llvm-6502/tools/llvmc/CompilerDriver.h
Reid Spencer bf43772038 More Functionality:
- cleaned up lexical scanner
- added support for "lang.optN" configuration items
- added temporary file support (ala lib/System)
- corrected logic for deciding which phases to run
- consolidated the Action and ActionPattern classes


git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@15765 91177308-0d34-0410-b5e6-96231b3b80d8
2004-08-15 08:19:46 +00:00

236 lines
9.3 KiB
C++

//===- CompilerDriver.h - Compiler Driver -----------------------*- C++ -*-===//
//
// The LLVM Compiler Infrastructure
//
// This file was developed by Reid Spencer and is distributed under the
// University of Illinois Open Source License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
//
// This file declares the CompilerDriver class which implements the bulk of the
// LLVM Compiler Driver program (llvmc).
//
//===------------------------------------------------------------------------===
#ifndef LLVM_TOOLS_LLVMC_COMPILERDRIVER_H
#define LLVM_TOOLS_LLVMC_COMPILERDRIVER_H
#include "llvm/System/Path.h"
#include <string>
#include <vector>
namespace llvm {
/// This class provides the high level interface to the LLVM Compiler Driver.
/// The driver's purpose is to make it easier for compiler writers and users
/// of LLVM to utilize the compiler toolkits and LLVM toolset by learning only
/// the interface of one program (llvmc).
///
/// @see llvmc.cpp
/// @brief The interface to the LLVM Compiler Driver.
class CompilerDriver {
/// @name Types
/// @{
public:
/// @brief A vector of strings, commonly used
typedef std::vector<std::string> StringVector;
/// @brief The phases of processing that llvmc understands
enum Phases {
PREPROCESSING, ///< Source language combining, filtering, substitution
TRANSLATION, ///< Translate source -> LLVM bytecode/assembly
OPTIMIZATION, ///< Optimize translation result
LINKING, ///< Link bytecode and native code
ASSEMBLY, ///< Convert program to executable
};
/// @brief The levels of optimization llvmc understands
enum OptimizationLevels {
OPT_FAST_COMPILE, ///< Optimize to make >compile< go faster
OPT_SIMPLE, ///< Standard/simple optimizations
OPT_AGGRESSIVE, ///< Aggressive optimizations
OPT_LINK_TIME, ///< Aggressive + LinkTime optimizations
OPT_AGGRESSIVE_LINK_TIME, ///< Make it go way fast!
OPT_NONE ///< No optimizations. Keep this at the end!
};
/// @brief Action specific flags
enum ConfigurationFlags {
REQUIRED_FLAG = 0x0001, ///< Should the action always be run?
GROKS_DASH_O_FLAG = 0x0002, ///< Understands the -On options?
PREPROCESSES_FLAG = 0x0004, ///< Does this action preprocess?
OPTIMIZES_FLAG = 0x0008, ///< Does this action optimize?
GROKS_O10N_FLAG = 0x0010, ///< Understands optimization options?
FLAGS_MASK = 0x001F, ///< Union of all flags
};
/// This type is the input list to the CompilerDriver. It provides
/// a vector of filename/filetype pairs. The filetype is used to look up
/// the configuration of the actions to be taken by the driver.
/// @brief The Input Data to the execute method
typedef std::vector<std::pair<sys::Path,std::string> > InputList;
/// This type is read from configuration files or otherwise provided to
/// the CompilerDriver through a "ConfigDataProvider". It serves as both
/// the template of what to do and the actual Action to be executed.
/// @brief A structure to hold the action data for a given source
/// language.
struct Action {
Action() : inputAt(0) , outputAt(0), flags(0) {}
sys::Path program; ///< The program to execve
StringVector args; ///< Arguments to the program
size_t inputAt; ///< Argument index to insert input file
size_t outputAt; ///< Argument index to insert output file
unsigned flags; ///< Action specific flags
void set(unsigned fl ) { flags |= fl; }
void clear(unsigned fl) { flags &= (FLAGS_MASK ^ fl); }
bool isSet(unsigned fl) { return flags&fl != 0; }
};
struct ConfigData {
std::string langName; ///< The name of the source language
std::vector<StringVector> opts; ///< The o10n options for each level
Action PreProcessor; ///< PreProcessor command line
Action Translator; ///< Translator command line
Action Optimizer; ///< Optimizer command line
Action Assembler; ///< Assembler command line
Action Linker; ///< Linker command line
};
/// This pure virtual interface class defines the interface between the
/// CompilerDriver and other software that provides ConfigData objects to
/// it. The CompilerDriver must be configured to use an object of this
/// type so it can obtain the configuration data.
/// @see setConfigDataProvider
/// @brief Configuration Data Provider interface
class ConfigDataProvider {
public:
virtual ConfigData* ProvideConfigData(const std::string& filetype) = 0;
virtual void setConfigDir(const std::string& dirName) = 0;
};
/// @}
/// @name Constructors
/// @{
public:
CompilerDriver(ConfigDataProvider& cdp );
virtual ~CompilerDriver();
/// @}
/// @name Methods
/// @{
public:
/// @brief Handle an error
virtual void error(const std::string& errmsg);
/// @brief Execute the actions requested for the given input list.
virtual int execute(const InputList& list, const sys::Path& output);
/// @}
/// @name Mutators
/// @{
public:
/// @brief Set the final phase at which compilation terminates
void setFinalPhase( Phases phase ) { finalPhase = phase; }
/// @brief Set the optimization level for the compilation
void setOptimization( OptimizationLevels level ) { optLevel = level; }
/// @brief Prevent the CompilerDriver from taking any actions
void setDryRun( bool TF ) { isDryRun = TF; }
/// @brief Cause the CompilerDriver to print to stderr all the
/// actions it is taking.
void setVerbose( bool TF ) { isVerbose = TF; }
/// @brief Cause the CompilerDriver to print to stderr very verbose
/// information that might be useful in debugging the driver's actions
void setDebug( bool TF ) { isDebug = TF; }
/// @brief Cause the CompilerDriver to print to stderr the
/// execution time of each action taken.
void setTimeActions( bool TF ) { timeActions = TF; }
/// @brief Indicate that native code is to be generated instead
/// of LLVM bytecode.
void setEmitNativeCode( bool TF ) { emitNativeCode = TF; }
/// @brief Indicate that raw, unoptimized code is to be generated.
void setEmitRawCode(bool TF ) { emitRawCode = TF; }
/// @brief Set the output machine name.
void setOutputMachine( const std::string& machineName ) {
machine = machineName;
}
/// @brief Set Preprocessor specific options
void setPreprocessorOptions(const std::vector<std::string>& opts) {
PreprocessorOptions = opts;
}
/// @brief Set Translator specific options
void setTranslatorOptions(const std::vector<std::string>& opts) {
TranslatorOptions = opts;
}
/// @brief Set Optimizer specific options
void setOptimizerOptions(const std::vector<std::string>& opts) {
OptimizerOptions = opts;
}
/// @brief Set Assembler specific options
void setAssemblerOptions(const std::vector<std::string>& opts) {
AssemblerOptions = opts;
}
/// @brief Set Linker specific options
void setLinkerOptions(const std::vector<std::string>& opts) {
LinkerOptions = opts;
}
/// @brief Set Library Paths
void setLibraryPaths(const std::vector<std::string>& paths) {
LibraryPaths = paths;
}
/// @brief Set the list of library paths to be searched for
/// libraries.
void addLibraryPath( const std::string& libPath ) {
LibraryPaths.push_back(libPath);
}
/// @}
/// @name Functions
/// @{
private:
Action* GetAction(ConfigData* cd, const std::string& input,
const std::string& output, Phases phase );
void DoAction(Action* a);
/// @}
/// @name Data
/// @{
private:
ConfigDataProvider* cdp; ///< Where we get configuration data from
Phases finalPhase; ///< The final phase of compilation
OptimizationLevels optLevel; ///< The optimization level to apply
bool isDryRun; ///< Prevent actions ?
bool isVerbose; ///< Print actions?
bool isDebug; ///< Print lotsa debug info?
bool timeActions; ///< Time the actions executed ?
bool emitRawCode; ///< Emit Raw (unoptimized) code?
bool emitNativeCode; ///< Emit native code instead of bytecode?
std::string machine; ///< Target machine name
std::vector<std::string> LibraryPaths;
std::vector<std::string> PreprocessorOptions;
std::vector<std::string> TranslatorOptions;
std::vector<std::string> OptimizerOptions;
std::vector<std::string> AssemblerOptions;
std::vector<std::string> LinkerOptions;
/// @}
};
}
// vim: sw=2 smartindent smarttab tw=80 autoindent expandtab
#endif