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/AssemblyAnnotationWriter.h"
20 #include "llvm/LLVMContext.h"
21 #include "llvm/CallingConv.h"
22 #include "llvm/Constants.h"
23 #include "llvm/DebugInfo.h"
24 #include "llvm/DerivedTypes.h"
25 #include "llvm/InlineAsm.h"
26 #include "llvm/IntrinsicInst.h"
27 #include "llvm/Operator.h"
28 #include "llvm/Module.h"
29 #include "llvm/TypeFinder.h"
30 #include "llvm/ValueSymbolTable.h"
31 #include "llvm/ADT/DenseMap.h"
32 #include "llvm/ADT/SmallString.h"
33 #include "llvm/ADT/StringExtras.h"
34 #include "llvm/ADT/STLExtras.h"
35 #include "llvm/Support/CFG.h"
36 #include "llvm/Support/Debug.h"
37 #include "llvm/Support/Dwarf.h"
38 #include "llvm/Support/ErrorHandling.h"
39 #include "llvm/Support/MathExtras.h"
40 #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 static void PrintCallingConv(unsigned cc, raw_ostream &Out)
72 case CallingConv::Fast: Out << "fastcc"; break;
73 case CallingConv::Cold: Out << "coldcc"; break;
74 case CallingConv::X86_StdCall: Out << "x86_stdcallcc"; break;
75 case CallingConv::X86_FastCall: Out << "x86_fastcallcc"; break;
76 case CallingConv::X86_ThisCall: Out << "x86_thiscallcc"; break;
77 case CallingConv::ARM_APCS: Out << "arm_apcscc"; break;
78 case CallingConv::ARM_AAPCS: Out << "arm_aapcscc"; break;
79 case CallingConv::ARM_AAPCS_VFP:Out << "arm_aapcs_vfpcc"; break;
80 case CallingConv::MSP430_INTR: Out << "msp430_intrcc"; break;
81 case CallingConv::PTX_Kernel: Out << "ptx_kernel"; break;
82 case CallingConv::PTX_Device: Out << "ptx_device"; break;
83 default: Out << "cc" << cc; break;
87 // PrintEscapedString - Print each character of the specified string, escaping
88 // it if it is not printable or if it is an escape char.
89 static void PrintEscapedString(StringRef Name, raw_ostream &Out) {
90 for (unsigned i = 0, e = Name.size(); i != e; ++i) {
91 unsigned char C = Name[i];
92 if (isprint(C) && C != '\\' && C != '"')
95 Out << '\\' << hexdigit(C >> 4) << hexdigit(C & 0x0F);
106 /// PrintLLVMName - Turn the specified name into an 'LLVM name', which is either
107 /// prefixed with % (if the string only contains simple characters) or is
108 /// surrounded with ""'s (if it has special chars in it). Print it out.
109 static void PrintLLVMName(raw_ostream &OS, StringRef Name, PrefixType Prefix) {
110 assert(!Name.empty() && "Cannot get empty name!");
112 case NoPrefix: break;
113 case GlobalPrefix: OS << '@'; break;
114 case LabelPrefix: break;
115 case LocalPrefix: OS << '%'; break;
118 // Scan the name to see if it needs quotes first.
119 bool NeedsQuotes = isdigit(Name[0]);
121 for (unsigned i = 0, e = Name.size(); i != e; ++i) {
122 // By making this unsigned, the value passed in to isalnum will always be
123 // in the range 0-255. This is important when building with MSVC because
124 // its implementation will assert. This situation can arise when dealing
125 // with UTF-8 multibyte characters.
126 unsigned char C = Name[i];
127 if (!isalnum(C) && C != '-' && C != '.' && C != '_') {
134 // If we didn't need any quotes, just write out the name in one blast.
140 // Okay, we need quotes. Output the quotes and escape any scary characters as
143 PrintEscapedString(Name, OS);
147 /// PrintLLVMName - Turn the specified name into an 'LLVM name', which is either
148 /// prefixed with % (if the string only contains simple characters) or is
149 /// surrounded with ""'s (if it has special chars in it). Print it out.
150 static void PrintLLVMName(raw_ostream &OS, const Value *V) {
151 PrintLLVMName(OS, V->getName(),
152 isa<GlobalValue>(V) ? GlobalPrefix : LocalPrefix);
155 //===----------------------------------------------------------------------===//
156 // TypePrinting Class: Type printing machinery
157 //===----------------------------------------------------------------------===//
159 /// TypePrinting - Type printing machinery.
162 TypePrinting(const TypePrinting &) LLVM_DELETED_FUNCTION;
163 void operator=(const TypePrinting&) LLVM_DELETED_FUNCTION;
166 /// NamedTypes - The named types that are used by the current module.
167 TypeFinder NamedTypes;
169 /// NumberedTypes - The numbered types, along with their value.
170 DenseMap<StructType*, unsigned> NumberedTypes;
176 void incorporateTypes(const Module &M);
178 void print(Type *Ty, raw_ostream &OS);
180 void printStructBody(StructType *Ty, raw_ostream &OS);
182 } // end anonymous namespace.
185 void TypePrinting::incorporateTypes(const Module &M) {
186 NamedTypes.run(M, false);
188 // The list of struct types we got back includes all the struct types, split
189 // the unnamed ones out to a numbering and remove the anonymous structs.
190 unsigned NextNumber = 0;
192 std::vector<StructType*>::iterator NextToUse = NamedTypes.begin(), I, E;
193 for (I = NamedTypes.begin(), E = NamedTypes.end(); I != E; ++I) {
194 StructType *STy = *I;
196 // Ignore anonymous types.
197 if (STy->isLiteral())
200 if (STy->getName().empty())
201 NumberedTypes[STy] = NextNumber++;
206 NamedTypes.erase(NextToUse, NamedTypes.end());
210 /// CalcTypeName - Write the specified type to the specified raw_ostream, making
211 /// use of type names or up references to shorten the type name where possible.
212 void TypePrinting::print(Type *Ty, raw_ostream &OS) {
213 switch (Ty->getTypeID()) {
214 case Type::VoidTyID: OS << "void"; break;
215 case Type::HalfTyID: OS << "half"; break;
216 case Type::FloatTyID: OS << "float"; break;
217 case Type::DoubleTyID: OS << "double"; break;
218 case Type::X86_FP80TyID: OS << "x86_fp80"; break;
219 case Type::FP128TyID: OS << "fp128"; break;
220 case Type::PPC_FP128TyID: OS << "ppc_fp128"; break;
221 case Type::LabelTyID: OS << "label"; break;
222 case Type::MetadataTyID: OS << "metadata"; break;
223 case Type::X86_MMXTyID: OS << "x86_mmx"; break;
224 case Type::IntegerTyID:
225 OS << 'i' << cast<IntegerType>(Ty)->getBitWidth();
228 case Type::FunctionTyID: {
229 FunctionType *FTy = cast<FunctionType>(Ty);
230 print(FTy->getReturnType(), OS);
232 for (FunctionType::param_iterator I = FTy->param_begin(),
233 E = FTy->param_end(); I != E; ++I) {
234 if (I != FTy->param_begin())
238 if (FTy->isVarArg()) {
239 if (FTy->getNumParams()) OS << ", ";
245 case Type::StructTyID: {
246 StructType *STy = cast<StructType>(Ty);
248 if (STy->isLiteral())
249 return printStructBody(STy, OS);
251 if (!STy->getName().empty())
252 return PrintLLVMName(OS, STy->getName(), LocalPrefix);
254 DenseMap<StructType*, unsigned>::iterator I = NumberedTypes.find(STy);
255 if (I != NumberedTypes.end())
256 OS << '%' << I->second;
257 else // Not enumerated, print the hex address.
258 OS << "%\"type " << STy << '\"';
261 case Type::PointerTyID: {
262 PointerType *PTy = cast<PointerType>(Ty);
263 print(PTy->getElementType(), OS);
264 if (unsigned AddressSpace = PTy->getAddressSpace())
265 OS << " addrspace(" << AddressSpace << ')';
269 case Type::ArrayTyID: {
270 ArrayType *ATy = cast<ArrayType>(Ty);
271 OS << '[' << ATy->getNumElements() << " x ";
272 print(ATy->getElementType(), OS);
276 case Type::VectorTyID: {
277 VectorType *PTy = cast<VectorType>(Ty);
278 OS << "<" << PTy->getNumElements() << " x ";
279 print(PTy->getElementType(), OS);
284 OS << "<unrecognized-type>";
289 void TypePrinting::printStructBody(StructType *STy, raw_ostream &OS) {
290 if (STy->isOpaque()) {
298 if (STy->getNumElements() == 0) {
301 StructType::element_iterator I = STy->element_begin();
304 for (StructType::element_iterator E = STy->element_end(); I != E; ++I) {
317 //===----------------------------------------------------------------------===//
318 // SlotTracker Class: Enumerate slot numbers for unnamed values
319 //===----------------------------------------------------------------------===//
323 /// This class provides computation of slot numbers for LLVM Assembly writing.
327 /// ValueMap - A mapping of Values to slot numbers.
328 typedef DenseMap<const Value*, unsigned> ValueMap;
331 /// TheModule - The module for which we are holding slot numbers.
332 const Module* TheModule;
334 /// TheFunction - The function for which we are holding slot numbers.
335 const Function* TheFunction;
336 bool FunctionProcessed;
338 /// mMap - The slot map for the module level data.
342 /// fMap - The slot map for the function level data.
346 /// mdnMap - Map for MDNodes.
347 DenseMap<const MDNode*, unsigned> mdnMap;
350 /// Construct from a module
351 explicit SlotTracker(const Module *M);
352 /// Construct from a function, starting out in incorp state.
353 explicit SlotTracker(const Function *F);
355 /// Return the slot number of the specified value in it's type
356 /// plane. If something is not in the SlotTracker, return -1.
357 int getLocalSlot(const Value *V);
358 int getGlobalSlot(const GlobalValue *V);
359 int getMetadataSlot(const MDNode *N);
361 /// If you'd like to deal with a function instead of just a module, use
362 /// this method to get its data into the SlotTracker.
363 void incorporateFunction(const Function *F) {
365 FunctionProcessed = false;
368 /// After calling incorporateFunction, use this method to remove the
369 /// most recently incorporated function from the SlotTracker. This
370 /// will reset the state of the machine back to just the module contents.
371 void purgeFunction();
373 /// MDNode map iterators.
374 typedef DenseMap<const MDNode*, unsigned>::iterator mdn_iterator;
375 mdn_iterator mdn_begin() { return mdnMap.begin(); }
376 mdn_iterator mdn_end() { return mdnMap.end(); }
377 unsigned mdn_size() const { return mdnMap.size(); }
378 bool mdn_empty() const { return mdnMap.empty(); }
380 /// This function does the actual initialization.
381 inline void initialize();
383 // Implementation Details
385 /// CreateModuleSlot - Insert the specified GlobalValue* into the slot table.
386 void CreateModuleSlot(const GlobalValue *V);
388 /// CreateMetadataSlot - Insert the specified MDNode* into the slot table.
389 void CreateMetadataSlot(const MDNode *N);
391 /// CreateFunctionSlot - Insert the specified Value* into the slot table.
392 void CreateFunctionSlot(const Value *V);
394 /// Add all of the module level global variables (and their initializers)
395 /// and function declarations, but not the contents of those functions.
396 void processModule();
398 /// Add all of the functions arguments, basic blocks, and instructions.
399 void processFunction();
401 SlotTracker(const SlotTracker &) LLVM_DELETED_FUNCTION;
402 void operator=(const SlotTracker &) LLVM_DELETED_FUNCTION;
405 } // end anonymous namespace
408 static SlotTracker *createSlotTracker(const Value *V) {
409 if (const Argument *FA = dyn_cast<Argument>(V))
410 return new SlotTracker(FA->getParent());
412 if (const Instruction *I = dyn_cast<Instruction>(V))
414 return new SlotTracker(I->getParent()->getParent());
416 if (const BasicBlock *BB = dyn_cast<BasicBlock>(V))
417 return new SlotTracker(BB->getParent());
419 if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(V))
420 return new SlotTracker(GV->getParent());
422 if (const GlobalAlias *GA = dyn_cast<GlobalAlias>(V))
423 return new SlotTracker(GA->getParent());
425 if (const Function *Func = dyn_cast<Function>(V))
426 return new SlotTracker(Func);
428 if (const MDNode *MD = dyn_cast<MDNode>(V)) {
429 if (!MD->isFunctionLocal())
430 return new SlotTracker(MD->getFunction());
432 return new SlotTracker((Function *)0);
439 #define ST_DEBUG(X) dbgs() << X
444 // Module level constructor. Causes the contents of the Module (sans functions)
445 // to be added to the slot table.
446 SlotTracker::SlotTracker(const Module *M)
447 : TheModule(M), TheFunction(0), FunctionProcessed(false),
448 mNext(0), fNext(0), mdnNext(0) {
451 // Function level constructor. Causes the contents of the Module and the one
452 // function provided to be added to the slot table.
453 SlotTracker::SlotTracker(const Function *F)
454 : TheModule(F ? F->getParent() : 0), TheFunction(F), FunctionProcessed(false),
455 mNext(0), fNext(0), mdnNext(0) {
458 inline void SlotTracker::initialize() {
461 TheModule = 0; ///< Prevent re-processing next time we're called.
464 if (TheFunction && !FunctionProcessed)
468 // Iterate through all the global variables, functions, and global
469 // variable initializers and create slots for them.
470 void SlotTracker::processModule() {
471 ST_DEBUG("begin processModule!\n");
473 // Add all of the unnamed global variables to the value table.
474 for (Module::const_global_iterator I = TheModule->global_begin(),
475 E = TheModule->global_end(); I != E; ++I) {
480 // Add metadata used by named metadata.
481 for (Module::const_named_metadata_iterator
482 I = TheModule->named_metadata_begin(),
483 E = TheModule->named_metadata_end(); I != E; ++I) {
484 const NamedMDNode *NMD = I;
485 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i)
486 CreateMetadataSlot(NMD->getOperand(i));
489 // Add all the unnamed functions to the table.
490 for (Module::const_iterator I = TheModule->begin(), E = TheModule->end();
495 ST_DEBUG("end processModule!\n");
498 // Process the arguments, basic blocks, and instructions of a function.
499 void SlotTracker::processFunction() {
500 ST_DEBUG("begin processFunction!\n");
503 // Add all the function arguments with no names.
504 for(Function::const_arg_iterator AI = TheFunction->arg_begin(),
505 AE = TheFunction->arg_end(); AI != AE; ++AI)
507 CreateFunctionSlot(AI);
509 ST_DEBUG("Inserting Instructions:\n");
511 SmallVector<std::pair<unsigned, MDNode*>, 4> MDForInst;
513 // Add all of the basic blocks and instructions with no names.
514 for (Function::const_iterator BB = TheFunction->begin(),
515 E = TheFunction->end(); BB != E; ++BB) {
517 CreateFunctionSlot(BB);
519 for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I != E;
521 if (!I->getType()->isVoidTy() && !I->hasName())
522 CreateFunctionSlot(I);
524 // Intrinsics can directly use metadata. We allow direct calls to any
525 // llvm.foo function here, because the target may not be linked into the
527 if (const CallInst *CI = dyn_cast<CallInst>(I)) {
528 if (Function *F = CI->getCalledFunction())
529 if (F->getName().startswith("llvm."))
530 for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i)
531 if (MDNode *N = dyn_cast_or_null<MDNode>(I->getOperand(i)))
532 CreateMetadataSlot(N);
535 // Process metadata attached with this instruction.
536 I->getAllMetadata(MDForInst);
537 for (unsigned i = 0, e = MDForInst.size(); i != e; ++i)
538 CreateMetadataSlot(MDForInst[i].second);
543 FunctionProcessed = true;
545 ST_DEBUG("end processFunction!\n");
548 /// Clean up after incorporating a function. This is the only way to get out of
549 /// the function incorporation state that affects get*Slot/Create*Slot. Function
550 /// incorporation state is indicated by TheFunction != 0.
551 void SlotTracker::purgeFunction() {
552 ST_DEBUG("begin purgeFunction!\n");
553 fMap.clear(); // Simply discard the function level map
555 FunctionProcessed = false;
556 ST_DEBUG("end purgeFunction!\n");
559 /// getGlobalSlot - Get the slot number of a global value.
560 int SlotTracker::getGlobalSlot(const GlobalValue *V) {
561 // Check for uninitialized state and do lazy initialization.
564 // Find the value in the module map
565 ValueMap::iterator MI = mMap.find(V);
566 return MI == mMap.end() ? -1 : (int)MI->second;
569 /// getMetadataSlot - Get the slot number of a MDNode.
570 int SlotTracker::getMetadataSlot(const MDNode *N) {
571 // Check for uninitialized state and do lazy initialization.
574 // Find the MDNode in the module map
575 mdn_iterator MI = mdnMap.find(N);
576 return MI == mdnMap.end() ? -1 : (int)MI->second;
580 /// getLocalSlot - Get the slot number for a value that is local to a function.
581 int SlotTracker::getLocalSlot(const Value *V) {
582 assert(!isa<Constant>(V) && "Can't get a constant or global slot with this!");
584 // Check for uninitialized state and do lazy initialization.
587 ValueMap::iterator FI = fMap.find(V);
588 return FI == fMap.end() ? -1 : (int)FI->second;
592 /// CreateModuleSlot - Insert the specified GlobalValue* into the slot table.
593 void SlotTracker::CreateModuleSlot(const GlobalValue *V) {
594 assert(V && "Can't insert a null Value into SlotTracker!");
595 assert(!V->getType()->isVoidTy() && "Doesn't need a slot!");
596 assert(!V->hasName() && "Doesn't need a slot!");
598 unsigned DestSlot = mNext++;
601 ST_DEBUG(" Inserting value [" << V->getType() << "] = " << V << " slot=" <<
603 // G = Global, F = Function, A = Alias, o = other
604 ST_DEBUG((isa<GlobalVariable>(V) ? 'G' :
605 (isa<Function>(V) ? 'F' :
606 (isa<GlobalAlias>(V) ? 'A' : 'o'))) << "]\n");
609 /// CreateSlot - Create a new slot for the specified value if it has no name.
610 void SlotTracker::CreateFunctionSlot(const Value *V) {
611 assert(!V->getType()->isVoidTy() && !V->hasName() && "Doesn't need a slot!");
613 unsigned DestSlot = fNext++;
616 // G = Global, F = Function, o = other
617 ST_DEBUG(" Inserting value [" << V->getType() << "] = " << V << " slot=" <<
618 DestSlot << " [o]\n");
621 /// CreateModuleSlot - Insert the specified MDNode* into the slot table.
622 void SlotTracker::CreateMetadataSlot(const MDNode *N) {
623 assert(N && "Can't insert a null Value into SlotTracker!");
625 // Don't insert if N is a function-local metadata, these are always printed
627 if (!N->isFunctionLocal()) {
628 mdn_iterator I = mdnMap.find(N);
629 if (I != mdnMap.end())
632 unsigned DestSlot = mdnNext++;
633 mdnMap[N] = DestSlot;
636 // Recursively add any MDNodes referenced by operands.
637 for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i)
638 if (const MDNode *Op = dyn_cast_or_null<MDNode>(N->getOperand(i)))
639 CreateMetadataSlot(Op);
642 //===----------------------------------------------------------------------===//
643 // AsmWriter Implementation
644 //===----------------------------------------------------------------------===//
646 static void WriteAsOperandInternal(raw_ostream &Out, const Value *V,
647 TypePrinting *TypePrinter,
648 SlotTracker *Machine,
649 const Module *Context);
653 static const char *getPredicateText(unsigned predicate) {
654 const char * pred = "unknown";
656 case FCmpInst::FCMP_FALSE: pred = "false"; break;
657 case FCmpInst::FCMP_OEQ: pred = "oeq"; break;
658 case FCmpInst::FCMP_OGT: pred = "ogt"; break;
659 case FCmpInst::FCMP_OGE: pred = "oge"; break;
660 case FCmpInst::FCMP_OLT: pred = "olt"; break;
661 case FCmpInst::FCMP_OLE: pred = "ole"; break;
662 case FCmpInst::FCMP_ONE: pred = "one"; break;
663 case FCmpInst::FCMP_ORD: pred = "ord"; break;
664 case FCmpInst::FCMP_UNO: pred = "uno"; break;
665 case FCmpInst::FCMP_UEQ: pred = "ueq"; break;
666 case FCmpInst::FCMP_UGT: pred = "ugt"; break;
667 case FCmpInst::FCMP_UGE: pred = "uge"; break;
668 case FCmpInst::FCMP_ULT: pred = "ult"; break;
669 case FCmpInst::FCMP_ULE: pred = "ule"; break;
670 case FCmpInst::FCMP_UNE: pred = "une"; break;
671 case FCmpInst::FCMP_TRUE: pred = "true"; break;
672 case ICmpInst::ICMP_EQ: pred = "eq"; break;
673 case ICmpInst::ICMP_NE: pred = "ne"; break;
674 case ICmpInst::ICMP_SGT: pred = "sgt"; break;
675 case ICmpInst::ICMP_SGE: pred = "sge"; break;
676 case ICmpInst::ICMP_SLT: pred = "slt"; break;
677 case ICmpInst::ICMP_SLE: pred = "sle"; break;
678 case ICmpInst::ICMP_UGT: pred = "ugt"; break;
679 case ICmpInst::ICMP_UGE: pred = "uge"; break;
680 case ICmpInst::ICMP_ULT: pred = "ult"; break;
681 case ICmpInst::ICMP_ULE: pred = "ule"; break;
686 static void writeAtomicRMWOperation(raw_ostream &Out,
687 AtomicRMWInst::BinOp Op) {
689 default: Out << " <unknown operation " << Op << ">"; break;
690 case AtomicRMWInst::Xchg: Out << " xchg"; break;
691 case AtomicRMWInst::Add: Out << " add"; break;
692 case AtomicRMWInst::Sub: Out << " sub"; break;
693 case AtomicRMWInst::And: Out << " and"; break;
694 case AtomicRMWInst::Nand: Out << " nand"; break;
695 case AtomicRMWInst::Or: Out << " or"; break;
696 case AtomicRMWInst::Xor: Out << " xor"; break;
697 case AtomicRMWInst::Max: Out << " max"; break;
698 case AtomicRMWInst::Min: Out << " min"; break;
699 case AtomicRMWInst::UMax: Out << " umax"; break;
700 case AtomicRMWInst::UMin: Out << " umin"; break;
704 static void WriteOptimizationInfo(raw_ostream &Out, const User *U) {
705 if (const OverflowingBinaryOperator *OBO =
706 dyn_cast<OverflowingBinaryOperator>(U)) {
707 if (OBO->hasNoUnsignedWrap())
709 if (OBO->hasNoSignedWrap())
711 } else if (const PossiblyExactOperator *Div =
712 dyn_cast<PossiblyExactOperator>(U)) {
715 } else if (const GEPOperator *GEP = dyn_cast<GEPOperator>(U)) {
716 if (GEP->isInBounds())
721 static void WriteConstantInternal(raw_ostream &Out, const Constant *CV,
722 TypePrinting &TypePrinter,
723 SlotTracker *Machine,
724 const Module *Context) {
725 if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV)) {
726 if (CI->getType()->isIntegerTy(1)) {
727 Out << (CI->getZExtValue() ? "true" : "false");
730 Out << CI->getValue();
734 if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV)) {
735 if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEsingle ||
736 &CFP->getValueAPF().getSemantics() == &APFloat::IEEEdouble) {
737 // We would like to output the FP constant value in exponential notation,
738 // but we cannot do this if doing so will lose precision. Check here to
739 // make sure that we only output it in exponential format if we can parse
740 // the value back and get the same value.
743 bool isHalf = &CFP->getValueAPF().getSemantics()==&APFloat::IEEEhalf;
744 bool isDouble = &CFP->getValueAPF().getSemantics()==&APFloat::IEEEdouble;
745 bool isInf = CFP->getValueAPF().isInfinity();
746 bool isNaN = CFP->getValueAPF().isNaN();
747 if (!isHalf && !isInf && !isNaN) {
748 double Val = isDouble ? CFP->getValueAPF().convertToDouble() :
749 CFP->getValueAPF().convertToFloat();
750 SmallString<128> StrVal;
751 raw_svector_ostream(StrVal) << Val;
753 // Check to make sure that the stringized number is not some string like
754 // "Inf" or NaN, that atof will accept, but the lexer will not. Check
755 // that the string matches the "[-+]?[0-9]" regex.
757 if ((StrVal[0] >= '0' && StrVal[0] <= '9') ||
758 ((StrVal[0] == '-' || StrVal[0] == '+') &&
759 (StrVal[1] >= '0' && StrVal[1] <= '9'))) {
760 // Reparse stringized version!
761 if (APFloat(APFloat::IEEEdouble, StrVal).convertToDouble() == Val) {
767 // Otherwise we could not reparse it to exactly the same value, so we must
768 // output the string in hexadecimal format! Note that loading and storing
769 // floating point types changes the bits of NaNs on some hosts, notably
770 // x86, so we must not use these types.
771 assert(sizeof(double) == sizeof(uint64_t) &&
772 "assuming that double is 64 bits!");
774 APFloat apf = CFP->getValueAPF();
775 // Halves and floats are represented in ASCII IR as double, convert.
777 apf.convert(APFloat::IEEEdouble, APFloat::rmNearestTiesToEven,
780 utohex_buffer(uint64_t(apf.bitcastToAPInt().getZExtValue()),
785 // Either half, or some form of long double.
786 // These appear as a magic letter identifying the type, then a
787 // fixed number of hex digits.
789 // Bit position, in the current word, of the next nibble to print.
792 if (&CFP->getValueAPF().getSemantics() == &APFloat::x87DoubleExtended) {
794 // api needed to prevent premature destruction
795 APInt api = CFP->getValueAPF().bitcastToAPInt();
796 const uint64_t* p = api.getRawData();
797 uint64_t word = p[1];
799 int width = api.getBitWidth();
800 for (int j=0; j<width; j+=4, shiftcount-=4) {
801 unsigned int nibble = (word>>shiftcount) & 15;
803 Out << (unsigned char)(nibble + '0');
805 Out << (unsigned char)(nibble - 10 + 'A');
806 if (shiftcount == 0 && j+4 < width) {
810 shiftcount = width-j-4;
814 } else if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEquad) {
817 } else if (&CFP->getValueAPF().getSemantics() == &APFloat::PPCDoubleDouble) {
820 } else if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEhalf) {
824 llvm_unreachable("Unsupported floating point type");
825 // api needed to prevent premature destruction
826 APInt api = CFP->getValueAPF().bitcastToAPInt();
827 const uint64_t* p = api.getRawData();
829 int width = api.getBitWidth();
830 for (int j=0; j<width; j+=4, shiftcount-=4) {
831 unsigned int nibble = (word>>shiftcount) & 15;
833 Out << (unsigned char)(nibble + '0');
835 Out << (unsigned char)(nibble - 10 + 'A');
836 if (shiftcount == 0 && j+4 < width) {
840 shiftcount = width-j-4;
846 if (isa<ConstantAggregateZero>(CV)) {
847 Out << "zeroinitializer";
851 if (const BlockAddress *BA = dyn_cast<BlockAddress>(CV)) {
852 Out << "blockaddress(";
853 WriteAsOperandInternal(Out, BA->getFunction(), &TypePrinter, Machine,
856 WriteAsOperandInternal(Out, BA->getBasicBlock(), &TypePrinter, Machine,
862 if (const ConstantArray *CA = dyn_cast<ConstantArray>(CV)) {
863 Type *ETy = CA->getType()->getElementType();
865 TypePrinter.print(ETy, Out);
867 WriteAsOperandInternal(Out, CA->getOperand(0),
868 &TypePrinter, Machine,
870 for (unsigned i = 1, e = CA->getNumOperands(); i != e; ++i) {
872 TypePrinter.print(ETy, Out);
874 WriteAsOperandInternal(Out, CA->getOperand(i), &TypePrinter, Machine,
881 if (const ConstantDataArray *CA = dyn_cast<ConstantDataArray>(CV)) {
882 // As a special case, print the array as a string if it is an array of
883 // i8 with ConstantInt values.
884 if (CA->isString()) {
886 PrintEscapedString(CA->getAsString(), Out);
891 Type *ETy = CA->getType()->getElementType();
893 TypePrinter.print(ETy, Out);
895 WriteAsOperandInternal(Out, CA->getElementAsConstant(0),
896 &TypePrinter, Machine,
898 for (unsigned i = 1, e = CA->getNumElements(); i != e; ++i) {
900 TypePrinter.print(ETy, Out);
902 WriteAsOperandInternal(Out, CA->getElementAsConstant(i), &TypePrinter,
910 if (const ConstantStruct *CS = dyn_cast<ConstantStruct>(CV)) {
911 if (CS->getType()->isPacked())
914 unsigned N = CS->getNumOperands();
917 TypePrinter.print(CS->getOperand(0)->getType(), Out);
920 WriteAsOperandInternal(Out, CS->getOperand(0), &TypePrinter, Machine,
923 for (unsigned i = 1; i < N; i++) {
925 TypePrinter.print(CS->getOperand(i)->getType(), Out);
928 WriteAsOperandInternal(Out, CS->getOperand(i), &TypePrinter, Machine,
935 if (CS->getType()->isPacked())
940 if (isa<ConstantVector>(CV) || isa<ConstantDataVector>(CV)) {
941 Type *ETy = CV->getType()->getVectorElementType();
943 TypePrinter.print(ETy, Out);
945 WriteAsOperandInternal(Out, CV->getAggregateElement(0U), &TypePrinter,
947 for (unsigned i = 1, e = CV->getType()->getVectorNumElements(); i != e;++i){
949 TypePrinter.print(ETy, Out);
951 WriteAsOperandInternal(Out, CV->getAggregateElement(i), &TypePrinter,
958 if (isa<ConstantPointerNull>(CV)) {
963 if (isa<UndefValue>(CV)) {
968 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV)) {
969 Out << CE->getOpcodeName();
970 WriteOptimizationInfo(Out, CE);
972 Out << ' ' << getPredicateText(CE->getPredicate());
975 for (User::const_op_iterator OI=CE->op_begin(); OI != CE->op_end(); ++OI) {
976 TypePrinter.print((*OI)->getType(), Out);
978 WriteAsOperandInternal(Out, *OI, &TypePrinter, Machine, Context);
979 if (OI+1 != CE->op_end())
983 if (CE->hasIndices()) {
984 ArrayRef<unsigned> Indices = CE->getIndices();
985 for (unsigned i = 0, e = Indices.size(); i != e; ++i)
986 Out << ", " << Indices[i];
991 TypePrinter.print(CE->getType(), Out);
998 Out << "<placeholder or erroneous Constant>";
1001 static void WriteMDNodeBodyInternal(raw_ostream &Out, const MDNode *Node,
1002 TypePrinting *TypePrinter,
1003 SlotTracker *Machine,
1004 const Module *Context) {
1006 for (unsigned mi = 0, me = Node->getNumOperands(); mi != me; ++mi) {
1007 const Value *V = Node->getOperand(mi);
1011 TypePrinter->print(V->getType(), Out);
1013 WriteAsOperandInternal(Out, Node->getOperand(mi),
1014 TypePrinter, Machine, Context);
1024 /// WriteAsOperand - Write the name of the specified value out to the specified
1025 /// ostream. This can be useful when you just want to print int %reg126, not
1026 /// the whole instruction that generated it.
1028 static void WriteAsOperandInternal(raw_ostream &Out, const Value *V,
1029 TypePrinting *TypePrinter,
1030 SlotTracker *Machine,
1031 const Module *Context) {
1033 PrintLLVMName(Out, V);
1037 const Constant *CV = dyn_cast<Constant>(V);
1038 if (CV && !isa<GlobalValue>(CV)) {
1039 assert(TypePrinter && "Constants require TypePrinting!");
1040 WriteConstantInternal(Out, CV, *TypePrinter, Machine, Context);
1044 if (const InlineAsm *IA = dyn_cast<InlineAsm>(V)) {
1046 if (IA->hasSideEffects())
1047 Out << "sideeffect ";
1048 if (IA->isAlignStack())
1049 Out << "alignstack ";
1050 // We don't emit the AD_ATT dialect as it's the assumed default.
1051 if (IA->getDialect() == InlineAsm::AD_Intel)
1052 Out << "inteldialect ";
1054 PrintEscapedString(IA->getAsmString(), Out);
1056 PrintEscapedString(IA->getConstraintString(), Out);
1061 if (const MDNode *N = dyn_cast<MDNode>(V)) {
1062 if (N->isFunctionLocal()) {
1063 // Print metadata inline, not via slot reference number.
1064 WriteMDNodeBodyInternal(Out, N, TypePrinter, Machine, Context);
1069 if (N->isFunctionLocal())
1070 Machine = new SlotTracker(N->getFunction());
1072 Machine = new SlotTracker(Context);
1074 int Slot = Machine->getMetadataSlot(N);
1082 if (const MDString *MDS = dyn_cast<MDString>(V)) {
1084 PrintEscapedString(MDS->getString(), Out);
1089 if (V->getValueID() == Value::PseudoSourceValueVal ||
1090 V->getValueID() == Value::FixedStackPseudoSourceValueVal) {
1097 // If we have a SlotTracker, use it.
1099 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
1100 Slot = Machine->getGlobalSlot(GV);
1103 Slot = Machine->getLocalSlot(V);
1105 // If the local value didn't succeed, then we may be referring to a value
1106 // from a different function. Translate it, as this can happen when using
1107 // address of blocks.
1109 if ((Machine = createSlotTracker(V))) {
1110 Slot = Machine->getLocalSlot(V);
1114 } else if ((Machine = createSlotTracker(V))) {
1115 // Otherwise, create one to get the # and then destroy it.
1116 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
1117 Slot = Machine->getGlobalSlot(GV);
1120 Slot = Machine->getLocalSlot(V);
1129 Out << Prefix << Slot;
1134 void llvm::WriteAsOperand(raw_ostream &Out, const Value *V,
1135 bool PrintType, const Module *Context) {
1137 // Fast path: Don't construct and populate a TypePrinting object if we
1138 // won't be needing any types printed.
1140 ((!isa<Constant>(V) && !isa<MDNode>(V)) ||
1141 V->hasName() || isa<GlobalValue>(V))) {
1142 WriteAsOperandInternal(Out, V, 0, 0, Context);
1146 if (Context == 0) Context = getModuleFromVal(V);
1148 TypePrinting TypePrinter;
1150 TypePrinter.incorporateTypes(*Context);
1152 TypePrinter.print(V->getType(), Out);
1156 WriteAsOperandInternal(Out, V, &TypePrinter, 0, Context);
1161 class AssemblyWriter {
1162 formatted_raw_ostream &Out;
1163 SlotTracker &Machine;
1164 const Module *TheModule;
1165 TypePrinting TypePrinter;
1166 AssemblyAnnotationWriter *AnnotationWriter;
1169 inline AssemblyWriter(formatted_raw_ostream &o, SlotTracker &Mac,
1171 AssemblyAnnotationWriter *AAW)
1172 : Out(o), Machine(Mac), TheModule(M), AnnotationWriter(AAW) {
1174 TypePrinter.incorporateTypes(*M);
1177 void printMDNodeBody(const MDNode *MD);
1178 void printNamedMDNode(const NamedMDNode *NMD);
1180 void printModule(const Module *M);
1182 void writeOperand(const Value *Op, bool PrintType);
1183 void writeParamOperand(const Value *Operand, Attributes Attrs);
1184 void writeAtomic(AtomicOrdering Ordering, SynchronizationScope SynchScope);
1186 void writeAllMDNodes();
1188 void printTypeIdentities();
1189 void printGlobal(const GlobalVariable *GV);
1190 void printAlias(const GlobalAlias *GV);
1191 void printFunction(const Function *F);
1192 void printArgument(const Argument *FA, Attributes Attrs);
1193 void printBasicBlock(const BasicBlock *BB);
1194 void printInstruction(const Instruction &I);
1197 // printInfoComment - Print a little comment after the instruction indicating
1198 // which slot it occupies.
1199 void printInfoComment(const Value &V);
1201 } // end of anonymous namespace
1203 void AssemblyWriter::writeOperand(const Value *Operand, bool PrintType) {
1205 Out << "<null operand!>";
1209 TypePrinter.print(Operand->getType(), Out);
1212 WriteAsOperandInternal(Out, Operand, &TypePrinter, &Machine, TheModule);
1215 void AssemblyWriter::writeAtomic(AtomicOrdering Ordering,
1216 SynchronizationScope SynchScope) {
1217 if (Ordering == NotAtomic)
1220 switch (SynchScope) {
1221 case SingleThread: Out << " singlethread"; break;
1222 case CrossThread: break;
1226 default: Out << " <bad ordering " << int(Ordering) << ">"; break;
1227 case Unordered: Out << " unordered"; break;
1228 case Monotonic: Out << " monotonic"; break;
1229 case Acquire: Out << " acquire"; break;
1230 case Release: Out << " release"; break;
1231 case AcquireRelease: Out << " acq_rel"; break;
1232 case SequentiallyConsistent: Out << " seq_cst"; break;
1236 void AssemblyWriter::writeParamOperand(const Value *Operand,
1239 Out << "<null operand!>";
1244 TypePrinter.print(Operand->getType(), Out);
1245 // Print parameter attributes list
1246 if (Attrs != Attribute::None)
1247 Out << ' ' << Attribute::getAsString(Attrs);
1249 // Print the operand
1250 WriteAsOperandInternal(Out, Operand, &TypePrinter, &Machine, TheModule);
1253 void AssemblyWriter::printModule(const Module *M) {
1254 if (!M->getModuleIdentifier().empty() &&
1255 // Don't print the ID if it will start a new line (which would
1256 // require a comment char before it).
1257 M->getModuleIdentifier().find('\n') == std::string::npos)
1258 Out << "; ModuleID = '" << M->getModuleIdentifier() << "'\n";
1260 if (!M->getDataLayout().empty())
1261 Out << "target datalayout = \"" << M->getDataLayout() << "\"\n";
1262 if (!M->getTargetTriple().empty())
1263 Out << "target triple = \"" << M->getTargetTriple() << "\"\n";
1265 if (!M->getModuleInlineAsm().empty()) {
1266 // Split the string into lines, to make it easier to read the .ll file.
1267 std::string Asm = M->getModuleInlineAsm();
1269 size_t NewLine = Asm.find_first_of('\n', CurPos);
1271 while (NewLine != std::string::npos) {
1272 // We found a newline, print the portion of the asm string from the
1273 // last newline up to this newline.
1274 Out << "module asm \"";
1275 PrintEscapedString(std::string(Asm.begin()+CurPos, Asm.begin()+NewLine),
1279 NewLine = Asm.find_first_of('\n', CurPos);
1281 std::string rest(Asm.begin()+CurPos, Asm.end());
1282 if (!rest.empty()) {
1283 Out << "module asm \"";
1284 PrintEscapedString(rest, Out);
1289 // Loop over the dependent libraries and emit them.
1290 Module::lib_iterator LI = M->lib_begin();
1291 Module::lib_iterator LE = M->lib_end();
1294 Out << "deplibs = [ ";
1296 Out << '"' << *LI << '"';
1304 printTypeIdentities();
1306 // Output all globals.
1307 if (!M->global_empty()) Out << '\n';
1308 for (Module::const_global_iterator I = M->global_begin(), E = M->global_end();
1310 printGlobal(I); Out << '\n';
1313 // Output all aliases.
1314 if (!M->alias_empty()) Out << "\n";
1315 for (Module::const_alias_iterator I = M->alias_begin(), E = M->alias_end();
1319 // Output all of the functions.
1320 for (Module::const_iterator I = M->begin(), E = M->end(); I != E; ++I)
1323 // Output named metadata.
1324 if (!M->named_metadata_empty()) Out << '\n';
1326 for (Module::const_named_metadata_iterator I = M->named_metadata_begin(),
1327 E = M->named_metadata_end(); I != E; ++I)
1328 printNamedMDNode(I);
1331 if (!Machine.mdn_empty()) {
1337 void AssemblyWriter::printNamedMDNode(const NamedMDNode *NMD) {
1339 StringRef Name = NMD->getName();
1341 Out << "<empty name> ";
1343 if (isalpha(Name[0]) || Name[0] == '-' || Name[0] == '$' ||
1344 Name[0] == '.' || Name[0] == '_')
1347 Out << '\\' << hexdigit(Name[0] >> 4) << hexdigit(Name[0] & 0x0F);
1348 for (unsigned i = 1, e = Name.size(); i != e; ++i) {
1349 unsigned char C = Name[i];
1350 if (isalnum(C) || C == '-' || C == '$' || C == '.' || C == '_')
1353 Out << '\\' << hexdigit(C >> 4) << hexdigit(C & 0x0F);
1357 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
1359 int Slot = Machine.getMetadataSlot(NMD->getOperand(i));
1369 static void PrintLinkage(GlobalValue::LinkageTypes LT,
1370 formatted_raw_ostream &Out) {
1372 case GlobalValue::ExternalLinkage: break;
1373 case GlobalValue::PrivateLinkage: Out << "private "; break;
1374 case GlobalValue::LinkerPrivateLinkage: Out << "linker_private "; break;
1375 case GlobalValue::LinkerPrivateWeakLinkage:
1376 Out << "linker_private_weak ";
1378 case GlobalValue::InternalLinkage: Out << "internal "; break;
1379 case GlobalValue::LinkOnceAnyLinkage: Out << "linkonce "; break;
1380 case GlobalValue::LinkOnceODRLinkage: Out << "linkonce_odr "; break;
1381 case GlobalValue::LinkOnceODRAutoHideLinkage:
1382 Out << "linkonce_odr_auto_hide ";
1384 case GlobalValue::WeakAnyLinkage: Out << "weak "; break;
1385 case GlobalValue::WeakODRLinkage: Out << "weak_odr "; break;
1386 case GlobalValue::CommonLinkage: Out << "common "; break;
1387 case GlobalValue::AppendingLinkage: Out << "appending "; break;
1388 case GlobalValue::DLLImportLinkage: Out << "dllimport "; break;
1389 case GlobalValue::DLLExportLinkage: Out << "dllexport "; break;
1390 case GlobalValue::ExternalWeakLinkage: Out << "extern_weak "; break;
1391 case GlobalValue::AvailableExternallyLinkage:
1392 Out << "available_externally ";
1398 static void PrintVisibility(GlobalValue::VisibilityTypes Vis,
1399 formatted_raw_ostream &Out) {
1401 case GlobalValue::DefaultVisibility: break;
1402 case GlobalValue::HiddenVisibility: Out << "hidden "; break;
1403 case GlobalValue::ProtectedVisibility: Out << "protected "; break;
1407 static void PrintThreadLocalModel(GlobalVariable::ThreadLocalMode TLM,
1408 formatted_raw_ostream &Out) {
1410 case GlobalVariable::NotThreadLocal:
1412 case GlobalVariable::GeneralDynamicTLSModel:
1413 Out << "thread_local ";
1415 case GlobalVariable::LocalDynamicTLSModel:
1416 Out << "thread_local(localdynamic) ";
1418 case GlobalVariable::InitialExecTLSModel:
1419 Out << "thread_local(initialexec) ";
1421 case GlobalVariable::LocalExecTLSModel:
1422 Out << "thread_local(localexec) ";
1427 void AssemblyWriter::printGlobal(const GlobalVariable *GV) {
1428 if (GV->isMaterializable())
1429 Out << "; Materializable\n";
1431 WriteAsOperandInternal(Out, GV, &TypePrinter, &Machine, GV->getParent());
1434 if (!GV->hasInitializer() && GV->hasExternalLinkage())
1437 PrintLinkage(GV->getLinkage(), Out);
1438 PrintVisibility(GV->getVisibility(), Out);
1439 PrintThreadLocalModel(GV->getThreadLocalMode(), Out);
1441 if (unsigned AddressSpace = GV->getType()->getAddressSpace())
1442 Out << "addrspace(" << AddressSpace << ") ";
1443 if (GV->hasUnnamedAddr()) Out << "unnamed_addr ";
1444 Out << (GV->isConstant() ? "constant " : "global ");
1445 TypePrinter.print(GV->getType()->getElementType(), Out);
1447 if (GV->hasInitializer()) {
1449 writeOperand(GV->getInitializer(), false);
1452 if (GV->hasSection()) {
1453 Out << ", section \"";
1454 PrintEscapedString(GV->getSection(), Out);
1457 if (GV->getAlignment())
1458 Out << ", align " << GV->getAlignment();
1460 printInfoComment(*GV);
1463 void AssemblyWriter::printAlias(const GlobalAlias *GA) {
1464 if (GA->isMaterializable())
1465 Out << "; Materializable\n";
1467 // Don't crash when dumping partially built GA
1469 Out << "<<nameless>> = ";
1471 PrintLLVMName(Out, GA);
1474 PrintVisibility(GA->getVisibility(), Out);
1478 PrintLinkage(GA->getLinkage(), Out);
1480 const Constant *Aliasee = GA->getAliasee();
1483 TypePrinter.print(GA->getType(), Out);
1484 Out << " <<NULL ALIASEE>>";
1486 writeOperand(Aliasee, !isa<ConstantExpr>(Aliasee));
1489 printInfoComment(*GA);
1493 void AssemblyWriter::printTypeIdentities() {
1494 if (TypePrinter.NumberedTypes.empty() &&
1495 TypePrinter.NamedTypes.empty())
1500 // We know all the numbers that each type is used and we know that it is a
1501 // dense assignment. Convert the map to an index table.
1502 std::vector<StructType*> NumberedTypes(TypePrinter.NumberedTypes.size());
1503 for (DenseMap<StructType*, unsigned>::iterator I =
1504 TypePrinter.NumberedTypes.begin(), E = TypePrinter.NumberedTypes.end();
1506 assert(I->second < NumberedTypes.size() && "Didn't get a dense numbering?");
1507 NumberedTypes[I->second] = I->first;
1510 // Emit all numbered types.
1511 for (unsigned i = 0, e = NumberedTypes.size(); i != e; ++i) {
1512 Out << '%' << i << " = type ";
1514 // Make sure we print out at least one level of the type structure, so
1515 // that we do not get %2 = type %2
1516 TypePrinter.printStructBody(NumberedTypes[i], Out);
1520 for (unsigned i = 0, e = TypePrinter.NamedTypes.size(); i != e; ++i) {
1521 PrintLLVMName(Out, TypePrinter.NamedTypes[i]->getName(), LocalPrefix);
1524 // Make sure we print out at least one level of the type structure, so
1525 // that we do not get %FILE = type %FILE
1526 TypePrinter.printStructBody(TypePrinter.NamedTypes[i], Out);
1531 /// printFunction - Print all aspects of a function.
1533 void AssemblyWriter::printFunction(const Function *F) {
1534 // Print out the return type and name.
1537 if (AnnotationWriter) AnnotationWriter->emitFunctionAnnot(F, Out);
1539 if (F->isMaterializable())
1540 Out << "; Materializable\n";
1542 if (F->isDeclaration())
1547 PrintLinkage(F->getLinkage(), Out);
1548 PrintVisibility(F->getVisibility(), Out);
1550 // Print the calling convention.
1551 if (F->getCallingConv() != CallingConv::C) {
1552 PrintCallingConv(F->getCallingConv(), Out);
1556 FunctionType *FT = F->getFunctionType();
1557 const AttrListPtr &Attrs = F->getAttributes();
1558 Attributes RetAttrs = Attrs.getRetAttributes();
1559 if (RetAttrs != Attribute::None)
1560 Out << Attribute::getAsString(Attrs.getRetAttributes()) << ' ';
1561 TypePrinter.print(F->getReturnType(), Out);
1563 WriteAsOperandInternal(Out, F, &TypePrinter, &Machine, F->getParent());
1565 Machine.incorporateFunction(F);
1567 // Loop over the arguments, printing them...
1570 if (!F->isDeclaration()) {
1571 // If this isn't a declaration, print the argument names as well.
1572 for (Function::const_arg_iterator I = F->arg_begin(), E = F->arg_end();
1574 // Insert commas as we go... the first arg doesn't get a comma
1575 if (I != F->arg_begin()) Out << ", ";
1576 printArgument(I, Attrs.getParamAttributes(Idx));
1580 // Otherwise, print the types from the function type.
1581 for (unsigned i = 0, e = FT->getNumParams(); i != e; ++i) {
1582 // Insert commas as we go... the first arg doesn't get a comma
1586 TypePrinter.print(FT->getParamType(i), Out);
1588 Attributes ArgAttrs = Attrs.getParamAttributes(i+1);
1589 if (ArgAttrs != Attribute::None)
1590 Out << ' ' << Attribute::getAsString(ArgAttrs);
1594 // Finish printing arguments...
1595 if (FT->isVarArg()) {
1596 if (FT->getNumParams()) Out << ", ";
1597 Out << "..."; // Output varargs portion of signature!
1600 if (F->hasUnnamedAddr())
1601 Out << " unnamed_addr";
1602 Attributes FnAttrs = Attrs.getFnAttributes();
1603 if (FnAttrs != Attribute::None)
1604 Out << ' ' << Attribute::getAsString(Attrs.getFnAttributes());
1605 if (F->hasSection()) {
1606 Out << " section \"";
1607 PrintEscapedString(F->getSection(), Out);
1610 if (F->getAlignment())
1611 Out << " align " << F->getAlignment();
1613 Out << " gc \"" << F->getGC() << '"';
1614 if (F->isDeclaration()) {
1618 // Output all of the function's basic blocks.
1619 for (Function::const_iterator I = F->begin(), E = F->end(); I != E; ++I)
1625 Machine.purgeFunction();
1628 /// printArgument - This member is called for every argument that is passed into
1629 /// the function. Simply print it out
1631 void AssemblyWriter::printArgument(const Argument *Arg,
1634 TypePrinter.print(Arg->getType(), Out);
1636 // Output parameter attributes list
1637 if (Attrs != Attribute::None)
1638 Out << ' ' << Attribute::getAsString(Attrs);
1640 // Output name, if available...
1641 if (Arg->hasName()) {
1643 PrintLLVMName(Out, Arg);
1647 /// printBasicBlock - This member is called for each basic block in a method.
1649 void AssemblyWriter::printBasicBlock(const BasicBlock *BB) {
1650 if (BB->hasName()) { // Print out the label if it exists...
1652 PrintLLVMName(Out, BB->getName(), LabelPrefix);
1654 } else if (!BB->use_empty()) { // Don't print block # of no uses...
1655 Out << "\n; <label>:";
1656 int Slot = Machine.getLocalSlot(BB);
1663 if (BB->getParent() == 0) {
1664 Out.PadToColumn(50);
1665 Out << "; Error: Block without parent!";
1666 } else if (BB != &BB->getParent()->getEntryBlock()) { // Not the entry block?
1667 // Output predecessors for the block.
1668 Out.PadToColumn(50);
1670 const_pred_iterator PI = pred_begin(BB), PE = pred_end(BB);
1673 Out << " No predecessors!";
1676 writeOperand(*PI, false);
1677 for (++PI; PI != PE; ++PI) {
1679 writeOperand(*PI, false);
1686 if (AnnotationWriter) AnnotationWriter->emitBasicBlockStartAnnot(BB, Out);
1688 // Output all of the instructions in the basic block...
1689 for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I != E; ++I) {
1690 printInstruction(*I);
1694 if (AnnotationWriter) AnnotationWriter->emitBasicBlockEndAnnot(BB, Out);
1697 /// printInfoComment - Print a little comment after the instruction indicating
1698 /// which slot it occupies.
1700 void AssemblyWriter::printInfoComment(const Value &V) {
1701 if (AnnotationWriter) {
1702 AnnotationWriter->printInfoComment(V, Out);
1707 // This member is called for each Instruction in a function..
1708 void AssemblyWriter::printInstruction(const Instruction &I) {
1709 if (AnnotationWriter) AnnotationWriter->emitInstructionAnnot(&I, Out);
1711 // Print out indentation for an instruction.
1714 // Print out name if it exists...
1716 PrintLLVMName(Out, &I);
1718 } else if (!I.getType()->isVoidTy()) {
1719 // Print out the def slot taken.
1720 int SlotNum = Machine.getLocalSlot(&I);
1722 Out << "<badref> = ";
1724 Out << '%' << SlotNum << " = ";
1727 if (isa<CallInst>(I) && cast<CallInst>(I).isTailCall())
1730 // Print out the opcode...
1731 Out << I.getOpcodeName();
1733 // If this is an atomic load or store, print out the atomic marker.
1734 if ((isa<LoadInst>(I) && cast<LoadInst>(I).isAtomic()) ||
1735 (isa<StoreInst>(I) && cast<StoreInst>(I).isAtomic()))
1738 // If this is a volatile operation, print out the volatile marker.
1739 if ((isa<LoadInst>(I) && cast<LoadInst>(I).isVolatile()) ||
1740 (isa<StoreInst>(I) && cast<StoreInst>(I).isVolatile()) ||
1741 (isa<AtomicCmpXchgInst>(I) && cast<AtomicCmpXchgInst>(I).isVolatile()) ||
1742 (isa<AtomicRMWInst>(I) && cast<AtomicRMWInst>(I).isVolatile()))
1745 // Print out optimization information.
1746 WriteOptimizationInfo(Out, &I);
1748 // Print out the compare instruction predicates
1749 if (const CmpInst *CI = dyn_cast<CmpInst>(&I))
1750 Out << ' ' << getPredicateText(CI->getPredicate());
1752 // Print out the atomicrmw operation
1753 if (const AtomicRMWInst *RMWI = dyn_cast<AtomicRMWInst>(&I))
1754 writeAtomicRMWOperation(Out, RMWI->getOperation());
1756 // Print out the type of the operands...
1757 const Value *Operand = I.getNumOperands() ? I.getOperand(0) : 0;
1759 // Special case conditional branches to swizzle the condition out to the front
1760 if (isa<BranchInst>(I) && cast<BranchInst>(I).isConditional()) {
1761 BranchInst &BI(cast<BranchInst>(I));
1763 writeOperand(BI.getCondition(), true);
1765 writeOperand(BI.getSuccessor(0), true);
1767 writeOperand(BI.getSuccessor(1), true);
1769 } else if (isa<SwitchInst>(I)) {
1770 SwitchInst& SI(cast<SwitchInst>(I));
1771 // Special case switch instruction to get formatting nice and correct.
1773 writeOperand(SI.getCondition(), true);
1775 writeOperand(SI.getDefaultDest(), true);
1777 for (SwitchInst::CaseIt i = SI.case_begin(), e = SI.case_end();
1780 writeOperand(i.getCaseValue(), true);
1782 writeOperand(i.getCaseSuccessor(), true);
1785 } else if (isa<IndirectBrInst>(I)) {
1786 // Special case indirectbr instruction to get formatting nice and correct.
1788 writeOperand(Operand, true);
1791 for (unsigned i = 1, e = I.getNumOperands(); i != e; ++i) {
1794 writeOperand(I.getOperand(i), true);
1797 } else if (const PHINode *PN = dyn_cast<PHINode>(&I)) {
1799 TypePrinter.print(I.getType(), Out);
1802 for (unsigned op = 0, Eop = PN->getNumIncomingValues(); op < Eop; ++op) {
1803 if (op) Out << ", ";
1805 writeOperand(PN->getIncomingValue(op), false); Out << ", ";
1806 writeOperand(PN->getIncomingBlock(op), false); Out << " ]";
1808 } else if (const ExtractValueInst *EVI = dyn_cast<ExtractValueInst>(&I)) {
1810 writeOperand(I.getOperand(0), true);
1811 for (const unsigned *i = EVI->idx_begin(), *e = EVI->idx_end(); i != e; ++i)
1813 } else if (const InsertValueInst *IVI = dyn_cast<InsertValueInst>(&I)) {
1815 writeOperand(I.getOperand(0), true); Out << ", ";
1816 writeOperand(I.getOperand(1), true);
1817 for (const unsigned *i = IVI->idx_begin(), *e = IVI->idx_end(); i != e; ++i)
1819 } else if (const LandingPadInst *LPI = dyn_cast<LandingPadInst>(&I)) {
1821 TypePrinter.print(I.getType(), Out);
1822 Out << " personality ";
1823 writeOperand(I.getOperand(0), true); Out << '\n';
1825 if (LPI->isCleanup())
1828 for (unsigned i = 0, e = LPI->getNumClauses(); i != e; ++i) {
1829 if (i != 0 || LPI->isCleanup()) Out << "\n";
1830 if (LPI->isCatch(i))
1835 writeOperand(LPI->getClause(i), true);
1837 } else if (isa<ReturnInst>(I) && !Operand) {
1839 } else if (const CallInst *CI = dyn_cast<CallInst>(&I)) {
1840 // Print the calling convention being used.
1841 if (CI->getCallingConv() != CallingConv::C) {
1843 PrintCallingConv(CI->getCallingConv(), Out);
1846 Operand = CI->getCalledValue();
1847 PointerType *PTy = cast<PointerType>(Operand->getType());
1848 FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
1849 Type *RetTy = FTy->getReturnType();
1850 const AttrListPtr &PAL = CI->getAttributes();
1852 if (PAL.getRetAttributes() != Attribute::None)
1853 Out << ' ' << Attribute::getAsString(PAL.getRetAttributes());
1855 // If possible, print out the short form of the call instruction. We can
1856 // only do this if the first argument is a pointer to a nonvararg function,
1857 // and if the return type is not a pointer to a function.
1860 if (!FTy->isVarArg() &&
1861 (!RetTy->isPointerTy() ||
1862 !cast<PointerType>(RetTy)->getElementType()->isFunctionTy())) {
1863 TypePrinter.print(RetTy, Out);
1865 writeOperand(Operand, false);
1867 writeOperand(Operand, true);
1870 for (unsigned op = 0, Eop = CI->getNumArgOperands(); op < Eop; ++op) {
1873 writeParamOperand(CI->getArgOperand(op), PAL.getParamAttributes(op + 1));
1876 if (PAL.getFnAttributes() != Attribute::None)
1877 Out << ' ' << Attribute::getAsString(PAL.getFnAttributes());
1878 } else if (const InvokeInst *II = dyn_cast<InvokeInst>(&I)) {
1879 Operand = II->getCalledValue();
1880 PointerType *PTy = cast<PointerType>(Operand->getType());
1881 FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
1882 Type *RetTy = FTy->getReturnType();
1883 const AttrListPtr &PAL = II->getAttributes();
1885 // Print the calling convention being used.
1886 if (II->getCallingConv() != CallingConv::C) {
1888 PrintCallingConv(II->getCallingConv(), Out);
1891 if (PAL.getRetAttributes() != Attribute::None)
1892 Out << ' ' << Attribute::getAsString(PAL.getRetAttributes());
1894 // If possible, print out the short form of the invoke instruction. We can
1895 // only do this if the first argument is a pointer to a nonvararg function,
1896 // and if the return type is not a pointer to a function.
1899 if (!FTy->isVarArg() &&
1900 (!RetTy->isPointerTy() ||
1901 !cast<PointerType>(RetTy)->getElementType()->isFunctionTy())) {
1902 TypePrinter.print(RetTy, Out);
1904 writeOperand(Operand, false);
1906 writeOperand(Operand, true);
1909 for (unsigned op = 0, Eop = II->getNumArgOperands(); op < Eop; ++op) {
1912 writeParamOperand(II->getArgOperand(op), PAL.getParamAttributes(op + 1));
1916 if (PAL.getFnAttributes() != Attribute::None)
1917 Out << ' ' << Attribute::getAsString(PAL.getFnAttributes());
1920 writeOperand(II->getNormalDest(), true);
1922 writeOperand(II->getUnwindDest(), true);
1924 } else if (const AllocaInst *AI = dyn_cast<AllocaInst>(&I)) {
1926 TypePrinter.print(AI->getType()->getElementType(), Out);
1927 if (!AI->getArraySize() || AI->isArrayAllocation()) {
1929 writeOperand(AI->getArraySize(), true);
1931 if (AI->getAlignment()) {
1932 Out << ", align " << AI->getAlignment();
1934 } else if (isa<CastInst>(I)) {
1937 writeOperand(Operand, true); // Work with broken code
1940 TypePrinter.print(I.getType(), Out);
1941 } else if (isa<VAArgInst>(I)) {
1944 writeOperand(Operand, true); // Work with broken code
1947 TypePrinter.print(I.getType(), Out);
1948 } else if (Operand) { // Print the normal way.
1950 // PrintAllTypes - Instructions who have operands of all the same type
1951 // omit the type from all but the first operand. If the instruction has
1952 // different type operands (for example br), then they are all printed.
1953 bool PrintAllTypes = false;
1954 Type *TheType = Operand->getType();
1956 // Select, Store and ShuffleVector always print all types.
1957 if (isa<SelectInst>(I) || isa<StoreInst>(I) || isa<ShuffleVectorInst>(I)
1958 || isa<ReturnInst>(I)) {
1959 PrintAllTypes = true;
1961 for (unsigned i = 1, E = I.getNumOperands(); i != E; ++i) {
1962 Operand = I.getOperand(i);
1963 // note that Operand shouldn't be null, but the test helps make dump()
1964 // more tolerant of malformed IR
1965 if (Operand && Operand->getType() != TheType) {
1966 PrintAllTypes = true; // We have differing types! Print them all!
1972 if (!PrintAllTypes) {
1974 TypePrinter.print(TheType, Out);
1978 for (unsigned i = 0, E = I.getNumOperands(); i != E; ++i) {
1980 writeOperand(I.getOperand(i), PrintAllTypes);
1984 // Print atomic ordering/alignment for memory operations
1985 if (const LoadInst *LI = dyn_cast<LoadInst>(&I)) {
1987 writeAtomic(LI->getOrdering(), LI->getSynchScope());
1988 if (LI->getAlignment())
1989 Out << ", align " << LI->getAlignment();
1990 } else if (const StoreInst *SI = dyn_cast<StoreInst>(&I)) {
1992 writeAtomic(SI->getOrdering(), SI->getSynchScope());
1993 if (SI->getAlignment())
1994 Out << ", align " << SI->getAlignment();
1995 } else if (const AtomicCmpXchgInst *CXI = dyn_cast<AtomicCmpXchgInst>(&I)) {
1996 writeAtomic(CXI->getOrdering(), CXI->getSynchScope());
1997 } else if (const AtomicRMWInst *RMWI = dyn_cast<AtomicRMWInst>(&I)) {
1998 writeAtomic(RMWI->getOrdering(), RMWI->getSynchScope());
1999 } else if (const FenceInst *FI = dyn_cast<FenceInst>(&I)) {
2000 writeAtomic(FI->getOrdering(), FI->getSynchScope());
2003 // Print Metadata info.
2004 SmallVector<std::pair<unsigned, MDNode*>, 4> InstMD;
2005 I.getAllMetadata(InstMD);
2006 if (!InstMD.empty()) {
2007 SmallVector<StringRef, 8> MDNames;
2008 I.getType()->getContext().getMDKindNames(MDNames);
2009 for (unsigned i = 0, e = InstMD.size(); i != e; ++i) {
2010 unsigned Kind = InstMD[i].first;
2011 if (Kind < MDNames.size()) {
2012 Out << ", !" << MDNames[Kind];
2014 Out << ", !<unknown kind #" << Kind << ">";
2017 WriteAsOperandInternal(Out, InstMD[i].second, &TypePrinter, &Machine,
2021 printInfoComment(I);
2024 static void WriteMDNodeComment(const MDNode *Node,
2025 formatted_raw_ostream &Out) {
2026 if (Node->getNumOperands() < 1)
2029 Value *Op = Node->getOperand(0);
2030 if (!Op || !isa<ConstantInt>(Op) || cast<ConstantInt>(Op)->getBitWidth() < 32)
2033 DIDescriptor Desc(Node);
2034 if (Desc.getVersion() < LLVMDebugVersion11)
2037 unsigned Tag = Desc.getTag();
2038 Out.PadToColumn(50);
2039 if (dwarf::TagString(Tag)) {
2042 } else if (Tag == dwarf::DW_TAG_user_base) {
2043 Out << "; [ DW_TAG_user_base ]";
2047 void AssemblyWriter::writeAllMDNodes() {
2048 SmallVector<const MDNode *, 16> Nodes;
2049 Nodes.resize(Machine.mdn_size());
2050 for (SlotTracker::mdn_iterator I = Machine.mdn_begin(), E = Machine.mdn_end();
2052 Nodes[I->second] = cast<MDNode>(I->first);
2054 for (unsigned i = 0, e = Nodes.size(); i != e; ++i) {
2055 Out << '!' << i << " = metadata ";
2056 printMDNodeBody(Nodes[i]);
2060 void AssemblyWriter::printMDNodeBody(const MDNode *Node) {
2061 WriteMDNodeBodyInternal(Out, Node, &TypePrinter, &Machine, TheModule);
2062 WriteMDNodeComment(Node, Out);
2066 //===----------------------------------------------------------------------===//
2067 // External Interface declarations
2068 //===----------------------------------------------------------------------===//
2070 void Module::print(raw_ostream &ROS, AssemblyAnnotationWriter *AAW) const {
2071 SlotTracker SlotTable(this);
2072 formatted_raw_ostream OS(ROS);
2073 AssemblyWriter W(OS, SlotTable, this, AAW);
2074 W.printModule(this);
2077 void NamedMDNode::print(raw_ostream &ROS, AssemblyAnnotationWriter *AAW) const {
2078 SlotTracker SlotTable(getParent());
2079 formatted_raw_ostream OS(ROS);
2080 AssemblyWriter W(OS, SlotTable, getParent(), AAW);
2081 W.printNamedMDNode(this);
2084 void Type::print(raw_ostream &OS) const {
2086 OS << "<null Type>";
2090 TP.print(const_cast<Type*>(this), OS);
2092 // If the type is a named struct type, print the body as well.
2093 if (StructType *STy = dyn_cast<StructType>(const_cast<Type*>(this)))
2094 if (!STy->isLiteral()) {
2096 TP.printStructBody(STy, OS);
2100 void Value::print(raw_ostream &ROS, AssemblyAnnotationWriter *AAW) const {
2102 ROS << "printing a <null> value\n";
2105 formatted_raw_ostream OS(ROS);
2106 if (const Instruction *I = dyn_cast<Instruction>(this)) {
2107 const Function *F = I->getParent() ? I->getParent()->getParent() : 0;
2108 SlotTracker SlotTable(F);
2109 AssemblyWriter W(OS, SlotTable, getModuleFromVal(I), AAW);
2110 W.printInstruction(*I);
2111 } else if (const BasicBlock *BB = dyn_cast<BasicBlock>(this)) {
2112 SlotTracker SlotTable(BB->getParent());
2113 AssemblyWriter W(OS, SlotTable, getModuleFromVal(BB), AAW);
2114 W.printBasicBlock(BB);
2115 } else if (const GlobalValue *GV = dyn_cast<GlobalValue>(this)) {
2116 SlotTracker SlotTable(GV->getParent());
2117 AssemblyWriter W(OS, SlotTable, GV->getParent(), AAW);
2118 if (const GlobalVariable *V = dyn_cast<GlobalVariable>(GV))
2120 else if (const Function *F = dyn_cast<Function>(GV))
2123 W.printAlias(cast<GlobalAlias>(GV));
2124 } else if (const MDNode *N = dyn_cast<MDNode>(this)) {
2125 const Function *F = N->getFunction();
2126 SlotTracker SlotTable(F);
2127 AssemblyWriter W(OS, SlotTable, F ? F->getParent() : 0, AAW);
2128 W.printMDNodeBody(N);
2129 } else if (const Constant *C = dyn_cast<Constant>(this)) {
2130 TypePrinting TypePrinter;
2131 TypePrinter.print(C->getType(), OS);
2133 WriteConstantInternal(OS, C, TypePrinter, 0, 0);
2134 } else if (isa<InlineAsm>(this) || isa<MDString>(this) ||
2135 isa<Argument>(this)) {
2136 WriteAsOperand(OS, this, true, 0);
2138 // Otherwise we don't know what it is. Call the virtual function to
2139 // allow a subclass to print itself.
2144 // Value::printCustom - subclasses should override this to implement printing.
2145 void Value::printCustom(raw_ostream &OS) const {
2146 llvm_unreachable("Unknown value to print out!");
2149 // Value::dump - allow easy printing of Values from the debugger.
2150 void Value::dump() const { print(dbgs()); dbgs() << '\n'; }
2152 // Type::dump - allow easy printing of Types from the debugger.
2153 void Type::dump() const { print(dbgs()); }
2155 // Module::dump() - Allow printing of Modules from the debugger.
2156 void Module::dump() const { print(dbgs(), 0); }
2158 // NamedMDNode::dump() - Allow printing of NamedMDNodes from the debugger.
2159 void NamedMDNode::dump() const { print(dbgs(), 0); }