include/llvm/Target/TargetAsmInfo.h

   1 //===-- llvm/Target/TargetAsmInfo.h - Asm info ------------------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by James M. Laskey and is distributed under
   6 // the University of Illinois Open Source 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/CodeGen/MachineFunctionPass.h"
  20 #include "llvm/Support/DataTypes.h"
  21
  22 namespace llvm {
  23   class TargetMachine;
  24   class CallInst;
  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     /// TextSection - Section directive for standard text.
  35     ///
  36     const char *TextSection;              // Defaults to ".text".
  37
  38     /// DataSection - Section directive for standard data.
  39     ///
  40     const char *DataSection;              // Defaults to ".data".
  41
  42     /// BSSSection - Section directive for uninitialized data.  Null if this
  43     /// target doesn't support a BSS section.
  44     ///
  45     const char *BSSSection;               // Default to ".bss".
  46
  47     /// TLSDataSection - Section directive for Thread Local data.
  48     ///
  49     const char *TLSDataSection;// Defaults to ".section .tdata,"awT",@progbits".
  50
  51     /// TLSBSSSection - Section directive for Thread Local uninitialized data.
  52     /// Null if this target doesn't support a BSS section.
  53     ///
  54     const char *TLSBSSSection;// Default to ".section .tbss,"awT",@nobits".
  55     /// ZeroFillDirective - Directive for emitting a global to the ZeroFill
  56     /// section on this target.  Null if this target doesn't support zerofill.
  57     const char *ZeroFillDirective;        // Default is null.
  58
  59     /// AddressSize - Size of addresses used in file.
  60     ///
  61     unsigned AddressSize;                 // Defaults to 4.
  62
  63     /// NeedsSet - True if target asm can't compute addresses on data
  64     /// directives.
  65     bool NeedsSet;                        // Defaults to false.
  66
  67     /// MaxInstLength - This is the maximum possible length of an instruction,
  68     /// which is needed to compute the size of an inline asm.
  69     unsigned MaxInstLength;               // Defaults to 4.
  70
  71     /// PCSymbol - The symbol used to represent the current PC.  Used in PC
  72     /// relative expressions.
  73     const char *PCSymbol;                 // Defaults to "$".
  74
  75     /// SeparatorChar - This character, if specified, is used to separate
  76     /// instructions from each other when on the same line.  This is used to
  77     /// measure inline asm instructions.
  78     char SeparatorChar;                   // Defaults to ';'
  79
  80     /// CommentString - This indicates the comment character used by the
  81     /// assembler.
  82     const char *CommentString;            // Defaults to "#"
  83
  84     /// GlobalPrefix - If this is set to a non-empty string, it is prepended
  85     /// onto all global symbols.  This is often used for "_" or ".".
  86     const char *GlobalPrefix;             // Defaults to ""
  87
  88     /// PrivateGlobalPrefix - This prefix is used for globals like constant
  89     /// pool entries that are completely private to the .o file and should not
  90     /// have names in the .o file.  This is often "." or "L".
  91     const char *PrivateGlobalPrefix;      // Defaults to "."
  92
  93     /// JumpTableSpecialLabelPrefix - If not null, a extra (dead) label is
  94     /// emitted before jump tables with the specified prefix.
  95     const char *JumpTableSpecialLabelPrefix;  // Default to null.
  96
  97     /// GlobalVarAddrPrefix/Suffix - If these are nonempty, these strings
  98     /// will enclose any GlobalVariable (that isn't a function)
  99     ///
 100     const char *GlobalVarAddrPrefix;      // Defaults to ""
 101     const char *GlobalVarAddrSuffix;      // Defaults to ""
 102
 103     /// FunctionAddrPrefix/Suffix - If these are nonempty, these strings
 104     /// will enclose any GlobalVariable that points to a function.
 105     /// For example, this is used by the IA64 backend to materialize
 106     /// function descriptors, by decorating the ".data8" object with the
 107     /// @verbatim @fptr( ) @endverbatim
 108     /// link-relocation operator.
 109     ///
 110     const char *FunctionAddrPrefix;       // Defaults to ""
 111     const char *FunctionAddrSuffix;       // Defaults to ""
 112
 113     /// InlineAsmStart/End - If these are nonempty, they contain a directive to
 114     /// emit before and after an inline assembly statement.
 115     const char *InlineAsmStart;           // Defaults to "#APP\n"
 116     const char *InlineAsmEnd;             // Defaults to "#NO_APP\n"
 117
 118     /// AssemblerDialect - Which dialect of an assembler variant to use.
 119     unsigned AssemblerDialect;            // Defaults to 0
 120
 121     //===--- Data Emission Directives -------------------------------------===//
 122
 123     /// ZeroDirective - this should be set to the directive used to get some
 124     /// number of zero bytes emitted to the current section.  Common cases are
 125     /// "\t.zero\t" and "\t.space\t".  If this is set to null, the
 126     /// Data*bitsDirective's will be used to emit zero bytes.
 127     const char *ZeroDirective;            // Defaults to "\t.zero\t"
 128     const char *ZeroDirectiveSuffix;      // Defaults to ""
 129
 130     /// AsciiDirective - This directive allows emission of an ascii string with
 131     /// the standard C escape characters embedded into it.
 132     const char *AsciiDirective;           // Defaults to "\t.ascii\t"
 133
 134     /// AscizDirective - If not null, this allows for special handling of
 135     /// zero terminated strings on this target.  This is commonly supported as
 136     /// ".asciz".  If a target doesn't support this, it can be set to null.
 137     const char *AscizDirective;           // Defaults to "\t.asciz\t"
 138
 139     /// DataDirectives - These directives are used to output some unit of
 140     /// integer data to the current section.  If a data directive is set to
 141     /// null, smaller data directives will be used to emit the large sizes.
 142     const char *Data8bitsDirective;       // Defaults to "\t.byte\t"
 143     const char *Data16bitsDirective;      // Defaults to "\t.short\t"
 144     const char *Data32bitsDirective;      // Defaults to "\t.long\t"
 145     const char *Data64bitsDirective;      // Defaults to "\t.quad\t"
 146
 147     //===--- Alignment Information ----------------------------------------===//
 148
 149     /// AlignDirective - The directive used to emit round up to an alignment
 150     /// boundary.
 151     ///
 152     const char *AlignDirective;           // Defaults to "\t.align\t"
 153
 154     /// AlignmentIsInBytes - If this is true (the default) then the asmprinter
 155     /// emits ".align N" directives, where N is the number of bytes to align to.
 156     /// Otherwise, it emits ".align log2(N)", e.g. 3 to align to an 8 byte
 157     /// boundary.
 158     bool AlignmentIsInBytes;              // Defaults to true
 159
 160     //===--- Section Switching Directives ---------------------------------===//
 161
 162     /// SwitchToSectionDirective - This is the directive used when we want to
 163     /// emit a global to an arbitrary section.  The section name is emited after
 164     /// this.
 165     const char *SwitchToSectionDirective; // Defaults to "\t.section\t"
 166
 167     /// TextSectionStartSuffix - This is printed after each start of section
 168     /// directive for text sections.
 169     const char *TextSectionStartSuffix;   // Defaults to "".
 170
 171     /// DataSectionStartSuffix - This is printed after each start of section
 172     /// directive for data sections.
 173     const char *DataSectionStartSuffix;   // Defaults to "".
 174
 175     /// SectionEndDirectiveSuffix - If non-null, the asm printer will close each
 176     /// section with the section name and this suffix printed.
 177     const char *SectionEndDirectiveSuffix;// Defaults to null.
 178
 179     /// ConstantPoolSection - This is the section that we SwitchToSection right
 180     /// before emitting the constant pool for a function.
 181     const char *ConstantPoolSection;      // Defaults to "\t.section .rodata"
 182
 183     /// JumpTableDataSection - This is the section that we SwitchToSection right
 184     /// before emitting the jump tables for a function when the relocation model
 185     /// is not PIC.
 186     const char *JumpTableDataSection;     // Defaults to "\t.section .rodata"
 187
 188     /// JumpTableDirective - if non-null, the directive to emit before a jump
 189     /// table.
 190     const char *JumpTableDirective;
 191
 192     /// CStringSection - If not null, this allows for special handling of
 193     /// cstring constants (null terminated string that does not contain any
 194     /// other null bytes) on this target. This is commonly supported as
 195     /// ".cstring".
 196     const char *CStringSection;           // Defaults to NULL
 197
 198     /// StaticCtorsSection - This is the directive that is emitted to switch to
 199     /// a section to emit the static constructor list.
 200     /// Defaults to "\t.section .ctors,\"aw\",@progbits".
 201     const char *StaticCtorsSection;
 202
 203     /// StaticDtorsSection - This is the directive that is emitted to switch to
 204     /// a section to emit the static destructor list.
 205     /// Defaults to "\t.section .dtors,\"aw\",@progbits".
 206     const char *StaticDtorsSection;
 207
 208     /// FourByteConstantSection, EightByteConstantSection,
 209     /// SixteenByteConstantSection - These are special sections where we place
 210     /// 4-, 8-, and 16- byte constant literals.
 211     const char *FourByteConstantSection;
 212     const char *EightByteConstantSection;
 213     const char *SixteenByteConstantSection;
 214
 215     /// ReadOnlySection - This is the directive that is emitted to switch to a
 216     /// read-only section for constant data (e.g. data declared const,
 217     /// jump tables).
 218     const char *ReadOnlySection;          // Defaults to NULL
 219
 220     //===--- Global Variable Emission Directives --------------------------===//
 221
 222     /// GlobalDirective - This is the directive used to declare a global entity.
 223     ///
 224     const char *GlobalDirective;          // Defaults to NULL.
 225
 226     /// SetDirective - This is the name of a directive that can be used to tell
 227     /// the assembler to set the value of a variable to some expression.
 228     const char *SetDirective;             // Defaults to null.
 229
 230     /// LCOMMDirective - This is the name of a directive (if supported) that can
 231     /// be used to efficiently declare a local (internal) block of zero
 232     /// initialized data in the .bss/.data section.  The syntax expected is:
 233     /// @verbatim <LCOMMDirective> SYMBOLNAME LENGTHINBYTES, ALIGNMENT
 234     /// @endverbatim
 235     const char *LCOMMDirective;           // Defaults to null.
 236
 237     const char *COMMDirective;            // Defaults to "\t.comm\t".
 238
 239     /// COMMDirectiveTakesAlignment - True if COMMDirective take a third
 240     /// argument that specifies the alignment of the declaration.
 241     bool COMMDirectiveTakesAlignment;     // Defaults to true.
 242
 243     /// HasDotTypeDotSizeDirective - True if the target has .type and .size
 244     /// directives, this is true for most ELF targets.
 245     bool HasDotTypeDotSizeDirective;      // Defaults to true.
 246
 247     /// UsedDirective - This directive, if non-null, is used to declare a global
 248     /// as being used somehow that the assembler can't see.  This prevents dead
 249     /// code elimination on some targets.
 250     const char *UsedDirective;            // Defaults to null.
 251
 252     /// WeakRefDirective - This directive, if non-null, is used to declare a
 253     /// global as being a weak undefined symbol.
 254     const char *WeakRefDirective;         // Defaults to null.
 255
 256     /// HiddenDirective - This directive, if non-null, is used to declare a
 257     /// global or function as having hidden visibility.
 258     const char *HiddenDirective;          // Defaults to "\t.hidden\t".
 259
 260     /// ProtectedDirective - This directive, if non-null, is used to declare a
 261     /// global or function as having protected visibility.
 262     const char *ProtectedDirective;       // Defaults to "\t.protected\t".
 263
 264     //===--- Dwarf Emission Directives -----------------------------------===//
 265
 266     /// AbsoluteDebugSectionOffsets - True if we should emit abolute section
 267     /// offsets for debug information. Defaults to false.
 268     bool AbsoluteDebugSectionOffsets;
 269
 270     /// AbsoluteEHSectionOffsets - True if we should emit abolute section
 271     /// offsets for EH information. Defaults to false.
 272     bool AbsoluteEHSectionOffsets;
 273
 274     /// HasLEB128 - True if target asm supports leb128 directives.
 275     ///
 276     bool HasLEB128; // Defaults to false.
 277
 278     /// hasDotLoc - True if target asm supports .loc directives.
 279     ///
 280     bool HasDotLoc; // Defaults to false.
 281
 282     /// HasDotFile - True if target asm supports .file directives.
 283     ///
 284     bool HasDotFile; // Defaults to false.
 285
 286     /// SupportsDebugInformation - True if target supports emission of debugging
 287     /// information.
 288     bool SupportsDebugInformation;
 289
 290     /// SupportsExceptionHandling - True if target supports
 291     /// exception handling.
 292     ///
 293     bool SupportsExceptionHandling; // Defaults to false.
 294
 295     /// RequiresFrameSection - true if the Dwarf2 output needs a frame section
 296     ///
 297     bool DwarfRequiresFrameSection; // Defaults to true.
 298
 299     /// DwarfSectionOffsetDirective - Special section offset directive.
 300     const char* DwarfSectionOffsetDirective; // Defaults to NULL
 301
 302     /// DwarfAbbrevSection - Section directive for Dwarf abbrev.
 303     ///
 304     const char *DwarfAbbrevSection; // Defaults to ".debug_abbrev".
 305
 306     /// DwarfInfoSection - Section directive for Dwarf info.
 307     ///
 308     const char *DwarfInfoSection; // Defaults to ".debug_info".
 309
 310     /// DwarfLineSection - Section directive for Dwarf info.
 311     ///
 312     const char *DwarfLineSection; // Defaults to ".debug_line".
 313
 314     /// DwarfFrameSection - Section directive for Dwarf info.
 315     ///
 316     const char *DwarfFrameSection; // Defaults to ".debug_frame".
 317
 318     /// DwarfPubNamesSection - Section directive for Dwarf info.
 319     ///
 320     const char *DwarfPubNamesSection; // Defaults to ".debug_pubnames".
 321
 322     /// DwarfPubTypesSection - Section directive for Dwarf info.
 323     ///
 324     const char *DwarfPubTypesSection; // Defaults to ".debug_pubtypes".
 325
 326     /// DwarfStrSection - Section directive for Dwarf info.
 327     ///
 328     const char *DwarfStrSection; // Defaults to ".debug_str".
 329
 330     /// DwarfLocSection - Section directive for Dwarf info.
 331     ///
 332     const char *DwarfLocSection; // Defaults to ".debug_loc".
 333
 334     /// DwarfARangesSection - Section directive for Dwarf info.
 335     ///
 336     const char *DwarfARangesSection; // Defaults to ".debug_aranges".
 337
 338     /// DwarfRangesSection - Section directive for Dwarf info.
 339     ///
 340     const char *DwarfRangesSection; // Defaults to ".debug_ranges".
 341
 342     /// DwarfMacInfoSection - Section directive for Dwarf info.
 343     ///
 344     const char *DwarfMacInfoSection; // Defaults to ".debug_macinfo".
 345
 346     /// DwarfEHFrameSection - Section directive for Exception frames.
 347     ///
 348     const char *DwarfEHFrameSection; // Defaults to ".eh_frame".
 349
 350     /// DwarfExceptionSection - Section directive for Exception table.
 351     ///
 352     const char *DwarfExceptionSection; // Defaults to ".gcc_except_table".
 353
 354
 355     //===--- CBE Asm Translation Table -----------------------------------===//
 356
 357     const char** AsmTransCBE; // Defaults to empty
 358
 359   public:
 360     TargetAsmInfo();
 361     virtual ~TargetAsmInfo();
 362
 363     /// Measure the specified inline asm to determine an approximation of its
 364     /// length.
 365     virtual unsigned getInlineAsmLength(const char *Str) const;
 366
 367     /// ExpandInlineAsm - This hook allows the target to expand an inline asm
 368     /// call to be explicit llvm code if it wants to.  This is useful for
 369     /// turning simple inline asms into LLVM intrinsics, which gives the
 370     /// compiler more information about the behavior of the code.
 371     virtual bool ExpandInlineAsm(CallInst *CI) const {
 372       return false;
 373     }
 374
 375     // Accessors.
 376     //
 377     const char *getTextSection() const {
 378       return TextSection;
 379     }
 380     const char *getDataSection() const {
 381       return DataSection;
 382     }
 383     const char *getBSSSection() const {
 384       return BSSSection;
 385     }
 386     const char *getTLSDataSection() const {
 387       return TLSDataSection;
 388     }
 389     const char *getTLSBSSSection() const {
 390       return TLSBSSSection;
 391     }
 392     const char *getZeroFillDirective() const {
 393       return ZeroFillDirective;
 394     }
 395     unsigned getAddressSize() const {
 396       return AddressSize;
 397     }
 398     bool needsSet() const {
 399       return NeedsSet;
 400     }
 401     const char *getPCSymbol() const {
 402       return PCSymbol;
 403     }
 404     char getSeparatorChar() const {
 405       return SeparatorChar;
 406     }
 407     const char *getCommentString() const {
 408       return CommentString;
 409     }
 410     const char *getGlobalPrefix() const {
 411       return GlobalPrefix;
 412     }
 413     const char *getPrivateGlobalPrefix() const {
 414       return PrivateGlobalPrefix;
 415     }
 416     const char *getJumpTableSpecialLabelPrefix() const {
 417       return JumpTableSpecialLabelPrefix;
 418     }
 419     const char *getGlobalVarAddrPrefix() const {
 420       return GlobalVarAddrPrefix;
 421     }
 422     const char *getGlobalVarAddrSuffix() const {
 423       return GlobalVarAddrSuffix;
 424     }
 425     const char *getFunctionAddrPrefix() const {
 426       return FunctionAddrPrefix;
 427     }
 428     const char *getFunctionAddrSuffix() const {
 429       return FunctionAddrSuffix;
 430     }
 431     const char *getInlineAsmStart() const {
 432       return InlineAsmStart;
 433     }
 434     const char *getInlineAsmEnd() const {
 435       return InlineAsmEnd;
 436     }
 437     unsigned getAssemblerDialect() const {
 438       return AssemblerDialect;
 439     }
 440     const char *getZeroDirective() const {
 441       return ZeroDirective;
 442     }
 443     const char *getZeroDirectiveSuffix() const {
 444       return ZeroDirectiveSuffix;
 445     }
 446     const char *getAsciiDirective() const {
 447       return AsciiDirective;
 448     }
 449     const char *getAscizDirective() const {
 450       return AscizDirective;
 451     }
 452     const char *getData8bitsDirective() const {
 453       return Data8bitsDirective;
 454     }
 455     const char *getData16bitsDirective() const {
 456       return Data16bitsDirective;
 457     }
 458     const char *getData32bitsDirective() const {
 459       return Data32bitsDirective;
 460     }
 461     const char *getData64bitsDirective() const {
 462       return Data64bitsDirective;
 463     }
 464     const char *getJumpTableDirective() const {
 465       return JumpTableDirective;
 466     }
 467     const char *getAlignDirective() const {
 468       return AlignDirective;
 469     }
 470     bool getAlignmentIsInBytes() const {
 471       return AlignmentIsInBytes;
 472     }
 473     const char *getSwitchToSectionDirective() const {
 474       return SwitchToSectionDirective;
 475     }
 476     const char *getTextSectionStartSuffix() const {
 477       return TextSectionStartSuffix;
 478     }
 479     const char *getDataSectionStartSuffix() const {
 480       return DataSectionStartSuffix;
 481     }
 482     const char *getSectionEndDirectiveSuffix() const {
 483       return SectionEndDirectiveSuffix;
 484     }
 485     const char *getConstantPoolSection() const {
 486       return ConstantPoolSection;
 487     }
 488     const char *getJumpTableDataSection() const {
 489       return JumpTableDataSection;
 490     }
 491     const char *getCStringSection() const {
 492       return CStringSection;
 493     }
 494     const char *getStaticCtorsSection() const {
 495       return StaticCtorsSection;
 496     }
 497     const char *getStaticDtorsSection() const {
 498       return StaticDtorsSection;
 499     }
 500     const char *getFourByteConstantSection() const {
 501       return FourByteConstantSection;
 502     }
 503     const char *getEightByteConstantSection() const {
 504       return EightByteConstantSection;
 505     }
 506     const char *getSixteenByteConstantSection() const {
 507       return SixteenByteConstantSection;
 508     }
 509     const char *getReadOnlySection() const {
 510       return ReadOnlySection;
 511     }
 512     const char *getGlobalDirective() const {
 513       return GlobalDirective;
 514     }
 515     const char *getSetDirective() const {
 516       return SetDirective;
 517     }
 518     const char *getLCOMMDirective() const {
 519       return LCOMMDirective;
 520     }
 521     const char *getCOMMDirective() const {
 522       return COMMDirective;
 523     }
 524     bool getCOMMDirectiveTakesAlignment() const {
 525       return COMMDirectiveTakesAlignment;
 526     }
 527     bool hasDotTypeDotSizeDirective() const {
 528       return HasDotTypeDotSizeDirective;
 529     }
 530     const char *getUsedDirective() const {
 531       return UsedDirective;
 532     }
 533     const char *getWeakRefDirective() const {
 534       return WeakRefDirective;
 535     }
 536     const char *getHiddenDirective() const {
 537       return HiddenDirective;
 538     }
 539     const char *getProtectedDirective() const {
 540       return ProtectedDirective;
 541     }
 542     bool isAbsoluteDebugSectionOffsets() const {
 543       return AbsoluteDebugSectionOffsets;
 544     }
 545     bool isAbsoluteEHSectionOffsets() const {
 546       return AbsoluteEHSectionOffsets;
 547     }
 548     bool hasLEB128() const {
 549       return HasLEB128;
 550     }
 551     bool hasDotLoc() const {
 552       return HasDotLoc;
 553     }
 554     bool hasDotFile() const {
 555       return HasDotFile;
 556     }
 557     bool doesSupportDebugInformation() const {
 558       return SupportsDebugInformation;
 559     }
 560     bool doesSupportExceptionHandling() const {
 561       return SupportsExceptionHandling;
 562     }
 563     bool doesDwarfRequireFrameSection() const {
 564       return DwarfRequiresFrameSection;
 565     }
 566     const char *getDwarfSectionOffsetDirective() const {
 567       return DwarfSectionOffsetDirective;
 568     }
 569     const char *getDwarfAbbrevSection() const {
 570       return DwarfAbbrevSection;
 571     }
 572     const char *getDwarfInfoSection() const {
 573       return DwarfInfoSection;
 574     }
 575     const char *getDwarfLineSection() const {
 576       return DwarfLineSection;
 577     }
 578     const char *getDwarfFrameSection() const {
 579       return DwarfFrameSection;
 580     }
 581     const char *getDwarfPubNamesSection() const {
 582       return DwarfPubNamesSection;
 583     }
 584     const char *getDwarfPubTypesSection() const {
 585       return DwarfPubTypesSection;
 586     }
 587     const char *getDwarfStrSection() const {
 588       return DwarfStrSection;
 589     }
 590     const char *getDwarfLocSection() const {
 591       return DwarfLocSection;
 592     }
 593     const char *getDwarfARangesSection() const {
 594       return DwarfARangesSection;
 595     }
 596     const char *getDwarfRangesSection() const {
 597       return DwarfRangesSection;
 598     }
 599     const char *getDwarfMacInfoSection() const {
 600       return DwarfMacInfoSection;
 601     }
 602     const char *getDwarfEHFrameSection() const {
 603       return DwarfEHFrameSection;
 604     }
 605     const char *getDwarfExceptionSection() const {
 606       return DwarfExceptionSection;
 607     }
 608     const char** getAsmCBE() const {
 609       return AsmTransCBE;
 610     }
 611   };
 612 }
 613
 614 #endif
 615