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 writeAPFloatInternal(raw_ostream &Out, const APFloat &APF) {
1540 if (&APF.getSemantics() == &APFloat::IEEEsingle() ||
1541 &APF.getSemantics() == &APFloat::IEEEdouble()) {
1542 // We would like to output the FP constant value in exponential notation,
1543 // but we cannot do this if doing so will lose precision. Check here to
1544 // make sure that we only output it in exponential format if we can parse
1545 // the value back and get the same value.
1546 //
1547 bool ignored;
1548 bool isDouble = &APF.getSemantics() == &APFloat::IEEEdouble();
1549 bool isInf = APF.isInfinity();
1550 bool isNaN = APF.isNaN();
1551
1552 if (!isInf && !isNaN) {
1553 double Val = APF.convertToDouble();
1554 SmallString<128> StrVal;
1555 APF.toString(Str&: StrVal, FormatPrecision: 6, FormatMaxPadding: 0, TruncateZero: false);
1556 // Check to make sure that the stringized number is not some string like
1557 // "Inf" or NaN, that atof will accept, but the lexer will not. Check
1558 // that the string matches the "[-+]?[0-9]" regex.
1559 //
1560 assert((isDigit(StrVal[0]) ||
1561 ((StrVal[0] == '-' || StrVal[0] == '+') && isDigit(StrVal[1]))) &&
1562 "[-+]?[0-9] regex does not match!");
1563 // Reparse stringized version!
1564 if (APFloat(APFloat::IEEEdouble(), StrVal).convertToDouble() == Val) {
1565 Out << StrVal;
1566 return;
1567 }
1568 }
1569
1570 // Otherwise we could not reparse it to exactly the same value, so we must
1571 // output the string in hexadecimal format! Note that loading and storing
1572 // floating point types changes the bits of NaNs on some hosts, notably
1573 // x86, so we must not use these types.
1574 static_assert(sizeof(double) == sizeof(uint64_t),
1575 "assuming that double is 64 bits!");
1576 APFloat apf = APF;
1577
1578 // Floats are represented in ASCII IR as double, convert.
1579 // FIXME: We should allow 32-bit hex float and remove this.
1580 if (!isDouble) {
1581 // A signaling NaN is quieted on conversion, so we need to recreate the
1582 // expected value after convert (quiet bit of the payload is clear).
1583 bool IsSNAN = apf.isSignaling();
1584 apf.convert(ToSemantics: APFloat::IEEEdouble(), RM: APFloat::rmNearestTiesToEven,
1585 losesInfo: &ignored);
1586 if (IsSNAN) {
1587 APInt Payload = apf.bitcastToAPInt();
1588 apf =
1589 APFloat::getSNaN(Sem: APFloat::IEEEdouble(), Negative: apf.isNegative(), payload: &Payload);
1590 }
1591 }
1592
1593 Out << format_hex(N: apf.bitcastToAPInt().getZExtValue(), Width: 0, /*Upper=*/true);
1594 return;
1595 }
1596
1597 // Either half, bfloat or some form of long double.
1598 // These appear as a magic letter identifying the type, then a
1599 // fixed number of hex digits.
1600 Out << "0x";
1601 APInt API = APF.bitcastToAPInt();
1602 if (&APF.getSemantics() == &APFloat::x87DoubleExtended()) {
1603 Out << 'K';
1604 Out << format_hex_no_prefix(N: API.getHiBits(numBits: 16).getZExtValue(), Width: 4,
1605 /*Upper=*/true);
1606 Out << format_hex_no_prefix(N: API.getLoBits(numBits: 64).getZExtValue(), Width: 16,
1607 /*Upper=*/true);
1608 } else if (&APF.getSemantics() == &APFloat::IEEEquad()) {
1609 Out << 'L';
1610 Out << format_hex_no_prefix(N: API.getLoBits(numBits: 64).getZExtValue(), Width: 16,
1611 /*Upper=*/true);
1612 Out << format_hex_no_prefix(N: API.getHiBits(numBits: 64).getZExtValue(), Width: 16,
1613 /*Upper=*/true);
1614 } else if (&APF.getSemantics() == &APFloat::PPCDoubleDouble()) {
1615 Out << 'M';
1616 Out << format_hex_no_prefix(N: API.getLoBits(numBits: 64).getZExtValue(), Width: 16,
1617 /*Upper=*/true);
1618 Out << format_hex_no_prefix(N: API.getHiBits(numBits: 64).getZExtValue(), Width: 16,
1619 /*Upper=*/true);
1620 } else if (&APF.getSemantics() == &APFloat::IEEEhalf()) {
1621 Out << 'H';
1622 Out << format_hex_no_prefix(N: API.getZExtValue(), Width: 4,
1623 /*Upper=*/true);
1624 } else if (&APF.getSemantics() == &APFloat::BFloat()) {
1625 Out << 'R';
1626 Out << format_hex_no_prefix(N: API.getZExtValue(), Width: 4,
1627 /*Upper=*/true);
1628 } else
1629 llvm_unreachable("Unsupported floating point type");
1630}
1631
1632static void writeConstantInternal(raw_ostream &Out, const Constant *CV,
1633 AsmWriterContext &WriterCtx) {
1634 if (const auto *CI = dyn_cast<ConstantInt>(Val: CV)) {
1635 Type *Ty = CI->getType();
1636
1637 if (Ty->isVectorTy()) {
1638 Out << "splat (";
1639 WriterCtx.TypePrinter->print(Ty: Ty->getScalarType(), OS&: Out);
1640 Out << " ";
1641 }
1642
1643 if (Ty->getScalarType()->isIntegerTy(Bitwidth: 1))
1644 Out << (CI->getZExtValue() ? "true" : "false");
1645 else
1646 Out << CI->getValue();
1647
1648 if (Ty->isVectorTy())
1649 Out << ")";
1650
1651 return;
1652 }
1653
1654 if (const auto *CB = dyn_cast<ConstantByte>(Val: CV)) {
1655 Type *Ty = CB->getType();
1656
1657 if (Ty->isVectorTy()) {
1658 Out << "splat (";
1659 WriterCtx.TypePrinter->print(Ty: Ty->getScalarType(), OS&: Out);
1660 Out << " ";
1661 }
1662
1663 Out << CB->getValue();
1664
1665 if (Ty->isVectorTy())
1666 Out << ")";
1667
1668 return;
1669 }
1670
1671 if (const auto *CFP = dyn_cast<ConstantFP>(Val: CV)) {
1672 Type *Ty = CFP->getType();
1673
1674 if (Ty->isVectorTy()) {
1675 Out << "splat (";
1676 WriterCtx.TypePrinter->print(Ty: Ty->getScalarType(), OS&: Out);
1677 Out << " ";
1678 }
1679
1680 writeAPFloatInternal(Out, APF: CFP->getValueAPF());
1681
1682 if (Ty->isVectorTy())
1683 Out << ")";
1684
1685 return;
1686 }
1687
1688 if (isa<ConstantAggregateZero>(Val: CV) || isa<ConstantTargetNone>(Val: CV)) {
1689 Out << "zeroinitializer";
1690 return;
1691 }
1692
1693 if (const auto *BA = dyn_cast<BlockAddress>(Val: CV)) {
1694 Out << "blockaddress(";
1695 writeAsOperandInternal(Out, V: BA->getFunction(), WriterCtx);
1696 Out << ", ";
1697 writeAsOperandInternal(Out, V: BA->getBasicBlock(), WriterCtx);
1698 Out << ")";
1699 return;
1700 }
1701
1702 if (const auto *Equiv = dyn_cast<DSOLocalEquivalent>(Val: CV)) {
1703 Out << "dso_local_equivalent ";
1704 writeAsOperandInternal(Out, V: Equiv->getGlobalValue(), WriterCtx);
1705 return;
1706 }
1707
1708 if (const auto *NC = dyn_cast<NoCFIValue>(Val: CV)) {
1709 Out << "no_cfi ";
1710 writeAsOperandInternal(Out, V: NC->getGlobalValue(), WriterCtx);
1711 return;
1712 }
1713
1714 if (const auto *CPA = dyn_cast<ConstantPtrAuth>(Val: CV)) {
1715 Out << "ptrauth (";
1716
1717 // ptrauth (ptr CST, i32 KEY[, i64 DISC[, ptr ADDRDISC[, ptr DS]?]?]?)
1718 unsigned NumOpsToWrite = 2;
1719 if (!CPA->getOperand(i_nocapture: 2)->isNullValue())
1720 NumOpsToWrite = 3;
1721 if (!CPA->getOperand(i_nocapture: 3)->isNullValue())
1722 NumOpsToWrite = 4;
1723 if (!CPA->getOperand(i_nocapture: 4)->isNullValue())
1724 NumOpsToWrite = 5;
1725
1726 ListSeparator LS;
1727 for (unsigned i = 0, e = NumOpsToWrite; i != e; ++i) {
1728 Out << LS;
1729 writeAsOperandInternal(Out, V: CPA->getOperand(i_nocapture: i), WriterCtx,
1730 /*PrintType=*/true);
1731 }
1732 Out << ')';
1733 return;
1734 }
1735
1736 if (const auto *CA = dyn_cast<ConstantArray>(Val: CV)) {
1737 Out << '[';
1738 ListSeparator LS;
1739 for (const Value *Op : CA->operands()) {
1740 Out << LS;
1741 writeAsOperandInternal(Out, V: Op, WriterCtx, /*PrintType=*/true);
1742 }
1743 Out << ']';
1744 return;
1745 }
1746
1747 if (const auto *CA = dyn_cast<ConstantDataArray>(Val: CV)) {
1748 // As a special case, print the array as a string if it is an array of
1749 // i8 with ConstantInt values.
1750 if (CA->isString()) {
1751 Out << "c\"";
1752 printEscapedString(Name: CA->getAsString(), Out);
1753 Out << '"';
1754 return;
1755 }
1756
1757 Out << '[';
1758 ListSeparator LS;
1759 for (uint64_t i = 0, e = CA->getNumElements(); i != e; ++i) {
1760 Out << LS;
1761 writeAsOperandInternal(Out, V: CA->getElementAsConstant(i), WriterCtx,
1762 /*PrintType=*/true);
1763 }
1764 Out << ']';
1765 return;
1766 }
1767
1768 if (const auto *CS = dyn_cast<ConstantStruct>(Val: CV)) {
1769 if (CS->getType()->isPacked())
1770 Out << '<';
1771 Out << '{';
1772 if (CS->getNumOperands() != 0) {
1773 Out << ' ';
1774 ListSeparator LS;
1775 for (const Value *Op : CS->operands()) {
1776 Out << LS;
1777 writeAsOperandInternal(Out, V: Op, WriterCtx, /*PrintType=*/true);
1778 }
1779 Out << ' ';
1780 }
1781 Out << '}';
1782 if (CS->getType()->isPacked())
1783 Out << '>';
1784 return;
1785 }
1786
1787 if (isa<ConstantVector>(Val: CV) || isa<ConstantDataVector>(Val: CV)) {
1788 auto *CVVTy = cast<FixedVectorType>(Val: CV->getType());
1789
1790 // Use the same shorthand for splat vector (i.e. "splat(Ty val)") as is
1791 // permitted on IR input to reduce the output changes when enabling
1792 // UseConstant{Int,FP}ForFixedLengthSplat.
1793 // TODO: Remove this block when the UseConstant{Int,FP}ForFixedLengthSplat
1794 // options are removed.
1795 if (auto *SplatVal = CV->getSplatValue()) {
1796 if (isa<ConstantInt>(Val: SplatVal) || isa<ConstantFP>(Val: SplatVal) ||
1797 isa<ConstantByte>(Val: SplatVal)) {
1798 Out << "splat (";
1799 writeAsOperandInternal(Out, V: SplatVal, WriterCtx, /*PrintType=*/true);
1800 Out << ')';
1801 return;
1802 }
1803 }
1804
1805 Out << '<';
1806 ListSeparator LS;
1807 for (unsigned i = 0, e = CVVTy->getNumElements(); i != e; ++i) {
1808 Out << LS;
1809 writeAsOperandInternal(Out, V: CV->getAggregateElement(Elt: i), WriterCtx,
1810 /*PrintType=*/true);
1811 }
1812 Out << '>';
1813 return;
1814 }
1815
1816 if (isa<ConstantPointerNull>(Val: CV)) {
1817 Out << "null";
1818 return;
1819 }
1820
1821 if (isa<ConstantTokenNone>(Val: CV)) {
1822 Out << "none";
1823 return;
1824 }
1825
1826 if (isa<PoisonValue>(Val: CV)) {
1827 Out << "poison";
1828 return;
1829 }
1830
1831 if (isa<UndefValue>(Val: CV)) {
1832 Out << "undef";
1833 return;
1834 }
1835
1836 if (const auto *CE = dyn_cast<ConstantExpr>(Val: CV)) {
1837 // Use the same shorthand for splat vector (i.e. "splat(Ty val)") as is
1838 // permitted on IR input to reduce the output changes when enabling
1839 // UseConstant{Int,FP}ForScalableSplat.
1840 // TODO: Remove this block when the UseConstant{Int,FP}ForScalableSplat
1841 // options are removed.
1842 if (CE->getOpcode() == Instruction::ShuffleVector) {
1843 if (auto *SplatVal = CE->getSplatValue()) {
1844 if (isa<ConstantInt>(Val: SplatVal) || isa<ConstantFP>(Val: SplatVal) ||
1845 isa<ConstantByte>(Val: SplatVal)) {
1846 Out << "splat (";
1847 writeAsOperandInternal(Out, V: SplatVal, WriterCtx, /*PrintType=*/true);
1848 Out << ')';
1849 return;
1850 }
1851 }
1852 }
1853
1854 Out << CE->getOpcodeName();
1855 writeOptimizationInfo(Out, U: CE);
1856 Out << " (";
1857
1858 if (const auto *GEP = dyn_cast<GEPOperator>(Val: CE)) {
1859 WriterCtx.TypePrinter->print(Ty: GEP->getSourceElementType(), OS&: Out);
1860 Out << ", ";
1861 }
1862
1863 ListSeparator LS;
1864 for (const Value *Op : CE->operands()) {
1865 Out << LS;
1866 writeAsOperandInternal(Out, V: Op, WriterCtx, /*PrintType=*/true);
1867 }
1868
1869 if (CE->isCast()) {
1870 Out << " to ";
1871 WriterCtx.TypePrinter->print(Ty: CE->getType(), OS&: Out);
1872 }
1873
1874 if (CE->getOpcode() == Instruction::ShuffleVector)
1875 printShuffleMask(Out, Ty: CE->getType(), Mask: CE->getShuffleMask());
1876
1877 Out << ')';
1878 return;
1879 }
1880
1881 Out << "<placeholder or erroneous Constant>";
1882}
1883
1884static void writeMDTuple(raw_ostream &Out, const MDTuple *Node,
1885 AsmWriterContext &WriterCtx) {
1886 Out << "!{";
1887 ListSeparator LS;
1888 for (const Metadata *MD : Node->operands()) {
1889 Out << LS;
1890 if (!MD) {
1891 Out << "null";
1892 } else if (auto *MDV = dyn_cast<ValueAsMetadata>(Val: MD)) {
1893 Value *V = MDV->getValue();
1894 writeAsOperandInternal(Out, V, WriterCtx, /*PrintType=*/true);
1895 } else {
1896 writeAsOperandInternal(Out, MD, WriterCtx);
1897 WriterCtx.onWriteMetadataAsOperand(MD);
1898 }
1899 }
1900
1901 Out << "}";
1902}
1903
1904namespace {
1905
1906struct MDFieldPrinter {
1907 raw_ostream &Out;
1908 ListSeparator FS;
1909 AsmWriterContext &WriterCtx;
1910
1911 explicit MDFieldPrinter(raw_ostream &Out)
1912 : Out(Out), WriterCtx(AsmWriterContext::getEmpty()) {}
1913 MDFieldPrinter(raw_ostream &Out, AsmWriterContext &Ctx)
1914 : Out(Out), WriterCtx(Ctx) {}
1915
1916 void printTag(const DINode *N);
1917 void printMacinfoType(const DIMacroNode *N);
1918 void printChecksum(const DIFile::ChecksumInfo<StringRef> &N);
1919 void printString(StringRef Name, StringRef Value,
1920 bool ShouldSkipEmpty = true);
1921 void printMetadata(StringRef Name, const Metadata *MD,
1922 bool ShouldSkipNull = true);
1923 void printMetadataOrInt(StringRef Name, const Metadata *MD, bool IsUnsigned,
1924 bool ShouldSkipZero = true);
1925 template <class IntTy>
1926 void printInt(StringRef Name, IntTy Int, bool ShouldSkipZero = true);
1927 void printAPInt(StringRef Name, const APInt &Int, bool IsUnsigned,
1928 bool ShouldSkipZero);
1929 void printBool(StringRef Name, bool Value,
1930 std::optional<bool> Default = std::nullopt);
1931 void printDIFlags(StringRef Name, DINode::DIFlags Flags);
1932 void printDISPFlags(StringRef Name, DISubprogram::DISPFlags Flags);
1933 template <class IntTy, class Stringifier>
1934 void printDwarfEnum(StringRef Name, IntTy Value, Stringifier toString,
1935 bool ShouldSkipZero = true);
1936 void printEmissionKind(StringRef Name, DICompileUnit::DebugEmissionKind EK);
1937 void printNameTableKind(StringRef Name,
1938 DICompileUnit::DebugNameTableKind NTK);
1939 void printFixedPointKind(StringRef Name, DIFixedPointType::FixedPointKind V);
1940};
1941
1942} // end anonymous namespace
1943
1944void MDFieldPrinter::printTag(const DINode *N) {
1945 Out << FS << "tag: ";
1946 auto Tag = dwarf::TagString(Tag: N->getTag());
1947 if (!Tag.empty())
1948 Out << Tag;
1949 else
1950 Out << N->getTag();
1951}
1952
1953void MDFieldPrinter::printMacinfoType(const DIMacroNode *N) {
1954 Out << FS << "type: ";
1955 auto Type = dwarf::MacinfoString(Encoding: N->getMacinfoType());
1956 if (!Type.empty())
1957 Out << Type;
1958 else
1959 Out << N->getMacinfoType();
1960}
1961
1962void MDFieldPrinter::printChecksum(
1963 const DIFile::ChecksumInfo<StringRef> &Checksum) {
1964 Out << FS << "checksumkind: " << Checksum.getKindAsString();
1965 printString(Name: "checksum", Value: Checksum.Value, /* ShouldSkipEmpty */ false);
1966}
1967
1968void MDFieldPrinter::printString(StringRef Name, StringRef Value,
1969 bool ShouldSkipEmpty) {
1970 if (ShouldSkipEmpty && Value.empty())
1971 return;
1972
1973 Out << FS << Name << ": \"";
1974 printEscapedString(Name: Value, Out);
1975 Out << "\"";
1976}
1977
1978static void writeMetadataAsOperand(raw_ostream &Out, const Metadata *MD,
1979 AsmWriterContext &WriterCtx) {
1980 if (!MD) {
1981 Out << "null";
1982 return;
1983 }
1984 writeAsOperandInternal(Out, MD, WriterCtx);
1985 WriterCtx.onWriteMetadataAsOperand(MD);
1986}
1987
1988void MDFieldPrinter::printMetadata(StringRef Name, const Metadata *MD,
1989 bool ShouldSkipNull) {
1990 if (ShouldSkipNull && !MD)
1991 return;
1992
1993 Out << FS << Name << ": ";
1994 writeMetadataAsOperand(Out, MD, WriterCtx);
1995}
1996
1997void MDFieldPrinter::printMetadataOrInt(StringRef Name, const Metadata *MD,
1998 bool IsUnsigned, bool ShouldSkipZero) {
1999 if (!MD)
2000 return;
2001
2002 if (auto *CI = dyn_cast<ConstantAsMetadata>(Val: MD)) {
2003 auto *CV = cast<ConstantInt>(Val: CI->getValue());
2004 if (IsUnsigned)
2005 printInt(Name, Int: CV->getZExtValue(), ShouldSkipZero);
2006 else
2007 printInt(Name, Int: CV->getSExtValue(), ShouldSkipZero);
2008 } else
2009 printMetadata(Name, MD);
2010}
2011
2012template <class IntTy>
2013void MDFieldPrinter::printInt(StringRef Name, IntTy Int, bool ShouldSkipZero) {
2014 if (ShouldSkipZero && !Int)
2015 return;
2016
2017 Out << FS << Name << ": " << Int;
2018}
2019
2020void MDFieldPrinter::printAPInt(StringRef Name, const APInt &Int,
2021 bool IsUnsigned, bool ShouldSkipZero) {
2022 if (ShouldSkipZero && Int.isZero())
2023 return;
2024
2025 Out << FS << Name << ": ";
2026 Int.print(OS&: Out, isSigned: !IsUnsigned);
2027}
2028
2029void MDFieldPrinter::printBool(StringRef Name, bool Value,
2030 std::optional<bool> Default) {
2031 if (Default && Value == *Default)
2032 return;
2033 Out << FS << Name << ": " << (Value ? "true" : "false");
2034}
2035
2036void MDFieldPrinter::printDIFlags(StringRef Name, DINode::DIFlags Flags) {
2037 if (!Flags)
2038 return;
2039
2040 Out << FS << Name << ": ";
2041
2042 SmallVector<DINode::DIFlags, 8> SplitFlags;
2043 auto Extra = DINode::splitFlags(Flags, SplitFlags);
2044
2045 ListSeparator FlagsFS(" | ");
2046 for (auto F : SplitFlags) {
2047 auto StringF = DINode::getFlagString(Flag: F);
2048 assert(!StringF.empty() && "Expected valid flag");
2049 Out << FlagsFS << StringF;
2050 }
2051 if (Extra || SplitFlags.empty())
2052 Out << FlagsFS << Extra;
2053}
2054
2055void MDFieldPrinter::printDISPFlags(StringRef Name,
2056 DISubprogram::DISPFlags Flags) {
2057 // Always print this field, because no flags in the IR at all will be
2058 // interpreted as old-style isDefinition: true.
2059 Out << FS << Name << ": ";
2060
2061 if (!Flags) {
2062 Out << 0;
2063 return;
2064 }
2065
2066 SmallVector<DISubprogram::DISPFlags, 8> SplitFlags;
2067 auto Extra = DISubprogram::splitFlags(Flags, SplitFlags);
2068
2069 ListSeparator FlagsFS(" | ");
2070 for (auto F : SplitFlags) {
2071 auto StringF = DISubprogram::getFlagString(Flag: F);
2072 assert(!StringF.empty() && "Expected valid flag");
2073 Out << FlagsFS << StringF;
2074 }
2075 if (Extra || SplitFlags.empty())
2076 Out << FlagsFS << Extra;
2077}
2078
2079void MDFieldPrinter::printEmissionKind(StringRef Name,
2080 DICompileUnit::DebugEmissionKind EK) {
2081 Out << FS << Name << ": " << DICompileUnit::emissionKindString(EK);
2082}
2083
2084void MDFieldPrinter::printNameTableKind(StringRef Name,
2085 DICompileUnit::DebugNameTableKind NTK) {
2086 if (NTK == DICompileUnit::DebugNameTableKind::Default)
2087 return;
2088 Out << FS << Name << ": " << DICompileUnit::nameTableKindString(PK: NTK);
2089}
2090
2091void MDFieldPrinter::printFixedPointKind(StringRef Name,
2092 DIFixedPointType::FixedPointKind V) {
2093 Out << FS << Name << ": " << DIFixedPointType::fixedPointKindString(V);
2094}
2095
2096template <class IntTy, class Stringifier>
2097void MDFieldPrinter::printDwarfEnum(StringRef Name, IntTy Value,
2098 Stringifier toString, bool ShouldSkipZero) {
2099 if (ShouldSkipZero && !Value)
2100 return;
2101
2102 Out << FS << Name << ": ";
2103 auto S = toString(Value);
2104 if (!S.empty())
2105 Out << S;
2106 else
2107 Out << Value;
2108}
2109
2110static void writeGenericDINode(raw_ostream &Out, const GenericDINode *N,
2111 AsmWriterContext &WriterCtx) {
2112 Out << "!GenericDINode(";
2113 MDFieldPrinter Printer(Out, WriterCtx);
2114 Printer.printTag(N);
2115 Printer.printString(Name: "header", Value: N->getHeader());
2116 if (N->getNumDwarfOperands()) {
2117 Out << Printer.FS << "operands: {";
2118 ListSeparator IFS;
2119 for (auto &I : N->dwarf_operands()) {
2120 Out << IFS;
2121 writeMetadataAsOperand(Out, MD: I, WriterCtx);
2122 }
2123 Out << "}";
2124 }
2125 Out << ")";
2126}
2127
2128static void writeDILocation(raw_ostream &Out, const DILocation *DL,
2129 AsmWriterContext &WriterCtx) {
2130 Out << "!DILocation(";
2131 MDFieldPrinter Printer(Out, WriterCtx);
2132 // Always output the line, since 0 is a relevant and important value for it.
2133 Printer.printInt(Name: "line", Int: DL->getLine(), /* ShouldSkipZero */ false);
2134 Printer.printInt(Name: "column", Int: DL->getColumn());
2135 Printer.printMetadata(Name: "scope", MD: DL->getRawScope(), /* ShouldSkipNull */ false);
2136 Printer.printMetadata(Name: "inlinedAt", MD: DL->getRawInlinedAt());
2137 Printer.printBool(Name: "isImplicitCode", Value: DL->isImplicitCode(),
2138 /* Default */ false);
2139 Printer.printInt(Name: "atomGroup", Int: DL->getAtomGroup());
2140 Printer.printInt<unsigned>(Name: "atomRank", Int: DL->getAtomRank());
2141 Out << ")";
2142}
2143
2144static void writeDIAssignID(raw_ostream &Out, const DIAssignID *DL,
2145 AsmWriterContext &WriterCtx) {
2146 Out << "!DIAssignID()";
2147 MDFieldPrinter Printer(Out, WriterCtx);
2148}
2149
2150static void writeDISubrange(raw_ostream &Out, const DISubrange *N,
2151 AsmWriterContext &WriterCtx) {
2152 Out << "!DISubrange(";
2153 MDFieldPrinter Printer(Out, WriterCtx);
2154
2155 Printer.printMetadataOrInt(Name: "count", MD: N->getRawCountNode(),
2156 /* IsUnsigned */ false,
2157 /* ShouldSkipZero */ false);
2158
2159 // A lowerBound of constant 0 should not be skipped, since it is different
2160 // from an unspecified lower bound (= nullptr).
2161 Printer.printMetadataOrInt(Name: "lowerBound", MD: N->getRawLowerBound(),
2162 /* IsUnsigned */ false,
2163 /* ShouldSkipZero */ false);
2164 Printer.printMetadataOrInt(Name: "upperBound", MD: N->getRawUpperBound(),
2165 /* IsUnsigned */ false,
2166 /* ShouldSkipZero */ false);
2167 Printer.printMetadataOrInt(Name: "stride", MD: N->getRawStride(),
2168 /* IsUnsigned */ false,
2169 /* ShouldSkipZero */ false);
2170
2171 Out << ")";
2172}
2173
2174static void writeDIGenericSubrange(raw_ostream &Out, const DIGenericSubrange *N,
2175 AsmWriterContext &WriterCtx) {
2176 Out << "!DIGenericSubrange(";
2177 MDFieldPrinter Printer(Out, WriterCtx);
2178
2179 auto GetConstant = [&](Metadata *Bound) -> std::optional<int64_t> {
2180 auto *BE = dyn_cast_or_null<DIExpression>(Val: Bound);
2181 if (!BE)
2182 return std::nullopt;
2183 if (BE->isConstant() &&
2184 DIExpression::SignedOrUnsignedConstant::SignedConstant ==
2185 *BE->isConstant()) {
2186 return static_cast<int64_t>(BE->getElement(I: 1));
2187 }
2188 return std::nullopt;
2189 };
2190
2191 auto *Count = N->getRawCountNode();
2192 if (auto ConstantCount = GetConstant(Count))
2193 Printer.printInt(Name: "count", Int: *ConstantCount,
2194 /* ShouldSkipZero */ false);
2195 else
2196 Printer.printMetadata(Name: "count", MD: Count, /*ShouldSkipNull */ true);
2197
2198 auto *LBound = N->getRawLowerBound();
2199 if (auto ConstantLBound = GetConstant(LBound))
2200 Printer.printInt(Name: "lowerBound", Int: *ConstantLBound,
2201 /* ShouldSkipZero */ false);
2202 else
2203 Printer.printMetadata(Name: "lowerBound", MD: LBound, /*ShouldSkipNull */ true);
2204
2205 auto *UBound = N->getRawUpperBound();
2206 if (auto ConstantUBound = GetConstant(UBound))
2207 Printer.printInt(Name: "upperBound", Int: *ConstantUBound,
2208 /* ShouldSkipZero */ false);
2209 else
2210 Printer.printMetadata(Name: "upperBound", MD: UBound, /*ShouldSkipNull */ true);
2211
2212 auto *Stride = N->getRawStride();
2213 if (auto ConstantStride = GetConstant(Stride))
2214 Printer.printInt(Name: "stride", Int: *ConstantStride,
2215 /* ShouldSkipZero */ false);
2216 else
2217 Printer.printMetadata(Name: "stride", MD: Stride, /*ShouldSkipNull */ true);
2218
2219 Out << ")";
2220}
2221
2222static void writeDIEnumerator(raw_ostream &Out, const DIEnumerator *N,
2223 AsmWriterContext &) {
2224 Out << "!DIEnumerator(";
2225 MDFieldPrinter Printer(Out);
2226 Printer.printString(Name: "name", Value: N->getName(), /* ShouldSkipEmpty */ false);
2227 Printer.printAPInt(Name: "value", Int: N->getValue(), IsUnsigned: N->isUnsigned(),
2228 /*ShouldSkipZero=*/false);
2229 if (N->isUnsigned())
2230 Printer.printBool(Name: "isUnsigned", Value: true);
2231 Out << ")";
2232}
2233
2234static void writeDIBasicType(raw_ostream &Out, const DIBasicType *N,
2235 AsmWriterContext &WriterCtx) {
2236 Out << "!DIBasicType(";
2237 MDFieldPrinter Printer(Out, WriterCtx);
2238 if (N->getTag() != dwarf::DW_TAG_base_type)
2239 Printer.printTag(N);
2240 Printer.printString(Name: "name", Value: N->getName());
2241 Printer.printMetadataOrInt(Name: "size", MD: N->getRawSizeInBits(), IsUnsigned: true);
2242 Printer.printInt(Name: "align", Int: N->getAlignInBits());
2243 Printer.printInt(Name: "dataSize", Int: N->getDataSizeInBits());
2244 Printer.printDwarfEnum(Name: "encoding", Value: N->getEncoding(),
2245 toString: dwarf::AttributeEncodingString);
2246 Printer.printInt(Name: "num_extra_inhabitants", Int: N->getNumExtraInhabitants());
2247 Printer.printDIFlags(Name: "flags", Flags: N->getFlags());
2248 Out << ")";
2249}
2250
2251static void writeDIFixedPointType(raw_ostream &Out, const DIFixedPointType *N,
2252 AsmWriterContext &WriterCtx) {
2253 Out << "!DIFixedPointType(";
2254 MDFieldPrinter Printer(Out, WriterCtx);
2255 if (N->getTag() != dwarf::DW_TAG_base_type)
2256 Printer.printTag(N);
2257 Printer.printString(Name: "name", Value: N->getName());
2258 Printer.printMetadataOrInt(Name: "size", MD: N->getRawSizeInBits(), IsUnsigned: true);
2259 Printer.printInt(Name: "align", Int: N->getAlignInBits());
2260 Printer.printDwarfEnum(Name: "encoding", Value: N->getEncoding(),
2261 toString: dwarf::AttributeEncodingString);
2262 Printer.printDIFlags(Name: "flags", Flags: N->getFlags());
2263 Printer.printFixedPointKind(Name: "kind", V: N->getKind());
2264 if (N->isRational()) {
2265 bool IsUnsigned = !N->isSigned();
2266 Printer.printAPInt(Name: "numerator", Int: N->getNumerator(), IsUnsigned, ShouldSkipZero: false);
2267 Printer.printAPInt(Name: "denominator", Int: N->getDenominator(), IsUnsigned, ShouldSkipZero: false);
2268 } else {
2269 Printer.printInt(Name: "factor", Int: N->getFactor());
2270 }
2271 Out << ")";
2272}
2273
2274static void writeDIStringType(raw_ostream &Out, const DIStringType *N,
2275 AsmWriterContext &WriterCtx) {
2276 Out << "!DIStringType(";
2277 MDFieldPrinter Printer(Out, WriterCtx);
2278 if (N->getTag() != dwarf::DW_TAG_string_type)
2279 Printer.printTag(N);
2280 Printer.printString(Name: "name", Value: N->getName());
2281 Printer.printMetadata(Name: "stringLength", MD: N->getRawStringLength());
2282 Printer.printMetadata(Name: "stringLengthExpression", MD: N->getRawStringLengthExp());
2283 Printer.printMetadata(Name: "stringLocationExpression",
2284 MD: N->getRawStringLocationExp());
2285 Printer.printMetadataOrInt(Name: "size", MD: N->getRawSizeInBits(), IsUnsigned: true);
2286 Printer.printInt(Name: "align", Int: N->getAlignInBits());
2287 Printer.printDwarfEnum(Name: "encoding", Value: N->getEncoding(),
2288 toString: dwarf::AttributeEncodingString);
2289 Out << ")";
2290}
2291
2292static void writeDIDerivedType(raw_ostream &Out, const DIDerivedType *N,
2293 AsmWriterContext &WriterCtx) {
2294 Out << "!DIDerivedType(";
2295 MDFieldPrinter Printer(Out, WriterCtx);
2296 Printer.printTag(N);
2297 Printer.printString(Name: "name", Value: N->getName());
2298 Printer.printMetadata(Name: "scope", MD: N->getRawScope());
2299 Printer.printMetadata(Name: "file", MD: N->getRawFile());
2300 Printer.printInt(Name: "line", Int: N->getLine());
2301 Printer.printMetadata(Name: "baseType", MD: N->getRawBaseType(),
2302 /* ShouldSkipNull */ false);
2303 Printer.printMetadataOrInt(Name: "size", MD: N->getRawSizeInBits(), IsUnsigned: true);
2304 Printer.printInt(Name: "align", Int: N->getAlignInBits());
2305 Printer.printMetadataOrInt(Name: "offset", MD: N->getRawOffsetInBits(), IsUnsigned: true);
2306 Printer.printDIFlags(Name: "flags", Flags: N->getFlags());
2307 Printer.printMetadata(Name: "extraData", MD: N->getRawExtraData());
2308 if (const auto &DWARFAddressSpace = N->getDWARFAddressSpace())
2309 Printer.printInt(Name: "dwarfAddressSpace", Int: *DWARFAddressSpace,
2310 /* ShouldSkipZero */ false);
2311 Printer.printMetadata(Name: "annotations", MD: N->getRawAnnotations());
2312 if (auto PtrAuthData = N->getPtrAuthData()) {
2313 Printer.printInt(Name: "ptrAuthKey", Int: PtrAuthData->key());
2314 Printer.printBool(Name: "ptrAuthIsAddressDiscriminated",
2315 Value: PtrAuthData->isAddressDiscriminated());
2316 Printer.printInt(Name: "ptrAuthExtraDiscriminator",
2317 Int: PtrAuthData->extraDiscriminator());
2318 Printer.printBool(Name: "ptrAuthIsaPointer", Value: PtrAuthData->isaPointer());
2319 Printer.printBool(Name: "ptrAuthAuthenticatesNullValues",
2320 Value: PtrAuthData->authenticatesNullValues());
2321 }
2322 Out << ")";
2323}
2324
2325static void writeDISubrangeType(raw_ostream &Out, const DISubrangeType *N,
2326 AsmWriterContext &WriterCtx) {
2327 Out << "!DISubrangeType(";
2328 MDFieldPrinter Printer(Out, WriterCtx);
2329 Printer.printString(Name: "name", Value: N->getName());
2330 Printer.printMetadata(Name: "scope", MD: N->getRawScope());
2331 Printer.printMetadata(Name: "file", MD: N->getRawFile());
2332 Printer.printInt(Name: "line", Int: N->getLine());
2333 Printer.printMetadataOrInt(Name: "size", MD: N->getRawSizeInBits(), IsUnsigned: true);
2334 Printer.printInt(Name: "align", Int: N->getAlignInBits());
2335 Printer.printDIFlags(Name: "flags", Flags: N->getFlags());
2336 Printer.printMetadata(Name: "baseType", MD: N->getRawBaseType(),
2337 /* ShouldSkipNull */ false);
2338 Printer.printMetadata(Name: "lowerBound", MD: N->getRawLowerBound());
2339 Printer.printMetadata(Name: "upperBound", MD: N->getRawUpperBound());
2340 Printer.printMetadata(Name: "stride", MD: N->getRawStride());
2341 Printer.printMetadata(Name: "bias", MD: N->getRawBias());
2342 Out << ")";
2343}
2344
2345static void writeDICompositeType(raw_ostream &Out, const DICompositeType *N,
2346 AsmWriterContext &WriterCtx) {
2347 Out << "!DICompositeType(";
2348 MDFieldPrinter Printer(Out, WriterCtx);
2349 Printer.printTag(N);
2350 Printer.printString(Name: "name", Value: N->getName());
2351 Printer.printMetadata(Name: "scope", MD: N->getRawScope());
2352 Printer.printMetadata(Name: "file", MD: N->getRawFile());
2353 Printer.printInt(Name: "line", Int: N->getLine());
2354 Printer.printMetadata(Name: "baseType", MD: N->getRawBaseType());
2355 Printer.printMetadataOrInt(Name: "size", MD: N->getRawSizeInBits(), IsUnsigned: true);
2356 Printer.printInt(Name: "align", Int: N->getAlignInBits());
2357 Printer.printMetadataOrInt(Name: "offset", MD: N->getRawOffsetInBits(), IsUnsigned: true);
2358 Printer.printInt(Name: "num_extra_inhabitants", Int: N->getNumExtraInhabitants());
2359 Printer.printDIFlags(Name: "flags", Flags: N->getFlags());
2360 Printer.printMetadata(Name: "elements", MD: N->getRawElements());
2361 Printer.printDwarfEnum(Name: "runtimeLang", Value: N->getRuntimeLang(),
2362 toString: dwarf::LanguageString);
2363 Printer.printMetadata(Name: "vtableHolder", MD: N->getRawVTableHolder());
2364 Printer.printMetadata(Name: "templateParams", MD: N->getRawTemplateParams());
2365 Printer.printString(Name: "identifier", Value: N->getIdentifier());
2366 Printer.printMetadata(Name: "discriminator", MD: N->getRawDiscriminator());
2367 Printer.printMetadata(Name: "dataLocation", MD: N->getRawDataLocation());
2368 Printer.printMetadata(Name: "associated", MD: N->getRawAssociated());
2369 Printer.printMetadata(Name: "allocated", MD: N->getRawAllocated());
2370 if (auto *RankConst = N->getRankConst())
2371 Printer.printInt(Name: "rank", Int: RankConst->getSExtValue(),
2372 /* ShouldSkipZero */ false);
2373 else
2374 Printer.printMetadata(Name: "rank", MD: N->getRawRank(), /*ShouldSkipNull */ true);
2375 Printer.printMetadata(Name: "annotations", MD: N->getRawAnnotations());
2376 if (auto *Specification = N->getRawSpecification())
2377 Printer.printMetadata(Name: "specification", MD: Specification);
2378
2379 if (auto EnumKind = N->getEnumKind())
2380 Printer.printDwarfEnum(Name: "enumKind", Value: *EnumKind, toString: dwarf::EnumKindString,
2381 /*ShouldSkipZero=*/false);
2382
2383 Printer.printMetadata(Name: "bitStride", MD: N->getRawBitStride());
2384 Out << ")";
2385}
2386
2387static void writeDISubroutineType(raw_ostream &Out, const DISubroutineType *N,
2388 AsmWriterContext &WriterCtx) {
2389 Out << "!DISubroutineType(";
2390 MDFieldPrinter Printer(Out, WriterCtx);
2391 Printer.printDIFlags(Name: "flags", Flags: N->getFlags());
2392 Printer.printDwarfEnum(Name: "cc", Value: N->getCC(), toString: dwarf::ConventionString);
2393 Printer.printMetadata(Name: "types", MD: N->getRawTypeArray(),
2394 /* ShouldSkipNull */ false);
2395 Out << ")";
2396}
2397
2398static void writeDIFile(raw_ostream &Out, const DIFile *N, AsmWriterContext &) {
2399 Out << "!DIFile(";
2400 MDFieldPrinter Printer(Out);
2401 Printer.printString(Name: "filename", Value: N->getFilename(),
2402 /* ShouldSkipEmpty */ false);
2403 Printer.printString(Name: "directory", Value: N->getDirectory(),
2404 /* ShouldSkipEmpty */ false);
2405 // Print all values for checksum together, or not at all.
2406 if (N->getChecksum())
2407 Printer.printChecksum(Checksum: *N->getChecksum());
2408 if (N->getSource())
2409 Printer.printString(Name: "source", Value: *N->getSource(),
2410 /* ShouldSkipEmpty */ false);
2411 Out << ")";
2412}
2413
2414static void writeDICompileUnit(raw_ostream &Out, const DICompileUnit *N,
2415 AsmWriterContext &WriterCtx) {
2416 Out << "!DICompileUnit(";
2417 MDFieldPrinter Printer(Out, WriterCtx);
2418
2419 DISourceLanguageName Lang = N->getSourceLanguage();
2420
2421 if (Lang.hasVersionedName()) {
2422 Printer.printDwarfEnum(
2423 Name: "sourceLanguageName",
2424 Value: static_cast<llvm::dwarf::SourceLanguageName>(Lang.getName()),
2425 toString: dwarf::SourceLanguageNameString,
2426 /* ShouldSkipZero */ false);
2427
2428 Printer.printInt(Name: "sourceLanguageVersion", Int: Lang.getVersion(),
2429 /*ShouldSkipZero=*/true);
2430 } else {
2431 Printer.printDwarfEnum(Name: "language", Value: Lang.getName(), toString: dwarf::LanguageString,
2432 /* ShouldSkipZero */ false);
2433 }
2434
2435 Printer.printMetadata(Name: "file", MD: N->getRawFile(), /* ShouldSkipNull */ false);
2436 Printer.printString(Name: "producer", Value: N->getProducer());
2437 Printer.printBool(Name: "isOptimized", Value: N->isOptimized());
2438 Printer.printString(Name: "flags", Value: N->getFlags());
2439 Printer.printInt(Name: "runtimeVersion", Int: N->getRuntimeVersion(),
2440 /* ShouldSkipZero */ false);
2441 Printer.printString(Name: "splitDebugFilename", Value: N->getSplitDebugFilename());
2442 Printer.printEmissionKind(Name: "emissionKind", EK: N->getEmissionKind());
2443 Printer.printMetadata(Name: "enums", MD: N->getRawEnumTypes());
2444 Printer.printMetadata(Name: "retainedTypes", MD: N->getRawRetainedTypes());
2445 Printer.printMetadata(Name: "globals", MD: N->getRawGlobalVariables());
2446 Printer.printMetadata(Name: "imports", MD: N->getRawImportedEntities());
2447 Printer.printMetadata(Name: "macros", MD: N->getRawMacros());
2448 Printer.printInt(Name: "dwoId", Int: N->getDWOId());
2449 Printer.printBool(Name: "splitDebugInlining", Value: N->getSplitDebugInlining(), Default: true);
2450 Printer.printBool(Name: "debugInfoForProfiling", Value: N->getDebugInfoForProfiling(),
2451 Default: false);
2452 Printer.printNameTableKind(Name: "nameTableKind", NTK: N->getNameTableKind());
2453 Printer.printBool(Name: "rangesBaseAddress", Value: N->getRangesBaseAddress(), Default: false);
2454 Printer.printString(Name: "sysroot", Value: N->getSysRoot());
2455 Printer.printString(Name: "sdk", Value: N->getSDK());
2456 Out << ")";
2457}
2458
2459static void writeDISubprogram(raw_ostream &Out, const DISubprogram *N,
2460 AsmWriterContext &WriterCtx) {
2461 Out << "!DISubprogram(";
2462 MDFieldPrinter Printer(Out, WriterCtx);
2463 Printer.printString(Name: "name", Value: N->getName());
2464 Printer.printString(Name: "linkageName", Value: N->getLinkageName());
2465 Printer.printMetadata(Name: "scope", MD: N->getRawScope(), /* ShouldSkipNull */ false);
2466 Printer.printMetadata(Name: "file", MD: N->getRawFile());
2467 Printer.printInt(Name: "line", Int: N->getLine());
2468 Printer.printMetadata(Name: "type", MD: N->getRawType());
2469 Printer.printInt(Name: "scopeLine", Int: N->getScopeLine());
2470 Printer.printMetadata(Name: "containingType", MD: N->getRawContainingType());
2471 if (N->getVirtuality() != dwarf::DW_VIRTUALITY_none ||
2472 N->getVirtualIndex() != 0)
2473 Printer.printInt(Name: "virtualIndex", Int: N->getVirtualIndex(), ShouldSkipZero: false);
2474 Printer.printInt(Name: "thisAdjustment", Int: N->getThisAdjustment());
2475 Printer.printDIFlags(Name: "flags", Flags: N->getFlags());
2476 Printer.printDISPFlags(Name: "spFlags", Flags: N->getSPFlags());
2477 Printer.printMetadata(Name: "unit", MD: N->getRawUnit());
2478 Printer.printMetadata(Name: "templateParams", MD: N->getRawTemplateParams());
2479 Printer.printMetadata(Name: "declaration", MD: N->getRawDeclaration());
2480 Printer.printMetadata(Name: "retainedNodes", MD: N->getRawRetainedNodes());
2481 Printer.printMetadata(Name: "thrownTypes", MD: N->getRawThrownTypes());
2482 Printer.printMetadata(Name: "annotations", MD: N->getRawAnnotations());
2483 Printer.printString(Name: "targetFuncName", Value: N->getTargetFuncName());
2484 Printer.printBool(Name: "keyInstructions", Value: N->getKeyInstructionsEnabled(), Default: false);
2485 Out << ")";
2486}
2487
2488static void writeDILexicalBlock(raw_ostream &Out, const DILexicalBlock *N,
2489 AsmWriterContext &WriterCtx) {
2490 Out << "!DILexicalBlock(";
2491 MDFieldPrinter Printer(Out, WriterCtx);
2492 Printer.printMetadata(Name: "scope", MD: N->getRawScope(), /* ShouldSkipNull */ false);
2493 Printer.printMetadata(Name: "file", MD: N->getRawFile());
2494 Printer.printInt(Name: "line", Int: N->getLine());
2495 Printer.printInt(Name: "column", Int: N->getColumn());
2496 Out << ")";
2497}
2498
2499static void writeDILexicalBlockFile(raw_ostream &Out,
2500 const DILexicalBlockFile *N,
2501 AsmWriterContext &WriterCtx) {
2502 Out << "!DILexicalBlockFile(";
2503 MDFieldPrinter Printer(Out, WriterCtx);
2504 Printer.printMetadata(Name: "scope", MD: N->getRawScope(), /* ShouldSkipNull */ false);
2505 Printer.printMetadata(Name: "file", MD: N->getRawFile());
2506 Printer.printInt(Name: "discriminator", Int: N->getDiscriminator(),
2507 /* ShouldSkipZero */ false);
2508 Out << ")";
2509}
2510
2511static void writeDINamespace(raw_ostream &Out, const DINamespace *N,
2512 AsmWriterContext &WriterCtx) {
2513 Out << "!DINamespace(";
2514 MDFieldPrinter Printer(Out, WriterCtx);
2515 Printer.printString(Name: "name", Value: N->getName());
2516 Printer.printMetadata(Name: "scope", MD: N->getRawScope(), /* ShouldSkipNull */ false);
2517 Printer.printBool(Name: "exportSymbols", Value: N->getExportSymbols(), Default: false);
2518 Out << ")";
2519}
2520
2521static void writeDICommonBlock(raw_ostream &Out, const DICommonBlock *N,
2522 AsmWriterContext &WriterCtx) {
2523 Out << "!DICommonBlock(";
2524 MDFieldPrinter Printer(Out, WriterCtx);
2525 Printer.printMetadata(Name: "scope", MD: N->getRawScope(), ShouldSkipNull: false);
2526 Printer.printMetadata(Name: "declaration", MD: N->getRawDecl(), ShouldSkipNull: false);
2527 Printer.printString(Name: "name", Value: N->getName());
2528 Printer.printMetadata(Name: "file", MD: N->getRawFile());
2529 Printer.printInt(Name: "line", Int: N->getLineNo());
2530 Out << ")";
2531}
2532
2533static void writeDIMacro(raw_ostream &Out, const DIMacro *N,
2534 AsmWriterContext &WriterCtx) {
2535 Out << "!DIMacro(";
2536 MDFieldPrinter Printer(Out, WriterCtx);
2537 Printer.printMacinfoType(N);
2538 Printer.printInt(Name: "line", Int: N->getLine());
2539 Printer.printString(Name: "name", Value: N->getName());
2540 Printer.printString(Name: "value", Value: N->getValue());
2541 Out << ")";
2542}
2543
2544static void writeDIMacroFile(raw_ostream &Out, const DIMacroFile *N,
2545 AsmWriterContext &WriterCtx) {
2546 Out << "!DIMacroFile(";
2547 MDFieldPrinter Printer(Out, WriterCtx);
2548 Printer.printInt(Name: "line", Int: N->getLine());
2549 Printer.printMetadata(Name: "file", MD: N->getRawFile(), /* ShouldSkipNull */ false);
2550 Printer.printMetadata(Name: "nodes", MD: N->getRawElements());
2551 Out << ")";
2552}
2553
2554static void writeDIModule(raw_ostream &Out, const DIModule *N,
2555 AsmWriterContext &WriterCtx) {
2556 Out << "!DIModule(";
2557 MDFieldPrinter Printer(Out, WriterCtx);
2558 Printer.printMetadata(Name: "scope", MD: N->getRawScope(), /* ShouldSkipNull */ false);
2559 Printer.printString(Name: "name", Value: N->getName());
2560 Printer.printString(Name: "configMacros", Value: N->getConfigurationMacros());
2561 Printer.printString(Name: "includePath", Value: N->getIncludePath());
2562 Printer.printString(Name: "apinotes", Value: N->getAPINotesFile());
2563 Printer.printMetadata(Name: "file", MD: N->getRawFile());
2564 Printer.printInt(Name: "line", Int: N->getLineNo());
2565 Printer.printBool(Name: "isDecl", Value: N->getIsDecl(), /* Default */ false);
2566 Out << ")";
2567}
2568
2569static void writeDITemplateTypeParameter(raw_ostream &Out,
2570 const DITemplateTypeParameter *N,
2571 AsmWriterContext &WriterCtx) {
2572 Out << "!DITemplateTypeParameter(";
2573 MDFieldPrinter Printer(Out, WriterCtx);
2574 Printer.printString(Name: "name", Value: N->getName());
2575 Printer.printMetadata(Name: "type", MD: N->getRawType(), /* ShouldSkipNull */ false);
2576 Printer.printBool(Name: "defaulted", Value: N->isDefault(), /* Default= */ false);
2577 Out << ")";
2578}
2579
2580static void writeDITemplateValueParameter(raw_ostream &Out,
2581 const DITemplateValueParameter *N,
2582 AsmWriterContext &WriterCtx) {
2583 Out << "!DITemplateValueParameter(";
2584 MDFieldPrinter Printer(Out, WriterCtx);
2585 if (N->getTag() != dwarf::DW_TAG_template_value_parameter)
2586 Printer.printTag(N);
2587 Printer.printString(Name: "name", Value: N->getName());
2588 Printer.printMetadata(Name: "type", MD: N->getRawType());
2589 Printer.printBool(Name: "defaulted", Value: N->isDefault(), /* Default= */ false);
2590 Printer.printMetadata(Name: "value", MD: N->getValue(), /* ShouldSkipNull */ false);
2591 Out << ")";
2592}
2593
2594static void writeDIGlobalVariable(raw_ostream &Out, const DIGlobalVariable *N,
2595 AsmWriterContext &WriterCtx) {
2596 Out << "!DIGlobalVariable(";
2597 MDFieldPrinter Printer(Out, WriterCtx);
2598 Printer.printString(Name: "name", Value: N->getName());
2599 Printer.printString(Name: "linkageName", Value: N->getLinkageName());
2600 Printer.printMetadata(Name: "scope", MD: N->getRawScope(), /* ShouldSkipNull */ false);
2601 Printer.printMetadata(Name: "file", MD: N->getRawFile());
2602 Printer.printInt(Name: "line", Int: N->getLine());
2603 Printer.printMetadata(Name: "type", MD: N->getRawType());
2604 Printer.printBool(Name: "isLocal", Value: N->isLocalToUnit());
2605 Printer.printBool(Name: "isDefinition", Value: N->isDefinition());
2606 Printer.printMetadata(Name: "declaration", MD: N->getRawStaticDataMemberDeclaration());
2607 Printer.printMetadata(Name: "templateParams", MD: N->getRawTemplateParams());
2608 Printer.printInt(Name: "align", Int: N->getAlignInBits());
2609 Printer.printMetadata(Name: "annotations", MD: N->getRawAnnotations());
2610 Out << ")";
2611}
2612
2613static void writeDILocalVariable(raw_ostream &Out, const DILocalVariable *N,
2614 AsmWriterContext &WriterCtx) {
2615 Out << "!DILocalVariable(";
2616 MDFieldPrinter Printer(Out, WriterCtx);
2617 Printer.printString(Name: "name", Value: N->getName());
2618 Printer.printInt(Name: "arg", Int: N->getArg());
2619 Printer.printMetadata(Name: "scope", MD: N->getRawScope(), /* ShouldSkipNull */ false);
2620 Printer.printMetadata(Name: "file", MD: N->getRawFile());
2621 Printer.printInt(Name: "line", Int: N->getLine());
2622 Printer.printMetadata(Name: "type", MD: N->getRawType());
2623 Printer.printDIFlags(Name: "flags", Flags: N->getFlags());
2624 Printer.printInt(Name: "align", Int: N->getAlignInBits());
2625 Printer.printMetadata(Name: "annotations", MD: N->getRawAnnotations());
2626 Out << ")";
2627}
2628
2629static void writeDILabel(raw_ostream &Out, const DILabel *N,
2630 AsmWriterContext &WriterCtx) {
2631 Out << "!DILabel(";
2632 MDFieldPrinter Printer(Out, WriterCtx);
2633 Printer.printMetadata(Name: "scope", MD: N->getRawScope(), /* ShouldSkipNull */ false);
2634 Printer.printString(Name: "name", Value: N->getName());
2635 Printer.printMetadata(Name: "file", MD: N->getRawFile());
2636 Printer.printInt(Name: "line", Int: N->getLine());
2637 Printer.printInt(Name: "column", Int: N->getColumn());
2638 Printer.printBool(Name: "isArtificial", Value: N->isArtificial(), Default: false);
2639 if (N->getCoroSuspendIdx())
2640 Printer.printInt(Name: "coroSuspendIdx", Int: *N->getCoroSuspendIdx(),
2641 /* ShouldSkipZero */ false);
2642 Out << ")";
2643}
2644
2645static void writeDIExpression(raw_ostream &Out, const DIExpression *N,
2646 AsmWriterContext &WriterCtx) {
2647 Out << "!DIExpression(";
2648 ListSeparator FS;
2649 if (N->isValid()) {
2650 for (const DIExpression::ExprOperand &Op : N->expr_ops()) {
2651 auto OpStr = dwarf::OperationEncodingString(Encoding: Op.getOp());
2652 assert(!OpStr.empty() && "Expected valid opcode");
2653
2654 Out << FS << OpStr;
2655 if (Op.getOp() == dwarf::DW_OP_LLVM_convert) {
2656 Out << FS << Op.getArg(I: 0);
2657 Out << FS << dwarf::AttributeEncodingString(Encoding: Op.getArg(I: 1));
2658 } else {
2659 for (unsigned A = 0, AE = Op.getNumArgs(); A != AE; ++A)
2660 Out << FS << Op.getArg(I: A);
2661 }
2662 }
2663 } else {
2664 for (const auto &I : N->getElements())
2665 Out << FS << I;
2666 }
2667 Out << ")";
2668}
2669
2670static void writeDIArgList(raw_ostream &Out, const DIArgList *N,
2671 AsmWriterContext &WriterCtx,
2672 bool FromValue = false) {
2673 assert(FromValue &&
2674 "Unexpected DIArgList metadata outside of value argument");
2675 Out << "!DIArgList(";
2676 ListSeparator FS;
2677 MDFieldPrinter Printer(Out, WriterCtx);
2678 for (const Metadata *Arg : N->getArgs()) {
2679 Out << FS;
2680 writeAsOperandInternal(Out, MD: Arg, WriterCtx, FromValue: true);
2681 }
2682 Out << ")";
2683}
2684
2685static void writeDIGlobalVariableExpression(raw_ostream &Out,
2686 const DIGlobalVariableExpression *N,
2687 AsmWriterContext &WriterCtx) {
2688 Out << "!DIGlobalVariableExpression(";
2689 MDFieldPrinter Printer(Out, WriterCtx);
2690 Printer.printMetadata(Name: "var", MD: N->getVariable());
2691 Printer.printMetadata(Name: "expr", MD: N->getExpression());
2692 Out << ")";
2693}
2694
2695static void writeDIObjCProperty(raw_ostream &Out, const DIObjCProperty *N,
2696 AsmWriterContext &WriterCtx) {
2697 Out << "!DIObjCProperty(";
2698 MDFieldPrinter Printer(Out, WriterCtx);
2699 Printer.printString(Name: "name", Value: N->getName());
2700 Printer.printMetadata(Name: "file", MD: N->getRawFile());
2701 Printer.printInt(Name: "line", Int: N->getLine());
2702 Printer.printString(Name: "setter", Value: N->getSetterName());
2703 Printer.printString(Name: "getter", Value: N->getGetterName());
2704 Printer.printInt(Name: "attributes", Int: N->getAttributes());
2705 Printer.printMetadata(Name: "type", MD: N->getRawType());
2706 Out << ")";
2707}
2708
2709static void writeDIImportedEntity(raw_ostream &Out, const DIImportedEntity *N,
2710 AsmWriterContext &WriterCtx) {
2711 Out << "!DIImportedEntity(";
2712 MDFieldPrinter Printer(Out, WriterCtx);
2713 Printer.printTag(N);
2714 Printer.printString(Name: "name", Value: N->getName());
2715 Printer.printMetadata(Name: "scope", MD: N->getRawScope(), /* ShouldSkipNull */ false);
2716 Printer.printMetadata(Name: "entity", MD: N->getRawEntity());
2717 Printer.printMetadata(Name: "file", MD: N->getRawFile());
2718 Printer.printInt(Name: "line", Int: N->getLine());
2719 Printer.printMetadata(Name: "elements", MD: N->getRawElements());
2720 Out << ")";
2721}
2722
2723static void writeMDNodeBodyInternal(raw_ostream &Out, const MDNode *Node,
2724 AsmWriterContext &Ctx) {
2725 if (Node->isDistinct())
2726 Out << "distinct ";
2727 else if (Node->isTemporary())
2728 Out << "<temporary!> "; // Handle broken code.
2729
2730 switch (Node->getMetadataID()) {
2731 default:
2732 llvm_unreachable("Expected uniquable MDNode");
2733#define HANDLE_MDNODE_LEAF(CLASS) \
2734 case Metadata::CLASS##Kind: \
2735 write##CLASS(Out, cast<CLASS>(Node), Ctx); \
2736 break;
2737#include "llvm/IR/Metadata.def"
2738 }
2739}
2740
2741// Full implementation of printing a Value as an operand with support for
2742// TypePrinting, etc.
2743static void writeAsOperandInternal(raw_ostream &Out, const Value *V,
2744 AsmWriterContext &WriterCtx,
2745 bool PrintType) {
2746 if (PrintType) {
2747 WriterCtx.TypePrinter->print(Ty: V->getType(), OS&: Out);
2748 Out << ' ';
2749 }
2750
2751 if (V->hasName()) {
2752 printLLVMName(OS&: Out, V);
2753 return;
2754 }
2755
2756 const auto *CV = dyn_cast<Constant>(Val: V);
2757 if (CV && !isa<GlobalValue>(Val: CV)) {
2758 assert(WriterCtx.TypePrinter && "Constants require TypePrinting!");
2759 writeConstantInternal(Out, CV, WriterCtx);
2760 return;
2761 }
2762
2763 if (const auto *IA = dyn_cast<InlineAsm>(Val: V)) {
2764 Out << "asm ";
2765 if (IA->hasSideEffects())
2766 Out << "sideeffect ";
2767 if (IA->isAlignStack())
2768 Out << "alignstack ";
2769 // We don't emit the AD_ATT dialect as it's the assumed default.
2770 if (IA->getDialect() == InlineAsm::AD_Intel)
2771 Out << "inteldialect ";
2772 if (IA->canThrow())
2773 Out << "unwind ";
2774 Out << '"';
2775 printEscapedString(Name: IA->getAsmString(), Out);
2776 Out << "\", \"";
2777 printEscapedString(Name: IA->getConstraintString(), Out);
2778 Out << '"';
2779 return;
2780 }
2781
2782 if (auto *MD = dyn_cast<MetadataAsValue>(Val: V)) {
2783 writeAsOperandInternal(Out, MD: MD->getMetadata(), WriterCtx,
2784 /* FromValue */ true);
2785 return;
2786 }
2787
2788 char Prefix = '%';
2789 int Slot;
2790 auto *Machine = WriterCtx.Machine;
2791 // If we have a SlotTracker, use it.
2792 if (Machine) {
2793 if (const auto *GV = dyn_cast<GlobalValue>(Val: V)) {
2794 Slot = Machine->getGlobalSlot(V: GV);
2795 Prefix = '@';
2796 } else {
2797 Slot = Machine->getLocalSlot(V);
2798
2799 // If the local value didn't succeed, then we may be referring to a value
2800 // from a different function. Translate it, as this can happen when using
2801 // address of blocks.
2802 if (Slot == -1)
2803 if ((Machine = createSlotTracker(V))) {
2804 Slot = Machine->getLocalSlot(V);
2805 delete Machine;
2806 }
2807 }
2808 } else if ((Machine = createSlotTracker(V))) {
2809 // Otherwise, create one to get the # and then destroy it.
2810 if (const auto *GV = dyn_cast<GlobalValue>(Val: V)) {
2811 Slot = Machine->getGlobalSlot(V: GV);
2812 Prefix = '@';
2813 } else {
2814 Slot = Machine->getLocalSlot(V);
2815 }
2816 delete Machine;
2817 Machine = nullptr;
2818 } else {
2819 Slot = -1;
2820 }
2821
2822 if (Slot != -1)
2823 Out << Prefix << Slot;
2824 else
2825 Out << "<badref>";
2826}
2827
2828static void writeAsOperandInternal(raw_ostream &Out, const Metadata *MD,
2829 AsmWriterContext &WriterCtx,
2830 bool FromValue) {
2831 // Write DIExpressions and DIArgLists inline when used as a value. Improves
2832 // readability of debug info intrinsics.
2833 if (const auto *Expr = dyn_cast<DIExpression>(Val: MD)) {
2834 writeDIExpression(Out, N: Expr, WriterCtx);
2835 return;
2836 }
2837 if (const auto *ArgList = dyn_cast<DIArgList>(Val: MD)) {
2838 writeDIArgList(Out, N: ArgList, WriterCtx, FromValue);
2839 return;
2840 }
2841
2842 if (const auto *N = dyn_cast<MDNode>(Val: MD)) {
2843 std::unique_ptr<SlotTracker> MachineStorage;
2844 SaveAndRestore SARMachine(WriterCtx.Machine);
2845 if (!WriterCtx.Machine) {
2846 MachineStorage = std::make_unique<SlotTracker>(args&: WriterCtx.Context);
2847 WriterCtx.Machine = MachineStorage.get();
2848 }
2849 int Slot = WriterCtx.Machine->getMetadataSlot(N);
2850 if (Slot == -1) {
2851 if (const auto *Loc = dyn_cast<DILocation>(Val: N)) {
2852 writeDILocation(Out, DL: Loc, WriterCtx);
2853 return;
2854 }
2855 // Give the pointer value instead of "badref", since this comes up all
2856 // the time when debugging.
2857 Out << "<" << N << ">";
2858 } else
2859 Out << '!' << Slot;
2860 return;
2861 }
2862
2863 if (const auto *MDS = dyn_cast<MDString>(Val: MD)) {
2864 Out << "!\"";
2865 printEscapedString(Name: MDS->getString(), Out);
2866 Out << '"';
2867 return;
2868 }
2869
2870 auto *V = cast<ValueAsMetadata>(Val: MD);
2871 assert(WriterCtx.TypePrinter && "TypePrinter required for metadata values");
2872 assert((FromValue || !isa<LocalAsMetadata>(V)) &&
2873 "Unexpected function-local metadata outside of value argument");
2874
2875 writeAsOperandInternal(Out, V: V->getValue(), WriterCtx, /*PrintType=*/true);
2876}
2877
2878namespace {
2879
2880class AssemblyWriter {
2881 formatted_raw_ostream &Out;
2882 const Module *TheModule = nullptr;
2883 const ModuleSummaryIndex *TheIndex = nullptr;
2884 std::unique_ptr<SlotTracker> SlotTrackerStorage;
2885 SlotTracker &Machine;
2886 TypePrinting TypePrinter;
2887 AssemblyAnnotationWriter *AnnotationWriter = nullptr;
2888 SetVector<const Comdat *> Comdats;
2889 bool IsForDebug;
2890 bool ShouldPreserveUseListOrder;
2891 UseListOrderMap UseListOrders;
2892 SmallVector<StringRef, 8> MDNames;
2893 /// Synchronization scope names registered with LLVMContext.
2894 SmallVector<StringRef, 8> SSNs;
2895 DenseMap<const GlobalValueSummary *, GlobalValue::GUID> SummaryToGUIDMap;
2896
2897public:
2898 /// Construct an AssemblyWriter with an external SlotTracker
2899 AssemblyWriter(formatted_raw_ostream &o, SlotTracker &Mac, const Module *M,
2900 AssemblyAnnotationWriter *AAW, bool IsForDebug,
2901 bool ShouldPreserveUseListOrder = false);
2902
2903 AssemblyWriter(formatted_raw_ostream &o, SlotTracker &Mac,
2904 const ModuleSummaryIndex *Index, bool IsForDebug);
2905
2906 AsmWriterContext getContext() {
2907 return AsmWriterContext(&TypePrinter, &Machine, TheModule);
2908 }
2909
2910 void printMDNodeBody(const MDNode *MD);
2911 void printNamedMDNode(const NamedMDNode *NMD);
2912
2913 void printModule(const Module *M);
2914
2915 void writeOperand(const Value *Op, bool PrintType);
2916 void writeParamOperand(const Value *Operand, AttributeSet Attrs);
2917 void writeOperandBundles(const CallBase *Call);
2918 void writeSyncScope(const LLVMContext &Context,
2919 SyncScope::ID SSID);
2920 void writeAtomic(const LLVMContext &Context,
2921 AtomicOrdering Ordering,
2922 SyncScope::ID SSID);
2923 void writeAtomicCmpXchg(const LLVMContext &Context,
2924 AtomicOrdering SuccessOrdering,
2925 AtomicOrdering FailureOrdering,
2926 SyncScope::ID SSID);
2927
2928 void writeAllMDNodes();
2929 void writeMDNode(unsigned Slot, const MDNode *Node);
2930 void writeAttribute(const Attribute &Attr, bool InAttrGroup = false);
2931 void writeAttributeSet(const AttributeSet &AttrSet, bool InAttrGroup = false);
2932 void writeAllAttributeGroups();
2933
2934 void printTypeIdentities();
2935 void printGlobal(const GlobalVariable *GV);
2936 void printAlias(const GlobalAlias *GA);
2937 void printIFunc(const GlobalIFunc *GI);
2938 void printComdat(const Comdat *C);
2939 void printFunction(const Function *F);
2940 void printArgument(const Argument *FA, AttributeSet Attrs);
2941 void printBasicBlock(const BasicBlock *BB);
2942 void printInstructionLine(const Instruction &I);
2943 void printInstruction(const Instruction &I);
2944 void printDbgMarker(const DbgMarker &DPI);
2945 void printDbgVariableRecord(const DbgVariableRecord &DVR);
2946 void printDbgLabelRecord(const DbgLabelRecord &DLR);
2947 void printDbgRecord(const DbgRecord &DR);
2948 void printDbgRecordLine(const DbgRecord &DR);
2949
2950 void printUseListOrder(const Value *V, ArrayRef<unsigned> Shuffle);
2951 void printUseLists(const Function *F);
2952
2953 void printModuleSummaryIndex();
2954 void printSummaryInfo(unsigned Slot, const ValueInfo &VI);
2955 void printSummary(const GlobalValueSummary &Summary);
2956 void printAliasSummary(const AliasSummary *AS);
2957 void printGlobalVarSummary(const GlobalVarSummary *GS);
2958 void printFunctionSummary(const FunctionSummary *FS);
2959 void printTypeIdSummary(const TypeIdSummary &TIS);
2960 void printTypeIdCompatibleVtableSummary(const TypeIdCompatibleVtableInfo &TI);
2961 void printTypeTestResolution(const TypeTestResolution &TTRes);
2962 void printArgs(ArrayRef<uint64_t> Args);
2963 void printWPDRes(const WholeProgramDevirtResolution &WPDRes);
2964 void printTypeIdInfo(const FunctionSummary::TypeIdInfo &TIDInfo);
2965 void printVFuncId(const FunctionSummary::VFuncId VFId);
2966 void printNonConstVCalls(ArrayRef<FunctionSummary::VFuncId> VCallList,
2967 const char *Tag);
2968 void printConstVCalls(ArrayRef<FunctionSummary::ConstVCall> VCallList,
2969 const char *Tag);
2970
2971private:
2972 /// Print out metadata attachments.
2973 void printMetadataAttachments(
2974 const SmallVectorImpl<std::pair<unsigned, MDNode *>> &MDs,
2975 StringRef Separator);
2976
2977 // printInfoComment - Print a little comment after the instruction indicating
2978 // which slot it occupies.
2979 void printInfoComment(const Value &V, bool isMaterializable = false);
2980
2981 // printGCRelocateComment - print comment after call to the gc.relocate
2982 // intrinsic indicating base and derived pointer names.
2983 void printGCRelocateComment(const GCRelocateInst &Relocate);
2984};
2985
2986} // end anonymous namespace
2987
2988AssemblyWriter::AssemblyWriter(formatted_raw_ostream &o, SlotTracker &Mac,
2989 const Module *M, AssemblyAnnotationWriter *AAW,
2990 bool IsForDebug, bool ShouldPreserveUseListOrder)
2991 : Out(o), TheModule(M), Machine(Mac), TypePrinter(M), AnnotationWriter(AAW),
2992 IsForDebug(IsForDebug),
2993 ShouldPreserveUseListOrder(
2994 PreserveAssemblyUseListOrder.getNumOccurrences()
2995 ? PreserveAssemblyUseListOrder
2996 : ShouldPreserveUseListOrder) {
2997 if (!TheModule)
2998 return;
2999 for (const GlobalObject &GO : TheModule->global_objects())
3000 if (const Comdat *C = GO.getComdat())
3001 Comdats.insert(X: C);
3002}
3003
3004AssemblyWriter::AssemblyWriter(formatted_raw_ostream &o, SlotTracker &Mac,
3005 const ModuleSummaryIndex *Index, bool IsForDebug)
3006 : Out(o), TheIndex(Index), Machine(Mac), TypePrinter(/*Module=*/nullptr),
3007 IsForDebug(IsForDebug),
3008 ShouldPreserveUseListOrder(PreserveAssemblyUseListOrder) {}
3009
3010void AssemblyWriter::writeOperand(const Value *Operand, bool PrintType) {
3011 if (!Operand) {
3012 Out << "<null operand!>";
3013 return;
3014 }
3015 auto WriteCtx = getContext();
3016 writeAsOperandInternal(Out, V: Operand, WriterCtx&: WriteCtx, PrintType);
3017}
3018
3019void AssemblyWriter::writeSyncScope(const LLVMContext &Context,
3020 SyncScope::ID SSID) {
3021 switch (SSID) {
3022 case SyncScope::System: {
3023 break;
3024 }
3025 default: {
3026 if (SSNs.empty())
3027 Context.getSyncScopeNames(SSNs);
3028
3029 Out << " syncscope(\"";
3030 printEscapedString(Name: SSNs[SSID], Out);
3031 Out << "\")";
3032 break;
3033 }
3034 }
3035}
3036
3037void AssemblyWriter::writeAtomic(const LLVMContext &Context,
3038 AtomicOrdering Ordering,
3039 SyncScope::ID SSID) {
3040 if (Ordering == AtomicOrdering::NotAtomic)
3041 return;
3042
3043 writeSyncScope(Context, SSID);
3044 Out << " " << toIRString(ao: Ordering);
3045}
3046
3047void AssemblyWriter::writeAtomicCmpXchg(const LLVMContext &Context,
3048 AtomicOrdering SuccessOrdering,
3049 AtomicOrdering FailureOrdering,
3050 SyncScope::ID SSID) {
3051 assert(SuccessOrdering != AtomicOrdering::NotAtomic &&
3052 FailureOrdering != AtomicOrdering::NotAtomic);
3053
3054 writeSyncScope(Context, SSID);
3055 Out << " " << toIRString(ao: SuccessOrdering);
3056 Out << " " << toIRString(ao: FailureOrdering);
3057}
3058
3059void AssemblyWriter::writeParamOperand(const Value *Operand,
3060 AttributeSet Attrs) {
3061 if (!Operand) {
3062 Out << "<null operand!>";
3063 return;
3064 }
3065
3066 // Print the type
3067 TypePrinter.print(Ty: Operand->getType(), OS&: Out);
3068 // Print parameter attributes list
3069 if (Attrs.hasAttributes()) {
3070 Out << ' ';
3071 writeAttributeSet(AttrSet: Attrs);
3072 }
3073 Out << ' ';
3074 // Print the operand
3075 auto WriterCtx = getContext();
3076 writeAsOperandInternal(Out, V: Operand, WriterCtx);
3077}
3078
3079void AssemblyWriter::writeOperandBundles(const CallBase *Call) {
3080 if (!Call->hasOperandBundles())
3081 return;
3082
3083 Out << " [ ";
3084
3085 ListSeparator LS;
3086 for (unsigned i = 0, e = Call->getNumOperandBundles(); i != e; ++i) {
3087 OperandBundleUse BU = Call->getOperandBundleAt(Index: i);
3088
3089 Out << LS << '"';
3090 printEscapedString(Name: BU.getTagName(), Out);
3091 Out << '"';
3092
3093 Out << '(';
3094
3095 ListSeparator InnerLS;
3096 auto WriterCtx = getContext();
3097 for (const auto &Input : BU.Inputs) {
3098 Out << InnerLS;
3099 if (Input == nullptr)
3100 Out << "<null operand bundle!>";
3101 else
3102 writeAsOperandInternal(Out, V: Input, WriterCtx, /*PrintType=*/true);
3103 }
3104
3105 Out << ')';
3106 }
3107
3108 Out << " ]";
3109}
3110
3111void AssemblyWriter::printModule(const Module *M) {
3112 Machine.initializeIfNeeded();
3113
3114 if (ShouldPreserveUseListOrder)
3115 UseListOrders = predictUseListOrder(M);
3116
3117 if (!M->getModuleIdentifier().empty() &&
3118 // Don't print the ID if it will start a new line (which would
3119 // require a comment char before it).
3120 M->getModuleIdentifier().find(c: '\n') == std::string::npos)
3121 Out << "; ModuleID = '" << M->getModuleIdentifier() << "'\n";
3122
3123 if (!M->getSourceFileName().empty()) {
3124 Out << "source_filename = \"";
3125 printEscapedString(Name: M->getSourceFileName(), Out);
3126 Out << "\"\n";
3127 }
3128
3129 const std::string &DL = M->getDataLayoutStr();
3130 if (!DL.empty())
3131 Out << "target datalayout = \"" << DL << "\"\n";
3132 if (!M->getTargetTriple().empty())
3133 Out << "target triple = \"" << M->getTargetTriple().str() << "\"\n";
3134
3135 if (!M->getModuleInlineAsm().empty()) {
3136 Out << '\n';
3137
3138 // Split the string into lines, to make it easier to read the .ll file.
3139 StringRef Asm = M->getModuleInlineAsm();
3140 do {
3141 StringRef Front;
3142 std::tie(args&: Front, args&: Asm) = Asm.split(Separator: '\n');
3143
3144 // We found a newline, print the portion of the asm string from the
3145 // last newline up to this newline.
3146 Out << "module asm \"";
3147 printEscapedString(Name: Front, Out);
3148 Out << "\"\n";
3149 } while (!Asm.empty());
3150 }
3151
3152 printTypeIdentities();
3153
3154 // Output all comdats.
3155 if (!Comdats.empty())
3156 Out << '\n';
3157 for (const Comdat *C : Comdats) {
3158 printComdat(C);
3159 if (C != Comdats.back())
3160 Out << '\n';
3161 }
3162
3163 // Output all globals.
3164 if (!M->global_empty()) Out << '\n';
3165 for (const GlobalVariable &GV : M->globals()) {
3166 printGlobal(GV: &GV); Out << '\n';
3167 }
3168
3169 // Output all aliases.
3170 if (!M->alias_empty()) Out << "\n";
3171 for (const GlobalAlias &GA : M->aliases())
3172 printAlias(GA: &GA);
3173
3174 // Output all ifuncs.
3175 if (!M->ifunc_empty()) Out << "\n";
3176 for (const GlobalIFunc &GI : M->ifuncs())
3177 printIFunc(GI: &GI);
3178
3179 // Output all of the functions.
3180 for (const Function &F : *M) {
3181 Out << '\n';
3182 printFunction(F: &F);
3183 }
3184
3185 // Output global use-lists.
3186 printUseLists(F: nullptr);
3187
3188 // Output all attribute groups.
3189 if (!Machine.as_empty()) {
3190 Out << '\n';
3191 writeAllAttributeGroups();
3192 }
3193
3194 // Output named metadata.
3195 if (!M->named_metadata_empty()) Out << '\n';
3196
3197 for (const NamedMDNode &Node : M->named_metadata())
3198 printNamedMDNode(NMD: &Node);
3199
3200 // Output metadata.
3201 if (!Machine.mdn_empty()) {
3202 Out << '\n';
3203 writeAllMDNodes();
3204 }
3205}
3206
3207void AssemblyWriter::printModuleSummaryIndex() {
3208 assert(TheIndex);
3209 int NumSlots = Machine.initializeIndexIfNeeded();
3210
3211 Out << "\n";
3212
3213 // Print module path entries. To print in order, add paths to a vector
3214 // indexed by module slot.
3215 std::vector<std::pair<std::string, ModuleHash>> moduleVec;
3216 std::string RegularLTOModuleName =
3217 ModuleSummaryIndex::getRegularLTOModuleName();
3218 moduleVec.resize(new_size: TheIndex->modulePaths().size());
3219 for (auto &[ModPath, ModHash] : TheIndex->modulePaths())
3220 moduleVec[Machine.getModulePathSlot(Path: ModPath)] = std::make_pair(
3221 // An empty module path is a special entry for a regular LTO module
3222 // created during the thin link.
3223 x: ModPath.empty() ? RegularLTOModuleName : std::string(ModPath), y: ModHash);
3224
3225 unsigned i = 0;
3226 for (auto &ModPair : moduleVec) {
3227 Out << "^" << i++ << " = module: (";
3228 Out << "path: \"";
3229 printEscapedString(Name: ModPair.first, Out);
3230 Out << "\", hash: (";
3231 ListSeparator FS;
3232 for (auto Hash : ModPair.second)
3233 Out << FS << Hash;
3234 Out << "))\n";
3235 }
3236
3237 // FIXME: Change AliasSummary to hold a ValueInfo instead of summary pointer
3238 // for aliasee (then update BitcodeWriter.cpp and remove get/setAliaseeGUID).
3239 for (auto &GlobalList : *TheIndex) {
3240 auto GUID = GlobalList.first;
3241 for (auto &Summary : GlobalList.second.getSummaryList())
3242 SummaryToGUIDMap[Summary.get()] = GUID;
3243 }
3244
3245 // Print the global value summary entries.
3246 for (auto &GlobalList : *TheIndex) {
3247 auto GUID = GlobalList.first;
3248 auto VI = TheIndex->getValueInfo(R: GlobalList);
3249 printSummaryInfo(Slot: Machine.getGUIDSlot(GUID), VI);
3250 }
3251
3252 // Print the TypeIdMap entries.
3253 for (const auto &TID : TheIndex->typeIds()) {
3254 Out << "^" << Machine.getTypeIdSlot(Id: TID.second.first)
3255 << " = typeid: (name: \"" << TID.second.first << "\"";
3256 printTypeIdSummary(TIS: TID.second.second);
3257 Out << ") ; guid = " << TID.first << "\n";
3258 }
3259
3260 // Print the TypeIdCompatibleVtableMap entries.
3261 for (auto &TId : TheIndex->typeIdCompatibleVtableMap()) {
3262 auto GUID = GlobalValue::getGUIDAssumingExternalLinkage(GlobalName: TId.first);
3263 Out << "^" << Machine.getTypeIdCompatibleVtableSlot(Id: TId.first)
3264 << " = typeidCompatibleVTable: (name: \"" << TId.first << "\"";
3265 printTypeIdCompatibleVtableSummary(TI: TId.second);
3266 Out << ") ; guid = " << GUID << "\n";
3267 }
3268
3269 // Don't emit flags when it's not really needed (value is zero by default).
3270 if (TheIndex->getFlags()) {
3271 Out << "^" << NumSlots << " = flags: " << TheIndex->getFlags() << "\n";
3272 ++NumSlots;
3273 }
3274
3275 Out << "^" << NumSlots << " = blockcount: " << TheIndex->getBlockCount()
3276 << "\n";
3277}
3278
3279static const char *
3280getWholeProgDevirtResKindName(WholeProgramDevirtResolution::Kind K) {
3281 switch (K) {
3282 case WholeProgramDevirtResolution::Indir:
3283 return "indir";
3284 case WholeProgramDevirtResolution::SingleImpl:
3285 return "singleImpl";
3286 case WholeProgramDevirtResolution::BranchFunnel:
3287 return "branchFunnel";
3288 }
3289 llvm_unreachable("invalid WholeProgramDevirtResolution kind");
3290}
3291
3292static const char *getWholeProgDevirtResByArgKindName(
3293 WholeProgramDevirtResolution::ByArg::Kind K) {
3294 switch (K) {
3295 case WholeProgramDevirtResolution::ByArg::Indir:
3296 return "indir";
3297 case WholeProgramDevirtResolution::ByArg::UniformRetVal:
3298 return "uniformRetVal";
3299 case WholeProgramDevirtResolution::ByArg::UniqueRetVal:
3300 return "uniqueRetVal";
3301 case WholeProgramDevirtResolution::ByArg::VirtualConstProp:
3302 return "virtualConstProp";
3303 }
3304 llvm_unreachable("invalid WholeProgramDevirtResolution::ByArg kind");
3305}
3306
3307static const char *getTTResKindName(TypeTestResolution::Kind K) {
3308 switch (K) {
3309 case TypeTestResolution::Unknown:
3310 return "unknown";
3311 case TypeTestResolution::Unsat:
3312 return "unsat";
3313 case TypeTestResolution::ByteArray:
3314 return "byteArray";
3315 case TypeTestResolution::Inline:
3316 return "inline";
3317 case TypeTestResolution::Single:
3318 return "single";
3319 case TypeTestResolution::AllOnes:
3320 return "allOnes";
3321 }
3322 llvm_unreachable("invalid TypeTestResolution kind");
3323}
3324
3325void AssemblyWriter::printTypeTestResolution(const TypeTestResolution &TTRes) {
3326 Out << "typeTestRes: (kind: " << getTTResKindName(K: TTRes.TheKind)
3327 << ", sizeM1BitWidth: " << TTRes.SizeM1BitWidth;
3328
3329 // The following fields are only used if the target does not support the use
3330 // of absolute symbols to store constants. Print only if non-zero.
3331 if (TTRes.AlignLog2)
3332 Out << ", alignLog2: " << TTRes.AlignLog2;
3333 if (TTRes.SizeM1)
3334 Out << ", sizeM1: " << TTRes.SizeM1;
3335 if (TTRes.BitMask)
3336 // BitMask is uint8_t which causes it to print the corresponding char.
3337 Out << ", bitMask: " << (unsigned)TTRes.BitMask;
3338 if (TTRes.InlineBits)
3339 Out << ", inlineBits: " << TTRes.InlineBits;
3340
3341 Out << ")";
3342}
3343
3344void AssemblyWriter::printTypeIdSummary(const TypeIdSummary &TIS) {
3345 Out << ", summary: (";
3346 printTypeTestResolution(TTRes: TIS.TTRes);
3347 if (!TIS.WPDRes.empty()) {
3348 Out << ", wpdResolutions: (";
3349 ListSeparator FS;
3350 for (auto &WPDRes : TIS.WPDRes) {
3351 Out << FS;
3352 Out << "(offset: " << WPDRes.first << ", ";
3353 printWPDRes(WPDRes: WPDRes.second);
3354 Out << ")";
3355 }
3356 Out << ")";
3357 }
3358 Out << ")";
3359}
3360
3361void AssemblyWriter::printTypeIdCompatibleVtableSummary(
3362 const TypeIdCompatibleVtableInfo &TI) {
3363 Out << ", summary: (";
3364 ListSeparator FS;
3365 for (auto &P : TI) {
3366 Out << FS;
3367 Out << "(offset: " << P.AddressPointOffset << ", ";
3368 Out << "^" << Machine.getGUIDSlot(GUID: P.VTableVI.getGUID());
3369 Out << ")";
3370 }
3371 Out << ")";
3372}
3373
3374void AssemblyWriter::printArgs(ArrayRef<uint64_t> Args) {
3375 Out << "args: (" << llvm::interleaved(R: Args) << ')';
3376}
3377
3378void AssemblyWriter::printWPDRes(const WholeProgramDevirtResolution &WPDRes) {
3379 Out << "wpdRes: (kind: ";
3380 Out << getWholeProgDevirtResKindName(K: WPDRes.TheKind);
3381
3382 if (WPDRes.TheKind == WholeProgramDevirtResolution::SingleImpl)
3383 Out << ", singleImplName: \"" << WPDRes.SingleImplName << "\"";
3384
3385 if (!WPDRes.ResByArg.empty()) {
3386 Out << ", resByArg: (";
3387 ListSeparator FS;
3388 for (auto &ResByArg : WPDRes.ResByArg) {
3389 Out << FS;
3390 printArgs(Args: ResByArg.first);
3391 Out << ", byArg: (kind: ";
3392 Out << getWholeProgDevirtResByArgKindName(K: ResByArg.second.TheKind);
3393 if (ResByArg.second.TheKind ==
3394 WholeProgramDevirtResolution::ByArg::UniformRetVal ||
3395 ResByArg.second.TheKind ==
3396 WholeProgramDevirtResolution::ByArg::UniqueRetVal)
3397 Out << ", info: " << ResByArg.second.Info;
3398
3399 // The following fields are only used if the target does not support the
3400 // use of absolute symbols to store constants. Print only if non-zero.
3401 if (ResByArg.second.Byte || ResByArg.second.Bit)
3402 Out << ", byte: " << ResByArg.second.Byte
3403 << ", bit: " << ResByArg.second.Bit;
3404
3405 Out << ")";
3406 }
3407 Out << ")";
3408 }
3409 Out << ")";
3410}
3411
3412static const char *getSummaryKindName(GlobalValueSummary::SummaryKind SK) {
3413 switch (SK) {
3414 case GlobalValueSummary::AliasKind:
3415 return "alias";
3416 case GlobalValueSummary::FunctionKind:
3417 return "function";
3418 case GlobalValueSummary::GlobalVarKind:
3419 return "variable";
3420 }
3421 llvm_unreachable("invalid summary kind");
3422}
3423
3424void AssemblyWriter::printAliasSummary(const AliasSummary *AS) {
3425 Out << ", aliasee: ";
3426 // The indexes emitted for distributed backends may not include the
3427 // aliasee summary (only if it is being imported directly). Handle
3428 // that case by just emitting "null" as the aliasee.
3429 if (AS->hasAliasee())
3430 Out << "^" << Machine.getGUIDSlot(GUID: SummaryToGUIDMap[&AS->getAliasee()]);
3431 else
3432 Out << "null";
3433}
3434
3435void AssemblyWriter::printGlobalVarSummary(const GlobalVarSummary *GS) {
3436 auto VTableFuncs = GS->vTableFuncs();
3437 Out << ", varFlags: (readonly: " << GS->VarFlags.MaybeReadOnly << ", "
3438 << "writeonly: " << GS->VarFlags.MaybeWriteOnly << ", "
3439 << "constant: " << GS->VarFlags.Constant;
3440 if (!VTableFuncs.empty())
3441 Out << ", "
3442 << "vcall_visibility: " << GS->VarFlags.VCallVisibility;
3443 Out << ")";
3444
3445 if (!VTableFuncs.empty()) {
3446 Out << ", vTableFuncs: (";
3447 ListSeparator FS;
3448 for (auto &P : VTableFuncs) {
3449 Out << FS;
3450 Out << "(virtFunc: ^" << Machine.getGUIDSlot(GUID: P.FuncVI.getGUID())
3451 << ", offset: " << P.VTableOffset;
3452 Out << ")";
3453 }
3454 Out << ")";
3455 }
3456}
3457
3458static std::string getLinkageName(GlobalValue::LinkageTypes LT) {
3459 switch (LT) {
3460 case GlobalValue::ExternalLinkage:
3461 return "external";
3462 case GlobalValue::PrivateLinkage:
3463 return "private";
3464 case GlobalValue::InternalLinkage:
3465 return "internal";
3466 case GlobalValue::LinkOnceAnyLinkage:
3467 return "linkonce";
3468 case GlobalValue::LinkOnceODRLinkage:
3469 return "linkonce_odr";
3470 case GlobalValue::WeakAnyLinkage:
3471 return "weak";
3472 case GlobalValue::WeakODRLinkage:
3473 return "weak_odr";
3474 case GlobalValue::CommonLinkage:
3475 return "common";
3476 case GlobalValue::AppendingLinkage:
3477 return "appending";
3478 case GlobalValue::ExternalWeakLinkage:
3479 return "extern_weak";
3480 case GlobalValue::AvailableExternallyLinkage:
3481 return "available_externally";
3482 }
3483 llvm_unreachable("invalid linkage");
3484}
3485
3486// When printing the linkage types in IR where the ExternalLinkage is
3487// not printed, and other linkage types are expected to be printed with
3488// a space after the name.
3489static std::string getLinkageNameWithSpace(GlobalValue::LinkageTypes LT) {
3490 if (LT == GlobalValue::ExternalLinkage)
3491 return "";
3492 return getLinkageName(LT) + " ";
3493}
3494
3495static const char *getVisibilityName(GlobalValue::VisibilityTypes Vis) {
3496 switch (Vis) {
3497 case GlobalValue::DefaultVisibility:
3498 return "default";
3499 case GlobalValue::HiddenVisibility:
3500 return "hidden";
3501 case GlobalValue::ProtectedVisibility:
3502 return "protected";
3503 }
3504 llvm_unreachable("invalid visibility");
3505}
3506
3507static const char *getImportTypeName(GlobalValueSummary::ImportKind IK) {
3508 switch (IK) {
3509 case GlobalValueSummary::Definition:
3510 return "definition";
3511 case GlobalValueSummary::Declaration:
3512 return "declaration";
3513 }
3514 llvm_unreachable("invalid import kind");
3515}
3516
3517void AssemblyWriter::printFunctionSummary(const FunctionSummary *FS) {
3518 Out << ", insts: " << FS->instCount();
3519 if (FS->fflags().anyFlagSet())
3520 Out << ", " << FS->fflags();
3521
3522 if (!FS->calls().empty()) {
3523 Out << ", calls: (";
3524 ListSeparator IFS;
3525 for (auto &Call : FS->calls()) {
3526 Out << IFS;
3527 Out << "(callee: ^" << Machine.getGUIDSlot(GUID: Call.first.getGUID());
3528 if (Call.second.getHotness() != CalleeInfo::HotnessType::Unknown)
3529 Out << ", hotness: " << getHotnessName(HT: Call.second.getHotness());
3530 // Follow the convention of emitting flags as a boolean value, but only
3531 // emit if true to avoid unnecessary verbosity and test churn.
3532 if (Call.second.HasTailCall)
3533 Out << ", tail: 1";
3534 Out << ")";
3535 }
3536 Out << ")";
3537 }
3538
3539 if (const auto *TIdInfo = FS->getTypeIdInfo())
3540 printTypeIdInfo(TIDInfo: *TIdInfo);
3541
3542 // The AllocationType identifiers capture the profiled context behavior
3543 // reaching a specific static allocation site (possibly cloned).
3544 auto AllocTypeName = [](uint8_t Type) -> const char * {
3545 switch (Type) {
3546 case (uint8_t)AllocationType::None:
3547 return "none";
3548 case (uint8_t)AllocationType::NotCold:
3549 return "notcold";
3550 case (uint8_t)AllocationType::Cold:
3551 return "cold";
3552 case (uint8_t)AllocationType::Hot:
3553 return "hot";
3554 }
3555 llvm_unreachable("Unexpected alloc type");
3556 };
3557
3558 if (!FS->allocs().empty()) {
3559 Out << ", allocs: (";
3560 ListSeparator AFS;
3561 for (auto &AI : FS->allocs()) {
3562 Out << AFS;
3563 Out << "(versions: (";
3564 ListSeparator VFS;
3565 for (auto V : AI.Versions) {
3566 Out << VFS;
3567 Out << AllocTypeName(V);
3568 }
3569 Out << "), memProf: (";
3570 ListSeparator MIBFS;
3571 for (auto &MIB : AI.MIBs) {
3572 Out << MIBFS;
3573 Out << "(type: " << AllocTypeName((uint8_t)MIB.AllocType);
3574 Out << ", stackIds: (";
3575 ListSeparator SIDFS;
3576 for (auto Id : MIB.StackIdIndices) {
3577 Out << SIDFS;
3578 Out << TheIndex->getStackIdAtIndex(Index: Id);
3579 }
3580 Out << "))";
3581 }
3582 Out << "))";
3583 }
3584 Out << ")";
3585 }
3586
3587 if (!FS->callsites().empty()) {
3588 Out << ", callsites: (";
3589 ListSeparator SNFS;
3590 for (auto &CI : FS->callsites()) {
3591 Out << SNFS;
3592 if (CI.Callee)
3593 Out << "(callee: ^" << Machine.getGUIDSlot(GUID: CI.Callee.getGUID());
3594 else
3595 Out << "(callee: null";
3596 Out << ", clones: (";
3597 ListSeparator VFS;
3598 for (auto V : CI.Clones) {
3599 Out << VFS;
3600 Out << V;
3601 }
3602 Out << "), stackIds: (";
3603 ListSeparator SIDFS;
3604 for (auto Id : CI.StackIdIndices) {
3605 Out << SIDFS;
3606 Out << TheIndex->getStackIdAtIndex(Index: Id);
3607 }
3608 Out << "))";
3609 }
3610 Out << ")";
3611 }
3612
3613 auto PrintRange = [&](const ConstantRange &Range) {
3614 Out << "[" << Range.getSignedMin() << ", " << Range.getSignedMax() << "]";
3615 };
3616
3617 if (!FS->paramAccesses().empty()) {
3618 Out << ", params: (";
3619 ListSeparator IFS;
3620 for (auto &PS : FS->paramAccesses()) {
3621 Out << IFS;
3622 Out << "(param: " << PS.ParamNo;
3623 Out << ", offset: ";
3624 PrintRange(PS.Use);
3625 if (!PS.Calls.empty()) {
3626 Out << ", calls: (";
3627 ListSeparator IFS;
3628 for (auto &Call : PS.Calls) {
3629 Out << IFS;
3630 Out << "(callee: ^" << Machine.getGUIDSlot(GUID: Call.Callee.getGUID());
3631 Out << ", param: " << Call.ParamNo;
3632 Out << ", offset: ";
3633 PrintRange(Call.Offsets);
3634 Out << ")";
3635 }
3636 Out << ")";
3637 }
3638 Out << ")";
3639 }
3640 Out << ")";
3641 }
3642}
3643
3644void AssemblyWriter::printTypeIdInfo(
3645 const FunctionSummary::TypeIdInfo &TIDInfo) {
3646 Out << ", typeIdInfo: (";
3647 ListSeparator TIDFS;
3648 if (!TIDInfo.TypeTests.empty()) {
3649 Out << TIDFS;
3650 Out << "typeTests: (";
3651 ListSeparator FS;
3652 for (auto &GUID : TIDInfo.TypeTests) {
3653 auto TidIter = TheIndex->typeIds().equal_range(x: GUID);
3654 if (TidIter.first == TidIter.second) {
3655 Out << FS;
3656 Out << GUID;
3657 continue;
3658 }
3659 // Print all type id that correspond to this GUID.
3660 for (const auto &[GUID, TypeIdPair] : make_range(p: TidIter)) {
3661 Out << FS;
3662 auto Slot = Machine.getTypeIdSlot(Id: TypeIdPair.first);
3663 assert(Slot != -1);
3664 Out << "^" << Slot;
3665 }
3666 }
3667 Out << ")";
3668 }
3669 if (!TIDInfo.TypeTestAssumeVCalls.empty()) {
3670 Out << TIDFS;
3671 printNonConstVCalls(VCallList: TIDInfo.TypeTestAssumeVCalls, Tag: "typeTestAssumeVCalls");
3672 }
3673 if (!TIDInfo.TypeCheckedLoadVCalls.empty()) {
3674 Out << TIDFS;
3675 printNonConstVCalls(VCallList: TIDInfo.TypeCheckedLoadVCalls, Tag: "typeCheckedLoadVCalls");
3676 }
3677 if (!TIDInfo.TypeTestAssumeConstVCalls.empty()) {
3678 Out << TIDFS;
3679 printConstVCalls(VCallList: TIDInfo.TypeTestAssumeConstVCalls,
3680 Tag: "typeTestAssumeConstVCalls");
3681 }
3682 if (!TIDInfo.TypeCheckedLoadConstVCalls.empty()) {
3683 Out << TIDFS;
3684 printConstVCalls(VCallList: TIDInfo.TypeCheckedLoadConstVCalls,
3685 Tag: "typeCheckedLoadConstVCalls");
3686 }
3687 Out << ")";
3688}
3689
3690void AssemblyWriter::printVFuncId(const FunctionSummary::VFuncId VFId) {
3691 auto TidIter = TheIndex->typeIds().equal_range(x: VFId.GUID);
3692 if (TidIter.first == TidIter.second) {
3693 Out << "vFuncId: (";
3694 Out << "guid: " << VFId.GUID;
3695 Out << ", offset: " << VFId.Offset;
3696 Out << ")";
3697 return;
3698 }
3699 // Print all type id that correspond to this GUID.
3700 ListSeparator FS;
3701 for (const auto &[GUID, TypeIdPair] : make_range(p: TidIter)) {
3702 Out << FS;
3703 Out << "vFuncId: (";
3704 auto Slot = Machine.getTypeIdSlot(Id: TypeIdPair.first);
3705 assert(Slot != -1);
3706 Out << "^" << Slot;
3707 Out << ", offset: " << VFId.Offset;
3708 Out << ")";
3709 }
3710}
3711
3712void AssemblyWriter::printNonConstVCalls(
3713 ArrayRef<FunctionSummary::VFuncId> VCallList, const char *Tag) {
3714 Out << Tag << ": (";
3715 ListSeparator FS;
3716 for (auto &VFuncId : VCallList) {
3717 Out << FS;
3718 printVFuncId(VFId: VFuncId);
3719 }
3720 Out << ")";
3721}
3722
3723void AssemblyWriter::printConstVCalls(
3724 ArrayRef<FunctionSummary::ConstVCall> VCallList, const char *Tag) {
3725 Out << Tag << ": (";
3726 ListSeparator FS;
3727 for (auto &ConstVCall : VCallList) {
3728 Out << FS;
3729 Out << "(";
3730 printVFuncId(VFId: ConstVCall.VFunc);
3731 if (!ConstVCall.Args.empty()) {
3732 Out << ", ";
3733 printArgs(Args: ConstVCall.Args);
3734 }
3735 Out << ")";
3736 }
3737 Out << ")";
3738}
3739
3740void AssemblyWriter::printSummary(const GlobalValueSummary &Summary) {
3741 GlobalValueSummary::GVFlags GVFlags = Summary.flags();
3742 GlobalValue::LinkageTypes LT = (GlobalValue::LinkageTypes)GVFlags.Linkage;
3743 Out << getSummaryKindName(SK: Summary.getSummaryKind()) << ": ";
3744 Out << "(module: ^" << Machine.getModulePathSlot(Path: Summary.modulePath())
3745 << ", flags: (";
3746 Out << "linkage: " << getLinkageName(LT);
3747 Out << ", visibility: "
3748 << getVisibilityName(Vis: (GlobalValue::VisibilityTypes)GVFlags.Visibility);
3749 Out << ", notEligibleToImport: " << GVFlags.NotEligibleToImport;
3750 Out << ", live: " << GVFlags.Live;
3751 Out << ", dsoLocal: " << GVFlags.DSOLocal;
3752 Out << ", canAutoHide: " << GVFlags.CanAutoHide;
3753 Out << ", importType: "
3754 << getImportTypeName(IK: GlobalValueSummary::ImportKind(GVFlags.ImportType));
3755 Out << ", noRenameOnPromotion: " << GVFlags.NoRenameOnPromotion;
3756 Out << ")";
3757
3758 if (Summary.getSummaryKind() == GlobalValueSummary::AliasKind)
3759 printAliasSummary(AS: cast<AliasSummary>(Val: &Summary));
3760 else if (Summary.getSummaryKind() == GlobalValueSummary::FunctionKind)
3761 printFunctionSummary(FS: cast<FunctionSummary>(Val: &Summary));
3762 else
3763 printGlobalVarSummary(GS: cast<GlobalVarSummary>(Val: &Summary));
3764
3765 auto RefList = Summary.refs();
3766 if (!RefList.empty()) {
3767 Out << ", refs: (";
3768 ListSeparator FS;
3769 for (auto &Ref : RefList) {
3770 Out << FS;
3771 if (Ref.isReadOnly())
3772 Out << "readonly ";
3773 else if (Ref.isWriteOnly())
3774 Out << "writeonly ";
3775 Out << "^" << Machine.getGUIDSlot(GUID: Ref.getGUID());
3776 }
3777 Out << ")";
3778 }
3779
3780 Out << ")";
3781}
3782
3783void AssemblyWriter::printSummaryInfo(unsigned Slot, const ValueInfo &VI) {
3784 Out << "^" << Slot << " = gv: (";
3785 if (VI.hasName() && !VI.name().empty())
3786 Out << "name: \"" << VI.name() << "\"";
3787 else
3788 Out << "guid: " << VI.getGUID();
3789 if (!VI.getSummaryList().empty()) {
3790 Out << ", summaries: (";
3791 ListSeparator FS;
3792 for (auto &Summary : VI.getSummaryList()) {
3793 Out << FS;
3794 printSummary(Summary: *Summary);
3795 }
3796 Out << ")";
3797 }
3798 Out << ")";
3799 if (VI.hasName() && !VI.name().empty())
3800 Out << " ; guid = " << VI.getGUID();
3801 Out << "\n";
3802}
3803
3804static void printMetadataIdentifier(StringRef Name,
3805 formatted_raw_ostream &Out) {
3806 if (Name.empty()) {
3807 Out << "<empty name> ";
3808 } else {
3809 unsigned char FirstC = static_cast<unsigned char>(Name[0]);
3810 if (isalpha(FirstC) || FirstC == '-' || FirstC == '$' || FirstC == '.' ||
3811 FirstC == '_')
3812 Out << FirstC;
3813 else
3814 Out << '\\' << hexdigit(X: FirstC >> 4) << hexdigit(X: FirstC & 0x0F);
3815 for (unsigned i = 1, e = Name.size(); i != e; ++i) {
3816 unsigned char C = Name[i];
3817 if (isalnum(C) || C == '-' || C == '$' || C == '.' || C == '_')
3818 Out << C;
3819 else
3820 Out << '\\' << hexdigit(X: C >> 4) << hexdigit(X: C & 0x0F);
3821 }
3822 }
3823}
3824
3825void AssemblyWriter::printNamedMDNode(const NamedMDNode *NMD) {
3826 Out << '!';
3827 printMetadataIdentifier(Name: NMD->getName(), Out);
3828 Out << " = !{";
3829 ListSeparator LS;
3830 for (const MDNode *Op : NMD->operands()) {
3831 Out << LS;
3832 // Write DIExpressions inline.
3833 // FIXME: Ban DIExpressions in NamedMDNodes, they will serve no purpose.
3834 if (auto *Expr = dyn_cast<DIExpression>(Val: Op)) {
3835 writeDIExpression(Out, N: Expr, WriterCtx&: AsmWriterContext::getEmpty());
3836 continue;
3837 }
3838
3839 int Slot = Machine.getMetadataSlot(N: Op);
3840 if (Slot == -1)
3841 Out << "<badref>";
3842 else
3843 Out << '!' << Slot;
3844 }
3845 Out << "}\n";
3846}
3847
3848static void printVisibility(GlobalValue::VisibilityTypes Vis,
3849 formatted_raw_ostream &Out) {
3850 switch (Vis) {
3851 case GlobalValue::DefaultVisibility: break;
3852 case GlobalValue::HiddenVisibility: Out << "hidden "; break;
3853 case GlobalValue::ProtectedVisibility: Out << "protected "; break;
3854 }
3855}
3856
3857static void printDSOLocation(const GlobalValue &GV,
3858 formatted_raw_ostream &Out) {
3859 if (GV.isDSOLocal() && !GV.isImplicitDSOLocal())
3860 Out << "dso_local ";
3861}
3862
3863static void printDLLStorageClass(GlobalValue::DLLStorageClassTypes SCT,
3864 formatted_raw_ostream &Out) {
3865 switch (SCT) {
3866 case GlobalValue::DefaultStorageClass: break;
3867 case GlobalValue::DLLImportStorageClass: Out << "dllimport "; break;
3868 case GlobalValue::DLLExportStorageClass: Out << "dllexport "; break;
3869 }
3870}
3871
3872static void printThreadLocalModel(GlobalVariable::ThreadLocalMode TLM,
3873 formatted_raw_ostream &Out) {
3874 switch (TLM) {
3875 case GlobalVariable::NotThreadLocal:
3876 break;
3877 case GlobalVariable::GeneralDynamicTLSModel:
3878 Out << "thread_local ";
3879 break;
3880 case GlobalVariable::LocalDynamicTLSModel:
3881 Out << "thread_local(localdynamic) ";
3882 break;
3883 case GlobalVariable::InitialExecTLSModel:
3884 Out << "thread_local(initialexec) ";
3885 break;
3886 case GlobalVariable::LocalExecTLSModel:
3887 Out << "thread_local(localexec) ";
3888 break;
3889 }
3890}
3891
3892static StringRef getUnnamedAddrEncoding(GlobalVariable::UnnamedAddr UA) {
3893 switch (UA) {
3894 case GlobalVariable::UnnamedAddr::None:
3895 return "";
3896 case GlobalVariable::UnnamedAddr::Local:
3897 return "local_unnamed_addr";
3898 case GlobalVariable::UnnamedAddr::Global:
3899 return "unnamed_addr";
3900 }
3901 llvm_unreachable("Unknown UnnamedAddr");
3902}
3903
3904static void maybePrintComdat(formatted_raw_ostream &Out,
3905 const GlobalObject &GO) {
3906 const Comdat *C = GO.getComdat();
3907 if (!C)
3908 return;
3909
3910 if (isa<GlobalVariable>(Val: GO))
3911 Out << ',';
3912 Out << " comdat";
3913
3914 if (GO.getName() == C->getName())
3915 return;
3916
3917 Out << '(';
3918 printLLVMName(OS&: Out, Name: C->getName(), Prefix: ComdatPrefix);
3919 Out << ')';
3920}
3921
3922void AssemblyWriter::printGlobal(const GlobalVariable *GV) {
3923 if (GV->isMaterializable())
3924 Out << "; Materializable\n";
3925
3926 AsmWriterContext WriterCtx(&TypePrinter, &Machine, GV->getParent());
3927 writeAsOperandInternal(Out, V: GV, WriterCtx);
3928 Out << " = ";
3929
3930 if (!GV->hasInitializer() && GV->hasExternalLinkage())
3931 Out << "external ";
3932
3933 Out << getLinkageNameWithSpace(LT: GV->getLinkage());
3934 printDSOLocation(GV: *GV, Out);
3935 printVisibility(Vis: GV->getVisibility(), Out);
3936 printDLLStorageClass(SCT: GV->getDLLStorageClass(), Out);
3937 printThreadLocalModel(TLM: GV->getThreadLocalMode(), Out);
3938 StringRef UA = getUnnamedAddrEncoding(UA: GV->getUnnamedAddr());
3939 if (!UA.empty())
3940 Out << UA << ' ';
3941
3942 printAddressSpace(M: GV->getParent(), AS: GV->getType()->getAddressSpace(), OS&: Out,
3943 /*Prefix=*/"", /*Suffix=*/" ");
3944 if (GV->isExternallyInitialized()) Out << "externally_initialized ";
3945 Out << (GV->isConstant() ? "constant " : "global ");
3946 TypePrinter.print(Ty: GV->getValueType(), OS&: Out);
3947
3948 if (GV->hasInitializer()) {
3949 Out << ' ';
3950 writeOperand(Operand: GV->getInitializer(), PrintType: false);
3951 }
3952
3953 if (GV->hasSection()) {
3954 Out << ", section \"";
3955 printEscapedString(Name: GV->getSection(), Out);
3956 Out << '"';
3957 }
3958 if (GV->hasPartition()) {
3959 Out << ", partition \"";
3960 printEscapedString(Name: GV->getPartition(), Out);
3961 Out << '"';
3962 }
3963 if (auto CM = GV->getCodeModel()) {
3964 Out << ", code_model \"";
3965 switch (*CM) {
3966 case CodeModel::Tiny:
3967 Out << "tiny";
3968 break;
3969 case CodeModel::Small:
3970 Out << "small";
3971 break;
3972 case CodeModel::Kernel:
3973 Out << "kernel";
3974 break;
3975 case CodeModel::Medium:
3976 Out << "medium";
3977 break;
3978 case CodeModel::Large:
3979 Out << "large";
3980 break;
3981 }
3982 Out << '"';
3983 }
3984
3985 using SanitizerMetadata = llvm::GlobalValue::SanitizerMetadata;
3986 if (GV->hasSanitizerMetadata()) {
3987 SanitizerMetadata MD = GV->getSanitizerMetadata();
3988 if (MD.NoAddress)
3989 Out << ", no_sanitize_address";
3990 if (MD.NoHWAddress)
3991 Out << ", no_sanitize_hwaddress";
3992 if (MD.Memtag)
3993 Out << ", sanitize_memtag";
3994 if (MD.IsDynInit)
3995 Out << ", sanitize_address_dyninit";
3996 }
3997
3998 maybePrintComdat(Out, GO: *GV);
3999 if (MaybeAlign A = GV->getAlign())
4000 Out << ", align " << A->value();
4001
4002 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
4003 GV->getAllMetadata(MDs);
4004 printMetadataAttachments(MDs, Separator: ", ");
4005
4006 auto Attrs = GV->getAttributes();
4007 if (Attrs.hasAttributes())
4008 Out << " #" << Machine.getAttributeGroupSlot(AS: Attrs);
4009
4010 printInfoComment(V: *GV, isMaterializable: GV->isMaterializable());
4011}
4012
4013void AssemblyWriter::printAlias(const GlobalAlias *GA) {
4014 if (GA->isMaterializable())
4015 Out << "; Materializable\n";
4016
4017 AsmWriterContext WriterCtx(&TypePrinter, &Machine, GA->getParent());
4018 writeAsOperandInternal(Out, V: GA, WriterCtx);
4019 Out << " = ";
4020
4021 Out << getLinkageNameWithSpace(LT: GA->getLinkage());
4022 printDSOLocation(GV: *GA, Out);
4023 printVisibility(Vis: GA->getVisibility(), Out);
4024 printDLLStorageClass(SCT: GA->getDLLStorageClass(), Out);
4025 printThreadLocalModel(TLM: GA->getThreadLocalMode(), Out);
4026 StringRef UA = getUnnamedAddrEncoding(UA: GA->getUnnamedAddr());
4027 if (!UA.empty())
4028 Out << UA << ' ';
4029
4030 Out << "alias ";
4031
4032 TypePrinter.print(Ty: GA->getValueType(), OS&: Out);
4033 Out << ", ";
4034
4035 if (const Constant *Aliasee = GA->getAliasee()) {
4036 writeOperand(Operand: Aliasee, PrintType: !isa<ConstantExpr>(Val: Aliasee));
4037 } else {
4038 TypePrinter.print(Ty: GA->getType(), OS&: Out);
4039 Out << " <<NULL ALIASEE>>";
4040 }
4041
4042 if (GA->hasPartition()) {
4043 Out << ", partition \"";
4044 printEscapedString(Name: GA->getPartition(), Out);
4045 Out << '"';
4046 }
4047
4048 printInfoComment(V: *GA, isMaterializable: GA->isMaterializable());
4049 Out << '\n';
4050}
4051
4052void AssemblyWriter::printIFunc(const GlobalIFunc *GI) {
4053 if (GI->isMaterializable())
4054 Out << "; Materializable\n";
4055
4056 AsmWriterContext WriterCtx(&TypePrinter, &Machine, GI->getParent());
4057 writeAsOperandInternal(Out, V: GI, WriterCtx);
4058 Out << " = ";
4059
4060 Out << getLinkageNameWithSpace(LT: GI->getLinkage());
4061 printDSOLocation(GV: *GI, Out);
4062 printVisibility(Vis: GI->getVisibility(), Out);
4063
4064 Out << "ifunc ";
4065
4066 TypePrinter.print(Ty: GI->getValueType(), OS&: Out);
4067 Out << ", ";
4068
4069 if (const Constant *Resolver = GI->getResolver()) {
4070 writeOperand(Operand: Resolver, PrintType: !isa<ConstantExpr>(Val: Resolver));
4071 } else {
4072 TypePrinter.print(Ty: GI->getType(), OS&: Out);
4073 Out << " <<NULL RESOLVER>>";
4074 }
4075
4076 if (GI->hasPartition()) {
4077 Out << ", partition \"";
4078 printEscapedString(Name: GI->getPartition(), Out);
4079 Out << '"';
4080 }
4081 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
4082 GI->getAllMetadata(MDs);
4083 if (!MDs.empty()) {
4084 printMetadataAttachments(MDs, Separator: ", ");
4085 }
4086
4087 printInfoComment(V: *GI, isMaterializable: GI->isMaterializable());
4088 Out << '\n';
4089}
4090
4091void AssemblyWriter::printComdat(const Comdat *C) {
4092 C->print(OS&: Out);
4093}
4094
4095void AssemblyWriter::printTypeIdentities() {
4096 if (TypePrinter.empty())
4097 return;
4098
4099 Out << '\n';
4100
4101 // Emit all numbered types.
4102 auto &NumberedTypes = TypePrinter.getNumberedTypes();
4103 for (unsigned I = 0, E = NumberedTypes.size(); I != E; ++I) {
4104 Out << '%' << I << " = type ";
4105
4106 // Make sure we print out at least one level of the type structure, so
4107 // that we do not get %2 = type %2
4108 TypePrinter.printStructBody(STy: NumberedTypes[I], OS&: Out);
4109 Out << '\n';
4110 }
4111
4112 auto &NamedTypes = TypePrinter.getNamedTypes();
4113 for (StructType *NamedType : NamedTypes) {
4114 printLLVMName(OS&: Out, Name: NamedType->getName(), Prefix: LocalPrefix);
4115 Out << " = type ";
4116
4117 // Make sure we print out at least one level of the type structure, so
4118 // that we do not get %FILE = type %FILE
4119 TypePrinter.printStructBody(STy: NamedType, OS&: Out);
4120 Out << '\n';
4121 }
4122}
4123
4124/// printFunction - Print all aspects of a function.
4125void AssemblyWriter::printFunction(const Function *F) {
4126 if (F->isMaterializable())
4127 Out << "; Materializable\n";
4128 else if (AnnotationWriter)
4129 AnnotationWriter->emitFunctionAnnot(F, Out);
4130
4131 const AttributeList &Attrs = F->getAttributes();
4132 if (Attrs.hasFnAttrs()) {
4133 AttributeSet AS = Attrs.getFnAttrs();
4134 std::string AttrStr;
4135
4136 for (const Attribute &Attr : AS) {
4137 if (!Attr.isStringAttribute()) {
4138 if (!AttrStr.empty()) AttrStr += ' ';
4139 AttrStr += Attr.getAsString();
4140 }
4141 }
4142
4143 if (!AttrStr.empty())
4144 Out << "; Function Attrs: " << AttrStr << '\n';
4145 }
4146
4147 if (F->isIntrinsic() && F->getIntrinsicID() == Intrinsic::not_intrinsic)
4148 Out << "; Unknown intrinsic\n";
4149
4150 Machine.incorporateFunction(F);
4151
4152 if (F->isDeclaration()) {
4153 Out << "declare";
4154 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
4155 F->getAllMetadata(MDs);
4156 printMetadataAttachments(MDs, Separator: " ");
4157 Out << ' ';
4158 } else
4159 Out << "define ";
4160
4161 Out << getLinkageNameWithSpace(LT: F->getLinkage());
4162 printDSOLocation(GV: *F, Out);
4163 printVisibility(Vis: F->getVisibility(), Out);
4164 printDLLStorageClass(SCT: F->getDLLStorageClass(), Out);
4165
4166 // Print the calling convention.
4167 if (F->getCallingConv() != CallingConv::C) {
4168 printCallingConv(cc: F->getCallingConv(), Out);
4169 Out << " ";
4170 }
4171
4172 FunctionType *FT = F->getFunctionType();
4173 if (Attrs.hasRetAttrs())
4174 Out << Attrs.getAsString(Index: AttributeList::ReturnIndex) << ' ';
4175 TypePrinter.print(Ty: F->getReturnType(), OS&: Out);
4176 AsmWriterContext WriterCtx(&TypePrinter, &Machine, F->getParent());
4177 Out << ' ';
4178 writeAsOperandInternal(Out, V: F, WriterCtx);
4179 Out << '(';
4180
4181 // Loop over the arguments, printing them...
4182 if (F->isDeclaration() && !IsForDebug) {
4183 // We're only interested in the type here - don't print argument names.
4184 ListSeparator LS;
4185 for (unsigned I = 0, E = FT->getNumParams(); I != E; ++I) {
4186 Out << LS;
4187 // Output type.
4188 TypePrinter.print(Ty: FT->getParamType(i: I), OS&: Out);
4189
4190 AttributeSet ArgAttrs = Attrs.getParamAttrs(ArgNo: I);
4191 if (ArgAttrs.hasAttributes()) {
4192 Out << ' ';
4193 writeAttributeSet(AttrSet: ArgAttrs);
4194 }
4195 }
4196 } else {
4197 // The arguments are meaningful here, print them in detail.
4198 ListSeparator LS;
4199 for (const Argument &Arg : F->args()) {
4200 Out << LS;
4201 printArgument(FA: &Arg, Attrs: Attrs.getParamAttrs(ArgNo: Arg.getArgNo()));
4202 }
4203 }
4204
4205 // Finish printing arguments...
4206 if (FT->isVarArg()) {
4207 if (FT->getNumParams()) Out << ", ";
4208 Out << "..."; // Output varargs portion of signature!
4209 }
4210 Out << ')';
4211 StringRef UA = getUnnamedAddrEncoding(UA: F->getUnnamedAddr());
4212 if (!UA.empty())
4213 Out << ' ' << UA;
4214 // We print the function address space if it is non-zero or if we are writing
4215 // a module with a non-zero program address space or if there is no valid
4216 // Module* so that the file can be parsed without the datalayout string.
4217 const Module *Mod = F->getParent();
4218 bool ForcePrintAddressSpace =
4219 !Mod || Mod->getDataLayout().getProgramAddressSpace() != 0;
4220 printAddressSpace(M: Mod, AS: F->getAddressSpace(), OS&: Out, /*Prefix=*/" ",
4221 /*Suffix=*/"", ForcePrint: ForcePrintAddressSpace);
4222 if (Attrs.hasFnAttrs())
4223 Out << " #" << Machine.getAttributeGroupSlot(AS: Attrs.getFnAttrs());
4224 if (F->hasSection()) {
4225 Out << " section \"";
4226 printEscapedString(Name: F->getSection(), Out);
4227 Out << '"';
4228 }
4229 if (F->hasPartition()) {
4230 Out << " partition \"";
4231 printEscapedString(Name: F->getPartition(), Out);
4232 Out << '"';
4233 }
4234 maybePrintComdat(Out, GO: *F);
4235 if (MaybeAlign A = F->getAlign())
4236 Out << " align " << A->value();
4237 if (MaybeAlign A = F->getPreferredAlignment())
4238 Out << " prefalign(" << A->value() << ')';
4239 if (F->hasGC())
4240 Out << " gc \"" << F->getGC() << '"';
4241 if (F->hasPrefixData()) {
4242 Out << " prefix ";
4243 writeOperand(Operand: F->getPrefixData(), PrintType: true);
4244 }
4245 if (F->hasPrologueData()) {
4246 Out << " prologue ";
4247 writeOperand(Operand: F->getPrologueData(), PrintType: true);
4248 }
4249 if (F->hasPersonalityFn()) {
4250 Out << " personality ";
4251 writeOperand(Operand: F->getPersonalityFn(), /*PrintType=*/true);
4252 }
4253
4254 if (PrintProfData) {
4255 if (auto *MDProf = F->getMetadata(KindID: LLVMContext::MD_prof)) {
4256 Out << " ";
4257 MDProf->print(OS&: Out, M: TheModule, /*IsForDebug=*/true);
4258 }
4259 }
4260
4261 if (F->isDeclaration()) {
4262 Out << '\n';
4263 } else {
4264 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
4265 F->getAllMetadata(MDs);
4266 printMetadataAttachments(MDs, Separator: " ");
4267
4268 Out << " {";
4269 // Output all of the function's basic blocks.
4270 for (const BasicBlock &BB : *F)
4271 printBasicBlock(BB: &BB);
4272
4273 // Output the function's use-lists.
4274 printUseLists(F);
4275
4276 Out << "}\n";
4277 }
4278
4279 Machine.purgeFunction();
4280}
4281
4282/// printArgument - This member is called for every argument that is passed into
4283/// the function. Simply print it out
4284void AssemblyWriter::printArgument(const Argument *Arg, AttributeSet Attrs) {
4285 // Output type...
4286 TypePrinter.print(Ty: Arg->getType(), OS&: Out);
4287
4288 // Output parameter attributes list
4289 if (Attrs.hasAttributes()) {
4290 Out << ' ';
4291 writeAttributeSet(AttrSet: Attrs);
4292 }
4293
4294 // Output name, if available...
4295 if (Arg->hasName()) {
4296 Out << ' ';
4297 printLLVMName(OS&: Out, V: Arg);
4298 } else {
4299 int Slot = Machine.getLocalSlot(V: Arg);
4300 assert(Slot != -1 && "expect argument in function here");
4301 Out << " %" << Slot;
4302 }
4303}
4304
4305/// printBasicBlock - This member is called for each basic block in a method.
4306void AssemblyWriter::printBasicBlock(const BasicBlock *BB) {
4307 bool IsEntryBlock = BB->getParent() && BB->isEntryBlock();
4308 if (BB->hasName()) { // Print out the label if it exists...
4309 Out << "\n";
4310 printLLVMName(OS&: Out, Name: BB->getName(), Prefix: LabelPrefix);
4311 Out << ':';
4312 } else if (!IsEntryBlock) {
4313 Out << "\n";
4314 int Slot = Machine.getLocalSlot(V: BB);
4315 if (Slot != -1)
4316 Out << Slot << ":";
4317 else
4318 Out << "<badref>:";
4319 }
4320
4321 if (!IsEntryBlock) {
4322 // Output predecessors for the block.
4323 Out.PadToColumn(NewCol: 50);
4324 Out << ";";
4325 if (pred_empty(BB)) {
4326 Out << " No predecessors!";
4327 } else {
4328 Out << " preds = ";
4329 ListSeparator LS;
4330 for (const BasicBlock *Pred : predecessors(BB)) {
4331 Out << LS;
4332 writeOperand(Operand: Pred, PrintType: false);
4333 }
4334 }
4335 }
4336
4337 Out << "\n";
4338
4339 if (AnnotationWriter) AnnotationWriter->emitBasicBlockStartAnnot(BB, Out);
4340
4341 // Output all of the instructions in the basic block...
4342 for (const Instruction &I : *BB) {
4343 for (const DbgRecord &DR : I.getDbgRecordRange())
4344 printDbgRecordLine(DR);
4345 printInstructionLine(I);
4346 }
4347
4348 if (AnnotationWriter) AnnotationWriter->emitBasicBlockEndAnnot(BB, Out);
4349}
4350
4351/// printInstructionLine - Print an instruction and a newline character.
4352void AssemblyWriter::printInstructionLine(const Instruction &I) {
4353 printInstruction(I);
4354 Out << '\n';
4355}
4356
4357/// printGCRelocateComment - print comment after call to the gc.relocate
4358/// intrinsic indicating base and derived pointer names.
4359void AssemblyWriter::printGCRelocateComment(const GCRelocateInst &Relocate) {
4360 Out << " ; (";
4361 writeOperand(Operand: Relocate.getBasePtr(), PrintType: false);
4362 Out << ", ";
4363 writeOperand(Operand: Relocate.getDerivedPtr(), PrintType: false);
4364 Out << ")";
4365}
4366
4367/// printInfoComment - Print a little comment after the instruction indicating
4368/// which slot it occupies.
4369void AssemblyWriter::printInfoComment(const Value &V, bool isMaterializable) {
4370 if (const auto *Relocate = dyn_cast<GCRelocateInst>(Val: &V))
4371 printGCRelocateComment(Relocate: *Relocate);
4372
4373 if (AnnotationWriter && !isMaterializable)
4374 AnnotationWriter->printInfoComment(V, Out);
4375
4376 if (PrintInstDebugLocs) {
4377 if (auto *I = dyn_cast<Instruction>(Val: &V)) {
4378 if (I->getDebugLoc()) {
4379 Out << " ; ";
4380 I->getDebugLoc().print(OS&: Out);
4381 }
4382 }
4383 }
4384 if (PrintProfData) {
4385 if (auto *I = dyn_cast<Instruction>(Val: &V)) {
4386 if (auto *MD = I->getMetadata(KindID: LLVMContext::MD_prof)) {
4387 Out << " ; ";
4388 MD->print(OS&: Out, M: TheModule, /*IsForDebug=*/true);
4389 }
4390 }
4391 }
4392
4393 if (PrintInstAddrs)
4394 Out << " ; " << &V;
4395}
4396
4397static void maybePrintCallAddrSpace(const Value *Operand, const Instruction *I,
4398 raw_ostream &Out) {
4399 if (Operand == nullptr) {
4400 Out << " <cannot get addrspace!>";
4401 return;
4402 }
4403
4404 // We print the address space of the call if it is non-zero.
4405 // We also print it if it is zero but not equal to the program address space
4406 // or if we can't find a valid Module* to make it possible to parse
4407 // the resulting file even without a datalayout string.
4408 unsigned CallAddrSpace = Operand->getType()->getPointerAddressSpace();
4409 const Module *Mod = getModuleFromVal(V: I);
4410 bool ForcePrintAddrSpace =
4411 !Mod || Mod->getDataLayout().getProgramAddressSpace() != 0;
4412 printAddressSpace(M: Mod, AS: CallAddrSpace, OS&: Out, /*Prefix=*/" ", /*Suffix=*/"",
4413 ForcePrint: ForcePrintAddrSpace);
4414}
4415
4416// This member is called for each Instruction in a function..
4417void AssemblyWriter::printInstruction(const Instruction &I) {
4418 if (AnnotationWriter) AnnotationWriter->emitInstructionAnnot(&I, Out);
4419
4420 // Print out indentation for an instruction.
4421 Out << " ";
4422
4423 // Print out name if it exists...
4424 if (I.hasName()) {
4425 printLLVMName(OS&: Out, V: &I);
4426 Out << " = ";
4427 } else if (!I.getType()->isVoidTy()) {
4428 // Print out the def slot taken.
4429 int SlotNum = Machine.getLocalSlot(V: &I);
4430 if (SlotNum == -1)
4431 Out << "<badref> = ";
4432 else
4433 Out << '%' << SlotNum << " = ";
4434 }
4435
4436 if (const auto *CI = dyn_cast<CallInst>(Val: &I)) {
4437 if (CI->isMustTailCall())
4438 Out << "musttail ";
4439 else if (CI->isTailCall())
4440 Out << "tail ";
4441 else if (CI->isNoTailCall())
4442 Out << "notail ";
4443 }
4444
4445 // Print out the opcode...
4446 Out << I.getOpcodeName();
4447
4448 // If this is an atomic load or store, print out the atomic marker.
4449 if ((isa<LoadInst>(Val: I) && cast<LoadInst>(Val: I).isAtomic()) ||
4450 (isa<StoreInst>(Val: I) && cast<StoreInst>(Val: I).isAtomic()))
4451 Out << " atomic";
4452
4453 if (isa<AtomicCmpXchgInst>(Val: I) && cast<AtomicCmpXchgInst>(Val: I).isWeak())
4454 Out << " weak";
4455
4456 // If this is a volatile operation, print out the volatile marker.
4457 if ((isa<LoadInst>(Val: I) && cast<LoadInst>(Val: I).isVolatile()) ||
4458 (isa<StoreInst>(Val: I) && cast<StoreInst>(Val: I).isVolatile()) ||
4459 (isa<AtomicCmpXchgInst>(Val: I) && cast<AtomicCmpXchgInst>(Val: I).isVolatile()) ||
4460 (isa<AtomicRMWInst>(Val: I) && cast<AtomicRMWInst>(Val: I).isVolatile()))
4461 Out << " volatile";
4462
4463 // Print out optimization information.
4464 writeOptimizationInfo(Out, U: &I);
4465
4466 // Print out the compare instruction predicates
4467 if (const auto *CI = dyn_cast<CmpInst>(Val: &I))
4468 Out << ' ' << CI->getPredicate();
4469
4470 // Print out the atomicrmw operation
4471 if (const auto *RMWI = dyn_cast<AtomicRMWInst>(Val: &I))
4472 Out << ' ' << AtomicRMWInst::getOperationName(Op: RMWI->getOperation());
4473
4474 // Print out the type of the operands...
4475 const Value *Operand = I.getNumOperands() ? I.getOperand(i: 0) : nullptr;
4476
4477 // Special case conditional branches to swizzle the condition out to the front
4478 if (const auto *BI = dyn_cast<CondBrInst>(Val: &I)) {
4479 Out << ' ';
4480 writeOperand(Operand: BI->getCondition(), PrintType: true);
4481 Out << ", ";
4482 writeOperand(Operand: BI->getSuccessor(i: 0), PrintType: true);
4483 Out << ", ";
4484 writeOperand(Operand: BI->getSuccessor(i: 1), PrintType: true);
4485 } else if (isa<SwitchInst>(Val: I)) {
4486 const SwitchInst& SI(cast<SwitchInst>(Val: I));
4487 // Special case switch instruction to get formatting nice and correct.
4488 Out << ' ';
4489 writeOperand(Operand: SI.getCondition(), PrintType: true);
4490 Out << ", ";
4491 writeOperand(Operand: SI.getDefaultDest(), PrintType: true);
4492 Out << " [";
4493 for (auto Case : SI.cases()) {
4494 Out << "\n ";
4495 writeOperand(Operand: Case.getCaseValue(), PrintType: true);
4496 Out << ", ";
4497 writeOperand(Operand: Case.getCaseSuccessor(), PrintType: true);
4498 }
4499 Out << "\n ]";
4500 } else if (isa<IndirectBrInst>(Val: I)) {
4501 // Special case indirectbr instruction to get formatting nice and correct.
4502 Out << ' ';
4503 writeOperand(Operand, PrintType: true);
4504 Out << ", [";
4505
4506 ListSeparator LS;
4507 for (unsigned i = 1, e = I.getNumOperands(); i != e; ++i) {
4508 Out << LS;
4509 writeOperand(Operand: I.getOperand(i), PrintType: true);
4510 }
4511 Out << ']';
4512 } else if (const auto *PN = dyn_cast<PHINode>(Val: &I)) {
4513 Out << ' ';
4514 TypePrinter.print(Ty: I.getType(), OS&: Out);
4515 Out << ' ';
4516
4517 ListSeparator LS;
4518 for (const auto &[V, Block] :
4519 zip_equal(t: PN->incoming_values(), u: PN->blocks())) {
4520 Out << LS << "[ ";
4521 writeOperand(Operand: V, PrintType: false);
4522 Out << ", ";
4523 writeOperand(Operand: Block, PrintType: false);
4524 Out << " ]";
4525 }
4526 } else if (const auto *EVI = dyn_cast<ExtractValueInst>(Val: &I)) {
4527 Out << ' ';
4528 writeOperand(Operand: I.getOperand(i: 0), PrintType: true);
4529 Out << ", ";
4530 Out << llvm::interleaved(R: EVI->indices());
4531 } else if (const auto *IVI = dyn_cast<InsertValueInst>(Val: &I)) {
4532 Out << ' ';
4533 writeOperand(Operand: I.getOperand(i: 0), PrintType: true); Out << ", ";
4534 writeOperand(Operand: I.getOperand(i: 1), PrintType: true);
4535 Out << ", ";
4536 Out << llvm::interleaved(R: IVI->indices());
4537 } else if (const auto *LPI = dyn_cast<LandingPadInst>(Val: &I)) {
4538 Out << ' ';
4539 TypePrinter.print(Ty: I.getType(), OS&: Out);
4540 if (LPI->isCleanup() || LPI->getNumClauses() != 0)
4541 Out << '\n';
4542
4543 if (LPI->isCleanup())
4544 Out << " cleanup";
4545
4546 for (unsigned i = 0, e = LPI->getNumClauses(); i != e; ++i) {
4547 if (i != 0 || LPI->isCleanup()) Out << "\n";
4548 if (LPI->isCatch(Idx: i))
4549 Out << " catch ";
4550 else
4551 Out << " filter ";
4552
4553 writeOperand(Operand: LPI->getClause(Idx: i), PrintType: true);
4554 }
4555 } else if (const auto *CatchSwitch = dyn_cast<CatchSwitchInst>(Val: &I)) {
4556 Out << " within ";
4557 writeOperand(Operand: CatchSwitch->getParentPad(), /*PrintType=*/false);
4558 Out << " [";
4559 ListSeparator LS;
4560 for (const BasicBlock *PadBB : CatchSwitch->handlers()) {
4561 Out << LS;
4562 writeOperand(Operand: PadBB, /*PrintType=*/true);
4563 }
4564 Out << "] unwind ";
4565 if (const BasicBlock *UnwindDest = CatchSwitch->getUnwindDest())
4566 writeOperand(Operand: UnwindDest, /*PrintType=*/true);
4567 else
4568 Out << "to caller";
4569 } else if (const auto *FPI = dyn_cast<FuncletPadInst>(Val: &I)) {
4570 Out << " within ";
4571 writeOperand(Operand: FPI->getParentPad(), /*PrintType=*/false);
4572 Out << " [";
4573 ListSeparator LS;
4574 for (const Value *Op : FPI->arg_operands()) {
4575 Out << LS;
4576 writeOperand(Operand: Op, /*PrintType=*/true);
4577 }
4578 Out << ']';
4579 } else if (isa<ReturnInst>(Val: I) && !Operand) {
4580 Out << " void";
4581 } else if (const auto *CRI = dyn_cast<CatchReturnInst>(Val: &I)) {
4582 Out << " from ";
4583 writeOperand(Operand: CRI->getOperand(i_nocapture: 0), /*PrintType=*/false);
4584
4585 Out << " to ";
4586 writeOperand(Operand: CRI->getOperand(i_nocapture: 1), /*PrintType=*/true);
4587 } else if (const auto *CRI = dyn_cast<CleanupReturnInst>(Val: &I)) {
4588 Out << " from ";
4589 writeOperand(Operand: CRI->getOperand(i_nocapture: 0), /*PrintType=*/false);
4590
4591 Out << " unwind ";
4592 if (CRI->hasUnwindDest())
4593 writeOperand(Operand: CRI->getOperand(i_nocapture: 1), /*PrintType=*/true);
4594 else
4595 Out << "to caller";
4596 } else if (const auto *CI = dyn_cast<CallInst>(Val: &I)) {
4597 // Print the calling convention being used.
4598 if (CI->getCallingConv() != CallingConv::C) {
4599 Out << " ";
4600 printCallingConv(cc: CI->getCallingConv(), Out);
4601 }
4602
4603 Operand = CI->getCalledOperand();
4604 FunctionType *FTy = CI->getFunctionType();
4605 Type *RetTy = FTy->getReturnType();
4606 const AttributeList &PAL = CI->getAttributes();
4607
4608 if (PAL.hasRetAttrs())
4609 Out << ' ' << PAL.getAsString(Index: AttributeList::ReturnIndex);
4610
4611 // Only print addrspace(N) if necessary:
4612 maybePrintCallAddrSpace(Operand, I: &I, Out);
4613
4614 // If possible, print out the short form of the call instruction. We can
4615 // only do this if the first argument is a pointer to a nonvararg function,
4616 // and if the return type is not a pointer to a function.
4617 Out << ' ';
4618 TypePrinter.print(Ty: FTy->isVarArg() ? FTy : RetTy, OS&: Out);
4619 Out << ' ';
4620 writeOperand(Operand, PrintType: false);
4621 Out << '(';
4622 bool HasPrettyPrintedArgs =
4623 isa<IntrinsicInst>(Val: CI) &&
4624 Intrinsic::hasPrettyPrintedArgs(id: CI->getIntrinsicID());
4625
4626 ListSeparator LS;
4627 Function *CalledFunc = CI->getCalledFunction();
4628 auto PrintArgComment = [&](unsigned ArgNo) {
4629 const auto *ConstArg = dyn_cast<Constant>(Val: CI->getArgOperand(i: ArgNo));
4630 if (!ConstArg)
4631 return;
4632 std::string ArgComment;
4633 raw_string_ostream ArgCommentStream(ArgComment);
4634 Intrinsic::ID IID = CalledFunc->getIntrinsicID();
4635 Intrinsic::printImmArg(IID, ArgIdx: ArgNo, OS&: ArgCommentStream, ImmArgVal: ConstArg);
4636 if (ArgComment.empty())
4637 return;
4638 Out << "/* " << ArgComment << " */ ";
4639 };
4640 if (HasPrettyPrintedArgs) {
4641 for (unsigned ArgNo = 0, NumArgs = CI->arg_size(); ArgNo < NumArgs;
4642 ++ArgNo) {
4643 Out << LS;
4644 PrintArgComment(ArgNo);
4645 writeParamOperand(Operand: CI->getArgOperand(i: ArgNo), Attrs: PAL.getParamAttrs(ArgNo));
4646 }
4647 } else {
4648 for (unsigned ArgNo = 0, NumArgs = CI->arg_size(); ArgNo < NumArgs;
4649 ++ArgNo) {
4650 Out << LS;
4651 writeParamOperand(Operand: CI->getArgOperand(i: ArgNo), Attrs: PAL.getParamAttrs(ArgNo));
4652 }
4653 }
4654 // Emit an ellipsis if this is a musttail call in a vararg function. This
4655 // is only to aid readability, musttail calls forward varargs by default.
4656 if (CI->isMustTailCall() && CI->getParent() &&
4657 CI->getParent()->getParent() &&
4658 CI->getParent()->getParent()->isVarArg()) {
4659 if (CI->arg_size() > 0)
4660 Out << ", ";
4661 Out << "...";
4662 }
4663
4664 Out << ')';
4665 if (PAL.hasFnAttrs())
4666 Out << " #" << Machine.getAttributeGroupSlot(AS: PAL.getFnAttrs());
4667
4668 writeOperandBundles(Call: CI);
4669 } else if (const auto *II = dyn_cast<InvokeInst>(Val: &I)) {
4670 Operand = II->getCalledOperand();
4671 FunctionType *FTy = II->getFunctionType();
4672 Type *RetTy = FTy->getReturnType();
4673 const AttributeList &PAL = II->getAttributes();
4674
4675 // Print the calling convention being used.
4676 if (II->getCallingConv() != CallingConv::C) {
4677 Out << " ";
4678 printCallingConv(cc: II->getCallingConv(), Out);
4679 }
4680
4681 if (PAL.hasRetAttrs())
4682 Out << ' ' << PAL.getAsString(Index: AttributeList::ReturnIndex);
4683
4684 // Only print addrspace(N) if necessary:
4685 maybePrintCallAddrSpace(Operand, I: &I, Out);
4686
4687 // If possible, print out the short form of the invoke instruction. We can
4688 // only do this if the first argument is a pointer to a nonvararg function,
4689 // and if the return type is not a pointer to a function.
4690 //
4691 Out << ' ';
4692 TypePrinter.print(Ty: FTy->isVarArg() ? FTy : RetTy, OS&: Out);
4693 Out << ' ';
4694 writeOperand(Operand, PrintType: false);
4695 Out << '(';
4696 ListSeparator LS;
4697 for (unsigned op = 0, Eop = II->arg_size(); op < Eop; ++op) {
4698 Out << LS;
4699 writeParamOperand(Operand: II->getArgOperand(i: op), Attrs: PAL.getParamAttrs(ArgNo: op));
4700 }
4701
4702 Out << ')';
4703 if (PAL.hasFnAttrs())
4704 Out << " #" << Machine.getAttributeGroupSlot(AS: PAL.getFnAttrs());
4705
4706 writeOperandBundles(Call: II);
4707
4708 Out << "\n to ";
4709 writeOperand(Operand: II->getNormalDest(), PrintType: true);
4710 Out << " unwind ";
4711 writeOperand(Operand: II->getUnwindDest(), PrintType: true);
4712 } else if (const auto *CBI = dyn_cast<CallBrInst>(Val: &I)) {
4713 Operand = CBI->getCalledOperand();
4714 FunctionType *FTy = CBI->getFunctionType();
4715 Type *RetTy = FTy->getReturnType();
4716 const AttributeList &PAL = CBI->getAttributes();
4717
4718 // Print the calling convention being used.
4719 if (CBI->getCallingConv() != CallingConv::C) {
4720 Out << " ";
4721 printCallingConv(cc: CBI->getCallingConv(), Out);
4722 }
4723
4724 if (PAL.hasRetAttrs())
4725 Out << ' ' << PAL.getAsString(Index: AttributeList::ReturnIndex);
4726
4727 // If possible, print out the short form of the callbr instruction. We can
4728 // only do this if the first argument is a pointer to a nonvararg function,
4729 // and if the return type is not a pointer to a function.
4730 //
4731 Out << ' ';
4732 TypePrinter.print(Ty: FTy->isVarArg() ? FTy : RetTy, OS&: Out);
4733 Out << ' ';
4734 writeOperand(Operand, PrintType: false);
4735 Out << '(';
4736 ListSeparator ArgLS;
4737 for (unsigned op = 0, Eop = CBI->arg_size(); op < Eop; ++op) {
4738 Out << ArgLS;
4739 writeParamOperand(Operand: CBI->getArgOperand(i: op), Attrs: PAL.getParamAttrs(ArgNo: op));
4740 }
4741
4742 Out << ')';
4743 if (PAL.hasFnAttrs())
4744 Out << " #" << Machine.getAttributeGroupSlot(AS: PAL.getFnAttrs());
4745
4746 writeOperandBundles(Call: CBI);
4747
4748 Out << "\n to ";
4749 writeOperand(Operand: CBI->getDefaultDest(), PrintType: true);
4750 Out << " [";
4751 ListSeparator DestLS;
4752 for (const BasicBlock *Dest : CBI->getIndirectDests()) {
4753 Out << DestLS;
4754 writeOperand(Operand: Dest, PrintType: true);
4755 }
4756 Out << ']';
4757 } else if (const auto *AI = dyn_cast<AllocaInst>(Val: &I)) {
4758 Out << ' ';
4759 if (AI->isUsedWithInAlloca())
4760 Out << "inalloca ";
4761 if (AI->isSwiftError())
4762 Out << "swifterror ";
4763 TypePrinter.print(Ty: AI->getAllocatedType(), OS&: Out);
4764
4765 // Explicitly write the array size if the code is broken, if it's an array
4766 // allocation, or if the type is not canonical for scalar allocations. The
4767 // latter case prevents the type from mutating when round-tripping through
4768 // assembly.
4769 if (!AI->getArraySize() || AI->isArrayAllocation() ||
4770 !AI->getArraySize()->getType()->isIntegerTy(Bitwidth: 32)) {
4771 Out << ", ";
4772 writeOperand(Operand: AI->getArraySize(), PrintType: true);
4773 }
4774 if (MaybeAlign A = AI->getAlign()) {
4775 Out << ", align " << A->value();
4776 }
4777
4778 printAddressSpace(M: AI->getModule(), AS: AI->getAddressSpace(), OS&: Out,
4779 /*Prefix=*/", ");
4780 } else if (isa<CastInst>(Val: I)) {
4781 if (Operand) {
4782 Out << ' ';
4783 writeOperand(Operand, PrintType: true); // Work with broken code
4784 }
4785 Out << " to ";
4786 TypePrinter.print(Ty: I.getType(), OS&: Out);
4787 } else if (isa<VAArgInst>(Val: I)) {
4788 if (Operand) {
4789 Out << ' ';
4790 writeOperand(Operand, PrintType: true); // Work with broken code
4791 }
4792 Out << ", ";
4793 TypePrinter.print(Ty: I.getType(), OS&: Out);
4794 } else if (Operand) { // Print the normal way.
4795 if (const auto *GEP = dyn_cast<GetElementPtrInst>(Val: &I)) {
4796 Out << ' ';
4797 TypePrinter.print(Ty: GEP->getSourceElementType(), OS&: Out);
4798 Out << ',';
4799 } else if (const auto *LI = dyn_cast<LoadInst>(Val: &I)) {
4800 Out << ' ';
4801 TypePrinter.print(Ty: LI->getType(), OS&: Out);
4802 Out << ',';
4803 }
4804
4805 // PrintAllTypes - Instructions who have operands of all the same type
4806 // omit the type from all but the first operand. If the instruction has
4807 // different type operands (for example br), then they are all printed.
4808 bool PrintAllTypes = false;
4809 Type *TheType = Operand->getType();
4810
4811 // Select, Store, ShuffleVector, CmpXchg and AtomicRMW always print all
4812 // types.
4813 if (isa<SelectInst>(Val: I) || isa<StoreInst>(Val: I) || isa<ShuffleVectorInst>(Val: I) ||
4814 isa<ReturnInst>(Val: I) || isa<AtomicCmpXchgInst>(Val: I) ||
4815 isa<AtomicRMWInst>(Val: I)) {
4816 PrintAllTypes = true;
4817 } else {
4818 for (unsigned i = 1, E = I.getNumOperands(); i != E; ++i) {
4819 Operand = I.getOperand(i);
4820 // note that Operand shouldn't be null, but the test helps make dump()
4821 // more tolerant of malformed IR
4822 if (Operand && Operand->getType() != TheType) {
4823 PrintAllTypes = true; // We have differing types! Print them all!
4824 break;
4825 }
4826 }
4827 }
4828
4829 if (!PrintAllTypes) {
4830 Out << ' ';
4831 TypePrinter.print(Ty: TheType, OS&: Out);
4832 }
4833
4834 Out << ' ';
4835 ListSeparator LS;
4836 for (const Value *Op : I.operands()) {
4837 Out << LS;
4838 writeOperand(Operand: Op, PrintType: PrintAllTypes);
4839 }
4840 }
4841
4842 // Print atomic ordering/alignment for memory operations
4843 if (const auto *LI = dyn_cast<LoadInst>(Val: &I)) {
4844 if (LI->isAtomic())
4845 writeAtomic(Context: LI->getContext(), Ordering: LI->getOrdering(), SSID: LI->getSyncScopeID());
4846 if (MaybeAlign A = LI->getAlign())
4847 Out << ", align " << A->value();
4848 } else if (const auto *SI = dyn_cast<StoreInst>(Val: &I)) {
4849 if (SI->isAtomic())
4850 writeAtomic(Context: SI->getContext(), Ordering: SI->getOrdering(), SSID: SI->getSyncScopeID());
4851 if (MaybeAlign A = SI->getAlign())
4852 Out << ", align " << A->value();
4853 } else if (const auto *CXI = dyn_cast<AtomicCmpXchgInst>(Val: &I)) {
4854 writeAtomicCmpXchg(Context: CXI->getContext(), SuccessOrdering: CXI->getSuccessOrdering(),
4855 FailureOrdering: CXI->getFailureOrdering(), SSID: CXI->getSyncScopeID());
4856 Out << ", align " << CXI->getAlign().value();
4857 } else if (const auto *RMWI = dyn_cast<AtomicRMWInst>(Val: &I)) {
4858 writeAtomic(Context: RMWI->getContext(), Ordering: RMWI->getOrdering(),
4859 SSID: RMWI->getSyncScopeID());
4860 Out << ", align " << RMWI->getAlign().value();
4861 } else if (const auto *FI = dyn_cast<FenceInst>(Val: &I)) {
4862 writeAtomic(Context: FI->getContext(), Ordering: FI->getOrdering(), SSID: FI->getSyncScopeID());
4863 } else if (const auto *SVI = dyn_cast<ShuffleVectorInst>(Val: &I)) {
4864 printShuffleMask(Out, Ty: SVI->getType(), Mask: SVI->getShuffleMask());
4865 }
4866
4867 // Print Metadata info.
4868 SmallVector<std::pair<unsigned, MDNode *>, 4> InstMD;
4869 I.getAllMetadata(MDs&: InstMD);
4870 printMetadataAttachments(MDs: InstMD, Separator: ", ");
4871
4872 // Print a nice comment.
4873 printInfoComment(V: I);
4874}
4875
4876void AssemblyWriter::printDbgMarker(const DbgMarker &Marker) {
4877 // There's no formal representation of a DbgMarker -- print purely as a
4878 // debugging aid.
4879 for (const DbgRecord &DPR : Marker.StoredDbgRecords) {
4880 printDbgRecord(DR: DPR);
4881 Out << "\n";
4882 }
4883
4884 Out << " DbgMarker -> { ";
4885 printInstruction(I: *Marker.MarkedInstr);
4886 Out << " }";
4887}
4888
4889void AssemblyWriter::printDbgRecord(const DbgRecord &DR) {
4890 if (auto *DVR = dyn_cast<DbgVariableRecord>(Val: &DR))
4891 printDbgVariableRecord(DVR: *DVR);
4892 else if (auto *DLR = dyn_cast<DbgLabelRecord>(Val: &DR))
4893 printDbgLabelRecord(DLR: *DLR);
4894 else
4895 llvm_unreachable("Unexpected DbgRecord kind");
4896}
4897
4898void AssemblyWriter::printDbgVariableRecord(const DbgVariableRecord &DVR) {
4899 auto WriterCtx = getContext();
4900 Out << "#dbg_";
4901 switch (DVR.getType()) {
4902 case DbgVariableRecord::LocationType::Value:
4903 Out << "value";
4904 break;
4905 case DbgVariableRecord::LocationType::Declare:
4906 Out << "declare";
4907 break;
4908 case DbgVariableRecord::LocationType::DeclareValue:
4909 Out << "declare_value";
4910 break;
4911 case DbgVariableRecord::LocationType::Assign:
4912 Out << "assign";
4913 break;
4914 default:
4915 llvm_unreachable(
4916 "Tried to print a DbgVariableRecord with an invalid LocationType!");
4917 }
4918
4919 auto PrintOrNull = [&](Metadata *M) {
4920 if (!M)
4921 Out << "(null)";
4922 else
4923 writeAsOperandInternal(Out, MD: M, WriterCtx, FromValue: true);
4924 };
4925
4926 Out << "(";
4927 PrintOrNull(DVR.getRawLocation());
4928 Out << ", ";
4929 PrintOrNull(DVR.getRawVariable());
4930 Out << ", ";
4931 PrintOrNull(DVR.getRawExpression());
4932 Out << ", ";
4933 if (DVR.isDbgAssign()) {
4934 PrintOrNull(DVR.getRawAssignID());
4935 Out << ", ";
4936 PrintOrNull(DVR.getRawAddress());
4937 Out << ", ";
4938 PrintOrNull(DVR.getRawAddressExpression());
4939 Out << ", ";
4940 }
4941 PrintOrNull(DVR.getDebugLoc().getAsMDNode());
4942 Out << ")";
4943}
4944
4945/// printDbgRecordLine - Print a DbgRecord with indentation and a newline
4946/// character.
4947void AssemblyWriter::printDbgRecordLine(const DbgRecord &DR) {
4948 // Print lengthier indentation to bring out-of-line with instructions.
4949 Out << " ";
4950 printDbgRecord(DR);
4951 Out << '\n';
4952}
4953
4954void AssemblyWriter::printDbgLabelRecord(const DbgLabelRecord &Label) {
4955 auto WriterCtx = getContext();
4956 Out << "#dbg_label(";
4957 writeAsOperandInternal(Out, MD: Label.getRawLabel(), WriterCtx, FromValue: true);
4958 Out << ", ";
4959 writeAsOperandInternal(Out, MD: Label.getDebugLoc(), WriterCtx, FromValue: true);
4960 Out << ")";
4961}
4962
4963void AssemblyWriter::printMetadataAttachments(
4964 const SmallVectorImpl<std::pair<unsigned, MDNode *>> &MDs,
4965 StringRef Separator) {
4966 if (MDs.empty())
4967 return;
4968
4969 if (MDNames.empty())
4970 MDs[0].second->getContext().getMDKindNames(Result&: MDNames);
4971
4972 auto WriterCtx = getContext();
4973 for (const auto &I : MDs) {
4974 unsigned Kind = I.first;
4975 Out << Separator;
4976 if (Kind < MDNames.size()) {
4977 Out << "!";
4978 printMetadataIdentifier(Name: MDNames[Kind], Out);
4979 } else
4980 Out << "!<unknown kind #" << Kind << ">";
4981 Out << ' ';
4982 writeAsOperandInternal(Out, MD: I.second, WriterCtx);
4983 }
4984}
4985
4986void AssemblyWriter::writeMDNode(unsigned Slot, const MDNode *Node) {
4987 Out << '!' << Slot << " = ";
4988 printMDNodeBody(MD: Node);
4989 Out << "\n";
4990}
4991
4992void AssemblyWriter::writeAllMDNodes() {
4993 SmallVector<const MDNode *, 16> Nodes;
4994 Nodes.resize(N: Machine.mdn_size());
4995 for (auto &I : llvm::make_range(x: Machine.mdn_begin(), y: Machine.mdn_end()))
4996 Nodes[I.second] = cast<MDNode>(Val: I.first);
4997
4998 for (unsigned i = 0, e = Nodes.size(); i != e; ++i) {
4999 writeMDNode(Slot: i, Node: Nodes[i]);
5000 }
5001}
5002
5003void AssemblyWriter::printMDNodeBody(const MDNode *Node) {
5004 auto WriterCtx = getContext();
5005 writeMDNodeBodyInternal(Out, Node, Ctx&: WriterCtx);
5006}
5007
5008void AssemblyWriter::writeAttribute(const Attribute &Attr, bool InAttrGroup) {
5009 if (!Attr.isTypeAttribute()) {
5010 Out << Attr.getAsString(InAttrGrp: InAttrGroup);
5011 return;
5012 }
5013
5014 Out << Attribute::getNameFromAttrKind(AttrKind: Attr.getKindAsEnum());
5015 if (Type *Ty = Attr.getValueAsType()) {
5016 Out << '(';
5017 TypePrinter.print(Ty, OS&: Out);
5018 Out << ')';
5019 }
5020}
5021
5022void AssemblyWriter::writeAttributeSet(const AttributeSet &AttrSet,
5023 bool InAttrGroup) {
5024 ListSeparator LS(" ");
5025 for (const auto &Attr : AttrSet) {
5026 Out << LS;
5027 writeAttribute(Attr, InAttrGroup);
5028 }
5029}
5030
5031void AssemblyWriter::writeAllAttributeGroups() {
5032 std::vector<std::pair<AttributeSet, unsigned>> asVec;
5033 asVec.resize(new_size: Machine.as_size());
5034
5035 for (auto &I : llvm::make_range(x: Machine.as_begin(), y: Machine.as_end()))
5036 asVec[I.second] = I;
5037
5038 for (const auto &I : asVec)
5039 Out << "attributes #" << I.second << " = { "
5040 << I.first.getAsString(InAttrGrp: true) << " }\n";
5041}
5042
5043void AssemblyWriter::printUseListOrder(const Value *V,
5044 ArrayRef<unsigned> Shuffle) {
5045 bool IsInFunction = Machine.getFunction();
5046 if (IsInFunction)
5047 Out << " ";
5048
5049 Out << "uselistorder";
5050 if (const BasicBlock *BB = IsInFunction ? nullptr : dyn_cast<BasicBlock>(Val: V)) {
5051 Out << "_bb ";
5052 writeOperand(Operand: BB->getParent(), PrintType: false);
5053 Out << ", ";
5054 writeOperand(Operand: BB, PrintType: false);
5055 } else {
5056 Out << " ";
5057 writeOperand(Operand: V, PrintType: true);
5058 }
5059
5060 assert(Shuffle.size() >= 2 && "Shuffle too small");
5061 Out << ", { " << llvm::interleaved(R: Shuffle) << " }\n";
5062}
5063
5064void AssemblyWriter::printUseLists(const Function *F) {
5065 auto It = UseListOrders.find(Val: F);
5066 if (It == UseListOrders.end())
5067 return;
5068
5069 Out << "\n; uselistorder directives\n";
5070 for (const auto &Pair : It->second)
5071 printUseListOrder(V: Pair.first, Shuffle: Pair.second);
5072}
5073
5074//===----------------------------------------------------------------------===//
5075// External Interface declarations
5076//===----------------------------------------------------------------------===//
5077
5078void Function::print(raw_ostream &ROS, AssemblyAnnotationWriter *AAW,
5079 bool ShouldPreserveUseListOrder, bool IsForDebug) const {
5080 SlotTracker SlotTable(this->getParent());
5081 formatted_raw_ostream OS(ROS);
5082 AssemblyWriter W(OS, SlotTable, this->getParent(), AAW, IsForDebug,
5083 ShouldPreserveUseListOrder);
5084 W.printFunction(F: this);
5085}
5086
5087void BasicBlock::print(raw_ostream &ROS, AssemblyAnnotationWriter *AAW,
5088 bool ShouldPreserveUseListOrder,
5089 bool IsForDebug) const {
5090 SlotTracker SlotTable(this->getParent());
5091 formatted_raw_ostream OS(ROS);
5092 AssemblyWriter W(OS, SlotTable, this->getModule(), AAW,
5093 IsForDebug,
5094 ShouldPreserveUseListOrder);
5095 W.printBasicBlock(BB: this);
5096}
5097
5098void Module::print(raw_ostream &ROS, AssemblyAnnotationWriter *AAW,
5099 bool ShouldPreserveUseListOrder, bool IsForDebug) const {
5100 SlotTracker SlotTable(this);
5101 formatted_raw_ostream OS(ROS);
5102 AssemblyWriter W(OS, SlotTable, this, AAW, IsForDebug,
5103 ShouldPreserveUseListOrder);
5104 W.printModule(M: this);
5105}
5106
5107void NamedMDNode::print(raw_ostream &ROS, bool IsForDebug) const {
5108 SlotTracker SlotTable(getParent());
5109 formatted_raw_ostream OS(ROS);
5110 AssemblyWriter W(OS, SlotTable, getParent(), nullptr, IsForDebug);
5111 W.printNamedMDNode(NMD: this);
5112}
5113
5114void NamedMDNode::print(raw_ostream &ROS, ModuleSlotTracker &MST,
5115 bool IsForDebug) const {
5116 std::optional<SlotTracker> LocalST;
5117 SlotTracker *SlotTable;
5118 if (auto *ST = MST.getMachine())
5119 SlotTable = ST;
5120 else {
5121 LocalST.emplace(args: getParent());
5122 SlotTable = &*LocalST;
5123 }
5124
5125 formatted_raw_ostream OS(ROS);
5126 AssemblyWriter W(OS, *SlotTable, getParent(), nullptr, IsForDebug);
5127 W.printNamedMDNode(NMD: this);
5128}
5129
5130void Comdat::print(raw_ostream &ROS, bool /*IsForDebug*/) const {
5131 printLLVMName(OS&: ROS, Name: getName(), Prefix: ComdatPrefix);
5132 ROS << " = comdat ";
5133
5134 switch (getSelectionKind()) {
5135 case Comdat::Any:
5136 ROS << "any";
5137 break;
5138 case Comdat::ExactMatch:
5139 ROS << "exactmatch";
5140 break;
5141 case Comdat::Largest:
5142 ROS << "largest";
5143 break;
5144 case Comdat::NoDeduplicate:
5145 ROS << "nodeduplicate";
5146 break;
5147 case Comdat::SameSize:
5148 ROS << "samesize";
5149 break;
5150 }
5151
5152 ROS << '\n';
5153}
5154
5155void Type::print(raw_ostream &OS, bool /*IsForDebug*/, bool NoDetails) const {
5156 TypePrinting TP;
5157 TP.print(Ty: const_cast<Type*>(this), OS);
5158
5159 if (NoDetails)
5160 return;
5161
5162 // If the type is a named struct type, print the body as well.
5163 if (auto *STy = dyn_cast<StructType>(Val: const_cast<Type *>(this)))
5164 if (!STy->isLiteral()) {
5165 OS << " = type ";
5166 TP.printStructBody(STy, OS);
5167 }
5168}
5169
5170static bool isReferencingMDNode(const Instruction &I) {
5171 if (const auto *CI = dyn_cast<CallInst>(Val: &I))
5172 if (Function *F = CI->getCalledFunction())
5173 if (F->isIntrinsic())
5174 for (auto &Op : I.operands())
5175 if (auto *V = dyn_cast_or_null<MetadataAsValue>(Val: Op))
5176 if (isa<MDNode>(Val: V->getMetadata()))
5177 return true;
5178 return false;
5179}
5180
5181void DbgMarker::print(raw_ostream &ROS, bool IsForDebug) const {
5182
5183 ModuleSlotTracker MST(getModuleFromDPI(Marker: this), true);
5184 print(ROS, MST, IsForDebug);
5185}
5186
5187void DbgVariableRecord::print(raw_ostream &ROS, bool IsForDebug) const {
5188
5189 ModuleSlotTracker MST(getModuleFromDPI(DR: this), true);
5190 print(ROS, MST, IsForDebug);
5191}
5192
5193void DbgMarker::print(raw_ostream &ROS, ModuleSlotTracker &MST,
5194 bool IsForDebug) const {
5195 formatted_raw_ostream OS(ROS);
5196 SlotTracker EmptySlotTable(static_cast<const Module *>(nullptr));
5197 SlotTracker &SlotTable =
5198 MST.getMachine() ? *MST.getMachine() : EmptySlotTable;
5199 const Function *F = getParent() ? getParent()->getParent() : nullptr;
5200 if (F)
5201 MST.incorporateFunction(F: *F);
5202 AssemblyWriter W(OS, SlotTable, getModuleFromDPI(Marker: this), nullptr, IsForDebug);
5203 W.printDbgMarker(Marker: *this);
5204}
5205
5206void DbgLabelRecord::print(raw_ostream &ROS, bool IsForDebug) const {
5207
5208 ModuleSlotTracker MST(getModuleFromDPI(DR: this), true);
5209 print(ROS, MST, IsForDebug);
5210}
5211
5212void DbgVariableRecord::print(raw_ostream &ROS, ModuleSlotTracker &MST,
5213 bool IsForDebug) const {
5214 formatted_raw_ostream OS(ROS);
5215 SlotTracker EmptySlotTable(static_cast<const Module *>(nullptr));
5216 SlotTracker &SlotTable =
5217 MST.getMachine() ? *MST.getMachine() : EmptySlotTable;
5218 const Function *F = Marker && Marker->getParent()
5219 ? Marker->getParent()->getParent()
5220 : nullptr;
5221 if (F)
5222 MST.incorporateFunction(F: *F);
5223 AssemblyWriter W(OS, SlotTable, getModuleFromDPI(DR: this), nullptr, IsForDebug);
5224 W.printDbgVariableRecord(DVR: *this);
5225}
5226
5227void DbgLabelRecord::print(raw_ostream &ROS, ModuleSlotTracker &MST,
5228 bool IsForDebug) const {
5229 formatted_raw_ostream OS(ROS);
5230 SlotTracker EmptySlotTable(static_cast<const Module *>(nullptr));
5231 SlotTracker &SlotTable =
5232 MST.getMachine() ? *MST.getMachine() : EmptySlotTable;
5233 const Function *F =
5234 Marker->getParent() ? Marker->getParent()->getParent() : nullptr;
5235 if (F)
5236 MST.incorporateFunction(F: *F);
5237
5238 AssemblyWriter W(OS, SlotTable, getModuleFromDPI(DR: this), nullptr, IsForDebug);
5239 W.printDbgLabelRecord(Label: *this);
5240}
5241
5242void Value::print(raw_ostream &ROS, bool IsForDebug) const {
5243 bool ShouldInitializeAllMetadata = false;
5244 if (auto *I = dyn_cast<Instruction>(Val: this))
5245 ShouldInitializeAllMetadata = isReferencingMDNode(I: *I);
5246 else if (isa<Function>(Val: this) || isa<MetadataAsValue>(Val: this))
5247 ShouldInitializeAllMetadata = true;
5248
5249 ModuleSlotTracker MST(getModuleFromVal(V: this), ShouldInitializeAllMetadata);
5250 print(O&: ROS, MST, IsForDebug);
5251}
5252
5253void Value::print(raw_ostream &ROS, ModuleSlotTracker &MST,
5254 bool IsForDebug) const {
5255 formatted_raw_ostream OS(ROS);
5256 SlotTracker EmptySlotTable(static_cast<const Module *>(nullptr));
5257 SlotTracker &SlotTable =
5258 MST.getMachine() ? *MST.getMachine() : EmptySlotTable;
5259 auto IncorporateFunction = [&](const Function *F) {
5260 if (F)
5261 MST.incorporateFunction(F: *F);
5262 };
5263
5264 if (const auto *I = dyn_cast<Instruction>(Val: this)) {
5265 IncorporateFunction(I->getParent() ? I->getParent()->getParent() : nullptr);
5266 AssemblyWriter W(OS, SlotTable, getModuleFromVal(V: I), nullptr, IsForDebug);
5267 W.printInstruction(I: *I);
5268 } else if (const auto *BB = dyn_cast<BasicBlock>(Val: this)) {
5269 IncorporateFunction(BB->getParent());
5270 AssemblyWriter W(OS, SlotTable, getModuleFromVal(V: BB), nullptr, IsForDebug);
5271 W.printBasicBlock(BB);
5272 } else if (const auto *GV = dyn_cast<GlobalValue>(Val: this)) {
5273 AssemblyWriter W(OS, SlotTable, GV->getParent(), nullptr, IsForDebug);
5274 if (const auto *V = dyn_cast<GlobalVariable>(Val: GV))
5275 W.printGlobal(GV: V);
5276 else if (const auto *F = dyn_cast<Function>(Val: GV))
5277 W.printFunction(F);
5278 else if (const auto *A = dyn_cast<GlobalAlias>(Val: GV))
5279 W.printAlias(GA: A);
5280 else if (const auto *I = dyn_cast<GlobalIFunc>(Val: GV))
5281 W.printIFunc(GI: I);
5282 else
5283 llvm_unreachable("Unknown GlobalValue to print out!");
5284 } else if (const auto *V = dyn_cast<MetadataAsValue>(Val: this)) {
5285 V->getMetadata()->print(OS&: ROS, MST, M: getModuleFromVal(V));
5286 } else if (const auto *C = dyn_cast<Constant>(Val: this)) {
5287 TypePrinting TypePrinter;
5288 TypePrinter.print(Ty: C->getType(), OS);
5289 OS << ' ';
5290 AsmWriterContext WriterCtx(&TypePrinter, MST.getMachine());
5291 writeConstantInternal(Out&: OS, CV: C, WriterCtx);
5292 } else if (isa<InlineAsm>(Val: this) || isa<Argument>(Val: this)) {
5293 this->printAsOperand(O&: OS, /* PrintType */ true, MST);
5294 } else {
5295 llvm_unreachable("Unknown value to print out!");
5296 }
5297}
5298
5299/// Print without a type, skipping the TypePrinting object.
5300///
5301/// \return \c true iff printing was successful.
5302static bool printWithoutType(const Value &V, raw_ostream &O,
5303 SlotTracker *Machine, const Module *M) {
5304 if (V.hasName() || isa<GlobalValue>(Val: V) ||
5305 (!isa<Constant>(Val: V) && !isa<MetadataAsValue>(Val: V))) {
5306 AsmWriterContext WriterCtx(nullptr, Machine, M);
5307 writeAsOperandInternal(Out&: O, V: &V, WriterCtx);
5308 return true;
5309 }
5310 return false;
5311}
5312
5313static void printAsOperandImpl(const Value &V, raw_ostream &O, bool PrintType,
5314 ModuleSlotTracker &MST) {
5315 TypePrinting TypePrinter(MST.getModule());
5316 AsmWriterContext WriterCtx(&TypePrinter, MST.getMachine(), MST.getModule());
5317 writeAsOperandInternal(Out&: O, V: &V, WriterCtx, PrintType);
5318}
5319
5320void Value::printAsOperand(raw_ostream &O, bool PrintType,
5321 const Module *M) const {
5322 if (!M)
5323 M = getModuleFromVal(V: this);
5324
5325 if (!PrintType)
5326 if (printWithoutType(V: *this, O, Machine: nullptr, M))
5327 return;
5328
5329 SlotTracker Machine(
5330 M, /* ShouldInitializeAllMetadata */ isa<MetadataAsValue>(Val: this));
5331 ModuleSlotTracker MST(Machine, M);
5332 printAsOperandImpl(V: *this, O, PrintType, MST);
5333}
5334
5335void Value::printAsOperand(raw_ostream &O, bool PrintType,
5336 ModuleSlotTracker &MST) const {
5337 if (!PrintType)
5338 if (printWithoutType(V: *this, O, Machine: MST.getMachine(), M: MST.getModule()))
5339 return;
5340
5341 printAsOperandImpl(V: *this, O, PrintType, MST);
5342}
5343
5344/// Recursive version of printMetadataImpl.
5345static void printMetadataImplRec(raw_ostream &ROS, const Metadata &MD,
5346 AsmWriterContext &WriterCtx) {
5347 formatted_raw_ostream OS(ROS);
5348 writeAsOperandInternal(Out&: OS, MD: &MD, WriterCtx, /* FromValue */ true);
5349
5350 auto *N = dyn_cast<MDNode>(Val: &MD);
5351 if (!N || isa<DIExpression>(Val: MD))
5352 return;
5353
5354 OS << " = ";
5355 writeMDNodeBodyInternal(Out&: OS, Node: N, Ctx&: WriterCtx);
5356}
5357
5358namespace {
5359struct MDTreeAsmWriterContext : public AsmWriterContext {
5360 unsigned Level;
5361 // {Level, Printed string}
5362 using EntryTy = std::pair<unsigned, std::string>;
5363 SmallVector<EntryTy, 4> Buffer;
5364
5365 // Used to break the cycle in case there is any.
5366 SmallPtrSet<const Metadata *, 4> Visited;
5367
5368 raw_ostream &MainOS;
5369
5370 MDTreeAsmWriterContext(TypePrinting *TP, SlotTracker *ST, const Module *M,
5371 raw_ostream &OS, const Metadata *InitMD)
5372 : AsmWriterContext(TP, ST, M), Level(0U), Visited({InitMD}), MainOS(OS) {}
5373
5374 void onWriteMetadataAsOperand(const Metadata *MD) override {
5375 if (!Visited.insert(Ptr: MD).second)
5376 return;
5377
5378 std::string Str;
5379 raw_string_ostream SS(Str);
5380 ++Level;
5381 // A placeholder entry to memorize the correct
5382 // position in buffer.
5383 Buffer.emplace_back(Args: std::make_pair(x&: Level, y: ""));
5384 unsigned InsertIdx = Buffer.size() - 1;
5385
5386 printMetadataImplRec(ROS&: SS, MD: *MD, WriterCtx&: *this);
5387 Buffer[InsertIdx].second = std::move(SS.str());
5388 --Level;
5389 }
5390
5391 ~MDTreeAsmWriterContext() override {
5392 for (const auto &Entry : Buffer) {
5393 MainOS << "\n";
5394 unsigned NumIndent = Entry.first * 2U;
5395 MainOS.indent(NumSpaces: NumIndent) << Entry.second;
5396 }
5397 }
5398};
5399} // end anonymous namespace
5400
5401static void printMetadataImpl(raw_ostream &ROS, const Metadata &MD,
5402 ModuleSlotTracker &MST, const Module *M,
5403 bool OnlyAsOperand, bool PrintAsTree = false) {
5404 formatted_raw_ostream OS(ROS);
5405
5406 TypePrinting TypePrinter(M);
5407
5408 std::unique_ptr<AsmWriterContext> WriterCtx;
5409 if (PrintAsTree && !OnlyAsOperand)
5410 WriterCtx = std::make_unique<MDTreeAsmWriterContext>(
5411 args: &TypePrinter, args: MST.getMachine(), args&: M, args&: OS, args: &MD);
5412 else
5413 WriterCtx =
5414 std::make_unique<AsmWriterContext>(args: &TypePrinter, args: MST.getMachine(), args&: M);
5415
5416 writeAsOperandInternal(Out&: OS, MD: &MD, WriterCtx&: *WriterCtx, /* FromValue */ true);
5417
5418 auto *N = dyn_cast<MDNode>(Val: &MD);
5419 if (OnlyAsOperand || !N || isa<DIExpression>(Val: MD))
5420 return;
5421
5422 OS << " = ";
5423 writeMDNodeBodyInternal(Out&: OS, Node: N, Ctx&: *WriterCtx);
5424}
5425
5426void Metadata::printAsOperand(raw_ostream &OS, const Module *M) const {
5427 ModuleSlotTracker MST(M, isa<MDNode>(Val: this));
5428 printMetadataImpl(ROS&: OS, MD: *this, MST, M, /* OnlyAsOperand */ true);
5429}
5430
5431void Metadata::printAsOperand(raw_ostream &OS, ModuleSlotTracker &MST,
5432 const Module *M) const {
5433 printMetadataImpl(ROS&: OS, MD: *this, MST, M, /* OnlyAsOperand */ true);
5434}
5435
5436void Metadata::print(raw_ostream &OS, const Module *M,
5437 bool /*IsForDebug*/) const {
5438 ModuleSlotTracker MST(M, isa<MDNode>(Val: this));
5439 printMetadataImpl(ROS&: OS, MD: *this, MST, M, /* OnlyAsOperand */ false);
5440}
5441
5442void Metadata::print(raw_ostream &OS, ModuleSlotTracker &MST,
5443 const Module *M, bool /*IsForDebug*/) const {
5444 printMetadataImpl(ROS&: OS, MD: *this, MST, M, /* OnlyAsOperand */ false);
5445}
5446
5447void MDNode::printTree(raw_ostream &OS, const Module *M) const {
5448 ModuleSlotTracker MST(M, true);
5449 printMetadataImpl(ROS&: OS, MD: *this, MST, M, /* OnlyAsOperand */ false,
5450 /*PrintAsTree=*/true);
5451}
5452
5453void MDNode::printTree(raw_ostream &OS, ModuleSlotTracker &MST,
5454 const Module *M) const {
5455 printMetadataImpl(ROS&: OS, MD: *this, MST, M, /* OnlyAsOperand */ false,
5456 /*PrintAsTree=*/true);
5457}
5458
5459void ModuleSummaryIndex::print(raw_ostream &ROS, bool IsForDebug) const {
5460 SlotTracker SlotTable(this);
5461 formatted_raw_ostream OS(ROS);
5462 AssemblyWriter W(OS, SlotTable, this, IsForDebug);
5463 W.printModuleSummaryIndex();
5464}
5465
5466void ModuleSlotTracker::collectMDNodes(MachineMDNodeListType &L, unsigned LB,
5467 unsigned UB) const {
5468 SlotTracker *ST = MachineStorage.get();
5469 if (!ST)
5470 return;
5471
5472 for (auto &I : llvm::make_range(x: ST->mdn_begin(), y: ST->mdn_end()))
5473 if (I.second >= LB && I.second < UB)
5474 L.push_back(x: std::make_pair(x&: I.second, y&: I.first));
5475}
5476
5477#if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
5478// Value::dump - allow easy printing of Values from the debugger.
5479LLVM_DUMP_METHOD
5480void Value::dump() const { print(dbgs(), /*IsForDebug=*/true); dbgs() << '\n'; }
5481
5482// Value::dump - allow easy printing of Values from the debugger.
5483LLVM_DUMP_METHOD
5484void DbgMarker::dump() const {
5485 print(dbgs(), /*IsForDebug=*/true);
5486 dbgs() << '\n';
5487}
5488
5489// Value::dump - allow easy printing of Values from the debugger.
5490LLVM_DUMP_METHOD
5491void DbgRecord::dump() const { print(dbgs(), /*IsForDebug=*/true); dbgs() << '\n'; }
5492
5493// Type::dump - allow easy printing of Types from the debugger.
5494LLVM_DUMP_METHOD
5495void Type::dump() const { print(dbgs(), /*IsForDebug=*/true); dbgs() << '\n'; }
5496
5497// Module::dump() - Allow printing of Modules from the debugger.
5498LLVM_DUMP_METHOD
5499void Module::dump() const {
5500 print(dbgs(), nullptr,
5501 /*ShouldPreserveUseListOrder=*/false, /*IsForDebug=*/true);
5502}
5503
5504// Allow printing of Comdats from the debugger.
5505LLVM_DUMP_METHOD
5506void Comdat::dump() const { print(dbgs(), /*IsForDebug=*/true); }
5507
5508// NamedMDNode::dump() - Allow printing of NamedMDNodes from the debugger.
5509LLVM_DUMP_METHOD
5510void NamedMDNode::dump() const { print(dbgs(), /*IsForDebug=*/true); }
5511
5512LLVM_DUMP_METHOD
5513void Metadata::dump() const { dump(nullptr); }
5514
5515LLVM_DUMP_METHOD
5516void Metadata::dump(const Module *M) const {
5517 print(dbgs(), M, /*IsForDebug=*/true);
5518 dbgs() << '\n';
5519}
5520
5521LLVM_DUMP_METHOD
5522void MDNode::dumpTree() const { dumpTree(nullptr); }
5523
5524LLVM_DUMP_METHOD
5525void MDNode::dumpTree(const Module *M) const {
5526 printTree(dbgs(), M);
5527 dbgs() << '\n';
5528}
5529
5530// Allow printing of ModuleSummaryIndex from the debugger.
5531LLVM_DUMP_METHOD
5532void ModuleSummaryIndex::dump() const { print(dbgs(), /*IsForDebug=*/true); }
5533#endif
5534