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/Statepoint.h"
35 #include "llvm/IR/TypeFinder.h"
36 #include "llvm/IR/UseListOrder.h"
37 #include "llvm/IR/ValueSymbolTable.h"
38 #include "llvm/Support/Debug.h"
39 #include "llvm/Support/Dwarf.h"
40 #include "llvm/Support/ErrorHandling.h"
41 #include "llvm/Support/FormattedStream.h"
42 #include "llvm/Support/MathExtras.h"
43 #include "llvm/Support/raw_ostream.h"
48 // Make virtual table appear in this compilation unit.
49 AssemblyAnnotationWriter::~AssemblyAnnotationWriter() {}
51 //===----------------------------------------------------------------------===//
53 //===----------------------------------------------------------------------===//
57 DenseMap<const Value *, std::pair<unsigned, bool>> IDs;
59 unsigned size() const { return IDs.size(); }
60 std::pair<unsigned, bool> &operator[](const Value *V) { return IDs[V]; }
61 std::pair<unsigned, bool> lookup(const Value *V) const {
64 void index(const Value *V) {
65 // Explicitly sequence get-size and insert-value operations to avoid UB.
66 unsigned ID = IDs.size() + 1;
72 static void orderValue(const Value *V, OrderMap &OM) {
73 if (OM.lookup(V).first)
76 if (const Constant *C = dyn_cast<Constant>(V))
77 if (C->getNumOperands() && !isa<GlobalValue>(C))
78 for (const Value *Op : C->operands())
79 if (!isa<BasicBlock>(Op) && !isa<GlobalValue>(Op))
82 // Note: we cannot cache this lookup above, since inserting into the map
83 // changes the map's size, and thus affects the other IDs.
87 static OrderMap orderModule(const Module *M) {
88 // This needs to match the order used by ValueEnumerator::ValueEnumerator()
89 // and ValueEnumerator::incorporateFunction().
92 for (const GlobalVariable &G : M->globals()) {
93 if (G.hasInitializer())
94 if (!isa<GlobalValue>(G.getInitializer()))
95 orderValue(G.getInitializer(), OM);
98 for (const GlobalAlias &A : M->aliases()) {
99 if (!isa<GlobalValue>(A.getAliasee()))
100 orderValue(A.getAliasee(), OM);
103 for (const Function &F : *M) {
104 if (F.hasPrefixData())
105 if (!isa<GlobalValue>(F.getPrefixData()))
106 orderValue(F.getPrefixData(), OM);
108 if (F.hasPrologueData())
109 if (!isa<GlobalValue>(F.getPrologueData()))
110 orderValue(F.getPrologueData(), OM);
114 if (F.isDeclaration())
117 for (const Argument &A : F.args())
119 for (const BasicBlock &BB : F) {
121 for (const Instruction &I : BB) {
122 for (const Value *Op : I.operands())
123 if ((isa<Constant>(*Op) && !isa<GlobalValue>(*Op)) ||
133 static void predictValueUseListOrderImpl(const Value *V, const Function *F,
134 unsigned ID, const OrderMap &OM,
135 UseListOrderStack &Stack) {
136 // Predict use-list order for this one.
137 typedef std::pair<const Use *, unsigned> Entry;
138 SmallVector<Entry, 64> List;
139 for (const Use &U : V->uses())
140 // Check if this user will be serialized.
141 if (OM.lookup(U.getUser()).first)
142 List.push_back(std::make_pair(&U, List.size()));
145 // We may have lost some users.
149 !isa<GlobalVariable>(V) && !isa<Function>(V) && !isa<BasicBlock>(V);
150 if (auto *BA = dyn_cast<BlockAddress>(V))
151 ID = OM.lookup(BA->getBasicBlock()).first;
152 std::sort(List.begin(), List.end(), [&](const Entry &L, const Entry &R) {
153 const Use *LU = L.first;
154 const Use *RU = R.first;
158 auto LID = OM.lookup(LU->getUser()).first;
159 auto RID = OM.lookup(RU->getUser()).first;
161 // If ID is 4, then expect: 7 6 5 1 2 3.
175 // LID and RID are equal, so we have different operands of the same user.
176 // Assume operands are added in order for all instructions.
179 return LU->getOperandNo() < RU->getOperandNo();
180 return LU->getOperandNo() > RU->getOperandNo();
184 List.begin(), List.end(),
185 [](const Entry &L, const Entry &R) { return L.second < R.second; }))
186 // Order is already correct.
189 // Store the shuffle.
190 Stack.emplace_back(V, F, List.size());
191 assert(List.size() == Stack.back().Shuffle.size() && "Wrong size");
192 for (size_t I = 0, E = List.size(); I != E; ++I)
193 Stack.back().Shuffle[I] = List[I].second;
196 static void predictValueUseListOrder(const Value *V, const Function *F,
197 OrderMap &OM, UseListOrderStack &Stack) {
198 auto &IDPair = OM[V];
199 assert(IDPair.first && "Unmapped value");
201 // Already predicted.
204 // Do the actual prediction.
205 IDPair.second = true;
206 if (!V->use_empty() && std::next(V->use_begin()) != V->use_end())
207 predictValueUseListOrderImpl(V, F, IDPair.first, OM, Stack);
209 // Recursive descent into constants.
210 if (const Constant *C = dyn_cast<Constant>(V))
211 if (C->getNumOperands()) // Visit GlobalValues.
212 for (const Value *Op : C->operands())
213 if (isa<Constant>(Op)) // Visit GlobalValues.
214 predictValueUseListOrder(Op, F, OM, Stack);
217 static UseListOrderStack predictUseListOrder(const Module *M) {
218 OrderMap OM = orderModule(M);
220 // Use-list orders need to be serialized after all the users have been added
221 // to a value, or else the shuffles will be incomplete. Store them per
222 // function in a stack.
224 // Aside from function order, the order of values doesn't matter much here.
225 UseListOrderStack Stack;
227 // We want to visit the functions backward now so we can list function-local
228 // constants in the last Function they're used in. Module-level constants
229 // have already been visited above.
230 for (auto I = M->rbegin(), E = M->rend(); I != E; ++I) {
231 const Function &F = *I;
232 if (F.isDeclaration())
234 for (const BasicBlock &BB : F)
235 predictValueUseListOrder(&BB, &F, OM, Stack);
236 for (const Argument &A : F.args())
237 predictValueUseListOrder(&A, &F, OM, Stack);
238 for (const BasicBlock &BB : F)
239 for (const Instruction &I : BB)
240 for (const Value *Op : I.operands())
241 if (isa<Constant>(*Op) || isa<InlineAsm>(*Op)) // Visit GlobalValues.
242 predictValueUseListOrder(Op, &F, OM, Stack);
243 for (const BasicBlock &BB : F)
244 for (const Instruction &I : BB)
245 predictValueUseListOrder(&I, &F, OM, Stack);
248 // Visit globals last.
249 for (const GlobalVariable &G : M->globals())
250 predictValueUseListOrder(&G, nullptr, OM, Stack);
251 for (const Function &F : *M)
252 predictValueUseListOrder(&F, nullptr, OM, Stack);
253 for (const GlobalAlias &A : M->aliases())
254 predictValueUseListOrder(&A, nullptr, OM, Stack);
255 for (const GlobalVariable &G : M->globals())
256 if (G.hasInitializer())
257 predictValueUseListOrder(G.getInitializer(), nullptr, OM, Stack);
258 for (const GlobalAlias &A : M->aliases())
259 predictValueUseListOrder(A.getAliasee(), nullptr, OM, Stack);
260 for (const Function &F : *M)
261 if (F.hasPrefixData())
262 predictValueUseListOrder(F.getPrefixData(), nullptr, OM, Stack);
267 static const Module *getModuleFromVal(const Value *V) {
268 if (const Argument *MA = dyn_cast<Argument>(V))
269 return MA->getParent() ? MA->getParent()->getParent() : nullptr;
271 if (const BasicBlock *BB = dyn_cast<BasicBlock>(V))
272 return BB->getParent() ? BB->getParent()->getParent() : nullptr;
274 if (const Instruction *I = dyn_cast<Instruction>(V)) {
275 const Function *M = I->getParent() ? I->getParent()->getParent() : nullptr;
276 return M ? M->getParent() : nullptr;
279 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V))
280 return GV->getParent();
282 if (const auto *MAV = dyn_cast<MetadataAsValue>(V)) {
283 for (const User *U : MAV->users())
284 if (isa<Instruction>(U))
285 if (const Module *M = getModuleFromVal(U))
293 static void PrintCallingConv(unsigned cc, raw_ostream &Out) {
295 default: Out << "cc" << cc; break;
296 case CallingConv::Fast: Out << "fastcc"; break;
297 case CallingConv::Cold: Out << "coldcc"; break;
298 case CallingConv::WebKit_JS: Out << "webkit_jscc"; break;
299 case CallingConv::AnyReg: Out << "anyregcc"; break;
300 case CallingConv::PreserveMost: Out << "preserve_mostcc"; break;
301 case CallingConv::PreserveAll: Out << "preserve_allcc"; break;
302 case CallingConv::GHC: Out << "ghccc"; break;
303 case CallingConv::X86_StdCall: Out << "x86_stdcallcc"; break;
304 case CallingConv::X86_FastCall: Out << "x86_fastcallcc"; break;
305 case CallingConv::X86_ThisCall: Out << "x86_thiscallcc"; break;
306 case CallingConv::X86_VectorCall:Out << "x86_vectorcallcc"; break;
307 case CallingConv::Intel_OCL_BI: Out << "intel_ocl_bicc"; break;
308 case CallingConv::ARM_APCS: Out << "arm_apcscc"; break;
309 case CallingConv::ARM_AAPCS: Out << "arm_aapcscc"; break;
310 case CallingConv::ARM_AAPCS_VFP: Out << "arm_aapcs_vfpcc"; break;
311 case CallingConv::MSP430_INTR: Out << "msp430_intrcc"; break;
312 case CallingConv::PTX_Kernel: Out << "ptx_kernel"; break;
313 case CallingConv::PTX_Device: Out << "ptx_device"; break;
314 case CallingConv::X86_64_SysV: Out << "x86_64_sysvcc"; break;
315 case CallingConv::X86_64_Win64: Out << "x86_64_win64cc"; break;
316 case CallingConv::SPIR_FUNC: Out << "spir_func"; break;
317 case CallingConv::SPIR_KERNEL: Out << "spir_kernel"; break;
321 // PrintEscapedString - Print each character of the specified string, escaping
322 // it if it is not printable or if it is an escape char.
323 static void PrintEscapedString(StringRef Name, raw_ostream &Out) {
324 for (unsigned i = 0, e = Name.size(); i != e; ++i) {
325 unsigned char C = Name[i];
326 if (isprint(C) && C != '\\' && C != '"')
329 Out << '\\' << hexdigit(C >> 4) << hexdigit(C & 0x0F);
341 /// PrintLLVMName - Turn the specified name into an 'LLVM name', which is either
342 /// prefixed with % (if the string only contains simple characters) or is
343 /// surrounded with ""'s (if it has special chars in it). Print it out.
344 static void PrintLLVMName(raw_ostream &OS, StringRef Name, PrefixType Prefix) {
345 assert(!Name.empty() && "Cannot get empty name!");
347 case NoPrefix: break;
348 case GlobalPrefix: OS << '@'; break;
349 case ComdatPrefix: OS << '$'; break;
350 case LabelPrefix: break;
351 case LocalPrefix: OS << '%'; break;
354 // Scan the name to see if it needs quotes first.
355 bool NeedsQuotes = isdigit(static_cast<unsigned char>(Name[0]));
357 for (unsigned i = 0, e = Name.size(); i != e; ++i) {
358 // By making this unsigned, the value passed in to isalnum will always be
359 // in the range 0-255. This is important when building with MSVC because
360 // its implementation will assert. This situation can arise when dealing
361 // with UTF-8 multibyte characters.
362 unsigned char C = Name[i];
363 if (!isalnum(static_cast<unsigned char>(C)) && C != '-' && C != '.' &&
371 // If we didn't need any quotes, just write out the name in one blast.
377 // Okay, we need quotes. Output the quotes and escape any scary characters as
380 PrintEscapedString(Name, OS);
384 /// PrintLLVMName - Turn the specified name into an 'LLVM name', which is either
385 /// prefixed with % (if the string only contains simple characters) or is
386 /// surrounded with ""'s (if it has special chars in it). Print it out.
387 static void PrintLLVMName(raw_ostream &OS, const Value *V) {
388 PrintLLVMName(OS, V->getName(),
389 isa<GlobalValue>(V) ? GlobalPrefix : LocalPrefix);
395 TypePrinting(const TypePrinting &) = delete;
396 void operator=(const TypePrinting&) = delete;
399 /// NamedTypes - The named types that are used by the current module.
400 TypeFinder NamedTypes;
402 /// NumberedTypes - The numbered types, along with their value.
403 DenseMap<StructType*, unsigned> NumberedTypes;
405 TypePrinting() = default;
407 void incorporateTypes(const Module &M);
409 void print(Type *Ty, raw_ostream &OS);
411 void printStructBody(StructType *Ty, raw_ostream &OS);
415 void TypePrinting::incorporateTypes(const Module &M) {
416 NamedTypes.run(M, false);
418 // The list of struct types we got back includes all the struct types, split
419 // the unnamed ones out to a numbering and remove the anonymous structs.
420 unsigned NextNumber = 0;
422 std::vector<StructType*>::iterator NextToUse = NamedTypes.begin(), I, E;
423 for (I = NamedTypes.begin(), E = NamedTypes.end(); I != E; ++I) {
424 StructType *STy = *I;
426 // Ignore anonymous types.
427 if (STy->isLiteral())
430 if (STy->getName().empty())
431 NumberedTypes[STy] = NextNumber++;
436 NamedTypes.erase(NextToUse, NamedTypes.end());
440 /// CalcTypeName - Write the specified type to the specified raw_ostream, making
441 /// use of type names or up references to shorten the type name where possible.
442 void TypePrinting::print(Type *Ty, raw_ostream &OS) {
443 switch (Ty->getTypeID()) {
444 case Type::VoidTyID: OS << "void"; return;
445 case Type::HalfTyID: OS << "half"; return;
446 case Type::FloatTyID: OS << "float"; return;
447 case Type::DoubleTyID: OS << "double"; return;
448 case Type::X86_FP80TyID: OS << "x86_fp80"; return;
449 case Type::FP128TyID: OS << "fp128"; return;
450 case Type::PPC_FP128TyID: OS << "ppc_fp128"; return;
451 case Type::LabelTyID: OS << "label"; return;
452 case Type::MetadataTyID: OS << "metadata"; return;
453 case Type::X86_MMXTyID: OS << "x86_mmx"; return;
454 case Type::IntegerTyID:
455 OS << 'i' << cast<IntegerType>(Ty)->getBitWidth();
458 case Type::FunctionTyID: {
459 FunctionType *FTy = cast<FunctionType>(Ty);
460 print(FTy->getReturnType(), OS);
462 for (FunctionType::param_iterator I = FTy->param_begin(),
463 E = FTy->param_end(); I != E; ++I) {
464 if (I != FTy->param_begin())
468 if (FTy->isVarArg()) {
469 if (FTy->getNumParams()) OS << ", ";
475 case Type::StructTyID: {
476 StructType *STy = cast<StructType>(Ty);
478 if (STy->isLiteral())
479 return printStructBody(STy, OS);
481 if (!STy->getName().empty())
482 return PrintLLVMName(OS, STy->getName(), LocalPrefix);
484 DenseMap<StructType*, unsigned>::iterator I = NumberedTypes.find(STy);
485 if (I != NumberedTypes.end())
486 OS << '%' << I->second;
487 else // Not enumerated, print the hex address.
488 OS << "%\"type " << STy << '\"';
491 case Type::PointerTyID: {
492 PointerType *PTy = cast<PointerType>(Ty);
493 print(PTy->getElementType(), OS);
494 if (unsigned AddressSpace = PTy->getAddressSpace())
495 OS << " addrspace(" << AddressSpace << ')';
499 case Type::ArrayTyID: {
500 ArrayType *ATy = cast<ArrayType>(Ty);
501 OS << '[' << ATy->getNumElements() << " x ";
502 print(ATy->getElementType(), OS);
506 case Type::VectorTyID: {
507 VectorType *PTy = cast<VectorType>(Ty);
508 OS << "<" << PTy->getNumElements() << " x ";
509 print(PTy->getElementType(), OS);
514 llvm_unreachable("Invalid TypeID");
517 void TypePrinting::printStructBody(StructType *STy, raw_ostream &OS) {
518 if (STy->isOpaque()) {
526 if (STy->getNumElements() == 0) {
529 StructType::element_iterator I = STy->element_begin();
532 for (StructType::element_iterator E = STy->element_end(); I != E; ++I) {
544 //===----------------------------------------------------------------------===//
545 // SlotTracker Class: Enumerate slot numbers for unnamed values
546 //===----------------------------------------------------------------------===//
547 /// This class provides computation of slot numbers for LLVM Assembly writing.
551 /// ValueMap - A mapping of Values to slot numbers.
552 typedef DenseMap<const Value*, unsigned> ValueMap;
555 /// TheModule - The module for which we are holding slot numbers.
556 const Module* TheModule;
558 /// TheFunction - The function for which we are holding slot numbers.
559 const Function* TheFunction;
560 bool FunctionProcessed;
561 bool ShouldInitializeAllMetadata;
563 /// mMap - The slot map for the module level data.
567 /// fMap - The slot map for the function level data.
571 /// mdnMap - Map for MDNodes.
572 DenseMap<const MDNode*, unsigned> mdnMap;
575 /// asMap - The slot map for attribute sets.
576 DenseMap<AttributeSet, unsigned> asMap;
579 /// Construct from a module.
581 /// If \c ShouldInitializeAllMetadata, initializes all metadata in all
582 /// functions, giving correct numbering for metadata referenced only from
583 /// within a function (even if no functions have been initialized).
584 explicit SlotTracker(const Module *M,
585 bool ShouldInitializeAllMetadata = false);
586 /// Construct from a function, starting out in incorp state.
588 /// If \c ShouldInitializeAllMetadata, initializes all metadata in all
589 /// functions, giving correct numbering for metadata referenced only from
590 /// within a function (even if no functions have been initialized).
591 explicit SlotTracker(const Function *F,
592 bool ShouldInitializeAllMetadata = false);
594 /// Return the slot number of the specified value in it's type
595 /// plane. If something is not in the SlotTracker, return -1.
596 int getLocalSlot(const Value *V);
597 int getGlobalSlot(const GlobalValue *V);
598 int getMetadataSlot(const MDNode *N);
599 int getAttributeGroupSlot(AttributeSet AS);
601 /// If you'd like to deal with a function instead of just a module, use
602 /// this method to get its data into the SlotTracker.
603 void incorporateFunction(const Function *F) {
605 FunctionProcessed = false;
608 const Function *getFunction() const { return TheFunction; }
610 /// After calling incorporateFunction, use this method to remove the
611 /// most recently incorporated function from the SlotTracker. This
612 /// will reset the state of the machine back to just the module contents.
613 void purgeFunction();
615 /// MDNode map iterators.
616 typedef DenseMap<const MDNode*, unsigned>::iterator mdn_iterator;
617 mdn_iterator mdn_begin() { return mdnMap.begin(); }
618 mdn_iterator mdn_end() { return mdnMap.end(); }
619 unsigned mdn_size() const { return mdnMap.size(); }
620 bool mdn_empty() const { return mdnMap.empty(); }
622 /// AttributeSet map iterators.
623 typedef DenseMap<AttributeSet, unsigned>::iterator as_iterator;
624 as_iterator as_begin() { return asMap.begin(); }
625 as_iterator as_end() { return asMap.end(); }
626 unsigned as_size() const { return asMap.size(); }
627 bool as_empty() const { return asMap.empty(); }
629 /// This function does the actual initialization.
630 inline void initialize();
632 // Implementation Details
634 /// CreateModuleSlot - Insert the specified GlobalValue* into the slot table.
635 void CreateModuleSlot(const GlobalValue *V);
637 /// CreateMetadataSlot - Insert the specified MDNode* into the slot table.
638 void CreateMetadataSlot(const MDNode *N);
640 /// CreateFunctionSlot - Insert the specified Value* into the slot table.
641 void CreateFunctionSlot(const Value *V);
643 /// \brief Insert the specified AttributeSet into the slot table.
644 void CreateAttributeSetSlot(AttributeSet AS);
646 /// Add all of the module level global variables (and their initializers)
647 /// and function declarations, but not the contents of those functions.
648 void processModule();
650 /// Add all of the functions arguments, basic blocks, and instructions.
651 void processFunction();
653 /// Add all of the metadata from a function.
654 void processFunctionMetadata(const Function &F);
656 /// Add all of the metadata from an instruction.
657 void processInstructionMetadata(const Instruction &I);
659 SlotTracker(const SlotTracker &) = delete;
660 void operator=(const SlotTracker &) = delete;
664 static SlotTracker *createSlotTracker(const Module *M) {
665 return new SlotTracker(M);
668 static SlotTracker *createSlotTracker(const Value *V) {
669 if (const Argument *FA = dyn_cast<Argument>(V))
670 return new SlotTracker(FA->getParent());
672 if (const Instruction *I = dyn_cast<Instruction>(V))
674 return new SlotTracker(I->getParent()->getParent());
676 if (const BasicBlock *BB = dyn_cast<BasicBlock>(V))
677 return new SlotTracker(BB->getParent());
679 if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(V))
680 return new SlotTracker(GV->getParent());
682 if (const GlobalAlias *GA = dyn_cast<GlobalAlias>(V))
683 return new SlotTracker(GA->getParent());
685 if (const Function *Func = dyn_cast<Function>(V))
686 return new SlotTracker(Func);
692 #define ST_DEBUG(X) dbgs() << X
697 // Module level constructor. Causes the contents of the Module (sans functions)
698 // to be added to the slot table.
699 SlotTracker::SlotTracker(const Module *M, bool ShouldInitializeAllMetadata)
700 : TheModule(M), TheFunction(nullptr), FunctionProcessed(false),
701 ShouldInitializeAllMetadata(ShouldInitializeAllMetadata), mNext(0),
702 fNext(0), mdnNext(0), asNext(0) {}
704 // Function level constructor. Causes the contents of the Module and the one
705 // function provided to be added to the slot table.
706 SlotTracker::SlotTracker(const Function *F, bool ShouldInitializeAllMetadata)
707 : TheModule(F ? F->getParent() : nullptr), TheFunction(F),
708 FunctionProcessed(false),
709 ShouldInitializeAllMetadata(ShouldInitializeAllMetadata), mNext(0),
710 fNext(0), mdnNext(0), asNext(0) {}
712 inline void SlotTracker::initialize() {
715 TheModule = nullptr; ///< Prevent re-processing next time we're called.
718 if (TheFunction && !FunctionProcessed)
722 // Iterate through all the global variables, functions, and global
723 // variable initializers and create slots for them.
724 void SlotTracker::processModule() {
725 ST_DEBUG("begin processModule!\n");
727 // Add all of the unnamed global variables to the value table.
728 for (Module::const_global_iterator I = TheModule->global_begin(),
729 E = TheModule->global_end(); I != E; ++I) {
734 // Add metadata used by named metadata.
735 for (Module::const_named_metadata_iterator
736 I = TheModule->named_metadata_begin(),
737 E = TheModule->named_metadata_end(); I != E; ++I) {
738 const NamedMDNode *NMD = I;
739 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i)
740 CreateMetadataSlot(NMD->getOperand(i));
743 for (Module::const_iterator I = TheModule->begin(), E = TheModule->end();
746 // Add all the unnamed functions to the table.
749 if (ShouldInitializeAllMetadata)
750 processFunctionMetadata(*I);
752 // Add all the function attributes to the table.
753 // FIXME: Add attributes of other objects?
754 AttributeSet FnAttrs = I->getAttributes().getFnAttributes();
755 if (FnAttrs.hasAttributes(AttributeSet::FunctionIndex))
756 CreateAttributeSetSlot(FnAttrs);
759 ST_DEBUG("end processModule!\n");
762 // Process the arguments, basic blocks, and instructions of a function.
763 void SlotTracker::processFunction() {
764 ST_DEBUG("begin processFunction!\n");
767 // Add all the function arguments with no names.
768 for(Function::const_arg_iterator AI = TheFunction->arg_begin(),
769 AE = TheFunction->arg_end(); AI != AE; ++AI)
771 CreateFunctionSlot(AI);
773 ST_DEBUG("Inserting Instructions:\n");
775 // Add all of the basic blocks and instructions with no names.
776 for (auto &BB : *TheFunction) {
778 CreateFunctionSlot(&BB);
780 processFunctionMetadata(*TheFunction);
783 if (!I.getType()->isVoidTy() && !I.hasName())
784 CreateFunctionSlot(&I);
786 // We allow direct calls to any llvm.foo function here, because the
787 // target may not be linked into the optimizer.
788 if (const CallInst *CI = dyn_cast<CallInst>(&I)) {
789 // Add all the call attributes to the table.
790 AttributeSet Attrs = CI->getAttributes().getFnAttributes();
791 if (Attrs.hasAttributes(AttributeSet::FunctionIndex))
792 CreateAttributeSetSlot(Attrs);
793 } else if (const InvokeInst *II = dyn_cast<InvokeInst>(&I)) {
794 // Add all the call attributes to the table.
795 AttributeSet Attrs = II->getAttributes().getFnAttributes();
796 if (Attrs.hasAttributes(AttributeSet::FunctionIndex))
797 CreateAttributeSetSlot(Attrs);
802 FunctionProcessed = true;
804 ST_DEBUG("end processFunction!\n");
807 void SlotTracker::processFunctionMetadata(const Function &F) {
808 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
810 F.getAllMetadata(MDs);
812 CreateMetadataSlot(MD.second);
815 processInstructionMetadata(I);
819 void SlotTracker::processInstructionMetadata(const Instruction &I) {
820 // Process metadata used directly by intrinsics.
821 if (const CallInst *CI = dyn_cast<CallInst>(&I))
822 if (Function *F = CI->getCalledFunction())
823 if (F->isIntrinsic())
824 for (auto &Op : I.operands())
825 if (auto *V = dyn_cast_or_null<MetadataAsValue>(Op))
826 if (MDNode *N = dyn_cast<MDNode>(V->getMetadata()))
827 CreateMetadataSlot(N);
829 // Process metadata attached to this instruction.
830 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
831 I.getAllMetadata(MDs);
833 CreateMetadataSlot(MD.second);
836 /// Clean up after incorporating a function. This is the only way to get out of
837 /// the function incorporation state that affects get*Slot/Create*Slot. Function
838 /// incorporation state is indicated by TheFunction != 0.
839 void SlotTracker::purgeFunction() {
840 ST_DEBUG("begin purgeFunction!\n");
841 fMap.clear(); // Simply discard the function level map
842 TheFunction = nullptr;
843 FunctionProcessed = false;
844 ST_DEBUG("end purgeFunction!\n");
847 /// getGlobalSlot - Get the slot number of a global value.
848 int SlotTracker::getGlobalSlot(const GlobalValue *V) {
849 // Check for uninitialized state and do lazy initialization.
852 // Find the value in the module map
853 ValueMap::iterator MI = mMap.find(V);
854 return MI == mMap.end() ? -1 : (int)MI->second;
857 /// getMetadataSlot - Get the slot number of a MDNode.
858 int SlotTracker::getMetadataSlot(const MDNode *N) {
859 // Check for uninitialized state and do lazy initialization.
862 // Find the MDNode in the module map
863 mdn_iterator MI = mdnMap.find(N);
864 return MI == mdnMap.end() ? -1 : (int)MI->second;
868 /// getLocalSlot - Get the slot number for a value that is local to a function.
869 int SlotTracker::getLocalSlot(const Value *V) {
870 assert(!isa<Constant>(V) && "Can't get a constant or global slot with this!");
872 // Check for uninitialized state and do lazy initialization.
875 ValueMap::iterator FI = fMap.find(V);
876 return FI == fMap.end() ? -1 : (int)FI->second;
879 int SlotTracker::getAttributeGroupSlot(AttributeSet AS) {
880 // Check for uninitialized state and do lazy initialization.
883 // Find the AttributeSet in the module map.
884 as_iterator AI = asMap.find(AS);
885 return AI == asMap.end() ? -1 : (int)AI->second;
888 /// CreateModuleSlot - Insert the specified GlobalValue* into the slot table.
889 void SlotTracker::CreateModuleSlot(const GlobalValue *V) {
890 assert(V && "Can't insert a null Value into SlotTracker!");
891 assert(!V->getType()->isVoidTy() && "Doesn't need a slot!");
892 assert(!V->hasName() && "Doesn't need a slot!");
894 unsigned DestSlot = mNext++;
897 ST_DEBUG(" Inserting value [" << V->getType() << "] = " << V << " slot=" <<
899 // G = Global, F = Function, A = Alias, o = other
900 ST_DEBUG((isa<GlobalVariable>(V) ? 'G' :
901 (isa<Function>(V) ? 'F' :
902 (isa<GlobalAlias>(V) ? 'A' : 'o'))) << "]\n");
905 /// CreateSlot - Create a new slot for the specified value if it has no name.
906 void SlotTracker::CreateFunctionSlot(const Value *V) {
907 assert(!V->getType()->isVoidTy() && !V->hasName() && "Doesn't need a slot!");
909 unsigned DestSlot = fNext++;
912 // G = Global, F = Function, o = other
913 ST_DEBUG(" Inserting value [" << V->getType() << "] = " << V << " slot=" <<
914 DestSlot << " [o]\n");
917 /// CreateModuleSlot - Insert the specified MDNode* into the slot table.
918 void SlotTracker::CreateMetadataSlot(const MDNode *N) {
919 assert(N && "Can't insert a null Value into SlotTracker!");
921 unsigned DestSlot = mdnNext;
922 if (!mdnMap.insert(std::make_pair(N, DestSlot)).second)
926 // Recursively add any MDNodes referenced by operands.
927 for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i)
928 if (const MDNode *Op = dyn_cast_or_null<MDNode>(N->getOperand(i)))
929 CreateMetadataSlot(Op);
932 void SlotTracker::CreateAttributeSetSlot(AttributeSet AS) {
933 assert(AS.hasAttributes(AttributeSet::FunctionIndex) &&
934 "Doesn't need a slot!");
936 as_iterator I = asMap.find(AS);
937 if (I != asMap.end())
940 unsigned DestSlot = asNext++;
941 asMap[AS] = DestSlot;
944 //===----------------------------------------------------------------------===//
945 // AsmWriter Implementation
946 //===----------------------------------------------------------------------===//
948 static void WriteAsOperandInternal(raw_ostream &Out, const Value *V,
949 TypePrinting *TypePrinter,
950 SlotTracker *Machine,
951 const Module *Context);
953 static void WriteAsOperandInternal(raw_ostream &Out, const Metadata *MD,
954 TypePrinting *TypePrinter,
955 SlotTracker *Machine, const Module *Context,
956 bool FromValue = false);
958 static const char *getPredicateText(unsigned predicate) {
959 const char * pred = "unknown";
961 case FCmpInst::FCMP_FALSE: pred = "false"; break;
962 case FCmpInst::FCMP_OEQ: pred = "oeq"; break;
963 case FCmpInst::FCMP_OGT: pred = "ogt"; break;
964 case FCmpInst::FCMP_OGE: pred = "oge"; break;
965 case FCmpInst::FCMP_OLT: pred = "olt"; break;
966 case FCmpInst::FCMP_OLE: pred = "ole"; break;
967 case FCmpInst::FCMP_ONE: pred = "one"; break;
968 case FCmpInst::FCMP_ORD: pred = "ord"; break;
969 case FCmpInst::FCMP_UNO: pred = "uno"; break;
970 case FCmpInst::FCMP_UEQ: pred = "ueq"; break;
971 case FCmpInst::FCMP_UGT: pred = "ugt"; break;
972 case FCmpInst::FCMP_UGE: pred = "uge"; break;
973 case FCmpInst::FCMP_ULT: pred = "ult"; break;
974 case FCmpInst::FCMP_ULE: pred = "ule"; break;
975 case FCmpInst::FCMP_UNE: pred = "une"; break;
976 case FCmpInst::FCMP_TRUE: pred = "true"; break;
977 case ICmpInst::ICMP_EQ: pred = "eq"; break;
978 case ICmpInst::ICMP_NE: pred = "ne"; break;
979 case ICmpInst::ICMP_SGT: pred = "sgt"; break;
980 case ICmpInst::ICMP_SGE: pred = "sge"; break;
981 case ICmpInst::ICMP_SLT: pred = "slt"; break;
982 case ICmpInst::ICMP_SLE: pred = "sle"; break;
983 case ICmpInst::ICMP_UGT: pred = "ugt"; break;
984 case ICmpInst::ICMP_UGE: pred = "uge"; break;
985 case ICmpInst::ICMP_ULT: pred = "ult"; break;
986 case ICmpInst::ICMP_ULE: pred = "ule"; break;
991 static void writeAtomicRMWOperation(raw_ostream &Out,
992 AtomicRMWInst::BinOp Op) {
994 default: Out << " <unknown operation " << Op << ">"; break;
995 case AtomicRMWInst::Xchg: Out << " xchg"; break;
996 case AtomicRMWInst::Add: Out << " add"; break;
997 case AtomicRMWInst::Sub: Out << " sub"; break;
998 case AtomicRMWInst::And: Out << " and"; break;
999 case AtomicRMWInst::Nand: Out << " nand"; break;
1000 case AtomicRMWInst::Or: Out << " or"; break;
1001 case AtomicRMWInst::Xor: Out << " xor"; break;
1002 case AtomicRMWInst::Max: Out << " max"; break;
1003 case AtomicRMWInst::Min: Out << " min"; break;
1004 case AtomicRMWInst::UMax: Out << " umax"; break;
1005 case AtomicRMWInst::UMin: Out << " umin"; break;
1009 static void WriteOptimizationInfo(raw_ostream &Out, const User *U) {
1010 if (const FPMathOperator *FPO = dyn_cast<const FPMathOperator>(U)) {
1011 // Unsafe algebra implies all the others, no need to write them all out
1012 if (FPO->hasUnsafeAlgebra())
1015 if (FPO->hasNoNaNs())
1017 if (FPO->hasNoInfs())
1019 if (FPO->hasNoSignedZeros())
1021 if (FPO->hasAllowReciprocal())
1026 if (const OverflowingBinaryOperator *OBO =
1027 dyn_cast<OverflowingBinaryOperator>(U)) {
1028 if (OBO->hasNoUnsignedWrap())
1030 if (OBO->hasNoSignedWrap())
1032 } else if (const PossiblyExactOperator *Div =
1033 dyn_cast<PossiblyExactOperator>(U)) {
1036 } else if (const GEPOperator *GEP = dyn_cast<GEPOperator>(U)) {
1037 if (GEP->isInBounds())
1042 static void WriteConstantInternal(raw_ostream &Out, const Constant *CV,
1043 TypePrinting &TypePrinter,
1044 SlotTracker *Machine,
1045 const Module *Context) {
1046 if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV)) {
1047 if (CI->getType()->isIntegerTy(1)) {
1048 Out << (CI->getZExtValue() ? "true" : "false");
1051 Out << CI->getValue();
1055 if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV)) {
1056 if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEsingle ||
1057 &CFP->getValueAPF().getSemantics() == &APFloat::IEEEdouble) {
1058 // We would like to output the FP constant value in exponential notation,
1059 // but we cannot do this if doing so will lose precision. Check here to
1060 // make sure that we only output it in exponential format if we can parse
1061 // the value back and get the same value.
1064 bool isHalf = &CFP->getValueAPF().getSemantics()==&APFloat::IEEEhalf;
1065 bool isDouble = &CFP->getValueAPF().getSemantics()==&APFloat::IEEEdouble;
1066 bool isInf = CFP->getValueAPF().isInfinity();
1067 bool isNaN = CFP->getValueAPF().isNaN();
1068 if (!isHalf && !isInf && !isNaN) {
1069 double Val = isDouble ? CFP->getValueAPF().convertToDouble() :
1070 CFP->getValueAPF().convertToFloat();
1071 SmallString<128> StrVal;
1072 raw_svector_ostream(StrVal) << Val;
1074 // Check to make sure that the stringized number is not some string like
1075 // "Inf" or NaN, that atof will accept, but the lexer will not. Check
1076 // that the string matches the "[-+]?[0-9]" regex.
1078 if ((StrVal[0] >= '0' && StrVal[0] <= '9') ||
1079 ((StrVal[0] == '-' || StrVal[0] == '+') &&
1080 (StrVal[1] >= '0' && StrVal[1] <= '9'))) {
1081 // Reparse stringized version!
1082 if (APFloat(APFloat::IEEEdouble, StrVal).convertToDouble() == Val) {
1088 // Otherwise we could not reparse it to exactly the same value, so we must
1089 // output the string in hexadecimal format! Note that loading and storing
1090 // floating point types changes the bits of NaNs on some hosts, notably
1091 // x86, so we must not use these types.
1092 static_assert(sizeof(double) == sizeof(uint64_t),
1093 "assuming that double is 64 bits!");
1095 APFloat apf = CFP->getValueAPF();
1096 // Halves and floats are represented in ASCII IR as double, convert.
1098 apf.convert(APFloat::IEEEdouble, APFloat::rmNearestTiesToEven,
1101 utohex_buffer(uint64_t(apf.bitcastToAPInt().getZExtValue()),
1106 // Either half, or some form of long double.
1107 // These appear as a magic letter identifying the type, then a
1108 // fixed number of hex digits.
1110 // Bit position, in the current word, of the next nibble to print.
1113 if (&CFP->getValueAPF().getSemantics() == &APFloat::x87DoubleExtended) {
1115 // api needed to prevent premature destruction
1116 APInt api = CFP->getValueAPF().bitcastToAPInt();
1117 const uint64_t* p = api.getRawData();
1118 uint64_t word = p[1];
1120 int width = api.getBitWidth();
1121 for (int j=0; j<width; j+=4, shiftcount-=4) {
1122 unsigned int nibble = (word>>shiftcount) & 15;
1124 Out << (unsigned char)(nibble + '0');
1126 Out << (unsigned char)(nibble - 10 + 'A');
1127 if (shiftcount == 0 && j+4 < width) {
1131 shiftcount = width-j-4;
1135 } else if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEquad) {
1138 } else if (&CFP->getValueAPF().getSemantics() == &APFloat::PPCDoubleDouble) {
1141 } else if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEhalf) {
1145 llvm_unreachable("Unsupported floating point type");
1146 // api needed to prevent premature destruction
1147 APInt api = CFP->getValueAPF().bitcastToAPInt();
1148 const uint64_t* p = api.getRawData();
1150 int width = api.getBitWidth();
1151 for (int j=0; j<width; j+=4, shiftcount-=4) {
1152 unsigned int nibble = (word>>shiftcount) & 15;
1154 Out << (unsigned char)(nibble + '0');
1156 Out << (unsigned char)(nibble - 10 + 'A');
1157 if (shiftcount == 0 && j+4 < width) {
1161 shiftcount = width-j-4;
1167 if (isa<ConstantAggregateZero>(CV)) {
1168 Out << "zeroinitializer";
1172 if (const BlockAddress *BA = dyn_cast<BlockAddress>(CV)) {
1173 Out << "blockaddress(";
1174 WriteAsOperandInternal(Out, BA->getFunction(), &TypePrinter, Machine,
1177 WriteAsOperandInternal(Out, BA->getBasicBlock(), &TypePrinter, Machine,
1183 if (const ConstantArray *CA = dyn_cast<ConstantArray>(CV)) {
1184 Type *ETy = CA->getType()->getElementType();
1186 TypePrinter.print(ETy, Out);
1188 WriteAsOperandInternal(Out, CA->getOperand(0),
1189 &TypePrinter, Machine,
1191 for (unsigned i = 1, e = CA->getNumOperands(); i != e; ++i) {
1193 TypePrinter.print(ETy, Out);
1195 WriteAsOperandInternal(Out, CA->getOperand(i), &TypePrinter, Machine,
1202 if (const ConstantDataArray *CA = dyn_cast<ConstantDataArray>(CV)) {
1203 // As a special case, print the array as a string if it is an array of
1204 // i8 with ConstantInt values.
1205 if (CA->isString()) {
1207 PrintEscapedString(CA->getAsString(), Out);
1212 Type *ETy = CA->getType()->getElementType();
1214 TypePrinter.print(ETy, Out);
1216 WriteAsOperandInternal(Out, CA->getElementAsConstant(0),
1217 &TypePrinter, Machine,
1219 for (unsigned i = 1, e = CA->getNumElements(); i != e; ++i) {
1221 TypePrinter.print(ETy, Out);
1223 WriteAsOperandInternal(Out, CA->getElementAsConstant(i), &TypePrinter,
1231 if (const ConstantStruct *CS = dyn_cast<ConstantStruct>(CV)) {
1232 if (CS->getType()->isPacked())
1235 unsigned N = CS->getNumOperands();
1238 TypePrinter.print(CS->getOperand(0)->getType(), Out);
1241 WriteAsOperandInternal(Out, CS->getOperand(0), &TypePrinter, Machine,
1244 for (unsigned i = 1; i < N; i++) {
1246 TypePrinter.print(CS->getOperand(i)->getType(), Out);
1249 WriteAsOperandInternal(Out, CS->getOperand(i), &TypePrinter, Machine,
1256 if (CS->getType()->isPacked())
1261 if (isa<ConstantVector>(CV) || isa<ConstantDataVector>(CV)) {
1262 Type *ETy = CV->getType()->getVectorElementType();
1264 TypePrinter.print(ETy, Out);
1266 WriteAsOperandInternal(Out, CV->getAggregateElement(0U), &TypePrinter,
1268 for (unsigned i = 1, e = CV->getType()->getVectorNumElements(); i != e;++i){
1270 TypePrinter.print(ETy, Out);
1272 WriteAsOperandInternal(Out, CV->getAggregateElement(i), &TypePrinter,
1279 if (isa<ConstantPointerNull>(CV)) {
1284 if (isa<UndefValue>(CV)) {
1289 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV)) {
1290 Out << CE->getOpcodeName();
1291 WriteOptimizationInfo(Out, CE);
1292 if (CE->isCompare())
1293 Out << ' ' << getPredicateText(CE->getPredicate());
1296 if (const GEPOperator *GEP = dyn_cast<GEPOperator>(CE)) {
1298 cast<PointerType>(GEP->getPointerOperandType()->getScalarType())
1304 for (User::const_op_iterator OI=CE->op_begin(); OI != CE->op_end(); ++OI) {
1305 TypePrinter.print((*OI)->getType(), Out);
1307 WriteAsOperandInternal(Out, *OI, &TypePrinter, Machine, Context);
1308 if (OI+1 != CE->op_end())
1312 if (CE->hasIndices()) {
1313 ArrayRef<unsigned> Indices = CE->getIndices();
1314 for (unsigned i = 0, e = Indices.size(); i != e; ++i)
1315 Out << ", " << Indices[i];
1320 TypePrinter.print(CE->getType(), Out);
1327 Out << "<placeholder or erroneous Constant>";
1330 static void writeMDTuple(raw_ostream &Out, const MDTuple *Node,
1331 TypePrinting *TypePrinter, SlotTracker *Machine,
1332 const Module *Context) {
1334 for (unsigned mi = 0, me = Node->getNumOperands(); mi != me; ++mi) {
1335 const Metadata *MD = Node->getOperand(mi);
1338 else if (auto *MDV = dyn_cast<ValueAsMetadata>(MD)) {
1339 Value *V = MDV->getValue();
1340 TypePrinter->print(V->getType(), Out);
1342 WriteAsOperandInternal(Out, V, TypePrinter, Machine, Context);
1344 WriteAsOperandInternal(Out, MD, TypePrinter, Machine, Context);
1354 struct FieldSeparator {
1357 FieldSeparator(const char *Sep = ", ") : Skip(true), Sep(Sep) {}
1359 raw_ostream &operator<<(raw_ostream &OS, FieldSeparator &FS) {
1364 return OS << FS.Sep;
1366 struct MDFieldPrinter {
1369 TypePrinting *TypePrinter;
1370 SlotTracker *Machine;
1371 const Module *Context;
1373 explicit MDFieldPrinter(raw_ostream &Out)
1374 : Out(Out), TypePrinter(nullptr), Machine(nullptr), Context(nullptr) {}
1375 MDFieldPrinter(raw_ostream &Out, TypePrinting *TypePrinter,
1376 SlotTracker *Machine, const Module *Context)
1377 : Out(Out), TypePrinter(TypePrinter), Machine(Machine), Context(Context) {
1379 void printTag(const DINode *N);
1380 void printString(StringRef Name, StringRef Value,
1381 bool ShouldSkipEmpty = true);
1382 void printMetadata(StringRef Name, const Metadata *MD,
1383 bool ShouldSkipNull = true);
1384 template <class IntTy>
1385 void printInt(StringRef Name, IntTy Int, bool ShouldSkipZero = true);
1386 void printBool(StringRef Name, bool Value);
1387 void printDIFlags(StringRef Name, unsigned Flags);
1388 template <class IntTy, class Stringifier>
1389 void printDwarfEnum(StringRef Name, IntTy Value, Stringifier toString,
1390 bool ShouldSkipZero = true);
1394 void MDFieldPrinter::printTag(const DINode *N) {
1395 Out << FS << "tag: ";
1396 if (const char *Tag = dwarf::TagString(N->getTag()))
1402 void MDFieldPrinter::printString(StringRef Name, StringRef Value,
1403 bool ShouldSkipEmpty) {
1404 if (ShouldSkipEmpty && Value.empty())
1407 Out << FS << Name << ": \"";
1408 PrintEscapedString(Value, Out);
1412 static void writeMetadataAsOperand(raw_ostream &Out, const Metadata *MD,
1413 TypePrinting *TypePrinter,
1414 SlotTracker *Machine,
1415 const Module *Context) {
1420 WriteAsOperandInternal(Out, MD, TypePrinter, Machine, Context);
1423 void MDFieldPrinter::printMetadata(StringRef Name, const Metadata *MD,
1424 bool ShouldSkipNull) {
1425 if (ShouldSkipNull && !MD)
1428 Out << FS << Name << ": ";
1429 writeMetadataAsOperand(Out, MD, TypePrinter, Machine, Context);
1432 template <class IntTy>
1433 void MDFieldPrinter::printInt(StringRef Name, IntTy Int, bool ShouldSkipZero) {
1434 if (ShouldSkipZero && !Int)
1437 Out << FS << Name << ": " << Int;
1440 void MDFieldPrinter::printBool(StringRef Name, bool Value) {
1441 Out << FS << Name << ": " << (Value ? "true" : "false");
1444 void MDFieldPrinter::printDIFlags(StringRef Name, unsigned Flags) {
1448 Out << FS << Name << ": ";
1450 SmallVector<unsigned, 8> SplitFlags;
1451 unsigned Extra = DINode::splitFlags(Flags, SplitFlags);
1453 FieldSeparator FlagsFS(" | ");
1454 for (unsigned F : SplitFlags) {
1455 const char *StringF = DINode::getFlagString(F);
1456 assert(StringF && "Expected valid flag");
1457 Out << FlagsFS << StringF;
1459 if (Extra || SplitFlags.empty())
1460 Out << FlagsFS << Extra;
1463 template <class IntTy, class Stringifier>
1464 void MDFieldPrinter::printDwarfEnum(StringRef Name, IntTy Value,
1465 Stringifier toString, bool ShouldSkipZero) {
1469 Out << FS << Name << ": ";
1470 if (const char *S = toString(Value))
1476 static void writeGenericDINode(raw_ostream &Out, const GenericDINode *N,
1477 TypePrinting *TypePrinter, SlotTracker *Machine,
1478 const Module *Context) {
1479 Out << "!GenericDINode(";
1480 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1481 Printer.printTag(N);
1482 Printer.printString("header", N->getHeader());
1483 if (N->getNumDwarfOperands()) {
1484 Out << Printer.FS << "operands: {";
1486 for (auto &I : N->dwarf_operands()) {
1488 writeMetadataAsOperand(Out, I, TypePrinter, Machine, Context);
1495 static void writeDILocation(raw_ostream &Out, const DILocation *DL,
1496 TypePrinting *TypePrinter, SlotTracker *Machine,
1497 const Module *Context) {
1498 Out << "!DILocation(";
1499 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1500 // Always output the line, since 0 is a relevant and important value for it.
1501 Printer.printInt("line", DL->getLine(), /* ShouldSkipZero */ false);
1502 Printer.printInt("column", DL->getColumn());
1503 Printer.printMetadata("scope", DL->getRawScope(), /* ShouldSkipNull */ false);
1504 Printer.printMetadata("inlinedAt", DL->getRawInlinedAt());
1508 static void writeDISubrange(raw_ostream &Out, const DISubrange *N,
1509 TypePrinting *, SlotTracker *, const Module *) {
1510 Out << "!DISubrange(";
1511 MDFieldPrinter Printer(Out);
1512 Printer.printInt("count", N->getCount(), /* ShouldSkipZero */ false);
1513 Printer.printInt("lowerBound", N->getLowerBound());
1517 static void writeDIEnumerator(raw_ostream &Out, const DIEnumerator *N,
1518 TypePrinting *, SlotTracker *, const Module *) {
1519 Out << "!DIEnumerator(";
1520 MDFieldPrinter Printer(Out);
1521 Printer.printString("name", N->getName(), /* ShouldSkipEmpty */ false);
1522 Printer.printInt("value", N->getValue(), /* ShouldSkipZero */ false);
1526 static void writeDIBasicType(raw_ostream &Out, const DIBasicType *N,
1527 TypePrinting *, SlotTracker *, const Module *) {
1528 Out << "!DIBasicType(";
1529 MDFieldPrinter Printer(Out);
1530 if (N->getTag() != dwarf::DW_TAG_base_type)
1531 Printer.printTag(N);
1532 Printer.printString("name", N->getName());
1533 Printer.printInt("size", N->getSizeInBits());
1534 Printer.printInt("align", N->getAlignInBits());
1535 Printer.printDwarfEnum("encoding", N->getEncoding(),
1536 dwarf::AttributeEncodingString);
1540 static void writeDIDerivedType(raw_ostream &Out, const DIDerivedType *N,
1541 TypePrinting *TypePrinter, SlotTracker *Machine,
1542 const Module *Context) {
1543 Out << "!DIDerivedType(";
1544 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1545 Printer.printTag(N);
1546 Printer.printString("name", N->getName());
1547 Printer.printMetadata("scope", N->getRawScope());
1548 Printer.printMetadata("file", N->getRawFile());
1549 Printer.printInt("line", N->getLine());
1550 Printer.printMetadata("baseType", N->getRawBaseType(),
1551 /* ShouldSkipNull */ false);
1552 Printer.printInt("size", N->getSizeInBits());
1553 Printer.printInt("align", N->getAlignInBits());
1554 Printer.printInt("offset", N->getOffsetInBits());
1555 Printer.printDIFlags("flags", N->getFlags());
1556 Printer.printMetadata("extraData", N->getRawExtraData());
1560 static void writeDICompositeType(raw_ostream &Out, const DICompositeType *N,
1561 TypePrinting *TypePrinter,
1562 SlotTracker *Machine, const Module *Context) {
1563 Out << "!DICompositeType(";
1564 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1565 Printer.printTag(N);
1566 Printer.printString("name", N->getName());
1567 Printer.printMetadata("scope", N->getRawScope());
1568 Printer.printMetadata("file", N->getRawFile());
1569 Printer.printInt("line", N->getLine());
1570 Printer.printMetadata("baseType", N->getRawBaseType());
1571 Printer.printInt("size", N->getSizeInBits());
1572 Printer.printInt("align", N->getAlignInBits());
1573 Printer.printInt("offset", N->getOffsetInBits());
1574 Printer.printDIFlags("flags", N->getFlags());
1575 Printer.printMetadata("elements", N->getRawElements());
1576 Printer.printDwarfEnum("runtimeLang", N->getRuntimeLang(),
1577 dwarf::LanguageString);
1578 Printer.printMetadata("vtableHolder", N->getRawVTableHolder());
1579 Printer.printMetadata("templateParams", N->getRawTemplateParams());
1580 Printer.printString("identifier", N->getIdentifier());
1584 static void writeDISubroutineType(raw_ostream &Out, const DISubroutineType *N,
1585 TypePrinting *TypePrinter,
1586 SlotTracker *Machine, const Module *Context) {
1587 Out << "!DISubroutineType(";
1588 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1589 Printer.printDIFlags("flags", N->getFlags());
1590 Printer.printMetadata("types", N->getRawTypeArray(),
1591 /* ShouldSkipNull */ false);
1595 static void writeDIFile(raw_ostream &Out, const DIFile *N, TypePrinting *,
1596 SlotTracker *, const Module *) {
1598 MDFieldPrinter Printer(Out);
1599 Printer.printString("filename", N->getFilename(),
1600 /* ShouldSkipEmpty */ false);
1601 Printer.printString("directory", N->getDirectory(),
1602 /* ShouldSkipEmpty */ false);
1606 static void writeDICompileUnit(raw_ostream &Out, const DICompileUnit *N,
1607 TypePrinting *TypePrinter, SlotTracker *Machine,
1608 const Module *Context) {
1609 Out << "!DICompileUnit(";
1610 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1611 Printer.printDwarfEnum("language", N->getSourceLanguage(),
1612 dwarf::LanguageString, /* ShouldSkipZero */ false);
1613 Printer.printMetadata("file", N->getRawFile(), /* ShouldSkipNull */ false);
1614 Printer.printString("producer", N->getProducer());
1615 Printer.printBool("isOptimized", N->isOptimized());
1616 Printer.printString("flags", N->getFlags());
1617 Printer.printInt("runtimeVersion", N->getRuntimeVersion(),
1618 /* ShouldSkipZero */ false);
1619 Printer.printString("splitDebugFilename", N->getSplitDebugFilename());
1620 Printer.printInt("emissionKind", N->getEmissionKind(),
1621 /* ShouldSkipZero */ false);
1622 Printer.printMetadata("enums", N->getRawEnumTypes());
1623 Printer.printMetadata("retainedTypes", N->getRawRetainedTypes());
1624 Printer.printMetadata("subprograms", N->getRawSubprograms());
1625 Printer.printMetadata("globals", N->getRawGlobalVariables());
1626 Printer.printMetadata("imports", N->getRawImportedEntities());
1630 static void writeDISubprogram(raw_ostream &Out, const DISubprogram *N,
1631 TypePrinting *TypePrinter, SlotTracker *Machine,
1632 const Module *Context) {
1633 Out << "!DISubprogram(";
1634 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1635 Printer.printString("name", N->getName());
1636 Printer.printString("linkageName", N->getLinkageName());
1637 Printer.printMetadata("scope", N->getRawScope(), /* ShouldSkipNull */ false);
1638 Printer.printMetadata("file", N->getRawFile());
1639 Printer.printInt("line", N->getLine());
1640 Printer.printMetadata("type", N->getRawType());
1641 Printer.printBool("isLocal", N->isLocalToUnit());
1642 Printer.printBool("isDefinition", N->isDefinition());
1643 Printer.printInt("scopeLine", N->getScopeLine());
1644 Printer.printMetadata("containingType", N->getRawContainingType());
1645 Printer.printDwarfEnum("virtuality", N->getVirtuality(),
1646 dwarf::VirtualityString);
1647 Printer.printInt("virtualIndex", N->getVirtualIndex());
1648 Printer.printDIFlags("flags", N->getFlags());
1649 Printer.printBool("isOptimized", N->isOptimized());
1650 Printer.printMetadata("function", N->getRawFunction());
1651 Printer.printMetadata("templateParams", N->getRawTemplateParams());
1652 Printer.printMetadata("declaration", N->getRawDeclaration());
1653 Printer.printMetadata("variables", N->getRawVariables());
1657 static void writeDILexicalBlock(raw_ostream &Out, const DILexicalBlock *N,
1658 TypePrinting *TypePrinter, SlotTracker *Machine,
1659 const Module *Context) {
1660 Out << "!DILexicalBlock(";
1661 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1662 Printer.printMetadata("scope", N->getRawScope(), /* ShouldSkipNull */ false);
1663 Printer.printMetadata("file", N->getRawFile());
1664 Printer.printInt("line", N->getLine());
1665 Printer.printInt("column", N->getColumn());
1669 static void writeDILexicalBlockFile(raw_ostream &Out,
1670 const DILexicalBlockFile *N,
1671 TypePrinting *TypePrinter,
1672 SlotTracker *Machine,
1673 const Module *Context) {
1674 Out << "!DILexicalBlockFile(";
1675 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1676 Printer.printMetadata("scope", N->getRawScope(), /* ShouldSkipNull */ false);
1677 Printer.printMetadata("file", N->getRawFile());
1678 Printer.printInt("discriminator", N->getDiscriminator(),
1679 /* ShouldSkipZero */ false);
1683 static void writeDINamespace(raw_ostream &Out, const DINamespace *N,
1684 TypePrinting *TypePrinter, SlotTracker *Machine,
1685 const Module *Context) {
1686 Out << "!DINamespace(";
1687 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1688 Printer.printString("name", N->getName());
1689 Printer.printMetadata("scope", N->getRawScope(), /* ShouldSkipNull */ false);
1690 Printer.printMetadata("file", N->getRawFile());
1691 Printer.printInt("line", N->getLine());
1695 static void writeDITemplateTypeParameter(raw_ostream &Out,
1696 const DITemplateTypeParameter *N,
1697 TypePrinting *TypePrinter,
1698 SlotTracker *Machine,
1699 const Module *Context) {
1700 Out << "!DITemplateTypeParameter(";
1701 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1702 Printer.printString("name", N->getName());
1703 Printer.printMetadata("type", N->getRawType(), /* ShouldSkipNull */ false);
1707 static void writeDITemplateValueParameter(raw_ostream &Out,
1708 const DITemplateValueParameter *N,
1709 TypePrinting *TypePrinter,
1710 SlotTracker *Machine,
1711 const Module *Context) {
1712 Out << "!DITemplateValueParameter(";
1713 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1714 if (N->getTag() != dwarf::DW_TAG_template_value_parameter)
1715 Printer.printTag(N);
1716 Printer.printString("name", N->getName());
1717 Printer.printMetadata("type", N->getRawType());
1718 Printer.printMetadata("value", N->getValue(), /* ShouldSkipNull */ false);
1722 static void writeDIGlobalVariable(raw_ostream &Out, const DIGlobalVariable *N,
1723 TypePrinting *TypePrinter,
1724 SlotTracker *Machine, const Module *Context) {
1725 Out << "!DIGlobalVariable(";
1726 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1727 Printer.printString("name", N->getName());
1728 Printer.printString("linkageName", N->getLinkageName());
1729 Printer.printMetadata("scope", N->getRawScope(), /* ShouldSkipNull */ false);
1730 Printer.printMetadata("file", N->getRawFile());
1731 Printer.printInt("line", N->getLine());
1732 Printer.printMetadata("type", N->getRawType());
1733 Printer.printBool("isLocal", N->isLocalToUnit());
1734 Printer.printBool("isDefinition", N->isDefinition());
1735 Printer.printMetadata("variable", N->getRawVariable());
1736 Printer.printMetadata("declaration", N->getRawStaticDataMemberDeclaration());
1740 static void writeDILocalVariable(raw_ostream &Out, const DILocalVariable *N,
1741 TypePrinting *TypePrinter,
1742 SlotTracker *Machine, const Module *Context) {
1743 Out << "!DILocalVariable(";
1744 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1745 Printer.printTag(N);
1746 Printer.printString("name", N->getName());
1747 Printer.printInt("arg", N->getArg(),
1748 /* ShouldSkipZero */
1749 N->getTag() == dwarf::DW_TAG_auto_variable);
1750 Printer.printMetadata("scope", N->getRawScope(), /* ShouldSkipNull */ false);
1751 Printer.printMetadata("file", N->getRawFile());
1752 Printer.printInt("line", N->getLine());
1753 Printer.printMetadata("type", N->getRawType());
1754 Printer.printDIFlags("flags", N->getFlags());
1758 static void writeDIExpression(raw_ostream &Out, const DIExpression *N,
1759 TypePrinting *TypePrinter, SlotTracker *Machine,
1760 const Module *Context) {
1761 Out << "!DIExpression(";
1764 for (auto I = N->expr_op_begin(), E = N->expr_op_end(); I != E; ++I) {
1765 const char *OpStr = dwarf::OperationEncodingString(I->getOp());
1766 assert(OpStr && "Expected valid opcode");
1769 for (unsigned A = 0, AE = I->getNumArgs(); A != AE; ++A)
1770 Out << FS << I->getArg(A);
1773 for (const auto &I : N->getElements())
1779 static void writeDIObjCProperty(raw_ostream &Out, const DIObjCProperty *N,
1780 TypePrinting *TypePrinter, SlotTracker *Machine,
1781 const Module *Context) {
1782 Out << "!DIObjCProperty(";
1783 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1784 Printer.printString("name", N->getName());
1785 Printer.printMetadata("file", N->getRawFile());
1786 Printer.printInt("line", N->getLine());
1787 Printer.printString("setter", N->getSetterName());
1788 Printer.printString("getter", N->getGetterName());
1789 Printer.printInt("attributes", N->getAttributes());
1790 Printer.printMetadata("type", N->getRawType());
1794 static void writeDIImportedEntity(raw_ostream &Out, const DIImportedEntity *N,
1795 TypePrinting *TypePrinter,
1796 SlotTracker *Machine, const Module *Context) {
1797 Out << "!DIImportedEntity(";
1798 MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1799 Printer.printTag(N);
1800 Printer.printString("name", N->getName());
1801 Printer.printMetadata("scope", N->getRawScope(), /* ShouldSkipNull */ false);
1802 Printer.printMetadata("entity", N->getRawEntity());
1803 Printer.printInt("line", N->getLine());
1808 static void WriteMDNodeBodyInternal(raw_ostream &Out, const MDNode *Node,
1809 TypePrinting *TypePrinter,
1810 SlotTracker *Machine,
1811 const Module *Context) {
1812 if (Node->isDistinct())
1814 else if (Node->isTemporary())
1815 Out << "<temporary!> "; // Handle broken code.
1817 switch (Node->getMetadataID()) {
1819 llvm_unreachable("Expected uniquable MDNode");
1820 #define HANDLE_MDNODE_LEAF(CLASS) \
1821 case Metadata::CLASS##Kind: \
1822 write##CLASS(Out, cast<CLASS>(Node), TypePrinter, Machine, Context); \
1824 #include "llvm/IR/Metadata.def"
1828 // Full implementation of printing a Value as an operand with support for
1829 // TypePrinting, etc.
1830 static void WriteAsOperandInternal(raw_ostream &Out, const Value *V,
1831 TypePrinting *TypePrinter,
1832 SlotTracker *Machine,
1833 const Module *Context) {
1835 PrintLLVMName(Out, V);
1839 const Constant *CV = dyn_cast<Constant>(V);
1840 if (CV && !isa<GlobalValue>(CV)) {
1841 assert(TypePrinter && "Constants require TypePrinting!");
1842 WriteConstantInternal(Out, CV, *TypePrinter, Machine, Context);
1846 if (const InlineAsm *IA = dyn_cast<InlineAsm>(V)) {
1848 if (IA->hasSideEffects())
1849 Out << "sideeffect ";
1850 if (IA->isAlignStack())
1851 Out << "alignstack ";
1852 // We don't emit the AD_ATT dialect as it's the assumed default.
1853 if (IA->getDialect() == InlineAsm::AD_Intel)
1854 Out << "inteldialect ";
1856 PrintEscapedString(IA->getAsmString(), Out);
1858 PrintEscapedString(IA->getConstraintString(), Out);
1863 if (auto *MD = dyn_cast<MetadataAsValue>(V)) {
1864 WriteAsOperandInternal(Out, MD->getMetadata(), TypePrinter, Machine,
1865 Context, /* FromValue */ true);
1871 // If we have a SlotTracker, use it.
1873 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
1874 Slot = Machine->getGlobalSlot(GV);
1877 Slot = Machine->getLocalSlot(V);
1879 // If the local value didn't succeed, then we may be referring to a value
1880 // from a different function. Translate it, as this can happen when using
1881 // address of blocks.
1883 if ((Machine = createSlotTracker(V))) {
1884 Slot = Machine->getLocalSlot(V);
1888 } else if ((Machine = createSlotTracker(V))) {
1889 // Otherwise, create one to get the # and then destroy it.
1890 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
1891 Slot = Machine->getGlobalSlot(GV);
1894 Slot = Machine->getLocalSlot(V);
1903 Out << Prefix << Slot;
1908 static void WriteAsOperandInternal(raw_ostream &Out, const Metadata *MD,
1909 TypePrinting *TypePrinter,
1910 SlotTracker *Machine, const Module *Context,
1912 if (const MDNode *N = dyn_cast<MDNode>(MD)) {
1914 Machine = new SlotTracker(Context);
1915 int Slot = Machine->getMetadataSlot(N);
1917 // Give the pointer value instead of "badref", since this comes up all
1918 // the time when debugging.
1919 Out << "<" << N << ">";
1925 if (const MDString *MDS = dyn_cast<MDString>(MD)) {
1927 PrintEscapedString(MDS->getString(), Out);
1932 auto *V = cast<ValueAsMetadata>(MD);
1933 assert(TypePrinter && "TypePrinter required for metadata values");
1934 assert((FromValue || !isa<LocalAsMetadata>(V)) &&
1935 "Unexpected function-local metadata outside of value argument");
1937 TypePrinter->print(V->getValue()->getType(), Out);
1939 WriteAsOperandInternal(Out, V->getValue(), TypePrinter, Machine, Context);
1943 class AssemblyWriter {
1944 formatted_raw_ostream &Out;
1945 const Module *TheModule;
1946 std::unique_ptr<SlotTracker> ModuleSlotTracker;
1947 SlotTracker &Machine;
1948 TypePrinting TypePrinter;
1949 AssemblyAnnotationWriter *AnnotationWriter;
1950 SetVector<const Comdat *> Comdats;
1951 bool ShouldPreserveUseListOrder;
1952 UseListOrderStack UseListOrders;
1953 SmallVector<StringRef, 8> MDNames;
1956 /// Construct an AssemblyWriter with an external SlotTracker
1957 AssemblyWriter(formatted_raw_ostream &o, SlotTracker &Mac, const Module *M,
1958 AssemblyAnnotationWriter *AAW,
1959 bool ShouldPreserveUseListOrder = false);
1961 /// Construct an AssemblyWriter with an internally allocated SlotTracker
1962 AssemblyWriter(formatted_raw_ostream &o, const Module *M,
1963 AssemblyAnnotationWriter *AAW,
1964 bool ShouldPreserveUseListOrder = false);
1966 void printMDNodeBody(const MDNode *MD);
1967 void printNamedMDNode(const NamedMDNode *NMD);
1969 void printModule(const Module *M);
1971 void writeOperand(const Value *Op, bool PrintType);
1972 void writeParamOperand(const Value *Operand, AttributeSet Attrs,unsigned Idx);
1973 void writeAtomic(AtomicOrdering Ordering, SynchronizationScope SynchScope);
1974 void writeAtomicCmpXchg(AtomicOrdering SuccessOrdering,
1975 AtomicOrdering FailureOrdering,
1976 SynchronizationScope SynchScope);
1978 void writeAllMDNodes();
1979 void writeMDNode(unsigned Slot, const MDNode *Node);
1980 void writeAllAttributeGroups();
1982 void printTypeIdentities();
1983 void printGlobal(const GlobalVariable *GV);
1984 void printAlias(const GlobalAlias *GV);
1985 void printComdat(const Comdat *C);
1986 void printFunction(const Function *F);
1987 void printArgument(const Argument *FA, AttributeSet Attrs, unsigned Idx);
1988 void printBasicBlock(const BasicBlock *BB);
1989 void printInstructionLine(const Instruction &I);
1990 void printInstruction(const Instruction &I);
1992 void printUseListOrder(const UseListOrder &Order);
1993 void printUseLists(const Function *F);
1998 /// \brief Print out metadata attachments.
1999 void printMetadataAttachments(
2000 const SmallVectorImpl<std::pair<unsigned, MDNode *>> &MDs,
2001 StringRef Separator);
2003 // printInfoComment - Print a little comment after the instruction indicating
2004 // which slot it occupies.
2005 void printInfoComment(const Value &V);
2007 // printGCRelocateComment - print comment after call to the gc.relocate
2008 // intrinsic indicating base and derived pointer names.
2009 void printGCRelocateComment(const Value &V);
2013 void AssemblyWriter::init() {
2016 TypePrinter.incorporateTypes(*TheModule);
2017 for (const Function &F : *TheModule)
2018 if (const Comdat *C = F.getComdat())
2020 for (const GlobalVariable &GV : TheModule->globals())
2021 if (const Comdat *C = GV.getComdat())
2025 AssemblyWriter::AssemblyWriter(formatted_raw_ostream &o, SlotTracker &Mac,
2026 const Module *M, AssemblyAnnotationWriter *AAW,
2027 bool ShouldPreserveUseListOrder)
2028 : Out(o), TheModule(M), Machine(Mac), AnnotationWriter(AAW),
2029 ShouldPreserveUseListOrder(ShouldPreserveUseListOrder) {
2033 AssemblyWriter::AssemblyWriter(formatted_raw_ostream &o, const Module *M,
2034 AssemblyAnnotationWriter *AAW,
2035 bool ShouldPreserveUseListOrder)
2036 : Out(o), TheModule(M), ModuleSlotTracker(createSlotTracker(M)),
2037 Machine(*ModuleSlotTracker), AnnotationWriter(AAW),
2038 ShouldPreserveUseListOrder(ShouldPreserveUseListOrder) {
2042 void AssemblyWriter::writeOperand(const Value *Operand, bool PrintType) {
2044 Out << "<null operand!>";
2048 TypePrinter.print(Operand->getType(), Out);
2051 WriteAsOperandInternal(Out, Operand, &TypePrinter, &Machine, TheModule);
2054 void AssemblyWriter::writeAtomic(AtomicOrdering Ordering,
2055 SynchronizationScope SynchScope) {
2056 if (Ordering == NotAtomic)
2059 switch (SynchScope) {
2060 case SingleThread: Out << " singlethread"; break;
2061 case CrossThread: break;
2065 default: Out << " <bad ordering " << int(Ordering) << ">"; break;
2066 case Unordered: Out << " unordered"; break;
2067 case Monotonic: Out << " monotonic"; break;
2068 case Acquire: Out << " acquire"; break;
2069 case Release: Out << " release"; break;
2070 case AcquireRelease: Out << " acq_rel"; break;
2071 case SequentiallyConsistent: Out << " seq_cst"; break;
2075 void AssemblyWriter::writeAtomicCmpXchg(AtomicOrdering SuccessOrdering,
2076 AtomicOrdering FailureOrdering,
2077 SynchronizationScope SynchScope) {
2078 assert(SuccessOrdering != NotAtomic && FailureOrdering != NotAtomic);
2080 switch (SynchScope) {
2081 case SingleThread: Out << " singlethread"; break;
2082 case CrossThread: break;
2085 switch (SuccessOrdering) {
2086 default: Out << " <bad ordering " << int(SuccessOrdering) << ">"; break;
2087 case Unordered: Out << " unordered"; break;
2088 case Monotonic: Out << " monotonic"; break;
2089 case Acquire: Out << " acquire"; break;
2090 case Release: Out << " release"; break;
2091 case AcquireRelease: Out << " acq_rel"; break;
2092 case SequentiallyConsistent: Out << " seq_cst"; break;
2095 switch (FailureOrdering) {
2096 default: Out << " <bad ordering " << int(FailureOrdering) << ">"; break;
2097 case Unordered: Out << " unordered"; break;
2098 case Monotonic: Out << " monotonic"; break;
2099 case Acquire: Out << " acquire"; break;
2100 case Release: Out << " release"; break;
2101 case AcquireRelease: Out << " acq_rel"; break;
2102 case SequentiallyConsistent: Out << " seq_cst"; break;
2106 void AssemblyWriter::writeParamOperand(const Value *Operand,
2107 AttributeSet Attrs, unsigned Idx) {
2109 Out << "<null operand!>";
2114 TypePrinter.print(Operand->getType(), Out);
2115 // Print parameter attributes list
2116 if (Attrs.hasAttributes(Idx))
2117 Out << ' ' << Attrs.getAsString(Idx);
2119 // Print the operand
2120 WriteAsOperandInternal(Out, Operand, &TypePrinter, &Machine, TheModule);
2123 void AssemblyWriter::printModule(const Module *M) {
2124 Machine.initialize();
2126 if (ShouldPreserveUseListOrder)
2127 UseListOrders = predictUseListOrder(M);
2129 if (!M->getModuleIdentifier().empty() &&
2130 // Don't print the ID if it will start a new line (which would
2131 // require a comment char before it).
2132 M->getModuleIdentifier().find('\n') == std::string::npos)
2133 Out << "; ModuleID = '" << M->getModuleIdentifier() << "'\n";
2135 const std::string &DL = M->getDataLayoutStr();
2137 Out << "target datalayout = \"" << DL << "\"\n";
2138 if (!M->getTargetTriple().empty())
2139 Out << "target triple = \"" << M->getTargetTriple() << "\"\n";
2141 if (!M->getModuleInlineAsm().empty()) {
2142 // Split the string into lines, to make it easier to read the .ll file.
2143 std::string Asm = M->getModuleInlineAsm();
2145 size_t NewLine = Asm.find_first_of('\n', CurPos);
2147 while (NewLine != std::string::npos) {
2148 // We found a newline, print the portion of the asm string from the
2149 // last newline up to this newline.
2150 Out << "module asm \"";
2151 PrintEscapedString(std::string(Asm.begin()+CurPos, Asm.begin()+NewLine),
2155 NewLine = Asm.find_first_of('\n', CurPos);
2157 std::string rest(Asm.begin()+CurPos, Asm.end());
2158 if (!rest.empty()) {
2159 Out << "module asm \"";
2160 PrintEscapedString(rest, Out);
2165 printTypeIdentities();
2167 // Output all comdats.
2168 if (!Comdats.empty())
2170 for (const Comdat *C : Comdats) {
2172 if (C != Comdats.back())
2176 // Output all globals.
2177 if (!M->global_empty()) Out << '\n';
2178 for (Module::const_global_iterator I = M->global_begin(), E = M->global_end();
2180 printGlobal(I); Out << '\n';
2183 // Output all aliases.
2184 if (!M->alias_empty()) Out << "\n";
2185 for (Module::const_alias_iterator I = M->alias_begin(), E = M->alias_end();
2189 // Output global use-lists.
2190 printUseLists(nullptr);
2192 // Output all of the functions.
2193 for (Module::const_iterator I = M->begin(), E = M->end(); I != E; ++I)
2195 assert(UseListOrders.empty() && "All use-lists should have been consumed");
2197 // Output all attribute groups.
2198 if (!Machine.as_empty()) {
2200 writeAllAttributeGroups();
2203 // Output named metadata.
2204 if (!M->named_metadata_empty()) Out << '\n';
2206 for (Module::const_named_metadata_iterator I = M->named_metadata_begin(),
2207 E = M->named_metadata_end(); I != E; ++I)
2208 printNamedMDNode(I);
2211 if (!Machine.mdn_empty()) {
2217 void AssemblyWriter::printNamedMDNode(const NamedMDNode *NMD) {
2219 StringRef Name = NMD->getName();
2221 Out << "<empty name> ";
2223 if (isalpha(static_cast<unsigned char>(Name[0])) ||
2224 Name[0] == '-' || Name[0] == '$' ||
2225 Name[0] == '.' || Name[0] == '_')
2228 Out << '\\' << hexdigit(Name[0] >> 4) << hexdigit(Name[0] & 0x0F);
2229 for (unsigned i = 1, e = Name.size(); i != e; ++i) {
2230 unsigned char C = Name[i];
2231 if (isalnum(static_cast<unsigned char>(C)) || C == '-' || C == '$' ||
2232 C == '.' || C == '_')
2235 Out << '\\' << hexdigit(C >> 4) << hexdigit(C & 0x0F);
2239 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
2241 int Slot = Machine.getMetadataSlot(NMD->getOperand(i));
2251 static void PrintLinkage(GlobalValue::LinkageTypes LT,
2252 formatted_raw_ostream &Out) {
2254 case GlobalValue::ExternalLinkage: break;
2255 case GlobalValue::PrivateLinkage: Out << "private "; break;
2256 case GlobalValue::InternalLinkage: Out << "internal "; break;
2257 case GlobalValue::LinkOnceAnyLinkage: Out << "linkonce "; break;
2258 case GlobalValue::LinkOnceODRLinkage: Out << "linkonce_odr "; break;
2259 case GlobalValue::WeakAnyLinkage: Out << "weak "; break;
2260 case GlobalValue::WeakODRLinkage: Out << "weak_odr "; break;
2261 case GlobalValue::CommonLinkage: Out << "common "; break;
2262 case GlobalValue::AppendingLinkage: Out << "appending "; break;
2263 case GlobalValue::ExternalWeakLinkage: Out << "extern_weak "; break;
2264 case GlobalValue::AvailableExternallyLinkage:
2265 Out << "available_externally ";
2271 static void PrintVisibility(GlobalValue::VisibilityTypes Vis,
2272 formatted_raw_ostream &Out) {
2274 case GlobalValue::DefaultVisibility: break;
2275 case GlobalValue::HiddenVisibility: Out << "hidden "; break;
2276 case GlobalValue::ProtectedVisibility: Out << "protected "; break;
2280 static void PrintDLLStorageClass(GlobalValue::DLLStorageClassTypes SCT,
2281 formatted_raw_ostream &Out) {
2283 case GlobalValue::DefaultStorageClass: break;
2284 case GlobalValue::DLLImportStorageClass: Out << "dllimport "; break;
2285 case GlobalValue::DLLExportStorageClass: Out << "dllexport "; break;
2289 static void PrintThreadLocalModel(GlobalVariable::ThreadLocalMode TLM,
2290 formatted_raw_ostream &Out) {
2292 case GlobalVariable::NotThreadLocal:
2294 case GlobalVariable::GeneralDynamicTLSModel:
2295 Out << "thread_local ";
2297 case GlobalVariable::LocalDynamicTLSModel:
2298 Out << "thread_local(localdynamic) ";
2300 case GlobalVariable::InitialExecTLSModel:
2301 Out << "thread_local(initialexec) ";
2303 case GlobalVariable::LocalExecTLSModel:
2304 Out << "thread_local(localexec) ";
2309 static void maybePrintComdat(formatted_raw_ostream &Out,
2310 const GlobalObject &GO) {
2311 const Comdat *C = GO.getComdat();
2315 if (isa<GlobalVariable>(GO))
2319 if (GO.getName() == C->getName())
2323 PrintLLVMName(Out, C->getName(), ComdatPrefix);
2327 void AssemblyWriter::printGlobal(const GlobalVariable *GV) {
2328 if (GV->isMaterializable())
2329 Out << "; Materializable\n";
2331 WriteAsOperandInternal(Out, GV, &TypePrinter, &Machine, GV->getParent());
2334 if (!GV->hasInitializer() && GV->hasExternalLinkage())
2337 PrintLinkage(GV->getLinkage(), Out);
2338 PrintVisibility(GV->getVisibility(), Out);
2339 PrintDLLStorageClass(GV->getDLLStorageClass(), Out);
2340 PrintThreadLocalModel(GV->getThreadLocalMode(), Out);
2341 if (GV->hasUnnamedAddr())
2342 Out << "unnamed_addr ";
2344 if (unsigned AddressSpace = GV->getType()->getAddressSpace())
2345 Out << "addrspace(" << AddressSpace << ") ";
2346 if (GV->isExternallyInitialized()) Out << "externally_initialized ";
2347 Out << (GV->isConstant() ? "constant " : "global ");
2348 TypePrinter.print(GV->getType()->getElementType(), Out);
2350 if (GV->hasInitializer()) {
2352 writeOperand(GV->getInitializer(), false);
2355 if (GV->hasSection()) {
2356 Out << ", section \"";
2357 PrintEscapedString(GV->getSection(), Out);
2360 maybePrintComdat(Out, *GV);
2361 if (GV->getAlignment())
2362 Out << ", align " << GV->getAlignment();
2364 printInfoComment(*GV);
2367 void AssemblyWriter::printAlias(const GlobalAlias *GA) {
2368 if (GA->isMaterializable())
2369 Out << "; Materializable\n";
2371 // Don't crash when dumping partially built GA
2373 Out << "<<nameless>> = ";
2375 PrintLLVMName(Out, GA);
2378 PrintLinkage(GA->getLinkage(), Out);
2379 PrintVisibility(GA->getVisibility(), Out);
2380 PrintDLLStorageClass(GA->getDLLStorageClass(), Out);
2381 PrintThreadLocalModel(GA->getThreadLocalMode(), Out);
2382 if (GA->hasUnnamedAddr())
2383 Out << "unnamed_addr ";
2387 const Constant *Aliasee = GA->getAliasee();
2390 TypePrinter.print(GA->getType(), Out);
2391 Out << " <<NULL ALIASEE>>";
2393 writeOperand(Aliasee, !isa<ConstantExpr>(Aliasee));
2396 printInfoComment(*GA);
2400 void AssemblyWriter::printComdat(const Comdat *C) {
2404 void AssemblyWriter::printTypeIdentities() {
2405 if (TypePrinter.NumberedTypes.empty() &&
2406 TypePrinter.NamedTypes.empty())
2411 // We know all the numbers that each type is used and we know that it is a
2412 // dense assignment. Convert the map to an index table.
2413 std::vector<StructType*> NumberedTypes(TypePrinter.NumberedTypes.size());
2414 for (DenseMap<StructType*, unsigned>::iterator I =
2415 TypePrinter.NumberedTypes.begin(), E = TypePrinter.NumberedTypes.end();
2417 assert(I->second < NumberedTypes.size() && "Didn't get a dense numbering?");
2418 NumberedTypes[I->second] = I->first;
2421 // Emit all numbered types.
2422 for (unsigned i = 0, e = NumberedTypes.size(); i != e; ++i) {
2423 Out << '%' << i << " = type ";
2425 // Make sure we print out at least one level of the type structure, so
2426 // that we do not get %2 = type %2
2427 TypePrinter.printStructBody(NumberedTypes[i], Out);
2431 for (unsigned i = 0, e = TypePrinter.NamedTypes.size(); i != e; ++i) {
2432 PrintLLVMName(Out, TypePrinter.NamedTypes[i]->getName(), LocalPrefix);
2435 // Make sure we print out at least one level of the type structure, so
2436 // that we do not get %FILE = type %FILE
2437 TypePrinter.printStructBody(TypePrinter.NamedTypes[i], Out);
2442 /// printFunction - Print all aspects of a function.
2444 void AssemblyWriter::printFunction(const Function *F) {
2445 // Print out the return type and name.
2448 if (AnnotationWriter) AnnotationWriter->emitFunctionAnnot(F, Out);
2450 if (F->isMaterializable())
2451 Out << "; Materializable\n";
2453 const AttributeSet &Attrs = F->getAttributes();
2454 if (Attrs.hasAttributes(AttributeSet::FunctionIndex)) {
2455 AttributeSet AS = Attrs.getFnAttributes();
2456 std::string AttrStr;
2459 for (unsigned E = AS.getNumSlots(); Idx != E; ++Idx)
2460 if (AS.getSlotIndex(Idx) == AttributeSet::FunctionIndex)
2463 for (AttributeSet::iterator I = AS.begin(Idx), E = AS.end(Idx);
2465 Attribute Attr = *I;
2466 if (!Attr.isStringAttribute()) {
2467 if (!AttrStr.empty()) AttrStr += ' ';
2468 AttrStr += Attr.getAsString();
2472 if (!AttrStr.empty())
2473 Out << "; Function Attrs: " << AttrStr << '\n';
2476 if (F->isDeclaration())
2481 PrintLinkage(F->getLinkage(), Out);
2482 PrintVisibility(F->getVisibility(), Out);
2483 PrintDLLStorageClass(F->getDLLStorageClass(), Out);
2485 // Print the calling convention.
2486 if (F->getCallingConv() != CallingConv::C) {
2487 PrintCallingConv(F->getCallingConv(), Out);
2491 FunctionType *FT = F->getFunctionType();
2492 if (Attrs.hasAttributes(AttributeSet::ReturnIndex))
2493 Out << Attrs.getAsString(AttributeSet::ReturnIndex) << ' ';
2494 TypePrinter.print(F->getReturnType(), Out);
2496 WriteAsOperandInternal(Out, F, &TypePrinter, &Machine, F->getParent());
2498 Machine.incorporateFunction(F);
2500 // Loop over the arguments, printing them...
2503 if (!F->isDeclaration()) {
2504 // If this isn't a declaration, print the argument names as well.
2505 for (Function::const_arg_iterator I = F->arg_begin(), E = F->arg_end();
2507 // Insert commas as we go... the first arg doesn't get a comma
2508 if (I != F->arg_begin()) Out << ", ";
2509 printArgument(I, Attrs, Idx);
2513 // Otherwise, print the types from the function type.
2514 for (unsigned i = 0, e = FT->getNumParams(); i != e; ++i) {
2515 // Insert commas as we go... the first arg doesn't get a comma
2519 TypePrinter.print(FT->getParamType(i), Out);
2521 if (Attrs.hasAttributes(i+1))
2522 Out << ' ' << Attrs.getAsString(i+1);
2526 // Finish printing arguments...
2527 if (FT->isVarArg()) {
2528 if (FT->getNumParams()) Out << ", ";
2529 Out << "..."; // Output varargs portion of signature!
2532 if (F->hasUnnamedAddr())
2533 Out << " unnamed_addr";
2534 if (Attrs.hasAttributes(AttributeSet::FunctionIndex))
2535 Out << " #" << Machine.getAttributeGroupSlot(Attrs.getFnAttributes());
2536 if (F->hasSection()) {
2537 Out << " section \"";
2538 PrintEscapedString(F->getSection(), Out);
2541 maybePrintComdat(Out, *F);
2542 if (F->getAlignment())
2543 Out << " align " << F->getAlignment();
2545 Out << " gc \"" << F->getGC() << '"';
2546 if (F->hasPrefixData()) {
2548 writeOperand(F->getPrefixData(), true);
2550 if (F->hasPrologueData()) {
2551 Out << " prologue ";
2552 writeOperand(F->getPrologueData(), true);
2555 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
2556 F->getAllMetadata(MDs);
2557 printMetadataAttachments(MDs, " ");
2559 if (F->isDeclaration()) {
2563 // Output all of the function's basic blocks.
2564 for (Function::const_iterator I = F->begin(), E = F->end(); I != E; ++I)
2567 // Output the function's use-lists.
2573 Machine.purgeFunction();
2576 /// printArgument - This member is called for every argument that is passed into
2577 /// the function. Simply print it out
2579 void AssemblyWriter::printArgument(const Argument *Arg,
2580 AttributeSet Attrs, unsigned Idx) {
2582 TypePrinter.print(Arg->getType(), Out);
2584 // Output parameter attributes list
2585 if (Attrs.hasAttributes(Idx))
2586 Out << ' ' << Attrs.getAsString(Idx);
2588 // Output name, if available...
2589 if (Arg->hasName()) {
2591 PrintLLVMName(Out, Arg);
2595 /// printBasicBlock - This member is called for each basic block in a method.
2597 void AssemblyWriter::printBasicBlock(const BasicBlock *BB) {
2598 if (BB->hasName()) { // Print out the label if it exists...
2600 PrintLLVMName(Out, BB->getName(), LabelPrefix);
2602 } else if (!BB->use_empty()) { // Don't print block # of no uses...
2603 Out << "\n; <label>:";
2604 int Slot = Machine.getLocalSlot(BB);
2611 if (!BB->getParent()) {
2612 Out.PadToColumn(50);
2613 Out << "; Error: Block without parent!";
2614 } else if (BB != &BB->getParent()->getEntryBlock()) { // Not the entry block?
2615 // Output predecessors for the block.
2616 Out.PadToColumn(50);
2618 const_pred_iterator PI = pred_begin(BB), PE = pred_end(BB);
2621 Out << " No predecessors!";
2624 writeOperand(*PI, false);
2625 for (++PI; PI != PE; ++PI) {
2627 writeOperand(*PI, false);
2634 if (AnnotationWriter) AnnotationWriter->emitBasicBlockStartAnnot(BB, Out);
2636 // Output all of the instructions in the basic block...
2637 for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I != E; ++I) {
2638 printInstructionLine(*I);
2641 if (AnnotationWriter) AnnotationWriter->emitBasicBlockEndAnnot(BB, Out);
2644 /// printInstructionLine - Print an instruction and a newline character.
2645 void AssemblyWriter::printInstructionLine(const Instruction &I) {
2646 printInstruction(I);
2650 /// printGCRelocateComment - print comment after call to the gc.relocate
2651 /// intrinsic indicating base and derived pointer names.
2652 void AssemblyWriter::printGCRelocateComment(const Value &V) {
2653 assert(isGCRelocate(&V));
2654 GCRelocateOperands GCOps(cast<Instruction>(&V));
2657 writeOperand(GCOps.getBasePtr(), false);
2659 writeOperand(GCOps.getDerivedPtr(), false);
2663 /// printInfoComment - Print a little comment after the instruction indicating
2664 /// which slot it occupies.
2666 void AssemblyWriter::printInfoComment(const Value &V) {
2667 if (isGCRelocate(&V))
2668 printGCRelocateComment(V);
2670 if (AnnotationWriter)
2671 AnnotationWriter->printInfoComment(V, Out);
2674 // This member is called for each Instruction in a function..
2675 void AssemblyWriter::printInstruction(const Instruction &I) {
2676 if (AnnotationWriter) AnnotationWriter->emitInstructionAnnot(&I, Out);
2678 // Print out indentation for an instruction.
2681 // Print out name if it exists...
2683 PrintLLVMName(Out, &I);
2685 } else if (!I.getType()->isVoidTy()) {
2686 // Print out the def slot taken.
2687 int SlotNum = Machine.getLocalSlot(&I);
2689 Out << "<badref> = ";
2691 Out << '%' << SlotNum << " = ";
2694 if (const CallInst *CI = dyn_cast<CallInst>(&I)) {
2695 if (CI->isMustTailCall())
2697 else if (CI->isTailCall())
2701 // Print out the opcode...
2702 Out << I.getOpcodeName();
2704 // If this is an atomic load or store, print out the atomic marker.
2705 if ((isa<LoadInst>(I) && cast<LoadInst>(I).isAtomic()) ||
2706 (isa<StoreInst>(I) && cast<StoreInst>(I).isAtomic()))
2709 if (isa<AtomicCmpXchgInst>(I) && cast<AtomicCmpXchgInst>(I).isWeak())
2712 // If this is a volatile operation, print out the volatile marker.
2713 if ((isa<LoadInst>(I) && cast<LoadInst>(I).isVolatile()) ||
2714 (isa<StoreInst>(I) && cast<StoreInst>(I).isVolatile()) ||
2715 (isa<AtomicCmpXchgInst>(I) && cast<AtomicCmpXchgInst>(I).isVolatile()) ||
2716 (isa<AtomicRMWInst>(I) && cast<AtomicRMWInst>(I).isVolatile()))
2719 // Print out optimization information.
2720 WriteOptimizationInfo(Out, &I);
2722 // Print out the compare instruction predicates
2723 if (const CmpInst *CI = dyn_cast<CmpInst>(&I))
2724 Out << ' ' << getPredicateText(CI->getPredicate());
2726 // Print out the atomicrmw operation
2727 if (const AtomicRMWInst *RMWI = dyn_cast<AtomicRMWInst>(&I))
2728 writeAtomicRMWOperation(Out, RMWI->getOperation());
2730 // Print out the type of the operands...
2731 const Value *Operand = I.getNumOperands() ? I.getOperand(0) : nullptr;
2733 // Special case conditional branches to swizzle the condition out to the front
2734 if (isa<BranchInst>(I) && cast<BranchInst>(I).isConditional()) {
2735 const BranchInst &BI(cast<BranchInst>(I));
2737 writeOperand(BI.getCondition(), true);
2739 writeOperand(BI.getSuccessor(0), true);
2741 writeOperand(BI.getSuccessor(1), true);
2743 } else if (isa<SwitchInst>(I)) {
2744 const SwitchInst& SI(cast<SwitchInst>(I));
2745 // Special case switch instruction to get formatting nice and correct.
2747 writeOperand(SI.getCondition(), true);
2749 writeOperand(SI.getDefaultDest(), true);
2751 for (SwitchInst::ConstCaseIt i = SI.case_begin(), e = SI.case_end();
2754 writeOperand(i.getCaseValue(), true);
2756 writeOperand(i.getCaseSuccessor(), true);
2759 } else if (isa<IndirectBrInst>(I)) {
2760 // Special case indirectbr instruction to get formatting nice and correct.
2762 writeOperand(Operand, true);
2765 for (unsigned i = 1, e = I.getNumOperands(); i != e; ++i) {
2768 writeOperand(I.getOperand(i), true);
2771 } else if (const PHINode *PN = dyn_cast<PHINode>(&I)) {
2773 TypePrinter.print(I.getType(), Out);
2776 for (unsigned op = 0, Eop = PN->getNumIncomingValues(); op < Eop; ++op) {
2777 if (op) Out << ", ";
2779 writeOperand(PN->getIncomingValue(op), false); Out << ", ";
2780 writeOperand(PN->getIncomingBlock(op), false); Out << " ]";
2782 } else if (const ExtractValueInst *EVI = dyn_cast<ExtractValueInst>(&I)) {
2784 writeOperand(I.getOperand(0), true);
2785 for (const unsigned *i = EVI->idx_begin(), *e = EVI->idx_end(); i != e; ++i)
2787 } else if (const InsertValueInst *IVI = dyn_cast<InsertValueInst>(&I)) {
2789 writeOperand(I.getOperand(0), true); Out << ", ";
2790 writeOperand(I.getOperand(1), true);
2791 for (const unsigned *i = IVI->idx_begin(), *e = IVI->idx_end(); i != e; ++i)
2793 } else if (const LandingPadInst *LPI = dyn_cast<LandingPadInst>(&I)) {
2795 TypePrinter.print(I.getType(), Out);
2796 Out << " personality ";
2797 writeOperand(I.getOperand(0), true); Out << '\n';
2799 if (LPI->isCleanup())
2802 for (unsigned i = 0, e = LPI->getNumClauses(); i != e; ++i) {
2803 if (i != 0 || LPI->isCleanup()) Out << "\n";
2804 if (LPI->isCatch(i))
2809 writeOperand(LPI->getClause(i), true);
2811 } else if (isa<ReturnInst>(I) && !Operand) {
2813 } else if (const CallInst *CI = dyn_cast<CallInst>(&I)) {
2814 // Print the calling convention being used.
2815 if (CI->getCallingConv() != CallingConv::C) {
2817 PrintCallingConv(CI->getCallingConv(), Out);
2820 Operand = CI->getCalledValue();
2821 FunctionType *FTy = cast<FunctionType>(CI->getFunctionType());
2822 Type *RetTy = FTy->getReturnType();
2823 const AttributeSet &PAL = CI->getAttributes();
2825 if (PAL.hasAttributes(AttributeSet::ReturnIndex))
2826 Out << ' ' << PAL.getAsString(AttributeSet::ReturnIndex);
2828 // If possible, print out the short form of the call instruction. We can
2829 // only do this if the first argument is a pointer to a nonvararg function,
2830 // and if the return type is not a pointer to a function.
2833 TypePrinter.print(FTy->isVarArg() ? FTy : RetTy, Out);
2835 writeOperand(Operand, false);
2837 for (unsigned op = 0, Eop = CI->getNumArgOperands(); op < Eop; ++op) {
2840 writeParamOperand(CI->getArgOperand(op), PAL, op + 1);
2843 // Emit an ellipsis if this is a musttail call in a vararg function. This
2844 // is only to aid readability, musttail calls forward varargs by default.
2845 if (CI->isMustTailCall() && CI->getParent() &&
2846 CI->getParent()->getParent() &&
2847 CI->getParent()->getParent()->isVarArg())
2851 if (PAL.hasAttributes(AttributeSet::FunctionIndex))
2852 Out << " #" << Machine.getAttributeGroupSlot(PAL.getFnAttributes());
2853 } else if (const InvokeInst *II = dyn_cast<InvokeInst>(&I)) {
2854 Operand = II->getCalledValue();
2855 FunctionType *FTy = cast<FunctionType>(II->getFunctionType());
2856 Type *RetTy = FTy->getReturnType();
2857 const AttributeSet &PAL = II->getAttributes();
2859 // Print the calling convention being used.
2860 if (II->getCallingConv() != CallingConv::C) {
2862 PrintCallingConv(II->getCallingConv(), Out);
2865 if (PAL.hasAttributes(AttributeSet::ReturnIndex))
2866 Out << ' ' << PAL.getAsString(AttributeSet::ReturnIndex);
2868 // If possible, print out the short form of the invoke instruction. We can
2869 // only do this if the first argument is a pointer to a nonvararg function,
2870 // and if the return type is not a pointer to a function.
2873 TypePrinter.print(FTy->isVarArg() ? FTy : RetTy, Out);
2875 writeOperand(Operand, false);
2877 for (unsigned op = 0, Eop = II->getNumArgOperands(); op < Eop; ++op) {
2880 writeParamOperand(II->getArgOperand(op), PAL, op + 1);
2884 if (PAL.hasAttributes(AttributeSet::FunctionIndex))
2885 Out << " #" << Machine.getAttributeGroupSlot(PAL.getFnAttributes());
2888 writeOperand(II->getNormalDest(), true);
2890 writeOperand(II->getUnwindDest(), true);
2892 } else if (const AllocaInst *AI = dyn_cast<AllocaInst>(&I)) {
2894 if (AI->isUsedWithInAlloca())
2896 TypePrinter.print(AI->getAllocatedType(), Out);
2898 // Explicitly write the array size if the code is broken, if it's an array
2899 // allocation, or if the type is not canonical for scalar allocations. The
2900 // latter case prevents the type from mutating when round-tripping through
2902 if (!AI->getArraySize() || AI->isArrayAllocation() ||
2903 !AI->getArraySize()->getType()->isIntegerTy(32)) {
2905 writeOperand(AI->getArraySize(), true);
2907 if (AI->getAlignment()) {
2908 Out << ", align " << AI->getAlignment();
2910 } else if (isa<CastInst>(I)) {
2913 writeOperand(Operand, true); // Work with broken code
2916 TypePrinter.print(I.getType(), Out);
2917 } else if (isa<VAArgInst>(I)) {
2920 writeOperand(Operand, true); // Work with broken code
2923 TypePrinter.print(I.getType(), Out);
2924 } else if (Operand) { // Print the normal way.
2925 if (const auto *GEP = dyn_cast<GetElementPtrInst>(&I)) {
2927 TypePrinter.print(GEP->getSourceElementType(), Out);
2929 } else if (const auto *LI = dyn_cast<LoadInst>(&I)) {
2931 TypePrinter.print(LI->getType(), Out);
2935 // PrintAllTypes - Instructions who have operands of all the same type
2936 // omit the type from all but the first operand. If the instruction has
2937 // different type operands (for example br), then they are all printed.
2938 bool PrintAllTypes = false;
2939 Type *TheType = Operand->getType();
2941 // Select, Store and ShuffleVector always print all types.
2942 if (isa<SelectInst>(I) || isa<StoreInst>(I) || isa<ShuffleVectorInst>(I)
2943 || isa<ReturnInst>(I)) {
2944 PrintAllTypes = true;
2946 for (unsigned i = 1, E = I.getNumOperands(); i != E; ++i) {
2947 Operand = I.getOperand(i);
2948 // note that Operand shouldn't be null, but the test helps make dump()
2949 // more tolerant of malformed IR
2950 if (Operand && Operand->getType() != TheType) {
2951 PrintAllTypes = true; // We have differing types! Print them all!
2957 if (!PrintAllTypes) {
2959 TypePrinter.print(TheType, Out);
2963 for (unsigned i = 0, E = I.getNumOperands(); i != E; ++i) {
2965 writeOperand(I.getOperand(i), PrintAllTypes);
2969 // Print atomic ordering/alignment for memory operations
2970 if (const LoadInst *LI = dyn_cast<LoadInst>(&I)) {
2972 writeAtomic(LI->getOrdering(), LI->getSynchScope());
2973 if (LI->getAlignment())
2974 Out << ", align " << LI->getAlignment();
2975 } else if (const StoreInst *SI = dyn_cast<StoreInst>(&I)) {
2977 writeAtomic(SI->getOrdering(), SI->getSynchScope());
2978 if (SI->getAlignment())
2979 Out << ", align " << SI->getAlignment();
2980 } else if (const AtomicCmpXchgInst *CXI = dyn_cast<AtomicCmpXchgInst>(&I)) {
2981 writeAtomicCmpXchg(CXI->getSuccessOrdering(), CXI->getFailureOrdering(),
2982 CXI->getSynchScope());
2983 } else if (const AtomicRMWInst *RMWI = dyn_cast<AtomicRMWInst>(&I)) {
2984 writeAtomic(RMWI->getOrdering(), RMWI->getSynchScope());
2985 } else if (const FenceInst *FI = dyn_cast<FenceInst>(&I)) {
2986 writeAtomic(FI->getOrdering(), FI->getSynchScope());
2989 // Print Metadata info.
2990 SmallVector<std::pair<unsigned, MDNode *>, 4> InstMD;
2991 I.getAllMetadata(InstMD);
2992 printMetadataAttachments(InstMD, ", ");
2994 // Print a nice comment.
2995 printInfoComment(I);
2998 void AssemblyWriter::printMetadataAttachments(
2999 const SmallVectorImpl<std::pair<unsigned, MDNode *>> &MDs,
3000 StringRef Separator) {
3004 if (MDNames.empty())
3005 TheModule->getMDKindNames(MDNames);
3007 for (const auto &I : MDs) {
3008 unsigned Kind = I.first;
3010 if (Kind < MDNames.size())
3011 Out << "!" << MDNames[Kind];
3013 Out << "!<unknown kind #" << Kind << ">";
3015 WriteAsOperandInternal(Out, I.second, &TypePrinter, &Machine, TheModule);
3019 void AssemblyWriter::writeMDNode(unsigned Slot, const MDNode *Node) {
3020 Out << '!' << Slot << " = ";
3021 printMDNodeBody(Node);
3025 void AssemblyWriter::writeAllMDNodes() {
3026 SmallVector<const MDNode *, 16> Nodes;
3027 Nodes.resize(Machine.mdn_size());
3028 for (SlotTracker::mdn_iterator I = Machine.mdn_begin(), E = Machine.mdn_end();
3030 Nodes[I->second] = cast<MDNode>(I->first);
3032 for (unsigned i = 0, e = Nodes.size(); i != e; ++i) {
3033 writeMDNode(i, Nodes[i]);
3037 void AssemblyWriter::printMDNodeBody(const MDNode *Node) {
3038 WriteMDNodeBodyInternal(Out, Node, &TypePrinter, &Machine, TheModule);
3041 void AssemblyWriter::writeAllAttributeGroups() {
3042 std::vector<std::pair<AttributeSet, unsigned> > asVec;
3043 asVec.resize(Machine.as_size());
3045 for (SlotTracker::as_iterator I = Machine.as_begin(), E = Machine.as_end();
3047 asVec[I->second] = *I;
3049 for (std::vector<std::pair<AttributeSet, unsigned> >::iterator
3050 I = asVec.begin(), E = asVec.end(); I != E; ++I)
3051 Out << "attributes #" << I->second << " = { "
3052 << I->first.getAsString(AttributeSet::FunctionIndex, true) << " }\n";
3055 void AssemblyWriter::printUseListOrder(const UseListOrder &Order) {
3056 bool IsInFunction = Machine.getFunction();
3060 Out << "uselistorder";
3061 if (const BasicBlock *BB =
3062 IsInFunction ? nullptr : dyn_cast<BasicBlock>(Order.V)) {
3064 writeOperand(BB->getParent(), false);
3066 writeOperand(BB, false);
3069 writeOperand(Order.V, true);
3073 assert(Order.Shuffle.size() >= 2 && "Shuffle too small");
3074 Out << Order.Shuffle[0];
3075 for (unsigned I = 1, E = Order.Shuffle.size(); I != E; ++I)
3076 Out << ", " << Order.Shuffle[I];
3080 void AssemblyWriter::printUseLists(const Function *F) {
3082 [&]() { return !UseListOrders.empty() && UseListOrders.back().F == F; };
3087 Out << "\n; uselistorder directives\n";
3089 printUseListOrder(UseListOrders.back());
3090 UseListOrders.pop_back();
3094 //===----------------------------------------------------------------------===//
3095 // External Interface declarations
3096 //===----------------------------------------------------------------------===//
3098 void Function::print(raw_ostream &ROS, AssemblyAnnotationWriter *AAW) const {
3099 SlotTracker SlotTable(this->getParent());
3100 formatted_raw_ostream OS(ROS);
3101 AssemblyWriter W(OS, SlotTable, this->getParent(), AAW);
3102 W.printFunction(this);
3105 void Module::print(raw_ostream &ROS, AssemblyAnnotationWriter *AAW,
3106 bool ShouldPreserveUseListOrder) const {
3107 SlotTracker SlotTable(this);
3108 formatted_raw_ostream OS(ROS);
3109 AssemblyWriter W(OS, SlotTable, this, AAW, ShouldPreserveUseListOrder);
3110 W.printModule(this);
3113 void NamedMDNode::print(raw_ostream &ROS) const {
3114 SlotTracker SlotTable(getParent());
3115 formatted_raw_ostream OS(ROS);
3116 AssemblyWriter W(OS, SlotTable, getParent(), nullptr);
3117 W.printNamedMDNode(this);
3120 void Comdat::print(raw_ostream &ROS) const {
3121 PrintLLVMName(ROS, getName(), ComdatPrefix);
3122 ROS << " = comdat ";
3124 switch (getSelectionKind()) {
3128 case Comdat::ExactMatch:
3129 ROS << "exactmatch";
3131 case Comdat::Largest:
3134 case Comdat::NoDuplicates:
3135 ROS << "noduplicates";
3137 case Comdat::SameSize:
3145 void Type::print(raw_ostream &OS) const {
3147 TP.print(const_cast<Type*>(this), OS);
3149 // If the type is a named struct type, print the body as well.
3150 if (StructType *STy = dyn_cast<StructType>(const_cast<Type*>(this)))
3151 if (!STy->isLiteral()) {
3153 TP.printStructBody(STy, OS);
3157 static bool isReferencingMDNode(const Instruction &I) {
3158 if (const auto *CI = dyn_cast<CallInst>(&I))
3159 if (Function *F = CI->getCalledFunction())
3160 if (F->isIntrinsic())
3161 for (auto &Op : I.operands())
3162 if (auto *V = dyn_cast_or_null<MetadataAsValue>(Op))
3163 if (isa<MDNode>(V->getMetadata()))
3168 void Value::print(raw_ostream &ROS) const {
3169 formatted_raw_ostream OS(ROS);
3170 if (const Instruction *I = dyn_cast<Instruction>(this)) {
3171 const Function *F = I->getParent() ? I->getParent()->getParent() : nullptr;
3172 SlotTracker SlotTable(
3174 /* ShouldInitializeAllMetadata */ isReferencingMDNode(*I));
3175 AssemblyWriter W(OS, SlotTable, getModuleFromVal(I), nullptr);
3176 W.printInstruction(*I);
3177 } else if (const BasicBlock *BB = dyn_cast<BasicBlock>(this)) {
3178 SlotTracker SlotTable(BB->getParent());
3179 AssemblyWriter W(OS, SlotTable, getModuleFromVal(BB), nullptr);
3180 W.printBasicBlock(BB);
3181 } else if (const GlobalValue *GV = dyn_cast<GlobalValue>(this)) {
3182 SlotTracker SlotTable(GV->getParent(),
3183 /* ShouldInitializeAllMetadata */ isa<Function>(GV));
3184 AssemblyWriter W(OS, SlotTable, GV->getParent(), nullptr);
3185 if (const GlobalVariable *V = dyn_cast<GlobalVariable>(GV))
3187 else if (const Function *F = dyn_cast<Function>(GV))
3190 W.printAlias(cast<GlobalAlias>(GV));
3191 } else if (const MetadataAsValue *V = dyn_cast<MetadataAsValue>(this)) {
3192 V->getMetadata()->print(ROS, getModuleFromVal(V));
3193 } else if (const Constant *C = dyn_cast<Constant>(this)) {
3194 TypePrinting TypePrinter;
3195 TypePrinter.print(C->getType(), OS);
3197 WriteConstantInternal(OS, C, TypePrinter, nullptr, nullptr);
3198 } else if (isa<InlineAsm>(this) || isa<Argument>(this)) {
3199 this->printAsOperand(OS);
3201 llvm_unreachable("Unknown value to print out!");
3205 void Value::printAsOperand(raw_ostream &O, bool PrintType, const Module *M) const {
3206 // Fast path: Don't construct and populate a TypePrinting object if we
3207 // won't be needing any types printed.
3208 bool IsMetadata = isa<MetadataAsValue>(this);
3209 if (!PrintType && ((!isa<Constant>(this) && !IsMetadata) || hasName() ||
3210 isa<GlobalValue>(this))) {
3211 WriteAsOperandInternal(O, this, nullptr, nullptr, M);
3216 M = getModuleFromVal(this);
3218 TypePrinting TypePrinter;
3220 TypePrinter.incorporateTypes(*M);
3222 TypePrinter.print(getType(), O);
3226 SlotTracker Machine(M, /* ShouldInitializeAllMetadata */ IsMetadata);
3227 WriteAsOperandInternal(O, this, &TypePrinter, &Machine, M);
3230 static void printMetadataImpl(raw_ostream &ROS, const Metadata &MD,
3231 const Module *M, bool OnlyAsOperand) {
3232 formatted_raw_ostream OS(ROS);
3234 auto *N = dyn_cast<MDNode>(&MD);
3235 TypePrinting TypePrinter;
3236 SlotTracker Machine(M, /* ShouldInitializeAllMetadata */ N);
3238 TypePrinter.incorporateTypes(*M);
3240 WriteAsOperandInternal(OS, &MD, &TypePrinter, &Machine, M,
3241 /* FromValue */ true);
3242 if (OnlyAsOperand || !N)
3246 WriteMDNodeBodyInternal(OS, N, &TypePrinter, &Machine, M);
3249 void Metadata::printAsOperand(raw_ostream &OS, const Module *M) const {
3250 printMetadataImpl(OS, *this, M, /* OnlyAsOperand */ true);
3253 void Metadata::print(raw_ostream &OS, const Module *M) const {
3254 printMetadataImpl(OS, *this, M, /* OnlyAsOperand */ false);
3257 // Value::dump - allow easy printing of Values from the debugger.
3259 void Value::dump() const { print(dbgs()); dbgs() << '\n'; }
3261 // Type::dump - allow easy printing of Types from the debugger.
3263 void Type::dump() const { print(dbgs()); dbgs() << '\n'; }
3265 // Module::dump() - Allow printing of Modules from the debugger.
3267 void Module::dump() const { print(dbgs(), nullptr); }
3269 // \brief Allow printing of Comdats from the debugger.
3271 void Comdat::dump() const { print(dbgs()); }
3273 // NamedMDNode::dump() - Allow printing of NamedMDNodes from the debugger.
3275 void NamedMDNode::dump() const { print(dbgs()); }
3278 void Metadata::dump() const { dump(nullptr); }
3281 void Metadata::dump(const Module *M) const {