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     /// CommentString - This indicates the comment character used by the
 105     /// assembler.
 106     const char *CommentString;               // Defaults to "#"
 107
 108     /// LabelSuffix - This is appended to emitted labels.
 109     const char *LabelSuffix;                 // Defaults to ":"
 110
 111     /// LabelSuffix - This is appended to emitted labels.
 112     const char *DebugLabelSuffix;                 // Defaults to ":"
 113
 114     /// This prefix is used for globals like constant pool entries that are
 115     /// completely private to the .s file and should not have names in the .o
 116     /// file.
 117     const char *PrivateGlobalPrefix;         // Defaults to "L"
 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     /// \brief This is true if the assembler allows @ characters in symbol
 135     /// names. Defaults to false.
 136     bool AllowAtInName;
 137
 138     /// UseDataRegionDirectives - This is true if data region markers should
 139     /// be printed as ".data_region/.end_data_region" directives. If false,
 140     /// use "$d/$a" labels instead.
 141     bool UseDataRegionDirectives;
 142
 143     //===--- Data Emission Directives -------------------------------------===//
 144
 145     /// ZeroDirective - this should be set to the directive used to get some
 146     /// number of zero bytes emitted to the current section.  Common cases are
 147     /// "\t.zero\t" and "\t.space\t".  If this is set to null, the
 148     /// Data*bitsDirective's will be used to emit zero bytes.
 149     const char *ZeroDirective;               // Defaults to "\t.zero\t"
 150
 151     /// AsciiDirective - This directive allows emission of an ascii string with
 152     /// the standard C escape characters embedded into it.
 153     const char *AsciiDirective;              // Defaults to "\t.ascii\t"
 154
 155     /// AscizDirective - If not null, this allows for special handling of
 156     /// zero terminated strings on this target.  This is commonly supported as
 157     /// ".asciz".  If a target doesn't support this, it can be set to null.
 158     const char *AscizDirective;              // Defaults to "\t.asciz\t"
 159
 160     /// DataDirectives - These directives are used to output some unit of
 161     /// integer data to the current section.  If a data directive is set to
 162     /// null, smaller data directives will be used to emit the large sizes.
 163     const char *Data8bitsDirective;          // Defaults to "\t.byte\t"
 164     const char *Data16bitsDirective;         // Defaults to "\t.short\t"
 165     const char *Data32bitsDirective;         // Defaults to "\t.long\t"
 166     const char *Data64bitsDirective;         // Defaults to "\t.quad\t"
 167
 168     /// GPRel64Directive - if non-null, a directive that is used to emit a word
 169     /// which should be relocated as a 64-bit GP-relative offset, e.g. .gpdword
 170     /// on Mips.
 171     const char *GPRel64Directive;            // Defaults to NULL.
 172
 173     /// GPRel32Directive - if non-null, a directive that is used to emit a word
 174     /// which should be relocated as a 32-bit GP-relative offset, e.g. .gpword
 175     /// on Mips or .gprel32 on Alpha.
 176     const char *GPRel32Directive;            // Defaults to NULL.
 177
 178     /// SunStyleELFSectionSwitchSyntax - This is true if this target uses "Sun
 179     /// Style" syntax for section switching ("#alloc,#write" etc) instead of the
 180     /// normal ELF syntax (,"a,w") in .section directives.
 181     bool SunStyleELFSectionSwitchSyntax;     // Defaults to false.
 182
 183     /// UsesELFSectionDirectiveForBSS - This is true if this target uses ELF
 184     /// '.section' directive before the '.bss' one. It's used for PPC/Linux
 185     /// which doesn't support the '.bss' directive only.
 186     bool UsesELFSectionDirectiveForBSS;      // Defaults to false.
 187
 188     bool NeedsDwarfSectionOffsetDirective;
 189
 190     //===--- Alignment Information ----------------------------------------===//
 191
 192     /// AlignmentIsInBytes - If this is true (the default) then the asmprinter
 193     /// emits ".align N" directives, where N is the number of bytes to align to.
 194     /// Otherwise, it emits ".align log2(N)", e.g. 3 to align to an 8 byte
 195     /// boundary.
 196     bool AlignmentIsInBytes;                 // Defaults to true
 197
 198     /// TextAlignFillValue - If non-zero, this is used to fill the executable
 199     /// space created as the result of a alignment directive.
 200     unsigned TextAlignFillValue;             // Defaults to 0
 201
 202     //===--- Global Variable Emission Directives --------------------------===//
 203
 204     /// GlobalDirective - This is the directive used to declare a global entity.
 205     ///
 206     const char *GlobalDirective;             // Defaults to NULL.
 207
 208     /// HasSetDirective - True if the assembler supports the .set directive.
 209     bool HasSetDirective;                    // Defaults to true.
 210
 211     /// HasAggressiveSymbolFolding - False if the assembler requires that we use
 212     /// Lc = a - b
 213     /// .long Lc
 214     /// instead of
 215     /// .long a - b
 216     bool HasAggressiveSymbolFolding;           // Defaults to true.
 217
 218     /// COMMDirectiveAlignmentIsInBytes - True is .comm's and .lcomms optional
 219     /// alignment is to be specified in bytes instead of log2(n).
 220     bool COMMDirectiveAlignmentIsInBytes;    // Defaults to true;
 221
 222     /// LCOMMDirectiveAlignment - Describes if the .lcomm directive for the
 223     /// target supports an alignment argument and how it is interpreted.
 224     LCOMM::LCOMMType LCOMMDirectiveAlignmentType; // Defaults to NoAlignment.
 225
 226     /// HasDotTypeDotSizeDirective - True if the target has .type and .size
 227     /// directives, this is true for most ELF targets.
 228     bool HasDotTypeDotSizeDirective;         // Defaults to true.
 229
 230     /// HasSingleParameterDotFile - True if the target has a single parameter
 231     /// .file directive, this is true for ELF targets.
 232     bool HasSingleParameterDotFile;          // Defaults to true.
 233
 234     /// hasIdentDirective - True if the target has a .ident directive, this is
 235     /// true for ELF targets.
 236     bool HasIdentDirective;                  // Defaults to false.
 237
 238     /// HasNoDeadStrip - True if this target supports the MachO .no_dead_strip
 239     /// directive.
 240     bool HasNoDeadStrip;                     // Defaults to false.
 241
 242     /// WeakRefDirective - This directive, if non-null, is used to declare a
 243     /// global as being a weak undefined symbol.
 244     const char *WeakRefDirective;            // Defaults to NULL.
 245
 246     /// True if we have a directive to declare a global as being a weak
 247     /// defined symbol.
 248     bool HasWeakDefDirective;                // Defaults to false.
 249
 250     /// True if we have a directive to declare a global as being a weak
 251     /// defined symbol that can be hidden (unexported).
 252     bool HasWeakDefCanBeHiddenDirective;     // Defaults to false.
 253
 254     /// True if we have a .linkonce directive.  This is used on cygwin/mingw.
 255     bool HasLinkOnceDirective;               // Defaults to false.
 256
 257     /// HiddenVisibilityAttr - This attribute, if not MCSA_Invalid, is used to
 258     /// declare a symbol as having hidden visibility.
 259     MCSymbolAttr HiddenVisibilityAttr;       // Defaults to MCSA_Hidden.
 260
 261     /// HiddenDeclarationVisibilityAttr - This attribute, if not MCSA_Invalid,
 262     /// is used to declare an undefined symbol as having hidden visibility.
 263     MCSymbolAttr HiddenDeclarationVisibilityAttr;   // Defaults to MCSA_Hidden.
 264
 265
 266     /// ProtectedVisibilityAttr - This attribute, if not MCSA_Invalid, is used
 267     /// to declare a symbol as having protected visibility.
 268     MCSymbolAttr ProtectedVisibilityAttr;    // Defaults to MCSA_Protected
 269
 270     //===--- Dwarf Emission Directives -----------------------------------===//
 271
 272     /// HasLEB128 - True if target asm supports leb128 directives.
 273     bool HasLEB128;                          // Defaults to false.
 274
 275     /// SupportsDebugInformation - True if target supports emission of debugging
 276     /// information.
 277     bool SupportsDebugInformation;           // Defaults to false.
 278
 279     /// SupportsExceptionHandling - True if target supports exception handling.
 280     ExceptionHandling::ExceptionsType ExceptionsType; // Defaults to None
 281
 282     /// DwarfUsesRelocationsAcrossSections - True if Dwarf2 output generally
 283     /// uses relocations for references to other .debug_* sections.
 284     bool DwarfUsesRelocationsAcrossSections;
 285
 286     /// DwarfFDESymbolsUseAbsDiff - true if DWARF FDE symbol reference
 287     /// relocations should be replaced by an absolute difference.
 288     bool DwarfFDESymbolsUseAbsDiff;
 289
 290     /// DwarfRegNumForCFI - True if dwarf register numbers are printed
 291     /// instead of symbolic register names in .cfi_* directives.
 292     bool DwarfRegNumForCFI;  // Defaults to false;
 293
 294     /// UseParensForSymbolVariant - True if target uses parens to indicate the
 295     /// symbol variant instead of @. For example, foo(plt) instead of foo@plt.
 296     bool UseParensForSymbolVariant; // Defaults to false;
 297
 298     //===--- Prologue State ----------------------------------------------===//
 299
 300     std::vector<MCCFIInstruction> InitialFrameState;
 301
 302     //===--- Integrated Assembler State ----------------------------------===//
 303     /// Should we use the integrated assembler?
 304     /// The integrated assembler should be enabled by default (by the
 305     /// constructors) when failing to parse a valid piece of assembly (inline
 306     /// or otherwise) is considered a bug. It may then be overridden after
 307     /// construction (see LLVMTargetMachine::initAsmInfo()).
 308     bool UseIntegratedAssembler;
 309
 310   public:
 311     explicit MCAsmInfo();
 312     virtual ~MCAsmInfo();
 313
 314     // FIXME: move these methods to DwarfPrinter when the JIT stops using them.
 315     static unsigned getSLEB128Size(int64_t Value);
 316     static unsigned getULEB128Size(uint64_t Value);
 317
 318     /// getPointerSize - Get the pointer size in bytes.
 319     unsigned getPointerSize() const {
 320       return PointerSize;
 321     }
 322
 323     /// getCalleeSaveStackSlotSize - Get the callee-saved register stack slot
 324     /// size in bytes.
 325     unsigned getCalleeSaveStackSlotSize() const {
 326       return CalleeSaveStackSlotSize;
 327     }
 328
 329     /// isLittleEndian - True if the target is little endian.
 330     bool isLittleEndian() const {
 331       return IsLittleEndian;
 332     }
 333
 334     /// isStackGrowthDirectionUp - True if target stack grow up.
 335     bool isStackGrowthDirectionUp() const {
 336       return StackGrowsUp;
 337     }
 338
 339     bool hasSubsectionsViaSymbols() const { return HasSubsectionsViaSymbols; }
 340
 341     // Data directive accessors.
 342     //
 343     const char *getData8bitsDirective() const {
 344       return Data8bitsDirective;
 345     }
 346     const char *getData16bitsDirective() const {
 347       return Data16bitsDirective;
 348     }
 349     const char *getData32bitsDirective() const {
 350       return Data32bitsDirective;
 351     }
 352     const char *getData64bitsDirective() const {
 353       return Data64bitsDirective;
 354     }
 355     const char *getGPRel64Directive() const { return GPRel64Directive; }
 356     const char *getGPRel32Directive() const { return GPRel32Directive; }
 357
 358     /// getNonexecutableStackSection - Targets can implement this method to
 359     /// specify a section to switch to if the translation unit doesn't have any
 360     /// trampolines that require an executable stack.
 361     virtual const MCSection *getNonexecutableStackSection(MCContext &Ctx) const{
 362       return 0;
 363     }
 364
 365     virtual const MCExpr *
 366     getExprForPersonalitySymbol(const MCSymbol *Sym,
 367                                 unsigned Encoding,
 368                                 MCStreamer &Streamer) const;
 369
 370     virtual const MCExpr *
 371     getExprForFDESymbol(const MCSymbol *Sym,
 372                         unsigned Encoding,
 373                         MCStreamer &Streamer) const;
 374
 375     bool usesSunStyleELFSectionSwitchSyntax() const {
 376       return SunStyleELFSectionSwitchSyntax;
 377     }
 378
 379     bool usesELFSectionDirectiveForBSS() const {
 380       return UsesELFSectionDirectiveForBSS;
 381     }
 382
 383     bool needsDwarfSectionOffsetDirective() const {
 384       return NeedsDwarfSectionOffsetDirective;
 385     }
 386
 387     // Accessors.
 388     //
 389     bool hasMachoZeroFillDirective() const { return HasMachoZeroFillDirective; }
 390     bool hasMachoTBSSDirective() const { return HasMachoTBSSDirective; }
 391     bool hasStaticCtorDtorReferenceInStaticMode() const {
 392       return HasStaticCtorDtorReferenceInStaticMode;
 393     }
 394     bool getLinkerRequiresNonEmptyDwarfLines() const {
 395       return LinkerRequiresNonEmptyDwarfLines;
 396     }
 397     unsigned getMaxInstLength() const {
 398       return MaxInstLength;
 399     }
 400     unsigned getMinInstAlignment() const {
 401       return MinInstAlignment;
 402     }
 403     bool getDollarIsPC() const {
 404       return DollarIsPC;
 405     }
 406     const char *getSeparatorString() const {
 407       return SeparatorString;
 408     }
 409
 410     /// This indicates the column (zero-based) at which asm comments should be
 411     /// printed.
 412     unsigned getCommentColumn() const {
 413       return 40;
 414     }
 415
 416     const char *getCommentString() const {
 417       return CommentString;
 418     }
 419     const char *getLabelSuffix() const {
 420       return LabelSuffix;
 421     }
 422
 423     const char *getDebugLabelSuffix() const {
 424       return DebugLabelSuffix;
 425     }
 426     const char *getPrivateGlobalPrefix() const {
 427       return PrivateGlobalPrefix;
 428     }
 429     const char *getInlineAsmStart() const {
 430       return InlineAsmStart;
 431     }
 432     const char *getInlineAsmEnd() const {
 433       return InlineAsmEnd;
 434     }
 435     const char *getCode16Directive() const {
 436       return Code16Directive;
 437     }
 438     const char *getCode32Directive() const {
 439       return Code32Directive;
 440     }
 441     const char *getCode64Directive() const {
 442       return Code64Directive;
 443     }
 444     unsigned getAssemblerDialect() const {
 445       return AssemblerDialect;
 446     }
 447     bool doesAllowAtInName() const {
 448       return AllowAtInName;
 449     }
 450     bool doesSupportDataRegionDirectives() const {
 451       return UseDataRegionDirectives;
 452     }
 453     const char *getZeroDirective() const {
 454       return ZeroDirective;
 455     }
 456     const char *getAsciiDirective() const {
 457       return AsciiDirective;
 458     }
 459     const char *getAscizDirective() const {
 460       return AscizDirective;
 461     }
 462     bool getAlignmentIsInBytes() const {
 463       return AlignmentIsInBytes;
 464     }
 465     unsigned getTextAlignFillValue() const {
 466       return TextAlignFillValue;
 467     }
 468     const char *getGlobalDirective() const {
 469       return GlobalDirective;
 470     }
 471     bool hasSetDirective() const { return HasSetDirective; }
 472     bool hasAggressiveSymbolFolding() const {
 473       return HasAggressiveSymbolFolding;
 474     }
 475     bool getCOMMDirectiveAlignmentIsInBytes() const {
 476       return COMMDirectiveAlignmentIsInBytes;
 477     }
 478     LCOMM::LCOMMType getLCOMMDirectiveAlignmentType() const {
 479       return LCOMMDirectiveAlignmentType;
 480     }
 481     bool hasDotTypeDotSizeDirective() const {return HasDotTypeDotSizeDirective;}
 482     bool hasSingleParameterDotFile() const { return HasSingleParameterDotFile; }
 483     bool hasIdentDirective() const { return HasIdentDirective; }
 484     bool hasNoDeadStrip() const { return HasNoDeadStrip; }
 485     const char *getWeakRefDirective() const { return WeakRefDirective; }
 486     bool hasWeakDefDirective() const { return HasWeakDefDirective; }
 487     bool hasWeakDefCanBeHiddenDirective() const {
 488       return HasWeakDefCanBeHiddenDirective;
 489     }
 490     bool hasLinkOnceDirective() const { return HasLinkOnceDirective; }
 491
 492     MCSymbolAttr getHiddenVisibilityAttr() const { return HiddenVisibilityAttr;}
 493     MCSymbolAttr getHiddenDeclarationVisibilityAttr() const {
 494       return HiddenDeclarationVisibilityAttr;
 495     }
 496     MCSymbolAttr getProtectedVisibilityAttr() const {
 497       return ProtectedVisibilityAttr;
 498     }
 499     bool hasLEB128() const {
 500       return HasLEB128;
 501     }
 502     bool doesSupportDebugInformation() const {
 503       return SupportsDebugInformation;
 504     }
 505     bool doesSupportExceptionHandling() const {
 506       return ExceptionsType != ExceptionHandling::None;
 507     }
 508     ExceptionHandling::ExceptionsType getExceptionHandlingType() const {
 509       return ExceptionsType;
 510     }
 511     bool isExceptionHandlingDwarf() const {
 512       return
 513         (ExceptionsType == ExceptionHandling::DwarfCFI ||
 514          ExceptionsType == ExceptionHandling::ARM ||
 515          ExceptionsType == ExceptionHandling::Win64);
 516     }
 517     bool doesDwarfUseRelocationsAcrossSections() const {
 518       return DwarfUsesRelocationsAcrossSections;
 519     }
 520     bool doDwarfFDESymbolsUseAbsDiff() const {
 521       return DwarfFDESymbolsUseAbsDiff;
 522     }
 523     bool useDwarfRegNumForCFI() const {
 524       return DwarfRegNumForCFI;
 525     }
 526     bool useParensForSymbolVariant() const {
 527       return UseParensForSymbolVariant;
 528     }
 529
 530     void addInitialFrameState(const MCCFIInstruction &Inst) {
 531       InitialFrameState.push_back(Inst);
 532     }
 533
 534     const std::vector<MCCFIInstruction> &getInitialFrameState() const {
 535       return InitialFrameState;
 536     }
 537
 538     /// Return true if assembly (inline or otherwise) should be parsed.
 539     bool useIntegratedAssembler() const { return UseIntegratedAssembler; }
 540
 541     /// Set whether assembly (inline or otherwise) should be parsed.
 542     void setUseIntegratedAssembler(bool Value) {
 543       UseIntegratedAssembler = Value;
 544     }
 545   };
 546 }
 547
 548 #endif