annotate compiler-rt/include/profile/InstrProfData.inc @ 192:d7606dcf6fce

Added tag llvm10 for changeset 0572611fdcc8
author Shinji KONO <kono@ie.u-ryukyu.ac.jp>
date Mon, 14 Dec 2020 18:01:34 +0900
parents 0572611fdcc8
children 2e18cbf3894f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
150
anatofuz
parents:
diff changeset
1 /*===-- InstrProfData.inc - instr profiling runtime structures -*- 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 is the master file that defines all the data structure, signature,
anatofuz
parents:
diff changeset
10 * constant literals that are shared across profiling runtime library,
anatofuz
parents:
diff changeset
11 * compiler (instrumentation), and host tools (reader/writer). The entities
anatofuz
parents:
diff changeset
12 * defined in this file affect the profile runtime ABI, the raw profile format,
anatofuz
parents:
diff changeset
13 * or both.
anatofuz
parents:
diff changeset
14 *
anatofuz
parents:
diff changeset
15 * The file has two identical copies. The master copy lives in LLVM and
anatofuz
parents:
diff changeset
16 * the other one sits in compiler-rt/lib/profile directory. To make changes
anatofuz
parents:
diff changeset
17 * in this file, first modify the master copy and copy it over to compiler-rt.
anatofuz
parents:
diff changeset
18 * Testing of any change in this file can start only after the two copies are
anatofuz
parents:
diff changeset
19 * synced up.
anatofuz
parents:
diff changeset
20 *
anatofuz
parents:
diff changeset
21 * The first part of the file includes macros that defines types, names, and
anatofuz
parents:
diff changeset
22 * initializers for the member fields of the core data structures. The field
anatofuz
parents:
diff changeset
23 * declarations for one structure is enabled by defining the field activation
anatofuz
parents:
diff changeset
24 * macro associated with that structure. Only one field activation record
anatofuz
parents:
diff changeset
25 * can be defined at one time and the rest definitions will be filtered out by
anatofuz
parents:
diff changeset
26 * the preprocessor.
anatofuz
parents:
diff changeset
27 *
anatofuz
parents:
diff changeset
28 * Examples of how the template is used to instantiate structure definition:
anatofuz
parents:
diff changeset
29 * 1. To declare a structure:
anatofuz
parents:
diff changeset
30 *
anatofuz
parents:
diff changeset
31 * struct ProfData {
anatofuz
parents:
diff changeset
32 * #define INSTR_PROF_DATA(Type, LLVMType, Name, Initializer) \
anatofuz
parents:
diff changeset
33 * Type Name;
anatofuz
parents:
diff changeset
34 * #include "llvm/ProfileData/InstrProfData.inc"
anatofuz
parents:
diff changeset
35 * };
anatofuz
parents:
diff changeset
36 *
anatofuz
parents:
diff changeset
37 * 2. To construct LLVM type arrays for the struct type:
anatofuz
parents:
diff changeset
38 *
anatofuz
parents:
diff changeset
39 * Type *DataTypes[] = {
anatofuz
parents:
diff changeset
40 * #define INSTR_PROF_DATA(Type, LLVMType, Name, Initializer) \
anatofuz
parents:
diff changeset
41 * LLVMType,
anatofuz
parents:
diff changeset
42 * #include "llvm/ProfileData/InstrProfData.inc"
anatofuz
parents:
diff changeset
43 * };
anatofuz
parents:
diff changeset
44 *
anatofuz
parents:
diff changeset
45 * 4. To construct constant array for the initializers:
anatofuz
parents:
diff changeset
46 * #define INSTR_PROF_DATA(Type, LLVMType, Name, Initializer) \
anatofuz
parents:
diff changeset
47 * Initializer,
anatofuz
parents:
diff changeset
48 * Constant *ConstantVals[] = {
anatofuz
parents:
diff changeset
49 * #include "llvm/ProfileData/InstrProfData.inc"
anatofuz
parents:
diff changeset
50 * };
anatofuz
parents:
diff changeset
51 *
anatofuz
parents:
diff changeset
52 *
anatofuz
parents:
diff changeset
53 * The second part of the file includes definitions all other entities that
anatofuz
parents:
diff changeset
54 * are related to runtime ABI and format. When no field activation macro is
anatofuz
parents:
diff changeset
55 * defined, this file can be included to introduce the definitions.
anatofuz
parents:
diff changeset
56 *
anatofuz
parents:
diff changeset
57 \*===----------------------------------------------------------------------===*/
anatofuz
parents:
diff changeset
58
anatofuz
parents:
diff changeset
59 /* Functions marked with INSTR_PROF_VISIBILITY must have hidden visibility in
anatofuz
parents:
diff changeset
60 * the compiler runtime. */
anatofuz
parents:
diff changeset
61 #ifndef INSTR_PROF_VISIBILITY
anatofuz
parents:
diff changeset
62 #define INSTR_PROF_VISIBILITY
anatofuz
parents:
diff changeset
63 #endif
anatofuz
parents:
diff changeset
64
anatofuz
parents:
diff changeset
65 /* INSTR_PROF_DATA start. */
anatofuz
parents:
diff changeset
66 /* Definition of member fields of the per-function control structure. */
anatofuz
parents:
diff changeset
67 #ifndef INSTR_PROF_DATA
anatofuz
parents:
diff changeset
68 #define INSTR_PROF_DATA(Type, LLVMType, Name, Initializer)
anatofuz
parents:
diff changeset
69 #else
anatofuz
parents:
diff changeset
70 #define INSTR_PROF_DATA_DEFINED
anatofuz
parents:
diff changeset
71 #endif
anatofuz
parents:
diff changeset
72 INSTR_PROF_DATA(const uint64_t, llvm::Type::getInt64Ty(Ctx), NameRef, \
anatofuz
parents:
diff changeset
73 ConstantInt::get(llvm::Type::getInt64Ty(Ctx), \
anatofuz
parents:
diff changeset
74 IndexedInstrProf::ComputeHash(getPGOFuncNameVarInitializer(Inc->getName()))))
anatofuz
parents:
diff changeset
75 INSTR_PROF_DATA(const uint64_t, llvm::Type::getInt64Ty(Ctx), FuncHash, \
anatofuz
parents:
diff changeset
76 ConstantInt::get(llvm::Type::getInt64Ty(Ctx), \
anatofuz
parents:
diff changeset
77 Inc->getHash()->getZExtValue()))
anatofuz
parents:
diff changeset
78 INSTR_PROF_DATA(const IntPtrT, llvm::Type::getInt64PtrTy(Ctx), CounterPtr, \
anatofuz
parents:
diff changeset
79 ConstantExpr::getBitCast(CounterPtr, \
anatofuz
parents:
diff changeset
80 llvm::Type::getInt64PtrTy(Ctx)))
anatofuz
parents:
diff changeset
81 /* This is used to map function pointers for the indirect call targets to
anatofuz
parents:
diff changeset
82 * function name hashes during the conversion from raw to merged profile
anatofuz
parents:
diff changeset
83 * data.
anatofuz
parents:
diff changeset
84 */
anatofuz
parents:
diff changeset
85 INSTR_PROF_DATA(const IntPtrT, llvm::Type::getInt8PtrTy(Ctx), FunctionPointer, \
anatofuz
parents:
diff changeset
86 FunctionAddr)
anatofuz
parents:
diff changeset
87 INSTR_PROF_DATA(IntPtrT, llvm::Type::getInt8PtrTy(Ctx), Values, \
anatofuz
parents:
diff changeset
88 ValuesPtrExpr)
anatofuz
parents:
diff changeset
89 INSTR_PROF_DATA(const uint32_t, llvm::Type::getInt32Ty(Ctx), NumCounters, \
anatofuz
parents:
diff changeset
90 ConstantInt::get(llvm::Type::getInt32Ty(Ctx), NumCounters))
anatofuz
parents:
diff changeset
91 INSTR_PROF_DATA(const uint16_t, Int16ArrayTy, NumValueSites[IPVK_Last+1], \
anatofuz
parents:
diff changeset
92 ConstantArray::get(Int16ArrayTy, Int16ArrayVals))
anatofuz
parents:
diff changeset
93 #undef INSTR_PROF_DATA
anatofuz
parents:
diff changeset
94 /* INSTR_PROF_DATA end. */
anatofuz
parents:
diff changeset
95
anatofuz
parents:
diff changeset
96
anatofuz
parents:
diff changeset
97 /* This is an internal data structure used by value profiler. It
anatofuz
parents:
diff changeset
98 * is defined here to allow serialization code sharing by LLVM
anatofuz
parents:
diff changeset
99 * to be used in unit test.
anatofuz
parents:
diff changeset
100 *
anatofuz
parents:
diff changeset
101 * typedef struct ValueProfNode {
anatofuz
parents:
diff changeset
102 * // InstrProfValueData VData;
anatofuz
parents:
diff changeset
103 * uint64_t Value;
anatofuz
parents:
diff changeset
104 * uint64_t Count;
anatofuz
parents:
diff changeset
105 * struct ValueProfNode *Next;
anatofuz
parents:
diff changeset
106 * } ValueProfNode;
anatofuz
parents:
diff changeset
107 */
anatofuz
parents:
diff changeset
108 /* INSTR_PROF_VALUE_NODE start. */
anatofuz
parents:
diff changeset
109 #ifndef INSTR_PROF_VALUE_NODE
anatofuz
parents:
diff changeset
110 #define INSTR_PROF_VALUE_NODE(Type, LLVMType, Name, Initializer)
anatofuz
parents:
diff changeset
111 #else
anatofuz
parents:
diff changeset
112 #define INSTR_PROF_DATA_DEFINED
anatofuz
parents:
diff changeset
113 #endif
anatofuz
parents:
diff changeset
114 INSTR_PROF_VALUE_NODE(uint64_t, llvm::Type::getInt64Ty(Ctx), Value, \
anatofuz
parents:
diff changeset
115 ConstantInt::get(llvm::Type::GetInt64Ty(Ctx), 0))
anatofuz
parents:
diff changeset
116 INSTR_PROF_VALUE_NODE(uint64_t, llvm::Type::getInt64Ty(Ctx), Count, \
anatofuz
parents:
diff changeset
117 ConstantInt::get(llvm::Type::GetInt64Ty(Ctx), 0))
anatofuz
parents:
diff changeset
118 INSTR_PROF_VALUE_NODE(PtrToNodeT, llvm::Type::getInt8PtrTy(Ctx), Next, \
anatofuz
parents:
diff changeset
119 ConstantInt::get(llvm::Type::GetInt8PtrTy(Ctx), 0))
anatofuz
parents:
diff changeset
120 #undef INSTR_PROF_VALUE_NODE
anatofuz
parents:
diff changeset
121 /* INSTR_PROF_VALUE_NODE end. */
anatofuz
parents:
diff changeset
122
anatofuz
parents:
diff changeset
123 /* INSTR_PROF_RAW_HEADER start */
anatofuz
parents:
diff changeset
124 /* Definition of member fields of the raw profile header data structure. */
anatofuz
parents:
diff changeset
125 #ifndef INSTR_PROF_RAW_HEADER
anatofuz
parents:
diff changeset
126 #define INSTR_PROF_RAW_HEADER(Type, Name, Initializer)
anatofuz
parents:
diff changeset
127 #else
anatofuz
parents:
diff changeset
128 #define INSTR_PROF_DATA_DEFINED
anatofuz
parents:
diff changeset
129 #endif
anatofuz
parents:
diff changeset
130 INSTR_PROF_RAW_HEADER(uint64_t, Magic, __llvm_profile_get_magic())
anatofuz
parents:
diff changeset
131 INSTR_PROF_RAW_HEADER(uint64_t, Version, __llvm_profile_get_version())
anatofuz
parents:
diff changeset
132 INSTR_PROF_RAW_HEADER(uint64_t, DataSize, DataSize)
anatofuz
parents:
diff changeset
133 INSTR_PROF_RAW_HEADER(uint64_t, PaddingBytesBeforeCounters, PaddingBytesBeforeCounters)
anatofuz
parents:
diff changeset
134 INSTR_PROF_RAW_HEADER(uint64_t, CountersSize, CountersSize)
anatofuz
parents:
diff changeset
135 INSTR_PROF_RAW_HEADER(uint64_t, PaddingBytesAfterCounters, PaddingBytesAfterCounters)
anatofuz
parents:
diff changeset
136 INSTR_PROF_RAW_HEADER(uint64_t, NamesSize, NamesSize)
anatofuz
parents:
diff changeset
137 INSTR_PROF_RAW_HEADER(uint64_t, CountersDelta, (uintptr_t)CountersBegin)
anatofuz
parents:
diff changeset
138 INSTR_PROF_RAW_HEADER(uint64_t, NamesDelta, (uintptr_t)NamesBegin)
anatofuz
parents:
diff changeset
139 INSTR_PROF_RAW_HEADER(uint64_t, ValueKindLast, IPVK_Last)
anatofuz
parents:
diff changeset
140 #undef INSTR_PROF_RAW_HEADER
anatofuz
parents:
diff changeset
141 /* INSTR_PROF_RAW_HEADER end */
anatofuz
parents:
diff changeset
142
anatofuz
parents:
diff changeset
143 /* VALUE_PROF_FUNC_PARAM start */
anatofuz
parents:
diff changeset
144 /* Definition of parameter types of the runtime API used to do value profiling
anatofuz
parents:
diff changeset
145 * for a given value site.
anatofuz
parents:
diff changeset
146 */
anatofuz
parents:
diff changeset
147 #ifndef VALUE_PROF_FUNC_PARAM
anatofuz
parents:
diff changeset
148 #define VALUE_PROF_FUNC_PARAM(ArgType, ArgName, ArgLLVMType)
anatofuz
parents:
diff changeset
149 #define INSTR_PROF_COMMA
anatofuz
parents:
diff changeset
150 #else
anatofuz
parents:
diff changeset
151 #define INSTR_PROF_DATA_DEFINED
anatofuz
parents:
diff changeset
152 #define INSTR_PROF_COMMA ,
anatofuz
parents:
diff changeset
153 #endif
anatofuz
parents:
diff changeset
154 VALUE_PROF_FUNC_PARAM(uint64_t, TargetValue, Type::getInt64Ty(Ctx)) \
anatofuz
parents:
diff changeset
155 INSTR_PROF_COMMA
anatofuz
parents:
diff changeset
156 VALUE_PROF_FUNC_PARAM(void *, Data, Type::getInt8PtrTy(Ctx)) INSTR_PROF_COMMA
anatofuz
parents:
diff changeset
157 #ifndef VALUE_RANGE_PROF
anatofuz
parents:
diff changeset
158 VALUE_PROF_FUNC_PARAM(uint32_t, CounterIndex, Type::getInt32Ty(Ctx))
anatofuz
parents:
diff changeset
159 #else /* VALUE_RANGE_PROF */
anatofuz
parents:
diff changeset
160 VALUE_PROF_FUNC_PARAM(uint32_t, CounterIndex, Type::getInt32Ty(Ctx)) \
anatofuz
parents:
diff changeset
161 INSTR_PROF_COMMA
anatofuz
parents:
diff changeset
162 VALUE_PROF_FUNC_PARAM(uint64_t, PreciseRangeStart, Type::getInt64Ty(Ctx)) \
anatofuz
parents:
diff changeset
163 INSTR_PROF_COMMA
anatofuz
parents:
diff changeset
164 VALUE_PROF_FUNC_PARAM(uint64_t, PreciseRangeLast, Type::getInt64Ty(Ctx)) \
anatofuz
parents:
diff changeset
165 INSTR_PROF_COMMA
anatofuz
parents:
diff changeset
166 VALUE_PROF_FUNC_PARAM(uint64_t, LargeValue, Type::getInt64Ty(Ctx))
anatofuz
parents:
diff changeset
167 #endif /*VALUE_RANGE_PROF */
anatofuz
parents:
diff changeset
168 #undef VALUE_PROF_FUNC_PARAM
anatofuz
parents:
diff changeset
169 #undef INSTR_PROF_COMMA
anatofuz
parents:
diff changeset
170 /* VALUE_PROF_FUNC_PARAM end */
anatofuz
parents:
diff changeset
171
anatofuz
parents:
diff changeset
172 /* VALUE_PROF_KIND start */
anatofuz
parents:
diff changeset
173 #ifndef VALUE_PROF_KIND
anatofuz
parents:
diff changeset
174 #define VALUE_PROF_KIND(Enumerator, Value, Descr)
anatofuz
parents:
diff changeset
175 #else
anatofuz
parents:
diff changeset
176 #define INSTR_PROF_DATA_DEFINED
anatofuz
parents:
diff changeset
177 #endif
anatofuz
parents:
diff changeset
178 /* For indirect function call value profiling, the addresses of the target
anatofuz
parents:
diff changeset
179 * functions are profiled by the instrumented code. The target addresses are
anatofuz
parents:
diff changeset
180 * written in the raw profile data and converted to target function name's MD5
anatofuz
parents:
diff changeset
181 * hash by the profile reader during deserialization. Typically, this happens
anatofuz
parents:
diff changeset
182 * when the raw profile data is read during profile merging.
anatofuz
parents:
diff changeset
183 *
anatofuz
parents:
diff changeset
184 * For this remapping the ProfData is used. ProfData contains both the function
anatofuz
parents:
diff changeset
185 * name hash and the function address.
anatofuz
parents:
diff changeset
186 */
anatofuz
parents:
diff changeset
187 VALUE_PROF_KIND(IPVK_IndirectCallTarget, 0, "indirect call target")
anatofuz
parents:
diff changeset
188 /* For memory intrinsic functions size profiling. */
anatofuz
parents:
diff changeset
189 VALUE_PROF_KIND(IPVK_MemOPSize, 1, "memory intrinsic functions size")
anatofuz
parents:
diff changeset
190 /* These two kinds must be the last to be
anatofuz
parents:
diff changeset
191 * declared. This is to make sure the string
anatofuz
parents:
diff changeset
192 * array created with the template can be
anatofuz
parents:
diff changeset
193 * indexed with the kind value.
anatofuz
parents:
diff changeset
194 */
anatofuz
parents:
diff changeset
195 VALUE_PROF_KIND(IPVK_First, IPVK_IndirectCallTarget, "first")
anatofuz
parents:
diff changeset
196 VALUE_PROF_KIND(IPVK_Last, IPVK_MemOPSize, "last")
anatofuz
parents:
diff changeset
197
anatofuz
parents:
diff changeset
198 #undef VALUE_PROF_KIND
anatofuz
parents:
diff changeset
199 /* VALUE_PROF_KIND end */
anatofuz
parents:
diff changeset
200
173
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
201 #undef COVMAP_V2_OR_V3
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
202 #ifdef COVMAP_V2
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
203 #define COVMAP_V2_OR_V3
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
204 #endif
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
205 #ifdef COVMAP_V3
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
206 #define COVMAP_V2_OR_V3
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
207 #endif
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
208
150
anatofuz
parents:
diff changeset
209 /* COVMAP_FUNC_RECORD start */
anatofuz
parents:
diff changeset
210 /* Definition of member fields of the function record structure in coverage
anatofuz
parents:
diff changeset
211 * map.
anatofuz
parents:
diff changeset
212 */
anatofuz
parents:
diff changeset
213 #ifndef COVMAP_FUNC_RECORD
anatofuz
parents:
diff changeset
214 #define COVMAP_FUNC_RECORD(Type, LLVMType, Name, Initializer)
anatofuz
parents:
diff changeset
215 #else
anatofuz
parents:
diff changeset
216 #define INSTR_PROF_DATA_DEFINED
anatofuz
parents:
diff changeset
217 #endif
anatofuz
parents:
diff changeset
218 #ifdef COVMAP_V1
anatofuz
parents:
diff changeset
219 COVMAP_FUNC_RECORD(const IntPtrT, llvm::Type::getInt8PtrTy(Ctx), \
anatofuz
parents:
diff changeset
220 NamePtr, llvm::ConstantExpr::getBitCast(NamePtr, \
anatofuz
parents:
diff changeset
221 llvm::Type::getInt8PtrTy(Ctx)))
anatofuz
parents:
diff changeset
222 COVMAP_FUNC_RECORD(const uint32_t, llvm::Type::getInt32Ty(Ctx), NameSize, \
anatofuz
parents:
diff changeset
223 llvm::ConstantInt::get(llvm::Type::getInt32Ty(Ctx), \
anatofuz
parents:
diff changeset
224 NameValue.size()))
173
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
225 #endif
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
226 #ifdef COVMAP_V2_OR_V3
150
anatofuz
parents:
diff changeset
227 COVMAP_FUNC_RECORD(const int64_t, llvm::Type::getInt64Ty(Ctx), NameRef, \
173
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
228 llvm::ConstantInt::get( \
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
229 llvm::Type::getInt64Ty(Ctx), NameHash))
150
anatofuz
parents:
diff changeset
230 #endif
anatofuz
parents:
diff changeset
231 COVMAP_FUNC_RECORD(const uint32_t, llvm::Type::getInt32Ty(Ctx), DataSize, \
173
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
232 llvm::ConstantInt::get( \
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
233 llvm::Type::getInt32Ty(Ctx), CoverageMapping.size()))
150
anatofuz
parents:
diff changeset
234 COVMAP_FUNC_RECORD(const uint64_t, llvm::Type::getInt64Ty(Ctx), FuncHash, \
173
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
235 llvm::ConstantInt::get( \
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
236 llvm::Type::getInt64Ty(Ctx), FuncHash))
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
237 #ifdef COVMAP_V3
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
238 COVMAP_FUNC_RECORD(const uint64_t, llvm::Type::getInt64Ty(Ctx), FilenamesRef, \
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
239 llvm::ConstantInt::get( \
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
240 llvm::Type::getInt64Ty(Ctx), FilenamesRef))
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
241 COVMAP_FUNC_RECORD(const char, \
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
242 llvm::ArrayType::get(llvm::Type::getInt8Ty(Ctx), \
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
243 CoverageMapping.size()), \
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
244 CoverageMapping,
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
245 llvm::ConstantDataArray::getRaw( \
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
246 CoverageMapping, CoverageMapping.size(), \
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
247 llvm::Type::getInt8Ty(Ctx)))
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
248 #endif
150
anatofuz
parents:
diff changeset
249 #undef COVMAP_FUNC_RECORD
anatofuz
parents:
diff changeset
250 /* COVMAP_FUNC_RECORD end. */
anatofuz
parents:
diff changeset
251
anatofuz
parents:
diff changeset
252 /* COVMAP_HEADER start */
anatofuz
parents:
diff changeset
253 /* Definition of member fields of coverage map header.
anatofuz
parents:
diff changeset
254 */
anatofuz
parents:
diff changeset
255 #ifndef COVMAP_HEADER
anatofuz
parents:
diff changeset
256 #define COVMAP_HEADER(Type, LLVMType, Name, Initializer)
anatofuz
parents:
diff changeset
257 #else
anatofuz
parents:
diff changeset
258 #define INSTR_PROF_DATA_DEFINED
anatofuz
parents:
diff changeset
259 #endif
anatofuz
parents:
diff changeset
260 COVMAP_HEADER(uint32_t, Int32Ty, NRecords, \
173
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
261 llvm::ConstantInt::get(Int32Ty, NRecords))
150
anatofuz
parents:
diff changeset
262 COVMAP_HEADER(uint32_t, Int32Ty, FilenamesSize, \
anatofuz
parents:
diff changeset
263 llvm::ConstantInt::get(Int32Ty, FilenamesSize))
anatofuz
parents:
diff changeset
264 COVMAP_HEADER(uint32_t, Int32Ty, CoverageSize, \
anatofuz
parents:
diff changeset
265 llvm::ConstantInt::get(Int32Ty, CoverageMappingSize))
anatofuz
parents:
diff changeset
266 COVMAP_HEADER(uint32_t, Int32Ty, Version, \
anatofuz
parents:
diff changeset
267 llvm::ConstantInt::get(Int32Ty, CovMapVersion::CurrentVersion))
anatofuz
parents:
diff changeset
268 #undef COVMAP_HEADER
anatofuz
parents:
diff changeset
269 /* COVMAP_HEADER end. */
anatofuz
parents:
diff changeset
270
anatofuz
parents:
diff changeset
271
anatofuz
parents:
diff changeset
272 #ifdef INSTR_PROF_SECT_ENTRY
anatofuz
parents:
diff changeset
273 #define INSTR_PROF_DATA_DEFINED
anatofuz
parents:
diff changeset
274 INSTR_PROF_SECT_ENTRY(IPSK_data, \
anatofuz
parents:
diff changeset
275 INSTR_PROF_QUOTE(INSTR_PROF_DATA_COMMON), \
anatofuz
parents:
diff changeset
276 INSTR_PROF_DATA_COFF, "__DATA,")
anatofuz
parents:
diff changeset
277 INSTR_PROF_SECT_ENTRY(IPSK_cnts, \
anatofuz
parents:
diff changeset
278 INSTR_PROF_QUOTE(INSTR_PROF_CNTS_COMMON), \
anatofuz
parents:
diff changeset
279 INSTR_PROF_CNTS_COFF, "__DATA,")
anatofuz
parents:
diff changeset
280 INSTR_PROF_SECT_ENTRY(IPSK_name, \
anatofuz
parents:
diff changeset
281 INSTR_PROF_QUOTE(INSTR_PROF_NAME_COMMON), \
anatofuz
parents:
diff changeset
282 INSTR_PROF_NAME_COFF, "__DATA,")
anatofuz
parents:
diff changeset
283 INSTR_PROF_SECT_ENTRY(IPSK_vals, \
anatofuz
parents:
diff changeset
284 INSTR_PROF_QUOTE(INSTR_PROF_VALS_COMMON), \
anatofuz
parents:
diff changeset
285 INSTR_PROF_VALS_COFF, "__DATA,")
anatofuz
parents:
diff changeset
286 INSTR_PROF_SECT_ENTRY(IPSK_vnodes, \
anatofuz
parents:
diff changeset
287 INSTR_PROF_QUOTE(INSTR_PROF_VNODES_COMMON), \
anatofuz
parents:
diff changeset
288 INSTR_PROF_VNODES_COFF, "__DATA,")
anatofuz
parents:
diff changeset
289 INSTR_PROF_SECT_ENTRY(IPSK_covmap, \
anatofuz
parents:
diff changeset
290 INSTR_PROF_QUOTE(INSTR_PROF_COVMAP_COMMON), \
anatofuz
parents:
diff changeset
291 INSTR_PROF_COVMAP_COFF, "__LLVM_COV,")
173
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
292 INSTR_PROF_SECT_ENTRY(IPSK_covfun, \
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
293 INSTR_PROF_QUOTE(INSTR_PROF_COVFUN_COMMON), \
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
294 INSTR_PROF_COVFUN_COFF, "__LLVM_COV,")
150
anatofuz
parents:
diff changeset
295 INSTR_PROF_SECT_ENTRY(IPSK_orderfile, \
anatofuz
parents:
diff changeset
296 INSTR_PROF_QUOTE(INSTR_PROF_ORDERFILE_COMMON), \
anatofuz
parents:
diff changeset
297 INSTR_PROF_QUOTE(INSTR_PROF_ORDERFILE_COFF), "__DATA,")
anatofuz
parents:
diff changeset
298
anatofuz
parents:
diff changeset
299 #undef INSTR_PROF_SECT_ENTRY
anatofuz
parents:
diff changeset
300 #endif
anatofuz
parents:
diff changeset
301
anatofuz
parents:
diff changeset
302
anatofuz
parents:
diff changeset
303 #ifdef INSTR_PROF_VALUE_PROF_DATA
anatofuz
parents:
diff changeset
304 #define INSTR_PROF_DATA_DEFINED
anatofuz
parents:
diff changeset
305
anatofuz
parents:
diff changeset
306 #define INSTR_PROF_MAX_NUM_VAL_PER_SITE 255
anatofuz
parents:
diff changeset
307 /*!
anatofuz
parents:
diff changeset
308 * This is the header of the data structure that defines the on-disk
anatofuz
parents:
diff changeset
309 * layout of the value profile data of a particular kind for one function.
anatofuz
parents:
diff changeset
310 */
anatofuz
parents:
diff changeset
311 typedef struct ValueProfRecord {
anatofuz
parents:
diff changeset
312 /* The kind of the value profile record. */
anatofuz
parents:
diff changeset
313 uint32_t Kind;
anatofuz
parents:
diff changeset
314 /*
anatofuz
parents:
diff changeset
315 * The number of value profile sites. It is guaranteed to be non-zero;
anatofuz
parents:
diff changeset
316 * otherwise the record for this kind won't be emitted.
anatofuz
parents:
diff changeset
317 */
anatofuz
parents:
diff changeset
318 uint32_t NumValueSites;
anatofuz
parents:
diff changeset
319 /*
anatofuz
parents:
diff changeset
320 * The first element of the array that stores the number of profiled
anatofuz
parents:
diff changeset
321 * values for each value site. The size of the array is NumValueSites.
anatofuz
parents:
diff changeset
322 * Since NumValueSites is greater than zero, there is at least one
anatofuz
parents:
diff changeset
323 * element in the array.
anatofuz
parents:
diff changeset
324 */
anatofuz
parents:
diff changeset
325 uint8_t SiteCountArray[1];
anatofuz
parents:
diff changeset
326
anatofuz
parents:
diff changeset
327 /*
anatofuz
parents:
diff changeset
328 * The fake declaration is for documentation purpose only.
anatofuz
parents:
diff changeset
329 * Align the start of next field to be on 8 byte boundaries.
anatofuz
parents:
diff changeset
330 uint8_t Padding[X];
anatofuz
parents:
diff changeset
331 */
anatofuz
parents:
diff changeset
332
anatofuz
parents:
diff changeset
333 /* The array of value profile data. The size of the array is the sum
anatofuz
parents:
diff changeset
334 * of all elements in SiteCountArray[].
anatofuz
parents:
diff changeset
335 InstrProfValueData ValueData[];
anatofuz
parents:
diff changeset
336 */
anatofuz
parents:
diff changeset
337
anatofuz
parents:
diff changeset
338 #ifdef __cplusplus
anatofuz
parents:
diff changeset
339 /*!
anatofuz
parents:
diff changeset
340 * Return the number of value sites.
anatofuz
parents:
diff changeset
341 */
anatofuz
parents:
diff changeset
342 uint32_t getNumValueSites() const { return NumValueSites; }
anatofuz
parents:
diff changeset
343 /*!
anatofuz
parents:
diff changeset
344 * Read data from this record and save it to Record.
anatofuz
parents:
diff changeset
345 */
anatofuz
parents:
diff changeset
346 void deserializeTo(InstrProfRecord &Record,
anatofuz
parents:
diff changeset
347 InstrProfSymtab *SymTab);
anatofuz
parents:
diff changeset
348 /*
anatofuz
parents:
diff changeset
349 * In-place byte swap:
anatofuz
parents:
diff changeset
350 * Do byte swap for this instance. \c Old is the original order before
anatofuz
parents:
diff changeset
351 * the swap, and \c New is the New byte order.
anatofuz
parents:
diff changeset
352 */
anatofuz
parents:
diff changeset
353 void swapBytes(support::endianness Old, support::endianness New);
anatofuz
parents:
diff changeset
354 #endif
anatofuz
parents:
diff changeset
355 } ValueProfRecord;
anatofuz
parents:
diff changeset
356
anatofuz
parents:
diff changeset
357 /*!
anatofuz
parents:
diff changeset
358 * Per-function header/control data structure for value profiling
anatofuz
parents:
diff changeset
359 * data in indexed format.
anatofuz
parents:
diff changeset
360 */
anatofuz
parents:
diff changeset
361 typedef struct ValueProfData {
anatofuz
parents:
diff changeset
362 /*
anatofuz
parents:
diff changeset
363 * Total size in bytes including this field. It must be a multiple
anatofuz
parents:
diff changeset
364 * of sizeof(uint64_t).
anatofuz
parents:
diff changeset
365 */
anatofuz
parents:
diff changeset
366 uint32_t TotalSize;
anatofuz
parents:
diff changeset
367 /*
anatofuz
parents:
diff changeset
368 *The number of value profile kinds that has value profile data.
anatofuz
parents:
diff changeset
369 * In this implementation, a value profile kind is considered to
anatofuz
parents:
diff changeset
370 * have profile data if the number of value profile sites for the
anatofuz
parents:
diff changeset
371 * kind is not zero. More aggressively, the implementation can
anatofuz
parents:
diff changeset
372 * choose to check the actual data value: if none of the value sites
anatofuz
parents:
diff changeset
373 * has any profiled values, the kind can be skipped.
anatofuz
parents:
diff changeset
374 */
anatofuz
parents:
diff changeset
375 uint32_t NumValueKinds;
anatofuz
parents:
diff changeset
376
anatofuz
parents:
diff changeset
377 /*
anatofuz
parents:
diff changeset
378 * Following are a sequence of variable length records. The prefix/header
anatofuz
parents:
diff changeset
379 * of each record is defined by ValueProfRecord type. The number of
anatofuz
parents:
diff changeset
380 * records is NumValueKinds.
anatofuz
parents:
diff changeset
381 * ValueProfRecord Record_1;
anatofuz
parents:
diff changeset
382 * ValueProfRecord Record_N;
anatofuz
parents:
diff changeset
383 */
anatofuz
parents:
diff changeset
384
anatofuz
parents:
diff changeset
385 #if __cplusplus
anatofuz
parents:
diff changeset
386 /*!
anatofuz
parents:
diff changeset
387 * Return the total size in bytes of the on-disk value profile data
anatofuz
parents:
diff changeset
388 * given the data stored in Record.
anatofuz
parents:
diff changeset
389 */
anatofuz
parents:
diff changeset
390 static uint32_t getSize(const InstrProfRecord &Record);
anatofuz
parents:
diff changeset
391 /*!
anatofuz
parents:
diff changeset
392 * Return a pointer to \c ValueProfData instance ready to be streamed.
anatofuz
parents:
diff changeset
393 */
anatofuz
parents:
diff changeset
394 static std::unique_ptr<ValueProfData>
anatofuz
parents:
diff changeset
395 serializeFrom(const InstrProfRecord &Record);
anatofuz
parents:
diff changeset
396 /*!
anatofuz
parents:
diff changeset
397 * Check the integrity of the record.
anatofuz
parents:
diff changeset
398 */
anatofuz
parents:
diff changeset
399 Error checkIntegrity();
anatofuz
parents:
diff changeset
400 /*!
anatofuz
parents:
diff changeset
401 * Return a pointer to \c ValueProfileData instance ready to be read.
anatofuz
parents:
diff changeset
402 * All data in the instance are properly byte swapped. The input
anatofuz
parents:
diff changeset
403 * data is assumed to be in little endian order.
anatofuz
parents:
diff changeset
404 */
anatofuz
parents:
diff changeset
405 static Expected<std::unique_ptr<ValueProfData>>
anatofuz
parents:
diff changeset
406 getValueProfData(const unsigned char *SrcBuffer,
anatofuz
parents:
diff changeset
407 const unsigned char *const SrcBufferEnd,
anatofuz
parents:
diff changeset
408 support::endianness SrcDataEndianness);
anatofuz
parents:
diff changeset
409 /*!
anatofuz
parents:
diff changeset
410 * Swap byte order from \c Endianness order to host byte order.
anatofuz
parents:
diff changeset
411 */
anatofuz
parents:
diff changeset
412 void swapBytesToHost(support::endianness Endianness);
anatofuz
parents:
diff changeset
413 /*!
anatofuz
parents:
diff changeset
414 * Swap byte order from host byte order to \c Endianness order.
anatofuz
parents:
diff changeset
415 */
anatofuz
parents:
diff changeset
416 void swapBytesFromHost(support::endianness Endianness);
anatofuz
parents:
diff changeset
417 /*!
anatofuz
parents:
diff changeset
418 * Return the total size of \c ValueProfileData.
anatofuz
parents:
diff changeset
419 */
anatofuz
parents:
diff changeset
420 uint32_t getSize() const { return TotalSize; }
anatofuz
parents:
diff changeset
421 /*!
anatofuz
parents:
diff changeset
422 * Read data from this data and save it to \c Record.
anatofuz
parents:
diff changeset
423 */
anatofuz
parents:
diff changeset
424 void deserializeTo(InstrProfRecord &Record,
anatofuz
parents:
diff changeset
425 InstrProfSymtab *SymTab);
anatofuz
parents:
diff changeset
426 void operator delete(void *ptr) { ::operator delete(ptr); }
anatofuz
parents:
diff changeset
427 #endif
anatofuz
parents:
diff changeset
428 } ValueProfData;
anatofuz
parents:
diff changeset
429
anatofuz
parents:
diff changeset
430 /*
anatofuz
parents:
diff changeset
431 * The closure is designed to abstact away two types of value profile data:
anatofuz
parents:
diff changeset
432 * - InstrProfRecord which is the primary data structure used to
anatofuz
parents:
diff changeset
433 * represent profile data in host tools (reader, writer, and profile-use)
anatofuz
parents:
diff changeset
434 * - value profile runtime data structure suitable to be used by C
anatofuz
parents:
diff changeset
435 * runtime library.
anatofuz
parents:
diff changeset
436 *
anatofuz
parents:
diff changeset
437 * Both sources of data need to serialize to disk/memory-buffer in common
anatofuz
parents:
diff changeset
438 * format: ValueProfData. The abstraction allows compiler-rt's raw profiler
anatofuz
parents:
diff changeset
439 * writer to share the same format and code with indexed profile writer.
anatofuz
parents:
diff changeset
440 *
anatofuz
parents:
diff changeset
441 * For documentation of the member methods below, refer to corresponding methods
anatofuz
parents:
diff changeset
442 * in class InstrProfRecord.
anatofuz
parents:
diff changeset
443 */
anatofuz
parents:
diff changeset
444 typedef struct ValueProfRecordClosure {
anatofuz
parents:
diff changeset
445 const void *Record;
anatofuz
parents:
diff changeset
446 uint32_t (*GetNumValueKinds)(const void *Record);
anatofuz
parents:
diff changeset
447 uint32_t (*GetNumValueSites)(const void *Record, uint32_t VKind);
anatofuz
parents:
diff changeset
448 uint32_t (*GetNumValueData)(const void *Record, uint32_t VKind);
anatofuz
parents:
diff changeset
449 uint32_t (*GetNumValueDataForSite)(const void *R, uint32_t VK, uint32_t S);
anatofuz
parents:
diff changeset
450
anatofuz
parents:
diff changeset
451 /*
anatofuz
parents:
diff changeset
452 * After extracting the value profile data from the value profile record,
anatofuz
parents:
diff changeset
453 * this method is used to map the in-memory value to on-disk value. If
anatofuz
parents:
diff changeset
454 * the method is null, value will be written out untranslated.
anatofuz
parents:
diff changeset
455 */
anatofuz
parents:
diff changeset
456 uint64_t (*RemapValueData)(uint32_t, uint64_t Value);
anatofuz
parents:
diff changeset
457 void (*GetValueForSite)(const void *R, InstrProfValueData *Dst, uint32_t K,
anatofuz
parents:
diff changeset
458 uint32_t S);
anatofuz
parents:
diff changeset
459 ValueProfData *(*AllocValueProfData)(size_t TotalSizeInBytes);
anatofuz
parents:
diff changeset
460 } ValueProfRecordClosure;
anatofuz
parents:
diff changeset
461
anatofuz
parents:
diff changeset
462 INSTR_PROF_VISIBILITY ValueProfRecord *
anatofuz
parents:
diff changeset
463 getFirstValueProfRecord(ValueProfData *VPD);
anatofuz
parents:
diff changeset
464 INSTR_PROF_VISIBILITY ValueProfRecord *
anatofuz
parents:
diff changeset
465 getValueProfRecordNext(ValueProfRecord *VPR);
anatofuz
parents:
diff changeset
466 INSTR_PROF_VISIBILITY InstrProfValueData *
anatofuz
parents:
diff changeset
467 getValueProfRecordValueData(ValueProfRecord *VPR);
anatofuz
parents:
diff changeset
468 INSTR_PROF_VISIBILITY uint32_t
anatofuz
parents:
diff changeset
469 getValueProfRecordHeaderSize(uint32_t NumValueSites);
anatofuz
parents:
diff changeset
470
anatofuz
parents:
diff changeset
471 #undef INSTR_PROF_VALUE_PROF_DATA
anatofuz
parents:
diff changeset
472 #endif /* INSTR_PROF_VALUE_PROF_DATA */
anatofuz
parents:
diff changeset
473
anatofuz
parents:
diff changeset
474
anatofuz
parents:
diff changeset
475 #ifdef INSTR_PROF_COMMON_API_IMPL
anatofuz
parents:
diff changeset
476 #define INSTR_PROF_DATA_DEFINED
anatofuz
parents:
diff changeset
477 #ifdef __cplusplus
anatofuz
parents:
diff changeset
478 #define INSTR_PROF_INLINE inline
anatofuz
parents:
diff changeset
479 #define INSTR_PROF_NULLPTR nullptr
anatofuz
parents:
diff changeset
480 #else
anatofuz
parents:
diff changeset
481 #define INSTR_PROF_INLINE
anatofuz
parents:
diff changeset
482 #define INSTR_PROF_NULLPTR NULL
anatofuz
parents:
diff changeset
483 #endif
anatofuz
parents:
diff changeset
484
anatofuz
parents:
diff changeset
485 #ifndef offsetof
anatofuz
parents:
diff changeset
486 #define offsetof(TYPE, MEMBER) ((size_t) &((TYPE *)0)->MEMBER)
anatofuz
parents:
diff changeset
487 #endif
anatofuz
parents:
diff changeset
488
anatofuz
parents:
diff changeset
489 /*!
anatofuz
parents:
diff changeset
490 * Return the \c ValueProfRecord header size including the
anatofuz
parents:
diff changeset
491 * padding bytes.
anatofuz
parents:
diff changeset
492 */
anatofuz
parents:
diff changeset
493 INSTR_PROF_VISIBILITY INSTR_PROF_INLINE
anatofuz
parents:
diff changeset
494 uint32_t getValueProfRecordHeaderSize(uint32_t NumValueSites) {
anatofuz
parents:
diff changeset
495 uint32_t Size = offsetof(ValueProfRecord, SiteCountArray) +
anatofuz
parents:
diff changeset
496 sizeof(uint8_t) * NumValueSites;
anatofuz
parents:
diff changeset
497 /* Round the size to multiple of 8 bytes. */
anatofuz
parents:
diff changeset
498 Size = (Size + 7) & ~7;
anatofuz
parents:
diff changeset
499 return Size;
anatofuz
parents:
diff changeset
500 }
anatofuz
parents:
diff changeset
501
anatofuz
parents:
diff changeset
502 /*!
anatofuz
parents:
diff changeset
503 * Return the total size of the value profile record including the
anatofuz
parents:
diff changeset
504 * header and the value data.
anatofuz
parents:
diff changeset
505 */
anatofuz
parents:
diff changeset
506 INSTR_PROF_VISIBILITY INSTR_PROF_INLINE
anatofuz
parents:
diff changeset
507 uint32_t getValueProfRecordSize(uint32_t NumValueSites,
anatofuz
parents:
diff changeset
508 uint32_t NumValueData) {
anatofuz
parents:
diff changeset
509 return getValueProfRecordHeaderSize(NumValueSites) +
anatofuz
parents:
diff changeset
510 sizeof(InstrProfValueData) * NumValueData;
anatofuz
parents:
diff changeset
511 }
anatofuz
parents:
diff changeset
512
anatofuz
parents:
diff changeset
513 /*!
anatofuz
parents:
diff changeset
514 * Return the pointer to the start of value data array.
anatofuz
parents:
diff changeset
515 */
anatofuz
parents:
diff changeset
516 INSTR_PROF_VISIBILITY INSTR_PROF_INLINE
anatofuz
parents:
diff changeset
517 InstrProfValueData *getValueProfRecordValueData(ValueProfRecord *This) {
anatofuz
parents:
diff changeset
518 return (InstrProfValueData *)((char *)This + getValueProfRecordHeaderSize(
anatofuz
parents:
diff changeset
519 This->NumValueSites));
anatofuz
parents:
diff changeset
520 }
anatofuz
parents:
diff changeset
521
anatofuz
parents:
diff changeset
522 /*!
anatofuz
parents:
diff changeset
523 * Return the total number of value data for \c This record.
anatofuz
parents:
diff changeset
524 */
anatofuz
parents:
diff changeset
525 INSTR_PROF_VISIBILITY INSTR_PROF_INLINE
anatofuz
parents:
diff changeset
526 uint32_t getValueProfRecordNumValueData(ValueProfRecord *This) {
anatofuz
parents:
diff changeset
527 uint32_t NumValueData = 0;
anatofuz
parents:
diff changeset
528 uint32_t I;
anatofuz
parents:
diff changeset
529 for (I = 0; I < This->NumValueSites; I++)
anatofuz
parents:
diff changeset
530 NumValueData += This->SiteCountArray[I];
anatofuz
parents:
diff changeset
531 return NumValueData;
anatofuz
parents:
diff changeset
532 }
anatofuz
parents:
diff changeset
533
anatofuz
parents:
diff changeset
534 /*!
anatofuz
parents:
diff changeset
535 * Use this method to advance to the next \c This \c ValueProfRecord.
anatofuz
parents:
diff changeset
536 */
anatofuz
parents:
diff changeset
537 INSTR_PROF_VISIBILITY INSTR_PROF_INLINE
anatofuz
parents:
diff changeset
538 ValueProfRecord *getValueProfRecordNext(ValueProfRecord *This) {
anatofuz
parents:
diff changeset
539 uint32_t NumValueData = getValueProfRecordNumValueData(This);
anatofuz
parents:
diff changeset
540 return (ValueProfRecord *)((char *)This +
anatofuz
parents:
diff changeset
541 getValueProfRecordSize(This->NumValueSites,
anatofuz
parents:
diff changeset
542 NumValueData));
anatofuz
parents:
diff changeset
543 }
anatofuz
parents:
diff changeset
544
anatofuz
parents:
diff changeset
545 /*!
anatofuz
parents:
diff changeset
546 * Return the first \c ValueProfRecord instance.
anatofuz
parents:
diff changeset
547 */
anatofuz
parents:
diff changeset
548 INSTR_PROF_VISIBILITY INSTR_PROF_INLINE
anatofuz
parents:
diff changeset
549 ValueProfRecord *getFirstValueProfRecord(ValueProfData *This) {
anatofuz
parents:
diff changeset
550 return (ValueProfRecord *)((char *)This + sizeof(ValueProfData));
anatofuz
parents:
diff changeset
551 }
anatofuz
parents:
diff changeset
552
anatofuz
parents:
diff changeset
553 /* Closure based interfaces. */
anatofuz
parents:
diff changeset
554
anatofuz
parents:
diff changeset
555 /*!
anatofuz
parents:
diff changeset
556 * Return the total size in bytes of the on-disk value profile data
anatofuz
parents:
diff changeset
557 * given the data stored in Record.
anatofuz
parents:
diff changeset
558 */
anatofuz
parents:
diff changeset
559 INSTR_PROF_VISIBILITY uint32_t
anatofuz
parents:
diff changeset
560 getValueProfDataSize(ValueProfRecordClosure *Closure) {
anatofuz
parents:
diff changeset
561 uint32_t Kind;
anatofuz
parents:
diff changeset
562 uint32_t TotalSize = sizeof(ValueProfData);
anatofuz
parents:
diff changeset
563 const void *Record = Closure->Record;
anatofuz
parents:
diff changeset
564
anatofuz
parents:
diff changeset
565 for (Kind = IPVK_First; Kind <= IPVK_Last; Kind++) {
anatofuz
parents:
diff changeset
566 uint32_t NumValueSites = Closure->GetNumValueSites(Record, Kind);
anatofuz
parents:
diff changeset
567 if (!NumValueSites)
anatofuz
parents:
diff changeset
568 continue;
anatofuz
parents:
diff changeset
569 TotalSize += getValueProfRecordSize(NumValueSites,
anatofuz
parents:
diff changeset
570 Closure->GetNumValueData(Record, Kind));
anatofuz
parents:
diff changeset
571 }
anatofuz
parents:
diff changeset
572 return TotalSize;
anatofuz
parents:
diff changeset
573 }
anatofuz
parents:
diff changeset
574
anatofuz
parents:
diff changeset
575 /*!
anatofuz
parents:
diff changeset
576 * Extract value profile data of a function for the profile kind \c ValueKind
anatofuz
parents:
diff changeset
577 * from the \c Closure and serialize the data into \c This record instance.
anatofuz
parents:
diff changeset
578 */
anatofuz
parents:
diff changeset
579 INSTR_PROF_VISIBILITY void
anatofuz
parents:
diff changeset
580 serializeValueProfRecordFrom(ValueProfRecord *This,
anatofuz
parents:
diff changeset
581 ValueProfRecordClosure *Closure,
anatofuz
parents:
diff changeset
582 uint32_t ValueKind, uint32_t NumValueSites) {
anatofuz
parents:
diff changeset
583 uint32_t S;
anatofuz
parents:
diff changeset
584 const void *Record = Closure->Record;
anatofuz
parents:
diff changeset
585 This->Kind = ValueKind;
anatofuz
parents:
diff changeset
586 This->NumValueSites = NumValueSites;
anatofuz
parents:
diff changeset
587 InstrProfValueData *DstVD = getValueProfRecordValueData(This);
anatofuz
parents:
diff changeset
588
anatofuz
parents:
diff changeset
589 for (S = 0; S < NumValueSites; S++) {
anatofuz
parents:
diff changeset
590 uint32_t ND = Closure->GetNumValueDataForSite(Record, ValueKind, S);
anatofuz
parents:
diff changeset
591 This->SiteCountArray[S] = ND;
anatofuz
parents:
diff changeset
592 Closure->GetValueForSite(Record, DstVD, ValueKind, S);
anatofuz
parents:
diff changeset
593 DstVD += ND;
anatofuz
parents:
diff changeset
594 }
anatofuz
parents:
diff changeset
595 }
anatofuz
parents:
diff changeset
596
anatofuz
parents:
diff changeset
597 /*!
anatofuz
parents:
diff changeset
598 * Extract value profile data of a function from the \c Closure
anatofuz
parents:
diff changeset
599 * and serialize the data into \c DstData if it is not NULL or heap
anatofuz
parents:
diff changeset
600 * memory allocated by the \c Closure's allocator method. If \c
anatofuz
parents:
diff changeset
601 * DstData is not null, the caller is expected to set the TotalSize
anatofuz
parents:
diff changeset
602 * in DstData.
anatofuz
parents:
diff changeset
603 */
anatofuz
parents:
diff changeset
604 INSTR_PROF_VISIBILITY ValueProfData *
anatofuz
parents:
diff changeset
605 serializeValueProfDataFrom(ValueProfRecordClosure *Closure,
anatofuz
parents:
diff changeset
606 ValueProfData *DstData) {
anatofuz
parents:
diff changeset
607 uint32_t Kind;
anatofuz
parents:
diff changeset
608 uint32_t TotalSize =
anatofuz
parents:
diff changeset
609 DstData ? DstData->TotalSize : getValueProfDataSize(Closure);
anatofuz
parents:
diff changeset
610
anatofuz
parents:
diff changeset
611 ValueProfData *VPD =
anatofuz
parents:
diff changeset
612 DstData ? DstData : Closure->AllocValueProfData(TotalSize);
anatofuz
parents:
diff changeset
613
anatofuz
parents:
diff changeset
614 VPD->TotalSize = TotalSize;
anatofuz
parents:
diff changeset
615 VPD->NumValueKinds = Closure->GetNumValueKinds(Closure->Record);
anatofuz
parents:
diff changeset
616 ValueProfRecord *VR = getFirstValueProfRecord(VPD);
anatofuz
parents:
diff changeset
617 for (Kind = IPVK_First; Kind <= IPVK_Last; Kind++) {
anatofuz
parents:
diff changeset
618 uint32_t NumValueSites = Closure->GetNumValueSites(Closure->Record, Kind);
anatofuz
parents:
diff changeset
619 if (!NumValueSites)
anatofuz
parents:
diff changeset
620 continue;
anatofuz
parents:
diff changeset
621 serializeValueProfRecordFrom(VR, Closure, Kind, NumValueSites);
anatofuz
parents:
diff changeset
622 VR = getValueProfRecordNext(VR);
anatofuz
parents:
diff changeset
623 }
anatofuz
parents:
diff changeset
624 return VPD;
anatofuz
parents:
diff changeset
625 }
anatofuz
parents:
diff changeset
626
anatofuz
parents:
diff changeset
627 #undef INSTR_PROF_COMMON_API_IMPL
anatofuz
parents:
diff changeset
628 #endif /* INSTR_PROF_COMMON_API_IMPL */
anatofuz
parents:
diff changeset
629
anatofuz
parents:
diff changeset
630 /*============================================================================*/
anatofuz
parents:
diff changeset
631
anatofuz
parents:
diff changeset
632 #ifndef INSTR_PROF_DATA_DEFINED
anatofuz
parents:
diff changeset
633
anatofuz
parents:
diff changeset
634 #ifndef INSTR_PROF_DATA_INC
anatofuz
parents:
diff changeset
635 #define INSTR_PROF_DATA_INC
anatofuz
parents:
diff changeset
636
anatofuz
parents:
diff changeset
637 /* Helper macros. */
anatofuz
parents:
diff changeset
638 #define INSTR_PROF_SIMPLE_QUOTE(x) #x
anatofuz
parents:
diff changeset
639 #define INSTR_PROF_QUOTE(x) INSTR_PROF_SIMPLE_QUOTE(x)
anatofuz
parents:
diff changeset
640 #define INSTR_PROF_SIMPLE_CONCAT(x,y) x ## y
anatofuz
parents:
diff changeset
641 #define INSTR_PROF_CONCAT(x,y) INSTR_PROF_SIMPLE_CONCAT(x,y)
anatofuz
parents:
diff changeset
642
anatofuz
parents:
diff changeset
643 /* Magic number to detect file format and endianness.
anatofuz
parents:
diff changeset
644 * Use 255 at one end, since no UTF-8 file can use that character. Avoid 0,
anatofuz
parents:
diff changeset
645 * so that utilities, like strings, don't grab it as a string. 129 is also
anatofuz
parents:
diff changeset
646 * invalid UTF-8, and high enough to be interesting.
anatofuz
parents:
diff changeset
647 * Use "lprofr" in the centre to stand for "LLVM Profile Raw", or "lprofR"
anatofuz
parents:
diff changeset
648 * for 32-bit platforms.
anatofuz
parents:
diff changeset
649 */
anatofuz
parents:
diff changeset
650 #define INSTR_PROF_RAW_MAGIC_64 (uint64_t)255 << 56 | (uint64_t)'l' << 48 | \
anatofuz
parents:
diff changeset
651 (uint64_t)'p' << 40 | (uint64_t)'r' << 32 | (uint64_t)'o' << 24 | \
anatofuz
parents:
diff changeset
652 (uint64_t)'f' << 16 | (uint64_t)'r' << 8 | (uint64_t)129
anatofuz
parents:
diff changeset
653 #define INSTR_PROF_RAW_MAGIC_32 (uint64_t)255 << 56 | (uint64_t)'l' << 48 | \
anatofuz
parents:
diff changeset
654 (uint64_t)'p' << 40 | (uint64_t)'r' << 32 | (uint64_t)'o' << 24 | \
anatofuz
parents:
diff changeset
655 (uint64_t)'f' << 16 | (uint64_t)'R' << 8 | (uint64_t)129
anatofuz
parents:
diff changeset
656
anatofuz
parents:
diff changeset
657 /* Raw profile format version (start from 1). */
anatofuz
parents:
diff changeset
658 #define INSTR_PROF_RAW_VERSION 5
anatofuz
parents:
diff changeset
659 /* Indexed profile format version (start from 1). */
anatofuz
parents:
diff changeset
660 #define INSTR_PROF_INDEX_VERSION 5
173
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
661 /* Coverage mapping format version (start from 0). */
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
662 #define INSTR_PROF_COVMAP_VERSION 3
150
anatofuz
parents:
diff changeset
663
anatofuz
parents:
diff changeset
664 /* Profile version is always of type uint64_t. Reserve the upper 8 bits in the
anatofuz
parents:
diff changeset
665 * version for other variants of profile. We set the lowest bit of the upper 8
anatofuz
parents:
diff changeset
666 * bits (i.e. bit 56) to 1 to indicate if this is an IR-level instrumentaiton
anatofuz
parents:
diff changeset
667 * generated profile, and 0 if this is a Clang FE generated profile.
anatofuz
parents:
diff changeset
668 * 1 in bit 57 indicates there are context-sensitive records in the profile.
anatofuz
parents:
diff changeset
669 */
anatofuz
parents:
diff changeset
670 #define VARIANT_MASKS_ALL 0xff00000000000000ULL
anatofuz
parents:
diff changeset
671 #define GET_VERSION(V) ((V) & ~VARIANT_MASKS_ALL)
anatofuz
parents:
diff changeset
672 #define VARIANT_MASK_IR_PROF (0x1ULL << 56)
anatofuz
parents:
diff changeset
673 #define VARIANT_MASK_CSIR_PROF (0x1ULL << 57)
anatofuz
parents:
diff changeset
674 #define INSTR_PROF_RAW_VERSION_VAR __llvm_profile_raw_version
anatofuz
parents:
diff changeset
675 #define INSTR_PROF_PROFILE_RUNTIME_VAR __llvm_profile_runtime
anatofuz
parents:
diff changeset
676
anatofuz
parents:
diff changeset
677 /* The variable that holds the name of the profile data
anatofuz
parents:
diff changeset
678 * specified via command line. */
anatofuz
parents:
diff changeset
679 #define INSTR_PROF_PROFILE_NAME_VAR __llvm_profile_filename
anatofuz
parents:
diff changeset
680
anatofuz
parents:
diff changeset
681 /* section name strings common to all targets other
anatofuz
parents:
diff changeset
682 than WIN32 */
anatofuz
parents:
diff changeset
683 #define INSTR_PROF_DATA_COMMON __llvm_prf_data
anatofuz
parents:
diff changeset
684 #define INSTR_PROF_NAME_COMMON __llvm_prf_names
anatofuz
parents:
diff changeset
685 #define INSTR_PROF_CNTS_COMMON __llvm_prf_cnts
anatofuz
parents:
diff changeset
686 #define INSTR_PROF_VALS_COMMON __llvm_prf_vals
anatofuz
parents:
diff changeset
687 #define INSTR_PROF_VNODES_COMMON __llvm_prf_vnds
anatofuz
parents:
diff changeset
688 #define INSTR_PROF_COVMAP_COMMON __llvm_covmap
173
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
689 #define INSTR_PROF_COVFUN_COMMON __llvm_covfun
150
anatofuz
parents:
diff changeset
690 #define INSTR_PROF_ORDERFILE_COMMON __llvm_orderfile
anatofuz
parents:
diff changeset
691 /* Windows section names. Because these section names contain dollar characters,
anatofuz
parents:
diff changeset
692 * they must be quoted.
anatofuz
parents:
diff changeset
693 */
anatofuz
parents:
diff changeset
694 #define INSTR_PROF_DATA_COFF ".lprfd$M"
anatofuz
parents:
diff changeset
695 #define INSTR_PROF_NAME_COFF ".lprfn$M"
anatofuz
parents:
diff changeset
696 #define INSTR_PROF_CNTS_COFF ".lprfc$M"
anatofuz
parents:
diff changeset
697 #define INSTR_PROF_VALS_COFF ".lprfv$M"
anatofuz
parents:
diff changeset
698 #define INSTR_PROF_VNODES_COFF ".lprfnd$M"
anatofuz
parents:
diff changeset
699 #define INSTR_PROF_COVMAP_COFF ".lcovmap$M"
173
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
700 #define INSTR_PROF_COVFUN_COFF ".lcovfun$M"
150
anatofuz
parents:
diff changeset
701 #define INSTR_PROF_ORDERFILE_COFF ".lorderfile$M"
anatofuz
parents:
diff changeset
702
anatofuz
parents:
diff changeset
703 #ifdef _WIN32
anatofuz
parents:
diff changeset
704 /* Runtime section names and name strings. */
anatofuz
parents:
diff changeset
705 #define INSTR_PROF_DATA_SECT_NAME INSTR_PROF_DATA_COFF
anatofuz
parents:
diff changeset
706 #define INSTR_PROF_NAME_SECT_NAME INSTR_PROF_NAME_COFF
anatofuz
parents:
diff changeset
707 #define INSTR_PROF_CNTS_SECT_NAME INSTR_PROF_CNTS_COFF
anatofuz
parents:
diff changeset
708 /* Array of pointers. Each pointer points to a list
anatofuz
parents:
diff changeset
709 * of value nodes associated with one value site.
anatofuz
parents:
diff changeset
710 */
anatofuz
parents:
diff changeset
711 #define INSTR_PROF_VALS_SECT_NAME INSTR_PROF_VALS_COFF
anatofuz
parents:
diff changeset
712 /* Value profile nodes section. */
anatofuz
parents:
diff changeset
713 #define INSTR_PROF_VNODES_SECT_NAME INSTR_PROF_VNODES_COFF
anatofuz
parents:
diff changeset
714 #define INSTR_PROF_COVMAP_SECT_NAME INSTR_PROF_COVMAP_COFF
173
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
715 #define INSTR_PROF_COVFUN_SECT_NAME INSTR_PROF_COVFUN_COFF
150
anatofuz
parents:
diff changeset
716 #define INSTR_PROF_ORDERFILE_SECT_NAME INSTR_PROF_ORDERFILE_COFF
anatofuz
parents:
diff changeset
717 #else
anatofuz
parents:
diff changeset
718 /* Runtime section names and name strings. */
anatofuz
parents:
diff changeset
719 #define INSTR_PROF_DATA_SECT_NAME INSTR_PROF_QUOTE(INSTR_PROF_DATA_COMMON)
anatofuz
parents:
diff changeset
720 #define INSTR_PROF_NAME_SECT_NAME INSTR_PROF_QUOTE(INSTR_PROF_NAME_COMMON)
anatofuz
parents:
diff changeset
721 #define INSTR_PROF_CNTS_SECT_NAME INSTR_PROF_QUOTE(INSTR_PROF_CNTS_COMMON)
anatofuz
parents:
diff changeset
722 /* Array of pointers. Each pointer points to a list
anatofuz
parents:
diff changeset
723 * of value nodes associated with one value site.
anatofuz
parents:
diff changeset
724 */
anatofuz
parents:
diff changeset
725 #define INSTR_PROF_VALS_SECT_NAME INSTR_PROF_QUOTE(INSTR_PROF_VALS_COMMON)
anatofuz
parents:
diff changeset
726 /* Value profile nodes section. */
anatofuz
parents:
diff changeset
727 #define INSTR_PROF_VNODES_SECT_NAME INSTR_PROF_QUOTE(INSTR_PROF_VNODES_COMMON)
anatofuz
parents:
diff changeset
728 #define INSTR_PROF_COVMAP_SECT_NAME INSTR_PROF_QUOTE(INSTR_PROF_COVMAP_COMMON)
173
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
729 #define INSTR_PROF_COVFUN_SECT_NAME INSTR_PROF_QUOTE(INSTR_PROF_COVFUN_COMMON)
150
anatofuz
parents:
diff changeset
730 /* Order file instrumentation. */
anatofuz
parents:
diff changeset
731 #define INSTR_PROF_ORDERFILE_SECT_NAME \
anatofuz
parents:
diff changeset
732 INSTR_PROF_QUOTE(INSTR_PROF_ORDERFILE_COMMON)
anatofuz
parents:
diff changeset
733 #endif
anatofuz
parents:
diff changeset
734
anatofuz
parents:
diff changeset
735 #define INSTR_PROF_ORDERFILE_BUFFER_NAME _llvm_order_file_buffer
anatofuz
parents:
diff changeset
736 #define INSTR_PROF_ORDERFILE_BUFFER_NAME_STR \
anatofuz
parents:
diff changeset
737 INSTR_PROF_QUOTE(INSTR_PROF_ORDERFILE_BUFFER_NAME)
anatofuz
parents:
diff changeset
738 #define INSTR_PROF_ORDERFILE_BUFFER_IDX_NAME _llvm_order_file_buffer_idx
anatofuz
parents:
diff changeset
739 #define INSTR_PROF_ORDERFILE_BUFFER_IDX_NAME_STR \
anatofuz
parents:
diff changeset
740 INSTR_PROF_QUOTE(INSTR_PROF_ORDERFILE_BUFFER_IDX_NAME)
anatofuz
parents:
diff changeset
741
anatofuz
parents:
diff changeset
742 /* Macros to define start/stop section symbol for a given
anatofuz
parents:
diff changeset
743 * section on Linux. For instance
anatofuz
parents:
diff changeset
744 * INSTR_PROF_SECT_START(INSTR_PROF_DATA_SECT_NAME) will
anatofuz
parents:
diff changeset
745 * expand to __start___llvm_prof_data
anatofuz
parents:
diff changeset
746 */
anatofuz
parents:
diff changeset
747 #define INSTR_PROF_SECT_START(Sect) \
anatofuz
parents:
diff changeset
748 INSTR_PROF_CONCAT(__start_,Sect)
anatofuz
parents:
diff changeset
749 #define INSTR_PROF_SECT_STOP(Sect) \
anatofuz
parents:
diff changeset
750 INSTR_PROF_CONCAT(__stop_,Sect)
anatofuz
parents:
diff changeset
751
anatofuz
parents:
diff changeset
752 /* Value Profiling API linkage name. */
anatofuz
parents:
diff changeset
753 #define INSTR_PROF_VALUE_PROF_FUNC __llvm_profile_instrument_target
anatofuz
parents:
diff changeset
754 #define INSTR_PROF_VALUE_PROF_FUNC_STR \
anatofuz
parents:
diff changeset
755 INSTR_PROF_QUOTE(INSTR_PROF_VALUE_PROF_FUNC)
anatofuz
parents:
diff changeset
756 #define INSTR_PROF_VALUE_RANGE_PROF_FUNC __llvm_profile_instrument_range
anatofuz
parents:
diff changeset
757 #define INSTR_PROF_VALUE_RANGE_PROF_FUNC_STR \
anatofuz
parents:
diff changeset
758 INSTR_PROF_QUOTE(INSTR_PROF_VALUE_RANGE_PROF_FUNC)
anatofuz
parents:
diff changeset
759
anatofuz
parents:
diff changeset
760 /* InstrProfile per-function control data alignment. */
anatofuz
parents:
diff changeset
761 #define INSTR_PROF_DATA_ALIGNMENT 8
anatofuz
parents:
diff changeset
762
anatofuz
parents:
diff changeset
763 /* The data structure that represents a tracked value by the
anatofuz
parents:
diff changeset
764 * value profiler.
anatofuz
parents:
diff changeset
765 */
anatofuz
parents:
diff changeset
766 typedef struct InstrProfValueData {
anatofuz
parents:
diff changeset
767 /* Profiled value. */
anatofuz
parents:
diff changeset
768 uint64_t Value;
anatofuz
parents:
diff changeset
769 /* Number of times the value appears in the training run. */
anatofuz
parents:
diff changeset
770 uint64_t Count;
anatofuz
parents:
diff changeset
771 } InstrProfValueData;
anatofuz
parents:
diff changeset
772
anatofuz
parents:
diff changeset
773 #endif /* INSTR_PROF_DATA_INC */
anatofuz
parents:
diff changeset
774
anatofuz
parents:
diff changeset
775 #ifndef INSTR_ORDER_FILE_INC
anatofuz
parents:
diff changeset
776 /* The maximal # of functions: 128*1024 (the buffer size will be 128*4 KB). */
anatofuz
parents:
diff changeset
777 #define INSTR_ORDER_FILE_BUFFER_SIZE 131072
anatofuz
parents:
diff changeset
778 #define INSTR_ORDER_FILE_BUFFER_BITS 17
anatofuz
parents:
diff changeset
779 #define INSTR_ORDER_FILE_BUFFER_MASK 0x1ffff
anatofuz
parents:
diff changeset
780 #endif /* INSTR_ORDER_FILE_INC */
anatofuz
parents:
diff changeset
781 #else
anatofuz
parents:
diff changeset
782 #undef INSTR_PROF_DATA_DEFINED
anatofuz
parents:
diff changeset
783 #endif
173
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
784
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
785 #undef COVMAP_V2_OR_V3