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/DerivedTypes.h"
24 #include "llvm/InlineAsm.h"
25 #include "llvm/IntrinsicInst.h"
26 #include "llvm/Operator.h"
27 #include "llvm/Module.h"
28 #include "llvm/ValueSymbolTable.h"
29 #include "llvm/ADT/DenseMap.h"
30 #include "llvm/ADT/SmallString.h"
31 #include "llvm/ADT/StringExtras.h"
32 #include "llvm/ADT/STLExtras.h"
33 #include "llvm/Support/CFG.h"
34 #include "llvm/Support/Debug.h"
35 #include "llvm/Support/Dwarf.h"
36 #include "llvm/Support/ErrorHandling.h"
37 #include "llvm/Support/MathExtras.h"
38 #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(StringRef Name, raw_ostream &Out) {
70 for (unsigned i = 0, e = Name.size(); i != e; ++i) {
71 unsigned char C = Name[i];
72 if (isprint(C) && C != '\\' && C != '"')
75 Out << '\\' << hexdigit(C >> 4) << hexdigit(C & 0x0F);
86 /// PrintLLVMName - Turn the specified name into an 'LLVM name', which is either
87 /// prefixed with % (if the string only contains simple characters) or is
88 /// surrounded with ""'s (if it has special chars in it). Print it out.
89 static void PrintLLVMName(raw_ostream &OS, StringRef Name, PrefixType Prefix) {
90 assert(!Name.empty() && "Cannot get empty name!");
93 case GlobalPrefix: OS << '@'; break;
94 case LabelPrefix: break;
95 case LocalPrefix: OS << '%'; break;
98 // Scan the name to see if it needs quotes first.
99 bool NeedsQuotes = isdigit(Name[0]);
101 for (unsigned i = 0, e = Name.size(); i != e; ++i) {
103 if (!isalnum(C) && C != '-' && C != '.' && C != '_') {
110 // If we didn't need any quotes, just write out the name in one blast.
116 // Okay, we need quotes. Output the quotes and escape any scary characters as
119 PrintEscapedString(Name, OS);
123 /// PrintLLVMName - Turn the specified name into an 'LLVM name', which is either
124 /// prefixed with % (if the string only contains simple characters) or is
125 /// surrounded with ""'s (if it has special chars in it). Print it out.
126 static void PrintLLVMName(raw_ostream &OS, const Value *V) {
127 PrintLLVMName(OS, V->getName(),
128 isa<GlobalValue>(V) ? GlobalPrefix : LocalPrefix);
131 //===----------------------------------------------------------------------===//
132 // TypePrinting Class: Type printing machinery
133 //===----------------------------------------------------------------------===//
135 /// TypePrinting - Type printing machinery.
138 TypePrinting(const TypePrinting &); // DO NOT IMPLEMENT
139 void operator=(const TypePrinting&); // DO NOT IMPLEMENT
142 /// NamedTypes - The named types that are used by the current module.
143 std::vector<StructType*> NamedTypes;
145 /// NumberedTypes - The numbered types, along with their value.
146 DenseMap<StructType*, unsigned> NumberedTypes;
152 void incorporateTypes(const Module &M);
154 void print(Type *Ty, raw_ostream &OS);
156 void printStructBody(StructType *Ty, raw_ostream &OS);
158 } // end anonymous namespace.
161 void TypePrinting::incorporateTypes(const Module &M) {
162 M.findUsedStructTypes(NamedTypes);
164 // The list of struct types we got back includes all the struct types, split
165 // the unnamed ones out to a numbering and remove the anonymous structs.
166 unsigned NextNumber = 0;
168 std::vector<StructType*>::iterator NextToUse = NamedTypes.begin(), I, E;
169 for (I = NamedTypes.begin(), E = NamedTypes.end(); I != E; ++I) {
170 StructType *STy = *I;
172 // Ignore anonymous types.
173 if (STy->isLiteral())
176 if (STy->getName().empty())
177 NumberedTypes[STy] = NextNumber++;
182 NamedTypes.erase(NextToUse, NamedTypes.end());
186 /// CalcTypeName - Write the specified type to the specified raw_ostream, making
187 /// use of type names or up references to shorten the type name where possible.
188 void TypePrinting::print(Type *Ty, raw_ostream &OS) {
189 switch (Ty->getTypeID()) {
190 case Type::VoidTyID: OS << "void"; break;
191 case Type::HalfTyID: OS << "half"; break;
192 case Type::FloatTyID: OS << "float"; break;
193 case Type::DoubleTyID: OS << "double"; break;
194 case Type::X86_FP80TyID: OS << "x86_fp80"; break;
195 case Type::FP128TyID: OS << "fp128"; break;
196 case Type::PPC_FP128TyID: OS << "ppc_fp128"; break;
197 case Type::LabelTyID: OS << "label"; break;
198 case Type::MetadataTyID: OS << "metadata"; break;
199 case Type::X86_MMXTyID: OS << "x86_mmx"; break;
200 case Type::IntegerTyID:
201 OS << 'i' << cast<IntegerType>(Ty)->getBitWidth();
204 case Type::FunctionTyID: {
205 FunctionType *FTy = cast<FunctionType>(Ty);
206 print(FTy->getReturnType(), OS);
208 for (FunctionType::param_iterator I = FTy->param_begin(),
209 E = FTy->param_end(); I != E; ++I) {
210 if (I != FTy->param_begin())
214 if (FTy->isVarArg()) {
215 if (FTy->getNumParams()) OS << ", ";
221 case Type::StructTyID: {
222 StructType *STy = cast<StructType>(Ty);
224 if (STy->isLiteral())
225 return printStructBody(STy, OS);
227 if (!STy->getName().empty())
228 return PrintLLVMName(OS, STy->getName(), LocalPrefix);
230 DenseMap<StructType*, unsigned>::iterator I = NumberedTypes.find(STy);
231 if (I != NumberedTypes.end())
232 OS << '%' << I->second;
233 else // Not enumerated, print the hex address.
234 OS << "%\"type " << STy << '\"';
237 case Type::PointerTyID: {
238 PointerType *PTy = cast<PointerType>(Ty);
239 print(PTy->getElementType(), OS);
240 if (unsigned AddressSpace = PTy->getAddressSpace())
241 OS << " addrspace(" << AddressSpace << ')';
245 case Type::ArrayTyID: {
246 ArrayType *ATy = cast<ArrayType>(Ty);
247 OS << '[' << ATy->getNumElements() << " x ";
248 print(ATy->getElementType(), OS);
252 case Type::VectorTyID: {
253 VectorType *PTy = cast<VectorType>(Ty);
254 OS << "<" << PTy->getNumElements() << " x ";
255 print(PTy->getElementType(), OS);
260 OS << "<unrecognized-type>";
265 void TypePrinting::printStructBody(StructType *STy, raw_ostream &OS) {
266 if (STy->isOpaque()) {
274 if (STy->getNumElements() == 0) {
277 StructType::element_iterator I = STy->element_begin();
280 for (StructType::element_iterator E = STy->element_end(); I != E; ++I) {
293 //===----------------------------------------------------------------------===//
294 // SlotTracker Class: Enumerate slot numbers for unnamed values
295 //===----------------------------------------------------------------------===//
299 /// This class provides computation of slot numbers for LLVM Assembly writing.
303 /// ValueMap - A mapping of Values to slot numbers.
304 typedef DenseMap<const Value*, unsigned> ValueMap;
307 /// TheModule - The module for which we are holding slot numbers.
308 const Module* TheModule;
310 /// TheFunction - The function for which we are holding slot numbers.
311 const Function* TheFunction;
312 bool FunctionProcessed;
314 /// mMap - The slot map for the module level data.
318 /// fMap - The slot map for the function level data.
322 /// mdnMap - Map for MDNodes.
323 DenseMap<const MDNode*, unsigned> mdnMap;
326 /// Construct from a module
327 explicit SlotTracker(const Module *M);
328 /// Construct from a function, starting out in incorp state.
329 explicit SlotTracker(const Function *F);
331 /// Return the slot number of the specified value in it's type
332 /// plane. If something is not in the SlotTracker, return -1.
333 int getLocalSlot(const Value *V);
334 int getGlobalSlot(const GlobalValue *V);
335 int getMetadataSlot(const MDNode *N);
337 /// If you'd like to deal with a function instead of just a module, use
338 /// this method to get its data into the SlotTracker.
339 void incorporateFunction(const Function *F) {
341 FunctionProcessed = false;
344 /// After calling incorporateFunction, use this method to remove the
345 /// most recently incorporated function from the SlotTracker. This
346 /// will reset the state of the machine back to just the module contents.
347 void purgeFunction();
349 /// MDNode map iterators.
350 typedef DenseMap<const MDNode*, unsigned>::iterator mdn_iterator;
351 mdn_iterator mdn_begin() { return mdnMap.begin(); }
352 mdn_iterator mdn_end() { return mdnMap.end(); }
353 unsigned mdn_size() const { return mdnMap.size(); }
354 bool mdn_empty() const { return mdnMap.empty(); }
356 /// This function does the actual initialization.
357 inline void initialize();
359 // Implementation Details
361 /// CreateModuleSlot - Insert the specified GlobalValue* into the slot table.
362 void CreateModuleSlot(const GlobalValue *V);
364 /// CreateMetadataSlot - Insert the specified MDNode* into the slot table.
365 void CreateMetadataSlot(const MDNode *N);
367 /// CreateFunctionSlot - Insert the specified Value* into the slot table.
368 void CreateFunctionSlot(const Value *V);
370 /// Add all of the module level global variables (and their initializers)
371 /// and function declarations, but not the contents of those functions.
372 void processModule();
374 /// Add all of the functions arguments, basic blocks, and instructions.
375 void processFunction();
377 SlotTracker(const SlotTracker &); // DO NOT IMPLEMENT
378 void operator=(const SlotTracker &); // DO NOT IMPLEMENT
381 } // end anonymous namespace
384 static SlotTracker *createSlotTracker(const Value *V) {
385 if (const Argument *FA = dyn_cast<Argument>(V))
386 return new SlotTracker(FA->getParent());
388 if (const Instruction *I = dyn_cast<Instruction>(V))
390 return new SlotTracker(I->getParent()->getParent());
392 if (const BasicBlock *BB = dyn_cast<BasicBlock>(V))
393 return new SlotTracker(BB->getParent());
395 if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(V))
396 return new SlotTracker(GV->getParent());
398 if (const GlobalAlias *GA = dyn_cast<GlobalAlias>(V))
399 return new SlotTracker(GA->getParent());
401 if (const Function *Func = dyn_cast<Function>(V))
402 return new SlotTracker(Func);
404 if (const MDNode *MD = dyn_cast<MDNode>(V)) {
405 if (!MD->isFunctionLocal())
406 return new SlotTracker(MD->getFunction());
408 return new SlotTracker((Function *)0);
415 #define ST_DEBUG(X) dbgs() << X
420 // Module level constructor. Causes the contents of the Module (sans functions)
421 // to be added to the slot table.
422 SlotTracker::SlotTracker(const Module *M)
423 : TheModule(M), TheFunction(0), FunctionProcessed(false),
424 mNext(0), fNext(0), mdnNext(0) {
427 // Function level constructor. Causes the contents of the Module and the one
428 // function provided to be added to the slot table.
429 SlotTracker::SlotTracker(const Function *F)
430 : TheModule(F ? F->getParent() : 0), TheFunction(F), FunctionProcessed(false),
431 mNext(0), fNext(0), mdnNext(0) {
434 inline void SlotTracker::initialize() {
437 TheModule = 0; ///< Prevent re-processing next time we're called.
440 if (TheFunction && !FunctionProcessed)
444 // Iterate through all the global variables, functions, and global
445 // variable initializers and create slots for them.
446 void SlotTracker::processModule() {
447 ST_DEBUG("begin processModule!\n");
449 // Add all of the unnamed global variables to the value table.
450 for (Module::const_global_iterator I = TheModule->global_begin(),
451 E = TheModule->global_end(); I != E; ++I) {
456 // Add metadata used by named metadata.
457 for (Module::const_named_metadata_iterator
458 I = TheModule->named_metadata_begin(),
459 E = TheModule->named_metadata_end(); I != E; ++I) {
460 const NamedMDNode *NMD = I;
461 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i)
462 CreateMetadataSlot(NMD->getOperand(i));
465 // Add all the unnamed functions to the table.
466 for (Module::const_iterator I = TheModule->begin(), E = TheModule->end();
471 ST_DEBUG("end processModule!\n");
474 // Process the arguments, basic blocks, and instructions of a function.
475 void SlotTracker::processFunction() {
476 ST_DEBUG("begin processFunction!\n");
479 // Add all the function arguments with no names.
480 for(Function::const_arg_iterator AI = TheFunction->arg_begin(),
481 AE = TheFunction->arg_end(); AI != AE; ++AI)
483 CreateFunctionSlot(AI);
485 ST_DEBUG("Inserting Instructions:\n");
487 SmallVector<std::pair<unsigned, MDNode*>, 4> MDForInst;
489 // Add all of the basic blocks and instructions with no names.
490 for (Function::const_iterator BB = TheFunction->begin(),
491 E = TheFunction->end(); BB != E; ++BB) {
493 CreateFunctionSlot(BB);
495 for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I != E;
497 if (!I->getType()->isVoidTy() && !I->hasName())
498 CreateFunctionSlot(I);
500 // Intrinsics can directly use metadata. We allow direct calls to any
501 // llvm.foo function here, because the target may not be linked into the
503 if (const CallInst *CI = dyn_cast<CallInst>(I)) {
504 if (Function *F = CI->getCalledFunction())
505 if (F->getName().startswith("llvm."))
506 for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i)
507 if (MDNode *N = dyn_cast_or_null<MDNode>(I->getOperand(i)))
508 CreateMetadataSlot(N);
511 // Process metadata attached with this instruction.
512 I->getAllMetadata(MDForInst);
513 for (unsigned i = 0, e = MDForInst.size(); i != e; ++i)
514 CreateMetadataSlot(MDForInst[i].second);
519 FunctionProcessed = true;
521 ST_DEBUG("end processFunction!\n");
524 /// Clean up after incorporating a function. This is the only way to get out of
525 /// the function incorporation state that affects get*Slot/Create*Slot. Function
526 /// incorporation state is indicated by TheFunction != 0.
527 void SlotTracker::purgeFunction() {
528 ST_DEBUG("begin purgeFunction!\n");
529 fMap.clear(); // Simply discard the function level map
531 FunctionProcessed = false;
532 ST_DEBUG("end purgeFunction!\n");
535 /// getGlobalSlot - Get the slot number of a global value.
536 int SlotTracker::getGlobalSlot(const GlobalValue *V) {
537 // Check for uninitialized state and do lazy initialization.
540 // Find the value in the module map
541 ValueMap::iterator MI = mMap.find(V);
542 return MI == mMap.end() ? -1 : (int)MI->second;
545 /// getMetadataSlot - Get the slot number of a MDNode.
546 int SlotTracker::getMetadataSlot(const MDNode *N) {
547 // Check for uninitialized state and do lazy initialization.
550 // Find the MDNode in the module map
551 mdn_iterator MI = mdnMap.find(N);
552 return MI == mdnMap.end() ? -1 : (int)MI->second;
556 /// getLocalSlot - Get the slot number for a value that is local to a function.
557 int SlotTracker::getLocalSlot(const Value *V) {
558 assert(!isa<Constant>(V) && "Can't get a constant or global slot with this!");
560 // Check for uninitialized state and do lazy initialization.
563 ValueMap::iterator FI = fMap.find(V);
564 return FI == fMap.end() ? -1 : (int)FI->second;
568 /// CreateModuleSlot - Insert the specified GlobalValue* into the slot table.
569 void SlotTracker::CreateModuleSlot(const GlobalValue *V) {
570 assert(V && "Can't insert a null Value into SlotTracker!");
571 assert(!V->getType()->isVoidTy() && "Doesn't need a slot!");
572 assert(!V->hasName() && "Doesn't need a slot!");
574 unsigned DestSlot = mNext++;
577 ST_DEBUG(" Inserting value [" << V->getType() << "] = " << V << " slot=" <<
579 // G = Global, F = Function, A = Alias, o = other
580 ST_DEBUG((isa<GlobalVariable>(V) ? 'G' :
581 (isa<Function>(V) ? 'F' :
582 (isa<GlobalAlias>(V) ? 'A' : 'o'))) << "]\n");
585 /// CreateSlot - Create a new slot for the specified value if it has no name.
586 void SlotTracker::CreateFunctionSlot(const Value *V) {
587 assert(!V->getType()->isVoidTy() && !V->hasName() && "Doesn't need a slot!");
589 unsigned DestSlot = fNext++;
592 // G = Global, F = Function, o = other
593 ST_DEBUG(" Inserting value [" << V->getType() << "] = " << V << " slot=" <<
594 DestSlot << " [o]\n");
597 /// CreateModuleSlot - Insert the specified MDNode* into the slot table.
598 void SlotTracker::CreateMetadataSlot(const MDNode *N) {
599 assert(N && "Can't insert a null Value into SlotTracker!");
601 // Don't insert if N is a function-local metadata, these are always printed
603 if (!N->isFunctionLocal()) {
604 mdn_iterator I = mdnMap.find(N);
605 if (I != mdnMap.end())
608 unsigned DestSlot = mdnNext++;
609 mdnMap[N] = DestSlot;
612 // Recursively add any MDNodes referenced by operands.
613 for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i)
614 if (const MDNode *Op = dyn_cast_or_null<MDNode>(N->getOperand(i)))
615 CreateMetadataSlot(Op);
618 //===----------------------------------------------------------------------===//
619 // AsmWriter Implementation
620 //===----------------------------------------------------------------------===//
622 static void WriteAsOperandInternal(raw_ostream &Out, const Value *V,
623 TypePrinting *TypePrinter,
624 SlotTracker *Machine,
625 const Module *Context);
629 static const char *getPredicateText(unsigned predicate) {
630 const char * pred = "unknown";
632 case FCmpInst::FCMP_FALSE: pred = "false"; break;
633 case FCmpInst::FCMP_OEQ: pred = "oeq"; break;
634 case FCmpInst::FCMP_OGT: pred = "ogt"; break;
635 case FCmpInst::FCMP_OGE: pred = "oge"; break;
636 case FCmpInst::FCMP_OLT: pred = "olt"; break;
637 case FCmpInst::FCMP_OLE: pred = "ole"; break;
638 case FCmpInst::FCMP_ONE: pred = "one"; break;
639 case FCmpInst::FCMP_ORD: pred = "ord"; break;
640 case FCmpInst::FCMP_UNO: pred = "uno"; break;
641 case FCmpInst::FCMP_UEQ: pred = "ueq"; break;
642 case FCmpInst::FCMP_UGT: pred = "ugt"; break;
643 case FCmpInst::FCMP_UGE: pred = "uge"; break;
644 case FCmpInst::FCMP_ULT: pred = "ult"; break;
645 case FCmpInst::FCMP_ULE: pred = "ule"; break;
646 case FCmpInst::FCMP_UNE: pred = "une"; break;
647 case FCmpInst::FCMP_TRUE: pred = "true"; break;
648 case ICmpInst::ICMP_EQ: pred = "eq"; break;
649 case ICmpInst::ICMP_NE: pred = "ne"; break;
650 case ICmpInst::ICMP_SGT: pred = "sgt"; break;
651 case ICmpInst::ICMP_SGE: pred = "sge"; break;
652 case ICmpInst::ICMP_SLT: pred = "slt"; break;
653 case ICmpInst::ICMP_SLE: pred = "sle"; break;
654 case ICmpInst::ICMP_UGT: pred = "ugt"; break;
655 case ICmpInst::ICMP_UGE: pred = "uge"; break;
656 case ICmpInst::ICMP_ULT: pred = "ult"; break;
657 case ICmpInst::ICMP_ULE: pred = "ule"; break;
662 static void writeAtomicRMWOperation(raw_ostream &Out,
663 AtomicRMWInst::BinOp Op) {
665 default: Out << " <unknown operation " << Op << ">"; break;
666 case AtomicRMWInst::Xchg: Out << " xchg"; break;
667 case AtomicRMWInst::Add: Out << " add"; break;
668 case AtomicRMWInst::Sub: Out << " sub"; break;
669 case AtomicRMWInst::And: Out << " and"; break;
670 case AtomicRMWInst::Nand: Out << " nand"; break;
671 case AtomicRMWInst::Or: Out << " or"; break;
672 case AtomicRMWInst::Xor: Out << " xor"; break;
673 case AtomicRMWInst::Max: Out << " max"; break;
674 case AtomicRMWInst::Min: Out << " min"; break;
675 case AtomicRMWInst::UMax: Out << " umax"; break;
676 case AtomicRMWInst::UMin: Out << " umin"; break;
680 static void WriteOptimizationInfo(raw_ostream &Out, const User *U) {
681 if (const OverflowingBinaryOperator *OBO =
682 dyn_cast<OverflowingBinaryOperator>(U)) {
683 if (OBO->hasNoUnsignedWrap())
685 if (OBO->hasNoSignedWrap())
687 } else if (const PossiblyExactOperator *Div =
688 dyn_cast<PossiblyExactOperator>(U)) {
691 } else if (const GEPOperator *GEP = dyn_cast<GEPOperator>(U)) {
692 if (GEP->isInBounds())
697 static void WriteConstantInternal(raw_ostream &Out, const Constant *CV,
698 TypePrinting &TypePrinter,
699 SlotTracker *Machine,
700 const Module *Context) {
701 if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV)) {
702 if (CI->getType()->isIntegerTy(1)) {
703 Out << (CI->getZExtValue() ? "true" : "false");
706 Out << CI->getValue();
710 if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV)) {
711 if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEhalf ||
712 &CFP->getValueAPF().getSemantics() == &APFloat::IEEEsingle ||
713 &CFP->getValueAPF().getSemantics() == &APFloat::IEEEdouble) {
714 // We would like to output the FP constant value in exponential notation,
715 // but we cannot do this if doing so will lose precision. Check here to
716 // make sure that we only output it in exponential format if we can parse
717 // the value back and get the same value.
720 bool isHalf = &CFP->getValueAPF().getSemantics()==&APFloat::IEEEhalf;
721 bool isDouble = &CFP->getValueAPF().getSemantics()==&APFloat::IEEEdouble;
722 bool isInf = CFP->getValueAPF().isInfinity();
723 bool isNaN = CFP->getValueAPF().isNaN();
724 if (!isHalf && !isInf && !isNaN) {
725 double Val = isDouble ? CFP->getValueAPF().convertToDouble() :
726 CFP->getValueAPF().convertToFloat();
727 SmallString<128> StrVal;
728 raw_svector_ostream(StrVal) << Val;
730 // Check to make sure that the stringized number is not some string like
731 // "Inf" or NaN, that atof will accept, but the lexer will not. Check
732 // that the string matches the "[-+]?[0-9]" regex.
734 if ((StrVal[0] >= '0' && StrVal[0] <= '9') ||
735 ((StrVal[0] == '-' || StrVal[0] == '+') &&
736 (StrVal[1] >= '0' && StrVal[1] <= '9'))) {
737 // Reparse stringized version!
738 if (APFloat(APFloat::IEEEdouble, StrVal).convertToDouble() == Val) {
744 // Otherwise we could not reparse it to exactly the same value, so we must
745 // output the string in hexadecimal format! Note that loading and storing
746 // floating point types changes the bits of NaNs on some hosts, notably
747 // x86, so we must not use these types.
748 assert(sizeof(double) == sizeof(uint64_t) &&
749 "assuming that double is 64 bits!");
751 APFloat apf = CFP->getValueAPF();
752 // Halves and floats are represented in ASCII IR as double, convert.
754 apf.convert(APFloat::IEEEdouble, APFloat::rmNearestTiesToEven,
757 utohex_buffer(uint64_t(apf.bitcastToAPInt().getZExtValue()),
762 // Some form of long double. These appear as a magic letter identifying
763 // the type, then a fixed number of hex digits.
765 if (&CFP->getValueAPF().getSemantics() == &APFloat::x87DoubleExtended) {
767 // api needed to prevent premature destruction
768 APInt api = CFP->getValueAPF().bitcastToAPInt();
769 const uint64_t* p = api.getRawData();
770 uint64_t word = p[1];
772 int width = api.getBitWidth();
773 for (int j=0; j<width; j+=4, shiftcount-=4) {
774 unsigned int nibble = (word>>shiftcount) & 15;
776 Out << (unsigned char)(nibble + '0');
778 Out << (unsigned char)(nibble - 10 + 'A');
779 if (shiftcount == 0 && j+4 < width) {
783 shiftcount = width-j-4;
787 } else if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEquad)
789 else if (&CFP->getValueAPF().getSemantics() == &APFloat::PPCDoubleDouble)
792 llvm_unreachable("Unsupported floating point type");
793 // api needed to prevent premature destruction
794 APInt api = CFP->getValueAPF().bitcastToAPInt();
795 const uint64_t* p = api.getRawData();
798 int width = api.getBitWidth();
799 for (int j=0; j<width; j+=4, shiftcount-=4) {
800 unsigned int nibble = (word>>shiftcount) & 15;
802 Out << (unsigned char)(nibble + '0');
804 Out << (unsigned char)(nibble - 10 + 'A');
805 if (shiftcount == 0 && j+4 < width) {
809 shiftcount = width-j-4;
815 if (isa<ConstantAggregateZero>(CV)) {
816 Out << "zeroinitializer";
820 if (const BlockAddress *BA = dyn_cast<BlockAddress>(CV)) {
821 Out << "blockaddress(";
822 WriteAsOperandInternal(Out, BA->getFunction(), &TypePrinter, Machine,
825 WriteAsOperandInternal(Out, BA->getBasicBlock(), &TypePrinter, Machine,
831 if (const ConstantArray *CA = dyn_cast<ConstantArray>(CV)) {
832 Type *ETy = CA->getType()->getElementType();
834 TypePrinter.print(ETy, Out);
836 WriteAsOperandInternal(Out, CA->getOperand(0),
837 &TypePrinter, Machine,
839 for (unsigned i = 1, e = CA->getNumOperands(); i != e; ++i) {
841 TypePrinter.print(ETy, Out);
843 WriteAsOperandInternal(Out, CA->getOperand(i), &TypePrinter, Machine,
850 if (const ConstantDataArray *CA = dyn_cast<ConstantDataArray>(CV)) {
851 // As a special case, print the array as a string if it is an array of
852 // i8 with ConstantInt values.
853 if (CA->isString()) {
855 PrintEscapedString(CA->getAsString(), Out);
860 Type *ETy = CA->getType()->getElementType();
862 TypePrinter.print(ETy, Out);
864 WriteAsOperandInternal(Out, CA->getElementAsConstant(0),
865 &TypePrinter, Machine,
867 for (unsigned i = 1, e = CA->getNumElements(); i != e; ++i) {
869 TypePrinter.print(ETy, Out);
871 WriteAsOperandInternal(Out, CA->getElementAsConstant(i), &TypePrinter,
879 if (const ConstantStruct *CS = dyn_cast<ConstantStruct>(CV)) {
880 if (CS->getType()->isPacked())
883 unsigned N = CS->getNumOperands();
886 TypePrinter.print(CS->getOperand(0)->getType(), Out);
889 WriteAsOperandInternal(Out, CS->getOperand(0), &TypePrinter, Machine,
892 for (unsigned i = 1; i < N; i++) {
894 TypePrinter.print(CS->getOperand(i)->getType(), Out);
897 WriteAsOperandInternal(Out, CS->getOperand(i), &TypePrinter, Machine,
904 if (CS->getType()->isPacked())
909 if (isa<ConstantVector>(CV) || isa<ConstantDataVector>(CV)) {
910 Type *ETy = CV->getType()->getVectorElementType();
912 TypePrinter.print(ETy, Out);
914 WriteAsOperandInternal(Out, CV->getAggregateElement(0U), &TypePrinter,
916 for (unsigned i = 1, e = CV->getType()->getVectorNumElements(); i != e;++i){
918 TypePrinter.print(ETy, Out);
920 WriteAsOperandInternal(Out, CV->getAggregateElement(i), &TypePrinter,
927 if (isa<ConstantPointerNull>(CV)) {
932 if (isa<UndefValue>(CV)) {
937 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV)) {
938 Out << CE->getOpcodeName();
939 WriteOptimizationInfo(Out, CE);
941 Out << ' ' << getPredicateText(CE->getPredicate());
944 for (User::const_op_iterator OI=CE->op_begin(); OI != CE->op_end(); ++OI) {
945 TypePrinter.print((*OI)->getType(), Out);
947 WriteAsOperandInternal(Out, *OI, &TypePrinter, Machine, Context);
948 if (OI+1 != CE->op_end())
952 if (CE->hasIndices()) {
953 ArrayRef<unsigned> Indices = CE->getIndices();
954 for (unsigned i = 0, e = Indices.size(); i != e; ++i)
955 Out << ", " << Indices[i];
960 TypePrinter.print(CE->getType(), Out);
967 Out << "<placeholder or erroneous Constant>";
970 static void WriteMDNodeBodyInternal(raw_ostream &Out, const MDNode *Node,
971 TypePrinting *TypePrinter,
972 SlotTracker *Machine,
973 const Module *Context) {
975 for (unsigned mi = 0, me = Node->getNumOperands(); mi != me; ++mi) {
976 const Value *V = Node->getOperand(mi);
980 TypePrinter->print(V->getType(), Out);
982 WriteAsOperandInternal(Out, Node->getOperand(mi),
983 TypePrinter, Machine, Context);
993 /// WriteAsOperand - Write the name of the specified value out to the specified
994 /// ostream. This can be useful when you just want to print int %reg126, not
995 /// the whole instruction that generated it.
997 static void WriteAsOperandInternal(raw_ostream &Out, const Value *V,
998 TypePrinting *TypePrinter,
999 SlotTracker *Machine,
1000 const Module *Context) {
1002 PrintLLVMName(Out, V);
1006 const Constant *CV = dyn_cast<Constant>(V);
1007 if (CV && !isa<GlobalValue>(CV)) {
1008 assert(TypePrinter && "Constants require TypePrinting!");
1009 WriteConstantInternal(Out, CV, *TypePrinter, Machine, Context);
1013 if (const InlineAsm *IA = dyn_cast<InlineAsm>(V)) {
1015 if (IA->hasSideEffects())
1016 Out << "sideeffect ";
1017 if (IA->isAlignStack())
1018 Out << "alignstack ";
1020 PrintEscapedString(IA->getAsmString(), Out);
1022 PrintEscapedString(IA->getConstraintString(), Out);
1027 if (const MDNode *N = dyn_cast<MDNode>(V)) {
1028 if (N->isFunctionLocal()) {
1029 // Print metadata inline, not via slot reference number.
1030 WriteMDNodeBodyInternal(Out, N, TypePrinter, Machine, Context);
1035 if (N->isFunctionLocal())
1036 Machine = new SlotTracker(N->getFunction());
1038 Machine = new SlotTracker(Context);
1040 int Slot = Machine->getMetadataSlot(N);
1048 if (const MDString *MDS = dyn_cast<MDString>(V)) {
1050 PrintEscapedString(MDS->getString(), Out);
1055 if (V->getValueID() == Value::PseudoSourceValueVal ||
1056 V->getValueID() == Value::FixedStackPseudoSourceValueVal) {
1063 // If we have a SlotTracker, use it.
1065 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
1066 Slot = Machine->getGlobalSlot(GV);
1069 Slot = Machine->getLocalSlot(V);
1071 // If the local value didn't succeed, then we may be referring to a value
1072 // from a different function. Translate it, as this can happen when using
1073 // address of blocks.
1075 if ((Machine = createSlotTracker(V))) {
1076 Slot = Machine->getLocalSlot(V);
1080 } else if ((Machine = createSlotTracker(V))) {
1081 // Otherwise, create one to get the # and then destroy it.
1082 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
1083 Slot = Machine->getGlobalSlot(GV);
1086 Slot = Machine->getLocalSlot(V);
1095 Out << Prefix << Slot;
1100 void llvm::WriteAsOperand(raw_ostream &Out, const Value *V,
1101 bool PrintType, const Module *Context) {
1103 // Fast path: Don't construct and populate a TypePrinting object if we
1104 // won't be needing any types printed.
1106 ((!isa<Constant>(V) && !isa<MDNode>(V)) ||
1107 V->hasName() || isa<GlobalValue>(V))) {
1108 WriteAsOperandInternal(Out, V, 0, 0, Context);
1112 if (Context == 0) Context = getModuleFromVal(V);
1114 TypePrinting TypePrinter;
1116 TypePrinter.incorporateTypes(*Context);
1118 TypePrinter.print(V->getType(), Out);
1122 WriteAsOperandInternal(Out, V, &TypePrinter, 0, Context);
1127 class AssemblyWriter {
1128 formatted_raw_ostream &Out;
1129 SlotTracker &Machine;
1130 const Module *TheModule;
1131 TypePrinting TypePrinter;
1132 AssemblyAnnotationWriter *AnnotationWriter;
1135 inline AssemblyWriter(formatted_raw_ostream &o, SlotTracker &Mac,
1137 AssemblyAnnotationWriter *AAW)
1138 : Out(o), Machine(Mac), TheModule(M), AnnotationWriter(AAW) {
1140 TypePrinter.incorporateTypes(*M);
1143 void printMDNodeBody(const MDNode *MD);
1144 void printNamedMDNode(const NamedMDNode *NMD);
1146 void printModule(const Module *M);
1148 void writeOperand(const Value *Op, bool PrintType);
1149 void writeParamOperand(const Value *Operand, Attributes Attrs);
1150 void writeAtomic(AtomicOrdering Ordering, SynchronizationScope SynchScope);
1152 void writeAllMDNodes();
1154 void printTypeIdentities();
1155 void printGlobal(const GlobalVariable *GV);
1156 void printAlias(const GlobalAlias *GV);
1157 void printFunction(const Function *F);
1158 void printArgument(const Argument *FA, Attributes Attrs);
1159 void printBasicBlock(const BasicBlock *BB);
1160 void printInstruction(const Instruction &I);
1163 // printInfoComment - Print a little comment after the instruction indicating
1164 // which slot it occupies.
1165 void printInfoComment(const Value &V);
1167 } // end of anonymous namespace
1169 void AssemblyWriter::writeOperand(const Value *Operand, bool PrintType) {
1171 Out << "<null operand!>";
1175 TypePrinter.print(Operand->getType(), Out);
1178 WriteAsOperandInternal(Out, Operand, &TypePrinter, &Machine, TheModule);
1181 void AssemblyWriter::writeAtomic(AtomicOrdering Ordering,
1182 SynchronizationScope SynchScope) {
1183 if (Ordering == NotAtomic)
1186 switch (SynchScope) {
1187 case SingleThread: Out << " singlethread"; break;
1188 case CrossThread: break;
1192 default: Out << " <bad ordering " << int(Ordering) << ">"; break;
1193 case Unordered: Out << " unordered"; break;
1194 case Monotonic: Out << " monotonic"; break;
1195 case Acquire: Out << " acquire"; break;
1196 case Release: Out << " release"; break;
1197 case AcquireRelease: Out << " acq_rel"; break;
1198 case SequentiallyConsistent: Out << " seq_cst"; break;
1202 void AssemblyWriter::writeParamOperand(const Value *Operand,
1205 Out << "<null operand!>";
1210 TypePrinter.print(Operand->getType(), Out);
1211 // Print parameter attributes list
1212 if (Attrs != Attribute::None)
1213 Out << ' ' << Attribute::getAsString(Attrs);
1215 // Print the operand
1216 WriteAsOperandInternal(Out, Operand, &TypePrinter, &Machine, TheModule);
1219 void AssemblyWriter::printModule(const Module *M) {
1220 if (!M->getModuleIdentifier().empty() &&
1221 // Don't print the ID if it will start a new line (which would
1222 // require a comment char before it).
1223 M->getModuleIdentifier().find('\n') == std::string::npos)
1224 Out << "; ModuleID = '" << M->getModuleIdentifier() << "'\n";
1226 if (!M->getDataLayout().empty())
1227 Out << "target datalayout = \"" << M->getDataLayout() << "\"\n";
1228 if (!M->getTargetTriple().empty())
1229 Out << "target triple = \"" << M->getTargetTriple() << "\"\n";
1231 if (!M->getModuleInlineAsm().empty()) {
1232 // Split the string into lines, to make it easier to read the .ll file.
1233 std::string Asm = M->getModuleInlineAsm();
1235 size_t NewLine = Asm.find_first_of('\n', CurPos);
1237 while (NewLine != std::string::npos) {
1238 // We found a newline, print the portion of the asm string from the
1239 // last newline up to this newline.
1240 Out << "module asm \"";
1241 PrintEscapedString(std::string(Asm.begin()+CurPos, Asm.begin()+NewLine),
1245 NewLine = Asm.find_first_of('\n', CurPos);
1247 std::string rest(Asm.begin()+CurPos, Asm.end());
1248 if (!rest.empty()) {
1249 Out << "module asm \"";
1250 PrintEscapedString(rest, Out);
1255 // Loop over the dependent libraries and emit them.
1256 Module::lib_iterator LI = M->lib_begin();
1257 Module::lib_iterator LE = M->lib_end();
1260 Out << "deplibs = [ ";
1262 Out << '"' << *LI << '"';
1270 printTypeIdentities();
1272 // Output all globals.
1273 if (!M->global_empty()) Out << '\n';
1274 for (Module::const_global_iterator I = M->global_begin(), E = M->global_end();
1278 // Output all aliases.
1279 if (!M->alias_empty()) Out << "\n";
1280 for (Module::const_alias_iterator I = M->alias_begin(), E = M->alias_end();
1284 // Output all of the functions.
1285 for (Module::const_iterator I = M->begin(), E = M->end(); I != E; ++I)
1288 // Output named metadata.
1289 if (!M->named_metadata_empty()) Out << '\n';
1291 for (Module::const_named_metadata_iterator I = M->named_metadata_begin(),
1292 E = M->named_metadata_end(); I != E; ++I)
1293 printNamedMDNode(I);
1296 if (!Machine.mdn_empty()) {
1302 void AssemblyWriter::printNamedMDNode(const NamedMDNode *NMD) {
1304 StringRef Name = NMD->getName();
1306 Out << "<empty name> ";
1308 if (isalpha(Name[0]) || Name[0] == '-' || Name[0] == '$' ||
1309 Name[0] == '.' || Name[0] == '_')
1312 Out << '\\' << hexdigit(Name[0] >> 4) << hexdigit(Name[0] & 0x0F);
1313 for (unsigned i = 1, e = Name.size(); i != e; ++i) {
1314 unsigned char C = Name[i];
1315 if (isalnum(C) || C == '-' || C == '$' || C == '.' || C == '_')
1318 Out << '\\' << hexdigit(C >> 4) << hexdigit(C & 0x0F);
1322 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
1324 int Slot = Machine.getMetadataSlot(NMD->getOperand(i));
1334 static void PrintLinkage(GlobalValue::LinkageTypes LT,
1335 formatted_raw_ostream &Out) {
1337 case GlobalValue::ExternalLinkage: break;
1338 case GlobalValue::PrivateLinkage: Out << "private "; break;
1339 case GlobalValue::LinkerPrivateLinkage: Out << "linker_private "; break;
1340 case GlobalValue::LinkerPrivateWeakLinkage:
1341 Out << "linker_private_weak ";
1343 case GlobalValue::LinkerPrivateWeakDefAutoLinkage:
1344 Out << "linker_private_weak_def_auto ";
1346 case GlobalValue::InternalLinkage: Out << "internal "; break;
1347 case GlobalValue::LinkOnceAnyLinkage: Out << "linkonce "; break;
1348 case GlobalValue::LinkOnceODRLinkage: Out << "linkonce_odr "; break;
1349 case GlobalValue::WeakAnyLinkage: Out << "weak "; break;
1350 case GlobalValue::WeakODRLinkage: Out << "weak_odr "; break;
1351 case GlobalValue::CommonLinkage: Out << "common "; break;
1352 case GlobalValue::AppendingLinkage: Out << "appending "; break;
1353 case GlobalValue::DLLImportLinkage: Out << "dllimport "; break;
1354 case GlobalValue::DLLExportLinkage: Out << "dllexport "; break;
1355 case GlobalValue::ExternalWeakLinkage: Out << "extern_weak "; break;
1356 case GlobalValue::AvailableExternallyLinkage:
1357 Out << "available_externally ";
1363 static void PrintVisibility(GlobalValue::VisibilityTypes Vis,
1364 formatted_raw_ostream &Out) {
1366 case GlobalValue::DefaultVisibility: break;
1367 case GlobalValue::HiddenVisibility: Out << "hidden "; break;
1368 case GlobalValue::ProtectedVisibility: Out << "protected "; break;
1372 void AssemblyWriter::printGlobal(const GlobalVariable *GV) {
1373 if (GV->isMaterializable())
1374 Out << "; Materializable\n";
1376 WriteAsOperandInternal(Out, GV, &TypePrinter, &Machine, GV->getParent());
1379 if (!GV->hasInitializer() && GV->hasExternalLinkage())
1382 PrintLinkage(GV->getLinkage(), Out);
1383 PrintVisibility(GV->getVisibility(), Out);
1385 if (GV->isThreadLocal()) Out << "thread_local ";
1386 if (unsigned AddressSpace = GV->getType()->getAddressSpace())
1387 Out << "addrspace(" << AddressSpace << ") ";
1388 if (GV->hasUnnamedAddr()) Out << "unnamed_addr ";
1389 Out << (GV->isConstant() ? "constant " : "global ");
1390 TypePrinter.print(GV->getType()->getElementType(), Out);
1392 if (GV->hasInitializer()) {
1394 writeOperand(GV->getInitializer(), false);
1397 if (GV->hasSection()) {
1398 Out << ", section \"";
1399 PrintEscapedString(GV->getSection(), Out);
1402 if (GV->getAlignment())
1403 Out << ", align " << GV->getAlignment();
1405 printInfoComment(*GV);
1409 void AssemblyWriter::printAlias(const GlobalAlias *GA) {
1410 if (GA->isMaterializable())
1411 Out << "; Materializable\n";
1413 // Don't crash when dumping partially built GA
1415 Out << "<<nameless>> = ";
1417 PrintLLVMName(Out, GA);
1420 PrintVisibility(GA->getVisibility(), Out);
1424 PrintLinkage(GA->getLinkage(), Out);
1426 const Constant *Aliasee = GA->getAliasee();
1429 TypePrinter.print(GA->getType(), Out);
1430 Out << " <<NULL ALIASEE>>";
1432 writeOperand(Aliasee, !isa<ConstantExpr>(Aliasee));
1435 printInfoComment(*GA);
1439 void AssemblyWriter::printTypeIdentities() {
1440 if (TypePrinter.NumberedTypes.empty() &&
1441 TypePrinter.NamedTypes.empty())
1446 // We know all the numbers that each type is used and we know that it is a
1447 // dense assignment. Convert the map to an index table.
1448 std::vector<StructType*> NumberedTypes(TypePrinter.NumberedTypes.size());
1449 for (DenseMap<StructType*, unsigned>::iterator I =
1450 TypePrinter.NumberedTypes.begin(), E = TypePrinter.NumberedTypes.end();
1452 assert(I->second < NumberedTypes.size() && "Didn't get a dense numbering?");
1453 NumberedTypes[I->second] = I->first;
1456 // Emit all numbered types.
1457 for (unsigned i = 0, e = NumberedTypes.size(); i != e; ++i) {
1458 Out << '%' << i << " = type ";
1460 // Make sure we print out at least one level of the type structure, so
1461 // that we do not get %2 = type %2
1462 TypePrinter.printStructBody(NumberedTypes[i], Out);
1466 for (unsigned i = 0, e = TypePrinter.NamedTypes.size(); i != e; ++i) {
1467 PrintLLVMName(Out, TypePrinter.NamedTypes[i]->getName(), LocalPrefix);
1470 // Make sure we print out at least one level of the type structure, so
1471 // that we do not get %FILE = type %FILE
1472 TypePrinter.printStructBody(TypePrinter.NamedTypes[i], Out);
1477 /// printFunction - Print all aspects of a function.
1479 void AssemblyWriter::printFunction(const Function *F) {
1480 // Print out the return type and name.
1483 if (AnnotationWriter) AnnotationWriter->emitFunctionAnnot(F, Out);
1485 if (F->isMaterializable())
1486 Out << "; Materializable\n";
1488 if (F->isDeclaration())
1493 PrintLinkage(F->getLinkage(), Out);
1494 PrintVisibility(F->getVisibility(), Out);
1496 // Print the calling convention.
1497 switch (F->getCallingConv()) {
1498 case CallingConv::C: break; // default
1499 case CallingConv::Fast: Out << "fastcc "; break;
1500 case CallingConv::Cold: Out << "coldcc "; break;
1501 case CallingConv::X86_StdCall: Out << "x86_stdcallcc "; break;
1502 case CallingConv::X86_FastCall: Out << "x86_fastcallcc "; break;
1503 case CallingConv::X86_ThisCall: Out << "x86_thiscallcc "; break;
1504 case CallingConv::ARM_APCS: Out << "arm_apcscc "; break;
1505 case CallingConv::ARM_AAPCS: Out << "arm_aapcscc "; break;
1506 case CallingConv::ARM_AAPCS_VFP:Out << "arm_aapcs_vfpcc "; break;
1507 case CallingConv::MSP430_INTR: Out << "msp430_intrcc "; break;
1508 case CallingConv::PTX_Kernel: Out << "ptx_kernel "; break;
1509 case CallingConv::PTX_Device: Out << "ptx_device "; break;
1510 default: Out << "cc" << F->getCallingConv() << " "; break;
1513 FunctionType *FT = F->getFunctionType();
1514 const AttrListPtr &Attrs = F->getAttributes();
1515 Attributes RetAttrs = Attrs.getRetAttributes();
1516 if (RetAttrs != Attribute::None)
1517 Out << Attribute::getAsString(Attrs.getRetAttributes()) << ' ';
1518 TypePrinter.print(F->getReturnType(), Out);
1520 WriteAsOperandInternal(Out, F, &TypePrinter, &Machine, F->getParent());
1522 Machine.incorporateFunction(F);
1524 // Loop over the arguments, printing them...
1527 if (!F->isDeclaration()) {
1528 // If this isn't a declaration, print the argument names as well.
1529 for (Function::const_arg_iterator I = F->arg_begin(), E = F->arg_end();
1531 // Insert commas as we go... the first arg doesn't get a comma
1532 if (I != F->arg_begin()) Out << ", ";
1533 printArgument(I, Attrs.getParamAttributes(Idx));
1537 // Otherwise, print the types from the function type.
1538 for (unsigned i = 0, e = FT->getNumParams(); i != e; ++i) {
1539 // Insert commas as we go... the first arg doesn't get a comma
1543 TypePrinter.print(FT->getParamType(i), Out);
1545 Attributes ArgAttrs = Attrs.getParamAttributes(i+1);
1546 if (ArgAttrs != Attribute::None)
1547 Out << ' ' << Attribute::getAsString(ArgAttrs);
1551 // Finish printing arguments...
1552 if (FT->isVarArg()) {
1553 if (FT->getNumParams()) Out << ", ";
1554 Out << "..."; // Output varargs portion of signature!
1557 if (F->hasUnnamedAddr())
1558 Out << " unnamed_addr";
1559 Attributes FnAttrs = Attrs.getFnAttributes();
1560 if (FnAttrs != Attribute::None)
1561 Out << ' ' << Attribute::getAsString(Attrs.getFnAttributes());
1562 if (F->hasSection()) {
1563 Out << " section \"";
1564 PrintEscapedString(F->getSection(), Out);
1567 if (F->getAlignment())
1568 Out << " align " << F->getAlignment();
1570 Out << " gc \"" << F->getGC() << '"';
1571 if (F->isDeclaration()) {
1575 // Output all of the function's basic blocks.
1576 for (Function::const_iterator I = F->begin(), E = F->end(); I != E; ++I)
1582 Machine.purgeFunction();
1585 /// printArgument - This member is called for every argument that is passed into
1586 /// the function. Simply print it out
1588 void AssemblyWriter::printArgument(const Argument *Arg,
1591 TypePrinter.print(Arg->getType(), Out);
1593 // Output parameter attributes list
1594 if (Attrs != Attribute::None)
1595 Out << ' ' << Attribute::getAsString(Attrs);
1597 // Output name, if available...
1598 if (Arg->hasName()) {
1600 PrintLLVMName(Out, Arg);
1604 /// printBasicBlock - This member is called for each basic block in a method.
1606 void AssemblyWriter::printBasicBlock(const BasicBlock *BB) {
1607 if (BB->hasName()) { // Print out the label if it exists...
1609 PrintLLVMName(Out, BB->getName(), LabelPrefix);
1611 } else if (!BB->use_empty()) { // Don't print block # of no uses...
1612 Out << "\n; <label>:";
1613 int Slot = Machine.getLocalSlot(BB);
1620 if (BB->getParent() == 0) {
1621 Out.PadToColumn(50);
1622 Out << "; Error: Block without parent!";
1623 } else if (BB != &BB->getParent()->getEntryBlock()) { // Not the entry block?
1624 // Output predecessors for the block.
1625 Out.PadToColumn(50);
1627 const_pred_iterator PI = pred_begin(BB), PE = pred_end(BB);
1630 Out << " No predecessors!";
1633 writeOperand(*PI, false);
1634 for (++PI; PI != PE; ++PI) {
1636 writeOperand(*PI, false);
1643 if (AnnotationWriter) AnnotationWriter->emitBasicBlockStartAnnot(BB, Out);
1645 // Output all of the instructions in the basic block...
1646 for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I != E; ++I) {
1647 printInstruction(*I);
1651 if (AnnotationWriter) AnnotationWriter->emitBasicBlockEndAnnot(BB, Out);
1654 /// printInfoComment - Print a little comment after the instruction indicating
1655 /// which slot it occupies.
1657 void AssemblyWriter::printInfoComment(const Value &V) {
1658 if (AnnotationWriter) {
1659 AnnotationWriter->printInfoComment(V, Out);
1664 // This member is called for each Instruction in a function..
1665 void AssemblyWriter::printInstruction(const Instruction &I) {
1666 if (AnnotationWriter) AnnotationWriter->emitInstructionAnnot(&I, Out);
1668 // Print out indentation for an instruction.
1671 // Print out name if it exists...
1673 PrintLLVMName(Out, &I);
1675 } else if (!I.getType()->isVoidTy()) {
1676 // Print out the def slot taken.
1677 int SlotNum = Machine.getLocalSlot(&I);
1679 Out << "<badref> = ";
1681 Out << '%' << SlotNum << " = ";
1684 if (isa<CallInst>(I) && cast<CallInst>(I).isTailCall())
1687 // Print out the opcode...
1688 Out << I.getOpcodeName();
1690 // If this is an atomic load or store, print out the atomic marker.
1691 if ((isa<LoadInst>(I) && cast<LoadInst>(I).isAtomic()) ||
1692 (isa<StoreInst>(I) && cast<StoreInst>(I).isAtomic()))
1695 // If this is a volatile operation, print out the volatile marker.
1696 if ((isa<LoadInst>(I) && cast<LoadInst>(I).isVolatile()) ||
1697 (isa<StoreInst>(I) && cast<StoreInst>(I).isVolatile()) ||
1698 (isa<AtomicCmpXchgInst>(I) && cast<AtomicCmpXchgInst>(I).isVolatile()) ||
1699 (isa<AtomicRMWInst>(I) && cast<AtomicRMWInst>(I).isVolatile()))
1702 // Print out optimization information.
1703 WriteOptimizationInfo(Out, &I);
1705 // Print out the compare instruction predicates
1706 if (const CmpInst *CI = dyn_cast<CmpInst>(&I))
1707 Out << ' ' << getPredicateText(CI->getPredicate());
1709 // Print out the atomicrmw operation
1710 if (const AtomicRMWInst *RMWI = dyn_cast<AtomicRMWInst>(&I))
1711 writeAtomicRMWOperation(Out, RMWI->getOperation());
1713 // Print out the type of the operands...
1714 const Value *Operand = I.getNumOperands() ? I.getOperand(0) : 0;
1716 // Special case conditional branches to swizzle the condition out to the front
1717 if (isa<BranchInst>(I) && cast<BranchInst>(I).isConditional()) {
1718 BranchInst &BI(cast<BranchInst>(I));
1720 writeOperand(BI.getCondition(), true);
1722 writeOperand(BI.getSuccessor(0), true);
1724 writeOperand(BI.getSuccessor(1), true);
1726 } else if (isa<SwitchInst>(I)) {
1727 SwitchInst& SI(cast<SwitchInst>(I));
1728 // Special case switch instruction to get formatting nice and correct.
1730 writeOperand(SI.getCondition(), true);
1732 writeOperand(SI.getDefaultDest(), true);
1734 for (SwitchInst::CaseIt i = SI.case_begin(), e = SI.case_end();
1737 writeOperand(i.getCaseValue(), true);
1739 writeOperand(i.getCaseSuccessor(), true);
1742 } else if (isa<IndirectBrInst>(I)) {
1743 // Special case indirectbr instruction to get formatting nice and correct.
1745 writeOperand(Operand, true);
1748 for (unsigned i = 1, e = I.getNumOperands(); i != e; ++i) {
1751 writeOperand(I.getOperand(i), true);
1754 } else if (const PHINode *PN = dyn_cast<PHINode>(&I)) {
1756 TypePrinter.print(I.getType(), Out);
1759 for (unsigned op = 0, Eop = PN->getNumIncomingValues(); op < Eop; ++op) {
1760 if (op) Out << ", ";
1762 writeOperand(PN->getIncomingValue(op), false); Out << ", ";
1763 writeOperand(PN->getIncomingBlock(op), false); Out << " ]";
1765 } else if (const ExtractValueInst *EVI = dyn_cast<ExtractValueInst>(&I)) {
1767 writeOperand(I.getOperand(0), true);
1768 for (const unsigned *i = EVI->idx_begin(), *e = EVI->idx_end(); i != e; ++i)
1770 } else if (const InsertValueInst *IVI = dyn_cast<InsertValueInst>(&I)) {
1772 writeOperand(I.getOperand(0), true); Out << ", ";
1773 writeOperand(I.getOperand(1), true);
1774 for (const unsigned *i = IVI->idx_begin(), *e = IVI->idx_end(); i != e; ++i)
1776 } else if (const LandingPadInst *LPI = dyn_cast<LandingPadInst>(&I)) {
1778 TypePrinter.print(I.getType(), Out);
1779 Out << " personality ";
1780 writeOperand(I.getOperand(0), true); Out << '\n';
1782 if (LPI->isCleanup())
1785 for (unsigned i = 0, e = LPI->getNumClauses(); i != e; ++i) {
1786 if (i != 0 || LPI->isCleanup()) Out << "\n";
1787 if (LPI->isCatch(i))
1792 writeOperand(LPI->getClause(i), true);
1794 } else if (isa<ReturnInst>(I) && !Operand) {
1796 } else if (const CallInst *CI = dyn_cast<CallInst>(&I)) {
1797 // Print the calling convention being used.
1798 switch (CI->getCallingConv()) {
1799 case CallingConv::C: break; // default
1800 case CallingConv::Fast: Out << " fastcc"; break;
1801 case CallingConv::Cold: Out << " coldcc"; break;
1802 case CallingConv::X86_StdCall: Out << " x86_stdcallcc"; break;
1803 case CallingConv::X86_FastCall: Out << " x86_fastcallcc"; break;
1804 case CallingConv::X86_ThisCall: Out << " x86_thiscallcc"; break;
1805 case CallingConv::ARM_APCS: Out << " arm_apcscc "; break;
1806 case CallingConv::ARM_AAPCS: Out << " arm_aapcscc "; break;
1807 case CallingConv::ARM_AAPCS_VFP:Out << " arm_aapcs_vfpcc "; break;
1808 case CallingConv::MSP430_INTR: Out << " msp430_intrcc "; break;
1809 case CallingConv::PTX_Kernel: Out << " ptx_kernel"; break;
1810 case CallingConv::PTX_Device: Out << " ptx_device"; break;
1811 default: Out << " cc" << CI->getCallingConv(); break;
1814 Operand = CI->getCalledValue();
1815 PointerType *PTy = cast<PointerType>(Operand->getType());
1816 FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
1817 Type *RetTy = FTy->getReturnType();
1818 const AttrListPtr &PAL = CI->getAttributes();
1820 if (PAL.getRetAttributes() != Attribute::None)
1821 Out << ' ' << Attribute::getAsString(PAL.getRetAttributes());
1823 // If possible, print out the short form of the call instruction. We can
1824 // only do this if the first argument is a pointer to a nonvararg function,
1825 // and if the return type is not a pointer to a function.
1828 if (!FTy->isVarArg() &&
1829 (!RetTy->isPointerTy() ||
1830 !cast<PointerType>(RetTy)->getElementType()->isFunctionTy())) {
1831 TypePrinter.print(RetTy, Out);
1833 writeOperand(Operand, false);
1835 writeOperand(Operand, true);
1838 for (unsigned op = 0, Eop = CI->getNumArgOperands(); op < Eop; ++op) {
1841 writeParamOperand(CI->getArgOperand(op), PAL.getParamAttributes(op + 1));
1844 if (PAL.getFnAttributes() != Attribute::None)
1845 Out << ' ' << Attribute::getAsString(PAL.getFnAttributes());
1846 } else if (const InvokeInst *II = dyn_cast<InvokeInst>(&I)) {
1847 Operand = II->getCalledValue();
1848 PointerType *PTy = cast<PointerType>(Operand->getType());
1849 FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
1850 Type *RetTy = FTy->getReturnType();
1851 const AttrListPtr &PAL = II->getAttributes();
1853 // Print the calling convention being used.
1854 switch (II->getCallingConv()) {
1855 case CallingConv::C: break; // default
1856 case CallingConv::Fast: Out << " fastcc"; break;
1857 case CallingConv::Cold: Out << " coldcc"; break;
1858 case CallingConv::X86_StdCall: Out << " x86_stdcallcc"; break;
1859 case CallingConv::X86_FastCall: Out << " x86_fastcallcc"; break;
1860 case CallingConv::X86_ThisCall: Out << " x86_thiscallcc"; break;
1861 case CallingConv::ARM_APCS: Out << " arm_apcscc "; break;
1862 case CallingConv::ARM_AAPCS: Out << " arm_aapcscc "; break;
1863 case CallingConv::ARM_AAPCS_VFP:Out << " arm_aapcs_vfpcc "; break;
1864 case CallingConv::MSP430_INTR: Out << " msp430_intrcc "; break;
1865 case CallingConv::PTX_Kernel: Out << " ptx_kernel"; break;
1866 case CallingConv::PTX_Device: Out << " ptx_device"; break;
1867 default: Out << " cc" << II->getCallingConv(); break;
1870 if (PAL.getRetAttributes() != Attribute::None)
1871 Out << ' ' << Attribute::getAsString(PAL.getRetAttributes());
1873 // If possible, print out the short form of the invoke instruction. We can
1874 // only do this if the first argument is a pointer to a nonvararg function,
1875 // and if the return type is not a pointer to a function.
1878 if (!FTy->isVarArg() &&
1879 (!RetTy->isPointerTy() ||
1880 !cast<PointerType>(RetTy)->getElementType()->isFunctionTy())) {
1881 TypePrinter.print(RetTy, Out);
1883 writeOperand(Operand, false);
1885 writeOperand(Operand, true);
1888 for (unsigned op = 0, Eop = II->getNumArgOperands(); op < Eop; ++op) {
1891 writeParamOperand(II->getArgOperand(op), PAL.getParamAttributes(op + 1));
1895 if (PAL.getFnAttributes() != Attribute::None)
1896 Out << ' ' << Attribute::getAsString(PAL.getFnAttributes());
1899 writeOperand(II->getNormalDest(), true);
1901 writeOperand(II->getUnwindDest(), true);
1903 } else if (const AllocaInst *AI = dyn_cast<AllocaInst>(&I)) {
1905 TypePrinter.print(AI->getType()->getElementType(), Out);
1906 if (!AI->getArraySize() || AI->isArrayAllocation()) {
1908 writeOperand(AI->getArraySize(), true);
1910 if (AI->getAlignment()) {
1911 Out << ", align " << AI->getAlignment();
1913 } else if (isa<CastInst>(I)) {
1916 writeOperand(Operand, true); // Work with broken code
1919 TypePrinter.print(I.getType(), Out);
1920 } else if (isa<VAArgInst>(I)) {
1923 writeOperand(Operand, true); // Work with broken code
1926 TypePrinter.print(I.getType(), Out);
1927 } else if (Operand) { // Print the normal way.
1929 // PrintAllTypes - Instructions who have operands of all the same type
1930 // omit the type from all but the first operand. If the instruction has
1931 // different type operands (for example br), then they are all printed.
1932 bool PrintAllTypes = false;
1933 Type *TheType = Operand->getType();
1935 // Select, Store and ShuffleVector always print all types.
1936 if (isa<SelectInst>(I) || isa<StoreInst>(I) || isa<ShuffleVectorInst>(I)
1937 || isa<ReturnInst>(I)) {
1938 PrintAllTypes = true;
1940 for (unsigned i = 1, E = I.getNumOperands(); i != E; ++i) {
1941 Operand = I.getOperand(i);
1942 // note that Operand shouldn't be null, but the test helps make dump()
1943 // more tolerant of malformed IR
1944 if (Operand && Operand->getType() != TheType) {
1945 PrintAllTypes = true; // We have differing types! Print them all!
1951 if (!PrintAllTypes) {
1953 TypePrinter.print(TheType, Out);
1957 for (unsigned i = 0, E = I.getNumOperands(); i != E; ++i) {
1959 writeOperand(I.getOperand(i), PrintAllTypes);
1963 // Print atomic ordering/alignment for memory operations
1964 if (const LoadInst *LI = dyn_cast<LoadInst>(&I)) {
1966 writeAtomic(LI->getOrdering(), LI->getSynchScope());
1967 if (LI->getAlignment())
1968 Out << ", align " << LI->getAlignment();
1969 } else if (const StoreInst *SI = dyn_cast<StoreInst>(&I)) {
1971 writeAtomic(SI->getOrdering(), SI->getSynchScope());
1972 if (SI->getAlignment())
1973 Out << ", align " << SI->getAlignment();
1974 } else if (const AtomicCmpXchgInst *CXI = dyn_cast<AtomicCmpXchgInst>(&I)) {
1975 writeAtomic(CXI->getOrdering(), CXI->getSynchScope());
1976 } else if (const AtomicRMWInst *RMWI = dyn_cast<AtomicRMWInst>(&I)) {
1977 writeAtomic(RMWI->getOrdering(), RMWI->getSynchScope());
1978 } else if (const FenceInst *FI = dyn_cast<FenceInst>(&I)) {
1979 writeAtomic(FI->getOrdering(), FI->getSynchScope());
1982 // Print Metadata info.
1983 SmallVector<std::pair<unsigned, MDNode*>, 4> InstMD;
1984 I.getAllMetadata(InstMD);
1985 if (!InstMD.empty()) {
1986 SmallVector<StringRef, 8> MDNames;
1987 I.getType()->getContext().getMDKindNames(MDNames);
1988 for (unsigned i = 0, e = InstMD.size(); i != e; ++i) {
1989 unsigned Kind = InstMD[i].first;
1990 if (Kind < MDNames.size()) {
1991 Out << ", !" << MDNames[Kind];
1993 Out << ", !<unknown kind #" << Kind << ">";
1996 WriteAsOperandInternal(Out, InstMD[i].second, &TypePrinter, &Machine,
2000 printInfoComment(I);
2003 static void WriteMDNodeComment(const MDNode *Node,
2004 formatted_raw_ostream &Out) {
2005 if (Node->getNumOperands() < 1)
2007 ConstantInt *CI = dyn_cast_or_null<ConstantInt>(Node->getOperand(0));
2009 APInt Val = CI->getValue();
2010 APInt Tag = Val & ~APInt(Val.getBitWidth(), LLVMDebugVersionMask);
2011 if (Val.ult(LLVMDebugVersion11))
2014 Out.PadToColumn(50);
2015 if (Tag == dwarf::DW_TAG_user_base)
2016 Out << "; [ DW_TAG_user_base ]";
2017 else if (Tag.isIntN(32)) {
2018 if (const char *TagName = dwarf::TagString(Tag.getZExtValue()))
2019 Out << "; [ " << TagName << " ]";
2023 void AssemblyWriter::writeAllMDNodes() {
2024 SmallVector<const MDNode *, 16> Nodes;
2025 Nodes.resize(Machine.mdn_size());
2026 for (SlotTracker::mdn_iterator I = Machine.mdn_begin(), E = Machine.mdn_end();
2028 Nodes[I->second] = cast<MDNode>(I->first);
2030 for (unsigned i = 0, e = Nodes.size(); i != e; ++i) {
2031 Out << '!' << i << " = metadata ";
2032 printMDNodeBody(Nodes[i]);
2036 void AssemblyWriter::printMDNodeBody(const MDNode *Node) {
2037 WriteMDNodeBodyInternal(Out, Node, &TypePrinter, &Machine, TheModule);
2038 WriteMDNodeComment(Node, Out);
2042 //===----------------------------------------------------------------------===//
2043 // External Interface declarations
2044 //===----------------------------------------------------------------------===//
2046 void Module::print(raw_ostream &ROS, AssemblyAnnotationWriter *AAW) const {
2047 SlotTracker SlotTable(this);
2048 formatted_raw_ostream OS(ROS);
2049 AssemblyWriter W(OS, SlotTable, this, AAW);
2050 W.printModule(this);
2053 void NamedMDNode::print(raw_ostream &ROS, AssemblyAnnotationWriter *AAW) const {
2054 SlotTracker SlotTable(getParent());
2055 formatted_raw_ostream OS(ROS);
2056 AssemblyWriter W(OS, SlotTable, getParent(), AAW);
2057 W.printNamedMDNode(this);
2060 void Type::print(raw_ostream &OS) const {
2062 OS << "<null Type>";
2066 TP.print(const_cast<Type*>(this), OS);
2068 // If the type is a named struct type, print the body as well.
2069 if (StructType *STy = dyn_cast<StructType>(const_cast<Type*>(this)))
2070 if (!STy->isLiteral()) {
2072 TP.printStructBody(STy, OS);
2076 void Value::print(raw_ostream &ROS, AssemblyAnnotationWriter *AAW) const {
2078 ROS << "printing a <null> value\n";
2081 formatted_raw_ostream OS(ROS);
2082 if (const Instruction *I = dyn_cast<Instruction>(this)) {
2083 const Function *F = I->getParent() ? I->getParent()->getParent() : 0;
2084 SlotTracker SlotTable(F);
2085 AssemblyWriter W(OS, SlotTable, getModuleFromVal(I), AAW);
2086 W.printInstruction(*I);
2087 } else if (const BasicBlock *BB = dyn_cast<BasicBlock>(this)) {
2088 SlotTracker SlotTable(BB->getParent());
2089 AssemblyWriter W(OS, SlotTable, getModuleFromVal(BB), AAW);
2090 W.printBasicBlock(BB);
2091 } else if (const GlobalValue *GV = dyn_cast<GlobalValue>(this)) {
2092 SlotTracker SlotTable(GV->getParent());
2093 AssemblyWriter W(OS, SlotTable, GV->getParent(), AAW);
2094 if (const GlobalVariable *V = dyn_cast<GlobalVariable>(GV))
2096 else if (const Function *F = dyn_cast<Function>(GV))
2099 W.printAlias(cast<GlobalAlias>(GV));
2100 } else if (const MDNode *N = dyn_cast<MDNode>(this)) {
2101 const Function *F = N->getFunction();
2102 SlotTracker SlotTable(F);
2103 AssemblyWriter W(OS, SlotTable, F ? F->getParent() : 0, AAW);
2104 W.printMDNodeBody(N);
2105 } else if (const Constant *C = dyn_cast<Constant>(this)) {
2106 TypePrinting TypePrinter;
2107 TypePrinter.print(C->getType(), OS);
2109 WriteConstantInternal(OS, C, TypePrinter, 0, 0);
2110 } else if (isa<InlineAsm>(this) || isa<MDString>(this) ||
2111 isa<Argument>(this)) {
2112 WriteAsOperand(OS, this, true, 0);
2114 // Otherwise we don't know what it is. Call the virtual function to
2115 // allow a subclass to print itself.
2120 // Value::printCustom - subclasses should override this to implement printing.
2121 void Value::printCustom(raw_ostream &OS) const {
2122 llvm_unreachable("Unknown value to print out!");
2125 // Value::dump - allow easy printing of Values from the debugger.
2126 void Value::dump() const { print(dbgs()); dbgs() << '\n'; }
2128 // Type::dump - allow easy printing of Types from the debugger.
2129 void Type::dump() const { print(dbgs()); }
2131 // Module::dump() - Allow printing of Modules from the debugger.
2132 void Module::dump() const { print(dbgs(), 0); }
2134 // NamedMDNode::dump() - Allow printing of NamedMDNodes from the debugger.
2135 void NamedMDNode::dump() const { print(dbgs(), 0); }