1 //===-- llvm/MC/MCAsmInfo.h - Asm info --------------------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // 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_MC_MCASMINFO_H
17 #define LLVM_MC_MCASMINFO_H
19 #include "llvm/MC/MCDirectives.h"
20 #include "llvm/MC/MCDwarf.h"
32 enum class EncodingType {
34 Alpha, /// Windows Alpha
35 Alpha64, /// Windows AXP64
36 ARM, /// Windows NT (Windows on ARM)
37 CE, /// Windows CE ARM, PowerPC, SH3, SH4
38 Itanium, /// Windows x64, Windows Itanium (IA-64)
39 X86, /// Windows x86, uses no CFI, just EH tables
44 enum class ExceptionHandling {
45 None, /// No exception support
46 DwarfCFI, /// DWARF-like instruction based exceptions
47 SjLj, /// setjmp/longjmp based exceptions
49 WinEH, /// Windows Exception Handling
53 enum LCOMMType { NoAlignment, ByteAlignment, Log2Alignment };
56 enum class DebugCompressionType {
57 DCT_None, // no compression
58 DCT_Zlib, // zlib style complession
59 DCT_ZlibGnu // zlib-gnu style compression
62 /// This class is intended to be used as a base class for asm
63 /// properties and features specific to the target.
66 //===------------------------------------------------------------------===//
67 // Properties to be set by the target writer, used to configure asm printer.
70 /// Pointer size in bytes. Default is 4.
73 /// Size of the stack slot reserved for callee-saved registers, in bytes.
74 /// Default is same as pointer size.
75 unsigned CalleeSaveStackSlotSize;
77 /// True if target is little endian. Default is true.
80 /// True if target stack grow up. Default is false.
83 /// True if this target has the MachO .subsections_via_symbols directive.
85 bool HasSubsectionsViaSymbols;
87 /// True if this is a MachO target that supports the macho-specific .zerofill
88 /// directive for emitting BSS Symbols. Default is false.
89 bool HasMachoZeroFillDirective;
91 /// True if this is a MachO target that supports the macho-specific .tbss
92 /// directive for emitting thread local BSS Symbols. Default is false.
93 bool HasMachoTBSSDirective;
95 /// True if the compiler should emit a ".reference .constructors_used" or
96 /// ".reference .destructors_used" directive after the static ctor/dtor
97 /// list. This directive is only emitted in Static relocation model. Default
99 bool HasStaticCtorDtorReferenceInStaticMode;
101 /// This is the maximum possible length of an instruction, which is needed to
102 /// compute the size of an inline asm. Defaults to 4.
103 unsigned MaxInstLength;
105 /// Every possible instruction length is a multiple of this value. Factored
106 /// out in .debug_frame and .debug_line. Defaults to 1.
107 unsigned MinInstAlignment;
109 /// The '$' token, when not referencing an identifier or constant, refers to
110 /// the current PC. Defaults to false.
113 /// This string, if specified, is used to separate instructions from each
114 /// other when on the same line. Defaults to ';'
115 const char *SeparatorString;
117 /// This indicates the comment character used by the assembler. Defaults to
119 const char *CommentString;
121 /// This is appended to emitted labels. Defaults to ":"
122 const char *LabelSuffix;
124 // Print the EH begin symbol with an assignment. Defaults to false.
125 bool UseAssignmentForEHBegin;
127 // Do we need to create a local symbol for .size?
128 bool NeedsLocalForSize;
130 /// This prefix is used for globals like constant pool entries that are
131 /// completely private to the .s file and should not have names in the .o
132 /// file. Defaults to "L"
133 const char *PrivateGlobalPrefix;
135 /// This prefix is used for labels for basic blocks. Defaults to the same as
136 /// PrivateGlobalPrefix.
137 const char *PrivateLabelPrefix;
139 /// This prefix is used for symbols that should be passed through the
140 /// assembler but be removed by the linker. This is 'l' on Darwin, currently
141 /// used for some ObjC metadata. The default of "" meast that for this system
142 /// a plain private symbol should be used. Defaults to "".
143 const char *LinkerPrivateGlobalPrefix;
145 /// If these are nonempty, they contain a directive to emit before and after
146 /// an inline assembly statement. Defaults to "#APP\n", "#NO_APP\n"
147 const char *InlineAsmStart;
148 const char *InlineAsmEnd;
150 /// These are assembly directives that tells the assembler to interpret the
151 /// following instructions differently. Defaults to ".code16", ".code32",
153 const char *Code16Directive;
154 const char *Code32Directive;
155 const char *Code64Directive;
157 /// Which dialect of an assembler variant to use. Defaults to 0
158 unsigned AssemblerDialect;
160 /// This is true if the assembler allows @ characters in symbol names.
161 /// Defaults to false.
164 /// If this is true, symbol names with invalid characters will be printed in
166 bool SupportsQuotedNames;
168 /// This is true if data region markers should be printed as
169 /// ".data_region/.end_data_region" directives. If false, use "$d/$a" labels
171 bool UseDataRegionDirectives;
173 //===--- Data Emission Directives -------------------------------------===//
175 /// This should be set to the directive used to get some number of zero bytes
176 /// emitted to the current section. Common cases are "\t.zero\t" and
177 /// "\t.space\t". If this is set to null, the Data*bitsDirective's will be
178 /// used to emit zero bytes. Defaults to "\t.zero\t"
179 const char *ZeroDirective;
181 /// This directive allows emission of an ascii string with the standard C
182 /// escape characters embedded into it. Defaults to "\t.ascii\t"
183 const char *AsciiDirective;
185 /// If not null, this allows for special handling of zero terminated strings
186 /// on this target. This is commonly supported as ".asciz". If a target
187 /// doesn't support this, it can be set to null. Defaults to "\t.asciz\t"
188 const char *AscizDirective;
190 /// These directives are used to output some unit of integer data to the
191 /// current section. If a data directive is set to null, smaller data
192 /// directives will be used to emit the large sizes. Defaults to "\t.byte\t",
193 /// "\t.short\t", "\t.long\t", "\t.quad\t"
194 const char *Data8bitsDirective;
195 const char *Data16bitsDirective;
196 const char *Data32bitsDirective;
197 const char *Data64bitsDirective;
199 /// If non-null, a directive that is used to emit a word which should be
200 /// relocated as a 64-bit GP-relative offset, e.g. .gpdword on Mips. Defaults
202 const char *GPRel64Directive;
204 /// If non-null, a directive that is used to emit a word which should be
205 /// relocated as a 32-bit GP-relative offset, e.g. .gpword on Mips or .gprel32
206 /// on Alpha. Defaults to NULL.
207 const char *GPRel32Directive;
209 /// This is true if this target uses "Sun Style" syntax for section switching
210 /// ("#alloc,#write" etc) instead of the normal ELF syntax (,"a,w") in
211 /// .section directives. Defaults to false.
212 bool SunStyleELFSectionSwitchSyntax;
214 /// This is true if this target uses ELF '.section' directive before the
215 /// '.bss' one. It's used for PPC/Linux which doesn't support the '.bss'
216 /// directive only. Defaults to false.
217 bool UsesELFSectionDirectiveForBSS;
219 bool NeedsDwarfSectionOffsetDirective;
221 //===--- Alignment Information ----------------------------------------===//
223 /// If this is true (the default) then the asmprinter emits ".align N"
224 /// directives, where N is the number of bytes to align to. Otherwise, it
225 /// emits ".align log2(N)", e.g. 3 to align to an 8 byte boundary. Defaults
227 bool AlignmentIsInBytes;
229 /// If non-zero, this is used to fill the executable space created as the
230 /// result of a alignment directive. Defaults to 0
231 unsigned TextAlignFillValue;
233 //===--- Global Variable Emission Directives --------------------------===//
235 /// This is the directive used to declare a global entity. Defaults to
237 const char *GlobalDirective;
239 /// True if the expression
241 /// uses a relocation but it can be suppressed by writing
244 bool SetDirectiveSuppressesReloc;
246 /// False if the assembler requires that we use
258 /// Defaults to true.
259 bool HasAggressiveSymbolFolding;
261 /// True is .comm's and .lcomms optional alignment is to be specified in bytes
262 /// instead of log2(n). Defaults to true.
263 bool COMMDirectiveAlignmentIsInBytes;
265 /// Describes if the .lcomm directive for the target supports an alignment
266 /// argument and how it is interpreted. Defaults to NoAlignment.
267 LCOMM::LCOMMType LCOMMDirectiveAlignmentType;
269 // True if the target allows .align directives on functions. This is true for
270 // most targets, so defaults to true.
271 bool HasFunctionAlignment;
273 /// True if the target has .type and .size directives, this is true for most
274 /// ELF targets. Defaults to true.
275 bool HasDotTypeDotSizeDirective;
277 /// True if the target has a single parameter .file directive, this is true
278 /// for ELF targets. Defaults to true.
279 bool HasSingleParameterDotFile;
281 /// True if the target has a .ident directive, this is true for ELF targets.
282 /// Defaults to false.
283 bool HasIdentDirective;
285 /// True if this target supports the MachO .no_dead_strip directive. Defaults
289 /// True if this target supports the MachO .alt_entry directive. Defaults to
293 /// Used to declare a global as being a weak symbol. Defaults to ".weak".
294 const char *WeakDirective;
296 /// This directive, if non-null, is used to declare a global as being a weak
297 /// undefined symbol. Defaults to NULL.
298 const char *WeakRefDirective;
300 /// True if we have a directive to declare a global as being a weak defined
301 /// symbol. Defaults to false.
302 bool HasWeakDefDirective;
304 /// True if we have a directive to declare a global as being a weak defined
305 /// symbol that can be hidden (unexported). Defaults to false.
306 bool HasWeakDefCanBeHiddenDirective;
308 /// True if we have a .linkonce directive. This is used on cygwin/mingw.
309 /// Defaults to false.
310 bool HasLinkOnceDirective;
312 /// This attribute, if not MCSA_Invalid, is used to declare a symbol as having
313 /// hidden visibility. Defaults to MCSA_Hidden.
314 MCSymbolAttr HiddenVisibilityAttr;
316 /// This attribute, if not MCSA_Invalid, is used to declare an undefined
317 /// symbol as having hidden visibility. Defaults to MCSA_Hidden.
318 MCSymbolAttr HiddenDeclarationVisibilityAttr;
320 /// This attribute, if not MCSA_Invalid, is used to declare a symbol as having
321 /// protected visibility. Defaults to MCSA_Protected
322 MCSymbolAttr ProtectedVisibilityAttr;
324 //===--- Dwarf Emission Directives -----------------------------------===//
326 /// True if target supports emission of debugging information. Defaults to
328 bool SupportsDebugInformation;
330 /// Exception handling format for the target. Defaults to None.
331 ExceptionHandling ExceptionsType;
333 /// Windows exception handling data (.pdata) encoding. Defaults to Invalid.
334 WinEH::EncodingType WinEHEncodingType;
336 /// True if Dwarf2 output generally uses relocations for references to other
337 /// .debug_* sections.
338 bool DwarfUsesRelocationsAcrossSections;
340 /// True if DWARF FDE symbol reference relocations should be replaced by an
341 /// absolute difference.
342 bool DwarfFDESymbolsUseAbsDiff;
344 /// True if dwarf register numbers are printed instead of symbolic register
345 /// names in .cfi_* directives. Defaults to false.
346 bool DwarfRegNumForCFI;
348 /// True if target uses parens to indicate the symbol variant instead of @.
349 /// For example, foo(plt) instead of foo@plt. Defaults to false.
350 bool UseParensForSymbolVariant;
352 //===--- Prologue State ----------------------------------------------===//
354 std::vector<MCCFIInstruction> InitialFrameState;
356 //===--- Integrated Assembler Information ----------------------------===//
358 /// Should we use the integrated assembler?
359 /// The integrated assembler should be enabled by default (by the
360 /// constructors) when failing to parse a valid piece of assembly (inline
361 /// or otherwise) is considered a bug. It may then be overridden after
362 /// construction (see LLVMTargetMachine::initAsmInfo()).
363 bool UseIntegratedAssembler;
365 /// Preserve Comments in assembly
366 bool PreserveAsmComments;
368 /// Compress DWARF debug sections. Defaults to no compression.
369 DebugCompressionType CompressDebugSections;
371 /// True if the integrated assembler should interpret 'a >> b' constant
372 /// expressions as logical rather than arithmetic.
375 // If true, emit GOTPCRELX/REX_GOTPCRELX instead of GOTPCREL, on
377 bool RelaxELFRelocations = true;
380 explicit MCAsmInfo();
381 virtual ~MCAsmInfo();
383 /// Get the pointer size in bytes.
384 unsigned getPointerSize() const { return PointerSize; }
386 /// Get the callee-saved register stack slot
388 unsigned getCalleeSaveStackSlotSize() const {
389 return CalleeSaveStackSlotSize;
392 /// True if the target is little endian.
393 bool isLittleEndian() const { return IsLittleEndian; }
395 /// True if target stack grow up.
396 bool isStackGrowthDirectionUp() const { return StackGrowsUp; }
398 bool hasSubsectionsViaSymbols() const { return HasSubsectionsViaSymbols; }
400 // Data directive accessors.
402 const char *getData8bitsDirective() const { return Data8bitsDirective; }
403 const char *getData16bitsDirective() const { return Data16bitsDirective; }
404 const char *getData32bitsDirective() const { return Data32bitsDirective; }
405 const char *getData64bitsDirective() const { return Data64bitsDirective; }
406 const char *getGPRel64Directive() const { return GPRel64Directive; }
407 const char *getGPRel32Directive() const { return GPRel32Directive; }
409 /// Targets can implement this method to specify a section to switch to if the
410 /// translation unit doesn't have any trampolines that require an executable
412 virtual MCSection *getNonexecutableStackSection(MCContext &Ctx) const {
416 /// \brief True if the section is atomized using the symbols in it.
417 /// This is false if the section is not atomized at all (most ELF sections) or
418 /// if it is atomized based on its contents (MachO' __TEXT,__cstring for
420 virtual bool isSectionAtomizableBySymbols(const MCSection &Section) const;
422 virtual const MCExpr *getExprForPersonalitySymbol(const MCSymbol *Sym,
424 MCStreamer &Streamer) const;
426 virtual const MCExpr *getExprForFDESymbol(const MCSymbol *Sym,
428 MCStreamer &Streamer) const;
430 /// Return true if the identifier \p Name does not need quotes to be
431 /// syntactically correct.
432 virtual bool isValidUnquotedName(StringRef Name) const;
434 /// Return true if the .section directive should be omitted when
435 /// emitting \p SectionName. For example:
437 /// shouldOmitSectionDirective(".text")
439 /// returns false => .section .text,#alloc,#execinstr
440 /// returns true => .text
441 virtual bool shouldOmitSectionDirective(StringRef SectionName) const;
443 bool usesSunStyleELFSectionSwitchSyntax() const {
444 return SunStyleELFSectionSwitchSyntax;
447 bool usesELFSectionDirectiveForBSS() const {
448 return UsesELFSectionDirectiveForBSS;
451 bool needsDwarfSectionOffsetDirective() const {
452 return NeedsDwarfSectionOffsetDirective;
457 bool hasMachoZeroFillDirective() const { return HasMachoZeroFillDirective; }
458 bool hasMachoTBSSDirective() const { return HasMachoTBSSDirective; }
459 bool hasStaticCtorDtorReferenceInStaticMode() const {
460 return HasStaticCtorDtorReferenceInStaticMode;
462 unsigned getMaxInstLength() const { return MaxInstLength; }
463 unsigned getMinInstAlignment() const { return MinInstAlignment; }
464 bool getDollarIsPC() const { return DollarIsPC; }
465 const char *getSeparatorString() const { return SeparatorString; }
467 /// This indicates the column (zero-based) at which asm comments should be
469 unsigned getCommentColumn() const { return 40; }
471 const char *getCommentString() const { return CommentString; }
472 const char *getLabelSuffix() const { return LabelSuffix; }
474 bool useAssignmentForEHBegin() const { return UseAssignmentForEHBegin; }
475 bool needsLocalForSize() const { return NeedsLocalForSize; }
476 const char *getPrivateGlobalPrefix() const { return PrivateGlobalPrefix; }
477 const char *getPrivateLabelPrefix() const { return PrivateLabelPrefix; }
478 bool hasLinkerPrivateGlobalPrefix() const {
479 return LinkerPrivateGlobalPrefix[0] != '\0';
481 const char *getLinkerPrivateGlobalPrefix() const {
482 if (hasLinkerPrivateGlobalPrefix())
483 return LinkerPrivateGlobalPrefix;
484 return getPrivateGlobalPrefix();
486 const char *getInlineAsmStart() const { return InlineAsmStart; }
487 const char *getInlineAsmEnd() const { return InlineAsmEnd; }
488 const char *getCode16Directive() const { return Code16Directive; }
489 const char *getCode32Directive() const { return Code32Directive; }
490 const char *getCode64Directive() const { return Code64Directive; }
491 unsigned getAssemblerDialect() const { return AssemblerDialect; }
492 bool doesAllowAtInName() const { return AllowAtInName; }
493 bool supportsNameQuoting() const { return SupportsQuotedNames; }
494 bool doesSupportDataRegionDirectives() const {
495 return UseDataRegionDirectives;
497 const char *getZeroDirective() const { return ZeroDirective; }
498 const char *getAsciiDirective() const { return AsciiDirective; }
499 const char *getAscizDirective() const { return AscizDirective; }
500 bool getAlignmentIsInBytes() const { return AlignmentIsInBytes; }
501 unsigned getTextAlignFillValue() const { return TextAlignFillValue; }
502 const char *getGlobalDirective() const { return GlobalDirective; }
503 bool doesSetDirectiveSuppressReloc() const {
504 return SetDirectiveSuppressesReloc;
506 bool hasAggressiveSymbolFolding() const { return HasAggressiveSymbolFolding; }
507 bool getCOMMDirectiveAlignmentIsInBytes() const {
508 return COMMDirectiveAlignmentIsInBytes;
510 LCOMM::LCOMMType getLCOMMDirectiveAlignmentType() const {
511 return LCOMMDirectiveAlignmentType;
513 bool hasFunctionAlignment() const { return HasFunctionAlignment; }
514 bool hasDotTypeDotSizeDirective() const { return HasDotTypeDotSizeDirective; }
515 bool hasSingleParameterDotFile() const { return HasSingleParameterDotFile; }
516 bool hasIdentDirective() const { return HasIdentDirective; }
517 bool hasNoDeadStrip() const { return HasNoDeadStrip; }
518 bool hasAltEntry() const { return HasAltEntry; }
519 const char *getWeakDirective() const { return WeakDirective; }
520 const char *getWeakRefDirective() const { return WeakRefDirective; }
521 bool hasWeakDefDirective() const { return HasWeakDefDirective; }
522 bool hasWeakDefCanBeHiddenDirective() const {
523 return HasWeakDefCanBeHiddenDirective;
525 bool hasLinkOnceDirective() const { return HasLinkOnceDirective; }
527 MCSymbolAttr getHiddenVisibilityAttr() const { return HiddenVisibilityAttr; }
528 MCSymbolAttr getHiddenDeclarationVisibilityAttr() const {
529 return HiddenDeclarationVisibilityAttr;
531 MCSymbolAttr getProtectedVisibilityAttr() const {
532 return ProtectedVisibilityAttr;
534 bool doesSupportDebugInformation() const { return SupportsDebugInformation; }
535 bool doesSupportExceptionHandling() const {
536 return ExceptionsType != ExceptionHandling::None;
538 ExceptionHandling getExceptionHandlingType() const { return ExceptionsType; }
539 WinEH::EncodingType getWinEHEncodingType() const { return WinEHEncodingType; }
541 void setExceptionsType(ExceptionHandling EH) {
545 /// Returns true if the exception handling method for the platform uses call
546 /// frame information to unwind.
547 bool usesCFIForEH() const {
548 return (ExceptionsType == ExceptionHandling::DwarfCFI ||
549 ExceptionsType == ExceptionHandling::ARM || usesWindowsCFI());
552 bool usesWindowsCFI() const {
553 return ExceptionsType == ExceptionHandling::WinEH &&
554 (WinEHEncodingType != WinEH::EncodingType::Invalid &&
555 WinEHEncodingType != WinEH::EncodingType::X86);
558 bool doesDwarfUseRelocationsAcrossSections() const {
559 return DwarfUsesRelocationsAcrossSections;
561 bool doDwarfFDESymbolsUseAbsDiff() const { return DwarfFDESymbolsUseAbsDiff; }
562 bool useDwarfRegNumForCFI() const { return DwarfRegNumForCFI; }
563 bool useParensForSymbolVariant() const { return UseParensForSymbolVariant; }
565 void addInitialFrameState(const MCCFIInstruction &Inst) {
566 InitialFrameState.push_back(Inst);
569 const std::vector<MCCFIInstruction> &getInitialFrameState() const {
570 return InitialFrameState;
573 /// Return true if assembly (inline or otherwise) should be parsed.
574 bool useIntegratedAssembler() const { return UseIntegratedAssembler; }
576 /// Set whether assembly (inline or otherwise) should be parsed.
577 virtual void setUseIntegratedAssembler(bool Value) {
578 UseIntegratedAssembler = Value;
581 /// Return true if assembly (inline or otherwise) should be parsed.
582 bool preserveAsmComments() const { return PreserveAsmComments; }
584 /// Set whether assembly (inline or otherwise) should be parsed.
585 virtual void setPreserveAsmComments(bool Value) {
586 PreserveAsmComments = Value;
589 DebugCompressionType compressDebugSections() const {
590 return CompressDebugSections;
593 void setCompressDebugSections(DebugCompressionType CompressDebugSections) {
594 this->CompressDebugSections = CompressDebugSections;
597 bool shouldUseLogicalShr() const { return UseLogicalShr; }
599 bool canRelaxRelocations() const { return RelaxELFRelocations; }
600 void setRelaxELFRelocations(bool V) { RelaxELFRelocations = V; }