1 //===- CompilerDriver.h - 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 file declares the CompilerDriver class which implements the bulk of the
11 // LLVM Compiler Driver program (llvmc).
13 //===------------------------------------------------------------------------===
14 #ifndef LLVM_TOOLS_LLVMC_COMPILERDRIVER_H
15 #define LLVM_TOOLS_LLVMC_COMPILERDRIVER_H
21 /// This class provides the high level interface to the LLVM Compiler Driver.
22 /// The driver's purpose is to make it easier for compiler writers and users
23 /// of LLVM to utilize the compiler toolkits and LLVM toolset by learning only
24 /// the interface of one program (llvmc).
27 /// @brief The interface to the LLVM Compiler Driver.
28 class CompilerDriver {
32 /// @brief A vector of strings, commonly used
33 typedef std::vector<std::string> StringVector;
35 /// @brief A table of strings, indexed typically by Phases
36 typedef std::vector<StringVector> StringTable;
38 /// @brief The phases of processing that llvmc understands
40 PREPROCESSING, ///< Source language combining, filtering, substitution
41 TRANSLATION, ///< Translate source -> LLVM bytecode/assembly
42 OPTIMIZATION, ///< Optimize translation result
43 ASSEMBLY, ///< Convert program to executable
44 LINKING, ///< Link bytecode and native code
45 NUM_PHASES ///< Always last!
48 /// @brief The levels of optimization llvmc understands
49 enum OptimizationLevels {
50 OPT_FAST_COMPILE, ///< Optimize to make >compile< go faster
51 OPT_SIMPLE, ///< Standard/simple optimizations
52 OPT_AGGRESSIVE, ///< Aggressive optimizations
53 OPT_LINK_TIME, ///< Aggressive + LinkTime optimizations
54 OPT_AGGRESSIVE_LINK_TIME, ///< Make it go way fast!
55 OPT_NONE ///< No optimizations. Keep this at the end!
58 /// @brief Action specific flags
59 enum ConfigurationFlags {
60 REQUIRED_FLAG = 0x0001, ///< Should the action always be run?
61 GROKS_DASH_O_FLAG = 0x0002, ///< Understands the -On options?
62 PREPROCESSES_FLAG = 0x0004, ///< Does this action preprocess?
63 TRANSLATES_FLAG = 0x0008, ///< Does this action translate?
64 OPTIMIZES_FLAG = 0x0010, ///< Does this action optimize?
65 OUTPUT_IS_ASM_FLAG = 0x0020, ///< Action produces .ll files?
66 FLAGS_MASK = 0x003F, ///< Union of all flags
69 /// This type is the input list to the CompilerDriver. It provides
70 /// a vector of filename/filetype pairs. The filetype is used to look up
71 /// the configuration of the actions to be taken by the driver.
72 /// @brief The Input Data to the execute method
73 typedef std::vector<std::pair<std::string,std::string> > InputList;
75 /// This type is read from configuration files or otherwise provided to
76 /// the CompilerDriver through a "ConfigDataProvider". It serves as both
77 /// the template of what to do and the actual Action to be executed.
78 /// @brief A structure to hold the action data for a given source
81 Action() : flags(0) {}
82 std::string program; ///< The program to execve
83 StringVector args; ///< Arguments to the program
84 unsigned flags; ///< Action specific flags
85 void set(unsigned fl ) { flags |= fl; }
86 void clear(unsigned fl) { flags &= (FLAGS_MASK ^ fl); }
87 bool isSet(unsigned fl) { return (flags&fl) != 0; }
92 std::string version; ///< The version number.
93 std::string langName; ///< The name of the source language
94 StringTable opts; ///< The o10n options for each level
95 Action PreProcessor; ///< PreProcessor command line
96 Action Translator; ///< Translator command line
97 Action Optimizer; ///< Optimizer command line
98 Action Assembler; ///< Assembler command line
99 Action Linker; ///< Linker command line
102 /// This pure virtual interface class defines the interface between the
103 /// CompilerDriver and other software that provides ConfigData objects to
104 /// it. The CompilerDriver must be configured to use an object of this
105 /// type so it can obtain the configuration data.
106 /// @see setConfigDataProvider
107 /// @brief Configuration Data Provider interface
108 class ConfigDataProvider {
110 virtual ConfigData* ProvideConfigData(const std::string& filetype) = 0;
111 virtual void setConfigDir(const std::string& dirName) = 0;
115 /// @name Constructors
118 CompilerDriver(ConfigDataProvider& cdp );
119 virtual ~CompilerDriver();
125 /// @brief Handle an error
126 virtual void error(const std::string& errmsg);
128 /// @brief Execute the actions requested for the given input list.
129 virtual int execute(const InputList& list, const std::string& output);
135 /// @brief Set the final phase at which compilation terminates
136 void setFinalPhase( Phases phase ) { finalPhase = phase; }
138 /// @brief Set the optimization level for the compilation
139 void setOptimization( OptimizationLevels level ) { optLevel = level; }
141 /// @brief Prevent the CompilerDriver from taking any actions
142 void setDryRun( bool TF ) { isDryRun = TF; }
144 /// @brief Cause the CompilerDriver to print to stderr all the
145 /// actions it is taking.
146 void setVerbose( bool TF ) { isVerbose = TF; }
148 /// @brief Cause the CompilerDriver to print to stderr very verbose
149 /// information that might be useful in debugging the driver's actions
150 void setDebug( bool TF ) { isDebug = TF; }
152 /// @brief Cause the CompilerDriver to print to stderr the
153 /// execution time of each action taken.
154 void setTimeActions( bool TF ) { timeActions = TF; }
156 /// @brief Cause the CompilerDriver to print timings for each pass.
157 void setTimePasses( bool TF ) { timePasses = TF; }
159 /// @brief Cause the CompilerDriver to show statistics gathered
160 void setShowStats( bool TF ) { showStats = TF; }
162 /// @brief Indicate that native code is to be generated instead
163 /// of LLVM bytecode.
164 void setEmitNativeCode( bool TF ) { emitNativeCode = TF; }
166 /// @brief Indicate that raw, unoptimized code is to be generated.
167 void setEmitRawCode(bool TF ) { emitRawCode = TF; }
169 void setKeepTemporaries(bool TF) { keepTemps = TF; }
171 /// @brief Set the output machine name.
172 void setOutputMachine( const std::string& machineName ) {
173 machine = machineName;
176 /// @brief Set Preprocessor specific options
177 void setPhaseArgs(Phases phase, const std::vector<std::string>& opts) {
178 assert(phase <= LINKING && phase >= PREPROCESSING);
179 AdditionalArgs[phase] = opts;
182 /// @brief Set Library Paths
183 void setLibraryPaths(const std::vector<std::string>& paths) {
184 LibraryPaths = paths;
187 /// @brief Set the list of library paths to be searched for
189 void addLibraryPath( const std::string& libPath ) {
190 LibraryPaths.push_back(libPath);
197 Action* GetAction(ConfigData* cd, const std::string& input,
198 const std::string& output, Phases phase );
199 bool DoAction(Action* a);
205 ConfigDataProvider* cdp; ///< Where we get configuration data from
206 Phases finalPhase; ///< The final phase of compilation
207 OptimizationLevels optLevel; ///< The optimization level to apply
208 bool isDryRun; ///< Prevent actions ?
209 bool isVerbose; ///< Print actions?
210 bool isDebug; ///< Print lotsa debug info?
211 bool timeActions; ///< Time the actions executed ?
212 bool timePasses; ///< Time each pass and print timing ?
213 bool showStats; ///< Show gathered statistics ?
214 bool emitRawCode; ///< Emit Raw (unoptimized) code?
215 bool emitNativeCode; ///< Emit native code instead of bytecode?
216 bool keepTemps; ///< Keep temporary files?
217 std::string machine; ///< Target machine name
218 StringVector LibraryPaths; ///< -L options
219 StringTable AdditionalArgs; ///< The -Txyz options
220 std::string TempDir; ///< Name of the temporary directory.
227 // vim: sw=2 smartindent smarttab tw=80 autoindent expandtab