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"
46 // Make virtual table appear in this compilation unit.
47 AssemblyAnnotationWriter::~AssemblyAnnotationWriter() {}
49 //===----------------------------------------------------------------------===//
51 //===----------------------------------------------------------------------===//
55 DenseMap<const Value *, std::pair<unsigned, bool>> IDs;
57 unsigned size() const { return IDs.size(); }
58 std::pair<unsigned, bool> &operator[](const Value *V) { return IDs[V]; }
59 std::pair<unsigned, bool> lookup(const Value *V) const {
62 void index(const Value *V) {
63 // Explicitly sequence get-size and insert-value operations to avoid UB.
64 unsigned ID = IDs.size() + 1;
70 static void orderValue(const Value *V, OrderMap &OM) {
71 if (OM.lookup(V).first)
74 if (const Constant *C = dyn_cast<Constant>(V))
75 if (C->getNumOperands() && !isa<GlobalValue>(C))
76 for (const Value *Op : C->operands())
77 if (!isa<BasicBlock>(Op) && !isa<GlobalValue>(Op))
80 // Note: we cannot cache this lookup above, since inserting into the map
81 // changes the map's size, and thus affects the other IDs.
85 static OrderMap orderModule(const Module *M) {
86 // This needs to match the order used by ValueEnumerator::ValueEnumerator()
87 // and ValueEnumerator::incorporateFunction().
90 for (const GlobalVariable &G : M->globals()) {
91 if (G.hasInitializer())
92 if (!isa<GlobalValue>(G.getInitializer()))
93 orderValue(G.getInitializer(), OM);
96 for (const GlobalAlias &A : M->aliases()) {
97 if (!isa<GlobalValue>(A.getAliasee()))
98 orderValue(A.getAliasee(), OM);
101 for (const Function &F : *M) {
102 if (F.hasPrefixData())
103 if (!isa<GlobalValue>(F.getPrefixData()))
104 orderValue(F.getPrefixData(), OM);
106 if (F.hasPrologueData())
107 if (!isa<GlobalValue>(F.getPrologueData()))
108 orderValue(F.getPrologueData(), OM);
112 if (F.isDeclaration())
115 for (const Argument &A : F.args())
117 for (const BasicBlock &BB : F) {
119 for (const Instruction &I : BB) {
120 for (const Value *Op : I.operands())
121 if ((isa<Constant>(*Op) && !isa<GlobalValue>(*Op)) ||
131 static void predictValueUseListOrderImpl(const Value *V, const Function *F,
132 unsigned ID, const OrderMap &OM,
133 UseListOrderStack &Stack) {
134 // Predict use-list order for this one.
135 typedef std::pair<const Use *, unsigned> Entry;
136 SmallVector<Entry, 64> List;
137 for (const Use &U : V->uses())
138 // Check if this user will be serialized.
139 if (OM.lookup(U.getUser()).first)
140 List.push_back(std::make_pair(&U, List.size()));
143 // We may have lost some users.
147 !isa<GlobalVariable>(V) && !isa<Function>(V) && !isa<BasicBlock>(V);
148 if (auto *BA = dyn_cast<BlockAddress>(V))
149 ID = OM.lookup(BA->getBasicBlock()).first;
150 std::sort(List.begin(), List.end(), [&](const Entry &L, const Entry &R) {
151 const Use *LU = L.first;
152 const Use *RU = R.first;
156 auto LID = OM.lookup(LU->getUser()).first;
157 auto RID = OM.lookup(RU->getUser()).first;
159 // If ID is 4, then expect: 7 6 5 1 2 3.
173 // LID and RID are equal, so we have different operands of the same user.
174 // Assume operands are added in order for all instructions.
177 return LU->getOperandNo() < RU->getOperandNo();
178 return LU->getOperandNo() > RU->getOperandNo();
182 List.begin(), List.end(),
183 [](const Entry &L, const Entry &R) { return L.second < R.second; }))
184 // Order is already correct.
187 // Store the shuffle.
188 Stack.emplace_back(V, F, List.size());
189 assert(List.size() == Stack.back().Shuffle.size() && "Wrong size");
190 for (size_t I = 0, E = List.size(); I != E; ++I)
191 Stack.back().Shuffle[I] = List[I].second;
194 static void predictValueUseListOrder(const Value *V, const Function *F,
195 OrderMap &OM, UseListOrderStack &Stack) {
196 auto &IDPair = OM[V];
197 assert(IDPair.first && "Unmapped value");
199 // Already predicted.
202 // Do the actual prediction.
203 IDPair.second = true;
204 if (!V->use_empty() && std::next(V->use_begin()) != V->use_end())
205 predictValueUseListOrderImpl(V, F, IDPair.first, OM, Stack);
207 // Recursive descent into constants.
208 if (const Constant *C = dyn_cast<Constant>(V))
209 if (C->getNumOperands()) // Visit GlobalValues.
210 for (const Value *Op : C->operands())
211 if (isa<Constant>(Op)) // Visit GlobalValues.
212 predictValueUseListOrder(Op, F, OM, Stack);
215 static UseListOrderStack predictUseListOrder(const Module *M) {
216 OrderMap OM = orderModule(M);
218 // Use-list orders need to be serialized after all the users have been added
219 // to a value, or else the shuffles will be incomplete. Store them per
220 // function in a stack.
222 // Aside from function order, the order of values doesn't matter much here.
223 UseListOrderStack Stack;
225 // We want to visit the functions backward now so we can list function-local
226 // constants in the last Function they're used in. Module-level constants
227 // have already been visited above.
228 for (auto I = M->rbegin(), E = M->rend(); I != E; ++I) {
229 const Function &F = *I;
230 if (F.isDeclaration())
232 for (const BasicBlock &BB : F)
233 predictValueUseListOrder(&BB, &F, OM, Stack);
234 for (const Argument &A : F.args())
235 predictValueUseListOrder(&A, &F, OM, Stack);
236 for (const BasicBlock &BB : F)
237 for (const Instruction &I : BB)
238 for (const Value *Op : I.operands())
239 if (isa<Constant>(*Op) || isa<InlineAsm>(*Op)) // Visit GlobalValues.
240 predictValueUseListOrder(Op, &F, OM, Stack);
241 for (const BasicBlock &BB : F)
242 for (const Instruction &I : BB)
243 predictValueUseListOrder(&I, &F, OM, Stack);
246 // Visit globals last.
247 for (const GlobalVariable &G : M->globals())
248 predictValueUseListOrder(&G, nullptr, OM, Stack);
249 for (const Function &F : *M)
250 predictValueUseListOrder(&F, nullptr, OM, Stack);
251 for (const GlobalAlias &A : M->aliases())
252 predictValueUseListOrder(&A, nullptr, OM, Stack);
253 for (const GlobalVariable &G : M->globals())
254 if (G.hasInitializer())
255 predictValueUseListOrder(G.getInitializer(), nullptr, OM, Stack);
256 for (const GlobalAlias &A : M->aliases())
257 predictValueUseListOrder(A.getAliasee(), nullptr, OM, Stack);
258 for (const Function &F : *M)
259 if (F.hasPrefixData())
260 predictValueUseListOrder(F.getPrefixData(), nullptr, OM, Stack);
265 static const Module *getModuleFromVal(const Value *V) {
266 if (const Argument *MA = dyn_cast<Argument>(V))
267 return MA->getParent() ? MA->getParent()->getParent() : nullptr;
269 if (const BasicBlock *BB = dyn_cast<BasicBlock>(V))
270 return BB->getParent() ? BB->getParent()->getParent() : nullptr;
272 if (const Instruction *I = dyn_cast<Instruction>(V)) {
273 const Function *M = I->getParent() ? I->getParent()->getParent() : nullptr;
274 return M ? M->getParent() : nullptr;
277 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V))
278 return GV->getParent();
280 if (const auto *MAV = dyn_cast<MetadataAsValue>(V)) {
281 for (const User *U : MAV->users())
282 if (isa<Instruction>(U))
283 if (const Module *M = getModuleFromVal(U))
291 static void PrintCallingConv(unsigned cc, raw_ostream &Out) {
293 default: Out << "cc" << cc; break;
294 case CallingConv::Fast: Out << "fastcc"; break;
295 case CallingConv::Cold: Out << "coldcc"; break;
296 case CallingConv::WebKit_JS: Out << "webkit_jscc"; break;
297 case CallingConv::AnyReg: Out << "anyregcc"; break;
298 case CallingConv::PreserveMost: Out << "preserve_mostcc"; break;
299 case CallingConv::PreserveAll: Out << "preserve_allcc"; break;
300 case CallingConv::GHC: Out << "ghccc"; break;
301 case CallingConv::X86_StdCall: Out << "x86_stdcallcc"; break;
302 case CallingConv::X86_FastCall: Out << "x86_fastcallcc"; break;
303 case CallingConv::X86_ThisCall: Out << "x86_thiscallcc"; break;
304 case CallingConv::X86_VectorCall:Out << "x86_vectorcallcc"; break;
305 case CallingConv::Intel_OCL_BI: Out << "intel_ocl_bicc"; break;
306 case CallingConv::ARM_APCS: Out << "arm_apcscc"; break;
307 case CallingConv::ARM_AAPCS: Out << "arm_aapcscc"; break;
308 case CallingConv::ARM_AAPCS_VFP: Out << "arm_aapcs_vfpcc"; break;
309 case CallingConv::MSP430_INTR: Out << "msp430_intrcc"; break;
310 case CallingConv::PTX_Kernel: Out << "ptx_kernel"; break;
311 case CallingConv::PTX_Device: Out << "ptx_device"; break;
312 case CallingConv::X86_64_SysV: Out << "x86_64_sysvcc"; break;
313 case CallingConv::X86_64_Win64: Out << "x86_64_win64cc"; break;
314 case CallingConv::SPIR_FUNC: Out << "spir_func"; break;
315 case CallingConv::SPIR_KERNEL: Out << "spir_kernel"; break;
319 // PrintEscapedString - Print each character of the specified string, escaping
320 // it if it is not printable or if it is an escape char.
321 static void PrintEscapedString(StringRef Name, raw_ostream &Out) {
322 for (unsigned i = 0, e = Name.size(); i != e; ++i) {
323 unsigned char C = Name[i];
324 if (isprint(C) && C != '\\' && C != '"')
327 Out << '\\' << hexdigit(C >> 4) << hexdigit(C & 0x0F);
339 /// PrintLLVMName - Turn the specified name into an 'LLVM name', which is either
340 /// prefixed with % (if the string only contains simple characters) or is
341 /// surrounded with ""'s (if it has special chars in it). Print it out.
342 static void PrintLLVMName(raw_ostream &OS, StringRef Name, PrefixType Prefix) {
343 assert(!Name.empty() && "Cannot get empty name!");
345 case NoPrefix: break;
346 case GlobalPrefix: OS << '@'; break;
347 case ComdatPrefix: OS << '$'; break;
348 case LabelPrefix: break;
349 case LocalPrefix: OS << '%'; break;
352 // Scan the name to see if it needs quotes first.
353 bool NeedsQuotes = isdigit(static_cast<unsigned char>(Name[0]));
355 for (unsigned i = 0, e = Name.size(); i != e; ++i) {
356 // By making this unsigned, the value passed in to isalnum will always be
357 // in the range 0-255. This is important when building with MSVC because
358 // its implementation will assert. This situation can arise when dealing
359 // with UTF-8 multibyte characters.
360 unsigned char C = Name[i];
361 if (!isalnum(static_cast<unsigned char>(C)) && C != '-' && C != '.' &&
369 // If we didn't need any quotes, just write out the name in one blast.
375 // Okay, we need quotes. Output the quotes and escape any scary characters as
378 PrintEscapedString(Name, OS);
382 /// PrintLLVMName - Turn the specified name into an 'LLVM name', which is either
383 /// prefixed with % (if the string only contains simple characters) or is
384 /// surrounded with ""'s (if it has special chars in it). Print it out.
385 static void PrintLLVMName(raw_ostream &OS, const Value *V) {
386 PrintLLVMName(OS, V->getName(),
387 isa<GlobalValue>(V) ? GlobalPrefix : LocalPrefix);
393 TypePrinting(const TypePrinting &) = delete;
394 void operator=(const TypePrinting&) = delete;
397 /// NamedTypes - The named types that are used by the current module.
398 TypeFinder NamedTypes;
400 /// NumberedTypes - The numbered types, along with their value.
401 DenseMap<StructType*, unsigned> NumberedTypes;
407 void incorporateTypes(const Module &M);
409 void print(Type *Ty, raw_ostream &OS);
411 void printStructBody(StructType *Ty, raw_ostream &OS);
415 void TypePrinting::incorporateTypes(const Module &M) {
416 NamedTypes.run(M, false);
418 // The list of struct types we got back includes all the struct types, split
419 // the unnamed ones out to a numbering and remove the anonymous structs.
420 unsigned NextNumber = 0;
422 std::vector<StructType*>::iterator NextToUse = NamedTypes.begin(), I, E;
423 for (I = NamedTypes.begin(), E = NamedTypes.end(); I != E; ++I) {
424 StructType *STy = *I;
426 // Ignore anonymous types.
427 if (STy->isLiteral())
430 if (STy->getName().empty())
431 NumberedTypes[STy] = NextNumber++;
436 NamedTypes.erase(NextToUse, NamedTypes.end());
440 /// CalcTypeName - Write the specified type to the specified raw_ostream, making
441 /// use of type names or up references to shorten the type name where possible.
442 void TypePrinting::print(Type *Ty, raw_ostream &OS) {
443 switch (Ty->getTypeID()) {
444 case Type::VoidTyID: OS << "void"; return;
445 case Type::HalfTyID: OS << "half"; return;
446 case Type::FloatTyID: OS << "float"; return;
447 case Type::DoubleTyID: OS << "double"; return;
448 case Type::X86_FP80TyID: OS << "x86_fp80"; return;
449 case Type::FP128TyID: OS << "fp128"; return;
450 case Type::PPC_FP128TyID: OS << "ppc_fp128"; return;
451 case Type::LabelTyID: OS << "label"; return;
452 case Type::MetadataTyID: OS << "metadata"; return;
453 case Type::X86_MMXTyID: OS << "x86_mmx"; return;
454 case Type::IntegerTyID:
455 OS << 'i' << cast<IntegerType>(Ty)->getBitWidth();
458 case Type::FunctionTyID: {
459 FunctionType *FTy = cast<FunctionType>(Ty);
460 print(FTy->getReturnType(), OS);
462 for (FunctionType::param_iterator I = FTy->param_begin(),
463 E = FTy->param_end(); I != E; ++I) {
464 if (I != FTy->param_begin())
468 if (FTy->isVarArg()) {
469 if (FTy->getNumParams()) OS << ", ";
475 case Type::StructTyID: {
476 StructType *STy = cast<StructType>(Ty);
478 if (STy->isLiteral())
479 return printStructBody(STy, OS);
481 if (!STy->getName().empty())
482 return PrintLLVMName(OS, STy->getName(), LocalPrefix);
484 DenseMap<StructType*, unsigned>::iterator I = NumberedTypes.find(STy);
485 if (I != NumberedTypes.end())
486 OS << '%' << I->second;
487 else // Not enumerated, print the hex address.
488 OS << "%\"type " << STy << '\"';
491 case Type::PointerTyID: {
492 PointerType *PTy = cast<PointerType>(Ty);
493 print(PTy->getElementType(), OS);
494 if (unsigned AddressSpace = PTy->getAddressSpace())
495 OS << " addrspace(" << AddressSpace << ')';
499 case Type::ArrayTyID: {
500 ArrayType *ATy = cast<ArrayType>(Ty);
501 OS << '[' << ATy->getNumElements() << " x ";
502 print(ATy->getElementType(), OS);
506 case Type::VectorTyID: {
507 VectorType *PTy = cast<VectorType>(Ty);
508 OS << "<" << PTy->getNumElements() << " x ";
509 print(PTy->getElementType(), OS);
514 llvm_unreachable("Invalid TypeID");
517 void TypePrinting::printStructBody(StructType *STy, raw_ostream &OS) {
518 if (STy->isOpaque()) {
526 if (STy->getNumElements() == 0) {
529 StructType::element_iterator I = STy->element_begin();
532 for (StructType::element_iterator E = STy->element_end(); I != E; ++I) {
544 //===----------------------------------------------------------------------===//
545 // SlotTracker Class: Enumerate slot numbers for unnamed values
546 //===----------------------------------------------------------------------===//
547 /// This class provides computation of slot numbers for LLVM Assembly writing.
551 /// ValueMap - A mapping of Values to slot numbers.
552 typedef DenseMap<const Value*, unsigned> ValueMap;
555 /// TheModule - The module for which we are holding slot numbers.
556 const Module* TheModule;
558 /// TheFunction - The function for which we are holding slot numbers.
559 const Function* TheFunction;
560 bool FunctionProcessed;
561 bool ShouldInitializeAllMetadata;
563 /// mMap - The slot map for the module level data.
567 /// fMap - The slot map for the function level data.
571 /// mdnMap - Map for MDNodes.
572 DenseMap<const MDNode*, unsigned> mdnMap;
575 /// asMap - The slot map for attribute sets.
576 DenseMap<AttributeSet, unsigned> asMap;
579 /// Construct from a module.
581 /// If \c ShouldInitializeAllMetadata, initializes all metadata in all
582 /// functions, giving correct numbering for metadata referenced only from
583 /// within a function (even if no functions have been initialized).
584 explicit SlotTracker(const Module *M,
585 bool ShouldInitializeAllMetadata = false);
586 /// Construct from a function, starting out in incorp state.
588 /// If \c ShouldInitializeAllMetadata, initializes all metadata in all
589 /// functions, giving correct numbering for metadata referenced only from
590 /// within a function (even if no functions have been initialized).
591 explicit SlotTracker(const Function *F,
592 bool ShouldInitializeAllMetadata = false);
594 /// Return the slot number of the specified value in it's type
595 /// plane. If something is not in the SlotTracker, return -1.
596 int getLocalSlot(const Value *V);
597 int getGlobalSlot(const GlobalValue *V);
598 int getMetadataSlot(const MDNode *N);
599 int getAttributeGroupSlot(AttributeSet AS);
601 /// If you'd like to deal with a function instead of just a module, use
602 /// this method to get its data into the SlotTracker.
603 void incorporateFunction(const Function *F) {
605 FunctionProcessed = false;
608 const Function *getFunction() const { return TheFunction; }
610 /// After calling incorporateFunction, use this method to remove the
611 /// most recently incorporated function from the SlotTracker. This
612 /// will reset the state of the machine back to just the module contents.
613 void purgeFunction();
615 /// MDNode map iterators.
616 typedef DenseMap<const MDNode*, unsigned>::iterator mdn_iterator;
617 mdn_iterator mdn_begin() { return mdnMap.begin(); }
618 mdn_iterator mdn_end() { return mdnMap.end(); }
619 unsigned mdn_size() const { return mdnMap.size(); }
620 bool mdn_empty() const { return mdnMap.empty(); }
622 /// AttributeSet map iterators.
623 typedef DenseMap<AttributeSet, unsigned>::iterator as_iterator;
624 as_iterator as_begin() { return asMap.begin(); }
625 as_iterator as_end() { return asMap.end(); }
626 unsigned as_size() const { return asMap.size(); }
627 bool as_empty() const { return asMap.empty(); }
629 /// This function does the actual initialization.
630 inline void initialize();
632 // Implementation Details
634 /// CreateModuleSlot - Insert the specified GlobalValue* into the slot table.
635 void CreateModuleSlot(const GlobalValue *V);
637 /// CreateMetadataSlot - Insert the specified MDNode* into the slot table.
638 void CreateMetadataSlot(const MDNode *N);
640 /// CreateFunctionSlot - Insert the specified Value* into the slot table.
641 void CreateFunctionSlot(const Value *V);
643 /// \brief Insert the specified AttributeSet into the slot table.
644 void CreateAttributeSetSlot(AttributeSet AS);
646 /// Add all of the module level global variables (and their initializers)
647 /// and function declarations, but not the contents of those functions.
648 void processModule();
650 /// Add all of the functions arguments, basic blocks, and instructions.
651 void processFunction();
653 /// Add all of the metadata from a function.
654 void processFunctionMetadata(const Function &F);
656 /// Add all of the metadata from an instruction.
657 void processInstructionMetadata(const Instruction &I);
659 SlotTracker(const SlotTracker &) = delete;
660 void operator=(const SlotTracker &) = delete;
664 static SlotTracker *createSlotTracker(const Module *M) {
665 return new SlotTracker(M);
668 static SlotTracker *createSlotTracker(const Value *V) {
669 if (const Argument *FA = dyn_cast<Argument>(V))
670 return new SlotTracker(FA->getParent());
672 if (const Instruction *I = dyn_cast<Instruction>(V))
674 return new SlotTracker(I->getParent()->getParent());
676 if (const BasicBlock *BB = dyn_cast<BasicBlock>(V))
677 return new SlotTracker(BB->getParent());
679 if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(V))
680 return new SlotTracker(GV->getParent());
682 if (const GlobalAlias *GA = dyn_cast<GlobalAlias>(V))
683 return new SlotTracker(GA->getParent());
685 if (const Function *Func = dyn_cast<Function>(V))
686 return new SlotTracker(Func);
692 #define ST_DEBUG(X) dbgs() << X
697 // Module level constructor. Causes the contents of the Module (sans functions)
698 // to be added to the slot table.
699 SlotTracker::SlotTracker(const Module *M, bool ShouldInitializeAllMetadata)
700 : TheModule(M), TheFunction(nullptr), FunctionProcessed(false),
701 ShouldInitializeAllMetadata(ShouldInitializeAllMetadata), mNext(0),
702 fNext(0), mdnNext(0), asNext(0) {}
704 // Function level constructor. Causes the contents of the Module and the one
705 // function provided to be added to the slot table.
706 SlotTracker::SlotTracker(const Function *F, bool ShouldInitializeAllMetadata)
707 : TheModule(F ? F->getParent() : nullptr), TheFunction(F),
708 FunctionProcessed(false),
709 ShouldInitializeAllMetadata(ShouldInitializeAllMetadata), mNext(0),
710 fNext(0), mdnNext(0), asNext(0) {}
712 inline void SlotTracker::initialize() {
715 TheModule = nullptr; ///< Prevent re-processing next time we're called.
718 if (TheFunction && !FunctionProcessed)
722 // Iterate through all the global variables, functions, and global
723 // variable initializers and create slots for them.
724 void SlotTracker::processModule() {
725 ST_DEBUG("begin processModule!\n");
727 // Add all of the unnamed global variables to the value table.
728 for (Module::const_global_iterator I = TheModule->global_begin(),
729 E = TheModule->global_end(); I != E; ++I) {
734 // Add metadata used by named metadata.
735 for (Module::const_named_metadata_iterator
736 I = TheModule->named_metadata_begin(),
737 E = TheModule->named_metadata_end(); I != E; ++I) {
738 const NamedMDNode *NMD = I;
739 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i)
740 CreateMetadataSlot(NMD->getOperand(i));
743 for (Module::const_iterator I = TheModule->begin(), E = TheModule->end();
746 // Add all the unnamed functions to the table.
749 if (ShouldInitializeAllMetadata)
750 processFunctionMetadata(*I);
752 // Add all the function attributes to the table.
753 // FIXME: Add attributes of other objects?
754 AttributeSet FnAttrs = I->getAttributes().getFnAttributes();
755 if (FnAttrs.hasAttributes(AttributeSet::FunctionIndex))
756 CreateAttributeSetSlot(FnAttrs);
759 ST_DEBUG("end processModule!\n");
762 // Process the arguments, basic blocks, and instructions of a function.
763 void SlotTracker::processFunction() {
764 ST_DEBUG("begin processFunction!\n");
767 // Add all the function arguments with no names.
768 for(Function::const_arg_iterator AI = TheFunction->arg_begin(),
769 AE = TheFunction->arg_end(); AI != AE; ++AI)
771 CreateFunctionSlot(AI);
773 ST_DEBUG("Inserting Instructions:\n");
775 // Add all of the basic blocks and instructions with no names.
776 for (auto &BB : *TheFunction) {
778 CreateFunctionSlot(&BB);
781 if (!I.getType()->isVoidTy() && !I.hasName())
782 CreateFunctionSlot(&I);
784 processInstructionMetadata(I);
786 // We allow direct calls to any llvm.foo function here, because the
787 // target may not be linked into the optimizer.
788 if (const CallInst *CI = dyn_cast<CallInst>(&I)) {
789 // Add all the call attributes to the table.
790 AttributeSet Attrs = CI->getAttributes().getFnAttributes();
791 if (Attrs.hasAttributes(AttributeSet::FunctionIndex))
792 CreateAttributeSetSlot(Attrs);
793 } else if (const InvokeInst *II = dyn_cast<InvokeInst>(&I)) {
794 // Add all the call attributes to the table.
795 AttributeSet Attrs = II->getAttributes().getFnAttributes();
796 if (Attrs.hasAttributes(AttributeSet::FunctionIndex))
797 CreateAttributeSetSlot(Attrs);
802 FunctionProcessed = true;
804 ST_DEBUG("end processFunction!\n");
807 void SlotTracker::processFunctionMetadata(const Function &F) {
810 processInstructionMetadata(I);
813 void SlotTracker::processInstructionMetadata(const Instruction &I) {
814 // Process metadata used directly by intrinsics.
815 if (const CallInst *CI = dyn_cast<CallInst>(&I))
816 if (Function *F = CI->getCalledFunction())
817 if (F->isIntrinsic())
818 for (auto &Op : I.operands())
819 if (auto *V = dyn_cast_or_null<MetadataAsValue>(Op))
820 if (MDNode *N = dyn_cast<MDNode>(V->getMetadata()))
821 CreateMetadataSlot(N);
823 // Process metadata attached to this instruction.
824 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
825 I.getAllMetadata(MDs);
827 CreateMetadataSlot(MD.second);
830 /// Clean up after incorporating a function. This is the only way to get out of
831 /// the function incorporation state that affects get*Slot/Create*Slot. Function
832 /// incorporation state is indicated by TheFunction != 0.
833 void SlotTracker::purgeFunction() {
834 ST_DEBUG("begin purgeFunction!\n");
835 fMap.clear(); // Simply discard the function level map
836 TheFunction = nullptr;
837 FunctionProcessed = false;
838 ST_DEBUG("end purgeFunction!\n");
841 /// getGlobalSlot - Get the slot number of a global value.
842 int SlotTracker::getGlobalSlot(const GlobalValue *V) {
843 // Check for uninitialized state and do lazy initialization.
846 // Find the value in the module map
847 ValueMap::iterator MI = mMap.find(V);
848 return MI == mMap.end() ? -1 : (int)MI->second;
851 /// getMetadataSlot - Get the slot number of a MDNode.
852 int SlotTracker::getMetadataSlot(const MDNode *N) {
853 // Check for uninitialized state and do lazy initialization.
856 // Find the MDNode in the module map
857 mdn_iterator MI = mdnMap.find(N);
858 return MI == mdnMap.end() ? -1 : (int)MI->second;
862 /// getLocalSlot - Get the slot number for a value that is local to a function.
863 int SlotTracker::getLocalSlot(const Value *V) {
864 assert(!isa<Constant>(V) && "Can't get a constant or global slot with this!");
866 // Check for uninitialized state and do lazy initialization.
869 ValueMap::iterator FI = fMap.find(V);
870 return FI == fMap.end() ? -1 : (int)FI->second;
873 int SlotTracker::getAttributeGroupSlot(AttributeSet AS) {
874 // Check for uninitialized state and do lazy initialization.
877 // Find the AttributeSet in the module map.
878 as_iterator AI = asMap.find(AS);
879 return AI == asMap.end() ? -1 : (int)AI->second;
882 /// CreateModuleSlot - Insert the specified GlobalValue* into the slot table.
883 void SlotTracker::CreateModuleSlot(const GlobalValue *V) {
884 assert(V && "Can't insert a null Value into SlotTracker!");
885 assert(!V->getType()->isVoidTy() && "Doesn't need a slot!");
886 assert(!V->hasName() && "Doesn't need a slot!");
888 unsigned DestSlot = mNext++;
891 ST_DEBUG(" Inserting value [" << V->getType() << "] = " << V << " slot=" <<
893 // G = Global, F = Function, A = Alias, o = other
894 ST_DEBUG((isa<GlobalVariable>(V) ? 'G' :
895 (isa<Function>(V) ? 'F' :
896 (isa<GlobalAlias>(V) ? 'A' : 'o'))) << "]\n");
899 /// CreateSlot - Create a new slot for the specified value if it has no name.
900 void SlotTracker::CreateFunctionSlot(const Value *V) {
901 assert(!V->getType()->isVoidTy() && !V->hasName() && "Doesn't need a slot!");
903 unsigned DestSlot = fNext++;
906 // G = Global, F = Function, o = other
907 ST_DEBUG(" Inserting value [" << V->getType() << "] = " << V << " slot=" <<
908 DestSlot << " [o]\n");
911 /// CreateModuleSlot - Insert the specified MDNode* into the slot table.
912 void SlotTracker::CreateMetadataSlot(const MDNode *N) {
913 assert(N && "Can't insert a null Value into SlotTracker!");
915 unsigned DestSlot = mdnNext;
916 if (!mdnMap.insert(std::make_pair(N, DestSlot)).second)
920 // Recursively add any MDNodes referenced by operands.
921 for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i)
922 if (const MDNode *Op = dyn_cast_or_null<MDNode>(N->getOperand(i)))
923 CreateMetadataSlot(Op);
926 void SlotTracker::CreateAttributeSetSlot(AttributeSet AS) {
927 assert(AS.hasAttributes(AttributeSet::FunctionIndex) &&
928 "Doesn't need a slot!");
930 as_iterator I = asMap.find(AS);
931 if (I != asMap.end())
934 unsigned DestSlot = asNext++;
935 asMap[AS] = DestSlot;
938 //===----------------------------------------------------------------------===//
939 // AsmWriter Implementation
940 //===----------------------------------------------------------------------===//
942 static void WriteAsOperandInternal(raw_ostream &Out, const Value *V,
943 TypePrinting *TypePrinter,
944 SlotTracker *Machine,
945 const Module *Context);
947 static void WriteAsOperandInternal(raw_ostream &Out, const Metadata *MD,
948 TypePrinting *TypePrinter,
949 SlotTracker *Machine, const Module *Context,
950 bool FromValue = false);
952 static const char *getPredicateText(unsigned predicate) {
953 const char * pred = "unknown";
955 case FCmpInst::FCMP_FALSE: pred = "false"; break;
956 case FCmpInst::FCMP_OEQ: pred = "oeq"; break;
957 case FCmpInst::FCMP_OGT: pred = "ogt"; break;
958 case FCmpInst::FCMP_OGE: pred = "oge"; break;
959 case FCmpInst::FCMP_OLT: pred = "olt"; break;
960 case FCmpInst::FCMP_OLE: pred = "ole"; break;
961 case FCmpInst::FCMP_ONE: pred = "one"; break;
962 case FCmpInst::FCMP_ORD: pred = "ord"; break;
963 case FCmpInst::FCMP_UNO: pred = "uno"; break;
964 case FCmpInst::FCMP_UEQ: pred = "ueq"; break;
965 case FCmpInst::FCMP_UGT: pred = "ugt"; break;
966 case FCmpInst::FCMP_UGE: pred = "uge"; break;
967 case FCmpInst::FCMP_ULT: pred = "ult"; break;
968 case FCmpInst::FCMP_ULE: pred = "ule"; break;
969 case FCmpInst::FCMP_UNE: pred = "une"; break;
970 case FCmpInst::FCMP_TRUE: pred = "true"; break;
971 case ICmpInst::ICMP_EQ: pred = "eq"; break;
972 case ICmpInst::ICMP_NE: pred = "ne"; break;
973 case ICmpInst::ICMP_SGT: pred = "sgt"; break;
974 case ICmpInst::ICMP_SGE: pred = "sge"; break;
975 case ICmpInst::ICMP_SLT: pred = "slt"; break;
976 case ICmpInst::ICMP_SLE: pred = "sle"; break;
977 case ICmpInst::ICMP_UGT: pred = "ugt"; break;
978 case ICmpInst::ICMP_UGE: pred = "uge"; break;
979 case ICmpInst::ICMP_ULT: pred = "ult"; break;
980 case ICmpInst::ICMP_ULE: pred = "ule"; break;
985 static void writeAtomicRMWOperation(raw_ostream &Out,
986 AtomicRMWInst::BinOp Op) {
988 default: Out << " <unknown operation " << Op << ">"; break;
989 case AtomicRMWInst::Xchg: Out << " xchg"; break;
990 case AtomicRMWInst::Add: Out << " add"; break;
991 case AtomicRMWInst::Sub: Out << " sub"; break;
992 case AtomicRMWInst::And: Out << " and"; break;
993 case AtomicRMWInst::Nand: Out << " nand"; break;
994 case AtomicRMWInst::Or: Out << " or"; break;
995 case AtomicRMWInst::Xor: Out << " xor"; break;
996 case AtomicRMWInst::Max: Out << " max"; break;
997 case AtomicRMWInst::Min: Out << " min"; break;
998 case AtomicRMWInst::UMax: Out << " umax"; break;
999 case AtomicRMWInst::UMin: Out << " umin"; break;
1003 static void WriteOptimizationInfo(raw_ostream &Out, const User *U) {
1004 if (const FPMathOperator *FPO = dyn_cast<const FPMathOperator>(U)) {
1005 // Unsafe algebra implies all the others, no need to write them all out
1006 if (FPO->hasUnsafeAlgebra())
1009 if (FPO->hasNoNaNs())
1011 if (FPO->hasNoInfs())
1013 if (FPO->hasNoSignedZeros())
1015 if (FPO->hasAllowReciprocal())
1020 if (const OverflowingBinaryOperator *OBO =
1021 dyn_cast<OverflowingBinaryOperator>(U)) {
1022 if (OBO->hasNoUnsignedWrap())
1024 if (OBO->hasNoSignedWrap())
1026 } else if (const PossiblyExactOperator *Div =
1027 dyn_cast<PossiblyExactOperator>(U)) {
1030 } else if (const GEPOperator *GEP = dyn_cast<GEPOperator>(U)) {
1031 if (GEP->isInBounds())
1036 static void WriteConstantInternal(raw_ostream &Out, const Constant *CV,
1037 TypePrinting &TypePrinter,
1038 SlotTracker *Machine,
1039 const Module *Context) {
1040 if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV)) {
1041 if (CI->getType()->isIntegerTy(1)) {
1042 Out << (CI->getZExtValue() ? "true" : "false");
1045 Out << CI->getValue();
1049 if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV)) {
1050 if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEsingle ||
1051 &CFP->getValueAPF().getSemantics() == &APFloat::IEEEdouble) {
1052 // We would like to output the FP constant value in exponential notation,
1053 // but we cannot do this if doing so will lose precision. Check here to
1054 // make sure that we only output it in exponential format if we can parse
1055 // the value back and get the same value.
1058 bool isHalf = &CFP->getValueAPF().getSemantics()==&APFloat::IEEEhalf;
1059 bool isDouble = &CFP->getValueAPF().getSemantics()==&APFloat::IEEEdouble;
1060 bool isInf = CFP->getValueAPF().isInfinity();
1061 bool isNaN = CFP->getValueAPF().isNaN();
1062 if (!isHalf && !isInf && !isNaN) {
1063 double Val = isDouble ? CFP->getValueAPF().convertToDouble() :
1064 CFP->getValueAPF().convertToFloat();
1065 SmallString<128> StrVal;
1066 raw_svector_ostream(StrVal) << Val;
1068 // Check to make sure that the stringized number is not some string like
1069 // "Inf" or NaN, that atof will accept, but the lexer will not. Check
1070 // that the string matches the "[-+]?[0-9]" regex.
1072 if ((StrVal[0] >= '0' && StrVal[0] <= '9') ||
1073 ((StrVal[0] == '-' || StrVal[0] == '+') &&
1074 (StrVal[1] >= '0' && StrVal[1] <= '9'))) {
1075 // Reparse stringized version!
1076 if (APFloat(APFloat::IEEEdouble, StrVal).convertToDouble() == Val) {
1082 // Otherwise we could not reparse it to exactly the same value, so we must
1083 // output the string in hexadecimal format! Note that loading and storing
1084 // floating point types changes the bits of NaNs on some hosts, notably
1085 // x86, so we must not use these types.
1086 static_assert(sizeof(double) == sizeof(uint64_t),
1087 "assuming that double is 64 bits!");
1089 APFloat apf = CFP->getValueAPF();
1090 // Halves and floats are represented in ASCII IR as double, convert.
1092 apf.convert(APFloat::IEEEdouble, APFloat::rmNearestTiesToEven,
1095 utohex_buffer(uint64_t(apf.bitcastToAPInt().getZExtValue()),
1100 // Either half, or some form of long double.
1101 // These appear as a magic letter identifying the type, then a
1102 // fixed number of hex digits.
1104 // Bit position, in the current word, of the next nibble to print.
1107 if (&CFP->getValueAPF().getSemantics() == &APFloat::x87DoubleExtended) {
1109 // api needed to prevent premature destruction
1110 APInt api = CFP->getValueAPF().bitcastToAPInt();
1111 const uint64_t* p = api.getRawData();
1112 uint64_t word = p[1];
1114 int width = api.getBitWidth();
1115 for (int j=0; j<width; j+=4, shiftcount-=4) {
1116 unsigned int nibble = (word>>shiftcount) & 15;
1118 Out << (unsigned char)(nibble + '0');
1120 Out << (unsigned char)(nibble - 10 + 'A');
1121 if (shiftcount == 0 && j+4 < width) {
1125 shiftcount = width-j-4;
1129 } else if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEquad) {
1132 } else if (&CFP->getValueAPF().getSemantics() == &APFloat::PPCDoubleDouble) {
1135 } else if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEhalf) {
1139 llvm_unreachable("Unsupported floating point type");
1140 // api needed to prevent premature destruction
1141 APInt api = CFP->getValueAPF().bitcastToAPInt();
1142 const uint64_t* p = api.getRawData();
1144 int width = api.getBitWidth();
1145 for (int j=0; j<width; j+=4, shiftcount-=4) {
1146 unsigned int nibble = (word>>shiftcount) & 15;
1148 Out << (unsigned char)(nibble + '0');
1150 Out << (unsigned char)(nibble - 10 + 'A');
1151 if (shiftcount == 0 && j+4 < width) {
1155 shiftcount = width-j-4;
1161 if (isa<ConstantAggregateZero>(CV)) {
1162 Out << "zeroinitializer";
1166 if (const BlockAddress *BA = dyn_cast<BlockAddress>(CV)) {
1167 Out << "blockaddress(";
1168 WriteAsOperandInternal(Out, BA->getFunction(), &TypePrinter, Machine,
1171 WriteAsOperandInternal(Out, BA->getBasicBlock(), &TypePrinter, Machine,
1177 if (const ConstantArray *CA = dyn_cast<ConstantArray>(CV)) {
1178 Type *ETy = CA->getType()->getElementType();
1180 TypePrinter.print(ETy, Out);
1182 WriteAsOperandInternal(Out, CA->getOperand(0),
1183 &TypePrinter, Machine,
1185 for (unsigned i = 1, e = CA->getNumOperands(); i != e; ++i) {
1187 TypePrinter.print(ETy, Out);
1189 WriteAsOperandInternal(Out, CA->getOperand(i), &TypePrinter, Machine,
1196 if (const ConstantDataArray *CA = dyn_cast<ConstantDataArray>(CV)) {
1197 // As a special case, print the array as a string if it is an array of
1198 // i8 with ConstantInt values.
1199 if (CA->isString()) {
1201 PrintEscapedString(CA->getAsString(), Out);
1206 Type *ETy = CA->getType()->getElementType();
1208 TypePrinter.print(ETy, Out);
1210 WriteAsOperandInternal(Out, CA->getElementAsConstant(0),
1211 &TypePrinter, Machine,
1213 for (unsigned i = 1, e = CA->getNumElements(); i != e; ++i) {
1215 TypePrinter.print(ETy, Out);
1217 WriteAsOperandInternal(Out, CA->getElementAsConstant(i), &TypePrinter,
1225 if (const ConstantStruct *CS = dyn_cast<ConstantStruct>(CV)) {
1226 if (CS->getType()->isPacked())
1229 unsigned N = CS->getNumOperands();
1232 TypePrinter.print(CS->getOperand(0)->getType(), Out);
1235 WriteAsOperandInternal(Out, CS->getOperand(0), &TypePrinter, Machine,
1238 for (unsigned i = 1; i < N; i++) {
1240 TypePrinter.print(CS->getOperand(i)->getType(), Out);
1243 WriteAsOperandInternal(Out, CS->getOperand(i), &TypePrinter, Machine,
1250 if (CS->getType()->isPacked())
1255 if (isa<ConstantVector>(CV) || isa<ConstantDataVector>(CV)) {
1256 Type *ETy = CV->getType()->getVectorElementType();
1258 TypePrinter.print(ETy, Out);
1260 WriteAsOperandInternal(Out, CV->getAggregateElement(0U), &TypePrinter,
1262 for (unsigned i = 1, e = CV->getType()->getVectorNumElements(); i != e;++i){
1264 TypePrinter.print(ETy, Out);
1266 WriteAsOperandInternal(Out, CV->getAggregateElement(i), &TypePrinter,
1273 if (isa<ConstantPointerNull>(CV)) {
1278 if (isa<UndefValue>(CV)) {
1283 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV)) {
1284 Out << CE->getOpcodeName();
1285 WriteOptimizationInfo(Out, CE);
1286 if (CE->isCompare())
1287 Out << ' ' << getPredicateText(CE->getPredicate());
1290 if (const GEPOperator *GEP = dyn_cast<GEPOperator>(CE)) {
1292 cast<PointerType>(GEP->getPointerOperandType()->getScalarType())
1298 for (User::const_op_iterator OI=CE->op_begin(); OI != CE->op_end(); ++OI) {
1299 TypePrinter.print((*OI)->getType(), Out);
1301 WriteAsOperandInternal(Out, *OI, &TypePrinter, Machine, Context);
1302 if (OI+1 != CE->op_end())
1306 if (CE->hasIndices()) {
1307 ArrayRef<unsigned> Indices = CE->getIndices();
1308 for (unsigned i = 0, e = Indices.size(); i != e; ++i)
1309 Out << ", " << Indices[i];
1314 TypePrinter.print(CE->getType(), Out);
1321 Out << "<placeholder or erroneous Constant>";
1324 static void writeMDTuple(raw_ostream &Out, const MDTuple *Node,
1325 TypePrinting *TypePrinter, SlotTracker *Machine,
1326 const Module *Context) {
1328 for (unsigned mi = 0, me = Node->getNumOperands(); mi != me; ++mi) {
1329 const Metadata *MD = Node->getOperand(mi);
1332 else if (auto *MDV = dyn_cast<ValueAsMetadata>(MD)) {
1333 Value *V = MDV->getValue();
1334 TypePrinter->print(V->getType(), Out);
1336 WriteAsOperandInternal(Out, V, TypePrinter, Machine, Context);
1338 WriteAsOperandInternal(Out, MD, TypePrinter, Machine, Context);
1348 struct FieldSeparator {
1351 FieldSeparator(const char *Sep = ", ") : Skip(true), Sep(Sep) {}
1353 raw_ostream &operator<<(raw_ostream &OS, FieldSeparator &FS) {
1358 return OS << FS.Sep;
1362 static void writeMetadataAsOperand(raw_ostream &Out, const Metadata *MD,
1363 TypePrinting *TypePrinter,
1364 SlotTracker *Machine,
1365 const Module *Context) {
1370 WriteAsOperandInternal(Out, MD, TypePrinter, Machine, Context);
1373 static void writeTag(raw_ostream &Out, FieldSeparator &FS, const DebugNode *N) {
1374 Out << FS << "tag: ";
1375 if (const char *Tag = dwarf::TagString(N->getTag()))
1381 static void writeStringField(raw_ostream &Out, FieldSeparator &FS,
1382 StringRef Name, StringRef Value,
1383 bool ShouldSkipEmpty = true) {
1384 if (ShouldSkipEmpty && Value.empty())
1387 Out << FS << Name << ": \"";
1388 PrintEscapedString(Value, Out);
1392 static void writeGenericDebugNode(raw_ostream &Out, const GenericDebugNode *N,
1393 TypePrinting *TypePrinter,
1394 SlotTracker *Machine, const Module *Context) {
1395 Out << "!GenericDebugNode(";
1397 writeTag(Out, FS, N);
1398 writeStringField(Out, FS, "header", N->getHeader());
1399 if (N->getNumDwarfOperands()) {
1400 Out << FS << "operands: {";
1402 for (auto &I : N->dwarf_operands()) {
1404 writeMetadataAsOperand(Out, I, TypePrinter, Machine, Context);
1411 static void writeMDLocation(raw_ostream &Out, const MDLocation *DL,
1412 TypePrinting *TypePrinter, SlotTracker *Machine,
1413 const Module *Context) {
1414 Out << "!MDLocation(";
1416 // Always output the line, since 0 is a relevant and important value for it.
1417 Out << FS << "line: " << DL->getLine();
1418 if (DL->getColumn())
1419 Out << FS << "column: " << DL->getColumn();
1420 Out << FS << "scope: ";
1421 WriteAsOperandInternal(Out, DL->getScope(), TypePrinter, Machine, Context);
1422 if (DL->getInlinedAt()) {
1423 Out << FS << "inlinedAt: ";
1424 WriteAsOperandInternal(Out, DL->getInlinedAt(), TypePrinter, Machine,
1430 static void writeMDSubrange(raw_ostream &Out, const MDSubrange *N,
1431 TypePrinting *, SlotTracker *, const Module *) {
1432 Out << "!MDSubrange(";
1434 Out << FS << "count: " << N->getCount();
1436 Out << FS << "lowerBound: " << N->getLo();
1440 static void writeMDEnumerator(raw_ostream &Out, const MDEnumerator *N,
1441 TypePrinting *, SlotTracker *, const Module *) {
1442 Out << "!MDEnumerator(";
1444 writeStringField(Out, FS, "name", N->getName(), /* ShouldSkipEmpty */ false);
1445 Out << FS << "value: " << N->getValue();
1449 static void writeMDBasicType(raw_ostream &Out, const MDBasicType *N,
1450 TypePrinting *, SlotTracker *, const Module *) {
1451 Out << "!MDBasicType(";
1453 if (N->getTag() != dwarf::DW_TAG_base_type)
1454 writeTag(Out, FS, N);
1455 writeStringField(Out, FS, "name", N->getName());
1456 if (N->getSizeInBits())
1457 Out << FS << "size: " << N->getSizeInBits();
1458 if (N->getAlignInBits())
1459 Out << FS << "align: " << N->getAlignInBits();
1460 if (unsigned Encoding = N->getEncoding()) {
1461 Out << FS << "encoding: ";
1462 if (const char *S = dwarf::AttributeEncodingString(Encoding))
1470 static void writeDIFlags(raw_ostream &Out, unsigned Flags) {
1471 SmallVector<unsigned, 8> SplitFlags;
1472 unsigned Extra = DIDescriptor::splitFlags(Flags, SplitFlags);
1474 FieldSeparator FS(" | ");
1475 for (unsigned F : SplitFlags) {
1476 const char *StringF = DIDescriptor::getFlagString(F);
1477 assert(StringF && "Expected valid flag");
1478 Out << FS << StringF;
1480 if (Extra || SplitFlags.empty())
1484 static void writeMDDerivedType(raw_ostream &Out, const MDDerivedType *N,
1485 TypePrinting *TypePrinter, SlotTracker *Machine,
1486 const Module *Context) {
1487 Out << "!MDDerivedType(";
1489 writeTag(Out, FS, N);
1490 writeStringField(Out, FS, "name", N->getName());
1491 if (N->getScope()) {
1492 Out << FS << "scope: ";
1493 writeMetadataAsOperand(Out, N->getScope(), TypePrinter, Machine, Context);
1496 Out << FS << "file: ";
1497 writeMetadataAsOperand(Out, N->getFile(), TypePrinter, Machine,
1501 Out << FS << "line: " << N->getLine();
1502 Out << FS << "baseType: ";
1503 writeMetadataAsOperand(Out, N->getBaseType(), TypePrinter, Machine, Context);
1504 if (N->getSizeInBits())
1505 Out << FS << "size: " << N->getSizeInBits();
1506 if (N->getAlignInBits())
1507 Out << FS << "align: " << N->getAlignInBits();
1508 if (N->getOffsetInBits())
1509 Out << FS << "offset: " << N->getOffsetInBits();
1510 if (auto Flags = N->getFlags()) {
1511 Out << FS << "flags: ";
1512 writeDIFlags(Out, Flags);
1514 if (N->getExtraData()) {
1515 Out << FS << "extraData: ";
1516 writeMetadataAsOperand(Out, N->getExtraData(), TypePrinter, Machine,
1522 static void writeMDCompositeType(raw_ostream &Out, const MDCompositeType *N,
1523 TypePrinting *TypePrinter,
1524 SlotTracker *Machine, const Module *Context) {
1525 Out << "!MDCompositeType(";
1527 writeTag(Out, FS, N);
1528 writeStringField(Out, FS, "name", N->getName());
1529 if (N->getScope()) {
1530 Out << FS << "scope: ";
1531 writeMetadataAsOperand(Out, N->getScope(), TypePrinter, Machine, Context);
1534 Out << FS << "file: ";
1535 writeMetadataAsOperand(Out, N->getFile(), TypePrinter, Machine,
1539 Out << FS << "line: " << N->getLine();
1540 if (N->getBaseType()) {
1541 Out << FS << "baseType: ";
1542 writeMetadataAsOperand(Out, N->getBaseType(), TypePrinter, Machine,
1545 if (N->getSizeInBits())
1546 Out << FS << "size: " << N->getSizeInBits();
1547 if (N->getAlignInBits())
1548 Out << FS << "align: " << N->getAlignInBits();
1549 if (N->getOffsetInBits())
1550 Out << FS << "offset: " << N->getOffsetInBits();
1551 if (auto Flags = N->getFlags()) {
1552 Out << FS << "flags: ";
1553 writeDIFlags(Out, Flags);
1555 if (N->getElements()) {
1556 Out << FS << "elements: ";
1557 writeMetadataAsOperand(Out, N->getElements(), TypePrinter, Machine,
1560 if (unsigned Lang = N->getRuntimeLang()) {
1561 Out << FS << "runtimeLang: ";
1562 if (const char *S = dwarf::LanguageString(Lang))
1568 if (N->getVTableHolder()) {
1569 Out << FS << "vtableHolder: ";
1570 writeMetadataAsOperand(Out, N->getVTableHolder(), TypePrinter, Machine,
1573 if (N->getTemplateParams()) {
1574 Out << FS << "templateParams: ";
1575 writeMetadataAsOperand(Out, N->getTemplateParams(), TypePrinter, Machine,
1578 writeStringField(Out, FS, "identifier", N->getIdentifier());
1582 static void writeMDSubroutineType(raw_ostream &Out, const MDSubroutineType *N,
1583 TypePrinting *TypePrinter,
1584 SlotTracker *Machine, const Module *Context) {
1585 Out << "!MDSubroutineType(";
1587 if (auto Flags = N->getFlags()) {
1588 Out << FS << "flags: ";
1589 writeDIFlags(Out, Flags);
1591 Out << FS << "types: ";
1592 writeMetadataAsOperand(Out, N->getTypeArray(), TypePrinter, Machine, Context);
1596 static void writeMDFile(raw_ostream &Out, const MDFile *N, TypePrinting *,
1597 SlotTracker *, const Module *) {
1600 writeStringField(Out, FS, "filename", N->getFilename(),
1601 /* ShouldSkipEmpty */ false);
1602 writeStringField(Out, FS, "directory", N->getDirectory(),
1603 /* ShouldSkipEmpty */ false);
1607 static void writeMDCompileUnit(raw_ostream &Out, const MDCompileUnit *N,
1608 TypePrinting *TypePrinter, SlotTracker *Machine,
1609 const Module *Context) {
1610 Out << "!MDCompileUnit(";
1612 Out << FS << "language: ";
1613 if (const char *Lang = dwarf::LanguageString(N->getSourceLanguage()))
1616 Out << N->getSourceLanguage();
1617 Out << FS << "file: ";
1618 writeMetadataAsOperand(Out, N->getFile(), TypePrinter, Machine, Context);
1619 writeStringField(Out, FS, "producer", N->getProducer());
1620 Out << FS << "isOptimized: " << (N->isOptimized() ? "true" : "false");
1621 writeStringField(Out, FS, "flags", N->getFlags());
1622 Out << FS << "runtimeVersion: " << N->getRuntimeVersion();
1623 writeStringField(Out, FS, "splitDebugFilename", N->getSplitDebugFilename());
1624 Out << FS << "emissionKind: " << N->getEmissionKind();
1625 if (N->getEnumTypes()) {
1626 Out << FS << "enums: ";
1627 writeMetadataAsOperand(Out, N->getEnumTypes(), TypePrinter, Machine,
1630 if (N->getRetainedTypes()) {
1631 Out << FS << "retainedTypes: ";
1632 writeMetadataAsOperand(Out, N->getRetainedTypes(), TypePrinter, Machine,
1635 if (N->getSubprograms()) {
1636 Out << FS << "subprograms: ";
1637 writeMetadataAsOperand(Out, N->getSubprograms(), TypePrinter, Machine,
1640 if (N->getGlobalVariables()) {
1641 Out << FS << "globals: ";
1642 writeMetadataAsOperand(Out, N->getGlobalVariables(), TypePrinter, Machine,
1645 if (N->getImportedEntities()) {
1646 Out << FS << "imports: ";
1647 writeMetadataAsOperand(Out, N->getImportedEntities(), TypePrinter, Machine,
1653 static void writeMDSubprogram(raw_ostream &Out, const MDSubprogram *N,
1654 TypePrinting *TypePrinter, SlotTracker *Machine,
1655 const Module *Context) {
1656 Out << "!MDSubprogram(";
1658 writeStringField(Out, FS, "name", N->getName());
1659 writeStringField(Out, FS, "linkageName", N->getLinkageName());
1660 Out << FS << "scope: ";
1661 writeMetadataAsOperand(Out, N->getScope(), TypePrinter, Machine, Context);
1663 Out << FS << "file: ";
1664 writeMetadataAsOperand(Out, N->getFile(), TypePrinter, Machine,
1668 Out << FS << "line: " << N->getLine();
1670 Out << FS << "type: ";
1671 writeMetadataAsOperand(Out, N->getType(), TypePrinter, Machine,
1674 Out << FS << "isLocal: " << (N->isLocalToUnit() ? "true" : "false");
1675 Out << FS << "isDefinition: " << (N->isDefinition() ? "true" : "false");
1676 if (N->getScopeLine())
1677 Out << FS << "scopeLine: " << N->getScopeLine();
1678 if (N->getContainingType()) {
1679 Out << FS << "containingType: ";
1680 writeMetadataAsOperand(Out, N->getContainingType(), TypePrinter, Machine,
1683 if (unsigned V = N->getVirtuality()) {
1684 Out << FS << "virtuality: ";
1685 if (const char *S = dwarf::VirtualityString(V))
1690 if (N->getVirtualIndex())
1691 Out << FS << "virtualIndex: " << N->getVirtualIndex();
1692 if (auto Flags = N->getFlags()) {
1693 Out << FS << "flags: ";
1694 writeDIFlags(Out, Flags);
1696 Out << FS << "isOptimized: " << (N->isOptimized() ? "true" : "false");
1697 if (N->getFunction()) {
1698 Out << FS << "function: ";
1699 writeMetadataAsOperand(Out, N->getFunction(), TypePrinter, Machine,
1702 if (N->getTemplateParams()) {
1703 Out << FS << "templateParams: ";
1704 writeMetadataAsOperand(Out, N->getTemplateParams(), TypePrinter, Machine,
1707 if (N->getDeclaration()) {
1708 Out << FS << "declaration: ";
1709 writeMetadataAsOperand(Out, N->getDeclaration(), TypePrinter, Machine,
1712 if (N->getVariables()) {
1713 Out << FS << "variables: ";
1714 writeMetadataAsOperand(Out, N->getVariables(), TypePrinter, Machine,
1720 static void writeMDLexicalBlock(raw_ostream &Out, const MDLexicalBlock *N,
1721 TypePrinting *TypePrinter, SlotTracker *Machine,
1722 const Module *Context) {
1723 Out << "!MDLexicalBlock(";
1725 Out << FS << "scope: ";
1726 writeMetadataAsOperand(Out, N->getScope(), TypePrinter, Machine, Context);
1728 Out << FS << "file: ";
1729 writeMetadataAsOperand(Out, N->getFile(), TypePrinter, Machine,
1733 Out << FS << "line: " << N->getLine();
1735 Out << FS << "column: " << N->getColumn();
1739 static void writeMDLexicalBlockFile(raw_ostream &Out,
1740 const MDLexicalBlockFile *N,
1741 TypePrinting *TypePrinter,
1742 SlotTracker *Machine,
1743 const Module *Context) {
1744 Out << "!MDLexicalBlockFile(";
1746 Out << FS << "scope: ";
1747 writeMetadataAsOperand(Out, N->getScope(), TypePrinter, Machine, Context);
1749 Out << FS << "file: ";
1750 writeMetadataAsOperand(Out, N->getFile(), TypePrinter, Machine,
1753 Out << FS << "discriminator: " << N->getDiscriminator();
1757 static void writeMDNamespace(raw_ostream &Out, const MDNamespace *N,
1758 TypePrinting *TypePrinter, SlotTracker *Machine,
1759 const Module *Context) {
1760 Out << "!MDNamespace(";
1762 writeStringField(Out, FS, "name", N->getName());
1763 Out << FS << "scope: ";
1764 writeMetadataAsOperand(Out, N->getScope(), TypePrinter, Machine, Context);
1766 Out << FS << "file: ";
1767 writeMetadataAsOperand(Out, N->getFile(), TypePrinter, Machine, Context);
1770 Out << FS << "line: " << N->getLine();
1774 static void writeMDTemplateTypeParameter(raw_ostream &Out,
1775 const MDTemplateTypeParameter *N,
1776 TypePrinting *TypePrinter,
1777 SlotTracker *Machine,
1778 const Module *Context) {
1779 Out << "!MDTemplateTypeParameter(";
1781 writeStringField(Out, FS, "name", N->getName());
1782 Out << FS << "type: ";
1783 writeMetadataAsOperand(Out, N->getType(), TypePrinter, Machine, Context);
1787 static void writeMDTemplateValueParameter(raw_ostream &Out,
1788 const MDTemplateValueParameter *N,
1789 TypePrinting *TypePrinter,
1790 SlotTracker *Machine,
1791 const Module *Context) {
1792 Out << "!MDTemplateValueParameter(";
1794 if (N->getTag() != dwarf::DW_TAG_template_value_parameter)
1795 writeTag(Out, FS, N);
1796 writeStringField(Out, FS, "name", N->getName());
1797 if (auto *Type = N->getType()) {
1798 Out << FS << "type: ";
1799 writeMetadataAsOperand(Out, Type, TypePrinter, Machine, Context);
1801 Out << FS << "value: ";
1802 writeMetadataAsOperand(Out, N->getValue(), TypePrinter, Machine, Context);
1806 static void writeMDGlobalVariable(raw_ostream &Out, const MDGlobalVariable *N,
1807 TypePrinting *TypePrinter,
1808 SlotTracker *Machine, const Module *Context) {
1809 Out << "!MDGlobalVariable(";
1811 writeStringField(Out, FS, "name", N->getName());
1812 writeStringField(Out, FS, "linkageName", N->getLinkageName());
1813 Out << FS << "scope: ";
1814 writeMetadataAsOperand(Out, N->getScope(), TypePrinter, Machine, Context);
1816 Out << FS << "file: ";
1817 writeMetadataAsOperand(Out, N->getFile(), TypePrinter, Machine,
1821 Out << FS << "line: " << N->getLine();
1823 Out << FS << "type: ";
1824 writeMetadataAsOperand(Out, N->getType(), TypePrinter, Machine,
1827 Out << FS << "isLocal: " << (N->isLocalToUnit() ? "true" : "false");
1828 Out << FS << "isDefinition: " << (N->isDefinition() ? "true" : "false");
1829 if (N->getVariable()) {
1830 Out << FS << "variable: ";
1831 writeMetadataAsOperand(Out, N->getVariable(), TypePrinter, Machine,
1834 if (N->getStaticDataMemberDeclaration()) {
1835 Out << FS << "declaration: ";
1836 writeMetadataAsOperand(Out, N->getStaticDataMemberDeclaration(),
1837 TypePrinter, Machine, Context);
1842 static void writeMDLocalVariable(raw_ostream &Out, const MDLocalVariable *N,
1843 TypePrinting *TypePrinter,
1844 SlotTracker *Machine, const Module *Context) {
1845 Out << "!MDLocalVariable(";
1847 writeTag(Out, FS, N);
1848 writeStringField(Out, FS, "name", N->getName());
1849 if (N->getTag() == dwarf::DW_TAG_arg_variable || N->getArg())
1850 Out << FS << "arg: " << N->getArg();
1851 Out << FS << "scope: ";
1852 writeMetadataAsOperand(Out, N->getScope(), TypePrinter, Machine, Context);
1854 Out << FS << "file: ";
1855 writeMetadataAsOperand(Out, N->getFile(), TypePrinter, Machine,
1859 Out << FS << "line: " << N->getLine();
1861 Out << FS << "type: ";
1862 writeMetadataAsOperand(Out, N->getType(), TypePrinter, Machine,
1865 if (auto Flags = N->getFlags()) {
1866 Out << FS << "flags: ";
1867 writeDIFlags(Out, Flags);
1869 if (N->getInlinedAt()) {
1870 Out << FS << "inlinedAt: ";
1871 writeMetadataAsOperand(Out, N->getInlinedAt(), TypePrinter, Machine,
1877 static void writeMDExpression(raw_ostream &Out, const MDExpression *N,
1878 TypePrinting *TypePrinter, SlotTracker *Machine,
1879 const Module *Context) {
1880 Out << "!MDExpression(";
1883 for (auto I = N->expr_op_begin(), E = N->expr_op_end(); I != E; ++I) {
1884 const char *OpStr = dwarf::OperationEncodingString(I->getOp());
1885 assert(OpStr && "Expected valid opcode");
1888 for (unsigned A = 0, AE = I->getNumArgs(); A != AE; ++A)
1889 Out << FS << I->getArg(A);
1892 for (const auto &I : N->getElements())
1898 static void writeMDObjCProperty(raw_ostream &Out, const MDObjCProperty *N,
1899 TypePrinting *TypePrinter, SlotTracker *Machine,
1900 const Module *Context) {
1901 Out << "!MDObjCProperty(";
1903 writeStringField(Out, FS, "name", N->getName());
1905 Out << FS << "file: ";
1906 writeMetadataAsOperand(Out, N->getFile(), TypePrinter, Machine, Context);
1909 Out << FS << "line: " << N->getLine();
1910 writeStringField(Out, FS, "setter", N->getSetterName());
1911 writeStringField(Out, FS, "getter", N->getGetterName());
1912 if (N->getAttributes())
1913 Out << FS << "attributes: " << N->getAttributes();
1915 Out << FS << "type: ";
1916 writeMetadataAsOperand(Out, N->getType(), TypePrinter, Machine, Context);
1921 static void writeMDImportedEntity(raw_ostream &Out, const MDImportedEntity *N,
1922 TypePrinting *TypePrinter,
1923 SlotTracker *Machine, const Module *Context) {
1924 Out << "!MDImportedEntity(";
1926 writeTag(Out, FS, N);
1927 writeStringField(Out, FS, "name", N->getName());
1928 Out << FS << "scope: ";
1929 writeMetadataAsOperand(Out, N->getScope(), TypePrinter, Machine, Context);
1930 if (N->getEntity()) {
1931 Out << FS << "entity: ";
1932 writeMetadataAsOperand(Out, N->getEntity(), TypePrinter, Machine, Context);
1935 Out << FS << "line: " << N->getLine();
1940 static void WriteMDNodeBodyInternal(raw_ostream &Out, const MDNode *Node,
1941 TypePrinting *TypePrinter,
1942 SlotTracker *Machine,
1943 const Module *Context) {
1944 if (Node->isDistinct())
1946 else if (Node->isTemporary())
1947 Out << "<temporary!> "; // Handle broken code.
1949 switch (Node->getMetadataID()) {
1951 llvm_unreachable("Expected uniquable MDNode");
1952 #define HANDLE_MDNODE_LEAF(CLASS) \
1953 case Metadata::CLASS##Kind: \
1954 write##CLASS(Out, cast<CLASS>(Node), TypePrinter, Machine, Context); \
1956 #include "llvm/IR/Metadata.def"
1960 // Full implementation of printing a Value as an operand with support for
1961 // TypePrinting, etc.
1962 static void WriteAsOperandInternal(raw_ostream &Out, const Value *V,
1963 TypePrinting *TypePrinter,
1964 SlotTracker *Machine,
1965 const Module *Context) {
1967 PrintLLVMName(Out, V);
1971 const Constant *CV = dyn_cast<Constant>(V);
1972 if (CV && !isa<GlobalValue>(CV)) {
1973 assert(TypePrinter && "Constants require TypePrinting!");
1974 WriteConstantInternal(Out, CV, *TypePrinter, Machine, Context);
1978 if (const InlineAsm *IA = dyn_cast<InlineAsm>(V)) {
1980 if (IA->hasSideEffects())
1981 Out << "sideeffect ";
1982 if (IA->isAlignStack())
1983 Out << "alignstack ";
1984 // We don't emit the AD_ATT dialect as it's the assumed default.
1985 if (IA->getDialect() == InlineAsm::AD_Intel)
1986 Out << "inteldialect ";
1988 PrintEscapedString(IA->getAsmString(), Out);
1990 PrintEscapedString(IA->getConstraintString(), Out);
1995 if (auto *MD = dyn_cast<MetadataAsValue>(V)) {
1996 WriteAsOperandInternal(Out, MD->getMetadata(), TypePrinter, Machine,
1997 Context, /* FromValue */ true);
2003 // If we have a SlotTracker, use it.
2005 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
2006 Slot = Machine->getGlobalSlot(GV);
2009 Slot = Machine->getLocalSlot(V);
2011 // If the local value didn't succeed, then we may be referring to a value
2012 // from a different function. Translate it, as this can happen when using
2013 // address of blocks.
2015 if ((Machine = createSlotTracker(V))) {
2016 Slot = Machine->getLocalSlot(V);
2020 } else if ((Machine = createSlotTracker(V))) {
2021 // Otherwise, create one to get the # and then destroy it.
2022 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
2023 Slot = Machine->getGlobalSlot(GV);
2026 Slot = Machine->getLocalSlot(V);
2035 Out << Prefix << Slot;
2040 static void WriteAsOperandInternal(raw_ostream &Out, const Metadata *MD,
2041 TypePrinting *TypePrinter,
2042 SlotTracker *Machine, const Module *Context,
2044 if (const MDNode *N = dyn_cast<MDNode>(MD)) {
2046 Machine = new SlotTracker(Context);
2047 int Slot = Machine->getMetadataSlot(N);
2049 // Give the pointer value instead of "badref", since this comes up all
2050 // the time when debugging.
2051 Out << "<" << N << ">";
2057 if (const MDString *MDS = dyn_cast<MDString>(MD)) {
2059 PrintEscapedString(MDS->getString(), Out);
2064 auto *V = cast<ValueAsMetadata>(MD);
2065 assert(TypePrinter && "TypePrinter required for metadata values");
2066 assert((FromValue || !isa<LocalAsMetadata>(V)) &&
2067 "Unexpected function-local metadata outside of value argument");
2069 TypePrinter->print(V->getValue()->getType(), Out);
2071 WriteAsOperandInternal(Out, V->getValue(), TypePrinter, Machine, Context);
2075 class AssemblyWriter {
2076 formatted_raw_ostream &Out;
2077 const Module *TheModule;
2078 std::unique_ptr<SlotTracker> ModuleSlotTracker;
2079 SlotTracker &Machine;
2080 TypePrinting TypePrinter;
2081 AssemblyAnnotationWriter *AnnotationWriter;
2082 SetVector<const Comdat *> Comdats;
2083 UseListOrderStack UseListOrders;
2086 /// Construct an AssemblyWriter with an external SlotTracker
2087 AssemblyWriter(formatted_raw_ostream &o, SlotTracker &Mac,
2088 const Module *M, AssemblyAnnotationWriter *AAW);
2090 /// Construct an AssemblyWriter with an internally allocated SlotTracker
2091 AssemblyWriter(formatted_raw_ostream &o, const Module *M,
2092 AssemblyAnnotationWriter *AAW);
2094 void printMDNodeBody(const MDNode *MD);
2095 void printNamedMDNode(const NamedMDNode *NMD);
2097 void printModule(const Module *M);
2099 void writeOperand(const Value *Op, bool PrintType);
2100 void writeParamOperand(const Value *Operand, AttributeSet Attrs,unsigned Idx);
2101 void writeAtomic(AtomicOrdering Ordering, SynchronizationScope SynchScope);
2102 void writeAtomicCmpXchg(AtomicOrdering SuccessOrdering,
2103 AtomicOrdering FailureOrdering,
2104 SynchronizationScope SynchScope);
2106 void writeAllMDNodes();
2107 void writeMDNode(unsigned Slot, const MDNode *Node);
2108 void writeAllAttributeGroups();
2110 void printTypeIdentities();
2111 void printGlobal(const GlobalVariable *GV);
2112 void printAlias(const GlobalAlias *GV);
2113 void printComdat(const Comdat *C);
2114 void printFunction(const Function *F);
2115 void printArgument(const Argument *FA, AttributeSet Attrs, unsigned Idx);
2116 void printBasicBlock(const BasicBlock *BB);
2117 void printInstructionLine(const Instruction &I);
2118 void printInstruction(const Instruction &I);
2120 void printUseListOrder(const UseListOrder &Order);
2121 void printUseLists(const Function *F);
2126 // printInfoComment - Print a little comment after the instruction indicating
2127 // which slot it occupies.
2128 void printInfoComment(const Value &V);
2132 void AssemblyWriter::init() {
2135 TypePrinter.incorporateTypes(*TheModule);
2136 for (const Function &F : *TheModule)
2137 if (const Comdat *C = F.getComdat())
2139 for (const GlobalVariable &GV : TheModule->globals())
2140 if (const Comdat *C = GV.getComdat())
2145 AssemblyWriter::AssemblyWriter(formatted_raw_ostream &o, SlotTracker &Mac,
2147 AssemblyAnnotationWriter *AAW)
2148 : Out(o), TheModule(M), Machine(Mac), AnnotationWriter(AAW) {
2152 AssemblyWriter::AssemblyWriter(formatted_raw_ostream &o, const Module *M,
2153 AssemblyAnnotationWriter *AAW)
2154 : Out(o), TheModule(M), ModuleSlotTracker(createSlotTracker(M)),
2155 Machine(*ModuleSlotTracker), AnnotationWriter(AAW) {
2159 void AssemblyWriter::writeOperand(const Value *Operand, bool PrintType) {
2161 Out << "<null operand!>";
2165 TypePrinter.print(Operand->getType(), Out);
2168 WriteAsOperandInternal(Out, Operand, &TypePrinter, &Machine, TheModule);
2171 void AssemblyWriter::writeAtomic(AtomicOrdering Ordering,
2172 SynchronizationScope SynchScope) {
2173 if (Ordering == NotAtomic)
2176 switch (SynchScope) {
2177 case SingleThread: Out << " singlethread"; break;
2178 case CrossThread: break;
2182 default: Out << " <bad ordering " << int(Ordering) << ">"; break;
2183 case Unordered: Out << " unordered"; break;
2184 case Monotonic: Out << " monotonic"; break;
2185 case Acquire: Out << " acquire"; break;
2186 case Release: Out << " release"; break;
2187 case AcquireRelease: Out << " acq_rel"; break;
2188 case SequentiallyConsistent: Out << " seq_cst"; break;
2192 void AssemblyWriter::writeAtomicCmpXchg(AtomicOrdering SuccessOrdering,
2193 AtomicOrdering FailureOrdering,
2194 SynchronizationScope SynchScope) {
2195 assert(SuccessOrdering != NotAtomic && FailureOrdering != NotAtomic);
2197 switch (SynchScope) {
2198 case SingleThread: Out << " singlethread"; break;
2199 case CrossThread: break;
2202 switch (SuccessOrdering) {
2203 default: Out << " <bad ordering " << int(SuccessOrdering) << ">"; break;
2204 case Unordered: Out << " unordered"; break;
2205 case Monotonic: Out << " monotonic"; break;
2206 case Acquire: Out << " acquire"; break;
2207 case Release: Out << " release"; break;
2208 case AcquireRelease: Out << " acq_rel"; break;
2209 case SequentiallyConsistent: Out << " seq_cst"; break;
2212 switch (FailureOrdering) {
2213 default: Out << " <bad ordering " << int(FailureOrdering) << ">"; break;
2214 case Unordered: Out << " unordered"; break;
2215 case Monotonic: Out << " monotonic"; break;
2216 case Acquire: Out << " acquire"; break;
2217 case Release: Out << " release"; break;
2218 case AcquireRelease: Out << " acq_rel"; break;
2219 case SequentiallyConsistent: Out << " seq_cst"; break;
2223 void AssemblyWriter::writeParamOperand(const Value *Operand,
2224 AttributeSet Attrs, unsigned Idx) {
2226 Out << "<null operand!>";
2231 TypePrinter.print(Operand->getType(), Out);
2232 // Print parameter attributes list
2233 if (Attrs.hasAttributes(Idx))
2234 Out << ' ' << Attrs.getAsString(Idx);
2236 // Print the operand
2237 WriteAsOperandInternal(Out, Operand, &TypePrinter, &Machine, TheModule);
2240 void AssemblyWriter::printModule(const Module *M) {
2241 Machine.initialize();
2243 if (shouldPreserveAssemblyUseListOrder())
2244 UseListOrders = predictUseListOrder(M);
2246 if (!M->getModuleIdentifier().empty() &&
2247 // Don't print the ID if it will start a new line (which would
2248 // require a comment char before it).
2249 M->getModuleIdentifier().find('\n') == std::string::npos)
2250 Out << "; ModuleID = '" << M->getModuleIdentifier() << "'\n";
2252 const std::string &DL = M->getDataLayoutStr();
2254 Out << "target datalayout = \"" << DL << "\"\n";
2255 if (!M->getTargetTriple().empty())
2256 Out << "target triple = \"" << M->getTargetTriple() << "\"\n";
2258 if (!M->getModuleInlineAsm().empty()) {
2259 // Split the string into lines, to make it easier to read the .ll file.
2260 std::string Asm = M->getModuleInlineAsm();
2262 size_t NewLine = Asm.find_first_of('\n', CurPos);
2264 while (NewLine != std::string::npos) {
2265 // We found a newline, print the portion of the asm string from the
2266 // last newline up to this newline.
2267 Out << "module asm \"";
2268 PrintEscapedString(std::string(Asm.begin()+CurPos, Asm.begin()+NewLine),
2272 NewLine = Asm.find_first_of('\n', CurPos);
2274 std::string rest(Asm.begin()+CurPos, Asm.end());
2275 if (!rest.empty()) {
2276 Out << "module asm \"";
2277 PrintEscapedString(rest, Out);
2282 printTypeIdentities();
2284 // Output all comdats.
2285 if (!Comdats.empty())
2287 for (const Comdat *C : Comdats) {
2289 if (C != Comdats.back())
2293 // Output all globals.
2294 if (!M->global_empty()) Out << '\n';
2295 for (Module::const_global_iterator I = M->global_begin(), E = M->global_end();
2297 printGlobal(I); Out << '\n';
2300 // Output all aliases.
2301 if (!M->alias_empty()) Out << "\n";
2302 for (Module::const_alias_iterator I = M->alias_begin(), E = M->alias_end();
2306 // Output global use-lists.
2307 printUseLists(nullptr);
2309 // Output all of the functions.
2310 for (Module::const_iterator I = M->begin(), E = M->end(); I != E; ++I)
2312 assert(UseListOrders.empty() && "All use-lists should have been consumed");
2314 // Output all attribute groups.
2315 if (!Machine.as_empty()) {
2317 writeAllAttributeGroups();
2320 // Output named metadata.
2321 if (!M->named_metadata_empty()) Out << '\n';
2323 for (Module::const_named_metadata_iterator I = M->named_metadata_begin(),
2324 E = M->named_metadata_end(); I != E; ++I)
2325 printNamedMDNode(I);
2328 if (!Machine.mdn_empty()) {
2334 void AssemblyWriter::printNamedMDNode(const NamedMDNode *NMD) {
2336 StringRef Name = NMD->getName();
2338 Out << "<empty name> ";
2340 if (isalpha(static_cast<unsigned char>(Name[0])) ||
2341 Name[0] == '-' || Name[0] == '$' ||
2342 Name[0] == '.' || Name[0] == '_')
2345 Out << '\\' << hexdigit(Name[0] >> 4) << hexdigit(Name[0] & 0x0F);
2346 for (unsigned i = 1, e = Name.size(); i != e; ++i) {
2347 unsigned char C = Name[i];
2348 if (isalnum(static_cast<unsigned char>(C)) || C == '-' || C == '$' ||
2349 C == '.' || C == '_')
2352 Out << '\\' << hexdigit(C >> 4) << hexdigit(C & 0x0F);
2356 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
2358 int Slot = Machine.getMetadataSlot(NMD->getOperand(i));
2368 static void PrintLinkage(GlobalValue::LinkageTypes LT,
2369 formatted_raw_ostream &Out) {
2371 case GlobalValue::ExternalLinkage: break;
2372 case GlobalValue::PrivateLinkage: Out << "private "; break;
2373 case GlobalValue::InternalLinkage: Out << "internal "; break;
2374 case GlobalValue::LinkOnceAnyLinkage: Out << "linkonce "; break;
2375 case GlobalValue::LinkOnceODRLinkage: Out << "linkonce_odr "; break;
2376 case GlobalValue::WeakAnyLinkage: Out << "weak "; break;
2377 case GlobalValue::WeakODRLinkage: Out << "weak_odr "; break;
2378 case GlobalValue::CommonLinkage: Out << "common "; break;
2379 case GlobalValue::AppendingLinkage: Out << "appending "; break;
2380 case GlobalValue::ExternalWeakLinkage: Out << "extern_weak "; break;
2381 case GlobalValue::AvailableExternallyLinkage:
2382 Out << "available_externally ";
2388 static void PrintVisibility(GlobalValue::VisibilityTypes Vis,
2389 formatted_raw_ostream &Out) {
2391 case GlobalValue::DefaultVisibility: break;
2392 case GlobalValue::HiddenVisibility: Out << "hidden "; break;
2393 case GlobalValue::ProtectedVisibility: Out << "protected "; break;
2397 static void PrintDLLStorageClass(GlobalValue::DLLStorageClassTypes SCT,
2398 formatted_raw_ostream &Out) {
2400 case GlobalValue::DefaultStorageClass: break;
2401 case GlobalValue::DLLImportStorageClass: Out << "dllimport "; break;
2402 case GlobalValue::DLLExportStorageClass: Out << "dllexport "; break;
2406 static void PrintThreadLocalModel(GlobalVariable::ThreadLocalMode TLM,
2407 formatted_raw_ostream &Out) {
2409 case GlobalVariable::NotThreadLocal:
2411 case GlobalVariable::GeneralDynamicTLSModel:
2412 Out << "thread_local ";
2414 case GlobalVariable::LocalDynamicTLSModel:
2415 Out << "thread_local(localdynamic) ";
2417 case GlobalVariable::InitialExecTLSModel:
2418 Out << "thread_local(initialexec) ";
2420 case GlobalVariable::LocalExecTLSModel:
2421 Out << "thread_local(localexec) ";
2426 static void maybePrintComdat(formatted_raw_ostream &Out,
2427 const GlobalObject &GO) {
2428 const Comdat *C = GO.getComdat();
2432 if (isa<GlobalVariable>(GO))
2436 if (GO.getName() == C->getName())
2440 PrintLLVMName(Out, C->getName(), ComdatPrefix);
2444 void AssemblyWriter::printGlobal(const GlobalVariable *GV) {
2445 if (GV->isMaterializable())
2446 Out << "; Materializable\n";
2448 WriteAsOperandInternal(Out, GV, &TypePrinter, &Machine, GV->getParent());
2451 if (!GV->hasInitializer() && GV->hasExternalLinkage())
2454 PrintLinkage(GV->getLinkage(), Out);
2455 PrintVisibility(GV->getVisibility(), Out);
2456 PrintDLLStorageClass(GV->getDLLStorageClass(), Out);
2457 PrintThreadLocalModel(GV->getThreadLocalMode(), Out);
2458 if (GV->hasUnnamedAddr())
2459 Out << "unnamed_addr ";
2461 if (unsigned AddressSpace = GV->getType()->getAddressSpace())
2462 Out << "addrspace(" << AddressSpace << ") ";
2463 if (GV->isExternallyInitialized()) Out << "externally_initialized ";
2464 Out << (GV->isConstant() ? "constant " : "global ");
2465 TypePrinter.print(GV->getType()->getElementType(), Out);
2467 if (GV->hasInitializer()) {
2469 writeOperand(GV->getInitializer(), false);
2472 if (GV->hasSection()) {
2473 Out << ", section \"";
2474 PrintEscapedString(GV->getSection(), Out);
2477 maybePrintComdat(Out, *GV);
2478 if (GV->getAlignment())
2479 Out << ", align " << GV->getAlignment();
2481 printInfoComment(*GV);
2484 void AssemblyWriter::printAlias(const GlobalAlias *GA) {
2485 if (GA->isMaterializable())
2486 Out << "; Materializable\n";
2488 // Don't crash when dumping partially built GA
2490 Out << "<<nameless>> = ";
2492 PrintLLVMName(Out, GA);
2495 PrintLinkage(GA->getLinkage(), Out);
2496 PrintVisibility(GA->getVisibility(), Out);
2497 PrintDLLStorageClass(GA->getDLLStorageClass(), Out);
2498 PrintThreadLocalModel(GA->getThreadLocalMode(), Out);
2499 if (GA->hasUnnamedAddr())
2500 Out << "unnamed_addr ";
2504 const Constant *Aliasee = GA->getAliasee();
2507 TypePrinter.print(GA->getType(), Out);
2508 Out << " <<NULL ALIASEE>>";
2510 writeOperand(Aliasee, !isa<ConstantExpr>(Aliasee));
2513 printInfoComment(*GA);
2517 void AssemblyWriter::printComdat(const Comdat *C) {
2521 void AssemblyWriter::printTypeIdentities() {
2522 if (TypePrinter.NumberedTypes.empty() &&
2523 TypePrinter.NamedTypes.empty())
2528 // We know all the numbers that each type is used and we know that it is a
2529 // dense assignment. Convert the map to an index table.
2530 std::vector<StructType*> NumberedTypes(TypePrinter.NumberedTypes.size());
2531 for (DenseMap<StructType*, unsigned>::iterator I =
2532 TypePrinter.NumberedTypes.begin(), E = TypePrinter.NumberedTypes.end();
2534 assert(I->second < NumberedTypes.size() && "Didn't get a dense numbering?");
2535 NumberedTypes[I->second] = I->first;
2538 // Emit all numbered types.
2539 for (unsigned i = 0, e = NumberedTypes.size(); i != e; ++i) {
2540 Out << '%' << i << " = type ";
2542 // Make sure we print out at least one level of the type structure, so
2543 // that we do not get %2 = type %2
2544 TypePrinter.printStructBody(NumberedTypes[i], Out);
2548 for (unsigned i = 0, e = TypePrinter.NamedTypes.size(); i != e; ++i) {
2549 PrintLLVMName(Out, TypePrinter.NamedTypes[i]->getName(), LocalPrefix);
2552 // Make sure we print out at least one level of the type structure, so
2553 // that we do not get %FILE = type %FILE
2554 TypePrinter.printStructBody(TypePrinter.NamedTypes[i], Out);
2559 /// printFunction - Print all aspects of a function.
2561 void AssemblyWriter::printFunction(const Function *F) {
2562 // Print out the return type and name.
2565 if (AnnotationWriter) AnnotationWriter->emitFunctionAnnot(F, Out);
2567 if (F->isMaterializable())
2568 Out << "; Materializable\n";
2570 const AttributeSet &Attrs = F->getAttributes();
2571 if (Attrs.hasAttributes(AttributeSet::FunctionIndex)) {
2572 AttributeSet AS = Attrs.getFnAttributes();
2573 std::string AttrStr;
2576 for (unsigned E = AS.getNumSlots(); Idx != E; ++Idx)
2577 if (AS.getSlotIndex(Idx) == AttributeSet::FunctionIndex)
2580 for (AttributeSet::iterator I = AS.begin(Idx), E = AS.end(Idx);
2582 Attribute Attr = *I;
2583 if (!Attr.isStringAttribute()) {
2584 if (!AttrStr.empty()) AttrStr += ' ';
2585 AttrStr += Attr.getAsString();
2589 if (!AttrStr.empty())
2590 Out << "; Function Attrs: " << AttrStr << '\n';
2593 if (F->isDeclaration())
2598 PrintLinkage(F->getLinkage(), Out);
2599 PrintVisibility(F->getVisibility(), Out);
2600 PrintDLLStorageClass(F->getDLLStorageClass(), Out);
2602 // Print the calling convention.
2603 if (F->getCallingConv() != CallingConv::C) {
2604 PrintCallingConv(F->getCallingConv(), Out);
2608 FunctionType *FT = F->getFunctionType();
2609 if (Attrs.hasAttributes(AttributeSet::ReturnIndex))
2610 Out << Attrs.getAsString(AttributeSet::ReturnIndex) << ' ';
2611 TypePrinter.print(F->getReturnType(), Out);
2613 WriteAsOperandInternal(Out, F, &TypePrinter, &Machine, F->getParent());
2615 Machine.incorporateFunction(F);
2617 // Loop over the arguments, printing them...
2620 if (!F->isDeclaration()) {
2621 // If this isn't a declaration, print the argument names as well.
2622 for (Function::const_arg_iterator I = F->arg_begin(), E = F->arg_end();
2624 // Insert commas as we go... the first arg doesn't get a comma
2625 if (I != F->arg_begin()) Out << ", ";
2626 printArgument(I, Attrs, Idx);
2630 // Otherwise, print the types from the function type.
2631 for (unsigned i = 0, e = FT->getNumParams(); i != e; ++i) {
2632 // Insert commas as we go... the first arg doesn't get a comma
2636 TypePrinter.print(FT->getParamType(i), Out);
2638 if (Attrs.hasAttributes(i+1))
2639 Out << ' ' << Attrs.getAsString(i+1);
2643 // Finish printing arguments...
2644 if (FT->isVarArg()) {
2645 if (FT->getNumParams()) Out << ", ";
2646 Out << "..."; // Output varargs portion of signature!
2649 if (F->hasUnnamedAddr())
2650 Out << " unnamed_addr";
2651 if (Attrs.hasAttributes(AttributeSet::FunctionIndex))
2652 Out << " #" << Machine.getAttributeGroupSlot(Attrs.getFnAttributes());
2653 if (F->hasSection()) {
2654 Out << " section \"";
2655 PrintEscapedString(F->getSection(), Out);
2658 maybePrintComdat(Out, *F);
2659 if (F->getAlignment())
2660 Out << " align " << F->getAlignment();
2662 Out << " gc \"" << F->getGC() << '"';
2663 if (F->hasPrefixData()) {
2665 writeOperand(F->getPrefixData(), true);
2667 if (F->hasPrologueData()) {
2668 Out << " prologue ";
2669 writeOperand(F->getPrologueData(), true);
2672 if (F->isDeclaration()) {
2676 // Output all of the function's basic blocks.
2677 for (Function::const_iterator I = F->begin(), E = F->end(); I != E; ++I)
2680 // Output the function's use-lists.
2686 Machine.purgeFunction();
2689 /// printArgument - This member is called for every argument that is passed into
2690 /// the function. Simply print it out
2692 void AssemblyWriter::printArgument(const Argument *Arg,
2693 AttributeSet Attrs, unsigned Idx) {
2695 TypePrinter.print(Arg->getType(), Out);
2697 // Output parameter attributes list
2698 if (Attrs.hasAttributes(Idx))
2699 Out << ' ' << Attrs.getAsString(Idx);
2701 // Output name, if available...
2702 if (Arg->hasName()) {
2704 PrintLLVMName(Out, Arg);
2708 /// printBasicBlock - This member is called for each basic block in a method.
2710 void AssemblyWriter::printBasicBlock(const BasicBlock *BB) {
2711 if (BB->hasName()) { // Print out the label if it exists...
2713 PrintLLVMName(Out, BB->getName(), LabelPrefix);
2715 } else if (!BB->use_empty()) { // Don't print block # of no uses...
2716 Out << "\n; <label>:";
2717 int Slot = Machine.getLocalSlot(BB);
2724 if (!BB->getParent()) {
2725 Out.PadToColumn(50);
2726 Out << "; Error: Block without parent!";
2727 } else if (BB != &BB->getParent()->getEntryBlock()) { // Not the entry block?
2728 // Output predecessors for the block.
2729 Out.PadToColumn(50);
2731 const_pred_iterator PI = pred_begin(BB), PE = pred_end(BB);
2734 Out << " No predecessors!";
2737 writeOperand(*PI, false);
2738 for (++PI; PI != PE; ++PI) {
2740 writeOperand(*PI, false);
2747 if (AnnotationWriter) AnnotationWriter->emitBasicBlockStartAnnot(BB, Out);
2749 // Output all of the instructions in the basic block...
2750 for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I != E; ++I) {
2751 printInstructionLine(*I);
2754 if (AnnotationWriter) AnnotationWriter->emitBasicBlockEndAnnot(BB, Out);
2757 /// printInstructionLine - Print an instruction and a newline character.
2758 void AssemblyWriter::printInstructionLine(const Instruction &I) {
2759 printInstruction(I);
2763 /// printInfoComment - Print a little comment after the instruction indicating
2764 /// which slot it occupies.
2766 void AssemblyWriter::printInfoComment(const Value &V) {
2767 if (AnnotationWriter)
2768 AnnotationWriter->printInfoComment(V, Out);
2771 // This member is called for each Instruction in a function..
2772 void AssemblyWriter::printInstruction(const Instruction &I) {
2773 if (AnnotationWriter) AnnotationWriter->emitInstructionAnnot(&I, Out);
2775 // Print out indentation for an instruction.
2778 // Print out name if it exists...
2780 PrintLLVMName(Out, &I);
2782 } else if (!I.getType()->isVoidTy()) {
2783 // Print out the def slot taken.
2784 int SlotNum = Machine.getLocalSlot(&I);
2786 Out << "<badref> = ";
2788 Out << '%' << SlotNum << " = ";
2791 if (const CallInst *CI = dyn_cast<CallInst>(&I)) {
2792 if (CI->isMustTailCall())
2794 else if (CI->isTailCall())
2798 // Print out the opcode...
2799 Out << I.getOpcodeName();
2801 // If this is an atomic load or store, print out the atomic marker.
2802 if ((isa<LoadInst>(I) && cast<LoadInst>(I).isAtomic()) ||
2803 (isa<StoreInst>(I) && cast<StoreInst>(I).isAtomic()))
2806 if (isa<AtomicCmpXchgInst>(I) && cast<AtomicCmpXchgInst>(I).isWeak())
2809 // If this is a volatile operation, print out the volatile marker.
2810 if ((isa<LoadInst>(I) && cast<LoadInst>(I).isVolatile()) ||
2811 (isa<StoreInst>(I) && cast<StoreInst>(I).isVolatile()) ||
2812 (isa<AtomicCmpXchgInst>(I) && cast<AtomicCmpXchgInst>(I).isVolatile()) ||
2813 (isa<AtomicRMWInst>(I) && cast<AtomicRMWInst>(I).isVolatile()))
2816 // Print out optimization information.
2817 WriteOptimizationInfo(Out, &I);
2819 // Print out the compare instruction predicates
2820 if (const CmpInst *CI = dyn_cast<CmpInst>(&I))
2821 Out << ' ' << getPredicateText(CI->getPredicate());
2823 // Print out the atomicrmw operation
2824 if (const AtomicRMWInst *RMWI = dyn_cast<AtomicRMWInst>(&I))
2825 writeAtomicRMWOperation(Out, RMWI->getOperation());
2827 // Print out the type of the operands...
2828 const Value *Operand = I.getNumOperands() ? I.getOperand(0) : nullptr;
2830 // Special case conditional branches to swizzle the condition out to the front
2831 if (isa<BranchInst>(I) && cast<BranchInst>(I).isConditional()) {
2832 const BranchInst &BI(cast<BranchInst>(I));
2834 writeOperand(BI.getCondition(), true);
2836 writeOperand(BI.getSuccessor(0), true);
2838 writeOperand(BI.getSuccessor(1), true);
2840 } else if (isa<SwitchInst>(I)) {
2841 const SwitchInst& SI(cast<SwitchInst>(I));
2842 // Special case switch instruction to get formatting nice and correct.
2844 writeOperand(SI.getCondition(), true);
2846 writeOperand(SI.getDefaultDest(), true);
2848 for (SwitchInst::ConstCaseIt i = SI.case_begin(), e = SI.case_end();
2851 writeOperand(i.getCaseValue(), true);
2853 writeOperand(i.getCaseSuccessor(), true);
2856 } else if (isa<IndirectBrInst>(I)) {
2857 // Special case indirectbr instruction to get formatting nice and correct.
2859 writeOperand(Operand, true);
2862 for (unsigned i = 1, e = I.getNumOperands(); i != e; ++i) {
2865 writeOperand(I.getOperand(i), true);
2868 } else if (const PHINode *PN = dyn_cast<PHINode>(&I)) {
2870 TypePrinter.print(I.getType(), Out);
2873 for (unsigned op = 0, Eop = PN->getNumIncomingValues(); op < Eop; ++op) {
2874 if (op) Out << ", ";
2876 writeOperand(PN->getIncomingValue(op), false); Out << ", ";
2877 writeOperand(PN->getIncomingBlock(op), false); Out << " ]";
2879 } else if (const ExtractValueInst *EVI = dyn_cast<ExtractValueInst>(&I)) {
2881 writeOperand(I.getOperand(0), true);
2882 for (const unsigned *i = EVI->idx_begin(), *e = EVI->idx_end(); i != e; ++i)
2884 } else if (const InsertValueInst *IVI = dyn_cast<InsertValueInst>(&I)) {
2886 writeOperand(I.getOperand(0), true); Out << ", ";
2887 writeOperand(I.getOperand(1), true);
2888 for (const unsigned *i = IVI->idx_begin(), *e = IVI->idx_end(); i != e; ++i)
2890 } else if (const LandingPadInst *LPI = dyn_cast<LandingPadInst>(&I)) {
2892 TypePrinter.print(I.getType(), Out);
2893 Out << " personality ";
2894 writeOperand(I.getOperand(0), true); Out << '\n';
2896 if (LPI->isCleanup())
2899 for (unsigned i = 0, e = LPI->getNumClauses(); i != e; ++i) {
2900 if (i != 0 || LPI->isCleanup()) Out << "\n";
2901 if (LPI->isCatch(i))
2906 writeOperand(LPI->getClause(i), true);
2908 } else if (isa<ReturnInst>(I) && !Operand) {
2910 } else if (const CallInst *CI = dyn_cast<CallInst>(&I)) {
2911 // Print the calling convention being used.
2912 if (CI->getCallingConv() != CallingConv::C) {
2914 PrintCallingConv(CI->getCallingConv(), Out);
2917 Operand = CI->getCalledValue();
2918 PointerType *PTy = cast<PointerType>(Operand->getType());
2919 FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
2920 Type *RetTy = FTy->getReturnType();
2921 const AttributeSet &PAL = CI->getAttributes();
2923 if (PAL.hasAttributes(AttributeSet::ReturnIndex))
2924 Out << ' ' << PAL.getAsString(AttributeSet::ReturnIndex);
2926 // If possible, print out the short form of the call instruction. We can
2927 // only do this if the first argument is a pointer to a nonvararg function,
2928 // and if the return type is not a pointer to a function.
2931 if (!FTy->isVarArg() &&
2932 (!RetTy->isPointerTy() ||
2933 !cast<PointerType>(RetTy)->getElementType()->isFunctionTy())) {
2934 TypePrinter.print(RetTy, Out);
2936 writeOperand(Operand, false);
2938 writeOperand(Operand, true);
2941 for (unsigned op = 0, Eop = CI->getNumArgOperands(); op < Eop; ++op) {
2944 writeParamOperand(CI->getArgOperand(op), PAL, op + 1);
2947 // Emit an ellipsis if this is a musttail call in a vararg function. This
2948 // is only to aid readability, musttail calls forward varargs by default.
2949 if (CI->isMustTailCall() && CI->getParent() &&
2950 CI->getParent()->getParent() &&
2951 CI->getParent()->getParent()->isVarArg())
2955 if (PAL.hasAttributes(AttributeSet::FunctionIndex))
2956 Out << " #" << Machine.getAttributeGroupSlot(PAL.getFnAttributes());
2957 } else if (const InvokeInst *II = dyn_cast<InvokeInst>(&I)) {
2958 Operand = II->getCalledValue();
2959 PointerType *PTy = cast<PointerType>(Operand->getType());
2960 FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
2961 Type *RetTy = FTy->getReturnType();
2962 const AttributeSet &PAL = II->getAttributes();
2964 // Print the calling convention being used.
2965 if (II->getCallingConv() != CallingConv::C) {
2967 PrintCallingConv(II->getCallingConv(), Out);
2970 if (PAL.hasAttributes(AttributeSet::ReturnIndex))
2971 Out << ' ' << PAL.getAsString(AttributeSet::ReturnIndex);
2973 // If possible, print out the short form of the invoke instruction. We can
2974 // only do this if the first argument is a pointer to a nonvararg function,
2975 // and if the return type is not a pointer to a function.
2978 if (!FTy->isVarArg() &&
2979 (!RetTy->isPointerTy() ||
2980 !cast<PointerType>(RetTy)->getElementType()->isFunctionTy())) {
2981 TypePrinter.print(RetTy, Out);
2983 writeOperand(Operand, false);
2985 writeOperand(Operand, true);
2988 for (unsigned op = 0, Eop = II->getNumArgOperands(); op < Eop; ++op) {
2991 writeParamOperand(II->getArgOperand(op), PAL, op + 1);
2995 if (PAL.hasAttributes(AttributeSet::FunctionIndex))
2996 Out << " #" << Machine.getAttributeGroupSlot(PAL.getFnAttributes());
2999 writeOperand(II->getNormalDest(), true);
3001 writeOperand(II->getUnwindDest(), true);
3003 } else if (const AllocaInst *AI = dyn_cast<AllocaInst>(&I)) {
3005 if (AI->isUsedWithInAlloca())
3007 TypePrinter.print(AI->getAllocatedType(), Out);
3009 // Explicitly write the array size if the code is broken, if it's an array
3010 // allocation, or if the type is not canonical for scalar allocations. The
3011 // latter case prevents the type from mutating when round-tripping through
3013 if (!AI->getArraySize() || AI->isArrayAllocation() ||
3014 !AI->getArraySize()->getType()->isIntegerTy(32)) {
3016 writeOperand(AI->getArraySize(), true);
3018 if (AI->getAlignment()) {
3019 Out << ", align " << AI->getAlignment();
3021 } else if (isa<CastInst>(I)) {
3024 writeOperand(Operand, true); // Work with broken code
3027 TypePrinter.print(I.getType(), Out);
3028 } else if (isa<VAArgInst>(I)) {
3031 writeOperand(Operand, true); // Work with broken code
3034 TypePrinter.print(I.getType(), Out);
3035 } else if (Operand) { // Print the normal way.
3036 if (const auto *GEP = dyn_cast<GetElementPtrInst>(&I)) {
3038 TypePrinter.print(GEP->getSourceElementType(), Out);
3040 } else if (const auto *LI = dyn_cast<LoadInst>(&I)) {
3042 TypePrinter.print(LI->getType(), Out);
3046 // PrintAllTypes - Instructions who have operands of all the same type
3047 // omit the type from all but the first operand. If the instruction has
3048 // different type operands (for example br), then they are all printed.
3049 bool PrintAllTypes = false;
3050 Type *TheType = Operand->getType();
3052 // Select, Store and ShuffleVector always print all types.
3053 if (isa<SelectInst>(I) || isa<StoreInst>(I) || isa<ShuffleVectorInst>(I)
3054 || isa<ReturnInst>(I)) {
3055 PrintAllTypes = true;
3057 for (unsigned i = 1, E = I.getNumOperands(); i != E; ++i) {
3058 Operand = I.getOperand(i);
3059 // note that Operand shouldn't be null, but the test helps make dump()
3060 // more tolerant of malformed IR
3061 if (Operand && Operand->getType() != TheType) {
3062 PrintAllTypes = true; // We have differing types! Print them all!
3068 if (!PrintAllTypes) {
3070 TypePrinter.print(TheType, Out);
3074 for (unsigned i = 0, E = I.getNumOperands(); i != E; ++i) {
3076 writeOperand(I.getOperand(i), PrintAllTypes);
3080 // Print atomic ordering/alignment for memory operations
3081 if (const LoadInst *LI = dyn_cast<LoadInst>(&I)) {
3083 writeAtomic(LI->getOrdering(), LI->getSynchScope());
3084 if (LI->getAlignment())
3085 Out << ", align " << LI->getAlignment();
3086 } else if (const StoreInst *SI = dyn_cast<StoreInst>(&I)) {
3088 writeAtomic(SI->getOrdering(), SI->getSynchScope());
3089 if (SI->getAlignment())
3090 Out << ", align " << SI->getAlignment();
3091 } else if (const AtomicCmpXchgInst *CXI = dyn_cast<AtomicCmpXchgInst>(&I)) {
3092 writeAtomicCmpXchg(CXI->getSuccessOrdering(), CXI->getFailureOrdering(),
3093 CXI->getSynchScope());
3094 } else if (const AtomicRMWInst *RMWI = dyn_cast<AtomicRMWInst>(&I)) {
3095 writeAtomic(RMWI->getOrdering(), RMWI->getSynchScope());
3096 } else if (const FenceInst *FI = dyn_cast<FenceInst>(&I)) {
3097 writeAtomic(FI->getOrdering(), FI->getSynchScope());
3100 // Print Metadata info.
3101 SmallVector<std::pair<unsigned, MDNode *>, 4> InstMD;
3102 I.getAllMetadata(InstMD);
3103 if (!InstMD.empty()) {
3104 SmallVector<StringRef, 8> MDNames;
3105 I.getType()->getContext().getMDKindNames(MDNames);
3106 for (unsigned i = 0, e = InstMD.size(); i != e; ++i) {
3107 unsigned Kind = InstMD[i].first;
3108 if (Kind < MDNames.size()) {
3109 Out << ", !" << MDNames[Kind];
3111 Out << ", !<unknown kind #" << Kind << ">";
3114 WriteAsOperandInternal(Out, InstMD[i].second, &TypePrinter, &Machine,
3118 printInfoComment(I);
3121 void AssemblyWriter::writeMDNode(unsigned Slot, const MDNode *Node) {
3122 Out << '!' << Slot << " = ";
3123 printMDNodeBody(Node);
3127 void AssemblyWriter::writeAllMDNodes() {
3128 SmallVector<const MDNode *, 16> Nodes;
3129 Nodes.resize(Machine.mdn_size());
3130 for (SlotTracker::mdn_iterator I = Machine.mdn_begin(), E = Machine.mdn_end();
3132 Nodes[I->second] = cast<MDNode>(I->first);
3134 for (unsigned i = 0, e = Nodes.size(); i != e; ++i) {
3135 writeMDNode(i, Nodes[i]);
3139 void AssemblyWriter::printMDNodeBody(const MDNode *Node) {
3140 WriteMDNodeBodyInternal(Out, Node, &TypePrinter, &Machine, TheModule);
3143 void AssemblyWriter::writeAllAttributeGroups() {
3144 std::vector<std::pair<AttributeSet, unsigned> > asVec;
3145 asVec.resize(Machine.as_size());
3147 for (SlotTracker::as_iterator I = Machine.as_begin(), E = Machine.as_end();
3149 asVec[I->second] = *I;
3151 for (std::vector<std::pair<AttributeSet, unsigned> >::iterator
3152 I = asVec.begin(), E = asVec.end(); I != E; ++I)
3153 Out << "attributes #" << I->second << " = { "
3154 << I->first.getAsString(AttributeSet::FunctionIndex, true) << " }\n";
3157 void AssemblyWriter::printUseListOrder(const UseListOrder &Order) {
3158 bool IsInFunction = Machine.getFunction();
3162 Out << "uselistorder";
3163 if (const BasicBlock *BB =
3164 IsInFunction ? nullptr : dyn_cast<BasicBlock>(Order.V)) {
3166 writeOperand(BB->getParent(), false);
3168 writeOperand(BB, false);
3171 writeOperand(Order.V, true);
3175 assert(Order.Shuffle.size() >= 2 && "Shuffle too small");
3176 Out << Order.Shuffle[0];
3177 for (unsigned I = 1, E = Order.Shuffle.size(); I != E; ++I)
3178 Out << ", " << Order.Shuffle[I];
3182 void AssemblyWriter::printUseLists(const Function *F) {
3184 [&]() { return !UseListOrders.empty() && UseListOrders.back().F == F; };
3189 Out << "\n; uselistorder directives\n";
3191 printUseListOrder(UseListOrders.back());
3192 UseListOrders.pop_back();
3196 //===----------------------------------------------------------------------===//
3197 // External Interface declarations
3198 //===----------------------------------------------------------------------===//
3200 void Module::print(raw_ostream &ROS, AssemblyAnnotationWriter *AAW) const {
3201 SlotTracker SlotTable(this);
3202 formatted_raw_ostream OS(ROS);
3203 AssemblyWriter W(OS, SlotTable, this, AAW);
3204 W.printModule(this);
3207 void NamedMDNode::print(raw_ostream &ROS) const {
3208 SlotTracker SlotTable(getParent());
3209 formatted_raw_ostream OS(ROS);
3210 AssemblyWriter W(OS, SlotTable, getParent(), nullptr);
3211 W.printNamedMDNode(this);
3214 void Comdat::print(raw_ostream &ROS) const {
3215 PrintLLVMName(ROS, getName(), ComdatPrefix);
3216 ROS << " = comdat ";
3218 switch (getSelectionKind()) {
3222 case Comdat::ExactMatch:
3223 ROS << "exactmatch";
3225 case Comdat::Largest:
3228 case Comdat::NoDuplicates:
3229 ROS << "noduplicates";
3231 case Comdat::SameSize:
3239 void Type::print(raw_ostream &OS) const {
3241 TP.print(const_cast<Type*>(this), OS);
3243 // If the type is a named struct type, print the body as well.
3244 if (StructType *STy = dyn_cast<StructType>(const_cast<Type*>(this)))
3245 if (!STy->isLiteral()) {
3247 TP.printStructBody(STy, OS);
3251 static bool isReferencingMDNode(const Instruction &I) {
3252 if (const auto *CI = dyn_cast<CallInst>(&I))
3253 if (Function *F = CI->getCalledFunction())
3254 if (F->isIntrinsic())
3255 for (auto &Op : I.operands())
3256 if (auto *V = dyn_cast_or_null<MetadataAsValue>(Op))
3257 if (isa<MDNode>(V->getMetadata()))
3262 void Value::print(raw_ostream &ROS) const {
3263 formatted_raw_ostream OS(ROS);
3264 if (const Instruction *I = dyn_cast<Instruction>(this)) {
3265 const Function *F = I->getParent() ? I->getParent()->getParent() : nullptr;
3266 SlotTracker SlotTable(
3268 /* ShouldInitializeAllMetadata */ isReferencingMDNode(*I));
3269 AssemblyWriter W(OS, SlotTable, getModuleFromVal(I), nullptr);
3270 W.printInstruction(*I);
3271 } else if (const BasicBlock *BB = dyn_cast<BasicBlock>(this)) {
3272 SlotTracker SlotTable(BB->getParent());
3273 AssemblyWriter W(OS, SlotTable, getModuleFromVal(BB), nullptr);
3274 W.printBasicBlock(BB);
3275 } else if (const GlobalValue *GV = dyn_cast<GlobalValue>(this)) {
3276 SlotTracker SlotTable(GV->getParent(),
3277 /* ShouldInitializeAllMetadata */ isa<Function>(GV));
3278 AssemblyWriter W(OS, SlotTable, GV->getParent(), nullptr);
3279 if (const GlobalVariable *V = dyn_cast<GlobalVariable>(GV))
3281 else if (const Function *F = dyn_cast<Function>(GV))
3284 W.printAlias(cast<GlobalAlias>(GV));
3285 } else if (const MetadataAsValue *V = dyn_cast<MetadataAsValue>(this)) {
3286 V->getMetadata()->print(ROS, getModuleFromVal(V));
3287 } else if (const Constant *C = dyn_cast<Constant>(this)) {
3288 TypePrinting TypePrinter;
3289 TypePrinter.print(C->getType(), OS);
3291 WriteConstantInternal(OS, C, TypePrinter, nullptr, nullptr);
3292 } else if (isa<InlineAsm>(this) || isa<Argument>(this)) {
3293 this->printAsOperand(OS);
3295 llvm_unreachable("Unknown value to print out!");
3299 void Value::printAsOperand(raw_ostream &O, bool PrintType, const Module *M) const {
3300 // Fast path: Don't construct and populate a TypePrinting object if we
3301 // won't be needing any types printed.
3302 bool IsMetadata = isa<MetadataAsValue>(this);
3303 if (!PrintType && ((!isa<Constant>(this) && !IsMetadata) || hasName() ||
3304 isa<GlobalValue>(this))) {
3305 WriteAsOperandInternal(O, this, nullptr, nullptr, M);
3310 M = getModuleFromVal(this);
3312 TypePrinting TypePrinter;
3314 TypePrinter.incorporateTypes(*M);
3316 TypePrinter.print(getType(), O);
3320 SlotTracker Machine(M, /* ShouldInitializeAllMetadata */ IsMetadata);
3321 WriteAsOperandInternal(O, this, &TypePrinter, &Machine, M);
3324 static void printMetadataImpl(raw_ostream &ROS, const Metadata &MD,
3325 const Module *M, bool OnlyAsOperand) {
3326 formatted_raw_ostream OS(ROS);
3328 auto *N = dyn_cast<MDNode>(&MD);
3329 TypePrinting TypePrinter;
3330 SlotTracker Machine(M, /* ShouldInitializeAllMetadata */ N);
3332 TypePrinter.incorporateTypes(*M);
3334 WriteAsOperandInternal(OS, &MD, &TypePrinter, &Machine, M,
3335 /* FromValue */ true);
3336 if (OnlyAsOperand || !N)
3340 WriteMDNodeBodyInternal(OS, N, &TypePrinter, &Machine, M);
3343 void Metadata::printAsOperand(raw_ostream &OS, const Module *M) const {
3344 printMetadataImpl(OS, *this, M, /* OnlyAsOperand */ true);
3347 void Metadata::print(raw_ostream &OS, const Module *M) const {
3348 printMetadataImpl(OS, *this, M, /* OnlyAsOperand */ false);
3351 // Value::dump - allow easy printing of Values from the debugger.
3353 void Value::dump() const { print(dbgs()); dbgs() << '\n'; }
3355 // Type::dump - allow easy printing of Types from the debugger.
3357 void Type::dump() const { print(dbgs()); dbgs() << '\n'; }
3359 // Module::dump() - Allow printing of Modules from the debugger.
3361 void Module::dump() const { print(dbgs(), nullptr); }
3363 // \brief Allow printing of Comdats from the debugger.
3365 void Comdat::dump() const { print(dbgs()); }
3367 // NamedMDNode::dump() - Allow printing of NamedMDNodes from the debugger.
3369 void NamedMDNode::dump() const { print(dbgs()); }
3372 void Metadata::dump() const { dump(nullptr); }
3375 void Metadata::dump(const Module *M) const {