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 "AsmWriter.h"
18 #include "llvm/ADT/DenseMap.h"
19 #include "llvm/ADT/STLExtras.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/ValueSymbolTable.h"
36 #include "llvm/Support/Debug.h"
37 #include "llvm/Support/Dwarf.h"
38 #include "llvm/Support/ErrorHandling.h"
39 #include "llvm/Support/FormattedStream.h"
40 #include "llvm/Support/MathExtras.h"
45 // Make virtual table appear in this compilation unit.
46 AssemblyAnnotationWriter::~AssemblyAnnotationWriter() {}
48 //===----------------------------------------------------------------------===//
50 //===----------------------------------------------------------------------===//
54 DenseMap<const Value *, std::pair<unsigned, bool>> IDs;
56 unsigned size() const { return IDs.size(); }
57 std::pair<unsigned, bool> &operator[](const Value *V) { return IDs[V]; }
58 std::pair<unsigned, bool> lookup(const Value *V) const {
61 void index(const Value *V) {
62 // Explicitly sequence get-size and insert-value operations to avoid UB.
63 unsigned ID = IDs.size() + 1;
69 static void orderValue(const Value *V, OrderMap &OM) {
70 if (OM.lookup(V).first)
73 if (const Constant *C = dyn_cast<Constant>(V))
74 if (C->getNumOperands() && !isa<GlobalValue>(C))
75 for (const Value *Op : C->operands())
76 if (!isa<BasicBlock>(Op) && !isa<GlobalValue>(Op))
79 // Note: we cannot cache this lookup above, since inserting into the map
80 // changes the map's size, and thus affects the other IDs.
84 static OrderMap orderModule(const Module *M) {
85 // This needs to match the order used by ValueEnumerator::ValueEnumerator()
86 // and ValueEnumerator::incorporateFunction().
89 for (const GlobalVariable &G : M->globals()) {
90 if (G.hasInitializer())
91 if (!isa<GlobalValue>(G.getInitializer()))
92 orderValue(G.getInitializer(), OM);
95 for (const GlobalAlias &A : M->aliases()) {
96 if (!isa<GlobalValue>(A.getAliasee()))
97 orderValue(A.getAliasee(), OM);
100 for (const Function &F : *M) {
101 if (F.hasPrefixData())
102 if (!isa<GlobalValue>(F.getPrefixData()))
103 orderValue(F.getPrefixData(), OM);
105 if (F.hasPrologueData())
106 if (!isa<GlobalValue>(F.getPrologueData()))
107 orderValue(F.getPrologueData(), OM);
111 if (F.isDeclaration())
114 for (const Argument &A : F.args())
116 for (const BasicBlock &BB : F) {
118 for (const Instruction &I : BB) {
119 for (const Value *Op : I.operands())
120 if ((isa<Constant>(*Op) && !isa<GlobalValue>(*Op)) ||
130 static void predictValueUseListOrderImpl(const Value *V, const Function *F,
131 unsigned ID, const OrderMap &OM,
132 UseListOrderStack &Stack) {
133 // Predict use-list order for this one.
134 typedef std::pair<const Use *, unsigned> Entry;
135 SmallVector<Entry, 64> List;
136 for (const Use &U : V->uses())
137 // Check if this user will be serialized.
138 if (OM.lookup(U.getUser()).first)
139 List.push_back(std::make_pair(&U, List.size()));
142 // We may have lost some users.
146 !isa<GlobalVariable>(V) && !isa<Function>(V) && !isa<BasicBlock>(V);
147 if (auto *BA = dyn_cast<BlockAddress>(V))
148 ID = OM.lookup(BA->getBasicBlock()).first;
149 std::sort(List.begin(), List.end(), [&](const Entry &L, const Entry &R) {
150 const Use *LU = L.first;
151 const Use *RU = R.first;
155 auto LID = OM.lookup(LU->getUser()).first;
156 auto RID = OM.lookup(RU->getUser()).first;
158 // If ID is 4, then expect: 7 6 5 1 2 3.
172 // LID and RID are equal, so we have different operands of the same user.
173 // Assume operands are added in order for all instructions.
176 return LU->getOperandNo() < RU->getOperandNo();
177 return LU->getOperandNo() > RU->getOperandNo();
181 List.begin(), List.end(),
182 [](const Entry &L, const Entry &R) { return L.second < R.second; }))
183 // Order is already correct.
186 // Store the shuffle.
187 Stack.emplace_back(V, F, List.size());
188 assert(List.size() == Stack.back().Shuffle.size() && "Wrong size");
189 for (size_t I = 0, E = List.size(); I != E; ++I)
190 Stack.back().Shuffle[I] = List[I].second;
193 static void predictValueUseListOrder(const Value *V, const Function *F,
194 OrderMap &OM, UseListOrderStack &Stack) {
195 auto &IDPair = OM[V];
196 assert(IDPair.first && "Unmapped value");
198 // Already predicted.
201 // Do the actual prediction.
202 IDPair.second = true;
203 if (!V->use_empty() && std::next(V->use_begin()) != V->use_end())
204 predictValueUseListOrderImpl(V, F, IDPair.first, OM, Stack);
206 // Recursive descent into constants.
207 if (const Constant *C = dyn_cast<Constant>(V))
208 if (C->getNumOperands()) // Visit GlobalValues.
209 for (const Value *Op : C->operands())
210 if (isa<Constant>(Op)) // Visit GlobalValues.
211 predictValueUseListOrder(Op, F, OM, Stack);
214 static UseListOrderStack predictUseListOrder(const Module *M) {
215 OrderMap OM = orderModule(M);
217 // Use-list orders need to be serialized after all the users have been added
218 // to a value, or else the shuffles will be incomplete. Store them per
219 // function in a stack.
221 // Aside from function order, the order of values doesn't matter much here.
222 UseListOrderStack Stack;
224 // We want to visit the functions backward now so we can list function-local
225 // constants in the last Function they're used in. Module-level constants
226 // have already been visited above.
227 for (auto I = M->rbegin(), E = M->rend(); I != E; ++I) {
228 const Function &F = *I;
229 if (F.isDeclaration())
231 for (const BasicBlock &BB : F)
232 predictValueUseListOrder(&BB, &F, OM, Stack);
233 for (const Argument &A : F.args())
234 predictValueUseListOrder(&A, &F, OM, Stack);
235 for (const BasicBlock &BB : F)
236 for (const Instruction &I : BB)
237 for (const Value *Op : I.operands())
238 if (isa<Constant>(*Op) || isa<InlineAsm>(*Op)) // Visit GlobalValues.
239 predictValueUseListOrder(Op, &F, OM, Stack);
240 for (const BasicBlock &BB : F)
241 for (const Instruction &I : BB)
242 predictValueUseListOrder(&I, &F, OM, Stack);
245 // Visit globals last.
246 for (const GlobalVariable &G : M->globals())
247 predictValueUseListOrder(&G, nullptr, OM, Stack);
248 for (const Function &F : *M)
249 predictValueUseListOrder(&F, nullptr, OM, Stack);
250 for (const GlobalAlias &A : M->aliases())
251 predictValueUseListOrder(&A, nullptr, OM, Stack);
252 for (const GlobalVariable &G : M->globals())
253 if (G.hasInitializer())
254 predictValueUseListOrder(G.getInitializer(), nullptr, OM, Stack);
255 for (const GlobalAlias &A : M->aliases())
256 predictValueUseListOrder(A.getAliasee(), nullptr, OM, Stack);
257 for (const Function &F : *M)
258 if (F.hasPrefixData())
259 predictValueUseListOrder(F.getPrefixData(), nullptr, OM, Stack);
264 static const Module *getModuleFromVal(const Value *V) {
265 if (const Argument *MA = dyn_cast<Argument>(V))
266 return MA->getParent() ? MA->getParent()->getParent() : nullptr;
268 if (const BasicBlock *BB = dyn_cast<BasicBlock>(V))
269 return BB->getParent() ? BB->getParent()->getParent() : nullptr;
271 if (const Instruction *I = dyn_cast<Instruction>(V)) {
272 const Function *M = I->getParent() ? I->getParent()->getParent() : nullptr;
273 return M ? M->getParent() : nullptr;
276 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V))
277 return GV->getParent();
279 if (const auto *MAV = dyn_cast<MetadataAsValue>(V)) {
280 for (const User *U : MAV->users())
281 if (isa<Instruction>(U))
282 if (const Module *M = getModuleFromVal(U))
290 static void PrintCallingConv(unsigned cc, raw_ostream &Out) {
292 default: Out << "cc" << cc; break;
293 case CallingConv::Fast: Out << "fastcc"; break;
294 case CallingConv::Cold: Out << "coldcc"; break;
295 case CallingConv::WebKit_JS: Out << "webkit_jscc"; break;
296 case CallingConv::AnyReg: Out << "anyregcc"; break;
297 case CallingConv::PreserveMost: Out << "preserve_mostcc"; break;
298 case CallingConv::PreserveAll: Out << "preserve_allcc"; break;
299 case CallingConv::GHC: Out << "ghccc"; break;
300 case CallingConv::X86_StdCall: Out << "x86_stdcallcc"; break;
301 case CallingConv::X86_FastCall: Out << "x86_fastcallcc"; break;
302 case CallingConv::X86_ThisCall: Out << "x86_thiscallcc"; break;
303 case CallingConv::X86_VectorCall:Out << "x86_vectorcallcc"; break;
304 case CallingConv::Intel_OCL_BI: Out << "intel_ocl_bicc"; break;
305 case CallingConv::ARM_APCS: Out << "arm_apcscc"; break;
306 case CallingConv::ARM_AAPCS: Out << "arm_aapcscc"; break;
307 case CallingConv::ARM_AAPCS_VFP: Out << "arm_aapcs_vfpcc"; break;
308 case CallingConv::MSP430_INTR: Out << "msp430_intrcc"; break;
309 case CallingConv::PTX_Kernel: Out << "ptx_kernel"; break;
310 case CallingConv::PTX_Device: Out << "ptx_device"; break;
311 case CallingConv::X86_64_SysV: Out << "x86_64_sysvcc"; break;
312 case CallingConv::X86_64_Win64: Out << "x86_64_win64cc"; break;
313 case CallingConv::SPIR_FUNC: Out << "spir_func"; break;
314 case CallingConv::SPIR_KERNEL: Out << "spir_kernel"; break;
318 // PrintEscapedString - Print each character of the specified string, escaping
319 // it if it is not printable or if it is an escape char.
320 static void PrintEscapedString(StringRef Name, raw_ostream &Out) {
321 for (unsigned i = 0, e = Name.size(); i != e; ++i) {
322 unsigned char C = Name[i];
323 if (isprint(C) && C != '\\' && C != '"')
326 Out << '\\' << hexdigit(C >> 4) << hexdigit(C & 0x0F);
338 /// PrintLLVMName - Turn the specified name into an 'LLVM name', which is either
339 /// prefixed with % (if the string only contains simple characters) or is
340 /// surrounded with ""'s (if it has special chars in it). Print it out.
341 static void PrintLLVMName(raw_ostream &OS, StringRef Name, PrefixType Prefix) {
342 assert(!Name.empty() && "Cannot get empty name!");
344 case NoPrefix: break;
345 case GlobalPrefix: OS << '@'; break;
346 case ComdatPrefix: OS << '$'; break;
347 case LabelPrefix: break;
348 case LocalPrefix: OS << '%'; break;
351 // Scan the name to see if it needs quotes first.
352 bool NeedsQuotes = isdigit(static_cast<unsigned char>(Name[0]));
354 for (unsigned i = 0, e = Name.size(); i != e; ++i) {
355 // By making this unsigned, the value passed in to isalnum will always be
356 // in the range 0-255. This is important when building with MSVC because
357 // its implementation will assert. This situation can arise when dealing
358 // with UTF-8 multibyte characters.
359 unsigned char C = Name[i];
360 if (!isalnum(static_cast<unsigned char>(C)) && C != '-' && C != '.' &&
368 // If we didn't need any quotes, just write out the name in one blast.
374 // Okay, we need quotes. Output the quotes and escape any scary characters as
377 PrintEscapedString(Name, OS);
381 /// PrintLLVMName - Turn the specified name into an 'LLVM name', which is either
382 /// prefixed with % (if the string only contains simple characters) or is
383 /// surrounded with ""'s (if it has special chars in it). Print it out.
384 static void PrintLLVMName(raw_ostream &OS, const Value *V) {
385 PrintLLVMName(OS, V->getName(),
386 isa<GlobalValue>(V) ? GlobalPrefix : LocalPrefix);
392 void TypePrinting::incorporateTypes(const Module &M) {
393 NamedTypes.run(M, false);
395 // The list of struct types we got back includes all the struct types, split
396 // the unnamed ones out to a numbering and remove the anonymous structs.
397 unsigned NextNumber = 0;
399 std::vector<StructType*>::iterator NextToUse = NamedTypes.begin(), I, E;
400 for (I = NamedTypes.begin(), E = NamedTypes.end(); I != E; ++I) {
401 StructType *STy = *I;
403 // Ignore anonymous types.
404 if (STy->isLiteral())
407 if (STy->getName().empty())
408 NumberedTypes[STy] = NextNumber++;
413 NamedTypes.erase(NextToUse, NamedTypes.end());
417 /// CalcTypeName - Write the specified type to the specified raw_ostream, making
418 /// use of type names or up references to shorten the type name where possible.
419 void TypePrinting::print(Type *Ty, raw_ostream &OS) {
420 switch (Ty->getTypeID()) {
421 case Type::VoidTyID: OS << "void"; return;
422 case Type::HalfTyID: OS << "half"; return;
423 case Type::FloatTyID: OS << "float"; return;
424 case Type::DoubleTyID: OS << "double"; return;
425 case Type::X86_FP80TyID: OS << "x86_fp80"; return;
426 case Type::FP128TyID: OS << "fp128"; return;
427 case Type::PPC_FP128TyID: OS << "ppc_fp128"; return;
428 case Type::LabelTyID: OS << "label"; return;
429 case Type::MetadataTyID: OS << "metadata"; return;
430 case Type::X86_MMXTyID: OS << "x86_mmx"; return;
431 case Type::IntegerTyID:
432 OS << 'i' << cast<IntegerType>(Ty)->getBitWidth();
435 case Type::FunctionTyID: {
436 FunctionType *FTy = cast<FunctionType>(Ty);
437 print(FTy->getReturnType(), OS);
439 for (FunctionType::param_iterator I = FTy->param_begin(),
440 E = FTy->param_end(); I != E; ++I) {
441 if (I != FTy->param_begin())
445 if (FTy->isVarArg()) {
446 if (FTy->getNumParams()) OS << ", ";
452 case Type::StructTyID: {
453 StructType *STy = cast<StructType>(Ty);
455 if (STy->isLiteral())
456 return printStructBody(STy, OS);
458 if (!STy->getName().empty())
459 return PrintLLVMName(OS, STy->getName(), LocalPrefix);
461 DenseMap<StructType*, unsigned>::iterator I = NumberedTypes.find(STy);
462 if (I != NumberedTypes.end())
463 OS << '%' << I->second;
464 else // Not enumerated, print the hex address.
465 OS << "%\"type " << STy << '\"';
468 case Type::PointerTyID: {
469 PointerType *PTy = cast<PointerType>(Ty);
470 print(PTy->getElementType(), OS);
471 if (unsigned AddressSpace = PTy->getAddressSpace())
472 OS << " addrspace(" << AddressSpace << ')';
476 case Type::ArrayTyID: {
477 ArrayType *ATy = cast<ArrayType>(Ty);
478 OS << '[' << ATy->getNumElements() << " x ";
479 print(ATy->getElementType(), OS);
483 case Type::VectorTyID: {
484 VectorType *PTy = cast<VectorType>(Ty);
485 OS << "<" << PTy->getNumElements() << " x ";
486 print(PTy->getElementType(), OS);
491 llvm_unreachable("Invalid TypeID");
494 void TypePrinting::printStructBody(StructType *STy, raw_ostream &OS) {
495 if (STy->isOpaque()) {
503 if (STy->getNumElements() == 0) {
506 StructType::element_iterator I = STy->element_begin();
509 for (StructType::element_iterator E = STy->element_end(); I != E; ++I) {
520 //===----------------------------------------------------------------------===//
521 // SlotTracker Class: Enumerate slot numbers for unnamed values
522 //===----------------------------------------------------------------------===//
523 /// This class provides computation of slot numbers for LLVM Assembly writing.
527 /// ValueMap - A mapping of Values to slot numbers.
528 typedef DenseMap<const Value*, unsigned> ValueMap;
531 /// TheModule - The module for which we are holding slot numbers.
532 const Module* TheModule;
534 /// TheFunction - The function for which we are holding slot numbers.
535 const Function* TheFunction;
536 bool FunctionProcessed;
537 bool ShouldInitializeAllMetadata;
539 /// mMap - The slot map for the module level data.
543 /// fMap - The slot map for the function level data.
547 /// mdnMap - Map for MDNodes.
548 DenseMap<const MDNode*, unsigned> mdnMap;
551 /// asMap - The slot map for attribute sets.
552 DenseMap<AttributeSet, unsigned> asMap;
555 /// Construct from a module.
557 /// If \c ShouldInitializeAllMetadata, initializes all metadata in all
558 /// functions, giving correct numbering for metadata referenced only from
559 /// within a function (even if no functions have been initialized).
560 explicit SlotTracker(const Module *M,
561 bool ShouldInitializeAllMetadata = false);
562 /// Construct from a function, starting out in incorp state.
564 /// If \c ShouldInitializeAllMetadata, initializes all metadata in all
565 /// functions, giving correct numbering for metadata referenced only from
566 /// within a function (even if no functions have been initialized).
567 explicit SlotTracker(const Function *F,
568 bool ShouldInitializeAllMetadata = false);
570 /// Return the slot number of the specified value in it's type
571 /// plane. If something is not in the SlotTracker, return -1.
572 int getLocalSlot(const Value *V);
573 int getGlobalSlot(const GlobalValue *V);
574 int getMetadataSlot(const MDNode *N);
575 int getAttributeGroupSlot(AttributeSet AS);
577 /// If you'd like to deal with a function instead of just a module, use
578 /// this method to get its data into the SlotTracker.
579 void incorporateFunction(const Function *F) {
581 FunctionProcessed = false;
584 const Function *getFunction() const { return TheFunction; }
586 /// After calling incorporateFunction, use this method to remove the
587 /// most recently incorporated function from the SlotTracker. This
588 /// will reset the state of the machine back to just the module contents.
589 void purgeFunction();
591 /// MDNode map iterators.
592 typedef DenseMap<const MDNode*, unsigned>::iterator mdn_iterator;
593 mdn_iterator mdn_begin() { return mdnMap.begin(); }
594 mdn_iterator mdn_end() { return mdnMap.end(); }
595 unsigned mdn_size() const { return mdnMap.size(); }
596 bool mdn_empty() const { return mdnMap.empty(); }
598 /// AttributeSet map iterators.
599 typedef DenseMap<AttributeSet, unsigned>::iterator as_iterator;
600 as_iterator as_begin() { return asMap.begin(); }
601 as_iterator as_end() { return asMap.end(); }
602 unsigned as_size() const { return asMap.size(); }
603 bool as_empty() const { return asMap.empty(); }
605 /// This function does the actual initialization.
606 inline void initialize();
608 // Implementation Details
610 /// CreateModuleSlot - Insert the specified GlobalValue* into the slot table.
611 void CreateModuleSlot(const GlobalValue *V);
613 /// CreateMetadataSlot - Insert the specified MDNode* into the slot table.
614 void CreateMetadataSlot(const MDNode *N);
616 /// CreateFunctionSlot - Insert the specified Value* into the slot table.
617 void CreateFunctionSlot(const Value *V);
619 /// \brief Insert the specified AttributeSet into the slot table.
620 void CreateAttributeSetSlot(AttributeSet AS);
622 /// Add all of the module level global variables (and their initializers)
623 /// and function declarations, but not the contents of those functions.
624 void processModule();
626 /// Add all of the functions arguments, basic blocks, and instructions.
627 void processFunction();
629 /// Add all of the metadata from a function.
630 void processFunctionMetadata(const Function &F);
632 /// Add all of the metadata from an instruction.
633 void processInstructionMetadata(const Instruction &I);
635 SlotTracker(const SlotTracker &) = delete;
636 void operator=(const SlotTracker &) = delete;
639 SlotTracker *createSlotTracker(const Module *M) {
640 return new SlotTracker(M);
643 static SlotTracker *createSlotTracker(const Value *V) {
644 if (const Argument *FA = dyn_cast<Argument>(V))
645 return new SlotTracker(FA->getParent());
647 if (const Instruction *I = dyn_cast<Instruction>(V))
649 return new SlotTracker(I->getParent()->getParent());
651 if (const BasicBlock *BB = dyn_cast<BasicBlock>(V))
652 return new SlotTracker(BB->getParent());
654 if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(V))
655 return new SlotTracker(GV->getParent());
657 if (const GlobalAlias *GA = dyn_cast<GlobalAlias>(V))
658 return new SlotTracker(GA->getParent());
660 if (const Function *Func = dyn_cast<Function>(V))
661 return new SlotTracker(Func);
667 #define ST_DEBUG(X) dbgs() << X
672 // Module level constructor. Causes the contents of the Module (sans functions)
673 // to be added to the slot table.
674 SlotTracker::SlotTracker(const Module *M, bool ShouldInitializeAllMetadata)
675 : TheModule(M), TheFunction(nullptr), FunctionProcessed(false),
676 ShouldInitializeAllMetadata(ShouldInitializeAllMetadata), mNext(0),
677 fNext(0), mdnNext(0), asNext(0) {}
679 // Function level constructor. Causes the contents of the Module and the one
680 // function provided to be added to the slot table.
681 SlotTracker::SlotTracker(const Function *F, bool ShouldInitializeAllMetadata)
682 : TheModule(F ? F->getParent() : nullptr), TheFunction(F),
683 FunctionProcessed(false),
684 ShouldInitializeAllMetadata(ShouldInitializeAllMetadata), mNext(0),
685 fNext(0), mdnNext(0), asNext(0) {}
687 inline void SlotTracker::initialize() {
690 TheModule = nullptr; ///< Prevent re-processing next time we're called.
693 if (TheFunction && !FunctionProcessed)
697 // Iterate through all the global variables, functions, and global
698 // variable initializers and create slots for them.
699 void SlotTracker::processModule() {
700 ST_DEBUG("begin processModule!\n");
702 // Add all of the unnamed global variables to the value table.
703 for (Module::const_global_iterator I = TheModule->global_begin(),
704 E = TheModule->global_end(); I != E; ++I) {
709 // Add metadata used by named metadata.
710 for (Module::const_named_metadata_iterator
711 I = TheModule->named_metadata_begin(),
712 E = TheModule->named_metadata_end(); I != E; ++I) {
713 const NamedMDNode *NMD = I;
714 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i)
715 CreateMetadataSlot(NMD->getOperand(i));
718 for (Module::const_iterator I = TheModule->begin(), E = TheModule->end();
721 // Add all the unnamed functions to the table.
724 if (ShouldInitializeAllMetadata)
725 processFunctionMetadata(*I);
727 // Add all the function attributes to the table.
728 // FIXME: Add attributes of other objects?
729 AttributeSet FnAttrs = I->getAttributes().getFnAttributes();
730 if (FnAttrs.hasAttributes(AttributeSet::FunctionIndex))
731 CreateAttributeSetSlot(FnAttrs);
734 ST_DEBUG("end processModule!\n");
737 // Process the arguments, basic blocks, and instructions of a function.
738 void SlotTracker::processFunction() {
739 ST_DEBUG("begin processFunction!\n");
742 // Add all the function arguments with no names.
743 for(Function::const_arg_iterator AI = TheFunction->arg_begin(),
744 AE = TheFunction->arg_end(); AI != AE; ++AI)
746 CreateFunctionSlot(AI);
748 ST_DEBUG("Inserting Instructions:\n");
750 // Add all of the basic blocks and instructions with no names.
751 for (auto &BB : *TheFunction) {
753 CreateFunctionSlot(&BB);
756 if (!I.getType()->isVoidTy() && !I.hasName())
757 CreateFunctionSlot(&I);
759 processInstructionMetadata(I);
761 // We allow direct calls to any llvm.foo function here, because the
762 // target may not be linked into the optimizer.
763 if (const CallInst *CI = dyn_cast<CallInst>(&I)) {
764 // Add all the call attributes to the table.
765 AttributeSet Attrs = CI->getAttributes().getFnAttributes();
766 if (Attrs.hasAttributes(AttributeSet::FunctionIndex))
767 CreateAttributeSetSlot(Attrs);
768 } else if (const InvokeInst *II = dyn_cast<InvokeInst>(&I)) {
769 // Add all the call attributes to the table.
770 AttributeSet Attrs = II->getAttributes().getFnAttributes();
771 if (Attrs.hasAttributes(AttributeSet::FunctionIndex))
772 CreateAttributeSetSlot(Attrs);
777 FunctionProcessed = true;
779 ST_DEBUG("end processFunction!\n");
782 void SlotTracker::processFunctionMetadata(const Function &F) {
785 processInstructionMetadata(I);
788 void SlotTracker::processInstructionMetadata(const Instruction &I) {
789 // Process metadata used directly by intrinsics.
790 if (const CallInst *CI = dyn_cast<CallInst>(&I))
791 if (Function *F = CI->getCalledFunction())
792 if (F->isIntrinsic())
793 for (auto &Op : I.operands())
794 if (auto *V = dyn_cast_or_null<MetadataAsValue>(Op))
795 if (MDNode *N = dyn_cast<MDNode>(V->getMetadata()))
796 CreateMetadataSlot(N);
798 // Process metadata attached to this instruction.
799 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
800 I.getAllMetadata(MDs);
802 CreateMetadataSlot(MD.second);
805 /// Clean up after incorporating a function. This is the only way to get out of
806 /// the function incorporation state that affects get*Slot/Create*Slot. Function
807 /// incorporation state is indicated by TheFunction != 0.
808 void SlotTracker::purgeFunction() {
809 ST_DEBUG("begin purgeFunction!\n");
810 fMap.clear(); // Simply discard the function level map
811 TheFunction = nullptr;
812 FunctionProcessed = false;
813 ST_DEBUG("end purgeFunction!\n");
816 /// getGlobalSlot - Get the slot number of a global value.
817 int SlotTracker::getGlobalSlot(const GlobalValue *V) {
818 // Check for uninitialized state and do lazy initialization.
821 // Find the value in the module map
822 ValueMap::iterator MI = mMap.find(V);
823 return MI == mMap.end() ? -1 : (int)MI->second;
826 /// getMetadataSlot - Get the slot number of a MDNode.
827 int SlotTracker::getMetadataSlot(const MDNode *N) {
828 // Check for uninitialized state and do lazy initialization.
831 // Find the MDNode in the module map
832 mdn_iterator MI = mdnMap.find(N);
833 return MI == mdnMap.end() ? -1 : (int)MI->second;
837 /// getLocalSlot - Get the slot number for a value that is local to a function.
838 int SlotTracker::getLocalSlot(const Value *V) {
839 assert(!isa<Constant>(V) && "Can't get a constant or global slot with this!");
841 // Check for uninitialized state and do lazy initialization.
844 ValueMap::iterator FI = fMap.find(V);
845 return FI == fMap.end() ? -1 : (int)FI->second;
848 int SlotTracker::getAttributeGroupSlot(AttributeSet AS) {
849 // Check for uninitialized state and do lazy initialization.
852 // Find the AttributeSet in the module map.
853 as_iterator AI = asMap.find(AS);
854 return AI == asMap.end() ? -1 : (int)AI->second;
857 /// CreateModuleSlot - Insert the specified GlobalValue* into the slot table.
858 void SlotTracker::CreateModuleSlot(const GlobalValue *V) {
859 assert(V && "Can't insert a null Value into SlotTracker!");
860 assert(!V->getType()->isVoidTy() && "Doesn't need a slot!");
861 assert(!V->hasName() && "Doesn't need a slot!");
863 unsigned DestSlot = mNext++;
866 ST_DEBUG(" Inserting value [" << V->getType() << "] = " << V << " slot=" <<
868 // G = Global, F = Function, A = Alias, o = other
869 ST_DEBUG((isa<GlobalVariable>(V) ? 'G' :
870 (isa<Function>(V) ? 'F' :
871 (isa<GlobalAlias>(V) ? 'A' : 'o'))) << "]\n");
874 /// CreateSlot - Create a new slot for the specified value if it has no name.
875 void SlotTracker::CreateFunctionSlot(const Value *V) {
876 assert(!V->getType()->isVoidTy() && !V->hasName() && "Doesn't need a slot!");
878 unsigned DestSlot = fNext++;
881 // G = Global, F = Function, o = other
882 ST_DEBUG(" Inserting value [" << V->getType() << "] = " << V << " slot=" <<
883 DestSlot << " [o]\n");
886 /// CreateModuleSlot - Insert the specified MDNode* into the slot table.
887 void SlotTracker::CreateMetadataSlot(const MDNode *N) {
888 assert(N && "Can't insert a null Value into SlotTracker!");
890 unsigned DestSlot = mdnNext;
891 if (!mdnMap.insert(std::make_pair(N, DestSlot)).second)
895 // Recursively add any MDNodes referenced by operands.
896 for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i)
897 if (const MDNode *Op = dyn_cast_or_null<MDNode>(N->getOperand(i)))
898 CreateMetadataSlot(Op);
901 void SlotTracker::CreateAttributeSetSlot(AttributeSet AS) {
902 assert(AS.hasAttributes(AttributeSet::FunctionIndex) &&
903 "Doesn't need a slot!");
905 as_iterator I = asMap.find(AS);
906 if (I != asMap.end())
909 unsigned DestSlot = asNext++;
910 asMap[AS] = DestSlot;
913 //===----------------------------------------------------------------------===//
914 // AsmWriter Implementation
915 //===----------------------------------------------------------------------===//
917 static void WriteAsOperandInternal(raw_ostream &Out, const Value *V,
918 TypePrinting *TypePrinter,
919 SlotTracker *Machine,
920 const Module *Context);
922 static void WriteAsOperandInternal(raw_ostream &Out, const Metadata *MD,
923 TypePrinting *TypePrinter,
924 SlotTracker *Machine, const Module *Context,
925 bool FromValue = false);
927 static const char *getPredicateText(unsigned predicate) {
928 const char * pred = "unknown";
930 case FCmpInst::FCMP_FALSE: pred = "false"; break;
931 case FCmpInst::FCMP_OEQ: pred = "oeq"; break;
932 case FCmpInst::FCMP_OGT: pred = "ogt"; break;
933 case FCmpInst::FCMP_OGE: pred = "oge"; break;
934 case FCmpInst::FCMP_OLT: pred = "olt"; break;
935 case FCmpInst::FCMP_OLE: pred = "ole"; break;
936 case FCmpInst::FCMP_ONE: pred = "one"; break;
937 case FCmpInst::FCMP_ORD: pred = "ord"; break;
938 case FCmpInst::FCMP_UNO: pred = "uno"; break;
939 case FCmpInst::FCMP_UEQ: pred = "ueq"; break;
940 case FCmpInst::FCMP_UGT: pred = "ugt"; break;
941 case FCmpInst::FCMP_UGE: pred = "uge"; break;
942 case FCmpInst::FCMP_ULT: pred = "ult"; break;
943 case FCmpInst::FCMP_ULE: pred = "ule"; break;
944 case FCmpInst::FCMP_UNE: pred = "une"; break;
945 case FCmpInst::FCMP_TRUE: pred = "true"; break;
946 case ICmpInst::ICMP_EQ: pred = "eq"; break;
947 case ICmpInst::ICMP_NE: pred = "ne"; break;
948 case ICmpInst::ICMP_SGT: pred = "sgt"; break;
949 case ICmpInst::ICMP_SGE: pred = "sge"; break;
950 case ICmpInst::ICMP_SLT: pred = "slt"; break;
951 case ICmpInst::ICMP_SLE: pred = "sle"; break;
952 case ICmpInst::ICMP_UGT: pred = "ugt"; break;
953 case ICmpInst::ICMP_UGE: pred = "uge"; break;
954 case ICmpInst::ICMP_ULT: pred = "ult"; break;
955 case ICmpInst::ICMP_ULE: pred = "ule"; break;
960 static void writeAtomicRMWOperation(raw_ostream &Out,
961 AtomicRMWInst::BinOp Op) {
963 default: Out << " <unknown operation " << Op << ">"; break;
964 case AtomicRMWInst::Xchg: Out << " xchg"; break;
965 case AtomicRMWInst::Add: Out << " add"; break;
966 case AtomicRMWInst::Sub: Out << " sub"; break;
967 case AtomicRMWInst::And: Out << " and"; break;
968 case AtomicRMWInst::Nand: Out << " nand"; break;
969 case AtomicRMWInst::Or: Out << " or"; break;
970 case AtomicRMWInst::Xor: Out << " xor"; break;
971 case AtomicRMWInst::Max: Out << " max"; break;
972 case AtomicRMWInst::Min: Out << " min"; break;
973 case AtomicRMWInst::UMax: Out << " umax"; break;
974 case AtomicRMWInst::UMin: Out << " umin"; break;
978 static void WriteOptimizationInfo(raw_ostream &Out, const User *U) {
979 if (const FPMathOperator *FPO = dyn_cast<const FPMathOperator>(U)) {
980 // Unsafe algebra implies all the others, no need to write them all out
981 if (FPO->hasUnsafeAlgebra())
984 if (FPO->hasNoNaNs())
986 if (FPO->hasNoInfs())
988 if (FPO->hasNoSignedZeros())
990 if (FPO->hasAllowReciprocal())
995 if (const OverflowingBinaryOperator *OBO =
996 dyn_cast<OverflowingBinaryOperator>(U)) {
997 if (OBO->hasNoUnsignedWrap())
999 if (OBO->hasNoSignedWrap())
1001 } else if (const PossiblyExactOperator *Div =
1002 dyn_cast<PossiblyExactOperator>(U)) {
1005 } else if (const GEPOperator *GEP = dyn_cast<GEPOperator>(U)) {
1006 if (GEP->isInBounds())
1011 static void WriteConstantInternal(raw_ostream &Out, const Constant *CV,
1012 TypePrinting &TypePrinter,
1013 SlotTracker *Machine,
1014 const Module *Context) {
1015 if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV)) {
1016 if (CI->getType()->isIntegerTy(1)) {
1017 Out << (CI->getZExtValue() ? "true" : "false");
1020 Out << CI->getValue();
1024 if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV)) {
1025 if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEsingle ||
1026 &CFP->getValueAPF().getSemantics() == &APFloat::IEEEdouble) {
1027 // We would like to output the FP constant value in exponential notation,
1028 // but we cannot do this if doing so will lose precision. Check here to
1029 // make sure that we only output it in exponential format if we can parse
1030 // the value back and get the same value.
1033 bool isHalf = &CFP->getValueAPF().getSemantics()==&APFloat::IEEEhalf;
1034 bool isDouble = &CFP->getValueAPF().getSemantics()==&APFloat::IEEEdouble;
1035 bool isInf = CFP->getValueAPF().isInfinity();
1036 bool isNaN = CFP->getValueAPF().isNaN();
1037 if (!isHalf && !isInf && !isNaN) {
1038 double Val = isDouble ? CFP->getValueAPF().convertToDouble() :
1039 CFP->getValueAPF().convertToFloat();
1040 SmallString<128> StrVal;
1041 raw_svector_ostream(StrVal) << Val;
1043 // Check to make sure that the stringized number is not some string like
1044 // "Inf" or NaN, that atof will accept, but the lexer will not. Check
1045 // that the string matches the "[-+]?[0-9]" regex.
1047 if ((StrVal[0] >= '0' && StrVal[0] <= '9') ||
1048 ((StrVal[0] == '-' || StrVal[0] == '+') &&
1049 (StrVal[1] >= '0' && StrVal[1] <= '9'))) {
1050 // Reparse stringized version!
1051 if (APFloat(APFloat::IEEEdouble, StrVal).convertToDouble() == Val) {
1057 // Otherwise we could not reparse it to exactly the same value, so we must
1058 // output the string in hexadecimal format! Note that loading and storing
1059 // floating point types changes the bits of NaNs on some hosts, notably
1060 // x86, so we must not use these types.
1061 static_assert(sizeof(double) == sizeof(uint64_t),
1062 "assuming that double is 64 bits!");
1064 APFloat apf = CFP->getValueAPF();
1065 // Halves and floats are represented in ASCII IR as double, convert.
1067 apf.convert(APFloat::IEEEdouble, APFloat::rmNearestTiesToEven,
1070 utohex_buffer(uint64_t(apf.bitcastToAPInt().getZExtValue()),
1075 // Either half, or some form of long double.
1076 // These appear as a magic letter identifying the type, then a
1077 // fixed number of hex digits.
1079 // Bit position, in the current word, of the next nibble to print.
1082 if (&CFP->getValueAPF().getSemantics() == &APFloat::x87DoubleExtended) {
1084 // api needed to prevent premature destruction
1085 APInt api = CFP->getValueAPF().bitcastToAPInt();
1086 const uint64_t* p = api.getRawData();
1087 uint64_t word = p[1];
1089 int width = api.getBitWidth();
1090 for (int j=0; j<width; j+=4, shiftcount-=4) {
1091 unsigned int nibble = (word>>shiftcount) & 15;
1093 Out << (unsigned char)(nibble + '0');
1095 Out << (unsigned char)(nibble - 10 + 'A');
1096 if (shiftcount == 0 && j+4 < width) {
1100 shiftcount = width-j-4;
1104 } else if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEquad) {
1107 } else if (&CFP->getValueAPF().getSemantics() == &APFloat::PPCDoubleDouble) {
1110 } else if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEhalf) {
1114 llvm_unreachable("Unsupported floating point type");
1115 // api needed to prevent premature destruction
1116 APInt api = CFP->getValueAPF().bitcastToAPInt();
1117 const uint64_t* p = api.getRawData();
1119 int width = api.getBitWidth();
1120 for (int j=0; j<width; j+=4, shiftcount-=4) {
1121 unsigned int nibble = (word>>shiftcount) & 15;
1123 Out << (unsigned char)(nibble + '0');
1125 Out << (unsigned char)(nibble - 10 + 'A');
1126 if (shiftcount == 0 && j+4 < width) {
1130 shiftcount = width-j-4;
1136 if (isa<ConstantAggregateZero>(CV)) {
1137 Out << "zeroinitializer";
1141 if (const BlockAddress *BA = dyn_cast<BlockAddress>(CV)) {
1142 Out << "blockaddress(";
1143 WriteAsOperandInternal(Out, BA->getFunction(), &TypePrinter, Machine,
1146 WriteAsOperandInternal(Out, BA->getBasicBlock(), &TypePrinter, Machine,
1152 if (const ConstantArray *CA = dyn_cast<ConstantArray>(CV)) {
1153 Type *ETy = CA->getType()->getElementType();
1155 TypePrinter.print(ETy, Out);
1157 WriteAsOperandInternal(Out, CA->getOperand(0),
1158 &TypePrinter, Machine,
1160 for (unsigned i = 1, e = CA->getNumOperands(); i != e; ++i) {
1162 TypePrinter.print(ETy, Out);
1164 WriteAsOperandInternal(Out, CA->getOperand(i), &TypePrinter, Machine,
1171 if (const ConstantDataArray *CA = dyn_cast<ConstantDataArray>(CV)) {
1172 // As a special case, print the array as a string if it is an array of
1173 // i8 with ConstantInt values.
1174 if (CA->isString()) {
1176 PrintEscapedString(CA->getAsString(), Out);
1181 Type *ETy = CA->getType()->getElementType();
1183 TypePrinter.print(ETy, Out);
1185 WriteAsOperandInternal(Out, CA->getElementAsConstant(0),
1186 &TypePrinter, Machine,
1188 for (unsigned i = 1, e = CA->getNumElements(); i != e; ++i) {
1190 TypePrinter.print(ETy, Out);
1192 WriteAsOperandInternal(Out, CA->getElementAsConstant(i), &TypePrinter,
1200 if (const ConstantStruct *CS = dyn_cast<ConstantStruct>(CV)) {
1201 if (CS->getType()->isPacked())
1204 unsigned N = CS->getNumOperands();
1207 TypePrinter.print(CS->getOperand(0)->getType(), Out);
1210 WriteAsOperandInternal(Out, CS->getOperand(0), &TypePrinter, Machine,
1213 for (unsigned i = 1; i < N; i++) {
1215 TypePrinter.print(CS->getOperand(i)->getType(), Out);
1218 WriteAsOperandInternal(Out, CS->getOperand(i), &TypePrinter, Machine,
1225 if (CS->getType()->isPacked())
1230 if (isa<ConstantVector>(CV) || isa<ConstantDataVector>(CV)) {
1231 Type *ETy = CV->getType()->getVectorElementType();
1233 TypePrinter.print(ETy, Out);
1235 WriteAsOperandInternal(Out, CV->getAggregateElement(0U), &TypePrinter,
1237 for (unsigned i = 1, e = CV->getType()->getVectorNumElements(); i != e;++i){
1239 TypePrinter.print(ETy, Out);
1241 WriteAsOperandInternal(Out, CV->getAggregateElement(i), &TypePrinter,
1248 if (isa<ConstantPointerNull>(CV)) {
1253 if (isa<UndefValue>(CV)) {
1258 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV)) {
1259 Out << CE->getOpcodeName();
1260 WriteOptimizationInfo(Out, CE);
1261 if (CE->isCompare())
1262 Out << ' ' << getPredicateText(CE->getPredicate());
1265 if (const GEPOperator *GEP = dyn_cast<GEPOperator>(CE)) {
1267 cast<PointerType>(GEP->getPointerOperandType()->getScalarType())
1273 for (User::const_op_iterator OI=CE->op_begin(); OI != CE->op_end(); ++OI) {
1274 TypePrinter.print((*OI)->getType(), Out);
1276 WriteAsOperandInternal(Out, *OI, &TypePrinter, Machine, Context);
1277 if (OI+1 != CE->op_end())
1281 if (CE->hasIndices()) {
1282 ArrayRef<unsigned> Indices = CE->getIndices();
1283 for (unsigned i = 0, e = Indices.size(); i != e; ++i)
1284 Out << ", " << Indices[i];
1289 TypePrinter.print(CE->getType(), Out);
1296 Out << "<placeholder or erroneous Constant>";
1299 static void writeMDTuple(raw_ostream &Out, const MDTuple *Node,
1300 TypePrinting *TypePrinter, SlotTracker *Machine,
1301 const Module *Context) {
1303 for (unsigned mi = 0, me = Node->getNumOperands(); mi != me; ++mi) {
1304 const Metadata *MD = Node->getOperand(mi);
1307 else if (auto *MDV = dyn_cast<ValueAsMetadata>(MD)) {
1308 Value *V = MDV->getValue();
1309 TypePrinter->print(V->getType(), Out);
1311 WriteAsOperandInternal(Out, V, TypePrinter, Machine, Context);
1313 WriteAsOperandInternal(Out, MD, TypePrinter, Machine, Context);
1323 struct FieldSeparator {
1326 FieldSeparator(const char *Sep = ", ") : Skip(true), Sep(Sep) {}
1328 raw_ostream &operator<<(raw_ostream &OS, FieldSeparator &FS) {
1333 return OS << FS.Sep;
1337 static void writeMetadataAsOperand(raw_ostream &Out, const Metadata *MD,
1338 TypePrinting *TypePrinter,
1339 SlotTracker *Machine,
1340 const Module *Context) {
1345 WriteAsOperandInternal(Out, MD, TypePrinter, Machine, Context);
1348 static void writeTag(raw_ostream &Out, FieldSeparator &FS, const DebugNode *N) {
1349 Out << FS << "tag: ";
1350 if (const char *Tag = dwarf::TagString(N->getTag()))
1356 static void writeStringField(raw_ostream &Out, FieldSeparator &FS,
1357 StringRef Name, StringRef Value,
1358 bool ShouldSkipEmpty = true) {
1359 if (ShouldSkipEmpty && Value.empty())
1362 Out << FS << Name << ": \"";
1363 PrintEscapedString(Value, Out);
1367 static void writeGenericDebugNode(raw_ostream &Out, const GenericDebugNode *N,
1368 TypePrinting *TypePrinter,
1369 SlotTracker *Machine, const Module *Context) {
1370 Out << "!GenericDebugNode(";
1372 writeTag(Out, FS, N);
1373 writeStringField(Out, FS, "header", N->getHeader());
1374 if (N->getNumDwarfOperands()) {
1375 Out << FS << "operands: {";
1377 for (auto &I : N->dwarf_operands()) {
1379 writeMetadataAsOperand(Out, I, TypePrinter, Machine, Context);
1386 static void writeMDLocation(raw_ostream &Out, const MDLocation *DL,
1387 TypePrinting *TypePrinter, SlotTracker *Machine,
1388 const Module *Context) {
1389 Out << "!MDLocation(";
1391 // Always output the line, since 0 is a relevant and important value for it.
1392 Out << FS << "line: " << DL->getLine();
1393 if (DL->getColumn())
1394 Out << FS << "column: " << DL->getColumn();
1395 Out << FS << "scope: ";
1396 WriteAsOperandInternal(Out, DL->getScope(), TypePrinter, Machine, Context);
1397 if (DL->getInlinedAt()) {
1398 Out << FS << "inlinedAt: ";
1399 WriteAsOperandInternal(Out, DL->getInlinedAt(), TypePrinter, Machine,
1405 static void writeMDSubrange(raw_ostream &Out, const MDSubrange *N,
1406 TypePrinting *, SlotTracker *, const Module *) {
1407 Out << "!MDSubrange(";
1409 Out << FS << "count: " << N->getCount();
1411 Out << FS << "lowerBound: " << N->getLo();
1415 static void writeMDEnumerator(raw_ostream &Out, const MDEnumerator *N,
1416 TypePrinting *, SlotTracker *, const Module *) {
1417 Out << "!MDEnumerator(";
1419 writeStringField(Out, FS, "name", N->getName(), /* ShouldSkipEmpty */ false);
1420 Out << FS << "value: " << N->getValue();
1424 static void writeMDBasicType(raw_ostream &Out, const MDBasicType *N,
1425 TypePrinting *, SlotTracker *, const Module *) {
1426 Out << "!MDBasicType(";
1428 if (N->getTag() != dwarf::DW_TAG_base_type)
1429 writeTag(Out, FS, N);
1430 writeStringField(Out, FS, "name", N->getName());
1431 if (N->getSizeInBits())
1432 Out << FS << "size: " << N->getSizeInBits();
1433 if (N->getAlignInBits())
1434 Out << FS << "align: " << N->getAlignInBits();
1435 if (unsigned Encoding = N->getEncoding()) {
1436 Out << FS << "encoding: ";
1437 if (const char *S = dwarf::AttributeEncodingString(Encoding))
1445 static void writeDIFlags(raw_ostream &Out, unsigned Flags) {
1446 SmallVector<unsigned, 8> SplitFlags;
1447 unsigned Extra = DIDescriptor::splitFlags(Flags, SplitFlags);
1449 FieldSeparator FS(" | ");
1450 for (unsigned F : SplitFlags) {
1451 const char *StringF = DIDescriptor::getFlagString(F);
1452 assert(StringF && "Expected valid flag");
1453 Out << FS << StringF;
1455 if (Extra || SplitFlags.empty())
1459 static void writeMDDerivedType(raw_ostream &Out, const MDDerivedType *N,
1460 TypePrinting *TypePrinter, SlotTracker *Machine,
1461 const Module *Context) {
1462 Out << "!MDDerivedType(";
1464 writeTag(Out, FS, N);
1465 writeStringField(Out, FS, "name", N->getName());
1466 if (N->getScope()) {
1467 Out << FS << "scope: ";
1468 writeMetadataAsOperand(Out, N->getScope(), TypePrinter, Machine, Context);
1471 Out << FS << "file: ";
1472 writeMetadataAsOperand(Out, N->getFile(), TypePrinter, Machine,
1476 Out << FS << "line: " << N->getLine();
1477 Out << FS << "baseType: ";
1478 writeMetadataAsOperand(Out, N->getBaseType(), TypePrinter, Machine, Context);
1479 if (N->getSizeInBits())
1480 Out << FS << "size: " << N->getSizeInBits();
1481 if (N->getAlignInBits())
1482 Out << FS << "align: " << N->getAlignInBits();
1483 if (N->getOffsetInBits())
1484 Out << FS << "offset: " << N->getOffsetInBits();
1485 if (auto Flags = N->getFlags()) {
1486 Out << FS << "flags: ";
1487 writeDIFlags(Out, Flags);
1489 if (N->getExtraData()) {
1490 Out << FS << "extraData: ";
1491 writeMetadataAsOperand(Out, N->getExtraData(), TypePrinter, Machine,
1497 static void writeMDCompositeType(raw_ostream &Out, const MDCompositeType *N,
1498 TypePrinting *TypePrinter,
1499 SlotTracker *Machine, const Module *Context) {
1500 Out << "!MDCompositeType(";
1502 writeTag(Out, FS, N);
1503 writeStringField(Out, FS, "name", N->getName());
1504 if (N->getScope()) {
1505 Out << FS << "scope: ";
1506 writeMetadataAsOperand(Out, N->getScope(), TypePrinter, Machine, Context);
1509 Out << FS << "file: ";
1510 writeMetadataAsOperand(Out, N->getFile(), TypePrinter, Machine,
1514 Out << FS << "line: " << N->getLine();
1515 if (N->getBaseType()) {
1516 Out << FS << "baseType: ";
1517 writeMetadataAsOperand(Out, N->getBaseType(), TypePrinter, Machine,
1520 if (N->getSizeInBits())
1521 Out << FS << "size: " << N->getSizeInBits();
1522 if (N->getAlignInBits())
1523 Out << FS << "align: " << N->getAlignInBits();
1524 if (N->getOffsetInBits())
1525 Out << FS << "offset: " << N->getOffsetInBits();
1526 if (auto Flags = N->getFlags()) {
1527 Out << FS << "flags: ";
1528 writeDIFlags(Out, Flags);
1530 if (N->getElements()) {
1531 Out << FS << "elements: ";
1532 writeMetadataAsOperand(Out, N->getElements(), TypePrinter, Machine,
1535 if (unsigned Lang = N->getRuntimeLang()) {
1536 Out << FS << "runtimeLang: ";
1537 if (const char *S = dwarf::LanguageString(Lang))
1543 if (N->getVTableHolder()) {
1544 Out << FS << "vtableHolder: ";
1545 writeMetadataAsOperand(Out, N->getVTableHolder(), TypePrinter, Machine,
1548 if (N->getTemplateParams()) {
1549 Out << FS << "templateParams: ";
1550 writeMetadataAsOperand(Out, N->getTemplateParams(), TypePrinter, Machine,
1553 writeStringField(Out, FS, "identifier", N->getIdentifier());
1557 static void writeMDSubroutineType(raw_ostream &Out, const MDSubroutineType *N,
1558 TypePrinting *TypePrinter,
1559 SlotTracker *Machine, const Module *Context) {
1560 Out << "!MDSubroutineType(";
1562 if (auto Flags = N->getFlags()) {
1563 Out << FS << "flags: ";
1564 writeDIFlags(Out, Flags);
1566 Out << FS << "types: ";
1567 writeMetadataAsOperand(Out, N->getTypeArray(), TypePrinter, Machine, Context);
1571 static void writeMDFile(raw_ostream &Out, const MDFile *N, TypePrinting *,
1572 SlotTracker *, const Module *) {
1575 writeStringField(Out, FS, "filename", N->getFilename(),
1576 /* ShouldSkipEmpty */ false);
1577 writeStringField(Out, FS, "directory", N->getDirectory(),
1578 /* ShouldSkipEmpty */ false);
1582 static void writeMDCompileUnit(raw_ostream &Out, const MDCompileUnit *N,
1583 TypePrinting *TypePrinter, SlotTracker *Machine,
1584 const Module *Context) {
1585 Out << "!MDCompileUnit(";
1587 Out << FS << "language: ";
1588 if (const char *Lang = dwarf::LanguageString(N->getSourceLanguage()))
1591 Out << N->getSourceLanguage();
1592 Out << FS << "file: ";
1593 writeMetadataAsOperand(Out, N->getFile(), TypePrinter, Machine, Context);
1594 writeStringField(Out, FS, "producer", N->getProducer());
1595 Out << FS << "isOptimized: " << (N->isOptimized() ? "true" : "false");
1596 writeStringField(Out, FS, "flags", N->getFlags());
1597 Out << FS << "runtimeVersion: " << N->getRuntimeVersion();
1598 writeStringField(Out, FS, "splitDebugFilename", N->getSplitDebugFilename());
1599 Out << FS << "emissionKind: " << N->getEmissionKind();
1600 if (N->getEnumTypes()) {
1601 Out << FS << "enums: ";
1602 writeMetadataAsOperand(Out, N->getEnumTypes(), TypePrinter, Machine,
1605 if (N->getRetainedTypes()) {
1606 Out << FS << "retainedTypes: ";
1607 writeMetadataAsOperand(Out, N->getRetainedTypes(), TypePrinter, Machine,
1610 if (N->getSubprograms()) {
1611 Out << FS << "subprograms: ";
1612 writeMetadataAsOperand(Out, N->getSubprograms(), TypePrinter, Machine,
1615 if (N->getGlobalVariables()) {
1616 Out << FS << "globals: ";
1617 writeMetadataAsOperand(Out, N->getGlobalVariables(), TypePrinter, Machine,
1620 if (N->getImportedEntities()) {
1621 Out << FS << "imports: ";
1622 writeMetadataAsOperand(Out, N->getImportedEntities(), TypePrinter, Machine,
1628 static void writeMDSubprogram(raw_ostream &Out, const MDSubprogram *N,
1629 TypePrinting *TypePrinter, SlotTracker *Machine,
1630 const Module *Context) {
1631 Out << "!MDSubprogram(";
1633 writeStringField(Out, FS, "name", N->getName());
1634 writeStringField(Out, FS, "linkageName", N->getLinkageName());
1635 Out << FS << "scope: ";
1636 writeMetadataAsOperand(Out, N->getScope(), TypePrinter, Machine, Context);
1638 Out << FS << "file: ";
1639 writeMetadataAsOperand(Out, N->getFile(), TypePrinter, Machine,
1643 Out << FS << "line: " << N->getLine();
1645 Out << FS << "type: ";
1646 writeMetadataAsOperand(Out, N->getType(), TypePrinter, Machine,
1649 Out << FS << "isLocal: " << (N->isLocalToUnit() ? "true" : "false");
1650 Out << FS << "isDefinition: " << (N->isDefinition() ? "true" : "false");
1651 if (N->getScopeLine())
1652 Out << FS << "scopeLine: " << N->getScopeLine();
1653 if (N->getContainingType()) {
1654 Out << FS << "containingType: ";
1655 writeMetadataAsOperand(Out, N->getContainingType(), TypePrinter, Machine,
1658 if (unsigned V = N->getVirtuality()) {
1659 Out << FS << "virtuality: ";
1660 if (const char *S = dwarf::VirtualityString(V))
1665 if (N->getVirtualIndex())
1666 Out << FS << "virtualIndex: " << N->getVirtualIndex();
1667 if (auto Flags = N->getFlags()) {
1668 Out << FS << "flags: ";
1669 writeDIFlags(Out, Flags);
1671 Out << FS << "isOptimized: " << (N->isOptimized() ? "true" : "false");
1672 if (N->getFunction()) {
1673 Out << FS << "function: ";
1674 writeMetadataAsOperand(Out, N->getFunction(), TypePrinter, Machine,
1677 if (N->getTemplateParams()) {
1678 Out << FS << "templateParams: ";
1679 writeMetadataAsOperand(Out, N->getTemplateParams(), TypePrinter, Machine,
1682 if (N->getDeclaration()) {
1683 Out << FS << "declaration: ";
1684 writeMetadataAsOperand(Out, N->getDeclaration(), TypePrinter, Machine,
1687 if (N->getVariables()) {
1688 Out << FS << "variables: ";
1689 writeMetadataAsOperand(Out, N->getVariables(), TypePrinter, Machine,
1695 static void writeMDLexicalBlock(raw_ostream &Out, const MDLexicalBlock *N,
1696 TypePrinting *TypePrinter, SlotTracker *Machine,
1697 const Module *Context) {
1698 Out << "!MDLexicalBlock(";
1700 Out << FS << "scope: ";
1701 writeMetadataAsOperand(Out, N->getScope(), TypePrinter, Machine, Context);
1703 Out << FS << "file: ";
1704 writeMetadataAsOperand(Out, N->getFile(), TypePrinter, Machine,
1708 Out << FS << "line: " << N->getLine();
1710 Out << FS << "column: " << N->getColumn();
1714 static void writeMDLexicalBlockFile(raw_ostream &Out,
1715 const MDLexicalBlockFile *N,
1716 TypePrinting *TypePrinter,
1717 SlotTracker *Machine,
1718 const Module *Context) {
1719 Out << "!MDLexicalBlockFile(";
1721 Out << FS << "scope: ";
1722 writeMetadataAsOperand(Out, N->getScope(), TypePrinter, Machine, Context);
1724 Out << FS << "file: ";
1725 writeMetadataAsOperand(Out, N->getFile(), TypePrinter, Machine,
1728 Out << FS << "discriminator: " << N->getDiscriminator();
1732 static void writeMDNamespace(raw_ostream &Out, const MDNamespace *N,
1733 TypePrinting *TypePrinter, SlotTracker *Machine,
1734 const Module *Context) {
1735 Out << "!MDNamespace(";
1737 writeStringField(Out, FS, "name", N->getName());
1738 Out << FS << "scope: ";
1739 writeMetadataAsOperand(Out, N->getScope(), TypePrinter, Machine, Context);
1741 Out << FS << "file: ";
1742 writeMetadataAsOperand(Out, N->getFile(), TypePrinter, Machine, Context);
1745 Out << FS << "line: " << N->getLine();
1749 static void writeMDTemplateTypeParameter(raw_ostream &Out,
1750 const MDTemplateTypeParameter *N,
1751 TypePrinting *TypePrinter,
1752 SlotTracker *Machine,
1753 const Module *Context) {
1754 Out << "!MDTemplateTypeParameter(";
1756 writeStringField(Out, FS, "name", N->getName());
1757 Out << FS << "type: ";
1758 writeMetadataAsOperand(Out, N->getType(), TypePrinter, Machine, Context);
1762 static void writeMDTemplateValueParameter(raw_ostream &Out,
1763 const MDTemplateValueParameter *N,
1764 TypePrinting *TypePrinter,
1765 SlotTracker *Machine,
1766 const Module *Context) {
1767 Out << "!MDTemplateValueParameter(";
1769 if (N->getTag() != dwarf::DW_TAG_template_value_parameter)
1770 writeTag(Out, FS, N);
1771 writeStringField(Out, FS, "name", N->getName());
1772 if (auto *Type = N->getType()) {
1773 Out << FS << "type: ";
1774 writeMetadataAsOperand(Out, Type, TypePrinter, Machine, Context);
1776 Out << FS << "value: ";
1777 writeMetadataAsOperand(Out, N->getValue(), TypePrinter, Machine, Context);
1781 static void writeMDGlobalVariable(raw_ostream &Out, const MDGlobalVariable *N,
1782 TypePrinting *TypePrinter,
1783 SlotTracker *Machine, const Module *Context) {
1784 Out << "!MDGlobalVariable(";
1786 writeStringField(Out, FS, "name", N->getName());
1787 writeStringField(Out, FS, "linkageName", N->getLinkageName());
1788 Out << FS << "scope: ";
1789 writeMetadataAsOperand(Out, N->getScope(), TypePrinter, Machine, Context);
1791 Out << FS << "file: ";
1792 writeMetadataAsOperand(Out, N->getFile(), TypePrinter, Machine,
1796 Out << FS << "line: " << N->getLine();
1798 Out << FS << "type: ";
1799 writeMetadataAsOperand(Out, N->getType(), TypePrinter, Machine,
1802 Out << FS << "isLocal: " << (N->isLocalToUnit() ? "true" : "false");
1803 Out << FS << "isDefinition: " << (N->isDefinition() ? "true" : "false");
1804 if (N->getVariable()) {
1805 Out << FS << "variable: ";
1806 writeMetadataAsOperand(Out, N->getVariable(), TypePrinter, Machine,
1809 if (N->getStaticDataMemberDeclaration()) {
1810 Out << FS << "declaration: ";
1811 writeMetadataAsOperand(Out, N->getStaticDataMemberDeclaration(),
1812 TypePrinter, Machine, Context);
1817 static void writeMDLocalVariable(raw_ostream &Out, const MDLocalVariable *N,
1818 TypePrinting *TypePrinter,
1819 SlotTracker *Machine, const Module *Context) {
1820 Out << "!MDLocalVariable(";
1822 writeTag(Out, FS, N);
1823 writeStringField(Out, FS, "name", N->getName());
1824 if (N->getTag() == dwarf::DW_TAG_arg_variable || N->getArg())
1825 Out << FS << "arg: " << N->getArg();
1826 Out << FS << "scope: ";
1827 writeMetadataAsOperand(Out, N->getScope(), TypePrinter, Machine, Context);
1829 Out << FS << "file: ";
1830 writeMetadataAsOperand(Out, N->getFile(), TypePrinter, Machine,
1834 Out << FS << "line: " << N->getLine();
1836 Out << FS << "type: ";
1837 writeMetadataAsOperand(Out, N->getType(), TypePrinter, Machine,
1840 if (auto Flags = N->getFlags()) {
1841 Out << FS << "flags: ";
1842 writeDIFlags(Out, Flags);
1844 if (N->getInlinedAt()) {
1845 Out << FS << "inlinedAt: ";
1846 writeMetadataAsOperand(Out, N->getInlinedAt(), TypePrinter, Machine,
1852 static void writeMDExpression(raw_ostream &Out, const MDExpression *N,
1853 TypePrinting *TypePrinter, SlotTracker *Machine,
1854 const Module *Context) {
1855 Out << "!MDExpression(";
1858 for (auto I = N->expr_op_begin(), E = N->expr_op_end(); I != E; ++I) {
1859 const char *OpStr = dwarf::OperationEncodingString(I->getOp());
1860 assert(OpStr && "Expected valid opcode");
1863 for (unsigned A = 0, AE = I->getNumArgs(); A != AE; ++A)
1864 Out << FS << I->getArg(A);
1867 for (const auto &I : N->getElements())
1873 static void writeMDObjCProperty(raw_ostream &Out, const MDObjCProperty *N,
1874 TypePrinting *TypePrinter, SlotTracker *Machine,
1875 const Module *Context) {
1876 Out << "!MDObjCProperty(";
1878 writeStringField(Out, FS, "name", N->getName());
1880 Out << FS << "file: ";
1881 writeMetadataAsOperand(Out, N->getFile(), TypePrinter, Machine, Context);
1884 Out << FS << "line: " << N->getLine();
1885 writeStringField(Out, FS, "setter", N->getSetterName());
1886 writeStringField(Out, FS, "getter", N->getGetterName());
1887 if (N->getAttributes())
1888 Out << FS << "attributes: " << N->getAttributes();
1890 Out << FS << "type: ";
1891 writeMetadataAsOperand(Out, N->getType(), TypePrinter, Machine, Context);
1896 static void writeMDImportedEntity(raw_ostream &Out, const MDImportedEntity *N,
1897 TypePrinting *TypePrinter,
1898 SlotTracker *Machine, const Module *Context) {
1899 Out << "!MDImportedEntity(";
1901 writeTag(Out, FS, N);
1902 writeStringField(Out, FS, "name", N->getName());
1903 Out << FS << "scope: ";
1904 writeMetadataAsOperand(Out, N->getScope(), TypePrinter, Machine, Context);
1905 if (N->getEntity()) {
1906 Out << FS << "entity: ";
1907 writeMetadataAsOperand(Out, N->getEntity(), TypePrinter, Machine, Context);
1910 Out << FS << "line: " << N->getLine();
1915 static void WriteMDNodeBodyInternal(raw_ostream &Out, const MDNode *Node,
1916 TypePrinting *TypePrinter,
1917 SlotTracker *Machine,
1918 const Module *Context) {
1919 if (Node->isDistinct())
1921 else if (Node->isTemporary())
1922 Out << "<temporary!> "; // Handle broken code.
1924 switch (Node->getMetadataID()) {
1926 llvm_unreachable("Expected uniquable MDNode");
1927 #define HANDLE_MDNODE_LEAF(CLASS) \
1928 case Metadata::CLASS##Kind: \
1929 write##CLASS(Out, cast<CLASS>(Node), TypePrinter, Machine, Context); \
1931 #include "llvm/IR/Metadata.def"
1935 // Full implementation of printing a Value as an operand with support for
1936 // TypePrinting, etc.
1937 static void WriteAsOperandInternal(raw_ostream &Out, const Value *V,
1938 TypePrinting *TypePrinter,
1939 SlotTracker *Machine,
1940 const Module *Context) {
1942 PrintLLVMName(Out, V);
1946 const Constant *CV = dyn_cast<Constant>(V);
1947 if (CV && !isa<GlobalValue>(CV)) {
1948 assert(TypePrinter && "Constants require TypePrinting!");
1949 WriteConstantInternal(Out, CV, *TypePrinter, Machine, Context);
1953 if (const InlineAsm *IA = dyn_cast<InlineAsm>(V)) {
1955 if (IA->hasSideEffects())
1956 Out << "sideeffect ";
1957 if (IA->isAlignStack())
1958 Out << "alignstack ";
1959 // We don't emit the AD_ATT dialect as it's the assumed default.
1960 if (IA->getDialect() == InlineAsm::AD_Intel)
1961 Out << "inteldialect ";
1963 PrintEscapedString(IA->getAsmString(), Out);
1965 PrintEscapedString(IA->getConstraintString(), Out);
1970 if (auto *MD = dyn_cast<MetadataAsValue>(V)) {
1971 WriteAsOperandInternal(Out, MD->getMetadata(), TypePrinter, Machine,
1972 Context, /* FromValue */ true);
1978 // If we have a SlotTracker, use it.
1980 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
1981 Slot = Machine->getGlobalSlot(GV);
1984 Slot = Machine->getLocalSlot(V);
1986 // If the local value didn't succeed, then we may be referring to a value
1987 // from a different function. Translate it, as this can happen when using
1988 // address of blocks.
1990 if ((Machine = createSlotTracker(V))) {
1991 Slot = Machine->getLocalSlot(V);
1995 } else if ((Machine = createSlotTracker(V))) {
1996 // Otherwise, create one to get the # and then destroy it.
1997 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
1998 Slot = Machine->getGlobalSlot(GV);
2001 Slot = Machine->getLocalSlot(V);
2010 Out << Prefix << Slot;
2015 static void WriteAsOperandInternal(raw_ostream &Out, const Metadata *MD,
2016 TypePrinting *TypePrinter,
2017 SlotTracker *Machine, const Module *Context,
2019 if (const MDNode *N = dyn_cast<MDNode>(MD)) {
2021 Machine = new SlotTracker(Context);
2022 int Slot = Machine->getMetadataSlot(N);
2024 // Give the pointer value instead of "badref", since this comes up all
2025 // the time when debugging.
2026 Out << "<" << N << ">";
2032 if (const MDString *MDS = dyn_cast<MDString>(MD)) {
2034 PrintEscapedString(MDS->getString(), Out);
2039 auto *V = cast<ValueAsMetadata>(MD);
2040 assert(TypePrinter && "TypePrinter required for metadata values");
2041 assert((FromValue || !isa<LocalAsMetadata>(V)) &&
2042 "Unexpected function-local metadata outside of value argument");
2044 TypePrinter->print(V->getValue()->getType(), Out);
2046 WriteAsOperandInternal(Out, V->getValue(), TypePrinter, Machine, Context);
2049 void AssemblyWriter::init() {
2052 TypePrinter.incorporateTypes(*TheModule);
2053 for (const Function &F : *TheModule)
2054 if (const Comdat *C = F.getComdat())
2056 for (const GlobalVariable &GV : TheModule->globals())
2057 if (const Comdat *C = GV.getComdat())
2062 AssemblyWriter::AssemblyWriter(formatted_raw_ostream &o, SlotTracker &Mac,
2064 AssemblyAnnotationWriter *AAW)
2065 : Out(o), TheModule(M), Machine(Mac), AnnotationWriter(AAW) {
2069 AssemblyWriter::AssemblyWriter(formatted_raw_ostream &o, const Module *M,
2070 AssemblyAnnotationWriter *AAW)
2071 : Out(o), TheModule(M), ModuleSlotTracker(createSlotTracker(M)),
2072 Machine(*ModuleSlotTracker), AnnotationWriter(AAW) {
2076 AssemblyWriter::~AssemblyWriter() { }
2078 void AssemblyWriter::writeOperand(const Value *Operand, bool PrintType) {
2080 Out << "<null operand!>";
2084 TypePrinter.print(Operand->getType(), Out);
2087 WriteAsOperandInternal(Out, Operand, &TypePrinter, &Machine, TheModule);
2090 void AssemblyWriter::writeAtomic(AtomicOrdering Ordering,
2091 SynchronizationScope SynchScope) {
2092 if (Ordering == NotAtomic)
2095 switch (SynchScope) {
2096 case SingleThread: Out << " singlethread"; break;
2097 case CrossThread: break;
2101 default: Out << " <bad ordering " << int(Ordering) << ">"; break;
2102 case Unordered: Out << " unordered"; break;
2103 case Monotonic: Out << " monotonic"; break;
2104 case Acquire: Out << " acquire"; break;
2105 case Release: Out << " release"; break;
2106 case AcquireRelease: Out << " acq_rel"; break;
2107 case SequentiallyConsistent: Out << " seq_cst"; break;
2111 void AssemblyWriter::writeAtomicCmpXchg(AtomicOrdering SuccessOrdering,
2112 AtomicOrdering FailureOrdering,
2113 SynchronizationScope SynchScope) {
2114 assert(SuccessOrdering != NotAtomic && FailureOrdering != NotAtomic);
2116 switch (SynchScope) {
2117 case SingleThread: Out << " singlethread"; break;
2118 case CrossThread: break;
2121 switch (SuccessOrdering) {
2122 default: Out << " <bad ordering " << int(SuccessOrdering) << ">"; break;
2123 case Unordered: Out << " unordered"; break;
2124 case Monotonic: Out << " monotonic"; break;
2125 case Acquire: Out << " acquire"; break;
2126 case Release: Out << " release"; break;
2127 case AcquireRelease: Out << " acq_rel"; break;
2128 case SequentiallyConsistent: Out << " seq_cst"; break;
2131 switch (FailureOrdering) {
2132 default: Out << " <bad ordering " << int(FailureOrdering) << ">"; break;
2133 case Unordered: Out << " unordered"; break;
2134 case Monotonic: Out << " monotonic"; break;
2135 case Acquire: Out << " acquire"; break;
2136 case Release: Out << " release"; break;
2137 case AcquireRelease: Out << " acq_rel"; break;
2138 case SequentiallyConsistent: Out << " seq_cst"; break;
2142 void AssemblyWriter::writeParamOperand(const Value *Operand,
2143 AttributeSet Attrs, unsigned Idx) {
2145 Out << "<null operand!>";
2150 TypePrinter.print(Operand->getType(), Out);
2151 // Print parameter attributes list
2152 if (Attrs.hasAttributes(Idx))
2153 Out << ' ' << Attrs.getAsString(Idx);
2155 // Print the operand
2156 WriteAsOperandInternal(Out, Operand, &TypePrinter, &Machine, TheModule);
2159 void AssemblyWriter::printModule(const Module *M) {
2160 Machine.initialize();
2162 if (shouldPreserveAssemblyUseListOrder())
2163 UseListOrders = predictUseListOrder(M);
2165 if (!M->getModuleIdentifier().empty() &&
2166 // Don't print the ID if it will start a new line (which would
2167 // require a comment char before it).
2168 M->getModuleIdentifier().find('\n') == std::string::npos)
2169 Out << "; ModuleID = '" << M->getModuleIdentifier() << "'\n";
2171 const std::string &DL = M->getDataLayoutStr();
2173 Out << "target datalayout = \"" << DL << "\"\n";
2174 if (!M->getTargetTriple().empty())
2175 Out << "target triple = \"" << M->getTargetTriple() << "\"\n";
2177 if (!M->getModuleInlineAsm().empty()) {
2178 // Split the string into lines, to make it easier to read the .ll file.
2179 std::string Asm = M->getModuleInlineAsm();
2181 size_t NewLine = Asm.find_first_of('\n', CurPos);
2183 while (NewLine != std::string::npos) {
2184 // We found a newline, print the portion of the asm string from the
2185 // last newline up to this newline.
2186 Out << "module asm \"";
2187 PrintEscapedString(std::string(Asm.begin()+CurPos, Asm.begin()+NewLine),
2191 NewLine = Asm.find_first_of('\n', CurPos);
2193 std::string rest(Asm.begin()+CurPos, Asm.end());
2194 if (!rest.empty()) {
2195 Out << "module asm \"";
2196 PrintEscapedString(rest, Out);
2201 printTypeIdentities();
2203 // Output all comdats.
2204 if (!Comdats.empty())
2206 for (const Comdat *C : Comdats) {
2208 if (C != Comdats.back())
2212 // Output all globals.
2213 if (!M->global_empty()) Out << '\n';
2214 for (Module::const_global_iterator I = M->global_begin(), E = M->global_end();
2216 printGlobal(I); Out << '\n';
2219 // Output all aliases.
2220 if (!M->alias_empty()) Out << "\n";
2221 for (Module::const_alias_iterator I = M->alias_begin(), E = M->alias_end();
2225 // Output global use-lists.
2226 printUseLists(nullptr);
2228 // Output all of the functions.
2229 for (Module::const_iterator I = M->begin(), E = M->end(); I != E; ++I)
2231 assert(UseListOrders.empty() && "All use-lists should have been consumed");
2233 // Output all attribute groups.
2234 if (!Machine.as_empty()) {
2236 writeAllAttributeGroups();
2239 // Output named metadata.
2240 if (!M->named_metadata_empty()) Out << '\n';
2242 for (Module::const_named_metadata_iterator I = M->named_metadata_begin(),
2243 E = M->named_metadata_end(); I != E; ++I)
2244 printNamedMDNode(I);
2247 if (!Machine.mdn_empty()) {
2253 void AssemblyWriter::printNamedMDNode(const NamedMDNode *NMD) {
2255 StringRef Name = NMD->getName();
2257 Out << "<empty name> ";
2259 if (isalpha(static_cast<unsigned char>(Name[0])) ||
2260 Name[0] == '-' || Name[0] == '$' ||
2261 Name[0] == '.' || Name[0] == '_')
2264 Out << '\\' << hexdigit(Name[0] >> 4) << hexdigit(Name[0] & 0x0F);
2265 for (unsigned i = 1, e = Name.size(); i != e; ++i) {
2266 unsigned char C = Name[i];
2267 if (isalnum(static_cast<unsigned char>(C)) || C == '-' || C == '$' ||
2268 C == '.' || C == '_')
2271 Out << '\\' << hexdigit(C >> 4) << hexdigit(C & 0x0F);
2275 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
2277 int Slot = Machine.getMetadataSlot(NMD->getOperand(i));
2287 static void PrintLinkage(GlobalValue::LinkageTypes LT,
2288 formatted_raw_ostream &Out) {
2290 case GlobalValue::ExternalLinkage: break;
2291 case GlobalValue::PrivateLinkage: Out << "private "; break;
2292 case GlobalValue::InternalLinkage: Out << "internal "; break;
2293 case GlobalValue::LinkOnceAnyLinkage: Out << "linkonce "; break;
2294 case GlobalValue::LinkOnceODRLinkage: Out << "linkonce_odr "; break;
2295 case GlobalValue::WeakAnyLinkage: Out << "weak "; break;
2296 case GlobalValue::WeakODRLinkage: Out << "weak_odr "; break;
2297 case GlobalValue::CommonLinkage: Out << "common "; break;
2298 case GlobalValue::AppendingLinkage: Out << "appending "; break;
2299 case GlobalValue::ExternalWeakLinkage: Out << "extern_weak "; break;
2300 case GlobalValue::AvailableExternallyLinkage:
2301 Out << "available_externally ";
2307 static void PrintVisibility(GlobalValue::VisibilityTypes Vis,
2308 formatted_raw_ostream &Out) {
2310 case GlobalValue::DefaultVisibility: break;
2311 case GlobalValue::HiddenVisibility: Out << "hidden "; break;
2312 case GlobalValue::ProtectedVisibility: Out << "protected "; break;
2316 static void PrintDLLStorageClass(GlobalValue::DLLStorageClassTypes SCT,
2317 formatted_raw_ostream &Out) {
2319 case GlobalValue::DefaultStorageClass: break;
2320 case GlobalValue::DLLImportStorageClass: Out << "dllimport "; break;
2321 case GlobalValue::DLLExportStorageClass: Out << "dllexport "; break;
2325 static void PrintThreadLocalModel(GlobalVariable::ThreadLocalMode TLM,
2326 formatted_raw_ostream &Out) {
2328 case GlobalVariable::NotThreadLocal:
2330 case GlobalVariable::GeneralDynamicTLSModel:
2331 Out << "thread_local ";
2333 case GlobalVariable::LocalDynamicTLSModel:
2334 Out << "thread_local(localdynamic) ";
2336 case GlobalVariable::InitialExecTLSModel:
2337 Out << "thread_local(initialexec) ";
2339 case GlobalVariable::LocalExecTLSModel:
2340 Out << "thread_local(localexec) ";
2345 static void maybePrintComdat(formatted_raw_ostream &Out,
2346 const GlobalObject &GO) {
2347 const Comdat *C = GO.getComdat();
2351 if (isa<GlobalVariable>(GO))
2355 if (GO.getName() == C->getName())
2359 PrintLLVMName(Out, C->getName(), ComdatPrefix);
2363 void AssemblyWriter::printGlobal(const GlobalVariable *GV) {
2364 if (GV->isMaterializable())
2365 Out << "; Materializable\n";
2367 WriteAsOperandInternal(Out, GV, &TypePrinter, &Machine, GV->getParent());
2370 if (!GV->hasInitializer() && GV->hasExternalLinkage())
2373 PrintLinkage(GV->getLinkage(), Out);
2374 PrintVisibility(GV->getVisibility(), Out);
2375 PrintDLLStorageClass(GV->getDLLStorageClass(), Out);
2376 PrintThreadLocalModel(GV->getThreadLocalMode(), Out);
2377 if (GV->hasUnnamedAddr())
2378 Out << "unnamed_addr ";
2380 if (unsigned AddressSpace = GV->getType()->getAddressSpace())
2381 Out << "addrspace(" << AddressSpace << ") ";
2382 if (GV->isExternallyInitialized()) Out << "externally_initialized ";
2383 Out << (GV->isConstant() ? "constant " : "global ");
2384 TypePrinter.print(GV->getType()->getElementType(), Out);
2386 if (GV->hasInitializer()) {
2388 writeOperand(GV->getInitializer(), false);
2391 if (GV->hasSection()) {
2392 Out << ", section \"";
2393 PrintEscapedString(GV->getSection(), Out);
2396 maybePrintComdat(Out, *GV);
2397 if (GV->getAlignment())
2398 Out << ", align " << GV->getAlignment();
2400 printInfoComment(*GV);
2403 void AssemblyWriter::printAlias(const GlobalAlias *GA) {
2404 if (GA->isMaterializable())
2405 Out << "; Materializable\n";
2407 // Don't crash when dumping partially built GA
2409 Out << "<<nameless>> = ";
2411 PrintLLVMName(Out, GA);
2414 PrintLinkage(GA->getLinkage(), Out);
2415 PrintVisibility(GA->getVisibility(), Out);
2416 PrintDLLStorageClass(GA->getDLLStorageClass(), Out);
2417 PrintThreadLocalModel(GA->getThreadLocalMode(), Out);
2418 if (GA->hasUnnamedAddr())
2419 Out << "unnamed_addr ";
2423 const Constant *Aliasee = GA->getAliasee();
2426 TypePrinter.print(GA->getType(), Out);
2427 Out << " <<NULL ALIASEE>>";
2429 writeOperand(Aliasee, !isa<ConstantExpr>(Aliasee));
2432 printInfoComment(*GA);
2436 void AssemblyWriter::printComdat(const Comdat *C) {
2440 void AssemblyWriter::printTypeIdentities() {
2441 if (TypePrinter.NumberedTypes.empty() &&
2442 TypePrinter.NamedTypes.empty())
2447 // We know all the numbers that each type is used and we know that it is a
2448 // dense assignment. Convert the map to an index table.
2449 std::vector<StructType*> NumberedTypes(TypePrinter.NumberedTypes.size());
2450 for (DenseMap<StructType*, unsigned>::iterator I =
2451 TypePrinter.NumberedTypes.begin(), E = TypePrinter.NumberedTypes.end();
2453 assert(I->second < NumberedTypes.size() && "Didn't get a dense numbering?");
2454 NumberedTypes[I->second] = I->first;
2457 // Emit all numbered types.
2458 for (unsigned i = 0, e = NumberedTypes.size(); i != e; ++i) {
2459 Out << '%' << i << " = type ";
2461 // Make sure we print out at least one level of the type structure, so
2462 // that we do not get %2 = type %2
2463 TypePrinter.printStructBody(NumberedTypes[i], Out);
2467 for (unsigned i = 0, e = TypePrinter.NamedTypes.size(); i != e; ++i) {
2468 PrintLLVMName(Out, TypePrinter.NamedTypes[i]->getName(), LocalPrefix);
2471 // Make sure we print out at least one level of the type structure, so
2472 // that we do not get %FILE = type %FILE
2473 TypePrinter.printStructBody(TypePrinter.NamedTypes[i], Out);
2478 /// printFunction - Print all aspects of a function.
2480 void AssemblyWriter::printFunction(const Function *F) {
2481 // Print out the return type and name.
2484 if (AnnotationWriter) AnnotationWriter->emitFunctionAnnot(F, Out);
2486 if (F->isMaterializable())
2487 Out << "; Materializable\n";
2489 const AttributeSet &Attrs = F->getAttributes();
2490 if (Attrs.hasAttributes(AttributeSet::FunctionIndex)) {
2491 AttributeSet AS = Attrs.getFnAttributes();
2492 std::string AttrStr;
2495 for (unsigned E = AS.getNumSlots(); Idx != E; ++Idx)
2496 if (AS.getSlotIndex(Idx) == AttributeSet::FunctionIndex)
2499 for (AttributeSet::iterator I = AS.begin(Idx), E = AS.end(Idx);
2501 Attribute Attr = *I;
2502 if (!Attr.isStringAttribute()) {
2503 if (!AttrStr.empty()) AttrStr += ' ';
2504 AttrStr += Attr.getAsString();
2508 if (!AttrStr.empty())
2509 Out << "; Function Attrs: " << AttrStr << '\n';
2512 if (F->isDeclaration())
2517 PrintLinkage(F->getLinkage(), Out);
2518 PrintVisibility(F->getVisibility(), Out);
2519 PrintDLLStorageClass(F->getDLLStorageClass(), Out);
2521 // Print the calling convention.
2522 if (F->getCallingConv() != CallingConv::C) {
2523 PrintCallingConv(F->getCallingConv(), Out);
2527 FunctionType *FT = F->getFunctionType();
2528 if (Attrs.hasAttributes(AttributeSet::ReturnIndex))
2529 Out << Attrs.getAsString(AttributeSet::ReturnIndex) << ' ';
2530 TypePrinter.print(F->getReturnType(), Out);
2532 WriteAsOperandInternal(Out, F, &TypePrinter, &Machine, F->getParent());
2534 Machine.incorporateFunction(F);
2536 // Loop over the arguments, printing them...
2539 if (!F->isDeclaration()) {
2540 // If this isn't a declaration, print the argument names as well.
2541 for (Function::const_arg_iterator I = F->arg_begin(), E = F->arg_end();
2543 // Insert commas as we go... the first arg doesn't get a comma
2544 if (I != F->arg_begin()) Out << ", ";
2545 printArgument(I, Attrs, Idx);
2549 // Otherwise, print the types from the function type.
2550 for (unsigned i = 0, e = FT->getNumParams(); i != e; ++i) {
2551 // Insert commas as we go... the first arg doesn't get a comma
2555 TypePrinter.print(FT->getParamType(i), Out);
2557 if (Attrs.hasAttributes(i+1))
2558 Out << ' ' << Attrs.getAsString(i+1);
2562 // Finish printing arguments...
2563 if (FT->isVarArg()) {
2564 if (FT->getNumParams()) Out << ", ";
2565 Out << "..."; // Output varargs portion of signature!
2568 if (F->hasUnnamedAddr())
2569 Out << " unnamed_addr";
2570 if (Attrs.hasAttributes(AttributeSet::FunctionIndex))
2571 Out << " #" << Machine.getAttributeGroupSlot(Attrs.getFnAttributes());
2572 if (F->hasSection()) {
2573 Out << " section \"";
2574 PrintEscapedString(F->getSection(), Out);
2577 maybePrintComdat(Out, *F);
2578 if (F->getAlignment())
2579 Out << " align " << F->getAlignment();
2581 Out << " gc \"" << F->getGC() << '"';
2582 if (F->hasPrefixData()) {
2584 writeOperand(F->getPrefixData(), true);
2586 if (F->hasPrologueData()) {
2587 Out << " prologue ";
2588 writeOperand(F->getPrologueData(), true);
2591 if (F->isDeclaration()) {
2595 // Output all of the function's basic blocks.
2596 for (Function::const_iterator I = F->begin(), E = F->end(); I != E; ++I)
2599 // Output the function's use-lists.
2605 Machine.purgeFunction();
2608 /// printArgument - This member is called for every argument that is passed into
2609 /// the function. Simply print it out
2611 void AssemblyWriter::printArgument(const Argument *Arg,
2612 AttributeSet Attrs, unsigned Idx) {
2614 TypePrinter.print(Arg->getType(), Out);
2616 // Output parameter attributes list
2617 if (Attrs.hasAttributes(Idx))
2618 Out << ' ' << Attrs.getAsString(Idx);
2620 // Output name, if available...
2621 if (Arg->hasName()) {
2623 PrintLLVMName(Out, Arg);
2627 /// printBasicBlock - This member is called for each basic block in a method.
2629 void AssemblyWriter::printBasicBlock(const BasicBlock *BB) {
2630 if (BB->hasName()) { // Print out the label if it exists...
2632 PrintLLVMName(Out, BB->getName(), LabelPrefix);
2634 } else if (!BB->use_empty()) { // Don't print block # of no uses...
2635 Out << "\n; <label>:";
2636 int Slot = Machine.getLocalSlot(BB);
2643 if (!BB->getParent()) {
2644 Out.PadToColumn(50);
2645 Out << "; Error: Block without parent!";
2646 } else if (BB != &BB->getParent()->getEntryBlock()) { // Not the entry block?
2647 // Output predecessors for the block.
2648 Out.PadToColumn(50);
2650 const_pred_iterator PI = pred_begin(BB), PE = pred_end(BB);
2653 Out << " No predecessors!";
2656 writeOperand(*PI, false);
2657 for (++PI; PI != PE; ++PI) {
2659 writeOperand(*PI, false);
2666 if (AnnotationWriter) AnnotationWriter->emitBasicBlockStartAnnot(BB, Out);
2668 // Output all of the instructions in the basic block...
2669 for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I != E; ++I) {
2670 printInstructionLine(*I);
2673 if (AnnotationWriter) AnnotationWriter->emitBasicBlockEndAnnot(BB, Out);
2676 /// printInstructionLine - Print an instruction and a newline character.
2677 void AssemblyWriter::printInstructionLine(const Instruction &I) {
2678 printInstruction(I);
2682 /// printInfoComment - Print a little comment after the instruction indicating
2683 /// which slot it occupies.
2685 void AssemblyWriter::printInfoComment(const Value &V) {
2686 if (AnnotationWriter)
2687 AnnotationWriter->printInfoComment(V, Out);
2690 // This member is called for each Instruction in a function..
2691 void AssemblyWriter::printInstruction(const Instruction &I) {
2692 if (AnnotationWriter) AnnotationWriter->emitInstructionAnnot(&I, Out);
2694 // Print out indentation for an instruction.
2697 // Print out name if it exists...
2699 PrintLLVMName(Out, &I);
2701 } else if (!I.getType()->isVoidTy()) {
2702 // Print out the def slot taken.
2703 int SlotNum = Machine.getLocalSlot(&I);
2705 Out << "<badref> = ";
2707 Out << '%' << SlotNum << " = ";
2710 if (const CallInst *CI = dyn_cast<CallInst>(&I)) {
2711 if (CI->isMustTailCall())
2713 else if (CI->isTailCall())
2717 // Print out the opcode...
2718 Out << I.getOpcodeName();
2720 // If this is an atomic load or store, print out the atomic marker.
2721 if ((isa<LoadInst>(I) && cast<LoadInst>(I).isAtomic()) ||
2722 (isa<StoreInst>(I) && cast<StoreInst>(I).isAtomic()))
2725 if (isa<AtomicCmpXchgInst>(I) && cast<AtomicCmpXchgInst>(I).isWeak())
2728 // If this is a volatile operation, print out the volatile marker.
2729 if ((isa<LoadInst>(I) && cast<LoadInst>(I).isVolatile()) ||
2730 (isa<StoreInst>(I) && cast<StoreInst>(I).isVolatile()) ||
2731 (isa<AtomicCmpXchgInst>(I) && cast<AtomicCmpXchgInst>(I).isVolatile()) ||
2732 (isa<AtomicRMWInst>(I) && cast<AtomicRMWInst>(I).isVolatile()))
2735 // Print out optimization information.
2736 WriteOptimizationInfo(Out, &I);
2738 // Print out the compare instruction predicates
2739 if (const CmpInst *CI = dyn_cast<CmpInst>(&I))
2740 Out << ' ' << getPredicateText(CI->getPredicate());
2742 // Print out the atomicrmw operation
2743 if (const AtomicRMWInst *RMWI = dyn_cast<AtomicRMWInst>(&I))
2744 writeAtomicRMWOperation(Out, RMWI->getOperation());
2746 // Print out the type of the operands...
2747 const Value *Operand = I.getNumOperands() ? I.getOperand(0) : nullptr;
2749 // Special case conditional branches to swizzle the condition out to the front
2750 if (isa<BranchInst>(I) && cast<BranchInst>(I).isConditional()) {
2751 const BranchInst &BI(cast<BranchInst>(I));
2753 writeOperand(BI.getCondition(), true);
2755 writeOperand(BI.getSuccessor(0), true);
2757 writeOperand(BI.getSuccessor(1), true);
2759 } else if (isa<SwitchInst>(I)) {
2760 const SwitchInst& SI(cast<SwitchInst>(I));
2761 // Special case switch instruction to get formatting nice and correct.
2763 writeOperand(SI.getCondition(), true);
2765 writeOperand(SI.getDefaultDest(), true);
2767 for (SwitchInst::ConstCaseIt i = SI.case_begin(), e = SI.case_end();
2770 writeOperand(i.getCaseValue(), true);
2772 writeOperand(i.getCaseSuccessor(), true);
2775 } else if (isa<IndirectBrInst>(I)) {
2776 // Special case indirectbr instruction to get formatting nice and correct.
2778 writeOperand(Operand, true);
2781 for (unsigned i = 1, e = I.getNumOperands(); i != e; ++i) {
2784 writeOperand(I.getOperand(i), true);
2787 } else if (const PHINode *PN = dyn_cast<PHINode>(&I)) {
2789 TypePrinter.print(I.getType(), Out);
2792 for (unsigned op = 0, Eop = PN->getNumIncomingValues(); op < Eop; ++op) {
2793 if (op) Out << ", ";
2795 writeOperand(PN->getIncomingValue(op), false); Out << ", ";
2796 writeOperand(PN->getIncomingBlock(op), false); Out << " ]";
2798 } else if (const ExtractValueInst *EVI = dyn_cast<ExtractValueInst>(&I)) {
2800 writeOperand(I.getOperand(0), true);
2801 for (const unsigned *i = EVI->idx_begin(), *e = EVI->idx_end(); i != e; ++i)
2803 } else if (const InsertValueInst *IVI = dyn_cast<InsertValueInst>(&I)) {
2805 writeOperand(I.getOperand(0), true); Out << ", ";
2806 writeOperand(I.getOperand(1), true);
2807 for (const unsigned *i = IVI->idx_begin(), *e = IVI->idx_end(); i != e; ++i)
2809 } else if (const LandingPadInst *LPI = dyn_cast<LandingPadInst>(&I)) {
2811 TypePrinter.print(I.getType(), Out);
2812 Out << " personality ";
2813 writeOperand(I.getOperand(0), true); Out << '\n';
2815 if (LPI->isCleanup())
2818 for (unsigned i = 0, e = LPI->getNumClauses(); i != e; ++i) {
2819 if (i != 0 || LPI->isCleanup()) Out << "\n";
2820 if (LPI->isCatch(i))
2825 writeOperand(LPI->getClause(i), true);
2827 } else if (isa<ReturnInst>(I) && !Operand) {
2829 } else if (const CallInst *CI = dyn_cast<CallInst>(&I)) {
2830 // Print the calling convention being used.
2831 if (CI->getCallingConv() != CallingConv::C) {
2833 PrintCallingConv(CI->getCallingConv(), Out);
2836 Operand = CI->getCalledValue();
2837 PointerType *PTy = cast<PointerType>(Operand->getType());
2838 FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
2839 Type *RetTy = FTy->getReturnType();
2840 const AttributeSet &PAL = CI->getAttributes();
2842 if (PAL.hasAttributes(AttributeSet::ReturnIndex))
2843 Out << ' ' << PAL.getAsString(AttributeSet::ReturnIndex);
2845 // If possible, print out the short form of the call instruction. We can
2846 // only do this if the first argument is a pointer to a nonvararg function,
2847 // and if the return type is not a pointer to a function.
2850 if (!FTy->isVarArg() &&
2851 (!RetTy->isPointerTy() ||
2852 !cast<PointerType>(RetTy)->getElementType()->isFunctionTy())) {
2853 TypePrinter.print(RetTy, Out);
2855 writeOperand(Operand, false);
2857 writeOperand(Operand, true);
2860 for (unsigned op = 0, Eop = CI->getNumArgOperands(); op < Eop; ++op) {
2863 writeParamOperand(CI->getArgOperand(op), PAL, op + 1);
2866 // Emit an ellipsis if this is a musttail call in a vararg function. This
2867 // is only to aid readability, musttail calls forward varargs by default.
2868 if (CI->isMustTailCall() && CI->getParent() &&
2869 CI->getParent()->getParent() &&
2870 CI->getParent()->getParent()->isVarArg())
2874 if (PAL.hasAttributes(AttributeSet::FunctionIndex))
2875 Out << " #" << Machine.getAttributeGroupSlot(PAL.getFnAttributes());
2876 } else if (const InvokeInst *II = dyn_cast<InvokeInst>(&I)) {
2877 Operand = II->getCalledValue();
2878 PointerType *PTy = cast<PointerType>(Operand->getType());
2879 FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
2880 Type *RetTy = FTy->getReturnType();
2881 const AttributeSet &PAL = II->getAttributes();
2883 // Print the calling convention being used.
2884 if (II->getCallingConv() != CallingConv::C) {
2886 PrintCallingConv(II->getCallingConv(), Out);
2889 if (PAL.hasAttributes(AttributeSet::ReturnIndex))
2890 Out << ' ' << PAL.getAsString(AttributeSet::ReturnIndex);
2892 // If possible, print out the short form of the invoke instruction. We can
2893 // only do this if the first argument is a pointer to a nonvararg function,
2894 // and if the return type is not a pointer to a function.
2897 if (!FTy->isVarArg() &&
2898 (!RetTy->isPointerTy() ||
2899 !cast<PointerType>(RetTy)->getElementType()->isFunctionTy())) {
2900 TypePrinter.print(RetTy, Out);
2902 writeOperand(Operand, false);
2904 writeOperand(Operand, true);
2907 for (unsigned op = 0, Eop = II->getNumArgOperands(); op < Eop; ++op) {
2910 writeParamOperand(II->getArgOperand(op), PAL, op + 1);
2914 if (PAL.hasAttributes(AttributeSet::FunctionIndex))
2915 Out << " #" << Machine.getAttributeGroupSlot(PAL.getFnAttributes());
2918 writeOperand(II->getNormalDest(), true);
2920 writeOperand(II->getUnwindDest(), true);
2922 } else if (const AllocaInst *AI = dyn_cast<AllocaInst>(&I)) {
2924 if (AI->isUsedWithInAlloca())
2926 TypePrinter.print(AI->getAllocatedType(), Out);
2928 // Explicitly write the array size if the code is broken, if it's an array
2929 // allocation, or if the type is not canonical for scalar allocations. The
2930 // latter case prevents the type from mutating when round-tripping through
2932 if (!AI->getArraySize() || AI->isArrayAllocation() ||
2933 !AI->getArraySize()->getType()->isIntegerTy(32)) {
2935 writeOperand(AI->getArraySize(), true);
2937 if (AI->getAlignment()) {
2938 Out << ", align " << AI->getAlignment();
2940 } else if (isa<CastInst>(I)) {
2943 writeOperand(Operand, true); // Work with broken code
2946 TypePrinter.print(I.getType(), Out);
2947 } else if (isa<VAArgInst>(I)) {
2950 writeOperand(Operand, true); // Work with broken code
2953 TypePrinter.print(I.getType(), Out);
2954 } else if (Operand) { // Print the normal way.
2955 if (const auto *GEP = dyn_cast<GetElementPtrInst>(&I)) {
2957 TypePrinter.print(GEP->getSourceElementType(), Out);
2959 } else if (const auto *LI = dyn_cast<LoadInst>(&I)) {
2961 TypePrinter.print(LI->getType(), Out);
2965 // PrintAllTypes - Instructions who have operands of all the same type
2966 // omit the type from all but the first operand. If the instruction has
2967 // different type operands (for example br), then they are all printed.
2968 bool PrintAllTypes = false;
2969 Type *TheType = Operand->getType();
2971 // Select, Store and ShuffleVector always print all types.
2972 if (isa<SelectInst>(I) || isa<StoreInst>(I) || isa<ShuffleVectorInst>(I)
2973 || isa<ReturnInst>(I)) {
2974 PrintAllTypes = true;
2976 for (unsigned i = 1, E = I.getNumOperands(); i != E; ++i) {
2977 Operand = I.getOperand(i);
2978 // note that Operand shouldn't be null, but the test helps make dump()
2979 // more tolerant of malformed IR
2980 if (Operand && Operand->getType() != TheType) {
2981 PrintAllTypes = true; // We have differing types! Print them all!
2987 if (!PrintAllTypes) {
2989 TypePrinter.print(TheType, Out);
2993 for (unsigned i = 0, E = I.getNumOperands(); i != E; ++i) {
2995 writeOperand(I.getOperand(i), PrintAllTypes);
2999 // Print atomic ordering/alignment for memory operations
3000 if (const LoadInst *LI = dyn_cast<LoadInst>(&I)) {
3002 writeAtomic(LI->getOrdering(), LI->getSynchScope());
3003 if (LI->getAlignment())
3004 Out << ", align " << LI->getAlignment();
3005 } else if (const StoreInst *SI = dyn_cast<StoreInst>(&I)) {
3007 writeAtomic(SI->getOrdering(), SI->getSynchScope());
3008 if (SI->getAlignment())
3009 Out << ", align " << SI->getAlignment();
3010 } else if (const AtomicCmpXchgInst *CXI = dyn_cast<AtomicCmpXchgInst>(&I)) {
3011 writeAtomicCmpXchg(CXI->getSuccessOrdering(), CXI->getFailureOrdering(),
3012 CXI->getSynchScope());
3013 } else if (const AtomicRMWInst *RMWI = dyn_cast<AtomicRMWInst>(&I)) {
3014 writeAtomic(RMWI->getOrdering(), RMWI->getSynchScope());
3015 } else if (const FenceInst *FI = dyn_cast<FenceInst>(&I)) {
3016 writeAtomic(FI->getOrdering(), FI->getSynchScope());
3019 // Print Metadata info.
3020 SmallVector<std::pair<unsigned, MDNode *>, 4> InstMD;
3021 I.getAllMetadata(InstMD);
3022 if (!InstMD.empty()) {
3023 SmallVector<StringRef, 8> MDNames;
3024 I.getType()->getContext().getMDKindNames(MDNames);
3025 for (unsigned i = 0, e = InstMD.size(); i != e; ++i) {
3026 unsigned Kind = InstMD[i].first;
3027 if (Kind < MDNames.size()) {
3028 Out << ", !" << MDNames[Kind];
3030 Out << ", !<unknown kind #" << Kind << ">";
3033 WriteAsOperandInternal(Out, InstMD[i].second, &TypePrinter, &Machine,
3037 printInfoComment(I);
3040 void AssemblyWriter::writeMDNode(unsigned Slot, const MDNode *Node) {
3041 Out << '!' << Slot << " = ";
3042 printMDNodeBody(Node);
3046 void AssemblyWriter::writeAllMDNodes() {
3047 SmallVector<const MDNode *, 16> Nodes;
3048 Nodes.resize(Machine.mdn_size());
3049 for (SlotTracker::mdn_iterator I = Machine.mdn_begin(), E = Machine.mdn_end();
3051 Nodes[I->second] = cast<MDNode>(I->first);
3053 for (unsigned i = 0, e = Nodes.size(); i != e; ++i) {
3054 writeMDNode(i, Nodes[i]);
3058 void AssemblyWriter::printMDNodeBody(const MDNode *Node) {
3059 WriteMDNodeBodyInternal(Out, Node, &TypePrinter, &Machine, TheModule);
3062 void AssemblyWriter::writeAllAttributeGroups() {
3063 std::vector<std::pair<AttributeSet, unsigned> > asVec;
3064 asVec.resize(Machine.as_size());
3066 for (SlotTracker::as_iterator I = Machine.as_begin(), E = Machine.as_end();
3068 asVec[I->second] = *I;
3070 for (std::vector<std::pair<AttributeSet, unsigned> >::iterator
3071 I = asVec.begin(), E = asVec.end(); I != E; ++I)
3072 Out << "attributes #" << I->second << " = { "
3073 << I->first.getAsString(AttributeSet::FunctionIndex, true) << " }\n";
3078 void AssemblyWriter::printUseListOrder(const UseListOrder &Order) {
3079 bool IsInFunction = Machine.getFunction();
3083 Out << "uselistorder";
3084 if (const BasicBlock *BB =
3085 IsInFunction ? nullptr : dyn_cast<BasicBlock>(Order.V)) {
3087 writeOperand(BB->getParent(), false);
3089 writeOperand(BB, false);
3092 writeOperand(Order.V, true);
3096 assert(Order.Shuffle.size() >= 2 && "Shuffle too small");
3097 Out << Order.Shuffle[0];
3098 for (unsigned I = 1, E = Order.Shuffle.size(); I != E; ++I)
3099 Out << ", " << Order.Shuffle[I];
3103 void AssemblyWriter::printUseLists(const Function *F) {
3105 [&]() { return !UseListOrders.empty() && UseListOrders.back().F == F; };
3110 Out << "\n; uselistorder directives\n";
3112 printUseListOrder(UseListOrders.back());
3113 UseListOrders.pop_back();
3117 //===----------------------------------------------------------------------===//
3118 // External Interface declarations
3119 //===----------------------------------------------------------------------===//
3121 void Module::print(raw_ostream &ROS, AssemblyAnnotationWriter *AAW) const {
3122 SlotTracker SlotTable(this);
3123 formatted_raw_ostream OS(ROS);
3124 AssemblyWriter W(OS, SlotTable, this, AAW);
3125 W.printModule(this);
3128 void NamedMDNode::print(raw_ostream &ROS) const {
3129 SlotTracker SlotTable(getParent());
3130 formatted_raw_ostream OS(ROS);
3131 AssemblyWriter W(OS, SlotTable, getParent(), nullptr);
3132 W.printNamedMDNode(this);
3135 void Comdat::print(raw_ostream &ROS) const {
3136 PrintLLVMName(ROS, getName(), ComdatPrefix);
3137 ROS << " = comdat ";
3139 switch (getSelectionKind()) {
3143 case Comdat::ExactMatch:
3144 ROS << "exactmatch";
3146 case Comdat::Largest:
3149 case Comdat::NoDuplicates:
3150 ROS << "noduplicates";
3152 case Comdat::SameSize:
3160 void Type::print(raw_ostream &OS) const {
3162 TP.print(const_cast<Type*>(this), OS);
3164 // If the type is a named struct type, print the body as well.
3165 if (StructType *STy = dyn_cast<StructType>(const_cast<Type*>(this)))
3166 if (!STy->isLiteral()) {
3168 TP.printStructBody(STy, OS);
3172 static bool isReferencingMDNode(const Instruction &I) {
3173 if (const auto *CI = dyn_cast<CallInst>(&I))
3174 if (Function *F = CI->getCalledFunction())
3175 if (F->isIntrinsic())
3176 for (auto &Op : I.operands())
3177 if (auto *V = dyn_cast_or_null<MetadataAsValue>(Op))
3178 if (isa<MDNode>(V->getMetadata()))
3183 void Value::print(raw_ostream &ROS) const {
3184 formatted_raw_ostream OS(ROS);
3185 if (const Instruction *I = dyn_cast<Instruction>(this)) {
3186 const Function *F = I->getParent() ? I->getParent()->getParent() : nullptr;
3187 SlotTracker SlotTable(
3189 /* ShouldInitializeAllMetadata */ isReferencingMDNode(*I));
3190 AssemblyWriter W(OS, SlotTable, getModuleFromVal(I), nullptr);
3191 W.printInstruction(*I);
3192 } else if (const BasicBlock *BB = dyn_cast<BasicBlock>(this)) {
3193 SlotTracker SlotTable(BB->getParent());
3194 AssemblyWriter W(OS, SlotTable, getModuleFromVal(BB), nullptr);
3195 W.printBasicBlock(BB);
3196 } else if (const GlobalValue *GV = dyn_cast<GlobalValue>(this)) {
3197 SlotTracker SlotTable(GV->getParent(),
3198 /* ShouldInitializeAllMetadata */ isa<Function>(GV));
3199 AssemblyWriter W(OS, SlotTable, GV->getParent(), nullptr);
3200 if (const GlobalVariable *V = dyn_cast<GlobalVariable>(GV))
3202 else if (const Function *F = dyn_cast<Function>(GV))
3205 W.printAlias(cast<GlobalAlias>(GV));
3206 } else if (const MetadataAsValue *V = dyn_cast<MetadataAsValue>(this)) {
3207 V->getMetadata()->print(ROS, getModuleFromVal(V));
3208 } else if (const Constant *C = dyn_cast<Constant>(this)) {
3209 TypePrinting TypePrinter;
3210 TypePrinter.print(C->getType(), OS);
3212 WriteConstantInternal(OS, C, TypePrinter, nullptr, nullptr);
3213 } else if (isa<InlineAsm>(this) || isa<Argument>(this)) {
3214 this->printAsOperand(OS);
3216 llvm_unreachable("Unknown value to print out!");
3220 void Value::printAsOperand(raw_ostream &O, bool PrintType, const Module *M) const {
3221 // Fast path: Don't construct and populate a TypePrinting object if we
3222 // won't be needing any types printed.
3223 bool IsMetadata = isa<MetadataAsValue>(this);
3224 if (!PrintType && ((!isa<Constant>(this) && !IsMetadata) || hasName() ||
3225 isa<GlobalValue>(this))) {
3226 WriteAsOperandInternal(O, this, nullptr, nullptr, M);
3231 M = getModuleFromVal(this);
3233 TypePrinting TypePrinter;
3235 TypePrinter.incorporateTypes(*M);
3237 TypePrinter.print(getType(), O);
3241 SlotTracker Machine(M, /* ShouldInitializeAllMetadata */ IsMetadata);
3242 WriteAsOperandInternal(O, this, &TypePrinter, &Machine, M);
3245 static void printMetadataImpl(raw_ostream &ROS, const Metadata &MD,
3246 const Module *M, bool OnlyAsOperand) {
3247 formatted_raw_ostream OS(ROS);
3249 auto *N = dyn_cast<MDNode>(&MD);
3250 TypePrinting TypePrinter;
3251 SlotTracker Machine(M, /* ShouldInitializeAllMetadata */ N);
3253 TypePrinter.incorporateTypes(*M);
3255 WriteAsOperandInternal(OS, &MD, &TypePrinter, &Machine, M,
3256 /* FromValue */ true);
3257 if (OnlyAsOperand || !N)
3261 WriteMDNodeBodyInternal(OS, N, &TypePrinter, &Machine, M);
3264 void Metadata::printAsOperand(raw_ostream &OS, const Module *M) const {
3265 printMetadataImpl(OS, *this, M, /* OnlyAsOperand */ true);
3268 void Metadata::print(raw_ostream &OS, const Module *M) const {
3269 printMetadataImpl(OS, *this, M, /* OnlyAsOperand */ false);
3272 // Value::dump - allow easy printing of Values from the debugger.
3274 void Value::dump() const { print(dbgs()); dbgs() << '\n'; }
3276 // Type::dump - allow easy printing of Types from the debugger.
3278 void Type::dump() const { print(dbgs()); dbgs() << '\n'; }
3280 // Module::dump() - Allow printing of Modules from the debugger.
3282 void Module::dump() const { print(dbgs(), nullptr); }
3284 // \brief Allow printing of Comdats from the debugger.
3286 void Comdat::dump() const { print(dbgs()); }
3288 // NamedMDNode::dump() - Allow printing of NamedMDNodes from the debugger.
3290 void NamedMDNode::dump() const { print(dbgs()); }
3293 void Metadata::dump() const { dump(nullptr); }
3296 void Metadata::dump(const Module *M) const {