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/Operator.h"
27 #include "llvm/Metadata.h"
28 #include "llvm/Module.h"
29 #include "llvm/ValueSymbolTable.h"
30 #include "llvm/TypeSymbolTable.h"
31 #include "llvm/ADT/DenseSet.h"
32 #include "llvm/ADT/StringExtras.h"
33 #include "llvm/ADT/STLExtras.h"
34 #include "llvm/Support/CFG.h"
35 #include "llvm/Support/ErrorHandling.h"
36 #include "llvm/Support/MathExtras.h"
37 #include "llvm/Support/FormattedStream.h"
43 // Make virtual table appear in this compilation unit.
44 AssemblyAnnotationWriter::~AssemblyAnnotationWriter() {}
46 //===----------------------------------------------------------------------===//
48 //===----------------------------------------------------------------------===//
50 static const Module *getModuleFromVal(const Value *V) {
51 if (const Argument *MA = dyn_cast<Argument>(V))
52 return MA->getParent() ? MA->getParent()->getParent() : 0;
54 if (const BasicBlock *BB = dyn_cast<BasicBlock>(V))
55 return BB->getParent() ? BB->getParent()->getParent() : 0;
57 if (const Instruction *I = dyn_cast<Instruction>(V)) {
58 const Function *M = I->getParent() ? I->getParent()->getParent() : 0;
59 return M ? M->getParent() : 0;
62 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V))
63 return GV->getParent();
67 // PrintEscapedString - Print each character of the specified string, escaping
68 // it if it is not printable or if it is an escape char.
69 static void PrintEscapedString(const StringRef &Name,
71 for (unsigned i = 0, e = Name.size(); i != e; ++i) {
72 unsigned char C = Name[i];
73 if (isprint(C) && C != '\\' && C != '"')
76 Out << '\\' << hexdigit(C >> 4) << hexdigit(C & 0x0F);
87 /// PrintLLVMName - Turn the specified name into an 'LLVM name', which is either
88 /// prefixed with % (if the string only contains simple characters) or is
89 /// surrounded with ""'s (if it has special chars in it). Print it out.
90 static void PrintLLVMName(raw_ostream &OS, const StringRef &Name,
92 assert(Name.data() && "Cannot get empty name!");
94 default: llvm_unreachable("Bad prefix!");
96 case GlobalPrefix: OS << '@'; break;
97 case LabelPrefix: break;
98 case LocalPrefix: OS << '%'; break;
101 // Scan the name to see if it needs quotes first.
102 bool NeedsQuotes = isdigit(Name[0]);
104 for (unsigned i = 0, e = Name.size(); i != e; ++i) {
106 if (!isalnum(C) && C != '-' && C != '.' && C != '_') {
113 // If we didn't need any quotes, just write out the name in one blast.
119 // Okay, we need quotes. Output the quotes and escape any scary characters as
122 PrintEscapedString(Name, OS);
126 /// PrintLLVMName - Turn the specified name into an 'LLVM name', which is either
127 /// prefixed with % (if the string only contains simple characters) or is
128 /// surrounded with ""'s (if it has special chars in it). Print it out.
129 static void PrintLLVMName(raw_ostream &OS, const Value *V) {
130 PrintLLVMName(OS, V->getName(),
131 isa<GlobalValue>(V) ? GlobalPrefix : LocalPrefix);
134 //===----------------------------------------------------------------------===//
135 // TypePrinting Class: Type printing machinery
136 //===----------------------------------------------------------------------===//
138 static DenseMap<const Type *, std::string> &getTypeNamesMap(void *M) {
139 return *static_cast<DenseMap<const Type *, std::string>*>(M);
142 void TypePrinting::clear() {
143 getTypeNamesMap(TypeNames).clear();
146 bool TypePrinting::hasTypeName(const Type *Ty) const {
147 return getTypeNamesMap(TypeNames).count(Ty);
150 void TypePrinting::addTypeName(const Type *Ty, const std::string &N) {
151 getTypeNamesMap(TypeNames).insert(std::make_pair(Ty, N));
155 TypePrinting::TypePrinting() {
156 TypeNames = new DenseMap<const Type *, std::string>();
159 TypePrinting::~TypePrinting() {
160 delete &getTypeNamesMap(TypeNames);
163 /// CalcTypeName - Write the specified type to the specified raw_ostream, making
164 /// use of type names or up references to shorten the type name where possible.
165 void TypePrinting::CalcTypeName(const Type *Ty,
166 SmallVectorImpl<const Type *> &TypeStack,
167 raw_ostream &OS, bool IgnoreTopLevelName) {
168 // Check to see if the type is named.
169 if (!IgnoreTopLevelName) {
170 DenseMap<const Type *, std::string> &TM = getTypeNamesMap(TypeNames);
171 DenseMap<const Type *, std::string>::iterator I = TM.find(Ty);
178 // Check to see if the Type is already on the stack...
179 unsigned Slot = 0, CurSize = TypeStack.size();
180 while (Slot < CurSize && TypeStack[Slot] != Ty) ++Slot; // Scan for type
182 // This is another base case for the recursion. In this case, we know
183 // that we have looped back to a type that we have previously visited.
184 // Generate the appropriate upreference to handle this.
185 if (Slot < CurSize) {
186 OS << '\\' << unsigned(CurSize-Slot); // Here's the upreference
190 TypeStack.push_back(Ty); // Recursive case: Add us to the stack..
192 switch (Ty->getTypeID()) {
193 case Type::VoidTyID: OS << "void"; break;
194 case Type::FloatTyID: OS << "float"; break;
195 case Type::DoubleTyID: OS << "double"; break;
196 case Type::X86_FP80TyID: OS << "x86_fp80"; break;
197 case Type::FP128TyID: OS << "fp128"; break;
198 case Type::PPC_FP128TyID: OS << "ppc_fp128"; break;
199 case Type::LabelTyID: OS << "label"; break;
200 case Type::MetadataTyID: OS << "metadata"; break;
201 case Type::IntegerTyID:
202 OS << 'i' << cast<IntegerType>(Ty)->getBitWidth();
205 case Type::FunctionTyID: {
206 const FunctionType *FTy = cast<FunctionType>(Ty);
207 CalcTypeName(FTy->getReturnType(), TypeStack, OS);
209 for (FunctionType::param_iterator I = FTy->param_begin(),
210 E = FTy->param_end(); I != E; ++I) {
211 if (I != FTy->param_begin())
213 CalcTypeName(*I, TypeStack, OS);
215 if (FTy->isVarArg()) {
216 if (FTy->getNumParams()) OS << ", ";
222 case Type::StructTyID: {
223 const StructType *STy = cast<StructType>(Ty);
227 for (StructType::element_iterator I = STy->element_begin(),
228 E = STy->element_end(); I != E; ++I) {
229 CalcTypeName(*I, TypeStack, OS);
230 if (next(I) != STy->element_end())
239 case Type::PointerTyID: {
240 const PointerType *PTy = cast<PointerType>(Ty);
241 CalcTypeName(PTy->getElementType(), TypeStack, OS);
242 if (unsigned AddressSpace = PTy->getAddressSpace())
243 OS << " addrspace(" << AddressSpace << ')';
247 case Type::ArrayTyID: {
248 const ArrayType *ATy = cast<ArrayType>(Ty);
249 OS << '[' << ATy->getNumElements() << " x ";
250 CalcTypeName(ATy->getElementType(), TypeStack, OS);
254 case Type::VectorTyID: {
255 const VectorType *PTy = cast<VectorType>(Ty);
256 OS << "<" << PTy->getNumElements() << " x ";
257 CalcTypeName(PTy->getElementType(), TypeStack, OS);
261 case Type::OpaqueTyID:
265 OS << "<unrecognized-type>";
269 TypeStack.pop_back(); // Remove self from stack.
272 /// printTypeInt - The internal guts of printing out a type that has a
273 /// potentially named portion.
275 void TypePrinting::print(const Type *Ty, raw_ostream &OS,
276 bool IgnoreTopLevelName) {
277 // Check to see if the type is named.
278 DenseMap<const Type*, std::string> &TM = getTypeNamesMap(TypeNames);
279 if (!IgnoreTopLevelName) {
280 DenseMap<const Type*, std::string>::iterator I = TM.find(Ty);
287 // Otherwise we have a type that has not been named but is a derived type.
288 // Carefully recurse the type hierarchy to print out any contained symbolic
290 SmallVector<const Type *, 16> TypeStack;
291 std::string TypeName;
293 raw_string_ostream TypeOS(TypeName);
294 CalcTypeName(Ty, TypeStack, TypeOS, IgnoreTopLevelName);
297 // Cache type name for later use.
298 if (!IgnoreTopLevelName)
299 TM.insert(std::make_pair(Ty, TypeOS.str()));
304 // To avoid walking constant expressions multiple times and other IR
305 // objects, we keep several helper maps.
306 DenseSet<const Value*> VisitedConstants;
307 DenseSet<const Type*> VisitedTypes;
310 std::vector<const Type*> &NumberedTypes;
312 TypeFinder(TypePrinting &tp, std::vector<const Type*> &numberedTypes)
313 : TP(tp), NumberedTypes(numberedTypes) {}
315 void Run(const Module &M) {
316 // Get types from the type symbol table. This gets opaque types referened
317 // only through derived named types.
318 const TypeSymbolTable &ST = M.getTypeSymbolTable();
319 for (TypeSymbolTable::const_iterator TI = ST.begin(), E = ST.end();
321 IncorporateType(TI->second);
323 // Get types from global variables.
324 for (Module::const_global_iterator I = M.global_begin(),
325 E = M.global_end(); I != E; ++I) {
326 IncorporateType(I->getType());
327 if (I->hasInitializer())
328 IncorporateValue(I->getInitializer());
331 // Get types from aliases.
332 for (Module::const_alias_iterator I = M.alias_begin(),
333 E = M.alias_end(); I != E; ++I) {
334 IncorporateType(I->getType());
335 IncorporateValue(I->getAliasee());
338 // Get types from functions.
339 for (Module::const_iterator FI = M.begin(), E = M.end(); FI != E; ++FI) {
340 IncorporateType(FI->getType());
342 for (Function::const_iterator BB = FI->begin(), E = FI->end();
344 for (BasicBlock::const_iterator II = BB->begin(),
345 E = BB->end(); II != E; ++II) {
346 const Instruction &I = *II;
347 // Incorporate the type of the instruction and all its operands.
348 IncorporateType(I.getType());
349 for (User::const_op_iterator OI = I.op_begin(), OE = I.op_end();
351 IncorporateValue(*OI);
357 void IncorporateType(const Type *Ty) {
358 // Check to see if we're already visited this type.
359 if (!VisitedTypes.insert(Ty).second)
362 // If this is a structure or opaque type, add a name for the type.
363 if (((isa<StructType>(Ty) && cast<StructType>(Ty)->getNumElements())
364 || isa<OpaqueType>(Ty)) && !TP.hasTypeName(Ty)) {
365 TP.addTypeName(Ty, "%"+utostr(unsigned(NumberedTypes.size())));
366 NumberedTypes.push_back(Ty);
369 // Recursively walk all contained types.
370 for (Type::subtype_iterator I = Ty->subtype_begin(),
371 E = Ty->subtype_end(); I != E; ++I)
375 /// IncorporateValue - This method is used to walk operand lists finding
376 /// types hiding in constant expressions and other operands that won't be
377 /// walked in other ways. GlobalValues, basic blocks, instructions, and
378 /// inst operands are all explicitly enumerated.
379 void IncorporateValue(const Value *V) {
380 if (V == 0 || !isa<Constant>(V) || isa<GlobalValue>(V)) return;
383 if (!VisitedConstants.insert(V).second)
387 IncorporateType(V->getType());
389 // Look in operands for types.
390 const Constant *C = cast<Constant>(V);
391 for (Constant::const_op_iterator I = C->op_begin(),
392 E = C->op_end(); I != E;++I)
393 IncorporateValue(*I);
396 } // end anonymous namespace
399 /// AddModuleTypesToPrinter - Add all of the symbolic type names for types in
400 /// the specified module to the TypePrinter and all numbered types to it and the
401 /// NumberedTypes table.
402 static void AddModuleTypesToPrinter(TypePrinting &TP,
403 std::vector<const Type*> &NumberedTypes,
407 // If the module has a symbol table, take all global types and stuff their
408 // names into the TypeNames map.
409 const TypeSymbolTable &ST = M->getTypeSymbolTable();
410 for (TypeSymbolTable::const_iterator TI = ST.begin(), E = ST.end();
412 const Type *Ty = cast<Type>(TI->second);
414 // As a heuristic, don't insert pointer to primitive types, because
415 // they are used too often to have a single useful name.
416 if (const PointerType *PTy = dyn_cast<PointerType>(Ty)) {
417 const Type *PETy = PTy->getElementType();
418 if ((PETy->isPrimitiveType() || PETy->isInteger()) &&
419 !isa<OpaqueType>(PETy))
423 // Likewise don't insert primitives either.
424 if (Ty->isInteger() || Ty->isPrimitiveType())
427 // Get the name as a string and insert it into TypeNames.
429 raw_string_ostream NameROS(NameStr);
430 formatted_raw_ostream NameOS(NameROS);
431 PrintLLVMName(NameOS, TI->first, LocalPrefix);
433 TP.addTypeName(Ty, NameStr);
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 /// TheMDNode - The MDNode for which we are holding slot numbers.
477 const MDNode *TheMDNode;
479 /// TheNamedMDNode - The MDNode for which we are holding slot numbers.
480 const NamedMDNode *TheNamedMDNode;
482 /// mMap - The TypePlanes map for the module level data.
486 /// fMap - The TypePlanes map for the function level data.
490 /// mdnMap - Map for MDNodes.
494 /// Construct from a module
495 explicit SlotTracker(const Module *M);
496 /// Construct from a function, starting out in incorp state.
497 explicit SlotTracker(const Function *F);
498 /// Construct from a mdnode.
499 explicit SlotTracker(const MDNode *N);
500 /// Construct from a named mdnode.
501 explicit SlotTracker(const NamedMDNode *N);
503 /// Return the slot number of the specified value in it's type
504 /// plane. If something is not in the SlotTracker, return -1.
505 int getLocalSlot(const Value *V);
506 int getGlobalSlot(const GlobalValue *V);
507 int getMetadataSlot(const MDNode *N);
509 /// If you'd like to deal with a function instead of just a module, use
510 /// this method to get its data into the SlotTracker.
511 void incorporateFunction(const Function *F) {
513 FunctionProcessed = false;
516 /// After calling incorporateFunction, use this method to remove the
517 /// most recently incorporated function from the SlotTracker. This
518 /// will reset the state of the machine back to just the module contents.
519 void purgeFunction();
521 /// MDNode map iterators.
522 ValueMap::iterator mdnBegin() { return mdnMap.begin(); }
523 ValueMap::iterator mdnEnd() { return mdnMap.end(); }
524 unsigned mdnSize() const { return mdnMap.size(); }
525 bool mdnEmpty() const { return mdnMap.empty(); }
527 /// This function does the actual initialization.
528 inline void initialize();
530 // Implementation Details
532 /// CreateModuleSlot - Insert the specified GlobalValue* into the slot table.
533 void CreateModuleSlot(const GlobalValue *V);
535 /// CreateMetadataSlot - Insert the specified MDNode* into the slot table.
536 void CreateMetadataSlot(const MDNode *N);
538 /// CreateFunctionSlot - Insert the specified Value* into the slot table.
539 void CreateFunctionSlot(const Value *V);
541 /// Add all of the module level global variables (and their initializers)
542 /// and function declarations, but not the contents of those functions.
543 void processModule();
545 /// Add all of the functions arguments, basic blocks, and instructions.
546 void processFunction();
548 /// Add all MDNode operands.
549 void processMDNode();
551 /// Add all MDNode operands.
552 void processNamedMDNode();
554 SlotTracker(const SlotTracker &); // DO NOT IMPLEMENT
555 void operator=(const SlotTracker &); // DO NOT IMPLEMENT
558 } // end anonymous namespace
561 static SlotTracker *createSlotTracker(const Value *V) {
562 if (const Argument *FA = dyn_cast<Argument>(V))
563 return new SlotTracker(FA->getParent());
565 if (const Instruction *I = dyn_cast<Instruction>(V))
566 return new SlotTracker(I->getParent()->getParent());
568 if (const BasicBlock *BB = dyn_cast<BasicBlock>(V))
569 return new SlotTracker(BB->getParent());
571 if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(V))
572 return new SlotTracker(GV->getParent());
574 if (const GlobalAlias *GA = dyn_cast<GlobalAlias>(V))
575 return new SlotTracker(GA->getParent());
577 if (const Function *Func = dyn_cast<Function>(V))
578 return new SlotTracker(Func);
584 #define ST_DEBUG(X) errs() << X
589 // Module level constructor. Causes the contents of the Module (sans functions)
590 // to be added to the slot table.
591 SlotTracker::SlotTracker(const Module *M)
592 : TheModule(M), TheFunction(0), FunctionProcessed(false), TheMDNode(0),
593 TheNamedMDNode(0), mNext(0), fNext(0), mdnNext(0) {
596 // Function level constructor. Causes the contents of the Module and the one
597 // function provided to be added to the slot table.
598 SlotTracker::SlotTracker(const Function *F)
599 : TheModule(F ? F->getParent() : 0), TheFunction(F), FunctionProcessed(false),
600 TheMDNode(0), TheNamedMDNode(0), mNext(0), fNext(0), mdnNext(0) {
603 // Constructor to handle single MDNode.
604 SlotTracker::SlotTracker(const MDNode *C)
605 : TheModule(0), TheFunction(0), FunctionProcessed(false), TheMDNode(C),
606 TheNamedMDNode(0), mNext(0), fNext(0), mdnNext(0) {
609 // Constructor to handle single NamedMDNode.
610 SlotTracker::SlotTracker(const NamedMDNode *N)
611 : TheModule(0), TheFunction(0), FunctionProcessed(false), TheMDNode(0),
612 TheNamedMDNode(N), mNext(0), fNext(0), mdnNext(0) {
615 inline void SlotTracker::initialize() {
618 TheModule = 0; ///< Prevent re-processing next time we're called.
621 if (TheFunction && !FunctionProcessed)
628 processNamedMDNode();
631 // Iterate through all the global variables, functions, and global
632 // variable initializers and create slots for them.
633 void SlotTracker::processModule() {
634 ST_DEBUG("begin processModule!\n");
636 // Add all of the unnamed global variables to the value table.
637 for (Module::const_global_iterator I = TheModule->global_begin(),
638 E = TheModule->global_end(); I != E; ++I) {
641 if (I->hasInitializer()) {
642 if (MDNode *N = dyn_cast<MDNode>(I->getInitializer()))
643 CreateMetadataSlot(N);
647 // Add metadata used by named metadata.
648 for (Module::const_named_metadata_iterator
649 I = TheModule->named_metadata_begin(),
650 E = TheModule->named_metadata_end(); I != E; ++I) {
651 const NamedMDNode *NMD = I;
652 for (unsigned i = 0, e = NMD->getNumElements(); i != e; ++i) {
653 MDNode *MD = dyn_cast_or_null<MDNode>(NMD->getElement(i));
655 CreateMetadataSlot(MD);
659 // Add all the unnamed functions to the table.
660 for (Module::const_iterator I = TheModule->begin(), E = TheModule->end();
665 ST_DEBUG("end processModule!\n");
668 // Process the arguments, basic blocks, and instructions of a function.
669 void SlotTracker::processFunction() {
670 ST_DEBUG("begin processFunction!\n");
673 // Add all the function arguments with no names.
674 for(Function::const_arg_iterator AI = TheFunction->arg_begin(),
675 AE = TheFunction->arg_end(); AI != AE; ++AI)
677 CreateFunctionSlot(AI);
679 ST_DEBUG("Inserting Instructions:\n");
681 Metadata &TheMetadata = TheFunction->getContext().getMetadata();
683 // Add all of the basic blocks and instructions with no names.
684 for (Function::const_iterator BB = TheFunction->begin(),
685 E = TheFunction->end(); BB != E; ++BB) {
687 CreateFunctionSlot(BB);
688 for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I != E;
690 if (I->getType() != Type::getVoidTy(TheFunction->getContext()) &&
692 CreateFunctionSlot(I);
693 for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i)
694 if (MDNode *N = dyn_cast_or_null<MDNode>(I->getOperand(i)))
695 CreateMetadataSlot(N);
697 // Process metadata attached with this instruction.
698 const Metadata::MDMapTy *MDs = TheMetadata.getMDs(I);
700 for (Metadata::MDMapTy::const_iterator MI = MDs->begin(),
701 ME = MDs->end(); MI != ME; ++MI)
702 if (MDNode *MDN = dyn_cast_or_null<MDNode>(MI->second))
703 CreateMetadataSlot(MDN);
707 FunctionProcessed = true;
709 ST_DEBUG("end processFunction!\n");
712 /// processMDNode - Process TheMDNode.
713 void SlotTracker::processMDNode() {
714 ST_DEBUG("begin processMDNode!\n");
716 CreateMetadataSlot(TheMDNode);
718 ST_DEBUG("end processMDNode!\n");
721 /// processNamedMDNode - Process TheNamedMDNode.
722 void SlotTracker::processNamedMDNode() {
723 ST_DEBUG("begin processNamedMDNode!\n");
725 for (unsigned i = 0, e = TheNamedMDNode->getNumElements(); i != e; ++i) {
726 MDNode *MD = dyn_cast_or_null<MDNode>(TheNamedMDNode->getElement(i));
728 CreateMetadataSlot(MD);
731 ST_DEBUG("end processNamedMDNode!\n");
734 /// Clean up after incorporating a function. This is the only way to get out of
735 /// the function incorporation state that affects get*Slot/Create*Slot. Function
736 /// incorporation state is indicated by TheFunction != 0.
737 void SlotTracker::purgeFunction() {
738 ST_DEBUG("begin purgeFunction!\n");
739 fMap.clear(); // Simply discard the function level map
741 FunctionProcessed = false;
742 ST_DEBUG("end purgeFunction!\n");
745 /// getGlobalSlot - Get the slot number of a global value.
746 int SlotTracker::getGlobalSlot(const GlobalValue *V) {
747 // Check for uninitialized state and do lazy initialization.
750 // Find the type plane in the module map
751 ValueMap::iterator MI = mMap.find(V);
752 return MI == mMap.end() ? -1 : (int)MI->second;
755 /// getGlobalSlot - Get the slot number of a MDNode.
756 int SlotTracker::getMetadataSlot(const MDNode *N) {
757 // Check for uninitialized state and do lazy initialization.
760 // Find the type plane in the module map
761 ValueMap::iterator MI = mdnMap.find(N);
762 return MI == mdnMap.end() ? -1 : (int)MI->second;
766 /// getLocalSlot - Get the slot number for a value that is local to a function.
767 int SlotTracker::getLocalSlot(const Value *V) {
768 assert(!isa<Constant>(V) && "Can't get a constant or global slot with this!");
770 // Check for uninitialized state and do lazy initialization.
773 ValueMap::iterator FI = fMap.find(V);
774 return FI == fMap.end() ? -1 : (int)FI->second;
778 /// CreateModuleSlot - Insert the specified GlobalValue* into the slot table.
779 void SlotTracker::CreateModuleSlot(const GlobalValue *V) {
780 assert(V && "Can't insert a null Value into SlotTracker!");
781 assert(V->getType() != Type::getVoidTy(V->getContext()) &&
782 "Doesn't need a slot!");
783 assert(!V->hasName() && "Doesn't need a slot!");
785 unsigned DestSlot = mNext++;
788 ST_DEBUG(" Inserting value [" << V->getType() << "] = " << V << " slot=" <<
790 // G = Global, F = Function, A = Alias, o = other
791 ST_DEBUG((isa<GlobalVariable>(V) ? 'G' :
792 (isa<Function>(V) ? 'F' :
793 (isa<GlobalAlias>(V) ? 'A' : 'o'))) << "]\n");
796 /// CreateSlot - Create a new slot for the specified value if it has no name.
797 void SlotTracker::CreateFunctionSlot(const Value *V) {
798 assert(V->getType() != Type::getVoidTy(TheFunction->getContext()) &&
799 !V->hasName() && "Doesn't need a slot!");
801 unsigned DestSlot = fNext++;
804 // G = Global, F = Function, o = other
805 ST_DEBUG(" Inserting value [" << V->getType() << "] = " << V << " slot=" <<
806 DestSlot << " [o]\n");
809 /// CreateModuleSlot - Insert the specified MDNode* into the slot table.
810 void SlotTracker::CreateMetadataSlot(const MDNode *N) {
811 assert(N && "Can't insert a null Value into SlotTracker!");
813 ValueMap::iterator I = mdnMap.find(N);
814 if (I != mdnMap.end())
817 unsigned DestSlot = mdnNext++;
818 mdnMap[N] = DestSlot;
820 for (MDNode::const_elem_iterator MDI = N->elem_begin(),
821 MDE = N->elem_end(); MDI != MDE; ++MDI) {
822 const Value *TV = *MDI;
824 if (const MDNode *N2 = dyn_cast<MDNode>(TV))
825 CreateMetadataSlot(N2);
829 //===----------------------------------------------------------------------===//
830 // AsmWriter Implementation
831 //===----------------------------------------------------------------------===//
833 static void WriteAsOperandInternal(raw_ostream &Out, const Value *V,
834 TypePrinting *TypePrinter,
835 SlotTracker *Machine);
839 static const char *getPredicateText(unsigned predicate) {
840 const char * pred = "unknown";
842 case FCmpInst::FCMP_FALSE: pred = "false"; break;
843 case FCmpInst::FCMP_OEQ: pred = "oeq"; break;
844 case FCmpInst::FCMP_OGT: pred = "ogt"; break;
845 case FCmpInst::FCMP_OGE: pred = "oge"; break;
846 case FCmpInst::FCMP_OLT: pred = "olt"; break;
847 case FCmpInst::FCMP_OLE: pred = "ole"; break;
848 case FCmpInst::FCMP_ONE: pred = "one"; break;
849 case FCmpInst::FCMP_ORD: pred = "ord"; break;
850 case FCmpInst::FCMP_UNO: pred = "uno"; break;
851 case FCmpInst::FCMP_UEQ: pred = "ueq"; break;
852 case FCmpInst::FCMP_UGT: pred = "ugt"; break;
853 case FCmpInst::FCMP_UGE: pred = "uge"; break;
854 case FCmpInst::FCMP_ULT: pred = "ult"; break;
855 case FCmpInst::FCMP_ULE: pred = "ule"; break;
856 case FCmpInst::FCMP_UNE: pred = "une"; break;
857 case FCmpInst::FCMP_TRUE: pred = "true"; break;
858 case ICmpInst::ICMP_EQ: pred = "eq"; break;
859 case ICmpInst::ICMP_NE: pred = "ne"; break;
860 case ICmpInst::ICMP_SGT: pred = "sgt"; break;
861 case ICmpInst::ICMP_SGE: pred = "sge"; break;
862 case ICmpInst::ICMP_SLT: pred = "slt"; break;
863 case ICmpInst::ICMP_SLE: pred = "sle"; break;
864 case ICmpInst::ICMP_UGT: pred = "ugt"; break;
865 case ICmpInst::ICMP_UGE: pred = "uge"; break;
866 case ICmpInst::ICMP_ULT: pred = "ult"; break;
867 case ICmpInst::ICMP_ULE: pred = "ule"; break;
872 static void WriteMDNodes(formatted_raw_ostream &Out, TypePrinting &TypePrinter,
873 SlotTracker &Machine) {
874 SmallVector<const MDNode *, 16> Nodes;
875 Nodes.resize(Machine.mdnSize());
876 for (SlotTracker::ValueMap::iterator I =
877 Machine.mdnBegin(), E = Machine.mdnEnd(); I != E; ++I)
878 Nodes[I->second] = cast<MDNode>(I->first);
880 for (unsigned i = 0, e = Nodes.size(); i != e; ++i) {
881 Out << '!' << i << " = metadata ";
882 const MDNode *Node = Nodes[i];
884 for (MDNode::const_elem_iterator NI = Node->elem_begin(),
885 NE = Node->elem_end(); NI != NE;) {
886 const Value *V = *NI;
889 else if (const MDNode *N = dyn_cast<MDNode>(V)) {
891 Out << '!' << Machine.getMetadataSlot(N);
894 TypePrinter.print((*NI)->getType(), Out);
896 WriteAsOperandInternal(Out, *NI, &TypePrinter, &Machine);
905 static void WriteOptimizationInfo(raw_ostream &Out, const User *U) {
906 if (const OverflowingBinaryOperator *OBO =
907 dyn_cast<OverflowingBinaryOperator>(U)) {
908 if (OBO->hasNoUnsignedWrap())
910 if (OBO->hasNoSignedWrap())
912 } else if (const SDivOperator *Div = dyn_cast<SDivOperator>(U)) {
915 } else if (const GEPOperator *GEP = dyn_cast<GEPOperator>(U)) {
916 if (GEP->isInBounds())
921 static void WriteConstantInt(raw_ostream &Out, const Constant *CV,
922 TypePrinting &TypePrinter, SlotTracker *Machine) {
923 if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV)) {
924 if (CI->getType() == Type::getInt1Ty(CV->getContext())) {
925 Out << (CI->getZExtValue() ? "true" : "false");
928 Out << CI->getValue();
932 if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV)) {
933 if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEdouble ||
934 &CFP->getValueAPF().getSemantics() == &APFloat::IEEEsingle) {
935 // We would like to output the FP constant value in exponential notation,
936 // but we cannot do this if doing so will lose precision. Check here to
937 // make sure that we only output it in exponential format if we can parse
938 // the value back and get the same value.
941 bool isDouble = &CFP->getValueAPF().getSemantics()==&APFloat::IEEEdouble;
942 double Val = isDouble ? CFP->getValueAPF().convertToDouble() :
943 CFP->getValueAPF().convertToFloat();
944 std::string StrVal = ftostr(CFP->getValueAPF());
946 // Check to make sure that the stringized number is not some string like
947 // "Inf" or NaN, that atof will accept, but the lexer will not. Check
948 // that the string matches the "[-+]?[0-9]" regex.
950 if ((StrVal[0] >= '0' && StrVal[0] <= '9') ||
951 ((StrVal[0] == '-' || StrVal[0] == '+') &&
952 (StrVal[1] >= '0' && StrVal[1] <= '9'))) {
953 // Reparse stringized version!
954 if (atof(StrVal.c_str()) == Val) {
959 // Otherwise we could not reparse it to exactly the same value, so we must
960 // output the string in hexadecimal format! Note that loading and storing
961 // floating point types changes the bits of NaNs on some hosts, notably
962 // x86, so we must not use these types.
963 assert(sizeof(double) == sizeof(uint64_t) &&
964 "assuming that double is 64 bits!");
966 APFloat apf = CFP->getValueAPF();
967 // Floats are represented in ASCII IR as double, convert.
969 apf.convert(APFloat::IEEEdouble, APFloat::rmNearestTiesToEven,
972 utohex_buffer(uint64_t(apf.bitcastToAPInt().getZExtValue()),
977 // Some form of long double. These appear as a magic letter identifying
978 // the type, then a fixed number of hex digits.
980 if (&CFP->getValueAPF().getSemantics() == &APFloat::x87DoubleExtended) {
982 // api needed to prevent premature destruction
983 APInt api = CFP->getValueAPF().bitcastToAPInt();
984 const uint64_t* p = api.getRawData();
985 uint64_t word = p[1];
987 int width = api.getBitWidth();
988 for (int j=0; j<width; j+=4, shiftcount-=4) {
989 unsigned int nibble = (word>>shiftcount) & 15;
991 Out << (unsigned char)(nibble + '0');
993 Out << (unsigned char)(nibble - 10 + 'A');
994 if (shiftcount == 0 && j+4 < width) {
998 shiftcount = width-j-4;
1002 } else if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEquad)
1004 else if (&CFP->getValueAPF().getSemantics() == &APFloat::PPCDoubleDouble)
1007 llvm_unreachable("Unsupported floating point type");
1008 // api needed to prevent premature destruction
1009 APInt api = CFP->getValueAPF().bitcastToAPInt();
1010 const uint64_t* p = api.getRawData();
1013 int width = api.getBitWidth();
1014 for (int j=0; j<width; j+=4, shiftcount-=4) {
1015 unsigned int nibble = (word>>shiftcount) & 15;
1017 Out << (unsigned char)(nibble + '0');
1019 Out << (unsigned char)(nibble - 10 + 'A');
1020 if (shiftcount == 0 && j+4 < width) {
1024 shiftcount = width-j-4;
1030 if (isa<ConstantAggregateZero>(CV)) {
1031 Out << "zeroinitializer";
1035 if (const ConstantArray *CA = dyn_cast<ConstantArray>(CV)) {
1036 // As a special case, print the array as a string if it is an array of
1037 // i8 with ConstantInt values.
1039 const Type *ETy = CA->getType()->getElementType();
1040 if (CA->isString()) {
1042 PrintEscapedString(CA->getAsString(), Out);
1044 } else { // Cannot output in string format...
1046 if (CA->getNumOperands()) {
1047 TypePrinter.print(ETy, Out);
1049 WriteAsOperandInternal(Out, CA->getOperand(0),
1050 &TypePrinter, Machine);
1051 for (unsigned i = 1, e = CA->getNumOperands(); i != e; ++i) {
1053 TypePrinter.print(ETy, Out);
1055 WriteAsOperandInternal(Out, CA->getOperand(i), &TypePrinter, Machine);
1063 if (const ConstantStruct *CS = dyn_cast<ConstantStruct>(CV)) {
1064 if (CS->getType()->isPacked())
1067 unsigned N = CS->getNumOperands();
1070 TypePrinter.print(CS->getOperand(0)->getType(), Out);
1073 WriteAsOperandInternal(Out, CS->getOperand(0), &TypePrinter, Machine);
1075 for (unsigned i = 1; i < N; i++) {
1077 TypePrinter.print(CS->getOperand(i)->getType(), Out);
1080 WriteAsOperandInternal(Out, CS->getOperand(i), &TypePrinter, Machine);
1086 if (CS->getType()->isPacked())
1091 if (const ConstantVector *CP = dyn_cast<ConstantVector>(CV)) {
1092 const Type *ETy = CP->getType()->getElementType();
1093 assert(CP->getNumOperands() > 0 &&
1094 "Number of operands for a PackedConst must be > 0");
1096 TypePrinter.print(ETy, Out);
1098 WriteAsOperandInternal(Out, CP->getOperand(0), &TypePrinter, Machine);
1099 for (unsigned i = 1, e = CP->getNumOperands(); i != e; ++i) {
1101 TypePrinter.print(ETy, Out);
1103 WriteAsOperandInternal(Out, CP->getOperand(i), &TypePrinter, Machine);
1109 if (isa<ConstantPointerNull>(CV)) {
1114 if (isa<UndefValue>(CV)) {
1119 if (const MDNode *Node = dyn_cast<MDNode>(CV)) {
1120 Out << "!" << Machine->getMetadataSlot(Node);
1124 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV)) {
1125 Out << CE->getOpcodeName();
1126 WriteOptimizationInfo(Out, CE);
1127 if (CE->isCompare())
1128 Out << ' ' << getPredicateText(CE->getPredicate());
1131 for (User::const_op_iterator OI=CE->op_begin(); OI != CE->op_end(); ++OI) {
1132 TypePrinter.print((*OI)->getType(), Out);
1134 WriteAsOperandInternal(Out, *OI, &TypePrinter, Machine);
1135 if (OI+1 != CE->op_end())
1139 if (CE->hasIndices()) {
1140 const SmallVector<unsigned, 4> &Indices = CE->getIndices();
1141 for (unsigned i = 0, e = Indices.size(); i != e; ++i)
1142 Out << ", " << Indices[i];
1147 TypePrinter.print(CE->getType(), Out);
1154 Out << "<placeholder or erroneous Constant>";
1158 /// WriteAsOperand - Write the name of the specified value out to the specified
1159 /// ostream. This can be useful when you just want to print int %reg126, not
1160 /// the whole instruction that generated it.
1162 static void WriteAsOperandInternal(raw_ostream &Out, const Value *V,
1163 TypePrinting *TypePrinter,
1164 SlotTracker *Machine) {
1166 PrintLLVMName(Out, V);
1170 const Constant *CV = dyn_cast<Constant>(V);
1171 if (CV && !isa<GlobalValue>(CV)) {
1172 assert(TypePrinter && "Constants require TypePrinting!");
1173 WriteConstantInt(Out, CV, *TypePrinter, Machine);
1177 if (const InlineAsm *IA = dyn_cast<InlineAsm>(V)) {
1179 if (IA->hasSideEffects())
1180 Out << "sideeffect ";
1182 PrintEscapedString(IA->getAsmString(), Out);
1184 PrintEscapedString(IA->getConstraintString(), Out);
1189 if (const MDNode *N = dyn_cast<MDNode>(V)) {
1190 Out << '!' << Machine->getMetadataSlot(N);
1194 if (const MDString *MDS = dyn_cast<MDString>(V)) {
1196 PrintEscapedString(MDS->getString(), Out);
1201 if (V->getValueID() == Value::PseudoSourceValueVal) {
1209 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
1210 Slot = Machine->getGlobalSlot(GV);
1213 Slot = Machine->getLocalSlot(V);
1216 Machine = createSlotTracker(V);
1218 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
1219 Slot = Machine->getGlobalSlot(GV);
1222 Slot = Machine->getLocalSlot(V);
1231 Out << Prefix << Slot;
1236 void llvm::WriteAsOperand(raw_ostream &Out, const Value *V,
1237 bool PrintType, const Module *Context) {
1239 // Fast path: Don't construct and populate a TypePrinting object if we
1240 // won't be needing any types printed.
1242 (!isa<Constant>(V) || V->hasName() || isa<GlobalValue>(V))) {
1243 WriteAsOperandInternal(Out, V, 0, 0);
1247 if (Context == 0) Context = getModuleFromVal(V);
1249 TypePrinting TypePrinter;
1250 std::vector<const Type*> NumberedTypes;
1251 AddModuleTypesToPrinter(TypePrinter, NumberedTypes, Context);
1253 TypePrinter.print(V->getType(), Out);
1257 WriteAsOperandInternal(Out, V, &TypePrinter, 0);
1262 class AssemblyWriter {
1263 formatted_raw_ostream &Out;
1264 SlotTracker &Machine;
1265 const Module *TheModule;
1266 TypePrinting TypePrinter;
1267 AssemblyAnnotationWriter *AnnotationWriter;
1268 std::vector<const Type*> NumberedTypes;
1271 inline AssemblyWriter(formatted_raw_ostream &o, SlotTracker &Mac,
1273 AssemblyAnnotationWriter *AAW)
1274 : Out(o), Machine(Mac), TheModule(M), AnnotationWriter(AAW) {
1275 AddModuleTypesToPrinter(TypePrinter, NumberedTypes, M);
1278 void write(const Module *M) { printModule(M); }
1280 void write(const GlobalValue *G) {
1281 if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(G))
1283 else if (const GlobalAlias *GA = dyn_cast<GlobalAlias>(G))
1285 else if (const Function *F = dyn_cast<Function>(G))
1288 llvm_unreachable("Unknown global");
1291 void write(const BasicBlock *BB) { printBasicBlock(BB); }
1292 void write(const Instruction *I) { printInstruction(*I); }
1294 void writeOperand(const Value *Op, bool PrintType);
1295 void writeParamOperand(const Value *Operand, Attributes Attrs);
1298 void printModule(const Module *M);
1299 void printTypeSymbolTable(const TypeSymbolTable &ST);
1300 void printGlobal(const GlobalVariable *GV);
1301 void printAlias(const GlobalAlias *GV);
1302 void printFunction(const Function *F);
1303 void printArgument(const Argument *FA, Attributes Attrs);
1304 void printBasicBlock(const BasicBlock *BB);
1305 void printInstruction(const Instruction &I);
1307 // printInfoComment - Print a little comment after the instruction indicating
1308 // which slot it occupies.
1309 void printInfoComment(const Value &V);
1311 } // end of anonymous namespace
1314 void AssemblyWriter::writeOperand(const Value *Operand, bool PrintType) {
1316 Out << "<null operand!>";
1319 TypePrinter.print(Operand->getType(), Out);
1322 WriteAsOperandInternal(Out, Operand, &TypePrinter, &Machine);
1326 void AssemblyWriter::writeParamOperand(const Value *Operand,
1329 Out << "<null operand!>";
1332 TypePrinter.print(Operand->getType(), Out);
1333 // Print parameter attributes list
1334 if (Attrs != Attribute::None)
1335 Out << ' ' << Attribute::getAsString(Attrs);
1337 // Print the operand
1338 WriteAsOperandInternal(Out, Operand, &TypePrinter, &Machine);
1342 void AssemblyWriter::printModule(const Module *M) {
1343 if (!M->getModuleIdentifier().empty() &&
1344 // Don't print the ID if it will start a new line (which would
1345 // require a comment char before it).
1346 M->getModuleIdentifier().find('\n') == std::string::npos)
1347 Out << "; ModuleID = '" << M->getModuleIdentifier() << "'\n";
1349 if (!M->getDataLayout().empty())
1350 Out << "target datalayout = \"" << M->getDataLayout() << "\"\n";
1351 if (!M->getTargetTriple().empty())
1352 Out << "target triple = \"" << M->getTargetTriple() << "\"\n";
1354 if (!M->getModuleInlineAsm().empty()) {
1355 // Split the string into lines, to make it easier to read the .ll file.
1356 std::string Asm = M->getModuleInlineAsm();
1358 size_t NewLine = Asm.find_first_of('\n', CurPos);
1360 while (NewLine != std::string::npos) {
1361 // We found a newline, print the portion of the asm string from the
1362 // last newline up to this newline.
1363 Out << "module asm \"";
1364 PrintEscapedString(std::string(Asm.begin()+CurPos, Asm.begin()+NewLine),
1368 NewLine = Asm.find_first_of('\n', CurPos);
1370 Out << "module asm \"";
1371 PrintEscapedString(std::string(Asm.begin()+CurPos, Asm.end()), Out);
1375 // Loop over the dependent libraries and emit them.
1376 Module::lib_iterator LI = M->lib_begin();
1377 Module::lib_iterator LE = M->lib_end();
1380 Out << "deplibs = [ ";
1382 Out << '"' << *LI << '"';
1390 // Loop over the symbol table, emitting all id'd types.
1391 if (!M->getTypeSymbolTable().empty() || !NumberedTypes.empty()) Out << '\n';
1392 printTypeSymbolTable(M->getTypeSymbolTable());
1394 // Output all globals.
1395 if (!M->global_empty()) Out << '\n';
1396 for (Module::const_global_iterator I = M->global_begin(), E = M->global_end();
1400 // Output all aliases.
1401 if (!M->alias_empty()) Out << "\n";
1402 for (Module::const_alias_iterator I = M->alias_begin(), E = M->alias_end();
1406 // Output all of the functions.
1407 for (Module::const_iterator I = M->begin(), E = M->end(); I != E; ++I)
1410 // Output named metadata.
1411 if (!M->named_metadata_empty()) Out << '\n';
1412 for (Module::const_named_metadata_iterator I = M->named_metadata_begin(),
1413 E = M->named_metadata_end(); I != E; ++I) {
1414 const NamedMDNode *NMD = I;
1415 Out << "!" << NMD->getName() << " = !{";
1416 for (unsigned i = 0, e = NMD->getNumElements(); i != e; ++i) {
1418 MDNode *MD = dyn_cast_or_null<MDNode>(NMD->getElement(i));
1419 Out << '!' << Machine.getMetadataSlot(MD);
1425 if (!Machine.mdnEmpty()) Out << '\n';
1426 WriteMDNodes(Out, TypePrinter, Machine);
1429 static void PrintLinkage(GlobalValue::LinkageTypes LT,
1430 formatted_raw_ostream &Out) {
1432 case GlobalValue::ExternalLinkage: break;
1433 case GlobalValue::PrivateLinkage: Out << "private "; break;
1434 case GlobalValue::LinkerPrivateLinkage: Out << "linker_private "; break;
1435 case GlobalValue::InternalLinkage: Out << "internal "; break;
1436 case GlobalValue::LinkOnceAnyLinkage: Out << "linkonce "; break;
1437 case GlobalValue::LinkOnceODRLinkage: Out << "linkonce_odr "; break;
1438 case GlobalValue::WeakAnyLinkage: Out << "weak "; break;
1439 case GlobalValue::WeakODRLinkage: Out << "weak_odr "; break;
1440 case GlobalValue::CommonLinkage: Out << "common "; break;
1441 case GlobalValue::AppendingLinkage: Out << "appending "; break;
1442 case GlobalValue::DLLImportLinkage: Out << "dllimport "; break;
1443 case GlobalValue::DLLExportLinkage: Out << "dllexport "; break;
1444 case GlobalValue::ExternalWeakLinkage: Out << "extern_weak "; break;
1445 case GlobalValue::AvailableExternallyLinkage:
1446 Out << "available_externally ";
1448 case GlobalValue::GhostLinkage:
1449 llvm_unreachable("GhostLinkage not allowed in AsmWriter!");
1454 static void PrintVisibility(GlobalValue::VisibilityTypes Vis,
1455 formatted_raw_ostream &Out) {
1457 default: llvm_unreachable("Invalid visibility style!");
1458 case GlobalValue::DefaultVisibility: break;
1459 case GlobalValue::HiddenVisibility: Out << "hidden "; break;
1460 case GlobalValue::ProtectedVisibility: Out << "protected "; break;
1464 void AssemblyWriter::printGlobal(const GlobalVariable *GV) {
1465 WriteAsOperandInternal(Out, GV, &TypePrinter, &Machine);
1468 if (!GV->hasInitializer() && GV->hasExternalLinkage())
1471 PrintLinkage(GV->getLinkage(), Out);
1472 PrintVisibility(GV->getVisibility(), Out);
1474 if (GV->isThreadLocal()) Out << "thread_local ";
1475 if (unsigned AddressSpace = GV->getType()->getAddressSpace())
1476 Out << "addrspace(" << AddressSpace << ") ";
1477 Out << (GV->isConstant() ? "constant " : "global ");
1478 TypePrinter.print(GV->getType()->getElementType(), Out);
1480 if (GV->hasInitializer()) {
1482 writeOperand(GV->getInitializer(), false);
1485 if (GV->hasSection())
1486 Out << ", section \"" << GV->getSection() << '"';
1487 if (GV->getAlignment())
1488 Out << ", align " << GV->getAlignment();
1490 printInfoComment(*GV);
1494 void AssemblyWriter::printAlias(const GlobalAlias *GA) {
1495 // Don't crash when dumping partially built GA
1497 Out << "<<nameless>> = ";
1499 PrintLLVMName(Out, GA);
1502 PrintVisibility(GA->getVisibility(), Out);
1506 PrintLinkage(GA->getLinkage(), Out);
1508 const Constant *Aliasee = GA->getAliasee();
1510 if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(Aliasee)) {
1511 TypePrinter.print(GV->getType(), Out);
1513 PrintLLVMName(Out, GV);
1514 } else if (const Function *F = dyn_cast<Function>(Aliasee)) {
1515 TypePrinter.print(F->getFunctionType(), Out);
1518 WriteAsOperandInternal(Out, F, &TypePrinter, &Machine);
1519 } else if (const GlobalAlias *GA = dyn_cast<GlobalAlias>(Aliasee)) {
1520 TypePrinter.print(GA->getType(), Out);
1522 PrintLLVMName(Out, GA);
1524 const ConstantExpr *CE = cast<ConstantExpr>(Aliasee);
1525 // The only valid GEP is an all zero GEP.
1526 assert((CE->getOpcode() == Instruction::BitCast ||
1527 CE->getOpcode() == Instruction::GetElementPtr) &&
1528 "Unsupported aliasee");
1529 writeOperand(CE, false);
1532 printInfoComment(*GA);
1536 void AssemblyWriter::printTypeSymbolTable(const TypeSymbolTable &ST) {
1537 // Emit all numbered types.
1538 for (unsigned i = 0, e = NumberedTypes.size(); i != e; ++i) {
1539 Out << '%' << i << " = type ";
1541 // Make sure we print out at least one level of the type structure, so
1542 // that we do not get %2 = type %2
1543 TypePrinter.printAtLeastOneLevel(NumberedTypes[i], Out);
1547 // Print the named types.
1548 for (TypeSymbolTable::const_iterator TI = ST.begin(), TE = ST.end();
1550 PrintLLVMName(Out, TI->first, LocalPrefix);
1553 // Make sure we print out at least one level of the type structure, so
1554 // that we do not get %FILE = type %FILE
1555 TypePrinter.printAtLeastOneLevel(TI->second, Out);
1560 /// printFunction - Print all aspects of a function.
1562 void AssemblyWriter::printFunction(const Function *F) {
1563 // Print out the return type and name.
1566 if (AnnotationWriter) AnnotationWriter->emitFunctionAnnot(F, Out);
1568 if (F->isDeclaration())
1573 PrintLinkage(F->getLinkage(), Out);
1574 PrintVisibility(F->getVisibility(), Out);
1576 // Print the calling convention.
1577 switch (F->getCallingConv()) {
1578 case CallingConv::C: break; // default
1579 case CallingConv::Fast: Out << "fastcc "; break;
1580 case CallingConv::Cold: Out << "coldcc "; break;
1581 case CallingConv::X86_StdCall: Out << "x86_stdcallcc "; break;
1582 case CallingConv::X86_FastCall: Out << "x86_fastcallcc "; break;
1583 case CallingConv::ARM_APCS: Out << "arm_apcscc "; break;
1584 case CallingConv::ARM_AAPCS: Out << "arm_aapcscc "; break;
1585 case CallingConv::ARM_AAPCS_VFP:Out << "arm_aapcs_vfpcc "; break;
1586 default: Out << "cc" << F->getCallingConv() << " "; break;
1589 const FunctionType *FT = F->getFunctionType();
1590 const AttrListPtr &Attrs = F->getAttributes();
1591 Attributes RetAttrs = Attrs.getRetAttributes();
1592 if (RetAttrs != Attribute::None)
1593 Out << Attribute::getAsString(Attrs.getRetAttributes()) << ' ';
1594 TypePrinter.print(F->getReturnType(), Out);
1596 WriteAsOperandInternal(Out, F, &TypePrinter, &Machine);
1598 Machine.incorporateFunction(F);
1600 // Loop over the arguments, printing them...
1603 if (!F->isDeclaration()) {
1604 // If this isn't a declaration, print the argument names as well.
1605 for (Function::const_arg_iterator I = F->arg_begin(), E = F->arg_end();
1607 // Insert commas as we go... the first arg doesn't get a comma
1608 if (I != F->arg_begin()) Out << ", ";
1609 printArgument(I, Attrs.getParamAttributes(Idx));
1613 // Otherwise, print the types from the function type.
1614 for (unsigned i = 0, e = FT->getNumParams(); i != e; ++i) {
1615 // Insert commas as we go... the first arg doesn't get a comma
1619 TypePrinter.print(FT->getParamType(i), Out);
1621 Attributes ArgAttrs = Attrs.getParamAttributes(i+1);
1622 if (ArgAttrs != Attribute::None)
1623 Out << ' ' << Attribute::getAsString(ArgAttrs);
1627 // Finish printing arguments...
1628 if (FT->isVarArg()) {
1629 if (FT->getNumParams()) Out << ", ";
1630 Out << "..."; // Output varargs portion of signature!
1633 Attributes FnAttrs = Attrs.getFnAttributes();
1634 if (FnAttrs != Attribute::None)
1635 Out << ' ' << Attribute::getAsString(Attrs.getFnAttributes());
1636 if (F->hasSection())
1637 Out << " section \"" << F->getSection() << '"';
1638 if (F->getAlignment())
1639 Out << " align " << F->getAlignment();
1641 Out << " gc \"" << F->getGC() << '"';
1642 if (F->isDeclaration()) {
1647 // Output all of its basic blocks... for the function
1648 for (Function::const_iterator I = F->begin(), E = F->end(); I != E; ++I)
1654 Machine.purgeFunction();
1657 /// printArgument - This member is called for every argument that is passed into
1658 /// the function. Simply print it out
1660 void AssemblyWriter::printArgument(const Argument *Arg,
1663 TypePrinter.print(Arg->getType(), Out);
1665 // Output parameter attributes list
1666 if (Attrs != Attribute::None)
1667 Out << ' ' << Attribute::getAsString(Attrs);
1669 // Output name, if available...
1670 if (Arg->hasName()) {
1672 PrintLLVMName(Out, Arg);
1676 /// printBasicBlock - This member is called for each basic block in a method.
1678 void AssemblyWriter::printBasicBlock(const BasicBlock *BB) {
1679 if (BB->hasName()) { // Print out the label if it exists...
1681 PrintLLVMName(Out, BB->getName(), LabelPrefix);
1683 } else if (!BB->use_empty()) { // Don't print block # of no uses...
1684 Out << "\n; <label>:";
1685 int Slot = Machine.getLocalSlot(BB);
1692 if (BB->getParent() == 0) {
1693 Out.PadToColumn(50);
1694 Out << "; Error: Block without parent!";
1695 } else if (BB != &BB->getParent()->getEntryBlock()) { // Not the entry block?
1696 // Output predecessors for the block...
1697 Out.PadToColumn(50);
1699 pred_const_iterator PI = pred_begin(BB), PE = pred_end(BB);
1702 Out << " No predecessors!";
1705 writeOperand(*PI, false);
1706 for (++PI; PI != PE; ++PI) {
1708 writeOperand(*PI, false);
1715 if (AnnotationWriter) AnnotationWriter->emitBasicBlockStartAnnot(BB, Out);
1717 // Output all of the instructions in the basic block...
1718 for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I != E; ++I) {
1719 printInstruction(*I);
1723 if (AnnotationWriter) AnnotationWriter->emitBasicBlockEndAnnot(BB, Out);
1727 /// printInfoComment - Print a little comment after the instruction indicating
1728 /// which slot it occupies.
1730 void AssemblyWriter::printInfoComment(const Value &V) {
1731 if (V.getType() != Type::getVoidTy(V.getContext())) {
1732 Out.PadToColumn(50);
1734 TypePrinter.print(V.getType(), Out);
1735 Out << "> [#uses=" << V.getNumUses() << ']'; // Output # uses
1739 // This member is called for each Instruction in a function..
1740 void AssemblyWriter::printInstruction(const Instruction &I) {
1741 if (AnnotationWriter) AnnotationWriter->emitInstructionAnnot(&I, Out);
1743 // Print out indentation for an instruction.
1746 // Print out name if it exists...
1748 PrintLLVMName(Out, &I);
1750 } else if (I.getType() != Type::getVoidTy(I.getContext())) {
1751 // Print out the def slot taken.
1752 int SlotNum = Machine.getLocalSlot(&I);
1754 Out << "<badref> = ";
1756 Out << '%' << SlotNum << " = ";
1759 // If this is a volatile load or store, print out the volatile marker.
1760 if ((isa<LoadInst>(I) && cast<LoadInst>(I).isVolatile()) ||
1761 (isa<StoreInst>(I) && cast<StoreInst>(I).isVolatile())) {
1763 } else if (isa<CallInst>(I) && cast<CallInst>(I).isTailCall()) {
1764 // If this is a call, check if it's a tail call.
1768 // Print out the opcode...
1769 Out << I.getOpcodeName();
1771 // Print out optimization information.
1772 WriteOptimizationInfo(Out, &I);
1774 // Print out the compare instruction predicates
1775 if (const CmpInst *CI = dyn_cast<CmpInst>(&I))
1776 Out << ' ' << getPredicateText(CI->getPredicate());
1778 // Print out the type of the operands...
1779 const Value *Operand = I.getNumOperands() ? I.getOperand(0) : 0;
1781 // Special case conditional branches to swizzle the condition out to the front
1782 if (isa<BranchInst>(I) && cast<BranchInst>(I).isConditional()) {
1783 BranchInst &BI(cast<BranchInst>(I));
1785 writeOperand(BI.getCondition(), true);
1787 writeOperand(BI.getSuccessor(0), true);
1789 writeOperand(BI.getSuccessor(1), true);
1791 } else if (isa<SwitchInst>(I)) {
1792 // Special case switch statement to get formatting nice and correct...
1794 writeOperand(Operand , true);
1796 writeOperand(I.getOperand(1), true);
1799 for (unsigned op = 2, Eop = I.getNumOperands(); op < Eop; op += 2) {
1801 writeOperand(I.getOperand(op ), true);
1803 writeOperand(I.getOperand(op+1), true);
1806 } else if (isa<PHINode>(I)) {
1808 TypePrinter.print(I.getType(), Out);
1811 for (unsigned op = 0, Eop = I.getNumOperands(); op < Eop; op += 2) {
1812 if (op) Out << ", ";
1814 writeOperand(I.getOperand(op ), false); Out << ", ";
1815 writeOperand(I.getOperand(op+1), false); Out << " ]";
1817 } else if (const ExtractValueInst *EVI = dyn_cast<ExtractValueInst>(&I)) {
1819 writeOperand(I.getOperand(0), true);
1820 for (const unsigned *i = EVI->idx_begin(), *e = EVI->idx_end(); i != e; ++i)
1822 } else if (const InsertValueInst *IVI = dyn_cast<InsertValueInst>(&I)) {
1824 writeOperand(I.getOperand(0), true); Out << ", ";
1825 writeOperand(I.getOperand(1), true);
1826 for (const unsigned *i = IVI->idx_begin(), *e = IVI->idx_end(); i != e; ++i)
1828 } else if (isa<ReturnInst>(I) && !Operand) {
1830 } else if (const CallInst *CI = dyn_cast<CallInst>(&I)) {
1831 // Print the calling convention being used.
1832 switch (CI->getCallingConv()) {
1833 case CallingConv::C: break; // default
1834 case CallingConv::Fast: Out << " fastcc"; break;
1835 case CallingConv::Cold: Out << " coldcc"; break;
1836 case CallingConv::X86_StdCall: Out << " x86_stdcallcc"; break;
1837 case CallingConv::X86_FastCall: Out << " x86_fastcallcc"; break;
1838 case CallingConv::ARM_APCS: Out << " arm_apcscc "; break;
1839 case CallingConv::ARM_AAPCS: Out << " arm_aapcscc "; break;
1840 case CallingConv::ARM_AAPCS_VFP:Out << " arm_aapcs_vfpcc "; break;
1841 default: Out << " cc" << CI->getCallingConv(); break;
1844 const PointerType *PTy = cast<PointerType>(Operand->getType());
1845 const FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
1846 const Type *RetTy = FTy->getReturnType();
1847 const AttrListPtr &PAL = CI->getAttributes();
1849 if (PAL.getRetAttributes() != Attribute::None)
1850 Out << ' ' << Attribute::getAsString(PAL.getRetAttributes());
1852 // If possible, print out the short form of the call instruction. We can
1853 // only do this if the first argument is a pointer to a nonvararg function,
1854 // and if the return type is not a pointer to a function.
1857 if (!FTy->isVarArg() &&
1858 (!isa<PointerType>(RetTy) ||
1859 !isa<FunctionType>(cast<PointerType>(RetTy)->getElementType()))) {
1860 TypePrinter.print(RetTy, Out);
1862 writeOperand(Operand, false);
1864 writeOperand(Operand, true);
1867 for (unsigned op = 1, Eop = I.getNumOperands(); op < Eop; ++op) {
1870 writeParamOperand(I.getOperand(op), PAL.getParamAttributes(op));
1873 if (PAL.getFnAttributes() != Attribute::None)
1874 Out << ' ' << Attribute::getAsString(PAL.getFnAttributes());
1875 } else if (const InvokeInst *II = dyn_cast<InvokeInst>(&I)) {
1876 const PointerType *PTy = cast<PointerType>(Operand->getType());
1877 const FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
1878 const Type *RetTy = FTy->getReturnType();
1879 const AttrListPtr &PAL = II->getAttributes();
1881 // Print the calling convention being used.
1882 switch (II->getCallingConv()) {
1883 case CallingConv::C: break; // default
1884 case CallingConv::Fast: Out << " fastcc"; break;
1885 case CallingConv::Cold: Out << " coldcc"; break;
1886 case CallingConv::X86_StdCall: Out << " x86_stdcallcc"; break;
1887 case CallingConv::X86_FastCall: Out << " x86_fastcallcc"; break;
1888 case CallingConv::ARM_APCS: Out << " arm_apcscc "; break;
1889 case CallingConv::ARM_AAPCS: Out << " arm_aapcscc "; break;
1890 case CallingConv::ARM_AAPCS_VFP:Out << " arm_aapcs_vfpcc "; break;
1891 default: Out << " cc" << II->getCallingConv(); break;
1894 if (PAL.getRetAttributes() != Attribute::None)
1895 Out << ' ' << Attribute::getAsString(PAL.getRetAttributes());
1897 // If possible, print out the short form of the invoke instruction. We can
1898 // only do this if the first argument is a pointer to a nonvararg function,
1899 // and if the return type is not a pointer to a function.
1902 if (!FTy->isVarArg() &&
1903 (!isa<PointerType>(RetTy) ||
1904 !isa<FunctionType>(cast<PointerType>(RetTy)->getElementType()))) {
1905 TypePrinter.print(RetTy, Out);
1907 writeOperand(Operand, false);
1909 writeOperand(Operand, true);
1912 for (unsigned op = 3, Eop = I.getNumOperands(); op < Eop; ++op) {
1915 writeParamOperand(I.getOperand(op), PAL.getParamAttributes(op-2));
1919 if (PAL.getFnAttributes() != Attribute::None)
1920 Out << ' ' << Attribute::getAsString(PAL.getFnAttributes());
1923 writeOperand(II->getNormalDest(), true);
1925 writeOperand(II->getUnwindDest(), true);
1927 } else if (const AllocationInst *AI = dyn_cast<AllocationInst>(&I)) {
1929 TypePrinter.print(AI->getType()->getElementType(), Out);
1930 if (!AI->getArraySize() || AI->isArrayAllocation()) {
1932 writeOperand(AI->getArraySize(), true);
1934 if (AI->getAlignment()) {
1935 Out << ", align " << AI->getAlignment();
1937 } else if (isa<CastInst>(I)) {
1940 writeOperand(Operand, true); // Work with broken code
1943 TypePrinter.print(I.getType(), Out);
1944 } else if (isa<VAArgInst>(I)) {
1947 writeOperand(Operand, true); // Work with broken code
1950 TypePrinter.print(I.getType(), Out);
1951 } else if (Operand) { // Print the normal way.
1953 // PrintAllTypes - Instructions who have operands of all the same type
1954 // omit the type from all but the first operand. If the instruction has
1955 // different type operands (for example br), then they are all printed.
1956 bool PrintAllTypes = false;
1957 const Type *TheType = Operand->getType();
1959 // Select, Store and ShuffleVector always print all types.
1960 if (isa<SelectInst>(I) || isa<StoreInst>(I) || isa<ShuffleVectorInst>(I)
1961 || isa<ReturnInst>(I)) {
1962 PrintAllTypes = true;
1964 for (unsigned i = 1, E = I.getNumOperands(); i != E; ++i) {
1965 Operand = I.getOperand(i);
1966 // note that Operand shouldn't be null, but the test helps make dump()
1967 // more tolerant of malformed IR
1968 if (Operand && Operand->getType() != TheType) {
1969 PrintAllTypes = true; // We have differing types! Print them all!
1975 if (!PrintAllTypes) {
1977 TypePrinter.print(TheType, Out);
1981 for (unsigned i = 0, E = I.getNumOperands(); i != E; ++i) {
1983 writeOperand(I.getOperand(i), PrintAllTypes);
1987 // Print post operand alignment for load/store
1988 if (isa<LoadInst>(I) && cast<LoadInst>(I).getAlignment()) {
1989 Out << ", align " << cast<LoadInst>(I).getAlignment();
1990 } else if (isa<StoreInst>(I) && cast<StoreInst>(I).getAlignment()) {
1991 Out << ", align " << cast<StoreInst>(I).getAlignment();
1995 Metadata &TheMetadata = I.getContext().getMetadata();
1996 unsigned MDDbgKind = TheMetadata.getMDKind("dbg");
1997 if (const MDNode *Dbg = TheMetadata.getMD(MDDbgKind, &I))
1998 Out << ", dbg !" << Machine.getMetadataSlot(Dbg);
1999 printInfoComment(I);
2003 //===----------------------------------------------------------------------===//
2004 // External Interface declarations
2005 //===----------------------------------------------------------------------===//
2007 void Module::print(raw_ostream &ROS, AssemblyAnnotationWriter *AAW) const {
2008 SlotTracker SlotTable(this);
2009 formatted_raw_ostream OS(ROS);
2010 AssemblyWriter W(OS, SlotTable, this, AAW);
2014 void Type::print(raw_ostream &OS) const {
2016 OS << "<null Type>";
2019 TypePrinting().print(this, OS);
2022 void Value::print(raw_ostream &ROS, AssemblyAnnotationWriter *AAW) const {
2024 ROS << "printing a <null> value\n";
2027 formatted_raw_ostream OS(ROS);
2028 if (const Instruction *I = dyn_cast<Instruction>(this)) {
2029 const Function *F = I->getParent() ? I->getParent()->getParent() : 0;
2030 SlotTracker SlotTable(F);
2031 AssemblyWriter W(OS, SlotTable, F ? F->getParent() : 0, AAW);
2033 } else if (const BasicBlock *BB = dyn_cast<BasicBlock>(this)) {
2034 SlotTracker SlotTable(BB->getParent());
2035 AssemblyWriter W(OS, SlotTable,
2036 BB->getParent() ? BB->getParent()->getParent() : 0, AAW);
2038 } else if (const GlobalValue *GV = dyn_cast<GlobalValue>(this)) {
2039 SlotTracker SlotTable(GV->getParent());
2040 AssemblyWriter W(OS, SlotTable, GV->getParent(), AAW);
2042 } else if (const MDString *MDS = dyn_cast<MDString>(this)) {
2043 TypePrinting TypePrinter;
2044 TypePrinter.print(MDS->getType(), OS);
2047 PrintEscapedString(MDS->getString(), OS);
2049 } else if (const MDNode *N = dyn_cast<MDNode>(this)) {
2050 SlotTracker SlotTable(N);
2051 TypePrinting TypePrinter;
2052 SlotTable.initialize();
2053 WriteMDNodes(OS, TypePrinter, SlotTable);
2054 } else if (const NamedMDNode *N = dyn_cast<NamedMDNode>(this)) {
2055 SlotTracker SlotTable(N);
2056 TypePrinting TypePrinter;
2057 SlotTable.initialize();
2058 OS << "!" << N->getName() << " = !{";
2059 for (unsigned i = 0, e = N->getNumElements(); i != e; ++i) {
2061 MDNode *MD = dyn_cast_or_null<MDNode>(N->getElement(i));
2063 OS << '!' << SlotTable.getMetadataSlot(MD);
2068 WriteMDNodes(OS, TypePrinter, SlotTable);
2069 } else if (const Constant *C = dyn_cast<Constant>(this)) {
2070 TypePrinting TypePrinter;
2071 TypePrinter.print(C->getType(), OS);
2073 WriteConstantInt(OS, C, TypePrinter, 0);
2074 } else if (const Argument *A = dyn_cast<Argument>(this)) {
2075 WriteAsOperand(OS, this, true,
2076 A->getParent() ? A->getParent()->getParent() : 0);
2077 } else if (isa<InlineAsm>(this)) {
2078 WriteAsOperand(OS, this, true, 0);
2080 // Otherwise we don't know what it is. Call the virtual function to
2081 // allow a subclass to print itself.
2086 // Value::printCustom - subclasses should override this to implement printing.
2087 void Value::printCustom(raw_ostream &OS) const {
2088 llvm_unreachable("Unknown value to print out!");
2091 // Value::dump - allow easy printing of Values from the debugger.
2092 void Value::dump() const { print(errs()); errs() << '\n'; }
2094 // Type::dump - allow easy printing of Types from the debugger.
2095 // This one uses type names from the given context module
2096 void Type::dump(const Module *Context) const {
2097 WriteTypeSymbolic(errs(), this, Context);
2101 // Type::dump - allow easy printing of Types from the debugger.
2102 void Type::dump() const { dump(0); }
2104 // Module::dump() - Allow printing of Modules from the debugger.
2105 void Module::dump() const { print(errs(), 0); }