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(cl::Optional,
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(cl::ZeroOrMore,
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::alias PreprocessorToolOptsAlias("Wp,", cl::ZeroOrMore,
78 cl::desc("Alias for -Tpre"), cl::aliasopt(PreprocessorToolOpts));
80 cl::list<std::string> TranslatorToolOpts("Ttrn", cl::ZeroOrMore,
81 cl::desc("Pass specific options to the assembler"),
82 cl::value_desc("option"));
84 cl::list<std::string> AssemblerToolOpts("Tasm", cl::ZeroOrMore,
85 cl::desc("Pass specific options to the assembler"),
86 cl::value_desc("option"));
88 cl::alias AssemblerToolOptsAlias("Wa,", cl::ZeroOrMore,
89 cl::desc("Alias for -Tasm"), cl::aliasopt(AssemblerToolOpts));
91 cl::list<std::string> OptimizerToolOpts("Topt", cl::ZeroOrMore,
92 cl::desc("Pass specific options to the optimizer"),
93 cl::value_desc("option"));
95 cl::list<std::string> LinkerToolOpts("Tlnk", cl::ZeroOrMore,
96 cl::desc("Pass specific options to the linker"),
97 cl::value_desc("option"));
99 cl::alias LinkerToolOptsAlias("Wl,", cl::ZeroOrMore,
100 cl::desc("Alias for -Tlnk"), cl::aliasopt(LinkerToolOpts));
102 cl::list<std::string> fOpts("f", cl::ZeroOrMore, cl::Prefix,
103 cl::desc("Pass through -f options to compiler tools"),
104 cl::value_desc("option"));
106 cl::list<std::string> MOpts("M", cl::ZeroOrMore, cl::Prefix,
107 cl::desc("Pass through -M options to compiler tools"),
108 cl::value_desc("option"));
110 cl::list<std::string> WOpts("W", cl::ZeroOrMore, cl::Prefix,
111 cl::desc("Pass through -W options to compiler tools"),
112 cl::value_desc("option"));
114 cl::list<std::string> BOpt("B", cl::ZeroOrMore, cl::Prefix,
115 cl::desc("Specify path to find llvmc sub-tools"),
116 cl::value_desc("dir"));
118 //===----------------------------------------------------------------------===//
120 //===----------------------------------------------------------------------===//
122 cl::list<std::string> LibPaths("L", cl::Prefix,
123 cl::desc("Specify a library search path"), cl::value_desc("dir"));
125 cl::list<std::string> Libraries("l", cl::Prefix,
126 cl::desc("Specify base name of libraries to link to"), cl::value_desc("lib"));
128 cl::list<std::string> Includes("I", cl::Prefix,
129 cl::desc("Specify location to search for included source"),
130 cl::value_desc("dir"));
132 cl::list<std::string> Defines("D", cl::Prefix,
133 cl::desc("Specify a pre-processor symbol to define"),
134 cl::value_desc("symbol"));
136 //===----------------------------------------------------------------------===//
138 //===----------------------------------------------------------------------===//
140 cl::opt<std::string> OutputFilename("o",
141 cl::desc("Override output filename"), cl::value_desc("file"));
143 cl::opt<std::string> OutputMachine("m", cl::Prefix,
144 cl::desc("Specify a target machine"), cl::value_desc("machine"));
146 cl::opt<bool> Native("native", cl::init(false),
147 cl::desc("Generative native code instead of bytecode"));
149 cl::opt<bool> DebugOutput("g", cl::init(false),
150 cl::desc("Generate objects that include debug symbols"));
152 cl::opt<bool> StripOutput("strip", cl::init(false),
153 cl::desc("Strip all symbols from linked output file"));
155 cl::opt<std::string> PrintFileName("print-fname", cl::Optional,
156 cl::value_desc("file"),
157 cl::desc("Print the full path for the option's value"));
159 //===----------------------------------------------------------------------===//
160 //=== INFORMATION OPTIONS
161 //===----------------------------------------------------------------------===//
163 cl::opt<bool> DryRun("dry-run", cl::Optional, cl::init(false),
164 cl::desc("Do everything but perform the compilation actions"));
166 cl::alias DryRunAlias("y", cl::Optional,
167 cl::desc("Alias for -dry-run"), cl::aliasopt(DryRun));
169 cl::opt<bool> Verbose("verbose", cl::Optional, cl::init(false),
170 cl::desc("Print out each action taken"));
172 cl::alias VerboseAlias("v", cl::Optional,
173 cl::desc("Alias for -verbose"), cl::aliasopt(Verbose));
175 cl::opt<bool> Debug("debug", cl::Optional, cl::init(false),
176 cl::Hidden, cl::desc("Print out debugging information"));
178 cl::alias DebugAlias("d", cl::Optional,
179 cl::desc("Alias for -debug"), cl::aliasopt(Debug));
181 cl::opt<bool> TimeActions("time-actions", cl::Optional, cl::init(false),
182 cl::desc("Print execution time for each action taken"));
184 cl::opt<bool> ShowStats("stats", cl::Optional, cl::init(false),
185 cl::desc("Print statistics accumulated during optimization"));
187 //===----------------------------------------------------------------------===//
188 //=== ADVANCED OPTIONS
189 //===----------------------------------------------------------------------===//
191 static cl::opt<std::string> ConfigDir("config-dir", cl::Optional,
192 cl::desc("Specify configuration directory to override defaults"),
193 cl::value_desc("dir"));
195 static cl::opt<bool> EmitRawCode("emit-raw-code", cl::Hidden, cl::Optional,
196 cl::desc("Emit raw, unoptimized code"));
198 static cl::opt<bool> PipeCommands("pipe", cl::Optional,
199 cl::desc("Invoke sub-commands by linking input/output with pipes"));
201 static cl::opt<bool> KeepTemps("keep-temps", cl::Optional,
202 cl::desc("Don't delete temporary files created by llvmc"));
204 //===----------------------------------------------------------------------===//
205 //=== POSITIONAL OPTIONS
206 //===----------------------------------------------------------------------===//
208 static cl::list<std::string> Files(cl::Positional, cl::ZeroOrMore,
209 cl::desc("[Sources/objects/libraries]"));
211 static cl::list<std::string> Languages("x", cl::ZeroOrMore,
212 cl::desc("Specify the source language for subsequent files"),
213 cl::value_desc("language"));
215 //===----------------------------------------------------------------------===//
216 //=== GetFileType - determine type of a file
217 //===----------------------------------------------------------------------===//
218 const std::string GetFileType(const std::string& fname, unsigned pos) {
219 static std::vector<std::string>::iterator langIt = Languages.begin();
220 static std::string CurrLang = "";
222 // If a -x LANG option has been specified ..
223 if (langIt != Languages.end())
224 // If the -x LANG option came before the current file on command line
225 if (Languages.getPosition( langIt - Languages.begin() ) < pos) {
227 CurrLang = *langIt++;
231 // If there's a current language in effect
232 if (!CurrLang.empty())
233 return CurrLang; // use that language
235 // otherwise just determine lang from the filename's suffix
236 return fname.substr(fname.rfind('.', fname.size()) + 1);
239 } // end anonymous namespace
241 void handleTerminatingOptions(CompilerDriver* CD) {
242 if (!PrintFileName.empty()) {
243 sys::Path path = CD->GetPathForLinkageItem(PrintFileName, false);
244 std::string p = path.toString();
246 std::cout << "Can't locate `" << PrintFileName << "'.\n";
248 std::cout << p << '\n';
253 /// @brief The main program for llvmc
254 int main(int argc, char **argv) {
255 // Make sure we print stack trace if we get bad signals
256 sys::PrintStackTraceOnErrorSignal();
260 // Parse the command line options
261 cl::ParseCommandLineOptions(argc, argv,
262 " LLVM Compiler Driver (llvmc)\n\n"
263 " This program provides easy invocation of the LLVM tool set\n"
264 " and other compiler tools.\n"
267 // Deal with unimplemented options.
269 throw std::string("Not implemented yet: -pipe");
271 if (OutputFilename.empty())
272 if (OptLevel == CompilerDriver::LINKING)
273 OutputFilename = "a.out";
275 // Construct the ConfigDataProvider object
276 LLVMC_ConfigDataProvider Provider;
277 Provider.setConfigDir(sys::Path(ConfigDir));
279 // Construct the CompilerDriver object
280 CompilerDriver* CD = CompilerDriver::Get(Provider);
282 // If the LLVM_LIB_SEARCH_PATH environment variable is
283 // set, append it to the list of places to search for libraries
284 char *srchPath = getenv("LLVM_LIB_SEARCH_PATH");
285 if (srchPath != NULL && strlen(srchPath) != 0)
286 LibPaths.push_back(std::string(srchPath));
288 // Set the driver flags based on command line options
290 if (Verbose) flags |= CompilerDriver::VERBOSE_FLAG;
291 if (Debug) flags |= CompilerDriver::DEBUG_FLAG;
292 if (DryRun) flags |= CompilerDriver::DRY_RUN_FLAG;
293 if (Native) flags |= CompilerDriver::EMIT_NATIVE_FLAG;
294 if (EmitRawCode) flags |= CompilerDriver::EMIT_RAW_FLAG;
295 if (KeepTemps) flags |= CompilerDriver::KEEP_TEMPS_FLAG;
296 if (ShowStats) flags |= CompilerDriver::SHOW_STATS_FLAG;
297 if (TimeActions) flags |= CompilerDriver::TIME_ACTIONS_FLAG;
298 if (StripOutput) flags |= CompilerDriver::STRIP_OUTPUT_FLAG;
299 CD->setDriverFlags(flags);
301 // Specify required parameters
302 CD->setFinalPhase(FinalPhase);
303 CD->setOptimization(OptLevel);
304 CD->setOutputMachine(OutputMachine);
305 CD->setIncludePaths(Includes);
306 CD->setSymbolDefines(Defines);
307 CD->setLibraryPaths(LibPaths);
308 CD->setfPassThrough(fOpts);
309 CD->setMPassThrough(MOpts);
310 CD->setWPassThrough(WOpts);
312 // Provide additional tool arguments
313 if (!PreprocessorToolOpts.empty())
314 CD->setPhaseArgs(CompilerDriver::PREPROCESSING, PreprocessorToolOpts);
315 if (!TranslatorToolOpts.empty())
316 CD->setPhaseArgs(CompilerDriver::TRANSLATION, TranslatorToolOpts);
317 if (!OptimizerToolOpts.empty())
318 CD->setPhaseArgs(CompilerDriver::OPTIMIZATION, OptimizerToolOpts);
319 if (!AssemblerToolOpts.empty())
320 CD->setPhaseArgs(CompilerDriver::ASSEMBLY,AssemblerToolOpts);
321 if (!LinkerToolOpts.empty())
322 CD->setPhaseArgs(CompilerDriver::LINKING, LinkerToolOpts);
324 // Check for options that cause us to terminate before any significant work
326 handleTerminatingOptions(CD);
328 // Prepare the list of files to be compiled by the CompilerDriver.
329 CompilerDriver::InputList InpList;
330 std::vector<std::string>::iterator fileIt = Files.begin();
331 std::vector<std::string>::iterator libIt = Libraries.begin();
332 unsigned libPos = 0, filePos = 0;
334 if (libIt != Libraries.end())
335 libPos = Libraries.getPosition( libIt - Libraries.begin() );
338 if (fileIt != Files.end())
339 filePos = Files.getPosition(fileIt - Files.begin());
343 if (filePos != 0 && (libPos == 0 || filePos < libPos)) {
345 InpList.push_back(std::make_pair(*fileIt,
346 GetFileType(*fileIt, filePos)));
348 } else if ( libPos != 0 && (filePos == 0 || libPos < filePos) ) {
350 InpList.push_back(std::make_pair(*libIt++, ""));
353 break; // we're done with the list
356 // Tell the driver to do its thing
358 int result = CD->execute(InpList, sys::Path(OutputFilename), ErrMsg);
360 std::cerr << argv[0] << ": " << ErrMsg << '\n';
364 // All is good, return success
366 } catch (const std::string& msg) {
367 std::cerr << argv[0] << ": " << msg << '\n';
369 std::cerr << argv[0] << ": Unexpected unknown exception occurred.\n";