1 //===-- AsmWriter.cpp - Printing LLVM as an assembly file -----------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This library implements the functionality defined in llvm/IR/Writer.h
12 // Note that these routines must be extremely tolerant of various errors in the
13 // LLVM code, because it can be used for debugging transformations.
15 //===----------------------------------------------------------------------===//
17 #include "llvm/ADT/DenseMap.h"
18 #include "llvm/ADT/STLExtras.h"
19 #include "llvm/ADT/SetVector.h"
20 #include "llvm/ADT/SmallString.h"
21 #include "llvm/ADT/StringExtras.h"
22 #include "llvm/IR/AssemblyAnnotationWriter.h"
23 #include "llvm/IR/CFG.h"
24 #include "llvm/IR/CallingConv.h"
25 #include "llvm/IR/Constants.h"
26 #include "llvm/IR/DebugInfo.h"
27 #include "llvm/IR/DerivedTypes.h"
28 #include "llvm/IR/IRPrintingPasses.h"
29 #include "llvm/IR/InlineAsm.h"
30 #include "llvm/IR/IntrinsicInst.h"
31 #include "llvm/IR/LLVMContext.h"
32 #include "llvm/IR/Module.h"
33 #include "llvm/IR/ModuleSlotTracker.h"
34 #include "llvm/IR/Operator.h"
35 #include "llvm/IR/Statepoint.h"
36 #include "llvm/IR/TypeFinder.h"
37 #include "llvm/IR/UseListOrder.h"
38 #include "llvm/IR/ValueSymbolTable.h"
39 #include "llvm/Support/Debug.h"
40 #include "llvm/Support/Dwarf.h"
41 #include "llvm/Support/ErrorHandling.h"
42 #include "llvm/Support/FormattedStream.h"
43 #include "llvm/Support/MathExtras.h"
44 #include "llvm/Support/raw_ostream.h"
49 // Make virtual table appear in this compilation unit.
50 AssemblyAnnotationWriter::~AssemblyAnnotationWriter() {}
52 //===----------------------------------------------------------------------===//
54 //===----------------------------------------------------------------------===//
58 DenseMap<const Value *, std::pair<unsigned, bool>> IDs;
60 unsigned size() const { return IDs.size(); }
61 std::pair<unsigned, bool> &operator[](const Value *V) { return IDs[V]; }
62 std::pair<unsigned, bool> lookup(const Value *V) const {
65 void index(const Value *V) {
66 // Explicitly sequence get-size and insert-value operations to avoid UB.
67 unsigned ID = IDs.size() + 1;
73 static void orderValue(const Value *V, OrderMap &OM) {
74 if (OM.lookup(V).first)
77 if (const Constant *C = dyn_cast<Constant>(V))
78 if (C->getNumOperands() && !isa<GlobalValue>(C))
79 for (const Value *Op : C->operands())
80 if (!isa<BasicBlock>(Op) && !isa<GlobalValue>(Op))
83 // Note: we cannot cache this lookup above, since inserting into the map
84 // changes the map's size, and thus affects the other IDs.
88 static OrderMap orderModule(const Module *M) {
89 // This needs to match the order used by ValueEnumerator::ValueEnumerator()
90 // and ValueEnumerator::incorporateFunction().
93 for (const GlobalVariable &G : M->globals()) {
94 if (G.hasInitializer())
95 if (!isa<GlobalValue>(G.getInitializer()))
96 orderValue(G.getInitializer(), OM);
99 for (const GlobalAlias &A : M->aliases()) {
100 if (!isa<GlobalValue>(A.getAliasee()))
101 orderValue(A.getAliasee(), OM);
104 for (const Function &F : *M) {
105 if (F.hasPrefixData())
106 if (!isa<GlobalValue>(F.getPrefixData()))
107 orderValue(F.getPrefixData(), OM);
109 if (F.hasPrologueData())
110 if (!isa<GlobalValue>(F.getPrologueData()))
111 orderValue(F.getPrologueData(), OM);
113 if (F.hasPersonalityFn())
114 if (!isa<GlobalValue>(F.getPersonalityFn()))
115 orderValue(F.getPersonalityFn(), OM);
119 if (F.isDeclaration())
122 for (const Argument &A : F.args())
124 for (const BasicBlock &BB : F) {
126 for (const Instruction &I : BB) {
127 for (const Value *Op : I.operands())
128 if ((isa<Constant>(*Op) && !isa<GlobalValue>(*Op)) ||
138 static void predictValueUseListOrderImpl(const Value *V, const Function *F,
139 unsigned ID, const OrderMap &OM,
140 UseListOrderStack &Stack) {
141 // Predict use-list order for this one.
142 typedef std::pair<const Use *, unsigned> Entry;
143 SmallVector<Entry, 64> List;
144 for (const Use &U : V->uses())
145 // Check if this user will be serialized.
146 if (OM.lookup(U.getUser()).first)
147 List.push_back(std::make_pair(&U, List.size()));
150 // We may have lost some users.
154 !isa<GlobalVariable>(V) && !isa<Function>(V) && !isa<BasicBlock>(V);
155 if (auto *BA = dyn_cast<BlockAddress>(V))
156 ID = OM.lookup(BA->getBasicBlock()).first;
157 std::sort(List.begin(), List.end(), [&](const Entry &L, const Entry &R) {
158 const Use *LU = L.first;
159 const Use *RU = R.first;
163 auto LID = OM.lookup(LU->getUser()).first;
164 auto RID = OM.lookup(RU->getUser()).first;
166 // If ID is 4, then expect: 7 6 5 1 2 3.
180 // LID and RID are equal, so we have different operands of the same user.
181 // Assume operands are added in order for all instructions.
184 return LU->getOperandNo() < RU->getOperandNo();
185 return LU->getOperandNo() > RU->getOperandNo();
189 List.begin(), List.end(),
190 [](const Entry &L, const Entry &R) { return L.second < R.second; }))
191 // Order is already correct.
194 // Store the shuffle.
195 Stack.emplace_back(V, F, List.size());
196 assert(List.size() == Stack.back().Shuffle.size() && "Wrong size");
197 for (size_t I = 0, E = List.size(); I != E; ++I)
198 Stack.back().Shuffle[I] = List[I].second;
201 static void predictValueUseListOrder(const Value *V, const Function *F,
202 OrderMap &OM, UseListOrderStack &Stack) {
203 auto &IDPair = OM[V];
204 assert(IDPair.first && "Unmapped value");
206 // Already predicted.
209 // Do the actual prediction.
210 IDPair.second = true;
211 if (!V->use_empty() && std::next(V->use_begin()) != V->use_end())
212 predictValueUseListOrderImpl(V, F, IDPair.first, OM, Stack);
214 // Recursive descent into constants.
215 if (const Constant *C = dyn_cast<Constant>(V))
216 if (C->getNumOperands()) // Visit GlobalValues.
217 for (const Value *Op : C->operands())
218 if (isa<Constant>(Op)) // Visit GlobalValues.
219 predictValueUseListOrder(Op, F, OM, Stack);
222 static UseListOrderStack predictUseListOrder(const Module *M) {
223 OrderMap OM = orderModule(M);
225 // Use-list orders need to be serialized after all the users have been added
226 // to a value, or else the shuffles will be incomplete. Store them per
227 // function in a stack.
229 // Aside from function order, the order of values doesn't matter much here.
230 UseListOrderStack Stack;
232 // We want to visit the functions backward now so we can list function-local
233 // constants in the last Function they're used in. Module-level constants
234 // have already been visited above.
235 for (auto I = M->rbegin(), E = M->rend(); I != E; ++I) {
236 const Function &F = *I;
237 if (F.isDeclaration())
239 for (const BasicBlock &BB : F)
240 predictValueUseListOrder(&BB, &F, OM, Stack);
241 for (const Argument &A : F.args())
242 predictValueUseListOrder(&A, &F, OM, Stack);
243 for (const BasicBlock &BB : F)
244 for (const Instruction &I : BB)
245 for (const Value *Op : I.operands())
246 if (isa<Constant>(*Op) || isa<InlineAsm>(*Op)) // Visit GlobalValues.
247 predictValueUseListOrder(Op, &F, OM, Stack);
248 for (const BasicBlock &BB : F)
249 for (const Instruction &I : BB)
250 predictValueUseListOrder(&I, &F, OM, Stack);
253 // Visit globals last.
254 for (const GlobalVariable &G : M->globals())
255 predictValueUseListOrder(&G, nullptr, OM, Stack);
256 for (const Function &F : *M)
257 predictValueUseListOrder(&F, nullptr, OM, Stack);
258 for (const GlobalAlias &A : M->aliases())
259 predictValueUseListOrder(&A, nullptr, OM, Stack);
260 for (const GlobalVariable &G : M->globals())
261 if (G.hasInitializer())
262 predictValueUseListOrder(G.getInitializer(), nullptr, OM, Stack);
263 for (const GlobalAlias &A : M->aliases())
264 predictValueUseListOrder(A.getAliasee(), nullptr, OM, Stack);
265 for (const Function &F : *M)
266 if (F.hasPrefixData())
267 predictValueUseListOrder(F.getPrefixData(), nullptr, OM, Stack);
272 static const Module *getModuleFromVal(const Value *V) {
273 if (const Argument *MA = dyn_cast<Argument>(V))
274 return MA->getParent() ? MA->getParent()->getParent() : nullptr;
276 if (const BasicBlock *BB = dyn_cast<BasicBlock>(V))
277 return BB->getParent() ? BB->getParent()->getParent() : nullptr;
279 if (const Instruction *I = dyn_cast<Instruction>(V)) {
280 const Function *M = I->getParent() ? I->getParent()->getParent() : nullptr;
281 return M ? M->getParent() : nullptr;
284 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V))
285 return GV->getParent();
287 if (const auto *MAV = dyn_cast<MetadataAsValue>(V)) {
288 for (const User *U : MAV->users())
289 if (isa<Instruction>(U))
290 if (const Module *M = getModuleFromVal(U))
298 static void PrintCallingConv(unsigned cc, raw_ostream &Out) {
300 default: Out << "cc" << cc; break;
301 case CallingConv::Fast: Out << "fastcc"; break;
302 case CallingConv::Cold: Out << "coldcc"; break;
303 case CallingConv::WebKit_JS: Out << "webkit_jscc"; break;
304 case CallingConv::AnyReg: Out << "anyregcc"; break;
305 case CallingConv::PreserveMost: Out << "preserve_mostcc"; break;
306 case CallingConv::PreserveAll: Out << "preserve_allcc"; break;
307 case CallingConv::GHC: Out << "ghccc"; break;
308 case CallingConv::X86_StdCall: Out << "x86_stdcallcc"; break;
309 case CallingConv::X86_FastCall: Out << "x86_fastcallcc"; break;
310 case CallingConv::X86_ThisCall: Out << "x86_thiscallcc"; break;
311 case CallingConv::X86_VectorCall:Out << "x86_vectorcallcc"; break;
312 case CallingConv::Intel_OCL_BI: Out << "intel_ocl_bicc"; break;
313 case CallingConv::ARM_APCS: Out << "arm_apcscc"; break;
314 case CallingConv::ARM_AAPCS: Out << "arm_aapcscc"; break;
315 case CallingConv::ARM_AAPCS_VFP: Out << "arm_aapcs_vfpcc"; break;
316 case CallingConv::MSP430_INTR: Out << "msp430_intrcc"; break;
317 case CallingConv::PTX_Kernel: Out << "ptx_kernel"; break;
318 case CallingConv::PTX_Device: Out << "ptx_device"; break;
319 case CallingConv::X86_64_SysV: Out << "x86_64_sysvcc"; break;
320 case CallingConv::X86_64_Win64: Out << "x86_64_win64cc"; break;
321 case CallingConv::SPIR_FUNC: Out << "spir_func"; break;
322 case CallingConv::SPIR_KERNEL: Out << "spir_kernel"; break;
326 // PrintEscapedString - Print each character of the specified string, escaping
327 // it if it is not printable or if it is an escape char.
328 static void PrintEscapedString(StringRef Name, raw_ostream &Out) {
329 for (unsigned i = 0, e = Name.size(); i != e; ++i) {
330 unsigned char C = Name[i];
331 if (isprint(C) && C != '\\' && C != '"')
334 Out << '\\' << hexdigit(C >> 4) << hexdigit(C & 0x0F);
346 /// PrintLLVMName - Turn the specified name into an 'LLVM name', which is either
347 /// prefixed with % (if the string only contains simple characters) or is
348 /// surrounded with ""'s (if it has special chars in it). Print it out.
349 static void PrintLLVMName(raw_ostream &OS, StringRef Name, PrefixType Prefix) {
350 assert(!Name.empty() && "Cannot get empty name!");
352 case NoPrefix: break;
353 case GlobalPrefix: OS << '@'; break;
354 case ComdatPrefix: OS << '$'; break;
355 case LabelPrefix: break;
356 case LocalPrefix: OS << '%'; break;
359 // Scan the name to see if it needs quotes first.
360 bool NeedsQuotes = isdigit(static_cast<unsigned char>(Name[0]));
362 for (unsigned i = 0, e = Name.size(); i != e; ++i) {
363 // By making this unsigned, the value passed in to isalnum will always be
364 // in the range 0-255. This is important when building with MSVC because
365 // its implementation will assert. This situation can arise when dealing
366 // with UTF-8 multibyte characters.
367 unsigned char C = Name[i];
368 if (!isalnum(static_cast<unsigned char>(C)) && C != '-' && C != '.' &&
376 // If we didn't need any quotes, just write out the name in one blast.
382 // Okay, we need quotes. Output the quotes and escape any scary characters as
385 PrintEscapedString(Name, OS);
389 /// PrintLLVMName - Turn the specified name into an 'LLVM name', which is either
390 /// prefixed with % (if the string only contains simple characters) or is
391 /// surrounded with ""'s (if it has special chars in it). Print it out.
392 static void PrintLLVMName(raw_ostream &OS, const Value *V) {
393 PrintLLVMName(OS, V->getName(),
394 isa<GlobalValue>(V) ? GlobalPrefix : LocalPrefix);
400 TypePrinting(const TypePrinting &) = delete;
401 void operator=(const TypePrinting&) = delete;
404 /// NamedTypes - The named types that are used by the current module.
405 TypeFinder NamedTypes;
407 /// NumberedTypes - The numbered types, along with their value.
408 DenseMap<StructType*, unsigned> NumberedTypes;
410 TypePrinting() = default;
412 void incorporateTypes(const Module &M);
414 void print(Type *Ty, raw_ostream &OS);
416 void printStructBody(StructType *Ty, raw_ostream &OS);
420 void TypePrinting::incorporateTypes(const Module &M) {
421 NamedTypes.run(M, false);
423 // The list of struct types we got back includes all the struct types, split
424 // the unnamed ones out to a numbering and remove the anonymous structs.
425 unsigned NextNumber = 0;
427 std::vector<StructType*>::iterator NextToUse = NamedTypes.begin(), I, E;
428 for (I = NamedTypes.begin(), E = NamedTypes.end(); I != E; ++I) {
429 StructType *STy = *I;
431 // Ignore anonymous types.
432 if (STy->isLiteral())
435 if (STy->getName().empty())
436 NumberedTypes[STy] = NextNumber++;
441 NamedTypes.erase(NextToUse, NamedTypes.end());
445 /// CalcTypeName - Write the specified type to the specified raw_ostream, making
446 /// use of type names or up references to shorten the type name where possible.
447 void TypePrinting::print(Type *Ty, raw_ostream &OS) {
448 switch (Ty->getTypeID()) {
449 case Type::VoidTyID: OS << "void"; return;
450 case Type::HalfTyID: OS << "half"; return;
451 case Type::FloatTyID: OS << "float"; return;
452 case Type::DoubleTyID: OS << "double"; return;
453 case Type::X86_FP80TyID: OS << "x86_fp80"; return;
454 case Type::FP128TyID: OS << "fp128"; return;
455 case Type::PPC_FP128TyID: OS << "ppc_fp128"; return;
456 case Type::LabelTyID: OS << "label"; return;
457 case Type::MetadataTyID: OS << "metadata"; return;
458 case Type::X86_MMXTyID: OS << "x86_mmx"; return;
459 case Type::IntegerTyID:
460 OS << 'i' << cast<IntegerType>(Ty)->getBitWidth();
463 case Type::FunctionTyID: {
464 FunctionType *FTy = cast<FunctionType>(Ty);
465 print(FTy->getReturnType(), OS);
467 for (FunctionType::param_iterator I = FTy->param_begin(),
468 E = FTy->param_end(); I != E; ++I) {
469 if (I != FTy->param_begin())
473 if (FTy->isVarArg()) {
474 if (FTy->getNumParams()) OS << ", ";
480 case Type::StructTyID: {
481 StructType *STy = cast<StructType>(Ty);
483 if (STy->isLiteral())
484 return printStructBody(STy, OS);
486 if (!STy->getName().empty())
487 return PrintLLVMName(OS, STy->getName(), LocalPrefix);
489 DenseMap<StructType*, unsigned>::iterator I = NumberedTypes.find(STy);
490 if (I != NumberedTypes.end())
491 OS << '%' << I->second;
492 else // Not enumerated, print the hex address.
493 OS << "%\"type " << STy << '\"';
496 case Type::PointerTyID: {
497 PointerType *PTy = cast<PointerType>(Ty);
498 print(PTy->getElementType(), OS);
499 if (unsigned AddressSpace = PTy->getAddressSpace())
500 OS << " addrspace(" << AddressSpace << ')';
504 case Type::ArrayTyID: {
505 ArrayType *ATy = cast<ArrayType>(Ty);
506 OS << '[' << ATy->getNumElements() << " x ";
507 print(ATy->getElementType(), OS);
511 case Type::VectorTyID: {
512 VectorType *PTy = cast<VectorType>(Ty);
513 OS << "<" << PTy->getNumElements() << " x ";
514 print(PTy->getElementType(), OS);
519 llvm_unreachable("Invalid TypeID");
522 void TypePrinting::printStructBody(StructType *STy, raw_ostream &OS) {
523 if (STy->isOpaque()) {
531 if (STy->getNumElements() == 0) {
534 StructType::element_iterator I = STy->element_begin();
537 for (StructType::element_iterator E = STy->element_end(); I != E; ++I) {
549 //===----------------------------------------------------------------------===//
550 // SlotTracker Class: Enumerate slot numbers for unnamed values
551 //===----------------------------------------------------------------------===//
552 /// This class provides computation of slot numbers for LLVM Assembly writing.
556 /// ValueMap - A mapping of Values to slot numbers.
557 typedef DenseMap<const Value*, unsigned> ValueMap;
560 /// TheModule - The module for which we are holding slot numbers.
561 const Module* TheModule;
563 /// TheFunction - The function for which we are holding slot numbers.
564 const Function* TheFunction;
565 bool FunctionProcessed;
566 bool ShouldInitializeAllMetadata;
568 /// mMap - The slot map for the module level data.
572 /// fMap - The slot map for the function level data.
576 /// mdnMap - Map for MDNodes.
577 DenseMap<const MDNode*, unsigned> mdnMap;
580 /// asMap - The slot map for attribute sets.
581 DenseMap<AttributeSet, unsigned> asMap;
584 /// Construct from a module.
586 /// If \c ShouldInitializeAllMetadata, initializes all metadata in all
587 /// functions, giving correct numbering for metadata referenced only from
588 /// within a function (even if no functions have been initialized).
589 explicit SlotTracker(const Module *M,
590 bool ShouldInitializeAllMetadata = false);
591 /// Construct from a function, starting out in incorp state.
593 /// If \c ShouldInitializeAllMetadata, initializes all metadata in all
594 /// functions, giving correct numbering for metadata referenced only from
595 /// within a function (even if no functions have been initialized).
596 explicit SlotTracker(const Function *F,
597 bool ShouldInitializeAllMetadata = false);
599 /// Return the slot number of the specified value in it's type
600 /// plane. If something is not in the SlotTracker, return -1.
601 int getLocalSlot(const Value *V);
602 int getGlobalSlot(const GlobalValue *V);
603 int getMetadataSlot(const MDNode *N);
604 int getAttributeGroupSlot(AttributeSet AS);
606 /// If you'd like to deal with a function instead of just a module, use
607 /// this method to get its data into the SlotTracker.
608 void incorporateFunction(const Function *F) {
610 FunctionProcessed = false;
613 const Function *getFunction() const { return TheFunction; }
615 /// After calling incorporateFunction, use this method to remove the
616 /// most recently incorporated function from the SlotTracker. This
617 /// will reset the state of the machine back to just the module contents.
618 void purgeFunction();
620 /// MDNode map iterators.
621 typedef DenseMap<const MDNode*, unsigned>::iterator mdn_iterator;
622 mdn_iterator mdn_begin() { return mdnMap.begin(); }
623 mdn_iterator mdn_end() { return mdnMap.end(); }
624 unsigned mdn_size() const { return mdnMap.size(); }
625 bool mdn_empty() const { return mdnMap.empty(); }
627 /// AttributeSet map iterators.
628 typedef DenseMap<AttributeSet, unsigned>::iterator as_iterator;
629 as_iterator as_begin() { return asMap.begin(); }
630 as_iterator as_end() { return asMap.end(); }
631 unsigned as_size() const { return asMap.size(); }
632 bool as_empty() const { return asMap.empty(); }
634 /// This function does the actual initialization.
635 inline void initialize();
637 // Implementation Details
639 /// CreateModuleSlot - Insert the specified GlobalValue* into the slot table.
640 void CreateModuleSlot(const GlobalValue *V);
642 /// CreateMetadataSlot - Insert the specified MDNode* into the slot table.
643 void CreateMetadataSlot(const MDNode *N);
645 /// CreateFunctionSlot - Insert the specified Value* into the slot table.
646 void CreateFunctionSlot(const Value *V);
648 /// \brief Insert the specified AttributeSet into the slot table.
649 void CreateAttributeSetSlot(AttributeSet AS);
651 /// Add all of the module level global variables (and their initializers)
652 /// and function declarations, but not the contents of those functions.
653 void processModule();
655 /// Add all of the functions arguments, basic blocks, and instructions.
656 void processFunction();
658 /// Add all of the metadata from a function.
659 void processFunctionMetadata(const Function &F);
661 /// Add all of the metadata from an instruction.
662 void processInstructionMetadata(const Instruction &I);
664 SlotTracker(const SlotTracker &) = delete;
665 void operator=(const SlotTracker &) = delete;
669 ModuleSlotTracker::ModuleSlotTracker(SlotTracker &Machine, const Module *M,
671 : M(M), F(F), Machine(&Machine) {}
673 ModuleSlotTracker::ModuleSlotTracker(const Module *M)
675 M ? new SlotTracker(M, /* ShouldInitializeAllMetadata */ true)
677 M(M), Machine(MachineStorage.get()) {}
679 ModuleSlotTracker::~ModuleSlotTracker() {}
681 void ModuleSlotTracker::incorporateFunction(const Function &F) {
685 // Nothing to do if this is the right function already.
689 Machine->purgeFunction();
690 Machine->incorporateFunction(&F);
694 static SlotTracker *createSlotTracker(const Module *M) {
695 return new SlotTracker(M);
698 static SlotTracker *createSlotTracker(const Value *V) {
699 if (const Argument *FA = dyn_cast<Argument>(V))
700 return new SlotTracker(FA->getParent());
702 if (const Instruction *I = dyn_cast<Instruction>(V))
704 return new SlotTracker(I->getParent()->getParent());
706 if (const BasicBlock *BB = dyn_cast<BasicBlock>(V))
707 return new SlotTracker(BB->getParent());
709 if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(V))
710 return new SlotTracker(GV->getParent());
712 if (const GlobalAlias *GA = dyn_cast<GlobalAlias>(V))
713 return new SlotTracker(GA->getParent());
715 if (const Function *Func = dyn_cast<Function>(V))
716 return new SlotTracker(Func);
722 #define ST_DEBUG(X) dbgs() << X
727 // Module level constructor. Causes the contents of the Module (sans functions)
728 // to be added to the slot table.
729 SlotTracker::SlotTracker(const Module *M, bool ShouldInitializeAllMetadata)
730 : TheModule(M), TheFunction(nullptr), FunctionProcessed(false),
731 ShouldInitializeAllMetadata(ShouldInitializeAllMetadata), mNext(0),
732 fNext(0), mdnNext(0), asNext(0) {}
734 // Function level constructor. Causes the contents of the Module and the one
735 // function provided to be added to the slot table.
736 SlotTracker::SlotTracker(const Function *F, bool ShouldInitializeAllMetadata)
737 : TheModule(F ? F->getParent() : nullptr), TheFunction(F),
738 FunctionProcessed(false),
739 ShouldInitializeAllMetadata(ShouldInitializeAllMetadata), mNext(0),
740 fNext(0), mdnNext(0), asNext(0) {}
742 inline void SlotTracker::initialize() {
745 TheModule = nullptr; ///< Prevent re-processing next time we're called.
748 if (TheFunction && !FunctionProcessed)
752 // Iterate through all the global variables, functions, and global
753 // variable initializers and create slots for them.
754 void SlotTracker::processModule() {
755 ST_DEBUG("begin processModule!\n");
757 // Add all of the unnamed global variables to the value table.
758 for (const GlobalVariable &Var : TheModule->globals()) {
760 CreateModuleSlot(&Var);
763 for (const GlobalAlias &A : TheModule->aliases()) {
765 CreateModuleSlot(&A);
768 // Add metadata used by named metadata.
769 for (const NamedMDNode &NMD : TheModule->named_metadata()) {
770 for (unsigned i = 0, e = NMD.getNumOperands(); i != e; ++i)
771 CreateMetadataSlot(NMD.getOperand(i));
774 for (const Function &F : *TheModule) {
776 // Add all the unnamed functions to the table.
777 CreateModuleSlot(&F);
779 if (ShouldInitializeAllMetadata)
780 processFunctionMetadata(F);
782 // Add all the function attributes to the table.
783 // FIXME: Add attributes of other objects?
784 AttributeSet FnAttrs = F.getAttributes().getFnAttributes();
785 if (FnAttrs.hasAttributes(AttributeSet::FunctionIndex))
786 CreateAttributeSetSlot(FnAttrs);
789 ST_DEBUG("end processModule!\n");
792 // Process the arguments, basic blocks, and instructions of a function.
793 void SlotTracker::processFunction() {
794 ST_DEBUG("begin processFunction!\n");
797 // Add all the function arguments with no names.
798 for(Function::const_arg_iterator AI = TheFunction->arg_begin(),
799 AE = TheFunction->arg_end(); AI != AE; ++AI)
801 CreateFunctionSlot(AI);
803 ST_DEBUG("Inserting Instructions:\n");
805 // Add all of the basic blocks and instructions with no names.
806 for (auto &BB : *TheFunction) {
808 CreateFunctionSlot(&BB);
810 processFunctionMetadata(*TheFunction);
813 if (!I.getType()->isVoidTy() && !I.hasName())
814 CreateFunctionSlot(&I);
816 // We allow direct calls to any llvm.foo function here, because the
817 // target may not be linked into the optimizer.
818 if (const CallInst *CI = dyn_cast<CallInst>(&I)) {
819 // Add all the call attributes to the table.
820 AttributeSet Attrs = CI->getAttributes().getFnAttributes();
821 if (Attrs.hasAttributes(AttributeSet::FunctionIndex))
822 CreateAttributeSetSlot(Attrs);
823 } else if (const InvokeInst *II = dyn_cast<InvokeInst>(&I)) {
824 // Add all the call attributes to the table.
825 AttributeSet Attrs = II->getAttributes().getFnAttributes();
826 if (Attrs.hasAttributes(AttributeSet::FunctionIndex))
827 CreateAttributeSetSlot(Attrs);
832 FunctionProcessed = true;
834 ST_DEBUG("end processFunction!\n");
837 void SlotTracker::processFunctionMetadata(const Function &F) {
838 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
840 F.getAllMetadata(MDs);
842 CreateMetadataSlot(MD.second);
845 processInstructionMetadata(I);
849 void SlotTracker::processInstructionMetadata(const Instruction &I) {
850 // Process metadata used directly by intrinsics.
851 if (const CallInst *CI = dyn_cast<CallInst>(&I))
852 if (Function *F = CI->getCalledFunction())
853 if (F->isIntrinsic())
854 for (auto &Op : I.operands())
855 if (auto *V = dyn_cast_or_null<MetadataAsValue>(Op))
856 if (MDNode *N = dyn_cast<MDNode>(V->getMetadata()))
857 CreateMetadataSlot(N);
859 // Process metadata attached to this instruction.
860 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
861 I.getAllMetadata(MDs);
863 CreateMetadataSlot(MD.second);
866 /// Clean up after incorporating a function. This is the only way to get out of
867 /// the function incorporation state that affects get*Slot/Create*Slot. Function
868 /// incorporation state is indicated by TheFunction != 0.
869 void SlotTracker::purgeFunction() {
870 ST_DEBUG("begin purgeFunction!\n");
871 fMap.clear(); // Simply discard the function level map
872 TheFunction = nullptr;
873 FunctionProcessed = false;
874 ST_DEBUG("end purgeFunction!\n");
877 /// getGlobalSlot - Get the slot number of a global value.
878 int SlotTracker::getGlobalSlot(const GlobalValue *V) {
879 // Check for uninitialized state and do lazy initialization.
882 // Find the value in the module map
883 ValueMap::iterator MI = mMap.find(V);
884 return MI == mMap.end() ? -1 : (int)MI->second;
887 /// getMetadataSlot - Get the slot number of a MDNode.
888 int SlotTracker::getMetadataSlot(const MDNode *N) {
889 // Check for uninitialized state and do lazy initialization.
892 // Find the MDNode in the module map
893 mdn_iterator MI = mdnMap.find(N);
894 return MI == mdnMap.end() ? -1 : (int)MI->second;
898 /// getLocalSlot - Get the slot number for a value that is local to a function.
899 int SlotTracker::getLocalSlot(const Value *V) {
900 assert(!isa<Constant>(V) && "Can't get a constant or global slot with this!");
902 // Check for uninitialized state and do lazy initialization.
905 ValueMap::iterator FI = fMap.find(V);
906 return FI == fMap.end() ? -1 : (int)FI->second;
909 int SlotTracker::getAttributeGroupSlot(AttributeSet AS) {
910 // Check for uninitialized state and do lazy initialization.
913 // Find the AttributeSet in the module map.
914 as_iterator AI = asMap.find(AS);
915 return AI == asMap.end() ? -1 : (int)AI->second;
918 /// CreateModuleSlot - Insert the specified GlobalValue* into the slot table.
919 void SlotTracker::CreateModuleSlot(const GlobalValue *V) {
920 assert(V && "Can't insert a null Value into SlotTracker!");
921 assert(!V->getType()->isVoidTy() && "Doesn't need a slot!");
922 assert(!V->hasName() && "Doesn't need a slot!");
924 unsigned DestSlot = mNext++;
927 ST_DEBUG(" Inserting value [" << V->getType() << "] = " << V << " slot=" <<
929 // G = Global, F = Function, A = Alias, o = other
930 ST_DEBUG((isa<GlobalVariable>(V) ? 'G' :
931 (isa<Function>(V) ? 'F' :
932 (isa<GlobalAlias>(V) ? 'A' : 'o'))) << "]\n");
935 /// CreateSlot - Create a new slot for the specified value if it has no name.
936 void SlotTracker::CreateFunctionSlot(const Value *V) {
937 assert(!V->getType()->isVoidTy() && !V->hasName() && "Doesn't need a slot!");
939 unsigned DestSlot = fNext++;
942 // G = Global, F = Function, o = other
943 ST_DEBUG(" Inserting value [" << V->getType() << "] = " << V << " slot=" <<
944 DestSlot << " [o]\n");
947 /// CreateModuleSlot - Insert the specified MDNode* into the slot table.
948 void SlotTracker::CreateMetadataSlot(const MDNode *N) {
949 assert(N && "Can't insert a null Value into SlotTracker!");
951 unsigned DestSlot = mdnNext;
952 if (!mdnMap.insert(std::make_pair(N, DestSlot)).second)
956 // Recursively add any MDNodes referenced by operands.
957 for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i)
958 if (const MDNode *Op = dyn_cast_or_null<MDNode>(N->getOperand(i)))
959 CreateMetadataSlot(Op);
962 void SlotTracker::CreateAttributeSetSlot(AttributeSet AS) {
963 assert(AS.hasAttributes(AttributeSet::FunctionIndex) &&
964 "Doesn't need a slot!");
966 as_iterator I = asMap.find(AS);
967 if (I != asMap.end())
970 unsigned DestSlot = asNext++;
971 asMap[AS] = DestSlot;
974 //===----------------------------------------------------------------------===//
975 // AsmWriter Implementation
976 //===----------------------------------------------------------------------===//
978 static void WriteAsOperandInternal(raw_ostream &Out, const Value *V,
979 TypePrinting *TypePrinter,
980 SlotTracker *Machine,
981 const Module *Context);
983 static void WriteAsOperandInternal(raw_ostream &Out, const Metadata *MD,
984 TypePrinting *TypePrinter,
985 SlotTracker *Machine, const Module *Context,
986 bool FromValue = false);
988 static const char *getPredicateText(unsigned predicate) {
989 const char * pred = "unknown";
991 case FCmpInst::FCMP_FALSE: pred = "false"; break;
992 case FCmpInst::FCMP_OEQ: pred = "oeq"; break;
993 case FCmpInst::FCMP_OGT: pred = "ogt"; break;
994 case FCmpInst::FCMP_OGE: pred = "oge"; break;
995 case FCmpInst::FCMP_OLT: pred = "olt"; break;
996 case FCmpInst::FCMP_OLE: pred = "ole"; break;
997 case FCmpInst::FCMP_ONE: pred = "one"; break;
998 case FCmpInst::FCMP_ORD: pred = "ord"; break;
999 case FCmpInst::FCMP_UNO: pred = "uno"; break;
1000 case FCmpInst::FCMP_UEQ: pred = "ueq"; break;
1001 case FCmpInst::FCMP_UGT: pred = "ugt"; break;
1002 case FCmpInst::FCMP_UGE: pred = "uge"; break;
1003 case FCmpInst::FCMP_ULT: pred = "ult"; break;
1004 case FCmpInst::FCMP_ULE: pred = "ule"; break;
1005 case FCmpInst::FCMP_UNE: pred = "une"; break;
1006 case FCmpInst::FCMP_TRUE: pred = "true"; break;
1007 case ICmpInst::ICMP_EQ: pred = "eq"; break;
1008 case ICmpInst::ICMP_NE: pred = "ne"; break;
1009 case ICmpInst::ICMP_SGT: pred = "sgt"; break;
1010 case ICmpInst::ICMP_SGE: pred = "sge"; break;
1011 case ICmpInst::ICMP_SLT: pred = "slt"; break;
1012 case ICmpInst::ICMP_SLE: pred = "sle"; break;
1013 case ICmpInst::ICMP_UGT: pred = "ugt"; break;
1014 case ICmpInst::ICMP_UGE: pred = "uge"; break;
1015 case ICmpInst::ICMP_ULT: pred = "ult"; break;
1016 case ICmpInst::ICMP_ULE: pred = "ule"; break;
1021 static void writeAtomicRMWOperation(raw_ostream &Out,
1022 AtomicRMWInst::BinOp Op) {
1024 default: Out << " <unknown operation " << Op << ">"; break;
1025 case AtomicRMWInst::Xchg: Out << " xchg"; break;
1026 case AtomicRMWInst::Add: Out << " add"; break;
1027 case AtomicRMWInst::Sub: Out << " sub"; break;
1028 case AtomicRMWInst::And: Out << " and"; break;
1029 case AtomicRMWInst::Nand: Out << " nand"; break;
1030 case AtomicRMWInst::Or: Out << " or"; break;
1031 case AtomicRMWInst::Xor: Out << " xor"; break;
1032 case AtomicRMWInst::Max: Out << " max"; break;
1033 case AtomicRMWInst::Min: Out << " min"; break;
1034 case AtomicRMWInst::UMax: Out << " umax"; break;
1035 case AtomicRMWInst::UMin: Out << " umin"; break;
1039 static void WriteOptimizationInfo(raw_ostream &Out, const User *U) {
1040 if (const FPMathOperator *FPO = dyn_cast<const FPMathOperator>(U)) {
1041 // Unsafe algebra implies all the others, no need to write them all out
1042 if (FPO->hasUnsafeAlgebra())
1045 if (FPO->hasNoNaNs())
1047 if (FPO->hasNoInfs())
1049 if (FPO->hasNoSignedZeros())
1051 if (FPO->hasAllowReciprocal())
1056 if (const OverflowingBinaryOperator *OBO =
1057 dyn_cast<OverflowingBinaryOperator>(U)) {
1058 if (OBO->hasNoUnsignedWrap())
1060 if (OBO->hasNoSignedWrap())
1062 } else if (const PossiblyExactOperator *Div =
1063 dyn_cast<PossiblyExactOperator>(U)) {
1066 } else if (const GEPOperator *GEP = dyn_cast<GEPOperator>(U)) {
1067 if (GEP->isInBounds())
1072 static void WriteConstantInternal(raw_ostream &Out, const Constant *CV,
1073 TypePrinting &TypePrinter,
1074 SlotTracker *Machine,
1075 const Module *Context) {
1076 if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV)) {
1077 if (CI->getType()->isIntegerTy(1)) {
1078 Out << (CI->getZExtValue() ? "true" : "false");
1081 Out << CI->getValue();
1085 if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV)) {
1086 if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEsingle ||
1087 &CFP->getValueAPF().getSemantics() == &APFloat::IEEEdouble) {
1088 // We would like to output the FP constant value in exponential notation,
1089 // but we cannot do this if doing so will lose precision. Check here to
1090 // make sure that we only output it in exponential format if we can parse
1091 // the value back and get the same value.
1094 bool isHalf = &CFP->getValueAPF().getSemantics()==&APFloat::IEEEhalf;
1095 bool isDouble = &CFP->getValueAPF().getSemantics()==&APFloat::IEEEdouble;
1096 bool isInf = CFP->getValueAPF().isInfinity();
1097 bool isNaN = CFP->getValueAPF().isNaN();
1098 if (!isHalf && !isInf && !isNaN) {
1099 double Val = isDouble ? CFP->getValueAPF().convertToDouble() :
1100 CFP->getValueAPF().convertToFloat();
1101 SmallString<128> StrVal;
1102 raw_svector_ostream(StrVal) << Val;
1104 // Check to make sure that the stringized number is not some string like
1105 // "Inf" or NaN, that atof will accept, but the lexer will not. Check
1106 // that the string matches the "[-+]?[0-9]" regex.
1108 if ((StrVal[0] >= '0' && StrVal[0] <= '9') ||
1109 ((StrVal[0] == '-' || StrVal[0] == '+') &&
1110 (StrVal[1] >= '0' && StrVal[1] <= '9'))) {
1111 // Reparse stringized version!
1112 if (APFloat(APFloat::IEEEdouble, StrVal).convertToDouble() == Val) {
1118 // Otherwise we could not reparse it to exactly the same value, so we must
1119 // output the string in hexadecimal format! Note that loading and storing
1120 // floating point types changes the bits of NaNs on some hosts, notably
1121 // x86, so we must not use these types.
1122 static_assert(sizeof(double) == sizeof(uint64_t),
1123 "assuming that double is 64 bits!");
1125 APFloat apf = CFP->getValueAPF();
1126 // Halves and floats are represented in ASCII IR as double, convert.
1128 apf.convert(APFloat::IEEEdouble, APFloat::rmNearestTiesToEven,
1131 utohex_buffer(uint64_t(apf.bitcastToAPInt().getZExtValue()),
1136 // Either half, or some form of long double.
1137 // These appear as a magic letter identifying the type, then a
1138 // fixed number of hex digits.
1140 // Bit position, in the current word, of the next nibble to print.
1143 if (&CFP->getValueAPF().getSemantics() == &APFloat::x87DoubleExtended) {
1145 // api needed to prevent premature destruction
1146 APInt api = CFP->getValueAPF().bitcastToAPInt();
1147 const uint64_t* p = api.getRawData();
1148 uint64_t word = p[1];
1150 int width = api.getBitWidth();
1151 for (int j=0; j<width; j+=4, shiftcount-=4) {
1152 unsigned int nibble = (word>>shiftcount) & 15;
1154 Out << (unsigned char)(nibble + '0');
1156 Out << (unsigned char)(nibble - 10 + 'A');
1157 if (shiftcount == 0 && j+4 < width) {
1161 shiftcount = width-j-4;
1165 } else if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEquad) {
1168 } else if (&CFP->getValueAPF().getSemantics() == &APFloat::PPCDoubleDouble) {
1171 } else if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEhalf) {
1175 llvm_unreachable("Unsupported floating point type");
1176 // api needed to prevent premature destruction
1177 APInt api = CFP->getValueAPF().bitcastToAPInt();
1178 const uint64_t* p = api.getRawData();
1180 int width = api.getBitWidth();
1181 for (int j=0; j<width; j+=4, shiftcount-=4) {
1182 unsigned int nibble = (word>>shiftcount) & 15;
1184 Out << (unsigned char)(nibble + '0');
1186 Out << (unsigned char)(nibble - 10 + 'A');
1187 if (shiftcount == 0 && j+4 < width) {
1191 shiftcount = width-j-4;
1197 if (isa<ConstantAggregateZero>(CV)) {
1198 Out << "zeroinitializer";
1202 if (const BlockAddress *BA = dyn_cast<BlockAddress>(CV)) {
1203 Out << "blockaddress(";
1204 WriteAsOperandInternal(Out, BA->getFunction(), &TypePrinter, Machine,
1207 WriteAsOperandInternal(Out, BA->getBasicBlock(), &TypePrinter, Machine,
1213 if (const ConstantArray *CA = dyn_cast<ConstantArray>(CV)) {
1214 Type *ETy = CA->getType()->getElementType();
1216 TypePrinter.print(ETy, Out);
1218 WriteAsOperandInternal(Out, CA->getOperand(0),
1219 &TypePrinter, Machine,
1221 for (unsigned i = 1, e = CA->getNumOperands(); i != e; ++i) {
1223 TypePrinter.print(ETy, Out);
1225 WriteAsOperandInternal(Out, CA->getOperand(i), &TypePrinter, Machine,
1232 if (const ConstantDataArray *CA = dyn_cast<ConstantDataArray>(CV)) {
1233 // As a special case, print the array as a string if it is an array of
1234 // i8 with ConstantInt values.
1235 if (CA->isString()) {
1237 PrintEscapedString(CA->getAsString(), Out);
1242 Type *ETy = CA->getType()->getElementType();
1244 TypePrinter.print(ETy, Out);
1246 WriteAsOperandInternal(Out, CA->getElementAsConstant(0),
1247 &TypePrinter, Machine,
1249 for (unsigned i = 1, e = CA->getNumElements(); i != e; ++i) {
1251 TypePrinter.print(ETy, Out);
1253 WriteAsOperandInternal(Out, CA->getElementAsConstant(i), &TypePrinter,
1261 if (const ConstantStruct *CS = dyn_cast<ConstantStruct>(CV)) {
1262 if (CS->getType()->isPacked())
1265 unsigned N = CS->getNumOperands();
1268 TypePrinter.print(CS->getOperand(0)->getType(), Out);
1271 WriteAsOperandInternal(Out, CS->getOperand(0), &TypePrinter, Machine,
1274 for (unsigned i = 1; i < N; i++) {
1276 TypePrinter.print(CS->getOperand(i)->getType(), Out);
1279 WriteAsOperandInternal(Out, CS->getOperand(i), &TypePrinter, Machine,
1286 if (CS->getType()->isPacked())
1291 if (isa<ConstantVector>(CV) || isa<ConstantDataVector>(CV)) {
1292 Type *ETy = CV->getType()->getVectorElementType();
1294 TypePrinter.print(ETy, Out);
1296 WriteAsOperandInternal(Out, CV->getAggregateElement(0U), &TypePrinter,
1298 for (unsigned i = 1, e = CV->getType()->getVectorNumElements(); i != e;++i){
1300 TypePrinter.print(ETy, Out);
1302 WriteAsOperandInternal(Out, CV->getAggregateElement(i), &TypePrinter,
1309 if (isa<ConstantPointerNull>(CV)) {
1314 if (isa<UndefValue>(CV)) {
1319 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV)) {
1320 Out << CE->getOpcodeName();
1321 WriteOptimizationInfo(Out, CE);
1322 if (CE->isCompare())
1323 Out << ' ' << getPredicateText(CE->getPredicate());
1326 if (const GEPOperator *GEP = dyn_cast<GEPOperator>(CE)) {
1328 cast<PointerType>(GEP->getPointerOperandType()->getScalarType())
1334 for (User::const_op_iterator OI=CE->op_begin(); OI != CE->op_end(); ++OI) {
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 printString(StringRef Name, StringRef Value,
1411 bool ShouldSkipEmpty = true);
1412 void printMetadata(StringRef Name, const Metadata *MD,
1413 bool ShouldSkipNull = true);
1414 template <class IntTy>
1415 void printInt(StringRef Name, IntTy Int, bool ShouldSkipZero = true);
1416 void printBool(StringRef Name, bool Value);
1417 void printDIFlags(StringRef Name, unsigned Flags);
1418 template <class IntTy, class Stringifier>
1419 void printDwarfEnum(StringRef Name, IntTy Value, Stringifier toString,
1420 bool ShouldSkipZero = true);
1424 void MDFieldPrinter::printTag(const DINode *N) {
1425 Out << FS << "tag: ";
1426 if (const char *Tag = dwarf::TagString(N->getTag()))
1432 void MDFieldPrinter::printString(StringRef Name, StringRef Value,
1433 bool ShouldSkipEmpty) {
1434 if (ShouldSkipEmpty && Value.empty())
1437 Out << FS << Name << ": \"";
1438 PrintEscapedString(Value, Out);
1442 static void writeMetadataAsOperand(raw_ostream &Out, const Metadata *MD,
1443 TypePrinting *TypePrinter,
1444 SlotTracker *Machine,
1445 const Module *Context) {
1450 WriteAsOperandInternal(Out, MD, TypePrinter, Machine, Context);
1453 void MDFieldPrinter::printMetadata(StringRef Name, const Metadata *MD,
1454 bool ShouldSkipNull) {
1455 if (ShouldSkipNull && !MD)
1458 Out << FS << Name << ": ";
1459 writeMetadataAsOperand(Out, MD, TypePrinter, Machine, Context);
1462 template <class IntTy>
1463 void MDFieldPrinter::printInt(StringRef Name, IntTy Int, bool ShouldSkipZero) {
1464 if (ShouldSkipZero && !Int)
1467 Out << FS << Name << ": " << Int;
1470 void MDFieldPrinter::printBool(StringRef Name, bool Value) {
1471 Out << FS << Name << ": " << (Value ? "true" : "false");
1474 void MDFieldPrinter::printDIFlags(StringRef Name, unsigned Flags) {
1478 Out << FS << Name << ": ";
1480 SmallVector<unsigned, 8> SplitFlags;
1481 unsigned Extra = DINode::splitFlags(Flags, SplitFlags);
1483 FieldSeparator FlagsFS(" | ");
1484 for (unsigned F : SplitFlags) {
1485 const char *StringF = DINode::getFlagString(F);
1486 assert(StringF && "Expected valid flag");
1487 Out << FlagsFS << StringF;
1489 if (Extra || SplitFlags.empty())
1490 Out << FlagsFS << Extra;
1493 template <class IntTy, class Stringifier>
1494 void MDFieldPrinter::printDwarfEnum(StringRef Name, IntTy Value,
1495 Stringifier toString, bool ShouldSkipZero) {
1499 Out << FS << Name << ": ";
1500 if (const char *S = toString(Value))
1506 static void writeGenericDINode(raw_ostream &Out, const GenericDINode *N,
1507 TypePrinting *TypePrinter, SlotTracker *Machine,
1508 const Module *Context) {
1509 Out << "!GenericDINode(";
1510 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1511 Printer.printTag(N);
1512 Printer.printString("header", N->getHeader());
1513 if (N->getNumDwarfOperands()) {
1514 Out << Printer.FS << "operands: {";
1516 for (auto &I : N->dwarf_operands()) {
1518 writeMetadataAsOperand(Out, I, TypePrinter, Machine, Context);
1525 static void writeDILocation(raw_ostream &Out, const DILocation *DL,
1526 TypePrinting *TypePrinter, SlotTracker *Machine,
1527 const Module *Context) {
1528 Out << "!DILocation(";
1529 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1530 // Always output the line, since 0 is a relevant and important value for it.
1531 Printer.printInt("line", DL->getLine(), /* ShouldSkipZero */ false);
1532 Printer.printInt("column", DL->getColumn());
1533 Printer.printMetadata("scope", DL->getRawScope(), /* ShouldSkipNull */ false);
1534 Printer.printMetadata("inlinedAt", DL->getRawInlinedAt());
1538 static void writeDISubrange(raw_ostream &Out, const DISubrange *N,
1539 TypePrinting *, SlotTracker *, const Module *) {
1540 Out << "!DISubrange(";
1541 MDFieldPrinter Printer(Out);
1542 Printer.printInt("count", N->getCount(), /* ShouldSkipZero */ false);
1543 Printer.printInt("lowerBound", N->getLowerBound());
1547 static void writeDIEnumerator(raw_ostream &Out, const DIEnumerator *N,
1548 TypePrinting *, SlotTracker *, const Module *) {
1549 Out << "!DIEnumerator(";
1550 MDFieldPrinter Printer(Out);
1551 Printer.printString("name", N->getName(), /* ShouldSkipEmpty */ false);
1552 Printer.printInt("value", N->getValue(), /* ShouldSkipZero */ false);
1556 static void writeDIBasicType(raw_ostream &Out, const DIBasicType *N,
1557 TypePrinting *, SlotTracker *, const Module *) {
1558 Out << "!DIBasicType(";
1559 MDFieldPrinter Printer(Out);
1560 if (N->getTag() != dwarf::DW_TAG_base_type)
1561 Printer.printTag(N);
1562 Printer.printString("name", N->getName());
1563 Printer.printInt("size", N->getSizeInBits());
1564 Printer.printInt("align", N->getAlignInBits());
1565 Printer.printDwarfEnum("encoding", N->getEncoding(),
1566 dwarf::AttributeEncodingString);
1570 static void writeDIDerivedType(raw_ostream &Out, const DIDerivedType *N,
1571 TypePrinting *TypePrinter, SlotTracker *Machine,
1572 const Module *Context) {
1573 Out << "!DIDerivedType(";
1574 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1575 Printer.printTag(N);
1576 Printer.printString("name", N->getName());
1577 Printer.printMetadata("scope", N->getRawScope());
1578 Printer.printMetadata("file", N->getRawFile());
1579 Printer.printInt("line", N->getLine());
1580 Printer.printMetadata("baseType", N->getRawBaseType(),
1581 /* ShouldSkipNull */ false);
1582 Printer.printInt("size", N->getSizeInBits());
1583 Printer.printInt("align", N->getAlignInBits());
1584 Printer.printInt("offset", N->getOffsetInBits());
1585 Printer.printDIFlags("flags", N->getFlags());
1586 Printer.printMetadata("extraData", N->getRawExtraData());
1590 static void writeDICompositeType(raw_ostream &Out, const DICompositeType *N,
1591 TypePrinting *TypePrinter,
1592 SlotTracker *Machine, const Module *Context) {
1593 Out << "!DICompositeType(";
1594 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1595 Printer.printTag(N);
1596 Printer.printString("name", N->getName());
1597 Printer.printMetadata("scope", N->getRawScope());
1598 Printer.printMetadata("file", N->getRawFile());
1599 Printer.printInt("line", N->getLine());
1600 Printer.printMetadata("baseType", N->getRawBaseType());
1601 Printer.printInt("size", N->getSizeInBits());
1602 Printer.printInt("align", N->getAlignInBits());
1603 Printer.printInt("offset", N->getOffsetInBits());
1604 Printer.printDIFlags("flags", N->getFlags());
1605 Printer.printMetadata("elements", N->getRawElements());
1606 Printer.printDwarfEnum("runtimeLang", N->getRuntimeLang(),
1607 dwarf::LanguageString);
1608 Printer.printMetadata("vtableHolder", N->getRawVTableHolder());
1609 Printer.printMetadata("templateParams", N->getRawTemplateParams());
1610 Printer.printString("identifier", N->getIdentifier());
1614 static void writeDISubroutineType(raw_ostream &Out, const DISubroutineType *N,
1615 TypePrinting *TypePrinter,
1616 SlotTracker *Machine, const Module *Context) {
1617 Out << "!DISubroutineType(";
1618 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1619 Printer.printDIFlags("flags", N->getFlags());
1620 Printer.printMetadata("types", N->getRawTypeArray(),
1621 /* ShouldSkipNull */ false);
1625 static void writeDIFile(raw_ostream &Out, const DIFile *N, TypePrinting *,
1626 SlotTracker *, const Module *) {
1628 MDFieldPrinter Printer(Out);
1629 Printer.printString("filename", N->getFilename(),
1630 /* ShouldSkipEmpty */ false);
1631 Printer.printString("directory", N->getDirectory(),
1632 /* ShouldSkipEmpty */ false);
1636 static void writeDICompileUnit(raw_ostream &Out, const DICompileUnit *N,
1637 TypePrinting *TypePrinter, SlotTracker *Machine,
1638 const Module *Context) {
1639 Out << "!DICompileUnit(";
1640 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1641 Printer.printDwarfEnum("language", N->getSourceLanguage(),
1642 dwarf::LanguageString, /* ShouldSkipZero */ false);
1643 Printer.printMetadata("file", N->getRawFile(), /* ShouldSkipNull */ false);
1644 Printer.printString("producer", N->getProducer());
1645 Printer.printBool("isOptimized", N->isOptimized());
1646 Printer.printString("flags", N->getFlags());
1647 Printer.printInt("runtimeVersion", N->getRuntimeVersion(),
1648 /* ShouldSkipZero */ false);
1649 Printer.printString("splitDebugFilename", N->getSplitDebugFilename());
1650 Printer.printInt("emissionKind", N->getEmissionKind(),
1651 /* ShouldSkipZero */ false);
1652 Printer.printMetadata("enums", N->getRawEnumTypes());
1653 Printer.printMetadata("retainedTypes", N->getRawRetainedTypes());
1654 Printer.printMetadata("subprograms", N->getRawSubprograms());
1655 Printer.printMetadata("globals", N->getRawGlobalVariables());
1656 Printer.printMetadata("imports", N->getRawImportedEntities());
1657 Printer.printInt("dwoId", N->getDWOId());
1661 static void writeDISubprogram(raw_ostream &Out, const DISubprogram *N,
1662 TypePrinting *TypePrinter, SlotTracker *Machine,
1663 const Module *Context) {
1664 Out << "!DISubprogram(";
1665 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1666 Printer.printString("name", N->getName());
1667 Printer.printString("linkageName", N->getLinkageName());
1668 Printer.printMetadata("scope", N->getRawScope(), /* ShouldSkipNull */ false);
1669 Printer.printMetadata("file", N->getRawFile());
1670 Printer.printInt("line", N->getLine());
1671 Printer.printMetadata("type", N->getRawType());
1672 Printer.printBool("isLocal", N->isLocalToUnit());
1673 Printer.printBool("isDefinition", N->isDefinition());
1674 Printer.printInt("scopeLine", N->getScopeLine());
1675 Printer.printMetadata("containingType", N->getRawContainingType());
1676 Printer.printDwarfEnum("virtuality", N->getVirtuality(),
1677 dwarf::VirtualityString);
1678 Printer.printInt("virtualIndex", N->getVirtualIndex());
1679 Printer.printDIFlags("flags", N->getFlags());
1680 Printer.printBool("isOptimized", N->isOptimized());
1681 Printer.printMetadata("function", N->getRawFunction());
1682 Printer.printMetadata("templateParams", N->getRawTemplateParams());
1683 Printer.printMetadata("declaration", N->getRawDeclaration());
1684 Printer.printMetadata("variables", N->getRawVariables());
1688 static void writeDILexicalBlock(raw_ostream &Out, const DILexicalBlock *N,
1689 TypePrinting *TypePrinter, SlotTracker *Machine,
1690 const Module *Context) {
1691 Out << "!DILexicalBlock(";
1692 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1693 Printer.printMetadata("scope", N->getRawScope(), /* ShouldSkipNull */ false);
1694 Printer.printMetadata("file", N->getRawFile());
1695 Printer.printInt("line", N->getLine());
1696 Printer.printInt("column", N->getColumn());
1700 static void writeDILexicalBlockFile(raw_ostream &Out,
1701 const DILexicalBlockFile *N,
1702 TypePrinting *TypePrinter,
1703 SlotTracker *Machine,
1704 const Module *Context) {
1705 Out << "!DILexicalBlockFile(";
1706 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1707 Printer.printMetadata("scope", N->getRawScope(), /* ShouldSkipNull */ false);
1708 Printer.printMetadata("file", N->getRawFile());
1709 Printer.printInt("discriminator", N->getDiscriminator(),
1710 /* ShouldSkipZero */ false);
1714 static void writeDINamespace(raw_ostream &Out, const DINamespace *N,
1715 TypePrinting *TypePrinter, SlotTracker *Machine,
1716 const Module *Context) {
1717 Out << "!DINamespace(";
1718 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1719 Printer.printString("name", N->getName());
1720 Printer.printMetadata("scope", N->getRawScope(), /* ShouldSkipNull */ false);
1721 Printer.printMetadata("file", N->getRawFile());
1722 Printer.printInt("line", N->getLine());
1726 static void writeDITemplateTypeParameter(raw_ostream &Out,
1727 const DITemplateTypeParameter *N,
1728 TypePrinting *TypePrinter,
1729 SlotTracker *Machine,
1730 const Module *Context) {
1731 Out << "!DITemplateTypeParameter(";
1732 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1733 Printer.printString("name", N->getName());
1734 Printer.printMetadata("type", N->getRawType(), /* ShouldSkipNull */ false);
1738 static void writeDITemplateValueParameter(raw_ostream &Out,
1739 const DITemplateValueParameter *N,
1740 TypePrinting *TypePrinter,
1741 SlotTracker *Machine,
1742 const Module *Context) {
1743 Out << "!DITemplateValueParameter(";
1744 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1745 if (N->getTag() != dwarf::DW_TAG_template_value_parameter)
1746 Printer.printTag(N);
1747 Printer.printString("name", N->getName());
1748 Printer.printMetadata("type", N->getRawType());
1749 Printer.printMetadata("value", N->getValue(), /* ShouldSkipNull */ false);
1753 static void writeDIGlobalVariable(raw_ostream &Out, const DIGlobalVariable *N,
1754 TypePrinting *TypePrinter,
1755 SlotTracker *Machine, const Module *Context) {
1756 Out << "!DIGlobalVariable(";
1757 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1758 Printer.printString("name", N->getName());
1759 Printer.printString("linkageName", N->getLinkageName());
1760 Printer.printMetadata("scope", N->getRawScope(), /* ShouldSkipNull */ false);
1761 Printer.printMetadata("file", N->getRawFile());
1762 Printer.printInt("line", N->getLine());
1763 Printer.printMetadata("type", N->getRawType());
1764 Printer.printBool("isLocal", N->isLocalToUnit());
1765 Printer.printBool("isDefinition", N->isDefinition());
1766 Printer.printMetadata("variable", N->getRawVariable());
1767 Printer.printMetadata("declaration", N->getRawStaticDataMemberDeclaration());
1771 static void writeDILocalVariable(raw_ostream &Out, const DILocalVariable *N,
1772 TypePrinting *TypePrinter,
1773 SlotTracker *Machine, const Module *Context) {
1774 Out << "!DILocalVariable(";
1775 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1776 Printer.printTag(N);
1777 Printer.printString("name", N->getName());
1778 Printer.printInt("arg", N->getArg(),
1779 /* ShouldSkipZero */
1780 N->getTag() == dwarf::DW_TAG_auto_variable);
1781 Printer.printMetadata("scope", N->getRawScope(), /* ShouldSkipNull */ false);
1782 Printer.printMetadata("file", N->getRawFile());
1783 Printer.printInt("line", N->getLine());
1784 Printer.printMetadata("type", N->getRawType());
1785 Printer.printDIFlags("flags", N->getFlags());
1789 static void writeDIExpression(raw_ostream &Out, const DIExpression *N,
1790 TypePrinting *TypePrinter, SlotTracker *Machine,
1791 const Module *Context) {
1792 Out << "!DIExpression(";
1795 for (auto I = N->expr_op_begin(), E = N->expr_op_end(); I != E; ++I) {
1796 const char *OpStr = dwarf::OperationEncodingString(I->getOp());
1797 assert(OpStr && "Expected valid opcode");
1800 for (unsigned A = 0, AE = I->getNumArgs(); A != AE; ++A)
1801 Out << FS << I->getArg(A);
1804 for (const auto &I : N->getElements())
1810 static void writeDIObjCProperty(raw_ostream &Out, const DIObjCProperty *N,
1811 TypePrinting *TypePrinter, SlotTracker *Machine,
1812 const Module *Context) {
1813 Out << "!DIObjCProperty(";
1814 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1815 Printer.printString("name", N->getName());
1816 Printer.printMetadata("file", N->getRawFile());
1817 Printer.printInt("line", N->getLine());
1818 Printer.printString("setter", N->getSetterName());
1819 Printer.printString("getter", N->getGetterName());
1820 Printer.printInt("attributes", N->getAttributes());
1821 Printer.printMetadata("type", N->getRawType());
1825 static void writeDIImportedEntity(raw_ostream &Out, const DIImportedEntity *N,
1826 TypePrinting *TypePrinter,
1827 SlotTracker *Machine, const Module *Context) {
1828 Out << "!DIImportedEntity(";
1829 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1830 Printer.printTag(N);
1831 Printer.printString("name", N->getName());
1832 Printer.printMetadata("scope", N->getRawScope(), /* ShouldSkipNull */ false);
1833 Printer.printMetadata("entity", N->getRawEntity());
1834 Printer.printInt("line", N->getLine());
1839 static void WriteMDNodeBodyInternal(raw_ostream &Out, const MDNode *Node,
1840 TypePrinting *TypePrinter,
1841 SlotTracker *Machine,
1842 const Module *Context) {
1843 if (Node->isDistinct())
1845 else if (Node->isTemporary())
1846 Out << "<temporary!> "; // Handle broken code.
1848 switch (Node->getMetadataID()) {
1850 llvm_unreachable("Expected uniquable MDNode");
1851 #define HANDLE_MDNODE_LEAF(CLASS) \
1852 case Metadata::CLASS##Kind: \
1853 write##CLASS(Out, cast<CLASS>(Node), TypePrinter, Machine, Context); \
1855 #include "llvm/IR/Metadata.def"
1859 // Full implementation of printing a Value as an operand with support for
1860 // TypePrinting, etc.
1861 static void WriteAsOperandInternal(raw_ostream &Out, const Value *V,
1862 TypePrinting *TypePrinter,
1863 SlotTracker *Machine,
1864 const Module *Context) {
1866 PrintLLVMName(Out, V);
1870 const Constant *CV = dyn_cast<Constant>(V);
1871 if (CV && !isa<GlobalValue>(CV)) {
1872 assert(TypePrinter && "Constants require TypePrinting!");
1873 WriteConstantInternal(Out, CV, *TypePrinter, Machine, Context);
1877 if (const InlineAsm *IA = dyn_cast<InlineAsm>(V)) {
1879 if (IA->hasSideEffects())
1880 Out << "sideeffect ";
1881 if (IA->isAlignStack())
1882 Out << "alignstack ";
1883 // We don't emit the AD_ATT dialect as it's the assumed default.
1884 if (IA->getDialect() == InlineAsm::AD_Intel)
1885 Out << "inteldialect ";
1887 PrintEscapedString(IA->getAsmString(), Out);
1889 PrintEscapedString(IA->getConstraintString(), Out);
1894 if (auto *MD = dyn_cast<MetadataAsValue>(V)) {
1895 WriteAsOperandInternal(Out, MD->getMetadata(), TypePrinter, Machine,
1896 Context, /* FromValue */ true);
1902 // If we have a SlotTracker, use it.
1904 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
1905 Slot = Machine->getGlobalSlot(GV);
1908 Slot = Machine->getLocalSlot(V);
1910 // If the local value didn't succeed, then we may be referring to a value
1911 // from a different function. Translate it, as this can happen when using
1912 // address of blocks.
1914 if ((Machine = createSlotTracker(V))) {
1915 Slot = Machine->getLocalSlot(V);
1919 } else if ((Machine = createSlotTracker(V))) {
1920 // Otherwise, create one to get the # and then destroy it.
1921 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
1922 Slot = Machine->getGlobalSlot(GV);
1925 Slot = Machine->getLocalSlot(V);
1934 Out << Prefix << Slot;
1939 static void WriteAsOperandInternal(raw_ostream &Out, const Metadata *MD,
1940 TypePrinting *TypePrinter,
1941 SlotTracker *Machine, const Module *Context,
1943 if (const MDNode *N = dyn_cast<MDNode>(MD)) {
1945 Machine = new SlotTracker(Context);
1946 int Slot = Machine->getMetadataSlot(N);
1948 // Give the pointer value instead of "badref", since this comes up all
1949 // the time when debugging.
1950 Out << "<" << N << ">";
1956 if (const MDString *MDS = dyn_cast<MDString>(MD)) {
1958 PrintEscapedString(MDS->getString(), Out);
1963 auto *V = cast<ValueAsMetadata>(MD);
1964 assert(TypePrinter && "TypePrinter required for metadata values");
1965 assert((FromValue || !isa<LocalAsMetadata>(V)) &&
1966 "Unexpected function-local metadata outside of value argument");
1968 TypePrinter->print(V->getValue()->getType(), Out);
1970 WriteAsOperandInternal(Out, V->getValue(), TypePrinter, Machine, Context);
1974 class AssemblyWriter {
1975 formatted_raw_ostream &Out;
1976 const Module *TheModule;
1977 std::unique_ptr<SlotTracker> SlotTrackerStorage;
1978 SlotTracker &Machine;
1979 TypePrinting TypePrinter;
1980 AssemblyAnnotationWriter *AnnotationWriter;
1981 SetVector<const Comdat *> Comdats;
1982 bool ShouldPreserveUseListOrder;
1983 UseListOrderStack UseListOrders;
1984 SmallVector<StringRef, 8> MDNames;
1987 /// Construct an AssemblyWriter with an external SlotTracker
1988 AssemblyWriter(formatted_raw_ostream &o, SlotTracker &Mac, const Module *M,
1989 AssemblyAnnotationWriter *AAW,
1990 bool ShouldPreserveUseListOrder = false);
1992 /// Construct an AssemblyWriter with an internally allocated SlotTracker
1993 AssemblyWriter(formatted_raw_ostream &o, const Module *M,
1994 AssemblyAnnotationWriter *AAW,
1995 bool ShouldPreserveUseListOrder = false);
1997 void printMDNodeBody(const MDNode *MD);
1998 void printNamedMDNode(const NamedMDNode *NMD);
2000 void printModule(const Module *M);
2002 void writeOperand(const Value *Op, bool PrintType);
2003 void writeParamOperand(const Value *Operand, AttributeSet Attrs,unsigned Idx);
2004 void writeAtomic(AtomicOrdering Ordering, SynchronizationScope SynchScope);
2005 void writeAtomicCmpXchg(AtomicOrdering SuccessOrdering,
2006 AtomicOrdering FailureOrdering,
2007 SynchronizationScope SynchScope);
2009 void writeAllMDNodes();
2010 void writeMDNode(unsigned Slot, const MDNode *Node);
2011 void writeAllAttributeGroups();
2013 void printTypeIdentities();
2014 void printGlobal(const GlobalVariable *GV);
2015 void printAlias(const GlobalAlias *GV);
2016 void printComdat(const Comdat *C);
2017 void printFunction(const Function *F);
2018 void printArgument(const Argument *FA, AttributeSet Attrs, unsigned Idx);
2019 void printBasicBlock(const BasicBlock *BB);
2020 void printInstructionLine(const Instruction &I);
2021 void printInstruction(const Instruction &I);
2023 void printUseListOrder(const UseListOrder &Order);
2024 void printUseLists(const Function *F);
2029 /// \brief Print out metadata attachments.
2030 void printMetadataAttachments(
2031 const SmallVectorImpl<std::pair<unsigned, MDNode *>> &MDs,
2032 StringRef Separator);
2034 // printInfoComment - Print a little comment after the instruction indicating
2035 // which slot it occupies.
2036 void printInfoComment(const Value &V);
2038 // printGCRelocateComment - print comment after call to the gc.relocate
2039 // intrinsic indicating base and derived pointer names.
2040 void printGCRelocateComment(const Value &V);
2044 void AssemblyWriter::init() {
2047 TypePrinter.incorporateTypes(*TheModule);
2048 for (const Function &F : *TheModule)
2049 if (const Comdat *C = F.getComdat())
2051 for (const GlobalVariable &GV : TheModule->globals())
2052 if (const Comdat *C = GV.getComdat())
2056 AssemblyWriter::AssemblyWriter(formatted_raw_ostream &o, SlotTracker &Mac,
2057 const Module *M, AssemblyAnnotationWriter *AAW,
2058 bool ShouldPreserveUseListOrder)
2059 : Out(o), TheModule(M), Machine(Mac), AnnotationWriter(AAW),
2060 ShouldPreserveUseListOrder(ShouldPreserveUseListOrder) {
2064 AssemblyWriter::AssemblyWriter(formatted_raw_ostream &o, const Module *M,
2065 AssemblyAnnotationWriter *AAW,
2066 bool ShouldPreserveUseListOrder)
2067 : Out(o), TheModule(M), SlotTrackerStorage(createSlotTracker(M)),
2068 Machine(*SlotTrackerStorage), AnnotationWriter(AAW),
2069 ShouldPreserveUseListOrder(ShouldPreserveUseListOrder) {
2073 void AssemblyWriter::writeOperand(const Value *Operand, bool PrintType) {
2075 Out << "<null operand!>";
2079 TypePrinter.print(Operand->getType(), Out);
2082 WriteAsOperandInternal(Out, Operand, &TypePrinter, &Machine, TheModule);
2085 void AssemblyWriter::writeAtomic(AtomicOrdering Ordering,
2086 SynchronizationScope SynchScope) {
2087 if (Ordering == NotAtomic)
2090 switch (SynchScope) {
2091 case SingleThread: Out << " singlethread"; break;
2092 case CrossThread: break;
2096 default: Out << " <bad ordering " << int(Ordering) << ">"; break;
2097 case Unordered: Out << " unordered"; break;
2098 case Monotonic: Out << " monotonic"; break;
2099 case Acquire: Out << " acquire"; break;
2100 case Release: Out << " release"; break;
2101 case AcquireRelease: Out << " acq_rel"; break;
2102 case SequentiallyConsistent: Out << " seq_cst"; break;
2106 void AssemblyWriter::writeAtomicCmpXchg(AtomicOrdering SuccessOrdering,
2107 AtomicOrdering FailureOrdering,
2108 SynchronizationScope SynchScope) {
2109 assert(SuccessOrdering != NotAtomic && FailureOrdering != NotAtomic);
2111 switch (SynchScope) {
2112 case SingleThread: Out << " singlethread"; break;
2113 case CrossThread: break;
2116 switch (SuccessOrdering) {
2117 default: Out << " <bad ordering " << int(SuccessOrdering) << ">"; break;
2118 case Unordered: Out << " unordered"; break;
2119 case Monotonic: Out << " monotonic"; break;
2120 case Acquire: Out << " acquire"; break;
2121 case Release: Out << " release"; break;
2122 case AcquireRelease: Out << " acq_rel"; break;
2123 case SequentiallyConsistent: Out << " seq_cst"; break;
2126 switch (FailureOrdering) {
2127 default: Out << " <bad ordering " << int(FailureOrdering) << ">"; break;
2128 case Unordered: Out << " unordered"; break;
2129 case Monotonic: Out << " monotonic"; break;
2130 case Acquire: Out << " acquire"; break;
2131 case Release: Out << " release"; break;
2132 case AcquireRelease: Out << " acq_rel"; break;
2133 case SequentiallyConsistent: Out << " seq_cst"; break;
2137 void AssemblyWriter::writeParamOperand(const Value *Operand,
2138 AttributeSet Attrs, unsigned Idx) {
2140 Out << "<null operand!>";
2145 TypePrinter.print(Operand->getType(), Out);
2146 // Print parameter attributes list
2147 if (Attrs.hasAttributes(Idx))
2148 Out << ' ' << Attrs.getAsString(Idx);
2150 // Print the operand
2151 WriteAsOperandInternal(Out, Operand, &TypePrinter, &Machine, TheModule);
2154 void AssemblyWriter::printModule(const Module *M) {
2155 Machine.initialize();
2157 if (ShouldPreserveUseListOrder)
2158 UseListOrders = predictUseListOrder(M);
2160 if (!M->getModuleIdentifier().empty() &&
2161 // Don't print the ID if it will start a new line (which would
2162 // require a comment char before it).
2163 M->getModuleIdentifier().find('\n') == std::string::npos)
2164 Out << "; ModuleID = '" << M->getModuleIdentifier() << "'\n";
2166 const std::string &DL = M->getDataLayoutStr();
2168 Out << "target datalayout = \"" << DL << "\"\n";
2169 if (!M->getTargetTriple().empty())
2170 Out << "target triple = \"" << M->getTargetTriple() << "\"\n";
2172 if (!M->getModuleInlineAsm().empty()) {
2175 // Split the string into lines, to make it easier to read the .ll file.
2176 StringRef Asm = M->getModuleInlineAsm();
2179 std::tie(Front, Asm) = Asm.split('\n');
2181 // We found a newline, print the portion of the asm string from the
2182 // last newline up to this newline.
2183 Out << "module asm \"";
2184 PrintEscapedString(Front, Out);
2186 } while (!Asm.empty());
2189 printTypeIdentities();
2191 // Output all comdats.
2192 if (!Comdats.empty())
2194 for (const Comdat *C : Comdats) {
2196 if (C != Comdats.back())
2200 // Output all globals.
2201 if (!M->global_empty()) Out << '\n';
2202 for (const GlobalVariable &GV : M->globals()) {
2203 printGlobal(&GV); Out << '\n';
2206 // Output all aliases.
2207 if (!M->alias_empty()) Out << "\n";
2208 for (const GlobalAlias &GA : M->aliases())
2211 // Output global use-lists.
2212 printUseLists(nullptr);
2214 // Output all of the functions.
2215 for (const Function &F : *M)
2217 assert(UseListOrders.empty() && "All use-lists should have been consumed");
2219 // Output all attribute groups.
2220 if (!Machine.as_empty()) {
2222 writeAllAttributeGroups();
2225 // Output named metadata.
2226 if (!M->named_metadata_empty()) Out << '\n';
2228 for (const NamedMDNode &Node : M->named_metadata())
2229 printNamedMDNode(&Node);
2232 if (!Machine.mdn_empty()) {
2238 static void printMetadataIdentifier(StringRef Name,
2239 formatted_raw_ostream &Out) {
2241 Out << "<empty name> ";
2243 if (isalpha(static_cast<unsigned char>(Name[0])) || Name[0] == '-' ||
2244 Name[0] == '$' || Name[0] == '.' || Name[0] == '_')
2247 Out << '\\' << hexdigit(Name[0] >> 4) << hexdigit(Name[0] & 0x0F);
2248 for (unsigned i = 1, e = Name.size(); i != e; ++i) {
2249 unsigned char C = Name[i];
2250 if (isalnum(static_cast<unsigned char>(C)) || C == '-' || C == '$' ||
2251 C == '.' || C == '_')
2254 Out << '\\' << hexdigit(C >> 4) << hexdigit(C & 0x0F);
2259 void AssemblyWriter::printNamedMDNode(const NamedMDNode *NMD) {
2261 printMetadataIdentifier(NMD->getName(), Out);
2263 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
2266 int Slot = Machine.getMetadataSlot(NMD->getOperand(i));
2275 static void PrintLinkage(GlobalValue::LinkageTypes LT,
2276 formatted_raw_ostream &Out) {
2278 case GlobalValue::ExternalLinkage: break;
2279 case GlobalValue::PrivateLinkage: Out << "private "; break;
2280 case GlobalValue::InternalLinkage: Out << "internal "; break;
2281 case GlobalValue::LinkOnceAnyLinkage: Out << "linkonce "; break;
2282 case GlobalValue::LinkOnceODRLinkage: Out << "linkonce_odr "; break;
2283 case GlobalValue::WeakAnyLinkage: Out << "weak "; break;
2284 case GlobalValue::WeakODRLinkage: Out << "weak_odr "; break;
2285 case GlobalValue::CommonLinkage: Out << "common "; break;
2286 case GlobalValue::AppendingLinkage: Out << "appending "; break;
2287 case GlobalValue::ExternalWeakLinkage: Out << "extern_weak "; break;
2288 case GlobalValue::AvailableExternallyLinkage:
2289 Out << "available_externally ";
2294 static void PrintVisibility(GlobalValue::VisibilityTypes Vis,
2295 formatted_raw_ostream &Out) {
2297 case GlobalValue::DefaultVisibility: break;
2298 case GlobalValue::HiddenVisibility: Out << "hidden "; break;
2299 case GlobalValue::ProtectedVisibility: Out << "protected "; break;
2303 static void PrintDLLStorageClass(GlobalValue::DLLStorageClassTypes SCT,
2304 formatted_raw_ostream &Out) {
2306 case GlobalValue::DefaultStorageClass: break;
2307 case GlobalValue::DLLImportStorageClass: Out << "dllimport "; break;
2308 case GlobalValue::DLLExportStorageClass: Out << "dllexport "; break;
2312 static void PrintThreadLocalModel(GlobalVariable::ThreadLocalMode TLM,
2313 formatted_raw_ostream &Out) {
2315 case GlobalVariable::NotThreadLocal:
2317 case GlobalVariable::GeneralDynamicTLSModel:
2318 Out << "thread_local ";
2320 case GlobalVariable::LocalDynamicTLSModel:
2321 Out << "thread_local(localdynamic) ";
2323 case GlobalVariable::InitialExecTLSModel:
2324 Out << "thread_local(initialexec) ";
2326 case GlobalVariable::LocalExecTLSModel:
2327 Out << "thread_local(localexec) ";
2332 static void maybePrintComdat(formatted_raw_ostream &Out,
2333 const GlobalObject &GO) {
2334 const Comdat *C = GO.getComdat();
2338 if (isa<GlobalVariable>(GO))
2342 if (GO.getName() == C->getName())
2346 PrintLLVMName(Out, C->getName(), ComdatPrefix);
2350 void AssemblyWriter::printGlobal(const GlobalVariable *GV) {
2351 if (GV->isMaterializable())
2352 Out << "; Materializable\n";
2354 WriteAsOperandInternal(Out, GV, &TypePrinter, &Machine, GV->getParent());
2357 if (!GV->hasInitializer() && GV->hasExternalLinkage())
2360 PrintLinkage(GV->getLinkage(), Out);
2361 PrintVisibility(GV->getVisibility(), Out);
2362 PrintDLLStorageClass(GV->getDLLStorageClass(), Out);
2363 PrintThreadLocalModel(GV->getThreadLocalMode(), Out);
2364 if (GV->hasUnnamedAddr())
2365 Out << "unnamed_addr ";
2367 if (unsigned AddressSpace = GV->getType()->getAddressSpace())
2368 Out << "addrspace(" << AddressSpace << ") ";
2369 if (GV->isExternallyInitialized()) Out << "externally_initialized ";
2370 Out << (GV->isConstant() ? "constant " : "global ");
2371 TypePrinter.print(GV->getType()->getElementType(), Out);
2373 if (GV->hasInitializer()) {
2375 writeOperand(GV->getInitializer(), false);
2378 if (GV->hasSection()) {
2379 Out << ", section \"";
2380 PrintEscapedString(GV->getSection(), Out);
2383 maybePrintComdat(Out, *GV);
2384 if (GV->getAlignment())
2385 Out << ", align " << GV->getAlignment();
2387 printInfoComment(*GV);
2390 void AssemblyWriter::printAlias(const GlobalAlias *GA) {
2391 if (GA->isMaterializable())
2392 Out << "; Materializable\n";
2394 WriteAsOperandInternal(Out, GA, &TypePrinter, &Machine, GA->getParent());
2397 PrintLinkage(GA->getLinkage(), Out);
2398 PrintVisibility(GA->getVisibility(), Out);
2399 PrintDLLStorageClass(GA->getDLLStorageClass(), Out);
2400 PrintThreadLocalModel(GA->getThreadLocalMode(), Out);
2401 if (GA->hasUnnamedAddr())
2402 Out << "unnamed_addr ";
2406 const Constant *Aliasee = GA->getAliasee();
2409 TypePrinter.print(GA->getType(), Out);
2410 Out << " <<NULL ALIASEE>>";
2412 writeOperand(Aliasee, !isa<ConstantExpr>(Aliasee));
2415 printInfoComment(*GA);
2419 void AssemblyWriter::printComdat(const Comdat *C) {
2423 void AssemblyWriter::printTypeIdentities() {
2424 if (TypePrinter.NumberedTypes.empty() &&
2425 TypePrinter.NamedTypes.empty())
2430 // We know all the numbers that each type is used and we know that it is a
2431 // dense assignment. Convert the map to an index table.
2432 std::vector<StructType*> NumberedTypes(TypePrinter.NumberedTypes.size());
2433 for (DenseMap<StructType*, unsigned>::iterator I =
2434 TypePrinter.NumberedTypes.begin(), E = TypePrinter.NumberedTypes.end();
2436 assert(I->second < NumberedTypes.size() && "Didn't get a dense numbering?");
2437 NumberedTypes[I->second] = I->first;
2440 // Emit all numbered types.
2441 for (unsigned i = 0, e = NumberedTypes.size(); i != e; ++i) {
2442 Out << '%' << i << " = type ";
2444 // Make sure we print out at least one level of the type structure, so
2445 // that we do not get %2 = type %2
2446 TypePrinter.printStructBody(NumberedTypes[i], Out);
2450 for (unsigned i = 0, e = TypePrinter.NamedTypes.size(); i != e; ++i) {
2451 PrintLLVMName(Out, TypePrinter.NamedTypes[i]->getName(), LocalPrefix);
2454 // Make sure we print out at least one level of the type structure, so
2455 // that we do not get %FILE = type %FILE
2456 TypePrinter.printStructBody(TypePrinter.NamedTypes[i], Out);
2461 /// printFunction - Print all aspects of a function.
2463 void AssemblyWriter::printFunction(const Function *F) {
2464 // Print out the return type and name.
2467 if (AnnotationWriter) AnnotationWriter->emitFunctionAnnot(F, Out);
2469 if (F->isMaterializable())
2470 Out << "; Materializable\n";
2472 const AttributeSet &Attrs = F->getAttributes();
2473 if (Attrs.hasAttributes(AttributeSet::FunctionIndex)) {
2474 AttributeSet AS = Attrs.getFnAttributes();
2475 std::string AttrStr;
2478 for (unsigned E = AS.getNumSlots(); Idx != E; ++Idx)
2479 if (AS.getSlotIndex(Idx) == AttributeSet::FunctionIndex)
2482 for (AttributeSet::iterator I = AS.begin(Idx), E = AS.end(Idx);
2484 Attribute Attr = *I;
2485 if (!Attr.isStringAttribute()) {
2486 if (!AttrStr.empty()) AttrStr += ' ';
2487 AttrStr += Attr.getAsString();
2491 if (!AttrStr.empty())
2492 Out << "; Function Attrs: " << AttrStr << '\n';
2495 if (F->isDeclaration())
2500 PrintLinkage(F->getLinkage(), Out);
2501 PrintVisibility(F->getVisibility(), Out);
2502 PrintDLLStorageClass(F->getDLLStorageClass(), Out);
2504 // Print the calling convention.
2505 if (F->getCallingConv() != CallingConv::C) {
2506 PrintCallingConv(F->getCallingConv(), Out);
2510 FunctionType *FT = F->getFunctionType();
2511 if (Attrs.hasAttributes(AttributeSet::ReturnIndex))
2512 Out << Attrs.getAsString(AttributeSet::ReturnIndex) << ' ';
2513 TypePrinter.print(F->getReturnType(), Out);
2515 WriteAsOperandInternal(Out, F, &TypePrinter, &Machine, F->getParent());
2517 Machine.incorporateFunction(F);
2519 // Loop over the arguments, printing them...
2522 if (!F->isDeclaration()) {
2523 // If this isn't a declaration, print the argument names as well.
2524 for (Function::const_arg_iterator I = F->arg_begin(), E = F->arg_end();
2526 // Insert commas as we go... the first arg doesn't get a comma
2527 if (I != F->arg_begin()) Out << ", ";
2528 printArgument(I, Attrs, Idx);
2532 // Otherwise, print the types from the function type.
2533 for (unsigned i = 0, e = FT->getNumParams(); i != e; ++i) {
2534 // Insert commas as we go... the first arg doesn't get a comma
2538 TypePrinter.print(FT->getParamType(i), Out);
2540 if (Attrs.hasAttributes(i+1))
2541 Out << ' ' << Attrs.getAsString(i+1);
2545 // Finish printing arguments...
2546 if (FT->isVarArg()) {
2547 if (FT->getNumParams()) Out << ", ";
2548 Out << "..."; // Output varargs portion of signature!
2551 if (F->hasUnnamedAddr())
2552 Out << " unnamed_addr";
2553 if (Attrs.hasAttributes(AttributeSet::FunctionIndex))
2554 Out << " #" << Machine.getAttributeGroupSlot(Attrs.getFnAttributes());
2555 if (F->hasSection()) {
2556 Out << " section \"";
2557 PrintEscapedString(F->getSection(), Out);
2560 maybePrintComdat(Out, *F);
2561 if (F->getAlignment())
2562 Out << " align " << F->getAlignment();
2564 Out << " gc \"" << F->getGC() << '"';
2565 if (F->hasPrefixData()) {
2567 writeOperand(F->getPrefixData(), true);
2569 if (F->hasPrologueData()) {
2570 Out << " prologue ";
2571 writeOperand(F->getPrologueData(), true);
2573 if (F->hasPersonalityFn()) {
2574 Out << " personality ";
2575 writeOperand(F->getPersonalityFn(), /*PrintType=*/true);
2578 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
2579 F->getAllMetadata(MDs);
2580 printMetadataAttachments(MDs, " ");
2582 if (F->isDeclaration()) {
2586 // Output all of the function's basic blocks.
2587 for (Function::const_iterator I = F->begin(), E = F->end(); I != E; ++I)
2590 // Output the function's use-lists.
2596 Machine.purgeFunction();
2599 /// printArgument - This member is called for every argument that is passed into
2600 /// the function. Simply print it out
2602 void AssemblyWriter::printArgument(const Argument *Arg,
2603 AttributeSet Attrs, unsigned Idx) {
2605 TypePrinter.print(Arg->getType(), Out);
2607 // Output parameter attributes list
2608 if (Attrs.hasAttributes(Idx))
2609 Out << ' ' << Attrs.getAsString(Idx);
2611 // Output name, if available...
2612 if (Arg->hasName()) {
2614 PrintLLVMName(Out, Arg);
2618 /// printBasicBlock - This member is called for each basic block in a method.
2620 void AssemblyWriter::printBasicBlock(const BasicBlock *BB) {
2621 if (BB->hasName()) { // Print out the label if it exists...
2623 PrintLLVMName(Out, BB->getName(), LabelPrefix);
2625 } else if (!BB->use_empty()) { // Don't print block # of no uses...
2626 Out << "\n; <label>:";
2627 int Slot = Machine.getLocalSlot(BB);
2634 if (!BB->getParent()) {
2635 Out.PadToColumn(50);
2636 Out << "; Error: Block without parent!";
2637 } else if (BB != &BB->getParent()->getEntryBlock()) { // Not the entry block?
2638 // Output predecessors for the block.
2639 Out.PadToColumn(50);
2641 const_pred_iterator PI = pred_begin(BB), PE = pred_end(BB);
2644 Out << " No predecessors!";
2647 writeOperand(*PI, false);
2648 for (++PI; PI != PE; ++PI) {
2650 writeOperand(*PI, false);
2657 if (AnnotationWriter) AnnotationWriter->emitBasicBlockStartAnnot(BB, Out);
2659 // Output all of the instructions in the basic block...
2660 for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I != E; ++I) {
2661 printInstructionLine(*I);
2664 if (AnnotationWriter) AnnotationWriter->emitBasicBlockEndAnnot(BB, Out);
2667 /// printInstructionLine - Print an instruction and a newline character.
2668 void AssemblyWriter::printInstructionLine(const Instruction &I) {
2669 printInstruction(I);
2673 /// printGCRelocateComment - print comment after call to the gc.relocate
2674 /// intrinsic indicating base and derived pointer names.
2675 void AssemblyWriter::printGCRelocateComment(const Value &V) {
2676 assert(isGCRelocate(&V));
2677 GCRelocateOperands GCOps(cast<Instruction>(&V));
2680 writeOperand(GCOps.getBasePtr(), false);
2682 writeOperand(GCOps.getDerivedPtr(), false);
2686 /// printInfoComment - Print a little comment after the instruction indicating
2687 /// which slot it occupies.
2689 void AssemblyWriter::printInfoComment(const Value &V) {
2690 if (isGCRelocate(&V))
2691 printGCRelocateComment(V);
2693 if (AnnotationWriter)
2694 AnnotationWriter->printInfoComment(V, Out);
2697 // This member is called for each Instruction in a function..
2698 void AssemblyWriter::printInstruction(const Instruction &I) {
2699 if (AnnotationWriter) AnnotationWriter->emitInstructionAnnot(&I, Out);
2701 // Print out indentation for an instruction.
2704 // Print out name if it exists...
2706 PrintLLVMName(Out, &I);
2708 } else if (!I.getType()->isVoidTy()) {
2709 // Print out the def slot taken.
2710 int SlotNum = Machine.getLocalSlot(&I);
2712 Out << "<badref> = ";
2714 Out << '%' << SlotNum << " = ";
2717 if (const CallInst *CI = dyn_cast<CallInst>(&I)) {
2718 if (CI->isMustTailCall())
2720 else if (CI->isTailCall())
2724 // Print out the opcode...
2725 Out << I.getOpcodeName();
2727 // If this is an atomic load or store, print out the atomic marker.
2728 if ((isa<LoadInst>(I) && cast<LoadInst>(I).isAtomic()) ||
2729 (isa<StoreInst>(I) && cast<StoreInst>(I).isAtomic()))
2732 if (isa<AtomicCmpXchgInst>(I) && cast<AtomicCmpXchgInst>(I).isWeak())
2735 // If this is a volatile operation, print out the volatile marker.
2736 if ((isa<LoadInst>(I) && cast<LoadInst>(I).isVolatile()) ||
2737 (isa<StoreInst>(I) && cast<StoreInst>(I).isVolatile()) ||
2738 (isa<AtomicCmpXchgInst>(I) && cast<AtomicCmpXchgInst>(I).isVolatile()) ||
2739 (isa<AtomicRMWInst>(I) && cast<AtomicRMWInst>(I).isVolatile()))
2742 // Print out optimization information.
2743 WriteOptimizationInfo(Out, &I);
2745 // Print out the compare instruction predicates
2746 if (const CmpInst *CI = dyn_cast<CmpInst>(&I))
2747 Out << ' ' << getPredicateText(CI->getPredicate());
2749 // Print out the atomicrmw operation
2750 if (const AtomicRMWInst *RMWI = dyn_cast<AtomicRMWInst>(&I))
2751 writeAtomicRMWOperation(Out, RMWI->getOperation());
2753 // Print out the type of the operands...
2754 const Value *Operand = I.getNumOperands() ? I.getOperand(0) : nullptr;
2756 // Special case conditional branches to swizzle the condition out to the front
2757 if (isa<BranchInst>(I) && cast<BranchInst>(I).isConditional()) {
2758 const BranchInst &BI(cast<BranchInst>(I));
2760 writeOperand(BI.getCondition(), true);
2762 writeOperand(BI.getSuccessor(0), true);
2764 writeOperand(BI.getSuccessor(1), true);
2766 } else if (isa<SwitchInst>(I)) {
2767 const SwitchInst& SI(cast<SwitchInst>(I));
2768 // Special case switch instruction to get formatting nice and correct.
2770 writeOperand(SI.getCondition(), true);
2772 writeOperand(SI.getDefaultDest(), true);
2774 for (SwitchInst::ConstCaseIt i = SI.case_begin(), e = SI.case_end();
2777 writeOperand(i.getCaseValue(), true);
2779 writeOperand(i.getCaseSuccessor(), true);
2782 } else if (isa<IndirectBrInst>(I)) {
2783 // Special case indirectbr instruction to get formatting nice and correct.
2785 writeOperand(Operand, true);
2788 for (unsigned i = 1, e = I.getNumOperands(); i != e; ++i) {
2791 writeOperand(I.getOperand(i), true);
2794 } else if (const PHINode *PN = dyn_cast<PHINode>(&I)) {
2796 TypePrinter.print(I.getType(), Out);
2799 for (unsigned op = 0, Eop = PN->getNumIncomingValues(); op < Eop; ++op) {
2800 if (op) Out << ", ";
2802 writeOperand(PN->getIncomingValue(op), false); Out << ", ";
2803 writeOperand(PN->getIncomingBlock(op), false); Out << " ]";
2805 } else if (const ExtractValueInst *EVI = dyn_cast<ExtractValueInst>(&I)) {
2807 writeOperand(I.getOperand(0), true);
2808 for (const unsigned *i = EVI->idx_begin(), *e = EVI->idx_end(); i != e; ++i)
2810 } else if (const InsertValueInst *IVI = dyn_cast<InsertValueInst>(&I)) {
2812 writeOperand(I.getOperand(0), true); Out << ", ";
2813 writeOperand(I.getOperand(1), true);
2814 for (const unsigned *i = IVI->idx_begin(), *e = IVI->idx_end(); i != e; ++i)
2816 } else if (const LandingPadInst *LPI = dyn_cast<LandingPadInst>(&I)) {
2818 TypePrinter.print(I.getType(), Out);
2819 if (LPI->isCleanup() || LPI->getNumClauses() != 0)
2822 if (LPI->isCleanup())
2825 for (unsigned i = 0, e = LPI->getNumClauses(); i != e; ++i) {
2826 if (i != 0 || LPI->isCleanup()) Out << "\n";
2827 if (LPI->isCatch(i))
2832 writeOperand(LPI->getClause(i), true);
2834 } else if (isa<ReturnInst>(I) && !Operand) {
2836 } else if (const CallInst *CI = dyn_cast<CallInst>(&I)) {
2837 // Print the calling convention being used.
2838 if (CI->getCallingConv() != CallingConv::C) {
2840 PrintCallingConv(CI->getCallingConv(), Out);
2843 Operand = CI->getCalledValue();
2844 FunctionType *FTy = cast<FunctionType>(CI->getFunctionType());
2845 Type *RetTy = FTy->getReturnType();
2846 const AttributeSet &PAL = CI->getAttributes();
2848 if (PAL.hasAttributes(AttributeSet::ReturnIndex))
2849 Out << ' ' << PAL.getAsString(AttributeSet::ReturnIndex);
2851 // If possible, print out the short form of the call instruction. We can
2852 // only do this if the first argument is a pointer to a nonvararg function,
2853 // and if the return type is not a pointer to a function.
2856 TypePrinter.print(FTy->isVarArg() ? FTy : RetTy, Out);
2858 writeOperand(Operand, false);
2860 for (unsigned op = 0, Eop = CI->getNumArgOperands(); op < Eop; ++op) {
2863 writeParamOperand(CI->getArgOperand(op), PAL, op + 1);
2866 // Emit an ellipsis if this is a musttail call in a vararg function. This
2867 // is only to aid readability, musttail calls forward varargs by default.
2868 if (CI->isMustTailCall() && CI->getParent() &&
2869 CI->getParent()->getParent() &&
2870 CI->getParent()->getParent()->isVarArg())
2874 if (PAL.hasAttributes(AttributeSet::FunctionIndex))
2875 Out << " #" << Machine.getAttributeGroupSlot(PAL.getFnAttributes());
2876 } else if (const InvokeInst *II = dyn_cast<InvokeInst>(&I)) {
2877 Operand = II->getCalledValue();
2878 FunctionType *FTy = cast<FunctionType>(II->getFunctionType());
2879 Type *RetTy = FTy->getReturnType();
2880 const AttributeSet &PAL = II->getAttributes();
2882 // Print the calling convention being used.
2883 if (II->getCallingConv() != CallingConv::C) {
2885 PrintCallingConv(II->getCallingConv(), Out);
2888 if (PAL.hasAttributes(AttributeSet::ReturnIndex))
2889 Out << ' ' << PAL.getAsString(AttributeSet::ReturnIndex);
2891 // If possible, print out the short form of the invoke instruction. We can
2892 // only do this if the first argument is a pointer to a nonvararg function,
2893 // and if the return type is not a pointer to a function.
2896 TypePrinter.print(FTy->isVarArg() ? FTy : RetTy, Out);
2898 writeOperand(Operand, false);
2900 for (unsigned op = 0, Eop = II->getNumArgOperands(); op < Eop; ++op) {
2903 writeParamOperand(II->getArgOperand(op), PAL, op + 1);
2907 if (PAL.hasAttributes(AttributeSet::FunctionIndex))
2908 Out << " #" << Machine.getAttributeGroupSlot(PAL.getFnAttributes());
2911 writeOperand(II->getNormalDest(), true);
2913 writeOperand(II->getUnwindDest(), true);
2915 } else if (const AllocaInst *AI = dyn_cast<AllocaInst>(&I)) {
2917 if (AI->isUsedWithInAlloca())
2919 TypePrinter.print(AI->getAllocatedType(), Out);
2921 // Explicitly write the array size if the code is broken, if it's an array
2922 // allocation, or if the type is not canonical for scalar allocations. The
2923 // latter case prevents the type from mutating when round-tripping through
2925 if (!AI->getArraySize() || AI->isArrayAllocation() ||
2926 !AI->getArraySize()->getType()->isIntegerTy(32)) {
2928 writeOperand(AI->getArraySize(), true);
2930 if (AI->getAlignment()) {
2931 Out << ", align " << AI->getAlignment();
2933 } else if (isa<CastInst>(I)) {
2936 writeOperand(Operand, true); // Work with broken code
2939 TypePrinter.print(I.getType(), Out);
2940 } else if (isa<VAArgInst>(I)) {
2943 writeOperand(Operand, true); // Work with broken code
2946 TypePrinter.print(I.getType(), Out);
2947 } else if (Operand) { // Print the normal way.
2948 if (const auto *GEP = dyn_cast<GetElementPtrInst>(&I)) {
2950 TypePrinter.print(GEP->getSourceElementType(), Out);
2952 } else if (const auto *LI = dyn_cast<LoadInst>(&I)) {
2954 TypePrinter.print(LI->getType(), Out);
2958 // PrintAllTypes - Instructions who have operands of all the same type
2959 // omit the type from all but the first operand. If the instruction has
2960 // different type operands (for example br), then they are all printed.
2961 bool PrintAllTypes = false;
2962 Type *TheType = Operand->getType();
2964 // Select, Store and ShuffleVector always print all types.
2965 if (isa<SelectInst>(I) || isa<StoreInst>(I) || isa<ShuffleVectorInst>(I)
2966 || isa<ReturnInst>(I)) {
2967 PrintAllTypes = true;
2969 for (unsigned i = 1, E = I.getNumOperands(); i != E; ++i) {
2970 Operand = I.getOperand(i);
2971 // note that Operand shouldn't be null, but the test helps make dump()
2972 // more tolerant of malformed IR
2973 if (Operand && Operand->getType() != TheType) {
2974 PrintAllTypes = true; // We have differing types! Print them all!
2980 if (!PrintAllTypes) {
2982 TypePrinter.print(TheType, Out);
2986 for (unsigned i = 0, E = I.getNumOperands(); i != E; ++i) {
2988 writeOperand(I.getOperand(i), PrintAllTypes);
2992 // Print atomic ordering/alignment for memory operations
2993 if (const LoadInst *LI = dyn_cast<LoadInst>(&I)) {
2995 writeAtomic(LI->getOrdering(), LI->getSynchScope());
2996 if (LI->getAlignment())
2997 Out << ", align " << LI->getAlignment();
2998 } else if (const StoreInst *SI = dyn_cast<StoreInst>(&I)) {
3000 writeAtomic(SI->getOrdering(), SI->getSynchScope());
3001 if (SI->getAlignment())
3002 Out << ", align " << SI->getAlignment();
3003 } else if (const AtomicCmpXchgInst *CXI = dyn_cast<AtomicCmpXchgInst>(&I)) {
3004 writeAtomicCmpXchg(CXI->getSuccessOrdering(), CXI->getFailureOrdering(),
3005 CXI->getSynchScope());
3006 } else if (const AtomicRMWInst *RMWI = dyn_cast<AtomicRMWInst>(&I)) {
3007 writeAtomic(RMWI->getOrdering(), RMWI->getSynchScope());
3008 } else if (const FenceInst *FI = dyn_cast<FenceInst>(&I)) {
3009 writeAtomic(FI->getOrdering(), FI->getSynchScope());
3012 // Print Metadata info.
3013 SmallVector<std::pair<unsigned, MDNode *>, 4> InstMD;
3014 I.getAllMetadata(InstMD);
3015 printMetadataAttachments(InstMD, ", ");
3017 // Print a nice comment.
3018 printInfoComment(I);
3021 void AssemblyWriter::printMetadataAttachments(
3022 const SmallVectorImpl<std::pair<unsigned, MDNode *>> &MDs,
3023 StringRef Separator) {
3027 if (MDNames.empty())
3028 TheModule->getMDKindNames(MDNames);
3030 for (const auto &I : MDs) {
3031 unsigned Kind = I.first;
3033 if (Kind < MDNames.size()) {
3035 printMetadataIdentifier(MDNames[Kind], Out);
3037 Out << "!<unknown kind #" << Kind << ">";
3039 WriteAsOperandInternal(Out, I.second, &TypePrinter, &Machine, TheModule);
3043 void AssemblyWriter::writeMDNode(unsigned Slot, const MDNode *Node) {
3044 Out << '!' << Slot << " = ";
3045 printMDNodeBody(Node);
3049 void AssemblyWriter::writeAllMDNodes() {
3050 SmallVector<const MDNode *, 16> Nodes;
3051 Nodes.resize(Machine.mdn_size());
3052 for (SlotTracker::mdn_iterator I = Machine.mdn_begin(), E = Machine.mdn_end();
3054 Nodes[I->second] = cast<MDNode>(I->first);
3056 for (unsigned i = 0, e = Nodes.size(); i != e; ++i) {
3057 writeMDNode(i, Nodes[i]);
3061 void AssemblyWriter::printMDNodeBody(const MDNode *Node) {
3062 WriteMDNodeBodyInternal(Out, Node, &TypePrinter, &Machine, TheModule);
3065 void AssemblyWriter::writeAllAttributeGroups() {
3066 std::vector<std::pair<AttributeSet, unsigned> > asVec;
3067 asVec.resize(Machine.as_size());
3069 for (SlotTracker::as_iterator I = Machine.as_begin(), E = Machine.as_end();
3071 asVec[I->second] = *I;
3073 for (std::vector<std::pair<AttributeSet, unsigned> >::iterator
3074 I = asVec.begin(), E = asVec.end(); I != E; ++I)
3075 Out << "attributes #" << I->second << " = { "
3076 << I->first.getAsString(AttributeSet::FunctionIndex, true) << " }\n";
3079 void AssemblyWriter::printUseListOrder(const UseListOrder &Order) {
3080 bool IsInFunction = Machine.getFunction();
3084 Out << "uselistorder";
3085 if (const BasicBlock *BB =
3086 IsInFunction ? nullptr : dyn_cast<BasicBlock>(Order.V)) {
3088 writeOperand(BB->getParent(), false);
3090 writeOperand(BB, false);
3093 writeOperand(Order.V, true);
3097 assert(Order.Shuffle.size() >= 2 && "Shuffle too small");
3098 Out << Order.Shuffle[0];
3099 for (unsigned I = 1, E = Order.Shuffle.size(); I != E; ++I)
3100 Out << ", " << Order.Shuffle[I];
3104 void AssemblyWriter::printUseLists(const Function *F) {
3106 [&]() { return !UseListOrders.empty() && UseListOrders.back().F == F; };
3111 Out << "\n; uselistorder directives\n";
3113 printUseListOrder(UseListOrders.back());
3114 UseListOrders.pop_back();
3118 //===----------------------------------------------------------------------===//
3119 // External Interface declarations
3120 //===----------------------------------------------------------------------===//
3122 void Function::print(raw_ostream &ROS, AssemblyAnnotationWriter *AAW) const {
3123 SlotTracker SlotTable(this->getParent());
3124 formatted_raw_ostream OS(ROS);
3125 AssemblyWriter W(OS, SlotTable, this->getParent(), AAW);
3126 W.printFunction(this);
3129 void Module::print(raw_ostream &ROS, AssemblyAnnotationWriter *AAW,
3130 bool ShouldPreserveUseListOrder) const {
3131 SlotTracker SlotTable(this);
3132 formatted_raw_ostream OS(ROS);
3133 AssemblyWriter W(OS, SlotTable, this, AAW, ShouldPreserveUseListOrder);
3134 W.printModule(this);
3137 void NamedMDNode::print(raw_ostream &ROS) const {
3138 SlotTracker SlotTable(getParent());
3139 formatted_raw_ostream OS(ROS);
3140 AssemblyWriter W(OS, SlotTable, getParent(), nullptr);
3141 W.printNamedMDNode(this);
3144 void Comdat::print(raw_ostream &ROS) const {
3145 PrintLLVMName(ROS, getName(), ComdatPrefix);
3146 ROS << " = comdat ";
3148 switch (getSelectionKind()) {
3152 case Comdat::ExactMatch:
3153 ROS << "exactmatch";
3155 case Comdat::Largest:
3158 case Comdat::NoDuplicates:
3159 ROS << "noduplicates";
3161 case Comdat::SameSize:
3169 void Type::print(raw_ostream &OS) const {
3171 TP.print(const_cast<Type*>(this), OS);
3173 // If the type is a named struct type, print the body as well.
3174 if (StructType *STy = dyn_cast<StructType>(const_cast<Type*>(this)))
3175 if (!STy->isLiteral()) {
3177 TP.printStructBody(STy, OS);
3181 static bool isReferencingMDNode(const Instruction &I) {
3182 if (const auto *CI = dyn_cast<CallInst>(&I))
3183 if (Function *F = CI->getCalledFunction())
3184 if (F->isIntrinsic())
3185 for (auto &Op : I.operands())
3186 if (auto *V = dyn_cast_or_null<MetadataAsValue>(Op))
3187 if (isa<MDNode>(V->getMetadata()))
3192 void Value::print(raw_ostream &ROS) const {
3193 formatted_raw_ostream OS(ROS);
3194 if (const Instruction *I = dyn_cast<Instruction>(this)) {
3195 const Function *F = I->getParent() ? I->getParent()->getParent() : nullptr;
3196 SlotTracker SlotTable(
3198 /* ShouldInitializeAllMetadata */ isReferencingMDNode(*I));
3199 AssemblyWriter W(OS, SlotTable, getModuleFromVal(I), nullptr);
3200 W.printInstruction(*I);
3201 } else if (const BasicBlock *BB = dyn_cast<BasicBlock>(this)) {
3202 SlotTracker SlotTable(BB->getParent());
3203 AssemblyWriter W(OS, SlotTable, getModuleFromVal(BB), nullptr);
3204 W.printBasicBlock(BB);
3205 } else if (const GlobalValue *GV = dyn_cast<GlobalValue>(this)) {
3206 SlotTracker SlotTable(GV->getParent(),
3207 /* ShouldInitializeAllMetadata */ isa<Function>(GV));
3208 AssemblyWriter W(OS, SlotTable, GV->getParent(), nullptr);
3209 if (const GlobalVariable *V = dyn_cast<GlobalVariable>(GV))
3211 else if (const Function *F = dyn_cast<Function>(GV))
3214 W.printAlias(cast<GlobalAlias>(GV));
3215 } else if (const MetadataAsValue *V = dyn_cast<MetadataAsValue>(this)) {
3216 V->getMetadata()->print(ROS, getModuleFromVal(V));
3217 } else if (const Constant *C = dyn_cast<Constant>(this)) {
3218 TypePrinting TypePrinter;
3219 TypePrinter.print(C->getType(), OS);
3221 WriteConstantInternal(OS, C, TypePrinter, nullptr, nullptr);
3222 } else if (isa<InlineAsm>(this) || isa<Argument>(this)) {
3223 this->printAsOperand(OS);
3225 llvm_unreachable("Unknown value to print out!");
3229 /// Print without a type, skipping the TypePrinting object.
3231 /// \return \c true iff printing was succesful.
3232 static bool printWithoutType(const Value &V, raw_ostream &O,
3233 SlotTracker *Machine, const Module *M) {
3234 if (V.hasName() || isa<GlobalValue>(V) ||
3235 (!isa<Constant>(V) && !isa<MetadataAsValue>(V))) {
3236 WriteAsOperandInternal(O, &V, nullptr, Machine, M);
3242 static void printAsOperandImpl(const Value &V, raw_ostream &O, bool PrintType,
3243 ModuleSlotTracker &MST) {
3244 TypePrinting TypePrinter;
3245 if (const Module *M = MST.getModule())
3246 TypePrinter.incorporateTypes(*M);
3248 TypePrinter.print(V.getType(), O);
3252 WriteAsOperandInternal(O, &V, &TypePrinter, MST.getMachine(),
3256 void Value::printAsOperand(raw_ostream &O, bool PrintType,
3257 const Module *M) const {
3259 M = getModuleFromVal(this);
3262 if (printWithoutType(*this, O, nullptr, M))
3265 SlotTracker Machine(
3266 M, /* ShouldInitializeAllMetadata */ isa<MetadataAsValue>(this));
3267 ModuleSlotTracker MST(Machine, M);
3268 printAsOperandImpl(*this, O, PrintType, MST);
3271 void Value::printAsOperand(raw_ostream &O, bool PrintType,
3272 ModuleSlotTracker &MST) const {
3274 if (printWithoutType(*this, O, MST.getMachine(), MST.getModule()))
3277 printAsOperandImpl(*this, O, PrintType, MST);
3280 static void printMetadataImpl(raw_ostream &ROS, const Metadata &MD,
3281 const Module *M, bool OnlyAsOperand) {
3282 formatted_raw_ostream OS(ROS);
3284 auto *N = dyn_cast<MDNode>(&MD);
3285 TypePrinting TypePrinter;
3286 SlotTracker Machine(M, /* ShouldInitializeAllMetadata */ N);
3288 TypePrinter.incorporateTypes(*M);
3290 WriteAsOperandInternal(OS, &MD, &TypePrinter, &Machine, M,
3291 /* FromValue */ true);
3292 if (OnlyAsOperand || !N)
3296 WriteMDNodeBodyInternal(OS, N, &TypePrinter, &Machine, M);
3299 void Metadata::printAsOperand(raw_ostream &OS, const Module *M) const {
3300 printMetadataImpl(OS, *this, M, /* OnlyAsOperand */ true);
3303 void Metadata::print(raw_ostream &OS, const Module *M) const {
3304 printMetadataImpl(OS, *this, M, /* OnlyAsOperand */ false);
3307 // Value::dump - allow easy printing of Values from the debugger.
3309 void Value::dump() const { print(dbgs()); dbgs() << '\n'; }
3311 // Type::dump - allow easy printing of Types from the debugger.
3313 void Type::dump() const { print(dbgs()); dbgs() << '\n'; }
3315 // Module::dump() - Allow printing of Modules from the debugger.
3317 void Module::dump() const { print(dbgs(), nullptr); }
3319 // \brief Allow printing of Comdats from the debugger.
3321 void Comdat::dump() const { print(dbgs()); }
3323 // NamedMDNode::dump() - Allow printing of NamedMDNodes from the debugger.
3325 void NamedMDNode::dump() const { print(dbgs()); }
3328 void Metadata::dump() const { dump(nullptr); }
3331 void Metadata::dump(const Module *M) const {