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