GCC Code Coverage Report


Directory: ../
File: src/irgenerator/GenVTable.cpp
Date: 2025-02-05 01:09:36
Exec Total Coverage
Lines: 92 92 100.0%
Functions: 4 4 100.0%
Branches: 90 166 54.2%

Line Branch Exec Source
1 // Copyright (c) 2021-2025 ChilliBits. All rights reserved.
2
3 #include "IRGenerator.h"
4
5 #include <llvm/IR/Module.h>
6
7 #include <SourceFile.h>
8 #include <irgenerator/NameMangling.h>
9
10 namespace spice::compiler {
11
12 275 llvm::Constant *IRGenerator::generateTypeInfoName(StructBase *spiceStruct) const {
13 // Resolve mangled type info name and mangled global name
14
1/2
✓ Branch 0 (2→3) taken 275 times.
✗ Branch 1 (2→29) not taken.
275 const std::string globalName = NameMangling::mangleTypeInfoName(spiceStruct);
15
16 // Generate global string constant
17
3/6
✓ Branch 0 (3→4) taken 275 times.
✗ Branch 1 (3→24) not taken.
✓ Branch 2 (4→5) taken 275 times.
✗ Branch 3 (4→22) not taken.
✓ Branch 4 (6→7) taken 275 times.
✗ Branch 5 (6→20) not taken.
275 builder.CreateGlobalString(NameMangling::mangleTypeInfoValue(spiceStruct->name), globalName, 0, module);
18
1/2
✓ Branch 0 (9→10) taken 275 times.
✗ Branch 1 (9→25) not taken.
275 llvm::GlobalVariable *global = module->getNamedGlobal(globalName);
19
20 // Set global attributes
21 275 global->setConstant(true);
22 275 global->setDSOLocal(true);
23 275 global->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::None);
24
1/2
✓ Branch 0 (13→14) taken 275 times.
✗ Branch 1 (13→27) not taken.
275 global->setLinkage(llvm::GlobalValue::ExternalLinkage);
25
2/4
✓ Branch 0 (15→16) taken 275 times.
✗ Branch 1 (15→26) not taken.
✓ Branch 2 (16→17) taken 275 times.
✗ Branch 3 (16→26) not taken.
275 global->setComdat(module->getOrInsertComdat(globalName));
26
27 275 return spiceStruct->vTableData.typeInfoName = global;
28 275 }
29
30 275 llvm::Constant *IRGenerator::generateTypeInfo(StructBase *spiceStruct) const {
31 // Generate type info name
32
1/2
✓ Branch 0 (2→3) taken 275 times.
✗ Branch 1 (2→116) not taken.
275 llvm::Constant *typeInfoName = generateTypeInfoName(spiceStruct);
33
34 // Generate LLVM type for type info
35
1/2
✓ Branch 0 (3→4) taken 275 times.
✗ Branch 1 (3→116) not taken.
275 const std::string mangledName = NameMangling::mangleTypeInfo(spiceStruct);
36
1/2
✓ Branch 0 (4→5) taken 275 times.
✗ Branch 1 (4→114) not taken.
275 llvm::PointerType *ptrTy = builder.getPtrTy();
37
38 275 QualTypeList interfaceTypes;
39
4/6
✓ Branch 0 (5→6) taken 275 times.
✗ Branch 1 (5→112) not taken.
✓ Branch 2 (6→7) taken 275 times.
✗ Branch 3 (6→112) not taken.
✓ Branch 4 (7→8) taken 155 times.
✓ Branch 5 (7→9) taken 120 times.
275 if (spiceStruct->entry->getQualType().is(TY_STRUCT)) {
40 155 const auto spiceStructEnsured = reinterpret_cast<Struct *>(spiceStruct);
41
1/2
✓ Branch 0 (8→9) taken 155 times.
✗ Branch 1 (8→112) not taken.
155 interfaceTypes = spiceStructEnsured->interfaceTypes;
42 }
43
44 // Build type info LLVM type
45
1/2
✓ Branch 0 (11→12) taken 275 times.
✗ Branch 1 (11→82) not taken.
550 std::vector<llvm::Type *> typeInfoFieldTypes = {ptrTy, ptrTy};
46
2/2
✓ Branch 0 (17→14) taken 117 times.
✓ Branch 1 (17→18) taken 275 times.
392 for (size_t i = 0; i < interfaceTypes.size(); i++)
47
1/2
✓ Branch 0 (14→15) taken 117 times.
✗ Branch 1 (14→86) not taken.
117 typeInfoFieldTypes.push_back(ptrTy);
48
1/2
✓ Branch 0 (19→20) taken 275 times.
✗ Branch 1 (19→87) not taken.
275 spiceStruct->vTableData.typeInfoType = llvm::StructType::get(context, typeInfoFieldTypes);
49
50 // Generate type info values
51
1/2
✓ Branch 0 (20→21) taken 275 times.
✗ Branch 1 (20→110) not taken.
275 llvm::Constant *typeInfoVTable = llvm::Constant::getNullValue(ptrTy);
52
3/4
✓ Branch 0 (21→22) taken 275 times.
✗ Branch 1 (21→110) not taken.
✓ Branch 2 (24→25) taken 237 times.
✓ Branch 3 (24→41) taken 38 times.
550 if (!sourceFile->isRttiRT()) {
53 // Add external global pointer for TypeInfo vtable
54
2/4
✓ Branch 0 (25→26) taken 237 times.
✗ Branch 1 (25→97) not taken.
✗ Branch 2 (26→27) not taken.
✓ Branch 3 (26→28) taken 237 times.
237 assert(sourceFile->isRuntimeModuleAvailable(RuntimeModule::RTTI_RT));
55
2/4
✓ Branch 0 (30→31) taken 237 times.
✗ Branch 1 (30→90) not taken.
✓ Branch 2 (31→32) taken 237 times.
✗ Branch 3 (31→88) not taken.
237 const std::string typeInfoMangledName = NameMangling::mangleVTable("TypeInfo");
56
2/4
✓ Branch 0 (34→35) taken 237 times.
✗ Branch 1 (34→95) not taken.
✓ Branch 2 (36→37) taken 237 times.
✗ Branch 3 (36→94) not taken.
237 llvm::Constant *typeInfoExtPtr = module->getOrInsertGlobal(typeInfoMangledName, builder.getPtrTy());
57
2/4
✓ Branch 0 (37→38) taken 237 times.
✗ Branch 1 (37→95) not taken.
✓ Branch 2 (38→39) taken 237 times.
✗ Branch 3 (38→95) not taken.
237 typeInfoVTable = llvm::ConstantExpr::getInBoundsGetElementPtr(ptrTy, typeInfoExtPtr, builder.getInt64(2));
58 237 }
59 275 std::vector<llvm::Constant *> fieldValues;
60
1/2
✓ Branch 0 (41→42) taken 275 times.
✗ Branch 1 (41→108) not taken.
275 fieldValues.push_back(typeInfoVTable);
61
1/2
✓ Branch 0 (42→43) taken 275 times.
✗ Branch 1 (42→108) not taken.
275 fieldValues.push_back(typeInfoName);
62
2/2
✓ Branch 0 (59→45) taken 117 times.
✓ Branch 1 (59→60) taken 275 times.
392 for (const QualType &interfaceType : interfaceTypes) {
63
1/2
✓ Branch 0 (46→47) taken 117 times.
✗ Branch 1 (46→101) not taken.
117 const Interface *interface = interfaceType.getInterface(nullptr);
64
2/4
✓ Branch 0 (47→48) taken 117 times.
✗ Branch 1 (47→50) not taken.
✓ Branch 2 (48→49) taken 117 times.
✗ Branch 3 (48→50) not taken.
117 assert(interface != nullptr && interface->vTableData.typeInfo != nullptr);
65
1/2
✓ Branch 0 (51→52) taken 117 times.
✗ Branch 1 (51→101) not taken.
117 const std::string interfaceMangledName = NameMangling::mangleTypeInfo(interface);
66
2/4
✓ Branch 0 (52→53) taken 117 times.
✗ Branch 1 (52→99) not taken.
✓ Branch 2 (54→55) taken 117 times.
✗ Branch 3 (54→98) not taken.
117 llvm::Constant *global = module->getOrInsertGlobal(interfaceMangledName, builder.getPtrTy());
67
1/2
✓ Branch 0 (55→56) taken 117 times.
✗ Branch 1 (55→99) not taken.
117 fieldValues.push_back(global);
68 117 }
69
1/2
✓ Branch 0 (61→62) taken 275 times.
✗ Branch 1 (61→103) not taken.
275 llvm::Constant *typeInfo = llvm::ConstantStruct::get(spiceStruct->vTableData.typeInfoType, fieldValues);
70
71 // Generate global variable
72
1/2
✓ Branch 0 (63→64) taken 275 times.
✗ Branch 1 (63→104) not taken.
275 module->getOrInsertGlobal(mangledName, spiceStruct->vTableData.typeInfoType);
73
1/2
✓ Branch 0 (65→66) taken 275 times.
✗ Branch 1 (65→105) not taken.
275 llvm::GlobalVariable *global = module->getNamedGlobal(mangledName);
74
1/2
✓ Branch 0 (66→67) taken 275 times.
✗ Branch 1 (66→108) not taken.
275 global->setInitializer(typeInfo);
75
76 // Set global attributes
77 275 global->setConstant(true);
78 275 global->setDSOLocal(true);
79 275 global->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::None);
80
1/2
✓ Branch 0 (70→71) taken 275 times.
✗ Branch 1 (70→108) not taken.
275 global->setLinkage(llvm::GlobalValue::ExternalLinkage);
81
2/4
✓ Branch 0 (72→73) taken 275 times.
✗ Branch 1 (72→106) not taken.
✓ Branch 2 (73→74) taken 275 times.
✗ Branch 3 (73→106) not taken.
275 global->setComdat(module->getOrInsertComdat(mangledName));
82
2/4
✓ Branch 0 (74→75) taken 275 times.
✗ Branch 1 (74→107) not taken.
✓ Branch 2 (75→76) taken 275 times.
✗ Branch 3 (75→107) not taken.
275 global->setAlignment(llvm::MaybeAlign(8));
83
84 275 return spiceStruct->vTableData.typeInfo = global;
85 275 }
86
87 275 llvm::Constant *IRGenerator::generateVTable(StructBase *spiceStruct) const {
88 // Retrieve virtual method count
89
1/2
✓ Branch 0 (2→3) taken 275 times.
✗ Branch 1 (2→37) not taken.
275 const std::vector<Function *> virtualMethods = spiceStruct->scope->getVirtualMethods();
90 275 const size_t virtualMethodCount = virtualMethods.size();
91 275 const size_t arrayElementCount = virtualMethodCount + 2; // +2 for nullptr and TypeInfo
92
93 // Generate type info data structures
94
1/2
✓ Branch 0 (4→5) taken 275 times.
✗ Branch 1 (4→35) not taken.
275 generateTypeInfo(spiceStruct);
95
96 // Generate VTable type
97
2/4
✓ Branch 0 (5→6) taken 275 times.
✗ Branch 1 (5→35) not taken.
✓ Branch 2 (6→7) taken 275 times.
✗ Branch 3 (6→35) not taken.
275 llvm::ArrayType *vtableArrayTy = llvm::ArrayType::get(builder.getPtrTy(), arrayElementCount);
98
1/2
✓ Branch 0 (8→9) taken 275 times.
✗ Branch 1 (8→27) not taken.
275 spiceStruct->vTableData.vtableType = llvm::StructType::get(context, vtableArrayTy, false);
99
100
1/2
✓ Branch 0 (9→10) taken 275 times.
✗ Branch 1 (9→35) not taken.
275 const std::string mangledName = NameMangling::mangleVTable(spiceStruct);
101
1/2
✓ Branch 0 (11→12) taken 275 times.
✗ Branch 1 (11→29) not taken.
275 module->getOrInsertGlobal(mangledName, spiceStruct->vTableData.vtableType);
102
1/2
✓ Branch 0 (13→14) taken 275 times.
✗ Branch 1 (13→30) not taken.
275 llvm::GlobalVariable *global = module->getNamedGlobal(mangledName);
103
104 // Set global attributes
105 275 global->setConstant(true);
106 275 global->setDSOLocal(true);
107 275 global->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
108
1/2
✓ Branch 0 (17→18) taken 275 times.
✗ Branch 1 (17→33) not taken.
275 global->setLinkage(llvm::GlobalValue::ExternalLinkage);
109
2/4
✓ Branch 0 (19→20) taken 275 times.
✗ Branch 1 (19→31) not taken.
✓ Branch 2 (20→21) taken 275 times.
✗ Branch 3 (20→31) not taken.
275 global->setComdat(module->getOrInsertComdat(mangledName));
110
2/4
✓ Branch 0 (21→22) taken 275 times.
✗ Branch 1 (21→32) not taken.
✓ Branch 2 (22→23) taken 275 times.
✗ Branch 3 (22→32) not taken.
275 global->setAlignment(llvm::MaybeAlign(8));
111
112 275 return spiceStruct->vTableData.vtable = global;
113 275 }
114
115 275 void IRGenerator::generateVTableInitializer(const StructBase *spiceStruct) const {
116 // Retrieve virtual method count
117
1/2
✗ Branch 0 (2→3) not taken.
✓ Branch 1 (2→4) taken 275 times.
275 assert(spiceStruct->scope);
118
1/2
✓ Branch 0 (4→5) taken 275 times.
✗ Branch 1 (4→58) not taken.
275 const std::vector<Function *> virtualMethods = spiceStruct->scope->getVirtualMethods();
119 275 const size_t virtualMethodCount = virtualMethods.size();
120 275 const size_t arrayElementCount = virtualMethodCount + 2; // +2 for nullptr and TypeInfo
121
122 // Generate VTable type
123
1/2
✓ Branch 0 (6→7) taken 275 times.
✗ Branch 1 (6→56) not taken.
275 llvm::PointerType *ptrTy = builder.getPtrTy();
124
1/2
✓ Branch 0 (7→8) taken 275 times.
✗ Branch 1 (7→56) not taken.
275 llvm::ArrayType *vtableArrayTy = llvm::ArrayType::get(ptrTy, arrayElementCount);
125
1/2
✗ Branch 0 (8→9) not taken.
✓ Branch 1 (8→10) taken 275 times.
275 assert(spiceStruct->vTableData.vtableType);
126
127 // Generate VTable values
128 275 std::vector<llvm::Constant *> arrayValues;
129
2/4
✓ Branch 0 (10→11) taken 275 times.
✗ Branch 1 (10→43) not taken.
✓ Branch 2 (11→12) taken 275 times.
✗ Branch 3 (11→43) not taken.
275 arrayValues.push_back(llvm::Constant::getNullValue(ptrTy)); // nullptr as safety guard
130
1/2
✓ Branch 0 (12→13) taken 275 times.
✗ Branch 1 (12→54) not taken.
275 arrayValues.push_back(spiceStruct->vTableData.typeInfo); // TypeInfo to identify the type for the VTable
131
2/2
✓ Branch 0 (26→15) taken 610 times.
✓ Branch 1 (26→27) taken 275 times.
885 for (Function *virtualMethod : virtualMethods) {
132
3/4
✓ Branch 0 (16→17) taken 301 times.
✓ Branch 1 (16→19) taken 309 times.
✗ Branch 2 (17→18) not taken.
✓ Branch 3 (17→19) taken 301 times.
610 assert(spiceStruct->scope->type == ScopeType::INTERFACE || virtualMethod->llvmFunction != nullptr);
133
4/6
✓ Branch 0 (19→20) taken 301 times.
✓ Branch 1 (19→21) taken 309 times.
✓ Branch 2 (21→22) taken 309 times.
✗ Branch 3 (21→44) not taken.
✓ Branch 4 (23→24) taken 610 times.
✗ Branch 5 (23→44) not taken.
610 arrayValues.push_back(virtualMethod->llvmFunction ? virtualMethod->llvmFunction : llvm::Constant::getNullValue(ptrTy));
134 }
135
136 // Generate VTable struct
137 275 std::vector<llvm::Constant *> fieldValues;
138
2/4
✓ Branch 0 (28→29) taken 275 times.
✗ Branch 1 (28→46) not taken.
✓ Branch 2 (29→30) taken 275 times.
✗ Branch 3 (29→46) not taken.
275 fieldValues.push_back(llvm::ConstantArray::get(vtableArrayTy, arrayValues));
139
1/2
✓ Branch 0 (31→32) taken 275 times.
✗ Branch 1 (31→48) not taken.
275 llvm::Constant *initializer = llvm::ConstantStruct::get(spiceStruct->vTableData.vtableType, fieldValues);
140
141
1/2
✓ Branch 0 (32→33) taken 275 times.
✗ Branch 1 (32→52) not taken.
275 const std::string mangledName = NameMangling::mangleVTable(spiceStruct);
142
1/2
✓ Branch 0 (34→35) taken 275 times.
✗ Branch 1 (34→49) not taken.
275 llvm::GlobalVariable *global = module->getNamedGlobal(mangledName);
143
1/2
✗ Branch 0 (35→36) not taken.
✓ Branch 1 (35→37) taken 275 times.
275 assert(global != nullptr);
144
1/2
✓ Branch 0 (37→38) taken 275 times.
✗ Branch 1 (37→50) not taken.
275 global->setInitializer(initializer);
145 275 }
146
147 } // namespace spice::compiler
148