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/IR/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 "AsmWriter.h"
18 #include "llvm/ADT/DenseMap.h"
19 #include "llvm/ADT/STLExtras.h"
20 #include "llvm/ADT/SmallString.h"
21 #include "llvm/ADT/StringExtras.h"
22 #include "llvm/IR/AssemblyAnnotationWriter.h"
23 #include "llvm/IR/CFG.h"
24 #include "llvm/IR/CallingConv.h"
25 #include "llvm/IR/Constants.h"
26 #include "llvm/IR/DebugInfo.h"
27 #include "llvm/IR/DerivedTypes.h"
28 #include "llvm/IR/IRPrintingPasses.h"
29 #include "llvm/IR/InlineAsm.h"
30 #include "llvm/IR/IntrinsicInst.h"
31 #include "llvm/IR/LLVMContext.h"
32 #include "llvm/IR/Module.h"
33 #include "llvm/IR/Operator.h"
34 #include "llvm/IR/TypeFinder.h"
35 #include "llvm/IR/ValueSymbolTable.h"
36 #include "llvm/Support/Debug.h"
37 #include "llvm/Support/Dwarf.h"
38 #include "llvm/Support/ErrorHandling.h"
39 #include "llvm/Support/FormattedStream.h"
40 #include "llvm/Support/MathExtras.h"
45 // Make virtual table appear in this compilation unit.
46 AssemblyAnnotationWriter::~AssemblyAnnotationWriter() {}
48 //===----------------------------------------------------------------------===//
50 //===----------------------------------------------------------------------===//
54 DenseMap<const Value *, std::pair<unsigned, bool>> IDs;
56 unsigned size() const { return IDs.size(); }
57 std::pair<unsigned, bool> &operator[](const Value *V) { return IDs[V]; }
58 std::pair<unsigned, bool> lookup(const Value *V) const {
61 void index(const Value *V) {
62 // Explicitly sequence get-size and insert-value operations to avoid UB.
63 unsigned ID = IDs.size() + 1;
69 static void orderValue(const Value *V, OrderMap &OM) {
70 if (OM.lookup(V).first)
73 if (const Constant *C = dyn_cast<Constant>(V))
74 if (C->getNumOperands() && !isa<GlobalValue>(C))
75 for (const Value *Op : C->operands())
76 if (!isa<BasicBlock>(Op) && !isa<GlobalValue>(Op))
79 // Note: we cannot cache this lookup above, since inserting into the map
80 // changes the map's size, and thus affects the other IDs.
84 static OrderMap orderModule(const Module *M) {
85 // This needs to match the order used by ValueEnumerator::ValueEnumerator()
86 // and ValueEnumerator::incorporateFunction().
89 for (const GlobalVariable &G : M->globals()) {
90 if (G.hasInitializer())
91 if (!isa<GlobalValue>(G.getInitializer()))
92 orderValue(G.getInitializer(), OM);
95 for (const GlobalAlias &A : M->aliases()) {
96 if (!isa<GlobalValue>(A.getAliasee()))
97 orderValue(A.getAliasee(), OM);
100 for (const Function &F : *M) {
101 if (F.hasPrefixData())
102 if (!isa<GlobalValue>(F.getPrefixData()))
103 orderValue(F.getPrefixData(), OM);
106 if (F.isDeclaration())
109 for (const Argument &A : F.args())
111 for (const BasicBlock &BB : F) {
113 for (const Instruction &I : BB) {
114 for (const Value *Op : I.operands())
115 if ((isa<Constant>(*Op) && !isa<GlobalValue>(*Op)) ||
125 static void predictValueUseListOrderImpl(const Value *V, const Function *F,
126 unsigned ID, const OrderMap &OM,
127 UseListOrderStack &Stack) {
128 // Predict use-list order for this one.
129 typedef std::pair<const Use *, unsigned> Entry;
130 SmallVector<Entry, 64> List;
131 for (const Use &U : V->uses())
132 // Check if this user will be serialized.
133 if (OM.lookup(U.getUser()).first)
134 List.push_back(std::make_pair(&U, List.size()));
137 // We may have lost some users.
141 !isa<GlobalVariable>(V) && !isa<Function>(V) && !isa<BasicBlock>(V);
142 if (auto *BA = dyn_cast<BlockAddress>(V))
143 ID = OM.lookup(BA->getBasicBlock()).first;
144 std::sort(List.begin(), List.end(), [&](const Entry &L, const Entry &R) {
145 const Use *LU = L.first;
146 const Use *RU = R.first;
150 auto LID = OM.lookup(LU->getUser()).first;
151 auto RID = OM.lookup(RU->getUser()).first;
153 // If ID is 4, then expect: 7 6 5 1 2 3.
167 // LID and RID are equal, so we have different operands of the same user.
168 // Assume operands are added in order for all instructions.
171 return LU->getOperandNo() < RU->getOperandNo();
172 return LU->getOperandNo() > RU->getOperandNo();
176 List.begin(), List.end(),
177 [](const Entry &L, const Entry &R) { return L.second < R.second; }))
178 // Order is already correct.
181 // Store the shuffle.
182 Stack.emplace_back(V, F, List.size());
183 assert(List.size() == Stack.back().Shuffle.size() && "Wrong size");
184 for (size_t I = 0, E = List.size(); I != E; ++I)
185 Stack.back().Shuffle[I] = List[I].second;
188 static void predictValueUseListOrder(const Value *V, const Function *F,
189 OrderMap &OM, UseListOrderStack &Stack) {
190 auto &IDPair = OM[V];
191 assert(IDPair.first && "Unmapped value");
193 // Already predicted.
196 // Do the actual prediction.
197 IDPair.second = true;
198 if (!V->use_empty() && std::next(V->use_begin()) != V->use_end())
199 predictValueUseListOrderImpl(V, F, IDPair.first, OM, Stack);
201 // Recursive descent into constants.
202 if (const Constant *C = dyn_cast<Constant>(V))
203 if (C->getNumOperands()) // Visit GlobalValues.
204 for (const Value *Op : C->operands())
205 if (isa<Constant>(Op)) // Visit GlobalValues.
206 predictValueUseListOrder(Op, F, OM, Stack);
209 static UseListOrderStack predictUseListOrder(const Module *M) {
210 OrderMap OM = orderModule(M);
212 // Use-list orders need to be serialized after all the users have been added
213 // to a value, or else the shuffles will be incomplete. Store them per
214 // function in a stack.
216 // Aside from function order, the order of values doesn't matter much here.
217 UseListOrderStack Stack;
219 // We want to visit the functions backward now so we can list function-local
220 // constants in the last Function they're used in. Module-level constants
221 // have already been visited above.
222 for (auto I = M->rbegin(), E = M->rend(); I != E; ++I) {
223 const Function &F = *I;
224 if (F.isDeclaration())
226 for (const BasicBlock &BB : F)
227 predictValueUseListOrder(&BB, &F, OM, Stack);
228 for (const Argument &A : F.args())
229 predictValueUseListOrder(&A, &F, OM, Stack);
230 for (const BasicBlock &BB : F)
231 for (const Instruction &I : BB)
232 for (const Value *Op : I.operands())
233 if (isa<Constant>(*Op) || isa<InlineAsm>(*Op)) // Visit GlobalValues.
234 predictValueUseListOrder(Op, &F, OM, Stack);
235 for (const BasicBlock &BB : F)
236 for (const Instruction &I : BB)
237 predictValueUseListOrder(&I, &F, OM, Stack);
240 // Visit globals last.
241 for (const GlobalVariable &G : M->globals())
242 predictValueUseListOrder(&G, nullptr, OM, Stack);
243 for (const Function &F : *M)
244 predictValueUseListOrder(&F, nullptr, OM, Stack);
245 for (const GlobalAlias &A : M->aliases())
246 predictValueUseListOrder(&A, nullptr, OM, Stack);
247 for (const GlobalVariable &G : M->globals())
248 if (G.hasInitializer())
249 predictValueUseListOrder(G.getInitializer(), nullptr, OM, Stack);
250 for (const GlobalAlias &A : M->aliases())
251 predictValueUseListOrder(A.getAliasee(), nullptr, OM, Stack);
252 for (const Function &F : *M)
253 if (F.hasPrefixData())
254 predictValueUseListOrder(F.getPrefixData(), nullptr, OM, Stack);
259 static const Module *getModuleFromVal(const Value *V) {
260 if (const Argument *MA = dyn_cast<Argument>(V))
261 return MA->getParent() ? MA->getParent()->getParent() : nullptr;
263 if (const BasicBlock *BB = dyn_cast<BasicBlock>(V))
264 return BB->getParent() ? BB->getParent()->getParent() : nullptr;
266 if (const Instruction *I = dyn_cast<Instruction>(V)) {
267 const Function *M = I->getParent() ? I->getParent()->getParent() : nullptr;
268 return M ? M->getParent() : nullptr;
271 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V))
272 return GV->getParent();
276 static void PrintCallingConv(unsigned cc, raw_ostream &Out) {
278 default: Out << "cc" << cc; break;
279 case CallingConv::Fast: Out << "fastcc"; break;
280 case CallingConv::Cold: Out << "coldcc"; break;
281 case CallingConv::WebKit_JS: Out << "webkit_jscc"; break;
282 case CallingConv::AnyReg: Out << "anyregcc"; break;
283 case CallingConv::PreserveMost: Out << "preserve_mostcc"; break;
284 case CallingConv::PreserveAll: Out << "preserve_allcc"; break;
285 case CallingConv::X86_StdCall: Out << "x86_stdcallcc"; break;
286 case CallingConv::X86_FastCall: Out << "x86_fastcallcc"; break;
287 case CallingConv::X86_ThisCall: Out << "x86_thiscallcc"; break;
288 case CallingConv::X86_VectorCall:Out << "x86_vectorcallcc"; break;
289 case CallingConv::Intel_OCL_BI: Out << "intel_ocl_bicc"; break;
290 case CallingConv::ARM_APCS: Out << "arm_apcscc"; break;
291 case CallingConv::ARM_AAPCS: Out << "arm_aapcscc"; break;
292 case CallingConv::ARM_AAPCS_VFP: Out << "arm_aapcs_vfpcc"; break;
293 case CallingConv::MSP430_INTR: Out << "msp430_intrcc"; break;
294 case CallingConv::PTX_Kernel: Out << "ptx_kernel"; break;
295 case CallingConv::PTX_Device: Out << "ptx_device"; break;
296 case CallingConv::X86_64_SysV: Out << "x86_64_sysvcc"; break;
297 case CallingConv::X86_64_Win64: Out << "x86_64_win64cc"; break;
298 case CallingConv::SPIR_FUNC: Out << "spir_func"; break;
299 case CallingConv::SPIR_KERNEL: Out << "spir_kernel"; break;
303 // PrintEscapedString - Print each character of the specified string, escaping
304 // it if it is not printable or if it is an escape char.
305 static void PrintEscapedString(StringRef Name, raw_ostream &Out) {
306 for (unsigned i = 0, e = Name.size(); i != e; ++i) {
307 unsigned char C = Name[i];
308 if (isprint(C) && C != '\\' && C != '"')
311 Out << '\\' << hexdigit(C >> 4) << hexdigit(C & 0x0F);
323 /// PrintLLVMName - Turn the specified name into an 'LLVM name', which is either
324 /// prefixed with % (if the string only contains simple characters) or is
325 /// surrounded with ""'s (if it has special chars in it). Print it out.
326 static void PrintLLVMName(raw_ostream &OS, StringRef Name, PrefixType Prefix) {
327 assert(!Name.empty() && "Cannot get empty name!");
329 case NoPrefix: break;
330 case GlobalPrefix: OS << '@'; break;
331 case ComdatPrefix: OS << '$'; break;
332 case LabelPrefix: break;
333 case LocalPrefix: OS << '%'; break;
336 // Scan the name to see if it needs quotes first.
337 bool NeedsQuotes = isdigit(static_cast<unsigned char>(Name[0]));
339 for (unsigned i = 0, e = Name.size(); i != e; ++i) {
340 // By making this unsigned, the value passed in to isalnum will always be
341 // in the range 0-255. This is important when building with MSVC because
342 // its implementation will assert. This situation can arise when dealing
343 // with UTF-8 multibyte characters.
344 unsigned char C = Name[i];
345 if (!isalnum(static_cast<unsigned char>(C)) && C != '-' && C != '.' &&
353 // If we didn't need any quotes, just write out the name in one blast.
359 // Okay, we need quotes. Output the quotes and escape any scary characters as
362 PrintEscapedString(Name, OS);
366 /// PrintLLVMName - Turn the specified name into an 'LLVM name', which is either
367 /// prefixed with % (if the string only contains simple characters) or is
368 /// surrounded with ""'s (if it has special chars in it). Print it out.
369 static void PrintLLVMName(raw_ostream &OS, const Value *V) {
370 PrintLLVMName(OS, V->getName(),
371 isa<GlobalValue>(V) ? GlobalPrefix : LocalPrefix);
377 void TypePrinting::incorporateTypes(const Module &M) {
378 NamedTypes.run(M, false);
380 // The list of struct types we got back includes all the struct types, split
381 // the unnamed ones out to a numbering and remove the anonymous structs.
382 unsigned NextNumber = 0;
384 std::vector<StructType*>::iterator NextToUse = NamedTypes.begin(), I, E;
385 for (I = NamedTypes.begin(), E = NamedTypes.end(); I != E; ++I) {
386 StructType *STy = *I;
388 // Ignore anonymous types.
389 if (STy->isLiteral())
392 if (STy->getName().empty())
393 NumberedTypes[STy] = NextNumber++;
398 NamedTypes.erase(NextToUse, NamedTypes.end());
402 /// CalcTypeName - Write the specified type to the specified raw_ostream, making
403 /// use of type names or up references to shorten the type name where possible.
404 void TypePrinting::print(Type *Ty, raw_ostream &OS) {
405 switch (Ty->getTypeID()) {
406 case Type::VoidTyID: OS << "void"; return;
407 case Type::HalfTyID: OS << "half"; return;
408 case Type::FloatTyID: OS << "float"; return;
409 case Type::DoubleTyID: OS << "double"; return;
410 case Type::X86_FP80TyID: OS << "x86_fp80"; return;
411 case Type::FP128TyID: OS << "fp128"; return;
412 case Type::PPC_FP128TyID: OS << "ppc_fp128"; return;
413 case Type::LabelTyID: OS << "label"; return;
414 case Type::MetadataTyID: OS << "metadata"; return;
415 case Type::X86_MMXTyID: OS << "x86_mmx"; return;
416 case Type::IntegerTyID:
417 OS << 'i' << cast<IntegerType>(Ty)->getBitWidth();
420 case Type::FunctionTyID: {
421 FunctionType *FTy = cast<FunctionType>(Ty);
422 print(FTy->getReturnType(), OS);
424 for (FunctionType::param_iterator I = FTy->param_begin(),
425 E = FTy->param_end(); I != E; ++I) {
426 if (I != FTy->param_begin())
430 if (FTy->isVarArg()) {
431 if (FTy->getNumParams()) OS << ", ";
437 case Type::StructTyID: {
438 StructType *STy = cast<StructType>(Ty);
440 if (STy->isLiteral())
441 return printStructBody(STy, OS);
443 if (!STy->getName().empty())
444 return PrintLLVMName(OS, STy->getName(), LocalPrefix);
446 DenseMap<StructType*, unsigned>::iterator I = NumberedTypes.find(STy);
447 if (I != NumberedTypes.end())
448 OS << '%' << I->second;
449 else // Not enumerated, print the hex address.
450 OS << "%\"type " << STy << '\"';
453 case Type::PointerTyID: {
454 PointerType *PTy = cast<PointerType>(Ty);
455 print(PTy->getElementType(), OS);
456 if (unsigned AddressSpace = PTy->getAddressSpace())
457 OS << " addrspace(" << AddressSpace << ')';
461 case Type::ArrayTyID: {
462 ArrayType *ATy = cast<ArrayType>(Ty);
463 OS << '[' << ATy->getNumElements() << " x ";
464 print(ATy->getElementType(), OS);
468 case Type::VectorTyID: {
469 VectorType *PTy = cast<VectorType>(Ty);
470 OS << "<" << PTy->getNumElements() << " x ";
471 print(PTy->getElementType(), OS);
476 llvm_unreachable("Invalid TypeID");
479 void TypePrinting::printStructBody(StructType *STy, raw_ostream &OS) {
480 if (STy->isOpaque()) {
488 if (STy->getNumElements() == 0) {
491 StructType::element_iterator I = STy->element_begin();
494 for (StructType::element_iterator E = STy->element_end(); I != E; ++I) {
505 //===----------------------------------------------------------------------===//
506 // SlotTracker Class: Enumerate slot numbers for unnamed values
507 //===----------------------------------------------------------------------===//
508 /// This class provides computation of slot numbers for LLVM Assembly writing.
512 /// ValueMap - A mapping of Values to slot numbers.
513 typedef DenseMap<const Value*, unsigned> ValueMap;
516 /// TheModule - The module for which we are holding slot numbers.
517 const Module* TheModule;
519 /// TheFunction - The function for which we are holding slot numbers.
520 const Function* TheFunction;
521 bool FunctionProcessed;
523 /// mMap - The slot map for the module level data.
527 /// fMap - The slot map for the function level data.
531 /// mdnMap - Map for MDNodes.
532 DenseMap<const MDNode*, unsigned> mdnMap;
535 /// asMap - The slot map for attribute sets.
536 DenseMap<AttributeSet, unsigned> asMap;
539 /// Construct from a module
540 explicit SlotTracker(const Module *M);
541 /// Construct from a function, starting out in incorp state.
542 explicit SlotTracker(const Function *F);
544 /// Return the slot number of the specified value in it's type
545 /// plane. If something is not in the SlotTracker, return -1.
546 int getLocalSlot(const Value *V);
547 int getGlobalSlot(const GlobalValue *V);
548 int getMetadataSlot(const Value *MD);
549 int getAttributeGroupSlot(AttributeSet AS);
551 /// If you'd like to deal with a function instead of just a module, use
552 /// this method to get its data into the SlotTracker.
553 void incorporateFunction(const Function *F) {
555 FunctionProcessed = false;
558 const Function *getFunction() const { return TheFunction; }
560 /// After calling incorporateFunction, use this method to remove the
561 /// most recently incorporated function from the SlotTracker. This
562 /// will reset the state of the machine back to just the module contents.
563 void purgeFunction();
565 /// MDNode map iterators.
566 typedef DenseMap<const MDNode*, unsigned>::iterator mdn_iterator;
567 mdn_iterator mdn_begin() { return mdnMap.begin(); }
568 mdn_iterator mdn_end() { return mdnMap.end(); }
569 unsigned mdn_size() const { return mdnMap.size(); }
570 bool mdn_empty() const { return mdnMap.empty(); }
572 /// AttributeSet map iterators.
573 typedef DenseMap<AttributeSet, unsigned>::iterator as_iterator;
574 as_iterator as_begin() { return asMap.begin(); }
575 as_iterator as_end() { return asMap.end(); }
576 unsigned as_size() const { return asMap.size(); }
577 bool as_empty() const { return asMap.empty(); }
579 /// This function does the actual initialization.
580 inline void initialize();
582 // Implementation Details
584 /// CreateModuleSlot - Insert the specified GlobalValue* into the slot table.
585 void CreateModuleSlot(const GlobalValue *V);
587 /// CreateMetadataSlot - Insert the specified MDNode* into the slot table.
588 void CreateMetadataSlot(const Value *MD);
590 /// CreateFunctionSlot - Insert the specified Value* into the slot table.
591 void CreateFunctionSlot(const Value *V);
593 /// \brief Insert the specified AttributeSet into the slot table.
594 void CreateAttributeSetSlot(AttributeSet AS);
596 /// Add all of the module level global variables (and their initializers)
597 /// and function declarations, but not the contents of those functions.
598 void processModule();
600 /// Add all of the functions arguments, basic blocks, and instructions.
601 void processFunction();
603 SlotTracker(const SlotTracker &) LLVM_DELETED_FUNCTION;
604 void operator=(const SlotTracker &) LLVM_DELETED_FUNCTION;
607 SlotTracker *createSlotTracker(const Module *M) {
608 return new SlotTracker(M);
611 static SlotTracker *createSlotTracker(const Value *V) {
612 if (const Argument *FA = dyn_cast<Argument>(V))
613 return new SlotTracker(FA->getParent());
615 if (const Instruction *I = dyn_cast<Instruction>(V))
617 return new SlotTracker(I->getParent()->getParent());
619 if (const BasicBlock *BB = dyn_cast<BasicBlock>(V))
620 return new SlotTracker(BB->getParent());
622 if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(V))
623 return new SlotTracker(GV->getParent());
625 if (const GlobalAlias *GA = dyn_cast<GlobalAlias>(V))
626 return new SlotTracker(GA->getParent());
628 if (const Function *Func = dyn_cast<Function>(V))
629 return new SlotTracker(Func);
631 if (const MDNode *MD = dyn_cast<MDNode>(V)) {
632 if (!MD->isFunctionLocal())
633 return new SlotTracker(MD->getFunction());
635 return new SlotTracker((Function *)nullptr);
642 #define ST_DEBUG(X) dbgs() << X
647 // Module level constructor. Causes the contents of the Module (sans functions)
648 // to be added to the slot table.
649 SlotTracker::SlotTracker(const Module *M)
650 : TheModule(M), TheFunction(nullptr), FunctionProcessed(false),
651 mNext(0), fNext(0), mdnNext(0), asNext(0) {
654 // Function level constructor. Causes the contents of the Module and the one
655 // function provided to be added to the slot table.
656 SlotTracker::SlotTracker(const Function *F)
657 : TheModule(F ? F->getParent() : nullptr), TheFunction(F),
658 FunctionProcessed(false), mNext(0), fNext(0), mdnNext(0), asNext(0) {
661 inline void SlotTracker::initialize() {
664 TheModule = nullptr; ///< Prevent re-processing next time we're called.
667 if (TheFunction && !FunctionProcessed)
671 // Iterate through all the global variables, functions, and global
672 // variable initializers and create slots for them.
673 void SlotTracker::processModule() {
674 ST_DEBUG("begin processModule!\n");
676 // Add all of the unnamed global variables to the value table.
677 for (Module::const_global_iterator I = TheModule->global_begin(),
678 E = TheModule->global_end(); I != E; ++I) {
683 // Add metadata used by named metadata.
684 for (Module::const_named_metadata_iterator
685 I = TheModule->named_metadata_begin(),
686 E = TheModule->named_metadata_end(); I != E; ++I) {
687 const NamedMDNode *NMD = I;
688 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i)
689 CreateMetadataSlot(NMD->getOperand(i));
692 for (Module::const_iterator I = TheModule->begin(), E = TheModule->end();
695 // Add all the unnamed functions to the table.
698 // Add all the function attributes to the table.
699 // FIXME: Add attributes of other objects?
700 AttributeSet FnAttrs = I->getAttributes().getFnAttributes();
701 if (FnAttrs.hasAttributes(AttributeSet::FunctionIndex))
702 CreateAttributeSetSlot(FnAttrs);
705 ST_DEBUG("end processModule!\n");
708 // Process the arguments, basic blocks, and instructions of a function.
709 void SlotTracker::processFunction() {
710 ST_DEBUG("begin processFunction!\n");
713 // Add all the function arguments with no names.
714 for(Function::const_arg_iterator AI = TheFunction->arg_begin(),
715 AE = TheFunction->arg_end(); AI != AE; ++AI)
717 CreateFunctionSlot(AI);
719 ST_DEBUG("Inserting Instructions:\n");
721 SmallVector<std::pair<unsigned, Value *>, 4> MDForInst;
723 // Add all of the basic blocks and instructions with no names.
724 for (Function::const_iterator BB = TheFunction->begin(),
725 E = TheFunction->end(); BB != E; ++BB) {
727 CreateFunctionSlot(BB);
729 for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I != E;
731 if (!I->getType()->isVoidTy() && !I->hasName())
732 CreateFunctionSlot(I);
734 // Intrinsics can directly use metadata. We allow direct calls to any
735 // llvm.foo function here, because the target may not be linked into the
737 if (const CallInst *CI = dyn_cast<CallInst>(I)) {
738 if (Function *F = CI->getCalledFunction())
739 if (F->isIntrinsic())
740 for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i)
741 if (MDNode *N = dyn_cast_or_null<MDNode>(I->getOperand(i)))
742 CreateMetadataSlot(N);
744 // Add all the call attributes to the table.
745 AttributeSet Attrs = CI->getAttributes().getFnAttributes();
746 if (Attrs.hasAttributes(AttributeSet::FunctionIndex))
747 CreateAttributeSetSlot(Attrs);
748 } else if (const InvokeInst *II = dyn_cast<InvokeInst>(I)) {
749 // Add all the call attributes to the table.
750 AttributeSet Attrs = II->getAttributes().getFnAttributes();
751 if (Attrs.hasAttributes(AttributeSet::FunctionIndex))
752 CreateAttributeSetSlot(Attrs);
755 // Process metadata attached with this instruction.
756 I->getAllMetadata(MDForInst);
757 for (unsigned i = 0, e = MDForInst.size(); i != e; ++i)
758 CreateMetadataSlot(cast<MDNode>(MDForInst[i].second));
763 FunctionProcessed = true;
765 ST_DEBUG("end processFunction!\n");
768 /// Clean up after incorporating a function. This is the only way to get out of
769 /// the function incorporation state that affects get*Slot/Create*Slot. Function
770 /// incorporation state is indicated by TheFunction != 0.
771 void SlotTracker::purgeFunction() {
772 ST_DEBUG("begin purgeFunction!\n");
773 fMap.clear(); // Simply discard the function level map
774 TheFunction = nullptr;
775 FunctionProcessed = false;
776 ST_DEBUG("end purgeFunction!\n");
779 /// getGlobalSlot - Get the slot number of a global value.
780 int SlotTracker::getGlobalSlot(const GlobalValue *V) {
781 // Check for uninitialized state and do lazy initialization.
784 // Find the value in the module map
785 ValueMap::iterator MI = mMap.find(V);
786 return MI == mMap.end() ? -1 : (int)MI->second;
789 /// getMetadataSlot - Get the slot number of a metadata node.
790 int SlotTracker::getMetadataSlot(const Value *MD) {
791 // Check for uninitialized state and do lazy initialization.
794 // Find the MDNode in the module map
795 mdn_iterator MI = mdnMap.find(cast<MDNode>(MD));
796 return MI == mdnMap.end() ? -1 : (int)MI->second;
800 /// getLocalSlot - Get the slot number for a value that is local to a function.
801 int SlotTracker::getLocalSlot(const Value *V) {
802 assert(!isa<Constant>(V) && "Can't get a constant or global slot with this!");
804 // Check for uninitialized state and do lazy initialization.
807 ValueMap::iterator FI = fMap.find(V);
808 return FI == fMap.end() ? -1 : (int)FI->second;
811 int SlotTracker::getAttributeGroupSlot(AttributeSet AS) {
812 // Check for uninitialized state and do lazy initialization.
815 // Find the AttributeSet in the module map.
816 as_iterator AI = asMap.find(AS);
817 return AI == asMap.end() ? -1 : (int)AI->second;
820 /// CreateModuleSlot - Insert the specified GlobalValue* into the slot table.
821 void SlotTracker::CreateModuleSlot(const GlobalValue *V) {
822 assert(V && "Can't insert a null Value into SlotTracker!");
823 assert(!V->getType()->isVoidTy() && "Doesn't need a slot!");
824 assert(!V->hasName() && "Doesn't need a slot!");
826 unsigned DestSlot = mNext++;
829 ST_DEBUG(" Inserting value [" << V->getType() << "] = " << V << " slot=" <<
831 // G = Global, F = Function, A = Alias, o = other
832 ST_DEBUG((isa<GlobalVariable>(V) ? 'G' :
833 (isa<Function>(V) ? 'F' :
834 (isa<GlobalAlias>(V) ? 'A' : 'o'))) << "]\n");
837 /// CreateSlot - Create a new slot for the specified value if it has no name.
838 void SlotTracker::CreateFunctionSlot(const Value *V) {
839 assert(!V->getType()->isVoidTy() && !V->hasName() && "Doesn't need a slot!");
841 unsigned DestSlot = fNext++;
844 // G = Global, F = Function, o = other
845 ST_DEBUG(" Inserting value [" << V->getType() << "] = " << V << " slot=" <<
846 DestSlot << " [o]\n");
849 /// CreateModuleSlot - Insert the specified metadata into the slot table.
850 void SlotTracker::CreateMetadataSlot(const Value *MD) {
851 assert(MD && "Can't insert a null Value into SlotTracker!");
852 const MDNode *N = cast<MDNode>(MD);
854 // Don't insert if N is a function-local metadata, these are always printed
856 if (!N->isFunctionLocal()) {
857 mdn_iterator I = mdnMap.find(N);
858 if (I != mdnMap.end())
861 unsigned DestSlot = mdnNext++;
862 mdnMap[N] = DestSlot;
865 // Recursively add any MDNodes referenced by operands.
866 for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i)
867 if (const MDNode *Op = dyn_cast_or_null<MDNode>(N->getOperand(i)))
868 CreateMetadataSlot(Op);
871 void SlotTracker::CreateAttributeSetSlot(AttributeSet AS) {
872 assert(AS.hasAttributes(AttributeSet::FunctionIndex) &&
873 "Doesn't need a slot!");
875 as_iterator I = asMap.find(AS);
876 if (I != asMap.end())
879 unsigned DestSlot = asNext++;
880 asMap[AS] = DestSlot;
883 //===----------------------------------------------------------------------===//
884 // AsmWriter Implementation
885 //===----------------------------------------------------------------------===//
887 static void WriteAsOperandInternal(raw_ostream &Out, const Value *V,
888 TypePrinting *TypePrinter,
889 SlotTracker *Machine,
890 const Module *Context);
892 static const char *getPredicateText(unsigned predicate) {
893 const char * pred = "unknown";
895 case FCmpInst::FCMP_FALSE: pred = "false"; break;
896 case FCmpInst::FCMP_OEQ: pred = "oeq"; break;
897 case FCmpInst::FCMP_OGT: pred = "ogt"; break;
898 case FCmpInst::FCMP_OGE: pred = "oge"; break;
899 case FCmpInst::FCMP_OLT: pred = "olt"; break;
900 case FCmpInst::FCMP_OLE: pred = "ole"; break;
901 case FCmpInst::FCMP_ONE: pred = "one"; break;
902 case FCmpInst::FCMP_ORD: pred = "ord"; break;
903 case FCmpInst::FCMP_UNO: pred = "uno"; break;
904 case FCmpInst::FCMP_UEQ: pred = "ueq"; break;
905 case FCmpInst::FCMP_UGT: pred = "ugt"; break;
906 case FCmpInst::FCMP_UGE: pred = "uge"; break;
907 case FCmpInst::FCMP_ULT: pred = "ult"; break;
908 case FCmpInst::FCMP_ULE: pred = "ule"; break;
909 case FCmpInst::FCMP_UNE: pred = "une"; break;
910 case FCmpInst::FCMP_TRUE: pred = "true"; break;
911 case ICmpInst::ICMP_EQ: pred = "eq"; break;
912 case ICmpInst::ICMP_NE: pred = "ne"; break;
913 case ICmpInst::ICMP_SGT: pred = "sgt"; break;
914 case ICmpInst::ICMP_SGE: pred = "sge"; break;
915 case ICmpInst::ICMP_SLT: pred = "slt"; break;
916 case ICmpInst::ICMP_SLE: pred = "sle"; break;
917 case ICmpInst::ICMP_UGT: pred = "ugt"; break;
918 case ICmpInst::ICMP_UGE: pred = "uge"; break;
919 case ICmpInst::ICMP_ULT: pred = "ult"; break;
920 case ICmpInst::ICMP_ULE: pred = "ule"; break;
925 static void writeAtomicRMWOperation(raw_ostream &Out,
926 AtomicRMWInst::BinOp Op) {
928 default: Out << " <unknown operation " << Op << ">"; break;
929 case AtomicRMWInst::Xchg: Out << " xchg"; break;
930 case AtomicRMWInst::Add: Out << " add"; break;
931 case AtomicRMWInst::Sub: Out << " sub"; break;
932 case AtomicRMWInst::And: Out << " and"; break;
933 case AtomicRMWInst::Nand: Out << " nand"; break;
934 case AtomicRMWInst::Or: Out << " or"; break;
935 case AtomicRMWInst::Xor: Out << " xor"; break;
936 case AtomicRMWInst::Max: Out << " max"; break;
937 case AtomicRMWInst::Min: Out << " min"; break;
938 case AtomicRMWInst::UMax: Out << " umax"; break;
939 case AtomicRMWInst::UMin: Out << " umin"; break;
943 static void WriteOptimizationInfo(raw_ostream &Out, const User *U) {
944 if (const FPMathOperator *FPO = dyn_cast<const FPMathOperator>(U)) {
945 // Unsafe algebra implies all the others, no need to write them all out
946 if (FPO->hasUnsafeAlgebra())
949 if (FPO->hasNoNaNs())
951 if (FPO->hasNoInfs())
953 if (FPO->hasNoSignedZeros())
955 if (FPO->hasAllowReciprocal())
960 if (const OverflowingBinaryOperator *OBO =
961 dyn_cast<OverflowingBinaryOperator>(U)) {
962 if (OBO->hasNoUnsignedWrap())
964 if (OBO->hasNoSignedWrap())
966 } else if (const PossiblyExactOperator *Div =
967 dyn_cast<PossiblyExactOperator>(U)) {
970 } else if (const GEPOperator *GEP = dyn_cast<GEPOperator>(U)) {
971 if (GEP->isInBounds())
976 static void WriteConstantInternal(raw_ostream &Out, const Constant *CV,
977 TypePrinting &TypePrinter,
978 SlotTracker *Machine,
979 const Module *Context) {
980 if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV)) {
981 if (CI->getType()->isIntegerTy(1)) {
982 Out << (CI->getZExtValue() ? "true" : "false");
985 Out << CI->getValue();
989 if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV)) {
990 if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEsingle ||
991 &CFP->getValueAPF().getSemantics() == &APFloat::IEEEdouble) {
992 // We would like to output the FP constant value in exponential notation,
993 // but we cannot do this if doing so will lose precision. Check here to
994 // make sure that we only output it in exponential format if we can parse
995 // the value back and get the same value.
998 bool isHalf = &CFP->getValueAPF().getSemantics()==&APFloat::IEEEhalf;
999 bool isDouble = &CFP->getValueAPF().getSemantics()==&APFloat::IEEEdouble;
1000 bool isInf = CFP->getValueAPF().isInfinity();
1001 bool isNaN = CFP->getValueAPF().isNaN();
1002 if (!isHalf && !isInf && !isNaN) {
1003 double Val = isDouble ? CFP->getValueAPF().convertToDouble() :
1004 CFP->getValueAPF().convertToFloat();
1005 SmallString<128> StrVal;
1006 raw_svector_ostream(StrVal) << Val;
1008 // Check to make sure that the stringized number is not some string like
1009 // "Inf" or NaN, that atof will accept, but the lexer will not. Check
1010 // that the string matches the "[-+]?[0-9]" regex.
1012 if ((StrVal[0] >= '0' && StrVal[0] <= '9') ||
1013 ((StrVal[0] == '-' || StrVal[0] == '+') &&
1014 (StrVal[1] >= '0' && StrVal[1] <= '9'))) {
1015 // Reparse stringized version!
1016 if (APFloat(APFloat::IEEEdouble, StrVal).convertToDouble() == Val) {
1017 Out << StrVal.str();
1022 // Otherwise we could not reparse it to exactly the same value, so we must
1023 // output the string in hexadecimal format! Note that loading and storing
1024 // floating point types changes the bits of NaNs on some hosts, notably
1025 // x86, so we must not use these types.
1026 static_assert(sizeof(double) == sizeof(uint64_t),
1027 "assuming that double is 64 bits!");
1029 APFloat apf = CFP->getValueAPF();
1030 // Halves and floats are represented in ASCII IR as double, convert.
1032 apf.convert(APFloat::IEEEdouble, APFloat::rmNearestTiesToEven,
1035 utohex_buffer(uint64_t(apf.bitcastToAPInt().getZExtValue()),
1040 // Either half, or some form of long double.
1041 // These appear as a magic letter identifying the type, then a
1042 // fixed number of hex digits.
1044 // Bit position, in the current word, of the next nibble to print.
1047 if (&CFP->getValueAPF().getSemantics() == &APFloat::x87DoubleExtended) {
1049 // api needed to prevent premature destruction
1050 APInt api = CFP->getValueAPF().bitcastToAPInt();
1051 const uint64_t* p = api.getRawData();
1052 uint64_t word = p[1];
1054 int width = api.getBitWidth();
1055 for (int j=0; j<width; j+=4, shiftcount-=4) {
1056 unsigned int nibble = (word>>shiftcount) & 15;
1058 Out << (unsigned char)(nibble + '0');
1060 Out << (unsigned char)(nibble - 10 + 'A');
1061 if (shiftcount == 0 && j+4 < width) {
1065 shiftcount = width-j-4;
1069 } else if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEquad) {
1072 } else if (&CFP->getValueAPF().getSemantics() == &APFloat::PPCDoubleDouble) {
1075 } else if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEhalf) {
1079 llvm_unreachable("Unsupported floating point type");
1080 // api needed to prevent premature destruction
1081 APInt api = CFP->getValueAPF().bitcastToAPInt();
1082 const uint64_t* p = api.getRawData();
1084 int width = api.getBitWidth();
1085 for (int j=0; j<width; j+=4, shiftcount-=4) {
1086 unsigned int nibble = (word>>shiftcount) & 15;
1088 Out << (unsigned char)(nibble + '0');
1090 Out << (unsigned char)(nibble - 10 + 'A');
1091 if (shiftcount == 0 && j+4 < width) {
1095 shiftcount = width-j-4;
1101 if (isa<ConstantAggregateZero>(CV)) {
1102 Out << "zeroinitializer";
1106 if (const BlockAddress *BA = dyn_cast<BlockAddress>(CV)) {
1107 Out << "blockaddress(";
1108 WriteAsOperandInternal(Out, BA->getFunction(), &TypePrinter, Machine,
1111 WriteAsOperandInternal(Out, BA->getBasicBlock(), &TypePrinter, Machine,
1117 if (const ConstantArray *CA = dyn_cast<ConstantArray>(CV)) {
1118 Type *ETy = CA->getType()->getElementType();
1120 TypePrinter.print(ETy, Out);
1122 WriteAsOperandInternal(Out, CA->getOperand(0),
1123 &TypePrinter, Machine,
1125 for (unsigned i = 1, e = CA->getNumOperands(); i != e; ++i) {
1127 TypePrinter.print(ETy, Out);
1129 WriteAsOperandInternal(Out, CA->getOperand(i), &TypePrinter, Machine,
1136 if (const ConstantDataArray *CA = dyn_cast<ConstantDataArray>(CV)) {
1137 // As a special case, print the array as a string if it is an array of
1138 // i8 with ConstantInt values.
1139 if (CA->isString()) {
1141 PrintEscapedString(CA->getAsString(), Out);
1146 Type *ETy = CA->getType()->getElementType();
1148 TypePrinter.print(ETy, Out);
1150 WriteAsOperandInternal(Out, CA->getElementAsConstant(0),
1151 &TypePrinter, Machine,
1153 for (unsigned i = 1, e = CA->getNumElements(); i != e; ++i) {
1155 TypePrinter.print(ETy, Out);
1157 WriteAsOperandInternal(Out, CA->getElementAsConstant(i), &TypePrinter,
1165 if (const ConstantStruct *CS = dyn_cast<ConstantStruct>(CV)) {
1166 if (CS->getType()->isPacked())
1169 unsigned N = CS->getNumOperands();
1172 TypePrinter.print(CS->getOperand(0)->getType(), Out);
1175 WriteAsOperandInternal(Out, CS->getOperand(0), &TypePrinter, Machine,
1178 for (unsigned i = 1; i < N; i++) {
1180 TypePrinter.print(CS->getOperand(i)->getType(), Out);
1183 WriteAsOperandInternal(Out, CS->getOperand(i), &TypePrinter, Machine,
1190 if (CS->getType()->isPacked())
1195 if (isa<ConstantVector>(CV) || isa<ConstantDataVector>(CV)) {
1196 Type *ETy = CV->getType()->getVectorElementType();
1198 TypePrinter.print(ETy, Out);
1200 WriteAsOperandInternal(Out, CV->getAggregateElement(0U), &TypePrinter,
1202 for (unsigned i = 1, e = CV->getType()->getVectorNumElements(); i != e;++i){
1204 TypePrinter.print(ETy, Out);
1206 WriteAsOperandInternal(Out, CV->getAggregateElement(i), &TypePrinter,
1213 if (isa<ConstantPointerNull>(CV)) {
1218 if (isa<UndefValue>(CV)) {
1223 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV)) {
1224 Out << CE->getOpcodeName();
1225 WriteOptimizationInfo(Out, CE);
1226 if (CE->isCompare())
1227 Out << ' ' << getPredicateText(CE->getPredicate());
1230 for (User::const_op_iterator OI=CE->op_begin(); OI != CE->op_end(); ++OI) {
1231 TypePrinter.print((*OI)->getType(), Out);
1233 WriteAsOperandInternal(Out, *OI, &TypePrinter, Machine, Context);
1234 if (OI+1 != CE->op_end())
1238 if (CE->hasIndices()) {
1239 ArrayRef<unsigned> Indices = CE->getIndices();
1240 for (unsigned i = 0, e = Indices.size(); i != e; ++i)
1241 Out << ", " << Indices[i];
1246 TypePrinter.print(CE->getType(), Out);
1253 Out << "<placeholder or erroneous Constant>";
1256 static void WriteMDNodeBodyInternal(raw_ostream &Out, const MDNode *Node,
1257 TypePrinting *TypePrinter,
1258 SlotTracker *Machine,
1259 const Module *Context) {
1261 for (unsigned mi = 0, me = Node->getNumOperands(); mi != me; ++mi) {
1262 const Value *V = Node->getOperand(mi);
1266 TypePrinter->print(V->getType(), Out);
1268 WriteAsOperandInternal(Out, Node->getOperand(mi),
1269 TypePrinter, Machine, Context);
1278 // Full implementation of printing a Value as an operand with support for
1279 // TypePrinting, etc.
1280 static void WriteAsOperandInternal(raw_ostream &Out, const Value *V,
1281 TypePrinting *TypePrinter,
1282 SlotTracker *Machine,
1283 const Module *Context) {
1285 PrintLLVMName(Out, V);
1289 const Constant *CV = dyn_cast<Constant>(V);
1290 if (CV && !isa<GlobalValue>(CV)) {
1291 assert(TypePrinter && "Constants require TypePrinting!");
1292 WriteConstantInternal(Out, CV, *TypePrinter, Machine, Context);
1296 if (const InlineAsm *IA = dyn_cast<InlineAsm>(V)) {
1298 if (IA->hasSideEffects())
1299 Out << "sideeffect ";
1300 if (IA->isAlignStack())
1301 Out << "alignstack ";
1302 // We don't emit the AD_ATT dialect as it's the assumed default.
1303 if (IA->getDialect() == InlineAsm::AD_Intel)
1304 Out << "inteldialect ";
1306 PrintEscapedString(IA->getAsmString(), Out);
1308 PrintEscapedString(IA->getConstraintString(), Out);
1313 if (const MDNode *N = dyn_cast<MDNode>(V)) {
1314 if (N->isFunctionLocal()) {
1315 // Print metadata inline, not via slot reference number.
1316 WriteMDNodeBodyInternal(Out, N, TypePrinter, Machine, Context);
1321 if (N->isFunctionLocal())
1322 Machine = new SlotTracker(N->getFunction());
1324 Machine = new SlotTracker(Context);
1326 int Slot = Machine->getMetadataSlot(N);
1334 if (const MDString *MDS = dyn_cast<MDString>(V)) {
1336 PrintEscapedString(MDS->getString(), Out);
1343 // If we have a SlotTracker, use it.
1345 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
1346 Slot = Machine->getGlobalSlot(GV);
1349 Slot = Machine->getLocalSlot(V);
1351 // If the local value didn't succeed, then we may be referring to a value
1352 // from a different function. Translate it, as this can happen when using
1353 // address of blocks.
1355 if ((Machine = createSlotTracker(V))) {
1356 Slot = Machine->getLocalSlot(V);
1360 } else if ((Machine = createSlotTracker(V))) {
1361 // Otherwise, create one to get the # and then destroy it.
1362 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
1363 Slot = Machine->getGlobalSlot(GV);
1366 Slot = Machine->getLocalSlot(V);
1375 Out << Prefix << Slot;
1380 void AssemblyWriter::init() {
1383 TypePrinter.incorporateTypes(*TheModule);
1384 for (const Function &F : *TheModule)
1385 if (const Comdat *C = F.getComdat())
1387 for (const GlobalVariable &GV : TheModule->globals())
1388 if (const Comdat *C = GV.getComdat())
1393 AssemblyWriter::AssemblyWriter(formatted_raw_ostream &o, SlotTracker &Mac,
1395 AssemblyAnnotationWriter *AAW)
1396 : Out(o), TheModule(M), Machine(Mac), AnnotationWriter(AAW) {
1400 AssemblyWriter::AssemblyWriter(formatted_raw_ostream &o, const Module *M,
1401 AssemblyAnnotationWriter *AAW)
1402 : Out(o), TheModule(M), ModuleSlotTracker(createSlotTracker(M)),
1403 Machine(*ModuleSlotTracker), AnnotationWriter(AAW) {
1407 AssemblyWriter::~AssemblyWriter() { }
1409 void AssemblyWriter::writeOperand(const Value *Operand, bool PrintType) {
1411 Out << "<null operand!>";
1415 TypePrinter.print(Operand->getType(), Out);
1418 WriteAsOperandInternal(Out, Operand, &TypePrinter, &Machine, TheModule);
1421 void AssemblyWriter::writeAtomic(AtomicOrdering Ordering,
1422 SynchronizationScope SynchScope) {
1423 if (Ordering == NotAtomic)
1426 switch (SynchScope) {
1427 case SingleThread: Out << " singlethread"; break;
1428 case CrossThread: break;
1432 default: Out << " <bad ordering " << int(Ordering) << ">"; break;
1433 case Unordered: Out << " unordered"; break;
1434 case Monotonic: Out << " monotonic"; break;
1435 case Acquire: Out << " acquire"; break;
1436 case Release: Out << " release"; break;
1437 case AcquireRelease: Out << " acq_rel"; break;
1438 case SequentiallyConsistent: Out << " seq_cst"; break;
1442 void AssemblyWriter::writeAtomicCmpXchg(AtomicOrdering SuccessOrdering,
1443 AtomicOrdering FailureOrdering,
1444 SynchronizationScope SynchScope) {
1445 assert(SuccessOrdering != NotAtomic && FailureOrdering != NotAtomic);
1447 switch (SynchScope) {
1448 case SingleThread: Out << " singlethread"; break;
1449 case CrossThread: break;
1452 switch (SuccessOrdering) {
1453 default: Out << " <bad ordering " << int(SuccessOrdering) << ">"; break;
1454 case Unordered: Out << " unordered"; break;
1455 case Monotonic: Out << " monotonic"; break;
1456 case Acquire: Out << " acquire"; break;
1457 case Release: Out << " release"; break;
1458 case AcquireRelease: Out << " acq_rel"; break;
1459 case SequentiallyConsistent: Out << " seq_cst"; break;
1462 switch (FailureOrdering) {
1463 default: Out << " <bad ordering " << int(FailureOrdering) << ">"; break;
1464 case Unordered: Out << " unordered"; break;
1465 case Monotonic: Out << " monotonic"; break;
1466 case Acquire: Out << " acquire"; break;
1467 case Release: Out << " release"; break;
1468 case AcquireRelease: Out << " acq_rel"; break;
1469 case SequentiallyConsistent: Out << " seq_cst"; break;
1473 void AssemblyWriter::writeParamOperand(const Value *Operand,
1474 AttributeSet Attrs, unsigned Idx) {
1476 Out << "<null operand!>";
1481 TypePrinter.print(Operand->getType(), Out);
1482 // Print parameter attributes list
1483 if (Attrs.hasAttributes(Idx))
1484 Out << ' ' << Attrs.getAsString(Idx);
1486 // Print the operand
1487 WriteAsOperandInternal(Out, Operand, &TypePrinter, &Machine, TheModule);
1490 void AssemblyWriter::printModule(const Module *M) {
1491 Machine.initialize();
1493 if (shouldPreserveAssemblyUseListOrder())
1494 UseListOrders = predictUseListOrder(M);
1496 if (!M->getModuleIdentifier().empty() &&
1497 // Don't print the ID if it will start a new line (which would
1498 // require a comment char before it).
1499 M->getModuleIdentifier().find('\n') == std::string::npos)
1500 Out << "; ModuleID = '" << M->getModuleIdentifier() << "'\n";
1502 const std::string &DL = M->getDataLayoutStr();
1504 Out << "target datalayout = \"" << DL << "\"\n";
1505 if (!M->getTargetTriple().empty())
1506 Out << "target triple = \"" << M->getTargetTriple() << "\"\n";
1508 if (!M->getModuleInlineAsm().empty()) {
1509 // Split the string into lines, to make it easier to read the .ll file.
1510 std::string Asm = M->getModuleInlineAsm();
1512 size_t NewLine = Asm.find_first_of('\n', CurPos);
1514 while (NewLine != std::string::npos) {
1515 // We found a newline, print the portion of the asm string from the
1516 // last newline up to this newline.
1517 Out << "module asm \"";
1518 PrintEscapedString(std::string(Asm.begin()+CurPos, Asm.begin()+NewLine),
1522 NewLine = Asm.find_first_of('\n', CurPos);
1524 std::string rest(Asm.begin()+CurPos, Asm.end());
1525 if (!rest.empty()) {
1526 Out << "module asm \"";
1527 PrintEscapedString(rest, Out);
1532 printTypeIdentities();
1534 // Output all comdats.
1535 if (!Comdats.empty())
1537 for (const Comdat *C : Comdats) {
1539 if (C != Comdats.back())
1543 // Output all globals.
1544 if (!M->global_empty()) Out << '\n';
1545 for (Module::const_global_iterator I = M->global_begin(), E = M->global_end();
1547 printGlobal(I); Out << '\n';
1550 // Output all aliases.
1551 if (!M->alias_empty()) Out << "\n";
1552 for (Module::const_alias_iterator I = M->alias_begin(), E = M->alias_end();
1556 // Output global use-lists.
1557 printUseLists(nullptr);
1559 // Output all of the functions.
1560 for (Module::const_iterator I = M->begin(), E = M->end(); I != E; ++I)
1562 assert(UseListOrders.empty() && "All use-lists should have been consumed");
1564 // Output all attribute groups.
1565 if (!Machine.as_empty()) {
1567 writeAllAttributeGroups();
1570 // Output named metadata.
1571 if (!M->named_metadata_empty()) Out << '\n';
1573 for (Module::const_named_metadata_iterator I = M->named_metadata_begin(),
1574 E = M->named_metadata_end(); I != E; ++I)
1575 printNamedMDNode(I);
1578 if (!Machine.mdn_empty()) {
1584 void AssemblyWriter::printNamedMDNode(const NamedMDNode *NMD) {
1586 StringRef Name = NMD->getName();
1588 Out << "<empty name> ";
1590 if (isalpha(static_cast<unsigned char>(Name[0])) ||
1591 Name[0] == '-' || Name[0] == '$' ||
1592 Name[0] == '.' || Name[0] == '_')
1595 Out << '\\' << hexdigit(Name[0] >> 4) << hexdigit(Name[0] & 0x0F);
1596 for (unsigned i = 1, e = Name.size(); i != e; ++i) {
1597 unsigned char C = Name[i];
1598 if (isalnum(static_cast<unsigned char>(C)) || C == '-' || C == '$' ||
1599 C == '.' || C == '_')
1602 Out << '\\' << hexdigit(C >> 4) << hexdigit(C & 0x0F);
1606 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
1608 int Slot = Machine.getMetadataSlot(NMD->getOperand(i));
1618 static void PrintLinkage(GlobalValue::LinkageTypes LT,
1619 formatted_raw_ostream &Out) {
1621 case GlobalValue::ExternalLinkage: break;
1622 case GlobalValue::PrivateLinkage: Out << "private "; break;
1623 case GlobalValue::InternalLinkage: Out << "internal "; break;
1624 case GlobalValue::LinkOnceAnyLinkage: Out << "linkonce "; break;
1625 case GlobalValue::LinkOnceODRLinkage: Out << "linkonce_odr "; break;
1626 case GlobalValue::WeakAnyLinkage: Out << "weak "; break;
1627 case GlobalValue::WeakODRLinkage: Out << "weak_odr "; break;
1628 case GlobalValue::CommonLinkage: Out << "common "; break;
1629 case GlobalValue::AppendingLinkage: Out << "appending "; break;
1630 case GlobalValue::ExternalWeakLinkage: Out << "extern_weak "; break;
1631 case GlobalValue::AvailableExternallyLinkage:
1632 Out << "available_externally ";
1638 static void PrintVisibility(GlobalValue::VisibilityTypes Vis,
1639 formatted_raw_ostream &Out) {
1641 case GlobalValue::DefaultVisibility: break;
1642 case GlobalValue::HiddenVisibility: Out << "hidden "; break;
1643 case GlobalValue::ProtectedVisibility: Out << "protected "; break;
1647 static void PrintDLLStorageClass(GlobalValue::DLLStorageClassTypes SCT,
1648 formatted_raw_ostream &Out) {
1650 case GlobalValue::DefaultStorageClass: break;
1651 case GlobalValue::DLLImportStorageClass: Out << "dllimport "; break;
1652 case GlobalValue::DLLExportStorageClass: Out << "dllexport "; break;
1656 static void PrintThreadLocalModel(GlobalVariable::ThreadLocalMode TLM,
1657 formatted_raw_ostream &Out) {
1659 case GlobalVariable::NotThreadLocal:
1661 case GlobalVariable::GeneralDynamicTLSModel:
1662 Out << "thread_local ";
1664 case GlobalVariable::LocalDynamicTLSModel:
1665 Out << "thread_local(localdynamic) ";
1667 case GlobalVariable::InitialExecTLSModel:
1668 Out << "thread_local(initialexec) ";
1670 case GlobalVariable::LocalExecTLSModel:
1671 Out << "thread_local(localexec) ";
1676 void AssemblyWriter::printGlobal(const GlobalVariable *GV) {
1677 if (GV->isMaterializable())
1678 Out << "; Materializable\n";
1680 WriteAsOperandInternal(Out, GV, &TypePrinter, &Machine, GV->getParent());
1683 if (!GV->hasInitializer() && GV->hasExternalLinkage())
1686 PrintLinkage(GV->getLinkage(), Out);
1687 PrintVisibility(GV->getVisibility(), Out);
1688 PrintDLLStorageClass(GV->getDLLStorageClass(), Out);
1689 PrintThreadLocalModel(GV->getThreadLocalMode(), Out);
1690 if (GV->hasUnnamedAddr())
1691 Out << "unnamed_addr ";
1693 if (unsigned AddressSpace = GV->getType()->getAddressSpace())
1694 Out << "addrspace(" << AddressSpace << ") ";
1695 if (GV->isExternallyInitialized()) Out << "externally_initialized ";
1696 Out << (GV->isConstant() ? "constant " : "global ");
1697 TypePrinter.print(GV->getType()->getElementType(), Out);
1699 if (GV->hasInitializer()) {
1701 writeOperand(GV->getInitializer(), false);
1704 if (GV->hasSection()) {
1705 Out << ", section \"";
1706 PrintEscapedString(GV->getSection(), Out);
1709 if (GV->hasComdat()) {
1711 PrintLLVMName(Out, GV->getComdat()->getName(), ComdatPrefix);
1713 if (GV->getAlignment())
1714 Out << ", align " << GV->getAlignment();
1716 printInfoComment(*GV);
1719 void AssemblyWriter::printAlias(const GlobalAlias *GA) {
1720 if (GA->isMaterializable())
1721 Out << "; Materializable\n";
1723 // Don't crash when dumping partially built GA
1725 Out << "<<nameless>> = ";
1727 PrintLLVMName(Out, GA);
1730 PrintLinkage(GA->getLinkage(), Out);
1731 PrintVisibility(GA->getVisibility(), Out);
1732 PrintDLLStorageClass(GA->getDLLStorageClass(), Out);
1733 PrintThreadLocalModel(GA->getThreadLocalMode(), Out);
1734 if (GA->hasUnnamedAddr())
1735 Out << "unnamed_addr ";
1739 const Constant *Aliasee = GA->getAliasee();
1742 TypePrinter.print(GA->getType(), Out);
1743 Out << " <<NULL ALIASEE>>";
1745 writeOperand(Aliasee, !isa<ConstantExpr>(Aliasee));
1748 printInfoComment(*GA);
1752 void AssemblyWriter::printComdat(const Comdat *C) {
1756 void AssemblyWriter::printTypeIdentities() {
1757 if (TypePrinter.NumberedTypes.empty() &&
1758 TypePrinter.NamedTypes.empty())
1763 // We know all the numbers that each type is used and we know that it is a
1764 // dense assignment. Convert the map to an index table.
1765 std::vector<StructType*> NumberedTypes(TypePrinter.NumberedTypes.size());
1766 for (DenseMap<StructType*, unsigned>::iterator I =
1767 TypePrinter.NumberedTypes.begin(), E = TypePrinter.NumberedTypes.end();
1769 assert(I->second < NumberedTypes.size() && "Didn't get a dense numbering?");
1770 NumberedTypes[I->second] = I->first;
1773 // Emit all numbered types.
1774 for (unsigned i = 0, e = NumberedTypes.size(); i != e; ++i) {
1775 Out << '%' << i << " = type ";
1777 // Make sure we print out at least one level of the type structure, so
1778 // that we do not get %2 = type %2
1779 TypePrinter.printStructBody(NumberedTypes[i], Out);
1783 for (unsigned i = 0, e = TypePrinter.NamedTypes.size(); i != e; ++i) {
1784 PrintLLVMName(Out, TypePrinter.NamedTypes[i]->getName(), LocalPrefix);
1787 // Make sure we print out at least one level of the type structure, so
1788 // that we do not get %FILE = type %FILE
1789 TypePrinter.printStructBody(TypePrinter.NamedTypes[i], Out);
1794 /// printFunction - Print all aspects of a function.
1796 void AssemblyWriter::printFunction(const Function *F) {
1797 // Print out the return type and name.
1800 if (AnnotationWriter) AnnotationWriter->emitFunctionAnnot(F, Out);
1802 if (F->isMaterializable())
1803 Out << "; Materializable\n";
1805 const AttributeSet &Attrs = F->getAttributes();
1806 if (Attrs.hasAttributes(AttributeSet::FunctionIndex)) {
1807 AttributeSet AS = Attrs.getFnAttributes();
1808 std::string AttrStr;
1811 for (unsigned E = AS.getNumSlots(); Idx != E; ++Idx)
1812 if (AS.getSlotIndex(Idx) == AttributeSet::FunctionIndex)
1815 for (AttributeSet::iterator I = AS.begin(Idx), E = AS.end(Idx);
1817 Attribute Attr = *I;
1818 if (!Attr.isStringAttribute()) {
1819 if (!AttrStr.empty()) AttrStr += ' ';
1820 AttrStr += Attr.getAsString();
1824 if (!AttrStr.empty())
1825 Out << "; Function Attrs: " << AttrStr << '\n';
1828 if (F->isDeclaration())
1833 PrintLinkage(F->getLinkage(), Out);
1834 PrintVisibility(F->getVisibility(), Out);
1835 PrintDLLStorageClass(F->getDLLStorageClass(), Out);
1837 // Print the calling convention.
1838 if (F->getCallingConv() != CallingConv::C) {
1839 PrintCallingConv(F->getCallingConv(), Out);
1843 FunctionType *FT = F->getFunctionType();
1844 if (Attrs.hasAttributes(AttributeSet::ReturnIndex))
1845 Out << Attrs.getAsString(AttributeSet::ReturnIndex) << ' ';
1846 TypePrinter.print(F->getReturnType(), Out);
1848 WriteAsOperandInternal(Out, F, &TypePrinter, &Machine, F->getParent());
1850 Machine.incorporateFunction(F);
1852 // Loop over the arguments, printing them...
1855 if (!F->isDeclaration()) {
1856 // If this isn't a declaration, print the argument names as well.
1857 for (Function::const_arg_iterator I = F->arg_begin(), E = F->arg_end();
1859 // Insert commas as we go... the first arg doesn't get a comma
1860 if (I != F->arg_begin()) Out << ", ";
1861 printArgument(I, Attrs, Idx);
1865 // Otherwise, print the types from the function type.
1866 for (unsigned i = 0, e = FT->getNumParams(); i != e; ++i) {
1867 // Insert commas as we go... the first arg doesn't get a comma
1871 TypePrinter.print(FT->getParamType(i), Out);
1873 if (Attrs.hasAttributes(i+1))
1874 Out << ' ' << Attrs.getAsString(i+1);
1878 // Finish printing arguments...
1879 if (FT->isVarArg()) {
1880 if (FT->getNumParams()) Out << ", ";
1881 Out << "..."; // Output varargs portion of signature!
1884 if (F->hasUnnamedAddr())
1885 Out << " unnamed_addr";
1886 if (Attrs.hasAttributes(AttributeSet::FunctionIndex))
1887 Out << " #" << Machine.getAttributeGroupSlot(Attrs.getFnAttributes());
1888 if (F->hasSection()) {
1889 Out << " section \"";
1890 PrintEscapedString(F->getSection(), Out);
1893 if (F->hasComdat()) {
1895 PrintLLVMName(Out, F->getComdat()->getName(), ComdatPrefix);
1897 if (F->getAlignment())
1898 Out << " align " << F->getAlignment();
1900 Out << " gc \"" << F->getGC() << '"';
1901 if (F->hasPrefixData()) {
1903 writeOperand(F->getPrefixData(), true);
1905 if (F->isDeclaration()) {
1909 // Output all of the function's basic blocks.
1910 for (Function::const_iterator I = F->begin(), E = F->end(); I != E; ++I)
1913 // Output the function's use-lists.
1919 Machine.purgeFunction();
1922 /// printArgument - This member is called for every argument that is passed into
1923 /// the function. Simply print it out
1925 void AssemblyWriter::printArgument(const Argument *Arg,
1926 AttributeSet Attrs, unsigned Idx) {
1928 TypePrinter.print(Arg->getType(), Out);
1930 // Output parameter attributes list
1931 if (Attrs.hasAttributes(Idx))
1932 Out << ' ' << Attrs.getAsString(Idx);
1934 // Output name, if available...
1935 if (Arg->hasName()) {
1937 PrintLLVMName(Out, Arg);
1941 /// printBasicBlock - This member is called for each basic block in a method.
1943 void AssemblyWriter::printBasicBlock(const BasicBlock *BB) {
1944 if (BB->hasName()) { // Print out the label if it exists...
1946 PrintLLVMName(Out, BB->getName(), LabelPrefix);
1948 } else if (!BB->use_empty()) { // Don't print block # of no uses...
1949 Out << "\n; <label>:";
1950 int Slot = Machine.getLocalSlot(BB);
1957 if (!BB->getParent()) {
1958 Out.PadToColumn(50);
1959 Out << "; Error: Block without parent!";
1960 } else if (BB != &BB->getParent()->getEntryBlock()) { // Not the entry block?
1961 // Output predecessors for the block.
1962 Out.PadToColumn(50);
1964 const_pred_iterator PI = pred_begin(BB), PE = pred_end(BB);
1967 Out << " No predecessors!";
1970 writeOperand(*PI, false);
1971 for (++PI; PI != PE; ++PI) {
1973 writeOperand(*PI, false);
1980 if (AnnotationWriter) AnnotationWriter->emitBasicBlockStartAnnot(BB, Out);
1982 // Output all of the instructions in the basic block...
1983 for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I != E; ++I) {
1984 printInstructionLine(*I);
1987 if (AnnotationWriter) AnnotationWriter->emitBasicBlockEndAnnot(BB, Out);
1990 /// printInstructionLine - Print an instruction and a newline character.
1991 void AssemblyWriter::printInstructionLine(const Instruction &I) {
1992 printInstruction(I);
1996 /// printInfoComment - Print a little comment after the instruction indicating
1997 /// which slot it occupies.
1999 void AssemblyWriter::printInfoComment(const Value &V) {
2000 if (AnnotationWriter)
2001 AnnotationWriter->printInfoComment(V, Out);
2004 // This member is called for each Instruction in a function..
2005 void AssemblyWriter::printInstruction(const Instruction &I) {
2006 if (AnnotationWriter) AnnotationWriter->emitInstructionAnnot(&I, Out);
2008 // Print out indentation for an instruction.
2011 // Print out name if it exists...
2013 PrintLLVMName(Out, &I);
2015 } else if (!I.getType()->isVoidTy()) {
2016 // Print out the def slot taken.
2017 int SlotNum = Machine.getLocalSlot(&I);
2019 Out << "<badref> = ";
2021 Out << '%' << SlotNum << " = ";
2024 if (const CallInst *CI = dyn_cast<CallInst>(&I)) {
2025 if (CI->isMustTailCall())
2027 else if (CI->isTailCall())
2031 // Print out the opcode...
2032 Out << I.getOpcodeName();
2034 // If this is an atomic load or store, print out the atomic marker.
2035 if ((isa<LoadInst>(I) && cast<LoadInst>(I).isAtomic()) ||
2036 (isa<StoreInst>(I) && cast<StoreInst>(I).isAtomic()))
2039 if (isa<AtomicCmpXchgInst>(I) && cast<AtomicCmpXchgInst>(I).isWeak())
2042 // If this is a volatile operation, print out the volatile marker.
2043 if ((isa<LoadInst>(I) && cast<LoadInst>(I).isVolatile()) ||
2044 (isa<StoreInst>(I) && cast<StoreInst>(I).isVolatile()) ||
2045 (isa<AtomicCmpXchgInst>(I) && cast<AtomicCmpXchgInst>(I).isVolatile()) ||
2046 (isa<AtomicRMWInst>(I) && cast<AtomicRMWInst>(I).isVolatile()))
2049 // Print out optimization information.
2050 WriteOptimizationInfo(Out, &I);
2052 // Print out the compare instruction predicates
2053 if (const CmpInst *CI = dyn_cast<CmpInst>(&I))
2054 Out << ' ' << getPredicateText(CI->getPredicate());
2056 // Print out the atomicrmw operation
2057 if (const AtomicRMWInst *RMWI = dyn_cast<AtomicRMWInst>(&I))
2058 writeAtomicRMWOperation(Out, RMWI->getOperation());
2060 // Print out the type of the operands...
2061 const Value *Operand = I.getNumOperands() ? I.getOperand(0) : nullptr;
2063 // Special case conditional branches to swizzle the condition out to the front
2064 if (isa<BranchInst>(I) && cast<BranchInst>(I).isConditional()) {
2065 const BranchInst &BI(cast<BranchInst>(I));
2067 writeOperand(BI.getCondition(), true);
2069 writeOperand(BI.getSuccessor(0), true);
2071 writeOperand(BI.getSuccessor(1), true);
2073 } else if (isa<SwitchInst>(I)) {
2074 const SwitchInst& SI(cast<SwitchInst>(I));
2075 // Special case switch instruction to get formatting nice and correct.
2077 writeOperand(SI.getCondition(), true);
2079 writeOperand(SI.getDefaultDest(), true);
2081 for (SwitchInst::ConstCaseIt i = SI.case_begin(), e = SI.case_end();
2084 writeOperand(i.getCaseValue(), true);
2086 writeOperand(i.getCaseSuccessor(), true);
2089 } else if (isa<IndirectBrInst>(I)) {
2090 // Special case indirectbr instruction to get formatting nice and correct.
2092 writeOperand(Operand, true);
2095 for (unsigned i = 1, e = I.getNumOperands(); i != e; ++i) {
2098 writeOperand(I.getOperand(i), true);
2101 } else if (const PHINode *PN = dyn_cast<PHINode>(&I)) {
2103 TypePrinter.print(I.getType(), Out);
2106 for (unsigned op = 0, Eop = PN->getNumIncomingValues(); op < Eop; ++op) {
2107 if (op) Out << ", ";
2109 writeOperand(PN->getIncomingValue(op), false); Out << ", ";
2110 writeOperand(PN->getIncomingBlock(op), false); Out << " ]";
2112 } else if (const ExtractValueInst *EVI = dyn_cast<ExtractValueInst>(&I)) {
2114 writeOperand(I.getOperand(0), true);
2115 for (const unsigned *i = EVI->idx_begin(), *e = EVI->idx_end(); i != e; ++i)
2117 } else if (const InsertValueInst *IVI = dyn_cast<InsertValueInst>(&I)) {
2119 writeOperand(I.getOperand(0), true); Out << ", ";
2120 writeOperand(I.getOperand(1), true);
2121 for (const unsigned *i = IVI->idx_begin(), *e = IVI->idx_end(); i != e; ++i)
2123 } else if (const LandingPadInst *LPI = dyn_cast<LandingPadInst>(&I)) {
2125 TypePrinter.print(I.getType(), Out);
2126 Out << " personality ";
2127 writeOperand(I.getOperand(0), true); Out << '\n';
2129 if (LPI->isCleanup())
2132 for (unsigned i = 0, e = LPI->getNumClauses(); i != e; ++i) {
2133 if (i != 0 || LPI->isCleanup()) Out << "\n";
2134 if (LPI->isCatch(i))
2139 writeOperand(LPI->getClause(i), true);
2141 } else if (isa<ReturnInst>(I) && !Operand) {
2143 } else if (const CallInst *CI = dyn_cast<CallInst>(&I)) {
2144 // Print the calling convention being used.
2145 if (CI->getCallingConv() != CallingConv::C) {
2147 PrintCallingConv(CI->getCallingConv(), Out);
2150 Operand = CI->getCalledValue();
2151 PointerType *PTy = cast<PointerType>(Operand->getType());
2152 FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
2153 Type *RetTy = FTy->getReturnType();
2154 const AttributeSet &PAL = CI->getAttributes();
2156 if (PAL.hasAttributes(AttributeSet::ReturnIndex))
2157 Out << ' ' << PAL.getAsString(AttributeSet::ReturnIndex);
2159 // If possible, print out the short form of the call instruction. We can
2160 // only do this if the first argument is a pointer to a nonvararg function,
2161 // and if the return type is not a pointer to a function.
2164 if (!FTy->isVarArg() &&
2165 (!RetTy->isPointerTy() ||
2166 !cast<PointerType>(RetTy)->getElementType()->isFunctionTy())) {
2167 TypePrinter.print(RetTy, Out);
2169 writeOperand(Operand, false);
2171 writeOperand(Operand, true);
2174 for (unsigned op = 0, Eop = CI->getNumArgOperands(); op < Eop; ++op) {
2177 writeParamOperand(CI->getArgOperand(op), PAL, op + 1);
2180 // Emit an ellipsis if this is a musttail call in a vararg function. This
2181 // is only to aid readability, musttail calls forward varargs by default.
2182 if (CI->isMustTailCall() && CI->getParent() &&
2183 CI->getParent()->getParent() &&
2184 CI->getParent()->getParent()->isVarArg())
2188 if (PAL.hasAttributes(AttributeSet::FunctionIndex))
2189 Out << " #" << Machine.getAttributeGroupSlot(PAL.getFnAttributes());
2190 } else if (const InvokeInst *II = dyn_cast<InvokeInst>(&I)) {
2191 Operand = II->getCalledValue();
2192 PointerType *PTy = cast<PointerType>(Operand->getType());
2193 FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
2194 Type *RetTy = FTy->getReturnType();
2195 const AttributeSet &PAL = II->getAttributes();
2197 // Print the calling convention being used.
2198 if (II->getCallingConv() != CallingConv::C) {
2200 PrintCallingConv(II->getCallingConv(), Out);
2203 if (PAL.hasAttributes(AttributeSet::ReturnIndex))
2204 Out << ' ' << PAL.getAsString(AttributeSet::ReturnIndex);
2206 // If possible, print out the short form of the invoke instruction. We can
2207 // only do this if the first argument is a pointer to a nonvararg function,
2208 // and if the return type is not a pointer to a function.
2211 if (!FTy->isVarArg() &&
2212 (!RetTy->isPointerTy() ||
2213 !cast<PointerType>(RetTy)->getElementType()->isFunctionTy())) {
2214 TypePrinter.print(RetTy, Out);
2216 writeOperand(Operand, false);
2218 writeOperand(Operand, true);
2221 for (unsigned op = 0, Eop = II->getNumArgOperands(); op < Eop; ++op) {
2224 writeParamOperand(II->getArgOperand(op), PAL, op + 1);
2228 if (PAL.hasAttributes(AttributeSet::FunctionIndex))
2229 Out << " #" << Machine.getAttributeGroupSlot(PAL.getFnAttributes());
2232 writeOperand(II->getNormalDest(), true);
2234 writeOperand(II->getUnwindDest(), true);
2236 } else if (const AllocaInst *AI = dyn_cast<AllocaInst>(&I)) {
2238 if (AI->isUsedWithInAlloca())
2240 TypePrinter.print(AI->getAllocatedType(), Out);
2241 if (!AI->getArraySize() || AI->isArrayAllocation()) {
2243 writeOperand(AI->getArraySize(), true);
2245 if (AI->getAlignment()) {
2246 Out << ", align " << AI->getAlignment();
2248 } else if (isa<CastInst>(I)) {
2251 writeOperand(Operand, true); // Work with broken code
2254 TypePrinter.print(I.getType(), Out);
2255 } else if (isa<VAArgInst>(I)) {
2258 writeOperand(Operand, true); // Work with broken code
2261 TypePrinter.print(I.getType(), Out);
2262 } else if (Operand) { // Print the normal way.
2264 // PrintAllTypes - Instructions who have operands of all the same type
2265 // omit the type from all but the first operand. If the instruction has
2266 // different type operands (for example br), then they are all printed.
2267 bool PrintAllTypes = false;
2268 Type *TheType = Operand->getType();
2270 // Select, Store and ShuffleVector always print all types.
2271 if (isa<SelectInst>(I) || isa<StoreInst>(I) || isa<ShuffleVectorInst>(I)
2272 || isa<ReturnInst>(I)) {
2273 PrintAllTypes = true;
2275 for (unsigned i = 1, E = I.getNumOperands(); i != E; ++i) {
2276 Operand = I.getOperand(i);
2277 // note that Operand shouldn't be null, but the test helps make dump()
2278 // more tolerant of malformed IR
2279 if (Operand && Operand->getType() != TheType) {
2280 PrintAllTypes = true; // We have differing types! Print them all!
2286 if (!PrintAllTypes) {
2288 TypePrinter.print(TheType, Out);
2292 for (unsigned i = 0, E = I.getNumOperands(); i != E; ++i) {
2294 writeOperand(I.getOperand(i), PrintAllTypes);
2298 // Print atomic ordering/alignment for memory operations
2299 if (const LoadInst *LI = dyn_cast<LoadInst>(&I)) {
2301 writeAtomic(LI->getOrdering(), LI->getSynchScope());
2302 if (LI->getAlignment())
2303 Out << ", align " << LI->getAlignment();
2304 } else if (const StoreInst *SI = dyn_cast<StoreInst>(&I)) {
2306 writeAtomic(SI->getOrdering(), SI->getSynchScope());
2307 if (SI->getAlignment())
2308 Out << ", align " << SI->getAlignment();
2309 } else if (const AtomicCmpXchgInst *CXI = dyn_cast<AtomicCmpXchgInst>(&I)) {
2310 writeAtomicCmpXchg(CXI->getSuccessOrdering(), CXI->getFailureOrdering(),
2311 CXI->getSynchScope());
2312 } else if (const AtomicRMWInst *RMWI = dyn_cast<AtomicRMWInst>(&I)) {
2313 writeAtomic(RMWI->getOrdering(), RMWI->getSynchScope());
2314 } else if (const FenceInst *FI = dyn_cast<FenceInst>(&I)) {
2315 writeAtomic(FI->getOrdering(), FI->getSynchScope());
2318 // Print Metadata info.
2319 SmallVector<std::pair<unsigned, Value *>, 4> InstMD;
2320 I.getAllMetadata(InstMD);
2321 if (!InstMD.empty()) {
2322 SmallVector<StringRef, 8> MDNames;
2323 I.getType()->getContext().getMDKindNames(MDNames);
2324 for (unsigned i = 0, e = InstMD.size(); i != e; ++i) {
2325 unsigned Kind = InstMD[i].first;
2326 if (Kind < MDNames.size()) {
2327 Out << ", !" << MDNames[Kind];
2329 Out << ", !<unknown kind #" << Kind << ">";
2332 WriteAsOperandInternal(Out, cast<MDNode>(InstMD[i].second), &TypePrinter,
2333 &Machine, TheModule);
2336 printInfoComment(I);
2339 static void WriteMDNodeComment(const MDNode *Node,
2340 formatted_raw_ostream &Out) {
2341 if (Node->getNumOperands() < 1)
2344 Value *Op = Node->getOperand(0);
2345 if (!Op || !isa<MDString>(Op))
2348 DIDescriptor Desc(Node);
2352 unsigned Tag = Desc.getTag();
2353 Out.PadToColumn(50);
2354 if (dwarf::TagString(Tag)) {
2357 } else if (Tag == dwarf::DW_TAG_user_base) {
2358 Out << "; [ DW_TAG_user_base ]";
2362 void AssemblyWriter::writeMDNode(unsigned Slot, const MDNode *Node) {
2363 Out << '!' << Slot << " = metadata ";
2364 printMDNodeBody(Node);
2367 void AssemblyWriter::writeAllMDNodes() {
2368 SmallVector<const MDNode *, 16> Nodes;
2369 Nodes.resize(Machine.mdn_size());
2370 for (SlotTracker::mdn_iterator I = Machine.mdn_begin(), E = Machine.mdn_end();
2372 Nodes[I->second] = cast<MDNode>(I->first);
2374 for (unsigned i = 0, e = Nodes.size(); i != e; ++i) {
2375 writeMDNode(i, Nodes[i]);
2379 void AssemblyWriter::printMDNodeBody(const MDNode *Node) {
2380 WriteMDNodeBodyInternal(Out, Node, &TypePrinter, &Machine, TheModule);
2381 WriteMDNodeComment(Node, Out);
2385 void AssemblyWriter::writeAllAttributeGroups() {
2386 std::vector<std::pair<AttributeSet, unsigned> > asVec;
2387 asVec.resize(Machine.as_size());
2389 for (SlotTracker::as_iterator I = Machine.as_begin(), E = Machine.as_end();
2391 asVec[I->second] = *I;
2393 for (std::vector<std::pair<AttributeSet, unsigned> >::iterator
2394 I = asVec.begin(), E = asVec.end(); I != E; ++I)
2395 Out << "attributes #" << I->second << " = { "
2396 << I->first.getAsString(AttributeSet::FunctionIndex, true) << " }\n";
2401 void AssemblyWriter::printUseListOrder(const UseListOrder &Order) {
2402 bool IsInFunction = Machine.getFunction();
2406 Out << "uselistorder";
2407 if (const BasicBlock *BB =
2408 IsInFunction ? nullptr : dyn_cast<BasicBlock>(Order.V)) {
2410 writeOperand(BB->getParent(), false);
2412 writeOperand(BB, false);
2415 writeOperand(Order.V, true);
2419 assert(Order.Shuffle.size() >= 2 && "Shuffle too small");
2420 Out << Order.Shuffle[0];
2421 for (unsigned I = 1, E = Order.Shuffle.size(); I != E; ++I)
2422 Out << ", " << Order.Shuffle[I];
2426 void AssemblyWriter::printUseLists(const Function *F) {
2428 [&]() { return !UseListOrders.empty() && UseListOrders.back().F == F; };
2433 Out << "\n; uselistorder directives\n";
2435 printUseListOrder(UseListOrders.back());
2436 UseListOrders.pop_back();
2440 //===----------------------------------------------------------------------===//
2441 // External Interface declarations
2442 //===----------------------------------------------------------------------===//
2444 void Module::print(raw_ostream &ROS, AssemblyAnnotationWriter *AAW) const {
2445 SlotTracker SlotTable(this);
2446 formatted_raw_ostream OS(ROS);
2447 AssemblyWriter W(OS, SlotTable, this, AAW);
2448 W.printModule(this);
2451 void NamedMDNode::print(raw_ostream &ROS) const {
2452 SlotTracker SlotTable(getParent());
2453 formatted_raw_ostream OS(ROS);
2454 AssemblyWriter W(OS, SlotTable, getParent(), nullptr);
2455 W.printNamedMDNode(this);
2458 void Comdat::print(raw_ostream &ROS) const {
2459 PrintLLVMName(ROS, getName(), ComdatPrefix);
2460 ROS << " = comdat ";
2462 switch (getSelectionKind()) {
2466 case Comdat::ExactMatch:
2467 ROS << "exactmatch";
2469 case Comdat::Largest:
2472 case Comdat::NoDuplicates:
2473 ROS << "noduplicates";
2475 case Comdat::SameSize:
2483 void Type::print(raw_ostream &OS) const {
2485 TP.print(const_cast<Type*>(this), OS);
2487 // If the type is a named struct type, print the body as well.
2488 if (StructType *STy = dyn_cast<StructType>(const_cast<Type*>(this)))
2489 if (!STy->isLiteral()) {
2491 TP.printStructBody(STy, OS);
2495 void Value::print(raw_ostream &ROS) const {
2496 formatted_raw_ostream OS(ROS);
2497 if (const Instruction *I = dyn_cast<Instruction>(this)) {
2498 const Function *F = I->getParent() ? I->getParent()->getParent() : nullptr;
2499 SlotTracker SlotTable(F);
2500 AssemblyWriter W(OS, SlotTable, getModuleFromVal(I), nullptr);
2501 W.printInstruction(*I);
2502 } else if (const BasicBlock *BB = dyn_cast<BasicBlock>(this)) {
2503 SlotTracker SlotTable(BB->getParent());
2504 AssemblyWriter W(OS, SlotTable, getModuleFromVal(BB), nullptr);
2505 W.printBasicBlock(BB);
2506 } else if (const GlobalValue *GV = dyn_cast<GlobalValue>(this)) {
2507 SlotTracker SlotTable(GV->getParent());
2508 AssemblyWriter W(OS, SlotTable, GV->getParent(), nullptr);
2509 if (const GlobalVariable *V = dyn_cast<GlobalVariable>(GV))
2511 else if (const Function *F = dyn_cast<Function>(GV))
2514 W.printAlias(cast<GlobalAlias>(GV));
2515 } else if (const MDNode *N = dyn_cast<MDNode>(this)) {
2516 const Function *F = N->getFunction();
2517 SlotTracker SlotTable(F);
2518 AssemblyWriter W(OS, SlotTable, F ? F->getParent() : nullptr, nullptr);
2519 W.printMDNodeBody(N);
2520 } else if (const Constant *C = dyn_cast<Constant>(this)) {
2521 TypePrinting TypePrinter;
2522 TypePrinter.print(C->getType(), OS);
2524 WriteConstantInternal(OS, C, TypePrinter, nullptr, nullptr);
2525 } else if (isa<InlineAsm>(this) || isa<MDString>(this) ||
2526 isa<Argument>(this)) {
2527 this->printAsOperand(OS);
2529 llvm_unreachable("Unknown value to print out!");
2533 void Value::printAsOperand(raw_ostream &O, bool PrintType, const Module *M) const {
2534 // Fast path: Don't construct and populate a TypePrinting object if we
2535 // won't be needing any types printed.
2537 ((!isa<Constant>(this) && !isa<MDNode>(this)) ||
2538 hasName() || isa<GlobalValue>(this))) {
2539 WriteAsOperandInternal(O, this, nullptr, nullptr, M);
2544 M = getModuleFromVal(this);
2546 TypePrinting TypePrinter;
2548 TypePrinter.incorporateTypes(*M);
2550 TypePrinter.print(getType(), O);
2554 WriteAsOperandInternal(O, this, &TypePrinter, nullptr, M);
2557 // Value::dump - allow easy printing of Values from the debugger.
2558 void Value::dump() const { print(dbgs()); dbgs() << '\n'; }
2560 // Type::dump - allow easy printing of Types from the debugger.
2561 void Type::dump() const { print(dbgs()); dbgs() << '\n'; }
2563 // Module::dump() - Allow printing of Modules from the debugger.
2564 void Module::dump() const { print(dbgs(), nullptr); }
2566 // \brief Allow printing of Comdats from the debugger.
2567 void Comdat::dump() const { print(dbgs()); }
2569 // NamedMDNode::dump() - Allow printing of NamedMDNodes from the debugger.
2570 void NamedMDNode::dump() const { print(dbgs()); }