1 //===- CodegenNameGenerator.cpp - Codegen name generation -----------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // Determines the name that the symbol will get for code generation.
12 //===----------------------------------------------------------------------===//
14 #include "clang/Index/CodegenNameGenerator.h"
15 #include "clang/AST/ASTContext.h"
16 #include "clang/AST/DeclCXX.h"
17 #include "clang/AST/DeclObjC.h"
18 #include "clang/AST/Mangle.h"
19 #include "clang/AST/VTableBuilder.h"
20 #include "clang/Basic/TargetInfo.h"
21 #include "llvm/IR/DataLayout.h"
22 #include "llvm/IR/Mangler.h"
23 #include "llvm/Support/raw_ostream.h"
25 using namespace clang;
26 using namespace clang::index;
28 struct CodegenNameGenerator::Implementation {
29 std::unique_ptr<MangleContext> MC;
32 Implementation(ASTContext &Ctx)
33 : MC(Ctx.createMangleContext()),
34 DL(Ctx.getTargetInfo().getDataLayout()) {}
36 bool writeName(const Decl *D, raw_ostream &OS) {
37 // First apply frontend mangling.
38 SmallString<128> FrontendBuf;
39 llvm::raw_svector_ostream FrontendBufOS(FrontendBuf);
40 if (auto *FD = dyn_cast<FunctionDecl>(D)) {
41 if (FD->isDependentContext())
43 if (writeFuncOrVarName(FD, FrontendBufOS))
45 } else if (auto *VD = dyn_cast<VarDecl>(D)) {
46 if (writeFuncOrVarName(VD, FrontendBufOS))
48 } else if (auto *MD = dyn_cast<ObjCMethodDecl>(D)) {
49 MC->mangleObjCMethodNameWithoutSize(MD, OS);
51 } else if (auto *ID = dyn_cast<ObjCInterfaceDecl>(D)) {
52 writeObjCClassName(ID, FrontendBufOS);
57 // Now apply backend mangling.
58 llvm::Mangler::getNameWithPrefix(OS, FrontendBufOS.str(), DL);
62 std::string getName(const Decl *D) {
65 llvm::raw_string_ostream OS(Name);
71 std::vector<std::string> getAllManglings(const Decl *D) {
72 if (!(isa<CXXRecordDecl>(D) || isa<CXXMethodDecl>(D)))
75 const NamedDecl *ND = cast<NamedDecl>(D);
77 ASTContext &Ctx = ND->getASTContext();
78 std::unique_ptr<MangleContext> M(Ctx.createMangleContext());
80 std::vector<std::string> Manglings;
82 auto hasDefaultCXXMethodCC = [](ASTContext &C, const CXXMethodDecl *MD) {
83 auto DefaultCC = C.getDefaultCallingConvention(/*IsVariadic=*/false,
84 /*IsCSSMethod=*/true);
85 auto CC = MD->getType()->getAs<FunctionProtoType>()->getCallConv();
86 return CC == DefaultCC;
89 if (const auto *CD = dyn_cast_or_null<CXXConstructorDecl>(ND)) {
90 Manglings.emplace_back(getMangledStructor(CD, Ctor_Base));
92 if (Ctx.getTargetInfo().getCXXABI().isItaniumFamily())
93 if (!CD->getParent()->isAbstract())
94 Manglings.emplace_back(getMangledStructor(CD, Ctor_Complete));
96 if (Ctx.getTargetInfo().getCXXABI().isMicrosoft())
97 if (CD->hasAttr<DLLExportAttr>() && CD->isDefaultConstructor())
98 if (!(hasDefaultCXXMethodCC(Ctx, CD) && CD->getNumParams() == 0))
99 Manglings.emplace_back(getMangledStructor(CD, Ctor_DefaultClosure));
100 } else if (const auto *DD = dyn_cast_or_null<CXXDestructorDecl>(ND)) {
101 Manglings.emplace_back(getMangledStructor(DD, Dtor_Base));
102 if (Ctx.getTargetInfo().getCXXABI().isItaniumFamily()) {
103 Manglings.emplace_back(getMangledStructor(DD, Dtor_Complete));
105 Manglings.emplace_back(getMangledStructor(DD, Dtor_Deleting));
107 } else if (const auto *MD = dyn_cast_or_null<CXXMethodDecl>(ND)) {
108 Manglings.emplace_back(getName(ND));
110 if (const auto *TIV = Ctx.getVTableContext()->getThunkInfo(MD))
111 for (const auto &T : *TIV)
112 Manglings.emplace_back(getMangledThunk(MD, T));
119 bool writeFuncOrVarName(const NamedDecl *D, raw_ostream &OS) {
120 if (MC->shouldMangleDeclName(D)) {
121 if (const auto *CtorD = dyn_cast<CXXConstructorDecl>(D))
122 MC->mangleCXXCtor(CtorD, Ctor_Complete, OS);
123 else if (const auto *DtorD = dyn_cast<CXXDestructorDecl>(D))
124 MC->mangleCXXDtor(DtorD, Dtor_Complete, OS);
126 MC->mangleName(D, OS);
129 IdentifierInfo *II = D->getIdentifier();
137 void writeObjCClassName(const ObjCInterfaceDecl *D, raw_ostream &OS) {
138 OS << getClassSymbolPrefix();
139 OS << D->getObjCRuntimeNameAsString();
142 static StringRef getClassSymbolPrefix() {
143 return "OBJC_CLASS_$_";
146 std::string getMangledStructor(const NamedDecl *ND, unsigned StructorType) {
147 std::string FrontendBuf;
148 llvm::raw_string_ostream FOS(FrontendBuf);
150 if (const auto *CD = dyn_cast_or_null<CXXConstructorDecl>(ND))
151 MC->mangleCXXCtor(CD, static_cast<CXXCtorType>(StructorType), FOS);
152 else if (const auto *DD = dyn_cast_or_null<CXXDestructorDecl>(ND))
153 MC->mangleCXXDtor(DD, static_cast<CXXDtorType>(StructorType), FOS);
155 std::string BackendBuf;
156 llvm::raw_string_ostream BOS(BackendBuf);
158 llvm::Mangler::getNameWithPrefix(BOS, FOS.str(), DL);
163 std::string getMangledThunk(const CXXMethodDecl *MD, const ThunkInfo &T) {
164 std::string FrontendBuf;
165 llvm::raw_string_ostream FOS(FrontendBuf);
167 MC->mangleThunk(MD, T, FOS);
169 std::string BackendBuf;
170 llvm::raw_string_ostream BOS(BackendBuf);
172 llvm::Mangler::getNameWithPrefix(BOS, FOS.str(), DL);
178 CodegenNameGenerator::CodegenNameGenerator(ASTContext &Ctx)
179 : Impl(new Implementation(Ctx)) {
182 CodegenNameGenerator::~CodegenNameGenerator() {
185 bool CodegenNameGenerator::writeName(const Decl *D, raw_ostream &OS) {
186 return Impl->writeName(D, OS);
189 std::string CodegenNameGenerator::getName(const Decl *D) {
190 return Impl->getName(D);
193 std::vector<std::string> CodegenNameGenerator::getAllManglings(const Decl *D) {
194 return Impl->getAllManglings(D);