Move some methods out of MachineInstr into MachineOperand
[oota-llvm.git] / include / llvm / CodeGen / AsmPrinter.h
index b6ed3a5254c6e19fe5ababfe818c3909469a56ab..60bfabf29c375e97738ddada8420c7420745329b 100644 (file)
@@ -21,7 +21,9 @@
 
 namespace llvm {
   class Constant;
+  class ConstantArray;
   class Mangler;
+  class GlobalVariable;
 
   class AsmPrinter : public MachineFunctionPass {
     /// CurrentSection - The current section we are emitting to.  This is
@@ -34,8 +36,8 @@ namespace llvm {
     /// IncrementFunctionNumber().
     ///
     unsigned FunctionNumber;
-    
-  protected:
+
+  public:
     /// Output stream on which we're printing assembly code.
     ///
     std::ostream &O;
@@ -85,6 +87,11 @@ namespace llvm {
     const char *FunctionAddrPrefix;       // Defaults to ""
     const char *FunctionAddrSuffix;       // Defaults to ""
 
+    /// InlineAsmStart/End - If these are nonempty, they contain a directive to
+    /// emit before and after an inline assmebly statement.
+    const char *InlineAsmStart;           // Defaults to "#APP\n"
+    const char *InlineAsmEnd;             // Defaults to "#NO_APP\n"
+    
     //===--- Data Emission Directives -------------------------------------===//
 
     /// ZeroDirective - this should be set to the directive used to get some
@@ -92,6 +99,7 @@ namespace llvm {
     /// "\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 ""
 
     /// AsciiDirective - This directive allows emission of an ascii string with
     /// the standard C escape characters embedded into it.
@@ -129,33 +137,48 @@ namespace llvm {
     /// emit a global to an arbitrary section.  The section name is emited after
     /// this.
     const char *SwitchToSectionDirective;  // Defaults to "\t.section\t"
+    bool MLSections;  // True if Microsoft ML assembler is targetted
     
     /// 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\n"
 
-    AsmPrinter(std::ostream &o, TargetMachine &tm)
-      : FunctionNumber(0), O(o), TM(tm),
-        CommentString("#"),
-        GlobalPrefix(""),
-        PrivateGlobalPrefix("."),
-        GlobalVarAddrPrefix(""),
-        GlobalVarAddrSuffix(""),
-        FunctionAddrPrefix(""),
-        FunctionAddrSuffix(""),
-        ZeroDirective("\t.zero\t"),
-        AsciiDirective("\t.ascii\t"),
-        AscizDirective("\t.asciz\t"),
-        Data8bitsDirective("\t.byte\t"),
-        Data16bitsDirective("\t.short\t"),
-        Data32bitsDirective("\t.long\t"),
-        Data64bitsDirective("\t.quad\t"),
-        AlignDirective("\t.align\t"),
-        AlignmentIsInBytes(true),
-        SwitchToSectionDirective("\t.section\t"),
-        ConstantPoolSection("\t.section .rodata\n") {
-    }
+    /// JumpTableSection - This is the section that we SwitchToSection right
+    /// before emitting the jump tables for a function.
+    const char *JumpTableSection;     // Defaults to "\t.section .rodata\n"
+    
+    /// 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 --------------------------===//
+    
+    /// 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:
+    ///    <LCOMMDirective> SYMBOLNAME LENGTHINBYTES, ALIGNMENT
+    const char *LCOMMDirective;          // Defaults to null.
+    
+    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.
+    
+    /// HasDotTypeDotSizeDirective - True if the target has .type and .size
+    /// directives, this is true for most ELF targets.
+    bool HasDotTypeDotSizeDirective;     // Defaults to true.
+  
+  protected:
+    AsmPrinter(std::ostream &o, TargetMachine &TM);
+    
+  public:
     /// SwitchSection - Switch to the specified section of the executable if we
     /// are not already in it!  If GV is non-null and if the global has an
     /// explicitly requested section, we switch to the section indicated for the
@@ -166,15 +189,11 @@ namespace llvm {
     ///
     void SwitchSection(const char *NewSection, const GlobalValue *GV);
 
-    /// getFunctionNumber - Return a unique ID for the current function.
-    ///
-    unsigned getFunctionNumber() const { return FunctionNumber; }
-    
-    /// IncrementFunctionNumber - Increase Function Number.  AsmPrinters should
-    /// not normally call this, as the counter is automatically bumped by
-    /// SetupMachineFunction.
-    void IncrementFunctionNumber() { FunctionNumber++; }
-    
+    /// getPreferredAlignmentLog - Return the preferred alignment of the
+    /// specified global, returned in log form.  This includes an explicitly
+    /// requested alignment (if the global has one).
+    unsigned getPreferredAlignmentLog(const GlobalVariable *GV) const;
+  protected:
     /// doInitialization - Set up the AsmPrinter when we are working on a new
     /// module.  If your pass overrides this, it must make sure to explicitly
     /// call this implementation.
@@ -184,12 +203,51 @@ namespace llvm {
     /// pass, you must make sure to call it explicitly.
     bool doFinalization(Module &M);
 
+    /// PrintAsmOperand - Print the specified operand of MI, an INLINEASM
+    /// instruction, using the specified assembler variant.  Targets should
+    /// override this to format as appropriate.  This method can return true if
+    /// the operand is erroneous.
+    virtual bool PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
+                                 unsigned AsmVariant, const char *ExtraCode);
+    
+    /// PrintAsmMemoryOperand - Print the specified operand of MI, an INLINEASM
+    /// instruction, using the specified assembler variant as an address.
+    /// Targets should override this to format as appropriate.  This method can
+    /// return true if the operand is erroneous.
+    virtual bool PrintAsmMemoryOperand(const MachineInstr *MI, unsigned OpNo,
+                                       unsigned AsmVariant, 
+                                       const char *ExtraCode);
+    
     /// SetupMachineFunction - This should be called when a new MachineFunction
     /// is being processed from runOnMachineFunction.
     void SetupMachineFunction(MachineFunction &MF);
     
+    /// getFunctionNumber - Return a unique ID for the current function.
+    ///
+    unsigned getFunctionNumber() const { return FunctionNumber; }
+    
+    /// IncrementFunctionNumber - Increase Function Number.  AsmPrinters should
+    /// not normally call this, as the counter is automatically bumped by
+    /// SetupMachineFunction.
+    void IncrementFunctionNumber() { FunctionNumber++; }
+    
+    /// EmitConstantPool - Print to the current output stream assembly
+    /// representations of the constants in the constant pool MCP. This is
+    /// used to print out constants which have been "spilled to memory" by
+    /// the code generator.
+    ///
     void EmitConstantPool(MachineConstantPool *MCP);
 
+    /// EmitJumpTableInfo - Print assembly representations of the jump tables 
+    /// used by the current function to the current output stream.  
+    ///
+    void EmitJumpTableInfo(MachineJumpTableInfo *MJTI);
+    
+    /// EmitSpecialLLVMGlobal - Check to see if the specified global is a
+    /// special global used by LLVM.  If so, emit it and return true, otherwise
+    /// do nothing and return false.
+    bool EmitSpecialLLVMGlobal(const GlobalVariable *GV);
+
     /// EmitAlignment - Emit an alignment directive to the specified power of
     /// two boundary.  For example, if you pass in 3 here, you will get an 8
     /// byte alignment.  If a global value is specified, and if that global has
@@ -200,6 +258,10 @@ namespace llvm {
     ///
     void EmitZeros(uint64_t NumZeros) const;
 
+    /// EmitString - Emit a zero-byte-terminated string constant.
+    ///
+    virtual void EmitString(const ConstantArray *CVA) const;
+
     /// EmitConstantValueOnly - Print out the specified constant, without a
     /// storage class.  Only constants of first-class type are allowed here.
     void EmitConstantValueOnly(const Constant *CV);
@@ -207,6 +269,20 @@ namespace llvm {
     /// EmitGlobalConstant - Print a general LLVM constant to the .s file.
     ///
     void EmitGlobalConstant(const Constant* CV);
+    
+    /// printInlineAsm - This method formats and prints the specified machine
+    /// instruction that is an inline asm.
+    void printInlineAsm(const MachineInstr *MI) const;
+    
+    /// printBasicBlockLabel - This method prints the label for the specified
+    /// MachineBasicBlock
+    virtual void printBasicBlockLabel(const MachineBasicBlock *MBB,
+                                      bool printColon = false,
+                                      bool printComment = true) const;
+    
+  private:
+    void EmitXXStructorList(Constant *List);
+
   };
 }