1 //===--- llvmc.cpp - The LLVM Compiler Driver -------------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file was developed by Reid Spencer and is distributed under the
6 // University of Illinois Open Source License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This tool provides a single point of access to the LLVM compilation tools.
11 // It has many options. To discover the options supported please refer to the
12 // tools' manual page (docs/CommandGuide/html/llvmc.html) or run the tool with
15 //===------------------------------------------------------------------------===
17 #include "CompilerDriver.h"
18 #include "Configuration.h"
19 #include "llvm/Pass.h"
20 #include "llvm/System/Signals.h"
21 #include "Support/CommandLine.h"
27 //===------------------------------------------------------------------------===
29 //===------------------------------------------------------------------------===
30 cl::opt<CompilerDriver::Phases> FinalPhase(
31 cl::desc("Choose final phase of compilation:"),
32 cl::init(CompilerDriver::LINKING),
34 clEnumValN(CompilerDriver::PREPROCESSING,"E",
35 "Stop compilation after pre-processing phase"),
36 clEnumValN(CompilerDriver::TRANSLATION, "t",
37 "Stop compilation after translation phase"),
38 clEnumValN(CompilerDriver::OPTIMIZATION,"c",
39 "Stop compilation after optimization phase"),
40 clEnumValN(CompilerDriver::ASSEMBLY,"S",
41 "Stop compilation after assembly phase"),
46 //===------------------------------------------------------------------------===
47 //=== OPTIMIZATION OPTIONS
48 //===------------------------------------------------------------------------===
49 cl::opt<CompilerDriver::OptimizationLevels> OptLevel(
50 cl::desc("Choose level of optimization to apply:"),
51 cl::init(CompilerDriver::OPT_FAST_COMPILE),
53 clEnumValN(CompilerDriver::OPT_FAST_COMPILE,"O0",
54 "An alias for the -O1 option."),
55 clEnumValN(CompilerDriver::OPT_FAST_COMPILE,"O1",
56 "Optimize for compilation speed, not execution speed."),
57 clEnumValN(CompilerDriver::OPT_SIMPLE,"O2",
58 "Perform simple translation time optimizations"),
59 clEnumValN(CompilerDriver::OPT_AGGRESSIVE,"O3",
60 "Perform aggressive translation time optimizations"),
61 clEnumValN(CompilerDriver::OPT_LINK_TIME,"O4",
62 "Perform link time optimizations"),
63 clEnumValN(CompilerDriver::OPT_AGGRESSIVE_LINK_TIME,"O5",
64 "Perform aggressive link time optimizations"),
69 //===------------------------------------------------------------------------===
71 //===------------------------------------------------------------------------===
73 cl::list<std::string> PreprocessorToolOpts("Tpre", cl::ZeroOrMore,
74 cl::desc("Pass specific options to the pre-processor"),
75 cl::value_desc("option"));
77 cl::list<std::string> TranslatorToolOpts("Ttrn", cl::ZeroOrMore,
78 cl::desc("Pass specific options to the assembler"),
79 cl::value_desc("option"));
81 cl::list<std::string> AssemblerToolOpts("Tasm", cl::ZeroOrMore,
82 cl::desc("Pass specific options to the assembler"),
83 cl::value_desc("option"));
85 cl::list<std::string> OptimizerToolOpts("Topt", cl::ZeroOrMore,
86 cl::desc("Pass specific options to the optimizer"),
87 cl::value_desc("option"));
89 cl::list<std::string> LinkerToolOpts("Tlnk", cl::ZeroOrMore,
90 cl::desc("Pass specific options to the linker"),
91 cl::value_desc("option"));
93 //===------------------------------------------------------------------------===
95 //===------------------------------------------------------------------------===
97 cl::list<std::string> LibPaths("L", cl::Prefix,
98 cl::desc("Specify a library search path"), cl::value_desc("directory"));
100 cl::list<std::string> Libraries("l", cl::Prefix,
101 cl::desc("Specify libraries to link to"), cl::value_desc("library prefix"));
104 //===------------------------------------------------------------------------===
106 //===------------------------------------------------------------------------===
108 cl::opt<std::string> OutputFilename("o",
109 cl::desc("Override output filename"), cl::value_desc("filename"));
111 cl::opt<std::string> OutputMachine("m", cl::Prefix,
112 cl::desc("Specify a target machine"), cl::value_desc("machine"));
114 cl::opt<bool> Native("native", cl::init(false),
115 cl::desc("Generative native object and executables instead of bytecode"));
117 //===------------------------------------------------------------------------===
118 //=== INFORMATION OPTIONS
119 //===------------------------------------------------------------------------===
121 cl::opt<bool> DryRun("dry-run", cl::Optional, cl::init(false),
122 cl::desc("Do everything but perform the compilation actions"));
124 cl::alias DryRunAlias("y", cl::Optional,
125 cl::desc("Alias for -dry-run"), cl::aliasopt(DryRun));
127 cl::opt<bool> Verbose("verbose", cl::Optional, cl::init(false),
128 cl::desc("Print out each action taken"));
130 cl::alias VerboseAlias("v", cl::Optional,
131 cl::desc("Alias for -verbose"), cl::aliasopt(Verbose));
133 cl::opt<bool> Debug("debug", cl::Optional, cl::init(false),
134 cl::Hidden, cl::desc("Print out debugging information"));
136 cl::alias DebugAlias("d", cl::Optional,
137 cl::desc("Alias for -debug"), cl::aliasopt(Debug));
139 cl::opt<bool> TimeActions("time-actions", cl::Optional, cl::init(false),
140 cl::desc("Print execution time for each action taken"));
142 cl::opt<bool> ShowStats("stats", cl::Optional, cl::init(false),
143 cl::desc("Print statistics accumulated during optimization"));
145 //===------------------------------------------------------------------------===
146 //=== ADVANCED OPTIONS
147 //===------------------------------------------------------------------------===
149 static cl::opt<std::string> ConfigDir("config-dir", cl::Optional,
150 cl::desc("Specify a configuration directory to override defaults"),
151 cl::value_desc("directory"));
153 static cl::opt<bool> EmitRawCode("emit-raw-code", cl::Hidden, cl::Optional,
154 cl::desc("Emit raw, unoptimized code"));
156 static cl::opt<bool> PipeCommands("pipe", cl::Optional,
157 cl::desc("Invoke sub-commands by linking input/output with pipes"));
159 static cl::opt<bool> KeepTemporaries("keep-temps", cl::Optional,
160 cl::desc("Don't delete the temporary files created during compilation"));
162 //===------------------------------------------------------------------------===
163 //=== POSITIONAL OPTIONS
164 //===------------------------------------------------------------------------===
166 static cl::list<std::string> Files(cl::Positional, cl::OneOrMore,
167 cl::desc("[Sources/objects/libraries]"));
169 static cl::list<std::string> Languages("x", cl::ZeroOrMore,
170 cl::desc("Specify the source language for subsequent files"),
171 cl::value_desc("language"));
173 //===------------------------------------------------------------------------===
174 //=== GetFileType - determine type of a file
175 //===------------------------------------------------------------------------===
176 const std::string GetFileType(const std::string& fname, unsigned pos ) {
177 static std::vector<std::string>::iterator langIt = Languages.begin();
178 static std::string CurrLang = "";
180 // If a -x LANG option has been specified ..
181 if ( langIt != Languages.end() )
182 // If the -x LANG option came before the current file on command line
183 if ( Languages.getPosition( langIt - Languages.begin() ) < pos ) {
185 CurrLang = *langIt++;
189 // If there's a current language in effect
190 if (!CurrLang.empty())
191 return CurrLang; // use that language
193 // otherwise just determine lang from the filename's suffix
194 return fname.substr( fname.rfind('.',fname.size()) + 1 );
197 } // end anonymous namespace
200 /// @brief The main program for llvmc
201 int main(int argc, char **argv) {
203 // Make sure we print stack trace if we get bad signals
204 PrintStackTraceOnErrorSignal();
206 // Parse the command line options
207 cl::ParseCommandLineOptions(argc, argv,
208 " LLVM Compilation Driver (llvmc)\n\n"
209 " This program provides easy invocation of the LLVM tool set\n"
210 " and source language compiler tools.\n"
213 // Deal with unimplemented options.
215 throw "Not implemented yet: -pipe";
217 if (OutputFilename.empty())
218 if (OptLevel == CompilerDriver::LINKING)
219 OutputFilename = "a.out";
221 throw "An output file must be specified. Please use the -o option";
224 // Construct the ConfigDataProvider object
225 LLVMC_ConfigDataProvider Provider;
226 Provider.setConfigDir(ConfigDir);
228 // Construct the CompilerDriver object
229 CompilerDriver CD(Provider);
231 // Configure the driver based on options
232 CD.setVerbose(Verbose);
234 CD.setDryRun(DryRun);
235 CD.setFinalPhase(FinalPhase);
236 CD.setOptimization(OptLevel);
237 CD.setOutputMachine(OutputMachine);
238 CD.setEmitNativeCode(Native);
239 CD.setEmitRawCode(EmitRawCode);
240 CD.setTimeActions(TimeActions);
241 CD.setTimePasses(TimePassesIsEnabled);
242 CD.setShowStats(ShowStats);
243 CD.setKeepTemporaries(KeepTemporaries);
244 CD.setLibraryPaths(LibPaths);
245 if (!PreprocessorToolOpts.empty())
246 CD.setPhaseArgs(CompilerDriver::PREPROCESSING, PreprocessorToolOpts);
247 if (!TranslatorToolOpts.empty())
248 CD.setPhaseArgs(CompilerDriver::TRANSLATION, TranslatorToolOpts);
249 if (!OptimizerToolOpts.empty())
250 CD.setPhaseArgs(CompilerDriver::OPTIMIZATION, OptimizerToolOpts);
251 if (!AssemblerToolOpts.empty())
252 CD.setPhaseArgs(CompilerDriver::ASSEMBLY,AssemblerToolOpts);
253 if (!LinkerToolOpts.empty())
254 CD.setPhaseArgs(CompilerDriver::LINKING, LinkerToolOpts);
256 // Prepare the list of files to be compiled by the CompilerDriver.
257 CompilerDriver::InputList InpList;
258 std::vector<std::string>::iterator fileIt = Files.begin();
259 std::vector<std::string>::iterator libIt = Libraries.begin();
260 unsigned libPos = 0, filePos = 0;
262 if ( libIt != Libraries.end() )
263 libPos = Libraries.getPosition( libIt - Libraries.begin() );
266 if ( fileIt != Files.end() )
267 filePos = Files.getPosition( fileIt - Files.begin() );
271 if ( filePos != 0 && (libPos == 0 || filePos < libPos) ) {
273 InpList.push_back( std::make_pair(*fileIt, GetFileType(*fileIt,filePos)));
276 else if ( libPos != 0 && (filePos == 0 || libPos < filePos) ) {
278 InpList.push_back( std::make_pair(*libIt++,""));
281 break; // we're done with the list
284 // Tell the driver to do its thing
285 int result = CD.execute(InpList,OutputFilename);
287 throw "Error executing actions. Terminated.\n";
291 // All is good, return success
293 } catch (std::string& msg) {
294 std::cerr << argv[0] << ": " << msg << "\n";
296 std::cerr << argv[0] << ": Unexpected unknown exception occurred.\n";