1 //===-- AsmWriter.cpp - Printing LLVM as an assembly file -----------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This library implements the functionality defined in llvm/IR/Writer.h
12 // Note that these routines must be extremely tolerant of various errors in the
13 // LLVM code, because it can be used for debugging transformations.
15 //===----------------------------------------------------------------------===//
17 #include "AsmWriter.h"
18 #include "llvm/ADT/DenseMap.h"
19 #include "llvm/ADT/STLExtras.h"
20 #include "llvm/ADT/SmallString.h"
21 #include "llvm/ADT/StringExtras.h"
22 #include "llvm/IR/AssemblyAnnotationWriter.h"
23 #include "llvm/IR/CFG.h"
24 #include "llvm/IR/CallingConv.h"
25 #include "llvm/IR/Constants.h"
26 #include "llvm/IR/DebugInfo.h"
27 #include "llvm/IR/DerivedTypes.h"
28 #include "llvm/IR/IRPrintingPasses.h"
29 #include "llvm/IR/InlineAsm.h"
30 #include "llvm/IR/IntrinsicInst.h"
31 #include "llvm/IR/LLVMContext.h"
32 #include "llvm/IR/Module.h"
33 #include "llvm/IR/Operator.h"
34 #include "llvm/IR/TypeFinder.h"
35 #include "llvm/IR/ValueSymbolTable.h"
36 #include "llvm/Support/Debug.h"
37 #include "llvm/Support/Dwarf.h"
38 #include "llvm/Support/ErrorHandling.h"
39 #include "llvm/Support/FormattedStream.h"
40 #include "llvm/Support/MathExtras.h"
45 // Make virtual table appear in this compilation unit.
46 AssemblyAnnotationWriter::~AssemblyAnnotationWriter() {}
48 //===----------------------------------------------------------------------===//
50 //===----------------------------------------------------------------------===//
54 DenseMap<const Value *, std::pair<unsigned, bool>> IDs;
56 unsigned size() const { return IDs.size(); }
57 std::pair<unsigned, bool> &operator[](const Value *V) { return IDs[V]; }
58 std::pair<unsigned, bool> lookup(const Value *V) const {
61 void index(const Value *V) {
62 // Explicitly sequence get-size and insert-value operations to avoid UB.
63 unsigned ID = IDs.size() + 1;
69 static void orderValue(const Value *V, OrderMap &OM) {
70 if (OM.lookup(V).first)
73 if (const Constant *C = dyn_cast<Constant>(V))
74 if (C->getNumOperands() && !isa<GlobalValue>(C))
75 for (const Value *Op : C->operands())
76 if (!isa<BasicBlock>(Op) && !isa<GlobalValue>(Op))
79 // Note: we cannot cache this lookup above, since inserting into the map
80 // changes the map's size, and thus affects the other IDs.
84 static OrderMap orderModule(const Module *M) {
85 // This needs to match the order used by ValueEnumerator::ValueEnumerator()
86 // and ValueEnumerator::incorporateFunction().
89 for (const GlobalVariable &G : M->globals()) {
90 if (G.hasInitializer())
91 if (!isa<GlobalValue>(G.getInitializer()))
92 orderValue(G.getInitializer(), OM);
95 for (const GlobalAlias &A : M->aliases()) {
96 if (!isa<GlobalValue>(A.getAliasee()))
97 orderValue(A.getAliasee(), OM);
100 for (const Function &F : *M) {
101 if (F.hasPrefixData())
102 if (!isa<GlobalValue>(F.getPrefixData()))
103 orderValue(F.getPrefixData(), OM);
106 if (F.isDeclaration())
109 for (const Argument &A : F.args())
111 for (const BasicBlock &BB : F) {
113 for (const Instruction &I : BB) {
114 for (const Value *Op : I.operands())
115 if ((isa<Constant>(*Op) && !isa<GlobalValue>(*Op)) ||
125 static void predictValueUseListOrderImpl(const Value *V, const Function *F,
126 unsigned ID, const OrderMap &OM,
127 UseListOrderStack &Stack) {
128 // Predict use-list order for this one.
129 typedef std::pair<const Use *, unsigned> Entry;
130 SmallVector<Entry, 64> List;
131 for (const Use &U : V->uses())
132 // Check if this user will be serialized.
133 if (OM.lookup(U.getUser()).first)
134 List.push_back(std::make_pair(&U, List.size()));
137 // We may have lost some users.
141 !isa<GlobalVariable>(V) && !isa<Function>(V) && !isa<BasicBlock>(V);
142 if (auto *BA = dyn_cast<BlockAddress>(V))
143 ID = OM.lookup(BA->getBasicBlock()).first;
144 std::sort(List.begin(), List.end(), [&](const Entry &L, const Entry &R) {
145 const Use *LU = L.first;
146 const Use *RU = R.first;
150 auto LID = OM.lookup(LU->getUser()).first;
151 auto RID = OM.lookup(RU->getUser()).first;
153 // If ID is 4, then expect: 7 6 5 1 2 3.
167 // LID and RID are equal, so we have different operands of the same user.
168 // Assume operands are added in order for all instructions.
171 return LU->getOperandNo() < RU->getOperandNo();
172 return LU->getOperandNo() > RU->getOperandNo();
176 List.begin(), List.end(),
177 [](const Entry &L, const Entry &R) { return L.second < R.second; }))
178 // Order is already correct.
181 // Store the shuffle.
182 Stack.emplace_back(V, F, List.size());
183 assert(List.size() == Stack.back().Shuffle.size() && "Wrong size");
184 for (size_t I = 0, E = List.size(); I != E; ++I)
185 Stack.back().Shuffle[I] = List[I].second;
188 static void predictValueUseListOrder(const Value *V, const Function *F,
189 OrderMap &OM, UseListOrderStack &Stack) {
190 auto &IDPair = OM[V];
191 assert(IDPair.first && "Unmapped value");
193 // Already predicted.
196 // Do the actual prediction.
197 IDPair.second = true;
198 if (!V->use_empty() && std::next(V->use_begin()) != V->use_end())
199 predictValueUseListOrderImpl(V, F, IDPair.first, OM, Stack);
201 // Recursive descent into constants.
202 if (const Constant *C = dyn_cast<Constant>(V))
203 if (C->getNumOperands()) // Visit GlobalValues.
204 for (const Value *Op : C->operands())
205 if (isa<Constant>(Op)) // Visit GlobalValues.
206 predictValueUseListOrder(Op, F, OM, Stack);
209 static UseListOrderStack predictUseListOrder(const Module *M) {
210 OrderMap OM = orderModule(M);
212 // Use-list orders need to be serialized after all the users have been added
213 // to a value, or else the shuffles will be incomplete. Store them per
214 // function in a stack.
216 // Aside from function order, the order of values doesn't matter much here.
217 UseListOrderStack Stack;
219 // We want to visit the functions backward now so we can list function-local
220 // constants in the last Function they're used in. Module-level constants
221 // have already been visited above.
222 for (auto I = M->rbegin(), E = M->rend(); I != E; ++I) {
223 const Function &F = *I;
224 if (F.isDeclaration())
226 for (const BasicBlock &BB : F)
227 predictValueUseListOrder(&BB, &F, OM, Stack);
228 for (const Argument &A : F.args())
229 predictValueUseListOrder(&A, &F, OM, Stack);
230 for (const BasicBlock &BB : F)
231 for (const Instruction &I : BB)
232 for (const Value *Op : I.operands())
233 if (isa<Constant>(*Op) || isa<InlineAsm>(*Op)) // Visit GlobalValues.
234 predictValueUseListOrder(Op, &F, OM, Stack);
235 for (const BasicBlock &BB : F)
236 for (const Instruction &I : BB)
237 predictValueUseListOrder(&I, &F, OM, Stack);
240 // Visit globals last.
241 for (const GlobalVariable &G : M->globals())
242 predictValueUseListOrder(&G, nullptr, OM, Stack);
243 for (const Function &F : *M)
244 predictValueUseListOrder(&F, nullptr, OM, Stack);
245 for (const GlobalAlias &A : M->aliases())
246 predictValueUseListOrder(&A, nullptr, OM, Stack);
247 for (const GlobalVariable &G : M->globals())
248 if (G.hasInitializer())
249 predictValueUseListOrder(G.getInitializer(), nullptr, OM, Stack);
250 for (const GlobalAlias &A : M->aliases())
251 predictValueUseListOrder(A.getAliasee(), nullptr, OM, Stack);
252 for (const Function &F : *M)
253 if (F.hasPrefixData())
254 predictValueUseListOrder(F.getPrefixData(), nullptr, OM, Stack);
259 static const Module *getModuleFromVal(const Value *V) {
260 if (const Argument *MA = dyn_cast<Argument>(V))
261 return MA->getParent() ? MA->getParent()->getParent() : nullptr;
263 if (const BasicBlock *BB = dyn_cast<BasicBlock>(V))
264 return BB->getParent() ? BB->getParent()->getParent() : nullptr;
266 if (const Instruction *I = dyn_cast<Instruction>(V)) {
267 const Function *M = I->getParent() ? I->getParent()->getParent() : nullptr;
268 return M ? M->getParent() : nullptr;
271 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V))
272 return GV->getParent();
276 static void PrintCallingConv(unsigned cc, raw_ostream &Out) {
278 default: Out << "cc" << cc; break;
279 case CallingConv::Fast: Out << "fastcc"; break;
280 case CallingConv::Cold: Out << "coldcc"; break;
281 case CallingConv::WebKit_JS: Out << "webkit_jscc"; break;
282 case CallingConv::AnyReg: Out << "anyregcc"; break;
283 case CallingConv::PreserveMost: Out << "preserve_mostcc"; break;
284 case CallingConv::PreserveAll: Out << "preserve_allcc"; break;
285 case CallingConv::X86_StdCall: Out << "x86_stdcallcc"; break;
286 case CallingConv::X86_FastCall: Out << "x86_fastcallcc"; break;
287 case CallingConv::X86_ThisCall: Out << "x86_thiscallcc"; break;
288 case CallingConv::Intel_OCL_BI: Out << "intel_ocl_bicc"; break;
289 case CallingConv::ARM_APCS: Out << "arm_apcscc"; break;
290 case CallingConv::ARM_AAPCS: Out << "arm_aapcscc"; break;
291 case CallingConv::ARM_AAPCS_VFP: Out << "arm_aapcs_vfpcc"; break;
292 case CallingConv::MSP430_INTR: Out << "msp430_intrcc"; break;
293 case CallingConv::PTX_Kernel: Out << "ptx_kernel"; break;
294 case CallingConv::PTX_Device: Out << "ptx_device"; break;
295 case CallingConv::X86_64_SysV: Out << "x86_64_sysvcc"; break;
296 case CallingConv::X86_64_Win64: Out << "x86_64_win64cc"; break;
297 case CallingConv::SPIR_FUNC: Out << "spir_func"; break;
298 case CallingConv::SPIR_KERNEL: Out << "spir_kernel"; break;
302 // PrintEscapedString - Print each character of the specified string, escaping
303 // it if it is not printable or if it is an escape char.
304 static void PrintEscapedString(StringRef Name, raw_ostream &Out) {
305 for (unsigned i = 0, e = Name.size(); i != e; ++i) {
306 unsigned char C = Name[i];
307 if (isprint(C) && C != '\\' && C != '"')
310 Out << '\\' << hexdigit(C >> 4) << hexdigit(C & 0x0F);
322 /// PrintLLVMName - Turn the specified name into an 'LLVM name', which is either
323 /// prefixed with % (if the string only contains simple characters) or is
324 /// surrounded with ""'s (if it has special chars in it). Print it out.
325 static void PrintLLVMName(raw_ostream &OS, StringRef Name, PrefixType Prefix) {
326 assert(!Name.empty() && "Cannot get empty name!");
328 case NoPrefix: break;
329 case GlobalPrefix: OS << '@'; break;
330 case ComdatPrefix: OS << '$'; break;
331 case LabelPrefix: break;
332 case LocalPrefix: OS << '%'; break;
335 // Scan the name to see if it needs quotes first.
336 bool NeedsQuotes = isdigit(static_cast<unsigned char>(Name[0]));
338 for (unsigned i = 0, e = Name.size(); i != e; ++i) {
339 // By making this unsigned, the value passed in to isalnum will always be
340 // in the range 0-255. This is important when building with MSVC because
341 // its implementation will assert. This situation can arise when dealing
342 // with UTF-8 multibyte characters.
343 unsigned char C = Name[i];
344 if (!isalnum(static_cast<unsigned char>(C)) && C != '-' && C != '.' &&
352 // If we didn't need any quotes, just write out the name in one blast.
358 // Okay, we need quotes. Output the quotes and escape any scary characters as
361 PrintEscapedString(Name, OS);
365 /// PrintLLVMName - Turn the specified name into an 'LLVM name', which is either
366 /// prefixed with % (if the string only contains simple characters) or is
367 /// surrounded with ""'s (if it has special chars in it). Print it out.
368 static void PrintLLVMName(raw_ostream &OS, const Value *V) {
369 PrintLLVMName(OS, V->getName(),
370 isa<GlobalValue>(V) ? GlobalPrefix : LocalPrefix);
376 void TypePrinting::incorporateTypes(const Module &M) {
377 NamedTypes.run(M, false);
379 // The list of struct types we got back includes all the struct types, split
380 // the unnamed ones out to a numbering and remove the anonymous structs.
381 unsigned NextNumber = 0;
383 std::vector<StructType*>::iterator NextToUse = NamedTypes.begin(), I, E;
384 for (I = NamedTypes.begin(), E = NamedTypes.end(); I != E; ++I) {
385 StructType *STy = *I;
387 // Ignore anonymous types.
388 if (STy->isLiteral())
391 if (STy->getName().empty())
392 NumberedTypes[STy] = NextNumber++;
397 NamedTypes.erase(NextToUse, NamedTypes.end());
401 /// CalcTypeName - Write the specified type to the specified raw_ostream, making
402 /// use of type names or up references to shorten the type name where possible.
403 void TypePrinting::print(Type *Ty, raw_ostream &OS) {
404 switch (Ty->getTypeID()) {
405 case Type::VoidTyID: OS << "void"; return;
406 case Type::HalfTyID: OS << "half"; return;
407 case Type::FloatTyID: OS << "float"; return;
408 case Type::DoubleTyID: OS << "double"; return;
409 case Type::X86_FP80TyID: OS << "x86_fp80"; return;
410 case Type::FP128TyID: OS << "fp128"; return;
411 case Type::PPC_FP128TyID: OS << "ppc_fp128"; return;
412 case Type::LabelTyID: OS << "label"; return;
413 case Type::MetadataTyID: OS << "metadata"; return;
414 case Type::X86_MMXTyID: OS << "x86_mmx"; return;
415 case Type::IntegerTyID:
416 OS << 'i' << cast<IntegerType>(Ty)->getBitWidth();
419 case Type::FunctionTyID: {
420 FunctionType *FTy = cast<FunctionType>(Ty);
421 print(FTy->getReturnType(), OS);
423 for (FunctionType::param_iterator I = FTy->param_begin(),
424 E = FTy->param_end(); I != E; ++I) {
425 if (I != FTy->param_begin())
429 if (FTy->isVarArg()) {
430 if (FTy->getNumParams()) OS << ", ";
436 case Type::StructTyID: {
437 StructType *STy = cast<StructType>(Ty);
439 if (STy->isLiteral())
440 return printStructBody(STy, OS);
442 if (!STy->getName().empty())
443 return PrintLLVMName(OS, STy->getName(), LocalPrefix);
445 DenseMap<StructType*, unsigned>::iterator I = NumberedTypes.find(STy);
446 if (I != NumberedTypes.end())
447 OS << '%' << I->second;
448 else // Not enumerated, print the hex address.
449 OS << "%\"type " << STy << '\"';
452 case Type::PointerTyID: {
453 PointerType *PTy = cast<PointerType>(Ty);
454 print(PTy->getElementType(), OS);
455 if (unsigned AddressSpace = PTy->getAddressSpace())
456 OS << " addrspace(" << AddressSpace << ')';
460 case Type::ArrayTyID: {
461 ArrayType *ATy = cast<ArrayType>(Ty);
462 OS << '[' << ATy->getNumElements() << " x ";
463 print(ATy->getElementType(), OS);
467 case Type::VectorTyID: {
468 VectorType *PTy = cast<VectorType>(Ty);
469 OS << "<" << PTy->getNumElements() << " x ";
470 print(PTy->getElementType(), OS);
475 llvm_unreachable("Invalid TypeID");
478 void TypePrinting::printStructBody(StructType *STy, raw_ostream &OS) {
479 if (STy->isOpaque()) {
487 if (STy->getNumElements() == 0) {
490 StructType::element_iterator I = STy->element_begin();
493 for (StructType::element_iterator E = STy->element_end(); I != E; ++I) {
504 //===----------------------------------------------------------------------===//
505 // SlotTracker Class: Enumerate slot numbers for unnamed values
506 //===----------------------------------------------------------------------===//
507 /// This class provides computation of slot numbers for LLVM Assembly writing.
511 /// ValueMap - A mapping of Values to slot numbers.
512 typedef DenseMap<const Value*, unsigned> ValueMap;
515 /// TheModule - The module for which we are holding slot numbers.
516 const Module* TheModule;
518 /// TheFunction - The function for which we are holding slot numbers.
519 const Function* TheFunction;
520 bool FunctionProcessed;
522 /// mMap - The slot map for the module level data.
526 /// fMap - The slot map for the function level data.
530 /// mdnMap - Map for MDNodes.
531 DenseMap<const MDNode*, unsigned> mdnMap;
534 /// asMap - The slot map for attribute sets.
535 DenseMap<AttributeSet, unsigned> asMap;
538 /// Construct from a module
539 explicit SlotTracker(const Module *M);
540 /// Construct from a function, starting out in incorp state.
541 explicit SlotTracker(const Function *F);
543 /// Return the slot number of the specified value in it's type
544 /// plane. If something is not in the SlotTracker, return -1.
545 int getLocalSlot(const Value *V);
546 int getGlobalSlot(const GlobalValue *V);
547 int getMetadataSlot(const MDNode *N);
548 int getAttributeGroupSlot(AttributeSet AS);
550 /// If you'd like to deal with a function instead of just a module, use
551 /// this method to get its data into the SlotTracker.
552 void incorporateFunction(const Function *F) {
554 FunctionProcessed = false;
557 const Function *getFunction() const { return TheFunction; }
559 /// After calling incorporateFunction, use this method to remove the
560 /// most recently incorporated function from the SlotTracker. This
561 /// will reset the state of the machine back to just the module contents.
562 void purgeFunction();
564 /// MDNode map iterators.
565 typedef DenseMap<const MDNode*, unsigned>::iterator mdn_iterator;
566 mdn_iterator mdn_begin() { return mdnMap.begin(); }
567 mdn_iterator mdn_end() { return mdnMap.end(); }
568 unsigned mdn_size() const { return mdnMap.size(); }
569 bool mdn_empty() const { return mdnMap.empty(); }
571 /// AttributeSet map iterators.
572 typedef DenseMap<AttributeSet, unsigned>::iterator as_iterator;
573 as_iterator as_begin() { return asMap.begin(); }
574 as_iterator as_end() { return asMap.end(); }
575 unsigned as_size() const { return asMap.size(); }
576 bool as_empty() const { return asMap.empty(); }
578 /// This function does the actual initialization.
579 inline void initialize();
581 // Implementation Details
583 /// CreateModuleSlot - Insert the specified GlobalValue* into the slot table.
584 void CreateModuleSlot(const GlobalValue *V);
586 /// CreateMetadataSlot - Insert the specified MDNode* into the slot table.
587 void CreateMetadataSlot(const MDNode *N);
589 /// CreateFunctionSlot - Insert the specified Value* into the slot table.
590 void CreateFunctionSlot(const Value *V);
592 /// \brief Insert the specified AttributeSet into the slot table.
593 void CreateAttributeSetSlot(AttributeSet AS);
595 /// Add all of the module level global variables (and their initializers)
596 /// and function declarations, but not the contents of those functions.
597 void processModule();
599 /// Add all of the functions arguments, basic blocks, and instructions.
600 void processFunction();
602 SlotTracker(const SlotTracker &) LLVM_DELETED_FUNCTION;
603 void operator=(const SlotTracker &) LLVM_DELETED_FUNCTION;
606 SlotTracker *createSlotTracker(const Module *M) {
607 return new SlotTracker(M);
610 static SlotTracker *createSlotTracker(const Value *V) {
611 if (const Argument *FA = dyn_cast<Argument>(V))
612 return new SlotTracker(FA->getParent());
614 if (const Instruction *I = dyn_cast<Instruction>(V))
616 return new SlotTracker(I->getParent()->getParent());
618 if (const BasicBlock *BB = dyn_cast<BasicBlock>(V))
619 return new SlotTracker(BB->getParent());
621 if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(V))
622 return new SlotTracker(GV->getParent());
624 if (const GlobalAlias *GA = dyn_cast<GlobalAlias>(V))
625 return new SlotTracker(GA->getParent());
627 if (const Function *Func = dyn_cast<Function>(V))
628 return new SlotTracker(Func);
630 if (const MDNode *MD = dyn_cast<MDNode>(V)) {
631 if (!MD->isFunctionLocal())
632 return new SlotTracker(MD->getFunction());
634 return new SlotTracker((Function *)nullptr);
641 #define ST_DEBUG(X) dbgs() << X
646 // Module level constructor. Causes the contents of the Module (sans functions)
647 // to be added to the slot table.
648 SlotTracker::SlotTracker(const Module *M)
649 : TheModule(M), TheFunction(nullptr), FunctionProcessed(false),
650 mNext(0), fNext(0), mdnNext(0), asNext(0) {
653 // Function level constructor. Causes the contents of the Module and the one
654 // function provided to be added to the slot table.
655 SlotTracker::SlotTracker(const Function *F)
656 : TheModule(F ? F->getParent() : nullptr), TheFunction(F),
657 FunctionProcessed(false), mNext(0), fNext(0), mdnNext(0), asNext(0) {
660 inline void SlotTracker::initialize() {
663 TheModule = nullptr; ///< Prevent re-processing next time we're called.
666 if (TheFunction && !FunctionProcessed)
670 // Iterate through all the global variables, functions, and global
671 // variable initializers and create slots for them.
672 void SlotTracker::processModule() {
673 ST_DEBUG("begin processModule!\n");
675 // Add all of the unnamed global variables to the value table.
676 for (Module::const_global_iterator I = TheModule->global_begin(),
677 E = TheModule->global_end(); I != E; ++I) {
682 // Add metadata used by named metadata.
683 for (Module::const_named_metadata_iterator
684 I = TheModule->named_metadata_begin(),
685 E = TheModule->named_metadata_end(); I != E; ++I) {
686 const NamedMDNode *NMD = I;
687 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i)
688 CreateMetadataSlot(NMD->getOperand(i));
691 for (Module::const_iterator I = TheModule->begin(), E = TheModule->end();
694 // Add all the unnamed functions to the table.
697 // Add all the function attributes to the table.
698 // FIXME: Add attributes of other objects?
699 AttributeSet FnAttrs = I->getAttributes().getFnAttributes();
700 if (FnAttrs.hasAttributes(AttributeSet::FunctionIndex))
701 CreateAttributeSetSlot(FnAttrs);
704 ST_DEBUG("end processModule!\n");
707 // Process the arguments, basic blocks, and instructions of a function.
708 void SlotTracker::processFunction() {
709 ST_DEBUG("begin processFunction!\n");
712 // Add all the function arguments with no names.
713 for(Function::const_arg_iterator AI = TheFunction->arg_begin(),
714 AE = TheFunction->arg_end(); AI != AE; ++AI)
716 CreateFunctionSlot(AI);
718 ST_DEBUG("Inserting Instructions:\n");
720 SmallVector<std::pair<unsigned, MDNode*>, 4> MDForInst;
722 // Add all of the basic blocks and instructions with no names.
723 for (Function::const_iterator BB = TheFunction->begin(),
724 E = TheFunction->end(); BB != E; ++BB) {
726 CreateFunctionSlot(BB);
728 for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I != E;
730 if (!I->getType()->isVoidTy() && !I->hasName())
731 CreateFunctionSlot(I);
733 // Intrinsics can directly use metadata. We allow direct calls to any
734 // llvm.foo function here, because the target may not be linked into the
736 if (const CallInst *CI = dyn_cast<CallInst>(I)) {
737 if (Function *F = CI->getCalledFunction())
738 if (F->isIntrinsic())
739 for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i)
740 if (MDNode *N = dyn_cast_or_null<MDNode>(I->getOperand(i)))
741 CreateMetadataSlot(N);
743 // Add all the call attributes to the table.
744 AttributeSet Attrs = CI->getAttributes().getFnAttributes();
745 if (Attrs.hasAttributes(AttributeSet::FunctionIndex))
746 CreateAttributeSetSlot(Attrs);
747 } else if (const InvokeInst *II = dyn_cast<InvokeInst>(I)) {
748 // Add all the call attributes to the table.
749 AttributeSet Attrs = II->getAttributes().getFnAttributes();
750 if (Attrs.hasAttributes(AttributeSet::FunctionIndex))
751 CreateAttributeSetSlot(Attrs);
754 // Process metadata attached with this instruction.
755 I->getAllMetadata(MDForInst);
756 for (unsigned i = 0, e = MDForInst.size(); i != e; ++i)
757 CreateMetadataSlot(MDForInst[i].second);
762 FunctionProcessed = true;
764 ST_DEBUG("end processFunction!\n");
767 /// Clean up after incorporating a function. This is the only way to get out of
768 /// the function incorporation state that affects get*Slot/Create*Slot. Function
769 /// incorporation state is indicated by TheFunction != 0.
770 void SlotTracker::purgeFunction() {
771 ST_DEBUG("begin purgeFunction!\n");
772 fMap.clear(); // Simply discard the function level map
773 TheFunction = nullptr;
774 FunctionProcessed = false;
775 ST_DEBUG("end purgeFunction!\n");
778 /// getGlobalSlot - Get the slot number of a global value.
779 int SlotTracker::getGlobalSlot(const GlobalValue *V) {
780 // Check for uninitialized state and do lazy initialization.
783 // Find the value in the module map
784 ValueMap::iterator MI = mMap.find(V);
785 return MI == mMap.end() ? -1 : (int)MI->second;
788 /// getMetadataSlot - Get the slot number of a MDNode.
789 int SlotTracker::getMetadataSlot(const MDNode *N) {
790 // Check for uninitialized state and do lazy initialization.
793 // Find the MDNode in the module map
794 mdn_iterator MI = mdnMap.find(N);
795 return MI == mdnMap.end() ? -1 : (int)MI->second;
799 /// getLocalSlot - Get the slot number for a value that is local to a function.
800 int SlotTracker::getLocalSlot(const Value *V) {
801 assert(!isa<Constant>(V) && "Can't get a constant or global slot with this!");
803 // Check for uninitialized state and do lazy initialization.
806 ValueMap::iterator FI = fMap.find(V);
807 return FI == fMap.end() ? -1 : (int)FI->second;
810 int SlotTracker::getAttributeGroupSlot(AttributeSet AS) {
811 // Check for uninitialized state and do lazy initialization.
814 // Find the AttributeSet in the module map.
815 as_iterator AI = asMap.find(AS);
816 return AI == asMap.end() ? -1 : (int)AI->second;
819 /// CreateModuleSlot - Insert the specified GlobalValue* into the slot table.
820 void SlotTracker::CreateModuleSlot(const GlobalValue *V) {
821 assert(V && "Can't insert a null Value into SlotTracker!");
822 assert(!V->getType()->isVoidTy() && "Doesn't need a slot!");
823 assert(!V->hasName() && "Doesn't need a slot!");
825 unsigned DestSlot = mNext++;
828 ST_DEBUG(" Inserting value [" << V->getType() << "] = " << V << " slot=" <<
830 // G = Global, F = Function, A = Alias, o = other
831 ST_DEBUG((isa<GlobalVariable>(V) ? 'G' :
832 (isa<Function>(V) ? 'F' :
833 (isa<GlobalAlias>(V) ? 'A' : 'o'))) << "]\n");
836 /// CreateSlot - Create a new slot for the specified value if it has no name.
837 void SlotTracker::CreateFunctionSlot(const Value *V) {
838 assert(!V->getType()->isVoidTy() && !V->hasName() && "Doesn't need a slot!");
840 unsigned DestSlot = fNext++;
843 // G = Global, F = Function, o = other
844 ST_DEBUG(" Inserting value [" << V->getType() << "] = " << V << " slot=" <<
845 DestSlot << " [o]\n");
848 /// CreateModuleSlot - Insert the specified MDNode* into the slot table.
849 void SlotTracker::CreateMetadataSlot(const MDNode *N) {
850 assert(N && "Can't insert a null Value into SlotTracker!");
852 // Don't insert if N is a function-local metadata, these are always printed
854 if (!N->isFunctionLocal()) {
855 mdn_iterator I = mdnMap.find(N);
856 if (I != mdnMap.end())
859 unsigned DestSlot = mdnNext++;
860 mdnMap[N] = DestSlot;
863 // Recursively add any MDNodes referenced by operands.
864 for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i)
865 if (const MDNode *Op = dyn_cast_or_null<MDNode>(N->getOperand(i)))
866 CreateMetadataSlot(Op);
869 void SlotTracker::CreateAttributeSetSlot(AttributeSet AS) {
870 assert(AS.hasAttributes(AttributeSet::FunctionIndex) &&
871 "Doesn't need a slot!");
873 as_iterator I = asMap.find(AS);
874 if (I != asMap.end())
877 unsigned DestSlot = asNext++;
878 asMap[AS] = DestSlot;
881 //===----------------------------------------------------------------------===//
882 // AsmWriter Implementation
883 //===----------------------------------------------------------------------===//
885 static void WriteAsOperandInternal(raw_ostream &Out, const Value *V,
886 TypePrinting *TypePrinter,
887 SlotTracker *Machine,
888 const Module *Context);
890 static const char *getPredicateText(unsigned predicate) {
891 const char * pred = "unknown";
893 case FCmpInst::FCMP_FALSE: pred = "false"; break;
894 case FCmpInst::FCMP_OEQ: pred = "oeq"; break;
895 case FCmpInst::FCMP_OGT: pred = "ogt"; break;
896 case FCmpInst::FCMP_OGE: pred = "oge"; break;
897 case FCmpInst::FCMP_OLT: pred = "olt"; break;
898 case FCmpInst::FCMP_OLE: pred = "ole"; break;
899 case FCmpInst::FCMP_ONE: pred = "one"; break;
900 case FCmpInst::FCMP_ORD: pred = "ord"; break;
901 case FCmpInst::FCMP_UNO: pred = "uno"; break;
902 case FCmpInst::FCMP_UEQ: pred = "ueq"; break;
903 case FCmpInst::FCMP_UGT: pred = "ugt"; break;
904 case FCmpInst::FCMP_UGE: pred = "uge"; break;
905 case FCmpInst::FCMP_ULT: pred = "ult"; break;
906 case FCmpInst::FCMP_ULE: pred = "ule"; break;
907 case FCmpInst::FCMP_UNE: pred = "une"; break;
908 case FCmpInst::FCMP_TRUE: pred = "true"; break;
909 case ICmpInst::ICMP_EQ: pred = "eq"; break;
910 case ICmpInst::ICMP_NE: pred = "ne"; break;
911 case ICmpInst::ICMP_SGT: pred = "sgt"; break;
912 case ICmpInst::ICMP_SGE: pred = "sge"; break;
913 case ICmpInst::ICMP_SLT: pred = "slt"; break;
914 case ICmpInst::ICMP_SLE: pred = "sle"; break;
915 case ICmpInst::ICMP_UGT: pred = "ugt"; break;
916 case ICmpInst::ICMP_UGE: pred = "uge"; break;
917 case ICmpInst::ICMP_ULT: pred = "ult"; break;
918 case ICmpInst::ICMP_ULE: pred = "ule"; break;
923 static void writeAtomicRMWOperation(raw_ostream &Out,
924 AtomicRMWInst::BinOp Op) {
926 default: Out << " <unknown operation " << Op << ">"; break;
927 case AtomicRMWInst::Xchg: Out << " xchg"; break;
928 case AtomicRMWInst::Add: Out << " add"; break;
929 case AtomicRMWInst::Sub: Out << " sub"; break;
930 case AtomicRMWInst::And: Out << " and"; break;
931 case AtomicRMWInst::Nand: Out << " nand"; break;
932 case AtomicRMWInst::Or: Out << " or"; break;
933 case AtomicRMWInst::Xor: Out << " xor"; break;
934 case AtomicRMWInst::Max: Out << " max"; break;
935 case AtomicRMWInst::Min: Out << " min"; break;
936 case AtomicRMWInst::UMax: Out << " umax"; break;
937 case AtomicRMWInst::UMin: Out << " umin"; break;
941 static void WriteOptimizationInfo(raw_ostream &Out, const User *U) {
942 if (const FPMathOperator *FPO = dyn_cast<const FPMathOperator>(U)) {
943 // Unsafe algebra implies all the others, no need to write them all out
944 if (FPO->hasUnsafeAlgebra())
947 if (FPO->hasNoNaNs())
949 if (FPO->hasNoInfs())
951 if (FPO->hasNoSignedZeros())
953 if (FPO->hasAllowReciprocal())
958 if (const OverflowingBinaryOperator *OBO =
959 dyn_cast<OverflowingBinaryOperator>(U)) {
960 if (OBO->hasNoUnsignedWrap())
962 if (OBO->hasNoSignedWrap())
964 } else if (const PossiblyExactOperator *Div =
965 dyn_cast<PossiblyExactOperator>(U)) {
968 } else if (const GEPOperator *GEP = dyn_cast<GEPOperator>(U)) {
969 if (GEP->isInBounds())
974 static void WriteConstantInternal(raw_ostream &Out, const Constant *CV,
975 TypePrinting &TypePrinter,
976 SlotTracker *Machine,
977 const Module *Context) {
978 if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV)) {
979 if (CI->getType()->isIntegerTy(1)) {
980 Out << (CI->getZExtValue() ? "true" : "false");
983 Out << CI->getValue();
987 if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV)) {
988 if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEsingle ||
989 &CFP->getValueAPF().getSemantics() == &APFloat::IEEEdouble) {
990 // We would like to output the FP constant value in exponential notation,
991 // but we cannot do this if doing so will lose precision. Check here to
992 // make sure that we only output it in exponential format if we can parse
993 // the value back and get the same value.
996 bool isHalf = &CFP->getValueAPF().getSemantics()==&APFloat::IEEEhalf;
997 bool isDouble = &CFP->getValueAPF().getSemantics()==&APFloat::IEEEdouble;
998 bool isInf = CFP->getValueAPF().isInfinity();
999 bool isNaN = CFP->getValueAPF().isNaN();
1000 if (!isHalf && !isInf && !isNaN) {
1001 double Val = isDouble ? CFP->getValueAPF().convertToDouble() :
1002 CFP->getValueAPF().convertToFloat();
1003 SmallString<128> StrVal;
1004 raw_svector_ostream(StrVal) << Val;
1006 // Check to make sure that the stringized number is not some string like
1007 // "Inf" or NaN, that atof will accept, but the lexer will not. Check
1008 // that the string matches the "[-+]?[0-9]" regex.
1010 if ((StrVal[0] >= '0' && StrVal[0] <= '9') ||
1011 ((StrVal[0] == '-' || StrVal[0] == '+') &&
1012 (StrVal[1] >= '0' && StrVal[1] <= '9'))) {
1013 // Reparse stringized version!
1014 if (APFloat(APFloat::IEEEdouble, StrVal).convertToDouble() == Val) {
1015 Out << StrVal.str();
1020 // Otherwise we could not reparse it to exactly the same value, so we must
1021 // output the string in hexadecimal format! Note that loading and storing
1022 // floating point types changes the bits of NaNs on some hosts, notably
1023 // x86, so we must not use these types.
1024 static_assert(sizeof(double) == sizeof(uint64_t),
1025 "assuming that double is 64 bits!");
1027 APFloat apf = CFP->getValueAPF();
1028 // Halves and floats are represented in ASCII IR as double, convert.
1030 apf.convert(APFloat::IEEEdouble, APFloat::rmNearestTiesToEven,
1033 utohex_buffer(uint64_t(apf.bitcastToAPInt().getZExtValue()),
1038 // Either half, or some form of long double.
1039 // These appear as a magic letter identifying the type, then a
1040 // fixed number of hex digits.
1042 // Bit position, in the current word, of the next nibble to print.
1045 if (&CFP->getValueAPF().getSemantics() == &APFloat::x87DoubleExtended) {
1047 // api needed to prevent premature destruction
1048 APInt api = CFP->getValueAPF().bitcastToAPInt();
1049 const uint64_t* p = api.getRawData();
1050 uint64_t word = p[1];
1052 int width = api.getBitWidth();
1053 for (int j=0; j<width; j+=4, shiftcount-=4) {
1054 unsigned int nibble = (word>>shiftcount) & 15;
1056 Out << (unsigned char)(nibble + '0');
1058 Out << (unsigned char)(nibble - 10 + 'A');
1059 if (shiftcount == 0 && j+4 < width) {
1063 shiftcount = width-j-4;
1067 } else if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEquad) {
1070 } else if (&CFP->getValueAPF().getSemantics() == &APFloat::PPCDoubleDouble) {
1073 } else if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEhalf) {
1077 llvm_unreachable("Unsupported floating point type");
1078 // api needed to prevent premature destruction
1079 APInt api = CFP->getValueAPF().bitcastToAPInt();
1080 const uint64_t* p = api.getRawData();
1082 int width = api.getBitWidth();
1083 for (int j=0; j<width; j+=4, shiftcount-=4) {
1084 unsigned int nibble = (word>>shiftcount) & 15;
1086 Out << (unsigned char)(nibble + '0');
1088 Out << (unsigned char)(nibble - 10 + 'A');
1089 if (shiftcount == 0 && j+4 < width) {
1093 shiftcount = width-j-4;
1099 if (isa<ConstantAggregateZero>(CV)) {
1100 Out << "zeroinitializer";
1104 if (const BlockAddress *BA = dyn_cast<BlockAddress>(CV)) {
1105 Out << "blockaddress(";
1106 WriteAsOperandInternal(Out, BA->getFunction(), &TypePrinter, Machine,
1109 WriteAsOperandInternal(Out, BA->getBasicBlock(), &TypePrinter, Machine,
1115 if (const ConstantArray *CA = dyn_cast<ConstantArray>(CV)) {
1116 Type *ETy = CA->getType()->getElementType();
1118 TypePrinter.print(ETy, Out);
1120 WriteAsOperandInternal(Out, CA->getOperand(0),
1121 &TypePrinter, Machine,
1123 for (unsigned i = 1, e = CA->getNumOperands(); i != e; ++i) {
1125 TypePrinter.print(ETy, Out);
1127 WriteAsOperandInternal(Out, CA->getOperand(i), &TypePrinter, Machine,
1134 if (const ConstantDataArray *CA = dyn_cast<ConstantDataArray>(CV)) {
1135 // As a special case, print the array as a string if it is an array of
1136 // i8 with ConstantInt values.
1137 if (CA->isString()) {
1139 PrintEscapedString(CA->getAsString(), Out);
1144 Type *ETy = CA->getType()->getElementType();
1146 TypePrinter.print(ETy, Out);
1148 WriteAsOperandInternal(Out, CA->getElementAsConstant(0),
1149 &TypePrinter, Machine,
1151 for (unsigned i = 1, e = CA->getNumElements(); i != e; ++i) {
1153 TypePrinter.print(ETy, Out);
1155 WriteAsOperandInternal(Out, CA->getElementAsConstant(i), &TypePrinter,
1163 if (const ConstantStruct *CS = dyn_cast<ConstantStruct>(CV)) {
1164 if (CS->getType()->isPacked())
1167 unsigned N = CS->getNumOperands();
1170 TypePrinter.print(CS->getOperand(0)->getType(), Out);
1173 WriteAsOperandInternal(Out, CS->getOperand(0), &TypePrinter, Machine,
1176 for (unsigned i = 1; i < N; i++) {
1178 TypePrinter.print(CS->getOperand(i)->getType(), Out);
1181 WriteAsOperandInternal(Out, CS->getOperand(i), &TypePrinter, Machine,
1188 if (CS->getType()->isPacked())
1193 if (isa<ConstantVector>(CV) || isa<ConstantDataVector>(CV)) {
1194 Type *ETy = CV->getType()->getVectorElementType();
1196 TypePrinter.print(ETy, Out);
1198 WriteAsOperandInternal(Out, CV->getAggregateElement(0U), &TypePrinter,
1200 for (unsigned i = 1, e = CV->getType()->getVectorNumElements(); i != e;++i){
1202 TypePrinter.print(ETy, Out);
1204 WriteAsOperandInternal(Out, CV->getAggregateElement(i), &TypePrinter,
1211 if (isa<ConstantPointerNull>(CV)) {
1216 if (isa<UndefValue>(CV)) {
1221 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV)) {
1222 Out << CE->getOpcodeName();
1223 WriteOptimizationInfo(Out, CE);
1224 if (CE->isCompare())
1225 Out << ' ' << getPredicateText(CE->getPredicate());
1228 for (User::const_op_iterator OI=CE->op_begin(); OI != CE->op_end(); ++OI) {
1229 TypePrinter.print((*OI)->getType(), Out);
1231 WriteAsOperandInternal(Out, *OI, &TypePrinter, Machine, Context);
1232 if (OI+1 != CE->op_end())
1236 if (CE->hasIndices()) {
1237 ArrayRef<unsigned> Indices = CE->getIndices();
1238 for (unsigned i = 0, e = Indices.size(); i != e; ++i)
1239 Out << ", " << Indices[i];
1244 TypePrinter.print(CE->getType(), Out);
1251 Out << "<placeholder or erroneous Constant>";
1254 static void WriteMDNodeBodyInternal(raw_ostream &Out, const MDNode *Node,
1255 TypePrinting *TypePrinter,
1256 SlotTracker *Machine,
1257 const Module *Context) {
1259 for (unsigned mi = 0, me = Node->getNumOperands(); mi != me; ++mi) {
1260 const Value *V = Node->getOperand(mi);
1264 TypePrinter->print(V->getType(), Out);
1266 WriteAsOperandInternal(Out, Node->getOperand(mi),
1267 TypePrinter, Machine, Context);
1276 // Full implementation of printing a Value as an operand with support for
1277 // TypePrinting, etc.
1278 static void WriteAsOperandInternal(raw_ostream &Out, const Value *V,
1279 TypePrinting *TypePrinter,
1280 SlotTracker *Machine,
1281 const Module *Context) {
1283 PrintLLVMName(Out, V);
1287 const Constant *CV = dyn_cast<Constant>(V);
1288 if (CV && !isa<GlobalValue>(CV)) {
1289 assert(TypePrinter && "Constants require TypePrinting!");
1290 WriteConstantInternal(Out, CV, *TypePrinter, Machine, Context);
1294 if (const InlineAsm *IA = dyn_cast<InlineAsm>(V)) {
1296 if (IA->hasSideEffects())
1297 Out << "sideeffect ";
1298 if (IA->isAlignStack())
1299 Out << "alignstack ";
1300 // We don't emit the AD_ATT dialect as it's the assumed default.
1301 if (IA->getDialect() == InlineAsm::AD_Intel)
1302 Out << "inteldialect ";
1304 PrintEscapedString(IA->getAsmString(), Out);
1306 PrintEscapedString(IA->getConstraintString(), Out);
1311 if (const MDNode *N = dyn_cast<MDNode>(V)) {
1312 if (N->isFunctionLocal()) {
1313 // Print metadata inline, not via slot reference number.
1314 WriteMDNodeBodyInternal(Out, N, TypePrinter, Machine, Context);
1319 if (N->isFunctionLocal())
1320 Machine = new SlotTracker(N->getFunction());
1322 Machine = new SlotTracker(Context);
1324 int Slot = Machine->getMetadataSlot(N);
1332 if (const MDString *MDS = dyn_cast<MDString>(V)) {
1334 PrintEscapedString(MDS->getString(), Out);
1341 // If we have a SlotTracker, use it.
1343 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
1344 Slot = Machine->getGlobalSlot(GV);
1347 Slot = Machine->getLocalSlot(V);
1349 // If the local value didn't succeed, then we may be referring to a value
1350 // from a different function. Translate it, as this can happen when using
1351 // address of blocks.
1353 if ((Machine = createSlotTracker(V))) {
1354 Slot = Machine->getLocalSlot(V);
1358 } else if ((Machine = createSlotTracker(V))) {
1359 // Otherwise, create one to get the # and then destroy it.
1360 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
1361 Slot = Machine->getGlobalSlot(GV);
1364 Slot = Machine->getLocalSlot(V);
1373 Out << Prefix << Slot;
1378 void AssemblyWriter::init() {
1381 TypePrinter.incorporateTypes(*TheModule);
1382 for (const Function &F : *TheModule)
1383 if (const Comdat *C = F.getComdat())
1385 for (const GlobalVariable &GV : TheModule->globals())
1386 if (const Comdat *C = GV.getComdat())
1391 AssemblyWriter::AssemblyWriter(formatted_raw_ostream &o, SlotTracker &Mac,
1393 AssemblyAnnotationWriter *AAW)
1394 : Out(o), TheModule(M), Machine(Mac), AnnotationWriter(AAW) {
1398 AssemblyWriter::AssemblyWriter(formatted_raw_ostream &o, const Module *M,
1399 AssemblyAnnotationWriter *AAW)
1400 : Out(o), TheModule(M), ModuleSlotTracker(createSlotTracker(M)),
1401 Machine(*ModuleSlotTracker), AnnotationWriter(AAW) {
1405 AssemblyWriter::~AssemblyWriter() { }
1407 void AssemblyWriter::writeOperand(const Value *Operand, bool PrintType) {
1409 Out << "<null operand!>";
1413 TypePrinter.print(Operand->getType(), Out);
1416 WriteAsOperandInternal(Out, Operand, &TypePrinter, &Machine, TheModule);
1419 void AssemblyWriter::writeAtomic(AtomicOrdering Ordering,
1420 SynchronizationScope SynchScope) {
1421 if (Ordering == NotAtomic)
1424 switch (SynchScope) {
1425 case SingleThread: Out << " singlethread"; break;
1426 case CrossThread: break;
1430 default: Out << " <bad ordering " << int(Ordering) << ">"; break;
1431 case Unordered: Out << " unordered"; break;
1432 case Monotonic: Out << " monotonic"; break;
1433 case Acquire: Out << " acquire"; break;
1434 case Release: Out << " release"; break;
1435 case AcquireRelease: Out << " acq_rel"; break;
1436 case SequentiallyConsistent: Out << " seq_cst"; break;
1440 void AssemblyWriter::writeAtomicCmpXchg(AtomicOrdering SuccessOrdering,
1441 AtomicOrdering FailureOrdering,
1442 SynchronizationScope SynchScope) {
1443 assert(SuccessOrdering != NotAtomic && FailureOrdering != NotAtomic);
1445 switch (SynchScope) {
1446 case SingleThread: Out << " singlethread"; break;
1447 case CrossThread: break;
1450 switch (SuccessOrdering) {
1451 default: Out << " <bad ordering " << int(SuccessOrdering) << ">"; break;
1452 case Unordered: Out << " unordered"; break;
1453 case Monotonic: Out << " monotonic"; break;
1454 case Acquire: Out << " acquire"; break;
1455 case Release: Out << " release"; break;
1456 case AcquireRelease: Out << " acq_rel"; break;
1457 case SequentiallyConsistent: Out << " seq_cst"; break;
1460 switch (FailureOrdering) {
1461 default: Out << " <bad ordering " << int(FailureOrdering) << ">"; break;
1462 case Unordered: Out << " unordered"; break;
1463 case Monotonic: Out << " monotonic"; break;
1464 case Acquire: Out << " acquire"; break;
1465 case Release: Out << " release"; break;
1466 case AcquireRelease: Out << " acq_rel"; break;
1467 case SequentiallyConsistent: Out << " seq_cst"; break;
1471 void AssemblyWriter::writeParamOperand(const Value *Operand,
1472 AttributeSet Attrs, unsigned Idx) {
1474 Out << "<null operand!>";
1479 TypePrinter.print(Operand->getType(), Out);
1480 // Print parameter attributes list
1481 if (Attrs.hasAttributes(Idx))
1482 Out << ' ' << Attrs.getAsString(Idx);
1484 // Print the operand
1485 WriteAsOperandInternal(Out, Operand, &TypePrinter, &Machine, TheModule);
1488 void AssemblyWriter::printModule(const Module *M) {
1489 Machine.initialize();
1491 if (shouldPreserveAssemblyUseListOrder())
1492 UseListOrders = predictUseListOrder(M);
1494 if (!M->getModuleIdentifier().empty() &&
1495 // Don't print the ID if it will start a new line (which would
1496 // require a comment char before it).
1497 M->getModuleIdentifier().find('\n') == std::string::npos)
1498 Out << "; ModuleID = '" << M->getModuleIdentifier() << "'\n";
1500 const std::string &DL = M->getDataLayoutStr();
1502 Out << "target datalayout = \"" << DL << "\"\n";
1503 if (!M->getTargetTriple().empty())
1504 Out << "target triple = \"" << M->getTargetTriple() << "\"\n";
1506 if (!M->getModuleInlineAsm().empty()) {
1507 // Split the string into lines, to make it easier to read the .ll file.
1508 std::string Asm = M->getModuleInlineAsm();
1510 size_t NewLine = Asm.find_first_of('\n', CurPos);
1512 while (NewLine != std::string::npos) {
1513 // We found a newline, print the portion of the asm string from the
1514 // last newline up to this newline.
1515 Out << "module asm \"";
1516 PrintEscapedString(std::string(Asm.begin()+CurPos, Asm.begin()+NewLine),
1520 NewLine = Asm.find_first_of('\n', CurPos);
1522 std::string rest(Asm.begin()+CurPos, Asm.end());
1523 if (!rest.empty()) {
1524 Out << "module asm \"";
1525 PrintEscapedString(rest, Out);
1530 printTypeIdentities();
1532 // Output all comdats.
1533 if (!Comdats.empty())
1535 for (const Comdat *C : Comdats) {
1537 if (C != Comdats.back())
1541 // Output all globals.
1542 if (!M->global_empty()) Out << '\n';
1543 for (Module::const_global_iterator I = M->global_begin(), E = M->global_end();
1545 printGlobal(I); Out << '\n';
1548 // Output all aliases.
1549 if (!M->alias_empty()) Out << "\n";
1550 for (Module::const_alias_iterator I = M->alias_begin(), E = M->alias_end();
1554 // Output global use-lists.
1555 printUseLists(nullptr);
1557 // Output all of the functions.
1558 for (Module::const_iterator I = M->begin(), E = M->end(); I != E; ++I)
1560 assert(UseListOrders.empty() && "All use-lists should have been consumed");
1562 // Output all attribute groups.
1563 if (!Machine.as_empty()) {
1565 writeAllAttributeGroups();
1568 // Output named metadata.
1569 if (!M->named_metadata_empty()) Out << '\n';
1571 for (Module::const_named_metadata_iterator I = M->named_metadata_begin(),
1572 E = M->named_metadata_end(); I != E; ++I)
1573 printNamedMDNode(I);
1576 if (!Machine.mdn_empty()) {
1582 void AssemblyWriter::printNamedMDNode(const NamedMDNode *NMD) {
1584 StringRef Name = NMD->getName();
1586 Out << "<empty name> ";
1588 if (isalpha(static_cast<unsigned char>(Name[0])) ||
1589 Name[0] == '-' || Name[0] == '$' ||
1590 Name[0] == '.' || Name[0] == '_')
1593 Out << '\\' << hexdigit(Name[0] >> 4) << hexdigit(Name[0] & 0x0F);
1594 for (unsigned i = 1, e = Name.size(); i != e; ++i) {
1595 unsigned char C = Name[i];
1596 if (isalnum(static_cast<unsigned char>(C)) || C == '-' || C == '$' ||
1597 C == '.' || C == '_')
1600 Out << '\\' << hexdigit(C >> 4) << hexdigit(C & 0x0F);
1604 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
1606 int Slot = Machine.getMetadataSlot(NMD->getOperand(i));
1616 static void PrintLinkage(GlobalValue::LinkageTypes LT,
1617 formatted_raw_ostream &Out) {
1619 case GlobalValue::ExternalLinkage: break;
1620 case GlobalValue::PrivateLinkage: Out << "private "; break;
1621 case GlobalValue::InternalLinkage: Out << "internal "; break;
1622 case GlobalValue::LinkOnceAnyLinkage: Out << "linkonce "; break;
1623 case GlobalValue::LinkOnceODRLinkage: Out << "linkonce_odr "; break;
1624 case GlobalValue::WeakAnyLinkage: Out << "weak "; break;
1625 case GlobalValue::WeakODRLinkage: Out << "weak_odr "; break;
1626 case GlobalValue::CommonLinkage: Out << "common "; break;
1627 case GlobalValue::AppendingLinkage: Out << "appending "; break;
1628 case GlobalValue::ExternalWeakLinkage: Out << "extern_weak "; break;
1629 case GlobalValue::AvailableExternallyLinkage:
1630 Out << "available_externally ";
1636 static void PrintVisibility(GlobalValue::VisibilityTypes Vis,
1637 formatted_raw_ostream &Out) {
1639 case GlobalValue::DefaultVisibility: break;
1640 case GlobalValue::HiddenVisibility: Out << "hidden "; break;
1641 case GlobalValue::ProtectedVisibility: Out << "protected "; break;
1645 static void PrintDLLStorageClass(GlobalValue::DLLStorageClassTypes SCT,
1646 formatted_raw_ostream &Out) {
1648 case GlobalValue::DefaultStorageClass: break;
1649 case GlobalValue::DLLImportStorageClass: Out << "dllimport "; break;
1650 case GlobalValue::DLLExportStorageClass: Out << "dllexport "; break;
1654 static void PrintThreadLocalModel(GlobalVariable::ThreadLocalMode TLM,
1655 formatted_raw_ostream &Out) {
1657 case GlobalVariable::NotThreadLocal:
1659 case GlobalVariable::GeneralDynamicTLSModel:
1660 Out << "thread_local ";
1662 case GlobalVariable::LocalDynamicTLSModel:
1663 Out << "thread_local(localdynamic) ";
1665 case GlobalVariable::InitialExecTLSModel:
1666 Out << "thread_local(initialexec) ";
1668 case GlobalVariable::LocalExecTLSModel:
1669 Out << "thread_local(localexec) ";
1674 void AssemblyWriter::printGlobal(const GlobalVariable *GV) {
1675 if (GV->isMaterializable())
1676 Out << "; Materializable\n";
1678 WriteAsOperandInternal(Out, GV, &TypePrinter, &Machine, GV->getParent());
1681 if (!GV->hasInitializer() && GV->hasExternalLinkage())
1684 PrintLinkage(GV->getLinkage(), Out);
1685 PrintVisibility(GV->getVisibility(), Out);
1686 PrintDLLStorageClass(GV->getDLLStorageClass(), Out);
1687 PrintThreadLocalModel(GV->getThreadLocalMode(), Out);
1688 if (GV->hasUnnamedAddr())
1689 Out << "unnamed_addr ";
1691 if (unsigned AddressSpace = GV->getType()->getAddressSpace())
1692 Out << "addrspace(" << AddressSpace << ") ";
1693 if (GV->isExternallyInitialized()) Out << "externally_initialized ";
1694 Out << (GV->isConstant() ? "constant " : "global ");
1695 TypePrinter.print(GV->getType()->getElementType(), Out);
1697 if (GV->hasInitializer()) {
1699 writeOperand(GV->getInitializer(), false);
1702 if (GV->hasSection()) {
1703 Out << ", section \"";
1704 PrintEscapedString(GV->getSection(), Out);
1707 if (GV->hasComdat()) {
1709 PrintLLVMName(Out, GV->getComdat()->getName(), ComdatPrefix);
1711 if (GV->getAlignment())
1712 Out << ", align " << GV->getAlignment();
1714 printInfoComment(*GV);
1717 void AssemblyWriter::printAlias(const GlobalAlias *GA) {
1718 if (GA->isMaterializable())
1719 Out << "; Materializable\n";
1721 // Don't crash when dumping partially built GA
1723 Out << "<<nameless>> = ";
1725 PrintLLVMName(Out, GA);
1728 PrintLinkage(GA->getLinkage(), Out);
1729 PrintVisibility(GA->getVisibility(), Out);
1730 PrintDLLStorageClass(GA->getDLLStorageClass(), Out);
1731 PrintThreadLocalModel(GA->getThreadLocalMode(), Out);
1732 if (GA->hasUnnamedAddr())
1733 Out << "unnamed_addr ";
1737 const Constant *Aliasee = GA->getAliasee();
1740 TypePrinter.print(GA->getType(), Out);
1741 Out << " <<NULL ALIASEE>>";
1743 writeOperand(Aliasee, !isa<ConstantExpr>(Aliasee));
1746 printInfoComment(*GA);
1750 void AssemblyWriter::printComdat(const Comdat *C) {
1754 void AssemblyWriter::printTypeIdentities() {
1755 if (TypePrinter.NumberedTypes.empty() &&
1756 TypePrinter.NamedTypes.empty())
1761 // We know all the numbers that each type is used and we know that it is a
1762 // dense assignment. Convert the map to an index table.
1763 std::vector<StructType*> NumberedTypes(TypePrinter.NumberedTypes.size());
1764 for (DenseMap<StructType*, unsigned>::iterator I =
1765 TypePrinter.NumberedTypes.begin(), E = TypePrinter.NumberedTypes.end();
1767 assert(I->second < NumberedTypes.size() && "Didn't get a dense numbering?");
1768 NumberedTypes[I->second] = I->first;
1771 // Emit all numbered types.
1772 for (unsigned i = 0, e = NumberedTypes.size(); i != e; ++i) {
1773 Out << '%' << i << " = type ";
1775 // Make sure we print out at least one level of the type structure, so
1776 // that we do not get %2 = type %2
1777 TypePrinter.printStructBody(NumberedTypes[i], Out);
1781 for (unsigned i = 0, e = TypePrinter.NamedTypes.size(); i != e; ++i) {
1782 PrintLLVMName(Out, TypePrinter.NamedTypes[i]->getName(), LocalPrefix);
1785 // Make sure we print out at least one level of the type structure, so
1786 // that we do not get %FILE = type %FILE
1787 TypePrinter.printStructBody(TypePrinter.NamedTypes[i], Out);
1792 /// printFunction - Print all aspects of a function.
1794 void AssemblyWriter::printFunction(const Function *F) {
1795 // Print out the return type and name.
1798 if (AnnotationWriter) AnnotationWriter->emitFunctionAnnot(F, Out);
1800 if (F->isMaterializable())
1801 Out << "; Materializable\n";
1803 const AttributeSet &Attrs = F->getAttributes();
1804 if (Attrs.hasAttributes(AttributeSet::FunctionIndex)) {
1805 AttributeSet AS = Attrs.getFnAttributes();
1806 std::string AttrStr;
1809 for (unsigned E = AS.getNumSlots(); Idx != E; ++Idx)
1810 if (AS.getSlotIndex(Idx) == AttributeSet::FunctionIndex)
1813 for (AttributeSet::iterator I = AS.begin(Idx), E = AS.end(Idx);
1815 Attribute Attr = *I;
1816 if (!Attr.isStringAttribute()) {
1817 if (!AttrStr.empty()) AttrStr += ' ';
1818 AttrStr += Attr.getAsString();
1822 if (!AttrStr.empty())
1823 Out << "; Function Attrs: " << AttrStr << '\n';
1826 if (F->isDeclaration())
1831 PrintLinkage(F->getLinkage(), Out);
1832 PrintVisibility(F->getVisibility(), Out);
1833 PrintDLLStorageClass(F->getDLLStorageClass(), Out);
1835 // Print the calling convention.
1836 if (F->getCallingConv() != CallingConv::C) {
1837 PrintCallingConv(F->getCallingConv(), Out);
1841 FunctionType *FT = F->getFunctionType();
1842 if (Attrs.hasAttributes(AttributeSet::ReturnIndex))
1843 Out << Attrs.getAsString(AttributeSet::ReturnIndex) << ' ';
1844 TypePrinter.print(F->getReturnType(), Out);
1846 WriteAsOperandInternal(Out, F, &TypePrinter, &Machine, F->getParent());
1848 Machine.incorporateFunction(F);
1850 // Loop over the arguments, printing them...
1853 if (!F->isDeclaration()) {
1854 // If this isn't a declaration, print the argument names as well.
1855 for (Function::const_arg_iterator I = F->arg_begin(), E = F->arg_end();
1857 // Insert commas as we go... the first arg doesn't get a comma
1858 if (I != F->arg_begin()) Out << ", ";
1859 printArgument(I, Attrs, Idx);
1863 // Otherwise, print the types from the function type.
1864 for (unsigned i = 0, e = FT->getNumParams(); i != e; ++i) {
1865 // Insert commas as we go... the first arg doesn't get a comma
1869 TypePrinter.print(FT->getParamType(i), Out);
1871 if (Attrs.hasAttributes(i+1))
1872 Out << ' ' << Attrs.getAsString(i+1);
1876 // Finish printing arguments...
1877 if (FT->isVarArg()) {
1878 if (FT->getNumParams()) Out << ", ";
1879 Out << "..."; // Output varargs portion of signature!
1882 if (F->hasUnnamedAddr())
1883 Out << " unnamed_addr";
1884 if (Attrs.hasAttributes(AttributeSet::FunctionIndex))
1885 Out << " #" << Machine.getAttributeGroupSlot(Attrs.getFnAttributes());
1886 if (F->hasSection()) {
1887 Out << " section \"";
1888 PrintEscapedString(F->getSection(), Out);
1891 if (F->hasComdat()) {
1893 PrintLLVMName(Out, F->getComdat()->getName(), ComdatPrefix);
1895 if (F->getAlignment())
1896 Out << " align " << F->getAlignment();
1898 Out << " gc \"" << F->getGC() << '"';
1899 if (F->hasPrefixData()) {
1901 writeOperand(F->getPrefixData(), true);
1903 if (F->isDeclaration()) {
1907 // Output all of the function's basic blocks.
1908 for (Function::const_iterator I = F->begin(), E = F->end(); I != E; ++I)
1911 // Output the function's use-lists.
1917 Machine.purgeFunction();
1920 /// printArgument - This member is called for every argument that is passed into
1921 /// the function. Simply print it out
1923 void AssemblyWriter::printArgument(const Argument *Arg,
1924 AttributeSet Attrs, unsigned Idx) {
1926 TypePrinter.print(Arg->getType(), Out);
1928 // Output parameter attributes list
1929 if (Attrs.hasAttributes(Idx))
1930 Out << ' ' << Attrs.getAsString(Idx);
1932 // Output name, if available...
1933 if (Arg->hasName()) {
1935 PrintLLVMName(Out, Arg);
1939 /// printBasicBlock - This member is called for each basic block in a method.
1941 void AssemblyWriter::printBasicBlock(const BasicBlock *BB) {
1942 if (BB->hasName()) { // Print out the label if it exists...
1944 PrintLLVMName(Out, BB->getName(), LabelPrefix);
1946 } else if (!BB->use_empty()) { // Don't print block # of no uses...
1947 Out << "\n; <label>:";
1948 int Slot = Machine.getLocalSlot(BB);
1955 if (!BB->getParent()) {
1956 Out.PadToColumn(50);
1957 Out << "; Error: Block without parent!";
1958 } else if (BB != &BB->getParent()->getEntryBlock()) { // Not the entry block?
1959 // Output predecessors for the block.
1960 Out.PadToColumn(50);
1962 const_pred_iterator PI = pred_begin(BB), PE = pred_end(BB);
1965 Out << " No predecessors!";
1968 writeOperand(*PI, false);
1969 for (++PI; PI != PE; ++PI) {
1971 writeOperand(*PI, false);
1978 if (AnnotationWriter) AnnotationWriter->emitBasicBlockStartAnnot(BB, Out);
1980 // Output all of the instructions in the basic block...
1981 for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I != E; ++I) {
1982 printInstructionLine(*I);
1985 if (AnnotationWriter) AnnotationWriter->emitBasicBlockEndAnnot(BB, Out);
1988 /// printInstructionLine - Print an instruction and a newline character.
1989 void AssemblyWriter::printInstructionLine(const Instruction &I) {
1990 printInstruction(I);
1994 /// printInfoComment - Print a little comment after the instruction indicating
1995 /// which slot it occupies.
1997 void AssemblyWriter::printInfoComment(const Value &V) {
1998 if (AnnotationWriter)
1999 AnnotationWriter->printInfoComment(V, Out);
2002 // This member is called for each Instruction in a function..
2003 void AssemblyWriter::printInstruction(const Instruction &I) {
2004 if (AnnotationWriter) AnnotationWriter->emitInstructionAnnot(&I, Out);
2006 // Print out indentation for an instruction.
2009 // Print out name if it exists...
2011 PrintLLVMName(Out, &I);
2013 } else if (!I.getType()->isVoidTy()) {
2014 // Print out the def slot taken.
2015 int SlotNum = Machine.getLocalSlot(&I);
2017 Out << "<badref> = ";
2019 Out << '%' << SlotNum << " = ";
2022 if (const CallInst *CI = dyn_cast<CallInst>(&I)) {
2023 if (CI->isMustTailCall())
2025 else if (CI->isTailCall())
2029 // Print out the opcode...
2030 Out << I.getOpcodeName();
2032 // If this is an atomic load or store, print out the atomic marker.
2033 if ((isa<LoadInst>(I) && cast<LoadInst>(I).isAtomic()) ||
2034 (isa<StoreInst>(I) && cast<StoreInst>(I).isAtomic()))
2037 if (isa<AtomicCmpXchgInst>(I) && cast<AtomicCmpXchgInst>(I).isWeak())
2040 // If this is a volatile operation, print out the volatile marker.
2041 if ((isa<LoadInst>(I) && cast<LoadInst>(I).isVolatile()) ||
2042 (isa<StoreInst>(I) && cast<StoreInst>(I).isVolatile()) ||
2043 (isa<AtomicCmpXchgInst>(I) && cast<AtomicCmpXchgInst>(I).isVolatile()) ||
2044 (isa<AtomicRMWInst>(I) && cast<AtomicRMWInst>(I).isVolatile()))
2047 // Print out optimization information.
2048 WriteOptimizationInfo(Out, &I);
2050 // Print out the compare instruction predicates
2051 if (const CmpInst *CI = dyn_cast<CmpInst>(&I))
2052 Out << ' ' << getPredicateText(CI->getPredicate());
2054 // Print out the atomicrmw operation
2055 if (const AtomicRMWInst *RMWI = dyn_cast<AtomicRMWInst>(&I))
2056 writeAtomicRMWOperation(Out, RMWI->getOperation());
2058 // Print out the type of the operands...
2059 const Value *Operand = I.getNumOperands() ? I.getOperand(0) : nullptr;
2061 // Special case conditional branches to swizzle the condition out to the front
2062 if (isa<BranchInst>(I) && cast<BranchInst>(I).isConditional()) {
2063 const BranchInst &BI(cast<BranchInst>(I));
2065 writeOperand(BI.getCondition(), true);
2067 writeOperand(BI.getSuccessor(0), true);
2069 writeOperand(BI.getSuccessor(1), true);
2071 } else if (isa<SwitchInst>(I)) {
2072 const SwitchInst& SI(cast<SwitchInst>(I));
2073 // Special case switch instruction to get formatting nice and correct.
2075 writeOperand(SI.getCondition(), true);
2077 writeOperand(SI.getDefaultDest(), true);
2079 for (SwitchInst::ConstCaseIt i = SI.case_begin(), e = SI.case_end();
2082 writeOperand(i.getCaseValue(), true);
2084 writeOperand(i.getCaseSuccessor(), true);
2087 } else if (isa<IndirectBrInst>(I)) {
2088 // Special case indirectbr instruction to get formatting nice and correct.
2090 writeOperand(Operand, true);
2093 for (unsigned i = 1, e = I.getNumOperands(); i != e; ++i) {
2096 writeOperand(I.getOperand(i), true);
2099 } else if (const PHINode *PN = dyn_cast<PHINode>(&I)) {
2101 TypePrinter.print(I.getType(), Out);
2104 for (unsigned op = 0, Eop = PN->getNumIncomingValues(); op < Eop; ++op) {
2105 if (op) Out << ", ";
2107 writeOperand(PN->getIncomingValue(op), false); Out << ", ";
2108 writeOperand(PN->getIncomingBlock(op), false); Out << " ]";
2110 } else if (const ExtractValueInst *EVI = dyn_cast<ExtractValueInst>(&I)) {
2112 writeOperand(I.getOperand(0), true);
2113 for (const unsigned *i = EVI->idx_begin(), *e = EVI->idx_end(); i != e; ++i)
2115 } else if (const InsertValueInst *IVI = dyn_cast<InsertValueInst>(&I)) {
2117 writeOperand(I.getOperand(0), true); Out << ", ";
2118 writeOperand(I.getOperand(1), true);
2119 for (const unsigned *i = IVI->idx_begin(), *e = IVI->idx_end(); i != e; ++i)
2121 } else if (const LandingPadInst *LPI = dyn_cast<LandingPadInst>(&I)) {
2123 TypePrinter.print(I.getType(), Out);
2124 Out << " personality ";
2125 writeOperand(I.getOperand(0), true); Out << '\n';
2127 if (LPI->isCleanup())
2130 for (unsigned i = 0, e = LPI->getNumClauses(); i != e; ++i) {
2131 if (i != 0 || LPI->isCleanup()) Out << "\n";
2132 if (LPI->isCatch(i))
2137 writeOperand(LPI->getClause(i), true);
2139 } else if (isa<ReturnInst>(I) && !Operand) {
2141 } else if (const CallInst *CI = dyn_cast<CallInst>(&I)) {
2142 // Print the calling convention being used.
2143 if (CI->getCallingConv() != CallingConv::C) {
2145 PrintCallingConv(CI->getCallingConv(), Out);
2148 Operand = CI->getCalledValue();
2149 PointerType *PTy = cast<PointerType>(Operand->getType());
2150 FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
2151 Type *RetTy = FTy->getReturnType();
2152 const AttributeSet &PAL = CI->getAttributes();
2154 if (PAL.hasAttributes(AttributeSet::ReturnIndex))
2155 Out << ' ' << PAL.getAsString(AttributeSet::ReturnIndex);
2157 // If possible, print out the short form of the call instruction. We can
2158 // only do this if the first argument is a pointer to a nonvararg function,
2159 // and if the return type is not a pointer to a function.
2162 if (!FTy->isVarArg() &&
2163 (!RetTy->isPointerTy() ||
2164 !cast<PointerType>(RetTy)->getElementType()->isFunctionTy())) {
2165 TypePrinter.print(RetTy, Out);
2167 writeOperand(Operand, false);
2169 writeOperand(Operand, true);
2172 for (unsigned op = 0, Eop = CI->getNumArgOperands(); op < Eop; ++op) {
2175 writeParamOperand(CI->getArgOperand(op), PAL, op + 1);
2178 // Emit an ellipsis if this is a musttail call in a vararg function. This
2179 // is only to aid readability, musttail calls forward varargs by default.
2180 if (CI->isMustTailCall() && CI->getParent() &&
2181 CI->getParent()->getParent() &&
2182 CI->getParent()->getParent()->isVarArg())
2186 if (PAL.hasAttributes(AttributeSet::FunctionIndex))
2187 Out << " #" << Machine.getAttributeGroupSlot(PAL.getFnAttributes());
2188 } else if (const InvokeInst *II = dyn_cast<InvokeInst>(&I)) {
2189 Operand = II->getCalledValue();
2190 PointerType *PTy = cast<PointerType>(Operand->getType());
2191 FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
2192 Type *RetTy = FTy->getReturnType();
2193 const AttributeSet &PAL = II->getAttributes();
2195 // Print the calling convention being used.
2196 if (II->getCallingConv() != CallingConv::C) {
2198 PrintCallingConv(II->getCallingConv(), Out);
2201 if (PAL.hasAttributes(AttributeSet::ReturnIndex))
2202 Out << ' ' << PAL.getAsString(AttributeSet::ReturnIndex);
2204 // If possible, print out the short form of the invoke instruction. We can
2205 // only do this if the first argument is a pointer to a nonvararg function,
2206 // and if the return type is not a pointer to a function.
2209 if (!FTy->isVarArg() &&
2210 (!RetTy->isPointerTy() ||
2211 !cast<PointerType>(RetTy)->getElementType()->isFunctionTy())) {
2212 TypePrinter.print(RetTy, Out);
2214 writeOperand(Operand, false);
2216 writeOperand(Operand, true);
2219 for (unsigned op = 0, Eop = II->getNumArgOperands(); op < Eop; ++op) {
2222 writeParamOperand(II->getArgOperand(op), PAL, op + 1);
2226 if (PAL.hasAttributes(AttributeSet::FunctionIndex))
2227 Out << " #" << Machine.getAttributeGroupSlot(PAL.getFnAttributes());
2230 writeOperand(II->getNormalDest(), true);
2232 writeOperand(II->getUnwindDest(), true);
2234 } else if (const AllocaInst *AI = dyn_cast<AllocaInst>(&I)) {
2236 if (AI->isUsedWithInAlloca())
2238 TypePrinter.print(AI->getAllocatedType(), Out);
2239 if (!AI->getArraySize() || AI->isArrayAllocation()) {
2241 writeOperand(AI->getArraySize(), true);
2243 if (AI->getAlignment()) {
2244 Out << ", align " << AI->getAlignment();
2246 } else if (isa<CastInst>(I)) {
2249 writeOperand(Operand, true); // Work with broken code
2252 TypePrinter.print(I.getType(), Out);
2253 } else if (isa<VAArgInst>(I)) {
2256 writeOperand(Operand, true); // Work with broken code
2259 TypePrinter.print(I.getType(), Out);
2260 } else if (Operand) { // Print the normal way.
2262 // PrintAllTypes - Instructions who have operands of all the same type
2263 // omit the type from all but the first operand. If the instruction has
2264 // different type operands (for example br), then they are all printed.
2265 bool PrintAllTypes = false;
2266 Type *TheType = Operand->getType();
2268 // Select, Store and ShuffleVector always print all types.
2269 if (isa<SelectInst>(I) || isa<StoreInst>(I) || isa<ShuffleVectorInst>(I)
2270 || isa<ReturnInst>(I)) {
2271 PrintAllTypes = true;
2273 for (unsigned i = 1, E = I.getNumOperands(); i != E; ++i) {
2274 Operand = I.getOperand(i);
2275 // note that Operand shouldn't be null, but the test helps make dump()
2276 // more tolerant of malformed IR
2277 if (Operand && Operand->getType() != TheType) {
2278 PrintAllTypes = true; // We have differing types! Print them all!
2284 if (!PrintAllTypes) {
2286 TypePrinter.print(TheType, Out);
2290 for (unsigned i = 0, E = I.getNumOperands(); i != E; ++i) {
2292 writeOperand(I.getOperand(i), PrintAllTypes);
2296 // Print atomic ordering/alignment for memory operations
2297 if (const LoadInst *LI = dyn_cast<LoadInst>(&I)) {
2299 writeAtomic(LI->getOrdering(), LI->getSynchScope());
2300 if (LI->getAlignment())
2301 Out << ", align " << LI->getAlignment();
2302 } else if (const StoreInst *SI = dyn_cast<StoreInst>(&I)) {
2304 writeAtomic(SI->getOrdering(), SI->getSynchScope());
2305 if (SI->getAlignment())
2306 Out << ", align " << SI->getAlignment();
2307 } else if (const AtomicCmpXchgInst *CXI = dyn_cast<AtomicCmpXchgInst>(&I)) {
2308 writeAtomicCmpXchg(CXI->getSuccessOrdering(), CXI->getFailureOrdering(),
2309 CXI->getSynchScope());
2310 } else if (const AtomicRMWInst *RMWI = dyn_cast<AtomicRMWInst>(&I)) {
2311 writeAtomic(RMWI->getOrdering(), RMWI->getSynchScope());
2312 } else if (const FenceInst *FI = dyn_cast<FenceInst>(&I)) {
2313 writeAtomic(FI->getOrdering(), FI->getSynchScope());
2316 // Print Metadata info.
2317 SmallVector<std::pair<unsigned, MDNode*>, 4> InstMD;
2318 I.getAllMetadata(InstMD);
2319 if (!InstMD.empty()) {
2320 SmallVector<StringRef, 8> MDNames;
2321 I.getType()->getContext().getMDKindNames(MDNames);
2322 for (unsigned i = 0, e = InstMD.size(); i != e; ++i) {
2323 unsigned Kind = InstMD[i].first;
2324 if (Kind < MDNames.size()) {
2325 Out << ", !" << MDNames[Kind];
2327 Out << ", !<unknown kind #" << Kind << ">";
2330 WriteAsOperandInternal(Out, InstMD[i].second, &TypePrinter, &Machine,
2334 printInfoComment(I);
2337 static void WriteMDNodeComment(const MDNode *Node,
2338 formatted_raw_ostream &Out) {
2339 if (Node->getNumOperands() < 1)
2342 Value *Op = Node->getOperand(0);
2343 if (!Op || !isa<ConstantInt>(Op) || cast<ConstantInt>(Op)->getBitWidth() < 32)
2346 DIDescriptor Desc(Node);
2350 unsigned Tag = Desc.getTag();
2351 Out.PadToColumn(50);
2352 if (dwarf::TagString(Tag)) {
2355 } else if (Tag == dwarf::DW_TAG_user_base) {
2356 Out << "; [ DW_TAG_user_base ]";
2360 void AssemblyWriter::writeMDNode(unsigned Slot, const MDNode *Node) {
2361 Out << '!' << Slot << " = metadata ";
2362 printMDNodeBody(Node);
2365 void AssemblyWriter::writeAllMDNodes() {
2366 SmallVector<const MDNode *, 16> Nodes;
2367 Nodes.resize(Machine.mdn_size());
2368 for (SlotTracker::mdn_iterator I = Machine.mdn_begin(), E = Machine.mdn_end();
2370 Nodes[I->second] = cast<MDNode>(I->first);
2372 for (unsigned i = 0, e = Nodes.size(); i != e; ++i) {
2373 writeMDNode(i, Nodes[i]);
2377 void AssemblyWriter::printMDNodeBody(const MDNode *Node) {
2378 WriteMDNodeBodyInternal(Out, Node, &TypePrinter, &Machine, TheModule);
2379 WriteMDNodeComment(Node, Out);
2383 void AssemblyWriter::writeAllAttributeGroups() {
2384 std::vector<std::pair<AttributeSet, unsigned> > asVec;
2385 asVec.resize(Machine.as_size());
2387 for (SlotTracker::as_iterator I = Machine.as_begin(), E = Machine.as_end();
2389 asVec[I->second] = *I;
2391 for (std::vector<std::pair<AttributeSet, unsigned> >::iterator
2392 I = asVec.begin(), E = asVec.end(); I != E; ++I)
2393 Out << "attributes #" << I->second << " = { "
2394 << I->first.getAsString(AttributeSet::FunctionIndex, true) << " }\n";
2399 void AssemblyWriter::printUseListOrder(const UseListOrder &Order) {
2400 bool IsInFunction = Machine.getFunction();
2404 Out << "uselistorder";
2405 if (const BasicBlock *BB =
2406 IsInFunction ? nullptr : dyn_cast<BasicBlock>(Order.V)) {
2408 writeOperand(BB->getParent(), false);
2410 writeOperand(BB, false);
2413 writeOperand(Order.V, true);
2417 assert(Order.Shuffle.size() >= 2 && "Shuffle too small");
2418 Out << Order.Shuffle[0];
2419 for (unsigned I = 1, E = Order.Shuffle.size(); I != E; ++I)
2420 Out << ", " << Order.Shuffle[I];
2424 void AssemblyWriter::printUseLists(const Function *F) {
2426 [&]() { return !UseListOrders.empty() && UseListOrders.back().F == F; };
2431 Out << "\n; uselistorder directives\n";
2433 printUseListOrder(UseListOrders.back());
2434 UseListOrders.pop_back();
2438 //===----------------------------------------------------------------------===//
2439 // External Interface declarations
2440 //===----------------------------------------------------------------------===//
2442 void Module::print(raw_ostream &ROS, AssemblyAnnotationWriter *AAW) const {
2443 SlotTracker SlotTable(this);
2444 formatted_raw_ostream OS(ROS);
2445 AssemblyWriter W(OS, SlotTable, this, AAW);
2446 W.printModule(this);
2449 void NamedMDNode::print(raw_ostream &ROS) const {
2450 SlotTracker SlotTable(getParent());
2451 formatted_raw_ostream OS(ROS);
2452 AssemblyWriter W(OS, SlotTable, getParent(), nullptr);
2453 W.printNamedMDNode(this);
2456 void Comdat::print(raw_ostream &ROS) const {
2457 PrintLLVMName(ROS, getName(), ComdatPrefix);
2458 ROS << " = comdat ";
2460 switch (getSelectionKind()) {
2464 case Comdat::ExactMatch:
2465 ROS << "exactmatch";
2467 case Comdat::Largest:
2470 case Comdat::NoDuplicates:
2471 ROS << "noduplicates";
2473 case Comdat::SameSize:
2481 void Type::print(raw_ostream &OS) const {
2483 TP.print(const_cast<Type*>(this), OS);
2485 // If the type is a named struct type, print the body as well.
2486 if (StructType *STy = dyn_cast<StructType>(const_cast<Type*>(this)))
2487 if (!STy->isLiteral()) {
2489 TP.printStructBody(STy, OS);
2493 void Value::print(raw_ostream &ROS) const {
2494 formatted_raw_ostream OS(ROS);
2495 if (const Instruction *I = dyn_cast<Instruction>(this)) {
2496 const Function *F = I->getParent() ? I->getParent()->getParent() : nullptr;
2497 SlotTracker SlotTable(F);
2498 AssemblyWriter W(OS, SlotTable, getModuleFromVal(I), nullptr);
2499 W.printInstruction(*I);
2500 } else if (const BasicBlock *BB = dyn_cast<BasicBlock>(this)) {
2501 SlotTracker SlotTable(BB->getParent());
2502 AssemblyWriter W(OS, SlotTable, getModuleFromVal(BB), nullptr);
2503 W.printBasicBlock(BB);
2504 } else if (const GlobalValue *GV = dyn_cast<GlobalValue>(this)) {
2505 SlotTracker SlotTable(GV->getParent());
2506 AssemblyWriter W(OS, SlotTable, GV->getParent(), nullptr);
2507 if (const GlobalVariable *V = dyn_cast<GlobalVariable>(GV))
2509 else if (const Function *F = dyn_cast<Function>(GV))
2512 W.printAlias(cast<GlobalAlias>(GV));
2513 } else if (const MDNode *N = dyn_cast<MDNode>(this)) {
2514 const Function *F = N->getFunction();
2515 SlotTracker SlotTable(F);
2516 AssemblyWriter W(OS, SlotTable, F ? F->getParent() : nullptr, nullptr);
2517 W.printMDNodeBody(N);
2518 } else if (const Constant *C = dyn_cast<Constant>(this)) {
2519 TypePrinting TypePrinter;
2520 TypePrinter.print(C->getType(), OS);
2522 WriteConstantInternal(OS, C, TypePrinter, nullptr, nullptr);
2523 } else if (isa<InlineAsm>(this) || isa<MDString>(this) ||
2524 isa<Argument>(this)) {
2525 this->printAsOperand(OS);
2527 llvm_unreachable("Unknown value to print out!");
2531 void Value::printAsOperand(raw_ostream &O, bool PrintType, const Module *M) const {
2532 // Fast path: Don't construct and populate a TypePrinting object if we
2533 // won't be needing any types printed.
2535 ((!isa<Constant>(this) && !isa<MDNode>(this)) ||
2536 hasName() || isa<GlobalValue>(this))) {
2537 WriteAsOperandInternal(O, this, nullptr, nullptr, M);
2542 M = getModuleFromVal(this);
2544 TypePrinting TypePrinter;
2546 TypePrinter.incorporateTypes(*M);
2548 TypePrinter.print(getType(), O);
2552 WriteAsOperandInternal(O, this, &TypePrinter, nullptr, M);
2555 // Value::dump - allow easy printing of Values from the debugger.
2556 void Value::dump() const { print(dbgs()); dbgs() << '\n'; }
2558 // Type::dump - allow easy printing of Types from the debugger.
2559 void Type::dump() const { print(dbgs()); dbgs() << '\n'; }
2561 // Module::dump() - Allow printing of Modules from the debugger.
2562 void Module::dump() const { print(dbgs(), nullptr); }
2564 // \brief Allow printing of Comdats from the debugger.
2565 void Comdat::dump() const { print(dbgs()); }
2567 // NamedMDNode::dump() - Allow printing of NamedMDNodes from the debugger.
2568 void NamedMDNode::dump() const { print(dbgs()); }