1//===- AsmWriter.cpp - Printing LLVM as an assembly file ------------------===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8//
9// This library implements `print` family of functions in classes like
10// Module, Function, Value, etc. In-memory representation of those classes is
11// converted to IR strings.
12//
13// Note that these routines must be extremely tolerant of various errors in the
14// LLVM code, because it can be used for debugging transformations.
15//
16//===----------------------------------------------------------------------===//
17
18#include "llvm/ADT/APFloat.h"
19#include "llvm/ADT/APInt.h"
20#include "llvm/ADT/ArrayRef.h"
21#include "llvm/ADT/DenseMap.h"
22#include "llvm/ADT/STLExtras.h"
23#include "llvm/ADT/SetVector.h"
24#include "llvm/ADT/SmallPtrSet.h"
25#include "llvm/ADT/SmallString.h"
26#include "llvm/ADT/SmallVector.h"
27#include "llvm/ADT/StringExtras.h"
28#include "llvm/ADT/StringRef.h"
29#include "llvm/ADT/iterator_range.h"
30#include "llvm/BinaryFormat/Dwarf.h"
31#include "llvm/Config/llvm-config.h"
32#include "llvm/IR/Argument.h"
33#include "llvm/IR/AssemblyAnnotationWriter.h"
34#include "llvm/IR/Attributes.h"
35#include "llvm/IR/BasicBlock.h"
36#include "llvm/IR/CFG.h"
37#include "llvm/IR/CallingConv.h"
38#include "llvm/IR/Comdat.h"
39#include "llvm/IR/Constant.h"
40#include "llvm/IR/Constants.h"
41#include "llvm/IR/DebugInfoMetadata.h"
42#include "llvm/IR/DebugProgramInstruction.h"
43#include "llvm/IR/DerivedTypes.h"
44#include "llvm/IR/Function.h"
45#include "llvm/IR/GlobalAlias.h"
46#include "llvm/IR/GlobalIFunc.h"
47#include "llvm/IR/GlobalObject.h"
48#include "llvm/IR/GlobalValue.h"
49#include "llvm/IR/GlobalVariable.h"
50#include "llvm/IR/IRPrintingPasses.h"
51#include "llvm/IR/InlineAsm.h"
52#include "llvm/IR/InstrTypes.h"
53#include "llvm/IR/Instruction.h"
54#include "llvm/IR/Instructions.h"
55#include "llvm/IR/IntrinsicInst.h"
56#include "llvm/IR/Intrinsics.h"
57#include "llvm/IR/LLVMContext.h"
58#include "llvm/IR/Metadata.h"
59#include "llvm/IR/Module.h"
60#include "llvm/IR/ModuleSlotTracker.h"
61#include "llvm/IR/ModuleSummaryIndex.h"
62#include "llvm/IR/Operator.h"
63#include "llvm/IR/Type.h"
64#include "llvm/IR/TypeFinder.h"
65#include "llvm/IR/TypedPointerType.h"
66#include "llvm/IR/Use.h"
67#include "llvm/IR/User.h"
68#include "llvm/IR/Value.h"
69#include "llvm/Support/AtomicOrdering.h"
70#include "llvm/Support/Casting.h"
71#include "llvm/Support/Compiler.h"
72#include "llvm/Support/Debug.h"
73#include "llvm/Support/ErrorHandling.h"
74#include "llvm/Support/Format.h"
75#include "llvm/Support/FormattedStream.h"
76#include "llvm/Support/SaveAndRestore.h"
77#include "llvm/Support/raw_ostream.h"
78#include <cassert>
79#include <cctype>
80#include <cstddef>
81#include <cstdint>
82#include <iterator>
83#include <memory>
84#include <optional>
85#include <string>
86#include <tuple>
87#include <utility>
88#include <vector>
89
90using namespace llvm;
91
92// See https://llvm.org/docs/DebuggingLLVM.html for why these flags are useful.
93
94static cl::opt<bool>
95 PrintInstAddrs("print-inst-addrs", cl::Hidden,
96 cl::desc("Print addresses of instructions when dumping"));
97
98static cl::opt<bool> PrintInstDebugLocs(
99 "print-inst-debug-locs", cl::Hidden,
100 cl::desc("Pretty print debug locations of instructions when dumping"));
101
102static cl::opt<bool> PrintProfData(
103 "print-prof-data", cl::Hidden,
104 cl::desc("Pretty print perf data (branch weights, etc) when dumping"));
105
106static cl::opt<bool> PreserveAssemblyUseListOrder(
107 "preserve-ll-uselistorder", cl::Hidden, cl::init(Val: false),
108 cl::desc("Preserve use-list order when writing LLVM assembly."));
109
110static cl::opt<bool> PrintAddrspaceName("print-addrspace-name", cl::Hidden,
111 cl::init(Val: false),
112 cl::desc("Print address space names"));
113
114// Make virtual table appear in this compilation unit.
115AssemblyAnnotationWriter::~AssemblyAnnotationWriter() = default;
116
117//===----------------------------------------------------------------------===//
118// Helper Functions
119//===----------------------------------------------------------------------===//
120
121using OrderMap = MapVector<const Value *, unsigned>;
122
123using UseListOrderMap =
124 DenseMap<const Function *, MapVector<const Value *, std::vector<unsigned>>>;
125
126/// Look for a value that might be wrapped as metadata, e.g. a value in a
127/// metadata operand. Returns the input value as-is if it is not wrapped.
128static const Value *skipMetadataWrapper(const Value *V) {
129 if (const auto *MAV = dyn_cast<MetadataAsValue>(Val: V))
130 if (const auto *VAM = dyn_cast<ValueAsMetadata>(Val: MAV->getMetadata()))
131 return VAM->getValue();
132 return V;
133}
134
135static void orderValue(const Value *V, OrderMap &OM) {
136 if (OM.lookup(Key: V))
137 return;
138
139 if (const auto *C = dyn_cast<Constant>(Val: V)) {
140 if (isa<ConstantData>(Val: C))
141 return;
142
143 if (C->getNumOperands() && !isa<GlobalValue>(Val: C))
144 for (const Value *Op : C->operands())
145 if (!isa<BasicBlock>(Val: Op) && !isa<GlobalValue>(Val: Op))
146 orderValue(V: Op, OM);
147 }
148
149 // Note: we cannot cache this lookup above, since inserting into the map
150 // changes the map's size, and thus affects the other IDs.
151 unsigned ID = OM.size() + 1;
152 OM[V] = ID;
153}
154
155static OrderMap orderModule(const Module *M) {
156 OrderMap OM;
157
158 auto OrderConstantValue = [&OM](const Value *V) {
159 if (isa<Constant>(Val: V) || isa<InlineAsm>(Val: V))
160 orderValue(V, OM);
161 };
162
163 auto OrderConstantFromMetadata = [&](Metadata *MD) {
164 if (const auto *VAM = dyn_cast<ValueAsMetadata>(Val: MD)) {
165 OrderConstantValue(VAM->getValue());
166 } else if (const auto *AL = dyn_cast<DIArgList>(Val: MD)) {
167 for (const auto *VAM : AL->getArgs())
168 OrderConstantValue(VAM->getValue());
169 }
170 };
171
172 for (const GlobalVariable &G : M->globals()) {
173 if (G.hasInitializer())
174 if (!isa<GlobalValue>(Val: G.getInitializer()))
175 orderValue(V: G.getInitializer(), OM);
176 orderValue(V: &G, OM);
177 }
178 for (const GlobalAlias &A : M->aliases()) {
179 if (!isa<GlobalValue>(Val: A.getAliasee()))
180 orderValue(V: A.getAliasee(), OM);
181 orderValue(V: &A, OM);
182 }
183 for (const GlobalIFunc &I : M->ifuncs()) {
184 if (!isa<GlobalValue>(Val: I.getResolver()))
185 orderValue(V: I.getResolver(), OM);
186 orderValue(V: &I, OM);
187 }
188 for (const Function &F : *M) {
189 for (const Use &U : F.operands())
190 if (!isa<GlobalValue>(Val: U.get()))
191 orderValue(V: U.get(), OM);
192
193 orderValue(V: &F, OM);
194
195 if (F.isDeclaration())
196 continue;
197
198 for (const Argument &A : F.args())
199 orderValue(V: &A, OM);
200 for (const BasicBlock &BB : F) {
201 orderValue(V: &BB, OM);
202 for (const Instruction &I : BB) {
203 // Debug records can contain Value references, that can then contain
204 // Values disconnected from the rest of the Value hierachy, if wrapped
205 // in some kind of constant-expression. Find and order any Values that
206 // are wrapped in debug-info.
207 for (DbgVariableRecord &DVR : filterDbgVars(R: I.getDbgRecordRange())) {
208 OrderConstantFromMetadata(DVR.getRawLocation());
209 if (DVR.isDbgAssign())
210 OrderConstantFromMetadata(DVR.getRawAddress());
211 }
212
213 for (const Value *Op : I.operands()) {
214 Op = skipMetadataWrapper(V: Op);
215 if ((isa<Constant>(Val: *Op) && !isa<GlobalValue>(Val: *Op)) ||
216 isa<InlineAsm>(Val: *Op))
217 orderValue(V: Op, OM);
218 }
219 orderValue(V: &I, OM);
220 }
221 }
222 }
223 return OM;
224}
225
226static std::vector<unsigned>
227predictValueUseListOrder(const Value *V, unsigned ID, const OrderMap &OM) {
228 // Predict use-list order for this one.
229 using Entry = std::pair<const Use *, unsigned>;
230 SmallVector<Entry, 64> List;
231 for (const Use &U : V->uses())
232 // Check if this user will be serialized.
233 if (OM.lookup(Key: U.getUser()))
234 List.push_back(Elt: std::make_pair(x: &U, y: List.size()));
235
236 if (List.size() < 2)
237 // We may have lost some users.
238 return {};
239
240 // When referencing a value before its declaration, a temporary value is
241 // created, which will later be RAUWed with the actual value. This reverses
242 // the use list. This happens for all values apart from basic blocks.
243 bool GetsReversed = !isa<BasicBlock>(Val: V);
244 if (auto *BA = dyn_cast<BlockAddress>(Val: V))
245 ID = OM.lookup(Key: BA->getBasicBlock());
246 llvm::sort(C&: List, Comp: [&](const Entry &L, const Entry &R) {
247 const Use *LU = L.first;
248 const Use *RU = R.first;
249 if (LU == RU)
250 return false;
251
252 auto LID = OM.lookup(Key: LU->getUser());
253 auto RID = OM.lookup(Key: RU->getUser());
254
255 // If ID is 4, then expect: 7 6 5 1 2 3.
256 if (LID < RID) {
257 if (GetsReversed)
258 if (RID <= ID)
259 return true;
260 return false;
261 }
262 if (RID < LID) {
263 if (GetsReversed)
264 if (LID <= ID)
265 return false;
266 return true;
267 }
268
269 // LID and RID are equal, so we have different operands of the same user.
270 // Assume operands are added in order for all instructions.
271 if (GetsReversed)
272 if (LID <= ID)
273 return LU->getOperandNo() < RU->getOperandNo();
274 return LU->getOperandNo() > RU->getOperandNo();
275 });
276
277 if (llvm::is_sorted(Range&: List, C: llvm::less_second()))
278 // Order is already correct.
279 return {};
280
281 // Store the shuffle.
282 std::vector<unsigned> Shuffle(List.size());
283 for (size_t I = 0, E = List.size(); I != E; ++I)
284 Shuffle[I] = List[I].second;
285 return Shuffle;
286}
287
288static UseListOrderMap predictUseListOrder(const Module *M) {
289 OrderMap OM = orderModule(M);
290 UseListOrderMap ULOM;
291 for (const auto &Pair : OM) {
292 const Value *V = Pair.first;
293 if (V->use_empty() || std::next(x: V->use_begin()) == V->use_end())
294 continue;
295
296 std::vector<unsigned> Shuffle =
297 predictValueUseListOrder(V, ID: Pair.second, OM);
298 if (Shuffle.empty())
299 continue;
300
301 const Function *F = nullptr;
302 if (auto *I = dyn_cast<Instruction>(Val: V))
303 F = I->getFunction();
304 if (auto *A = dyn_cast<Argument>(Val: V))
305 F = A->getParent();
306 if (auto *BB = dyn_cast<BasicBlock>(Val: V))
307 F = BB->getParent();
308 ULOM[F][V] = std::move(Shuffle);
309 }
310 return ULOM;
311}
312
313static const Module *getModuleFromVal(const Value *V) {
314 if (const auto *MA = dyn_cast<Argument>(Val: V))
315 return MA->getParent() ? MA->getParent()->getParent() : nullptr;
316
317 if (const auto *BB = dyn_cast<BasicBlock>(Val: V))
318 return BB->getParent() ? BB->getParent()->getParent() : nullptr;
319
320 if (const auto *I = dyn_cast<Instruction>(Val: V)) {
321 const Function *M = I->getParent() ? I->getParent()->getParent() : nullptr;
322 return M ? M->getParent() : nullptr;
323 }
324
325 if (const auto *GV = dyn_cast<GlobalValue>(Val: V))
326 return GV->getParent();
327
328 if (const auto *MAV = dyn_cast<MetadataAsValue>(Val: V)) {
329 for (const User *U : MAV->users())
330 if (isa<Instruction>(Val: U))
331 if (const Module *M = getModuleFromVal(V: U))
332 return M;
333 return nullptr;
334 }
335
336 return nullptr;
337}
338
339static const Module *getModuleFromDPI(const DbgMarker *Marker) {
340 const Function *M =
341 Marker->getParent() ? Marker->getParent()->getParent() : nullptr;
342 return M ? M->getParent() : nullptr;
343}
344
345static const Module *getModuleFromDPI(const DbgRecord *DR) {
346 return DR->getMarker() ? getModuleFromDPI(Marker: DR->getMarker()) : nullptr;
347}
348
349static void printCallingConv(unsigned cc, raw_ostream &Out) {
350 switch (cc) {
351 default: Out << "cc" << cc; break;
352 case CallingConv::Fast: Out << "fastcc"; break;
353 case CallingConv::Cold: Out << "coldcc"; break;
354 case CallingConv::AnyReg: Out << "anyregcc"; break;
355 case CallingConv::PreserveMost: Out << "preserve_mostcc"; break;
356 case CallingConv::PreserveAll: Out << "preserve_allcc"; break;
357 case CallingConv::PreserveNone: Out << "preserve_nonecc"; break;
358 case CallingConv::CXX_FAST_TLS: Out << "cxx_fast_tlscc"; break;
359 case CallingConv::GHC: Out << "ghccc"; break;
360 case CallingConv::Tail: Out << "tailcc"; break;
361 case CallingConv::GRAAL: Out << "graalcc"; break;
362 case CallingConv::CFGuard_Check: Out << "cfguard_checkcc"; break;
363 case CallingConv::X86_StdCall: Out << "x86_stdcallcc"; break;
364 case CallingConv::X86_FastCall: Out << "x86_fastcallcc"; break;
365 case CallingConv::X86_ThisCall: Out << "x86_thiscallcc"; break;
366 case CallingConv::X86_RegCall: Out << "x86_regcallcc"; break;
367 case CallingConv::X86_VectorCall:Out << "x86_vectorcallcc"; break;
368 case CallingConv::Intel_OCL_BI: Out << "intel_ocl_bicc"; break;
369 case CallingConv::ARM_APCS: Out << "arm_apcscc"; break;
370 case CallingConv::ARM_AAPCS: Out << "arm_aapcscc"; break;
371 case CallingConv::ARM_AAPCS_VFP: Out << "arm_aapcs_vfpcc"; break;
372 case CallingConv::AArch64_VectorCall: Out << "aarch64_vector_pcs"; break;
373 case CallingConv::AArch64_SVE_VectorCall:
374 Out << "aarch64_sve_vector_pcs";
375 break;
376 case CallingConv::AArch64_SME_ABI_Support_Routines_PreserveMost_From_X0:
377 Out << "aarch64_sme_preservemost_from_x0";
378 break;
379 case CallingConv::AArch64_SME_ABI_Support_Routines_PreserveMost_From_X1:
380 Out << "aarch64_sme_preservemost_from_x1";
381 break;
382 case CallingConv::AArch64_SME_ABI_Support_Routines_PreserveMost_From_X2:
383 Out << "aarch64_sme_preservemost_from_x2";
384 break;
385 case CallingConv::MSP430_INTR: Out << "msp430_intrcc"; break;
386 case CallingConv::AVR_INTR: Out << "avr_intrcc "; break;
387 case CallingConv::AVR_SIGNAL: Out << "avr_signalcc "; break;
388 case CallingConv::PTX_Kernel: Out << "ptx_kernel"; break;
389 case CallingConv::PTX_Device: Out << "ptx_device"; break;
390 case CallingConv::X86_64_SysV: Out << "x86_64_sysvcc"; break;
391 case CallingConv::Win64: Out << "win64cc"; break;
392 case CallingConv::SPIR_FUNC: Out << "spir_func"; break;
393 case CallingConv::SPIR_KERNEL: Out << "spir_kernel"; break;
394 case CallingConv::Swift: Out << "swiftcc"; break;
395 case CallingConv::SwiftTail: Out << "swifttailcc"; break;
396 case CallingConv::X86_INTR: Out << "x86_intrcc"; break;
397 case CallingConv::DUMMY_HHVM:
398 Out << "hhvmcc";
399 break;
400 case CallingConv::DUMMY_HHVM_C:
401 Out << "hhvm_ccc";
402 break;
403 case CallingConv::AMDGPU_VS: Out << "amdgpu_vs"; break;
404 case CallingConv::AMDGPU_LS: Out << "amdgpu_ls"; break;
405 case CallingConv::AMDGPU_HS: Out << "amdgpu_hs"; break;
406 case CallingConv::AMDGPU_ES: Out << "amdgpu_es"; break;
407 case CallingConv::AMDGPU_GS: Out << "amdgpu_gs"; break;
408 case CallingConv::AMDGPU_PS: Out << "amdgpu_ps"; break;
409 case CallingConv::AMDGPU_CS: Out << "amdgpu_cs"; break;
410 case CallingConv::AMDGPU_CS_Chain:
411 Out << "amdgpu_cs_chain";
412 break;
413 case CallingConv::AMDGPU_CS_ChainPreserve:
414 Out << "amdgpu_cs_chain_preserve";
415 break;
416 case CallingConv::AMDGPU_KERNEL: Out << "amdgpu_kernel"; break;
417 case CallingConv::AMDGPU_Gfx: Out << "amdgpu_gfx"; break;
418 case CallingConv::AMDGPU_Gfx_WholeWave:
419 Out << "amdgpu_gfx_whole_wave";
420 break;
421 case CallingConv::M68k_RTD: Out << "m68k_rtdcc"; break;
422 case CallingConv::RISCV_VectorCall:
423 Out << "riscv_vector_cc";
424 break;
425#define CC_VLS_CASE(ABI_VLEN) \
426 case CallingConv::RISCV_VLSCall_##ABI_VLEN: \
427 Out << "riscv_vls_cc(" #ABI_VLEN ")"; \
428 break;
429 CC_VLS_CASE(32)
430 CC_VLS_CASE(64)
431 CC_VLS_CASE(128)
432 CC_VLS_CASE(256)
433 CC_VLS_CASE(512)
434 CC_VLS_CASE(1024)
435 CC_VLS_CASE(2048)
436 CC_VLS_CASE(4096)
437 CC_VLS_CASE(8192)
438 CC_VLS_CASE(16384)
439 CC_VLS_CASE(32768)
440 CC_VLS_CASE(65536)
441#undef CC_VLS_CASE
442 case CallingConv::CHERIoT_CompartmentCall:
443 Out << "cheriot_compartmentcallcc";
444 break;
445 case CallingConv::CHERIoT_CompartmentCallee:
446 Out << "cheriot_compartmentcalleecc";
447 break;
448 case CallingConv::CHERIoT_LibraryCall:
449 Out << "cheriot_librarycallcc";
450 break;
451 }
452}
453
454enum PrefixType {
455 GlobalPrefix,
456 ComdatPrefix,
457 LabelPrefix,
458 LocalPrefix,
459 NoPrefix
460};
461
462void llvm::printLLVMNameWithoutPrefix(raw_ostream &OS, StringRef Name) {
463 assert(!Name.empty() && "Cannot get empty name!");
464
465 // Scan the name to see if it needs quotes first.
466 bool NeedsQuotes = isdigit(static_cast<unsigned char>(Name[0]));
467 if (!NeedsQuotes) {
468 for (unsigned char C : Name) {
469 // By making this unsigned, the value passed in to isalnum will always be
470 // in the range 0-255. This is important when building with MSVC because
471 // its implementation will assert. This situation can arise when dealing
472 // with UTF-8 multibyte characters.
473 if (!isalnum(C) && C != '-' && C != '.' && C != '_') {
474 NeedsQuotes = true;
475 break;
476 }
477 }
478 }
479
480 // If we didn't need any quotes, just write out the name in one blast.
481 if (!NeedsQuotes) {
482 OS << Name;
483 return;
484 }
485
486 // Okay, we need quotes. Output the quotes and escape any scary characters as
487 // needed.
488 OS << '"';
489 printEscapedString(Name, Out&: OS);
490 OS << '"';
491}
492
493/// Turn the specified name into an 'LLVM name', which is either prefixed with %
494/// (if the string only contains simple characters) or is surrounded with ""'s
495/// (if it has special chars in it). Print it out.
496static void printLLVMName(raw_ostream &OS, StringRef Name, PrefixType Prefix) {
497 switch (Prefix) {
498 case NoPrefix:
499 break;
500 case GlobalPrefix:
501 OS << '@';
502 break;
503 case ComdatPrefix:
504 OS << '$';
505 break;
506 case LabelPrefix:
507 break;
508 case LocalPrefix:
509 OS << '%';
510 break;
511 }
512 printLLVMNameWithoutPrefix(OS, Name);
513}
514
515/// Turn the specified name into an 'LLVM name', which is either prefixed with %
516/// (if the string only contains simple characters) or is surrounded with ""'s
517/// (if it has special chars in it). Print it out.
518static void printLLVMName(raw_ostream &OS, const Value *V) {
519 printLLVMName(OS, Name: V->getName(),
520 Prefix: isa<GlobalValue>(Val: V) ? GlobalPrefix : LocalPrefix);
521}
522
523static void printShuffleMask(raw_ostream &Out, Type *Ty, ArrayRef<int> Mask) {
524 Out << ", <";
525 if (isa<ScalableVectorType>(Val: Ty))
526 Out << "vscale x ";
527 Out << Mask.size() << " x i32> ";
528 if (all_of(Range&: Mask, P: equal_to(Arg: 0))) {
529 Out << "zeroinitializer";
530 } else if (all_of(Range&: Mask, P: equal_to(Arg: PoisonMaskElem))) {
531 Out << "poison";
532 } else {
533 Out << "<";
534 ListSeparator LS;
535 for (int Elt : Mask) {
536 Out << LS << "i32 ";
537 if (Elt == PoisonMaskElem)
538 Out << "poison";
539 else
540 Out << Elt;
541 }
542 Out << ">";
543 }
544}
545
546namespace {
547
548class TypePrinting {
549public:
550 TypePrinting(const Module *M = nullptr)
551 : M(M), TypesIncorporated(M == nullptr) {}
552
553 TypePrinting(const TypePrinting &) = delete;
554 TypePrinting &operator=(const TypePrinting &) = delete;
555
556 /// The named types that are used by the current module.
557 TypeFinder &getNamedTypes();
558
559 /// The numbered types, number to type mapping.
560 std::vector<StructType *> &getNumberedTypes();
561
562 bool empty();
563
564 void print(Type *Ty, raw_ostream &OS);
565
566 void printStructBody(StructType *Ty, raw_ostream &OS);
567
568private:
569 void incorporateTypes();
570
571 /// A module to process lazily.
572 const Module *M;
573 bool TypesIncorporated;
574
575 TypeFinder NamedTypes;
576
577 // The numbered types, along with their value.
578 DenseMap<StructType *, unsigned> Type2Number;
579
580 std::vector<StructType *> NumberedTypes;
581};
582
583} // end anonymous namespace
584
585TypeFinder &TypePrinting::getNamedTypes() {
586 incorporateTypes();
587 return NamedTypes;
588}
589
590std::vector<StructType *> &TypePrinting::getNumberedTypes() {
591 incorporateTypes();
592
593 // We know all the numbers that each type is used and we know that it is a
594 // dense assignment. Convert the map to an index table, if it's not done
595 // already (judging from the sizes):
596 if (NumberedTypes.size() == Type2Number.size())
597 return NumberedTypes;
598
599 NumberedTypes.resize(new_size: Type2Number.size());
600 for (const auto &P : Type2Number) {
601 assert(P.second < NumberedTypes.size() && "Didn't get a dense numbering?");
602 assert(!NumberedTypes[P.second] && "Didn't get a unique numbering?");
603 NumberedTypes[P.second] = P.first;
604 }
605 return NumberedTypes;
606}
607
608bool TypePrinting::empty() {
609 incorporateTypes();
610 return NamedTypes.empty() && Type2Number.empty();
611}
612
613void TypePrinting::incorporateTypes() {
614 if (TypesIncorporated)
615 return;
616
617 NamedTypes.run(M: *M, onlyNamed: false);
618 TypesIncorporated = true;
619
620 // The list of struct types we got back includes all the struct types, split
621 // the unnamed ones out to a numbering and remove the anonymous structs.
622 unsigned NextNumber = 0;
623
624 std::vector<StructType *>::iterator NextToUse = NamedTypes.begin();
625 for (StructType *STy : NamedTypes) {
626 // Ignore anonymous types.
627 if (STy->isLiteral())
628 continue;
629
630 if (STy->getName().empty())
631 Type2Number[STy] = NextNumber++;
632 else
633 *NextToUse++ = STy;
634 }
635
636 NamedTypes.erase(I: NextToUse, E: NamedTypes.end());
637}
638
639static void printAddressSpace(const Module *M, unsigned AS, raw_ostream &OS,
640 StringRef Prefix = " ", StringRef Suffix = "",
641 bool ForcePrint = false) {
642 if (AS == 0 && !ForcePrint)
643 return;
644 OS << Prefix << "addrspace(";
645 StringRef ASName =
646 PrintAddrspaceName && M ? M->getDataLayout().getAddressSpaceName(AS) : "";
647 if (!ASName.empty())
648 OS << "\"" << ASName << "\"";
649 else
650 OS << AS;
651 OS << ")" << Suffix;
652}
653
654/// Write the specified type to the specified raw_ostream, making use of type
655/// names or up references to shorten the type name where possible.
656void TypePrinting::print(Type *Ty, raw_ostream &OS) {
657 switch (Ty->getTypeID()) {
658 case Type::VoidTyID: OS << "void"; return;
659 case Type::HalfTyID: OS << "half"; return;
660 case Type::BFloatTyID: OS << "bfloat"; return;
661 case Type::FloatTyID: OS << "float"; return;
662 case Type::DoubleTyID: OS << "double"; return;
663 case Type::X86_FP80TyID: OS << "x86_fp80"; return;
664 case Type::FP128TyID: OS << "fp128"; return;
665 case Type::PPC_FP128TyID: OS << "ppc_fp128"; return;
666 case Type::LabelTyID: OS << "label"; return;
667 case Type::MetadataTyID:
668 OS << "metadata";
669 return;
670 case Type::X86_AMXTyID: OS << "x86_amx"; return;
671 case Type::TokenTyID: OS << "token"; return;
672 case Type::ByteTyID:
673 OS << 'b' << Ty->getByteBitWidth();
674 return;
675 case Type::IntegerTyID:
676 OS << 'i' << cast<IntegerType>(Val: Ty)->getBitWidth();
677 return;
678
679 case Type::FunctionTyID: {
680 FunctionType *FTy = cast<FunctionType>(Val: Ty);
681 print(Ty: FTy->getReturnType(), OS);
682 OS << " (";
683 ListSeparator LS;
684 for (Type *Ty : FTy->params()) {
685 OS << LS;
686 print(Ty, OS);
687 }
688 if (FTy->isVarArg())
689 OS << LS << "...";
690 OS << ')';
691 return;
692 }
693 case Type::StructTyID: {
694 StructType *STy = cast<StructType>(Val: Ty);
695
696 if (STy->isLiteral())
697 return printStructBody(Ty: STy, OS);
698
699 if (!STy->getName().empty())
700 return printLLVMName(OS, Name: STy->getName(), Prefix: LocalPrefix);
701
702 incorporateTypes();
703 const auto I = Type2Number.find(Val: STy);
704 if (I != Type2Number.end())
705 OS << '%' << I->second;
706 else // Not enumerated, print the hex address.
707 OS << "%\"type " << STy << '\"';
708 return;
709 }
710 case Type::PointerTyID: {
711 PointerType *PTy = cast<PointerType>(Val: Ty);
712 OS << "ptr";
713 printAddressSpace(M, AS: PTy->getAddressSpace(), OS);
714 return;
715 }
716 case Type::ArrayTyID: {
717 ArrayType *ATy = cast<ArrayType>(Val: Ty);
718 OS << '[' << ATy->getNumElements() << " x ";
719 print(Ty: ATy->getElementType(), OS);
720 OS << ']';
721 return;
722 }
723 case Type::FixedVectorTyID:
724 case Type::ScalableVectorTyID: {
725 VectorType *PTy = cast<VectorType>(Val: Ty);
726 ElementCount EC = PTy->getElementCount();
727 OS << "<";
728 if (EC.isScalable())
729 OS << "vscale x ";
730 OS << EC.getKnownMinValue() << " x ";
731 print(Ty: PTy->getElementType(), OS);
732 OS << '>';
733 return;
734 }
735 case Type::TypedPointerTyID: {
736 TypedPointerType *TPTy = cast<TypedPointerType>(Val: Ty);
737 OS << "typedptr(" << *TPTy->getElementType() << ", "
738 << TPTy->getAddressSpace() << ")";
739 return;
740 }
741 case Type::TargetExtTyID:
742 TargetExtType *TETy = cast<TargetExtType>(Val: Ty);
743 OS << "target(\"";
744 printEscapedString(Name: Ty->getTargetExtName(), Out&: OS);
745 OS << "\"";
746 for (Type *Inner : TETy->type_params()) {
747 OS << ", ";
748 Inner->print(O&: OS, /*IsForDebug=*/false, /*NoDetails=*/true);
749 }
750 for (unsigned IntParam : TETy->int_params())
751 OS << ", " << IntParam;
752 OS << ")";
753 return;
754 }
755 llvm_unreachable("Invalid TypeID");
756}
757
758void TypePrinting::printStructBody(StructType *STy, raw_ostream &OS) {
759 if (STy->isOpaque()) {
760 OS << "opaque";
761 return;
762 }
763
764 if (STy->isPacked())
765 OS << '<';
766
767 if (STy->getNumElements() == 0) {
768 OS << "{}";
769 } else {
770 OS << "{ ";
771 ListSeparator LS;
772 for (Type *Ty : STy->elements()) {
773 OS << LS;
774 print(Ty, OS);
775 }
776
777 OS << " }";
778 }
779 if (STy->isPacked())
780 OS << '>';
781}
782
783AbstractSlotTrackerStorage::~AbstractSlotTrackerStorage() = default;
784
785//===----------------------------------------------------------------------===//
786// SlotTracker Class: Enumerate slot numbers for unnamed values
787//===----------------------------------------------------------------------===//
788/// This class provides computation of slot numbers for LLVM Assembly writing.
789///
790class llvm::SlotTracker : public AbstractSlotTrackerStorage {
791public:
792 /// ValueMap - A mapping of Values to slot numbers.
793 using ValueMap = DenseMap<const Value *, unsigned>;
794
795private:
796 /// TheModule - The module for which we are holding slot numbers.
797 const Module* TheModule;
798
799 /// TheFunction - The function for which we are holding slot numbers.
800 const Function* TheFunction = nullptr;
801 bool FunctionProcessed = false;
802 bool ShouldInitializeAllMetadata;
803
804 std::function<void(AbstractSlotTrackerStorage *, const Module *, bool)>
805 ProcessModuleHookFn;
806 std::function<void(AbstractSlotTrackerStorage *, const Function *, bool)>
807 ProcessFunctionHookFn;
808
809 /// The summary index for which we are holding slot numbers.
810 const ModuleSummaryIndex *TheIndex = nullptr;
811
812 /// mMap - The slot map for the module level data.
813 ValueMap mMap;
814 unsigned mNext = 0;
815
816 /// fMap - The slot map for the function level data.
817 ValueMap fMap;
818 unsigned fNext = 0;
819
820 /// mdnMap - Map for MDNodes.
821 DenseMap<const MDNode*, unsigned> mdnMap;
822 unsigned mdnNext = 0;
823
824 /// asMap - The slot map for attribute sets.
825 DenseMap<AttributeSet, unsigned> asMap;
826 unsigned asNext = 0;
827
828 /// ModulePathMap - The slot map for Module paths used in the summary index.
829 StringMap<unsigned> ModulePathMap;
830 unsigned ModulePathNext = 0;
831
832 /// GUIDMap - The slot map for GUIDs used in the summary index.
833 DenseMap<GlobalValue::GUID, unsigned> GUIDMap;
834 unsigned GUIDNext = 0;
835
836 /// TypeIdMap - The slot map for type ids used in the summary index.
837 StringMap<unsigned> TypeIdMap;
838 unsigned TypeIdNext = 0;
839
840 /// TypeIdCompatibleVtableMap - The slot map for type compatible vtable ids
841 /// used in the summary index.
842 StringMap<unsigned> TypeIdCompatibleVtableMap;
843 unsigned TypeIdCompatibleVtableNext = 0;
844
845public:
846 /// Construct from a module.
847 ///
848 /// If \c ShouldInitializeAllMetadata, initializes all metadata in all
849 /// functions, giving correct numbering for metadata referenced only from
850 /// within a function (even if no functions have been initialized).
851 explicit SlotTracker(const Module *M,
852 bool ShouldInitializeAllMetadata = false);
853
854 /// Construct from a function, starting out in incorp state.
855 ///
856 /// If \c ShouldInitializeAllMetadata, initializes all metadata in all
857 /// functions, giving correct numbering for metadata referenced only from
858 /// within a function (even if no functions have been initialized).
859 explicit SlotTracker(const Function *F,
860 bool ShouldInitializeAllMetadata = false);
861
862 /// Construct from a module summary index.
863 explicit SlotTracker(const ModuleSummaryIndex *Index);
864
865 SlotTracker(const SlotTracker &) = delete;
866 SlotTracker &operator=(const SlotTracker &) = delete;
867
868 ~SlotTracker() override = default;
869
870 void setProcessHook(
871 std::function<void(AbstractSlotTrackerStorage *, const Module *, bool)>);
872 void setProcessHook(std::function<void(AbstractSlotTrackerStorage *,
873 const Function *, bool)>);
874
875 unsigned getNextMetadataSlot() override { return mdnNext; }
876
877 void createMetadataSlot(const MDNode *N) override;
878
879 /// Return the slot number of the specified value in it's type
880 /// plane. If something is not in the SlotTracker, return -1.
881 int getLocalSlot(const Value *V);
882 int getGlobalSlot(const GlobalValue *V);
883 int getMetadataSlot(const MDNode *N) override;
884 int getAttributeGroupSlot(AttributeSet AS);
885 int getModulePathSlot(StringRef Path);
886 int getGUIDSlot(GlobalValue::GUID GUID);
887 int getTypeIdSlot(StringRef Id);
888 int getTypeIdCompatibleVtableSlot(StringRef Id);
889
890 /// If you'd like to deal with a function instead of just a module, use
891 /// this method to get its data into the SlotTracker.
892 void incorporateFunction(const Function *F) {
893 TheFunction = F;
894 FunctionProcessed = false;
895 }
896
897 const Function *getFunction() const { return TheFunction; }
898
899 /// After calling incorporateFunction, use this method to remove the
900 /// most recently incorporated function from the SlotTracker. This
901 /// will reset the state of the machine back to just the module contents.
902 void purgeFunction();
903
904 /// MDNode map iterators.
905 using mdn_iterator = DenseMap<const MDNode*, unsigned>::iterator;
906
907 mdn_iterator mdn_begin() { return mdnMap.begin(); }
908 mdn_iterator mdn_end() { return mdnMap.end(); }
909 unsigned mdn_size() const { return mdnMap.size(); }
910 bool mdn_empty() const { return mdnMap.empty(); }
911
912 /// AttributeSet map iterators.
913 using as_iterator = DenseMap<AttributeSet, unsigned>::iterator;
914
915 as_iterator as_begin() { return asMap.begin(); }
916 as_iterator as_end() { return asMap.end(); }
917 unsigned as_size() const { return asMap.size(); }
918 bool as_empty() const { return asMap.empty(); }
919
920 /// GUID map iterators.
921 using guid_iterator = DenseMap<GlobalValue::GUID, unsigned>::iterator;
922
923 /// These functions do the actual initialization.
924 inline void initializeIfNeeded();
925 int initializeIndexIfNeeded();
926
927 // Implementation Details
928private:
929 /// CreateModuleSlot - Insert the specified GlobalValue* into the slot table.
930 void CreateModuleSlot(const GlobalValue *V);
931
932 /// CreateMetadataSlot - Insert the specified MDNode* into the slot table.
933 void CreateMetadataSlot(const MDNode *N);
934
935 /// CreateFunctionSlot - Insert the specified Value* into the slot table.
936 void CreateFunctionSlot(const Value *V);
937
938 /// Insert the specified AttributeSet into the slot table.
939 void CreateAttributeSetSlot(AttributeSet AS);
940
941 inline void CreateModulePathSlot(StringRef Path);
942 void CreateGUIDSlot(GlobalValue::GUID GUID);
943 void CreateTypeIdSlot(StringRef Id);
944 void CreateTypeIdCompatibleVtableSlot(StringRef Id);
945
946 /// Add all of the module level global variables (and their initializers)
947 /// and function declarations, but not the contents of those functions.
948 void processModule();
949 // Returns number of allocated slots
950 int processIndex();
951
952 /// Add all of the functions arguments, basic blocks, and instructions.
953 void processFunction();
954
955 /// Add the metadata directly attached to a GlobalObject.
956 void processGlobalObjectMetadata(const GlobalObject &GO);
957
958 /// Add all of the metadata from a function.
959 void processFunctionMetadata(const Function &F);
960
961 /// Add all of the metadata from an instruction.
962 void processInstructionMetadata(const Instruction &I);
963
964 /// Add all of the metadata from a DbgRecord.
965 void processDbgRecordMetadata(const DbgRecord &DVR);
966};
967
968ModuleSlotTracker::ModuleSlotTracker(SlotTracker &Machine, const Module *M,
969 const Function *F)
970 : M(M), F(F), Machine(&Machine) {}
971
972ModuleSlotTracker::ModuleSlotTracker(const Module *M,
973 bool ShouldInitializeAllMetadata)
974 : ShouldCreateStorage(M),
975 ShouldInitializeAllMetadata(ShouldInitializeAllMetadata), M(M) {}
976
977ModuleSlotTracker::~ModuleSlotTracker() = default;
978
979SlotTracker *ModuleSlotTracker::getMachine() {
980 if (!ShouldCreateStorage)
981 return Machine;
982
983 ShouldCreateStorage = false;
984 MachineStorage =
985 std::make_unique<SlotTracker>(args&: M, args&: ShouldInitializeAllMetadata);
986 Machine = MachineStorage.get();
987 if (ProcessModuleHookFn)
988 Machine->setProcessHook(ProcessModuleHookFn);
989 if (ProcessFunctionHookFn)
990 Machine->setProcessHook(ProcessFunctionHookFn);
991 return Machine;
992}
993
994void ModuleSlotTracker::incorporateFunction(const Function &F) {
995 // Using getMachine() may lazily create the slot tracker.
996 if (!getMachine())
997 return;
998
999 // Nothing to do if this is the right function already.
1000 if (this->F == &F)
1001 return;
1002 if (this->F)
1003 Machine->purgeFunction();
1004 Machine->incorporateFunction(F: &F);
1005 this->F = &F;
1006}
1007
1008int ModuleSlotTracker::getLocalSlot(const Value *V) {
1009 assert(F && "No function incorporated");
1010 return Machine->getLocalSlot(V);
1011}
1012
1013void ModuleSlotTracker::setProcessHook(
1014 std::function<void(AbstractSlotTrackerStorage *, const Module *, bool)>
1015 Fn) {
1016 ProcessModuleHookFn = std::move(Fn);
1017}
1018
1019void ModuleSlotTracker::setProcessHook(
1020 std::function<void(AbstractSlotTrackerStorage *, const Function *, bool)>
1021 Fn) {
1022 ProcessFunctionHookFn = std::move(Fn);
1023}
1024
1025static SlotTracker *createSlotTracker(const Value *V) {
1026 if (const auto *FA = dyn_cast<Argument>(Val: V))
1027 return new SlotTracker(FA->getParent());
1028
1029 if (const auto *I = dyn_cast<Instruction>(Val: V))
1030 if (I->getParent())
1031 return new SlotTracker(I->getParent()->getParent());
1032
1033 if (const auto *BB = dyn_cast<BasicBlock>(Val: V))
1034 return new SlotTracker(BB->getParent());
1035
1036 if (const auto *GV = dyn_cast<GlobalVariable>(Val: V))
1037 return new SlotTracker(GV->getParent());
1038
1039 if (const auto *GA = dyn_cast<GlobalAlias>(Val: V))
1040 return new SlotTracker(GA->getParent());
1041
1042 if (const auto *GIF = dyn_cast<GlobalIFunc>(Val: V))
1043 return new SlotTracker(GIF->getParent());
1044
1045 if (const auto *Func = dyn_cast<Function>(Val: V))
1046 return new SlotTracker(Func);
1047
1048 return nullptr;
1049}
1050
1051#if 0
1052#define ST_DEBUG(X) dbgs() << X
1053#else
1054#define ST_DEBUG(X)
1055#endif
1056
1057// Module level constructor. Causes the contents of the Module (sans functions)
1058// to be added to the slot table.
1059SlotTracker::SlotTracker(const Module *M, bool ShouldInitializeAllMetadata)
1060 : TheModule(M), ShouldInitializeAllMetadata(ShouldInitializeAllMetadata) {}
1061
1062// Function level constructor. Causes the contents of the Module and the one
1063// function provided to be added to the slot table.
1064SlotTracker::SlotTracker(const Function *F, bool ShouldInitializeAllMetadata)
1065 : TheModule(F ? F->getParent() : nullptr), TheFunction(F),
1066 ShouldInitializeAllMetadata(ShouldInitializeAllMetadata) {}
1067
1068SlotTracker::SlotTracker(const ModuleSummaryIndex *Index)
1069 : TheModule(nullptr), ShouldInitializeAllMetadata(false), TheIndex(Index) {}
1070
1071inline void SlotTracker::initializeIfNeeded() {
1072 if (TheModule) {
1073 processModule();
1074 TheModule = nullptr; ///< Prevent re-processing next time we're called.
1075 }
1076
1077 if (TheFunction && !FunctionProcessed)
1078 processFunction();
1079}
1080
1081int SlotTracker::initializeIndexIfNeeded() {
1082 if (!TheIndex)
1083 return 0;
1084 int NumSlots = processIndex();
1085 TheIndex = nullptr; ///< Prevent re-processing next time we're called.
1086 return NumSlots;
1087}
1088
1089// Iterate through all the global variables, functions, and global
1090// variable initializers and create slots for them.
1091void SlotTracker::processModule() {
1092 ST_DEBUG("begin processModule!\n");
1093
1094 // Add all of the unnamed global variables to the value table.
1095 for (const GlobalVariable &Var : TheModule->globals()) {
1096 if (!Var.hasName())
1097 CreateModuleSlot(V: &Var);
1098 processGlobalObjectMetadata(GO: Var);
1099 auto Attrs = Var.getAttributes();
1100 if (Attrs.hasAttributes())
1101 CreateAttributeSetSlot(AS: Attrs);
1102 }
1103
1104 for (const GlobalAlias &A : TheModule->aliases()) {
1105 if (!A.hasName())
1106 CreateModuleSlot(V: &A);
1107 }
1108
1109 for (const GlobalIFunc &I : TheModule->ifuncs()) {
1110 if (!I.hasName())
1111 CreateModuleSlot(V: &I);
1112 processGlobalObjectMetadata(GO: I);
1113 }
1114
1115 // Add metadata used by named metadata.
1116 for (const NamedMDNode &NMD : TheModule->named_metadata()) {
1117 for (const MDNode *N : NMD.operands())
1118 CreateMetadataSlot(N);
1119 }
1120
1121 for (const Function &F : *TheModule) {
1122 if (!F.hasName())
1123 // Add all the unnamed functions to the table.
1124 CreateModuleSlot(V: &F);
1125
1126 if (ShouldInitializeAllMetadata)
1127 processFunctionMetadata(F);
1128
1129 // Add all the function attributes to the table.
1130 // FIXME: Add attributes of other objects?
1131 AttributeSet FnAttrs = F.getAttributes().getFnAttrs();
1132 if (FnAttrs.hasAttributes())
1133 CreateAttributeSetSlot(AS: FnAttrs);
1134 }
1135
1136 if (ProcessModuleHookFn)
1137 ProcessModuleHookFn(this, TheModule, ShouldInitializeAllMetadata);
1138
1139 ST_DEBUG("end processModule!\n");
1140}
1141
1142// Process the arguments, basic blocks, and instructions of a function.
1143void SlotTracker::processFunction() {
1144 ST_DEBUG("begin processFunction!\n");
1145 fNext = 0;
1146
1147 // Process function metadata if it wasn't hit at the module-level.
1148 if (!ShouldInitializeAllMetadata)
1149 processFunctionMetadata(F: *TheFunction);
1150
1151 // Add all the function arguments with no names.
1152 for(Function::const_arg_iterator AI = TheFunction->arg_begin(),
1153 AE = TheFunction->arg_end(); AI != AE; ++AI)
1154 if (!AI->hasName())
1155 CreateFunctionSlot(V: &*AI);
1156
1157 ST_DEBUG("Inserting Instructions:\n");
1158
1159 // Add all of the basic blocks and instructions with no names.
1160 for (auto &BB : *TheFunction) {
1161 if (!BB.hasName())
1162 CreateFunctionSlot(V: &BB);
1163
1164 for (auto &I : BB) {
1165 if (!I.getType()->isVoidTy() && !I.hasName())
1166 CreateFunctionSlot(V: &I);
1167
1168 // We allow direct calls to any llvm.foo function here, because the
1169 // target may not be linked into the optimizer.
1170 if (const auto *Call = dyn_cast<CallBase>(Val: &I)) {
1171 // Add all the call attributes to the table.
1172 AttributeSet Attrs = Call->getAttributes().getFnAttrs();
1173 if (Attrs.hasAttributes())
1174 CreateAttributeSetSlot(AS: Attrs);
1175 }
1176 }
1177 }
1178
1179 if (ProcessFunctionHookFn)
1180 ProcessFunctionHookFn(this, TheFunction, ShouldInitializeAllMetadata);
1181
1182 FunctionProcessed = true;
1183
1184 ST_DEBUG("end processFunction!\n");
1185}
1186
1187// Iterate through all the GUID in the index and create slots for them.
1188int SlotTracker::processIndex() {
1189 ST_DEBUG("begin processIndex!\n");
1190 assert(TheIndex);
1191
1192 // The first block of slots are just the module ids, which start at 0 and are
1193 // assigned consecutively. Since the StringMap iteration order isn't
1194 // guaranteed, order by path string before assigning slots.
1195 std::vector<StringRef> ModulePaths;
1196 for (auto &[ModPath, _] : TheIndex->modulePaths())
1197 ModulePaths.push_back(x: ModPath);
1198 llvm::sort(C&: ModulePaths);
1199 for (auto &ModPath : ModulePaths)
1200 CreateModulePathSlot(Path: ModPath);
1201
1202 // Start numbering the GUIDs after the module ids.
1203 GUIDNext = ModulePathNext;
1204
1205 for (auto &GlobalList : *TheIndex)
1206 CreateGUIDSlot(GUID: GlobalList.first);
1207
1208 // Start numbering the TypeIdCompatibleVtables after the GUIDs.
1209 TypeIdCompatibleVtableNext = GUIDNext;
1210 for (auto &TId : TheIndex->typeIdCompatibleVtableMap())
1211 CreateTypeIdCompatibleVtableSlot(Id: TId.first);
1212
1213 // Start numbering the TypeIds after the TypeIdCompatibleVtables.
1214 TypeIdNext = TypeIdCompatibleVtableNext;
1215 for (const auto &TID : TheIndex->typeIds())
1216 CreateTypeIdSlot(Id: TID.second.first);
1217
1218 ST_DEBUG("end processIndex!\n");
1219 return TypeIdNext;
1220}
1221
1222void SlotTracker::processGlobalObjectMetadata(const GlobalObject &GO) {
1223 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
1224 GO.getAllMetadata(MDs);
1225 for (auto &MD : MDs)
1226 CreateMetadataSlot(N: MD.second);
1227}
1228
1229void SlotTracker::processFunctionMetadata(const Function &F) {
1230 processGlobalObjectMetadata(GO: F);
1231 for (auto &BB : F) {
1232 for (auto &I : BB) {
1233 for (const DbgRecord &DR : I.getDbgRecordRange())
1234 processDbgRecordMetadata(DVR: DR);
1235 processInstructionMetadata(I);
1236 }
1237 }
1238}
1239
1240void SlotTracker::processDbgRecordMetadata(const DbgRecord &DR) {
1241 // Tolerate null metadata pointers: it's a completely illegal debug record,
1242 // but we can have faulty metadata from debug-intrinsic days being
1243 // autoupgraded into debug records. This gets caught by the verifier, which
1244 // then will print the faulty IR, hitting this code path.
1245 if (const auto *DVR = dyn_cast<const DbgVariableRecord>(Val: &DR)) {
1246 // Process metadata used by DbgRecords; we only specifically care about the
1247 // DILocalVariable, DILocation, and DIAssignID fields, as the Value and
1248 // Expression fields should only be printed inline and so do not use a slot.
1249 // Note: The above doesn't apply for empty-metadata operands.
1250 if (auto *Empty = dyn_cast_if_present<MDNode>(Val: DVR->getRawLocation()))
1251 CreateMetadataSlot(N: Empty);
1252 if (DVR->getRawVariable())
1253 CreateMetadataSlot(N: DVR->getRawVariable());
1254 if (DVR->isDbgAssign()) {
1255 if (auto *AssignID = DVR->getRawAssignID())
1256 CreateMetadataSlot(N: cast<MDNode>(Val: AssignID));
1257 if (auto *Empty = dyn_cast_if_present<MDNode>(Val: DVR->getRawAddress()))
1258 CreateMetadataSlot(N: Empty);
1259 }
1260 } else if (const auto *DLR = dyn_cast<const DbgLabelRecord>(Val: &DR)) {
1261 CreateMetadataSlot(N: DLR->getRawLabel());
1262 } else {
1263 llvm_unreachable("unsupported DbgRecord kind");
1264 }
1265 if (DR.getDebugLoc())
1266 CreateMetadataSlot(N: DR.getDebugLoc().getAsMDNode());
1267}
1268
1269void SlotTracker::processInstructionMetadata(const Instruction &I) {
1270 // Process metadata used directly by intrinsics.
1271 if (const auto *CI = dyn_cast<CallInst>(Val: &I))
1272 if (Function *F = CI->getCalledFunction())
1273 if (F->isIntrinsic())
1274 for (auto &Op : I.operands())
1275 if (auto *V = dyn_cast_or_null<MetadataAsValue>(Val: Op))
1276 if (auto *N = dyn_cast<MDNode>(Val: V->getMetadata()))
1277 CreateMetadataSlot(N);
1278
1279 // Process metadata attached to this instruction.
1280 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
1281 I.getAllMetadata(MDs);
1282 for (auto &MD : MDs)
1283 CreateMetadataSlot(N: MD.second);
1284}
1285
1286/// Clean up after incorporating a function. This is the only way to get out of
1287/// the function incorporation state that affects get*Slot/Create*Slot. Function
1288/// incorporation state is indicated by TheFunction != 0.
1289void SlotTracker::purgeFunction() {
1290 ST_DEBUG("begin purgeFunction!\n");
1291 fMap.clear(); // Simply discard the function level map
1292 TheFunction = nullptr;
1293 FunctionProcessed = false;
1294 ST_DEBUG("end purgeFunction!\n");
1295}
1296
1297/// getGlobalSlot - Get the slot number of a global value.
1298int SlotTracker::getGlobalSlot(const GlobalValue *V) {
1299 // Check for uninitialized state and do lazy initialization.
1300 initializeIfNeeded();
1301
1302 // Find the value in the module map
1303 ValueMap::iterator MI = mMap.find(Val: V);
1304 return MI == mMap.end() ? -1 : (int)MI->second;
1305}
1306
1307void SlotTracker::setProcessHook(
1308 std::function<void(AbstractSlotTrackerStorage *, const Module *, bool)>
1309 Fn) {
1310 ProcessModuleHookFn = std::move(Fn);
1311}
1312
1313void SlotTracker::setProcessHook(
1314 std::function<void(AbstractSlotTrackerStorage *, const Function *, bool)>
1315 Fn) {
1316 ProcessFunctionHookFn = std::move(Fn);
1317}
1318
1319/// getMetadataSlot - Get the slot number of a MDNode.
1320void SlotTracker::createMetadataSlot(const MDNode *N) { CreateMetadataSlot(N); }
1321
1322/// getMetadataSlot - Get the slot number of a MDNode.
1323int SlotTracker::getMetadataSlot(const MDNode *N) {
1324 // Check for uninitialized state and do lazy initialization.
1325 initializeIfNeeded();
1326
1327 // Find the MDNode in the module map
1328 mdn_iterator MI = mdnMap.find(Val: N);
1329 return MI == mdnMap.end() ? -1 : (int)MI->second;
1330}
1331
1332/// getLocalSlot - Get the slot number for a value that is local to a function.
1333int SlotTracker::getLocalSlot(const Value *V) {
1334 assert(!isa<Constant>(V) && "Can't get a constant or global slot with this!");
1335
1336 // Check for uninitialized state and do lazy initialization.
1337 initializeIfNeeded();
1338
1339 ValueMap::iterator FI = fMap.find(Val: V);
1340 return FI == fMap.end() ? -1 : (int)FI->second;
1341}
1342
1343int SlotTracker::getAttributeGroupSlot(AttributeSet AS) {
1344 // Check for uninitialized state and do lazy initialization.
1345 initializeIfNeeded();
1346
1347 // Find the AttributeSet in the module map.
1348 as_iterator AI = asMap.find(Val: AS);
1349 return AI == asMap.end() ? -1 : (int)AI->second;
1350}
1351
1352int SlotTracker::getModulePathSlot(StringRef Path) {
1353 // Check for uninitialized state and do lazy initialization.
1354 initializeIndexIfNeeded();
1355
1356 // Find the Module path in the map
1357 auto I = ModulePathMap.find(Key: Path);
1358 return I == ModulePathMap.end() ? -1 : (int)I->second;
1359}
1360
1361int SlotTracker::getGUIDSlot(GlobalValue::GUID GUID) {
1362 // Check for uninitialized state and do lazy initialization.
1363 initializeIndexIfNeeded();
1364
1365 // Find the GUID in the map
1366 guid_iterator I = GUIDMap.find(Val: GUID);
1367 return I == GUIDMap.end() ? -1 : (int)I->second;
1368}
1369
1370int SlotTracker::getTypeIdSlot(StringRef Id) {
1371 // Check for uninitialized state and do lazy initialization.
1372 initializeIndexIfNeeded();
1373
1374 // Find the TypeId string in the map
1375 auto I = TypeIdMap.find(Key: Id);
1376 return I == TypeIdMap.end() ? -1 : (int)I->second;
1377}
1378
1379int SlotTracker::getTypeIdCompatibleVtableSlot(StringRef Id) {
1380 // Check for uninitialized state and do lazy initialization.
1381 initializeIndexIfNeeded();
1382
1383 // Find the TypeIdCompatibleVtable string in the map
1384 auto I = TypeIdCompatibleVtableMap.find(Key: Id);
1385 return I == TypeIdCompatibleVtableMap.end() ? -1 : (int)I->second;
1386}
1387
1388/// CreateModuleSlot - Insert the specified GlobalValue* into the slot table.
1389void SlotTracker::CreateModuleSlot(const GlobalValue *V) {
1390 assert(V && "Can't insert a null Value into SlotTracker!");
1391 assert(!V->getType()->isVoidTy() && "Doesn't need a slot!");
1392 assert(!V->hasName() && "Doesn't need a slot!");
1393
1394 unsigned DestSlot = mNext++;
1395 mMap[V] = DestSlot;
1396
1397 ST_DEBUG(" Inserting value [" << V->getType() << "] = " << V << " slot=" <<
1398 DestSlot << " [");
1399 // G = Global, F = Function, A = Alias, I = IFunc, o = other
1400 ST_DEBUG((isa<GlobalVariable>(V) ? 'G' :
1401 (isa<Function>(V) ? 'F' :
1402 (isa<GlobalAlias>(V) ? 'A' :
1403 (isa<GlobalIFunc>(V) ? 'I' : 'o')))) << "]\n");
1404}
1405
1406/// CreateSlot - Create a new slot for the specified value if it has no name.
1407void SlotTracker::CreateFunctionSlot(const Value *V) {
1408 assert(!V->getType()->isVoidTy() && !V->hasName() && "Doesn't need a slot!");
1409
1410 unsigned DestSlot = fNext++;
1411 fMap[V] = DestSlot;
1412
1413 // G = Global, F = Function, o = other
1414 ST_DEBUG(" Inserting value [" << V->getType() << "] = " << V << " slot=" <<
1415 DestSlot << " [o]\n");
1416}
1417
1418/// CreateModuleSlot - Insert the specified MDNode* into the slot table.
1419void SlotTracker::CreateMetadataSlot(const MDNode *N) {
1420 assert(N && "Can't insert a null Value into SlotTracker!");
1421
1422 // Don't make slots for DIExpressions. We just print them inline everywhere.
1423 if (isa<DIExpression>(Val: N))
1424 return;
1425
1426 unsigned DestSlot = mdnNext;
1427 if (!mdnMap.insert(KV: std::make_pair(x&: N, y&: DestSlot)).second)
1428 return;
1429 ++mdnNext;
1430
1431 // Recursively add any MDNodes referenced by operands.
1432 for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i)
1433 if (const auto *Op = dyn_cast_or_null<MDNode>(Val: N->getOperand(I: i)))
1434 CreateMetadataSlot(N: Op);
1435}
1436
1437void SlotTracker::CreateAttributeSetSlot(AttributeSet AS) {
1438 assert(AS.hasAttributes() && "Doesn't need a slot!");
1439
1440 if (asMap.try_emplace(Key: AS, Args&: asNext).second)
1441 ++asNext;
1442}
1443
1444/// Create a new slot for the specified Module
1445void SlotTracker::CreateModulePathSlot(StringRef Path) {
1446 ModulePathMap[Path] = ModulePathNext++;
1447}
1448
1449/// Create a new slot for the specified GUID
1450void SlotTracker::CreateGUIDSlot(GlobalValue::GUID GUID) {
1451 GUIDMap[GUID] = GUIDNext++;
1452}
1453
1454/// Create a new slot for the specified Id
1455void SlotTracker::CreateTypeIdSlot(StringRef Id) {
1456 TypeIdMap[Id] = TypeIdNext++;
1457}
1458
1459/// Create a new slot for the specified Id
1460void SlotTracker::CreateTypeIdCompatibleVtableSlot(StringRef Id) {
1461 TypeIdCompatibleVtableMap[Id] = TypeIdCompatibleVtableNext++;
1462}
1463
1464namespace {
1465/// Common instances used by most of the printer functions.
1466struct AsmWriterContext {
1467 TypePrinting *TypePrinter = nullptr;
1468 SlotTracker *Machine = nullptr;
1469 const Module *Context = nullptr;
1470
1471 AsmWriterContext(TypePrinting *TP, SlotTracker *ST, const Module *M = nullptr)
1472 : TypePrinter(TP), Machine(ST), Context(M) {}
1473
1474 static AsmWriterContext &getEmpty() {
1475 static AsmWriterContext EmptyCtx(nullptr, nullptr);
1476 return EmptyCtx;
1477 }
1478
1479 /// A callback that will be triggered when the underlying printer
1480 /// prints a Metadata as operand.
1481 virtual void onWriteMetadataAsOperand(const Metadata *) {}
1482
1483 virtual ~AsmWriterContext() = default;
1484};
1485} // end anonymous namespace
1486
1487//===----------------------------------------------------------------------===//
1488// AsmWriter Implementation
1489//===----------------------------------------------------------------------===//
1490
1491static void writeAsOperandInternal(raw_ostream &Out, const Value *V,
1492 AsmWriterContext &WriterCtx,
1493 bool PrintType = false);
1494
1495static void writeAsOperandInternal(raw_ostream &Out, const Metadata *MD,
1496 AsmWriterContext &WriterCtx,
1497 bool FromValue = false);
1498
1499static void writeOptimizationInfo(raw_ostream &Out, const User *U) {
1500 if (const auto *FPO = dyn_cast<const FPMathOperator>(Val: U))
1501 Out << FPO->getFastMathFlags();
1502
1503 if (const auto *OBO = dyn_cast<OverflowingBinaryOperator>(Val: U)) {
1504 if (OBO->hasNoUnsignedWrap())
1505 Out << " nuw";
1506 if (OBO->hasNoSignedWrap())
1507 Out << " nsw";
1508 } else if (const auto *Div = dyn_cast<PossiblyExactOperator>(Val: U)) {
1509 if (Div->isExact())
1510 Out << " exact";
1511 } else if (const auto *PDI = dyn_cast<PossiblyDisjointInst>(Val: U)) {
1512 if (PDI->isDisjoint())
1513 Out << " disjoint";
1514 } else if (const auto *GEP = dyn_cast<GEPOperator>(Val: U)) {
1515 if (GEP->isInBounds())
1516 Out << " inbounds";
1517 else if (GEP->hasNoUnsignedSignedWrap())
1518 Out << " nusw";
1519 if (GEP->hasNoUnsignedWrap())
1520 Out << " nuw";
1521 if (auto InRange = GEP->getInRange()) {
1522 Out << " inrange(" << InRange->getLower() << ", " << InRange->getUpper()
1523 << ")";
1524 }
1525 } else if (const auto *NNI = dyn_cast<PossiblyNonNegInst>(Val: U)) {
1526 if (NNI->hasNonNeg())
1527 Out << " nneg";
1528 } else if (const auto *TI = dyn_cast<TruncInst>(Val: U)) {
1529 if (TI->hasNoUnsignedWrap())
1530 Out << " nuw";
1531 if (TI->hasNoSignedWrap())
1532 Out << " nsw";
1533 } else if (const auto *ICmp = dyn_cast<ICmpInst>(Val: U)) {
1534 if (ICmp->hasSameSign())
1535 Out << " samesign";
1536 }
1537}
1538
1539static void WriteFullHexAPInt(raw_ostream &Out, const APInt &Val) {
1540 SmallVector<char, 32> Bits;
1541 Val.toStringUnsigned(Str&: Bits, Radix: 16);
1542 unsigned NumDigits = std::max(a: (Val.getBitWidth() + 3) / 4, b: 1U);
1543 Out << "0x";
1544 for (unsigned i = 0; i < NumDigits - Bits.size(); i++)
1545 Out << '0';
1546 Out << Bits;
1547}
1548
1549static void writeAPFloatInternal(raw_ostream &Out, const APFloat &APF) {
1550 bool ForceBitwiseOutput = false;
1551 if (&APF.getSemantics() == &APFloat::PPCDoubleDouble()) {
1552 // ppc_fp128 types are double-double. The special cases set the second
1553 // (high) double to +0.0, so if the high word is nonzero, force the use of
1554 // bitwise output.
1555 APInt HiWord = APF.bitcastToAPInt().lshr(shiftAmt: 64);
1556 ForceBitwiseOutput = !HiWord.isZero();
1557 }
1558
1559 if (!ForceBitwiseOutput) {
1560 // Check for special values in APFloat.
1561 if (APF.isInfinity()) {
1562 Out << (APF.isNegative() ? '-' : '+') << "inf";
1563 return;
1564 }
1565
1566 if (APF.isNaN()) {
1567 Out << (APF.isNegative() ? '-' : '+');
1568 APInt Payload = APF.getNaNPayload();
1569 // The quiet bit of a NaN is the highest bit of the payload, so the
1570 // preferred QNaN value happens to be the sign mask value.
1571 if (Payload.isSignMask()) {
1572 Out << "qnan";
1573 } else {
1574 if (APF.isSignaling())
1575 Out << 's';
1576 Out << "nan(";
1577 // Clear out the signaling/quiet bit of the payload for output.
1578 Payload.clearBit(BitPosition: Payload.getBitWidth() - 1);
1579 // Trim the string to exclude leading 0's.
1580 WriteFullHexAPInt(Out, Val: Payload.trunc(width: Payload.getActiveBits()));
1581 Out << ')';
1582 }
1583 return;
1584 }
1585 }
1586
1587 // Try for a decimal string output. If the value is convertible back to the
1588 // same APFloat value, then we know that it is safe to use it. Otherwise, fall
1589 // back onto the hexadecimal format.
1590 SmallString<128> StrVal;
1591 APF.toString(Str&: StrVal, FormatPrecision: 6, FormatMaxPadding: 0, TruncateZero: false);
1592 if (APFloat(APF.getSemantics(), StrVal) == APF) {
1593 Out << StrVal;
1594 return;
1595 }
1596
1597 // Fallback to the hexadecimal format representing the bit string exactly.
1598 Out << 'f';
1599 APInt API = APF.bitcastToAPInt();
1600 WriteFullHexAPInt(Out, Val: API);
1601}
1602
1603static void writeConstantInternal(raw_ostream &Out, const Constant *CV,
1604 AsmWriterContext &WriterCtx) {
1605 if (const auto *CI = dyn_cast<ConstantInt>(Val: CV)) {
1606 Type *Ty = CI->getType();
1607
1608 if (Ty->isVectorTy()) {
1609 Out << "splat (";
1610 WriterCtx.TypePrinter->print(Ty: Ty->getScalarType(), OS&: Out);
1611 Out << " ";
1612 }
1613
1614 if (Ty->getScalarType()->isIntegerTy(BitWidth: 1))
1615 Out << (CI->getZExtValue() ? "true" : "false");
1616 else
1617 Out << CI->getValue();
1618
1619 if (Ty->isVectorTy())
1620 Out << ")";
1621
1622 return;
1623 }
1624
1625 if (const auto *CB = dyn_cast<ConstantByte>(Val: CV)) {
1626 Type *Ty = CB->getType();
1627
1628 if (Ty->isVectorTy()) {
1629 Out << "splat (";
1630 WriterCtx.TypePrinter->print(Ty: Ty->getScalarType(), OS&: Out);
1631 Out << " ";
1632 }
1633
1634 Out << CB->getValue();
1635
1636 if (Ty->isVectorTy())
1637 Out << ")";
1638
1639 return;
1640 }
1641
1642 if (const auto *CFP = dyn_cast<ConstantFP>(Val: CV)) {
1643 Type *Ty = CFP->getType();
1644
1645 if (Ty->isVectorTy()) {
1646 if (CFP->getValue().bitcastToAPInt().isZero()) {
1647 Out << "zeroinitializer";
1648 return;
1649 }
1650
1651 Out << "splat (";
1652 WriterCtx.TypePrinter->print(Ty: Ty->getScalarType(), OS&: Out);
1653 Out << " ";
1654 }
1655
1656 writeAPFloatInternal(Out, APF: CFP->getValueAPF());
1657
1658 if (Ty->isVectorTy())
1659 Out << ")";
1660
1661 return;
1662 }
1663
1664 if (isa<ConstantAggregateZero>(Val: CV) || isa<ConstantTargetNone>(Val: CV)) {
1665 Out << "zeroinitializer";
1666 return;
1667 }
1668
1669 if (const auto *BA = dyn_cast<BlockAddress>(Val: CV)) {
1670 Out << "blockaddress(";
1671 writeAsOperandInternal(Out, V: BA->getFunction(), WriterCtx);
1672 Out << ", ";
1673 writeAsOperandInternal(Out, V: BA->getBasicBlock(), WriterCtx);
1674 Out << ")";
1675 return;
1676 }
1677
1678 if (const auto *Equiv = dyn_cast<DSOLocalEquivalent>(Val: CV)) {
1679 Out << "dso_local_equivalent ";
1680 writeAsOperandInternal(Out, V: Equiv->getGlobalValue(), WriterCtx);
1681 return;
1682 }
1683
1684 if (const auto *NC = dyn_cast<NoCFIValue>(Val: CV)) {
1685 Out << "no_cfi ";
1686 writeAsOperandInternal(Out, V: NC->getGlobalValue(), WriterCtx);
1687 return;
1688 }
1689
1690 if (const auto *CPA = dyn_cast<ConstantPtrAuth>(Val: CV)) {
1691 Out << "ptrauth (";
1692
1693 // ptrauth (ptr CST, i32 KEY[, i64 DISC[, ptr ADDRDISC[, ptr DS]?]?]?)
1694 unsigned NumOpsToWrite = 2;
1695 if (!CPA->getOperand(i_nocapture: 2)->isNullValue())
1696 NumOpsToWrite = 3;
1697 if (!isa<ConstantPointerNull>(Val: CPA->getOperand(i_nocapture: 3)))
1698 NumOpsToWrite = 4;
1699 if (!isa<ConstantPointerNull>(Val: CPA->getOperand(i_nocapture: 4)))
1700 NumOpsToWrite = 5;
1701
1702 ListSeparator LS;
1703 for (unsigned i = 0, e = NumOpsToWrite; i != e; ++i) {
1704 Out << LS;
1705 writeAsOperandInternal(Out, V: CPA->getOperand(i_nocapture: i), WriterCtx,
1706 /*PrintType=*/true);
1707 }
1708 Out << ')';
1709 return;
1710 }
1711
1712 if (const auto *CA = dyn_cast<ConstantArray>(Val: CV)) {
1713 Out << '[';
1714 ListSeparator LS;
1715 for (const Value *Op : CA->operands()) {
1716 Out << LS;
1717 writeAsOperandInternal(Out, V: Op, WriterCtx, /*PrintType=*/true);
1718 }
1719 Out << ']';
1720 return;
1721 }
1722
1723 if (const auto *CA = dyn_cast<ConstantDataArray>(Val: CV)) {
1724 // As a special case, print the array as a string if it is an array of
1725 // i8 with ConstantInt values.
1726 if (CA->isString()) {
1727 Out << "c\"";
1728 printEscapedString(Name: CA->getAsString(), Out);
1729 Out << '"';
1730 return;
1731 }
1732
1733 Out << '[';
1734 ListSeparator LS;
1735 for (uint64_t i = 0, e = CA->getNumElements(); i != e; ++i) {
1736 Out << LS;
1737 writeAsOperandInternal(Out, V: CA->getElementAsConstant(i), WriterCtx,
1738 /*PrintType=*/true);
1739 }
1740 Out << ']';
1741 return;
1742 }
1743
1744 if (const auto *CS = dyn_cast<ConstantStruct>(Val: CV)) {
1745 if (CS->getType()->isPacked())
1746 Out << '<';
1747 Out << '{';
1748 if (CS->getNumOperands() != 0) {
1749 Out << ' ';
1750 ListSeparator LS;
1751 for (const Value *Op : CS->operands()) {
1752 Out << LS;
1753 writeAsOperandInternal(Out, V: Op, WriterCtx, /*PrintType=*/true);
1754 }
1755 Out << ' ';
1756 }
1757 Out << '}';
1758 if (CS->getType()->isPacked())
1759 Out << '>';
1760 return;
1761 }
1762
1763 if (isa<ConstantVector>(Val: CV) || isa<ConstantDataVector>(Val: CV)) {
1764 auto *CVVTy = cast<FixedVectorType>(Val: CV->getType());
1765
1766 // Use the same shorthand for splat vector (i.e. "splat(Ty val)") as is
1767 // permitted on IR input to reduce the output changes when enabling
1768 // UseConstant{Int,FP}ForFixedLengthSplat.
1769 // TODO: Remove this block when the UseConstant{Int,FP}ForFixedLengthSplat
1770 // options are removed.
1771 if (auto *SplatVal = CV->getSplatValue()) {
1772 if (isa<ConstantInt>(Val: SplatVal) || isa<ConstantFP>(Val: SplatVal) ||
1773 isa<ConstantByte>(Val: SplatVal)) {
1774 Out << "splat (";
1775 writeAsOperandInternal(Out, V: SplatVal, WriterCtx, /*PrintType=*/true);
1776 Out << ')';
1777 return;
1778 }
1779 }
1780
1781 Out << '<';
1782 ListSeparator LS;
1783 for (unsigned i = 0, e = CVVTy->getNumElements(); i != e; ++i) {
1784 Out << LS;
1785 writeAsOperandInternal(Out, V: CV->getAggregateElement(Elt: i), WriterCtx,
1786 /*PrintType=*/true);
1787 }
1788 Out << '>';
1789 return;
1790 }
1791
1792 if (const auto *CPN = dyn_cast<ConstantPointerNull>(Val: CV)) {
1793 if (auto *VT = dyn_cast<VectorType>(Val: CPN->getType())) {
1794 Out << "splat (";
1795 writeAsOperandInternal(Out,
1796 V: ConstantPointerNull::get(T: VT->getElementType()),
1797 WriterCtx, /*PrintType=*/true);
1798 Out << ')';
1799 return;
1800 }
1801
1802 Out << "null";
1803 return;
1804 }
1805
1806 if (isa<ConstantTokenNone>(Val: CV)) {
1807 Out << "none";
1808 return;
1809 }
1810
1811 if (isa<PoisonValue>(Val: CV)) {
1812 Out << "poison";
1813 return;
1814 }
1815
1816 if (isa<UndefValue>(Val: CV)) {
1817 Out << "undef";
1818 return;
1819 }
1820
1821 if (const auto *CE = dyn_cast<ConstantExpr>(Val: CV)) {
1822 // Use the same shorthand for splat vector (i.e. "splat(Ty val)") as is
1823 // permitted on IR input to reduce the output changes when enabling
1824 // UseConstant{Int,FP}ForScalableSplat.
1825 // TODO: Remove this block when the UseConstant{Int,FP}ForScalableSplat
1826 // options are removed.
1827 if (CE->getOpcode() == Instruction::ShuffleVector) {
1828 if (auto *SplatVal = CE->getSplatValue()) {
1829 if (isa<ConstantInt>(Val: SplatVal) || isa<ConstantFP>(Val: SplatVal) ||
1830 isa<ConstantByte>(Val: SplatVal)) {
1831 Out << "splat (";
1832 writeAsOperandInternal(Out, V: SplatVal, WriterCtx, /*PrintType=*/true);
1833 Out << ')';
1834 return;
1835 }
1836 }
1837 }
1838
1839 Out << CE->getOpcodeName();
1840 writeOptimizationInfo(Out, U: CE);
1841 Out << " (";
1842
1843 if (const auto *GEP = dyn_cast<GEPOperator>(Val: CE)) {
1844 WriterCtx.TypePrinter->print(Ty: GEP->getSourceElementType(), OS&: Out);
1845 Out << ", ";
1846 }
1847
1848 ListSeparator LS;
1849 for (const Value *Op : CE->operands()) {
1850 Out << LS;
1851 writeAsOperandInternal(Out, V: Op, WriterCtx, /*PrintType=*/true);
1852 }
1853
1854 if (CE->isCast()) {
1855 Out << " to ";
1856 WriterCtx.TypePrinter->print(Ty: CE->getType(), OS&: Out);
1857 }
1858
1859 if (CE->getOpcode() == Instruction::ShuffleVector)
1860 printShuffleMask(Out, Ty: CE->getType(), Mask: CE->getShuffleMask());
1861
1862 Out << ')';
1863 return;
1864 }
1865
1866 Out << "<placeholder or erroneous Constant>";
1867}
1868
1869static void writeMDTuple(raw_ostream &Out, const MDTuple *Node,
1870 AsmWriterContext &WriterCtx) {
1871 Out << "!{";
1872 ListSeparator LS;
1873 for (const Metadata *MD : Node->operands()) {
1874 Out << LS;
1875 if (!MD) {
1876 Out << "null";
1877 } else if (auto *MDV = dyn_cast<ValueAsMetadata>(Val: MD)) {
1878 Value *V = MDV->getValue();
1879 writeAsOperandInternal(Out, V, WriterCtx, /*PrintType=*/true);
1880 } else {
1881 writeAsOperandInternal(Out, MD, WriterCtx);
1882 WriterCtx.onWriteMetadataAsOperand(MD);
1883 }
1884 }
1885
1886 Out << "}";
1887}
1888
1889namespace {
1890
1891struct MDFieldPrinter {
1892 raw_ostream &Out;
1893 ListSeparator FS;
1894 AsmWriterContext &WriterCtx;
1895
1896 explicit MDFieldPrinter(raw_ostream &Out)
1897 : Out(Out), WriterCtx(AsmWriterContext::getEmpty()) {}
1898 MDFieldPrinter(raw_ostream &Out, AsmWriterContext &Ctx)
1899 : Out(Out), WriterCtx(Ctx) {}
1900
1901 void printTag(const DINode *N);
1902 void printMacinfoType(const DIMacroNode *N);
1903 void printChecksum(const DIFile::ChecksumInfo<StringRef> &N);
1904 void printString(StringRef Name, StringRef Value,
1905 bool ShouldSkipEmpty = true);
1906 void printMetadata(StringRef Name, const Metadata *MD,
1907 bool ShouldSkipNull = true);
1908 void printMetadataOrInt(StringRef Name, const Metadata *MD, bool IsUnsigned,
1909 bool ShouldSkipZero = true);
1910 template <class IntTy>
1911 void printInt(StringRef Name, IntTy Int, bool ShouldSkipZero = true);
1912 void printAPInt(StringRef Name, const APInt &Int, bool IsUnsigned,
1913 bool ShouldSkipZero);
1914 void printBool(StringRef Name, bool Value,
1915 std::optional<bool> Default = std::nullopt);
1916 void printDIFlags(StringRef Name, DINode::DIFlags Flags);
1917 void printDISPFlags(StringRef Name, DISubprogram::DISPFlags Flags);
1918 template <class IntTy, class Stringifier>
1919 void printDwarfEnum(StringRef Name, IntTy Value, Stringifier toString,
1920 bool ShouldSkipZero = true);
1921 void printEmissionKind(StringRef Name, DICompileUnit::DebugEmissionKind EK);
1922 void printNameTableKind(StringRef Name,
1923 DICompileUnit::DebugNameTableKind NTK);
1924 void printFixedPointKind(StringRef Name, DIFixedPointType::FixedPointKind V);
1925};
1926
1927} // end anonymous namespace
1928
1929void MDFieldPrinter::printTag(const DINode *N) {
1930 Out << FS << "tag: ";
1931 auto Tag = dwarf::TagString(Tag: N->getTag());
1932 if (!Tag.empty())
1933 Out << Tag;
1934 else
1935 Out << N->getTag();
1936}
1937
1938void MDFieldPrinter::printMacinfoType(const DIMacroNode *N) {
1939 Out << FS << "type: ";
1940 auto Type = dwarf::MacinfoString(Encoding: N->getMacinfoType());
1941 if (!Type.empty())
1942 Out << Type;
1943 else
1944 Out << N->getMacinfoType();
1945}
1946
1947void MDFieldPrinter::printChecksum(
1948 const DIFile::ChecksumInfo<StringRef> &Checksum) {
1949 Out << FS << "checksumkind: " << Checksum.getKindAsString();
1950 printString(Name: "checksum", Value: Checksum.Value, /* ShouldSkipEmpty */ false);
1951}
1952
1953void MDFieldPrinter::printString(StringRef Name, StringRef Value,
1954 bool ShouldSkipEmpty) {
1955 if (ShouldSkipEmpty && Value.empty())
1956 return;
1957
1958 Out << FS << Name << ": \"";
1959 printEscapedString(Name: Value, Out);
1960 Out << "\"";
1961}
1962
1963static void writeMetadataAsOperand(raw_ostream &Out, const Metadata *MD,
1964 AsmWriterContext &WriterCtx) {
1965 if (!MD) {
1966 Out << "null";
1967 return;
1968 }
1969 writeAsOperandInternal(Out, MD, WriterCtx);
1970 WriterCtx.onWriteMetadataAsOperand(MD);
1971}
1972
1973void MDFieldPrinter::printMetadata(StringRef Name, const Metadata *MD,
1974 bool ShouldSkipNull) {
1975 if (ShouldSkipNull && !MD)
1976 return;
1977
1978 Out << FS << Name << ": ";
1979 writeMetadataAsOperand(Out, MD, WriterCtx);
1980}
1981
1982void MDFieldPrinter::printMetadataOrInt(StringRef Name, const Metadata *MD,
1983 bool IsUnsigned, bool ShouldSkipZero) {
1984 if (!MD)
1985 return;
1986
1987 if (auto *CI = dyn_cast<ConstantAsMetadata>(Val: MD)) {
1988 auto *CV = cast<ConstantInt>(Val: CI->getValue());
1989 if (IsUnsigned)
1990 printInt(Name, Int: CV->getZExtValue(), ShouldSkipZero);
1991 else
1992 printInt(Name, Int: CV->getSExtValue(), ShouldSkipZero);
1993 } else
1994 printMetadata(Name, MD);
1995}
1996
1997template <class IntTy>
1998void MDFieldPrinter::printInt(StringRef Name, IntTy Int, bool ShouldSkipZero) {
1999 if (ShouldSkipZero && !Int)
2000 return;
2001
2002 Out << FS << Name << ": " << Int;
2003}
2004
2005void MDFieldPrinter::printAPInt(StringRef Name, const APInt &Int,
2006 bool IsUnsigned, bool ShouldSkipZero) {
2007 if (ShouldSkipZero && Int.isZero())
2008 return;
2009
2010 Out << FS << Name << ": ";
2011 Int.print(OS&: Out, isSigned: !IsUnsigned);
2012}
2013
2014void MDFieldPrinter::printBool(StringRef Name, bool Value,
2015 std::optional<bool> Default) {
2016 if (Default && Value == *Default)
2017 return;
2018 Out << FS << Name << ": " << (Value ? "true" : "false");
2019}
2020
2021void MDFieldPrinter::printDIFlags(StringRef Name, DINode::DIFlags Flags) {
2022 if (!Flags)
2023 return;
2024
2025 Out << FS << Name << ": ";
2026
2027 SmallVector<DINode::DIFlags, 8> SplitFlags;
2028 auto Extra = DINode::splitFlags(Flags, SplitFlags);
2029
2030 ListSeparator FlagsFS(" | ");
2031 for (auto F : SplitFlags) {
2032 auto StringF = DINode::getFlagString(Flag: F);
2033 assert(!StringF.empty() && "Expected valid flag");
2034 Out << FlagsFS << StringF;
2035 }
2036 if (Extra || SplitFlags.empty())
2037 Out << FlagsFS << Extra;
2038}
2039
2040void MDFieldPrinter::printDISPFlags(StringRef Name,
2041 DISubprogram::DISPFlags Flags) {
2042 // Always print this field, because no flags in the IR at all will be
2043 // interpreted as old-style isDefinition: true.
2044 Out << FS << Name << ": ";
2045
2046 if (!Flags) {
2047 Out << 0;
2048 return;
2049 }
2050
2051 SmallVector<DISubprogram::DISPFlags, 8> SplitFlags;
2052 auto Extra = DISubprogram::splitFlags(Flags, SplitFlags);
2053
2054 ListSeparator FlagsFS(" | ");
2055 for (auto F : SplitFlags) {
2056 auto StringF = DISubprogram::getFlagString(Flag: F);
2057 assert(!StringF.empty() && "Expected valid flag");
2058 Out << FlagsFS << StringF;
2059 }
2060 if (Extra || SplitFlags.empty())
2061 Out << FlagsFS << Extra;
2062}
2063
2064void MDFieldPrinter::printEmissionKind(StringRef Name,
2065 DICompileUnit::DebugEmissionKind EK) {
2066 Out << FS << Name << ": " << DICompileUnit::emissionKindString(EK);
2067}
2068
2069void MDFieldPrinter::printNameTableKind(StringRef Name,
2070 DICompileUnit::DebugNameTableKind NTK) {
2071 if (NTK == DICompileUnit::DebugNameTableKind::Default)
2072 return;
2073 Out << FS << Name << ": " << DICompileUnit::nameTableKindString(PK: NTK);
2074}
2075
2076void MDFieldPrinter::printFixedPointKind(StringRef Name,
2077 DIFixedPointType::FixedPointKind V) {
2078 Out << FS << Name << ": " << DIFixedPointType::fixedPointKindString(V);
2079}
2080
2081template <class IntTy, class Stringifier>
2082void MDFieldPrinter::printDwarfEnum(StringRef Name, IntTy Value,
2083 Stringifier toString, bool ShouldSkipZero) {
2084 if (ShouldSkipZero && !Value)
2085 return;
2086
2087 Out << FS << Name << ": ";
2088 auto S = toString(Value);
2089 if (!S.empty())
2090 Out << S;
2091 else
2092 Out << Value;
2093}
2094
2095static void writeGenericDINode(raw_ostream &Out, const GenericDINode *N,
2096 AsmWriterContext &WriterCtx) {
2097 Out << "!GenericDINode(";
2098 MDFieldPrinter Printer(Out, WriterCtx);
2099 Printer.printTag(N);
2100 Printer.printString(Name: "header", Value: N->getHeader());
2101 if (N->getNumDwarfOperands()) {
2102 Out << Printer.FS << "operands: {";
2103 ListSeparator IFS;
2104 for (auto &I : N->dwarf_operands()) {
2105 Out << IFS;
2106 writeMetadataAsOperand(Out, MD: I, WriterCtx);
2107 }
2108 Out << "}";
2109 }
2110 Out << ")";
2111}
2112
2113static void writeDILocation(raw_ostream &Out, const DILocation *DL,
2114 AsmWriterContext &WriterCtx) {
2115 Out << "!DILocation(";
2116 MDFieldPrinter Printer(Out, WriterCtx);
2117 // Always output the line, since 0 is a relevant and important value for it.
2118 Printer.printInt(Name: "line", Int: DL->getLine(), /* ShouldSkipZero */ false);
2119 Printer.printInt(Name: "column", Int: DL->getColumn());
2120 Printer.printMetadata(Name: "scope", MD: DL->getRawScope(), /* ShouldSkipNull */ false);
2121 Printer.printMetadata(Name: "inlinedAt", MD: DL->getRawInlinedAt());
2122 Printer.printBool(Name: "isImplicitCode", Value: DL->isImplicitCode(),
2123 /* Default */ false);
2124 Printer.printInt(Name: "atomGroup", Int: DL->getAtomGroup());
2125 Printer.printInt<unsigned>(Name: "atomRank", Int: DL->getAtomRank());
2126 Out << ")";
2127}
2128
2129static void writeDIAssignID(raw_ostream &Out, const DIAssignID *DL,
2130 AsmWriterContext &WriterCtx) {
2131 Out << "!DIAssignID()";
2132 MDFieldPrinter Printer(Out, WriterCtx);
2133}
2134
2135static void writeDISubrange(raw_ostream &Out, const DISubrange *N,
2136 AsmWriterContext &WriterCtx) {
2137 Out << "!DISubrange(";
2138 MDFieldPrinter Printer(Out, WriterCtx);
2139
2140 Printer.printMetadataOrInt(Name: "count", MD: N->getRawCountNode(),
2141 /* IsUnsigned */ false,
2142 /* ShouldSkipZero */ false);
2143
2144 // A lowerBound of constant 0 should not be skipped, since it is different
2145 // from an unspecified lower bound (= nullptr).
2146 Printer.printMetadataOrInt(Name: "lowerBound", MD: N->getRawLowerBound(),
2147 /* IsUnsigned */ false,
2148 /* ShouldSkipZero */ false);
2149 Printer.printMetadataOrInt(Name: "upperBound", MD: N->getRawUpperBound(),
2150 /* IsUnsigned */ false,
2151 /* ShouldSkipZero */ false);
2152 Printer.printMetadataOrInt(Name: "stride", MD: N->getRawStride(),
2153 /* IsUnsigned */ false,
2154 /* ShouldSkipZero */ false);
2155
2156 Out << ")";
2157}
2158
2159static void writeDIGenericSubrange(raw_ostream &Out, const DIGenericSubrange *N,
2160 AsmWriterContext &WriterCtx) {
2161 Out << "!DIGenericSubrange(";
2162 MDFieldPrinter Printer(Out, WriterCtx);
2163
2164 auto GetConstant = [&](Metadata *Bound) -> std::optional<int64_t> {
2165 auto *BE = dyn_cast_or_null<DIExpression>(Val: Bound);
2166 if (!BE)
2167 return std::nullopt;
2168 if (BE->isConstant() &&
2169 DIExpression::SignedOrUnsignedConstant::SignedConstant ==
2170 *BE->isConstant()) {
2171 return static_cast<int64_t>(BE->getElement(I: 1));
2172 }
2173 return std::nullopt;
2174 };
2175
2176 auto *Count = N->getRawCountNode();
2177 if (auto ConstantCount = GetConstant(Count))
2178 Printer.printInt(Name: "count", Int: *ConstantCount,
2179 /* ShouldSkipZero */ false);
2180 else
2181 Printer.printMetadata(Name: "count", MD: Count, /*ShouldSkipNull */ true);
2182
2183 auto *LBound = N->getRawLowerBound();
2184 if (auto ConstantLBound = GetConstant(LBound))
2185 Printer.printInt(Name: "lowerBound", Int: *ConstantLBound,
2186 /* ShouldSkipZero */ false);
2187 else
2188 Printer.printMetadata(Name: "lowerBound", MD: LBound, /*ShouldSkipNull */ true);
2189
2190 auto *UBound = N->getRawUpperBound();
2191 if (auto ConstantUBound = GetConstant(UBound))
2192 Printer.printInt(Name: "upperBound", Int: *ConstantUBound,
2193 /* ShouldSkipZero */ false);
2194 else
2195 Printer.printMetadata(Name: "upperBound", MD: UBound, /*ShouldSkipNull */ true);
2196
2197 auto *Stride = N->getRawStride();
2198 if (auto ConstantStride = GetConstant(Stride))
2199 Printer.printInt(Name: "stride", Int: *ConstantStride,
2200 /* ShouldSkipZero */ false);
2201 else
2202 Printer.printMetadata(Name: "stride", MD: Stride, /*ShouldSkipNull */ true);
2203
2204 Out << ")";
2205}
2206
2207static void writeDIEnumerator(raw_ostream &Out, const DIEnumerator *N,
2208 AsmWriterContext &) {
2209 Out << "!DIEnumerator(";
2210 MDFieldPrinter Printer(Out);
2211 Printer.printString(Name: "name", Value: N->getName(), /* ShouldSkipEmpty */ false);
2212 Printer.printAPInt(Name: "value", Int: N->getValue(), IsUnsigned: N->isUnsigned(),
2213 /*ShouldSkipZero=*/false);
2214 if (N->isUnsigned())
2215 Printer.printBool(Name: "isUnsigned", Value: true);
2216 Out << ")";
2217}
2218
2219static void writeDIBasicType(raw_ostream &Out, const DIBasicType *N,
2220 AsmWriterContext &WriterCtx) {
2221 Out << "!DIBasicType(";
2222 MDFieldPrinter Printer(Out, WriterCtx);
2223 if (N->getTag() != dwarf::DW_TAG_base_type)
2224 Printer.printTag(N);
2225 Printer.printString(Name: "name", Value: N->getName());
2226 Printer.printMetadata(Name: "scope", MD: N->getRawScope());
2227 Printer.printMetadata(Name: "file", MD: N->getRawFile());
2228 Printer.printInt(Name: "line", Int: N->getLine());
2229 Printer.printMetadataOrInt(Name: "size", MD: N->getRawSizeInBits(), IsUnsigned: true);
2230 Printer.printInt(Name: "align", Int: N->getAlignInBits());
2231 Printer.printInt(Name: "dataSize", Int: N->getDataSizeInBits());
2232 Printer.printDwarfEnum(Name: "encoding", Value: N->getEncoding(),
2233 toString: dwarf::AttributeEncodingString);
2234 Printer.printInt(Name: "num_extra_inhabitants", Int: N->getNumExtraInhabitants());
2235 Printer.printDIFlags(Name: "flags", Flags: N->getFlags());
2236 Out << ")";
2237}
2238
2239static void writeDIFixedPointType(raw_ostream &Out, const DIFixedPointType *N,
2240 AsmWriterContext &WriterCtx) {
2241 Out << "!DIFixedPointType(";
2242 MDFieldPrinter Printer(Out, WriterCtx);
2243 if (N->getTag() != dwarf::DW_TAG_base_type)
2244 Printer.printTag(N);
2245 Printer.printString(Name: "name", Value: N->getName());
2246 Printer.printMetadata(Name: "scope", MD: N->getRawScope());
2247 Printer.printMetadata(Name: "file", MD: N->getRawFile());
2248 Printer.printInt(Name: "line", Int: N->getLine());
2249 Printer.printMetadataOrInt(Name: "size", MD: N->getRawSizeInBits(), IsUnsigned: true);
2250 Printer.printInt(Name: "align", Int: N->getAlignInBits());
2251 Printer.printDwarfEnum(Name: "encoding", Value: N->getEncoding(),
2252 toString: dwarf::AttributeEncodingString);
2253 Printer.printDIFlags(Name: "flags", Flags: N->getFlags());
2254 Printer.printFixedPointKind(Name: "kind", V: N->getKind());
2255 if (N->isRational()) {
2256 bool IsUnsigned = !N->isSigned();
2257 Printer.printAPInt(Name: "numerator", Int: N->getNumerator(), IsUnsigned, ShouldSkipZero: false);
2258 Printer.printAPInt(Name: "denominator", Int: N->getDenominator(), IsUnsigned, ShouldSkipZero: false);
2259 } else {
2260 Printer.printInt(Name: "factor", Int: N->getFactor());
2261 }
2262 Out << ")";
2263}
2264
2265static void writeDIStringType(raw_ostream &Out, const DIStringType *N,
2266 AsmWriterContext &WriterCtx) {
2267 Out << "!DIStringType(";
2268 MDFieldPrinter Printer(Out, WriterCtx);
2269 if (N->getTag() != dwarf::DW_TAG_string_type)
2270 Printer.printTag(N);
2271 Printer.printString(Name: "name", Value: N->getName());
2272 Printer.printMetadata(Name: "stringLength", MD: N->getRawStringLength());
2273 Printer.printMetadata(Name: "stringLengthExpression", MD: N->getRawStringLengthExp());
2274 Printer.printMetadata(Name: "stringLocationExpression",
2275 MD: N->getRawStringLocationExp());
2276 Printer.printMetadataOrInt(Name: "size", MD: N->getRawSizeInBits(), IsUnsigned: true);
2277 Printer.printInt(Name: "align", Int: N->getAlignInBits());
2278 Printer.printDwarfEnum(Name: "encoding", Value: N->getEncoding(),
2279 toString: dwarf::AttributeEncodingString);
2280 Out << ")";
2281}
2282
2283static void writeDIDerivedType(raw_ostream &Out, const DIDerivedType *N,
2284 AsmWriterContext &WriterCtx) {
2285 Out << "!DIDerivedType(";
2286 MDFieldPrinter Printer(Out, WriterCtx);
2287 Printer.printTag(N);
2288 Printer.printString(Name: "name", Value: N->getName());
2289 Printer.printMetadata(Name: "scope", MD: N->getRawScope());
2290 Printer.printMetadata(Name: "file", MD: N->getRawFile());
2291 Printer.printInt(Name: "line", Int: N->getLine());
2292 Printer.printMetadata(Name: "baseType", MD: N->getRawBaseType(),
2293 /* ShouldSkipNull */ false);
2294 Printer.printMetadataOrInt(Name: "size", MD: N->getRawSizeInBits(), IsUnsigned: true);
2295 Printer.printInt(Name: "align", Int: N->getAlignInBits());
2296 Printer.printMetadataOrInt(Name: "offset", MD: N->getRawOffsetInBits(), IsUnsigned: true);
2297 Printer.printDIFlags(Name: "flags", Flags: N->getFlags());
2298 Printer.printMetadata(Name: "extraData", MD: N->getRawExtraData());
2299 if (const auto &DWARFAddressSpace = N->getDWARFAddressSpace())
2300 Printer.printInt(Name: "dwarfAddressSpace", Int: *DWARFAddressSpace,
2301 /* ShouldSkipZero */ false);
2302 Printer.printMetadata(Name: "annotations", MD: N->getRawAnnotations());
2303 if (auto PtrAuthData = N->getPtrAuthData()) {
2304 Printer.printInt(Name: "ptrAuthKey", Int: PtrAuthData->key());
2305 Printer.printBool(Name: "ptrAuthIsAddressDiscriminated",
2306 Value: PtrAuthData->isAddressDiscriminated());
2307 Printer.printInt(Name: "ptrAuthExtraDiscriminator",
2308 Int: PtrAuthData->extraDiscriminator());
2309 Printer.printBool(Name: "ptrAuthIsaPointer", Value: PtrAuthData->isaPointer());
2310 Printer.printBool(Name: "ptrAuthAuthenticatesNullValues",
2311 Value: PtrAuthData->authenticatesNullValues());
2312 }
2313 Out << ")";
2314}
2315
2316static void writeDISubrangeType(raw_ostream &Out, const DISubrangeType *N,
2317 AsmWriterContext &WriterCtx) {
2318 Out << "!DISubrangeType(";
2319 MDFieldPrinter Printer(Out, WriterCtx);
2320 Printer.printString(Name: "name", Value: N->getName());
2321 Printer.printMetadata(Name: "scope", MD: N->getRawScope());
2322 Printer.printMetadata(Name: "file", MD: N->getRawFile());
2323 Printer.printInt(Name: "line", Int: N->getLine());
2324 Printer.printMetadataOrInt(Name: "size", MD: N->getRawSizeInBits(), IsUnsigned: true);
2325 Printer.printInt(Name: "align", Int: N->getAlignInBits());
2326 Printer.printDIFlags(Name: "flags", Flags: N->getFlags());
2327 Printer.printMetadata(Name: "baseType", MD: N->getRawBaseType(),
2328 /* ShouldSkipNull */ false);
2329 Printer.printMetadata(Name: "lowerBound", MD: N->getRawLowerBound());
2330 Printer.printMetadata(Name: "upperBound", MD: N->getRawUpperBound());
2331 Printer.printMetadata(Name: "stride", MD: N->getRawStride());
2332 Printer.printMetadata(Name: "bias", MD: N->getRawBias());
2333 Out << ")";
2334}
2335
2336static void writeDICompositeType(raw_ostream &Out, const DICompositeType *N,
2337 AsmWriterContext &WriterCtx) {
2338 Out << "!DICompositeType(";
2339 MDFieldPrinter Printer(Out, WriterCtx);
2340 Printer.printTag(N);
2341 Printer.printString(Name: "name", Value: N->getName());
2342 Printer.printMetadata(Name: "scope", MD: N->getRawScope());
2343 Printer.printMetadata(Name: "file", MD: N->getRawFile());
2344 Printer.printInt(Name: "line", Int: N->getLine());
2345 Printer.printMetadata(Name: "baseType", MD: N->getRawBaseType());
2346 Printer.printMetadataOrInt(Name: "size", MD: N->getRawSizeInBits(), IsUnsigned: true);
2347 Printer.printInt(Name: "align", Int: N->getAlignInBits());
2348 Printer.printMetadataOrInt(Name: "offset", MD: N->getRawOffsetInBits(), IsUnsigned: true);
2349 Printer.printInt(Name: "num_extra_inhabitants", Int: N->getNumExtraInhabitants());
2350 Printer.printDIFlags(Name: "flags", Flags: N->getFlags());
2351 Printer.printMetadata(Name: "elements", MD: N->getRawElements());
2352 Printer.printDwarfEnum(Name: "runtimeLang", Value: N->getRuntimeLang(),
2353 toString: dwarf::LanguageString);
2354 Printer.printMetadata(Name: "vtableHolder", MD: N->getRawVTableHolder());
2355 Printer.printMetadata(Name: "templateParams", MD: N->getRawTemplateParams());
2356 Printer.printString(Name: "identifier", Value: N->getIdentifier());
2357 Printer.printMetadata(Name: "discriminator", MD: N->getRawDiscriminator());
2358 Printer.printMetadata(Name: "dataLocation", MD: N->getRawDataLocation());
2359 Printer.printMetadata(Name: "associated", MD: N->getRawAssociated());
2360 Printer.printMetadata(Name: "allocated", MD: N->getRawAllocated());
2361 if (auto *RankConst = N->getRankConst())
2362 Printer.printInt(Name: "rank", Int: RankConst->getSExtValue(),
2363 /* ShouldSkipZero */ false);
2364 else
2365 Printer.printMetadata(Name: "rank", MD: N->getRawRank(), /*ShouldSkipNull */ true);
2366 Printer.printMetadata(Name: "annotations", MD: N->getRawAnnotations());
2367 if (auto *Specification = N->getRawSpecification())
2368 Printer.printMetadata(Name: "specification", MD: Specification);
2369
2370 if (auto EnumKind = N->getEnumKind())
2371 Printer.printDwarfEnum(Name: "enumKind", Value: *EnumKind, toString: dwarf::EnumKindString,
2372 /*ShouldSkipZero=*/false);
2373
2374 Printer.printMetadata(Name: "bitStride", MD: N->getRawBitStride());
2375 Out << ")";
2376}
2377
2378static void writeDISubroutineType(raw_ostream &Out, const DISubroutineType *N,
2379 AsmWriterContext &WriterCtx) {
2380 Out << "!DISubroutineType(";
2381 MDFieldPrinter Printer(Out, WriterCtx);
2382 Printer.printDIFlags(Name: "flags", Flags: N->getFlags());
2383 Printer.printDwarfEnum(Name: "cc", Value: N->getCC(), toString: dwarf::ConventionString);
2384 Printer.printMetadata(Name: "types", MD: N->getRawTypeArray(),
2385 /* ShouldSkipNull */ false);
2386 Out << ")";
2387}
2388
2389static void writeDIFile(raw_ostream &Out, const DIFile *N, AsmWriterContext &) {
2390 Out << "!DIFile(";
2391 MDFieldPrinter Printer(Out);
2392 Printer.printString(Name: "filename", Value: N->getFilename(),
2393 /* ShouldSkipEmpty */ false);
2394 Printer.printString(Name: "directory", Value: N->getDirectory(),
2395 /* ShouldSkipEmpty */ false);
2396 // Print all values for checksum together, or not at all.
2397 if (N->getChecksum())
2398 Printer.printChecksum(Checksum: *N->getChecksum());
2399 if (N->getSource())
2400 Printer.printString(Name: "source", Value: *N->getSource(),
2401 /* ShouldSkipEmpty */ false);
2402 Out << ")";
2403}
2404
2405static void writeDICompileUnit(raw_ostream &Out, const DICompileUnit *N,
2406 AsmWriterContext &WriterCtx) {
2407 Out << "!DICompileUnit(";
2408 MDFieldPrinter Printer(Out, WriterCtx);
2409
2410 DISourceLanguageName Lang = N->getSourceLanguage();
2411
2412 if (Lang.hasVersionedName()) {
2413 Printer.printDwarfEnum(
2414 Name: "sourceLanguageName",
2415 Value: static_cast<llvm::dwarf::SourceLanguageName>(Lang.getName()),
2416 toString: dwarf::SourceLanguageNameString,
2417 /* ShouldSkipZero */ false);
2418
2419 Printer.printInt(Name: "sourceLanguageVersion", Int: Lang.getVersion(),
2420 /*ShouldSkipZero=*/true);
2421 } else {
2422 Printer.printDwarfEnum(Name: "language", Value: Lang.getName(), toString: dwarf::LanguageString,
2423 /* ShouldSkipZero */ false);
2424 }
2425
2426 Printer.printMetadata(Name: "file", MD: N->getRawFile(), /* ShouldSkipNull */ false);
2427 Printer.printString(Name: "producer", Value: N->getProducer());
2428 Printer.printBool(Name: "isOptimized", Value: N->isOptimized());
2429 Printer.printString(Name: "flags", Value: N->getFlags());
2430 Printer.printInt(Name: "runtimeVersion", Int: N->getRuntimeVersion(),
2431 /* ShouldSkipZero */ false);
2432 Printer.printString(Name: "splitDebugFilename", Value: N->getSplitDebugFilename());
2433 Printer.printEmissionKind(Name: "emissionKind", EK: N->getEmissionKind());
2434 Printer.printMetadata(Name: "enums", MD: N->getRawEnumTypes());
2435 Printer.printMetadata(Name: "retainedTypes", MD: N->getRawRetainedTypes());
2436 Printer.printMetadata(Name: "globals", MD: N->getRawGlobalVariables());
2437 Printer.printMetadata(Name: "imports", MD: N->getRawImportedEntities());
2438 Printer.printMetadata(Name: "macros", MD: N->getRawMacros());
2439 Printer.printInt(Name: "dwoId", Int: N->getDWOId());
2440 Printer.printBool(Name: "splitDebugInlining", Value: N->getSplitDebugInlining(), Default: true);
2441 Printer.printBool(Name: "debugInfoForProfiling", Value: N->getDebugInfoForProfiling(),
2442 Default: false);
2443 Printer.printNameTableKind(Name: "nameTableKind", NTK: N->getNameTableKind());
2444 Printer.printBool(Name: "rangesBaseAddress", Value: N->getRangesBaseAddress(), Default: false);
2445 Printer.printString(Name: "sysroot", Value: N->getSysRoot());
2446 Printer.printString(Name: "sdk", Value: N->getSDK());
2447 Printer.printDwarfEnum(Name: "dialect", Value: Lang.getDialect(),
2448 toString: dwarf::LanguageDialectString);
2449 Out << ")";
2450}
2451
2452static void writeDISubprogram(raw_ostream &Out, const DISubprogram *N,
2453 AsmWriterContext &WriterCtx) {
2454 Out << "!DISubprogram(";
2455 MDFieldPrinter Printer(Out, WriterCtx);
2456 Printer.printString(Name: "name", Value: N->getName());
2457 Printer.printString(Name: "linkageName", Value: N->getLinkageName());
2458 Printer.printMetadata(Name: "scope", MD: N->getRawScope(), /* ShouldSkipNull */ false);
2459 Printer.printMetadata(Name: "file", MD: N->getRawFile());
2460 Printer.printInt(Name: "line", Int: N->getLine());
2461 Printer.printMetadata(Name: "type", MD: N->getRawType());
2462 Printer.printInt(Name: "scopeLine", Int: N->getScopeLine());
2463 Printer.printMetadata(Name: "containingType", MD: N->getRawContainingType());
2464 if (N->getVirtuality() != dwarf::DW_VIRTUALITY_none ||
2465 N->getVirtualIndex() != 0)
2466 Printer.printInt(Name: "virtualIndex", Int: N->getVirtualIndex(), ShouldSkipZero: false);
2467 Printer.printInt(Name: "thisAdjustment", Int: N->getThisAdjustment());
2468 Printer.printDIFlags(Name: "flags", Flags: N->getFlags());
2469 Printer.printDISPFlags(Name: "spFlags", Flags: N->getSPFlags());
2470 Printer.printMetadata(Name: "unit", MD: N->getRawUnit());
2471 Printer.printMetadata(Name: "templateParams", MD: N->getRawTemplateParams());
2472 Printer.printMetadata(Name: "declaration", MD: N->getRawDeclaration());
2473 Printer.printMetadata(Name: "retainedNodes", MD: N->getRawRetainedNodes());
2474 Printer.printMetadata(Name: "thrownTypes", MD: N->getRawThrownTypes());
2475 Printer.printMetadata(Name: "annotations", MD: N->getRawAnnotations());
2476 Printer.printString(Name: "targetFuncName", Value: N->getTargetFuncName());
2477 Printer.printBool(Name: "keyInstructions", Value: N->getKeyInstructionsEnabled(), Default: false);
2478 Out << ")";
2479}
2480
2481static void writeDILexicalBlock(raw_ostream &Out, const DILexicalBlock *N,
2482 AsmWriterContext &WriterCtx) {
2483 Out << "!DILexicalBlock(";
2484 MDFieldPrinter Printer(Out, WriterCtx);
2485 Printer.printMetadata(Name: "scope", MD: N->getRawScope(), /* ShouldSkipNull */ false);
2486 Printer.printMetadata(Name: "file", MD: N->getRawFile());
2487 Printer.printInt(Name: "line", Int: N->getLine());
2488 Printer.printInt(Name: "column", Int: N->getColumn());
2489 Out << ")";
2490}
2491
2492static void writeDILexicalBlockFile(raw_ostream &Out,
2493 const DILexicalBlockFile *N,
2494 AsmWriterContext &WriterCtx) {
2495 Out << "!DILexicalBlockFile(";
2496 MDFieldPrinter Printer(Out, WriterCtx);
2497 Printer.printMetadata(Name: "scope", MD: N->getRawScope(), /* ShouldSkipNull */ false);
2498 Printer.printMetadata(Name: "file", MD: N->getRawFile());
2499 Printer.printInt(Name: "discriminator", Int: N->getDiscriminator(),
2500 /* ShouldSkipZero */ false);
2501 Out << ")";
2502}
2503
2504static void writeDINamespace(raw_ostream &Out, const DINamespace *N,
2505 AsmWriterContext &WriterCtx) {
2506 Out << "!DINamespace(";
2507 MDFieldPrinter Printer(Out, WriterCtx);
2508 Printer.printString(Name: "name", Value: N->getName());
2509 Printer.printMetadata(Name: "scope", MD: N->getRawScope(), /* ShouldSkipNull */ false);
2510 Printer.printBool(Name: "exportSymbols", Value: N->getExportSymbols(), Default: false);
2511 Out << ")";
2512}
2513
2514static void writeDICommonBlock(raw_ostream &Out, const DICommonBlock *N,
2515 AsmWriterContext &WriterCtx) {
2516 Out << "!DICommonBlock(";
2517 MDFieldPrinter Printer(Out, WriterCtx);
2518 Printer.printMetadata(Name: "scope", MD: N->getRawScope(), ShouldSkipNull: false);
2519 Printer.printMetadata(Name: "declaration", MD: N->getRawDecl(), ShouldSkipNull: false);
2520 Printer.printString(Name: "name", Value: N->getName());
2521 Printer.printMetadata(Name: "file", MD: N->getRawFile());
2522 Printer.printInt(Name: "line", Int: N->getLineNo());
2523 Out << ")";
2524}
2525
2526static void writeDIMacro(raw_ostream &Out, const DIMacro *N,
2527 AsmWriterContext &WriterCtx) {
2528 Out << "!DIMacro(";
2529 MDFieldPrinter Printer(Out, WriterCtx);
2530 Printer.printMacinfoType(N);
2531 Printer.printInt(Name: "line", Int: N->getLine());
2532 Printer.printString(Name: "name", Value: N->getName());
2533 Printer.printString(Name: "value", Value: N->getValue());
2534 Out << ")";
2535}
2536
2537static void writeDIMacroFile(raw_ostream &Out, const DIMacroFile *N,
2538 AsmWriterContext &WriterCtx) {
2539 Out << "!DIMacroFile(";
2540 MDFieldPrinter Printer(Out, WriterCtx);
2541 Printer.printInt(Name: "line", Int: N->getLine());
2542 Printer.printMetadata(Name: "file", MD: N->getRawFile(), /* ShouldSkipNull */ false);
2543 Printer.printMetadata(Name: "nodes", MD: N->getRawElements());
2544 Out << ")";
2545}
2546
2547static void writeDIModule(raw_ostream &Out, const DIModule *N,
2548 AsmWriterContext &WriterCtx) {
2549 Out << "!DIModule(";
2550 MDFieldPrinter Printer(Out, WriterCtx);
2551 Printer.printMetadata(Name: "scope", MD: N->getRawScope(), /* ShouldSkipNull */ false);
2552 Printer.printString(Name: "name", Value: N->getName());
2553 Printer.printString(Name: "configMacros", Value: N->getConfigurationMacros());
2554 Printer.printString(Name: "includePath", Value: N->getIncludePath());
2555 Printer.printString(Name: "apinotes", Value: N->getAPINotesFile());
2556 Printer.printMetadata(Name: "file", MD: N->getRawFile());
2557 Printer.printInt(Name: "line", Int: N->getLineNo());
2558 Printer.printBool(Name: "isDecl", Value: N->getIsDecl(), /* Default */ false);
2559 Out << ")";
2560}
2561
2562static void writeDITemplateTypeParameter(raw_ostream &Out,
2563 const DITemplateTypeParameter *N,
2564 AsmWriterContext &WriterCtx) {
2565 Out << "!DITemplateTypeParameter(";
2566 MDFieldPrinter Printer(Out, WriterCtx);
2567 Printer.printString(Name: "name", Value: N->getName());
2568 Printer.printMetadata(Name: "type", MD: N->getRawType(), /* ShouldSkipNull */ false);
2569 Printer.printBool(Name: "defaulted", Value: N->isDefault(), /* Default= */ false);
2570 Out << ")";
2571}
2572
2573static void writeDITemplateValueParameter(raw_ostream &Out,
2574 const DITemplateValueParameter *N,
2575 AsmWriterContext &WriterCtx) {
2576 Out << "!DITemplateValueParameter(";
2577 MDFieldPrinter Printer(Out, WriterCtx);
2578 if (N->getTag() != dwarf::DW_TAG_template_value_parameter)
2579 Printer.printTag(N);
2580 Printer.printString(Name: "name", Value: N->getName());
2581 Printer.printMetadata(Name: "type", MD: N->getRawType());
2582 Printer.printBool(Name: "defaulted", Value: N->isDefault(), /* Default= */ false);
2583 Printer.printMetadata(Name: "value", MD: N->getValue(), /* ShouldSkipNull */ false);
2584 Out << ")";
2585}
2586
2587static void writeDIGlobalVariable(raw_ostream &Out, const DIGlobalVariable *N,
2588 AsmWriterContext &WriterCtx) {
2589 Out << "!DIGlobalVariable(";
2590 MDFieldPrinter Printer(Out, WriterCtx);
2591 Printer.printString(Name: "name", Value: N->getName());
2592 Printer.printString(Name: "linkageName", Value: N->getLinkageName());
2593 Printer.printMetadata(Name: "scope", MD: N->getRawScope(), /* ShouldSkipNull */ false);
2594 Printer.printMetadata(Name: "file", MD: N->getRawFile());
2595 Printer.printInt(Name: "line", Int: N->getLine());
2596 Printer.printMetadata(Name: "type", MD: N->getRawType());
2597 Printer.printBool(Name: "isLocal", Value: N->isLocalToUnit());
2598 Printer.printBool(Name: "isDefinition", Value: N->isDefinition());
2599 Printer.printMetadata(Name: "declaration", MD: N->getRawStaticDataMemberDeclaration());
2600 Printer.printMetadata(Name: "templateParams", MD: N->getRawTemplateParams());
2601 Printer.printInt(Name: "align", Int: N->getAlignInBits());
2602 Printer.printMetadata(Name: "annotations", MD: N->getRawAnnotations());
2603 Out << ")";
2604}
2605
2606static void writeDILocalVariable(raw_ostream &Out, const DILocalVariable *N,
2607 AsmWriterContext &WriterCtx) {
2608 Out << "!DILocalVariable(";
2609 MDFieldPrinter Printer(Out, WriterCtx);
2610 Printer.printString(Name: "name", Value: N->getName());
2611 Printer.printInt(Name: "arg", Int: N->getArg());
2612 Printer.printMetadata(Name: "scope", MD: N->getRawScope(), /* ShouldSkipNull */ false);
2613 Printer.printMetadata(Name: "file", MD: N->getRawFile());
2614 Printer.printInt(Name: "line", Int: N->getLine());
2615 Printer.printMetadata(Name: "type", MD: N->getRawType());
2616 Printer.printDIFlags(Name: "flags", Flags: N->getFlags());
2617 Printer.printInt(Name: "align", Int: N->getAlignInBits());
2618 Printer.printMetadata(Name: "annotations", MD: N->getRawAnnotations());
2619 Out << ")";
2620}
2621
2622static void writeDILabel(raw_ostream &Out, const DILabel *N,
2623 AsmWriterContext &WriterCtx) {
2624 Out << "!DILabel(";
2625 MDFieldPrinter Printer(Out, WriterCtx);
2626 Printer.printMetadata(Name: "scope", MD: N->getRawScope(), /* ShouldSkipNull */ false);
2627 Printer.printString(Name: "name", Value: N->getName());
2628 Printer.printMetadata(Name: "file", MD: N->getRawFile());
2629 Printer.printInt(Name: "line", Int: N->getLine(), /* ShouldSkipZero */ false);
2630 Printer.printInt(Name: "column", Int: N->getColumn());
2631 Printer.printBool(Name: "isArtificial", Value: N->isArtificial(), Default: false);
2632 if (N->getCoroSuspendIdx())
2633 Printer.printInt(Name: "coroSuspendIdx", Int: *N->getCoroSuspendIdx(),
2634 /* ShouldSkipZero */ false);
2635 Out << ")";
2636}
2637
2638static void writeDIExpression(raw_ostream &Out, const DIExpression *N,
2639 AsmWriterContext &WriterCtx) {
2640 Out << "!DIExpression(";
2641 ListSeparator FS;
2642 if (N->isValid()) {
2643 for (const DIExpression::ExprOperand &Op : N->expr_ops()) {
2644 auto OpStr = dwarf::OperationEncodingString(Encoding: Op.getOp());
2645 assert(!OpStr.empty() && "Expected valid opcode");
2646
2647 Out << FS << OpStr;
2648 if (Op.getOp() == dwarf::DW_OP_LLVM_convert) {
2649 Out << FS << Op.getArg(I: 0);
2650 Out << FS << dwarf::AttributeEncodingString(Encoding: Op.getArg(I: 1));
2651 } else {
2652 for (unsigned A = 0, AE = Op.getNumArgs(); A != AE; ++A)
2653 Out << FS << Op.getArg(I: A);
2654 }
2655 }
2656 } else {
2657 for (const auto &I : N->getElements())
2658 Out << FS << I;
2659 }
2660 Out << ")";
2661}
2662
2663static void writeDIArgList(raw_ostream &Out, const DIArgList *N,
2664 AsmWriterContext &WriterCtx,
2665 bool FromValue = false) {
2666 assert(FromValue &&
2667 "Unexpected DIArgList metadata outside of value argument");
2668 Out << "!DIArgList(";
2669 ListSeparator FS;
2670 MDFieldPrinter Printer(Out, WriterCtx);
2671 for (const Metadata *Arg : N->getArgs()) {
2672 Out << FS;
2673 writeAsOperandInternal(Out, MD: Arg, WriterCtx, FromValue: true);
2674 }
2675 Out << ")";
2676}
2677
2678static void writeDIGlobalVariableExpression(raw_ostream &Out,
2679 const DIGlobalVariableExpression *N,
2680 AsmWriterContext &WriterCtx) {
2681 Out << "!DIGlobalVariableExpression(";
2682 MDFieldPrinter Printer(Out, WriterCtx);
2683 Printer.printMetadata(Name: "var", MD: N->getVariable());
2684 Printer.printMetadata(Name: "expr", MD: N->getExpression());
2685 Out << ")";
2686}
2687
2688static void writeDIObjCProperty(raw_ostream &Out, const DIObjCProperty *N,
2689 AsmWriterContext &WriterCtx) {
2690 Out << "!DIObjCProperty(";
2691 MDFieldPrinter Printer(Out, WriterCtx);
2692 Printer.printString(Name: "name", Value: N->getName());
2693 Printer.printMetadata(Name: "file", MD: N->getRawFile());
2694 Printer.printInt(Name: "line", Int: N->getLine());
2695 Printer.printString(Name: "setter", Value: N->getSetterName());
2696 Printer.printString(Name: "getter", Value: N->getGetterName());
2697 Printer.printInt(Name: "attributes", Int: N->getAttributes());
2698 Printer.printMetadata(Name: "type", MD: N->getRawType());
2699 Out << ")";
2700}
2701
2702static void writeDIImportedEntity(raw_ostream &Out, const DIImportedEntity *N,
2703 AsmWriterContext &WriterCtx) {
2704 Out << "!DIImportedEntity(";
2705 MDFieldPrinter Printer(Out, WriterCtx);
2706 Printer.printTag(N);
2707 Printer.printString(Name: "name", Value: N->getName());
2708 Printer.printMetadata(Name: "scope", MD: N->getRawScope(), /* ShouldSkipNull */ false);
2709 Printer.printMetadata(Name: "entity", MD: N->getRawEntity());
2710 Printer.printMetadata(Name: "file", MD: N->getRawFile());
2711 Printer.printInt(Name: "line", Int: N->getLine());
2712 Printer.printMetadata(Name: "elements", MD: N->getRawElements());
2713 Out << ")";
2714}
2715
2716static void writeMDNodeBodyInternal(raw_ostream &Out, const MDNode *Node,
2717 AsmWriterContext &Ctx) {
2718 if (Node->isDistinct())
2719 Out << "distinct ";
2720 else if (Node->isTemporary())
2721 Out << "<temporary!> "; // Handle broken code.
2722
2723 switch (Node->getMetadataID()) {
2724 default:
2725 llvm_unreachable("Expected uniquable MDNode");
2726#define HANDLE_MDNODE_LEAF(CLASS) \
2727 case Metadata::CLASS##Kind: \
2728 write##CLASS(Out, cast<CLASS>(Node), Ctx); \
2729 break;
2730#include "llvm/IR/Metadata.def"
2731 }
2732}
2733
2734// Full implementation of printing a Value as an operand with support for
2735// TypePrinting, etc.
2736static void writeAsOperandInternal(raw_ostream &Out, const Value *V,
2737 AsmWriterContext &WriterCtx,
2738 bool PrintType) {
2739 if (PrintType) {
2740 WriterCtx.TypePrinter->print(Ty: V->getType(), OS&: Out);
2741 Out << ' ';
2742 }
2743
2744 if (V->hasName()) {
2745 printLLVMName(OS&: Out, V);
2746 return;
2747 }
2748
2749 const auto *CV = dyn_cast<Constant>(Val: V);
2750 if (CV && !isa<GlobalValue>(Val: CV)) {
2751 assert(WriterCtx.TypePrinter && "Constants require TypePrinting!");
2752 writeConstantInternal(Out, CV, WriterCtx);
2753 return;
2754 }
2755
2756 if (const auto *IA = dyn_cast<InlineAsm>(Val: V)) {
2757 Out << "asm ";
2758 if (IA->hasSideEffects())
2759 Out << "sideeffect ";
2760 if (IA->isAlignStack())
2761 Out << "alignstack ";
2762 // We don't emit the AD_ATT dialect as it's the assumed default.
2763 if (IA->getDialect() == InlineAsm::AD_Intel)
2764 Out << "inteldialect ";
2765 if (IA->canThrow())
2766 Out << "unwind ";
2767 Out << '"';
2768 printEscapedString(Name: IA->getAsmString(), Out);
2769 Out << "\", \"";
2770 printEscapedString(Name: IA->getConstraintString(), Out);
2771 Out << '"';
2772 return;
2773 }
2774
2775 if (auto *MD = dyn_cast<MetadataAsValue>(Val: V)) {
2776 writeAsOperandInternal(Out, MD: MD->getMetadata(), WriterCtx,
2777 /* FromValue */ true);
2778 return;
2779 }
2780
2781 char Prefix = '%';
2782 int Slot;
2783 auto *Machine = WriterCtx.Machine;
2784 // If we have a SlotTracker, use it.
2785 if (Machine) {
2786 if (const auto *GV = dyn_cast<GlobalValue>(Val: V)) {
2787 Slot = Machine->getGlobalSlot(V: GV);
2788 Prefix = '@';
2789 } else {
2790 Slot = Machine->getLocalSlot(V);
2791
2792 // If the local value didn't succeed, then we may be referring to a value
2793 // from a different function. Translate it, as this can happen when using
2794 // address of blocks.
2795 if (Slot == -1)
2796 if ((Machine = createSlotTracker(V))) {
2797 Slot = Machine->getLocalSlot(V);
2798 delete Machine;
2799 }
2800 }
2801 } else if ((Machine = createSlotTracker(V))) {
2802 // Otherwise, create one to get the # and then destroy it.
2803 if (const auto *GV = dyn_cast<GlobalValue>(Val: V)) {
2804 Slot = Machine->getGlobalSlot(V: GV);
2805 Prefix = '@';
2806 } else {
2807 Slot = Machine->getLocalSlot(V);
2808 }
2809 delete Machine;
2810 Machine = nullptr;
2811 } else {
2812 Slot = -1;
2813 }
2814
2815 if (Slot != -1)
2816 Out << Prefix << Slot;
2817 else
2818 Out << "<badref>";
2819}
2820
2821static void writeAsOperandInternal(raw_ostream &Out, const Metadata *MD,
2822 AsmWriterContext &WriterCtx,
2823 bool FromValue) {
2824 // Write DIExpressions and DIArgLists inline when used as a value. Improves
2825 // readability of debug info intrinsics.
2826 if (const auto *Expr = dyn_cast<DIExpression>(Val: MD)) {
2827 writeDIExpression(Out, N: Expr, WriterCtx);
2828 return;
2829 }
2830 if (const auto *ArgList = dyn_cast<DIArgList>(Val: MD)) {
2831 writeDIArgList(Out, N: ArgList, WriterCtx, FromValue);
2832 return;
2833 }
2834
2835 if (const auto *N = dyn_cast<MDNode>(Val: MD)) {
2836 std::unique_ptr<SlotTracker> MachineStorage;
2837 SaveAndRestore SARMachine(WriterCtx.Machine);
2838 if (!WriterCtx.Machine) {
2839 MachineStorage = std::make_unique<SlotTracker>(args&: WriterCtx.Context);
2840 WriterCtx.Machine = MachineStorage.get();
2841 }
2842 int Slot = WriterCtx.Machine->getMetadataSlot(N);
2843 if (Slot == -1) {
2844 if (const auto *Loc = dyn_cast<DILocation>(Val: N)) {
2845 writeDILocation(Out, DL: Loc, WriterCtx);
2846 return;
2847 }
2848 // Give the pointer value instead of "badref", since this comes up all
2849 // the time when debugging.
2850 Out << "<" << N << ">";
2851 } else
2852 Out << '!' << Slot;
2853 return;
2854 }
2855
2856 if (const auto *MDS = dyn_cast<MDString>(Val: MD)) {
2857 Out << "!\"";
2858 printEscapedString(Name: MDS->getString(), Out);
2859 Out << '"';
2860 return;
2861 }
2862
2863 auto *V = cast<ValueAsMetadata>(Val: MD);
2864 assert(WriterCtx.TypePrinter && "TypePrinter required for metadata values");
2865 assert((FromValue || !isa<LocalAsMetadata>(V)) &&
2866 "Unexpected function-local metadata outside of value argument");
2867
2868 writeAsOperandInternal(Out, V: V->getValue(), WriterCtx, /*PrintType=*/true);
2869}
2870
2871namespace {
2872
2873class AssemblyWriter {
2874 formatted_raw_ostream &Out;
2875 const Module *TheModule = nullptr;
2876 const ModuleSummaryIndex *TheIndex = nullptr;
2877 std::unique_ptr<SlotTracker> SlotTrackerStorage;
2878 SlotTracker &Machine;
2879 TypePrinting TypePrinter;
2880 AssemblyAnnotationWriter *AnnotationWriter = nullptr;
2881 SetVector<const Comdat *> Comdats;
2882 bool IsForDebug;
2883 bool ShouldPreserveUseListOrder;
2884 UseListOrderMap UseListOrders;
2885 SmallVector<StringRef, 8> MDNames;
2886 /// Synchronization scope names registered with LLVMContext.
2887 SmallVector<StringRef, 8> SSNs;
2888 DenseMap<const GlobalValueSummary *, GlobalValue::GUID> SummaryToGUIDMap;
2889
2890public:
2891 /// Construct an AssemblyWriter with an external SlotTracker
2892 AssemblyWriter(formatted_raw_ostream &o, SlotTracker &Mac, const Module *M,
2893 AssemblyAnnotationWriter *AAW, bool IsForDebug,
2894 bool ShouldPreserveUseListOrder = false);
2895
2896 AssemblyWriter(formatted_raw_ostream &o, SlotTracker &Mac,
2897 const ModuleSummaryIndex *Index, bool IsForDebug);
2898
2899 AsmWriterContext getContext() {
2900 return AsmWriterContext(&TypePrinter, &Machine, TheModule);
2901 }
2902
2903 void printMDNodeBody(const MDNode *MD);
2904 void printNamedMDNode(const NamedMDNode *NMD);
2905
2906 void printModule(const Module *M);
2907
2908 void writeOperand(const Value *Op, bool PrintType);
2909 void writeParamOperand(const Value *Operand, AttributeSet Attrs);
2910 void writeOperandBundles(const CallBase *Call);
2911 void writeSyncScope(const LLVMContext &Context,
2912 SyncScope::ID SSID);
2913 void writeAtomic(const LLVMContext &Context,
2914 AtomicOrdering Ordering,
2915 SyncScope::ID SSID);
2916 void writeAtomicCmpXchg(const LLVMContext &Context,
2917 AtomicOrdering SuccessOrdering,
2918 AtomicOrdering FailureOrdering,
2919 SyncScope::ID SSID);
2920
2921 void writeAllMDNodes();
2922 void writeMDNode(unsigned Slot, const MDNode *Node);
2923 void writeAttribute(const Attribute &Attr, bool InAttrGroup = false);
2924 void writeAttributeSet(const AttributeSet &AttrSet, bool InAttrGroup = false);
2925 void writeAllAttributeGroups();
2926
2927 void printTypeIdentities();
2928 void printGlobal(const GlobalVariable *GV);
2929 void printAlias(const GlobalAlias *GA);
2930 void printIFunc(const GlobalIFunc *GI);
2931 void printComdat(const Comdat *C);
2932 void printFunction(const Function *F);
2933 void printArgument(const Argument *FA, AttributeSet Attrs);
2934 void printBasicBlock(const BasicBlock *BB);
2935 void printInstructionLine(const Instruction &I);
2936 void printInstruction(const Instruction &I);
2937 void printDbgMarker(const DbgMarker &DPI);
2938 void printDbgVariableRecord(const DbgVariableRecord &DVR);
2939 void printDbgLabelRecord(const DbgLabelRecord &DLR);
2940 void printDbgRecord(const DbgRecord &DR);
2941 void printDbgRecordLine(const DbgRecord &DR);
2942
2943 void printUseListOrder(const Value *V, ArrayRef<unsigned> Shuffle);
2944 void printUseLists(const Function *F);
2945
2946 void printModuleSummaryIndex();
2947 void printSummaryInfo(unsigned Slot, const ValueInfo &VI);
2948 void printSummary(const GlobalValueSummary &Summary);
2949 void printAliasSummary(const AliasSummary *AS);
2950 void printGlobalVarSummary(const GlobalVarSummary *GS);
2951 void printFunctionSummary(const FunctionSummary *FS);
2952 void printTypeIdSummary(const TypeIdSummary &TIS);
2953 void printTypeIdCompatibleVtableSummary(const TypeIdCompatibleVtableInfo &TI);
2954 void printTypeTestResolution(const TypeTestResolution &TTRes);
2955 void printArgs(ArrayRef<uint64_t> Args);
2956 void printWPDRes(const WholeProgramDevirtResolution &WPDRes);
2957 void printTypeIdInfo(const FunctionSummary::TypeIdInfo &TIDInfo);
2958 void printVFuncId(const FunctionSummary::VFuncId VFId);
2959 void printNonConstVCalls(ArrayRef<FunctionSummary::VFuncId> VCallList,
2960 const char *Tag);
2961 void printConstVCalls(ArrayRef<FunctionSummary::ConstVCall> VCallList,
2962 const char *Tag);
2963
2964private:
2965 /// Print out metadata attachments.
2966 void printMetadataAttachments(
2967 const SmallVectorImpl<std::pair<unsigned, MDNode *>> &MDs,
2968 StringRef Separator);
2969
2970 // printInfoComment - Print a little comment after the instruction indicating
2971 // which slot it occupies.
2972 void printInfoComment(const Value &V, bool isMaterializable = false);
2973
2974 // printGCRelocateComment - print comment after call to the gc.relocate
2975 // intrinsic indicating base and derived pointer names.
2976 void printGCRelocateComment(const GCRelocateInst &Relocate);
2977};
2978
2979} // end anonymous namespace
2980
2981AssemblyWriter::AssemblyWriter(formatted_raw_ostream &o, SlotTracker &Mac,
2982 const Module *M, AssemblyAnnotationWriter *AAW,
2983 bool IsForDebug, bool ShouldPreserveUseListOrder)
2984 : Out(o), TheModule(M), Machine(Mac), TypePrinter(M), AnnotationWriter(AAW),
2985 IsForDebug(IsForDebug),
2986 ShouldPreserveUseListOrder(
2987 PreserveAssemblyUseListOrder.getNumOccurrences()
2988 ? PreserveAssemblyUseListOrder
2989 : ShouldPreserveUseListOrder) {
2990 if (!TheModule)
2991 return;
2992 for (const GlobalObject &GO : TheModule->global_objects())
2993 if (const Comdat *C = GO.getComdat())
2994 Comdats.insert(X: C);
2995}
2996
2997AssemblyWriter::AssemblyWriter(formatted_raw_ostream &o, SlotTracker &Mac,
2998 const ModuleSummaryIndex *Index, bool IsForDebug)
2999 : Out(o), TheIndex(Index), Machine(Mac), TypePrinter(/*Module=*/nullptr),
3000 IsForDebug(IsForDebug),
3001 ShouldPreserveUseListOrder(PreserveAssemblyUseListOrder) {}
3002
3003void AssemblyWriter::writeOperand(const Value *Operand, bool PrintType) {
3004 if (!Operand) {
3005 Out << "<null operand!>";
3006 return;
3007 }
3008 auto WriteCtx = getContext();
3009 writeAsOperandInternal(Out, V: Operand, WriterCtx&: WriteCtx, PrintType);
3010}
3011
3012void AssemblyWriter::writeSyncScope(const LLVMContext &Context,
3013 SyncScope::ID SSID) {
3014 switch (SSID) {
3015 case SyncScope::System: {
3016 break;
3017 }
3018 default: {
3019 if (SSNs.empty())
3020 Context.getSyncScopeNames(SSNs);
3021
3022 Out << " syncscope(\"";
3023 printEscapedString(Name: SSNs[SSID], Out);
3024 Out << "\")";
3025 break;
3026 }
3027 }
3028}
3029
3030void AssemblyWriter::writeAtomic(const LLVMContext &Context,
3031 AtomicOrdering Ordering,
3032 SyncScope::ID SSID) {
3033 if (Ordering == AtomicOrdering::NotAtomic)
3034 return;
3035
3036 writeSyncScope(Context, SSID);
3037 Out << " " << toIRString(ao: Ordering);
3038}
3039
3040void AssemblyWriter::writeAtomicCmpXchg(const LLVMContext &Context,
3041 AtomicOrdering SuccessOrdering,
3042 AtomicOrdering FailureOrdering,
3043 SyncScope::ID SSID) {
3044 assert(SuccessOrdering != AtomicOrdering::NotAtomic &&
3045 FailureOrdering != AtomicOrdering::NotAtomic);
3046
3047 writeSyncScope(Context, SSID);
3048 Out << " " << toIRString(ao: SuccessOrdering);
3049 Out << " " << toIRString(ao: FailureOrdering);
3050}
3051
3052void AssemblyWriter::writeParamOperand(const Value *Operand,
3053 AttributeSet Attrs) {
3054 if (!Operand) {
3055 Out << "<null operand!>";
3056 return;
3057 }
3058
3059 // Print the type
3060 TypePrinter.print(Ty: Operand->getType(), OS&: Out);
3061 // Print parameter attributes list
3062 if (Attrs.hasAttributes()) {
3063 Out << ' ';
3064 writeAttributeSet(AttrSet: Attrs);
3065 }
3066 Out << ' ';
3067 // Print the operand
3068 auto WriterCtx = getContext();
3069 writeAsOperandInternal(Out, V: Operand, WriterCtx);
3070}
3071
3072void AssemblyWriter::writeOperandBundles(const CallBase *Call) {
3073 if (!Call->hasOperandBundles())
3074 return;
3075
3076 Out << " [ ";
3077
3078 ListSeparator LS;
3079 for (unsigned i = 0, e = Call->getNumOperandBundles(); i != e; ++i) {
3080 OperandBundleUse BU = Call->getOperandBundleAt(Index: i);
3081
3082 Out << LS << '"';
3083 printEscapedString(Name: BU.getTagName(), Out);
3084 Out << '"';
3085
3086 Out << '(';
3087
3088 ListSeparator InnerLS;
3089 auto WriterCtx = getContext();
3090 for (const auto &Input : BU.Inputs) {
3091 Out << InnerLS;
3092 if (Input == nullptr)
3093 Out << "<null operand bundle!>";
3094 else
3095 writeAsOperandInternal(Out, V: Input, WriterCtx, /*PrintType=*/true);
3096 }
3097
3098 Out << ')';
3099 }
3100
3101 Out << " ]";
3102}
3103
3104void AssemblyWriter::printModule(const Module *M) {
3105 Machine.initializeIfNeeded();
3106
3107 if (ShouldPreserveUseListOrder)
3108 UseListOrders = predictUseListOrder(M);
3109
3110 if (!M->getModuleIdentifier().empty() &&
3111 // Don't print the ID if it will start a new line (which would
3112 // require a comment char before it).
3113 M->getModuleIdentifier().find(c: '\n') == std::string::npos)
3114 Out << "; ModuleID = '" << M->getModuleIdentifier() << "'\n";
3115
3116 if (!M->getSourceFileName().empty()) {
3117 Out << "source_filename = \"";
3118 printEscapedString(Name: M->getSourceFileName(), Out);
3119 Out << "\"\n";
3120 }
3121
3122 const std::string &DL = M->getDataLayoutStr();
3123 if (!DL.empty())
3124 Out << "target datalayout = \"" << DL << "\"\n";
3125 if (!M->getTargetTriple().empty())
3126 Out << "target triple = \"" << M->getTargetTriple().str() << "\"\n";
3127
3128 if (!M->getModuleInlineAsm().empty()) {
3129 Out << '\n';
3130
3131 // Split the string into lines, to make it easier to read the .ll file.
3132 StringRef Asm = M->getModuleInlineAsm();
3133 do {
3134 StringRef Front;
3135 std::tie(args&: Front, args&: Asm) = Asm.split(Separator: '\n');
3136
3137 // We found a newline, print the portion of the asm string from the
3138 // last newline up to this newline.
3139 Out << "module asm \"";
3140 printEscapedString(Name: Front, Out);
3141 Out << "\"\n";
3142 } while (!Asm.empty());
3143 }
3144
3145 printTypeIdentities();
3146
3147 // Output all comdats.
3148 if (!Comdats.empty())
3149 Out << '\n';
3150 for (const Comdat *C : Comdats) {
3151 printComdat(C);
3152 if (C != Comdats.back())
3153 Out << '\n';
3154 }
3155
3156 // Output all globals.
3157 if (!M->global_empty()) Out << '\n';
3158 for (const GlobalVariable &GV : M->globals()) {
3159 printGlobal(GV: &GV); Out << '\n';
3160 }
3161
3162 // Output all aliases.
3163 if (!M->alias_empty()) Out << "\n";
3164 for (const GlobalAlias &GA : M->aliases())
3165 printAlias(GA: &GA);
3166
3167 // Output all ifuncs.
3168 if (!M->ifunc_empty()) Out << "\n";
3169 for (const GlobalIFunc &GI : M->ifuncs())
3170 printIFunc(GI: &GI);
3171
3172 // Output all of the functions.
3173 for (const Function &F : *M) {
3174 Out << '\n';
3175 printFunction(F: &F);
3176 }
3177
3178 // Output global use-lists.
3179 printUseLists(F: nullptr);
3180
3181 // Output all attribute groups.
3182 if (!Machine.as_empty()) {
3183 Out << '\n';
3184 writeAllAttributeGroups();
3185 }
3186
3187 // Output named metadata.
3188 if (!M->named_metadata_empty()) Out << '\n';
3189
3190 for (const NamedMDNode &Node : M->named_metadata())
3191 printNamedMDNode(NMD: &Node);
3192
3193 // Output metadata.
3194 if (!Machine.mdn_empty()) {
3195 Out << '\n';
3196 writeAllMDNodes();
3197 }
3198}
3199
3200void AssemblyWriter::printModuleSummaryIndex() {
3201 assert(TheIndex);
3202 int NumSlots = Machine.initializeIndexIfNeeded();
3203
3204 Out << "\n";
3205
3206 // Print module path entries. To print in order, add paths to a vector
3207 // indexed by module slot.
3208 std::vector<std::pair<std::string, ModuleHash>> moduleVec;
3209 std::string RegularLTOModuleName =
3210 ModuleSummaryIndex::getRegularLTOModuleName();
3211 moduleVec.resize(new_size: TheIndex->modulePaths().size());
3212 for (auto &[ModPath, ModHash] : TheIndex->modulePaths())
3213 moduleVec[Machine.getModulePathSlot(Path: ModPath)] = std::make_pair(
3214 // An empty module path is a special entry for a regular LTO module
3215 // created during the thin link.
3216 x: ModPath.empty() ? RegularLTOModuleName : std::string(ModPath), y: ModHash);
3217
3218 unsigned i = 0;
3219 for (auto &ModPair : moduleVec) {
3220 Out << "^" << i++ << " = module: (";
3221 Out << "path: \"";
3222 printEscapedString(Name: ModPair.first, Out);
3223 Out << "\", hash: (";
3224 ListSeparator FS;
3225 for (auto Hash : ModPair.second)
3226 Out << FS << Hash;
3227 Out << "))\n";
3228 }
3229
3230 // FIXME: Change AliasSummary to hold a ValueInfo instead of summary pointer
3231 // for aliasee (then update BitcodeWriter.cpp and remove get/setAliaseeGUID).
3232 for (auto &GlobalList : *TheIndex) {
3233 auto GUID = GlobalList.first;
3234 for (auto &Summary : GlobalList.second.getSummaryList())
3235 SummaryToGUIDMap[Summary.get()] = GUID;
3236 }
3237
3238 // Print the global value summary entries.
3239 for (auto &GlobalList : *TheIndex) {
3240 auto GUID = GlobalList.first;
3241 auto VI = TheIndex->getValueInfo(R: GlobalList);
3242 printSummaryInfo(Slot: Machine.getGUIDSlot(GUID), VI);
3243 }
3244
3245 // Print the TypeIdMap entries.
3246 for (const auto &TID : TheIndex->typeIds()) {
3247 Out << "^" << Machine.getTypeIdSlot(Id: TID.second.first)
3248 << " = typeid: (name: \"" << TID.second.first << "\"";
3249 printTypeIdSummary(TIS: TID.second.second);
3250 Out << ") ; guid = " << TID.first << "\n";
3251 }
3252
3253 // Print the TypeIdCompatibleVtableMap entries.
3254 for (auto &TId : TheIndex->typeIdCompatibleVtableMap()) {
3255 auto GUID = GlobalValue::getGUIDAssumingExternalLinkage(GlobalName: TId.first);
3256 Out << "^" << Machine.getTypeIdCompatibleVtableSlot(Id: TId.first)
3257 << " = typeidCompatibleVTable: (name: \"" << TId.first << "\"";
3258 printTypeIdCompatibleVtableSummary(TI: TId.second);
3259 Out << ") ; guid = " << GUID << "\n";
3260 }
3261
3262 // Don't emit flags when it's not really needed (value is zero by default).
3263 if (TheIndex->getFlags()) {
3264 Out << "^" << NumSlots << " = flags: " << TheIndex->getFlags() << "\n";
3265 ++NumSlots;
3266 }
3267
3268 Out << "^" << NumSlots << " = blockcount: " << TheIndex->getBlockCount()
3269 << "\n";
3270}
3271
3272static const char *
3273getWholeProgDevirtResKindName(WholeProgramDevirtResolution::Kind K) {
3274 switch (K) {
3275 case WholeProgramDevirtResolution::Indir:
3276 return "indir";
3277 case WholeProgramDevirtResolution::SingleImpl:
3278 return "singleImpl";
3279 case WholeProgramDevirtResolution::BranchFunnel:
3280 return "branchFunnel";
3281 }
3282 llvm_unreachable("invalid WholeProgramDevirtResolution kind");
3283}
3284
3285static const char *getWholeProgDevirtResByArgKindName(
3286 WholeProgramDevirtResolution::ByArg::Kind K) {
3287 switch (K) {
3288 case WholeProgramDevirtResolution::ByArg::Indir:
3289 return "indir";
3290 case WholeProgramDevirtResolution::ByArg::UniformRetVal:
3291 return "uniformRetVal";
3292 case WholeProgramDevirtResolution::ByArg::UniqueRetVal:
3293 return "uniqueRetVal";
3294 case WholeProgramDevirtResolution::ByArg::VirtualConstProp:
3295 return "virtualConstProp";
3296 }
3297 llvm_unreachable("invalid WholeProgramDevirtResolution::ByArg kind");
3298}
3299
3300static const char *getTTResKindName(TypeTestResolution::Kind K) {
3301 switch (K) {
3302 case TypeTestResolution::Unknown:
3303 return "unknown";
3304 case TypeTestResolution::Unsat:
3305 return "unsat";
3306 case TypeTestResolution::ByteArray:
3307 return "byteArray";
3308 case TypeTestResolution::Inline:
3309 return "inline";
3310 case TypeTestResolution::Single:
3311 return "single";
3312 case TypeTestResolution::AllOnes:
3313 return "allOnes";
3314 }
3315 llvm_unreachable("invalid TypeTestResolution kind");
3316}
3317
3318void AssemblyWriter::printTypeTestResolution(const TypeTestResolution &TTRes) {
3319 Out << "typeTestRes: (kind: " << getTTResKindName(K: TTRes.TheKind)
3320 << ", sizeM1BitWidth: " << TTRes.SizeM1BitWidth;
3321
3322 // The following fields are only used if the target does not support the use
3323 // of absolute symbols to store constants. Print only if non-zero.
3324 if (TTRes.AlignLog2)
3325 Out << ", alignLog2: " << TTRes.AlignLog2;
3326 if (TTRes.SizeM1)
3327 Out << ", sizeM1: " << TTRes.SizeM1;
3328 if (TTRes.BitMask)
3329 // BitMask is uint8_t which causes it to print the corresponding char.
3330 Out << ", bitMask: " << (unsigned)TTRes.BitMask;
3331 if (TTRes.InlineBits)
3332 Out << ", inlineBits: " << TTRes.InlineBits;
3333
3334 Out << ")";
3335}
3336
3337void AssemblyWriter::printTypeIdSummary(const TypeIdSummary &TIS) {
3338 Out << ", summary: (";
3339 printTypeTestResolution(TTRes: TIS.TTRes);
3340 if (!TIS.WPDRes.empty()) {
3341 Out << ", wpdResolutions: (";
3342 ListSeparator FS;
3343 for (auto &WPDRes : TIS.WPDRes) {
3344 Out << FS;
3345 Out << "(offset: " << WPDRes.first << ", ";
3346 printWPDRes(WPDRes: WPDRes.second);
3347 Out << ")";
3348 }
3349 Out << ")";
3350 }
3351 Out << ")";
3352}
3353
3354void AssemblyWriter::printTypeIdCompatibleVtableSummary(
3355 const TypeIdCompatibleVtableInfo &TI) {
3356 Out << ", summary: (";
3357 ListSeparator FS;
3358 for (auto &P : TI) {
3359 Out << FS;
3360 Out << "(offset: " << P.AddressPointOffset << ", ";
3361 Out << "^" << Machine.getGUIDSlot(GUID: P.VTableVI.getGUID());
3362 Out << ")";
3363 }
3364 Out << ")";
3365}
3366
3367void AssemblyWriter::printArgs(ArrayRef<uint64_t> Args) {
3368 Out << "args: (" << llvm::interleaved(R: Args) << ')';
3369}
3370
3371void AssemblyWriter::printWPDRes(const WholeProgramDevirtResolution &WPDRes) {
3372 Out << "wpdRes: (kind: ";
3373 Out << getWholeProgDevirtResKindName(K: WPDRes.TheKind);
3374
3375 if (WPDRes.TheKind == WholeProgramDevirtResolution::SingleImpl)
3376 Out << ", singleImplName: \"" << WPDRes.SingleImplName << "\"";
3377
3378 if (!WPDRes.ResByArg.empty()) {
3379 Out << ", resByArg: (";
3380 ListSeparator FS;
3381 for (auto &ResByArg : WPDRes.ResByArg) {
3382 Out << FS;
3383 printArgs(Args: ResByArg.first);
3384 Out << ", byArg: (kind: ";
3385 Out << getWholeProgDevirtResByArgKindName(K: ResByArg.second.TheKind);
3386 if (ResByArg.second.TheKind ==
3387 WholeProgramDevirtResolution::ByArg::UniformRetVal ||
3388 ResByArg.second.TheKind ==
3389 WholeProgramDevirtResolution::ByArg::UniqueRetVal)
3390 Out << ", info: " << ResByArg.second.Info;
3391
3392 // The following fields are only used if the target does not support the
3393 // use of absolute symbols to store constants. Print only if non-zero.
3394 if (ResByArg.second.Byte || ResByArg.second.Bit)
3395 Out << ", byte: " << ResByArg.second.Byte
3396 << ", bit: " << ResByArg.second.Bit;
3397
3398 Out << ")";
3399 }
3400 Out << ")";
3401 }
3402 Out << ")";
3403}
3404
3405static const char *getSummaryKindName(GlobalValueSummary::SummaryKind SK) {
3406 switch (SK) {
3407 case GlobalValueSummary::AliasKind:
3408 return "alias";
3409 case GlobalValueSummary::FunctionKind:
3410 return "function";
3411 case GlobalValueSummary::GlobalVarKind:
3412 return "variable";
3413 }
3414 llvm_unreachable("invalid summary kind");
3415}
3416
3417void AssemblyWriter::printAliasSummary(const AliasSummary *AS) {
3418 Out << ", aliasee: ";
3419 // The indexes emitted for distributed backends may not include the
3420 // aliasee summary (only if it is being imported directly). Handle
3421 // that case by just emitting "null" as the aliasee.
3422 if (AS->hasAliasee())
3423 Out << "^" << Machine.getGUIDSlot(GUID: SummaryToGUIDMap[&AS->getAliasee()]);
3424 else
3425 Out << "null";
3426}
3427
3428void AssemblyWriter::printGlobalVarSummary(const GlobalVarSummary *GS) {
3429 auto VTableFuncs = GS->vTableFuncs();
3430 Out << ", varFlags: (readonly: " << GS->VarFlags.MaybeReadOnly << ", "
3431 << "writeonly: " << GS->VarFlags.MaybeWriteOnly << ", "
3432 << "constant: " << GS->VarFlags.Constant;
3433 if (!VTableFuncs.empty())
3434 Out << ", "
3435 << "vcall_visibility: " << GS->VarFlags.VCallVisibility;
3436 Out << ")";
3437
3438 if (!VTableFuncs.empty()) {
3439 Out << ", vTableFuncs: (";
3440 ListSeparator FS;
3441 for (auto &P : VTableFuncs) {
3442 Out << FS;
3443 Out << "(virtFunc: ^" << Machine.getGUIDSlot(GUID: P.FuncVI.getGUID())
3444 << ", offset: " << P.VTableOffset;
3445 Out << ")";
3446 }
3447 Out << ")";
3448 }
3449}
3450
3451static std::string getLinkageName(GlobalValue::LinkageTypes LT) {
3452 switch (LT) {
3453 case GlobalValue::ExternalLinkage:
3454 return "external";
3455 case GlobalValue::PrivateLinkage:
3456 return "private";
3457 case GlobalValue::InternalLinkage:
3458 return "internal";
3459 case GlobalValue::LinkOnceAnyLinkage:
3460 return "linkonce";
3461 case GlobalValue::LinkOnceODRLinkage:
3462 return "linkonce_odr";
3463 case GlobalValue::WeakAnyLinkage:
3464 return "weak";
3465 case GlobalValue::WeakODRLinkage:
3466 return "weak_odr";
3467 case GlobalValue::CommonLinkage:
3468 return "common";
3469 case GlobalValue::AppendingLinkage:
3470 return "appending";
3471 case GlobalValue::ExternalWeakLinkage:
3472 return "extern_weak";
3473 case GlobalValue::AvailableExternallyLinkage:
3474 return "available_externally";
3475 }
3476 llvm_unreachable("invalid linkage");
3477}
3478
3479// When printing the linkage types in IR where the ExternalLinkage is
3480// not printed, and other linkage types are expected to be printed with
3481// a space after the name.
3482static std::string getLinkageNameWithSpace(GlobalValue::LinkageTypes LT) {
3483 if (LT == GlobalValue::ExternalLinkage)
3484 return "";
3485 return getLinkageName(LT) + " ";
3486}
3487
3488static const char *getVisibilityName(GlobalValue::VisibilityTypes Vis) {
3489 switch (Vis) {
3490 case GlobalValue::DefaultVisibility:
3491 return "default";
3492 case GlobalValue::HiddenVisibility:
3493 return "hidden";
3494 case GlobalValue::ProtectedVisibility:
3495 return "protected";
3496 }
3497 llvm_unreachable("invalid visibility");
3498}
3499
3500static const char *getImportTypeName(GlobalValueSummary::ImportKind IK) {
3501 switch (IK) {
3502 case GlobalValueSummary::Definition:
3503 return "definition";
3504 case GlobalValueSummary::Declaration:
3505 return "declaration";
3506 }
3507 llvm_unreachable("invalid import kind");
3508}
3509
3510void AssemblyWriter::printFunctionSummary(const FunctionSummary *FS) {
3511 Out << ", insts: " << FS->instCount();
3512 if (FS->fflags().anyFlagSet())
3513 Out << ", " << FS->fflags();
3514
3515 if (!FS->calls().empty()) {
3516 Out << ", calls: (";
3517 ListSeparator IFS;
3518 for (auto &Call : FS->calls()) {
3519 Out << IFS;
3520 Out << "(callee: ^" << Machine.getGUIDSlot(GUID: Call.first.getGUID());
3521 if (Call.second.getHotness() != CalleeInfo::HotnessType::Unknown)
3522 Out << ", hotness: " << getHotnessName(HT: Call.second.getHotness());
3523 // Follow the convention of emitting flags as a boolean value, but only
3524 // emit if true to avoid unnecessary verbosity and test churn.
3525 if (Call.second.HasTailCall)
3526 Out << ", tail: 1";
3527 Out << ")";
3528 }
3529 Out << ")";
3530 }
3531
3532 if (const auto *TIdInfo = FS->getTypeIdInfo())
3533 printTypeIdInfo(TIDInfo: *TIdInfo);
3534
3535 // The AllocationType identifiers capture the profiled context behavior
3536 // reaching a specific static allocation site (possibly cloned).
3537 auto AllocTypeName = [](uint8_t Type) -> const char * {
3538 switch (Type) {
3539 case (uint8_t)AllocationType::None:
3540 return "none";
3541 case (uint8_t)AllocationType::NotCold:
3542 return "notcold";
3543 case (uint8_t)AllocationType::Cold:
3544 return "cold";
3545 case (uint8_t)AllocationType::Hot:
3546 return "hot";
3547 }
3548 llvm_unreachable("Unexpected alloc type");
3549 };
3550
3551 if (!FS->allocs().empty()) {
3552 Out << ", allocs: (";
3553 ListSeparator AFS;
3554 for (auto &AI : FS->allocs()) {
3555 Out << AFS;
3556 Out << "(versions: (";
3557 ListSeparator VFS;
3558 for (auto V : AI.Versions) {
3559 Out << VFS;
3560 Out << AllocTypeName(V);
3561 }
3562 Out << "), memProf: (";
3563 ListSeparator MIBFS;
3564 for (auto &MIB : AI.MIBs) {
3565 Out << MIBFS;
3566 Out << "(type: " << AllocTypeName((uint8_t)MIB.AllocType);
3567 Out << ", stackIds: (";
3568 ListSeparator SIDFS;
3569 for (auto Id : MIB.StackIdIndices) {
3570 Out << SIDFS;
3571 Out << TheIndex->getStackIdAtIndex(Index: Id);
3572 }
3573 Out << "))";
3574 }
3575 Out << "))";
3576 }
3577 Out << ")";
3578 }
3579
3580 if (!FS->callsites().empty()) {
3581 Out << ", callsites: (";
3582 ListSeparator SNFS;
3583 for (auto &CI : FS->callsites()) {
3584 Out << SNFS;
3585 if (CI.Callee)
3586 Out << "(callee: ^" << Machine.getGUIDSlot(GUID: CI.Callee.getGUID());
3587 else
3588 Out << "(callee: null";
3589 Out << ", clones: (";
3590 ListSeparator VFS;
3591 for (auto V : CI.Clones) {
3592 Out << VFS;
3593 Out << V;
3594 }
3595 Out << "), stackIds: (";
3596 ListSeparator SIDFS;
3597 for (auto Id : CI.StackIdIndices) {
3598 Out << SIDFS;
3599 Out << TheIndex->getStackIdAtIndex(Index: Id);
3600 }
3601 Out << "))";
3602 }
3603 Out << ")";
3604 }
3605
3606 auto PrintRange = [&](const ConstantRange &Range) {
3607 Out << "[" << Range.getSignedMin() << ", " << Range.getSignedMax() << "]";
3608 };
3609
3610 if (!FS->paramAccesses().empty()) {
3611 Out << ", params: (";
3612 ListSeparator IFS;
3613 for (auto &PS : FS->paramAccesses()) {
3614 Out << IFS;
3615 Out << "(param: " << PS.ParamNo;
3616 Out << ", offset: ";
3617 PrintRange(PS.Use);
3618 if (!PS.Calls.empty()) {
3619 Out << ", calls: (";
3620 ListSeparator IFS;
3621 for (auto &Call : PS.Calls) {
3622 Out << IFS;
3623 Out << "(callee: ^" << Machine.getGUIDSlot(GUID: Call.Callee.getGUID());
3624 Out << ", param: " << Call.ParamNo;
3625 Out << ", offset: ";
3626 PrintRange(Call.Offsets);
3627 Out << ")";
3628 }
3629 Out << ")";
3630 }
3631 Out << ")";
3632 }
3633 Out << ")";
3634 }
3635}
3636
3637void AssemblyWriter::printTypeIdInfo(
3638 const FunctionSummary::TypeIdInfo &TIDInfo) {
3639 Out << ", typeIdInfo: (";
3640 ListSeparator TIDFS;
3641 if (!TIDInfo.TypeTests.empty()) {
3642 Out << TIDFS;
3643 Out << "typeTests: (";
3644 ListSeparator FS;
3645 for (auto &GUID : TIDInfo.TypeTests) {
3646 auto TidIter = TheIndex->typeIds().equal_range(x: GUID);
3647 if (TidIter.first == TidIter.second) {
3648 Out << FS;
3649 Out << GUID;
3650 continue;
3651 }
3652 // Print all type id that correspond to this GUID.
3653 for (const auto &[GUID, TypeIdPair] : make_range(p: TidIter)) {
3654 Out << FS;
3655 auto Slot = Machine.getTypeIdSlot(Id: TypeIdPair.first);
3656 assert(Slot != -1);
3657 Out << "^" << Slot;
3658 }
3659 }
3660 Out << ")";
3661 }
3662 if (!TIDInfo.TypeTestAssumeVCalls.empty()) {
3663 Out << TIDFS;
3664 printNonConstVCalls(VCallList: TIDInfo.TypeTestAssumeVCalls, Tag: "typeTestAssumeVCalls");
3665 }
3666 if (!TIDInfo.TypeCheckedLoadVCalls.empty()) {
3667 Out << TIDFS;
3668 printNonConstVCalls(VCallList: TIDInfo.TypeCheckedLoadVCalls, Tag: "typeCheckedLoadVCalls");
3669 }
3670 if (!TIDInfo.TypeTestAssumeConstVCalls.empty()) {
3671 Out << TIDFS;
3672 printConstVCalls(VCallList: TIDInfo.TypeTestAssumeConstVCalls,
3673 Tag: "typeTestAssumeConstVCalls");
3674 }
3675 if (!TIDInfo.TypeCheckedLoadConstVCalls.empty()) {
3676 Out << TIDFS;
3677 printConstVCalls(VCallList: TIDInfo.TypeCheckedLoadConstVCalls,
3678 Tag: "typeCheckedLoadConstVCalls");
3679 }
3680 Out << ")";
3681}
3682
3683void AssemblyWriter::printVFuncId(const FunctionSummary::VFuncId VFId) {
3684 auto TidIter = TheIndex->typeIds().equal_range(x: VFId.GUID);
3685 if (TidIter.first == TidIter.second) {
3686 Out << "vFuncId: (";
3687 Out << "guid: " << VFId.GUID;
3688 Out << ", offset: " << VFId.Offset;
3689 Out << ")";
3690 return;
3691 }
3692 // Print all type id that correspond to this GUID.
3693 ListSeparator FS;
3694 for (const auto &[GUID, TypeIdPair] : make_range(p: TidIter)) {
3695 Out << FS;
3696 Out << "vFuncId: (";
3697 auto Slot = Machine.getTypeIdSlot(Id: TypeIdPair.first);
3698 assert(Slot != -1);
3699 Out << "^" << Slot;
3700 Out << ", offset: " << VFId.Offset;
3701 Out << ")";
3702 }
3703}
3704
3705void AssemblyWriter::printNonConstVCalls(
3706 ArrayRef<FunctionSummary::VFuncId> VCallList, const char *Tag) {
3707 Out << Tag << ": (";
3708 ListSeparator FS;
3709 for (auto &VFuncId : VCallList) {
3710 Out << FS;
3711 printVFuncId(VFId: VFuncId);
3712 }
3713 Out << ")";
3714}
3715
3716void AssemblyWriter::printConstVCalls(
3717 ArrayRef<FunctionSummary::ConstVCall> VCallList, const char *Tag) {
3718 Out << Tag << ": (";
3719 ListSeparator FS;
3720 for (auto &ConstVCall : VCallList) {
3721 Out << FS;
3722 Out << "(";
3723 printVFuncId(VFId: ConstVCall.VFunc);
3724 if (!ConstVCall.Args.empty()) {
3725 Out << ", ";
3726 printArgs(Args: ConstVCall.Args);
3727 }
3728 Out << ")";
3729 }
3730 Out << ")";
3731}
3732
3733void AssemblyWriter::printSummary(const GlobalValueSummary &Summary) {
3734 GlobalValueSummary::GVFlags GVFlags = Summary.flags();
3735 GlobalValue::LinkageTypes LT = (GlobalValue::LinkageTypes)GVFlags.Linkage;
3736 Out << getSummaryKindName(SK: Summary.getSummaryKind()) << ": ";
3737 Out << "(module: ^" << Machine.getModulePathSlot(Path: Summary.modulePath())
3738 << ", flags: (";
3739 Out << "linkage: " << getLinkageName(LT);
3740 Out << ", visibility: "
3741 << getVisibilityName(Vis: (GlobalValue::VisibilityTypes)GVFlags.Visibility);
3742 Out << ", notEligibleToImport: " << GVFlags.NotEligibleToImport;
3743 Out << ", live: " << GVFlags.Live;
3744 Out << ", dsoLocal: " << GVFlags.DSOLocal;
3745 Out << ", canAutoHide: " << GVFlags.CanAutoHide;
3746 Out << ", importType: "
3747 << getImportTypeName(IK: GlobalValueSummary::ImportKind(GVFlags.ImportType));
3748 Out << ", noRenameOnPromotion: " << GVFlags.NoRenameOnPromotion;
3749 Out << ")";
3750
3751 if (Summary.getSummaryKind() == GlobalValueSummary::AliasKind)
3752 printAliasSummary(AS: cast<AliasSummary>(Val: &Summary));
3753 else if (Summary.getSummaryKind() == GlobalValueSummary::FunctionKind)
3754 printFunctionSummary(FS: cast<FunctionSummary>(Val: &Summary));
3755 else
3756 printGlobalVarSummary(GS: cast<GlobalVarSummary>(Val: &Summary));
3757
3758 auto RefList = Summary.refs();
3759 if (!RefList.empty()) {
3760 Out << ", refs: (";
3761 ListSeparator FS;
3762 for (auto &Ref : RefList) {
3763 Out << FS;
3764 if (Ref.isReadOnly())
3765 Out << "readonly ";
3766 else if (Ref.isWriteOnly())
3767 Out << "writeonly ";
3768 Out << "^" << Machine.getGUIDSlot(GUID: Ref.getGUID());
3769 }
3770 Out << ")";
3771 }
3772
3773 Out << ")";
3774}
3775
3776void AssemblyWriter::printSummaryInfo(unsigned Slot, const ValueInfo &VI) {
3777 Out << "^" << Slot << " = gv: (";
3778 if (VI.hasName() && !VI.name().empty())
3779 Out << "name: \"" << VI.name() << "\"";
3780 else
3781 Out << "guid: " << VI.getGUID();
3782 if (!VI.getSummaryList().empty()) {
3783 Out << ", summaries: (";
3784 ListSeparator FS;
3785 for (auto &Summary : VI.getSummaryList()) {
3786 Out << FS;
3787 printSummary(Summary: *Summary);
3788 }
3789 Out << ")";
3790 }
3791 Out << ")";
3792 if (VI.hasName() && !VI.name().empty())
3793 Out << " ; guid = " << VI.getGUID();
3794 Out << "\n";
3795}
3796
3797static void printMetadataIdentifier(StringRef Name,
3798 formatted_raw_ostream &Out) {
3799 if (Name.empty()) {
3800 Out << "<empty name> ";
3801 } else {
3802 unsigned char FirstC = static_cast<unsigned char>(Name[0]);
3803 if (isalpha(FirstC) || FirstC == '-' || FirstC == '$' || FirstC == '.' ||
3804 FirstC == '_')
3805 Out << FirstC;
3806 else
3807 Out << '\\' << hexdigit(X: FirstC >> 4) << hexdigit(X: FirstC & 0x0F);
3808 for (unsigned i = 1, e = Name.size(); i != e; ++i) {
3809 unsigned char C = Name[i];
3810 if (isalnum(C) || C == '-' || C == '$' || C == '.' || C == '_')
3811 Out << C;
3812 else
3813 Out << '\\' << hexdigit(X: C >> 4) << hexdigit(X: C & 0x0F);
3814 }
3815 }
3816}
3817
3818void AssemblyWriter::printNamedMDNode(const NamedMDNode *NMD) {
3819 Out << '!';
3820 printMetadataIdentifier(Name: NMD->getName(), Out);
3821 Out << " = !{";
3822 ListSeparator LS;
3823 for (const MDNode *Op : NMD->operands()) {
3824 Out << LS;
3825 // Write DIExpressions inline.
3826 // FIXME: Ban DIExpressions in NamedMDNodes, they will serve no purpose.
3827 if (auto *Expr = dyn_cast<DIExpression>(Val: Op)) {
3828 writeDIExpression(Out, N: Expr, WriterCtx&: AsmWriterContext::getEmpty());
3829 continue;
3830 }
3831
3832 int Slot = Machine.getMetadataSlot(N: Op);
3833 if (Slot == -1)
3834 Out << "<badref>";
3835 else
3836 Out << '!' << Slot;
3837 }
3838 Out << "}\n";
3839}
3840
3841static void printVisibility(GlobalValue::VisibilityTypes Vis,
3842 formatted_raw_ostream &Out) {
3843 switch (Vis) {
3844 case GlobalValue::DefaultVisibility: break;
3845 case GlobalValue::HiddenVisibility: Out << "hidden "; break;
3846 case GlobalValue::ProtectedVisibility: Out << "protected "; break;
3847 }
3848}
3849
3850static void printDSOLocation(const GlobalValue &GV,
3851 formatted_raw_ostream &Out) {
3852 if (GV.isDSOLocal() && !GV.isImplicitDSOLocal())
3853 Out << "dso_local ";
3854}
3855
3856static void printDLLStorageClass(GlobalValue::DLLStorageClassTypes SCT,
3857 formatted_raw_ostream &Out) {
3858 switch (SCT) {
3859 case GlobalValue::DefaultStorageClass: break;
3860 case GlobalValue::DLLImportStorageClass: Out << "dllimport "; break;
3861 case GlobalValue::DLLExportStorageClass: Out << "dllexport "; break;
3862 }
3863}
3864
3865static void printThreadLocalModel(GlobalVariable::ThreadLocalMode TLM,
3866 formatted_raw_ostream &Out) {
3867 switch (TLM) {
3868 case GlobalVariable::NotThreadLocal:
3869 break;
3870 case GlobalVariable::GeneralDynamicTLSModel:
3871 Out << "thread_local ";
3872 break;
3873 case GlobalVariable::LocalDynamicTLSModel:
3874 Out << "thread_local(localdynamic) ";
3875 break;
3876 case GlobalVariable::InitialExecTLSModel:
3877 Out << "thread_local(initialexec) ";
3878 break;
3879 case GlobalVariable::LocalExecTLSModel:
3880 Out << "thread_local(localexec) ";
3881 break;
3882 }
3883}
3884
3885static StringRef getUnnamedAddrEncoding(GlobalVariable::UnnamedAddr UA) {
3886 switch (UA) {
3887 case GlobalVariable::UnnamedAddr::None:
3888 return "";
3889 case GlobalVariable::UnnamedAddr::Local:
3890 return "local_unnamed_addr";
3891 case GlobalVariable::UnnamedAddr::Global:
3892 return "unnamed_addr";
3893 }
3894 llvm_unreachable("Unknown UnnamedAddr");
3895}
3896
3897static void maybePrintComdat(formatted_raw_ostream &Out,
3898 const GlobalObject &GO) {
3899 const Comdat *C = GO.getComdat();
3900 if (!C)
3901 return;
3902
3903 if (isa<GlobalVariable>(Val: GO))
3904 Out << ',';
3905 Out << " comdat";
3906
3907 if (GO.getName() == C->getName())
3908 return;
3909
3910 Out << '(';
3911 printLLVMName(OS&: Out, Name: C->getName(), Prefix: ComdatPrefix);
3912 Out << ')';
3913}
3914
3915void AssemblyWriter::printGlobal(const GlobalVariable *GV) {
3916 if (GV->isMaterializable())
3917 Out << "; Materializable\n";
3918
3919 AsmWriterContext WriterCtx(&TypePrinter, &Machine, GV->getParent());
3920 writeAsOperandInternal(Out, V: GV, WriterCtx);
3921 Out << " = ";
3922
3923 if (!GV->hasInitializer() && GV->hasExternalLinkage())
3924 Out << "external ";
3925
3926 Out << getLinkageNameWithSpace(LT: GV->getLinkage());
3927 printDSOLocation(GV: *GV, Out);
3928 printVisibility(Vis: GV->getVisibility(), Out);
3929 printDLLStorageClass(SCT: GV->getDLLStorageClass(), Out);
3930 printThreadLocalModel(TLM: GV->getThreadLocalMode(), Out);
3931 StringRef UA = getUnnamedAddrEncoding(UA: GV->getUnnamedAddr());
3932 if (!UA.empty())
3933 Out << UA << ' ';
3934
3935 printAddressSpace(M: GV->getParent(), AS: GV->getType()->getAddressSpace(), OS&: Out,
3936 /*Prefix=*/"", /*Suffix=*/" ");
3937 if (GV->isExternallyInitialized()) Out << "externally_initialized ";
3938 Out << (GV->isConstant() ? "constant " : "global ");
3939 TypePrinter.print(Ty: GV->getValueType(), OS&: Out);
3940
3941 if (GV->hasInitializer()) {
3942 Out << ' ';
3943 writeOperand(Operand: GV->getInitializer(), PrintType: false);
3944 }
3945
3946 if (GV->hasSection()) {
3947 Out << ", section \"";
3948 printEscapedString(Name: GV->getSection(), Out);
3949 Out << '"';
3950 }
3951 if (GV->hasPartition()) {
3952 Out << ", partition \"";
3953 printEscapedString(Name: GV->getPartition(), Out);
3954 Out << '"';
3955 }
3956 if (auto CM = GV->getCodeModel()) {
3957 Out << ", code_model \"";
3958 switch (*CM) {
3959 case CodeModel::Tiny:
3960 Out << "tiny";
3961 break;
3962 case CodeModel::Small:
3963 Out << "small";
3964 break;
3965 case CodeModel::Kernel:
3966 Out << "kernel";
3967 break;
3968 case CodeModel::Medium:
3969 Out << "medium";
3970 break;
3971 case CodeModel::Large:
3972 Out << "large";
3973 break;
3974 }
3975 Out << '"';
3976 }
3977
3978 using SanitizerMetadata = llvm::GlobalValue::SanitizerMetadata;
3979 if (GV->hasSanitizerMetadata()) {
3980 SanitizerMetadata MD = GV->getSanitizerMetadata();
3981 if (MD.NoAddress)
3982 Out << ", no_sanitize_address";
3983 if (MD.NoHWAddress)
3984 Out << ", no_sanitize_hwaddress";
3985 if (MD.Memtag)
3986 Out << ", sanitize_memtag";
3987 if (MD.IsDynInit)
3988 Out << ", sanitize_address_dyninit";
3989 }
3990
3991 maybePrintComdat(Out, GO: *GV);
3992 if (MaybeAlign A = GV->getAlign())
3993 Out << ", align " << A->value();
3994
3995 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
3996 GV->getAllMetadata(MDs);
3997 printMetadataAttachments(MDs, Separator: ", ");
3998
3999 auto Attrs = GV->getAttributes();
4000 if (Attrs.hasAttributes())
4001 Out << " #" << Machine.getAttributeGroupSlot(AS: Attrs);
4002
4003 printInfoComment(V: *GV, isMaterializable: GV->isMaterializable());
4004}
4005
4006void AssemblyWriter::printAlias(const GlobalAlias *GA) {
4007 if (GA->isMaterializable())
4008 Out << "; Materializable\n";
4009
4010 AsmWriterContext WriterCtx(&TypePrinter, &Machine, GA->getParent());
4011 writeAsOperandInternal(Out, V: GA, WriterCtx);
4012 Out << " = ";
4013
4014 Out << getLinkageNameWithSpace(LT: GA->getLinkage());
4015 printDSOLocation(GV: *GA, Out);
4016 printVisibility(Vis: GA->getVisibility(), Out);
4017 printDLLStorageClass(SCT: GA->getDLLStorageClass(), Out);
4018 printThreadLocalModel(TLM: GA->getThreadLocalMode(), Out);
4019 StringRef UA = getUnnamedAddrEncoding(UA: GA->getUnnamedAddr());
4020 if (!UA.empty())
4021 Out << UA << ' ';
4022
4023 Out << "alias ";
4024
4025 TypePrinter.print(Ty: GA->getValueType(), OS&: Out);
4026 Out << ", ";
4027
4028 if (const Constant *Aliasee = GA->getAliasee()) {
4029 writeOperand(Operand: Aliasee, PrintType: !isa<ConstantExpr>(Val: Aliasee));
4030 } else {
4031 TypePrinter.print(Ty: GA->getType(), OS&: Out);
4032 Out << " <<NULL ALIASEE>>";
4033 }
4034
4035 if (GA->hasPartition()) {
4036 Out << ", partition \"";
4037 printEscapedString(Name: GA->getPartition(), Out);
4038 Out << '"';
4039 }
4040
4041 printInfoComment(V: *GA, isMaterializable: GA->isMaterializable());
4042 Out << '\n';
4043}
4044
4045void AssemblyWriter::printIFunc(const GlobalIFunc *GI) {
4046 if (GI->isMaterializable())
4047 Out << "; Materializable\n";
4048
4049 AsmWriterContext WriterCtx(&TypePrinter, &Machine, GI->getParent());
4050 writeAsOperandInternal(Out, V: GI, WriterCtx);
4051 Out << " = ";
4052
4053 Out << getLinkageNameWithSpace(LT: GI->getLinkage());
4054 printDSOLocation(GV: *GI, Out);
4055 printVisibility(Vis: GI->getVisibility(), Out);
4056
4057 Out << "ifunc ";
4058
4059 TypePrinter.print(Ty: GI->getValueType(), OS&: Out);
4060 Out << ", ";
4061
4062 if (const Constant *Resolver = GI->getResolver()) {
4063 writeOperand(Operand: Resolver, PrintType: !isa<ConstantExpr>(Val: Resolver));
4064 } else {
4065 TypePrinter.print(Ty: GI->getType(), OS&: Out);
4066 Out << " <<NULL RESOLVER>>";
4067 }
4068
4069 if (GI->hasPartition()) {
4070 Out << ", partition \"";
4071 printEscapedString(Name: GI->getPartition(), Out);
4072 Out << '"';
4073 }
4074 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
4075 GI->getAllMetadata(MDs);
4076 if (!MDs.empty()) {
4077 printMetadataAttachments(MDs, Separator: ", ");
4078 }
4079
4080 printInfoComment(V: *GI, isMaterializable: GI->isMaterializable());
4081 Out << '\n';
4082}
4083
4084void AssemblyWriter::printComdat(const Comdat *C) {
4085 C->print(OS&: Out);
4086}
4087
4088void AssemblyWriter::printTypeIdentities() {
4089 if (TypePrinter.empty())
4090 return;
4091
4092 Out << '\n';
4093
4094 // Emit all numbered types.
4095 auto &NumberedTypes = TypePrinter.getNumberedTypes();
4096 for (unsigned I = 0, E = NumberedTypes.size(); I != E; ++I) {
4097 Out << '%' << I << " = type ";
4098
4099 // Make sure we print out at least one level of the type structure, so
4100 // that we do not get %2 = type %2
4101 TypePrinter.printStructBody(STy: NumberedTypes[I], OS&: Out);
4102 Out << '\n';
4103 }
4104
4105 auto &NamedTypes = TypePrinter.getNamedTypes();
4106 for (StructType *NamedType : NamedTypes) {
4107 printLLVMName(OS&: Out, Name: NamedType->getName(), Prefix: LocalPrefix);
4108 Out << " = type ";
4109
4110 // Make sure we print out at least one level of the type structure, so
4111 // that we do not get %FILE = type %FILE
4112 TypePrinter.printStructBody(STy: NamedType, OS&: Out);
4113 Out << '\n';
4114 }
4115}
4116
4117/// printFunction - Print all aspects of a function.
4118void AssemblyWriter::printFunction(const Function *F) {
4119 if (F->isMaterializable())
4120 Out << "; Materializable\n";
4121 else if (AnnotationWriter)
4122 AnnotationWriter->emitFunctionAnnot(F, Out);
4123
4124 const AttributeList &Attrs = F->getAttributes();
4125 if (Attrs.hasFnAttrs()) {
4126 AttributeSet AS = Attrs.getFnAttrs();
4127 std::string AttrStr;
4128
4129 for (const Attribute &Attr : AS) {
4130 if (!Attr.isStringAttribute()) {
4131 if (!AttrStr.empty()) AttrStr += ' ';
4132 AttrStr += Attr.getAsString();
4133 }
4134 }
4135
4136 if (!AttrStr.empty())
4137 Out << "; Function Attrs: " << AttrStr << '\n';
4138 }
4139
4140 if (F->isIntrinsic() && F->getIntrinsicID() == Intrinsic::not_intrinsic)
4141 Out << "; Unknown intrinsic\n";
4142
4143 Machine.incorporateFunction(F);
4144
4145 if (F->isDeclaration()) {
4146 Out << "declare";
4147 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
4148 F->getAllMetadata(MDs);
4149 printMetadataAttachments(MDs, Separator: " ");
4150 Out << ' ';
4151 } else
4152 Out << "define ";
4153
4154 Out << getLinkageNameWithSpace(LT: F->getLinkage());
4155 printDSOLocation(GV: *F, Out);
4156 printVisibility(Vis: F->getVisibility(), Out);
4157 printDLLStorageClass(SCT: F->getDLLStorageClass(), Out);
4158
4159 // Print the calling convention.
4160 if (F->getCallingConv() != CallingConv::C) {
4161 printCallingConv(cc: F->getCallingConv(), Out);
4162 Out << " ";
4163 }
4164
4165 FunctionType *FT = F->getFunctionType();
4166 if (Attrs.hasRetAttrs())
4167 Out << Attrs.getAsString(Index: AttributeList::ReturnIndex) << ' ';
4168 TypePrinter.print(Ty: F->getReturnType(), OS&: Out);
4169 AsmWriterContext WriterCtx(&TypePrinter, &Machine, F->getParent());
4170 Out << ' ';
4171 writeAsOperandInternal(Out, V: F, WriterCtx);
4172 Out << '(';
4173
4174 // Loop over the arguments, printing them...
4175 if (F->isDeclaration() && !IsForDebug) {
4176 // We're only interested in the type here - don't print argument names.
4177 ListSeparator LS;
4178 for (unsigned I = 0, E = FT->getNumParams(); I != E; ++I) {
4179 Out << LS;
4180 // Output type.
4181 TypePrinter.print(Ty: FT->getParamType(i: I), OS&: Out);
4182
4183 AttributeSet ArgAttrs = Attrs.getParamAttrs(ArgNo: I);
4184 if (ArgAttrs.hasAttributes()) {
4185 Out << ' ';
4186 writeAttributeSet(AttrSet: ArgAttrs);
4187 }
4188 }
4189 } else {
4190 // The arguments are meaningful here, print them in detail.
4191 ListSeparator LS;
4192 for (const Argument &Arg : F->args()) {
4193 Out << LS;
4194 printArgument(FA: &Arg, Attrs: Attrs.getParamAttrs(ArgNo: Arg.getArgNo()));
4195 }
4196 }
4197
4198 // Finish printing arguments...
4199 if (FT->isVarArg()) {
4200 if (FT->getNumParams()) Out << ", ";
4201 Out << "..."; // Output varargs portion of signature!
4202 }
4203 Out << ')';
4204 StringRef UA = getUnnamedAddrEncoding(UA: F->getUnnamedAddr());
4205 if (!UA.empty())
4206 Out << ' ' << UA;
4207 // We print the function address space if it is non-zero or if we are writing
4208 // a module with a non-zero program address space or if there is no valid
4209 // Module* so that the file can be parsed without the datalayout string.
4210 const Module *Mod = F->getParent();
4211 bool ForcePrintAddressSpace =
4212 !Mod || Mod->getDataLayout().getProgramAddressSpace() != 0;
4213 printAddressSpace(M: Mod, AS: F->getAddressSpace(), OS&: Out, /*Prefix=*/" ",
4214 /*Suffix=*/"", ForcePrint: ForcePrintAddressSpace);
4215 if (Attrs.hasFnAttrs())
4216 Out << " #" << Machine.getAttributeGroupSlot(AS: Attrs.getFnAttrs());
4217 if (F->hasSection()) {
4218 Out << " section \"";
4219 printEscapedString(Name: F->getSection(), Out);
4220 Out << '"';
4221 }
4222 if (F->hasPartition()) {
4223 Out << " partition \"";
4224 printEscapedString(Name: F->getPartition(), Out);
4225 Out << '"';
4226 }
4227 maybePrintComdat(Out, GO: *F);
4228 if (MaybeAlign A = F->getAlign())
4229 Out << " align " << A->value();
4230 if (MaybeAlign A = F->getPreferredAlignment())
4231 Out << " prefalign(" << A->value() << ')';
4232 if (F->hasGC())
4233 Out << " gc \"" << F->getGC() << '"';
4234 if (F->hasPrefixData()) {
4235 Out << " prefix ";
4236 writeOperand(Operand: F->getPrefixData(), PrintType: true);
4237 }
4238 if (F->hasPrologueData()) {
4239 Out << " prologue ";
4240 writeOperand(Operand: F->getPrologueData(), PrintType: true);
4241 }
4242 if (F->hasPersonalityFn()) {
4243 Out << " personality ";
4244 writeOperand(Operand: F->getPersonalityFn(), /*PrintType=*/true);
4245 }
4246
4247 if (PrintProfData) {
4248 if (auto *MDProf = F->getMetadata(KindID: LLVMContext::MD_prof)) {
4249 Out << " ";
4250 MDProf->print(OS&: Out, M: TheModule, /*IsForDebug=*/true);
4251 }
4252 }
4253
4254 if (F->isDeclaration()) {
4255 Out << '\n';
4256 } else {
4257 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
4258 F->getAllMetadata(MDs);
4259 printMetadataAttachments(MDs, Separator: " ");
4260
4261 Out << " {";
4262 // Output all of the function's basic blocks.
4263 for (const BasicBlock &BB : *F)
4264 printBasicBlock(BB: &BB);
4265
4266 // Output the function's use-lists.
4267 printUseLists(F);
4268
4269 Out << "}\n";
4270 }
4271
4272 Machine.purgeFunction();
4273}
4274
4275/// printArgument - This member is called for every argument that is passed into
4276/// the function. Simply print it out
4277void AssemblyWriter::printArgument(const Argument *Arg, AttributeSet Attrs) {
4278 // Output type...
4279 TypePrinter.print(Ty: Arg->getType(), OS&: Out);
4280
4281 // Output parameter attributes list
4282 if (Attrs.hasAttributes()) {
4283 Out << ' ';
4284 writeAttributeSet(AttrSet: Attrs);
4285 }
4286
4287 // Output name, if available...
4288 if (Arg->hasName()) {
4289 Out << ' ';
4290 printLLVMName(OS&: Out, V: Arg);
4291 } else {
4292 int Slot = Machine.getLocalSlot(V: Arg);
4293 assert(Slot != -1 && "expect argument in function here");
4294 Out << " %" << Slot;
4295 }
4296}
4297
4298/// printBasicBlock - This member is called for each basic block in a method.
4299void AssemblyWriter::printBasicBlock(const BasicBlock *BB) {
4300 bool IsEntryBlock = BB->getParent() && BB->isEntryBlock();
4301 if (BB->hasName()) { // Print out the label if it exists...
4302 Out << "\n";
4303 printLLVMName(OS&: Out, Name: BB->getName(), Prefix: LabelPrefix);
4304 Out << ':';
4305 } else if (!IsEntryBlock) {
4306 Out << "\n";
4307 int Slot = Machine.getLocalSlot(V: BB);
4308 if (Slot != -1)
4309 Out << Slot << ":";
4310 else
4311 Out << "<badref>:";
4312 }
4313
4314 if (!IsEntryBlock) {
4315 // Output predecessors for the block.
4316 Out.PadToColumn(NewCol: 50);
4317 Out << ";";
4318 if (pred_empty(BB)) {
4319 Out << " No predecessors!";
4320 } else {
4321 Out << " preds = ";
4322 ListSeparator LS;
4323 for (const BasicBlock *Pred : predecessors(BB)) {
4324 Out << LS;
4325 writeOperand(Operand: Pred, PrintType: false);
4326 }
4327 }
4328 }
4329
4330 Out << "\n";
4331
4332 if (AnnotationWriter) AnnotationWriter->emitBasicBlockStartAnnot(BB, Out);
4333
4334 // Output all of the instructions in the basic block...
4335 for (const Instruction &I : *BB) {
4336 for (const DbgRecord &DR : I.getDbgRecordRange())
4337 printDbgRecordLine(DR);
4338 printInstructionLine(I);
4339 }
4340
4341 if (AnnotationWriter) AnnotationWriter->emitBasicBlockEndAnnot(BB, Out);
4342}
4343
4344/// printInstructionLine - Print an instruction and a newline character.
4345void AssemblyWriter::printInstructionLine(const Instruction &I) {
4346 printInstruction(I);
4347 Out << '\n';
4348}
4349
4350/// printGCRelocateComment - print comment after call to the gc.relocate
4351/// intrinsic indicating base and derived pointer names.
4352void AssemblyWriter::printGCRelocateComment(const GCRelocateInst &Relocate) {
4353 Out << " ; (";
4354 writeOperand(Operand: Relocate.getBasePtr(), PrintType: false);
4355 Out << ", ";
4356 writeOperand(Operand: Relocate.getDerivedPtr(), PrintType: false);
4357 Out << ")";
4358}
4359
4360/// printInfoComment - Print a little comment after the instruction indicating
4361/// which slot it occupies.
4362void AssemblyWriter::printInfoComment(const Value &V, bool isMaterializable) {
4363 if (const auto *Relocate = dyn_cast<GCRelocateInst>(Val: &V))
4364 printGCRelocateComment(Relocate: *Relocate);
4365
4366 if (AnnotationWriter && !isMaterializable)
4367 AnnotationWriter->printInfoComment(V, Out);
4368
4369 if (PrintInstDebugLocs) {
4370 if (auto *I = dyn_cast<Instruction>(Val: &V)) {
4371 if (I->getDebugLoc()) {
4372 Out << " ; ";
4373 I->getDebugLoc().print(OS&: Out);
4374 }
4375 }
4376 }
4377 if (PrintProfData) {
4378 if (auto *I = dyn_cast<Instruction>(Val: &V)) {
4379 if (auto *MD = I->getMetadata(KindID: LLVMContext::MD_prof)) {
4380 Out << " ; ";
4381 MD->print(OS&: Out, M: TheModule, /*IsForDebug=*/true);
4382 }
4383 }
4384 }
4385
4386 if (PrintInstAddrs)
4387 Out << " ; " << &V;
4388}
4389
4390static void maybePrintCallAddrSpace(const Value *Operand, const Instruction *I,
4391 raw_ostream &Out) {
4392 if (Operand == nullptr) {
4393 Out << " <cannot get addrspace!>";
4394 return;
4395 }
4396
4397 // We print the address space of the call if it is non-zero.
4398 // We also print it if it is zero but not equal to the program address space
4399 // or if we can't find a valid Module* to make it possible to parse
4400 // the resulting file even without a datalayout string.
4401 unsigned CallAddrSpace = Operand->getType()->getPointerAddressSpace();
4402 const Module *Mod = getModuleFromVal(V: I);
4403 bool ForcePrintAddrSpace =
4404 !Mod || Mod->getDataLayout().getProgramAddressSpace() != 0;
4405 printAddressSpace(M: Mod, AS: CallAddrSpace, OS&: Out, /*Prefix=*/" ", /*Suffix=*/"",
4406 ForcePrint: ForcePrintAddrSpace);
4407}
4408
4409// This member is called for each Instruction in a function..
4410void AssemblyWriter::printInstruction(const Instruction &I) {
4411 if (AnnotationWriter) AnnotationWriter->emitInstructionAnnot(&I, Out);
4412
4413 // Print out indentation for an instruction.
4414 Out << " ";
4415
4416 // Print out name if it exists...
4417 if (I.hasName()) {
4418 printLLVMName(OS&: Out, V: &I);
4419 Out << " = ";
4420 } else if (!I.getType()->isVoidTy()) {
4421 // Print out the def slot taken.
4422 int SlotNum = Machine.getLocalSlot(V: &I);
4423 if (SlotNum == -1)
4424 Out << "<badref> = ";
4425 else
4426 Out << '%' << SlotNum << " = ";
4427 }
4428
4429 if (const auto *CI = dyn_cast<CallInst>(Val: &I)) {
4430 if (CI->isMustTailCall())
4431 Out << "musttail ";
4432 else if (CI->isTailCall())
4433 Out << "tail ";
4434 else if (CI->isNoTailCall())
4435 Out << "notail ";
4436 }
4437
4438 // Print out the opcode...
4439 Out << I.getOpcodeName();
4440
4441 // If this is an atomic load or store, print out the atomic marker.
4442 if ((isa<LoadInst>(Val: I) && cast<LoadInst>(Val: I).isAtomic()) ||
4443 (isa<StoreInst>(Val: I) && cast<StoreInst>(Val: I).isAtomic()))
4444 Out << " atomic";
4445
4446 if (isa<AtomicCmpXchgInst>(Val: I) && cast<AtomicCmpXchgInst>(Val: I).isWeak())
4447 Out << " weak";
4448
4449 // If this is a volatile operation, print out the volatile marker.
4450 if ((isa<LoadInst>(Val: I) && cast<LoadInst>(Val: I).isVolatile()) ||
4451 (isa<StoreInst>(Val: I) && cast<StoreInst>(Val: I).isVolatile()) ||
4452 (isa<AtomicCmpXchgInst>(Val: I) && cast<AtomicCmpXchgInst>(Val: I).isVolatile()) ||
4453 (isa<AtomicRMWInst>(Val: I) && cast<AtomicRMWInst>(Val: I).isVolatile()))
4454 Out << " volatile";
4455
4456 // Print out optimization information.
4457 writeOptimizationInfo(Out, U: &I);
4458
4459 // Print out the compare instruction predicates
4460 if (const auto *CI = dyn_cast<CmpInst>(Val: &I))
4461 Out << ' ' << CI->getPredicate();
4462
4463 // Print out the atomicrmw operation
4464 if (const auto *RMWI = dyn_cast<AtomicRMWInst>(Val: &I)) {
4465 if (RMWI->isElementwise())
4466 Out << " elementwise";
4467 Out << ' ' << AtomicRMWInst::getOperationName(Op: RMWI->getOperation());
4468 }
4469
4470 // Print out the type of the operands...
4471 const Value *Operand = I.getNumOperands() ? I.getOperand(i: 0) : nullptr;
4472
4473 // Special case conditional branches to swizzle the condition out to the front
4474 if (const auto *BI = dyn_cast<CondBrInst>(Val: &I)) {
4475 Out << ' ';
4476 writeOperand(Operand: BI->getCondition(), PrintType: true);
4477 Out << ", ";
4478 writeOperand(Operand: BI->getSuccessor(i: 0), PrintType: true);
4479 Out << ", ";
4480 writeOperand(Operand: BI->getSuccessor(i: 1), PrintType: true);
4481 } else if (isa<SwitchInst>(Val: I)) {
4482 const SwitchInst& SI(cast<SwitchInst>(Val: I));
4483 // Special case switch instruction to get formatting nice and correct.
4484 Out << ' ';
4485 writeOperand(Operand: SI.getCondition(), PrintType: true);
4486 Out << ", ";
4487 writeOperand(Operand: SI.getDefaultDest(), PrintType: true);
4488 Out << " [";
4489 for (auto Case : SI.cases()) {
4490 Out << "\n ";
4491 writeOperand(Operand: Case.getCaseValue(), PrintType: true);
4492 Out << ", ";
4493 writeOperand(Operand: Case.getCaseSuccessor(), PrintType: true);
4494 }
4495 Out << "\n ]";
4496 } else if (isa<IndirectBrInst>(Val: I)) {
4497 // Special case indirectbr instruction to get formatting nice and correct.
4498 Out << ' ';
4499 writeOperand(Operand, PrintType: true);
4500 Out << ", [";
4501
4502 ListSeparator LS;
4503 for (unsigned i = 1, e = I.getNumOperands(); i != e; ++i) {
4504 Out << LS;
4505 writeOperand(Operand: I.getOperand(i), PrintType: true);
4506 }
4507 Out << ']';
4508 } else if (const auto *PN = dyn_cast<PHINode>(Val: &I)) {
4509 Out << ' ';
4510 TypePrinter.print(Ty: I.getType(), OS&: Out);
4511 Out << ' ';
4512
4513 ListSeparator LS;
4514 for (const auto &[V, Block] :
4515 zip_equal(t: PN->incoming_values(), u: PN->blocks())) {
4516 Out << LS << "[ ";
4517 writeOperand(Operand: V, PrintType: false);
4518 Out << ", ";
4519 writeOperand(Operand: Block, PrintType: false);
4520 Out << " ]";
4521 }
4522 } else if (const auto *EVI = dyn_cast<ExtractValueInst>(Val: &I)) {
4523 Out << ' ';
4524 writeOperand(Operand: I.getOperand(i: 0), PrintType: true);
4525 Out << ", ";
4526 Out << llvm::interleaved(R: EVI->indices());
4527 } else if (const auto *IVI = dyn_cast<InsertValueInst>(Val: &I)) {
4528 Out << ' ';
4529 writeOperand(Operand: I.getOperand(i: 0), PrintType: true); Out << ", ";
4530 writeOperand(Operand: I.getOperand(i: 1), PrintType: true);
4531 Out << ", ";
4532 Out << llvm::interleaved(R: IVI->indices());
4533 } else if (const auto *LPI = dyn_cast<LandingPadInst>(Val: &I)) {
4534 Out << ' ';
4535 TypePrinter.print(Ty: I.getType(), OS&: Out);
4536 if (LPI->isCleanup() || LPI->getNumClauses() != 0)
4537 Out << '\n';
4538
4539 if (LPI->isCleanup())
4540 Out << " cleanup";
4541
4542 for (unsigned i = 0, e = LPI->getNumClauses(); i != e; ++i) {
4543 if (i != 0 || LPI->isCleanup()) Out << "\n";
4544 if (LPI->isCatch(Idx: i))
4545 Out << " catch ";
4546 else
4547 Out << " filter ";
4548
4549 writeOperand(Operand: LPI->getClause(Idx: i), PrintType: true);
4550 }
4551 } else if (const auto *CatchSwitch = dyn_cast<CatchSwitchInst>(Val: &I)) {
4552 Out << " within ";
4553 writeOperand(Operand: CatchSwitch->getParentPad(), /*PrintType=*/false);
4554 Out << " [";
4555 ListSeparator LS;
4556 for (const BasicBlock *PadBB : CatchSwitch->handlers()) {
4557 Out << LS;
4558 writeOperand(Operand: PadBB, /*PrintType=*/true);
4559 }
4560 Out << "] unwind ";
4561 if (const BasicBlock *UnwindDest = CatchSwitch->getUnwindDest())
4562 writeOperand(Operand: UnwindDest, /*PrintType=*/true);
4563 else
4564 Out << "to caller";
4565 } else if (const auto *FPI = dyn_cast<FuncletPadInst>(Val: &I)) {
4566 Out << " within ";
4567 writeOperand(Operand: FPI->getParentPad(), /*PrintType=*/false);
4568 Out << " [";
4569 ListSeparator LS;
4570 for (const Value *Op : FPI->arg_operands()) {
4571 Out << LS;
4572 writeOperand(Operand: Op, /*PrintType=*/true);
4573 }
4574 Out << ']';
4575 } else if (isa<ReturnInst>(Val: I) && !Operand) {
4576 Out << " void";
4577 } else if (const auto *CRI = dyn_cast<CatchReturnInst>(Val: &I)) {
4578 Out << " from ";
4579 writeOperand(Operand: CRI->getOperand(i_nocapture: 0), /*PrintType=*/false);
4580
4581 Out << " to ";
4582 writeOperand(Operand: CRI->getOperand(i_nocapture: 1), /*PrintType=*/true);
4583 } else if (const auto *CRI = dyn_cast<CleanupReturnInst>(Val: &I)) {
4584 Out << " from ";
4585 writeOperand(Operand: CRI->getOperand(i_nocapture: 0), /*PrintType=*/false);
4586
4587 Out << " unwind ";
4588 if (CRI->hasUnwindDest())
4589 writeOperand(Operand: CRI->getOperand(i_nocapture: 1), /*PrintType=*/true);
4590 else
4591 Out << "to caller";
4592 } else if (const auto *CI = dyn_cast<CallInst>(Val: &I)) {
4593 // Print the calling convention being used.
4594 if (CI->getCallingConv() != CallingConv::C) {
4595 Out << " ";
4596 printCallingConv(cc: CI->getCallingConv(), Out);
4597 }
4598
4599 Operand = CI->getCalledOperand();
4600 FunctionType *FTy = CI->getFunctionType();
4601 Type *RetTy = FTy->getReturnType();
4602 const AttributeList &PAL = CI->getAttributes();
4603
4604 if (PAL.hasRetAttrs())
4605 Out << ' ' << PAL.getAsString(Index: AttributeList::ReturnIndex);
4606
4607 // Only print addrspace(N) if necessary:
4608 maybePrintCallAddrSpace(Operand, I: &I, Out);
4609
4610 // If possible, print out the short form of the call instruction. We can
4611 // only do this if the first argument is a pointer to a nonvararg function,
4612 // and if the return type is not a pointer to a function.
4613 Out << ' ';
4614 TypePrinter.print(Ty: FTy->isVarArg() ? FTy : RetTy, OS&: Out);
4615 Out << ' ';
4616 writeOperand(Operand, PrintType: false);
4617 Out << '(';
4618 bool HasPrettyPrintedArgs =
4619 isa<IntrinsicInst>(Val: CI) &&
4620 Intrinsic::hasPrettyPrintedArgs(id: CI->getIntrinsicID());
4621
4622 ListSeparator LS;
4623 Function *CalledFunc = CI->getCalledFunction();
4624 auto PrintArgComment = [&](unsigned ArgNo) {
4625 const auto *ConstArg = dyn_cast<Constant>(Val: CI->getArgOperand(i: ArgNo));
4626 if (!ConstArg)
4627 return;
4628 std::string ArgComment;
4629 raw_string_ostream ArgCommentStream(ArgComment);
4630 Intrinsic::ID IID = CalledFunc->getIntrinsicID();
4631 Intrinsic::printImmArg(IID, ArgIdx: ArgNo, OS&: ArgCommentStream, ImmArgVal: ConstArg);
4632 if (ArgComment.empty())
4633 return;
4634 Out << "/* " << ArgComment << " */ ";
4635 };
4636 if (HasPrettyPrintedArgs) {
4637 for (unsigned ArgNo = 0, NumArgs = CI->arg_size(); ArgNo < NumArgs;
4638 ++ArgNo) {
4639 Out << LS;
4640 PrintArgComment(ArgNo);
4641 writeParamOperand(Operand: CI->getArgOperand(i: ArgNo), Attrs: PAL.getParamAttrs(ArgNo));
4642 }
4643 } else {
4644 for (unsigned ArgNo = 0, NumArgs = CI->arg_size(); ArgNo < NumArgs;
4645 ++ArgNo) {
4646 Out << LS;
4647 writeParamOperand(Operand: CI->getArgOperand(i: ArgNo), Attrs: PAL.getParamAttrs(ArgNo));
4648 }
4649 }
4650 // Emit an ellipsis if this is a musttail call in a vararg function. This
4651 // is only to aid readability, musttail calls forward varargs by default.
4652 if (CI->isMustTailCall() && CI->getParent() &&
4653 CI->getParent()->getParent() &&
4654 CI->getParent()->getParent()->isVarArg()) {
4655 if (CI->arg_size() > 0)
4656 Out << ", ";
4657 Out << "...";
4658 }
4659
4660 Out << ')';
4661 if (PAL.hasFnAttrs())
4662 Out << " #" << Machine.getAttributeGroupSlot(AS: PAL.getFnAttrs());
4663
4664 writeOperandBundles(Call: CI);
4665 } else if (const auto *II = dyn_cast<InvokeInst>(Val: &I)) {
4666 Operand = II->getCalledOperand();
4667 FunctionType *FTy = II->getFunctionType();
4668 Type *RetTy = FTy->getReturnType();
4669 const AttributeList &PAL = II->getAttributes();
4670
4671 // Print the calling convention being used.
4672 if (II->getCallingConv() != CallingConv::C) {
4673 Out << " ";
4674 printCallingConv(cc: II->getCallingConv(), Out);
4675 }
4676
4677 if (PAL.hasRetAttrs())
4678 Out << ' ' << PAL.getAsString(Index: AttributeList::ReturnIndex);
4679
4680 // Only print addrspace(N) if necessary:
4681 maybePrintCallAddrSpace(Operand, I: &I, Out);
4682
4683 // If possible, print out the short form of the invoke instruction. We can
4684 // only do this if the first argument is a pointer to a nonvararg function,
4685 // and if the return type is not a pointer to a function.
4686 //
4687 Out << ' ';
4688 TypePrinter.print(Ty: FTy->isVarArg() ? FTy : RetTy, OS&: Out);
4689 Out << ' ';
4690 writeOperand(Operand, PrintType: false);
4691 Out << '(';
4692 ListSeparator LS;
4693 for (unsigned op = 0, Eop = II->arg_size(); op < Eop; ++op) {
4694 Out << LS;
4695 writeParamOperand(Operand: II->getArgOperand(i: op), Attrs: PAL.getParamAttrs(ArgNo: op));
4696 }
4697
4698 Out << ')';
4699 if (PAL.hasFnAttrs())
4700 Out << " #" << Machine.getAttributeGroupSlot(AS: PAL.getFnAttrs());
4701
4702 writeOperandBundles(Call: II);
4703
4704 Out << "\n to ";
4705 writeOperand(Operand: II->getNormalDest(), PrintType: true);
4706 Out << " unwind ";
4707 writeOperand(Operand: II->getUnwindDest(), PrintType: true);
4708 } else if (const auto *CBI = dyn_cast<CallBrInst>(Val: &I)) {
4709 Operand = CBI->getCalledOperand();
4710 FunctionType *FTy = CBI->getFunctionType();
4711 Type *RetTy = FTy->getReturnType();
4712 const AttributeList &PAL = CBI->getAttributes();
4713
4714 // Print the calling convention being used.
4715 if (CBI->getCallingConv() != CallingConv::C) {
4716 Out << " ";
4717 printCallingConv(cc: CBI->getCallingConv(), Out);
4718 }
4719
4720 if (PAL.hasRetAttrs())
4721 Out << ' ' << PAL.getAsString(Index: AttributeList::ReturnIndex);
4722
4723 // If possible, print out the short form of the callbr instruction. We can
4724 // only do this if the first argument is a pointer to a nonvararg function,
4725 // and if the return type is not a pointer to a function.
4726 //
4727 Out << ' ';
4728 TypePrinter.print(Ty: FTy->isVarArg() ? FTy : RetTy, OS&: Out);
4729 Out << ' ';
4730 writeOperand(Operand, PrintType: false);
4731 Out << '(';
4732 ListSeparator ArgLS;
4733 for (unsigned op = 0, Eop = CBI->arg_size(); op < Eop; ++op) {
4734 Out << ArgLS;
4735 writeParamOperand(Operand: CBI->getArgOperand(i: op), Attrs: PAL.getParamAttrs(ArgNo: op));
4736 }
4737
4738 Out << ')';
4739 if (PAL.hasFnAttrs())
4740 Out << " #" << Machine.getAttributeGroupSlot(AS: PAL.getFnAttrs());
4741
4742 writeOperandBundles(Call: CBI);
4743
4744 Out << "\n to ";
4745 writeOperand(Operand: CBI->getDefaultDest(), PrintType: true);
4746 Out << " [";
4747 ListSeparator DestLS;
4748 for (const BasicBlock *Dest : CBI->getIndirectDests()) {
4749 Out << DestLS;
4750 writeOperand(Operand: Dest, PrintType: true);
4751 }
4752 Out << ']';
4753 } else if (const auto *AI = dyn_cast<AllocaInst>(Val: &I)) {
4754 Out << ' ';
4755 if (AI->isUsedWithInAlloca())
4756 Out << "inalloca ";
4757 if (AI->isSwiftError())
4758 Out << "swifterror ";
4759 TypePrinter.print(Ty: AI->getAllocatedType(), OS&: Out);
4760
4761 // Explicitly write the array size if the code is broken, if it's an array
4762 // allocation, or if the type is not canonical for scalar allocations. The
4763 // latter case prevents the type from mutating when round-tripping through
4764 // assembly.
4765 if (!AI->getArraySize() || AI->isArrayAllocation() ||
4766 !AI->getArraySize()->getType()->isIntegerTy(BitWidth: 32)) {
4767 Out << ", ";
4768 writeOperand(Operand: AI->getArraySize(), PrintType: true);
4769 }
4770 if (MaybeAlign A = AI->getAlign()) {
4771 Out << ", align " << A->value();
4772 }
4773
4774 printAddressSpace(M: AI->getModule(), AS: AI->getAddressSpace(), OS&: Out,
4775 /*Prefix=*/", ");
4776 } else if (isa<CastInst>(Val: I)) {
4777 if (Operand) {
4778 Out << ' ';
4779 writeOperand(Operand, PrintType: true); // Work with broken code
4780 }
4781 Out << " to ";
4782 TypePrinter.print(Ty: I.getType(), OS&: Out);
4783 } else if (isa<VAArgInst>(Val: I)) {
4784 if (Operand) {
4785 Out << ' ';
4786 writeOperand(Operand, PrintType: true); // Work with broken code
4787 }
4788 Out << ", ";
4789 TypePrinter.print(Ty: I.getType(), OS&: Out);
4790 } else if (Operand) { // Print the normal way.
4791 if (const auto *GEP = dyn_cast<GetElementPtrInst>(Val: &I)) {
4792 Out << ' ';
4793 TypePrinter.print(Ty: GEP->getSourceElementType(), OS&: Out);
4794 Out << ',';
4795 } else if (const auto *LI = dyn_cast<LoadInst>(Val: &I)) {
4796 Out << ' ';
4797 TypePrinter.print(Ty: LI->getType(), OS&: Out);
4798 Out << ',';
4799 }
4800
4801 // PrintAllTypes - Instructions who have operands of all the same type
4802 // omit the type from all but the first operand. If the instruction has
4803 // different type operands (for example br), then they are all printed.
4804 bool PrintAllTypes = false;
4805 Type *TheType = Operand->getType();
4806
4807 // Select, Store, ShuffleVector, CmpXchg and AtomicRMW always print all
4808 // types.
4809 if (isa<SelectInst>(Val: I) || isa<StoreInst>(Val: I) || isa<ShuffleVectorInst>(Val: I) ||
4810 isa<ReturnInst>(Val: I) || isa<AtomicCmpXchgInst>(Val: I) ||
4811 isa<AtomicRMWInst>(Val: I)) {
4812 PrintAllTypes = true;
4813 } else {
4814 for (unsigned i = 1, E = I.getNumOperands(); i != E; ++i) {
4815 Operand = I.getOperand(i);
4816 // note that Operand shouldn't be null, but the test helps make dump()
4817 // more tolerant of malformed IR
4818 if (Operand && Operand->getType() != TheType) {
4819 PrintAllTypes = true; // We have differing types! Print them all!
4820 break;
4821 }
4822 }
4823 }
4824
4825 if (!PrintAllTypes) {
4826 Out << ' ';
4827 TypePrinter.print(Ty: TheType, OS&: Out);
4828 }
4829
4830 Out << ' ';
4831 ListSeparator LS;
4832 for (const Value *Op : I.operands()) {
4833 Out << LS;
4834 writeOperand(Operand: Op, PrintType: PrintAllTypes);
4835 }
4836 }
4837
4838 // Print atomic ordering/alignment for memory operations
4839 if (const auto *LI = dyn_cast<LoadInst>(Val: &I)) {
4840 if (LI->isAtomic())
4841 writeAtomic(Context: LI->getContext(), Ordering: LI->getOrdering(), SSID: LI->getSyncScopeID());
4842 if (MaybeAlign A = LI->getAlign())
4843 Out << ", align " << A->value();
4844 } else if (const auto *SI = dyn_cast<StoreInst>(Val: &I)) {
4845 if (SI->isAtomic())
4846 writeAtomic(Context: SI->getContext(), Ordering: SI->getOrdering(), SSID: SI->getSyncScopeID());
4847 if (MaybeAlign A = SI->getAlign())
4848 Out << ", align " << A->value();
4849 } else if (const auto *CXI = dyn_cast<AtomicCmpXchgInst>(Val: &I)) {
4850 writeAtomicCmpXchg(Context: CXI->getContext(), SuccessOrdering: CXI->getSuccessOrdering(),
4851 FailureOrdering: CXI->getFailureOrdering(), SSID: CXI->getSyncScopeID());
4852 Out << ", align " << CXI->getAlign().value();
4853 } else if (const auto *RMWI = dyn_cast<AtomicRMWInst>(Val: &I)) {
4854 writeAtomic(Context: RMWI->getContext(), Ordering: RMWI->getOrdering(),
4855 SSID: RMWI->getSyncScopeID());
4856 Out << ", align " << RMWI->getAlign().value();
4857 } else if (const auto *FI = dyn_cast<FenceInst>(Val: &I)) {
4858 writeAtomic(Context: FI->getContext(), Ordering: FI->getOrdering(), SSID: FI->getSyncScopeID());
4859 } else if (const auto *SVI = dyn_cast<ShuffleVectorInst>(Val: &I)) {
4860 printShuffleMask(Out, Ty: SVI->getType(), Mask: SVI->getShuffleMask());
4861 }
4862
4863 // Print Metadata info.
4864 SmallVector<std::pair<unsigned, MDNode *>, 4> InstMD;
4865 I.getAllMetadata(MDs&: InstMD);
4866 printMetadataAttachments(MDs: InstMD, Separator: ", ");
4867
4868 // Print a nice comment.
4869 printInfoComment(V: I);
4870}
4871
4872void AssemblyWriter::printDbgMarker(const DbgMarker &Marker) {
4873 // There's no formal representation of a DbgMarker -- print purely as a
4874 // debugging aid.
4875 for (const DbgRecord &DPR : Marker.StoredDbgRecords) {
4876 printDbgRecord(DR: DPR);
4877 Out << "\n";
4878 }
4879
4880 Out << " DbgMarker -> { ";
4881 printInstruction(I: *Marker.MarkedInstr);
4882 Out << " }";
4883}
4884
4885void AssemblyWriter::printDbgRecord(const DbgRecord &DR) {
4886 if (auto *DVR = dyn_cast<DbgVariableRecord>(Val: &DR))
4887 printDbgVariableRecord(DVR: *DVR);
4888 else if (auto *DLR = dyn_cast<DbgLabelRecord>(Val: &DR))
4889 printDbgLabelRecord(DLR: *DLR);
4890 else
4891 llvm_unreachable("Unexpected DbgRecord kind");
4892}
4893
4894void AssemblyWriter::printDbgVariableRecord(const DbgVariableRecord &DVR) {
4895 auto WriterCtx = getContext();
4896 Out << "#dbg_";
4897 switch (DVR.getType()) {
4898 case DbgVariableRecord::LocationType::Value:
4899 Out << "value";
4900 break;
4901 case DbgVariableRecord::LocationType::Declare:
4902 Out << "declare";
4903 break;
4904 case DbgVariableRecord::LocationType::DeclareValue:
4905 Out << "declare_value";
4906 break;
4907 case DbgVariableRecord::LocationType::Assign:
4908 Out << "assign";
4909 break;
4910 default:
4911 llvm_unreachable(
4912 "Tried to print a DbgVariableRecord with an invalid LocationType!");
4913 }
4914
4915 auto PrintOrNull = [&](Metadata *M) {
4916 if (!M)
4917 Out << "(null)";
4918 else
4919 writeAsOperandInternal(Out, MD: M, WriterCtx, FromValue: true);
4920 };
4921
4922 Out << "(";
4923 PrintOrNull(DVR.getRawLocation());
4924 Out << ", ";
4925 PrintOrNull(DVR.getRawVariable());
4926 Out << ", ";
4927 PrintOrNull(DVR.getRawExpression());
4928 Out << ", ";
4929 if (DVR.isDbgAssign()) {
4930 PrintOrNull(DVR.getRawAssignID());
4931 Out << ", ";
4932 PrintOrNull(DVR.getRawAddress());
4933 Out << ", ";
4934 PrintOrNull(DVR.getRawAddressExpression());
4935 Out << ", ";
4936 }
4937 PrintOrNull(DVR.getDebugLoc().getAsMDNode());
4938 Out << ")";
4939}
4940
4941/// printDbgRecordLine - Print a DbgRecord with indentation and a newline
4942/// character.
4943void AssemblyWriter::printDbgRecordLine(const DbgRecord &DR) {
4944 // Print lengthier indentation to bring out-of-line with instructions.
4945 Out << " ";
4946 printDbgRecord(DR);
4947 Out << '\n';
4948}
4949
4950void AssemblyWriter::printDbgLabelRecord(const DbgLabelRecord &Label) {
4951 auto WriterCtx = getContext();
4952 Out << "#dbg_label(";
4953 writeAsOperandInternal(Out, MD: Label.getRawLabel(), WriterCtx, FromValue: true);
4954 Out << ", ";
4955 writeAsOperandInternal(Out, MD: Label.getDebugLoc(), WriterCtx, FromValue: true);
4956 Out << ")";
4957}
4958
4959void AssemblyWriter::printMetadataAttachments(
4960 const SmallVectorImpl<std::pair<unsigned, MDNode *>> &MDs,
4961 StringRef Separator) {
4962 if (MDs.empty())
4963 return;
4964
4965 if (MDNames.empty())
4966 MDs[0].second->getContext().getMDKindNames(Result&: MDNames);
4967
4968 auto WriterCtx = getContext();
4969 for (const auto &I : MDs) {
4970 unsigned Kind = I.first;
4971 Out << Separator;
4972 if (Kind < MDNames.size()) {
4973 Out << "!";
4974 printMetadataIdentifier(Name: MDNames[Kind], Out);
4975 } else
4976 Out << "!<unknown kind #" << Kind << ">";
4977 Out << ' ';
4978 writeAsOperandInternal(Out, MD: I.second, WriterCtx);
4979 }
4980}
4981
4982void AssemblyWriter::writeMDNode(unsigned Slot, const MDNode *Node) {
4983 if (AnnotationWriter)
4984 AnnotationWriter->emitMDNodeAnnot(Node, Out);
4985
4986 Out << '!' << Slot << " = ";
4987 printMDNodeBody(MD: Node);
4988 Out << "\n";
4989}
4990
4991void AssemblyWriter::writeAllMDNodes() {
4992 SmallVector<const MDNode *, 16> Nodes;
4993 Nodes.resize(N: Machine.mdn_size());
4994 for (auto &I : llvm::make_range(x: Machine.mdn_begin(), y: Machine.mdn_end()))
4995 Nodes[I.second] = cast<MDNode>(Val: I.first);
4996
4997 for (unsigned i = 0, e = Nodes.size(); i != e; ++i) {
4998 writeMDNode(Slot: i, Node: Nodes[i]);
4999 }
5000}
5001
5002void AssemblyWriter::printMDNodeBody(const MDNode *Node) {
5003 auto WriterCtx = getContext();
5004 writeMDNodeBodyInternal(Out, Node, Ctx&: WriterCtx);
5005}
5006
5007void AssemblyWriter::writeAttribute(const Attribute &Attr, bool InAttrGroup) {
5008 if (!Attr.isTypeAttribute()) {
5009 Out << Attr.getAsString(InAttrGrp: InAttrGroup);
5010 return;
5011 }
5012
5013 Out << Attribute::getNameFromAttrKind(AttrKind: Attr.getKindAsEnum());
5014 if (Type *Ty = Attr.getValueAsType()) {
5015 Out << '(';
5016 TypePrinter.print(Ty, OS&: Out);
5017 Out << ')';
5018 }
5019}
5020
5021void AssemblyWriter::writeAttributeSet(const AttributeSet &AttrSet,
5022 bool InAttrGroup) {
5023 ListSeparator LS(" ");
5024 for (const auto &Attr : AttrSet) {
5025 Out << LS;
5026 writeAttribute(Attr, InAttrGroup);
5027 }
5028}
5029
5030void AssemblyWriter::writeAllAttributeGroups() {
5031 std::vector<std::pair<AttributeSet, unsigned>> asVec;
5032 asVec.resize(new_size: Machine.as_size());
5033
5034 for (auto &I : llvm::make_range(x: Machine.as_begin(), y: Machine.as_end()))
5035 asVec[I.second] = I;
5036
5037 for (const auto &I : asVec)
5038 Out << "attributes #" << I.second << " = { "
5039 << I.first.getAsString(InAttrGrp: true) << " }\n";
5040}
5041
5042void AssemblyWriter::printUseListOrder(const Value *V,
5043 ArrayRef<unsigned> Shuffle) {
5044 if (Machine.getFunction())
5045 Out << " ";
5046
5047 Out << "uselistorder ";
5048 writeOperand(Operand: V, PrintType: true);
5049
5050 assert(Shuffle.size() >= 2 && "Shuffle too small");
5051 Out << ", { " << llvm::interleaved(R: Shuffle) << " }\n";
5052}
5053
5054void AssemblyWriter::printUseLists(const Function *F) {
5055 auto It = UseListOrders.find(Val: F);
5056 if (It == UseListOrders.end())
5057 return;
5058
5059 Out << "\n; uselistorder directives\n";
5060 for (const auto &Pair : It->second)
5061 printUseListOrder(V: Pair.first, Shuffle: Pair.second);
5062}
5063
5064//===----------------------------------------------------------------------===//
5065// External Interface declarations
5066//===----------------------------------------------------------------------===//
5067
5068void Function::print(raw_ostream &ROS, AssemblyAnnotationWriter *AAW,
5069 bool ShouldPreserveUseListOrder, bool IsForDebug) const {
5070 SlotTracker SlotTable(this->getParent());
5071 formatted_raw_ostream OS(ROS);
5072 AssemblyWriter W(OS, SlotTable, this->getParent(), AAW, IsForDebug,
5073 ShouldPreserveUseListOrder);
5074 W.printFunction(F: this);
5075}
5076
5077void BasicBlock::print(raw_ostream &ROS, AssemblyAnnotationWriter *AAW,
5078 bool ShouldPreserveUseListOrder,
5079 bool IsForDebug) const {
5080 SlotTracker SlotTable(this->getParent());
5081 formatted_raw_ostream OS(ROS);
5082 AssemblyWriter W(OS, SlotTable, this->getModule(), AAW,
5083 IsForDebug,
5084 ShouldPreserveUseListOrder);
5085 W.printBasicBlock(BB: this);
5086}
5087
5088void Module::print(raw_ostream &ROS, AssemblyAnnotationWriter *AAW,
5089 bool ShouldPreserveUseListOrder, bool IsForDebug) const {
5090 SlotTracker SlotTable(this);
5091 formatted_raw_ostream OS(ROS);
5092 AssemblyWriter W(OS, SlotTable, this, AAW, IsForDebug,
5093 ShouldPreserveUseListOrder);
5094 W.printModule(M: this);
5095}
5096
5097void NamedMDNode::print(raw_ostream &ROS, bool IsForDebug) const {
5098 SlotTracker SlotTable(getParent());
5099 formatted_raw_ostream OS(ROS);
5100 AssemblyWriter W(OS, SlotTable, getParent(), nullptr, IsForDebug);
5101 W.printNamedMDNode(NMD: this);
5102}
5103
5104void NamedMDNode::print(raw_ostream &ROS, ModuleSlotTracker &MST,
5105 bool IsForDebug) const {
5106 std::optional<SlotTracker> LocalST;
5107 SlotTracker *SlotTable;
5108 if (auto *ST = MST.getMachine())
5109 SlotTable = ST;
5110 else {
5111 LocalST.emplace(args: getParent());
5112 SlotTable = &*LocalST;
5113 }
5114
5115 formatted_raw_ostream OS(ROS);
5116 AssemblyWriter W(OS, *SlotTable, getParent(), nullptr, IsForDebug);
5117 W.printNamedMDNode(NMD: this);
5118}
5119
5120void Comdat::print(raw_ostream &ROS, bool /*IsForDebug*/) const {
5121 printLLVMName(OS&: ROS, Name: getName(), Prefix: ComdatPrefix);
5122 ROS << " = comdat ";
5123
5124 switch (getSelectionKind()) {
5125 case Comdat::Any:
5126 ROS << "any";
5127 break;
5128 case Comdat::ExactMatch:
5129 ROS << "exactmatch";
5130 break;
5131 case Comdat::Largest:
5132 ROS << "largest";
5133 break;
5134 case Comdat::NoDeduplicate:
5135 ROS << "nodeduplicate";
5136 break;
5137 case Comdat::SameSize:
5138 ROS << "samesize";
5139 break;
5140 }
5141
5142 ROS << '\n';
5143}
5144
5145void Type::print(raw_ostream &OS, bool /*IsForDebug*/, bool NoDetails) const {
5146 TypePrinting TP;
5147 TP.print(Ty: const_cast<Type*>(this), OS);
5148
5149 if (NoDetails)
5150 return;
5151
5152 // If the type is a named struct type, print the body as well.
5153 if (auto *STy = dyn_cast<StructType>(Val: const_cast<Type *>(this)))
5154 if (!STy->isLiteral()) {
5155 OS << " = type ";
5156 TP.printStructBody(STy, OS);
5157 }
5158}
5159
5160static bool isReferencingMDNode(const Instruction &I) {
5161 if (const auto *CI = dyn_cast<CallInst>(Val: &I))
5162 if (Function *F = CI->getCalledFunction())
5163 if (F->isIntrinsic())
5164 for (auto &Op : I.operands())
5165 if (auto *V = dyn_cast_or_null<MetadataAsValue>(Val: Op))
5166 if (isa<MDNode>(Val: V->getMetadata()))
5167 return true;
5168 return false;
5169}
5170
5171void DbgMarker::print(raw_ostream &ROS, bool IsForDebug) const {
5172
5173 ModuleSlotTracker MST(getModuleFromDPI(Marker: this), true);
5174 print(ROS, MST, IsForDebug);
5175}
5176
5177void DbgVariableRecord::print(raw_ostream &ROS, bool IsForDebug) const {
5178
5179 ModuleSlotTracker MST(getModuleFromDPI(DR: this), true);
5180 print(ROS, MST, IsForDebug);
5181}
5182
5183void DbgMarker::print(raw_ostream &ROS, ModuleSlotTracker &MST,
5184 bool IsForDebug) const {
5185 formatted_raw_ostream OS(ROS);
5186 SlotTracker EmptySlotTable(static_cast<const Module *>(nullptr));
5187 SlotTracker &SlotTable =
5188 MST.getMachine() ? *MST.getMachine() : EmptySlotTable;
5189 const Function *F = getParent() ? getParent()->getParent() : nullptr;
5190 if (F)
5191 MST.incorporateFunction(F: *F);
5192 AssemblyWriter W(OS, SlotTable, getModuleFromDPI(Marker: this), nullptr, IsForDebug);
5193 W.printDbgMarker(Marker: *this);
5194}
5195
5196void DbgLabelRecord::print(raw_ostream &ROS, bool IsForDebug) const {
5197
5198 ModuleSlotTracker MST(getModuleFromDPI(DR: this), true);
5199 print(ROS, MST, IsForDebug);
5200}
5201
5202void DbgVariableRecord::print(raw_ostream &ROS, ModuleSlotTracker &MST,
5203 bool IsForDebug) const {
5204 formatted_raw_ostream OS(ROS);
5205 SlotTracker EmptySlotTable(static_cast<const Module *>(nullptr));
5206 SlotTracker &SlotTable =
5207 MST.getMachine() ? *MST.getMachine() : EmptySlotTable;
5208 const Function *F = Marker && Marker->getParent()
5209 ? Marker->getParent()->getParent()
5210 : nullptr;
5211 if (F)
5212 MST.incorporateFunction(F: *F);
5213 AssemblyWriter W(OS, SlotTable, getModuleFromDPI(DR: this), nullptr, IsForDebug);
5214 W.printDbgVariableRecord(DVR: *this);
5215}
5216
5217void DbgLabelRecord::print(raw_ostream &ROS, ModuleSlotTracker &MST,
5218 bool IsForDebug) const {
5219 formatted_raw_ostream OS(ROS);
5220 SlotTracker EmptySlotTable(static_cast<const Module *>(nullptr));
5221 SlotTracker &SlotTable =
5222 MST.getMachine() ? *MST.getMachine() : EmptySlotTable;
5223 const Function *F =
5224 Marker->getParent() ? Marker->getParent()->getParent() : nullptr;
5225 if (F)
5226 MST.incorporateFunction(F: *F);
5227
5228 AssemblyWriter W(OS, SlotTable, getModuleFromDPI(DR: this), nullptr, IsForDebug);
5229 W.printDbgLabelRecord(Label: *this);
5230}
5231
5232void Value::print(raw_ostream &ROS, bool IsForDebug) const {
5233 bool ShouldInitializeAllMetadata = false;
5234 if (auto *I = dyn_cast<Instruction>(Val: this))
5235 ShouldInitializeAllMetadata = isReferencingMDNode(I: *I);
5236 else if (isa<Function>(Val: this) || isa<MetadataAsValue>(Val: this))
5237 ShouldInitializeAllMetadata = true;
5238
5239 ModuleSlotTracker MST(getModuleFromVal(V: this), ShouldInitializeAllMetadata);
5240 print(O&: ROS, MST, IsForDebug);
5241}
5242
5243void Value::print(raw_ostream &ROS, ModuleSlotTracker &MST,
5244 bool IsForDebug) const {
5245 formatted_raw_ostream OS(ROS);
5246 SlotTracker EmptySlotTable(static_cast<const Module *>(nullptr));
5247 SlotTracker &SlotTable =
5248 MST.getMachine() ? *MST.getMachine() : EmptySlotTable;
5249 auto IncorporateFunction = [&](const Function *F) {
5250 if (F)
5251 MST.incorporateFunction(F: *F);
5252 };
5253
5254 if (const auto *I = dyn_cast<Instruction>(Val: this)) {
5255 IncorporateFunction(I->getParent() ? I->getParent()->getParent() : nullptr);
5256 AssemblyWriter W(OS, SlotTable, getModuleFromVal(V: I), nullptr, IsForDebug);
5257 W.printInstruction(I: *I);
5258 } else if (const auto *BB = dyn_cast<BasicBlock>(Val: this)) {
5259 IncorporateFunction(BB->getParent());
5260 AssemblyWriter W(OS, SlotTable, getModuleFromVal(V: BB), nullptr, IsForDebug);
5261 W.printBasicBlock(BB);
5262 } else if (const auto *GV = dyn_cast<GlobalValue>(Val: this)) {
5263 AssemblyWriter W(OS, SlotTable, GV->getParent(), nullptr, IsForDebug);
5264 if (const auto *V = dyn_cast<GlobalVariable>(Val: GV))
5265 W.printGlobal(GV: V);
5266 else if (const auto *F = dyn_cast<Function>(Val: GV))
5267 W.printFunction(F);
5268 else if (const auto *A = dyn_cast<GlobalAlias>(Val: GV))
5269 W.printAlias(GA: A);
5270 else if (const auto *I = dyn_cast<GlobalIFunc>(Val: GV))
5271 W.printIFunc(GI: I);
5272 else
5273 llvm_unreachable("Unknown GlobalValue to print out!");
5274 } else if (const auto *V = dyn_cast<MetadataAsValue>(Val: this)) {
5275 V->getMetadata()->print(OS&: ROS, MST, M: getModuleFromVal(V));
5276 } else if (const auto *C = dyn_cast<Constant>(Val: this)) {
5277 TypePrinting TypePrinter;
5278 TypePrinter.print(Ty: C->getType(), OS);
5279 OS << ' ';
5280 AsmWriterContext WriterCtx(&TypePrinter, MST.getMachine());
5281 writeConstantInternal(Out&: OS, CV: C, WriterCtx);
5282 } else if (isa<InlineAsm>(Val: this) || isa<Argument>(Val: this)) {
5283 this->printAsOperand(O&: OS, /* PrintType */ true, MST);
5284 } else {
5285 llvm_unreachable("Unknown value to print out!");
5286 }
5287}
5288
5289/// Print without a type, skipping the TypePrinting object.
5290///
5291/// \return \c true iff printing was successful.
5292static bool printWithoutType(const Value &V, raw_ostream &O,
5293 SlotTracker *Machine, const Module *M) {
5294 if (V.hasName() || isa<GlobalValue>(Val: V) ||
5295 (!isa<Constant>(Val: V) && !isa<MetadataAsValue>(Val: V))) {
5296 AsmWriterContext WriterCtx(nullptr, Machine, M);
5297 writeAsOperandInternal(Out&: O, V: &V, WriterCtx);
5298 return true;
5299 }
5300 return false;
5301}
5302
5303static void printAsOperandImpl(const Value &V, raw_ostream &O, bool PrintType,
5304 ModuleSlotTracker &MST) {
5305 TypePrinting TypePrinter(MST.getModule());
5306 AsmWriterContext WriterCtx(&TypePrinter, MST.getMachine(), MST.getModule());
5307 writeAsOperandInternal(Out&: O, V: &V, WriterCtx, PrintType);
5308}
5309
5310void Value::printAsOperand(raw_ostream &O, bool PrintType,
5311 const Module *M) const {
5312 if (!M)
5313 M = getModuleFromVal(V: this);
5314
5315 if (!PrintType)
5316 if (printWithoutType(V: *this, O, Machine: nullptr, M))
5317 return;
5318
5319 SlotTracker Machine(
5320 M, /* ShouldInitializeAllMetadata */ isa<MetadataAsValue>(Val: this));
5321 ModuleSlotTracker MST(Machine, M);
5322 printAsOperandImpl(V: *this, O, PrintType, MST);
5323}
5324
5325void Value::printAsOperand(raw_ostream &O, bool PrintType,
5326 ModuleSlotTracker &MST) const {
5327 if (!PrintType)
5328 if (printWithoutType(V: *this, O, Machine: MST.getMachine(), M: MST.getModule()))
5329 return;
5330
5331 printAsOperandImpl(V: *this, O, PrintType, MST);
5332}
5333
5334/// Recursive version of printMetadataImpl.
5335static void printMetadataImplRec(raw_ostream &ROS, const Metadata &MD,
5336 AsmWriterContext &WriterCtx) {
5337 formatted_raw_ostream OS(ROS);
5338 writeAsOperandInternal(Out&: OS, MD: &MD, WriterCtx, /* FromValue */ true);
5339
5340 auto *N = dyn_cast<MDNode>(Val: &MD);
5341 if (!N || isa<DIExpression>(Val: MD))
5342 return;
5343
5344 OS << " = ";
5345 writeMDNodeBodyInternal(Out&: OS, Node: N, Ctx&: WriterCtx);
5346}
5347
5348namespace {
5349struct MDTreeAsmWriterContext : public AsmWriterContext {
5350 unsigned Level;
5351 // {Level, Printed string}
5352 using EntryTy = std::pair<unsigned, std::string>;
5353 SmallVector<EntryTy, 4> Buffer;
5354
5355 // Used to break the cycle in case there is any.
5356 SmallPtrSet<const Metadata *, 4> Visited;
5357
5358 raw_ostream &MainOS;
5359
5360 MDTreeAsmWriterContext(TypePrinting *TP, SlotTracker *ST, const Module *M,
5361 raw_ostream &OS, const Metadata *InitMD)
5362 : AsmWriterContext(TP, ST, M), Level(0U), Visited({InitMD}), MainOS(OS) {}
5363
5364 void onWriteMetadataAsOperand(const Metadata *MD) override {
5365 if (!Visited.insert(Ptr: MD).second)
5366 return;
5367
5368 std::string Str;
5369 raw_string_ostream SS(Str);
5370 ++Level;
5371 // A placeholder entry to memorize the correct
5372 // position in buffer.
5373 Buffer.emplace_back(Args: std::make_pair(x&: Level, y: ""));
5374 unsigned InsertIdx = Buffer.size() - 1;
5375
5376 printMetadataImplRec(ROS&: SS, MD: *MD, WriterCtx&: *this);
5377 Buffer[InsertIdx].second = std::move(SS.str());
5378 --Level;
5379 }
5380
5381 ~MDTreeAsmWriterContext() override {
5382 for (const auto &Entry : Buffer) {
5383 MainOS << "\n";
5384 unsigned NumIndent = Entry.first * 2U;
5385 MainOS.indent(NumSpaces: NumIndent) << Entry.second;
5386 }
5387 }
5388};
5389} // end anonymous namespace
5390
5391static void printMetadataImpl(raw_ostream &ROS, const Metadata &MD,
5392 ModuleSlotTracker &MST, const Module *M,
5393 bool OnlyAsOperand, bool PrintAsTree = false) {
5394 formatted_raw_ostream OS(ROS);
5395
5396 TypePrinting TypePrinter(M);
5397
5398 std::unique_ptr<AsmWriterContext> WriterCtx;
5399 if (PrintAsTree && !OnlyAsOperand)
5400 WriterCtx = std::make_unique<MDTreeAsmWriterContext>(
5401 args: &TypePrinter, args: MST.getMachine(), args&: M, args&: OS, args: &MD);
5402 else
5403 WriterCtx =
5404 std::make_unique<AsmWriterContext>(args: &TypePrinter, args: MST.getMachine(), args&: M);
5405
5406 writeAsOperandInternal(Out&: OS, MD: &MD, WriterCtx&: *WriterCtx, /* FromValue */ true);
5407
5408 auto *N = dyn_cast<MDNode>(Val: &MD);
5409 if (OnlyAsOperand || !N || isa<DIExpression>(Val: MD))
5410 return;
5411
5412 OS << " = ";
5413 writeMDNodeBodyInternal(Out&: OS, Node: N, Ctx&: *WriterCtx);
5414}
5415
5416void Metadata::printAsOperand(raw_ostream &OS, const Module *M) const {
5417 ModuleSlotTracker MST(M, isa<MDNode>(Val: this));
5418 printMetadataImpl(ROS&: OS, MD: *this, MST, M, /* OnlyAsOperand */ true);
5419}
5420
5421void Metadata::printAsOperand(raw_ostream &OS, ModuleSlotTracker &MST,
5422 const Module *M) const {
5423 printMetadataImpl(ROS&: OS, MD: *this, MST, M, /* OnlyAsOperand */ true);
5424}
5425
5426void Metadata::print(raw_ostream &OS, const Module *M,
5427 bool /*IsForDebug*/) const {
5428 ModuleSlotTracker MST(M, isa<MDNode>(Val: this));
5429 printMetadataImpl(ROS&: OS, MD: *this, MST, M, /* OnlyAsOperand */ false);
5430}
5431
5432void Metadata::print(raw_ostream &OS, ModuleSlotTracker &MST,
5433 const Module *M, bool /*IsForDebug*/) const {
5434 printMetadataImpl(ROS&: OS, MD: *this, MST, M, /* OnlyAsOperand */ false);
5435}
5436
5437void MDNode::printTree(raw_ostream &OS, const Module *M) const {
5438 ModuleSlotTracker MST(M, true);
5439 printMetadataImpl(ROS&: OS, MD: *this, MST, M, /* OnlyAsOperand */ false,
5440 /*PrintAsTree=*/true);
5441}
5442
5443void MDNode::printTree(raw_ostream &OS, ModuleSlotTracker &MST,
5444 const Module *M) const {
5445 printMetadataImpl(ROS&: OS, MD: *this, MST, M, /* OnlyAsOperand */ false,
5446 /*PrintAsTree=*/true);
5447}
5448
5449void ModuleSummaryIndex::print(raw_ostream &ROS, bool IsForDebug) const {
5450 SlotTracker SlotTable(this);
5451 formatted_raw_ostream OS(ROS);
5452 AssemblyWriter W(OS, SlotTable, this, IsForDebug);
5453 W.printModuleSummaryIndex();
5454}
5455
5456void ModuleSlotTracker::collectMDNodes(MachineMDNodeListType &L, unsigned LB,
5457 unsigned UB) const {
5458 SlotTracker *ST = MachineStorage.get();
5459 if (!ST)
5460 return;
5461
5462 for (auto &I : llvm::make_range(x: ST->mdn_begin(), y: ST->mdn_end()))
5463 if (I.second >= LB && I.second < UB)
5464 L.push_back(x: std::make_pair(x&: I.second, y&: I.first));
5465}
5466
5467#if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
5468// Value::dump - allow easy printing of Values from the debugger.
5469LLVM_DUMP_METHOD
5470void Value::dump() const { print(dbgs(), /*IsForDebug=*/true); dbgs() << '\n'; }
5471
5472// Value::dump - allow easy printing of Values from the debugger.
5473LLVM_DUMP_METHOD
5474void DbgMarker::dump() const {
5475 print(dbgs(), /*IsForDebug=*/true);
5476 dbgs() << '\n';
5477}
5478
5479// Value::dump - allow easy printing of Values from the debugger.
5480LLVM_DUMP_METHOD
5481void DbgRecord::dump() const { print(dbgs(), /*IsForDebug=*/true); dbgs() << '\n'; }
5482
5483// Type::dump - allow easy printing of Types from the debugger.
5484LLVM_DUMP_METHOD
5485void Type::dump() const { print(dbgs(), /*IsForDebug=*/true); dbgs() << '\n'; }
5486
5487// Module::dump() - Allow printing of Modules from the debugger.
5488LLVM_DUMP_METHOD
5489void Module::dump() const {
5490 print(dbgs(), nullptr,
5491 /*ShouldPreserveUseListOrder=*/false, /*IsForDebug=*/true);
5492}
5493
5494// Allow printing of Comdats from the debugger.
5495LLVM_DUMP_METHOD
5496void Comdat::dump() const { print(dbgs(), /*IsForDebug=*/true); }
5497
5498// NamedMDNode::dump() - Allow printing of NamedMDNodes from the debugger.
5499LLVM_DUMP_METHOD
5500void NamedMDNode::dump() const { print(dbgs(), /*IsForDebug=*/true); }
5501
5502LLVM_DUMP_METHOD
5503void Metadata::dump() const { dump(nullptr); }
5504
5505LLVM_DUMP_METHOD
5506void Metadata::dump(const Module *M) const {
5507 print(dbgs(), M, /*IsForDebug=*/true);
5508 dbgs() << '\n';
5509}
5510
5511LLVM_DUMP_METHOD
5512void MDNode::dumpTree() const { dumpTree(nullptr); }
5513
5514LLVM_DUMP_METHOD
5515void MDNode::dumpTree(const Module *M) const {
5516 printTree(dbgs(), M);
5517 dbgs() << '\n';
5518}
5519
5520// Allow printing of ModuleSummaryIndex from the debugger.
5521LLVM_DUMP_METHOD
5522void ModuleSummaryIndex::dump() const { print(dbgs(), /*IsForDebug=*/true); }
5523#endif
5524