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/MC/SectionKind.h"
  19
  20 namespace llvm {
  21   class Mangler;
  22   class MCSection;
  23   class MCSectionMachO;
  24   class MCContext;
  25   class GlobalValue;
  26   class StringRef;
  27   class TargetMachine;
  28   class TargetAsmInfo;
  29
  30 class TargetLoweringObjectFile {
  31   MCContext *Ctx;
  32
  33   TargetLoweringObjectFile(const TargetLoweringObjectFile&); // DO NOT IMPLEMENT
  34   void operator=(const TargetLoweringObjectFile&);           // DO NOT IMPLEMENT
  35 protected:
  36
  37   TargetLoweringObjectFile();
  38
  39   /// TextSection - Section directive for standard text.
  40   ///
  41   const MCSection *TextSection;
  42
  43   /// DataSection - Section directive for standard data.
  44   ///
  45   const MCSection *DataSection;
  46
  47   /// BSSSection - Section that is default initialized to zero.
  48   const MCSection *BSSSection;
  49
  50   /// ReadOnlySection - Section that is readonly and can contain arbitrary
  51   /// initialized data.  Targets are not required to have a readonly section.
  52   /// If they don't, various bits of code will fall back to using the data
  53   /// section for constants.
  54   const MCSection *ReadOnlySection;
  55
  56   /// StaticCtorSection - This section contains the static constructor pointer
  57   /// list.
  58   const MCSection *StaticCtorSection;
  59
  60   /// StaticDtorSection - This section contains the static destructor pointer
  61   /// list.
  62   const MCSection *StaticDtorSection;
  63
  64   /// LSDASection - If exception handling is supported by the target, this is
  65   /// the section the Language Specific Data Area information is emitted to.
  66   const MCSection *LSDASection;
  67
  68   /// EHFrameSection - If exception handling is supported by the target, this is
  69   /// the section the EH Frame is emitted to.
  70   const MCSection *EHFrameSection;
  71
  72   // Dwarf sections for debug info.  If a target supports debug info, these must
  73   // be set.
  74   const MCSection *DwarfAbbrevSection;
  75   const MCSection *DwarfInfoSection;
  76   const MCSection *DwarfLineSection;
  77   const MCSection *DwarfFrameSection;
  78   const MCSection *DwarfPubNamesSection;
  79   const MCSection *DwarfPubTypesSection;
  80   const MCSection *DwarfDebugInlineSection;
  81   const MCSection *DwarfStrSection;
  82   const MCSection *DwarfLocSection;
  83   const MCSection *DwarfARangesSection;
  84   const MCSection *DwarfRangesSection;
  85   const MCSection *DwarfMacroInfoSection;
  86
  87 public:
  88
  89   MCContext &getContext() const { return *Ctx; }
  90
  91
  92   virtual ~TargetLoweringObjectFile();
  93
  94   /// Initialize - this method must be called before any actual lowering is
  95   /// done.  This specifies the current context for codegen, and gives the
  96   /// lowering implementations a chance to set up their default sections.
  97   virtual void Initialize(MCContext &ctx, const TargetMachine &TM) {
  98     Ctx = &ctx;
  99   }
 100
 101
 102   const MCSection *getTextSection() const { return TextSection; }
 103   const MCSection *getDataSection() const { return DataSection; }
 104   const MCSection *getStaticCtorSection() const { return StaticCtorSection; }
 105   const MCSection *getStaticDtorSection() const { return StaticDtorSection; }
 106   const MCSection *getLSDASection() const { return LSDASection; }
 107   const MCSection *getEHFrameSection() const { return EHFrameSection; }
 108   const MCSection *getDwarfAbbrevSection() const { return DwarfAbbrevSection; }
 109   const MCSection *getDwarfInfoSection() const { return DwarfInfoSection; }
 110   const MCSection *getDwarfLineSection() const { return DwarfLineSection; }
 111   const MCSection *getDwarfFrameSection() const { return DwarfFrameSection; }
 112   const MCSection *getDwarfPubNamesSection() const{return DwarfPubNamesSection;}
 113   const MCSection *getDwarfPubTypesSection() const{return DwarfPubTypesSection;}
 114   const MCSection *getDwarfDebugInlineSection() const {
 115     return DwarfDebugInlineSection;
 116   }
 117   const MCSection *getDwarfStrSection() const { return DwarfStrSection; }
 118   const MCSection *getDwarfLocSection() const { return DwarfLocSection; }
 119   const MCSection *getDwarfARangesSection() const { return DwarfARangesSection;}
 120   const MCSection *getDwarfRangesSection() const { return DwarfRangesSection; }
 121   const MCSection *getDwarfMacroInfoSection() const {
 122     return DwarfMacroInfoSection;
 123   }
 124
 125   /// shouldEmitUsedDirectiveFor - This hook allows targets to selectively
 126   /// decide not to emit the UsedDirective for some symbols in llvm.used.
 127   /// FIXME: REMOVE this (rdar://7071300)
 128   virtual bool shouldEmitUsedDirectiveFor(const GlobalValue *GV,
 129                                           Mangler *) const {
 130     return GV != 0;
 131   }
 132
 133   /// getSectionForConstant - Given a constant with the SectionKind, return a
 134   /// section that it should be placed in.
 135   virtual const MCSection *getSectionForConstant(SectionKind Kind) const;
 136
 137   /// getKindForGlobal - Classify the specified global variable into a set of
 138   /// target independent categories embodied in SectionKind.
 139   static SectionKind getKindForGlobal(const GlobalValue *GV,
 140                                       const TargetMachine &TM);
 141
 142   /// SectionForGlobal - This method computes the appropriate section to emit
 143   /// the specified global variable or function definition.  This should not
 144   /// be passed external (or available externally) globals.
 145   const MCSection *SectionForGlobal(const GlobalValue *GV,
 146                                     SectionKind Kind, Mangler *Mang,
 147                                     const TargetMachine &TM) const;
 148
 149   /// SectionForGlobal - This method computes the appropriate section to emit
 150   /// the specified global variable or function definition.  This should not
 151   /// be passed external (or available externally) globals.
 152   const MCSection *SectionForGlobal(const GlobalValue *GV,
 153                                     Mangler *Mang,
 154                                     const TargetMachine &TM) const {
 155     return SectionForGlobal(GV, getKindForGlobal(GV, TM), Mang, TM);
 156   }
 157
 158
 159
 160   /// getExplicitSectionGlobal - Targets should implement this method to assign
 161   /// a section to globals with an explicit section specfied.  The
 162   /// implementation of this method can assume that GV->hasSection() is true.
 163   virtual const MCSection *
 164   getExplicitSectionGlobal(const GlobalValue *GV, SectionKind Kind,
 165                            Mangler *Mang, const TargetMachine &TM) const = 0;
 166
 167   /// getSpecialCasedSectionGlobals - Allow the target to completely override
 168   /// section assignment of a global.
 169   virtual const MCSection *
 170   getSpecialCasedSectionGlobals(const GlobalValue *GV, Mangler *Mang,
 171                                 SectionKind Kind) const {
 172     return 0;
 173   }
 174
 175 protected:
 176   virtual const MCSection *
 177   SelectSectionForGlobal(const GlobalValue *GV, SectionKind Kind,
 178                          Mangler *Mang, const TargetMachine &TM) const;
 179 };
 180
 181
 182
 183
 184 class TargetLoweringObjectFileELF : public TargetLoweringObjectFile {
 185   bool HasCrazyBSS;
 186   mutable void *UniquingMap;
 187 protected:
 188   /// TLSDataSection - Section directive for Thread Local data.
 189   ///
 190   const MCSection *TLSDataSection;        // Defaults to ".tdata".
 191
 192   /// TLSBSSSection - Section directive for Thread Local uninitialized data.
 193   /// Null if this target doesn't support a BSS section.
 194   ///
 195   const MCSection *TLSBSSSection;         // Defaults to ".tbss".
 196
 197   const MCSection *DataRelSection;
 198   const MCSection *DataRelLocalSection;
 199   const MCSection *DataRelROSection;
 200   const MCSection *DataRelROLocalSection;
 201
 202   const MCSection *MergeableConst4Section;
 203   const MCSection *MergeableConst8Section;
 204   const MCSection *MergeableConst16Section;
 205
 206 protected:
 207   const MCSection *getELFSection(StringRef Section, unsigned Type,
 208                                  unsigned Flags, SectionKind Kind,
 209                                  bool IsExplicit = false) const;
 210 public:
 211   TargetLoweringObjectFileELF(// FIXME: REMOVE AFTER UNIQUING IS FIXED.
 212                               bool hasCrazyBSS = false)
 213     : HasCrazyBSS(hasCrazyBSS), UniquingMap(0) {}
 214
 215   ~TargetLoweringObjectFileELF();
 216
 217
 218   virtual void Initialize(MCContext &Ctx, const TargetMachine &TM);
 219
 220   /// getSectionForConstant - Given a constant with the SectionKind, return a
 221   /// section that it should be placed in.
 222   virtual const MCSection *getSectionForConstant(SectionKind Kind) const;
 223
 224
 225   virtual const MCSection *
 226   getExplicitSectionGlobal(const GlobalValue *GV, SectionKind Kind,
 227                            Mangler *Mang, const TargetMachine &TM) const;
 228
 229   virtual const MCSection *
 230   SelectSectionForGlobal(const GlobalValue *GV, SectionKind Kind,
 231                          Mangler *Mang, const TargetMachine &TM) const;
 232 };
 233
 234
 235
 236 class TargetLoweringObjectFileMachO : public TargetLoweringObjectFile {
 237   mutable void *UniquingMap;
 238
 239   const MCSection *CStringSection;
 240   const MCSection *UStringSection;
 241   const MCSection *TextCoalSection;
 242   const MCSection *ConstTextCoalSection;
 243   const MCSection *ConstDataCoalSection;
 244   const MCSection *ConstDataSection;
 245   const MCSection *DataCoalSection;
 246   const MCSection *FourByteConstantSection;
 247   const MCSection *EightByteConstantSection;
 248   const MCSection *SixteenByteConstantSection;
 249
 250   const MCSection *LazySymbolPointerSection;
 251   const MCSection *NonLazySymbolPointerSection;
 252 public:
 253   TargetLoweringObjectFileMachO() : UniquingMap(0) {}
 254   ~TargetLoweringObjectFileMachO();
 255
 256   virtual void Initialize(MCContext &Ctx, const TargetMachine &TM);
 257
 258   virtual const MCSection *
 259   SelectSectionForGlobal(const GlobalValue *GV, SectionKind Kind,
 260                          Mangler *Mang, const TargetMachine &TM) const;
 261
 262   virtual const MCSection *
 263   getExplicitSectionGlobal(const GlobalValue *GV, SectionKind Kind,
 264                            Mangler *Mang, const TargetMachine &TM) const;
 265
 266   virtual const MCSection *getSectionForConstant(SectionKind Kind) const;
 267
 268   /// shouldEmitUsedDirectiveFor - This hook allows targets to selectively
 269   /// decide not to emit the UsedDirective for some symbols in llvm.used.
 270   /// FIXME: REMOVE this (rdar://7071300)
 271   virtual bool shouldEmitUsedDirectiveFor(const GlobalValue *GV,
 272                                           Mangler *) const;
 273
 274   /// getMachOSection - Return the MCSection for the specified mach-o section.
 275   /// This requires the operands to be valid.
 276   const MCSectionMachO *getMachOSection(const StringRef &Segment,
 277                                         const StringRef &Section,
 278                                         unsigned TypeAndAttributes,
 279                                         SectionKind K) const {
 280     return getMachOSection(Segment, Section, TypeAndAttributes, 0, K);
 281   }
 282   const MCSectionMachO *getMachOSection(const StringRef &Segment,
 283                                         const StringRef &Section,
 284                                         unsigned TypeAndAttributes,
 285                                         unsigned Reserved2,
 286                                         SectionKind K) const;
 287
 288   /// getTextCoalSection - Return the "__TEXT,__textcoal_nt" section we put weak
 289   /// symbols into.
 290   const MCSection *getTextCoalSection() const {
 291     return TextCoalSection;
 292   }
 293
 294   /// getLazySymbolPointerSection - Return the section corresponding to
 295   /// the .lazy_symbol_pointer directive.
 296   const MCSection *getLazySymbolPointerSection() const {
 297     return LazySymbolPointerSection;
 298   }
 299
 300   /// getNonLazySymbolPointerSection - Return the section corresponding to
 301   /// the .non_lazy_symbol_pointer directive.
 302   const MCSection *getNonLazySymbolPointerSection() const {
 303     return NonLazySymbolPointerSection;
 304   }
 305 };
 306
 307
 308
 309 class TargetLoweringObjectFileCOFF : public TargetLoweringObjectFile {
 310   mutable void *UniquingMap;
 311 public:
 312   TargetLoweringObjectFileCOFF() : UniquingMap(0) {}
 313   ~TargetLoweringObjectFileCOFF();
 314
 315   virtual void Initialize(MCContext &Ctx, const TargetMachine &TM);
 316
 317   virtual const MCSection *
 318   getExplicitSectionGlobal(const GlobalValue *GV, SectionKind Kind,
 319                            Mangler *Mang, const TargetMachine &TM) const;
 320
 321   virtual const MCSection *
 322   SelectSectionForGlobal(const GlobalValue *GV, SectionKind Kind,
 323                          Mangler *Mang, const TargetMachine &TM) const;
 324
 325   /// getCOFFSection - Return the MCSection for the specified COFF section.
 326   /// FIXME: Switch this to a semantic view eventually.
 327   const MCSection *getCOFFSection(const char *Name, bool isDirective,
 328                                   SectionKind K) const;
 329 };
 330
 331 } // end namespace llvm
 332
 333 #endif