LLVM 24.0.0git
MicrosoftDemangleNodes.cpp
Go to the documentation of this file.
1//===- MicrosoftDemangle.cpp ----------------------------------------------===//
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 file defines a demangler for MSVC-style mangled symbols.
10//
11//===----------------------------------------------------------------------===//
12
15#include <cctype>
16#include <string>
17
18using namespace llvm;
19using namespace ms_demangle;
20
21#define OUTPUT_ENUM_CLASS_VALUE(Enum, Value, Desc) \
22 case Enum::Value: \
23 OB << Desc; \
24 break;
25
26// Writes a space if the last token does not end with a punctuation.
28 if (OB.empty())
29 return;
30
31 char C = OB.back();
32 if (std::isalnum(C) || C == '>')
33 OB << " ";
34}
35
37 switch (Q) {
38 case Q_Const:
39 OB << "const";
40 break;
41 case Q_Volatile:
42 OB << "volatile";
43 break;
44 case Q_Restrict:
45 OB << "__restrict";
46 break;
47 default:
48 break;
49 }
50}
51
53 Qualifiers Mask, bool NeedSpace) {
54 if (!(Q & Mask))
55 return NeedSpace;
56
57 if (NeedSpace)
58 OB << " ";
59
60 outputSingleQualifier(OB, Mask);
61 return true;
62}
63
64static void outputQualifiers(OutputBuffer &OB, Qualifiers Q, bool SpaceBefore,
65 bool SpaceAfter) {
66 if (Q == Q_None)
67 return;
68
69 size_t Pos1 = OB.getCurrentPosition();
70 SpaceBefore = outputQualifierIfPresent(OB, Q, Q_Const, SpaceBefore);
71 SpaceBefore = outputQualifierIfPresent(OB, Q, Q_Volatile, SpaceBefore);
72 SpaceBefore = outputQualifierIfPresent(OB, Q, Q_Restrict, SpaceBefore);
73 size_t Pos2 = OB.getCurrentPosition();
74 if (SpaceAfter && Pos2 > Pos1)
75 OB << " ";
76}
77
80
81 switch (CC) {
82 case CallingConv::Cdecl:
83 OB << "__cdecl";
84 break;
85 case CallingConv::Fastcall:
86 OB << "__fastcall";
87 break;
88 case CallingConv::Pascal:
89 OB << "__pascal";
90 break;
91 case CallingConv::Regcall:
92 OB << "__regcall";
93 break;
94 case CallingConv::Stdcall:
95 OB << "__stdcall";
96 break;
97 case CallingConv::Thiscall:
98 OB << "__thiscall";
99 break;
100 case CallingConv::Eabi:
101 OB << "__eabi";
102 break;
103 case CallingConv::Vectorcall:
104 OB << "__vectorcall";
105 break;
106 case CallingConv::Clrcall:
107 OB << "__clrcall";
108 break;
110 OB << "__attribute__((__swiftcall__)) ";
111 break;
112 case CallingConv::SwiftAsync:
113 OB << "__attribute__((__swiftasynccall__)) ";
114 break;
115 default:
116 break;
117 }
118}
119
120std::string Node::toString(OutputFlags Flags) const {
121 OutputBuffer OB;
122 this->output(OB, Flags);
123 std::string_view SV = OB;
124 std::string Owned(SV.begin(), SV.end());
125 std::free(OB.getBuffer());
126 return Owned;
127}
128
130 switch (PrimKind) {
140 OUTPUT_ENUM_CLASS_VALUE(PrimitiveKind, Ushort, "unsigned short");
146 OUTPUT_ENUM_CLASS_VALUE(PrimitiveKind, Uint64, "unsigned __int64");
154 }
155 outputQualifiers(OB, Quals, true, false);
156}
157
159 output(OB, Flags, ", ");
160}
161
163 std::string_view Separator) const {
164 if (Count == 0)
165 return;
166 if (Nodes[0])
167 Nodes[0]->output(OB, Flags);
168 for (size_t I = 1; I < Count; ++I) {
169 OB << Separator;
170 Nodes[I]->output(OB, Flags);
171 }
172}
173
175 OutputFlags Flags) const {
176 switch (Char) {
177 case CharKind::Wchar:
178 OB << "L\"";
179 break;
180 case CharKind::Char:
181 OB << "\"";
182 break;
183 case CharKind::Char16:
184 OB << "u\"";
185 break;
186 case CharKind::Char32:
187 OB << "U\"";
188 break;
189 }
190 OB << DecodedString << "\"";
191 if (IsTruncated)
192 OB << "...";
193}
194
196 if (IsNegative)
197 OB << '-';
198 OB << Value;
199}
200
202 OutputFlags Flags) const {
203 if (ThunkOffsetCount > 0)
204 OB << "{";
206 OB << "&";
207
208 if (Symbol) {
209 Symbol->output(OB, Flags);
210 if (ThunkOffsetCount > 0)
211 OB << ", ";
212 }
213
214 if (ThunkOffsetCount > 0)
215 OB << ThunkOffsets[0];
216 for (int I = 1; I < ThunkOffsetCount; ++I) {
217 OB << ", " << ThunkOffsets[I];
218 }
219 if (ThunkOffsetCount > 0)
220 OB << "}";
221}
222
224 OutputFlags Flags) const {
225 if (!TemplateParams)
226 return;
227 OB << "<";
228 TemplateParams->output(OB, Flags);
229 OB << ">";
230}
231
233 OutputFlags Flags) const {
234 if (IsDestructor)
235 OB << "`dynamic atexit destructor for ";
236 else
237 OB << "`dynamic initializer for ";
238
239 if (Variable) {
240 OB << "`";
241 Variable->output(OB, Flags);
242 OB << "''";
243 } else {
244 OB << "'";
245 Name->output(OB, Flags);
246 OB << "''";
247 }
248}
249
251 OB << Name;
252 outputTemplateParameters(OB, Flags);
253}
254
256 OutputFlags Flags) const {
257 switch (Operator) {
267 "operator[]");
276 "operator->*");
283 "operator>=");
299 "operator&=");
301 "operator|=");
303 "operator^=");
306 "`vector deleting dtor'");
308 "`default ctor closure'");
310 "`scalar deleting dtor'");
312 "`vector ctor iterator'");
314 "`vector dtor iterator'");
316 "`vector vbase ctor iterator'");
318 "`virtual displacement map'");
320 "`eh vector ctor iterator'");
322 "`eh vector dtor iterator'");
324 "`eh vector vbase ctor iterator'");
326 "`copy ctor closure'");
328 "`local vftable ctor closure'");
331 "operator delete[]");
333 "`managed vector ctor iterator'");
335 "`managed vector dtor iterator'");
337 "`EH vector copy ctor iterator'");
339 "`EH vector vbase copy ctor iterator'");
341 "`vector copy ctor iterator'");
343 "`vector vbase copy constructor iterator'");
345 "`managed vector vbase copy constructor iterator'");
347 "operator co_await");
351 break;
352 }
353 outputTemplateParameters(OB, Flags);
354}
355
357 OutputFlags Flags) const {
358 if (IsThread)
359 OB << "`local static thread guard'";
360 else
361 OB << "`local static guard'";
362 if (ScopeIndex > 0)
363 OB << "{" << ScopeIndex << "}";
364}
365
367 OutputFlags Flags) const {
368 OB << "operator";
369 outputTemplateParameters(OB, Flags);
370 OB << " ";
371 TargetType->output(OB, Flags);
372}
373
375 if (IsDestructor)
376 OB << "~";
377 Class->output(OB, Flags);
378 outputTemplateParameters(OB, Flags);
379}
380
382 OutputFlags Flags) const {
383 OB << "operator \"\"" << Name;
384 outputTemplateParameters(OB, Flags);
385}
386
388 OutputFlags Flags) const {
389 if (!(Flags & OF_NoAccessSpecifier)) {
391 OB << "public: ";
393 OB << "protected: ";
395 OB << "private: ";
396 }
397
398 if (!(Flags & OF_NoMemberType)) {
399 if (!(FunctionClass & FC_Global)) {
401 OB << "static ";
402 }
404 OB << "virtual ";
405
407 OB << "extern \"C\" ";
408 }
409
410 if (!(Flags & OF_NoReturnType) && ReturnType) {
411 ReturnType->outputPre(OB, Flags);
412 OB << " ";
413 }
414}
415
417 OutputFlags Flags) const {
418 outputPreSignature(OB, Flags);
419
420 if (!(Flags & OF_NoCallingConvention))
422}
423
425 OutputFlags Flags) const {
427 OB << "(";
428 if (Params)
429 Params->output(OB, Flags);
430 else if (!(Flags & OF_NoVoidParameter))
431 OB << "void";
432
433 if (IsVariadic) {
434 if (OB.back() != '(')
435 OB << ", ";
436 OB << "...";
437 }
438 OB << ")";
439 }
440
441 if (Quals & Q_Const)
442 OB << " const";
443 if (Quals & Q_Volatile)
444 OB << " volatile";
445 if (Quals & Q_Restrict)
446 OB << " __restrict";
447 if (Quals & Q_Unaligned)
448 OB << " __unaligned";
449
450 if (IsNoexcept)
451 OB << " noexcept";
452
454 OB << " &";
456 OB << " &&";
457
458 if (!(Flags & OF_NoReturnType) && ReturnType)
459 ReturnType->outputPost(OB, Flags);
460}
461
463 OB << "[thunk]: ";
464
466}
467
470 OB << "`adjustor{" << ThisAdjust.StaticOffset << "}'";
471 } else if (FunctionClass & FC_VirtualThisAdjust) {
473 OB << "`vtordispex{" << ThisAdjust.VBPtrOffset << ", "
474 << ThisAdjust.VBOffsetOffset << ", " << ThisAdjust.VtordispOffset
475 << ", " << ThisAdjust.StaticOffset << "}'";
476 } else {
477 OB << "`vtordisp{" << ThisAdjust.VtordispOffset << ", "
478 << ThisAdjust.StaticOffset << "}'";
479 }
480 }
481
483}
484
486 if (Pointee->kind() == NodeKind::FunctionSignature) {
487 // If this is a pointer to a function, don't output the calling convention.
488 // It needs to go inside the parentheses.
489 const FunctionSignatureNode *Sig =
490 static_cast<const FunctionSignatureNode *>(Pointee);
491 // A function pointer's return type is part of its type, so we ignore
492 // OF_NoReturnType.
494 } else
495 Pointee->outputPre(OB, Flags);
496
498
499 if (Quals & Q_Unaligned)
500 OB << "__unaligned ";
501
502 if (Pointee->kind() == NodeKind::ArrayType) {
503 OB << "(";
504 } else if (Pointee->kind() == NodeKind::FunctionSignature) {
505 OB << "(";
506 const FunctionSignatureNode *Sig =
507 static_cast<const FunctionSignatureNode *>(Pointee);
508 if (!(Flags & OF_NoCallingConvention)) {
510 OB << " ";
511 }
512 }
513
514 if (ClassParent) {
515 ClassParent->output(OB, Flags);
516 OB << "::";
517 }
518
519 switch (Affinity) {
521 OB << "*";
522 break;
524 OB << "&";
525 break;
527 OB << "&&";
528 break;
529 default:
530 assert(false);
531 }
532 outputQualifiers(OB, Quals, false, false);
533
535 PointerAuthQualifier->output(OB, Flags);
536}
537
539 if (Pointee->kind() == NodeKind::ArrayType ||
541 OB << ")";
542
543 if (Pointee->kind() == NodeKind::FunctionSignature) {
544 // A function pointer's return type is part of its type, so we ignore
545 // OF_NoReturnType.
546 Pointee->outputPost(OB, OutputFlags(Flags & ~OF_NoReturnType));
547 } else
548 Pointee->outputPost(OB, Flags);
549}
550
552 if (!(Flags & OF_NoTagSpecifier)) {
553 switch (Tag) {
558 }
559 OB << " ";
560 }
561 QualifiedName->output(OB, Flags);
562 outputQualifiers(OB, Quals, true, false);
563}
564
566
568 ElementType->outputPre(OB, Flags);
569 outputQualifiers(OB, Quals, true, false);
570}
571
573 Node *N) const {
575 IntegerLiteralNode *ILN = static_cast<IntegerLiteralNode *>(N);
576 if (ILN->Value != 0)
577 ILN->output(OB, Flags);
578}
579
581 OutputFlags Flags) const {
582 if (Dimensions->Count == 0)
583 return;
584
585 outputOneDimension(OB, Flags, Dimensions->Nodes[0]);
586 for (size_t I = 1; I < Dimensions->Count; ++I) {
587 OB << "][";
588 outputOneDimension(OB, Flags, Dimensions->Nodes[I]);
589 }
590}
591
593 OB << "[";
594 outputDimensionsImpl(OB, Flags);
595 OB << "]";
596
597 ElementType->outputPost(OB, Flags);
598}
599
601 Name->output(OB, Flags);
602}
603
605 Signature->outputPre(OB, Flags);
607 Name->output(OB, Flags);
608 Signature->outputPost(OB, Flags);
609}
610
612 OutputFlags Flags) const {
613 OB << "__ptrauth(";
614 Components->output(OB, Flags);
615 OB << ")";
616}
617
619 const char *AccessSpec = nullptr;
620 bool IsStatic = true;
621 switch (SC) {
623 AccessSpec = "private";
624 break;
626 AccessSpec = "public";
627 break;
629 AccessSpec = "protected";
630 break;
631 default:
632 IsStatic = false;
633 break;
634 }
635 if (!(Flags & OF_NoAccessSpecifier) && AccessSpec)
636 OB << AccessSpec << ": ";
637 if (!(Flags & OF_NoMemberType) && IsStatic)
638 OB << "static ";
639
640 if (!(Flags & OF_NoVariableType) && Type)
641 Type->outputPre(OB, Flags);
642 if (shouldOutputName(Flags)) {
644 Name->output(OB, Flags);
645 }
646 if (!(Flags & OF_NoVariableType) && Type)
647 Type->outputPost(OB, Flags);
648}
649
651 Identifier->output(OB, Flags);
652}
654
656 Components->output(OB, Flags, "::");
657}
658
660 OutputFlags Flags) const {
661 OB << "`RTTI Base Class Descriptor at (";
662 OB << NVOffset << ", " << VBPtrOffset << ", " << VBTableOffset << ", "
663 << this->Flags;
664 OB << ")'";
665}
666
668 OutputFlags Flags) const {
669 Name->output(OB, Flags);
670}
671
673 OutputFlags Flags) const {
674 OB << "`vcall'{" << OffsetInVTable << ", {flat}}";
675}
676
678 outputQualifiers(OB, Quals, false, true);
679 Name->output(OB, Flags);
680 if (TargetNames) {
681 OB << "{for `";
682 TargetNames->output(OB, Flags, "'s `");
683 OB << "'}";
684 }
685}
assert(UImm &&(UImm !=~static_cast< T >(0)) &&"Invalid immediate!")
static GCRegistry::Add< ShadowStackGC > C("shadow-stack", "Very portable GC for uncooperative code generators")
Qualifiers
#define I(x, y, z)
Definition MD5.cpp:57
static void outputCallingConvention(OutputBuffer &OB, CallingConv CC)
#define OUTPUT_ENUM_CLASS_VALUE(Enum, Value, Desc)
static void outputSingleQualifier(OutputBuffer &OB, Qualifiers Q)
static bool outputQualifierIfPresent(OutputBuffer &OB, Qualifiers Q, Qualifiers Mask, bool NeedSpace)
static void outputQualifiers(OutputBuffer &OB, Qualifiers Q, bool SpaceBefore, bool SpaceAfter)
static void outputSpaceIfNecessary(OutputBuffer &OB)
CallingConv Namespace - This namespace contains an enum with a value for the well-known calling conve...
Definition CallingConv.h:21
@ Swift
Calling convention for Swift.
Definition CallingConv.h:69
This is an optimization pass for GlobalISel generic memory operations.
#define N
void outputPost(OutputBuffer &OB, OutputFlags Flags) const override
void outputOneDimension(OutputBuffer &OB, OutputFlags Flags, Node *N) const
void outputPre(OutputBuffer &OB, OutputFlags Flags) const override
void outputDimensionsImpl(OutputBuffer &OB, OutputFlags Flags) const
void output(OutputBuffer &OB, OutputFlags Flags) const override
void outputPost(OutputBuffer &OB, OutputFlags Flags) const override
void outputPre(OutputBuffer &OB, OutputFlags Flags) const override
void output(OutputBuffer &OB, OutputFlags Flags) const override
void output(OutputBuffer &OB, OutputFlags Flags) const override
void outputPre(OutputBuffer &OB, OutputFlags Flags) const override
void outputPreSignature(OutputBuffer &OB, OutputFlags Flags) const
void outputPost(OutputBuffer &OB, OutputFlags Flags) const override
void output(OutputBuffer &OB, OutputFlags Flags) const override
DEMANGLE_ABI void outputTemplateParameters(OutputBuffer &OB, OutputFlags Flags) const
void output(OutputBuffer &OB, OutputFlags Flags) const override
void output(OutputBuffer &OB, OutputFlags Flags) const override
void output(OutputBuffer &OB, OutputFlags Flags) const override
void output(OutputBuffer &OB, OutputFlags Flags) const override
void output(OutputBuffer &OB, OutputFlags Flags) const override
void output(OutputBuffer &OB, OutputFlags Flags) const override
void output(OutputBuffer &OB, OutputFlags Flags) const override
virtual void output(OutputBuffer &OB, OutputFlags Flags) const =0
DEMANGLE_ABI std::string toString(OutputFlags Flags=OF_Default) const
void output(OutputBuffer &OB, OutputFlags Flags) const override
void outputPost(OutputBuffer &OB, OutputFlags Flags) const override
PointerAuthQualifierNode * PointerAuthQualifier
void outputPre(OutputBuffer &OB, OutputFlags Flags) const override
void outputPre(OutputBuffer &OB, OutputFlags Flags) const override
void output(OutputBuffer &OB, OutputFlags Flags) const override
void output(OutputBuffer &OB, OutputFlags Flags) const override
void output(OutputBuffer &OB, OutputFlags Flags) const override
void output(OutputBuffer &OB, OutputFlags Flags) const override
void output(OutputBuffer &OB, OutputFlags Flags) const override
void outputPost(OutputBuffer &OB, OutputFlags Flags) const override
void outputPre(OutputBuffer &OB, OutputFlags Flags) const override
void output(OutputBuffer &OB, OutputFlags Flags) const override
void outputPost(OutputBuffer &OB, OutputFlags Flags) const override
void outputPre(OutputBuffer &OB, OutputFlags Flags) const override
void output(OutputBuffer &OB, OutputFlags Flags) const override
virtual bool shouldOutputName(OutputFlags Flags) const
void output(OutputBuffer &OB, OutputFlags Flags) const override