1 /*===-- InstrProfData.inc - instr profiling runtime structures -----------=== *\
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 * This is the master file that defines all the data structure, signature,
11 * constant literals that are shared across profiling runtime library,
12 * compiler (instrumentation), and host tools (reader/writer). The entities
13 * defined in this file affect the profile runtime ABI, the raw profile format,
16 * The file has two identical copies. The master copy lives in LLVM and
17 * the other one sits in compiler-rt/lib/profile directory. To make changes
18 * in this file, first modify the master copy and copy it over to compiler-rt.
19 * Testing of any change in this file can start only after the two copies are
22 * The first part of the file includes macros that defines types, names, and
23 * initializers for the member fields of the core data structures. The field
24 * declarations for one structure is enabled by defining the field activation
25 * macro associated with that structure. Only one field activation record
26 * can be defined at one time and the rest definitions will be filtered out by
29 * Examples of how the template is used to instantiate structure definition:
30 * 1. To declare a structure:
33 * #define INSTR_PROF_DATA(Type, LLVMType, Name, Initializer) \
35 * #include "llvm/ProfileData/InstrProfData.inc"
38 * 2. To construct LLVM type arrays for the struct type:
40 * Type *DataTypes[] = {
41 * #define INSTR_PROF_DATA(Type, LLVMType, Name, Initializer) \
43 * #include "llvm/ProfileData/InstrProfData.inc"
46 * 4. To construct constant array for the initializers:
47 * #define INSTR_PROF_DATA(Type, LLVMType, Name, Initializer) \
49 * Constant *ConstantVals[] = {
50 * #include "llvm/ProfileData/InstrProfData.inc"
54 * The second part of the file includes definitions all other entities that
55 * are related to runtime ABI and format. When no field activation macro is
56 * defined, this file can be included to introduce the definitions.
58 \*===----------------------------------------------------------------------===*/
60 /* INSTR_PROF_DATA start. */
61 /* Definition of member fields of the per-function control structure. */
62 #ifndef INSTR_PROF_DATA
63 #define INSTR_PROF_DATA(Type, LLVMType, Name, Initializer)
65 #define INSTR_PROF_DATA_DEFINED
68 INSTR_PROF_DATA(const uint32_t, llvm::Type::getInt32Ty(Ctx), NameSize, \
69 ConstantInt::get(llvm::Type::getInt32Ty(Ctx), \
70 NamePtr->getType()->getPointerElementType()->getArrayNumElements()))
71 INSTR_PROF_DATA(const uint32_t, llvm::Type::getInt32Ty(Ctx), NumCounters, \
72 ConstantInt::get(llvm::Type::getInt32Ty(Ctx), NumCounters))
73 INSTR_PROF_DATA(const uint64_t, llvm::Type::getInt64Ty(Ctx), FuncHash, \
74 ConstantInt::get(llvm::Type::getInt64Ty(Ctx), \
75 Inc->getHash()->getZExtValue()))
76 INSTR_PROF_DATA(const IntPtrT, llvm::Type::getInt8PtrTy(Ctx), NamePtr, \
77 ConstantExpr::getBitCast(NamePtr, llvm::Type::getInt8PtrTy(Ctx)))
78 INSTR_PROF_DATA(const IntPtrT, llvm::Type::getInt64PtrTy(Ctx), CounterPtr, \
79 ConstantExpr::getBitCast(CounterPtr, \
80 llvm::Type::getInt64PtrTy(Ctx)))
81 INSTR_PROF_DATA(const IntPtrT, llvm::Type::getInt8PtrTy(Ctx), FunctionPointer, \
83 INSTR_PROF_DATA(IntPtrT, llvm::Type::getInt8PtrTy(Ctx), Values, \
84 ConstantPointerNull::get(Int8PtrTy))
85 INSTR_PROF_DATA(const uint16_t, Int16ArrayTy, NumValueSites[IPVK_Last+1], \
86 ConstantArray::get(Int16ArrayTy, Int16ArrayVals))
87 #undef INSTR_PROF_DATA
88 /* INSTR_PROF_DATA end. */
90 /* INSTR_PROF_RAW_HEADER start */
91 /* Definition of member fields of the raw profile header data structure. */
92 #ifndef INSTR_PROF_RAW_HEADER
93 #define INSTR_PROF_RAW_HEADER(Type, Name, Initializer)
95 #define INSTR_PROF_DATA_DEFINED
97 INSTR_PROF_RAW_HEADER(uint64_t, Magic, __llvm_profile_get_magic())
98 INSTR_PROF_RAW_HEADER(uint64_t, Version, __llvm_profile_get_version())
99 INSTR_PROF_RAW_HEADER(uint64_t, DataSize, DataSize)
100 INSTR_PROF_RAW_HEADER(uint64_t, CountersSize, CountersSize)
101 INSTR_PROF_RAW_HEADER(uint64_t, NamesSize, NamesSize)
102 INSTR_PROF_RAW_HEADER(uint64_t, CountersDelta, (uintptr_t)CountersBegin)
103 INSTR_PROF_RAW_HEADER(uint64_t, NamesDelta, (uintptr_t)NamesBegin)
104 INSTR_PROF_RAW_HEADER(uint64_t, ValueKindLast, IPVK_Last)
105 INSTR_PROF_RAW_HEADER(uint64_t, ValueDataSize, ValueDataSize)
106 INSTR_PROF_RAW_HEADER(uint64_t, ValueDataDelta, (uintptr_t)ValueDataBegin)
107 #undef INSTR_PROF_RAW_HEADER
108 /* INSTR_PROF_RAW_HEADER end */
110 /* VALUE_PROF_FUNC_PARAM start */
111 /* Definition of parameter types of the runtime API used to do value profiling
112 * for a given value site.
114 #ifndef VALUE_PROF_FUNC_PARAM
115 #define VALUE_PROF_FUNC_PARAM(ArgType, ArgName, ArgLLVMType)
116 #define INSTR_PROF_COMMA
118 #define INSTR_PROF_DATA_DEFINED
119 #define INSTR_PROF_COMMA ,
121 VALUE_PROF_FUNC_PARAM(uint64_t, TargetValue, Type::getInt64Ty(Ctx)) \
123 VALUE_PROF_FUNC_PARAM(void *, Data, Type::getInt8PtrTy(Ctx)) INSTR_PROF_COMMA
124 VALUE_PROF_FUNC_PARAM(uint32_t, CounterIndex, Type::getInt32Ty(Ctx))
125 #undef VALUE_PROF_FUNC_PARAM
126 #undef INSTR_PROF_COMMA
127 /* VALUE_PROF_FUNC_PARAM end */
129 /* VALUE_PROF_KIND start */
130 #ifndef VALUE_PROF_KIND
131 #define VALUE_PROF_KIND(Enumerator, Value)
133 #define INSTR_PROF_DATA_DEFINED
135 VALUE_PROF_KIND(IPVK_IndirectCallTarget, 0)
136 /* These two kinds must be the last to be
137 * declared. This is to make sure the string
138 * array created with the template can be
139 * indexed with the kind value.
141 VALUE_PROF_KIND(IPVK_First, IPVK_IndirectCallTarget)
142 VALUE_PROF_KIND(IPVK_Last, IPVK_IndirectCallTarget)
144 #undef VALUE_PROF_KIND
145 /* VALUE_PROF_KIND end */
147 /* COVMAP_FUNC_RECORD start */
148 /* Definition of member fields of the function record structure in coverage
151 #ifndef COVMAP_FUNC_RECORD
152 #define COVMAP_FUNC_RECORD(Type, LLVMType, Name, Initializer)
154 #define INSTR_PROF_DATA_DEFINED
156 COVMAP_FUNC_RECORD(const IntPtrT, llvm::Type::getInt8PtrTy(Ctx), \
157 NamePtr, llvm::ConstantExpr::getBitCast(NamePtr, \
158 llvm::Type::getInt8PtrTy(Ctx)))
159 COVMAP_FUNC_RECORD(const uint32_t, llvm::Type::getInt32Ty(Ctx), NameSize, \
160 llvm::ConstantInt::get(llvm::Type::getInt32Ty(Ctx),\
162 COVMAP_FUNC_RECORD(const uint32_t, llvm::Type::getInt32Ty(Ctx), DataSize, \
163 llvm::ConstantInt::get(llvm::Type::getInt32Ty(Ctx),\
164 CoverageMapping.size()))
165 COVMAP_FUNC_RECORD(const uint64_t, llvm::Type::getInt64Ty(Ctx), FuncHash, \
166 llvm::ConstantInt::get(llvm::Type::getInt64Ty(Ctx), FuncHash))
167 #undef COVMAP_FUNC_RECORD
168 /* COVMAP_FUNC_RECORD end. */
170 /* COVMAP_HEADER start */
171 /* Definition of member fields of coverage map header.
173 #ifndef COVMAP_HEADER
174 #define COVMAP_HEADER(Type, LLVMType, Name, Initializer)
176 #define INSTR_PROF_DATA_DEFINED
178 COVMAP_HEADER(uint32_t, Int32Ty, NRecords, \
179 llvm::ConstantInt::get(Int32Ty, FunctionRecords.size()))
180 COVMAP_HEADER(uint32_t, Int32Ty, FilenamesSize, \
181 llvm::ConstantInt::get(Int32Ty, FilenamesSize))
182 COVMAP_HEADER(uint32_t, Int32Ty, CoverageSize, \
183 llvm::ConstantInt::get(Int32Ty, CoverageMappingSize))
184 COVMAP_HEADER(uint32_t, Int32Ty, Version, \
185 llvm::ConstantInt::get(Int32Ty, CoverageMappingVersion1))
187 /* COVMAP_HEADER end. */
190 #ifdef INSTR_PROF_VALUE_PROF_DATA
191 #define INSTR_PROF_DATA_DEFINED
194 * This is the header of the data structure that defines the on-disk
195 * layout of the value profile data of a particular kind for one function.
197 typedef struct ValueProfRecord {
198 /* The kind of the value profile record. */
201 * The number of value profile sites. It is guaranteed to be non-zero;
202 * otherwise the record for this kind won't be emitted.
204 uint32_t NumValueSites;
206 * The first element of the array that stores the number of profiled
207 * values for each value site. The size of the array is NumValueSites.
208 * Since NumValueSites is greater than zero, there is at least one
209 * element in the array.
211 uint8_t SiteCountArray[1];
214 * The fake declaration is for documentation purpose only.
215 * Align the start of next field to be on 8 byte boundaries.
219 /* The array of value profile data. The size of the array is the sum
220 * of all elements in SiteCountArray[].
221 InstrProfValueData ValueData[];
226 * \brief Return the number of value sites.
228 uint32_t getNumValueSites() const { return NumValueSites; }
230 * \brief Read data from this record and save it to Record.
232 void deserializeTo(InstrProfRecord &Record,
233 InstrProfRecord::ValueMapType *VMap);
235 * In-place byte swap:
236 * Do byte swap for this instance. \c Old is the original order before
237 * the swap, and \c New is the New byte order.
239 void swapBytes(support::endianness Old, support::endianness New);
244 * Per-function header/control data structure for value profiling
245 * data in indexed format.
247 typedef struct ValueProfData {
249 * Total size in bytes including this field. It must be a multiple
250 * of sizeof(uint64_t).
254 *The number of value profile kinds that has value profile data.
255 * In this implementation, a value profile kind is considered to
256 * have profile data if the number of value profile sites for the
257 * kind is not zero. More aggressively, the implementation can
258 * choose to check the actual data value: if none of the value sites
259 * has any profiled values, the kind can be skipped.
261 uint32_t NumValueKinds;
264 * Following are a sequence of variable length records. The prefix/header
265 * of each record is defined by ValueProfRecord type. The number of
266 * records is NumValueKinds.
267 * ValueProfRecord Record_1;
268 * ValueProfRecord Record_N;
273 * Return the total size in bytes of the on-disk value profile data
274 * given the data stored in Record.
276 static uint32_t getSize(const InstrProfRecord &Record);
278 * Return a pointer to \c ValueProfData instance ready to be streamed.
280 static std::unique_ptr<ValueProfData>
281 serializeFrom(const InstrProfRecord &Record);
283 * Check the integrity of the record. Return the error code when
284 * an error is detected, otherwise return instrprof_error::success.
286 instrprof_error checkIntegrity();
288 * Return a pointer to \c ValueProfileData instance ready to be read.
289 * All data in the instance are properly byte swapped. The input
290 * data is assumed to be in little endian order.
292 static ErrorOr<std::unique_ptr<ValueProfData>>
293 getValueProfData(const unsigned char *SrcBuffer,
294 const unsigned char *const SrcBufferEnd,
295 support::endianness SrcDataEndianness);
297 * Swap byte order from \c Endianness order to host byte order.
299 void swapBytesToHost(support::endianness Endianness);
301 * Swap byte order from host byte order to \c Endianness order.
303 void swapBytesFromHost(support::endianness Endianness);
305 * Return the total size of \c ValueProfileData.
307 uint32_t getSize() const { return TotalSize; }
309 * Read data from this data and save it to \c Record.
311 void deserializeTo(InstrProfRecord &Record,
312 InstrProfRecord::ValueMapType *VMap);
313 void operator delete(void *ptr) { ::operator delete(ptr); }
318 * The closure is designed to abstact away two types of value profile data:
319 * - InstrProfRecord which is the primary data structure used to
320 * represent profile data in host tools (reader, writer, and profile-use)
321 * - value profile runtime data structure suitable to be used by C
324 * Both sources of data need to serialize to disk/memory-buffer in common
325 * format: ValueProfData. The abstraction allows compiler-rt's raw profiler
326 * writer to share the same format and code with indexed profile writer.
328 * For documentation of the member methods below, refer to corresponding methods
329 * in class InstrProfRecord.
331 typedef struct ValueProfRecordClosure {
333 uint32_t (*GetNumValueKinds)(const void *Record);
334 uint32_t (*GetNumValueSites)(const void *Record, uint32_t VKind);
335 uint32_t (*GetNumValueData)(const void *Record, uint32_t VKind);
336 uint32_t (*GetNumValueDataForSite)(const void *R, uint32_t VK, uint32_t S);
339 * After extracting the value profile data from the value profile record,
340 * this method is used to map the in-memory value to on-disk value. If
341 * the method is null, value will be written out untranslated.
343 uint64_t (*RemapValueData)(uint32_t, uint64_t Value);
344 void (*GetValueForSite)(const void *R, InstrProfValueData *Dst, uint32_t K,
345 uint32_t S, uint64_t (*Mapper)(uint32_t, uint64_t));
346 ValueProfData *(*AllocValueProfData)(size_t TotalSizeInBytes);
347 } ValueProfRecordClosure;
350 * A wrapper struct that represents value profile runtime data.
351 * Like InstrProfRecord class which is used by profiling host tools,
352 * ValueProfRuntimeRecord also implements the abstract intefaces defined in
353 * ValueProfRecordClosure so that the runtime data can be serialized using
354 * shared C implementation. In this structure, NumValueSites and Nodes
355 * members are the primary fields while other fields hold the derived
356 * information for fast implementation of closure interfaces.
358 typedef struct ValueProfRuntimeRecord {
359 /* Number of sites for each value profile kind. */
360 const uint16_t *NumValueSites;
361 /* An array of linked-list headers. The size of of the array is the
362 * total number of value profile sites : sum(NumValueSites[*])). Each
363 * linked-list stores the values profiled for a value profile site. */
364 ValueProfNode **Nodes;
366 /* Total number of value profile kinds which have at least one
367 * value profile sites. */
368 uint32_t NumValueKinds;
369 /* An array recording the number of values tracked at each site.
370 * The size of the array is TotalNumValueSites. */
371 uint8_t *SiteCountArray[IPVK_Last + 1];
372 ValueProfNode **NodesKind[IPVK_Last + 1];
373 } ValueProfRuntimeRecord;
375 /* Forward declarations of C interfaces. */
376 int initializeValueProfRuntimeRecord(ValueProfRuntimeRecord *RuntimeRecord,
377 const uint16_t *NumValueSites,
378 ValueProfNode **Nodes);
379 void finalizeValueProfRuntimeRecord(ValueProfRuntimeRecord *RuntimeRecord);
380 uint32_t getValueProfDataSizeRT(const ValueProfRuntimeRecord *Record);
382 serializeValueProfDataFromRT(const ValueProfRuntimeRecord *Record,
384 uint32_t getNumValueKindsRT(const void *R);
386 #undef INSTR_PROF_VALUE_PROF_DATA
387 #endif /* INSTR_PROF_VALUE_PROF_DATA */
390 #ifdef INSTR_PROF_COMMON_API_IMPL
391 #define INSTR_PROF_DATA_DEFINED
393 #define INSTR_PROF_INLINE inline
395 #define INSTR_PROF_INLINE
399 #define offsetof(TYPE, MEMBER) ((size_t) &((TYPE *)0)->MEMBER)
403 * \brief Return the \c ValueProfRecord header size including the
407 uint32_t getValueProfRecordHeaderSize(uint32_t NumValueSites) {
408 uint32_t Size = offsetof(ValueProfRecord, SiteCountArray) +
409 sizeof(uint8_t) * NumValueSites;
410 /* Round the size to multiple of 8 bytes. */
411 Size = (Size + 7) & ~7;
416 * \brief Return the total size of the value profile record including the
417 * header and the value data.
420 uint32_t getValueProfRecordSize(uint32_t NumValueSites,
421 uint32_t NumValueData) {
422 return getValueProfRecordHeaderSize(NumValueSites) +
423 sizeof(InstrProfValueData) * NumValueData;
427 * \brief Return the pointer to the start of value data array.
430 InstrProfValueData *getValueProfRecordValueData(ValueProfRecord *This) {
431 return (InstrProfValueData *)((char *)This + getValueProfRecordHeaderSize(
432 This->NumValueSites));
436 * \brief Return the total number of value data for \c This record.
439 uint32_t getValueProfRecordNumValueData(ValueProfRecord *This) {
440 uint32_t NumValueData = 0;
442 for (I = 0; I < This->NumValueSites; I++)
443 NumValueData += This->SiteCountArray[I];
448 * \brief Use this method to advance to the next \c This \c ValueProfRecord.
451 ValueProfRecord *getValueProfRecordNext(ValueProfRecord *This) {
452 uint32_t NumValueData = getValueProfRecordNumValueData(This);
453 return (ValueProfRecord *)((char *)This +
454 getValueProfRecordSize(This->NumValueSites,
459 * \brief Return the first \c ValueProfRecord instance.
462 ValueProfRecord *getFirstValueProfRecord(ValueProfData *This) {
463 return (ValueProfRecord *)((char *)This + sizeof(ValueProfData));
466 /* Closure based interfaces. */
469 * Return the total size in bytes of the on-disk value profile data
470 * given the data stored in Record.
472 uint32_t getValueProfDataSize(ValueProfRecordClosure *Closure) {
474 uint32_t TotalSize = sizeof(ValueProfData);
475 const void *Record = Closure->Record;
476 uint32_t NumValueKinds = Closure->GetNumValueKinds(Record);
477 if (NumValueKinds == 0)
480 for (Kind = IPVK_First; Kind <= IPVK_Last; Kind++) {
481 uint32_t NumValueSites = Closure->GetNumValueSites(Record, Kind);
484 TotalSize += getValueProfRecordSize(NumValueSites,
485 Closure->GetNumValueData(Record, Kind));
491 * Extract value profile data of a function for the profile kind \c ValueKind
492 * from the \c Closure and serialize the data into \c This record instance.
494 void serializeValueProfRecordFrom(ValueProfRecord *This,
495 ValueProfRecordClosure *Closure,
496 uint32_t ValueKind, uint32_t NumValueSites) {
498 const void *Record = Closure->Record;
499 This->Kind = ValueKind;
500 This->NumValueSites = NumValueSites;
501 InstrProfValueData *DstVD = getValueProfRecordValueData(This);
503 for (S = 0; S < NumValueSites; S++) {
504 uint32_t ND = Closure->GetNumValueDataForSite(Record, ValueKind, S);
505 This->SiteCountArray[S] = ND;
506 Closure->GetValueForSite(Record, DstVD, ValueKind, S,
507 Closure->RemapValueData);
513 * Extract value profile data of a function from the \c Closure
514 * and serialize the data into \c DstData if it is not NULL or heap
515 * memory allocated by the \c Closure's allocator method.
517 ValueProfData *serializeValueProfDataFrom(ValueProfRecordClosure *Closure,
518 ValueProfData *DstData) {
520 uint32_t TotalSize = getValueProfDataSize(Closure);
523 DstData ? DstData : Closure->AllocValueProfData(TotalSize);
525 VPD->TotalSize = TotalSize;
526 VPD->NumValueKinds = Closure->GetNumValueKinds(Closure->Record);
527 ValueProfRecord *VR = getFirstValueProfRecord(VPD);
528 for (Kind = IPVK_First; Kind <= IPVK_Last; Kind++) {
529 uint32_t NumValueSites = Closure->GetNumValueSites(Closure->Record, Kind);
532 serializeValueProfRecordFrom(VR, Closure, Kind, NumValueSites);
533 VR = getValueProfRecordNext(VR);
539 * The value profiler runtime library stores the value profile data
540 * for a given function in \c NumValueSites and \c Nodes structures.
541 * \c ValueProfRuntimeRecord class is used to encapsulate the runtime
542 * profile data and provides fast interfaces to retrieve the profile
543 * information. This interface is used to initialize the runtime record
544 * and pre-compute the information needed for efficient implementation
545 * of callbacks required by ValueProfRecordClosure class.
547 int initializeValueProfRuntimeRecord(ValueProfRuntimeRecord *RuntimeRecord,
548 const uint16_t *NumValueSites,
549 ValueProfNode **Nodes) {
550 unsigned I, J, S = 0, NumValueKinds = 0;
551 RuntimeRecord->NumValueSites = NumValueSites;
552 RuntimeRecord->Nodes = Nodes;
553 for (I = 0; I <= IPVK_Last; I++) {
554 uint16_t N = NumValueSites[I];
556 RuntimeRecord->SiteCountArray[I] = 0;
560 RuntimeRecord->SiteCountArray[I] = (uint8_t *)calloc(N, 1);
561 if (!RuntimeRecord->SiteCountArray[I])
563 RuntimeRecord->NodesKind[I] = Nodes ? &Nodes[S] : NULL;
564 for (J = 0; J < N; J++) {
565 /* Compute value count for each site. */
567 ValueProfNode *Site = Nodes ? RuntimeRecord->NodesKind[I][J] : NULL;
574 RuntimeRecord->SiteCountArray[I][J] = C;
578 RuntimeRecord->NumValueKinds = NumValueKinds;
582 void finalizeValueProfRuntimeRecord(ValueProfRuntimeRecord *RuntimeRecord) {
584 for (I = 0; I <= IPVK_Last; I++) {
585 if (RuntimeRecord->SiteCountArray[I])
586 free(RuntimeRecord->SiteCountArray[I]);
590 /* ValueProfRecordClosure Interface implementation for
591 * ValueProfDataRuntimeRecord. */
592 uint32_t getNumValueKindsRT(const void *R) {
593 return ((const ValueProfRuntimeRecord *)R)->NumValueKinds;
596 uint32_t getNumValueSitesRT(const void *R, uint32_t VK) {
597 return ((const ValueProfRuntimeRecord *)R)->NumValueSites[VK];
600 uint32_t getNumValueDataForSiteRT(const void *R, uint32_t VK, uint32_t S) {
601 const ValueProfRuntimeRecord *Record = (const ValueProfRuntimeRecord *)R;
602 return Record->SiteCountArray[VK][S];
605 uint32_t getNumValueDataRT(const void *R, uint32_t VK) {
607 const ValueProfRuntimeRecord *Record = (const ValueProfRuntimeRecord *)R;
608 if (Record->SiteCountArray[VK] == 0)
610 for (I = 0; I < Record->NumValueSites[VK]; I++)
611 S += Record->SiteCountArray[VK][I];
615 void getValueForSiteRT(const void *R, InstrProfValueData *Dst, uint32_t VK,
616 uint32_t S, uint64_t (*Mapper)(uint32_t, uint64_t)) {
618 const ValueProfRuntimeRecord *Record = (const ValueProfRuntimeRecord *)R;
619 N = getNumValueDataForSiteRT(R, VK, S);
622 ValueProfNode *VNode = Record->NodesKind[VK][S];
623 for (I = 0; I < N; I++) {
624 Dst[I] = VNode->VData;
629 ValueProfData *allocValueProfDataRT(size_t TotalSizeInBytes) {
630 return (ValueProfData *)calloc(TotalSizeInBytes, 1);
633 static ValueProfRecordClosure RTRecordClosure = {0,
637 getNumValueDataForSiteRT,
640 allocValueProfDataRT};
643 * Return the size of ValueProfData structure to store data
644 * recorded in the runtime record.
646 uint32_t getValueProfDataSizeRT(const ValueProfRuntimeRecord *Record) {
647 RTRecordClosure.Record = Record;
648 return getValueProfDataSize(&RTRecordClosure);
652 * Return a ValueProfData instance that stores the data collected
653 * from runtime. If \c DstData is provided by the caller, the value
654 * profile data will be store in *DstData and DstData is returned,
655 * otherwise the method will allocate space for the value data and
656 * return pointer to the newly allocated space.
659 serializeValueProfDataFromRT(const ValueProfRuntimeRecord *Record,
660 ValueProfData *DstData) {
661 RTRecordClosure.Record = Record;
662 return serializeValueProfDataFrom(&RTRecordClosure, DstData);
666 #undef INSTR_PROF_COMMON_API_IMPL
667 #endif /* INSTR_PROF_COMMON_API_IMPL */
669 /*============================================================================*/
672 #ifndef INSTR_PROF_DATA_DEFINED
674 #ifndef INSTR_PROF_DATA_INC_
675 #define INSTR_PROF_DATA_INC_
678 #define INSTR_PROF_SIMPLE_QUOTE(x) #x
679 #define INSTR_PROF_QUOTE(x) INSTR_PROF_SIMPLE_QUOTE(x)
680 #define INSTR_PROF_SIMPLE_CONCAT(x,y) x ## y
681 #define INSTR_PROF_CONCAT(x,y) INSTR_PROF_SIMPLE_CONCAT(x,y)
683 /* Magic number to detect file format and endianness.
684 * Use 255 at one end, since no UTF-8 file can use that character. Avoid 0,
685 * so that utilities, like strings, don't grab it as a string. 129 is also
686 * invalid UTF-8, and high enough to be interesting.
687 * Use "lprofr" in the centre to stand for "LLVM Profile Raw", or "lprofR"
688 * for 32-bit platforms.
690 #define INSTR_PROF_RAW_MAGIC_64 (uint64_t)255 << 56 | (uint64_t)'l' << 48 | \
691 (uint64_t)'p' << 40 | (uint64_t)'r' << 32 | (uint64_t)'o' << 24 | \
692 (uint64_t)'f' << 16 | (uint64_t)'r' << 8 | (uint64_t)129
693 #define INSTR_PROF_RAW_MAGIC_32 (uint64_t)255 << 56 | (uint64_t)'l' << 48 | \
694 (uint64_t)'p' << 40 | (uint64_t)'r' << 32 | (uint64_t)'o' << 24 | \
695 (uint64_t)'f' << 16 | (uint64_t)'R' << 8 | (uint64_t)129
697 /* Raw profile format version. */
698 #define INSTR_PROF_RAW_VERSION 2
700 /* Runtime section names and name strings. */
701 #define INSTR_PROF_DATA_SECT_NAME __llvm_prf_data
702 #define INSTR_PROF_NAME_SECT_NAME __llvm_prf_names
703 #define INSTR_PROF_CNTS_SECT_NAME __llvm_prf_cnts
705 #define INSTR_PROF_DATA_SECT_NAME_STR \
706 INSTR_PROF_QUOTE(INSTR_PROF_DATA_SECT_NAME)
707 #define INSTR_PROF_NAME_SECT_NAME_STR \
708 INSTR_PROF_QUOTE(INSTR_PROF_NAME_SECT_NAME)
709 #define INSTR_PROF_CNTS_SECT_NAME_STR \
710 INSTR_PROF_QUOTE(INSTR_PROF_CNTS_SECT_NAME)
712 /* Macros to define start/stop section symbol for a given
713 * section on Linux. For instance
714 * INSTR_PROF_SECT_START(INSTR_PROF_DATA_SECT_NAME) will
715 * expand to __start___llvm_prof_data
717 #define INSTR_PROF_SECT_START(Sect) \
718 INSTR_PROF_CONCAT(__start_,Sect)
719 #define INSTR_PROF_SECT_STOP(Sect) \
720 INSTR_PROF_CONCAT(__stop_,Sect)
722 /* Value Profiling API linkage name. */
723 #define INSTR_PROF_VALUE_PROF_FUNC __llvm_profile_instrument_target
724 #define INSTR_PROF_VALUE_PROF_FUNC_STR \
725 INSTR_PROF_QUOTE(INSTR_PROF_VALUE_PROF_FUNC)
727 /* InstrProfile per-function control data alignment. */
728 #define INSTR_PROF_DATA_ALIGNMENT 8
730 /* The data structure that represents a tracked value by the
733 typedef struct InstrProfValueData {
734 /* Profiled value. */
736 /* Number of times the value appears in the training run. */
738 } InstrProfValueData;
740 /* This is an internal data structure used by value profiler. It
741 * is defined here to allow serialization code sharing by LLVM
742 * to be used in unit test.
744 typedef struct ValueProfNode {
745 InstrProfValueData VData;
746 struct ValueProfNode *Next;
749 #endif /* INSTR_PROF_DATA_INC_ */
752 #undef INSTR_PROF_DATA_DEFINED