lib/ProfileData/InstrProf.cpp

   1 //=-- InstrProf.cpp - Instrumented profiling format support -----------------=//
   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 file contains support for clang's instrumentation based PGO and
  11 // coverage.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #include "llvm/IR/Constants.h"
  16 #include "llvm/IR/Function.h"
  17 #include "llvm/IR/Module.h"
  18 #include "llvm/IR/GlobalVariable.h"
  19 #include "llvm/ProfileData/InstrProf.h"
  20 #include "llvm/Support/ErrorHandling.h"
  21 #include "llvm/Support/ManagedStatic.h"
  22
  23 using namespace llvm;
  24
  25 namespace {
  26 class InstrProfErrorCategoryType : public std::error_category {
  27   const char *name() const LLVM_NOEXCEPT override { return "llvm.instrprof"; }
  28   std::string message(int IE) const override {
  29     instrprof_error E = static_cast<instrprof_error>(IE);
  30     switch (E) {
  31     case instrprof_error::success:
  32       return "Success";
  33     case instrprof_error::eof:
  34       return "End of File";
  35     case instrprof_error::unrecognized_format:
  36       return "Unrecognized instrumentation profile encoding format";
  37     case instrprof_error::bad_magic:
  38       return "Invalid instrumentation profile data (bad magic)";
  39     case instrprof_error::bad_header:
  40       return "Invalid instrumentation profile data (file header is corrupt)";
  41     case instrprof_error::unsupported_version:
  42       return "Unsupported instrumentation profile format version";
  43     case instrprof_error::unsupported_hash_type:
  44       return "Unsupported instrumentation profile hash type";
  45     case instrprof_error::too_large:
  46       return "Too much profile data";
  47     case instrprof_error::truncated:
  48       return "Truncated profile data";
  49     case instrprof_error::malformed:
  50       return "Malformed instrumentation profile data";
  51     case instrprof_error::unknown_function:
  52       return "No profile data available for function";
  53     case instrprof_error::hash_mismatch:
  54       return "Function control flow change detected (hash mismatch)";
  55     case instrprof_error::count_mismatch:
  56       return "Function basic block count change detected (counter mismatch)";
  57     case instrprof_error::counter_overflow:
  58       return "Counter overflow";
  59     case instrprof_error::value_site_count_mismatch:
  60       return "Function value site count change detected (counter mismatch)";
  61     }
  62     llvm_unreachable("A value of instrprof_error has no message.");
  63   }
  64 };
  65 }
  66
  67 static ManagedStatic<InstrProfErrorCategoryType> ErrorCategory;
  68
  69 const std::error_category &llvm::instrprof_category() {
  70   return *ErrorCategory;
  71 }
  72
  73 namespace llvm {
  74
  75 std::string getPGOFuncName(StringRef RawFuncName,
  76                            GlobalValue::LinkageTypes Linkage,
  77                            StringRef FileName) {
  78
  79   // Function names may be prefixed with a binary '1' to indicate
  80   // that the backend should not modify the symbols due to any platform
  81   // naming convention. Do not include that '1' in the PGO profile name.
  82   if (RawFuncName[0] == '\1')
  83     RawFuncName = RawFuncName.substr(1);
  84
  85   std::string FuncName = RawFuncName;
  86   if (llvm::GlobalValue::isLocalLinkage(Linkage)) {
  87     // For local symbols, prepend the main file name to distinguish them.
  88     // Do not include the full path in the file name since there's no guarantee
  89     // that it will stay the same, e.g., if the files are checked out from
  90     // version control in different locations.
  91     if (FileName.empty())
  92       FuncName = FuncName.insert(0, "<unknown>:");
  93     else
  94       FuncName = FuncName.insert(0, FileName.str() + ":");
  95   }
  96   return FuncName;
  97 }
  98
  99 std::string getPGOFuncName(const Function &F) {
 100   return getPGOFuncName(F.getName(), F.getLinkage(), F.getParent()->getName());
 101 }
 102
 103 GlobalVariable *createPGOFuncNameVar(Module &M,
 104                                      GlobalValue::LinkageTypes Linkage,
 105                                      StringRef FuncName) {
 106
 107   // We generally want to match the function's linkage, but available_externally
 108   // and extern_weak both have the wrong semantics, and anything that doesn't
 109   // need to link across compilation units doesn't need to be visible at all.
 110   if (Linkage == GlobalValue::ExternalWeakLinkage)
 111     Linkage = GlobalValue::LinkOnceAnyLinkage;
 112   else if (Linkage == GlobalValue::AvailableExternallyLinkage)
 113     Linkage = GlobalValue::LinkOnceODRLinkage;
 114   else if (Linkage == GlobalValue::InternalLinkage ||
 115            Linkage == GlobalValue::ExternalLinkage)
 116     Linkage = GlobalValue::PrivateLinkage;
 117
 118   auto *Value = ConstantDataArray::getString(M.getContext(), FuncName, false);
 119   auto FuncNameVar =
 120       new GlobalVariable(M, Value->getType(), true, Linkage, Value,
 121                          Twine(getInstrProfNameVarPrefix()) + FuncName);
 122
 123   // Hide the symbol so that we correctly get a copy for each executable.
 124   if (!GlobalValue::isLocalLinkage(FuncNameVar->getLinkage()))
 125     FuncNameVar->setVisibility(GlobalValue::HiddenVisibility);
 126
 127   return FuncNameVar;
 128 }
 129
 130 GlobalVariable *createPGOFuncNameVar(Function &F, StringRef FuncName) {
 131   return createPGOFuncNameVar(*F.getParent(), F.getLinkage(), FuncName);
 132 }
 133
 134 /// Return the total size in bytes of the on-disk value profile data
 135 /// given the data stored in Record.
 136 uint32_t getValueProfDataSize(ValueProfRecordClosure *Closure) {
 137   uint32_t Kind;
 138   uint32_t TotalSize = sizeof(ValueProfData);
 139   const void *Record = Closure->Record;
 140   uint32_t NumValueKinds = Closure->GetNumValueKinds(Record);
 141   if (NumValueKinds == 0)
 142     return TotalSize;
 143
 144   for (Kind = IPVK_First; Kind <= IPVK_Last; Kind++) {
 145     uint32_t NumValueSites = Closure->GetNumValueSites(Record, Kind);
 146     if (!NumValueSites)
 147       continue;
 148     TotalSize += getValueProfRecordSize(NumValueSites,
 149                                         Closure->GetNumValueData(Record, Kind));
 150   }
 151   return TotalSize;
 152 }
 153
 154 // Extract data from \c Closure and serialize into \c This instance.
 155 void serializeValueProfRecordFrom(ValueProfRecord *This,
 156                                   ValueProfRecordClosure *Closure,
 157                                   uint32_t ValueKind, uint32_t NumValueSites) {
 158   uint32_t S;
 159   const void *Record = Closure->Record;
 160   This->Kind = ValueKind;
 161   This->NumValueSites = NumValueSites;
 162   InstrProfValueData *DstVD = getValueProfRecordValueData(This);
 163
 164   for (S = 0; S < NumValueSites; S++) {
 165     uint32_t ND = Closure->GetNumValueDataForSite(Record, ValueKind, S);
 166     This->SiteCountArray[S] = ND;
 167     Closure->GetValueForSite(Record, DstVD, ValueKind, S,
 168                              Closure->RemapValueData);
 169     DstVD += ND;
 170   }
 171 }
 172
 173 ValueProfData *serializeValueProfDataFrom(ValueProfRecordClosure *Closure) {
 174   uint32_t TotalSize = getValueProfDataSize(Closure);
 175
 176   ValueProfData *VPD = Closure->AllocValueProfData(TotalSize);
 177
 178   VPD->TotalSize = TotalSize;
 179   VPD->NumValueKinds = Closure->GetNumValueKinds(Closure->Record);
 180   ValueProfRecord *VR = getFirstValueProfRecord(VPD);
 181   for (uint32_t Kind = IPVK_First; Kind <= IPVK_Last; Kind++) {
 182     uint32_t NumValueSites = Closure->GetNumValueSites(Closure->Record, Kind);
 183     if (!NumValueSites)
 184       continue;
 185     serializeValueProfRecordFrom(VR, Closure, Kind, NumValueSites);
 186     VR = getValueProfRecordNext(VR);
 187   }
 188   return VPD;
 189 }
 190
 191 // C wrappers of InstrProfRecord member functions used in Closure.
 192 // These C wrappers are used as adaptors so that C++ code can be
 193 // invoked as callbacks.
 194 uint32_t getNumValueKindsInstrProf(const void *Record) {
 195   return reinterpret_cast<const InstrProfRecord *>(Record)->getNumValueKinds();
 196 }
 197
 198 uint32_t getNumValueSitesInstrProf(const void *Record, uint32_t VKind) {
 199   return reinterpret_cast<const InstrProfRecord *>(Record)
 200       ->getNumValueSites(VKind);
 201 }
 202
 203 uint32_t getNumValueDataInstrProf(const void *Record, uint32_t VKind) {
 204   return reinterpret_cast<const InstrProfRecord *>(Record)
 205       ->getNumValueData(VKind);
 206 }
 207
 208 uint32_t getNumValueDataForSiteInstrProf(const void *R, uint32_t VK,
 209                                          uint32_t S) {
 210   return reinterpret_cast<const InstrProfRecord *>(R)
 211       ->getNumValueDataForSite(VK, S);
 212 }
 213
 214 void getValueForSiteInstrProf(const void *R, InstrProfValueData *Dst,
 215                               uint32_t K, uint32_t S,
 216                               uint64_t (*Mapper)(uint32_t, uint64_t)) {
 217   return reinterpret_cast<const InstrProfRecord *>(R)
 218       ->getValueForSite(Dst, K, S, Mapper);
 219 }
 220
 221 uint64_t stringToHash(uint32_t ValueKind, uint64_t Value) {
 222   switch (ValueKind) {
 223   case IPVK_IndirectCallTarget:
 224     return IndexedInstrProf::ComputeHash(IndexedInstrProf::HashType,
 225                                          (const char *)Value);
 226     break;
 227   default:
 228     llvm_unreachable("value kind not handled !");
 229   }
 230   return Value;
 231 }
 232
 233 ValueProfData *allocValueProfDataInstrProf(size_t TotalSizeInBytes) {
 234   return (ValueProfData *)(new (::operator new(TotalSizeInBytes))
 235                                ValueProfData());
 236 }
 237
 238 static ValueProfRecordClosure InstrProfRecordClosure = {
 239     0,
 240     getNumValueKindsInstrProf,
 241     getNumValueSitesInstrProf,
 242     getNumValueDataInstrProf,
 243     getNumValueDataForSiteInstrProf,
 244     stringToHash,
 245     getValueForSiteInstrProf,
 246     allocValueProfDataInstrProf
 247 };
 248
 249 // Wrapper implementation using the closure mechanism.
 250 uint32_t ValueProfData::getSize(const InstrProfRecord &Record) {
 251   InstrProfRecordClosure.Record = &Record;
 252   return getValueProfDataSize(&InstrProfRecordClosure);
 253 }
 254
 255 // Wrapper implementation using the closure mechanism.
 256 std::unique_ptr<ValueProfData>
 257 ValueProfData::serializeFrom(const InstrProfRecord &Record) {
 258   InstrProfRecordClosure.Record = &Record;
 259
 260   std::unique_ptr<ValueProfData> VPD(
 261       serializeValueProfDataFrom(&InstrProfRecordClosure));
 262   return VPD;
 263 }
 264
 265 void ValueProfRecord::deserializeTo(InstrProfRecord &Record,
 266                                     InstrProfRecord::ValueMapType *VMap) {
 267   Record.reserveSites(Kind, NumValueSites);
 268
 269   InstrProfValueData *ValueData = getValueProfRecordValueData(this);
 270   for (uint64_t VSite = 0; VSite < NumValueSites; ++VSite) {
 271     uint8_t ValueDataCount = this->SiteCountArray[VSite];
 272     Record.addValueData(Kind, VSite, ValueData, ValueDataCount, VMap);
 273     ValueData += ValueDataCount;
 274   }
 275 }
 276 // For writing/serializing,  Old is the host endianness, and  New is
 277 // byte order intended on disk. For Reading/deserialization, Old
 278 // is the on-disk source endianness, and New is the host endianness.
 279 void ValueProfRecord::swapBytes(support::endianness Old,
 280                                 support::endianness New) {
 281   using namespace support;
 282   if (Old == New)
 283     return;
 284
 285   if (getHostEndianness() != Old) {
 286     sys::swapByteOrder<uint32_t>(NumValueSites);
 287     sys::swapByteOrder<uint32_t>(Kind);
 288   }
 289   uint32_t ND = getValueProfRecordNumValueData(this);
 290   InstrProfValueData *VD = getValueProfRecordValueData(this);
 291
 292   // No need to swap byte array: SiteCountArrray.
 293   for (uint32_t I = 0; I < ND; I++) {
 294     sys::swapByteOrder<uint64_t>(VD[I].Value);
 295     sys::swapByteOrder<uint64_t>(VD[I].Count);
 296   }
 297   if (getHostEndianness() == Old) {
 298     sys::swapByteOrder<uint32_t>(NumValueSites);
 299     sys::swapByteOrder<uint32_t>(Kind);
 300   }
 301 }
 302
 303 void ValueProfData::deserializeTo(InstrProfRecord &Record,
 304                                   InstrProfRecord::ValueMapType *VMap) {
 305   if (NumValueKinds == 0)
 306     return;
 307
 308   ValueProfRecord *VR = getFirstValueProfRecord(this);
 309   for (uint32_t K = 0; K < NumValueKinds; K++) {
 310     VR->deserializeTo(Record, VMap);
 311     VR = getValueProfRecordNext(VR);
 312   }
 313 }
 314
 315 template <class T>
 316 static T swapToHostOrder(const unsigned char *&D, support::endianness Orig) {
 317   using namespace support;
 318   if (Orig == little)
 319     return endian::readNext<T, little, unaligned>(D);
 320   else
 321     return endian::readNext<T, big, unaligned>(D);
 322 }
 323
 324 static std::unique_ptr<ValueProfData> allocValueProfData(uint32_t TotalSize) {
 325   return std::unique_ptr<ValueProfData>(new (::operator new(TotalSize))
 326                                             ValueProfData());
 327 }
 328
 329 ErrorOr<std::unique_ptr<ValueProfData>>
 330 ValueProfData::getValueProfData(const unsigned char *D,
 331                                 const unsigned char *const BufferEnd,
 332                                 support::endianness Endianness) {
 333   using namespace support;
 334   if (D + sizeof(ValueProfData) > BufferEnd)
 335     return instrprof_error::truncated;
 336
 337   const unsigned char *Header = D;
 338   uint32_t TotalSize = swapToHostOrder<uint32_t>(Header, Endianness);
 339   uint32_t NumValueKinds = swapToHostOrder<uint32_t>(Header, Endianness);
 340
 341   if (D + TotalSize > BufferEnd)
 342     return instrprof_error::too_large;
 343   if (NumValueKinds > IPVK_Last + 1)
 344     return instrprof_error::malformed;
 345   // Total size needs to be mulltiple of quadword size.
 346   if (TotalSize % sizeof(uint64_t))
 347     return instrprof_error::malformed;
 348
 349   std::unique_ptr<ValueProfData> VPD = allocValueProfData(TotalSize);
 350
 351   memcpy(VPD.get(), D, TotalSize);
 352   // Byte swap.
 353   VPD->swapBytesToHost(Endianness);
 354
 355   // Data integrity check:
 356   ValueProfRecord *VR = getFirstValueProfRecord(VPD.get());
 357   for (uint32_t K = 0; K < VPD->NumValueKinds; K++) {
 358     if (VR->Kind > IPVK_Last)
 359       return instrprof_error::malformed;
 360     VR = getValueProfRecordNext(VR);
 361     if ((char *)VR - (char *)VPD.get() > (ptrdiff_t)TotalSize)
 362       return instrprof_error::malformed;
 363   }
 364
 365   return std::move(VPD);
 366 }
 367
 368 void ValueProfData::swapBytesToHost(support::endianness Endianness) {
 369   using namespace support;
 370   if (Endianness == getHostEndianness())
 371     return;
 372
 373   sys::swapByteOrder<uint32_t>(TotalSize);
 374   sys::swapByteOrder<uint32_t>(NumValueKinds);
 375
 376   ValueProfRecord *VR = getFirstValueProfRecord(this);
 377   for (uint32_t K = 0; K < NumValueKinds; K++) {
 378     VR->swapBytes(Endianness, getHostEndianness());
 379     VR = getValueProfRecordNext(VR);
 380   }
 381 }
 382
 383 void ValueProfData::swapBytesFromHost(support::endianness Endianness) {
 384   using namespace support;
 385   if (Endianness == getHostEndianness())
 386     return;
 387
 388   ValueProfRecord *VR = getFirstValueProfRecord(this);
 389   for (uint32_t K = 0; K < NumValueKinds; K++) {
 390     ValueProfRecord *NVR = getValueProfRecordNext(VR);
 391     VR->swapBytes(getHostEndianness(), Endianness);
 392     VR = NVR;
 393   }
 394   sys::swapByteOrder<uint32_t>(TotalSize);
 395   sys::swapByteOrder<uint32_t>(NumValueKinds);
 396 }
 397
 398 }