//
// 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 file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
//
#define LLVM_CODEGEN_ASMPRINTER_H
#include "llvm/CodeGen/MachineFunctionPass.h"
-#include "llvm/Support/DataTypes.h"
-#include <set>
+#include "llvm/Support/DebugLoc.h"
+#include "llvm/Target/TargetMachine.h"
+#include "llvm/ADT/DenseMap.h"
namespace llvm {
+ class GCStrategy;
class Constant;
class ConstantArray;
+ class ConstantFP;
+ class ConstantInt;
+ class ConstantStruct;
+ class ConstantVector;
+ class GCMetadataPrinter;
+ class GlobalValue;
class GlobalVariable;
+ class MachineBasicBlock;
+ class MachineFunction;
+ class MachineInstr;
+ class MachineLoopInfo;
+ class MachineLoop;
+ class MachineConstantPool;
class MachineConstantPoolEntry;
class MachineConstantPoolValue;
+ class MachineJumpTableInfo;
+ class MachineModuleInfo;
+ class MCInst;
+ class MCContext;
+ class MCSection;
+ class MCStreamer;
+ class DwarfWriter;
class Mangler;
- class TargetAsmInfo;
-
+ class MCAsmInfo;
+ class TargetLoweringObjectFile;
+ class Type;
+ class formatted_raw_ostream;
/// AsmPrinter - This class is intended to be used as a driving class for all
/// asm writers.
class AsmPrinter : public MachineFunctionPass {
+ static char ID;
+
/// 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
///
unsigned FunctionNumber;
+ // GCMetadataPrinters - The garbage collection metadata printer table.
+ typedef DenseMap<GCStrategy*,GCMetadataPrinter*> gcp_map_type;
+ typedef gcp_map_type::iterator gcp_iterator;
+ gcp_map_type GCMetadataPrinters;
+
+ /// If VerboseAsm is set, a pointer to the loop info for this
+ /// function.
+ ///
+ MachineLoopInfo *LI;
+
protected:
- // Necessary for external weak linkage support
- std::set<const GlobalValue*> ExtWeakSymbols;
+ /// MMI - If available, this is a pointer to the current MachineModuleInfo.
+ MachineModuleInfo *MMI;
+
+ /// DW - If available, this is a pointer to the current dwarf writer.
+ DwarfWriter *DW;
public:
/// Output stream on which we're printing assembly code.
///
- std::ostream &O;
+ formatted_raw_ostream &O;
/// Target machine description.
///
TargetMachine &TM;
+ /// getObjFileLowering - Return information about object file lowering.
+ TargetLoweringObjectFile &getObjFileLowering() const;
+
/// Target Asm Printer information.
///
- const TargetAsmInfo *TAI;
+ const MCAsmInfo *MAI;
+
+ /// Target Register Information.
+ ///
+ const TargetRegisterInfo *TRI;
+
+ /// OutContext - This is the context for the output file that we are
+ /// streaming. This owns all of the global MC-related objects for the
+ /// generated translation unit.
+ MCContext &OutContext;
+
+ /// OutStreamer - This is the MCStreamer object for the file we are
+ /// generating. This contains the transient state for the current
+ /// translation unit that we are generating (such as the current section
+ /// etc).
+ MCStreamer &OutStreamer;
+
+ /// The current machine function.
+ const MachineFunction *MF;
/// Name-mangler for global names.
///
///
std::string CurrentFnName;
- /// CurrentSection - The current section we are emitting to. This is
- /// controlled and used by the SwitchSection method.
- std::string CurrentSection;
-
- protected:
- AsmPrinter(std::ostream &o, TargetMachine &TM, const TargetAsmInfo *T);
+ /// getCurrentSection() - Return the current section we are emitting to.
+ const MCSection *getCurrentSection() const;
- public:
- /// SwitchToTextSection - 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.
- ///
- /// This method is used when about to emit executable code.
- ///
- void SwitchToTextSection(const char *NewSection, const GlobalValue *GV = NULL);
- /// SwitchToDataSection - 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.
+ /// VerboseAsm - Emit comments in assembly output if this is true.
///
- /// This method is used when about to emit data. For most assemblers, this
- /// is the same as the SwitchToTextSection method, but not all assemblers
- /// are the same.
+ bool VerboseAsm;
+
+ /// ExuberantAsm - Emit many more comments in assembly output if
+ /// this is true.
///
- void SwitchToDataSection(const char *NewSection, const GlobalValue *GV = NULL);
+ bool ExuberantAsm;
+
+ /// Private state for PrintSpecial()
+ // Assign a unique ID to this machine instruction.
+ mutable const MachineInstr *LastMI;
+ mutable const Function *LastFn;
+ mutable unsigned Counter;
+ // Private state for processDebugLock()
+ mutable DebugLocTuple PrevDLT;
+
+ protected:
+ explicit AsmPrinter(formatted_raw_ostream &o, TargetMachine &TM,
+ const MCAsmInfo *T, bool V);
+
+ public:
+ virtual ~AsmPrinter();
+
+ /// isVerbose - Return true if assembly output should contain comments.
+ ///
+ bool isVerbose() const { return VerboseAsm; }
+
/// getGlobalLinkName - Returns the asm/link name of of the specified
/// global variable. Should be overridden by each target asm printer to
/// generate the appropriate value.
- virtual const std::string getGlobalLinkName(const GlobalVariable *GV) const;
+ virtual const std::string &getGlobalLinkName(const GlobalVariable *GV,
+ std::string &LinkName) const;
/// EmitExternalGlobal - Emit the external reference to a global variable.
/// Should be overridden if an indirect reference should be used.
virtual void EmitExternalGlobal(const GlobalVariable *GV);
+ /// getCurrentFunctionEHName - Called to return the CurrentFnEHName.
+ ///
+ std::string getCurrentFunctionEHName(const MachineFunction *MF) const;
+
protected:
+ /// getAnalysisUsage - Record analysis usage.
+ ///
+ void getAnalysisUsage(AnalysisUsage &AU) const;
+
/// 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.
/// or other bits of target-specific knowledge into the asmstrings. The
/// syntax used is ${:comment}. Targets can override this to add support
/// for their own strange codes.
- virtual void PrintSpecial(const MachineInstr *MI, const char *Code);
+ virtual void PrintSpecial(const MachineInstr *MI, const char *Code) const;
/// PrintAsmOperand - Print the specified operand of MI, an INLINEASM
/// instruction, using the specified assembler variant. Targets should
unsigned AsmVariant,
const char *ExtraCode);
- /// getSectionForFunction - Return the section that we should emit the
- /// specified function body into. This defaults to 'TextSection'. This
- /// should most likely be overridden by the target to put linkonce/weak
- /// functions into special sections.
- virtual std::string getSectionForFunction(const Function &F) const;
-
+ /// PrintGlobalVariable - Emit the specified global variable and its
+ /// initializer to the output stream.
+ virtual void PrintGlobalVariable(const GlobalVariable *GV) = 0;
+
/// SetupMachineFunction - This should be called when a new MachineFunction
/// is being processed from runOnMachineFunction.
void SetupMachineFunction(MachineFunction &MF);
/// special global used by LLVM. If so, emit it and return true, otherwise
/// do nothing and return false.
bool EmitSpecialLLVMGlobal(const GlobalVariable *GV);
-
+
public:
//===------------------------------------------------------------------===//
/// LEB 128 number encoding.
/// representing an unsigned leb128 value.
void PrintULEB128(unsigned Value) const;
- /// SizeULEB128 - Compute the number of bytes required for an unsigned
- /// leb128 value.
- static unsigned SizeULEB128(unsigned Value);
-
/// PrintSLEB128 - Print a series of hexidecimal values(separated by commas)
/// representing a signed leb128 value.
void PrintSLEB128(int Value) const;
- /// SizeSLEB128 - Compute the number of bytes required for a signed leb128
- /// value.
- static unsigned SizeSLEB128(int Value);
-
//===------------------------------------------------------------------===//
// Emission and print routines
//
/// then it will be printed first. Comments should not contain '\n'.
void EOL() const;
void EOL(const std::string &Comment) const;
+ void EOL(const char* Comment) const;
+ void EOL(const std::string &Comment, unsigned DatFormat) const;
+ void EOL(const char* Comment, unsigned DataFormat) const;
/// EmitULEB128Bytes - Emit an assembler byte data directive to compose an
/// unsigned leb128 value.
/// EmitString - Emit a string with quotes and a null terminator.
/// Special characters are emitted properly.
- /// \literal (Eg. '\t') \endliteral
+ /// @verbatim (Eg. '\t') @endverbatim
void EmitString(const std::string &String) const;
-
+ void EmitString(const char *String, unsigned Size) const;
+
+ /// EmitFile - Emit a .file directive.
+ void EmitFile(unsigned Number, const std::string &Name) const;
+
//===------------------------------------------------------------------===//
/// 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
- /// an explicit alignment requested, it will override the alignment request.
- void EmitAlignment(unsigned NumBits, const GlobalValue *GV = 0) const;
+ /// an explicit alignment requested, it will unconditionally override the
+ /// alignment request. However, if ForcedAlignBits is specified, this value
+ /// has final say: the ultimate alignment will be the max of ForcedAlignBits
+ /// and the alignment computed with NumBits and the global. If UseFillExpr
+ /// is true, it also emits an optional second value FillValue which the
+ /// assembler uses to fill gaps to match alignment for text sections if the
+ /// has specified a non-zero fill value.
+ ///
+ /// The algorithm is:
+ /// Align = NumBits;
+ /// if (GV && GV->hasalignment) Align = GV->getalignment();
+ /// Align = std::max(Align, ForcedAlignBits);
+ ///
+ void EmitAlignment(unsigned NumBits, const GlobalValue *GV = 0,
+ unsigned ForcedAlignBits = 0,
+ bool UseFillExpr = true) const;
+
+ /// printLabel - This method prints a local label used by debug and
+ /// exception handling tables.
+ void printLabel(const MachineInstr *MI) const;
+ void printLabel(unsigned Id) const;
+
+ /// printDeclare - This method prints a local variable declaration used by
+ /// debug tables.
+ void printDeclare(const MachineInstr *MI) const;
+
+ /// EmitComments - Pretty-print comments for instructions
+ void EmitComments(const MachineInstr &MI) const;
+ /// EmitComments - Pretty-print comments for instructions
+ void EmitComments(const MCInst &MI) const;
+ /// EmitComments - Pretty-print comments for basic blocks
+ void EmitComments(const MachineBasicBlock &MBB) const;
+
+ /// printMCInst - Print an MCInst for this target.
+ ///
+ /// Note, this is only a temporary hack to allow the MCStreamer to print
+ /// instructions, do not use this function outside of llvm-mc.
+ virtual void printMCInst(const MCInst *MI);
protected:
/// EmitZeros - Emit a block of zeros.
///
- void EmitZeros(uint64_t NumZeros) const;
+ void EmitZeros(uint64_t NumZeros, unsigned AddrSpace = 0) const;
/// EmitString - Emit a zero-byte-terminated string constant.
///
void EmitConstantValueOnly(const Constant *CV);
/// EmitGlobalConstant - Print a general LLVM constant to the .s file.
- ///
- void EmitGlobalConstant(const Constant* CV);
+ void EmitGlobalConstant(const Constant* CV, unsigned AddrSpace = 0);
virtual void EmitMachineConstantPoolValue(MachineConstantPoolValue *MCPV);
+
+ /// processDebugLoc - Processes the debug information of each machine
+ /// instruction's DebugLoc.
+ void processDebugLoc(DebugLoc DL);
/// printInlineAsm - This method formats and prints the specified machine
/// instruction that is an inline asm.
void printInlineAsm(const MachineInstr *MI) const;
-
- /// printLabel - This method prints a local label used by debug and
- /// exception handling tables.
- void printLabel(const MachineInstr *MI) const;
+ /// printImplicitDef - This method prints the specified machine instruction
+ /// that is an implicit def.
+ virtual void printImplicitDef(const MachineInstr *MI) const;
+
/// printBasicBlockLabel - This method prints the label for the specified
/// MachineBasicBlock
virtual void printBasicBlockLabel(const MachineBasicBlock *MBB,
+ bool printAlign = false,
bool printColon = false,
bool printComment = true) const;
- /// printSetLabel - This method prints a set label for the specified
- /// MachineBasicBlock
- void printSetLabel(unsigned uid, const MachineBasicBlock *MBB) const;
- void printSetLabel(unsigned uid, unsigned uid2,
- const MachineBasicBlock *MBB) const;
-
+ /// printPICJumpTableSetLabel - This method prints a set label for the
+ /// specified MachineBasicBlock for a jumptable entry.
+ virtual void printPICJumpTableSetLabel(unsigned uid,
+ const MachineBasicBlock *MBB) const;
+ virtual void printPICJumpTableSetLabel(unsigned uid, unsigned uid2,
+ const MachineBasicBlock *MBB) const;
+ virtual void printPICJumpTableEntry(const MachineJumpTableInfo *MJTI,
+ const MachineBasicBlock *MBB,
+ unsigned uid) const;
+
/// printDataDirective - This method prints the asm directive for the
/// specified type.
- void printDataDirective(const Type *type);
+ void printDataDirective(const Type *type, unsigned AddrSpace = 0);
+
+ /// printVisibility - This prints visibility information about symbol, if
+ /// this is suported by the target.
+ void printVisibility(const std::string& Name, unsigned Visibility) const;
+ /// printOffset - This is just convenient handler for printing offsets.
+ void printOffset(int64_t Offset) const;
+
private:
void EmitLLVMUsedList(Constant *List);
void EmitXXStructorList(Constant *List);
- void EmitConstantPool(unsigned Alignment, const char *Section,
- std::vector<std::pair<MachineConstantPoolEntry,unsigned> > &CP);
-
+ void EmitGlobalConstantStruct(const ConstantStruct* CVS,
+ unsigned AddrSpace);
+ void EmitGlobalConstantArray(const ConstantArray* CVA, unsigned AddrSpace);
+ void EmitGlobalConstantVector(const ConstantVector* CP);
+ void EmitGlobalConstantFP(const ConstantFP* CFP, unsigned AddrSpace);
+ void EmitGlobalConstantLargeInt(const ConstantInt* CI, unsigned AddrSpace);
+ GCMetadataPrinter *GetOrCreateGCPrinter(GCStrategy *C);
};
}
projects / oota-llvm.git / blobdiff