Move the getInlineAsmLength virtual method from TAI to TII, where
[oota-llvm.git] / include / llvm / Target / TargetAsmInfo.h
index e493538c5c503b6299073eff873a0f7fec855ec5..75b3bdf025b99d1ab391d792ac52aa2a41929d34 100644 (file)
 #ifndef LLVM_TARGET_ASM_INFO_H
 #define LLVM_TARGET_ASM_INFO_H
 
-#include "llvm/ADT/DenseMap.h"
-#include "llvm/ADT/StringMap.h"
 #include "llvm/Support/DataTypes.h"
+#include <cassert>
 #include <string>
 
 namespace llvm {
-  // DWARF encoding query type
-  namespace DwarfEncoding {
-    enum Target {
-      Data       = 0,
-      CodeLabels = 1,
-      Functions  = 2
-    };
-  }
-
-  namespace SectionKind {
-    enum Kind {
-      Unknown = 0,      ///< Custom section
-      Text,             ///< Text section
-      Data,             ///< Data section
-      DataRel,          ///< Contains data that has relocations
-      DataRelLocal,     ///< Contains data that has only local relocations
-      BSS,              ///< BSS section
-      ROData,           ///< Readonly data section
-      DataRelRO,        ///< Contains data that is otherwise readonly
-      DataRelROLocal,   ///< Contains r/o data with only local relocations
-      RODataMergeStr,   ///< Readonly data section (mergeable strings)
-      RODataMergeConst, ///< Readonly data section (mergeable constants)
-      SmallData,        ///< Small data section
-      SmallBSS,         ///< Small bss section
-      SmallROData,      ///< Small readonly section
-      ThreadData,       ///< Initialized TLS data objects
-      ThreadBSS         ///< Uninitialized TLS data objects
-    };
-
-    static inline bool isReadOnly(Kind K) {
-      return (K == SectionKind::ROData ||
-              K == SectionKind::RODataMergeConst ||
-              K == SectionKind::RODataMergeStr ||
-              K == SectionKind::SmallROData);
-    }
-
-    static inline bool isBSS(Kind K) {
-      return (K == SectionKind::BSS ||
-              K == SectionKind::SmallBSS);
-    }
-  }
-
-  namespace SectionFlags {
-    const unsigned Invalid    = -1U;
-    const unsigned None       = 0;
-    const unsigned Code       = 1 << 0;  ///< Section contains code
-    const unsigned Writeable  = 1 << 1;  ///< Section is writeable
-    const unsigned BSS        = 1 << 2;  ///< Section contains only zeroes
-    const unsigned Mergeable  = 1 << 3;  ///< Section contains mergeable data
-    const unsigned Strings    = 1 << 4;  ///< Section contains C-type strings
-    const unsigned TLS        = 1 << 5;  ///< Section contains thread-local data
-    const unsigned Debug      = 1 << 6;  ///< Section contains debug data
-    const unsigned Linkonce   = 1 << 7;  ///< Section is linkonce
-    const unsigned Small      = 1 << 8;  ///< Section is small
-    const unsigned TypeFlags  = 0xFF;
-    // Some gap for future flags
-    const unsigned Named      = 1 << 23; ///< Section is named
-    const unsigned EntitySize = 0xFF << 24; ///< Entity size for mergeable stuff
-
-    static inline unsigned getEntitySize(unsigned Flags) {
-      return (Flags >> 24) & 0xFF;
-    }
-
-    static inline unsigned setEntitySize(unsigned Flags, unsigned Size) {
-      return ((Flags & ~EntitySize) | ((Size & 0xFF) << 24));
-    }
-
-    struct KeyInfo {
-      static inline unsigned getEmptyKey() { return Invalid; }
-      static inline unsigned getTombstoneKey() { return Invalid - 1; }
-      static unsigned getHashValue(const unsigned &Key) { return Key; }
-      static bool isEqual(unsigned LHS, unsigned RHS) { return LHS == RHS; }
-      static bool isPod() { return true; }
-    };
-
-    typedef DenseMap<unsigned, std::string, KeyInfo> FlagsStringsMapType;
-  }
-
-  class TargetMachine;
-  class CallInst;
-  class GlobalValue;
-  class Type;
-  class Mangler;
-
-  class Section {
-    friend class TargetAsmInfo;
-    friend class StringMapEntry<Section>;
-    friend class StringMap<Section>;
-
-    std::string Name;
-    unsigned Flags;
-    explicit Section(unsigned F = SectionFlags::Invalid):Flags(F) { }
-
-  public:
-    
-    bool isNamed() const { return Flags & SectionFlags::Named; }
-    unsigned getEntitySize() const { return (Flags >> 24) & 0xFF; }
-
-    const std::string& getName() const { return Name; }
-    unsigned getFlags() const { return Flags; }
-  };
-
+  template <typename T> class SmallVectorImpl;
+  
   /// TargetAsmInfo - This class is intended to be used as a base class for asm
   /// properties and features specific to the target.
   class TargetAsmInfo {
-  private:
-    mutable StringMap<Section> Sections;
-    mutable SectionFlags::FlagsStringsMapType FlagsStrings;
-    void fillDefaultValues();
   protected:
-    /// TM - The current TargetMachine.
-    const TargetMachine &TM;
-
     //===------------------------------------------------------------------===//
     // Properties to be set by the target writer, used to configure asm printer.
     //
 
-    /// TextSection - Section directive for standard text.
-    ///
-    const Section *TextSection;           // Defaults to ".text".
-
-    /// DataSection - Section directive for standard data.
-    ///
-    const Section *DataSection;           // Defaults to ".data".
-
-    /// BSSSection - Section directive for uninitialized data.  Null if this
-    /// target doesn't support a BSS section.
-    ///
-    const char *BSSSection;               // Default to ".bss".
-    const Section *BSSSection_;
-
-    /// ReadOnlySection - This is the directive that is emitted to switch to a
-    /// read-only section for constant data (e.g. data declared const,
-    /// jump tables).
-    const Section *ReadOnlySection;       // Defaults to NULL
-
-    /// SmallDataSection - This is the directive that is emitted to switch to a
-    /// small data section.
-    ///
-    const Section *SmallDataSection;      // Defaults to NULL
-
-    /// SmallBSSSection - This is the directive that is emitted to switch to a
-    /// small bss section.
-    ///
-    const Section *SmallBSSSection;       // Defaults to NULL
-
-    /// SmallRODataSection - This is the directive that is emitted to switch to 
-    /// a small read-only data section.
-    ///
-    const Section *SmallRODataSection;    // Defaults to NULL
-
-    /// TLSDataSection - Section directive for Thread Local data.
-    ///
-    const Section *TLSDataSection;        // Defaults to ".tdata".
-
-    /// TLSBSSSection - Section directive for Thread Local uninitialized data.
-    /// Null if this target doesn't support a BSS section.
-    ///
-    const Section *TLSBSSSection;         // Defaults to ".tbss".
-
     /// 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.
@@ -215,10 +64,22 @@ namespace llvm {
     /// measure inline asm instructions.
     char SeparatorChar;                   // Defaults to ';'
 
+    /// CommentColumn - This indicates the comment num (zero-based) at
+    /// which asm comments should be printed.
+    unsigned CommentColumn;               // Defaults to 60
+
     /// CommentString - This indicates the comment character used by the
     /// assembler.
     const char *CommentString;            // Defaults to "#"
 
+    /// FirstOperandColumn - The output column where the first operand
+    /// should be printed
+    unsigned FirstOperandColumn;          // Defaults to 0 (ignored)
+
+    /// MaxOperandLength - The maximum length of any printed asm
+    /// operand
+    unsigned MaxOperandLength;            // Defaults to 0 (ignored)
+
     /// 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 ""
@@ -228,10 +89,10 @@ namespace llvm {
     /// have names in the .o file.  This is often "." or "L".
     const char *PrivateGlobalPrefix;      // Defaults to "."
     
-    /// LessPrivateGlobalPrefix - This prefix is used for symbols that should
+    /// 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 *LessPrivateGlobalPrefix;      // Defaults to ""
+    const char *LinkerPrivateGlobalPrefix;      // Defaults to ""
     
     /// JumpTableSpecialLabelPrefix - If not null, a extra (dead) label is
     /// emitted before jump tables with the specified prefix.
@@ -245,10 +106,6 @@ namespace llvm {
 
     /// FunctionAddrPrefix/Suffix - If these are nonempty, these strings
     /// will enclose any GlobalVariable that points to a function.
-    /// For example, this is used by the IA64 backend to materialize
-    /// function descriptors, by decorating the ".data8" object with the
-    /// @verbatim @fptr( ) @endverbatim
-    /// link-relocation operator.
     ///
     const char *FunctionAddrPrefix;       // Defaults to ""
     const char *FunctionAddrSuffix;       // Defaults to ""
@@ -272,12 +129,10 @@ namespace llvm {
     /// AssemblerDialect - Which dialect of an assembler variant to use.
     unsigned AssemblerDialect;            // Defaults to 0
 
-    /// StringConstantPrefix - Prefix for FEs to use when generating unnamed
-    /// constant strings.  These names get run through the Mangler later; if
-    /// you want the Mangler not to add the GlobalPrefix as well, 
-    /// use '\1' as the first character.
-    const char *StringConstantPrefix;     // Defaults to ".str"
-
+    /// AllowQuotesInName - This is true if the assembler allows for complex
+    /// symbol names to be surrounded in quotes.  This defaults to false.
+    bool AllowQuotesInName;
+    
     //===--- Data Emission Directives -------------------------------------===//
 
     /// ZeroDirective - this should be set to the directive used to get some
@@ -304,12 +159,10 @@ namespace llvm {
     const char *Data32bitsDirective;      // Defaults to "\t.long\t"
     const char *Data64bitsDirective;      // Defaults to "\t.quad\t"
 
-    /// getASDirective - Targets can override it to provide different data
-    /// directives for various sizes and non-default address spaces.
-    virtual const char *getASDirective(unsigned size, 
-                                       unsigned AS) const {
-      assert (AS > 0 
-              && "Dont know the directives for default addr space");
+    /// 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;
     }
 
@@ -349,41 +202,20 @@ namespace llvm {
     /// section with the section name and this suffix printed.
     const char *SectionEndDirectiveSuffix;// Defaults to null.
     
-    /// ConstantPoolSection - This is the section that we SwitchToSection right
-    /// before emitting the constant pool for a function.
-    const char *ConstantPoolSection;      // Defaults to "\t.section .rodata"
-
-    /// JumpTableDataSection - This is the section that we SwitchToSection right
-    /// before emitting the jump tables for a function when the relocation model
-    /// is not PIC.
-    const char *JumpTableDataSection;     // Defaults to "\t.section .rodata"
-    
     /// JumpTableDirective - if non-null, the directive to emit before a jump
     /// table.
     const char *JumpTableDirective;
 
-    /// CStringSection - If not null, this allows for special handling of
-    /// cstring constants (null terminated string that does not contain any
-    /// other null bytes) on this target. This is commonly supported as
-    /// ".cstring".
-    const char *CStringSection;           // Defaults to NULL
-    const Section *CStringSection_;
-
-    /// StaticCtorsSection - This is the directive that is emitted to switch to
-    /// a section to emit the static constructor list.
-    /// Defaults to "\t.section .ctors,\"aw\",@progbits".
-    const char *StaticCtorsSection;
-
-    /// StaticDtorsSection - This is the directive that is emitted to switch to
-    /// a section to emit the static destructor list.
-    /// Defaults to "\t.section .dtors,\"aw\",@progbits".
-    const char *StaticDtorsSection;
-
     //===--- Global Variable Emission Directives --------------------------===//
     
     /// GlobalDirective - This is the directive used to declare a global entity.
     ///
     const char *GlobalDirective;          // Defaults to NULL.
+
+    /// ExternDirective - This is the directive used to declare external 
+    /// globals.
+    ///
+    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.
@@ -467,13 +299,9 @@ namespace llvm {
     /// encode inline subroutine information.
     bool DwarfUsesInlineInfoSection; // Defaults to false.
 
-    /// SupportsMacInfo - true if the Dwarf output supports macro information
-    ///
-    bool SupportsMacInfoSection;            // Defaults to true
-
-    /// NonLocalEHFrameLabel - If set, the EH_frame label needs to be non-local.
-    ///
-    bool NonLocalEHFrameLabel;              // 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.
 
     /// GlobalEHDirective - This is the directive used to make exception frame
     /// tables globally visible.
@@ -531,150 +359,48 @@ namespace llvm {
     ///
     const char *DwarfRangesSection; // Defaults to ".debug_ranges".
 
-    /// DwarfMacInfoSection - Section directive for Dwarf info.
+    /// DwarfMacroInfoSection - Section directive for DWARF macro info.
     ///
-    const char *DwarfMacInfoSection; // Defaults to ".debug_macinfo".
+    const char *DwarfMacroInfoSection; // Defaults to ".debug_macinfo".
     
     /// DwarfEHFrameSection - Section directive for Exception frames.
     ///
     const char *DwarfEHFrameSection; // Defaults to ".eh_frame".
     
-    /// DwarfExceptionSection - Section directive for Exception table.
-    ///
-    const char *DwarfExceptionSection; // Defaults to ".gcc_except_table".
-
     //===--- CBE Asm Translation Table -----------------------------------===//
 
     const char *const *AsmTransCBE; // Defaults to empty
 
   public:
-    explicit TargetAsmInfo(const TargetMachine &TM);
+    explicit TargetAsmInfo();
     virtual ~TargetAsmInfo();
 
-    const Section* getNamedSection(const char *Name,
-                                   unsigned Flags = SectionFlags::None,
-                                   bool Override = false) const;
-    const Section* getUnnamedSection(const char *Directive,
-                                     unsigned Flags = SectionFlags::None,
-                                     bool Override = false) const;
-
-    /// Measure the specified inline asm to determine an approximation of its
-    /// length.
-    virtual unsigned getInlineAsmLength(const char *Str) const;
-
-    /// ExpandInlineAsm - This hook allows the target to expand an inline asm
-    /// call to be explicit llvm code if it wants to.  This is useful for
-    /// turning simple inline asms into LLVM intrinsics, which gives the
-    /// compiler more information about the behavior of the code.
-    virtual bool ExpandInlineAsm(CallInst *CI) const {
-      return false;
-    }
-
-    /// emitUsedDirectiveFor - This hook allows targets to selectively decide
-    /// not to emit the UsedDirective for some symbols in llvm.used.
-    virtual bool emitUsedDirectiveFor(const GlobalValue *GV,
-                                      Mangler *Mang) const {
-      return (GV!=0);
-    }
-
-    /// PreferredEHDataFormat - This hook allows the target to select data
-    /// format used for encoding pointers in exception handling data. Reason is
-    /// 0 for data, 1 for code labels, 2 for function pointers. Global is true
-    /// if the symbol can be relocated.
-    virtual unsigned PreferredEHDataFormat(DwarfEncoding::Target Reason,
-                                           bool Global) const;
-
-    /// SectionKindForGlobal - This hook allows the target to select proper
-    /// section kind used for global emission.
-    virtual SectionKind::Kind
-    SectionKindForGlobal(const GlobalValue *GV) const;
-
-    /// RelocBehaviour - Describes how relocations should be treated when
-    /// selecting sections. Reloc::Global bit should be set if global
-    /// relocations should force object to be placed in read-write
-    /// sections. Reloc::Local bit should be set if local relocations should
-    /// force object to be placed in read-write sections.
-    virtual unsigned RelocBehaviour() const;
-
-    /// SectionFlagsForGlobal - This hook allows the target to select proper
-    /// section flags either for given global or for section.
-    virtual unsigned
-    SectionFlagsForGlobal(const GlobalValue *GV = NULL,
-                          const char* name = NULL) const;
-
-    /// SectionForGlobal - This hooks returns proper section name for given
-    /// global with all necessary flags and marks.
-    virtual const Section* SectionForGlobal(const GlobalValue *GV) const;
-
-    // Helper methods for SectionForGlobal
-    virtual std::string UniqueSectionForGlobal(const GlobalValue* GV,
-                                               SectionKind::Kind kind) const;
-
-    const std::string& getSectionFlags(unsigned Flags) const;
-    virtual std::string printSectionFlags(unsigned flags) const { return ""; }
-
-    virtual const Section* SelectSectionForGlobal(const GlobalValue *GV) const;
-
-    virtual const Section* SelectSectionForMachineConst(const Type *Ty) const;
-
     /// getSLEB128Size - Compute the number of bytes required for a signed
     /// leb128 value.
-
     static unsigned getSLEB128Size(int Value);
 
     /// getULEB128Size - Compute the number of bytes required for an unsigned
     /// leb128 value.
-
     static unsigned getULEB128Size(unsigned Value);
 
-    // Data directive accessors
+    // Data directive accessors.
     //
     const char *getData8bitsDirective(unsigned AS = 0) const {
-      return AS == 0 ? Data8bitsDirective : getASDirective(8, AS);
+      return AS == 0 ? Data8bitsDirective : getDataASDirective(8, AS);
     }
     const char *getData16bitsDirective(unsigned AS = 0) const {
-      return AS == 0 ? Data16bitsDirective : getASDirective(16, AS);
+      return AS == 0 ? Data16bitsDirective : getDataASDirective(16, AS);
     }
     const char *getData32bitsDirective(unsigned AS = 0) const {
-      return AS == 0 ? Data32bitsDirective : getASDirective(32, AS);
+      return AS == 0 ? Data32bitsDirective : getDataASDirective(32, AS);
     }
     const char *getData64bitsDirective(unsigned AS = 0) const {
-      return AS == 0 ? Data64bitsDirective : getASDirective(64, AS);
+      return AS == 0 ? Data64bitsDirective : getDataASDirective(64, AS);
     }
 
 
     // Accessors.
     //
-    const Section *getTextSection() const {
-      return TextSection;
-    }
-    const Section *getDataSection() const {
-      return DataSection;
-    }
-    const char *getBSSSection() const {
-      return BSSSection;
-    }
-    const Section *getBSSSection_() const {
-      return BSSSection_;
-    }
-    const Section *getReadOnlySection() const {
-      return ReadOnlySection;
-    }
-    const Section *getSmallDataSection() const {
-      return SmallDataSection;
-    }
-    const Section *getSmallBSSSection() const {
-      return SmallBSSSection;
-    }
-    const Section *getSmallRODataSection() const {
-      return SmallRODataSection;
-    }
-    const Section *getTLSDataSection() const {
-      return TLSDataSection;
-    }
-    const Section *getTLSBSSSection() const {
-      return TLSBSSSection;
-    }
     const char *getZeroFillDirective() const {
       return ZeroFillDirective;
     }
@@ -684,29 +410,32 @@ namespace llvm {
     bool needsSet() const {
       return NeedsSet;
     }
+    unsigned getMaxInstLength() const {
+      return MaxInstLength;
+    }
     const char *getPCSymbol() const {
       return PCSymbol;
     }
     char getSeparatorChar() const {
       return SeparatorChar;
     }
+    unsigned getCommentColumn() const {
+      return CommentColumn;
+    }
     const char *getCommentString() const {
       return CommentString;
     }
+    unsigned getOperandColumn(int operand) const {
+      return FirstOperandColumn + (MaxOperandLength+1)*(operand-1);
+    }
     const char *getGlobalPrefix() const {
       return GlobalPrefix;
     }
     const char *getPrivateGlobalPrefix() const {
       return PrivateGlobalPrefix;
     }
-    /// EHGlobalPrefix - Prefix for EH_frame and the .eh symbols.
-    /// This is normally PrivateGlobalPrefix, but some targets want
-    /// these symbols to be visible.
-    virtual const char *getEHGlobalPrefix() const {
-      return PrivateGlobalPrefix;
-    }
-    const char *getLessPrivateGlobalPrefix() const {
-      return LessPrivateGlobalPrefix;
+    const char *getLinkerPrivateGlobalPrefix() const {
+      return LinkerPrivateGlobalPrefix;
     }
     const char *getJumpTableSpecialLabelPrefix() const {
       return JumpTableSpecialLabelPrefix;
@@ -741,8 +470,8 @@ namespace llvm {
     unsigned getAssemblerDialect() const {
       return AssemblerDialect;
     }
-    const char *getStringConstantPrefix() const {
-      return StringConstantPrefix;
+    bool doesAllowQuotesInName() const {
+      return AllowQuotesInName;
     }
     const char *getZeroDirective() const {
       return ZeroDirective;
@@ -780,27 +509,12 @@ namespace llvm {
     const char *getSectionEndDirectiveSuffix() const {
       return SectionEndDirectiveSuffix;
     }
-    const char *getConstantPoolSection() const {
-      return ConstantPoolSection;
-    }
-    const char *getJumpTableDataSection() const {
-      return JumpTableDataSection;
-    }
-    const char *getCStringSection() const {
-      return CStringSection;
-    }
-    const Section *getCStringSection_() const {
-      return CStringSection_;
-    }
-    const char *getStaticCtorsSection() const {
-      return StaticCtorsSection;
-    }
-    const char *getStaticDtorsSection() const {
-      return StaticDtorsSection;
-    }
     const char *getGlobalDirective() const {
       return GlobalDirective;
     }
+    const char *getExternDirective() const {
+      return ExternDirective;
+    }
     const char *getSetDirective() const {
       return SetDirective;
     }
@@ -858,11 +572,8 @@ namespace llvm {
     bool doesDwarfUsesInlineInfoSection() const {
       return DwarfUsesInlineInfoSection;
     }
-    bool doesSupportMacInfoSection() const {
-      return SupportsMacInfoSection;
-    }
-    bool doesRequireNonLocalEHFrameLabel() const {
-      return NonLocalEHFrameLabel;
+    bool is_EHSymbolPrivate() const {
+      return Is_EHSymbolPrivate;
     }
     const char *getGlobalEHDirective() const {
       return GlobalEHDirective;
@@ -906,15 +617,12 @@ namespace llvm {
     const char *getDwarfRangesSection() const {
       return DwarfRangesSection;
     }
-    const char *getDwarfMacInfoSection() const {
-      return DwarfMacInfoSection;
+    const char *getDwarfMacroInfoSection() const {
+      return DwarfMacroInfoSection;
     }
     const char *getDwarfEHFrameSection() const {
       return DwarfEHFrameSection;
     }
-    const char *getDwarfExceptionSection() const {
-      return DwarfExceptionSection;
-    }
     const char *const *getAsmCBE() const {
       return AsmTransCBE;
     }