1 //===-- llvm/Target/TargetAsmInfo.h - Asm info ------------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
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.
8 //===----------------------------------------------------------------------===//
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.
14 //===----------------------------------------------------------------------===//
16 #ifndef LLVM_TARGET_ASM_INFO_H
17 #define LLVM_TARGET_ASM_INFO_H
19 #include "llvm/CodeGen/MachineFunctionPass.h"
20 #include "llvm/Support/DataTypes.h"
26 /// TargetAsmInfo - This class is intended to be used as a base class for asm
27 /// properties and features specific to the target.
30 //===------------------------------------------------------------------===//
31 // Properties to be set by the target writer, used to configure asm printer.
34 /// TextSection - Section directive for standard text.
36 const char *TextSection; // Defaults to ".text".
38 /// DataSection - Section directive for standard data.
40 const char *DataSection; // Defaults to ".data".
42 /// BSSSection - Section directive for uninitialized data. Null if this
43 /// target doesn't support a BSS section.
45 const char *BSSSection; // Default to ".bss".
47 /// TLSDataSection - Section directive for Thread Local data.
49 const char *TLSDataSection;// Defaults to ".section .tdata,"awT",@progbits".
51 /// TLSBSSSection - Section directive for Thread Local uninitialized data.
52 /// Null if this target doesn't support a BSS section.
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.
59 /// AddressSize - Size of addresses used in file.
61 unsigned AddressSize; // Defaults to 4.
63 /// NeedsSet - True if target asm can't compute addresses on data
65 bool NeedsSet; // Defaults to false.
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.
71 /// PCSymbol - The symbol used to represent the current PC. Used in PC
72 /// relative expressions.
73 const char *PCSymbol; // Defaults to "$".
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 ';'
80 /// CommentString - This indicates the comment character used by the
82 const char *CommentString; // Defaults to "#"
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 ""
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 "."
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.
97 /// GlobalVarAddrPrefix/Suffix - If these are nonempty, these strings
98 /// will enclose any GlobalVariable (that isn't a function)
100 const char *GlobalVarAddrPrefix; // Defaults to ""
101 const char *GlobalVarAddrSuffix; // Defaults to ""
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 /// \literal @fptr( ) \endliteral
108 /// link-relocation operator.
110 const char *FunctionAddrPrefix; // Defaults to ""
111 const char *FunctionAddrSuffix; // Defaults to ""
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"
118 /// AssemblerDialect - Which dialect of an assembler variant to use.
119 unsigned AssemblerDialect; // Defaults to 0
121 //===--- Data Emission Directives -------------------------------------===//
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 ""
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"
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"
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"
147 //===--- Alignment Information ----------------------------------------===//
149 /// AlignDirective - The directive used to emit round up to an alignment
152 const char *AlignDirective; // Defaults to "\t.align\t"
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
158 bool AlignmentIsInBytes; // Defaults to true
160 //===--- Section Switching Directives ---------------------------------===//
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
165 const char *SwitchToSectionDirective; // Defaults to "\t.section\t"
167 /// TextSectionStartSuffix - This is printed after each start of section
168 /// directive for text sections.
169 const char *TextSectionStartSuffix; // Defaults to "".
171 /// DataSectionStartSuffix - This is printed after each start of section
172 /// directive for data sections.
173 const char *DataSectionStartSuffix; // Defaults to "".
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.
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"
183 /// JumpTableDataSection - This is the section that we SwitchToSection right
184 /// before emitting the jump tables for a function when the relocation model
186 const char *JumpTableDataSection; // Defaults to "\t.section .rodata"
188 /// JumpTableDirective - if non-null, the directive to emit before a jump
190 const char *JumpTableDirective;
192 /// CStringSection - If not null, this allows for special handling of
193 /// cstring constants (\0 terminated string that does not contain any
194 /// other null bytes) on this target. This is commonly supported as
196 const char *CStringSection; // Defaults to NULL
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;
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;
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;
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,
218 const char *ReadOnlySection; // Defaults to NULL
220 //===--- Global Variable Emission Directives --------------------------===//
222 /// GlobalDirective - This is the directive used to declare a global entity.
224 const char *GlobalDirective; // Defaults to NULL.
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.
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 /// \literal <LCOMMDirective> SYMBOLNAME LENGTHINBYTES, ALIGNMENT
235 const char *LCOMMDirective; // Defaults to null.
237 const char *COMMDirective; // Defaults to "\t.comm\t".
239 /// COMMDirectiveTakesAlignment - True if COMMDirective take a third
240 /// argument that specifies the alignment of the declaration.
241 bool COMMDirectiveTakesAlignment; // Defaults to true.
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.
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.
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.
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".
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".
264 //===--- Dwarf Emission Directives -----------------------------------===//
266 /// AbsoluteDebugSectionOffsets - True if we should emit abolute section
267 /// offsets for debug information. Defaults to false.
268 bool AbsoluteDebugSectionOffsets;
270 /// AbsoluteEHSectionOffsets - True if we should emit abolute section
271 /// offsets for EH information. Defaults to false.
272 bool AbsoluteEHSectionOffsets;
274 /// HasLEB128 - True if target asm supports leb128 directives.
276 bool HasLEB128; // Defaults to false.
278 /// hasDotLoc - True if target asm supports .loc directives.
280 bool HasDotLoc; // Defaults to false.
282 /// HasDotFile - True if target asm supports .file directives.
284 bool HasDotFile; // Defaults to false.
286 /// SupportsDebugInformation - True if target supports emission of debugging
288 bool SupportsDebugInformation;
290 /// SupportsExceptionHandling - True if target supports
291 /// exception handling.
293 bool SupportsExceptionHandling; // Defaults to false.
295 /// RequiresFrameSection - true if the Dwarf2 output needs a frame section
297 bool DwarfRequiresFrameSection; // Defaults to true.
299 /// DwarfSectionOffsetDirective - Special section offset directive.
300 const char* DwarfSectionOffsetDirective; // Defaults to NULL
302 /// DwarfAbbrevSection - Section directive for Dwarf abbrev.
304 const char *DwarfAbbrevSection; // Defaults to ".debug_abbrev".
306 /// DwarfInfoSection - Section directive for Dwarf info.
308 const char *DwarfInfoSection; // Defaults to ".debug_info".
310 /// DwarfLineSection - Section directive for Dwarf info.
312 const char *DwarfLineSection; // Defaults to ".debug_line".
314 /// DwarfFrameSection - Section directive for Dwarf info.
316 const char *DwarfFrameSection; // Defaults to ".debug_frame".
318 /// DwarfPubNamesSection - Section directive for Dwarf info.
320 const char *DwarfPubNamesSection; // Defaults to ".debug_pubnames".
322 /// DwarfPubTypesSection - Section directive for Dwarf info.
324 const char *DwarfPubTypesSection; // Defaults to ".debug_pubtypes".
326 /// DwarfStrSection - Section directive for Dwarf info.
328 const char *DwarfStrSection; // Defaults to ".debug_str".
330 /// DwarfLocSection - Section directive for Dwarf info.
332 const char *DwarfLocSection; // Defaults to ".debug_loc".
334 /// DwarfARangesSection - Section directive for Dwarf info.
336 const char *DwarfARangesSection; // Defaults to ".debug_aranges".
338 /// DwarfRangesSection - Section directive for Dwarf info.
340 const char *DwarfRangesSection; // Defaults to ".debug_ranges".
342 /// DwarfMacInfoSection - Section directive for Dwarf info.
344 const char *DwarfMacInfoSection; // Defaults to ".debug_macinfo".
346 /// DwarfEHFrameSection - Section directive for Exception frames.
348 const char *DwarfEHFrameSection; // Defaults to ".eh_frame".
350 /// DwarfExceptionSection - Section directive for Exception table.
352 const char *DwarfExceptionSection; // Defaults to ".gcc_except_table".
355 //===--- CBE Asm Translation Table -----------------------------------===//
357 const char** AsmTransCBE; // Defaults to empty
361 virtual ~TargetAsmInfo();
363 /// Measure the specified inline asm to determine an approximation of its
365 virtual unsigned getInlineAsmLength(const char *Str) const;
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 {
377 const char *getTextSection() const {
380 const char *getDataSection() const {
383 const char *getBSSSection() const {
386 const char *getTLSDataSection() const {
387 return TLSDataSection;
389 const char *getTLSBSSSection() const {
390 return TLSBSSSection;
392 const char *getZeroFillDirective() const {
393 return ZeroFillDirective;
395 unsigned getAddressSize() const {
398 bool needsSet() const {
401 const char *getPCSymbol() const {
404 char getSeparatorChar() const {
405 return SeparatorChar;
407 const char *getCommentString() const {
408 return CommentString;
410 const char *getGlobalPrefix() const {
413 const char *getPrivateGlobalPrefix() const {
414 return PrivateGlobalPrefix;
416 const char *getJumpTableSpecialLabelPrefix() const {
417 return JumpTableSpecialLabelPrefix;
419 const char *getGlobalVarAddrPrefix() const {
420 return GlobalVarAddrPrefix;
422 const char *getGlobalVarAddrSuffix() const {
423 return GlobalVarAddrSuffix;
425 const char *getFunctionAddrPrefix() const {
426 return FunctionAddrPrefix;
428 const char *getFunctionAddrSuffix() const {
429 return FunctionAddrSuffix;
431 const char *getInlineAsmStart() const {
432 return InlineAsmStart;
434 const char *getInlineAsmEnd() const {
437 unsigned getAssemblerDialect() const {
438 return AssemblerDialect;
440 const char *getZeroDirective() const {
441 return ZeroDirective;
443 const char *getZeroDirectiveSuffix() const {
444 return ZeroDirectiveSuffix;
446 const char *getAsciiDirective() const {
447 return AsciiDirective;
449 const char *getAscizDirective() const {
450 return AscizDirective;
452 const char *getData8bitsDirective() const {
453 return Data8bitsDirective;
455 const char *getData16bitsDirective() const {
456 return Data16bitsDirective;
458 const char *getData32bitsDirective() const {
459 return Data32bitsDirective;
461 const char *getData64bitsDirective() const {
462 return Data64bitsDirective;
464 const char *getJumpTableDirective() const {
465 return JumpTableDirective;
467 const char *getAlignDirective() const {
468 return AlignDirective;
470 bool getAlignmentIsInBytes() const {
471 return AlignmentIsInBytes;
473 const char *getSwitchToSectionDirective() const {
474 return SwitchToSectionDirective;
476 const char *getTextSectionStartSuffix() const {
477 return TextSectionStartSuffix;
479 const char *getDataSectionStartSuffix() const {
480 return DataSectionStartSuffix;
482 const char *getSectionEndDirectiveSuffix() const {
483 return SectionEndDirectiveSuffix;
485 const char *getConstantPoolSection() const {
486 return ConstantPoolSection;
488 const char *getJumpTableDataSection() const {
489 return JumpTableDataSection;
491 const char *getCStringSection() const {
492 return CStringSection;
494 const char *getStaticCtorsSection() const {
495 return StaticCtorsSection;
497 const char *getStaticDtorsSection() const {
498 return StaticDtorsSection;
500 const char *getFourByteConstantSection() const {
501 return FourByteConstantSection;
503 const char *getEightByteConstantSection() const {
504 return EightByteConstantSection;
506 const char *getSixteenByteConstantSection() const {
507 return SixteenByteConstantSection;
509 const char *getReadOnlySection() const {
510 return ReadOnlySection;
512 const char *getGlobalDirective() const {
513 return GlobalDirective;
515 const char *getSetDirective() const {
518 const char *getLCOMMDirective() const {
519 return LCOMMDirective;
521 const char *getCOMMDirective() const {
522 return COMMDirective;
524 bool getCOMMDirectiveTakesAlignment() const {
525 return COMMDirectiveTakesAlignment;
527 bool hasDotTypeDotSizeDirective() const {
528 return HasDotTypeDotSizeDirective;
530 const char *getUsedDirective() const {
531 return UsedDirective;
533 const char *getWeakRefDirective() const {
534 return WeakRefDirective;
536 const char *getHiddenDirective() const {
537 return HiddenDirective;
539 const char *getProtectedDirective() const {
540 return ProtectedDirective;
542 bool isAbsoluteDebugSectionOffsets() const {
543 return AbsoluteDebugSectionOffsets;
545 bool isAbsoluteEHSectionOffsets() const {
546 return AbsoluteEHSectionOffsets;
548 bool hasLEB128() const {
551 bool hasDotLoc() const {
554 bool hasDotFile() const {
557 bool doesSupportDebugInformation() const {
558 return SupportsDebugInformation;
560 bool doesSupportExceptionHandling() const {
561 return SupportsExceptionHandling;
563 bool doesDwarfRequireFrameSection() const {
564 return DwarfRequiresFrameSection;
566 const char *getDwarfSectionOffsetDirective() const {
567 return DwarfSectionOffsetDirective;
569 const char *getDwarfAbbrevSection() const {
570 return DwarfAbbrevSection;
572 const char *getDwarfInfoSection() const {
573 return DwarfInfoSection;
575 const char *getDwarfLineSection() const {
576 return DwarfLineSection;
578 const char *getDwarfFrameSection() const {
579 return DwarfFrameSection;
581 const char *getDwarfPubNamesSection() const {
582 return DwarfPubNamesSection;
584 const char *getDwarfPubTypesSection() const {
585 return DwarfPubTypesSection;
587 const char *getDwarfStrSection() const {
588 return DwarfStrSection;
590 const char *getDwarfLocSection() const {
591 return DwarfLocSection;
593 const char *getDwarfARangesSection() const {
594 return DwarfARangesSection;
596 const char *getDwarfRangesSection() const {
597 return DwarfRangesSection;
599 const char *getDwarfMacInfoSection() const {
600 return DwarfMacInfoSection;
602 const char *getDwarfEHFrameSection() const {
603 return DwarfEHFrameSection;
605 const char *getDwarfExceptionSection() const {
606 return DwarfExceptionSection;
608 const char** getAsmCBE() const {