annotate clang/lib/CodeGen/CGVTables.h @ 150:1d019706d866

LLVM10
author anatofuz
date Thu, 13 Feb 2020 15:10:13 +0900
parents
children 2e18cbf3894f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
150
anatofuz
parents:
diff changeset
1 //===--- CGVTables.h - Emit LLVM Code for C++ vtables -----------*- C++ -*-===//
anatofuz
parents:
diff changeset
2 //
anatofuz
parents:
diff changeset
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
anatofuz
parents:
diff changeset
4 // See https://llvm.org/LICENSE.txt for license information.
anatofuz
parents:
diff changeset
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
anatofuz
parents:
diff changeset
6 //
anatofuz
parents:
diff changeset
7 //===----------------------------------------------------------------------===//
anatofuz
parents:
diff changeset
8 //
anatofuz
parents:
diff changeset
9 // This contains code dealing with C++ code generation of virtual tables.
anatofuz
parents:
diff changeset
10 //
anatofuz
parents:
diff changeset
11 //===----------------------------------------------------------------------===//
anatofuz
parents:
diff changeset
12
anatofuz
parents:
diff changeset
13 #ifndef LLVM_CLANG_LIB_CODEGEN_CGVTABLES_H
anatofuz
parents:
diff changeset
14 #define LLVM_CLANG_LIB_CODEGEN_CGVTABLES_H
anatofuz
parents:
diff changeset
15
anatofuz
parents:
diff changeset
16 #include "clang/AST/BaseSubobject.h"
anatofuz
parents:
diff changeset
17 #include "clang/AST/CharUnits.h"
anatofuz
parents:
diff changeset
18 #include "clang/AST/GlobalDecl.h"
anatofuz
parents:
diff changeset
19 #include "clang/AST/VTableBuilder.h"
anatofuz
parents:
diff changeset
20 #include "clang/Basic/ABI.h"
anatofuz
parents:
diff changeset
21 #include "llvm/ADT/DenseMap.h"
anatofuz
parents:
diff changeset
22 #include "llvm/IR/GlobalVariable.h"
anatofuz
parents:
diff changeset
23
anatofuz
parents:
diff changeset
24 namespace clang {
anatofuz
parents:
diff changeset
25 class CXXRecordDecl;
anatofuz
parents:
diff changeset
26
anatofuz
parents:
diff changeset
27 namespace CodeGen {
anatofuz
parents:
diff changeset
28 class CodeGenModule;
anatofuz
parents:
diff changeset
29 class ConstantArrayBuilder;
anatofuz
parents:
diff changeset
30 class ConstantStructBuilder;
anatofuz
parents:
diff changeset
31
anatofuz
parents:
diff changeset
32 class CodeGenVTables {
anatofuz
parents:
diff changeset
33 CodeGenModule &CGM;
anatofuz
parents:
diff changeset
34
anatofuz
parents:
diff changeset
35 VTableContextBase *VTContext;
anatofuz
parents:
diff changeset
36
anatofuz
parents:
diff changeset
37 /// VTableAddressPointsMapTy - Address points for a single vtable.
anatofuz
parents:
diff changeset
38 typedef VTableLayout::AddressPointsMapTy VTableAddressPointsMapTy;
anatofuz
parents:
diff changeset
39
anatofuz
parents:
diff changeset
40 typedef std::pair<const CXXRecordDecl *, BaseSubobject> BaseSubobjectPairTy;
anatofuz
parents:
diff changeset
41 typedef llvm::DenseMap<BaseSubobjectPairTy, uint64_t> SubVTTIndiciesMapTy;
anatofuz
parents:
diff changeset
42
anatofuz
parents:
diff changeset
43 /// SubVTTIndicies - Contains indices into the various sub-VTTs.
anatofuz
parents:
diff changeset
44 SubVTTIndiciesMapTy SubVTTIndicies;
anatofuz
parents:
diff changeset
45
anatofuz
parents:
diff changeset
46 typedef llvm::DenseMap<BaseSubobjectPairTy, uint64_t>
anatofuz
parents:
diff changeset
47 SecondaryVirtualPointerIndicesMapTy;
anatofuz
parents:
diff changeset
48
anatofuz
parents:
diff changeset
49 /// SecondaryVirtualPointerIndices - Contains the secondary virtual pointer
anatofuz
parents:
diff changeset
50 /// indices.
anatofuz
parents:
diff changeset
51 SecondaryVirtualPointerIndicesMapTy SecondaryVirtualPointerIndices;
anatofuz
parents:
diff changeset
52
anatofuz
parents:
diff changeset
53 /// Cache for the pure virtual member call function.
anatofuz
parents:
diff changeset
54 llvm::Constant *PureVirtualFn = nullptr;
anatofuz
parents:
diff changeset
55
anatofuz
parents:
diff changeset
56 /// Cache for the deleted virtual member call function.
anatofuz
parents:
diff changeset
57 llvm::Constant *DeletedVirtualFn = nullptr;
anatofuz
parents:
diff changeset
58
anatofuz
parents:
diff changeset
59 /// Get the address of a thunk and emit it if necessary.
anatofuz
parents:
diff changeset
60 llvm::Constant *maybeEmitThunk(GlobalDecl GD,
anatofuz
parents:
diff changeset
61 const ThunkInfo &ThunkAdjustments,
anatofuz
parents:
diff changeset
62 bool ForVTable);
anatofuz
parents:
diff changeset
63
anatofuz
parents:
diff changeset
64 void addVTableComponent(ConstantArrayBuilder &builder,
anatofuz
parents:
diff changeset
65 const VTableLayout &layout, unsigned idx,
anatofuz
parents:
diff changeset
66 llvm::Constant *rtti,
anatofuz
parents:
diff changeset
67 unsigned &nextVTableThunkIndex);
anatofuz
parents:
diff changeset
68
anatofuz
parents:
diff changeset
69 public:
anatofuz
parents:
diff changeset
70 /// Add vtable components for the given vtable layout to the given
anatofuz
parents:
diff changeset
71 /// global initializer.
anatofuz
parents:
diff changeset
72 void createVTableInitializer(ConstantStructBuilder &builder,
anatofuz
parents:
diff changeset
73 const VTableLayout &layout,
anatofuz
parents:
diff changeset
74 llvm::Constant *rtti);
anatofuz
parents:
diff changeset
75
anatofuz
parents:
diff changeset
76 CodeGenVTables(CodeGenModule &CGM);
anatofuz
parents:
diff changeset
77
anatofuz
parents:
diff changeset
78 ItaniumVTableContext &getItaniumVTableContext() {
anatofuz
parents:
diff changeset
79 return *cast<ItaniumVTableContext>(VTContext);
anatofuz
parents:
diff changeset
80 }
anatofuz
parents:
diff changeset
81
anatofuz
parents:
diff changeset
82 MicrosoftVTableContext &getMicrosoftVTableContext() {
anatofuz
parents:
diff changeset
83 return *cast<MicrosoftVTableContext>(VTContext);
anatofuz
parents:
diff changeset
84 }
anatofuz
parents:
diff changeset
85
anatofuz
parents:
diff changeset
86 /// getSubVTTIndex - Return the index of the sub-VTT for the base class of the
anatofuz
parents:
diff changeset
87 /// given record decl.
anatofuz
parents:
diff changeset
88 uint64_t getSubVTTIndex(const CXXRecordDecl *RD, BaseSubobject Base);
anatofuz
parents:
diff changeset
89
anatofuz
parents:
diff changeset
90 /// getSecondaryVirtualPointerIndex - Return the index in the VTT where the
anatofuz
parents:
diff changeset
91 /// virtual pointer for the given subobject is located.
anatofuz
parents:
diff changeset
92 uint64_t getSecondaryVirtualPointerIndex(const CXXRecordDecl *RD,
anatofuz
parents:
diff changeset
93 BaseSubobject Base);
anatofuz
parents:
diff changeset
94
anatofuz
parents:
diff changeset
95 /// GenerateConstructionVTable - Generate a construction vtable for the given
anatofuz
parents:
diff changeset
96 /// base subobject.
anatofuz
parents:
diff changeset
97 llvm::GlobalVariable *
anatofuz
parents:
diff changeset
98 GenerateConstructionVTable(const CXXRecordDecl *RD, const BaseSubobject &Base,
anatofuz
parents:
diff changeset
99 bool BaseIsVirtual,
anatofuz
parents:
diff changeset
100 llvm::GlobalVariable::LinkageTypes Linkage,
anatofuz
parents:
diff changeset
101 VTableAddressPointsMapTy& AddressPoints);
anatofuz
parents:
diff changeset
102
anatofuz
parents:
diff changeset
103
anatofuz
parents:
diff changeset
104 /// GetAddrOfVTT - Get the address of the VTT for the given record decl.
anatofuz
parents:
diff changeset
105 llvm::GlobalVariable *GetAddrOfVTT(const CXXRecordDecl *RD);
anatofuz
parents:
diff changeset
106
anatofuz
parents:
diff changeset
107 /// EmitVTTDefinition - Emit the definition of the given vtable.
anatofuz
parents:
diff changeset
108 void EmitVTTDefinition(llvm::GlobalVariable *VTT,
anatofuz
parents:
diff changeset
109 llvm::GlobalVariable::LinkageTypes Linkage,
anatofuz
parents:
diff changeset
110 const CXXRecordDecl *RD);
anatofuz
parents:
diff changeset
111
anatofuz
parents:
diff changeset
112 /// EmitThunks - Emit the associated thunks for the given global decl.
anatofuz
parents:
diff changeset
113 void EmitThunks(GlobalDecl GD);
anatofuz
parents:
diff changeset
114
anatofuz
parents:
diff changeset
115 /// GenerateClassData - Generate all the class data required to be
anatofuz
parents:
diff changeset
116 /// generated upon definition of a KeyFunction. This includes the
anatofuz
parents:
diff changeset
117 /// vtable, the RTTI data structure (if RTTI is enabled) and the VTT
anatofuz
parents:
diff changeset
118 /// (if the class has virtual bases).
anatofuz
parents:
diff changeset
119 void GenerateClassData(const CXXRecordDecl *RD);
anatofuz
parents:
diff changeset
120
anatofuz
parents:
diff changeset
121 bool isVTableExternal(const CXXRecordDecl *RD);
anatofuz
parents:
diff changeset
122
anatofuz
parents:
diff changeset
123 /// Returns the type of a vtable with the given layout. Normally a struct of
anatofuz
parents:
diff changeset
124 /// arrays of pointers, with one struct element for each vtable in the vtable
anatofuz
parents:
diff changeset
125 /// group.
anatofuz
parents:
diff changeset
126 llvm::Type *getVTableType(const VTableLayout &layout);
anatofuz
parents:
diff changeset
127 };
anatofuz
parents:
diff changeset
128
anatofuz
parents:
diff changeset
129 } // end namespace CodeGen
anatofuz
parents:
diff changeset
130 } // end namespace clang
anatofuz
parents:
diff changeset
131 #endif