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/Metadata.h"
27 #include "llvm/Module.h"
28 #include "llvm/ValueSymbolTable.h"
29 #include "llvm/TypeSymbolTable.h"
30 #include "llvm/ADT/DenseSet.h"
31 #include "llvm/ADT/StringExtras.h"
32 #include "llvm/ADT/STLExtras.h"
33 #include "llvm/Support/CFG.h"
34 #include "llvm/Support/MathExtras.h"
35 #include "llvm/Support/raw_ostream.h"
40 // Make virtual table appear in this compilation unit.
41 AssemblyAnnotationWriter::~AssemblyAnnotationWriter() {}
43 //===----------------------------------------------------------------------===//
45 //===----------------------------------------------------------------------===//
47 static const Module *getModuleFromVal(const Value *V) {
48 if (const Argument *MA = dyn_cast<Argument>(V))
49 return MA->getParent() ? MA->getParent()->getParent() : 0;
51 if (const BasicBlock *BB = dyn_cast<BasicBlock>(V))
52 return BB->getParent() ? BB->getParent()->getParent() : 0;
54 if (const Instruction *I = dyn_cast<Instruction>(V)) {
55 const Function *M = I->getParent() ? I->getParent()->getParent() : 0;
56 return M ? M->getParent() : 0;
59 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V))
60 return GV->getParent();
64 // PrintEscapedString - Print each character of the specified string, escaping
65 // it if it is not printable or if it is an escape char.
66 static void PrintEscapedString(const char *Str, unsigned Length,
68 for (unsigned i = 0; i != Length; ++i) {
69 unsigned char C = Str[i];
70 if (isprint(C) && C != '\\' && C != '"')
73 Out << '\\' << hexdigit(C >> 4) << hexdigit(C & 0x0F);
77 // PrintEscapedString - Print each character of the specified string, escaping
78 // it if it is not printable or if it is an escape char.
79 static void PrintEscapedString(const std::string &Str, raw_ostream &Out) {
80 PrintEscapedString(Str.c_str(), Str.size(), Out);
90 /// PrintLLVMName - Turn the specified name into an 'LLVM name', which is either
91 /// prefixed with % (if the string only contains simple characters) or is
92 /// surrounded with ""'s (if it has special chars in it). Print it out.
93 static void PrintLLVMName(raw_ostream &OS, const char *NameStr,
94 unsigned NameLen, PrefixType Prefix) {
95 assert(NameStr && "Cannot get empty name!");
97 default: assert(0 && "Bad prefix!");
99 case GlobalPrefix: OS << '@'; break;
100 case LabelPrefix: break;
101 case LocalPrefix: OS << '%'; break;
104 // Scan the name to see if it needs quotes first.
105 bool NeedsQuotes = isdigit(NameStr[0]);
107 for (unsigned i = 0; i != NameLen; ++i) {
109 if (!isalnum(C) && C != '-' && C != '.' && C != '_') {
116 // If we didn't need any quotes, just write out the name in one blast.
118 OS.write(NameStr, NameLen);
122 // Okay, we need quotes. Output the quotes and escape any scary characters as
125 PrintEscapedString(NameStr, NameLen, OS);
129 /// PrintLLVMName - Turn the specified name into an 'LLVM name', which is either
130 /// prefixed with % (if the string only contains simple characters) or is
131 /// surrounded with ""'s (if it has special chars in it). Print it out.
132 static void PrintLLVMName(raw_ostream &OS, const Value *V) {
133 PrintLLVMName(OS, V->getNameStart(), V->getNameLen(),
134 isa<GlobalValue>(V) ? GlobalPrefix : LocalPrefix);
137 //===----------------------------------------------------------------------===//
138 // TypePrinting Class: Type printing machinery
139 //===----------------------------------------------------------------------===//
141 static DenseMap<const Type *, std::string> &getTypeNamesMap(void *M) {
142 return *static_cast<DenseMap<const Type *, std::string>*>(M);
145 void TypePrinting::clear() {
146 getTypeNamesMap(TypeNames).clear();
149 bool TypePrinting::hasTypeName(const Type *Ty) const {
150 return getTypeNamesMap(TypeNames).count(Ty);
153 void TypePrinting::addTypeName(const Type *Ty, const std::string &N) {
154 getTypeNamesMap(TypeNames).insert(std::make_pair(Ty, N));
158 TypePrinting::TypePrinting() {
159 TypeNames = new DenseMap<const Type *, std::string>();
162 TypePrinting::~TypePrinting() {
163 delete &getTypeNamesMap(TypeNames);
166 /// CalcTypeName - Write the specified type to the specified raw_ostream, making
167 /// use of type names or up references to shorten the type name where possible.
168 void TypePrinting::CalcTypeName(const Type *Ty,
169 SmallVectorImpl<const Type *> &TypeStack,
170 raw_ostream &OS, bool IgnoreTopLevelName) {
171 // Check to see if the type is named.
172 if (!IgnoreTopLevelName) {
173 DenseMap<const Type *, std::string> &TM = getTypeNamesMap(TypeNames);
174 DenseMap<const Type *, std::string>::iterator I = TM.find(Ty);
181 // Check to see if the Type is already on the stack...
182 unsigned Slot = 0, CurSize = TypeStack.size();
183 while (Slot < CurSize && TypeStack[Slot] != Ty) ++Slot; // Scan for type
185 // This is another base case for the recursion. In this case, we know
186 // that we have looped back to a type that we have previously visited.
187 // Generate the appropriate upreference to handle this.
188 if (Slot < CurSize) {
189 OS << '\\' << unsigned(CurSize-Slot); // Here's the upreference
193 TypeStack.push_back(Ty); // Recursive case: Add us to the stack..
195 switch (Ty->getTypeID()) {
196 case Type::VoidTyID: OS << "void"; break;
197 case Type::FloatTyID: OS << "float"; break;
198 case Type::DoubleTyID: OS << "double"; break;
199 case Type::X86_FP80TyID: OS << "x86_fp80"; break;
200 case Type::FP128TyID: OS << "fp128"; break;
201 case Type::PPC_FP128TyID: OS << "ppc_fp128"; break;
202 case Type::LabelTyID: OS << "label"; break;
203 case Type::IntegerTyID:
204 OS << 'i' << cast<IntegerType>(Ty)->getBitWidth();
207 case Type::FunctionTyID: {
208 const FunctionType *FTy = cast<FunctionType>(Ty);
209 CalcTypeName(FTy->getReturnType(), TypeStack, OS);
211 for (FunctionType::param_iterator I = FTy->param_begin(),
212 E = FTy->param_end(); I != E; ++I) {
213 if (I != FTy->param_begin())
215 CalcTypeName(*I, TypeStack, OS);
217 if (FTy->isVarArg()) {
218 if (FTy->getNumParams()) OS << ", ";
224 case Type::StructTyID: {
225 const StructType *STy = cast<StructType>(Ty);
229 for (StructType::element_iterator I = STy->element_begin(),
230 E = STy->element_end(); I != E; ++I) {
231 CalcTypeName(*I, TypeStack, OS);
232 if (next(I) != STy->element_end())
241 case Type::PointerTyID: {
242 const PointerType *PTy = cast<PointerType>(Ty);
243 CalcTypeName(PTy->getElementType(), TypeStack, OS);
244 if (unsigned AddressSpace = PTy->getAddressSpace())
245 OS << " addrspace(" << AddressSpace << ')';
249 case Type::ArrayTyID: {
250 const ArrayType *ATy = cast<ArrayType>(Ty);
251 OS << '[' << ATy->getNumElements() << " x ";
252 CalcTypeName(ATy->getElementType(), TypeStack, OS);
256 case Type::VectorTyID: {
257 const VectorType *PTy = cast<VectorType>(Ty);
258 OS << "<" << PTy->getNumElements() << " x ";
259 CalcTypeName(PTy->getElementType(), TypeStack, OS);
263 case Type::OpaqueTyID:
267 OS << "<unrecognized-type>";
271 TypeStack.pop_back(); // Remove self from stack.
274 /// printTypeInt - The internal guts of printing out a type that has a
275 /// potentially named portion.
277 void TypePrinting::print(const Type *Ty, raw_ostream &OS,
278 bool IgnoreTopLevelName) {
279 // Check to see if the type is named.
280 DenseMap<const Type*, std::string> &TM = getTypeNamesMap(TypeNames);
281 if (!IgnoreTopLevelName) {
282 DenseMap<const Type*, std::string>::iterator I = TM.find(Ty);
289 // Otherwise we have a type that has not been named but is a derived type.
290 // Carefully recurse the type hierarchy to print out any contained symbolic
292 SmallVector<const Type *, 16> TypeStack;
293 std::string TypeName;
295 raw_string_ostream TypeOS(TypeName);
296 CalcTypeName(Ty, TypeStack, TypeOS, IgnoreTopLevelName);
299 // Cache type name for later use.
300 if (!IgnoreTopLevelName)
301 TM.insert(std::make_pair(Ty, TypeOS.str()));
306 // To avoid walking constant expressions multiple times and other IR
307 // objects, we keep several helper maps.
308 DenseSet<const Value*> VisitedConstants;
309 DenseSet<const Type*> VisitedTypes;
312 std::vector<const Type*> &NumberedTypes;
314 TypeFinder(TypePrinting &tp, std::vector<const Type*> &numberedTypes)
315 : TP(tp), NumberedTypes(numberedTypes) {}
317 void Run(const Module &M) {
318 // Get types from the type symbol table. This gets opaque types referened
319 // only through derived named types.
320 const TypeSymbolTable &ST = M.getTypeSymbolTable();
321 for (TypeSymbolTable::const_iterator TI = ST.begin(), E = ST.end();
323 IncorporateType(TI->second);
325 // Get types from global variables.
326 for (Module::const_global_iterator I = M.global_begin(),
327 E = M.global_end(); I != E; ++I) {
328 IncorporateType(I->getType());
329 if (I->hasInitializer())
330 IncorporateValue(I->getInitializer());
333 // Get types from aliases.
334 for (Module::const_alias_iterator I = M.alias_begin(),
335 E = M.alias_end(); I != E; ++I) {
336 IncorporateType(I->getType());
337 IncorporateValue(I->getAliasee());
340 // Get types from functions.
341 for (Module::const_iterator FI = M.begin(), E = M.end(); FI != E; ++FI) {
342 IncorporateType(FI->getType());
344 for (Function::const_iterator BB = FI->begin(), E = FI->end();
346 for (BasicBlock::const_iterator II = BB->begin(),
347 E = BB->end(); II != E; ++II) {
348 const Instruction &I = *II;
349 // Incorporate the type of the instruction and all its operands.
350 IncorporateType(I.getType());
351 for (User::const_op_iterator OI = I.op_begin(), OE = I.op_end();
353 IncorporateValue(*OI);
359 void IncorporateType(const Type *Ty) {
360 // Check to see if we're already visited this type.
361 if (!VisitedTypes.insert(Ty).second)
364 // If this is a structure or opaque type, add a name for the type.
365 if (((isa<StructType>(Ty) && cast<StructType>(Ty)->getNumElements())
366 || isa<OpaqueType>(Ty)) && !TP.hasTypeName(Ty)) {
367 TP.addTypeName(Ty, "%"+utostr(unsigned(NumberedTypes.size())));
368 NumberedTypes.push_back(Ty);
371 // Recursively walk all contained types.
372 for (Type::subtype_iterator I = Ty->subtype_begin(),
373 E = Ty->subtype_end(); I != E; ++I)
377 /// IncorporateValue - This method is used to walk operand lists finding
378 /// types hiding in constant expressions and other operands that won't be
379 /// walked in other ways. GlobalValues, basic blocks, instructions, and
380 /// inst operands are all explicitly enumerated.
381 void IncorporateValue(const Value *V) {
382 if (V == 0 || !isa<Constant>(V) || isa<GlobalValue>(V)) return;
385 if (!VisitedConstants.insert(V).second)
389 IncorporateType(V->getType());
391 // Look in operands for types.
392 const Constant *C = cast<Constant>(V);
393 for (Constant::const_op_iterator I = C->op_begin(),
394 E = C->op_end(); I != E;++I)
395 IncorporateValue(*I);
398 } // end anonymous namespace
401 /// AddModuleTypesToPrinter - Add all of the symbolic type names for types in
402 /// the specified module to the TypePrinter and all numbered types to it and the
403 /// NumberedTypes table.
404 static void AddModuleTypesToPrinter(TypePrinting &TP,
405 std::vector<const Type*> &NumberedTypes,
409 // If the module has a symbol table, take all global types and stuff their
410 // names into the TypeNames map.
411 const TypeSymbolTable &ST = M->getTypeSymbolTable();
412 for (TypeSymbolTable::const_iterator TI = ST.begin(), E = ST.end();
414 const Type *Ty = cast<Type>(TI->second);
416 // As a heuristic, don't insert pointer to primitive types, because
417 // they are used too often to have a single useful name.
418 if (const PointerType *PTy = dyn_cast<PointerType>(Ty)) {
419 const Type *PETy = PTy->getElementType();
420 if ((PETy->isPrimitiveType() || PETy->isInteger()) &&
421 !isa<OpaqueType>(PETy))
425 // Likewise don't insert primitives either.
426 if (Ty->isInteger() || Ty->isPrimitiveType())
429 // Get the name as a string and insert it into TypeNames.
431 raw_string_ostream NameOS(NameStr);
432 PrintLLVMName(NameOS, TI->first.c_str(), TI->first.length(), LocalPrefix);
433 TP.addTypeName(Ty, NameOS.str());
436 // Walk the entire module to find references to unnamed structure and opaque
437 // types. This is required for correctness by opaque types (because multiple
438 // uses of an unnamed opaque type needs to be referred to by the same ID) and
439 // it shrinks complex recursive structure types substantially in some cases.
440 TypeFinder(TP, NumberedTypes).Run(*M);
444 /// WriteTypeSymbolic - This attempts to write the specified type as a symbolic
445 /// type, iff there is an entry in the modules symbol table for the specified
446 /// type or one of it's component types.
448 void llvm::WriteTypeSymbolic(raw_ostream &OS, const Type *Ty, const Module *M) {
449 TypePrinting Printer;
450 std::vector<const Type*> NumberedTypes;
451 AddModuleTypesToPrinter(Printer, NumberedTypes, M);
452 Printer.print(Ty, OS);
455 //===----------------------------------------------------------------------===//
456 // SlotTracker Class: Enumerate slot numbers for unnamed values
457 //===----------------------------------------------------------------------===//
461 /// This class provides computation of slot numbers for LLVM Assembly writing.
465 /// ValueMap - A mapping of Values to slot numbers
466 typedef DenseMap<const Value*, unsigned> ValueMap;
469 /// TheModule - The module for which we are holding slot numbers
470 const Module* TheModule;
472 /// TheFunction - The function for which we are holding slot numbers
473 const Function* TheFunction;
474 bool FunctionProcessed;
476 /// mMap - The TypePlanes map for the module level data
480 /// fMap - The TypePlanes map for the function level data
485 /// Construct from a module
486 explicit SlotTracker(const Module *M);
487 /// Construct from a function, starting out in incorp state.
488 explicit SlotTracker(const Function *F);
490 /// Return the slot number of the specified value in it's type
491 /// plane. If something is not in the SlotTracker, return -1.
492 int getLocalSlot(const Value *V);
493 int getGlobalSlot(const GlobalValue *V);
495 /// If you'd like to deal with a function instead of just a module, use
496 /// this method to get its data into the SlotTracker.
497 void incorporateFunction(const Function *F) {
499 FunctionProcessed = false;
502 /// After calling incorporateFunction, use this method to remove the
503 /// most recently incorporated function from the SlotTracker. This
504 /// will reset the state of the machine back to just the module contents.
505 void purgeFunction();
507 // Implementation Details
509 /// This function does the actual initialization.
510 inline void initialize();
512 /// CreateModuleSlot - Insert the specified GlobalValue* into the slot table.
513 void CreateModuleSlot(const GlobalValue *V);
515 /// CreateFunctionSlot - Insert the specified Value* into the slot table.
516 void CreateFunctionSlot(const Value *V);
518 /// Add all of the module level global variables (and their initializers)
519 /// and function declarations, but not the contents of those functions.
520 void processModule();
522 /// Add all of the functions arguments, basic blocks, and instructions
523 void processFunction();
525 SlotTracker(const SlotTracker &); // DO NOT IMPLEMENT
526 void operator=(const SlotTracker &); // DO NOT IMPLEMENT
529 } // end anonymous namespace
532 static SlotTracker *createSlotTracker(const Value *V) {
533 if (const Argument *FA = dyn_cast<Argument>(V))
534 return new SlotTracker(FA->getParent());
536 if (const Instruction *I = dyn_cast<Instruction>(V))
537 return new SlotTracker(I->getParent()->getParent());
539 if (const BasicBlock *BB = dyn_cast<BasicBlock>(V))
540 return new SlotTracker(BB->getParent());
542 if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(V))
543 return new SlotTracker(GV->getParent());
545 if (const GlobalAlias *GA = dyn_cast<GlobalAlias>(V))
546 return new SlotTracker(GA->getParent());
548 if (const Function *Func = dyn_cast<Function>(V))
549 return new SlotTracker(Func);
555 #define ST_DEBUG(X) cerr << X
560 // Module level constructor. Causes the contents of the Module (sans functions)
561 // to be added to the slot table.
562 SlotTracker::SlotTracker(const Module *M)
563 : TheModule(M), TheFunction(0), FunctionProcessed(false), mNext(0), fNext(0) {
566 // Function level constructor. Causes the contents of the Module and the one
567 // function provided to be added to the slot table.
568 SlotTracker::SlotTracker(const Function *F)
569 : TheModule(F ? F->getParent() : 0), TheFunction(F), FunctionProcessed(false),
573 inline void SlotTracker::initialize() {
576 TheModule = 0; ///< Prevent re-processing next time we're called.
579 if (TheFunction && !FunctionProcessed)
583 // Iterate through all the global variables, functions, and global
584 // variable initializers and create slots for them.
585 void SlotTracker::processModule() {
586 ST_DEBUG("begin processModule!\n");
588 // Add all of the unnamed global variables to the value table.
589 for (Module::const_global_iterator I = TheModule->global_begin(),
590 E = TheModule->global_end(); I != E; ++I)
594 // Add all the unnamed functions to the table.
595 for (Module::const_iterator I = TheModule->begin(), E = TheModule->end();
600 ST_DEBUG("end processModule!\n");
604 // Process the arguments, basic blocks, and instructions of a function.
605 void SlotTracker::processFunction() {
606 ST_DEBUG("begin processFunction!\n");
609 // Add all the function arguments with no names.
610 for(Function::const_arg_iterator AI = TheFunction->arg_begin(),
611 AE = TheFunction->arg_end(); AI != AE; ++AI)
613 CreateFunctionSlot(AI);
615 ST_DEBUG("Inserting Instructions:\n");
617 // Add all of the basic blocks and instructions with no names.
618 for (Function::const_iterator BB = TheFunction->begin(),
619 E = TheFunction->end(); BB != E; ++BB) {
621 CreateFunctionSlot(BB);
622 for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I != E; ++I)
623 if (I->getType() != Type::VoidTy && !I->hasName())
624 CreateFunctionSlot(I);
627 FunctionProcessed = true;
629 ST_DEBUG("end processFunction!\n");
632 /// Clean up after incorporating a function. This is the only way to get out of
633 /// the function incorporation state that affects get*Slot/Create*Slot. Function
634 /// incorporation state is indicated by TheFunction != 0.
635 void SlotTracker::purgeFunction() {
636 ST_DEBUG("begin purgeFunction!\n");
637 fMap.clear(); // Simply discard the function level map
639 FunctionProcessed = false;
640 ST_DEBUG("end purgeFunction!\n");
643 /// getGlobalSlot - Get the slot number of a global value.
644 int SlotTracker::getGlobalSlot(const GlobalValue *V) {
645 // Check for uninitialized state and do lazy initialization.
648 // Find the type plane in the module map
649 ValueMap::iterator MI = mMap.find(V);
650 return MI == mMap.end() ? -1 : (int)MI->second;
654 /// getLocalSlot - Get the slot number for a value that is local to a function.
655 int SlotTracker::getLocalSlot(const Value *V) {
656 assert(!isa<Constant>(V) && "Can't get a constant or global slot with this!");
658 // Check for uninitialized state and do lazy initialization.
661 ValueMap::iterator FI = fMap.find(V);
662 return FI == fMap.end() ? -1 : (int)FI->second;
666 /// CreateModuleSlot - Insert the specified GlobalValue* into the slot table.
667 void SlotTracker::CreateModuleSlot(const GlobalValue *V) {
668 assert(V && "Can't insert a null Value into SlotTracker!");
669 assert(V->getType() != Type::VoidTy && "Doesn't need a slot!");
670 assert(!V->hasName() && "Doesn't need a slot!");
672 unsigned DestSlot = mNext++;
675 ST_DEBUG(" Inserting value [" << V->getType() << "] = " << V << " slot=" <<
677 // G = Global, F = Function, A = Alias, o = other
678 ST_DEBUG((isa<GlobalVariable>(V) ? 'G' :
679 (isa<Function>(V) ? 'F' :
680 (isa<GlobalAlias>(V) ? 'A' : 'o'))) << "]\n");
684 /// CreateSlot - Create a new slot for the specified value if it has no name.
685 void SlotTracker::CreateFunctionSlot(const Value *V) {
686 assert(V->getType() != Type::VoidTy && !V->hasName() &&
687 "Doesn't need a slot!");
689 unsigned DestSlot = fNext++;
692 // G = Global, F = Function, o = other
693 ST_DEBUG(" Inserting value [" << V->getType() << "] = " << V << " slot=" <<
694 DestSlot << " [o]\n");
699 //===----------------------------------------------------------------------===//
700 // AsmWriter Implementation
701 //===----------------------------------------------------------------------===//
703 static void WriteAsOperandInternal(raw_ostream &Out, const Value *V,
704 TypePrinting &TypePrinter,
705 SlotTracker *Machine);
709 static const char *getPredicateText(unsigned predicate) {
710 const char * pred = "unknown";
712 case FCmpInst::FCMP_FALSE: pred = "false"; break;
713 case FCmpInst::FCMP_OEQ: pred = "oeq"; break;
714 case FCmpInst::FCMP_OGT: pred = "ogt"; break;
715 case FCmpInst::FCMP_OGE: pred = "oge"; break;
716 case FCmpInst::FCMP_OLT: pred = "olt"; break;
717 case FCmpInst::FCMP_OLE: pred = "ole"; break;
718 case FCmpInst::FCMP_ONE: pred = "one"; break;
719 case FCmpInst::FCMP_ORD: pred = "ord"; break;
720 case FCmpInst::FCMP_UNO: pred = "uno"; break;
721 case FCmpInst::FCMP_UEQ: pred = "ueq"; break;
722 case FCmpInst::FCMP_UGT: pred = "ugt"; break;
723 case FCmpInst::FCMP_UGE: pred = "uge"; break;
724 case FCmpInst::FCMP_ULT: pred = "ult"; break;
725 case FCmpInst::FCMP_ULE: pred = "ule"; break;
726 case FCmpInst::FCMP_UNE: pred = "une"; break;
727 case FCmpInst::FCMP_TRUE: pred = "true"; break;
728 case ICmpInst::ICMP_EQ: pred = "eq"; break;
729 case ICmpInst::ICMP_NE: pred = "ne"; break;
730 case ICmpInst::ICMP_SGT: pred = "sgt"; break;
731 case ICmpInst::ICMP_SGE: pred = "sge"; break;
732 case ICmpInst::ICMP_SLT: pred = "slt"; break;
733 case ICmpInst::ICMP_SLE: pred = "sle"; break;
734 case ICmpInst::ICMP_UGT: pred = "ugt"; break;
735 case ICmpInst::ICMP_UGE: pred = "uge"; break;
736 case ICmpInst::ICMP_ULT: pred = "ult"; break;
737 case ICmpInst::ICMP_ULE: pred = "ule"; break;
742 static void WriteConstantInt(raw_ostream &Out, const Constant *CV,
743 TypePrinting &TypePrinter, SlotTracker *Machine) {
744 if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV)) {
745 if (CI->getType() == Type::Int1Ty) {
746 Out << (CI->getZExtValue() ? "true" : "false");
749 Out << CI->getValue();
753 if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV)) {
754 if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEdouble ||
755 &CFP->getValueAPF().getSemantics() == &APFloat::IEEEsingle) {
756 // We would like to output the FP constant value in exponential notation,
757 // but we cannot do this if doing so will lose precision. Check here to
758 // make sure that we only output it in exponential format if we can parse
759 // the value back and get the same value.
762 bool isDouble = &CFP->getValueAPF().getSemantics()==&APFloat::IEEEdouble;
763 double Val = isDouble ? CFP->getValueAPF().convertToDouble() :
764 CFP->getValueAPF().convertToFloat();
765 std::string StrVal = ftostr(CFP->getValueAPF());
767 // Check to make sure that the stringized number is not some string like
768 // "Inf" or NaN, that atof will accept, but the lexer will not. Check
769 // that the string matches the "[-+]?[0-9]" regex.
771 if ((StrVal[0] >= '0' && StrVal[0] <= '9') ||
772 ((StrVal[0] == '-' || StrVal[0] == '+') &&
773 (StrVal[1] >= '0' && StrVal[1] <= '9'))) {
774 // Reparse stringized version!
775 if (atof(StrVal.c_str()) == Val) {
780 // Otherwise we could not reparse it to exactly the same value, so we must
781 // output the string in hexadecimal format! Note that loading and storing
782 // floating point types changes the bits of NaNs on some hosts, notably
783 // x86, so we must not use these types.
784 assert(sizeof(double) == sizeof(uint64_t) &&
785 "assuming that double is 64 bits!");
787 APFloat apf = CFP->getValueAPF();
788 // Floats are represented in ASCII IR as double, convert.
790 apf.convert(APFloat::IEEEdouble, APFloat::rmNearestTiesToEven,
793 utohex_buffer(uint64_t(apf.bitcastToAPInt().getZExtValue()),
798 // Some form of long double. These appear as a magic letter identifying
799 // the type, then a fixed number of hex digits.
801 if (&CFP->getValueAPF().getSemantics() == &APFloat::x87DoubleExtended) {
803 // api needed to prevent premature destruction
804 APInt api = CFP->getValueAPF().bitcastToAPInt();
805 const uint64_t* p = api.getRawData();
806 uint64_t word = p[1];
808 int width = api.getBitWidth();
809 for (int j=0; j<width; j+=4, shiftcount-=4) {
810 unsigned int nibble = (word>>shiftcount) & 15;
812 Out << (unsigned char)(nibble + '0');
814 Out << (unsigned char)(nibble - 10 + 'A');
815 if (shiftcount == 0 && j+4 < width) {
819 shiftcount = width-j-4;
823 } else if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEquad)
825 else if (&CFP->getValueAPF().getSemantics() == &APFloat::PPCDoubleDouble)
828 assert(0 && "Unsupported floating point type");
829 // api needed to prevent premature destruction
830 APInt api = CFP->getValueAPF().bitcastToAPInt();
831 const uint64_t* p = api.getRawData();
834 int width = api.getBitWidth();
835 for (int j=0; j<width; j+=4, shiftcount-=4) {
836 unsigned int nibble = (word>>shiftcount) & 15;
838 Out << (unsigned char)(nibble + '0');
840 Out << (unsigned char)(nibble - 10 + 'A');
841 if (shiftcount == 0 && j+4 < width) {
845 shiftcount = width-j-4;
851 if (isa<ConstantAggregateZero>(CV)) {
852 Out << "zeroinitializer";
856 if (const ConstantArray *CA = dyn_cast<ConstantArray>(CV)) {
857 // As a special case, print the array as a string if it is an array of
858 // i8 with ConstantInt values.
860 const Type *ETy = CA->getType()->getElementType();
861 if (CA->isString()) {
863 PrintEscapedString(CA->getAsString(), Out);
865 } else { // Cannot output in string format...
867 if (CA->getNumOperands()) {
868 TypePrinter.print(ETy, Out);
870 WriteAsOperandInternal(Out, CA->getOperand(0),
871 TypePrinter, Machine);
872 for (unsigned i = 1, e = CA->getNumOperands(); i != e; ++i) {
874 TypePrinter.print(ETy, Out);
876 WriteAsOperandInternal(Out, CA->getOperand(i), TypePrinter, Machine);
884 if (const ConstantStruct *CS = dyn_cast<ConstantStruct>(CV)) {
885 if (CS->getType()->isPacked())
888 unsigned N = CS->getNumOperands();
891 TypePrinter.print(CS->getOperand(0)->getType(), Out);
894 WriteAsOperandInternal(Out, CS->getOperand(0), TypePrinter, Machine);
896 for (unsigned i = 1; i < N; i++) {
898 TypePrinter.print(CS->getOperand(i)->getType(), Out);
901 WriteAsOperandInternal(Out, CS->getOperand(i), TypePrinter, Machine);
907 if (CS->getType()->isPacked())
912 if (const ConstantVector *CP = dyn_cast<ConstantVector>(CV)) {
913 const Type *ETy = CP->getType()->getElementType();
914 assert(CP->getNumOperands() > 0 &&
915 "Number of operands for a PackedConst must be > 0");
917 TypePrinter.print(ETy, Out);
919 WriteAsOperandInternal(Out, CP->getOperand(0), TypePrinter, Machine);
920 for (unsigned i = 1, e = CP->getNumOperands(); i != e; ++i) {
922 TypePrinter.print(ETy, Out);
924 WriteAsOperandInternal(Out, CP->getOperand(i), TypePrinter, Machine);
930 if (isa<ConstantPointerNull>(CV)) {
935 if (isa<UndefValue>(CV)) {
940 if (const MDString *S = dyn_cast<MDString>(CV)) {
942 PrintEscapedString(S->begin(), S->size(), Out);
947 if (const MDNode *N = dyn_cast<MDNode>(CV)) {
949 for (MDNode::const_op_iterator I = N->op_begin(), E = N->op_end(); I != E;){
950 TypePrinter.print((*I)->getType(), Out);
952 WriteAsOperandInternal(Out, *I, TypePrinter, Machine);
960 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV)) {
961 Out << CE->getOpcodeName();
963 Out << ' ' << getPredicateText(CE->getPredicate());
966 for (User::const_op_iterator OI=CE->op_begin(); OI != CE->op_end(); ++OI) {
967 TypePrinter.print((*OI)->getType(), Out);
969 WriteAsOperandInternal(Out, *OI, TypePrinter, Machine);
970 if (OI+1 != CE->op_end())
974 if (CE->hasIndices()) {
975 const SmallVector<unsigned, 4> &Indices = CE->getIndices();
976 for (unsigned i = 0, e = Indices.size(); i != e; ++i)
977 Out << ", " << Indices[i];
982 TypePrinter.print(CE->getType(), Out);
989 Out << "<placeholder or erroneous Constant>";
993 /// WriteAsOperand - Write the name of the specified value out to the specified
994 /// ostream. This can be useful when you just want to print int %reg126, not
995 /// the whole instruction that generated it.
997 static void WriteAsOperandInternal(raw_ostream &Out, const Value *V,
998 TypePrinting &TypePrinter,
999 SlotTracker *Machine) {
1001 PrintLLVMName(Out, V);
1005 const Constant *CV = dyn_cast<Constant>(V);
1006 if (CV && !isa<GlobalValue>(CV)) {
1007 WriteConstantInt(Out, CV, TypePrinter, Machine);
1011 if (const InlineAsm *IA = dyn_cast<InlineAsm>(V)) {
1013 if (IA->hasSideEffects())
1014 Out << "sideeffect ";
1016 PrintEscapedString(IA->getAsmString(), Out);
1018 PrintEscapedString(IA->getConstraintString(), Out);
1026 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
1027 Slot = Machine->getGlobalSlot(GV);
1030 Slot = Machine->getLocalSlot(V);
1033 Machine = createSlotTracker(V);
1035 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
1036 Slot = Machine->getGlobalSlot(GV);
1039 Slot = Machine->getLocalSlot(V);
1048 Out << Prefix << Slot;
1053 /// WriteAsOperand - Write the name of the specified value out to the specified
1054 /// ostream. This can be useful when you just want to print int %reg126, not
1055 /// the whole instruction that generated it.
1057 void llvm::WriteAsOperand(std::ostream &Out, const Value *V, bool PrintType,
1058 const Module *Context) {
1059 raw_os_ostream OS(Out);
1060 WriteAsOperand(OS, V, PrintType, Context);
1063 void llvm::WriteAsOperand(raw_ostream &Out, const Value *V, bool PrintType,
1064 const Module *Context) {
1065 if (Context == 0) Context = getModuleFromVal(V);
1067 TypePrinting TypePrinter;
1068 std::vector<const Type*> NumberedTypes;
1069 AddModuleTypesToPrinter(TypePrinter, NumberedTypes, Context);
1071 TypePrinter.print(V->getType(), Out);
1075 WriteAsOperandInternal(Out, V, TypePrinter, 0);
1081 class AssemblyWriter {
1083 SlotTracker &Machine;
1084 const Module *TheModule;
1085 TypePrinting TypePrinter;
1086 AssemblyAnnotationWriter *AnnotationWriter;
1087 std::vector<const Type*> NumberedTypes;
1089 inline AssemblyWriter(raw_ostream &o, SlotTracker &Mac, const Module *M,
1090 AssemblyAnnotationWriter *AAW)
1091 : Out(o), Machine(Mac), TheModule(M), AnnotationWriter(AAW) {
1092 AddModuleTypesToPrinter(TypePrinter, NumberedTypes, M);
1095 void write(const Module *M) { printModule(M); }
1097 void write(const GlobalValue *G) {
1098 if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(G))
1100 else if (const GlobalAlias *GA = dyn_cast<GlobalAlias>(G))
1102 else if (const Function *F = dyn_cast<Function>(G))
1105 assert(0 && "Unknown global");
1108 void write(const BasicBlock *BB) { printBasicBlock(BB); }
1109 void write(const Instruction *I) { printInstruction(*I); }
1111 void writeOperand(const Value *Op, bool PrintType);
1112 void writeParamOperand(const Value *Operand, Attributes Attrs);
1114 const Module* getModule() { return TheModule; }
1117 void printModule(const Module *M);
1118 void printTypeSymbolTable(const TypeSymbolTable &ST);
1119 void printGlobal(const GlobalVariable *GV);
1120 void printAlias(const GlobalAlias *GV);
1121 void printFunction(const Function *F);
1122 void printArgument(const Argument *FA, Attributes Attrs);
1123 void printBasicBlock(const BasicBlock *BB);
1124 void printInstruction(const Instruction &I);
1126 // printInfoComment - Print a little comment after the instruction indicating
1127 // which slot it occupies.
1128 void printInfoComment(const Value &V);
1130 } // end of anonymous namespace
1133 void AssemblyWriter::writeOperand(const Value *Operand, bool PrintType) {
1135 Out << "<null operand!>";
1138 TypePrinter.print(Operand->getType(), Out);
1141 WriteAsOperandInternal(Out, Operand, TypePrinter, &Machine);
1145 void AssemblyWriter::writeParamOperand(const Value *Operand,
1148 Out << "<null operand!>";
1151 TypePrinter.print(Operand->getType(), Out);
1152 // Print parameter attributes list
1153 if (Attrs != Attribute::None)
1154 Out << ' ' << Attribute::getAsString(Attrs);
1156 // Print the operand
1157 WriteAsOperandInternal(Out, Operand, TypePrinter, &Machine);
1161 void AssemblyWriter::printModule(const Module *M) {
1162 if (!M->getModuleIdentifier().empty() &&
1163 // Don't print the ID if it will start a new line (which would
1164 // require a comment char before it).
1165 M->getModuleIdentifier().find('\n') == std::string::npos)
1166 Out << "; ModuleID = '" << M->getModuleIdentifier() << "'\n";
1168 if (!M->getDataLayout().empty())
1169 Out << "target datalayout = \"" << M->getDataLayout() << "\"\n";
1170 if (!M->getTargetTriple().empty())
1171 Out << "target triple = \"" << M->getTargetTriple() << "\"\n";
1173 if (!M->getModuleInlineAsm().empty()) {
1174 // Split the string into lines, to make it easier to read the .ll file.
1175 std::string Asm = M->getModuleInlineAsm();
1177 size_t NewLine = Asm.find_first_of('\n', CurPos);
1178 while (NewLine != std::string::npos) {
1179 // We found a newline, print the portion of the asm string from the
1180 // last newline up to this newline.
1181 Out << "module asm \"";
1182 PrintEscapedString(std::string(Asm.begin()+CurPos, Asm.begin()+NewLine),
1186 NewLine = Asm.find_first_of('\n', CurPos);
1188 Out << "module asm \"";
1189 PrintEscapedString(std::string(Asm.begin()+CurPos, Asm.end()), Out);
1193 // Loop over the dependent libraries and emit them.
1194 Module::lib_iterator LI = M->lib_begin();
1195 Module::lib_iterator LE = M->lib_end();
1197 Out << "deplibs = [ ";
1199 Out << '"' << *LI << '"';
1207 // Loop over the symbol table, emitting all id'd types.
1208 printTypeSymbolTable(M->getTypeSymbolTable());
1210 for (Module::const_global_iterator I = M->global_begin(), E = M->global_end();
1214 // Output all aliases.
1215 if (!M->alias_empty()) Out << "\n";
1216 for (Module::const_alias_iterator I = M->alias_begin(), E = M->alias_end();
1220 // Output all of the functions.
1221 for (Module::const_iterator I = M->begin(), E = M->end(); I != E; ++I)
1225 static void PrintLinkage(GlobalValue::LinkageTypes LT, raw_ostream &Out) {
1227 case GlobalValue::PrivateLinkage: Out << "private "; break;
1228 case GlobalValue::InternalLinkage: Out << "internal "; break;
1229 case GlobalValue::LinkOnceAnyLinkage: Out << "linkonce "; break;
1230 case GlobalValue::LinkOnceODRLinkage: Out << "linkonce_odr "; break;
1231 case GlobalValue::WeakAnyLinkage: Out << "weak "; break;
1232 case GlobalValue::WeakODRLinkage: Out << "weak_odr "; break;
1233 case GlobalValue::CommonLinkage: Out << "common "; break;
1234 case GlobalValue::AppendingLinkage: Out << "appending "; break;
1235 case GlobalValue::DLLImportLinkage: Out << "dllimport "; break;
1236 case GlobalValue::DLLExportLinkage: Out << "dllexport "; break;
1237 case GlobalValue::ExternalWeakLinkage: Out << "extern_weak "; break;
1238 case GlobalValue::ExternalLinkage: break;
1239 case GlobalValue::GhostLinkage:
1240 Out << "GhostLinkage not allowed in AsmWriter!\n";
1246 static void PrintVisibility(GlobalValue::VisibilityTypes Vis,
1249 default: assert(0 && "Invalid visibility style!");
1250 case GlobalValue::DefaultVisibility: break;
1251 case GlobalValue::HiddenVisibility: Out << "hidden "; break;
1252 case GlobalValue::ProtectedVisibility: Out << "protected "; break;
1256 void AssemblyWriter::printGlobal(const GlobalVariable *GV) {
1257 if (GV->hasName()) {
1258 PrintLLVMName(Out, GV);
1262 if (!GV->hasInitializer() && GV->hasExternalLinkage())
1265 PrintLinkage(GV->getLinkage(), Out);
1266 PrintVisibility(GV->getVisibility(), Out);
1268 if (GV->isThreadLocal()) Out << "thread_local ";
1269 if (unsigned AddressSpace = GV->getType()->getAddressSpace())
1270 Out << "addrspace(" << AddressSpace << ") ";
1271 Out << (GV->isConstant() ? "constant " : "global ");
1272 TypePrinter.print(GV->getType()->getElementType(), Out);
1274 if (GV->hasInitializer()) {
1276 writeOperand(GV->getInitializer(), false);
1279 if (GV->hasSection())
1280 Out << ", section \"" << GV->getSection() << '"';
1281 if (GV->getAlignment())
1282 Out << ", align " << GV->getAlignment();
1284 printInfoComment(*GV);
1288 void AssemblyWriter::printAlias(const GlobalAlias *GA) {
1289 // Don't crash when dumping partially built GA
1291 Out << "<<nameless>> = ";
1293 PrintLLVMName(Out, GA);
1296 PrintVisibility(GA->getVisibility(), Out);
1300 PrintLinkage(GA->getLinkage(), Out);
1302 const Constant *Aliasee = GA->getAliasee();
1304 if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(Aliasee)) {
1305 TypePrinter.print(GV->getType(), Out);
1307 PrintLLVMName(Out, GV);
1308 } else if (const Function *F = dyn_cast<Function>(Aliasee)) {
1309 TypePrinter.print(F->getFunctionType(), Out);
1312 WriteAsOperandInternal(Out, F, TypePrinter, &Machine);
1313 } else if (const GlobalAlias *GA = dyn_cast<GlobalAlias>(Aliasee)) {
1314 TypePrinter.print(GA->getType(), Out);
1316 PrintLLVMName(Out, GA);
1318 const ConstantExpr *CE = 0;
1319 if ((CE = dyn_cast<ConstantExpr>(Aliasee)) &&
1320 (CE->getOpcode() == Instruction::BitCast)) {
1321 writeOperand(CE, false);
1323 assert(0 && "Unsupported aliasee");
1326 printInfoComment(*GA);
1330 void AssemblyWriter::printTypeSymbolTable(const TypeSymbolTable &ST) {
1331 // Emit all numbered types.
1332 for (unsigned i = 0, e = NumberedTypes.size(); i != e; ++i) {
1335 // Make sure we print out at least one level of the type structure, so
1336 // that we do not get %2 = type %2
1337 TypePrinter.printAtLeastOneLevel(NumberedTypes[i], Out);
1338 Out << "\t\t; type %" << i << '\n';
1341 // Print the named types.
1342 for (TypeSymbolTable::const_iterator TI = ST.begin(), TE = ST.end();
1345 PrintLLVMName(Out, &TI->first[0], TI->first.size(), LocalPrefix);
1348 // Make sure we print out at least one level of the type structure, so
1349 // that we do not get %FILE = type %FILE
1350 TypePrinter.printAtLeastOneLevel(TI->second, Out);
1355 /// printFunction - Print all aspects of a function.
1357 void AssemblyWriter::printFunction(const Function *F) {
1358 // Print out the return type and name.
1361 if (AnnotationWriter) AnnotationWriter->emitFunctionAnnot(F, Out);
1363 if (F->isDeclaration())
1368 PrintLinkage(F->getLinkage(), Out);
1369 PrintVisibility(F->getVisibility(), Out);
1371 // Print the calling convention.
1372 switch (F->getCallingConv()) {
1373 case CallingConv::C: break; // default
1374 case CallingConv::Fast: Out << "fastcc "; break;
1375 case CallingConv::Cold: Out << "coldcc "; break;
1376 case CallingConv::X86_StdCall: Out << "x86_stdcallcc "; break;
1377 case CallingConv::X86_FastCall: Out << "x86_fastcallcc "; break;
1378 default: Out << "cc" << F->getCallingConv() << " "; break;
1381 const FunctionType *FT = F->getFunctionType();
1382 const AttrListPtr &Attrs = F->getAttributes();
1383 Attributes RetAttrs = Attrs.getRetAttributes();
1384 if (RetAttrs != Attribute::None)
1385 Out << Attribute::getAsString(Attrs.getRetAttributes()) << ' ';
1386 TypePrinter.print(F->getReturnType(), Out);
1388 WriteAsOperandInternal(Out, F, TypePrinter, &Machine);
1390 Machine.incorporateFunction(F);
1392 // Loop over the arguments, printing them...
1395 if (!F->isDeclaration()) {
1396 // If this isn't a declaration, print the argument names as well.
1397 for (Function::const_arg_iterator I = F->arg_begin(), E = F->arg_end();
1399 // Insert commas as we go... the first arg doesn't get a comma
1400 if (I != F->arg_begin()) Out << ", ";
1401 printArgument(I, Attrs.getParamAttributes(Idx));
1405 // Otherwise, print the types from the function type.
1406 for (unsigned i = 0, e = FT->getNumParams(); i != e; ++i) {
1407 // Insert commas as we go... the first arg doesn't get a comma
1411 TypePrinter.print(FT->getParamType(i), Out);
1413 Attributes ArgAttrs = Attrs.getParamAttributes(i+1);
1414 if (ArgAttrs != Attribute::None)
1415 Out << ' ' << Attribute::getAsString(ArgAttrs);
1419 // Finish printing arguments...
1420 if (FT->isVarArg()) {
1421 if (FT->getNumParams()) Out << ", ";
1422 Out << "..."; // Output varargs portion of signature!
1425 Attributes FnAttrs = Attrs.getFnAttributes();
1426 if (FnAttrs != Attribute::None)
1427 Out << ' ' << Attribute::getAsString(Attrs.getFnAttributes());
1428 if (F->hasSection())
1429 Out << " section \"" << F->getSection() << '"';
1430 if (F->getAlignment())
1431 Out << " align " << F->getAlignment();
1433 Out << " gc \"" << F->getGC() << '"';
1434 if (F->isDeclaration()) {
1439 // Output all of its basic blocks... for the function
1440 for (Function::const_iterator I = F->begin(), E = F->end(); I != E; ++I)
1446 Machine.purgeFunction();
1449 /// printArgument - This member is called for every argument that is passed into
1450 /// the function. Simply print it out
1452 void AssemblyWriter::printArgument(const Argument *Arg,
1455 TypePrinter.print(Arg->getType(), Out);
1457 // Output parameter attributes list
1458 if (Attrs != Attribute::None)
1459 Out << ' ' << Attribute::getAsString(Attrs);
1461 // Output name, if available...
1462 if (Arg->hasName()) {
1464 PrintLLVMName(Out, Arg);
1468 /// printBasicBlock - This member is called for each basic block in a method.
1470 void AssemblyWriter::printBasicBlock(const BasicBlock *BB) {
1471 if (BB->hasName()) { // Print out the label if it exists...
1473 PrintLLVMName(Out, BB->getNameStart(), BB->getNameLen(), LabelPrefix);
1475 } else if (!BB->use_empty()) { // Don't print block # of no uses...
1476 Out << "\n; <label>:";
1477 int Slot = Machine.getLocalSlot(BB);
1484 if (BB->getParent() == 0)
1485 Out << "\t\t; Error: Block without parent!";
1486 else if (BB != &BB->getParent()->getEntryBlock()) { // Not the entry block?
1487 // Output predecessors for the block...
1489 pred_const_iterator PI = pred_begin(BB), PE = pred_end(BB);
1492 Out << " No predecessors!";
1495 writeOperand(*PI, false);
1496 for (++PI; PI != PE; ++PI) {
1498 writeOperand(*PI, false);
1505 if (AnnotationWriter) AnnotationWriter->emitBasicBlockStartAnnot(BB, Out);
1507 // Output all of the instructions in the basic block...
1508 for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I != E; ++I)
1509 printInstruction(*I);
1511 if (AnnotationWriter) AnnotationWriter->emitBasicBlockEndAnnot(BB, Out);
1515 /// printInfoComment - Print a little comment after the instruction indicating
1516 /// which slot it occupies.
1518 void AssemblyWriter::printInfoComment(const Value &V) {
1519 if (V.getType() != Type::VoidTy) {
1521 TypePrinter.print(V.getType(), Out);
1524 if (!V.hasName() && !isa<Instruction>(V)) {
1526 if (const GlobalValue *GV = dyn_cast<GlobalValue>(&V))
1527 SlotNum = Machine.getGlobalSlot(GV);
1529 SlotNum = Machine.getLocalSlot(&V);
1533 Out << ':' << SlotNum; // Print out the def slot taken.
1535 Out << " [#uses=" << V.getNumUses() << ']'; // Output # uses
1539 // This member is called for each Instruction in a function..
1540 void AssemblyWriter::printInstruction(const Instruction &I) {
1541 if (AnnotationWriter) AnnotationWriter->emitInstructionAnnot(&I, Out);
1545 // Print out name if it exists...
1547 PrintLLVMName(Out, &I);
1549 } else if (I.getType() != Type::VoidTy) {
1550 // Print out the def slot taken.
1551 int SlotNum = Machine.getLocalSlot(&I);
1553 Out << "<badref> = ";
1555 Out << '%' << SlotNum << " = ";
1558 // If this is a volatile load or store, print out the volatile marker.
1559 if ((isa<LoadInst>(I) && cast<LoadInst>(I).isVolatile()) ||
1560 (isa<StoreInst>(I) && cast<StoreInst>(I).isVolatile())) {
1562 } else if (isa<CallInst>(I) && cast<CallInst>(I).isTailCall()) {
1563 // If this is a call, check if it's a tail call.
1567 // Print out the opcode...
1568 Out << I.getOpcodeName();
1570 // Print out the compare instruction predicates
1571 if (const CmpInst *CI = dyn_cast<CmpInst>(&I))
1572 Out << ' ' << getPredicateText(CI->getPredicate());
1574 // Print out the type of the operands...
1575 const Value *Operand = I.getNumOperands() ? I.getOperand(0) : 0;
1577 // Special case conditional branches to swizzle the condition out to the front
1578 if (isa<BranchInst>(I) && cast<BranchInst>(I).isConditional()) {
1579 BranchInst &BI(cast<BranchInst>(I));
1581 writeOperand(BI.getCondition(), true);
1583 writeOperand(BI.getSuccessor(0), true);
1585 writeOperand(BI.getSuccessor(1), true);
1587 } else if (isa<SwitchInst>(I)) {
1588 // Special case switch statement to get formatting nice and correct...
1590 writeOperand(Operand , true);
1592 writeOperand(I.getOperand(1), true);
1595 for (unsigned op = 2, Eop = I.getNumOperands(); op < Eop; op += 2) {
1597 writeOperand(I.getOperand(op ), true);
1599 writeOperand(I.getOperand(op+1), true);
1602 } else if (isa<PHINode>(I)) {
1604 TypePrinter.print(I.getType(), Out);
1607 for (unsigned op = 0, Eop = I.getNumOperands(); op < Eop; op += 2) {
1608 if (op) Out << ", ";
1610 writeOperand(I.getOperand(op ), false); Out << ", ";
1611 writeOperand(I.getOperand(op+1), false); Out << " ]";
1613 } else if (const ExtractValueInst *EVI = dyn_cast<ExtractValueInst>(&I)) {
1615 writeOperand(I.getOperand(0), true);
1616 for (const unsigned *i = EVI->idx_begin(), *e = EVI->idx_end(); i != e; ++i)
1618 } else if (const InsertValueInst *IVI = dyn_cast<InsertValueInst>(&I)) {
1620 writeOperand(I.getOperand(0), true); Out << ", ";
1621 writeOperand(I.getOperand(1), true);
1622 for (const unsigned *i = IVI->idx_begin(), *e = IVI->idx_end(); i != e; ++i)
1624 } else if (isa<ReturnInst>(I) && !Operand) {
1626 } else if (const CallInst *CI = dyn_cast<CallInst>(&I)) {
1627 // Print the calling convention being used.
1628 switch (CI->getCallingConv()) {
1629 case CallingConv::C: break; // default
1630 case CallingConv::Fast: Out << " fastcc"; break;
1631 case CallingConv::Cold: Out << " coldcc"; break;
1632 case CallingConv::X86_StdCall: Out << " x86_stdcallcc"; break;
1633 case CallingConv::X86_FastCall: Out << " x86_fastcallcc"; break;
1634 default: Out << " cc" << CI->getCallingConv(); break;
1637 const PointerType *PTy = cast<PointerType>(Operand->getType());
1638 const FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
1639 const Type *RetTy = FTy->getReturnType();
1640 const AttrListPtr &PAL = CI->getAttributes();
1642 if (PAL.getRetAttributes() != Attribute::None)
1643 Out << ' ' << Attribute::getAsString(PAL.getRetAttributes());
1645 // If possible, print out the short form of the call instruction. We can
1646 // only do this if the first argument is a pointer to a nonvararg function,
1647 // and if the return type is not a pointer to a function.
1650 if (!FTy->isVarArg() &&
1651 (!isa<PointerType>(RetTy) ||
1652 !isa<FunctionType>(cast<PointerType>(RetTy)->getElementType()))) {
1653 TypePrinter.print(RetTy, Out);
1655 writeOperand(Operand, false);
1657 writeOperand(Operand, true);
1660 for (unsigned op = 1, Eop = I.getNumOperands(); op < Eop; ++op) {
1663 writeParamOperand(I.getOperand(op), PAL.getParamAttributes(op));
1666 if (PAL.getFnAttributes() != Attribute::None)
1667 Out << ' ' << Attribute::getAsString(PAL.getFnAttributes());
1668 } else if (const InvokeInst *II = dyn_cast<InvokeInst>(&I)) {
1669 const PointerType *PTy = cast<PointerType>(Operand->getType());
1670 const FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
1671 const Type *RetTy = FTy->getReturnType();
1672 const AttrListPtr &PAL = II->getAttributes();
1674 // Print the calling convention being used.
1675 switch (II->getCallingConv()) {
1676 case CallingConv::C: break; // default
1677 case CallingConv::Fast: Out << " fastcc"; break;
1678 case CallingConv::Cold: Out << " coldcc"; break;
1679 case CallingConv::X86_StdCall: Out << " x86_stdcallcc"; break;
1680 case CallingConv::X86_FastCall: Out << " x86_fastcallcc"; break;
1681 default: Out << " cc" << II->getCallingConv(); break;
1684 if (PAL.getRetAttributes() != Attribute::None)
1685 Out << ' ' << Attribute::getAsString(PAL.getRetAttributes());
1687 // If possible, print out the short form of the invoke instruction. We can
1688 // only do this if the first argument is a pointer to a nonvararg function,
1689 // and if the return type is not a pointer to a function.
1692 if (!FTy->isVarArg() &&
1693 (!isa<PointerType>(RetTy) ||
1694 !isa<FunctionType>(cast<PointerType>(RetTy)->getElementType()))) {
1695 TypePrinter.print(RetTy, Out);
1697 writeOperand(Operand, false);
1699 writeOperand(Operand, true);
1702 for (unsigned op = 3, Eop = I.getNumOperands(); op < Eop; ++op) {
1705 writeParamOperand(I.getOperand(op), PAL.getParamAttributes(op-2));
1709 if (PAL.getFnAttributes() != Attribute::None)
1710 Out << ' ' << Attribute::getAsString(PAL.getFnAttributes());
1712 Out << "\n\t\t\tto ";
1713 writeOperand(II->getNormalDest(), true);
1715 writeOperand(II->getUnwindDest(), true);
1717 } else if (const AllocationInst *AI = dyn_cast<AllocationInst>(&I)) {
1719 TypePrinter.print(AI->getType()->getElementType(), Out);
1720 if (AI->isArrayAllocation()) {
1722 writeOperand(AI->getArraySize(), true);
1724 if (AI->getAlignment()) {
1725 Out << ", align " << AI->getAlignment();
1727 } else if (isa<CastInst>(I)) {
1730 writeOperand(Operand, true); // Work with broken code
1733 TypePrinter.print(I.getType(), Out);
1734 } else if (isa<VAArgInst>(I)) {
1737 writeOperand(Operand, true); // Work with broken code
1740 TypePrinter.print(I.getType(), Out);
1741 } else if (Operand) { // Print the normal way.
1743 // PrintAllTypes - Instructions who have operands of all the same type
1744 // omit the type from all but the first operand. If the instruction has
1745 // different type operands (for example br), then they are all printed.
1746 bool PrintAllTypes = false;
1747 const Type *TheType = Operand->getType();
1749 // Select, Store and ShuffleVector always print all types.
1750 if (isa<SelectInst>(I) || isa<StoreInst>(I) || isa<ShuffleVectorInst>(I)
1751 || isa<ReturnInst>(I)) {
1752 PrintAllTypes = true;
1754 for (unsigned i = 1, E = I.getNumOperands(); i != E; ++i) {
1755 Operand = I.getOperand(i);
1756 // note that Operand shouldn't be null, but the test helps make dump()
1757 // more tolerant of malformed IR
1758 if (Operand && Operand->getType() != TheType) {
1759 PrintAllTypes = true; // We have differing types! Print them all!
1765 if (!PrintAllTypes) {
1767 TypePrinter.print(TheType, Out);
1771 for (unsigned i = 0, E = I.getNumOperands(); i != E; ++i) {
1773 writeOperand(I.getOperand(i), PrintAllTypes);
1777 // Print post operand alignment for load/store
1778 if (isa<LoadInst>(I) && cast<LoadInst>(I).getAlignment()) {
1779 Out << ", align " << cast<LoadInst>(I).getAlignment();
1780 } else if (isa<StoreInst>(I) && cast<StoreInst>(I).getAlignment()) {
1781 Out << ", align " << cast<StoreInst>(I).getAlignment();
1784 printInfoComment(I);
1789 //===----------------------------------------------------------------------===//
1790 // External Interface declarations
1791 //===----------------------------------------------------------------------===//
1793 void Module::print(std::ostream &o, AssemblyAnnotationWriter *AAW) const {
1794 raw_os_ostream OS(o);
1797 void Module::print(raw_ostream &OS, AssemblyAnnotationWriter *AAW) const {
1798 SlotTracker SlotTable(this);
1799 AssemblyWriter W(OS, SlotTable, this, AAW);
1803 void Type::print(std::ostream &o) const {
1804 raw_os_ostream OS(o);
1808 void Type::print(raw_ostream &OS) const {
1810 OS << "<null Type>";
1813 TypePrinting().print(this, OS);
1816 void Value::print(raw_ostream &OS, AssemblyAnnotationWriter *AAW) const {
1818 OS << "printing a <null> value\n";
1822 if (const Instruction *I = dyn_cast<Instruction>(this)) {
1823 const Function *F = I->getParent() ? I->getParent()->getParent() : 0;
1824 SlotTracker SlotTable(F);
1825 AssemblyWriter W(OS, SlotTable, F ? F->getParent() : 0, AAW);
1827 } else if (const BasicBlock *BB = dyn_cast<BasicBlock>(this)) {
1828 SlotTracker SlotTable(BB->getParent());
1829 AssemblyWriter W(OS, SlotTable,
1830 BB->getParent() ? BB->getParent()->getParent() : 0, AAW);
1832 } else if (const GlobalValue *GV = dyn_cast<GlobalValue>(this)) {
1833 SlotTracker SlotTable(GV->getParent());
1834 AssemblyWriter W(OS, SlotTable, GV->getParent(), 0);
1836 } else if (const Constant *C = dyn_cast<Constant>(this)) {
1837 TypePrinting TypePrinter;
1838 TypePrinter.print(C->getType(), OS);
1840 WriteConstantInt(OS, C, TypePrinter, 0);
1841 } else if (const Argument *A = dyn_cast<Argument>(this)) {
1842 WriteAsOperand(OS, this, true,
1843 A->getParent() ? A->getParent()->getParent() : 0);
1844 } else if (isa<InlineAsm>(this)) {
1845 WriteAsOperand(OS, this, true, 0);
1847 assert(0 && "Unknown value to print out!");
1851 void Value::print(std::ostream &O, AssemblyAnnotationWriter *AAW) const {
1852 raw_os_ostream OS(O);
1856 // Value::dump - allow easy printing of Values from the debugger.
1857 void Value::dump() const { print(errs()); errs() << '\n'; }
1859 // Type::dump - allow easy printing of Types from the debugger.
1860 // This one uses type names from the given context module
1861 void Type::dump(const Module *Context) const {
1862 WriteTypeSymbolic(errs(), this, Context);
1866 // Type::dump - allow easy printing of Types from the debugger.
1867 void Type::dump() const { dump(0); }
1869 // Module::dump() - Allow printing of Modules from the debugger.
1870 void Module::dump() const { print(errs(), 0); }