1 //===-- AsmWriter.cpp - Printing LLVM as an assembly file -----------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This library implements the functionality defined in llvm/IR/Writer.h
12 // Note that these routines must be extremely tolerant of various errors in the
13 // LLVM code, because it can be used for debugging transformations.
15 //===----------------------------------------------------------------------===//
17 #include "llvm/ADT/DenseMap.h"
18 #include "llvm/ADT/STLExtras.h"
19 #include "llvm/ADT/SetVector.h"
20 #include "llvm/ADT/SmallString.h"
21 #include "llvm/ADT/StringExtras.h"
22 #include "llvm/IR/AssemblyAnnotationWriter.h"
23 #include "llvm/IR/CFG.h"
24 #include "llvm/IR/CallingConv.h"
25 #include "llvm/IR/Constants.h"
26 #include "llvm/IR/DebugInfo.h"
27 #include "llvm/IR/DerivedTypes.h"
28 #include "llvm/IR/IRPrintingPasses.h"
29 #include "llvm/IR/InlineAsm.h"
30 #include "llvm/IR/IntrinsicInst.h"
31 #include "llvm/IR/LLVMContext.h"
32 #include "llvm/IR/Module.h"
33 #include "llvm/IR/Operator.h"
34 #include "llvm/IR/TypeFinder.h"
35 #include "llvm/IR/UseListOrder.h"
36 #include "llvm/IR/ValueSymbolTable.h"
37 #include "llvm/Support/Debug.h"
38 #include "llvm/Support/Dwarf.h"
39 #include "llvm/Support/ErrorHandling.h"
40 #include "llvm/Support/FormattedStream.h"
41 #include "llvm/Support/MathExtras.h"
42 #include "llvm/Support/raw_ostream.h"
47 // Make virtual table appear in this compilation unit.
48 AssemblyAnnotationWriter::~AssemblyAnnotationWriter() {}
50 //===----------------------------------------------------------------------===//
52 //===----------------------------------------------------------------------===//
56 DenseMap<const Value *, std::pair<unsigned, bool>> IDs;
58 unsigned size() const { return IDs.size(); }
59 std::pair<unsigned, bool> &operator[](const Value *V) { return IDs[V]; }
60 std::pair<unsigned, bool> lookup(const Value *V) const {
63 void index(const Value *V) {
64 // Explicitly sequence get-size and insert-value operations to avoid UB.
65 unsigned ID = IDs.size() + 1;
71 static void orderValue(const Value *V, OrderMap &OM) {
72 if (OM.lookup(V).first)
75 if (const Constant *C = dyn_cast<Constant>(V))
76 if (C->getNumOperands() && !isa<GlobalValue>(C))
77 for (const Value *Op : C->operands())
78 if (!isa<BasicBlock>(Op) && !isa<GlobalValue>(Op))
81 // Note: we cannot cache this lookup above, since inserting into the map
82 // changes the map's size, and thus affects the other IDs.
86 static OrderMap orderModule(const Module *M) {
87 // This needs to match the order used by ValueEnumerator::ValueEnumerator()
88 // and ValueEnumerator::incorporateFunction().
91 for (const GlobalVariable &G : M->globals()) {
92 if (G.hasInitializer())
93 if (!isa<GlobalValue>(G.getInitializer()))
94 orderValue(G.getInitializer(), OM);
97 for (const GlobalAlias &A : M->aliases()) {
98 if (!isa<GlobalValue>(A.getAliasee()))
99 orderValue(A.getAliasee(), OM);
102 for (const Function &F : *M) {
103 if (F.hasPrefixData())
104 if (!isa<GlobalValue>(F.getPrefixData()))
105 orderValue(F.getPrefixData(), OM);
107 if (F.hasPrologueData())
108 if (!isa<GlobalValue>(F.getPrologueData()))
109 orderValue(F.getPrologueData(), OM);
113 if (F.isDeclaration())
116 for (const Argument &A : F.args())
118 for (const BasicBlock &BB : F) {
120 for (const Instruction &I : BB) {
121 for (const Value *Op : I.operands())
122 if ((isa<Constant>(*Op) && !isa<GlobalValue>(*Op)) ||
132 static void predictValueUseListOrderImpl(const Value *V, const Function *F,
133 unsigned ID, const OrderMap &OM,
134 UseListOrderStack &Stack) {
135 // Predict use-list order for this one.
136 typedef std::pair<const Use *, unsigned> Entry;
137 SmallVector<Entry, 64> List;
138 for (const Use &U : V->uses())
139 // Check if this user will be serialized.
140 if (OM.lookup(U.getUser()).first)
141 List.push_back(std::make_pair(&U, List.size()));
144 // We may have lost some users.
148 !isa<GlobalVariable>(V) && !isa<Function>(V) && !isa<BasicBlock>(V);
149 if (auto *BA = dyn_cast<BlockAddress>(V))
150 ID = OM.lookup(BA->getBasicBlock()).first;
151 std::sort(List.begin(), List.end(), [&](const Entry &L, const Entry &R) {
152 const Use *LU = L.first;
153 const Use *RU = R.first;
157 auto LID = OM.lookup(LU->getUser()).first;
158 auto RID = OM.lookup(RU->getUser()).first;
160 // If ID is 4, then expect: 7 6 5 1 2 3.
174 // LID and RID are equal, so we have different operands of the same user.
175 // Assume operands are added in order for all instructions.
178 return LU->getOperandNo() < RU->getOperandNo();
179 return LU->getOperandNo() > RU->getOperandNo();
183 List.begin(), List.end(),
184 [](const Entry &L, const Entry &R) { return L.second < R.second; }))
185 // Order is already correct.
188 // Store the shuffle.
189 Stack.emplace_back(V, F, List.size());
190 assert(List.size() == Stack.back().Shuffle.size() && "Wrong size");
191 for (size_t I = 0, E = List.size(); I != E; ++I)
192 Stack.back().Shuffle[I] = List[I].second;
195 static void predictValueUseListOrder(const Value *V, const Function *F,
196 OrderMap &OM, UseListOrderStack &Stack) {
197 auto &IDPair = OM[V];
198 assert(IDPair.first && "Unmapped value");
200 // Already predicted.
203 // Do the actual prediction.
204 IDPair.second = true;
205 if (!V->use_empty() && std::next(V->use_begin()) != V->use_end())
206 predictValueUseListOrderImpl(V, F, IDPair.first, OM, Stack);
208 // Recursive descent into constants.
209 if (const Constant *C = dyn_cast<Constant>(V))
210 if (C->getNumOperands()) // Visit GlobalValues.
211 for (const Value *Op : C->operands())
212 if (isa<Constant>(Op)) // Visit GlobalValues.
213 predictValueUseListOrder(Op, F, OM, Stack);
216 static UseListOrderStack predictUseListOrder(const Module *M) {
217 OrderMap OM = orderModule(M);
219 // Use-list orders need to be serialized after all the users have been added
220 // to a value, or else the shuffles will be incomplete. Store them per
221 // function in a stack.
223 // Aside from function order, the order of values doesn't matter much here.
224 UseListOrderStack Stack;
226 // We want to visit the functions backward now so we can list function-local
227 // constants in the last Function they're used in. Module-level constants
228 // have already been visited above.
229 for (auto I = M->rbegin(), E = M->rend(); I != E; ++I) {
230 const Function &F = *I;
231 if (F.isDeclaration())
233 for (const BasicBlock &BB : F)
234 predictValueUseListOrder(&BB, &F, OM, Stack);
235 for (const Argument &A : F.args())
236 predictValueUseListOrder(&A, &F, OM, Stack);
237 for (const BasicBlock &BB : F)
238 for (const Instruction &I : BB)
239 for (const Value *Op : I.operands())
240 if (isa<Constant>(*Op) || isa<InlineAsm>(*Op)) // Visit GlobalValues.
241 predictValueUseListOrder(Op, &F, OM, Stack);
242 for (const BasicBlock &BB : F)
243 for (const Instruction &I : BB)
244 predictValueUseListOrder(&I, &F, OM, Stack);
247 // Visit globals last.
248 for (const GlobalVariable &G : M->globals())
249 predictValueUseListOrder(&G, nullptr, OM, Stack);
250 for (const Function &F : *M)
251 predictValueUseListOrder(&F, nullptr, OM, Stack);
252 for (const GlobalAlias &A : M->aliases())
253 predictValueUseListOrder(&A, nullptr, OM, Stack);
254 for (const GlobalVariable &G : M->globals())
255 if (G.hasInitializer())
256 predictValueUseListOrder(G.getInitializer(), nullptr, OM, Stack);
257 for (const GlobalAlias &A : M->aliases())
258 predictValueUseListOrder(A.getAliasee(), nullptr, OM, Stack);
259 for (const Function &F : *M)
260 if (F.hasPrefixData())
261 predictValueUseListOrder(F.getPrefixData(), nullptr, OM, Stack);
266 static const Module *getModuleFromVal(const Value *V) {
267 if (const Argument *MA = dyn_cast<Argument>(V))
268 return MA->getParent() ? MA->getParent()->getParent() : nullptr;
270 if (const BasicBlock *BB = dyn_cast<BasicBlock>(V))
271 return BB->getParent() ? BB->getParent()->getParent() : nullptr;
273 if (const Instruction *I = dyn_cast<Instruction>(V)) {
274 const Function *M = I->getParent() ? I->getParent()->getParent() : nullptr;
275 return M ? M->getParent() : nullptr;
278 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V))
279 return GV->getParent();
281 if (const auto *MAV = dyn_cast<MetadataAsValue>(V)) {
282 for (const User *U : MAV->users())
283 if (isa<Instruction>(U))
284 if (const Module *M = getModuleFromVal(U))
292 static void PrintCallingConv(unsigned cc, raw_ostream &Out) {
294 default: Out << "cc" << cc; break;
295 case CallingConv::Fast: Out << "fastcc"; break;
296 case CallingConv::Cold: Out << "coldcc"; break;
297 case CallingConv::WebKit_JS: Out << "webkit_jscc"; break;
298 case CallingConv::AnyReg: Out << "anyregcc"; break;
299 case CallingConv::PreserveMost: Out << "preserve_mostcc"; break;
300 case CallingConv::PreserveAll: Out << "preserve_allcc"; break;
301 case CallingConv::GHC: Out << "ghccc"; break;
302 case CallingConv::X86_StdCall: Out << "x86_stdcallcc"; break;
303 case CallingConv::X86_FastCall: Out << "x86_fastcallcc"; break;
304 case CallingConv::X86_ThisCall: Out << "x86_thiscallcc"; break;
305 case CallingConv::X86_VectorCall:Out << "x86_vectorcallcc"; break;
306 case CallingConv::Intel_OCL_BI: Out << "intel_ocl_bicc"; break;
307 case CallingConv::ARM_APCS: Out << "arm_apcscc"; break;
308 case CallingConv::ARM_AAPCS: Out << "arm_aapcscc"; break;
309 case CallingConv::ARM_AAPCS_VFP: Out << "arm_aapcs_vfpcc"; break;
310 case CallingConv::MSP430_INTR: Out << "msp430_intrcc"; break;
311 case CallingConv::PTX_Kernel: Out << "ptx_kernel"; break;
312 case CallingConv::PTX_Device: Out << "ptx_device"; break;
313 case CallingConv::X86_64_SysV: Out << "x86_64_sysvcc"; break;
314 case CallingConv::X86_64_Win64: Out << "x86_64_win64cc"; break;
315 case CallingConv::SPIR_FUNC: Out << "spir_func"; break;
316 case CallingConv::SPIR_KERNEL: Out << "spir_kernel"; break;
320 // PrintEscapedString - Print each character of the specified string, escaping
321 // it if it is not printable or if it is an escape char.
322 static void PrintEscapedString(StringRef Name, raw_ostream &Out) {
323 for (unsigned i = 0, e = Name.size(); i != e; ++i) {
324 unsigned char C = Name[i];
325 if (isprint(C) && C != '\\' && C != '"')
328 Out << '\\' << hexdigit(C >> 4) << hexdigit(C & 0x0F);
340 /// PrintLLVMName - Turn the specified name into an 'LLVM name', which is either
341 /// prefixed with % (if the string only contains simple characters) or is
342 /// surrounded with ""'s (if it has special chars in it). Print it out.
343 static void PrintLLVMName(raw_ostream &OS, StringRef Name, PrefixType Prefix) {
344 assert(!Name.empty() && "Cannot get empty name!");
346 case NoPrefix: break;
347 case GlobalPrefix: OS << '@'; break;
348 case ComdatPrefix: OS << '$'; break;
349 case LabelPrefix: break;
350 case LocalPrefix: OS << '%'; break;
353 // Scan the name to see if it needs quotes first.
354 bool NeedsQuotes = isdigit(static_cast<unsigned char>(Name[0]));
356 for (unsigned i = 0, e = Name.size(); i != e; ++i) {
357 // By making this unsigned, the value passed in to isalnum will always be
358 // in the range 0-255. This is important when building with MSVC because
359 // its implementation will assert. This situation can arise when dealing
360 // with UTF-8 multibyte characters.
361 unsigned char C = Name[i];
362 if (!isalnum(static_cast<unsigned char>(C)) && C != '-' && C != '.' &&
370 // If we didn't need any quotes, just write out the name in one blast.
376 // Okay, we need quotes. Output the quotes and escape any scary characters as
379 PrintEscapedString(Name, OS);
383 /// PrintLLVMName - Turn the specified name into an 'LLVM name', which is either
384 /// prefixed with % (if the string only contains simple characters) or is
385 /// surrounded with ""'s (if it has special chars in it). Print it out.
386 static void PrintLLVMName(raw_ostream &OS, const Value *V) {
387 PrintLLVMName(OS, V->getName(),
388 isa<GlobalValue>(V) ? GlobalPrefix : LocalPrefix);
394 TypePrinting(const TypePrinting &) = delete;
395 void operator=(const TypePrinting&) = delete;
398 /// NamedTypes - The named types that are used by the current module.
399 TypeFinder NamedTypes;
401 /// NumberedTypes - The numbered types, along with their value.
402 DenseMap<StructType*, unsigned> NumberedTypes;
408 void incorporateTypes(const Module &M);
410 void print(Type *Ty, raw_ostream &OS);
412 void printStructBody(StructType *Ty, raw_ostream &OS);
416 void TypePrinting::incorporateTypes(const Module &M) {
417 NamedTypes.run(M, false);
419 // The list of struct types we got back includes all the struct types, split
420 // the unnamed ones out to a numbering and remove the anonymous structs.
421 unsigned NextNumber = 0;
423 std::vector<StructType*>::iterator NextToUse = NamedTypes.begin(), I, E;
424 for (I = NamedTypes.begin(), E = NamedTypes.end(); I != E; ++I) {
425 StructType *STy = *I;
427 // Ignore anonymous types.
428 if (STy->isLiteral())
431 if (STy->getName().empty())
432 NumberedTypes[STy] = NextNumber++;
437 NamedTypes.erase(NextToUse, NamedTypes.end());
441 /// CalcTypeName - Write the specified type to the specified raw_ostream, making
442 /// use of type names or up references to shorten the type name where possible.
443 void TypePrinting::print(Type *Ty, raw_ostream &OS) {
444 switch (Ty->getTypeID()) {
445 case Type::VoidTyID: OS << "void"; return;
446 case Type::HalfTyID: OS << "half"; return;
447 case Type::FloatTyID: OS << "float"; return;
448 case Type::DoubleTyID: OS << "double"; return;
449 case Type::X86_FP80TyID: OS << "x86_fp80"; return;
450 case Type::FP128TyID: OS << "fp128"; return;
451 case Type::PPC_FP128TyID: OS << "ppc_fp128"; return;
452 case Type::LabelTyID: OS << "label"; return;
453 case Type::MetadataTyID: OS << "metadata"; return;
454 case Type::X86_MMXTyID: OS << "x86_mmx"; return;
455 case Type::IntegerTyID:
456 OS << 'i' << cast<IntegerType>(Ty)->getBitWidth();
459 case Type::FunctionTyID: {
460 FunctionType *FTy = cast<FunctionType>(Ty);
461 print(FTy->getReturnType(), OS);
463 for (FunctionType::param_iterator I = FTy->param_begin(),
464 E = FTy->param_end(); I != E; ++I) {
465 if (I != FTy->param_begin())
469 if (FTy->isVarArg()) {
470 if (FTy->getNumParams()) OS << ", ";
476 case Type::StructTyID: {
477 StructType *STy = cast<StructType>(Ty);
479 if (STy->isLiteral())
480 return printStructBody(STy, OS);
482 if (!STy->getName().empty())
483 return PrintLLVMName(OS, STy->getName(), LocalPrefix);
485 DenseMap<StructType*, unsigned>::iterator I = NumberedTypes.find(STy);
486 if (I != NumberedTypes.end())
487 OS << '%' << I->second;
488 else // Not enumerated, print the hex address.
489 OS << "%\"type " << STy << '\"';
492 case Type::PointerTyID: {
493 PointerType *PTy = cast<PointerType>(Ty);
494 print(PTy->getElementType(), OS);
495 if (unsigned AddressSpace = PTy->getAddressSpace())
496 OS << " addrspace(" << AddressSpace << ')';
500 case Type::ArrayTyID: {
501 ArrayType *ATy = cast<ArrayType>(Ty);
502 OS << '[' << ATy->getNumElements() << " x ";
503 print(ATy->getElementType(), OS);
507 case Type::VectorTyID: {
508 VectorType *PTy = cast<VectorType>(Ty);
509 OS << "<" << PTy->getNumElements() << " x ";
510 print(PTy->getElementType(), OS);
515 llvm_unreachable("Invalid TypeID");
518 void TypePrinting::printStructBody(StructType *STy, raw_ostream &OS) {
519 if (STy->isOpaque()) {
527 if (STy->getNumElements() == 0) {
530 StructType::element_iterator I = STy->element_begin();
533 for (StructType::element_iterator E = STy->element_end(); I != E; ++I) {
545 //===----------------------------------------------------------------------===//
546 // SlotTracker Class: Enumerate slot numbers for unnamed values
547 //===----------------------------------------------------------------------===//
548 /// This class provides computation of slot numbers for LLVM Assembly writing.
552 /// ValueMap - A mapping of Values to slot numbers.
553 typedef DenseMap<const Value*, unsigned> ValueMap;
556 /// TheModule - The module for which we are holding slot numbers.
557 const Module* TheModule;
559 /// TheFunction - The function for which we are holding slot numbers.
560 const Function* TheFunction;
561 bool FunctionProcessed;
562 bool ShouldInitializeAllMetadata;
564 /// mMap - The slot map for the module level data.
568 /// fMap - The slot map for the function level data.
572 /// mdnMap - Map for MDNodes.
573 DenseMap<const MDNode*, unsigned> mdnMap;
576 /// asMap - The slot map for attribute sets.
577 DenseMap<AttributeSet, unsigned> asMap;
580 /// Construct from a module.
582 /// If \c ShouldInitializeAllMetadata, initializes all metadata in all
583 /// functions, giving correct numbering for metadata referenced only from
584 /// within a function (even if no functions have been initialized).
585 explicit SlotTracker(const Module *M,
586 bool ShouldInitializeAllMetadata = false);
587 /// Construct from a function, starting out in incorp state.
589 /// If \c ShouldInitializeAllMetadata, initializes all metadata in all
590 /// functions, giving correct numbering for metadata referenced only from
591 /// within a function (even if no functions have been initialized).
592 explicit SlotTracker(const Function *F,
593 bool ShouldInitializeAllMetadata = false);
595 /// Return the slot number of the specified value in it's type
596 /// plane. If something is not in the SlotTracker, return -1.
597 int getLocalSlot(const Value *V);
598 int getGlobalSlot(const GlobalValue *V);
599 int getMetadataSlot(const MDNode *N);
600 int getAttributeGroupSlot(AttributeSet AS);
602 /// If you'd like to deal with a function instead of just a module, use
603 /// this method to get its data into the SlotTracker.
604 void incorporateFunction(const Function *F) {
606 FunctionProcessed = false;
609 const Function *getFunction() const { return TheFunction; }
611 /// After calling incorporateFunction, use this method to remove the
612 /// most recently incorporated function from the SlotTracker. This
613 /// will reset the state of the machine back to just the module contents.
614 void purgeFunction();
616 /// MDNode map iterators.
617 typedef DenseMap<const MDNode*, unsigned>::iterator mdn_iterator;
618 mdn_iterator mdn_begin() { return mdnMap.begin(); }
619 mdn_iterator mdn_end() { return mdnMap.end(); }
620 unsigned mdn_size() const { return mdnMap.size(); }
621 bool mdn_empty() const { return mdnMap.empty(); }
623 /// AttributeSet map iterators.
624 typedef DenseMap<AttributeSet, unsigned>::iterator as_iterator;
625 as_iterator as_begin() { return asMap.begin(); }
626 as_iterator as_end() { return asMap.end(); }
627 unsigned as_size() const { return asMap.size(); }
628 bool as_empty() const { return asMap.empty(); }
630 /// This function does the actual initialization.
631 inline void initialize();
633 // Implementation Details
635 /// CreateModuleSlot - Insert the specified GlobalValue* into the slot table.
636 void CreateModuleSlot(const GlobalValue *V);
638 /// CreateMetadataSlot - Insert the specified MDNode* into the slot table.
639 void CreateMetadataSlot(const MDNode *N);
641 /// CreateFunctionSlot - Insert the specified Value* into the slot table.
642 void CreateFunctionSlot(const Value *V);
644 /// \brief Insert the specified AttributeSet into the slot table.
645 void CreateAttributeSetSlot(AttributeSet AS);
647 /// Add all of the module level global variables (and their initializers)
648 /// and function declarations, but not the contents of those functions.
649 void processModule();
651 /// Add all of the functions arguments, basic blocks, and instructions.
652 void processFunction();
654 /// Add all of the metadata from a function.
655 void processFunctionMetadata(const Function &F);
657 /// Add all of the metadata from an instruction.
658 void processInstructionMetadata(const Instruction &I);
660 SlotTracker(const SlotTracker &) = delete;
661 void operator=(const SlotTracker &) = delete;
665 static SlotTracker *createSlotTracker(const Module *M) {
666 return new SlotTracker(M);
669 static SlotTracker *createSlotTracker(const Value *V) {
670 if (const Argument *FA = dyn_cast<Argument>(V))
671 return new SlotTracker(FA->getParent());
673 if (const Instruction *I = dyn_cast<Instruction>(V))
675 return new SlotTracker(I->getParent()->getParent());
677 if (const BasicBlock *BB = dyn_cast<BasicBlock>(V))
678 return new SlotTracker(BB->getParent());
680 if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(V))
681 return new SlotTracker(GV->getParent());
683 if (const GlobalAlias *GA = dyn_cast<GlobalAlias>(V))
684 return new SlotTracker(GA->getParent());
686 if (const Function *Func = dyn_cast<Function>(V))
687 return new SlotTracker(Func);
693 #define ST_DEBUG(X) dbgs() << X
698 // Module level constructor. Causes the contents of the Module (sans functions)
699 // to be added to the slot table.
700 SlotTracker::SlotTracker(const Module *M, bool ShouldInitializeAllMetadata)
701 : TheModule(M), TheFunction(nullptr), FunctionProcessed(false),
702 ShouldInitializeAllMetadata(ShouldInitializeAllMetadata), mNext(0),
703 fNext(0), mdnNext(0), asNext(0) {}
705 // Function level constructor. Causes the contents of the Module and the one
706 // function provided to be added to the slot table.
707 SlotTracker::SlotTracker(const Function *F, bool ShouldInitializeAllMetadata)
708 : TheModule(F ? F->getParent() : nullptr), TheFunction(F),
709 FunctionProcessed(false),
710 ShouldInitializeAllMetadata(ShouldInitializeAllMetadata), mNext(0),
711 fNext(0), mdnNext(0), asNext(0) {}
713 inline void SlotTracker::initialize() {
716 TheModule = nullptr; ///< Prevent re-processing next time we're called.
719 if (TheFunction && !FunctionProcessed)
723 // Iterate through all the global variables, functions, and global
724 // variable initializers and create slots for them.
725 void SlotTracker::processModule() {
726 ST_DEBUG("begin processModule!\n");
728 // Add all of the unnamed global variables to the value table.
729 for (Module::const_global_iterator I = TheModule->global_begin(),
730 E = TheModule->global_end(); I != E; ++I) {
735 // Add metadata used by named metadata.
736 for (Module::const_named_metadata_iterator
737 I = TheModule->named_metadata_begin(),
738 E = TheModule->named_metadata_end(); I != E; ++I) {
739 const NamedMDNode *NMD = I;
740 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i)
741 CreateMetadataSlot(NMD->getOperand(i));
744 for (Module::const_iterator I = TheModule->begin(), E = TheModule->end();
747 // Add all the unnamed functions to the table.
750 if (ShouldInitializeAllMetadata)
751 processFunctionMetadata(*I);
753 // Add all the function attributes to the table.
754 // FIXME: Add attributes of other objects?
755 AttributeSet FnAttrs = I->getAttributes().getFnAttributes();
756 if (FnAttrs.hasAttributes(AttributeSet::FunctionIndex))
757 CreateAttributeSetSlot(FnAttrs);
760 ST_DEBUG("end processModule!\n");
763 // Process the arguments, basic blocks, and instructions of a function.
764 void SlotTracker::processFunction() {
765 ST_DEBUG("begin processFunction!\n");
768 // Add all the function arguments with no names.
769 for(Function::const_arg_iterator AI = TheFunction->arg_begin(),
770 AE = TheFunction->arg_end(); AI != AE; ++AI)
772 CreateFunctionSlot(AI);
774 ST_DEBUG("Inserting Instructions:\n");
776 // Add all of the basic blocks and instructions with no names.
777 for (auto &BB : *TheFunction) {
779 CreateFunctionSlot(&BB);
782 if (!I.getType()->isVoidTy() && !I.hasName())
783 CreateFunctionSlot(&I);
785 processInstructionMetadata(I);
787 // We allow direct calls to any llvm.foo function here, because the
788 // target may not be linked into the optimizer.
789 if (const CallInst *CI = dyn_cast<CallInst>(&I)) {
790 // Add all the call attributes to the table.
791 AttributeSet Attrs = CI->getAttributes().getFnAttributes();
792 if (Attrs.hasAttributes(AttributeSet::FunctionIndex))
793 CreateAttributeSetSlot(Attrs);
794 } else if (const InvokeInst *II = dyn_cast<InvokeInst>(&I)) {
795 // Add all the call attributes to the table.
796 AttributeSet Attrs = II->getAttributes().getFnAttributes();
797 if (Attrs.hasAttributes(AttributeSet::FunctionIndex))
798 CreateAttributeSetSlot(Attrs);
803 FunctionProcessed = true;
805 ST_DEBUG("end processFunction!\n");
808 void SlotTracker::processFunctionMetadata(const Function &F) {
811 processInstructionMetadata(I);
814 void SlotTracker::processInstructionMetadata(const Instruction &I) {
815 // Process metadata used directly by intrinsics.
816 if (const CallInst *CI = dyn_cast<CallInst>(&I))
817 if (Function *F = CI->getCalledFunction())
818 if (F->isIntrinsic())
819 for (auto &Op : I.operands())
820 if (auto *V = dyn_cast_or_null<MetadataAsValue>(Op))
821 if (MDNode *N = dyn_cast<MDNode>(V->getMetadata()))
822 CreateMetadataSlot(N);
824 // Process metadata attached to this instruction.
825 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
826 I.getAllMetadata(MDs);
828 CreateMetadataSlot(MD.second);
831 /// Clean up after incorporating a function. This is the only way to get out of
832 /// the function incorporation state that affects get*Slot/Create*Slot. Function
833 /// incorporation state is indicated by TheFunction != 0.
834 void SlotTracker::purgeFunction() {
835 ST_DEBUG("begin purgeFunction!\n");
836 fMap.clear(); // Simply discard the function level map
837 TheFunction = nullptr;
838 FunctionProcessed = false;
839 ST_DEBUG("end purgeFunction!\n");
842 /// getGlobalSlot - Get the slot number of a global value.
843 int SlotTracker::getGlobalSlot(const GlobalValue *V) {
844 // Check for uninitialized state and do lazy initialization.
847 // Find the value in the module map
848 ValueMap::iterator MI = mMap.find(V);
849 return MI == mMap.end() ? -1 : (int)MI->second;
852 /// getMetadataSlot - Get the slot number of a MDNode.
853 int SlotTracker::getMetadataSlot(const MDNode *N) {
854 // Check for uninitialized state and do lazy initialization.
857 // Find the MDNode in the module map
858 mdn_iterator MI = mdnMap.find(N);
859 return MI == mdnMap.end() ? -1 : (int)MI->second;
863 /// getLocalSlot - Get the slot number for a value that is local to a function.
864 int SlotTracker::getLocalSlot(const Value *V) {
865 assert(!isa<Constant>(V) && "Can't get a constant or global slot with this!");
867 // Check for uninitialized state and do lazy initialization.
870 ValueMap::iterator FI = fMap.find(V);
871 return FI == fMap.end() ? -1 : (int)FI->second;
874 int SlotTracker::getAttributeGroupSlot(AttributeSet AS) {
875 // Check for uninitialized state and do lazy initialization.
878 // Find the AttributeSet in the module map.
879 as_iterator AI = asMap.find(AS);
880 return AI == asMap.end() ? -1 : (int)AI->second;
883 /// CreateModuleSlot - Insert the specified GlobalValue* into the slot table.
884 void SlotTracker::CreateModuleSlot(const GlobalValue *V) {
885 assert(V && "Can't insert a null Value into SlotTracker!");
886 assert(!V->getType()->isVoidTy() && "Doesn't need a slot!");
887 assert(!V->hasName() && "Doesn't need a slot!");
889 unsigned DestSlot = mNext++;
892 ST_DEBUG(" Inserting value [" << V->getType() << "] = " << V << " slot=" <<
894 // G = Global, F = Function, A = Alias, o = other
895 ST_DEBUG((isa<GlobalVariable>(V) ? 'G' :
896 (isa<Function>(V) ? 'F' :
897 (isa<GlobalAlias>(V) ? 'A' : 'o'))) << "]\n");
900 /// CreateSlot - Create a new slot for the specified value if it has no name.
901 void SlotTracker::CreateFunctionSlot(const Value *V) {
902 assert(!V->getType()->isVoidTy() && !V->hasName() && "Doesn't need a slot!");
904 unsigned DestSlot = fNext++;
907 // G = Global, F = Function, o = other
908 ST_DEBUG(" Inserting value [" << V->getType() << "] = " << V << " slot=" <<
909 DestSlot << " [o]\n");
912 /// CreateModuleSlot - Insert the specified MDNode* into the slot table.
913 void SlotTracker::CreateMetadataSlot(const MDNode *N) {
914 assert(N && "Can't insert a null Value into SlotTracker!");
916 unsigned DestSlot = mdnNext;
917 if (!mdnMap.insert(std::make_pair(N, DestSlot)).second)
921 // Recursively add any MDNodes referenced by operands.
922 for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i)
923 if (const MDNode *Op = dyn_cast_or_null<MDNode>(N->getOperand(i)))
924 CreateMetadataSlot(Op);
927 void SlotTracker::CreateAttributeSetSlot(AttributeSet AS) {
928 assert(AS.hasAttributes(AttributeSet::FunctionIndex) &&
929 "Doesn't need a slot!");
931 as_iterator I = asMap.find(AS);
932 if (I != asMap.end())
935 unsigned DestSlot = asNext++;
936 asMap[AS] = DestSlot;
939 //===----------------------------------------------------------------------===//
940 // AsmWriter Implementation
941 //===----------------------------------------------------------------------===//
943 static void WriteAsOperandInternal(raw_ostream &Out, const Value *V,
944 TypePrinting *TypePrinter,
945 SlotTracker *Machine,
946 const Module *Context);
948 static void WriteAsOperandInternal(raw_ostream &Out, const Metadata *MD,
949 TypePrinting *TypePrinter,
950 SlotTracker *Machine, const Module *Context,
951 bool FromValue = false);
953 static const char *getPredicateText(unsigned predicate) {
954 const char * pred = "unknown";
956 case FCmpInst::FCMP_FALSE: pred = "false"; break;
957 case FCmpInst::FCMP_OEQ: pred = "oeq"; break;
958 case FCmpInst::FCMP_OGT: pred = "ogt"; break;
959 case FCmpInst::FCMP_OGE: pred = "oge"; break;
960 case FCmpInst::FCMP_OLT: pred = "olt"; break;
961 case FCmpInst::FCMP_OLE: pred = "ole"; break;
962 case FCmpInst::FCMP_ONE: pred = "one"; break;
963 case FCmpInst::FCMP_ORD: pred = "ord"; break;
964 case FCmpInst::FCMP_UNO: pred = "uno"; break;
965 case FCmpInst::FCMP_UEQ: pred = "ueq"; break;
966 case FCmpInst::FCMP_UGT: pred = "ugt"; break;
967 case FCmpInst::FCMP_UGE: pred = "uge"; break;
968 case FCmpInst::FCMP_ULT: pred = "ult"; break;
969 case FCmpInst::FCMP_ULE: pred = "ule"; break;
970 case FCmpInst::FCMP_UNE: pred = "une"; break;
971 case FCmpInst::FCMP_TRUE: pred = "true"; break;
972 case ICmpInst::ICMP_EQ: pred = "eq"; break;
973 case ICmpInst::ICMP_NE: pred = "ne"; break;
974 case ICmpInst::ICMP_SGT: pred = "sgt"; break;
975 case ICmpInst::ICMP_SGE: pred = "sge"; break;
976 case ICmpInst::ICMP_SLT: pred = "slt"; break;
977 case ICmpInst::ICMP_SLE: pred = "sle"; break;
978 case ICmpInst::ICMP_UGT: pred = "ugt"; break;
979 case ICmpInst::ICMP_UGE: pred = "uge"; break;
980 case ICmpInst::ICMP_ULT: pred = "ult"; break;
981 case ICmpInst::ICMP_ULE: pred = "ule"; break;
986 static void writeAtomicRMWOperation(raw_ostream &Out,
987 AtomicRMWInst::BinOp Op) {
989 default: Out << " <unknown operation " << Op << ">"; break;
990 case AtomicRMWInst::Xchg: Out << " xchg"; break;
991 case AtomicRMWInst::Add: Out << " add"; break;
992 case AtomicRMWInst::Sub: Out << " sub"; break;
993 case AtomicRMWInst::And: Out << " and"; break;
994 case AtomicRMWInst::Nand: Out << " nand"; break;
995 case AtomicRMWInst::Or: Out << " or"; break;
996 case AtomicRMWInst::Xor: Out << " xor"; break;
997 case AtomicRMWInst::Max: Out << " max"; break;
998 case AtomicRMWInst::Min: Out << " min"; break;
999 case AtomicRMWInst::UMax: Out << " umax"; break;
1000 case AtomicRMWInst::UMin: Out << " umin"; break;
1004 static void WriteOptimizationInfo(raw_ostream &Out, const User *U) {
1005 if (const FPMathOperator *FPO = dyn_cast<const FPMathOperator>(U)) {
1006 // Unsafe algebra implies all the others, no need to write them all out
1007 if (FPO->hasUnsafeAlgebra())
1010 if (FPO->hasNoNaNs())
1012 if (FPO->hasNoInfs())
1014 if (FPO->hasNoSignedZeros())
1016 if (FPO->hasAllowReciprocal())
1021 if (const OverflowingBinaryOperator *OBO =
1022 dyn_cast<OverflowingBinaryOperator>(U)) {
1023 if (OBO->hasNoUnsignedWrap())
1025 if (OBO->hasNoSignedWrap())
1027 } else if (const PossiblyExactOperator *Div =
1028 dyn_cast<PossiblyExactOperator>(U)) {
1031 } else if (const GEPOperator *GEP = dyn_cast<GEPOperator>(U)) {
1032 if (GEP->isInBounds())
1037 static void WriteConstantInternal(raw_ostream &Out, const Constant *CV,
1038 TypePrinting &TypePrinter,
1039 SlotTracker *Machine,
1040 const Module *Context) {
1041 if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV)) {
1042 if (CI->getType()->isIntegerTy(1)) {
1043 Out << (CI->getZExtValue() ? "true" : "false");
1046 Out << CI->getValue();
1050 if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV)) {
1051 if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEsingle ||
1052 &CFP->getValueAPF().getSemantics() == &APFloat::IEEEdouble) {
1053 // We would like to output the FP constant value in exponential notation,
1054 // but we cannot do this if doing so will lose precision. Check here to
1055 // make sure that we only output it in exponential format if we can parse
1056 // the value back and get the same value.
1059 bool isHalf = &CFP->getValueAPF().getSemantics()==&APFloat::IEEEhalf;
1060 bool isDouble = &CFP->getValueAPF().getSemantics()==&APFloat::IEEEdouble;
1061 bool isInf = CFP->getValueAPF().isInfinity();
1062 bool isNaN = CFP->getValueAPF().isNaN();
1063 if (!isHalf && !isInf && !isNaN) {
1064 double Val = isDouble ? CFP->getValueAPF().convertToDouble() :
1065 CFP->getValueAPF().convertToFloat();
1066 SmallString<128> StrVal;
1067 raw_svector_ostream(StrVal) << Val;
1069 // Check to make sure that the stringized number is not some string like
1070 // "Inf" or NaN, that atof will accept, but the lexer will not. Check
1071 // that the string matches the "[-+]?[0-9]" regex.
1073 if ((StrVal[0] >= '0' && StrVal[0] <= '9') ||
1074 ((StrVal[0] == '-' || StrVal[0] == '+') &&
1075 (StrVal[1] >= '0' && StrVal[1] <= '9'))) {
1076 // Reparse stringized version!
1077 if (APFloat(APFloat::IEEEdouble, StrVal).convertToDouble() == Val) {
1083 // Otherwise we could not reparse it to exactly the same value, so we must
1084 // output the string in hexadecimal format! Note that loading and storing
1085 // floating point types changes the bits of NaNs on some hosts, notably
1086 // x86, so we must not use these types.
1087 static_assert(sizeof(double) == sizeof(uint64_t),
1088 "assuming that double is 64 bits!");
1090 APFloat apf = CFP->getValueAPF();
1091 // Halves and floats are represented in ASCII IR as double, convert.
1093 apf.convert(APFloat::IEEEdouble, APFloat::rmNearestTiesToEven,
1096 utohex_buffer(uint64_t(apf.bitcastToAPInt().getZExtValue()),
1101 // Either half, or some form of long double.
1102 // These appear as a magic letter identifying the type, then a
1103 // fixed number of hex digits.
1105 // Bit position, in the current word, of the next nibble to print.
1108 if (&CFP->getValueAPF().getSemantics() == &APFloat::x87DoubleExtended) {
1110 // api needed to prevent premature destruction
1111 APInt api = CFP->getValueAPF().bitcastToAPInt();
1112 const uint64_t* p = api.getRawData();
1113 uint64_t word = p[1];
1115 int width = api.getBitWidth();
1116 for (int j=0; j<width; j+=4, shiftcount-=4) {
1117 unsigned int nibble = (word>>shiftcount) & 15;
1119 Out << (unsigned char)(nibble + '0');
1121 Out << (unsigned char)(nibble - 10 + 'A');
1122 if (shiftcount == 0 && j+4 < width) {
1126 shiftcount = width-j-4;
1130 } else if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEquad) {
1133 } else if (&CFP->getValueAPF().getSemantics() == &APFloat::PPCDoubleDouble) {
1136 } else if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEhalf) {
1140 llvm_unreachable("Unsupported floating point type");
1141 // api needed to prevent premature destruction
1142 APInt api = CFP->getValueAPF().bitcastToAPInt();
1143 const uint64_t* p = api.getRawData();
1145 int width = api.getBitWidth();
1146 for (int j=0; j<width; j+=4, shiftcount-=4) {
1147 unsigned int nibble = (word>>shiftcount) & 15;
1149 Out << (unsigned char)(nibble + '0');
1151 Out << (unsigned char)(nibble - 10 + 'A');
1152 if (shiftcount == 0 && j+4 < width) {
1156 shiftcount = width-j-4;
1162 if (isa<ConstantAggregateZero>(CV)) {
1163 Out << "zeroinitializer";
1167 if (const BlockAddress *BA = dyn_cast<BlockAddress>(CV)) {
1168 Out << "blockaddress(";
1169 WriteAsOperandInternal(Out, BA->getFunction(), &TypePrinter, Machine,
1172 WriteAsOperandInternal(Out, BA->getBasicBlock(), &TypePrinter, Machine,
1178 if (const ConstantArray *CA = dyn_cast<ConstantArray>(CV)) {
1179 Type *ETy = CA->getType()->getElementType();
1181 TypePrinter.print(ETy, Out);
1183 WriteAsOperandInternal(Out, CA->getOperand(0),
1184 &TypePrinter, Machine,
1186 for (unsigned i = 1, e = CA->getNumOperands(); i != e; ++i) {
1188 TypePrinter.print(ETy, Out);
1190 WriteAsOperandInternal(Out, CA->getOperand(i), &TypePrinter, Machine,
1197 if (const ConstantDataArray *CA = dyn_cast<ConstantDataArray>(CV)) {
1198 // As a special case, print the array as a string if it is an array of
1199 // i8 with ConstantInt values.
1200 if (CA->isString()) {
1202 PrintEscapedString(CA->getAsString(), Out);
1207 Type *ETy = CA->getType()->getElementType();
1209 TypePrinter.print(ETy, Out);
1211 WriteAsOperandInternal(Out, CA->getElementAsConstant(0),
1212 &TypePrinter, Machine,
1214 for (unsigned i = 1, e = CA->getNumElements(); i != e; ++i) {
1216 TypePrinter.print(ETy, Out);
1218 WriteAsOperandInternal(Out, CA->getElementAsConstant(i), &TypePrinter,
1226 if (const ConstantStruct *CS = dyn_cast<ConstantStruct>(CV)) {
1227 if (CS->getType()->isPacked())
1230 unsigned N = CS->getNumOperands();
1233 TypePrinter.print(CS->getOperand(0)->getType(), Out);
1236 WriteAsOperandInternal(Out, CS->getOperand(0), &TypePrinter, Machine,
1239 for (unsigned i = 1; i < N; i++) {
1241 TypePrinter.print(CS->getOperand(i)->getType(), Out);
1244 WriteAsOperandInternal(Out, CS->getOperand(i), &TypePrinter, Machine,
1251 if (CS->getType()->isPacked())
1256 if (isa<ConstantVector>(CV) || isa<ConstantDataVector>(CV)) {
1257 Type *ETy = CV->getType()->getVectorElementType();
1259 TypePrinter.print(ETy, Out);
1261 WriteAsOperandInternal(Out, CV->getAggregateElement(0U), &TypePrinter,
1263 for (unsigned i = 1, e = CV->getType()->getVectorNumElements(); i != e;++i){
1265 TypePrinter.print(ETy, Out);
1267 WriteAsOperandInternal(Out, CV->getAggregateElement(i), &TypePrinter,
1274 if (isa<ConstantPointerNull>(CV)) {
1279 if (isa<UndefValue>(CV)) {
1284 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV)) {
1285 Out << CE->getOpcodeName();
1286 WriteOptimizationInfo(Out, CE);
1287 if (CE->isCompare())
1288 Out << ' ' << getPredicateText(CE->getPredicate());
1291 if (const GEPOperator *GEP = dyn_cast<GEPOperator>(CE)) {
1293 cast<PointerType>(GEP->getPointerOperandType()->getScalarType())
1299 for (User::const_op_iterator OI=CE->op_begin(); OI != CE->op_end(); ++OI) {
1300 TypePrinter.print((*OI)->getType(), Out);
1302 WriteAsOperandInternal(Out, *OI, &TypePrinter, Machine, Context);
1303 if (OI+1 != CE->op_end())
1307 if (CE->hasIndices()) {
1308 ArrayRef<unsigned> Indices = CE->getIndices();
1309 for (unsigned i = 0, e = Indices.size(); i != e; ++i)
1310 Out << ", " << Indices[i];
1315 TypePrinter.print(CE->getType(), Out);
1322 Out << "<placeholder or erroneous Constant>";
1325 static void writeMDTuple(raw_ostream &Out, const MDTuple *Node,
1326 TypePrinting *TypePrinter, SlotTracker *Machine,
1327 const Module *Context) {
1329 for (unsigned mi = 0, me = Node->getNumOperands(); mi != me; ++mi) {
1330 const Metadata *MD = Node->getOperand(mi);
1333 else if (auto *MDV = dyn_cast<ValueAsMetadata>(MD)) {
1334 Value *V = MDV->getValue();
1335 TypePrinter->print(V->getType(), Out);
1337 WriteAsOperandInternal(Out, V, TypePrinter, Machine, Context);
1339 WriteAsOperandInternal(Out, MD, TypePrinter, Machine, Context);
1349 struct FieldSeparator {
1352 FieldSeparator(const char *Sep = ", ") : Skip(true), Sep(Sep) {}
1354 raw_ostream &operator<<(raw_ostream &OS, FieldSeparator &FS) {
1359 return OS << FS.Sep;
1361 struct MDFieldPrinter {
1364 TypePrinting *TypePrinter;
1365 SlotTracker *Machine;
1366 const Module *Context;
1368 explicit MDFieldPrinter(raw_ostream &Out)
1369 : Out(Out), TypePrinter(nullptr), Machine(nullptr), Context(nullptr) {}
1370 MDFieldPrinter(raw_ostream &Out, TypePrinting *TypePrinter,
1371 SlotTracker *Machine, const Module *Context)
1372 : Out(Out), TypePrinter(TypePrinter), Machine(Machine), Context(Context) {
1374 void printTag(const DebugNode *N);
1375 void printString(StringRef Name, StringRef Value,
1376 bool ShouldSkipEmpty = true);
1377 void printMetadata(StringRef Name, const Metadata *MD,
1378 bool ShouldSkipNull = true);
1379 template <class IntTy>
1380 void printInt(StringRef Name, IntTy Int, bool ShouldSkipZero = true);
1381 void printBool(StringRef Name, bool Value);
1382 void printDIFlags(StringRef Name, unsigned Flags);
1383 template <class IntTy, class Stringifier>
1384 void printDwarfEnum(StringRef Name, IntTy Value, Stringifier toString,
1385 bool ShouldSkipZero = true);
1389 void MDFieldPrinter::printTag(const DebugNode *N) {
1390 Out << FS << "tag: ";
1391 if (const char *Tag = dwarf::TagString(N->getTag()))
1397 void MDFieldPrinter::printString(StringRef Name, StringRef Value,
1398 bool ShouldSkipEmpty) {
1399 if (ShouldSkipEmpty && Value.empty())
1402 Out << FS << Name << ": \"";
1403 PrintEscapedString(Value, Out);
1407 static void writeMetadataAsOperand(raw_ostream &Out, const Metadata *MD,
1408 TypePrinting *TypePrinter,
1409 SlotTracker *Machine,
1410 const Module *Context) {
1415 WriteAsOperandInternal(Out, MD, TypePrinter, Machine, Context);
1418 void MDFieldPrinter::printMetadata(StringRef Name, const Metadata *MD,
1419 bool ShouldSkipNull) {
1420 if (ShouldSkipNull && !MD)
1423 Out << FS << Name << ": ";
1424 writeMetadataAsOperand(Out, MD, TypePrinter, Machine, Context);
1427 template <class IntTy>
1428 void MDFieldPrinter::printInt(StringRef Name, IntTy Int, bool ShouldSkipZero) {
1429 if (ShouldSkipZero && !Int)
1432 Out << FS << Name << ": " << Int;
1435 void MDFieldPrinter::printBool(StringRef Name, bool Value) {
1436 Out << FS << Name << ": " << (Value ? "true" : "false");
1439 void MDFieldPrinter::printDIFlags(StringRef Name, unsigned Flags) {
1443 Out << FS << Name << ": ";
1445 SmallVector<unsigned, 8> SplitFlags;
1446 unsigned Extra = DIDescriptor::splitFlags(Flags, SplitFlags);
1448 FieldSeparator FlagsFS(" | ");
1449 for (unsigned F : SplitFlags) {
1450 const char *StringF = DIDescriptor::getFlagString(F);
1451 assert(StringF && "Expected valid flag");
1452 Out << FlagsFS << StringF;
1454 if (Extra || SplitFlags.empty())
1455 Out << FlagsFS << Extra;
1458 template <class IntTy, class Stringifier>
1459 void MDFieldPrinter::printDwarfEnum(StringRef Name, IntTy Value,
1460 Stringifier toString, bool ShouldSkipZero) {
1464 Out << FS << Name << ": ";
1465 if (const char *S = toString(Value))
1471 static void writeGenericDebugNode(raw_ostream &Out, const GenericDebugNode *N,
1472 TypePrinting *TypePrinter,
1473 SlotTracker *Machine, const Module *Context) {
1474 Out << "!GenericDebugNode(";
1475 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1476 Printer.printTag(N);
1477 Printer.printString("header", N->getHeader());
1478 if (N->getNumDwarfOperands()) {
1479 Out << Printer.FS << "operands: {";
1481 for (auto &I : N->dwarf_operands()) {
1483 writeMetadataAsOperand(Out, I, TypePrinter, Machine, Context);
1490 static void writeMDLocation(raw_ostream &Out, const MDLocation *DL,
1491 TypePrinting *TypePrinter, SlotTracker *Machine,
1492 const Module *Context) {
1493 Out << "!MDLocation(";
1494 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1495 // Always output the line, since 0 is a relevant and important value for it.
1496 Printer.printInt("line", DL->getLine(), /* ShouldSkipZero */ false);
1497 Printer.printInt("column", DL->getColumn());
1498 Printer.printMetadata("scope", DL->getRawScope(), /* ShouldSkipNull */ false);
1499 Printer.printMetadata("inlinedAt", DL->getRawInlinedAt());
1503 static void writeMDSubrange(raw_ostream &Out, const MDSubrange *N,
1504 TypePrinting *, SlotTracker *, const Module *) {
1505 Out << "!MDSubrange(";
1506 MDFieldPrinter Printer(Out);
1507 Printer.printInt("count", N->getCount(), /* ShouldSkipZero */ false);
1508 Printer.printInt("lowerBound", N->getLo());
1512 static void writeMDEnumerator(raw_ostream &Out, const MDEnumerator *N,
1513 TypePrinting *, SlotTracker *, const Module *) {
1514 Out << "!MDEnumerator(";
1515 MDFieldPrinter Printer(Out);
1516 Printer.printString("name", N->getName(), /* ShouldSkipEmpty */ false);
1517 Printer.printInt("value", N->getValue(), /* ShouldSkipZero */ false);
1521 static void writeMDBasicType(raw_ostream &Out, const MDBasicType *N,
1522 TypePrinting *, SlotTracker *, const Module *) {
1523 Out << "!MDBasicType(";
1524 MDFieldPrinter Printer(Out);
1525 if (N->getTag() != dwarf::DW_TAG_base_type)
1526 Printer.printTag(N);
1527 Printer.printString("name", N->getName());
1528 Printer.printInt("size", N->getSizeInBits());
1529 Printer.printInt("align", N->getAlignInBits());
1530 Printer.printDwarfEnum("encoding", N->getEncoding(),
1531 dwarf::AttributeEncodingString);
1535 static void writeMDDerivedType(raw_ostream &Out, const MDDerivedType *N,
1536 TypePrinting *TypePrinter, SlotTracker *Machine,
1537 const Module *Context) {
1538 Out << "!MDDerivedType(";
1539 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1540 Printer.printTag(N);
1541 Printer.printString("name", N->getName());
1542 Printer.printMetadata("scope", N->getScope());
1543 Printer.printMetadata("file", N->getFile());
1544 Printer.printInt("line", N->getLine());
1545 Printer.printMetadata("baseType", N->getBaseType(),
1546 /* ShouldSkipNull */ false);
1547 Printer.printInt("size", N->getSizeInBits());
1548 Printer.printInt("align", N->getAlignInBits());
1549 Printer.printInt("offset", N->getOffsetInBits());
1550 Printer.printDIFlags("flags", N->getFlags());
1551 Printer.printMetadata("extraData", N->getExtraData());
1555 static void writeMDCompositeType(raw_ostream &Out, const MDCompositeType *N,
1556 TypePrinting *TypePrinter,
1557 SlotTracker *Machine, const Module *Context) {
1558 Out << "!MDCompositeType(";
1559 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1560 Printer.printTag(N);
1561 Printer.printString("name", N->getName());
1562 Printer.printMetadata("scope", N->getScope());
1563 Printer.printMetadata("file", N->getFile());
1564 Printer.printInt("line", N->getLine());
1565 Printer.printMetadata("baseType", N->getBaseType());
1566 Printer.printInt("size", N->getSizeInBits());
1567 Printer.printInt("align", N->getAlignInBits());
1568 Printer.printInt("offset", N->getOffsetInBits());
1569 Printer.printDIFlags("flags", N->getFlags());
1570 Printer.printMetadata("elements", N->getElements());
1571 Printer.printDwarfEnum("runtimeLang", N->getRuntimeLang(),
1572 dwarf::LanguageString);
1573 Printer.printMetadata("vtableHolder", N->getVTableHolder());
1574 Printer.printMetadata("templateParams", N->getTemplateParams());
1575 Printer.printString("identifier", N->getIdentifier());
1579 static void writeMDSubroutineType(raw_ostream &Out, const MDSubroutineType *N,
1580 TypePrinting *TypePrinter,
1581 SlotTracker *Machine, const Module *Context) {
1582 Out << "!MDSubroutineType(";
1583 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1584 Printer.printDIFlags("flags", N->getFlags());
1585 Printer.printMetadata("types", N->getTypeArray(), /* ShouldSkipNull */ false);
1589 static void writeMDFile(raw_ostream &Out, const MDFile *N, TypePrinting *,
1590 SlotTracker *, const Module *) {
1592 MDFieldPrinter Printer(Out);
1593 Printer.printString("filename", N->getFilename(),
1594 /* ShouldSkipEmpty */ false);
1595 Printer.printString("directory", N->getDirectory(),
1596 /* ShouldSkipEmpty */ false);
1600 static void writeMDCompileUnit(raw_ostream &Out, const MDCompileUnit *N,
1601 TypePrinting *TypePrinter, SlotTracker *Machine,
1602 const Module *Context) {
1603 Out << "!MDCompileUnit(";
1604 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1605 Printer.printDwarfEnum("language", N->getSourceLanguage(),
1606 dwarf::LanguageString, /* ShouldSkipZero */ false);
1607 Printer.printMetadata("file", N->getFile(), /* ShouldSkipNull */ false);
1608 Printer.printString("producer", N->getProducer());
1609 Printer.printBool("isOptimized", N->isOptimized());
1610 Printer.printString("flags", N->getFlags());
1611 Printer.printInt("runtimeVersion", N->getRuntimeVersion(),
1612 /* ShouldSkipZero */ false);
1613 Printer.printString("splitDebugFilename", N->getSplitDebugFilename());
1614 Printer.printInt("emissionKind", N->getEmissionKind(),
1615 /* ShouldSkipZero */ false);
1616 Printer.printMetadata("enums", N->getEnumTypes());
1617 Printer.printMetadata("retainedTypes", N->getRetainedTypes());
1618 Printer.printMetadata("subprograms", N->getSubprograms());
1619 Printer.printMetadata("globals", N->getGlobalVariables());
1620 Printer.printMetadata("imports", N->getImportedEntities());
1624 static void writeMDSubprogram(raw_ostream &Out, const MDSubprogram *N,
1625 TypePrinting *TypePrinter, SlotTracker *Machine,
1626 const Module *Context) {
1627 Out << "!MDSubprogram(";
1628 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1629 Printer.printString("name", N->getName());
1630 Printer.printString("linkageName", N->getLinkageName());
1631 Printer.printMetadata("scope", N->getScope(), /* ShouldSkipNull */ false);
1632 Printer.printMetadata("file", N->getFile());
1633 Printer.printInt("line", N->getLine());
1634 Printer.printMetadata("type", N->getType());
1635 Printer.printBool("isLocal", N->isLocalToUnit());
1636 Printer.printBool("isDefinition", N->isDefinition());
1637 Printer.printInt("scopeLine", N->getScopeLine());
1638 Printer.printMetadata("containingType", N->getContainingType());
1639 Printer.printDwarfEnum("virtuality", N->getVirtuality(),
1640 dwarf::VirtualityString);
1641 Printer.printInt("virtualIndex", N->getVirtualIndex());
1642 Printer.printDIFlags("flags", N->getFlags());
1643 Printer.printBool("isOptimized", N->isOptimized());
1644 Printer.printMetadata("function", N->getFunction());
1645 Printer.printMetadata("templateParams", N->getTemplateParams());
1646 Printer.printMetadata("declaration", N->getDeclaration());
1647 Printer.printMetadata("variables", N->getVariables());
1651 static void writeMDLexicalBlock(raw_ostream &Out, const MDLexicalBlock *N,
1652 TypePrinting *TypePrinter, SlotTracker *Machine,
1653 const Module *Context) {
1654 Out << "!MDLexicalBlock(";
1655 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1656 Printer.printMetadata("scope", N->getScope(), /* ShouldSkipNull */ false);
1657 Printer.printMetadata("file", N->getFile());
1658 Printer.printInt("line", N->getLine());
1659 Printer.printInt("column", N->getColumn());
1663 static void writeMDLexicalBlockFile(raw_ostream &Out,
1664 const MDLexicalBlockFile *N,
1665 TypePrinting *TypePrinter,
1666 SlotTracker *Machine,
1667 const Module *Context) {
1668 Out << "!MDLexicalBlockFile(";
1669 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1670 Printer.printMetadata("scope", N->getScope(), /* ShouldSkipNull */ false);
1671 Printer.printMetadata("file", N->getFile());
1672 Printer.printInt("discriminator", N->getDiscriminator(),
1673 /* ShouldSkipZero */ false);
1677 static void writeMDNamespace(raw_ostream &Out, const MDNamespace *N,
1678 TypePrinting *TypePrinter, SlotTracker *Machine,
1679 const Module *Context) {
1680 Out << "!MDNamespace(";
1681 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1682 Printer.printString("name", N->getName());
1683 Printer.printMetadata("scope", N->getScope(), /* ShouldSkipNull */ false);
1684 Printer.printMetadata("file", N->getFile());
1685 Printer.printInt("line", N->getLine());
1689 static void writeMDTemplateTypeParameter(raw_ostream &Out,
1690 const MDTemplateTypeParameter *N,
1691 TypePrinting *TypePrinter,
1692 SlotTracker *Machine,
1693 const Module *Context) {
1694 Out << "!MDTemplateTypeParameter(";
1695 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1696 Printer.printString("name", N->getName());
1697 Printer.printMetadata("type", N->getType(), /* ShouldSkipNull */ false);
1701 static void writeMDTemplateValueParameter(raw_ostream &Out,
1702 const MDTemplateValueParameter *N,
1703 TypePrinting *TypePrinter,
1704 SlotTracker *Machine,
1705 const Module *Context) {
1706 Out << "!MDTemplateValueParameter(";
1707 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1708 if (N->getTag() != dwarf::DW_TAG_template_value_parameter)
1709 Printer.printTag(N);
1710 Printer.printString("name", N->getName());
1711 Printer.printMetadata("type", N->getType());
1712 Printer.printMetadata("value", N->getValue(), /* ShouldSkipNull */ false);
1716 static void writeMDGlobalVariable(raw_ostream &Out, const MDGlobalVariable *N,
1717 TypePrinting *TypePrinter,
1718 SlotTracker *Machine, const Module *Context) {
1719 Out << "!MDGlobalVariable(";
1720 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1721 Printer.printString("name", N->getName());
1722 Printer.printString("linkageName", N->getLinkageName());
1723 Printer.printMetadata("scope", N->getScope(), /* ShouldSkipNull */ false);
1724 Printer.printMetadata("file", N->getFile());
1725 Printer.printInt("line", N->getLine());
1726 Printer.printMetadata("type", N->getType());
1727 Printer.printBool("isLocal", N->isLocalToUnit());
1728 Printer.printBool("isDefinition", N->isDefinition());
1729 Printer.printMetadata("variable", N->getVariable());
1730 Printer.printMetadata("declaration", N->getStaticDataMemberDeclaration());
1734 static void writeMDLocalVariable(raw_ostream &Out, const MDLocalVariable *N,
1735 TypePrinting *TypePrinter,
1736 SlotTracker *Machine, const Module *Context) {
1737 Out << "!MDLocalVariable(";
1738 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1739 Printer.printTag(N);
1740 Printer.printString("name", N->getName());
1741 Printer.printInt("arg", N->getArg(),
1742 /* ShouldSkipZero */
1743 N->getTag() == dwarf::DW_TAG_auto_variable);
1744 Printer.printMetadata("scope", N->getScope(), /* ShouldSkipNull */ false);
1745 Printer.printMetadata("file", N->getFile());
1746 Printer.printInt("line", N->getLine());
1747 Printer.printMetadata("type", N->getType());
1748 Printer.printDIFlags("flags", N->getFlags());
1749 Printer.printMetadata("inlinedAt", N->getInlinedAt());
1753 static void writeMDExpression(raw_ostream &Out, const MDExpression *N,
1754 TypePrinting *TypePrinter, SlotTracker *Machine,
1755 const Module *Context) {
1756 Out << "!MDExpression(";
1759 for (auto I = N->expr_op_begin(), E = N->expr_op_end(); I != E; ++I) {
1760 const char *OpStr = dwarf::OperationEncodingString(I->getOp());
1761 assert(OpStr && "Expected valid opcode");
1764 for (unsigned A = 0, AE = I->getNumArgs(); A != AE; ++A)
1765 Out << FS << I->getArg(A);
1768 for (const auto &I : N->getElements())
1774 static void writeMDObjCProperty(raw_ostream &Out, const MDObjCProperty *N,
1775 TypePrinting *TypePrinter, SlotTracker *Machine,
1776 const Module *Context) {
1777 Out << "!MDObjCProperty(";
1778 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1779 Printer.printString("name", N->getName());
1780 Printer.printMetadata("file", N->getFile());
1781 Printer.printInt("line", N->getLine());
1782 Printer.printString("setter", N->getSetterName());
1783 Printer.printString("getter", N->getGetterName());
1784 Printer.printInt("attributes", N->getAttributes());
1785 Printer.printMetadata("type", N->getType());
1789 static void writeMDImportedEntity(raw_ostream &Out, const MDImportedEntity *N,
1790 TypePrinting *TypePrinter,
1791 SlotTracker *Machine, const Module *Context) {
1792 Out << "!MDImportedEntity(";
1793 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1794 Printer.printTag(N);
1795 Printer.printString("name", N->getName());
1796 Printer.printMetadata("scope", N->getScope(), /* ShouldSkipNull */ false);
1797 Printer.printMetadata("entity", N->getEntity());
1798 Printer.printInt("line", N->getLine());
1803 static void WriteMDNodeBodyInternal(raw_ostream &Out, const MDNode *Node,
1804 TypePrinting *TypePrinter,
1805 SlotTracker *Machine,
1806 const Module *Context) {
1807 if (Node->isDistinct())
1809 else if (Node->isTemporary())
1810 Out << "<temporary!> "; // Handle broken code.
1812 switch (Node->getMetadataID()) {
1814 llvm_unreachable("Expected uniquable MDNode");
1815 #define HANDLE_MDNODE_LEAF(CLASS) \
1816 case Metadata::CLASS##Kind: \
1817 write##CLASS(Out, cast<CLASS>(Node), TypePrinter, Machine, Context); \
1819 #include "llvm/IR/Metadata.def"
1823 // Full implementation of printing a Value as an operand with support for
1824 // TypePrinting, etc.
1825 static void WriteAsOperandInternal(raw_ostream &Out, const Value *V,
1826 TypePrinting *TypePrinter,
1827 SlotTracker *Machine,
1828 const Module *Context) {
1830 PrintLLVMName(Out, V);
1834 const Constant *CV = dyn_cast<Constant>(V);
1835 if (CV && !isa<GlobalValue>(CV)) {
1836 assert(TypePrinter && "Constants require TypePrinting!");
1837 WriteConstantInternal(Out, CV, *TypePrinter, Machine, Context);
1841 if (const InlineAsm *IA = dyn_cast<InlineAsm>(V)) {
1843 if (IA->hasSideEffects())
1844 Out << "sideeffect ";
1845 if (IA->isAlignStack())
1846 Out << "alignstack ";
1847 // We don't emit the AD_ATT dialect as it's the assumed default.
1848 if (IA->getDialect() == InlineAsm::AD_Intel)
1849 Out << "inteldialect ";
1851 PrintEscapedString(IA->getAsmString(), Out);
1853 PrintEscapedString(IA->getConstraintString(), Out);
1858 if (auto *MD = dyn_cast<MetadataAsValue>(V)) {
1859 WriteAsOperandInternal(Out, MD->getMetadata(), TypePrinter, Machine,
1860 Context, /* FromValue */ true);
1866 // If we have a SlotTracker, use it.
1868 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
1869 Slot = Machine->getGlobalSlot(GV);
1872 Slot = Machine->getLocalSlot(V);
1874 // If the local value didn't succeed, then we may be referring to a value
1875 // from a different function. Translate it, as this can happen when using
1876 // address of blocks.
1878 if ((Machine = createSlotTracker(V))) {
1879 Slot = Machine->getLocalSlot(V);
1883 } else if ((Machine = createSlotTracker(V))) {
1884 // Otherwise, create one to get the # and then destroy it.
1885 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
1886 Slot = Machine->getGlobalSlot(GV);
1889 Slot = Machine->getLocalSlot(V);
1898 Out << Prefix << Slot;
1903 static void WriteAsOperandInternal(raw_ostream &Out, const Metadata *MD,
1904 TypePrinting *TypePrinter,
1905 SlotTracker *Machine, const Module *Context,
1907 if (const MDNode *N = dyn_cast<MDNode>(MD)) {
1909 Machine = new SlotTracker(Context);
1910 int Slot = Machine->getMetadataSlot(N);
1912 // Give the pointer value instead of "badref", since this comes up all
1913 // the time when debugging.
1914 Out << "<" << N << ">";
1920 if (const MDString *MDS = dyn_cast<MDString>(MD)) {
1922 PrintEscapedString(MDS->getString(), Out);
1927 auto *V = cast<ValueAsMetadata>(MD);
1928 assert(TypePrinter && "TypePrinter required for metadata values");
1929 assert((FromValue || !isa<LocalAsMetadata>(V)) &&
1930 "Unexpected function-local metadata outside of value argument");
1932 TypePrinter->print(V->getValue()->getType(), Out);
1934 WriteAsOperandInternal(Out, V->getValue(), TypePrinter, Machine, Context);
1938 class AssemblyWriter {
1939 formatted_raw_ostream &Out;
1940 const Module *TheModule;
1941 std::unique_ptr<SlotTracker> ModuleSlotTracker;
1942 SlotTracker &Machine;
1943 TypePrinting TypePrinter;
1944 AssemblyAnnotationWriter *AnnotationWriter;
1945 SetVector<const Comdat *> Comdats;
1946 UseListOrderStack UseListOrders;
1949 /// Construct an AssemblyWriter with an external SlotTracker
1950 AssemblyWriter(formatted_raw_ostream &o, SlotTracker &Mac,
1951 const Module *M, AssemblyAnnotationWriter *AAW);
1953 /// Construct an AssemblyWriter with an internally allocated SlotTracker
1954 AssemblyWriter(formatted_raw_ostream &o, const Module *M,
1955 AssemblyAnnotationWriter *AAW);
1957 void printMDNodeBody(const MDNode *MD);
1958 void printNamedMDNode(const NamedMDNode *NMD);
1960 void printModule(const Module *M);
1962 void writeOperand(const Value *Op, bool PrintType);
1963 void writeParamOperand(const Value *Operand, AttributeSet Attrs,unsigned Idx);
1964 void writeAtomic(AtomicOrdering Ordering, SynchronizationScope SynchScope);
1965 void writeAtomicCmpXchg(AtomicOrdering SuccessOrdering,
1966 AtomicOrdering FailureOrdering,
1967 SynchronizationScope SynchScope);
1969 void writeAllMDNodes();
1970 void writeMDNode(unsigned Slot, const MDNode *Node);
1971 void writeAllAttributeGroups();
1973 void printTypeIdentities();
1974 void printGlobal(const GlobalVariable *GV);
1975 void printAlias(const GlobalAlias *GV);
1976 void printComdat(const Comdat *C);
1977 void printFunction(const Function *F);
1978 void printArgument(const Argument *FA, AttributeSet Attrs, unsigned Idx);
1979 void printBasicBlock(const BasicBlock *BB);
1980 void printInstructionLine(const Instruction &I);
1981 void printInstruction(const Instruction &I);
1983 void printUseListOrder(const UseListOrder &Order);
1984 void printUseLists(const Function *F);
1989 // printInfoComment - Print a little comment after the instruction indicating
1990 // which slot it occupies.
1991 void printInfoComment(const Value &V);
1995 void AssemblyWriter::init() {
1998 TypePrinter.incorporateTypes(*TheModule);
1999 for (const Function &F : *TheModule)
2000 if (const Comdat *C = F.getComdat())
2002 for (const GlobalVariable &GV : TheModule->globals())
2003 if (const Comdat *C = GV.getComdat())
2008 AssemblyWriter::AssemblyWriter(formatted_raw_ostream &o, SlotTracker &Mac,
2010 AssemblyAnnotationWriter *AAW)
2011 : Out(o), TheModule(M), Machine(Mac), AnnotationWriter(AAW) {
2015 AssemblyWriter::AssemblyWriter(formatted_raw_ostream &o, const Module *M,
2016 AssemblyAnnotationWriter *AAW)
2017 : Out(o), TheModule(M), ModuleSlotTracker(createSlotTracker(M)),
2018 Machine(*ModuleSlotTracker), AnnotationWriter(AAW) {
2022 void AssemblyWriter::writeOperand(const Value *Operand, bool PrintType) {
2024 Out << "<null operand!>";
2028 TypePrinter.print(Operand->getType(), Out);
2031 WriteAsOperandInternal(Out, Operand, &TypePrinter, &Machine, TheModule);
2034 void AssemblyWriter::writeAtomic(AtomicOrdering Ordering,
2035 SynchronizationScope SynchScope) {
2036 if (Ordering == NotAtomic)
2039 switch (SynchScope) {
2040 case SingleThread: Out << " singlethread"; break;
2041 case CrossThread: break;
2045 default: Out << " <bad ordering " << int(Ordering) << ">"; break;
2046 case Unordered: Out << " unordered"; break;
2047 case Monotonic: Out << " monotonic"; break;
2048 case Acquire: Out << " acquire"; break;
2049 case Release: Out << " release"; break;
2050 case AcquireRelease: Out << " acq_rel"; break;
2051 case SequentiallyConsistent: Out << " seq_cst"; break;
2055 void AssemblyWriter::writeAtomicCmpXchg(AtomicOrdering SuccessOrdering,
2056 AtomicOrdering FailureOrdering,
2057 SynchronizationScope SynchScope) {
2058 assert(SuccessOrdering != NotAtomic && FailureOrdering != NotAtomic);
2060 switch (SynchScope) {
2061 case SingleThread: Out << " singlethread"; break;
2062 case CrossThread: break;
2065 switch (SuccessOrdering) {
2066 default: Out << " <bad ordering " << int(SuccessOrdering) << ">"; 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;
2075 switch (FailureOrdering) {
2076 default: Out << " <bad ordering " << int(FailureOrdering) << ">"; break;
2077 case Unordered: Out << " unordered"; break;
2078 case Monotonic: Out << " monotonic"; break;
2079 case Acquire: Out << " acquire"; break;
2080 case Release: Out << " release"; break;
2081 case AcquireRelease: Out << " acq_rel"; break;
2082 case SequentiallyConsistent: Out << " seq_cst"; break;
2086 void AssemblyWriter::writeParamOperand(const Value *Operand,
2087 AttributeSet Attrs, unsigned Idx) {
2089 Out << "<null operand!>";
2094 TypePrinter.print(Operand->getType(), Out);
2095 // Print parameter attributes list
2096 if (Attrs.hasAttributes(Idx))
2097 Out << ' ' << Attrs.getAsString(Idx);
2099 // Print the operand
2100 WriteAsOperandInternal(Out, Operand, &TypePrinter, &Machine, TheModule);
2103 void AssemblyWriter::printModule(const Module *M) {
2104 Machine.initialize();
2106 if (shouldPreserveAssemblyUseListOrder())
2107 UseListOrders = predictUseListOrder(M);
2109 if (!M->getModuleIdentifier().empty() &&
2110 // Don't print the ID if it will start a new line (which would
2111 // require a comment char before it).
2112 M->getModuleIdentifier().find('\n') == std::string::npos)
2113 Out << "; ModuleID = '" << M->getModuleIdentifier() << "'\n";
2115 const std::string &DL = M->getDataLayoutStr();
2117 Out << "target datalayout = \"" << DL << "\"\n";
2118 if (!M->getTargetTriple().empty())
2119 Out << "target triple = \"" << M->getTargetTriple() << "\"\n";
2121 if (!M->getModuleInlineAsm().empty()) {
2122 // Split the string into lines, to make it easier to read the .ll file.
2123 std::string Asm = M->getModuleInlineAsm();
2125 size_t NewLine = Asm.find_first_of('\n', CurPos);
2127 while (NewLine != std::string::npos) {
2128 // We found a newline, print the portion of the asm string from the
2129 // last newline up to this newline.
2130 Out << "module asm \"";
2131 PrintEscapedString(std::string(Asm.begin()+CurPos, Asm.begin()+NewLine),
2135 NewLine = Asm.find_first_of('\n', CurPos);
2137 std::string rest(Asm.begin()+CurPos, Asm.end());
2138 if (!rest.empty()) {
2139 Out << "module asm \"";
2140 PrintEscapedString(rest, Out);
2145 printTypeIdentities();
2147 // Output all comdats.
2148 if (!Comdats.empty())
2150 for (const Comdat *C : Comdats) {
2152 if (C != Comdats.back())
2156 // Output all globals.
2157 if (!M->global_empty()) Out << '\n';
2158 for (Module::const_global_iterator I = M->global_begin(), E = M->global_end();
2160 printGlobal(I); Out << '\n';
2163 // Output all aliases.
2164 if (!M->alias_empty()) Out << "\n";
2165 for (Module::const_alias_iterator I = M->alias_begin(), E = M->alias_end();
2169 // Output global use-lists.
2170 printUseLists(nullptr);
2172 // Output all of the functions.
2173 for (Module::const_iterator I = M->begin(), E = M->end(); I != E; ++I)
2175 assert(UseListOrders.empty() && "All use-lists should have been consumed");
2177 // Output all attribute groups.
2178 if (!Machine.as_empty()) {
2180 writeAllAttributeGroups();
2183 // Output named metadata.
2184 if (!M->named_metadata_empty()) Out << '\n';
2186 for (Module::const_named_metadata_iterator I = M->named_metadata_begin(),
2187 E = M->named_metadata_end(); I != E; ++I)
2188 printNamedMDNode(I);
2191 if (!Machine.mdn_empty()) {
2197 void AssemblyWriter::printNamedMDNode(const NamedMDNode *NMD) {
2199 StringRef Name = NMD->getName();
2201 Out << "<empty name> ";
2203 if (isalpha(static_cast<unsigned char>(Name[0])) ||
2204 Name[0] == '-' || Name[0] == '$' ||
2205 Name[0] == '.' || Name[0] == '_')
2208 Out << '\\' << hexdigit(Name[0] >> 4) << hexdigit(Name[0] & 0x0F);
2209 for (unsigned i = 1, e = Name.size(); i != e; ++i) {
2210 unsigned char C = Name[i];
2211 if (isalnum(static_cast<unsigned char>(C)) || C == '-' || C == '$' ||
2212 C == '.' || C == '_')
2215 Out << '\\' << hexdigit(C >> 4) << hexdigit(C & 0x0F);
2219 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
2221 int Slot = Machine.getMetadataSlot(NMD->getOperand(i));
2231 static void PrintLinkage(GlobalValue::LinkageTypes LT,
2232 formatted_raw_ostream &Out) {
2234 case GlobalValue::ExternalLinkage: break;
2235 case GlobalValue::PrivateLinkage: Out << "private "; break;
2236 case GlobalValue::InternalLinkage: Out << "internal "; break;
2237 case GlobalValue::LinkOnceAnyLinkage: Out << "linkonce "; break;
2238 case GlobalValue::LinkOnceODRLinkage: Out << "linkonce_odr "; break;
2239 case GlobalValue::WeakAnyLinkage: Out << "weak "; break;
2240 case GlobalValue::WeakODRLinkage: Out << "weak_odr "; break;
2241 case GlobalValue::CommonLinkage: Out << "common "; break;
2242 case GlobalValue::AppendingLinkage: Out << "appending "; break;
2243 case GlobalValue::ExternalWeakLinkage: Out << "extern_weak "; break;
2244 case GlobalValue::AvailableExternallyLinkage:
2245 Out << "available_externally ";
2251 static void PrintVisibility(GlobalValue::VisibilityTypes Vis,
2252 formatted_raw_ostream &Out) {
2254 case GlobalValue::DefaultVisibility: break;
2255 case GlobalValue::HiddenVisibility: Out << "hidden "; break;
2256 case GlobalValue::ProtectedVisibility: Out << "protected "; break;
2260 static void PrintDLLStorageClass(GlobalValue::DLLStorageClassTypes SCT,
2261 formatted_raw_ostream &Out) {
2263 case GlobalValue::DefaultStorageClass: break;
2264 case GlobalValue::DLLImportStorageClass: Out << "dllimport "; break;
2265 case GlobalValue::DLLExportStorageClass: Out << "dllexport "; break;
2269 static void PrintThreadLocalModel(GlobalVariable::ThreadLocalMode TLM,
2270 formatted_raw_ostream &Out) {
2272 case GlobalVariable::NotThreadLocal:
2274 case GlobalVariable::GeneralDynamicTLSModel:
2275 Out << "thread_local ";
2277 case GlobalVariable::LocalDynamicTLSModel:
2278 Out << "thread_local(localdynamic) ";
2280 case GlobalVariable::InitialExecTLSModel:
2281 Out << "thread_local(initialexec) ";
2283 case GlobalVariable::LocalExecTLSModel:
2284 Out << "thread_local(localexec) ";
2289 static void maybePrintComdat(formatted_raw_ostream &Out,
2290 const GlobalObject &GO) {
2291 const Comdat *C = GO.getComdat();
2295 if (isa<GlobalVariable>(GO))
2299 if (GO.getName() == C->getName())
2303 PrintLLVMName(Out, C->getName(), ComdatPrefix);
2307 void AssemblyWriter::printGlobal(const GlobalVariable *GV) {
2308 if (GV->isMaterializable())
2309 Out << "; Materializable\n";
2311 WriteAsOperandInternal(Out, GV, &TypePrinter, &Machine, GV->getParent());
2314 if (!GV->hasInitializer() && GV->hasExternalLinkage())
2317 PrintLinkage(GV->getLinkage(), Out);
2318 PrintVisibility(GV->getVisibility(), Out);
2319 PrintDLLStorageClass(GV->getDLLStorageClass(), Out);
2320 PrintThreadLocalModel(GV->getThreadLocalMode(), Out);
2321 if (GV->hasUnnamedAddr())
2322 Out << "unnamed_addr ";
2324 if (unsigned AddressSpace = GV->getType()->getAddressSpace())
2325 Out << "addrspace(" << AddressSpace << ") ";
2326 if (GV->isExternallyInitialized()) Out << "externally_initialized ";
2327 Out << (GV->isConstant() ? "constant " : "global ");
2328 TypePrinter.print(GV->getType()->getElementType(), Out);
2330 if (GV->hasInitializer()) {
2332 writeOperand(GV->getInitializer(), false);
2335 if (GV->hasSection()) {
2336 Out << ", section \"";
2337 PrintEscapedString(GV->getSection(), Out);
2340 maybePrintComdat(Out, *GV);
2341 if (GV->getAlignment())
2342 Out << ", align " << GV->getAlignment();
2344 printInfoComment(*GV);
2347 void AssemblyWriter::printAlias(const GlobalAlias *GA) {
2348 if (GA->isMaterializable())
2349 Out << "; Materializable\n";
2351 // Don't crash when dumping partially built GA
2353 Out << "<<nameless>> = ";
2355 PrintLLVMName(Out, GA);
2358 PrintLinkage(GA->getLinkage(), Out);
2359 PrintVisibility(GA->getVisibility(), Out);
2360 PrintDLLStorageClass(GA->getDLLStorageClass(), Out);
2361 PrintThreadLocalModel(GA->getThreadLocalMode(), Out);
2362 if (GA->hasUnnamedAddr())
2363 Out << "unnamed_addr ";
2367 const Constant *Aliasee = GA->getAliasee();
2370 TypePrinter.print(GA->getType(), Out);
2371 Out << " <<NULL ALIASEE>>";
2373 writeOperand(Aliasee, !isa<ConstantExpr>(Aliasee));
2376 printInfoComment(*GA);
2380 void AssemblyWriter::printComdat(const Comdat *C) {
2384 void AssemblyWriter::printTypeIdentities() {
2385 if (TypePrinter.NumberedTypes.empty() &&
2386 TypePrinter.NamedTypes.empty())
2391 // We know all the numbers that each type is used and we know that it is a
2392 // dense assignment. Convert the map to an index table.
2393 std::vector<StructType*> NumberedTypes(TypePrinter.NumberedTypes.size());
2394 for (DenseMap<StructType*, unsigned>::iterator I =
2395 TypePrinter.NumberedTypes.begin(), E = TypePrinter.NumberedTypes.end();
2397 assert(I->second < NumberedTypes.size() && "Didn't get a dense numbering?");
2398 NumberedTypes[I->second] = I->first;
2401 // Emit all numbered types.
2402 for (unsigned i = 0, e = NumberedTypes.size(); i != e; ++i) {
2403 Out << '%' << i << " = type ";
2405 // Make sure we print out at least one level of the type structure, so
2406 // that we do not get %2 = type %2
2407 TypePrinter.printStructBody(NumberedTypes[i], Out);
2411 for (unsigned i = 0, e = TypePrinter.NamedTypes.size(); i != e; ++i) {
2412 PrintLLVMName(Out, TypePrinter.NamedTypes[i]->getName(), LocalPrefix);
2415 // Make sure we print out at least one level of the type structure, so
2416 // that we do not get %FILE = type %FILE
2417 TypePrinter.printStructBody(TypePrinter.NamedTypes[i], Out);
2422 /// printFunction - Print all aspects of a function.
2424 void AssemblyWriter::printFunction(const Function *F) {
2425 // Print out the return type and name.
2428 if (AnnotationWriter) AnnotationWriter->emitFunctionAnnot(F, Out);
2430 if (F->isMaterializable())
2431 Out << "; Materializable\n";
2433 const AttributeSet &Attrs = F->getAttributes();
2434 if (Attrs.hasAttributes(AttributeSet::FunctionIndex)) {
2435 AttributeSet AS = Attrs.getFnAttributes();
2436 std::string AttrStr;
2439 for (unsigned E = AS.getNumSlots(); Idx != E; ++Idx)
2440 if (AS.getSlotIndex(Idx) == AttributeSet::FunctionIndex)
2443 for (AttributeSet::iterator I = AS.begin(Idx), E = AS.end(Idx);
2445 Attribute Attr = *I;
2446 if (!Attr.isStringAttribute()) {
2447 if (!AttrStr.empty()) AttrStr += ' ';
2448 AttrStr += Attr.getAsString();
2452 if (!AttrStr.empty())
2453 Out << "; Function Attrs: " << AttrStr << '\n';
2456 if (F->isDeclaration())
2461 PrintLinkage(F->getLinkage(), Out);
2462 PrintVisibility(F->getVisibility(), Out);
2463 PrintDLLStorageClass(F->getDLLStorageClass(), Out);
2465 // Print the calling convention.
2466 if (F->getCallingConv() != CallingConv::C) {
2467 PrintCallingConv(F->getCallingConv(), Out);
2471 FunctionType *FT = F->getFunctionType();
2472 if (Attrs.hasAttributes(AttributeSet::ReturnIndex))
2473 Out << Attrs.getAsString(AttributeSet::ReturnIndex) << ' ';
2474 TypePrinter.print(F->getReturnType(), Out);
2476 WriteAsOperandInternal(Out, F, &TypePrinter, &Machine, F->getParent());
2478 Machine.incorporateFunction(F);
2480 // Loop over the arguments, printing them...
2483 if (!F->isDeclaration()) {
2484 // If this isn't a declaration, print the argument names as well.
2485 for (Function::const_arg_iterator I = F->arg_begin(), E = F->arg_end();
2487 // Insert commas as we go... the first arg doesn't get a comma
2488 if (I != F->arg_begin()) Out << ", ";
2489 printArgument(I, Attrs, Idx);
2493 // Otherwise, print the types from the function type.
2494 for (unsigned i = 0, e = FT->getNumParams(); i != e; ++i) {
2495 // Insert commas as we go... the first arg doesn't get a comma
2499 TypePrinter.print(FT->getParamType(i), Out);
2501 if (Attrs.hasAttributes(i+1))
2502 Out << ' ' << Attrs.getAsString(i+1);
2506 // Finish printing arguments...
2507 if (FT->isVarArg()) {
2508 if (FT->getNumParams()) Out << ", ";
2509 Out << "..."; // Output varargs portion of signature!
2512 if (F->hasUnnamedAddr())
2513 Out << " unnamed_addr";
2514 if (Attrs.hasAttributes(AttributeSet::FunctionIndex))
2515 Out << " #" << Machine.getAttributeGroupSlot(Attrs.getFnAttributes());
2516 if (F->hasSection()) {
2517 Out << " section \"";
2518 PrintEscapedString(F->getSection(), Out);
2521 maybePrintComdat(Out, *F);
2522 if (F->getAlignment())
2523 Out << " align " << F->getAlignment();
2525 Out << " gc \"" << F->getGC() << '"';
2526 if (F->hasPrefixData()) {
2528 writeOperand(F->getPrefixData(), true);
2530 if (F->hasPrologueData()) {
2531 Out << " prologue ";
2532 writeOperand(F->getPrologueData(), true);
2535 if (F->isDeclaration()) {
2539 // Output all of the function's basic blocks.
2540 for (Function::const_iterator I = F->begin(), E = F->end(); I != E; ++I)
2543 // Output the function's use-lists.
2549 Machine.purgeFunction();
2552 /// printArgument - This member is called for every argument that is passed into
2553 /// the function. Simply print it out
2555 void AssemblyWriter::printArgument(const Argument *Arg,
2556 AttributeSet Attrs, unsigned Idx) {
2558 TypePrinter.print(Arg->getType(), Out);
2560 // Output parameter attributes list
2561 if (Attrs.hasAttributes(Idx))
2562 Out << ' ' << Attrs.getAsString(Idx);
2564 // Output name, if available...
2565 if (Arg->hasName()) {
2567 PrintLLVMName(Out, Arg);
2571 /// printBasicBlock - This member is called for each basic block in a method.
2573 void AssemblyWriter::printBasicBlock(const BasicBlock *BB) {
2574 if (BB->hasName()) { // Print out the label if it exists...
2576 PrintLLVMName(Out, BB->getName(), LabelPrefix);
2578 } else if (!BB->use_empty()) { // Don't print block # of no uses...
2579 Out << "\n; <label>:";
2580 int Slot = Machine.getLocalSlot(BB);
2587 if (!BB->getParent()) {
2588 Out.PadToColumn(50);
2589 Out << "; Error: Block without parent!";
2590 } else if (BB != &BB->getParent()->getEntryBlock()) { // Not the entry block?
2591 // Output predecessors for the block.
2592 Out.PadToColumn(50);
2594 const_pred_iterator PI = pred_begin(BB), PE = pred_end(BB);
2597 Out << " No predecessors!";
2600 writeOperand(*PI, false);
2601 for (++PI; PI != PE; ++PI) {
2603 writeOperand(*PI, false);
2610 if (AnnotationWriter) AnnotationWriter->emitBasicBlockStartAnnot(BB, Out);
2612 // Output all of the instructions in the basic block...
2613 for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I != E; ++I) {
2614 printInstructionLine(*I);
2617 if (AnnotationWriter) AnnotationWriter->emitBasicBlockEndAnnot(BB, Out);
2620 /// printInstructionLine - Print an instruction and a newline character.
2621 void AssemblyWriter::printInstructionLine(const Instruction &I) {
2622 printInstruction(I);
2626 /// printInfoComment - Print a little comment after the instruction indicating
2627 /// which slot it occupies.
2629 void AssemblyWriter::printInfoComment(const Value &V) {
2630 if (AnnotationWriter)
2631 AnnotationWriter->printInfoComment(V, Out);
2634 // This member is called for each Instruction in a function..
2635 void AssemblyWriter::printInstruction(const Instruction &I) {
2636 if (AnnotationWriter) AnnotationWriter->emitInstructionAnnot(&I, Out);
2638 // Print out indentation for an instruction.
2641 // Print out name if it exists...
2643 PrintLLVMName(Out, &I);
2645 } else if (!I.getType()->isVoidTy()) {
2646 // Print out the def slot taken.
2647 int SlotNum = Machine.getLocalSlot(&I);
2649 Out << "<badref> = ";
2651 Out << '%' << SlotNum << " = ";
2654 if (const CallInst *CI = dyn_cast<CallInst>(&I)) {
2655 if (CI->isMustTailCall())
2657 else if (CI->isTailCall())
2661 // Print out the opcode...
2662 Out << I.getOpcodeName();
2664 // If this is an atomic load or store, print out the atomic marker.
2665 if ((isa<LoadInst>(I) && cast<LoadInst>(I).isAtomic()) ||
2666 (isa<StoreInst>(I) && cast<StoreInst>(I).isAtomic()))
2669 if (isa<AtomicCmpXchgInst>(I) && cast<AtomicCmpXchgInst>(I).isWeak())
2672 // If this is a volatile operation, print out the volatile marker.
2673 if ((isa<LoadInst>(I) && cast<LoadInst>(I).isVolatile()) ||
2674 (isa<StoreInst>(I) && cast<StoreInst>(I).isVolatile()) ||
2675 (isa<AtomicCmpXchgInst>(I) && cast<AtomicCmpXchgInst>(I).isVolatile()) ||
2676 (isa<AtomicRMWInst>(I) && cast<AtomicRMWInst>(I).isVolatile()))
2679 // Print out optimization information.
2680 WriteOptimizationInfo(Out, &I);
2682 // Print out the compare instruction predicates
2683 if (const CmpInst *CI = dyn_cast<CmpInst>(&I))
2684 Out << ' ' << getPredicateText(CI->getPredicate());
2686 // Print out the atomicrmw operation
2687 if (const AtomicRMWInst *RMWI = dyn_cast<AtomicRMWInst>(&I))
2688 writeAtomicRMWOperation(Out, RMWI->getOperation());
2690 // Print out the type of the operands...
2691 const Value *Operand = I.getNumOperands() ? I.getOperand(0) : nullptr;
2693 // Special case conditional branches to swizzle the condition out to the front
2694 if (isa<BranchInst>(I) && cast<BranchInst>(I).isConditional()) {
2695 const BranchInst &BI(cast<BranchInst>(I));
2697 writeOperand(BI.getCondition(), true);
2699 writeOperand(BI.getSuccessor(0), true);
2701 writeOperand(BI.getSuccessor(1), true);
2703 } else if (isa<SwitchInst>(I)) {
2704 const SwitchInst& SI(cast<SwitchInst>(I));
2705 // Special case switch instruction to get formatting nice and correct.
2707 writeOperand(SI.getCondition(), true);
2709 writeOperand(SI.getDefaultDest(), true);
2711 for (SwitchInst::ConstCaseIt i = SI.case_begin(), e = SI.case_end();
2714 writeOperand(i.getCaseValue(), true);
2716 writeOperand(i.getCaseSuccessor(), true);
2719 } else if (isa<IndirectBrInst>(I)) {
2720 // Special case indirectbr instruction to get formatting nice and correct.
2722 writeOperand(Operand, true);
2725 for (unsigned i = 1, e = I.getNumOperands(); i != e; ++i) {
2728 writeOperand(I.getOperand(i), true);
2731 } else if (const PHINode *PN = dyn_cast<PHINode>(&I)) {
2733 TypePrinter.print(I.getType(), Out);
2736 for (unsigned op = 0, Eop = PN->getNumIncomingValues(); op < Eop; ++op) {
2737 if (op) Out << ", ";
2739 writeOperand(PN->getIncomingValue(op), false); Out << ", ";
2740 writeOperand(PN->getIncomingBlock(op), false); Out << " ]";
2742 } else if (const ExtractValueInst *EVI = dyn_cast<ExtractValueInst>(&I)) {
2744 writeOperand(I.getOperand(0), true);
2745 for (const unsigned *i = EVI->idx_begin(), *e = EVI->idx_end(); i != e; ++i)
2747 } else if (const InsertValueInst *IVI = dyn_cast<InsertValueInst>(&I)) {
2749 writeOperand(I.getOperand(0), true); Out << ", ";
2750 writeOperand(I.getOperand(1), true);
2751 for (const unsigned *i = IVI->idx_begin(), *e = IVI->idx_end(); i != e; ++i)
2753 } else if (const LandingPadInst *LPI = dyn_cast<LandingPadInst>(&I)) {
2755 TypePrinter.print(I.getType(), Out);
2756 Out << " personality ";
2757 writeOperand(I.getOperand(0), true); Out << '\n';
2759 if (LPI->isCleanup())
2762 for (unsigned i = 0, e = LPI->getNumClauses(); i != e; ++i) {
2763 if (i != 0 || LPI->isCleanup()) Out << "\n";
2764 if (LPI->isCatch(i))
2769 writeOperand(LPI->getClause(i), true);
2771 } else if (isa<ReturnInst>(I) && !Operand) {
2773 } else if (const CallInst *CI = dyn_cast<CallInst>(&I)) {
2774 // Print the calling convention being used.
2775 if (CI->getCallingConv() != CallingConv::C) {
2777 PrintCallingConv(CI->getCallingConv(), Out);
2780 Operand = CI->getCalledValue();
2781 PointerType *PTy = cast<PointerType>(Operand->getType());
2782 FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
2783 Type *RetTy = FTy->getReturnType();
2784 const AttributeSet &PAL = CI->getAttributes();
2786 if (PAL.hasAttributes(AttributeSet::ReturnIndex))
2787 Out << ' ' << PAL.getAsString(AttributeSet::ReturnIndex);
2789 // If possible, print out the short form of the call instruction. We can
2790 // only do this if the first argument is a pointer to a nonvararg function,
2791 // and if the return type is not a pointer to a function.
2794 if (!FTy->isVarArg() &&
2795 (!RetTy->isPointerTy() ||
2796 !cast<PointerType>(RetTy)->getElementType()->isFunctionTy())) {
2797 TypePrinter.print(RetTy, Out);
2799 writeOperand(Operand, false);
2801 writeOperand(Operand, true);
2804 for (unsigned op = 0, Eop = CI->getNumArgOperands(); op < Eop; ++op) {
2807 writeParamOperand(CI->getArgOperand(op), PAL, op + 1);
2810 // Emit an ellipsis if this is a musttail call in a vararg function. This
2811 // is only to aid readability, musttail calls forward varargs by default.
2812 if (CI->isMustTailCall() && CI->getParent() &&
2813 CI->getParent()->getParent() &&
2814 CI->getParent()->getParent()->isVarArg())
2818 if (PAL.hasAttributes(AttributeSet::FunctionIndex))
2819 Out << " #" << Machine.getAttributeGroupSlot(PAL.getFnAttributes());
2820 } else if (const InvokeInst *II = dyn_cast<InvokeInst>(&I)) {
2821 Operand = II->getCalledValue();
2822 PointerType *PTy = cast<PointerType>(Operand->getType());
2823 FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
2824 Type *RetTy = FTy->getReturnType();
2825 const AttributeSet &PAL = II->getAttributes();
2827 // Print the calling convention being used.
2828 if (II->getCallingConv() != CallingConv::C) {
2830 PrintCallingConv(II->getCallingConv(), Out);
2833 if (PAL.hasAttributes(AttributeSet::ReturnIndex))
2834 Out << ' ' << PAL.getAsString(AttributeSet::ReturnIndex);
2836 // If possible, print out the short form of the invoke instruction. We can
2837 // only do this if the first argument is a pointer to a nonvararg function,
2838 // and if the return type is not a pointer to a function.
2841 if (!FTy->isVarArg() &&
2842 (!RetTy->isPointerTy() ||
2843 !cast<PointerType>(RetTy)->getElementType()->isFunctionTy())) {
2844 TypePrinter.print(RetTy, Out);
2846 writeOperand(Operand, false);
2848 writeOperand(Operand, true);
2851 for (unsigned op = 0, Eop = II->getNumArgOperands(); op < Eop; ++op) {
2854 writeParamOperand(II->getArgOperand(op), PAL, op + 1);
2858 if (PAL.hasAttributes(AttributeSet::FunctionIndex))
2859 Out << " #" << Machine.getAttributeGroupSlot(PAL.getFnAttributes());
2862 writeOperand(II->getNormalDest(), true);
2864 writeOperand(II->getUnwindDest(), true);
2866 } else if (const AllocaInst *AI = dyn_cast<AllocaInst>(&I)) {
2868 if (AI->isUsedWithInAlloca())
2870 TypePrinter.print(AI->getAllocatedType(), Out);
2872 // Explicitly write the array size if the code is broken, if it's an array
2873 // allocation, or if the type is not canonical for scalar allocations. The
2874 // latter case prevents the type from mutating when round-tripping through
2876 if (!AI->getArraySize() || AI->isArrayAllocation() ||
2877 !AI->getArraySize()->getType()->isIntegerTy(32)) {
2879 writeOperand(AI->getArraySize(), true);
2881 if (AI->getAlignment()) {
2882 Out << ", align " << AI->getAlignment();
2884 } else if (isa<CastInst>(I)) {
2887 writeOperand(Operand, true); // Work with broken code
2890 TypePrinter.print(I.getType(), Out);
2891 } else if (isa<VAArgInst>(I)) {
2894 writeOperand(Operand, true); // Work with broken code
2897 TypePrinter.print(I.getType(), Out);
2898 } else if (Operand) { // Print the normal way.
2899 if (const auto *GEP = dyn_cast<GetElementPtrInst>(&I)) {
2901 TypePrinter.print(GEP->getSourceElementType(), Out);
2903 } else if (const auto *LI = dyn_cast<LoadInst>(&I)) {
2905 TypePrinter.print(LI->getType(), Out);
2909 // PrintAllTypes - Instructions who have operands of all the same type
2910 // omit the type from all but the first operand. If the instruction has
2911 // different type operands (for example br), then they are all printed.
2912 bool PrintAllTypes = false;
2913 Type *TheType = Operand->getType();
2915 // Select, Store and ShuffleVector always print all types.
2916 if (isa<SelectInst>(I) || isa<StoreInst>(I) || isa<ShuffleVectorInst>(I)
2917 || isa<ReturnInst>(I)) {
2918 PrintAllTypes = true;
2920 for (unsigned i = 1, E = I.getNumOperands(); i != E; ++i) {
2921 Operand = I.getOperand(i);
2922 // note that Operand shouldn't be null, but the test helps make dump()
2923 // more tolerant of malformed IR
2924 if (Operand && Operand->getType() != TheType) {
2925 PrintAllTypes = true; // We have differing types! Print them all!
2931 if (!PrintAllTypes) {
2933 TypePrinter.print(TheType, Out);
2937 for (unsigned i = 0, E = I.getNumOperands(); i != E; ++i) {
2939 writeOperand(I.getOperand(i), PrintAllTypes);
2943 // Print atomic ordering/alignment for memory operations
2944 if (const LoadInst *LI = dyn_cast<LoadInst>(&I)) {
2946 writeAtomic(LI->getOrdering(), LI->getSynchScope());
2947 if (LI->getAlignment())
2948 Out << ", align " << LI->getAlignment();
2949 } else if (const StoreInst *SI = dyn_cast<StoreInst>(&I)) {
2951 writeAtomic(SI->getOrdering(), SI->getSynchScope());
2952 if (SI->getAlignment())
2953 Out << ", align " << SI->getAlignment();
2954 } else if (const AtomicCmpXchgInst *CXI = dyn_cast<AtomicCmpXchgInst>(&I)) {
2955 writeAtomicCmpXchg(CXI->getSuccessOrdering(), CXI->getFailureOrdering(),
2956 CXI->getSynchScope());
2957 } else if (const AtomicRMWInst *RMWI = dyn_cast<AtomicRMWInst>(&I)) {
2958 writeAtomic(RMWI->getOrdering(), RMWI->getSynchScope());
2959 } else if (const FenceInst *FI = dyn_cast<FenceInst>(&I)) {
2960 writeAtomic(FI->getOrdering(), FI->getSynchScope());
2963 // Print Metadata info.
2964 SmallVector<std::pair<unsigned, MDNode *>, 4> InstMD;
2965 I.getAllMetadata(InstMD);
2966 if (!InstMD.empty()) {
2967 SmallVector<StringRef, 8> MDNames;
2968 I.getType()->getContext().getMDKindNames(MDNames);
2969 for (unsigned i = 0, e = InstMD.size(); i != e; ++i) {
2970 unsigned Kind = InstMD[i].first;
2971 if (Kind < MDNames.size()) {
2972 Out << ", !" << MDNames[Kind];
2974 Out << ", !<unknown kind #" << Kind << ">";
2977 WriteAsOperandInternal(Out, InstMD[i].second, &TypePrinter, &Machine,
2981 printInfoComment(I);
2984 void AssemblyWriter::writeMDNode(unsigned Slot, const MDNode *Node) {
2985 Out << '!' << Slot << " = ";
2986 printMDNodeBody(Node);
2990 void AssemblyWriter::writeAllMDNodes() {
2991 SmallVector<const MDNode *, 16> Nodes;
2992 Nodes.resize(Machine.mdn_size());
2993 for (SlotTracker::mdn_iterator I = Machine.mdn_begin(), E = Machine.mdn_end();
2995 Nodes[I->second] = cast<MDNode>(I->first);
2997 for (unsigned i = 0, e = Nodes.size(); i != e; ++i) {
2998 writeMDNode(i, Nodes[i]);
3002 void AssemblyWriter::printMDNodeBody(const MDNode *Node) {
3003 WriteMDNodeBodyInternal(Out, Node, &TypePrinter, &Machine, TheModule);
3006 void AssemblyWriter::writeAllAttributeGroups() {
3007 std::vector<std::pair<AttributeSet, unsigned> > asVec;
3008 asVec.resize(Machine.as_size());
3010 for (SlotTracker::as_iterator I = Machine.as_begin(), E = Machine.as_end();
3012 asVec[I->second] = *I;
3014 for (std::vector<std::pair<AttributeSet, unsigned> >::iterator
3015 I = asVec.begin(), E = asVec.end(); I != E; ++I)
3016 Out << "attributes #" << I->second << " = { "
3017 << I->first.getAsString(AttributeSet::FunctionIndex, true) << " }\n";
3020 void AssemblyWriter::printUseListOrder(const UseListOrder &Order) {
3021 bool IsInFunction = Machine.getFunction();
3025 Out << "uselistorder";
3026 if (const BasicBlock *BB =
3027 IsInFunction ? nullptr : dyn_cast<BasicBlock>(Order.V)) {
3029 writeOperand(BB->getParent(), false);
3031 writeOperand(BB, false);
3034 writeOperand(Order.V, true);
3038 assert(Order.Shuffle.size() >= 2 && "Shuffle too small");
3039 Out << Order.Shuffle[0];
3040 for (unsigned I = 1, E = Order.Shuffle.size(); I != E; ++I)
3041 Out << ", " << Order.Shuffle[I];
3045 void AssemblyWriter::printUseLists(const Function *F) {
3047 [&]() { return !UseListOrders.empty() && UseListOrders.back().F == F; };
3052 Out << "\n; uselistorder directives\n";
3054 printUseListOrder(UseListOrders.back());
3055 UseListOrders.pop_back();
3059 //===----------------------------------------------------------------------===//
3060 // External Interface declarations
3061 //===----------------------------------------------------------------------===//
3063 void Module::print(raw_ostream &ROS, AssemblyAnnotationWriter *AAW) const {
3064 SlotTracker SlotTable(this);
3065 formatted_raw_ostream OS(ROS);
3066 AssemblyWriter W(OS, SlotTable, this, AAW);
3067 W.printModule(this);
3070 void NamedMDNode::print(raw_ostream &ROS) const {
3071 SlotTracker SlotTable(getParent());
3072 formatted_raw_ostream OS(ROS);
3073 AssemblyWriter W(OS, SlotTable, getParent(), nullptr);
3074 W.printNamedMDNode(this);
3077 void Comdat::print(raw_ostream &ROS) const {
3078 PrintLLVMName(ROS, getName(), ComdatPrefix);
3079 ROS << " = comdat ";
3081 switch (getSelectionKind()) {
3085 case Comdat::ExactMatch:
3086 ROS << "exactmatch";
3088 case Comdat::Largest:
3091 case Comdat::NoDuplicates:
3092 ROS << "noduplicates";
3094 case Comdat::SameSize:
3102 void Type::print(raw_ostream &OS) const {
3104 TP.print(const_cast<Type*>(this), OS);
3106 // If the type is a named struct type, print the body as well.
3107 if (StructType *STy = dyn_cast<StructType>(const_cast<Type*>(this)))
3108 if (!STy->isLiteral()) {
3110 TP.printStructBody(STy, OS);
3114 static bool isReferencingMDNode(const Instruction &I) {
3115 if (const auto *CI = dyn_cast<CallInst>(&I))
3116 if (Function *F = CI->getCalledFunction())
3117 if (F->isIntrinsic())
3118 for (auto &Op : I.operands())
3119 if (auto *V = dyn_cast_or_null<MetadataAsValue>(Op))
3120 if (isa<MDNode>(V->getMetadata()))
3125 void Value::print(raw_ostream &ROS) const {
3126 formatted_raw_ostream OS(ROS);
3127 if (const Instruction *I = dyn_cast<Instruction>(this)) {
3128 const Function *F = I->getParent() ? I->getParent()->getParent() : nullptr;
3129 SlotTracker SlotTable(
3131 /* ShouldInitializeAllMetadata */ isReferencingMDNode(*I));
3132 AssemblyWriter W(OS, SlotTable, getModuleFromVal(I), nullptr);
3133 W.printInstruction(*I);
3134 } else if (const BasicBlock *BB = dyn_cast<BasicBlock>(this)) {
3135 SlotTracker SlotTable(BB->getParent());
3136 AssemblyWriter W(OS, SlotTable, getModuleFromVal(BB), nullptr);
3137 W.printBasicBlock(BB);
3138 } else if (const GlobalValue *GV = dyn_cast<GlobalValue>(this)) {
3139 SlotTracker SlotTable(GV->getParent(),
3140 /* ShouldInitializeAllMetadata */ isa<Function>(GV));
3141 AssemblyWriter W(OS, SlotTable, GV->getParent(), nullptr);
3142 if (const GlobalVariable *V = dyn_cast<GlobalVariable>(GV))
3144 else if (const Function *F = dyn_cast<Function>(GV))
3147 W.printAlias(cast<GlobalAlias>(GV));
3148 } else if (const MetadataAsValue *V = dyn_cast<MetadataAsValue>(this)) {
3149 V->getMetadata()->print(ROS, getModuleFromVal(V));
3150 } else if (const Constant *C = dyn_cast<Constant>(this)) {
3151 TypePrinting TypePrinter;
3152 TypePrinter.print(C->getType(), OS);
3154 WriteConstantInternal(OS, C, TypePrinter, nullptr, nullptr);
3155 } else if (isa<InlineAsm>(this) || isa<Argument>(this)) {
3156 this->printAsOperand(OS);
3158 llvm_unreachable("Unknown value to print out!");
3162 void Value::printAsOperand(raw_ostream &O, bool PrintType, const Module *M) const {
3163 // Fast path: Don't construct and populate a TypePrinting object if we
3164 // won't be needing any types printed.
3165 bool IsMetadata = isa<MetadataAsValue>(this);
3166 if (!PrintType && ((!isa<Constant>(this) && !IsMetadata) || hasName() ||
3167 isa<GlobalValue>(this))) {
3168 WriteAsOperandInternal(O, this, nullptr, nullptr, M);
3173 M = getModuleFromVal(this);
3175 TypePrinting TypePrinter;
3177 TypePrinter.incorporateTypes(*M);
3179 TypePrinter.print(getType(), O);
3183 SlotTracker Machine(M, /* ShouldInitializeAllMetadata */ IsMetadata);
3184 WriteAsOperandInternal(O, this, &TypePrinter, &Machine, M);
3187 static void printMetadataImpl(raw_ostream &ROS, const Metadata &MD,
3188 const Module *M, bool OnlyAsOperand) {
3189 formatted_raw_ostream OS(ROS);
3191 auto *N = dyn_cast<MDNode>(&MD);
3192 TypePrinting TypePrinter;
3193 SlotTracker Machine(M, /* ShouldInitializeAllMetadata */ N);
3195 TypePrinter.incorporateTypes(*M);
3197 WriteAsOperandInternal(OS, &MD, &TypePrinter, &Machine, M,
3198 /* FromValue */ true);
3199 if (OnlyAsOperand || !N)
3203 WriteMDNodeBodyInternal(OS, N, &TypePrinter, &Machine, M);
3206 void Metadata::printAsOperand(raw_ostream &OS, const Module *M) const {
3207 printMetadataImpl(OS, *this, M, /* OnlyAsOperand */ true);
3210 void Metadata::print(raw_ostream &OS, const Module *M) const {
3211 printMetadataImpl(OS, *this, M, /* OnlyAsOperand */ false);
3214 // Value::dump - allow easy printing of Values from the debugger.
3216 void Value::dump() const { print(dbgs()); dbgs() << '\n'; }
3218 // Type::dump - allow easy printing of Types from the debugger.
3220 void Type::dump() const { print(dbgs()); dbgs() << '\n'; }
3222 // Module::dump() - Allow printing of Modules from the debugger.
3224 void Module::dump() const { print(dbgs(), nullptr); }
3226 // \brief Allow printing of Comdats from the debugger.
3228 void Comdat::dump() const { print(dbgs()); }
3230 // NamedMDNode::dump() - Allow printing of NamedMDNodes from the debugger.
3232 void NamedMDNode::dump() const { print(dbgs()); }
3235 void Metadata::dump() const { dump(nullptr); }
3238 void Metadata::dump(const Module *M) const {