Prefer copy init over direct init. NFC.
[oota-llvm.git] / lib / IR / AsmWriter.cpp
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 //===----------------------------------------------------------------------===//
16
17 #include "llvm/ADT/DenseMap.h"
18 #include "llvm/ADT/STLExtras.h"
19 #include "llvm/ADT/SetVector.h"
20 #include "llvm/ADT/SmallString.h"
21 #include "llvm/ADT/StringExtras.h"
22 #include "llvm/IR/AssemblyAnnotationWriter.h"
23 #include "llvm/IR/CFG.h"
24 #include "llvm/IR/CallingConv.h"
25 #include "llvm/IR/Constants.h"
26 #include "llvm/IR/DebugInfo.h"
27 #include "llvm/IR/DerivedTypes.h"
28 #include "llvm/IR/IRPrintingPasses.h"
29 #include "llvm/IR/InlineAsm.h"
30 #include "llvm/IR/IntrinsicInst.h"
31 #include "llvm/IR/LLVMContext.h"
32 #include "llvm/IR/Module.h"
33 #include "llvm/IR/Operator.h"
34 #include "llvm/IR/Statepoint.h"
35 #include "llvm/IR/TypeFinder.h"
36 #include "llvm/IR/UseListOrder.h"
37 #include "llvm/IR/ValueSymbolTable.h"
38 #include "llvm/Support/Debug.h"
39 #include "llvm/Support/Dwarf.h"
40 #include "llvm/Support/ErrorHandling.h"
41 #include "llvm/Support/FormattedStream.h"
42 #include "llvm/Support/MathExtras.h"
43 #include "llvm/Support/raw_ostream.h"
44 #include <algorithm>
45 #include <cctype>
46 using namespace llvm;
47
48 // Make virtual table appear in this compilation unit.
49 AssemblyAnnotationWriter::~AssemblyAnnotationWriter() {}
50
51 //===----------------------------------------------------------------------===//
52 // Helper Functions
53 //===----------------------------------------------------------------------===//
54
55 namespace {
56 struct OrderMap {
57   DenseMap<const Value *, std::pair<unsigned, bool>> IDs;
58
59   unsigned size() const { return IDs.size(); }
60   std::pair<unsigned, bool> &operator[](const Value *V) { return IDs[V]; }
61   std::pair<unsigned, bool> lookup(const Value *V) const {
62     return IDs.lookup(V);
63   }
64   void index(const Value *V) {
65     // Explicitly sequence get-size and insert-value operations to avoid UB.
66     unsigned ID = IDs.size() + 1;
67     IDs[V].first = ID;
68   }
69 };
70 }
71
72 static void orderValue(const Value *V, OrderMap &OM) {
73   if (OM.lookup(V).first)
74     return;
75
76   if (const Constant *C = dyn_cast<Constant>(V))
77     if (C->getNumOperands() && !isa<GlobalValue>(C))
78       for (const Value *Op : C->operands())
79         if (!isa<BasicBlock>(Op) && !isa<GlobalValue>(Op))
80           orderValue(Op, OM);
81
82   // Note: we cannot cache this lookup above, since inserting into the map
83   // changes the map's size, and thus affects the other IDs.
84   OM.index(V);
85 }
86
87 static OrderMap orderModule(const Module *M) {
88   // This needs to match the order used by ValueEnumerator::ValueEnumerator()
89   // and ValueEnumerator::incorporateFunction().
90   OrderMap OM;
91
92   for (const GlobalVariable &G : M->globals()) {
93     if (G.hasInitializer())
94       if (!isa<GlobalValue>(G.getInitializer()))
95         orderValue(G.getInitializer(), OM);
96     orderValue(&G, OM);
97   }
98   for (const GlobalAlias &A : M->aliases()) {
99     if (!isa<GlobalValue>(A.getAliasee()))
100       orderValue(A.getAliasee(), OM);
101     orderValue(&A, OM);
102   }
103   for (const Function &F : *M) {
104     if (F.hasPrefixData())
105       if (!isa<GlobalValue>(F.getPrefixData()))
106         orderValue(F.getPrefixData(), OM);
107
108     if (F.hasPrologueData())
109       if (!isa<GlobalValue>(F.getPrologueData()))
110         orderValue(F.getPrologueData(), OM);
111
112     orderValue(&F, OM);
113
114     if (F.isDeclaration())
115       continue;
116
117     for (const Argument &A : F.args())
118       orderValue(&A, OM);
119     for (const BasicBlock &BB : F) {
120       orderValue(&BB, OM);
121       for (const Instruction &I : BB) {
122         for (const Value *Op : I.operands())
123           if ((isa<Constant>(*Op) && !isa<GlobalValue>(*Op)) ||
124               isa<InlineAsm>(*Op))
125             orderValue(Op, OM);
126         orderValue(&I, OM);
127       }
128     }
129   }
130   return OM;
131 }
132
133 static void predictValueUseListOrderImpl(const Value *V, const Function *F,
134                                          unsigned ID, const OrderMap &OM,
135                                          UseListOrderStack &Stack) {
136   // Predict use-list order for this one.
137   typedef std::pair<const Use *, unsigned> Entry;
138   SmallVector<Entry, 64> List;
139   for (const Use &U : V->uses())
140     // Check if this user will be serialized.
141     if (OM.lookup(U.getUser()).first)
142       List.push_back(std::make_pair(&U, List.size()));
143
144   if (List.size() < 2)
145     // We may have lost some users.
146     return;
147
148   bool GetsReversed =
149       !isa<GlobalVariable>(V) && !isa<Function>(V) && !isa<BasicBlock>(V);
150   if (auto *BA = dyn_cast<BlockAddress>(V))
151     ID = OM.lookup(BA->getBasicBlock()).first;
152   std::sort(List.begin(), List.end(), [&](const Entry &L, const Entry &R) {
153     const Use *LU = L.first;
154     const Use *RU = R.first;
155     if (LU == RU)
156       return false;
157
158     auto LID = OM.lookup(LU->getUser()).first;
159     auto RID = OM.lookup(RU->getUser()).first;
160
161     // If ID is 4, then expect: 7 6 5 1 2 3.
162     if (LID < RID) {
163       if (GetsReversed)
164         if (RID <= ID)
165           return true;
166       return false;
167     }
168     if (RID < LID) {
169       if (GetsReversed)
170         if (LID <= ID)
171           return false;
172       return true;
173     }
174
175     // LID and RID are equal, so we have different operands of the same user.
176     // Assume operands are added in order for all instructions.
177     if (GetsReversed)
178       if (LID <= ID)
179         return LU->getOperandNo() < RU->getOperandNo();
180     return LU->getOperandNo() > RU->getOperandNo();
181   });
182
183   if (std::is_sorted(
184           List.begin(), List.end(),
185           [](const Entry &L, const Entry &R) { return L.second < R.second; }))
186     // Order is already correct.
187     return;
188
189   // Store the shuffle.
190   Stack.emplace_back(V, F, List.size());
191   assert(List.size() == Stack.back().Shuffle.size() && "Wrong size");
192   for (size_t I = 0, E = List.size(); I != E; ++I)
193     Stack.back().Shuffle[I] = List[I].second;
194 }
195
196 static void predictValueUseListOrder(const Value *V, const Function *F,
197                                      OrderMap &OM, UseListOrderStack &Stack) {
198   auto &IDPair = OM[V];
199   assert(IDPair.first && "Unmapped value");
200   if (IDPair.second)
201     // Already predicted.
202     return;
203
204   // Do the actual prediction.
205   IDPair.second = true;
206   if (!V->use_empty() && std::next(V->use_begin()) != V->use_end())
207     predictValueUseListOrderImpl(V, F, IDPair.first, OM, Stack);
208
209   // Recursive descent into constants.
210   if (const Constant *C = dyn_cast<Constant>(V))
211     if (C->getNumOperands()) // Visit GlobalValues.
212       for (const Value *Op : C->operands())
213         if (isa<Constant>(Op)) // Visit GlobalValues.
214           predictValueUseListOrder(Op, F, OM, Stack);
215 }
216
217 static UseListOrderStack predictUseListOrder(const Module *M) {
218   OrderMap OM = orderModule(M);
219
220   // Use-list orders need to be serialized after all the users have been added
221   // to a value, or else the shuffles will be incomplete.  Store them per
222   // function in a stack.
223   //
224   // Aside from function order, the order of values doesn't matter much here.
225   UseListOrderStack Stack;
226
227   // We want to visit the functions backward now so we can list function-local
228   // constants in the last Function they're used in.  Module-level constants
229   // have already been visited above.
230   for (auto I = M->rbegin(), E = M->rend(); I != E; ++I) {
231     const Function &F = *I;
232     if (F.isDeclaration())
233       continue;
234     for (const BasicBlock &BB : F)
235       predictValueUseListOrder(&BB, &F, OM, Stack);
236     for (const Argument &A : F.args())
237       predictValueUseListOrder(&A, &F, OM, Stack);
238     for (const BasicBlock &BB : F)
239       for (const Instruction &I : BB)
240         for (const Value *Op : I.operands())
241           if (isa<Constant>(*Op) || isa<InlineAsm>(*Op)) // Visit GlobalValues.
242             predictValueUseListOrder(Op, &F, OM, Stack);
243     for (const BasicBlock &BB : F)
244       for (const Instruction &I : BB)
245         predictValueUseListOrder(&I, &F, OM, Stack);
246   }
247
248   // Visit globals last.
249   for (const GlobalVariable &G : M->globals())
250     predictValueUseListOrder(&G, nullptr, OM, Stack);
251   for (const Function &F : *M)
252     predictValueUseListOrder(&F, nullptr, OM, Stack);
253   for (const GlobalAlias &A : M->aliases())
254     predictValueUseListOrder(&A, nullptr, OM, Stack);
255   for (const GlobalVariable &G : M->globals())
256     if (G.hasInitializer())
257       predictValueUseListOrder(G.getInitializer(), nullptr, OM, Stack);
258   for (const GlobalAlias &A : M->aliases())
259     predictValueUseListOrder(A.getAliasee(), nullptr, OM, Stack);
260   for (const Function &F : *M)
261     if (F.hasPrefixData())
262       predictValueUseListOrder(F.getPrefixData(), nullptr, OM, Stack);
263
264   return Stack;
265 }
266
267 static const Module *getModuleFromVal(const Value *V) {
268   if (const Argument *MA = dyn_cast<Argument>(V))
269     return MA->getParent() ? MA->getParent()->getParent() : nullptr;
270
271   if (const BasicBlock *BB = dyn_cast<BasicBlock>(V))
272     return BB->getParent() ? BB->getParent()->getParent() : nullptr;
273
274   if (const Instruction *I = dyn_cast<Instruction>(V)) {
275     const Function *M = I->getParent() ? I->getParent()->getParent() : nullptr;
276     return M ? M->getParent() : nullptr;
277   }
278
279   if (const GlobalValue *GV = dyn_cast<GlobalValue>(V))
280     return GV->getParent();
281
282   if (const auto *MAV = dyn_cast<MetadataAsValue>(V)) {
283     for (const User *U : MAV->users())
284       if (isa<Instruction>(U))
285         if (const Module *M = getModuleFromVal(U))
286           return M;
287     return nullptr;
288   }
289
290   return nullptr;
291 }
292
293 static void PrintCallingConv(unsigned cc, raw_ostream &Out) {
294   switch (cc) {
295   default:                         Out << "cc" << cc; break;
296   case CallingConv::Fast:          Out << "fastcc"; break;
297   case CallingConv::Cold:          Out << "coldcc"; break;
298   case CallingConv::WebKit_JS:     Out << "webkit_jscc"; break;
299   case CallingConv::AnyReg:        Out << "anyregcc"; break;
300   case CallingConv::PreserveMost:  Out << "preserve_mostcc"; break;
301   case CallingConv::PreserveAll:   Out << "preserve_allcc"; break;
302   case CallingConv::GHC:           Out << "ghccc"; break;
303   case CallingConv::X86_StdCall:   Out << "x86_stdcallcc"; break;
304   case CallingConv::X86_FastCall:  Out << "x86_fastcallcc"; break;
305   case CallingConv::X86_ThisCall:  Out << "x86_thiscallcc"; break;
306   case CallingConv::X86_VectorCall:Out << "x86_vectorcallcc"; break;
307   case CallingConv::Intel_OCL_BI:  Out << "intel_ocl_bicc"; break;
308   case CallingConv::ARM_APCS:      Out << "arm_apcscc"; break;
309   case CallingConv::ARM_AAPCS:     Out << "arm_aapcscc"; break;
310   case CallingConv::ARM_AAPCS_VFP: Out << "arm_aapcs_vfpcc"; break;
311   case CallingConv::MSP430_INTR:   Out << "msp430_intrcc"; break;
312   case CallingConv::PTX_Kernel:    Out << "ptx_kernel"; break;
313   case CallingConv::PTX_Device:    Out << "ptx_device"; break;
314   case CallingConv::X86_64_SysV:   Out << "x86_64_sysvcc"; break;
315   case CallingConv::X86_64_Win64:  Out << "x86_64_win64cc"; break;
316   case CallingConv::SPIR_FUNC:     Out << "spir_func"; break;
317   case CallingConv::SPIR_KERNEL:   Out << "spir_kernel"; break;
318   }
319 }
320
321 // PrintEscapedString - Print each character of the specified string, escaping
322 // it if it is not printable or if it is an escape char.
323 static void PrintEscapedString(StringRef Name, raw_ostream &Out) {
324   for (unsigned i = 0, e = Name.size(); i != e; ++i) {
325     unsigned char C = Name[i];
326     if (isprint(C) && C != '\\' && C != '"')
327       Out << C;
328     else
329       Out << '\\' << hexdigit(C >> 4) << hexdigit(C & 0x0F);
330   }
331 }
332
333 enum PrefixType {
334   GlobalPrefix,
335   ComdatPrefix,
336   LabelPrefix,
337   LocalPrefix,
338   NoPrefix
339 };
340
341 /// PrintLLVMName - Turn the specified name into an 'LLVM name', which is either
342 /// prefixed with % (if the string only contains simple characters) or is
343 /// surrounded with ""'s (if it has special chars in it).  Print it out.
344 static void PrintLLVMName(raw_ostream &OS, StringRef Name, PrefixType Prefix) {
345   assert(!Name.empty() && "Cannot get empty name!");
346   switch (Prefix) {
347   case NoPrefix: break;
348   case GlobalPrefix: OS << '@'; break;
349   case ComdatPrefix: OS << '$'; break;
350   case LabelPrefix:  break;
351   case LocalPrefix:  OS << '%'; break;
352   }
353
354   // Scan the name to see if it needs quotes first.
355   bool NeedsQuotes = isdigit(static_cast<unsigned char>(Name[0]));
356   if (!NeedsQuotes) {
357     for (unsigned i = 0, e = Name.size(); i != e; ++i) {
358       // By making this unsigned, the value passed in to isalnum will always be
359       // in the range 0-255.  This is important when building with MSVC because
360       // its implementation will assert.  This situation can arise when dealing
361       // with UTF-8 multibyte characters.
362       unsigned char C = Name[i];
363       if (!isalnum(static_cast<unsigned char>(C)) && C != '-' && C != '.' &&
364           C != '_') {
365         NeedsQuotes = true;
366         break;
367       }
368     }
369   }
370
371   // If we didn't need any quotes, just write out the name in one blast.
372   if (!NeedsQuotes) {
373     OS << Name;
374     return;
375   }
376
377   // Okay, we need quotes.  Output the quotes and escape any scary characters as
378   // needed.
379   OS << '"';
380   PrintEscapedString(Name, OS);
381   OS << '"';
382 }
383
384 /// PrintLLVMName - Turn the specified name into an 'LLVM name', which is either
385 /// prefixed with % (if the string only contains simple characters) or is
386 /// surrounded with ""'s (if it has special chars in it).  Print it out.
387 static void PrintLLVMName(raw_ostream &OS, const Value *V) {
388   PrintLLVMName(OS, V->getName(),
389                 isa<GlobalValue>(V) ? GlobalPrefix : LocalPrefix);
390 }
391
392
393 namespace {
394 class TypePrinting {
395   TypePrinting(const TypePrinting &) = delete;
396   void operator=(const TypePrinting&) = delete;
397 public:
398
399   /// NamedTypes - The named types that are used by the current module.
400   TypeFinder NamedTypes;
401
402   /// NumberedTypes - The numbered types, along with their value.
403   DenseMap<StructType*, unsigned> NumberedTypes;
404
405   TypePrinting() = default;
406
407   void incorporateTypes(const Module &M);
408
409   void print(Type *Ty, raw_ostream &OS);
410
411   void printStructBody(StructType *Ty, raw_ostream &OS);
412 };
413 } // namespace
414
415 void TypePrinting::incorporateTypes(const Module &M) {
416   NamedTypes.run(M, false);
417
418   // The list of struct types we got back includes all the struct types, split
419   // the unnamed ones out to a numbering and remove the anonymous structs.
420   unsigned NextNumber = 0;
421
422   std::vector<StructType*>::iterator NextToUse = NamedTypes.begin(), I, E;
423   for (I = NamedTypes.begin(), E = NamedTypes.end(); I != E; ++I) {
424     StructType *STy = *I;
425
426     // Ignore anonymous types.
427     if (STy->isLiteral())
428       continue;
429
430     if (STy->getName().empty())
431       NumberedTypes[STy] = NextNumber++;
432     else
433       *NextToUse++ = STy;
434   }
435
436   NamedTypes.erase(NextToUse, NamedTypes.end());
437 }
438
439
440 /// CalcTypeName - Write the specified type to the specified raw_ostream, making
441 /// use of type names or up references to shorten the type name where possible.
442 void TypePrinting::print(Type *Ty, raw_ostream &OS) {
443   switch (Ty->getTypeID()) {
444   case Type::VoidTyID:      OS << "void"; return;
445   case Type::HalfTyID:      OS << "half"; return;
446   case Type::FloatTyID:     OS << "float"; return;
447   case Type::DoubleTyID:    OS << "double"; return;
448   case Type::X86_FP80TyID:  OS << "x86_fp80"; return;
449   case Type::FP128TyID:     OS << "fp128"; return;
450   case Type::PPC_FP128TyID: OS << "ppc_fp128"; return;
451   case Type::LabelTyID:     OS << "label"; return;
452   case Type::MetadataTyID:  OS << "metadata"; return;
453   case Type::X86_MMXTyID:   OS << "x86_mmx"; return;
454   case Type::IntegerTyID:
455     OS << 'i' << cast<IntegerType>(Ty)->getBitWidth();
456     return;
457
458   case Type::FunctionTyID: {
459     FunctionType *FTy = cast<FunctionType>(Ty);
460     print(FTy->getReturnType(), OS);
461     OS << " (";
462     for (FunctionType::param_iterator I = FTy->param_begin(),
463          E = FTy->param_end(); I != E; ++I) {
464       if (I != FTy->param_begin())
465         OS << ", ";
466       print(*I, OS);
467     }
468     if (FTy->isVarArg()) {
469       if (FTy->getNumParams()) OS << ", ";
470       OS << "...";
471     }
472     OS << ')';
473     return;
474   }
475   case Type::StructTyID: {
476     StructType *STy = cast<StructType>(Ty);
477
478     if (STy->isLiteral())
479       return printStructBody(STy, OS);
480
481     if (!STy->getName().empty())
482       return PrintLLVMName(OS, STy->getName(), LocalPrefix);
483
484     DenseMap<StructType*, unsigned>::iterator I = NumberedTypes.find(STy);
485     if (I != NumberedTypes.end())
486       OS << '%' << I->second;
487     else  // Not enumerated, print the hex address.
488       OS << "%\"type " << STy << '\"';
489     return;
490   }
491   case Type::PointerTyID: {
492     PointerType *PTy = cast<PointerType>(Ty);
493     print(PTy->getElementType(), OS);
494     if (unsigned AddressSpace = PTy->getAddressSpace())
495       OS << " addrspace(" << AddressSpace << ')';
496     OS << '*';
497     return;
498   }
499   case Type::ArrayTyID: {
500     ArrayType *ATy = cast<ArrayType>(Ty);
501     OS << '[' << ATy->getNumElements() << " x ";
502     print(ATy->getElementType(), OS);
503     OS << ']';
504     return;
505   }
506   case Type::VectorTyID: {
507     VectorType *PTy = cast<VectorType>(Ty);
508     OS << "<" << PTy->getNumElements() << " x ";
509     print(PTy->getElementType(), OS);
510     OS << '>';
511     return;
512   }
513   }
514   llvm_unreachable("Invalid TypeID");
515 }
516
517 void TypePrinting::printStructBody(StructType *STy, raw_ostream &OS) {
518   if (STy->isOpaque()) {
519     OS << "opaque";
520     return;
521   }
522
523   if (STy->isPacked())
524     OS << '<';
525
526   if (STy->getNumElements() == 0) {
527     OS << "{}";
528   } else {
529     StructType::element_iterator I = STy->element_begin();
530     OS << "{ ";
531     print(*I++, OS);
532     for (StructType::element_iterator E = STy->element_end(); I != E; ++I) {
533       OS << ", ";
534       print(*I, OS);
535     }
536
537     OS << " }";
538   }
539   if (STy->isPacked())
540     OS << '>';
541 }
542
543 namespace {
544 //===----------------------------------------------------------------------===//
545 // SlotTracker Class: Enumerate slot numbers for unnamed values
546 //===----------------------------------------------------------------------===//
547 /// This class provides computation of slot numbers for LLVM Assembly writing.
548 ///
549 class SlotTracker {
550 public:
551   /// ValueMap - A mapping of Values to slot numbers.
552   typedef DenseMap<const Value*, unsigned> ValueMap;
553
554 private:
555   /// TheModule - The module for which we are holding slot numbers.
556   const Module* TheModule;
557
558   /// TheFunction - The function for which we are holding slot numbers.
559   const Function* TheFunction;
560   bool FunctionProcessed;
561   bool ShouldInitializeAllMetadata;
562
563   /// mMap - The slot map for the module level data.
564   ValueMap mMap;
565   unsigned mNext;
566
567   /// fMap - The slot map for the function level data.
568   ValueMap fMap;
569   unsigned fNext;
570
571   /// mdnMap - Map for MDNodes.
572   DenseMap<const MDNode*, unsigned> mdnMap;
573   unsigned mdnNext;
574
575   /// asMap - The slot map for attribute sets.
576   DenseMap<AttributeSet, unsigned> asMap;
577   unsigned asNext;
578 public:
579   /// Construct from a module.
580   ///
581   /// If \c ShouldInitializeAllMetadata, initializes all metadata in all
582   /// functions, giving correct numbering for metadata referenced only from
583   /// within a function (even if no functions have been initialized).
584   explicit SlotTracker(const Module *M,
585                        bool ShouldInitializeAllMetadata = false);
586   /// Construct from a function, starting out in incorp state.
587   ///
588   /// If \c ShouldInitializeAllMetadata, initializes all metadata in all
589   /// functions, giving correct numbering for metadata referenced only from
590   /// within a function (even if no functions have been initialized).
591   explicit SlotTracker(const Function *F,
592                        bool ShouldInitializeAllMetadata = false);
593
594   /// Return the slot number of the specified value in it's type
595   /// plane.  If something is not in the SlotTracker, return -1.
596   int getLocalSlot(const Value *V);
597   int getGlobalSlot(const GlobalValue *V);
598   int getMetadataSlot(const MDNode *N);
599   int getAttributeGroupSlot(AttributeSet AS);
600
601   /// If you'd like to deal with a function instead of just a module, use
602   /// this method to get its data into the SlotTracker.
603   void incorporateFunction(const Function *F) {
604     TheFunction = F;
605     FunctionProcessed = false;
606   }
607
608   const Function *getFunction() const { return TheFunction; }
609
610   /// After calling incorporateFunction, use this method to remove the
611   /// most recently incorporated function from the SlotTracker. This
612   /// will reset the state of the machine back to just the module contents.
613   void purgeFunction();
614
615   /// MDNode map iterators.
616   typedef DenseMap<const MDNode*, unsigned>::iterator mdn_iterator;
617   mdn_iterator mdn_begin() { return mdnMap.begin(); }
618   mdn_iterator mdn_end() { return mdnMap.end(); }
619   unsigned mdn_size() const { return mdnMap.size(); }
620   bool mdn_empty() const { return mdnMap.empty(); }
621
622   /// AttributeSet map iterators.
623   typedef DenseMap<AttributeSet, unsigned>::iterator as_iterator;
624   as_iterator as_begin()   { return asMap.begin(); }
625   as_iterator as_end()     { return asMap.end(); }
626   unsigned as_size() const { return asMap.size(); }
627   bool as_empty() const    { return asMap.empty(); }
628
629   /// This function does the actual initialization.
630   inline void initialize();
631
632   // Implementation Details
633 private:
634   /// CreateModuleSlot - Insert the specified GlobalValue* into the slot table.
635   void CreateModuleSlot(const GlobalValue *V);
636
637   /// CreateMetadataSlot - Insert the specified MDNode* into the slot table.
638   void CreateMetadataSlot(const MDNode *N);
639
640   /// CreateFunctionSlot - Insert the specified Value* into the slot table.
641   void CreateFunctionSlot(const Value *V);
642
643   /// \brief Insert the specified AttributeSet into the slot table.
644   void CreateAttributeSetSlot(AttributeSet AS);
645
646   /// Add all of the module level global variables (and their initializers)
647   /// and function declarations, but not the contents of those functions.
648   void processModule();
649
650   /// Add all of the functions arguments, basic blocks, and instructions.
651   void processFunction();
652
653   /// Add all of the metadata from a function.
654   void processFunctionMetadata(const Function &F);
655
656   /// Add all of the metadata from an instruction.
657   void processInstructionMetadata(const Instruction &I);
658
659   SlotTracker(const SlotTracker &) = delete;
660   void operator=(const SlotTracker &) = delete;
661 };
662 } // namespace
663
664 static SlotTracker *createSlotTracker(const Module *M) {
665   return new SlotTracker(M);
666 }
667
668 static SlotTracker *createSlotTracker(const Value *V) {
669   if (const Argument *FA = dyn_cast<Argument>(V))
670     return new SlotTracker(FA->getParent());
671
672   if (const Instruction *I = dyn_cast<Instruction>(V))
673     if (I->getParent())
674       return new SlotTracker(I->getParent()->getParent());
675
676   if (const BasicBlock *BB = dyn_cast<BasicBlock>(V))
677     return new SlotTracker(BB->getParent());
678
679   if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(V))
680     return new SlotTracker(GV->getParent());
681
682   if (const GlobalAlias *GA = dyn_cast<GlobalAlias>(V))
683     return new SlotTracker(GA->getParent());
684
685   if (const Function *Func = dyn_cast<Function>(V))
686     return new SlotTracker(Func);
687
688   return nullptr;
689 }
690
691 #if 0
692 #define ST_DEBUG(X) dbgs() << X
693 #else
694 #define ST_DEBUG(X)
695 #endif
696
697 // Module level constructor. Causes the contents of the Module (sans functions)
698 // to be added to the slot table.
699 SlotTracker::SlotTracker(const Module *M, bool ShouldInitializeAllMetadata)
700     : TheModule(M), TheFunction(nullptr), FunctionProcessed(false),
701       ShouldInitializeAllMetadata(ShouldInitializeAllMetadata), mNext(0),
702       fNext(0), mdnNext(0), asNext(0) {}
703
704 // Function level constructor. Causes the contents of the Module and the one
705 // function provided to be added to the slot table.
706 SlotTracker::SlotTracker(const Function *F, bool ShouldInitializeAllMetadata)
707     : TheModule(F ? F->getParent() : nullptr), TheFunction(F),
708       FunctionProcessed(false),
709       ShouldInitializeAllMetadata(ShouldInitializeAllMetadata), mNext(0),
710       fNext(0), mdnNext(0), asNext(0) {}
711
712 inline void SlotTracker::initialize() {
713   if (TheModule) {
714     processModule();
715     TheModule = nullptr; ///< Prevent re-processing next time we're called.
716   }
717
718   if (TheFunction && !FunctionProcessed)
719     processFunction();
720 }
721
722 // Iterate through all the global variables, functions, and global
723 // variable initializers and create slots for them.
724 void SlotTracker::processModule() {
725   ST_DEBUG("begin processModule!\n");
726
727   // Add all of the unnamed global variables to the value table.
728   for (Module::const_global_iterator I = TheModule->global_begin(),
729          E = TheModule->global_end(); I != E; ++I) {
730     if (!I->hasName())
731       CreateModuleSlot(I);
732   }
733
734   // Add metadata used by named metadata.
735   for (Module::const_named_metadata_iterator
736          I = TheModule->named_metadata_begin(),
737          E = TheModule->named_metadata_end(); I != E; ++I) {
738     const NamedMDNode *NMD = I;
739     for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i)
740       CreateMetadataSlot(NMD->getOperand(i));
741   }
742
743   for (Module::const_iterator I = TheModule->begin(), E = TheModule->end();
744        I != E; ++I) {
745     if (!I->hasName())
746       // Add all the unnamed functions to the table.
747       CreateModuleSlot(I);
748
749     if (ShouldInitializeAllMetadata)
750       processFunctionMetadata(*I);
751
752     // Add all the function attributes to the table.
753     // FIXME: Add attributes of other objects?
754     AttributeSet FnAttrs = I->getAttributes().getFnAttributes();
755     if (FnAttrs.hasAttributes(AttributeSet::FunctionIndex))
756       CreateAttributeSetSlot(FnAttrs);
757   }
758
759   ST_DEBUG("end processModule!\n");
760 }
761
762 // Process the arguments, basic blocks, and instructions  of a function.
763 void SlotTracker::processFunction() {
764   ST_DEBUG("begin processFunction!\n");
765   fNext = 0;
766
767   // Add all the function arguments with no names.
768   for(Function::const_arg_iterator AI = TheFunction->arg_begin(),
769       AE = TheFunction->arg_end(); AI != AE; ++AI)
770     if (!AI->hasName())
771       CreateFunctionSlot(AI);
772
773   ST_DEBUG("Inserting Instructions:\n");
774
775   // Add all of the basic blocks and instructions with no names.
776   for (auto &BB : *TheFunction) {
777     if (!BB.hasName())
778       CreateFunctionSlot(&BB);
779
780     processFunctionMetadata(*TheFunction);
781
782     for (auto &I : BB) {
783       if (!I.getType()->isVoidTy() && !I.hasName())
784         CreateFunctionSlot(&I);
785
786       // We allow direct calls to any llvm.foo function here, because the
787       // target may not be linked into the optimizer.
788       if (const CallInst *CI = dyn_cast<CallInst>(&I)) {
789         // Add all the call attributes to the table.
790         AttributeSet Attrs = CI->getAttributes().getFnAttributes();
791         if (Attrs.hasAttributes(AttributeSet::FunctionIndex))
792           CreateAttributeSetSlot(Attrs);
793       } else if (const InvokeInst *II = dyn_cast<InvokeInst>(&I)) {
794         // Add all the call attributes to the table.
795         AttributeSet Attrs = II->getAttributes().getFnAttributes();
796         if (Attrs.hasAttributes(AttributeSet::FunctionIndex))
797           CreateAttributeSetSlot(Attrs);
798       }
799     }
800   }
801
802   FunctionProcessed = true;
803
804   ST_DEBUG("end processFunction!\n");
805 }
806
807 void SlotTracker::processFunctionMetadata(const Function &F) {
808   SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
809   for (auto &BB : F) {
810     F.getAllMetadata(MDs);
811     for (auto &MD : MDs)
812       CreateMetadataSlot(MD.second);
813
814     for (auto &I : BB)
815       processInstructionMetadata(I);
816   }
817 }
818
819 void SlotTracker::processInstructionMetadata(const Instruction &I) {
820   // Process metadata used directly by intrinsics.
821   if (const CallInst *CI = dyn_cast<CallInst>(&I))
822     if (Function *F = CI->getCalledFunction())
823       if (F->isIntrinsic())
824         for (auto &Op : I.operands())
825           if (auto *V = dyn_cast_or_null<MetadataAsValue>(Op))
826             if (MDNode *N = dyn_cast<MDNode>(V->getMetadata()))
827               CreateMetadataSlot(N);
828
829   // Process metadata attached to this instruction.
830   SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
831   I.getAllMetadata(MDs);
832   for (auto &MD : MDs)
833     CreateMetadataSlot(MD.second);
834 }
835
836 /// Clean up after incorporating a function. This is the only way to get out of
837 /// the function incorporation state that affects get*Slot/Create*Slot. Function
838 /// incorporation state is indicated by TheFunction != 0.
839 void SlotTracker::purgeFunction() {
840   ST_DEBUG("begin purgeFunction!\n");
841   fMap.clear(); // Simply discard the function level map
842   TheFunction = nullptr;
843   FunctionProcessed = false;
844   ST_DEBUG("end purgeFunction!\n");
845 }
846
847 /// getGlobalSlot - Get the slot number of a global value.
848 int SlotTracker::getGlobalSlot(const GlobalValue *V) {
849   // Check for uninitialized state and do lazy initialization.
850   initialize();
851
852   // Find the value in the module map
853   ValueMap::iterator MI = mMap.find(V);
854   return MI == mMap.end() ? -1 : (int)MI->second;
855 }
856
857 /// getMetadataSlot - Get the slot number of a MDNode.
858 int SlotTracker::getMetadataSlot(const MDNode *N) {
859   // Check for uninitialized state and do lazy initialization.
860   initialize();
861
862   // Find the MDNode in the module map
863   mdn_iterator MI = mdnMap.find(N);
864   return MI == mdnMap.end() ? -1 : (int)MI->second;
865 }
866
867
868 /// getLocalSlot - Get the slot number for a value that is local to a function.
869 int SlotTracker::getLocalSlot(const Value *V) {
870   assert(!isa<Constant>(V) && "Can't get a constant or global slot with this!");
871
872   // Check for uninitialized state and do lazy initialization.
873   initialize();
874
875   ValueMap::iterator FI = fMap.find(V);
876   return FI == fMap.end() ? -1 : (int)FI->second;
877 }
878
879 int SlotTracker::getAttributeGroupSlot(AttributeSet AS) {
880   // Check for uninitialized state and do lazy initialization.
881   initialize();
882
883   // Find the AttributeSet in the module map.
884   as_iterator AI = asMap.find(AS);
885   return AI == asMap.end() ? -1 : (int)AI->second;
886 }
887
888 /// CreateModuleSlot - Insert the specified GlobalValue* into the slot table.
889 void SlotTracker::CreateModuleSlot(const GlobalValue *V) {
890   assert(V && "Can't insert a null Value into SlotTracker!");
891   assert(!V->getType()->isVoidTy() && "Doesn't need a slot!");
892   assert(!V->hasName() && "Doesn't need a slot!");
893
894   unsigned DestSlot = mNext++;
895   mMap[V] = DestSlot;
896
897   ST_DEBUG("  Inserting value [" << V->getType() << "] = " << V << " slot=" <<
898            DestSlot << " [");
899   // G = Global, F = Function, A = Alias, o = other
900   ST_DEBUG((isa<GlobalVariable>(V) ? 'G' :
901             (isa<Function>(V) ? 'F' :
902              (isa<GlobalAlias>(V) ? 'A' : 'o'))) << "]\n");
903 }
904
905 /// CreateSlot - Create a new slot for the specified value if it has no name.
906 void SlotTracker::CreateFunctionSlot(const Value *V) {
907   assert(!V->getType()->isVoidTy() && !V->hasName() && "Doesn't need a slot!");
908
909   unsigned DestSlot = fNext++;
910   fMap[V] = DestSlot;
911
912   // G = Global, F = Function, o = other
913   ST_DEBUG("  Inserting value [" << V->getType() << "] = " << V << " slot=" <<
914            DestSlot << " [o]\n");
915 }
916
917 /// CreateModuleSlot - Insert the specified MDNode* into the slot table.
918 void SlotTracker::CreateMetadataSlot(const MDNode *N) {
919   assert(N && "Can't insert a null Value into SlotTracker!");
920
921   unsigned DestSlot = mdnNext;
922   if (!mdnMap.insert(std::make_pair(N, DestSlot)).second)
923     return;
924   ++mdnNext;
925
926   // Recursively add any MDNodes referenced by operands.
927   for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i)
928     if (const MDNode *Op = dyn_cast_or_null<MDNode>(N->getOperand(i)))
929       CreateMetadataSlot(Op);
930 }
931
932 void SlotTracker::CreateAttributeSetSlot(AttributeSet AS) {
933   assert(AS.hasAttributes(AttributeSet::FunctionIndex) &&
934          "Doesn't need a slot!");
935
936   as_iterator I = asMap.find(AS);
937   if (I != asMap.end())
938     return;
939
940   unsigned DestSlot = asNext++;
941   asMap[AS] = DestSlot;
942 }
943
944 //===----------------------------------------------------------------------===//
945 // AsmWriter Implementation
946 //===----------------------------------------------------------------------===//
947
948 static void WriteAsOperandInternal(raw_ostream &Out, const Value *V,
949                                    TypePrinting *TypePrinter,
950                                    SlotTracker *Machine,
951                                    const Module *Context);
952
953 static void WriteAsOperandInternal(raw_ostream &Out, const Metadata *MD,
954                                    TypePrinting *TypePrinter,
955                                    SlotTracker *Machine, const Module *Context,
956                                    bool FromValue = false);
957
958 static const char *getPredicateText(unsigned predicate) {
959   const char * pred = "unknown";
960   switch (predicate) {
961   case FCmpInst::FCMP_FALSE: pred = "false"; break;
962   case FCmpInst::FCMP_OEQ:   pred = "oeq"; break;
963   case FCmpInst::FCMP_OGT:   pred = "ogt"; break;
964   case FCmpInst::FCMP_OGE:   pred = "oge"; break;
965   case FCmpInst::FCMP_OLT:   pred = "olt"; break;
966   case FCmpInst::FCMP_OLE:   pred = "ole"; break;
967   case FCmpInst::FCMP_ONE:   pred = "one"; break;
968   case FCmpInst::FCMP_ORD:   pred = "ord"; break;
969   case FCmpInst::FCMP_UNO:   pred = "uno"; break;
970   case FCmpInst::FCMP_UEQ:   pred = "ueq"; break;
971   case FCmpInst::FCMP_UGT:   pred = "ugt"; break;
972   case FCmpInst::FCMP_UGE:   pred = "uge"; break;
973   case FCmpInst::FCMP_ULT:   pred = "ult"; break;
974   case FCmpInst::FCMP_ULE:   pred = "ule"; break;
975   case FCmpInst::FCMP_UNE:   pred = "une"; break;
976   case FCmpInst::FCMP_TRUE:  pred = "true"; break;
977   case ICmpInst::ICMP_EQ:    pred = "eq"; break;
978   case ICmpInst::ICMP_NE:    pred = "ne"; break;
979   case ICmpInst::ICMP_SGT:   pred = "sgt"; break;
980   case ICmpInst::ICMP_SGE:   pred = "sge"; break;
981   case ICmpInst::ICMP_SLT:   pred = "slt"; break;
982   case ICmpInst::ICMP_SLE:   pred = "sle"; break;
983   case ICmpInst::ICMP_UGT:   pred = "ugt"; break;
984   case ICmpInst::ICMP_UGE:   pred = "uge"; break;
985   case ICmpInst::ICMP_ULT:   pred = "ult"; break;
986   case ICmpInst::ICMP_ULE:   pred = "ule"; break;
987   }
988   return pred;
989 }
990
991 static void writeAtomicRMWOperation(raw_ostream &Out,
992                                     AtomicRMWInst::BinOp Op) {
993   switch (Op) {
994   default: Out << " <unknown operation " << Op << ">"; break;
995   case AtomicRMWInst::Xchg: Out << " xchg"; break;
996   case AtomicRMWInst::Add:  Out << " add"; break;
997   case AtomicRMWInst::Sub:  Out << " sub"; break;
998   case AtomicRMWInst::And:  Out << " and"; break;
999   case AtomicRMWInst::Nand: Out << " nand"; break;
1000   case AtomicRMWInst::Or:   Out << " or"; break;
1001   case AtomicRMWInst::Xor:  Out << " xor"; break;
1002   case AtomicRMWInst::Max:  Out << " max"; break;
1003   case AtomicRMWInst::Min:  Out << " min"; break;
1004   case AtomicRMWInst::UMax: Out << " umax"; break;
1005   case AtomicRMWInst::UMin: Out << " umin"; break;
1006   }
1007 }
1008
1009 static void WriteOptimizationInfo(raw_ostream &Out, const User *U) {
1010   if (const FPMathOperator *FPO = dyn_cast<const FPMathOperator>(U)) {
1011     // Unsafe algebra implies all the others, no need to write them all out
1012     if (FPO->hasUnsafeAlgebra())
1013       Out << " fast";
1014     else {
1015       if (FPO->hasNoNaNs())
1016         Out << " nnan";
1017       if (FPO->hasNoInfs())
1018         Out << " ninf";
1019       if (FPO->hasNoSignedZeros())
1020         Out << " nsz";
1021       if (FPO->hasAllowReciprocal())
1022         Out << " arcp";
1023     }
1024   }
1025
1026   if (const OverflowingBinaryOperator *OBO =
1027         dyn_cast<OverflowingBinaryOperator>(U)) {
1028     if (OBO->hasNoUnsignedWrap())
1029       Out << " nuw";
1030     if (OBO->hasNoSignedWrap())
1031       Out << " nsw";
1032   } else if (const PossiblyExactOperator *Div =
1033                dyn_cast<PossiblyExactOperator>(U)) {
1034     if (Div->isExact())
1035       Out << " exact";
1036   } else if (const GEPOperator *GEP = dyn_cast<GEPOperator>(U)) {
1037     if (GEP->isInBounds())
1038       Out << " inbounds";
1039   }
1040 }
1041
1042 static void WriteConstantInternal(raw_ostream &Out, const Constant *CV,
1043                                   TypePrinting &TypePrinter,
1044                                   SlotTracker *Machine,
1045                                   const Module *Context) {
1046   if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV)) {
1047     if (CI->getType()->isIntegerTy(1)) {
1048       Out << (CI->getZExtValue() ? "true" : "false");
1049       return;
1050     }
1051     Out << CI->getValue();
1052     return;
1053   }
1054
1055   if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV)) {
1056     if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEsingle ||
1057         &CFP->getValueAPF().getSemantics() == &APFloat::IEEEdouble) {
1058       // We would like to output the FP constant value in exponential notation,
1059       // but we cannot do this if doing so will lose precision.  Check here to
1060       // make sure that we only output it in exponential format if we can parse
1061       // the value back and get the same value.
1062       //
1063       bool ignored;
1064       bool isHalf = &CFP->getValueAPF().getSemantics()==&APFloat::IEEEhalf;
1065       bool isDouble = &CFP->getValueAPF().getSemantics()==&APFloat::IEEEdouble;
1066       bool isInf = CFP->getValueAPF().isInfinity();
1067       bool isNaN = CFP->getValueAPF().isNaN();
1068       if (!isHalf && !isInf && !isNaN) {
1069         double Val = isDouble ? CFP->getValueAPF().convertToDouble() :
1070                                 CFP->getValueAPF().convertToFloat();
1071         SmallString<128> StrVal;
1072         raw_svector_ostream(StrVal) << Val;
1073
1074         // Check to make sure that the stringized number is not some string like
1075         // "Inf" or NaN, that atof will accept, but the lexer will not.  Check
1076         // that the string matches the "[-+]?[0-9]" regex.
1077         //
1078         if ((StrVal[0] >= '0' && StrVal[0] <= '9') ||
1079             ((StrVal[0] == '-' || StrVal[0] == '+') &&
1080              (StrVal[1] >= '0' && StrVal[1] <= '9'))) {
1081           // Reparse stringized version!
1082           if (APFloat(APFloat::IEEEdouble, StrVal).convertToDouble() == Val) {
1083             Out << StrVal;
1084             return;
1085           }
1086         }
1087       }
1088       // Otherwise we could not reparse it to exactly the same value, so we must
1089       // output the string in hexadecimal format!  Note that loading and storing
1090       // floating point types changes the bits of NaNs on some hosts, notably
1091       // x86, so we must not use these types.
1092       static_assert(sizeof(double) == sizeof(uint64_t),
1093                     "assuming that double is 64 bits!");
1094       char Buffer[40];
1095       APFloat apf = CFP->getValueAPF();
1096       // Halves and floats are represented in ASCII IR as double, convert.
1097       if (!isDouble)
1098         apf.convert(APFloat::IEEEdouble, APFloat::rmNearestTiesToEven,
1099                           &ignored);
1100       Out << "0x" <<
1101               utohex_buffer(uint64_t(apf.bitcastToAPInt().getZExtValue()),
1102                             Buffer+40);
1103       return;
1104     }
1105
1106     // Either half, or some form of long double.
1107     // These appear as a magic letter identifying the type, then a
1108     // fixed number of hex digits.
1109     Out << "0x";
1110     // Bit position, in the current word, of the next nibble to print.
1111     int shiftcount;
1112
1113     if (&CFP->getValueAPF().getSemantics() == &APFloat::x87DoubleExtended) {
1114       Out << 'K';
1115       // api needed to prevent premature destruction
1116       APInt api = CFP->getValueAPF().bitcastToAPInt();
1117       const uint64_t* p = api.getRawData();
1118       uint64_t word = p[1];
1119       shiftcount = 12;
1120       int width = api.getBitWidth();
1121       for (int j=0; j<width; j+=4, shiftcount-=4) {
1122         unsigned int nibble = (word>>shiftcount) & 15;
1123         if (nibble < 10)
1124           Out << (unsigned char)(nibble + '0');
1125         else
1126           Out << (unsigned char)(nibble - 10 + 'A');
1127         if (shiftcount == 0 && j+4 < width) {
1128           word = *p;
1129           shiftcount = 64;
1130           if (width-j-4 < 64)
1131             shiftcount = width-j-4;
1132         }
1133       }
1134       return;
1135     } else if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEquad) {
1136       shiftcount = 60;
1137       Out << 'L';
1138     } else if (&CFP->getValueAPF().getSemantics() == &APFloat::PPCDoubleDouble) {
1139       shiftcount = 60;
1140       Out << 'M';
1141     } else if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEhalf) {
1142       shiftcount = 12;
1143       Out << 'H';
1144     } else
1145       llvm_unreachable("Unsupported floating point type");
1146     // api needed to prevent premature destruction
1147     APInt api = CFP->getValueAPF().bitcastToAPInt();
1148     const uint64_t* p = api.getRawData();
1149     uint64_t word = *p;
1150     int width = api.getBitWidth();
1151     for (int j=0; j<width; j+=4, shiftcount-=4) {
1152       unsigned int nibble = (word>>shiftcount) & 15;
1153       if (nibble < 10)
1154         Out << (unsigned char)(nibble + '0');
1155       else
1156         Out << (unsigned char)(nibble - 10 + 'A');
1157       if (shiftcount == 0 && j+4 < width) {
1158         word = *(++p);
1159         shiftcount = 64;
1160         if (width-j-4 < 64)
1161           shiftcount = width-j-4;
1162       }
1163     }
1164     return;
1165   }
1166
1167   if (isa<ConstantAggregateZero>(CV)) {
1168     Out << "zeroinitializer";
1169     return;
1170   }
1171
1172   if (const BlockAddress *BA = dyn_cast<BlockAddress>(CV)) {
1173     Out << "blockaddress(";
1174     WriteAsOperandInternal(Out, BA->getFunction(), &TypePrinter, Machine,
1175                            Context);
1176     Out << ", ";
1177     WriteAsOperandInternal(Out, BA->getBasicBlock(), &TypePrinter, Machine,
1178                            Context);
1179     Out << ")";
1180     return;
1181   }
1182
1183   if (const ConstantArray *CA = dyn_cast<ConstantArray>(CV)) {
1184     Type *ETy = CA->getType()->getElementType();
1185     Out << '[';
1186     TypePrinter.print(ETy, Out);
1187     Out << ' ';
1188     WriteAsOperandInternal(Out, CA->getOperand(0),
1189                            &TypePrinter, Machine,
1190                            Context);
1191     for (unsigned i = 1, e = CA->getNumOperands(); i != e; ++i) {
1192       Out << ", ";
1193       TypePrinter.print(ETy, Out);
1194       Out << ' ';
1195       WriteAsOperandInternal(Out, CA->getOperand(i), &TypePrinter, Machine,
1196                              Context);
1197     }
1198     Out << ']';
1199     return;
1200   }
1201
1202   if (const ConstantDataArray *CA = dyn_cast<ConstantDataArray>(CV)) {
1203     // As a special case, print the array as a string if it is an array of
1204     // i8 with ConstantInt values.
1205     if (CA->isString()) {
1206       Out << "c\"";
1207       PrintEscapedString(CA->getAsString(), Out);
1208       Out << '"';
1209       return;
1210     }
1211
1212     Type *ETy = CA->getType()->getElementType();
1213     Out << '[';
1214     TypePrinter.print(ETy, Out);
1215     Out << ' ';
1216     WriteAsOperandInternal(Out, CA->getElementAsConstant(0),
1217                            &TypePrinter, Machine,
1218                            Context);
1219     for (unsigned i = 1, e = CA->getNumElements(); i != e; ++i) {
1220       Out << ", ";
1221       TypePrinter.print(ETy, Out);
1222       Out << ' ';
1223       WriteAsOperandInternal(Out, CA->getElementAsConstant(i), &TypePrinter,
1224                              Machine, Context);
1225     }
1226     Out << ']';
1227     return;
1228   }
1229
1230
1231   if (const ConstantStruct *CS = dyn_cast<ConstantStruct>(CV)) {
1232     if (CS->getType()->isPacked())
1233       Out << '<';
1234     Out << '{';
1235     unsigned N = CS->getNumOperands();
1236     if (N) {
1237       Out << ' ';
1238       TypePrinter.print(CS->getOperand(0)->getType(), Out);
1239       Out << ' ';
1240
1241       WriteAsOperandInternal(Out, CS->getOperand(0), &TypePrinter, Machine,
1242                              Context);
1243
1244       for (unsigned i = 1; i < N; i++) {
1245         Out << ", ";
1246         TypePrinter.print(CS->getOperand(i)->getType(), Out);
1247         Out << ' ';
1248
1249         WriteAsOperandInternal(Out, CS->getOperand(i), &TypePrinter, Machine,
1250                                Context);
1251       }
1252       Out << ' ';
1253     }
1254
1255     Out << '}';
1256     if (CS->getType()->isPacked())
1257       Out << '>';
1258     return;
1259   }
1260
1261   if (isa<ConstantVector>(CV) || isa<ConstantDataVector>(CV)) {
1262     Type *ETy = CV->getType()->getVectorElementType();
1263     Out << '<';
1264     TypePrinter.print(ETy, Out);
1265     Out << ' ';
1266     WriteAsOperandInternal(Out, CV->getAggregateElement(0U), &TypePrinter,
1267                            Machine, Context);
1268     for (unsigned i = 1, e = CV->getType()->getVectorNumElements(); i != e;++i){
1269       Out << ", ";
1270       TypePrinter.print(ETy, Out);
1271       Out << ' ';
1272       WriteAsOperandInternal(Out, CV->getAggregateElement(i), &TypePrinter,
1273                              Machine, Context);
1274     }
1275     Out << '>';
1276     return;
1277   }
1278
1279   if (isa<ConstantPointerNull>(CV)) {
1280     Out << "null";
1281     return;
1282   }
1283
1284   if (isa<UndefValue>(CV)) {
1285     Out << "undef";
1286     return;
1287   }
1288
1289   if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV)) {
1290     Out << CE->getOpcodeName();
1291     WriteOptimizationInfo(Out, CE);
1292     if (CE->isCompare())
1293       Out << ' ' << getPredicateText(CE->getPredicate());
1294     Out << " (";
1295
1296     if (const GEPOperator *GEP = dyn_cast<GEPOperator>(CE)) {
1297       TypePrinter.print(
1298           cast<PointerType>(GEP->getPointerOperandType()->getScalarType())
1299               ->getElementType(),
1300           Out);
1301       Out << ", ";
1302     }
1303
1304     for (User::const_op_iterator OI=CE->op_begin(); OI != CE->op_end(); ++OI) {
1305       TypePrinter.print((*OI)->getType(), Out);
1306       Out << ' ';
1307       WriteAsOperandInternal(Out, *OI, &TypePrinter, Machine, Context);
1308       if (OI+1 != CE->op_end())
1309         Out << ", ";
1310     }
1311
1312     if (CE->hasIndices()) {
1313       ArrayRef<unsigned> Indices = CE->getIndices();
1314       for (unsigned i = 0, e = Indices.size(); i != e; ++i)
1315         Out << ", " << Indices[i];
1316     }
1317
1318     if (CE->isCast()) {
1319       Out << " to ";
1320       TypePrinter.print(CE->getType(), Out);
1321     }
1322
1323     Out << ')';
1324     return;
1325   }
1326
1327   Out << "<placeholder or erroneous Constant>";
1328 }
1329
1330 static void writeMDTuple(raw_ostream &Out, const MDTuple *Node,
1331                          TypePrinting *TypePrinter, SlotTracker *Machine,
1332                          const Module *Context) {
1333   Out << "!{";
1334   for (unsigned mi = 0, me = Node->getNumOperands(); mi != me; ++mi) {
1335     const Metadata *MD = Node->getOperand(mi);
1336     if (!MD)
1337       Out << "null";
1338     else if (auto *MDV = dyn_cast<ValueAsMetadata>(MD)) {
1339       Value *V = MDV->getValue();
1340       TypePrinter->print(V->getType(), Out);
1341       Out << ' ';
1342       WriteAsOperandInternal(Out, V, TypePrinter, Machine, Context);
1343     } else {
1344       WriteAsOperandInternal(Out, MD, TypePrinter, Machine, Context);
1345     }
1346     if (mi + 1 != me)
1347       Out << ", ";
1348   }
1349
1350   Out << "}";
1351 }
1352
1353 namespace {
1354 struct FieldSeparator {
1355   bool Skip;
1356   const char *Sep;
1357   FieldSeparator(const char *Sep = ", ") : Skip(true), Sep(Sep) {}
1358 };
1359 raw_ostream &operator<<(raw_ostream &OS, FieldSeparator &FS) {
1360   if (FS.Skip) {
1361     FS.Skip = false;
1362     return OS;
1363   }
1364   return OS << FS.Sep;
1365 }
1366 struct MDFieldPrinter {
1367   raw_ostream &Out;
1368   FieldSeparator FS;
1369   TypePrinting *TypePrinter;
1370   SlotTracker *Machine;
1371   const Module *Context;
1372
1373   explicit MDFieldPrinter(raw_ostream &Out)
1374       : Out(Out), TypePrinter(nullptr), Machine(nullptr), Context(nullptr) {}
1375   MDFieldPrinter(raw_ostream &Out, TypePrinting *TypePrinter,
1376                  SlotTracker *Machine, const Module *Context)
1377       : Out(Out), TypePrinter(TypePrinter), Machine(Machine), Context(Context) {
1378   }
1379   void printTag(const DINode *N);
1380   void printString(StringRef Name, StringRef Value,
1381                    bool ShouldSkipEmpty = true);
1382   void printMetadata(StringRef Name, const Metadata *MD,
1383                      bool ShouldSkipNull = true);
1384   template <class IntTy>
1385   void printInt(StringRef Name, IntTy Int, bool ShouldSkipZero = true);
1386   void printBool(StringRef Name, bool Value);
1387   void printDIFlags(StringRef Name, unsigned Flags);
1388   template <class IntTy, class Stringifier>
1389   void printDwarfEnum(StringRef Name, IntTy Value, Stringifier toString,
1390                       bool ShouldSkipZero = true);
1391 };
1392 } // end namespace
1393
1394 void MDFieldPrinter::printTag(const DINode *N) {
1395   Out << FS << "tag: ";
1396   if (const char *Tag = dwarf::TagString(N->getTag()))
1397     Out << Tag;
1398   else
1399     Out << N->getTag();
1400 }
1401
1402 void MDFieldPrinter::printString(StringRef Name, StringRef Value,
1403                                  bool ShouldSkipEmpty) {
1404   if (ShouldSkipEmpty && Value.empty())
1405     return;
1406
1407   Out << FS << Name << ": \"";
1408   PrintEscapedString(Value, Out);
1409   Out << "\"";
1410 }
1411
1412 static void writeMetadataAsOperand(raw_ostream &Out, const Metadata *MD,
1413                                    TypePrinting *TypePrinter,
1414                                    SlotTracker *Machine,
1415                                    const Module *Context) {
1416   if (!MD) {
1417     Out << "null";
1418     return;
1419   }
1420   WriteAsOperandInternal(Out, MD, TypePrinter, Machine, Context);
1421 }
1422
1423 void MDFieldPrinter::printMetadata(StringRef Name, const Metadata *MD,
1424                                    bool ShouldSkipNull) {
1425   if (ShouldSkipNull && !MD)
1426     return;
1427
1428   Out << FS << Name << ": ";
1429   writeMetadataAsOperand(Out, MD, TypePrinter, Machine, Context);
1430 }
1431
1432 template <class IntTy>
1433 void MDFieldPrinter::printInt(StringRef Name, IntTy Int, bool ShouldSkipZero) {
1434   if (ShouldSkipZero && !Int)
1435     return;
1436
1437   Out << FS << Name << ": " << Int;
1438 }
1439
1440 void MDFieldPrinter::printBool(StringRef Name, bool Value) {
1441   Out << FS << Name << ": " << (Value ? "true" : "false");
1442 }
1443
1444 void MDFieldPrinter::printDIFlags(StringRef Name, unsigned Flags) {
1445   if (!Flags)
1446     return;
1447
1448   Out << FS << Name << ": ";
1449
1450   SmallVector<unsigned, 8> SplitFlags;
1451   unsigned Extra = DINode::splitFlags(Flags, SplitFlags);
1452
1453   FieldSeparator FlagsFS(" | ");
1454   for (unsigned F : SplitFlags) {
1455     const char *StringF = DINode::getFlagString(F);
1456     assert(StringF && "Expected valid flag");
1457     Out << FlagsFS << StringF;
1458   }
1459   if (Extra || SplitFlags.empty())
1460     Out << FlagsFS << Extra;
1461 }
1462
1463 template <class IntTy, class Stringifier>
1464 void MDFieldPrinter::printDwarfEnum(StringRef Name, IntTy Value,
1465                                     Stringifier toString, bool ShouldSkipZero) {
1466   if (!Value)
1467     return;
1468
1469   Out << FS << Name << ": ";
1470   if (const char *S = toString(Value))
1471     Out << S;
1472   else
1473     Out << Value;
1474 }
1475
1476 static void writeGenericDINode(raw_ostream &Out, const GenericDINode *N,
1477                                TypePrinting *TypePrinter, SlotTracker *Machine,
1478                                const Module *Context) {
1479   Out << "!GenericDINode(";
1480   MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1481   Printer.printTag(N);
1482   Printer.printString("header", N->getHeader());
1483   if (N->getNumDwarfOperands()) {
1484     Out << Printer.FS << "operands: {";
1485     FieldSeparator IFS;
1486     for (auto &I : N->dwarf_operands()) {
1487       Out << IFS;
1488       writeMetadataAsOperand(Out, I, TypePrinter, Machine, Context);
1489     }
1490     Out << "}";
1491   }
1492   Out << ")";
1493 }
1494
1495 static void writeDILocation(raw_ostream &Out, const DILocation *DL,
1496                             TypePrinting *TypePrinter, SlotTracker *Machine,
1497                             const Module *Context) {
1498   Out << "!DILocation(";
1499   MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1500   // Always output the line, since 0 is a relevant and important value for it.
1501   Printer.printInt("line", DL->getLine(), /* ShouldSkipZero */ false);
1502   Printer.printInt("column", DL->getColumn());
1503   Printer.printMetadata("scope", DL->getRawScope(), /* ShouldSkipNull */ false);
1504   Printer.printMetadata("inlinedAt", DL->getRawInlinedAt());
1505   Out << ")";
1506 }
1507
1508 static void writeDISubrange(raw_ostream &Out, const DISubrange *N,
1509                             TypePrinting *, SlotTracker *, const Module *) {
1510   Out << "!DISubrange(";
1511   MDFieldPrinter Printer(Out);
1512   Printer.printInt("count", N->getCount(), /* ShouldSkipZero */ false);
1513   Printer.printInt("lowerBound", N->getLowerBound());
1514   Out << ")";
1515 }
1516
1517 static void writeDIEnumerator(raw_ostream &Out, const DIEnumerator *N,
1518                               TypePrinting *, SlotTracker *, const Module *) {
1519   Out << "!DIEnumerator(";
1520   MDFieldPrinter Printer(Out);
1521   Printer.printString("name", N->getName(), /* ShouldSkipEmpty */ false);
1522   Printer.printInt("value", N->getValue(), /* ShouldSkipZero */ false);
1523   Out << ")";
1524 }
1525
1526 static void writeDIBasicType(raw_ostream &Out, const DIBasicType *N,
1527                              TypePrinting *, SlotTracker *, const Module *) {
1528   Out << "!DIBasicType(";
1529   MDFieldPrinter Printer(Out);
1530   if (N->getTag() != dwarf::DW_TAG_base_type)
1531     Printer.printTag(N);
1532   Printer.printString("name", N->getName());
1533   Printer.printInt("size", N->getSizeInBits());
1534   Printer.printInt("align", N->getAlignInBits());
1535   Printer.printDwarfEnum("encoding", N->getEncoding(),
1536                          dwarf::AttributeEncodingString);
1537   Out << ")";
1538 }
1539
1540 static void writeDIDerivedType(raw_ostream &Out, const DIDerivedType *N,
1541                                TypePrinting *TypePrinter, SlotTracker *Machine,
1542                                const Module *Context) {
1543   Out << "!DIDerivedType(";
1544   MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1545   Printer.printTag(N);
1546   Printer.printString("name", N->getName());
1547   Printer.printMetadata("scope", N->getRawScope());
1548   Printer.printMetadata("file", N->getRawFile());
1549   Printer.printInt("line", N->getLine());
1550   Printer.printMetadata("baseType", N->getRawBaseType(),
1551                         /* ShouldSkipNull */ false);
1552   Printer.printInt("size", N->getSizeInBits());
1553   Printer.printInt("align", N->getAlignInBits());
1554   Printer.printInt("offset", N->getOffsetInBits());
1555   Printer.printDIFlags("flags", N->getFlags());
1556   Printer.printMetadata("extraData", N->getRawExtraData());
1557   Out << ")";
1558 }
1559
1560 static void writeDICompositeType(raw_ostream &Out, const DICompositeType *N,
1561                                  TypePrinting *TypePrinter,
1562                                  SlotTracker *Machine, const Module *Context) {
1563   Out << "!DICompositeType(";
1564   MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1565   Printer.printTag(N);
1566   Printer.printString("name", N->getName());
1567   Printer.printMetadata("scope", N->getRawScope());
1568   Printer.printMetadata("file", N->getRawFile());
1569   Printer.printInt("line", N->getLine());
1570   Printer.printMetadata("baseType", N->getRawBaseType());
1571   Printer.printInt("size", N->getSizeInBits());
1572   Printer.printInt("align", N->getAlignInBits());
1573   Printer.printInt("offset", N->getOffsetInBits());
1574   Printer.printDIFlags("flags", N->getFlags());
1575   Printer.printMetadata("elements", N->getRawElements());
1576   Printer.printDwarfEnum("runtimeLang", N->getRuntimeLang(),
1577                          dwarf::LanguageString);
1578   Printer.printMetadata("vtableHolder", N->getRawVTableHolder());
1579   Printer.printMetadata("templateParams", N->getRawTemplateParams());
1580   Printer.printString("identifier", N->getIdentifier());
1581   Out << ")";
1582 }
1583
1584 static void writeDISubroutineType(raw_ostream &Out, const DISubroutineType *N,
1585                                   TypePrinting *TypePrinter,
1586                                   SlotTracker *Machine, const Module *Context) {
1587   Out << "!DISubroutineType(";
1588   MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1589   Printer.printDIFlags("flags", N->getFlags());
1590   Printer.printMetadata("types", N->getRawTypeArray(),
1591                         /* ShouldSkipNull */ false);
1592   Out << ")";
1593 }
1594
1595 static void writeDIFile(raw_ostream &Out, const DIFile *N, TypePrinting *,
1596                         SlotTracker *, const Module *) {
1597   Out << "!DIFile(";
1598   MDFieldPrinter Printer(Out);
1599   Printer.printString("filename", N->getFilename(),
1600                       /* ShouldSkipEmpty */ false);
1601   Printer.printString("directory", N->getDirectory(),
1602                       /* ShouldSkipEmpty */ false);
1603   Out << ")";
1604 }
1605
1606 static void writeDICompileUnit(raw_ostream &Out, const DICompileUnit *N,
1607                                TypePrinting *TypePrinter, SlotTracker *Machine,
1608                                const Module *Context) {
1609   Out << "!DICompileUnit(";
1610   MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1611   Printer.printDwarfEnum("language", N->getSourceLanguage(),
1612                          dwarf::LanguageString, /* ShouldSkipZero */ false);
1613   Printer.printMetadata("file", N->getRawFile(), /* ShouldSkipNull */ false);
1614   Printer.printString("producer", N->getProducer());
1615   Printer.printBool("isOptimized", N->isOptimized());
1616   Printer.printString("flags", N->getFlags());
1617   Printer.printInt("runtimeVersion", N->getRuntimeVersion(),
1618                    /* ShouldSkipZero */ false);
1619   Printer.printString("splitDebugFilename", N->getSplitDebugFilename());
1620   Printer.printInt("emissionKind", N->getEmissionKind(),
1621                    /* ShouldSkipZero */ false);
1622   Printer.printMetadata("enums", N->getRawEnumTypes());
1623   Printer.printMetadata("retainedTypes", N->getRawRetainedTypes());
1624   Printer.printMetadata("subprograms", N->getRawSubprograms());
1625   Printer.printMetadata("globals", N->getRawGlobalVariables());
1626   Printer.printMetadata("imports", N->getRawImportedEntities());
1627   Printer.printInt("dwoId", N->getDWOId());
1628   Out << ")";
1629 }
1630
1631 static void writeDISubprogram(raw_ostream &Out, const DISubprogram *N,
1632                               TypePrinting *TypePrinter, SlotTracker *Machine,
1633                               const Module *Context) {
1634   Out << "!DISubprogram(";
1635   MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1636   Printer.printString("name", N->getName());
1637   Printer.printString("linkageName", N->getLinkageName());
1638   Printer.printMetadata("scope", N->getRawScope(), /* ShouldSkipNull */ false);
1639   Printer.printMetadata("file", N->getRawFile());
1640   Printer.printInt("line", N->getLine());
1641   Printer.printMetadata("type", N->getRawType());
1642   Printer.printBool("isLocal", N->isLocalToUnit());
1643   Printer.printBool("isDefinition", N->isDefinition());
1644   Printer.printInt("scopeLine", N->getScopeLine());
1645   Printer.printMetadata("containingType", N->getRawContainingType());
1646   Printer.printDwarfEnum("virtuality", N->getVirtuality(),
1647                          dwarf::VirtualityString);
1648   Printer.printInt("virtualIndex", N->getVirtualIndex());
1649   Printer.printDIFlags("flags", N->getFlags());
1650   Printer.printBool("isOptimized", N->isOptimized());
1651   Printer.printMetadata("function", N->getRawFunction());
1652   Printer.printMetadata("templateParams", N->getRawTemplateParams());
1653   Printer.printMetadata("declaration", N->getRawDeclaration());
1654   Printer.printMetadata("variables", N->getRawVariables());
1655   Out << ")";
1656 }
1657
1658 static void writeDILexicalBlock(raw_ostream &Out, const DILexicalBlock *N,
1659                                 TypePrinting *TypePrinter, SlotTracker *Machine,
1660                                 const Module *Context) {
1661   Out << "!DILexicalBlock(";
1662   MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1663   Printer.printMetadata("scope", N->getRawScope(), /* ShouldSkipNull */ false);
1664   Printer.printMetadata("file", N->getRawFile());
1665   Printer.printInt("line", N->getLine());
1666   Printer.printInt("column", N->getColumn());
1667   Out << ")";
1668 }
1669
1670 static void writeDILexicalBlockFile(raw_ostream &Out,
1671                                     const DILexicalBlockFile *N,
1672                                     TypePrinting *TypePrinter,
1673                                     SlotTracker *Machine,
1674                                     const Module *Context) {
1675   Out << "!DILexicalBlockFile(";
1676   MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1677   Printer.printMetadata("scope", N->getRawScope(), /* ShouldSkipNull */ false);
1678   Printer.printMetadata("file", N->getRawFile());
1679   Printer.printInt("discriminator", N->getDiscriminator(),
1680                    /* ShouldSkipZero */ false);
1681   Out << ")";
1682 }
1683
1684 static void writeDINamespace(raw_ostream &Out, const DINamespace *N,
1685                              TypePrinting *TypePrinter, SlotTracker *Machine,
1686                              const Module *Context) {
1687   Out << "!DINamespace(";
1688   MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1689   Printer.printString("name", N->getName());
1690   Printer.printMetadata("scope", N->getRawScope(), /* ShouldSkipNull */ false);
1691   Printer.printMetadata("file", N->getRawFile());
1692   Printer.printInt("line", N->getLine());
1693   Out << ")";
1694 }
1695
1696 static void writeDITemplateTypeParameter(raw_ostream &Out,
1697                                          const DITemplateTypeParameter *N,
1698                                          TypePrinting *TypePrinter,
1699                                          SlotTracker *Machine,
1700                                          const Module *Context) {
1701   Out << "!DITemplateTypeParameter(";
1702   MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1703   Printer.printString("name", N->getName());
1704   Printer.printMetadata("type", N->getRawType(), /* ShouldSkipNull */ false);
1705   Out << ")";
1706 }
1707
1708 static void writeDITemplateValueParameter(raw_ostream &Out,
1709                                           const DITemplateValueParameter *N,
1710                                           TypePrinting *TypePrinter,
1711                                           SlotTracker *Machine,
1712                                           const Module *Context) {
1713   Out << "!DITemplateValueParameter(";
1714   MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1715   if (N->getTag() != dwarf::DW_TAG_template_value_parameter)
1716     Printer.printTag(N);
1717   Printer.printString("name", N->getName());
1718   Printer.printMetadata("type", N->getRawType());
1719   Printer.printMetadata("value", N->getValue(), /* ShouldSkipNull */ false);
1720   Out << ")";
1721 }
1722
1723 static void writeDIGlobalVariable(raw_ostream &Out, const DIGlobalVariable *N,
1724                                   TypePrinting *TypePrinter,
1725                                   SlotTracker *Machine, const Module *Context) {
1726   Out << "!DIGlobalVariable(";
1727   MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1728   Printer.printString("name", N->getName());
1729   Printer.printString("linkageName", N->getLinkageName());
1730   Printer.printMetadata("scope", N->getRawScope(), /* ShouldSkipNull */ false);
1731   Printer.printMetadata("file", N->getRawFile());
1732   Printer.printInt("line", N->getLine());
1733   Printer.printMetadata("type", N->getRawType());
1734   Printer.printBool("isLocal", N->isLocalToUnit());
1735   Printer.printBool("isDefinition", N->isDefinition());
1736   Printer.printMetadata("variable", N->getRawVariable());
1737   Printer.printMetadata("declaration", N->getRawStaticDataMemberDeclaration());
1738   Out << ")";
1739 }
1740
1741 static void writeDILocalVariable(raw_ostream &Out, const DILocalVariable *N,
1742                                  TypePrinting *TypePrinter,
1743                                  SlotTracker *Machine, const Module *Context) {
1744   Out << "!DILocalVariable(";
1745   MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1746   Printer.printTag(N);
1747   Printer.printString("name", N->getName());
1748   Printer.printInt("arg", N->getArg(),
1749                    /* ShouldSkipZero */
1750                    N->getTag() == dwarf::DW_TAG_auto_variable);
1751   Printer.printMetadata("scope", N->getRawScope(), /* ShouldSkipNull */ false);
1752   Printer.printMetadata("file", N->getRawFile());
1753   Printer.printInt("line", N->getLine());
1754   Printer.printMetadata("type", N->getRawType());
1755   Printer.printDIFlags("flags", N->getFlags());
1756   Out << ")";
1757 }
1758
1759 static void writeDIExpression(raw_ostream &Out, const DIExpression *N,
1760                               TypePrinting *TypePrinter, SlotTracker *Machine,
1761                               const Module *Context) {
1762   Out << "!DIExpression(";
1763   FieldSeparator FS;
1764   if (N->isValid()) {
1765     for (auto I = N->expr_op_begin(), E = N->expr_op_end(); I != E; ++I) {
1766       const char *OpStr = dwarf::OperationEncodingString(I->getOp());
1767       assert(OpStr && "Expected valid opcode");
1768
1769       Out << FS << OpStr;
1770       for (unsigned A = 0, AE = I->getNumArgs(); A != AE; ++A)
1771         Out << FS << I->getArg(A);
1772     }
1773   } else {
1774     for (const auto &I : N->getElements())
1775       Out << FS << I;
1776   }
1777   Out << ")";
1778 }
1779
1780 static void writeDIObjCProperty(raw_ostream &Out, const DIObjCProperty *N,
1781                                 TypePrinting *TypePrinter, SlotTracker *Machine,
1782                                 const Module *Context) {
1783   Out << "!DIObjCProperty(";
1784   MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1785   Printer.printString("name", N->getName());
1786   Printer.printMetadata("file", N->getRawFile());
1787   Printer.printInt("line", N->getLine());
1788   Printer.printString("setter", N->getSetterName());
1789   Printer.printString("getter", N->getGetterName());
1790   Printer.printInt("attributes", N->getAttributes());
1791   Printer.printMetadata("type", N->getRawType());
1792   Out << ")";
1793 }
1794
1795 static void writeDIImportedEntity(raw_ostream &Out, const DIImportedEntity *N,
1796                                   TypePrinting *TypePrinter,
1797                                   SlotTracker *Machine, const Module *Context) {
1798   Out << "!DIImportedEntity(";
1799   MDFieldPrinter Printer(Out, TypePrinter, Machine, Context);
1800   Printer.printTag(N);
1801   Printer.printString("name", N->getName());
1802   Printer.printMetadata("scope", N->getRawScope(), /* ShouldSkipNull */ false);
1803   Printer.printMetadata("entity", N->getRawEntity());
1804   Printer.printInt("line", N->getLine());
1805   Out << ")";
1806 }
1807
1808
1809 static void WriteMDNodeBodyInternal(raw_ostream &Out, const MDNode *Node,
1810                                     TypePrinting *TypePrinter,
1811                                     SlotTracker *Machine,
1812                                     const Module *Context) {
1813   if (Node->isDistinct())
1814     Out << "distinct ";
1815   else if (Node->isTemporary())
1816     Out << "<temporary!> "; // Handle broken code.
1817
1818   switch (Node->getMetadataID()) {
1819   default:
1820     llvm_unreachable("Expected uniquable MDNode");
1821 #define HANDLE_MDNODE_LEAF(CLASS)                                              \
1822   case Metadata::CLASS##Kind:                                                  \
1823     write##CLASS(Out, cast<CLASS>(Node), TypePrinter, Machine, Context);       \
1824     break;
1825 #include "llvm/IR/Metadata.def"
1826   }
1827 }
1828
1829 // Full implementation of printing a Value as an operand with support for
1830 // TypePrinting, etc.
1831 static void WriteAsOperandInternal(raw_ostream &Out, const Value *V,
1832                                    TypePrinting *TypePrinter,
1833                                    SlotTracker *Machine,
1834                                    const Module *Context) {
1835   if (V->hasName()) {
1836     PrintLLVMName(Out, V);
1837     return;
1838   }
1839
1840   const Constant *CV = dyn_cast<Constant>(V);
1841   if (CV && !isa<GlobalValue>(CV)) {
1842     assert(TypePrinter && "Constants require TypePrinting!");
1843     WriteConstantInternal(Out, CV, *TypePrinter, Machine, Context);
1844     return;
1845   }
1846
1847   if (const InlineAsm *IA = dyn_cast<InlineAsm>(V)) {
1848     Out << "asm ";
1849     if (IA->hasSideEffects())
1850       Out << "sideeffect ";
1851     if (IA->isAlignStack())
1852       Out << "alignstack ";
1853     // We don't emit the AD_ATT dialect as it's the assumed default.
1854     if (IA->getDialect() == InlineAsm::AD_Intel)
1855       Out << "inteldialect ";
1856     Out << '"';
1857     PrintEscapedString(IA->getAsmString(), Out);
1858     Out << "\", \"";
1859     PrintEscapedString(IA->getConstraintString(), Out);
1860     Out << '"';
1861     return;
1862   }
1863
1864   if (auto *MD = dyn_cast<MetadataAsValue>(V)) {
1865     WriteAsOperandInternal(Out, MD->getMetadata(), TypePrinter, Machine,
1866                            Context, /* FromValue */ true);
1867     return;
1868   }
1869
1870   char Prefix = '%';
1871   int Slot;
1872   // If we have a SlotTracker, use it.
1873   if (Machine) {
1874     if (const GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
1875       Slot = Machine->getGlobalSlot(GV);
1876       Prefix = '@';
1877     } else {
1878       Slot = Machine->getLocalSlot(V);
1879
1880       // If the local value didn't succeed, then we may be referring to a value
1881       // from a different function.  Translate it, as this can happen when using
1882       // address of blocks.
1883       if (Slot == -1)
1884         if ((Machine = createSlotTracker(V))) {
1885           Slot = Machine->getLocalSlot(V);
1886           delete Machine;
1887         }
1888     }
1889   } else if ((Machine = createSlotTracker(V))) {
1890     // Otherwise, create one to get the # and then destroy it.
1891     if (const GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
1892       Slot = Machine->getGlobalSlot(GV);
1893       Prefix = '@';
1894     } else {
1895       Slot = Machine->getLocalSlot(V);
1896     }
1897     delete Machine;
1898     Machine = nullptr;
1899   } else {
1900     Slot = -1;
1901   }
1902
1903   if (Slot != -1)
1904     Out << Prefix << Slot;
1905   else
1906     Out << "<badref>";
1907 }
1908
1909 static void WriteAsOperandInternal(raw_ostream &Out, const Metadata *MD,
1910                                    TypePrinting *TypePrinter,
1911                                    SlotTracker *Machine, const Module *Context,
1912                                    bool FromValue) {
1913   if (const MDNode *N = dyn_cast<MDNode>(MD)) {
1914     if (!Machine)
1915       Machine = new SlotTracker(Context);
1916     int Slot = Machine->getMetadataSlot(N);
1917     if (Slot == -1)
1918       // Give the pointer value instead of "badref", since this comes up all
1919       // the time when debugging.
1920       Out << "<" << N << ">";
1921     else
1922       Out << '!' << Slot;
1923     return;
1924   }
1925
1926   if (const MDString *MDS = dyn_cast<MDString>(MD)) {
1927     Out << "!\"";
1928     PrintEscapedString(MDS->getString(), Out);
1929     Out << '"';
1930     return;
1931   }
1932
1933   auto *V = cast<ValueAsMetadata>(MD);
1934   assert(TypePrinter && "TypePrinter required for metadata values");
1935   assert((FromValue || !isa<LocalAsMetadata>(V)) &&
1936          "Unexpected function-local metadata outside of value argument");
1937
1938   TypePrinter->print(V->getValue()->getType(), Out);
1939   Out << ' ';
1940   WriteAsOperandInternal(Out, V->getValue(), TypePrinter, Machine, Context);
1941 }
1942
1943 namespace {
1944 class AssemblyWriter {
1945   formatted_raw_ostream &Out;
1946   const Module *TheModule;
1947   std::unique_ptr<SlotTracker> ModuleSlotTracker;
1948   SlotTracker &Machine;
1949   TypePrinting TypePrinter;
1950   AssemblyAnnotationWriter *AnnotationWriter;
1951   SetVector<const Comdat *> Comdats;
1952   bool ShouldPreserveUseListOrder;
1953   UseListOrderStack UseListOrders;
1954   SmallVector<StringRef, 8> MDNames;
1955
1956 public:
1957   /// Construct an AssemblyWriter with an external SlotTracker
1958   AssemblyWriter(formatted_raw_ostream &o, SlotTracker &Mac, const Module *M,
1959                  AssemblyAnnotationWriter *AAW,
1960                  bool ShouldPreserveUseListOrder = false);
1961
1962   /// Construct an AssemblyWriter with an internally allocated SlotTracker
1963   AssemblyWriter(formatted_raw_ostream &o, const Module *M,
1964                  AssemblyAnnotationWriter *AAW,
1965                  bool ShouldPreserveUseListOrder = false);
1966
1967   void printMDNodeBody(const MDNode *MD);
1968   void printNamedMDNode(const NamedMDNode *NMD);
1969
1970   void printModule(const Module *M);
1971
1972   void writeOperand(const Value *Op, bool PrintType);
1973   void writeParamOperand(const Value *Operand, AttributeSet Attrs,unsigned Idx);
1974   void writeAtomic(AtomicOrdering Ordering, SynchronizationScope SynchScope);
1975   void writeAtomicCmpXchg(AtomicOrdering SuccessOrdering,
1976                           AtomicOrdering FailureOrdering,
1977                           SynchronizationScope SynchScope);
1978
1979   void writeAllMDNodes();
1980   void writeMDNode(unsigned Slot, const MDNode *Node);
1981   void writeAllAttributeGroups();
1982
1983   void printTypeIdentities();
1984   void printGlobal(const GlobalVariable *GV);
1985   void printAlias(const GlobalAlias *GV);
1986   void printComdat(const Comdat *C);
1987   void printFunction(const Function *F);
1988   void printArgument(const Argument *FA, AttributeSet Attrs, unsigned Idx);
1989   void printBasicBlock(const BasicBlock *BB);
1990   void printInstructionLine(const Instruction &I);
1991   void printInstruction(const Instruction &I);
1992
1993   void printUseListOrder(const UseListOrder &Order);
1994   void printUseLists(const Function *F);
1995
1996 private:
1997   void init();
1998
1999   /// \brief Print out metadata attachments.
2000   void printMetadataAttachments(
2001       const SmallVectorImpl<std::pair<unsigned, MDNode *>> &MDs,
2002       StringRef Separator);
2003
2004   // printInfoComment - Print a little comment after the instruction indicating
2005   // which slot it occupies.
2006   void printInfoComment(const Value &V);
2007
2008   // printGCRelocateComment - print comment after call to the gc.relocate
2009   // intrinsic indicating base and derived pointer names.
2010   void printGCRelocateComment(const Value &V);
2011 };
2012 } // namespace
2013
2014 void AssemblyWriter::init() {
2015   if (!TheModule)
2016     return;
2017   TypePrinter.incorporateTypes(*TheModule);
2018   for (const Function &F : *TheModule)
2019     if (const Comdat *C = F.getComdat())
2020       Comdats.insert(C);
2021   for (const GlobalVariable &GV : TheModule->globals())
2022     if (const Comdat *C = GV.getComdat())
2023       Comdats.insert(C);
2024 }
2025
2026 AssemblyWriter::AssemblyWriter(formatted_raw_ostream &o, SlotTracker &Mac,
2027                                const Module *M, AssemblyAnnotationWriter *AAW,
2028                                bool ShouldPreserveUseListOrder)
2029     : Out(o), TheModule(M), Machine(Mac), AnnotationWriter(AAW),
2030       ShouldPreserveUseListOrder(ShouldPreserveUseListOrder) {
2031   init();
2032 }
2033
2034 AssemblyWriter::AssemblyWriter(formatted_raw_ostream &o, const Module *M,
2035                                AssemblyAnnotationWriter *AAW,
2036                                bool ShouldPreserveUseListOrder)
2037     : Out(o), TheModule(M), ModuleSlotTracker(createSlotTracker(M)),
2038       Machine(*ModuleSlotTracker), AnnotationWriter(AAW),
2039       ShouldPreserveUseListOrder(ShouldPreserveUseListOrder) {
2040   init();
2041 }
2042
2043 void AssemblyWriter::writeOperand(const Value *Operand, bool PrintType) {
2044   if (!Operand) {
2045     Out << "<null operand!>";
2046     return;
2047   }
2048   if (PrintType) {
2049     TypePrinter.print(Operand->getType(), Out);
2050     Out << ' ';
2051   }
2052   WriteAsOperandInternal(Out, Operand, &TypePrinter, &Machine, TheModule);
2053 }
2054
2055 void AssemblyWriter::writeAtomic(AtomicOrdering Ordering,
2056                                  SynchronizationScope SynchScope) {
2057   if (Ordering == NotAtomic)
2058     return;
2059
2060   switch (SynchScope) {
2061   case SingleThread: Out << " singlethread"; break;
2062   case CrossThread: break;
2063   }
2064
2065   switch (Ordering) {
2066   default: Out << " <bad ordering " << int(Ordering) << ">"; break;
2067   case Unordered: Out << " unordered"; break;
2068   case Monotonic: Out << " monotonic"; break;
2069   case Acquire: Out << " acquire"; break;
2070   case Release: Out << " release"; break;
2071   case AcquireRelease: Out << " acq_rel"; break;
2072   case SequentiallyConsistent: Out << " seq_cst"; break;
2073   }
2074 }
2075
2076 void AssemblyWriter::writeAtomicCmpXchg(AtomicOrdering SuccessOrdering,
2077                                         AtomicOrdering FailureOrdering,
2078                                         SynchronizationScope SynchScope) {
2079   assert(SuccessOrdering != NotAtomic && FailureOrdering != NotAtomic);
2080
2081   switch (SynchScope) {
2082   case SingleThread: Out << " singlethread"; break;
2083   case CrossThread: break;
2084   }
2085
2086   switch (SuccessOrdering) {
2087   default: Out << " <bad ordering " << int(SuccessOrdering) << ">"; break;
2088   case Unordered: Out << " unordered"; break;
2089   case Monotonic: Out << " monotonic"; break;
2090   case Acquire: Out << " acquire"; break;
2091   case Release: Out << " release"; break;
2092   case AcquireRelease: Out << " acq_rel"; break;
2093   case SequentiallyConsistent: Out << " seq_cst"; break;
2094   }
2095
2096   switch (FailureOrdering) {
2097   default: Out << " <bad ordering " << int(FailureOrdering) << ">"; break;
2098   case Unordered: Out << " unordered"; break;
2099   case Monotonic: Out << " monotonic"; break;
2100   case Acquire: Out << " acquire"; break;
2101   case Release: Out << " release"; break;
2102   case AcquireRelease: Out << " acq_rel"; break;
2103   case SequentiallyConsistent: Out << " seq_cst"; break;
2104   }
2105 }
2106
2107 void AssemblyWriter::writeParamOperand(const Value *Operand,
2108                                        AttributeSet Attrs, unsigned Idx) {
2109   if (!Operand) {
2110     Out << "<null operand!>";
2111     return;
2112   }
2113
2114   // Print the type
2115   TypePrinter.print(Operand->getType(), Out);
2116   // Print parameter attributes list
2117   if (Attrs.hasAttributes(Idx))
2118     Out << ' ' << Attrs.getAsString(Idx);
2119   Out << ' ';
2120   // Print the operand
2121   WriteAsOperandInternal(Out, Operand, &TypePrinter, &Machine, TheModule);
2122 }
2123
2124 void AssemblyWriter::printModule(const Module *M) {
2125   Machine.initialize();
2126
2127   if (ShouldPreserveUseListOrder)
2128     UseListOrders = predictUseListOrder(M);
2129
2130   if (!M->getModuleIdentifier().empty() &&
2131       // Don't print the ID if it will start a new line (which would
2132       // require a comment char before it).
2133       M->getModuleIdentifier().find('\n') == std::string::npos)
2134     Out << "; ModuleID = '" << M->getModuleIdentifier() << "'\n";
2135
2136   const std::string &DL = M->getDataLayoutStr();
2137   if (!DL.empty())
2138     Out << "target datalayout = \"" << DL << "\"\n";
2139   if (!M->getTargetTriple().empty())
2140     Out << "target triple = \"" << M->getTargetTriple() << "\"\n";
2141
2142   if (!M->getModuleInlineAsm().empty()) {
2143     Out << '\n';
2144
2145     // Split the string into lines, to make it easier to read the .ll file.
2146     StringRef Asm = M->getModuleInlineAsm();
2147     do {
2148       StringRef Front;
2149       std::tie(Front, Asm) = Asm.split('\n');
2150
2151       // We found a newline, print the portion of the asm string from the
2152       // last newline up to this newline.
2153       Out << "module asm \"";
2154       PrintEscapedString(Front, Out);
2155       Out << "\"\n";
2156     } while (!Asm.empty());
2157   }
2158
2159   printTypeIdentities();
2160
2161   // Output all comdats.
2162   if (!Comdats.empty())
2163     Out << '\n';
2164   for (const Comdat *C : Comdats) {
2165     printComdat(C);
2166     if (C != Comdats.back())
2167       Out << '\n';
2168   }
2169
2170   // Output all globals.
2171   if (!M->global_empty()) Out << '\n';
2172   for (Module::const_global_iterator I = M->global_begin(), E = M->global_end();
2173        I != E; ++I) {
2174     printGlobal(I); Out << '\n';
2175   }
2176
2177   // Output all aliases.
2178   if (!M->alias_empty()) Out << "\n";
2179   for (Module::const_alias_iterator I = M->alias_begin(), E = M->alias_end();
2180        I != E; ++I)
2181     printAlias(I);
2182
2183   // Output global use-lists.
2184   printUseLists(nullptr);
2185
2186   // Output all of the functions.
2187   for (Module::const_iterator I = M->begin(), E = M->end(); I != E; ++I)
2188     printFunction(I);
2189   assert(UseListOrders.empty() && "All use-lists should have been consumed");
2190
2191   // Output all attribute groups.
2192   if (!Machine.as_empty()) {
2193     Out << '\n';
2194     writeAllAttributeGroups();
2195   }
2196
2197   // Output named metadata.
2198   if (!M->named_metadata_empty()) Out << '\n';
2199
2200   for (Module::const_named_metadata_iterator I = M->named_metadata_begin(),
2201        E = M->named_metadata_end(); I != E; ++I)
2202     printNamedMDNode(I);
2203
2204   // Output metadata.
2205   if (!Machine.mdn_empty()) {
2206     Out << '\n';
2207     writeAllMDNodes();
2208   }
2209 }
2210
2211 static void printMetadataIdentifier(StringRef Name,
2212                                     formatted_raw_ostream &Out) {
2213   if (Name.empty()) {
2214     Out << "<empty name> ";
2215   } else {
2216     if (isalpha(static_cast<unsigned char>(Name[0])) || Name[0] == '-' ||
2217         Name[0] == '$' || Name[0] == '.' || Name[0] == '_')
2218       Out << Name[0];
2219     else
2220       Out << '\\' << hexdigit(Name[0] >> 4) << hexdigit(Name[0] & 0x0F);
2221     for (unsigned i = 1, e = Name.size(); i != e; ++i) {
2222       unsigned char C = Name[i];
2223       if (isalnum(static_cast<unsigned char>(C)) || C == '-' || C == '$' ||
2224           C == '.' || C == '_')
2225         Out << C;
2226       else
2227         Out << '\\' << hexdigit(C >> 4) << hexdigit(C & 0x0F);
2228     }
2229   }
2230 }
2231
2232 void AssemblyWriter::printNamedMDNode(const NamedMDNode *NMD) {
2233   Out << '!';
2234   printMetadataIdentifier(NMD->getName(), Out);
2235   Out << " = !{";
2236   for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
2237     if (i)
2238       Out << ", ";
2239     int Slot = Machine.getMetadataSlot(NMD->getOperand(i));
2240     if (Slot == -1)
2241       Out << "<badref>";
2242     else
2243       Out << '!' << Slot;
2244   }
2245   Out << "}\n";
2246 }
2247
2248 static void PrintLinkage(GlobalValue::LinkageTypes LT,
2249                          formatted_raw_ostream &Out) {
2250   switch (LT) {
2251   case GlobalValue::ExternalLinkage: break;
2252   case GlobalValue::PrivateLinkage:       Out << "private ";        break;
2253   case GlobalValue::InternalLinkage:      Out << "internal ";       break;
2254   case GlobalValue::LinkOnceAnyLinkage:   Out << "linkonce ";       break;
2255   case GlobalValue::LinkOnceODRLinkage:   Out << "linkonce_odr ";   break;
2256   case GlobalValue::WeakAnyLinkage:       Out << "weak ";           break;
2257   case GlobalValue::WeakODRLinkage:       Out << "weak_odr ";       break;
2258   case GlobalValue::CommonLinkage:        Out << "common ";         break;
2259   case GlobalValue::AppendingLinkage:     Out << "appending ";      break;
2260   case GlobalValue::ExternalWeakLinkage:  Out << "extern_weak ";    break;
2261   case GlobalValue::AvailableExternallyLinkage:
2262     Out << "available_externally ";
2263     break;
2264   }
2265 }
2266
2267 static void PrintVisibility(GlobalValue::VisibilityTypes Vis,
2268                             formatted_raw_ostream &Out) {
2269   switch (Vis) {
2270   case GlobalValue::DefaultVisibility: break;
2271   case GlobalValue::HiddenVisibility:    Out << "hidden "; break;
2272   case GlobalValue::ProtectedVisibility: Out << "protected "; break;
2273   }
2274 }
2275
2276 static void PrintDLLStorageClass(GlobalValue::DLLStorageClassTypes SCT,
2277                                  formatted_raw_ostream &Out) {
2278   switch (SCT) {
2279   case GlobalValue::DefaultStorageClass: break;
2280   case GlobalValue::DLLImportStorageClass: Out << "dllimport "; break;
2281   case GlobalValue::DLLExportStorageClass: Out << "dllexport "; break;
2282   }
2283 }
2284
2285 static void PrintThreadLocalModel(GlobalVariable::ThreadLocalMode TLM,
2286                                   formatted_raw_ostream &Out) {
2287   switch (TLM) {
2288     case GlobalVariable::NotThreadLocal:
2289       break;
2290     case GlobalVariable::GeneralDynamicTLSModel:
2291       Out << "thread_local ";
2292       break;
2293     case GlobalVariable::LocalDynamicTLSModel:
2294       Out << "thread_local(localdynamic) ";
2295       break;
2296     case GlobalVariable::InitialExecTLSModel:
2297       Out << "thread_local(initialexec) ";
2298       break;
2299     case GlobalVariable::LocalExecTLSModel:
2300       Out << "thread_local(localexec) ";
2301       break;
2302   }
2303 }
2304
2305 static void maybePrintComdat(formatted_raw_ostream &Out,
2306                              const GlobalObject &GO) {
2307   const Comdat *C = GO.getComdat();
2308   if (!C)
2309     return;
2310
2311   if (isa<GlobalVariable>(GO))
2312     Out << ',';
2313   Out << " comdat";
2314
2315   if (GO.getName() == C->getName())
2316     return;
2317
2318   Out << '(';
2319   PrintLLVMName(Out, C->getName(), ComdatPrefix);
2320   Out << ')';
2321 }
2322
2323 void AssemblyWriter::printGlobal(const GlobalVariable *GV) {
2324   if (GV->isMaterializable())
2325     Out << "; Materializable\n";
2326
2327   WriteAsOperandInternal(Out, GV, &TypePrinter, &Machine, GV->getParent());
2328   Out << " = ";
2329
2330   if (!GV->hasInitializer() && GV->hasExternalLinkage())
2331     Out << "external ";
2332
2333   PrintLinkage(GV->getLinkage(), Out);
2334   PrintVisibility(GV->getVisibility(), Out);
2335   PrintDLLStorageClass(GV->getDLLStorageClass(), Out);
2336   PrintThreadLocalModel(GV->getThreadLocalMode(), Out);
2337   if (GV->hasUnnamedAddr())
2338     Out << "unnamed_addr ";
2339
2340   if (unsigned AddressSpace = GV->getType()->getAddressSpace())
2341     Out << "addrspace(" << AddressSpace << ") ";
2342   if (GV->isExternallyInitialized()) Out << "externally_initialized ";
2343   Out << (GV->isConstant() ? "constant " : "global ");
2344   TypePrinter.print(GV->getType()->getElementType(), Out);
2345
2346   if (GV->hasInitializer()) {
2347     Out << ' ';
2348     writeOperand(GV->getInitializer(), false);
2349   }
2350
2351   if (GV->hasSection()) {
2352     Out << ", section \"";
2353     PrintEscapedString(GV->getSection(), Out);
2354     Out << '"';
2355   }
2356   maybePrintComdat(Out, *GV);
2357   if (GV->getAlignment())
2358     Out << ", align " << GV->getAlignment();
2359
2360   printInfoComment(*GV);
2361 }
2362
2363 void AssemblyWriter::printAlias(const GlobalAlias *GA) {
2364   if (GA->isMaterializable())
2365     Out << "; Materializable\n";
2366
2367   // Don't crash when dumping partially built GA
2368   if (!GA->hasName())
2369     Out << "<<nameless>> = ";
2370   else {
2371     PrintLLVMName(Out, GA);
2372     Out << " = ";
2373   }
2374   PrintLinkage(GA->getLinkage(), Out);
2375   PrintVisibility(GA->getVisibility(), Out);
2376   PrintDLLStorageClass(GA->getDLLStorageClass(), Out);
2377   PrintThreadLocalModel(GA->getThreadLocalMode(), Out);
2378   if (GA->hasUnnamedAddr())
2379     Out << "unnamed_addr ";
2380
2381   Out << "alias ";
2382
2383   const Constant *Aliasee = GA->getAliasee();
2384
2385   if (!Aliasee) {
2386     TypePrinter.print(GA->getType(), Out);
2387     Out << " <<NULL ALIASEE>>";
2388   } else {
2389     writeOperand(Aliasee, !isa<ConstantExpr>(Aliasee));
2390   }
2391
2392   printInfoComment(*GA);
2393   Out << '\n';
2394 }
2395
2396 void AssemblyWriter::printComdat(const Comdat *C) {
2397   C->print(Out);
2398 }
2399
2400 void AssemblyWriter::printTypeIdentities() {
2401   if (TypePrinter.NumberedTypes.empty() &&
2402       TypePrinter.NamedTypes.empty())
2403     return;
2404
2405   Out << '\n';
2406
2407   // We know all the numbers that each type is used and we know that it is a
2408   // dense assignment.  Convert the map to an index table.
2409   std::vector<StructType*> NumberedTypes(TypePrinter.NumberedTypes.size());
2410   for (DenseMap<StructType*, unsigned>::iterator I =
2411        TypePrinter.NumberedTypes.begin(), E = TypePrinter.NumberedTypes.end();
2412        I != E; ++I) {
2413     assert(I->second < NumberedTypes.size() && "Didn't get a dense numbering?");
2414     NumberedTypes[I->second] = I->first;
2415   }
2416
2417   // Emit all numbered types.
2418   for (unsigned i = 0, e = NumberedTypes.size(); i != e; ++i) {
2419     Out << '%' << i << " = type ";
2420
2421     // Make sure we print out at least one level of the type structure, so
2422     // that we do not get %2 = type %2
2423     TypePrinter.printStructBody(NumberedTypes[i], Out);
2424     Out << '\n';
2425   }
2426
2427   for (unsigned i = 0, e = TypePrinter.NamedTypes.size(); i != e; ++i) {
2428     PrintLLVMName(Out, TypePrinter.NamedTypes[i]->getName(), LocalPrefix);
2429     Out << " = type ";
2430
2431     // Make sure we print out at least one level of the type structure, so
2432     // that we do not get %FILE = type %FILE
2433     TypePrinter.printStructBody(TypePrinter.NamedTypes[i], Out);
2434     Out << '\n';
2435   }
2436 }
2437
2438 /// printFunction - Print all aspects of a function.
2439 ///
2440 void AssemblyWriter::printFunction(const Function *F) {
2441   // Print out the return type and name.
2442   Out << '\n';
2443
2444   if (AnnotationWriter) AnnotationWriter->emitFunctionAnnot(F, Out);
2445
2446   if (F->isMaterializable())
2447     Out << "; Materializable\n";
2448
2449   const AttributeSet &Attrs = F->getAttributes();
2450   if (Attrs.hasAttributes(AttributeSet::FunctionIndex)) {
2451     AttributeSet AS = Attrs.getFnAttributes();
2452     std::string AttrStr;
2453
2454     unsigned Idx = 0;
2455     for (unsigned E = AS.getNumSlots(); Idx != E; ++Idx)
2456       if (AS.getSlotIndex(Idx) == AttributeSet::FunctionIndex)
2457         break;
2458
2459     for (AttributeSet::iterator I = AS.begin(Idx), E = AS.end(Idx);
2460          I != E; ++I) {
2461       Attribute Attr = *I;
2462       if (!Attr.isStringAttribute()) {
2463         if (!AttrStr.empty()) AttrStr += ' ';
2464         AttrStr += Attr.getAsString();
2465       }
2466     }
2467
2468     if (!AttrStr.empty())
2469       Out << "; Function Attrs: " << AttrStr << '\n';
2470   }
2471
2472   if (F->isDeclaration())
2473     Out << "declare ";
2474   else
2475     Out << "define ";
2476
2477   PrintLinkage(F->getLinkage(), Out);
2478   PrintVisibility(F->getVisibility(), Out);
2479   PrintDLLStorageClass(F->getDLLStorageClass(), Out);
2480
2481   // Print the calling convention.
2482   if (F->getCallingConv() != CallingConv::C) {
2483     PrintCallingConv(F->getCallingConv(), Out);
2484     Out << " ";
2485   }
2486
2487   FunctionType *FT = F->getFunctionType();
2488   if (Attrs.hasAttributes(AttributeSet::ReturnIndex))
2489     Out <<  Attrs.getAsString(AttributeSet::ReturnIndex) << ' ';
2490   TypePrinter.print(F->getReturnType(), Out);
2491   Out << ' ';
2492   WriteAsOperandInternal(Out, F, &TypePrinter, &Machine, F->getParent());
2493   Out << '(';
2494   Machine.incorporateFunction(F);
2495
2496   // Loop over the arguments, printing them...
2497
2498   unsigned Idx = 1;
2499   if (!F->isDeclaration()) {
2500     // If this isn't a declaration, print the argument names as well.
2501     for (Function::const_arg_iterator I = F->arg_begin(), E = F->arg_end();
2502          I != E; ++I) {
2503       // Insert commas as we go... the first arg doesn't get a comma
2504       if (I != F->arg_begin()) Out << ", ";
2505       printArgument(I, Attrs, Idx);
2506       Idx++;
2507     }
2508   } else {
2509     // Otherwise, print the types from the function type.
2510     for (unsigned i = 0, e = FT->getNumParams(); i != e; ++i) {
2511       // Insert commas as we go... the first arg doesn't get a comma
2512       if (i) Out << ", ";
2513
2514       // Output type...
2515       TypePrinter.print(FT->getParamType(i), Out);
2516
2517       if (Attrs.hasAttributes(i+1))
2518         Out << ' ' << Attrs.getAsString(i+1);
2519     }
2520   }
2521
2522   // Finish printing arguments...
2523   if (FT->isVarArg()) {
2524     if (FT->getNumParams()) Out << ", ";
2525     Out << "...";  // Output varargs portion of signature!
2526   }
2527   Out << ')';
2528   if (F->hasUnnamedAddr())
2529     Out << " unnamed_addr";
2530   if (Attrs.hasAttributes(AttributeSet::FunctionIndex))
2531     Out << " #" << Machine.getAttributeGroupSlot(Attrs.getFnAttributes());
2532   if (F->hasSection()) {
2533     Out << " section \"";
2534     PrintEscapedString(F->getSection(), Out);
2535     Out << '"';
2536   }
2537   maybePrintComdat(Out, *F);
2538   if (F->getAlignment())
2539     Out << " align " << F->getAlignment();
2540   if (F->hasGC())
2541     Out << " gc \"" << F->getGC() << '"';
2542   if (F->hasPrefixData()) {
2543     Out << " prefix ";
2544     writeOperand(F->getPrefixData(), true);
2545   }
2546   if (F->hasPrologueData()) {
2547     Out << " prologue ";
2548     writeOperand(F->getPrologueData(), true);
2549   }
2550
2551   SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
2552   F->getAllMetadata(MDs);
2553   printMetadataAttachments(MDs, " ");
2554
2555   if (F->isDeclaration()) {
2556     Out << '\n';
2557   } else {
2558     Out << " {";
2559     // Output all of the function's basic blocks.
2560     for (Function::const_iterator I = F->begin(), E = F->end(); I != E; ++I)
2561       printBasicBlock(I);
2562
2563     // Output the function's use-lists.
2564     printUseLists(F);
2565
2566     Out << "}\n";
2567   }
2568
2569   Machine.purgeFunction();
2570 }
2571
2572 /// printArgument - This member is called for every argument that is passed into
2573 /// the function.  Simply print it out
2574 ///
2575 void AssemblyWriter::printArgument(const Argument *Arg,
2576                                    AttributeSet Attrs, unsigned Idx) {
2577   // Output type...
2578   TypePrinter.print(Arg->getType(), Out);
2579
2580   // Output parameter attributes list
2581   if (Attrs.hasAttributes(Idx))
2582     Out << ' ' << Attrs.getAsString(Idx);
2583
2584   // Output name, if available...
2585   if (Arg->hasName()) {
2586     Out << ' ';
2587     PrintLLVMName(Out, Arg);
2588   }
2589 }
2590
2591 /// printBasicBlock - This member is called for each basic block in a method.
2592 ///
2593 void AssemblyWriter::printBasicBlock(const BasicBlock *BB) {
2594   if (BB->hasName()) {              // Print out the label if it exists...
2595     Out << "\n";
2596     PrintLLVMName(Out, BB->getName(), LabelPrefix);
2597     Out << ':';
2598   } else if (!BB->use_empty()) {      // Don't print block # of no uses...
2599     Out << "\n; <label>:";
2600     int Slot = Machine.getLocalSlot(BB);
2601     if (Slot != -1)
2602       Out << Slot;
2603     else
2604       Out << "<badref>";
2605   }
2606
2607   if (!BB->getParent()) {
2608     Out.PadToColumn(50);
2609     Out << "; Error: Block without parent!";
2610   } else if (BB != &BB->getParent()->getEntryBlock()) {  // Not the entry block?
2611     // Output predecessors for the block.
2612     Out.PadToColumn(50);
2613     Out << ";";
2614     const_pred_iterator PI = pred_begin(BB), PE = pred_end(BB);
2615
2616     if (PI == PE) {
2617       Out << " No predecessors!";
2618     } else {
2619       Out << " preds = ";
2620       writeOperand(*PI, false);
2621       for (++PI; PI != PE; ++PI) {
2622         Out << ", ";
2623         writeOperand(*PI, false);
2624       }
2625     }
2626   }
2627
2628   Out << "\n";
2629
2630   if (AnnotationWriter) AnnotationWriter->emitBasicBlockStartAnnot(BB, Out);
2631
2632   // Output all of the instructions in the basic block...
2633   for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I != E; ++I) {
2634     printInstructionLine(*I);
2635   }
2636
2637   if (AnnotationWriter) AnnotationWriter->emitBasicBlockEndAnnot(BB, Out);
2638 }
2639
2640 /// printInstructionLine - Print an instruction and a newline character.
2641 void AssemblyWriter::printInstructionLine(const Instruction &I) {
2642   printInstruction(I);
2643   Out << '\n';
2644 }
2645
2646 /// printGCRelocateComment - print comment after call to the gc.relocate
2647 /// intrinsic indicating base and derived pointer names.
2648 void AssemblyWriter::printGCRelocateComment(const Value &V) {
2649   assert(isGCRelocate(&V));
2650   GCRelocateOperands GCOps(cast<Instruction>(&V));
2651
2652   Out << " ; (";
2653   writeOperand(GCOps.getBasePtr(), false);
2654   Out << ", ";
2655   writeOperand(GCOps.getDerivedPtr(), false);
2656   Out << ")";
2657 }
2658
2659 /// printInfoComment - Print a little comment after the instruction indicating
2660 /// which slot it occupies.
2661 ///
2662 void AssemblyWriter::printInfoComment(const Value &V) {
2663   if (isGCRelocate(&V))
2664     printGCRelocateComment(V);
2665
2666   if (AnnotationWriter)
2667     AnnotationWriter->printInfoComment(V, Out);
2668 }
2669
2670 // This member is called for each Instruction in a function..
2671 void AssemblyWriter::printInstruction(const Instruction &I) {
2672   if (AnnotationWriter) AnnotationWriter->emitInstructionAnnot(&I, Out);
2673
2674   // Print out indentation for an instruction.
2675   Out << "  ";
2676
2677   // Print out name if it exists...
2678   if (I.hasName()) {
2679     PrintLLVMName(Out, &I);
2680     Out << " = ";
2681   } else if (!I.getType()->isVoidTy()) {
2682     // Print out the def slot taken.
2683     int SlotNum = Machine.getLocalSlot(&I);
2684     if (SlotNum == -1)
2685       Out << "<badref> = ";
2686     else
2687       Out << '%' << SlotNum << " = ";
2688   }
2689
2690   if (const CallInst *CI = dyn_cast<CallInst>(&I)) {
2691     if (CI->isMustTailCall())
2692       Out << "musttail ";
2693     else if (CI->isTailCall())
2694       Out << "tail ";
2695   }
2696
2697   // Print out the opcode...
2698   Out << I.getOpcodeName();
2699
2700   // If this is an atomic load or store, print out the atomic marker.
2701   if ((isa<LoadInst>(I)  && cast<LoadInst>(I).isAtomic()) ||
2702       (isa<StoreInst>(I) && cast<StoreInst>(I).isAtomic()))
2703     Out << " atomic";
2704
2705   if (isa<AtomicCmpXchgInst>(I) && cast<AtomicCmpXchgInst>(I).isWeak())
2706     Out << " weak";
2707
2708   // If this is a volatile operation, print out the volatile marker.
2709   if ((isa<LoadInst>(I)  && cast<LoadInst>(I).isVolatile()) ||
2710       (isa<StoreInst>(I) && cast<StoreInst>(I).isVolatile()) ||
2711       (isa<AtomicCmpXchgInst>(I) && cast<AtomicCmpXchgInst>(I).isVolatile()) ||
2712       (isa<AtomicRMWInst>(I) && cast<AtomicRMWInst>(I).isVolatile()))
2713     Out << " volatile";
2714
2715   // Print out optimization information.
2716   WriteOptimizationInfo(Out, &I);
2717
2718   // Print out the compare instruction predicates
2719   if (const CmpInst *CI = dyn_cast<CmpInst>(&I))
2720     Out << ' ' << getPredicateText(CI->getPredicate());
2721
2722   // Print out the atomicrmw operation
2723   if (const AtomicRMWInst *RMWI = dyn_cast<AtomicRMWInst>(&I))
2724     writeAtomicRMWOperation(Out, RMWI->getOperation());
2725
2726   // Print out the type of the operands...
2727   const Value *Operand = I.getNumOperands() ? I.getOperand(0) : nullptr;
2728
2729   // Special case conditional branches to swizzle the condition out to the front
2730   if (isa<BranchInst>(I) && cast<BranchInst>(I).isConditional()) {
2731     const BranchInst &BI(cast<BranchInst>(I));
2732     Out << ' ';
2733     writeOperand(BI.getCondition(), true);
2734     Out << ", ";
2735     writeOperand(BI.getSuccessor(0), true);
2736     Out << ", ";
2737     writeOperand(BI.getSuccessor(1), true);
2738
2739   } else if (isa<SwitchInst>(I)) {
2740     const SwitchInst& SI(cast<SwitchInst>(I));
2741     // Special case switch instruction to get formatting nice and correct.
2742     Out << ' ';
2743     writeOperand(SI.getCondition(), true);
2744     Out << ", ";
2745     writeOperand(SI.getDefaultDest(), true);
2746     Out << " [";
2747     for (SwitchInst::ConstCaseIt i = SI.case_begin(), e = SI.case_end();
2748          i != e; ++i) {
2749       Out << "\n    ";
2750       writeOperand(i.getCaseValue(), true);
2751       Out << ", ";
2752       writeOperand(i.getCaseSuccessor(), true);
2753     }
2754     Out << "\n  ]";
2755   } else if (isa<IndirectBrInst>(I)) {
2756     // Special case indirectbr instruction to get formatting nice and correct.
2757     Out << ' ';
2758     writeOperand(Operand, true);
2759     Out << ", [";
2760
2761     for (unsigned i = 1, e = I.getNumOperands(); i != e; ++i) {
2762       if (i != 1)
2763         Out << ", ";
2764       writeOperand(I.getOperand(i), true);
2765     }
2766     Out << ']';
2767   } else if (const PHINode *PN = dyn_cast<PHINode>(&I)) {
2768     Out << ' ';
2769     TypePrinter.print(I.getType(), Out);
2770     Out << ' ';
2771
2772     for (unsigned op = 0, Eop = PN->getNumIncomingValues(); op < Eop; ++op) {
2773       if (op) Out << ", ";
2774       Out << "[ ";
2775       writeOperand(PN->getIncomingValue(op), false); Out << ", ";
2776       writeOperand(PN->getIncomingBlock(op), false); Out << " ]";
2777     }
2778   } else if (const ExtractValueInst *EVI = dyn_cast<ExtractValueInst>(&I)) {
2779     Out << ' ';
2780     writeOperand(I.getOperand(0), true);
2781     for (const unsigned *i = EVI->idx_begin(), *e = EVI->idx_end(); i != e; ++i)
2782       Out << ", " << *i;
2783   } else if (const InsertValueInst *IVI = dyn_cast<InsertValueInst>(&I)) {
2784     Out << ' ';
2785     writeOperand(I.getOperand(0), true); Out << ", ";
2786     writeOperand(I.getOperand(1), true);
2787     for (const unsigned *i = IVI->idx_begin(), *e = IVI->idx_end(); i != e; ++i)
2788       Out << ", " << *i;
2789   } else if (const LandingPadInst *LPI = dyn_cast<LandingPadInst>(&I)) {
2790     Out << ' ';
2791     TypePrinter.print(I.getType(), Out);
2792     Out << " personality ";
2793     writeOperand(I.getOperand(0), true); Out << '\n';
2794
2795     if (LPI->isCleanup())
2796       Out << "          cleanup";
2797
2798     for (unsigned i = 0, e = LPI->getNumClauses(); i != e; ++i) {
2799       if (i != 0 || LPI->isCleanup()) Out << "\n";
2800       if (LPI->isCatch(i))
2801         Out << "          catch ";
2802       else
2803         Out << "          filter ";
2804
2805       writeOperand(LPI->getClause(i), true);
2806     }
2807   } else if (isa<ReturnInst>(I) && !Operand) {
2808     Out << " void";
2809   } else if (const CallInst *CI = dyn_cast<CallInst>(&I)) {
2810     // Print the calling convention being used.
2811     if (CI->getCallingConv() != CallingConv::C) {
2812       Out << " ";
2813       PrintCallingConv(CI->getCallingConv(), Out);
2814     }
2815
2816     Operand = CI->getCalledValue();
2817     FunctionType *FTy = cast<FunctionType>(CI->getFunctionType());
2818     Type *RetTy = FTy->getReturnType();
2819     const AttributeSet &PAL = CI->getAttributes();
2820
2821     if (PAL.hasAttributes(AttributeSet::ReturnIndex))
2822       Out << ' ' << PAL.getAsString(AttributeSet::ReturnIndex);
2823
2824     // If possible, print out the short form of the call instruction.  We can
2825     // only do this if the first argument is a pointer to a nonvararg function,
2826     // and if the return type is not a pointer to a function.
2827     //
2828     Out << ' ';
2829     TypePrinter.print(FTy->isVarArg() ? FTy : RetTy, Out);
2830     Out << ' ';
2831     writeOperand(Operand, false);
2832     Out << '(';
2833     for (unsigned op = 0, Eop = CI->getNumArgOperands(); op < Eop; ++op) {
2834       if (op > 0)
2835         Out << ", ";
2836       writeParamOperand(CI->getArgOperand(op), PAL, op + 1);
2837     }
2838
2839     // Emit an ellipsis if this is a musttail call in a vararg function.  This
2840     // is only to aid readability, musttail calls forward varargs by default.
2841     if (CI->isMustTailCall() && CI->getParent() &&
2842         CI->getParent()->getParent() &&
2843         CI->getParent()->getParent()->isVarArg())
2844       Out << ", ...";
2845
2846     Out << ')';
2847     if (PAL.hasAttributes(AttributeSet::FunctionIndex))
2848       Out << " #" << Machine.getAttributeGroupSlot(PAL.getFnAttributes());
2849   } else if (const InvokeInst *II = dyn_cast<InvokeInst>(&I)) {
2850     Operand = II->getCalledValue();
2851     FunctionType *FTy = cast<FunctionType>(II->getFunctionType());
2852     Type *RetTy = FTy->getReturnType();
2853     const AttributeSet &PAL = II->getAttributes();
2854
2855     // Print the calling convention being used.
2856     if (II->getCallingConv() != CallingConv::C) {
2857       Out << " ";
2858       PrintCallingConv(II->getCallingConv(), Out);
2859     }
2860
2861     if (PAL.hasAttributes(AttributeSet::ReturnIndex))
2862       Out << ' ' << PAL.getAsString(AttributeSet::ReturnIndex);
2863
2864     // If possible, print out the short form of the invoke instruction. We can
2865     // only do this if the first argument is a pointer to a nonvararg function,
2866     // and if the return type is not a pointer to a function.
2867     //
2868     Out << ' ';
2869     TypePrinter.print(FTy->isVarArg() ? FTy : RetTy, Out);
2870     Out << ' ';
2871     writeOperand(Operand, false);
2872     Out << '(';
2873     for (unsigned op = 0, Eop = II->getNumArgOperands(); op < Eop; ++op) {
2874       if (op)
2875         Out << ", ";
2876       writeParamOperand(II->getArgOperand(op), PAL, op + 1);
2877     }
2878
2879     Out << ')';
2880     if (PAL.hasAttributes(AttributeSet::FunctionIndex))
2881       Out << " #" << Machine.getAttributeGroupSlot(PAL.getFnAttributes());
2882
2883     Out << "\n          to ";
2884     writeOperand(II->getNormalDest(), true);
2885     Out << " unwind ";
2886     writeOperand(II->getUnwindDest(), true);
2887
2888   } else if (const AllocaInst *AI = dyn_cast<AllocaInst>(&I)) {
2889     Out << ' ';
2890     if (AI->isUsedWithInAlloca())
2891       Out << "inalloca ";
2892     TypePrinter.print(AI->getAllocatedType(), Out);
2893
2894     // Explicitly write the array size if the code is broken, if it's an array
2895     // allocation, or if the type is not canonical for scalar allocations.  The
2896     // latter case prevents the type from mutating when round-tripping through
2897     // assembly.
2898     if (!AI->getArraySize() || AI->isArrayAllocation() ||
2899         !AI->getArraySize()->getType()->isIntegerTy(32)) {
2900       Out << ", ";
2901       writeOperand(AI->getArraySize(), true);
2902     }
2903     if (AI->getAlignment()) {
2904       Out << ", align " << AI->getAlignment();
2905     }
2906   } else if (isa<CastInst>(I)) {
2907     if (Operand) {
2908       Out << ' ';
2909       writeOperand(Operand, true);   // Work with broken code
2910     }
2911     Out << " to ";
2912     TypePrinter.print(I.getType(), Out);
2913   } else if (isa<VAArgInst>(I)) {
2914     if (Operand) {
2915       Out << ' ';
2916       writeOperand(Operand, true);   // Work with broken code
2917     }
2918     Out << ", ";
2919     TypePrinter.print(I.getType(), Out);
2920   } else if (Operand) {   // Print the normal way.
2921     if (const auto *GEP = dyn_cast<GetElementPtrInst>(&I)) {
2922       Out << ' ';
2923       TypePrinter.print(GEP->getSourceElementType(), Out);
2924       Out << ',';
2925     } else if (const auto *LI = dyn_cast<LoadInst>(&I)) {
2926       Out << ' ';
2927       TypePrinter.print(LI->getType(), Out);
2928       Out << ',';
2929     }
2930
2931     // PrintAllTypes - Instructions who have operands of all the same type
2932     // omit the type from all but the first operand.  If the instruction has
2933     // different type operands (for example br), then they are all printed.
2934     bool PrintAllTypes = false;
2935     Type *TheType = Operand->getType();
2936
2937     // Select, Store and ShuffleVector always print all types.
2938     if (isa<SelectInst>(I) || isa<StoreInst>(I) || isa<ShuffleVectorInst>(I)
2939         || isa<ReturnInst>(I)) {
2940       PrintAllTypes = true;
2941     } else {
2942       for (unsigned i = 1, E = I.getNumOperands(); i != E; ++i) {
2943         Operand = I.getOperand(i);
2944         // note that Operand shouldn't be null, but the test helps make dump()
2945         // more tolerant of malformed IR
2946         if (Operand && Operand->getType() != TheType) {
2947           PrintAllTypes = true;    // We have differing types!  Print them all!
2948           break;
2949         }
2950       }
2951     }
2952
2953     if (!PrintAllTypes) {
2954       Out << ' ';
2955       TypePrinter.print(TheType, Out);
2956     }
2957
2958     Out << ' ';
2959     for (unsigned i = 0, E = I.getNumOperands(); i != E; ++i) {
2960       if (i) Out << ", ";
2961       writeOperand(I.getOperand(i), PrintAllTypes);
2962     }
2963   }
2964
2965   // Print atomic ordering/alignment for memory operations
2966   if (const LoadInst *LI = dyn_cast<LoadInst>(&I)) {
2967     if (LI->isAtomic())
2968       writeAtomic(LI->getOrdering(), LI->getSynchScope());
2969     if (LI->getAlignment())
2970       Out << ", align " << LI->getAlignment();
2971   } else if (const StoreInst *SI = dyn_cast<StoreInst>(&I)) {
2972     if (SI->isAtomic())
2973       writeAtomic(SI->getOrdering(), SI->getSynchScope());
2974     if (SI->getAlignment())
2975       Out << ", align " << SI->getAlignment();
2976   } else if (const AtomicCmpXchgInst *CXI = dyn_cast<AtomicCmpXchgInst>(&I)) {
2977     writeAtomicCmpXchg(CXI->getSuccessOrdering(), CXI->getFailureOrdering(),
2978                        CXI->getSynchScope());
2979   } else if (const AtomicRMWInst *RMWI = dyn_cast<AtomicRMWInst>(&I)) {
2980     writeAtomic(RMWI->getOrdering(), RMWI->getSynchScope());
2981   } else if (const FenceInst *FI = dyn_cast<FenceInst>(&I)) {
2982     writeAtomic(FI->getOrdering(), FI->getSynchScope());
2983   }
2984
2985   // Print Metadata info.
2986   SmallVector<std::pair<unsigned, MDNode *>, 4> InstMD;
2987   I.getAllMetadata(InstMD);
2988   printMetadataAttachments(InstMD, ", ");
2989
2990   // Print a nice comment.
2991   printInfoComment(I);
2992 }
2993
2994 void AssemblyWriter::printMetadataAttachments(
2995     const SmallVectorImpl<std::pair<unsigned, MDNode *>> &MDs,
2996     StringRef Separator) {
2997   if (MDs.empty())
2998     return;
2999
3000   if (MDNames.empty())
3001     TheModule->getMDKindNames(MDNames);
3002
3003   for (const auto &I : MDs) {
3004     unsigned Kind = I.first;
3005     Out << Separator;
3006     if (Kind < MDNames.size()) {
3007       Out << "!";
3008       printMetadataIdentifier(MDNames[Kind], Out);
3009     } else
3010       Out << "!<unknown kind #" << Kind << ">";
3011     Out << ' ';
3012     WriteAsOperandInternal(Out, I.second, &TypePrinter, &Machine, TheModule);
3013   }
3014 }
3015
3016 void AssemblyWriter::writeMDNode(unsigned Slot, const MDNode *Node) {
3017   Out << '!' << Slot << " = ";
3018   printMDNodeBody(Node);
3019   Out << "\n";
3020 }
3021
3022 void AssemblyWriter::writeAllMDNodes() {
3023   SmallVector<const MDNode *, 16> Nodes;
3024   Nodes.resize(Machine.mdn_size());
3025   for (SlotTracker::mdn_iterator I = Machine.mdn_begin(), E = Machine.mdn_end();
3026        I != E; ++I)
3027     Nodes[I->second] = cast<MDNode>(I->first);
3028
3029   for (unsigned i = 0, e = Nodes.size(); i != e; ++i) {
3030     writeMDNode(i, Nodes[i]);
3031   }
3032 }
3033
3034 void AssemblyWriter::printMDNodeBody(const MDNode *Node) {
3035   WriteMDNodeBodyInternal(Out, Node, &TypePrinter, &Machine, TheModule);
3036 }
3037
3038 void AssemblyWriter::writeAllAttributeGroups() {
3039   std::vector<std::pair<AttributeSet, unsigned> > asVec;
3040   asVec.resize(Machine.as_size());
3041
3042   for (SlotTracker::as_iterator I = Machine.as_begin(), E = Machine.as_end();
3043        I != E; ++I)
3044     asVec[I->second] = *I;
3045
3046   for (std::vector<std::pair<AttributeSet, unsigned> >::iterator
3047          I = asVec.begin(), E = asVec.end(); I != E; ++I)
3048     Out << "attributes #" << I->second << " = { "
3049         << I->first.getAsString(AttributeSet::FunctionIndex, true) << " }\n";
3050 }
3051
3052 void AssemblyWriter::printUseListOrder(const UseListOrder &Order) {
3053   bool IsInFunction = Machine.getFunction();
3054   if (IsInFunction)
3055     Out << "  ";
3056
3057   Out << "uselistorder";
3058   if (const BasicBlock *BB =
3059           IsInFunction ? nullptr : dyn_cast<BasicBlock>(Order.V)) {
3060     Out << "_bb ";
3061     writeOperand(BB->getParent(), false);
3062     Out << ", ";
3063     writeOperand(BB, false);
3064   } else {
3065     Out << " ";
3066     writeOperand(Order.V, true);
3067   }
3068   Out << ", { ";
3069
3070   assert(Order.Shuffle.size() >= 2 && "Shuffle too small");
3071   Out << Order.Shuffle[0];
3072   for (unsigned I = 1, E = Order.Shuffle.size(); I != E; ++I)
3073     Out << ", " << Order.Shuffle[I];
3074   Out << " }\n";
3075 }
3076
3077 void AssemblyWriter::printUseLists(const Function *F) {
3078   auto hasMore =
3079       [&]() { return !UseListOrders.empty() && UseListOrders.back().F == F; };
3080   if (!hasMore())
3081     // Nothing to do.
3082     return;
3083
3084   Out << "\n; uselistorder directives\n";
3085   while (hasMore()) {
3086     printUseListOrder(UseListOrders.back());
3087     UseListOrders.pop_back();
3088   }
3089 }
3090
3091 //===----------------------------------------------------------------------===//
3092 //                       External Interface declarations
3093 //===----------------------------------------------------------------------===//
3094
3095 void Function::print(raw_ostream &ROS, AssemblyAnnotationWriter *AAW) const {
3096   SlotTracker SlotTable(this->getParent());
3097   formatted_raw_ostream OS(ROS);
3098   AssemblyWriter W(OS, SlotTable, this->getParent(), AAW);
3099   W.printFunction(this);
3100 }
3101
3102 void Module::print(raw_ostream &ROS, AssemblyAnnotationWriter *AAW,
3103                    bool ShouldPreserveUseListOrder) const {
3104   SlotTracker SlotTable(this);
3105   formatted_raw_ostream OS(ROS);
3106   AssemblyWriter W(OS, SlotTable, this, AAW, ShouldPreserveUseListOrder);
3107   W.printModule(this);
3108 }
3109
3110 void NamedMDNode::print(raw_ostream &ROS) const {
3111   SlotTracker SlotTable(getParent());
3112   formatted_raw_ostream OS(ROS);
3113   AssemblyWriter W(OS, SlotTable, getParent(), nullptr);
3114   W.printNamedMDNode(this);
3115 }
3116
3117 void Comdat::print(raw_ostream &ROS) const {
3118   PrintLLVMName(ROS, getName(), ComdatPrefix);
3119   ROS << " = comdat ";
3120
3121   switch (getSelectionKind()) {
3122   case Comdat::Any:
3123     ROS << "any";
3124     break;
3125   case Comdat::ExactMatch:
3126     ROS << "exactmatch";
3127     break;
3128   case Comdat::Largest:
3129     ROS << "largest";
3130     break;
3131   case Comdat::NoDuplicates:
3132     ROS << "noduplicates";
3133     break;
3134   case Comdat::SameSize:
3135     ROS << "samesize";
3136     break;
3137   }
3138
3139   ROS << '\n';
3140 }
3141
3142 void Type::print(raw_ostream &OS) const {
3143   TypePrinting TP;
3144   TP.print(const_cast<Type*>(this), OS);
3145
3146   // If the type is a named struct type, print the body as well.
3147   if (StructType *STy = dyn_cast<StructType>(const_cast<Type*>(this)))
3148     if (!STy->isLiteral()) {
3149       OS << " = type ";
3150       TP.printStructBody(STy, OS);
3151     }
3152 }
3153
3154 static bool isReferencingMDNode(const Instruction &I) {
3155   if (const auto *CI = dyn_cast<CallInst>(&I))
3156     if (Function *F = CI->getCalledFunction())
3157       if (F->isIntrinsic())
3158         for (auto &Op : I.operands())
3159           if (auto *V = dyn_cast_or_null<MetadataAsValue>(Op))
3160             if (isa<MDNode>(V->getMetadata()))
3161               return true;
3162   return false;
3163 }
3164
3165 void Value::print(raw_ostream &ROS) const {
3166   formatted_raw_ostream OS(ROS);
3167   if (const Instruction *I = dyn_cast<Instruction>(this)) {
3168     const Function *F = I->getParent() ? I->getParent()->getParent() : nullptr;
3169     SlotTracker SlotTable(
3170         F,
3171         /* ShouldInitializeAllMetadata */ isReferencingMDNode(*I));
3172     AssemblyWriter W(OS, SlotTable, getModuleFromVal(I), nullptr);
3173     W.printInstruction(*I);
3174   } else if (const BasicBlock *BB = dyn_cast<BasicBlock>(this)) {
3175     SlotTracker SlotTable(BB->getParent());
3176     AssemblyWriter W(OS, SlotTable, getModuleFromVal(BB), nullptr);
3177     W.printBasicBlock(BB);
3178   } else if (const GlobalValue *GV = dyn_cast<GlobalValue>(this)) {
3179     SlotTracker SlotTable(GV->getParent(),
3180                           /* ShouldInitializeAllMetadata */ isa<Function>(GV));
3181     AssemblyWriter W(OS, SlotTable, GV->getParent(), nullptr);
3182     if (const GlobalVariable *V = dyn_cast<GlobalVariable>(GV))
3183       W.printGlobal(V);
3184     else if (const Function *F = dyn_cast<Function>(GV))
3185       W.printFunction(F);
3186     else
3187       W.printAlias(cast<GlobalAlias>(GV));
3188   } else if (const MetadataAsValue *V = dyn_cast<MetadataAsValue>(this)) {
3189     V->getMetadata()->print(ROS, getModuleFromVal(V));
3190   } else if (const Constant *C = dyn_cast<Constant>(this)) {
3191     TypePrinting TypePrinter;
3192     TypePrinter.print(C->getType(), OS);
3193     OS << ' ';
3194     WriteConstantInternal(OS, C, TypePrinter, nullptr, nullptr);
3195   } else if (isa<InlineAsm>(this) || isa<Argument>(this)) {
3196     this->printAsOperand(OS);
3197   } else {
3198     llvm_unreachable("Unknown value to print out!");
3199   }
3200 }
3201
3202 void Value::printAsOperand(raw_ostream &O, bool PrintType, const Module *M) const {
3203   // Fast path: Don't construct and populate a TypePrinting object if we
3204   // won't be needing any types printed.
3205   bool IsMetadata = isa<MetadataAsValue>(this);
3206   if (!PrintType && ((!isa<Constant>(this) && !IsMetadata) || hasName() ||
3207                      isa<GlobalValue>(this))) {
3208     WriteAsOperandInternal(O, this, nullptr, nullptr, M);
3209     return;
3210   }
3211
3212   if (!M)
3213     M = getModuleFromVal(this);
3214
3215   TypePrinting TypePrinter;
3216   if (M)
3217     TypePrinter.incorporateTypes(*M);
3218   if (PrintType) {
3219     TypePrinter.print(getType(), O);
3220     O << ' ';
3221   }
3222
3223   SlotTracker Machine(M, /* ShouldInitializeAllMetadata */ IsMetadata);
3224   WriteAsOperandInternal(O, this, &TypePrinter, &Machine, M);
3225 }
3226
3227 static void printMetadataImpl(raw_ostream &ROS, const Metadata &MD,
3228                               const Module *M, bool OnlyAsOperand) {
3229   formatted_raw_ostream OS(ROS);
3230
3231   auto *N = dyn_cast<MDNode>(&MD);
3232   TypePrinting TypePrinter;
3233   SlotTracker Machine(M, /* ShouldInitializeAllMetadata */ N);
3234   if (M)
3235     TypePrinter.incorporateTypes(*M);
3236
3237   WriteAsOperandInternal(OS, &MD, &TypePrinter, &Machine, M,
3238                          /* FromValue */ true);
3239   if (OnlyAsOperand || !N)
3240     return;
3241
3242   OS << " = ";
3243   WriteMDNodeBodyInternal(OS, N, &TypePrinter, &Machine, M);
3244 }
3245
3246 void Metadata::printAsOperand(raw_ostream &OS, const Module *M) const {
3247   printMetadataImpl(OS, *this, M, /* OnlyAsOperand */ true);
3248 }
3249
3250 void Metadata::print(raw_ostream &OS, const Module *M) const {
3251   printMetadataImpl(OS, *this, M, /* OnlyAsOperand */ false);
3252 }
3253
3254 // Value::dump - allow easy printing of Values from the debugger.
3255 LLVM_DUMP_METHOD
3256 void Value::dump() const { print(dbgs()); dbgs() << '\n'; }
3257
3258 // Type::dump - allow easy printing of Types from the debugger.
3259 LLVM_DUMP_METHOD
3260 void Type::dump() const { print(dbgs()); dbgs() << '\n'; }
3261
3262 // Module::dump() - Allow printing of Modules from the debugger.
3263 LLVM_DUMP_METHOD
3264 void Module::dump() const { print(dbgs(), nullptr); }
3265
3266 // \brief Allow printing of Comdats from the debugger.
3267 LLVM_DUMP_METHOD
3268 void Comdat::dump() const { print(dbgs()); }
3269
3270 // NamedMDNode::dump() - Allow printing of NamedMDNodes from the debugger.
3271 LLVM_DUMP_METHOD
3272 void NamedMDNode::dump() const { print(dbgs()); }
3273
3274 LLVM_DUMP_METHOD
3275 void Metadata::dump() const { dump(nullptr); }
3276
3277 LLVM_DUMP_METHOD
3278 void Metadata::dump(const Module *M) const {
3279   print(dbgs(), M);
3280   dbgs() << '\n';
3281 }