MC asm parser: allow ?'s in symbol names, and handle @'s in names in MS asm
[oota-llvm.git] / include / llvm / MC / MCAsmInfo.h
1 //===-- llvm/MC/MCAsmInfo.h - Asm info --------------------------*- C++ -*-===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // 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_MC_MCASMINFO_H
17 #define LLVM_MC_MCASMINFO_H
18
19 #include "llvm/MC/MCDirectives.h"
20 #include "llvm/MC/MCDwarf.h"
21 #include "llvm/MC/MachineLocation.h"
22 #include <cassert>
23 #include <vector>
24
25 namespace llvm {
26   class MCExpr;
27   class MCSection;
28   class MCStreamer;
29   class MCSymbol;
30   class MCContext;
31
32   namespace ExceptionHandling {
33     enum ExceptionsType { None, DwarfCFI, SjLj, ARM, Win64 };
34   }
35
36   namespace LCOMM {
37     enum LCOMMType { NoAlignment, ByteAlignment, Log2Alignment };
38   }
39
40   /// MCAsmInfo - This class is intended to be used as a base class for asm
41   /// properties and features specific to the target.
42   class MCAsmInfo {
43   protected:
44     //===------------------------------------------------------------------===//
45     // Properties to be set by the target writer, used to configure asm printer.
46     //
47
48     /// PointerSize - Pointer size in bytes.
49     ///               Default is 4.
50     unsigned PointerSize;
51
52     /// CalleeSaveStackSlotSize - Size of the stack slot reserved for
53     ///                           callee-saved registers, in bytes.
54     ///                           Default is same as pointer size.
55     unsigned CalleeSaveStackSlotSize;
56
57     /// IsLittleEndian - True if target is little endian.
58     ///                  Default is true.
59     bool IsLittleEndian;
60
61     /// StackGrowsUp - True if target stack grow up.
62     ///                Default is false.
63     bool StackGrowsUp;
64
65     /// HasSubsectionsViaSymbols - True if this target has the MachO
66     /// .subsections_via_symbols directive.
67     bool HasSubsectionsViaSymbols;           // Default is false.
68
69     /// HasMachoZeroFillDirective - True if this is a MachO target that supports
70     /// the macho-specific .zerofill directive for emitting BSS Symbols.
71     bool HasMachoZeroFillDirective;               // Default is false.
72
73     /// HasMachoTBSSDirective - True if this is a MachO target that supports
74     /// the macho-specific .tbss directive for emitting thread local BSS Symbols
75     bool HasMachoTBSSDirective;                 // Default is false.
76
77     /// HasStaticCtorDtorReferenceInStaticMode - True if the compiler should
78     /// emit a ".reference .constructors_used" or ".reference .destructors_used"
79     /// directive after the a static ctor/dtor list.  This directive is only
80     /// emitted in Static relocation model.
81     bool HasStaticCtorDtorReferenceInStaticMode;  // Default is false.
82
83     /// LinkerRequiresNonEmptyDwarfLines - True if the linker has a bug and
84     /// requires that the debug_line section be of a minimum size. In practice
85     /// such a linker requires a non empty line sequence if a file is present.
86     bool LinkerRequiresNonEmptyDwarfLines; // Default to false.
87
88     /// MaxInstLength - This is the maximum possible length of an instruction,
89     /// which is needed to compute the size of an inline asm.
90     unsigned MaxInstLength;                  // Defaults to 4.
91
92     /// MinInstAlignment - Every possible instruction length is a multiple of
93     /// this value.  Factored out in .debug_frame and .debug_line.
94     unsigned MinInstAlignment;                  // Defaults to 1.
95
96     /// DollarIsPC - The '$' token, when not referencing an identifier or
97     /// constant, refers to the current PC.
98     bool DollarIsPC;                         // Defaults to false.
99
100     /// SeparatorString - This string, if specified, is used to separate
101     /// instructions from each other when on the same line.
102     const char *SeparatorString;             // Defaults to ';'
103
104     /// CommentColumn - This indicates the comment num (zero-based) at
105     /// which asm comments should be printed.
106     unsigned CommentColumn;                  // Defaults to 40
107
108     /// CommentString - This indicates the comment character used by the
109     /// assembler.
110     const char *CommentString;               // Defaults to "#"
111
112     /// LabelSuffix - This is appended to emitted labels.
113     const char *LabelSuffix;                 // Defaults to ":"
114
115     /// LabelSuffix - This is appended to emitted labels.
116     const char *DebugLabelSuffix;                 // Defaults to ":"
117
118     /// GlobalPrefix - If this is set to a non-empty string, it is prepended
119     /// onto all global symbols.  This is often used for "_" or ".".
120     const char *GlobalPrefix;                // Defaults to ""
121
122     /// PrivateGlobalPrefix - This prefix is used for globals like constant
123     /// pool entries that are completely private to the .s file and should not
124     /// have names in the .o file.  This is often "." or "L".
125     const char *PrivateGlobalPrefix;         // Defaults to "."
126
127     /// LinkerPrivateGlobalPrefix - This prefix is used for symbols that should
128     /// be passed through the assembler but be removed by the linker.  This
129     /// is "l" on Darwin, currently used for some ObjC metadata.
130     const char *LinkerPrivateGlobalPrefix;   // Defaults to ""
131
132     /// InlineAsmStart/End - If these are nonempty, they contain a directive to
133     /// emit before and after an inline assembly statement.
134     const char *InlineAsmStart;              // Defaults to "#APP\n"
135     const char *InlineAsmEnd;                // Defaults to "#NO_APP\n"
136
137     /// Code16Directive, Code32Directive, Code64Directive - These are assembly
138     /// directives that tells the assembler to interpret the following
139     /// instructions differently.
140     const char *Code16Directive;             // Defaults to ".code16"
141     const char *Code32Directive;             // Defaults to ".code32"
142     const char *Code64Directive;             // Defaults to ".code64"
143
144     /// AssemblerDialect - Which dialect of an assembler variant to use.
145     unsigned AssemblerDialect;               // Defaults to 0
146
147     /// AllowQuotesInName - This is true if the assembler allows for complex
148     /// symbol names to be surrounded in quotes.  This defaults to false.
149     bool AllowQuotesInName;
150
151     /// AllowNameToStartWithDigit - This is true if the assembler allows symbol
152     /// names to start with a digit (e.g., "0x0021").  This defaults to false.
153     bool AllowNameToStartWithDigit;
154
155     /// AllowPeriodsInName - This is true if the assembler allows periods in
156     /// symbol names.  This defaults to true.
157     bool AllowPeriodsInName;
158
159     /// \brief This is true if the assembler allows @ characters in symbol
160     /// names. Defaults to false.
161     bool AllowAtInName;
162
163     /// AllowUTF8 - This is true if the assembler accepts UTF-8 input.
164     // FIXME: Make this a more general encoding setting?
165     bool AllowUTF8;
166
167     /// UseDataRegionDirectives - This is true if data region markers should
168     /// be printed as ".data_region/.end_data_region" directives. If false,
169     /// use "$d/$a" labels instead.
170     bool UseDataRegionDirectives;
171
172     //===--- Data Emission Directives -------------------------------------===//
173
174     /// ZeroDirective - this should be set to the directive used to get some
175     /// number of zero bytes emitted to the current section.  Common cases are
176     /// "\t.zero\t" and "\t.space\t".  If this is set to null, the
177     /// Data*bitsDirective's will be used to emit zero bytes.
178     const char *ZeroDirective;               // Defaults to "\t.zero\t"
179
180     /// AsciiDirective - This directive allows emission of an ascii string with
181     /// the standard C escape characters embedded into it.
182     const char *AsciiDirective;              // Defaults to "\t.ascii\t"
183
184     /// AscizDirective - If not null, this allows for special handling of
185     /// zero terminated strings on this target.  This is commonly supported as
186     /// ".asciz".  If a target doesn't support this, it can be set to null.
187     const char *AscizDirective;              // Defaults to "\t.asciz\t"
188
189     /// DataDirectives - These directives are used to output some unit of
190     /// integer data to the current section.  If a data directive is set to
191     /// null, smaller data directives will be used to emit the large sizes.
192     const char *Data8bitsDirective;          // Defaults to "\t.byte\t"
193     const char *Data16bitsDirective;         // Defaults to "\t.short\t"
194     const char *Data32bitsDirective;         // Defaults to "\t.long\t"
195     const char *Data64bitsDirective;         // Defaults to "\t.quad\t"
196
197     /// GPRel64Directive - if non-null, a directive that is used to emit a word
198     /// which should be relocated as a 64-bit GP-relative offset, e.g. .gpdword
199     /// on Mips.
200     const char *GPRel64Directive;            // Defaults to NULL.
201
202     /// GPRel32Directive - if non-null, a directive that is used to emit a word
203     /// which should be relocated as a 32-bit GP-relative offset, e.g. .gpword
204     /// on Mips or .gprel32 on Alpha.
205     const char *GPRel32Directive;            // Defaults to NULL.
206
207     /// SunStyleELFSectionSwitchSyntax - This is true if this target uses "Sun
208     /// Style" syntax for section switching ("#alloc,#write" etc) instead of the
209     /// normal ELF syntax (,"a,w") in .section directives.
210     bool SunStyleELFSectionSwitchSyntax;     // Defaults to false.
211
212     /// UsesELFSectionDirectiveForBSS - This is true if this target uses ELF
213     /// '.section' directive before the '.bss' one. It's used for PPC/Linux
214     /// which doesn't support the '.bss' directive only.
215     bool UsesELFSectionDirectiveForBSS;      // Defaults to false.
216
217     /// HasMicrosoftFastStdCallMangling - True if this target uses microsoft
218     /// style mangling for functions with X86_StdCall/X86_FastCall calling
219     /// convention.
220     bool HasMicrosoftFastStdCallMangling;    // Defaults to false.
221
222     bool NeedsDwarfSectionOffsetDirective;
223
224     //===--- Alignment Information ----------------------------------------===//
225
226     /// AlignDirective - The directive used to emit round up to an alignment
227     /// boundary.
228     ///
229     const char *AlignDirective;              // Defaults to "\t.align\t"
230
231     /// AlignmentIsInBytes - If this is true (the default) then the asmprinter
232     /// emits ".align N" directives, where N is the number of bytes to align to.
233     /// Otherwise, it emits ".align log2(N)", e.g. 3 to align to an 8 byte
234     /// boundary.
235     bool AlignmentIsInBytes;                 // Defaults to true
236
237     /// TextAlignFillValue - If non-zero, this is used to fill the executable
238     /// space created as the result of a alignment directive.
239     unsigned TextAlignFillValue;             // Defaults to 0
240
241     //===--- Global Variable Emission Directives --------------------------===//
242
243     /// GlobalDirective - This is the directive used to declare a global entity.
244     ///
245     const char *GlobalDirective;             // Defaults to NULL.
246
247     /// ExternDirective - This is the directive used to declare external
248     /// globals.
249     ///
250     const char *ExternDirective;             // Defaults to NULL.
251
252     /// HasSetDirective - True if the assembler supports the .set directive.
253     bool HasSetDirective;                    // Defaults to true.
254
255     /// HasAggressiveSymbolFolding - False if the assembler requires that we use
256     /// Lc = a - b
257     /// .long Lc
258     /// instead of
259     /// .long a - b
260     bool HasAggressiveSymbolFolding;           // Defaults to true.
261
262     /// COMMDirectiveAlignmentIsInBytes - True is .comm's and .lcomms optional
263     /// alignment is to be specified in bytes instead of log2(n).
264     bool COMMDirectiveAlignmentIsInBytes;    // Defaults to true;
265
266     /// LCOMMDirectiveAlignment - Describes if the .lcomm directive for the
267     /// target supports an alignment argument and how it is interpreted.
268     LCOMM::LCOMMType LCOMMDirectiveAlignmentType; // Defaults to NoAlignment.
269
270     /// HasDotTypeDotSizeDirective - True if the target has .type and .size
271     /// directives, this is true for most ELF targets.
272     bool HasDotTypeDotSizeDirective;         // Defaults to true.
273
274     /// HasSingleParameterDotFile - True if the target has a single parameter
275     /// .file directive, this is true for ELF targets.
276     bool HasSingleParameterDotFile;          // Defaults to true.
277
278     /// hasIdentDirective - True if the target has a .ident directive, this is
279     /// true for ELF targets.
280     bool HasIdentDirective;                  // Defaults to false.
281
282     /// HasNoDeadStrip - True if this target supports the MachO .no_dead_strip
283     /// directive.
284     bool HasNoDeadStrip;                     // Defaults to false.
285
286     /// HasSymbolResolver - True if this target supports the MachO
287     /// .symbol_resolver directive.
288     bool HasSymbolResolver;                     // Defaults to false.
289
290     /// WeakRefDirective - This directive, if non-null, is used to declare a
291     /// global as being a weak undefined symbol.
292     const char *WeakRefDirective;            // Defaults to NULL.
293
294     /// WeakDefDirective - This directive, if non-null, is used to declare a
295     /// global as being a weak defined symbol.
296     const char *WeakDefDirective;            // Defaults to NULL.
297
298     /// LinkOnceDirective - This directive, if non-null is used to declare a
299     /// global as being a weak defined symbol.  This is used on cygwin/mingw.
300     const char *LinkOnceDirective;           // Defaults to NULL.
301
302     /// HiddenVisibilityAttr - This attribute, if not MCSA_Invalid, is used to
303     /// declare a symbol as having hidden visibility.
304     MCSymbolAttr HiddenVisibilityAttr;       // Defaults to MCSA_Hidden.
305
306     /// HiddenDeclarationVisibilityAttr - This attribute, if not MCSA_Invalid,
307     /// is used to declare an undefined symbol as having hidden visibility.
308     MCSymbolAttr HiddenDeclarationVisibilityAttr;   // Defaults to MCSA_Hidden.
309
310
311     /// ProtectedVisibilityAttr - This attribute, if not MCSA_Invalid, is used
312     /// to declare a symbol as having protected visibility.
313     MCSymbolAttr ProtectedVisibilityAttr;    // Defaults to MCSA_Protected
314
315     //===--- Dwarf Emission Directives -----------------------------------===//
316
317     /// HasLEB128 - True if target asm supports leb128 directives.
318     bool HasLEB128;                          // Defaults to false.
319
320     /// SupportsDebugInformation - True if target supports emission of debugging
321     /// information.
322     bool SupportsDebugInformation;           // Defaults to false.
323
324     /// SupportsExceptionHandling - True if target supports exception handling.
325     ExceptionHandling::ExceptionsType ExceptionsType; // Defaults to None
326
327     /// DwarfUsesRelocationsAcrossSections - True if Dwarf2 output generally
328     /// uses relocations for references to other .debug_* sections.
329     bool DwarfUsesRelocationsAcrossSections;
330
331     /// DwarfRegNumForCFI - True if dwarf register numbers are printed
332     /// instead of symbolic register names in .cfi_* directives.
333     bool DwarfRegNumForCFI;  // Defaults to false;
334
335     //===--- Prologue State ----------------------------------------------===//
336
337     std::vector<MCCFIInstruction> InitialFrameState;
338
339   public:
340     explicit MCAsmInfo();
341     virtual ~MCAsmInfo();
342
343     // FIXME: move these methods to DwarfPrinter when the JIT stops using them.
344     static unsigned getSLEB128Size(int64_t Value);
345     static unsigned getULEB128Size(uint64_t Value);
346
347     /// getPointerSize - Get the pointer size in bytes.
348     unsigned getPointerSize() const {
349       return PointerSize;
350     }
351
352     /// getCalleeSaveStackSlotSize - Get the callee-saved register stack slot
353     /// size in bytes.
354     unsigned getCalleeSaveStackSlotSize() const {
355       return CalleeSaveStackSlotSize;
356     }
357
358     /// isLittleEndian - True if the target is little endian.
359     bool isLittleEndian() const {
360       return IsLittleEndian;
361     }
362
363     /// isStackGrowthDirectionUp - True if target stack grow up.
364     bool isStackGrowthDirectionUp() const {
365       return StackGrowsUp;
366     }
367
368     bool hasSubsectionsViaSymbols() const { return HasSubsectionsViaSymbols; }
369
370     // Data directive accessors.
371     //
372     const char *getData8bitsDirective() const {
373       return Data8bitsDirective;
374     }
375     const char *getData16bitsDirective() const {
376       return Data16bitsDirective;
377     }
378     const char *getData32bitsDirective() const {
379       return Data32bitsDirective;
380     }
381     const char *getData64bitsDirective() const {
382       return Data64bitsDirective;
383     }
384     const char *getGPRel64Directive() const { return GPRel64Directive; }
385     const char *getGPRel32Directive() const { return GPRel32Directive; }
386
387     /// getNonexecutableStackSection - Targets can implement this method to
388     /// specify a section to switch to if the translation unit doesn't have any
389     /// trampolines that require an executable stack.
390     virtual const MCSection *getNonexecutableStackSection(MCContext &Ctx) const{
391       return 0;
392     }
393
394     virtual const MCExpr *
395     getExprForPersonalitySymbol(const MCSymbol *Sym,
396                                 unsigned Encoding,
397                                 MCStreamer &Streamer) const;
398
399     const MCExpr *
400     getExprForFDESymbol(const MCSymbol *Sym,
401                         unsigned Encoding,
402                         MCStreamer &Streamer) const;
403
404     bool usesSunStyleELFSectionSwitchSyntax() const {
405       return SunStyleELFSectionSwitchSyntax;
406     }
407
408     bool usesELFSectionDirectiveForBSS() const {
409       return UsesELFSectionDirectiveForBSS;
410     }
411
412     bool hasMicrosoftFastStdCallMangling() const {
413       return HasMicrosoftFastStdCallMangling;
414     }
415
416     bool needsDwarfSectionOffsetDirective() const {
417       return NeedsDwarfSectionOffsetDirective;
418     }
419
420     // Accessors.
421     //
422     bool hasMachoZeroFillDirective() const { return HasMachoZeroFillDirective; }
423     bool hasMachoTBSSDirective() const { return HasMachoTBSSDirective; }
424     bool hasStaticCtorDtorReferenceInStaticMode() const {
425       return HasStaticCtorDtorReferenceInStaticMode;
426     }
427     bool getLinkerRequiresNonEmptyDwarfLines() const {
428       return LinkerRequiresNonEmptyDwarfLines;
429     }
430     unsigned getMaxInstLength() const {
431       return MaxInstLength;
432     }
433     unsigned getMinInstAlignment() const {
434       return MinInstAlignment;
435     }
436     bool getDollarIsPC() const {
437       return DollarIsPC;
438     }
439     const char *getSeparatorString() const {
440       return SeparatorString;
441     }
442     unsigned getCommentColumn() const {
443       return CommentColumn;
444     }
445     const char *getCommentString() const {
446       return CommentString;
447     }
448     const char *getLabelSuffix() const {
449       return LabelSuffix;
450     }
451
452     const char *getDebugLabelSuffix() const {
453       return DebugLabelSuffix;
454     }
455
456     const char *getGlobalPrefix() const {
457       return GlobalPrefix;
458     }
459     const char *getPrivateGlobalPrefix() const {
460       return PrivateGlobalPrefix;
461     }
462     const char *getLinkerPrivateGlobalPrefix() const {
463       return LinkerPrivateGlobalPrefix;
464     }
465     const char *getInlineAsmStart() const {
466       return InlineAsmStart;
467     }
468     const char *getInlineAsmEnd() const {
469       return InlineAsmEnd;
470     }
471     const char *getCode16Directive() const {
472       return Code16Directive;
473     }
474     const char *getCode32Directive() const {
475       return Code32Directive;
476     }
477     const char *getCode64Directive() const {
478       return Code64Directive;
479     }
480     unsigned getAssemblerDialect() const {
481       return AssemblerDialect;
482     }
483     bool doesAllowQuotesInName() const {
484       return AllowQuotesInName;
485     }
486     bool doesAllowNameToStartWithDigit() const {
487       return AllowNameToStartWithDigit;
488     }
489     bool doesAllowPeriodsInName() const {
490       return AllowPeriodsInName;
491     }
492     bool doesAllowAtInName() const {
493       return AllowAtInName;
494     }
495     bool doesAllowUTF8() const {
496       return AllowUTF8;
497     }
498     bool doesSupportDataRegionDirectives() const {
499       return UseDataRegionDirectives;
500     }
501     const char *getZeroDirective() const {
502       return ZeroDirective;
503     }
504     const char *getAsciiDirective() const {
505       return AsciiDirective;
506     }
507     const char *getAscizDirective() const {
508       return AscizDirective;
509     }
510     const char *getAlignDirective() const {
511       return AlignDirective;
512     }
513     bool getAlignmentIsInBytes() const {
514       return AlignmentIsInBytes;
515     }
516     unsigned getTextAlignFillValue() const {
517       return TextAlignFillValue;
518     }
519     const char *getGlobalDirective() const {
520       return GlobalDirective;
521     }
522     const char *getExternDirective() const {
523       return ExternDirective;
524     }
525     bool hasSetDirective() const { return HasSetDirective; }
526     bool hasAggressiveSymbolFolding() const {
527       return HasAggressiveSymbolFolding;
528     }
529     bool getCOMMDirectiveAlignmentIsInBytes() const {
530       return COMMDirectiveAlignmentIsInBytes;
531     }
532     LCOMM::LCOMMType getLCOMMDirectiveAlignmentType() const {
533       return LCOMMDirectiveAlignmentType;
534     }
535     bool hasDotTypeDotSizeDirective() const {return HasDotTypeDotSizeDirective;}
536     bool hasSingleParameterDotFile() const { return HasSingleParameterDotFile; }
537     bool hasIdentDirective() const { return HasIdentDirective; }
538     bool hasNoDeadStrip() const { return HasNoDeadStrip; }
539     bool hasSymbolResolver() const { return HasSymbolResolver; }
540     const char *getWeakRefDirective() const { return WeakRefDirective; }
541     const char *getWeakDefDirective() const { return WeakDefDirective; }
542     const char *getLinkOnceDirective() const { return LinkOnceDirective; }
543
544     MCSymbolAttr getHiddenVisibilityAttr() const { return HiddenVisibilityAttr;}
545     MCSymbolAttr getHiddenDeclarationVisibilityAttr() const {
546       return HiddenDeclarationVisibilityAttr;
547     }
548     MCSymbolAttr getProtectedVisibilityAttr() const {
549       return ProtectedVisibilityAttr;
550     }
551     bool hasLEB128() const {
552       return HasLEB128;
553     }
554     bool doesSupportDebugInformation() const {
555       return SupportsDebugInformation;
556     }
557     bool doesSupportExceptionHandling() const {
558       return ExceptionsType != ExceptionHandling::None;
559     }
560     ExceptionHandling::ExceptionsType getExceptionHandlingType() const {
561       return ExceptionsType;
562     }
563     bool isExceptionHandlingDwarf() const {
564       return
565         (ExceptionsType == ExceptionHandling::DwarfCFI ||
566          ExceptionsType == ExceptionHandling::ARM ||
567          ExceptionsType == ExceptionHandling::Win64);
568     }
569     bool doesDwarfUseRelocationsAcrossSections() const {
570       return DwarfUsesRelocationsAcrossSections;
571     }
572     bool useDwarfRegNumForCFI() const {
573       return DwarfRegNumForCFI;
574     }
575
576     void addInitialFrameState(const MCCFIInstruction &Inst) {
577       InitialFrameState.push_back(Inst);
578     }
579
580     const std::vector<MCCFIInstruction> &getInitialFrameState() const {
581       return InitialFrameState;
582     }
583   };
584 }
585
586 #endif