include/llvm/Target/TargetAsmInfo.h

   1 //===-- llvm/Target/TargetAsmInfo.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/Support/DataTypes.h"
  20 #include <cassert>
  21 #include <string>
  22
  23 namespace llvm {
  24   template <typename T> class SmallVectorImpl;
  25
  26   /// TargetAsmInfo - This class is intended to be used as a base class for asm
  27   /// properties and features specific to the target.
  28   class TargetAsmInfo {
  29   protected:
  30     //===------------------------------------------------------------------===//
  31     // Properties to be set by the target writer, used to configure asm printer.
  32     //
  33
  34     /// ZeroFillDirective - Directive for emitting a global to the ZeroFill
  35     /// section on this target.  Null if this target doesn't support zerofill.
  36     const char *ZeroFillDirective;        // Default is null.
  37
  38     /// NonexecutableStackDirective - Directive for declaring to the
  39     /// linker and beyond that the emitted code does not require stack
  40     /// memory to be executable.
  41     const char *NonexecutableStackDirective; // Default is null.
  42
  43     /// NeedsSet - True if target asm treats expressions in data directives
  44     /// as linktime-relocatable.  For assembly-time computation, we need to
  45     /// use a .set.  Thus:
  46     /// .set w, x-y
  47     /// .long w
  48     /// is computed at assembly time, while
  49     /// .long x-y
  50     /// is relocated if the relative locations of x and y change at linktime.
  51     /// We want both these things in different places.
  52     bool NeedsSet;                        // Defaults to false.
  53
  54     /// MaxInstLength - This is the maximum possible length of an instruction,
  55     /// which is needed to compute the size of an inline asm.
  56     unsigned MaxInstLength;               // Defaults to 4.
  57
  58     /// PCSymbol - The symbol used to represent the current PC.  Used in PC
  59     /// relative expressions.
  60     const char *PCSymbol;                 // Defaults to "$".
  61
  62     /// SeparatorChar - This character, if specified, is used to separate
  63     /// instructions from each other when on the same line.  This is used to
  64     /// measure inline asm instructions.
  65     char SeparatorChar;                   // Defaults to ';'
  66
  67     /// CommentColumn - This indicates the comment num (zero-based) at
  68     /// which asm comments should be printed.
  69     unsigned CommentColumn;               // Defaults to 60
  70
  71     /// CommentString - This indicates the comment character used by the
  72     /// assembler.
  73     const char *CommentString;            // Defaults to "#"
  74
  75     /// GlobalPrefix - If this is set to a non-empty string, it is prepended
  76     /// onto all global symbols.  This is often used for "_" or ".".
  77     const char *GlobalPrefix;             // Defaults to ""
  78
  79     /// PrivateGlobalPrefix - This prefix is used for globals like constant
  80     /// pool entries that are completely private to the .s file and should not
  81     /// have names in the .o file.  This is often "." or "L".
  82     const char *PrivateGlobalPrefix;      // Defaults to "."
  83
  84     /// LinkerPrivateGlobalPrefix - This prefix is used for symbols that should
  85     /// be passed through the assembler but be removed by the linker.  This
  86     /// is "l" on Darwin, currently used for some ObjC metadata.
  87     const char *LinkerPrivateGlobalPrefix;      // Defaults to ""
  88
  89     /// JumpTableSpecialLabelPrefix - If not null, a extra (dead) label is
  90     /// emitted before jump tables with the specified prefix.
  91     const char *JumpTableSpecialLabelPrefix;  // Default to null.
  92
  93     /// GlobalVarAddrPrefix/Suffix - If these are nonempty, these strings
  94     /// will enclose any GlobalVariable (that isn't a function)
  95     ///
  96     const char *GlobalVarAddrPrefix;      // Defaults to ""
  97     const char *GlobalVarAddrSuffix;      // Defaults to ""
  98
  99     /// FunctionAddrPrefix/Suffix - If these are nonempty, these strings
 100     /// will enclose any GlobalVariable that points to a function.
 101     ///
 102     const char *FunctionAddrPrefix;       // Defaults to ""
 103     const char *FunctionAddrSuffix;       // Defaults to ""
 104
 105     /// PersonalityPrefix/Suffix - If these are nonempty, these strings will
 106     /// enclose any personality function in the common frame section.
 107     ///
 108     const char *PersonalityPrefix;        // Defaults to ""
 109     const char *PersonalitySuffix;        // Defaults to ""
 110
 111     /// NeedsIndirectEncoding - If set, we need to set the indirect encoding bit
 112     /// for EH in Dwarf.
 113     ///
 114     bool NeedsIndirectEncoding;           // Defaults to false
 115
 116     /// InlineAsmStart/End - If these are nonempty, they contain a directive to
 117     /// emit before and after an inline assembly statement.
 118     const char *InlineAsmStart;           // Defaults to "#APP\n"
 119     const char *InlineAsmEnd;             // Defaults to "#NO_APP\n"
 120
 121     /// AssemblerDialect - Which dialect of an assembler variant to use.
 122     unsigned AssemblerDialect;            // Defaults to 0
 123
 124     /// AllowQuotesInName - This is true if the assembler allows for complex
 125     /// symbol names to be surrounded in quotes.  This defaults to false.
 126     bool AllowQuotesInName;
 127
 128     //===--- Data Emission Directives -------------------------------------===//
 129
 130     /// ZeroDirective - this should be set to the directive used to get some
 131     /// number of zero bytes emitted to the current section.  Common cases are
 132     /// "\t.zero\t" and "\t.space\t".  If this is set to null, the
 133     /// Data*bitsDirective's will be used to emit zero bytes.
 134     const char *ZeroDirective;            // Defaults to "\t.zero\t"
 135     const char *ZeroDirectiveSuffix;      // Defaults to ""
 136
 137     /// AsciiDirective - This directive allows emission of an ascii string with
 138     /// the standard C escape characters embedded into it.
 139     const char *AsciiDirective;           // Defaults to "\t.ascii\t"
 140
 141     /// AscizDirective - If not null, this allows for special handling of
 142     /// zero terminated strings on this target.  This is commonly supported as
 143     /// ".asciz".  If a target doesn't support this, it can be set to null.
 144     const char *AscizDirective;           // Defaults to "\t.asciz\t"
 145
 146     /// DataDirectives - These directives are used to output some unit of
 147     /// integer data to the current section.  If a data directive is set to
 148     /// null, smaller data directives will be used to emit the large sizes.
 149     const char *Data8bitsDirective;       // Defaults to "\t.byte\t"
 150     const char *Data16bitsDirective;      // Defaults to "\t.short\t"
 151     const char *Data32bitsDirective;      // Defaults to "\t.long\t"
 152     const char *Data64bitsDirective;      // Defaults to "\t.quad\t"
 153
 154     /// getDataASDirective - Return the directive that should be used to emit
 155     /// data of the specified size to the specified numeric address space.
 156     virtual const char *getDataASDirective(unsigned Size, unsigned AS) const {
 157       assert(AS != 0 && "Don't know the directives for default addr space");
 158       return NULL;
 159     }
 160
 161     /// SunStyleELFSectionSwitchSyntax - This is true if this target uses "Sun
 162     /// Style" syntax for section switching ("#alloc,#write" etc) instead of the
 163     /// normal ELF syntax (,"a,w") in .section directives.
 164     bool SunStyleELFSectionSwitchSyntax;   // Defaults to false.
 165
 166     //===--- Alignment Information ----------------------------------------===//
 167
 168     /// AlignDirective - The directive used to emit round up to an alignment
 169     /// boundary.
 170     ///
 171     const char *AlignDirective;           // Defaults to "\t.align\t"
 172
 173     /// AlignmentIsInBytes - If this is true (the default) then the asmprinter
 174     /// emits ".align N" directives, where N is the number of bytes to align to.
 175     /// Otherwise, it emits ".align log2(N)", e.g. 3 to align to an 8 byte
 176     /// boundary.
 177     bool AlignmentIsInBytes;              // Defaults to true
 178
 179     /// TextAlignFillValue - If non-zero, this is used to fill the executable
 180     /// space created as the result of a alignment directive.
 181     unsigned TextAlignFillValue;
 182
 183     //===--- Section Switching Directives ---------------------------------===//
 184
 185     /// SwitchToSectionDirective - This is the directive used when we want to
 186     /// emit a global to an arbitrary section.  The section name is emited after
 187     /// this.
 188     const char *SwitchToSectionDirective; // Defaults to "\t.section\t"
 189
 190     /// JumpTableDirective - if non-null, the directive to emit before a jump
 191     /// table.
 192     const char *JumpTableDirective;
 193
 194     //===--- Global Variable Emission Directives --------------------------===//
 195
 196     /// GlobalDirective - This is the directive used to declare a global entity.
 197     ///
 198     const char *GlobalDirective;          // Defaults to NULL.
 199
 200     /// ExternDirective - This is the directive used to declare external
 201     /// globals.
 202     ///
 203     const char *ExternDirective;          // Defaults to NULL.
 204
 205     /// SetDirective - This is the name of a directive that can be used to tell
 206     /// the assembler to set the value of a variable to some expression.
 207     const char *SetDirective;             // Defaults to null.
 208
 209     /// LCOMMDirective - This is the name of a directive (if supported) that can
 210     /// be used to efficiently declare a local (internal) block of zero
 211     /// initialized data in the .bss/.data section.  The syntax expected is:
 212     /// @verbatim <LCOMMDirective> SYMBOLNAME LENGTHINBYTES, ALIGNMENT
 213     /// @endverbatim
 214     const char *LCOMMDirective;           // Defaults to null.
 215
 216     const char *COMMDirective;            // Defaults to "\t.comm\t".
 217
 218     /// COMMDirectiveTakesAlignment - True if COMMDirective take a third
 219     /// argument that specifies the alignment of the declaration.
 220     bool COMMDirectiveTakesAlignment;     // Defaults to true.
 221
 222     /// HasDotTypeDotSizeDirective - True if the target has .type and .size
 223     /// directives, this is true for most ELF targets.
 224     bool HasDotTypeDotSizeDirective;      // Defaults to true.
 225
 226     /// HasSingleParameterDotFile - True if the target has a single parameter
 227     /// .file directive, this is true for ELF targets.
 228     bool HasSingleParameterDotFile;      // Defaults to true.
 229
 230     /// UsedDirective - This directive, if non-null, is used to declare a global
 231     /// as being used somehow that the assembler can't see.  This prevents dead
 232     /// code elimination on some targets.
 233     const char *UsedDirective;            // Defaults to null.
 234
 235     /// WeakRefDirective - This directive, if non-null, is used to declare a
 236     /// global as being a weak undefined symbol.
 237     const char *WeakRefDirective;         // Defaults to null.
 238
 239     /// WeakDefDirective - This directive, if non-null, is used to declare a
 240     /// global as being a weak defined symbol.
 241     const char *WeakDefDirective;         // Defaults to null.
 242
 243     /// HiddenDirective - This directive, if non-null, is used to declare a
 244     /// global or function as having hidden visibility.
 245     const char *HiddenDirective;          // Defaults to "\t.hidden\t".
 246
 247     /// ProtectedDirective - This directive, if non-null, is used to declare a
 248     /// global or function as having protected visibility.
 249     const char *ProtectedDirective;       // Defaults to "\t.protected\t".
 250
 251     //===--- Dwarf Emission Directives -----------------------------------===//
 252
 253     /// AbsoluteDebugSectionOffsets - True if we should emit abolute section
 254     /// offsets for debug information. Defaults to false.
 255     bool AbsoluteDebugSectionOffsets;
 256
 257     /// AbsoluteEHSectionOffsets - True if we should emit abolute section
 258     /// offsets for EH information. Defaults to false.
 259     bool AbsoluteEHSectionOffsets;
 260
 261     /// HasLEB128 - True if target asm supports leb128 directives.
 262     ///
 263     bool HasLEB128; // Defaults to false.
 264
 265     /// hasDotLocAndDotFile - True if target asm supports .loc and .file
 266     /// directives for emitting debugging information.
 267     ///
 268     bool HasDotLocAndDotFile; // Defaults to false.
 269
 270     /// SupportsDebugInformation - True if target supports emission of debugging
 271     /// information.
 272     bool SupportsDebugInformation;
 273
 274     /// SupportsExceptionHandling - True if target supports
 275     /// exception handling.
 276     ///
 277     bool SupportsExceptionHandling; // Defaults to false.
 278
 279     /// RequiresFrameSection - true if the Dwarf2 output needs a frame section
 280     ///
 281     bool DwarfRequiresFrameSection; // Defaults to true.
 282
 283     /// DwarfUsesInlineInfoSection - True if DwarfDebugInlineSection is used to
 284     /// encode inline subroutine information.
 285     bool DwarfUsesInlineInfoSection; // Defaults to false.
 286
 287     /// Is_EHSymbolPrivate - If set, the "_foo.eh" is made private so that it
 288     /// doesn't show up in the symbol table of the object file.
 289     bool Is_EHSymbolPrivate;                // Defaults to true.
 290
 291     /// GlobalEHDirective - This is the directive used to make exception frame
 292     /// tables globally visible.
 293     ///
 294     const char *GlobalEHDirective;          // Defaults to NULL.
 295
 296     /// SupportsWeakEmptyEHFrame - True if target assembler and linker will
 297     /// handle a weak_definition of constant 0 for an omitted EH frame.
 298     bool SupportsWeakOmittedEHFrame;  // Defaults to true.
 299
 300     /// DwarfSectionOffsetDirective - Special section offset directive.
 301     const char* DwarfSectionOffsetDirective; // Defaults to NULL
 302
 303     //===--- CBE Asm Translation Table -----------------------------------===//
 304
 305     const char *const *AsmTransCBE; // Defaults to empty
 306
 307   public:
 308     explicit TargetAsmInfo();
 309     virtual ~TargetAsmInfo();
 310
 311     /// getSLEB128Size - Compute the number of bytes required for a signed
 312     /// leb128 value.
 313     static unsigned getSLEB128Size(int Value);
 314
 315     /// getULEB128Size - Compute the number of bytes required for an unsigned
 316     /// leb128 value.
 317     static unsigned getULEB128Size(unsigned Value);
 318
 319     // Data directive accessors.
 320     //
 321     const char *getData8bitsDirective(unsigned AS = 0) const {
 322       return AS == 0 ? Data8bitsDirective : getDataASDirective(8, AS);
 323     }
 324     const char *getData16bitsDirective(unsigned AS = 0) const {
 325       return AS == 0 ? Data16bitsDirective : getDataASDirective(16, AS);
 326     }
 327     const char *getData32bitsDirective(unsigned AS = 0) const {
 328       return AS == 0 ? Data32bitsDirective : getDataASDirective(32, AS);
 329     }
 330     const char *getData64bitsDirective(unsigned AS = 0) const {
 331       return AS == 0 ? Data64bitsDirective : getDataASDirective(64, AS);
 332     }
 333
 334
 335     bool usesSunStyleELFSectionSwitchSyntax() const {
 336       return SunStyleELFSectionSwitchSyntax;
 337     }
 338
 339
 340     // Accessors.
 341     //
 342     const char *getZeroFillDirective() const {
 343       return ZeroFillDirective;
 344     }
 345     const char *getNonexecutableStackDirective() const {
 346       return NonexecutableStackDirective;
 347     }
 348     bool needsSet() const {
 349       return NeedsSet;
 350     }
 351     unsigned getMaxInstLength() const {
 352       return MaxInstLength;
 353     }
 354     const char *getPCSymbol() const {
 355       return PCSymbol;
 356     }
 357     char getSeparatorChar() const {
 358       return SeparatorChar;
 359     }
 360     unsigned getCommentColumn() const {
 361       return CommentColumn;
 362     }
 363     const char *getCommentString() const {
 364       return CommentString;
 365     }
 366     const char *getGlobalPrefix() const {
 367       return GlobalPrefix;
 368     }
 369     const char *getPrivateGlobalPrefix() const {
 370       return PrivateGlobalPrefix;
 371     }
 372     const char *getLinkerPrivateGlobalPrefix() const {
 373       return LinkerPrivateGlobalPrefix;
 374     }
 375     const char *getJumpTableSpecialLabelPrefix() const {
 376       return JumpTableSpecialLabelPrefix;
 377     }
 378     const char *getGlobalVarAddrPrefix() const {
 379       return GlobalVarAddrPrefix;
 380     }
 381     const char *getGlobalVarAddrSuffix() const {
 382       return GlobalVarAddrSuffix;
 383     }
 384     const char *getFunctionAddrPrefix() const {
 385       return FunctionAddrPrefix;
 386     }
 387     const char *getFunctionAddrSuffix() const {
 388       return FunctionAddrSuffix;
 389     }
 390     const char *getPersonalityPrefix() const {
 391       return PersonalityPrefix;
 392     }
 393     const char *getPersonalitySuffix() const {
 394       return PersonalitySuffix;
 395     }
 396     bool getNeedsIndirectEncoding() const {
 397       return NeedsIndirectEncoding;
 398     }
 399     const char *getInlineAsmStart() const {
 400       return InlineAsmStart;
 401     }
 402     const char *getInlineAsmEnd() const {
 403       return InlineAsmEnd;
 404     }
 405     unsigned getAssemblerDialect() const {
 406       return AssemblerDialect;
 407     }
 408     bool doesAllowQuotesInName() const {
 409       return AllowQuotesInName;
 410     }
 411     const char *getZeroDirective() const {
 412       return ZeroDirective;
 413     }
 414     const char *getZeroDirectiveSuffix() const {
 415       return ZeroDirectiveSuffix;
 416     }
 417     const char *getAsciiDirective() const {
 418       return AsciiDirective;
 419     }
 420     const char *getAscizDirective() const {
 421       return AscizDirective;
 422     }
 423     const char *getJumpTableDirective() const {
 424       return JumpTableDirective;
 425     }
 426     const char *getAlignDirective() const {
 427       return AlignDirective;
 428     }
 429     bool getAlignmentIsInBytes() const {
 430       return AlignmentIsInBytes;
 431     }
 432     unsigned getTextAlignFillValue() const {
 433       return TextAlignFillValue;
 434     }
 435     const char *getSwitchToSectionDirective() const {
 436       return SwitchToSectionDirective;
 437     }
 438     const char *getGlobalDirective() const {
 439       return GlobalDirective;
 440     }
 441     const char *getExternDirective() const {
 442       return ExternDirective;
 443     }
 444     const char *getSetDirective() const {
 445       return SetDirective;
 446     }
 447     const char *getLCOMMDirective() const {
 448       return LCOMMDirective;
 449     }
 450     const char *getCOMMDirective() const {
 451       return COMMDirective;
 452     }
 453     bool getCOMMDirectiveTakesAlignment() const {
 454       return COMMDirectiveTakesAlignment;
 455     }
 456     bool hasDotTypeDotSizeDirective() const {
 457       return HasDotTypeDotSizeDirective;
 458     }
 459     bool hasSingleParameterDotFile() const {
 460       return HasSingleParameterDotFile;
 461     }
 462     const char *getUsedDirective() const {
 463       return UsedDirective;
 464     }
 465     const char *getWeakRefDirective() const {
 466       return WeakRefDirective;
 467     }
 468     const char *getWeakDefDirective() const {
 469       return WeakDefDirective;
 470     }
 471     const char *getHiddenDirective() const {
 472       return HiddenDirective;
 473     }
 474     const char *getProtectedDirective() const {
 475       return ProtectedDirective;
 476     }
 477     bool isAbsoluteDebugSectionOffsets() const {
 478       return AbsoluteDebugSectionOffsets;
 479     }
 480     bool isAbsoluteEHSectionOffsets() const {
 481       return AbsoluteEHSectionOffsets;
 482     }
 483     bool hasLEB128() const {
 484       return HasLEB128;
 485     }
 486     bool hasDotLocAndDotFile() const {
 487       return HasDotLocAndDotFile;
 488     }
 489     bool doesSupportDebugInformation() const {
 490       return SupportsDebugInformation;
 491     }
 492     bool doesSupportExceptionHandling() const {
 493       return SupportsExceptionHandling;
 494     }
 495     bool doesDwarfRequireFrameSection() const {
 496       return DwarfRequiresFrameSection;
 497     }
 498     bool doesDwarfUsesInlineInfoSection() const {
 499       return DwarfUsesInlineInfoSection;
 500     }
 501     bool is_EHSymbolPrivate() const {
 502       return Is_EHSymbolPrivate;
 503     }
 504     const char *getGlobalEHDirective() const {
 505       return GlobalEHDirective;
 506     }
 507     bool getSupportsWeakOmittedEHFrame() const {
 508       return SupportsWeakOmittedEHFrame;
 509     }
 510     const char *getDwarfSectionOffsetDirective() const {
 511       return DwarfSectionOffsetDirective;
 512     }
 513     const char *const *getAsmCBE() const {
 514       return AsmTransCBE;
 515     }
 516   };
 517 }
 518
 519 #endif