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();
281 static void PrintCallingConv(unsigned cc, raw_ostream &Out) {
283 default: Out << "cc" << cc; break;
284 case CallingConv::Fast: Out << "fastcc"; break;
285 case CallingConv::Cold: Out << "coldcc"; break;
286 case CallingConv::WebKit_JS: Out << "webkit_jscc"; break;
287 case CallingConv::AnyReg: Out << "anyregcc"; break;
288 case CallingConv::PreserveMost: Out << "preserve_mostcc"; break;
289 case CallingConv::PreserveAll: Out << "preserve_allcc"; break;
290 case CallingConv::GHC: Out << "ghccc"; break;
291 case CallingConv::X86_StdCall: Out << "x86_stdcallcc"; break;
292 case CallingConv::X86_FastCall: Out << "x86_fastcallcc"; break;
293 case CallingConv::X86_ThisCall: Out << "x86_thiscallcc"; break;
294 case CallingConv::X86_VectorCall:Out << "x86_vectorcallcc"; break;
295 case CallingConv::Intel_OCL_BI: Out << "intel_ocl_bicc"; break;
296 case CallingConv::ARM_APCS: Out << "arm_apcscc"; break;
297 case CallingConv::ARM_AAPCS: Out << "arm_aapcscc"; break;
298 case CallingConv::ARM_AAPCS_VFP: Out << "arm_aapcs_vfpcc"; break;
299 case CallingConv::MSP430_INTR: Out << "msp430_intrcc"; break;
300 case CallingConv::PTX_Kernel: Out << "ptx_kernel"; break;
301 case CallingConv::PTX_Device: Out << "ptx_device"; break;
302 case CallingConv::X86_64_SysV: Out << "x86_64_sysvcc"; break;
303 case CallingConv::X86_64_Win64: Out << "x86_64_win64cc"; break;
304 case CallingConv::SPIR_FUNC: Out << "spir_func"; break;
305 case CallingConv::SPIR_KERNEL: Out << "spir_kernel"; break;
309 // PrintEscapedString - Print each character of the specified string, escaping
310 // it if it is not printable or if it is an escape char.
311 static void PrintEscapedString(StringRef Name, raw_ostream &Out) {
312 for (unsigned i = 0, e = Name.size(); i != e; ++i) {
313 unsigned char C = Name[i];
314 if (isprint(C) && C != '\\' && C != '"')
317 Out << '\\' << hexdigit(C >> 4) << hexdigit(C & 0x0F);
329 /// PrintLLVMName - Turn the specified name into an 'LLVM name', which is either
330 /// prefixed with % (if the string only contains simple characters) or is
331 /// surrounded with ""'s (if it has special chars in it). Print it out.
332 static void PrintLLVMName(raw_ostream &OS, StringRef Name, PrefixType Prefix) {
333 assert(!Name.empty() && "Cannot get empty name!");
335 case NoPrefix: break;
336 case GlobalPrefix: OS << '@'; break;
337 case ComdatPrefix: OS << '$'; break;
338 case LabelPrefix: break;
339 case LocalPrefix: OS << '%'; break;
342 // Scan the name to see if it needs quotes first.
343 bool NeedsQuotes = isdigit(static_cast<unsigned char>(Name[0]));
345 for (unsigned i = 0, e = Name.size(); i != e; ++i) {
346 // By making this unsigned, the value passed in to isalnum will always be
347 // in the range 0-255. This is important when building with MSVC because
348 // its implementation will assert. This situation can arise when dealing
349 // with UTF-8 multibyte characters.
350 unsigned char C = Name[i];
351 if (!isalnum(static_cast<unsigned char>(C)) && C != '-' && C != '.' &&
359 // If we didn't need any quotes, just write out the name in one blast.
365 // Okay, we need quotes. Output the quotes and escape any scary characters as
368 PrintEscapedString(Name, OS);
372 /// PrintLLVMName - Turn the specified name into an 'LLVM name', which is either
373 /// prefixed with % (if the string only contains simple characters) or is
374 /// surrounded with ""'s (if it has special chars in it). Print it out.
375 static void PrintLLVMName(raw_ostream &OS, const Value *V) {
376 PrintLLVMName(OS, V->getName(),
377 isa<GlobalValue>(V) ? GlobalPrefix : LocalPrefix);
383 void TypePrinting::incorporateTypes(const Module &M) {
384 NamedTypes.run(M, false);
386 // The list of struct types we got back includes all the struct types, split
387 // the unnamed ones out to a numbering and remove the anonymous structs.
388 unsigned NextNumber = 0;
390 std::vector<StructType*>::iterator NextToUse = NamedTypes.begin(), I, E;
391 for (I = NamedTypes.begin(), E = NamedTypes.end(); I != E; ++I) {
392 StructType *STy = *I;
394 // Ignore anonymous types.
395 if (STy->isLiteral())
398 if (STy->getName().empty())
399 NumberedTypes[STy] = NextNumber++;
404 NamedTypes.erase(NextToUse, NamedTypes.end());
408 /// CalcTypeName - Write the specified type to the specified raw_ostream, making
409 /// use of type names or up references to shorten the type name where possible.
410 void TypePrinting::print(Type *Ty, raw_ostream &OS) {
411 switch (Ty->getTypeID()) {
412 case Type::VoidTyID: OS << "void"; return;
413 case Type::HalfTyID: OS << "half"; return;
414 case Type::FloatTyID: OS << "float"; return;
415 case Type::DoubleTyID: OS << "double"; return;
416 case Type::X86_FP80TyID: OS << "x86_fp80"; return;
417 case Type::FP128TyID: OS << "fp128"; return;
418 case Type::PPC_FP128TyID: OS << "ppc_fp128"; return;
419 case Type::LabelTyID: OS << "label"; return;
420 case Type::MetadataTyID: OS << "metadata"; return;
421 case Type::X86_MMXTyID: OS << "x86_mmx"; return;
422 case Type::IntegerTyID:
423 OS << 'i' << cast<IntegerType>(Ty)->getBitWidth();
426 case Type::FunctionTyID: {
427 FunctionType *FTy = cast<FunctionType>(Ty);
428 print(FTy->getReturnType(), OS);
430 for (FunctionType::param_iterator I = FTy->param_begin(),
431 E = FTy->param_end(); I != E; ++I) {
432 if (I != FTy->param_begin())
436 if (FTy->isVarArg()) {
437 if (FTy->getNumParams()) OS << ", ";
443 case Type::StructTyID: {
444 StructType *STy = cast<StructType>(Ty);
446 if (STy->isLiteral())
447 return printStructBody(STy, OS);
449 if (!STy->getName().empty())
450 return PrintLLVMName(OS, STy->getName(), LocalPrefix);
452 DenseMap<StructType*, unsigned>::iterator I = NumberedTypes.find(STy);
453 if (I != NumberedTypes.end())
454 OS << '%' << I->second;
455 else // Not enumerated, print the hex address.
456 OS << "%\"type " << STy << '\"';
459 case Type::PointerTyID: {
460 PointerType *PTy = cast<PointerType>(Ty);
461 print(PTy->getElementType(), OS);
462 if (unsigned AddressSpace = PTy->getAddressSpace())
463 OS << " addrspace(" << AddressSpace << ')';
467 case Type::ArrayTyID: {
468 ArrayType *ATy = cast<ArrayType>(Ty);
469 OS << '[' << ATy->getNumElements() << " x ";
470 print(ATy->getElementType(), OS);
474 case Type::VectorTyID: {
475 VectorType *PTy = cast<VectorType>(Ty);
476 OS << "<" << PTy->getNumElements() << " x ";
477 print(PTy->getElementType(), OS);
482 llvm_unreachable("Invalid TypeID");
485 void TypePrinting::printStructBody(StructType *STy, raw_ostream &OS) {
486 if (STy->isOpaque()) {
494 if (STy->getNumElements() == 0) {
497 StructType::element_iterator I = STy->element_begin();
500 for (StructType::element_iterator E = STy->element_end(); I != E; ++I) {
511 //===----------------------------------------------------------------------===//
512 // SlotTracker Class: Enumerate slot numbers for unnamed values
513 //===----------------------------------------------------------------------===//
514 /// This class provides computation of slot numbers for LLVM Assembly writing.
518 /// ValueMap - A mapping of Values to slot numbers.
519 typedef DenseMap<const Value*, unsigned> ValueMap;
522 /// TheModule - The module for which we are holding slot numbers.
523 const Module* TheModule;
525 /// TheFunction - The function for which we are holding slot numbers.
526 const Function* TheFunction;
527 bool FunctionProcessed;
529 /// mMap - The slot map for the module level data.
533 /// fMap - The slot map for the function level data.
537 /// mdnMap - Map for MDNodes.
538 DenseMap<const MDNode*, unsigned> mdnMap;
541 /// asMap - The slot map for attribute sets.
542 DenseMap<AttributeSet, unsigned> asMap;
545 /// Construct from a module
546 explicit SlotTracker(const Module *M);
547 /// Construct from a function, starting out in incorp state.
548 explicit SlotTracker(const Function *F);
550 /// Return the slot number of the specified value in it's type
551 /// plane. If something is not in the SlotTracker, return -1.
552 int getLocalSlot(const Value *V);
553 int getGlobalSlot(const GlobalValue *V);
554 int getMetadataSlot(const MDNode *N);
555 int getAttributeGroupSlot(AttributeSet AS);
557 /// If you'd like to deal with a function instead of just a module, use
558 /// this method to get its data into the SlotTracker.
559 void incorporateFunction(const Function *F) {
561 FunctionProcessed = false;
564 const Function *getFunction() const { return TheFunction; }
566 /// After calling incorporateFunction, use this method to remove the
567 /// most recently incorporated function from the SlotTracker. This
568 /// will reset the state of the machine back to just the module contents.
569 void purgeFunction();
571 /// MDNode map iterators.
572 typedef DenseMap<const MDNode*, unsigned>::iterator mdn_iterator;
573 mdn_iterator mdn_begin() { return mdnMap.begin(); }
574 mdn_iterator mdn_end() { return mdnMap.end(); }
575 unsigned mdn_size() const { return mdnMap.size(); }
576 bool mdn_empty() const { return mdnMap.empty(); }
578 /// AttributeSet map iterators.
579 typedef DenseMap<AttributeSet, unsigned>::iterator as_iterator;
580 as_iterator as_begin() { return asMap.begin(); }
581 as_iterator as_end() { return asMap.end(); }
582 unsigned as_size() const { return asMap.size(); }
583 bool as_empty() const { return asMap.empty(); }
585 /// This function does the actual initialization.
586 inline void initialize();
588 // Implementation Details
590 /// CreateModuleSlot - Insert the specified GlobalValue* into the slot table.
591 void CreateModuleSlot(const GlobalValue *V);
593 /// CreateMetadataSlot - Insert the specified MDNode* into the slot table.
594 void CreateMetadataSlot(const MDNode *N);
596 /// CreateFunctionSlot - Insert the specified Value* into the slot table.
597 void CreateFunctionSlot(const Value *V);
599 /// \brief Insert the specified AttributeSet into the slot table.
600 void CreateAttributeSetSlot(AttributeSet AS);
602 /// Add all of the module level global variables (and their initializers)
603 /// and function declarations, but not the contents of those functions.
604 void processModule();
606 /// Add all of the functions arguments, basic blocks, and instructions.
607 void processFunction();
609 /// Add all of the metadata from an instruction.
610 void processInstructionMetadata(const Instruction &I);
612 SlotTracker(const SlotTracker &) = delete;
613 void operator=(const SlotTracker &) = delete;
616 SlotTracker *createSlotTracker(const Module *M) {
617 return new SlotTracker(M);
620 static SlotTracker *createSlotTracker(const Value *V) {
621 if (const Argument *FA = dyn_cast<Argument>(V))
622 return new SlotTracker(FA->getParent());
624 if (const Instruction *I = dyn_cast<Instruction>(V))
626 return new SlotTracker(I->getParent()->getParent());
628 if (const BasicBlock *BB = dyn_cast<BasicBlock>(V))
629 return new SlotTracker(BB->getParent());
631 if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(V))
632 return new SlotTracker(GV->getParent());
634 if (const GlobalAlias *GA = dyn_cast<GlobalAlias>(V))
635 return new SlotTracker(GA->getParent());
637 if (const Function *Func = dyn_cast<Function>(V))
638 return new SlotTracker(Func);
644 #define ST_DEBUG(X) dbgs() << X
649 // Module level constructor. Causes the contents of the Module (sans functions)
650 // to be added to the slot table.
651 SlotTracker::SlotTracker(const Module *M)
652 : TheModule(M), TheFunction(nullptr), FunctionProcessed(false), mNext(0),
653 fNext(0), mdnNext(0), asNext(0) {}
655 // Function level constructor. Causes the contents of the Module and the one
656 // function provided to be added to the slot table.
657 SlotTracker::SlotTracker(const Function *F)
658 : TheModule(F ? F->getParent() : nullptr), TheFunction(F),
659 FunctionProcessed(false), mNext(0), fNext(0), mdnNext(0), asNext(0) {}
661 inline void SlotTracker::initialize() {
664 TheModule = nullptr; ///< Prevent re-processing next time we're called.
667 if (TheFunction && !FunctionProcessed)
671 // Iterate through all the global variables, functions, and global
672 // variable initializers and create slots for them.
673 void SlotTracker::processModule() {
674 ST_DEBUG("begin processModule!\n");
676 // Add all of the unnamed global variables to the value table.
677 for (Module::const_global_iterator I = TheModule->global_begin(),
678 E = TheModule->global_end(); I != E; ++I) {
683 // Add metadata used by named metadata.
684 for (Module::const_named_metadata_iterator
685 I = TheModule->named_metadata_begin(),
686 E = TheModule->named_metadata_end(); I != E; ++I) {
687 const NamedMDNode *NMD = I;
688 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i)
689 CreateMetadataSlot(NMD->getOperand(i));
692 for (Module::const_iterator I = TheModule->begin(), E = TheModule->end();
695 // Add all the unnamed functions to the table.
698 // Add all the function attributes to the table.
699 // FIXME: Add attributes of other objects?
700 AttributeSet FnAttrs = I->getAttributes().getFnAttributes();
701 if (FnAttrs.hasAttributes(AttributeSet::FunctionIndex))
702 CreateAttributeSetSlot(FnAttrs);
705 ST_DEBUG("end processModule!\n");
708 // Process the arguments, basic blocks, and instructions of a function.
709 void SlotTracker::processFunction() {
710 ST_DEBUG("begin processFunction!\n");
713 // Add all the function arguments with no names.
714 for(Function::const_arg_iterator AI = TheFunction->arg_begin(),
715 AE = TheFunction->arg_end(); AI != AE; ++AI)
717 CreateFunctionSlot(AI);
719 ST_DEBUG("Inserting Instructions:\n");
721 // Add all of the basic blocks and instructions with no names.
722 for (auto &BB : *TheFunction) {
724 CreateFunctionSlot(&BB);
727 if (!I.getType()->isVoidTy() && !I.hasName())
728 CreateFunctionSlot(&I);
730 processInstructionMetadata(I);
732 // We allow direct calls to any llvm.foo function here, because the
733 // target may not be linked into the optimizer.
734 if (const CallInst *CI = dyn_cast<CallInst>(&I)) {
735 // Add all the call attributes to the table.
736 AttributeSet Attrs = CI->getAttributes().getFnAttributes();
737 if (Attrs.hasAttributes(AttributeSet::FunctionIndex))
738 CreateAttributeSetSlot(Attrs);
739 } else if (const InvokeInst *II = dyn_cast<InvokeInst>(&I)) {
740 // Add all the call attributes to the table.
741 AttributeSet Attrs = II->getAttributes().getFnAttributes();
742 if (Attrs.hasAttributes(AttributeSet::FunctionIndex))
743 CreateAttributeSetSlot(Attrs);
748 FunctionProcessed = true;
750 ST_DEBUG("end processFunction!\n");
753 void SlotTracker::processInstructionMetadata(const Instruction &I) {
754 // Process metadata used directly by intrinsics.
755 if (const CallInst *CI = dyn_cast<CallInst>(&I))
756 if (Function *F = CI->getCalledFunction())
757 if (F->isIntrinsic())
758 for (auto &Op : I.operands())
759 if (auto *V = dyn_cast_or_null<MetadataAsValue>(Op))
760 if (MDNode *N = dyn_cast<MDNode>(V->getMetadata()))
761 CreateMetadataSlot(N);
763 // Process metadata attached to this instruction.
764 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
765 I.getAllMetadata(MDs);
767 CreateMetadataSlot(MD.second);
770 /// Clean up after incorporating a function. This is the only way to get out of
771 /// the function incorporation state that affects get*Slot/Create*Slot. Function
772 /// incorporation state is indicated by TheFunction != 0.
773 void SlotTracker::purgeFunction() {
774 ST_DEBUG("begin purgeFunction!\n");
775 fMap.clear(); // Simply discard the function level map
776 TheFunction = nullptr;
777 FunctionProcessed = false;
778 ST_DEBUG("end purgeFunction!\n");
781 /// getGlobalSlot - Get the slot number of a global value.
782 int SlotTracker::getGlobalSlot(const GlobalValue *V) {
783 // Check for uninitialized state and do lazy initialization.
786 // Find the value in the module map
787 ValueMap::iterator MI = mMap.find(V);
788 return MI == mMap.end() ? -1 : (int)MI->second;
791 /// getMetadataSlot - Get the slot number of a MDNode.
792 int SlotTracker::getMetadataSlot(const MDNode *N) {
793 // Check for uninitialized state and do lazy initialization.
796 // Find the MDNode in the module map
797 mdn_iterator MI = mdnMap.find(N);
798 return MI == mdnMap.end() ? -1 : (int)MI->second;
802 /// getLocalSlot - Get the slot number for a value that is local to a function.
803 int SlotTracker::getLocalSlot(const Value *V) {
804 assert(!isa<Constant>(V) && "Can't get a constant or global slot with this!");
806 // Check for uninitialized state and do lazy initialization.
809 ValueMap::iterator FI = fMap.find(V);
810 return FI == fMap.end() ? -1 : (int)FI->second;
813 int SlotTracker::getAttributeGroupSlot(AttributeSet AS) {
814 // Check for uninitialized state and do lazy initialization.
817 // Find the AttributeSet in the module map.
818 as_iterator AI = asMap.find(AS);
819 return AI == asMap.end() ? -1 : (int)AI->second;
822 /// CreateModuleSlot - Insert the specified GlobalValue* into the slot table.
823 void SlotTracker::CreateModuleSlot(const GlobalValue *V) {
824 assert(V && "Can't insert a null Value into SlotTracker!");
825 assert(!V->getType()->isVoidTy() && "Doesn't need a slot!");
826 assert(!V->hasName() && "Doesn't need a slot!");
828 unsigned DestSlot = mNext++;
831 ST_DEBUG(" Inserting value [" << V->getType() << "] = " << V << " slot=" <<
833 // G = Global, F = Function, A = Alias, o = other
834 ST_DEBUG((isa<GlobalVariable>(V) ? 'G' :
835 (isa<Function>(V) ? 'F' :
836 (isa<GlobalAlias>(V) ? 'A' : 'o'))) << "]\n");
839 /// CreateSlot - Create a new slot for the specified value if it has no name.
840 void SlotTracker::CreateFunctionSlot(const Value *V) {
841 assert(!V->getType()->isVoidTy() && !V->hasName() && "Doesn't need a slot!");
843 unsigned DestSlot = fNext++;
846 // G = Global, F = Function, o = other
847 ST_DEBUG(" Inserting value [" << V->getType() << "] = " << V << " slot=" <<
848 DestSlot << " [o]\n");
851 /// CreateModuleSlot - Insert the specified MDNode* into the slot table.
852 void SlotTracker::CreateMetadataSlot(const MDNode *N) {
853 assert(N && "Can't insert a null Value into SlotTracker!");
855 unsigned DestSlot = mdnNext;
856 if (!mdnMap.insert(std::make_pair(N, DestSlot)).second)
860 // Recursively add any MDNodes referenced by operands.
861 for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i)
862 if (const MDNode *Op = dyn_cast_or_null<MDNode>(N->getOperand(i)))
863 CreateMetadataSlot(Op);
866 void SlotTracker::CreateAttributeSetSlot(AttributeSet AS) {
867 assert(AS.hasAttributes(AttributeSet::FunctionIndex) &&
868 "Doesn't need a slot!");
870 as_iterator I = asMap.find(AS);
871 if (I != asMap.end())
874 unsigned DestSlot = asNext++;
875 asMap[AS] = DestSlot;
878 //===----------------------------------------------------------------------===//
879 // AsmWriter Implementation
880 //===----------------------------------------------------------------------===//
882 static void WriteAsOperandInternal(raw_ostream &Out, const Value *V,
883 TypePrinting *TypePrinter,
884 SlotTracker *Machine,
885 const Module *Context);
887 static void WriteAsOperandInternal(raw_ostream &Out, const Metadata *MD,
888 TypePrinting *TypePrinter,
889 SlotTracker *Machine, const Module *Context,
890 bool FromValue = false);
892 static const char *getPredicateText(unsigned predicate) {
893 const char * pred = "unknown";
895 case FCmpInst::FCMP_FALSE: pred = "false"; break;
896 case FCmpInst::FCMP_OEQ: pred = "oeq"; break;
897 case FCmpInst::FCMP_OGT: pred = "ogt"; break;
898 case FCmpInst::FCMP_OGE: pred = "oge"; break;
899 case FCmpInst::FCMP_OLT: pred = "olt"; break;
900 case FCmpInst::FCMP_OLE: pred = "ole"; break;
901 case FCmpInst::FCMP_ONE: pred = "one"; break;
902 case FCmpInst::FCMP_ORD: pred = "ord"; break;
903 case FCmpInst::FCMP_UNO: pred = "uno"; break;
904 case FCmpInst::FCMP_UEQ: pred = "ueq"; break;
905 case FCmpInst::FCMP_UGT: pred = "ugt"; break;
906 case FCmpInst::FCMP_UGE: pred = "uge"; break;
907 case FCmpInst::FCMP_ULT: pred = "ult"; break;
908 case FCmpInst::FCMP_ULE: pred = "ule"; break;
909 case FCmpInst::FCMP_UNE: pred = "une"; break;
910 case FCmpInst::FCMP_TRUE: pred = "true"; break;
911 case ICmpInst::ICMP_EQ: pred = "eq"; break;
912 case ICmpInst::ICMP_NE: pred = "ne"; break;
913 case ICmpInst::ICMP_SGT: pred = "sgt"; break;
914 case ICmpInst::ICMP_SGE: pred = "sge"; break;
915 case ICmpInst::ICMP_SLT: pred = "slt"; break;
916 case ICmpInst::ICMP_SLE: pred = "sle"; break;
917 case ICmpInst::ICMP_UGT: pred = "ugt"; break;
918 case ICmpInst::ICMP_UGE: pred = "uge"; break;
919 case ICmpInst::ICMP_ULT: pred = "ult"; break;
920 case ICmpInst::ICMP_ULE: pred = "ule"; break;
925 static void writeAtomicRMWOperation(raw_ostream &Out,
926 AtomicRMWInst::BinOp Op) {
928 default: Out << " <unknown operation " << Op << ">"; break;
929 case AtomicRMWInst::Xchg: Out << " xchg"; break;
930 case AtomicRMWInst::Add: Out << " add"; break;
931 case AtomicRMWInst::Sub: Out << " sub"; break;
932 case AtomicRMWInst::And: Out << " and"; break;
933 case AtomicRMWInst::Nand: Out << " nand"; break;
934 case AtomicRMWInst::Or: Out << " or"; break;
935 case AtomicRMWInst::Xor: Out << " xor"; break;
936 case AtomicRMWInst::Max: Out << " max"; break;
937 case AtomicRMWInst::Min: Out << " min"; break;
938 case AtomicRMWInst::UMax: Out << " umax"; break;
939 case AtomicRMWInst::UMin: Out << " umin"; break;
943 static void WriteOptimizationInfo(raw_ostream &Out, const User *U) {
944 if (const FPMathOperator *FPO = dyn_cast<const FPMathOperator>(U)) {
945 // Unsafe algebra implies all the others, no need to write them all out
946 if (FPO->hasUnsafeAlgebra())
949 if (FPO->hasNoNaNs())
951 if (FPO->hasNoInfs())
953 if (FPO->hasNoSignedZeros())
955 if (FPO->hasAllowReciprocal())
960 if (const OverflowingBinaryOperator *OBO =
961 dyn_cast<OverflowingBinaryOperator>(U)) {
962 if (OBO->hasNoUnsignedWrap())
964 if (OBO->hasNoSignedWrap())
966 } else if (const PossiblyExactOperator *Div =
967 dyn_cast<PossiblyExactOperator>(U)) {
970 } else if (const GEPOperator *GEP = dyn_cast<GEPOperator>(U)) {
971 if (GEP->isInBounds())
976 static void WriteConstantInternal(raw_ostream &Out, const Constant *CV,
977 TypePrinting &TypePrinter,
978 SlotTracker *Machine,
979 const Module *Context) {
980 if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV)) {
981 if (CI->getType()->isIntegerTy(1)) {
982 Out << (CI->getZExtValue() ? "true" : "false");
985 Out << CI->getValue();
989 if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV)) {
990 if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEsingle ||
991 &CFP->getValueAPF().getSemantics() == &APFloat::IEEEdouble) {
992 // We would like to output the FP constant value in exponential notation,
993 // but we cannot do this if doing so will lose precision. Check here to
994 // make sure that we only output it in exponential format if we can parse
995 // the value back and get the same value.
998 bool isHalf = &CFP->getValueAPF().getSemantics()==&APFloat::IEEEhalf;
999 bool isDouble = &CFP->getValueAPF().getSemantics()==&APFloat::IEEEdouble;
1000 bool isInf = CFP->getValueAPF().isInfinity();
1001 bool isNaN = CFP->getValueAPF().isNaN();
1002 if (!isHalf && !isInf && !isNaN) {
1003 double Val = isDouble ? CFP->getValueAPF().convertToDouble() :
1004 CFP->getValueAPF().convertToFloat();
1005 SmallString<128> StrVal;
1006 raw_svector_ostream(StrVal) << Val;
1008 // Check to make sure that the stringized number is not some string like
1009 // "Inf" or NaN, that atof will accept, but the lexer will not. Check
1010 // that the string matches the "[-+]?[0-9]" regex.
1012 if ((StrVal[0] >= '0' && StrVal[0] <= '9') ||
1013 ((StrVal[0] == '-' || StrVal[0] == '+') &&
1014 (StrVal[1] >= '0' && StrVal[1] <= '9'))) {
1015 // Reparse stringized version!
1016 if (APFloat(APFloat::IEEEdouble, StrVal).convertToDouble() == Val) {
1022 // Otherwise we could not reparse it to exactly the same value, so we must
1023 // output the string in hexadecimal format! Note that loading and storing
1024 // floating point types changes the bits of NaNs on some hosts, notably
1025 // x86, so we must not use these types.
1026 static_assert(sizeof(double) == sizeof(uint64_t),
1027 "assuming that double is 64 bits!");
1029 APFloat apf = CFP->getValueAPF();
1030 // Halves and floats are represented in ASCII IR as double, convert.
1032 apf.convert(APFloat::IEEEdouble, APFloat::rmNearestTiesToEven,
1035 utohex_buffer(uint64_t(apf.bitcastToAPInt().getZExtValue()),
1040 // Either half, or some form of long double.
1041 // These appear as a magic letter identifying the type, then a
1042 // fixed number of hex digits.
1044 // Bit position, in the current word, of the next nibble to print.
1047 if (&CFP->getValueAPF().getSemantics() == &APFloat::x87DoubleExtended) {
1049 // api needed to prevent premature destruction
1050 APInt api = CFP->getValueAPF().bitcastToAPInt();
1051 const uint64_t* p = api.getRawData();
1052 uint64_t word = p[1];
1054 int width = api.getBitWidth();
1055 for (int j=0; j<width; j+=4, shiftcount-=4) {
1056 unsigned int nibble = (word>>shiftcount) & 15;
1058 Out << (unsigned char)(nibble + '0');
1060 Out << (unsigned char)(nibble - 10 + 'A');
1061 if (shiftcount == 0 && j+4 < width) {
1065 shiftcount = width-j-4;
1069 } else if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEquad) {
1072 } else if (&CFP->getValueAPF().getSemantics() == &APFloat::PPCDoubleDouble) {
1075 } else if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEhalf) {
1079 llvm_unreachable("Unsupported floating point type");
1080 // api needed to prevent premature destruction
1081 APInt api = CFP->getValueAPF().bitcastToAPInt();
1082 const uint64_t* p = api.getRawData();
1084 int width = api.getBitWidth();
1085 for (int j=0; j<width; j+=4, shiftcount-=4) {
1086 unsigned int nibble = (word>>shiftcount) & 15;
1088 Out << (unsigned char)(nibble + '0');
1090 Out << (unsigned char)(nibble - 10 + 'A');
1091 if (shiftcount == 0 && j+4 < width) {
1095 shiftcount = width-j-4;
1101 if (isa<ConstantAggregateZero>(CV)) {
1102 Out << "zeroinitializer";
1106 if (const BlockAddress *BA = dyn_cast<BlockAddress>(CV)) {
1107 Out << "blockaddress(";
1108 WriteAsOperandInternal(Out, BA->getFunction(), &TypePrinter, Machine,
1111 WriteAsOperandInternal(Out, BA->getBasicBlock(), &TypePrinter, Machine,
1117 if (const ConstantArray *CA = dyn_cast<ConstantArray>(CV)) {
1118 Type *ETy = CA->getType()->getElementType();
1120 TypePrinter.print(ETy, Out);
1122 WriteAsOperandInternal(Out, CA->getOperand(0),
1123 &TypePrinter, Machine,
1125 for (unsigned i = 1, e = CA->getNumOperands(); i != e; ++i) {
1127 TypePrinter.print(ETy, Out);
1129 WriteAsOperandInternal(Out, CA->getOperand(i), &TypePrinter, Machine,
1136 if (const ConstantDataArray *CA = dyn_cast<ConstantDataArray>(CV)) {
1137 // As a special case, print the array as a string if it is an array of
1138 // i8 with ConstantInt values.
1139 if (CA->isString()) {
1141 PrintEscapedString(CA->getAsString(), Out);
1146 Type *ETy = CA->getType()->getElementType();
1148 TypePrinter.print(ETy, Out);
1150 WriteAsOperandInternal(Out, CA->getElementAsConstant(0),
1151 &TypePrinter, Machine,
1153 for (unsigned i = 1, e = CA->getNumElements(); i != e; ++i) {
1155 TypePrinter.print(ETy, Out);
1157 WriteAsOperandInternal(Out, CA->getElementAsConstant(i), &TypePrinter,
1165 if (const ConstantStruct *CS = dyn_cast<ConstantStruct>(CV)) {
1166 if (CS->getType()->isPacked())
1169 unsigned N = CS->getNumOperands();
1172 TypePrinter.print(CS->getOperand(0)->getType(), Out);
1175 WriteAsOperandInternal(Out, CS->getOperand(0), &TypePrinter, Machine,
1178 for (unsigned i = 1; i < N; i++) {
1180 TypePrinter.print(CS->getOperand(i)->getType(), Out);
1183 WriteAsOperandInternal(Out, CS->getOperand(i), &TypePrinter, Machine,
1190 if (CS->getType()->isPacked())
1195 if (isa<ConstantVector>(CV) || isa<ConstantDataVector>(CV)) {
1196 Type *ETy = CV->getType()->getVectorElementType();
1198 TypePrinter.print(ETy, Out);
1200 WriteAsOperandInternal(Out, CV->getAggregateElement(0U), &TypePrinter,
1202 for (unsigned i = 1, e = CV->getType()->getVectorNumElements(); i != e;++i){
1204 TypePrinter.print(ETy, Out);
1206 WriteAsOperandInternal(Out, CV->getAggregateElement(i), &TypePrinter,
1213 if (isa<ConstantPointerNull>(CV)) {
1218 if (isa<UndefValue>(CV)) {
1223 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV)) {
1224 Out << CE->getOpcodeName();
1225 WriteOptimizationInfo(Out, CE);
1226 if (CE->isCompare())
1227 Out << ' ' << getPredicateText(CE->getPredicate());
1230 if (const GEPOperator *GEP = dyn_cast<GEPOperator>(CE)) {
1232 cast<PointerType>(GEP->getPointerOperandType()->getScalarType())
1238 for (User::const_op_iterator OI=CE->op_begin(); OI != CE->op_end(); ++OI) {
1239 TypePrinter.print((*OI)->getType(), Out);
1241 WriteAsOperandInternal(Out, *OI, &TypePrinter, Machine, Context);
1242 if (OI+1 != CE->op_end())
1246 if (CE->hasIndices()) {
1247 ArrayRef<unsigned> Indices = CE->getIndices();
1248 for (unsigned i = 0, e = Indices.size(); i != e; ++i)
1249 Out << ", " << Indices[i];
1254 TypePrinter.print(CE->getType(), Out);
1261 Out << "<placeholder or erroneous Constant>";
1264 static void writeMDTuple(raw_ostream &Out, const MDTuple *Node,
1265 TypePrinting *TypePrinter, SlotTracker *Machine,
1266 const Module *Context) {
1268 for (unsigned mi = 0, me = Node->getNumOperands(); mi != me; ++mi) {
1269 const Metadata *MD = Node->getOperand(mi);
1272 else if (auto *MDV = dyn_cast<ValueAsMetadata>(MD)) {
1273 Value *V = MDV->getValue();
1274 TypePrinter->print(V->getType(), Out);
1276 WriteAsOperandInternal(Out, V, TypePrinter, Machine, Context);
1278 WriteAsOperandInternal(Out, MD, TypePrinter, Machine, Context);
1288 struct FieldSeparator {
1291 FieldSeparator(const char *Sep = ", ") : Skip(true), Sep(Sep) {}
1293 raw_ostream &operator<<(raw_ostream &OS, FieldSeparator &FS) {
1298 return OS << FS.Sep;
1302 static void writeMetadataAsOperand(raw_ostream &Out, const Metadata *MD,
1303 TypePrinting *TypePrinter,
1304 SlotTracker *Machine,
1305 const Module *Context) {
1310 WriteAsOperandInternal(Out, MD, TypePrinter, Machine, Context);
1313 static void writeTag(raw_ostream &Out, FieldSeparator &FS, const DebugNode *N) {
1314 Out << FS << "tag: ";
1315 if (const char *Tag = dwarf::TagString(N->getTag()))
1321 static void writeStringField(raw_ostream &Out, FieldSeparator &FS,
1322 StringRef Name, StringRef Value,
1323 bool ShouldSkipEmpty = true) {
1324 if (ShouldSkipEmpty && Value.empty())
1327 Out << FS << Name << ": \"";
1328 PrintEscapedString(Value, Out);
1332 static void writeGenericDebugNode(raw_ostream &Out, const GenericDebugNode *N,
1333 TypePrinting *TypePrinter,
1334 SlotTracker *Machine, const Module *Context) {
1335 Out << "!GenericDebugNode(";
1337 writeTag(Out, FS, N);
1338 writeStringField(Out, FS, "header", N->getHeader());
1339 if (N->getNumDwarfOperands()) {
1340 Out << FS << "operands: {";
1342 for (auto &I : N->dwarf_operands()) {
1344 writeMetadataAsOperand(Out, I, TypePrinter, Machine, Context);
1351 static void writeMDLocation(raw_ostream &Out, const MDLocation *DL,
1352 TypePrinting *TypePrinter, SlotTracker *Machine,
1353 const Module *Context) {
1354 Out << "!MDLocation(";
1356 // Always output the line, since 0 is a relevant and important value for it.
1357 Out << FS << "line: " << DL->getLine();
1358 if (DL->getColumn())
1359 Out << FS << "column: " << DL->getColumn();
1360 Out << FS << "scope: ";
1361 WriteAsOperandInternal(Out, DL->getScope(), TypePrinter, Machine, Context);
1362 if (DL->getInlinedAt()) {
1363 Out << FS << "inlinedAt: ";
1364 WriteAsOperandInternal(Out, DL->getInlinedAt(), TypePrinter, Machine,
1370 static void writeMDSubrange(raw_ostream &Out, const MDSubrange *N,
1371 TypePrinting *, SlotTracker *, const Module *) {
1372 Out << "!MDSubrange(";
1374 Out << FS << "count: " << N->getCount();
1376 Out << FS << "lowerBound: " << N->getLo();
1380 static void writeMDEnumerator(raw_ostream &Out, const MDEnumerator *N,
1381 TypePrinting *, SlotTracker *, const Module *) {
1382 Out << "!MDEnumerator(";
1384 writeStringField(Out, FS, "name", N->getName(), /* ShouldSkipEmpty */ false);
1385 Out << FS << "value: " << N->getValue();
1389 static void writeMDBasicType(raw_ostream &Out, const MDBasicType *N,
1390 TypePrinting *, SlotTracker *, const Module *) {
1391 Out << "!MDBasicType(";
1393 if (N->getTag() != dwarf::DW_TAG_base_type)
1394 writeTag(Out, FS, N);
1395 writeStringField(Out, FS, "name", N->getName());
1396 if (N->getSizeInBits())
1397 Out << FS << "size: " << N->getSizeInBits();
1398 if (N->getAlignInBits())
1399 Out << FS << "align: " << N->getAlignInBits();
1400 if (unsigned Encoding = N->getEncoding()) {
1401 Out << FS << "encoding: ";
1402 if (const char *S = dwarf::AttributeEncodingString(Encoding))
1410 static void writeDIFlags(raw_ostream &Out, unsigned Flags) {
1411 SmallVector<unsigned, 8> SplitFlags;
1412 unsigned Extra = DIDescriptor::splitFlags(Flags, SplitFlags);
1414 FieldSeparator FS(" | ");
1415 for (unsigned F : SplitFlags) {
1416 const char *StringF = DIDescriptor::getFlagString(F);
1417 assert(StringF && "Expected valid flag");
1418 Out << FS << StringF;
1420 if (Extra || SplitFlags.empty())
1424 static void writeMDDerivedType(raw_ostream &Out, const MDDerivedType *N,
1425 TypePrinting *TypePrinter, SlotTracker *Machine,
1426 const Module *Context) {
1427 Out << "!MDDerivedType(";
1429 writeTag(Out, FS, N);
1430 writeStringField(Out, FS, "name", N->getName());
1431 if (N->getScope()) {
1432 Out << FS << "scope: ";
1433 writeMetadataAsOperand(Out, N->getScope(), TypePrinter, Machine, Context);
1436 Out << FS << "file: ";
1437 writeMetadataAsOperand(Out, N->getFile(), TypePrinter, Machine,
1441 Out << FS << "line: " << N->getLine();
1442 Out << FS << "baseType: ";
1443 writeMetadataAsOperand(Out, N->getBaseType(), TypePrinter, Machine, Context);
1444 if (N->getSizeInBits())
1445 Out << FS << "size: " << N->getSizeInBits();
1446 if (N->getAlignInBits())
1447 Out << FS << "align: " << N->getAlignInBits();
1448 if (N->getOffsetInBits())
1449 Out << FS << "offset: " << N->getOffsetInBits();
1450 if (auto Flags = N->getFlags()) {
1451 Out << FS << "flags: ";
1452 writeDIFlags(Out, Flags);
1454 if (N->getExtraData()) {
1455 Out << FS << "extraData: ";
1456 writeMetadataAsOperand(Out, N->getExtraData(), TypePrinter, Machine,
1462 static void writeMDCompositeType(raw_ostream &Out, const MDCompositeType *N,
1463 TypePrinting *TypePrinter,
1464 SlotTracker *Machine, const Module *Context) {
1465 Out << "!MDCompositeType(";
1467 writeTag(Out, FS, N);
1468 writeStringField(Out, FS, "name", N->getName());
1469 if (N->getScope()) {
1470 Out << FS << "scope: ";
1471 writeMetadataAsOperand(Out, N->getScope(), TypePrinter, Machine, Context);
1474 Out << FS << "file: ";
1475 writeMetadataAsOperand(Out, N->getFile(), TypePrinter, Machine,
1479 Out << FS << "line: " << N->getLine();
1480 if (N->getBaseType()) {
1481 Out << FS << "baseType: ";
1482 writeMetadataAsOperand(Out, N->getBaseType(), TypePrinter, Machine,
1485 if (N->getSizeInBits())
1486 Out << FS << "size: " << N->getSizeInBits();
1487 if (N->getAlignInBits())
1488 Out << FS << "align: " << N->getAlignInBits();
1489 if (N->getOffsetInBits())
1490 Out << FS << "offset: " << N->getOffsetInBits();
1491 if (auto Flags = N->getFlags()) {
1492 Out << FS << "flags: ";
1493 writeDIFlags(Out, Flags);
1495 if (N->getElements()) {
1496 Out << FS << "elements: ";
1497 writeMetadataAsOperand(Out, N->getElements(), TypePrinter, Machine,
1500 if (unsigned Lang = N->getRuntimeLang()) {
1501 Out << FS << "runtimeLang: ";
1502 if (const char *S = dwarf::LanguageString(Lang))
1508 if (N->getVTableHolder()) {
1509 Out << FS << "vtableHolder: ";
1510 writeMetadataAsOperand(Out, N->getVTableHolder(), TypePrinter, Machine,
1513 if (N->getTemplateParams()) {
1514 Out << FS << "templateParams: ";
1515 writeMetadataAsOperand(Out, N->getTemplateParams(), TypePrinter, Machine,
1518 writeStringField(Out, FS, "identifier", N->getIdentifier());
1522 static void writeMDSubroutineType(raw_ostream &Out, const MDSubroutineType *N,
1523 TypePrinting *TypePrinter,
1524 SlotTracker *Machine, const Module *Context) {
1525 Out << "!MDSubroutineType(";
1527 if (auto Flags = N->getFlags()) {
1528 Out << FS << "flags: ";
1529 writeDIFlags(Out, Flags);
1531 Out << FS << "types: ";
1532 writeMetadataAsOperand(Out, N->getTypeArray(), TypePrinter, Machine, Context);
1536 static void writeMDFile(raw_ostream &Out, const MDFile *N, TypePrinting *,
1537 SlotTracker *, const Module *) {
1540 writeStringField(Out, FS, "filename", N->getFilename(),
1541 /* ShouldSkipEmpty */ false);
1542 writeStringField(Out, FS, "directory", N->getDirectory(),
1543 /* ShouldSkipEmpty */ false);
1547 static void writeMDCompileUnit(raw_ostream &Out, const MDCompileUnit *N,
1548 TypePrinting *TypePrinter, SlotTracker *Machine,
1549 const Module *Context) {
1550 Out << "!MDCompileUnit(";
1552 Out << FS << "language: ";
1553 if (const char *Lang = dwarf::LanguageString(N->getSourceLanguage()))
1556 Out << N->getSourceLanguage();
1557 Out << FS << "file: ";
1558 writeMetadataAsOperand(Out, N->getFile(), TypePrinter, Machine, Context);
1559 writeStringField(Out, FS, "producer", N->getProducer());
1560 Out << FS << "isOptimized: " << (N->isOptimized() ? "true" : "false");
1561 writeStringField(Out, FS, "flags", N->getFlags());
1562 Out << FS << "runtimeVersion: " << N->getRuntimeVersion();
1563 writeStringField(Out, FS, "splitDebugFilename", N->getSplitDebugFilename());
1564 Out << FS << "emissionKind: " << N->getEmissionKind();
1565 if (N->getEnumTypes()) {
1566 Out << FS << "enums: ";
1567 writeMetadataAsOperand(Out, N->getEnumTypes(), TypePrinter, Machine,
1570 if (N->getRetainedTypes()) {
1571 Out << FS << "retainedTypes: ";
1572 writeMetadataAsOperand(Out, N->getRetainedTypes(), TypePrinter, Machine,
1575 if (N->getSubprograms()) {
1576 Out << FS << "subprograms: ";
1577 writeMetadataAsOperand(Out, N->getSubprograms(), TypePrinter, Machine,
1580 if (N->getGlobalVariables()) {
1581 Out << FS << "globals: ";
1582 writeMetadataAsOperand(Out, N->getGlobalVariables(), TypePrinter, Machine,
1585 if (N->getImportedEntities()) {
1586 Out << FS << "imports: ";
1587 writeMetadataAsOperand(Out, N->getImportedEntities(), TypePrinter, Machine,
1593 static void writeMDSubprogram(raw_ostream &Out, const MDSubprogram *N,
1594 TypePrinting *TypePrinter, SlotTracker *Machine,
1595 const Module *Context) {
1596 Out << "!MDSubprogram(";
1598 writeStringField(Out, FS, "name", N->getName());
1599 writeStringField(Out, FS, "linkageName", N->getLinkageName());
1600 Out << FS << "scope: ";
1601 writeMetadataAsOperand(Out, N->getScope(), TypePrinter, Machine, Context);
1603 Out << FS << "file: ";
1604 writeMetadataAsOperand(Out, N->getFile(), TypePrinter, Machine,
1608 Out << FS << "line: " << N->getLine();
1610 Out << FS << "type: ";
1611 writeMetadataAsOperand(Out, N->getType(), TypePrinter, Machine,
1614 Out << FS << "isLocal: " << (N->isLocalToUnit() ? "true" : "false");
1615 Out << FS << "isDefinition: " << (N->isDefinition() ? "true" : "false");
1616 if (N->getScopeLine())
1617 Out << FS << "scopeLine: " << N->getScopeLine();
1618 if (N->getContainingType()) {
1619 Out << FS << "containingType: ";
1620 writeMetadataAsOperand(Out, N->getContainingType(), TypePrinter, Machine,
1623 if (unsigned V = N->getVirtuality()) {
1624 Out << FS << "virtuality: ";
1625 if (const char *S = dwarf::VirtualityString(V))
1630 if (N->getVirtualIndex())
1631 Out << FS << "virtualIndex: " << N->getVirtualIndex();
1632 if (auto Flags = N->getFlags()) {
1633 Out << FS << "flags: ";
1634 writeDIFlags(Out, Flags);
1636 Out << FS << "isOptimized: " << (N->isOptimized() ? "true" : "false");
1637 if (N->getFunction()) {
1638 Out << FS << "function: ";
1639 writeMetadataAsOperand(Out, N->getFunction(), TypePrinter, Machine,
1642 if (N->getTemplateParams()) {
1643 Out << FS << "templateParams: ";
1644 writeMetadataAsOperand(Out, N->getTemplateParams(), TypePrinter, Machine,
1647 if (N->getDeclaration()) {
1648 Out << FS << "declaration: ";
1649 writeMetadataAsOperand(Out, N->getDeclaration(), TypePrinter, Machine,
1652 if (N->getVariables()) {
1653 Out << FS << "variables: ";
1654 writeMetadataAsOperand(Out, N->getVariables(), TypePrinter, Machine,
1660 static void writeMDLexicalBlock(raw_ostream &Out, const MDLexicalBlock *N,
1661 TypePrinting *TypePrinter, SlotTracker *Machine,
1662 const Module *Context) {
1663 Out << "!MDLexicalBlock(";
1665 Out << FS << "scope: ";
1666 writeMetadataAsOperand(Out, N->getScope(), TypePrinter, Machine, Context);
1668 Out << FS << "file: ";
1669 writeMetadataAsOperand(Out, N->getFile(), TypePrinter, Machine,
1673 Out << FS << "line: " << N->getLine();
1675 Out << FS << "column: " << N->getColumn();
1679 static void writeMDLexicalBlockFile(raw_ostream &Out,
1680 const MDLexicalBlockFile *N,
1681 TypePrinting *TypePrinter,
1682 SlotTracker *Machine,
1683 const Module *Context) {
1684 Out << "!MDLexicalBlockFile(";
1686 Out << FS << "scope: ";
1687 writeMetadataAsOperand(Out, N->getScope(), TypePrinter, Machine, Context);
1689 Out << FS << "file: ";
1690 writeMetadataAsOperand(Out, N->getFile(), TypePrinter, Machine,
1693 Out << FS << "discriminator: " << N->getDiscriminator();
1697 static void writeMDNamespace(raw_ostream &Out, const MDNamespace *N,
1698 TypePrinting *TypePrinter, SlotTracker *Machine,
1699 const Module *Context) {
1700 Out << "!MDNamespace(";
1702 writeStringField(Out, FS, "name", N->getName());
1703 Out << FS << "scope: ";
1704 writeMetadataAsOperand(Out, N->getScope(), TypePrinter, Machine, Context);
1706 Out << FS << "file: ";
1707 writeMetadataAsOperand(Out, N->getFile(), TypePrinter, Machine, Context);
1710 Out << FS << "line: " << N->getLine();
1714 static void writeMDTemplateTypeParameter(raw_ostream &Out,
1715 const MDTemplateTypeParameter *N,
1716 TypePrinting *TypePrinter,
1717 SlotTracker *Machine,
1718 const Module *Context) {
1719 Out << "!MDTemplateTypeParameter(";
1721 writeStringField(Out, FS, "name", N->getName());
1722 Out << FS << "type: ";
1723 writeMetadataAsOperand(Out, N->getType(), TypePrinter, Machine, Context);
1727 static void writeMDTemplateValueParameter(raw_ostream &Out,
1728 const MDTemplateValueParameter *N,
1729 TypePrinting *TypePrinter,
1730 SlotTracker *Machine,
1731 const Module *Context) {
1732 Out << "!MDTemplateValueParameter(";
1734 if (N->getTag() != dwarf::DW_TAG_template_value_parameter)
1735 writeTag(Out, FS, N);
1736 writeStringField(Out, FS, "name", N->getName());
1737 if (auto *Type = N->getType()) {
1738 Out << FS << "type: ";
1739 writeMetadataAsOperand(Out, Type, TypePrinter, Machine, Context);
1741 Out << FS << "value: ";
1742 writeMetadataAsOperand(Out, N->getValue(), TypePrinter, Machine, Context);
1746 static void writeMDGlobalVariable(raw_ostream &Out, const MDGlobalVariable *N,
1747 TypePrinting *TypePrinter,
1748 SlotTracker *Machine, const Module *Context) {
1749 Out << "!MDGlobalVariable(";
1751 writeStringField(Out, FS, "name", N->getName());
1752 writeStringField(Out, FS, "linkageName", N->getLinkageName());
1753 Out << FS << "scope: ";
1754 writeMetadataAsOperand(Out, N->getScope(), TypePrinter, Machine, Context);
1756 Out << FS << "file: ";
1757 writeMetadataAsOperand(Out, N->getFile(), TypePrinter, Machine,
1761 Out << FS << "line: " << N->getLine();
1763 Out << FS << "type: ";
1764 writeMetadataAsOperand(Out, N->getType(), TypePrinter, Machine,
1767 Out << FS << "isLocal: " << (N->isLocalToUnit() ? "true" : "false");
1768 Out << FS << "isDefinition: " << (N->isDefinition() ? "true" : "false");
1769 if (N->getVariable()) {
1770 Out << FS << "variable: ";
1771 writeMetadataAsOperand(Out, N->getVariable(), TypePrinter, Machine,
1774 if (N->getStaticDataMemberDeclaration()) {
1775 Out << FS << "declaration: ";
1776 writeMetadataAsOperand(Out, N->getStaticDataMemberDeclaration(),
1777 TypePrinter, Machine, Context);
1782 static void writeMDLocalVariable(raw_ostream &Out, const MDLocalVariable *N,
1783 TypePrinting *TypePrinter,
1784 SlotTracker *Machine, const Module *Context) {
1785 Out << "!MDLocalVariable(";
1787 writeTag(Out, FS, N);
1788 writeStringField(Out, FS, "name", N->getName());
1789 if (N->getTag() == dwarf::DW_TAG_arg_variable || N->getArg())
1790 Out << FS << "arg: " << N->getArg();
1791 Out << FS << "scope: ";
1792 writeMetadataAsOperand(Out, N->getScope(), TypePrinter, Machine, Context);
1794 Out << FS << "file: ";
1795 writeMetadataAsOperand(Out, N->getFile(), TypePrinter, Machine,
1799 Out << FS << "line: " << N->getLine();
1801 Out << FS << "type: ";
1802 writeMetadataAsOperand(Out, N->getType(), TypePrinter, Machine,
1805 if (auto Flags = N->getFlags()) {
1806 Out << FS << "flags: ";
1807 writeDIFlags(Out, Flags);
1809 if (N->getInlinedAt()) {
1810 Out << FS << "inlinedAt: ";
1811 writeMetadataAsOperand(Out, N->getInlinedAt(), TypePrinter, Machine,
1817 static void writeMDExpression(raw_ostream &Out, const MDExpression *N,
1818 TypePrinting *TypePrinter, SlotTracker *Machine,
1819 const Module *Context) {
1820 Out << "!MDExpression(";
1823 for (auto I = N->expr_op_begin(), E = N->expr_op_end(); I != E; ++I) {
1824 const char *OpStr = dwarf::OperationEncodingString(I->getOp());
1825 assert(OpStr && "Expected valid opcode");
1828 for (unsigned A = 0, AE = I->getNumArgs(); A != AE; ++A)
1829 Out << FS << I->getArg(A);
1832 for (const auto &I : N->getElements())
1838 static void writeMDObjCProperty(raw_ostream &Out, const MDObjCProperty *N,
1839 TypePrinting *TypePrinter, SlotTracker *Machine,
1840 const Module *Context) {
1841 Out << "!MDObjCProperty(";
1843 writeStringField(Out, FS, "name", N->getName());
1845 Out << FS << "file: ";
1846 writeMetadataAsOperand(Out, N->getFile(), TypePrinter, Machine, Context);
1849 Out << FS << "line: " << N->getLine();
1850 writeStringField(Out, FS, "setter", N->getSetterName());
1851 writeStringField(Out, FS, "getter", N->getGetterName());
1852 if (N->getAttributes())
1853 Out << FS << "attributes: " << N->getAttributes();
1855 Out << FS << "type: ";
1856 writeMetadataAsOperand(Out, N->getType(), TypePrinter, Machine, Context);
1861 static void writeMDImportedEntity(raw_ostream &Out, const MDImportedEntity *N,
1862 TypePrinting *TypePrinter,
1863 SlotTracker *Machine, const Module *Context) {
1864 Out << "!MDImportedEntity(";
1866 writeTag(Out, FS, N);
1867 writeStringField(Out, FS, "name", N->getName());
1868 Out << FS << "scope: ";
1869 writeMetadataAsOperand(Out, N->getScope(), TypePrinter, Machine, Context);
1870 if (N->getEntity()) {
1871 Out << FS << "entity: ";
1872 writeMetadataAsOperand(Out, N->getEntity(), TypePrinter, Machine, Context);
1875 Out << FS << "line: " << N->getLine();
1880 static void WriteMDNodeBodyInternal(raw_ostream &Out, const MDNode *Node,
1881 TypePrinting *TypePrinter,
1882 SlotTracker *Machine,
1883 const Module *Context) {
1884 assert(!Node->isTemporary() && "Unexpected forward declaration");
1886 if (Node->isDistinct())
1889 switch (Node->getMetadataID()) {
1891 llvm_unreachable("Expected uniquable MDNode");
1892 #define HANDLE_MDNODE_LEAF(CLASS) \
1893 case Metadata::CLASS##Kind: \
1894 write##CLASS(Out, cast<CLASS>(Node), TypePrinter, Machine, Context); \
1896 #include "llvm/IR/Metadata.def"
1900 // Full implementation of printing a Value as an operand with support for
1901 // TypePrinting, etc.
1902 static void WriteAsOperandInternal(raw_ostream &Out, const Value *V,
1903 TypePrinting *TypePrinter,
1904 SlotTracker *Machine,
1905 const Module *Context) {
1907 PrintLLVMName(Out, V);
1911 const Constant *CV = dyn_cast<Constant>(V);
1912 if (CV && !isa<GlobalValue>(CV)) {
1913 assert(TypePrinter && "Constants require TypePrinting!");
1914 WriteConstantInternal(Out, CV, *TypePrinter, Machine, Context);
1918 if (const InlineAsm *IA = dyn_cast<InlineAsm>(V)) {
1920 if (IA->hasSideEffects())
1921 Out << "sideeffect ";
1922 if (IA->isAlignStack())
1923 Out << "alignstack ";
1924 // We don't emit the AD_ATT dialect as it's the assumed default.
1925 if (IA->getDialect() == InlineAsm::AD_Intel)
1926 Out << "inteldialect ";
1928 PrintEscapedString(IA->getAsmString(), Out);
1930 PrintEscapedString(IA->getConstraintString(), Out);
1935 if (auto *MD = dyn_cast<MetadataAsValue>(V)) {
1936 WriteAsOperandInternal(Out, MD->getMetadata(), TypePrinter, Machine,
1937 Context, /* FromValue */ true);
1943 // If we have a SlotTracker, use it.
1945 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
1946 Slot = Machine->getGlobalSlot(GV);
1949 Slot = Machine->getLocalSlot(V);
1951 // If the local value didn't succeed, then we may be referring to a value
1952 // from a different function. Translate it, as this can happen when using
1953 // address of blocks.
1955 if ((Machine = createSlotTracker(V))) {
1956 Slot = Machine->getLocalSlot(V);
1960 } else if ((Machine = createSlotTracker(V))) {
1961 // Otherwise, create one to get the # and then destroy it.
1962 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
1963 Slot = Machine->getGlobalSlot(GV);
1966 Slot = Machine->getLocalSlot(V);
1975 Out << Prefix << Slot;
1980 static void WriteAsOperandInternal(raw_ostream &Out, const Metadata *MD,
1981 TypePrinting *TypePrinter,
1982 SlotTracker *Machine, const Module *Context,
1984 if (const MDNode *N = dyn_cast<MDNode>(MD)) {
1986 Machine = new SlotTracker(Context);
1987 int Slot = Machine->getMetadataSlot(N);
1989 // Give the pointer value instead of "badref", since this comes up all
1990 // the time when debugging.
1991 Out << "<" << N << ">";
1997 if (const MDString *MDS = dyn_cast<MDString>(MD)) {
1999 PrintEscapedString(MDS->getString(), Out);
2004 auto *V = cast<ValueAsMetadata>(MD);
2005 assert(TypePrinter && "TypePrinter required for metadata values");
2006 assert((FromValue || !isa<LocalAsMetadata>(V)) &&
2007 "Unexpected function-local metadata outside of value argument");
2009 TypePrinter->print(V->getValue()->getType(), Out);
2011 WriteAsOperandInternal(Out, V->getValue(), TypePrinter, Machine, Context);
2014 void AssemblyWriter::init() {
2017 TypePrinter.incorporateTypes(*TheModule);
2018 for (const Function &F : *TheModule)
2019 if (const Comdat *C = F.getComdat())
2021 for (const GlobalVariable &GV : TheModule->globals())
2022 if (const Comdat *C = GV.getComdat())
2027 AssemblyWriter::AssemblyWriter(formatted_raw_ostream &o, SlotTracker &Mac,
2029 AssemblyAnnotationWriter *AAW)
2030 : Out(o), TheModule(M), Machine(Mac), AnnotationWriter(AAW) {
2034 AssemblyWriter::AssemblyWriter(formatted_raw_ostream &o, const Module *M,
2035 AssemblyAnnotationWriter *AAW)
2036 : Out(o), TheModule(M), ModuleSlotTracker(createSlotTracker(M)),
2037 Machine(*ModuleSlotTracker), AnnotationWriter(AAW) {
2041 AssemblyWriter::~AssemblyWriter() { }
2043 void AssemblyWriter::writeOperand(const Value *Operand, bool PrintType) {
2045 Out << "<null operand!>";
2049 TypePrinter.print(Operand->getType(), Out);
2052 WriteAsOperandInternal(Out, Operand, &TypePrinter, &Machine, TheModule);
2055 void AssemblyWriter::writeAtomic(AtomicOrdering Ordering,
2056 SynchronizationScope SynchScope) {
2057 if (Ordering == NotAtomic)
2060 switch (SynchScope) {
2061 case SingleThread: Out << " singlethread"; break;
2062 case CrossThread: break;
2066 default: Out << " <bad ordering " << int(Ordering) << ">"; break;
2067 case Unordered: Out << " unordered"; break;
2068 case Monotonic: Out << " monotonic"; break;
2069 case Acquire: Out << " acquire"; break;
2070 case Release: Out << " release"; break;
2071 case AcquireRelease: Out << " acq_rel"; break;
2072 case SequentiallyConsistent: Out << " seq_cst"; break;
2076 void AssemblyWriter::writeAtomicCmpXchg(AtomicOrdering SuccessOrdering,
2077 AtomicOrdering FailureOrdering,
2078 SynchronizationScope SynchScope) {
2079 assert(SuccessOrdering != NotAtomic && FailureOrdering != NotAtomic);
2081 switch (SynchScope) {
2082 case SingleThread: Out << " singlethread"; break;
2083 case CrossThread: break;
2086 switch (SuccessOrdering) {
2087 default: Out << " <bad ordering " << int(SuccessOrdering) << ">"; break;
2088 case Unordered: Out << " unordered"; break;
2089 case Monotonic: Out << " monotonic"; break;
2090 case Acquire: Out << " acquire"; break;
2091 case Release: Out << " release"; break;
2092 case AcquireRelease: Out << " acq_rel"; break;
2093 case SequentiallyConsistent: Out << " seq_cst"; break;
2096 switch (FailureOrdering) {
2097 default: Out << " <bad ordering " << int(FailureOrdering) << ">"; break;
2098 case Unordered: Out << " unordered"; break;
2099 case Monotonic: Out << " monotonic"; break;
2100 case Acquire: Out << " acquire"; break;
2101 case Release: Out << " release"; break;
2102 case AcquireRelease: Out << " acq_rel"; break;
2103 case SequentiallyConsistent: Out << " seq_cst"; break;
2107 void AssemblyWriter::writeParamOperand(const Value *Operand,
2108 AttributeSet Attrs, unsigned Idx) {
2110 Out << "<null operand!>";
2115 TypePrinter.print(Operand->getType(), Out);
2116 // Print parameter attributes list
2117 if (Attrs.hasAttributes(Idx))
2118 Out << ' ' << Attrs.getAsString(Idx);
2120 // Print the operand
2121 WriteAsOperandInternal(Out, Operand, &TypePrinter, &Machine, TheModule);
2124 void AssemblyWriter::printModule(const Module *M) {
2125 Machine.initialize();
2127 if (shouldPreserveAssemblyUseListOrder())
2128 UseListOrders = predictUseListOrder(M);
2130 if (!M->getModuleIdentifier().empty() &&
2131 // Don't print the ID if it will start a new line (which would
2132 // require a comment char before it).
2133 M->getModuleIdentifier().find('\n') == std::string::npos)
2134 Out << "; ModuleID = '" << M->getModuleIdentifier() << "'\n";
2136 const std::string &DL = M->getDataLayoutStr();
2138 Out << "target datalayout = \"" << DL << "\"\n";
2139 if (!M->getTargetTriple().empty())
2140 Out << "target triple = \"" << M->getTargetTriple() << "\"\n";
2142 if (!M->getModuleInlineAsm().empty()) {
2143 // Split the string into lines, to make it easier to read the .ll file.
2144 std::string Asm = M->getModuleInlineAsm();
2146 size_t NewLine = Asm.find_first_of('\n', CurPos);
2148 while (NewLine != std::string::npos) {
2149 // We found a newline, print the portion of the asm string from the
2150 // last newline up to this newline.
2151 Out << "module asm \"";
2152 PrintEscapedString(std::string(Asm.begin()+CurPos, Asm.begin()+NewLine),
2156 NewLine = Asm.find_first_of('\n', CurPos);
2158 std::string rest(Asm.begin()+CurPos, Asm.end());
2159 if (!rest.empty()) {
2160 Out << "module asm \"";
2161 PrintEscapedString(rest, Out);
2166 printTypeIdentities();
2168 // Output all comdats.
2169 if (!Comdats.empty())
2171 for (const Comdat *C : Comdats) {
2173 if (C != Comdats.back())
2177 // Output all globals.
2178 if (!M->global_empty()) Out << '\n';
2179 for (Module::const_global_iterator I = M->global_begin(), E = M->global_end();
2181 printGlobal(I); Out << '\n';
2184 // Output all aliases.
2185 if (!M->alias_empty()) Out << "\n";
2186 for (Module::const_alias_iterator I = M->alias_begin(), E = M->alias_end();
2190 // Output global use-lists.
2191 printUseLists(nullptr);
2193 // Output all of the functions.
2194 for (Module::const_iterator I = M->begin(), E = M->end(); I != E; ++I)
2196 assert(UseListOrders.empty() && "All use-lists should have been consumed");
2198 // Output all attribute groups.
2199 if (!Machine.as_empty()) {
2201 writeAllAttributeGroups();
2204 // Output named metadata.
2205 if (!M->named_metadata_empty()) Out << '\n';
2207 for (Module::const_named_metadata_iterator I = M->named_metadata_begin(),
2208 E = M->named_metadata_end(); I != E; ++I)
2209 printNamedMDNode(I);
2212 if (!Machine.mdn_empty()) {
2218 void AssemblyWriter::printNamedMDNode(const NamedMDNode *NMD) {
2220 StringRef Name = NMD->getName();
2222 Out << "<empty name> ";
2224 if (isalpha(static_cast<unsigned char>(Name[0])) ||
2225 Name[0] == '-' || Name[0] == '$' ||
2226 Name[0] == '.' || Name[0] == '_')
2229 Out << '\\' << hexdigit(Name[0] >> 4) << hexdigit(Name[0] & 0x0F);
2230 for (unsigned i = 1, e = Name.size(); i != e; ++i) {
2231 unsigned char C = Name[i];
2232 if (isalnum(static_cast<unsigned char>(C)) || C == '-' || C == '$' ||
2233 C == '.' || C == '_')
2236 Out << '\\' << hexdigit(C >> 4) << hexdigit(C & 0x0F);
2240 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
2242 int Slot = Machine.getMetadataSlot(NMD->getOperand(i));
2252 static void PrintLinkage(GlobalValue::LinkageTypes LT,
2253 formatted_raw_ostream &Out) {
2255 case GlobalValue::ExternalLinkage: break;
2256 case GlobalValue::PrivateLinkage: Out << "private "; break;
2257 case GlobalValue::InternalLinkage: Out << "internal "; break;
2258 case GlobalValue::LinkOnceAnyLinkage: Out << "linkonce "; break;
2259 case GlobalValue::LinkOnceODRLinkage: Out << "linkonce_odr "; break;
2260 case GlobalValue::WeakAnyLinkage: Out << "weak "; break;
2261 case GlobalValue::WeakODRLinkage: Out << "weak_odr "; break;
2262 case GlobalValue::CommonLinkage: Out << "common "; break;
2263 case GlobalValue::AppendingLinkage: Out << "appending "; break;
2264 case GlobalValue::ExternalWeakLinkage: Out << "extern_weak "; break;
2265 case GlobalValue::AvailableExternallyLinkage:
2266 Out << "available_externally ";
2272 static void PrintVisibility(GlobalValue::VisibilityTypes Vis,
2273 formatted_raw_ostream &Out) {
2275 case GlobalValue::DefaultVisibility: break;
2276 case GlobalValue::HiddenVisibility: Out << "hidden "; break;
2277 case GlobalValue::ProtectedVisibility: Out << "protected "; break;
2281 static void PrintDLLStorageClass(GlobalValue::DLLStorageClassTypes SCT,
2282 formatted_raw_ostream &Out) {
2284 case GlobalValue::DefaultStorageClass: break;
2285 case GlobalValue::DLLImportStorageClass: Out << "dllimport "; break;
2286 case GlobalValue::DLLExportStorageClass: Out << "dllexport "; break;
2290 static void PrintThreadLocalModel(GlobalVariable::ThreadLocalMode TLM,
2291 formatted_raw_ostream &Out) {
2293 case GlobalVariable::NotThreadLocal:
2295 case GlobalVariable::GeneralDynamicTLSModel:
2296 Out << "thread_local ";
2298 case GlobalVariable::LocalDynamicTLSModel:
2299 Out << "thread_local(localdynamic) ";
2301 case GlobalVariable::InitialExecTLSModel:
2302 Out << "thread_local(initialexec) ";
2304 case GlobalVariable::LocalExecTLSModel:
2305 Out << "thread_local(localexec) ";
2310 static void maybePrintComdat(formatted_raw_ostream &Out,
2311 const GlobalObject &GO) {
2312 const Comdat *C = GO.getComdat();
2316 if (isa<GlobalVariable>(GO))
2320 if (GO.getName() == C->getName())
2324 PrintLLVMName(Out, C->getName(), ComdatPrefix);
2328 void AssemblyWriter::printGlobal(const GlobalVariable *GV) {
2329 if (GV->isMaterializable())
2330 Out << "; Materializable\n";
2332 WriteAsOperandInternal(Out, GV, &TypePrinter, &Machine, GV->getParent());
2335 if (!GV->hasInitializer() && GV->hasExternalLinkage())
2338 PrintLinkage(GV->getLinkage(), Out);
2339 PrintVisibility(GV->getVisibility(), Out);
2340 PrintDLLStorageClass(GV->getDLLStorageClass(), Out);
2341 PrintThreadLocalModel(GV->getThreadLocalMode(), Out);
2342 if (GV->hasUnnamedAddr())
2343 Out << "unnamed_addr ";
2345 if (unsigned AddressSpace = GV->getType()->getAddressSpace())
2346 Out << "addrspace(" << AddressSpace << ") ";
2347 if (GV->isExternallyInitialized()) Out << "externally_initialized ";
2348 Out << (GV->isConstant() ? "constant " : "global ");
2349 TypePrinter.print(GV->getType()->getElementType(), Out);
2351 if (GV->hasInitializer()) {
2353 writeOperand(GV->getInitializer(), false);
2356 if (GV->hasSection()) {
2357 Out << ", section \"";
2358 PrintEscapedString(GV->getSection(), Out);
2361 maybePrintComdat(Out, *GV);
2362 if (GV->getAlignment())
2363 Out << ", align " << GV->getAlignment();
2365 printInfoComment(*GV);
2368 void AssemblyWriter::printAlias(const GlobalAlias *GA) {
2369 if (GA->isMaterializable())
2370 Out << "; Materializable\n";
2372 // Don't crash when dumping partially built GA
2374 Out << "<<nameless>> = ";
2376 PrintLLVMName(Out, GA);
2379 PrintLinkage(GA->getLinkage(), Out);
2380 PrintVisibility(GA->getVisibility(), Out);
2381 PrintDLLStorageClass(GA->getDLLStorageClass(), Out);
2382 PrintThreadLocalModel(GA->getThreadLocalMode(), Out);
2383 if (GA->hasUnnamedAddr())
2384 Out << "unnamed_addr ";
2388 const Constant *Aliasee = GA->getAliasee();
2391 TypePrinter.print(GA->getType(), Out);
2392 Out << " <<NULL ALIASEE>>";
2394 writeOperand(Aliasee, !isa<ConstantExpr>(Aliasee));
2397 printInfoComment(*GA);
2401 void AssemblyWriter::printComdat(const Comdat *C) {
2405 void AssemblyWriter::printTypeIdentities() {
2406 if (TypePrinter.NumberedTypes.empty() &&
2407 TypePrinter.NamedTypes.empty())
2412 // We know all the numbers that each type is used and we know that it is a
2413 // dense assignment. Convert the map to an index table.
2414 std::vector<StructType*> NumberedTypes(TypePrinter.NumberedTypes.size());
2415 for (DenseMap<StructType*, unsigned>::iterator I =
2416 TypePrinter.NumberedTypes.begin(), E = TypePrinter.NumberedTypes.end();
2418 assert(I->second < NumberedTypes.size() && "Didn't get a dense numbering?");
2419 NumberedTypes[I->second] = I->first;
2422 // Emit all numbered types.
2423 for (unsigned i = 0, e = NumberedTypes.size(); i != e; ++i) {
2424 Out << '%' << i << " = type ";
2426 // Make sure we print out at least one level of the type structure, so
2427 // that we do not get %2 = type %2
2428 TypePrinter.printStructBody(NumberedTypes[i], Out);
2432 for (unsigned i = 0, e = TypePrinter.NamedTypes.size(); i != e; ++i) {
2433 PrintLLVMName(Out, TypePrinter.NamedTypes[i]->getName(), LocalPrefix);
2436 // Make sure we print out at least one level of the type structure, so
2437 // that we do not get %FILE = type %FILE
2438 TypePrinter.printStructBody(TypePrinter.NamedTypes[i], Out);
2443 /// printFunction - Print all aspects of a function.
2445 void AssemblyWriter::printFunction(const Function *F) {
2446 // Print out the return type and name.
2449 if (AnnotationWriter) AnnotationWriter->emitFunctionAnnot(F, Out);
2451 if (F->isMaterializable())
2452 Out << "; Materializable\n";
2454 const AttributeSet &Attrs = F->getAttributes();
2455 if (Attrs.hasAttributes(AttributeSet::FunctionIndex)) {
2456 AttributeSet AS = Attrs.getFnAttributes();
2457 std::string AttrStr;
2460 for (unsigned E = AS.getNumSlots(); Idx != E; ++Idx)
2461 if (AS.getSlotIndex(Idx) == AttributeSet::FunctionIndex)
2464 for (AttributeSet::iterator I = AS.begin(Idx), E = AS.end(Idx);
2466 Attribute Attr = *I;
2467 if (!Attr.isStringAttribute()) {
2468 if (!AttrStr.empty()) AttrStr += ' ';
2469 AttrStr += Attr.getAsString();
2473 if (!AttrStr.empty())
2474 Out << "; Function Attrs: " << AttrStr << '\n';
2477 if (F->isDeclaration())
2482 PrintLinkage(F->getLinkage(), Out);
2483 PrintVisibility(F->getVisibility(), Out);
2484 PrintDLLStorageClass(F->getDLLStorageClass(), Out);
2486 // Print the calling convention.
2487 if (F->getCallingConv() != CallingConv::C) {
2488 PrintCallingConv(F->getCallingConv(), Out);
2492 FunctionType *FT = F->getFunctionType();
2493 if (Attrs.hasAttributes(AttributeSet::ReturnIndex))
2494 Out << Attrs.getAsString(AttributeSet::ReturnIndex) << ' ';
2495 TypePrinter.print(F->getReturnType(), Out);
2497 WriteAsOperandInternal(Out, F, &TypePrinter, &Machine, F->getParent());
2499 Machine.incorporateFunction(F);
2501 // Loop over the arguments, printing them...
2504 if (!F->isDeclaration()) {
2505 // If this isn't a declaration, print the argument names as well.
2506 for (Function::const_arg_iterator I = F->arg_begin(), E = F->arg_end();
2508 // Insert commas as we go... the first arg doesn't get a comma
2509 if (I != F->arg_begin()) Out << ", ";
2510 printArgument(I, Attrs, Idx);
2514 // Otherwise, print the types from the function type.
2515 for (unsigned i = 0, e = FT->getNumParams(); i != e; ++i) {
2516 // Insert commas as we go... the first arg doesn't get a comma
2520 TypePrinter.print(FT->getParamType(i), Out);
2522 if (Attrs.hasAttributes(i+1))
2523 Out << ' ' << Attrs.getAsString(i+1);
2527 // Finish printing arguments...
2528 if (FT->isVarArg()) {
2529 if (FT->getNumParams()) Out << ", ";
2530 Out << "..."; // Output varargs portion of signature!
2533 if (F->hasUnnamedAddr())
2534 Out << " unnamed_addr";
2535 if (Attrs.hasAttributes(AttributeSet::FunctionIndex))
2536 Out << " #" << Machine.getAttributeGroupSlot(Attrs.getFnAttributes());
2537 if (F->hasSection()) {
2538 Out << " section \"";
2539 PrintEscapedString(F->getSection(), Out);
2542 maybePrintComdat(Out, *F);
2543 if (F->getAlignment())
2544 Out << " align " << F->getAlignment();
2546 Out << " gc \"" << F->getGC() << '"';
2547 if (F->hasPrefixData()) {
2549 writeOperand(F->getPrefixData(), true);
2551 if (F->hasPrologueData()) {
2552 Out << " prologue ";
2553 writeOperand(F->getPrologueData(), true);
2556 if (F->isDeclaration()) {
2560 // Output all of the function's basic blocks.
2561 for (Function::const_iterator I = F->begin(), E = F->end(); I != E; ++I)
2564 // Output the function's use-lists.
2570 Machine.purgeFunction();
2573 /// printArgument - This member is called for every argument that is passed into
2574 /// the function. Simply print it out
2576 void AssemblyWriter::printArgument(const Argument *Arg,
2577 AttributeSet Attrs, unsigned Idx) {
2579 TypePrinter.print(Arg->getType(), Out);
2581 // Output parameter attributes list
2582 if (Attrs.hasAttributes(Idx))
2583 Out << ' ' << Attrs.getAsString(Idx);
2585 // Output name, if available...
2586 if (Arg->hasName()) {
2588 PrintLLVMName(Out, Arg);
2592 /// printBasicBlock - This member is called for each basic block in a method.
2594 void AssemblyWriter::printBasicBlock(const BasicBlock *BB) {
2595 if (BB->hasName()) { // Print out the label if it exists...
2597 PrintLLVMName(Out, BB->getName(), LabelPrefix);
2599 } else if (!BB->use_empty()) { // Don't print block # of no uses...
2600 Out << "\n; <label>:";
2601 int Slot = Machine.getLocalSlot(BB);
2608 if (!BB->getParent()) {
2609 Out.PadToColumn(50);
2610 Out << "; Error: Block without parent!";
2611 } else if (BB != &BB->getParent()->getEntryBlock()) { // Not the entry block?
2612 // Output predecessors for the block.
2613 Out.PadToColumn(50);
2615 const_pred_iterator PI = pred_begin(BB), PE = pred_end(BB);
2618 Out << " No predecessors!";
2621 writeOperand(*PI, false);
2622 for (++PI; PI != PE; ++PI) {
2624 writeOperand(*PI, false);
2631 if (AnnotationWriter) AnnotationWriter->emitBasicBlockStartAnnot(BB, Out);
2633 // Output all of the instructions in the basic block...
2634 for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I != E; ++I) {
2635 printInstructionLine(*I);
2638 if (AnnotationWriter) AnnotationWriter->emitBasicBlockEndAnnot(BB, Out);
2641 /// printInstructionLine - Print an instruction and a newline character.
2642 void AssemblyWriter::printInstructionLine(const Instruction &I) {
2643 printInstruction(I);
2647 /// printInfoComment - Print a little comment after the instruction indicating
2648 /// which slot it occupies.
2650 void AssemblyWriter::printInfoComment(const Value &V) {
2651 if (AnnotationWriter)
2652 AnnotationWriter->printInfoComment(V, Out);
2655 // This member is called for each Instruction in a function..
2656 void AssemblyWriter::printInstruction(const Instruction &I) {
2657 if (AnnotationWriter) AnnotationWriter->emitInstructionAnnot(&I, Out);
2659 // Print out indentation for an instruction.
2662 // Print out name if it exists...
2664 PrintLLVMName(Out, &I);
2666 } else if (!I.getType()->isVoidTy()) {
2667 // Print out the def slot taken.
2668 int SlotNum = Machine.getLocalSlot(&I);
2670 Out << "<badref> = ";
2672 Out << '%' << SlotNum << " = ";
2675 if (const CallInst *CI = dyn_cast<CallInst>(&I)) {
2676 if (CI->isMustTailCall())
2678 else if (CI->isTailCall())
2682 // Print out the opcode...
2683 Out << I.getOpcodeName();
2685 // If this is an atomic load or store, print out the atomic marker.
2686 if ((isa<LoadInst>(I) && cast<LoadInst>(I).isAtomic()) ||
2687 (isa<StoreInst>(I) && cast<StoreInst>(I).isAtomic()))
2690 if (isa<AtomicCmpXchgInst>(I) && cast<AtomicCmpXchgInst>(I).isWeak())
2693 // If this is a volatile operation, print out the volatile marker.
2694 if ((isa<LoadInst>(I) && cast<LoadInst>(I).isVolatile()) ||
2695 (isa<StoreInst>(I) && cast<StoreInst>(I).isVolatile()) ||
2696 (isa<AtomicCmpXchgInst>(I) && cast<AtomicCmpXchgInst>(I).isVolatile()) ||
2697 (isa<AtomicRMWInst>(I) && cast<AtomicRMWInst>(I).isVolatile()))
2700 // Print out optimization information.
2701 WriteOptimizationInfo(Out, &I);
2703 // Print out the compare instruction predicates
2704 if (const CmpInst *CI = dyn_cast<CmpInst>(&I))
2705 Out << ' ' << getPredicateText(CI->getPredicate());
2707 // Print out the atomicrmw operation
2708 if (const AtomicRMWInst *RMWI = dyn_cast<AtomicRMWInst>(&I))
2709 writeAtomicRMWOperation(Out, RMWI->getOperation());
2711 // Print out the type of the operands...
2712 const Value *Operand = I.getNumOperands() ? I.getOperand(0) : nullptr;
2714 // Special case conditional branches to swizzle the condition out to the front
2715 if (isa<BranchInst>(I) && cast<BranchInst>(I).isConditional()) {
2716 const BranchInst &BI(cast<BranchInst>(I));
2718 writeOperand(BI.getCondition(), true);
2720 writeOperand(BI.getSuccessor(0), true);
2722 writeOperand(BI.getSuccessor(1), true);
2724 } else if (isa<SwitchInst>(I)) {
2725 const SwitchInst& SI(cast<SwitchInst>(I));
2726 // Special case switch instruction to get formatting nice and correct.
2728 writeOperand(SI.getCondition(), true);
2730 writeOperand(SI.getDefaultDest(), true);
2732 for (SwitchInst::ConstCaseIt i = SI.case_begin(), e = SI.case_end();
2735 writeOperand(i.getCaseValue(), true);
2737 writeOperand(i.getCaseSuccessor(), true);
2740 } else if (isa<IndirectBrInst>(I)) {
2741 // Special case indirectbr instruction to get formatting nice and correct.
2743 writeOperand(Operand, true);
2746 for (unsigned i = 1, e = I.getNumOperands(); i != e; ++i) {
2749 writeOperand(I.getOperand(i), true);
2752 } else if (const PHINode *PN = dyn_cast<PHINode>(&I)) {
2754 TypePrinter.print(I.getType(), Out);
2757 for (unsigned op = 0, Eop = PN->getNumIncomingValues(); op < Eop; ++op) {
2758 if (op) Out << ", ";
2760 writeOperand(PN->getIncomingValue(op), false); Out << ", ";
2761 writeOperand(PN->getIncomingBlock(op), false); Out << " ]";
2763 } else if (const ExtractValueInst *EVI = dyn_cast<ExtractValueInst>(&I)) {
2765 writeOperand(I.getOperand(0), true);
2766 for (const unsigned *i = EVI->idx_begin(), *e = EVI->idx_end(); i != e; ++i)
2768 } else if (const InsertValueInst *IVI = dyn_cast<InsertValueInst>(&I)) {
2770 writeOperand(I.getOperand(0), true); Out << ", ";
2771 writeOperand(I.getOperand(1), true);
2772 for (const unsigned *i = IVI->idx_begin(), *e = IVI->idx_end(); i != e; ++i)
2774 } else if (const LandingPadInst *LPI = dyn_cast<LandingPadInst>(&I)) {
2776 TypePrinter.print(I.getType(), Out);
2777 Out << " personality ";
2778 writeOperand(I.getOperand(0), true); Out << '\n';
2780 if (LPI->isCleanup())
2783 for (unsigned i = 0, e = LPI->getNumClauses(); i != e; ++i) {
2784 if (i != 0 || LPI->isCleanup()) Out << "\n";
2785 if (LPI->isCatch(i))
2790 writeOperand(LPI->getClause(i), true);
2792 } else if (isa<ReturnInst>(I) && !Operand) {
2794 } else if (const CallInst *CI = dyn_cast<CallInst>(&I)) {
2795 // Print the calling convention being used.
2796 if (CI->getCallingConv() != CallingConv::C) {
2798 PrintCallingConv(CI->getCallingConv(), Out);
2801 Operand = CI->getCalledValue();
2802 PointerType *PTy = cast<PointerType>(Operand->getType());
2803 FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
2804 Type *RetTy = FTy->getReturnType();
2805 const AttributeSet &PAL = CI->getAttributes();
2807 if (PAL.hasAttributes(AttributeSet::ReturnIndex))
2808 Out << ' ' << PAL.getAsString(AttributeSet::ReturnIndex);
2810 // If possible, print out the short form of the call instruction. We can
2811 // only do this if the first argument is a pointer to a nonvararg function,
2812 // and if the return type is not a pointer to a function.
2815 if (!FTy->isVarArg() &&
2816 (!RetTy->isPointerTy() ||
2817 !cast<PointerType>(RetTy)->getElementType()->isFunctionTy())) {
2818 TypePrinter.print(RetTy, Out);
2820 writeOperand(Operand, false);
2822 writeOperand(Operand, true);
2825 for (unsigned op = 0, Eop = CI->getNumArgOperands(); op < Eop; ++op) {
2828 writeParamOperand(CI->getArgOperand(op), PAL, op + 1);
2831 // Emit an ellipsis if this is a musttail call in a vararg function. This
2832 // is only to aid readability, musttail calls forward varargs by default.
2833 if (CI->isMustTailCall() && CI->getParent() &&
2834 CI->getParent()->getParent() &&
2835 CI->getParent()->getParent()->isVarArg())
2839 if (PAL.hasAttributes(AttributeSet::FunctionIndex))
2840 Out << " #" << Machine.getAttributeGroupSlot(PAL.getFnAttributes());
2841 } else if (const InvokeInst *II = dyn_cast<InvokeInst>(&I)) {
2842 Operand = II->getCalledValue();
2843 PointerType *PTy = cast<PointerType>(Operand->getType());
2844 FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
2845 Type *RetTy = FTy->getReturnType();
2846 const AttributeSet &PAL = II->getAttributes();
2848 // Print the calling convention being used.
2849 if (II->getCallingConv() != CallingConv::C) {
2851 PrintCallingConv(II->getCallingConv(), Out);
2854 if (PAL.hasAttributes(AttributeSet::ReturnIndex))
2855 Out << ' ' << PAL.getAsString(AttributeSet::ReturnIndex);
2857 // If possible, print out the short form of the invoke instruction. We can
2858 // only do this if the first argument is a pointer to a nonvararg function,
2859 // and if the return type is not a pointer to a function.
2862 if (!FTy->isVarArg() &&
2863 (!RetTy->isPointerTy() ||
2864 !cast<PointerType>(RetTy)->getElementType()->isFunctionTy())) {
2865 TypePrinter.print(RetTy, Out);
2867 writeOperand(Operand, false);
2869 writeOperand(Operand, true);
2872 for (unsigned op = 0, Eop = II->getNumArgOperands(); op < Eop; ++op) {
2875 writeParamOperand(II->getArgOperand(op), PAL, op + 1);
2879 if (PAL.hasAttributes(AttributeSet::FunctionIndex))
2880 Out << " #" << Machine.getAttributeGroupSlot(PAL.getFnAttributes());
2883 writeOperand(II->getNormalDest(), true);
2885 writeOperand(II->getUnwindDest(), true);
2887 } else if (const AllocaInst *AI = dyn_cast<AllocaInst>(&I)) {
2889 if (AI->isUsedWithInAlloca())
2891 TypePrinter.print(AI->getAllocatedType(), Out);
2893 // Explicitly write the array size if the code is broken, if it's an array
2894 // allocation, or if the type is not canonical for scalar allocations. The
2895 // latter case prevents the type from mutating when round-tripping through
2897 if (!AI->getArraySize() || AI->isArrayAllocation() ||
2898 !AI->getArraySize()->getType()->isIntegerTy(32)) {
2900 writeOperand(AI->getArraySize(), true);
2902 if (AI->getAlignment()) {
2903 Out << ", align " << AI->getAlignment();
2905 } else if (isa<CastInst>(I)) {
2908 writeOperand(Operand, true); // Work with broken code
2911 TypePrinter.print(I.getType(), Out);
2912 } else if (isa<VAArgInst>(I)) {
2915 writeOperand(Operand, true); // Work with broken code
2918 TypePrinter.print(I.getType(), Out);
2919 } else if (Operand) { // Print the normal way.
2920 if (const auto *GEP = dyn_cast<GetElementPtrInst>(&I)) {
2922 TypePrinter.print(GEP->getSourceElementType(), Out);
2924 } else if (const auto *LI = dyn_cast<LoadInst>(&I)) {
2926 TypePrinter.print(LI->getType(), Out);
2930 // PrintAllTypes - Instructions who have operands of all the same type
2931 // omit the type from all but the first operand. If the instruction has
2932 // different type operands (for example br), then they are all printed.
2933 bool PrintAllTypes = false;
2934 Type *TheType = Operand->getType();
2936 // Select, Store and ShuffleVector always print all types.
2937 if (isa<SelectInst>(I) || isa<StoreInst>(I) || isa<ShuffleVectorInst>(I)
2938 || isa<ReturnInst>(I)) {
2939 PrintAllTypes = true;
2941 for (unsigned i = 1, E = I.getNumOperands(); i != E; ++i) {
2942 Operand = I.getOperand(i);
2943 // note that Operand shouldn't be null, but the test helps make dump()
2944 // more tolerant of malformed IR
2945 if (Operand && Operand->getType() != TheType) {
2946 PrintAllTypes = true; // We have differing types! Print them all!
2952 if (!PrintAllTypes) {
2954 TypePrinter.print(TheType, Out);
2958 for (unsigned i = 0, E = I.getNumOperands(); i != E; ++i) {
2960 writeOperand(I.getOperand(i), PrintAllTypes);
2964 // Print atomic ordering/alignment for memory operations
2965 if (const LoadInst *LI = dyn_cast<LoadInst>(&I)) {
2967 writeAtomic(LI->getOrdering(), LI->getSynchScope());
2968 if (LI->getAlignment())
2969 Out << ", align " << LI->getAlignment();
2970 } else if (const StoreInst *SI = dyn_cast<StoreInst>(&I)) {
2972 writeAtomic(SI->getOrdering(), SI->getSynchScope());
2973 if (SI->getAlignment())
2974 Out << ", align " << SI->getAlignment();
2975 } else if (const AtomicCmpXchgInst *CXI = dyn_cast<AtomicCmpXchgInst>(&I)) {
2976 writeAtomicCmpXchg(CXI->getSuccessOrdering(), CXI->getFailureOrdering(),
2977 CXI->getSynchScope());
2978 } else if (const AtomicRMWInst *RMWI = dyn_cast<AtomicRMWInst>(&I)) {
2979 writeAtomic(RMWI->getOrdering(), RMWI->getSynchScope());
2980 } else if (const FenceInst *FI = dyn_cast<FenceInst>(&I)) {
2981 writeAtomic(FI->getOrdering(), FI->getSynchScope());
2984 // Print Metadata info.
2985 SmallVector<std::pair<unsigned, MDNode *>, 4> InstMD;
2986 I.getAllMetadata(InstMD);
2987 if (!InstMD.empty()) {
2988 SmallVector<StringRef, 8> MDNames;
2989 I.getType()->getContext().getMDKindNames(MDNames);
2990 for (unsigned i = 0, e = InstMD.size(); i != e; ++i) {
2991 unsigned Kind = InstMD[i].first;
2992 if (Kind < MDNames.size()) {
2993 Out << ", !" << MDNames[Kind];
2995 Out << ", !<unknown kind #" << Kind << ">";
2998 WriteAsOperandInternal(Out, InstMD[i].second, &TypePrinter, &Machine,
3002 printInfoComment(I);
3005 void AssemblyWriter::writeMDNode(unsigned Slot, const MDNode *Node) {
3006 Out << '!' << Slot << " = ";
3007 printMDNodeBody(Node);
3011 void AssemblyWriter::writeAllMDNodes() {
3012 SmallVector<const MDNode *, 16> Nodes;
3013 Nodes.resize(Machine.mdn_size());
3014 for (SlotTracker::mdn_iterator I = Machine.mdn_begin(), E = Machine.mdn_end();
3016 Nodes[I->second] = cast<MDNode>(I->first);
3018 for (unsigned i = 0, e = Nodes.size(); i != e; ++i) {
3019 writeMDNode(i, Nodes[i]);
3023 void AssemblyWriter::printMDNodeBody(const MDNode *Node) {
3024 WriteMDNodeBodyInternal(Out, Node, &TypePrinter, &Machine, TheModule);
3027 void AssemblyWriter::writeAllAttributeGroups() {
3028 std::vector<std::pair<AttributeSet, unsigned> > asVec;
3029 asVec.resize(Machine.as_size());
3031 for (SlotTracker::as_iterator I = Machine.as_begin(), E = Machine.as_end();
3033 asVec[I->second] = *I;
3035 for (std::vector<std::pair<AttributeSet, unsigned> >::iterator
3036 I = asVec.begin(), E = asVec.end(); I != E; ++I)
3037 Out << "attributes #" << I->second << " = { "
3038 << I->first.getAsString(AttributeSet::FunctionIndex, true) << " }\n";
3043 void AssemblyWriter::printUseListOrder(const UseListOrder &Order) {
3044 bool IsInFunction = Machine.getFunction();
3048 Out << "uselistorder";
3049 if (const BasicBlock *BB =
3050 IsInFunction ? nullptr : dyn_cast<BasicBlock>(Order.V)) {
3052 writeOperand(BB->getParent(), false);
3054 writeOperand(BB, false);
3057 writeOperand(Order.V, true);
3061 assert(Order.Shuffle.size() >= 2 && "Shuffle too small");
3062 Out << Order.Shuffle[0];
3063 for (unsigned I = 1, E = Order.Shuffle.size(); I != E; ++I)
3064 Out << ", " << Order.Shuffle[I];
3068 void AssemblyWriter::printUseLists(const Function *F) {
3070 [&]() { return !UseListOrders.empty() && UseListOrders.back().F == F; };
3075 Out << "\n; uselistorder directives\n";
3077 printUseListOrder(UseListOrders.back());
3078 UseListOrders.pop_back();
3082 //===----------------------------------------------------------------------===//
3083 // External Interface declarations
3084 //===----------------------------------------------------------------------===//
3086 void Module::print(raw_ostream &ROS, AssemblyAnnotationWriter *AAW) const {
3087 SlotTracker SlotTable(this);
3088 formatted_raw_ostream OS(ROS);
3089 AssemblyWriter W(OS, SlotTable, this, AAW);
3090 W.printModule(this);
3093 void NamedMDNode::print(raw_ostream &ROS) const {
3094 SlotTracker SlotTable(getParent());
3095 formatted_raw_ostream OS(ROS);
3096 AssemblyWriter W(OS, SlotTable, getParent(), nullptr);
3097 W.printNamedMDNode(this);
3100 void Comdat::print(raw_ostream &ROS) const {
3101 PrintLLVMName(ROS, getName(), ComdatPrefix);
3102 ROS << " = comdat ";
3104 switch (getSelectionKind()) {
3108 case Comdat::ExactMatch:
3109 ROS << "exactmatch";
3111 case Comdat::Largest:
3114 case Comdat::NoDuplicates:
3115 ROS << "noduplicates";
3117 case Comdat::SameSize:
3125 void Type::print(raw_ostream &OS) const {
3127 TP.print(const_cast<Type*>(this), OS);
3129 // If the type is a named struct type, print the body as well.
3130 if (StructType *STy = dyn_cast<StructType>(const_cast<Type*>(this)))
3131 if (!STy->isLiteral()) {
3133 TP.printStructBody(STy, OS);
3137 void Value::print(raw_ostream &ROS) const {
3138 formatted_raw_ostream OS(ROS);
3139 if (const Instruction *I = dyn_cast<Instruction>(this)) {
3140 const Function *F = I->getParent() ? I->getParent()->getParent() : nullptr;
3141 SlotTracker SlotTable(F);
3142 AssemblyWriter W(OS, SlotTable, getModuleFromVal(I), nullptr);
3143 W.printInstruction(*I);
3144 } else if (const BasicBlock *BB = dyn_cast<BasicBlock>(this)) {
3145 SlotTracker SlotTable(BB->getParent());
3146 AssemblyWriter W(OS, SlotTable, getModuleFromVal(BB), nullptr);
3147 W.printBasicBlock(BB);
3148 } else if (const GlobalValue *GV = dyn_cast<GlobalValue>(this)) {
3149 SlotTracker SlotTable(GV->getParent());
3150 AssemblyWriter W(OS, SlotTable, GV->getParent(), nullptr);
3151 if (const GlobalVariable *V = dyn_cast<GlobalVariable>(GV))
3153 else if (const Function *F = dyn_cast<Function>(GV))
3156 W.printAlias(cast<GlobalAlias>(GV));
3157 } else if (const MetadataAsValue *V = dyn_cast<MetadataAsValue>(this)) {
3158 V->getMetadata()->print(ROS);
3159 } else if (const Constant *C = dyn_cast<Constant>(this)) {
3160 TypePrinting TypePrinter;
3161 TypePrinter.print(C->getType(), OS);
3163 WriteConstantInternal(OS, C, TypePrinter, nullptr, nullptr);
3164 } else if (isa<InlineAsm>(this) || isa<Argument>(this)) {
3165 this->printAsOperand(OS);
3167 llvm_unreachable("Unknown value to print out!");
3171 void Value::printAsOperand(raw_ostream &O, bool PrintType, const Module *M) const {
3172 // Fast path: Don't construct and populate a TypePrinting object if we
3173 // won't be needing any types printed.
3174 if (!PrintType && ((!isa<Constant>(this) && !isa<MetadataAsValue>(this)) ||
3175 hasName() || isa<GlobalValue>(this))) {
3176 WriteAsOperandInternal(O, this, nullptr, nullptr, M);
3181 M = getModuleFromVal(this);
3183 TypePrinting TypePrinter;
3185 TypePrinter.incorporateTypes(*M);
3187 TypePrinter.print(getType(), O);
3191 WriteAsOperandInternal(O, this, &TypePrinter, nullptr, M);
3194 void Metadata::print(raw_ostream &ROS) const {
3195 formatted_raw_ostream OS(ROS);
3196 if (auto *N = dyn_cast<MDNode>(this)) {
3197 SlotTracker SlotTable(static_cast<Function *>(nullptr));
3198 AssemblyWriter W(OS, SlotTable, nullptr, nullptr);
3199 W.printMDNodeBody(N);
3206 void Metadata::printAsOperand(raw_ostream &ROS, bool PrintType,
3207 const Module *M) const {
3208 formatted_raw_ostream OS(ROS);
3210 std::unique_ptr<TypePrinting> TypePrinter;
3212 TypePrinter.reset(new TypePrinting);
3214 TypePrinter->incorporateTypes(*M);
3216 WriteAsOperandInternal(OS, this, TypePrinter.get(), nullptr, M,
3217 /* FromValue */ true);
3220 // Value::dump - allow easy printing of Values from the debugger.
3222 void Value::dump() const { print(dbgs()); dbgs() << '\n'; }
3224 // Type::dump - allow easy printing of Types from the debugger.
3226 void Type::dump() const { print(dbgs()); dbgs() << '\n'; }
3228 // Module::dump() - Allow printing of Modules from the debugger.
3230 void Module::dump() const { print(dbgs(), nullptr); }
3232 // \brief Allow printing of Comdats from the debugger.
3234 void Comdat::dump() const { print(dbgs()); }
3236 // NamedMDNode::dump() - Allow printing of NamedMDNodes from the debugger.
3238 void NamedMDNode::dump() const { print(dbgs()); }
3241 void Metadata::dump() const {