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"
24 // Forward declaration.
27 /// TargetAsmInfo - This class is intended to be used as a base class for asm
28 /// properties and features specific to the target.
32 //===------------------------------------------------------------------===//
33 // Properties to be set by the target writer, used to configure asm printer.
36 /// TextSection - Section directive for standard text.
38 const char *TextSection; // Defaults to ".text".
40 /// DataSection - Section directive for standard data.
42 const char *DataSection; // Defaults to ".data".
44 /// AddressSize - Size of addresses used in file.
46 unsigned AddressSize; // Defaults to 4.
48 /// NeedsSet - True if target asm can't compute addresses on data
50 bool NeedsSet; // Defaults to false.
52 /// CommentString - This indicates the comment character used by the
54 const char *CommentString; // Defaults to "#"
56 /// GlobalPrefix - If this is set to a non-empty string, it is prepended
57 /// onto all global symbols. This is often used for "_" or ".".
58 const char *GlobalPrefix; // Defaults to ""
60 /// PrivateGlobalPrefix - This prefix is used for globals like constant
61 /// pool entries that are completely private to the .o file and should not
62 /// have names in the .o file. This is often "." or "L".
63 const char *PrivateGlobalPrefix; // Defaults to "."
65 /// GlobalVarAddrPrefix/Suffix - If these are nonempty, these strings
66 /// will enclose any GlobalVariable (that isn't a function)
68 const char *GlobalVarAddrPrefix; // Defaults to ""
69 const char *GlobalVarAddrSuffix; // Defaults to ""
71 /// FunctionAddrPrefix/Suffix - If these are nonempty, these strings
72 /// will enclose any GlobalVariable that points to a function.
73 /// For example, this is used by the IA64 backend to materialize
74 /// function descriptors, by decorating the ".data8" object with the
75 /// \literal @fptr( ) \endliteral
76 /// link-relocation operator.
78 const char *FunctionAddrPrefix; // Defaults to ""
79 const char *FunctionAddrSuffix; // Defaults to ""
81 /// InlineAsmStart/End - If these are nonempty, they contain a directive to
82 /// emit before and after an inline assembly statement.
83 const char *InlineAsmStart; // Defaults to "#APP\n"
84 const char *InlineAsmEnd; // Defaults to "#NO_APP\n"
86 //===--- Data Emission Directives -------------------------------------===//
88 /// ZeroDirective - this should be set to the directive used to get some
89 /// number of zero bytes emitted to the current section. Common cases are
90 /// "\t.zero\t" and "\t.space\t". If this is set to null, the
91 /// Data*bitsDirective's will be used to emit zero bytes.
92 const char *ZeroDirective; // Defaults to "\t.zero\t"
93 const char *ZeroDirectiveSuffix; // Defaults to ""
95 /// AsciiDirective - This directive allows emission of an ascii string with
96 /// the standard C escape characters embedded into it.
97 const char *AsciiDirective; // Defaults to "\t.ascii\t"
99 /// AscizDirective - If not null, this allows for special handling of
100 /// zero terminated strings on this target. This is commonly supported as
101 /// ".asciz". If a target doesn't support this, it can be set to null.
102 const char *AscizDirective; // Defaults to "\t.asciz\t"
104 /// DataDirectives - These directives are used to output some unit of
105 /// integer data to the current section. If a data directive is set to
106 /// null, smaller data directives will be used to emit the large sizes.
107 const char *Data8bitsDirective; // Defaults to "\t.byte\t"
108 const char *Data16bitsDirective; // Defaults to "\t.short\t"
109 const char *Data32bitsDirective; // Defaults to "\t.long\t"
110 const char *Data64bitsDirective; // Defaults to "\t.quad\t"
112 //===--- Alignment Information ----------------------------------------===//
114 /// AlignDirective - The directive used to emit round up to an alignment
117 const char *AlignDirective; // Defaults to "\t.align\t"
119 /// AlignmentIsInBytes - If this is true (the default) then the asmprinter
120 /// emits ".align N" directives, where N is the number of bytes to align to.
121 /// Otherwise, it emits ".align log2(N)", e.g. 3 to align to an 8 byte
123 bool AlignmentIsInBytes; // Defaults to true
125 //===--- Section Switching Directives ---------------------------------===//
127 /// SwitchToSectionDirective - This is the directive used when we want to
128 /// emit a global to an arbitrary section. The section name is emited after
130 const char *SwitchToSectionDirective; // Defaults to "\t.section\t"
132 /// TextSectionStartSuffix - This is printed after each start of section
133 /// directive for text sections.
134 const char *TextSectionStartSuffix; // Defaults to "".
136 /// DataSectionStartSuffix - This is printed after each start of section
137 /// directive for data sections.
138 const char *DataSectionStartSuffix; // Defaults to "".
140 /// SectionEndDirectiveSuffix - If non-null, the asm printer will close each
141 /// section with the section name and this suffix printed.
142 const char *SectionEndDirectiveSuffix;// Defaults to null.
144 /// ConstantPoolSection - This is the section that we SwitchToSection right
145 /// before emitting the constant pool for a function.
146 const char *ConstantPoolSection; // Defaults to "\t.section .rodata\n"
148 /// JumpTableDataSection - This is the section that we SwitchToSection right
149 /// before emitting the jump tables for a function when the relocation model
151 const char *JumpTableDataSection; // Defaults to "\t.section .rodata\n"
153 /// JumpTableTextSection - This is the section that we SwitchToSection right
154 /// before emitting the jump tables for a function when the relocation model
156 const char *JumpTableTextSection; // Defaults to "\t.text\n"
158 /// JumpTableDirective - if non-null, the directive to emit before a jump
160 const char *JumpTableDirective;
162 /// StaticCtorsSection - This is the directive that is emitted to switch to
163 /// a section to emit the static constructor list.
164 /// Defaults to "\t.section .ctors,\"aw\",@progbits".
165 const char *StaticCtorsSection;
167 /// StaticDtorsSection - This is the directive that is emitted to switch to
168 /// a section to emit the static destructor list.
169 /// Defaults to "\t.section .dtors,\"aw\",@progbits".
170 const char *StaticDtorsSection;
172 /// FourByteConstantSection, EightByteConstantSection,
173 /// SixteenByteConstantSection - These are special sections where we place
174 /// 4-, 8-, and 16- byte constant literals.
175 const char *FourByteConstantSection;
176 const char *EightByteConstantSection;
177 const char *SixteenByteConstantSection;
179 //===--- Global Variable Emission Directives --------------------------===//
181 /// SetDirective - This is the name of a directive that can be used to tell
182 /// the assembler to set the value of a variable to some expression.
183 const char *SetDirective; // Defaults to null.
185 /// LCOMMDirective - This is the name of a directive (if supported) that can
186 /// be used to efficiently declare a local (internal) block of zero
187 /// initialized data in the .bss/.data section. The syntax expected is:
188 /// \literal <LCOMMDirective> SYMBOLNAME LENGTHINBYTES, ALIGNMENT
190 const char *LCOMMDirective; // Defaults to null.
192 const char *COMMDirective; // Defaults to "\t.comm\t".
194 /// COMMDirectiveTakesAlignment - True if COMMDirective take a third
195 /// argument that specifies the alignment of the declaration.
196 bool COMMDirectiveTakesAlignment; // Defaults to true.
198 /// HasDotTypeDotSizeDirective - True if the target has .type and .size
199 /// directives, this is true for most ELF targets.
200 bool HasDotTypeDotSizeDirective; // Defaults to true.
202 //===--- Dwarf Emission Directives -----------------------------------===//
204 /// HasLEB128 - True if target asm supports leb128 directives.
206 bool HasLEB128; // Defaults to false.
208 /// hasDotLoc - True if target asm supports .loc directives.
210 bool HasDotLoc; // Defaults to false.
212 /// HasDotFile - True if target asm supports .file directives.
214 bool HasDotFile; // Defaults to false.
216 /// DwarfAbbrevSection - Section directive for Dwarf abbrev.
218 const char *DwarfAbbrevSection; // Defaults to ".debug_abbrev".
220 /// DwarfInfoSection - Section directive for Dwarf info.
222 const char *DwarfInfoSection; // Defaults to ".debug_info".
224 /// DwarfLineSection - Section directive for Dwarf info.
226 const char *DwarfLineSection; // Defaults to ".debug_line".
228 /// DwarfFrameSection - Section directive for Dwarf info.
230 const char *DwarfFrameSection; // Defaults to ".debug_frame".
232 /// DwarfPubNamesSection - Section directive for Dwarf info.
234 const char *DwarfPubNamesSection; // Defaults to ".debug_pubnames".
236 /// DwarfPubTypesSection - Section directive for Dwarf info.
238 const char *DwarfPubTypesSection; // Defaults to ".debug_pubtypes".
240 /// DwarfStrSection - Section directive for Dwarf info.
242 const char *DwarfStrSection; // Defaults to ".debug_str".
244 /// DwarfLocSection - Section directive for Dwarf info.
246 const char *DwarfLocSection; // Defaults to ".debug_loc".
248 /// DwarfARangesSection - Section directive for Dwarf info.
250 const char *DwarfARangesSection; // Defaults to ".debug_aranges".
252 /// DwarfRangesSection - Section directive for Dwarf info.
254 const char *DwarfRangesSection; // Defaults to ".debug_ranges".
256 /// DwarfMacInfoSection - Section directive for Dwarf info.
258 const char *DwarfMacInfoSection; // Defaults to ".debug_macinfo".
267 const char *getTextSection() const {
270 const char *getDataSection() const {
273 unsigned getAddressSize() const {
276 bool needsSet() const {
279 const char *getCommentString() const {
280 return CommentString;
282 const char *getGlobalPrefix() const {
285 const char *getPrivateGlobalPrefix() const {
286 return PrivateGlobalPrefix;
288 const char *getGlobalVarAddrPrefix() const {
289 return GlobalVarAddrPrefix;
291 const char *getGlobalVarAddrSuffix() const {
292 return GlobalVarAddrSuffix;
294 const char *getFunctionAddrPrefix() const {
295 return FunctionAddrPrefix;
297 const char *getFunctionAddrSuffix() const {
298 return FunctionAddrSuffix;
300 const char *getInlineAsmStart() const {
301 return InlineAsmStart;
303 const char *getInlineAsmEnd() const {
306 const char *getZeroDirective() const {
307 return ZeroDirective;
309 const char *getZeroDirectiveSuffix() const {
310 return ZeroDirectiveSuffix;
312 const char *getAsciiDirective() const {
313 return AsciiDirective;
315 const char *getAscizDirective() const {
316 return AscizDirective;
318 const char *getData8bitsDirective() const {
319 return Data8bitsDirective;
321 const char *getData16bitsDirective() const {
322 return Data16bitsDirective;
324 const char *getData32bitsDirective() const {
325 return Data32bitsDirective;
327 const char *getData64bitsDirective() const {
328 return Data64bitsDirective;
330 const char *getJumpTableDirective() const {
331 return JumpTableDirective;
333 const char *getAlignDirective() const {
334 return AlignDirective;
336 bool getAlignmentIsInBytes() const {
337 return AlignmentIsInBytes;
339 const char *getSwitchToSectionDirective() const {
340 return SwitchToSectionDirective;
342 const char *getTextSectionStartSuffix() const {
343 return TextSectionStartSuffix;
345 const char *getDataSectionStartSuffix() const {
346 return DataSectionStartSuffix;
348 const char *getSectionEndDirectiveSuffix() const {
349 return SectionEndDirectiveSuffix;
351 const char *getConstantPoolSection() const {
352 return ConstantPoolSection;
354 const char *getJumpTableDataSection() const {
355 return JumpTableDataSection;
357 const char *getJumpTableTextSection() const {
358 return JumpTableTextSection;
360 const char *getStaticCtorsSection() const {
361 return StaticCtorsSection;
363 const char *getStaticDtorsSection() const {
364 return StaticDtorsSection;
366 const char *getFourByteConstantSection() const {
367 return FourByteConstantSection;
369 const char *getEightByteConstantSection() const {
370 return EightByteConstantSection;
372 const char *getSixteenByteConstantSection() const {
373 return SixteenByteConstantSection;
375 const char *getSetDirective() const {
378 const char *getLCOMMDirective() const {
379 return LCOMMDirective;
381 const char *getCOMMDirective() const {
382 return COMMDirective;
384 bool getCOMMDirectiveTakesAlignment() const {
385 return COMMDirectiveTakesAlignment;
387 bool hasDotTypeDotSizeDirective() const {
388 return HasDotTypeDotSizeDirective;
390 bool hasLEB128() const {
393 bool hasDotLoc() const {
396 bool hasDotFile() const {
399 const char *getDwarfAbbrevSection() const {
400 return DwarfAbbrevSection;
402 const char *getDwarfInfoSection() const {
403 return DwarfInfoSection;
405 const char *getDwarfLineSection() const {
406 return DwarfLineSection;
408 const char *getDwarfFrameSection() const {
409 return DwarfFrameSection;
411 const char *getDwarfPubNamesSection() const {
412 return DwarfPubNamesSection;
414 const char *getDwarfPubTypesSection() const {
415 return DwarfPubTypesSection;
417 const char *getDwarfStrSection() const {
418 return DwarfStrSection;
420 const char *getDwarfLocSection() const {
421 return DwarfLocSection;
423 const char *getDwarfARangesSection() const {
424 return DwarfARangesSection;
426 const char *getDwarfRangesSection() const {
427 return DwarfRangesSection;
429 const char *getDwarfMacInfoSection() const {
430 return DwarfMacInfoSection;