include/llvm/Target/TargetLoweringObjectFile.h

   1 //===-- llvm/Target/TargetLoweringObjectFile.h - Object Info ----*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file implements classes used to handle lowerings specific to common
  11 // object file formats.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #ifndef LLVM_TARGET_TARGETLOWERINGOBJECTFILE_H
  16 #define LLVM_TARGET_TARGETLOWERINGOBJECTFILE_H
  17
  18 #include "llvm/ADT/ArrayRef.h"
  19 #include "llvm/IR/Module.h"
  20 #include "llvm/MC/MCObjectFileInfo.h"
  21 #include "llvm/MC/SectionKind.h"
  22
  23 namespace llvm {
  24   class MachineModuleInfo;
  25   class Mangler;
  26   class MCContext;
  27   class MCExpr;
  28   class MCSection;
  29   class MCSymbol;
  30   class MCSymbolRefExpr;
  31   class MCStreamer;
  32   class MCValue;
  33   class ConstantExpr;
  34   class GlobalValue;
  35   class TargetMachine;
  36
  37 class TargetLoweringObjectFile : public MCObjectFileInfo {
  38   MCContext *Ctx;
  39
  40   TargetLoweringObjectFile(
  41     const TargetLoweringObjectFile&) = delete;
  42   void operator=(const TargetLoweringObjectFile&) = delete;
  43
  44 protected:
  45   const DataLayout *DL;
  46   bool SupportIndirectSymViaGOTPCRel;
  47   bool SupportGOTPCRelWithOffset;
  48
  49 public:
  50   MCContext &getContext() const { return *Ctx; }
  51
  52   TargetLoweringObjectFile() : MCObjectFileInfo(), Ctx(nullptr), DL(nullptr),
  53                                SupportIndirectSymViaGOTPCRel(false),
  54                                SupportGOTPCRelWithOffset(true) {}
  55
  56   virtual ~TargetLoweringObjectFile();
  57
  58   /// This method must be called before any actual lowering is done.  This
  59   /// specifies the current context for codegen, and gives the lowering
  60   /// implementations a chance to set up their default sections.
  61   virtual void Initialize(MCContext &ctx, const TargetMachine &TM);
  62
  63   virtual void emitPersonalityValue(MCStreamer &Streamer,
  64                                     const TargetMachine &TM,
  65                                     const MCSymbol *Sym) const;
  66
  67   /// Extract the dependent library name from a linker option string. Returns
  68   /// StringRef() if the option does not specify a library.
  69   virtual StringRef getDepLibFromLinkerOpt(StringRef LinkerOption) const {
  70     return StringRef();
  71   }
  72
  73   /// Emit the module flags that the platform cares about.
  74   virtual void emitModuleFlags(MCStreamer &Streamer,
  75                                ArrayRef<Module::ModuleFlagEntry> Flags,
  76                                Mangler &Mang, const TargetMachine &TM) const {}
  77
  78   /// Given a constant with the SectionKind, return a section that it should be
  79   /// placed in.
  80   virtual const MCSection *getSectionForConstant(SectionKind Kind,
  81                                                  const Constant *C) const;
  82
  83   /// Classify the specified global variable into a set of target independent
  84   /// categories embodied in SectionKind.
  85   static SectionKind getKindForGlobal(const GlobalValue *GV,
  86                                       const TargetMachine &TM);
  87
  88   /// This method computes the appropriate section to emit the specified global
  89   /// variable or function definition. This should not be passed external (or
  90   /// available externally) globals.
  91   const MCSection *SectionForGlobal(const GlobalValue *GV,
  92                                     SectionKind Kind, Mangler &Mang,
  93                                     const TargetMachine &TM) const;
  94
  95   /// This method computes the appropriate section to emit the specified global
  96   /// variable or function definition. This should not be passed external (or
  97   /// available externally) globals.
  98   const MCSection *SectionForGlobal(const GlobalValue *GV,
  99                                     Mangler &Mang,
 100                                     const TargetMachine &TM) const {
 101     return SectionForGlobal(GV, getKindForGlobal(GV, TM), Mang, TM);
 102   }
 103
 104   virtual const MCSection *
 105   getSectionForJumpTable(const Function &F, Mangler &Mang,
 106                          const TargetMachine &TM) const;
 107
 108   virtual bool shouldPutJumpTableInFunctionSection(bool UsesLabelDifference,
 109                                                    const Function &F) const;
 110
 111   /// Targets should implement this method to assign a section to globals with
 112   /// an explicit section specfied. The implementation of this method can
 113   /// assume that GV->hasSection() is true.
 114   virtual const MCSection *
 115   getExplicitSectionGlobal(const GlobalValue *GV, SectionKind Kind,
 116                            Mangler &Mang, const TargetMachine &TM) const = 0;
 117
 118   /// Allow the target to completely override section assignment of a global.
 119   virtual const MCSection *getSpecialCasedSectionGlobals(const GlobalValue *GV,
 120                                                          SectionKind Kind,
 121                                                          Mangler &Mang) const {
 122     return nullptr;
 123   }
 124
 125   /// Return an MCExpr to use for a reference to the specified global variable
 126   /// from exception handling information.
 127   virtual const MCExpr *
 128   getTTypeGlobalReference(const GlobalValue *GV, unsigned Encoding,
 129                           Mangler &Mang, const TargetMachine &TM,
 130                           MachineModuleInfo *MMI, MCStreamer &Streamer) const;
 131
 132   /// Return the MCSymbol for a private symbol with global value name as its
 133   /// base, with the specified suffix.
 134   MCSymbol *getSymbolWithGlobalValueBase(const GlobalValue *GV,
 135                                          StringRef Suffix, Mangler &Mang,
 136                                          const TargetMachine &TM) const;
 137
 138   // The symbol that gets passed to .cfi_personality.
 139   virtual MCSymbol *getCFIPersonalitySymbol(const GlobalValue *GV,
 140                                             Mangler &Mang,
 141                                             const TargetMachine &TM,
 142                                             MachineModuleInfo *MMI) const;
 143
 144   const MCExpr *
 145   getTTypeReference(const MCSymbolRefExpr *Sym, unsigned Encoding,
 146                     MCStreamer &Streamer) const;
 147
 148   virtual const MCSection *getStaticCtorSection(unsigned Priority,
 149                                                 const MCSymbol *KeySym) const {
 150     return StaticCtorSection;
 151   }
 152
 153   virtual const MCSection *getStaticDtorSection(unsigned Priority,
 154                                                 const MCSymbol *KeySym) const {
 155     return StaticDtorSection;
 156   }
 157
 158   /// \brief Create a symbol reference to describe the given TLS variable when
 159   /// emitting the address in debug info.
 160   virtual const MCExpr *getDebugThreadLocalSymbol(const MCSymbol *Sym) const;
 161
 162   virtual const MCExpr *
 163   getExecutableRelativeSymbol(const ConstantExpr *CE, Mangler &Mang,
 164                               const TargetMachine &TM) const {
 165     return nullptr;
 166   }
 167
 168   /// \brief Target supports replacing a data "PC"-relative access to a symbol
 169   /// through another symbol, by accessing the later via a GOT entry instead?
 170   bool supportIndirectSymViaGOTPCRel() const {
 171     return SupportIndirectSymViaGOTPCRel;
 172   }
 173
 174   /// \brief Target GOT "PC"-relative relocation supports encoding an additional
 175   /// binary expression with an offset?
 176   bool supportGOTPCRelWithOffset() const {
 177     return SupportGOTPCRelWithOffset;
 178   }
 179
 180   /// \brief Get the target specific PC relative GOT entry relocation
 181   virtual const MCExpr *getIndirectSymViaGOTPCRel(const MCSymbol *Sym,
 182                                                   const MCValue &MV,
 183                                                   int64_t Offset,
 184                                                   MachineModuleInfo *MMI,
 185                                                   MCStreamer &Streamer) const {
 186     return nullptr;
 187   }
 188
 189 protected:
 190   virtual const MCSection *
 191   SelectSectionForGlobal(const GlobalValue *GV, SectionKind Kind,
 192                          Mangler &Mang, const TargetMachine &TM) const = 0;
 193 };
 194
 195 } // end namespace llvm
 196
 197 #endif