1 /*===-- InstrProfData.inc - instr profiling runtime structures -*- C++ -*-=== *\
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, CoverageMappingCurrentVersion))
187 /* COVMAP_HEADER end. */
190 #ifdef INSTR_PROF_VALUE_PROF_DATA
191 #define INSTR_PROF_DATA_DEFINED
193 #define INSTR_PROF_MAX_NUM_VAL_PER_SITE 255
195 * This is the header of the data structure that defines the on-disk
196 * layout of the value profile data of a particular kind for one function.
198 typedef struct ValueProfRecord {
199 /* The kind of the value profile record. */
202 * The number of value profile sites. It is guaranteed to be non-zero;
203 * otherwise the record for this kind won't be emitted.
205 uint32_t NumValueSites;
207 * The first element of the array that stores the number of profiled
208 * values for each value site. The size of the array is NumValueSites.
209 * Since NumValueSites is greater than zero, there is at least one
210 * element in the array.
212 uint8_t SiteCountArray[1];
215 * The fake declaration is for documentation purpose only.
216 * Align the start of next field to be on 8 byte boundaries.
220 /* The array of value profile data. The size of the array is the sum
221 * of all elements in SiteCountArray[].
222 InstrProfValueData ValueData[];
227 * \brief Return the number of value sites.
229 uint32_t getNumValueSites() const { return NumValueSites; }
231 * \brief Read data from this record and save it to Record.
233 void deserializeTo(InstrProfRecord &Record,
234 InstrProfRecord::ValueMapType *VMap);
236 * In-place byte swap:
237 * Do byte swap for this instance. \c Old is the original order before
238 * the swap, and \c New is the New byte order.
240 void swapBytes(support::endianness Old, support::endianness New);
245 * Per-function header/control data structure for value profiling
246 * data in indexed format.
248 typedef struct ValueProfData {
250 * Total size in bytes including this field. It must be a multiple
251 * of sizeof(uint64_t).
255 *The number of value profile kinds that has value profile data.
256 * In this implementation, a value profile kind is considered to
257 * have profile data if the number of value profile sites for the
258 * kind is not zero. More aggressively, the implementation can
259 * choose to check the actual data value: if none of the value sites
260 * has any profiled values, the kind can be skipped.
262 uint32_t NumValueKinds;
265 * Following are a sequence of variable length records. The prefix/header
266 * of each record is defined by ValueProfRecord type. The number of
267 * records is NumValueKinds.
268 * ValueProfRecord Record_1;
269 * ValueProfRecord Record_N;
274 * Return the total size in bytes of the on-disk value profile data
275 * given the data stored in Record.
277 static uint32_t getSize(const InstrProfRecord &Record);
279 * Return a pointer to \c ValueProfData instance ready to be streamed.
281 static std::unique_ptr<ValueProfData>
282 serializeFrom(const InstrProfRecord &Record);
284 * Check the integrity of the record. Return the error code when
285 * an error is detected, otherwise return instrprof_error::success.
287 instrprof_error checkIntegrity();
289 * Return a pointer to \c ValueProfileData instance ready to be read.
290 * All data in the instance are properly byte swapped. The input
291 * data is assumed to be in little endian order.
293 static ErrorOr<std::unique_ptr<ValueProfData>>
294 getValueProfData(const unsigned char *SrcBuffer,
295 const unsigned char *const SrcBufferEnd,
296 support::endianness SrcDataEndianness);
298 * Swap byte order from \c Endianness order to host byte order.
300 void swapBytesToHost(support::endianness Endianness);
302 * Swap byte order from host byte order to \c Endianness order.
304 void swapBytesFromHost(support::endianness Endianness);
306 * Return the total size of \c ValueProfileData.
308 uint32_t getSize() const { return TotalSize; }
310 * Read data from this data and save it to \c Record.
312 void deserializeTo(InstrProfRecord &Record,
313 InstrProfRecord::ValueMapType *VMap);
314 void operator delete(void *ptr) { ::operator delete(ptr); }
319 * The closure is designed to abstact away two types of value profile data:
320 * - InstrProfRecord which is the primary data structure used to
321 * represent profile data in host tools (reader, writer, and profile-use)
322 * - value profile runtime data structure suitable to be used by C
325 * Both sources of data need to serialize to disk/memory-buffer in common
326 * format: ValueProfData. The abstraction allows compiler-rt's raw profiler
327 * writer to share the same format and code with indexed profile writer.
329 * For documentation of the member methods below, refer to corresponding methods
330 * in class InstrProfRecord.
332 typedef struct ValueProfRecordClosure {
334 uint32_t (*GetNumValueKinds)(const void *Record);
335 uint32_t (*GetNumValueSites)(const void *Record, uint32_t VKind);
336 uint32_t (*GetNumValueData)(const void *Record, uint32_t VKind);
337 uint32_t (*GetNumValueDataForSite)(const void *R, uint32_t VK, uint32_t S);
340 * After extracting the value profile data from the value profile record,
341 * this method is used to map the in-memory value to on-disk value. If
342 * the method is null, value will be written out untranslated.
344 uint64_t (*RemapValueData)(uint32_t, uint64_t Value);
345 void (*GetValueForSite)(const void *R, InstrProfValueData *Dst, uint32_t K,
346 uint32_t S, uint64_t (*Mapper)(uint32_t, uint64_t));
347 ValueProfData *(*AllocValueProfData)(size_t TotalSizeInBytes);
348 } ValueProfRecordClosure;
351 * A wrapper struct that represents value profile runtime data.
352 * Like InstrProfRecord class which is used by profiling host tools,
353 * ValueProfRuntimeRecord also implements the abstract intefaces defined in
354 * ValueProfRecordClosure so that the runtime data can be serialized using
355 * shared C implementation. In this structure, NumValueSites and Nodes
356 * members are the primary fields while other fields hold the derived
357 * information for fast implementation of closure interfaces.
359 typedef struct ValueProfRuntimeRecord {
360 /* Number of sites for each value profile kind. */
361 const uint16_t *NumValueSites;
362 /* An array of linked-list headers. The size of of the array is the
363 * total number of value profile sites : sum(NumValueSites[*])). Each
364 * linked-list stores the values profiled for a value profile site. */
365 ValueProfNode **Nodes;
367 /* Total number of value profile kinds which have at least one
368 * value profile sites. */
369 uint32_t NumValueKinds;
370 /* An array recording the number of values tracked at each site.
371 * The size of the array is TotalNumValueSites. */
372 uint8_t *SiteCountArray[IPVK_Last + 1];
373 ValueProfNode **NodesKind[IPVK_Last + 1];
374 } ValueProfRuntimeRecord;
376 /* Forward declarations of C interfaces. */
377 int initializeValueProfRuntimeRecord(ValueProfRuntimeRecord *RuntimeRecord,
378 const uint16_t *NumValueSites,
379 ValueProfNode **Nodes);
380 void finalizeValueProfRuntimeRecord(ValueProfRuntimeRecord *RuntimeRecord);
381 uint32_t getValueProfDataSizeRT(const ValueProfRuntimeRecord *Record);
383 serializeValueProfDataFromRT(const ValueProfRuntimeRecord *Record,
385 uint32_t getNumValueKindsRT(const void *R);
387 #undef INSTR_PROF_VALUE_PROF_DATA
388 #endif /* INSTR_PROF_VALUE_PROF_DATA */
391 #ifdef INSTR_PROF_COMMON_API_IMPL
392 #define INSTR_PROF_DATA_DEFINED
394 #define INSTR_PROF_INLINE inline
396 #define INSTR_PROF_INLINE
400 #define offsetof(TYPE, MEMBER) ((size_t) &((TYPE *)0)->MEMBER)
404 * \brief Return the \c ValueProfRecord header size including the
408 uint32_t getValueProfRecordHeaderSize(uint32_t NumValueSites) {
409 uint32_t Size = offsetof(ValueProfRecord, SiteCountArray) +
410 sizeof(uint8_t) * NumValueSites;
411 /* Round the size to multiple of 8 bytes. */
412 Size = (Size + 7) & ~7;
417 * \brief Return the total size of the value profile record including the
418 * header and the value data.
421 uint32_t getValueProfRecordSize(uint32_t NumValueSites,
422 uint32_t NumValueData) {
423 return getValueProfRecordHeaderSize(NumValueSites) +
424 sizeof(InstrProfValueData) * NumValueData;
428 * \brief Return the pointer to the start of value data array.
431 InstrProfValueData *getValueProfRecordValueData(ValueProfRecord *This) {
432 return (InstrProfValueData *)((char *)This + getValueProfRecordHeaderSize(
433 This->NumValueSites));
437 * \brief Return the total number of value data for \c This record.
440 uint32_t getValueProfRecordNumValueData(ValueProfRecord *This) {
441 uint32_t NumValueData = 0;
443 for (I = 0; I < This->NumValueSites; I++)
444 NumValueData += This->SiteCountArray[I];
449 * \brief Use this method to advance to the next \c This \c ValueProfRecord.
452 ValueProfRecord *getValueProfRecordNext(ValueProfRecord *This) {
453 uint32_t NumValueData = getValueProfRecordNumValueData(This);
454 return (ValueProfRecord *)((char *)This +
455 getValueProfRecordSize(This->NumValueSites,
460 * \brief Return the first \c ValueProfRecord instance.
463 ValueProfRecord *getFirstValueProfRecord(ValueProfData *This) {
464 return (ValueProfRecord *)((char *)This + sizeof(ValueProfData));
467 /* Closure based interfaces. */
470 * Return the total size in bytes of the on-disk value profile data
471 * given the data stored in Record.
473 uint32_t getValueProfDataSize(ValueProfRecordClosure *Closure) {
475 uint32_t TotalSize = sizeof(ValueProfData);
476 const void *Record = Closure->Record;
477 uint32_t NumValueKinds = Closure->GetNumValueKinds(Record);
478 if (NumValueKinds == 0)
481 for (Kind = IPVK_First; Kind <= IPVK_Last; Kind++) {
482 uint32_t NumValueSites = Closure->GetNumValueSites(Record, Kind);
485 TotalSize += getValueProfRecordSize(NumValueSites,
486 Closure->GetNumValueData(Record, Kind));
492 * Extract value profile data of a function for the profile kind \c ValueKind
493 * from the \c Closure and serialize the data into \c This record instance.
495 void serializeValueProfRecordFrom(ValueProfRecord *This,
496 ValueProfRecordClosure *Closure,
497 uint32_t ValueKind, uint32_t NumValueSites) {
499 const void *Record = Closure->Record;
500 This->Kind = ValueKind;
501 This->NumValueSites = NumValueSites;
502 InstrProfValueData *DstVD = getValueProfRecordValueData(This);
504 for (S = 0; S < NumValueSites; S++) {
505 uint32_t ND = Closure->GetNumValueDataForSite(Record, ValueKind, S);
506 This->SiteCountArray[S] = ND;
507 Closure->GetValueForSite(Record, DstVD, ValueKind, S,
508 Closure->RemapValueData);
514 * Extract value profile data of a function from the \c Closure
515 * and serialize the data into \c DstData if it is not NULL or heap
516 * memory allocated by the \c Closure's allocator method.
518 ValueProfData *serializeValueProfDataFrom(ValueProfRecordClosure *Closure,
519 ValueProfData *DstData) {
521 uint32_t TotalSize = getValueProfDataSize(Closure);
524 DstData ? DstData : Closure->AllocValueProfData(TotalSize);
526 VPD->TotalSize = TotalSize;
527 VPD->NumValueKinds = Closure->GetNumValueKinds(Closure->Record);
528 ValueProfRecord *VR = getFirstValueProfRecord(VPD);
529 for (Kind = IPVK_First; Kind <= IPVK_Last; Kind++) {
530 uint32_t NumValueSites = Closure->GetNumValueSites(Closure->Record, Kind);
533 serializeValueProfRecordFrom(VR, Closure, Kind, NumValueSites);
534 VR = getValueProfRecordNext(VR);
540 * The value profiler runtime library stores the value profile data
541 * for a given function in \c NumValueSites and \c Nodes structures.
542 * \c ValueProfRuntimeRecord class is used to encapsulate the runtime
543 * profile data and provides fast interfaces to retrieve the profile
544 * information. This interface is used to initialize the runtime record
545 * and pre-compute the information needed for efficient implementation
546 * of callbacks required by ValueProfRecordClosure class.
548 int initializeValueProfRuntimeRecord(ValueProfRuntimeRecord *RuntimeRecord,
549 const uint16_t *NumValueSites,
550 ValueProfNode **Nodes) {
551 unsigned I, J, S = 0, NumValueKinds = 0;
552 RuntimeRecord->NumValueSites = NumValueSites;
553 RuntimeRecord->Nodes = Nodes;
554 for (I = 0; I <= IPVK_Last; I++) {
555 uint16_t N = NumValueSites[I];
557 RuntimeRecord->SiteCountArray[I] = 0;
561 RuntimeRecord->SiteCountArray[I] = (uint8_t *)calloc(N, 1);
562 if (!RuntimeRecord->SiteCountArray[I])
564 RuntimeRecord->NodesKind[I] = Nodes ? &Nodes[S] : NULL;
565 for (J = 0; J < N; J++) {
566 /* Compute value count for each site. */
568 ValueProfNode *Site = Nodes ? RuntimeRecord->NodesKind[I][J] : NULL;
575 RuntimeRecord->SiteCountArray[I][J] = C;
579 RuntimeRecord->NumValueKinds = NumValueKinds;
583 void finalizeValueProfRuntimeRecord(ValueProfRuntimeRecord *RuntimeRecord) {
585 for (I = 0; I <= IPVK_Last; I++) {
586 if (RuntimeRecord->SiteCountArray[I])
587 free(RuntimeRecord->SiteCountArray[I]);
591 /* ValueProfRecordClosure Interface implementation for
592 * ValueProfDataRuntimeRecord. */
593 uint32_t getNumValueKindsRT(const void *R) {
594 return ((const ValueProfRuntimeRecord *)R)->NumValueKinds;
597 uint32_t getNumValueSitesRT(const void *R, uint32_t VK) {
598 return ((const ValueProfRuntimeRecord *)R)->NumValueSites[VK];
601 uint32_t getNumValueDataForSiteRT(const void *R, uint32_t VK, uint32_t S) {
602 const ValueProfRuntimeRecord *Record = (const ValueProfRuntimeRecord *)R;
603 return Record->SiteCountArray[VK][S];
606 uint32_t getNumValueDataRT(const void *R, uint32_t VK) {
608 const ValueProfRuntimeRecord *Record = (const ValueProfRuntimeRecord *)R;
609 if (Record->SiteCountArray[VK] == 0)
611 for (I = 0; I < Record->NumValueSites[VK]; I++)
612 S += Record->SiteCountArray[VK][I];
616 void getValueForSiteRT(const void *R, InstrProfValueData *Dst, uint32_t VK,
617 uint32_t S, uint64_t (*Mapper)(uint32_t, uint64_t)) {
619 const ValueProfRuntimeRecord *Record = (const ValueProfRuntimeRecord *)R;
620 N = getNumValueDataForSiteRT(R, VK, S);
623 ValueProfNode *VNode = Record->NodesKind[VK][S];
624 for (I = 0; I < N; I++) {
625 Dst[I] = VNode->VData;
630 ValueProfData *allocValueProfDataRT(size_t TotalSizeInBytes) {
631 return (ValueProfData *)calloc(TotalSizeInBytes, 1);
634 static ValueProfRecordClosure RTRecordClosure = {0,
638 getNumValueDataForSiteRT,
641 allocValueProfDataRT};
644 * Return the size of ValueProfData structure to store data
645 * recorded in the runtime record.
647 uint32_t getValueProfDataSizeRT(const ValueProfRuntimeRecord *Record) {
648 RTRecordClosure.Record = Record;
649 return getValueProfDataSize(&RTRecordClosure);
653 * Return a ValueProfData instance that stores the data collected
654 * from runtime. If \c DstData is provided by the caller, the value
655 * profile data will be store in *DstData and DstData is returned,
656 * otherwise the method will allocate space for the value data and
657 * return pointer to the newly allocated space.
660 serializeValueProfDataFromRT(const ValueProfRuntimeRecord *Record,
661 ValueProfData *DstData) {
662 RTRecordClosure.Record = Record;
663 return serializeValueProfDataFrom(&RTRecordClosure, DstData);
667 #undef INSTR_PROF_COMMON_API_IMPL
668 #endif /* INSTR_PROF_COMMON_API_IMPL */
670 /*============================================================================*/
673 #ifndef INSTR_PROF_DATA_DEFINED
675 #ifndef INSTR_PROF_DATA_INC_
676 #define INSTR_PROF_DATA_INC_
679 #define INSTR_PROF_SIMPLE_QUOTE(x) #x
680 #define INSTR_PROF_QUOTE(x) INSTR_PROF_SIMPLE_QUOTE(x)
681 #define INSTR_PROF_SIMPLE_CONCAT(x,y) x ## y
682 #define INSTR_PROF_CONCAT(x,y) INSTR_PROF_SIMPLE_CONCAT(x,y)
684 /* Magic number to detect file format and endianness.
685 * Use 255 at one end, since no UTF-8 file can use that character. Avoid 0,
686 * so that utilities, like strings, don't grab it as a string. 129 is also
687 * invalid UTF-8, and high enough to be interesting.
688 * Use "lprofr" in the centre to stand for "LLVM Profile Raw", or "lprofR"
689 * for 32-bit platforms.
691 #define INSTR_PROF_RAW_MAGIC_64 (uint64_t)255 << 56 | (uint64_t)'l' << 48 | \
692 (uint64_t)'p' << 40 | (uint64_t)'r' << 32 | (uint64_t)'o' << 24 | \
693 (uint64_t)'f' << 16 | (uint64_t)'r' << 8 | (uint64_t)129
694 #define INSTR_PROF_RAW_MAGIC_32 (uint64_t)255 << 56 | (uint64_t)'l' << 48 | \
695 (uint64_t)'p' << 40 | (uint64_t)'r' << 32 | (uint64_t)'o' << 24 | \
696 (uint64_t)'f' << 16 | (uint64_t)'R' << 8 | (uint64_t)129
698 /* Raw profile format version. */
699 #define INSTR_PROF_RAW_VERSION 2
700 #define INSTR_PROF_INDEX_VERSION 3
701 #define INSTR_PROF_COVMAP_VERSION 0
703 /* Profile version is always of type uint_64_t. Reserve the upper 8 bits in the
704 * version for other variants of profile. We set the lowest bit of the upper 8
705 * bits (i.e. bit 56) to 1 to indicate if this is an IR-level instrumentaiton
706 * generated profile, and 0 if this is a Clang FE generated profile.
708 #define VARIANT_MASKS_ALL 0xff00000000000000ULL
709 #define GET_VERSION(V) ((V) & ~VARIANT_MASKS_ALL)
711 /* Runtime section names and name strings. */
712 #define INSTR_PROF_DATA_SECT_NAME __llvm_prf_data
713 #define INSTR_PROF_NAME_SECT_NAME __llvm_prf_names
714 #define INSTR_PROF_CNTS_SECT_NAME __llvm_prf_cnts
715 #define INSTR_PROF_COVMAP_SECT_NAME __llvm_covmap
717 #define INSTR_PROF_DATA_SECT_NAME_STR \
718 INSTR_PROF_QUOTE(INSTR_PROF_DATA_SECT_NAME)
719 #define INSTR_PROF_NAME_SECT_NAME_STR \
720 INSTR_PROF_QUOTE(INSTR_PROF_NAME_SECT_NAME)
721 #define INSTR_PROF_CNTS_SECT_NAME_STR \
722 INSTR_PROF_QUOTE(INSTR_PROF_CNTS_SECT_NAME)
723 #define INSTR_PROF_COVMAP_SECT_NAME_STR \
724 INSTR_PROF_QUOTE(INSTR_PROF_COVMAP_SECT_NAME)
726 /* Macros to define start/stop section symbol for a given
727 * section on Linux. For instance
728 * INSTR_PROF_SECT_START(INSTR_PROF_DATA_SECT_NAME) will
729 * expand to __start___llvm_prof_data
731 #define INSTR_PROF_SECT_START(Sect) \
732 INSTR_PROF_CONCAT(__start_,Sect)
733 #define INSTR_PROF_SECT_STOP(Sect) \
734 INSTR_PROF_CONCAT(__stop_,Sect)
736 /* Value Profiling API linkage name. */
737 #define INSTR_PROF_VALUE_PROF_FUNC __llvm_profile_instrument_target
738 #define INSTR_PROF_VALUE_PROF_FUNC_STR \
739 INSTR_PROF_QUOTE(INSTR_PROF_VALUE_PROF_FUNC)
741 /* InstrProfile per-function control data alignment. */
742 #define INSTR_PROF_DATA_ALIGNMENT 8
744 /* The data structure that represents a tracked value by the
747 typedef struct InstrProfValueData {
748 /* Profiled value. */
750 /* Number of times the value appears in the training run. */
752 } InstrProfValueData;
754 /* This is an internal data structure used by value profiler. It
755 * is defined here to allow serialization code sharing by LLVM
756 * to be used in unit test.
758 typedef struct ValueProfNode {
759 InstrProfValueData VData;
760 struct ValueProfNode *Next;
763 #endif /* INSTR_PROF_DATA_INC_ */
766 #undef INSTR_PROF_DATA_DEFINED