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/InlineAsm.h"
24 #include "llvm/Instruction.h"
25 #include "llvm/Instructions.h"
26 #include "llvm/Module.h"
27 #include "llvm/ValueSymbolTable.h"
28 #include "llvm/TypeSymbolTable.h"
29 #include "llvm/ADT/DenseMap.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/raw_ostream.h"
39 // Make virtual table appear in this compilation unit.
40 AssemblyAnnotationWriter::~AssemblyAnnotationWriter() {}
42 //===----------------------------------------------------------------------===//
44 //===----------------------------------------------------------------------===//
46 static const Module *getModuleFromVal(const Value *V) {
47 if (const Argument *MA = dyn_cast<Argument>(V))
48 return MA->getParent() ? MA->getParent()->getParent() : 0;
50 if (const BasicBlock *BB = dyn_cast<BasicBlock>(V))
51 return BB->getParent() ? BB->getParent()->getParent() : 0;
53 if (const Instruction *I = dyn_cast<Instruction>(V)) {
54 const Function *M = I->getParent() ? I->getParent()->getParent() : 0;
55 return M ? M->getParent() : 0;
58 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V))
59 return GV->getParent();
63 // PrintEscapedString - Print each character of the specified string, escaping
64 // it if it is not printable or if it is an escape char.
65 static void PrintEscapedString(const char *Str, unsigned Length,
67 for (unsigned i = 0; i != Length; ++i) {
68 unsigned char C = Str[i];
69 if (isprint(C) && C != '\\' && C != '"' && isprint(C))
72 Out << '\\' << hexdigit(C >> 4) << hexdigit(C & 0x0F);
76 // PrintEscapedString - Print each character of the specified string, escaping
77 // it if it is not printable or if it is an escape char.
78 static void PrintEscapedString(const std::string &Str, raw_ostream &Out) {
79 PrintEscapedString(Str.c_str(), Str.size(), Out);
89 /// PrintLLVMName - Turn the specified name into an 'LLVM name', which is either
90 /// prefixed with % (if the string only contains simple characters) or is
91 /// surrounded with ""'s (if it has special chars in it). Print it out.
92 static void PrintLLVMName(raw_ostream &OS, const char *NameStr,
93 unsigned NameLen, PrefixType Prefix) {
94 assert(NameStr && "Cannot get empty name!");
96 default: assert(0 && "Bad prefix!");
98 case GlobalPrefix: OS << '@'; break;
99 case LabelPrefix: break;
100 case LocalPrefix: OS << '%'; break;
103 // Scan the name to see if it needs quotes first.
104 bool NeedsQuotes = isdigit(NameStr[0]);
106 for (unsigned i = 0; i != NameLen; ++i) {
108 if (!isalnum(C) && C != '-' && C != '.' && C != '_') {
115 // If we didn't need any quotes, just write out the name in one blast.
117 OS.write(NameStr, NameLen);
121 // Okay, we need quotes. Output the quotes and escape any scary characters as
124 PrintEscapedString(NameStr, NameLen, OS);
128 /// getLLVMName - Turn the specified string into an 'LLVM name', which is
129 /// surrounded with ""'s and escaped if it has special chars in it.
130 static std::string getLLVMName(const std::string &Name) {
131 assert(!Name.empty() && "Cannot get empty name!");
133 raw_string_ostream OS(result);
134 PrintLLVMName(OS, Name.c_str(), Name.length(), NoPrefix);
138 /// PrintLLVMName - Turn the specified name into an 'LLVM name', which is either
139 /// prefixed with % (if the string only contains simple characters) or is
140 /// surrounded with ""'s (if it has special chars in it). Print it out.
141 static void PrintLLVMName(raw_ostream &OS, const Value *V) {
142 PrintLLVMName(OS, V->getNameStart(), V->getNameLen(),
143 isa<GlobalValue>(V) ? GlobalPrefix : LocalPrefix);
148 //===----------------------------------------------------------------------===//
149 // SlotTracker Class: Enumerate slot numbers for unnamed values
150 //===----------------------------------------------------------------------===//
154 /// This class provides computation of slot numbers for LLVM Assembly writing.
158 /// ValueMap - A mapping of Values to slot numbers
159 typedef DenseMap<const Value*, unsigned> ValueMap;
162 /// TheModule - The module for which we are holding slot numbers
163 const Module* TheModule;
165 /// TheFunction - The function for which we are holding slot numbers
166 const Function* TheFunction;
167 bool FunctionProcessed;
169 /// mMap - The TypePlanes map for the module level data
173 /// fMap - The TypePlanes map for the function level data
178 /// Construct from a module
179 explicit SlotTracker(const Module *M);
180 /// Construct from a function, starting out in incorp state.
181 explicit SlotTracker(const Function *F);
183 /// Return the slot number of the specified value in it's type
184 /// plane. If something is not in the SlotTracker, return -1.
185 int getLocalSlot(const Value *V);
186 int getGlobalSlot(const GlobalValue *V);
188 /// If you'd like to deal with a function instead of just a module, use
189 /// this method to get its data into the SlotTracker.
190 void incorporateFunction(const Function *F) {
192 FunctionProcessed = false;
195 /// After calling incorporateFunction, use this method to remove the
196 /// most recently incorporated function from the SlotTracker. This
197 /// will reset the state of the machine back to just the module contents.
198 void purgeFunction();
200 // Implementation Details
202 /// This function does the actual initialization.
203 inline void initialize();
205 /// CreateModuleSlot - Insert the specified GlobalValue* into the slot table.
206 void CreateModuleSlot(const GlobalValue *V);
208 /// CreateFunctionSlot - Insert the specified Value* into the slot table.
209 void CreateFunctionSlot(const Value *V);
211 /// Add all of the module level global variables (and their initializers)
212 /// and function declarations, but not the contents of those functions.
213 void processModule();
215 /// Add all of the functions arguments, basic blocks, and instructions
216 void processFunction();
218 SlotTracker(const SlotTracker &); // DO NOT IMPLEMENT
219 void operator=(const SlotTracker &); // DO NOT IMPLEMENT
222 } // end anonymous namespace
225 static SlotTracker *createSlotTracker(const Value *V) {
226 if (const Argument *FA = dyn_cast<Argument>(V))
227 return new SlotTracker(FA->getParent());
229 if (const Instruction *I = dyn_cast<Instruction>(V))
230 return new SlotTracker(I->getParent()->getParent());
232 if (const BasicBlock *BB = dyn_cast<BasicBlock>(V))
233 return new SlotTracker(BB->getParent());
235 if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(V))
236 return new SlotTracker(GV->getParent());
238 if (const GlobalAlias *GA = dyn_cast<GlobalAlias>(V))
239 return new SlotTracker(GA->getParent());
241 if (const Function *Func = dyn_cast<Function>(V))
242 return new SlotTracker(Func);
248 #define ST_DEBUG(X) cerr << X
253 // Module level constructor. Causes the contents of the Module (sans functions)
254 // to be added to the slot table.
255 SlotTracker::SlotTracker(const Module *M)
256 : TheModule(M), TheFunction(0), FunctionProcessed(false), mNext(0), fNext(0) {
259 // Function level constructor. Causes the contents of the Module and the one
260 // function provided to be added to the slot table.
261 SlotTracker::SlotTracker(const Function *F)
262 : TheModule(F ? F->getParent() : 0), TheFunction(F), FunctionProcessed(false),
266 inline void SlotTracker::initialize() {
269 TheModule = 0; ///< Prevent re-processing next time we're called.
272 if (TheFunction && !FunctionProcessed)
276 // Iterate through all the global variables, functions, and global
277 // variable initializers and create slots for them.
278 void SlotTracker::processModule() {
279 ST_DEBUG("begin processModule!\n");
281 // Add all of the unnamed global variables to the value table.
282 for (Module::const_global_iterator I = TheModule->global_begin(),
283 E = TheModule->global_end(); I != E; ++I)
287 // Add all the unnamed functions to the table.
288 for (Module::const_iterator I = TheModule->begin(), E = TheModule->end();
293 ST_DEBUG("end processModule!\n");
297 // Process the arguments, basic blocks, and instructions of a function.
298 void SlotTracker::processFunction() {
299 ST_DEBUG("begin processFunction!\n");
302 // Add all the function arguments with no names.
303 for(Function::const_arg_iterator AI = TheFunction->arg_begin(),
304 AE = TheFunction->arg_end(); AI != AE; ++AI)
306 CreateFunctionSlot(AI);
308 ST_DEBUG("Inserting Instructions:\n");
310 // Add all of the basic blocks and instructions with no names.
311 for (Function::const_iterator BB = TheFunction->begin(),
312 E = TheFunction->end(); BB != E; ++BB) {
314 CreateFunctionSlot(BB);
315 for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I != E; ++I)
316 if (I->getType() != Type::VoidTy && !I->hasName())
317 CreateFunctionSlot(I);
320 FunctionProcessed = true;
322 ST_DEBUG("end processFunction!\n");
325 /// Clean up after incorporating a function. This is the only way to get out of
326 /// the function incorporation state that affects get*Slot/Create*Slot. Function
327 /// incorporation state is indicated by TheFunction != 0.
328 void SlotTracker::purgeFunction() {
329 ST_DEBUG("begin purgeFunction!\n");
330 fMap.clear(); // Simply discard the function level map
332 FunctionProcessed = false;
333 ST_DEBUG("end purgeFunction!\n");
336 /// getGlobalSlot - Get the slot number of a global value.
337 int SlotTracker::getGlobalSlot(const GlobalValue *V) {
338 // Check for uninitialized state and do lazy initialization.
341 // Find the type plane in the module map
342 ValueMap::iterator MI = mMap.find(V);
343 return MI == mMap.end() ? -1 : (int)MI->second;
347 /// getLocalSlot - Get the slot number for a value that is local to a function.
348 int SlotTracker::getLocalSlot(const Value *V) {
349 assert(!isa<Constant>(V) && "Can't get a constant or global slot with this!");
351 // Check for uninitialized state and do lazy initialization.
354 ValueMap::iterator FI = fMap.find(V);
355 return FI == fMap.end() ? -1 : (int)FI->second;
359 /// CreateModuleSlot - Insert the specified GlobalValue* into the slot table.
360 void SlotTracker::CreateModuleSlot(const GlobalValue *V) {
361 assert(V && "Can't insert a null Value into SlotTracker!");
362 assert(V->getType() != Type::VoidTy && "Doesn't need a slot!");
363 assert(!V->hasName() && "Doesn't need a slot!");
365 unsigned DestSlot = mNext++;
368 ST_DEBUG(" Inserting value [" << V->getType() << "] = " << V << " slot=" <<
370 // G = Global, F = Function, A = Alias, o = other
371 ST_DEBUG((isa<GlobalVariable>(V) ? 'G' :
372 (isa<Function>(V) ? 'F' :
373 (isa<GlobalAlias>(V) ? 'A' : 'o'))) << "]\n");
377 /// CreateSlot - Create a new slot for the specified value if it has no name.
378 void SlotTracker::CreateFunctionSlot(const Value *V) {
379 assert(V->getType() != Type::VoidTy && !V->hasName() &&
380 "Doesn't need a slot!");
382 unsigned DestSlot = fNext++;
385 // G = Global, F = Function, o = other
386 ST_DEBUG(" Inserting value [" << V->getType() << "] = " << V << " slot=" <<
387 DestSlot << " [o]\n");
392 //===----------------------------------------------------------------------===//
393 // AsmWriter Implementation
394 //===----------------------------------------------------------------------===//
396 static void WriteAsOperandInternal(raw_ostream &Out, const Value *V,
397 std::map<const Type *, std::string> &TypeTable,
398 SlotTracker *Machine);
402 /// fillTypeNameTable - If the module has a symbol table, take all global types
403 /// and stuff their names into the TypeNames map.
405 static void fillTypeNameTable(const Module *M,
406 std::map<const Type *, std::string> &TypeNames) {
408 const TypeSymbolTable &ST = M->getTypeSymbolTable();
409 TypeSymbolTable::const_iterator TI = ST.begin();
410 for (; TI != ST.end(); ++TI) {
411 // As a heuristic, don't insert pointer to primitive types, because
412 // they are used too often to have a single useful name.
414 const Type *Ty = cast<Type>(TI->second);
415 if (!isa<PointerType>(Ty) ||
416 !cast<PointerType>(Ty)->getElementType()->isPrimitiveType() ||
417 !cast<PointerType>(Ty)->getElementType()->isInteger() ||
418 isa<OpaqueType>(cast<PointerType>(Ty)->getElementType()))
419 TypeNames.insert(std::make_pair(Ty, '%' + getLLVMName(TI->first)));
425 static void calcTypeName(const Type *Ty,
426 std::vector<const Type *> &TypeStack,
427 std::map<const Type *, std::string> &TypeNames,
428 std::string &Result) {
429 if (Ty->isInteger() || (Ty->isPrimitiveType() && !isa<OpaqueType>(Ty))) {
430 Result += Ty->getDescription(); // Base case
434 // Check to see if the type is named.
435 std::map<const Type *, std::string>::iterator I = TypeNames.find(Ty);
436 if (I != TypeNames.end()) {
441 if (isa<OpaqueType>(Ty)) {
446 // Check to see if the Type is already on the stack...
447 unsigned Slot = 0, CurSize = TypeStack.size();
448 while (Slot < CurSize && TypeStack[Slot] != Ty) ++Slot; // Scan for type
450 // This is another base case for the recursion. In this case, we know
451 // that we have looped back to a type that we have previously visited.
452 // Generate the appropriate upreference to handle this.
453 if (Slot < CurSize) {
454 Result += "\\" + utostr(CurSize-Slot); // Here's the upreference
458 TypeStack.push_back(Ty); // Recursive case: Add us to the stack..
460 switch (Ty->getTypeID()) {
461 case Type::IntegerTyID: {
462 unsigned BitWidth = cast<IntegerType>(Ty)->getBitWidth();
463 Result += "i" + utostr(BitWidth);
466 case Type::FunctionTyID: {
467 const FunctionType *FTy = cast<FunctionType>(Ty);
468 calcTypeName(FTy->getReturnType(), TypeStack, TypeNames, Result);
470 for (FunctionType::param_iterator I = FTy->param_begin(),
471 E = FTy->param_end(); I != E; ++I) {
472 if (I != FTy->param_begin())
474 calcTypeName(*I, TypeStack, TypeNames, Result);
476 if (FTy->isVarArg()) {
477 if (FTy->getNumParams()) Result += ", ";
483 case Type::StructTyID: {
484 const StructType *STy = cast<StructType>(Ty);
488 for (StructType::element_iterator I = STy->element_begin(),
489 E = STy->element_end(); I != E; ++I) {
490 calcTypeName(*I, TypeStack, TypeNames, Result);
491 if (next(I) != STy->element_end())
500 case Type::PointerTyID: {
501 const PointerType *PTy = cast<PointerType>(Ty);
502 calcTypeName(PTy->getElementType(), TypeStack, TypeNames, Result);
503 if (unsigned AddressSpace = PTy->getAddressSpace())
504 Result += " addrspace(" + utostr(AddressSpace) + ")";
508 case Type::ArrayTyID: {
509 const ArrayType *ATy = cast<ArrayType>(Ty);
510 Result += "[" + utostr(ATy->getNumElements()) + " x ";
511 calcTypeName(ATy->getElementType(), TypeStack, TypeNames, Result);
515 case Type::VectorTyID: {
516 const VectorType *PTy = cast<VectorType>(Ty);
517 Result += "<" + utostr(PTy->getNumElements()) + " x ";
518 calcTypeName(PTy->getElementType(), TypeStack, TypeNames, Result);
522 case Type::OpaqueTyID:
526 Result += "<unrecognized-type>";
530 TypeStack.pop_back(); // Remove self from stack...
534 /// printTypeInt - The internal guts of printing out a type that has a
535 /// potentially named portion.
537 static void printTypeInt(raw_ostream &Out, const Type *Ty,
538 std::map<const Type *, std::string> &TypeNames) {
539 // Primitive types always print out their description, regardless of whether
540 // they have been named or not.
542 if (Ty->isInteger() || (Ty->isPrimitiveType() && !isa<OpaqueType>(Ty))) {
543 Out << Ty->getDescription();
547 // Check to see if the type is named.
548 std::map<const Type *, std::string>::iterator I = TypeNames.find(Ty);
549 if (I != TypeNames.end()) {
554 // Otherwise we have a type that has not been named but is a derived type.
555 // Carefully recurse the type hierarchy to print out any contained symbolic
558 std::vector<const Type *> TypeStack;
559 std::string TypeName;
560 calcTypeName(Ty, TypeStack, TypeNames, TypeName);
561 TypeNames.insert(std::make_pair(Ty, TypeName));//Cache type name for later use
566 /// WriteTypeSymbolic - This attempts to write the specified type as a symbolic
567 /// type, iff there is an entry in the modules symbol table for the specified
568 /// type or one of it's component types. This is slower than a simple x << Type
570 void llvm::WriteTypeSymbolic(std::ostream &Out, const Type *Ty,
572 raw_os_ostream RO(Out);
573 WriteTypeSymbolic(RO, Ty, M);
576 void llvm::WriteTypeSymbolic(raw_ostream &Out, const Type *Ty, const Module *M){
579 // If they want us to print out a type, but there is no context, we can't
580 // print it symbolically.
582 Out << Ty->getDescription();
584 std::map<const Type *, std::string> TypeNames;
585 fillTypeNameTable(M, TypeNames);
586 printTypeInt(Out, Ty, TypeNames);
590 static const char *getPredicateText(unsigned predicate) {
591 const char * pred = "unknown";
593 case FCmpInst::FCMP_FALSE: pred = "false"; break;
594 case FCmpInst::FCMP_OEQ: pred = "oeq"; break;
595 case FCmpInst::FCMP_OGT: pred = "ogt"; break;
596 case FCmpInst::FCMP_OGE: pred = "oge"; break;
597 case FCmpInst::FCMP_OLT: pred = "olt"; break;
598 case FCmpInst::FCMP_OLE: pred = "ole"; break;
599 case FCmpInst::FCMP_ONE: pred = "one"; break;
600 case FCmpInst::FCMP_ORD: pred = "ord"; break;
601 case FCmpInst::FCMP_UNO: pred = "uno"; break;
602 case FCmpInst::FCMP_UEQ: pred = "ueq"; break;
603 case FCmpInst::FCMP_UGT: pred = "ugt"; break;
604 case FCmpInst::FCMP_UGE: pred = "uge"; break;
605 case FCmpInst::FCMP_ULT: pred = "ult"; break;
606 case FCmpInst::FCMP_ULE: pred = "ule"; break;
607 case FCmpInst::FCMP_UNE: pred = "une"; break;
608 case FCmpInst::FCMP_TRUE: pred = "true"; break;
609 case ICmpInst::ICMP_EQ: pred = "eq"; break;
610 case ICmpInst::ICMP_NE: pred = "ne"; break;
611 case ICmpInst::ICMP_SGT: pred = "sgt"; break;
612 case ICmpInst::ICMP_SGE: pred = "sge"; break;
613 case ICmpInst::ICMP_SLT: pred = "slt"; break;
614 case ICmpInst::ICMP_SLE: pred = "sle"; break;
615 case ICmpInst::ICMP_UGT: pred = "ugt"; break;
616 case ICmpInst::ICMP_UGE: pred = "uge"; break;
617 case ICmpInst::ICMP_ULT: pred = "ult"; break;
618 case ICmpInst::ICMP_ULE: pred = "ule"; break;
623 static void WriteConstantInt(raw_ostream &Out, const Constant *CV,
624 std::map<const Type *, std::string> &TypeTable,
625 SlotTracker *Machine) {
626 if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV)) {
627 if (CI->getType() == Type::Int1Ty) {
628 Out << (CI->getZExtValue() ? "true" : "false");
631 Out << CI->getValue();
635 if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV)) {
636 if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEdouble ||
637 &CFP->getValueAPF().getSemantics() == &APFloat::IEEEsingle) {
638 // We would like to output the FP constant value in exponential notation,
639 // but we cannot do this if doing so will lose precision. Check here to
640 // make sure that we only output it in exponential format if we can parse
641 // the value back and get the same value.
643 bool isDouble = &CFP->getValueAPF().getSemantics()==&APFloat::IEEEdouble;
644 double Val = isDouble ? CFP->getValueAPF().convertToDouble() :
645 CFP->getValueAPF().convertToFloat();
646 std::string StrVal = ftostr(CFP->getValueAPF());
648 // Check to make sure that the stringized number is not some string like
649 // "Inf" or NaN, that atof will accept, but the lexer will not. Check
650 // that the string matches the "[-+]?[0-9]" regex.
652 if ((StrVal[0] >= '0' && StrVal[0] <= '9') ||
653 ((StrVal[0] == '-' || StrVal[0] == '+') &&
654 (StrVal[1] >= '0' && StrVal[1] <= '9'))) {
655 // Reparse stringized version!
656 if (atof(StrVal.c_str()) == Val) {
661 // Otherwise we could not reparse it to exactly the same value, so we must
662 // output the string in hexadecimal format!
663 assert(sizeof(double) == sizeof(uint64_t) &&
664 "assuming that double is 64 bits!");
666 Out << "0x" << utohex_buffer(uint64_t(DoubleToBits(Val)), Buffer+40);
670 // Some form of long double. These appear as a magic letter identifying
671 // the type, then a fixed number of hex digits.
673 if (&CFP->getValueAPF().getSemantics() == &APFloat::x87DoubleExtended)
675 else if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEquad)
677 else if (&CFP->getValueAPF().getSemantics() == &APFloat::PPCDoubleDouble)
680 assert(0 && "Unsupported floating point type");
681 // api needed to prevent premature destruction
682 APInt api = CFP->getValueAPF().bitcastToAPInt();
683 const uint64_t* p = api.getRawData();
686 int width = api.getBitWidth();
687 for (int j=0; j<width; j+=4, shiftcount-=4) {
688 unsigned int nibble = (word>>shiftcount) & 15;
690 Out << (unsigned char)(nibble + '0');
692 Out << (unsigned char)(nibble - 10 + 'A');
693 if (shiftcount == 0 && j+4 < width) {
697 shiftcount = width-j-4;
703 if (isa<ConstantAggregateZero>(CV)) {
704 Out << "zeroinitializer";
708 if (const ConstantArray *CA = dyn_cast<ConstantArray>(CV)) {
709 // As a special case, print the array as a string if it is an array of
710 // i8 with ConstantInt values.
712 const Type *ETy = CA->getType()->getElementType();
713 if (CA->isString()) {
715 PrintEscapedString(CA->getAsString(), Out);
717 } else { // Cannot output in string format...
719 if (CA->getNumOperands()) {
721 printTypeInt(Out, ETy, TypeTable);
723 WriteAsOperandInternal(Out, CA->getOperand(0),
725 for (unsigned i = 1, e = CA->getNumOperands(); i != e; ++i) {
727 printTypeInt(Out, ETy, TypeTable);
729 WriteAsOperandInternal(Out, CA->getOperand(i), TypeTable, Machine);
738 if (const ConstantStruct *CS = dyn_cast<ConstantStruct>(CV)) {
739 if (CS->getType()->isPacked())
742 unsigned N = CS->getNumOperands();
745 printTypeInt(Out, CS->getOperand(0)->getType(), TypeTable);
748 WriteAsOperandInternal(Out, CS->getOperand(0), TypeTable, Machine);
750 for (unsigned i = 1; i < N; i++) {
752 printTypeInt(Out, CS->getOperand(i)->getType(), TypeTable);
755 WriteAsOperandInternal(Out, CS->getOperand(i), TypeTable, Machine);
761 if (CS->getType()->isPacked())
766 if (const ConstantVector *CP = dyn_cast<ConstantVector>(CV)) {
767 const Type *ETy = CP->getType()->getElementType();
768 assert(CP->getNumOperands() > 0 &&
769 "Number of operands for a PackedConst must be > 0");
771 printTypeInt(Out, ETy, TypeTable);
773 WriteAsOperandInternal(Out, CP->getOperand(0), TypeTable, Machine);
774 for (unsigned i = 1, e = CP->getNumOperands(); i != e; ++i) {
776 printTypeInt(Out, ETy, TypeTable);
778 WriteAsOperandInternal(Out, CP->getOperand(i), TypeTable, Machine);
784 if (isa<ConstantPointerNull>(CV)) {
789 if (isa<UndefValue>(CV)) {
794 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV)) {
795 Out << CE->getOpcodeName();
797 Out << ' ' << getPredicateText(CE->getPredicate());
800 for (User::const_op_iterator OI=CE->op_begin(); OI != CE->op_end(); ++OI) {
801 printTypeInt(Out, (*OI)->getType(), TypeTable);
803 WriteAsOperandInternal(Out, *OI, TypeTable, Machine);
804 if (OI+1 != CE->op_end())
808 if (CE->hasIndices()) {
809 const SmallVector<unsigned, 4> &Indices = CE->getIndices();
810 for (unsigned i = 0, e = Indices.size(); i != e; ++i)
811 Out << ", " << Indices[i];
816 printTypeInt(Out, CE->getType(), TypeTable);
823 Out << "<placeholder or erroneous Constant>";
827 /// WriteAsOperand - Write the name of the specified value out to the specified
828 /// ostream. This can be useful when you just want to print int %reg126, not
829 /// the whole instruction that generated it.
831 static void WriteAsOperandInternal(raw_ostream &Out, const Value *V,
832 std::map<const Type*, std::string> &TypeTable,
833 SlotTracker *Machine) {
835 PrintLLVMName(Out, V);
839 const Constant *CV = dyn_cast<Constant>(V);
840 if (CV && !isa<GlobalValue>(CV)) {
841 WriteConstantInt(Out, CV, TypeTable, Machine);
845 if (const InlineAsm *IA = dyn_cast<InlineAsm>(V)) {
847 if (IA->hasSideEffects())
848 Out << "sideeffect ";
850 PrintEscapedString(IA->getAsmString(), Out);
852 PrintEscapedString(IA->getConstraintString(), Out);
860 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
861 Slot = Machine->getGlobalSlot(GV);
864 Slot = Machine->getLocalSlot(V);
867 Machine = createSlotTracker(V);
869 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
870 Slot = Machine->getGlobalSlot(GV);
873 Slot = Machine->getLocalSlot(V);
882 Out << Prefix << Slot;
887 /// WriteAsOperand - Write the name of the specified value out to the specified
888 /// ostream. This can be useful when you just want to print int %reg126, not
889 /// the whole instruction that generated it.
891 void llvm::WriteAsOperand(std::ostream &Out, const Value *V, bool PrintType,
892 const Module *Context) {
893 raw_os_ostream OS(Out);
894 WriteAsOperand(OS, V, PrintType, Context);
897 void llvm::WriteAsOperand(raw_ostream &Out, const Value *V, bool PrintType,
898 const Module *Context) {
899 std::map<const Type *, std::string> TypeNames;
900 if (Context == 0) Context = getModuleFromVal(V);
903 fillTypeNameTable(Context, TypeNames);
906 printTypeInt(Out, V->getType(), TypeNames);
910 WriteAsOperandInternal(Out, V, TypeNames, 0);
916 class AssemblyWriter {
918 SlotTracker &Machine;
919 const Module *TheModule;
920 std::map<const Type *, std::string> TypeNames;
921 AssemblyAnnotationWriter *AnnotationWriter;
923 inline AssemblyWriter(raw_ostream &o, SlotTracker &Mac, const Module *M,
924 AssemblyAnnotationWriter *AAW)
925 : Out(o), Machine(Mac), TheModule(M), AnnotationWriter(AAW) {
927 // If the module has a symbol table, take all global types and stuff their
928 // names into the TypeNames map.
930 fillTypeNameTable(M, TypeNames);
933 void write(const Module *M) { printModule(M); }
935 void write(const GlobalValue *G) {
936 if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(G))
938 else if (const GlobalAlias *GA = dyn_cast<GlobalAlias>(G))
940 else if (const Function *F = dyn_cast<Function>(G))
943 assert(0 && "Unknown global");
946 void write(const BasicBlock *BB) { printBasicBlock(BB); }
947 void write(const Instruction *I) { printInstruction(*I); }
948 void write(const Type *Ty) { printType(Ty); }
950 void writeOperand(const Value *Op, bool PrintType);
951 void writeParamOperand(const Value *Operand, Attributes Attrs);
953 const Module* getModule() { return TheModule; }
956 void printModule(const Module *M);
957 void printTypeSymbolTable(const TypeSymbolTable &ST);
958 void printGlobal(const GlobalVariable *GV);
959 void printAlias(const GlobalAlias *GV);
960 void printFunction(const Function *F);
961 void printArgument(const Argument *FA, Attributes Attrs);
962 void printBasicBlock(const BasicBlock *BB);
963 void printInstruction(const Instruction &I);
965 // printType - Go to extreme measures to attempt to print out a short,
966 // symbolic version of a type name.
968 void printType(const Type *Ty) {
969 printTypeInt(Out, Ty, TypeNames);
972 // printTypeAtLeastOneLevel - Print out one level of the possibly complex type
973 // without considering any symbolic types that we may have equal to it.
975 void printTypeAtLeastOneLevel(const Type *Ty);
977 // printInfoComment - Print a little comment after the instruction indicating
978 // which slot it occupies.
979 void printInfoComment(const Value &V);
981 } // end of llvm namespace
983 /// printTypeAtLeastOneLevel - Print out one level of the possibly complex type
984 /// without considering any symbolic types that we may have equal to it.
986 void AssemblyWriter::printTypeAtLeastOneLevel(const Type *Ty) {
987 if (const IntegerType *ITy = dyn_cast<IntegerType>(Ty)) {
988 Out << "i" << utostr(ITy->getBitWidth());
992 if (const FunctionType *FTy = dyn_cast<FunctionType>(Ty)) {
993 printType(FTy->getReturnType());
995 for (FunctionType::param_iterator I = FTy->param_begin(),
996 E = FTy->param_end(); I != E; ++I) {
997 if (I != FTy->param_begin())
1001 if (FTy->isVarArg()) {
1002 if (FTy->getNumParams()) Out << ", ";
1009 if (const StructType *STy = dyn_cast<StructType>(Ty)) {
1010 if (STy->isPacked())
1013 for (StructType::element_iterator I = STy->element_begin(),
1014 E = STy->element_end(); I != E; ++I) {
1015 if (I != STy->element_begin())
1020 if (STy->isPacked())
1025 if (const PointerType *PTy = dyn_cast<PointerType>(Ty)) {
1026 printType(PTy->getElementType());
1027 if (unsigned AddressSpace = PTy->getAddressSpace())
1028 Out << " addrspace(" << AddressSpace << ")";
1033 if (const ArrayType *ATy = dyn_cast<ArrayType>(Ty)) {
1034 Out << '[' << ATy->getNumElements() << " x ";
1035 printType(ATy->getElementType());
1040 if (const VectorType *PTy = dyn_cast<VectorType>(Ty)) {
1041 Out << '<' << PTy->getNumElements() << " x ";
1042 printType(PTy->getElementType());
1047 if (isa<OpaqueType>(Ty)) {
1052 if (!Ty->isPrimitiveType())
1053 Out << "<unknown derived type>";
1058 void AssemblyWriter::writeOperand(const Value *Operand, bool PrintType) {
1060 Out << "<null operand!>";
1063 printType(Operand->getType());
1066 WriteAsOperandInternal(Out, Operand, TypeNames, &Machine);
1070 void AssemblyWriter::writeParamOperand(const Value *Operand,
1073 Out << "<null operand!>";
1076 printType(Operand->getType());
1077 // Print parameter attributes list
1078 if (Attrs != Attribute::None)
1079 Out << ' ' << Attribute::getAsString(Attrs);
1081 // Print the operand
1082 WriteAsOperandInternal(Out, Operand, TypeNames, &Machine);
1086 void AssemblyWriter::printModule(const Module *M) {
1087 if (!M->getModuleIdentifier().empty() &&
1088 // Don't print the ID if it will start a new line (which would
1089 // require a comment char before it).
1090 M->getModuleIdentifier().find('\n') == std::string::npos)
1091 Out << "; ModuleID = '" << M->getModuleIdentifier() << "'\n";
1093 if (!M->getDataLayout().empty())
1094 Out << "target datalayout = \"" << M->getDataLayout() << "\"\n";
1095 if (!M->getTargetTriple().empty())
1096 Out << "target triple = \"" << M->getTargetTriple() << "\"\n";
1098 if (!M->getModuleInlineAsm().empty()) {
1099 // Split the string into lines, to make it easier to read the .ll file.
1100 std::string Asm = M->getModuleInlineAsm();
1102 size_t NewLine = Asm.find_first_of('\n', CurPos);
1103 while (NewLine != std::string::npos) {
1104 // We found a newline, print the portion of the asm string from the
1105 // last newline up to this newline.
1106 Out << "module asm \"";
1107 PrintEscapedString(std::string(Asm.begin()+CurPos, Asm.begin()+NewLine),
1111 NewLine = Asm.find_first_of('\n', CurPos);
1113 Out << "module asm \"";
1114 PrintEscapedString(std::string(Asm.begin()+CurPos, Asm.end()), Out);
1118 // Loop over the dependent libraries and emit them.
1119 Module::lib_iterator LI = M->lib_begin();
1120 Module::lib_iterator LE = M->lib_end();
1122 Out << "deplibs = [ ";
1124 Out << '"' << *LI << '"';
1132 // Loop over the symbol table, emitting all named constants.
1133 printTypeSymbolTable(M->getTypeSymbolTable());
1135 for (Module::const_global_iterator I = M->global_begin(), E = M->global_end();
1139 // Output all aliases.
1140 if (!M->alias_empty()) Out << "\n";
1141 for (Module::const_alias_iterator I = M->alias_begin(), E = M->alias_end();
1145 // Output all of the functions.
1146 for (Module::const_iterator I = M->begin(), E = M->end(); I != E; ++I)
1150 static void PrintLinkage(GlobalValue::LinkageTypes LT, raw_ostream &Out) {
1152 case GlobalValue::InternalLinkage: Out << "internal "; break;
1153 case GlobalValue::LinkOnceLinkage: Out << "linkonce "; break;
1154 case GlobalValue::WeakLinkage: Out << "weak "; break;
1155 case GlobalValue::CommonLinkage: Out << "common "; break;
1156 case GlobalValue::AppendingLinkage: Out << "appending "; break;
1157 case GlobalValue::DLLImportLinkage: Out << "dllimport "; break;
1158 case GlobalValue::DLLExportLinkage: Out << "dllexport "; break;
1159 case GlobalValue::ExternalWeakLinkage: Out << "extern_weak "; break;
1160 case GlobalValue::ExternalLinkage: break;
1161 case GlobalValue::GhostLinkage:
1162 Out << "GhostLinkage not allowed in AsmWriter!\n";
1168 static void PrintVisibility(GlobalValue::VisibilityTypes Vis,
1171 default: assert(0 && "Invalid visibility style!");
1172 case GlobalValue::DefaultVisibility: break;
1173 case GlobalValue::HiddenVisibility: Out << "hidden "; break;
1174 case GlobalValue::ProtectedVisibility: Out << "protected "; break;
1178 void AssemblyWriter::printGlobal(const GlobalVariable *GV) {
1179 if (GV->hasName()) {
1180 PrintLLVMName(Out, GV);
1184 if (!GV->hasInitializer() && GV->hasExternalLinkage())
1187 PrintLinkage(GV->getLinkage(), Out);
1188 PrintVisibility(GV->getVisibility(), Out);
1190 if (GV->isThreadLocal()) Out << "thread_local ";
1191 if (unsigned AddressSpace = GV->getType()->getAddressSpace())
1192 Out << "addrspace(" << AddressSpace << ") ";
1193 Out << (GV->isConstant() ? "constant " : "global ");
1194 printType(GV->getType()->getElementType());
1196 if (GV->hasInitializer()) {
1198 writeOperand(GV->getInitializer(), false);
1201 if (GV->hasSection())
1202 Out << ", section \"" << GV->getSection() << '"';
1203 if (GV->getAlignment())
1204 Out << ", align " << GV->getAlignment();
1206 printInfoComment(*GV);
1210 void AssemblyWriter::printAlias(const GlobalAlias *GA) {
1211 // Don't crash when dumping partially built GA
1213 Out << "<<nameless>> = ";
1215 PrintLLVMName(Out, GA);
1218 PrintVisibility(GA->getVisibility(), Out);
1222 PrintLinkage(GA->getLinkage(), Out);
1224 const Constant *Aliasee = GA->getAliasee();
1226 if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(Aliasee)) {
1227 printType(GV->getType());
1229 PrintLLVMName(Out, GV);
1230 } else if (const Function *F = dyn_cast<Function>(Aliasee)) {
1231 printType(F->getFunctionType());
1235 PrintLLVMName(Out, F);
1238 } else if (const GlobalAlias *GA = dyn_cast<GlobalAlias>(Aliasee)) {
1239 printType(GA->getType());
1241 PrintLLVMName(Out, GA);
1243 const ConstantExpr *CE = 0;
1244 if ((CE = dyn_cast<ConstantExpr>(Aliasee)) &&
1245 (CE->getOpcode() == Instruction::BitCast)) {
1246 writeOperand(CE, false);
1248 assert(0 && "Unsupported aliasee");
1251 printInfoComment(*GA);
1255 void AssemblyWriter::printTypeSymbolTable(const TypeSymbolTable &ST) {
1257 for (TypeSymbolTable::const_iterator TI = ST.begin(), TE = ST.end();
1260 PrintLLVMName(Out, &TI->first[0], TI->first.size(), LocalPrefix);
1263 // Make sure we print out at least one level of the type structure, so
1264 // that we do not get %FILE = type %FILE
1266 printTypeAtLeastOneLevel(TI->second);
1271 /// printFunction - Print all aspects of a function.
1273 void AssemblyWriter::printFunction(const Function *F) {
1274 // Print out the return type and name.
1277 if (AnnotationWriter) AnnotationWriter->emitFunctionAnnot(F, Out);
1279 if (F->isDeclaration())
1284 PrintLinkage(F->getLinkage(), Out);
1285 PrintVisibility(F->getVisibility(), Out);
1287 // Print the calling convention.
1288 switch (F->getCallingConv()) {
1289 case CallingConv::C: break; // default
1290 case CallingConv::Fast: Out << "fastcc "; break;
1291 case CallingConv::Cold: Out << "coldcc "; break;
1292 case CallingConv::X86_StdCall: Out << "x86_stdcallcc "; break;
1293 case CallingConv::X86_FastCall: Out << "x86_fastcallcc "; break;
1294 default: Out << "cc" << F->getCallingConv() << " "; break;
1297 const FunctionType *FT = F->getFunctionType();
1298 const AttrListPtr &Attrs = F->getAttributes();
1299 Attributes RetAttrs = Attrs.getRetAttributes();
1300 if (RetAttrs != Attribute::None)
1301 Out << Attribute::getAsString(Attrs.getRetAttributes()) << ' ';
1302 printType(F->getReturnType());
1305 PrintLLVMName(Out, F);
1309 Machine.incorporateFunction(F);
1311 // Loop over the arguments, printing them...
1314 if (!F->isDeclaration()) {
1315 // If this isn't a declaration, print the argument names as well.
1316 for (Function::const_arg_iterator I = F->arg_begin(), E = F->arg_end();
1318 // Insert commas as we go... the first arg doesn't get a comma
1319 if (I != F->arg_begin()) Out << ", ";
1320 printArgument(I, Attrs.getParamAttributes(Idx));
1324 // Otherwise, print the types from the function type.
1325 for (unsigned i = 0, e = FT->getNumParams(); i != e; ++i) {
1326 // Insert commas as we go... the first arg doesn't get a comma
1330 printType(FT->getParamType(i));
1332 Attributes ArgAttrs = Attrs.getParamAttributes(i+1);
1333 if (ArgAttrs != Attribute::None)
1334 Out << ' ' << Attribute::getAsString(ArgAttrs);
1338 // Finish printing arguments...
1339 if (FT->isVarArg()) {
1340 if (FT->getNumParams()) Out << ", ";
1341 Out << "..."; // Output varargs portion of signature!
1344 Attributes FnAttrs = Attrs.getFnAttributes();
1345 if (FnAttrs != Attribute::None)
1346 Out << ' ' << Attribute::getAsString(Attrs.getFnAttributes());
1347 if (F->hasSection())
1348 Out << " section \"" << F->getSection() << '"';
1349 if (F->getAlignment())
1350 Out << " align " << F->getAlignment();
1352 Out << " gc \"" << F->getGC() << '"';
1353 if (F->isDeclaration()) {
1358 // Output all of its basic blocks... for the function
1359 for (Function::const_iterator I = F->begin(), E = F->end(); I != E; ++I)
1365 Machine.purgeFunction();
1368 /// printArgument - This member is called for every argument that is passed into
1369 /// the function. Simply print it out
1371 void AssemblyWriter::printArgument(const Argument *Arg,
1374 printType(Arg->getType());
1376 // Output parameter attributes list
1377 if (Attrs != Attribute::None)
1378 Out << ' ' << Attribute::getAsString(Attrs);
1380 // Output name, if available...
1381 if (Arg->hasName()) {
1383 PrintLLVMName(Out, Arg);
1387 /// printBasicBlock - This member is called for each basic block in a method.
1389 void AssemblyWriter::printBasicBlock(const BasicBlock *BB) {
1390 if (BB->hasName()) { // Print out the label if it exists...
1392 PrintLLVMName(Out, BB->getNameStart(), BB->getNameLen(), LabelPrefix);
1394 } else if (!BB->use_empty()) { // Don't print block # of no uses...
1395 Out << "\n; <label>:";
1396 int Slot = Machine.getLocalSlot(BB);
1403 if (BB->getParent() == 0)
1404 Out << "\t\t; Error: Block without parent!";
1405 else if (BB != &BB->getParent()->getEntryBlock()) { // Not the entry block?
1406 // Output predecessors for the block...
1408 pred_const_iterator PI = pred_begin(BB), PE = pred_end(BB);
1411 Out << " No predecessors!";
1414 writeOperand(*PI, false);
1415 for (++PI; PI != PE; ++PI) {
1417 writeOperand(*PI, false);
1424 if (AnnotationWriter) AnnotationWriter->emitBasicBlockStartAnnot(BB, Out);
1426 // Output all of the instructions in the basic block...
1427 for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I != E; ++I)
1428 printInstruction(*I);
1430 if (AnnotationWriter) AnnotationWriter->emitBasicBlockEndAnnot(BB, Out);
1434 /// printInfoComment - Print a little comment after the instruction indicating
1435 /// which slot it occupies.
1437 void AssemblyWriter::printInfoComment(const Value &V) {
1438 if (V.getType() != Type::VoidTy) {
1440 printType(V.getType());
1443 if (!V.hasName() && !isa<Instruction>(V)) {
1445 if (const GlobalValue *GV = dyn_cast<GlobalValue>(&V))
1446 SlotNum = Machine.getGlobalSlot(GV);
1448 SlotNum = Machine.getLocalSlot(&V);
1452 Out << ':' << SlotNum; // Print out the def slot taken.
1454 Out << " [#uses=" << V.getNumUses() << ']'; // Output # uses
1458 // This member is called for each Instruction in a function..
1459 void AssemblyWriter::printInstruction(const Instruction &I) {
1460 if (AnnotationWriter) AnnotationWriter->emitInstructionAnnot(&I, Out);
1464 // Print out name if it exists...
1466 PrintLLVMName(Out, &I);
1468 } else if (I.getType() != Type::VoidTy) {
1469 // Print out the def slot taken.
1470 int SlotNum = Machine.getLocalSlot(&I);
1472 Out << "<badref> = ";
1474 Out << '%' << SlotNum << " = ";
1477 // If this is a volatile load or store, print out the volatile marker.
1478 if ((isa<LoadInst>(I) && cast<LoadInst>(I).isVolatile()) ||
1479 (isa<StoreInst>(I) && cast<StoreInst>(I).isVolatile())) {
1481 } else if (isa<CallInst>(I) && cast<CallInst>(I).isTailCall()) {
1482 // If this is a call, check if it's a tail call.
1486 // Print out the opcode...
1487 Out << I.getOpcodeName();
1489 // Print out the compare instruction predicates
1490 if (const CmpInst *CI = dyn_cast<CmpInst>(&I))
1491 Out << ' ' << getPredicateText(CI->getPredicate());
1493 // Print out the type of the operands...
1494 const Value *Operand = I.getNumOperands() ? I.getOperand(0) : 0;
1496 // Special case conditional branches to swizzle the condition out to the front
1497 if (isa<BranchInst>(I) && I.getNumOperands() > 1) {
1499 writeOperand(I.getOperand(2), true);
1501 writeOperand(Operand, true);
1503 writeOperand(I.getOperand(1), true);
1505 } else if (isa<SwitchInst>(I)) {
1506 // Special case switch statement to get formatting nice and correct...
1508 writeOperand(Operand , true);
1510 writeOperand(I.getOperand(1), true);
1513 for (unsigned op = 2, Eop = I.getNumOperands(); op < Eop; op += 2) {
1515 writeOperand(I.getOperand(op ), true);
1517 writeOperand(I.getOperand(op+1), true);
1520 } else if (isa<PHINode>(I)) {
1522 printType(I.getType());
1525 for (unsigned op = 0, Eop = I.getNumOperands(); op < Eop; op += 2) {
1526 if (op) Out << ", ";
1528 writeOperand(I.getOperand(op ), false); Out << ", ";
1529 writeOperand(I.getOperand(op+1), false); Out << " ]";
1531 } else if (const ExtractValueInst *EVI = dyn_cast<ExtractValueInst>(&I)) {
1533 writeOperand(I.getOperand(0), true);
1534 for (const unsigned *i = EVI->idx_begin(), *e = EVI->idx_end(); i != e; ++i)
1536 } else if (const InsertValueInst *IVI = dyn_cast<InsertValueInst>(&I)) {
1538 writeOperand(I.getOperand(0), true); Out << ", ";
1539 writeOperand(I.getOperand(1), true);
1540 for (const unsigned *i = IVI->idx_begin(), *e = IVI->idx_end(); i != e; ++i)
1542 } else if (isa<ReturnInst>(I) && !Operand) {
1544 } else if (const CallInst *CI = dyn_cast<CallInst>(&I)) {
1545 // Print the calling convention being used.
1546 switch (CI->getCallingConv()) {
1547 case CallingConv::C: break; // default
1548 case CallingConv::Fast: Out << " fastcc"; break;
1549 case CallingConv::Cold: Out << " coldcc"; break;
1550 case CallingConv::X86_StdCall: Out << " x86_stdcallcc"; break;
1551 case CallingConv::X86_FastCall: Out << " x86_fastcallcc"; break;
1552 default: Out << " cc" << CI->getCallingConv(); break;
1555 const PointerType *PTy = cast<PointerType>(Operand->getType());
1556 const FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
1557 const Type *RetTy = FTy->getReturnType();
1558 const AttrListPtr &PAL = CI->getAttributes();
1560 if (PAL.getRetAttributes() != Attribute::None)
1561 Out << ' ' << Attribute::getAsString(PAL.getRetAttributes());
1563 // If possible, print out the short form of the call instruction. We can
1564 // only do this if the first argument is a pointer to a nonvararg function,
1565 // and if the return type is not a pointer to a function.
1568 if (!FTy->isVarArg() &&
1569 (!isa<PointerType>(RetTy) ||
1570 !isa<FunctionType>(cast<PointerType>(RetTy)->getElementType()))) {
1573 writeOperand(Operand, false);
1575 writeOperand(Operand, true);
1578 for (unsigned op = 1, Eop = I.getNumOperands(); op < Eop; ++op) {
1581 writeParamOperand(I.getOperand(op), PAL.getParamAttributes(op));
1584 if (PAL.getFnAttributes() != Attribute::None)
1585 Out << ' ' << Attribute::getAsString(PAL.getFnAttributes());
1586 } else if (const InvokeInst *II = dyn_cast<InvokeInst>(&I)) {
1587 const PointerType *PTy = cast<PointerType>(Operand->getType());
1588 const FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
1589 const Type *RetTy = FTy->getReturnType();
1590 const AttrListPtr &PAL = II->getAttributes();
1592 // Print the calling convention being used.
1593 switch (II->getCallingConv()) {
1594 case CallingConv::C: break; // default
1595 case CallingConv::Fast: Out << " fastcc"; break;
1596 case CallingConv::Cold: Out << " coldcc"; break;
1597 case CallingConv::X86_StdCall: Out << " x86_stdcallcc"; break;
1598 case CallingConv::X86_FastCall: Out << " x86_fastcallcc"; break;
1599 default: Out << " cc" << II->getCallingConv(); break;
1602 if (PAL.getRetAttributes() != Attribute::None)
1603 Out << ' ' << Attribute::getAsString(PAL.getRetAttributes());
1605 // If possible, print out the short form of the invoke instruction. We can
1606 // only do this if the first argument is a pointer to a nonvararg function,
1607 // and if the return type is not a pointer to a function.
1610 if (!FTy->isVarArg() &&
1611 (!isa<PointerType>(RetTy) ||
1612 !isa<FunctionType>(cast<PointerType>(RetTy)->getElementType()))) {
1615 writeOperand(Operand, false);
1617 writeOperand(Operand, true);
1620 for (unsigned op = 3, Eop = I.getNumOperands(); op < Eop; ++op) {
1623 writeParamOperand(I.getOperand(op), PAL.getParamAttributes(op-2));
1627 if (PAL.getFnAttributes() != Attribute::None)
1628 Out << ' ' << Attribute::getAsString(PAL.getFnAttributes());
1630 Out << "\n\t\t\tto ";
1631 writeOperand(II->getNormalDest(), true);
1633 writeOperand(II->getUnwindDest(), true);
1635 } else if (const AllocationInst *AI = dyn_cast<AllocationInst>(&I)) {
1637 printType(AI->getType()->getElementType());
1638 if (AI->isArrayAllocation()) {
1640 writeOperand(AI->getArraySize(), true);
1642 if (AI->getAlignment()) {
1643 Out << ", align " << AI->getAlignment();
1645 } else if (isa<CastInst>(I)) {
1648 writeOperand(Operand, true); // Work with broken code
1651 printType(I.getType());
1652 } else if (isa<VAArgInst>(I)) {
1655 writeOperand(Operand, true); // Work with broken code
1658 printType(I.getType());
1659 } else if (Operand) { // Print the normal way...
1661 // PrintAllTypes - Instructions who have operands of all the same type
1662 // omit the type from all but the first operand. If the instruction has
1663 // different type operands (for example br), then they are all printed.
1664 bool PrintAllTypes = false;
1665 const Type *TheType = Operand->getType();
1667 // Select, Store and ShuffleVector always print all types.
1668 if (isa<SelectInst>(I) || isa<StoreInst>(I) || isa<ShuffleVectorInst>(I)
1669 || isa<ReturnInst>(I)) {
1670 PrintAllTypes = true;
1672 for (unsigned i = 1, E = I.getNumOperands(); i != E; ++i) {
1673 Operand = I.getOperand(i);
1674 if (Operand->getType() != TheType) {
1675 PrintAllTypes = true; // We have differing types! Print them all!
1681 if (!PrintAllTypes) {
1687 for (unsigned i = 0, E = I.getNumOperands(); i != E; ++i) {
1689 writeOperand(I.getOperand(i), PrintAllTypes);
1693 // Print post operand alignment for load/store
1694 if (isa<LoadInst>(I) && cast<LoadInst>(I).getAlignment()) {
1695 Out << ", align " << cast<LoadInst>(I).getAlignment();
1696 } else if (isa<StoreInst>(I) && cast<StoreInst>(I).getAlignment()) {
1697 Out << ", align " << cast<StoreInst>(I).getAlignment();
1700 printInfoComment(I);
1705 //===----------------------------------------------------------------------===//
1706 // External Interface declarations
1707 //===----------------------------------------------------------------------===//
1709 void Module::print(std::ostream &o, AssemblyAnnotationWriter *AAW) const {
1710 raw_os_ostream OS(o);
1713 void Module::print(raw_ostream &OS, AssemblyAnnotationWriter *AAW) const {
1714 SlotTracker SlotTable(this);
1715 AssemblyWriter W(OS, SlotTable, this, AAW);
1719 void Type::print(std::ostream &o) const {
1720 raw_os_ostream OS(o);
1724 void Type::print(raw_ostream &o) const {
1728 o << getDescription();
1731 void Value::print(raw_ostream &OS, AssemblyAnnotationWriter *AAW) const {
1733 OS << "printing a <null> value\n";
1737 if (const Instruction *I = dyn_cast<Instruction>(this)) {
1738 const Function *F = I->getParent() ? I->getParent()->getParent() : 0;
1739 SlotTracker SlotTable(F);
1740 AssemblyWriter W(OS, SlotTable, F ? F->getParent() : 0, AAW);
1742 } else if (const BasicBlock *BB = dyn_cast<BasicBlock>(this)) {
1743 SlotTracker SlotTable(BB->getParent());
1744 AssemblyWriter W(OS, SlotTable,
1745 BB->getParent() ? BB->getParent()->getParent() : 0, AAW);
1747 } else if (const GlobalValue *GV = dyn_cast<GlobalValue>(this)) {
1748 SlotTracker SlotTable(GV->getParent());
1749 AssemblyWriter W(OS, SlotTable, GV->getParent(), 0);
1751 } else if (const Constant *C = dyn_cast<Constant>(this)) {
1752 OS << C->getType()->getDescription() << ' ';
1753 std::map<const Type *, std::string> TypeTable;
1754 WriteConstantInt(OS, C, TypeTable, 0);
1755 } else if (const Argument *A = dyn_cast<Argument>(this)) {
1756 WriteAsOperand(OS, this, true,
1757 A->getParent() ? A->getParent()->getParent() : 0);
1758 } else if (isa<InlineAsm>(this)) {
1759 WriteAsOperand(OS, this, true, 0);
1761 assert(0 && "Unknown value to print out!");
1765 void Value::print(std::ostream &O, AssemblyAnnotationWriter *AAW) const {
1766 raw_os_ostream OS(O);
1770 // Value::dump - allow easy printing of Values from the debugger.
1771 void Value::dump() const { print(errs()); errs() << '\n'; errs().flush(); }
1773 // Type::dump - allow easy printing of Types from the debugger.
1774 void Type::dump() const { print(errs()); errs() << '\n'; errs().flush(); }
1776 // Type::dump - allow easy printing of Types from the debugger.
1777 // This one uses type names from the given context module
1778 void Type::dump(const Module *Context) const {
1779 WriteTypeSymbolic(errs(), this, Context);
1784 // Module::dump() - Allow printing of Modules from the debugger.
1785 void Module::dump() const { print(errs(), 0); errs().flush(); }