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/Operator.h"
34 #include "llvm/IR/TypeFinder.h"
35 #include "llvm/IR/UseListOrder.h"
36 #include "llvm/IR/ValueSymbolTable.h"
37 #include "llvm/Support/Debug.h"
38 #include "llvm/Support/Dwarf.h"
39 #include "llvm/Support/ErrorHandling.h"
40 #include "llvm/Support/FormattedStream.h"
41 #include "llvm/Support/MathExtras.h"
42 #include "llvm/Support/raw_ostream.h"
47 // Make virtual table appear in this compilation unit.
48 AssemblyAnnotationWriter::~AssemblyAnnotationWriter() {}
50 //===----------------------------------------------------------------------===//
52 //===----------------------------------------------------------------------===//
56 DenseMap<const Value *, std::pair<unsigned, bool>> IDs;
58 unsigned size() const { return IDs.size(); }
59 std::pair<unsigned, bool> &operator[](const Value *V) { return IDs[V]; }
60 std::pair<unsigned, bool> lookup(const Value *V) const {
63 void index(const Value *V) {
64 // Explicitly sequence get-size and insert-value operations to avoid UB.
65 unsigned ID = IDs.size() + 1;
71 static void orderValue(const Value *V, OrderMap &OM) {
72 if (OM.lookup(V).first)
75 if (const Constant *C = dyn_cast<Constant>(V))
76 if (C->getNumOperands() && !isa<GlobalValue>(C))
77 for (const Value *Op : C->operands())
78 if (!isa<BasicBlock>(Op) && !isa<GlobalValue>(Op))
81 // Note: we cannot cache this lookup above, since inserting into the map
82 // changes the map's size, and thus affects the other IDs.
86 static OrderMap orderModule(const Module *M) {
87 // This needs to match the order used by ValueEnumerator::ValueEnumerator()
88 // and ValueEnumerator::incorporateFunction().
91 for (const GlobalVariable &G : M->globals()) {
92 if (G.hasInitializer())
93 if (!isa<GlobalValue>(G.getInitializer()))
94 orderValue(G.getInitializer(), OM);
97 for (const GlobalAlias &A : M->aliases()) {
98 if (!isa<GlobalValue>(A.getAliasee()))
99 orderValue(A.getAliasee(), OM);
102 for (const Function &F : *M) {
103 if (F.hasPrefixData())
104 if (!isa<GlobalValue>(F.getPrefixData()))
105 orderValue(F.getPrefixData(), OM);
107 if (F.hasPrologueData())
108 if (!isa<GlobalValue>(F.getPrologueData()))
109 orderValue(F.getPrologueData(), OM);
113 if (F.isDeclaration())
116 for (const Argument &A : F.args())
118 for (const BasicBlock &BB : F) {
120 for (const Instruction &I : BB) {
121 for (const Value *Op : I.operands())
122 if ((isa<Constant>(*Op) && !isa<GlobalValue>(*Op)) ||
132 static void predictValueUseListOrderImpl(const Value *V, const Function *F,
133 unsigned ID, const OrderMap &OM,
134 UseListOrderStack &Stack) {
135 // Predict use-list order for this one.
136 typedef std::pair<const Use *, unsigned> Entry;
137 SmallVector<Entry, 64> List;
138 for (const Use &U : V->uses())
139 // Check if this user will be serialized.
140 if (OM.lookup(U.getUser()).first)
141 List.push_back(std::make_pair(&U, List.size()));
144 // We may have lost some users.
148 !isa<GlobalVariable>(V) && !isa<Function>(V) && !isa<BasicBlock>(V);
149 if (auto *BA = dyn_cast<BlockAddress>(V))
150 ID = OM.lookup(BA->getBasicBlock()).first;
151 std::sort(List.begin(), List.end(), [&](const Entry &L, const Entry &R) {
152 const Use *LU = L.first;
153 const Use *RU = R.first;
157 auto LID = OM.lookup(LU->getUser()).first;
158 auto RID = OM.lookup(RU->getUser()).first;
160 // If ID is 4, then expect: 7 6 5 1 2 3.
174 // LID and RID are equal, so we have different operands of the same user.
175 // Assume operands are added in order for all instructions.
178 return LU->getOperandNo() < RU->getOperandNo();
179 return LU->getOperandNo() > RU->getOperandNo();
183 List.begin(), List.end(),
184 [](const Entry &L, const Entry &R) { return L.second < R.second; }))
185 // Order is already correct.
188 // Store the shuffle.
189 Stack.emplace_back(V, F, List.size());
190 assert(List.size() == Stack.back().Shuffle.size() && "Wrong size");
191 for (size_t I = 0, E = List.size(); I != E; ++I)
192 Stack.back().Shuffle[I] = List[I].second;
195 static void predictValueUseListOrder(const Value *V, const Function *F,
196 OrderMap &OM, UseListOrderStack &Stack) {
197 auto &IDPair = OM[V];
198 assert(IDPair.first && "Unmapped value");
200 // Already predicted.
203 // Do the actual prediction.
204 IDPair.second = true;
205 if (!V->use_empty() && std::next(V->use_begin()) != V->use_end())
206 predictValueUseListOrderImpl(V, F, IDPair.first, OM, Stack);
208 // Recursive descent into constants.
209 if (const Constant *C = dyn_cast<Constant>(V))
210 if (C->getNumOperands()) // Visit GlobalValues.
211 for (const Value *Op : C->operands())
212 if (isa<Constant>(Op)) // Visit GlobalValues.
213 predictValueUseListOrder(Op, F, OM, Stack);
216 static UseListOrderStack predictUseListOrder(const Module *M) {
217 OrderMap OM = orderModule(M);
219 // Use-list orders need to be serialized after all the users have been added
220 // to a value, or else the shuffles will be incomplete. Store them per
221 // function in a stack.
223 // Aside from function order, the order of values doesn't matter much here.
224 UseListOrderStack Stack;
226 // We want to visit the functions backward now so we can list function-local
227 // constants in the last Function they're used in. Module-level constants
228 // have already been visited above.
229 for (auto I = M->rbegin(), E = M->rend(); I != E; ++I) {
230 const Function &F = *I;
231 if (F.isDeclaration())
233 for (const BasicBlock &BB : F)
234 predictValueUseListOrder(&BB, &F, OM, Stack);
235 for (const Argument &A : F.args())
236 predictValueUseListOrder(&A, &F, OM, Stack);
237 for (const BasicBlock &BB : F)
238 for (const Instruction &I : BB)
239 for (const Value *Op : I.operands())
240 if (isa<Constant>(*Op) || isa<InlineAsm>(*Op)) // Visit GlobalValues.
241 predictValueUseListOrder(Op, &F, OM, Stack);
242 for (const BasicBlock &BB : F)
243 for (const Instruction &I : BB)
244 predictValueUseListOrder(&I, &F, OM, Stack);
247 // Visit globals last.
248 for (const GlobalVariable &G : M->globals())
249 predictValueUseListOrder(&G, nullptr, OM, Stack);
250 for (const Function &F : *M)
251 predictValueUseListOrder(&F, nullptr, OM, Stack);
252 for (const GlobalAlias &A : M->aliases())
253 predictValueUseListOrder(&A, nullptr, OM, Stack);
254 for (const GlobalVariable &G : M->globals())
255 if (G.hasInitializer())
256 predictValueUseListOrder(G.getInitializer(), nullptr, OM, Stack);
257 for (const GlobalAlias &A : M->aliases())
258 predictValueUseListOrder(A.getAliasee(), nullptr, OM, Stack);
259 for (const Function &F : *M)
260 if (F.hasPrefixData())
261 predictValueUseListOrder(F.getPrefixData(), nullptr, OM, Stack);
266 static const Module *getModuleFromVal(const Value *V) {
267 if (const Argument *MA = dyn_cast<Argument>(V))
268 return MA->getParent() ? MA->getParent()->getParent() : nullptr;
270 if (const BasicBlock *BB = dyn_cast<BasicBlock>(V))
271 return BB->getParent() ? BB->getParent()->getParent() : nullptr;
273 if (const Instruction *I = dyn_cast<Instruction>(V)) {
274 const Function *M = I->getParent() ? I->getParent()->getParent() : nullptr;
275 return M ? M->getParent() : nullptr;
278 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V))
279 return GV->getParent();
281 if (const auto *MAV = dyn_cast<MetadataAsValue>(V)) {
282 for (const User *U : MAV->users())
283 if (isa<Instruction>(U))
284 if (const Module *M = getModuleFromVal(U))
292 static void PrintCallingConv(unsigned cc, raw_ostream &Out) {
294 default: Out << "cc" << cc; break;
295 case CallingConv::Fast: Out << "fastcc"; break;
296 case CallingConv::Cold: Out << "coldcc"; break;
297 case CallingConv::WebKit_JS: Out << "webkit_jscc"; break;
298 case CallingConv::AnyReg: Out << "anyregcc"; break;
299 case CallingConv::PreserveMost: Out << "preserve_mostcc"; break;
300 case CallingConv::PreserveAll: Out << "preserve_allcc"; break;
301 case CallingConv::GHC: Out << "ghccc"; break;
302 case CallingConv::X86_StdCall: Out << "x86_stdcallcc"; break;
303 case CallingConv::X86_FastCall: Out << "x86_fastcallcc"; break;
304 case CallingConv::X86_ThisCall: Out << "x86_thiscallcc"; break;
305 case CallingConv::X86_VectorCall:Out << "x86_vectorcallcc"; break;
306 case CallingConv::Intel_OCL_BI: Out << "intel_ocl_bicc"; break;
307 case CallingConv::ARM_APCS: Out << "arm_apcscc"; break;
308 case CallingConv::ARM_AAPCS: Out << "arm_aapcscc"; break;
309 case CallingConv::ARM_AAPCS_VFP: Out << "arm_aapcs_vfpcc"; break;
310 case CallingConv::MSP430_INTR: Out << "msp430_intrcc"; break;
311 case CallingConv::PTX_Kernel: Out << "ptx_kernel"; break;
312 case CallingConv::PTX_Device: Out << "ptx_device"; break;
313 case CallingConv::X86_64_SysV: Out << "x86_64_sysvcc"; break;
314 case CallingConv::X86_64_Win64: Out << "x86_64_win64cc"; break;
315 case CallingConv::SPIR_FUNC: Out << "spir_func"; break;
316 case CallingConv::SPIR_KERNEL: Out << "spir_kernel"; break;
320 // PrintEscapedString - Print each character of the specified string, escaping
321 // it if it is not printable or if it is an escape char.
322 static void PrintEscapedString(StringRef Name, raw_ostream &Out) {
323 for (unsigned i = 0, e = Name.size(); i != e; ++i) {
324 unsigned char C = Name[i];
325 if (isprint(C) && C != '\\' && C != '"')
328 Out << '\\' << hexdigit(C >> 4) << hexdigit(C & 0x0F);
340 /// PrintLLVMName - Turn the specified name into an 'LLVM name', which is either
341 /// prefixed with % (if the string only contains simple characters) or is
342 /// surrounded with ""'s (if it has special chars in it). Print it out.
343 static void PrintLLVMName(raw_ostream &OS, StringRef Name, PrefixType Prefix) {
344 assert(!Name.empty() && "Cannot get empty name!");
346 case NoPrefix: break;
347 case GlobalPrefix: OS << '@'; break;
348 case ComdatPrefix: OS << '$'; break;
349 case LabelPrefix: break;
350 case LocalPrefix: OS << '%'; break;
353 // Scan the name to see if it needs quotes first.
354 bool NeedsQuotes = isdigit(static_cast<unsigned char>(Name[0]));
356 for (unsigned i = 0, e = Name.size(); i != e; ++i) {
357 // By making this unsigned, the value passed in to isalnum will always be
358 // in the range 0-255. This is important when building with MSVC because
359 // its implementation will assert. This situation can arise when dealing
360 // with UTF-8 multibyte characters.
361 unsigned char C = Name[i];
362 if (!isalnum(static_cast<unsigned char>(C)) && C != '-' && C != '.' &&
370 // If we didn't need any quotes, just write out the name in one blast.
376 // Okay, we need quotes. Output the quotes and escape any scary characters as
379 PrintEscapedString(Name, OS);
383 /// PrintLLVMName - Turn the specified name into an 'LLVM name', which is either
384 /// prefixed with % (if the string only contains simple characters) or is
385 /// surrounded with ""'s (if it has special chars in it). Print it out.
386 static void PrintLLVMName(raw_ostream &OS, const Value *V) {
387 PrintLLVMName(OS, V->getName(),
388 isa<GlobalValue>(V) ? GlobalPrefix : LocalPrefix);
394 TypePrinting(const TypePrinting &) = delete;
395 void operator=(const TypePrinting&) = delete;
398 /// NamedTypes - The named types that are used by the current module.
399 TypeFinder NamedTypes;
401 /// NumberedTypes - The numbered types, along with their value.
402 DenseMap<StructType*, unsigned> NumberedTypes;
404 TypePrinting() = default;
406 void incorporateTypes(const Module &M);
408 void print(Type *Ty, raw_ostream &OS);
410 void printStructBody(StructType *Ty, raw_ostream &OS);
414 void TypePrinting::incorporateTypes(const Module &M) {
415 NamedTypes.run(M, false);
417 // The list of struct types we got back includes all the struct types, split
418 // the unnamed ones out to a numbering and remove the anonymous structs.
419 unsigned NextNumber = 0;
421 std::vector<StructType*>::iterator NextToUse = NamedTypes.begin(), I, E;
422 for (I = NamedTypes.begin(), E = NamedTypes.end(); I != E; ++I) {
423 StructType *STy = *I;
425 // Ignore anonymous types.
426 if (STy->isLiteral())
429 if (STy->getName().empty())
430 NumberedTypes[STy] = NextNumber++;
435 NamedTypes.erase(NextToUse, NamedTypes.end());
439 /// CalcTypeName - Write the specified type to the specified raw_ostream, making
440 /// use of type names or up references to shorten the type name where possible.
441 void TypePrinting::print(Type *Ty, raw_ostream &OS) {
442 switch (Ty->getTypeID()) {
443 case Type::VoidTyID: OS << "void"; return;
444 case Type::HalfTyID: OS << "half"; return;
445 case Type::FloatTyID: OS << "float"; return;
446 case Type::DoubleTyID: OS << "double"; return;
447 case Type::X86_FP80TyID: OS << "x86_fp80"; return;
448 case Type::FP128TyID: OS << "fp128"; return;
449 case Type::PPC_FP128TyID: OS << "ppc_fp128"; return;
450 case Type::LabelTyID: OS << "label"; return;
451 case Type::MetadataTyID: OS << "metadata"; return;
452 case Type::X86_MMXTyID: OS << "x86_mmx"; return;
453 case Type::IntegerTyID:
454 OS << 'i' << cast<IntegerType>(Ty)->getBitWidth();
457 case Type::FunctionTyID: {
458 FunctionType *FTy = cast<FunctionType>(Ty);
459 print(FTy->getReturnType(), OS);
461 for (FunctionType::param_iterator I = FTy->param_begin(),
462 E = FTy->param_end(); I != E; ++I) {
463 if (I != FTy->param_begin())
467 if (FTy->isVarArg()) {
468 if (FTy->getNumParams()) OS << ", ";
474 case Type::StructTyID: {
475 StructType *STy = cast<StructType>(Ty);
477 if (STy->isLiteral())
478 return printStructBody(STy, OS);
480 if (!STy->getName().empty())
481 return PrintLLVMName(OS, STy->getName(), LocalPrefix);
483 DenseMap<StructType*, unsigned>::iterator I = NumberedTypes.find(STy);
484 if (I != NumberedTypes.end())
485 OS << '%' << I->second;
486 else // Not enumerated, print the hex address.
487 OS << "%\"type " << STy << '\"';
490 case Type::PointerTyID: {
491 PointerType *PTy = cast<PointerType>(Ty);
492 print(PTy->getElementType(), OS);
493 if (unsigned AddressSpace = PTy->getAddressSpace())
494 OS << " addrspace(" << AddressSpace << ')';
498 case Type::ArrayTyID: {
499 ArrayType *ATy = cast<ArrayType>(Ty);
500 OS << '[' << ATy->getNumElements() << " x ";
501 print(ATy->getElementType(), OS);
505 case Type::VectorTyID: {
506 VectorType *PTy = cast<VectorType>(Ty);
507 OS << "<" << PTy->getNumElements() << " x ";
508 print(PTy->getElementType(), OS);
513 llvm_unreachable("Invalid TypeID");
516 void TypePrinting::printStructBody(StructType *STy, raw_ostream &OS) {
517 if (STy->isOpaque()) {
525 if (STy->getNumElements() == 0) {
528 StructType::element_iterator I = STy->element_begin();
531 for (StructType::element_iterator E = STy->element_end(); I != E; ++I) {
543 //===----------------------------------------------------------------------===//
544 // SlotTracker Class: Enumerate slot numbers for unnamed values
545 //===----------------------------------------------------------------------===//
546 /// This class provides computation of slot numbers for LLVM Assembly writing.
550 /// ValueMap - A mapping of Values to slot numbers.
551 typedef DenseMap<const Value*, unsigned> ValueMap;
554 /// TheModule - The module for which we are holding slot numbers.
555 const Module* TheModule;
557 /// TheFunction - The function for which we are holding slot numbers.
558 const Function* TheFunction;
559 bool FunctionProcessed;
560 bool ShouldInitializeAllMetadata;
562 /// mMap - The slot map for the module level data.
566 /// fMap - The slot map for the function level data.
570 /// mdnMap - Map for MDNodes.
571 DenseMap<const MDNode*, unsigned> mdnMap;
574 /// asMap - The slot map for attribute sets.
575 DenseMap<AttributeSet, unsigned> asMap;
578 /// Construct from a module.
580 /// If \c ShouldInitializeAllMetadata, initializes all metadata in all
581 /// functions, giving correct numbering for metadata referenced only from
582 /// within a function (even if no functions have been initialized).
583 explicit SlotTracker(const Module *M,
584 bool ShouldInitializeAllMetadata = false);
585 /// Construct from a function, starting out in incorp state.
587 /// If \c ShouldInitializeAllMetadata, initializes all metadata in all
588 /// functions, giving correct numbering for metadata referenced only from
589 /// within a function (even if no functions have been initialized).
590 explicit SlotTracker(const Function *F,
591 bool ShouldInitializeAllMetadata = false);
593 /// Return the slot number of the specified value in it's type
594 /// plane. If something is not in the SlotTracker, return -1.
595 int getLocalSlot(const Value *V);
596 int getGlobalSlot(const GlobalValue *V);
597 int getMetadataSlot(const MDNode *N);
598 int getAttributeGroupSlot(AttributeSet AS);
600 /// If you'd like to deal with a function instead of just a module, use
601 /// this method to get its data into the SlotTracker.
602 void incorporateFunction(const Function *F) {
604 FunctionProcessed = false;
607 const Function *getFunction() const { return TheFunction; }
609 /// After calling incorporateFunction, use this method to remove the
610 /// most recently incorporated function from the SlotTracker. This
611 /// will reset the state of the machine back to just the module contents.
612 void purgeFunction();
614 /// MDNode map iterators.
615 typedef DenseMap<const MDNode*, unsigned>::iterator mdn_iterator;
616 mdn_iterator mdn_begin() { return mdnMap.begin(); }
617 mdn_iterator mdn_end() { return mdnMap.end(); }
618 unsigned mdn_size() const { return mdnMap.size(); }
619 bool mdn_empty() const { return mdnMap.empty(); }
621 /// AttributeSet map iterators.
622 typedef DenseMap<AttributeSet, unsigned>::iterator as_iterator;
623 as_iterator as_begin() { return asMap.begin(); }
624 as_iterator as_end() { return asMap.end(); }
625 unsigned as_size() const { return asMap.size(); }
626 bool as_empty() const { return asMap.empty(); }
628 /// This function does the actual initialization.
629 inline void initialize();
631 // Implementation Details
633 /// CreateModuleSlot - Insert the specified GlobalValue* into the slot table.
634 void CreateModuleSlot(const GlobalValue *V);
636 /// CreateMetadataSlot - Insert the specified MDNode* into the slot table.
637 void CreateMetadataSlot(const MDNode *N);
639 /// CreateFunctionSlot - Insert the specified Value* into the slot table.
640 void CreateFunctionSlot(const Value *V);
642 /// \brief Insert the specified AttributeSet into the slot table.
643 void CreateAttributeSetSlot(AttributeSet AS);
645 /// Add all of the module level global variables (and their initializers)
646 /// and function declarations, but not the contents of those functions.
647 void processModule();
649 /// Add all of the functions arguments, basic blocks, and instructions.
650 void processFunction();
652 /// Add all of the metadata from a function.
653 void processFunctionMetadata(const Function &F);
655 /// Add all of the metadata from an instruction.
656 void processInstructionMetadata(const Instruction &I);
658 SlotTracker(const SlotTracker &) = delete;
659 void operator=(const SlotTracker &) = delete;
663 static SlotTracker *createSlotTracker(const Module *M) {
664 return new SlotTracker(M);
667 static SlotTracker *createSlotTracker(const Value *V) {
668 if (const Argument *FA = dyn_cast<Argument>(V))
669 return new SlotTracker(FA->getParent());
671 if (const Instruction *I = dyn_cast<Instruction>(V))
673 return new SlotTracker(I->getParent()->getParent());
675 if (const BasicBlock *BB = dyn_cast<BasicBlock>(V))
676 return new SlotTracker(BB->getParent());
678 if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(V))
679 return new SlotTracker(GV->getParent());
681 if (const GlobalAlias *GA = dyn_cast<GlobalAlias>(V))
682 return new SlotTracker(GA->getParent());
684 if (const Function *Func = dyn_cast<Function>(V))
685 return new SlotTracker(Func);
691 #define ST_DEBUG(X) dbgs() << X
696 // Module level constructor. Causes the contents of the Module (sans functions)
697 // to be added to the slot table.
698 SlotTracker::SlotTracker(const Module *M, bool ShouldInitializeAllMetadata)
699 : TheModule(M), TheFunction(nullptr), FunctionProcessed(false),
700 ShouldInitializeAllMetadata(ShouldInitializeAllMetadata), mNext(0),
701 fNext(0), mdnNext(0), asNext(0) {}
703 // Function level constructor. Causes the contents of the Module and the one
704 // function provided to be added to the slot table.
705 SlotTracker::SlotTracker(const Function *F, bool ShouldInitializeAllMetadata)
706 : TheModule(F ? F->getParent() : nullptr), TheFunction(F),
707 FunctionProcessed(false),
708 ShouldInitializeAllMetadata(ShouldInitializeAllMetadata), mNext(0),
709 fNext(0), mdnNext(0), asNext(0) {}
711 inline void SlotTracker::initialize() {
714 TheModule = nullptr; ///< Prevent re-processing next time we're called.
717 if (TheFunction && !FunctionProcessed)
721 // Iterate through all the global variables, functions, and global
722 // variable initializers and create slots for them.
723 void SlotTracker::processModule() {
724 ST_DEBUG("begin processModule!\n");
726 // Add all of the unnamed global variables to the value table.
727 for (Module::const_global_iterator I = TheModule->global_begin(),
728 E = TheModule->global_end(); I != E; ++I) {
733 // Add metadata used by named metadata.
734 for (Module::const_named_metadata_iterator
735 I = TheModule->named_metadata_begin(),
736 E = TheModule->named_metadata_end(); I != E; ++I) {
737 const NamedMDNode *NMD = I;
738 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i)
739 CreateMetadataSlot(NMD->getOperand(i));
742 for (Module::const_iterator I = TheModule->begin(), E = TheModule->end();
745 // Add all the unnamed functions to the table.
748 if (ShouldInitializeAllMetadata)
749 processFunctionMetadata(*I);
751 // Add all the function attributes to the table.
752 // FIXME: Add attributes of other objects?
753 AttributeSet FnAttrs = I->getAttributes().getFnAttributes();
754 if (FnAttrs.hasAttributes(AttributeSet::FunctionIndex))
755 CreateAttributeSetSlot(FnAttrs);
758 ST_DEBUG("end processModule!\n");
761 // Process the arguments, basic blocks, and instructions of a function.
762 void SlotTracker::processFunction() {
763 ST_DEBUG("begin processFunction!\n");
766 // Add all the function arguments with no names.
767 for(Function::const_arg_iterator AI = TheFunction->arg_begin(),
768 AE = TheFunction->arg_end(); AI != AE; ++AI)
770 CreateFunctionSlot(AI);
772 ST_DEBUG("Inserting Instructions:\n");
774 // Add all of the basic blocks and instructions with no names.
775 for (auto &BB : *TheFunction) {
777 CreateFunctionSlot(&BB);
779 processFunctionMetadata(*TheFunction);
782 if (!I.getType()->isVoidTy() && !I.hasName())
783 CreateFunctionSlot(&I);
785 // We allow direct calls to any llvm.foo function here, because the
786 // target may not be linked into the optimizer.
787 if (const CallInst *CI = dyn_cast<CallInst>(&I)) {
788 // Add all the call attributes to the table.
789 AttributeSet Attrs = CI->getAttributes().getFnAttributes();
790 if (Attrs.hasAttributes(AttributeSet::FunctionIndex))
791 CreateAttributeSetSlot(Attrs);
792 } else if (const InvokeInst *II = dyn_cast<InvokeInst>(&I)) {
793 // Add all the call attributes to the table.
794 AttributeSet Attrs = II->getAttributes().getFnAttributes();
795 if (Attrs.hasAttributes(AttributeSet::FunctionIndex))
796 CreateAttributeSetSlot(Attrs);
801 FunctionProcessed = true;
803 ST_DEBUG("end processFunction!\n");
806 void SlotTracker::processFunctionMetadata(const Function &F) {
807 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
809 F.getAllMetadata(MDs);
811 CreateMetadataSlot(MD.second);
814 processInstructionMetadata(I);
818 void SlotTracker::processInstructionMetadata(const Instruction &I) {
819 // Process metadata used directly by intrinsics.
820 if (const CallInst *CI = dyn_cast<CallInst>(&I))
821 if (Function *F = CI->getCalledFunction())
822 if (F->isIntrinsic())
823 for (auto &Op : I.operands())
824 if (auto *V = dyn_cast_or_null<MetadataAsValue>(Op))
825 if (MDNode *N = dyn_cast<MDNode>(V->getMetadata()))
826 CreateMetadataSlot(N);
828 // Process metadata attached to this instruction.
829 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
830 I.getAllMetadata(MDs);
832 CreateMetadataSlot(MD.second);
835 /// Clean up after incorporating a function. This is the only way to get out of
836 /// the function incorporation state that affects get*Slot/Create*Slot. Function
837 /// incorporation state is indicated by TheFunction != 0.
838 void SlotTracker::purgeFunction() {
839 ST_DEBUG("begin purgeFunction!\n");
840 fMap.clear(); // Simply discard the function level map
841 TheFunction = nullptr;
842 FunctionProcessed = false;
843 ST_DEBUG("end purgeFunction!\n");
846 /// getGlobalSlot - Get the slot number of a global value.
847 int SlotTracker::getGlobalSlot(const GlobalValue *V) {
848 // Check for uninitialized state and do lazy initialization.
851 // Find the value in the module map
852 ValueMap::iterator MI = mMap.find(V);
853 return MI == mMap.end() ? -1 : (int)MI->second;
856 /// getMetadataSlot - Get the slot number of a MDNode.
857 int SlotTracker::getMetadataSlot(const MDNode *N) {
858 // Check for uninitialized state and do lazy initialization.
861 // Find the MDNode in the module map
862 mdn_iterator MI = mdnMap.find(N);
863 return MI == mdnMap.end() ? -1 : (int)MI->second;
867 /// getLocalSlot - Get the slot number for a value that is local to a function.
868 int SlotTracker::getLocalSlot(const Value *V) {
869 assert(!isa<Constant>(V) && "Can't get a constant or global slot with this!");
871 // Check for uninitialized state and do lazy initialization.
874 ValueMap::iterator FI = fMap.find(V);
875 return FI == fMap.end() ? -1 : (int)FI->second;
878 int SlotTracker::getAttributeGroupSlot(AttributeSet AS) {
879 // Check for uninitialized state and do lazy initialization.
882 // Find the AttributeSet in the module map.
883 as_iterator AI = asMap.find(AS);
884 return AI == asMap.end() ? -1 : (int)AI->second;
887 /// CreateModuleSlot - Insert the specified GlobalValue* into the slot table.
888 void SlotTracker::CreateModuleSlot(const GlobalValue *V) {
889 assert(V && "Can't insert a null Value into SlotTracker!");
890 assert(!V->getType()->isVoidTy() && "Doesn't need a slot!");
891 assert(!V->hasName() && "Doesn't need a slot!");
893 unsigned DestSlot = mNext++;
896 ST_DEBUG(" Inserting value [" << V->getType() << "] = " << V << " slot=" <<
898 // G = Global, F = Function, A = Alias, o = other
899 ST_DEBUG((isa<GlobalVariable>(V) ? 'G' :
900 (isa<Function>(V) ? 'F' :
901 (isa<GlobalAlias>(V) ? 'A' : 'o'))) << "]\n");
904 /// CreateSlot - Create a new slot for the specified value if it has no name.
905 void SlotTracker::CreateFunctionSlot(const Value *V) {
906 assert(!V->getType()->isVoidTy() && !V->hasName() && "Doesn't need a slot!");
908 unsigned DestSlot = fNext++;
911 // G = Global, F = Function, o = other
912 ST_DEBUG(" Inserting value [" << V->getType() << "] = " << V << " slot=" <<
913 DestSlot << " [o]\n");
916 /// CreateModuleSlot - Insert the specified MDNode* into the slot table.
917 void SlotTracker::CreateMetadataSlot(const MDNode *N) {
918 assert(N && "Can't insert a null Value into SlotTracker!");
920 unsigned DestSlot = mdnNext;
921 if (!mdnMap.insert(std::make_pair(N, DestSlot)).second)
925 // Recursively add any MDNodes referenced by operands.
926 for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i)
927 if (const MDNode *Op = dyn_cast_or_null<MDNode>(N->getOperand(i)))
928 CreateMetadataSlot(Op);
931 void SlotTracker::CreateAttributeSetSlot(AttributeSet AS) {
932 assert(AS.hasAttributes(AttributeSet::FunctionIndex) &&
933 "Doesn't need a slot!");
935 as_iterator I = asMap.find(AS);
936 if (I != asMap.end())
939 unsigned DestSlot = asNext++;
940 asMap[AS] = DestSlot;
943 //===----------------------------------------------------------------------===//
944 // AsmWriter Implementation
945 //===----------------------------------------------------------------------===//
947 static void WriteAsOperandInternal(raw_ostream &Out, const Value *V,
948 TypePrinting *TypePrinter,
949 SlotTracker *Machine,
950 const Module *Context);
952 static void WriteAsOperandInternal(raw_ostream &Out, const Metadata *MD,
953 TypePrinting *TypePrinter,
954 SlotTracker *Machine, const Module *Context,
955 bool FromValue = false);
957 static const char *getPredicateText(unsigned predicate) {
958 const char * pred = "unknown";
960 case FCmpInst::FCMP_FALSE: pred = "false"; break;
961 case FCmpInst::FCMP_OEQ: pred = "oeq"; break;
962 case FCmpInst::FCMP_OGT: pred = "ogt"; break;
963 case FCmpInst::FCMP_OGE: pred = "oge"; break;
964 case FCmpInst::FCMP_OLT: pred = "olt"; break;
965 case FCmpInst::FCMP_OLE: pred = "ole"; break;
966 case FCmpInst::FCMP_ONE: pred = "one"; break;
967 case FCmpInst::FCMP_ORD: pred = "ord"; break;
968 case FCmpInst::FCMP_UNO: pred = "uno"; break;
969 case FCmpInst::FCMP_UEQ: pred = "ueq"; break;
970 case FCmpInst::FCMP_UGT: pred = "ugt"; break;
971 case FCmpInst::FCMP_UGE: pred = "uge"; break;
972 case FCmpInst::FCMP_ULT: pred = "ult"; break;
973 case FCmpInst::FCMP_ULE: pred = "ule"; break;
974 case FCmpInst::FCMP_UNE: pred = "une"; break;
975 case FCmpInst::FCMP_TRUE: pred = "true"; break;
976 case ICmpInst::ICMP_EQ: pred = "eq"; break;
977 case ICmpInst::ICMP_NE: pred = "ne"; break;
978 case ICmpInst::ICMP_SGT: pred = "sgt"; break;
979 case ICmpInst::ICMP_SGE: pred = "sge"; break;
980 case ICmpInst::ICMP_SLT: pred = "slt"; break;
981 case ICmpInst::ICMP_SLE: pred = "sle"; break;
982 case ICmpInst::ICMP_UGT: pred = "ugt"; break;
983 case ICmpInst::ICMP_UGE: pred = "uge"; break;
984 case ICmpInst::ICMP_ULT: pred = "ult"; break;
985 case ICmpInst::ICMP_ULE: pred = "ule"; break;
990 static void writeAtomicRMWOperation(raw_ostream &Out,
991 AtomicRMWInst::BinOp Op) {
993 default: Out << " <unknown operation " << Op << ">"; break;
994 case AtomicRMWInst::Xchg: Out << " xchg"; break;
995 case AtomicRMWInst::Add: Out << " add"; break;
996 case AtomicRMWInst::Sub: Out << " sub"; break;
997 case AtomicRMWInst::And: Out << " and"; break;
998 case AtomicRMWInst::Nand: Out << " nand"; break;
999 case AtomicRMWInst::Or: Out << " or"; break;
1000 case AtomicRMWInst::Xor: Out << " xor"; break;
1001 case AtomicRMWInst::Max: Out << " max"; break;
1002 case AtomicRMWInst::Min: Out << " min"; break;
1003 case AtomicRMWInst::UMax: Out << " umax"; break;
1004 case AtomicRMWInst::UMin: Out << " umin"; break;
1008 static void WriteOptimizationInfo(raw_ostream &Out, const User *U) {
1009 if (const FPMathOperator *FPO = dyn_cast<const FPMathOperator>(U)) {
1010 // Unsafe algebra implies all the others, no need to write them all out
1011 if (FPO->hasUnsafeAlgebra())
1014 if (FPO->hasNoNaNs())
1016 if (FPO->hasNoInfs())
1018 if (FPO->hasNoSignedZeros())
1020 if (FPO->hasAllowReciprocal())
1025 if (const OverflowingBinaryOperator *OBO =
1026 dyn_cast<OverflowingBinaryOperator>(U)) {
1027 if (OBO->hasNoUnsignedWrap())
1029 if (OBO->hasNoSignedWrap())
1031 } else if (const PossiblyExactOperator *Div =
1032 dyn_cast<PossiblyExactOperator>(U)) {
1035 } else if (const GEPOperator *GEP = dyn_cast<GEPOperator>(U)) {
1036 if (GEP->isInBounds())
1041 static void WriteConstantInternal(raw_ostream &Out, const Constant *CV,
1042 TypePrinting &TypePrinter,
1043 SlotTracker *Machine,
1044 const Module *Context) {
1045 if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV)) {
1046 if (CI->getType()->isIntegerTy(1)) {
1047 Out << (CI->getZExtValue() ? "true" : "false");
1050 Out << CI->getValue();
1054 if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV)) {
1055 if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEsingle ||
1056 &CFP->getValueAPF().getSemantics() == &APFloat::IEEEdouble) {
1057 // We would like to output the FP constant value in exponential notation,
1058 // but we cannot do this if doing so will lose precision. Check here to
1059 // make sure that we only output it in exponential format if we can parse
1060 // the value back and get the same value.
1063 bool isHalf = &CFP->getValueAPF().getSemantics()==&APFloat::IEEEhalf;
1064 bool isDouble = &CFP->getValueAPF().getSemantics()==&APFloat::IEEEdouble;
1065 bool isInf = CFP->getValueAPF().isInfinity();
1066 bool isNaN = CFP->getValueAPF().isNaN();
1067 if (!isHalf && !isInf && !isNaN) {
1068 double Val = isDouble ? CFP->getValueAPF().convertToDouble() :
1069 CFP->getValueAPF().convertToFloat();
1070 SmallString<128> StrVal;
1071 raw_svector_ostream(StrVal) << Val;
1073 // Check to make sure that the stringized number is not some string like
1074 // "Inf" or NaN, that atof will accept, but the lexer will not. Check
1075 // that the string matches the "[-+]?[0-9]" regex.
1077 if ((StrVal[0] >= '0' && StrVal[0] <= '9') ||
1078 ((StrVal[0] == '-' || StrVal[0] == '+') &&
1079 (StrVal[1] >= '0' && StrVal[1] <= '9'))) {
1080 // Reparse stringized version!
1081 if (APFloat(APFloat::IEEEdouble, StrVal).convertToDouble() == Val) {
1087 // Otherwise we could not reparse it to exactly the same value, so we must
1088 // output the string in hexadecimal format! Note that loading and storing
1089 // floating point types changes the bits of NaNs on some hosts, notably
1090 // x86, so we must not use these types.
1091 static_assert(sizeof(double) == sizeof(uint64_t),
1092 "assuming that double is 64 bits!");
1094 APFloat apf = CFP->getValueAPF();
1095 // Halves and floats are represented in ASCII IR as double, convert.
1097 apf.convert(APFloat::IEEEdouble, APFloat::rmNearestTiesToEven,
1100 utohex_buffer(uint64_t(apf.bitcastToAPInt().getZExtValue()),
1105 // Either half, or some form of long double.
1106 // These appear as a magic letter identifying the type, then a
1107 // fixed number of hex digits.
1109 // Bit position, in the current word, of the next nibble to print.
1112 if (&CFP->getValueAPF().getSemantics() == &APFloat::x87DoubleExtended) {
1114 // api needed to prevent premature destruction
1115 APInt api = CFP->getValueAPF().bitcastToAPInt();
1116 const uint64_t* p = api.getRawData();
1117 uint64_t word = p[1];
1119 int width = api.getBitWidth();
1120 for (int j=0; j<width; j+=4, shiftcount-=4) {
1121 unsigned int nibble = (word>>shiftcount) & 15;
1123 Out << (unsigned char)(nibble + '0');
1125 Out << (unsigned char)(nibble - 10 + 'A');
1126 if (shiftcount == 0 && j+4 < width) {
1130 shiftcount = width-j-4;
1134 } else if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEquad) {
1137 } else if (&CFP->getValueAPF().getSemantics() == &APFloat::PPCDoubleDouble) {
1140 } else if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEhalf) {
1144 llvm_unreachable("Unsupported floating point type");
1145 // api needed to prevent premature destruction
1146 APInt api = CFP->getValueAPF().bitcastToAPInt();
1147 const uint64_t* p = api.getRawData();
1149 int width = api.getBitWidth();
1150 for (int j=0; j<width; j+=4, shiftcount-=4) {
1151 unsigned int nibble = (word>>shiftcount) & 15;
1153 Out << (unsigned char)(nibble + '0');
1155 Out << (unsigned char)(nibble - 10 + 'A');
1156 if (shiftcount == 0 && j+4 < width) {
1160 shiftcount = width-j-4;
1166 if (isa<ConstantAggregateZero>(CV)) {
1167 Out << "zeroinitializer";
1171 if (const BlockAddress *BA = dyn_cast<BlockAddress>(CV)) {
1172 Out << "blockaddress(";
1173 WriteAsOperandInternal(Out, BA->getFunction(), &TypePrinter, Machine,
1176 WriteAsOperandInternal(Out, BA->getBasicBlock(), &TypePrinter, Machine,
1182 if (const ConstantArray *CA = dyn_cast<ConstantArray>(CV)) {
1183 Type *ETy = CA->getType()->getElementType();
1185 TypePrinter.print(ETy, Out);
1187 WriteAsOperandInternal(Out, CA->getOperand(0),
1188 &TypePrinter, Machine,
1190 for (unsigned i = 1, e = CA->getNumOperands(); i != e; ++i) {
1192 TypePrinter.print(ETy, Out);
1194 WriteAsOperandInternal(Out, CA->getOperand(i), &TypePrinter, Machine,
1201 if (const ConstantDataArray *CA = dyn_cast<ConstantDataArray>(CV)) {
1202 // As a special case, print the array as a string if it is an array of
1203 // i8 with ConstantInt values.
1204 if (CA->isString()) {
1206 PrintEscapedString(CA->getAsString(), Out);
1211 Type *ETy = CA->getType()->getElementType();
1213 TypePrinter.print(ETy, Out);
1215 WriteAsOperandInternal(Out, CA->getElementAsConstant(0),
1216 &TypePrinter, Machine,
1218 for (unsigned i = 1, e = CA->getNumElements(); i != e; ++i) {
1220 TypePrinter.print(ETy, Out);
1222 WriteAsOperandInternal(Out, CA->getElementAsConstant(i), &TypePrinter,
1230 if (const ConstantStruct *CS = dyn_cast<ConstantStruct>(CV)) {
1231 if (CS->getType()->isPacked())
1234 unsigned N = CS->getNumOperands();
1237 TypePrinter.print(CS->getOperand(0)->getType(), Out);
1240 WriteAsOperandInternal(Out, CS->getOperand(0), &TypePrinter, Machine,
1243 for (unsigned i = 1; i < N; i++) {
1245 TypePrinter.print(CS->getOperand(i)->getType(), Out);
1248 WriteAsOperandInternal(Out, CS->getOperand(i), &TypePrinter, Machine,
1255 if (CS->getType()->isPacked())
1260 if (isa<ConstantVector>(CV) || isa<ConstantDataVector>(CV)) {
1261 Type *ETy = CV->getType()->getVectorElementType();
1263 TypePrinter.print(ETy, Out);
1265 WriteAsOperandInternal(Out, CV->getAggregateElement(0U), &TypePrinter,
1267 for (unsigned i = 1, e = CV->getType()->getVectorNumElements(); i != e;++i){
1269 TypePrinter.print(ETy, Out);
1271 WriteAsOperandInternal(Out, CV->getAggregateElement(i), &TypePrinter,
1278 if (isa<ConstantPointerNull>(CV)) {
1283 if (isa<UndefValue>(CV)) {
1288 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV)) {
1289 Out << CE->getOpcodeName();
1290 WriteOptimizationInfo(Out, CE);
1291 if (CE->isCompare())
1292 Out << ' ' << getPredicateText(CE->getPredicate());
1295 if (const GEPOperator *GEP = dyn_cast<GEPOperator>(CE)) {
1297 cast<PointerType>(GEP->getPointerOperandType()->getScalarType())
1303 for (User::const_op_iterator OI=CE->op_begin(); OI != CE->op_end(); ++OI) {
1304 TypePrinter.print((*OI)->getType(), Out);
1306 WriteAsOperandInternal(Out, *OI, &TypePrinter, Machine, Context);
1307 if (OI+1 != CE->op_end())
1311 if (CE->hasIndices()) {
1312 ArrayRef<unsigned> Indices = CE->getIndices();
1313 for (unsigned i = 0, e = Indices.size(); i != e; ++i)
1314 Out << ", " << Indices[i];
1319 TypePrinter.print(CE->getType(), Out);
1326 Out << "<placeholder or erroneous Constant>";
1329 static void writeMDTuple(raw_ostream &Out, const MDTuple *Node,
1330 TypePrinting *TypePrinter, SlotTracker *Machine,
1331 const Module *Context) {
1333 for (unsigned mi = 0, me = Node->getNumOperands(); mi != me; ++mi) {
1334 const Metadata *MD = Node->getOperand(mi);
1337 else if (auto *MDV = dyn_cast<ValueAsMetadata>(MD)) {
1338 Value *V = MDV->getValue();
1339 TypePrinter->print(V->getType(), Out);
1341 WriteAsOperandInternal(Out, V, TypePrinter, Machine, Context);
1343 WriteAsOperandInternal(Out, MD, TypePrinter, Machine, Context);
1353 struct FieldSeparator {
1356 FieldSeparator(const char *Sep = ", ") : Skip(true), Sep(Sep) {}
1358 raw_ostream &operator<<(raw_ostream &OS, FieldSeparator &FS) {
1363 return OS << FS.Sep;
1365 struct MDFieldPrinter {
1368 TypePrinting *TypePrinter;
1369 SlotTracker *Machine;
1370 const Module *Context;
1372 explicit MDFieldPrinter(raw_ostream &Out)
1373 : Out(Out), TypePrinter(nullptr), Machine(nullptr), Context(nullptr) {}
1374 MDFieldPrinter(raw_ostream &Out, TypePrinting *TypePrinter,
1375 SlotTracker *Machine, const Module *Context)
1376 : Out(Out), TypePrinter(TypePrinter), Machine(Machine), Context(Context) {
1378 void printTag(const DebugNode *N);
1379 void printString(StringRef Name, StringRef Value,
1380 bool ShouldSkipEmpty = true);
1381 void printMetadata(StringRef Name, const Metadata *MD,
1382 bool ShouldSkipNull = true);
1383 template <class IntTy>
1384 void printInt(StringRef Name, IntTy Int, bool ShouldSkipZero = true);
1385 void printBool(StringRef Name, bool Value);
1386 void printDIFlags(StringRef Name, unsigned Flags);
1387 template <class IntTy, class Stringifier>
1388 void printDwarfEnum(StringRef Name, IntTy Value, Stringifier toString,
1389 bool ShouldSkipZero = true);
1393 void MDFieldPrinter::printTag(const DebugNode *N) {
1394 Out << FS << "tag: ";
1395 if (const char *Tag = dwarf::TagString(N->getTag()))
1401 void MDFieldPrinter::printString(StringRef Name, StringRef Value,
1402 bool ShouldSkipEmpty) {
1403 if (ShouldSkipEmpty && Value.empty())
1406 Out << FS << Name << ": \"";
1407 PrintEscapedString(Value, Out);
1411 static void writeMetadataAsOperand(raw_ostream &Out, const Metadata *MD,
1412 TypePrinting *TypePrinter,
1413 SlotTracker *Machine,
1414 const Module *Context) {
1419 WriteAsOperandInternal(Out, MD, TypePrinter, Machine, Context);
1422 void MDFieldPrinter::printMetadata(StringRef Name, const Metadata *MD,
1423 bool ShouldSkipNull) {
1424 if (ShouldSkipNull && !MD)
1427 Out << FS << Name << ": ";
1428 writeMetadataAsOperand(Out, MD, TypePrinter, Machine, Context);
1431 template <class IntTy>
1432 void MDFieldPrinter::printInt(StringRef Name, IntTy Int, bool ShouldSkipZero) {
1433 if (ShouldSkipZero && !Int)
1436 Out << FS << Name << ": " << Int;
1439 void MDFieldPrinter::printBool(StringRef Name, bool Value) {
1440 Out << FS << Name << ": " << (Value ? "true" : "false");
1443 void MDFieldPrinter::printDIFlags(StringRef Name, unsigned Flags) {
1447 Out << FS << Name << ": ";
1449 SmallVector<unsigned, 8> SplitFlags;
1450 unsigned Extra = DebugNode::splitFlags(Flags, SplitFlags);
1452 FieldSeparator FlagsFS(" | ");
1453 for (unsigned F : SplitFlags) {
1454 const char *StringF = DebugNode::getFlagString(F);
1455 assert(StringF && "Expected valid flag");
1456 Out << FlagsFS << StringF;
1458 if (Extra || SplitFlags.empty())
1459 Out << FlagsFS << Extra;
1462 template <class IntTy, class Stringifier>
1463 void MDFieldPrinter::printDwarfEnum(StringRef Name, IntTy Value,
1464 Stringifier toString, bool ShouldSkipZero) {
1468 Out << FS << Name << ": ";
1469 if (const char *S = toString(Value))
1475 static void writeGenericDebugNode(raw_ostream &Out, const GenericDebugNode *N,
1476 TypePrinting *TypePrinter,
1477 SlotTracker *Machine, const Module *Context) {
1478 Out << "!GenericDebugNode(";
1479 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1480 Printer.printTag(N);
1481 Printer.printString("header", N->getHeader());
1482 if (N->getNumDwarfOperands()) {
1483 Out << Printer.FS << "operands: {";
1485 for (auto &I : N->dwarf_operands()) {
1487 writeMetadataAsOperand(Out, I, TypePrinter, Machine, Context);
1494 static void writeMDLocation(raw_ostream &Out, const MDLocation *DL,
1495 TypePrinting *TypePrinter, SlotTracker *Machine,
1496 const Module *Context) {
1497 Out << "!MDLocation(";
1498 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1499 // Always output the line, since 0 is a relevant and important value for it.
1500 Printer.printInt("line", DL->getLine(), /* ShouldSkipZero */ false);
1501 Printer.printInt("column", DL->getColumn());
1502 Printer.printMetadata("scope", DL->getRawScope(), /* ShouldSkipNull */ false);
1503 Printer.printMetadata("inlinedAt", DL->getRawInlinedAt());
1507 static void writeMDSubrange(raw_ostream &Out, const MDSubrange *N,
1508 TypePrinting *, SlotTracker *, const Module *) {
1509 Out << "!MDSubrange(";
1510 MDFieldPrinter Printer(Out);
1511 Printer.printInt("count", N->getCount(), /* ShouldSkipZero */ false);
1512 Printer.printInt("lowerBound", N->getLowerBound());
1516 static void writeMDEnumerator(raw_ostream &Out, const MDEnumerator *N,
1517 TypePrinting *, SlotTracker *, const Module *) {
1518 Out << "!MDEnumerator(";
1519 MDFieldPrinter Printer(Out);
1520 Printer.printString("name", N->getName(), /* ShouldSkipEmpty */ false);
1521 Printer.printInt("value", N->getValue(), /* ShouldSkipZero */ false);
1525 static void writeMDBasicType(raw_ostream &Out, const MDBasicType *N,
1526 TypePrinting *, SlotTracker *, const Module *) {
1527 Out << "!MDBasicType(";
1528 MDFieldPrinter Printer(Out);
1529 if (N->getTag() != dwarf::DW_TAG_base_type)
1530 Printer.printTag(N);
1531 Printer.printString("name", N->getName());
1532 Printer.printInt("size", N->getSizeInBits());
1533 Printer.printInt("align", N->getAlignInBits());
1534 Printer.printDwarfEnum("encoding", N->getEncoding(),
1535 dwarf::AttributeEncodingString);
1539 static void writeMDDerivedType(raw_ostream &Out, const MDDerivedType *N,
1540 TypePrinting *TypePrinter, SlotTracker *Machine,
1541 const Module *Context) {
1542 Out << "!MDDerivedType(";
1543 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1544 Printer.printTag(N);
1545 Printer.printString("name", N->getName());
1546 Printer.printMetadata("scope", N->getRawScope());
1547 Printer.printMetadata("file", N->getRawFile());
1548 Printer.printInt("line", N->getLine());
1549 Printer.printMetadata("baseType", N->getRawBaseType(),
1550 /* ShouldSkipNull */ false);
1551 Printer.printInt("size", N->getSizeInBits());
1552 Printer.printInt("align", N->getAlignInBits());
1553 Printer.printInt("offset", N->getOffsetInBits());
1554 Printer.printDIFlags("flags", N->getFlags());
1555 Printer.printMetadata("extraData", N->getRawExtraData());
1559 static void writeMDCompositeType(raw_ostream &Out, const MDCompositeType *N,
1560 TypePrinting *TypePrinter,
1561 SlotTracker *Machine, const Module *Context) {
1562 Out << "!MDCompositeType(";
1563 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1564 Printer.printTag(N);
1565 Printer.printString("name", N->getName());
1566 Printer.printMetadata("scope", N->getRawScope());
1567 Printer.printMetadata("file", N->getRawFile());
1568 Printer.printInt("line", N->getLine());
1569 Printer.printMetadata("baseType", N->getRawBaseType());
1570 Printer.printInt("size", N->getSizeInBits());
1571 Printer.printInt("align", N->getAlignInBits());
1572 Printer.printInt("offset", N->getOffsetInBits());
1573 Printer.printDIFlags("flags", N->getFlags());
1574 Printer.printMetadata("elements", N->getRawElements());
1575 Printer.printDwarfEnum("runtimeLang", N->getRuntimeLang(),
1576 dwarf::LanguageString);
1577 Printer.printMetadata("vtableHolder", N->getRawVTableHolder());
1578 Printer.printMetadata("templateParams", N->getRawTemplateParams());
1579 Printer.printString("identifier", N->getIdentifier());
1583 static void writeMDSubroutineType(raw_ostream &Out, const MDSubroutineType *N,
1584 TypePrinting *TypePrinter,
1585 SlotTracker *Machine, const Module *Context) {
1586 Out << "!MDSubroutineType(";
1587 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1588 Printer.printDIFlags("flags", N->getFlags());
1589 Printer.printMetadata("types", N->getRawTypeArray(),
1590 /* ShouldSkipNull */ false);
1594 static void writeMDFile(raw_ostream &Out, const MDFile *N, TypePrinting *,
1595 SlotTracker *, const Module *) {
1597 MDFieldPrinter Printer(Out);
1598 Printer.printString("filename", N->getFilename(),
1599 /* ShouldSkipEmpty */ false);
1600 Printer.printString("directory", N->getDirectory(),
1601 /* ShouldSkipEmpty */ false);
1605 static void writeMDCompileUnit(raw_ostream &Out, const MDCompileUnit *N,
1606 TypePrinting *TypePrinter, SlotTracker *Machine,
1607 const Module *Context) {
1608 Out << "!MDCompileUnit(";
1609 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1610 Printer.printDwarfEnum("language", N->getSourceLanguage(),
1611 dwarf::LanguageString, /* ShouldSkipZero */ false);
1612 Printer.printMetadata("file", N->getRawFile(), /* ShouldSkipNull */ false);
1613 Printer.printString("producer", N->getProducer());
1614 Printer.printBool("isOptimized", N->isOptimized());
1615 Printer.printString("flags", N->getFlags());
1616 Printer.printInt("runtimeVersion", N->getRuntimeVersion(),
1617 /* ShouldSkipZero */ false);
1618 Printer.printString("splitDebugFilename", N->getSplitDebugFilename());
1619 Printer.printInt("emissionKind", N->getEmissionKind(),
1620 /* ShouldSkipZero */ false);
1621 Printer.printMetadata("enums", N->getRawEnumTypes());
1622 Printer.printMetadata("retainedTypes", N->getRawRetainedTypes());
1623 Printer.printMetadata("subprograms", N->getRawSubprograms());
1624 Printer.printMetadata("globals", N->getRawGlobalVariables());
1625 Printer.printMetadata("imports", N->getRawImportedEntities());
1629 static void writeMDSubprogram(raw_ostream &Out, const MDSubprogram *N,
1630 TypePrinting *TypePrinter, SlotTracker *Machine,
1631 const Module *Context) {
1632 Out << "!MDSubprogram(";
1633 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1634 Printer.printString("name", N->getName());
1635 Printer.printString("linkageName", N->getLinkageName());
1636 Printer.printMetadata("scope", N->getRawScope(), /* ShouldSkipNull */ false);
1637 Printer.printMetadata("file", N->getRawFile());
1638 Printer.printInt("line", N->getLine());
1639 Printer.printMetadata("type", N->getRawType());
1640 Printer.printBool("isLocal", N->isLocalToUnit());
1641 Printer.printBool("isDefinition", N->isDefinition());
1642 Printer.printInt("scopeLine", N->getScopeLine());
1643 Printer.printMetadata("containingType", N->getRawContainingType());
1644 Printer.printDwarfEnum("virtuality", N->getVirtuality(),
1645 dwarf::VirtualityString);
1646 Printer.printInt("virtualIndex", N->getVirtualIndex());
1647 Printer.printDIFlags("flags", N->getFlags());
1648 Printer.printBool("isOptimized", N->isOptimized());
1649 Printer.printMetadata("function", N->getRawFunction());
1650 Printer.printMetadata("templateParams", N->getRawTemplateParams());
1651 Printer.printMetadata("declaration", N->getRawDeclaration());
1652 Printer.printMetadata("variables", N->getRawVariables());
1656 static void writeMDLexicalBlock(raw_ostream &Out, const MDLexicalBlock *N,
1657 TypePrinting *TypePrinter, SlotTracker *Machine,
1658 const Module *Context) {
1659 Out << "!MDLexicalBlock(";
1660 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1661 Printer.printMetadata("scope", N->getRawScope(), /* ShouldSkipNull */ false);
1662 Printer.printMetadata("file", N->getRawFile());
1663 Printer.printInt("line", N->getLine());
1664 Printer.printInt("column", N->getColumn());
1668 static void writeMDLexicalBlockFile(raw_ostream &Out,
1669 const MDLexicalBlockFile *N,
1670 TypePrinting *TypePrinter,
1671 SlotTracker *Machine,
1672 const Module *Context) {
1673 Out << "!MDLexicalBlockFile(";
1674 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1675 Printer.printMetadata("scope", N->getRawScope(), /* ShouldSkipNull */ false);
1676 Printer.printMetadata("file", N->getRawFile());
1677 Printer.printInt("discriminator", N->getDiscriminator(),
1678 /* ShouldSkipZero */ false);
1682 static void writeMDNamespace(raw_ostream &Out, const MDNamespace *N,
1683 TypePrinting *TypePrinter, SlotTracker *Machine,
1684 const Module *Context) {
1685 Out << "!MDNamespace(";
1686 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1687 Printer.printString("name", N->getName());
1688 Printer.printMetadata("scope", N->getRawScope(), /* ShouldSkipNull */ false);
1689 Printer.printMetadata("file", N->getRawFile());
1690 Printer.printInt("line", N->getLine());
1694 static void writeMDTemplateTypeParameter(raw_ostream &Out,
1695 const MDTemplateTypeParameter *N,
1696 TypePrinting *TypePrinter,
1697 SlotTracker *Machine,
1698 const Module *Context) {
1699 Out << "!MDTemplateTypeParameter(";
1700 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1701 Printer.printString("name", N->getName());
1702 Printer.printMetadata("type", N->getRawType(), /* ShouldSkipNull */ false);
1706 static void writeMDTemplateValueParameter(raw_ostream &Out,
1707 const MDTemplateValueParameter *N,
1708 TypePrinting *TypePrinter,
1709 SlotTracker *Machine,
1710 const Module *Context) {
1711 Out << "!MDTemplateValueParameter(";
1712 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1713 if (N->getTag() != dwarf::DW_TAG_template_value_parameter)
1714 Printer.printTag(N);
1715 Printer.printString("name", N->getName());
1716 Printer.printMetadata("type", N->getRawType());
1717 Printer.printMetadata("value", N->getValue(), /* ShouldSkipNull */ false);
1721 static void writeMDGlobalVariable(raw_ostream &Out, const MDGlobalVariable *N,
1722 TypePrinting *TypePrinter,
1723 SlotTracker *Machine, const Module *Context) {
1724 Out << "!MDGlobalVariable(";
1725 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1726 Printer.printString("name", N->getName());
1727 Printer.printString("linkageName", N->getLinkageName());
1728 Printer.printMetadata("scope", N->getRawScope(), /* ShouldSkipNull */ false);
1729 Printer.printMetadata("file", N->getRawFile());
1730 Printer.printInt("line", N->getLine());
1731 Printer.printMetadata("type", N->getRawType());
1732 Printer.printBool("isLocal", N->isLocalToUnit());
1733 Printer.printBool("isDefinition", N->isDefinition());
1734 Printer.printMetadata("variable", N->getRawVariable());
1735 Printer.printMetadata("declaration", N->getRawStaticDataMemberDeclaration());
1739 static void writeMDLocalVariable(raw_ostream &Out, const MDLocalVariable *N,
1740 TypePrinting *TypePrinter,
1741 SlotTracker *Machine, const Module *Context) {
1742 Out << "!MDLocalVariable(";
1743 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1744 Printer.printTag(N);
1745 Printer.printString("name", N->getName());
1746 Printer.printInt("arg", N->getArg(),
1747 /* ShouldSkipZero */
1748 N->getTag() == dwarf::DW_TAG_auto_variable);
1749 Printer.printMetadata("scope", N->getRawScope(), /* ShouldSkipNull */ false);
1750 Printer.printMetadata("file", N->getRawFile());
1751 Printer.printInt("line", N->getLine());
1752 Printer.printMetadata("type", N->getRawType());
1753 Printer.printDIFlags("flags", N->getFlags());
1757 static void writeMDExpression(raw_ostream &Out, const MDExpression *N,
1758 TypePrinting *TypePrinter, SlotTracker *Machine,
1759 const Module *Context) {
1760 Out << "!MDExpression(";
1763 for (auto I = N->expr_op_begin(), E = N->expr_op_end(); I != E; ++I) {
1764 const char *OpStr = dwarf::OperationEncodingString(I->getOp());
1765 assert(OpStr && "Expected valid opcode");
1768 for (unsigned A = 0, AE = I->getNumArgs(); A != AE; ++A)
1769 Out << FS << I->getArg(A);
1772 for (const auto &I : N->getElements())
1778 static void writeMDObjCProperty(raw_ostream &Out, const MDObjCProperty *N,
1779 TypePrinting *TypePrinter, SlotTracker *Machine,
1780 const Module *Context) {
1781 Out << "!MDObjCProperty(";
1782 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1783 Printer.printString("name", N->getName());
1784 Printer.printMetadata("file", N->getRawFile());
1785 Printer.printInt("line", N->getLine());
1786 Printer.printString("setter", N->getSetterName());
1787 Printer.printString("getter", N->getGetterName());
1788 Printer.printInt("attributes", N->getAttributes());
1789 Printer.printMetadata("type", N->getRawType());
1793 static void writeMDImportedEntity(raw_ostream &Out, const MDImportedEntity *N,
1794 TypePrinting *TypePrinter,
1795 SlotTracker *Machine, const Module *Context) {
1796 Out << "!MDImportedEntity(";
1797 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1798 Printer.printTag(N);
1799 Printer.printString("name", N->getName());
1800 Printer.printMetadata("scope", N->getRawScope(), /* ShouldSkipNull */ false);
1801 Printer.printMetadata("entity", N->getRawEntity());
1802 Printer.printInt("line", N->getLine());
1807 static void WriteMDNodeBodyInternal(raw_ostream &Out, const MDNode *Node,
1808 TypePrinting *TypePrinter,
1809 SlotTracker *Machine,
1810 const Module *Context) {
1811 if (Node->isDistinct())
1813 else if (Node->isTemporary())
1814 Out << "<temporary!> "; // Handle broken code.
1816 switch (Node->getMetadataID()) {
1818 llvm_unreachable("Expected uniquable MDNode");
1819 #define HANDLE_MDNODE_LEAF(CLASS) \
1820 case Metadata::CLASS##Kind: \
1821 write##CLASS(Out, cast<CLASS>(Node), TypePrinter, Machine, Context); \
1823 #include "llvm/IR/Metadata.def"
1827 // Full implementation of printing a Value as an operand with support for
1828 // TypePrinting, etc.
1829 static void WriteAsOperandInternal(raw_ostream &Out, const Value *V,
1830 TypePrinting *TypePrinter,
1831 SlotTracker *Machine,
1832 const Module *Context) {
1834 PrintLLVMName(Out, V);
1838 const Constant *CV = dyn_cast<Constant>(V);
1839 if (CV && !isa<GlobalValue>(CV)) {
1840 assert(TypePrinter && "Constants require TypePrinting!");
1841 WriteConstantInternal(Out, CV, *TypePrinter, Machine, Context);
1845 if (const InlineAsm *IA = dyn_cast<InlineAsm>(V)) {
1847 if (IA->hasSideEffects())
1848 Out << "sideeffect ";
1849 if (IA->isAlignStack())
1850 Out << "alignstack ";
1851 // We don't emit the AD_ATT dialect as it's the assumed default.
1852 if (IA->getDialect() == InlineAsm::AD_Intel)
1853 Out << "inteldialect ";
1855 PrintEscapedString(IA->getAsmString(), Out);
1857 PrintEscapedString(IA->getConstraintString(), Out);
1862 if (auto *MD = dyn_cast<MetadataAsValue>(V)) {
1863 WriteAsOperandInternal(Out, MD->getMetadata(), TypePrinter, Machine,
1864 Context, /* FromValue */ true);
1870 // If we have a SlotTracker, use it.
1872 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
1873 Slot = Machine->getGlobalSlot(GV);
1876 Slot = Machine->getLocalSlot(V);
1878 // If the local value didn't succeed, then we may be referring to a value
1879 // from a different function. Translate it, as this can happen when using
1880 // address of blocks.
1882 if ((Machine = createSlotTracker(V))) {
1883 Slot = Machine->getLocalSlot(V);
1887 } else if ((Machine = createSlotTracker(V))) {
1888 // Otherwise, create one to get the # and then destroy it.
1889 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
1890 Slot = Machine->getGlobalSlot(GV);
1893 Slot = Machine->getLocalSlot(V);
1902 Out << Prefix << Slot;
1907 static void WriteAsOperandInternal(raw_ostream &Out, const Metadata *MD,
1908 TypePrinting *TypePrinter,
1909 SlotTracker *Machine, const Module *Context,
1911 if (const MDNode *N = dyn_cast<MDNode>(MD)) {
1913 Machine = new SlotTracker(Context);
1914 int Slot = Machine->getMetadataSlot(N);
1916 // Give the pointer value instead of "badref", since this comes up all
1917 // the time when debugging.
1918 Out << "<" << N << ">";
1924 if (const MDString *MDS = dyn_cast<MDString>(MD)) {
1926 PrintEscapedString(MDS->getString(), Out);
1931 auto *V = cast<ValueAsMetadata>(MD);
1932 assert(TypePrinter && "TypePrinter required for metadata values");
1933 assert((FromValue || !isa<LocalAsMetadata>(V)) &&
1934 "Unexpected function-local metadata outside of value argument");
1936 TypePrinter->print(V->getValue()->getType(), Out);
1938 WriteAsOperandInternal(Out, V->getValue(), TypePrinter, Machine, Context);
1942 class AssemblyWriter {
1943 formatted_raw_ostream &Out;
1944 const Module *TheModule;
1945 std::unique_ptr<SlotTracker> ModuleSlotTracker;
1946 SlotTracker &Machine;
1947 TypePrinting TypePrinter;
1948 AssemblyAnnotationWriter *AnnotationWriter;
1949 SetVector<const Comdat *> Comdats;
1950 bool ShouldPreserveUseListOrder;
1951 UseListOrderStack UseListOrders;
1952 SmallVector<StringRef, 8> MDNames;
1955 /// Construct an AssemblyWriter with an external SlotTracker
1956 AssemblyWriter(formatted_raw_ostream &o, SlotTracker &Mac, const Module *M,
1957 AssemblyAnnotationWriter *AAW,
1958 bool ShouldPreserveUseListOrder = false);
1960 /// Construct an AssemblyWriter with an internally allocated SlotTracker
1961 AssemblyWriter(formatted_raw_ostream &o, const Module *M,
1962 AssemblyAnnotationWriter *AAW,
1963 bool ShouldPreserveUseListOrder = false);
1965 void printMDNodeBody(const MDNode *MD);
1966 void printNamedMDNode(const NamedMDNode *NMD);
1968 void printModule(const Module *M);
1970 void writeOperand(const Value *Op, bool PrintType);
1971 void writeParamOperand(const Value *Operand, AttributeSet Attrs,unsigned Idx);
1972 void writeAtomic(AtomicOrdering Ordering, SynchronizationScope SynchScope);
1973 void writeAtomicCmpXchg(AtomicOrdering SuccessOrdering,
1974 AtomicOrdering FailureOrdering,
1975 SynchronizationScope SynchScope);
1977 void writeAllMDNodes();
1978 void writeMDNode(unsigned Slot, const MDNode *Node);
1979 void writeAllAttributeGroups();
1981 void printTypeIdentities();
1982 void printGlobal(const GlobalVariable *GV);
1983 void printAlias(const GlobalAlias *GV);
1984 void printComdat(const Comdat *C);
1985 void printFunction(const Function *F);
1986 void printArgument(const Argument *FA, AttributeSet Attrs, unsigned Idx);
1987 void printBasicBlock(const BasicBlock *BB);
1988 void printInstructionLine(const Instruction &I);
1989 void printInstruction(const Instruction &I);
1991 void printUseListOrder(const UseListOrder &Order);
1992 void printUseLists(const Function *F);
1997 /// \brief Print out metadata attachments.
1998 void printMetadataAttachments(
1999 const SmallVectorImpl<std::pair<unsigned, MDNode *>> &MDs,
2000 StringRef Separator);
2002 // printInfoComment - Print a little comment after the instruction indicating
2003 // which slot it occupies.
2004 void printInfoComment(const Value &V);
2008 void AssemblyWriter::init() {
2011 TypePrinter.incorporateTypes(*TheModule);
2012 for (const Function &F : *TheModule)
2013 if (const Comdat *C = F.getComdat())
2015 for (const GlobalVariable &GV : TheModule->globals())
2016 if (const Comdat *C = GV.getComdat())
2020 AssemblyWriter::AssemblyWriter(formatted_raw_ostream &o, SlotTracker &Mac,
2021 const Module *M, AssemblyAnnotationWriter *AAW,
2022 bool ShouldPreserveUseListOrder)
2023 : Out(o), TheModule(M), Machine(Mac), AnnotationWriter(AAW),
2024 ShouldPreserveUseListOrder(ShouldPreserveUseListOrder) {
2028 AssemblyWriter::AssemblyWriter(formatted_raw_ostream &o, const Module *M,
2029 AssemblyAnnotationWriter *AAW,
2030 bool ShouldPreserveUseListOrder)
2031 : Out(o), TheModule(M), ModuleSlotTracker(createSlotTracker(M)),
2032 Machine(*ModuleSlotTracker), AnnotationWriter(AAW),
2033 ShouldPreserveUseListOrder(ShouldPreserveUseListOrder) {
2037 void AssemblyWriter::writeOperand(const Value *Operand, bool PrintType) {
2039 Out << "<null operand!>";
2043 TypePrinter.print(Operand->getType(), Out);
2046 WriteAsOperandInternal(Out, Operand, &TypePrinter, &Machine, TheModule);
2049 void AssemblyWriter::writeAtomic(AtomicOrdering Ordering,
2050 SynchronizationScope SynchScope) {
2051 if (Ordering == NotAtomic)
2054 switch (SynchScope) {
2055 case SingleThread: Out << " singlethread"; break;
2056 case CrossThread: break;
2060 default: Out << " <bad ordering " << int(Ordering) << ">"; break;
2061 case Unordered: Out << " unordered"; break;
2062 case Monotonic: Out << " monotonic"; break;
2063 case Acquire: Out << " acquire"; break;
2064 case Release: Out << " release"; break;
2065 case AcquireRelease: Out << " acq_rel"; break;
2066 case SequentiallyConsistent: Out << " seq_cst"; break;
2070 void AssemblyWriter::writeAtomicCmpXchg(AtomicOrdering SuccessOrdering,
2071 AtomicOrdering FailureOrdering,
2072 SynchronizationScope SynchScope) {
2073 assert(SuccessOrdering != NotAtomic && FailureOrdering != NotAtomic);
2075 switch (SynchScope) {
2076 case SingleThread: Out << " singlethread"; break;
2077 case CrossThread: break;
2080 switch (SuccessOrdering) {
2081 default: Out << " <bad ordering " << int(SuccessOrdering) << ">"; break;
2082 case Unordered: Out << " unordered"; break;
2083 case Monotonic: Out << " monotonic"; break;
2084 case Acquire: Out << " acquire"; break;
2085 case Release: Out << " release"; break;
2086 case AcquireRelease: Out << " acq_rel"; break;
2087 case SequentiallyConsistent: Out << " seq_cst"; break;
2090 switch (FailureOrdering) {
2091 default: Out << " <bad ordering " << int(FailureOrdering) << ">"; break;
2092 case Unordered: Out << " unordered"; break;
2093 case Monotonic: Out << " monotonic"; break;
2094 case Acquire: Out << " acquire"; break;
2095 case Release: Out << " release"; break;
2096 case AcquireRelease: Out << " acq_rel"; break;
2097 case SequentiallyConsistent: Out << " seq_cst"; break;
2101 void AssemblyWriter::writeParamOperand(const Value *Operand,
2102 AttributeSet Attrs, unsigned Idx) {
2104 Out << "<null operand!>";
2109 TypePrinter.print(Operand->getType(), Out);
2110 // Print parameter attributes list
2111 if (Attrs.hasAttributes(Idx))
2112 Out << ' ' << Attrs.getAsString(Idx);
2114 // Print the operand
2115 WriteAsOperandInternal(Out, Operand, &TypePrinter, &Machine, TheModule);
2118 void AssemblyWriter::printModule(const Module *M) {
2119 Machine.initialize();
2121 if (ShouldPreserveUseListOrder)
2122 UseListOrders = predictUseListOrder(M);
2124 if (!M->getModuleIdentifier().empty() &&
2125 // Don't print the ID if it will start a new line (which would
2126 // require a comment char before it).
2127 M->getModuleIdentifier().find('\n') == std::string::npos)
2128 Out << "; ModuleID = '" << M->getModuleIdentifier() << "'\n";
2130 const std::string &DL = M->getDataLayoutStr();
2132 Out << "target datalayout = \"" << DL << "\"\n";
2133 if (!M->getTargetTriple().empty())
2134 Out << "target triple = \"" << M->getTargetTriple() << "\"\n";
2136 if (!M->getModuleInlineAsm().empty()) {
2137 // Split the string into lines, to make it easier to read the .ll file.
2138 std::string Asm = M->getModuleInlineAsm();
2140 size_t NewLine = Asm.find_first_of('\n', CurPos);
2142 while (NewLine != std::string::npos) {
2143 // We found a newline, print the portion of the asm string from the
2144 // last newline up to this newline.
2145 Out << "module asm \"";
2146 PrintEscapedString(std::string(Asm.begin()+CurPos, Asm.begin()+NewLine),
2150 NewLine = Asm.find_first_of('\n', CurPos);
2152 std::string rest(Asm.begin()+CurPos, Asm.end());
2153 if (!rest.empty()) {
2154 Out << "module asm \"";
2155 PrintEscapedString(rest, Out);
2160 printTypeIdentities();
2162 // Output all comdats.
2163 if (!Comdats.empty())
2165 for (const Comdat *C : Comdats) {
2167 if (C != Comdats.back())
2171 // Output all globals.
2172 if (!M->global_empty()) Out << '\n';
2173 for (Module::const_global_iterator I = M->global_begin(), E = M->global_end();
2175 printGlobal(I); Out << '\n';
2178 // Output all aliases.
2179 if (!M->alias_empty()) Out << "\n";
2180 for (Module::const_alias_iterator I = M->alias_begin(), E = M->alias_end();
2184 // Output global use-lists.
2185 printUseLists(nullptr);
2187 // Output all of the functions.
2188 for (Module::const_iterator I = M->begin(), E = M->end(); I != E; ++I)
2190 assert(UseListOrders.empty() && "All use-lists should have been consumed");
2192 // Output all attribute groups.
2193 if (!Machine.as_empty()) {
2195 writeAllAttributeGroups();
2198 // Output named metadata.
2199 if (!M->named_metadata_empty()) Out << '\n';
2201 for (Module::const_named_metadata_iterator I = M->named_metadata_begin(),
2202 E = M->named_metadata_end(); I != E; ++I)
2203 printNamedMDNode(I);
2206 if (!Machine.mdn_empty()) {
2212 void AssemblyWriter::printNamedMDNode(const NamedMDNode *NMD) {
2214 StringRef Name = NMD->getName();
2216 Out << "<empty name> ";
2218 if (isalpha(static_cast<unsigned char>(Name[0])) ||
2219 Name[0] == '-' || Name[0] == '$' ||
2220 Name[0] == '.' || Name[0] == '_')
2223 Out << '\\' << hexdigit(Name[0] >> 4) << hexdigit(Name[0] & 0x0F);
2224 for (unsigned i = 1, e = Name.size(); i != e; ++i) {
2225 unsigned char C = Name[i];
2226 if (isalnum(static_cast<unsigned char>(C)) || C == '-' || C == '$' ||
2227 C == '.' || C == '_')
2230 Out << '\\' << hexdigit(C >> 4) << hexdigit(C & 0x0F);
2234 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
2236 int Slot = Machine.getMetadataSlot(NMD->getOperand(i));
2246 static void PrintLinkage(GlobalValue::LinkageTypes LT,
2247 formatted_raw_ostream &Out) {
2249 case GlobalValue::ExternalLinkage: break;
2250 case GlobalValue::PrivateLinkage: Out << "private "; break;
2251 case GlobalValue::InternalLinkage: Out << "internal "; break;
2252 case GlobalValue::LinkOnceAnyLinkage: Out << "linkonce "; break;
2253 case GlobalValue::LinkOnceODRLinkage: Out << "linkonce_odr "; break;
2254 case GlobalValue::WeakAnyLinkage: Out << "weak "; break;
2255 case GlobalValue::WeakODRLinkage: Out << "weak_odr "; break;
2256 case GlobalValue::CommonLinkage: Out << "common "; break;
2257 case GlobalValue::AppendingLinkage: Out << "appending "; break;
2258 case GlobalValue::ExternalWeakLinkage: Out << "extern_weak "; break;
2259 case GlobalValue::AvailableExternallyLinkage:
2260 Out << "available_externally ";
2266 static void PrintVisibility(GlobalValue::VisibilityTypes Vis,
2267 formatted_raw_ostream &Out) {
2269 case GlobalValue::DefaultVisibility: break;
2270 case GlobalValue::HiddenVisibility: Out << "hidden "; break;
2271 case GlobalValue::ProtectedVisibility: Out << "protected "; break;
2275 static void PrintDLLStorageClass(GlobalValue::DLLStorageClassTypes SCT,
2276 formatted_raw_ostream &Out) {
2278 case GlobalValue::DefaultStorageClass: break;
2279 case GlobalValue::DLLImportStorageClass: Out << "dllimport "; break;
2280 case GlobalValue::DLLExportStorageClass: Out << "dllexport "; break;
2284 static void PrintThreadLocalModel(GlobalVariable::ThreadLocalMode TLM,
2285 formatted_raw_ostream &Out) {
2287 case GlobalVariable::NotThreadLocal:
2289 case GlobalVariable::GeneralDynamicTLSModel:
2290 Out << "thread_local ";
2292 case GlobalVariable::LocalDynamicTLSModel:
2293 Out << "thread_local(localdynamic) ";
2295 case GlobalVariable::InitialExecTLSModel:
2296 Out << "thread_local(initialexec) ";
2298 case GlobalVariable::LocalExecTLSModel:
2299 Out << "thread_local(localexec) ";
2304 static void maybePrintComdat(formatted_raw_ostream &Out,
2305 const GlobalObject &GO) {
2306 const Comdat *C = GO.getComdat();
2310 if (isa<GlobalVariable>(GO))
2314 if (GO.getName() == C->getName())
2318 PrintLLVMName(Out, C->getName(), ComdatPrefix);
2322 void AssemblyWriter::printGlobal(const GlobalVariable *GV) {
2323 if (GV->isMaterializable())
2324 Out << "; Materializable\n";
2326 WriteAsOperandInternal(Out, GV, &TypePrinter, &Machine, GV->getParent());
2329 if (!GV->hasInitializer() && GV->hasExternalLinkage())
2332 PrintLinkage(GV->getLinkage(), Out);
2333 PrintVisibility(GV->getVisibility(), Out);
2334 PrintDLLStorageClass(GV->getDLLStorageClass(), Out);
2335 PrintThreadLocalModel(GV->getThreadLocalMode(), Out);
2336 if (GV->hasUnnamedAddr())
2337 Out << "unnamed_addr ";
2339 if (unsigned AddressSpace = GV->getType()->getAddressSpace())
2340 Out << "addrspace(" << AddressSpace << ") ";
2341 if (GV->isExternallyInitialized()) Out << "externally_initialized ";
2342 Out << (GV->isConstant() ? "constant " : "global ");
2343 TypePrinter.print(GV->getType()->getElementType(), Out);
2345 if (GV->hasInitializer()) {
2347 writeOperand(GV->getInitializer(), false);
2350 if (GV->hasSection()) {
2351 Out << ", section \"";
2352 PrintEscapedString(GV->getSection(), Out);
2355 maybePrintComdat(Out, *GV);
2356 if (GV->getAlignment())
2357 Out << ", align " << GV->getAlignment();
2359 printInfoComment(*GV);
2362 void AssemblyWriter::printAlias(const GlobalAlias *GA) {
2363 if (GA->isMaterializable())
2364 Out << "; Materializable\n";
2366 // Don't crash when dumping partially built GA
2368 Out << "<<nameless>> = ";
2370 PrintLLVMName(Out, GA);
2373 PrintLinkage(GA->getLinkage(), Out);
2374 PrintVisibility(GA->getVisibility(), Out);
2375 PrintDLLStorageClass(GA->getDLLStorageClass(), Out);
2376 PrintThreadLocalModel(GA->getThreadLocalMode(), Out);
2377 if (GA->hasUnnamedAddr())
2378 Out << "unnamed_addr ";
2382 const Constant *Aliasee = GA->getAliasee();
2385 TypePrinter.print(GA->getType(), Out);
2386 Out << " <<NULL ALIASEE>>";
2388 writeOperand(Aliasee, !isa<ConstantExpr>(Aliasee));
2391 printInfoComment(*GA);
2395 void AssemblyWriter::printComdat(const Comdat *C) {
2399 void AssemblyWriter::printTypeIdentities() {
2400 if (TypePrinter.NumberedTypes.empty() &&
2401 TypePrinter.NamedTypes.empty())
2406 // We know all the numbers that each type is used and we know that it is a
2407 // dense assignment. Convert the map to an index table.
2408 std::vector<StructType*> NumberedTypes(TypePrinter.NumberedTypes.size());
2409 for (DenseMap<StructType*, unsigned>::iterator I =
2410 TypePrinter.NumberedTypes.begin(), E = TypePrinter.NumberedTypes.end();
2412 assert(I->second < NumberedTypes.size() && "Didn't get a dense numbering?");
2413 NumberedTypes[I->second] = I->first;
2416 // Emit all numbered types.
2417 for (unsigned i = 0, e = NumberedTypes.size(); i != e; ++i) {
2418 Out << '%' << i << " = type ";
2420 // Make sure we print out at least one level of the type structure, so
2421 // that we do not get %2 = type %2
2422 TypePrinter.printStructBody(NumberedTypes[i], Out);
2426 for (unsigned i = 0, e = TypePrinter.NamedTypes.size(); i != e; ++i) {
2427 PrintLLVMName(Out, TypePrinter.NamedTypes[i]->getName(), LocalPrefix);
2430 // Make sure we print out at least one level of the type structure, so
2431 // that we do not get %FILE = type %FILE
2432 TypePrinter.printStructBody(TypePrinter.NamedTypes[i], Out);
2437 /// printFunction - Print all aspects of a function.
2439 void AssemblyWriter::printFunction(const Function *F) {
2440 // Print out the return type and name.
2443 if (AnnotationWriter) AnnotationWriter->emitFunctionAnnot(F, Out);
2445 if (F->isMaterializable())
2446 Out << "; Materializable\n";
2448 const AttributeSet &Attrs = F->getAttributes();
2449 if (Attrs.hasAttributes(AttributeSet::FunctionIndex)) {
2450 AttributeSet AS = Attrs.getFnAttributes();
2451 std::string AttrStr;
2454 for (unsigned E = AS.getNumSlots(); Idx != E; ++Idx)
2455 if (AS.getSlotIndex(Idx) == AttributeSet::FunctionIndex)
2458 for (AttributeSet::iterator I = AS.begin(Idx), E = AS.end(Idx);
2460 Attribute Attr = *I;
2461 if (!Attr.isStringAttribute()) {
2462 if (!AttrStr.empty()) AttrStr += ' ';
2463 AttrStr += Attr.getAsString();
2467 if (!AttrStr.empty())
2468 Out << "; Function Attrs: " << AttrStr << '\n';
2471 if (F->isDeclaration())
2476 PrintLinkage(F->getLinkage(), Out);
2477 PrintVisibility(F->getVisibility(), Out);
2478 PrintDLLStorageClass(F->getDLLStorageClass(), Out);
2480 // Print the calling convention.
2481 if (F->getCallingConv() != CallingConv::C) {
2482 PrintCallingConv(F->getCallingConv(), Out);
2486 FunctionType *FT = F->getFunctionType();
2487 if (Attrs.hasAttributes(AttributeSet::ReturnIndex))
2488 Out << Attrs.getAsString(AttributeSet::ReturnIndex) << ' ';
2489 TypePrinter.print(F->getReturnType(), Out);
2491 WriteAsOperandInternal(Out, F, &TypePrinter, &Machine, F->getParent());
2493 Machine.incorporateFunction(F);
2495 // Loop over the arguments, printing them...
2498 if (!F->isDeclaration()) {
2499 // If this isn't a declaration, print the argument names as well.
2500 for (Function::const_arg_iterator I = F->arg_begin(), E = F->arg_end();
2502 // Insert commas as we go... the first arg doesn't get a comma
2503 if (I != F->arg_begin()) Out << ", ";
2504 printArgument(I, Attrs, Idx);
2508 // Otherwise, print the types from the function type.
2509 for (unsigned i = 0, e = FT->getNumParams(); i != e; ++i) {
2510 // Insert commas as we go... the first arg doesn't get a comma
2514 TypePrinter.print(FT->getParamType(i), Out);
2516 if (Attrs.hasAttributes(i+1))
2517 Out << ' ' << Attrs.getAsString(i+1);
2521 // Finish printing arguments...
2522 if (FT->isVarArg()) {
2523 if (FT->getNumParams()) Out << ", ";
2524 Out << "..."; // Output varargs portion of signature!
2527 if (F->hasUnnamedAddr())
2528 Out << " unnamed_addr";
2529 if (Attrs.hasAttributes(AttributeSet::FunctionIndex))
2530 Out << " #" << Machine.getAttributeGroupSlot(Attrs.getFnAttributes());
2531 if (F->hasSection()) {
2532 Out << " section \"";
2533 PrintEscapedString(F->getSection(), Out);
2536 maybePrintComdat(Out, *F);
2537 if (F->getAlignment())
2538 Out << " align " << F->getAlignment();
2540 Out << " gc \"" << F->getGC() << '"';
2541 if (F->hasPrefixData()) {
2543 writeOperand(F->getPrefixData(), true);
2545 if (F->hasPrologueData()) {
2546 Out << " prologue ";
2547 writeOperand(F->getPrologueData(), true);
2550 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
2551 F->getAllMetadata(MDs);
2552 printMetadataAttachments(MDs, " ");
2554 if (F->isDeclaration()) {
2558 // Output all of the function's basic blocks.
2559 for (Function::const_iterator I = F->begin(), E = F->end(); I != E; ++I)
2562 // Output the function's use-lists.
2568 Machine.purgeFunction();
2571 /// printArgument - This member is called for every argument that is passed into
2572 /// the function. Simply print it out
2574 void AssemblyWriter::printArgument(const Argument *Arg,
2575 AttributeSet Attrs, unsigned Idx) {
2577 TypePrinter.print(Arg->getType(), Out);
2579 // Output parameter attributes list
2580 if (Attrs.hasAttributes(Idx))
2581 Out << ' ' << Attrs.getAsString(Idx);
2583 // Output name, if available...
2584 if (Arg->hasName()) {
2586 PrintLLVMName(Out, Arg);
2590 /// printBasicBlock - This member is called for each basic block in a method.
2592 void AssemblyWriter::printBasicBlock(const BasicBlock *BB) {
2593 if (BB->hasName()) { // Print out the label if it exists...
2595 PrintLLVMName(Out, BB->getName(), LabelPrefix);
2597 } else if (!BB->use_empty()) { // Don't print block # of no uses...
2598 Out << "\n; <label>:";
2599 int Slot = Machine.getLocalSlot(BB);
2606 if (!BB->getParent()) {
2607 Out.PadToColumn(50);
2608 Out << "; Error: Block without parent!";
2609 } else if (BB != &BB->getParent()->getEntryBlock()) { // Not the entry block?
2610 // Output predecessors for the block.
2611 Out.PadToColumn(50);
2613 const_pred_iterator PI = pred_begin(BB), PE = pred_end(BB);
2616 Out << " No predecessors!";
2619 writeOperand(*PI, false);
2620 for (++PI; PI != PE; ++PI) {
2622 writeOperand(*PI, false);
2629 if (AnnotationWriter) AnnotationWriter->emitBasicBlockStartAnnot(BB, Out);
2631 // Output all of the instructions in the basic block...
2632 for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I != E; ++I) {
2633 printInstructionLine(*I);
2636 if (AnnotationWriter) AnnotationWriter->emitBasicBlockEndAnnot(BB, Out);
2639 /// printInstructionLine - Print an instruction and a newline character.
2640 void AssemblyWriter::printInstructionLine(const Instruction &I) {
2641 printInstruction(I);
2645 /// printInfoComment - Print a little comment after the instruction indicating
2646 /// which slot it occupies.
2648 void AssemblyWriter::printInfoComment(const Value &V) {
2649 if (AnnotationWriter)
2650 AnnotationWriter->printInfoComment(V, Out);
2653 // This member is called for each Instruction in a function..
2654 void AssemblyWriter::printInstruction(const Instruction &I) {
2655 if (AnnotationWriter) AnnotationWriter->emitInstructionAnnot(&I, Out);
2657 // Print out indentation for an instruction.
2660 // Print out name if it exists...
2662 PrintLLVMName(Out, &I);
2664 } else if (!I.getType()->isVoidTy()) {
2665 // Print out the def slot taken.
2666 int SlotNum = Machine.getLocalSlot(&I);
2668 Out << "<badref> = ";
2670 Out << '%' << SlotNum << " = ";
2673 if (const CallInst *CI = dyn_cast<CallInst>(&I)) {
2674 if (CI->isMustTailCall())
2676 else if (CI->isTailCall())
2680 // Print out the opcode...
2681 Out << I.getOpcodeName();
2683 // If this is an atomic load or store, print out the atomic marker.
2684 if ((isa<LoadInst>(I) && cast<LoadInst>(I).isAtomic()) ||
2685 (isa<StoreInst>(I) && cast<StoreInst>(I).isAtomic()))
2688 if (isa<AtomicCmpXchgInst>(I) && cast<AtomicCmpXchgInst>(I).isWeak())
2691 // If this is a volatile operation, print out the volatile marker.
2692 if ((isa<LoadInst>(I) && cast<LoadInst>(I).isVolatile()) ||
2693 (isa<StoreInst>(I) && cast<StoreInst>(I).isVolatile()) ||
2694 (isa<AtomicCmpXchgInst>(I) && cast<AtomicCmpXchgInst>(I).isVolatile()) ||
2695 (isa<AtomicRMWInst>(I) && cast<AtomicRMWInst>(I).isVolatile()))
2698 // Print out optimization information.
2699 WriteOptimizationInfo(Out, &I);
2701 // Print out the compare instruction predicates
2702 if (const CmpInst *CI = dyn_cast<CmpInst>(&I))
2703 Out << ' ' << getPredicateText(CI->getPredicate());
2705 // Print out the atomicrmw operation
2706 if (const AtomicRMWInst *RMWI = dyn_cast<AtomicRMWInst>(&I))
2707 writeAtomicRMWOperation(Out, RMWI->getOperation());
2709 // Print out the type of the operands...
2710 const Value *Operand = I.getNumOperands() ? I.getOperand(0) : nullptr;
2712 // Special case conditional branches to swizzle the condition out to the front
2713 if (isa<BranchInst>(I) && cast<BranchInst>(I).isConditional()) {
2714 const BranchInst &BI(cast<BranchInst>(I));
2716 writeOperand(BI.getCondition(), true);
2718 writeOperand(BI.getSuccessor(0), true);
2720 writeOperand(BI.getSuccessor(1), true);
2722 } else if (isa<SwitchInst>(I)) {
2723 const SwitchInst& SI(cast<SwitchInst>(I));
2724 // Special case switch instruction to get formatting nice and correct.
2726 writeOperand(SI.getCondition(), true);
2728 writeOperand(SI.getDefaultDest(), true);
2730 for (SwitchInst::ConstCaseIt i = SI.case_begin(), e = SI.case_end();
2733 writeOperand(i.getCaseValue(), true);
2735 writeOperand(i.getCaseSuccessor(), true);
2738 } else if (isa<IndirectBrInst>(I)) {
2739 // Special case indirectbr instruction to get formatting nice and correct.
2741 writeOperand(Operand, true);
2744 for (unsigned i = 1, e = I.getNumOperands(); i != e; ++i) {
2747 writeOperand(I.getOperand(i), true);
2750 } else if (const PHINode *PN = dyn_cast<PHINode>(&I)) {
2752 TypePrinter.print(I.getType(), Out);
2755 for (unsigned op = 0, Eop = PN->getNumIncomingValues(); op < Eop; ++op) {
2756 if (op) Out << ", ";
2758 writeOperand(PN->getIncomingValue(op), false); Out << ", ";
2759 writeOperand(PN->getIncomingBlock(op), false); Out << " ]";
2761 } else if (const ExtractValueInst *EVI = dyn_cast<ExtractValueInst>(&I)) {
2763 writeOperand(I.getOperand(0), true);
2764 for (const unsigned *i = EVI->idx_begin(), *e = EVI->idx_end(); i != e; ++i)
2766 } else if (const InsertValueInst *IVI = dyn_cast<InsertValueInst>(&I)) {
2768 writeOperand(I.getOperand(0), true); Out << ", ";
2769 writeOperand(I.getOperand(1), true);
2770 for (const unsigned *i = IVI->idx_begin(), *e = IVI->idx_end(); i != e; ++i)
2772 } else if (const LandingPadInst *LPI = dyn_cast<LandingPadInst>(&I)) {
2774 TypePrinter.print(I.getType(), Out);
2775 Out << " personality ";
2776 writeOperand(I.getOperand(0), true); Out << '\n';
2778 if (LPI->isCleanup())
2781 for (unsigned i = 0, e = LPI->getNumClauses(); i != e; ++i) {
2782 if (i != 0 || LPI->isCleanup()) Out << "\n";
2783 if (LPI->isCatch(i))
2788 writeOperand(LPI->getClause(i), true);
2790 } else if (isa<ReturnInst>(I) && !Operand) {
2792 } else if (const CallInst *CI = dyn_cast<CallInst>(&I)) {
2793 // Print the calling convention being used.
2794 if (CI->getCallingConv() != CallingConv::C) {
2796 PrintCallingConv(CI->getCallingConv(), Out);
2799 Operand = CI->getCalledValue();
2800 FunctionType *FTy = cast<FunctionType>(CI->getFunctionType());
2801 Type *RetTy = FTy->getReturnType();
2802 const AttributeSet &PAL = CI->getAttributes();
2804 if (PAL.hasAttributes(AttributeSet::ReturnIndex))
2805 Out << ' ' << PAL.getAsString(AttributeSet::ReturnIndex);
2807 // If possible, print out the short form of the call instruction. We can
2808 // only do this if the first argument is a pointer to a nonvararg function,
2809 // and if the return type is not a pointer to a function.
2812 TypePrinter.print(FTy->isVarArg() ? FTy : RetTy, Out);
2814 writeOperand(Operand, false);
2816 for (unsigned op = 0, Eop = CI->getNumArgOperands(); op < Eop; ++op) {
2819 writeParamOperand(CI->getArgOperand(op), PAL, op + 1);
2822 // Emit an ellipsis if this is a musttail call in a vararg function. This
2823 // is only to aid readability, musttail calls forward varargs by default.
2824 if (CI->isMustTailCall() && CI->getParent() &&
2825 CI->getParent()->getParent() &&
2826 CI->getParent()->getParent()->isVarArg())
2830 if (PAL.hasAttributes(AttributeSet::FunctionIndex))
2831 Out << " #" << Machine.getAttributeGroupSlot(PAL.getFnAttributes());
2832 } else if (const InvokeInst *II = dyn_cast<InvokeInst>(&I)) {
2833 Operand = II->getCalledValue();
2834 FunctionType *FTy = cast<FunctionType>(II->getFunctionType());
2835 Type *RetTy = FTy->getReturnType();
2836 const AttributeSet &PAL = II->getAttributes();
2838 // Print the calling convention being used.
2839 if (II->getCallingConv() != CallingConv::C) {
2841 PrintCallingConv(II->getCallingConv(), Out);
2844 if (PAL.hasAttributes(AttributeSet::ReturnIndex))
2845 Out << ' ' << PAL.getAsString(AttributeSet::ReturnIndex);
2847 // If possible, print out the short form of the invoke instruction. We can
2848 // only do this if the first argument is a pointer to a nonvararg function,
2849 // and if the return type is not a pointer to a function.
2852 TypePrinter.print(FTy->isVarArg() ? FTy : RetTy, Out);
2854 writeOperand(Operand, false);
2856 for (unsigned op = 0, Eop = II->getNumArgOperands(); op < Eop; ++op) {
2859 writeParamOperand(II->getArgOperand(op), PAL, op + 1);
2863 if (PAL.hasAttributes(AttributeSet::FunctionIndex))
2864 Out << " #" << Machine.getAttributeGroupSlot(PAL.getFnAttributes());
2867 writeOperand(II->getNormalDest(), true);
2869 writeOperand(II->getUnwindDest(), true);
2871 } else if (const AllocaInst *AI = dyn_cast<AllocaInst>(&I)) {
2873 if (AI->isUsedWithInAlloca())
2875 TypePrinter.print(AI->getAllocatedType(), Out);
2877 // Explicitly write the array size if the code is broken, if it's an array
2878 // allocation, or if the type is not canonical for scalar allocations. The
2879 // latter case prevents the type from mutating when round-tripping through
2881 if (!AI->getArraySize() || AI->isArrayAllocation() ||
2882 !AI->getArraySize()->getType()->isIntegerTy(32)) {
2884 writeOperand(AI->getArraySize(), true);
2886 if (AI->getAlignment()) {
2887 Out << ", align " << AI->getAlignment();
2889 } else if (isa<CastInst>(I)) {
2892 writeOperand(Operand, true); // Work with broken code
2895 TypePrinter.print(I.getType(), Out);
2896 } else if (isa<VAArgInst>(I)) {
2899 writeOperand(Operand, true); // Work with broken code
2902 TypePrinter.print(I.getType(), Out);
2903 } else if (Operand) { // Print the normal way.
2904 if (const auto *GEP = dyn_cast<GetElementPtrInst>(&I)) {
2906 TypePrinter.print(GEP->getSourceElementType(), Out);
2908 } else if (const auto *LI = dyn_cast<LoadInst>(&I)) {
2910 TypePrinter.print(LI->getType(), Out);
2914 // PrintAllTypes - Instructions who have operands of all the same type
2915 // omit the type from all but the first operand. If the instruction has
2916 // different type operands (for example br), then they are all printed.
2917 bool PrintAllTypes = false;
2918 Type *TheType = Operand->getType();
2920 // Select, Store and ShuffleVector always print all types.
2921 if (isa<SelectInst>(I) || isa<StoreInst>(I) || isa<ShuffleVectorInst>(I)
2922 || isa<ReturnInst>(I)) {
2923 PrintAllTypes = true;
2925 for (unsigned i = 1, E = I.getNumOperands(); i != E; ++i) {
2926 Operand = I.getOperand(i);
2927 // note that Operand shouldn't be null, but the test helps make dump()
2928 // more tolerant of malformed IR
2929 if (Operand && Operand->getType() != TheType) {
2930 PrintAllTypes = true; // We have differing types! Print them all!
2936 if (!PrintAllTypes) {
2938 TypePrinter.print(TheType, Out);
2942 for (unsigned i = 0, E = I.getNumOperands(); i != E; ++i) {
2944 writeOperand(I.getOperand(i), PrintAllTypes);
2948 // Print atomic ordering/alignment for memory operations
2949 if (const LoadInst *LI = dyn_cast<LoadInst>(&I)) {
2951 writeAtomic(LI->getOrdering(), LI->getSynchScope());
2952 if (LI->getAlignment())
2953 Out << ", align " << LI->getAlignment();
2954 } else if (const StoreInst *SI = dyn_cast<StoreInst>(&I)) {
2956 writeAtomic(SI->getOrdering(), SI->getSynchScope());
2957 if (SI->getAlignment())
2958 Out << ", align " << SI->getAlignment();
2959 } else if (const AtomicCmpXchgInst *CXI = dyn_cast<AtomicCmpXchgInst>(&I)) {
2960 writeAtomicCmpXchg(CXI->getSuccessOrdering(), CXI->getFailureOrdering(),
2961 CXI->getSynchScope());
2962 } else if (const AtomicRMWInst *RMWI = dyn_cast<AtomicRMWInst>(&I)) {
2963 writeAtomic(RMWI->getOrdering(), RMWI->getSynchScope());
2964 } else if (const FenceInst *FI = dyn_cast<FenceInst>(&I)) {
2965 writeAtomic(FI->getOrdering(), FI->getSynchScope());
2968 // Print Metadata info.
2969 SmallVector<std::pair<unsigned, MDNode *>, 4> InstMD;
2970 I.getAllMetadata(InstMD);
2971 printMetadataAttachments(InstMD, ", ");
2973 // Print a nice comment.
2974 printInfoComment(I);
2977 void AssemblyWriter::printMetadataAttachments(
2978 const SmallVectorImpl<std::pair<unsigned, MDNode *>> &MDs,
2979 StringRef Separator) {
2983 if (MDNames.empty())
2984 TheModule->getMDKindNames(MDNames);
2986 for (const auto &I : MDs) {
2987 unsigned Kind = I.first;
2989 if (Kind < MDNames.size())
2990 Out << "!" << MDNames[Kind];
2992 Out << "!<unknown kind #" << Kind << ">";
2994 WriteAsOperandInternal(Out, I.second, &TypePrinter, &Machine, TheModule);
2998 void AssemblyWriter::writeMDNode(unsigned Slot, const MDNode *Node) {
2999 Out << '!' << Slot << " = ";
3000 printMDNodeBody(Node);
3004 void AssemblyWriter::writeAllMDNodes() {
3005 SmallVector<const MDNode *, 16> Nodes;
3006 Nodes.resize(Machine.mdn_size());
3007 for (SlotTracker::mdn_iterator I = Machine.mdn_begin(), E = Machine.mdn_end();
3009 Nodes[I->second] = cast<MDNode>(I->first);
3011 for (unsigned i = 0, e = Nodes.size(); i != e; ++i) {
3012 writeMDNode(i, Nodes[i]);
3016 void AssemblyWriter::printMDNodeBody(const MDNode *Node) {
3017 WriteMDNodeBodyInternal(Out, Node, &TypePrinter, &Machine, TheModule);
3020 void AssemblyWriter::writeAllAttributeGroups() {
3021 std::vector<std::pair<AttributeSet, unsigned> > asVec;
3022 asVec.resize(Machine.as_size());
3024 for (SlotTracker::as_iterator I = Machine.as_begin(), E = Machine.as_end();
3026 asVec[I->second] = *I;
3028 for (std::vector<std::pair<AttributeSet, unsigned> >::iterator
3029 I = asVec.begin(), E = asVec.end(); I != E; ++I)
3030 Out << "attributes #" << I->second << " = { "
3031 << I->first.getAsString(AttributeSet::FunctionIndex, true) << " }\n";
3034 void AssemblyWriter::printUseListOrder(const UseListOrder &Order) {
3035 bool IsInFunction = Machine.getFunction();
3039 Out << "uselistorder";
3040 if (const BasicBlock *BB =
3041 IsInFunction ? nullptr : dyn_cast<BasicBlock>(Order.V)) {
3043 writeOperand(BB->getParent(), false);
3045 writeOperand(BB, false);
3048 writeOperand(Order.V, true);
3052 assert(Order.Shuffle.size() >= 2 && "Shuffle too small");
3053 Out << Order.Shuffle[0];
3054 for (unsigned I = 1, E = Order.Shuffle.size(); I != E; ++I)
3055 Out << ", " << Order.Shuffle[I];
3059 void AssemblyWriter::printUseLists(const Function *F) {
3061 [&]() { return !UseListOrders.empty() && UseListOrders.back().F == F; };
3066 Out << "\n; uselistorder directives\n";
3068 printUseListOrder(UseListOrders.back());
3069 UseListOrders.pop_back();
3073 //===----------------------------------------------------------------------===//
3074 // External Interface declarations
3075 //===----------------------------------------------------------------------===//
3077 void Function::print(raw_ostream &ROS, AssemblyAnnotationWriter *AAW) const {
3078 SlotTracker SlotTable(this->getParent());
3079 formatted_raw_ostream OS(ROS);
3080 AssemblyWriter W(OS, SlotTable, this->getParent(), AAW);
3081 W.printFunction(this);
3084 void Module::print(raw_ostream &ROS, AssemblyAnnotationWriter *AAW,
3085 bool ShouldPreserveUseListOrder) const {
3086 SlotTracker SlotTable(this);
3087 formatted_raw_ostream OS(ROS);
3088 AssemblyWriter W(OS, SlotTable, this, AAW, ShouldPreserveUseListOrder);
3089 W.printModule(this);
3092 void NamedMDNode::print(raw_ostream &ROS) const {
3093 SlotTracker SlotTable(getParent());
3094 formatted_raw_ostream OS(ROS);
3095 AssemblyWriter W(OS, SlotTable, getParent(), nullptr);
3096 W.printNamedMDNode(this);
3099 void Comdat::print(raw_ostream &ROS) const {
3100 PrintLLVMName(ROS, getName(), ComdatPrefix);
3101 ROS << " = comdat ";
3103 switch (getSelectionKind()) {
3107 case Comdat::ExactMatch:
3108 ROS << "exactmatch";
3110 case Comdat::Largest:
3113 case Comdat::NoDuplicates:
3114 ROS << "noduplicates";
3116 case Comdat::SameSize:
3124 void Type::print(raw_ostream &OS) const {
3126 TP.print(const_cast<Type*>(this), OS);
3128 // If the type is a named struct type, print the body as well.
3129 if (StructType *STy = dyn_cast<StructType>(const_cast<Type*>(this)))
3130 if (!STy->isLiteral()) {
3132 TP.printStructBody(STy, OS);
3136 static bool isReferencingMDNode(const Instruction &I) {
3137 if (const auto *CI = dyn_cast<CallInst>(&I))
3138 if (Function *F = CI->getCalledFunction())
3139 if (F->isIntrinsic())
3140 for (auto &Op : I.operands())
3141 if (auto *V = dyn_cast_or_null<MetadataAsValue>(Op))
3142 if (isa<MDNode>(V->getMetadata()))
3147 void Value::print(raw_ostream &ROS) const {
3148 formatted_raw_ostream OS(ROS);
3149 if (const Instruction *I = dyn_cast<Instruction>(this)) {
3150 const Function *F = I->getParent() ? I->getParent()->getParent() : nullptr;
3151 SlotTracker SlotTable(
3153 /* ShouldInitializeAllMetadata */ isReferencingMDNode(*I));
3154 AssemblyWriter W(OS, SlotTable, getModuleFromVal(I), nullptr);
3155 W.printInstruction(*I);
3156 } else if (const BasicBlock *BB = dyn_cast<BasicBlock>(this)) {
3157 SlotTracker SlotTable(BB->getParent());
3158 AssemblyWriter W(OS, SlotTable, getModuleFromVal(BB), nullptr);
3159 W.printBasicBlock(BB);
3160 } else if (const GlobalValue *GV = dyn_cast<GlobalValue>(this)) {
3161 SlotTracker SlotTable(GV->getParent(),
3162 /* ShouldInitializeAllMetadata */ isa<Function>(GV));
3163 AssemblyWriter W(OS, SlotTable, GV->getParent(), nullptr);
3164 if (const GlobalVariable *V = dyn_cast<GlobalVariable>(GV))
3166 else if (const Function *F = dyn_cast<Function>(GV))
3169 W.printAlias(cast<GlobalAlias>(GV));
3170 } else if (const MetadataAsValue *V = dyn_cast<MetadataAsValue>(this)) {
3171 V->getMetadata()->print(ROS, getModuleFromVal(V));
3172 } else if (const Constant *C = dyn_cast<Constant>(this)) {
3173 TypePrinting TypePrinter;
3174 TypePrinter.print(C->getType(), OS);
3176 WriteConstantInternal(OS, C, TypePrinter, nullptr, nullptr);
3177 } else if (isa<InlineAsm>(this) || isa<Argument>(this)) {
3178 this->printAsOperand(OS);
3180 llvm_unreachable("Unknown value to print out!");
3184 void Value::printAsOperand(raw_ostream &O, bool PrintType, const Module *M) const {
3185 // Fast path: Don't construct and populate a TypePrinting object if we
3186 // won't be needing any types printed.
3187 bool IsMetadata = isa<MetadataAsValue>(this);
3188 if (!PrintType && ((!isa<Constant>(this) && !IsMetadata) || hasName() ||
3189 isa<GlobalValue>(this))) {
3190 WriteAsOperandInternal(O, this, nullptr, nullptr, M);
3195 M = getModuleFromVal(this);
3197 TypePrinting TypePrinter;
3199 TypePrinter.incorporateTypes(*M);
3201 TypePrinter.print(getType(), O);
3205 SlotTracker Machine(M, /* ShouldInitializeAllMetadata */ IsMetadata);
3206 WriteAsOperandInternal(O, this, &TypePrinter, &Machine, M);
3209 static void printMetadataImpl(raw_ostream &ROS, const Metadata &MD,
3210 const Module *M, bool OnlyAsOperand) {
3211 formatted_raw_ostream OS(ROS);
3213 auto *N = dyn_cast<MDNode>(&MD);
3214 TypePrinting TypePrinter;
3215 SlotTracker Machine(M, /* ShouldInitializeAllMetadata */ N);
3217 TypePrinter.incorporateTypes(*M);
3219 WriteAsOperandInternal(OS, &MD, &TypePrinter, &Machine, M,
3220 /* FromValue */ true);
3221 if (OnlyAsOperand || !N)
3225 WriteMDNodeBodyInternal(OS, N, &TypePrinter, &Machine, M);
3228 void Metadata::printAsOperand(raw_ostream &OS, const Module *M) const {
3229 printMetadataImpl(OS, *this, M, /* OnlyAsOperand */ true);
3232 void Metadata::print(raw_ostream &OS, const Module *M) const {
3233 printMetadataImpl(OS, *this, M, /* OnlyAsOperand */ false);
3236 // Value::dump - allow easy printing of Values from the debugger.
3238 void Value::dump() const { print(dbgs()); dbgs() << '\n'; }
3240 // Type::dump - allow easy printing of Types from the debugger.
3242 void Type::dump() const { print(dbgs()); dbgs() << '\n'; }
3244 // Module::dump() - Allow printing of Modules from the debugger.
3246 void Module::dump() const { print(dbgs(), nullptr); }
3248 // \brief Allow printing of Comdats from the debugger.
3250 void Comdat::dump() const { print(dbgs()); }
3252 // NamedMDNode::dump() - Allow printing of NamedMDNodes from the debugger.
3254 void NamedMDNode::dump() const { print(dbgs()); }
3257 void Metadata::dump() const { dump(nullptr); }
3260 void Metadata::dump(const Module *M) const {