include/llvm/LinkTimeOptimizer.h

   1 //===-- llvm/LinkTimeOptimizer.h - Public Interface  ------------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by Devang Patel and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This header provides public interface to use LLVM link time optimization
  11 // library. This is intended to be used by linker to do link time optimization.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #ifndef __LTO_H__
  16 #define __LTO_H__
  17
  18 #include <string>
  19 #include <vector>
  20 #include <set>
  21 #include <llvm/ADT/hash_map>
  22
  23 namespace llvm {
  24
  25   class Module;
  26   class GlobalValue;
  27   class TargetMachine;
  28
  29   enum LTOStatus {
  30     LTO_UNKNOWN,
  31     LTO_OPT_SUCCESS,
  32     LTO_READ_SUCCESS,
  33     LTO_READ_FAILURE,
  34     LTO_WRITE_FAILURE,
  35     LTO_NO_TARGET,
  36     LTO_NO_WORK,
  37     LTO_MODULE_MERGE_FAILURE,
  38     LTO_ASM_FAILURE
  39   };
  40
  41   enum LTOLinkageTypes {
  42     LTOExternalLinkage, // Externally visible function
  43     LTOLinkOnceLinkage, // Keep one copy of named function when linking (inline)
  44     LTOWeakLinkage,     // Keep one copy of named function when linking (weak)
  45     LTOInternalLinkage  // Rename collisions when linking (static functions)
  46   };
  47
  48   /// This class represents LLVM symbol information without exposing details
  49   /// of LLVM global values. It encapsulates symbol linkage information. This
  50   /// is typically used in hash_map where associated name identifies the
  51   /// the symbol name.
  52   class LLVMSymbol {
  53
  54   public:
  55
  56     LTOLinkageTypes getLinkage() const { return linkage; }
  57     void mayBeNotUsed();
  58
  59     LLVMSymbol (enum LTOLinkageTypes lt, GlobalValue *g, const std::string &n,
  60                 const std::string &m) : linkage(lt), gv(g), name(n),
  61                                         mangledName(m) {}
  62
  63     const char *getName() { return name.c_str(); }
  64     const char *getMangledName() { return mangledName.c_str(); }
  65
  66   private:
  67     enum LTOLinkageTypes linkage;
  68     GlobalValue *gv;
  69     std::string name;
  70     std::string mangledName;
  71   };
  72
  73   class string_compare {
  74   public:
  75     bool operator()(const char* left, const char* right) const {
  76       return (strcmp(left, right) == 0);
  77     }
  78   };
  79
  80   /// This is abstract class to facilitate dlopen() interface.
  81   /// See LTO below for more info.
  82   class LinkTimeOptimizer {
  83   public:
  84     typedef hash_map<const char*, LLVMSymbol*, hash<const char*>,
  85                      string_compare> NameToSymbolMap;
  86     typedef hash_map<const char*, Module*, hash<const char*>,
  87                      string_compare> NameToModuleMap;
  88     virtual enum LTOStatus readLLVMObjectFile(const std::string &,
  89                                               NameToSymbolMap &,
  90                                               std::set<std::string> &) = 0;
  91     virtual enum LTOStatus optimizeModules(const std::string &,
  92                                    std::vector<const char*> &,
  93                                    std::string &) = 0;
  94     virtual void getTargetTriple(const std::string &, std::string &) = 0;
  95     virtual void removeModule (const std::string &InputFilename) = 0;
  96     virtual ~LinkTimeOptimizer() = 0;
  97   };
  98
  99   /// This is the main link time optimization class. It exposes simple API
 100   /// to perform link time optimization using LLVM intermodular optimizer.
 101   class LTO : public LinkTimeOptimizer {
 102
 103   public:
 104     typedef hash_map<const char*, LLVMSymbol*, hash<const char*>,
 105                      string_compare> NameToSymbolMap;
 106     typedef hash_map<const char*, Module*, hash<const char*>,
 107                      string_compare> NameToModuleMap;
 108
 109     enum LTOStatus readLLVMObjectFile(const std::string &InputFilename,
 110                                       NameToSymbolMap &symbols,
 111                                       std::set<std::string> &references);
 112     enum LTOStatus optimizeModules(const std::string &OutputFilename,
 113                                    std::vector<const char*> &exportList,
 114                                    std::string &targetTriple);
 115     void getTargetTriple(const std::string &InputFilename, std::string &targetTriple);
 116     void removeModule (const std::string &InputFilename);
 117
 118     // Constructors and destructors
 119     LTO() {
 120       /// TODO: Use Target info, it is available at this time.
 121       Target = NULL;
 122     }
 123     ~LTO();
 124
 125   private:
 126     Module *getModule (const std::string &InputFilename);
 127     enum LTOStatus optimize(Module *, std::ostream &,
 128                             std::vector<const char *> &);
 129     void getTarget(Module *);
 130
 131   private:
 132     std::vector<Module *> modules;
 133     NameToSymbolMap allSymbols;
 134     NameToModuleMap allModules;
 135     TargetMachine *Target;
 136   };
 137
 138 } // End llvm namespace
 139
 140 /// This provides C interface to initialize link time optimizer. This allows
 141 /// linker to use dlopen() interface to dynamically load LinkTimeOptimizer.
 142 /// extern "C" helps, because dlopen() interface uses name to find the symbol.
 143 extern "C"
 144 llvm::LinkTimeOptimizer *createLLVMOptimizer();
 145
 146 #endif