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);
780 if (!I.getType()->isVoidTy() && !I.hasName())
781 CreateFunctionSlot(&I);
783 processInstructionMetadata(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) {
809 processInstructionMetadata(I);
812 void SlotTracker::processInstructionMetadata(const Instruction &I) {
813 // Process metadata used directly by intrinsics.
814 if (const CallInst *CI = dyn_cast<CallInst>(&I))
815 if (Function *F = CI->getCalledFunction())
816 if (F->isIntrinsic())
817 for (auto &Op : I.operands())
818 if (auto *V = dyn_cast_or_null<MetadataAsValue>(Op))
819 if (MDNode *N = dyn_cast<MDNode>(V->getMetadata()))
820 CreateMetadataSlot(N);
822 // Process metadata attached to this instruction.
823 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
824 I.getAllMetadata(MDs);
826 CreateMetadataSlot(MD.second);
829 /// Clean up after incorporating a function. This is the only way to get out of
830 /// the function incorporation state that affects get*Slot/Create*Slot. Function
831 /// incorporation state is indicated by TheFunction != 0.
832 void SlotTracker::purgeFunction() {
833 ST_DEBUG("begin purgeFunction!\n");
834 fMap.clear(); // Simply discard the function level map
835 TheFunction = nullptr;
836 FunctionProcessed = false;
837 ST_DEBUG("end purgeFunction!\n");
840 /// getGlobalSlot - Get the slot number of a global value.
841 int SlotTracker::getGlobalSlot(const GlobalValue *V) {
842 // Check for uninitialized state and do lazy initialization.
845 // Find the value in the module map
846 ValueMap::iterator MI = mMap.find(V);
847 return MI == mMap.end() ? -1 : (int)MI->second;
850 /// getMetadataSlot - Get the slot number of a MDNode.
851 int SlotTracker::getMetadataSlot(const MDNode *N) {
852 // Check for uninitialized state and do lazy initialization.
855 // Find the MDNode in the module map
856 mdn_iterator MI = mdnMap.find(N);
857 return MI == mdnMap.end() ? -1 : (int)MI->second;
861 /// getLocalSlot - Get the slot number for a value that is local to a function.
862 int SlotTracker::getLocalSlot(const Value *V) {
863 assert(!isa<Constant>(V) && "Can't get a constant or global slot with this!");
865 // Check for uninitialized state and do lazy initialization.
868 ValueMap::iterator FI = fMap.find(V);
869 return FI == fMap.end() ? -1 : (int)FI->second;
872 int SlotTracker::getAttributeGroupSlot(AttributeSet AS) {
873 // Check for uninitialized state and do lazy initialization.
876 // Find the AttributeSet in the module map.
877 as_iterator AI = asMap.find(AS);
878 return AI == asMap.end() ? -1 : (int)AI->second;
881 /// CreateModuleSlot - Insert the specified GlobalValue* into the slot table.
882 void SlotTracker::CreateModuleSlot(const GlobalValue *V) {
883 assert(V && "Can't insert a null Value into SlotTracker!");
884 assert(!V->getType()->isVoidTy() && "Doesn't need a slot!");
885 assert(!V->hasName() && "Doesn't need a slot!");
887 unsigned DestSlot = mNext++;
890 ST_DEBUG(" Inserting value [" << V->getType() << "] = " << V << " slot=" <<
892 // G = Global, F = Function, A = Alias, o = other
893 ST_DEBUG((isa<GlobalVariable>(V) ? 'G' :
894 (isa<Function>(V) ? 'F' :
895 (isa<GlobalAlias>(V) ? 'A' : 'o'))) << "]\n");
898 /// CreateSlot - Create a new slot for the specified value if it has no name.
899 void SlotTracker::CreateFunctionSlot(const Value *V) {
900 assert(!V->getType()->isVoidTy() && !V->hasName() && "Doesn't need a slot!");
902 unsigned DestSlot = fNext++;
905 // G = Global, F = Function, o = other
906 ST_DEBUG(" Inserting value [" << V->getType() << "] = " << V << " slot=" <<
907 DestSlot << " [o]\n");
910 /// CreateModuleSlot - Insert the specified MDNode* into the slot table.
911 void SlotTracker::CreateMetadataSlot(const MDNode *N) {
912 assert(N && "Can't insert a null Value into SlotTracker!");
914 unsigned DestSlot = mdnNext;
915 if (!mdnMap.insert(std::make_pair(N, DestSlot)).second)
919 // Recursively add any MDNodes referenced by operands.
920 for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i)
921 if (const MDNode *Op = dyn_cast_or_null<MDNode>(N->getOperand(i)))
922 CreateMetadataSlot(Op);
925 void SlotTracker::CreateAttributeSetSlot(AttributeSet AS) {
926 assert(AS.hasAttributes(AttributeSet::FunctionIndex) &&
927 "Doesn't need a slot!");
929 as_iterator I = asMap.find(AS);
930 if (I != asMap.end())
933 unsigned DestSlot = asNext++;
934 asMap[AS] = DestSlot;
937 //===----------------------------------------------------------------------===//
938 // AsmWriter Implementation
939 //===----------------------------------------------------------------------===//
941 static void WriteAsOperandInternal(raw_ostream &Out, const Value *V,
942 TypePrinting *TypePrinter,
943 SlotTracker *Machine,
944 const Module *Context);
946 static void WriteAsOperandInternal(raw_ostream &Out, const Metadata *MD,
947 TypePrinting *TypePrinter,
948 SlotTracker *Machine, const Module *Context,
949 bool FromValue = false);
951 static const char *getPredicateText(unsigned predicate) {
952 const char * pred = "unknown";
954 case FCmpInst::FCMP_FALSE: pred = "false"; break;
955 case FCmpInst::FCMP_OEQ: pred = "oeq"; break;
956 case FCmpInst::FCMP_OGT: pred = "ogt"; break;
957 case FCmpInst::FCMP_OGE: pred = "oge"; break;
958 case FCmpInst::FCMP_OLT: pred = "olt"; break;
959 case FCmpInst::FCMP_OLE: pred = "ole"; break;
960 case FCmpInst::FCMP_ONE: pred = "one"; break;
961 case FCmpInst::FCMP_ORD: pred = "ord"; break;
962 case FCmpInst::FCMP_UNO: pred = "uno"; break;
963 case FCmpInst::FCMP_UEQ: pred = "ueq"; break;
964 case FCmpInst::FCMP_UGT: pred = "ugt"; break;
965 case FCmpInst::FCMP_UGE: pred = "uge"; break;
966 case FCmpInst::FCMP_ULT: pred = "ult"; break;
967 case FCmpInst::FCMP_ULE: pred = "ule"; break;
968 case FCmpInst::FCMP_UNE: pred = "une"; break;
969 case FCmpInst::FCMP_TRUE: pred = "true"; break;
970 case ICmpInst::ICMP_EQ: pred = "eq"; break;
971 case ICmpInst::ICMP_NE: pred = "ne"; break;
972 case ICmpInst::ICMP_SGT: pred = "sgt"; break;
973 case ICmpInst::ICMP_SGE: pred = "sge"; break;
974 case ICmpInst::ICMP_SLT: pred = "slt"; break;
975 case ICmpInst::ICMP_SLE: pred = "sle"; break;
976 case ICmpInst::ICMP_UGT: pred = "ugt"; break;
977 case ICmpInst::ICMP_UGE: pred = "uge"; break;
978 case ICmpInst::ICMP_ULT: pred = "ult"; break;
979 case ICmpInst::ICMP_ULE: pred = "ule"; break;
984 static void writeAtomicRMWOperation(raw_ostream &Out,
985 AtomicRMWInst::BinOp Op) {
987 default: Out << " <unknown operation " << Op << ">"; break;
988 case AtomicRMWInst::Xchg: Out << " xchg"; break;
989 case AtomicRMWInst::Add: Out << " add"; break;
990 case AtomicRMWInst::Sub: Out << " sub"; break;
991 case AtomicRMWInst::And: Out << " and"; break;
992 case AtomicRMWInst::Nand: Out << " nand"; break;
993 case AtomicRMWInst::Or: Out << " or"; break;
994 case AtomicRMWInst::Xor: Out << " xor"; break;
995 case AtomicRMWInst::Max: Out << " max"; break;
996 case AtomicRMWInst::Min: Out << " min"; break;
997 case AtomicRMWInst::UMax: Out << " umax"; break;
998 case AtomicRMWInst::UMin: Out << " umin"; break;
1002 static void WriteOptimizationInfo(raw_ostream &Out, const User *U) {
1003 if (const FPMathOperator *FPO = dyn_cast<const FPMathOperator>(U)) {
1004 // Unsafe algebra implies all the others, no need to write them all out
1005 if (FPO->hasUnsafeAlgebra())
1008 if (FPO->hasNoNaNs())
1010 if (FPO->hasNoInfs())
1012 if (FPO->hasNoSignedZeros())
1014 if (FPO->hasAllowReciprocal())
1019 if (const OverflowingBinaryOperator *OBO =
1020 dyn_cast<OverflowingBinaryOperator>(U)) {
1021 if (OBO->hasNoUnsignedWrap())
1023 if (OBO->hasNoSignedWrap())
1025 } else if (const PossiblyExactOperator *Div =
1026 dyn_cast<PossiblyExactOperator>(U)) {
1029 } else if (const GEPOperator *GEP = dyn_cast<GEPOperator>(U)) {
1030 if (GEP->isInBounds())
1035 static void WriteConstantInternal(raw_ostream &Out, const Constant *CV,
1036 TypePrinting &TypePrinter,
1037 SlotTracker *Machine,
1038 const Module *Context) {
1039 if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV)) {
1040 if (CI->getType()->isIntegerTy(1)) {
1041 Out << (CI->getZExtValue() ? "true" : "false");
1044 Out << CI->getValue();
1048 if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV)) {
1049 if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEsingle ||
1050 &CFP->getValueAPF().getSemantics() == &APFloat::IEEEdouble) {
1051 // We would like to output the FP constant value in exponential notation,
1052 // but we cannot do this if doing so will lose precision. Check here to
1053 // make sure that we only output it in exponential format if we can parse
1054 // the value back and get the same value.
1057 bool isHalf = &CFP->getValueAPF().getSemantics()==&APFloat::IEEEhalf;
1058 bool isDouble = &CFP->getValueAPF().getSemantics()==&APFloat::IEEEdouble;
1059 bool isInf = CFP->getValueAPF().isInfinity();
1060 bool isNaN = CFP->getValueAPF().isNaN();
1061 if (!isHalf && !isInf && !isNaN) {
1062 double Val = isDouble ? CFP->getValueAPF().convertToDouble() :
1063 CFP->getValueAPF().convertToFloat();
1064 SmallString<128> StrVal;
1065 raw_svector_ostream(StrVal) << Val;
1067 // Check to make sure that the stringized number is not some string like
1068 // "Inf" or NaN, that atof will accept, but the lexer will not. Check
1069 // that the string matches the "[-+]?[0-9]" regex.
1071 if ((StrVal[0] >= '0' && StrVal[0] <= '9') ||
1072 ((StrVal[0] == '-' || StrVal[0] == '+') &&
1073 (StrVal[1] >= '0' && StrVal[1] <= '9'))) {
1074 // Reparse stringized version!
1075 if (APFloat(APFloat::IEEEdouble, StrVal).convertToDouble() == Val) {
1081 // Otherwise we could not reparse it to exactly the same value, so we must
1082 // output the string in hexadecimal format! Note that loading and storing
1083 // floating point types changes the bits of NaNs on some hosts, notably
1084 // x86, so we must not use these types.
1085 static_assert(sizeof(double) == sizeof(uint64_t),
1086 "assuming that double is 64 bits!");
1088 APFloat apf = CFP->getValueAPF();
1089 // Halves and floats are represented in ASCII IR as double, convert.
1091 apf.convert(APFloat::IEEEdouble, APFloat::rmNearestTiesToEven,
1094 utohex_buffer(uint64_t(apf.bitcastToAPInt().getZExtValue()),
1099 // Either half, or some form of long double.
1100 // These appear as a magic letter identifying the type, then a
1101 // fixed number of hex digits.
1103 // Bit position, in the current word, of the next nibble to print.
1106 if (&CFP->getValueAPF().getSemantics() == &APFloat::x87DoubleExtended) {
1108 // api needed to prevent premature destruction
1109 APInt api = CFP->getValueAPF().bitcastToAPInt();
1110 const uint64_t* p = api.getRawData();
1111 uint64_t word = p[1];
1113 int width = api.getBitWidth();
1114 for (int j=0; j<width; j+=4, shiftcount-=4) {
1115 unsigned int nibble = (word>>shiftcount) & 15;
1117 Out << (unsigned char)(nibble + '0');
1119 Out << (unsigned char)(nibble - 10 + 'A');
1120 if (shiftcount == 0 && j+4 < width) {
1124 shiftcount = width-j-4;
1128 } else if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEquad) {
1131 } else if (&CFP->getValueAPF().getSemantics() == &APFloat::PPCDoubleDouble) {
1134 } else if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEhalf) {
1138 llvm_unreachable("Unsupported floating point type");
1139 // api needed to prevent premature destruction
1140 APInt api = CFP->getValueAPF().bitcastToAPInt();
1141 const uint64_t* p = api.getRawData();
1143 int width = api.getBitWidth();
1144 for (int j=0; j<width; j+=4, shiftcount-=4) {
1145 unsigned int nibble = (word>>shiftcount) & 15;
1147 Out << (unsigned char)(nibble + '0');
1149 Out << (unsigned char)(nibble - 10 + 'A');
1150 if (shiftcount == 0 && j+4 < width) {
1154 shiftcount = width-j-4;
1160 if (isa<ConstantAggregateZero>(CV)) {
1161 Out << "zeroinitializer";
1165 if (const BlockAddress *BA = dyn_cast<BlockAddress>(CV)) {
1166 Out << "blockaddress(";
1167 WriteAsOperandInternal(Out, BA->getFunction(), &TypePrinter, Machine,
1170 WriteAsOperandInternal(Out, BA->getBasicBlock(), &TypePrinter, Machine,
1176 if (const ConstantArray *CA = dyn_cast<ConstantArray>(CV)) {
1177 Type *ETy = CA->getType()->getElementType();
1179 TypePrinter.print(ETy, Out);
1181 WriteAsOperandInternal(Out, CA->getOperand(0),
1182 &TypePrinter, Machine,
1184 for (unsigned i = 1, e = CA->getNumOperands(); i != e; ++i) {
1186 TypePrinter.print(ETy, Out);
1188 WriteAsOperandInternal(Out, CA->getOperand(i), &TypePrinter, Machine,
1195 if (const ConstantDataArray *CA = dyn_cast<ConstantDataArray>(CV)) {
1196 // As a special case, print the array as a string if it is an array of
1197 // i8 with ConstantInt values.
1198 if (CA->isString()) {
1200 PrintEscapedString(CA->getAsString(), Out);
1205 Type *ETy = CA->getType()->getElementType();
1207 TypePrinter.print(ETy, Out);
1209 WriteAsOperandInternal(Out, CA->getElementAsConstant(0),
1210 &TypePrinter, Machine,
1212 for (unsigned i = 1, e = CA->getNumElements(); i != e; ++i) {
1214 TypePrinter.print(ETy, Out);
1216 WriteAsOperandInternal(Out, CA->getElementAsConstant(i), &TypePrinter,
1224 if (const ConstantStruct *CS = dyn_cast<ConstantStruct>(CV)) {
1225 if (CS->getType()->isPacked())
1228 unsigned N = CS->getNumOperands();
1231 TypePrinter.print(CS->getOperand(0)->getType(), Out);
1234 WriteAsOperandInternal(Out, CS->getOperand(0), &TypePrinter, Machine,
1237 for (unsigned i = 1; i < N; i++) {
1239 TypePrinter.print(CS->getOperand(i)->getType(), Out);
1242 WriteAsOperandInternal(Out, CS->getOperand(i), &TypePrinter, Machine,
1249 if (CS->getType()->isPacked())
1254 if (isa<ConstantVector>(CV) || isa<ConstantDataVector>(CV)) {
1255 Type *ETy = CV->getType()->getVectorElementType();
1257 TypePrinter.print(ETy, Out);
1259 WriteAsOperandInternal(Out, CV->getAggregateElement(0U), &TypePrinter,
1261 for (unsigned i = 1, e = CV->getType()->getVectorNumElements(); i != e;++i){
1263 TypePrinter.print(ETy, Out);
1265 WriteAsOperandInternal(Out, CV->getAggregateElement(i), &TypePrinter,
1272 if (isa<ConstantPointerNull>(CV)) {
1277 if (isa<UndefValue>(CV)) {
1282 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV)) {
1283 Out << CE->getOpcodeName();
1284 WriteOptimizationInfo(Out, CE);
1285 if (CE->isCompare())
1286 Out << ' ' << getPredicateText(CE->getPredicate());
1289 if (const GEPOperator *GEP = dyn_cast<GEPOperator>(CE)) {
1291 cast<PointerType>(GEP->getPointerOperandType()->getScalarType())
1297 for (User::const_op_iterator OI=CE->op_begin(); OI != CE->op_end(); ++OI) {
1298 TypePrinter.print((*OI)->getType(), Out);
1300 WriteAsOperandInternal(Out, *OI, &TypePrinter, Machine, Context);
1301 if (OI+1 != CE->op_end())
1305 if (CE->hasIndices()) {
1306 ArrayRef<unsigned> Indices = CE->getIndices();
1307 for (unsigned i = 0, e = Indices.size(); i != e; ++i)
1308 Out << ", " << Indices[i];
1313 TypePrinter.print(CE->getType(), Out);
1320 Out << "<placeholder or erroneous Constant>";
1323 static void writeMDTuple(raw_ostream &Out, const MDTuple *Node,
1324 TypePrinting *TypePrinter, SlotTracker *Machine,
1325 const Module *Context) {
1327 for (unsigned mi = 0, me = Node->getNumOperands(); mi != me; ++mi) {
1328 const Metadata *MD = Node->getOperand(mi);
1331 else if (auto *MDV = dyn_cast<ValueAsMetadata>(MD)) {
1332 Value *V = MDV->getValue();
1333 TypePrinter->print(V->getType(), Out);
1335 WriteAsOperandInternal(Out, V, TypePrinter, Machine, Context);
1337 WriteAsOperandInternal(Out, MD, TypePrinter, Machine, Context);
1347 struct FieldSeparator {
1350 FieldSeparator(const char *Sep = ", ") : Skip(true), Sep(Sep) {}
1352 raw_ostream &operator<<(raw_ostream &OS, FieldSeparator &FS) {
1357 return OS << FS.Sep;
1359 struct MDFieldPrinter {
1362 TypePrinting *TypePrinter;
1363 SlotTracker *Machine;
1364 const Module *Context;
1366 explicit MDFieldPrinter(raw_ostream &Out)
1367 : Out(Out), TypePrinter(nullptr), Machine(nullptr), Context(nullptr) {}
1368 MDFieldPrinter(raw_ostream &Out, TypePrinting *TypePrinter,
1369 SlotTracker *Machine, const Module *Context)
1370 : Out(Out), TypePrinter(TypePrinter), Machine(Machine), Context(Context) {
1372 void printTag(const DebugNode *N);
1373 void printString(StringRef Name, StringRef Value,
1374 bool ShouldSkipEmpty = true);
1375 void printMetadata(StringRef Name, const Metadata *MD,
1376 bool ShouldSkipNull = true);
1377 template <class IntTy>
1378 void printInt(StringRef Name, IntTy Int, bool ShouldSkipZero = true);
1379 void printBool(StringRef Name, bool Value);
1380 void printDIFlags(StringRef Name, unsigned Flags);
1381 template <class IntTy, class Stringifier>
1382 void printDwarfEnum(StringRef Name, IntTy Value, Stringifier toString,
1383 bool ShouldSkipZero = true);
1387 void MDFieldPrinter::printTag(const DebugNode *N) {
1388 Out << FS << "tag: ";
1389 if (const char *Tag = dwarf::TagString(N->getTag()))
1395 void MDFieldPrinter::printString(StringRef Name, StringRef Value,
1396 bool ShouldSkipEmpty) {
1397 if (ShouldSkipEmpty && Value.empty())
1400 Out << FS << Name << ": \"";
1401 PrintEscapedString(Value, Out);
1405 static void writeMetadataAsOperand(raw_ostream &Out, const Metadata *MD,
1406 TypePrinting *TypePrinter,
1407 SlotTracker *Machine,
1408 const Module *Context) {
1413 WriteAsOperandInternal(Out, MD, TypePrinter, Machine, Context);
1416 void MDFieldPrinter::printMetadata(StringRef Name, const Metadata *MD,
1417 bool ShouldSkipNull) {
1418 if (ShouldSkipNull && !MD)
1421 Out << FS << Name << ": ";
1422 writeMetadataAsOperand(Out, MD, TypePrinter, Machine, Context);
1425 template <class IntTy>
1426 void MDFieldPrinter::printInt(StringRef Name, IntTy Int, bool ShouldSkipZero) {
1427 if (ShouldSkipZero && !Int)
1430 Out << FS << Name << ": " << Int;
1433 void MDFieldPrinter::printBool(StringRef Name, bool Value) {
1434 Out << FS << Name << ": " << (Value ? "true" : "false");
1437 void MDFieldPrinter::printDIFlags(StringRef Name, unsigned Flags) {
1441 Out << FS << Name << ": ";
1443 SmallVector<unsigned, 8> SplitFlags;
1444 unsigned Extra = DebugNode::splitFlags(Flags, SplitFlags);
1446 FieldSeparator FlagsFS(" | ");
1447 for (unsigned F : SplitFlags) {
1448 const char *StringF = DebugNode::getFlagString(F);
1449 assert(StringF && "Expected valid flag");
1450 Out << FlagsFS << StringF;
1452 if (Extra || SplitFlags.empty())
1453 Out << FlagsFS << Extra;
1456 template <class IntTy, class Stringifier>
1457 void MDFieldPrinter::printDwarfEnum(StringRef Name, IntTy Value,
1458 Stringifier toString, bool ShouldSkipZero) {
1462 Out << FS << Name << ": ";
1463 if (const char *S = toString(Value))
1469 static void writeGenericDebugNode(raw_ostream &Out, const GenericDebugNode *N,
1470 TypePrinting *TypePrinter,
1471 SlotTracker *Machine, const Module *Context) {
1472 Out << "!GenericDebugNode(";
1473 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1474 Printer.printTag(N);
1475 Printer.printString("header", N->getHeader());
1476 if (N->getNumDwarfOperands()) {
1477 Out << Printer.FS << "operands: {";
1479 for (auto &I : N->dwarf_operands()) {
1481 writeMetadataAsOperand(Out, I, TypePrinter, Machine, Context);
1488 static void writeMDLocation(raw_ostream &Out, const MDLocation *DL,
1489 TypePrinting *TypePrinter, SlotTracker *Machine,
1490 const Module *Context) {
1491 Out << "!MDLocation(";
1492 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1493 // Always output the line, since 0 is a relevant and important value for it.
1494 Printer.printInt("line", DL->getLine(), /* ShouldSkipZero */ false);
1495 Printer.printInt("column", DL->getColumn());
1496 Printer.printMetadata("scope", DL->getRawScope(), /* ShouldSkipNull */ false);
1497 Printer.printMetadata("inlinedAt", DL->getRawInlinedAt());
1501 static void writeMDSubrange(raw_ostream &Out, const MDSubrange *N,
1502 TypePrinting *, SlotTracker *, const Module *) {
1503 Out << "!MDSubrange(";
1504 MDFieldPrinter Printer(Out);
1505 Printer.printInt("count", N->getCount(), /* ShouldSkipZero */ false);
1506 Printer.printInt("lowerBound", N->getLowerBound());
1510 static void writeMDEnumerator(raw_ostream &Out, const MDEnumerator *N,
1511 TypePrinting *, SlotTracker *, const Module *) {
1512 Out << "!MDEnumerator(";
1513 MDFieldPrinter Printer(Out);
1514 Printer.printString("name", N->getName(), /* ShouldSkipEmpty */ false);
1515 Printer.printInt("value", N->getValue(), /* ShouldSkipZero */ false);
1519 static void writeMDBasicType(raw_ostream &Out, const MDBasicType *N,
1520 TypePrinting *, SlotTracker *, const Module *) {
1521 Out << "!MDBasicType(";
1522 MDFieldPrinter Printer(Out);
1523 if (N->getTag() != dwarf::DW_TAG_base_type)
1524 Printer.printTag(N);
1525 Printer.printString("name", N->getName());
1526 Printer.printInt("size", N->getSizeInBits());
1527 Printer.printInt("align", N->getAlignInBits());
1528 Printer.printDwarfEnum("encoding", N->getEncoding(),
1529 dwarf::AttributeEncodingString);
1533 static void writeMDDerivedType(raw_ostream &Out, const MDDerivedType *N,
1534 TypePrinting *TypePrinter, SlotTracker *Machine,
1535 const Module *Context) {
1536 Out << "!MDDerivedType(";
1537 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1538 Printer.printTag(N);
1539 Printer.printString("name", N->getName());
1540 Printer.printMetadata("scope", N->getRawScope());
1541 Printer.printMetadata("file", N->getRawFile());
1542 Printer.printInt("line", N->getLine());
1543 Printer.printMetadata("baseType", N->getRawBaseType(),
1544 /* ShouldSkipNull */ false);
1545 Printer.printInt("size", N->getSizeInBits());
1546 Printer.printInt("align", N->getAlignInBits());
1547 Printer.printInt("offset", N->getOffsetInBits());
1548 Printer.printDIFlags("flags", N->getFlags());
1549 Printer.printMetadata("extraData", N->getRawExtraData());
1553 static void writeMDCompositeType(raw_ostream &Out, const MDCompositeType *N,
1554 TypePrinting *TypePrinter,
1555 SlotTracker *Machine, const Module *Context) {
1556 Out << "!MDCompositeType(";
1557 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1558 Printer.printTag(N);
1559 Printer.printString("name", N->getName());
1560 Printer.printMetadata("scope", N->getRawScope());
1561 Printer.printMetadata("file", N->getRawFile());
1562 Printer.printInt("line", N->getLine());
1563 Printer.printMetadata("baseType", N->getRawBaseType());
1564 Printer.printInt("size", N->getSizeInBits());
1565 Printer.printInt("align", N->getAlignInBits());
1566 Printer.printInt("offset", N->getOffsetInBits());
1567 Printer.printDIFlags("flags", N->getFlags());
1568 Printer.printMetadata("elements", N->getRawElements());
1569 Printer.printDwarfEnum("runtimeLang", N->getRuntimeLang(),
1570 dwarf::LanguageString);
1571 Printer.printMetadata("vtableHolder", N->getRawVTableHolder());
1572 Printer.printMetadata("templateParams", N->getRawTemplateParams());
1573 Printer.printString("identifier", N->getIdentifier());
1577 static void writeMDSubroutineType(raw_ostream &Out, const MDSubroutineType *N,
1578 TypePrinting *TypePrinter,
1579 SlotTracker *Machine, const Module *Context) {
1580 Out << "!MDSubroutineType(";
1581 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1582 Printer.printDIFlags("flags", N->getFlags());
1583 Printer.printMetadata("types", N->getRawTypeArray(),
1584 /* ShouldSkipNull */ false);
1588 static void writeMDFile(raw_ostream &Out, const MDFile *N, TypePrinting *,
1589 SlotTracker *, const Module *) {
1591 MDFieldPrinter Printer(Out);
1592 Printer.printString("filename", N->getFilename(),
1593 /* ShouldSkipEmpty */ false);
1594 Printer.printString("directory", N->getDirectory(),
1595 /* ShouldSkipEmpty */ false);
1599 static void writeMDCompileUnit(raw_ostream &Out, const MDCompileUnit *N,
1600 TypePrinting *TypePrinter, SlotTracker *Machine,
1601 const Module *Context) {
1602 Out << "!MDCompileUnit(";
1603 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1604 Printer.printDwarfEnum("language", N->getSourceLanguage(),
1605 dwarf::LanguageString, /* ShouldSkipZero */ false);
1606 Printer.printMetadata("file", N->getRawFile(), /* ShouldSkipNull */ false);
1607 Printer.printString("producer", N->getProducer());
1608 Printer.printBool("isOptimized", N->isOptimized());
1609 Printer.printString("flags", N->getFlags());
1610 Printer.printInt("runtimeVersion", N->getRuntimeVersion(),
1611 /* ShouldSkipZero */ false);
1612 Printer.printString("splitDebugFilename", N->getSplitDebugFilename());
1613 Printer.printInt("emissionKind", N->getEmissionKind(),
1614 /* ShouldSkipZero */ false);
1615 Printer.printMetadata("enums", N->getRawEnumTypes());
1616 Printer.printMetadata("retainedTypes", N->getRawRetainedTypes());
1617 Printer.printMetadata("subprograms", N->getRawSubprograms());
1618 Printer.printMetadata("globals", N->getRawGlobalVariables());
1619 Printer.printMetadata("imports", N->getRawImportedEntities());
1623 static void writeMDSubprogram(raw_ostream &Out, const MDSubprogram *N,
1624 TypePrinting *TypePrinter, SlotTracker *Machine,
1625 const Module *Context) {
1626 Out << "!MDSubprogram(";
1627 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1628 Printer.printString("name", N->getName());
1629 Printer.printString("linkageName", N->getLinkageName());
1630 Printer.printMetadata("scope", N->getRawScope(), /* ShouldSkipNull */ false);
1631 Printer.printMetadata("file", N->getRawFile());
1632 Printer.printInt("line", N->getLine());
1633 Printer.printMetadata("type", N->getRawType());
1634 Printer.printBool("isLocal", N->isLocalToUnit());
1635 Printer.printBool("isDefinition", N->isDefinition());
1636 Printer.printInt("scopeLine", N->getScopeLine());
1637 Printer.printMetadata("containingType", N->getRawContainingType());
1638 Printer.printDwarfEnum("virtuality", N->getVirtuality(),
1639 dwarf::VirtualityString);
1640 Printer.printInt("virtualIndex", N->getVirtualIndex());
1641 Printer.printDIFlags("flags", N->getFlags());
1642 Printer.printBool("isOptimized", N->isOptimized());
1643 Printer.printMetadata("function", N->getRawFunction());
1644 Printer.printMetadata("templateParams", N->getRawTemplateParams());
1645 Printer.printMetadata("declaration", N->getRawDeclaration());
1646 Printer.printMetadata("variables", N->getRawVariables());
1650 static void writeMDLexicalBlock(raw_ostream &Out, const MDLexicalBlock *N,
1651 TypePrinting *TypePrinter, SlotTracker *Machine,
1652 const Module *Context) {
1653 Out << "!MDLexicalBlock(";
1654 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1655 Printer.printMetadata("scope", N->getRawScope(), /* ShouldSkipNull */ false);
1656 Printer.printMetadata("file", N->getRawFile());
1657 Printer.printInt("line", N->getLine());
1658 Printer.printInt("column", N->getColumn());
1662 static void writeMDLexicalBlockFile(raw_ostream &Out,
1663 const MDLexicalBlockFile *N,
1664 TypePrinting *TypePrinter,
1665 SlotTracker *Machine,
1666 const Module *Context) {
1667 Out << "!MDLexicalBlockFile(";
1668 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1669 Printer.printMetadata("scope", N->getRawScope(), /* ShouldSkipNull */ false);
1670 Printer.printMetadata("file", N->getRawFile());
1671 Printer.printInt("discriminator", N->getDiscriminator(),
1672 /* ShouldSkipZero */ false);
1676 static void writeMDNamespace(raw_ostream &Out, const MDNamespace *N,
1677 TypePrinting *TypePrinter, SlotTracker *Machine,
1678 const Module *Context) {
1679 Out << "!MDNamespace(";
1680 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1681 Printer.printString("name", N->getName());
1682 Printer.printMetadata("scope", N->getRawScope(), /* ShouldSkipNull */ false);
1683 Printer.printMetadata("file", N->getRawFile());
1684 Printer.printInt("line", N->getLine());
1688 static void writeMDTemplateTypeParameter(raw_ostream &Out,
1689 const MDTemplateTypeParameter *N,
1690 TypePrinting *TypePrinter,
1691 SlotTracker *Machine,
1692 const Module *Context) {
1693 Out << "!MDTemplateTypeParameter(";
1694 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1695 Printer.printString("name", N->getName());
1696 Printer.printMetadata("type", N->getRawType(), /* ShouldSkipNull */ false);
1700 static void writeMDTemplateValueParameter(raw_ostream &Out,
1701 const MDTemplateValueParameter *N,
1702 TypePrinting *TypePrinter,
1703 SlotTracker *Machine,
1704 const Module *Context) {
1705 Out << "!MDTemplateValueParameter(";
1706 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1707 if (N->getTag() != dwarf::DW_TAG_template_value_parameter)
1708 Printer.printTag(N);
1709 Printer.printString("name", N->getName());
1710 Printer.printMetadata("type", N->getRawType());
1711 Printer.printMetadata("value", N->getValue(), /* ShouldSkipNull */ false);
1715 static void writeMDGlobalVariable(raw_ostream &Out, const MDGlobalVariable *N,
1716 TypePrinting *TypePrinter,
1717 SlotTracker *Machine, const Module *Context) {
1718 Out << "!MDGlobalVariable(";
1719 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1720 Printer.printString("name", N->getName());
1721 Printer.printString("linkageName", N->getLinkageName());
1722 Printer.printMetadata("scope", N->getRawScope(), /* ShouldSkipNull */ false);
1723 Printer.printMetadata("file", N->getRawFile());
1724 Printer.printInt("line", N->getLine());
1725 Printer.printMetadata("type", N->getRawType());
1726 Printer.printBool("isLocal", N->isLocalToUnit());
1727 Printer.printBool("isDefinition", N->isDefinition());
1728 Printer.printMetadata("variable", N->getRawVariable());
1729 Printer.printMetadata("declaration", N->getRawStaticDataMemberDeclaration());
1733 static void writeMDLocalVariable(raw_ostream &Out, const MDLocalVariable *N,
1734 TypePrinting *TypePrinter,
1735 SlotTracker *Machine, const Module *Context) {
1736 Out << "!MDLocalVariable(";
1737 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1738 Printer.printTag(N);
1739 Printer.printString("name", N->getName());
1740 Printer.printInt("arg", N->getArg(),
1741 /* ShouldSkipZero */
1742 N->getTag() == dwarf::DW_TAG_auto_variable);
1743 Printer.printMetadata("scope", N->getRawScope(), /* ShouldSkipNull */ false);
1744 Printer.printMetadata("file", N->getRawFile());
1745 Printer.printInt("line", N->getLine());
1746 Printer.printMetadata("type", N->getRawType());
1747 Printer.printDIFlags("flags", N->getFlags());
1748 Printer.printMetadata("inlinedAt", N->getRawInlinedAt());
1752 static void writeMDExpression(raw_ostream &Out, const MDExpression *N,
1753 TypePrinting *TypePrinter, SlotTracker *Machine,
1754 const Module *Context) {
1755 Out << "!MDExpression(";
1758 for (auto I = N->expr_op_begin(), E = N->expr_op_end(); I != E; ++I) {
1759 const char *OpStr = dwarf::OperationEncodingString(I->getOp());
1760 assert(OpStr && "Expected valid opcode");
1763 for (unsigned A = 0, AE = I->getNumArgs(); A != AE; ++A)
1764 Out << FS << I->getArg(A);
1767 for (const auto &I : N->getElements())
1773 static void writeMDObjCProperty(raw_ostream &Out, const MDObjCProperty *N,
1774 TypePrinting *TypePrinter, SlotTracker *Machine,
1775 const Module *Context) {
1776 Out << "!MDObjCProperty(";
1777 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1778 Printer.printString("name", N->getName());
1779 Printer.printMetadata("file", N->getRawFile());
1780 Printer.printInt("line", N->getLine());
1781 Printer.printString("setter", N->getSetterName());
1782 Printer.printString("getter", N->getGetterName());
1783 Printer.printInt("attributes", N->getAttributes());
1784 Printer.printMetadata("type", N->getRawType());
1788 static void writeMDImportedEntity(raw_ostream &Out, const MDImportedEntity *N,
1789 TypePrinting *TypePrinter,
1790 SlotTracker *Machine, const Module *Context) {
1791 Out << "!MDImportedEntity(";
1792 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1793 Printer.printTag(N);
1794 Printer.printString("name", N->getName());
1795 Printer.printMetadata("scope", N->getRawScope(), /* ShouldSkipNull */ false);
1796 Printer.printMetadata("entity", N->getRawEntity());
1797 Printer.printInt("line", N->getLine());
1802 static void WriteMDNodeBodyInternal(raw_ostream &Out, const MDNode *Node,
1803 TypePrinting *TypePrinter,
1804 SlotTracker *Machine,
1805 const Module *Context) {
1806 if (Node->isDistinct())
1808 else if (Node->isTemporary())
1809 Out << "<temporary!> "; // Handle broken code.
1811 switch (Node->getMetadataID()) {
1813 llvm_unreachable("Expected uniquable MDNode");
1814 #define HANDLE_MDNODE_LEAF(CLASS) \
1815 case Metadata::CLASS##Kind: \
1816 write##CLASS(Out, cast<CLASS>(Node), TypePrinter, Machine, Context); \
1818 #include "llvm/IR/Metadata.def"
1822 // Full implementation of printing a Value as an operand with support for
1823 // TypePrinting, etc.
1824 static void WriteAsOperandInternal(raw_ostream &Out, const Value *V,
1825 TypePrinting *TypePrinter,
1826 SlotTracker *Machine,
1827 const Module *Context) {
1829 PrintLLVMName(Out, V);
1833 const Constant *CV = dyn_cast<Constant>(V);
1834 if (CV && !isa<GlobalValue>(CV)) {
1835 assert(TypePrinter && "Constants require TypePrinting!");
1836 WriteConstantInternal(Out, CV, *TypePrinter, Machine, Context);
1840 if (const InlineAsm *IA = dyn_cast<InlineAsm>(V)) {
1842 if (IA->hasSideEffects())
1843 Out << "sideeffect ";
1844 if (IA->isAlignStack())
1845 Out << "alignstack ";
1846 // We don't emit the AD_ATT dialect as it's the assumed default.
1847 if (IA->getDialect() == InlineAsm::AD_Intel)
1848 Out << "inteldialect ";
1850 PrintEscapedString(IA->getAsmString(), Out);
1852 PrintEscapedString(IA->getConstraintString(), Out);
1857 if (auto *MD = dyn_cast<MetadataAsValue>(V)) {
1858 WriteAsOperandInternal(Out, MD->getMetadata(), TypePrinter, Machine,
1859 Context, /* FromValue */ true);
1865 // If we have a SlotTracker, use it.
1867 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
1868 Slot = Machine->getGlobalSlot(GV);
1871 Slot = Machine->getLocalSlot(V);
1873 // If the local value didn't succeed, then we may be referring to a value
1874 // from a different function. Translate it, as this can happen when using
1875 // address of blocks.
1877 if ((Machine = createSlotTracker(V))) {
1878 Slot = Machine->getLocalSlot(V);
1882 } else if ((Machine = createSlotTracker(V))) {
1883 // Otherwise, create one to get the # and then destroy it.
1884 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
1885 Slot = Machine->getGlobalSlot(GV);
1888 Slot = Machine->getLocalSlot(V);
1897 Out << Prefix << Slot;
1902 static void WriteAsOperandInternal(raw_ostream &Out, const Metadata *MD,
1903 TypePrinting *TypePrinter,
1904 SlotTracker *Machine, const Module *Context,
1906 if (const MDNode *N = dyn_cast<MDNode>(MD)) {
1908 Machine = new SlotTracker(Context);
1909 int Slot = Machine->getMetadataSlot(N);
1911 // Give the pointer value instead of "badref", since this comes up all
1912 // the time when debugging.
1913 Out << "<" << N << ">";
1919 if (const MDString *MDS = dyn_cast<MDString>(MD)) {
1921 PrintEscapedString(MDS->getString(), Out);
1926 auto *V = cast<ValueAsMetadata>(MD);
1927 assert(TypePrinter && "TypePrinter required for metadata values");
1928 assert((FromValue || !isa<LocalAsMetadata>(V)) &&
1929 "Unexpected function-local metadata outside of value argument");
1931 TypePrinter->print(V->getValue()->getType(), Out);
1933 WriteAsOperandInternal(Out, V->getValue(), TypePrinter, Machine, Context);
1937 class AssemblyWriter {
1938 formatted_raw_ostream &Out;
1939 const Module *TheModule;
1940 std::unique_ptr<SlotTracker> ModuleSlotTracker;
1941 SlotTracker &Machine;
1942 TypePrinting TypePrinter;
1943 AssemblyAnnotationWriter *AnnotationWriter;
1944 SetVector<const Comdat *> Comdats;
1945 UseListOrderStack UseListOrders;
1948 /// Construct an AssemblyWriter with an external SlotTracker
1949 AssemblyWriter(formatted_raw_ostream &o, SlotTracker &Mac,
1950 const Module *M, AssemblyAnnotationWriter *AAW);
1952 /// Construct an AssemblyWriter with an internally allocated SlotTracker
1953 AssemblyWriter(formatted_raw_ostream &o, const Module *M,
1954 AssemblyAnnotationWriter *AAW);
1956 void printMDNodeBody(const MDNode *MD);
1957 void printNamedMDNode(const NamedMDNode *NMD);
1959 void printModule(const Module *M);
1961 void writeOperand(const Value *Op, bool PrintType);
1962 void writeParamOperand(const Value *Operand, AttributeSet Attrs,unsigned Idx);
1963 void writeAtomic(AtomicOrdering Ordering, SynchronizationScope SynchScope);
1964 void writeAtomicCmpXchg(AtomicOrdering SuccessOrdering,
1965 AtomicOrdering FailureOrdering,
1966 SynchronizationScope SynchScope);
1968 void writeAllMDNodes();
1969 void writeMDNode(unsigned Slot, const MDNode *Node);
1970 void writeAllAttributeGroups();
1972 void printTypeIdentities();
1973 void printGlobal(const GlobalVariable *GV);
1974 void printAlias(const GlobalAlias *GV);
1975 void printComdat(const Comdat *C);
1976 void printFunction(const Function *F);
1977 void printArgument(const Argument *FA, AttributeSet Attrs, unsigned Idx);
1978 void printBasicBlock(const BasicBlock *BB);
1979 void printInstructionLine(const Instruction &I);
1980 void printInstruction(const Instruction &I);
1982 void printUseListOrder(const UseListOrder &Order);
1983 void printUseLists(const Function *F);
1988 // printInfoComment - Print a little comment after the instruction indicating
1989 // which slot it occupies.
1990 void printInfoComment(const Value &V);
1994 void AssemblyWriter::init() {
1997 TypePrinter.incorporateTypes(*TheModule);
1998 for (const Function &F : *TheModule)
1999 if (const Comdat *C = F.getComdat())
2001 for (const GlobalVariable &GV : TheModule->globals())
2002 if (const Comdat *C = GV.getComdat())
2007 AssemblyWriter::AssemblyWriter(formatted_raw_ostream &o, SlotTracker &Mac,
2009 AssemblyAnnotationWriter *AAW)
2010 : Out(o), TheModule(M), Machine(Mac), AnnotationWriter(AAW) {
2014 AssemblyWriter::AssemblyWriter(formatted_raw_ostream &o, const Module *M,
2015 AssemblyAnnotationWriter *AAW)
2016 : Out(o), TheModule(M), ModuleSlotTracker(createSlotTracker(M)),
2017 Machine(*ModuleSlotTracker), AnnotationWriter(AAW) {
2021 void AssemblyWriter::writeOperand(const Value *Operand, bool PrintType) {
2023 Out << "<null operand!>";
2027 TypePrinter.print(Operand->getType(), Out);
2030 WriteAsOperandInternal(Out, Operand, &TypePrinter, &Machine, TheModule);
2033 void AssemblyWriter::writeAtomic(AtomicOrdering Ordering,
2034 SynchronizationScope SynchScope) {
2035 if (Ordering == NotAtomic)
2038 switch (SynchScope) {
2039 case SingleThread: Out << " singlethread"; break;
2040 case CrossThread: break;
2044 default: Out << " <bad ordering " << int(Ordering) << ">"; break;
2045 case Unordered: Out << " unordered"; break;
2046 case Monotonic: Out << " monotonic"; break;
2047 case Acquire: Out << " acquire"; break;
2048 case Release: Out << " release"; break;
2049 case AcquireRelease: Out << " acq_rel"; break;
2050 case SequentiallyConsistent: Out << " seq_cst"; break;
2054 void AssemblyWriter::writeAtomicCmpXchg(AtomicOrdering SuccessOrdering,
2055 AtomicOrdering FailureOrdering,
2056 SynchronizationScope SynchScope) {
2057 assert(SuccessOrdering != NotAtomic && FailureOrdering != NotAtomic);
2059 switch (SynchScope) {
2060 case SingleThread: Out << " singlethread"; break;
2061 case CrossThread: break;
2064 switch (SuccessOrdering) {
2065 default: Out << " <bad ordering " << int(SuccessOrdering) << ">"; break;
2066 case Unordered: Out << " unordered"; break;
2067 case Monotonic: Out << " monotonic"; break;
2068 case Acquire: Out << " acquire"; break;
2069 case Release: Out << " release"; break;
2070 case AcquireRelease: Out << " acq_rel"; break;
2071 case SequentiallyConsistent: Out << " seq_cst"; break;
2074 switch (FailureOrdering) {
2075 default: Out << " <bad ordering " << int(FailureOrdering) << ">"; break;
2076 case Unordered: Out << " unordered"; break;
2077 case Monotonic: Out << " monotonic"; break;
2078 case Acquire: Out << " acquire"; break;
2079 case Release: Out << " release"; break;
2080 case AcquireRelease: Out << " acq_rel"; break;
2081 case SequentiallyConsistent: Out << " seq_cst"; break;
2085 void AssemblyWriter::writeParamOperand(const Value *Operand,
2086 AttributeSet Attrs, unsigned Idx) {
2088 Out << "<null operand!>";
2093 TypePrinter.print(Operand->getType(), Out);
2094 // Print parameter attributes list
2095 if (Attrs.hasAttributes(Idx))
2096 Out << ' ' << Attrs.getAsString(Idx);
2098 // Print the operand
2099 WriteAsOperandInternal(Out, Operand, &TypePrinter, &Machine, TheModule);
2102 void AssemblyWriter::printModule(const Module *M) {
2103 Machine.initialize();
2105 if (shouldPreserveAssemblyUseListOrder())
2106 UseListOrders = predictUseListOrder(M);
2108 if (!M->getModuleIdentifier().empty() &&
2109 // Don't print the ID if it will start a new line (which would
2110 // require a comment char before it).
2111 M->getModuleIdentifier().find('\n') == std::string::npos)
2112 Out << "; ModuleID = '" << M->getModuleIdentifier() << "'\n";
2114 const std::string &DL = M->getDataLayoutStr();
2116 Out << "target datalayout = \"" << DL << "\"\n";
2117 if (!M->getTargetTriple().empty())
2118 Out << "target triple = \"" << M->getTargetTriple() << "\"\n";
2120 if (!M->getModuleInlineAsm().empty()) {
2121 // Split the string into lines, to make it easier to read the .ll file.
2122 std::string Asm = M->getModuleInlineAsm();
2124 size_t NewLine = Asm.find_first_of('\n', CurPos);
2126 while (NewLine != std::string::npos) {
2127 // We found a newline, print the portion of the asm string from the
2128 // last newline up to this newline.
2129 Out << "module asm \"";
2130 PrintEscapedString(std::string(Asm.begin()+CurPos, Asm.begin()+NewLine),
2134 NewLine = Asm.find_first_of('\n', CurPos);
2136 std::string rest(Asm.begin()+CurPos, Asm.end());
2137 if (!rest.empty()) {
2138 Out << "module asm \"";
2139 PrintEscapedString(rest, Out);
2144 printTypeIdentities();
2146 // Output all comdats.
2147 if (!Comdats.empty())
2149 for (const Comdat *C : Comdats) {
2151 if (C != Comdats.back())
2155 // Output all globals.
2156 if (!M->global_empty()) Out << '\n';
2157 for (Module::const_global_iterator I = M->global_begin(), E = M->global_end();
2159 printGlobal(I); Out << '\n';
2162 // Output all aliases.
2163 if (!M->alias_empty()) Out << "\n";
2164 for (Module::const_alias_iterator I = M->alias_begin(), E = M->alias_end();
2168 // Output global use-lists.
2169 printUseLists(nullptr);
2171 // Output all of the functions.
2172 for (Module::const_iterator I = M->begin(), E = M->end(); I != E; ++I)
2174 assert(UseListOrders.empty() && "All use-lists should have been consumed");
2176 // Output all attribute groups.
2177 if (!Machine.as_empty()) {
2179 writeAllAttributeGroups();
2182 // Output named metadata.
2183 if (!M->named_metadata_empty()) Out << '\n';
2185 for (Module::const_named_metadata_iterator I = M->named_metadata_begin(),
2186 E = M->named_metadata_end(); I != E; ++I)
2187 printNamedMDNode(I);
2190 if (!Machine.mdn_empty()) {
2196 void AssemblyWriter::printNamedMDNode(const NamedMDNode *NMD) {
2198 StringRef Name = NMD->getName();
2200 Out << "<empty name> ";
2202 if (isalpha(static_cast<unsigned char>(Name[0])) ||
2203 Name[0] == '-' || Name[0] == '$' ||
2204 Name[0] == '.' || Name[0] == '_')
2207 Out << '\\' << hexdigit(Name[0] >> 4) << hexdigit(Name[0] & 0x0F);
2208 for (unsigned i = 1, e = Name.size(); i != e; ++i) {
2209 unsigned char C = Name[i];
2210 if (isalnum(static_cast<unsigned char>(C)) || C == '-' || C == '$' ||
2211 C == '.' || C == '_')
2214 Out << '\\' << hexdigit(C >> 4) << hexdigit(C & 0x0F);
2218 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
2220 int Slot = Machine.getMetadataSlot(NMD->getOperand(i));
2230 static void PrintLinkage(GlobalValue::LinkageTypes LT,
2231 formatted_raw_ostream &Out) {
2233 case GlobalValue::ExternalLinkage: break;
2234 case GlobalValue::PrivateLinkage: Out << "private "; break;
2235 case GlobalValue::InternalLinkage: Out << "internal "; break;
2236 case GlobalValue::LinkOnceAnyLinkage: Out << "linkonce "; break;
2237 case GlobalValue::LinkOnceODRLinkage: Out << "linkonce_odr "; break;
2238 case GlobalValue::WeakAnyLinkage: Out << "weak "; break;
2239 case GlobalValue::WeakODRLinkage: Out << "weak_odr "; break;
2240 case GlobalValue::CommonLinkage: Out << "common "; break;
2241 case GlobalValue::AppendingLinkage: Out << "appending "; break;
2242 case GlobalValue::ExternalWeakLinkage: Out << "extern_weak "; break;
2243 case GlobalValue::AvailableExternallyLinkage:
2244 Out << "available_externally ";
2250 static void PrintVisibility(GlobalValue::VisibilityTypes Vis,
2251 formatted_raw_ostream &Out) {
2253 case GlobalValue::DefaultVisibility: break;
2254 case GlobalValue::HiddenVisibility: Out << "hidden "; break;
2255 case GlobalValue::ProtectedVisibility: Out << "protected "; break;
2259 static void PrintDLLStorageClass(GlobalValue::DLLStorageClassTypes SCT,
2260 formatted_raw_ostream &Out) {
2262 case GlobalValue::DefaultStorageClass: break;
2263 case GlobalValue::DLLImportStorageClass: Out << "dllimport "; break;
2264 case GlobalValue::DLLExportStorageClass: Out << "dllexport "; break;
2268 static void PrintThreadLocalModel(GlobalVariable::ThreadLocalMode TLM,
2269 formatted_raw_ostream &Out) {
2271 case GlobalVariable::NotThreadLocal:
2273 case GlobalVariable::GeneralDynamicTLSModel:
2274 Out << "thread_local ";
2276 case GlobalVariable::LocalDynamicTLSModel:
2277 Out << "thread_local(localdynamic) ";
2279 case GlobalVariable::InitialExecTLSModel:
2280 Out << "thread_local(initialexec) ";
2282 case GlobalVariable::LocalExecTLSModel:
2283 Out << "thread_local(localexec) ";
2288 static void maybePrintComdat(formatted_raw_ostream &Out,
2289 const GlobalObject &GO) {
2290 const Comdat *C = GO.getComdat();
2294 if (isa<GlobalVariable>(GO))
2298 if (GO.getName() == C->getName())
2302 PrintLLVMName(Out, C->getName(), ComdatPrefix);
2306 void AssemblyWriter::printGlobal(const GlobalVariable *GV) {
2307 if (GV->isMaterializable())
2308 Out << "; Materializable\n";
2310 WriteAsOperandInternal(Out, GV, &TypePrinter, &Machine, GV->getParent());
2313 if (!GV->hasInitializer() && GV->hasExternalLinkage())
2316 PrintLinkage(GV->getLinkage(), Out);
2317 PrintVisibility(GV->getVisibility(), Out);
2318 PrintDLLStorageClass(GV->getDLLStorageClass(), Out);
2319 PrintThreadLocalModel(GV->getThreadLocalMode(), Out);
2320 if (GV->hasUnnamedAddr())
2321 Out << "unnamed_addr ";
2323 if (unsigned AddressSpace = GV->getType()->getAddressSpace())
2324 Out << "addrspace(" << AddressSpace << ") ";
2325 if (GV->isExternallyInitialized()) Out << "externally_initialized ";
2326 Out << (GV->isConstant() ? "constant " : "global ");
2327 TypePrinter.print(GV->getType()->getElementType(), Out);
2329 if (GV->hasInitializer()) {
2331 writeOperand(GV->getInitializer(), false);
2334 if (GV->hasSection()) {
2335 Out << ", section \"";
2336 PrintEscapedString(GV->getSection(), Out);
2339 maybePrintComdat(Out, *GV);
2340 if (GV->getAlignment())
2341 Out << ", align " << GV->getAlignment();
2343 printInfoComment(*GV);
2346 void AssemblyWriter::printAlias(const GlobalAlias *GA) {
2347 if (GA->isMaterializable())
2348 Out << "; Materializable\n";
2350 // Don't crash when dumping partially built GA
2352 Out << "<<nameless>> = ";
2354 PrintLLVMName(Out, GA);
2357 PrintLinkage(GA->getLinkage(), Out);
2358 PrintVisibility(GA->getVisibility(), Out);
2359 PrintDLLStorageClass(GA->getDLLStorageClass(), Out);
2360 PrintThreadLocalModel(GA->getThreadLocalMode(), Out);
2361 if (GA->hasUnnamedAddr())
2362 Out << "unnamed_addr ";
2366 const Constant *Aliasee = GA->getAliasee();
2369 TypePrinter.print(GA->getType(), Out);
2370 Out << " <<NULL ALIASEE>>";
2372 writeOperand(Aliasee, !isa<ConstantExpr>(Aliasee));
2375 printInfoComment(*GA);
2379 void AssemblyWriter::printComdat(const Comdat *C) {
2383 void AssemblyWriter::printTypeIdentities() {
2384 if (TypePrinter.NumberedTypes.empty() &&
2385 TypePrinter.NamedTypes.empty())
2390 // We know all the numbers that each type is used and we know that it is a
2391 // dense assignment. Convert the map to an index table.
2392 std::vector<StructType*> NumberedTypes(TypePrinter.NumberedTypes.size());
2393 for (DenseMap<StructType*, unsigned>::iterator I =
2394 TypePrinter.NumberedTypes.begin(), E = TypePrinter.NumberedTypes.end();
2396 assert(I->second < NumberedTypes.size() && "Didn't get a dense numbering?");
2397 NumberedTypes[I->second] = I->first;
2400 // Emit all numbered types.
2401 for (unsigned i = 0, e = NumberedTypes.size(); i != e; ++i) {
2402 Out << '%' << i << " = type ";
2404 // Make sure we print out at least one level of the type structure, so
2405 // that we do not get %2 = type %2
2406 TypePrinter.printStructBody(NumberedTypes[i], Out);
2410 for (unsigned i = 0, e = TypePrinter.NamedTypes.size(); i != e; ++i) {
2411 PrintLLVMName(Out, TypePrinter.NamedTypes[i]->getName(), LocalPrefix);
2414 // Make sure we print out at least one level of the type structure, so
2415 // that we do not get %FILE = type %FILE
2416 TypePrinter.printStructBody(TypePrinter.NamedTypes[i], Out);
2421 /// printFunction - Print all aspects of a function.
2423 void AssemblyWriter::printFunction(const Function *F) {
2424 // Print out the return type and name.
2427 if (AnnotationWriter) AnnotationWriter->emitFunctionAnnot(F, Out);
2429 if (F->isMaterializable())
2430 Out << "; Materializable\n";
2432 const AttributeSet &Attrs = F->getAttributes();
2433 if (Attrs.hasAttributes(AttributeSet::FunctionIndex)) {
2434 AttributeSet AS = Attrs.getFnAttributes();
2435 std::string AttrStr;
2438 for (unsigned E = AS.getNumSlots(); Idx != E; ++Idx)
2439 if (AS.getSlotIndex(Idx) == AttributeSet::FunctionIndex)
2442 for (AttributeSet::iterator I = AS.begin(Idx), E = AS.end(Idx);
2444 Attribute Attr = *I;
2445 if (!Attr.isStringAttribute()) {
2446 if (!AttrStr.empty()) AttrStr += ' ';
2447 AttrStr += Attr.getAsString();
2451 if (!AttrStr.empty())
2452 Out << "; Function Attrs: " << AttrStr << '\n';
2455 if (F->isDeclaration())
2460 PrintLinkage(F->getLinkage(), Out);
2461 PrintVisibility(F->getVisibility(), Out);
2462 PrintDLLStorageClass(F->getDLLStorageClass(), Out);
2464 // Print the calling convention.
2465 if (F->getCallingConv() != CallingConv::C) {
2466 PrintCallingConv(F->getCallingConv(), Out);
2470 FunctionType *FT = F->getFunctionType();
2471 if (Attrs.hasAttributes(AttributeSet::ReturnIndex))
2472 Out << Attrs.getAsString(AttributeSet::ReturnIndex) << ' ';
2473 TypePrinter.print(F->getReturnType(), Out);
2475 WriteAsOperandInternal(Out, F, &TypePrinter, &Machine, F->getParent());
2477 Machine.incorporateFunction(F);
2479 // Loop over the arguments, printing them...
2482 if (!F->isDeclaration()) {
2483 // If this isn't a declaration, print the argument names as well.
2484 for (Function::const_arg_iterator I = F->arg_begin(), E = F->arg_end();
2486 // Insert commas as we go... the first arg doesn't get a comma
2487 if (I != F->arg_begin()) Out << ", ";
2488 printArgument(I, Attrs, Idx);
2492 // Otherwise, print the types from the function type.
2493 for (unsigned i = 0, e = FT->getNumParams(); i != e; ++i) {
2494 // Insert commas as we go... the first arg doesn't get a comma
2498 TypePrinter.print(FT->getParamType(i), Out);
2500 if (Attrs.hasAttributes(i+1))
2501 Out << ' ' << Attrs.getAsString(i+1);
2505 // Finish printing arguments...
2506 if (FT->isVarArg()) {
2507 if (FT->getNumParams()) Out << ", ";
2508 Out << "..."; // Output varargs portion of signature!
2511 if (F->hasUnnamedAddr())
2512 Out << " unnamed_addr";
2513 if (Attrs.hasAttributes(AttributeSet::FunctionIndex))
2514 Out << " #" << Machine.getAttributeGroupSlot(Attrs.getFnAttributes());
2515 if (F->hasSection()) {
2516 Out << " section \"";
2517 PrintEscapedString(F->getSection(), Out);
2520 maybePrintComdat(Out, *F);
2521 if (F->getAlignment())
2522 Out << " align " << F->getAlignment();
2524 Out << " gc \"" << F->getGC() << '"';
2525 if (F->hasPrefixData()) {
2527 writeOperand(F->getPrefixData(), true);
2529 if (F->hasPrologueData()) {
2530 Out << " prologue ";
2531 writeOperand(F->getPrologueData(), true);
2534 if (F->isDeclaration()) {
2538 // Output all of the function's basic blocks.
2539 for (Function::const_iterator I = F->begin(), E = F->end(); I != E; ++I)
2542 // Output the function's use-lists.
2548 Machine.purgeFunction();
2551 /// printArgument - This member is called for every argument that is passed into
2552 /// the function. Simply print it out
2554 void AssemblyWriter::printArgument(const Argument *Arg,
2555 AttributeSet Attrs, unsigned Idx) {
2557 TypePrinter.print(Arg->getType(), Out);
2559 // Output parameter attributes list
2560 if (Attrs.hasAttributes(Idx))
2561 Out << ' ' << Attrs.getAsString(Idx);
2563 // Output name, if available...
2564 if (Arg->hasName()) {
2566 PrintLLVMName(Out, Arg);
2570 /// printBasicBlock - This member is called for each basic block in a method.
2572 void AssemblyWriter::printBasicBlock(const BasicBlock *BB) {
2573 if (BB->hasName()) { // Print out the label if it exists...
2575 PrintLLVMName(Out, BB->getName(), LabelPrefix);
2577 } else if (!BB->use_empty()) { // Don't print block # of no uses...
2578 Out << "\n; <label>:";
2579 int Slot = Machine.getLocalSlot(BB);
2586 if (!BB->getParent()) {
2587 Out.PadToColumn(50);
2588 Out << "; Error: Block without parent!";
2589 } else if (BB != &BB->getParent()->getEntryBlock()) { // Not the entry block?
2590 // Output predecessors for the block.
2591 Out.PadToColumn(50);
2593 const_pred_iterator PI = pred_begin(BB), PE = pred_end(BB);
2596 Out << " No predecessors!";
2599 writeOperand(*PI, false);
2600 for (++PI; PI != PE; ++PI) {
2602 writeOperand(*PI, false);
2609 if (AnnotationWriter) AnnotationWriter->emitBasicBlockStartAnnot(BB, Out);
2611 // Output all of the instructions in the basic block...
2612 for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I != E; ++I) {
2613 printInstructionLine(*I);
2616 if (AnnotationWriter) AnnotationWriter->emitBasicBlockEndAnnot(BB, Out);
2619 /// printInstructionLine - Print an instruction and a newline character.
2620 void AssemblyWriter::printInstructionLine(const Instruction &I) {
2621 printInstruction(I);
2625 /// printInfoComment - Print a little comment after the instruction indicating
2626 /// which slot it occupies.
2628 void AssemblyWriter::printInfoComment(const Value &V) {
2629 if (AnnotationWriter)
2630 AnnotationWriter->printInfoComment(V, Out);
2633 // This member is called for each Instruction in a function..
2634 void AssemblyWriter::printInstruction(const Instruction &I) {
2635 if (AnnotationWriter) AnnotationWriter->emitInstructionAnnot(&I, Out);
2637 // Print out indentation for an instruction.
2640 // Print out name if it exists...
2642 PrintLLVMName(Out, &I);
2644 } else if (!I.getType()->isVoidTy()) {
2645 // Print out the def slot taken.
2646 int SlotNum = Machine.getLocalSlot(&I);
2648 Out << "<badref> = ";
2650 Out << '%' << SlotNum << " = ";
2653 if (const CallInst *CI = dyn_cast<CallInst>(&I)) {
2654 if (CI->isMustTailCall())
2656 else if (CI->isTailCall())
2660 // Print out the opcode...
2661 Out << I.getOpcodeName();
2663 // If this is an atomic load or store, print out the atomic marker.
2664 if ((isa<LoadInst>(I) && cast<LoadInst>(I).isAtomic()) ||
2665 (isa<StoreInst>(I) && cast<StoreInst>(I).isAtomic()))
2668 if (isa<AtomicCmpXchgInst>(I) && cast<AtomicCmpXchgInst>(I).isWeak())
2671 // If this is a volatile operation, print out the volatile marker.
2672 if ((isa<LoadInst>(I) && cast<LoadInst>(I).isVolatile()) ||
2673 (isa<StoreInst>(I) && cast<StoreInst>(I).isVolatile()) ||
2674 (isa<AtomicCmpXchgInst>(I) && cast<AtomicCmpXchgInst>(I).isVolatile()) ||
2675 (isa<AtomicRMWInst>(I) && cast<AtomicRMWInst>(I).isVolatile()))
2678 // Print out optimization information.
2679 WriteOptimizationInfo(Out, &I);
2681 // Print out the compare instruction predicates
2682 if (const CmpInst *CI = dyn_cast<CmpInst>(&I))
2683 Out << ' ' << getPredicateText(CI->getPredicate());
2685 // Print out the atomicrmw operation
2686 if (const AtomicRMWInst *RMWI = dyn_cast<AtomicRMWInst>(&I))
2687 writeAtomicRMWOperation(Out, RMWI->getOperation());
2689 // Print out the type of the operands...
2690 const Value *Operand = I.getNumOperands() ? I.getOperand(0) : nullptr;
2692 // Special case conditional branches to swizzle the condition out to the front
2693 if (isa<BranchInst>(I) && cast<BranchInst>(I).isConditional()) {
2694 const BranchInst &BI(cast<BranchInst>(I));
2696 writeOperand(BI.getCondition(), true);
2698 writeOperand(BI.getSuccessor(0), true);
2700 writeOperand(BI.getSuccessor(1), true);
2702 } else if (isa<SwitchInst>(I)) {
2703 const SwitchInst& SI(cast<SwitchInst>(I));
2704 // Special case switch instruction to get formatting nice and correct.
2706 writeOperand(SI.getCondition(), true);
2708 writeOperand(SI.getDefaultDest(), true);
2710 for (SwitchInst::ConstCaseIt i = SI.case_begin(), e = SI.case_end();
2713 writeOperand(i.getCaseValue(), true);
2715 writeOperand(i.getCaseSuccessor(), true);
2718 } else if (isa<IndirectBrInst>(I)) {
2719 // Special case indirectbr instruction to get formatting nice and correct.
2721 writeOperand(Operand, true);
2724 for (unsigned i = 1, e = I.getNumOperands(); i != e; ++i) {
2727 writeOperand(I.getOperand(i), true);
2730 } else if (const PHINode *PN = dyn_cast<PHINode>(&I)) {
2732 TypePrinter.print(I.getType(), Out);
2735 for (unsigned op = 0, Eop = PN->getNumIncomingValues(); op < Eop; ++op) {
2736 if (op) Out << ", ";
2738 writeOperand(PN->getIncomingValue(op), false); Out << ", ";
2739 writeOperand(PN->getIncomingBlock(op), false); Out << " ]";
2741 } else if (const ExtractValueInst *EVI = dyn_cast<ExtractValueInst>(&I)) {
2743 writeOperand(I.getOperand(0), true);
2744 for (const unsigned *i = EVI->idx_begin(), *e = EVI->idx_end(); i != e; ++i)
2746 } else if (const InsertValueInst *IVI = dyn_cast<InsertValueInst>(&I)) {
2748 writeOperand(I.getOperand(0), true); Out << ", ";
2749 writeOperand(I.getOperand(1), true);
2750 for (const unsigned *i = IVI->idx_begin(), *e = IVI->idx_end(); i != e; ++i)
2752 } else if (const LandingPadInst *LPI = dyn_cast<LandingPadInst>(&I)) {
2754 TypePrinter.print(I.getType(), Out);
2755 Out << " personality ";
2756 writeOperand(I.getOperand(0), true); Out << '\n';
2758 if (LPI->isCleanup())
2761 for (unsigned i = 0, e = LPI->getNumClauses(); i != e; ++i) {
2762 if (i != 0 || LPI->isCleanup()) Out << "\n";
2763 if (LPI->isCatch(i))
2768 writeOperand(LPI->getClause(i), true);
2770 } else if (isa<ReturnInst>(I) && !Operand) {
2772 } else if (const CallInst *CI = dyn_cast<CallInst>(&I)) {
2773 // Print the calling convention being used.
2774 if (CI->getCallingConv() != CallingConv::C) {
2776 PrintCallingConv(CI->getCallingConv(), Out);
2779 Operand = CI->getCalledValue();
2780 PointerType *PTy = cast<PointerType>(Operand->getType());
2781 FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
2782 Type *RetTy = FTy->getReturnType();
2783 const AttributeSet &PAL = CI->getAttributes();
2785 if (PAL.hasAttributes(AttributeSet::ReturnIndex))
2786 Out << ' ' << PAL.getAsString(AttributeSet::ReturnIndex);
2788 // If possible, print out the short form of the call instruction. We can
2789 // only do this if the first argument is a pointer to a nonvararg function,
2790 // and if the return type is not a pointer to a function.
2793 if (!FTy->isVarArg() &&
2794 (!RetTy->isPointerTy() ||
2795 !cast<PointerType>(RetTy)->getElementType()->isFunctionTy())) {
2796 TypePrinter.print(RetTy, Out);
2798 writeOperand(Operand, false);
2800 writeOperand(Operand, true);
2803 for (unsigned op = 0, Eop = CI->getNumArgOperands(); op < Eop; ++op) {
2806 writeParamOperand(CI->getArgOperand(op), PAL, op + 1);
2809 // Emit an ellipsis if this is a musttail call in a vararg function. This
2810 // is only to aid readability, musttail calls forward varargs by default.
2811 if (CI->isMustTailCall() && CI->getParent() &&
2812 CI->getParent()->getParent() &&
2813 CI->getParent()->getParent()->isVarArg())
2817 if (PAL.hasAttributes(AttributeSet::FunctionIndex))
2818 Out << " #" << Machine.getAttributeGroupSlot(PAL.getFnAttributes());
2819 } else if (const InvokeInst *II = dyn_cast<InvokeInst>(&I)) {
2820 Operand = II->getCalledValue();
2821 PointerType *PTy = cast<PointerType>(Operand->getType());
2822 FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
2823 Type *RetTy = FTy->getReturnType();
2824 const AttributeSet &PAL = II->getAttributes();
2826 // Print the calling convention being used.
2827 if (II->getCallingConv() != CallingConv::C) {
2829 PrintCallingConv(II->getCallingConv(), Out);
2832 if (PAL.hasAttributes(AttributeSet::ReturnIndex))
2833 Out << ' ' << PAL.getAsString(AttributeSet::ReturnIndex);
2835 // If possible, print out the short form of the invoke instruction. We can
2836 // only do this if the first argument is a pointer to a nonvararg function,
2837 // and if the return type is not a pointer to a function.
2840 if (!FTy->isVarArg() &&
2841 (!RetTy->isPointerTy() ||
2842 !cast<PointerType>(RetTy)->getElementType()->isFunctionTy())) {
2843 TypePrinter.print(RetTy, Out);
2845 writeOperand(Operand, false);
2847 writeOperand(Operand, true);
2850 for (unsigned op = 0, Eop = II->getNumArgOperands(); op < Eop; ++op) {
2853 writeParamOperand(II->getArgOperand(op), PAL, op + 1);
2857 if (PAL.hasAttributes(AttributeSet::FunctionIndex))
2858 Out << " #" << Machine.getAttributeGroupSlot(PAL.getFnAttributes());
2861 writeOperand(II->getNormalDest(), true);
2863 writeOperand(II->getUnwindDest(), true);
2865 } else if (const AllocaInst *AI = dyn_cast<AllocaInst>(&I)) {
2867 if (AI->isUsedWithInAlloca())
2869 TypePrinter.print(AI->getAllocatedType(), Out);
2871 // Explicitly write the array size if the code is broken, if it's an array
2872 // allocation, or if the type is not canonical for scalar allocations. The
2873 // latter case prevents the type from mutating when round-tripping through
2875 if (!AI->getArraySize() || AI->isArrayAllocation() ||
2876 !AI->getArraySize()->getType()->isIntegerTy(32)) {
2878 writeOperand(AI->getArraySize(), true);
2880 if (AI->getAlignment()) {
2881 Out << ", align " << AI->getAlignment();
2883 } else if (isa<CastInst>(I)) {
2886 writeOperand(Operand, true); // Work with broken code
2889 TypePrinter.print(I.getType(), Out);
2890 } else if (isa<VAArgInst>(I)) {
2893 writeOperand(Operand, true); // Work with broken code
2896 TypePrinter.print(I.getType(), Out);
2897 } else if (Operand) { // Print the normal way.
2898 if (const auto *GEP = dyn_cast<GetElementPtrInst>(&I)) {
2900 TypePrinter.print(GEP->getSourceElementType(), Out);
2902 } else if (const auto *LI = dyn_cast<LoadInst>(&I)) {
2904 TypePrinter.print(LI->getType(), Out);
2908 // PrintAllTypes - Instructions who have operands of all the same type
2909 // omit the type from all but the first operand. If the instruction has
2910 // different type operands (for example br), then they are all printed.
2911 bool PrintAllTypes = false;
2912 Type *TheType = Operand->getType();
2914 // Select, Store and ShuffleVector always print all types.
2915 if (isa<SelectInst>(I) || isa<StoreInst>(I) || isa<ShuffleVectorInst>(I)
2916 || isa<ReturnInst>(I)) {
2917 PrintAllTypes = true;
2919 for (unsigned i = 1, E = I.getNumOperands(); i != E; ++i) {
2920 Operand = I.getOperand(i);
2921 // note that Operand shouldn't be null, but the test helps make dump()
2922 // more tolerant of malformed IR
2923 if (Operand && Operand->getType() != TheType) {
2924 PrintAllTypes = true; // We have differing types! Print them all!
2930 if (!PrintAllTypes) {
2932 TypePrinter.print(TheType, Out);
2936 for (unsigned i = 0, E = I.getNumOperands(); i != E; ++i) {
2938 writeOperand(I.getOperand(i), PrintAllTypes);
2942 // Print atomic ordering/alignment for memory operations
2943 if (const LoadInst *LI = dyn_cast<LoadInst>(&I)) {
2945 writeAtomic(LI->getOrdering(), LI->getSynchScope());
2946 if (LI->getAlignment())
2947 Out << ", align " << LI->getAlignment();
2948 } else if (const StoreInst *SI = dyn_cast<StoreInst>(&I)) {
2950 writeAtomic(SI->getOrdering(), SI->getSynchScope());
2951 if (SI->getAlignment())
2952 Out << ", align " << SI->getAlignment();
2953 } else if (const AtomicCmpXchgInst *CXI = dyn_cast<AtomicCmpXchgInst>(&I)) {
2954 writeAtomicCmpXchg(CXI->getSuccessOrdering(), CXI->getFailureOrdering(),
2955 CXI->getSynchScope());
2956 } else if (const AtomicRMWInst *RMWI = dyn_cast<AtomicRMWInst>(&I)) {
2957 writeAtomic(RMWI->getOrdering(), RMWI->getSynchScope());
2958 } else if (const FenceInst *FI = dyn_cast<FenceInst>(&I)) {
2959 writeAtomic(FI->getOrdering(), FI->getSynchScope());
2962 // Print Metadata info.
2963 SmallVector<std::pair<unsigned, MDNode *>, 4> InstMD;
2964 I.getAllMetadata(InstMD);
2965 if (!InstMD.empty()) {
2966 SmallVector<StringRef, 8> MDNames;
2967 I.getType()->getContext().getMDKindNames(MDNames);
2968 for (unsigned i = 0, e = InstMD.size(); i != e; ++i) {
2969 unsigned Kind = InstMD[i].first;
2970 if (Kind < MDNames.size()) {
2971 Out << ", !" << MDNames[Kind];
2973 Out << ", !<unknown kind #" << Kind << ">";
2976 WriteAsOperandInternal(Out, InstMD[i].second, &TypePrinter, &Machine,
2980 printInfoComment(I);
2983 void AssemblyWriter::writeMDNode(unsigned Slot, const MDNode *Node) {
2984 Out << '!' << Slot << " = ";
2985 printMDNodeBody(Node);
2989 void AssemblyWriter::writeAllMDNodes() {
2990 SmallVector<const MDNode *, 16> Nodes;
2991 Nodes.resize(Machine.mdn_size());
2992 for (SlotTracker::mdn_iterator I = Machine.mdn_begin(), E = Machine.mdn_end();
2994 Nodes[I->second] = cast<MDNode>(I->first);
2996 for (unsigned i = 0, e = Nodes.size(); i != e; ++i) {
2997 writeMDNode(i, Nodes[i]);
3001 void AssemblyWriter::printMDNodeBody(const MDNode *Node) {
3002 WriteMDNodeBodyInternal(Out, Node, &TypePrinter, &Machine, TheModule);
3005 void AssemblyWriter::writeAllAttributeGroups() {
3006 std::vector<std::pair<AttributeSet, unsigned> > asVec;
3007 asVec.resize(Machine.as_size());
3009 for (SlotTracker::as_iterator I = Machine.as_begin(), E = Machine.as_end();
3011 asVec[I->second] = *I;
3013 for (std::vector<std::pair<AttributeSet, unsigned> >::iterator
3014 I = asVec.begin(), E = asVec.end(); I != E; ++I)
3015 Out << "attributes #" << I->second << " = { "
3016 << I->first.getAsString(AttributeSet::FunctionIndex, true) << " }\n";
3019 void AssemblyWriter::printUseListOrder(const UseListOrder &Order) {
3020 bool IsInFunction = Machine.getFunction();
3024 Out << "uselistorder";
3025 if (const BasicBlock *BB =
3026 IsInFunction ? nullptr : dyn_cast<BasicBlock>(Order.V)) {
3028 writeOperand(BB->getParent(), false);
3030 writeOperand(BB, false);
3033 writeOperand(Order.V, true);
3037 assert(Order.Shuffle.size() >= 2 && "Shuffle too small");
3038 Out << Order.Shuffle[0];
3039 for (unsigned I = 1, E = Order.Shuffle.size(); I != E; ++I)
3040 Out << ", " << Order.Shuffle[I];
3044 void AssemblyWriter::printUseLists(const Function *F) {
3046 [&]() { return !UseListOrders.empty() && UseListOrders.back().F == F; };
3051 Out << "\n; uselistorder directives\n";
3053 printUseListOrder(UseListOrders.back());
3054 UseListOrders.pop_back();
3058 //===----------------------------------------------------------------------===//
3059 // External Interface declarations
3060 //===----------------------------------------------------------------------===//
3062 void Module::print(raw_ostream &ROS, AssemblyAnnotationWriter *AAW) const {
3063 SlotTracker SlotTable(this);
3064 formatted_raw_ostream OS(ROS);
3065 AssemblyWriter W(OS, SlotTable, this, AAW);
3066 W.printModule(this);
3069 void NamedMDNode::print(raw_ostream &ROS) const {
3070 SlotTracker SlotTable(getParent());
3071 formatted_raw_ostream OS(ROS);
3072 AssemblyWriter W(OS, SlotTable, getParent(), nullptr);
3073 W.printNamedMDNode(this);
3076 void Comdat::print(raw_ostream &ROS) const {
3077 PrintLLVMName(ROS, getName(), ComdatPrefix);
3078 ROS << " = comdat ";
3080 switch (getSelectionKind()) {
3084 case Comdat::ExactMatch:
3085 ROS << "exactmatch";
3087 case Comdat::Largest:
3090 case Comdat::NoDuplicates:
3091 ROS << "noduplicates";
3093 case Comdat::SameSize:
3101 void Type::print(raw_ostream &OS) const {
3103 TP.print(const_cast<Type*>(this), OS);
3105 // If the type is a named struct type, print the body as well.
3106 if (StructType *STy = dyn_cast<StructType>(const_cast<Type*>(this)))
3107 if (!STy->isLiteral()) {
3109 TP.printStructBody(STy, OS);
3113 static bool isReferencingMDNode(const Instruction &I) {
3114 if (const auto *CI = dyn_cast<CallInst>(&I))
3115 if (Function *F = CI->getCalledFunction())
3116 if (F->isIntrinsic())
3117 for (auto &Op : I.operands())
3118 if (auto *V = dyn_cast_or_null<MetadataAsValue>(Op))
3119 if (isa<MDNode>(V->getMetadata()))
3124 void Value::print(raw_ostream &ROS) const {
3125 formatted_raw_ostream OS(ROS);
3126 if (const Instruction *I = dyn_cast<Instruction>(this)) {
3127 const Function *F = I->getParent() ? I->getParent()->getParent() : nullptr;
3128 SlotTracker SlotTable(
3130 /* ShouldInitializeAllMetadata */ isReferencingMDNode(*I));
3131 AssemblyWriter W(OS, SlotTable, getModuleFromVal(I), nullptr);
3132 W.printInstruction(*I);
3133 } else if (const BasicBlock *BB = dyn_cast<BasicBlock>(this)) {
3134 SlotTracker SlotTable(BB->getParent());
3135 AssemblyWriter W(OS, SlotTable, getModuleFromVal(BB), nullptr);
3136 W.printBasicBlock(BB);
3137 } else if (const GlobalValue *GV = dyn_cast<GlobalValue>(this)) {
3138 SlotTracker SlotTable(GV->getParent(),
3139 /* ShouldInitializeAllMetadata */ isa<Function>(GV));
3140 AssemblyWriter W(OS, SlotTable, GV->getParent(), nullptr);
3141 if (const GlobalVariable *V = dyn_cast<GlobalVariable>(GV))
3143 else if (const Function *F = dyn_cast<Function>(GV))
3146 W.printAlias(cast<GlobalAlias>(GV));
3147 } else if (const MetadataAsValue *V = dyn_cast<MetadataAsValue>(this)) {
3148 V->getMetadata()->print(ROS, getModuleFromVal(V));
3149 } else if (const Constant *C = dyn_cast<Constant>(this)) {
3150 TypePrinting TypePrinter;
3151 TypePrinter.print(C->getType(), OS);
3153 WriteConstantInternal(OS, C, TypePrinter, nullptr, nullptr);
3154 } else if (isa<InlineAsm>(this) || isa<Argument>(this)) {
3155 this->printAsOperand(OS);
3157 llvm_unreachable("Unknown value to print out!");
3161 void Value::printAsOperand(raw_ostream &O, bool PrintType, const Module *M) const {
3162 // Fast path: Don't construct and populate a TypePrinting object if we
3163 // won't be needing any types printed.
3164 bool IsMetadata = isa<MetadataAsValue>(this);
3165 if (!PrintType && ((!isa<Constant>(this) && !IsMetadata) || hasName() ||
3166 isa<GlobalValue>(this))) {
3167 WriteAsOperandInternal(O, this, nullptr, nullptr, M);
3172 M = getModuleFromVal(this);
3174 TypePrinting TypePrinter;
3176 TypePrinter.incorporateTypes(*M);
3178 TypePrinter.print(getType(), O);
3182 SlotTracker Machine(M, /* ShouldInitializeAllMetadata */ IsMetadata);
3183 WriteAsOperandInternal(O, this, &TypePrinter, &Machine, M);
3186 static void printMetadataImpl(raw_ostream &ROS, const Metadata &MD,
3187 const Module *M, bool OnlyAsOperand) {
3188 formatted_raw_ostream OS(ROS);
3190 auto *N = dyn_cast<MDNode>(&MD);
3191 TypePrinting TypePrinter;
3192 SlotTracker Machine(M, /* ShouldInitializeAllMetadata */ N);
3194 TypePrinter.incorporateTypes(*M);
3196 WriteAsOperandInternal(OS, &MD, &TypePrinter, &Machine, M,
3197 /* FromValue */ true);
3198 if (OnlyAsOperand || !N)
3202 WriteMDNodeBodyInternal(OS, N, &TypePrinter, &Machine, M);
3205 void Metadata::printAsOperand(raw_ostream &OS, const Module *M) const {
3206 printMetadataImpl(OS, *this, M, /* OnlyAsOperand */ true);
3209 void Metadata::print(raw_ostream &OS, const Module *M) const {
3210 printMetadataImpl(OS, *this, M, /* OnlyAsOperand */ false);
3213 // Value::dump - allow easy printing of Values from the debugger.
3215 void Value::dump() const { print(dbgs()); dbgs() << '\n'; }
3217 // Type::dump - allow easy printing of Types from the debugger.
3219 void Type::dump() const { print(dbgs()); dbgs() << '\n'; }
3221 // Module::dump() - Allow printing of Modules from the debugger.
3223 void Module::dump() const { print(dbgs(), nullptr); }
3225 // \brief Allow printing of Comdats from the debugger.
3227 void Comdat::dump() const { print(dbgs()); }
3229 // NamedMDNode::dump() - Allow printing of NamedMDNodes from the debugger.
3231 void NamedMDNode::dump() const { print(dbgs()); }
3234 void Metadata::dump() const { dump(nullptr); }
3237 void Metadata::dump(const Module *M) const {