1 //===-- AsmWriter.cpp - Printing LLVM as an assembly file -----------------===//
2 //
3 // The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This library implements the functionality defined in llvm/IR/Writer.h
11 //
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.
14 //
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"
41 #include <algorithm>
42 #include <cctype>
43 using namespace llvm;
45 // Make virtual table appear in this compilation unit.
46 AssemblyAnnotationWriter::~AssemblyAnnotationWriter() {}
48 //===----------------------------------------------------------------------===//
49 // Helper Functions
50 //===----------------------------------------------------------------------===//
52 namespace {
53 struct OrderMap {
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 {
59 return IDs.lookup(V);
60 }
61 void index(const Value *V) {
62 // Explicitly sequence get-size and insert-value operations to avoid UB.
63 unsigned ID = IDs.size() + 1;
64 IDs[V].first = ID;
65 }
66 };
67 }
69 static void orderValue(const Value *V, OrderMap &OM) {
70 if (OM.lookup(V).first)
71 return;
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))
77 orderValue(Op, OM);
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.
81 OM.index(V);
82 }
84 static OrderMap orderModule(const Module *M) {
85 // This needs to match the order used by ValueEnumerator::ValueEnumerator()
86 // and ValueEnumerator::incorporateFunction().
87 OrderMap OM;
89 for (const GlobalVariable &G : M->globals()) {
90 if (G.hasInitializer())
91 if (!isa<GlobalValue>(G.getInitializer()))
92 orderValue(G.getInitializer(), OM);
93 orderValue(&G, OM);
94 }
95 for (const GlobalAlias &A : M->aliases()) {
96 if (!isa<GlobalValue>(A.getAliasee()))
97 orderValue(A.getAliasee(), OM);
98 orderValue(&A, OM);
99 }
100 for (const Function &F : *M) {
101 if (F.hasPrefixData())
102 if (!isa<GlobalValue>(F.getPrefixData()))
103 orderValue(F.getPrefixData(), OM);
105 if (F.hasPrologueData())
106 if (!isa<GlobalValue>(F.getPrologueData()))
107 orderValue(F.getPrologueData(), OM);
109 orderValue(&F, OM);
111 if (F.isDeclaration())
112 continue;
114 for (const Argument &A : F.args())
115 orderValue(&A, OM);
116 for (const BasicBlock &BB : F) {
117 orderValue(&BB, OM);
118 for (const Instruction &I : BB) {
119 for (const Value *Op : I.operands())
120 if ((isa<Constant>(*Op) && !isa<GlobalValue>(*Op)) ||
121 isa<InlineAsm>(*Op))
122 orderValue(Op, OM);
123 orderValue(&I, OM);
124 }
125 }
126 }
127 return OM;
128 }
130 static void predictValueUseListOrderImpl(const Value *V, const Function *F,
131 unsigned ID, const OrderMap &OM,
132 UseListOrderStack &Stack) {
133 // Predict use-list order for this one.
134 typedef std::pair<const Use *, unsigned> Entry;
135 SmallVector<Entry, 64> List;
136 for (const Use &U : V->uses())
137 // Check if this user will be serialized.
138 if (OM.lookup(U.getUser()).first)
139 List.push_back(std::make_pair(&U, List.size()));
141 if (List.size() < 2)
142 // We may have lost some users.
143 return;
145 bool GetsReversed =
146 !isa<GlobalVariable>(V) && !isa<Function>(V) && !isa<BasicBlock>(V);
147 if (auto *BA = dyn_cast<BlockAddress>(V))
148 ID = OM.lookup(BA->getBasicBlock()).first;
149 std::sort(List.begin(), List.end(), [&](const Entry &L, const Entry &R) {
150 const Use *LU = L.first;
151 const Use *RU = R.first;
152 if (LU == RU)
153 return false;
155 auto LID = OM.lookup(LU->getUser()).first;
156 auto RID = OM.lookup(RU->getUser()).first;
158 // If ID is 4, then expect: 7 6 5 1 2 3.
159 if (LID < RID) {
160 if (GetsReversed)
161 if (RID <= ID)
162 return true;
163 return false;
164 }
165 if (RID < LID) {
166 if (GetsReversed)
167 if (LID <= ID)
168 return false;
169 return true;
170 }
172 // LID and RID are equal, so we have different operands of the same user.
173 // Assume operands are added in order for all instructions.
174 if (GetsReversed)
175 if (LID <= ID)
176 return LU->getOperandNo() < RU->getOperandNo();
177 return LU->getOperandNo() > RU->getOperandNo();
178 });
180 if (std::is_sorted(
181 List.begin(), List.end(),
182 [](const Entry &L, const Entry &R) { return L.second < R.second; }))
183 // Order is already correct.
184 return;
186 // Store the shuffle.
187 Stack.emplace_back(V, F, List.size());
188 assert(List.size() == Stack.back().Shuffle.size() && "Wrong size");
189 for (size_t I = 0, E = List.size(); I != E; ++I)
190 Stack.back().Shuffle[I] = List[I].second;
191 }
193 static void predictValueUseListOrder(const Value *V, const Function *F,
194 OrderMap &OM, UseListOrderStack &Stack) {
195 auto &IDPair = OM[V];
196 assert(IDPair.first && "Unmapped value");
197 if (IDPair.second)
198 // Already predicted.
199 return;
201 // Do the actual prediction.
202 IDPair.second = true;
203 if (!V->use_empty() && std::next(V->use_begin()) != V->use_end())
204 predictValueUseListOrderImpl(V, F, IDPair.first, OM, Stack);
206 // Recursive descent into constants.
207 if (const Constant *C = dyn_cast<Constant>(V))
208 if (C->getNumOperands()) // Visit GlobalValues.
209 for (const Value *Op : C->operands())
210 if (isa<Constant>(Op)) // Visit GlobalValues.
211 predictValueUseListOrder(Op, F, OM, Stack);
212 }
214 static UseListOrderStack predictUseListOrder(const Module *M) {
215 OrderMap OM = orderModule(M);
217 // Use-list orders need to be serialized after all the users have been added
218 // to a value, or else the shuffles will be incomplete. Store them per
219 // function in a stack.
220 //
221 // Aside from function order, the order of values doesn't matter much here.
222 UseListOrderStack Stack;
224 // We want to visit the functions backward now so we can list function-local
225 // constants in the last Function they're used in. Module-level constants
226 // have already been visited above.
227 for (auto I = M->rbegin(), E = M->rend(); I != E; ++I) {
228 const Function &F = *I;
229 if (F.isDeclaration())
230 continue;
231 for (const BasicBlock &BB : F)
232 predictValueUseListOrder(&BB, &F, OM, Stack);
233 for (const Argument &A : F.args())
234 predictValueUseListOrder(&A, &F, OM, Stack);
235 for (const BasicBlock &BB : F)
236 for (const Instruction &I : BB)
237 for (const Value *Op : I.operands())
238 if (isa<Constant>(*Op) || isa<InlineAsm>(*Op)) // Visit GlobalValues.
239 predictValueUseListOrder(Op, &F, OM, Stack);
240 for (const BasicBlock &BB : F)
241 for (const Instruction &I : BB)
242 predictValueUseListOrder(&I, &F, OM, Stack);
243 }
245 // Visit globals last.
246 for (const GlobalVariable &G : M->globals())
247 predictValueUseListOrder(&G, nullptr, OM, Stack);
248 for (const Function &F : *M)
249 predictValueUseListOrder(&F, nullptr, OM, Stack);
250 for (const GlobalAlias &A : M->aliases())
251 predictValueUseListOrder(&A, nullptr, OM, Stack);
252 for (const GlobalVariable &G : M->globals())
253 if (G.hasInitializer())
254 predictValueUseListOrder(G.getInitializer(), nullptr, OM, Stack);
255 for (const GlobalAlias &A : M->aliases())
256 predictValueUseListOrder(A.getAliasee(), nullptr, OM, Stack);
257 for (const Function &F : *M)
258 if (F.hasPrefixData())
259 predictValueUseListOrder(F.getPrefixData(), nullptr, OM, Stack);
261 return Stack;
262 }
264 static const Module *getModuleFromVal(const Value *V) {
265 if (const Argument *MA = dyn_cast<Argument>(V))
266 return MA->getParent() ? MA->getParent()->getParent() : nullptr;
268 if (const BasicBlock *BB = dyn_cast<BasicBlock>(V))
269 return BB->getParent() ? BB->getParent()->getParent() : nullptr;
271 if (const Instruction *I = dyn_cast<Instruction>(V)) {
272 const Function *M = I->getParent() ? I->getParent()->getParent() : nullptr;
273 return M ? M->getParent() : nullptr;
274 }
276 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V))
277 return GV->getParent();
278 return nullptr;
279 }
281 static void PrintCallingConv(unsigned cc, raw_ostream &Out) {
282 switch (cc) {
283 default: Out << "cc" << cc; break;
284 case CallingConv::Fast: Out << "fastcc"; break;
285 case CallingConv::Cold: Out << "coldcc"; break;
286 case CallingConv::WebKit_JS: Out << "webkit_jscc"; break;
287 case CallingConv::AnyReg: Out << "anyregcc"; break;
288 case CallingConv::PreserveMost: Out << "preserve_mostcc"; break;
289 case CallingConv::PreserveAll: Out << "preserve_allcc"; break;
290 case CallingConv::GHC: Out << "ghccc"; break;
291 case CallingConv::X86_StdCall: Out << "x86_stdcallcc"; break;
292 case CallingConv::X86_FastCall: Out << "x86_fastcallcc"; break;
293 case CallingConv::X86_ThisCall: Out << "x86_thiscallcc"; break;
294 case CallingConv::X86_VectorCall:Out << "x86_vectorcallcc"; break;
295 case CallingConv::Intel_OCL_BI: Out << "intel_ocl_bicc"; break;
296 case CallingConv::ARM_APCS: Out << "arm_apcscc"; break;
297 case CallingConv::ARM_AAPCS: Out << "arm_aapcscc"; break;
298 case CallingConv::ARM_AAPCS_VFP: Out << "arm_aapcs_vfpcc"; break;
299 case CallingConv::MSP430_INTR: Out << "msp430_intrcc"; break;
300 case CallingConv::PTX_Kernel: Out << "ptx_kernel"; break;
301 case CallingConv::PTX_Device: Out << "ptx_device"; break;
302 case CallingConv::X86_64_SysV: Out << "x86_64_sysvcc"; break;
303 case CallingConv::X86_64_Win64: Out << "x86_64_win64cc"; break;
304 case CallingConv::SPIR_FUNC: Out << "spir_func"; break;
305 case CallingConv::SPIR_KERNEL: Out << "spir_kernel"; break;
306 }
307 }
309 // PrintEscapedString - Print each character of the specified string, escaping
310 // it if it is not printable or if it is an escape char.
311 static void PrintEscapedString(StringRef Name, raw_ostream &Out) {
312 for (unsigned i = 0, e = Name.size(); i != e; ++i) {
313 unsigned char C = Name[i];
314 if (isprint(C) && C != '\\' && C != '"')
315 Out << C;
316 else
317 Out << '\\' << hexdigit(C >> 4) << hexdigit(C & 0x0F);
318 }
319 }
321 enum PrefixType {
322 GlobalPrefix,
323 ComdatPrefix,
324 LabelPrefix,
325 LocalPrefix,
326 NoPrefix
327 };
329 /// PrintLLVMName - Turn the specified name into an 'LLVM name', which is either
330 /// prefixed with % (if the string only contains simple characters) or is
331 /// surrounded with ""'s (if it has special chars in it). Print it out.
332 static void PrintLLVMName(raw_ostream &OS, StringRef Name, PrefixType Prefix) {
333 assert(!Name.empty() && "Cannot get empty name!");
334 switch (Prefix) {
335 case NoPrefix: break;
336 case GlobalPrefix: OS << '@'; break;
337 case ComdatPrefix: OS << '$'; break;
338 case LabelPrefix: break;
339 case LocalPrefix: OS << '%'; break;
340 }
342 // Scan the name to see if it needs quotes first.
343 bool NeedsQuotes = isdigit(static_cast<unsigned char>(Name[0]));
344 if (!NeedsQuotes) {
345 for (unsigned i = 0, e = Name.size(); i != e; ++i) {
346 // By making this unsigned, the value passed in to isalnum will always be
347 // in the range 0-255. This is important when building with MSVC because
348 // its implementation will assert. This situation can arise when dealing
349 // with UTF-8 multibyte characters.
350 unsigned char C = Name[i];
351 if (!isalnum(static_cast<unsigned char>(C)) && C != '-' && C != '.' &&
352 C != '_') {
353 NeedsQuotes = true;
354 break;
355 }
356 }
357 }
359 // If we didn't need any quotes, just write out the name in one blast.
360 if (!NeedsQuotes) {
361 OS << Name;
362 return;
363 }
365 // Okay, we need quotes. Output the quotes and escape any scary characters as
366 // needed.
367 OS << '"';
368 PrintEscapedString(Name, OS);
369 OS << '"';
370 }
372 /// PrintLLVMName - Turn the specified name into an 'LLVM name', which is either
373 /// prefixed with % (if the string only contains simple characters) or is
374 /// surrounded with ""'s (if it has special chars in it). Print it out.
375 static void PrintLLVMName(raw_ostream &OS, const Value *V) {
376 PrintLLVMName(OS, V->getName(),
377 isa<GlobalValue>(V) ? GlobalPrefix : LocalPrefix);
378 }
381 namespace llvm {
383 void TypePrinting::incorporateTypes(const Module &M) {
384 NamedTypes.run(M, false);
386 // The list of struct types we got back includes all the struct types, split
387 // the unnamed ones out to a numbering and remove the anonymous structs.
388 unsigned NextNumber = 0;
390 std::vector<StructType*>::iterator NextToUse = NamedTypes.begin(), I, E;
391 for (I = NamedTypes.begin(), E = NamedTypes.end(); I != E; ++I) {
392 StructType *STy = *I;
394 // Ignore anonymous types.
395 if (STy->isLiteral())
396 continue;
398 if (STy->getName().empty())
399 NumberedTypes[STy] = NextNumber++;
400 else
401 *NextToUse++ = STy;
402 }
404 NamedTypes.erase(NextToUse, NamedTypes.end());
405 }
408 /// CalcTypeName - Write the specified type to the specified raw_ostream, making
409 /// use of type names or up references to shorten the type name where possible.
410 void TypePrinting::print(Type *Ty, raw_ostream &OS) {
411 switch (Ty->getTypeID()) {
412 case Type::VoidTyID: OS << "void"; return;
413 case Type::HalfTyID: OS << "half"; return;
414 case Type::FloatTyID: OS << "float"; return;
415 case Type::DoubleTyID: OS << "double"; return;
416 case Type::X86_FP80TyID: OS << "x86_fp80"; return;
417 case Type::FP128TyID: OS << "fp128"; return;
418 case Type::PPC_FP128TyID: OS << "ppc_fp128"; return;
419 case Type::LabelTyID: OS << "label"; return;
420 case Type::MetadataTyID: OS << "metadata"; return;
421 case Type::X86_MMXTyID: OS << "x86_mmx"; return;
422 case Type::IntegerTyID:
423 OS << 'i' << cast<IntegerType>(Ty)->getBitWidth();
424 return;
426 case Type::FunctionTyID: {
427 FunctionType *FTy = cast<FunctionType>(Ty);
428 print(FTy->getReturnType(), OS);
429 OS << " (";
430 for (FunctionType::param_iterator I = FTy->param_begin(),
431 E = FTy->param_end(); I != E; ++I) {
432 if (I != FTy->param_begin())
433 OS << ", ";
434 print(*I, OS);
435 }
436 if (FTy->isVarArg()) {
437 if (FTy->getNumParams()) OS << ", ";
438 OS << "...";
439 }
440 OS << ')';
441 return;
442 }
443 case Type::StructTyID: {
444 StructType *STy = cast<StructType>(Ty);
446 if (STy->isLiteral())
447 return printStructBody(STy, OS);
449 if (!STy->getName().empty())
450 return PrintLLVMName(OS, STy->getName(), LocalPrefix);
452 DenseMap<StructType*, unsigned>::iterator I = NumberedTypes.find(STy);
453 if (I != NumberedTypes.end())
454 OS << '%' << I->second;
455 else // Not enumerated, print the hex address.
456 OS << "%\"type " << STy << '\"';
457 return;
458 }
459 case Type::PointerTyID: {
460 PointerType *PTy = cast<PointerType>(Ty);
461 print(PTy->getElementType(), OS);
462 if (unsigned AddressSpace = PTy->getAddressSpace())
463 OS << " addrspace(" << AddressSpace << ')';
464 OS << '*';
465 return;
466 }
467 case Type::ArrayTyID: {
468 ArrayType *ATy = cast<ArrayType>(Ty);
469 OS << '[' << ATy->getNumElements() << " x ";
470 print(ATy->getElementType(), OS);
471 OS << ']';
472 return;
473 }
474 case Type::VectorTyID: {
475 VectorType *PTy = cast<VectorType>(Ty);
476 OS << "<" << PTy->getNumElements() << " x ";
477 print(PTy->getElementType(), OS);
478 OS << '>';
479 return;
480 }
481 }
482 llvm_unreachable("Invalid TypeID");
483 }
485 void TypePrinting::printStructBody(StructType *STy, raw_ostream &OS) {
486 if (STy->isOpaque()) {
487 OS << "opaque";
488 return;
489 }
491 if (STy->isPacked())
492 OS << '<';
494 if (STy->getNumElements() == 0) {
495 OS << "{}";
496 } else {
497 StructType::element_iterator I = STy->element_begin();
498 OS << "{ ";
499 print(*I++, OS);
500 for (StructType::element_iterator E = STy->element_end(); I != E; ++I) {
501 OS << ", ";
502 print(*I, OS);
503 }
505 OS << " }";
506 }
507 if (STy->isPacked())
508 OS << '>';
509 }
511 //===----------------------------------------------------------------------===//
512 // SlotTracker Class: Enumerate slot numbers for unnamed values
513 //===----------------------------------------------------------------------===//
514 /// This class provides computation of slot numbers for LLVM Assembly writing.
515 ///
516 class SlotTracker {
517 public:
518 /// ValueMap - A mapping of Values to slot numbers.
519 typedef DenseMap<const Value*, unsigned> ValueMap;
521 private:
522 /// TheModule - The module for which we are holding slot numbers.
523 const Module* TheModule;
525 /// TheFunction - The function for which we are holding slot numbers.
526 const Function* TheFunction;
527 bool FunctionProcessed;
529 /// mMap - The slot map for the module level data.
530 ValueMap mMap;
531 unsigned mNext;
533 /// fMap - The slot map for the function level data.
534 ValueMap fMap;
535 unsigned fNext;
537 /// mdnMap - Map for MDNodes.
538 DenseMap<const MDNode*, unsigned> mdnMap;
539 unsigned mdnNext;
541 /// asMap - The slot map for attribute sets.
542 DenseMap<AttributeSet, unsigned> asMap;
543 unsigned asNext;
544 public:
545 /// Construct from a module
546 explicit SlotTracker(const Module *M);
547 /// Construct from a function, starting out in incorp state.
548 explicit SlotTracker(const Function *F);
550 /// Return the slot number of the specified value in it's type
551 /// plane. If something is not in the SlotTracker, return -1.
552 int getLocalSlot(const Value *V);
553 int getGlobalSlot(const GlobalValue *V);
554 int getMetadataSlot(const MDNode *N);
555 int getAttributeGroupSlot(AttributeSet AS);
557 /// If you'd like to deal with a function instead of just a module, use
558 /// this method to get its data into the SlotTracker.
559 void incorporateFunction(const Function *F) {
560 TheFunction = F;
561 FunctionProcessed = false;
562 }
564 const Function *getFunction() const { return TheFunction; }
566 /// After calling incorporateFunction, use this method to remove the
567 /// most recently incorporated function from the SlotTracker. This
568 /// will reset the state of the machine back to just the module contents.
569 void purgeFunction();
571 /// MDNode map iterators.
572 typedef DenseMap<const MDNode*, unsigned>::iterator mdn_iterator;
573 mdn_iterator mdn_begin() { return mdnMap.begin(); }
574 mdn_iterator mdn_end() { return mdnMap.end(); }
575 unsigned mdn_size() const { return mdnMap.size(); }
576 bool mdn_empty() const { return mdnMap.empty(); }
578 /// AttributeSet map iterators.
579 typedef DenseMap<AttributeSet, unsigned>::iterator as_iterator;
580 as_iterator as_begin() { return asMap.begin(); }
581 as_iterator as_end() { return asMap.end(); }
582 unsigned as_size() const { return asMap.size(); }
583 bool as_empty() const { return asMap.empty(); }
585 /// This function does the actual initialization.
586 inline void initialize();
588 // Implementation Details
589 private:
590 /// CreateModuleSlot - Insert the specified GlobalValue* into the slot table.
591 void CreateModuleSlot(const GlobalValue *V);
593 /// CreateMetadataSlot - Insert the specified MDNode* into the slot table.
594 void CreateMetadataSlot(const MDNode *N);
596 /// CreateFunctionSlot - Insert the specified Value* into the slot table.
597 void CreateFunctionSlot(const Value *V);
599 /// \brief Insert the specified AttributeSet into the slot table.
600 void CreateAttributeSetSlot(AttributeSet AS);
602 /// Add all of the module level global variables (and their initializers)
603 /// and function declarations, but not the contents of those functions.
604 void processModule();
606 /// Add all of the functions arguments, basic blocks, and instructions.
607 void processFunction();
609 SlotTracker(const SlotTracker &) LLVM_DELETED_FUNCTION;
610 void operator=(const SlotTracker &) LLVM_DELETED_FUNCTION;
611 };
613 SlotTracker *createSlotTracker(const Module *M) {
614 return new SlotTracker(M);
615 }
617 static SlotTracker *createSlotTracker(const Value *V) {
618 if (const Argument *FA = dyn_cast<Argument>(V))
619 return new SlotTracker(FA->getParent());
621 if (const Instruction *I = dyn_cast<Instruction>(V))
622 if (I->getParent())
623 return new SlotTracker(I->getParent()->getParent());
625 if (const BasicBlock *BB = dyn_cast<BasicBlock>(V))
626 return new SlotTracker(BB->getParent());
628 if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(V))
629 return new SlotTracker(GV->getParent());
631 if (const GlobalAlias *GA = dyn_cast<GlobalAlias>(V))
632 return new SlotTracker(GA->getParent());
634 if (const Function *Func = dyn_cast<Function>(V))
635 return new SlotTracker(Func);
637 return nullptr;
638 }
640 #if 0
641 #define ST_DEBUG(X) dbgs() << X
642 #else
643 #define ST_DEBUG(X)
644 #endif
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), mNext(0),
650 fNext(0), mdnNext(0), asNext(0) {}
652 // Function level constructor. Causes the contents of the Module and the one
653 // function provided to be added to the slot table.
654 SlotTracker::SlotTracker(const Function *F)
655 : TheModule(F ? F->getParent() : nullptr), TheFunction(F),
656 FunctionProcessed(false), mNext(0), fNext(0), mdnNext(0), asNext(0) {}
658 inline void SlotTracker::initialize() {
659 if (TheModule) {
660 processModule();
661 TheModule = nullptr; ///< Prevent re-processing next time we're called.
662 }
664 if (TheFunction && !FunctionProcessed)
665 processFunction();
666 }
668 // Iterate through all the global variables, functions, and global
669 // variable initializers and create slots for them.
670 void SlotTracker::processModule() {
671 ST_DEBUG("begin processModule!\n");
673 // Add all of the unnamed global variables to the value table.
674 for (Module::const_global_iterator I = TheModule->global_begin(),
675 E = TheModule->global_end(); I != E; ++I) {
676 if (!I->hasName())
677 CreateModuleSlot(I);
678 }
680 // Add metadata used by named metadata.
681 for (Module::const_named_metadata_iterator
682 I = TheModule->named_metadata_begin(),
683 E = TheModule->named_metadata_end(); I != E; ++I) {
684 const NamedMDNode *NMD = I;
685 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i)
686 CreateMetadataSlot(NMD->getOperand(i));
687 }
689 for (Module::const_iterator I = TheModule->begin(), E = TheModule->end();
690 I != E; ++I) {
691 if (!I->hasName())
692 // Add all the unnamed functions to the table.
693 CreateModuleSlot(I);
695 // Add all the function attributes to the table.
696 // FIXME: Add attributes of other objects?
697 AttributeSet FnAttrs = I->getAttributes().getFnAttributes();
698 if (FnAttrs.hasAttributes(AttributeSet::FunctionIndex))
699 CreateAttributeSetSlot(FnAttrs);
700 }
702 ST_DEBUG("end processModule!\n");
703 }
705 // Process the arguments, basic blocks, and instructions of a function.
706 void SlotTracker::processFunction() {
707 ST_DEBUG("begin processFunction!\n");
708 fNext = 0;
710 // Add all the function arguments with no names.
711 for(Function::const_arg_iterator AI = TheFunction->arg_begin(),
712 AE = TheFunction->arg_end(); AI != AE; ++AI)
713 if (!AI->hasName())
714 CreateFunctionSlot(AI);
716 ST_DEBUG("Inserting Instructions:\n");
718 SmallVector<std::pair<unsigned, MDNode *>, 4> MDForInst;
720 // Add all of the basic blocks and instructions with no names.
721 for (Function::const_iterator BB = TheFunction->begin(),
722 E = TheFunction->end(); BB != E; ++BB) {
723 if (!BB->hasName())
724 CreateFunctionSlot(BB);
726 for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I != E;
727 ++I) {
728 if (!I->getType()->isVoidTy() && !I->hasName())
729 CreateFunctionSlot(I);
731 // Intrinsics can directly use metadata. We allow direct calls to any
732 // llvm.foo function here, because the target may not be linked into the
733 // optimizer.
734 if (const CallInst *CI = dyn_cast<CallInst>(I)) {
735 if (Function *F = CI->getCalledFunction())
736 if (F->isIntrinsic())
737 for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i)
738 if (auto *V = dyn_cast_or_null<MetadataAsValue>(I->getOperand(i)))
739 if (MDNode *N = dyn_cast<MDNode>(V->getMetadata()))
740 CreateMetadataSlot(N);
742 // Add all the call attributes to the table.
743 AttributeSet Attrs = CI->getAttributes().getFnAttributes();
744 if (Attrs.hasAttributes(AttributeSet::FunctionIndex))
745 CreateAttributeSetSlot(Attrs);
746 } else if (const InvokeInst *II = dyn_cast<InvokeInst>(I)) {
747 // Add all the call attributes to the table.
748 AttributeSet Attrs = II->getAttributes().getFnAttributes();
749 if (Attrs.hasAttributes(AttributeSet::FunctionIndex))
750 CreateAttributeSetSlot(Attrs);
751 }
753 // Process metadata attached with this instruction.
754 I->getAllMetadata(MDForInst);
755 for (unsigned i = 0, e = MDForInst.size(); i != e; ++i)
756 CreateMetadataSlot(MDForInst[i].second);
757 MDForInst.clear();
758 }
759 }
761 FunctionProcessed = true;
763 ST_DEBUG("end processFunction!\n");
764 }
766 /// Clean up after incorporating a function. This is the only way to get out of
767 /// the function incorporation state that affects get*Slot/Create*Slot. Function
768 /// incorporation state is indicated by TheFunction != 0.
769 void SlotTracker::purgeFunction() {
770 ST_DEBUG("begin purgeFunction!\n");
771 fMap.clear(); // Simply discard the function level map
772 TheFunction = nullptr;
773 FunctionProcessed = false;
774 ST_DEBUG("end purgeFunction!\n");
775 }
777 /// getGlobalSlot - Get the slot number of a global value.
778 int SlotTracker::getGlobalSlot(const GlobalValue *V) {
779 // Check for uninitialized state and do lazy initialization.
780 initialize();
782 // Find the value in the module map
783 ValueMap::iterator MI = mMap.find(V);
784 return MI == mMap.end() ? -1 : (int)MI->second;
785 }
787 /// getMetadataSlot - Get the slot number of a MDNode.
788 int SlotTracker::getMetadataSlot(const MDNode *N) {
789 // Check for uninitialized state and do lazy initialization.
790 initialize();
792 // Find the MDNode in the module map
793 mdn_iterator MI = mdnMap.find(N);
794 return MI == mdnMap.end() ? -1 : (int)MI->second;
795 }
798 /// getLocalSlot - Get the slot number for a value that is local to a function.
799 int SlotTracker::getLocalSlot(const Value *V) {
800 assert(!isa<Constant>(V) && "Can't get a constant or global slot with this!");
802 // Check for uninitialized state and do lazy initialization.
803 initialize();
805 ValueMap::iterator FI = fMap.find(V);
806 return FI == fMap.end() ? -1 : (int)FI->second;
807 }
809 int SlotTracker::getAttributeGroupSlot(AttributeSet AS) {
810 // Check for uninitialized state and do lazy initialization.
811 initialize();
813 // Find the AttributeSet in the module map.
814 as_iterator AI = asMap.find(AS);
815 return AI == asMap.end() ? -1 : (int)AI->second;
816 }
818 /// CreateModuleSlot - Insert the specified GlobalValue* into the slot table.
819 void SlotTracker::CreateModuleSlot(const GlobalValue *V) {
820 assert(V && "Can't insert a null Value into SlotTracker!");
821 assert(!V->getType()->isVoidTy() && "Doesn't need a slot!");
822 assert(!V->hasName() && "Doesn't need a slot!");
824 unsigned DestSlot = mNext++;
825 mMap[V] = DestSlot;
827 ST_DEBUG(" Inserting value [" << V->getType() << "] = " << V << " slot=" <<
828 DestSlot << " [");
829 // G = Global, F = Function, A = Alias, o = other
830 ST_DEBUG((isa<GlobalVariable>(V) ? 'G' :
831 (isa<Function>(V) ? 'F' :
832 (isa<GlobalAlias>(V) ? 'A' : 'o'))) << "]\n");
833 }
835 /// CreateSlot - Create a new slot for the specified value if it has no name.
836 void SlotTracker::CreateFunctionSlot(const Value *V) {
837 assert(!V->getType()->isVoidTy() && !V->hasName() && "Doesn't need a slot!");
839 unsigned DestSlot = fNext++;
840 fMap[V] = DestSlot;
842 // G = Global, F = Function, o = other
843 ST_DEBUG(" Inserting value [" << V->getType() << "] = " << V << " slot=" <<
844 DestSlot << " [o]\n");
845 }
847 /// CreateModuleSlot - Insert the specified MDNode* into the slot table.
848 void SlotTracker::CreateMetadataSlot(const MDNode *N) {
849 assert(N && "Can't insert a null Value into SlotTracker!");
851 unsigned DestSlot = mdnNext;
852 if (!mdnMap.insert(std::make_pair(N, DestSlot)).second)
853 return;
854 ++mdnNext;
856 // Recursively add any MDNodes referenced by operands.
857 for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i)
858 if (const MDNode *Op = dyn_cast_or_null<MDNode>(N->getOperand(i)))
859 CreateMetadataSlot(Op);
860 }
862 void SlotTracker::CreateAttributeSetSlot(AttributeSet AS) {
863 assert(AS.hasAttributes(AttributeSet::FunctionIndex) &&
864 "Doesn't need a slot!");
866 as_iterator I = asMap.find(AS);
867 if (I != asMap.end())
868 return;
870 unsigned DestSlot = asNext++;
871 asMap[AS] = DestSlot;
872 }
874 //===----------------------------------------------------------------------===//
875 // AsmWriter Implementation
876 //===----------------------------------------------------------------------===//
878 static void WriteAsOperandInternal(raw_ostream &Out, const Value *V,
879 TypePrinting *TypePrinter,
880 SlotTracker *Machine,
881 const Module *Context);
883 static void WriteAsOperandInternal(raw_ostream &Out, const Metadata *MD,
884 TypePrinting *TypePrinter,
885 SlotTracker *Machine, const Module *Context,
886 bool FromValue = false);
888 static const char *getPredicateText(unsigned predicate) {
889 const char * pred = "unknown";
890 switch (predicate) {
891 case FCmpInst::FCMP_FALSE: pred = "false"; break;
892 case FCmpInst::FCMP_OEQ: pred = "oeq"; break;
893 case FCmpInst::FCMP_OGT: pred = "ogt"; break;
894 case FCmpInst::FCMP_OGE: pred = "oge"; break;
895 case FCmpInst::FCMP_OLT: pred = "olt"; break;
896 case FCmpInst::FCMP_OLE: pred = "ole"; break;
897 case FCmpInst::FCMP_ONE: pred = "one"; break;
898 case FCmpInst::FCMP_ORD: pred = "ord"; break;
899 case FCmpInst::FCMP_UNO: pred = "uno"; break;
900 case FCmpInst::FCMP_UEQ: pred = "ueq"; break;
901 case FCmpInst::FCMP_UGT: pred = "ugt"; break;
902 case FCmpInst::FCMP_UGE: pred = "uge"; break;
903 case FCmpInst::FCMP_ULT: pred = "ult"; break;
904 case FCmpInst::FCMP_ULE: pred = "ule"; break;
905 case FCmpInst::FCMP_UNE: pred = "une"; break;
906 case FCmpInst::FCMP_TRUE: pred = "true"; break;
907 case ICmpInst::ICMP_EQ: pred = "eq"; break;
908 case ICmpInst::ICMP_NE: pred = "ne"; break;
909 case ICmpInst::ICMP_SGT: pred = "sgt"; break;
910 case ICmpInst::ICMP_SGE: pred = "sge"; break;
911 case ICmpInst::ICMP_SLT: pred = "slt"; break;
912 case ICmpInst::ICMP_SLE: pred = "sle"; break;
913 case ICmpInst::ICMP_UGT: pred = "ugt"; break;
914 case ICmpInst::ICMP_UGE: pred = "uge"; break;
915 case ICmpInst::ICMP_ULT: pred = "ult"; break;
916 case ICmpInst::ICMP_ULE: pred = "ule"; break;
917 }
918 return pred;
919 }
921 static void writeAtomicRMWOperation(raw_ostream &Out,
922 AtomicRMWInst::BinOp Op) {
923 switch (Op) {
924 default: Out << " <unknown operation " << Op << ">"; break;
925 case AtomicRMWInst::Xchg: Out << " xchg"; break;
926 case AtomicRMWInst::Add: Out << " add"; break;
927 case AtomicRMWInst::Sub: Out << " sub"; break;
928 case AtomicRMWInst::And: Out << " and"; break;
929 case AtomicRMWInst::Nand: Out << " nand"; break;
930 case AtomicRMWInst::Or: Out << " or"; break;
931 case AtomicRMWInst::Xor: Out << " xor"; break;
932 case AtomicRMWInst::Max: Out << " max"; break;
933 case AtomicRMWInst::Min: Out << " min"; break;
934 case AtomicRMWInst::UMax: Out << " umax"; break;
935 case AtomicRMWInst::UMin: Out << " umin"; break;
936 }
937 }
939 static void WriteOptimizationInfo(raw_ostream &Out, const User *U) {
940 if (const FPMathOperator *FPO = dyn_cast<const FPMathOperator>(U)) {
941 // Unsafe algebra implies all the others, no need to write them all out
942 if (FPO->hasUnsafeAlgebra())
943 Out << " fast";
944 else {
945 if (FPO->hasNoNaNs())
946 Out << " nnan";
947 if (FPO->hasNoInfs())
948 Out << " ninf";
949 if (FPO->hasNoSignedZeros())
950 Out << " nsz";
951 if (FPO->hasAllowReciprocal())
952 Out << " arcp";
953 }
954 }
956 if (const OverflowingBinaryOperator *OBO =
957 dyn_cast<OverflowingBinaryOperator>(U)) {
958 if (OBO->hasNoUnsignedWrap())
959 Out << " nuw";
960 if (OBO->hasNoSignedWrap())
961 Out << " nsw";
962 } else if (const PossiblyExactOperator *Div =
963 dyn_cast<PossiblyExactOperator>(U)) {
964 if (Div->isExact())
965 Out << " exact";
966 } else if (const GEPOperator *GEP = dyn_cast<GEPOperator>(U)) {
967 if (GEP->isInBounds())
968 Out << " inbounds";
969 }
970 }
972 static void WriteConstantInternal(raw_ostream &Out, const Constant *CV,
973 TypePrinting &TypePrinter,
974 SlotTracker *Machine,
975 const Module *Context) {
976 if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV)) {
977 if (CI->getType()->isIntegerTy(1)) {
978 Out << (CI->getZExtValue() ? "true" : "false");
979 return;
980 }
981 Out << CI->getValue();
982 return;
983 }
985 if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV)) {
986 if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEsingle ||
987 &CFP->getValueAPF().getSemantics() == &APFloat::IEEEdouble) {
988 // We would like to output the FP constant value in exponential notation,
989 // but we cannot do this if doing so will lose precision. Check here to
990 // make sure that we only output it in exponential format if we can parse
991 // the value back and get the same value.
992 //
993 bool ignored;
994 bool isHalf = &CFP->getValueAPF().getSemantics()==&APFloat::IEEEhalf;
995 bool isDouble = &CFP->getValueAPF().getSemantics()==&APFloat::IEEEdouble;
996 bool isInf = CFP->getValueAPF().isInfinity();
997 bool isNaN = CFP->getValueAPF().isNaN();
998 if (!isHalf && !isInf && !isNaN) {
999 double Val = isDouble ? CFP->getValueAPF().convertToDouble() :
1000 CFP->getValueAPF().convertToFloat();
1001 SmallString<128> StrVal;
1002 raw_svector_ostream(StrVal) << Val;
1004 // Check to make sure that the stringized number is not some string like
1005 // "Inf" or NaN, that atof will accept, but the lexer will not. Check
1006 // that the string matches the "[-+]?[0-9]" regex.
1007 //
1008 if ((StrVal[0] >= '0' && StrVal[0] <= '9') ||
1009 ((StrVal[0] == '-' || StrVal[0] == '+') &&
1010 (StrVal[1] >= '0' && StrVal[1] <= '9'))) {
1011 // Reparse stringized version!
1012 if (APFloat(APFloat::IEEEdouble, StrVal).convertToDouble() == Val) {
1013 Out << StrVal.str();
1014 return;
1015 }
1016 }
1017 }
1018 // Otherwise we could not reparse it to exactly the same value, so we must
1019 // output the string in hexadecimal format! Note that loading and storing
1020 // floating point types changes the bits of NaNs on some hosts, notably
1021 // x86, so we must not use these types.
1022 static_assert(sizeof(double) == sizeof(uint64_t),
1023 "assuming that double is 64 bits!");
1024 char Buffer[40];
1025 APFloat apf = CFP->getValueAPF();
1026 // Halves and floats are represented in ASCII IR as double, convert.
1027 if (!isDouble)
1028 apf.convert(APFloat::IEEEdouble, APFloat::rmNearestTiesToEven,
1029 &ignored);
1030 Out << "0x" <<
1031 utohex_buffer(uint64_t(apf.bitcastToAPInt().getZExtValue()),
1032 Buffer+40);
1033 return;
1034 }
1036 // Either half, or some form of long double.
1037 // These appear as a magic letter identifying the type, then a
1038 // fixed number of hex digits.
1039 Out << "0x";
1040 // Bit position, in the current word, of the next nibble to print.
1041 int shiftcount;
1043 if (&CFP->getValueAPF().getSemantics() == &APFloat::x87DoubleExtended) {
1044 Out << 'K';
1045 // api needed to prevent premature destruction
1046 APInt api = CFP->getValueAPF().bitcastToAPInt();
1047 const uint64_t* p = api.getRawData();
1048 uint64_t word = p[1];
1049 shiftcount = 12;
1050 int width = api.getBitWidth();
1051 for (int j=0; j<width; j+=4, shiftcount-=4) {
1052 unsigned int nibble = (word>>shiftcount) & 15;
1053 if (nibble < 10)
1054 Out << (unsigned char)(nibble + '0');
1055 else
1056 Out << (unsigned char)(nibble - 10 + 'A');
1057 if (shiftcount == 0 && j+4 < width) {
1058 word = *p;
1059 shiftcount = 64;
1060 if (width-j-4 < 64)
1061 shiftcount = width-j-4;
1062 }
1063 }
1064 return;
1065 } else if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEquad) {
1066 shiftcount = 60;
1067 Out << 'L';
1068 } else if (&CFP->getValueAPF().getSemantics() == &APFloat::PPCDoubleDouble) {
1069 shiftcount = 60;
1070 Out << 'M';
1071 } else if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEhalf) {
1072 shiftcount = 12;
1073 Out << 'H';
1074 } else
1075 llvm_unreachable("Unsupported floating point type");
1076 // api needed to prevent premature destruction
1077 APInt api = CFP->getValueAPF().bitcastToAPInt();
1078 const uint64_t* p = api.getRawData();
1079 uint64_t word = *p;
1080 int width = api.getBitWidth();
1081 for (int j=0; j<width; j+=4, shiftcount-=4) {
1082 unsigned int nibble = (word>>shiftcount) & 15;
1083 if (nibble < 10)
1084 Out << (unsigned char)(nibble + '0');
1085 else
1086 Out << (unsigned char)(nibble - 10 + 'A');
1087 if (shiftcount == 0 && j+4 < width) {
1088 word = *(++p);
1089 shiftcount = 64;
1090 if (width-j-4 < 64)
1091 shiftcount = width-j-4;
1092 }
1093 }
1094 return;
1095 }
1097 if (isa<ConstantAggregateZero>(CV)) {
1098 Out << "zeroinitializer";
1099 return;
1100 }
1102 if (const BlockAddress *BA = dyn_cast<BlockAddress>(CV)) {
1103 Out << "blockaddress(";
1104 WriteAsOperandInternal(Out, BA->getFunction(), &TypePrinter, Machine,
1105 Context);
1106 Out << ", ";
1107 WriteAsOperandInternal(Out, BA->getBasicBlock(), &TypePrinter, Machine,
1108 Context);
1109 Out << ")";
1110 return;
1111 }
1113 if (const ConstantArray *CA = dyn_cast<ConstantArray>(CV)) {
1114 Type *ETy = CA->getType()->getElementType();
1115 Out << '[';
1116 TypePrinter.print(ETy, Out);
1117 Out << ' ';
1118 WriteAsOperandInternal(Out, CA->getOperand(0),
1119 &TypePrinter, Machine,
1120 Context);
1121 for (unsigned i = 1, e = CA->getNumOperands(); i != e; ++i) {
1122 Out << ", ";
1123 TypePrinter.print(ETy, Out);
1124 Out << ' ';
1125 WriteAsOperandInternal(Out, CA->getOperand(i), &TypePrinter, Machine,
1126 Context);
1127 }
1128 Out << ']';
1129 return;
1130 }
1132 if (const ConstantDataArray *CA = dyn_cast<ConstantDataArray>(CV)) {
1133 // As a special case, print the array as a string if it is an array of
1134 // i8 with ConstantInt values.
1135 if (CA->isString()) {
1136 Out << "c\"";
1137 PrintEscapedString(CA->getAsString(), Out);
1138 Out << '"';
1139 return;
1140 }
1142 Type *ETy = CA->getType()->getElementType();
1143 Out << '[';
1144 TypePrinter.print(ETy, Out);
1145 Out << ' ';
1146 WriteAsOperandInternal(Out, CA->getElementAsConstant(0),
1147 &TypePrinter, Machine,
1148 Context);
1149 for (unsigned i = 1, e = CA->getNumElements(); i != e; ++i) {
1150 Out << ", ";
1151 TypePrinter.print(ETy, Out);
1152 Out << ' ';
1153 WriteAsOperandInternal(Out, CA->getElementAsConstant(i), &TypePrinter,
1154 Machine, Context);
1155 }
1156 Out << ']';
1157 return;
1158 }
1161 if (const ConstantStruct *CS = dyn_cast<ConstantStruct>(CV)) {
1162 if (CS->getType()->isPacked())
1163 Out << '<';
1164 Out << '{';
1165 unsigned N = CS->getNumOperands();
1166 if (N) {
1167 Out << ' ';
1168 TypePrinter.print(CS->getOperand(0)->getType(), Out);
1169 Out << ' ';
1171 WriteAsOperandInternal(Out, CS->getOperand(0), &TypePrinter, Machine,
1172 Context);
1174 for (unsigned i = 1; i < N; i++) {
1175 Out << ", ";
1176 TypePrinter.print(CS->getOperand(i)->getType(), Out);
1177 Out << ' ';
1179 WriteAsOperandInternal(Out, CS->getOperand(i), &TypePrinter, Machine,
1180 Context);
1181 }
1182 Out << ' ';
1183 }
1185 Out << '}';
1186 if (CS->getType()->isPacked())
1187 Out << '>';
1188 return;
1189 }
1191 if (isa<ConstantVector>(CV) || isa<ConstantDataVector>(CV)) {
1192 Type *ETy = CV->getType()->getVectorElementType();
1193 Out << '<';
1194 TypePrinter.print(ETy, Out);
1195 Out << ' ';
1196 WriteAsOperandInternal(Out, CV->getAggregateElement(0U), &TypePrinter,
1197 Machine, Context);
1198 for (unsigned i = 1, e = CV->getType()->getVectorNumElements(); i != e;++i){
1199 Out << ", ";
1200 TypePrinter.print(ETy, Out);
1201 Out << ' ';
1202 WriteAsOperandInternal(Out, CV->getAggregateElement(i), &TypePrinter,
1203 Machine, Context);
1204 }
1205 Out << '>';
1206 return;
1207 }
1209 if (isa<ConstantPointerNull>(CV)) {
1210 Out << "null";
1211 return;
1212 }
1214 if (isa<UndefValue>(CV)) {
1215 Out << "undef";
1216 return;
1217 }
1219 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV)) {
1220 Out << CE->getOpcodeName();
1221 WriteOptimizationInfo(Out, CE);
1222 if (CE->isCompare())
1223 Out << ' ' << getPredicateText(CE->getPredicate());
1224 Out << " (";
1226 for (User::const_op_iterator OI=CE->op_begin(); OI != CE->op_end(); ++OI) {
1227 TypePrinter.print((*OI)->getType(), Out);
1228 Out << ' ';
1229 WriteAsOperandInternal(Out, *OI, &TypePrinter, Machine, Context);
1230 if (OI+1 != CE->op_end())
1231 Out << ", ";
1232 }
1234 if (CE->hasIndices()) {
1235 ArrayRef<unsigned> Indices = CE->getIndices();
1236 for (unsigned i = 0, e = Indices.size(); i != e; ++i)
1237 Out << ", " << Indices[i];
1238 }
1240 if (CE->isCast()) {
1241 Out << " to ";
1242 TypePrinter.print(CE->getType(), Out);
1243 }
1245 Out << ')';
1246 return;
1247 }
1249 Out << "<placeholder or erroneous Constant>";
1250 }
1252 static void WriteMDNodeBodyInternal(raw_ostream &Out, const MDNode *Node,
1253 TypePrinting *TypePrinter,
1254 SlotTracker *Machine,
1255 const Module *Context) {
1256 Out << "!{";
1257 for (unsigned mi = 0, me = Node->getNumOperands(); mi != me; ++mi) {
1258 const Metadata *MD = Node->getOperand(mi);
1259 if (!MD)
1260 Out << "null";
1261 else if (auto *MDV = dyn_cast<ValueAsMetadata>(MD)) {
1262 Value *V = MDV->getValue();
1263 TypePrinter->print(V->getType(), Out);
1264 Out << ' ';
1265 WriteAsOperandInternal(Out, V, TypePrinter, Machine, Context);
1266 } else {
1267 WriteAsOperandInternal(Out, MD, TypePrinter, Machine, Context);
1268 }
1269 if (mi + 1 != me)
1270 Out << ", ";
1271 }
1273 Out << "}";
1274 }
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) {
1282 if (V->hasName()) {
1283 PrintLLVMName(Out, V);
1284 return;
1285 }
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);
1291 return;
1292 }
1294 if (const InlineAsm *IA = dyn_cast<InlineAsm>(V)) {
1295 Out << "asm ";
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 ";
1303 Out << '"';
1304 PrintEscapedString(IA->getAsmString(), Out);
1305 Out << "\", \"";
1306 PrintEscapedString(IA->getConstraintString(), Out);
1307 Out << '"';
1308 return;
1309 }
1311 if (auto *MD = dyn_cast<MetadataAsValue>(V)) {
1312 WriteAsOperandInternal(Out, MD->getMetadata(), TypePrinter, Machine,
1313 Context, /* FromValue */ true);
1314 return;
1315 }
1317 char Prefix = '%';
1318 int Slot;
1319 // If we have a SlotTracker, use it.
1320 if (Machine) {
1321 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
1322 Slot = Machine->getGlobalSlot(GV);
1323 Prefix = '@';
1324 } else {
1325 Slot = Machine->getLocalSlot(V);
1327 // If the local value didn't succeed, then we may be referring to a value
1328 // from a different function. Translate it, as this can happen when using
1329 // address of blocks.
1330 if (Slot == -1)
1331 if ((Machine = createSlotTracker(V))) {
1332 Slot = Machine->getLocalSlot(V);
1333 delete Machine;
1334 }
1335 }
1336 } else if ((Machine = createSlotTracker(V))) {
1337 // Otherwise, create one to get the # and then destroy it.
1338 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
1339 Slot = Machine->getGlobalSlot(GV);
1340 Prefix = '@';
1341 } else {
1342 Slot = Machine->getLocalSlot(V);
1343 }
1344 delete Machine;
1345 Machine = nullptr;
1346 } else {
1347 Slot = -1;
1348 }
1350 if (Slot != -1)
1351 Out << Prefix << Slot;
1352 else
1353 Out << "<badref>";
1354 }
1356 static void WriteAsOperandInternal(raw_ostream &Out, const Metadata *MD,
1357 TypePrinting *TypePrinter,
1358 SlotTracker *Machine, const Module *Context,
1359 bool FromValue) {
1360 if (const MDNode *N = dyn_cast<MDNode>(MD)) {
1361 if (!Machine)
1362 Machine = new SlotTracker(Context);
1363 int Slot = Machine->getMetadataSlot(N);
1364 if (Slot == -1)
1365 Out << "<badref>";
1366 else
1367 Out << '!' << Slot;
1368 return;
1369 }
1371 if (const MDString *MDS = dyn_cast<MDString>(MD)) {
1372 Out << "!\"";
1373 PrintEscapedString(MDS->getString(), Out);
1374 Out << '"';
1375 return;
1376 }
1378 auto *V = cast<ValueAsMetadata>(MD);
1379 assert(TypePrinter && "TypePrinter required for metadata values");
1380 assert((FromValue || !isa<LocalAsMetadata>(V)) &&
1381 "Unexpected function-local metadata outside of value argument");
1383 TypePrinter->print(V->getValue()->getType(), Out);
1384 Out << ' ';
1385 WriteAsOperandInternal(Out, V->getValue(), TypePrinter, Machine, Context);
1386 }
1388 void AssemblyWriter::init() {
1389 if (!TheModule)
1390 return;
1391 TypePrinter.incorporateTypes(*TheModule);
1392 for (const Function &F : *TheModule)
1393 if (const Comdat *C = F.getComdat())
1394 Comdats.insert(C);
1395 for (const GlobalVariable &GV : TheModule->globals())
1396 if (const Comdat *C = GV.getComdat())
1397 Comdats.insert(C);
1398 }
1401 AssemblyWriter::AssemblyWriter(formatted_raw_ostream &o, SlotTracker &Mac,
1402 const Module *M,
1403 AssemblyAnnotationWriter *AAW)
1404 : Out(o), TheModule(M), Machine(Mac), AnnotationWriter(AAW) {
1405 init();
1406 }
1408 AssemblyWriter::AssemblyWriter(formatted_raw_ostream &o, const Module *M,
1409 AssemblyAnnotationWriter *AAW)
1410 : Out(o), TheModule(M), ModuleSlotTracker(createSlotTracker(M)),
1411 Machine(*ModuleSlotTracker), AnnotationWriter(AAW) {
1412 init();
1413 }
1415 AssemblyWriter::~AssemblyWriter() { }
1417 void AssemblyWriter::writeOperand(const Value *Operand, bool PrintType) {
1418 if (!Operand) {
1419 Out << "<null operand!>";
1420 return;
1421 }
1422 if (PrintType) {
1423 TypePrinter.print(Operand->getType(), Out);
1424 Out << ' ';
1425 }
1426 WriteAsOperandInternal(Out, Operand, &TypePrinter, &Machine, TheModule);
1427 }
1429 void AssemblyWriter::writeAtomic(AtomicOrdering Ordering,
1430 SynchronizationScope SynchScope) {
1431 if (Ordering == NotAtomic)
1432 return;
1434 switch (SynchScope) {
1435 case SingleThread: Out << " singlethread"; break;
1436 case CrossThread: break;
1437 }
1439 switch (Ordering) {
1440 default: Out << " <bad ordering " << int(Ordering) << ">"; break;
1441 case Unordered: Out << " unordered"; break;
1442 case Monotonic: Out << " monotonic"; break;
1443 case Acquire: Out << " acquire"; break;
1444 case Release: Out << " release"; break;
1445 case AcquireRelease: Out << " acq_rel"; break;
1446 case SequentiallyConsistent: Out << " seq_cst"; break;
1447 }
1448 }
1450 void AssemblyWriter::writeAtomicCmpXchg(AtomicOrdering SuccessOrdering,
1451 AtomicOrdering FailureOrdering,
1452 SynchronizationScope SynchScope) {
1453 assert(SuccessOrdering != NotAtomic && FailureOrdering != NotAtomic);
1455 switch (SynchScope) {
1456 case SingleThread: Out << " singlethread"; break;
1457 case CrossThread: break;
1458 }
1460 switch (SuccessOrdering) {
1461 default: Out << " <bad ordering " << int(SuccessOrdering) << ">"; 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;
1468 }
1470 switch (FailureOrdering) {
1471 default: Out << " <bad ordering " << int(FailureOrdering) << ">"; break;
1472 case Unordered: Out << " unordered"; break;
1473 case Monotonic: Out << " monotonic"; break;
1474 case Acquire: Out << " acquire"; break;
1475 case Release: Out << " release"; break;
1476 case AcquireRelease: Out << " acq_rel"; break;
1477 case SequentiallyConsistent: Out << " seq_cst"; break;
1478 }
1479 }
1481 void AssemblyWriter::writeParamOperand(const Value *Operand,
1482 AttributeSet Attrs, unsigned Idx) {
1483 if (!Operand) {
1484 Out << "<null operand!>";
1485 return;
1486 }
1488 // Print the type
1489 TypePrinter.print(Operand->getType(), Out);
1490 // Print parameter attributes list
1491 if (Attrs.hasAttributes(Idx))
1492 Out << ' ' << Attrs.getAsString(Idx);
1493 Out << ' ';
1494 // Print the operand
1495 WriteAsOperandInternal(Out, Operand, &TypePrinter, &Machine, TheModule);
1496 }
1498 void AssemblyWriter::printModule(const Module *M) {
1499 Machine.initialize();
1501 if (shouldPreserveAssemblyUseListOrder())
1502 UseListOrders = predictUseListOrder(M);
1504 if (!M->getModuleIdentifier().empty() &&
1505 // Don't print the ID if it will start a new line (which would
1506 // require a comment char before it).
1507 M->getModuleIdentifier().find('\n') == std::string::npos)
1508 Out << "; ModuleID = '" << M->getModuleIdentifier() << "'\n";
1510 const std::string &DL = M->getDataLayoutStr();
1511 if (!DL.empty())
1512 Out << "target datalayout = \"" << DL << "\"\n";
1513 if (!M->getTargetTriple().empty())
1514 Out << "target triple = \"" << M->getTargetTriple() << "\"\n";
1516 if (!M->getModuleInlineAsm().empty()) {
1517 // Split the string into lines, to make it easier to read the .ll file.
1518 std::string Asm = M->getModuleInlineAsm();
1519 size_t CurPos = 0;
1520 size_t NewLine = Asm.find_first_of('\n', CurPos);
1521 Out << '\n';
1522 while (NewLine != std::string::npos) {
1523 // We found a newline, print the portion of the asm string from the
1524 // last newline up to this newline.
1525 Out << "module asm \"";
1526 PrintEscapedString(std::string(Asm.begin()+CurPos, Asm.begin()+NewLine),
1527 Out);
1528 Out << "\"\n";
1529 CurPos = NewLine+1;
1530 NewLine = Asm.find_first_of('\n', CurPos);
1531 }
1532 std::string rest(Asm.begin()+CurPos, Asm.end());
1533 if (!rest.empty()) {
1534 Out << "module asm \"";
1535 PrintEscapedString(rest, Out);
1536 Out << "\"\n";
1537 }
1538 }
1540 printTypeIdentities();
1542 // Output all comdats.
1543 if (!Comdats.empty())
1544 Out << '\n';
1545 for (const Comdat *C : Comdats) {
1546 printComdat(C);
1547 if (C != Comdats.back())
1548 Out << '\n';
1549 }
1551 // Output all globals.
1552 if (!M->global_empty()) Out << '\n';
1553 for (Module::const_global_iterator I = M->global_begin(), E = M->global_end();
1554 I != E; ++I) {
1555 printGlobal(I); Out << '\n';
1556 }
1558 // Output all aliases.
1559 if (!M->alias_empty()) Out << "\n";
1560 for (Module::const_alias_iterator I = M->alias_begin(), E = M->alias_end();
1561 I != E; ++I)
1562 printAlias(I);
1564 // Output global use-lists.
1565 printUseLists(nullptr);
1567 // Output all of the functions.
1568 for (Module::const_iterator I = M->begin(), E = M->end(); I != E; ++I)
1569 printFunction(I);
1570 assert(UseListOrders.empty() && "All use-lists should have been consumed");
1572 // Output all attribute groups.
1573 if (!Machine.as_empty()) {
1574 Out << '\n';
1575 writeAllAttributeGroups();
1576 }
1578 // Output named metadata.
1579 if (!M->named_metadata_empty()) Out << '\n';
1581 for (Module::const_named_metadata_iterator I = M->named_metadata_begin(),
1582 E = M->named_metadata_end(); I != E; ++I)
1583 printNamedMDNode(I);
1585 // Output metadata.
1586 if (!Machine.mdn_empty()) {
1587 Out << '\n';
1588 writeAllMDNodes();
1589 }
1590 }
1592 void AssemblyWriter::printNamedMDNode(const NamedMDNode *NMD) {
1593 Out << '!';
1594 StringRef Name = NMD->getName();
1595 if (Name.empty()) {
1596 Out << "<empty name> ";
1597 } else {
1598 if (isalpha(static_cast<unsigned char>(Name[0])) ||
1599 Name[0] == '-' || Name[0] == '$' ||
1600 Name[0] == '.' || Name[0] == '_')
1601 Out << Name[0];
1602 else
1603 Out << '\\' << hexdigit(Name[0] >> 4) << hexdigit(Name[0] & 0x0F);
1604 for (unsigned i = 1, e = Name.size(); i != e; ++i) {
1605 unsigned char C = Name[i];
1606 if (isalnum(static_cast<unsigned char>(C)) || C == '-' || C == '$' ||
1607 C == '.' || C == '_')
1608 Out << C;
1609 else
1610 Out << '\\' << hexdigit(C >> 4) << hexdigit(C & 0x0F);
1611 }
1612 }
1613 Out << " = !{";
1614 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
1615 if (i) Out << ", ";
1616 int Slot = Machine.getMetadataSlot(NMD->getOperand(i));
1617 if (Slot == -1)
1618 Out << "<badref>";
1619 else
1620 Out << '!' << Slot;
1621 }
1622 Out << "}\n";
1623 }
1626 static void PrintLinkage(GlobalValue::LinkageTypes LT,
1627 formatted_raw_ostream &Out) {
1628 switch (LT) {
1629 case GlobalValue::ExternalLinkage: break;
1630 case GlobalValue::PrivateLinkage: Out << "private "; break;
1631 case GlobalValue::InternalLinkage: Out << "internal "; break;
1632 case GlobalValue::LinkOnceAnyLinkage: Out << "linkonce "; break;
1633 case GlobalValue::LinkOnceODRLinkage: Out << "linkonce_odr "; break;
1634 case GlobalValue::WeakAnyLinkage: Out << "weak "; break;
1635 case GlobalValue::WeakODRLinkage: Out << "weak_odr "; break;
1636 case GlobalValue::CommonLinkage: Out << "common "; break;
1637 case GlobalValue::AppendingLinkage: Out << "appending "; break;
1638 case GlobalValue::ExternalWeakLinkage: Out << "extern_weak "; break;
1639 case GlobalValue::AvailableExternallyLinkage:
1640 Out << "available_externally ";
1641 break;
1642 }
1643 }
1646 static void PrintVisibility(GlobalValue::VisibilityTypes Vis,
1647 formatted_raw_ostream &Out) {
1648 switch (Vis) {
1649 case GlobalValue::DefaultVisibility: break;
1650 case GlobalValue::HiddenVisibility: Out << "hidden "; break;
1651 case GlobalValue::ProtectedVisibility: Out << "protected "; break;
1652 }
1653 }
1655 static void PrintDLLStorageClass(GlobalValue::DLLStorageClassTypes SCT,
1656 formatted_raw_ostream &Out) {
1657 switch (SCT) {
1658 case GlobalValue::DefaultStorageClass: break;
1659 case GlobalValue::DLLImportStorageClass: Out << "dllimport "; break;
1660 case GlobalValue::DLLExportStorageClass: Out << "dllexport "; break;
1661 }
1662 }
1664 static void PrintThreadLocalModel(GlobalVariable::ThreadLocalMode TLM,
1665 formatted_raw_ostream &Out) {
1666 switch (TLM) {
1667 case GlobalVariable::NotThreadLocal:
1668 break;
1669 case GlobalVariable::GeneralDynamicTLSModel:
1670 Out << "thread_local ";
1671 break;
1672 case GlobalVariable::LocalDynamicTLSModel:
1673 Out << "thread_local(localdynamic) ";
1674 break;
1675 case GlobalVariable::InitialExecTLSModel:
1676 Out << "thread_local(initialexec) ";
1677 break;
1678 case GlobalVariable::LocalExecTLSModel:
1679 Out << "thread_local(localexec) ";
1680 break;
1681 }
1682 }
1684 void AssemblyWriter::printGlobal(const GlobalVariable *GV) {
1685 if (GV->isMaterializable())
1686 Out << "; Materializable\n";
1688 WriteAsOperandInternal(Out, GV, &TypePrinter, &Machine, GV->getParent());
1689 Out << " = ";
1691 if (!GV->hasInitializer() && GV->hasExternalLinkage())
1692 Out << "external ";
1694 PrintLinkage(GV->getLinkage(), Out);
1695 PrintVisibility(GV->getVisibility(), Out);
1696 PrintDLLStorageClass(GV->getDLLStorageClass(), Out);
1697 PrintThreadLocalModel(GV->getThreadLocalMode(), Out);
1698 if (GV->hasUnnamedAddr())
1699 Out << "unnamed_addr ";
1701 if (unsigned AddressSpace = GV->getType()->getAddressSpace())
1702 Out << "addrspace(" << AddressSpace << ") ";
1703 if (GV->isExternallyInitialized()) Out << "externally_initialized ";
1704 Out << (GV->isConstant() ? "constant " : "global ");
1705 TypePrinter.print(GV->getType()->getElementType(), Out);
1707 if (GV->hasInitializer()) {
1708 Out << ' ';
1709 writeOperand(GV->getInitializer(), false);
1710 }
1712 if (GV->hasSection()) {
1713 Out << ", section \"";
1714 PrintEscapedString(GV->getSection(), Out);
1715 Out << '"';
1716 }
1717 if (GV->hasComdat()) {
1718 Out << ", comdat ";
1719 PrintLLVMName(Out, GV->getComdat()->getName(), ComdatPrefix);
1720 }
1721 if (GV->getAlignment())
1722 Out << ", align " << GV->getAlignment();
1724 printInfoComment(*GV);
1725 }
1727 void AssemblyWriter::printAlias(const GlobalAlias *GA) {
1728 if (GA->isMaterializable())
1729 Out << "; Materializable\n";
1731 // Don't crash when dumping partially built GA
1732 if (!GA->hasName())
1733 Out << "<<nameless>> = ";
1734 else {
1735 PrintLLVMName(Out, GA);
1736 Out << " = ";
1737 }
1738 PrintLinkage(GA->getLinkage(), Out);
1739 PrintVisibility(GA->getVisibility(), Out);
1740 PrintDLLStorageClass(GA->getDLLStorageClass(), Out);
1741 PrintThreadLocalModel(GA->getThreadLocalMode(), Out);
1742 if (GA->hasUnnamedAddr())
1743 Out << "unnamed_addr ";
1745 Out << "alias ";
1747 const Constant *Aliasee = GA->getAliasee();
1749 if (!Aliasee) {
1750 TypePrinter.print(GA->getType(), Out);
1751 Out << " <<NULL ALIASEE>>";
1752 } else {
1753 writeOperand(Aliasee, !isa<ConstantExpr>(Aliasee));
1754 }
1756 printInfoComment(*GA);
1757 Out << '\n';
1758 }
1760 void AssemblyWriter::printComdat(const Comdat *C) {
1761 C->print(Out);
1762 }
1764 void AssemblyWriter::printTypeIdentities() {
1765 if (TypePrinter.NumberedTypes.empty() &&
1766 TypePrinter.NamedTypes.empty())
1767 return;
1769 Out << '\n';
1771 // We know all the numbers that each type is used and we know that it is a
1772 // dense assignment. Convert the map to an index table.
1773 std::vector<StructType*> NumberedTypes(TypePrinter.NumberedTypes.size());
1774 for (DenseMap<StructType*, unsigned>::iterator I =
1775 TypePrinter.NumberedTypes.begin(), E = TypePrinter.NumberedTypes.end();
1776 I != E; ++I) {
1777 assert(I->second < NumberedTypes.size() && "Didn't get a dense numbering?");
1778 NumberedTypes[I->second] = I->first;
1779 }
1781 // Emit all numbered types.
1782 for (unsigned i = 0, e = NumberedTypes.size(); i != e; ++i) {
1783 Out << '%' << i << " = type ";
1785 // Make sure we print out at least one level of the type structure, so
1786 // that we do not get %2 = type %2
1787 TypePrinter.printStructBody(NumberedTypes[i], Out);
1788 Out << '\n';
1789 }
1791 for (unsigned i = 0, e = TypePrinter.NamedTypes.size(); i != e; ++i) {
1792 PrintLLVMName(Out, TypePrinter.NamedTypes[i]->getName(), LocalPrefix);
1793 Out << " = type ";
1795 // Make sure we print out at least one level of the type structure, so
1796 // that we do not get %FILE = type %FILE
1797 TypePrinter.printStructBody(TypePrinter.NamedTypes[i], Out);
1798 Out << '\n';
1799 }
1800 }
1802 /// printFunction - Print all aspects of a function.
1803 ///
1804 void AssemblyWriter::printFunction(const Function *F) {
1805 // Print out the return type and name.
1806 Out << '\n';
1808 if (AnnotationWriter) AnnotationWriter->emitFunctionAnnot(F, Out);
1810 if (F->isMaterializable())
1811 Out << "; Materializable\n";
1813 const AttributeSet &Attrs = F->getAttributes();
1814 if (Attrs.hasAttributes(AttributeSet::FunctionIndex)) {
1815 AttributeSet AS = Attrs.getFnAttributes();
1816 std::string AttrStr;
1818 unsigned Idx = 0;
1819 for (unsigned E = AS.getNumSlots(); Idx != E; ++Idx)
1820 if (AS.getSlotIndex(Idx) == AttributeSet::FunctionIndex)
1821 break;
1823 for (AttributeSet::iterator I = AS.begin(Idx), E = AS.end(Idx);
1824 I != E; ++I) {
1825 Attribute Attr = *I;
1826 if (!Attr.isStringAttribute()) {
1827 if (!AttrStr.empty()) AttrStr += ' ';
1828 AttrStr += Attr.getAsString();
1829 }
1830 }
1832 if (!AttrStr.empty())
1833 Out << "; Function Attrs: " << AttrStr << '\n';
1834 }
1836 if (F->isDeclaration())
1837 Out << "declare ";
1838 else
1839 Out << "define ";
1841 PrintLinkage(F->getLinkage(), Out);
1842 PrintVisibility(F->getVisibility(), Out);
1843 PrintDLLStorageClass(F->getDLLStorageClass(), Out);
1845 // Print the calling convention.
1846 if (F->getCallingConv() != CallingConv::C) {
1847 PrintCallingConv(F->getCallingConv(), Out);
1848 Out << " ";
1849 }
1851 FunctionType *FT = F->getFunctionType();
1852 if (Attrs.hasAttributes(AttributeSet::ReturnIndex))
1853 Out << Attrs.getAsString(AttributeSet::ReturnIndex) << ' ';
1854 TypePrinter.print(F->getReturnType(), Out);
1855 Out << ' ';
1856 WriteAsOperandInternal(Out, F, &TypePrinter, &Machine, F->getParent());
1857 Out << '(';
1858 Machine.incorporateFunction(F);
1860 // Loop over the arguments, printing them...
1862 unsigned Idx = 1;
1863 if (!F->isDeclaration()) {
1864 // If this isn't a declaration, print the argument names as well.
1865 for (Function::const_arg_iterator I = F->arg_begin(), E = F->arg_end();
1866 I != E; ++I) {
1867 // Insert commas as we go... the first arg doesn't get a comma
1868 if (I != F->arg_begin()) Out << ", ";
1869 printArgument(I, Attrs, Idx);
1870 Idx++;
1871 }
1872 } else {
1873 // Otherwise, print the types from the function type.
1874 for (unsigned i = 0, e = FT->getNumParams(); i != e; ++i) {
1875 // Insert commas as we go... the first arg doesn't get a comma
1876 if (i) Out << ", ";
1878 // Output type...
1879 TypePrinter.print(FT->getParamType(i), Out);
1881 if (Attrs.hasAttributes(i+1))
1882 Out << ' ' << Attrs.getAsString(i+1);
1883 }
1884 }
1886 // Finish printing arguments...
1887 if (FT->isVarArg()) {
1888 if (FT->getNumParams()) Out << ", ";
1889 Out << "..."; // Output varargs portion of signature!
1890 }
1891 Out << ')';
1892 if (F->hasUnnamedAddr())
1893 Out << " unnamed_addr";
1894 if (Attrs.hasAttributes(AttributeSet::FunctionIndex))
1895 Out << " #" << Machine.getAttributeGroupSlot(Attrs.getFnAttributes());
1896 if (F->hasSection()) {
1897 Out << " section \"";
1898 PrintEscapedString(F->getSection(), Out);
1899 Out << '"';
1900 }
1901 if (F->hasComdat()) {
1902 Out << " comdat ";
1903 PrintLLVMName(Out, F->getComdat()->getName(), ComdatPrefix);
1904 }
1905 if (F->getAlignment())
1906 Out << " align " << F->getAlignment();
1907 if (F->hasGC())
1908 Out << " gc \"" << F->getGC() << '"';
1909 if (F->hasPrefixData()) {
1910 Out << " prefix ";
1911 writeOperand(F->getPrefixData(), true);
1912 }
1913 if (F->hasPrologueData()) {
1914 Out << " prologue ";
1915 writeOperand(F->getPrologueData(), true);
1916 }
1918 if (F->isDeclaration()) {
1919 Out << '\n';
1920 } else {
1921 Out << " {";
1922 // Output all of the function's basic blocks.
1923 for (Function::const_iterator I = F->begin(), E = F->end(); I != E; ++I)
1924 printBasicBlock(I);
1926 // Output the function's use-lists.
1927 printUseLists(F);
1929 Out << "}\n";
1930 }
1932 Machine.purgeFunction();
1933 }
1935 /// printArgument - This member is called for every argument that is passed into
1936 /// the function. Simply print it out
1937 ///
1938 void AssemblyWriter::printArgument(const Argument *Arg,
1939 AttributeSet Attrs, unsigned Idx) {
1940 // Output type...
1941 TypePrinter.print(Arg->getType(), Out);
1943 // Output parameter attributes list
1944 if (Attrs.hasAttributes(Idx))
1945 Out << ' ' << Attrs.getAsString(Idx);
1947 // Output name, if available...
1948 if (Arg->hasName()) {
1949 Out << ' ';
1950 PrintLLVMName(Out, Arg);
1951 }
1952 }
1954 /// printBasicBlock - This member is called for each basic block in a method.
1955 ///
1956 void AssemblyWriter::printBasicBlock(const BasicBlock *BB) {
1957 if (BB->hasName()) { // Print out the label if it exists...
1958 Out << "\n";
1959 PrintLLVMName(Out, BB->getName(), LabelPrefix);
1960 Out << ':';
1961 } else if (!BB->use_empty()) { // Don't print block # of no uses...
1962 Out << "\n; <label>:";
1963 int Slot = Machine.getLocalSlot(BB);
1964 if (Slot != -1)
1965 Out << Slot;
1966 else
1967 Out << "<badref>";
1968 }
1970 if (!BB->getParent()) {
1971 Out.PadToColumn(50);
1972 Out << "; Error: Block without parent!";
1973 } else if (BB != &BB->getParent()->getEntryBlock()) { // Not the entry block?
1974 // Output predecessors for the block.
1975 Out.PadToColumn(50);
1976 Out << ";";
1977 const_pred_iterator PI = pred_begin(BB), PE = pred_end(BB);
1979 if (PI == PE) {
1980 Out << " No predecessors!";
1981 } else {
1982 Out << " preds = ";
1983 writeOperand(*PI, false);
1984 for (++PI; PI != PE; ++PI) {
1985 Out << ", ";
1986 writeOperand(*PI, false);
1987 }
1988 }
1989 }
1991 Out << "\n";
1993 if (AnnotationWriter) AnnotationWriter->emitBasicBlockStartAnnot(BB, Out);
1995 // Output all of the instructions in the basic block...
1996 for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I != E; ++I) {
1997 printInstructionLine(*I);
1998 }
2000 if (AnnotationWriter) AnnotationWriter->emitBasicBlockEndAnnot(BB, Out);
2001 }
2003 /// printInstructionLine - Print an instruction and a newline character.
2004 void AssemblyWriter::printInstructionLine(const Instruction &I) {
2005 printInstruction(I);
2006 Out << '\n';
2007 }
2009 /// printInfoComment - Print a little comment after the instruction indicating
2010 /// which slot it occupies.
2011 ///
2012 void AssemblyWriter::printInfoComment(const Value &V) {
2013 if (AnnotationWriter)
2014 AnnotationWriter->printInfoComment(V, Out);
2015 }
2017 // This member is called for each Instruction in a function..
2018 void AssemblyWriter::printInstruction(const Instruction &I) {
2019 if (AnnotationWriter) AnnotationWriter->emitInstructionAnnot(&I, Out);
2021 // Print out indentation for an instruction.
2022 Out << " ";
2024 // Print out name if it exists...
2025 if (I.hasName()) {
2026 PrintLLVMName(Out, &I);
2027 Out << " = ";
2028 } else if (!I.getType()->isVoidTy()) {
2029 // Print out the def slot taken.
2030 int SlotNum = Machine.getLocalSlot(&I);
2031 if (SlotNum == -1)
2032 Out << "<badref> = ";
2033 else
2034 Out << '%' << SlotNum << " = ";
2035 }
2037 if (const CallInst *CI = dyn_cast<CallInst>(&I)) {
2038 if (CI->isMustTailCall())
2039 Out << "musttail ";
2040 else if (CI->isTailCall())
2041 Out << "tail ";
2042 }
2044 // Print out the opcode...
2045 Out << I.getOpcodeName();
2047 // If this is an atomic load or store, print out the atomic marker.
2048 if ((isa<LoadInst>(I) && cast<LoadInst>(I).isAtomic()) ||
2049 (isa<StoreInst>(I) && cast<StoreInst>(I).isAtomic()))
2050 Out << " atomic";
2052 if (isa<AtomicCmpXchgInst>(I) && cast<AtomicCmpXchgInst>(I).isWeak())
2053 Out << " weak";
2055 // If this is a volatile operation, print out the volatile marker.
2056 if ((isa<LoadInst>(I) && cast<LoadInst>(I).isVolatile()) ||
2057 (isa<StoreInst>(I) && cast<StoreInst>(I).isVolatile()) ||
2058 (isa<AtomicCmpXchgInst>(I) && cast<AtomicCmpXchgInst>(I).isVolatile()) ||
2059 (isa<AtomicRMWInst>(I) && cast<AtomicRMWInst>(I).isVolatile()))
2060 Out << " volatile";
2062 // Print out optimization information.
2063 WriteOptimizationInfo(Out, &I);
2065 // Print out the compare instruction predicates
2066 if (const CmpInst *CI = dyn_cast<CmpInst>(&I))
2067 Out << ' ' << getPredicateText(CI->getPredicate());
2069 // Print out the atomicrmw operation
2070 if (const AtomicRMWInst *RMWI = dyn_cast<AtomicRMWInst>(&I))
2071 writeAtomicRMWOperation(Out, RMWI->getOperation());
2073 // Print out the type of the operands...
2074 const Value *Operand = I.getNumOperands() ? I.getOperand(0) : nullptr;
2076 // Special case conditional branches to swizzle the condition out to the front
2077 if (isa<BranchInst>(I) && cast<BranchInst>(I).isConditional()) {
2078 const BranchInst &BI(cast<BranchInst>(I));
2079 Out << ' ';
2080 writeOperand(BI.getCondition(), true);
2081 Out << ", ";
2082 writeOperand(BI.getSuccessor(0), true);
2083 Out << ", ";
2084 writeOperand(BI.getSuccessor(1), true);
2086 } else if (isa<SwitchInst>(I)) {
2087 const SwitchInst& SI(cast<SwitchInst>(I));
2088 // Special case switch instruction to get formatting nice and correct.
2089 Out << ' ';
2090 writeOperand(SI.getCondition(), true);
2091 Out << ", ";
2092 writeOperand(SI.getDefaultDest(), true);
2093 Out << " [";
2094 for (SwitchInst::ConstCaseIt i = SI.case_begin(), e = SI.case_end();
2095 i != e; ++i) {
2096 Out << "\n ";
2097 writeOperand(i.getCaseValue(), true);
2098 Out << ", ";
2099 writeOperand(i.getCaseSuccessor(), true);
2100 }
2101 Out << "\n ]";
2102 } else if (isa<IndirectBrInst>(I)) {
2103 // Special case indirectbr instruction to get formatting nice and correct.
2104 Out << ' ';
2105 writeOperand(Operand, true);
2106 Out << ", [";
2108 for (unsigned i = 1, e = I.getNumOperands(); i != e; ++i) {
2109 if (i != 1)
2110 Out << ", ";
2111 writeOperand(I.getOperand(i), true);
2112 }
2113 Out << ']';
2114 } else if (const PHINode *PN = dyn_cast<PHINode>(&I)) {
2115 Out << ' ';
2116 TypePrinter.print(I.getType(), Out);
2117 Out << ' ';
2119 for (unsigned op = 0, Eop = PN->getNumIncomingValues(); op < Eop; ++op) {
2120 if (op) Out << ", ";
2121 Out << "[ ";
2122 writeOperand(PN->getIncomingValue(op), false); Out << ", ";
2123 writeOperand(PN->getIncomingBlock(op), false); Out << " ]";
2124 }
2125 } else if (const ExtractValueInst *EVI = dyn_cast<ExtractValueInst>(&I)) {
2126 Out << ' ';
2127 writeOperand(I.getOperand(0), true);
2128 for (const unsigned *i = EVI->idx_begin(), *e = EVI->idx_end(); i != e; ++i)
2129 Out << ", " << *i;
2130 } else if (const InsertValueInst *IVI = dyn_cast<InsertValueInst>(&I)) {
2131 Out << ' ';
2132 writeOperand(I.getOperand(0), true); Out << ", ";
2133 writeOperand(I.getOperand(1), true);
2134 for (const unsigned *i = IVI->idx_begin(), *e = IVI->idx_end(); i != e; ++i)
2135 Out << ", " << *i;
2136 } else if (const LandingPadInst *LPI = dyn_cast<LandingPadInst>(&I)) {
2137 Out << ' ';
2138 TypePrinter.print(I.getType(), Out);
2139 Out << " personality ";
2140 writeOperand(I.getOperand(0), true); Out << '\n';
2142 if (LPI->isCleanup())
2143 Out << " cleanup";
2145 for (unsigned i = 0, e = LPI->getNumClauses(); i != e; ++i) {
2146 if (i != 0 || LPI->isCleanup()) Out << "\n";
2147 if (LPI->isCatch(i))
2148 Out << " catch ";
2149 else
2150 Out << " filter ";
2152 writeOperand(LPI->getClause(i), true);
2153 }
2154 } else if (isa<ReturnInst>(I) && !Operand) {
2155 Out << " void";
2156 } else if (const CallInst *CI = dyn_cast<CallInst>(&I)) {
2157 // Print the calling convention being used.
2158 if (CI->getCallingConv() != CallingConv::C) {
2159 Out << " ";
2160 PrintCallingConv(CI->getCallingConv(), Out);
2161 }
2163 Operand = CI->getCalledValue();
2164 PointerType *PTy = cast<PointerType>(Operand->getType());
2165 FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
2166 Type *RetTy = FTy->getReturnType();
2167 const AttributeSet &PAL = CI->getAttributes();
2169 if (PAL.hasAttributes(AttributeSet::ReturnIndex))
2170 Out << ' ' << PAL.getAsString(AttributeSet::ReturnIndex);
2172 // If possible, print out the short form of the call instruction. We can
2173 // only do this if the first argument is a pointer to a nonvararg function,
2174 // and if the return type is not a pointer to a function.
2175 //
2176 Out << ' ';
2177 if (!FTy->isVarArg() &&
2178 (!RetTy->isPointerTy() ||
2179 !cast<PointerType>(RetTy)->getElementType()->isFunctionTy())) {
2180 TypePrinter.print(RetTy, Out);
2181 Out << ' ';
2182 writeOperand(Operand, false);
2183 } else {
2184 writeOperand(Operand, true);
2185 }
2186 Out << '(';
2187 for (unsigned op = 0, Eop = CI->getNumArgOperands(); op < Eop; ++op) {
2188 if (op > 0)
2189 Out << ", ";
2190 writeParamOperand(CI->getArgOperand(op), PAL, op + 1);
2191 }
2193 // Emit an ellipsis if this is a musttail call in a vararg function. This
2194 // is only to aid readability, musttail calls forward varargs by default.
2195 if (CI->isMustTailCall() && CI->getParent() &&
2196 CI->getParent()->getParent() &&
2197 CI->getParent()->getParent()->isVarArg())
2198 Out << ", ...";
2200 Out << ')';
2201 if (PAL.hasAttributes(AttributeSet::FunctionIndex))
2202 Out << " #" << Machine.getAttributeGroupSlot(PAL.getFnAttributes());
2203 } else if (const InvokeInst *II = dyn_cast<InvokeInst>(&I)) {
2204 Operand = II->getCalledValue();
2205 PointerType *PTy = cast<PointerType>(Operand->getType());
2206 FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
2207 Type *RetTy = FTy->getReturnType();
2208 const AttributeSet &PAL = II->getAttributes();
2210 // Print the calling convention being used.
2211 if (II->getCallingConv() != CallingConv::C) {
2212 Out << " ";
2213 PrintCallingConv(II->getCallingConv(), Out);
2214 }
2216 if (PAL.hasAttributes(AttributeSet::ReturnIndex))
2217 Out << ' ' << PAL.getAsString(AttributeSet::ReturnIndex);
2219 // If possible, print out the short form of the invoke instruction. We can
2220 // only do this if the first argument is a pointer to a nonvararg function,
2221 // and if the return type is not a pointer to a function.
2222 //
2223 Out << ' ';
2224 if (!FTy->isVarArg() &&
2225 (!RetTy->isPointerTy() ||
2226 !cast<PointerType>(RetTy)->getElementType()->isFunctionTy())) {
2227 TypePrinter.print(RetTy, Out);
2228 Out << ' ';
2229 writeOperand(Operand, false);
2230 } else {
2231 writeOperand(Operand, true);
2232 }
2233 Out << '(';
2234 for (unsigned op = 0, Eop = II->getNumArgOperands(); op < Eop; ++op) {
2235 if (op)
2236 Out << ", ";
2237 writeParamOperand(II->getArgOperand(op), PAL, op + 1);
2238 }
2240 Out << ')';
2241 if (PAL.hasAttributes(AttributeSet::FunctionIndex))
2242 Out << " #" << Machine.getAttributeGroupSlot(PAL.getFnAttributes());
2244 Out << "\n to ";
2245 writeOperand(II->getNormalDest(), true);
2246 Out << " unwind ";
2247 writeOperand(II->getUnwindDest(), true);
2249 } else if (const AllocaInst *AI = dyn_cast<AllocaInst>(&I)) {
2250 Out << ' ';
2251 if (AI->isUsedWithInAlloca())
2252 Out << "inalloca ";
2253 TypePrinter.print(AI->getAllocatedType(), Out);
2254 if (!AI->getArraySize() || AI->isArrayAllocation()) {
2255 Out << ", ";
2256 writeOperand(AI->getArraySize(), true);
2257 }
2258 if (AI->getAlignment()) {
2259 Out << ", align " << AI->getAlignment();
2260 }
2261 } else if (isa<CastInst>(I)) {
2262 if (Operand) {
2263 Out << ' ';
2264 writeOperand(Operand, true); // Work with broken code
2265 }
2266 Out << " to ";
2267 TypePrinter.print(I.getType(), Out);
2268 } else if (isa<VAArgInst>(I)) {
2269 if (Operand) {
2270 Out << ' ';
2271 writeOperand(Operand, true); // Work with broken code
2272 }
2273 Out << ", ";
2274 TypePrinter.print(I.getType(), Out);
2275 } else if (Operand) { // Print the normal way.
2277 // PrintAllTypes - Instructions who have operands of all the same type
2278 // omit the type from all but the first operand. If the instruction has
2279 // different type operands (for example br), then they are all printed.
2280 bool PrintAllTypes = false;
2281 Type *TheType = Operand->getType();
2283 // Select, Store and ShuffleVector always print all types.
2284 if (isa<SelectInst>(I) || isa<StoreInst>(I) || isa<ShuffleVectorInst>(I)
2285 || isa<ReturnInst>(I)) {
2286 PrintAllTypes = true;
2287 } else {
2288 for (unsigned i = 1, E = I.getNumOperands(); i != E; ++i) {
2289 Operand = I.getOperand(i);
2290 // note that Operand shouldn't be null, but the test helps make dump()
2291 // more tolerant of malformed IR
2292 if (Operand && Operand->getType() != TheType) {
2293 PrintAllTypes = true; // We have differing types! Print them all!
2294 break;
2295 }
2296 }
2297 }
2299 if (!PrintAllTypes) {
2300 Out << ' ';
2301 TypePrinter.print(TheType, Out);
2302 }
2304 Out << ' ';
2305 for (unsigned i = 0, E = I.getNumOperands(); i != E; ++i) {
2306 if (i) Out << ", ";
2307 writeOperand(I.getOperand(i), PrintAllTypes);
2308 }
2309 }
2311 // Print atomic ordering/alignment for memory operations
2312 if (const LoadInst *LI = dyn_cast<LoadInst>(&I)) {
2313 if (LI->isAtomic())
2314 writeAtomic(LI->getOrdering(), LI->getSynchScope());
2315 if (LI->getAlignment())
2316 Out << ", align " << LI->getAlignment();
2317 } else if (const StoreInst *SI = dyn_cast<StoreInst>(&I)) {
2318 if (SI->isAtomic())
2319 writeAtomic(SI->getOrdering(), SI->getSynchScope());
2320 if (SI->getAlignment())
2321 Out << ", align " << SI->getAlignment();
2322 } else if (const AtomicCmpXchgInst *CXI = dyn_cast<AtomicCmpXchgInst>(&I)) {
2323 writeAtomicCmpXchg(CXI->getSuccessOrdering(), CXI->getFailureOrdering(),
2324 CXI->getSynchScope());
2325 } else if (const AtomicRMWInst *RMWI = dyn_cast<AtomicRMWInst>(&I)) {
2326 writeAtomic(RMWI->getOrdering(), RMWI->getSynchScope());
2327 } else if (const FenceInst *FI = dyn_cast<FenceInst>(&I)) {
2328 writeAtomic(FI->getOrdering(), FI->getSynchScope());
2329 }
2331 // Print Metadata info.
2332 SmallVector<std::pair<unsigned, MDNode *>, 4> InstMD;
2333 I.getAllMetadata(InstMD);
2334 if (!InstMD.empty()) {
2335 SmallVector<StringRef, 8> MDNames;
2336 I.getType()->getContext().getMDKindNames(MDNames);
2337 for (unsigned i = 0, e = InstMD.size(); i != e; ++i) {
2338 unsigned Kind = InstMD[i].first;
2339 if (Kind < MDNames.size()) {
2340 Out << ", !" << MDNames[Kind];
2341 } else {
2342 Out << ", !<unknown kind #" << Kind << ">";
2343 }
2344 Out << ' ';
2345 WriteAsOperandInternal(Out, InstMD[i].second, &TypePrinter, &Machine,
2346 TheModule);
2347 }
2348 }
2349 printInfoComment(I);
2350 }
2352 static void WriteMDNodeComment(const MDNode *Node,
2353 formatted_raw_ostream &Out) {
2354 if (Node->getNumOperands() < 1)
2355 return;
2357 Metadata *Op = Node->getOperand(0);
2358 if (!Op || !isa<MDString>(Op))
2359 return;
2361 DIDescriptor Desc(Node);
2362 if (!Desc.Verify())
2363 return;
2365 unsigned Tag = Desc.getTag();
2366 Out.PadToColumn(50);
2367 if (dwarf::TagString(Tag)) {
2368 Out << "; ";
2369 Desc.print(Out);
2370 } else if (Tag == dwarf::DW_TAG_user_base) {
2371 Out << "; [ DW_TAG_user_base ]";
2372 }
2373 }
2375 void AssemblyWriter::writeMDNode(unsigned Slot, const MDNode *Node) {
2376 Out << '!' << Slot << " = ";
2377 printMDNodeBody(Node);
2378 }
2380 void AssemblyWriter::writeAllMDNodes() {
2381 SmallVector<const MDNode *, 16> Nodes;
2382 Nodes.resize(Machine.mdn_size());
2383 for (SlotTracker::mdn_iterator I = Machine.mdn_begin(), E = Machine.mdn_end();
2384 I != E; ++I)
2385 Nodes[I->second] = cast<MDNode>(I->first);
2387 for (unsigned i = 0, e = Nodes.size(); i != e; ++i) {
2388 writeMDNode(i, Nodes[i]);
2389 }
2390 }
2392 void AssemblyWriter::printMDNodeBody(const MDNode *Node) {
2393 WriteMDNodeBodyInternal(Out, Node, &TypePrinter, &Machine, TheModule);
2394 WriteMDNodeComment(Node, Out);
2395 Out << "\n";
2396 }
2398 void AssemblyWriter::writeAllAttributeGroups() {
2399 std::vector<std::pair<AttributeSet, unsigned> > asVec;
2400 asVec.resize(Machine.as_size());
2402 for (SlotTracker::as_iterator I = Machine.as_begin(), E = Machine.as_end();
2403 I != E; ++I)
2404 asVec[I->second] = *I;
2406 for (std::vector<std::pair<AttributeSet, unsigned> >::iterator
2407 I = asVec.begin(), E = asVec.end(); I != E; ++I)
2408 Out << "attributes #" << I->second << " = { "
2409 << I->first.getAsString(AttributeSet::FunctionIndex, true) << " }\n";
2410 }
2412 } // namespace llvm
2414 void AssemblyWriter::printUseListOrder(const UseListOrder &Order) {
2415 bool IsInFunction = Machine.getFunction();
2416 if (IsInFunction)
2417 Out << " ";
2419 Out << "uselistorder";
2420 if (const BasicBlock *BB =
2421 IsInFunction ? nullptr : dyn_cast<BasicBlock>(Order.V)) {
2422 Out << "_bb ";
2423 writeOperand(BB->getParent(), false);
2424 Out << ", ";
2425 writeOperand(BB, false);
2426 } else {
2427 Out << " ";
2428 writeOperand(Order.V, true);
2429 }
2430 Out << ", { ";
2432 assert(Order.Shuffle.size() >= 2 && "Shuffle too small");
2433 Out << Order.Shuffle[0];
2434 for (unsigned I = 1, E = Order.Shuffle.size(); I != E; ++I)
2435 Out << ", " << Order.Shuffle[I];
2436 Out << " }\n";
2437 }
2439 void AssemblyWriter::printUseLists(const Function *F) {
2440 auto hasMore =
2441 [&]() { return !UseListOrders.empty() && UseListOrders.back().F == F; };
2442 if (!hasMore())
2443 // Nothing to do.
2444 return;
2446 Out << "\n; uselistorder directives\n";
2447 while (hasMore()) {
2448 printUseListOrder(UseListOrders.back());
2449 UseListOrders.pop_back();
2450 }
2451 }
2453 //===----------------------------------------------------------------------===//
2454 // External Interface declarations
2455 //===----------------------------------------------------------------------===//
2457 void Module::print(raw_ostream &ROS, AssemblyAnnotationWriter *AAW) const {
2458 SlotTracker SlotTable(this);
2459 formatted_raw_ostream OS(ROS);
2460 AssemblyWriter W(OS, SlotTable, this, AAW);
2461 W.printModule(this);
2462 }
2464 void NamedMDNode::print(raw_ostream &ROS) const {
2465 SlotTracker SlotTable(getParent());
2466 formatted_raw_ostream OS(ROS);
2467 AssemblyWriter W(OS, SlotTable, getParent(), nullptr);
2468 W.printNamedMDNode(this);
2469 }
2471 void Comdat::print(raw_ostream &ROS) const {
2472 PrintLLVMName(ROS, getName(), ComdatPrefix);
2473 ROS << " = comdat ";
2475 switch (getSelectionKind()) {
2476 case Comdat::Any:
2477 ROS << "any";
2478 break;
2479 case Comdat::ExactMatch:
2480 ROS << "exactmatch";
2481 break;
2482 case Comdat::Largest:
2483 ROS << "largest";
2484 break;
2485 case Comdat::NoDuplicates:
2486 ROS << "noduplicates";
2487 break;
2488 case Comdat::SameSize:
2489 ROS << "samesize";
2490 break;
2491 }
2493 ROS << '\n';
2494 }
2496 void Type::print(raw_ostream &OS) const {
2497 TypePrinting TP;
2498 TP.print(const_cast<Type*>(this), OS);
2500 // If the type is a named struct type, print the body as well.
2501 if (StructType *STy = dyn_cast<StructType>(const_cast<Type*>(this)))
2502 if (!STy->isLiteral()) {
2503 OS << " = type ";
2504 TP.printStructBody(STy, OS);
2505 }
2506 }
2508 void Value::print(raw_ostream &ROS) const {
2509 formatted_raw_ostream OS(ROS);
2510 if (const Instruction *I = dyn_cast<Instruction>(this)) {
2511 const Function *F = I->getParent() ? I->getParent()->getParent() : nullptr;
2512 SlotTracker SlotTable(F);
2513 AssemblyWriter W(OS, SlotTable, getModuleFromVal(I), nullptr);
2514 W.printInstruction(*I);
2515 } else if (const BasicBlock *BB = dyn_cast<BasicBlock>(this)) {
2516 SlotTracker SlotTable(BB->getParent());
2517 AssemblyWriter W(OS, SlotTable, getModuleFromVal(BB), nullptr);
2518 W.printBasicBlock(BB);
2519 } else if (const GlobalValue *GV = dyn_cast<GlobalValue>(this)) {
2520 SlotTracker SlotTable(GV->getParent());
2521 AssemblyWriter W(OS, SlotTable, GV->getParent(), nullptr);
2522 if (const GlobalVariable *V = dyn_cast<GlobalVariable>(GV))
2523 W.printGlobal(V);
2524 else if (const Function *F = dyn_cast<Function>(GV))
2525 W.printFunction(F);
2526 else
2527 W.printAlias(cast<GlobalAlias>(GV));
2528 } else if (const MetadataAsValue *V = dyn_cast<MetadataAsValue>(this)) {
2529 V->getMetadata()->print(ROS);
2530 } else if (const Constant *C = dyn_cast<Constant>(this)) {
2531 TypePrinting TypePrinter;
2532 TypePrinter.print(C->getType(), OS);
2533 OS << ' ';
2534 WriteConstantInternal(OS, C, TypePrinter, nullptr, nullptr);
2535 } else if (isa<InlineAsm>(this) || isa<Argument>(this)) {
2536 this->printAsOperand(OS);
2537 } else {
2538 llvm_unreachable("Unknown value to print out!");
2539 }
2540 }
2542 void Value::printAsOperand(raw_ostream &O, bool PrintType, const Module *M) const {
2543 // Fast path: Don't construct and populate a TypePrinting object if we
2544 // won't be needing any types printed.
2545 if (!PrintType && ((!isa<Constant>(this) && !isa<MetadataAsValue>(this)) ||
2546 hasName() || isa<GlobalValue>(this))) {
2547 WriteAsOperandInternal(O, this, nullptr, nullptr, M);
2548 return;
2549 }
2551 if (!M)
2552 M = getModuleFromVal(this);
2554 TypePrinting TypePrinter;
2555 if (M)
2556 TypePrinter.incorporateTypes(*M);
2557 if (PrintType) {
2558 TypePrinter.print(getType(), O);
2559 O << ' ';
2560 }
2562 WriteAsOperandInternal(O, this, &TypePrinter, nullptr, M);
2563 }
2565 void Metadata::print(raw_ostream &ROS) const {
2566 formatted_raw_ostream OS(ROS);
2567 if (auto *N = dyn_cast<MDNode>(this)) {
2568 OS << "metadata ";
2569 SlotTracker SlotTable(static_cast<Function *>(nullptr));
2570 AssemblyWriter W(OS, SlotTable, nullptr, nullptr);
2571 W.printMDNodeBody(N);
2573 return;
2574 }
2575 printAsOperand(OS);
2576 }
2578 void Metadata::printAsOperand(raw_ostream &ROS, bool PrintType,
2579 const Module *M) const {
2580 formatted_raw_ostream OS(ROS);
2581 if (PrintType)
2582 OS << "metadata ";
2584 std::unique_ptr<TypePrinting> TypePrinter;
2585 if (PrintType) {
2586 TypePrinter.reset(new TypePrinting);
2587 if (M)
2588 TypePrinter->incorporateTypes(*M);
2589 }
2590 WriteAsOperandInternal(OS, this, TypePrinter.get(), nullptr, M,
2591 /* FromValue */ true);
2592 }
2594 // Value::dump - allow easy printing of Values from the debugger.
2595 void Value::dump() const { print(dbgs()); dbgs() << '\n'; }
2597 // Type::dump - allow easy printing of Types from the debugger.
2598 void Type::dump() const { print(dbgs()); dbgs() << '\n'; }
2600 // Module::dump() - Allow printing of Modules from the debugger.
2601 void Module::dump() const { print(dbgs(), nullptr); }
2603 // \brief Allow printing of Comdats from the debugger.
2604 void Comdat::dump() const { print(dbgs()); }
2606 // NamedMDNode::dump() - Allow printing of NamedMDNodes from the debugger.
2607 void NamedMDNode::dump() const { print(dbgs()); }
2609 void Metadata::dump() const {
2610 print(dbgs());
2611 dbgs() << '\n';
2612 }