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);
105 if (F.hasPrologueData())
106 if (!isa<GlobalValue>(F.getPrologueData()))
107 orderValue(F.getPrologueData(), OM);
111 if (F.isDeclaration())
114 for (const Argument &A : F.args())
116 for (const BasicBlock &BB : F) {
118 for (const Instruction &I : BB) {
119 for (const Value *Op : I.operands())
120 if ((isa<Constant>(*Op) && !isa<GlobalValue>(*Op)) ||
130 static void predictValueUseListOrderImpl(const Value *V, const Function *F,
131 unsigned ID, const OrderMap &OM,
132 UseListOrderStack &Stack) {
133 // Predict use-list order for this one.
134 typedef std::pair<const Use *, unsigned> Entry;
135 SmallVector<Entry, 64> List;
136 for (const Use &U : V->uses())
137 // Check if this user will be serialized.
138 if (OM.lookup(U.getUser()).first)
139 List.push_back(std::make_pair(&U, List.size()));
142 // We may have lost some users.
146 !isa<GlobalVariable>(V) && !isa<Function>(V) && !isa<BasicBlock>(V);
147 if (auto *BA = dyn_cast<BlockAddress>(V))
148 ID = OM.lookup(BA->getBasicBlock()).first;
149 std::sort(List.begin(), List.end(), [&](const Entry &L, const Entry &R) {
150 const Use *LU = L.first;
151 const Use *RU = R.first;
155 auto LID = OM.lookup(LU->getUser()).first;
156 auto RID = OM.lookup(RU->getUser()).first;
158 // If ID is 4, then expect: 7 6 5 1 2 3.
172 // LID and RID are equal, so we have different operands of the same user.
173 // Assume operands are added in order for all instructions.
176 return LU->getOperandNo() < RU->getOperandNo();
177 return LU->getOperandNo() > RU->getOperandNo();
181 List.begin(), List.end(),
182 [](const Entry &L, const Entry &R) { return L.second < R.second; }))
183 // Order is already correct.
186 // Store the shuffle.
187 Stack.emplace_back(V, F, List.size());
188 assert(List.size() == Stack.back().Shuffle.size() && "Wrong size");
189 for (size_t I = 0, E = List.size(); I != E; ++I)
190 Stack.back().Shuffle[I] = List[I].second;
193 static void predictValueUseListOrder(const Value *V, const Function *F,
194 OrderMap &OM, UseListOrderStack &Stack) {
195 auto &IDPair = OM[V];
196 assert(IDPair.first && "Unmapped value");
198 // Already predicted.
201 // Do the actual prediction.
202 IDPair.second = true;
203 if (!V->use_empty() && std::next(V->use_begin()) != V->use_end())
204 predictValueUseListOrderImpl(V, F, IDPair.first, OM, Stack);
206 // Recursive descent into constants.
207 if (const Constant *C = dyn_cast<Constant>(V))
208 if (C->getNumOperands()) // Visit GlobalValues.
209 for (const Value *Op : C->operands())
210 if (isa<Constant>(Op)) // Visit GlobalValues.
211 predictValueUseListOrder(Op, F, OM, Stack);
214 static UseListOrderStack predictUseListOrder(const Module *M) {
215 OrderMap OM = orderModule(M);
217 // Use-list orders need to be serialized after all the users have been added
218 // to a value, or else the shuffles will be incomplete. Store them per
219 // function in a stack.
221 // Aside from function order, the order of values doesn't matter much here.
222 UseListOrderStack Stack;
224 // We want to visit the functions backward now so we can list function-local
225 // constants in the last Function they're used in. Module-level constants
226 // have already been visited above.
227 for (auto I = M->rbegin(), E = M->rend(); I != E; ++I) {
228 const Function &F = *I;
229 if (F.isDeclaration())
231 for (const BasicBlock &BB : F)
232 predictValueUseListOrder(&BB, &F, OM, Stack);
233 for (const Argument &A : F.args())
234 predictValueUseListOrder(&A, &F, OM, Stack);
235 for (const BasicBlock &BB : F)
236 for (const Instruction &I : BB)
237 for (const Value *Op : I.operands())
238 if (isa<Constant>(*Op) || isa<InlineAsm>(*Op)) // Visit GlobalValues.
239 predictValueUseListOrder(Op, &F, OM, Stack);
240 for (const BasicBlock &BB : F)
241 for (const Instruction &I : BB)
242 predictValueUseListOrder(&I, &F, OM, Stack);
245 // Visit globals last.
246 for (const GlobalVariable &G : M->globals())
247 predictValueUseListOrder(&G, nullptr, OM, Stack);
248 for (const Function &F : *M)
249 predictValueUseListOrder(&F, nullptr, OM, Stack);
250 for (const GlobalAlias &A : M->aliases())
251 predictValueUseListOrder(&A, nullptr, OM, Stack);
252 for (const GlobalVariable &G : M->globals())
253 if (G.hasInitializer())
254 predictValueUseListOrder(G.getInitializer(), nullptr, OM, Stack);
255 for (const GlobalAlias &A : M->aliases())
256 predictValueUseListOrder(A.getAliasee(), nullptr, OM, Stack);
257 for (const Function &F : *M)
258 if (F.hasPrefixData())
259 predictValueUseListOrder(F.getPrefixData(), nullptr, OM, Stack);
264 static const Module *getModuleFromVal(const Value *V) {
265 if (const Argument *MA = dyn_cast<Argument>(V))
266 return MA->getParent() ? MA->getParent()->getParent() : nullptr;
268 if (const BasicBlock *BB = dyn_cast<BasicBlock>(V))
269 return BB->getParent() ? BB->getParent()->getParent() : nullptr;
271 if (const Instruction *I = dyn_cast<Instruction>(V)) {
272 const Function *M = I->getParent() ? I->getParent()->getParent() : nullptr;
273 return M ? M->getParent() : nullptr;
276 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V))
277 return GV->getParent();
281 static void PrintCallingConv(unsigned cc, raw_ostream &Out) {
283 default: Out << "cc" << cc; break;
284 case CallingConv::Fast: Out << "fastcc"; break;
285 case CallingConv::Cold: Out << "coldcc"; break;
286 case CallingConv::WebKit_JS: Out << "webkit_jscc"; break;
287 case CallingConv::AnyReg: Out << "anyregcc"; break;
288 case CallingConv::PreserveMost: Out << "preserve_mostcc"; break;
289 case CallingConv::PreserveAll: Out << "preserve_allcc"; break;
290 case CallingConv::GHC: Out << "ghccc"; break;
291 case CallingConv::X86_StdCall: Out << "x86_stdcallcc"; break;
292 case CallingConv::X86_FastCall: Out << "x86_fastcallcc"; break;
293 case CallingConv::X86_ThisCall: Out << "x86_thiscallcc"; break;
294 case CallingConv::X86_VectorCall:Out << "x86_vectorcallcc"; break;
295 case CallingConv::Intel_OCL_BI: Out << "intel_ocl_bicc"; break;
296 case CallingConv::ARM_APCS: Out << "arm_apcscc"; break;
297 case CallingConv::ARM_AAPCS: Out << "arm_aapcscc"; break;
298 case CallingConv::ARM_AAPCS_VFP: Out << "arm_aapcs_vfpcc"; break;
299 case CallingConv::MSP430_INTR: Out << "msp430_intrcc"; break;
300 case CallingConv::PTX_Kernel: Out << "ptx_kernel"; break;
301 case CallingConv::PTX_Device: Out << "ptx_device"; break;
302 case CallingConv::X86_64_SysV: Out << "x86_64_sysvcc"; break;
303 case CallingConv::X86_64_Win64: Out << "x86_64_win64cc"; break;
304 case CallingConv::SPIR_FUNC: Out << "spir_func"; break;
305 case CallingConv::SPIR_KERNEL: Out << "spir_kernel"; break;
309 // PrintEscapedString - Print each character of the specified string, escaping
310 // it if it is not printable or if it is an escape char.
311 static void PrintEscapedString(StringRef Name, raw_ostream &Out) {
312 for (unsigned i = 0, e = Name.size(); i != e; ++i) {
313 unsigned char C = Name[i];
314 if (isprint(C) && C != '\\' && C != '"')
317 Out << '\\' << hexdigit(C >> 4) << hexdigit(C & 0x0F);
329 /// PrintLLVMName - Turn the specified name into an 'LLVM name', which is either
330 /// prefixed with % (if the string only contains simple characters) or is
331 /// surrounded with ""'s (if it has special chars in it). Print it out.
332 static void PrintLLVMName(raw_ostream &OS, StringRef Name, PrefixType Prefix) {
333 assert(!Name.empty() && "Cannot get empty name!");
335 case NoPrefix: break;
336 case GlobalPrefix: OS << '@'; break;
337 case ComdatPrefix: OS << '$'; break;
338 case LabelPrefix: break;
339 case LocalPrefix: OS << '%'; break;
342 // Scan the name to see if it needs quotes first.
343 bool NeedsQuotes = isdigit(static_cast<unsigned char>(Name[0]));
345 for (unsigned i = 0, e = Name.size(); i != e; ++i) {
346 // By making this unsigned, the value passed in to isalnum will always be
347 // in the range 0-255. This is important when building with MSVC because
348 // its implementation will assert. This situation can arise when dealing
349 // with UTF-8 multibyte characters.
350 unsigned char C = Name[i];
351 if (!isalnum(static_cast<unsigned char>(C)) && C != '-' && C != '.' &&
359 // If we didn't need any quotes, just write out the name in one blast.
365 // Okay, we need quotes. Output the quotes and escape any scary characters as
368 PrintEscapedString(Name, OS);
372 /// PrintLLVMName - Turn the specified name into an 'LLVM name', which is either
373 /// prefixed with % (if the string only contains simple characters) or is
374 /// surrounded with ""'s (if it has special chars in it). Print it out.
375 static void PrintLLVMName(raw_ostream &OS, const Value *V) {
376 PrintLLVMName(OS, V->getName(),
377 isa<GlobalValue>(V) ? GlobalPrefix : LocalPrefix);
383 void TypePrinting::incorporateTypes(const Module &M) {
384 NamedTypes.run(M, false);
386 // The list of struct types we got back includes all the struct types, split
387 // the unnamed ones out to a numbering and remove the anonymous structs.
388 unsigned NextNumber = 0;
390 std::vector<StructType*>::iterator NextToUse = NamedTypes.begin(), I, E;
391 for (I = NamedTypes.begin(), E = NamedTypes.end(); I != E; ++I) {
392 StructType *STy = *I;
394 // Ignore anonymous types.
395 if (STy->isLiteral())
398 if (STy->getName().empty())
399 NumberedTypes[STy] = NextNumber++;
404 NamedTypes.erase(NextToUse, NamedTypes.end());
408 /// CalcTypeName - Write the specified type to the specified raw_ostream, making
409 /// use of type names or up references to shorten the type name where possible.
410 void TypePrinting::print(Type *Ty, raw_ostream &OS) {
411 switch (Ty->getTypeID()) {
412 case Type::VoidTyID: OS << "void"; return;
413 case Type::HalfTyID: OS << "half"; return;
414 case Type::FloatTyID: OS << "float"; return;
415 case Type::DoubleTyID: OS << "double"; return;
416 case Type::X86_FP80TyID: OS << "x86_fp80"; return;
417 case Type::FP128TyID: OS << "fp128"; return;
418 case Type::PPC_FP128TyID: OS << "ppc_fp128"; return;
419 case Type::LabelTyID: OS << "label"; return;
420 case Type::MetadataTyID: OS << "metadata"; return;
421 case Type::X86_MMXTyID: OS << "x86_mmx"; return;
422 case Type::IntegerTyID:
423 OS << 'i' << cast<IntegerType>(Ty)->getBitWidth();
426 case Type::FunctionTyID: {
427 FunctionType *FTy = cast<FunctionType>(Ty);
428 print(FTy->getReturnType(), OS);
430 for (FunctionType::param_iterator I = FTy->param_begin(),
431 E = FTy->param_end(); I != E; ++I) {
432 if (I != FTy->param_begin())
436 if (FTy->isVarArg()) {
437 if (FTy->getNumParams()) OS << ", ";
443 case Type::StructTyID: {
444 StructType *STy = cast<StructType>(Ty);
446 if (STy->isLiteral())
447 return printStructBody(STy, OS);
449 if (!STy->getName().empty())
450 return PrintLLVMName(OS, STy->getName(), LocalPrefix);
452 DenseMap<StructType*, unsigned>::iterator I = NumberedTypes.find(STy);
453 if (I != NumberedTypes.end())
454 OS << '%' << I->second;
455 else // Not enumerated, print the hex address.
456 OS << "%\"type " << STy << '\"';
459 case Type::PointerTyID: {
460 PointerType *PTy = cast<PointerType>(Ty);
461 print(PTy->getElementType(), OS);
462 if (unsigned AddressSpace = PTy->getAddressSpace())
463 OS << " addrspace(" << AddressSpace << ')';
467 case Type::ArrayTyID: {
468 ArrayType *ATy = cast<ArrayType>(Ty);
469 OS << '[' << ATy->getNumElements() << " x ";
470 print(ATy->getElementType(), OS);
474 case Type::VectorTyID: {
475 VectorType *PTy = cast<VectorType>(Ty);
476 OS << "<" << PTy->getNumElements() << " x ";
477 print(PTy->getElementType(), OS);
482 llvm_unreachable("Invalid TypeID");
485 void TypePrinting::printStructBody(StructType *STy, raw_ostream &OS) {
486 if (STy->isOpaque()) {
494 if (STy->getNumElements() == 0) {
497 StructType::element_iterator I = STy->element_begin();
500 for (StructType::element_iterator E = STy->element_end(); I != E; ++I) {
511 //===----------------------------------------------------------------------===//
512 // SlotTracker Class: Enumerate slot numbers for unnamed values
513 //===----------------------------------------------------------------------===//
514 /// This class provides computation of slot numbers for LLVM Assembly writing.
518 /// ValueMap - A mapping of Values to slot numbers.
519 typedef DenseMap<const Value*, unsigned> ValueMap;
522 /// TheModule - The module for which we are holding slot numbers.
523 const Module* TheModule;
525 /// TheFunction - The function for which we are holding slot numbers.
526 const Function* TheFunction;
527 bool FunctionProcessed;
529 /// mMap - The slot map for the module level data.
533 /// fMap - The slot map for the function level data.
537 /// mdnMap - Map for MDNodes.
538 DenseMap<const MDNode*, unsigned> mdnMap;
541 /// asMap - The slot map for attribute sets.
542 DenseMap<AttributeSet, unsigned> asMap;
545 /// Construct from a module
546 explicit SlotTracker(const Module *M);
547 /// Construct from a function, starting out in incorp state.
548 explicit SlotTracker(const Function *F);
550 /// Return the slot number of the specified value in it's type
551 /// plane. If something is not in the SlotTracker, return -1.
552 int getLocalSlot(const Value *V);
553 int getGlobalSlot(const GlobalValue *V);
554 int getMetadataSlot(const MDNode *N);
555 int getAttributeGroupSlot(AttributeSet AS);
557 /// If you'd like to deal with a function instead of just a module, use
558 /// this method to get its data into the SlotTracker.
559 void incorporateFunction(const Function *F) {
561 FunctionProcessed = false;
564 const Function *getFunction() const { return TheFunction; }
566 /// After calling incorporateFunction, use this method to remove the
567 /// most recently incorporated function from the SlotTracker. This
568 /// will reset the state of the machine back to just the module contents.
569 void purgeFunction();
571 /// MDNode map iterators.
572 typedef DenseMap<const MDNode*, unsigned>::iterator mdn_iterator;
573 mdn_iterator mdn_begin() { return mdnMap.begin(); }
574 mdn_iterator mdn_end() { return mdnMap.end(); }
575 unsigned mdn_size() const { return mdnMap.size(); }
576 bool mdn_empty() const { return mdnMap.empty(); }
578 /// AttributeSet map iterators.
579 typedef DenseMap<AttributeSet, unsigned>::iterator as_iterator;
580 as_iterator as_begin() { return asMap.begin(); }
581 as_iterator as_end() { return asMap.end(); }
582 unsigned as_size() const { return asMap.size(); }
583 bool as_empty() const { return asMap.empty(); }
585 /// This function does the actual initialization.
586 inline void initialize();
588 // Implementation Details
590 /// CreateModuleSlot - Insert the specified GlobalValue* into the slot table.
591 void CreateModuleSlot(const GlobalValue *V);
593 /// CreateMetadataSlot - Insert the specified MDNode* into the slot table.
594 void CreateMetadataSlot(const MDNode *N);
596 /// CreateFunctionSlot - Insert the specified Value* into the slot table.
597 void CreateFunctionSlot(const Value *V);
599 /// \brief Insert the specified AttributeSet into the slot table.
600 void CreateAttributeSetSlot(AttributeSet AS);
602 /// Add all of the module level global variables (and their initializers)
603 /// and function declarations, but not the contents of those functions.
604 void processModule();
606 /// Add all of the functions arguments, basic blocks, and instructions.
607 void processFunction();
609 SlotTracker(const SlotTracker &) LLVM_DELETED_FUNCTION;
610 void operator=(const SlotTracker &) LLVM_DELETED_FUNCTION;
613 SlotTracker *createSlotTracker(const Module *M) {
614 return new SlotTracker(M);
617 static SlotTracker *createSlotTracker(const Value *V) {
618 if (const Argument *FA = dyn_cast<Argument>(V))
619 return new SlotTracker(FA->getParent());
621 if (const Instruction *I = dyn_cast<Instruction>(V))
623 return new SlotTracker(I->getParent()->getParent());
625 if (const BasicBlock *BB = dyn_cast<BasicBlock>(V))
626 return new SlotTracker(BB->getParent());
628 if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(V))
629 return new SlotTracker(GV->getParent());
631 if (const GlobalAlias *GA = dyn_cast<GlobalAlias>(V))
632 return new SlotTracker(GA->getParent());
634 if (const Function *Func = dyn_cast<Function>(V))
635 return new SlotTracker(Func);
641 #define ST_DEBUG(X) dbgs() << X
646 // Module level constructor. Causes the contents of the Module (sans functions)
647 // to be added to the slot table.
648 SlotTracker::SlotTracker(const Module *M)
649 : TheModule(M), TheFunction(nullptr), FunctionProcessed(false), mNext(0),
650 fNext(0), mdnNext(0), asNext(0) {}
652 // Function level constructor. Causes the contents of the Module and the one
653 // function provided to be added to the slot table.
654 SlotTracker::SlotTracker(const Function *F)
655 : TheModule(F ? F->getParent() : nullptr), TheFunction(F),
656 FunctionProcessed(false), mNext(0), fNext(0), mdnNext(0), asNext(0) {}
658 inline void SlotTracker::initialize() {
661 TheModule = nullptr; ///< Prevent re-processing next time we're called.
664 if (TheFunction && !FunctionProcessed)
668 // Iterate through all the global variables, functions, and global
669 // variable initializers and create slots for them.
670 void SlotTracker::processModule() {
671 ST_DEBUG("begin processModule!\n");
673 // Add all of the unnamed global variables to the value table.
674 for (Module::const_global_iterator I = TheModule->global_begin(),
675 E = TheModule->global_end(); I != E; ++I) {
680 // Add metadata used by named metadata.
681 for (Module::const_named_metadata_iterator
682 I = TheModule->named_metadata_begin(),
683 E = TheModule->named_metadata_end(); I != E; ++I) {
684 const NamedMDNode *NMD = I;
685 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i)
686 CreateMetadataSlot(NMD->getOperand(i));
689 for (Module::const_iterator I = TheModule->begin(), E = TheModule->end();
692 // Add all the unnamed functions to the table.
695 // Add all the function attributes to the table.
696 // FIXME: Add attributes of other objects?
697 AttributeSet FnAttrs = I->getAttributes().getFnAttributes();
698 if (FnAttrs.hasAttributes(AttributeSet::FunctionIndex))
699 CreateAttributeSetSlot(FnAttrs);
702 ST_DEBUG("end processModule!\n");
705 // Process the arguments, basic blocks, and instructions of a function.
706 void SlotTracker::processFunction() {
707 ST_DEBUG("begin processFunction!\n");
710 // Add all the function arguments with no names.
711 for(Function::const_arg_iterator AI = TheFunction->arg_begin(),
712 AE = TheFunction->arg_end(); AI != AE; ++AI)
714 CreateFunctionSlot(AI);
716 ST_DEBUG("Inserting Instructions:\n");
718 SmallVector<std::pair<unsigned, MDNode *>, 4> MDForInst;
720 // Add all of the basic blocks and instructions with no names.
721 for (Function::const_iterator BB = TheFunction->begin(),
722 E = TheFunction->end(); BB != E; ++BB) {
724 CreateFunctionSlot(BB);
726 for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I != E;
728 if (!I->getType()->isVoidTy() && !I->hasName())
729 CreateFunctionSlot(I);
731 // Intrinsics can directly use metadata. We allow direct calls to any
732 // llvm.foo function here, because the target may not be linked into the
734 if (const CallInst *CI = dyn_cast<CallInst>(I)) {
735 if (Function *F = CI->getCalledFunction())
736 if (F->isIntrinsic())
737 for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i)
738 if (auto *V = dyn_cast_or_null<MetadataAsValue>(I->getOperand(i)))
739 if (MDNode *N = dyn_cast<MDNode>(V->getMetadata()))
740 CreateMetadataSlot(N);
742 // Add all the call attributes to the table.
743 AttributeSet Attrs = CI->getAttributes().getFnAttributes();
744 if (Attrs.hasAttributes(AttributeSet::FunctionIndex))
745 CreateAttributeSetSlot(Attrs);
746 } else if (const InvokeInst *II = dyn_cast<InvokeInst>(I)) {
747 // Add all the call attributes to the table.
748 AttributeSet Attrs = II->getAttributes().getFnAttributes();
749 if (Attrs.hasAttributes(AttributeSet::FunctionIndex))
750 CreateAttributeSetSlot(Attrs);
753 // Process metadata attached with this instruction.
754 I->getAllMetadata(MDForInst);
755 for (unsigned i = 0, e = MDForInst.size(); i != e; ++i)
756 CreateMetadataSlot(MDForInst[i].second);
761 FunctionProcessed = true;
763 ST_DEBUG("end processFunction!\n");
766 /// Clean up after incorporating a function. This is the only way to get out of
767 /// the function incorporation state that affects get*Slot/Create*Slot. Function
768 /// incorporation state is indicated by TheFunction != 0.
769 void SlotTracker::purgeFunction() {
770 ST_DEBUG("begin purgeFunction!\n");
771 fMap.clear(); // Simply discard the function level map
772 TheFunction = nullptr;
773 FunctionProcessed = false;
774 ST_DEBUG("end purgeFunction!\n");
777 /// getGlobalSlot - Get the slot number of a global value.
778 int SlotTracker::getGlobalSlot(const GlobalValue *V) {
779 // Check for uninitialized state and do lazy initialization.
782 // Find the value in the module map
783 ValueMap::iterator MI = mMap.find(V);
784 return MI == mMap.end() ? -1 : (int)MI->second;
787 /// getMetadataSlot - Get the slot number of a MDNode.
788 int SlotTracker::getMetadataSlot(const MDNode *N) {
789 // Check for uninitialized state and do lazy initialization.
792 // Find the MDNode in the module map
793 mdn_iterator MI = mdnMap.find(N);
794 return MI == mdnMap.end() ? -1 : (int)MI->second;
798 /// getLocalSlot - Get the slot number for a value that is local to a function.
799 int SlotTracker::getLocalSlot(const Value *V) {
800 assert(!isa<Constant>(V) && "Can't get a constant or global slot with this!");
802 // Check for uninitialized state and do lazy initialization.
805 ValueMap::iterator FI = fMap.find(V);
806 return FI == fMap.end() ? -1 : (int)FI->second;
809 int SlotTracker::getAttributeGroupSlot(AttributeSet AS) {
810 // Check for uninitialized state and do lazy initialization.
813 // Find the AttributeSet in the module map.
814 as_iterator AI = asMap.find(AS);
815 return AI == asMap.end() ? -1 : (int)AI->second;
818 /// CreateModuleSlot - Insert the specified GlobalValue* into the slot table.
819 void SlotTracker::CreateModuleSlot(const GlobalValue *V) {
820 assert(V && "Can't insert a null Value into SlotTracker!");
821 assert(!V->getType()->isVoidTy() && "Doesn't need a slot!");
822 assert(!V->hasName() && "Doesn't need a slot!");
824 unsigned DestSlot = mNext++;
827 ST_DEBUG(" Inserting value [" << V->getType() << "] = " << V << " slot=" <<
829 // G = Global, F = Function, A = Alias, o = other
830 ST_DEBUG((isa<GlobalVariable>(V) ? 'G' :
831 (isa<Function>(V) ? 'F' :
832 (isa<GlobalAlias>(V) ? 'A' : 'o'))) << "]\n");
835 /// CreateSlot - Create a new slot for the specified value if it has no name.
836 void SlotTracker::CreateFunctionSlot(const Value *V) {
837 assert(!V->getType()->isVoidTy() && !V->hasName() && "Doesn't need a slot!");
839 unsigned DestSlot = fNext++;
842 // G = Global, F = Function, o = other
843 ST_DEBUG(" Inserting value [" << V->getType() << "] = " << V << " slot=" <<
844 DestSlot << " [o]\n");
847 /// CreateModuleSlot - Insert the specified MDNode* into the slot table.
848 void SlotTracker::CreateMetadataSlot(const MDNode *N) {
849 assert(N && "Can't insert a null Value into SlotTracker!");
851 unsigned DestSlot = mdnNext;
852 if (!mdnMap.insert(std::make_pair(N, DestSlot)).second)
856 // Recursively add any MDNodes referenced by operands.
857 for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i)
858 if (const MDNode *Op = dyn_cast_or_null<MDNode>(N->getOperand(i)))
859 CreateMetadataSlot(Op);
862 void SlotTracker::CreateAttributeSetSlot(AttributeSet AS) {
863 assert(AS.hasAttributes(AttributeSet::FunctionIndex) &&
864 "Doesn't need a slot!");
866 as_iterator I = asMap.find(AS);
867 if (I != asMap.end())
870 unsigned DestSlot = asNext++;
871 asMap[AS] = DestSlot;
874 //===----------------------------------------------------------------------===//
875 // AsmWriter Implementation
876 //===----------------------------------------------------------------------===//
878 static void WriteAsOperandInternal(raw_ostream &Out, const Value *V,
879 TypePrinting *TypePrinter,
880 SlotTracker *Machine,
881 const Module *Context);
883 static void WriteAsOperandInternal(raw_ostream &Out, const Metadata *MD,
884 TypePrinting *TypePrinter,
885 SlotTracker *Machine, const Module *Context,
886 bool FromValue = false);
888 static const char *getPredicateText(unsigned predicate) {
889 const char * pred = "unknown";
891 case FCmpInst::FCMP_FALSE: pred = "false"; break;
892 case FCmpInst::FCMP_OEQ: pred = "oeq"; break;
893 case FCmpInst::FCMP_OGT: pred = "ogt"; break;
894 case FCmpInst::FCMP_OGE: pred = "oge"; break;
895 case FCmpInst::FCMP_OLT: pred = "olt"; break;
896 case FCmpInst::FCMP_OLE: pred = "ole"; break;
897 case FCmpInst::FCMP_ONE: pred = "one"; break;
898 case FCmpInst::FCMP_ORD: pred = "ord"; break;
899 case FCmpInst::FCMP_UNO: pred = "uno"; break;
900 case FCmpInst::FCMP_UEQ: pred = "ueq"; break;
901 case FCmpInst::FCMP_UGT: pred = "ugt"; break;
902 case FCmpInst::FCMP_UGE: pred = "uge"; break;
903 case FCmpInst::FCMP_ULT: pred = "ult"; break;
904 case FCmpInst::FCMP_ULE: pred = "ule"; break;
905 case FCmpInst::FCMP_UNE: pred = "une"; break;
906 case FCmpInst::FCMP_TRUE: pred = "true"; break;
907 case ICmpInst::ICMP_EQ: pred = "eq"; break;
908 case ICmpInst::ICMP_NE: pred = "ne"; break;
909 case ICmpInst::ICMP_SGT: pred = "sgt"; break;
910 case ICmpInst::ICMP_SGE: pred = "sge"; break;
911 case ICmpInst::ICMP_SLT: pred = "slt"; break;
912 case ICmpInst::ICMP_SLE: pred = "sle"; break;
913 case ICmpInst::ICMP_UGT: pred = "ugt"; break;
914 case ICmpInst::ICMP_UGE: pred = "uge"; break;
915 case ICmpInst::ICMP_ULT: pred = "ult"; break;
916 case ICmpInst::ICMP_ULE: pred = "ule"; break;
921 static void writeAtomicRMWOperation(raw_ostream &Out,
922 AtomicRMWInst::BinOp Op) {
924 default: Out << " <unknown operation " << Op << ">"; break;
925 case AtomicRMWInst::Xchg: Out << " xchg"; break;
926 case AtomicRMWInst::Add: Out << " add"; break;
927 case AtomicRMWInst::Sub: Out << " sub"; break;
928 case AtomicRMWInst::And: Out << " and"; break;
929 case AtomicRMWInst::Nand: Out << " nand"; break;
930 case AtomicRMWInst::Or: Out << " or"; break;
931 case AtomicRMWInst::Xor: Out << " xor"; break;
932 case AtomicRMWInst::Max: Out << " max"; break;
933 case AtomicRMWInst::Min: Out << " min"; break;
934 case AtomicRMWInst::UMax: Out << " umax"; break;
935 case AtomicRMWInst::UMin: Out << " umin"; break;
939 static void WriteOptimizationInfo(raw_ostream &Out, const User *U) {
940 if (const FPMathOperator *FPO = dyn_cast<const FPMathOperator>(U)) {
941 // Unsafe algebra implies all the others, no need to write them all out
942 if (FPO->hasUnsafeAlgebra())
945 if (FPO->hasNoNaNs())
947 if (FPO->hasNoInfs())
949 if (FPO->hasNoSignedZeros())
951 if (FPO->hasAllowReciprocal())
956 if (const OverflowingBinaryOperator *OBO =
957 dyn_cast<OverflowingBinaryOperator>(U)) {
958 if (OBO->hasNoUnsignedWrap())
960 if (OBO->hasNoSignedWrap())
962 } else if (const PossiblyExactOperator *Div =
963 dyn_cast<PossiblyExactOperator>(U)) {
966 } else if (const GEPOperator *GEP = dyn_cast<GEPOperator>(U)) {
967 if (GEP->isInBounds())
972 static void WriteConstantInternal(raw_ostream &Out, const Constant *CV,
973 TypePrinting &TypePrinter,
974 SlotTracker *Machine,
975 const Module *Context) {
976 if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV)) {
977 if (CI->getType()->isIntegerTy(1)) {
978 Out << (CI->getZExtValue() ? "true" : "false");
981 Out << CI->getValue();
985 if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV)) {
986 if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEsingle ||
987 &CFP->getValueAPF().getSemantics() == &APFloat::IEEEdouble) {
988 // We would like to output the FP constant value in exponential notation,
989 // but we cannot do this if doing so will lose precision. Check here to
990 // make sure that we only output it in exponential format if we can parse
991 // the value back and get the same value.
994 bool isHalf = &CFP->getValueAPF().getSemantics()==&APFloat::IEEEhalf;
995 bool isDouble = &CFP->getValueAPF().getSemantics()==&APFloat::IEEEdouble;
996 bool isInf = CFP->getValueAPF().isInfinity();
997 bool isNaN = CFP->getValueAPF().isNaN();
998 if (!isHalf && !isInf && !isNaN) {
999 double Val = isDouble ? CFP->getValueAPF().convertToDouble() :
1000 CFP->getValueAPF().convertToFloat();
1001 SmallString<128> StrVal;
1002 raw_svector_ostream(StrVal) << Val;
1004 // Check to make sure that the stringized number is not some string like
1005 // "Inf" or NaN, that atof will accept, but the lexer will not. Check
1006 // that the string matches the "[-+]?[0-9]" regex.
1008 if ((StrVal[0] >= '0' && StrVal[0] <= '9') ||
1009 ((StrVal[0] == '-' || StrVal[0] == '+') &&
1010 (StrVal[1] >= '0' && StrVal[1] <= '9'))) {
1011 // Reparse stringized version!
1012 if (APFloat(APFloat::IEEEdouble, StrVal).convertToDouble() == Val) {
1013 Out << StrVal.str();
1018 // Otherwise we could not reparse it to exactly the same value, so we must
1019 // output the string in hexadecimal format! Note that loading and storing
1020 // floating point types changes the bits of NaNs on some hosts, notably
1021 // x86, so we must not use these types.
1022 static_assert(sizeof(double) == sizeof(uint64_t),
1023 "assuming that double is 64 bits!");
1025 APFloat apf = CFP->getValueAPF();
1026 // Halves and floats are represented in ASCII IR as double, convert.
1028 apf.convert(APFloat::IEEEdouble, APFloat::rmNearestTiesToEven,
1031 utohex_buffer(uint64_t(apf.bitcastToAPInt().getZExtValue()),
1036 // Either half, or some form of long double.
1037 // These appear as a magic letter identifying the type, then a
1038 // fixed number of hex digits.
1040 // Bit position, in the current word, of the next nibble to print.
1043 if (&CFP->getValueAPF().getSemantics() == &APFloat::x87DoubleExtended) {
1045 // api needed to prevent premature destruction
1046 APInt api = CFP->getValueAPF().bitcastToAPInt();
1047 const uint64_t* p = api.getRawData();
1048 uint64_t word = p[1];
1050 int width = api.getBitWidth();
1051 for (int j=0; j<width; j+=4, shiftcount-=4) {
1052 unsigned int nibble = (word>>shiftcount) & 15;
1054 Out << (unsigned char)(nibble + '0');
1056 Out << (unsigned char)(nibble - 10 + 'A');
1057 if (shiftcount == 0 && j+4 < width) {
1061 shiftcount = width-j-4;
1065 } else if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEquad) {
1068 } else if (&CFP->getValueAPF().getSemantics() == &APFloat::PPCDoubleDouble) {
1071 } else if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEhalf) {
1075 llvm_unreachable("Unsupported floating point type");
1076 // api needed to prevent premature destruction
1077 APInt api = CFP->getValueAPF().bitcastToAPInt();
1078 const uint64_t* p = api.getRawData();
1080 int width = api.getBitWidth();
1081 for (int j=0; j<width; j+=4, shiftcount-=4) {
1082 unsigned int nibble = (word>>shiftcount) & 15;
1084 Out << (unsigned char)(nibble + '0');
1086 Out << (unsigned char)(nibble - 10 + 'A');
1087 if (shiftcount == 0 && j+4 < width) {
1091 shiftcount = width-j-4;
1097 if (isa<ConstantAggregateZero>(CV)) {
1098 Out << "zeroinitializer";
1102 if (const BlockAddress *BA = dyn_cast<BlockAddress>(CV)) {
1103 Out << "blockaddress(";
1104 WriteAsOperandInternal(Out, BA->getFunction(), &TypePrinter, Machine,
1107 WriteAsOperandInternal(Out, BA->getBasicBlock(), &TypePrinter, Machine,
1113 if (const ConstantArray *CA = dyn_cast<ConstantArray>(CV)) {
1114 Type *ETy = CA->getType()->getElementType();
1116 TypePrinter.print(ETy, Out);
1118 WriteAsOperandInternal(Out, CA->getOperand(0),
1119 &TypePrinter, Machine,
1121 for (unsigned i = 1, e = CA->getNumOperands(); i != e; ++i) {
1123 TypePrinter.print(ETy, Out);
1125 WriteAsOperandInternal(Out, CA->getOperand(i), &TypePrinter, Machine,
1132 if (const ConstantDataArray *CA = dyn_cast<ConstantDataArray>(CV)) {
1133 // As a special case, print the array as a string if it is an array of
1134 // i8 with ConstantInt values.
1135 if (CA->isString()) {
1137 PrintEscapedString(CA->getAsString(), Out);
1142 Type *ETy = CA->getType()->getElementType();
1144 TypePrinter.print(ETy, Out);
1146 WriteAsOperandInternal(Out, CA->getElementAsConstant(0),
1147 &TypePrinter, Machine,
1149 for (unsigned i = 1, e = CA->getNumElements(); i != e; ++i) {
1151 TypePrinter.print(ETy, Out);
1153 WriteAsOperandInternal(Out, CA->getElementAsConstant(i), &TypePrinter,
1161 if (const ConstantStruct *CS = dyn_cast<ConstantStruct>(CV)) {
1162 if (CS->getType()->isPacked())
1165 unsigned N = CS->getNumOperands();
1168 TypePrinter.print(CS->getOperand(0)->getType(), Out);
1171 WriteAsOperandInternal(Out, CS->getOperand(0), &TypePrinter, Machine,
1174 for (unsigned i = 1; i < N; i++) {
1176 TypePrinter.print(CS->getOperand(i)->getType(), Out);
1179 WriteAsOperandInternal(Out, CS->getOperand(i), &TypePrinter, Machine,
1186 if (CS->getType()->isPacked())
1191 if (isa<ConstantVector>(CV) || isa<ConstantDataVector>(CV)) {
1192 Type *ETy = CV->getType()->getVectorElementType();
1194 TypePrinter.print(ETy, Out);
1196 WriteAsOperandInternal(Out, CV->getAggregateElement(0U), &TypePrinter,
1198 for (unsigned i = 1, e = CV->getType()->getVectorNumElements(); i != e;++i){
1200 TypePrinter.print(ETy, Out);
1202 WriteAsOperandInternal(Out, CV->getAggregateElement(i), &TypePrinter,
1209 if (isa<ConstantPointerNull>(CV)) {
1214 if (isa<UndefValue>(CV)) {
1219 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV)) {
1220 Out << CE->getOpcodeName();
1221 WriteOptimizationInfo(Out, CE);
1222 if (CE->isCompare())
1223 Out << ' ' << getPredicateText(CE->getPredicate());
1226 for (User::const_op_iterator OI=CE->op_begin(); OI != CE->op_end(); ++OI) {
1227 TypePrinter.print((*OI)->getType(), Out);
1229 WriteAsOperandInternal(Out, *OI, &TypePrinter, Machine, Context);
1230 if (OI+1 != CE->op_end())
1234 if (CE->hasIndices()) {
1235 ArrayRef<unsigned> Indices = CE->getIndices();
1236 for (unsigned i = 0, e = Indices.size(); i != e; ++i)
1237 Out << ", " << Indices[i];
1242 TypePrinter.print(CE->getType(), Out);
1249 Out << "<placeholder or erroneous Constant>";
1252 static void writeMDTuple(raw_ostream &Out, const MDTuple *Node,
1253 TypePrinting *TypePrinter, SlotTracker *Machine,
1254 const Module *Context) {
1256 for (unsigned mi = 0, me = Node->getNumOperands(); mi != me; ++mi) {
1257 const Metadata *MD = Node->getOperand(mi);
1260 else if (auto *MDV = dyn_cast<ValueAsMetadata>(MD)) {
1261 Value *V = MDV->getValue();
1262 TypePrinter->print(V->getType(), Out);
1264 WriteAsOperandInternal(Out, V, TypePrinter, Machine, Context);
1266 WriteAsOperandInternal(Out, MD, TypePrinter, Machine, Context);
1276 struct FieldSeparator {
1278 FieldSeparator() : Skip(true) {}
1280 raw_ostream &operator<<(raw_ostream &OS, FieldSeparator &FS) {
1289 static void writeMetadataAsOperand(raw_ostream &Out, const Metadata *MD,
1290 TypePrinting *TypePrinter,
1291 SlotTracker *Machine,
1292 const Module *Context) {
1297 WriteAsOperandInternal(Out, MD, TypePrinter, Machine, Context);
1300 static void writeTag(raw_ostream &Out, FieldSeparator &FS, const DebugNode *N) {
1301 Out << FS << "tag: ";
1302 if (const char *Tag = dwarf::TagString(N->getTag()))
1308 static void writeGenericDebugNode(raw_ostream &Out, const GenericDebugNode *N,
1309 TypePrinting *TypePrinter,
1310 SlotTracker *Machine, const Module *Context) {
1311 Out << "!GenericDebugNode(";
1313 writeTag(Out, FS, N);
1314 if (!N->getHeader().empty()) {
1315 Out << FS << "header: \"";
1316 PrintEscapedString(N->getHeader(), Out);
1319 if (N->getNumDwarfOperands()) {
1320 Out << FS << "operands: {";
1322 for (auto &I : N->dwarf_operands()) {
1324 writeMetadataAsOperand(Out, I, TypePrinter, Machine, Context);
1331 static void writeMDLocation(raw_ostream &Out, const MDLocation *DL,
1332 TypePrinting *TypePrinter, SlotTracker *Machine,
1333 const Module *Context) {
1334 Out << "!MDLocation(";
1336 // Always output the line, since 0 is a relevant and important value for it.
1337 Out << FS << "line: " << DL->getLine();
1338 if (DL->getColumn())
1339 Out << FS << "column: " << DL->getColumn();
1340 Out << FS << "scope: ";
1341 WriteAsOperandInternal(Out, DL->getScope(), TypePrinter, Machine, Context);
1342 if (DL->getInlinedAt()) {
1343 Out << FS << "inlinedAt: ";
1344 WriteAsOperandInternal(Out, DL->getInlinedAt(), TypePrinter, Machine,
1350 static void writeMDSubrange(raw_ostream &, const MDSubrange *, TypePrinting *,
1351 SlotTracker *, const Module *) {
1352 llvm_unreachable("write not implemented");
1354 static void writeMDEnumerator(raw_ostream &, const MDEnumerator *,
1355 TypePrinting *, SlotTracker *, const Module *) {
1356 llvm_unreachable("write not implemented");
1358 static void writeMDBasicType(raw_ostream &, const MDBasicType *, TypePrinting *,
1359 SlotTracker *, const Module *) {
1360 llvm_unreachable("write not implemented");
1362 static void writeMDDerivedType(raw_ostream &, const MDDerivedType *,
1363 TypePrinting *, SlotTracker *, const Module *) {
1364 llvm_unreachable("write not implemented");
1366 static void writeMDCompositeType(raw_ostream &, const MDCompositeType *,
1367 TypePrinting *, SlotTracker *,
1369 llvm_unreachable("write not implemented");
1371 static void writeMDSubroutineType(raw_ostream &, const MDSubroutineType *,
1372 TypePrinting *, SlotTracker *,
1374 llvm_unreachable("write not implemented");
1376 static void writeMDFile(raw_ostream &, const MDFile *, TypePrinting *,
1377 SlotTracker *, const Module *) {
1378 llvm_unreachable("write not implemented");
1380 static void writeMDCompileUnit(raw_ostream &, const MDCompileUnit *,
1381 TypePrinting *, SlotTracker *, const Module *) {
1382 llvm_unreachable("write not implemented");
1384 static void writeMDSubprogram(raw_ostream &, const MDSubprogram *,
1385 TypePrinting *, SlotTracker *, const Module *) {
1386 llvm_unreachable("write not implemented");
1388 static void writeMDLexicalBlock(raw_ostream &, const MDLexicalBlock *,
1389 TypePrinting *, SlotTracker *, const Module *) {
1390 llvm_unreachable("write not implemented");
1392 static void writeMDLexicalBlockFile(raw_ostream &, const MDLexicalBlockFile *,
1393 TypePrinting *, SlotTracker *,
1395 llvm_unreachable("write not implemented");
1397 static void writeMDNamespace(raw_ostream &, const MDNamespace *, TypePrinting *,
1398 SlotTracker *, const Module *) {
1399 llvm_unreachable("write not implemented");
1401 static void writeMDTemplateTypeParameter(raw_ostream &,
1402 const MDTemplateTypeParameter *,
1403 TypePrinting *, SlotTracker *,
1405 llvm_unreachable("write not implemented");
1407 static void writeMDTemplateValueParameter(raw_ostream &,
1408 const MDTemplateValueParameter *,
1409 TypePrinting *, SlotTracker *,
1411 llvm_unreachable("write not implemented");
1413 static void writeMDGlobalVariable(raw_ostream &, const MDGlobalVariable *,
1414 TypePrinting *, SlotTracker *,
1416 llvm_unreachable("write not implemented");
1418 static void writeMDLocalVariable(raw_ostream &, const MDLocalVariable *,
1419 TypePrinting *, SlotTracker *,
1421 llvm_unreachable("write not implemented");
1423 static void writeMDExpression(raw_ostream &, const MDExpression *,
1424 TypePrinting *, SlotTracker *, const Module *) {
1425 llvm_unreachable("write not implemented");
1427 static void writeMDObjCProperty(raw_ostream &, const MDObjCProperty *,
1428 TypePrinting *, SlotTracker *, const Module *) {
1429 llvm_unreachable("write not implemented");
1431 static void writeMDImportedEntity(raw_ostream &, const MDImportedEntity *,
1432 TypePrinting *, SlotTracker *,
1434 llvm_unreachable("write not implemented");
1437 static void WriteMDNodeBodyInternal(raw_ostream &Out, const MDNode *Node,
1438 TypePrinting *TypePrinter,
1439 SlotTracker *Machine,
1440 const Module *Context) {
1441 assert(!Node->isTemporary() && "Unexpected forward declaration");
1443 if (Node->isDistinct())
1446 switch (Node->getMetadataID()) {
1448 llvm_unreachable("Expected uniquable MDNode");
1449 #define HANDLE_MDNODE_LEAF(CLASS) \
1450 case Metadata::CLASS##Kind: \
1451 write##CLASS(Out, cast<CLASS>(Node), TypePrinter, Machine, Context); \
1453 #include "llvm/IR/Metadata.def"
1457 // Full implementation of printing a Value as an operand with support for
1458 // TypePrinting, etc.
1459 static void WriteAsOperandInternal(raw_ostream &Out, const Value *V,
1460 TypePrinting *TypePrinter,
1461 SlotTracker *Machine,
1462 const Module *Context) {
1464 PrintLLVMName(Out, V);
1468 const Constant *CV = dyn_cast<Constant>(V);
1469 if (CV && !isa<GlobalValue>(CV)) {
1470 assert(TypePrinter && "Constants require TypePrinting!");
1471 WriteConstantInternal(Out, CV, *TypePrinter, Machine, Context);
1475 if (const InlineAsm *IA = dyn_cast<InlineAsm>(V)) {
1477 if (IA->hasSideEffects())
1478 Out << "sideeffect ";
1479 if (IA->isAlignStack())
1480 Out << "alignstack ";
1481 // We don't emit the AD_ATT dialect as it's the assumed default.
1482 if (IA->getDialect() == InlineAsm::AD_Intel)
1483 Out << "inteldialect ";
1485 PrintEscapedString(IA->getAsmString(), Out);
1487 PrintEscapedString(IA->getConstraintString(), Out);
1492 if (auto *MD = dyn_cast<MetadataAsValue>(V)) {
1493 WriteAsOperandInternal(Out, MD->getMetadata(), TypePrinter, Machine,
1494 Context, /* FromValue */ true);
1500 // If we have a SlotTracker, use it.
1502 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
1503 Slot = Machine->getGlobalSlot(GV);
1506 Slot = Machine->getLocalSlot(V);
1508 // If the local value didn't succeed, then we may be referring to a value
1509 // from a different function. Translate it, as this can happen when using
1510 // address of blocks.
1512 if ((Machine = createSlotTracker(V))) {
1513 Slot = Machine->getLocalSlot(V);
1517 } else if ((Machine = createSlotTracker(V))) {
1518 // Otherwise, create one to get the # and then destroy it.
1519 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
1520 Slot = Machine->getGlobalSlot(GV);
1523 Slot = Machine->getLocalSlot(V);
1532 Out << Prefix << Slot;
1537 static void WriteAsOperandInternal(raw_ostream &Out, const Metadata *MD,
1538 TypePrinting *TypePrinter,
1539 SlotTracker *Machine, const Module *Context,
1541 if (const MDNode *N = dyn_cast<MDNode>(MD)) {
1543 Machine = new SlotTracker(Context);
1544 int Slot = Machine->getMetadataSlot(N);
1546 // Give the pointer value instead of "badref", since this comes up all
1547 // the time when debugging.
1548 Out << "<" << N << ">";
1554 if (const MDString *MDS = dyn_cast<MDString>(MD)) {
1556 PrintEscapedString(MDS->getString(), Out);
1561 auto *V = cast<ValueAsMetadata>(MD);
1562 assert(TypePrinter && "TypePrinter required for metadata values");
1563 assert((FromValue || !isa<LocalAsMetadata>(V)) &&
1564 "Unexpected function-local metadata outside of value argument");
1566 TypePrinter->print(V->getValue()->getType(), Out);
1568 WriteAsOperandInternal(Out, V->getValue(), TypePrinter, Machine, Context);
1571 void AssemblyWriter::init() {
1574 TypePrinter.incorporateTypes(*TheModule);
1575 for (const Function &F : *TheModule)
1576 if (const Comdat *C = F.getComdat())
1578 for (const GlobalVariable &GV : TheModule->globals())
1579 if (const Comdat *C = GV.getComdat())
1584 AssemblyWriter::AssemblyWriter(formatted_raw_ostream &o, SlotTracker &Mac,
1586 AssemblyAnnotationWriter *AAW)
1587 : Out(o), TheModule(M), Machine(Mac), AnnotationWriter(AAW) {
1591 AssemblyWriter::AssemblyWriter(formatted_raw_ostream &o, const Module *M,
1592 AssemblyAnnotationWriter *AAW)
1593 : Out(o), TheModule(M), ModuleSlotTracker(createSlotTracker(M)),
1594 Machine(*ModuleSlotTracker), AnnotationWriter(AAW) {
1598 AssemblyWriter::~AssemblyWriter() { }
1600 void AssemblyWriter::writeOperand(const Value *Operand, bool PrintType) {
1602 Out << "<null operand!>";
1606 TypePrinter.print(Operand->getType(), Out);
1609 WriteAsOperandInternal(Out, Operand, &TypePrinter, &Machine, TheModule);
1612 void AssemblyWriter::writeAtomic(AtomicOrdering Ordering,
1613 SynchronizationScope SynchScope) {
1614 if (Ordering == NotAtomic)
1617 switch (SynchScope) {
1618 case SingleThread: Out << " singlethread"; break;
1619 case CrossThread: break;
1623 default: Out << " <bad ordering " << int(Ordering) << ">"; break;
1624 case Unordered: Out << " unordered"; break;
1625 case Monotonic: Out << " monotonic"; break;
1626 case Acquire: Out << " acquire"; break;
1627 case Release: Out << " release"; break;
1628 case AcquireRelease: Out << " acq_rel"; break;
1629 case SequentiallyConsistent: Out << " seq_cst"; break;
1633 void AssemblyWriter::writeAtomicCmpXchg(AtomicOrdering SuccessOrdering,
1634 AtomicOrdering FailureOrdering,
1635 SynchronizationScope SynchScope) {
1636 assert(SuccessOrdering != NotAtomic && FailureOrdering != NotAtomic);
1638 switch (SynchScope) {
1639 case SingleThread: Out << " singlethread"; break;
1640 case CrossThread: break;
1643 switch (SuccessOrdering) {
1644 default: Out << " <bad ordering " << int(SuccessOrdering) << ">"; break;
1645 case Unordered: Out << " unordered"; break;
1646 case Monotonic: Out << " monotonic"; break;
1647 case Acquire: Out << " acquire"; break;
1648 case Release: Out << " release"; break;
1649 case AcquireRelease: Out << " acq_rel"; break;
1650 case SequentiallyConsistent: Out << " seq_cst"; break;
1653 switch (FailureOrdering) {
1654 default: Out << " <bad ordering " << int(FailureOrdering) << ">"; break;
1655 case Unordered: Out << " unordered"; break;
1656 case Monotonic: Out << " monotonic"; break;
1657 case Acquire: Out << " acquire"; break;
1658 case Release: Out << " release"; break;
1659 case AcquireRelease: Out << " acq_rel"; break;
1660 case SequentiallyConsistent: Out << " seq_cst"; break;
1664 void AssemblyWriter::writeParamOperand(const Value *Operand,
1665 AttributeSet Attrs, unsigned Idx) {
1667 Out << "<null operand!>";
1672 TypePrinter.print(Operand->getType(), Out);
1673 // Print parameter attributes list
1674 if (Attrs.hasAttributes(Idx))
1675 Out << ' ' << Attrs.getAsString(Idx);
1677 // Print the operand
1678 WriteAsOperandInternal(Out, Operand, &TypePrinter, &Machine, TheModule);
1681 void AssemblyWriter::printModule(const Module *M) {
1682 Machine.initialize();
1684 if (shouldPreserveAssemblyUseListOrder())
1685 UseListOrders = predictUseListOrder(M);
1687 if (!M->getModuleIdentifier().empty() &&
1688 // Don't print the ID if it will start a new line (which would
1689 // require a comment char before it).
1690 M->getModuleIdentifier().find('\n') == std::string::npos)
1691 Out << "; ModuleID = '" << M->getModuleIdentifier() << "'\n";
1693 const std::string &DL = M->getDataLayoutStr();
1695 Out << "target datalayout = \"" << DL << "\"\n";
1696 if (!M->getTargetTriple().empty())
1697 Out << "target triple = \"" << M->getTargetTriple() << "\"\n";
1699 if (!M->getModuleInlineAsm().empty()) {
1700 // Split the string into lines, to make it easier to read the .ll file.
1701 std::string Asm = M->getModuleInlineAsm();
1703 size_t NewLine = Asm.find_first_of('\n', CurPos);
1705 while (NewLine != std::string::npos) {
1706 // We found a newline, print the portion of the asm string from the
1707 // last newline up to this newline.
1708 Out << "module asm \"";
1709 PrintEscapedString(std::string(Asm.begin()+CurPos, Asm.begin()+NewLine),
1713 NewLine = Asm.find_first_of('\n', CurPos);
1715 std::string rest(Asm.begin()+CurPos, Asm.end());
1716 if (!rest.empty()) {
1717 Out << "module asm \"";
1718 PrintEscapedString(rest, Out);
1723 printTypeIdentities();
1725 // Output all comdats.
1726 if (!Comdats.empty())
1728 for (const Comdat *C : Comdats) {
1730 if (C != Comdats.back())
1734 // Output all globals.
1735 if (!M->global_empty()) Out << '\n';
1736 for (Module::const_global_iterator I = M->global_begin(), E = M->global_end();
1738 printGlobal(I); Out << '\n';
1741 // Output all aliases.
1742 if (!M->alias_empty()) Out << "\n";
1743 for (Module::const_alias_iterator I = M->alias_begin(), E = M->alias_end();
1747 // Output global use-lists.
1748 printUseLists(nullptr);
1750 // Output all of the functions.
1751 for (Module::const_iterator I = M->begin(), E = M->end(); I != E; ++I)
1753 assert(UseListOrders.empty() && "All use-lists should have been consumed");
1755 // Output all attribute groups.
1756 if (!Machine.as_empty()) {
1758 writeAllAttributeGroups();
1761 // Output named metadata.
1762 if (!M->named_metadata_empty()) Out << '\n';
1764 for (Module::const_named_metadata_iterator I = M->named_metadata_begin(),
1765 E = M->named_metadata_end(); I != E; ++I)
1766 printNamedMDNode(I);
1769 if (!Machine.mdn_empty()) {
1775 void AssemblyWriter::printNamedMDNode(const NamedMDNode *NMD) {
1777 StringRef Name = NMD->getName();
1779 Out << "<empty name> ";
1781 if (isalpha(static_cast<unsigned char>(Name[0])) ||
1782 Name[0] == '-' || Name[0] == '$' ||
1783 Name[0] == '.' || Name[0] == '_')
1786 Out << '\\' << hexdigit(Name[0] >> 4) << hexdigit(Name[0] & 0x0F);
1787 for (unsigned i = 1, e = Name.size(); i != e; ++i) {
1788 unsigned char C = Name[i];
1789 if (isalnum(static_cast<unsigned char>(C)) || C == '-' || C == '$' ||
1790 C == '.' || C == '_')
1793 Out << '\\' << hexdigit(C >> 4) << hexdigit(C & 0x0F);
1797 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
1799 int Slot = Machine.getMetadataSlot(NMD->getOperand(i));
1809 static void PrintLinkage(GlobalValue::LinkageTypes LT,
1810 formatted_raw_ostream &Out) {
1812 case GlobalValue::ExternalLinkage: break;
1813 case GlobalValue::PrivateLinkage: Out << "private "; break;
1814 case GlobalValue::InternalLinkage: Out << "internal "; break;
1815 case GlobalValue::LinkOnceAnyLinkage: Out << "linkonce "; break;
1816 case GlobalValue::LinkOnceODRLinkage: Out << "linkonce_odr "; break;
1817 case GlobalValue::WeakAnyLinkage: Out << "weak "; break;
1818 case GlobalValue::WeakODRLinkage: Out << "weak_odr "; break;
1819 case GlobalValue::CommonLinkage: Out << "common "; break;
1820 case GlobalValue::AppendingLinkage: Out << "appending "; break;
1821 case GlobalValue::ExternalWeakLinkage: Out << "extern_weak "; break;
1822 case GlobalValue::AvailableExternallyLinkage:
1823 Out << "available_externally ";
1829 static void PrintVisibility(GlobalValue::VisibilityTypes Vis,
1830 formatted_raw_ostream &Out) {
1832 case GlobalValue::DefaultVisibility: break;
1833 case GlobalValue::HiddenVisibility: Out << "hidden "; break;
1834 case GlobalValue::ProtectedVisibility: Out << "protected "; break;
1838 static void PrintDLLStorageClass(GlobalValue::DLLStorageClassTypes SCT,
1839 formatted_raw_ostream &Out) {
1841 case GlobalValue::DefaultStorageClass: break;
1842 case GlobalValue::DLLImportStorageClass: Out << "dllimport "; break;
1843 case GlobalValue::DLLExportStorageClass: Out << "dllexport "; break;
1847 static void PrintThreadLocalModel(GlobalVariable::ThreadLocalMode TLM,
1848 formatted_raw_ostream &Out) {
1850 case GlobalVariable::NotThreadLocal:
1852 case GlobalVariable::GeneralDynamicTLSModel:
1853 Out << "thread_local ";
1855 case GlobalVariable::LocalDynamicTLSModel:
1856 Out << "thread_local(localdynamic) ";
1858 case GlobalVariable::InitialExecTLSModel:
1859 Out << "thread_local(initialexec) ";
1861 case GlobalVariable::LocalExecTLSModel:
1862 Out << "thread_local(localexec) ";
1867 static void maybePrintComdat(formatted_raw_ostream &Out,
1868 const GlobalObject &GO) {
1869 const Comdat *C = GO.getComdat();
1873 if (isa<GlobalVariable>(GO))
1877 if (GO.getName() == C->getName())
1881 PrintLLVMName(Out, C->getName(), ComdatPrefix);
1885 void AssemblyWriter::printGlobal(const GlobalVariable *GV) {
1886 if (GV->isMaterializable())
1887 Out << "; Materializable\n";
1889 WriteAsOperandInternal(Out, GV, &TypePrinter, &Machine, GV->getParent());
1892 if (!GV->hasInitializer() && GV->hasExternalLinkage())
1895 PrintLinkage(GV->getLinkage(), Out);
1896 PrintVisibility(GV->getVisibility(), Out);
1897 PrintDLLStorageClass(GV->getDLLStorageClass(), Out);
1898 PrintThreadLocalModel(GV->getThreadLocalMode(), Out);
1899 if (GV->hasUnnamedAddr())
1900 Out << "unnamed_addr ";
1902 if (unsigned AddressSpace = GV->getType()->getAddressSpace())
1903 Out << "addrspace(" << AddressSpace << ") ";
1904 if (GV->isExternallyInitialized()) Out << "externally_initialized ";
1905 Out << (GV->isConstant() ? "constant " : "global ");
1906 TypePrinter.print(GV->getType()->getElementType(), Out);
1908 if (GV->hasInitializer()) {
1910 writeOperand(GV->getInitializer(), false);
1913 if (GV->hasSection()) {
1914 Out << ", section \"";
1915 PrintEscapedString(GV->getSection(), Out);
1918 maybePrintComdat(Out, *GV);
1919 if (GV->getAlignment())
1920 Out << ", align " << GV->getAlignment();
1922 printInfoComment(*GV);
1925 void AssemblyWriter::printAlias(const GlobalAlias *GA) {
1926 if (GA->isMaterializable())
1927 Out << "; Materializable\n";
1929 // Don't crash when dumping partially built GA
1931 Out << "<<nameless>> = ";
1933 PrintLLVMName(Out, GA);
1936 PrintLinkage(GA->getLinkage(), Out);
1937 PrintVisibility(GA->getVisibility(), Out);
1938 PrintDLLStorageClass(GA->getDLLStorageClass(), Out);
1939 PrintThreadLocalModel(GA->getThreadLocalMode(), Out);
1940 if (GA->hasUnnamedAddr())
1941 Out << "unnamed_addr ";
1945 const Constant *Aliasee = GA->getAliasee();
1948 TypePrinter.print(GA->getType(), Out);
1949 Out << " <<NULL ALIASEE>>";
1951 writeOperand(Aliasee, !isa<ConstantExpr>(Aliasee));
1954 printInfoComment(*GA);
1958 void AssemblyWriter::printComdat(const Comdat *C) {
1962 void AssemblyWriter::printTypeIdentities() {
1963 if (TypePrinter.NumberedTypes.empty() &&
1964 TypePrinter.NamedTypes.empty())
1969 // We know all the numbers that each type is used and we know that it is a
1970 // dense assignment. Convert the map to an index table.
1971 std::vector<StructType*> NumberedTypes(TypePrinter.NumberedTypes.size());
1972 for (DenseMap<StructType*, unsigned>::iterator I =
1973 TypePrinter.NumberedTypes.begin(), E = TypePrinter.NumberedTypes.end();
1975 assert(I->second < NumberedTypes.size() && "Didn't get a dense numbering?");
1976 NumberedTypes[I->second] = I->first;
1979 // Emit all numbered types.
1980 for (unsigned i = 0, e = NumberedTypes.size(); i != e; ++i) {
1981 Out << '%' << i << " = type ";
1983 // Make sure we print out at least one level of the type structure, so
1984 // that we do not get %2 = type %2
1985 TypePrinter.printStructBody(NumberedTypes[i], Out);
1989 for (unsigned i = 0, e = TypePrinter.NamedTypes.size(); i != e; ++i) {
1990 PrintLLVMName(Out, TypePrinter.NamedTypes[i]->getName(), LocalPrefix);
1993 // Make sure we print out at least one level of the type structure, so
1994 // that we do not get %FILE = type %FILE
1995 TypePrinter.printStructBody(TypePrinter.NamedTypes[i], Out);
2000 /// printFunction - Print all aspects of a function.
2002 void AssemblyWriter::printFunction(const Function *F) {
2003 // Print out the return type and name.
2006 if (AnnotationWriter) AnnotationWriter->emitFunctionAnnot(F, Out);
2008 if (F->isMaterializable())
2009 Out << "; Materializable\n";
2011 const AttributeSet &Attrs = F->getAttributes();
2012 if (Attrs.hasAttributes(AttributeSet::FunctionIndex)) {
2013 AttributeSet AS = Attrs.getFnAttributes();
2014 std::string AttrStr;
2017 for (unsigned E = AS.getNumSlots(); Idx != E; ++Idx)
2018 if (AS.getSlotIndex(Idx) == AttributeSet::FunctionIndex)
2021 for (AttributeSet::iterator I = AS.begin(Idx), E = AS.end(Idx);
2023 Attribute Attr = *I;
2024 if (!Attr.isStringAttribute()) {
2025 if (!AttrStr.empty()) AttrStr += ' ';
2026 AttrStr += Attr.getAsString();
2030 if (!AttrStr.empty())
2031 Out << "; Function Attrs: " << AttrStr << '\n';
2034 if (F->isDeclaration())
2039 PrintLinkage(F->getLinkage(), Out);
2040 PrintVisibility(F->getVisibility(), Out);
2041 PrintDLLStorageClass(F->getDLLStorageClass(), Out);
2043 // Print the calling convention.
2044 if (F->getCallingConv() != CallingConv::C) {
2045 PrintCallingConv(F->getCallingConv(), Out);
2049 FunctionType *FT = F->getFunctionType();
2050 if (Attrs.hasAttributes(AttributeSet::ReturnIndex))
2051 Out << Attrs.getAsString(AttributeSet::ReturnIndex) << ' ';
2052 TypePrinter.print(F->getReturnType(), Out);
2054 WriteAsOperandInternal(Out, F, &TypePrinter, &Machine, F->getParent());
2056 Machine.incorporateFunction(F);
2058 // Loop over the arguments, printing them...
2061 if (!F->isDeclaration()) {
2062 // If this isn't a declaration, print the argument names as well.
2063 for (Function::const_arg_iterator I = F->arg_begin(), E = F->arg_end();
2065 // Insert commas as we go... the first arg doesn't get a comma
2066 if (I != F->arg_begin()) Out << ", ";
2067 printArgument(I, Attrs, Idx);
2071 // Otherwise, print the types from the function type.
2072 for (unsigned i = 0, e = FT->getNumParams(); i != e; ++i) {
2073 // Insert commas as we go... the first arg doesn't get a comma
2077 TypePrinter.print(FT->getParamType(i), Out);
2079 if (Attrs.hasAttributes(i+1))
2080 Out << ' ' << Attrs.getAsString(i+1);
2084 // Finish printing arguments...
2085 if (FT->isVarArg()) {
2086 if (FT->getNumParams()) Out << ", ";
2087 Out << "..."; // Output varargs portion of signature!
2090 if (F->hasUnnamedAddr())
2091 Out << " unnamed_addr";
2092 if (Attrs.hasAttributes(AttributeSet::FunctionIndex))
2093 Out << " #" << Machine.getAttributeGroupSlot(Attrs.getFnAttributes());
2094 if (F->hasSection()) {
2095 Out << " section \"";
2096 PrintEscapedString(F->getSection(), Out);
2099 maybePrintComdat(Out, *F);
2100 if (F->getAlignment())
2101 Out << " align " << F->getAlignment();
2103 Out << " gc \"" << F->getGC() << '"';
2104 if (F->hasPrefixData()) {
2106 writeOperand(F->getPrefixData(), true);
2108 if (F->hasPrologueData()) {
2109 Out << " prologue ";
2110 writeOperand(F->getPrologueData(), true);
2113 if (F->isDeclaration()) {
2117 // Output all of the function's basic blocks.
2118 for (Function::const_iterator I = F->begin(), E = F->end(); I != E; ++I)
2121 // Output the function's use-lists.
2127 Machine.purgeFunction();
2130 /// printArgument - This member is called for every argument that is passed into
2131 /// the function. Simply print it out
2133 void AssemblyWriter::printArgument(const Argument *Arg,
2134 AttributeSet Attrs, unsigned Idx) {
2136 TypePrinter.print(Arg->getType(), Out);
2138 // Output parameter attributes list
2139 if (Attrs.hasAttributes(Idx))
2140 Out << ' ' << Attrs.getAsString(Idx);
2142 // Output name, if available...
2143 if (Arg->hasName()) {
2145 PrintLLVMName(Out, Arg);
2149 /// printBasicBlock - This member is called for each basic block in a method.
2151 void AssemblyWriter::printBasicBlock(const BasicBlock *BB) {
2152 if (BB->hasName()) { // Print out the label if it exists...
2154 PrintLLVMName(Out, BB->getName(), LabelPrefix);
2156 } else if (!BB->use_empty()) { // Don't print block # of no uses...
2157 Out << "\n; <label>:";
2158 int Slot = Machine.getLocalSlot(BB);
2165 if (!BB->getParent()) {
2166 Out.PadToColumn(50);
2167 Out << "; Error: Block without parent!";
2168 } else if (BB != &BB->getParent()->getEntryBlock()) { // Not the entry block?
2169 // Output predecessors for the block.
2170 Out.PadToColumn(50);
2172 const_pred_iterator PI = pred_begin(BB), PE = pred_end(BB);
2175 Out << " No predecessors!";
2178 writeOperand(*PI, false);
2179 for (++PI; PI != PE; ++PI) {
2181 writeOperand(*PI, false);
2188 if (AnnotationWriter) AnnotationWriter->emitBasicBlockStartAnnot(BB, Out);
2190 // Output all of the instructions in the basic block...
2191 for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I != E; ++I) {
2192 printInstructionLine(*I);
2195 if (AnnotationWriter) AnnotationWriter->emitBasicBlockEndAnnot(BB, Out);
2198 /// printInstructionLine - Print an instruction and a newline character.
2199 void AssemblyWriter::printInstructionLine(const Instruction &I) {
2200 printInstruction(I);
2204 /// printInfoComment - Print a little comment after the instruction indicating
2205 /// which slot it occupies.
2207 void AssemblyWriter::printInfoComment(const Value &V) {
2208 if (AnnotationWriter)
2209 AnnotationWriter->printInfoComment(V, Out);
2212 // This member is called for each Instruction in a function..
2213 void AssemblyWriter::printInstruction(const Instruction &I) {
2214 if (AnnotationWriter) AnnotationWriter->emitInstructionAnnot(&I, Out);
2216 // Print out indentation for an instruction.
2219 // Print out name if it exists...
2221 PrintLLVMName(Out, &I);
2223 } else if (!I.getType()->isVoidTy()) {
2224 // Print out the def slot taken.
2225 int SlotNum = Machine.getLocalSlot(&I);
2227 Out << "<badref> = ";
2229 Out << '%' << SlotNum << " = ";
2232 if (const CallInst *CI = dyn_cast<CallInst>(&I)) {
2233 if (CI->isMustTailCall())
2235 else if (CI->isTailCall())
2239 // Print out the opcode...
2240 Out << I.getOpcodeName();
2242 // If this is an atomic load or store, print out the atomic marker.
2243 if ((isa<LoadInst>(I) && cast<LoadInst>(I).isAtomic()) ||
2244 (isa<StoreInst>(I) && cast<StoreInst>(I).isAtomic()))
2247 if (isa<AtomicCmpXchgInst>(I) && cast<AtomicCmpXchgInst>(I).isWeak())
2250 // If this is a volatile operation, print out the volatile marker.
2251 if ((isa<LoadInst>(I) && cast<LoadInst>(I).isVolatile()) ||
2252 (isa<StoreInst>(I) && cast<StoreInst>(I).isVolatile()) ||
2253 (isa<AtomicCmpXchgInst>(I) && cast<AtomicCmpXchgInst>(I).isVolatile()) ||
2254 (isa<AtomicRMWInst>(I) && cast<AtomicRMWInst>(I).isVolatile()))
2257 // Print out optimization information.
2258 WriteOptimizationInfo(Out, &I);
2260 // Print out the compare instruction predicates
2261 if (const CmpInst *CI = dyn_cast<CmpInst>(&I))
2262 Out << ' ' << getPredicateText(CI->getPredicate());
2264 // Print out the atomicrmw operation
2265 if (const AtomicRMWInst *RMWI = dyn_cast<AtomicRMWInst>(&I))
2266 writeAtomicRMWOperation(Out, RMWI->getOperation());
2268 // Print out the type of the operands...
2269 const Value *Operand = I.getNumOperands() ? I.getOperand(0) : nullptr;
2271 // Special case conditional branches to swizzle the condition out to the front
2272 if (isa<BranchInst>(I) && cast<BranchInst>(I).isConditional()) {
2273 const BranchInst &BI(cast<BranchInst>(I));
2275 writeOperand(BI.getCondition(), true);
2277 writeOperand(BI.getSuccessor(0), true);
2279 writeOperand(BI.getSuccessor(1), true);
2281 } else if (isa<SwitchInst>(I)) {
2282 const SwitchInst& SI(cast<SwitchInst>(I));
2283 // Special case switch instruction to get formatting nice and correct.
2285 writeOperand(SI.getCondition(), true);
2287 writeOperand(SI.getDefaultDest(), true);
2289 for (SwitchInst::ConstCaseIt i = SI.case_begin(), e = SI.case_end();
2292 writeOperand(i.getCaseValue(), true);
2294 writeOperand(i.getCaseSuccessor(), true);
2297 } else if (isa<IndirectBrInst>(I)) {
2298 // Special case indirectbr instruction to get formatting nice and correct.
2300 writeOperand(Operand, true);
2303 for (unsigned i = 1, e = I.getNumOperands(); i != e; ++i) {
2306 writeOperand(I.getOperand(i), true);
2309 } else if (const PHINode *PN = dyn_cast<PHINode>(&I)) {
2311 TypePrinter.print(I.getType(), Out);
2314 for (unsigned op = 0, Eop = PN->getNumIncomingValues(); op < Eop; ++op) {
2315 if (op) Out << ", ";
2317 writeOperand(PN->getIncomingValue(op), false); Out << ", ";
2318 writeOperand(PN->getIncomingBlock(op), false); Out << " ]";
2320 } else if (const ExtractValueInst *EVI = dyn_cast<ExtractValueInst>(&I)) {
2322 writeOperand(I.getOperand(0), true);
2323 for (const unsigned *i = EVI->idx_begin(), *e = EVI->idx_end(); i != e; ++i)
2325 } else if (const InsertValueInst *IVI = dyn_cast<InsertValueInst>(&I)) {
2327 writeOperand(I.getOperand(0), true); Out << ", ";
2328 writeOperand(I.getOperand(1), true);
2329 for (const unsigned *i = IVI->idx_begin(), *e = IVI->idx_end(); i != e; ++i)
2331 } else if (const LandingPadInst *LPI = dyn_cast<LandingPadInst>(&I)) {
2333 TypePrinter.print(I.getType(), Out);
2334 Out << " personality ";
2335 writeOperand(I.getOperand(0), true); Out << '\n';
2337 if (LPI->isCleanup())
2340 for (unsigned i = 0, e = LPI->getNumClauses(); i != e; ++i) {
2341 if (i != 0 || LPI->isCleanup()) Out << "\n";
2342 if (LPI->isCatch(i))
2347 writeOperand(LPI->getClause(i), true);
2349 } else if (isa<ReturnInst>(I) && !Operand) {
2351 } else if (const CallInst *CI = dyn_cast<CallInst>(&I)) {
2352 // Print the calling convention being used.
2353 if (CI->getCallingConv() != CallingConv::C) {
2355 PrintCallingConv(CI->getCallingConv(), Out);
2358 Operand = CI->getCalledValue();
2359 PointerType *PTy = cast<PointerType>(Operand->getType());
2360 FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
2361 Type *RetTy = FTy->getReturnType();
2362 const AttributeSet &PAL = CI->getAttributes();
2364 if (PAL.hasAttributes(AttributeSet::ReturnIndex))
2365 Out << ' ' << PAL.getAsString(AttributeSet::ReturnIndex);
2367 // If possible, print out the short form of the call instruction. We can
2368 // only do this if the first argument is a pointer to a nonvararg function,
2369 // and if the return type is not a pointer to a function.
2372 if (!FTy->isVarArg() &&
2373 (!RetTy->isPointerTy() ||
2374 !cast<PointerType>(RetTy)->getElementType()->isFunctionTy())) {
2375 TypePrinter.print(RetTy, Out);
2377 writeOperand(Operand, false);
2379 writeOperand(Operand, true);
2382 for (unsigned op = 0, Eop = CI->getNumArgOperands(); op < Eop; ++op) {
2385 writeParamOperand(CI->getArgOperand(op), PAL, op + 1);
2388 // Emit an ellipsis if this is a musttail call in a vararg function. This
2389 // is only to aid readability, musttail calls forward varargs by default.
2390 if (CI->isMustTailCall() && CI->getParent() &&
2391 CI->getParent()->getParent() &&
2392 CI->getParent()->getParent()->isVarArg())
2396 if (PAL.hasAttributes(AttributeSet::FunctionIndex))
2397 Out << " #" << Machine.getAttributeGroupSlot(PAL.getFnAttributes());
2398 } else if (const InvokeInst *II = dyn_cast<InvokeInst>(&I)) {
2399 Operand = II->getCalledValue();
2400 PointerType *PTy = cast<PointerType>(Operand->getType());
2401 FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
2402 Type *RetTy = FTy->getReturnType();
2403 const AttributeSet &PAL = II->getAttributes();
2405 // Print the calling convention being used.
2406 if (II->getCallingConv() != CallingConv::C) {
2408 PrintCallingConv(II->getCallingConv(), Out);
2411 if (PAL.hasAttributes(AttributeSet::ReturnIndex))
2412 Out << ' ' << PAL.getAsString(AttributeSet::ReturnIndex);
2414 // If possible, print out the short form of the invoke instruction. We can
2415 // only do this if the first argument is a pointer to a nonvararg function,
2416 // and if the return type is not a pointer to a function.
2419 if (!FTy->isVarArg() &&
2420 (!RetTy->isPointerTy() ||
2421 !cast<PointerType>(RetTy)->getElementType()->isFunctionTy())) {
2422 TypePrinter.print(RetTy, Out);
2424 writeOperand(Operand, false);
2426 writeOperand(Operand, true);
2429 for (unsigned op = 0, Eop = II->getNumArgOperands(); op < Eop; ++op) {
2432 writeParamOperand(II->getArgOperand(op), PAL, op + 1);
2436 if (PAL.hasAttributes(AttributeSet::FunctionIndex))
2437 Out << " #" << Machine.getAttributeGroupSlot(PAL.getFnAttributes());
2440 writeOperand(II->getNormalDest(), true);
2442 writeOperand(II->getUnwindDest(), true);
2444 } else if (const AllocaInst *AI = dyn_cast<AllocaInst>(&I)) {
2446 if (AI->isUsedWithInAlloca())
2448 TypePrinter.print(AI->getAllocatedType(), Out);
2449 if (!AI->getArraySize() || AI->isArrayAllocation()) {
2451 writeOperand(AI->getArraySize(), true);
2453 if (AI->getAlignment()) {
2454 Out << ", align " << AI->getAlignment();
2456 } else if (isa<CastInst>(I)) {
2459 writeOperand(Operand, true); // Work with broken code
2462 TypePrinter.print(I.getType(), Out);
2463 } else if (isa<VAArgInst>(I)) {
2466 writeOperand(Operand, true); // Work with broken code
2469 TypePrinter.print(I.getType(), Out);
2470 } else if (Operand) { // Print the normal way.
2472 // PrintAllTypes - Instructions who have operands of all the same type
2473 // omit the type from all but the first operand. If the instruction has
2474 // different type operands (for example br), then they are all printed.
2475 bool PrintAllTypes = false;
2476 Type *TheType = Operand->getType();
2478 // Select, Store and ShuffleVector always print all types.
2479 if (isa<SelectInst>(I) || isa<StoreInst>(I) || isa<ShuffleVectorInst>(I)
2480 || isa<ReturnInst>(I)) {
2481 PrintAllTypes = true;
2483 for (unsigned i = 1, E = I.getNumOperands(); i != E; ++i) {
2484 Operand = I.getOperand(i);
2485 // note that Operand shouldn't be null, but the test helps make dump()
2486 // more tolerant of malformed IR
2487 if (Operand && Operand->getType() != TheType) {
2488 PrintAllTypes = true; // We have differing types! Print them all!
2494 if (!PrintAllTypes) {
2496 TypePrinter.print(TheType, Out);
2500 for (unsigned i = 0, E = I.getNumOperands(); i != E; ++i) {
2502 writeOperand(I.getOperand(i), PrintAllTypes);
2506 // Print atomic ordering/alignment for memory operations
2507 if (const LoadInst *LI = dyn_cast<LoadInst>(&I)) {
2509 writeAtomic(LI->getOrdering(), LI->getSynchScope());
2510 if (LI->getAlignment())
2511 Out << ", align " << LI->getAlignment();
2512 } else if (const StoreInst *SI = dyn_cast<StoreInst>(&I)) {
2514 writeAtomic(SI->getOrdering(), SI->getSynchScope());
2515 if (SI->getAlignment())
2516 Out << ", align " << SI->getAlignment();
2517 } else if (const AtomicCmpXchgInst *CXI = dyn_cast<AtomicCmpXchgInst>(&I)) {
2518 writeAtomicCmpXchg(CXI->getSuccessOrdering(), CXI->getFailureOrdering(),
2519 CXI->getSynchScope());
2520 } else if (const AtomicRMWInst *RMWI = dyn_cast<AtomicRMWInst>(&I)) {
2521 writeAtomic(RMWI->getOrdering(), RMWI->getSynchScope());
2522 } else if (const FenceInst *FI = dyn_cast<FenceInst>(&I)) {
2523 writeAtomic(FI->getOrdering(), FI->getSynchScope());
2526 // Print Metadata info.
2527 SmallVector<std::pair<unsigned, MDNode *>, 4> InstMD;
2528 I.getAllMetadata(InstMD);
2529 if (!InstMD.empty()) {
2530 SmallVector<StringRef, 8> MDNames;
2531 I.getType()->getContext().getMDKindNames(MDNames);
2532 for (unsigned i = 0, e = InstMD.size(); i != e; ++i) {
2533 unsigned Kind = InstMD[i].first;
2534 if (Kind < MDNames.size()) {
2535 Out << ", !" << MDNames[Kind];
2537 Out << ", !<unknown kind #" << Kind << ">";
2540 WriteAsOperandInternal(Out, InstMD[i].second, &TypePrinter, &Machine,
2544 printInfoComment(I);
2547 static void WriteMDNodeComment(const MDNode *Node,
2548 formatted_raw_ostream &Out) {
2549 if (Node->getNumOperands() < 1)
2552 Metadata *Op = Node->getOperand(0);
2553 if (!Op || !isa<MDString>(Op))
2556 DIDescriptor Desc(Node);
2560 unsigned Tag = Desc.getTag();
2561 Out.PadToColumn(50);
2562 if (dwarf::TagString(Tag)) {
2565 } else if (Tag == dwarf::DW_TAG_user_base) {
2566 Out << "; [ DW_TAG_user_base ]";
2570 void AssemblyWriter::writeMDNode(unsigned Slot, const MDNode *Node) {
2571 Out << '!' << Slot << " = ";
2572 printMDNodeBody(Node);
2575 void AssemblyWriter::writeAllMDNodes() {
2576 SmallVector<const MDNode *, 16> Nodes;
2577 Nodes.resize(Machine.mdn_size());
2578 for (SlotTracker::mdn_iterator I = Machine.mdn_begin(), E = Machine.mdn_end();
2580 Nodes[I->second] = cast<MDNode>(I->first);
2582 for (unsigned i = 0, e = Nodes.size(); i != e; ++i) {
2583 writeMDNode(i, Nodes[i]);
2587 void AssemblyWriter::printMDNodeBody(const MDNode *Node) {
2588 WriteMDNodeBodyInternal(Out, Node, &TypePrinter, &Machine, TheModule);
2589 WriteMDNodeComment(Node, Out);
2593 void AssemblyWriter::writeAllAttributeGroups() {
2594 std::vector<std::pair<AttributeSet, unsigned> > asVec;
2595 asVec.resize(Machine.as_size());
2597 for (SlotTracker::as_iterator I = Machine.as_begin(), E = Machine.as_end();
2599 asVec[I->second] = *I;
2601 for (std::vector<std::pair<AttributeSet, unsigned> >::iterator
2602 I = asVec.begin(), E = asVec.end(); I != E; ++I)
2603 Out << "attributes #" << I->second << " = { "
2604 << I->first.getAsString(AttributeSet::FunctionIndex, true) << " }\n";
2609 void AssemblyWriter::printUseListOrder(const UseListOrder &Order) {
2610 bool IsInFunction = Machine.getFunction();
2614 Out << "uselistorder";
2615 if (const BasicBlock *BB =
2616 IsInFunction ? nullptr : dyn_cast<BasicBlock>(Order.V)) {
2618 writeOperand(BB->getParent(), false);
2620 writeOperand(BB, false);
2623 writeOperand(Order.V, true);
2627 assert(Order.Shuffle.size() >= 2 && "Shuffle too small");
2628 Out << Order.Shuffle[0];
2629 for (unsigned I = 1, E = Order.Shuffle.size(); I != E; ++I)
2630 Out << ", " << Order.Shuffle[I];
2634 void AssemblyWriter::printUseLists(const Function *F) {
2636 [&]() { return !UseListOrders.empty() && UseListOrders.back().F == F; };
2641 Out << "\n; uselistorder directives\n";
2643 printUseListOrder(UseListOrders.back());
2644 UseListOrders.pop_back();
2648 //===----------------------------------------------------------------------===//
2649 // External Interface declarations
2650 //===----------------------------------------------------------------------===//
2652 void Module::print(raw_ostream &ROS, AssemblyAnnotationWriter *AAW) const {
2653 SlotTracker SlotTable(this);
2654 formatted_raw_ostream OS(ROS);
2655 AssemblyWriter W(OS, SlotTable, this, AAW);
2656 W.printModule(this);
2659 void NamedMDNode::print(raw_ostream &ROS) const {
2660 SlotTracker SlotTable(getParent());
2661 formatted_raw_ostream OS(ROS);
2662 AssemblyWriter W(OS, SlotTable, getParent(), nullptr);
2663 W.printNamedMDNode(this);
2666 void Comdat::print(raw_ostream &ROS) const {
2667 PrintLLVMName(ROS, getName(), ComdatPrefix);
2668 ROS << " = comdat ";
2670 switch (getSelectionKind()) {
2674 case Comdat::ExactMatch:
2675 ROS << "exactmatch";
2677 case Comdat::Largest:
2680 case Comdat::NoDuplicates:
2681 ROS << "noduplicates";
2683 case Comdat::SameSize:
2691 void Type::print(raw_ostream &OS) const {
2693 TP.print(const_cast<Type*>(this), OS);
2695 // If the type is a named struct type, print the body as well.
2696 if (StructType *STy = dyn_cast<StructType>(const_cast<Type*>(this)))
2697 if (!STy->isLiteral()) {
2699 TP.printStructBody(STy, OS);
2703 void Value::print(raw_ostream &ROS) const {
2704 formatted_raw_ostream OS(ROS);
2705 if (const Instruction *I = dyn_cast<Instruction>(this)) {
2706 const Function *F = I->getParent() ? I->getParent()->getParent() : nullptr;
2707 SlotTracker SlotTable(F);
2708 AssemblyWriter W(OS, SlotTable, getModuleFromVal(I), nullptr);
2709 W.printInstruction(*I);
2710 } else if (const BasicBlock *BB = dyn_cast<BasicBlock>(this)) {
2711 SlotTracker SlotTable(BB->getParent());
2712 AssemblyWriter W(OS, SlotTable, getModuleFromVal(BB), nullptr);
2713 W.printBasicBlock(BB);
2714 } else if (const GlobalValue *GV = dyn_cast<GlobalValue>(this)) {
2715 SlotTracker SlotTable(GV->getParent());
2716 AssemblyWriter W(OS, SlotTable, GV->getParent(), nullptr);
2717 if (const GlobalVariable *V = dyn_cast<GlobalVariable>(GV))
2719 else if (const Function *F = dyn_cast<Function>(GV))
2722 W.printAlias(cast<GlobalAlias>(GV));
2723 } else if (const MetadataAsValue *V = dyn_cast<MetadataAsValue>(this)) {
2724 V->getMetadata()->print(ROS);
2725 } else if (const Constant *C = dyn_cast<Constant>(this)) {
2726 TypePrinting TypePrinter;
2727 TypePrinter.print(C->getType(), OS);
2729 WriteConstantInternal(OS, C, TypePrinter, nullptr, nullptr);
2730 } else if (isa<InlineAsm>(this) || isa<Argument>(this)) {
2731 this->printAsOperand(OS);
2733 llvm_unreachable("Unknown value to print out!");
2737 void Value::printAsOperand(raw_ostream &O, bool PrintType, const Module *M) const {
2738 // Fast path: Don't construct and populate a TypePrinting object if we
2739 // won't be needing any types printed.
2740 if (!PrintType && ((!isa<Constant>(this) && !isa<MetadataAsValue>(this)) ||
2741 hasName() || isa<GlobalValue>(this))) {
2742 WriteAsOperandInternal(O, this, nullptr, nullptr, M);
2747 M = getModuleFromVal(this);
2749 TypePrinting TypePrinter;
2751 TypePrinter.incorporateTypes(*M);
2753 TypePrinter.print(getType(), O);
2757 WriteAsOperandInternal(O, this, &TypePrinter, nullptr, M);
2760 void Metadata::print(raw_ostream &ROS) const {
2761 formatted_raw_ostream OS(ROS);
2762 if (auto *N = dyn_cast<MDNode>(this)) {
2763 SlotTracker SlotTable(static_cast<Function *>(nullptr));
2764 AssemblyWriter W(OS, SlotTable, nullptr, nullptr);
2765 W.printMDNodeBody(N);
2772 void Metadata::printAsOperand(raw_ostream &ROS, bool PrintType,
2773 const Module *M) const {
2774 formatted_raw_ostream OS(ROS);
2776 std::unique_ptr<TypePrinting> TypePrinter;
2778 TypePrinter.reset(new TypePrinting);
2780 TypePrinter->incorporateTypes(*M);
2782 WriteAsOperandInternal(OS, this, TypePrinter.get(), nullptr, M,
2783 /* FromValue */ true);
2786 // Value::dump - allow easy printing of Values from the debugger.
2787 void Value::dump() const { print(dbgs()); dbgs() << '\n'; }
2789 // Type::dump - allow easy printing of Types from the debugger.
2790 void Type::dump() const { print(dbgs()); dbgs() << '\n'; }
2792 // Module::dump() - Allow printing of Modules from the debugger.
2793 void Module::dump() const { print(dbgs(), nullptr); }
2795 // \brief Allow printing of Comdats from the debugger.
2796 void Comdat::dump() const { print(dbgs()); }
2798 // NamedMDNode::dump() - Allow printing of NamedMDNodes from the debugger.
2799 void NamedMDNode::dump() const { print(dbgs()); }
2801 void Metadata::dump() const {