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/LLVMContext.h"
27 #include "llvm/Operator.h"
28 #include "llvm/Metadata.h"
29 #include "llvm/Module.h"
30 #include "llvm/ValueSymbolTable.h"
31 #include "llvm/TypeSymbolTable.h"
32 #include "llvm/ADT/DenseSet.h"
33 #include "llvm/ADT/StringExtras.h"
34 #include "llvm/ADT/STLExtras.h"
35 #include "llvm/Support/CFG.h"
36 #include "llvm/Support/Dwarf.h"
37 #include "llvm/Support/ErrorHandling.h"
38 #include "llvm/Support/MathExtras.h"
39 #include "llvm/Support/FormattedStream.h"
45 // Make virtual table appear in this compilation unit.
46 AssemblyAnnotationWriter::~AssemblyAnnotationWriter() {}
48 //===----------------------------------------------------------------------===//
50 //===----------------------------------------------------------------------===//
52 static const Module *getModuleFromVal(const Value *V) {
53 if (const Argument *MA = dyn_cast<Argument>(V))
54 return MA->getParent() ? MA->getParent()->getParent() : 0;
56 if (const BasicBlock *BB = dyn_cast<BasicBlock>(V))
57 return BB->getParent() ? BB->getParent()->getParent() : 0;
59 if (const Instruction *I = dyn_cast<Instruction>(V)) {
60 const Function *M = I->getParent() ? I->getParent()->getParent() : 0;
61 return M ? M->getParent() : 0;
64 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V))
65 return GV->getParent();
69 // PrintEscapedString - Print each character of the specified string, escaping
70 // it if it is not printable or if it is an escape char.
71 static void PrintEscapedString(const StringRef &Name,
73 for (unsigned i = 0, e = Name.size(); i != e; ++i) {
74 unsigned char C = Name[i];
75 if (isprint(C) && C != '\\' && C != '"')
78 Out << '\\' << hexdigit(C >> 4) << hexdigit(C & 0x0F);
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 StringRef &Name,
94 assert(Name.data() && "Cannot get empty name!");
96 default: llvm_unreachable("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(Name[0]);
106 for (unsigned i = 0, e = Name.size(); i != e; ++i) {
108 if (!isalnum(C) && C != '-' && C != '.' && C != '_') {
115 // If we didn't need any quotes, just write out the name in one blast.
121 // Okay, we need quotes. Output the quotes and escape any scary characters as
124 PrintEscapedString(Name, 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->getName(),
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::MetadataTyID: OS << "metadata"; 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 NameROS(NameStr);
432 formatted_raw_ostream NameOS(NameROS);
433 PrintLLVMName(NameOS, TI->first, LocalPrefix);
435 TP.addTypeName(Ty, NameStr);
438 // Walk the entire module to find references to unnamed structure and opaque
439 // types. This is required for correctness by opaque types (because multiple
440 // uses of an unnamed opaque type needs to be referred to by the same ID) and
441 // it shrinks complex recursive structure types substantially in some cases.
442 TypeFinder(TP, NumberedTypes).Run(*M);
446 /// WriteTypeSymbolic - This attempts to write the specified type as a symbolic
447 /// type, iff there is an entry in the modules symbol table for the specified
448 /// type or one of it's component types.
450 void llvm::WriteTypeSymbolic(raw_ostream &OS, const Type *Ty, const Module *M) {
451 TypePrinting Printer;
452 std::vector<const Type*> NumberedTypes;
453 AddModuleTypesToPrinter(Printer, NumberedTypes, M);
454 Printer.print(Ty, OS);
457 //===----------------------------------------------------------------------===//
458 // SlotTracker Class: Enumerate slot numbers for unnamed values
459 //===----------------------------------------------------------------------===//
463 /// This class provides computation of slot numbers for LLVM Assembly writing.
467 /// ValueMap - A mapping of Values to slot numbers.
468 typedef DenseMap<const Value*, unsigned> ValueMap;
471 /// TheModule - The module for which we are holding slot numbers.
472 const Module* TheModule;
474 /// TheFunction - The function for which we are holding slot numbers.
475 const Function* TheFunction;
476 bool FunctionProcessed;
478 /// TheMDNode - The MDNode for which we are holding slot numbers.
479 const MDNode *TheMDNode;
481 /// TheNamedMDNode - The MDNode for which we are holding slot numbers.
482 const NamedMDNode *TheNamedMDNode;
484 /// mMap - The TypePlanes map for the module level data.
488 /// fMap - The TypePlanes map for the function level data.
492 /// mdnMap - Map for MDNodes.
496 /// Construct from a module
497 explicit SlotTracker(const Module *M);
498 /// Construct from a function, starting out in incorp state.
499 explicit SlotTracker(const Function *F);
500 /// Construct from a mdnode.
501 explicit SlotTracker(const MDNode *N);
502 /// Construct from a named mdnode.
503 explicit SlotTracker(const NamedMDNode *N);
505 /// Return the slot number of the specified value in it's type
506 /// plane. If something is not in the SlotTracker, return -1.
507 int getLocalSlot(const Value *V);
508 int getGlobalSlot(const GlobalValue *V);
509 int getMetadataSlot(const MDNode *N);
511 /// If you'd like to deal with a function instead of just a module, use
512 /// this method to get its data into the SlotTracker.
513 void incorporateFunction(const Function *F) {
515 FunctionProcessed = false;
518 /// After calling incorporateFunction, use this method to remove the
519 /// most recently incorporated function from the SlotTracker. This
520 /// will reset the state of the machine back to just the module contents.
521 void purgeFunction();
523 /// MDNode map iterators.
524 ValueMap::iterator mdnBegin() { return mdnMap.begin(); }
525 ValueMap::iterator mdnEnd() { return mdnMap.end(); }
526 unsigned mdnSize() const { return mdnMap.size(); }
527 bool mdnEmpty() const { return mdnMap.empty(); }
529 /// This function does the actual initialization.
530 inline void initialize();
532 // Implementation Details
534 /// CreateModuleSlot - Insert the specified GlobalValue* into the slot table.
535 void CreateModuleSlot(const GlobalValue *V);
537 /// CreateMetadataSlot - Insert the specified MDNode* into the slot table.
538 void CreateMetadataSlot(const MDNode *N);
540 /// CreateFunctionSlot - Insert the specified Value* into the slot table.
541 void CreateFunctionSlot(const Value *V);
543 /// Add all of the module level global variables (and their initializers)
544 /// and function declarations, but not the contents of those functions.
545 void processModule();
547 /// Add all of the functions arguments, basic blocks, and instructions.
548 void processFunction();
550 /// Add all MDNode operands.
551 void processMDNode();
553 /// Add all MDNode operands.
554 void processNamedMDNode();
556 SlotTracker(const SlotTracker &); // DO NOT IMPLEMENT
557 void operator=(const SlotTracker &); // DO NOT IMPLEMENT
560 } // end anonymous namespace
563 static SlotTracker *createSlotTracker(const Value *V) {
564 if (const Argument *FA = dyn_cast<Argument>(V))
565 return new SlotTracker(FA->getParent());
567 if (const Instruction *I = dyn_cast<Instruction>(V))
568 return new SlotTracker(I->getParent()->getParent());
570 if (const BasicBlock *BB = dyn_cast<BasicBlock>(V))
571 return new SlotTracker(BB->getParent());
573 if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(V))
574 return new SlotTracker(GV->getParent());
576 if (const GlobalAlias *GA = dyn_cast<GlobalAlias>(V))
577 return new SlotTracker(GA->getParent());
579 if (const Function *Func = dyn_cast<Function>(V))
580 return new SlotTracker(Func);
586 #define ST_DEBUG(X) errs() << X
591 // Module level constructor. Causes the contents of the Module (sans functions)
592 // to be added to the slot table.
593 SlotTracker::SlotTracker(const Module *M)
594 : TheModule(M), TheFunction(0), FunctionProcessed(false), TheMDNode(0),
595 TheNamedMDNode(0), mNext(0), fNext(0), mdnNext(0) {
598 // Function level constructor. Causes the contents of the Module and the one
599 // function provided to be added to the slot table.
600 SlotTracker::SlotTracker(const Function *F)
601 : TheModule(F ? F->getParent() : 0), TheFunction(F), FunctionProcessed(false),
602 TheMDNode(0), TheNamedMDNode(0), mNext(0), fNext(0), mdnNext(0) {
605 // Constructor to handle single MDNode.
606 SlotTracker::SlotTracker(const MDNode *C)
607 : TheModule(0), TheFunction(0), FunctionProcessed(false), TheMDNode(C),
608 TheNamedMDNode(0), mNext(0), fNext(0), mdnNext(0) {
611 // Constructor to handle single NamedMDNode.
612 SlotTracker::SlotTracker(const NamedMDNode *N)
613 : TheModule(0), TheFunction(0), FunctionProcessed(false), TheMDNode(0),
614 TheNamedMDNode(N), mNext(0), fNext(0), mdnNext(0) {
617 inline void SlotTracker::initialize() {
620 TheModule = 0; ///< Prevent re-processing next time we're called.
623 if (TheFunction && !FunctionProcessed)
630 processNamedMDNode();
633 // Iterate through all the global variables, functions, and global
634 // variable initializers and create slots for them.
635 void SlotTracker::processModule() {
636 ST_DEBUG("begin processModule!\n");
638 // Add all of the unnamed global variables to the value table.
639 for (Module::const_global_iterator I = TheModule->global_begin(),
640 E = TheModule->global_end(); I != E; ++I) {
643 if (I->hasInitializer()) {
644 if (MDNode *N = dyn_cast<MDNode>(I->getInitializer()))
645 CreateMetadataSlot(N);
649 // Add metadata used by named metadata.
650 for (Module::const_named_metadata_iterator
651 I = TheModule->named_metadata_begin(),
652 E = TheModule->named_metadata_end(); I != E; ++I) {
653 const NamedMDNode *NMD = I;
654 for (unsigned i = 0, e = NMD->getNumElements(); i != e; ++i) {
655 MDNode *MD = dyn_cast_or_null<MDNode>(NMD->getElement(i));
657 CreateMetadataSlot(MD);
661 // Add all the unnamed functions to the table.
662 for (Module::const_iterator I = TheModule->begin(), E = TheModule->end();
667 ST_DEBUG("end processModule!\n");
670 // Process the arguments, basic blocks, and instructions of a function.
671 void SlotTracker::processFunction() {
672 ST_DEBUG("begin processFunction!\n");
675 // Add all the function arguments with no names.
676 for(Function::const_arg_iterator AI = TheFunction->arg_begin(),
677 AE = TheFunction->arg_end(); AI != AE; ++AI)
679 CreateFunctionSlot(AI);
681 ST_DEBUG("Inserting Instructions:\n");
683 MetadataContext &TheMetadata = TheFunction->getContext().getMetadata();
684 typedef SmallVector<std::pair<unsigned, TrackingVH<MDNode> >, 2> MDMapTy;
687 // Add all of the basic blocks and instructions with no names.
688 for (Function::const_iterator BB = TheFunction->begin(),
689 E = TheFunction->end(); BB != E; ++BB) {
691 CreateFunctionSlot(BB);
692 for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I != E;
694 if (I->getType() != Type::getVoidTy(TheFunction->getContext()) &&
696 CreateFunctionSlot(I);
697 for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i)
698 if (MDNode *N = dyn_cast_or_null<MDNode>(I->getOperand(i)))
699 CreateMetadataSlot(N);
701 // Process metadata attached with this instruction.
703 TheMetadata.getMDs(I, MDs);
704 for (MDMapTy::const_iterator MI = MDs.begin(), ME = MDs.end(); MI != ME;
706 CreateMetadataSlot(MI->second);
710 FunctionProcessed = true;
712 ST_DEBUG("end processFunction!\n");
715 /// processMDNode - Process TheMDNode.
716 void SlotTracker::processMDNode() {
717 ST_DEBUG("begin processMDNode!\n");
719 CreateMetadataSlot(TheMDNode);
721 ST_DEBUG("end processMDNode!\n");
724 /// processNamedMDNode - Process TheNamedMDNode.
725 void SlotTracker::processNamedMDNode() {
726 ST_DEBUG("begin processNamedMDNode!\n");
728 for (unsigned i = 0, e = TheNamedMDNode->getNumElements(); i != e; ++i) {
729 MDNode *MD = dyn_cast_or_null<MDNode>(TheNamedMDNode->getElement(i));
731 CreateMetadataSlot(MD);
734 ST_DEBUG("end processNamedMDNode!\n");
737 /// Clean up after incorporating a function. This is the only way to get out of
738 /// the function incorporation state that affects get*Slot/Create*Slot. Function
739 /// incorporation state is indicated by TheFunction != 0.
740 void SlotTracker::purgeFunction() {
741 ST_DEBUG("begin purgeFunction!\n");
742 fMap.clear(); // Simply discard the function level map
744 FunctionProcessed = false;
745 ST_DEBUG("end purgeFunction!\n");
748 /// getGlobalSlot - Get the slot number of a global value.
749 int SlotTracker::getGlobalSlot(const GlobalValue *V) {
750 // Check for uninitialized state and do lazy initialization.
753 // Find the type plane in the module map
754 ValueMap::iterator MI = mMap.find(V);
755 return MI == mMap.end() ? -1 : (int)MI->second;
758 /// getGlobalSlot - Get the slot number of a MDNode.
759 int SlotTracker::getMetadataSlot(const MDNode *N) {
760 // Check for uninitialized state and do lazy initialization.
763 // Find the type plane in the module map
764 ValueMap::iterator MI = mdnMap.find(N);
765 return MI == mdnMap.end() ? -1 : (int)MI->second;
769 /// getLocalSlot - Get the slot number for a value that is local to a function.
770 int SlotTracker::getLocalSlot(const Value *V) {
771 assert(!isa<Constant>(V) && "Can't get a constant or global slot with this!");
773 // Check for uninitialized state and do lazy initialization.
776 ValueMap::iterator FI = fMap.find(V);
777 return FI == fMap.end() ? -1 : (int)FI->second;
781 /// CreateModuleSlot - Insert the specified GlobalValue* into the slot table.
782 void SlotTracker::CreateModuleSlot(const GlobalValue *V) {
783 assert(V && "Can't insert a null Value into SlotTracker!");
784 assert(V->getType() != Type::getVoidTy(V->getContext()) &&
785 "Doesn't need a slot!");
786 assert(!V->hasName() && "Doesn't need a slot!");
788 unsigned DestSlot = mNext++;
791 ST_DEBUG(" Inserting value [" << V->getType() << "] = " << V << " slot=" <<
793 // G = Global, F = Function, A = Alias, o = other
794 ST_DEBUG((isa<GlobalVariable>(V) ? 'G' :
795 (isa<Function>(V) ? 'F' :
796 (isa<GlobalAlias>(V) ? 'A' : 'o'))) << "]\n");
799 /// CreateSlot - Create a new slot for the specified value if it has no name.
800 void SlotTracker::CreateFunctionSlot(const Value *V) {
801 assert(V->getType() != Type::getVoidTy(TheFunction->getContext()) &&
802 !V->hasName() && "Doesn't need a slot!");
804 unsigned DestSlot = fNext++;
807 // G = Global, F = Function, o = other
808 ST_DEBUG(" Inserting value [" << V->getType() << "] = " << V << " slot=" <<
809 DestSlot << " [o]\n");
812 /// CreateModuleSlot - Insert the specified MDNode* into the slot table.
813 void SlotTracker::CreateMetadataSlot(const MDNode *N) {
814 assert(N && "Can't insert a null Value into SlotTracker!");
816 ValueMap::iterator I = mdnMap.find(N);
817 if (I != mdnMap.end())
820 unsigned DestSlot = mdnNext++;
821 mdnMap[N] = DestSlot;
823 for (unsigned i = 0, e = N->getNumElements(); i != e; ++i) {
824 const Value *TV = N->getElement(i);
826 if (const MDNode *N2 = dyn_cast<MDNode>(TV))
827 CreateMetadataSlot(N2);
831 //===----------------------------------------------------------------------===//
832 // AsmWriter Implementation
833 //===----------------------------------------------------------------------===//
835 static void WriteAsOperandInternal(raw_ostream &Out, const Value *V,
836 TypePrinting *TypePrinter,
837 SlotTracker *Machine);
841 static const char *getPredicateText(unsigned predicate) {
842 const char * pred = "unknown";
844 case FCmpInst::FCMP_FALSE: pred = "false"; break;
845 case FCmpInst::FCMP_OEQ: pred = "oeq"; break;
846 case FCmpInst::FCMP_OGT: pred = "ogt"; break;
847 case FCmpInst::FCMP_OGE: pred = "oge"; break;
848 case FCmpInst::FCMP_OLT: pred = "olt"; break;
849 case FCmpInst::FCMP_OLE: pred = "ole"; break;
850 case FCmpInst::FCMP_ONE: pred = "one"; break;
851 case FCmpInst::FCMP_ORD: pred = "ord"; break;
852 case FCmpInst::FCMP_UNO: pred = "uno"; break;
853 case FCmpInst::FCMP_UEQ: pred = "ueq"; break;
854 case FCmpInst::FCMP_UGT: pred = "ugt"; break;
855 case FCmpInst::FCMP_UGE: pred = "uge"; break;
856 case FCmpInst::FCMP_ULT: pred = "ult"; break;
857 case FCmpInst::FCMP_ULE: pred = "ule"; break;
858 case FCmpInst::FCMP_UNE: pred = "une"; break;
859 case FCmpInst::FCMP_TRUE: pred = "true"; break;
860 case ICmpInst::ICMP_EQ: pred = "eq"; break;
861 case ICmpInst::ICMP_NE: pred = "ne"; break;
862 case ICmpInst::ICMP_SGT: pred = "sgt"; break;
863 case ICmpInst::ICMP_SGE: pred = "sge"; break;
864 case ICmpInst::ICMP_SLT: pred = "slt"; break;
865 case ICmpInst::ICMP_SLE: pred = "sle"; break;
866 case ICmpInst::ICMP_UGT: pred = "ugt"; break;
867 case ICmpInst::ICMP_UGE: pred = "uge"; break;
868 case ICmpInst::ICMP_ULT: pred = "ult"; break;
869 case ICmpInst::ICMP_ULE: pred = "ule"; break;
874 static void WriteMDNodeComment(const MDNode *Node,
875 formatted_raw_ostream &Out) {
876 if (Node->getNumElements() < 1)
878 ConstantInt *CI = dyn_cast_or_null<ConstantInt>(Node->getElement(0));
880 unsigned Val = CI->getZExtValue();
881 unsigned Tag = Val & ~LLVMDebugVersionMask;
882 if (Val >= LLVMDebugVersion) {
883 if (Tag == dwarf::DW_TAG_auto_variable)
884 Out << "; [ DW_TAG_auto_variable ]";
885 else if (Tag == dwarf::DW_TAG_arg_variable)
886 Out << "; [ DW_TAG_arg_variable ]";
887 else if (Tag == dwarf::DW_TAG_return_variable)
888 Out << "; [ DW_TAG_return_variable ]";
889 else if (Tag == dwarf::DW_TAG_vector_type)
890 Out << "; [ DW_TAG_vector_type ]";
891 else if (Tag == dwarf::DW_TAG_user_base)
892 Out << "; [ DW_TAG_user_base ]";
894 Out << "; [" << dwarf::TagString(Tag) << " ]";
898 static void WriteMDNodes(formatted_raw_ostream &Out, TypePrinting &TypePrinter,
899 SlotTracker &Machine) {
900 SmallVector<const MDNode *, 16> Nodes;
901 Nodes.resize(Machine.mdnSize());
902 for (SlotTracker::ValueMap::iterator I =
903 Machine.mdnBegin(), E = Machine.mdnEnd(); I != E; ++I)
904 Nodes[I->second] = cast<MDNode>(I->first);
906 for (unsigned i = 0, e = Nodes.size(); i != e; ++i) {
907 Out << '!' << i << " = metadata ";
908 const MDNode *Node = Nodes[i];
910 for (unsigned mi = 0, me = Node->getNumElements(); mi != me; ++mi) {
911 const Value *V = Node->getElement(mi);
914 else if (const MDNode *N = dyn_cast<MDNode>(V)) {
916 Out << '!' << Machine.getMetadataSlot(N);
919 TypePrinter.print(V->getType(), Out);
921 WriteAsOperandInternal(Out, Node->getElement(mi),
922 &TypePrinter, &Machine);
929 WriteMDNodeComment(Node, Out);
934 static void WriteOptimizationInfo(raw_ostream &Out, const User *U) {
935 if (const OverflowingBinaryOperator *OBO =
936 dyn_cast<OverflowingBinaryOperator>(U)) {
937 if (OBO->hasNoUnsignedWrap())
939 if (OBO->hasNoSignedWrap())
941 } else if (const SDivOperator *Div = dyn_cast<SDivOperator>(U)) {
944 } else if (const GEPOperator *GEP = dyn_cast<GEPOperator>(U)) {
945 if (GEP->isInBounds())
950 static void WriteConstantInt(raw_ostream &Out, const Constant *CV,
951 TypePrinting &TypePrinter, SlotTracker *Machine) {
952 if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV)) {
953 if (CI->getType() == Type::getInt1Ty(CV->getContext())) {
954 Out << (CI->getZExtValue() ? "true" : "false");
957 Out << CI->getValue();
961 if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV)) {
962 if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEdouble ||
963 &CFP->getValueAPF().getSemantics() == &APFloat::IEEEsingle) {
964 // We would like to output the FP constant value in exponential notation,
965 // but we cannot do this if doing so will lose precision. Check here to
966 // make sure that we only output it in exponential format if we can parse
967 // the value back and get the same value.
970 bool isDouble = &CFP->getValueAPF().getSemantics()==&APFloat::IEEEdouble;
971 double Val = isDouble ? CFP->getValueAPF().convertToDouble() :
972 CFP->getValueAPF().convertToFloat();
973 std::string StrVal = ftostr(CFP->getValueAPF());
975 // Check to make sure that the stringized number is not some string like
976 // "Inf" or NaN, that atof will accept, but the lexer will not. Check
977 // that the string matches the "[-+]?[0-9]" regex.
979 if ((StrVal[0] >= '0' && StrVal[0] <= '9') ||
980 ((StrVal[0] == '-' || StrVal[0] == '+') &&
981 (StrVal[1] >= '0' && StrVal[1] <= '9'))) {
982 // Reparse stringized version!
983 if (atof(StrVal.c_str()) == Val) {
988 // Otherwise we could not reparse it to exactly the same value, so we must
989 // output the string in hexadecimal format! Note that loading and storing
990 // floating point types changes the bits of NaNs on some hosts, notably
991 // x86, so we must not use these types.
992 assert(sizeof(double) == sizeof(uint64_t) &&
993 "assuming that double is 64 bits!");
995 APFloat apf = CFP->getValueAPF();
996 // Floats are represented in ASCII IR as double, convert.
998 apf.convert(APFloat::IEEEdouble, APFloat::rmNearestTiesToEven,
1001 utohex_buffer(uint64_t(apf.bitcastToAPInt().getZExtValue()),
1006 // Some form of long double. These appear as a magic letter identifying
1007 // the type, then a fixed number of hex digits.
1009 if (&CFP->getValueAPF().getSemantics() == &APFloat::x87DoubleExtended) {
1011 // api needed to prevent premature destruction
1012 APInt api = CFP->getValueAPF().bitcastToAPInt();
1013 const uint64_t* p = api.getRawData();
1014 uint64_t word = p[1];
1016 int width = api.getBitWidth();
1017 for (int j=0; j<width; j+=4, shiftcount-=4) {
1018 unsigned int nibble = (word>>shiftcount) & 15;
1020 Out << (unsigned char)(nibble + '0');
1022 Out << (unsigned char)(nibble - 10 + 'A');
1023 if (shiftcount == 0 && j+4 < width) {
1027 shiftcount = width-j-4;
1031 } else if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEquad)
1033 else if (&CFP->getValueAPF().getSemantics() == &APFloat::PPCDoubleDouble)
1036 llvm_unreachable("Unsupported floating point type");
1037 // api needed to prevent premature destruction
1038 APInt api = CFP->getValueAPF().bitcastToAPInt();
1039 const uint64_t* p = api.getRawData();
1042 int width = api.getBitWidth();
1043 for (int j=0; j<width; j+=4, shiftcount-=4) {
1044 unsigned int nibble = (word>>shiftcount) & 15;
1046 Out << (unsigned char)(nibble + '0');
1048 Out << (unsigned char)(nibble - 10 + 'A');
1049 if (shiftcount == 0 && j+4 < width) {
1053 shiftcount = width-j-4;
1059 if (isa<ConstantAggregateZero>(CV)) {
1060 Out << "zeroinitializer";
1064 if (const BlockAddress *BA = dyn_cast<BlockAddress>(CV)) {
1065 Out << "blockaddress(";
1066 WriteAsOperandInternal(Out, BA->getFunction(), &TypePrinter, Machine);
1068 if (BA->getBasicBlock())
1069 WriteAsOperandInternal(Out, BA->getBasicBlock(), &TypePrinter, Machine);
1076 if (const ConstantArray *CA = dyn_cast<ConstantArray>(CV)) {
1077 // As a special case, print the array as a string if it is an array of
1078 // i8 with ConstantInt values.
1080 const Type *ETy = CA->getType()->getElementType();
1081 if (CA->isString()) {
1083 PrintEscapedString(CA->getAsString(), Out);
1085 } else { // Cannot output in string format...
1087 if (CA->getNumOperands()) {
1088 TypePrinter.print(ETy, Out);
1090 WriteAsOperandInternal(Out, CA->getOperand(0),
1091 &TypePrinter, Machine);
1092 for (unsigned i = 1, e = CA->getNumOperands(); i != e; ++i) {
1094 TypePrinter.print(ETy, Out);
1096 WriteAsOperandInternal(Out, CA->getOperand(i), &TypePrinter, Machine);
1104 if (const ConstantStruct *CS = dyn_cast<ConstantStruct>(CV)) {
1105 if (CS->getType()->isPacked())
1108 unsigned N = CS->getNumOperands();
1111 TypePrinter.print(CS->getOperand(0)->getType(), Out);
1114 WriteAsOperandInternal(Out, CS->getOperand(0), &TypePrinter, Machine);
1116 for (unsigned i = 1; i < N; i++) {
1118 TypePrinter.print(CS->getOperand(i)->getType(), Out);
1121 WriteAsOperandInternal(Out, CS->getOperand(i), &TypePrinter, Machine);
1127 if (CS->getType()->isPacked())
1132 if (const ConstantVector *CP = dyn_cast<ConstantVector>(CV)) {
1133 const Type *ETy = CP->getType()->getElementType();
1134 assert(CP->getNumOperands() > 0 &&
1135 "Number of operands for a PackedConst must be > 0");
1137 TypePrinter.print(ETy, Out);
1139 WriteAsOperandInternal(Out, CP->getOperand(0), &TypePrinter, Machine);
1140 for (unsigned i = 1, e = CP->getNumOperands(); i != e; ++i) {
1142 TypePrinter.print(ETy, Out);
1144 WriteAsOperandInternal(Out, CP->getOperand(i), &TypePrinter, Machine);
1150 if (isa<ConstantPointerNull>(CV)) {
1155 if (isa<UndefValue>(CV)) {
1160 if (const MDNode *Node = dyn_cast<MDNode>(CV)) {
1161 Out << "!" << Machine->getMetadataSlot(Node);
1165 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV)) {
1166 Out << CE->getOpcodeName();
1167 WriteOptimizationInfo(Out, CE);
1168 if (CE->isCompare())
1169 Out << ' ' << getPredicateText(CE->getPredicate());
1172 for (User::const_op_iterator OI=CE->op_begin(); OI != CE->op_end(); ++OI) {
1173 TypePrinter.print((*OI)->getType(), Out);
1175 WriteAsOperandInternal(Out, *OI, &TypePrinter, Machine);
1176 if (OI+1 != CE->op_end())
1180 if (CE->hasIndices()) {
1181 const SmallVector<unsigned, 4> &Indices = CE->getIndices();
1182 for (unsigned i = 0, e = Indices.size(); i != e; ++i)
1183 Out << ", " << Indices[i];
1188 TypePrinter.print(CE->getType(), Out);
1195 Out << "<placeholder or erroneous Constant>";
1199 /// WriteAsOperand - Write the name of the specified value out to the specified
1200 /// ostream. This can be useful when you just want to print int %reg126, not
1201 /// the whole instruction that generated it.
1203 static void WriteAsOperandInternal(raw_ostream &Out, const Value *V,
1204 TypePrinting *TypePrinter,
1205 SlotTracker *Machine) {
1207 PrintLLVMName(Out, V);
1211 const Constant *CV = dyn_cast<Constant>(V);
1212 if (CV && !isa<GlobalValue>(CV)) {
1213 assert(TypePrinter && "Constants require TypePrinting!");
1214 WriteConstantInt(Out, CV, *TypePrinter, Machine);
1218 if (const InlineAsm *IA = dyn_cast<InlineAsm>(V)) {
1220 if (IA->hasSideEffects())
1221 Out << "sideeffect ";
1222 if (IA->isAlignStack())
1223 Out << "alignstack ";
1225 PrintEscapedString(IA->getAsmString(), Out);
1227 PrintEscapedString(IA->getConstraintString(), Out);
1232 if (const MDNode *N = dyn_cast<MDNode>(V)) {
1233 Out << '!' << Machine->getMetadataSlot(N);
1237 if (const MDString *MDS = dyn_cast<MDString>(V)) {
1239 PrintEscapedString(MDS->getString(), Out);
1244 if (V->getValueID() == Value::PseudoSourceValueVal) {
1252 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
1253 Slot = Machine->getGlobalSlot(GV);
1256 Slot = Machine->getLocalSlot(V);
1259 Machine = createSlotTracker(V);
1261 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
1262 Slot = Machine->getGlobalSlot(GV);
1265 Slot = Machine->getLocalSlot(V);
1274 Out << Prefix << Slot;
1279 void llvm::WriteAsOperand(raw_ostream &Out, const Value *V,
1280 bool PrintType, const Module *Context) {
1282 // Fast path: Don't construct and populate a TypePrinting object if we
1283 // won't be needing any types printed.
1285 (!isa<Constant>(V) || V->hasName() || isa<GlobalValue>(V))) {
1286 WriteAsOperandInternal(Out, V, 0, 0);
1290 if (Context == 0) Context = getModuleFromVal(V);
1292 TypePrinting TypePrinter;
1293 std::vector<const Type*> NumberedTypes;
1294 AddModuleTypesToPrinter(TypePrinter, NumberedTypes, Context);
1296 TypePrinter.print(V->getType(), Out);
1300 WriteAsOperandInternal(Out, V, &TypePrinter, 0);
1305 class AssemblyWriter {
1306 formatted_raw_ostream &Out;
1307 SlotTracker &Machine;
1308 const Module *TheModule;
1309 TypePrinting TypePrinter;
1310 AssemblyAnnotationWriter *AnnotationWriter;
1311 std::vector<const Type*> NumberedTypes;
1312 DenseMap<unsigned, StringRef> MDNames;
1315 inline AssemblyWriter(formatted_raw_ostream &o, SlotTracker &Mac,
1317 AssemblyAnnotationWriter *AAW)
1318 : Out(o), Machine(Mac), TheModule(M), AnnotationWriter(AAW) {
1319 AddModuleTypesToPrinter(TypePrinter, NumberedTypes, M);
1320 // FIXME: Provide MDPrinter
1322 MetadataContext &TheMetadata = M->getContext().getMetadata();
1323 SmallVector<std::pair<unsigned, StringRef>, 4> Names;
1324 TheMetadata.getHandlerNames(Names);
1325 for (SmallVector<std::pair<unsigned, StringRef>, 4>::iterator
1327 E = Names.end(); I != E; ++I) {
1328 MDNames[I->first] = I->second;
1333 void write(const Module *M) { printModule(M); }
1335 void write(const GlobalValue *G) {
1336 if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(G))
1338 else if (const GlobalAlias *GA = dyn_cast<GlobalAlias>(G))
1340 else if (const Function *F = dyn_cast<Function>(G))
1343 llvm_unreachable("Unknown global");
1346 void write(const BasicBlock *BB) { printBasicBlock(BB); }
1347 void write(const Instruction *I) { printInstruction(*I); }
1349 void writeOperand(const Value *Op, bool PrintType);
1350 void writeParamOperand(const Value *Operand, Attributes Attrs);
1353 void printModule(const Module *M);
1354 void printTypeSymbolTable(const TypeSymbolTable &ST);
1355 void printGlobal(const GlobalVariable *GV);
1356 void printAlias(const GlobalAlias *GV);
1357 void printFunction(const Function *F);
1358 void printArgument(const Argument *FA, Attributes Attrs);
1359 void printBasicBlock(const BasicBlock *BB);
1360 void printInstruction(const Instruction &I);
1362 // printInfoComment - Print a little comment after the instruction indicating
1363 // which slot it occupies.
1364 void printInfoComment(const Value &V);
1366 } // end of anonymous namespace
1369 void AssemblyWriter::writeOperand(const Value *Operand, bool PrintType) {
1371 Out << "<null operand!>";
1374 TypePrinter.print(Operand->getType(), Out);
1377 WriteAsOperandInternal(Out, Operand, &TypePrinter, &Machine);
1381 void AssemblyWriter::writeParamOperand(const Value *Operand,
1384 Out << "<null operand!>";
1387 TypePrinter.print(Operand->getType(), Out);
1388 // Print parameter attributes list
1389 if (Attrs != Attribute::None)
1390 Out << ' ' << Attribute::getAsString(Attrs);
1392 // Print the operand
1393 WriteAsOperandInternal(Out, Operand, &TypePrinter, &Machine);
1397 void AssemblyWriter::printModule(const Module *M) {
1398 if (!M->getModuleIdentifier().empty() &&
1399 // Don't print the ID if it will start a new line (which would
1400 // require a comment char before it).
1401 M->getModuleIdentifier().find('\n') == std::string::npos)
1402 Out << "; ModuleID = '" << M->getModuleIdentifier() << "'\n";
1404 if (!M->getDataLayout().empty())
1405 Out << "target datalayout = \"" << M->getDataLayout() << "\"\n";
1406 if (!M->getTargetTriple().empty())
1407 Out << "target triple = \"" << M->getTargetTriple() << "\"\n";
1409 if (!M->getModuleInlineAsm().empty()) {
1410 // Split the string into lines, to make it easier to read the .ll file.
1411 std::string Asm = M->getModuleInlineAsm();
1413 size_t NewLine = Asm.find_first_of('\n', CurPos);
1415 while (NewLine != std::string::npos) {
1416 // We found a newline, print the portion of the asm string from the
1417 // last newline up to this newline.
1418 Out << "module asm \"";
1419 PrintEscapedString(std::string(Asm.begin()+CurPos, Asm.begin()+NewLine),
1423 NewLine = Asm.find_first_of('\n', CurPos);
1425 Out << "module asm \"";
1426 PrintEscapedString(std::string(Asm.begin()+CurPos, Asm.end()), Out);
1430 // Loop over the dependent libraries and emit them.
1431 Module::lib_iterator LI = M->lib_begin();
1432 Module::lib_iterator LE = M->lib_end();
1435 Out << "deplibs = [ ";
1437 Out << '"' << *LI << '"';
1445 // Loop over the symbol table, emitting all id'd types.
1446 if (!M->getTypeSymbolTable().empty() || !NumberedTypes.empty()) Out << '\n';
1447 printTypeSymbolTable(M->getTypeSymbolTable());
1449 // Output all globals.
1450 if (!M->global_empty()) Out << '\n';
1451 for (Module::const_global_iterator I = M->global_begin(), E = M->global_end();
1455 // Output all aliases.
1456 if (!M->alias_empty()) Out << "\n";
1457 for (Module::const_alias_iterator I = M->alias_begin(), E = M->alias_end();
1461 // Output all of the functions.
1462 for (Module::const_iterator I = M->begin(), E = M->end(); I != E; ++I)
1465 // Output named metadata.
1466 if (!M->named_metadata_empty()) Out << '\n';
1467 for (Module::const_named_metadata_iterator I = M->named_metadata_begin(),
1468 E = M->named_metadata_end(); I != E; ++I) {
1469 const NamedMDNode *NMD = I;
1470 Out << "!" << NMD->getName() << " = !{";
1471 for (unsigned i = 0, e = NMD->getNumElements(); i != e; ++i) {
1473 MDNode *MD = dyn_cast_or_null<MDNode>(NMD->getElement(i));
1474 Out << '!' << Machine.getMetadataSlot(MD);
1480 if (!Machine.mdnEmpty()) Out << '\n';
1481 WriteMDNodes(Out, TypePrinter, Machine);
1484 static void PrintLinkage(GlobalValue::LinkageTypes LT,
1485 formatted_raw_ostream &Out) {
1487 case GlobalValue::ExternalLinkage: break;
1488 case GlobalValue::PrivateLinkage: Out << "private "; break;
1489 case GlobalValue::LinkerPrivateLinkage: Out << "linker_private "; break;
1490 case GlobalValue::InternalLinkage: Out << "internal "; break;
1491 case GlobalValue::LinkOnceAnyLinkage: Out << "linkonce "; break;
1492 case GlobalValue::LinkOnceODRLinkage: Out << "linkonce_odr "; break;
1493 case GlobalValue::WeakAnyLinkage: Out << "weak "; break;
1494 case GlobalValue::WeakODRLinkage: Out << "weak_odr "; break;
1495 case GlobalValue::CommonLinkage: Out << "common "; break;
1496 case GlobalValue::AppendingLinkage: Out << "appending "; break;
1497 case GlobalValue::DLLImportLinkage: Out << "dllimport "; break;
1498 case GlobalValue::DLLExportLinkage: Out << "dllexport "; break;
1499 case GlobalValue::ExternalWeakLinkage: Out << "extern_weak "; break;
1500 case GlobalValue::AvailableExternallyLinkage:
1501 Out << "available_externally ";
1503 case GlobalValue::GhostLinkage:
1504 llvm_unreachable("GhostLinkage not allowed in AsmWriter!");
1509 static void PrintVisibility(GlobalValue::VisibilityTypes Vis,
1510 formatted_raw_ostream &Out) {
1512 default: llvm_unreachable("Invalid visibility style!");
1513 case GlobalValue::DefaultVisibility: break;
1514 case GlobalValue::HiddenVisibility: Out << "hidden "; break;
1515 case GlobalValue::ProtectedVisibility: Out << "protected "; break;
1519 void AssemblyWriter::printGlobal(const GlobalVariable *GV) {
1520 WriteAsOperandInternal(Out, GV, &TypePrinter, &Machine);
1523 if (!GV->hasInitializer() && GV->hasExternalLinkage())
1526 PrintLinkage(GV->getLinkage(), Out);
1527 PrintVisibility(GV->getVisibility(), Out);
1529 if (GV->isThreadLocal()) Out << "thread_local ";
1530 if (unsigned AddressSpace = GV->getType()->getAddressSpace())
1531 Out << "addrspace(" << AddressSpace << ") ";
1532 Out << (GV->isConstant() ? "constant " : "global ");
1533 TypePrinter.print(GV->getType()->getElementType(), Out);
1535 if (GV->hasInitializer()) {
1537 writeOperand(GV->getInitializer(), false);
1540 if (GV->hasSection())
1541 Out << ", section \"" << GV->getSection() << '"';
1542 if (GV->getAlignment())
1543 Out << ", align " << GV->getAlignment();
1545 printInfoComment(*GV);
1549 void AssemblyWriter::printAlias(const GlobalAlias *GA) {
1550 // Don't crash when dumping partially built GA
1552 Out << "<<nameless>> = ";
1554 PrintLLVMName(Out, GA);
1557 PrintVisibility(GA->getVisibility(), Out);
1561 PrintLinkage(GA->getLinkage(), Out);
1563 const Constant *Aliasee = GA->getAliasee();
1565 if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(Aliasee)) {
1566 TypePrinter.print(GV->getType(), Out);
1568 PrintLLVMName(Out, GV);
1569 } else if (const Function *F = dyn_cast<Function>(Aliasee)) {
1570 TypePrinter.print(F->getFunctionType(), Out);
1573 WriteAsOperandInternal(Out, F, &TypePrinter, &Machine);
1574 } else if (const GlobalAlias *GA = dyn_cast<GlobalAlias>(Aliasee)) {
1575 TypePrinter.print(GA->getType(), Out);
1577 PrintLLVMName(Out, GA);
1579 const ConstantExpr *CE = cast<ConstantExpr>(Aliasee);
1580 // The only valid GEP is an all zero GEP.
1581 assert((CE->getOpcode() == Instruction::BitCast ||
1582 CE->getOpcode() == Instruction::GetElementPtr) &&
1583 "Unsupported aliasee");
1584 writeOperand(CE, false);
1587 printInfoComment(*GA);
1591 void AssemblyWriter::printTypeSymbolTable(const TypeSymbolTable &ST) {
1592 // Emit all numbered types.
1593 for (unsigned i = 0, e = NumberedTypes.size(); i != e; ++i) {
1594 Out << '%' << i << " = type ";
1596 // Make sure we print out at least one level of the type structure, so
1597 // that we do not get %2 = type %2
1598 TypePrinter.printAtLeastOneLevel(NumberedTypes[i], Out);
1602 // Print the named types.
1603 for (TypeSymbolTable::const_iterator TI = ST.begin(), TE = ST.end();
1605 PrintLLVMName(Out, TI->first, LocalPrefix);
1608 // Make sure we print out at least one level of the type structure, so
1609 // that we do not get %FILE = type %FILE
1610 TypePrinter.printAtLeastOneLevel(TI->second, Out);
1615 /// printFunction - Print all aspects of a function.
1617 void AssemblyWriter::printFunction(const Function *F) {
1618 // Print out the return type and name.
1621 if (AnnotationWriter) AnnotationWriter->emitFunctionAnnot(F, Out);
1623 if (F->isDeclaration())
1628 PrintLinkage(F->getLinkage(), Out);
1629 PrintVisibility(F->getVisibility(), Out);
1631 // Print the calling convention.
1632 switch (F->getCallingConv()) {
1633 case CallingConv::C: break; // default
1634 case CallingConv::Fast: Out << "fastcc "; break;
1635 case CallingConv::Cold: Out << "coldcc "; break;
1636 case CallingConv::X86_StdCall: Out << "x86_stdcallcc "; break;
1637 case CallingConv::X86_FastCall: Out << "x86_fastcallcc "; break;
1638 case CallingConv::ARM_APCS: Out << "arm_apcscc "; break;
1639 case CallingConv::ARM_AAPCS: Out << "arm_aapcscc "; break;
1640 case CallingConv::ARM_AAPCS_VFP:Out << "arm_aapcs_vfpcc "; break;
1641 default: Out << "cc" << F->getCallingConv() << " "; break;
1644 const FunctionType *FT = F->getFunctionType();
1645 const AttrListPtr &Attrs = F->getAttributes();
1646 Attributes RetAttrs = Attrs.getRetAttributes();
1647 if (RetAttrs != Attribute::None)
1648 Out << Attribute::getAsString(Attrs.getRetAttributes()) << ' ';
1649 TypePrinter.print(F->getReturnType(), Out);
1651 WriteAsOperandInternal(Out, F, &TypePrinter, &Machine);
1653 Machine.incorporateFunction(F);
1655 // Loop over the arguments, printing them...
1658 if (!F->isDeclaration()) {
1659 // If this isn't a declaration, print the argument names as well.
1660 for (Function::const_arg_iterator I = F->arg_begin(), E = F->arg_end();
1662 // Insert commas as we go... the first arg doesn't get a comma
1663 if (I != F->arg_begin()) Out << ", ";
1664 printArgument(I, Attrs.getParamAttributes(Idx));
1668 // Otherwise, print the types from the function type.
1669 for (unsigned i = 0, e = FT->getNumParams(); i != e; ++i) {
1670 // Insert commas as we go... the first arg doesn't get a comma
1674 TypePrinter.print(FT->getParamType(i), Out);
1676 Attributes ArgAttrs = Attrs.getParamAttributes(i+1);
1677 if (ArgAttrs != Attribute::None)
1678 Out << ' ' << Attribute::getAsString(ArgAttrs);
1682 // Finish printing arguments...
1683 if (FT->isVarArg()) {
1684 if (FT->getNumParams()) Out << ", ";
1685 Out << "..."; // Output varargs portion of signature!
1688 Attributes FnAttrs = Attrs.getFnAttributes();
1689 if (FnAttrs != Attribute::None)
1690 Out << ' ' << Attribute::getAsString(Attrs.getFnAttributes());
1691 if (F->hasSection())
1692 Out << " section \"" << F->getSection() << '"';
1693 if (F->getAlignment())
1694 Out << " align " << F->getAlignment();
1696 Out << " gc \"" << F->getGC() << '"';
1697 if (F->isDeclaration()) {
1702 // Output all of its basic blocks... for the function
1703 for (Function::const_iterator I = F->begin(), E = F->end(); I != E; ++I)
1709 Machine.purgeFunction();
1712 /// printArgument - This member is called for every argument that is passed into
1713 /// the function. Simply print it out
1715 void AssemblyWriter::printArgument(const Argument *Arg,
1718 TypePrinter.print(Arg->getType(), Out);
1720 // Output parameter attributes list
1721 if (Attrs != Attribute::None)
1722 Out << ' ' << Attribute::getAsString(Attrs);
1724 // Output name, if available...
1725 if (Arg->hasName()) {
1727 PrintLLVMName(Out, Arg);
1731 /// printBasicBlock - This member is called for each basic block in a method.
1733 void AssemblyWriter::printBasicBlock(const BasicBlock *BB) {
1734 if (BB->hasName()) { // Print out the label if it exists...
1736 PrintLLVMName(Out, BB->getName(), LabelPrefix);
1738 } else if (!BB->use_empty()) { // Don't print block # of no uses...
1739 Out << "\n; <label>:";
1740 int Slot = Machine.getLocalSlot(BB);
1747 if (BB->getParent() == 0) {
1748 Out.PadToColumn(50);
1749 Out << "; Error: Block without parent!";
1750 } else if (BB != &BB->getParent()->getEntryBlock()) { // Not the entry block?
1751 // Output predecessors for the block...
1752 Out.PadToColumn(50);
1754 pred_const_iterator PI = pred_begin(BB), PE = pred_end(BB);
1757 Out << " No predecessors!";
1760 writeOperand(*PI, false);
1761 for (++PI; PI != PE; ++PI) {
1763 writeOperand(*PI, false);
1770 if (AnnotationWriter) AnnotationWriter->emitBasicBlockStartAnnot(BB, Out);
1772 // Output all of the instructions in the basic block...
1773 for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I != E; ++I) {
1774 printInstruction(*I);
1778 if (AnnotationWriter) AnnotationWriter->emitBasicBlockEndAnnot(BB, Out);
1782 /// printInfoComment - Print a little comment after the instruction indicating
1783 /// which slot it occupies.
1785 void AssemblyWriter::printInfoComment(const Value &V) {
1786 if (V.getType() != Type::getVoidTy(V.getContext())) {
1787 Out.PadToColumn(50);
1789 TypePrinter.print(V.getType(), Out);
1790 Out << "> [#uses=" << V.getNumUses() << ']'; // Output # uses
1794 // This member is called for each Instruction in a function..
1795 void AssemblyWriter::printInstruction(const Instruction &I) {
1796 if (AnnotationWriter) AnnotationWriter->emitInstructionAnnot(&I, Out);
1798 // Print out indentation for an instruction.
1801 // Print out name if it exists...
1803 PrintLLVMName(Out, &I);
1805 } else if (I.getType() != Type::getVoidTy(I.getContext())) {
1806 // Print out the def slot taken.
1807 int SlotNum = Machine.getLocalSlot(&I);
1809 Out << "<badref> = ";
1811 Out << '%' << SlotNum << " = ";
1814 // If this is a volatile load or store, print out the volatile marker.
1815 if ((isa<LoadInst>(I) && cast<LoadInst>(I).isVolatile()) ||
1816 (isa<StoreInst>(I) && cast<StoreInst>(I).isVolatile())) {
1818 } else if (isa<CallInst>(I) && cast<CallInst>(I).isTailCall()) {
1819 // If this is a call, check if it's a tail call.
1823 // Print out the opcode...
1824 Out << I.getOpcodeName();
1826 // Print out optimization information.
1827 WriteOptimizationInfo(Out, &I);
1829 // Print out the compare instruction predicates
1830 if (const CmpInst *CI = dyn_cast<CmpInst>(&I))
1831 Out << ' ' << getPredicateText(CI->getPredicate());
1833 // Print out the type of the operands...
1834 const Value *Operand = I.getNumOperands() ? I.getOperand(0) : 0;
1836 // Special case conditional branches to swizzle the condition out to the front
1837 if (isa<BranchInst>(I) && cast<BranchInst>(I).isConditional()) {
1838 BranchInst &BI(cast<BranchInst>(I));
1840 writeOperand(BI.getCondition(), true);
1842 writeOperand(BI.getSuccessor(0), true);
1844 writeOperand(BI.getSuccessor(1), true);
1846 } else if (isa<SwitchInst>(I)) {
1847 // Special case switch instruction to get formatting nice and correct.
1849 writeOperand(Operand , true);
1851 writeOperand(I.getOperand(1), true);
1854 for (unsigned op = 2, Eop = I.getNumOperands(); op < Eop; op += 2) {
1856 writeOperand(I.getOperand(op ), true);
1858 writeOperand(I.getOperand(op+1), true);
1861 } else if (isa<IndirectBrInst>(I)) {
1862 // Special case indirectbr instruction to get formatting nice and correct.
1864 writeOperand(Operand, true);
1867 for (unsigned i = 1, e = I.getNumOperands(); i != e; ++i) {
1870 writeOperand(I.getOperand(i), true);
1873 } else if (isa<PHINode>(I)) {
1875 TypePrinter.print(I.getType(), Out);
1878 for (unsigned op = 0, Eop = I.getNumOperands(); op < Eop; op += 2) {
1879 if (op) Out << ", ";
1881 writeOperand(I.getOperand(op ), false); Out << ", ";
1882 writeOperand(I.getOperand(op+1), false); Out << " ]";
1884 } else if (const ExtractValueInst *EVI = dyn_cast<ExtractValueInst>(&I)) {
1886 writeOperand(I.getOperand(0), true);
1887 for (const unsigned *i = EVI->idx_begin(), *e = EVI->idx_end(); i != e; ++i)
1889 } else if (const InsertValueInst *IVI = dyn_cast<InsertValueInst>(&I)) {
1891 writeOperand(I.getOperand(0), true); Out << ", ";
1892 writeOperand(I.getOperand(1), true);
1893 for (const unsigned *i = IVI->idx_begin(), *e = IVI->idx_end(); i != e; ++i)
1895 } else if (isa<ReturnInst>(I) && !Operand) {
1897 } else if (const CallInst *CI = dyn_cast<CallInst>(&I)) {
1898 // Print the calling convention being used.
1899 switch (CI->getCallingConv()) {
1900 case CallingConv::C: break; // default
1901 case CallingConv::Fast: Out << " fastcc"; break;
1902 case CallingConv::Cold: Out << " coldcc"; break;
1903 case CallingConv::X86_StdCall: Out << " x86_stdcallcc"; break;
1904 case CallingConv::X86_FastCall: Out << " x86_fastcallcc"; break;
1905 case CallingConv::ARM_APCS: Out << " arm_apcscc "; break;
1906 case CallingConv::ARM_AAPCS: Out << " arm_aapcscc "; break;
1907 case CallingConv::ARM_AAPCS_VFP:Out << " arm_aapcs_vfpcc "; break;
1908 default: Out << " cc" << CI->getCallingConv(); break;
1911 const PointerType *PTy = cast<PointerType>(Operand->getType());
1912 const FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
1913 const Type *RetTy = FTy->getReturnType();
1914 const AttrListPtr &PAL = CI->getAttributes();
1916 if (PAL.getRetAttributes() != Attribute::None)
1917 Out << ' ' << Attribute::getAsString(PAL.getRetAttributes());
1919 // If possible, print out the short form of the call instruction. We can
1920 // only do this if the first argument is a pointer to a nonvararg function,
1921 // and if the return type is not a pointer to a function.
1924 if (!FTy->isVarArg() &&
1925 (!isa<PointerType>(RetTy) ||
1926 !isa<FunctionType>(cast<PointerType>(RetTy)->getElementType()))) {
1927 TypePrinter.print(RetTy, Out);
1929 writeOperand(Operand, false);
1931 writeOperand(Operand, true);
1934 for (unsigned op = 1, Eop = I.getNumOperands(); op < Eop; ++op) {
1937 writeParamOperand(I.getOperand(op), PAL.getParamAttributes(op));
1940 if (PAL.getFnAttributes() != Attribute::None)
1941 Out << ' ' << Attribute::getAsString(PAL.getFnAttributes());
1942 } else if (const InvokeInst *II = dyn_cast<InvokeInst>(&I)) {
1943 const PointerType *PTy = cast<PointerType>(Operand->getType());
1944 const FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
1945 const Type *RetTy = FTy->getReturnType();
1946 const AttrListPtr &PAL = II->getAttributes();
1948 // Print the calling convention being used.
1949 switch (II->getCallingConv()) {
1950 case CallingConv::C: break; // default
1951 case CallingConv::Fast: Out << " fastcc"; break;
1952 case CallingConv::Cold: Out << " coldcc"; break;
1953 case CallingConv::X86_StdCall: Out << " x86_stdcallcc"; break;
1954 case CallingConv::X86_FastCall: Out << " x86_fastcallcc"; break;
1955 case CallingConv::ARM_APCS: Out << " arm_apcscc "; break;
1956 case CallingConv::ARM_AAPCS: Out << " arm_aapcscc "; break;
1957 case CallingConv::ARM_AAPCS_VFP:Out << " arm_aapcs_vfpcc "; break;
1958 default: Out << " cc" << II->getCallingConv(); break;
1961 if (PAL.getRetAttributes() != Attribute::None)
1962 Out << ' ' << Attribute::getAsString(PAL.getRetAttributes());
1964 // If possible, print out the short form of the invoke instruction. We can
1965 // only do this if the first argument is a pointer to a nonvararg function,
1966 // and if the return type is not a pointer to a function.
1969 if (!FTy->isVarArg() &&
1970 (!isa<PointerType>(RetTy) ||
1971 !isa<FunctionType>(cast<PointerType>(RetTy)->getElementType()))) {
1972 TypePrinter.print(RetTy, Out);
1974 writeOperand(Operand, false);
1976 writeOperand(Operand, true);
1979 for (unsigned op = 3, Eop = I.getNumOperands(); op < Eop; ++op) {
1982 writeParamOperand(I.getOperand(op), PAL.getParamAttributes(op-2));
1986 if (PAL.getFnAttributes() != Attribute::None)
1987 Out << ' ' << Attribute::getAsString(PAL.getFnAttributes());
1990 writeOperand(II->getNormalDest(), true);
1992 writeOperand(II->getUnwindDest(), true);
1994 } else if (const AllocaInst *AI = dyn_cast<AllocaInst>(&I)) {
1996 TypePrinter.print(AI->getType()->getElementType(), Out);
1997 if (!AI->getArraySize() || AI->isArrayAllocation()) {
1999 writeOperand(AI->getArraySize(), true);
2001 if (AI->getAlignment()) {
2002 Out << ", align " << AI->getAlignment();
2004 } else if (isa<CastInst>(I)) {
2007 writeOperand(Operand, true); // Work with broken code
2010 TypePrinter.print(I.getType(), Out);
2011 } else if (isa<VAArgInst>(I)) {
2014 writeOperand(Operand, true); // Work with broken code
2017 TypePrinter.print(I.getType(), Out);
2018 } else if (Operand) { // Print the normal way.
2020 // PrintAllTypes - Instructions who have operands of all the same type
2021 // omit the type from all but the first operand. If the instruction has
2022 // different type operands (for example br), then they are all printed.
2023 bool PrintAllTypes = false;
2024 const Type *TheType = Operand->getType();
2026 // Select, Store and ShuffleVector always print all types.
2027 if (isa<SelectInst>(I) || isa<StoreInst>(I) || isa<ShuffleVectorInst>(I)
2028 || isa<ReturnInst>(I)) {
2029 PrintAllTypes = true;
2031 for (unsigned i = 1, E = I.getNumOperands(); i != E; ++i) {
2032 Operand = I.getOperand(i);
2033 // note that Operand shouldn't be null, but the test helps make dump()
2034 // more tolerant of malformed IR
2035 if (Operand && Operand->getType() != TheType) {
2036 PrintAllTypes = true; // We have differing types! Print them all!
2042 if (!PrintAllTypes) {
2044 TypePrinter.print(TheType, Out);
2048 for (unsigned i = 0, E = I.getNumOperands(); i != E; ++i) {
2050 writeOperand(I.getOperand(i), PrintAllTypes);
2054 // Print post operand alignment for load/store
2055 if (isa<LoadInst>(I) && cast<LoadInst>(I).getAlignment()) {
2056 Out << ", align " << cast<LoadInst>(I).getAlignment();
2057 } else if (isa<StoreInst>(I) && cast<StoreInst>(I).getAlignment()) {
2058 Out << ", align " << cast<StoreInst>(I).getAlignment();
2061 // Print Metadata info
2062 if (!MDNames.empty()) {
2063 MetadataContext &TheMetadata = I.getContext().getMetadata();
2064 typedef SmallVector<std::pair<unsigned, TrackingVH<MDNode> >, 2> MDMapTy;
2066 TheMetadata.getMDs(&I, MDs);
2067 for (MDMapTy::const_iterator MI = MDs.begin(), ME = MDs.end(); MI != ME;
2069 Out << ", !" << MDNames[MI->first]
2070 << " !" << Machine.getMetadataSlot(MI->second);
2072 printInfoComment(I);
2076 //===----------------------------------------------------------------------===//
2077 // External Interface declarations
2078 //===----------------------------------------------------------------------===//
2080 void Module::print(raw_ostream &ROS, AssemblyAnnotationWriter *AAW) const {
2081 SlotTracker SlotTable(this);
2082 formatted_raw_ostream OS(ROS);
2083 AssemblyWriter W(OS, SlotTable, this, AAW);
2087 void Type::print(raw_ostream &OS) const {
2089 OS << "<null Type>";
2092 TypePrinting().print(this, OS);
2095 void Value::print(raw_ostream &ROS, AssemblyAnnotationWriter *AAW) const {
2097 ROS << "printing a <null> value\n";
2100 formatted_raw_ostream OS(ROS);
2101 if (const Instruction *I = dyn_cast<Instruction>(this)) {
2102 const Function *F = I->getParent() ? I->getParent()->getParent() : 0;
2103 SlotTracker SlotTable(F);
2104 AssemblyWriter W(OS, SlotTable, F ? F->getParent() : 0, AAW);
2106 } else if (const BasicBlock *BB = dyn_cast<BasicBlock>(this)) {
2107 SlotTracker SlotTable(BB->getParent());
2108 AssemblyWriter W(OS, SlotTable,
2109 BB->getParent() ? BB->getParent()->getParent() : 0, AAW);
2111 } else if (const GlobalValue *GV = dyn_cast<GlobalValue>(this)) {
2112 SlotTracker SlotTable(GV->getParent());
2113 AssemblyWriter W(OS, SlotTable, GV->getParent(), AAW);
2115 } else if (const MDString *MDS = dyn_cast<MDString>(this)) {
2116 TypePrinting TypePrinter;
2117 TypePrinter.print(MDS->getType(), OS);
2120 PrintEscapedString(MDS->getString(), OS);
2122 } else if (const MDNode *N = dyn_cast<MDNode>(this)) {
2123 SlotTracker SlotTable(N);
2124 TypePrinting TypePrinter;
2125 SlotTable.initialize();
2126 WriteMDNodes(OS, TypePrinter, SlotTable);
2127 } else if (const NamedMDNode *N = dyn_cast<NamedMDNode>(this)) {
2128 SlotTracker SlotTable(N);
2129 TypePrinting TypePrinter;
2130 SlotTable.initialize();
2131 OS << "!" << N->getName() << " = !{";
2132 for (unsigned i = 0, e = N->getNumElements(); i != e; ++i) {
2134 MDNode *MD = dyn_cast_or_null<MDNode>(N->getElement(i));
2136 OS << '!' << SlotTable.getMetadataSlot(MD);
2141 WriteMDNodes(OS, TypePrinter, SlotTable);
2142 } else if (const Constant *C = dyn_cast<Constant>(this)) {
2143 TypePrinting TypePrinter;
2144 TypePrinter.print(C->getType(), OS);
2146 WriteConstantInt(OS, C, TypePrinter, 0);
2147 } else if (const Argument *A = dyn_cast<Argument>(this)) {
2148 WriteAsOperand(OS, this, true,
2149 A->getParent() ? A->getParent()->getParent() : 0);
2150 } else if (isa<InlineAsm>(this)) {
2151 WriteAsOperand(OS, this, true, 0);
2153 // Otherwise we don't know what it is. Call the virtual function to
2154 // allow a subclass to print itself.
2159 // Value::printCustom - subclasses should override this to implement printing.
2160 void Value::printCustom(raw_ostream &OS) const {
2161 llvm_unreachable("Unknown value to print out!");
2164 // Value::dump - allow easy printing of Values from the debugger.
2165 void Value::dump() const { print(errs()); errs() << '\n'; }
2167 // Type::dump - allow easy printing of Types from the debugger.
2168 // This one uses type names from the given context module
2169 void Type::dump(const Module *Context) const {
2170 WriteTypeSymbolic(errs(), this, Context);
2174 // Type::dump - allow easy printing of Types from the debugger.
2175 void Type::dump() const { dump(0); }
2177 // Module::dump() - Allow printing of Modules from the debugger.
2178 void Module::dump() const { print(errs(), 0); }