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 "llvm/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"));
103 cl::list<std::string> Includes("I", cl::Prefix,
104 cl::desc("Specify location to search for included source"),
105 cl::value_desc("include directory"));
107 cl::list<std::string> Defines("D", cl::Prefix,
108 cl::desc("Specify a symbol to define for source configuration"),
109 cl::value_desc("symbol definition"));
112 //===------------------------------------------------------------------------===
114 //===------------------------------------------------------------------------===
116 cl::opt<std::string> OutputFilename("o",
117 cl::desc("Override output filename"), cl::value_desc("filename"));
119 cl::opt<bool> ForceOutput("f", cl::Optional, cl::init(false),
120 cl::desc("Force output files to be overridden"));
122 cl::opt<std::string> OutputMachine("m", cl::Prefix,
123 cl::desc("Specify a target machine"), cl::value_desc("machine"));
125 cl::opt<bool> Native("native", cl::init(false),
126 cl::desc("Generative native object and executables instead of bytecode"));
128 cl::opt<bool> DebugOutput("g", cl::init(false),
129 cl::desc("Generate objects that include debug symbols"));
131 //===------------------------------------------------------------------------===
132 //=== INFORMATION OPTIONS
133 //===------------------------------------------------------------------------===
135 cl::opt<bool> DryRun("dry-run", cl::Optional, cl::init(false),
136 cl::desc("Do everything but perform the compilation actions"));
138 cl::alias DryRunAlias("y", cl::Optional,
139 cl::desc("Alias for -dry-run"), cl::aliasopt(DryRun));
141 cl::opt<bool> Verbose("verbose", cl::Optional, cl::init(false),
142 cl::desc("Print out each action taken"));
144 cl::alias VerboseAlias("v", cl::Optional,
145 cl::desc("Alias for -verbose"), cl::aliasopt(Verbose));
147 cl::opt<bool> Debug("debug", cl::Optional, cl::init(false),
148 cl::Hidden, cl::desc("Print out debugging information"));
150 cl::alias DebugAlias("d", cl::Optional,
151 cl::desc("Alias for -debug"), cl::aliasopt(Debug));
153 cl::opt<bool> TimeActions("time-actions", cl::Optional, cl::init(false),
154 cl::desc("Print execution time for each action taken"));
156 cl::opt<bool> ShowStats("stats", cl::Optional, cl::init(false),
157 cl::desc("Print statistics accumulated during optimization"));
159 cl::list<std::string> Warnings("W", cl::Prefix,
160 cl::desc("Provide warnings for additional classes of errors"),
161 cl::value_desc("warning category"));
163 //===------------------------------------------------------------------------===
164 //=== ADVANCED OPTIONS
165 //===------------------------------------------------------------------------===
167 static cl::opt<std::string> ConfigDir("config-dir", cl::Optional,
168 cl::desc("Specify a configuration directory to override defaults"),
169 cl::value_desc("directory"));
171 static cl::opt<bool> EmitRawCode("emit-raw-code", cl::Hidden, cl::Optional,
172 cl::desc("Emit raw, unoptimized code"));
174 static cl::opt<bool> PipeCommands("pipe", cl::Optional,
175 cl::desc("Invoke sub-commands by linking input/output with pipes"));
177 static cl::opt<bool> KeepTemps("keep-temps", cl::Optional,
178 cl::desc("Don't delete the temporary files created during compilation"));
180 //===------------------------------------------------------------------------===
181 //=== POSITIONAL OPTIONS
182 //===------------------------------------------------------------------------===
184 static cl::list<std::string> Files(cl::Positional, cl::OneOrMore,
185 cl::desc("[Sources/objects/libraries]"));
187 static cl::list<std::string> Languages("x", cl::ZeroOrMore,
188 cl::desc("Specify the source language for subsequent files"),
189 cl::value_desc("language"));
191 //===------------------------------------------------------------------------===
192 //=== GetFileType - determine type of a file
193 //===------------------------------------------------------------------------===
194 const std::string GetFileType(const std::string& fname, unsigned pos ) {
195 static std::vector<std::string>::iterator langIt = Languages.begin();
196 static std::string CurrLang = "";
198 // If a -x LANG option has been specified ..
199 if ( langIt != Languages.end() )
200 // If the -x LANG option came before the current file on command line
201 if ( Languages.getPosition( langIt - Languages.begin() ) < pos ) {
203 CurrLang = *langIt++;
207 // If there's a current language in effect
208 if (!CurrLang.empty())
209 return CurrLang; // use that language
211 // otherwise just determine lang from the filename's suffix
212 return fname.substr( fname.rfind('.',fname.size()) + 1 );
215 } // end anonymous namespace
218 /// @brief The main program for llvmc
219 int main(int argc, char **argv) {
220 // Make sure we print stack trace if we get bad signals
221 sys::PrintStackTraceOnErrorSignal();
225 // Parse the command line options
226 cl::ParseCommandLineOptions(argc, argv,
227 " LLVM Compiler Driver (llvmc)\n\n"
228 " This program provides easy invocation of the LLVM tool set\n"
229 " and other compiler tools.\n"
232 // Deal with unimplemented options.
234 throw std::string("Not implemented yet: -pipe");
236 if (OutputFilename.empty())
237 if (OptLevel == CompilerDriver::LINKING)
238 OutputFilename = "a.out";
240 throw std::string("An output file must be specified. Please use the -o option");
242 // Construct the ConfigDataProvider object
243 LLVMC_ConfigDataProvider Provider;
244 Provider.setConfigDir(sys::Path(ConfigDir));
246 // Construct the CompilerDriver object
247 CompilerDriver* CD = CompilerDriver::Get(Provider);
249 // If the LLVM_LIB_SEARCH_PATH environment variable is
250 // set, append it to the list of places to search for libraries
251 std::string srchPath = getenv("LLVM_LIB_SEARCH_PATH");
252 if (!srchPath.empty())
253 LibPaths.push_back(srchPath);
255 // Set the driver flags based on command line options
257 if (Verbose) flags |= CompilerDriver::VERBOSE_FLAG;
258 if (Debug) flags |= CompilerDriver::DEBUG_FLAG;
259 if (DryRun) flags |= CompilerDriver::DRY_RUN_FLAG;
260 if (ForceOutput) flags |= CompilerDriver::FORCE_FLAG;
261 if (Native) flags |= CompilerDriver::EMIT_NATIVE_FLAG;
262 if (EmitRawCode) flags |= CompilerDriver::EMIT_RAW_FLAG;
263 if (KeepTemps) flags |= CompilerDriver::KEEP_TEMPS_FLAG;
264 if (ShowStats) flags |= CompilerDriver::SHOW_STATS_FLAG;
265 if (TimeActions) flags |= CompilerDriver::TIME_ACTIONS_FLAG;
266 if (TimePassesIsEnabled) flags |= CompilerDriver::TIME_PASSES_FLAG;
267 CD->setDriverFlags(flags);
269 // Specify requred parameters
270 CD->setFinalPhase(FinalPhase);
271 CD->setOptimization(OptLevel);
272 CD->setOutputMachine(OutputMachine);
273 CD->setIncludePaths(Includes);
274 CD->setSymbolDefines(Defines);
275 CD->setLibraryPaths(LibPaths);
277 // Provide additional tool arguments
278 if (!PreprocessorToolOpts.empty())
279 CD->setPhaseArgs(CompilerDriver::PREPROCESSING, PreprocessorToolOpts);
280 if (!TranslatorToolOpts.empty())
281 CD->setPhaseArgs(CompilerDriver::TRANSLATION, TranslatorToolOpts);
282 if (!OptimizerToolOpts.empty())
283 CD->setPhaseArgs(CompilerDriver::OPTIMIZATION, OptimizerToolOpts);
284 if (!AssemblerToolOpts.empty())
285 CD->setPhaseArgs(CompilerDriver::ASSEMBLY,AssemblerToolOpts);
286 if (!LinkerToolOpts.empty())
287 CD->setPhaseArgs(CompilerDriver::LINKING, LinkerToolOpts);
289 // Prepare the list of files to be compiled by the CompilerDriver.
290 CompilerDriver::InputList InpList;
291 std::vector<std::string>::iterator fileIt = Files.begin();
292 std::vector<std::string>::iterator libIt = Libraries.begin();
293 unsigned libPos = 0, filePos = 0;
295 if ( libIt != Libraries.end() )
296 libPos = Libraries.getPosition( libIt - Libraries.begin() );
299 if ( fileIt != Files.end() )
300 filePos = Files.getPosition( fileIt - Files.begin() );
304 if ( filePos != 0 && (libPos == 0 || filePos < libPos) ) {
306 InpList.push_back( std::make_pair(*fileIt, GetFileType(*fileIt,filePos)));
309 else if ( libPos != 0 && (filePos == 0 || libPos < filePos) ) {
311 InpList.push_back( std::make_pair(*libIt++,""));
314 break; // we're done with the list
317 // Tell the driver to do its thing
318 int result = CD->execute(InpList,sys::Path(OutputFilename));
320 throw std::string("Error executing actions. Terminated.");
324 // All is good, return success
326 } catch (std::string& msg) {
327 std::cerr << argv[0] << ": " << msg << "\n";
329 std::cerr << argv[0] << ": Unexpected unknown exception occurred.\n";