include/llvm/ProfileData/InstrProf.h

   1 //=-- InstrProf.h - Instrumented profiling format support ---------*- C++ -*-=//
   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 // Instrumentation-based profiling data is generated by instrumented
  11 // binaries through library functions in compiler-rt, and read by the clang
  12 // frontend to feed PGO.
  13 //
  14 //===----------------------------------------------------------------------===//
  15
  16 #ifndef LLVM_PROFILEDATA_INSTRPROF_H_
  17 #define LLVM_PROFILEDATA_INSTRPROF_H_
  18
  19 #include "llvm/ADT/STLExtras.h"
  20 #include "llvm/ADT/StringRef.h"
  21 #include "llvm/ADT/StringSet.h"
  22 #include "llvm/IR/GlobalValue.h"
  23 #include "llvm/ProfileData/InstrProfData.inc"
  24 #include "llvm/Support/Endian.h"
  25 #include "llvm/Support/ErrorHandling.h"
  26 #include "llvm/Support/ErrorOr.h"
  27 #include "llvm/Support/MD5.h"
  28 #include <cstdint>
  29 #include <list>
  30 #include <system_error>
  31 #include <vector>
  32
  33 #define INSTR_PROF_INDEX_VERSION 3
  34 namespace llvm {
  35
  36 class Function;
  37 class GlobalVariable;
  38 class Module;
  39
  40 /// Return the name of data section containing profile counter variables.
  41 inline StringRef getInstrProfCountersSectionName(bool AddSegment) {
  42   return AddSegment ? "__DATA," INSTR_PROF_CNTS_SECT_NAME_STR
  43                     : INSTR_PROF_CNTS_SECT_NAME_STR;
  44 }
  45
  46 /// Return the name of data section containing names of instrumented
  47 /// functions.
  48 inline StringRef getInstrProfNameSectionName(bool AddSegment) {
  49   return AddSegment ? "__DATA," INSTR_PROF_NAME_SECT_NAME_STR
  50                     : INSTR_PROF_NAME_SECT_NAME_STR;
  51 }
  52
  53 /// Return the name of the data section containing per-function control
  54 /// data.
  55 inline StringRef getInstrProfDataSectionName(bool AddSegment) {
  56   return AddSegment ? "__DATA," INSTR_PROF_DATA_SECT_NAME_STR
  57                     : INSTR_PROF_DATA_SECT_NAME_STR;
  58 }
  59
  60 /// Return the name profile runtime entry point to do value profiling
  61 /// for a given site.
  62 inline StringRef getInstrProfValueProfFuncName() {
  63   return INSTR_PROF_VALUE_PROF_FUNC_STR;
  64 }
  65
  66 /// Return the name of the section containing function coverage mapping
  67 /// data.
  68 inline StringRef getInstrProfCoverageSectionName(bool AddSegment) {
  69   return AddSegment ? "__DATA,__llvm_covmap" : "__llvm_covmap";
  70 }
  71
  72 /// Return the name prefix of variables containing instrumented function names.
  73 inline StringRef getInstrProfNameVarPrefix() { return "__profn_"; }
  74
  75 /// Return the name prefix of variables containing per-function control data.
  76 inline StringRef getInstrProfDataVarPrefix() { return "__profd_"; }
  77
  78 /// Return the name prefix of profile counter variables.
  79 inline StringRef getInstrProfCountersVarPrefix() { return "__profc_"; }
  80
  81 /// Return the name prefix of the COMDAT group for instrumentation variables
  82 /// associated with a COMDAT function.
  83 inline StringRef getInstrProfComdatPrefix() { return "__profv_"; }
  84
  85 /// Return the name of a covarage mapping variable (internal linkage)
  86 /// for each instrumented source module. Such variables are allocated
  87 /// in the __llvm_covmap section.
  88 inline StringRef getCoverageMappingVarName() {
  89   return "__llvm_coverage_mapping";
  90 }
  91
  92 /// Return the name of function that registers all the per-function control
  93 /// data at program startup time by calling __llvm_register_function. This
  94 /// function has internal linkage and is called by  __llvm_profile_init
  95 /// runtime method. This function is not generated for these platforms:
  96 /// Darwin, Linux, and FreeBSD.
  97 inline StringRef getInstrProfRegFuncsName() {
  98   return "__llvm_profile_register_functions";
  99 }
 100
 101 /// Return the name of the runtime interface that registers per-function control
 102 /// data for one instrumented function.
 103 inline StringRef getInstrProfRegFuncName() {
 104   return "__llvm_profile_register_function";
 105 }
 106
 107 /// Return the name of the runtime initialization method that is generated by
 108 /// the compiler. The function calls __llvm_profile_register_functions and
 109 /// __llvm_profile_override_default_filename functions if needed. This function
 110 /// has internal linkage and invoked at startup time via init_array.
 111 inline StringRef getInstrProfInitFuncName() { return "__llvm_profile_init"; }
 112
 113 /// Return the name of the hook variable defined in profile runtime library.
 114 /// A reference to the variable causes the linker to link in the runtime
 115 /// initialization module (which defines the hook variable).
 116 inline StringRef getInstrProfRuntimeHookVarName() {
 117   return "__llvm_profile_runtime";
 118 }
 119
 120 /// Return the name of the compiler generated function that references the
 121 /// runtime hook variable. The function is a weak global.
 122 inline StringRef getInstrProfRuntimeHookVarUseFuncName() {
 123   return "__llvm_profile_runtime_user";
 124 }
 125
 126 /// Return the name of the profile runtime interface that overrides the default
 127 /// profile data file name.
 128 inline StringRef getInstrProfFileOverriderFuncName() {
 129   return "__llvm_profile_override_default_filename";
 130 }
 131
 132 /// Return the modified name for function \c F suitable to be
 133 /// used the key for profile lookup.
 134 std::string getPGOFuncName(const Function &F,
 135                            uint64_t Version = INSTR_PROF_INDEX_VERSION);
 136
 137 /// Return the modified name for a function suitable to be
 138 /// used the key for profile lookup. The function's original
 139 /// name is \c RawFuncName and has linkage of type \c Linkage.
 140 /// The function is defined in module \c FileName.
 141 std::string getPGOFuncName(StringRef RawFuncName,
 142                            GlobalValue::LinkageTypes Linkage,
 143                            StringRef FileName,
 144                            uint64_t Version = INSTR_PROF_INDEX_VERSION);
 145
 146 /// Create and return the global variable for function name used in PGO
 147 /// instrumentation. \c FuncName is the name of the function returned
 148 /// by \c getPGOFuncName call.
 149 GlobalVariable *createPGOFuncNameVar(Function &F, StringRef FuncName);
 150
 151 /// Create and return the global variable for function name used in PGO
 152 /// instrumentation.  /// \c FuncName is the name of the function
 153 /// returned by \c getPGOFuncName call, \c M is the owning module,
 154 /// and \c Linkage is the linkage of the instrumented function.
 155 GlobalVariable *createPGOFuncNameVar(Module &M,
 156                                      GlobalValue::LinkageTypes Linkage,
 157                                      StringRef FuncName);
 158
 159 /// Given a PGO function name, remove the filename prefix and return
 160 /// the original (static) function name.
 161 StringRef getFuncNameWithoutPrefix(StringRef PGOFuncName, StringRef FileName);
 162
 163 const std::error_category &instrprof_category();
 164
 165 enum class instrprof_error {
 166   success = 0,
 167   eof,
 168   unrecognized_format,
 169   bad_magic,
 170   bad_header,
 171   unsupported_version,
 172   unsupported_hash_type,
 173   too_large,
 174   truncated,
 175   malformed,
 176   unknown_function,
 177   hash_mismatch,
 178   count_mismatch,
 179   counter_overflow,
 180   value_site_count_mismatch
 181 };
 182
 183 inline std::error_code make_error_code(instrprof_error E) {
 184   return std::error_code(static_cast<int>(E), instrprof_category());
 185 }
 186
 187 inline instrprof_error MergeResult(instrprof_error &Accumulator,
 188                                    instrprof_error Result) {
 189   // Prefer first error encountered as later errors may be secondary effects of
 190   // the initial problem.
 191   if (Accumulator == instrprof_error::success &&
 192       Result != instrprof_error::success)
 193     Accumulator = Result;
 194   return Accumulator;
 195 }
 196
 197 enum InstrProfValueKind : uint32_t {
 198 #define VALUE_PROF_KIND(Enumerator, Value) Enumerator = Value,
 199 #include "llvm/ProfileData/InstrProfData.inc"
 200 };
 201
 202 namespace object {
 203 class SectionRef;
 204 }
 205 /// A symbol table used for function PGO name look-up with keys
 206 /// (such as pointers, md5hash values) to the function. A function's
 207 /// PGO name or name's md5hash are used in retrieving the profile
 208 /// data of the function. See \c getPGOFuncName() method for details
 209 /// on how PGO name is formed.
 210 class InstrProfSymtab {
 211 private:
 212   StringRef Data;
 213   uint64_t Address;
 214
 215 public:
 216   InstrProfSymtab() : Data(), Address(0) {}
 217
 218   /// Create InstrProfSymtab from a object file section which
 219   /// contains function PGO names that are uncompressed.
 220   std::error_code create(object::SectionRef &Section);
 221   std::error_code create(StringRef D, uint64_t BaseAddr) {
 222     Data = D;
 223     Address = BaseAddr;
 224     return std::error_code();
 225   }
 226
 227   /// Return function's PGO name from the function name's symabol
 228   /// address in the object file. If an error occurs, Return
 229   /// an empty string.
 230   StringRef getFuncName(uint64_t FuncNameAddress, size_t NameSize);
 231 };
 232
 233 struct InstrProfStringTable {
 234   // Set of string values in profiling data.
 235   StringSet<> StringValueSet;
 236   InstrProfStringTable() { StringValueSet.clear(); }
 237   // Get a pointer to internal storage of a string in set
 238   const char *getStringData(StringRef Str) {
 239     auto Result = StringValueSet.find(Str);
 240     return (Result == StringValueSet.end()) ? nullptr : Result->first().data();
 241   }
 242   // Insert a string to StringTable
 243   const char *insertString(StringRef Str) {
 244     auto Result = StringValueSet.insert(Str);
 245     return Result.first->first().data();
 246   }
 247 };
 248
 249 struct InstrProfValueSiteRecord {
 250   /// Value profiling data pairs at a given value site.
 251   std::list<InstrProfValueData> ValueData;
 252
 253   InstrProfValueSiteRecord() { ValueData.clear(); }
 254   template <class InputIterator>
 255   InstrProfValueSiteRecord(InputIterator F, InputIterator L)
 256       : ValueData(F, L) {}
 257
 258   /// Sort ValueData ascending by Value
 259   void sortByTargetValues() {
 260     ValueData.sort(
 261         [](const InstrProfValueData &left, const InstrProfValueData &right) {
 262           return left.Value < right.Value;
 263         });
 264   }
 265
 266   /// Merge data from another InstrProfValueSiteRecord
 267   /// Optionally scale merged counts by \p Weight.
 268   instrprof_error mergeValueData(InstrProfValueSiteRecord &Input,
 269                                  uint64_t Weight = 1) {
 270     this->sortByTargetValues();
 271     Input.sortByTargetValues();
 272     auto I = ValueData.begin();
 273     auto IE = ValueData.end();
 274     instrprof_error Result = instrprof_error::success;
 275     for (auto J = Input.ValueData.begin(), JE = Input.ValueData.end(); J != JE;
 276          ++J) {
 277       while (I != IE && I->Value < J->Value)
 278         ++I;
 279       if (I != IE && I->Value == J->Value) {
 280         uint64_t JCount = J->Count;
 281         bool Overflowed;
 282         if (Weight > 1) {
 283           JCount = SaturatingMultiply(JCount, Weight, &Overflowed);
 284           if (Overflowed)
 285             Result = instrprof_error::counter_overflow;
 286         }
 287         I->Count = SaturatingAdd(I->Count, JCount, &Overflowed);
 288         if (Overflowed)
 289           Result = instrprof_error::counter_overflow;
 290         ++I;
 291         continue;
 292       }
 293       ValueData.insert(I, *J);
 294     }
 295     return Result;
 296   }
 297 };
 298
 299 /// Profiling information for a single function.
 300 struct InstrProfRecord {
 301   InstrProfRecord() {}
 302   InstrProfRecord(StringRef Name, uint64_t Hash, std::vector<uint64_t> Counts)
 303       : Name(Name), Hash(Hash), Counts(std::move(Counts)) {}
 304   StringRef Name;
 305   uint64_t Hash;
 306   std::vector<uint64_t> Counts;
 307
 308   typedef std::vector<std::pair<uint64_t, const char *>> ValueMapType;
 309
 310   /// Return the number of value profile kinds with non-zero number
 311   /// of profile sites.
 312   inline uint32_t getNumValueKinds() const;
 313   /// Return the number of instrumented sites for ValueKind.
 314   inline uint32_t getNumValueSites(uint32_t ValueKind) const;
 315   /// Return the total number of ValueData for ValueKind.
 316   inline uint32_t getNumValueData(uint32_t ValueKind) const;
 317   /// Return the number of value data collected for ValueKind at profiling
 318   /// site: Site.
 319   inline uint32_t getNumValueDataForSite(uint32_t ValueKind,
 320                                          uint32_t Site) const;
 321   /// Return the array of profiled values at \p Site.
 322   inline std::unique_ptr<InstrProfValueData[]>
 323   getValueForSite(uint32_t ValueKind, uint32_t Site,
 324                   uint64_t (*ValueMapper)(uint32_t, uint64_t) = 0) const;
 325   inline void
 326   getValueForSite(InstrProfValueData Dest[], uint32_t ValueKind, uint32_t Site,
 327                   uint64_t (*ValueMapper)(uint32_t, uint64_t) = 0) const;
 328   /// Reserve space for NumValueSites sites.
 329   inline void reserveSites(uint32_t ValueKind, uint32_t NumValueSites);
 330   /// Add ValueData for ValueKind at value Site.
 331   void addValueData(uint32_t ValueKind, uint32_t Site,
 332                     InstrProfValueData *VData, uint32_t N,
 333                     ValueMapType *HashKeys);
 334
 335   /// Merge the counts in \p Other into this one.
 336   /// Optionally scale merged counts by \p Weight.
 337   instrprof_error merge(InstrProfRecord &Other, uint64_t Weight = 1);
 338
 339   /// Used by InstrProfWriter: update the value strings to commoned strings in
 340   /// the writer instance.
 341   void updateStrings(InstrProfStringTable *StrTab);
 342
 343   /// Clear value data entries
 344   void clearValueData() {
 345     for (uint32_t Kind = IPVK_First; Kind <= IPVK_Last; ++Kind)
 346       getValueSitesForKind(Kind).clear();
 347   }
 348
 349 private:
 350   std::vector<InstrProfValueSiteRecord> IndirectCallSites;
 351   const std::vector<InstrProfValueSiteRecord> &
 352   getValueSitesForKind(uint32_t ValueKind) const {
 353     switch (ValueKind) {
 354     case IPVK_IndirectCallTarget:
 355       return IndirectCallSites;
 356     default:
 357       llvm_unreachable("Unknown value kind!");
 358     }
 359     return IndirectCallSites;
 360   }
 361
 362   std::vector<InstrProfValueSiteRecord> &
 363   getValueSitesForKind(uint32_t ValueKind) {
 364     return const_cast<std::vector<InstrProfValueSiteRecord> &>(
 365         const_cast<const InstrProfRecord *>(this)
 366             ->getValueSitesForKind(ValueKind));
 367   }
 368
 369   // Map indirect call target name hash to name string.
 370   uint64_t remapValue(uint64_t Value, uint32_t ValueKind,
 371                       ValueMapType *HashKeys);
 372
 373   // Merge Value Profile data from Src record to this record for ValueKind.
 374   // Scale merged value counts by \p Weight.
 375   instrprof_error mergeValueProfData(uint32_t ValueKind, InstrProfRecord &Src,
 376                                      uint64_t Weight);
 377 };
 378
 379 uint32_t InstrProfRecord::getNumValueKinds() const {
 380   uint32_t NumValueKinds = 0;
 381   for (uint32_t Kind = IPVK_First; Kind <= IPVK_Last; ++Kind)
 382     NumValueKinds += !(getValueSitesForKind(Kind).empty());
 383   return NumValueKinds;
 384 }
 385
 386 uint32_t InstrProfRecord::getNumValueData(uint32_t ValueKind) const {
 387   uint32_t N = 0;
 388   const std::vector<InstrProfValueSiteRecord> &SiteRecords =
 389       getValueSitesForKind(ValueKind);
 390   for (auto &SR : SiteRecords) {
 391     N += SR.ValueData.size();
 392   }
 393   return N;
 394 }
 395
 396 uint32_t InstrProfRecord::getNumValueSites(uint32_t ValueKind) const {
 397   return getValueSitesForKind(ValueKind).size();
 398 }
 399
 400 uint32_t InstrProfRecord::getNumValueDataForSite(uint32_t ValueKind,
 401                                                  uint32_t Site) const {
 402   return getValueSitesForKind(ValueKind)[Site].ValueData.size();
 403 }
 404
 405 std::unique_ptr<InstrProfValueData[]> InstrProfRecord::getValueForSite(
 406     uint32_t ValueKind, uint32_t Site,
 407     uint64_t (*ValueMapper)(uint32_t, uint64_t)) const {
 408   uint32_t N = getNumValueDataForSite(ValueKind, Site);
 409   if (N == 0)
 410     return std::unique_ptr<InstrProfValueData[]>(nullptr);
 411
 412   auto VD = llvm::make_unique<InstrProfValueData[]>(N);
 413   getValueForSite(VD.get(), ValueKind, Site, ValueMapper);
 414
 415   return VD;
 416 }
 417
 418 void InstrProfRecord::getValueForSite(InstrProfValueData Dest[],
 419                                       uint32_t ValueKind, uint32_t Site,
 420                                       uint64_t (*ValueMapper)(uint32_t,
 421                                                               uint64_t)) const {
 422   uint32_t I = 0;
 423   for (auto V : getValueSitesForKind(ValueKind)[Site].ValueData) {
 424     Dest[I].Value = ValueMapper ? ValueMapper(ValueKind, V.Value) : V.Value;
 425     Dest[I].Count = V.Count;
 426     I++;
 427   }
 428 }
 429
 430 void InstrProfRecord::reserveSites(uint32_t ValueKind, uint32_t NumValueSites) {
 431   std::vector<InstrProfValueSiteRecord> &ValueSites =
 432       getValueSitesForKind(ValueKind);
 433   ValueSites.reserve(NumValueSites);
 434 }
 435
 436 inline support::endianness getHostEndianness() {
 437   return sys::IsLittleEndianHost ? support::little : support::big;
 438 }
 439
 440 // Include definitions for value profile data
 441 #define INSTR_PROF_VALUE_PROF_DATA
 442 #include "llvm/ProfileData/InstrProfData.inc"
 443
 444  /*
 445  * Initialize the record for runtime value profile data.
 446  * Return 0 if the initialization is successful, otherwise
 447  * return 1.
 448  */
 449 int initializeValueProfRuntimeRecord(ValueProfRuntimeRecord *RuntimeRecord,
 450                                      const uint16_t *NumValueSites,
 451                                      ValueProfNode **Nodes);
 452
 453 /* Release memory allocated for the runtime record.  */
 454 void finalizeValueProfRuntimeRecord(ValueProfRuntimeRecord *RuntimeRecord);
 455
 456 /* Return the size of ValueProfData structure that can be used to store
 457    the value profile data collected at runtime. */
 458 uint32_t getValueProfDataSizeRT(const ValueProfRuntimeRecord *Record);
 459
 460 /* Return a ValueProfData instance that stores the data collected at runtime. */
 461 ValueProfData *
 462 serializeValueProfDataFromRT(const ValueProfRuntimeRecord *Record,
 463                              ValueProfData *Dst);
 464
 465 namespace IndexedInstrProf {
 466
 467 enum class HashT : uint32_t {
 468   MD5,
 469
 470   Last = MD5
 471 };
 472
 473 static inline uint64_t MD5Hash(StringRef Str) {
 474   MD5 Hash;
 475   Hash.update(Str);
 476   llvm::MD5::MD5Result Result;
 477   Hash.final(Result);
 478   // Return the least significant 8 bytes. Our MD5 implementation returns the
 479   // result in little endian, so we may need to swap bytes.
 480   using namespace llvm::support;
 481   return endian::read<uint64_t, little, unaligned>(Result);
 482 }
 483
 484 static inline uint64_t ComputeHash(HashT Type, StringRef K) {
 485   switch (Type) {
 486   case HashT::MD5:
 487     return IndexedInstrProf::MD5Hash(K);
 488   }
 489   llvm_unreachable("Unhandled hash type");
 490 }
 491
 492 const uint64_t Magic = 0x8169666f72706cff; // "\xfflprofi\x81"
 493 const uint64_t Version = INSTR_PROF_INDEX_VERSION;
 494 const HashT HashType = HashT::MD5;
 495
 496 static inline uint64_t ComputeHash(StringRef K) {
 497   return ComputeHash(HashType, K);
 498 }
 499
 500 // This structure defines the file header of the LLVM profile
 501 // data file in indexed-format.
 502 struct Header {
 503   uint64_t Magic;
 504   uint64_t Version;
 505   uint64_t MaxFunctionCount;
 506   uint64_t HashType;
 507   uint64_t HashOffset;
 508 };
 509
 510 } // end namespace IndexedInstrProf
 511
 512 namespace RawInstrProf {
 513
 514 const uint64_t Version = INSTR_PROF_RAW_VERSION;
 515
 516 template <class IntPtrT> inline uint64_t getMagic();
 517 template <> inline uint64_t getMagic<uint64_t>() {
 518   return INSTR_PROF_RAW_MAGIC_64;
 519 }
 520
 521 template <> inline uint64_t getMagic<uint32_t>() {
 522   return INSTR_PROF_RAW_MAGIC_32;
 523 }
 524
 525 // Per-function profile data header/control structure.
 526 // The definition should match the structure defined in
 527 // compiler-rt/lib/profile/InstrProfiling.h.
 528 // It should also match the synthesized type in
 529 // Transforms/Instrumentation/InstrProfiling.cpp:getOrCreateRegionCounters.
 530 template <class IntPtrT> struct LLVM_ALIGNAS(8) ProfileData {
 531   #define INSTR_PROF_DATA(Type, LLVMType, Name, Init) Type Name;
 532   #include "llvm/ProfileData/InstrProfData.inc"
 533 };
 534
 535 // File header structure of the LLVM profile data in raw format.
 536 // The definition should match the header referenced in
 537 // compiler-rt/lib/profile/InstrProfilingFile.c  and
 538 // InstrProfilingBuffer.c.
 539 struct Header {
 540 #define INSTR_PROF_RAW_HEADER(Type, Name, Init) const Type Name;
 541 #include "llvm/ProfileData/InstrProfData.inc"
 542 };
 543
 544 }  // end namespace RawInstrProf
 545
 546 namespace coverage {
 547
 548 // Profile coverage map has the following layout:
 549 // [CoverageMapFileHeader]
 550 // [ArrayStart]
 551 //  [CovMapFunctionRecord]
 552 //  [CovMapFunctionRecord]
 553 //  ...
 554 // [ArrayEnd]
 555 // [Encoded Region Mapping Data]
 556 LLVM_PACKED_START
 557 template <class IntPtrT> struct CovMapFunctionRecord {
 558   #define COVMAP_FUNC_RECORD(Type, LLVMType, Name, Init) Type Name;
 559   #include "llvm/ProfileData/InstrProfData.inc"
 560 };
 561 LLVM_PACKED_END
 562
 563 }
 564
 565 } // end namespace llvm
 566
 567 namespace std {
 568 template <>
 569 struct is_error_code_enum<llvm::instrprof_error> : std::true_type {};
 570 }
 571
 572 #endif // LLVM_PROFILEDATA_INSTRPROF_H_