AsmPrinter.h revision af76e592c7f9deff0e55c13dbb4a34f07f1c7f64
1a80ba71efe5be5012128e2db0dd29b024e00105aChris Lattner//===-- llvm/CodeGen/AsmPrinter.h - AsmPrinter Framework --------*- C++ -*-===// 2ea61c358720aa6c7a159d51658b34276316aa841Misha Brukman// 3a80ba71efe5be5012128e2db0dd29b024e00105aChris Lattner// The LLVM Compiler Infrastructure 4a80ba71efe5be5012128e2db0dd29b024e00105aChris Lattner// 57ed47a13356daed2a34cd2209a31f92552e3bdd8Chris Lattner// This file is distributed under the University of Illinois Open Source 67ed47a13356daed2a34cd2209a31f92552e3bdd8Chris Lattner// License. See LICENSE.TXT for details. 7ea61c358720aa6c7a159d51658b34276316aa841Misha Brukman// 8a80ba71efe5be5012128e2db0dd29b024e00105aChris Lattner//===----------------------------------------------------------------------===// 9a80ba71efe5be5012128e2db0dd29b024e00105aChris Lattner// 10563321a2582851c653d0863e8e0bba3d483734f9Jim Laskey// This file contains a class to be used as the base class for target specific 11563321a2582851c653d0863e8e0bba3d483734f9Jim Laskey// asm writers. This class primarily handles common functionality used by 12563321a2582851c653d0863e8e0bba3d483734f9Jim Laskey// all asm writers. 13a80ba71efe5be5012128e2db0dd29b024e00105aChris Lattner// 14a80ba71efe5be5012128e2db0dd29b024e00105aChris Lattner//===----------------------------------------------------------------------===// 15a80ba71efe5be5012128e2db0dd29b024e00105aChris Lattner 16a80ba71efe5be5012128e2db0dd29b024e00105aChris Lattner#ifndef LLVM_CODEGEN_ASMPRINTER_H 17a80ba71efe5be5012128e2db0dd29b024e00105aChris Lattner#define LLVM_CODEGEN_ASMPRINTER_H 18a80ba71efe5be5012128e2db0dd29b024e00105aChris Lattner 19a80ba71efe5be5012128e2db0dd29b024e00105aChris Lattner#include "llvm/CodeGen/MachineFunctionPass.h" 20fe37ab335be5632eab561d49984c95cb06b946d4David Greene#include "llvm/Support/DebugLoc.h" 2198a366d547772010e94609e4584489b3e5ce0043Bill Wendling#include "llvm/Target/TargetMachine.h" 22dd061f6085e7492089befa7ed88dd0669ccb049aChris Lattner#include "llvm/ADT/DenseMap.h" 23a80ba71efe5be5012128e2db0dd29b024e00105aChris Lattner 24a80ba71efe5be5012128e2db0dd29b024e00105aChris Lattnernamespace llvm { 255eca075b74d62c621b160aa216b4cd50829a2cc7Gordon Henriksen class GCStrategy; 26a80ba71efe5be5012128e2db0dd29b024e00105aChris Lattner class Constant; 27c884db47f1a1d5449b749e6528292451e49025e4Jeff Cohen class ConstantArray; 28fe37ab335be5632eab561d49984c95cb06b946d4David Greene class ConstantFP; 2900d448a341175556ebd86af68219f5b90b7145a3Dan Gohman class ConstantInt; 3000d448a341175556ebd86af68219f5b90b7145a3Dan Gohman class ConstantStruct; 3100d448a341175556ebd86af68219f5b90b7145a3Dan Gohman class ConstantVector; 32c317a60c2714a5b90700a11ba646285cb754a5d3Gordon Henriksen class GCMetadataPrinter; 33fe37ab335be5632eab561d49984c95cb06b946d4David Greene class GlobalValue; 34ed13893ff729bc3b91697f6d80a3ba303782efccChris Lattner class GlobalVariable; 35fe37ab335be5632eab561d49984c95cb06b946d4David Greene class MachineBasicBlock; 36fe37ab335be5632eab561d49984c95cb06b946d4David Greene class MachineFunction; 37fe37ab335be5632eab561d49984c95cb06b946d4David Greene class MachineInstr; 38b71d1b2fe2c0673005283b48be2f37c750ce367bDavid Greene class MachineLoopInfo; 39b71d1b2fe2c0673005283b48be2f37c750ce367bDavid Greene class MachineLoop; 40fe37ab335be5632eab561d49984c95cb06b946d4David Greene class MachineConstantPool; 412d2cec1e9e93a388bd8448f4bad661ac89a49de3Evan Cheng class MachineConstantPoolEntry; 42d6594ae54cfde4db4d30272192645c0a45fb9902Evan Cheng class MachineConstantPoolValue; 43fe37ab335be5632eab561d49984c95cb06b946d4David Greene class MachineJumpTableInfo; 440de1fc4f416b3e94749ca84cdaede55b040a8b60Chris Lattner class MachineModuleInfo; 45014700c1a8cba203fd21ff129426ba8a426ab244David Greene class MCInst; 462b2954f00ba02ca1a902f47080cd9f06aebc0378Chris Lattner class MCContext; 47a87dea4f8c546ca748f1777a8d1cabcc06515d91Chris Lattner class MCSection; 482b2954f00ba02ca1a902f47080cd9f06aebc0378Chris Lattner class MCStreamer; 49c48c550e1322aebfbe35c7570891619db43bdb9bDevang Patel class DwarfWriter; 50563321a2582851c653d0863e8e0bba3d483734f9Jim Laskey class Mangler; 51af76e592c7f9deff0e55c13dbb4a34f07f1c7f64Chris Lattner class MCAsmInfo; 52f0144127b98425d214e59e4a1a4b342b78e3642bChris Lattner class TargetLoweringObjectFile; 5384bc5427d6883f73cfeae3da640acd011d35c006Chris Lattner class Type; 5471847813bc419f7a0667468136a07429c6d9f164David Greene class formatted_raw_ostream; 55a80ba71efe5be5012128e2db0dd29b024e00105aChris Lattner 56563321a2582851c653d0863e8e0bba3d483734f9Jim Laskey /// AsmPrinter - This class is intended to be used as a driving class for all 57563321a2582851c653d0863e8e0bba3d483734f9Jim Laskey /// asm writers. 58a80ba71efe5be5012128e2db0dd29b024e00105aChris Lattner class AsmPrinter : public MachineFunctionPass { 591997473cf72957d0e70322e2fe6fe2ab141c58a6Devang Patel static char ID; 60794fd75c67a2cdc128d67342c6d88a504d186896Devang Patel 61347d39f1fd8ad825a7ec5b8a3dce816723a56d42Evan Cheng /// FunctionNumber - This provides a unique ID for each function emitted in 62347d39f1fd8ad825a7ec5b8a3dce816723a56d42Evan Cheng /// this translation unit. It is autoincremented by SetupMachineFunction, 63347d39f1fd8ad825a7ec5b8a3dce816723a56d42Evan Cheng /// and can be accessed with getFunctionNumber() and 64347d39f1fd8ad825a7ec5b8a3dce816723a56d42Evan Cheng /// IncrementFunctionNumber(). 65347d39f1fd8ad825a7ec5b8a3dce816723a56d42Evan Cheng /// 66347d39f1fd8ad825a7ec5b8a3dce816723a56d42Evan Cheng unsigned FunctionNumber; 67347d39f1fd8ad825a7ec5b8a3dce816723a56d42Evan Cheng 68c317a60c2714a5b90700a11ba646285cb754a5d3Gordon Henriksen // GCMetadataPrinters - The garbage collection metadata printer table. 695eca075b74d62c621b160aa216b4cd50829a2cc7Gordon Henriksen typedef DenseMap<GCStrategy*,GCMetadataPrinter*> gcp_map_type; 70c317a60c2714a5b90700a11ba646285cb754a5d3Gordon Henriksen typedef gcp_map_type::iterator gcp_iterator; 71c317a60c2714a5b90700a11ba646285cb754a5d3Gordon Henriksen gcp_map_type GCMetadataPrinters; 7267e59834fc1dca7e357c40af2e5144f3d62f5133David Greene 732d320867494351031216d76c5b3e6a2789461881Chris Lattner /// If VerboseAsm is set, a pointer to the loop info for this 74b71d1b2fe2c0673005283b48be2f37c750ce367bDavid Greene /// function. 75b71d1b2fe2c0673005283b48be2f37c750ce367bDavid Greene /// 76b71d1b2fe2c0673005283b48be2f37c750ce367bDavid Greene MachineLoopInfo *LI; 77b71d1b2fe2c0673005283b48be2f37c750ce367bDavid Greene 7815404d060ba8b604c03b9223a0f2e2abcd0fddedRafael Espindola protected: 790de1fc4f416b3e94749ca84cdaede55b040a8b60Chris Lattner /// MMI - If available, this is a pointer to the current MachineModuleInfo. 800de1fc4f416b3e94749ca84cdaede55b040a8b60Chris Lattner MachineModuleInfo *MMI; 810de1fc4f416b3e94749ca84cdaede55b040a8b60Chris Lattner 820de1fc4f416b3e94749ca84cdaede55b040a8b60Chris Lattner /// DW - If available, this is a pointer to the current dwarf writer. 83cb819f13d785ff6efcacfbd7d0fa9f3f67e5494dBill Wendling DwarfWriter *DW; 84014700c1a8cba203fd21ff129426ba8a426ab244David Greene 85b2efb853f00d45b1c8d57f92acd0028fbdeffda6Jim Laskey public: 86a80ba71efe5be5012128e2db0dd29b024e00105aChris Lattner /// Output stream on which we're printing assembly code. 87a80ba71efe5be5012128e2db0dd29b024e00105aChris Lattner /// 8871847813bc419f7a0667468136a07429c6d9f164David Greene formatted_raw_ostream &O; 89a80ba71efe5be5012128e2db0dd29b024e00105aChris Lattner 90a80ba71efe5be5012128e2db0dd29b024e00105aChris Lattner /// Target machine description. 91a80ba71efe5be5012128e2db0dd29b024e00105aChris Lattner /// 92a80ba71efe5be5012128e2db0dd29b024e00105aChris Lattner TargetMachine &TM; 93563321a2582851c653d0863e8e0bba3d483734f9Jim Laskey 94f0144127b98425d214e59e4a1a4b342b78e3642bChris Lattner /// getObjFileLowering - Return information about object file lowering. 9538c398808cff7defdf013fa750dfac8e66302975Chris Lattner TargetLoweringObjectFile &getObjFileLowering() const; 96f0144127b98425d214e59e4a1a4b342b78e3642bChris Lattner 97563321a2582851c653d0863e8e0bba3d483734f9Jim Laskey /// Target Asm Printer information. 98563321a2582851c653d0863e8e0bba3d483734f9Jim Laskey /// 99af76e592c7f9deff0e55c13dbb4a34f07f1c7f64Chris Lattner const MCAsmInfo *TAI; 100a80ba71efe5be5012128e2db0dd29b024e00105aChris Lattner 101da47e6e0d003c873da960361549e57ee4617c301Evan Cheng /// Target Register Information. 102da47e6e0d003c873da960361549e57ee4617c301Evan Cheng /// 103da47e6e0d003c873da960361549e57ee4617c301Evan Cheng const TargetRegisterInfo *TRI; 104da47e6e0d003c873da960361549e57ee4617c301Evan Cheng 1052b2954f00ba02ca1a902f47080cd9f06aebc0378Chris Lattner /// OutContext - This is the context for the output file that we are 1062b2954f00ba02ca1a902f47080cd9f06aebc0378Chris Lattner /// streaming. This owns all of the global MC-related objects for the 1072b2954f00ba02ca1a902f47080cd9f06aebc0378Chris Lattner /// generated translation unit. 1082b2954f00ba02ca1a902f47080cd9f06aebc0378Chris Lattner MCContext &OutContext; 1092b2954f00ba02ca1a902f47080cd9f06aebc0378Chris Lattner 1102b2954f00ba02ca1a902f47080cd9f06aebc0378Chris Lattner /// OutStreamer - This is the MCStreamer object for the file we are 1112b2954f00ba02ca1a902f47080cd9f06aebc0378Chris Lattner /// generating. This contains the transient state for the current 1122b2954f00ba02ca1a902f47080cd9f06aebc0378Chris Lattner /// translation unit that we are generating (such as the current section 1132b2954f00ba02ca1a902f47080cd9f06aebc0378Chris Lattner /// etc). 1142b2954f00ba02ca1a902f47080cd9f06aebc0378Chris Lattner MCStreamer &OutStreamer; 1152b2954f00ba02ca1a902f47080cd9f06aebc0378Chris Lattner 11657f0db833dc30404f1f5d28b23df326e520698ecBill Wendling /// The current machine function. 11757f0db833dc30404f1f5d28b23df326e520698ecBill Wendling const MachineFunction *MF; 11857f0db833dc30404f1f5d28b23df326e520698ecBill Wendling 119a80ba71efe5be5012128e2db0dd29b024e00105aChris Lattner /// Name-mangler for global names. 120a80ba71efe5be5012128e2db0dd29b024e00105aChris Lattner /// 121a80ba71efe5be5012128e2db0dd29b024e00105aChris Lattner Mangler *Mang; 122a80ba71efe5be5012128e2db0dd29b024e00105aChris Lattner 123a80ba71efe5be5012128e2db0dd29b024e00105aChris Lattner /// Cache of mangled name for current function. This is recalculated at the 124a80ba71efe5be5012128e2db0dd29b024e00105aChris Lattner /// beginning of each call to runOnMachineFunction(). 125a80ba71efe5be5012128e2db0dd29b024e00105aChris Lattner /// 126a80ba71efe5be5012128e2db0dd29b024e00105aChris Lattner std::string CurrentFnName; 12797e32e3239c0f065698f8c004b2b3009162f5ed6Chris Lattner 128290c2f56ce551ebcf4480ac2944986fe4bb339e9Chris Lattner /// getCurrentSection() - Return the current section we are emitting to. 129dabf07c70a5e13a4560d75667fa5c7db28921a92Chris Lattner const MCSection *getCurrentSection() const; 130290c2f56ce551ebcf4480ac2944986fe4bb339e9Chris Lattner 13142bf74be1402df7409efbea089310d4c276fde37Evan Cheng 13242bf74be1402df7409efbea089310d4c276fde37Evan Cheng /// VerboseAsm - Emit comments in assembly output if this is true. 13342bf74be1402df7409efbea089310d4c276fde37Evan Cheng /// 13442bf74be1402df7409efbea089310d4c276fde37Evan Cheng bool VerboseAsm; 13542bf74be1402df7409efbea089310d4c276fde37Evan Cheng 136b71d1b2fe2c0673005283b48be2f37c750ce367bDavid Greene /// ExuberantAsm - Emit many more comments in assembly output if 137b71d1b2fe2c0673005283b48be2f37c750ce367bDavid Greene /// this is true. 138b71d1b2fe2c0673005283b48be2f37c750ce367bDavid Greene /// 139b71d1b2fe2c0673005283b48be2f37c750ce367bDavid Greene bool ExuberantAsm; 140b71d1b2fe2c0673005283b48be2f37c750ce367bDavid Greene 141bd58edf59128d2acb5ae48c76ef8a108fd587db2Owen Anderson /// Private state for PrintSpecial() 142bd58edf59128d2acb5ae48c76ef8a108fd587db2Owen Anderson // Assign a unique ID to this machine instruction. 143bd58edf59128d2acb5ae48c76ef8a108fd587db2Owen Anderson mutable const MachineInstr *LastMI; 144bd58edf59128d2acb5ae48c76ef8a108fd587db2Owen Anderson mutable const Function *LastFn; 145bd58edf59128d2acb5ae48c76ef8a108fd587db2Owen Anderson mutable unsigned Counter; 146a8dbf36f3f88917b101d7ab9d253ba2fe6e396b4Owen Anderson 147a8dbf36f3f88917b101d7ab9d253ba2fe6e396b4Owen Anderson // Private state for processDebugLock() 148a8dbf36f3f88917b101d7ab9d253ba2fe6e396b4Owen Anderson mutable DebugLocTuple PrevDLT; 149bd58edf59128d2acb5ae48c76ef8a108fd587db2Owen Anderson 150b2efb853f00d45b1c8d57f92acd0028fbdeffda6Jim Laskey protected: 15171847813bc419f7a0667468136a07429c6d9f164David Greene explicit AsmPrinter(formatted_raw_ostream &o, TargetMachine &TM, 152af76e592c7f9deff0e55c13dbb4a34f07f1c7f64Chris Lattner const MCAsmInfo *T, bool V); 153ed13893ff729bc3b91697f6d80a3ba303782efccChris Lattner 154a7cea6f599418a579ab5ce66413fba7efa8bf581Jim Laskey public: 155c317a60c2714a5b90700a11ba646285cb754a5d3Gordon Henriksen virtual ~AsmPrinter(); 15642bf74be1402df7409efbea089310d4c276fde37Evan Cheng 15742bf74be1402df7409efbea089310d4c276fde37Evan Cheng /// isVerbose - Return true if assembly output should contain comments. 15842bf74be1402df7409efbea089310d4c276fde37Evan Cheng /// 15942bf74be1402df7409efbea089310d4c276fde37Evan Cheng bool isVerbose() const { return VerboseAsm; } 16042bf74be1402df7409efbea089310d4c276fde37Evan Cheng 161a1a19f803c8fef05db627a8b73c909a50306e9d6Jim Laskey /// getGlobalLinkName - Returns the asm/link name of of the specified 162a1a19f803c8fef05db627a8b73c909a50306e9d6Jim Laskey /// global variable. Should be overridden by each target asm printer to 163a1a19f803c8fef05db627a8b73c909a50306e9d6Jim Laskey /// generate the appropriate value. 1647d16e85bfc2c6423c81ce87a177bf3b1b1012a04Bill Wendling virtual const std::string &getGlobalLinkName(const GlobalVariable *GV, 1657d16e85bfc2c6423c81ce87a177bf3b1b1012a04Bill Wendling std::string &LinkName) const; 166a1a19f803c8fef05db627a8b73c909a50306e9d6Jim Laskey 167bda9b0ec7bd6974cebf751ecd23c5434b34054e9Jim Laskey /// EmitExternalGlobal - Emit the external reference to a global variable. 168bda9b0ec7bd6974cebf751ecd23c5434b34054e9Jim Laskey /// Should be overridden if an indirect reference should be used. 169bda9b0ec7bd6974cebf751ecd23c5434b34054e9Jim Laskey virtual void EmitExternalGlobal(const GlobalVariable *GV); 170bda9b0ec7bd6974cebf751ecd23c5434b34054e9Jim Laskey 171e2cf37b88c089a71727b3ecd466856f0cd638813Chris Lattner /// getCurrentFunctionEHName - Called to return the CurrentFnEHName. 1726e19896999f9297db38e1a1a66d9bef0e2f09776Bill Wendling /// 173e2cf37b88c089a71727b3ecd466856f0cd638813Chris Lattner std::string getCurrentFunctionEHName(const MachineFunction *MF) const; 1746e19896999f9297db38e1a1a66d9bef0e2f09776Bill Wendling 175a7cea6f599418a579ab5ce66413fba7efa8bf581Jim Laskey protected: 176ce2247755e56f99a2377b64a1a9d393726582b85Gordon Henriksen /// getAnalysisUsage - Record analysis usage. 177ce2247755e56f99a2377b64a1a9d393726582b85Gordon Henriksen /// 178ce2247755e56f99a2377b64a1a9d393726582b85Gordon Henriksen void getAnalysisUsage(AnalysisUsage &AU) const; 179ce2247755e56f99a2377b64a1a9d393726582b85Gordon Henriksen 180a80ba71efe5be5012128e2db0dd29b024e00105aChris Lattner /// doInitialization - Set up the AsmPrinter when we are working on a new 181a80ba71efe5be5012128e2db0dd29b024e00105aChris Lattner /// module. If your pass overrides this, it must make sure to explicitly 182a80ba71efe5be5012128e2db0dd29b024e00105aChris Lattner /// call this implementation. 183a80ba71efe5be5012128e2db0dd29b024e00105aChris Lattner bool doInitialization(Module &M); 184a80ba71efe5be5012128e2db0dd29b024e00105aChris Lattner 185a80ba71efe5be5012128e2db0dd29b024e00105aChris Lattner /// doFinalization - Shut down the asmprinter. If you override this in your 186a80ba71efe5be5012128e2db0dd29b024e00105aChris Lattner /// pass, you must make sure to call it explicitly. 187a80ba71efe5be5012128e2db0dd29b024e00105aChris Lattner bool doFinalization(Module &M); 1883ce9b67e0c0f171c6d09c19407930ce6989f1b9dChris Lattner 1893ce9b67e0c0f171c6d09c19407930ce6989f1b9dChris Lattner /// PrintSpecial - Print information related to the specified machine instr 1903ce9b67e0c0f171c6d09c19407930ce6989f1b9dChris Lattner /// that is independent of the operand, and may be independent of the instr 1913ce9b67e0c0f171c6d09c19407930ce6989f1b9dChris Lattner /// itself. This can be useful for portably encoding the comment character 1923ce9b67e0c0f171c6d09c19407930ce6989f1b9dChris Lattner /// or other bits of target-specific knowledge into the asmstrings. The 1933ce9b67e0c0f171c6d09c19407930ce6989f1b9dChris Lattner /// syntax used is ${:comment}. Targets can override this to add support 1943ce9b67e0c0f171c6d09c19407930ce6989f1b9dChris Lattner /// for their own strange codes. 1953e0cc2634e861b789850b5103efcc8898bf14c4cChris Lattner virtual void PrintSpecial(const MachineInstr *MI, const char *Code) const; 19647cf4eda9faa3c0b063337d0eb4ea83aba8cb329Chris Lattner 19747cf4eda9faa3c0b063337d0eb4ea83aba8cb329Chris Lattner /// PrintAsmOperand - Print the specified operand of MI, an INLINEASM 19847cf4eda9faa3c0b063337d0eb4ea83aba8cb329Chris Lattner /// instruction, using the specified assembler variant. Targets should 199b44b5094110508e2381615b15077b388364f7e8aChris Lattner /// override this to format as appropriate. This method can return true if 20047cf4eda9faa3c0b063337d0eb4ea83aba8cb329Chris Lattner /// the operand is erroneous. 20147cf4eda9faa3c0b063337d0eb4ea83aba8cb329Chris Lattner virtual bool PrintAsmOperand(const MachineInstr *MI, unsigned OpNo, 202f483e58212d018f8b2ec760f59089e72defab5cfChris Lattner unsigned AsmVariant, const char *ExtraCode); 203b2efb853f00d45b1c8d57f92acd0028fbdeffda6Jim Laskey 204b44b5094110508e2381615b15077b388364f7e8aChris Lattner /// PrintAsmMemoryOperand - Print the specified operand of MI, an INLINEASM 205b44b5094110508e2381615b15077b388364f7e8aChris Lattner /// instruction, using the specified assembler variant as an address. 206b44b5094110508e2381615b15077b388364f7e8aChris Lattner /// Targets should override this to format as appropriate. This method can 207b44b5094110508e2381615b15077b388364f7e8aChris Lattner /// return true if the operand is erroneous. 208b44b5094110508e2381615b15077b388364f7e8aChris Lattner virtual bool PrintAsmMemoryOperand(const MachineInstr *MI, unsigned OpNo, 209b44b5094110508e2381615b15077b388364f7e8aChris Lattner unsigned AsmVariant, 210b44b5094110508e2381615b15077b388364f7e8aChris Lattner const char *ExtraCode); 211b44b5094110508e2381615b15077b388364f7e8aChris Lattner 21240bbebde9d250b875a47a688d0c6552834ada48fChris Lattner /// PrintGlobalVariable - Emit the specified global variable and its 21340bbebde9d250b875a47a688d0c6552834ada48fChris Lattner /// initializer to the output stream. 21440bbebde9d250b875a47a688d0c6552834ada48fChris Lattner virtual void PrintGlobalVariable(const GlobalVariable *GV) = 0; 215bef8768bd0576eec0470a80e3039cd5d1fd50c6bDavid Greene 2166fe3acce749ee2b3714009064626f6c53b06dfb4Chris Lattner /// SetupMachineFunction - This should be called when a new MachineFunction 217a80ba71efe5be5012128e2db0dd29b024e00105aChris Lattner /// is being processed from runOnMachineFunction. 2186fe3acce749ee2b3714009064626f6c53b06dfb4Chris Lattner void SetupMachineFunction(MachineFunction &MF); 21997e32e3239c0f065698f8c004b2b3009162f5ed6Chris Lattner 220347d39f1fd8ad825a7ec5b8a3dce816723a56d42Evan Cheng /// getFunctionNumber - Return a unique ID for the current function. 221347d39f1fd8ad825a7ec5b8a3dce816723a56d42Evan Cheng /// 222347d39f1fd8ad825a7ec5b8a3dce816723a56d42Evan Cheng unsigned getFunctionNumber() const { return FunctionNumber; } 223347d39f1fd8ad825a7ec5b8a3dce816723a56d42Evan Cheng 224347d39f1fd8ad825a7ec5b8a3dce816723a56d42Evan Cheng /// IncrementFunctionNumber - Increase Function Number. AsmPrinters should 225347d39f1fd8ad825a7ec5b8a3dce816723a56d42Evan Cheng /// not normally call this, as the counter is automatically bumped by 226347d39f1fd8ad825a7ec5b8a3dce816723a56d42Evan Cheng /// SetupMachineFunction. 227347d39f1fd8ad825a7ec5b8a3dce816723a56d42Evan Cheng void IncrementFunctionNumber() { FunctionNumber++; } 228347d39f1fd8ad825a7ec5b8a3dce816723a56d42Evan Cheng 229ed13893ff729bc3b91697f6d80a3ba303782efccChris Lattner /// EmitConstantPool - Print to the current output stream assembly 230ed13893ff729bc3b91697f6d80a3ba303782efccChris Lattner /// representations of the constants in the constant pool MCP. This is 231ed13893ff729bc3b91697f6d80a3ba303782efccChris Lattner /// used to print out constants which have been "spilled to memory" by 232ed13893ff729bc3b91697f6d80a3ba303782efccChris Lattner /// the code generator. 233ed13893ff729bc3b91697f6d80a3ba303782efccChris Lattner /// 2342d2cec1e9e93a388bd8448f4bad661ac89a49de3Evan Cheng void EmitConstantPool(MachineConstantPool *MCP); 235a80ba71efe5be5012128e2db0dd29b024e00105aChris Lattner 23637efe6764568a3829fee26aba532283131d1a104Nate Begeman /// EmitJumpTableInfo - Print assembly representations of the jump tables 23737efe6764568a3829fee26aba532283131d1a104Nate Begeman /// used by the current function to the current output stream. 23837efe6764568a3829fee26aba532283131d1a104Nate Begeman /// 2391da31ee472b9615d7329c656e2cc17c419ed7c95Chris Lattner void EmitJumpTableInfo(MachineJumpTableInfo *MJTI, MachineFunction &MF); 24037efe6764568a3829fee26aba532283131d1a104Nate Begeman 241ed13893ff729bc3b91697f6d80a3ba303782efccChris Lattner /// EmitSpecialLLVMGlobal - Check to see if the specified global is a 242ed13893ff729bc3b91697f6d80a3ba303782efccChris Lattner /// special global used by LLVM. If so, emit it and return true, otherwise 243ed13893ff729bc3b91697f6d80a3ba303782efccChris Lattner /// do nothing and return false. 244ed13893ff729bc3b91697f6d80a3ba303782efccChris Lattner bool EmitSpecialLLVMGlobal(const GlobalVariable *GV); 24587370b8301fa39ee54bdcaae0618fd565e808466Devang Patel 246f9e56198a39a08272c072211722b3c97ef88853cJim Laskey public: 247f1cdea1d021068f5c9e118d68321ce28fcea63faJim Laskey //===------------------------------------------------------------------===// 248f1cdea1d021068f5c9e118d68321ce28fcea63faJim Laskey /// LEB 128 number encoding. 249f1cdea1d021068f5c9e118d68321ce28fcea63faJim Laskey 250f1cdea1d021068f5c9e118d68321ce28fcea63faJim Laskey /// PrintULEB128 - Print a series of hexidecimal values(separated by commas) 251f1cdea1d021068f5c9e118d68321ce28fcea63faJim Laskey /// representing an unsigned leb128 value. 252f1cdea1d021068f5c9e118d68321ce28fcea63faJim Laskey void PrintULEB128(unsigned Value) const; 253f1cdea1d021068f5c9e118d68321ce28fcea63faJim Laskey 254f1cdea1d021068f5c9e118d68321ce28fcea63faJim Laskey /// PrintSLEB128 - Print a series of hexidecimal values(separated by commas) 255f1cdea1d021068f5c9e118d68321ce28fcea63faJim Laskey /// representing a signed leb128 value. 256f1cdea1d021068f5c9e118d68321ce28fcea63faJim Laskey void PrintSLEB128(int Value) const; 257f1cdea1d021068f5c9e118d68321ce28fcea63faJim Laskey 258f1cdea1d021068f5c9e118d68321ce28fcea63faJim Laskey //===------------------------------------------------------------------===// 259f1cdea1d021068f5c9e118d68321ce28fcea63faJim Laskey // Emission and print routines 260f1cdea1d021068f5c9e118d68321ce28fcea63faJim Laskey // 261f1cdea1d021068f5c9e118d68321ce28fcea63faJim Laskey 262f1cdea1d021068f5c9e118d68321ce28fcea63faJim Laskey /// PrintHex - Print a value as a hexidecimal value. 263f1cdea1d021068f5c9e118d68321ce28fcea63faJim Laskey /// 264f1cdea1d021068f5c9e118d68321ce28fcea63faJim Laskey void PrintHex(int Value) const; 265f1cdea1d021068f5c9e118d68321ce28fcea63faJim Laskey 266f1cdea1d021068f5c9e118d68321ce28fcea63faJim Laskey /// EOL - Print a newline character to asm stream. If a comment is present 267f1cdea1d021068f5c9e118d68321ce28fcea63faJim Laskey /// then it will be printed first. Comments should not contain '\n'. 268bda9b0ec7bd6974cebf751ecd23c5434b34054e9Jim Laskey void EOL() const; 269f1cdea1d021068f5c9e118d68321ce28fcea63faJim Laskey void EOL(const std::string &Comment) const; 27025995093e785f4794b3590f3df70fbfe834a00a1Owen Anderson void EOL(const char* Comment) const; 271f1cdea1d021068f5c9e118d68321ce28fcea63faJim Laskey 272f1cdea1d021068f5c9e118d68321ce28fcea63faJim Laskey /// EmitULEB128Bytes - Emit an assembler byte data directive to compose an 273f1cdea1d021068f5c9e118d68321ce28fcea63faJim Laskey /// unsigned leb128 value. 274f1cdea1d021068f5c9e118d68321ce28fcea63faJim Laskey void EmitULEB128Bytes(unsigned Value) const; 275f1cdea1d021068f5c9e118d68321ce28fcea63faJim Laskey 276f1cdea1d021068f5c9e118d68321ce28fcea63faJim Laskey /// EmitSLEB128Bytes - print an assembler byte data directive to compose a 277f1cdea1d021068f5c9e118d68321ce28fcea63faJim Laskey /// signed leb128 value. 278f1cdea1d021068f5c9e118d68321ce28fcea63faJim Laskey void EmitSLEB128Bytes(int Value) const; 279f1cdea1d021068f5c9e118d68321ce28fcea63faJim Laskey 280f1cdea1d021068f5c9e118d68321ce28fcea63faJim Laskey /// EmitInt8 - Emit a byte directive and value. 281f1cdea1d021068f5c9e118d68321ce28fcea63faJim Laskey /// 282f1cdea1d021068f5c9e118d68321ce28fcea63faJim Laskey void EmitInt8(int Value) const; 283f1cdea1d021068f5c9e118d68321ce28fcea63faJim Laskey 284f1cdea1d021068f5c9e118d68321ce28fcea63faJim Laskey /// EmitInt16 - Emit a short directive and value. 285f1cdea1d021068f5c9e118d68321ce28fcea63faJim Laskey /// 286f1cdea1d021068f5c9e118d68321ce28fcea63faJim Laskey void EmitInt16(int Value) const; 287f1cdea1d021068f5c9e118d68321ce28fcea63faJim Laskey 288f1cdea1d021068f5c9e118d68321ce28fcea63faJim Laskey /// EmitInt32 - Emit a long directive and value. 289f1cdea1d021068f5c9e118d68321ce28fcea63faJim Laskey /// 290f1cdea1d021068f5c9e118d68321ce28fcea63faJim Laskey void EmitInt32(int Value) const; 291f1cdea1d021068f5c9e118d68321ce28fcea63faJim Laskey 292f1cdea1d021068f5c9e118d68321ce28fcea63faJim Laskey /// EmitInt64 - Emit a long long directive and value. 293f1cdea1d021068f5c9e118d68321ce28fcea63faJim Laskey /// 294f1cdea1d021068f5c9e118d68321ce28fcea63faJim Laskey void EmitInt64(uint64_t Value) const; 295f1cdea1d021068f5c9e118d68321ce28fcea63faJim Laskey 296f1cdea1d021068f5c9e118d68321ce28fcea63faJim Laskey /// EmitString - Emit a string with quotes and a null terminator. 297f1cdea1d021068f5c9e118d68321ce28fcea63faJim Laskey /// Special characters are emitted properly. 298181b6c9cb5def44658d15848e34c5c45d973f065Reid Spencer /// @verbatim (Eg. '\t') @endverbatim 299f1cdea1d021068f5c9e118d68321ce28fcea63faJim Laskey void EmitString(const std::string &String) const; 300f34be827ac3bb257939e31575fcfc9ef27b94306Bill Wendling void EmitString(const char *String, unsigned Size) const; 301f34be827ac3bb257939e31575fcfc9ef27b94306Bill Wendling 302189f80dc253664627253b2d2cb07d0714feb12baDan Gohman /// EmitFile - Emit a .file directive. 303189f80dc253664627253b2d2cb07d0714feb12baDan Gohman void EmitFile(unsigned Number, const std::string &Name) const; 304189f80dc253664627253b2d2cb07d0714feb12baDan Gohman 305f1cdea1d021068f5c9e118d68321ce28fcea63faJim Laskey //===------------------------------------------------------------------===// 306f1cdea1d021068f5c9e118d68321ce28fcea63faJim Laskey 3076fe3acce749ee2b3714009064626f6c53b06dfb4Chris Lattner /// EmitAlignment - Emit an alignment directive to the specified power of 308bfddc2030a7e67b9e0c42276525d6932375ff261Chris Lattner /// two boundary. For example, if you pass in 3 here, you will get an 8 309a1ab72daadbdc5b499ce7e7e97c4b80efad46736Chris Lattner /// byte alignment. If a global value is specified, and if that global has 3103a4205367dc845d4cd804b47e061f8281777c9daChris Lattner /// an explicit alignment requested, it will unconditionally override the 3113a4205367dc845d4cd804b47e061f8281777c9daChris Lattner /// alignment request. However, if ForcedAlignBits is specified, this value 3123a4205367dc845d4cd804b47e061f8281777c9daChris Lattner /// has final say: the ultimate alignment will be the max of ForcedAlignBits 31305548eb174dd694b651de334b73197a62e5071f1Evan Cheng /// and the alignment computed with NumBits and the global. If UseFillExpr 31405548eb174dd694b651de334b73197a62e5071f1Evan Cheng /// is true, it also emits an optional second value FillValue which the 31505548eb174dd694b651de334b73197a62e5071f1Evan Cheng /// assembler uses to fill gaps to match alignment for text sections if the 31605548eb174dd694b651de334b73197a62e5071f1Evan Cheng /// has specified a non-zero fill value. 3173a4205367dc845d4cd804b47e061f8281777c9daChris Lattner /// 3183a4205367dc845d4cd804b47e061f8281777c9daChris Lattner /// The algorithm is: 3193a4205367dc845d4cd804b47e061f8281777c9daChris Lattner /// Align = NumBits; 3203a4205367dc845d4cd804b47e061f8281777c9daChris Lattner /// if (GV && GV->hasalignment) Align = GV->getalignment(); 3213a4205367dc845d4cd804b47e061f8281777c9daChris Lattner /// Align = std::max(Align, ForcedAlignBits); 3223a4205367dc845d4cd804b47e061f8281777c9daChris Lattner /// 3233a4205367dc845d4cd804b47e061f8281777c9daChris Lattner void EmitAlignment(unsigned NumBits, const GlobalValue *GV = 0, 32405548eb174dd694b651de334b73197a62e5071f1Evan Cheng unsigned ForcedAlignBits = 0, 32505548eb174dd694b651de334b73197a62e5071f1Evan Cheng bool UseFillExpr = true) const; 326bfddc2030a7e67b9e0c42276525d6932375ff261Chris Lattner 3271b08bbca5592351a940bcd164bdec724ee954326Evan Cheng /// printLabel - This method prints a local label used by debug and 3281b08bbca5592351a940bcd164bdec724ee954326Evan Cheng /// exception handling tables. 3291b08bbca5592351a940bcd164bdec724ee954326Evan Cheng void printLabel(const MachineInstr *MI) const; 3301b08bbca5592351a940bcd164bdec724ee954326Evan Cheng void printLabel(unsigned Id) const; 3311b08bbca5592351a940bcd164bdec724ee954326Evan Cheng 332a844bdeab31ef04221e7ef59a8467893584cc14dEvan Cheng /// printDeclare - This method prints a local variable declaration used by 333a844bdeab31ef04221e7ef59a8467893584cc14dEvan Cheng /// debug tables. 334a844bdeab31ef04221e7ef59a8467893584cc14dEvan Cheng void printDeclare(const MachineInstr *MI) const; 335a844bdeab31ef04221e7ef59a8467893584cc14dEvan Cheng 336fe7b16fe6529a6890adf94ce3ccc463ea939992aDavid Greene /// EmitComments - Pretty-print comments for instructions 337fe7b16fe6529a6890adf94ce3ccc463ea939992aDavid Greene void EmitComments(const MachineInstr &MI) const; 338fe7b16fe6529a6890adf94ce3ccc463ea939992aDavid Greene /// EmitComments - Pretty-print comments for instructions 339fe7b16fe6529a6890adf94ce3ccc463ea939992aDavid Greene void EmitComments(const MCInst &MI) const; 340b71d1b2fe2c0673005283b48be2f37c750ce367bDavid Greene /// EmitComments - Pretty-print comments for basic blocks 341b71d1b2fe2c0673005283b48be2f37c750ce367bDavid Greene void EmitComments(const MachineBasicBlock &MBB) const; 342fe7b16fe6529a6890adf94ce3ccc463ea939992aDavid Greene 343575327b77e9092074e5d18bfebfb78ce550aa2a3Daniel Dunbar /// printMCInst - Print an MCInst for this target. 344575327b77e9092074e5d18bfebfb78ce550aa2a3Daniel Dunbar /// 345575327b77e9092074e5d18bfebfb78ce550aa2a3Daniel Dunbar /// Note, this is only a temporary hack to allow the MCStreamer to print 346575327b77e9092074e5d18bfebfb78ce550aa2a3Daniel Dunbar /// instructions, do not use this function outside of llvm-mc. 347575327b77e9092074e5d18bfebfb78ce550aa2a3Daniel Dunbar virtual void printMCInst(const MCInst *MI); 348575327b77e9092074e5d18bfebfb78ce550aa2a3Daniel Dunbar 349f9e56198a39a08272c072211722b3c97ef88853cJim Laskey protected: 3506fe3acce749ee2b3714009064626f6c53b06dfb4Chris Lattner /// EmitZeros - Emit a block of zeros. 35130bad4af40d0126f888f601fb46d01e2b39dbc43Chris Lattner /// 352c8d7bc850ddf5a5df503a173b0bc0f8c03ffec96Sanjiv Gupta void EmitZeros(uint64_t NumZeros, unsigned AddrSpace = 0) const; 353c884db47f1a1d5449b749e6528292451e49025e4Jeff Cohen 354c884db47f1a1d5449b749e6528292451e49025e4Jeff Cohen /// EmitString - Emit a zero-byte-terminated string constant. 355c884db47f1a1d5449b749e6528292451e49025e4Jeff Cohen /// 356c884db47f1a1d5449b749e6528292451e49025e4Jeff Cohen virtual void EmitString(const ConstantArray *CVA) const; 35730bad4af40d0126f888f601fb46d01e2b39dbc43Chris Lattner 3586fe3acce749ee2b3714009064626f6c53b06dfb4Chris Lattner /// EmitConstantValueOnly - Print out the specified constant, without a 359a80ba71efe5be5012128e2db0dd29b024e00105aChris Lattner /// storage class. Only constants of first-class type are allowed here. 360a10f15949d6ca25eb67514cce69d42626efa6380Sanjiv Gupta void EmitConstantValueOnly(const Constant *CV); 36146d6126e669ab83383d47fb465d2a7d0c60169e5Chris Lattner 3626fe3acce749ee2b3714009064626f6c53b06dfb4Chris Lattner /// EmitGlobalConstant - Print a general LLVM constant to the .s file. 363c8d7bc850ddf5a5df503a173b0bc0f8c03ffec96Sanjiv Gupta void EmitGlobalConstant(const Constant* CV, unsigned AddrSpace = 0); 364d6594ae54cfde4db4d30272192645c0a45fb9902Evan Cheng 365d6594ae54cfde4db4d30272192645c0a45fb9902Evan Cheng virtual void EmitMachineConstantPoolValue(MachineConstantPoolValue *MCPV); 366cd76240f3d0f6c5f8c80e4762a8fe3a4de22e059Argyrios Kyrtzidis 367cd76240f3d0f6c5f8c80e4762a8fe3a4de22e059Argyrios Kyrtzidis /// processDebugLoc - Processes the debug information of each machine 368cd76240f3d0f6c5f8c80e4762a8fe3a4de22e059Argyrios Kyrtzidis /// instruction's DebugLoc. 369cd76240f3d0f6c5f8c80e4762a8fe3a4de22e059Argyrios Kyrtzidis void processDebugLoc(DebugLoc DL); 370ed13893ff729bc3b91697f6d80a3ba303782efccChris Lattner 371e736ed19478f05811f08a56706e07fa4ab865401Chris Lattner /// printInlineAsm - This method formats and prints the specified machine 372e736ed19478f05811f08a56706e07fa4ab865401Chris Lattner /// instruction that is an inline asm. 373e736ed19478f05811f08a56706e07fa4ab865401Chris Lattner void printInlineAsm(const MachineInstr *MI) const; 374da47e6e0d003c873da960361549e57ee4617c301Evan Cheng 375da47e6e0d003c873da960361549e57ee4617c301Evan Cheng /// printImplicitDef - This method prints the specified machine instruction 376da47e6e0d003c873da960361549e57ee4617c301Evan Cheng /// that is an implicit def. 377da47e6e0d003c873da960361549e57ee4617c301Evan Cheng virtual void printImplicitDef(const MachineInstr *MI) const; 37837efe6764568a3829fee26aba532283131d1a104Nate Begeman 37937efe6764568a3829fee26aba532283131d1a104Nate Begeman /// printBasicBlockLabel - This method prints the label for the specified 38037efe6764568a3829fee26aba532283131d1a104Nate Begeman /// MachineBasicBlock 381cdf38c4edb892c356cfaa3c09c57728bc8d6bfd0Nate Begeman virtual void printBasicBlockLabel(const MachineBasicBlock *MBB, 382fb8075d03f5c87bd57dcc9c5f2304f6b13c55aadEvan Cheng bool printAlign = false, 383cdf38c4edb892c356cfaa3c09c57728bc8d6bfd0Nate Begeman bool printColon = false, 384cdf38c4edb892c356cfaa3c09c57728bc8d6bfd0Nate Begeman bool printComment = true) const; 38552a51e38dc312aa262b0d771419afe1785f3cb22Nate Begeman 386cc41586b9d79532172b37e1f44a9077da4b73fc9Evan Cheng /// printPICJumpTableSetLabel - This method prints a set label for the 387cc41586b9d79532172b37e1f44a9077da4b73fc9Evan Cheng /// specified MachineBasicBlock for a jumptable entry. 388cc41586b9d79532172b37e1f44a9077da4b73fc9Evan Cheng virtual void printPICJumpTableSetLabel(unsigned uid, 389cc41586b9d79532172b37e1f44a9077da4b73fc9Evan Cheng const MachineBasicBlock *MBB) const; 390cc41586b9d79532172b37e1f44a9077da4b73fc9Evan Cheng virtual void printPICJumpTableSetLabel(unsigned uid, unsigned uid2, 391cc41586b9d79532172b37e1f44a9077da4b73fc9Evan Cheng const MachineBasicBlock *MBB) const; 3929de1934099f4eedaeb2f3a023411b2cd3e0e1eaeAnton Korobeynikov virtual void printPICJumpTableEntry(const MachineJumpTableInfo *MJTI, 3939de1934099f4eedaeb2f3a023411b2cd3e0e1eaeAnton Korobeynikov const MachineBasicBlock *MBB, 3949de1934099f4eedaeb2f3a023411b2cd3e0e1eaeAnton Korobeynikov unsigned uid) const; 3959de1934099f4eedaeb2f3a023411b2cd3e0e1eaeAnton Korobeynikov 396d6594ae54cfde4db4d30272192645c0a45fb9902Evan Cheng /// printDataDirective - This method prints the asm directive for the 397d6594ae54cfde4db4d30272192645c0a45fb9902Evan Cheng /// specified type. 398c8d7bc850ddf5a5df503a173b0bc0f8c03ffec96Sanjiv Gupta void printDataDirective(const Type *type, unsigned AddrSpace = 0); 399d6594ae54cfde4db4d30272192645c0a45fb9902Evan Cheng 400f5b6a47bb57fb5ffc734416d4d5d993e1a06273bAnton Korobeynikov /// printVisibility - This prints visibility information about symbol, if 401f5b6a47bb57fb5ffc734416d4d5d993e1a06273bAnton Korobeynikov /// this is suported by the target. 402f5b6a47bb57fb5ffc734416d4d5d993e1a06273bAnton Korobeynikov void printVisibility(const std::string& Name, unsigned Visibility) const; 403f5b6a47bb57fb5ffc734416d4d5d993e1a06273bAnton Korobeynikov 4047751ad92daeea5a3502fbc266ae814baec5c03e6Anton Korobeynikov /// printOffset - This is just convenient handler for printing offsets. 4057751ad92daeea5a3502fbc266ae814baec5c03e6Anton Korobeynikov void printOffset(int64_t Offset) const; 406014700c1a8cba203fd21ff129426ba8a426ab244David Greene 407ed13893ff729bc3b91697f6d80a3ba303782efccChris Lattner private: 408cb05af852f1d346ac07b84c74a930a5cdbd6d427Chris Lattner void EmitLLVMUsedList(Constant *List); 409ed13893ff729bc3b91697f6d80a3ba303782efccChris Lattner void EmitXXStructorList(Constant *List); 410c8d7bc850ddf5a5df503a173b0bc0f8c03ffec96Sanjiv Gupta void EmitGlobalConstantStruct(const ConstantStruct* CVS, 411c8d7bc850ddf5a5df503a173b0bc0f8c03ffec96Sanjiv Gupta unsigned AddrSpace); 412d3d965714b89c5d5aeb65fb5ce06e081f0b3c049Sanjiv Gupta void EmitGlobalConstantArray(const ConstantArray* CVA, unsigned AddrSpace); 41300d448a341175556ebd86af68219f5b90b7145a3Dan Gohman void EmitGlobalConstantVector(const ConstantVector* CP); 414c8d7bc850ddf5a5df503a173b0bc0f8c03ffec96Sanjiv Gupta void EmitGlobalConstantFP(const ConstantFP* CFP, unsigned AddrSpace); 415c8d7bc850ddf5a5df503a173b0bc0f8c03ffec96Sanjiv Gupta void EmitGlobalConstantLargeInt(const ConstantInt* CI, unsigned AddrSpace); 4165eca075b74d62c621b160aa216b4cd50829a2cc7Gordon Henriksen GCMetadataPrinter *GetOrCreateGCPrinter(GCStrategy *C); 417a80ba71efe5be5012128e2db0dd29b024e00105aChris Lattner }; 418a80ba71efe5be5012128e2db0dd29b024e00105aChris Lattner} 419a80ba71efe5be5012128e2db0dd29b024e00105aChris Lattner 420a80ba71efe5be5012128e2db0dd29b024e00105aChris Lattner#endif 421