1 //===-- AsmWriter.cpp - Printing LLVM as an assembly file -----------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This library implements the functionality defined in llvm/Assembly/Writer.h
12 // Note that these routines must be extremely tolerant of various errors in the
13 // LLVM code, because it can be used for debugging transformations.
15 //===----------------------------------------------------------------------===//
17 #include "llvm/Assembly/Writer.h"
18 #include "llvm/Assembly/PrintModulePass.h"
19 #include "llvm/Assembly/AsmAnnotationWriter.h"
20 #include "llvm/CallingConv.h"
21 #include "llvm/Constants.h"
22 #include "llvm/DerivedTypes.h"
23 #include "llvm/ParamAttrsList.h"
24 #include "llvm/InlineAsm.h"
25 #include "llvm/Instruction.h"
26 #include "llvm/Instructions.h"
27 #include "llvm/Module.h"
28 #include "llvm/ValueSymbolTable.h"
29 #include "llvm/TypeSymbolTable.h"
30 #include "llvm/ADT/StringExtras.h"
31 #include "llvm/ADT/STLExtras.h"
32 #include "llvm/Support/CFG.h"
33 #include "llvm/Support/MathExtras.h"
34 #include "llvm/Support/Streams.h"
41 // Make virtual table appear in this compilation unit.
42 AssemblyAnnotationWriter::~AssemblyAnnotationWriter() {}
44 /// This class provides computation of slot numbers for LLVM Assembly writing.
45 /// @brief LLVM Assembly Writing Slot Computation.
52 /// @brief A mapping of Values to slot numbers
53 typedef std::map<const Value*,unsigned> ValueMap;
56 /// @name Constructors
59 /// @brief Construct from a module
60 explicit SlotMachine(const Module *M);
62 /// @brief Construct from a function, starting out in incorp state.
63 explicit SlotMachine(const Function *F);
69 /// Return the slot number of the specified value in it's type
70 /// plane. If something is not in the SlotMachine, return -1.
71 int getLocalSlot(const Value *V);
72 int getGlobalSlot(const GlobalValue *V);
78 /// If you'd like to deal with a function instead of just a module, use
79 /// this method to get its data into the SlotMachine.
80 void incorporateFunction(const Function *F) {
82 FunctionProcessed = false;
85 /// After calling incorporateFunction, use this method to remove the
86 /// most recently incorporated function from the SlotMachine. This
87 /// will reset the state of the machine back to just the module contents.
91 /// @name Implementation Details
94 /// This function does the actual initialization.
95 inline void initialize();
97 /// CreateModuleSlot - Insert the specified GlobalValue* into the slot table.
98 void CreateModuleSlot(const GlobalValue *V);
100 /// CreateFunctionSlot - Insert the specified Value* into the slot table.
101 void CreateFunctionSlot(const Value *V);
103 /// Add all of the module level global variables (and their initializers)
104 /// and function declarations, but not the contents of those functions.
105 void processModule();
107 /// Add all of the functions arguments, basic blocks, and instructions
108 void processFunction();
110 SlotMachine(const SlotMachine &); // DO NOT IMPLEMENT
111 void operator=(const SlotMachine &); // DO NOT IMPLEMENT
118 /// @brief The module for which we are holding slot numbers
119 const Module* TheModule;
121 /// @brief The function for which we are holding slot numbers
122 const Function* TheFunction;
123 bool FunctionProcessed;
125 /// @brief The TypePlanes map for the module level data
129 /// @brief The TypePlanes map for the function level data
137 } // end namespace llvm
139 char PrintModulePass::ID = 0;
140 static RegisterPass<PrintModulePass>
141 X("printm", "Print module to stderr");
142 char PrintFunctionPass::ID = 0;
143 static RegisterPass<PrintFunctionPass>
144 Y("print","Print function to stderr");
146 static void WriteAsOperandInternal(std::ostream &Out, const Value *V,
147 std::map<const Type *, std::string> &TypeTable,
148 SlotMachine *Machine);
150 static const Module *getModuleFromVal(const Value *V) {
151 if (const Argument *MA = dyn_cast<Argument>(V))
152 return MA->getParent() ? MA->getParent()->getParent() : 0;
153 else if (const BasicBlock *BB = dyn_cast<BasicBlock>(V))
154 return BB->getParent() ? BB->getParent()->getParent() : 0;
155 else if (const Instruction *I = dyn_cast<Instruction>(V)) {
156 const Function *M = I->getParent() ? I->getParent()->getParent() : 0;
157 return M ? M->getParent() : 0;
158 } else if (const GlobalValue *GV = dyn_cast<GlobalValue>(V))
159 return GV->getParent();
163 static SlotMachine *createSlotMachine(const Value *V) {
164 if (const Argument *FA = dyn_cast<Argument>(V)) {
165 return new SlotMachine(FA->getParent());
166 } else if (const Instruction *I = dyn_cast<Instruction>(V)) {
167 return new SlotMachine(I->getParent()->getParent());
168 } else if (const BasicBlock *BB = dyn_cast<BasicBlock>(V)) {
169 return new SlotMachine(BB->getParent());
170 } else if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(V)){
171 return new SlotMachine(GV->getParent());
172 } else if (const GlobalAlias *GA = dyn_cast<GlobalAlias>(V)){
173 return new SlotMachine(GA->getParent());
174 } else if (const Function *Func = dyn_cast<Function>(V)) {
175 return new SlotMachine(Func);
180 /// NameNeedsQuotes - Return true if the specified llvm name should be wrapped
182 static std::string QuoteNameIfNeeded(const std::string &Name) {
184 bool needsQuotes = Name[0] >= '0' && Name[0] <= '9';
185 // Scan the name to see if it needs quotes and to replace funky chars with
186 // their octal equivalent.
187 for (unsigned i = 0, e = Name.size(); i != e; ++i) {
189 assert(C != '"' && "Illegal character in LLVM value name!");
190 if (isalnum(C) || C == '-' || C == '.' || C == '_')
192 else if (C == '\\') {
195 } else if (isprint(C)) {
201 char hex1 = (C >> 4) & 0x0F;
203 result += hex1 + '0';
205 result += hex1 - 10 + 'A';
206 char hex2 = C & 0x0F;
208 result += hex2 + '0';
210 result += hex2 - 10 + 'A';
214 result.insert(0,"\"");
226 /// getLLVMName - Turn the specified string into an 'LLVM name', which is either
227 /// prefixed with % (if the string only contains simple characters) or is
228 /// surrounded with ""'s (if it has special chars in it).
229 static std::string getLLVMName(const std::string &Name, PrefixType Prefix) {
230 assert(!Name.empty() && "Cannot get empty name!");
232 default: assert(0 && "Bad prefix!");
233 case GlobalPrefix: return '@' + QuoteNameIfNeeded(Name);
234 case LabelPrefix: return QuoteNameIfNeeded(Name);
235 case LocalPrefix: return '%' + QuoteNameIfNeeded(Name);
240 /// fillTypeNameTable - If the module has a symbol table, take all global types
241 /// and stuff their names into the TypeNames map.
243 static void fillTypeNameTable(const Module *M,
244 std::map<const Type *, std::string> &TypeNames) {
246 const TypeSymbolTable &ST = M->getTypeSymbolTable();
247 TypeSymbolTable::const_iterator TI = ST.begin();
248 for (; TI != ST.end(); ++TI) {
249 // As a heuristic, don't insert pointer to primitive types, because
250 // they are used too often to have a single useful name.
252 const Type *Ty = cast<Type>(TI->second);
253 if (!isa<PointerType>(Ty) ||
254 !cast<PointerType>(Ty)->getElementType()->isPrimitiveType() ||
255 !cast<PointerType>(Ty)->getElementType()->isInteger() ||
256 isa<OpaqueType>(cast<PointerType>(Ty)->getElementType()))
257 TypeNames.insert(std::make_pair(Ty, getLLVMName(TI->first, LocalPrefix)));
263 static void calcTypeName(const Type *Ty,
264 std::vector<const Type *> &TypeStack,
265 std::map<const Type *, std::string> &TypeNames,
266 std::string & Result){
267 if (Ty->isInteger() || (Ty->isPrimitiveType() && !isa<OpaqueType>(Ty))) {
268 Result += Ty->getDescription(); // Base case
272 // Check to see if the type is named.
273 std::map<const Type *, std::string>::iterator I = TypeNames.find(Ty);
274 if (I != TypeNames.end()) {
279 if (isa<OpaqueType>(Ty)) {
284 // Check to see if the Type is already on the stack...
285 unsigned Slot = 0, CurSize = TypeStack.size();
286 while (Slot < CurSize && TypeStack[Slot] != Ty) ++Slot; // Scan for type
288 // This is another base case for the recursion. In this case, we know
289 // that we have looped back to a type that we have previously visited.
290 // Generate the appropriate upreference to handle this.
291 if (Slot < CurSize) {
292 Result += "\\" + utostr(CurSize-Slot); // Here's the upreference
296 TypeStack.push_back(Ty); // Recursive case: Add us to the stack..
298 switch (Ty->getTypeID()) {
299 case Type::IntegerTyID: {
300 unsigned BitWidth = cast<IntegerType>(Ty)->getBitWidth();
301 Result += "i" + utostr(BitWidth);
304 case Type::FunctionTyID: {
305 const FunctionType *FTy = cast<FunctionType>(Ty);
306 calcTypeName(FTy->getReturnType(), TypeStack, TypeNames, Result);
308 for (FunctionType::param_iterator I = FTy->param_begin(),
309 E = FTy->param_end(); I != E; ++I) {
310 if (I != FTy->param_begin())
312 calcTypeName(*I, TypeStack, TypeNames, Result);
314 if (FTy->isVarArg()) {
315 if (FTy->getNumParams()) Result += ", ";
321 case Type::StructTyID: {
322 const StructType *STy = cast<StructType>(Ty);
326 for (StructType::element_iterator I = STy->element_begin(),
327 E = STy->element_end(); I != E; ++I) {
328 if (I != STy->element_begin())
330 calcTypeName(*I, TypeStack, TypeNames, Result);
337 case Type::PointerTyID: {
338 const PointerType *PTy = cast<PointerType>(Ty);
339 calcTypeName(PTy->getElementType(),
340 TypeStack, TypeNames, Result);
341 if (unsigned AddressSpace = PTy->getAddressSpace())
342 Result += " addrspace(" + utostr(AddressSpace) + ")";
346 case Type::ArrayTyID: {
347 const ArrayType *ATy = cast<ArrayType>(Ty);
348 Result += "[" + utostr(ATy->getNumElements()) + " x ";
349 calcTypeName(ATy->getElementType(), TypeStack, TypeNames, Result);
353 case Type::VectorTyID: {
354 const VectorType *PTy = cast<VectorType>(Ty);
355 Result += "<" + utostr(PTy->getNumElements()) + " x ";
356 calcTypeName(PTy->getElementType(), TypeStack, TypeNames, Result);
360 case Type::OpaqueTyID:
364 Result += "<unrecognized-type>";
368 TypeStack.pop_back(); // Remove self from stack...
372 /// printTypeInt - The internal guts of printing out a type that has a
373 /// potentially named portion.
375 static std::ostream &printTypeInt(std::ostream &Out, const Type *Ty,
376 std::map<const Type *, std::string> &TypeNames) {
377 // Primitive types always print out their description, regardless of whether
378 // they have been named or not.
380 if (Ty->isInteger() || (Ty->isPrimitiveType() && !isa<OpaqueType>(Ty)))
381 return Out << Ty->getDescription();
383 // Check to see if the type is named.
384 std::map<const Type *, std::string>::iterator I = TypeNames.find(Ty);
385 if (I != TypeNames.end()) return Out << I->second;
387 // Otherwise we have a type that has not been named but is a derived type.
388 // Carefully recurse the type hierarchy to print out any contained symbolic
391 std::vector<const Type *> TypeStack;
392 std::string TypeName;
393 calcTypeName(Ty, TypeStack, TypeNames, TypeName);
394 TypeNames.insert(std::make_pair(Ty, TypeName));//Cache type name for later use
395 return (Out << TypeName);
399 /// WriteTypeSymbolic - This attempts to write the specified type as a symbolic
400 /// type, iff there is an entry in the modules symbol table for the specified
401 /// type or one of it's component types. This is slower than a simple x << Type
403 std::ostream &llvm::WriteTypeSymbolic(std::ostream &Out, const Type *Ty,
407 // If they want us to print out a type, but there is no context, we can't
408 // print it symbolically.
410 return Out << Ty->getDescription();
412 std::map<const Type *, std::string> TypeNames;
413 fillTypeNameTable(M, TypeNames);
414 return printTypeInt(Out, Ty, TypeNames);
417 // PrintEscapedString - Print each character of the specified string, escaping
418 // it if it is not printable or if it is an escape char.
419 static void PrintEscapedString(const std::string &Str, std::ostream &Out) {
420 for (unsigned i = 0, e = Str.size(); i != e; ++i) {
421 unsigned char C = Str[i];
422 if (isprint(C) && C != '"' && C != '\\') {
426 << (char) ((C/16 < 10) ? ( C/16 +'0') : ( C/16 -10+'A'))
427 << (char)(((C&15) < 10) ? ((C&15)+'0') : ((C&15)-10+'A'));
432 static const char *getPredicateText(unsigned predicate) {
433 const char * pred = "unknown";
435 case FCmpInst::FCMP_FALSE: pred = "false"; break;
436 case FCmpInst::FCMP_OEQ: pred = "oeq"; break;
437 case FCmpInst::FCMP_OGT: pred = "ogt"; break;
438 case FCmpInst::FCMP_OGE: pred = "oge"; break;
439 case FCmpInst::FCMP_OLT: pred = "olt"; break;
440 case FCmpInst::FCMP_OLE: pred = "ole"; break;
441 case FCmpInst::FCMP_ONE: pred = "one"; break;
442 case FCmpInst::FCMP_ORD: pred = "ord"; break;
443 case FCmpInst::FCMP_UNO: pred = "uno"; break;
444 case FCmpInst::FCMP_UEQ: pred = "ueq"; break;
445 case FCmpInst::FCMP_UGT: pred = "ugt"; break;
446 case FCmpInst::FCMP_UGE: pred = "uge"; break;
447 case FCmpInst::FCMP_ULT: pred = "ult"; break;
448 case FCmpInst::FCMP_ULE: pred = "ule"; break;
449 case FCmpInst::FCMP_UNE: pred = "une"; break;
450 case FCmpInst::FCMP_TRUE: pred = "true"; break;
451 case ICmpInst::ICMP_EQ: pred = "eq"; break;
452 case ICmpInst::ICMP_NE: pred = "ne"; break;
453 case ICmpInst::ICMP_SGT: pred = "sgt"; break;
454 case ICmpInst::ICMP_SGE: pred = "sge"; break;
455 case ICmpInst::ICMP_SLT: pred = "slt"; break;
456 case ICmpInst::ICMP_SLE: pred = "sle"; break;
457 case ICmpInst::ICMP_UGT: pred = "ugt"; break;
458 case ICmpInst::ICMP_UGE: pred = "uge"; break;
459 case ICmpInst::ICMP_ULT: pred = "ult"; break;
460 case ICmpInst::ICMP_ULE: pred = "ule"; break;
465 /// @brief Internal constant writer.
466 static void WriteConstantInt(std::ostream &Out, const Constant *CV,
467 std::map<const Type *, std::string> &TypeTable,
468 SlotMachine *Machine) {
469 const int IndentSize = 4;
470 static std::string Indent = "\n";
471 if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV)) {
472 if (CI->getType() == Type::Int1Ty)
473 Out << (CI->getZExtValue() ? "true" : "false");
475 Out << CI->getValue().toStringSigned(10);
476 } else if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV)) {
477 if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEdouble ||
478 &CFP->getValueAPF().getSemantics() == &APFloat::IEEEsingle) {
479 // We would like to output the FP constant value in exponential notation,
480 // but we cannot do this if doing so will lose precision. Check here to
481 // make sure that we only output it in exponential format if we can parse
482 // the value back and get the same value.
484 bool isDouble = &CFP->getValueAPF().getSemantics()==&APFloat::IEEEdouble;
485 double Val = (isDouble) ? CFP->getValueAPF().convertToDouble() :
486 CFP->getValueAPF().convertToFloat();
487 std::string StrVal = ftostr(CFP->getValueAPF());
489 // Check to make sure that the stringized number is not some string like
490 // "Inf" or NaN, that atof will accept, but the lexer will not. Check
491 // that the string matches the "[-+]?[0-9]" regex.
493 if ((StrVal[0] >= '0' && StrVal[0] <= '9') ||
494 ((StrVal[0] == '-' || StrVal[0] == '+') &&
495 (StrVal[1] >= '0' && StrVal[1] <= '9'))) {
496 // Reparse stringized version!
497 if (atof(StrVal.c_str()) == Val) {
502 // Otherwise we could not reparse it to exactly the same value, so we must
503 // output the string in hexadecimal format!
504 assert(sizeof(double) == sizeof(uint64_t) &&
505 "assuming that double is 64 bits!");
506 Out << "0x" << utohexstr(DoubleToBits(Val));
508 // Some form of long double. These appear as a magic letter identifying
509 // the type, then a fixed number of hex digits.
511 if (&CFP->getValueAPF().getSemantics() == &APFloat::x87DoubleExtended)
513 else if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEquad)
515 else if (&CFP->getValueAPF().getSemantics() == &APFloat::PPCDoubleDouble)
518 assert(0 && "Unsupported floating point type");
519 // api needed to prevent premature destruction
520 APInt api = CFP->getValueAPF().convertToAPInt();
521 const uint64_t* p = api.getRawData();
524 int width = api.getBitWidth();
525 for (int j=0; j<width; j+=4, shiftcount-=4) {
526 unsigned int nibble = (word>>shiftcount) & 15;
528 Out << (unsigned char)(nibble + '0');
530 Out << (unsigned char)(nibble - 10 + 'A');
531 if (shiftcount == 0) {
535 shiftcount = width-j-4;
539 } else if (isa<ConstantAggregateZero>(CV)) {
540 Out << "zeroinitializer";
541 } else if (const ConstantArray *CA = dyn_cast<ConstantArray>(CV)) {
542 // As a special case, print the array as a string if it is an array of
543 // ubytes or an array of sbytes with positive values.
545 const Type *ETy = CA->getType()->getElementType();
546 if (CA->isString()) {
548 PrintEscapedString(CA->getAsString(), Out);
551 } else { // Cannot output in string format...
553 if (CA->getNumOperands()) {
555 printTypeInt(Out, ETy, TypeTable);
556 WriteAsOperandInternal(Out, CA->getOperand(0),
558 for (unsigned i = 1, e = CA->getNumOperands(); i != e; ++i) {
560 printTypeInt(Out, ETy, TypeTable);
561 WriteAsOperandInternal(Out, CA->getOperand(i), TypeTable, Machine);
566 } else if (const ConstantStruct *CS = dyn_cast<ConstantStruct>(CV)) {
567 if (CS->getType()->isPacked())
570 unsigned N = CS->getNumOperands();
573 Indent += std::string(IndentSize, ' ');
578 printTypeInt(Out, CS->getOperand(0)->getType(), TypeTable);
580 WriteAsOperandInternal(Out, CS->getOperand(0), TypeTable, Machine);
582 for (unsigned i = 1; i < N; i++) {
584 if (N > 2) Out << Indent;
585 printTypeInt(Out, CS->getOperand(i)->getType(), TypeTable);
587 WriteAsOperandInternal(Out, CS->getOperand(i), TypeTable, Machine);
589 if (N > 2) Indent.resize(Indent.size() - IndentSize);
593 if (CS->getType()->isPacked())
595 } else if (const ConstantVector *CP = dyn_cast<ConstantVector>(CV)) {
596 const Type *ETy = CP->getType()->getElementType();
597 assert(CP->getNumOperands() > 0 &&
598 "Number of operands for a PackedConst must be > 0");
601 printTypeInt(Out, ETy, TypeTable);
602 WriteAsOperandInternal(Out, CP->getOperand(0), TypeTable, Machine);
603 for (unsigned i = 1, e = CP->getNumOperands(); i != e; ++i) {
605 printTypeInt(Out, ETy, TypeTable);
606 WriteAsOperandInternal(Out, CP->getOperand(i), TypeTable, Machine);
609 } else if (isa<ConstantPointerNull>(CV)) {
612 } else if (isa<UndefValue>(CV)) {
615 } else if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV)) {
616 Out << CE->getOpcodeName();
618 Out << " " << getPredicateText(CE->getPredicate());
621 for (User::const_op_iterator OI=CE->op_begin(); OI != CE->op_end(); ++OI) {
622 printTypeInt(Out, (*OI)->getType(), TypeTable);
623 WriteAsOperandInternal(Out, *OI, TypeTable, Machine);
624 if (OI+1 != CE->op_end())
630 printTypeInt(Out, CE->getType(), TypeTable);
636 Out << "<placeholder or erroneous Constant>";
641 /// WriteAsOperand - Write the name of the specified value out to the specified
642 /// ostream. This can be useful when you just want to print int %reg126, not
643 /// the whole instruction that generated it.
645 static void WriteAsOperandInternal(std::ostream &Out, const Value *V,
646 std::map<const Type*, std::string> &TypeTable,
647 SlotMachine *Machine) {
650 Out << getLLVMName(V->getName(),
651 isa<GlobalValue>(V) ? GlobalPrefix : LocalPrefix);
653 const Constant *CV = dyn_cast<Constant>(V);
654 if (CV && !isa<GlobalValue>(CV)) {
655 WriteConstantInt(Out, CV, TypeTable, Machine);
656 } else if (const InlineAsm *IA = dyn_cast<InlineAsm>(V)) {
658 if (IA->hasSideEffects())
659 Out << "sideeffect ";
661 PrintEscapedString(IA->getAsmString(), Out);
663 PrintEscapedString(IA->getConstraintString(), Out);
669 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
670 Slot = Machine->getGlobalSlot(GV);
673 Slot = Machine->getLocalSlot(V);
676 Machine = createSlotMachine(V);
678 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
679 Slot = Machine->getGlobalSlot(GV);
682 Slot = Machine->getLocalSlot(V);
690 Out << Prefix << Slot;
697 /// WriteAsOperand - Write the name of the specified value out to the specified
698 /// ostream. This can be useful when you just want to print int %reg126, not
699 /// the whole instruction that generated it.
701 std::ostream &llvm::WriteAsOperand(std::ostream &Out, const Value *V,
702 bool PrintType, const Module *Context) {
703 std::map<const Type *, std::string> TypeNames;
704 if (Context == 0) Context = getModuleFromVal(V);
707 fillTypeNameTable(Context, TypeNames);
710 printTypeInt(Out, V->getType(), TypeNames);
712 WriteAsOperandInternal(Out, V, TypeNames, 0);
719 class AssemblyWriter {
721 SlotMachine &Machine;
722 const Module *TheModule;
723 std::map<const Type *, std::string> TypeNames;
724 AssemblyAnnotationWriter *AnnotationWriter;
726 inline AssemblyWriter(std::ostream &o, SlotMachine &Mac, const Module *M,
727 AssemblyAnnotationWriter *AAW)
728 : Out(o), Machine(Mac), TheModule(M), AnnotationWriter(AAW) {
730 // If the module has a symbol table, take all global types and stuff their
731 // names into the TypeNames map.
733 fillTypeNameTable(M, TypeNames);
736 inline void write(const Module *M) { printModule(M); }
737 inline void write(const GlobalVariable *G) { printGlobal(G); }
738 inline void write(const GlobalAlias *G) { printAlias(G); }
739 inline void write(const Function *F) { printFunction(F); }
740 inline void write(const BasicBlock *BB) { printBasicBlock(BB); }
741 inline void write(const Instruction *I) { printInstruction(*I); }
742 inline void write(const Type *Ty) { printType(Ty); }
744 void writeOperand(const Value *Op, bool PrintType);
745 void writeParamOperand(const Value *Operand, ParameterAttributes Attrs);
747 const Module* getModule() { return TheModule; }
750 void printModule(const Module *M);
751 void printTypeSymbolTable(const TypeSymbolTable &ST);
752 void printGlobal(const GlobalVariable *GV);
753 void printAlias(const GlobalAlias *GV);
754 void printFunction(const Function *F);
755 void printArgument(const Argument *FA, ParameterAttributes Attrs);
756 void printBasicBlock(const BasicBlock *BB);
757 void printInstruction(const Instruction &I);
759 // printType - Go to extreme measures to attempt to print out a short,
760 // symbolic version of a type name.
762 std::ostream &printType(const Type *Ty) {
763 return printTypeInt(Out, Ty, TypeNames);
766 // printTypeAtLeastOneLevel - Print out one level of the possibly complex type
767 // without considering any symbolic types that we may have equal to it.
769 std::ostream &printTypeAtLeastOneLevel(const Type *Ty);
771 // printInfoComment - Print a little comment after the instruction indicating
772 // which slot it occupies.
773 void printInfoComment(const Value &V);
775 } // end of llvm namespace
777 /// printTypeAtLeastOneLevel - Print out one level of the possibly complex type
778 /// without considering any symbolic types that we may have equal to it.
780 std::ostream &AssemblyWriter::printTypeAtLeastOneLevel(const Type *Ty) {
781 if (const IntegerType *ITy = dyn_cast<IntegerType>(Ty))
782 Out << "i" << utostr(ITy->getBitWidth());
783 else if (const FunctionType *FTy = dyn_cast<FunctionType>(Ty)) {
784 printType(FTy->getReturnType());
786 for (FunctionType::param_iterator I = FTy->param_begin(),
787 E = FTy->param_end(); I != E; ++I) {
788 if (I != FTy->param_begin())
792 if (FTy->isVarArg()) {
793 if (FTy->getNumParams()) Out << ", ";
797 } else if (const StructType *STy = dyn_cast<StructType>(Ty)) {
801 for (StructType::element_iterator I = STy->element_begin(),
802 E = STy->element_end(); I != E; ++I) {
803 if (I != STy->element_begin())
810 } else if (const PointerType *PTy = dyn_cast<PointerType>(Ty)) {
811 printType(PTy->getElementType());
812 if (unsigned AddressSpace = PTy->getAddressSpace())
813 Out << " addrspace(" << AddressSpace << ")";
815 } else if (const ArrayType *ATy = dyn_cast<ArrayType>(Ty)) {
816 Out << '[' << ATy->getNumElements() << " x ";
817 printType(ATy->getElementType()) << ']';
818 } else if (const VectorType *PTy = dyn_cast<VectorType>(Ty)) {
819 Out << '<' << PTy->getNumElements() << " x ";
820 printType(PTy->getElementType()) << '>';
822 else if (isa<OpaqueType>(Ty)) {
825 if (!Ty->isPrimitiveType())
826 Out << "<unknown derived type>";
833 void AssemblyWriter::writeOperand(const Value *Operand, bool PrintType) {
835 Out << "<null operand!>";
837 if (PrintType) { Out << ' '; printType(Operand->getType()); }
838 WriteAsOperandInternal(Out, Operand, TypeNames, &Machine);
842 void AssemblyWriter::writeParamOperand(const Value *Operand,
843 ParameterAttributes Attrs) {
845 Out << "<null operand!>";
849 printType(Operand->getType());
850 // Print parameter attributes list
851 if (Attrs != ParamAttr::None)
852 Out << ' ' << ParamAttrsList::getParamAttrsText(Attrs);
854 WriteAsOperandInternal(Out, Operand, TypeNames, &Machine);
858 void AssemblyWriter::printModule(const Module *M) {
859 if (!M->getModuleIdentifier().empty() &&
860 // Don't print the ID if it will start a new line (which would
861 // require a comment char before it).
862 M->getModuleIdentifier().find('\n') == std::string::npos)
863 Out << "; ModuleID = '" << M->getModuleIdentifier() << "'\n";
865 if (!M->getDataLayout().empty())
866 Out << "target datalayout = \"" << M->getDataLayout() << "\"\n";
867 if (!M->getTargetTriple().empty())
868 Out << "target triple = \"" << M->getTargetTriple() << "\"\n";
870 if (!M->getModuleInlineAsm().empty()) {
871 // Split the string into lines, to make it easier to read the .ll file.
872 std::string Asm = M->getModuleInlineAsm();
874 size_t NewLine = Asm.find_first_of('\n', CurPos);
875 while (NewLine != std::string::npos) {
876 // We found a newline, print the portion of the asm string from the
877 // last newline up to this newline.
878 Out << "module asm \"";
879 PrintEscapedString(std::string(Asm.begin()+CurPos, Asm.begin()+NewLine),
883 NewLine = Asm.find_first_of('\n', CurPos);
885 Out << "module asm \"";
886 PrintEscapedString(std::string(Asm.begin()+CurPos, Asm.end()), Out);
890 // Loop over the dependent libraries and emit them.
891 Module::lib_iterator LI = M->lib_begin();
892 Module::lib_iterator LE = M->lib_end();
894 Out << "deplibs = [ ";
896 Out << '"' << *LI << '"';
904 // Loop over the symbol table, emitting all named constants.
905 printTypeSymbolTable(M->getTypeSymbolTable());
907 for (Module::const_global_iterator I = M->global_begin(), E = M->global_end();
911 // Output all aliases.
912 if (!M->alias_empty()) Out << "\n";
913 for (Module::const_alias_iterator I = M->alias_begin(), E = M->alias_end();
917 // Output all of the functions.
918 for (Module::const_iterator I = M->begin(), E = M->end(); I != E; ++I)
922 void AssemblyWriter::printGlobal(const GlobalVariable *GV) {
923 if (GV->hasName()) Out << getLLVMName(GV->getName(), GlobalPrefix) << " = ";
925 if (!GV->hasInitializer()) {
926 switch (GV->getLinkage()) {
927 case GlobalValue::DLLImportLinkage: Out << "dllimport "; break;
928 case GlobalValue::ExternalWeakLinkage: Out << "extern_weak "; break;
929 default: Out << "external "; break;
932 switch (GV->getLinkage()) {
933 case GlobalValue::InternalLinkage: Out << "internal "; break;
934 case GlobalValue::LinkOnceLinkage: Out << "linkonce "; break;
935 case GlobalValue::WeakLinkage: Out << "weak "; break;
936 case GlobalValue::AppendingLinkage: Out << "appending "; break;
937 case GlobalValue::DLLImportLinkage: Out << "dllimport "; break;
938 case GlobalValue::DLLExportLinkage: Out << "dllexport "; break;
939 case GlobalValue::ExternalWeakLinkage: Out << "extern_weak "; break;
940 case GlobalValue::ExternalLinkage: break;
941 case GlobalValue::GhostLinkage:
942 cerr << "GhostLinkage not allowed in AsmWriter!\n";
945 switch (GV->getVisibility()) {
946 default: assert(0 && "Invalid visibility style!");
947 case GlobalValue::DefaultVisibility: break;
948 case GlobalValue::HiddenVisibility: Out << "hidden "; break;
949 case GlobalValue::ProtectedVisibility: Out << "protected "; break;
953 if (GV->isThreadLocal()) Out << "thread_local ";
954 Out << (GV->isConstant() ? "constant " : "global ");
955 printType(GV->getType()->getElementType());
957 if (GV->hasInitializer()) {
958 Constant* C = cast<Constant>(GV->getInitializer());
959 assert(C && "GlobalVar initializer isn't constant?");
960 writeOperand(GV->getInitializer(), false);
963 if (unsigned AddressSpace = GV->getType()->getAddressSpace())
964 Out << " addrspace(" << AddressSpace << ") ";
966 if (GV->hasSection())
967 Out << ", section \"" << GV->getSection() << '"';
968 if (GV->getAlignment())
969 Out << ", align " << GV->getAlignment();
971 printInfoComment(*GV);
975 void AssemblyWriter::printAlias(const GlobalAlias *GA) {
976 Out << getLLVMName(GA->getName(), GlobalPrefix) << " = ";
977 switch (GA->getVisibility()) {
978 default: assert(0 && "Invalid visibility style!");
979 case GlobalValue::DefaultVisibility: break;
980 case GlobalValue::HiddenVisibility: Out << "hidden "; break;
981 case GlobalValue::ProtectedVisibility: Out << "protected "; break;
986 switch (GA->getLinkage()) {
987 case GlobalValue::WeakLinkage: Out << "weak "; break;
988 case GlobalValue::InternalLinkage: Out << "internal "; break;
989 case GlobalValue::ExternalLinkage: break;
991 assert(0 && "Invalid alias linkage");
994 const Constant *Aliasee = GA->getAliasee();
996 if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(Aliasee)) {
997 printType(GV->getType());
998 Out << " " << getLLVMName(GV->getName(), GlobalPrefix);
999 } else if (const Function *F = dyn_cast<Function>(Aliasee)) {
1000 printType(F->getFunctionType());
1003 if (!F->getName().empty())
1004 Out << getLLVMName(F->getName(), GlobalPrefix);
1008 const ConstantExpr *CE = 0;
1009 if ((CE = dyn_cast<ConstantExpr>(Aliasee)) &&
1010 (CE->getOpcode() == Instruction::BitCast)) {
1011 writeOperand(CE, false);
1013 assert(0 && "Unsupported aliasee");
1016 printInfoComment(*GA);
1020 void AssemblyWriter::printTypeSymbolTable(const TypeSymbolTable &ST) {
1022 for (TypeSymbolTable::const_iterator TI = ST.begin(), TE = ST.end();
1024 Out << "\t" << getLLVMName(TI->first, LocalPrefix) << " = type ";
1026 // Make sure we print out at least one level of the type structure, so
1027 // that we do not get %FILE = type %FILE
1029 printTypeAtLeastOneLevel(TI->second) << "\n";
1033 /// printFunction - Print all aspects of a function.
1035 void AssemblyWriter::printFunction(const Function *F) {
1036 // Print out the return type and name...
1039 if (AnnotationWriter) AnnotationWriter->emitFunctionAnnot(F, Out);
1041 if (F->isDeclaration())
1046 switch (F->getLinkage()) {
1047 case GlobalValue::InternalLinkage: Out << "internal "; break;
1048 case GlobalValue::LinkOnceLinkage: Out << "linkonce "; break;
1049 case GlobalValue::WeakLinkage: Out << "weak "; break;
1050 case GlobalValue::AppendingLinkage: Out << "appending "; break;
1051 case GlobalValue::DLLImportLinkage: Out << "dllimport "; break;
1052 case GlobalValue::DLLExportLinkage: Out << "dllexport "; break;
1053 case GlobalValue::ExternalWeakLinkage: Out << "extern_weak "; break;
1054 case GlobalValue::ExternalLinkage: break;
1055 case GlobalValue::GhostLinkage:
1056 cerr << "GhostLinkage not allowed in AsmWriter!\n";
1059 switch (F->getVisibility()) {
1060 default: assert(0 && "Invalid visibility style!");
1061 case GlobalValue::DefaultVisibility: break;
1062 case GlobalValue::HiddenVisibility: Out << "hidden "; break;
1063 case GlobalValue::ProtectedVisibility: Out << "protected "; break;
1066 // Print the calling convention.
1067 switch (F->getCallingConv()) {
1068 case CallingConv::C: break; // default
1069 case CallingConv::Fast: Out << "fastcc "; break;
1070 case CallingConv::Cold: Out << "coldcc "; break;
1071 case CallingConv::X86_StdCall: Out << "x86_stdcallcc "; break;
1072 case CallingConv::X86_FastCall: Out << "x86_fastcallcc "; break;
1073 default: Out << "cc" << F->getCallingConv() << " "; break;
1076 const FunctionType *FT = F->getFunctionType();
1077 const ParamAttrsList *Attrs = F->getParamAttrs();
1078 printType(F->getReturnType()) << ' ';
1079 if (!F->getName().empty())
1080 Out << getLLVMName(F->getName(), GlobalPrefix);
1084 Machine.incorporateFunction(F);
1086 // Loop over the arguments, printing them...
1089 if (!F->isDeclaration()) {
1090 // If this isn't a declaration, print the argument names as well.
1091 for (Function::const_arg_iterator I = F->arg_begin(), E = F->arg_end();
1093 // Insert commas as we go... the first arg doesn't get a comma
1094 if (I != F->arg_begin()) Out << ", ";
1095 printArgument(I, (Attrs ? Attrs->getParamAttrs(Idx)
1096 : ParamAttr::None));
1100 // Otherwise, print the types from the function type.
1101 for (unsigned i = 0, e = FT->getNumParams(); i != e; ++i) {
1102 // Insert commas as we go... the first arg doesn't get a comma
1106 printType(FT->getParamType(i));
1108 ParameterAttributes ArgAttrs = ParamAttr::None;
1109 if (Attrs) ArgAttrs = Attrs->getParamAttrs(i+1);
1110 if (ArgAttrs != ParamAttr::None)
1111 Out << ' ' << ParamAttrsList::getParamAttrsText(ArgAttrs);
1115 // Finish printing arguments...
1116 if (FT->isVarArg()) {
1117 if (FT->getNumParams()) Out << ", ";
1118 Out << "..."; // Output varargs portion of signature!
1121 if (Attrs && Attrs->getParamAttrs(0) != ParamAttr::None)
1122 Out << ' ' << Attrs->getParamAttrsTextByIndex(0);
1123 if (F->hasSection())
1124 Out << " section \"" << F->getSection() << '"';
1125 if (F->getAlignment())
1126 Out << " align " << F->getAlignment();
1127 if (F->hasCollector())
1128 Out << " gc \"" << F->getCollector() << '"';
1130 if (F->isDeclaration()) {
1135 // Output all of its basic blocks... for the function
1136 for (Function::const_iterator I = F->begin(), E = F->end(); I != E; ++I)
1142 Machine.purgeFunction();
1145 /// printArgument - This member is called for every argument that is passed into
1146 /// the function. Simply print it out
1148 void AssemblyWriter::printArgument(const Argument *Arg,
1149 ParameterAttributes Attrs) {
1151 printType(Arg->getType());
1153 // Output parameter attributes list
1154 if (Attrs != ParamAttr::None)
1155 Out << ' ' << ParamAttrsList::getParamAttrsText(Attrs);
1157 // Output name, if available...
1159 Out << ' ' << getLLVMName(Arg->getName(), LocalPrefix);
1162 /// printBasicBlock - This member is called for each basic block in a method.
1164 void AssemblyWriter::printBasicBlock(const BasicBlock *BB) {
1165 if (BB->hasName()) // Print out the label if it exists...
1166 Out << getLLVMName(BB->getName(), LabelPrefix) << ':';
1168 if (const BasicBlock* unwindDest = BB->getUnwindDest()) {
1172 Out << "unwinds to";
1173 writeOperand(unwindDest, false);
1176 if (!BB->hasName() && !BB->use_empty()) { // Don't print block # of no uses...
1177 Out << "; <label>:";
1178 int Slot = Machine.getLocalSlot(BB);
1185 if (BB->getParent() == 0)
1186 Out << "\t\t; Error: Block without parent!";
1188 if (BB != &BB->getParent()->getEntryBlock()) { // Not the entry block?
1189 // Output predecessors for the block...
1191 pred_const_iterator PI = pred_begin(BB), PE = pred_end(BB);
1194 Out << " No predecessors!";
1197 writeOperand(*PI, false);
1198 for (++PI; PI != PE; ++PI) {
1200 writeOperand(*PI, false);
1206 if (BB->hasName() || !BB->use_empty() || BB->getUnwindDest() ||
1207 BB != &BB->getParent()->getEntryBlock())
1210 if (AnnotationWriter) AnnotationWriter->emitBasicBlockStartAnnot(BB, Out);
1212 // Output all of the instructions in the basic block...
1213 for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I != E; ++I)
1214 printInstruction(*I);
1216 if (AnnotationWriter) AnnotationWriter->emitBasicBlockEndAnnot(BB, Out);
1220 /// printInfoComment - Print a little comment after the instruction indicating
1221 /// which slot it occupies.
1223 void AssemblyWriter::printInfoComment(const Value &V) {
1224 if (V.getType() != Type::VoidTy) {
1226 printType(V.getType()) << '>';
1230 if (const GlobalValue *GV = dyn_cast<GlobalValue>(&V))
1231 SlotNum = Machine.getGlobalSlot(GV);
1233 SlotNum = Machine.getLocalSlot(&V);
1237 Out << ':' << SlotNum; // Print out the def slot taken.
1239 Out << " [#uses=" << V.getNumUses() << ']'; // Output # uses
1243 // This member is called for each Instruction in a function..
1244 void AssemblyWriter::printInstruction(const Instruction &I) {
1245 if (AnnotationWriter) AnnotationWriter->emitInstructionAnnot(&I, Out);
1249 // Print out name if it exists...
1251 Out << getLLVMName(I.getName(), LocalPrefix) << " = ";
1253 // If this is a volatile load or store, print out the volatile marker.
1254 if ((isa<LoadInst>(I) && cast<LoadInst>(I).isVolatile()) ||
1255 (isa<StoreInst>(I) && cast<StoreInst>(I).isVolatile())) {
1257 } else if (isa<CallInst>(I) && cast<CallInst>(I).isTailCall()) {
1258 // If this is a call, check if it's a tail call.
1262 // Print out the opcode...
1263 Out << I.getOpcodeName();
1265 // Print out the compare instruction predicates
1266 if (const FCmpInst *FCI = dyn_cast<FCmpInst>(&I)) {
1267 Out << " " << getPredicateText(FCI->getPredicate());
1268 } else if (const ICmpInst *ICI = dyn_cast<ICmpInst>(&I)) {
1269 Out << " " << getPredicateText(ICI->getPredicate());
1272 // Print out the type of the operands...
1273 const Value *Operand = I.getNumOperands() ? I.getOperand(0) : 0;
1275 // Special case conditional branches to swizzle the condition out to the front
1276 if (isa<BranchInst>(I) && I.getNumOperands() > 1) {
1277 writeOperand(I.getOperand(2), true);
1279 writeOperand(Operand, true);
1281 writeOperand(I.getOperand(1), true);
1283 } else if (isa<SwitchInst>(I)) {
1284 // Special case switch statement to get formatting nice and correct...
1285 writeOperand(Operand , true); Out << ',';
1286 writeOperand(I.getOperand(1), true); Out << " [";
1288 for (unsigned op = 2, Eop = I.getNumOperands(); op < Eop; op += 2) {
1290 writeOperand(I.getOperand(op ), true); Out << ',';
1291 writeOperand(I.getOperand(op+1), true);
1294 } else if (isa<PHINode>(I)) {
1296 printType(I.getType());
1299 for (unsigned op = 0, Eop = I.getNumOperands(); op < Eop; op += 2) {
1300 if (op) Out << ", ";
1302 writeOperand(I.getOperand(op ), false); Out << ',';
1303 writeOperand(I.getOperand(op+1), false); Out << " ]";
1305 } else if (const GetResultInst *GRI = dyn_cast<GetResultInst>(&I)) {
1306 writeOperand(I.getOperand(0), true);
1307 Out << ", " << GRI->getIndex();
1308 } else if (isa<ReturnInst>(I) && !Operand) {
1310 } else if (const CallInst *CI = dyn_cast<CallInst>(&I)) {
1311 // Print the calling convention being used.
1312 switch (CI->getCallingConv()) {
1313 case CallingConv::C: break; // default
1314 case CallingConv::Fast: Out << " fastcc"; break;
1315 case CallingConv::Cold: Out << " coldcc"; break;
1316 case CallingConv::X86_StdCall: Out << " x86_stdcallcc"; break;
1317 case CallingConv::X86_FastCall: Out << " x86_fastcallcc"; break;
1318 default: Out << " cc" << CI->getCallingConv(); break;
1321 const PointerType *PTy = cast<PointerType>(Operand->getType());
1322 const FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
1323 const Type *RetTy = FTy->getReturnType();
1324 const ParamAttrsList *PAL = CI->getParamAttrs();
1326 // If possible, print out the short form of the call instruction. We can
1327 // only do this if the first argument is a pointer to a nonvararg function,
1328 // and if the return type is not a pointer to a function.
1330 if (!FTy->isVarArg() &&
1331 (!isa<PointerType>(RetTy) ||
1332 !isa<FunctionType>(cast<PointerType>(RetTy)->getElementType()))) {
1333 Out << ' '; printType(RetTy);
1334 writeOperand(Operand, false);
1336 writeOperand(Operand, true);
1339 for (unsigned op = 1, Eop = I.getNumOperands(); op < Eop; ++op) {
1342 writeParamOperand(I.getOperand(op), PAL ? PAL->getParamAttrs(op) :
1346 if (PAL && PAL->getParamAttrs(0) != ParamAttr::None)
1347 Out << ' ' << PAL->getParamAttrsTextByIndex(0);
1348 } else if (const InvokeInst *II = dyn_cast<InvokeInst>(&I)) {
1349 const PointerType *PTy = cast<PointerType>(Operand->getType());
1350 const FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
1351 const Type *RetTy = FTy->getReturnType();
1352 const ParamAttrsList *PAL = II->getParamAttrs();
1354 // Print the calling convention being used.
1355 switch (II->getCallingConv()) {
1356 case CallingConv::C: break; // default
1357 case CallingConv::Fast: Out << " fastcc"; break;
1358 case CallingConv::Cold: Out << " coldcc"; break;
1359 case CallingConv::X86_StdCall: Out << "x86_stdcallcc "; break;
1360 case CallingConv::X86_FastCall: Out << "x86_fastcallcc "; break;
1361 default: Out << " cc" << II->getCallingConv(); break;
1364 // If possible, print out the short form of the invoke instruction. We can
1365 // only do this if the first argument is a pointer to a nonvararg function,
1366 // and if the return type is not a pointer to a function.
1368 if (!FTy->isVarArg() &&
1369 (!isa<PointerType>(RetTy) ||
1370 !isa<FunctionType>(cast<PointerType>(RetTy)->getElementType()))) {
1371 Out << ' '; printType(RetTy);
1372 writeOperand(Operand, false);
1374 writeOperand(Operand, true);
1378 for (unsigned op = 3, Eop = I.getNumOperands(); op < Eop; ++op) {
1381 writeParamOperand(I.getOperand(op), PAL ? PAL->getParamAttrs(op-2) :
1386 if (PAL && PAL->getParamAttrs(0) != ParamAttr::None)
1387 Out << " " << PAL->getParamAttrsTextByIndex(0);
1388 Out << "\n\t\t\tto";
1389 writeOperand(II->getNormalDest(), true);
1391 writeOperand(II->getUnwindDest(), true);
1393 } else if (const AllocationInst *AI = dyn_cast<AllocationInst>(&I)) {
1395 printType(AI->getType()->getElementType());
1396 if (AI->isArrayAllocation()) {
1398 writeOperand(AI->getArraySize(), true);
1400 if (AI->getAlignment()) {
1401 Out << ", align " << AI->getAlignment();
1403 } else if (isa<CastInst>(I)) {
1404 if (Operand) writeOperand(Operand, true); // Work with broken code
1406 printType(I.getType());
1407 } else if (isa<VAArgInst>(I)) {
1408 if (Operand) writeOperand(Operand, true); // Work with broken code
1410 printType(I.getType());
1411 } else if (Operand) { // Print the normal way...
1413 // PrintAllTypes - Instructions who have operands of all the same type
1414 // omit the type from all but the first operand. If the instruction has
1415 // different type operands (for example br), then they are all printed.
1416 bool PrintAllTypes = false;
1417 const Type *TheType = Operand->getType();
1419 // Select, Store and ShuffleVector always print all types.
1420 if (isa<SelectInst>(I) || isa<StoreInst>(I) || isa<ShuffleVectorInst>(I)
1421 || isa<ReturnInst>(I)) {
1422 PrintAllTypes = true;
1424 for (unsigned i = 1, E = I.getNumOperands(); i != E; ++i) {
1425 Operand = I.getOperand(i);
1426 if (Operand->getType() != TheType) {
1427 PrintAllTypes = true; // We have differing types! Print them all!
1433 if (!PrintAllTypes) {
1438 for (unsigned i = 0, E = I.getNumOperands(); i != E; ++i) {
1440 writeOperand(I.getOperand(i), PrintAllTypes);
1444 // Print post operand alignment for load/store
1445 if (isa<LoadInst>(I) && cast<LoadInst>(I).getAlignment()) {
1446 Out << ", align " << cast<LoadInst>(I).getAlignment();
1447 } else if (isa<StoreInst>(I) && cast<StoreInst>(I).getAlignment()) {
1448 Out << ", align " << cast<StoreInst>(I).getAlignment();
1451 printInfoComment(I);
1456 //===----------------------------------------------------------------------===//
1457 // External Interface declarations
1458 //===----------------------------------------------------------------------===//
1460 void Module::print(std::ostream &o, AssemblyAnnotationWriter *AAW) const {
1461 SlotMachine SlotTable(this);
1462 AssemblyWriter W(o, SlotTable, this, AAW);
1466 void GlobalVariable::print(std::ostream &o) const {
1467 SlotMachine SlotTable(getParent());
1468 AssemblyWriter W(o, SlotTable, getParent(), 0);
1472 void GlobalAlias::print(std::ostream &o) const {
1473 SlotMachine SlotTable(getParent());
1474 AssemblyWriter W(o, SlotTable, getParent(), 0);
1478 void Function::print(std::ostream &o, AssemblyAnnotationWriter *AAW) const {
1479 SlotMachine SlotTable(getParent());
1480 AssemblyWriter W(o, SlotTable, getParent(), AAW);
1485 void InlineAsm::print(std::ostream &o, AssemblyAnnotationWriter *AAW) const {
1486 WriteAsOperand(o, this, true, 0);
1489 void BasicBlock::print(std::ostream &o, AssemblyAnnotationWriter *AAW) const {
1490 SlotMachine SlotTable(getParent());
1491 AssemblyWriter W(o, SlotTable,
1492 getParent() ? getParent()->getParent() : 0, AAW);
1496 void Instruction::print(std::ostream &o, AssemblyAnnotationWriter *AAW) const {
1497 const Function *F = getParent() ? getParent()->getParent() : 0;
1498 SlotMachine SlotTable(F);
1499 AssemblyWriter W(o, SlotTable, F ? F->getParent() : 0, AAW);
1504 void Constant::print(std::ostream &o) const {
1505 if (this == 0) { o << "<null> constant value\n"; return; }
1507 o << ' ' << getType()->getDescription() << ' ';
1509 std::map<const Type *, std::string> TypeTable;
1510 WriteConstantInt(o, this, TypeTable, 0);
1513 void Type::print(std::ostream &o) const {
1517 o << getDescription();
1520 void Argument::print(std::ostream &o) const {
1521 WriteAsOperand(o, this, true, getParent() ? getParent()->getParent() : 0);
1524 // Value::dump - allow easy printing of Values from the debugger.
1525 // Located here because so much of the needed functionality is here.
1526 void Value::dump() const { print(*cerr.stream()); cerr << '\n'; }
1528 // Type::dump - allow easy printing of Values from the debugger.
1529 // Located here because so much of the needed functionality is here.
1530 void Type::dump() const { print(*cerr.stream()); cerr << '\n'; }
1533 ParamAttrsList::dump() const {
1535 for (unsigned i = 0; i < attrs.size(); ++i) {
1536 uint16_t index = getParamIndex(i);
1537 ParameterAttributes attrs = getParamAttrs(index);
1538 cerr << "{" << index << "," << attrs << "} ";
1544 //===----------------------------------------------------------------------===//
1545 // SlotMachine Implementation
1546 //===----------------------------------------------------------------------===//
1549 #define SC_DEBUG(X) cerr << X
1554 // Module level constructor. Causes the contents of the Module (sans functions)
1555 // to be added to the slot table.
1556 SlotMachine::SlotMachine(const Module *M)
1557 : TheModule(M) ///< Saved for lazy initialization.
1559 , FunctionProcessed(false)
1560 , mMap(), mNext(0), fMap(), fNext(0)
1564 // Function level constructor. Causes the contents of the Module and the one
1565 // function provided to be added to the slot table.
1566 SlotMachine::SlotMachine(const Function *F)
1567 : TheModule(F ? F->getParent() : 0) ///< Saved for lazy initialization
1568 , TheFunction(F) ///< Saved for lazy initialization
1569 , FunctionProcessed(false)
1570 , mMap(), mNext(0), fMap(), fNext(0)
1574 inline void SlotMachine::initialize() {
1577 TheModule = 0; ///< Prevent re-processing next time we're called.
1579 if (TheFunction && !FunctionProcessed)
1583 // Iterate through all the global variables, functions, and global
1584 // variable initializers and create slots for them.
1585 void SlotMachine::processModule() {
1586 SC_DEBUG("begin processModule!\n");
1588 // Add all of the unnamed global variables to the value table.
1589 for (Module::const_global_iterator I = TheModule->global_begin(),
1590 E = TheModule->global_end(); I != E; ++I)
1592 CreateModuleSlot(I);
1594 // Add all the unnamed functions to the table.
1595 for (Module::const_iterator I = TheModule->begin(), E = TheModule->end();
1598 CreateModuleSlot(I);
1600 SC_DEBUG("end processModule!\n");
1604 // Process the arguments, basic blocks, and instructions of a function.
1605 void SlotMachine::processFunction() {
1606 SC_DEBUG("begin processFunction!\n");
1609 // Add all the function arguments with no names.
1610 for(Function::const_arg_iterator AI = TheFunction->arg_begin(),
1611 AE = TheFunction->arg_end(); AI != AE; ++AI)
1613 CreateFunctionSlot(AI);
1615 SC_DEBUG("Inserting Instructions:\n");
1617 // Add all of the basic blocks and instructions with no names.
1618 for (Function::const_iterator BB = TheFunction->begin(),
1619 E = TheFunction->end(); BB != E; ++BB) {
1621 CreateFunctionSlot(BB);
1622 for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I != E; ++I)
1623 if (I->getType() != Type::VoidTy && !I->hasName())
1624 CreateFunctionSlot(I);
1627 FunctionProcessed = true;
1629 SC_DEBUG("end processFunction!\n");
1632 /// Clean up after incorporating a function. This is the only way to get out of
1633 /// the function incorporation state that affects get*Slot/Create*Slot. Function
1634 /// incorporation state is indicated by TheFunction != 0.
1635 void SlotMachine::purgeFunction() {
1636 SC_DEBUG("begin purgeFunction!\n");
1637 fMap.clear(); // Simply discard the function level map
1639 FunctionProcessed = false;
1640 SC_DEBUG("end purgeFunction!\n");
1643 /// getGlobalSlot - Get the slot number of a global value.
1644 int SlotMachine::getGlobalSlot(const GlobalValue *V) {
1645 // Check for uninitialized state and do lazy initialization.
1648 // Find the type plane in the module map
1649 ValueMap::const_iterator MI = mMap.find(V);
1650 if (MI == mMap.end()) return -1;
1656 /// getLocalSlot - Get the slot number for a value that is local to a function.
1657 int SlotMachine::getLocalSlot(const Value *V) {
1658 assert(!isa<Constant>(V) && "Can't get a constant or global slot with this!");
1660 // Check for uninitialized state and do lazy initialization.
1663 ValueMap::const_iterator FI = fMap.find(V);
1664 if (FI == fMap.end()) return -1;
1670 /// CreateModuleSlot - Insert the specified GlobalValue* into the slot table.
1671 void SlotMachine::CreateModuleSlot(const GlobalValue *V) {
1672 assert(V && "Can't insert a null Value into SlotMachine!");
1673 assert(V->getType() != Type::VoidTy && "Doesn't need a slot!");
1674 assert(!V->hasName() && "Doesn't need a slot!");
1676 unsigned DestSlot = mNext++;
1679 SC_DEBUG(" Inserting value [" << V->getType() << "] = " << V << " slot=" <<
1681 // G = Global, F = Function, A = Alias, o = other
1682 SC_DEBUG((isa<GlobalVariable>(V) ? 'G' :
1683 (isa<Function> ? 'F' :
1684 (isa<GlobalAlias> ? 'A' : 'o'))) << "]\n");
1688 /// CreateSlot - Create a new slot for the specified value if it has no name.
1689 void SlotMachine::CreateFunctionSlot(const Value *V) {
1690 const Type *VTy = V->getType();
1691 assert(VTy != Type::VoidTy && !V->hasName() && "Doesn't need a slot!");
1693 unsigned DestSlot = fNext++;
1696 // G = Global, F = Function, o = other
1697 SC_DEBUG(" Inserting value [" << VTy << "] = " << V << " slot=" <<
1698 DestSlot << " [o]\n");