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 /// @verbatim @fptr( ) @endverbatim
108 /// link-relocation operator.
110 const char *FunctionAddrPrefix; // Defaults to ""
111 const char *FunctionAddrSuffix; // Defaults to ""
113 /// PersonalityPrefix/Suffix - If these are nonempty, these strings will
114 /// enclose any personality function in the common frame section.
116 const char *PersonalityPrefix; // Defaults to ""
117 const char *PersonalitySuffix; // Defaults to ""
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"
124 /// AssemblerDialect - Which dialect of an assembler variant to use.
125 unsigned AssemblerDialect; // Defaults to 0
127 //===--- Data Emission Directives -------------------------------------===//
129 /// ZeroDirective - this should be set to the directive used to get some
130 /// number of zero bytes emitted to the current section. Common cases are
131 /// "\t.zero\t" and "\t.space\t". If this is set to null, the
132 /// Data*bitsDirective's will be used to emit zero bytes.
133 const char *ZeroDirective; // Defaults to "\t.zero\t"
134 const char *ZeroDirectiveSuffix; // Defaults to ""
136 /// AsciiDirective - This directive allows emission of an ascii string with
137 /// the standard C escape characters embedded into it.
138 const char *AsciiDirective; // Defaults to "\t.ascii\t"
140 /// AscizDirective - If not null, this allows for special handling of
141 /// zero terminated strings on this target. This is commonly supported as
142 /// ".asciz". If a target doesn't support this, it can be set to null.
143 const char *AscizDirective; // Defaults to "\t.asciz\t"
145 /// DataDirectives - These directives are used to output some unit of
146 /// integer data to the current section. If a data directive is set to
147 /// null, smaller data directives will be used to emit the large sizes.
148 const char *Data8bitsDirective; // Defaults to "\t.byte\t"
149 const char *Data16bitsDirective; // Defaults to "\t.short\t"
150 const char *Data32bitsDirective; // Defaults to "\t.long\t"
151 const char *Data64bitsDirective; // Defaults to "\t.quad\t"
153 //===--- Alignment Information ----------------------------------------===//
155 /// AlignDirective - The directive used to emit round up to an alignment
158 const char *AlignDirective; // Defaults to "\t.align\t"
160 /// AlignmentIsInBytes - If this is true (the default) then the asmprinter
161 /// emits ".align N" directives, where N is the number of bytes to align to.
162 /// Otherwise, it emits ".align log2(N)", e.g. 3 to align to an 8 byte
164 bool AlignmentIsInBytes; // Defaults to true
166 //===--- Section Switching Directives ---------------------------------===//
168 /// SwitchToSectionDirective - This is the directive used when we want to
169 /// emit a global to an arbitrary section. The section name is emited after
171 const char *SwitchToSectionDirective; // Defaults to "\t.section\t"
173 /// TextSectionStartSuffix - This is printed after each start of section
174 /// directive for text sections.
175 const char *TextSectionStartSuffix; // Defaults to "".
177 /// DataSectionStartSuffix - This is printed after each start of section
178 /// directive for data sections.
179 const char *DataSectionStartSuffix; // Defaults to "".
181 /// SectionEndDirectiveSuffix - If non-null, the asm printer will close each
182 /// section with the section name and this suffix printed.
183 const char *SectionEndDirectiveSuffix;// Defaults to null.
185 /// ConstantPoolSection - This is the section that we SwitchToSection right
186 /// before emitting the constant pool for a function.
187 const char *ConstantPoolSection; // Defaults to "\t.section .rodata"
189 /// JumpTableDataSection - This is the section that we SwitchToSection right
190 /// before emitting the jump tables for a function when the relocation model
192 const char *JumpTableDataSection; // Defaults to "\t.section .rodata"
194 /// JumpTableDirective - if non-null, the directive to emit before a jump
196 const char *JumpTableDirective;
198 /// CStringSection - If not null, this allows for special handling of
199 /// cstring constants (null terminated string that does not contain any
200 /// other null bytes) on this target. This is commonly supported as
202 const char *CStringSection; // Defaults to NULL
204 /// StaticCtorsSection - This is the directive that is emitted to switch to
205 /// a section to emit the static constructor list.
206 /// Defaults to "\t.section .ctors,\"aw\",@progbits".
207 const char *StaticCtorsSection;
209 /// StaticDtorsSection - This is the directive that is emitted to switch to
210 /// a section to emit the static destructor list.
211 /// Defaults to "\t.section .dtors,\"aw\",@progbits".
212 const char *StaticDtorsSection;
214 /// FourByteConstantSection, EightByteConstantSection,
215 /// SixteenByteConstantSection - These are special sections where we place
216 /// 4-, 8-, and 16- byte constant literals.
217 const char *FourByteConstantSection;
218 const char *EightByteConstantSection;
219 const char *SixteenByteConstantSection;
221 /// ReadOnlySection - This is the directive that is emitted to switch to a
222 /// read-only section for constant data (e.g. data declared const,
224 const char *ReadOnlySection; // Defaults to NULL
226 //===--- Global Variable Emission Directives --------------------------===//
228 /// GlobalDirective - This is the directive used to declare a global entity.
230 const char *GlobalDirective; // Defaults to NULL.
232 /// SetDirective - This is the name of a directive that can be used to tell
233 /// the assembler to set the value of a variable to some expression.
234 const char *SetDirective; // Defaults to null.
236 /// LCOMMDirective - This is the name of a directive (if supported) that can
237 /// be used to efficiently declare a local (internal) block of zero
238 /// initialized data in the .bss/.data section. The syntax expected is:
239 /// @verbatim <LCOMMDirective> SYMBOLNAME LENGTHINBYTES, ALIGNMENT
241 const char *LCOMMDirective; // Defaults to null.
243 const char *COMMDirective; // Defaults to "\t.comm\t".
245 /// COMMDirectiveTakesAlignment - True if COMMDirective take a third
246 /// argument that specifies the alignment of the declaration.
247 bool COMMDirectiveTakesAlignment; // Defaults to true.
249 /// HasDotTypeDotSizeDirective - True if the target has .type and .size
250 /// directives, this is true for most ELF targets.
251 bool HasDotTypeDotSizeDirective; // Defaults to true.
253 /// UsedDirective - This directive, if non-null, is used to declare a global
254 /// as being used somehow that the assembler can't see. This prevents dead
255 /// code elimination on some targets.
256 const char *UsedDirective; // Defaults to null.
258 /// WeakRefDirective - This directive, if non-null, is used to declare a
259 /// global as being a weak undefined symbol.
260 const char *WeakRefDirective; // Defaults to null.
262 /// HiddenDirective - This directive, if non-null, is used to declare a
263 /// global or function as having hidden visibility.
264 const char *HiddenDirective; // Defaults to "\t.hidden\t".
266 /// ProtectedDirective - This directive, if non-null, is used to declare a
267 /// global or function as having protected visibility.
268 const char *ProtectedDirective; // Defaults to "\t.protected\t".
270 //===--- Dwarf Emission Directives -----------------------------------===//
272 /// AbsoluteDebugSectionOffsets - True if we should emit abolute section
273 /// offsets for debug information. Defaults to false.
274 bool AbsoluteDebugSectionOffsets;
276 /// AbsoluteEHSectionOffsets - True if we should emit abolute section
277 /// offsets for EH information. Defaults to false.
278 bool AbsoluteEHSectionOffsets;
280 /// HasLEB128 - True if target asm supports leb128 directives.
282 bool HasLEB128; // Defaults to false.
284 /// hasDotLoc - True if target asm supports .loc directives.
286 bool HasDotLoc; // Defaults to false.
288 /// HasDotFile - True if target asm supports .file directives.
290 bool HasDotFile; // Defaults to false.
292 /// SupportsDebugInformation - True if target supports emission of debugging
294 bool SupportsDebugInformation;
296 /// SupportsExceptionHandling - True if target supports
297 /// exception handling.
299 bool SupportsExceptionHandling; // Defaults to false.
301 /// RequiresFrameSection - true if the Dwarf2 output needs a frame section
303 bool DwarfRequiresFrameSection; // Defaults to true.
305 /// DwarfSectionOffsetDirective - Special section offset directive.
306 const char* DwarfSectionOffsetDirective; // Defaults to NULL
308 /// DwarfAbbrevSection - Section directive for Dwarf abbrev.
310 const char *DwarfAbbrevSection; // Defaults to ".debug_abbrev".
312 /// DwarfInfoSection - Section directive for Dwarf info.
314 const char *DwarfInfoSection; // Defaults to ".debug_info".
316 /// DwarfLineSection - Section directive for Dwarf info.
318 const char *DwarfLineSection; // Defaults to ".debug_line".
320 /// DwarfFrameSection - Section directive for Dwarf info.
322 const char *DwarfFrameSection; // Defaults to ".debug_frame".
324 /// DwarfPubNamesSection - Section directive for Dwarf info.
326 const char *DwarfPubNamesSection; // Defaults to ".debug_pubnames".
328 /// DwarfPubTypesSection - Section directive for Dwarf info.
330 const char *DwarfPubTypesSection; // Defaults to ".debug_pubtypes".
332 /// DwarfStrSection - Section directive for Dwarf info.
334 const char *DwarfStrSection; // Defaults to ".debug_str".
336 /// DwarfLocSection - Section directive for Dwarf info.
338 const char *DwarfLocSection; // Defaults to ".debug_loc".
340 /// DwarfARangesSection - Section directive for Dwarf info.
342 const char *DwarfARangesSection; // Defaults to ".debug_aranges".
344 /// DwarfRangesSection - Section directive for Dwarf info.
346 const char *DwarfRangesSection; // Defaults to ".debug_ranges".
348 /// DwarfMacInfoSection - Section directive for Dwarf info.
350 const char *DwarfMacInfoSection; // Defaults to ".debug_macinfo".
352 /// DwarfEHFrameSection - Section directive for Exception frames.
354 const char *DwarfEHFrameSection; // Defaults to ".eh_frame".
356 /// DwarfExceptionSection - Section directive for Exception table.
358 const char *DwarfExceptionSection; // Defaults to ".gcc_except_table".
361 //===--- CBE Asm Translation Table -----------------------------------===//
363 const char** AsmTransCBE; // Defaults to empty
367 virtual ~TargetAsmInfo();
369 /// Measure the specified inline asm to determine an approximation of its
371 virtual unsigned getInlineAsmLength(const char *Str) const;
373 /// ExpandInlineAsm - This hook allows the target to expand an inline asm
374 /// call to be explicit llvm code if it wants to. This is useful for
375 /// turning simple inline asms into LLVM intrinsics, which gives the
376 /// compiler more information about the behavior of the code.
377 virtual bool ExpandInlineAsm(CallInst *CI) const {
383 const char *getTextSection() const {
386 const char *getDataSection() const {
389 const char *getBSSSection() const {
392 const char *getTLSDataSection() const {
393 return TLSDataSection;
395 const char *getTLSBSSSection() const {
396 return TLSBSSSection;
398 const char *getZeroFillDirective() const {
399 return ZeroFillDirective;
401 unsigned getAddressSize() const {
404 bool needsSet() const {
407 const char *getPCSymbol() const {
410 char getSeparatorChar() const {
411 return SeparatorChar;
413 const char *getCommentString() const {
414 return CommentString;
416 const char *getGlobalPrefix() const {
419 const char *getPrivateGlobalPrefix() const {
420 return PrivateGlobalPrefix;
422 const char *getJumpTableSpecialLabelPrefix() const {
423 return JumpTableSpecialLabelPrefix;
425 const char *getGlobalVarAddrPrefix() const {
426 return GlobalVarAddrPrefix;
428 const char *getGlobalVarAddrSuffix() const {
429 return GlobalVarAddrSuffix;
431 const char *getFunctionAddrPrefix() const {
432 return FunctionAddrPrefix;
434 const char *getFunctionAddrSuffix() const {
435 return FunctionAddrSuffix;
437 const char *getPersonalityPrefix() const {
438 return PersonalityPrefix;
440 const char *getPersonalitySuffix() const {
441 return PersonalitySuffix;
443 const char *getInlineAsmStart() const {
444 return InlineAsmStart;
446 const char *getInlineAsmEnd() const {
449 unsigned getAssemblerDialect() const {
450 return AssemblerDialect;
452 const char *getZeroDirective() const {
453 return ZeroDirective;
455 const char *getZeroDirectiveSuffix() const {
456 return ZeroDirectiveSuffix;
458 const char *getAsciiDirective() const {
459 return AsciiDirective;
461 const char *getAscizDirective() const {
462 return AscizDirective;
464 const char *getData8bitsDirective() const {
465 return Data8bitsDirective;
467 const char *getData16bitsDirective() const {
468 return Data16bitsDirective;
470 const char *getData32bitsDirective() const {
471 return Data32bitsDirective;
473 const char *getData64bitsDirective() const {
474 return Data64bitsDirective;
476 const char *getJumpTableDirective() const {
477 return JumpTableDirective;
479 const char *getAlignDirective() const {
480 return AlignDirective;
482 bool getAlignmentIsInBytes() const {
483 return AlignmentIsInBytes;
485 const char *getSwitchToSectionDirective() const {
486 return SwitchToSectionDirective;
488 const char *getTextSectionStartSuffix() const {
489 return TextSectionStartSuffix;
491 const char *getDataSectionStartSuffix() const {
492 return DataSectionStartSuffix;
494 const char *getSectionEndDirectiveSuffix() const {
495 return SectionEndDirectiveSuffix;
497 const char *getConstantPoolSection() const {
498 return ConstantPoolSection;
500 const char *getJumpTableDataSection() const {
501 return JumpTableDataSection;
503 const char *getCStringSection() const {
504 return CStringSection;
506 const char *getStaticCtorsSection() const {
507 return StaticCtorsSection;
509 const char *getStaticDtorsSection() const {
510 return StaticDtorsSection;
512 const char *getFourByteConstantSection() const {
513 return FourByteConstantSection;
515 const char *getEightByteConstantSection() const {
516 return EightByteConstantSection;
518 const char *getSixteenByteConstantSection() const {
519 return SixteenByteConstantSection;
521 const char *getReadOnlySection() const {
522 return ReadOnlySection;
524 const char *getGlobalDirective() const {
525 return GlobalDirective;
527 const char *getSetDirective() const {
530 const char *getLCOMMDirective() const {
531 return LCOMMDirective;
533 const char *getCOMMDirective() const {
534 return COMMDirective;
536 bool getCOMMDirectiveTakesAlignment() const {
537 return COMMDirectiveTakesAlignment;
539 bool hasDotTypeDotSizeDirective() const {
540 return HasDotTypeDotSizeDirective;
542 const char *getUsedDirective() const {
543 return UsedDirective;
545 const char *getWeakRefDirective() const {
546 return WeakRefDirective;
548 const char *getHiddenDirective() const {
549 return HiddenDirective;
551 const char *getProtectedDirective() const {
552 return ProtectedDirective;
554 bool isAbsoluteDebugSectionOffsets() const {
555 return AbsoluteDebugSectionOffsets;
557 bool isAbsoluteEHSectionOffsets() const {
558 return AbsoluteEHSectionOffsets;
560 bool hasLEB128() const {
563 bool hasDotLoc() const {
566 bool hasDotFile() const {
569 bool doesSupportDebugInformation() const {
570 return SupportsDebugInformation;
572 bool doesSupportExceptionHandling() const {
573 return SupportsExceptionHandling;
575 bool doesDwarfRequireFrameSection() const {
576 return DwarfRequiresFrameSection;
578 const char *getDwarfSectionOffsetDirective() const {
579 return DwarfSectionOffsetDirective;
581 const char *getDwarfAbbrevSection() const {
582 return DwarfAbbrevSection;
584 const char *getDwarfInfoSection() const {
585 return DwarfInfoSection;
587 const char *getDwarfLineSection() const {
588 return DwarfLineSection;
590 const char *getDwarfFrameSection() const {
591 return DwarfFrameSection;
593 const char *getDwarfPubNamesSection() const {
594 return DwarfPubNamesSection;
596 const char *getDwarfPubTypesSection() const {
597 return DwarfPubTypesSection;
599 const char *getDwarfStrSection() const {
600 return DwarfStrSection;
602 const char *getDwarfLocSection() const {
603 return DwarfLocSection;
605 const char *getDwarfARangesSection() const {
606 return DwarfARangesSection;
608 const char *getDwarfRangesSection() const {
609 return DwarfRangesSection;
611 const char *getDwarfMacInfoSection() const {
612 return DwarfMacInfoSection;
614 const char *getDwarfEHFrameSection() const {
615 return DwarfEHFrameSection;
617 const char *getDwarfExceptionSection() const {
618 return DwarfExceptionSection;
620 const char** getAsmCBE() const {