//===-- llvm/CodeGen/AsmPrinter.h - AsmPrinter Framework --------*- C++ -*-===//
-//
+//
// The LLVM Compiler Infrastructure
//
// This file was developed by the LLVM research group and is distributed under
// the University of Illinois Open Source License. See LICENSE.TXT for details.
-//
+//
//===----------------------------------------------------------------------===//
//
// This class is intended to be used as a base class for target-specific
namespace llvm {
class Constant;
+ class ConstantArray;
class Mangler;
+ class GlobalVariable;
class AsmPrinter : public MachineFunctionPass {
protected:
+ /// CurrentSection - The current section we are emitting to. This is
+ /// controlled and used by the SwitchSection method.
+ std::string CurrentSection;
+
+ private:
+ /// FunctionNumber - This provides a unique ID for each function emitted in
+ /// this translation unit. It is autoincremented by SetupMachineFunction,
+ /// and can be accessed with getFunctionNumber() and
+ /// IncrementFunctionNumber().
+ ///
+ unsigned FunctionNumber;
+
+ public:
/// Output stream on which we're printing assembly code.
///
std::ostream &O;
/// onto all global symbols. This is often used for "_" or ".".
const char *GlobalPrefix; // Defaults to ""
+ /// PrivateGlobalPrefix - This prefix is used for globals like constant
+ /// pool entries that are completely private to the .o file and should not
+ /// have names in the .o file. This is often "." or "L".
+ const char *PrivateGlobalPrefix; // Defaults to "."
+
/// GlobalVarAddrPrefix/Suffix - If these are nonempty, these strings
/// will enclose any GlobalVariable (that isn't a function)
///
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
/// 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
/// AsciiDirective - This directive allows emission of an ascii string with
/// the standard C escape characters embedded into it.
- const char *AsciiDirective;
+ 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"
+
/// 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 *Data32bitsDirective; // Defaults to "\t.long\t"
const char *Data64bitsDirective; // Defaults to "\t.quad\t"
+ //===--- Alignment Information ----------------------------------------===//
+
/// AlignDirective - The directive used to emit round up to an alignment
/// boundary.
///
/// Otherwise, it emits ".align log2(N)", e.g. 3 to align to an 8 byte
/// boundary.
bool AlignmentIsInBytes; // Defaults to true
+
+ //===--- Section Switching Directives ---------------------------------===//
+
+ /// SwitchToSectionDirective - This is the directive used when we want to
+ /// emit a global to an arbitrary section. The section name is emited after
+ /// this.
+ const char *SwitchToSectionDirective; // Defaults to "\t.section\t"
+
+ /// 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)
- : O(o), TM(tm),
- CommentString("#"),
- GlobalPrefix(""),
- GlobalVarAddrPrefix(""),
- GlobalVarAddrSuffix(""),
- FunctionAddrPrefix(""),
- FunctionAddrSuffix(""),
- ZeroDirective("\t.zero\t"),
- AsciiDirective("\t.ascii\t"),
- Data8bitsDirective("\t.byte\t"),
- Data16bitsDirective("\t.short\t"),
- Data32bitsDirective("\t.long\t"),
- Data64bitsDirective("\t.quad\t"),
- AlignDirective("\t.align\t"),
- AlignmentIsInBytes(true) {
- }
+ /// 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
+ /// global instead of NewSection.
+ ///
+ /// If the new section is an empty string, this method forgets what the
+ /// current section is, but does not emit a .section directive.
+ ///
+ virtual void SwitchSection(const char *NewSection, const GlobalValue *GV);
+
+ /// 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.
/// pass, you must make sure to call it explicitly.
bool doFinalization(Module &M);
- /// setupMachineFunction - This should be called when a new MachineFunction
+ /// 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);
+ 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);
- /// emitAlignment - Emit an alignment directive to the specified power of
+ /// 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.
- void emitAlignment(unsigned NumBits) const;
+ /// byte alignment. If a global value is specified, and if that global has
+ /// an explicit alignment requested, it will override the alignment request.
+ void EmitAlignment(unsigned NumBits, const GlobalValue *GV = 0) const;
+
+ /// EmitZeros - Emit a block of zeros.
+ ///
+ virtual void EmitZeros(uint64_t NumZeros) const;
- /// emitZeros - Emit a block of zeros.
+ /// EmitString - Emit a zero-byte-terminated string constant.
///
- void emitZeros(uint64_t NumZeros) const;
+ virtual void EmitString(const ConstantArray *CVA) const;
- /// emitConstantValueOnly - Print out the specified constant, without a
+ /// EmitConstantValueOnly - Print out the specified constant, without a
/// storage class. Only constants of first-class type are allowed here.
- void emitConstantValueOnly(const Constant *CV);
+ void EmitConstantValueOnly(const Constant *CV);
- /// emitGlobalConstant - Print a general LLVM constant to the .s file.
+ /// EmitGlobalConstant - Print a general LLVM constant to the .s file.
///
- void emitGlobalConstant(const Constant* CV);
+ 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) const;
+
+ private:
+ void EmitXXStructorList(Constant *List);
+
};
}
projects / oota-llvm.git / blobdiff