include/llvm/ProfileData/InstrProfData.inc

   1 /*===-- InstrProfData.inc - instr profiling runtime structures -----------=== *\
   2 |*
   3 |*                     The LLVM Compiler Infrastructure
   4 |*
   5 |* This file is distributed under the University of Illinois Open Source
   6 |* License. See LICENSE.TXT for details.
   7 |*
   8 \*===----------------------------------------------------------------------===*/
   9 /*
  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,
  14  * or both.
  15  *
  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
  20  * synced up.
  21  *
  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
  27  * the preprocessor.
  28  *
  29  * Examples of how the template is used to instantiate structure definition:
  30  * 1. To declare a structure:
  31  *
  32  * struct ProfData {
  33  * #define INSTR_PROF_DATA(Type, LLVMType, Name, Initializer) \
  34  *    Type Name;
  35  * #include "llvm/ProfileData/InstrProfData.inc"
  36  * };
  37  *
  38  * 2. To construct LLVM type arrays for the struct type:
  39  *
  40  * Type *DataTypes[] = {
  41  * #define INSTR_PROF_DATA(Type, LLVMType, Name, Initializer) \
  42  *   LLVMType,
  43  * #include "llvm/ProfileData/InstrProfData.inc"
  44  * };
  45  *
  46  * 4. To construct constant array for the initializers:
  47  * #define INSTR_PROF_DATA(Type, LLVMType, Name, Initializer) \
  48  *   Initializer,
  49  * Constant *ConstantVals[] = {
  50  * #include "llvm/ProfileData/InstrProfData.inc"
  51  * };
  52  *
  53  *
  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.
  57  *
  58 \*===----------------------------------------------------------------------===*/
  59
  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)
  64 #else
  65 #define INSTR_PROF_DATA_DEFINED
  66 #endif
  67
  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, \
  82                 FunctionAddr)
  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. */
  89
  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)
  94 #else
  95 #define INSTR_PROF_DATA_DEFINED
  96 #endif
  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 */
 109
 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.
 113  */
 114 #ifndef VALUE_PROF_FUNC_PARAM
 115 #define VALUE_PROF_FUNC_PARAM(ArgType, ArgName, ArgLLVMType)
 116 #define INSTR_PROF_COMMA
 117 #else
 118 #define INSTR_PROF_DATA_DEFINED
 119 #define INSTR_PROF_COMMA ,
 120 #endif
 121 VALUE_PROF_FUNC_PARAM(uint64_t, TargetValue, Type::getInt64Ty(Ctx)) \
 122                       INSTR_PROF_COMMA
 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 */
 128
 129 /* VALUE_PROF_KIND start */
 130 #ifndef VALUE_PROF_KIND
 131 #define VALUE_PROF_KIND(Enumerator, Value)
 132 #else
 133 #define INSTR_PROF_DATA_DEFINED
 134 #endif
 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.
 140  */
 141 VALUE_PROF_KIND(IPVK_First, IPVK_IndirectCallTarget)
 142 VALUE_PROF_KIND(IPVK_Last, IPVK_IndirectCallTarget)
 143
 144 #undef VALUE_PROF_KIND
 145 /* VALUE_PROF_KIND end */
 146
 147 /* COVMAP_FUNC_RECORD start */
 148 /* Definition of member fields of the function record structure in coverage
 149  * map.
 150  */
 151 #ifndef COVMAP_FUNC_RECORD
 152 #define COVMAP_FUNC_RECORD(Type, LLVMType, Name, Initializer)
 153 #else
 154 #define INSTR_PROF_DATA_DEFINED
 155 #endif
 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),\
 161                    NameValue.size()))
 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.  */
 169
 170
 171 #ifdef INSTR_PROF_VALUE_PROF_DATA
 172 #define INSTR_PROF_DATA_DEFINED
 173
 174 /*!
 175  * This is the header of the data structure that defines the on-disk
 176  * layout of the value profile data of a particular kind for one function.
 177  */
 178 typedef struct ValueProfRecord {
 179   /* The kind of the value profile record. */
 180   uint32_t Kind;
 181   /*
 182    * The number of value profile sites. It is guaranteed to be non-zero;
 183    * otherwise the record for this kind won't be emitted.
 184    */
 185   uint32_t NumValueSites;
 186   /*
 187    * The first element of the array that stores the number of profiled
 188    * values for each value site. The size of the array is NumValueSites.
 189    * Since NumValueSites is greater than zero, there is at least one
 190    * element in the array.
 191    */
 192   uint8_t SiteCountArray[1];
 193
 194   /*
 195    * The fake declaration is for documentation purpose only.
 196    * Align the start of next field to be on 8 byte boundaries.
 197   uint8_t Padding[X];
 198    */
 199
 200   /* The array of value profile data. The size of the array is the sum
 201    * of all elements in SiteCountArray[].
 202   InstrProfValueData ValueData[];
 203    */
 204
 205 #ifdef __cplusplus
 206   /*!
 207    * \brief Return the number of value sites.
 208    */
 209   uint32_t getNumValueSites() const { return NumValueSites; }
 210   /*!
 211    * \brief Read data from this record and save it to Record.
 212    */
 213   void deserializeTo(InstrProfRecord &Record,
 214                      InstrProfRecord::ValueMapType *VMap);
 215   /*
 216    * In-place byte swap:
 217    * Do byte swap for this instance. \c Old is the original order before
 218    * the swap, and \c New is the New byte order.
 219    */
 220   void swapBytes(support::endianness Old, support::endianness New);
 221 #endif
 222 } ValueProfRecord;
 223
 224 /*!
 225  * Per-function header/control data structure for value profiling
 226  * data in indexed format.
 227  */
 228 typedef struct ValueProfData {
 229   /*
 230    * Total size in bytes including this field. It must be a multiple
 231    * of sizeof(uint64_t).
 232    */
 233   uint32_t TotalSize;
 234   /*
 235    *The number of value profile kinds that has value profile data.
 236    * In this implementation, a value profile kind is considered to
 237    * have profile data if the number of value profile sites for the
 238    * kind is not zero. More aggressively, the implementation can
 239    * choose to check the actual data value: if none of the value sites
 240    * has any profiled values, the kind can be skipped.
 241    */
 242   uint32_t NumValueKinds;
 243
 244   /*
 245    * Following are a sequence of variable length records. The prefix/header
 246    * of each record is defined by ValueProfRecord type. The number of
 247    * records is NumValueKinds.
 248    * ValueProfRecord Record_1;
 249    * ValueProfRecord Record_N;
 250    */
 251
 252 #if __cplusplus
 253   /*!
 254    * Return the total size in bytes of the on-disk value profile data
 255    * given the data stored in Record.
 256    */
 257   static uint32_t getSize(const InstrProfRecord &Record);
 258   /*!
 259    * Return a pointer to \c ValueProfData instance ready to be streamed.
 260    */
 261   static std::unique_ptr<ValueProfData>
 262   serializeFrom(const InstrProfRecord &Record);
 263   /*!
 264    * Check the integrity of the record. Return the error code when
 265    * an error is detected, otherwise return instrprof_error::success.
 266    */
 267   instrprof_error checkIntegrity();
 268   /*!
 269    * Return a pointer to \c ValueProfileData instance ready to be read.
 270    * All data in the instance are properly byte swapped. The input
 271    * data is assumed to be in little endian order.
 272    */
 273   static ErrorOr<std::unique_ptr<ValueProfData>>
 274   getValueProfData(const unsigned char *SrcBuffer,
 275                    const unsigned char *const SrcBufferEnd,
 276                    support::endianness SrcDataEndianness);
 277   /*!
 278    * Swap byte order from \c Endianness order to host byte order.
 279    */
 280   void swapBytesToHost(support::endianness Endianness);
 281   /*!
 282    * Swap byte order from host byte order to \c Endianness order.
 283    */
 284   void swapBytesFromHost(support::endianness Endianness);
 285   /*!
 286    * Return the total size of \c ValueProfileData.
 287    */
 288   uint32_t getSize() const { return TotalSize; }
 289   /*!
 290    * Read data from this data and save it to \c Record.
 291    */
 292   void deserializeTo(InstrProfRecord &Record,
 293                      InstrProfRecord::ValueMapType *VMap);
 294 #endif
 295 } ValueProfData;
 296
 297 /*
 298  * The closure is designed to abstact away two types of value profile data:
 299  * - InstrProfRecord which is the primary data structure used to
 300  *   represent profile data in host tools (reader, writer, and profile-use)
 301  * - value profile runtime data structure suitable to be used by C
 302  *   runtime library.
 303  *
 304  * Both sources of data need to serialize to disk/memory-buffer in common
 305  * format: ValueProfData. The abstraction allows compiler-rt's raw profiler
 306  * writer to share the same format and code with indexed profile writer.
 307  *
 308  * For documentation of the member methods below, refer to corresponding methods
 309  * in class InstrProfRecord.
 310  */
 311 typedef struct ValueProfRecordClosure {
 312   const void *Record;
 313   uint32_t (*GetNumValueKinds)(const void *Record);
 314   uint32_t (*GetNumValueSites)(const void *Record, uint32_t VKind);
 315   uint32_t (*GetNumValueData)(const void *Record, uint32_t VKind);
 316   uint32_t (*GetNumValueDataForSite)(const void *R, uint32_t VK, uint32_t S);
 317
 318   /*
 319    * After extracting the value profile data from the value profile record,
 320    * this method is used to map the in-memory value to on-disk value. If
 321    * the method is null, value will be written out untranslated.
 322    */
 323   uint64_t (*RemapValueData)(uint32_t, uint64_t Value);
 324   void (*GetValueForSite)(const void *R, InstrProfValueData *Dst, uint32_t K,
 325                           uint32_t S, uint64_t (*Mapper)(uint32_t, uint64_t));
 326   ValueProfData *(*AllocValueProfData)(size_t TotalSizeInBytes);
 327 } ValueProfRecordClosure;
 328
 329 /*
 330  * A wrapper struct that represents value profile runtime data.
 331  * Like InstrProfRecord class which is used by profiling host tools,
 332  * ValueProfRuntimeRecord also implements the abstract intefaces defined in
 333  * ValueProfRecordClosure so that the runtime data can be serialized using
 334  * shared C implementation. In this structure, NumValueSites and Nodes
 335  * members are the primary fields while other fields hold the derived
 336  * information for fast implementation of closure interfaces.
 337  */
 338 typedef struct ValueProfRuntimeRecord {
 339   /* Number of sites for each value profile kind.  */
 340   const uint16_t *NumValueSites;
 341   /* An array of linked-list headers. The size of of the array is the
 342    * total number of value profile sites : sum(NumValueSites[*])). Each
 343    * linked-list stores the values profiled for a value profile site. */
 344   ValueProfNode **Nodes;
 345
 346   /* Total number of value profile kinds which have at least one
 347    *  value profile sites. */
 348   uint32_t NumValueKinds;
 349   /* An array recording the number of values tracked at each site.
 350    * The size of the array is TotalNumValueSites. */
 351   uint8_t *SiteCountArray[IPVK_Last + 1];
 352   ValueProfNode **NodesKind[IPVK_Last + 1];
 353 } ValueProfRuntimeRecord;
 354
 355 /* Forward declarations of C interfaces.  */
 356 int initializeValueProfRuntimeRecord(ValueProfRuntimeRecord *RuntimeRecord,
 357                                      const uint16_t *NumValueSites,
 358                                      ValueProfNode **Nodes);
 359 void finalizeValueProfRuntimeRecord(ValueProfRuntimeRecord *RuntimeRecord);
 360 uint32_t getValueProfDataSizeRT(const ValueProfRuntimeRecord *Record);
 361 ValueProfData *
 362 serializeValueProfDataFromRT(const ValueProfRuntimeRecord *Record,
 363                              ValueProfData *Dst);
 364
 365 #undef INSTR_PROF_VALUE_PROF_DATA
 366 #endif  /* INSTR_PROF_VALUE_PROF_DATA */
 367
 368
 369 #ifdef INSTR_PROF_COMMON_API_IMPL
 370 #define INSTR_PROF_DATA_DEFINED
 371 #ifdef __cplusplus
 372 #define INSTR_PROF_INLINE inline
 373 #else
 374 #define INSTR_PROF_INLINE
 375 #endif
 376
 377 #ifndef offsetof
 378 #define offsetof(TYPE, MEMBER) ((size_t) &((TYPE *)0)->MEMBER)
 379 #endif
 380
 381 /*!
 382  * \brief Return the \c ValueProfRecord header size including the
 383  * padding bytes.
 384  */
 385 INSTR_PROF_INLINE
 386 uint32_t getValueProfRecordHeaderSize(uint32_t NumValueSites) {
 387   uint32_t Size = offsetof(ValueProfRecord, SiteCountArray) +
 388                   sizeof(uint8_t) * NumValueSites;
 389   /* Round the size to multiple of 8 bytes. */
 390   Size = (Size + 7) & ~7;
 391   return Size;
 392 }
 393
 394 /*!
 395  * \brief Return the total size of the value profile record including the
 396  * header and the value data.
 397  */
 398 INSTR_PROF_INLINE
 399 uint32_t getValueProfRecordSize(uint32_t NumValueSites,
 400                                 uint32_t NumValueData) {
 401   return getValueProfRecordHeaderSize(NumValueSites) +
 402          sizeof(InstrProfValueData) * NumValueData;
 403 }
 404
 405 /*!
 406  * \brief Return the pointer to the start of value data array.
 407  */
 408 INSTR_PROF_INLINE
 409 InstrProfValueData *getValueProfRecordValueData(ValueProfRecord *This) {
 410   return (InstrProfValueData *)((char *)This + getValueProfRecordHeaderSize(
 411                                                    This->NumValueSites));
 412 }
 413
 414 /*!
 415  * \brief Return the total number of value data for \c This record.
 416  */
 417 INSTR_PROF_INLINE
 418 uint32_t getValueProfRecordNumValueData(ValueProfRecord *This) {
 419   uint32_t NumValueData = 0;
 420   uint32_t I;
 421   for (I = 0; I < This->NumValueSites; I++)
 422     NumValueData += This->SiteCountArray[I];
 423   return NumValueData;
 424 }
 425
 426 /*!
 427  * \brief Use this method to advance to the next \c This \c ValueProfRecord.
 428  */
 429 INSTR_PROF_INLINE
 430 ValueProfRecord *getValueProfRecordNext(ValueProfRecord *This) {
 431   uint32_t NumValueData = getValueProfRecordNumValueData(This);
 432   return (ValueProfRecord *)((char *)This +
 433                              getValueProfRecordSize(This->NumValueSites,
 434                                                     NumValueData));
 435 }
 436
 437 /*!
 438  * \brief Return the first \c ValueProfRecord instance.
 439  */
 440 INSTR_PROF_INLINE
 441 ValueProfRecord *getFirstValueProfRecord(ValueProfData *This) {
 442   return (ValueProfRecord *)((char *)This + sizeof(ValueProfData));
 443 }
 444
 445 /* Closure based interfaces.  */
 446
 447 /*!
 448  * Return the total size in bytes of the on-disk value profile data
 449  * given the data stored in Record.
 450  */
 451 uint32_t getValueProfDataSize(ValueProfRecordClosure *Closure) {
 452   uint32_t Kind;
 453   uint32_t TotalSize = sizeof(ValueProfData);
 454   const void *Record = Closure->Record;
 455   uint32_t NumValueKinds = Closure->GetNumValueKinds(Record);
 456   if (NumValueKinds == 0)
 457     return TotalSize;
 458
 459   for (Kind = IPVK_First; Kind <= IPVK_Last; Kind++) {
 460     uint32_t NumValueSites = Closure->GetNumValueSites(Record, Kind);
 461     if (!NumValueSites)
 462       continue;
 463     TotalSize += getValueProfRecordSize(NumValueSites,
 464                                         Closure->GetNumValueData(Record, Kind));
 465   }
 466   return TotalSize;
 467 }
 468
 469 /*!
 470  * Extract value profile data of a function for the profile kind \c ValueKind
 471  * from the \c Closure and serialize the data into \c This record instance.
 472  */
 473 void serializeValueProfRecordFrom(ValueProfRecord *This,
 474                                   ValueProfRecordClosure *Closure,
 475                                   uint32_t ValueKind, uint32_t NumValueSites) {
 476   uint32_t S;
 477   const void *Record = Closure->Record;
 478   This->Kind = ValueKind;
 479   This->NumValueSites = NumValueSites;
 480   InstrProfValueData *DstVD = getValueProfRecordValueData(This);
 481
 482   for (S = 0; S < NumValueSites; S++) {
 483     uint32_t ND = Closure->GetNumValueDataForSite(Record, ValueKind, S);
 484     This->SiteCountArray[S] = ND;
 485     Closure->GetValueForSite(Record, DstVD, ValueKind, S,
 486                              Closure->RemapValueData);
 487     DstVD += ND;
 488   }
 489 }
 490
 491 /*!
 492  * Extract value profile data of a function  from the \c Closure
 493  * and serialize the data into \c DstData if it is not NULL or heap
 494  * memory allocated by the \c Closure's allocator method.
 495  */
 496 ValueProfData *serializeValueProfDataFrom(ValueProfRecordClosure *Closure,
 497                                           ValueProfData *DstData) {
 498   uint32_t Kind;
 499   uint32_t TotalSize = getValueProfDataSize(Closure);
 500
 501   ValueProfData *VPD =
 502       DstData ? DstData : Closure->AllocValueProfData(TotalSize);
 503
 504   VPD->TotalSize = TotalSize;
 505   VPD->NumValueKinds = Closure->GetNumValueKinds(Closure->Record);
 506   ValueProfRecord *VR = getFirstValueProfRecord(VPD);
 507   for (Kind = IPVK_First; Kind <= IPVK_Last; Kind++) {
 508     uint32_t NumValueSites = Closure->GetNumValueSites(Closure->Record, Kind);
 509     if (!NumValueSites)
 510       continue;
 511     serializeValueProfRecordFrom(VR, Closure, Kind, NumValueSites);
 512     VR = getValueProfRecordNext(VR);
 513   }
 514   return VPD;
 515 }
 516
 517 /*
 518  * The value profiler runtime library stores the value profile data
 519  * for a given function in \c NumValueSites and \c Nodes structures.
 520  * \c ValueProfRuntimeRecord class is used to encapsulate the runtime
 521  * profile data and provides fast interfaces to retrieve the profile
 522  * information. This interface is used to initialize the runtime record
 523  * and pre-compute the information needed for efficient implementation
 524  * of callbacks required by ValueProfRecordClosure class.
 525  */
 526 int initializeValueProfRuntimeRecord(ValueProfRuntimeRecord *RuntimeRecord,
 527                                      const uint16_t *NumValueSites,
 528                                      ValueProfNode **Nodes) {
 529   unsigned I, J, S = 0, NumValueKinds = 0;
 530   RuntimeRecord->NumValueSites = NumValueSites;
 531   RuntimeRecord->Nodes = Nodes;
 532   for (I = 0; I <= IPVK_Last; I++) {
 533     uint16_t N = NumValueSites[I];
 534     if (!N) {
 535       RuntimeRecord->SiteCountArray[I] = 0;
 536       continue;
 537     }
 538     NumValueKinds++;
 539     RuntimeRecord->SiteCountArray[I] = (uint8_t *)calloc(N, 1);
 540     RuntimeRecord->NodesKind[I] = &RuntimeRecord->Nodes[S];
 541     if (!RuntimeRecord->NodesKind[I])
 542       return 1;
 543     for (J = 0; J < N; J++) {
 544       uint32_t C = 0;
 545       ValueProfNode *Site = RuntimeRecord->Nodes[S + J];
 546       while (Site) {
 547         C++;
 548         Site = Site->Next;
 549       }
 550       if (C > UCHAR_MAX)
 551         C = UCHAR_MAX;
 552       RuntimeRecord->SiteCountArray[I][J] = C;
 553     }
 554     S += N;
 555   }
 556   RuntimeRecord->NumValueKinds = NumValueKinds;
 557   return 0;
 558 }
 559
 560 void finalizeValueProfRuntimeRecord(ValueProfRuntimeRecord *RuntimeRecord) {
 561   unsigned I;
 562   for (I = 0; I <= IPVK_Last; I++) {
 563     if (RuntimeRecord->SiteCountArray[I])
 564       free(RuntimeRecord->SiteCountArray[I]);
 565   }
 566 }
 567
 568 /* ValueProfRecordClosure Interface implementation for
 569  * ValueProfDataRuntimeRecord.  */
 570 uint32_t getNumValueKindsRT(const void *R) {
 571   return ((const ValueProfRuntimeRecord *)R)->NumValueKinds;
 572 }
 573
 574 uint32_t getNumValueSitesRT(const void *R, uint32_t VK) {
 575   return ((const ValueProfRuntimeRecord *)R)->NumValueSites[VK];
 576 }
 577
 578 uint32_t getNumValueDataForSiteRT(const void *R, uint32_t VK, uint32_t S) {
 579   const ValueProfRuntimeRecord *Record = (const ValueProfRuntimeRecord *)R;
 580   return Record->SiteCountArray[VK][S];
 581 }
 582
 583 uint32_t getNumValueDataRT(const void *R, uint32_t VK) {
 584   unsigned I, S = 0;
 585   const ValueProfRuntimeRecord *Record = (const ValueProfRuntimeRecord *)R;
 586   if (Record->SiteCountArray[VK] == 0)
 587     return 0;
 588   for (I = 0; I < Record->NumValueSites[VK]; I++)
 589     S += Record->SiteCountArray[VK][I];
 590   return S;
 591 }
 592
 593 void getValueForSiteRT(const void *R, InstrProfValueData *Dst, uint32_t VK,
 594                        uint32_t S, uint64_t (*Mapper)(uint32_t, uint64_t)) {
 595   unsigned I, N = 0;
 596   const ValueProfRuntimeRecord *Record = (const ValueProfRuntimeRecord *)R;
 597   N = getNumValueDataForSiteRT(R, VK, S);
 598   ValueProfNode *VNode = Record->NodesKind[VK][S];
 599   for (I = 0; I < N; I++) {
 600     Dst[I] = VNode->VData;
 601     VNode = VNode->Next;
 602   }
 603 }
 604
 605 ValueProfData *allocValueProfDataRT(size_t TotalSizeInBytes) {
 606   return (ValueProfData *)calloc(TotalSizeInBytes, 1);
 607 }
 608
 609 static ValueProfRecordClosure RTRecordClosure = {0,
 610                                                  getNumValueKindsRT,
 611                                                  getNumValueSitesRT,
 612                                                  getNumValueDataRT,
 613                                                  getNumValueDataForSiteRT,
 614                                                  0,
 615                                                  getValueForSiteRT,
 616                                                  allocValueProfDataRT};
 617
 618 /*
 619  * Return the size of ValueProfData structure to store data
 620  * recorded in the runtime record.
 621  */
 622 uint32_t getValueProfDataSizeRT(const ValueProfRuntimeRecord *Record) {
 623   RTRecordClosure.Record = Record;
 624   return getValueProfDataSize(&RTRecordClosure);
 625 }
 626
 627 /*
 628  * Return a ValueProfData instance that stores the data collected
 629  * from runtime. If \c DstData is provided by the caller, the value
 630  * profile data will be store in *DstData and DstData is returned,
 631  * otherwise the method will allocate space for the value data and
 632  * return pointer to the newly allocated space.
 633  */
 634 ValueProfData *
 635 serializeValueProfDataFromRT(const ValueProfRuntimeRecord *Record,
 636                              ValueProfData *DstData) {
 637   RTRecordClosure.Record = Record;
 638   return serializeValueProfDataFrom(&RTRecordClosure, DstData);
 639 }
 640
 641
 642 #undef INSTR_PROF_COMMON_API_IMPL
 643 #endif /* INSTR_PROF_COMMON_API_IMPL */
 644
 645 /*============================================================================*/
 646
 647
 648 #ifndef INSTR_PROF_DATA_DEFINED
 649
 650 #ifndef INSTR_PROF_DATA_INC_
 651 #define INSTR_PROF_DATA_INC_
 652
 653 /* Helper macros.  */
 654 #define INSTR_PROF_SIMPLE_QUOTE(x) #x
 655 #define INSTR_PROF_QUOTE(x) INSTR_PROF_SIMPLE_QUOTE(x)
 656 #define INSTR_PROF_SIMPLE_CONCAT(x,y) x ## y
 657 #define INSTR_PROF_CONCAT(x,y) INSTR_PROF_SIMPLE_CONCAT(x,y)
 658
 659 /* Magic number to detect file format and endianness.
 660  * Use 255 at one end, since no UTF-8 file can use that character.  Avoid 0,
 661  * so that utilities, like strings, don't grab it as a string.  129 is also
 662  * invalid UTF-8, and high enough to be interesting.
 663  * Use "lprofr" in the centre to stand for "LLVM Profile Raw", or "lprofR"
 664  * for 32-bit platforms.
 665  */
 666 #define INSTR_PROF_RAW_MAGIC_64 (uint64_t)255 << 56 | (uint64_t)'l' << 48 | \
 667        (uint64_t)'p' << 40 | (uint64_t)'r' << 32 | (uint64_t)'o' << 24 |  \
 668         (uint64_t)'f' << 16 | (uint64_t)'r' << 8 | (uint64_t)129
 669 #define INSTR_PROF_RAW_MAGIC_32 (uint64_t)255 << 56 | (uint64_t)'l' << 48 | \
 670        (uint64_t)'p' << 40 | (uint64_t)'r' << 32 | (uint64_t)'o' << 24 |  \
 671         (uint64_t)'f' << 16 | (uint64_t)'R' << 8 | (uint64_t)129
 672
 673 /* Raw profile format version. */
 674 #define INSTR_PROF_RAW_VERSION 2
 675
 676 /* Runtime section names and name strings.  */
 677 #define INSTR_PROF_DATA_SECT_NAME __llvm_prf_data
 678 #define INSTR_PROF_NAME_SECT_NAME __llvm_prf_names
 679 #define INSTR_PROF_CNTS_SECT_NAME __llvm_prf_cnts
 680
 681 #define INSTR_PROF_DATA_SECT_NAME_STR \
 682         INSTR_PROF_QUOTE(INSTR_PROF_DATA_SECT_NAME)
 683 #define INSTR_PROF_NAME_SECT_NAME_STR \
 684         INSTR_PROF_QUOTE(INSTR_PROF_NAME_SECT_NAME)
 685 #define INSTR_PROF_CNTS_SECT_NAME_STR \
 686         INSTR_PROF_QUOTE(INSTR_PROF_CNTS_SECT_NAME)
 687
 688 /* Macros to define start/stop section symbol for a given
 689  * section on Linux. For instance
 690  * INSTR_PROF_SECT_START(INSTR_PROF_DATA_SECT_NAME) will
 691  * expand to __start___llvm_prof_data
 692  */
 693 #define INSTR_PROF_SECT_START(Sect) \
 694         INSTR_PROF_CONCAT(__start_,Sect)
 695 #define INSTR_PROF_SECT_STOP(Sect) \
 696         INSTR_PROF_CONCAT(__stop_,Sect)
 697
 698 /* Value Profiling API linkage name.  */
 699 #define INSTR_PROF_VALUE_PROF_FUNC __llvm_profile_instrument_target
 700 #define INSTR_PROF_VALUE_PROF_FUNC_STR \
 701         INSTR_PROF_QUOTE(INSTR_PROF_VALUE_PROF_FUNC)
 702
 703 /* InstrProfile per-function control data alignment.  */
 704 #define INSTR_PROF_DATA_ALIGNMENT 8
 705
 706 /* The data structure that represents a tracked value by the
 707  * value profiler.
 708  */
 709 typedef struct InstrProfValueData {
 710   /* Profiled value. */
 711   uint64_t Value;
 712   /* Number of times the value appears in the training run. */
 713   uint64_t Count;
 714 } InstrProfValueData;
 715
 716 /* This is an internal data structure used by value profiler. It
 717  * is defined here to allow serialization code sharing by LLVM
 718  * to be used in unit test.
 719  */
 720 typedef struct ValueProfNode {
 721   InstrProfValueData VData;
 722   struct ValueProfNode *Next;
 723 } ValueProfNode;
 724
 725 #endif /* INSTR_PROF_DATA_INC_ */
 726
 727 #else
 728 #undef INSTR_PROF_DATA_DEFINED
 729 #endif
 730