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 "llvm/ADT/DenseMap.h"
18 #include "llvm/ADT/STLExtras.h"
19 #include "llvm/ADT/SetVector.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/ModuleSlotTracker.h"
34 #include "llvm/IR/Operator.h"
35 #include "llvm/IR/Statepoint.h"
36 #include "llvm/IR/TypeFinder.h"
37 #include "llvm/IR/UseListOrder.h"
38 #include "llvm/IR/ValueSymbolTable.h"
39 #include "llvm/Support/Debug.h"
40 #include "llvm/Support/Dwarf.h"
41 #include "llvm/Support/ErrorHandling.h"
42 #include "llvm/Support/FormattedStream.h"
43 #include "llvm/Support/MathExtras.h"
44 #include "llvm/Support/raw_ostream.h"
49 // Make virtual table appear in this compilation unit.
50 AssemblyAnnotationWriter::~AssemblyAnnotationWriter() {}
52 //===----------------------------------------------------------------------===//
54 //===----------------------------------------------------------------------===//
58 DenseMap<const Value *, std::pair<unsigned, bool>> IDs;
60 unsigned size() const { return IDs.size(); }
61 std::pair<unsigned, bool> &operator[](const Value *V) { return IDs[V]; }
62 std::pair<unsigned, bool> lookup(const Value *V) const {
65 void index(const Value *V) {
66 // Explicitly sequence get-size and insert-value operations to avoid UB.
67 unsigned ID = IDs.size() + 1;
73 static void orderValue(const Value *V, OrderMap &OM) {
74 if (OM.lookup(V).first)
77 if (const Constant *C = dyn_cast<Constant>(V))
78 if (C->getNumOperands() && !isa<GlobalValue>(C))
79 for (const Value *Op : C->operands())
80 if (!isa<BasicBlock>(Op) && !isa<GlobalValue>(Op))
83 // Note: we cannot cache this lookup above, since inserting into the map
84 // changes the map's size, and thus affects the other IDs.
88 static OrderMap orderModule(const Module *M) {
89 // This needs to match the order used by ValueEnumerator::ValueEnumerator()
90 // and ValueEnumerator::incorporateFunction().
93 for (const GlobalVariable &G : M->globals()) {
94 if (G.hasInitializer())
95 if (!isa<GlobalValue>(G.getInitializer()))
96 orderValue(G.getInitializer(), OM);
99 for (const GlobalAlias &A : M->aliases()) {
100 if (!isa<GlobalValue>(A.getAliasee()))
101 orderValue(A.getAliasee(), OM);
104 for (const Function &F : *M) {
105 if (F.hasPrefixData())
106 if (!isa<GlobalValue>(F.getPrefixData()))
107 orderValue(F.getPrefixData(), OM);
109 if (F.hasPrologueData())
110 if (!isa<GlobalValue>(F.getPrologueData()))
111 orderValue(F.getPrologueData(), OM);
113 if (F.hasPersonalityFn())
114 if (!isa<GlobalValue>(F.getPersonalityFn()))
115 orderValue(F.getPersonalityFn(), OM);
119 if (F.isDeclaration())
122 for (const Argument &A : F.args())
124 for (const BasicBlock &BB : F) {
126 for (const Instruction &I : BB) {
127 for (const Value *Op : I.operands())
128 if ((isa<Constant>(*Op) && !isa<GlobalValue>(*Op)) ||
138 static void predictValueUseListOrderImpl(const Value *V, const Function *F,
139 unsigned ID, const OrderMap &OM,
140 UseListOrderStack &Stack) {
141 // Predict use-list order for this one.
142 typedef std::pair<const Use *, unsigned> Entry;
143 SmallVector<Entry, 64> List;
144 for (const Use &U : V->uses())
145 // Check if this user will be serialized.
146 if (OM.lookup(U.getUser()).first)
147 List.push_back(std::make_pair(&U, List.size()));
150 // We may have lost some users.
154 !isa<GlobalVariable>(V) && !isa<Function>(V) && !isa<BasicBlock>(V);
155 if (auto *BA = dyn_cast<BlockAddress>(V))
156 ID = OM.lookup(BA->getBasicBlock()).first;
157 std::sort(List.begin(), List.end(), [&](const Entry &L, const Entry &R) {
158 const Use *LU = L.first;
159 const Use *RU = R.first;
163 auto LID = OM.lookup(LU->getUser()).first;
164 auto RID = OM.lookup(RU->getUser()).first;
166 // If ID is 4, then expect: 7 6 5 1 2 3.
180 // LID and RID are equal, so we have different operands of the same user.
181 // Assume operands are added in order for all instructions.
184 return LU->getOperandNo() < RU->getOperandNo();
185 return LU->getOperandNo() > RU->getOperandNo();
189 List.begin(), List.end(),
190 [](const Entry &L, const Entry &R) { return L.second < R.second; }))
191 // Order is already correct.
194 // Store the shuffle.
195 Stack.emplace_back(V, F, List.size());
196 assert(List.size() == Stack.back().Shuffle.size() && "Wrong size");
197 for (size_t I = 0, E = List.size(); I != E; ++I)
198 Stack.back().Shuffle[I] = List[I].second;
201 static void predictValueUseListOrder(const Value *V, const Function *F,
202 OrderMap &OM, UseListOrderStack &Stack) {
203 auto &IDPair = OM[V];
204 assert(IDPair.first && "Unmapped value");
206 // Already predicted.
209 // Do the actual prediction.
210 IDPair.second = true;
211 if (!V->use_empty() && std::next(V->use_begin()) != V->use_end())
212 predictValueUseListOrderImpl(V, F, IDPair.first, OM, Stack);
214 // Recursive descent into constants.
215 if (const Constant *C = dyn_cast<Constant>(V))
216 if (C->getNumOperands()) // Visit GlobalValues.
217 for (const Value *Op : C->operands())
218 if (isa<Constant>(Op)) // Visit GlobalValues.
219 predictValueUseListOrder(Op, F, OM, Stack);
222 static UseListOrderStack predictUseListOrder(const Module *M) {
223 OrderMap OM = orderModule(M);
225 // Use-list orders need to be serialized after all the users have been added
226 // to a value, or else the shuffles will be incomplete. Store them per
227 // function in a stack.
229 // Aside from function order, the order of values doesn't matter much here.
230 UseListOrderStack Stack;
232 // We want to visit the functions backward now so we can list function-local
233 // constants in the last Function they're used in. Module-level constants
234 // have already been visited above.
235 for (const Function &F : make_range(M->rbegin(), M->rend())) {
236 if (F.isDeclaration())
238 for (const BasicBlock &BB : F)
239 predictValueUseListOrder(&BB, &F, OM, Stack);
240 for (const Argument &A : F.args())
241 predictValueUseListOrder(&A, &F, OM, Stack);
242 for (const BasicBlock &BB : F)
243 for (const Instruction &I : BB)
244 for (const Value *Op : I.operands())
245 if (isa<Constant>(*Op) || isa<InlineAsm>(*Op)) // Visit GlobalValues.
246 predictValueUseListOrder(Op, &F, OM, Stack);
247 for (const BasicBlock &BB : F)
248 for (const Instruction &I : BB)
249 predictValueUseListOrder(&I, &F, OM, Stack);
252 // Visit globals last.
253 for (const GlobalVariable &G : M->globals())
254 predictValueUseListOrder(&G, nullptr, OM, Stack);
255 for (const Function &F : *M)
256 predictValueUseListOrder(&F, nullptr, OM, Stack);
257 for (const GlobalAlias &A : M->aliases())
258 predictValueUseListOrder(&A, nullptr, OM, Stack);
259 for (const GlobalVariable &G : M->globals())
260 if (G.hasInitializer())
261 predictValueUseListOrder(G.getInitializer(), nullptr, OM, Stack);
262 for (const GlobalAlias &A : M->aliases())
263 predictValueUseListOrder(A.getAliasee(), nullptr, OM, Stack);
264 for (const Function &F : *M)
265 if (F.hasPrefixData())
266 predictValueUseListOrder(F.getPrefixData(), nullptr, OM, Stack);
271 static const Module *getModuleFromVal(const Value *V) {
272 if (const Argument *MA = dyn_cast<Argument>(V))
273 return MA->getParent() ? MA->getParent()->getParent() : nullptr;
275 if (const BasicBlock *BB = dyn_cast<BasicBlock>(V))
276 return BB->getParent() ? BB->getParent()->getParent() : nullptr;
278 if (const Instruction *I = dyn_cast<Instruction>(V)) {
279 const Function *M = I->getParent() ? I->getParent()->getParent() : nullptr;
280 return M ? M->getParent() : nullptr;
283 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V))
284 return GV->getParent();
286 if (const auto *MAV = dyn_cast<MetadataAsValue>(V)) {
287 for (const User *U : MAV->users())
288 if (isa<Instruction>(U))
289 if (const Module *M = getModuleFromVal(U))
297 static void PrintCallingConv(unsigned cc, raw_ostream &Out) {
299 default: Out << "cc" << cc; break;
300 case CallingConv::Fast: Out << "fastcc"; break;
301 case CallingConv::Cold: Out << "coldcc"; break;
302 case CallingConv::WebKit_JS: Out << "webkit_jscc"; break;
303 case CallingConv::AnyReg: Out << "anyregcc"; break;
304 case CallingConv::PreserveMost: Out << "preserve_mostcc"; break;
305 case CallingConv::PreserveAll: Out << "preserve_allcc"; break;
306 case CallingConv::GHC: Out << "ghccc"; break;
307 case CallingConv::X86_StdCall: Out << "x86_stdcallcc"; break;
308 case CallingConv::X86_FastCall: Out << "x86_fastcallcc"; break;
309 case CallingConv::X86_ThisCall: Out << "x86_thiscallcc"; break;
310 case CallingConv::X86_VectorCall:Out << "x86_vectorcallcc"; break;
311 case CallingConv::Intel_OCL_BI: Out << "intel_ocl_bicc"; break;
312 case CallingConv::ARM_APCS: Out << "arm_apcscc"; break;
313 case CallingConv::ARM_AAPCS: Out << "arm_aapcscc"; break;
314 case CallingConv::ARM_AAPCS_VFP: Out << "arm_aapcs_vfpcc"; break;
315 case CallingConv::MSP430_INTR: Out << "msp430_intrcc"; break;
316 case CallingConv::PTX_Kernel: Out << "ptx_kernel"; break;
317 case CallingConv::PTX_Device: Out << "ptx_device"; break;
318 case CallingConv::X86_64_SysV: Out << "x86_64_sysvcc"; break;
319 case CallingConv::X86_64_Win64: Out << "x86_64_win64cc"; break;
320 case CallingConv::SPIR_FUNC: Out << "spir_func"; break;
321 case CallingConv::SPIR_KERNEL: Out << "spir_kernel"; break;
325 // PrintEscapedString - Print each character of the specified string, escaping
326 // it if it is not printable or if it is an escape char.
327 static void PrintEscapedString(StringRef Name, raw_ostream &Out) {
328 for (unsigned i = 0, e = Name.size(); i != e; ++i) {
329 unsigned char C = Name[i];
330 if (isprint(C) && C != '\\' && C != '"')
333 Out << '\\' << hexdigit(C >> 4) << hexdigit(C & 0x0F);
345 void llvm::printLLVMNameWithoutPrefix(raw_ostream &OS, StringRef Name) {
346 assert(!Name.empty() && "Cannot get empty name!");
348 // Scan the name to see if it needs quotes first.
349 bool NeedsQuotes = isdigit(static_cast<unsigned char>(Name[0]));
351 for (unsigned i = 0, e = Name.size(); i != e; ++i) {
352 // By making this unsigned, the value passed in to isalnum will always be
353 // in the range 0-255. This is important when building with MSVC because
354 // its implementation will assert. This situation can arise when dealing
355 // with UTF-8 multibyte characters.
356 unsigned char C = Name[i];
357 if (!isalnum(static_cast<unsigned char>(C)) && C != '-' && C != '.' &&
365 // If we didn't need any quotes, just write out the name in one blast.
371 // Okay, we need quotes. Output the quotes and escape any scary characters as
374 PrintEscapedString(Name, OS);
378 /// Turn the specified name into an 'LLVM name', which is either prefixed with %
379 /// (if the string only contains simple characters) or is surrounded with ""'s
380 /// (if it has special chars in it). Print it out.
381 static void PrintLLVMName(raw_ostream &OS, StringRef Name, PrefixType Prefix) {
397 printLLVMNameWithoutPrefix(OS, Name);
400 /// Turn the specified name into an 'LLVM name', which is either prefixed with %
401 /// (if the string only contains simple characters) or is surrounded with ""'s
402 /// (if it has special chars in it). Print it out.
403 static void PrintLLVMName(raw_ostream &OS, const Value *V) {
404 PrintLLVMName(OS, V->getName(),
405 isa<GlobalValue>(V) ? GlobalPrefix : LocalPrefix);
411 TypePrinting(const TypePrinting &) = delete;
412 void operator=(const TypePrinting&) = delete;
415 /// NamedTypes - The named types that are used by the current module.
416 TypeFinder NamedTypes;
418 /// NumberedTypes - The numbered types, along with their value.
419 DenseMap<StructType*, unsigned> NumberedTypes;
421 TypePrinting() = default;
423 void incorporateTypes(const Module &M);
425 void print(Type *Ty, raw_ostream &OS);
427 void printStructBody(StructType *Ty, raw_ostream &OS);
431 void TypePrinting::incorporateTypes(const Module &M) {
432 NamedTypes.run(M, false);
434 // The list of struct types we got back includes all the struct types, split
435 // the unnamed ones out to a numbering and remove the anonymous structs.
436 unsigned NextNumber = 0;
438 std::vector<StructType*>::iterator NextToUse = NamedTypes.begin(), I, E;
439 for (I = NamedTypes.begin(), E = NamedTypes.end(); I != E; ++I) {
440 StructType *STy = *I;
442 // Ignore anonymous types.
443 if (STy->isLiteral())
446 if (STy->getName().empty())
447 NumberedTypes[STy] = NextNumber++;
452 NamedTypes.erase(NextToUse, NamedTypes.end());
456 /// CalcTypeName - Write the specified type to the specified raw_ostream, making
457 /// use of type names or up references to shorten the type name where possible.
458 void TypePrinting::print(Type *Ty, raw_ostream &OS) {
459 switch (Ty->getTypeID()) {
460 case Type::VoidTyID: OS << "void"; return;
461 case Type::HalfTyID: OS << "half"; return;
462 case Type::FloatTyID: OS << "float"; return;
463 case Type::DoubleTyID: OS << "double"; return;
464 case Type::X86_FP80TyID: OS << "x86_fp80"; return;
465 case Type::FP128TyID: OS << "fp128"; return;
466 case Type::PPC_FP128TyID: OS << "ppc_fp128"; return;
467 case Type::LabelTyID: OS << "label"; return;
468 case Type::MetadataTyID: OS << "metadata"; return;
469 case Type::X86_MMXTyID: OS << "x86_mmx"; return;
470 case Type::TokenTyID: OS << "token"; return;
471 case Type::IntegerTyID:
472 OS << 'i' << cast<IntegerType>(Ty)->getBitWidth();
475 case Type::FunctionTyID: {
476 FunctionType *FTy = cast<FunctionType>(Ty);
477 print(FTy->getReturnType(), OS);
479 for (FunctionType::param_iterator I = FTy->param_begin(),
480 E = FTy->param_end(); I != E; ++I) {
481 if (I != FTy->param_begin())
485 if (FTy->isVarArg()) {
486 if (FTy->getNumParams()) OS << ", ";
492 case Type::StructTyID: {
493 StructType *STy = cast<StructType>(Ty);
495 if (STy->isLiteral())
496 return printStructBody(STy, OS);
498 if (!STy->getName().empty())
499 return PrintLLVMName(OS, STy->getName(), LocalPrefix);
501 DenseMap<StructType*, unsigned>::iterator I = NumberedTypes.find(STy);
502 if (I != NumberedTypes.end())
503 OS << '%' << I->second;
504 else // Not enumerated, print the hex address.
505 OS << "%\"type " << STy << '\"';
508 case Type::PointerTyID: {
509 PointerType *PTy = cast<PointerType>(Ty);
510 print(PTy->getElementType(), OS);
511 if (unsigned AddressSpace = PTy->getAddressSpace())
512 OS << " addrspace(" << AddressSpace << ')';
516 case Type::ArrayTyID: {
517 ArrayType *ATy = cast<ArrayType>(Ty);
518 OS << '[' << ATy->getNumElements() << " x ";
519 print(ATy->getElementType(), OS);
523 case Type::VectorTyID: {
524 VectorType *PTy = cast<VectorType>(Ty);
525 OS << "<" << PTy->getNumElements() << " x ";
526 print(PTy->getElementType(), OS);
531 llvm_unreachable("Invalid TypeID");
534 void TypePrinting::printStructBody(StructType *STy, raw_ostream &OS) {
535 if (STy->isOpaque()) {
543 if (STy->getNumElements() == 0) {
546 StructType::element_iterator I = STy->element_begin();
549 for (StructType::element_iterator E = STy->element_end(); I != E; ++I) {
561 //===----------------------------------------------------------------------===//
562 // SlotTracker Class: Enumerate slot numbers for unnamed values
563 //===----------------------------------------------------------------------===//
564 /// This class provides computation of slot numbers for LLVM Assembly writing.
568 /// ValueMap - A mapping of Values to slot numbers.
569 typedef DenseMap<const Value*, unsigned> ValueMap;
572 /// TheModule - The module for which we are holding slot numbers.
573 const Module* TheModule;
575 /// TheFunction - The function for which we are holding slot numbers.
576 const Function* TheFunction;
577 bool FunctionProcessed;
578 bool ShouldInitializeAllMetadata;
580 /// mMap - The slot map for the module level data.
584 /// fMap - The slot map for the function level data.
588 /// mdnMap - Map for MDNodes.
589 DenseMap<const MDNode*, unsigned> mdnMap;
592 /// asMap - The slot map for attribute sets.
593 DenseMap<AttributeSet, unsigned> asMap;
596 /// Construct from a module.
598 /// If \c ShouldInitializeAllMetadata, initializes all metadata in all
599 /// functions, giving correct numbering for metadata referenced only from
600 /// within a function (even if no functions have been initialized).
601 explicit SlotTracker(const Module *M,
602 bool ShouldInitializeAllMetadata = false);
603 /// Construct from a function, starting out in incorp state.
605 /// If \c ShouldInitializeAllMetadata, initializes all metadata in all
606 /// functions, giving correct numbering for metadata referenced only from
607 /// within a function (even if no functions have been initialized).
608 explicit SlotTracker(const Function *F,
609 bool ShouldInitializeAllMetadata = false);
611 /// Return the slot number of the specified value in it's type
612 /// plane. If something is not in the SlotTracker, return -1.
613 int getLocalSlot(const Value *V);
614 int getGlobalSlot(const GlobalValue *V);
615 int getMetadataSlot(const MDNode *N);
616 int getAttributeGroupSlot(AttributeSet AS);
618 /// If you'd like to deal with a function instead of just a module, use
619 /// this method to get its data into the SlotTracker.
620 void incorporateFunction(const Function *F) {
622 FunctionProcessed = false;
625 const Function *getFunction() const { return TheFunction; }
627 /// After calling incorporateFunction, use this method to remove the
628 /// most recently incorporated function from the SlotTracker. This
629 /// will reset the state of the machine back to just the module contents.
630 void purgeFunction();
632 /// MDNode map iterators.
633 typedef DenseMap<const MDNode*, unsigned>::iterator mdn_iterator;
634 mdn_iterator mdn_begin() { return mdnMap.begin(); }
635 mdn_iterator mdn_end() { return mdnMap.end(); }
636 unsigned mdn_size() const { return mdnMap.size(); }
637 bool mdn_empty() const { return mdnMap.empty(); }
639 /// AttributeSet map iterators.
640 typedef DenseMap<AttributeSet, unsigned>::iterator as_iterator;
641 as_iterator as_begin() { return asMap.begin(); }
642 as_iterator as_end() { return asMap.end(); }
643 unsigned as_size() const { return asMap.size(); }
644 bool as_empty() const { return asMap.empty(); }
646 /// This function does the actual initialization.
647 inline void initialize();
649 // Implementation Details
651 /// CreateModuleSlot - Insert the specified GlobalValue* into the slot table.
652 void CreateModuleSlot(const GlobalValue *V);
654 /// CreateMetadataSlot - Insert the specified MDNode* into the slot table.
655 void CreateMetadataSlot(const MDNode *N);
657 /// CreateFunctionSlot - Insert the specified Value* into the slot table.
658 void CreateFunctionSlot(const Value *V);
660 /// \brief Insert the specified AttributeSet into the slot table.
661 void CreateAttributeSetSlot(AttributeSet AS);
663 /// Add all of the module level global variables (and their initializers)
664 /// and function declarations, but not the contents of those functions.
665 void processModule();
667 /// Add all of the functions arguments, basic blocks, and instructions.
668 void processFunction();
670 /// Add all of the metadata from a function.
671 void processFunctionMetadata(const Function &F);
673 /// Add all of the metadata from an instruction.
674 void processInstructionMetadata(const Instruction &I);
676 SlotTracker(const SlotTracker &) = delete;
677 void operator=(const SlotTracker &) = delete;
681 ModuleSlotTracker::ModuleSlotTracker(SlotTracker &Machine, const Module *M,
683 : M(M), F(F), Machine(&Machine) {}
685 ModuleSlotTracker::ModuleSlotTracker(const Module *M,
686 bool ShouldInitializeAllMetadata)
687 : MachineStorage(M ? new SlotTracker(M, ShouldInitializeAllMetadata)
689 M(M), Machine(MachineStorage.get()) {}
691 ModuleSlotTracker::~ModuleSlotTracker() {}
693 void ModuleSlotTracker::incorporateFunction(const Function &F) {
697 // Nothing to do if this is the right function already.
701 Machine->purgeFunction();
702 Machine->incorporateFunction(&F);
706 int ModuleSlotTracker::getLocalSlot(const Value *V) {
707 assert(F && "No function incorporated");
708 return Machine->getLocalSlot(V);
711 static SlotTracker *createSlotTracker(const Module *M) {
712 return new SlotTracker(M);
715 static SlotTracker *createSlotTracker(const Value *V) {
716 if (const Argument *FA = dyn_cast<Argument>(V))
717 return new SlotTracker(FA->getParent());
719 if (const Instruction *I = dyn_cast<Instruction>(V))
721 return new SlotTracker(I->getParent()->getParent());
723 if (const BasicBlock *BB = dyn_cast<BasicBlock>(V))
724 return new SlotTracker(BB->getParent());
726 if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(V))
727 return new SlotTracker(GV->getParent());
729 if (const GlobalAlias *GA = dyn_cast<GlobalAlias>(V))
730 return new SlotTracker(GA->getParent());
732 if (const Function *Func = dyn_cast<Function>(V))
733 return new SlotTracker(Func);
739 #define ST_DEBUG(X) dbgs() << X
744 // Module level constructor. Causes the contents of the Module (sans functions)
745 // to be added to the slot table.
746 SlotTracker::SlotTracker(const Module *M, bool ShouldInitializeAllMetadata)
747 : TheModule(M), TheFunction(nullptr), FunctionProcessed(false),
748 ShouldInitializeAllMetadata(ShouldInitializeAllMetadata), mNext(0),
749 fNext(0), mdnNext(0), asNext(0) {}
751 // Function level constructor. Causes the contents of the Module and the one
752 // function provided to be added to the slot table.
753 SlotTracker::SlotTracker(const Function *F, bool ShouldInitializeAllMetadata)
754 : TheModule(F ? F->getParent() : nullptr), TheFunction(F),
755 FunctionProcessed(false),
756 ShouldInitializeAllMetadata(ShouldInitializeAllMetadata), mNext(0),
757 fNext(0), mdnNext(0), asNext(0) {}
759 inline void SlotTracker::initialize() {
762 TheModule = nullptr; ///< Prevent re-processing next time we're called.
765 if (TheFunction && !FunctionProcessed)
769 // Iterate through all the global variables, functions, and global
770 // variable initializers and create slots for them.
771 void SlotTracker::processModule() {
772 ST_DEBUG("begin processModule!\n");
774 // Add all of the unnamed global variables to the value table.
775 for (const GlobalVariable &Var : TheModule->globals()) {
777 CreateModuleSlot(&Var);
780 for (const GlobalAlias &A : TheModule->aliases()) {
782 CreateModuleSlot(&A);
785 // Add metadata used by named metadata.
786 for (const NamedMDNode &NMD : TheModule->named_metadata()) {
787 for (unsigned i = 0, e = NMD.getNumOperands(); i != e; ++i)
788 CreateMetadataSlot(NMD.getOperand(i));
791 for (const Function &F : *TheModule) {
793 // Add all the unnamed functions to the table.
794 CreateModuleSlot(&F);
796 if (ShouldInitializeAllMetadata)
797 processFunctionMetadata(F);
799 // Add all the function attributes to the table.
800 // FIXME: Add attributes of other objects?
801 AttributeSet FnAttrs = F.getAttributes().getFnAttributes();
802 if (FnAttrs.hasAttributes(AttributeSet::FunctionIndex))
803 CreateAttributeSetSlot(FnAttrs);
806 ST_DEBUG("end processModule!\n");
809 // Process the arguments, basic blocks, and instructions of a function.
810 void SlotTracker::processFunction() {
811 ST_DEBUG("begin processFunction!\n");
814 // Add all the function arguments with no names.
815 for(Function::const_arg_iterator AI = TheFunction->arg_begin(),
816 AE = TheFunction->arg_end(); AI != AE; ++AI)
818 CreateFunctionSlot(AI);
820 ST_DEBUG("Inserting Instructions:\n");
822 // Add all of the basic blocks and instructions with no names.
823 for (auto &BB : *TheFunction) {
825 CreateFunctionSlot(&BB);
827 processFunctionMetadata(*TheFunction);
830 if (!I.getType()->isVoidTy() && !I.hasName())
831 CreateFunctionSlot(&I);
833 // We allow direct calls to any llvm.foo function here, because the
834 // target may not be linked into the optimizer.
835 if (const CallInst *CI = dyn_cast<CallInst>(&I)) {
836 // Add all the call attributes to the table.
837 AttributeSet Attrs = CI->getAttributes().getFnAttributes();
838 if (Attrs.hasAttributes(AttributeSet::FunctionIndex))
839 CreateAttributeSetSlot(Attrs);
840 } else if (const InvokeInst *II = dyn_cast<InvokeInst>(&I)) {
841 // Add all the call attributes to the table.
842 AttributeSet Attrs = II->getAttributes().getFnAttributes();
843 if (Attrs.hasAttributes(AttributeSet::FunctionIndex))
844 CreateAttributeSetSlot(Attrs);
849 FunctionProcessed = true;
851 ST_DEBUG("end processFunction!\n");
854 void SlotTracker::processFunctionMetadata(const Function &F) {
855 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
857 F.getAllMetadata(MDs);
859 CreateMetadataSlot(MD.second);
862 processInstructionMetadata(I);
866 void SlotTracker::processInstructionMetadata(const Instruction &I) {
867 // Process metadata used directly by intrinsics.
868 if (const CallInst *CI = dyn_cast<CallInst>(&I))
869 if (Function *F = CI->getCalledFunction())
870 if (F->isIntrinsic())
871 for (auto &Op : I.operands())
872 if (auto *V = dyn_cast_or_null<MetadataAsValue>(Op))
873 if (MDNode *N = dyn_cast<MDNode>(V->getMetadata()))
874 CreateMetadataSlot(N);
876 // Process metadata attached to this instruction.
877 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
878 I.getAllMetadata(MDs);
880 CreateMetadataSlot(MD.second);
883 /// Clean up after incorporating a function. This is the only way to get out of
884 /// the function incorporation state that affects get*Slot/Create*Slot. Function
885 /// incorporation state is indicated by TheFunction != 0.
886 void SlotTracker::purgeFunction() {
887 ST_DEBUG("begin purgeFunction!\n");
888 fMap.clear(); // Simply discard the function level map
889 TheFunction = nullptr;
890 FunctionProcessed = false;
891 ST_DEBUG("end purgeFunction!\n");
894 /// getGlobalSlot - Get the slot number of a global value.
895 int SlotTracker::getGlobalSlot(const GlobalValue *V) {
896 // Check for uninitialized state and do lazy initialization.
899 // Find the value in the module map
900 ValueMap::iterator MI = mMap.find(V);
901 return MI == mMap.end() ? -1 : (int)MI->second;
904 /// getMetadataSlot - Get the slot number of a MDNode.
905 int SlotTracker::getMetadataSlot(const MDNode *N) {
906 // Check for uninitialized state and do lazy initialization.
909 // Find the MDNode in the module map
910 mdn_iterator MI = mdnMap.find(N);
911 return MI == mdnMap.end() ? -1 : (int)MI->second;
915 /// getLocalSlot - Get the slot number for a value that is local to a function.
916 int SlotTracker::getLocalSlot(const Value *V) {
917 assert(!isa<Constant>(V) && "Can't get a constant or global slot with this!");
919 // Check for uninitialized state and do lazy initialization.
922 ValueMap::iterator FI = fMap.find(V);
923 return FI == fMap.end() ? -1 : (int)FI->second;
926 int SlotTracker::getAttributeGroupSlot(AttributeSet AS) {
927 // Check for uninitialized state and do lazy initialization.
930 // Find the AttributeSet in the module map.
931 as_iterator AI = asMap.find(AS);
932 return AI == asMap.end() ? -1 : (int)AI->second;
935 /// CreateModuleSlot - Insert the specified GlobalValue* into the slot table.
936 void SlotTracker::CreateModuleSlot(const GlobalValue *V) {
937 assert(V && "Can't insert a null Value into SlotTracker!");
938 assert(!V->getType()->isVoidTy() && "Doesn't need a slot!");
939 assert(!V->hasName() && "Doesn't need a slot!");
941 unsigned DestSlot = mNext++;
944 ST_DEBUG(" Inserting value [" << V->getType() << "] = " << V << " slot=" <<
946 // G = Global, F = Function, A = Alias, o = other
947 ST_DEBUG((isa<GlobalVariable>(V) ? 'G' :
948 (isa<Function>(V) ? 'F' :
949 (isa<GlobalAlias>(V) ? 'A' : 'o'))) << "]\n");
952 /// CreateSlot - Create a new slot for the specified value if it has no name.
953 void SlotTracker::CreateFunctionSlot(const Value *V) {
954 assert(!V->getType()->isVoidTy() && !V->hasName() && "Doesn't need a slot!");
956 unsigned DestSlot = fNext++;
959 // G = Global, F = Function, o = other
960 ST_DEBUG(" Inserting value [" << V->getType() << "] = " << V << " slot=" <<
961 DestSlot << " [o]\n");
964 /// CreateModuleSlot - Insert the specified MDNode* into the slot table.
965 void SlotTracker::CreateMetadataSlot(const MDNode *N) {
966 assert(N && "Can't insert a null Value into SlotTracker!");
968 unsigned DestSlot = mdnNext;
969 if (!mdnMap.insert(std::make_pair(N, DestSlot)).second)
973 // Recursively add any MDNodes referenced by operands.
974 for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i)
975 if (const MDNode *Op = dyn_cast_or_null<MDNode>(N->getOperand(i)))
976 CreateMetadataSlot(Op);
979 void SlotTracker::CreateAttributeSetSlot(AttributeSet AS) {
980 assert(AS.hasAttributes(AttributeSet::FunctionIndex) &&
981 "Doesn't need a slot!");
983 as_iterator I = asMap.find(AS);
984 if (I != asMap.end())
987 unsigned DestSlot = asNext++;
988 asMap[AS] = DestSlot;
991 //===----------------------------------------------------------------------===//
992 // AsmWriter Implementation
993 //===----------------------------------------------------------------------===//
995 static void WriteAsOperandInternal(raw_ostream &Out, const Value *V,
996 TypePrinting *TypePrinter,
997 SlotTracker *Machine,
998 const Module *Context);
1000 static void WriteAsOperandInternal(raw_ostream &Out, const Metadata *MD,
1001 TypePrinting *TypePrinter,
1002 SlotTracker *Machine, const Module *Context,
1003 bool FromValue = false);
1005 static const char *getPredicateText(unsigned predicate) {
1006 const char * pred = "unknown";
1007 switch (predicate) {
1008 case FCmpInst::FCMP_FALSE: pred = "false"; break;
1009 case FCmpInst::FCMP_OEQ: pred = "oeq"; break;
1010 case FCmpInst::FCMP_OGT: pred = "ogt"; break;
1011 case FCmpInst::FCMP_OGE: pred = "oge"; break;
1012 case FCmpInst::FCMP_OLT: pred = "olt"; break;
1013 case FCmpInst::FCMP_OLE: pred = "ole"; break;
1014 case FCmpInst::FCMP_ONE: pred = "one"; break;
1015 case FCmpInst::FCMP_ORD: pred = "ord"; break;
1016 case FCmpInst::FCMP_UNO: pred = "uno"; break;
1017 case FCmpInst::FCMP_UEQ: pred = "ueq"; break;
1018 case FCmpInst::FCMP_UGT: pred = "ugt"; break;
1019 case FCmpInst::FCMP_UGE: pred = "uge"; break;
1020 case FCmpInst::FCMP_ULT: pred = "ult"; break;
1021 case FCmpInst::FCMP_ULE: pred = "ule"; break;
1022 case FCmpInst::FCMP_UNE: pred = "une"; break;
1023 case FCmpInst::FCMP_TRUE: pred = "true"; break;
1024 case ICmpInst::ICMP_EQ: pred = "eq"; break;
1025 case ICmpInst::ICMP_NE: pred = "ne"; break;
1026 case ICmpInst::ICMP_SGT: pred = "sgt"; break;
1027 case ICmpInst::ICMP_SGE: pred = "sge"; break;
1028 case ICmpInst::ICMP_SLT: pred = "slt"; break;
1029 case ICmpInst::ICMP_SLE: pred = "sle"; break;
1030 case ICmpInst::ICMP_UGT: pred = "ugt"; break;
1031 case ICmpInst::ICMP_UGE: pred = "uge"; break;
1032 case ICmpInst::ICMP_ULT: pred = "ult"; break;
1033 case ICmpInst::ICMP_ULE: pred = "ule"; break;
1038 static void writeAtomicRMWOperation(raw_ostream &Out,
1039 AtomicRMWInst::BinOp Op) {
1041 default: Out << " <unknown operation " << Op << ">"; break;
1042 case AtomicRMWInst::Xchg: Out << " xchg"; break;
1043 case AtomicRMWInst::Add: Out << " add"; break;
1044 case AtomicRMWInst::Sub: Out << " sub"; break;
1045 case AtomicRMWInst::And: Out << " and"; break;
1046 case AtomicRMWInst::Nand: Out << " nand"; break;
1047 case AtomicRMWInst::Or: Out << " or"; break;
1048 case AtomicRMWInst::Xor: Out << " xor"; break;
1049 case AtomicRMWInst::Max: Out << " max"; break;
1050 case AtomicRMWInst::Min: Out << " min"; break;
1051 case AtomicRMWInst::UMax: Out << " umax"; break;
1052 case AtomicRMWInst::UMin: Out << " umin"; break;
1056 static void WriteOptimizationInfo(raw_ostream &Out, const User *U) {
1057 if (const FPMathOperator *FPO = dyn_cast<const FPMathOperator>(U)) {
1058 // Unsafe algebra implies all the others, no need to write them all out
1059 if (FPO->hasUnsafeAlgebra())
1062 if (FPO->hasNoNaNs())
1064 if (FPO->hasNoInfs())
1066 if (FPO->hasNoSignedZeros())
1068 if (FPO->hasAllowReciprocal())
1073 if (const OverflowingBinaryOperator *OBO =
1074 dyn_cast<OverflowingBinaryOperator>(U)) {
1075 if (OBO->hasNoUnsignedWrap())
1077 if (OBO->hasNoSignedWrap())
1079 } else if (const PossiblyExactOperator *Div =
1080 dyn_cast<PossiblyExactOperator>(U)) {
1083 } else if (const GEPOperator *GEP = dyn_cast<GEPOperator>(U)) {
1084 if (GEP->isInBounds())
1089 static void WriteConstantInternal(raw_ostream &Out, const Constant *CV,
1090 TypePrinting &TypePrinter,
1091 SlotTracker *Machine,
1092 const Module *Context) {
1093 if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV)) {
1094 if (CI->getType()->isIntegerTy(1)) {
1095 Out << (CI->getZExtValue() ? "true" : "false");
1098 Out << CI->getValue();
1102 if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV)) {
1103 if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEsingle ||
1104 &CFP->getValueAPF().getSemantics() == &APFloat::IEEEdouble) {
1105 // We would like to output the FP constant value in exponential notation,
1106 // but we cannot do this if doing so will lose precision. Check here to
1107 // make sure that we only output it in exponential format if we can parse
1108 // the value back and get the same value.
1111 bool isHalf = &CFP->getValueAPF().getSemantics()==&APFloat::IEEEhalf;
1112 bool isDouble = &CFP->getValueAPF().getSemantics()==&APFloat::IEEEdouble;
1113 bool isInf = CFP->getValueAPF().isInfinity();
1114 bool isNaN = CFP->getValueAPF().isNaN();
1115 if (!isHalf && !isInf && !isNaN) {
1116 double Val = isDouble ? CFP->getValueAPF().convertToDouble() :
1117 CFP->getValueAPF().convertToFloat();
1118 SmallString<128> StrVal;
1119 raw_svector_ostream(StrVal) << Val;
1121 // Check to make sure that the stringized number is not some string like
1122 // "Inf" or NaN, that atof will accept, but the lexer will not. Check
1123 // that the string matches the "[-+]?[0-9]" regex.
1125 if ((StrVal[0] >= '0' && StrVal[0] <= '9') ||
1126 ((StrVal[0] == '-' || StrVal[0] == '+') &&
1127 (StrVal[1] >= '0' && StrVal[1] <= '9'))) {
1128 // Reparse stringized version!
1129 if (APFloat(APFloat::IEEEdouble, StrVal).convertToDouble() == Val) {
1135 // Otherwise we could not reparse it to exactly the same value, so we must
1136 // output the string in hexadecimal format! Note that loading and storing
1137 // floating point types changes the bits of NaNs on some hosts, notably
1138 // x86, so we must not use these types.
1139 static_assert(sizeof(double) == sizeof(uint64_t),
1140 "assuming that double is 64 bits!");
1142 APFloat apf = CFP->getValueAPF();
1143 // Halves and floats are represented in ASCII IR as double, convert.
1145 apf.convert(APFloat::IEEEdouble, APFloat::rmNearestTiesToEven,
1148 utohex_buffer(uint64_t(apf.bitcastToAPInt().getZExtValue()),
1153 // Either half, or some form of long double.
1154 // These appear as a magic letter identifying the type, then a
1155 // fixed number of hex digits.
1157 // Bit position, in the current word, of the next nibble to print.
1160 if (&CFP->getValueAPF().getSemantics() == &APFloat::x87DoubleExtended) {
1162 // api needed to prevent premature destruction
1163 APInt api = CFP->getValueAPF().bitcastToAPInt();
1164 const uint64_t* p = api.getRawData();
1165 uint64_t word = p[1];
1167 int width = api.getBitWidth();
1168 for (int j=0; j<width; j+=4, shiftcount-=4) {
1169 unsigned int nibble = (word>>shiftcount) & 15;
1171 Out << (unsigned char)(nibble + '0');
1173 Out << (unsigned char)(nibble - 10 + 'A');
1174 if (shiftcount == 0 && j+4 < width) {
1178 shiftcount = width-j-4;
1182 } else if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEquad) {
1185 } else if (&CFP->getValueAPF().getSemantics() == &APFloat::PPCDoubleDouble) {
1188 } else if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEhalf) {
1192 llvm_unreachable("Unsupported floating point type");
1193 // api needed to prevent premature destruction
1194 APInt api = CFP->getValueAPF().bitcastToAPInt();
1195 const uint64_t* p = api.getRawData();
1197 int width = api.getBitWidth();
1198 for (int j=0; j<width; j+=4, shiftcount-=4) {
1199 unsigned int nibble = (word>>shiftcount) & 15;
1201 Out << (unsigned char)(nibble + '0');
1203 Out << (unsigned char)(nibble - 10 + 'A');
1204 if (shiftcount == 0 && j+4 < width) {
1208 shiftcount = width-j-4;
1214 if (isa<ConstantAggregateZero>(CV)) {
1215 Out << "zeroinitializer";
1219 if (const BlockAddress *BA = dyn_cast<BlockAddress>(CV)) {
1220 Out << "blockaddress(";
1221 WriteAsOperandInternal(Out, BA->getFunction(), &TypePrinter, Machine,
1224 WriteAsOperandInternal(Out, BA->getBasicBlock(), &TypePrinter, Machine,
1230 if (const ConstantArray *CA = dyn_cast<ConstantArray>(CV)) {
1231 Type *ETy = CA->getType()->getElementType();
1233 TypePrinter.print(ETy, Out);
1235 WriteAsOperandInternal(Out, CA->getOperand(0),
1236 &TypePrinter, Machine,
1238 for (unsigned i = 1, e = CA->getNumOperands(); i != e; ++i) {
1240 TypePrinter.print(ETy, Out);
1242 WriteAsOperandInternal(Out, CA->getOperand(i), &TypePrinter, Machine,
1249 if (const ConstantDataArray *CA = dyn_cast<ConstantDataArray>(CV)) {
1250 // As a special case, print the array as a string if it is an array of
1251 // i8 with ConstantInt values.
1252 if (CA->isString()) {
1254 PrintEscapedString(CA->getAsString(), Out);
1259 Type *ETy = CA->getType()->getElementType();
1261 TypePrinter.print(ETy, Out);
1263 WriteAsOperandInternal(Out, CA->getElementAsConstant(0),
1264 &TypePrinter, Machine,
1266 for (unsigned i = 1, e = CA->getNumElements(); i != e; ++i) {
1268 TypePrinter.print(ETy, Out);
1270 WriteAsOperandInternal(Out, CA->getElementAsConstant(i), &TypePrinter,
1278 if (const ConstantStruct *CS = dyn_cast<ConstantStruct>(CV)) {
1279 if (CS->getType()->isPacked())
1282 unsigned N = CS->getNumOperands();
1285 TypePrinter.print(CS->getOperand(0)->getType(), Out);
1288 WriteAsOperandInternal(Out, CS->getOperand(0), &TypePrinter, Machine,
1291 for (unsigned i = 1; i < N; i++) {
1293 TypePrinter.print(CS->getOperand(i)->getType(), Out);
1296 WriteAsOperandInternal(Out, CS->getOperand(i), &TypePrinter, Machine,
1303 if (CS->getType()->isPacked())
1308 if (isa<ConstantVector>(CV) || isa<ConstantDataVector>(CV)) {
1309 Type *ETy = CV->getType()->getVectorElementType();
1311 TypePrinter.print(ETy, Out);
1313 WriteAsOperandInternal(Out, CV->getAggregateElement(0U), &TypePrinter,
1315 for (unsigned i = 1, e = CV->getType()->getVectorNumElements(); i != e;++i){
1317 TypePrinter.print(ETy, Out);
1319 WriteAsOperandInternal(Out, CV->getAggregateElement(i), &TypePrinter,
1326 if (isa<ConstantPointerNull>(CV)) {
1331 if (isa<UndefValue>(CV)) {
1336 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV)) {
1337 Out << CE->getOpcodeName();
1338 WriteOptimizationInfo(Out, CE);
1339 if (CE->isCompare())
1340 Out << ' ' << getPredicateText(CE->getPredicate());
1343 if (const GEPOperator *GEP = dyn_cast<GEPOperator>(CE)) {
1344 TypePrinter.print(GEP->getSourceElementType(), Out);
1348 for (User::const_op_iterator OI=CE->op_begin(); OI != CE->op_end(); ++OI) {
1349 TypePrinter.print((*OI)->getType(), Out);
1351 WriteAsOperandInternal(Out, *OI, &TypePrinter, Machine, Context);
1352 if (OI+1 != CE->op_end())
1356 if (CE->hasIndices()) {
1357 ArrayRef<unsigned> Indices = CE->getIndices();
1358 for (unsigned i = 0, e = Indices.size(); i != e; ++i)
1359 Out << ", " << Indices[i];
1364 TypePrinter.print(CE->getType(), Out);
1371 Out << "<placeholder or erroneous Constant>";
1374 static void writeMDTuple(raw_ostream &Out, const MDTuple *Node,
1375 TypePrinting *TypePrinter, SlotTracker *Machine,
1376 const Module *Context) {
1378 for (unsigned mi = 0, me = Node->getNumOperands(); mi != me; ++mi) {
1379 const Metadata *MD = Node->getOperand(mi);
1382 else if (auto *MDV = dyn_cast<ValueAsMetadata>(MD)) {
1383 Value *V = MDV->getValue();
1384 TypePrinter->print(V->getType(), Out);
1386 WriteAsOperandInternal(Out, V, TypePrinter, Machine, Context);
1388 WriteAsOperandInternal(Out, MD, TypePrinter, Machine, Context);
1398 struct FieldSeparator {
1401 FieldSeparator(const char *Sep = ", ") : Skip(true), Sep(Sep) {}
1403 raw_ostream &operator<<(raw_ostream &OS, FieldSeparator &FS) {
1408 return OS << FS.Sep;
1410 struct MDFieldPrinter {
1413 TypePrinting *TypePrinter;
1414 SlotTracker *Machine;
1415 const Module *Context;
1417 explicit MDFieldPrinter(raw_ostream &Out)
1418 : Out(Out), TypePrinter(nullptr), Machine(nullptr), Context(nullptr) {}
1419 MDFieldPrinter(raw_ostream &Out, TypePrinting *TypePrinter,
1420 SlotTracker *Machine, const Module *Context)
1421 : Out(Out), TypePrinter(TypePrinter), Machine(Machine), Context(Context) {
1423 void printTag(const DINode *N);
1424 void printString(StringRef Name, StringRef Value,
1425 bool ShouldSkipEmpty = true);
1426 void printMetadata(StringRef Name, const Metadata *MD,
1427 bool ShouldSkipNull = true);
1428 template <class IntTy>
1429 void printInt(StringRef Name, IntTy Int, bool ShouldSkipZero = true);
1430 void printBool(StringRef Name, bool Value);
1431 void printDIFlags(StringRef Name, unsigned Flags);
1432 template <class IntTy, class Stringifier>
1433 void printDwarfEnum(StringRef Name, IntTy Value, Stringifier toString,
1434 bool ShouldSkipZero = true);
1438 void MDFieldPrinter::printTag(const DINode *N) {
1439 Out << FS << "tag: ";
1440 if (const char *Tag = dwarf::TagString(N->getTag()))
1446 void MDFieldPrinter::printString(StringRef Name, StringRef Value,
1447 bool ShouldSkipEmpty) {
1448 if (ShouldSkipEmpty && Value.empty())
1451 Out << FS << Name << ": \"";
1452 PrintEscapedString(Value, Out);
1456 static void writeMetadataAsOperand(raw_ostream &Out, const Metadata *MD,
1457 TypePrinting *TypePrinter,
1458 SlotTracker *Machine,
1459 const Module *Context) {
1464 WriteAsOperandInternal(Out, MD, TypePrinter, Machine, Context);
1467 void MDFieldPrinter::printMetadata(StringRef Name, const Metadata *MD,
1468 bool ShouldSkipNull) {
1469 if (ShouldSkipNull && !MD)
1472 Out << FS << Name << ": ";
1473 writeMetadataAsOperand(Out, MD, TypePrinter, Machine, Context);
1476 template <class IntTy>
1477 void MDFieldPrinter::printInt(StringRef Name, IntTy Int, bool ShouldSkipZero) {
1478 if (ShouldSkipZero && !Int)
1481 Out << FS << Name << ": " << Int;
1484 void MDFieldPrinter::printBool(StringRef Name, bool Value) {
1485 Out << FS << Name << ": " << (Value ? "true" : "false");
1488 void MDFieldPrinter::printDIFlags(StringRef Name, unsigned Flags) {
1492 Out << FS << Name << ": ";
1494 SmallVector<unsigned, 8> SplitFlags;
1495 unsigned Extra = DINode::splitFlags(Flags, SplitFlags);
1497 FieldSeparator FlagsFS(" | ");
1498 for (unsigned F : SplitFlags) {
1499 const char *StringF = DINode::getFlagString(F);
1500 assert(StringF && "Expected valid flag");
1501 Out << FlagsFS << StringF;
1503 if (Extra || SplitFlags.empty())
1504 Out << FlagsFS << Extra;
1507 template <class IntTy, class Stringifier>
1508 void MDFieldPrinter::printDwarfEnum(StringRef Name, IntTy Value,
1509 Stringifier toString, bool ShouldSkipZero) {
1513 Out << FS << Name << ": ";
1514 if (const char *S = toString(Value))
1520 static void writeGenericDINode(raw_ostream &Out, const GenericDINode *N,
1521 TypePrinting *TypePrinter, SlotTracker *Machine,
1522 const Module *Context) {
1523 Out << "!GenericDINode(";
1524 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1525 Printer.printTag(N);
1526 Printer.printString("header", N->getHeader());
1527 if (N->getNumDwarfOperands()) {
1528 Out << Printer.FS << "operands: {";
1530 for (auto &I : N->dwarf_operands()) {
1532 writeMetadataAsOperand(Out, I, TypePrinter, Machine, Context);
1539 static void writeDILocation(raw_ostream &Out, const DILocation *DL,
1540 TypePrinting *TypePrinter, SlotTracker *Machine,
1541 const Module *Context) {
1542 Out << "!DILocation(";
1543 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1544 // Always output the line, since 0 is a relevant and important value for it.
1545 Printer.printInt("line", DL->getLine(), /* ShouldSkipZero */ false);
1546 Printer.printInt("column", DL->getColumn());
1547 Printer.printMetadata("scope", DL->getRawScope(), /* ShouldSkipNull */ false);
1548 Printer.printMetadata("inlinedAt", DL->getRawInlinedAt());
1552 static void writeDISubrange(raw_ostream &Out, const DISubrange *N,
1553 TypePrinting *, SlotTracker *, const Module *) {
1554 Out << "!DISubrange(";
1555 MDFieldPrinter Printer(Out);
1556 Printer.printInt("count", N->getCount(), /* ShouldSkipZero */ false);
1557 Printer.printInt("lowerBound", N->getLowerBound());
1561 static void writeDIEnumerator(raw_ostream &Out, const DIEnumerator *N,
1562 TypePrinting *, SlotTracker *, const Module *) {
1563 Out << "!DIEnumerator(";
1564 MDFieldPrinter Printer(Out);
1565 Printer.printString("name", N->getName(), /* ShouldSkipEmpty */ false);
1566 Printer.printInt("value", N->getValue(), /* ShouldSkipZero */ false);
1570 static void writeDIBasicType(raw_ostream &Out, const DIBasicType *N,
1571 TypePrinting *, SlotTracker *, const Module *) {
1572 Out << "!DIBasicType(";
1573 MDFieldPrinter Printer(Out);
1574 if (N->getTag() != dwarf::DW_TAG_base_type)
1575 Printer.printTag(N);
1576 Printer.printString("name", N->getName());
1577 Printer.printInt("size", N->getSizeInBits());
1578 Printer.printInt("align", N->getAlignInBits());
1579 Printer.printDwarfEnum("encoding", N->getEncoding(),
1580 dwarf::AttributeEncodingString);
1584 static void writeDIDerivedType(raw_ostream &Out, const DIDerivedType *N,
1585 TypePrinting *TypePrinter, SlotTracker *Machine,
1586 const Module *Context) {
1587 Out << "!DIDerivedType(";
1588 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1589 Printer.printTag(N);
1590 Printer.printString("name", N->getName());
1591 Printer.printMetadata("scope", N->getRawScope());
1592 Printer.printMetadata("file", N->getRawFile());
1593 Printer.printInt("line", N->getLine());
1594 Printer.printMetadata("baseType", N->getRawBaseType(),
1595 /* ShouldSkipNull */ false);
1596 Printer.printInt("size", N->getSizeInBits());
1597 Printer.printInt("align", N->getAlignInBits());
1598 Printer.printInt("offset", N->getOffsetInBits());
1599 Printer.printDIFlags("flags", N->getFlags());
1600 Printer.printMetadata("extraData", N->getRawExtraData());
1604 static void writeDICompositeType(raw_ostream &Out, const DICompositeType *N,
1605 TypePrinting *TypePrinter,
1606 SlotTracker *Machine, const Module *Context) {
1607 Out << "!DICompositeType(";
1608 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1609 Printer.printTag(N);
1610 Printer.printString("name", N->getName());
1611 Printer.printMetadata("scope", N->getRawScope());
1612 Printer.printMetadata("file", N->getRawFile());
1613 Printer.printInt("line", N->getLine());
1614 Printer.printMetadata("baseType", N->getRawBaseType());
1615 Printer.printInt("size", N->getSizeInBits());
1616 Printer.printInt("align", N->getAlignInBits());
1617 Printer.printInt("offset", N->getOffsetInBits());
1618 Printer.printDIFlags("flags", N->getFlags());
1619 Printer.printMetadata("elements", N->getRawElements());
1620 Printer.printDwarfEnum("runtimeLang", N->getRuntimeLang(),
1621 dwarf::LanguageString);
1622 Printer.printMetadata("vtableHolder", N->getRawVTableHolder());
1623 Printer.printMetadata("templateParams", N->getRawTemplateParams());
1624 Printer.printString("identifier", N->getIdentifier());
1628 static void writeDISubroutineType(raw_ostream &Out, const DISubroutineType *N,
1629 TypePrinting *TypePrinter,
1630 SlotTracker *Machine, const Module *Context) {
1631 Out << "!DISubroutineType(";
1632 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1633 Printer.printDIFlags("flags", N->getFlags());
1634 Printer.printMetadata("types", N->getRawTypeArray(),
1635 /* ShouldSkipNull */ false);
1639 static void writeDIFile(raw_ostream &Out, const DIFile *N, TypePrinting *,
1640 SlotTracker *, const Module *) {
1642 MDFieldPrinter Printer(Out);
1643 Printer.printString("filename", N->getFilename(),
1644 /* ShouldSkipEmpty */ false);
1645 Printer.printString("directory", N->getDirectory(),
1646 /* ShouldSkipEmpty */ false);
1650 static void writeDICompileUnit(raw_ostream &Out, const DICompileUnit *N,
1651 TypePrinting *TypePrinter, SlotTracker *Machine,
1652 const Module *Context) {
1653 Out << "!DICompileUnit(";
1654 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1655 Printer.printDwarfEnum("language", N->getSourceLanguage(),
1656 dwarf::LanguageString, /* ShouldSkipZero */ false);
1657 Printer.printMetadata("file", N->getRawFile(), /* ShouldSkipNull */ false);
1658 Printer.printString("producer", N->getProducer());
1659 Printer.printBool("isOptimized", N->isOptimized());
1660 Printer.printString("flags", N->getFlags());
1661 Printer.printInt("runtimeVersion", N->getRuntimeVersion(),
1662 /* ShouldSkipZero */ false);
1663 Printer.printString("splitDebugFilename", N->getSplitDebugFilename());
1664 Printer.printInt("emissionKind", N->getEmissionKind(),
1665 /* ShouldSkipZero */ false);
1666 Printer.printMetadata("enums", N->getRawEnumTypes());
1667 Printer.printMetadata("retainedTypes", N->getRawRetainedTypes());
1668 Printer.printMetadata("subprograms", N->getRawSubprograms());
1669 Printer.printMetadata("globals", N->getRawGlobalVariables());
1670 Printer.printMetadata("imports", N->getRawImportedEntities());
1671 Printer.printInt("dwoId", N->getDWOId());
1675 static void writeDISubprogram(raw_ostream &Out, const DISubprogram *N,
1676 TypePrinting *TypePrinter, SlotTracker *Machine,
1677 const Module *Context) {
1678 Out << "!DISubprogram(";
1679 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1680 Printer.printString("name", N->getName());
1681 Printer.printString("linkageName", N->getLinkageName());
1682 Printer.printMetadata("scope", N->getRawScope(), /* ShouldSkipNull */ false);
1683 Printer.printMetadata("file", N->getRawFile());
1684 Printer.printInt("line", N->getLine());
1685 Printer.printMetadata("type", N->getRawType());
1686 Printer.printBool("isLocal", N->isLocalToUnit());
1687 Printer.printBool("isDefinition", N->isDefinition());
1688 Printer.printInt("scopeLine", N->getScopeLine());
1689 Printer.printMetadata("containingType", N->getRawContainingType());
1690 Printer.printDwarfEnum("virtuality", N->getVirtuality(),
1691 dwarf::VirtualityString);
1692 Printer.printInt("virtualIndex", N->getVirtualIndex());
1693 Printer.printDIFlags("flags", N->getFlags());
1694 Printer.printBool("isOptimized", N->isOptimized());
1695 Printer.printMetadata("function", N->getRawFunction());
1696 Printer.printMetadata("templateParams", N->getRawTemplateParams());
1697 Printer.printMetadata("declaration", N->getRawDeclaration());
1698 Printer.printMetadata("variables", N->getRawVariables());
1702 static void writeDILexicalBlock(raw_ostream &Out, const DILexicalBlock *N,
1703 TypePrinting *TypePrinter, SlotTracker *Machine,
1704 const Module *Context) {
1705 Out << "!DILexicalBlock(";
1706 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1707 Printer.printMetadata("scope", N->getRawScope(), /* ShouldSkipNull */ false);
1708 Printer.printMetadata("file", N->getRawFile());
1709 Printer.printInt("line", N->getLine());
1710 Printer.printInt("column", N->getColumn());
1714 static void writeDILexicalBlockFile(raw_ostream &Out,
1715 const DILexicalBlockFile *N,
1716 TypePrinting *TypePrinter,
1717 SlotTracker *Machine,
1718 const Module *Context) {
1719 Out << "!DILexicalBlockFile(";
1720 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1721 Printer.printMetadata("scope", N->getRawScope(), /* ShouldSkipNull */ false);
1722 Printer.printMetadata("file", N->getRawFile());
1723 Printer.printInt("discriminator", N->getDiscriminator(),
1724 /* ShouldSkipZero */ false);
1728 static void writeDINamespace(raw_ostream &Out, const DINamespace *N,
1729 TypePrinting *TypePrinter, SlotTracker *Machine,
1730 const Module *Context) {
1731 Out << "!DINamespace(";
1732 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1733 Printer.printString("name", N->getName());
1734 Printer.printMetadata("scope", N->getRawScope(), /* ShouldSkipNull */ false);
1735 Printer.printMetadata("file", N->getRawFile());
1736 Printer.printInt("line", N->getLine());
1740 static void writeDIModule(raw_ostream &Out, const DIModule *N,
1741 TypePrinting *TypePrinter, SlotTracker *Machine,
1742 const Module *Context) {
1743 Out << "!DIModule(";
1744 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1745 Printer.printMetadata("scope", N->getRawScope(), /* ShouldSkipNull */ false);
1746 Printer.printString("name", N->getName());
1747 Printer.printString("configMacros", N->getConfigurationMacros());
1748 Printer.printString("includePath", N->getIncludePath());
1749 Printer.printString("isysroot", N->getISysRoot());
1754 static void writeDITemplateTypeParameter(raw_ostream &Out,
1755 const DITemplateTypeParameter *N,
1756 TypePrinting *TypePrinter,
1757 SlotTracker *Machine,
1758 const Module *Context) {
1759 Out << "!DITemplateTypeParameter(";
1760 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1761 Printer.printString("name", N->getName());
1762 Printer.printMetadata("type", N->getRawType(), /* ShouldSkipNull */ false);
1766 static void writeDITemplateValueParameter(raw_ostream &Out,
1767 const DITemplateValueParameter *N,
1768 TypePrinting *TypePrinter,
1769 SlotTracker *Machine,
1770 const Module *Context) {
1771 Out << "!DITemplateValueParameter(";
1772 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1773 if (N->getTag() != dwarf::DW_TAG_template_value_parameter)
1774 Printer.printTag(N);
1775 Printer.printString("name", N->getName());
1776 Printer.printMetadata("type", N->getRawType());
1777 Printer.printMetadata("value", N->getValue(), /* ShouldSkipNull */ false);
1781 static void writeDIGlobalVariable(raw_ostream &Out, const DIGlobalVariable *N,
1782 TypePrinting *TypePrinter,
1783 SlotTracker *Machine, const Module *Context) {
1784 Out << "!DIGlobalVariable(";
1785 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1786 Printer.printString("name", N->getName());
1787 Printer.printString("linkageName", N->getLinkageName());
1788 Printer.printMetadata("scope", N->getRawScope(), /* ShouldSkipNull */ false);
1789 Printer.printMetadata("file", N->getRawFile());
1790 Printer.printInt("line", N->getLine());
1791 Printer.printMetadata("type", N->getRawType());
1792 Printer.printBool("isLocal", N->isLocalToUnit());
1793 Printer.printBool("isDefinition", N->isDefinition());
1794 Printer.printMetadata("variable", N->getRawVariable());
1795 Printer.printMetadata("declaration", N->getRawStaticDataMemberDeclaration());
1799 static void writeDILocalVariable(raw_ostream &Out, const DILocalVariable *N,
1800 TypePrinting *TypePrinter,
1801 SlotTracker *Machine, const Module *Context) {
1802 Out << "!DILocalVariable(";
1803 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1804 Printer.printString("name", N->getName());
1805 Printer.printInt("arg", N->getArg());
1806 Printer.printMetadata("scope", N->getRawScope(), /* ShouldSkipNull */ false);
1807 Printer.printMetadata("file", N->getRawFile());
1808 Printer.printInt("line", N->getLine());
1809 Printer.printMetadata("type", N->getRawType());
1810 Printer.printDIFlags("flags", N->getFlags());
1814 static void writeDIExpression(raw_ostream &Out, const DIExpression *N,
1815 TypePrinting *TypePrinter, SlotTracker *Machine,
1816 const Module *Context) {
1817 Out << "!DIExpression(";
1820 for (auto I = N->expr_op_begin(), E = N->expr_op_end(); I != E; ++I) {
1821 const char *OpStr = dwarf::OperationEncodingString(I->getOp());
1822 assert(OpStr && "Expected valid opcode");
1825 for (unsigned A = 0, AE = I->getNumArgs(); A != AE; ++A)
1826 Out << FS << I->getArg(A);
1829 for (const auto &I : N->getElements())
1835 static void writeDIObjCProperty(raw_ostream &Out, const DIObjCProperty *N,
1836 TypePrinting *TypePrinter, SlotTracker *Machine,
1837 const Module *Context) {
1838 Out << "!DIObjCProperty(";
1839 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1840 Printer.printString("name", N->getName());
1841 Printer.printMetadata("file", N->getRawFile());
1842 Printer.printInt("line", N->getLine());
1843 Printer.printString("setter", N->getSetterName());
1844 Printer.printString("getter", N->getGetterName());
1845 Printer.printInt("attributes", N->getAttributes());
1846 Printer.printMetadata("type", N->getRawType());
1850 static void writeDIImportedEntity(raw_ostream &Out, const DIImportedEntity *N,
1851 TypePrinting *TypePrinter,
1852 SlotTracker *Machine, const Module *Context) {
1853 Out << "!DIImportedEntity(";
1854 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1855 Printer.printTag(N);
1856 Printer.printString("name", N->getName());
1857 Printer.printMetadata("scope", N->getRawScope(), /* ShouldSkipNull */ false);
1858 Printer.printMetadata("entity", N->getRawEntity());
1859 Printer.printInt("line", N->getLine());
1864 static void WriteMDNodeBodyInternal(raw_ostream &Out, const MDNode *Node,
1865 TypePrinting *TypePrinter,
1866 SlotTracker *Machine,
1867 const Module *Context) {
1868 if (Node->isDistinct())
1870 else if (Node->isTemporary())
1871 Out << "<temporary!> "; // Handle broken code.
1873 switch (Node->getMetadataID()) {
1875 llvm_unreachable("Expected uniquable MDNode");
1876 #define HANDLE_MDNODE_LEAF(CLASS) \
1877 case Metadata::CLASS##Kind: \
1878 write##CLASS(Out, cast<CLASS>(Node), TypePrinter, Machine, Context); \
1880 #include "llvm/IR/Metadata.def"
1884 // Full implementation of printing a Value as an operand with support for
1885 // TypePrinting, etc.
1886 static void WriteAsOperandInternal(raw_ostream &Out, const Value *V,
1887 TypePrinting *TypePrinter,
1888 SlotTracker *Machine,
1889 const Module *Context) {
1891 PrintLLVMName(Out, V);
1895 const Constant *CV = dyn_cast<Constant>(V);
1896 if (CV && !isa<GlobalValue>(CV)) {
1897 assert(TypePrinter && "Constants require TypePrinting!");
1898 WriteConstantInternal(Out, CV, *TypePrinter, Machine, Context);
1902 if (const InlineAsm *IA = dyn_cast<InlineAsm>(V)) {
1904 if (IA->hasSideEffects())
1905 Out << "sideeffect ";
1906 if (IA->isAlignStack())
1907 Out << "alignstack ";
1908 // We don't emit the AD_ATT dialect as it's the assumed default.
1909 if (IA->getDialect() == InlineAsm::AD_Intel)
1910 Out << "inteldialect ";
1912 PrintEscapedString(IA->getAsmString(), Out);
1914 PrintEscapedString(IA->getConstraintString(), Out);
1919 if (auto *MD = dyn_cast<MetadataAsValue>(V)) {
1920 WriteAsOperandInternal(Out, MD->getMetadata(), TypePrinter, Machine,
1921 Context, /* FromValue */ true);
1927 // If we have a SlotTracker, use it.
1929 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
1930 Slot = Machine->getGlobalSlot(GV);
1933 Slot = Machine->getLocalSlot(V);
1935 // If the local value didn't succeed, then we may be referring to a value
1936 // from a different function. Translate it, as this can happen when using
1937 // address of blocks.
1939 if ((Machine = createSlotTracker(V))) {
1940 Slot = Machine->getLocalSlot(V);
1944 } else if ((Machine = createSlotTracker(V))) {
1945 // Otherwise, create one to get the # and then destroy it.
1946 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
1947 Slot = Machine->getGlobalSlot(GV);
1950 Slot = Machine->getLocalSlot(V);
1959 Out << Prefix << Slot;
1964 static void WriteAsOperandInternal(raw_ostream &Out, const Metadata *MD,
1965 TypePrinting *TypePrinter,
1966 SlotTracker *Machine, const Module *Context,
1968 if (const MDNode *N = dyn_cast<MDNode>(MD)) {
1969 std::unique_ptr<SlotTracker> MachineStorage;
1971 MachineStorage = make_unique<SlotTracker>(Context);
1972 Machine = MachineStorage.get();
1974 int Slot = Machine->getMetadataSlot(N);
1976 // Give the pointer value instead of "badref", since this comes up all
1977 // the time when debugging.
1978 Out << "<" << N << ">";
1984 if (const MDString *MDS = dyn_cast<MDString>(MD)) {
1986 PrintEscapedString(MDS->getString(), Out);
1991 auto *V = cast<ValueAsMetadata>(MD);
1992 assert(TypePrinter && "TypePrinter required for metadata values");
1993 assert((FromValue || !isa<LocalAsMetadata>(V)) &&
1994 "Unexpected function-local metadata outside of value argument");
1996 TypePrinter->print(V->getValue()->getType(), Out);
1998 WriteAsOperandInternal(Out, V->getValue(), TypePrinter, Machine, Context);
2002 class AssemblyWriter {
2003 formatted_raw_ostream &Out;
2004 const Module *TheModule;
2005 std::unique_ptr<SlotTracker> SlotTrackerStorage;
2006 SlotTracker &Machine;
2007 TypePrinting TypePrinter;
2008 AssemblyAnnotationWriter *AnnotationWriter;
2009 SetVector<const Comdat *> Comdats;
2010 bool ShouldPreserveUseListOrder;
2011 UseListOrderStack UseListOrders;
2012 SmallVector<StringRef, 8> MDNames;
2015 /// Construct an AssemblyWriter with an external SlotTracker
2016 AssemblyWriter(formatted_raw_ostream &o, SlotTracker &Mac, const Module *M,
2017 AssemblyAnnotationWriter *AAW,
2018 bool ShouldPreserveUseListOrder = false);
2020 /// Construct an AssemblyWriter with an internally allocated SlotTracker
2021 AssemblyWriter(formatted_raw_ostream &o, const Module *M,
2022 AssemblyAnnotationWriter *AAW,
2023 bool ShouldPreserveUseListOrder = false);
2025 void printMDNodeBody(const MDNode *MD);
2026 void printNamedMDNode(const NamedMDNode *NMD);
2028 void printModule(const Module *M);
2030 void writeOperand(const Value *Op, bool PrintType);
2031 void writeParamOperand(const Value *Operand, AttributeSet Attrs,unsigned Idx);
2032 void writeAtomic(AtomicOrdering Ordering, SynchronizationScope SynchScope);
2033 void writeAtomicCmpXchg(AtomicOrdering SuccessOrdering,
2034 AtomicOrdering FailureOrdering,
2035 SynchronizationScope SynchScope);
2037 void writeAllMDNodes();
2038 void writeMDNode(unsigned Slot, const MDNode *Node);
2039 void writeAllAttributeGroups();
2041 void printTypeIdentities();
2042 void printGlobal(const GlobalVariable *GV);
2043 void printAlias(const GlobalAlias *GV);
2044 void printComdat(const Comdat *C);
2045 void printFunction(const Function *F);
2046 void printArgument(const Argument *FA, AttributeSet Attrs, unsigned Idx);
2047 void printBasicBlock(const BasicBlock *BB);
2048 void printInstructionLine(const Instruction &I);
2049 void printInstruction(const Instruction &I);
2051 void printUseListOrder(const UseListOrder &Order);
2052 void printUseLists(const Function *F);
2057 /// \brief Print out metadata attachments.
2058 void printMetadataAttachments(
2059 const SmallVectorImpl<std::pair<unsigned, MDNode *>> &MDs,
2060 StringRef Separator);
2062 // printInfoComment - Print a little comment after the instruction indicating
2063 // which slot it occupies.
2064 void printInfoComment(const Value &V);
2066 // printGCRelocateComment - print comment after call to the gc.relocate
2067 // intrinsic indicating base and derived pointer names.
2068 void printGCRelocateComment(const Value &V);
2072 void AssemblyWriter::init() {
2075 TypePrinter.incorporateTypes(*TheModule);
2076 for (const Function &F : *TheModule)
2077 if (const Comdat *C = F.getComdat())
2079 for (const GlobalVariable &GV : TheModule->globals())
2080 if (const Comdat *C = GV.getComdat())
2084 AssemblyWriter::AssemblyWriter(formatted_raw_ostream &o, SlotTracker &Mac,
2085 const Module *M, AssemblyAnnotationWriter *AAW,
2086 bool ShouldPreserveUseListOrder)
2087 : Out(o), TheModule(M), Machine(Mac), AnnotationWriter(AAW),
2088 ShouldPreserveUseListOrder(ShouldPreserveUseListOrder) {
2092 AssemblyWriter::AssemblyWriter(formatted_raw_ostream &o, const Module *M,
2093 AssemblyAnnotationWriter *AAW,
2094 bool ShouldPreserveUseListOrder)
2095 : Out(o), TheModule(M), SlotTrackerStorage(createSlotTracker(M)),
2096 Machine(*SlotTrackerStorage), AnnotationWriter(AAW),
2097 ShouldPreserveUseListOrder(ShouldPreserveUseListOrder) {
2101 void AssemblyWriter::writeOperand(const Value *Operand, bool PrintType) {
2103 Out << "<null operand!>";
2107 TypePrinter.print(Operand->getType(), Out);
2110 WriteAsOperandInternal(Out, Operand, &TypePrinter, &Machine, TheModule);
2113 void AssemblyWriter::writeAtomic(AtomicOrdering Ordering,
2114 SynchronizationScope SynchScope) {
2115 if (Ordering == NotAtomic)
2118 switch (SynchScope) {
2119 case SingleThread: Out << " singlethread"; break;
2120 case CrossThread: break;
2124 default: Out << " <bad ordering " << int(Ordering) << ">"; break;
2125 case Unordered: Out << " unordered"; break;
2126 case Monotonic: Out << " monotonic"; break;
2127 case Acquire: Out << " acquire"; break;
2128 case Release: Out << " release"; break;
2129 case AcquireRelease: Out << " acq_rel"; break;
2130 case SequentiallyConsistent: Out << " seq_cst"; break;
2134 void AssemblyWriter::writeAtomicCmpXchg(AtomicOrdering SuccessOrdering,
2135 AtomicOrdering FailureOrdering,
2136 SynchronizationScope SynchScope) {
2137 assert(SuccessOrdering != NotAtomic && FailureOrdering != NotAtomic);
2139 switch (SynchScope) {
2140 case SingleThread: Out << " singlethread"; break;
2141 case CrossThread: break;
2144 switch (SuccessOrdering) {
2145 default: Out << " <bad ordering " << int(SuccessOrdering) << ">"; break;
2146 case Unordered: Out << " unordered"; break;
2147 case Monotonic: Out << " monotonic"; break;
2148 case Acquire: Out << " acquire"; break;
2149 case Release: Out << " release"; break;
2150 case AcquireRelease: Out << " acq_rel"; break;
2151 case SequentiallyConsistent: Out << " seq_cst"; break;
2154 switch (FailureOrdering) {
2155 default: Out << " <bad ordering " << int(FailureOrdering) << ">"; break;
2156 case Unordered: Out << " unordered"; break;
2157 case Monotonic: Out << " monotonic"; break;
2158 case Acquire: Out << " acquire"; break;
2159 case Release: Out << " release"; break;
2160 case AcquireRelease: Out << " acq_rel"; break;
2161 case SequentiallyConsistent: Out << " seq_cst"; break;
2165 void AssemblyWriter::writeParamOperand(const Value *Operand,
2166 AttributeSet Attrs, unsigned Idx) {
2168 Out << "<null operand!>";
2173 TypePrinter.print(Operand->getType(), Out);
2174 // Print parameter attributes list
2175 if (Attrs.hasAttributes(Idx))
2176 Out << ' ' << Attrs.getAsString(Idx);
2178 // Print the operand
2179 WriteAsOperandInternal(Out, Operand, &TypePrinter, &Machine, TheModule);
2182 void AssemblyWriter::printModule(const Module *M) {
2183 Machine.initialize();
2185 if (ShouldPreserveUseListOrder)
2186 UseListOrders = predictUseListOrder(M);
2188 if (!M->getModuleIdentifier().empty() &&
2189 // Don't print the ID if it will start a new line (which would
2190 // require a comment char before it).
2191 M->getModuleIdentifier().find('\n') == std::string::npos)
2192 Out << "; ModuleID = '" << M->getModuleIdentifier() << "'\n";
2194 const std::string &DL = M->getDataLayoutStr();
2196 Out << "target datalayout = \"" << DL << "\"\n";
2197 if (!M->getTargetTriple().empty())
2198 Out << "target triple = \"" << M->getTargetTriple() << "\"\n";
2200 if (!M->getModuleInlineAsm().empty()) {
2203 // Split the string into lines, to make it easier to read the .ll file.
2204 StringRef Asm = M->getModuleInlineAsm();
2207 std::tie(Front, Asm) = Asm.split('\n');
2209 // We found a newline, print the portion of the asm string from the
2210 // last newline up to this newline.
2211 Out << "module asm \"";
2212 PrintEscapedString(Front, Out);
2214 } while (!Asm.empty());
2217 printTypeIdentities();
2219 // Output all comdats.
2220 if (!Comdats.empty())
2222 for (const Comdat *C : Comdats) {
2224 if (C != Comdats.back())
2228 // Output all globals.
2229 if (!M->global_empty()) Out << '\n';
2230 for (const GlobalVariable &GV : M->globals()) {
2231 printGlobal(&GV); Out << '\n';
2234 // Output all aliases.
2235 if (!M->alias_empty()) Out << "\n";
2236 for (const GlobalAlias &GA : M->aliases())
2239 // Output global use-lists.
2240 printUseLists(nullptr);
2242 // Output all of the functions.
2243 for (const Function &F : *M)
2245 assert(UseListOrders.empty() && "All use-lists should have been consumed");
2247 // Output all attribute groups.
2248 if (!Machine.as_empty()) {
2250 writeAllAttributeGroups();
2253 // Output named metadata.
2254 if (!M->named_metadata_empty()) Out << '\n';
2256 for (const NamedMDNode &Node : M->named_metadata())
2257 printNamedMDNode(&Node);
2260 if (!Machine.mdn_empty()) {
2266 static void printMetadataIdentifier(StringRef Name,
2267 formatted_raw_ostream &Out) {
2269 Out << "<empty name> ";
2271 if (isalpha(static_cast<unsigned char>(Name[0])) || Name[0] == '-' ||
2272 Name[0] == '$' || Name[0] == '.' || Name[0] == '_')
2275 Out << '\\' << hexdigit(Name[0] >> 4) << hexdigit(Name[0] & 0x0F);
2276 for (unsigned i = 1, e = Name.size(); i != e; ++i) {
2277 unsigned char C = Name[i];
2278 if (isalnum(static_cast<unsigned char>(C)) || C == '-' || C == '$' ||
2279 C == '.' || C == '_')
2282 Out << '\\' << hexdigit(C >> 4) << hexdigit(C & 0x0F);
2287 void AssemblyWriter::printNamedMDNode(const NamedMDNode *NMD) {
2289 printMetadataIdentifier(NMD->getName(), Out);
2291 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
2294 int Slot = Machine.getMetadataSlot(NMD->getOperand(i));
2303 static void PrintLinkage(GlobalValue::LinkageTypes LT,
2304 formatted_raw_ostream &Out) {
2306 case GlobalValue::ExternalLinkage: break;
2307 case GlobalValue::PrivateLinkage: Out << "private "; break;
2308 case GlobalValue::InternalLinkage: Out << "internal "; break;
2309 case GlobalValue::LinkOnceAnyLinkage: Out << "linkonce "; break;
2310 case GlobalValue::LinkOnceODRLinkage: Out << "linkonce_odr "; break;
2311 case GlobalValue::WeakAnyLinkage: Out << "weak "; break;
2312 case GlobalValue::WeakODRLinkage: Out << "weak_odr "; break;
2313 case GlobalValue::CommonLinkage: Out << "common "; break;
2314 case GlobalValue::AppendingLinkage: Out << "appending "; break;
2315 case GlobalValue::ExternalWeakLinkage: Out << "extern_weak "; break;
2316 case GlobalValue::AvailableExternallyLinkage:
2317 Out << "available_externally ";
2322 static void PrintVisibility(GlobalValue::VisibilityTypes Vis,
2323 formatted_raw_ostream &Out) {
2325 case GlobalValue::DefaultVisibility: break;
2326 case GlobalValue::HiddenVisibility: Out << "hidden "; break;
2327 case GlobalValue::ProtectedVisibility: Out << "protected "; break;
2331 static void PrintDLLStorageClass(GlobalValue::DLLStorageClassTypes SCT,
2332 formatted_raw_ostream &Out) {
2334 case GlobalValue::DefaultStorageClass: break;
2335 case GlobalValue::DLLImportStorageClass: Out << "dllimport "; break;
2336 case GlobalValue::DLLExportStorageClass: Out << "dllexport "; break;
2340 static void PrintThreadLocalModel(GlobalVariable::ThreadLocalMode TLM,
2341 formatted_raw_ostream &Out) {
2343 case GlobalVariable::NotThreadLocal:
2345 case GlobalVariable::GeneralDynamicTLSModel:
2346 Out << "thread_local ";
2348 case GlobalVariable::LocalDynamicTLSModel:
2349 Out << "thread_local(localdynamic) ";
2351 case GlobalVariable::InitialExecTLSModel:
2352 Out << "thread_local(initialexec) ";
2354 case GlobalVariable::LocalExecTLSModel:
2355 Out << "thread_local(localexec) ";
2360 static void maybePrintComdat(formatted_raw_ostream &Out,
2361 const GlobalObject &GO) {
2362 const Comdat *C = GO.getComdat();
2366 if (isa<GlobalVariable>(GO))
2370 if (GO.getName() == C->getName())
2374 PrintLLVMName(Out, C->getName(), ComdatPrefix);
2378 void AssemblyWriter::printGlobal(const GlobalVariable *GV) {
2379 if (GV->isMaterializable())
2380 Out << "; Materializable\n";
2382 WriteAsOperandInternal(Out, GV, &TypePrinter, &Machine, GV->getParent());
2385 if (!GV->hasInitializer() && GV->hasExternalLinkage())
2388 PrintLinkage(GV->getLinkage(), Out);
2389 PrintVisibility(GV->getVisibility(), Out);
2390 PrintDLLStorageClass(GV->getDLLStorageClass(), Out);
2391 PrintThreadLocalModel(GV->getThreadLocalMode(), Out);
2392 if (GV->hasUnnamedAddr())
2393 Out << "unnamed_addr ";
2395 if (unsigned AddressSpace = GV->getType()->getAddressSpace())
2396 Out << "addrspace(" << AddressSpace << ") ";
2397 if (GV->isExternallyInitialized()) Out << "externally_initialized ";
2398 Out << (GV->isConstant() ? "constant " : "global ");
2399 TypePrinter.print(GV->getType()->getElementType(), Out);
2401 if (GV->hasInitializer()) {
2403 writeOperand(GV->getInitializer(), false);
2406 if (GV->hasSection()) {
2407 Out << ", section \"";
2408 PrintEscapedString(GV->getSection(), Out);
2411 maybePrintComdat(Out, *GV);
2412 if (GV->getAlignment())
2413 Out << ", align " << GV->getAlignment();
2415 printInfoComment(*GV);
2418 void AssemblyWriter::printAlias(const GlobalAlias *GA) {
2419 if (GA->isMaterializable())
2420 Out << "; Materializable\n";
2422 WriteAsOperandInternal(Out, GA, &TypePrinter, &Machine, GA->getParent());
2425 PrintLinkage(GA->getLinkage(), Out);
2426 PrintVisibility(GA->getVisibility(), Out);
2427 PrintDLLStorageClass(GA->getDLLStorageClass(), Out);
2428 PrintThreadLocalModel(GA->getThreadLocalMode(), Out);
2429 if (GA->hasUnnamedAddr())
2430 Out << "unnamed_addr ";
2434 const Constant *Aliasee = GA->getAliasee();
2437 TypePrinter.print(GA->getType(), Out);
2438 Out << " <<NULL ALIASEE>>";
2440 writeOperand(Aliasee, !isa<ConstantExpr>(Aliasee));
2443 printInfoComment(*GA);
2447 void AssemblyWriter::printComdat(const Comdat *C) {
2451 void AssemblyWriter::printTypeIdentities() {
2452 if (TypePrinter.NumberedTypes.empty() &&
2453 TypePrinter.NamedTypes.empty())
2458 // We know all the numbers that each type is used and we know that it is a
2459 // dense assignment. Convert the map to an index table.
2460 std::vector<StructType*> NumberedTypes(TypePrinter.NumberedTypes.size());
2461 for (DenseMap<StructType*, unsigned>::iterator I =
2462 TypePrinter.NumberedTypes.begin(), E = TypePrinter.NumberedTypes.end();
2464 assert(I->second < NumberedTypes.size() && "Didn't get a dense numbering?");
2465 NumberedTypes[I->second] = I->first;
2468 // Emit all numbered types.
2469 for (unsigned i = 0, e = NumberedTypes.size(); i != e; ++i) {
2470 Out << '%' << i << " = type ";
2472 // Make sure we print out at least one level of the type structure, so
2473 // that we do not get %2 = type %2
2474 TypePrinter.printStructBody(NumberedTypes[i], Out);
2478 for (unsigned i = 0, e = TypePrinter.NamedTypes.size(); i != e; ++i) {
2479 PrintLLVMName(Out, TypePrinter.NamedTypes[i]->getName(), LocalPrefix);
2482 // Make sure we print out at least one level of the type structure, so
2483 // that we do not get %FILE = type %FILE
2484 TypePrinter.printStructBody(TypePrinter.NamedTypes[i], Out);
2489 /// printFunction - Print all aspects of a function.
2491 void AssemblyWriter::printFunction(const Function *F) {
2492 // Print out the return type and name.
2495 if (AnnotationWriter) AnnotationWriter->emitFunctionAnnot(F, Out);
2497 if (F->isMaterializable())
2498 Out << "; Materializable\n";
2500 const AttributeSet &Attrs = F->getAttributes();
2501 if (Attrs.hasAttributes(AttributeSet::FunctionIndex)) {
2502 AttributeSet AS = Attrs.getFnAttributes();
2503 std::string AttrStr;
2506 for (unsigned E = AS.getNumSlots(); Idx != E; ++Idx)
2507 if (AS.getSlotIndex(Idx) == AttributeSet::FunctionIndex)
2510 for (AttributeSet::iterator I = AS.begin(Idx), E = AS.end(Idx);
2512 Attribute Attr = *I;
2513 if (!Attr.isStringAttribute()) {
2514 if (!AttrStr.empty()) AttrStr += ' ';
2515 AttrStr += Attr.getAsString();
2519 if (!AttrStr.empty())
2520 Out << "; Function Attrs: " << AttrStr << '\n';
2523 if (F->isDeclaration())
2528 PrintLinkage(F->getLinkage(), Out);
2529 PrintVisibility(F->getVisibility(), Out);
2530 PrintDLLStorageClass(F->getDLLStorageClass(), Out);
2532 // Print the calling convention.
2533 if (F->getCallingConv() != CallingConv::C) {
2534 PrintCallingConv(F->getCallingConv(), Out);
2538 FunctionType *FT = F->getFunctionType();
2539 if (Attrs.hasAttributes(AttributeSet::ReturnIndex))
2540 Out << Attrs.getAsString(AttributeSet::ReturnIndex) << ' ';
2541 TypePrinter.print(F->getReturnType(), Out);
2543 WriteAsOperandInternal(Out, F, &TypePrinter, &Machine, F->getParent());
2545 Machine.incorporateFunction(F);
2547 // Loop over the arguments, printing them...
2550 if (!F->isDeclaration()) {
2551 // If this isn't a declaration, print the argument names as well.
2552 for (Function::const_arg_iterator I = F->arg_begin(), E = F->arg_end();
2554 // Insert commas as we go... the first arg doesn't get a comma
2555 if (I != F->arg_begin()) Out << ", ";
2556 printArgument(I, Attrs, Idx);
2560 // Otherwise, print the types from the function type.
2561 for (unsigned i = 0, e = FT->getNumParams(); i != e; ++i) {
2562 // Insert commas as we go... the first arg doesn't get a comma
2566 TypePrinter.print(FT->getParamType(i), Out);
2568 if (Attrs.hasAttributes(i+1))
2569 Out << ' ' << Attrs.getAsString(i+1);
2573 // Finish printing arguments...
2574 if (FT->isVarArg()) {
2575 if (FT->getNumParams()) Out << ", ";
2576 Out << "..."; // Output varargs portion of signature!
2579 if (F->hasUnnamedAddr())
2580 Out << " unnamed_addr";
2581 if (Attrs.hasAttributes(AttributeSet::FunctionIndex))
2582 Out << " #" << Machine.getAttributeGroupSlot(Attrs.getFnAttributes());
2583 if (F->hasSection()) {
2584 Out << " section \"";
2585 PrintEscapedString(F->getSection(), Out);
2588 maybePrintComdat(Out, *F);
2589 if (F->getAlignment())
2590 Out << " align " << F->getAlignment();
2592 Out << " gc \"" << F->getGC() << '"';
2593 if (F->hasPrefixData()) {
2595 writeOperand(F->getPrefixData(), true);
2597 if (F->hasPrologueData()) {
2598 Out << " prologue ";
2599 writeOperand(F->getPrologueData(), true);
2601 if (F->hasPersonalityFn()) {
2602 Out << " personality ";
2603 writeOperand(F->getPersonalityFn(), /*PrintType=*/true);
2606 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
2607 F->getAllMetadata(MDs);
2608 printMetadataAttachments(MDs, " ");
2610 if (F->isDeclaration()) {
2614 // Output all of the function's basic blocks.
2615 for (Function::const_iterator I = F->begin(), E = F->end(); I != E; ++I)
2618 // Output the function's use-lists.
2624 Machine.purgeFunction();
2627 /// printArgument - This member is called for every argument that is passed into
2628 /// the function. Simply print it out
2630 void AssemblyWriter::printArgument(const Argument *Arg,
2631 AttributeSet Attrs, unsigned Idx) {
2633 TypePrinter.print(Arg->getType(), Out);
2635 // Output parameter attributes list
2636 if (Attrs.hasAttributes(Idx))
2637 Out << ' ' << Attrs.getAsString(Idx);
2639 // Output name, if available...
2640 if (Arg->hasName()) {
2642 PrintLLVMName(Out, Arg);
2646 /// printBasicBlock - This member is called for each basic block in a method.
2648 void AssemblyWriter::printBasicBlock(const BasicBlock *BB) {
2649 if (BB->hasName()) { // Print out the label if it exists...
2651 PrintLLVMName(Out, BB->getName(), LabelPrefix);
2653 } else if (!BB->use_empty()) { // Don't print block # of no uses...
2654 Out << "\n; <label>:";
2655 int Slot = Machine.getLocalSlot(BB);
2662 if (!BB->getParent()) {
2663 Out.PadToColumn(50);
2664 Out << "; Error: Block without parent!";
2665 } else if (BB != &BB->getParent()->getEntryBlock()) { // Not the entry block?
2666 // Output predecessors for the block.
2667 Out.PadToColumn(50);
2669 const_pred_iterator PI = pred_begin(BB), PE = pred_end(BB);
2672 Out << " No predecessors!";
2675 writeOperand(*PI, false);
2676 for (++PI; PI != PE; ++PI) {
2678 writeOperand(*PI, false);
2685 if (AnnotationWriter) AnnotationWriter->emitBasicBlockStartAnnot(BB, Out);
2687 // Output all of the instructions in the basic block...
2688 for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I != E; ++I) {
2689 printInstructionLine(*I);
2692 if (AnnotationWriter) AnnotationWriter->emitBasicBlockEndAnnot(BB, Out);
2695 /// printInstructionLine - Print an instruction and a newline character.
2696 void AssemblyWriter::printInstructionLine(const Instruction &I) {
2697 printInstruction(I);
2701 /// printGCRelocateComment - print comment after call to the gc.relocate
2702 /// intrinsic indicating base and derived pointer names.
2703 void AssemblyWriter::printGCRelocateComment(const Value &V) {
2704 assert(isGCRelocate(&V));
2705 GCRelocateOperands GCOps(cast<Instruction>(&V));
2708 writeOperand(GCOps.getBasePtr(), false);
2710 writeOperand(GCOps.getDerivedPtr(), false);
2714 /// printInfoComment - Print a little comment after the instruction indicating
2715 /// which slot it occupies.
2717 void AssemblyWriter::printInfoComment(const Value &V) {
2718 if (isGCRelocate(&V))
2719 printGCRelocateComment(V);
2721 if (AnnotationWriter)
2722 AnnotationWriter->printInfoComment(V, Out);
2725 // This member is called for each Instruction in a function..
2726 void AssemblyWriter::printInstruction(const Instruction &I) {
2727 if (AnnotationWriter) AnnotationWriter->emitInstructionAnnot(&I, Out);
2729 // Print out indentation for an instruction.
2732 // Print out name if it exists...
2734 PrintLLVMName(Out, &I);
2736 } else if (!I.getType()->isVoidTy()) {
2737 // Print out the def slot taken.
2738 int SlotNum = Machine.getLocalSlot(&I);
2740 Out << "<badref> = ";
2742 Out << '%' << SlotNum << " = ";
2745 if (const CallInst *CI = dyn_cast<CallInst>(&I)) {
2746 if (CI->isMustTailCall())
2748 else if (CI->isTailCall())
2752 // Print out the opcode...
2753 Out << I.getOpcodeName();
2755 // If this is an atomic load or store, print out the atomic marker.
2756 if ((isa<LoadInst>(I) && cast<LoadInst>(I).isAtomic()) ||
2757 (isa<StoreInst>(I) && cast<StoreInst>(I).isAtomic()))
2760 if (isa<AtomicCmpXchgInst>(I) && cast<AtomicCmpXchgInst>(I).isWeak())
2763 // If this is a volatile operation, print out the volatile marker.
2764 if ((isa<LoadInst>(I) && cast<LoadInst>(I).isVolatile()) ||
2765 (isa<StoreInst>(I) && cast<StoreInst>(I).isVolatile()) ||
2766 (isa<AtomicCmpXchgInst>(I) && cast<AtomicCmpXchgInst>(I).isVolatile()) ||
2767 (isa<AtomicRMWInst>(I) && cast<AtomicRMWInst>(I).isVolatile()))
2770 // Print out optimization information.
2771 WriteOptimizationInfo(Out, &I);
2773 // Print out the compare instruction predicates
2774 if (const CmpInst *CI = dyn_cast<CmpInst>(&I))
2775 Out << ' ' << getPredicateText(CI->getPredicate());
2777 // Print out the atomicrmw operation
2778 if (const AtomicRMWInst *RMWI = dyn_cast<AtomicRMWInst>(&I))
2779 writeAtomicRMWOperation(Out, RMWI->getOperation());
2781 // Print out the type of the operands...
2782 const Value *Operand = I.getNumOperands() ? I.getOperand(0) : nullptr;
2784 // Special case conditional branches to swizzle the condition out to the front
2785 if (isa<BranchInst>(I) && cast<BranchInst>(I).isConditional()) {
2786 const BranchInst &BI(cast<BranchInst>(I));
2788 writeOperand(BI.getCondition(), true);
2790 writeOperand(BI.getSuccessor(0), true);
2792 writeOperand(BI.getSuccessor(1), true);
2794 } else if (isa<SwitchInst>(I)) {
2795 const SwitchInst& SI(cast<SwitchInst>(I));
2796 // Special case switch instruction to get formatting nice and correct.
2798 writeOperand(SI.getCondition(), true);
2800 writeOperand(SI.getDefaultDest(), true);
2802 for (SwitchInst::ConstCaseIt i = SI.case_begin(), e = SI.case_end();
2805 writeOperand(i.getCaseValue(), true);
2807 writeOperand(i.getCaseSuccessor(), true);
2810 } else if (isa<IndirectBrInst>(I)) {
2811 // Special case indirectbr instruction to get formatting nice and correct.
2813 writeOperand(Operand, true);
2816 for (unsigned i = 1, e = I.getNumOperands(); i != e; ++i) {
2819 writeOperand(I.getOperand(i), true);
2822 } else if (const PHINode *PN = dyn_cast<PHINode>(&I)) {
2824 TypePrinter.print(I.getType(), Out);
2827 for (unsigned op = 0, Eop = PN->getNumIncomingValues(); op < Eop; ++op) {
2828 if (op) Out << ", ";
2830 writeOperand(PN->getIncomingValue(op), false); Out << ", ";
2831 writeOperand(PN->getIncomingBlock(op), false); Out << " ]";
2833 } else if (const ExtractValueInst *EVI = dyn_cast<ExtractValueInst>(&I)) {
2835 writeOperand(I.getOperand(0), true);
2836 for (const unsigned *i = EVI->idx_begin(), *e = EVI->idx_end(); i != e; ++i)
2838 } else if (const InsertValueInst *IVI = dyn_cast<InsertValueInst>(&I)) {
2840 writeOperand(I.getOperand(0), true); Out << ", ";
2841 writeOperand(I.getOperand(1), true);
2842 for (const unsigned *i = IVI->idx_begin(), *e = IVI->idx_end(); i != e; ++i)
2844 } else if (const LandingPadInst *LPI = dyn_cast<LandingPadInst>(&I)) {
2846 TypePrinter.print(I.getType(), Out);
2847 if (LPI->isCleanup() || LPI->getNumClauses() != 0)
2850 if (LPI->isCleanup())
2853 for (unsigned i = 0, e = LPI->getNumClauses(); i != e; ++i) {
2854 if (i != 0 || LPI->isCleanup()) Out << "\n";
2855 if (LPI->isCatch(i))
2860 writeOperand(LPI->getClause(i), true);
2862 } else if (const auto *CPI = dyn_cast<CatchPadInst>(&I)) {
2864 for (unsigned Op = 0, NumOps = CPI->getNumArgOperands(); Op < NumOps;
2868 writeOperand(CPI->getArgOperand(Op), /*PrintType=*/true);
2871 writeOperand(CPI->getNormalDest(), /*PrintType=*/true);
2873 writeOperand(CPI->getUnwindDest(), /*PrintType=*/true);
2874 } else if (const auto *TPI = dyn_cast<TerminatePadInst>(&I)) {
2876 for (unsigned Op = 0, NumOps = TPI->getNumArgOperands(); Op < NumOps;
2880 writeOperand(TPI->getArgOperand(Op), /*PrintType=*/true);
2883 if (TPI->hasUnwindDest())
2884 writeOperand(TPI->getUnwindDest(), /*PrintType=*/true);
2887 } else if (const auto *CPI = dyn_cast<CleanupPadInst>(&I)) {
2889 for (unsigned Op = 0, NumOps = CPI->getNumOperands(); Op < NumOps; ++Op) {
2892 writeOperand(CPI->getOperand(Op), /*PrintType=*/true);
2895 } else if (isa<ReturnInst>(I) && !Operand) {
2897 } else if (const auto *CRI = dyn_cast<CatchReturnInst>(&I)) {
2899 writeOperand(CRI->getCatchPad(), /*PrintType=*/false);
2902 writeOperand(CRI->getSuccessor(), /*PrintType=*/true);
2903 } else if (const auto *CRI = dyn_cast<CleanupReturnInst>(&I)) {
2905 writeOperand(CRI->getCleanupPad(), /*PrintType=*/false);
2908 if (CRI->hasUnwindDest())
2909 writeOperand(CRI->getUnwindDest(), /*PrintType=*/true);
2912 } else if (const auto *CEPI = dyn_cast<CatchEndPadInst>(&I)) {
2914 if (CEPI->hasUnwindDest())
2915 writeOperand(CEPI->getUnwindDest(), /*PrintType=*/true);
2918 } else if (const CallInst *CI = dyn_cast<CallInst>(&I)) {
2919 // Print the calling convention being used.
2920 if (CI->getCallingConv() != CallingConv::C) {
2922 PrintCallingConv(CI->getCallingConv(), Out);
2925 Operand = CI->getCalledValue();
2926 FunctionType *FTy = cast<FunctionType>(CI->getFunctionType());
2927 Type *RetTy = FTy->getReturnType();
2928 const AttributeSet &PAL = CI->getAttributes();
2930 if (PAL.hasAttributes(AttributeSet::ReturnIndex))
2931 Out << ' ' << PAL.getAsString(AttributeSet::ReturnIndex);
2933 // If possible, print out the short form of the call instruction. We can
2934 // only do this if the first argument is a pointer to a nonvararg function,
2935 // and if the return type is not a pointer to a function.
2938 TypePrinter.print(FTy->isVarArg() ? FTy : RetTy, Out);
2940 writeOperand(Operand, false);
2942 for (unsigned op = 0, Eop = CI->getNumArgOperands(); op < Eop; ++op) {
2945 writeParamOperand(CI->getArgOperand(op), PAL, op + 1);
2948 // Emit an ellipsis if this is a musttail call in a vararg function. This
2949 // is only to aid readability, musttail calls forward varargs by default.
2950 if (CI->isMustTailCall() && CI->getParent() &&
2951 CI->getParent()->getParent() &&
2952 CI->getParent()->getParent()->isVarArg())
2956 if (PAL.hasAttributes(AttributeSet::FunctionIndex))
2957 Out << " #" << Machine.getAttributeGroupSlot(PAL.getFnAttributes());
2958 } else if (const InvokeInst *II = dyn_cast<InvokeInst>(&I)) {
2959 Operand = II->getCalledValue();
2960 FunctionType *FTy = cast<FunctionType>(II->getFunctionType());
2961 Type *RetTy = FTy->getReturnType();
2962 const AttributeSet &PAL = II->getAttributes();
2964 // Print the calling convention being used.
2965 if (II->getCallingConv() != CallingConv::C) {
2967 PrintCallingConv(II->getCallingConv(), Out);
2970 if (PAL.hasAttributes(AttributeSet::ReturnIndex))
2971 Out << ' ' << PAL.getAsString(AttributeSet::ReturnIndex);
2973 // If possible, print out the short form of the invoke instruction. We can
2974 // only do this if the first argument is a pointer to a nonvararg function,
2975 // and if the return type is not a pointer to a function.
2978 TypePrinter.print(FTy->isVarArg() ? FTy : RetTy, Out);
2980 writeOperand(Operand, false);
2982 for (unsigned op = 0, Eop = II->getNumArgOperands(); op < Eop; ++op) {
2985 writeParamOperand(II->getArgOperand(op), PAL, op + 1);
2989 if (PAL.hasAttributes(AttributeSet::FunctionIndex))
2990 Out << " #" << Machine.getAttributeGroupSlot(PAL.getFnAttributes());
2993 writeOperand(II->getNormalDest(), true);
2995 writeOperand(II->getUnwindDest(), true);
2997 } else if (const AllocaInst *AI = dyn_cast<AllocaInst>(&I)) {
2999 if (AI->isUsedWithInAlloca())
3001 TypePrinter.print(AI->getAllocatedType(), Out);
3003 // Explicitly write the array size if the code is broken, if it's an array
3004 // allocation, or if the type is not canonical for scalar allocations. The
3005 // latter case prevents the type from mutating when round-tripping through
3007 if (!AI->getArraySize() || AI->isArrayAllocation() ||
3008 !AI->getArraySize()->getType()->isIntegerTy(32)) {
3010 writeOperand(AI->getArraySize(), true);
3012 if (AI->getAlignment()) {
3013 Out << ", align " << AI->getAlignment();
3015 } else if (isa<CastInst>(I)) {
3018 writeOperand(Operand, true); // Work with broken code
3021 TypePrinter.print(I.getType(), Out);
3022 } else if (isa<VAArgInst>(I)) {
3025 writeOperand(Operand, true); // Work with broken code
3028 TypePrinter.print(I.getType(), Out);
3029 } else if (Operand) { // Print the normal way.
3030 if (const auto *GEP = dyn_cast<GetElementPtrInst>(&I)) {
3032 TypePrinter.print(GEP->getSourceElementType(), Out);
3034 } else if (const auto *LI = dyn_cast<LoadInst>(&I)) {
3036 TypePrinter.print(LI->getType(), Out);
3040 // PrintAllTypes - Instructions who have operands of all the same type
3041 // omit the type from all but the first operand. If the instruction has
3042 // different type operands (for example br), then they are all printed.
3043 bool PrintAllTypes = false;
3044 Type *TheType = Operand->getType();
3046 // Select, Store and ShuffleVector always print all types.
3047 if (isa<SelectInst>(I) || isa<StoreInst>(I) || isa<ShuffleVectorInst>(I)
3048 || isa<ReturnInst>(I)) {
3049 PrintAllTypes = true;
3051 for (unsigned i = 1, E = I.getNumOperands(); i != E; ++i) {
3052 Operand = I.getOperand(i);
3053 // note that Operand shouldn't be null, but the test helps make dump()
3054 // more tolerant of malformed IR
3055 if (Operand && Operand->getType() != TheType) {
3056 PrintAllTypes = true; // We have differing types! Print them all!
3062 if (!PrintAllTypes) {
3064 TypePrinter.print(TheType, Out);
3068 for (unsigned i = 0, E = I.getNumOperands(); i != E; ++i) {
3070 writeOperand(I.getOperand(i), PrintAllTypes);
3074 // Print atomic ordering/alignment for memory operations
3075 if (const LoadInst *LI = dyn_cast<LoadInst>(&I)) {
3077 writeAtomic(LI->getOrdering(), LI->getSynchScope());
3078 if (LI->getAlignment())
3079 Out << ", align " << LI->getAlignment();
3080 } else if (const StoreInst *SI = dyn_cast<StoreInst>(&I)) {
3082 writeAtomic(SI->getOrdering(), SI->getSynchScope());
3083 if (SI->getAlignment())
3084 Out << ", align " << SI->getAlignment();
3085 } else if (const AtomicCmpXchgInst *CXI = dyn_cast<AtomicCmpXchgInst>(&I)) {
3086 writeAtomicCmpXchg(CXI->getSuccessOrdering(), CXI->getFailureOrdering(),
3087 CXI->getSynchScope());
3088 } else if (const AtomicRMWInst *RMWI = dyn_cast<AtomicRMWInst>(&I)) {
3089 writeAtomic(RMWI->getOrdering(), RMWI->getSynchScope());
3090 } else if (const FenceInst *FI = dyn_cast<FenceInst>(&I)) {
3091 writeAtomic(FI->getOrdering(), FI->getSynchScope());
3094 // Print Metadata info.
3095 SmallVector<std::pair<unsigned, MDNode *>, 4> InstMD;
3096 I.getAllMetadata(InstMD);
3097 printMetadataAttachments(InstMD, ", ");
3099 // Print a nice comment.
3100 printInfoComment(I);
3103 void AssemblyWriter::printMetadataAttachments(
3104 const SmallVectorImpl<std::pair<unsigned, MDNode *>> &MDs,
3105 StringRef Separator) {
3109 if (MDNames.empty())
3110 TheModule->getMDKindNames(MDNames);
3112 for (const auto &I : MDs) {
3113 unsigned Kind = I.first;
3115 if (Kind < MDNames.size()) {
3117 printMetadataIdentifier(MDNames[Kind], Out);
3119 Out << "!<unknown kind #" << Kind << ">";
3121 WriteAsOperandInternal(Out, I.second, &TypePrinter, &Machine, TheModule);
3125 void AssemblyWriter::writeMDNode(unsigned Slot, const MDNode *Node) {
3126 Out << '!' << Slot << " = ";
3127 printMDNodeBody(Node);
3131 void AssemblyWriter::writeAllMDNodes() {
3132 SmallVector<const MDNode *, 16> Nodes;
3133 Nodes.resize(Machine.mdn_size());
3134 for (SlotTracker::mdn_iterator I = Machine.mdn_begin(), E = Machine.mdn_end();
3136 Nodes[I->second] = cast<MDNode>(I->first);
3138 for (unsigned i = 0, e = Nodes.size(); i != e; ++i) {
3139 writeMDNode(i, Nodes[i]);
3143 void AssemblyWriter::printMDNodeBody(const MDNode *Node) {
3144 WriteMDNodeBodyInternal(Out, Node, &TypePrinter, &Machine, TheModule);
3147 void AssemblyWriter::writeAllAttributeGroups() {
3148 std::vector<std::pair<AttributeSet, unsigned> > asVec;
3149 asVec.resize(Machine.as_size());
3151 for (SlotTracker::as_iterator I = Machine.as_begin(), E = Machine.as_end();
3153 asVec[I->second] = *I;
3155 for (std::vector<std::pair<AttributeSet, unsigned> >::iterator
3156 I = asVec.begin(), E = asVec.end(); I != E; ++I)
3157 Out << "attributes #" << I->second << " = { "
3158 << I->first.getAsString(AttributeSet::FunctionIndex, true) << " }\n";
3161 void AssemblyWriter::printUseListOrder(const UseListOrder &Order) {
3162 bool IsInFunction = Machine.getFunction();
3166 Out << "uselistorder";
3167 if (const BasicBlock *BB =
3168 IsInFunction ? nullptr : dyn_cast<BasicBlock>(Order.V)) {
3170 writeOperand(BB->getParent(), false);
3172 writeOperand(BB, false);
3175 writeOperand(Order.V, true);
3179 assert(Order.Shuffle.size() >= 2 && "Shuffle too small");
3180 Out << Order.Shuffle[0];
3181 for (unsigned I = 1, E = Order.Shuffle.size(); I != E; ++I)
3182 Out << ", " << Order.Shuffle[I];
3186 void AssemblyWriter::printUseLists(const Function *F) {
3188 [&]() { return !UseListOrders.empty() && UseListOrders.back().F == F; };
3193 Out << "\n; uselistorder directives\n";
3195 printUseListOrder(UseListOrders.back());
3196 UseListOrders.pop_back();
3200 //===----------------------------------------------------------------------===//
3201 // External Interface declarations
3202 //===----------------------------------------------------------------------===//
3204 void Function::print(raw_ostream &ROS, AssemblyAnnotationWriter *AAW) const {
3205 SlotTracker SlotTable(this->getParent());
3206 formatted_raw_ostream OS(ROS);
3207 AssemblyWriter W(OS, SlotTable, this->getParent(), AAW);
3208 W.printFunction(this);
3211 void Module::print(raw_ostream &ROS, AssemblyAnnotationWriter *AAW,
3212 bool ShouldPreserveUseListOrder) const {
3213 SlotTracker SlotTable(this);
3214 formatted_raw_ostream OS(ROS);
3215 AssemblyWriter W(OS, SlotTable, this, AAW, ShouldPreserveUseListOrder);
3216 W.printModule(this);
3219 void NamedMDNode::print(raw_ostream &ROS) const {
3220 SlotTracker SlotTable(getParent());
3221 formatted_raw_ostream OS(ROS);
3222 AssemblyWriter W(OS, SlotTable, getParent(), nullptr);
3223 W.printNamedMDNode(this);
3226 void Comdat::print(raw_ostream &ROS) const {
3227 PrintLLVMName(ROS, getName(), ComdatPrefix);
3228 ROS << " = comdat ";
3230 switch (getSelectionKind()) {
3234 case Comdat::ExactMatch:
3235 ROS << "exactmatch";
3237 case Comdat::Largest:
3240 case Comdat::NoDuplicates:
3241 ROS << "noduplicates";
3243 case Comdat::SameSize:
3251 void Type::print(raw_ostream &OS) const {
3253 TP.print(const_cast<Type*>(this), OS);
3255 // If the type is a named struct type, print the body as well.
3256 if (StructType *STy = dyn_cast<StructType>(const_cast<Type*>(this)))
3257 if (!STy->isLiteral()) {
3259 TP.printStructBody(STy, OS);
3263 static bool isReferencingMDNode(const Instruction &I) {
3264 if (const auto *CI = dyn_cast<CallInst>(&I))
3265 if (Function *F = CI->getCalledFunction())
3266 if (F->isIntrinsic())
3267 for (auto &Op : I.operands())
3268 if (auto *V = dyn_cast_or_null<MetadataAsValue>(Op))
3269 if (isa<MDNode>(V->getMetadata()))
3274 void Value::print(raw_ostream &ROS) const {
3275 bool ShouldInitializeAllMetadata = false;
3276 if (auto *I = dyn_cast<Instruction>(this))
3277 ShouldInitializeAllMetadata = isReferencingMDNode(*I);
3278 else if (isa<Function>(this) || isa<MetadataAsValue>(this))
3279 ShouldInitializeAllMetadata = true;
3281 ModuleSlotTracker MST(getModuleFromVal(this), ShouldInitializeAllMetadata);
3285 void Value::print(raw_ostream &ROS, ModuleSlotTracker &MST) const {
3286 formatted_raw_ostream OS(ROS);
3287 SlotTracker EmptySlotTable(static_cast<const Module *>(nullptr));
3288 SlotTracker &SlotTable =
3289 MST.getMachine() ? *MST.getMachine() : EmptySlotTable;
3290 auto incorporateFunction = [&](const Function *F) {
3292 MST.incorporateFunction(*F);
3295 if (const Instruction *I = dyn_cast<Instruction>(this)) {
3296 incorporateFunction(I->getParent() ? I->getParent()->getParent() : nullptr);
3297 AssemblyWriter W(OS, SlotTable, getModuleFromVal(I), nullptr);
3298 W.printInstruction(*I);
3299 } else if (const BasicBlock *BB = dyn_cast<BasicBlock>(this)) {
3300 incorporateFunction(BB->getParent());
3301 AssemblyWriter W(OS, SlotTable, getModuleFromVal(BB), nullptr);
3302 W.printBasicBlock(BB);
3303 } else if (const GlobalValue *GV = dyn_cast<GlobalValue>(this)) {
3304 AssemblyWriter W(OS, SlotTable, GV->getParent(), nullptr);
3305 if (const GlobalVariable *V = dyn_cast<GlobalVariable>(GV))
3307 else if (const Function *F = dyn_cast<Function>(GV))
3310 W.printAlias(cast<GlobalAlias>(GV));
3311 } else if (const MetadataAsValue *V = dyn_cast<MetadataAsValue>(this)) {
3312 V->getMetadata()->print(ROS, MST, getModuleFromVal(V));
3313 } else if (const Constant *C = dyn_cast<Constant>(this)) {
3314 TypePrinting TypePrinter;
3315 TypePrinter.print(C->getType(), OS);
3317 WriteConstantInternal(OS, C, TypePrinter, MST.getMachine(), nullptr);
3318 } else if (isa<InlineAsm>(this) || isa<Argument>(this)) {
3319 this->printAsOperand(OS, /* PrintType */ true, MST);
3321 llvm_unreachable("Unknown value to print out!");
3325 /// Print without a type, skipping the TypePrinting object.
3327 /// \return \c true iff printing was successful.
3328 static bool printWithoutType(const Value &V, raw_ostream &O,
3329 SlotTracker *Machine, const Module *M) {
3330 if (V.hasName() || isa<GlobalValue>(V) ||
3331 (!isa<Constant>(V) && !isa<MetadataAsValue>(V))) {
3332 WriteAsOperandInternal(O, &V, nullptr, Machine, M);
3338 static void printAsOperandImpl(const Value &V, raw_ostream &O, bool PrintType,
3339 ModuleSlotTracker &MST) {
3340 TypePrinting TypePrinter;
3341 if (const Module *M = MST.getModule())
3342 TypePrinter.incorporateTypes(*M);
3344 TypePrinter.print(V.getType(), O);
3348 WriteAsOperandInternal(O, &V, &TypePrinter, MST.getMachine(),
3352 void Value::printAsOperand(raw_ostream &O, bool PrintType,
3353 const Module *M) const {
3355 M = getModuleFromVal(this);
3358 if (printWithoutType(*this, O, nullptr, M))
3361 SlotTracker Machine(
3362 M, /* ShouldInitializeAllMetadata */ isa<MetadataAsValue>(this));
3363 ModuleSlotTracker MST(Machine, M);
3364 printAsOperandImpl(*this, O, PrintType, MST);
3367 void Value::printAsOperand(raw_ostream &O, bool PrintType,
3368 ModuleSlotTracker &MST) const {
3370 if (printWithoutType(*this, O, MST.getMachine(), MST.getModule()))
3373 printAsOperandImpl(*this, O, PrintType, MST);
3376 static void printMetadataImpl(raw_ostream &ROS, const Metadata &MD,
3377 ModuleSlotTracker &MST, const Module *M,
3378 bool OnlyAsOperand) {
3379 formatted_raw_ostream OS(ROS);
3381 TypePrinting TypePrinter;
3383 TypePrinter.incorporateTypes(*M);
3385 WriteAsOperandInternal(OS, &MD, &TypePrinter, MST.getMachine(), M,
3386 /* FromValue */ true);
3388 auto *N = dyn_cast<MDNode>(&MD);
3389 if (OnlyAsOperand || !N)
3393 WriteMDNodeBodyInternal(OS, N, &TypePrinter, MST.getMachine(), M);
3396 void Metadata::printAsOperand(raw_ostream &OS, const Module *M) const {
3397 ModuleSlotTracker MST(M, isa<MDNode>(this));
3398 printMetadataImpl(OS, *this, MST, M, /* OnlyAsOperand */ true);
3401 void Metadata::printAsOperand(raw_ostream &OS, ModuleSlotTracker &MST,
3402 const Module *M) const {
3403 printMetadataImpl(OS, *this, MST, M, /* OnlyAsOperand */ true);
3406 void Metadata::print(raw_ostream &OS, const Module *M) const {
3407 ModuleSlotTracker MST(M, isa<MDNode>(this));
3408 printMetadataImpl(OS, *this, MST, M, /* OnlyAsOperand */ false);
3411 void Metadata::print(raw_ostream &OS, ModuleSlotTracker &MST,
3412 const Module *M) const {
3413 printMetadataImpl(OS, *this, MST, M, /* OnlyAsOperand */ false);
3416 // Value::dump - allow easy printing of Values from the debugger.
3418 void Value::dump() const { print(dbgs()); dbgs() << '\n'; }
3420 // Type::dump - allow easy printing of Types from the debugger.
3422 void Type::dump() const { print(dbgs()); dbgs() << '\n'; }
3424 // Module::dump() - Allow printing of Modules from the debugger.
3426 void Module::dump() const { print(dbgs(), nullptr); }
3428 // \brief Allow printing of Comdats from the debugger.
3430 void Comdat::dump() const { print(dbgs()); }
3432 // NamedMDNode::dump() - Allow printing of NamedMDNodes from the debugger.
3434 void NamedMDNode::dump() const { print(dbgs()); }
3437 void Metadata::dump() const { dump(nullptr); }
3440 void Metadata::dump(const Module *M) const {