include/llvm/MC/MCAsmInfo.h

   1 //===-- llvm/MC/MCAsmInfo.h - Asm 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 contains a class to be used as the basis for target specific
  11 // asm writers.  This class primarily takes care of global printing constants,
  12 // which are used in very similar ways across all targets.
  13 //
  14 //===----------------------------------------------------------------------===//
  15
  16 #ifndef LLVM_MC_MCASMINFO_H
  17 #define LLVM_MC_MCASMINFO_H
  18
  19 #include "llvm/MC/MCDirectives.h"
  20 #include "llvm/MC/MCDwarf.h"
  21 #include "llvm/MC/MachineLocation.h"
  22 #include <cassert>
  23 #include <vector>
  24
  25 namespace llvm {
  26   class MCExpr;
  27   class MCSection;
  28   class MCStreamer;
  29   class MCSymbol;
  30   class MCContext;
  31
  32   namespace ExceptionHandling {
  33     enum ExceptionsType { None, DwarfCFI, SjLj, ARM, Win64 };
  34   }
  35
  36   namespace LCOMM {
  37     enum LCOMMType { NoAlignment, ByteAlignment, Log2Alignment };
  38   }
  39
  40   /// MCAsmInfo - This class is intended to be used as a base class for asm
  41   /// properties and features specific to the target.
  42   class MCAsmInfo {
  43   protected:
  44     //===------------------------------------------------------------------===//
  45     // Properties to be set by the target writer, used to configure asm printer.
  46     //
  47
  48     /// PointerSize - Pointer size in bytes.
  49     ///               Default is 4.
  50     unsigned PointerSize;
  51
  52     /// CalleeSaveStackSlotSize - Size of the stack slot reserved for
  53     ///                           callee-saved registers, in bytes.
  54     ///                           Default is same as pointer size.
  55     unsigned CalleeSaveStackSlotSize;
  56
  57     /// IsLittleEndian - True if target is little endian.
  58     ///                  Default is true.
  59     bool IsLittleEndian;
  60
  61     /// StackGrowsUp - True if target stack grow up.
  62     ///                Default is false.
  63     bool StackGrowsUp;
  64
  65     /// HasSubsectionsViaSymbols - True if this target has the MachO
  66     /// .subsections_via_symbols directive.
  67     bool HasSubsectionsViaSymbols;           // Default is false.
  68
  69     /// HasMachoZeroFillDirective - True if this is a MachO target that supports
  70     /// the macho-specific .zerofill directive for emitting BSS Symbols.
  71     bool HasMachoZeroFillDirective;               // Default is false.
  72
  73     /// HasMachoTBSSDirective - True if this is a MachO target that supports
  74     /// the macho-specific .tbss directive for emitting thread local BSS Symbols
  75     bool HasMachoTBSSDirective;                 // Default is false.
  76
  77     /// HasStaticCtorDtorReferenceInStaticMode - True if the compiler should
  78     /// emit a ".reference .constructors_used" or ".reference .destructors_used"
  79     /// directive after the a static ctor/dtor list.  This directive is only
  80     /// emitted in Static relocation model.
  81     bool HasStaticCtorDtorReferenceInStaticMode;  // Default is false.
  82
  83     /// LinkerRequiresNonEmptyDwarfLines - True if the linker has a bug and
  84     /// requires that the debug_line section be of a minimum size. In practice
  85     /// such a linker requires a non-empty line sequence if a file is present.
  86     bool LinkerRequiresNonEmptyDwarfLines; // Default to false.
  87
  88     /// MaxInstLength - This is the maximum possible length of an instruction,
  89     /// which is needed to compute the size of an inline asm.
  90     unsigned MaxInstLength;                  // Defaults to 4.
  91
  92     /// MinInstAlignment - Every possible instruction length is a multiple of
  93     /// this value.  Factored out in .debug_frame and .debug_line.
  94     unsigned MinInstAlignment;                  // Defaults to 1.
  95
  96     /// DollarIsPC - The '$' token, when not referencing an identifier or
  97     /// constant, refers to the current PC.
  98     bool DollarIsPC;                         // Defaults to false.
  99
 100     /// SeparatorString - This string, if specified, is used to separate
 101     /// instructions from each other when on the same line.
 102     const char *SeparatorString;             // Defaults to ';'
 103
 104     /// CommentColumn - This indicates the comment num (zero-based) at
 105     /// which asm comments should be printed.
 106     unsigned CommentColumn;                  // Defaults to 40
 107
 108     /// CommentString - This indicates the comment character used by the
 109     /// assembler.
 110     const char *CommentString;               // Defaults to "#"
 111
 112     /// LabelSuffix - This is appended to emitted labels.
 113     const char *LabelSuffix;                 // Defaults to ":"
 114
 115     /// LabelSuffix - This is appended to emitted labels.
 116     const char *DebugLabelSuffix;                 // Defaults to ":"
 117
 118     /// If this is set to anything other than '\0', it is prepended
 119     /// onto all global symbols.  This is often used for '_'.
 120     char GlobalPrefix;                // Defaults to '\0'
 121
 122     /// This prefix is used for globals like constant pool entries that are
 123     /// completely private to the .s file and should not have names in the .o
 124     /// file.
 125     const char *PrivateGlobalPrefix;         // Defaults to "L"
 126
 127     /// LinkerPrivateGlobalPrefix - This prefix is used for symbols that should
 128     /// be passed through the assembler but be removed by the linker.  This
 129     /// is "l" on Darwin, currently used for some ObjC metadata.
 130     const char *LinkerPrivateGlobalPrefix;   // Defaults to ""
 131
 132     /// InlineAsmStart/End - If these are nonempty, they contain a directive to
 133     /// emit before and after an inline assembly statement.
 134     const char *InlineAsmStart;              // Defaults to "#APP\n"
 135     const char *InlineAsmEnd;                // Defaults to "#NO_APP\n"
 136
 137     /// Code16Directive, Code32Directive, Code64Directive - These are assembly
 138     /// directives that tells the assembler to interpret the following
 139     /// instructions differently.
 140     const char *Code16Directive;             // Defaults to ".code16"
 141     const char *Code32Directive;             // Defaults to ".code32"
 142     const char *Code64Directive;             // Defaults to ".code64"
 143
 144     /// AssemblerDialect - Which dialect of an assembler variant to use.
 145     unsigned AssemblerDialect;               // Defaults to 0
 146
 147     /// \brief This is true if the assembler allows @ characters in symbol
 148     /// names. Defaults to false.
 149     bool AllowAtInName;
 150
 151     /// UseDataRegionDirectives - This is true if data region markers should
 152     /// be printed as ".data_region/.end_data_region" directives. If false,
 153     /// use "$d/$a" labels instead.
 154     bool UseDataRegionDirectives;
 155
 156     //===--- Data Emission Directives -------------------------------------===//
 157
 158     /// ZeroDirective - this should be set to the directive used to get some
 159     /// number of zero bytes emitted to the current section.  Common cases are
 160     /// "\t.zero\t" and "\t.space\t".  If this is set to null, the
 161     /// Data*bitsDirective's will be used to emit zero bytes.
 162     const char *ZeroDirective;               // Defaults to "\t.zero\t"
 163
 164     /// AsciiDirective - This directive allows emission of an ascii string with
 165     /// the standard C escape characters embedded into it.
 166     const char *AsciiDirective;              // Defaults to "\t.ascii\t"
 167
 168     /// AscizDirective - If not null, this allows for special handling of
 169     /// zero terminated strings on this target.  This is commonly supported as
 170     /// ".asciz".  If a target doesn't support this, it can be set to null.
 171     const char *AscizDirective;              // Defaults to "\t.asciz\t"
 172
 173     /// DataDirectives - These directives are used to output some unit of
 174     /// integer data to the current section.  If a data directive is set to
 175     /// null, smaller data directives will be used to emit the large sizes.
 176     const char *Data8bitsDirective;          // Defaults to "\t.byte\t"
 177     const char *Data16bitsDirective;         // Defaults to "\t.short\t"
 178     const char *Data32bitsDirective;         // Defaults to "\t.long\t"
 179     const char *Data64bitsDirective;         // Defaults to "\t.quad\t"
 180
 181     /// GPRel64Directive - if non-null, a directive that is used to emit a word
 182     /// which should be relocated as a 64-bit GP-relative offset, e.g. .gpdword
 183     /// on Mips.
 184     const char *GPRel64Directive;            // Defaults to NULL.
 185
 186     /// GPRel32Directive - if non-null, a directive that is used to emit a word
 187     /// which should be relocated as a 32-bit GP-relative offset, e.g. .gpword
 188     /// on Mips or .gprel32 on Alpha.
 189     const char *GPRel32Directive;            // Defaults to NULL.
 190
 191     /// SunStyleELFSectionSwitchSyntax - This is true if this target uses "Sun
 192     /// Style" syntax for section switching ("#alloc,#write" etc) instead of the
 193     /// normal ELF syntax (,"a,w") in .section directives.
 194     bool SunStyleELFSectionSwitchSyntax;     // Defaults to false.
 195
 196     /// UsesELFSectionDirectiveForBSS - This is true if this target uses ELF
 197     /// '.section' directive before the '.bss' one. It's used for PPC/Linux
 198     /// which doesn't support the '.bss' directive only.
 199     bool UsesELFSectionDirectiveForBSS;      // Defaults to false.
 200
 201     /// HasMicrosoftFastStdCallMangling - True if this target uses microsoft
 202     /// style mangling for functions with X86_StdCall/X86_FastCall calling
 203     /// convention.
 204     bool HasMicrosoftFastStdCallMangling;    // Defaults to false.
 205
 206     bool NeedsDwarfSectionOffsetDirective;
 207
 208     //===--- Alignment Information ----------------------------------------===//
 209
 210     /// AlignDirective - The directive used to emit round up to an alignment
 211     /// boundary.
 212     ///
 213     const char *AlignDirective;              // Defaults to "\t.align\t"
 214
 215     /// AlignmentIsInBytes - If this is true (the default) then the asmprinter
 216     /// emits ".align N" directives, where N is the number of bytes to align to.
 217     /// Otherwise, it emits ".align log2(N)", e.g. 3 to align to an 8 byte
 218     /// boundary.
 219     bool AlignmentIsInBytes;                 // Defaults to true
 220
 221     /// TextAlignFillValue - If non-zero, this is used to fill the executable
 222     /// space created as the result of a alignment directive.
 223     unsigned TextAlignFillValue;             // Defaults to 0
 224
 225     //===--- Global Variable Emission Directives --------------------------===//
 226
 227     /// GlobalDirective - This is the directive used to declare a global entity.
 228     ///
 229     const char *GlobalDirective;             // Defaults to NULL.
 230
 231     /// HasSetDirective - True if the assembler supports the .set directive.
 232     bool HasSetDirective;                    // Defaults to true.
 233
 234     /// HasAggressiveSymbolFolding - False if the assembler requires that we use
 235     /// Lc = a - b
 236     /// .long Lc
 237     /// instead of
 238     /// .long a - b
 239     bool HasAggressiveSymbolFolding;           // Defaults to true.
 240
 241     /// COMMDirectiveAlignmentIsInBytes - True is .comm's and .lcomms optional
 242     /// alignment is to be specified in bytes instead of log2(n).
 243     bool COMMDirectiveAlignmentIsInBytes;    // Defaults to true;
 244
 245     /// LCOMMDirectiveAlignment - Describes if the .lcomm directive for the
 246     /// target supports an alignment argument and how it is interpreted.
 247     LCOMM::LCOMMType LCOMMDirectiveAlignmentType; // Defaults to NoAlignment.
 248
 249     /// HasDotTypeDotSizeDirective - True if the target has .type and .size
 250     /// directives, this is true for most ELF targets.
 251     bool HasDotTypeDotSizeDirective;         // Defaults to true.
 252
 253     /// HasSingleParameterDotFile - True if the target has a single parameter
 254     /// .file directive, this is true for ELF targets.
 255     bool HasSingleParameterDotFile;          // Defaults to true.
 256
 257     /// hasIdentDirective - True if the target has a .ident directive, this is
 258     /// true for ELF targets.
 259     bool HasIdentDirective;                  // Defaults to false.
 260
 261     /// HasNoDeadStrip - True if this target supports the MachO .no_dead_strip
 262     /// directive.
 263     bool HasNoDeadStrip;                     // Defaults to false.
 264
 265     /// WeakRefDirective - This directive, if non-null, is used to declare a
 266     /// global as being a weak undefined symbol.
 267     const char *WeakRefDirective;            // Defaults to NULL.
 268
 269     /// True if we have a directive to declare a global as being a weak
 270     /// defined symbol.
 271     bool HasWeakDefDirective;                // Defaults to false.
 272
 273     /// True if we have a .linkonce directive.  This is used on cygwin/mingw.
 274     bool HasLinkOnceDirective;               // Defaults to false.
 275
 276     /// HiddenVisibilityAttr - This attribute, if not MCSA_Invalid, is used to
 277     /// declare a symbol as having hidden visibility.
 278     MCSymbolAttr HiddenVisibilityAttr;       // Defaults to MCSA_Hidden.
 279
 280     /// HiddenDeclarationVisibilityAttr - This attribute, if not MCSA_Invalid,
 281     /// is used to declare an undefined symbol as having hidden visibility.
 282     MCSymbolAttr HiddenDeclarationVisibilityAttr;   // Defaults to MCSA_Hidden.
 283
 284
 285     /// ProtectedVisibilityAttr - This attribute, if not MCSA_Invalid, is used
 286     /// to declare a symbol as having protected visibility.
 287     MCSymbolAttr ProtectedVisibilityAttr;    // Defaults to MCSA_Protected
 288
 289     //===--- Dwarf Emission Directives -----------------------------------===//
 290
 291     /// HasLEB128 - True if target asm supports leb128 directives.
 292     bool HasLEB128;                          // Defaults to false.
 293
 294     /// SupportsDebugInformation - True if target supports emission of debugging
 295     /// information.
 296     bool SupportsDebugInformation;           // Defaults to false.
 297
 298     /// SupportsExceptionHandling - True if target supports exception handling.
 299     ExceptionHandling::ExceptionsType ExceptionsType; // Defaults to None
 300
 301     /// DwarfUsesRelocationsAcrossSections - True if Dwarf2 output generally
 302     /// uses relocations for references to other .debug_* sections.
 303     bool DwarfUsesRelocationsAcrossSections;
 304
 305     /// DwarfRegNumForCFI - True if dwarf register numbers are printed
 306     /// instead of symbolic register names in .cfi_* directives.
 307     bool DwarfRegNumForCFI;  // Defaults to false;
 308
 309     /// UseParensForSymbolVariant - True if target uses parens to indicate the
 310     /// symbol variant instead of @. For example, foo(plt) instead of foo@plt.
 311     bool UseParensForSymbolVariant; // Defaults to false;
 312
 313     //===--- Prologue State ----------------------------------------------===//
 314
 315     std::vector<MCCFIInstruction> InitialFrameState;
 316
 317   public:
 318     explicit MCAsmInfo();
 319     virtual ~MCAsmInfo();
 320
 321     // FIXME: move these methods to DwarfPrinter when the JIT stops using them.
 322     static unsigned getSLEB128Size(int64_t Value);
 323     static unsigned getULEB128Size(uint64_t Value);
 324
 325     /// getPointerSize - Get the pointer size in bytes.
 326     unsigned getPointerSize() const {
 327       return PointerSize;
 328     }
 329
 330     /// getCalleeSaveStackSlotSize - Get the callee-saved register stack slot
 331     /// size in bytes.
 332     unsigned getCalleeSaveStackSlotSize() const {
 333       return CalleeSaveStackSlotSize;
 334     }
 335
 336     /// isLittleEndian - True if the target is little endian.
 337     bool isLittleEndian() const {
 338       return IsLittleEndian;
 339     }
 340
 341     /// isStackGrowthDirectionUp - True if target stack grow up.
 342     bool isStackGrowthDirectionUp() const {
 343       return StackGrowsUp;
 344     }
 345
 346     bool hasSubsectionsViaSymbols() const { return HasSubsectionsViaSymbols; }
 347
 348     // Data directive accessors.
 349     //
 350     const char *getData8bitsDirective() const {
 351       return Data8bitsDirective;
 352     }
 353     const char *getData16bitsDirective() const {
 354       return Data16bitsDirective;
 355     }
 356     const char *getData32bitsDirective() const {
 357       return Data32bitsDirective;
 358     }
 359     const char *getData64bitsDirective() const {
 360       return Data64bitsDirective;
 361     }
 362     const char *getGPRel64Directive() const { return GPRel64Directive; }
 363     const char *getGPRel32Directive() const { return GPRel32Directive; }
 364
 365     /// getNonexecutableStackSection - Targets can implement this method to
 366     /// specify a section to switch to if the translation unit doesn't have any
 367     /// trampolines that require an executable stack.
 368     virtual const MCSection *getNonexecutableStackSection(MCContext &Ctx) const{
 369       return 0;
 370     }
 371
 372     virtual const MCExpr *
 373     getExprForPersonalitySymbol(const MCSymbol *Sym,
 374                                 unsigned Encoding,
 375                                 MCStreamer &Streamer) const;
 376
 377     const MCExpr *
 378     getExprForFDESymbol(const MCSymbol *Sym,
 379                         unsigned Encoding,
 380                         MCStreamer &Streamer) const;
 381
 382     bool usesSunStyleELFSectionSwitchSyntax() const {
 383       return SunStyleELFSectionSwitchSyntax;
 384     }
 385
 386     bool usesELFSectionDirectiveForBSS() const {
 387       return UsesELFSectionDirectiveForBSS;
 388     }
 389
 390     bool hasMicrosoftFastStdCallMangling() const {
 391       return HasMicrosoftFastStdCallMangling;
 392     }
 393
 394     bool needsDwarfSectionOffsetDirective() const {
 395       return NeedsDwarfSectionOffsetDirective;
 396     }
 397
 398     // Accessors.
 399     //
 400     bool hasMachoZeroFillDirective() const { return HasMachoZeroFillDirective; }
 401     bool hasMachoTBSSDirective() const { return HasMachoTBSSDirective; }
 402     bool hasStaticCtorDtorReferenceInStaticMode() const {
 403       return HasStaticCtorDtorReferenceInStaticMode;
 404     }
 405     bool getLinkerRequiresNonEmptyDwarfLines() const {
 406       return LinkerRequiresNonEmptyDwarfLines;
 407     }
 408     unsigned getMaxInstLength() const {
 409       return MaxInstLength;
 410     }
 411     unsigned getMinInstAlignment() const {
 412       return MinInstAlignment;
 413     }
 414     bool getDollarIsPC() const {
 415       return DollarIsPC;
 416     }
 417     const char *getSeparatorString() const {
 418       return SeparatorString;
 419     }
 420     unsigned getCommentColumn() const {
 421       return CommentColumn;
 422     }
 423     const char *getCommentString() const {
 424       return CommentString;
 425     }
 426     const char *getLabelSuffix() const {
 427       return LabelSuffix;
 428     }
 429
 430     const char *getDebugLabelSuffix() const {
 431       return DebugLabelSuffix;
 432     }
 433
 434     char getGlobalPrefix() const {
 435       return GlobalPrefix;
 436     }
 437     const char *getPrivateGlobalPrefix() const {
 438       return PrivateGlobalPrefix;
 439     }
 440     const char *getLinkerPrivateGlobalPrefix() const {
 441       return LinkerPrivateGlobalPrefix;
 442     }
 443     const char *getInlineAsmStart() const {
 444       return InlineAsmStart;
 445     }
 446     const char *getInlineAsmEnd() const {
 447       return InlineAsmEnd;
 448     }
 449     const char *getCode16Directive() const {
 450       return Code16Directive;
 451     }
 452     const char *getCode32Directive() const {
 453       return Code32Directive;
 454     }
 455     const char *getCode64Directive() const {
 456       return Code64Directive;
 457     }
 458     unsigned getAssemblerDialect() const {
 459       return AssemblerDialect;
 460     }
 461     bool doesAllowAtInName() const {
 462       return AllowAtInName;
 463     }
 464     bool doesSupportDataRegionDirectives() const {
 465       return UseDataRegionDirectives;
 466     }
 467     const char *getZeroDirective() const {
 468       return ZeroDirective;
 469     }
 470     const char *getAsciiDirective() const {
 471       return AsciiDirective;
 472     }
 473     const char *getAscizDirective() const {
 474       return AscizDirective;
 475     }
 476     const char *getAlignDirective() const {
 477       return AlignDirective;
 478     }
 479     bool getAlignmentIsInBytes() const {
 480       return AlignmentIsInBytes;
 481     }
 482     unsigned getTextAlignFillValue() const {
 483       return TextAlignFillValue;
 484     }
 485     const char *getGlobalDirective() const {
 486       return GlobalDirective;
 487     }
 488     bool hasSetDirective() const { return HasSetDirective; }
 489     bool hasAggressiveSymbolFolding() const {
 490       return HasAggressiveSymbolFolding;
 491     }
 492     bool getCOMMDirectiveAlignmentIsInBytes() const {
 493       return COMMDirectiveAlignmentIsInBytes;
 494     }
 495     LCOMM::LCOMMType getLCOMMDirectiveAlignmentType() const {
 496       return LCOMMDirectiveAlignmentType;
 497     }
 498     bool hasDotTypeDotSizeDirective() const {return HasDotTypeDotSizeDirective;}
 499     bool hasSingleParameterDotFile() const { return HasSingleParameterDotFile; }
 500     bool hasIdentDirective() const { return HasIdentDirective; }
 501     bool hasNoDeadStrip() const { return HasNoDeadStrip; }
 502     const char *getWeakRefDirective() const { return WeakRefDirective; }
 503     bool hasWeakDefDirective() const { return HasWeakDefDirective; }
 504     bool hasLinkOnceDirective() const { return HasLinkOnceDirective; }
 505
 506     MCSymbolAttr getHiddenVisibilityAttr() const { return HiddenVisibilityAttr;}
 507     MCSymbolAttr getHiddenDeclarationVisibilityAttr() const {
 508       return HiddenDeclarationVisibilityAttr;
 509     }
 510     MCSymbolAttr getProtectedVisibilityAttr() const {
 511       return ProtectedVisibilityAttr;
 512     }
 513     bool hasLEB128() const {
 514       return HasLEB128;
 515     }
 516     bool doesSupportDebugInformation() const {
 517       return SupportsDebugInformation;
 518     }
 519     bool doesSupportExceptionHandling() const {
 520       return ExceptionsType != ExceptionHandling::None;
 521     }
 522     ExceptionHandling::ExceptionsType getExceptionHandlingType() const {
 523       return ExceptionsType;
 524     }
 525     bool isExceptionHandlingDwarf() const {
 526       return
 527         (ExceptionsType == ExceptionHandling::DwarfCFI ||
 528          ExceptionsType == ExceptionHandling::ARM ||
 529          ExceptionsType == ExceptionHandling::Win64);
 530     }
 531     bool doesDwarfUseRelocationsAcrossSections() const {
 532       return DwarfUsesRelocationsAcrossSections;
 533     }
 534     bool useDwarfRegNumForCFI() const {
 535       return DwarfRegNumForCFI;
 536     }
 537     bool useParensForSymbolVariant() const {
 538       return UseParensForSymbolVariant;
 539     }
 540
 541     void addInitialFrameState(const MCCFIInstruction &Inst) {
 542       InitialFrameState.push_back(Inst);
 543     }
 544
 545     const std::vector<MCCFIInstruction> &getInitialFrameState() const {
 546       return InitialFrameState;
 547     }
 548   };
 549 }
 550
 551 #endif