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/ParameterAttributes.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, uint16_t 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, uint16_t ParamAttrs);
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, uint16_t Attrs) {
844 Out << "<null operand!>";
848 printType(Operand->getType());
849 // Print parameter attributes list
850 if (Attrs != ParamAttr::None)
851 Out << ' ' << ParamAttrsList::getParamAttrsText(Attrs);
853 WriteAsOperandInternal(Out, Operand, TypeNames, &Machine);
857 void AssemblyWriter::printModule(const Module *M) {
858 if (!M->getModuleIdentifier().empty() &&
859 // Don't print the ID if it will start a new line (which would
860 // require a comment char before it).
861 M->getModuleIdentifier().find('\n') == std::string::npos)
862 Out << "; ModuleID = '" << M->getModuleIdentifier() << "'\n";
864 if (!M->getDataLayout().empty())
865 Out << "target datalayout = \"" << M->getDataLayout() << "\"\n";
866 if (!M->getTargetTriple().empty())
867 Out << "target triple = \"" << M->getTargetTriple() << "\"\n";
869 if (!M->getModuleInlineAsm().empty()) {
870 // Split the string into lines, to make it easier to read the .ll file.
871 std::string Asm = M->getModuleInlineAsm();
873 size_t NewLine = Asm.find_first_of('\n', CurPos);
874 while (NewLine != std::string::npos) {
875 // We found a newline, print the portion of the asm string from the
876 // last newline up to this newline.
877 Out << "module asm \"";
878 PrintEscapedString(std::string(Asm.begin()+CurPos, Asm.begin()+NewLine),
882 NewLine = Asm.find_first_of('\n', CurPos);
884 Out << "module asm \"";
885 PrintEscapedString(std::string(Asm.begin()+CurPos, Asm.end()), Out);
889 // Loop over the dependent libraries and emit them.
890 Module::lib_iterator LI = M->lib_begin();
891 Module::lib_iterator LE = M->lib_end();
893 Out << "deplibs = [ ";
895 Out << '"' << *LI << '"';
903 // Loop over the symbol table, emitting all named constants.
904 printTypeSymbolTable(M->getTypeSymbolTable());
906 for (Module::const_global_iterator I = M->global_begin(), E = M->global_end();
910 // Output all aliases.
911 if (!M->alias_empty()) Out << "\n";
912 for (Module::const_alias_iterator I = M->alias_begin(), E = M->alias_end();
916 // Output all of the functions.
917 for (Module::const_iterator I = M->begin(), E = M->end(); I != E; ++I)
921 void AssemblyWriter::printGlobal(const GlobalVariable *GV) {
922 if (GV->hasName()) Out << getLLVMName(GV->getName(), GlobalPrefix) << " = ";
924 if (!GV->hasInitializer()) {
925 switch (GV->getLinkage()) {
926 case GlobalValue::DLLImportLinkage: Out << "dllimport "; break;
927 case GlobalValue::ExternalWeakLinkage: Out << "extern_weak "; break;
928 default: Out << "external "; break;
931 switch (GV->getLinkage()) {
932 case GlobalValue::InternalLinkage: Out << "internal "; break;
933 case GlobalValue::LinkOnceLinkage: Out << "linkonce "; break;
934 case GlobalValue::WeakLinkage: Out << "weak "; break;
935 case GlobalValue::AppendingLinkage: Out << "appending "; break;
936 case GlobalValue::DLLImportLinkage: Out << "dllimport "; break;
937 case GlobalValue::DLLExportLinkage: Out << "dllexport "; break;
938 case GlobalValue::ExternalWeakLinkage: Out << "extern_weak "; break;
939 case GlobalValue::ExternalLinkage: break;
940 case GlobalValue::GhostLinkage:
941 cerr << "GhostLinkage not allowed in AsmWriter!\n";
944 switch (GV->getVisibility()) {
945 default: assert(0 && "Invalid visibility style!");
946 case GlobalValue::DefaultVisibility: break;
947 case GlobalValue::HiddenVisibility: Out << "hidden "; break;
948 case GlobalValue::ProtectedVisibility: Out << "protected "; break;
952 if (GV->isThreadLocal()) Out << "thread_local ";
953 Out << (GV->isConstant() ? "constant " : "global ");
954 printType(GV->getType()->getElementType());
956 if (GV->hasInitializer()) {
957 Constant* C = cast<Constant>(GV->getInitializer());
958 assert(C && "GlobalVar initializer isn't constant?");
959 writeOperand(GV->getInitializer(), false);
962 if (unsigned AddressSpace = GV->getType()->getAddressSpace())
963 Out << " addrspace(" << AddressSpace << ") ";
965 if (GV->hasSection())
966 Out << ", section \"" << GV->getSection() << '"';
967 if (GV->getAlignment())
968 Out << ", align " << GV->getAlignment();
970 printInfoComment(*GV);
974 void AssemblyWriter::printAlias(const GlobalAlias *GA) {
975 Out << getLLVMName(GA->getName(), GlobalPrefix) << " = ";
976 switch (GA->getVisibility()) {
977 default: assert(0 && "Invalid visibility style!");
978 case GlobalValue::DefaultVisibility: break;
979 case GlobalValue::HiddenVisibility: Out << "hidden "; break;
980 case GlobalValue::ProtectedVisibility: Out << "protected "; break;
985 switch (GA->getLinkage()) {
986 case GlobalValue::WeakLinkage: Out << "weak "; break;
987 case GlobalValue::InternalLinkage: Out << "internal "; break;
988 case GlobalValue::ExternalLinkage: break;
990 assert(0 && "Invalid alias linkage");
993 const Constant *Aliasee = GA->getAliasee();
995 if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(Aliasee)) {
996 printType(GV->getType());
997 Out << " " << getLLVMName(GV->getName(), GlobalPrefix);
998 } else if (const Function *F = dyn_cast<Function>(Aliasee)) {
999 printType(F->getFunctionType());
1002 if (!F->getName().empty())
1003 Out << getLLVMName(F->getName(), GlobalPrefix);
1007 const ConstantExpr *CE = 0;
1008 if ((CE = dyn_cast<ConstantExpr>(Aliasee)) &&
1009 (CE->getOpcode() == Instruction::BitCast)) {
1010 writeOperand(CE, false);
1012 assert(0 && "Unsupported aliasee");
1015 printInfoComment(*GA);
1019 void AssemblyWriter::printTypeSymbolTable(const TypeSymbolTable &ST) {
1021 for (TypeSymbolTable::const_iterator TI = ST.begin(), TE = ST.end();
1023 Out << "\t" << getLLVMName(TI->first, LocalPrefix) << " = type ";
1025 // Make sure we print out at least one level of the type structure, so
1026 // that we do not get %FILE = type %FILE
1028 printTypeAtLeastOneLevel(TI->second) << "\n";
1032 /// printFunction - Print all aspects of a function.
1034 void AssemblyWriter::printFunction(const Function *F) {
1035 // Print out the return type and name...
1038 if (AnnotationWriter) AnnotationWriter->emitFunctionAnnot(F, Out);
1040 if (F->isDeclaration())
1045 switch (F->getLinkage()) {
1046 case GlobalValue::InternalLinkage: Out << "internal "; break;
1047 case GlobalValue::LinkOnceLinkage: Out << "linkonce "; break;
1048 case GlobalValue::WeakLinkage: Out << "weak "; break;
1049 case GlobalValue::AppendingLinkage: Out << "appending "; break;
1050 case GlobalValue::DLLImportLinkage: Out << "dllimport "; break;
1051 case GlobalValue::DLLExportLinkage: Out << "dllexport "; break;
1052 case GlobalValue::ExternalWeakLinkage: Out << "extern_weak "; break;
1053 case GlobalValue::ExternalLinkage: break;
1054 case GlobalValue::GhostLinkage:
1055 cerr << "GhostLinkage not allowed in AsmWriter!\n";
1058 switch (F->getVisibility()) {
1059 default: assert(0 && "Invalid visibility style!");
1060 case GlobalValue::DefaultVisibility: break;
1061 case GlobalValue::HiddenVisibility: Out << "hidden "; break;
1062 case GlobalValue::ProtectedVisibility: Out << "protected "; break;
1065 // Print the calling convention.
1066 switch (F->getCallingConv()) {
1067 case CallingConv::C: break; // default
1068 case CallingConv::Fast: Out << "fastcc "; break;
1069 case CallingConv::Cold: Out << "coldcc "; break;
1070 case CallingConv::X86_StdCall: Out << "x86_stdcallcc "; break;
1071 case CallingConv::X86_FastCall: Out << "x86_fastcallcc "; break;
1072 default: Out << "cc" << F->getCallingConv() << " "; break;
1075 const FunctionType *FT = F->getFunctionType();
1076 const ParamAttrsList *Attrs = F->getParamAttrs();
1077 printType(F->getReturnType()) << ' ';
1078 if (!F->getName().empty())
1079 Out << getLLVMName(F->getName(), GlobalPrefix);
1083 Machine.incorporateFunction(F);
1085 // Loop over the arguments, printing them...
1088 if (!F->isDeclaration()) {
1089 // If this isn't a declaration, print the argument names as well.
1090 for (Function::const_arg_iterator I = F->arg_begin(), E = F->arg_end();
1092 // Insert commas as we go... the first arg doesn't get a comma
1093 if (I != F->arg_begin()) Out << ", ";
1094 printArgument(I, (Attrs ? Attrs->getParamAttrs(Idx)
1095 : uint16_t(ParamAttr::None)));
1099 // Otherwise, print the types from the function type.
1100 for (unsigned i = 0, e = FT->getNumParams(); i != e; ++i) {
1101 // Insert commas as we go... the first arg doesn't get a comma
1105 printType(FT->getParamType(i));
1107 unsigned ArgAttrs = ParamAttr::None;
1108 if (Attrs) ArgAttrs = Attrs->getParamAttrs(i+1);
1109 if (ArgAttrs != ParamAttr::None)
1110 Out << ' ' << ParamAttrsList::getParamAttrsText(ArgAttrs);
1114 // Finish printing arguments...
1115 if (FT->isVarArg()) {
1116 if (FT->getNumParams()) Out << ", ";
1117 Out << "..."; // Output varargs portion of signature!
1120 if (Attrs && Attrs->getParamAttrs(0) != ParamAttr::None)
1121 Out << ' ' << Attrs->getParamAttrsTextByIndex(0);
1122 if (F->hasSection())
1123 Out << " section \"" << F->getSection() << '"';
1124 if (F->getAlignment())
1125 Out << " align " << F->getAlignment();
1126 if (F->hasCollector())
1127 Out << " gc \"" << F->getCollector() << '"';
1129 if (F->isDeclaration()) {
1134 // Output all of its basic blocks... for the function
1135 for (Function::const_iterator I = F->begin(), E = F->end(); I != E; ++I)
1141 Machine.purgeFunction();
1144 /// printArgument - This member is called for every argument that is passed into
1145 /// the function. Simply print it out
1147 void AssemblyWriter::printArgument(const Argument *Arg, uint16_t Attrs) {
1149 printType(Arg->getType());
1151 // Output parameter attributes list
1152 if (Attrs != ParamAttr::None)
1153 Out << ' ' << ParamAttrsList::getParamAttrsText(Attrs);
1155 // Output name, if available...
1157 Out << ' ' << getLLVMName(Arg->getName(), LocalPrefix);
1160 /// printBasicBlock - This member is called for each basic block in a method.
1162 void AssemblyWriter::printBasicBlock(const BasicBlock *BB) {
1163 if (BB->hasName()) { // Print out the label if it exists...
1164 Out << "\n" << getLLVMName(BB->getName(), LabelPrefix) << ':';
1165 } else if (!BB->use_empty()) { // Don't print block # of no uses...
1166 Out << "\n; <label>:";
1167 int Slot = Machine.getLocalSlot(BB);
1174 if (BB->getParent() == 0)
1175 Out << "\t\t; Error: Block without parent!";
1177 if (BB != &BB->getParent()->getEntryBlock()) { // Not the entry block?
1178 // Output predecessors for the block...
1180 pred_const_iterator PI = pred_begin(BB), PE = pred_end(BB);
1183 Out << " No predecessors!";
1186 writeOperand(*PI, false);
1187 for (++PI; PI != PE; ++PI) {
1189 writeOperand(*PI, false);
1197 if (AnnotationWriter) AnnotationWriter->emitBasicBlockStartAnnot(BB, Out);
1199 // Output all of the instructions in the basic block...
1200 for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I != E; ++I)
1201 printInstruction(*I);
1203 if (AnnotationWriter) AnnotationWriter->emitBasicBlockEndAnnot(BB, Out);
1207 /// printInfoComment - Print a little comment after the instruction indicating
1208 /// which slot it occupies.
1210 void AssemblyWriter::printInfoComment(const Value &V) {
1211 if (V.getType() != Type::VoidTy) {
1213 printType(V.getType()) << '>';
1217 if (const GlobalValue *GV = dyn_cast<GlobalValue>(&V))
1218 SlotNum = Machine.getGlobalSlot(GV);
1220 SlotNum = Machine.getLocalSlot(&V);
1224 Out << ':' << SlotNum; // Print out the def slot taken.
1226 Out << " [#uses=" << V.getNumUses() << ']'; // Output # uses
1230 // This member is called for each Instruction in a function..
1231 void AssemblyWriter::printInstruction(const Instruction &I) {
1232 if (AnnotationWriter) AnnotationWriter->emitInstructionAnnot(&I, Out);
1236 // Print out name if it exists...
1238 Out << getLLVMName(I.getName(), LocalPrefix) << " = ";
1240 // If this is a volatile load or store, print out the volatile marker.
1241 if ((isa<LoadInst>(I) && cast<LoadInst>(I).isVolatile()) ||
1242 (isa<StoreInst>(I) && cast<StoreInst>(I).isVolatile())) {
1244 } else if (isa<CallInst>(I) && cast<CallInst>(I).isTailCall()) {
1245 // If this is a call, check if it's a tail call.
1249 // Print out the opcode...
1250 Out << I.getOpcodeName();
1252 // Print out the compare instruction predicates
1253 if (const FCmpInst *FCI = dyn_cast<FCmpInst>(&I)) {
1254 Out << " " << getPredicateText(FCI->getPredicate());
1255 } else if (const ICmpInst *ICI = dyn_cast<ICmpInst>(&I)) {
1256 Out << " " << getPredicateText(ICI->getPredicate());
1259 // Print out the type of the operands...
1260 const Value *Operand = I.getNumOperands() ? I.getOperand(0) : 0;
1262 // Special case conditional branches to swizzle the condition out to the front
1263 if (isa<BranchInst>(I) && I.getNumOperands() > 1) {
1264 writeOperand(I.getOperand(2), true);
1266 writeOperand(Operand, true);
1268 writeOperand(I.getOperand(1), true);
1270 } else if (isa<SwitchInst>(I)) {
1271 // Special case switch statement to get formatting nice and correct...
1272 writeOperand(Operand , true); Out << ',';
1273 writeOperand(I.getOperand(1), true); Out << " [";
1275 for (unsigned op = 2, Eop = I.getNumOperands(); op < Eop; op += 2) {
1277 writeOperand(I.getOperand(op ), true); Out << ',';
1278 writeOperand(I.getOperand(op+1), true);
1281 } else if (isa<PHINode>(I)) {
1283 printType(I.getType());
1286 for (unsigned op = 0, Eop = I.getNumOperands(); op < Eop; op += 2) {
1287 if (op) Out << ", ";
1289 writeOperand(I.getOperand(op ), false); Out << ',';
1290 writeOperand(I.getOperand(op+1), false); Out << " ]";
1292 } else if (isa<ReturnInst>(I) && !Operand) {
1294 } else if (const CallInst *CI = dyn_cast<CallInst>(&I)) {
1295 // Print the calling convention being used.
1296 switch (CI->getCallingConv()) {
1297 case CallingConv::C: break; // default
1298 case CallingConv::Fast: Out << " fastcc"; break;
1299 case CallingConv::Cold: Out << " coldcc"; break;
1300 case CallingConv::X86_StdCall: Out << " x86_stdcallcc"; break;
1301 case CallingConv::X86_FastCall: Out << " x86_fastcallcc"; break;
1302 default: Out << " cc" << CI->getCallingConv(); break;
1305 const PointerType *PTy = cast<PointerType>(Operand->getType());
1306 const FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
1307 const Type *RetTy = FTy->getReturnType();
1308 const ParamAttrsList *PAL = CI->getParamAttrs();
1310 // If possible, print out the short form of the call instruction. We can
1311 // only do this if the first argument is a pointer to a nonvararg function,
1312 // and if the return type is not a pointer to a function.
1314 if (!FTy->isVarArg() &&
1315 (!isa<PointerType>(RetTy) ||
1316 !isa<FunctionType>(cast<PointerType>(RetTy)->getElementType()))) {
1317 Out << ' '; printType(RetTy);
1318 writeOperand(Operand, false);
1320 writeOperand(Operand, true);
1323 for (unsigned op = 1, Eop = I.getNumOperands(); op < Eop; ++op) {
1326 writeParamOperand(I.getOperand(op), PAL ? PAL->getParamAttrs(op) : 0);
1329 if (PAL && PAL->getParamAttrs(0) != ParamAttr::None)
1330 Out << ' ' << PAL->getParamAttrsTextByIndex(0);
1331 } else if (const InvokeInst *II = dyn_cast<InvokeInst>(&I)) {
1332 const PointerType *PTy = cast<PointerType>(Operand->getType());
1333 const FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
1334 const Type *RetTy = FTy->getReturnType();
1335 const ParamAttrsList *PAL = II->getParamAttrs();
1337 // Print the calling convention being used.
1338 switch (II->getCallingConv()) {
1339 case CallingConv::C: break; // default
1340 case CallingConv::Fast: Out << " fastcc"; break;
1341 case CallingConv::Cold: Out << " coldcc"; break;
1342 case CallingConv::X86_StdCall: Out << "x86_stdcallcc "; break;
1343 case CallingConv::X86_FastCall: Out << "x86_fastcallcc "; break;
1344 default: Out << " cc" << II->getCallingConv(); break;
1347 // If possible, print out the short form of the invoke instruction. We can
1348 // only do this if the first argument is a pointer to a nonvararg function,
1349 // and if the return type is not a pointer to a function.
1351 if (!FTy->isVarArg() &&
1352 (!isa<PointerType>(RetTy) ||
1353 !isa<FunctionType>(cast<PointerType>(RetTy)->getElementType()))) {
1354 Out << ' '; printType(RetTy);
1355 writeOperand(Operand, false);
1357 writeOperand(Operand, true);
1361 for (unsigned op = 3, Eop = I.getNumOperands(); op < Eop; ++op) {
1364 writeParamOperand(I.getOperand(op), PAL ? PAL->getParamAttrs(op-2) : 0);
1368 if (PAL && PAL->getParamAttrs(0) != ParamAttr::None)
1369 Out << " " << PAL->getParamAttrsTextByIndex(0);
1370 Out << "\n\t\t\tto";
1371 writeOperand(II->getNormalDest(), true);
1373 writeOperand(II->getUnwindDest(), true);
1375 } else if (const AllocationInst *AI = dyn_cast<AllocationInst>(&I)) {
1377 printType(AI->getType()->getElementType());
1378 if (AI->isArrayAllocation()) {
1380 writeOperand(AI->getArraySize(), true);
1382 if (AI->getAlignment()) {
1383 Out << ", align " << AI->getAlignment();
1385 } else if (isa<CastInst>(I)) {
1386 if (Operand) writeOperand(Operand, true); // Work with broken code
1388 printType(I.getType());
1389 } else if (isa<VAArgInst>(I)) {
1390 if (Operand) writeOperand(Operand, true); // Work with broken code
1392 printType(I.getType());
1393 } else if (Operand) { // Print the normal way...
1395 // PrintAllTypes - Instructions who have operands of all the same type
1396 // omit the type from all but the first operand. If the instruction has
1397 // different type operands (for example br), then they are all printed.
1398 bool PrintAllTypes = false;
1399 const Type *TheType = Operand->getType();
1401 // Select, Store and ShuffleVector always print all types.
1402 if (isa<SelectInst>(I) || isa<StoreInst>(I) || isa<ShuffleVectorInst>(I)) {
1403 PrintAllTypes = true;
1405 for (unsigned i = 1, E = I.getNumOperands(); i != E; ++i) {
1406 Operand = I.getOperand(i);
1407 if (Operand->getType() != TheType) {
1408 PrintAllTypes = true; // We have differing types! Print them all!
1414 if (!PrintAllTypes) {
1419 for (unsigned i = 0, E = I.getNumOperands(); i != E; ++i) {
1421 writeOperand(I.getOperand(i), PrintAllTypes);
1425 // Print post operand alignment for load/store
1426 if (isa<LoadInst>(I) && cast<LoadInst>(I).getAlignment()) {
1427 Out << ", align " << cast<LoadInst>(I).getAlignment();
1428 } else if (isa<StoreInst>(I) && cast<StoreInst>(I).getAlignment()) {
1429 Out << ", align " << cast<StoreInst>(I).getAlignment();
1432 printInfoComment(I);
1437 //===----------------------------------------------------------------------===//
1438 // External Interface declarations
1439 //===----------------------------------------------------------------------===//
1441 void Module::print(std::ostream &o, AssemblyAnnotationWriter *AAW) const {
1442 SlotMachine SlotTable(this);
1443 AssemblyWriter W(o, SlotTable, this, AAW);
1447 void GlobalVariable::print(std::ostream &o) const {
1448 SlotMachine SlotTable(getParent());
1449 AssemblyWriter W(o, SlotTable, getParent(), 0);
1453 void GlobalAlias::print(std::ostream &o) const {
1454 SlotMachine SlotTable(getParent());
1455 AssemblyWriter W(o, SlotTable, getParent(), 0);
1459 void Function::print(std::ostream &o, AssemblyAnnotationWriter *AAW) const {
1460 SlotMachine SlotTable(getParent());
1461 AssemblyWriter W(o, SlotTable, getParent(), AAW);
1466 void InlineAsm::print(std::ostream &o, AssemblyAnnotationWriter *AAW) const {
1467 WriteAsOperand(o, this, true, 0);
1470 void BasicBlock::print(std::ostream &o, AssemblyAnnotationWriter *AAW) const {
1471 SlotMachine SlotTable(getParent());
1472 AssemblyWriter W(o, SlotTable,
1473 getParent() ? getParent()->getParent() : 0, AAW);
1477 void Instruction::print(std::ostream &o, AssemblyAnnotationWriter *AAW) const {
1478 const Function *F = getParent() ? getParent()->getParent() : 0;
1479 SlotMachine SlotTable(F);
1480 AssemblyWriter W(o, SlotTable, F ? F->getParent() : 0, AAW);
1485 void Constant::print(std::ostream &o) const {
1486 if (this == 0) { o << "<null> constant value\n"; return; }
1488 o << ' ' << getType()->getDescription() << ' ';
1490 std::map<const Type *, std::string> TypeTable;
1491 WriteConstantInt(o, this, TypeTable, 0);
1494 void Type::print(std::ostream &o) const {
1498 o << getDescription();
1501 void Argument::print(std::ostream &o) const {
1502 WriteAsOperand(o, this, true, getParent() ? getParent()->getParent() : 0);
1505 // Value::dump - allow easy printing of Values from the debugger.
1506 // Located here because so much of the needed functionality is here.
1507 void Value::dump() const { print(*cerr.stream()); cerr << '\n'; }
1509 // Type::dump - allow easy printing of Values from the debugger.
1510 // Located here because so much of the needed functionality is here.
1511 void Type::dump() const { print(*cerr.stream()); cerr << '\n'; }
1514 ParamAttrsList::dump() const {
1516 for (unsigned i = 0; i < attrs.size(); ++i) {
1517 uint16_t index = getParamIndex(i);
1518 uint16_t attrs = getParamAttrs(index);
1519 cerr << "{" << index << "," << attrs << "} ";
1524 //===----------------------------------------------------------------------===//
1525 // SlotMachine Implementation
1526 //===----------------------------------------------------------------------===//
1529 #define SC_DEBUG(X) cerr << X
1534 // Module level constructor. Causes the contents of the Module (sans functions)
1535 // to be added to the slot table.
1536 SlotMachine::SlotMachine(const Module *M)
1537 : TheModule(M) ///< Saved for lazy initialization.
1539 , FunctionProcessed(false)
1540 , mMap(), mNext(0), fMap(), fNext(0)
1544 // Function level constructor. Causes the contents of the Module and the one
1545 // function provided to be added to the slot table.
1546 SlotMachine::SlotMachine(const Function *F)
1547 : TheModule(F ? F->getParent() : 0) ///< Saved for lazy initialization
1548 , TheFunction(F) ///< Saved for lazy initialization
1549 , FunctionProcessed(false)
1550 , mMap(), mNext(0), fMap(), fNext(0)
1554 inline void SlotMachine::initialize() {
1557 TheModule = 0; ///< Prevent re-processing next time we're called.
1559 if (TheFunction && !FunctionProcessed)
1563 // Iterate through all the global variables, functions, and global
1564 // variable initializers and create slots for them.
1565 void SlotMachine::processModule() {
1566 SC_DEBUG("begin processModule!\n");
1568 // Add all of the unnamed global variables to the value table.
1569 for (Module::const_global_iterator I = TheModule->global_begin(),
1570 E = TheModule->global_end(); I != E; ++I)
1572 CreateModuleSlot(I);
1574 // Add all the unnamed functions to the table.
1575 for (Module::const_iterator I = TheModule->begin(), E = TheModule->end();
1578 CreateModuleSlot(I);
1580 SC_DEBUG("end processModule!\n");
1584 // Process the arguments, basic blocks, and instructions of a function.
1585 void SlotMachine::processFunction() {
1586 SC_DEBUG("begin processFunction!\n");
1589 // Add all the function arguments with no names.
1590 for(Function::const_arg_iterator AI = TheFunction->arg_begin(),
1591 AE = TheFunction->arg_end(); AI != AE; ++AI)
1593 CreateFunctionSlot(AI);
1595 SC_DEBUG("Inserting Instructions:\n");
1597 // Add all of the basic blocks and instructions with no names.
1598 for (Function::const_iterator BB = TheFunction->begin(),
1599 E = TheFunction->end(); BB != E; ++BB) {
1601 CreateFunctionSlot(BB);
1602 for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I != E; ++I)
1603 if (I->getType() != Type::VoidTy && !I->hasName())
1604 CreateFunctionSlot(I);
1607 FunctionProcessed = true;
1609 SC_DEBUG("end processFunction!\n");
1612 /// Clean up after incorporating a function. This is the only way to get out of
1613 /// the function incorporation state that affects get*Slot/Create*Slot. Function
1614 /// incorporation state is indicated by TheFunction != 0.
1615 void SlotMachine::purgeFunction() {
1616 SC_DEBUG("begin purgeFunction!\n");
1617 fMap.clear(); // Simply discard the function level map
1619 FunctionProcessed = false;
1620 SC_DEBUG("end purgeFunction!\n");
1623 /// getGlobalSlot - Get the slot number of a global value.
1624 int SlotMachine::getGlobalSlot(const GlobalValue *V) {
1625 // Check for uninitialized state and do lazy initialization.
1628 // Find the type plane in the module map
1629 ValueMap::const_iterator MI = mMap.find(V);
1630 if (MI == mMap.end()) return -1;
1636 /// getLocalSlot - Get the slot number for a value that is local to a function.
1637 int SlotMachine::getLocalSlot(const Value *V) {
1638 assert(!isa<Constant>(V) && "Can't get a constant or global slot with this!");
1640 // Check for uninitialized state and do lazy initialization.
1643 ValueMap::const_iterator FI = fMap.find(V);
1644 if (FI == fMap.end()) return -1;
1650 /// CreateModuleSlot - Insert the specified GlobalValue* into the slot table.
1651 void SlotMachine::CreateModuleSlot(const GlobalValue *V) {
1652 assert(V && "Can't insert a null Value into SlotMachine!");
1653 assert(V->getType() != Type::VoidTy && "Doesn't need a slot!");
1654 assert(!V->hasName() && "Doesn't need a slot!");
1656 unsigned DestSlot = mNext++;
1659 SC_DEBUG(" Inserting value [" << V->getType() << "] = " << V << " slot=" <<
1661 // G = Global, F = Function, A = Alias, o = other
1662 SC_DEBUG((isa<GlobalVariable>(V) ? 'G' :
1663 (isa<Function> ? 'F' :
1664 (isa<GlobalAlias> ? 'A' : 'o'))) << "]\n");
1668 /// CreateSlot - Create a new slot for the specified value if it has no name.
1669 void SlotMachine::CreateFunctionSlot(const Value *V) {
1670 const Type *VTy = V->getType();
1671 assert(VTy != Type::VoidTy && !V->hasName() && "Doesn't need a slot!");
1673 unsigned DestSlot = fNext++;
1676 // G = Global, F = Function, o = other
1677 SC_DEBUG(" Inserting value [" << VTy << "] = " << V << " slot=" <<
1678 DestSlot << " [o]\n");