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