2 //===-- AsmWriter.cpp - Printing LLVM as an assembly file -----------------===//
4 // The LLVM Compiler Infrastructure
6 // This file is distributed under the University of Illinois Open Source
7 // License. See LICENSE.TXT for details.
9 //===----------------------------------------------------------------------===//
11 // This library implements the functionality defined in llvm/IR/Writer.h
13 // Note that these routines must be extremely tolerant of various errors in the
14 // LLVM code, because it can be used for debugging transformations.
16 //===----------------------------------------------------------------------===//
18 #include "llvm/ADT/DenseMap.h"
19 #include "llvm/ADT/STLExtras.h"
20 #include "llvm/ADT/SetVector.h"
21 #include "llvm/ADT/SmallString.h"
22 #include "llvm/ADT/StringExtras.h"
23 #include "llvm/IR/AssemblyAnnotationWriter.h"
24 #include "llvm/IR/Attributes.h"
25 #include "llvm/IR/CFG.h"
26 #include "llvm/IR/CallingConv.h"
27 #include "llvm/IR/Constants.h"
28 #include "llvm/IR/DebugInfo.h"
29 #include "llvm/IR/DerivedTypes.h"
30 #include "llvm/IR/IRPrintingPasses.h"
31 #include "llvm/IR/InlineAsm.h"
32 #include "llvm/IR/IntrinsicInst.h"
33 #include "llvm/IR/LLVMContext.h"
34 #include "llvm/IR/Module.h"
35 #include "llvm/IR/ModuleSlotTracker.h"
36 #include "llvm/IR/Operator.h"
37 #include "llvm/IR/Statepoint.h"
38 #include "llvm/IR/TypeFinder.h"
39 #include "llvm/IR/UseListOrder.h"
40 #include "llvm/IR/ValueSymbolTable.h"
41 #include "llvm/Support/Debug.h"
42 #include "llvm/Support/Dwarf.h"
43 #include "llvm/Support/ErrorHandling.h"
44 #include "llvm/Support/Format.h"
45 #include "llvm/Support/FormattedStream.h"
46 #include "llvm/Support/MathExtras.h"
47 #include "llvm/Support/raw_ostream.h"
52 // Make virtual table appear in this compilation unit.
53 AssemblyAnnotationWriter::~AssemblyAnnotationWriter() {}
55 //===----------------------------------------------------------------------===//
57 //===----------------------------------------------------------------------===//
61 DenseMap<const Value *, std::pair<unsigned, bool>> IDs;
63 unsigned size() const { return IDs.size(); }
64 std::pair<unsigned, bool> &operator[](const Value *V) { return IDs[V]; }
65 std::pair<unsigned, bool> lookup(const Value *V) const {
68 void index(const Value *V) {
69 // Explicitly sequence get-size and insert-value operations to avoid UB.
70 unsigned ID = IDs.size() + 1;
76 static void orderValue(const Value *V, OrderMap &OM) {
77 if (OM.lookup(V).first)
80 if (const Constant *C = dyn_cast<Constant>(V))
81 if (C->getNumOperands() && !isa<GlobalValue>(C))
82 for (const Value *Op : C->operands())
83 if (!isa<BasicBlock>(Op) && !isa<GlobalValue>(Op))
86 // Note: we cannot cache this lookup above, since inserting into the map
87 // changes the map's size, and thus affects the other IDs.
91 static OrderMap orderModule(const Module *M) {
92 // This needs to match the order used by ValueEnumerator::ValueEnumerator()
93 // and ValueEnumerator::incorporateFunction().
96 for (const GlobalVariable &G : M->globals()) {
97 if (G.hasInitializer())
98 if (!isa<GlobalValue>(G.getInitializer()))
99 orderValue(G.getInitializer(), OM);
102 for (const GlobalAlias &A : M->aliases()) {
103 if (!isa<GlobalValue>(A.getAliasee()))
104 orderValue(A.getAliasee(), OM);
107 for (const GlobalIFunc &I : M->ifuncs()) {
108 if (!isa<GlobalValue>(I.getResolver()))
109 orderValue(I.getResolver(), OM);
112 for (const Function &F : *M) {
113 for (const Use &U : F.operands())
114 if (!isa<GlobalValue>(U.get()))
115 orderValue(U.get(), 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 GlobalIFunc &I : M->ifuncs())
260 predictValueUseListOrder(&I, nullptr, OM, Stack);
261 for (const GlobalVariable &G : M->globals())
262 if (G.hasInitializer())
263 predictValueUseListOrder(G.getInitializer(), nullptr, OM, Stack);
264 for (const GlobalAlias &A : M->aliases())
265 predictValueUseListOrder(A.getAliasee(), nullptr, OM, Stack);
266 for (const GlobalIFunc &I : M->ifuncs())
267 predictValueUseListOrder(I.getResolver(), nullptr, OM, Stack);
268 for (const Function &F : *M)
269 for (const Use &U : F.operands())
270 predictValueUseListOrder(U.get(), nullptr, OM, Stack);
275 static const Module *getModuleFromVal(const Value *V) {
276 if (const Argument *MA = dyn_cast<Argument>(V))
277 return MA->getParent() ? MA->getParent()->getParent() : nullptr;
279 if (const BasicBlock *BB = dyn_cast<BasicBlock>(V))
280 return BB->getParent() ? BB->getParent()->getParent() : nullptr;
282 if (const Instruction *I = dyn_cast<Instruction>(V)) {
283 const Function *M = I->getParent() ? I->getParent()->getParent() : nullptr;
284 return M ? M->getParent() : nullptr;
287 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V))
288 return GV->getParent();
290 if (const auto *MAV = dyn_cast<MetadataAsValue>(V)) {
291 for (const User *U : MAV->users())
292 if (isa<Instruction>(U))
293 if (const Module *M = getModuleFromVal(U))
301 static void PrintCallingConv(unsigned cc, raw_ostream &Out) {
303 default: Out << "cc" << cc; break;
304 case CallingConv::Fast: Out << "fastcc"; break;
305 case CallingConv::Cold: Out << "coldcc"; break;
306 case CallingConv::WebKit_JS: Out << "webkit_jscc"; break;
307 case CallingConv::AnyReg: Out << "anyregcc"; break;
308 case CallingConv::PreserveMost: Out << "preserve_mostcc"; break;
309 case CallingConv::PreserveAll: Out << "preserve_allcc"; break;
310 case CallingConv::CXX_FAST_TLS: Out << "cxx_fast_tlscc"; break;
311 case CallingConv::GHC: Out << "ghccc"; break;
312 case CallingConv::X86_StdCall: Out << "x86_stdcallcc"; break;
313 case CallingConv::X86_FastCall: Out << "x86_fastcallcc"; break;
314 case CallingConv::X86_ThisCall: Out << "x86_thiscallcc"; break;
315 case CallingConv::X86_RegCall: Out << "x86_regcallcc"; break;
316 case CallingConv::X86_VectorCall:Out << "x86_vectorcallcc"; break;
317 case CallingConv::Intel_OCL_BI: Out << "intel_ocl_bicc"; break;
318 case CallingConv::ARM_APCS: Out << "arm_apcscc"; break;
319 case CallingConv::ARM_AAPCS: Out << "arm_aapcscc"; break;
320 case CallingConv::ARM_AAPCS_VFP: Out << "arm_aapcs_vfpcc"; break;
321 case CallingConv::MSP430_INTR: Out << "msp430_intrcc"; break;
322 case CallingConv::AVR_INTR: Out << "avr_intrcc "; break;
323 case CallingConv::AVR_SIGNAL: Out << "avr_signalcc "; break;
324 case CallingConv::PTX_Kernel: Out << "ptx_kernel"; break;
325 case CallingConv::PTX_Device: Out << "ptx_device"; break;
326 case CallingConv::X86_64_SysV: Out << "x86_64_sysvcc"; break;
327 case CallingConv::X86_64_Win64: Out << "x86_64_win64cc"; break;
328 case CallingConv::SPIR_FUNC: Out << "spir_func"; break;
329 case CallingConv::SPIR_KERNEL: Out << "spir_kernel"; break;
330 case CallingConv::Swift: Out << "swiftcc"; break;
331 case CallingConv::X86_INTR: Out << "x86_intrcc"; break;
332 case CallingConv::HHVM: Out << "hhvmcc"; break;
333 case CallingConv::HHVM_C: Out << "hhvm_ccc"; break;
334 case CallingConv::AMDGPU_VS: Out << "amdgpu_vs"; break;
335 case CallingConv::AMDGPU_HS: Out << "amdgpu_hs"; break;
336 case CallingConv::AMDGPU_GS: Out << "amdgpu_gs"; break;
337 case CallingConv::AMDGPU_PS: Out << "amdgpu_ps"; break;
338 case CallingConv::AMDGPU_CS: Out << "amdgpu_cs"; break;
339 case CallingConv::AMDGPU_KERNEL: Out << "amdgpu_kernel"; break;
343 void llvm::PrintEscapedString(StringRef Name, raw_ostream &Out) {
344 for (unsigned i = 0, e = Name.size(); i != e; ++i) {
345 unsigned char C = Name[i];
346 if (isprint(C) && C != '\\' && C != '"')
349 Out << '\\' << hexdigit(C >> 4) << hexdigit(C & 0x0F);
361 void llvm::printLLVMNameWithoutPrefix(raw_ostream &OS, StringRef Name) {
362 assert(!Name.empty() && "Cannot get empty name!");
364 // Scan the name to see if it needs quotes first.
365 bool NeedsQuotes = isdigit(static_cast<unsigned char>(Name[0]));
367 for (unsigned i = 0, e = Name.size(); i != e; ++i) {
368 // By making this unsigned, the value passed in to isalnum will always be
369 // in the range 0-255. This is important when building with MSVC because
370 // its implementation will assert. This situation can arise when dealing
371 // with UTF-8 multibyte characters.
372 unsigned char C = Name[i];
373 if (!isalnum(static_cast<unsigned char>(C)) && C != '-' && C != '.' &&
381 // If we didn't need any quotes, just write out the name in one blast.
387 // Okay, we need quotes. Output the quotes and escape any scary characters as
390 PrintEscapedString(Name, OS);
394 /// Turn the specified name into an 'LLVM name', which is either prefixed with %
395 /// (if the string only contains simple characters) or is surrounded with ""'s
396 /// (if it has special chars in it). Print it out.
397 static void PrintLLVMName(raw_ostream &OS, StringRef Name, PrefixType Prefix) {
413 printLLVMNameWithoutPrefix(OS, Name);
416 /// Turn the specified name into an 'LLVM name', which is either prefixed with %
417 /// (if the string only contains simple characters) or is surrounded with ""'s
418 /// (if it has special chars in it). Print it out.
419 static void PrintLLVMName(raw_ostream &OS, const Value *V) {
420 PrintLLVMName(OS, V->getName(),
421 isa<GlobalValue>(V) ? GlobalPrefix : LocalPrefix);
427 TypePrinting(const TypePrinting &) = delete;
428 void operator=(const TypePrinting&) = delete;
431 /// NamedTypes - The named types that are used by the current module.
432 TypeFinder NamedTypes;
434 /// NumberedTypes - The numbered types, along with their value.
435 DenseMap<StructType*, unsigned> NumberedTypes;
437 TypePrinting() = default;
439 void incorporateTypes(const Module &M);
441 void print(Type *Ty, raw_ostream &OS);
443 void printStructBody(StructType *Ty, raw_ostream &OS);
447 void TypePrinting::incorporateTypes(const Module &M) {
448 NamedTypes.run(M, false);
450 // The list of struct types we got back includes all the struct types, split
451 // the unnamed ones out to a numbering and remove the anonymous structs.
452 unsigned NextNumber = 0;
454 std::vector<StructType*>::iterator NextToUse = NamedTypes.begin(), I, E;
455 for (I = NamedTypes.begin(), E = NamedTypes.end(); I != E; ++I) {
456 StructType *STy = *I;
458 // Ignore anonymous types.
459 if (STy->isLiteral())
462 if (STy->getName().empty())
463 NumberedTypes[STy] = NextNumber++;
468 NamedTypes.erase(NextToUse, NamedTypes.end());
472 /// CalcTypeName - Write the specified type to the specified raw_ostream, making
473 /// use of type names or up references to shorten the type name where possible.
474 void TypePrinting::print(Type *Ty, raw_ostream &OS) {
475 switch (Ty->getTypeID()) {
476 case Type::VoidTyID: OS << "void"; return;
477 case Type::HalfTyID: OS << "half"; return;
478 case Type::FloatTyID: OS << "float"; return;
479 case Type::DoubleTyID: OS << "double"; return;
480 case Type::X86_FP80TyID: OS << "x86_fp80"; return;
481 case Type::FP128TyID: OS << "fp128"; return;
482 case Type::PPC_FP128TyID: OS << "ppc_fp128"; return;
483 case Type::LabelTyID: OS << "label"; return;
484 case Type::MetadataTyID: OS << "metadata"; return;
485 case Type::X86_MMXTyID: OS << "x86_mmx"; return;
486 case Type::TokenTyID: OS << "token"; return;
487 case Type::IntegerTyID:
488 OS << 'i' << cast<IntegerType>(Ty)->getBitWidth();
491 case Type::FunctionTyID: {
492 FunctionType *FTy = cast<FunctionType>(Ty);
493 print(FTy->getReturnType(), OS);
495 for (FunctionType::param_iterator I = FTy->param_begin(),
496 E = FTy->param_end(); I != E; ++I) {
497 if (I != FTy->param_begin())
501 if (FTy->isVarArg()) {
502 if (FTy->getNumParams()) OS << ", ";
508 case Type::StructTyID: {
509 StructType *STy = cast<StructType>(Ty);
511 if (STy->isLiteral())
512 return printStructBody(STy, OS);
514 if (!STy->getName().empty())
515 return PrintLLVMName(OS, STy->getName(), LocalPrefix);
517 DenseMap<StructType*, unsigned>::iterator I = NumberedTypes.find(STy);
518 if (I != NumberedTypes.end())
519 OS << '%' << I->second;
520 else // Not enumerated, print the hex address.
521 OS << "%\"type " << STy << '\"';
524 case Type::PointerTyID: {
525 PointerType *PTy = cast<PointerType>(Ty);
526 print(PTy->getElementType(), OS);
527 if (unsigned AddressSpace = PTy->getAddressSpace())
528 OS << " addrspace(" << AddressSpace << ')';
532 case Type::ArrayTyID: {
533 ArrayType *ATy = cast<ArrayType>(Ty);
534 OS << '[' << ATy->getNumElements() << " x ";
535 print(ATy->getElementType(), OS);
539 case Type::VectorTyID: {
540 VectorType *PTy = cast<VectorType>(Ty);
541 OS << "<" << PTy->getNumElements() << " x ";
542 print(PTy->getElementType(), OS);
547 llvm_unreachable("Invalid TypeID");
550 void TypePrinting::printStructBody(StructType *STy, raw_ostream &OS) {
551 if (STy->isOpaque()) {
559 if (STy->getNumElements() == 0) {
562 StructType::element_iterator I = STy->element_begin();
565 for (StructType::element_iterator E = STy->element_end(); I != E; ++I) {
577 //===----------------------------------------------------------------------===//
578 // SlotTracker Class: Enumerate slot numbers for unnamed values
579 //===----------------------------------------------------------------------===//
580 /// This class provides computation of slot numbers for LLVM Assembly writing.
584 /// ValueMap - A mapping of Values to slot numbers.
585 typedef DenseMap<const Value*, unsigned> ValueMap;
588 /// TheModule - The module for which we are holding slot numbers.
589 const Module* TheModule;
591 /// TheFunction - The function for which we are holding slot numbers.
592 const Function* TheFunction;
593 bool FunctionProcessed;
594 bool ShouldInitializeAllMetadata;
596 /// mMap - The slot map for the module level data.
600 /// fMap - The slot map for the function level data.
604 /// mdnMap - Map for MDNodes.
605 DenseMap<const MDNode*, unsigned> mdnMap;
608 /// asMap - The slot map for attribute sets.
609 DenseMap<AttributeSet, unsigned> asMap;
612 /// Construct from a module.
614 /// If \c ShouldInitializeAllMetadata, initializes all metadata in all
615 /// functions, giving correct numbering for metadata referenced only from
616 /// within a function (even if no functions have been initialized).
617 explicit SlotTracker(const Module *M,
618 bool ShouldInitializeAllMetadata = false);
619 /// Construct from a function, starting out in incorp state.
621 /// If \c ShouldInitializeAllMetadata, initializes all metadata in all
622 /// functions, giving correct numbering for metadata referenced only from
623 /// within a function (even if no functions have been initialized).
624 explicit SlotTracker(const Function *F,
625 bool ShouldInitializeAllMetadata = false);
627 /// Return the slot number of the specified value in it's type
628 /// plane. If something is not in the SlotTracker, return -1.
629 int getLocalSlot(const Value *V);
630 int getGlobalSlot(const GlobalValue *V);
631 int getMetadataSlot(const MDNode *N);
632 int getAttributeGroupSlot(AttributeSet AS);
634 /// If you'd like to deal with a function instead of just a module, use
635 /// this method to get its data into the SlotTracker.
636 void incorporateFunction(const Function *F) {
638 FunctionProcessed = false;
641 const Function *getFunction() const { return TheFunction; }
643 /// After calling incorporateFunction, use this method to remove the
644 /// most recently incorporated function from the SlotTracker. This
645 /// will reset the state of the machine back to just the module contents.
646 void purgeFunction();
648 /// MDNode map iterators.
649 typedef DenseMap<const MDNode*, unsigned>::iterator mdn_iterator;
650 mdn_iterator mdn_begin() { return mdnMap.begin(); }
651 mdn_iterator mdn_end() { return mdnMap.end(); }
652 unsigned mdn_size() const { return mdnMap.size(); }
653 bool mdn_empty() const { return mdnMap.empty(); }
655 /// AttributeSet map iterators.
656 typedef DenseMap<AttributeSet, unsigned>::iterator as_iterator;
657 as_iterator as_begin() { return asMap.begin(); }
658 as_iterator as_end() { return asMap.end(); }
659 unsigned as_size() const { return asMap.size(); }
660 bool as_empty() const { return asMap.empty(); }
662 /// This function does the actual initialization.
663 inline void initialize();
665 // Implementation Details
667 /// CreateModuleSlot - Insert the specified GlobalValue* into the slot table.
668 void CreateModuleSlot(const GlobalValue *V);
670 /// CreateMetadataSlot - Insert the specified MDNode* into the slot table.
671 void CreateMetadataSlot(const MDNode *N);
673 /// CreateFunctionSlot - Insert the specified Value* into the slot table.
674 void CreateFunctionSlot(const Value *V);
676 /// \brief Insert the specified AttributeSet into the slot table.
677 void CreateAttributeSetSlot(AttributeSet AS);
679 /// Add all of the module level global variables (and their initializers)
680 /// and function declarations, but not the contents of those functions.
681 void processModule();
683 /// Add all of the functions arguments, basic blocks, and instructions.
684 void processFunction();
686 /// Add the metadata directly attached to a GlobalObject.
687 void processGlobalObjectMetadata(const GlobalObject &GO);
689 /// Add all of the metadata from a function.
690 void processFunctionMetadata(const Function &F);
692 /// Add all of the metadata from an instruction.
693 void processInstructionMetadata(const Instruction &I);
695 SlotTracker(const SlotTracker &) = delete;
696 void operator=(const SlotTracker &) = delete;
700 ModuleSlotTracker::ModuleSlotTracker(SlotTracker &Machine, const Module *M,
702 : M(M), F(F), Machine(&Machine) {}
704 ModuleSlotTracker::ModuleSlotTracker(const Module *M,
705 bool ShouldInitializeAllMetadata)
706 : ShouldCreateStorage(M),
707 ShouldInitializeAllMetadata(ShouldInitializeAllMetadata), M(M) {}
709 ModuleSlotTracker::~ModuleSlotTracker() {}
711 SlotTracker *ModuleSlotTracker::getMachine() {
712 if (!ShouldCreateStorage)
715 ShouldCreateStorage = false;
717 llvm::make_unique<SlotTracker>(M, ShouldInitializeAllMetadata);
718 Machine = MachineStorage.get();
722 void ModuleSlotTracker::incorporateFunction(const Function &F) {
723 // Using getMachine() may lazily create the slot tracker.
727 // Nothing to do if this is the right function already.
731 Machine->purgeFunction();
732 Machine->incorporateFunction(&F);
736 int ModuleSlotTracker::getLocalSlot(const Value *V) {
737 assert(F && "No function incorporated");
738 return Machine->getLocalSlot(V);
741 static SlotTracker *createSlotTracker(const Value *V) {
742 if (const Argument *FA = dyn_cast<Argument>(V))
743 return new SlotTracker(FA->getParent());
745 if (const Instruction *I = dyn_cast<Instruction>(V))
747 return new SlotTracker(I->getParent()->getParent());
749 if (const BasicBlock *BB = dyn_cast<BasicBlock>(V))
750 return new SlotTracker(BB->getParent());
752 if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(V))
753 return new SlotTracker(GV->getParent());
755 if (const GlobalAlias *GA = dyn_cast<GlobalAlias>(V))
756 return new SlotTracker(GA->getParent());
758 if (const GlobalIFunc *GIF = dyn_cast<GlobalIFunc>(V))
759 return new SlotTracker(GIF->getParent());
761 if (const Function *Func = dyn_cast<Function>(V))
762 return new SlotTracker(Func);
768 #define ST_DEBUG(X) dbgs() << X
773 // Module level constructor. Causes the contents of the Module (sans functions)
774 // to be added to the slot table.
775 SlotTracker::SlotTracker(const Module *M, bool ShouldInitializeAllMetadata)
776 : TheModule(M), TheFunction(nullptr), FunctionProcessed(false),
777 ShouldInitializeAllMetadata(ShouldInitializeAllMetadata), mNext(0),
778 fNext(0), mdnNext(0), asNext(0) {}
780 // Function level constructor. Causes the contents of the Module and the one
781 // function provided to be added to the slot table.
782 SlotTracker::SlotTracker(const Function *F, bool ShouldInitializeAllMetadata)
783 : TheModule(F ? F->getParent() : nullptr), TheFunction(F),
784 FunctionProcessed(false),
785 ShouldInitializeAllMetadata(ShouldInitializeAllMetadata), mNext(0),
786 fNext(0), mdnNext(0), asNext(0) {}
788 inline void SlotTracker::initialize() {
791 TheModule = nullptr; ///< Prevent re-processing next time we're called.
794 if (TheFunction && !FunctionProcessed)
798 // Iterate through all the global variables, functions, and global
799 // variable initializers and create slots for them.
800 void SlotTracker::processModule() {
801 ST_DEBUG("begin processModule!\n");
803 // Add all of the unnamed global variables to the value table.
804 for (const GlobalVariable &Var : TheModule->globals()) {
806 CreateModuleSlot(&Var);
807 processGlobalObjectMetadata(Var);
808 auto Attrs = Var.getAttributes();
809 if (Attrs.hasAttributes())
810 CreateAttributeSetSlot(Attrs);
813 for (const GlobalAlias &A : TheModule->aliases()) {
815 CreateModuleSlot(&A);
818 for (const GlobalIFunc &I : TheModule->ifuncs()) {
820 CreateModuleSlot(&I);
823 // Add metadata used by named metadata.
824 for (const NamedMDNode &NMD : TheModule->named_metadata()) {
825 for (unsigned i = 0, e = NMD.getNumOperands(); i != e; ++i)
826 CreateMetadataSlot(NMD.getOperand(i));
829 for (const Function &F : *TheModule) {
831 // Add all the unnamed functions to the table.
832 CreateModuleSlot(&F);
834 if (ShouldInitializeAllMetadata)
835 processFunctionMetadata(F);
837 // Add all the function attributes to the table.
838 // FIXME: Add attributes of other objects?
839 AttributeSet FnAttrs = F.getAttributes().getFnAttributes();
840 if (FnAttrs.hasAttributes())
841 CreateAttributeSetSlot(FnAttrs);
844 ST_DEBUG("end processModule!\n");
847 // Process the arguments, basic blocks, and instructions of a function.
848 void SlotTracker::processFunction() {
849 ST_DEBUG("begin processFunction!\n");
852 // Process function metadata if it wasn't hit at the module-level.
853 if (!ShouldInitializeAllMetadata)
854 processFunctionMetadata(*TheFunction);
856 // Add all the function arguments with no names.
857 for(Function::const_arg_iterator AI = TheFunction->arg_begin(),
858 AE = TheFunction->arg_end(); AI != AE; ++AI)
860 CreateFunctionSlot(&*AI);
862 ST_DEBUG("Inserting Instructions:\n");
864 // Add all of the basic blocks and instructions with no names.
865 for (auto &BB : *TheFunction) {
867 CreateFunctionSlot(&BB);
870 if (!I.getType()->isVoidTy() && !I.hasName())
871 CreateFunctionSlot(&I);
873 // We allow direct calls to any llvm.foo function here, because the
874 // target may not be linked into the optimizer.
875 if (auto CS = ImmutableCallSite(&I)) {
876 // Add all the call attributes to the table.
877 AttributeSet Attrs = CS.getAttributes().getFnAttributes();
878 if (Attrs.hasAttributes())
879 CreateAttributeSetSlot(Attrs);
884 FunctionProcessed = true;
886 ST_DEBUG("end processFunction!\n");
889 void SlotTracker::processGlobalObjectMetadata(const GlobalObject &GO) {
890 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
891 GO.getAllMetadata(MDs);
893 CreateMetadataSlot(MD.second);
896 void SlotTracker::processFunctionMetadata(const Function &F) {
897 processGlobalObjectMetadata(F);
900 processInstructionMetadata(I);
904 void SlotTracker::processInstructionMetadata(const Instruction &I) {
905 // Process metadata used directly by intrinsics.
906 if (const CallInst *CI = dyn_cast<CallInst>(&I))
907 if (Function *F = CI->getCalledFunction())
908 if (F->isIntrinsic())
909 for (auto &Op : I.operands())
910 if (auto *V = dyn_cast_or_null<MetadataAsValue>(Op))
911 if (MDNode *N = dyn_cast<MDNode>(V->getMetadata()))
912 CreateMetadataSlot(N);
914 // Process metadata attached to this instruction.
915 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
916 I.getAllMetadata(MDs);
918 CreateMetadataSlot(MD.second);
921 /// Clean up after incorporating a function. This is the only way to get out of
922 /// the function incorporation state that affects get*Slot/Create*Slot. Function
923 /// incorporation state is indicated by TheFunction != 0.
924 void SlotTracker::purgeFunction() {
925 ST_DEBUG("begin purgeFunction!\n");
926 fMap.clear(); // Simply discard the function level map
927 TheFunction = nullptr;
928 FunctionProcessed = false;
929 ST_DEBUG("end purgeFunction!\n");
932 /// getGlobalSlot - Get the slot number of a global value.
933 int SlotTracker::getGlobalSlot(const GlobalValue *V) {
934 // Check for uninitialized state and do lazy initialization.
937 // Find the value in the module map
938 ValueMap::iterator MI = mMap.find(V);
939 return MI == mMap.end() ? -1 : (int)MI->second;
942 /// getMetadataSlot - Get the slot number of a MDNode.
943 int SlotTracker::getMetadataSlot(const MDNode *N) {
944 // Check for uninitialized state and do lazy initialization.
947 // Find the MDNode in the module map
948 mdn_iterator MI = mdnMap.find(N);
949 return MI == mdnMap.end() ? -1 : (int)MI->second;
953 /// getLocalSlot - Get the slot number for a value that is local to a function.
954 int SlotTracker::getLocalSlot(const Value *V) {
955 assert(!isa<Constant>(V) && "Can't get a constant or global slot with this!");
957 // Check for uninitialized state and do lazy initialization.
960 ValueMap::iterator FI = fMap.find(V);
961 return FI == fMap.end() ? -1 : (int)FI->second;
964 int SlotTracker::getAttributeGroupSlot(AttributeSet AS) {
965 // Check for uninitialized state and do lazy initialization.
968 // Find the AttributeSet in the module map.
969 as_iterator AI = asMap.find(AS);
970 return AI == asMap.end() ? -1 : (int)AI->second;
973 /// CreateModuleSlot - Insert the specified GlobalValue* into the slot table.
974 void SlotTracker::CreateModuleSlot(const GlobalValue *V) {
975 assert(V && "Can't insert a null Value into SlotTracker!");
976 assert(!V->getType()->isVoidTy() && "Doesn't need a slot!");
977 assert(!V->hasName() && "Doesn't need a slot!");
979 unsigned DestSlot = mNext++;
982 ST_DEBUG(" Inserting value [" << V->getType() << "] = " << V << " slot=" <<
984 // G = Global, F = Function, A = Alias, I = IFunc, o = other
985 ST_DEBUG((isa<GlobalVariable>(V) ? 'G' :
986 (isa<Function>(V) ? 'F' :
987 (isa<GlobalAlias>(V) ? 'A' :
988 (isa<GlobalIFunc>(V) ? 'I' : 'o')))) << "]\n");
991 /// CreateSlot - Create a new slot for the specified value if it has no name.
992 void SlotTracker::CreateFunctionSlot(const Value *V) {
993 assert(!V->getType()->isVoidTy() && !V->hasName() && "Doesn't need a slot!");
995 unsigned DestSlot = fNext++;
998 // G = Global, F = Function, o = other
999 ST_DEBUG(" Inserting value [" << V->getType() << "] = " << V << " slot=" <<
1000 DestSlot << " [o]\n");
1003 /// CreateModuleSlot - Insert the specified MDNode* into the slot table.
1004 void SlotTracker::CreateMetadataSlot(const MDNode *N) {
1005 assert(N && "Can't insert a null Value into SlotTracker!");
1007 unsigned DestSlot = mdnNext;
1008 if (!mdnMap.insert(std::make_pair(N, DestSlot)).second)
1012 // Recursively add any MDNodes referenced by operands.
1013 for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i)
1014 if (const MDNode *Op = dyn_cast_or_null<MDNode>(N->getOperand(i)))
1015 CreateMetadataSlot(Op);
1018 void SlotTracker::CreateAttributeSetSlot(AttributeSet AS) {
1019 assert(AS.hasAttributes() && "Doesn't need a slot!");
1021 as_iterator I = asMap.find(AS);
1022 if (I != asMap.end())
1025 unsigned DestSlot = asNext++;
1026 asMap[AS] = DestSlot;
1029 //===----------------------------------------------------------------------===//
1030 // AsmWriter Implementation
1031 //===----------------------------------------------------------------------===//
1033 static void WriteAsOperandInternal(raw_ostream &Out, const Value *V,
1034 TypePrinting *TypePrinter,
1035 SlotTracker *Machine,
1036 const Module *Context);
1038 static void WriteAsOperandInternal(raw_ostream &Out, const Metadata *MD,
1039 TypePrinting *TypePrinter,
1040 SlotTracker *Machine, const Module *Context,
1041 bool FromValue = false);
1043 static void writeAtomicRMWOperation(raw_ostream &Out,
1044 AtomicRMWInst::BinOp Op) {
1046 default: Out << " <unknown operation " << Op << ">"; break;
1047 case AtomicRMWInst::Xchg: Out << " xchg"; break;
1048 case AtomicRMWInst::Add: Out << " add"; break;
1049 case AtomicRMWInst::Sub: Out << " sub"; break;
1050 case AtomicRMWInst::And: Out << " and"; break;
1051 case AtomicRMWInst::Nand: Out << " nand"; break;
1052 case AtomicRMWInst::Or: Out << " or"; break;
1053 case AtomicRMWInst::Xor: Out << " xor"; break;
1054 case AtomicRMWInst::Max: Out << " max"; break;
1055 case AtomicRMWInst::Min: Out << " min"; break;
1056 case AtomicRMWInst::UMax: Out << " umax"; break;
1057 case AtomicRMWInst::UMin: Out << " umin"; break;
1061 static void WriteOptimizationInfo(raw_ostream &Out, const User *U) {
1062 if (const FPMathOperator *FPO = dyn_cast<const FPMathOperator>(U)) {
1063 // Unsafe algebra implies all the others, no need to write them all out
1064 if (FPO->hasUnsafeAlgebra())
1067 if (FPO->hasNoNaNs())
1069 if (FPO->hasNoInfs())
1071 if (FPO->hasNoSignedZeros())
1073 if (FPO->hasAllowReciprocal())
1075 if (FPO->hasAllowContract())
1080 if (const OverflowingBinaryOperator *OBO =
1081 dyn_cast<OverflowingBinaryOperator>(U)) {
1082 if (OBO->hasNoUnsignedWrap())
1084 if (OBO->hasNoSignedWrap())
1086 } else if (const PossiblyExactOperator *Div =
1087 dyn_cast<PossiblyExactOperator>(U)) {
1090 } else if (const GEPOperator *GEP = dyn_cast<GEPOperator>(U)) {
1091 if (GEP->isInBounds())
1096 static void WriteConstantInternal(raw_ostream &Out, const Constant *CV,
1097 TypePrinting &TypePrinter,
1098 SlotTracker *Machine,
1099 const Module *Context) {
1100 if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV)) {
1101 if (CI->getType()->isIntegerTy(1)) {
1102 Out << (CI->getZExtValue() ? "true" : "false");
1105 Out << CI->getValue();
1109 if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV)) {
1110 const APFloat &APF = CFP->getValueAPF();
1111 if (&APF.getSemantics() == &APFloat::IEEEsingle() ||
1112 &APF.getSemantics() == &APFloat::IEEEdouble()) {
1113 // We would like to output the FP constant value in exponential notation,
1114 // but we cannot do this if doing so will lose precision. Check here to
1115 // make sure that we only output it in exponential format if we can parse
1116 // the value back and get the same value.
1119 bool isDouble = &APF.getSemantics() == &APFloat::IEEEdouble();
1120 bool isInf = APF.isInfinity();
1121 bool isNaN = APF.isNaN();
1122 if (!isInf && !isNaN) {
1123 double Val = isDouble ? APF.convertToDouble() : APF.convertToFloat();
1124 SmallString<128> StrVal;
1125 APF.toString(StrVal, 6, 0, false);
1126 // Check to make sure that the stringized number is not some string like
1127 // "Inf" or NaN, that atof will accept, but the lexer will not. Check
1128 // that the string matches the "[-+]?[0-9]" regex.
1130 assert(((StrVal[0] >= '0' && StrVal[0] <= '9') ||
1131 ((StrVal[0] == '-' || StrVal[0] == '+') &&
1132 (StrVal[1] >= '0' && StrVal[1] <= '9'))) &&
1133 "[-+]?[0-9] regex does not match!");
1134 // Reparse stringized version!
1135 if (APFloat(APFloat::IEEEdouble(), StrVal).convertToDouble() == Val) {
1140 // Otherwise we could not reparse it to exactly the same value, so we must
1141 // output the string in hexadecimal format! Note that loading and storing
1142 // floating point types changes the bits of NaNs on some hosts, notably
1143 // x86, so we must not use these types.
1144 static_assert(sizeof(double) == sizeof(uint64_t),
1145 "assuming that double is 64 bits!");
1147 // Floats are represented in ASCII IR as double, convert.
1149 apf.convert(APFloat::IEEEdouble(), APFloat::rmNearestTiesToEven,
1151 Out << format_hex(apf.bitcastToAPInt().getZExtValue(), 0, /*Upper=*/true);
1155 // Either half, or some form of long double.
1156 // These appear as a magic letter identifying the type, then a
1157 // fixed number of hex digits.
1159 APInt API = APF.bitcastToAPInt();
1160 if (&APF.getSemantics() == &APFloat::x87DoubleExtended()) {
1162 Out << format_hex_no_prefix(API.getHiBits(16).getZExtValue(), 4,
1164 Out << format_hex_no_prefix(API.getLoBits(64).getZExtValue(), 16,
1167 } else if (&APF.getSemantics() == &APFloat::IEEEquad()) {
1169 Out << format_hex_no_prefix(API.getLoBits(64).getZExtValue(), 16,
1171 Out << format_hex_no_prefix(API.getHiBits(64).getZExtValue(), 16,
1173 } else if (&APF.getSemantics() == &APFloat::PPCDoubleDouble()) {
1175 Out << format_hex_no_prefix(API.getLoBits(64).getZExtValue(), 16,
1177 Out << format_hex_no_prefix(API.getHiBits(64).getZExtValue(), 16,
1179 } else if (&APF.getSemantics() == &APFloat::IEEEhalf()) {
1181 Out << format_hex_no_prefix(API.getZExtValue(), 4,
1184 llvm_unreachable("Unsupported floating point type");
1188 if (isa<ConstantAggregateZero>(CV)) {
1189 Out << "zeroinitializer";
1193 if (const BlockAddress *BA = dyn_cast<BlockAddress>(CV)) {
1194 Out << "blockaddress(";
1195 WriteAsOperandInternal(Out, BA->getFunction(), &TypePrinter, Machine,
1198 WriteAsOperandInternal(Out, BA->getBasicBlock(), &TypePrinter, Machine,
1204 if (const ConstantArray *CA = dyn_cast<ConstantArray>(CV)) {
1205 Type *ETy = CA->getType()->getElementType();
1207 TypePrinter.print(ETy, Out);
1209 WriteAsOperandInternal(Out, CA->getOperand(0),
1210 &TypePrinter, Machine,
1212 for (unsigned i = 1, e = CA->getNumOperands(); i != e; ++i) {
1214 TypePrinter.print(ETy, Out);
1216 WriteAsOperandInternal(Out, CA->getOperand(i), &TypePrinter, Machine,
1223 if (const ConstantDataArray *CA = dyn_cast<ConstantDataArray>(CV)) {
1224 // As a special case, print the array as a string if it is an array of
1225 // i8 with ConstantInt values.
1226 if (CA->isString()) {
1228 PrintEscapedString(CA->getAsString(), Out);
1233 Type *ETy = CA->getType()->getElementType();
1235 TypePrinter.print(ETy, Out);
1237 WriteAsOperandInternal(Out, CA->getElementAsConstant(0),
1238 &TypePrinter, Machine,
1240 for (unsigned i = 1, e = CA->getNumElements(); i != e; ++i) {
1242 TypePrinter.print(ETy, Out);
1244 WriteAsOperandInternal(Out, CA->getElementAsConstant(i), &TypePrinter,
1252 if (const ConstantStruct *CS = dyn_cast<ConstantStruct>(CV)) {
1253 if (CS->getType()->isPacked())
1256 unsigned N = CS->getNumOperands();
1259 TypePrinter.print(CS->getOperand(0)->getType(), Out);
1262 WriteAsOperandInternal(Out, CS->getOperand(0), &TypePrinter, Machine,
1265 for (unsigned i = 1; i < N; i++) {
1267 TypePrinter.print(CS->getOperand(i)->getType(), Out);
1270 WriteAsOperandInternal(Out, CS->getOperand(i), &TypePrinter, Machine,
1277 if (CS->getType()->isPacked())
1282 if (isa<ConstantVector>(CV) || isa<ConstantDataVector>(CV)) {
1283 Type *ETy = CV->getType()->getVectorElementType();
1285 TypePrinter.print(ETy, Out);
1287 WriteAsOperandInternal(Out, CV->getAggregateElement(0U), &TypePrinter,
1289 for (unsigned i = 1, e = CV->getType()->getVectorNumElements(); i != e;++i){
1291 TypePrinter.print(ETy, Out);
1293 WriteAsOperandInternal(Out, CV->getAggregateElement(i), &TypePrinter,
1300 if (isa<ConstantPointerNull>(CV)) {
1305 if (isa<ConstantTokenNone>(CV)) {
1310 if (isa<UndefValue>(CV)) {
1315 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV)) {
1316 Out << CE->getOpcodeName();
1317 WriteOptimizationInfo(Out, CE);
1318 if (CE->isCompare())
1319 Out << ' ' << CmpInst::getPredicateName(
1320 static_cast<CmpInst::Predicate>(CE->getPredicate()));
1323 Optional<unsigned> InRangeOp;
1324 if (const GEPOperator *GEP = dyn_cast<GEPOperator>(CE)) {
1325 TypePrinter.print(GEP->getSourceElementType(), Out);
1327 InRangeOp = GEP->getInRangeIndex();
1332 for (User::const_op_iterator OI=CE->op_begin(); OI != CE->op_end(); ++OI) {
1333 if (InRangeOp && unsigned(OI - CE->op_begin()) == *InRangeOp)
1335 TypePrinter.print((*OI)->getType(), Out);
1337 WriteAsOperandInternal(Out, *OI, &TypePrinter, Machine, Context);
1338 if (OI+1 != CE->op_end())
1342 if (CE->hasIndices()) {
1343 ArrayRef<unsigned> Indices = CE->getIndices();
1344 for (unsigned i = 0, e = Indices.size(); i != e; ++i)
1345 Out << ", " << Indices[i];
1350 TypePrinter.print(CE->getType(), Out);
1357 Out << "<placeholder or erroneous Constant>";
1360 static void writeMDTuple(raw_ostream &Out, const MDTuple *Node,
1361 TypePrinting *TypePrinter, SlotTracker *Machine,
1362 const Module *Context) {
1364 for (unsigned mi = 0, me = Node->getNumOperands(); mi != me; ++mi) {
1365 const Metadata *MD = Node->getOperand(mi);
1368 else if (auto *MDV = dyn_cast<ValueAsMetadata>(MD)) {
1369 Value *V = MDV->getValue();
1370 TypePrinter->print(V->getType(), Out);
1372 WriteAsOperandInternal(Out, V, TypePrinter, Machine, Context);
1374 WriteAsOperandInternal(Out, MD, TypePrinter, Machine, Context);
1384 struct FieldSeparator {
1387 FieldSeparator(const char *Sep = ", ") : Skip(true), Sep(Sep) {}
1389 raw_ostream &operator<<(raw_ostream &OS, FieldSeparator &FS) {
1394 return OS << FS.Sep;
1396 struct MDFieldPrinter {
1399 TypePrinting *TypePrinter;
1400 SlotTracker *Machine;
1401 const Module *Context;
1403 explicit MDFieldPrinter(raw_ostream &Out)
1404 : Out(Out), TypePrinter(nullptr), Machine(nullptr), Context(nullptr) {}
1405 MDFieldPrinter(raw_ostream &Out, TypePrinting *TypePrinter,
1406 SlotTracker *Machine, const Module *Context)
1407 : Out(Out), TypePrinter(TypePrinter), Machine(Machine), Context(Context) {
1409 void printTag(const DINode *N);
1410 void printMacinfoType(const DIMacroNode *N);
1411 void printChecksumKind(const DIFile *N);
1412 void printString(StringRef Name, StringRef Value,
1413 bool ShouldSkipEmpty = true);
1414 void printMetadata(StringRef Name, const Metadata *MD,
1415 bool ShouldSkipNull = true);
1416 template <class IntTy>
1417 void printInt(StringRef Name, IntTy Int, bool ShouldSkipZero = true);
1418 void printBool(StringRef Name, bool Value, Optional<bool> Default = None);
1419 void printDIFlags(StringRef Name, DINode::DIFlags Flags);
1420 template <class IntTy, class Stringifier>
1421 void printDwarfEnum(StringRef Name, IntTy Value, Stringifier toString,
1422 bool ShouldSkipZero = true);
1423 void printEmissionKind(StringRef Name, DICompileUnit::DebugEmissionKind EK);
1427 void MDFieldPrinter::printTag(const DINode *N) {
1428 Out << FS << "tag: ";
1429 auto Tag = dwarf::TagString(N->getTag());
1436 void MDFieldPrinter::printMacinfoType(const DIMacroNode *N) {
1437 Out << FS << "type: ";
1438 auto Type = dwarf::MacinfoString(N->getMacinfoType());
1442 Out << N->getMacinfoType();
1445 void MDFieldPrinter::printChecksumKind(const DIFile *N) {
1446 if (N->getChecksumKind() == DIFile::CSK_None)
1447 // Skip CSK_None checksum kind.
1449 Out << FS << "checksumkind: " << N->getChecksumKindAsString();
1452 void MDFieldPrinter::printString(StringRef Name, StringRef Value,
1453 bool ShouldSkipEmpty) {
1454 if (ShouldSkipEmpty && Value.empty())
1457 Out << FS << Name << ": \"";
1458 PrintEscapedString(Value, Out);
1462 static void writeMetadataAsOperand(raw_ostream &Out, const Metadata *MD,
1463 TypePrinting *TypePrinter,
1464 SlotTracker *Machine,
1465 const Module *Context) {
1470 WriteAsOperandInternal(Out, MD, TypePrinter, Machine, Context);
1473 void MDFieldPrinter::printMetadata(StringRef Name, const Metadata *MD,
1474 bool ShouldSkipNull) {
1475 if (ShouldSkipNull && !MD)
1478 Out << FS << Name << ": ";
1479 writeMetadataAsOperand(Out, MD, TypePrinter, Machine, Context);
1482 template <class IntTy>
1483 void MDFieldPrinter::printInt(StringRef Name, IntTy Int, bool ShouldSkipZero) {
1484 if (ShouldSkipZero && !Int)
1487 Out << FS << Name << ": " << Int;
1490 void MDFieldPrinter::printBool(StringRef Name, bool Value,
1491 Optional<bool> Default) {
1492 if (Default && Value == *Default)
1494 Out << FS << Name << ": " << (Value ? "true" : "false");
1497 void MDFieldPrinter::printDIFlags(StringRef Name, DINode::DIFlags Flags) {
1501 Out << FS << Name << ": ";
1503 SmallVector<DINode::DIFlags, 8> SplitFlags;
1504 auto Extra = DINode::splitFlags(Flags, SplitFlags);
1506 FieldSeparator FlagsFS(" | ");
1507 for (auto F : SplitFlags) {
1508 auto StringF = DINode::getFlagString(F);
1509 assert(!StringF.empty() && "Expected valid flag");
1510 Out << FlagsFS << StringF;
1512 if (Extra || SplitFlags.empty())
1513 Out << FlagsFS << Extra;
1516 void MDFieldPrinter::printEmissionKind(StringRef Name,
1517 DICompileUnit::DebugEmissionKind EK) {
1518 Out << FS << Name << ": " << DICompileUnit::EmissionKindString(EK);
1522 template <class IntTy, class Stringifier>
1523 void MDFieldPrinter::printDwarfEnum(StringRef Name, IntTy Value,
1524 Stringifier toString, bool ShouldSkipZero) {
1528 Out << FS << Name << ": ";
1529 auto S = toString(Value);
1536 static void writeGenericDINode(raw_ostream &Out, const GenericDINode *N,
1537 TypePrinting *TypePrinter, SlotTracker *Machine,
1538 const Module *Context) {
1539 Out << "!GenericDINode(";
1540 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1541 Printer.printTag(N);
1542 Printer.printString("header", N->getHeader());
1543 if (N->getNumDwarfOperands()) {
1544 Out << Printer.FS << "operands: {";
1546 for (auto &I : N->dwarf_operands()) {
1548 writeMetadataAsOperand(Out, I, TypePrinter, Machine, Context);
1555 static void writeDILocation(raw_ostream &Out, const DILocation *DL,
1556 TypePrinting *TypePrinter, SlotTracker *Machine,
1557 const Module *Context) {
1558 Out << "!DILocation(";
1559 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1560 // Always output the line, since 0 is a relevant and important value for it.
1561 Printer.printInt("line", DL->getLine(), /* ShouldSkipZero */ false);
1562 Printer.printInt("column", DL->getColumn());
1563 Printer.printMetadata("scope", DL->getRawScope(), /* ShouldSkipNull */ false);
1564 Printer.printMetadata("inlinedAt", DL->getRawInlinedAt());
1568 static void writeDISubrange(raw_ostream &Out, const DISubrange *N,
1569 TypePrinting *, SlotTracker *, const Module *) {
1570 Out << "!DISubrange(";
1571 MDFieldPrinter Printer(Out);
1572 Printer.printInt("count", N->getCount(), /* ShouldSkipZero */ false);
1573 Printer.printInt("lowerBound", N->getLowerBound());
1577 static void writeDIEnumerator(raw_ostream &Out, const DIEnumerator *N,
1578 TypePrinting *, SlotTracker *, const Module *) {
1579 Out << "!DIEnumerator(";
1580 MDFieldPrinter Printer(Out);
1581 Printer.printString("name", N->getName(), /* ShouldSkipEmpty */ false);
1582 Printer.printInt("value", N->getValue(), /* ShouldSkipZero */ false);
1586 static void writeDIBasicType(raw_ostream &Out, const DIBasicType *N,
1587 TypePrinting *, SlotTracker *, const Module *) {
1588 Out << "!DIBasicType(";
1589 MDFieldPrinter Printer(Out);
1590 if (N->getTag() != dwarf::DW_TAG_base_type)
1591 Printer.printTag(N);
1592 Printer.printString("name", N->getName());
1593 Printer.printInt("size", N->getSizeInBits());
1594 Printer.printInt("align", N->getAlignInBits());
1595 Printer.printDwarfEnum("encoding", N->getEncoding(),
1596 dwarf::AttributeEncodingString);
1600 static void writeDIDerivedType(raw_ostream &Out, const DIDerivedType *N,
1601 TypePrinting *TypePrinter, SlotTracker *Machine,
1602 const Module *Context) {
1603 Out << "!DIDerivedType(";
1604 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1605 Printer.printTag(N);
1606 Printer.printString("name", N->getName());
1607 Printer.printMetadata("scope", N->getRawScope());
1608 Printer.printMetadata("file", N->getRawFile());
1609 Printer.printInt("line", N->getLine());
1610 Printer.printMetadata("baseType", N->getRawBaseType(),
1611 /* ShouldSkipNull */ false);
1612 Printer.printInt("size", N->getSizeInBits());
1613 Printer.printInt("align", N->getAlignInBits());
1614 Printer.printInt("offset", N->getOffsetInBits());
1615 Printer.printDIFlags("flags", N->getFlags());
1616 Printer.printMetadata("extraData", N->getRawExtraData());
1617 if (const auto &DWARFAddressSpace = N->getDWARFAddressSpace())
1618 Printer.printInt("dwarfAddressSpace", *DWARFAddressSpace,
1619 /* ShouldSkipZero */ false);
1623 static void writeDICompositeType(raw_ostream &Out, const DICompositeType *N,
1624 TypePrinting *TypePrinter,
1625 SlotTracker *Machine, const Module *Context) {
1626 Out << "!DICompositeType(";
1627 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1628 Printer.printTag(N);
1629 Printer.printString("name", N->getName());
1630 Printer.printMetadata("scope", N->getRawScope());
1631 Printer.printMetadata("file", N->getRawFile());
1632 Printer.printInt("line", N->getLine());
1633 Printer.printMetadata("baseType", N->getRawBaseType());
1634 Printer.printInt("size", N->getSizeInBits());
1635 Printer.printInt("align", N->getAlignInBits());
1636 Printer.printInt("offset", N->getOffsetInBits());
1637 Printer.printDIFlags("flags", N->getFlags());
1638 Printer.printMetadata("elements", N->getRawElements());
1639 Printer.printDwarfEnum("runtimeLang", N->getRuntimeLang(),
1640 dwarf::LanguageString);
1641 Printer.printMetadata("vtableHolder", N->getRawVTableHolder());
1642 Printer.printMetadata("templateParams", N->getRawTemplateParams());
1643 Printer.printString("identifier", N->getIdentifier());
1647 static void writeDISubroutineType(raw_ostream &Out, const DISubroutineType *N,
1648 TypePrinting *TypePrinter,
1649 SlotTracker *Machine, const Module *Context) {
1650 Out << "!DISubroutineType(";
1651 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1652 Printer.printDIFlags("flags", N->getFlags());
1653 Printer.printDwarfEnum("cc", N->getCC(), dwarf::ConventionString);
1654 Printer.printMetadata("types", N->getRawTypeArray(),
1655 /* ShouldSkipNull */ false);
1659 static void writeDIFile(raw_ostream &Out, const DIFile *N, TypePrinting *,
1660 SlotTracker *, const Module *) {
1662 MDFieldPrinter Printer(Out);
1663 Printer.printString("filename", N->getFilename(),
1664 /* ShouldSkipEmpty */ false);
1665 Printer.printString("directory", N->getDirectory(),
1666 /* ShouldSkipEmpty */ false);
1667 Printer.printChecksumKind(N);
1668 Printer.printString("checksum", N->getChecksum(), /* ShouldSkipEmpty */ true);
1672 static void writeDICompileUnit(raw_ostream &Out, const DICompileUnit *N,
1673 TypePrinting *TypePrinter, SlotTracker *Machine,
1674 const Module *Context) {
1675 Out << "!DICompileUnit(";
1676 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1677 Printer.printDwarfEnum("language", N->getSourceLanguage(),
1678 dwarf::LanguageString, /* ShouldSkipZero */ false);
1679 Printer.printMetadata("file", N->getRawFile(), /* ShouldSkipNull */ false);
1680 Printer.printString("producer", N->getProducer());
1681 Printer.printBool("isOptimized", N->isOptimized());
1682 Printer.printString("flags", N->getFlags());
1683 Printer.printInt("runtimeVersion", N->getRuntimeVersion(),
1684 /* ShouldSkipZero */ false);
1685 Printer.printString("splitDebugFilename", N->getSplitDebugFilename());
1686 Printer.printEmissionKind("emissionKind", N->getEmissionKind());
1687 Printer.printMetadata("enums", N->getRawEnumTypes());
1688 Printer.printMetadata("retainedTypes", N->getRawRetainedTypes());
1689 Printer.printMetadata("globals", N->getRawGlobalVariables());
1690 Printer.printMetadata("imports", N->getRawImportedEntities());
1691 Printer.printMetadata("macros", N->getRawMacros());
1692 Printer.printInt("dwoId", N->getDWOId());
1693 Printer.printBool("splitDebugInlining", N->getSplitDebugInlining(), true);
1694 Printer.printBool("debugInfoForProfiling", N->getDebugInfoForProfiling(),
1699 static void writeDISubprogram(raw_ostream &Out, const DISubprogram *N,
1700 TypePrinting *TypePrinter, SlotTracker *Machine,
1701 const Module *Context) {
1702 Out << "!DISubprogram(";
1703 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1704 Printer.printString("name", N->getName());
1705 Printer.printString("linkageName", N->getLinkageName());
1706 Printer.printMetadata("scope", N->getRawScope(), /* ShouldSkipNull */ false);
1707 Printer.printMetadata("file", N->getRawFile());
1708 Printer.printInt("line", N->getLine());
1709 Printer.printMetadata("type", N->getRawType());
1710 Printer.printBool("isLocal", N->isLocalToUnit());
1711 Printer.printBool("isDefinition", N->isDefinition());
1712 Printer.printInt("scopeLine", N->getScopeLine());
1713 Printer.printMetadata("containingType", N->getRawContainingType());
1714 Printer.printDwarfEnum("virtuality", N->getVirtuality(),
1715 dwarf::VirtualityString);
1716 if (N->getVirtuality() != dwarf::DW_VIRTUALITY_none ||
1717 N->getVirtualIndex() != 0)
1718 Printer.printInt("virtualIndex", N->getVirtualIndex(), false);
1719 Printer.printInt("thisAdjustment", N->getThisAdjustment());
1720 Printer.printDIFlags("flags", N->getFlags());
1721 Printer.printBool("isOptimized", N->isOptimized());
1722 Printer.printMetadata("unit", N->getRawUnit());
1723 Printer.printMetadata("templateParams", N->getRawTemplateParams());
1724 Printer.printMetadata("declaration", N->getRawDeclaration());
1725 Printer.printMetadata("variables", N->getRawVariables());
1726 Printer.printMetadata("thrownTypes", N->getRawThrownTypes());
1730 static void writeDILexicalBlock(raw_ostream &Out, const DILexicalBlock *N,
1731 TypePrinting *TypePrinter, SlotTracker *Machine,
1732 const Module *Context) {
1733 Out << "!DILexicalBlock(";
1734 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1735 Printer.printMetadata("scope", N->getRawScope(), /* ShouldSkipNull */ false);
1736 Printer.printMetadata("file", N->getRawFile());
1737 Printer.printInt("line", N->getLine());
1738 Printer.printInt("column", N->getColumn());
1742 static void writeDILexicalBlockFile(raw_ostream &Out,
1743 const DILexicalBlockFile *N,
1744 TypePrinting *TypePrinter,
1745 SlotTracker *Machine,
1746 const Module *Context) {
1747 Out << "!DILexicalBlockFile(";
1748 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1749 Printer.printMetadata("scope", N->getRawScope(), /* ShouldSkipNull */ false);
1750 Printer.printMetadata("file", N->getRawFile());
1751 Printer.printInt("discriminator", N->getDiscriminator(),
1752 /* ShouldSkipZero */ false);
1756 static void writeDINamespace(raw_ostream &Out, const DINamespace *N,
1757 TypePrinting *TypePrinter, SlotTracker *Machine,
1758 const Module *Context) {
1759 Out << "!DINamespace(";
1760 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1761 Printer.printString("name", N->getName());
1762 Printer.printMetadata("scope", N->getRawScope(), /* ShouldSkipNull */ false);
1763 Printer.printBool("exportSymbols", N->getExportSymbols(), false);
1767 static void writeDIMacro(raw_ostream &Out, const DIMacro *N,
1768 TypePrinting *TypePrinter, SlotTracker *Machine,
1769 const Module *Context) {
1771 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1772 Printer.printMacinfoType(N);
1773 Printer.printInt("line", N->getLine());
1774 Printer.printString("name", N->getName());
1775 Printer.printString("value", N->getValue());
1779 static void writeDIMacroFile(raw_ostream &Out, const DIMacroFile *N,
1780 TypePrinting *TypePrinter, SlotTracker *Machine,
1781 const Module *Context) {
1782 Out << "!DIMacroFile(";
1783 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1784 Printer.printInt("line", N->getLine());
1785 Printer.printMetadata("file", N->getRawFile(), /* ShouldSkipNull */ false);
1786 Printer.printMetadata("nodes", N->getRawElements());
1790 static void writeDIModule(raw_ostream &Out, const DIModule *N,
1791 TypePrinting *TypePrinter, SlotTracker *Machine,
1792 const Module *Context) {
1793 Out << "!DIModule(";
1794 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1795 Printer.printMetadata("scope", N->getRawScope(), /* ShouldSkipNull */ false);
1796 Printer.printString("name", N->getName());
1797 Printer.printString("configMacros", N->getConfigurationMacros());
1798 Printer.printString("includePath", N->getIncludePath());
1799 Printer.printString("isysroot", N->getISysRoot());
1804 static void writeDITemplateTypeParameter(raw_ostream &Out,
1805 const DITemplateTypeParameter *N,
1806 TypePrinting *TypePrinter,
1807 SlotTracker *Machine,
1808 const Module *Context) {
1809 Out << "!DITemplateTypeParameter(";
1810 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1811 Printer.printString("name", N->getName());
1812 Printer.printMetadata("type", N->getRawType(), /* ShouldSkipNull */ false);
1816 static void writeDITemplateValueParameter(raw_ostream &Out,
1817 const DITemplateValueParameter *N,
1818 TypePrinting *TypePrinter,
1819 SlotTracker *Machine,
1820 const Module *Context) {
1821 Out << "!DITemplateValueParameter(";
1822 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1823 if (N->getTag() != dwarf::DW_TAG_template_value_parameter)
1824 Printer.printTag(N);
1825 Printer.printString("name", N->getName());
1826 Printer.printMetadata("type", N->getRawType());
1827 Printer.printMetadata("value", N->getValue(), /* ShouldSkipNull */ false);
1831 static void writeDIGlobalVariable(raw_ostream &Out, const DIGlobalVariable *N,
1832 TypePrinting *TypePrinter,
1833 SlotTracker *Machine, const Module *Context) {
1834 Out << "!DIGlobalVariable(";
1835 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1836 Printer.printString("name", N->getName());
1837 Printer.printString("linkageName", N->getLinkageName());
1838 Printer.printMetadata("scope", N->getRawScope(), /* ShouldSkipNull */ false);
1839 Printer.printMetadata("file", N->getRawFile());
1840 Printer.printInt("line", N->getLine());
1841 Printer.printMetadata("type", N->getRawType());
1842 Printer.printBool("isLocal", N->isLocalToUnit());
1843 Printer.printBool("isDefinition", N->isDefinition());
1844 Printer.printMetadata("declaration", N->getRawStaticDataMemberDeclaration());
1845 Printer.printInt("align", N->getAlignInBits());
1849 static void writeDILocalVariable(raw_ostream &Out, const DILocalVariable *N,
1850 TypePrinting *TypePrinter,
1851 SlotTracker *Machine, const Module *Context) {
1852 Out << "!DILocalVariable(";
1853 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1854 Printer.printString("name", N->getName());
1855 Printer.printInt("arg", N->getArg());
1856 Printer.printMetadata("scope", N->getRawScope(), /* ShouldSkipNull */ false);
1857 Printer.printMetadata("file", N->getRawFile());
1858 Printer.printInt("line", N->getLine());
1859 Printer.printMetadata("type", N->getRawType());
1860 Printer.printDIFlags("flags", N->getFlags());
1861 Printer.printInt("align", N->getAlignInBits());
1865 static void writeDIExpression(raw_ostream &Out, const DIExpression *N,
1866 TypePrinting *TypePrinter, SlotTracker *Machine,
1867 const Module *Context) {
1868 Out << "!DIExpression(";
1871 for (auto I = N->expr_op_begin(), E = N->expr_op_end(); I != E; ++I) {
1872 auto OpStr = dwarf::OperationEncodingString(I->getOp());
1873 assert(!OpStr.empty() && "Expected valid opcode");
1876 for (unsigned A = 0, AE = I->getNumArgs(); A != AE; ++A)
1877 Out << FS << I->getArg(A);
1880 for (const auto &I : N->getElements())
1886 static void writeDIGlobalVariableExpression(raw_ostream &Out,
1887 const DIGlobalVariableExpression *N,
1888 TypePrinting *TypePrinter,
1889 SlotTracker *Machine,
1890 const Module *Context) {
1891 Out << "!DIGlobalVariableExpression(";
1892 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1893 Printer.printMetadata("var", N->getVariable());
1894 Printer.printMetadata("expr", N->getExpression());
1898 static void writeDIObjCProperty(raw_ostream &Out, const DIObjCProperty *N,
1899 TypePrinting *TypePrinter, SlotTracker *Machine,
1900 const Module *Context) {
1901 Out << "!DIObjCProperty(";
1902 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1903 Printer.printString("name", N->getName());
1904 Printer.printMetadata("file", N->getRawFile());
1905 Printer.printInt("line", N->getLine());
1906 Printer.printString("setter", N->getSetterName());
1907 Printer.printString("getter", N->getGetterName());
1908 Printer.printInt("attributes", N->getAttributes());
1909 Printer.printMetadata("type", N->getRawType());
1913 static void writeDIImportedEntity(raw_ostream &Out, const DIImportedEntity *N,
1914 TypePrinting *TypePrinter,
1915 SlotTracker *Machine, const Module *Context) {
1916 Out << "!DIImportedEntity(";
1917 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1918 Printer.printTag(N);
1919 Printer.printString("name", N->getName());
1920 Printer.printMetadata("scope", N->getRawScope(), /* ShouldSkipNull */ false);
1921 Printer.printMetadata("entity", N->getRawEntity());
1922 Printer.printInt("line", N->getLine());
1927 static void WriteMDNodeBodyInternal(raw_ostream &Out, const MDNode *Node,
1928 TypePrinting *TypePrinter,
1929 SlotTracker *Machine,
1930 const Module *Context) {
1931 if (Node->isDistinct())
1933 else if (Node->isTemporary())
1934 Out << "<temporary!> "; // Handle broken code.
1936 switch (Node->getMetadataID()) {
1938 llvm_unreachable("Expected uniquable MDNode");
1939 #define HANDLE_MDNODE_LEAF(CLASS) \
1940 case Metadata::CLASS##Kind: \
1941 write##CLASS(Out, cast<CLASS>(Node), TypePrinter, Machine, Context); \
1943 #include "llvm/IR/Metadata.def"
1947 // Full implementation of printing a Value as an operand with support for
1948 // TypePrinting, etc.
1949 static void WriteAsOperandInternal(raw_ostream &Out, const Value *V,
1950 TypePrinting *TypePrinter,
1951 SlotTracker *Machine,
1952 const Module *Context) {
1954 PrintLLVMName(Out, V);
1958 const Constant *CV = dyn_cast<Constant>(V);
1959 if (CV && !isa<GlobalValue>(CV)) {
1960 assert(TypePrinter && "Constants require TypePrinting!");
1961 WriteConstantInternal(Out, CV, *TypePrinter, Machine, Context);
1965 if (const InlineAsm *IA = dyn_cast<InlineAsm>(V)) {
1967 if (IA->hasSideEffects())
1968 Out << "sideeffect ";
1969 if (IA->isAlignStack())
1970 Out << "alignstack ";
1971 // We don't emit the AD_ATT dialect as it's the assumed default.
1972 if (IA->getDialect() == InlineAsm::AD_Intel)
1973 Out << "inteldialect ";
1975 PrintEscapedString(IA->getAsmString(), Out);
1977 PrintEscapedString(IA->getConstraintString(), Out);
1982 if (auto *MD = dyn_cast<MetadataAsValue>(V)) {
1983 WriteAsOperandInternal(Out, MD->getMetadata(), TypePrinter, Machine,
1984 Context, /* FromValue */ true);
1990 // If we have a SlotTracker, use it.
1992 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
1993 Slot = Machine->getGlobalSlot(GV);
1996 Slot = Machine->getLocalSlot(V);
1998 // If the local value didn't succeed, then we may be referring to a value
1999 // from a different function. Translate it, as this can happen when using
2000 // address of blocks.
2002 if ((Machine = createSlotTracker(V))) {
2003 Slot = Machine->getLocalSlot(V);
2007 } else if ((Machine = createSlotTracker(V))) {
2008 // Otherwise, create one to get the # and then destroy it.
2009 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
2010 Slot = Machine->getGlobalSlot(GV);
2013 Slot = Machine->getLocalSlot(V);
2022 Out << Prefix << Slot;
2027 static void WriteAsOperandInternal(raw_ostream &Out, const Metadata *MD,
2028 TypePrinting *TypePrinter,
2029 SlotTracker *Machine, const Module *Context,
2031 if (const MDNode *N = dyn_cast<MDNode>(MD)) {
2032 std::unique_ptr<SlotTracker> MachineStorage;
2034 MachineStorage = make_unique<SlotTracker>(Context);
2035 Machine = MachineStorage.get();
2037 int Slot = Machine->getMetadataSlot(N);
2039 // Give the pointer value instead of "badref", since this comes up all
2040 // the time when debugging.
2041 Out << "<" << N << ">";
2047 if (const MDString *MDS = dyn_cast<MDString>(MD)) {
2049 PrintEscapedString(MDS->getString(), Out);
2054 auto *V = cast<ValueAsMetadata>(MD);
2055 assert(TypePrinter && "TypePrinter required for metadata values");
2056 assert((FromValue || !isa<LocalAsMetadata>(V)) &&
2057 "Unexpected function-local metadata outside of value argument");
2059 TypePrinter->print(V->getValue()->getType(), Out);
2061 WriteAsOperandInternal(Out, V->getValue(), TypePrinter, Machine, Context);
2065 class AssemblyWriter {
2066 formatted_raw_ostream &Out;
2067 const Module *TheModule;
2068 std::unique_ptr<SlotTracker> SlotTrackerStorage;
2069 SlotTracker &Machine;
2070 TypePrinting TypePrinter;
2071 AssemblyAnnotationWriter *AnnotationWriter;
2072 SetVector<const Comdat *> Comdats;
2074 bool ShouldPreserveUseListOrder;
2075 UseListOrderStack UseListOrders;
2076 SmallVector<StringRef, 8> MDNames;
2079 /// Construct an AssemblyWriter with an external SlotTracker
2080 AssemblyWriter(formatted_raw_ostream &o, SlotTracker &Mac, const Module *M,
2081 AssemblyAnnotationWriter *AAW, bool IsForDebug,
2082 bool ShouldPreserveUseListOrder = false);
2084 void printMDNodeBody(const MDNode *MD);
2085 void printNamedMDNode(const NamedMDNode *NMD);
2087 void printModule(const Module *M);
2089 void writeOperand(const Value *Op, bool PrintType);
2090 void writeParamOperand(const Value *Operand, AttributeSet Attrs);
2091 void writeOperandBundles(ImmutableCallSite CS);
2092 void writeAtomic(AtomicOrdering Ordering, SynchronizationScope SynchScope);
2093 void writeAtomicCmpXchg(AtomicOrdering SuccessOrdering,
2094 AtomicOrdering FailureOrdering,
2095 SynchronizationScope SynchScope);
2097 void writeAllMDNodes();
2098 void writeMDNode(unsigned Slot, const MDNode *Node);
2099 void writeAllAttributeGroups();
2101 void printTypeIdentities();
2102 void printGlobal(const GlobalVariable *GV);
2103 void printIndirectSymbol(const GlobalIndirectSymbol *GIS);
2104 void printComdat(const Comdat *C);
2105 void printFunction(const Function *F);
2106 void printArgument(const Argument *FA, AttributeSet Attrs);
2107 void printBasicBlock(const BasicBlock *BB);
2108 void printInstructionLine(const Instruction &I);
2109 void printInstruction(const Instruction &I);
2111 void printUseListOrder(const UseListOrder &Order);
2112 void printUseLists(const Function *F);
2115 /// \brief Print out metadata attachments.
2116 void printMetadataAttachments(
2117 const SmallVectorImpl<std::pair<unsigned, MDNode *>> &MDs,
2118 StringRef Separator);
2120 // printInfoComment - Print a little comment after the instruction indicating
2121 // which slot it occupies.
2122 void printInfoComment(const Value &V);
2124 // printGCRelocateComment - print comment after call to the gc.relocate
2125 // intrinsic indicating base and derived pointer names.
2126 void printGCRelocateComment(const GCRelocateInst &Relocate);
2130 AssemblyWriter::AssemblyWriter(formatted_raw_ostream &o, SlotTracker &Mac,
2131 const Module *M, AssemblyAnnotationWriter *AAW,
2132 bool IsForDebug, bool ShouldPreserveUseListOrder)
2133 : Out(o), TheModule(M), Machine(Mac), AnnotationWriter(AAW),
2134 IsForDebug(IsForDebug),
2135 ShouldPreserveUseListOrder(ShouldPreserveUseListOrder) {
2138 TypePrinter.incorporateTypes(*TheModule);
2139 for (const GlobalObject &GO : TheModule->global_objects())
2140 if (const Comdat *C = GO.getComdat())
2144 void AssemblyWriter::writeOperand(const Value *Operand, bool PrintType) {
2146 Out << "<null operand!>";
2150 TypePrinter.print(Operand->getType(), Out);
2153 WriteAsOperandInternal(Out, Operand, &TypePrinter, &Machine, TheModule);
2156 void AssemblyWriter::writeAtomic(AtomicOrdering Ordering,
2157 SynchronizationScope SynchScope) {
2158 if (Ordering == AtomicOrdering::NotAtomic)
2161 switch (SynchScope) {
2162 case SingleThread: Out << " singlethread"; break;
2163 case CrossThread: break;
2166 Out << " " << toIRString(Ordering);
2169 void AssemblyWriter::writeAtomicCmpXchg(AtomicOrdering SuccessOrdering,
2170 AtomicOrdering FailureOrdering,
2171 SynchronizationScope SynchScope) {
2172 assert(SuccessOrdering != AtomicOrdering::NotAtomic &&
2173 FailureOrdering != AtomicOrdering::NotAtomic);
2175 switch (SynchScope) {
2176 case SingleThread: Out << " singlethread"; break;
2177 case CrossThread: break;
2180 Out << " " << toIRString(SuccessOrdering);
2181 Out << " " << toIRString(FailureOrdering);
2184 void AssemblyWriter::writeParamOperand(const Value *Operand,
2185 AttributeSet Attrs) {
2187 Out << "<null operand!>";
2192 TypePrinter.print(Operand->getType(), Out);
2193 // Print parameter attributes list
2194 if (Attrs.hasAttributes())
2195 Out << ' ' << Attrs.getAsString();
2197 // Print the operand
2198 WriteAsOperandInternal(Out, Operand, &TypePrinter, &Machine, TheModule);
2201 void AssemblyWriter::writeOperandBundles(ImmutableCallSite CS) {
2202 if (!CS.hasOperandBundles())
2207 bool FirstBundle = true;
2208 for (unsigned i = 0, e = CS.getNumOperandBundles(); i != e; ++i) {
2209 OperandBundleUse BU = CS.getOperandBundleAt(i);
2213 FirstBundle = false;
2216 PrintEscapedString(BU.getTagName(), Out);
2221 bool FirstInput = true;
2222 for (const auto &Input : BU.Inputs) {
2227 TypePrinter.print(Input->getType(), Out);
2229 WriteAsOperandInternal(Out, Input, &TypePrinter, &Machine, TheModule);
2238 void AssemblyWriter::printModule(const Module *M) {
2239 Machine.initialize();
2241 if (ShouldPreserveUseListOrder)
2242 UseListOrders = predictUseListOrder(M);
2244 if (!M->getModuleIdentifier().empty() &&
2245 // Don't print the ID if it will start a new line (which would
2246 // require a comment char before it).
2247 M->getModuleIdentifier().find('\n') == std::string::npos)
2248 Out << "; ModuleID = '" << M->getModuleIdentifier() << "'\n";
2250 if (!M->getSourceFileName().empty()) {
2251 Out << "source_filename = \"";
2252 PrintEscapedString(M->getSourceFileName(), Out);
2256 const std::string &DL = M->getDataLayoutStr();
2258 Out << "target datalayout = \"" << DL << "\"\n";
2259 if (!M->getTargetTriple().empty())
2260 Out << "target triple = \"" << M->getTargetTriple() << "\"\n";
2262 if (!M->getModuleInlineAsm().empty()) {
2265 // Split the string into lines, to make it easier to read the .ll file.
2266 StringRef Asm = M->getModuleInlineAsm();
2269 std::tie(Front, Asm) = Asm.split('\n');
2271 // We found a newline, print the portion of the asm string from the
2272 // last newline up to this newline.
2273 Out << "module asm \"";
2274 PrintEscapedString(Front, Out);
2276 } while (!Asm.empty());
2279 printTypeIdentities();
2281 // Output all comdats.
2282 if (!Comdats.empty())
2284 for (const Comdat *C : Comdats) {
2286 if (C != Comdats.back())
2290 // Output all globals.
2291 if (!M->global_empty()) Out << '\n';
2292 for (const GlobalVariable &GV : M->globals()) {
2293 printGlobal(&GV); Out << '\n';
2296 // Output all aliases.
2297 if (!M->alias_empty()) Out << "\n";
2298 for (const GlobalAlias &GA : M->aliases())
2299 printIndirectSymbol(&GA);
2301 // Output all ifuncs.
2302 if (!M->ifunc_empty()) Out << "\n";
2303 for (const GlobalIFunc &GI : M->ifuncs())
2304 printIndirectSymbol(&GI);
2306 // Output global use-lists.
2307 printUseLists(nullptr);
2309 // Output all of the functions.
2310 for (const Function &F : *M)
2312 assert(UseListOrders.empty() && "All use-lists should have been consumed");
2314 // Output all attribute groups.
2315 if (!Machine.as_empty()) {
2317 writeAllAttributeGroups();
2320 // Output named metadata.
2321 if (!M->named_metadata_empty()) Out << '\n';
2323 for (const NamedMDNode &Node : M->named_metadata())
2324 printNamedMDNode(&Node);
2327 if (!Machine.mdn_empty()) {
2333 static void printMetadataIdentifier(StringRef Name,
2334 formatted_raw_ostream &Out) {
2336 Out << "<empty name> ";
2338 if (isalpha(static_cast<unsigned char>(Name[0])) || Name[0] == '-' ||
2339 Name[0] == '$' || Name[0] == '.' || Name[0] == '_')
2342 Out << '\\' << hexdigit(Name[0] >> 4) << hexdigit(Name[0] & 0x0F);
2343 for (unsigned i = 1, e = Name.size(); i != e; ++i) {
2344 unsigned char C = Name[i];
2345 if (isalnum(static_cast<unsigned char>(C)) || C == '-' || C == '$' ||
2346 C == '.' || C == '_')
2349 Out << '\\' << hexdigit(C >> 4) << hexdigit(C & 0x0F);
2354 void AssemblyWriter::printNamedMDNode(const NamedMDNode *NMD) {
2356 printMetadataIdentifier(NMD->getName(), Out);
2358 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
2361 int Slot = Machine.getMetadataSlot(NMD->getOperand(i));
2370 static const char *getLinkagePrintName(GlobalValue::LinkageTypes LT) {
2372 case GlobalValue::ExternalLinkage:
2374 case GlobalValue::PrivateLinkage:
2376 case GlobalValue::InternalLinkage:
2378 case GlobalValue::LinkOnceAnyLinkage:
2380 case GlobalValue::LinkOnceODRLinkage:
2381 return "linkonce_odr ";
2382 case GlobalValue::WeakAnyLinkage:
2384 case GlobalValue::WeakODRLinkage:
2386 case GlobalValue::CommonLinkage:
2388 case GlobalValue::AppendingLinkage:
2389 return "appending ";
2390 case GlobalValue::ExternalWeakLinkage:
2391 return "extern_weak ";
2392 case GlobalValue::AvailableExternallyLinkage:
2393 return "available_externally ";
2395 llvm_unreachable("invalid linkage");
2398 static void PrintVisibility(GlobalValue::VisibilityTypes Vis,
2399 formatted_raw_ostream &Out) {
2401 case GlobalValue::DefaultVisibility: break;
2402 case GlobalValue::HiddenVisibility: Out << "hidden "; break;
2403 case GlobalValue::ProtectedVisibility: Out << "protected "; break;
2407 static void PrintDLLStorageClass(GlobalValue::DLLStorageClassTypes SCT,
2408 formatted_raw_ostream &Out) {
2410 case GlobalValue::DefaultStorageClass: break;
2411 case GlobalValue::DLLImportStorageClass: Out << "dllimport "; break;
2412 case GlobalValue::DLLExportStorageClass: Out << "dllexport "; break;
2416 static void PrintThreadLocalModel(GlobalVariable::ThreadLocalMode TLM,
2417 formatted_raw_ostream &Out) {
2419 case GlobalVariable::NotThreadLocal:
2421 case GlobalVariable::GeneralDynamicTLSModel:
2422 Out << "thread_local ";
2424 case GlobalVariable::LocalDynamicTLSModel:
2425 Out << "thread_local(localdynamic) ";
2427 case GlobalVariable::InitialExecTLSModel:
2428 Out << "thread_local(initialexec) ";
2430 case GlobalVariable::LocalExecTLSModel:
2431 Out << "thread_local(localexec) ";
2436 static StringRef getUnnamedAddrEncoding(GlobalVariable::UnnamedAddr UA) {
2438 case GlobalVariable::UnnamedAddr::None:
2440 case GlobalVariable::UnnamedAddr::Local:
2441 return "local_unnamed_addr";
2442 case GlobalVariable::UnnamedAddr::Global:
2443 return "unnamed_addr";
2445 llvm_unreachable("Unknown UnnamedAddr");
2448 static void maybePrintComdat(formatted_raw_ostream &Out,
2449 const GlobalObject &GO) {
2450 const Comdat *C = GO.getComdat();
2454 if (isa<GlobalVariable>(GO))
2458 if (GO.getName() == C->getName())
2462 PrintLLVMName(Out, C->getName(), ComdatPrefix);
2466 void AssemblyWriter::printGlobal(const GlobalVariable *GV) {
2467 if (GV->isMaterializable())
2468 Out << "; Materializable\n";
2470 WriteAsOperandInternal(Out, GV, &TypePrinter, &Machine, GV->getParent());
2473 if (!GV->hasInitializer() && GV->hasExternalLinkage())
2476 Out << getLinkagePrintName(GV->getLinkage());
2477 PrintVisibility(GV->getVisibility(), Out);
2478 PrintDLLStorageClass(GV->getDLLStorageClass(), Out);
2479 PrintThreadLocalModel(GV->getThreadLocalMode(), Out);
2480 StringRef UA = getUnnamedAddrEncoding(GV->getUnnamedAddr());
2484 if (unsigned AddressSpace = GV->getType()->getAddressSpace())
2485 Out << "addrspace(" << AddressSpace << ") ";
2486 if (GV->isExternallyInitialized()) Out << "externally_initialized ";
2487 Out << (GV->isConstant() ? "constant " : "global ");
2488 TypePrinter.print(GV->getValueType(), Out);
2490 if (GV->hasInitializer()) {
2492 writeOperand(GV->getInitializer(), false);
2495 if (GV->hasSection()) {
2496 Out << ", section \"";
2497 PrintEscapedString(GV->getSection(), Out);
2500 maybePrintComdat(Out, *GV);
2501 if (GV->getAlignment())
2502 Out << ", align " << GV->getAlignment();
2504 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
2505 GV->getAllMetadata(MDs);
2506 printMetadataAttachments(MDs, ", ");
2508 auto Attrs = GV->getAttributes();
2509 if (Attrs.hasAttributes())
2510 Out << " #" << Machine.getAttributeGroupSlot(Attrs);
2512 printInfoComment(*GV);
2515 void AssemblyWriter::printIndirectSymbol(const GlobalIndirectSymbol *GIS) {
2516 if (GIS->isMaterializable())
2517 Out << "; Materializable\n";
2519 WriteAsOperandInternal(Out, GIS, &TypePrinter, &Machine, GIS->getParent());
2522 Out << getLinkagePrintName(GIS->getLinkage());
2523 PrintVisibility(GIS->getVisibility(), Out);
2524 PrintDLLStorageClass(GIS->getDLLStorageClass(), Out);
2525 PrintThreadLocalModel(GIS->getThreadLocalMode(), Out);
2526 StringRef UA = getUnnamedAddrEncoding(GIS->getUnnamedAddr());
2530 if (isa<GlobalAlias>(GIS))
2532 else if (isa<GlobalIFunc>(GIS))
2535 llvm_unreachable("Not an alias or ifunc!");
2537 TypePrinter.print(GIS->getValueType(), Out);
2541 const Constant *IS = GIS->getIndirectSymbol();
2544 TypePrinter.print(GIS->getType(), Out);
2545 Out << " <<NULL ALIASEE>>";
2547 writeOperand(IS, !isa<ConstantExpr>(IS));
2550 printInfoComment(*GIS);
2554 void AssemblyWriter::printComdat(const Comdat *C) {
2558 void AssemblyWriter::printTypeIdentities() {
2559 if (TypePrinter.NumberedTypes.empty() &&
2560 TypePrinter.NamedTypes.empty())
2565 // We know all the numbers that each type is used and we know that it is a
2566 // dense assignment. Convert the map to an index table.
2567 std::vector<StructType*> NumberedTypes(TypePrinter.NumberedTypes.size());
2568 for (DenseMap<StructType*, unsigned>::iterator I =
2569 TypePrinter.NumberedTypes.begin(), E = TypePrinter.NumberedTypes.end();
2571 assert(I->second < NumberedTypes.size() && "Didn't get a dense numbering?");
2572 NumberedTypes[I->second] = I->first;
2575 // Emit all numbered types.
2576 for (unsigned i = 0, e = NumberedTypes.size(); i != e; ++i) {
2577 Out << '%' << i << " = type ";
2579 // Make sure we print out at least one level of the type structure, so
2580 // that we do not get %2 = type %2
2581 TypePrinter.printStructBody(NumberedTypes[i], Out);
2585 for (unsigned i = 0, e = TypePrinter.NamedTypes.size(); i != e; ++i) {
2586 PrintLLVMName(Out, TypePrinter.NamedTypes[i]->getName(), LocalPrefix);
2589 // Make sure we print out at least one level of the type structure, so
2590 // that we do not get %FILE = type %FILE
2591 TypePrinter.printStructBody(TypePrinter.NamedTypes[i], Out);
2596 /// printFunction - Print all aspects of a function.
2598 void AssemblyWriter::printFunction(const Function *F) {
2599 // Print out the return type and name.
2602 if (AnnotationWriter) AnnotationWriter->emitFunctionAnnot(F, Out);
2604 if (F->isMaterializable())
2605 Out << "; Materializable\n";
2607 const AttributeList &Attrs = F->getAttributes();
2608 if (Attrs.hasAttributes(AttributeList::FunctionIndex)) {
2609 AttributeSet AS = Attrs.getFnAttributes();
2610 std::string AttrStr;
2612 for (const Attribute &Attr : AS) {
2613 if (!Attr.isStringAttribute()) {
2614 if (!AttrStr.empty()) AttrStr += ' ';
2615 AttrStr += Attr.getAsString();
2619 if (!AttrStr.empty())
2620 Out << "; Function Attrs: " << AttrStr << '\n';
2623 Machine.incorporateFunction(F);
2625 if (F->isDeclaration()) {
2627 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
2628 F->getAllMetadata(MDs);
2629 printMetadataAttachments(MDs, " ");
2634 Out << getLinkagePrintName(F->getLinkage());
2635 PrintVisibility(F->getVisibility(), Out);
2636 PrintDLLStorageClass(F->getDLLStorageClass(), Out);
2638 // Print the calling convention.
2639 if (F->getCallingConv() != CallingConv::C) {
2640 PrintCallingConv(F->getCallingConv(), Out);
2644 FunctionType *FT = F->getFunctionType();
2645 if (Attrs.hasAttributes(AttributeList::ReturnIndex))
2646 Out << Attrs.getAsString(AttributeList::ReturnIndex) << ' ';
2647 TypePrinter.print(F->getReturnType(), Out);
2649 WriteAsOperandInternal(Out, F, &TypePrinter, &Machine, F->getParent());
2652 // Loop over the arguments, printing them...
2653 if (F->isDeclaration() && !IsForDebug) {
2654 // We're only interested in the type here - don't print argument names.
2655 for (unsigned I = 0, E = FT->getNumParams(); I != E; ++I) {
2656 // Insert commas as we go... the first arg doesn't get a comma
2660 TypePrinter.print(FT->getParamType(I), Out);
2662 AttributeSet ArgAttrs = Attrs.getParamAttributes(I);
2663 if (ArgAttrs.hasAttributes())
2664 Out << ' ' << ArgAttrs.getAsString();
2667 // The arguments are meaningful here, print them in detail.
2668 for (const Argument &Arg : F->args()) {
2669 // Insert commas as we go... the first arg doesn't get a comma
2670 if (Arg.getArgNo() != 0)
2672 printArgument(&Arg, Attrs.getParamAttributes(Arg.getArgNo()));
2676 // Finish printing arguments...
2677 if (FT->isVarArg()) {
2678 if (FT->getNumParams()) Out << ", ";
2679 Out << "..."; // Output varargs portion of signature!
2682 StringRef UA = getUnnamedAddrEncoding(F->getUnnamedAddr());
2685 if (Attrs.hasAttributes(AttributeList::FunctionIndex))
2686 Out << " #" << Machine.getAttributeGroupSlot(Attrs.getFnAttributes());
2687 if (F->hasSection()) {
2688 Out << " section \"";
2689 PrintEscapedString(F->getSection(), Out);
2692 maybePrintComdat(Out, *F);
2693 if (F->getAlignment())
2694 Out << " align " << F->getAlignment();
2696 Out << " gc \"" << F->getGC() << '"';
2697 if (F->hasPrefixData()) {
2699 writeOperand(F->getPrefixData(), true);
2701 if (F->hasPrologueData()) {
2702 Out << " prologue ";
2703 writeOperand(F->getPrologueData(), true);
2705 if (F->hasPersonalityFn()) {
2706 Out << " personality ";
2707 writeOperand(F->getPersonalityFn(), /*PrintType=*/true);
2710 if (F->isDeclaration()) {
2713 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
2714 F->getAllMetadata(MDs);
2715 printMetadataAttachments(MDs, " ");
2718 // Output all of the function's basic blocks.
2719 for (const BasicBlock &BB : *F)
2720 printBasicBlock(&BB);
2722 // Output the function's use-lists.
2728 Machine.purgeFunction();
2731 /// printArgument - This member is called for every argument that is passed into
2732 /// the function. Simply print it out
2734 void AssemblyWriter::printArgument(const Argument *Arg, AttributeSet Attrs) {
2736 TypePrinter.print(Arg->getType(), Out);
2738 // Output parameter attributes list
2739 if (Attrs.hasAttributes())
2740 Out << ' ' << Attrs.getAsString();
2742 // Output name, if available...
2743 if (Arg->hasName()) {
2745 PrintLLVMName(Out, Arg);
2749 /// printBasicBlock - This member is called for each basic block in a method.
2751 void AssemblyWriter::printBasicBlock(const BasicBlock *BB) {
2752 if (BB->hasName()) { // Print out the label if it exists...
2754 PrintLLVMName(Out, BB->getName(), LabelPrefix);
2756 } else if (!BB->use_empty()) { // Don't print block # of no uses...
2757 Out << "\n; <label>:";
2758 int Slot = Machine.getLocalSlot(BB);
2765 if (!BB->getParent()) {
2766 Out.PadToColumn(50);
2767 Out << "; Error: Block without parent!";
2768 } else if (BB != &BB->getParent()->getEntryBlock()) { // Not the entry block?
2769 // Output predecessors for the block.
2770 Out.PadToColumn(50);
2772 const_pred_iterator PI = pred_begin(BB), PE = pred_end(BB);
2775 Out << " No predecessors!";
2778 writeOperand(*PI, false);
2779 for (++PI; PI != PE; ++PI) {
2781 writeOperand(*PI, false);
2788 if (AnnotationWriter) AnnotationWriter->emitBasicBlockStartAnnot(BB, Out);
2790 // Output all of the instructions in the basic block...
2791 for (const Instruction &I : *BB) {
2792 printInstructionLine(I);
2795 if (AnnotationWriter) AnnotationWriter->emitBasicBlockEndAnnot(BB, Out);
2798 /// printInstructionLine - Print an instruction and a newline character.
2799 void AssemblyWriter::printInstructionLine(const Instruction &I) {
2800 printInstruction(I);
2804 /// printGCRelocateComment - print comment after call to the gc.relocate
2805 /// intrinsic indicating base and derived pointer names.
2806 void AssemblyWriter::printGCRelocateComment(const GCRelocateInst &Relocate) {
2808 writeOperand(Relocate.getBasePtr(), false);
2810 writeOperand(Relocate.getDerivedPtr(), false);
2814 /// printInfoComment - Print a little comment after the instruction indicating
2815 /// which slot it occupies.
2817 void AssemblyWriter::printInfoComment(const Value &V) {
2818 if (const auto *Relocate = dyn_cast<GCRelocateInst>(&V))
2819 printGCRelocateComment(*Relocate);
2821 if (AnnotationWriter)
2822 AnnotationWriter->printInfoComment(V, Out);
2825 // This member is called for each Instruction in a function..
2826 void AssemblyWriter::printInstruction(const Instruction &I) {
2827 if (AnnotationWriter) AnnotationWriter->emitInstructionAnnot(&I, Out);
2829 // Print out indentation for an instruction.
2832 // Print out name if it exists...
2834 PrintLLVMName(Out, &I);
2836 } else if (!I.getType()->isVoidTy()) {
2837 // Print out the def slot taken.
2838 int SlotNum = Machine.getLocalSlot(&I);
2840 Out << "<badref> = ";
2842 Out << '%' << SlotNum << " = ";
2845 if (const CallInst *CI = dyn_cast<CallInst>(&I)) {
2846 if (CI->isMustTailCall())
2848 else if (CI->isTailCall())
2850 else if (CI->isNoTailCall())
2854 // Print out the opcode...
2855 Out << I.getOpcodeName();
2857 // If this is an atomic load or store, print out the atomic marker.
2858 if ((isa<LoadInst>(I) && cast<LoadInst>(I).isAtomic()) ||
2859 (isa<StoreInst>(I) && cast<StoreInst>(I).isAtomic()))
2862 if (isa<AtomicCmpXchgInst>(I) && cast<AtomicCmpXchgInst>(I).isWeak())
2865 // If this is a volatile operation, print out the volatile marker.
2866 if ((isa<LoadInst>(I) && cast<LoadInst>(I).isVolatile()) ||
2867 (isa<StoreInst>(I) && cast<StoreInst>(I).isVolatile()) ||
2868 (isa<AtomicCmpXchgInst>(I) && cast<AtomicCmpXchgInst>(I).isVolatile()) ||
2869 (isa<AtomicRMWInst>(I) && cast<AtomicRMWInst>(I).isVolatile()))
2872 // Print out optimization information.
2873 WriteOptimizationInfo(Out, &I);
2875 // Print out the compare instruction predicates
2876 if (const CmpInst *CI = dyn_cast<CmpInst>(&I))
2877 Out << ' ' << CmpInst::getPredicateName(CI->getPredicate());
2879 // Print out the atomicrmw operation
2880 if (const AtomicRMWInst *RMWI = dyn_cast<AtomicRMWInst>(&I))
2881 writeAtomicRMWOperation(Out, RMWI->getOperation());
2883 // Print out the type of the operands...
2884 const Value *Operand = I.getNumOperands() ? I.getOperand(0) : nullptr;
2886 // Special case conditional branches to swizzle the condition out to the front
2887 if (isa<BranchInst>(I) && cast<BranchInst>(I).isConditional()) {
2888 const BranchInst &BI(cast<BranchInst>(I));
2890 writeOperand(BI.getCondition(), true);
2892 writeOperand(BI.getSuccessor(0), true);
2894 writeOperand(BI.getSuccessor(1), true);
2896 } else if (isa<SwitchInst>(I)) {
2897 const SwitchInst& SI(cast<SwitchInst>(I));
2898 // Special case switch instruction to get formatting nice and correct.
2900 writeOperand(SI.getCondition(), true);
2902 writeOperand(SI.getDefaultDest(), true);
2904 for (auto Case : SI.cases()) {
2906 writeOperand(Case.getCaseValue(), true);
2908 writeOperand(Case.getCaseSuccessor(), true);
2911 } else if (isa<IndirectBrInst>(I)) {
2912 // Special case indirectbr instruction to get formatting nice and correct.
2914 writeOperand(Operand, true);
2917 for (unsigned i = 1, e = I.getNumOperands(); i != e; ++i) {
2920 writeOperand(I.getOperand(i), true);
2923 } else if (const PHINode *PN = dyn_cast<PHINode>(&I)) {
2925 TypePrinter.print(I.getType(), Out);
2928 for (unsigned op = 0, Eop = PN->getNumIncomingValues(); op < Eop; ++op) {
2929 if (op) Out << ", ";
2931 writeOperand(PN->getIncomingValue(op), false); Out << ", ";
2932 writeOperand(PN->getIncomingBlock(op), false); Out << " ]";
2934 } else if (const ExtractValueInst *EVI = dyn_cast<ExtractValueInst>(&I)) {
2936 writeOperand(I.getOperand(0), true);
2937 for (const unsigned *i = EVI->idx_begin(), *e = EVI->idx_end(); i != e; ++i)
2939 } else if (const InsertValueInst *IVI = dyn_cast<InsertValueInst>(&I)) {
2941 writeOperand(I.getOperand(0), true); Out << ", ";
2942 writeOperand(I.getOperand(1), true);
2943 for (const unsigned *i = IVI->idx_begin(), *e = IVI->idx_end(); i != e; ++i)
2945 } else if (const LandingPadInst *LPI = dyn_cast<LandingPadInst>(&I)) {
2947 TypePrinter.print(I.getType(), Out);
2948 if (LPI->isCleanup() || LPI->getNumClauses() != 0)
2951 if (LPI->isCleanup())
2954 for (unsigned i = 0, e = LPI->getNumClauses(); i != e; ++i) {
2955 if (i != 0 || LPI->isCleanup()) Out << "\n";
2956 if (LPI->isCatch(i))
2961 writeOperand(LPI->getClause(i), true);
2963 } else if (const auto *CatchSwitch = dyn_cast<CatchSwitchInst>(&I)) {
2965 writeOperand(CatchSwitch->getParentPad(), /*PrintType=*/false);
2968 for (const BasicBlock *PadBB : CatchSwitch->handlers()) {
2971 writeOperand(PadBB, /*PrintType=*/true);
2975 if (const BasicBlock *UnwindDest = CatchSwitch->getUnwindDest())
2976 writeOperand(UnwindDest, /*PrintType=*/true);
2979 } else if (const auto *FPI = dyn_cast<FuncletPadInst>(&I)) {
2981 writeOperand(FPI->getParentPad(), /*PrintType=*/false);
2983 for (unsigned Op = 0, NumOps = FPI->getNumArgOperands(); Op < NumOps;
2987 writeOperand(FPI->getArgOperand(Op), /*PrintType=*/true);
2990 } else if (isa<ReturnInst>(I) && !Operand) {
2992 } else if (const auto *CRI = dyn_cast<CatchReturnInst>(&I)) {
2994 writeOperand(CRI->getOperand(0), /*PrintType=*/false);
2997 writeOperand(CRI->getOperand(1), /*PrintType=*/true);
2998 } else if (const auto *CRI = dyn_cast<CleanupReturnInst>(&I)) {
3000 writeOperand(CRI->getOperand(0), /*PrintType=*/false);
3003 if (CRI->hasUnwindDest())
3004 writeOperand(CRI->getOperand(1), /*PrintType=*/true);
3007 } else if (const CallInst *CI = dyn_cast<CallInst>(&I)) {
3008 // Print the calling convention being used.
3009 if (CI->getCallingConv() != CallingConv::C) {
3011 PrintCallingConv(CI->getCallingConv(), Out);
3014 Operand = CI->getCalledValue();
3015 FunctionType *FTy = CI->getFunctionType();
3016 Type *RetTy = FTy->getReturnType();
3017 const AttributeList &PAL = CI->getAttributes();
3019 if (PAL.hasAttributes(AttributeList::ReturnIndex))
3020 Out << ' ' << PAL.getAsString(AttributeList::ReturnIndex);
3022 // If possible, print out the short form of the call instruction. We can
3023 // only do this if the first argument is a pointer to a nonvararg function,
3024 // and if the return type is not a pointer to a function.
3027 TypePrinter.print(FTy->isVarArg() ? FTy : RetTy, Out);
3029 writeOperand(Operand, false);
3031 for (unsigned op = 0, Eop = CI->getNumArgOperands(); op < Eop; ++op) {
3034 writeParamOperand(CI->getArgOperand(op), PAL.getParamAttributes(op));
3037 // Emit an ellipsis if this is a musttail call in a vararg function. This
3038 // is only to aid readability, musttail calls forward varargs by default.
3039 if (CI->isMustTailCall() && CI->getParent() &&
3040 CI->getParent()->getParent() &&
3041 CI->getParent()->getParent()->isVarArg())
3045 if (PAL.hasAttributes(AttributeList::FunctionIndex))
3046 Out << " #" << Machine.getAttributeGroupSlot(PAL.getFnAttributes());
3048 writeOperandBundles(CI);
3050 } else if (const InvokeInst *II = dyn_cast<InvokeInst>(&I)) {
3051 Operand = II->getCalledValue();
3052 FunctionType *FTy = II->getFunctionType();
3053 Type *RetTy = FTy->getReturnType();
3054 const AttributeList &PAL = II->getAttributes();
3056 // Print the calling convention being used.
3057 if (II->getCallingConv() != CallingConv::C) {
3059 PrintCallingConv(II->getCallingConv(), Out);
3062 if (PAL.hasAttributes(AttributeList::ReturnIndex))
3063 Out << ' ' << PAL.getAsString(AttributeList::ReturnIndex);
3065 // If possible, print out the short form of the invoke instruction. We can
3066 // only do this if the first argument is a pointer to a nonvararg function,
3067 // and if the return type is not a pointer to a function.
3070 TypePrinter.print(FTy->isVarArg() ? FTy : RetTy, Out);
3072 writeOperand(Operand, false);
3074 for (unsigned op = 0, Eop = II->getNumArgOperands(); op < Eop; ++op) {
3077 writeParamOperand(II->getArgOperand(op), PAL.getParamAttributes(op));
3081 if (PAL.hasAttributes(AttributeList::FunctionIndex))
3082 Out << " #" << Machine.getAttributeGroupSlot(PAL.getFnAttributes());
3084 writeOperandBundles(II);
3087 writeOperand(II->getNormalDest(), true);
3089 writeOperand(II->getUnwindDest(), true);
3091 } else if (const AllocaInst *AI = dyn_cast<AllocaInst>(&I)) {
3093 if (AI->isUsedWithInAlloca())
3095 if (AI->isSwiftError())
3096 Out << "swifterror ";
3097 TypePrinter.print(AI->getAllocatedType(), Out);
3099 // Explicitly write the array size if the code is broken, if it's an array
3100 // allocation, or if the type is not canonical for scalar allocations. The
3101 // latter case prevents the type from mutating when round-tripping through
3103 if (!AI->getArraySize() || AI->isArrayAllocation() ||
3104 !AI->getArraySize()->getType()->isIntegerTy(32)) {
3106 writeOperand(AI->getArraySize(), true);
3108 if (AI->getAlignment()) {
3109 Out << ", align " << AI->getAlignment();
3112 unsigned AddrSpace = AI->getType()->getAddressSpace();
3113 if (AddrSpace != 0) {
3114 Out << ", addrspace(" << AddrSpace << ')';
3117 } else if (isa<CastInst>(I)) {
3120 writeOperand(Operand, true); // Work with broken code
3123 TypePrinter.print(I.getType(), Out);
3124 } else if (isa<VAArgInst>(I)) {
3127 writeOperand(Operand, true); // Work with broken code
3130 TypePrinter.print(I.getType(), Out);
3131 } else if (Operand) { // Print the normal way.
3132 if (const auto *GEP = dyn_cast<GetElementPtrInst>(&I)) {
3134 TypePrinter.print(GEP->getSourceElementType(), Out);
3136 } else if (const auto *LI = dyn_cast<LoadInst>(&I)) {
3138 TypePrinter.print(LI->getType(), Out);
3142 // PrintAllTypes - Instructions who have operands of all the same type
3143 // omit the type from all but the first operand. If the instruction has
3144 // different type operands (for example br), then they are all printed.
3145 bool PrintAllTypes = false;
3146 Type *TheType = Operand->getType();
3148 // Select, Store and ShuffleVector always print all types.
3149 if (isa<SelectInst>(I) || isa<StoreInst>(I) || isa<ShuffleVectorInst>(I)
3150 || isa<ReturnInst>(I)) {
3151 PrintAllTypes = true;
3153 for (unsigned i = 1, E = I.getNumOperands(); i != E; ++i) {
3154 Operand = I.getOperand(i);
3155 // note that Operand shouldn't be null, but the test helps make dump()
3156 // more tolerant of malformed IR
3157 if (Operand && Operand->getType() != TheType) {
3158 PrintAllTypes = true; // We have differing types! Print them all!
3164 if (!PrintAllTypes) {
3166 TypePrinter.print(TheType, Out);
3170 for (unsigned i = 0, E = I.getNumOperands(); i != E; ++i) {
3172 writeOperand(I.getOperand(i), PrintAllTypes);
3176 // Print atomic ordering/alignment for memory operations
3177 if (const LoadInst *LI = dyn_cast<LoadInst>(&I)) {
3179 writeAtomic(LI->getOrdering(), LI->getSynchScope());
3180 if (LI->getAlignment())
3181 Out << ", align " << LI->getAlignment();
3182 } else if (const StoreInst *SI = dyn_cast<StoreInst>(&I)) {
3184 writeAtomic(SI->getOrdering(), SI->getSynchScope());
3185 if (SI->getAlignment())
3186 Out << ", align " << SI->getAlignment();
3187 } else if (const AtomicCmpXchgInst *CXI = dyn_cast<AtomicCmpXchgInst>(&I)) {
3188 writeAtomicCmpXchg(CXI->getSuccessOrdering(), CXI->getFailureOrdering(),
3189 CXI->getSynchScope());
3190 } else if (const AtomicRMWInst *RMWI = dyn_cast<AtomicRMWInst>(&I)) {
3191 writeAtomic(RMWI->getOrdering(), RMWI->getSynchScope());
3192 } else if (const FenceInst *FI = dyn_cast<FenceInst>(&I)) {
3193 writeAtomic(FI->getOrdering(), FI->getSynchScope());
3196 // Print Metadata info.
3197 SmallVector<std::pair<unsigned, MDNode *>, 4> InstMD;
3198 I.getAllMetadata(InstMD);
3199 printMetadataAttachments(InstMD, ", ");
3201 // Print a nice comment.
3202 printInfoComment(I);
3205 void AssemblyWriter::printMetadataAttachments(
3206 const SmallVectorImpl<std::pair<unsigned, MDNode *>> &MDs,
3207 StringRef Separator) {
3211 if (MDNames.empty())
3212 MDs[0].second->getContext().getMDKindNames(MDNames);
3214 for (const auto &I : MDs) {
3215 unsigned Kind = I.first;
3217 if (Kind < MDNames.size()) {
3219 printMetadataIdentifier(MDNames[Kind], Out);
3221 Out << "!<unknown kind #" << Kind << ">";
3223 WriteAsOperandInternal(Out, I.second, &TypePrinter, &Machine, TheModule);
3227 void AssemblyWriter::writeMDNode(unsigned Slot, const MDNode *Node) {
3228 Out << '!' << Slot << " = ";
3229 printMDNodeBody(Node);
3233 void AssemblyWriter::writeAllMDNodes() {
3234 SmallVector<const MDNode *, 16> Nodes;
3235 Nodes.resize(Machine.mdn_size());
3236 for (SlotTracker::mdn_iterator I = Machine.mdn_begin(), E = Machine.mdn_end();
3238 Nodes[I->second] = cast<MDNode>(I->first);
3240 for (unsigned i = 0, e = Nodes.size(); i != e; ++i) {
3241 writeMDNode(i, Nodes[i]);
3245 void AssemblyWriter::printMDNodeBody(const MDNode *Node) {
3246 WriteMDNodeBodyInternal(Out, Node, &TypePrinter, &Machine, TheModule);
3249 void AssemblyWriter::writeAllAttributeGroups() {
3250 std::vector<std::pair<AttributeSet, unsigned>> asVec;
3251 asVec.resize(Machine.as_size());
3253 for (SlotTracker::as_iterator I = Machine.as_begin(), E = Machine.as_end();
3255 asVec[I->second] = *I;
3257 for (const auto &I : asVec)
3258 Out << "attributes #" << I.second << " = { "
3259 << I.first.getAsString(true) << " }\n";
3262 void AssemblyWriter::printUseListOrder(const UseListOrder &Order) {
3263 bool IsInFunction = Machine.getFunction();
3267 Out << "uselistorder";
3268 if (const BasicBlock *BB =
3269 IsInFunction ? nullptr : dyn_cast<BasicBlock>(Order.V)) {
3271 writeOperand(BB->getParent(), false);
3273 writeOperand(BB, false);
3276 writeOperand(Order.V, true);
3280 assert(Order.Shuffle.size() >= 2 && "Shuffle too small");
3281 Out << Order.Shuffle[0];
3282 for (unsigned I = 1, E = Order.Shuffle.size(); I != E; ++I)
3283 Out << ", " << Order.Shuffle[I];
3287 void AssemblyWriter::printUseLists(const Function *F) {
3289 [&]() { return !UseListOrders.empty() && UseListOrders.back().F == F; };
3294 Out << "\n; uselistorder directives\n";
3296 printUseListOrder(UseListOrders.back());
3297 UseListOrders.pop_back();
3301 //===----------------------------------------------------------------------===//
3302 // External Interface declarations
3303 //===----------------------------------------------------------------------===//
3305 void Function::print(raw_ostream &ROS, AssemblyAnnotationWriter *AAW,
3306 bool ShouldPreserveUseListOrder,
3307 bool IsForDebug) const {
3308 SlotTracker SlotTable(this->getParent());
3309 formatted_raw_ostream OS(ROS);
3310 AssemblyWriter W(OS, SlotTable, this->getParent(), AAW,
3312 ShouldPreserveUseListOrder);
3313 W.printFunction(this);
3316 void Module::print(raw_ostream &ROS, AssemblyAnnotationWriter *AAW,
3317 bool ShouldPreserveUseListOrder, bool IsForDebug) const {
3318 SlotTracker SlotTable(this);
3319 formatted_raw_ostream OS(ROS);
3320 AssemblyWriter W(OS, SlotTable, this, AAW, IsForDebug,
3321 ShouldPreserveUseListOrder);
3322 W.printModule(this);
3325 void NamedMDNode::print(raw_ostream &ROS, bool IsForDebug) const {
3326 SlotTracker SlotTable(getParent());
3327 formatted_raw_ostream OS(ROS);
3328 AssemblyWriter W(OS, SlotTable, getParent(), nullptr, IsForDebug);
3329 W.printNamedMDNode(this);
3332 void NamedMDNode::print(raw_ostream &ROS, ModuleSlotTracker &MST,
3333 bool IsForDebug) const {
3334 Optional<SlotTracker> LocalST;
3335 SlotTracker *SlotTable;
3336 if (auto *ST = MST.getMachine())
3339 LocalST.emplace(getParent());
3340 SlotTable = &*LocalST;
3343 formatted_raw_ostream OS(ROS);
3344 AssemblyWriter W(OS, *SlotTable, getParent(), nullptr, IsForDebug);
3345 W.printNamedMDNode(this);
3348 void Comdat::print(raw_ostream &ROS, bool /*IsForDebug*/) const {
3349 PrintLLVMName(ROS, getName(), ComdatPrefix);
3350 ROS << " = comdat ";
3352 switch (getSelectionKind()) {
3356 case Comdat::ExactMatch:
3357 ROS << "exactmatch";
3359 case Comdat::Largest:
3362 case Comdat::NoDuplicates:
3363 ROS << "noduplicates";
3365 case Comdat::SameSize:
3373 void Type::print(raw_ostream &OS, bool /*IsForDebug*/, bool NoDetails) const {
3375 TP.print(const_cast<Type*>(this), OS);
3380 // If the type is a named struct type, print the body as well.
3381 if (StructType *STy = dyn_cast<StructType>(const_cast<Type*>(this)))
3382 if (!STy->isLiteral()) {
3384 TP.printStructBody(STy, OS);
3388 static bool isReferencingMDNode(const Instruction &I) {
3389 if (const auto *CI = dyn_cast<CallInst>(&I))
3390 if (Function *F = CI->getCalledFunction())
3391 if (F->isIntrinsic())
3392 for (auto &Op : I.operands())
3393 if (auto *V = dyn_cast_or_null<MetadataAsValue>(Op))
3394 if (isa<MDNode>(V->getMetadata()))
3399 void Value::print(raw_ostream &ROS, bool IsForDebug) const {
3400 bool ShouldInitializeAllMetadata = false;
3401 if (auto *I = dyn_cast<Instruction>(this))
3402 ShouldInitializeAllMetadata = isReferencingMDNode(*I);
3403 else if (isa<Function>(this) || isa<MetadataAsValue>(this))
3404 ShouldInitializeAllMetadata = true;
3406 ModuleSlotTracker MST(getModuleFromVal(this), ShouldInitializeAllMetadata);
3407 print(ROS, MST, IsForDebug);
3410 void Value::print(raw_ostream &ROS, ModuleSlotTracker &MST,
3411 bool IsForDebug) const {
3412 formatted_raw_ostream OS(ROS);
3413 SlotTracker EmptySlotTable(static_cast<const Module *>(nullptr));
3414 SlotTracker &SlotTable =
3415 MST.getMachine() ? *MST.getMachine() : EmptySlotTable;
3416 auto incorporateFunction = [&](const Function *F) {
3418 MST.incorporateFunction(*F);
3421 if (const Instruction *I = dyn_cast<Instruction>(this)) {
3422 incorporateFunction(I->getParent() ? I->getParent()->getParent() : nullptr);
3423 AssemblyWriter W(OS, SlotTable, getModuleFromVal(I), nullptr, IsForDebug);
3424 W.printInstruction(*I);
3425 } else if (const BasicBlock *BB = dyn_cast<BasicBlock>(this)) {
3426 incorporateFunction(BB->getParent());
3427 AssemblyWriter W(OS, SlotTable, getModuleFromVal(BB), nullptr, IsForDebug);
3428 W.printBasicBlock(BB);
3429 } else if (const GlobalValue *GV = dyn_cast<GlobalValue>(this)) {
3430 AssemblyWriter W(OS, SlotTable, GV->getParent(), nullptr, IsForDebug);
3431 if (const GlobalVariable *V = dyn_cast<GlobalVariable>(GV))
3433 else if (const Function *F = dyn_cast<Function>(GV))
3436 W.printIndirectSymbol(cast<GlobalIndirectSymbol>(GV));
3437 } else if (const MetadataAsValue *V = dyn_cast<MetadataAsValue>(this)) {
3438 V->getMetadata()->print(ROS, MST, getModuleFromVal(V));
3439 } else if (const Constant *C = dyn_cast<Constant>(this)) {
3440 TypePrinting TypePrinter;
3441 TypePrinter.print(C->getType(), OS);
3443 WriteConstantInternal(OS, C, TypePrinter, MST.getMachine(), nullptr);
3444 } else if (isa<InlineAsm>(this) || isa<Argument>(this)) {
3445 this->printAsOperand(OS, /* PrintType */ true, MST);
3447 llvm_unreachable("Unknown value to print out!");
3451 /// Print without a type, skipping the TypePrinting object.
3453 /// \return \c true iff printing was successful.
3454 static bool printWithoutType(const Value &V, raw_ostream &O,
3455 SlotTracker *Machine, const Module *M) {
3456 if (V.hasName() || isa<GlobalValue>(V) ||
3457 (!isa<Constant>(V) && !isa<MetadataAsValue>(V))) {
3458 WriteAsOperandInternal(O, &V, nullptr, Machine, M);
3464 static void printAsOperandImpl(const Value &V, raw_ostream &O, bool PrintType,
3465 ModuleSlotTracker &MST) {
3466 TypePrinting TypePrinter;
3467 if (const Module *M = MST.getModule())
3468 TypePrinter.incorporateTypes(*M);
3470 TypePrinter.print(V.getType(), O);
3474 WriteAsOperandInternal(O, &V, &TypePrinter, MST.getMachine(),
3478 void Value::printAsOperand(raw_ostream &O, bool PrintType,
3479 const Module *M) const {
3481 M = getModuleFromVal(this);
3484 if (printWithoutType(*this, O, nullptr, M))
3487 SlotTracker Machine(
3488 M, /* ShouldInitializeAllMetadata */ isa<MetadataAsValue>(this));
3489 ModuleSlotTracker MST(Machine, M);
3490 printAsOperandImpl(*this, O, PrintType, MST);
3493 void Value::printAsOperand(raw_ostream &O, bool PrintType,
3494 ModuleSlotTracker &MST) const {
3496 if (printWithoutType(*this, O, MST.getMachine(), MST.getModule()))
3499 printAsOperandImpl(*this, O, PrintType, MST);
3502 static void printMetadataImpl(raw_ostream &ROS, const Metadata &MD,
3503 ModuleSlotTracker &MST, const Module *M,
3504 bool OnlyAsOperand) {
3505 formatted_raw_ostream OS(ROS);
3507 TypePrinting TypePrinter;
3509 TypePrinter.incorporateTypes(*M);
3511 WriteAsOperandInternal(OS, &MD, &TypePrinter, MST.getMachine(), M,
3512 /* FromValue */ true);
3514 auto *N = dyn_cast<MDNode>(&MD);
3515 if (OnlyAsOperand || !N)
3519 WriteMDNodeBodyInternal(OS, N, &TypePrinter, MST.getMachine(), M);
3522 void Metadata::printAsOperand(raw_ostream &OS, const Module *M) const {
3523 ModuleSlotTracker MST(M, isa<MDNode>(this));
3524 printMetadataImpl(OS, *this, MST, M, /* OnlyAsOperand */ true);
3527 void Metadata::printAsOperand(raw_ostream &OS, ModuleSlotTracker &MST,
3528 const Module *M) const {
3529 printMetadataImpl(OS, *this, MST, M, /* OnlyAsOperand */ true);
3532 void Metadata::print(raw_ostream &OS, const Module *M,
3533 bool /*IsForDebug*/) const {
3534 ModuleSlotTracker MST(M, isa<MDNode>(this));
3535 printMetadataImpl(OS, *this, MST, M, /* OnlyAsOperand */ false);
3538 void Metadata::print(raw_ostream &OS, ModuleSlotTracker &MST,
3539 const Module *M, bool /*IsForDebug*/) const {
3540 printMetadataImpl(OS, *this, MST, M, /* OnlyAsOperand */ false);
3543 #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
3544 // Value::dump - allow easy printing of Values from the debugger.
3546 void Value::dump() const { print(dbgs(), /*IsForDebug=*/true); dbgs() << '\n'; }
3548 // Type::dump - allow easy printing of Types from the debugger.
3550 void Type::dump() const { print(dbgs(), /*IsForDebug=*/true); dbgs() << '\n'; }
3552 // Module::dump() - Allow printing of Modules from the debugger.
3554 void Module::dump() const {
3555 print(dbgs(), nullptr,
3556 /*ShouldPreserveUseListOrder=*/false, /*IsForDebug=*/true);
3559 // \brief Allow printing of Comdats from the debugger.
3561 void Comdat::dump() const { print(dbgs(), /*IsForDebug=*/true); }
3563 // NamedMDNode::dump() - Allow printing of NamedMDNodes from the debugger.
3565 void NamedMDNode::dump() const { print(dbgs(), /*IsForDebug=*/true); }
3568 void Metadata::dump() const { dump(nullptr); }
3571 void Metadata::dump(const Module *M) const {
3572 print(dbgs(), M, /*IsForDebug=*/true);