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/DenseSet.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 /// PrintLLVMName - Turn the specified name into an 'LLVM name', which is either
129 /// prefixed with % (if the string only contains simple characters) or is
130 /// surrounded with ""'s (if it has special chars in it). Print it out.
131 static void PrintLLVMName(raw_ostream &OS, const Value *V) {
132 PrintLLVMName(OS, V->getNameStart(), V->getNameLen(),
133 isa<GlobalValue>(V) ? GlobalPrefix : LocalPrefix);
136 //===----------------------------------------------------------------------===//
137 // TypePrinting Class: Type printing machinery
138 //===----------------------------------------------------------------------===//
140 static DenseMap<const Type *, std::string> &getTypeNamesMap(void *M) {
141 return *static_cast<DenseMap<const Type *, std::string>*>(M);
144 void TypePrinting::clear() {
145 getTypeNamesMap(TypeNames).clear();
148 bool TypePrinting::hasTypeName(const Type *Ty) const {
149 return getTypeNamesMap(TypeNames).count(Ty);
152 void TypePrinting::addTypeName(const Type *Ty, const std::string &N) {
153 getTypeNamesMap(TypeNames).insert(std::make_pair(Ty, N));
157 TypePrinting::TypePrinting() {
158 TypeNames = new DenseMap<const Type *, std::string>();
161 TypePrinting::~TypePrinting() {
162 delete &getTypeNamesMap(TypeNames);
165 /// CalcTypeName - Write the specified type to the specified raw_ostream, making
166 /// use of type names or up references to shorten the type name where possible.
167 void TypePrinting::CalcTypeName(const Type *Ty,
168 SmallVectorImpl<const Type *> &TypeStack,
169 raw_ostream &OS, bool IgnoreTopLevelName) {
170 // Check to see if the type is named.
171 if (!IgnoreTopLevelName) {
172 DenseMap<const Type*, std::string> &TM = getTypeNamesMap(TypeNames);
173 DenseMap<const Type *, std::string>::iterator I = TM.find(Ty);
180 // Check to see if the Type is already on the stack...
181 unsigned Slot = 0, CurSize = TypeStack.size();
182 while (Slot < CurSize && TypeStack[Slot] != Ty) ++Slot; // Scan for type
184 // This is another base case for the recursion. In this case, we know
185 // that we have looped back to a type that we have previously visited.
186 // Generate the appropriate upreference to handle this.
187 if (Slot < CurSize) {
188 OS << '\\' << unsigned(CurSize-Slot); // Here's the upreference
192 TypeStack.push_back(Ty); // Recursive case: Add us to the stack..
194 switch (Ty->getTypeID()) {
195 case Type::VoidTyID: OS << "void"; break;
196 case Type::FloatTyID: OS << "float"; break;
197 case Type::DoubleTyID: OS << "double"; break;
198 case Type::X86_FP80TyID: OS << "x86_fp80"; break;
199 case Type::FP128TyID: OS << "fp128"; break;
200 case Type::PPC_FP128TyID: OS << "ppc_fp128"; break;
201 case Type::LabelTyID: OS << "label"; break;
202 case Type::IntegerTyID:
203 OS << 'i' << cast<IntegerType>(Ty)->getBitWidth();
206 case Type::FunctionTyID: {
207 const FunctionType *FTy = cast<FunctionType>(Ty);
208 CalcTypeName(FTy->getReturnType(), TypeStack, OS);
210 for (FunctionType::param_iterator I = FTy->param_begin(),
211 E = FTy->param_end(); I != E; ++I) {
212 if (I != FTy->param_begin())
214 CalcTypeName(*I, TypeStack, OS);
216 if (FTy->isVarArg()) {
217 if (FTy->getNumParams()) OS << ", ";
223 case Type::StructTyID: {
224 const StructType *STy = cast<StructType>(Ty);
228 for (StructType::element_iterator I = STy->element_begin(),
229 E = STy->element_end(); I != E; ++I) {
230 CalcTypeName(*I, TypeStack, OS);
231 if (next(I) != STy->element_end())
240 case Type::PointerTyID: {
241 const PointerType *PTy = cast<PointerType>(Ty);
242 CalcTypeName(PTy->getElementType(), TypeStack, OS);
243 if (unsigned AddressSpace = PTy->getAddressSpace())
244 OS << " addrspace(" << AddressSpace << ')';
248 case Type::ArrayTyID: {
249 const ArrayType *ATy = cast<ArrayType>(Ty);
250 OS << '[' << ATy->getNumElements() << " x ";
251 CalcTypeName(ATy->getElementType(), TypeStack, OS);
255 case Type::VectorTyID: {
256 const VectorType *PTy = cast<VectorType>(Ty);
257 OS << "<" << PTy->getNumElements() << " x ";
258 CalcTypeName(PTy->getElementType(), TypeStack, OS);
262 case Type::OpaqueTyID:
266 OS << "<unrecognized-type>";
270 TypeStack.pop_back(); // Remove self from stack.
273 /// printTypeInt - The internal guts of printing out a type that has a
274 /// potentially named portion.
276 void TypePrinting::print(const Type *Ty, raw_ostream &OS,
277 bool IgnoreTopLevelName) {
278 // Check to see if the type is named.
279 DenseMap<const Type*, std::string> &TM = getTypeNamesMap(TypeNames);
280 if (!IgnoreTopLevelName) {
281 DenseMap<const Type*, std::string>::iterator I = TM.find(Ty);
288 // Otherwise we have a type that has not been named but is a derived type.
289 // Carefully recurse the type hierarchy to print out any contained symbolic
291 SmallVector<const Type *, 16> TypeStack;
292 std::string TypeName;
294 raw_string_ostream TypeOS(TypeName);
295 CalcTypeName(Ty, TypeStack, TypeOS, IgnoreTopLevelName);
298 // Cache type name for later use.
299 if (!IgnoreTopLevelName)
300 TM.insert(std::make_pair(Ty, TypeOS.str()));
305 // To avoid walking constant expressions multiple times and other IR
306 // objects, we keep several helper maps.
307 DenseSet<const Value*> VisitedConstants;
308 DenseSet<const Type*> VisitedTypes;
311 std::vector<const Type*> &NumberedTypes;
313 TypeFinder(TypePrinting &tp, std::vector<const Type*> &numberedTypes)
314 : TP(tp), NumberedTypes(numberedTypes) {}
316 void Run(const Module &M) {
317 // Get types from the type symbol table. This gets opaque types referened
318 // only through derived named types.
319 const TypeSymbolTable &ST = M.getTypeSymbolTable();
320 for (TypeSymbolTable::const_iterator TI = ST.begin(), E = ST.end();
322 IncorporateType(TI->second);
324 // Get types from global variables.
325 for (Module::const_global_iterator I = M.global_begin(),
326 E = M.global_end(); I != E; ++I) {
327 IncorporateType(I->getType());
328 if (I->hasInitializer())
329 IncorporateValue(I->getInitializer());
332 // Get types from aliases.
333 for (Module::const_alias_iterator I = M.alias_begin(),
334 E = M.alias_end(); I != E; ++I) {
335 IncorporateType(I->getType());
336 IncorporateValue(I->getAliasee());
339 // Get types from functions.
340 for (Module::const_iterator FI = M.begin(), E = M.end(); FI != E; ++FI) {
341 IncorporateType(FI->getType());
343 for (Function::const_iterator BB = FI->begin(), E = FI->end();
345 for (BasicBlock::const_iterator II = BB->begin(),
346 E = BB->end(); II != E; ++II) {
347 const Instruction &I = *II;
348 // Incorporate the type of the instruction and all its operands.
349 IncorporateType(I.getType());
350 for (User::const_op_iterator OI = I.op_begin(), OE = I.op_end();
352 IncorporateValue(*OI);
358 void IncorporateType(const Type *Ty) {
359 // Check to see if we're already visited this type.
360 if (!VisitedTypes.insert(Ty).second)
363 // If this is a structure or opaque type, add a name for the type.
364 if ((isa<StructType>(Ty) || isa<OpaqueType>(Ty))
365 && !TP.hasTypeName(Ty)) {
366 TP.addTypeName(Ty, "%"+utostr(unsigned(NumberedTypes.size())));
367 NumberedTypes.push_back(Ty);
370 // Recursively walk all contained types.
371 for (Type::subtype_iterator I = Ty->subtype_begin(),
372 E = Ty->subtype_end(); I != E; ++I)
376 /// IncorporateValue - This method is used to walk operand lists finding
377 /// types hiding in constant expressions and other operands that won't be
378 /// walked in other ways. GlobalValues, basic blocks, instructions, and
379 /// inst operands are all explicitly enumerated.
380 void IncorporateValue(const Value *V) {
381 if (V == 0 || !isa<Constant>(V) || isa<GlobalValue>(V)) return;
384 if (!VisitedConstants.insert(V).second)
388 IncorporateType(V->getType());
390 // Look in operands for types.
391 const Constant *C = cast<Constant>(V);
392 for (Constant::const_op_iterator I = C->op_begin(),
393 E = C->op_end(); I != E;++I)
394 IncorporateValue(*I);
397 } // end anonymous namespace
400 /// AddModuleTypesToPrinter - Add all of the symbolic type names for types in
401 /// the specified module to the TypePrinter and all numbered types to it and the
402 /// NumberedTypes table.
403 static void AddModuleTypesToPrinter(TypePrinting &TP,
404 std::vector<const Type*> &NumberedTypes,
408 // If the module has a symbol table, take all global types and stuff their
409 // names into the TypeNames map.
410 const TypeSymbolTable &ST = M->getTypeSymbolTable();
411 for (TypeSymbolTable::const_iterator TI = ST.begin(), E = ST.end();
413 const Type *Ty = cast<Type>(TI->second);
415 // As a heuristic, don't insert pointer to primitive types, because
416 // they are used too often to have a single useful name.
417 if (const PointerType *PTy = dyn_cast<PointerType>(Ty)) {
418 const Type *PETy = PTy->getElementType();
419 if ((PETy->isPrimitiveType() || PETy->isInteger()) &&
420 !isa<OpaqueType>(PETy))
424 // Likewise don't insert primitives either.
425 if (Ty->isInteger() || Ty->isPrimitiveType())
428 // Get the name as a string and insert it into TypeNames.
430 raw_string_ostream NameOS(NameStr);
431 PrintLLVMName(NameOS, TI->first.c_str(), TI->first.length(), LocalPrefix);
432 TP.addTypeName(Ty, NameOS.str());
435 // Walk the entire module to find references to unnamed structure and opaque
436 // types. This is required for correctness by opaque types (because multiple
437 // uses of an unnamed opaque type needs to be referred to by the same ID) and
438 // it shrinks complex recursive structure types substantially in some cases.
439 TypeFinder(TP, NumberedTypes).Run(*M);
443 /// WriteTypeSymbolic - This attempts to write the specified type as a symbolic
444 /// type, iff there is an entry in the modules symbol table for the specified
445 /// type or one of it's component types.
447 void llvm::WriteTypeSymbolic(raw_ostream &OS, const Type *Ty, const Module *M) {
448 TypePrinting Printer;
449 std::vector<const Type*> NumberedTypes;
450 AddModuleTypesToPrinter(Printer, NumberedTypes, M);
451 Printer.print(Ty, OS);
454 //===----------------------------------------------------------------------===//
455 // SlotTracker Class: Enumerate slot numbers for unnamed values
456 //===----------------------------------------------------------------------===//
460 /// This class provides computation of slot numbers for LLVM Assembly writing.
464 /// ValueMap - A mapping of Values to slot numbers
465 typedef DenseMap<const Value*, unsigned> ValueMap;
468 /// TheModule - The module for which we are holding slot numbers
469 const Module* TheModule;
471 /// TheFunction - The function for which we are holding slot numbers
472 const Function* TheFunction;
473 bool FunctionProcessed;
475 /// mMap - The TypePlanes map for the module level data
479 /// fMap - The TypePlanes map for the function level data
484 /// Construct from a module
485 explicit SlotTracker(const Module *M);
486 /// Construct from a function, starting out in incorp state.
487 explicit SlotTracker(const Function *F);
489 /// Return the slot number of the specified value in it's type
490 /// plane. If something is not in the SlotTracker, return -1.
491 int getLocalSlot(const Value *V);
492 int getGlobalSlot(const GlobalValue *V);
494 /// If you'd like to deal with a function instead of just a module, use
495 /// this method to get its data into the SlotTracker.
496 void incorporateFunction(const Function *F) {
498 FunctionProcessed = false;
501 /// After calling incorporateFunction, use this method to remove the
502 /// most recently incorporated function from the SlotTracker. This
503 /// will reset the state of the machine back to just the module contents.
504 void purgeFunction();
506 // Implementation Details
508 /// This function does the actual initialization.
509 inline void initialize();
511 /// CreateModuleSlot - Insert the specified GlobalValue* into the slot table.
512 void CreateModuleSlot(const GlobalValue *V);
514 /// CreateFunctionSlot - Insert the specified Value* into the slot table.
515 void CreateFunctionSlot(const Value *V);
517 /// Add all of the module level global variables (and their initializers)
518 /// and function declarations, but not the contents of those functions.
519 void processModule();
521 /// Add all of the functions arguments, basic blocks, and instructions
522 void processFunction();
524 SlotTracker(const SlotTracker &); // DO NOT IMPLEMENT
525 void operator=(const SlotTracker &); // DO NOT IMPLEMENT
528 } // end anonymous namespace
531 static SlotTracker *createSlotTracker(const Value *V) {
532 if (const Argument *FA = dyn_cast<Argument>(V))
533 return new SlotTracker(FA->getParent());
535 if (const Instruction *I = dyn_cast<Instruction>(V))
536 return new SlotTracker(I->getParent()->getParent());
538 if (const BasicBlock *BB = dyn_cast<BasicBlock>(V))
539 return new SlotTracker(BB->getParent());
541 if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(V))
542 return new SlotTracker(GV->getParent());
544 if (const GlobalAlias *GA = dyn_cast<GlobalAlias>(V))
545 return new SlotTracker(GA->getParent());
547 if (const Function *Func = dyn_cast<Function>(V))
548 return new SlotTracker(Func);
554 #define ST_DEBUG(X) cerr << X
559 // Module level constructor. Causes the contents of the Module (sans functions)
560 // to be added to the slot table.
561 SlotTracker::SlotTracker(const Module *M)
562 : TheModule(M), TheFunction(0), FunctionProcessed(false), mNext(0), fNext(0) {
565 // Function level constructor. Causes the contents of the Module and the one
566 // function provided to be added to the slot table.
567 SlotTracker::SlotTracker(const Function *F)
568 : TheModule(F ? F->getParent() : 0), TheFunction(F), FunctionProcessed(false),
572 inline void SlotTracker::initialize() {
575 TheModule = 0; ///< Prevent re-processing next time we're called.
578 if (TheFunction && !FunctionProcessed)
582 // Iterate through all the global variables, functions, and global
583 // variable initializers and create slots for them.
584 void SlotTracker::processModule() {
585 ST_DEBUG("begin processModule!\n");
587 // Add all of the unnamed global variables to the value table.
588 for (Module::const_global_iterator I = TheModule->global_begin(),
589 E = TheModule->global_end(); I != E; ++I)
593 // Add all the unnamed functions to the table.
594 for (Module::const_iterator I = TheModule->begin(), E = TheModule->end();
599 ST_DEBUG("end processModule!\n");
603 // Process the arguments, basic blocks, and instructions of a function.
604 void SlotTracker::processFunction() {
605 ST_DEBUG("begin processFunction!\n");
608 // Add all the function arguments with no names.
609 for(Function::const_arg_iterator AI = TheFunction->arg_begin(),
610 AE = TheFunction->arg_end(); AI != AE; ++AI)
612 CreateFunctionSlot(AI);
614 ST_DEBUG("Inserting Instructions:\n");
616 // Add all of the basic blocks and instructions with no names.
617 for (Function::const_iterator BB = TheFunction->begin(),
618 E = TheFunction->end(); BB != E; ++BB) {
620 CreateFunctionSlot(BB);
621 for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I != E; ++I)
622 if (I->getType() != Type::VoidTy && !I->hasName())
623 CreateFunctionSlot(I);
626 FunctionProcessed = true;
628 ST_DEBUG("end processFunction!\n");
631 /// Clean up after incorporating a function. This is the only way to get out of
632 /// the function incorporation state that affects get*Slot/Create*Slot. Function
633 /// incorporation state is indicated by TheFunction != 0.
634 void SlotTracker::purgeFunction() {
635 ST_DEBUG("begin purgeFunction!\n");
636 fMap.clear(); // Simply discard the function level map
638 FunctionProcessed = false;
639 ST_DEBUG("end purgeFunction!\n");
642 /// getGlobalSlot - Get the slot number of a global value.
643 int SlotTracker::getGlobalSlot(const GlobalValue *V) {
644 // Check for uninitialized state and do lazy initialization.
647 // Find the type plane in the module map
648 ValueMap::iterator MI = mMap.find(V);
649 return MI == mMap.end() ? -1 : (int)MI->second;
653 /// getLocalSlot - Get the slot number for a value that is local to a function.
654 int SlotTracker::getLocalSlot(const Value *V) {
655 assert(!isa<Constant>(V) && "Can't get a constant or global slot with this!");
657 // Check for uninitialized state and do lazy initialization.
660 ValueMap::iterator FI = fMap.find(V);
661 return FI == fMap.end() ? -1 : (int)FI->second;
665 /// CreateModuleSlot - Insert the specified GlobalValue* into the slot table.
666 void SlotTracker::CreateModuleSlot(const GlobalValue *V) {
667 assert(V && "Can't insert a null Value into SlotTracker!");
668 assert(V->getType() != Type::VoidTy && "Doesn't need a slot!");
669 assert(!V->hasName() && "Doesn't need a slot!");
671 unsigned DestSlot = mNext++;
674 ST_DEBUG(" Inserting value [" << V->getType() << "] = " << V << " slot=" <<
676 // G = Global, F = Function, A = Alias, o = other
677 ST_DEBUG((isa<GlobalVariable>(V) ? 'G' :
678 (isa<Function>(V) ? 'F' :
679 (isa<GlobalAlias>(V) ? 'A' : 'o'))) << "]\n");
683 /// CreateSlot - Create a new slot for the specified value if it has no name.
684 void SlotTracker::CreateFunctionSlot(const Value *V) {
685 assert(V->getType() != Type::VoidTy && !V->hasName() &&
686 "Doesn't need a slot!");
688 unsigned DestSlot = fNext++;
691 // G = Global, F = Function, o = other
692 ST_DEBUG(" Inserting value [" << V->getType() << "] = " << V << " slot=" <<
693 DestSlot << " [o]\n");
698 //===----------------------------------------------------------------------===//
699 // AsmWriter Implementation
700 //===----------------------------------------------------------------------===//
702 static void WriteAsOperandInternal(raw_ostream &Out, const Value *V,
703 TypePrinting &TypePrinter,
704 SlotTracker *Machine);
708 static const char *getPredicateText(unsigned predicate) {
709 const char * pred = "unknown";
711 case FCmpInst::FCMP_FALSE: pred = "false"; break;
712 case FCmpInst::FCMP_OEQ: pred = "oeq"; break;
713 case FCmpInst::FCMP_OGT: pred = "ogt"; break;
714 case FCmpInst::FCMP_OGE: pred = "oge"; break;
715 case FCmpInst::FCMP_OLT: pred = "olt"; break;
716 case FCmpInst::FCMP_OLE: pred = "ole"; break;
717 case FCmpInst::FCMP_ONE: pred = "one"; break;
718 case FCmpInst::FCMP_ORD: pred = "ord"; break;
719 case FCmpInst::FCMP_UNO: pred = "uno"; break;
720 case FCmpInst::FCMP_UEQ: pred = "ueq"; break;
721 case FCmpInst::FCMP_UGT: pred = "ugt"; break;
722 case FCmpInst::FCMP_UGE: pred = "uge"; break;
723 case FCmpInst::FCMP_ULT: pred = "ult"; break;
724 case FCmpInst::FCMP_ULE: pred = "ule"; break;
725 case FCmpInst::FCMP_UNE: pred = "une"; break;
726 case FCmpInst::FCMP_TRUE: pred = "true"; break;
727 case ICmpInst::ICMP_EQ: pred = "eq"; break;
728 case ICmpInst::ICMP_NE: pred = "ne"; break;
729 case ICmpInst::ICMP_SGT: pred = "sgt"; break;
730 case ICmpInst::ICMP_SGE: pred = "sge"; break;
731 case ICmpInst::ICMP_SLT: pred = "slt"; break;
732 case ICmpInst::ICMP_SLE: pred = "sle"; break;
733 case ICmpInst::ICMP_UGT: pred = "ugt"; break;
734 case ICmpInst::ICMP_UGE: pred = "uge"; break;
735 case ICmpInst::ICMP_ULT: pred = "ult"; break;
736 case ICmpInst::ICMP_ULE: pred = "ule"; break;
741 static void WriteConstantInt(raw_ostream &Out, const Constant *CV,
742 TypePrinting &TypePrinter, SlotTracker *Machine) {
743 if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV)) {
744 if (CI->getType() == Type::Int1Ty) {
745 Out << (CI->getZExtValue() ? "true" : "false");
748 Out << CI->getValue();
752 if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV)) {
753 if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEdouble ||
754 &CFP->getValueAPF().getSemantics() == &APFloat::IEEEsingle) {
755 // We would like to output the FP constant value in exponential notation,
756 // but we cannot do this if doing so will lose precision. Check here to
757 // make sure that we only output it in exponential format if we can parse
758 // the value back and get the same value.
761 bool isDouble = &CFP->getValueAPF().getSemantics()==&APFloat::IEEEdouble;
762 double Val = isDouble ? CFP->getValueAPF().convertToDouble() :
763 CFP->getValueAPF().convertToFloat();
764 std::string StrVal = ftostr(CFP->getValueAPF());
766 // Check to make sure that the stringized number is not some string like
767 // "Inf" or NaN, that atof will accept, but the lexer will not. Check
768 // that the string matches the "[-+]?[0-9]" regex.
770 if ((StrVal[0] >= '0' && StrVal[0] <= '9') ||
771 ((StrVal[0] == '-' || StrVal[0] == '+') &&
772 (StrVal[1] >= '0' && StrVal[1] <= '9'))) {
773 // Reparse stringized version!
774 if (atof(StrVal.c_str()) == Val) {
779 // Otherwise we could not reparse it to exactly the same value, so we must
780 // output the string in hexadecimal format! Note that loading and storing
781 // floating point types changes the bits of NaNs on some hosts, notably
782 // x86, so we must not use these types.
783 assert(sizeof(double) == sizeof(uint64_t) &&
784 "assuming that double is 64 bits!");
786 APFloat apf = CFP->getValueAPF();
787 // Floats are represented in ASCII IR as double, convert.
789 apf.convert(APFloat::IEEEdouble, APFloat::rmNearestTiesToEven,
792 utohex_buffer(uint64_t(apf.bitcastToAPInt().getZExtValue()),
797 // Some form of long double. These appear as a magic letter identifying
798 // the type, then a fixed number of hex digits.
800 if (&CFP->getValueAPF().getSemantics() == &APFloat::x87DoubleExtended)
802 else if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEquad)
804 else if (&CFP->getValueAPF().getSemantics() == &APFloat::PPCDoubleDouble)
807 assert(0 && "Unsupported floating point type");
808 // api needed to prevent premature destruction
809 APInt api = CFP->getValueAPF().bitcastToAPInt();
810 const uint64_t* p = api.getRawData();
813 int width = api.getBitWidth();
814 for (int j=0; j<width; j+=4, shiftcount-=4) {
815 unsigned int nibble = (word>>shiftcount) & 15;
817 Out << (unsigned char)(nibble + '0');
819 Out << (unsigned char)(nibble - 10 + 'A');
820 if (shiftcount == 0 && j+4 < width) {
824 shiftcount = width-j-4;
830 if (isa<ConstantAggregateZero>(CV)) {
831 Out << "zeroinitializer";
835 if (const ConstantArray *CA = dyn_cast<ConstantArray>(CV)) {
836 // As a special case, print the array as a string if it is an array of
837 // i8 with ConstantInt values.
839 const Type *ETy = CA->getType()->getElementType();
840 if (CA->isString()) {
842 PrintEscapedString(CA->getAsString(), Out);
844 } else { // Cannot output in string format...
846 if (CA->getNumOperands()) {
847 TypePrinter.print(ETy, Out);
849 WriteAsOperandInternal(Out, CA->getOperand(0),
850 TypePrinter, Machine);
851 for (unsigned i = 1, e = CA->getNumOperands(); i != e; ++i) {
853 TypePrinter.print(ETy, Out);
855 WriteAsOperandInternal(Out, CA->getOperand(i), TypePrinter, Machine);
863 if (const ConstantStruct *CS = dyn_cast<ConstantStruct>(CV)) {
864 if (CS->getType()->isPacked())
867 unsigned N = CS->getNumOperands();
870 TypePrinter.print(CS->getOperand(0)->getType(), Out);
873 WriteAsOperandInternal(Out, CS->getOperand(0), TypePrinter, Machine);
875 for (unsigned i = 1; i < N; i++) {
877 TypePrinter.print(CS->getOperand(i)->getType(), Out);
880 WriteAsOperandInternal(Out, CS->getOperand(i), TypePrinter, Machine);
886 if (CS->getType()->isPacked())
891 if (const ConstantVector *CP = dyn_cast<ConstantVector>(CV)) {
892 const Type *ETy = CP->getType()->getElementType();
893 assert(CP->getNumOperands() > 0 &&
894 "Number of operands for a PackedConst must be > 0");
896 TypePrinter.print(ETy, Out);
898 WriteAsOperandInternal(Out, CP->getOperand(0), TypePrinter, Machine);
899 for (unsigned i = 1, e = CP->getNumOperands(); i != e; ++i) {
901 TypePrinter.print(ETy, Out);
903 WriteAsOperandInternal(Out, CP->getOperand(i), TypePrinter, Machine);
909 if (isa<ConstantPointerNull>(CV)) {
914 if (isa<UndefValue>(CV)) {
919 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV)) {
920 Out << CE->getOpcodeName();
922 Out << ' ' << getPredicateText(CE->getPredicate());
925 for (User::const_op_iterator OI=CE->op_begin(); OI != CE->op_end(); ++OI) {
926 TypePrinter.print((*OI)->getType(), Out);
928 WriteAsOperandInternal(Out, *OI, TypePrinter, Machine);
929 if (OI+1 != CE->op_end())
933 if (CE->hasIndices()) {
934 const SmallVector<unsigned, 4> &Indices = CE->getIndices();
935 for (unsigned i = 0, e = Indices.size(); i != e; ++i)
936 Out << ", " << Indices[i];
941 TypePrinter.print(CE->getType(), Out);
948 Out << "<placeholder or erroneous Constant>";
952 /// WriteAsOperand - Write the name of the specified value out to the specified
953 /// ostream. This can be useful when you just want to print int %reg126, not
954 /// the whole instruction that generated it.
956 static void WriteAsOperandInternal(raw_ostream &Out, const Value *V,
957 TypePrinting &TypePrinter,
958 SlotTracker *Machine) {
960 PrintLLVMName(Out, V);
964 const Constant *CV = dyn_cast<Constant>(V);
965 if (CV && !isa<GlobalValue>(CV)) {
966 WriteConstantInt(Out, CV, TypePrinter, Machine);
970 if (const InlineAsm *IA = dyn_cast<InlineAsm>(V)) {
972 if (IA->hasSideEffects())
973 Out << "sideeffect ";
975 PrintEscapedString(IA->getAsmString(), Out);
977 PrintEscapedString(IA->getConstraintString(), Out);
985 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
986 Slot = Machine->getGlobalSlot(GV);
989 Slot = Machine->getLocalSlot(V);
992 Machine = createSlotTracker(V);
994 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
995 Slot = Machine->getGlobalSlot(GV);
998 Slot = Machine->getLocalSlot(V);
1007 Out << Prefix << Slot;
1012 /// WriteAsOperand - Write the name of the specified value out to the specified
1013 /// ostream. This can be useful when you just want to print int %reg126, not
1014 /// the whole instruction that generated it.
1016 void llvm::WriteAsOperand(std::ostream &Out, const Value *V, bool PrintType,
1017 const Module *Context) {
1018 raw_os_ostream OS(Out);
1019 WriteAsOperand(OS, V, PrintType, Context);
1022 void llvm::WriteAsOperand(raw_ostream &Out, const Value *V, bool PrintType,
1023 const Module *Context) {
1024 if (Context == 0) Context = getModuleFromVal(V);
1026 TypePrinting TypePrinter;
1027 std::vector<const Type*> NumberedTypes;
1028 AddModuleTypesToPrinter(TypePrinter, NumberedTypes, Context);
1030 TypePrinter.print(V->getType(), Out);
1034 WriteAsOperandInternal(Out, V, TypePrinter, 0);
1040 class AssemblyWriter {
1042 SlotTracker &Machine;
1043 const Module *TheModule;
1044 TypePrinting TypePrinter;
1045 AssemblyAnnotationWriter *AnnotationWriter;
1046 std::vector<const Type*> NumberedTypes;
1048 inline AssemblyWriter(raw_ostream &o, SlotTracker &Mac, const Module *M,
1049 AssemblyAnnotationWriter *AAW)
1050 : Out(o), Machine(Mac), TheModule(M), AnnotationWriter(AAW) {
1051 AddModuleTypesToPrinter(TypePrinter, NumberedTypes, M);
1054 void write(const Module *M) { printModule(M); }
1056 void write(const GlobalValue *G) {
1057 if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(G))
1059 else if (const GlobalAlias *GA = dyn_cast<GlobalAlias>(G))
1061 else if (const Function *F = dyn_cast<Function>(G))
1064 assert(0 && "Unknown global");
1067 void write(const BasicBlock *BB) { printBasicBlock(BB); }
1068 void write(const Instruction *I) { printInstruction(*I); }
1070 void writeOperand(const Value *Op, bool PrintType);
1071 void writeParamOperand(const Value *Operand, Attributes Attrs);
1073 const Module* getModule() { return TheModule; }
1076 void printModule(const Module *M);
1077 void printTypeSymbolTable(const TypeSymbolTable &ST);
1078 void printGlobal(const GlobalVariable *GV);
1079 void printAlias(const GlobalAlias *GV);
1080 void printFunction(const Function *F);
1081 void printArgument(const Argument *FA, Attributes Attrs);
1082 void printBasicBlock(const BasicBlock *BB);
1083 void printInstruction(const Instruction &I);
1085 // printInfoComment - Print a little comment after the instruction indicating
1086 // which slot it occupies.
1087 void printInfoComment(const Value &V);
1089 } // end of anonymous namespace
1092 void AssemblyWriter::writeOperand(const Value *Operand, bool PrintType) {
1094 Out << "<null operand!>";
1097 TypePrinter.print(Operand->getType(), Out);
1100 WriteAsOperandInternal(Out, Operand, TypePrinter, &Machine);
1104 void AssemblyWriter::writeParamOperand(const Value *Operand,
1107 Out << "<null operand!>";
1110 TypePrinter.print(Operand->getType(), Out);
1111 // Print parameter attributes list
1112 if (Attrs != Attribute::None)
1113 Out << ' ' << Attribute::getAsString(Attrs);
1115 // Print the operand
1116 WriteAsOperandInternal(Out, Operand, TypePrinter, &Machine);
1120 void AssemblyWriter::printModule(const Module *M) {
1121 if (!M->getModuleIdentifier().empty() &&
1122 // Don't print the ID if it will start a new line (which would
1123 // require a comment char before it).
1124 M->getModuleIdentifier().find('\n') == std::string::npos)
1125 Out << "; ModuleID = '" << M->getModuleIdentifier() << "'\n";
1127 if (!M->getDataLayout().empty())
1128 Out << "target datalayout = \"" << M->getDataLayout() << "\"\n";
1129 if (!M->getTargetTriple().empty())
1130 Out << "target triple = \"" << M->getTargetTriple() << "\"\n";
1132 if (!M->getModuleInlineAsm().empty()) {
1133 // Split the string into lines, to make it easier to read the .ll file.
1134 std::string Asm = M->getModuleInlineAsm();
1136 size_t NewLine = Asm.find_first_of('\n', CurPos);
1137 while (NewLine != std::string::npos) {
1138 // We found a newline, print the portion of the asm string from the
1139 // last newline up to this newline.
1140 Out << "module asm \"";
1141 PrintEscapedString(std::string(Asm.begin()+CurPos, Asm.begin()+NewLine),
1145 NewLine = Asm.find_first_of('\n', CurPos);
1147 Out << "module asm \"";
1148 PrintEscapedString(std::string(Asm.begin()+CurPos, Asm.end()), Out);
1152 // Loop over the dependent libraries and emit them.
1153 Module::lib_iterator LI = M->lib_begin();
1154 Module::lib_iterator LE = M->lib_end();
1156 Out << "deplibs = [ ";
1158 Out << '"' << *LI << '"';
1166 // Loop over the symbol table, emitting all id'd types.
1167 printTypeSymbolTable(M->getTypeSymbolTable());
1169 for (Module::const_global_iterator I = M->global_begin(), E = M->global_end();
1173 // Output all aliases.
1174 if (!M->alias_empty()) Out << "\n";
1175 for (Module::const_alias_iterator I = M->alias_begin(), E = M->alias_end();
1179 // Output all of the functions.
1180 for (Module::const_iterator I = M->begin(), E = M->end(); I != E; ++I)
1184 static void PrintLinkage(GlobalValue::LinkageTypes LT, raw_ostream &Out) {
1186 case GlobalValue::PrivateLinkage: Out << "private "; break;
1187 case GlobalValue::InternalLinkage: Out << "internal "; break;
1188 case GlobalValue::LinkOnceAnyLinkage: Out << "linkonce "; break;
1189 case GlobalValue::LinkOnceODRLinkage: Out << "linkonce_odr "; break;
1190 case GlobalValue::WeakAnyLinkage: Out << "weak "; break;
1191 case GlobalValue::WeakODRLinkage: Out << "weak_odr "; break;
1192 case GlobalValue::CommonLinkage: Out << "common "; break;
1193 case GlobalValue::AppendingLinkage: Out << "appending "; break;
1194 case GlobalValue::DLLImportLinkage: Out << "dllimport "; break;
1195 case GlobalValue::DLLExportLinkage: Out << "dllexport "; break;
1196 case GlobalValue::ExternalWeakLinkage: Out << "extern_weak "; break;
1197 case GlobalValue::ExternalLinkage: break;
1198 case GlobalValue::GhostLinkage:
1199 Out << "GhostLinkage not allowed in AsmWriter!\n";
1205 static void PrintVisibility(GlobalValue::VisibilityTypes Vis,
1208 default: assert(0 && "Invalid visibility style!");
1209 case GlobalValue::DefaultVisibility: break;
1210 case GlobalValue::HiddenVisibility: Out << "hidden "; break;
1211 case GlobalValue::ProtectedVisibility: Out << "protected "; break;
1215 void AssemblyWriter::printGlobal(const GlobalVariable *GV) {
1216 if (GV->hasName()) {
1217 PrintLLVMName(Out, GV);
1221 if (!GV->hasInitializer() && GV->hasExternalLinkage())
1224 PrintLinkage(GV->getLinkage(), Out);
1225 PrintVisibility(GV->getVisibility(), Out);
1227 if (GV->isThreadLocal()) Out << "thread_local ";
1228 if (unsigned AddressSpace = GV->getType()->getAddressSpace())
1229 Out << "addrspace(" << AddressSpace << ") ";
1230 Out << (GV->isConstant() ? "constant " : "global ");
1231 TypePrinter.print(GV->getType()->getElementType(), Out);
1233 if (GV->hasInitializer()) {
1235 writeOperand(GV->getInitializer(), false);
1238 if (GV->hasSection())
1239 Out << ", section \"" << GV->getSection() << '"';
1240 if (GV->getAlignment())
1241 Out << ", align " << GV->getAlignment();
1243 printInfoComment(*GV);
1247 void AssemblyWriter::printAlias(const GlobalAlias *GA) {
1248 // Don't crash when dumping partially built GA
1250 Out << "<<nameless>> = ";
1252 PrintLLVMName(Out, GA);
1255 PrintVisibility(GA->getVisibility(), Out);
1259 PrintLinkage(GA->getLinkage(), Out);
1261 const Constant *Aliasee = GA->getAliasee();
1263 if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(Aliasee)) {
1264 TypePrinter.print(GV->getType(), Out);
1266 PrintLLVMName(Out, GV);
1267 } else if (const Function *F = dyn_cast<Function>(Aliasee)) {
1268 TypePrinter.print(F->getFunctionType(), Out);
1271 WriteAsOperandInternal(Out, F, TypePrinter, &Machine);
1272 } else if (const GlobalAlias *GA = dyn_cast<GlobalAlias>(Aliasee)) {
1273 TypePrinter.print(GA->getType(), Out);
1275 PrintLLVMName(Out, GA);
1277 const ConstantExpr *CE = 0;
1278 if ((CE = dyn_cast<ConstantExpr>(Aliasee)) &&
1279 (CE->getOpcode() == Instruction::BitCast)) {
1280 writeOperand(CE, false);
1282 assert(0 && "Unsupported aliasee");
1285 printInfoComment(*GA);
1289 void AssemblyWriter::printTypeSymbolTable(const TypeSymbolTable &ST) {
1290 // Emit all numbered types.
1291 for (unsigned i = 0, e = NumberedTypes.size(); i != e; ++i) {
1294 // Make sure we print out at least one level of the type structure, so
1295 // that we do not get %2 = type %2
1296 TypePrinter.printAtLeastOneLevel(NumberedTypes[i], Out);
1297 Out << "\t\t; type %" << i << '\n';
1300 // Print the named types.
1301 for (TypeSymbolTable::const_iterator TI = ST.begin(), TE = ST.end();
1304 PrintLLVMName(Out, &TI->first[0], TI->first.size(), LocalPrefix);
1307 // Make sure we print out at least one level of the type structure, so
1308 // that we do not get %FILE = type %FILE
1309 TypePrinter.printAtLeastOneLevel(TI->second, Out);
1314 /// printFunction - Print all aspects of a function.
1316 void AssemblyWriter::printFunction(const Function *F) {
1317 // Print out the return type and name.
1320 if (AnnotationWriter) AnnotationWriter->emitFunctionAnnot(F, Out);
1322 if (F->isDeclaration())
1327 PrintLinkage(F->getLinkage(), Out);
1328 PrintVisibility(F->getVisibility(), Out);
1330 // Print the calling convention.
1331 switch (F->getCallingConv()) {
1332 case CallingConv::C: break; // default
1333 case CallingConv::Fast: Out << "fastcc "; break;
1334 case CallingConv::Cold: Out << "coldcc "; break;
1335 case CallingConv::X86_StdCall: Out << "x86_stdcallcc "; break;
1336 case CallingConv::X86_FastCall: Out << "x86_fastcallcc "; break;
1337 default: Out << "cc" << F->getCallingConv() << " "; break;
1340 const FunctionType *FT = F->getFunctionType();
1341 const AttrListPtr &Attrs = F->getAttributes();
1342 Attributes RetAttrs = Attrs.getRetAttributes();
1343 if (RetAttrs != Attribute::None)
1344 Out << Attribute::getAsString(Attrs.getRetAttributes()) << ' ';
1345 TypePrinter.print(F->getReturnType(), Out);
1347 WriteAsOperandInternal(Out, F, TypePrinter, &Machine);
1349 Machine.incorporateFunction(F);
1351 // Loop over the arguments, printing them...
1354 if (!F->isDeclaration()) {
1355 // If this isn't a declaration, print the argument names as well.
1356 for (Function::const_arg_iterator I = F->arg_begin(), E = F->arg_end();
1358 // Insert commas as we go... the first arg doesn't get a comma
1359 if (I != F->arg_begin()) Out << ", ";
1360 printArgument(I, Attrs.getParamAttributes(Idx));
1364 // Otherwise, print the types from the function type.
1365 for (unsigned i = 0, e = FT->getNumParams(); i != e; ++i) {
1366 // Insert commas as we go... the first arg doesn't get a comma
1370 TypePrinter.print(FT->getParamType(i), Out);
1372 Attributes ArgAttrs = Attrs.getParamAttributes(i+1);
1373 if (ArgAttrs != Attribute::None)
1374 Out << ' ' << Attribute::getAsString(ArgAttrs);
1378 // Finish printing arguments...
1379 if (FT->isVarArg()) {
1380 if (FT->getNumParams()) Out << ", ";
1381 Out << "..."; // Output varargs portion of signature!
1384 Attributes FnAttrs = Attrs.getFnAttributes();
1385 if (FnAttrs != Attribute::None)
1386 Out << ' ' << Attribute::getAsString(Attrs.getFnAttributes());
1387 if (F->hasSection())
1388 Out << " section \"" << F->getSection() << '"';
1389 if (F->getAlignment())
1390 Out << " align " << F->getAlignment();
1392 Out << " gc \"" << F->getGC() << '"';
1393 if (F->isDeclaration()) {
1398 // Output all of its basic blocks... for the function
1399 for (Function::const_iterator I = F->begin(), E = F->end(); I != E; ++I)
1405 Machine.purgeFunction();
1408 /// printArgument - This member is called for every argument that is passed into
1409 /// the function. Simply print it out
1411 void AssemblyWriter::printArgument(const Argument *Arg,
1414 TypePrinter.print(Arg->getType(), Out);
1416 // Output parameter attributes list
1417 if (Attrs != Attribute::None)
1418 Out << ' ' << Attribute::getAsString(Attrs);
1420 // Output name, if available...
1421 if (Arg->hasName()) {
1423 PrintLLVMName(Out, Arg);
1427 /// printBasicBlock - This member is called for each basic block in a method.
1429 void AssemblyWriter::printBasicBlock(const BasicBlock *BB) {
1430 if (BB->hasName()) { // Print out the label if it exists...
1432 PrintLLVMName(Out, BB->getNameStart(), BB->getNameLen(), LabelPrefix);
1434 } else if (!BB->use_empty()) { // Don't print block # of no uses...
1435 Out << "\n; <label>:";
1436 int Slot = Machine.getLocalSlot(BB);
1443 if (BB->getParent() == 0)
1444 Out << "\t\t; Error: Block without parent!";
1445 else if (BB != &BB->getParent()->getEntryBlock()) { // Not the entry block?
1446 // Output predecessors for the block...
1448 pred_const_iterator PI = pred_begin(BB), PE = pred_end(BB);
1451 Out << " No predecessors!";
1454 writeOperand(*PI, false);
1455 for (++PI; PI != PE; ++PI) {
1457 writeOperand(*PI, false);
1464 if (AnnotationWriter) AnnotationWriter->emitBasicBlockStartAnnot(BB, Out);
1466 // Output all of the instructions in the basic block...
1467 for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I != E; ++I)
1468 printInstruction(*I);
1470 if (AnnotationWriter) AnnotationWriter->emitBasicBlockEndAnnot(BB, Out);
1474 /// printInfoComment - Print a little comment after the instruction indicating
1475 /// which slot it occupies.
1477 void AssemblyWriter::printInfoComment(const Value &V) {
1478 if (V.getType() != Type::VoidTy) {
1480 TypePrinter.print(V.getType(), Out);
1483 if (!V.hasName() && !isa<Instruction>(V)) {
1485 if (const GlobalValue *GV = dyn_cast<GlobalValue>(&V))
1486 SlotNum = Machine.getGlobalSlot(GV);
1488 SlotNum = Machine.getLocalSlot(&V);
1492 Out << ':' << SlotNum; // Print out the def slot taken.
1494 Out << " [#uses=" << V.getNumUses() << ']'; // Output # uses
1498 // This member is called for each Instruction in a function..
1499 void AssemblyWriter::printInstruction(const Instruction &I) {
1500 if (AnnotationWriter) AnnotationWriter->emitInstructionAnnot(&I, Out);
1504 // Print out name if it exists...
1506 PrintLLVMName(Out, &I);
1508 } else if (I.getType() != Type::VoidTy) {
1509 // Print out the def slot taken.
1510 int SlotNum = Machine.getLocalSlot(&I);
1512 Out << "<badref> = ";
1514 Out << '%' << SlotNum << " = ";
1517 // If this is a volatile load or store, print out the volatile marker.
1518 if ((isa<LoadInst>(I) && cast<LoadInst>(I).isVolatile()) ||
1519 (isa<StoreInst>(I) && cast<StoreInst>(I).isVolatile())) {
1521 } else if (isa<CallInst>(I) && cast<CallInst>(I).isTailCall()) {
1522 // If this is a call, check if it's a tail call.
1526 // Print out the opcode...
1527 Out << I.getOpcodeName();
1529 // Print out the compare instruction predicates
1530 if (const CmpInst *CI = dyn_cast<CmpInst>(&I))
1531 Out << ' ' << getPredicateText(CI->getPredicate());
1533 // Print out the type of the operands...
1534 const Value *Operand = I.getNumOperands() ? I.getOperand(0) : 0;
1536 // Special case conditional branches to swizzle the condition out to the front
1537 if (isa<BranchInst>(I) && cast<BranchInst>(I).isConditional()) {
1538 BranchInst &BI(cast<BranchInst>(I));
1540 writeOperand(BI.getCondition(), true);
1542 writeOperand(BI.getSuccessor(0), true);
1544 writeOperand(BI.getSuccessor(1), true);
1546 } else if (isa<SwitchInst>(I)) {
1547 // Special case switch statement to get formatting nice and correct...
1549 writeOperand(Operand , true);
1551 writeOperand(I.getOperand(1), true);
1554 for (unsigned op = 2, Eop = I.getNumOperands(); op < Eop; op += 2) {
1556 writeOperand(I.getOperand(op ), true);
1558 writeOperand(I.getOperand(op+1), true);
1561 } else if (isa<PHINode>(I)) {
1563 TypePrinter.print(I.getType(), Out);
1566 for (unsigned op = 0, Eop = I.getNumOperands(); op < Eop; op += 2) {
1567 if (op) Out << ", ";
1569 writeOperand(I.getOperand(op ), false); Out << ", ";
1570 writeOperand(I.getOperand(op+1), false); Out << " ]";
1572 } else if (const ExtractValueInst *EVI = dyn_cast<ExtractValueInst>(&I)) {
1574 writeOperand(I.getOperand(0), true);
1575 for (const unsigned *i = EVI->idx_begin(), *e = EVI->idx_end(); i != e; ++i)
1577 } else if (const InsertValueInst *IVI = dyn_cast<InsertValueInst>(&I)) {
1579 writeOperand(I.getOperand(0), true); Out << ", ";
1580 writeOperand(I.getOperand(1), true);
1581 for (const unsigned *i = IVI->idx_begin(), *e = IVI->idx_end(); i != e; ++i)
1583 } else if (isa<ReturnInst>(I) && !Operand) {
1585 } else if (const CallInst *CI = dyn_cast<CallInst>(&I)) {
1586 // Print the calling convention being used.
1587 switch (CI->getCallingConv()) {
1588 case CallingConv::C: break; // default
1589 case CallingConv::Fast: Out << " fastcc"; break;
1590 case CallingConv::Cold: Out << " coldcc"; break;
1591 case CallingConv::X86_StdCall: Out << " x86_stdcallcc"; break;
1592 case CallingConv::X86_FastCall: Out << " x86_fastcallcc"; break;
1593 default: Out << " cc" << CI->getCallingConv(); break;
1596 const PointerType *PTy = cast<PointerType>(Operand->getType());
1597 const FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
1598 const Type *RetTy = FTy->getReturnType();
1599 const AttrListPtr &PAL = CI->getAttributes();
1601 if (PAL.getRetAttributes() != Attribute::None)
1602 Out << ' ' << Attribute::getAsString(PAL.getRetAttributes());
1604 // If possible, print out the short form of the call instruction. We can
1605 // only do this if the first argument is a pointer to a nonvararg function,
1606 // and if the return type is not a pointer to a function.
1609 if (!FTy->isVarArg() &&
1610 (!isa<PointerType>(RetTy) ||
1611 !isa<FunctionType>(cast<PointerType>(RetTy)->getElementType()))) {
1612 TypePrinter.print(RetTy, Out);
1614 writeOperand(Operand, false);
1616 writeOperand(Operand, true);
1619 for (unsigned op = 1, Eop = I.getNumOperands(); op < Eop; ++op) {
1622 writeParamOperand(I.getOperand(op), PAL.getParamAttributes(op));
1625 if (PAL.getFnAttributes() != Attribute::None)
1626 Out << ' ' << Attribute::getAsString(PAL.getFnAttributes());
1627 } else if (const InvokeInst *II = dyn_cast<InvokeInst>(&I)) {
1628 const PointerType *PTy = cast<PointerType>(Operand->getType());
1629 const FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
1630 const Type *RetTy = FTy->getReturnType();
1631 const AttrListPtr &PAL = II->getAttributes();
1633 // Print the calling convention being used.
1634 switch (II->getCallingConv()) {
1635 case CallingConv::C: break; // default
1636 case CallingConv::Fast: Out << " fastcc"; break;
1637 case CallingConv::Cold: Out << " coldcc"; break;
1638 case CallingConv::X86_StdCall: Out << " x86_stdcallcc"; break;
1639 case CallingConv::X86_FastCall: Out << " x86_fastcallcc"; break;
1640 default: Out << " cc" << II->getCallingConv(); break;
1643 if (PAL.getRetAttributes() != Attribute::None)
1644 Out << ' ' << Attribute::getAsString(PAL.getRetAttributes());
1646 // If possible, print out the short form of the invoke instruction. We can
1647 // only do this if the first argument is a pointer to a nonvararg function,
1648 // and if the return type is not a pointer to a function.
1651 if (!FTy->isVarArg() &&
1652 (!isa<PointerType>(RetTy) ||
1653 !isa<FunctionType>(cast<PointerType>(RetTy)->getElementType()))) {
1654 TypePrinter.print(RetTy, Out);
1656 writeOperand(Operand, false);
1658 writeOperand(Operand, true);
1661 for (unsigned op = 3, Eop = I.getNumOperands(); op < Eop; ++op) {
1664 writeParamOperand(I.getOperand(op), PAL.getParamAttributes(op-2));
1668 if (PAL.getFnAttributes() != Attribute::None)
1669 Out << ' ' << Attribute::getAsString(PAL.getFnAttributes());
1671 Out << "\n\t\t\tto ";
1672 writeOperand(II->getNormalDest(), true);
1674 writeOperand(II->getUnwindDest(), true);
1676 } else if (const AllocationInst *AI = dyn_cast<AllocationInst>(&I)) {
1678 TypePrinter.print(AI->getType()->getElementType(), Out);
1679 if (AI->isArrayAllocation()) {
1681 writeOperand(AI->getArraySize(), true);
1683 if (AI->getAlignment()) {
1684 Out << ", align " << AI->getAlignment();
1686 } else if (isa<CastInst>(I)) {
1689 writeOperand(Operand, true); // Work with broken code
1692 TypePrinter.print(I.getType(), Out);
1693 } else if (isa<VAArgInst>(I)) {
1696 writeOperand(Operand, true); // Work with broken code
1699 TypePrinter.print(I.getType(), Out);
1700 } else if (Operand) { // Print the normal way.
1702 // PrintAllTypes - Instructions who have operands of all the same type
1703 // omit the type from all but the first operand. If the instruction has
1704 // different type operands (for example br), then they are all printed.
1705 bool PrintAllTypes = false;
1706 const Type *TheType = Operand->getType();
1708 // Select, Store and ShuffleVector always print all types.
1709 if (isa<SelectInst>(I) || isa<StoreInst>(I) || isa<ShuffleVectorInst>(I)
1710 || isa<ReturnInst>(I)) {
1711 PrintAllTypes = true;
1713 for (unsigned i = 1, E = I.getNumOperands(); i != E; ++i) {
1714 Operand = I.getOperand(i);
1715 // note that Operand shouldn't be null, but the test helps make dump()
1716 // more tolerant of malformed IR
1717 if (Operand && Operand->getType() != TheType) {
1718 PrintAllTypes = true; // We have differing types! Print them all!
1724 if (!PrintAllTypes) {
1726 TypePrinter.print(TheType, Out);
1730 for (unsigned i = 0, E = I.getNumOperands(); i != E; ++i) {
1732 writeOperand(I.getOperand(i), PrintAllTypes);
1736 // Print post operand alignment for load/store
1737 if (isa<LoadInst>(I) && cast<LoadInst>(I).getAlignment()) {
1738 Out << ", align " << cast<LoadInst>(I).getAlignment();
1739 } else if (isa<StoreInst>(I) && cast<StoreInst>(I).getAlignment()) {
1740 Out << ", align " << cast<StoreInst>(I).getAlignment();
1743 printInfoComment(I);
1748 //===----------------------------------------------------------------------===//
1749 // External Interface declarations
1750 //===----------------------------------------------------------------------===//
1752 void Module::print(std::ostream &o, AssemblyAnnotationWriter *AAW) const {
1753 raw_os_ostream OS(o);
1756 void Module::print(raw_ostream &OS, AssemblyAnnotationWriter *AAW) const {
1757 SlotTracker SlotTable(this);
1758 AssemblyWriter W(OS, SlotTable, this, AAW);
1762 void Type::print(std::ostream &o) const {
1763 raw_os_ostream OS(o);
1767 void Type::print(raw_ostream &OS) const {
1769 OS << "<null Type>";
1772 TypePrinting().print(this, OS);
1775 void Value::print(raw_ostream &OS, AssemblyAnnotationWriter *AAW) const {
1777 OS << "printing a <null> value\n";
1781 if (const Instruction *I = dyn_cast<Instruction>(this)) {
1782 const Function *F = I->getParent() ? I->getParent()->getParent() : 0;
1783 SlotTracker SlotTable(F);
1784 AssemblyWriter W(OS, SlotTable, F ? F->getParent() : 0, AAW);
1786 } else if (const BasicBlock *BB = dyn_cast<BasicBlock>(this)) {
1787 SlotTracker SlotTable(BB->getParent());
1788 AssemblyWriter W(OS, SlotTable,
1789 BB->getParent() ? BB->getParent()->getParent() : 0, AAW);
1791 } else if (const GlobalValue *GV = dyn_cast<GlobalValue>(this)) {
1792 SlotTracker SlotTable(GV->getParent());
1793 AssemblyWriter W(OS, SlotTable, GV->getParent(), 0);
1795 } else if (const Constant *C = dyn_cast<Constant>(this)) {
1796 TypePrinting TypePrinter;
1797 TypePrinter.print(C->getType(), OS);
1799 WriteConstantInt(OS, C, TypePrinter, 0);
1800 } else if (const Argument *A = dyn_cast<Argument>(this)) {
1801 WriteAsOperand(OS, this, true,
1802 A->getParent() ? A->getParent()->getParent() : 0);
1803 } else if (isa<InlineAsm>(this)) {
1804 WriteAsOperand(OS, this, true, 0);
1806 assert(0 && "Unknown value to print out!");
1810 void Value::print(std::ostream &O, AssemblyAnnotationWriter *AAW) const {
1811 raw_os_ostream OS(O);
1815 // Value::dump - allow easy printing of Values from the debugger.
1816 void Value::dump() const { print(errs()); errs() << '\n'; errs().flush(); }
1818 // Type::dump - allow easy printing of Types from the debugger.
1819 // This one uses type names from the given context module
1820 void Type::dump(const Module *Context) const {
1821 WriteTypeSymbolic(errs(), this, Context);
1826 // Type::dump - allow easy printing of Types from the debugger.
1827 void Type::dump() const { dump(0); }
1829 // Module::dump() - Allow printing of Modules from the debugger.
1830 void Module::dump() const { print(errs(), 0); errs().flush(); }