mcize lcomm, simplify .comm, extend both to support 64-bit sizes.
[oota-llvm.git] / include / llvm / MC / MCAsmInfo.h
index 4f8d92b3fcd40af81d653457c502d09d9ccb382e..5e31dfeb0dacf62847b5416633b1e7b8074c5f82 100644 (file)
 #ifndef LLVM_TARGET_ASM_INFO_H
 #define LLVM_TARGET_ASM_INFO_H
 
-#include "llvm/Support/DataTypes.h"
+#include "llvm/MC/MCDirectives.h"
 #include <cassert>
-#include <string>
 
 namespace llvm {
-  template <typename T> class SmallVectorImpl;
+  class MCSection;
+  class MCContext;
   
   /// MCAsmInfo - This class is intended to be used as a base class for asm
   /// properties and features specific to the target.
@@ -33,15 +33,20 @@ namespace llvm {
     // Properties to be set by the target writer, used to configure asm printer.
     //
 
-    /// ZeroFillDirective - Directive for emitting a global to the ZeroFill
-    /// section on this target.  Null if this target doesn't support zerofill.
-    const char *ZeroFillDirective;        // Default is null.
-
-    /// NonexecutableStackDirective - Directive for declaring to the
-    /// linker and beyond that the emitted code does not require stack
-    /// memory to be executable.
-    const char *NonexecutableStackDirective; // Default is null.
-
+    /// HasSubsectionsViaSymbols - True if this target has the MachO
+    /// .subsections_via_symbols directive.
+    bool HasSubsectionsViaSymbols;           // Default is false.
+    
+    /// HasMachoZeroFillDirective - True if this is a MachO target that supports
+    /// the macho-specific .zerofill directive for emitting BSS Symbols.
+    bool HasMachoZeroFillDirective;               // Default is false.
+    
+    /// HasStaticCtorDtorReferenceInStaticMode - True if the compiler should
+    /// emit a ".reference .constructors_used" or ".reference .destructors_used"
+    /// directive after the a static ctor/dtor list.  This directive is only
+    /// emitted in Static relocation model.
+    bool HasStaticCtorDtorReferenceInStaticMode;  // Default is false.
+    
     /// NeedsSet - True if target asm treats expressions in data directives
     /// as linktime-relocatable.  For assembly-time computation, we need to
     /// use a .set.  Thus:
@@ -51,81 +56,58 @@ namespace llvm {
     /// .long x-y
     /// is relocated if the relative locations of x and y change at linktime.
     /// We want both these things in different places.
-    bool NeedsSet;                        // Defaults to false.
+    bool NeedsSet;                           // Defaults to false.
     
     /// MaxInstLength - This is the maximum possible length of an instruction,
     /// which is needed to compute the size of an inline asm.
-    unsigned MaxInstLength;               // Defaults to 4.
+    unsigned MaxInstLength;                  // Defaults to 4.
     
     /// PCSymbol - The symbol used to represent the current PC.  Used in PC
     /// relative expressions.
-    const char *PCSymbol;                 // Defaults to "$".
+    const char *PCSymbol;                    // Defaults to "$".
 
     /// SeparatorChar - This character, if specified, is used to separate
     /// instructions from each other when on the same line.  This is used to
     /// measure inline asm instructions.
-    char SeparatorChar;                   // Defaults to ';'
+    char SeparatorChar;                      // Defaults to ';'
 
     /// CommentColumn - This indicates the comment num (zero-based) at
     /// which asm comments should be printed.
-    unsigned CommentColumn;               // Defaults to 60
+    unsigned CommentColumn;                  // Defaults to 60
 
     /// CommentString - This indicates the comment character used by the
     /// assembler.
-    const char *CommentString;            // Defaults to "#"
+    const char *CommentString;               // Defaults to "#"
 
     /// GlobalPrefix - If this is set to a non-empty string, it is prepended
     /// onto all global symbols.  This is often used for "_" or ".".
-    const char *GlobalPrefix;             // Defaults to ""
+    const char *GlobalPrefix;                // Defaults to ""
 
     /// PrivateGlobalPrefix - This prefix is used for globals like constant
     /// pool entries that are completely private to the .s file and should not
     /// have names in the .o file.  This is often "." or "L".
-    const char *PrivateGlobalPrefix;      // Defaults to "."
+    const char *PrivateGlobalPrefix;         // Defaults to "."
     
     /// LinkerPrivateGlobalPrefix - This prefix is used for symbols that should
     /// be passed through the assembler but be removed by the linker.  This
     /// is "l" on Darwin, currently used for some ObjC metadata.
-    const char *LinkerPrivateGlobalPrefix;      // Defaults to ""
-    
-    /// JumpTableSpecialLabelPrefix - If not null, a extra (dead) label is
-    /// emitted before jump tables with the specified prefix.
-    const char *JumpTableSpecialLabelPrefix;  // Default to null.
+    const char *LinkerPrivateGlobalPrefix;   // Defaults to ""
     
-    /// GlobalVarAddrPrefix/Suffix - If these are nonempty, these strings
-    /// will enclose any GlobalVariable (that isn't a function)
-    ///
-    const char *GlobalVarAddrPrefix;      // Defaults to ""
-    const char *GlobalVarAddrSuffix;      // Defaults to ""
-
-    /// FunctionAddrPrefix/Suffix - If these are nonempty, these strings
-    /// will enclose any GlobalVariable that points to a function.
-    ///
-    const char *FunctionAddrPrefix;       // Defaults to ""
-    const char *FunctionAddrSuffix;       // Defaults to ""
-
-    /// PersonalityPrefix/Suffix - If these are nonempty, these strings will
-    /// enclose any personality function in the common frame section.
-    /// 
-    const char *PersonalityPrefix;        // Defaults to ""
-    const char *PersonalitySuffix;        // Defaults to ""
-
-    /// NeedsIndirectEncoding - If set, we need to set the indirect encoding bit
-    /// for EH in Dwarf.
-    /// 
-    bool NeedsIndirectEncoding;           // Defaults to false
-
     /// InlineAsmStart/End - If these are nonempty, they contain a directive to
     /// emit before and after an inline assembly statement.
-    const char *InlineAsmStart;           // Defaults to "#APP\n"
-    const char *InlineAsmEnd;             // Defaults to "#NO_APP\n"
+    const char *InlineAsmStart;              // Defaults to "#APP\n"
+    const char *InlineAsmEnd;                // Defaults to "#NO_APP\n"
 
     /// AssemblerDialect - Which dialect of an assembler variant to use.
-    unsigned AssemblerDialect;            // Defaults to 0
+    unsigned AssemblerDialect;               // Defaults to 0
 
     /// AllowQuotesInName - This is true if the assembler allows for complex
     /// symbol names to be surrounded in quotes.  This defaults to false.
     bool AllowQuotesInName;
+
+    /// AllowNameToStartWithDigit - This is true if the assembler allows symbol
+    /// names to start with a digit (e.g., "0x0021").  This defaults to false.
+    bool AllowNameToStartWithDigit;
     
     //===--- Data Emission Directives -------------------------------------===//
 
@@ -133,194 +115,182 @@ namespace llvm {
     /// number of zero bytes emitted to the current section.  Common cases are
     /// "\t.zero\t" and "\t.space\t".  If this is set to null, the
     /// Data*bitsDirective's will be used to emit zero bytes.
-    const char *ZeroDirective;            // Defaults to "\t.zero\t"
-    const char *ZeroDirectiveSuffix;      // Defaults to ""
+    const char *ZeroDirective;               // Defaults to "\t.zero\t"
 
     /// AsciiDirective - This directive allows emission of an ascii string with
     /// the standard C escape characters embedded into it.
-    const char *AsciiDirective;           // Defaults to "\t.ascii\t"
+    const char *AsciiDirective;              // Defaults to "\t.ascii\t"
     
     /// AscizDirective - If not null, this allows for special handling of
     /// zero terminated strings on this target.  This is commonly supported as
     /// ".asciz".  If a target doesn't support this, it can be set to null.
-    const char *AscizDirective;           // Defaults to "\t.asciz\t"
+    const char *AscizDirective;              // Defaults to "\t.asciz\t"
 
     /// DataDirectives - These directives are used to output some unit of
     /// integer data to the current section.  If a data directive is set to
     /// null, smaller data directives will be used to emit the large sizes.
-    const char *Data8bitsDirective;       // Defaults to "\t.byte\t"
-    const char *Data16bitsDirective;      // Defaults to "\t.short\t"
-    const char *Data32bitsDirective;      // Defaults to "\t.long\t"
-    const char *Data64bitsDirective;      // Defaults to "\t.quad\t"
+    const char *Data8bitsDirective;          // Defaults to "\t.byte\t"
+    const char *Data16bitsDirective;         // Defaults to "\t.short\t"
+    const char *Data32bitsDirective;         // Defaults to "\t.long\t"
+    const char *Data64bitsDirective;         // Defaults to "\t.quad\t"
 
     /// getDataASDirective - Return the directive that should be used to emit
     /// data of the specified size to the specified numeric address space.
     virtual const char *getDataASDirective(unsigned Size, unsigned AS) const {
       assert(AS != 0 && "Don't know the directives for default addr space");
-      return NULL;
+      return 0;
     }
 
     /// SunStyleELFSectionSwitchSyntax - This is true if this target uses "Sun
     /// Style" syntax for section switching ("#alloc,#write" etc) instead of the
     /// normal ELF syntax (,"a,w") in .section directives.
-    bool SunStyleELFSectionSwitchSyntax;   // Defaults to false.
+    bool SunStyleELFSectionSwitchSyntax;     // Defaults to false.
 
     /// UsesELFSectionDirectiveForBSS - This is true if this target uses ELF
     /// '.section' directive before the '.bss' one. It's used for PPC/Linux 
     /// which doesn't support the '.bss' directive only.
-    bool UsesELFSectionDirectiveForBSS;  // Defaults to false.
+    bool UsesELFSectionDirectiveForBSS;      // Defaults to false.
     
     //===--- Alignment Information ----------------------------------------===//
 
     /// AlignDirective - The directive used to emit round up to an alignment
     /// boundary.
     ///
-    const char *AlignDirective;           // Defaults to "\t.align\t"
+    const char *AlignDirective;              // Defaults to "\t.align\t"
 
     /// AlignmentIsInBytes - If this is true (the default) then the asmprinter
     /// emits ".align N" directives, where N is the number of bytes to align to.
     /// Otherwise, it emits ".align log2(N)", e.g. 3 to align to an 8 byte
     /// boundary.
-    bool AlignmentIsInBytes;              // Defaults to true
+    bool AlignmentIsInBytes;                 // Defaults to true
 
     /// TextAlignFillValue - If non-zero, this is used to fill the executable
     /// space created as the result of a alignment directive.
-    unsigned TextAlignFillValue;
+    unsigned TextAlignFillValue;             // Defaults to 0
 
     //===--- Section Switching Directives ---------------------------------===//
     
     /// JumpTableDirective - if non-null, the directive to emit before jump
     /// table entries.  FIXME: REMOVE THIS.
-    const char *JumpTableDirective;
-    const char *PICJumpTableDirective;
+    const char *JumpTableDirective;          // Defaults to NULL.
+    const char *PICJumpTableDirective;       // Defaults to NULL.
 
 
     //===--- Global Variable Emission Directives --------------------------===//
     
     /// GlobalDirective - This is the directive used to declare a global entity.
     ///
-    const char *GlobalDirective;          // Defaults to NULL.
+    const char *GlobalDirective;             // Defaults to NULL.
 
     /// ExternDirective - This is the directive used to declare external 
     /// globals.
     ///
-    const char *ExternDirective;          // Defaults to NULL.
+    const char *ExternDirective;             // Defaults to NULL.
     
     /// SetDirective - This is the name of a directive that can be used to tell
     /// the assembler to set the value of a variable to some expression.
-    const char *SetDirective;             // Defaults to null.
+    const char *SetDirective;                // Defaults to null.
     
-    /// LCOMMDirective - This is the name of a directive (if supported) that can
-    /// be used to efficiently declare a local (internal) block of zero
-    /// initialized data in the .bss/.data section.  The syntax expected is:
-    /// @verbatim <LCOMMDirective> SYMBOLNAME LENGTHINBYTES, ALIGNMENT
-    /// @endverbatim
-    const char *LCOMMDirective;           // Defaults to null.
+    /// HasLCOMMDirective - This is true if the target supports the .lcomm
+    /// directive.
+    bool HasLCOMMDirective;              // Defaults to false.
     
-    const char *COMMDirective;            // Defaults to "\t.comm\t".
-
     /// COMMDirectiveTakesAlignment - True if COMMDirective take a third
     /// argument that specifies the alignment of the declaration.
-    bool COMMDirectiveTakesAlignment;     // Defaults to true.
+    bool COMMDirectiveTakesAlignment;        // Defaults to true.
     
     /// HasDotTypeDotSizeDirective - True if the target has .type and .size
     /// directives, this is true for most ELF targets.
-    bool HasDotTypeDotSizeDirective;      // Defaults to true.
+    bool HasDotTypeDotSizeDirective;         // Defaults to true.
 
     /// HasSingleParameterDotFile - True if the target has a single parameter
     /// .file directive, this is true for ELF targets.
-    bool HasSingleParameterDotFile;      // Defaults to true.
+    bool HasSingleParameterDotFile;          // Defaults to true.
 
-    /// UsedDirective - This directive, if non-null, is used to declare a global
-    /// as being used somehow that the assembler can't see.  This prevents dead
-    /// code elimination on some targets.
-    const char *UsedDirective;            // Defaults to null.
+    /// HasNoDeadStrip - True if this target supports the MachO .no_dead_strip
+    /// directive.
+    bool HasNoDeadStrip;                     // Defaults to false.
 
     /// WeakRefDirective - This directive, if non-null, is used to declare a
     /// global as being a weak undefined symbol.
-    const char *WeakRefDirective;         // Defaults to null.
+    const char *WeakRefDirective;            // Defaults to NULL.
     
     /// WeakDefDirective - This directive, if non-null, is used to declare a
     /// global as being a weak defined symbol.
-    const char *WeakDefDirective;         // Defaults to null.
+    const char *WeakDefDirective;            // Defaults to NULL.
+
+    /// LinkOnceDirective - This directive, if non-null is used to declare a
+    /// global as being a weak defined symbol.  This is used on cygwin/mingw.
+    const char *LinkOnceDirective;           // Defaults to NULL.
     
-    /// HiddenDirective - This directive, if non-null, is used to declare a
-    /// global or function as having hidden visibility.
-    const char *HiddenDirective;          // Defaults to "\t.hidden\t".
+    /// HiddenVisibilityAttr - This attribute, if not MCSA_Invalid, is used to
+    /// declare a symbol as having hidden visibility.
+    MCSymbolAttr HiddenVisibilityAttr;       // Defaults to MCSA_Hidden.
 
-    /// ProtectedDirective - This directive, if non-null, is used to declare a
-    /// global or function as having protected visibility.
-    const char *ProtectedDirective;       // Defaults to "\t.protected\t".
+    /// ProtectedVisibilityAttr - This attribute, if not MCSA_Invalid, is used
+    /// to declare a symbol as having protected visibility.
+    MCSymbolAttr ProtectedVisibilityAttr;    // Defaults to MCSA_Protected
 
     //===--- Dwarf Emission Directives -----------------------------------===//
 
     /// AbsoluteDebugSectionOffsets - True if we should emit abolute section
-    /// offsets for debug information. Defaults to false.
-    bool AbsoluteDebugSectionOffsets;
+    /// offsets for debug information.
+    bool AbsoluteDebugSectionOffsets;        // Defaults to false.
 
     /// AbsoluteEHSectionOffsets - True if we should emit abolute section
     /// offsets for EH information. Defaults to false.
     bool AbsoluteEHSectionOffsets;
 
     /// HasLEB128 - True if target asm supports leb128 directives.
-    ///
-    bool HasLEB128; // Defaults to false.
+    bool HasLEB128;                          // Defaults to false.
 
     /// hasDotLocAndDotFile - True if target asm supports .loc and .file
     /// directives for emitting debugging information.
-    ///
-    bool HasDotLocAndDotFile; // Defaults to false.
+    bool HasDotLocAndDotFile;                // Defaults to false.
 
     /// SupportsDebugInformation - True if target supports emission of debugging
     /// information.
-    bool SupportsDebugInformation;
+    bool SupportsDebugInformation;           // Defaults to false.
 
-    /// SupportsExceptionHandling - True if target supports
-    /// exception handling.
-    ///
-    // Defaults to None
-    ExceptionHandling::ExceptionsType ExceptionsType;
+    /// SupportsExceptionHandling - True if target supports exception handling.
+    ExceptionHandling::ExceptionsType ExceptionsType; // Defaults to None
 
     /// RequiresFrameSection - true if the Dwarf2 output needs a frame section
-    ///
-    bool DwarfRequiresFrameSection; // Defaults to true.
+    bool DwarfRequiresFrameSection;          // Defaults to true.
 
     /// DwarfUsesInlineInfoSection - True if DwarfDebugInlineSection is used to
     /// encode inline subroutine information.
-    bool DwarfUsesInlineInfoSection; // Defaults to false.
+    bool DwarfUsesInlineInfoSection;         // Defaults to false.
 
     /// Is_EHSymbolPrivate - If set, the "_foo.eh" is made private so that it
     /// doesn't show up in the symbol table of the object file.
-    bool Is_EHSymbolPrivate;                // Defaults to true.
+    bool Is_EHSymbolPrivate;                 // Defaults to true.
 
     /// GlobalEHDirective - This is the directive used to make exception frame
     /// tables globally visible.
-    ///
-    const char *GlobalEHDirective;          // Defaults to NULL.
+    const char *GlobalEHDirective;           // Defaults to NULL.
 
     /// SupportsWeakEmptyEHFrame - True if target assembler and linker will
     /// handle a weak_definition of constant 0 for an omitted EH frame.
-    bool SupportsWeakOmittedEHFrame;  // Defaults to true.
+    bool SupportsWeakOmittedEHFrame;         // Defaults to true.
 
     /// DwarfSectionOffsetDirective - Special section offset directive.
     const char* DwarfSectionOffsetDirective; // Defaults to NULL
     
     //===--- CBE Asm Translation Table -----------------------------------===//
 
-    const char *const *AsmTransCBE; // Defaults to empty
+    const char *const *AsmTransCBE;          // Defaults to empty
 
   public:
     explicit MCAsmInfo();
     virtual ~MCAsmInfo();
 
-    /// getSLEB128Size - Compute the number of bytes required for a signed
-    /// leb128 value.
+    // FIXME: move these methods to DwarfPrinter when the JIT stops using them.
     static unsigned getSLEB128Size(int Value);
-
-    /// getULEB128Size - Compute the number of bytes required for an unsigned
-    /// leb128 value.
     static unsigned getULEB128Size(unsigned Value);
 
+    bool hasSubsectionsViaSymbols() const { return HasSubsectionsViaSymbols; }
+    
     // Data directive accessors.
     //
     const char *getData8bitsDirective(unsigned AS = 0) const {
@@ -336,6 +306,12 @@ namespace llvm {
       return AS == 0 ? Data64bitsDirective : getDataASDirective(64, AS);
     }
 
+    /// getNonexecutableStackSection - Targets can implement this method to
+    /// specify a section to switch to if the translation unit doesn't have any
+    /// trampolines that require an executable stack.
+    virtual MCSection *getNonexecutableStackSection(MCContext &Ctx) const {
+      return 0;
+    }
     
     bool usesSunStyleELFSectionSwitchSyntax() const {
       return SunStyleELFSectionSwitchSyntax;
@@ -347,11 +323,9 @@ namespace llvm {
 
     // Accessors.
     //
-    const char *getZeroFillDirective() const {
-      return ZeroFillDirective;
-    }
-    const char *getNonexecutableStackDirective() const {
-      return NonexecutableStackDirective;
+    bool hasMachoZeroFillDirective() const { return HasMachoZeroFillDirective; }
+    bool hasStaticCtorDtorReferenceInStaticMode() const {
+      return HasStaticCtorDtorReferenceInStaticMode;
     }
     bool needsSet() const {
       return NeedsSet;
@@ -380,30 +354,6 @@ namespace llvm {
     const char *getLinkerPrivateGlobalPrefix() const {
       return LinkerPrivateGlobalPrefix;
     }
-    const char *getJumpTableSpecialLabelPrefix() const {
-      return JumpTableSpecialLabelPrefix;
-    }
-    const char *getGlobalVarAddrPrefix() const {
-      return GlobalVarAddrPrefix;
-    }
-    const char *getGlobalVarAddrSuffix() const {
-      return GlobalVarAddrSuffix;
-    }
-    const char *getFunctionAddrPrefix() const {
-      return FunctionAddrPrefix;
-    }
-    const char *getFunctionAddrSuffix() const {
-      return FunctionAddrSuffix;
-    }
-    const char *getPersonalityPrefix() const {
-      return PersonalityPrefix;
-    }
-    const char *getPersonalitySuffix() const {
-      return PersonalitySuffix;
-    }
-    bool getNeedsIndirectEncoding() const {
-      return NeedsIndirectEncoding;
-    }
     const char *getInlineAsmStart() const {
       return InlineAsmStart;
     }
@@ -416,12 +366,12 @@ namespace llvm {
     bool doesAllowQuotesInName() const {
       return AllowQuotesInName;
     }
+    bool doesAllowNameToStartWithDigit() const {
+      return AllowNameToStartWithDigit;
+    }
     const char *getZeroDirective() const {
       return ZeroDirective;
     }
-    const char *getZeroDirectiveSuffix() const {
-      return ZeroDirectiveSuffix;
-    }
     const char *getAsciiDirective() const {
       return AsciiDirective;
     }
@@ -449,35 +399,20 @@ namespace llvm {
     const char *getSetDirective() const {
       return SetDirective;
     }
-    const char *getLCOMMDirective() const {
-      return LCOMMDirective;
-    }
-    const char *getCOMMDirective() const {
-      return COMMDirective;
-    }
+    bool hasLCOMMDirective() const { return HasLCOMMDirective; }
     bool getCOMMDirectiveTakesAlignment() const {
       return COMMDirectiveTakesAlignment;
     }
-    bool hasDotTypeDotSizeDirective() const {
-      return HasDotTypeDotSizeDirective;
-    }
-    bool hasSingleParameterDotFile() const {
-      return HasSingleParameterDotFile;
-    }
-    const char *getUsedDirective() const {
-      return UsedDirective;
-    }
-    const char *getWeakRefDirective() const {
-      return WeakRefDirective;
-    }
-    const char *getWeakDefDirective() const {
-      return WeakDefDirective;
-    }
-    const char *getHiddenDirective() const {
-      return HiddenDirective;
-    }
-    const char *getProtectedDirective() const {
-      return ProtectedDirective;
+    bool hasDotTypeDotSizeDirective() const {return HasDotTypeDotSizeDirective;}
+    bool hasSingleParameterDotFile() const { return HasSingleParameterDotFile; }
+    bool hasNoDeadStrip() const { return HasNoDeadStrip; }
+    const char *getWeakRefDirective() const { return WeakRefDirective; }
+    const char *getWeakDefDirective() const { return WeakDefDirective; }
+    const char *getLinkOnceDirective() const { return LinkOnceDirective; }
+    
+    MCSymbolAttr getHiddenVisibilityAttr() const { return HiddenVisibilityAttr;}
+    MCSymbolAttr getProtectedVisibilityAttr() const {
+      return ProtectedVisibilityAttr;
     }
     bool isAbsoluteDebugSectionOffsets() const {
       return AbsoluteDebugSectionOffsets;