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                            uint64_t Version LLVM_ATTRIBUTE_UNUSED) {
  79
  80   // Function names may be prefixed with a binary '1' to indicate
  81   // that the backend should not modify the symbols due to any platform
  82   // naming convention. Do not include that '1' in the PGO profile name.
  83   if (RawFuncName[0] == '\1')
  84     RawFuncName = RawFuncName.substr(1);
  85
  86   std::string FuncName = RawFuncName;
  87   if (llvm::GlobalValue::isLocalLinkage(Linkage)) {
  88     // For local symbols, prepend the main file name to distinguish them.
  89     // Do not include the full path in the file name since there's no guarantee
  90     // that it will stay the same, e.g., if the files are checked out from
  91     // version control in different locations.
  92     if (FileName.empty())
  93       FuncName = FuncName.insert(0, "<unknown>:");
  94     else
  95       FuncName = FuncName.insert(0, FileName.str() + ":");
  96   }
  97   return FuncName;
  98 }
  99
 100 std::string getPGOFuncName(const Function &F, uint64_t Version) {
 101   return getPGOFuncName(F.getName(), F.getLinkage(), F.getParent()->getName(),
 102                         Version);
 103 }
 104
 105 StringRef getFuncNameWithoutPrefix(StringRef PGOFuncName, StringRef FileName) {
 106   if (FileName.empty())
 107     return PGOFuncName;
 108   // Drop the file name including ':'. See also getPGOFuncName.
 109   if (PGOFuncName.startswith(FileName))
 110     PGOFuncName = PGOFuncName.drop_front(FileName.size() + 1);
 111   return PGOFuncName;
 112 }
 113
 114 // \p FuncName is the string used as profile lookup key for the function. A
 115 // symbol is created to hold the name. Return the legalized symbol name.
 116 static std::string getPGOFuncNameVarName(StringRef FuncName,
 117                                          GlobalValue::LinkageTypes Linkage) {
 118   std::string VarName = getInstrProfNameVarPrefix();
 119   VarName += FuncName;
 120
 121   if (!GlobalValue::isLocalLinkage(Linkage))
 122     return VarName;
 123
 124   // Now fix up illegal chars in local VarName that may upset the assembler.
 125   const char *InvalidChars = "-:<>\"'";
 126   size_t found = VarName.find_first_of(InvalidChars);
 127   while (found != std::string::npos) {
 128     VarName[found] = '_';
 129     found = VarName.find_first_of(InvalidChars, found + 1);
 130   }
 131   return VarName;
 132 }
 133
 134 GlobalVariable *createPGOFuncNameVar(Module &M,
 135                                      GlobalValue::LinkageTypes Linkage,
 136                                      StringRef FuncName) {
 137
 138   // We generally want to match the function's linkage, but available_externally
 139   // and extern_weak both have the wrong semantics, and anything that doesn't
 140   // need to link across compilation units doesn't need to be visible at all.
 141   if (Linkage == GlobalValue::ExternalWeakLinkage)
 142     Linkage = GlobalValue::LinkOnceAnyLinkage;
 143   else if (Linkage == GlobalValue::AvailableExternallyLinkage)
 144     Linkage = GlobalValue::LinkOnceODRLinkage;
 145   else if (Linkage == GlobalValue::InternalLinkage ||
 146            Linkage == GlobalValue::ExternalLinkage)
 147     Linkage = GlobalValue::PrivateLinkage;
 148
 149   auto *Value = ConstantDataArray::getString(M.getContext(), FuncName, false);
 150   auto FuncNameVar =
 151       new GlobalVariable(M, Value->getType(), true, Linkage, Value,
 152                          getPGOFuncNameVarName(FuncName, Linkage));
 153
 154   // Hide the symbol so that we correctly get a copy for each executable.
 155   if (!GlobalValue::isLocalLinkage(FuncNameVar->getLinkage()))
 156     FuncNameVar->setVisibility(GlobalValue::HiddenVisibility);
 157
 158   return FuncNameVar;
 159 }
 160
 161 GlobalVariable *createPGOFuncNameVar(Function &F, StringRef FuncName) {
 162   return createPGOFuncNameVar(*F.getParent(), F.getLinkage(), FuncName);
 163 }
 164
 165 #define INSTR_PROF_COMMON_API_IMPL
 166 #include "llvm/ProfileData/InstrProfData.inc"
 167
 168
 169 /*!
 170  * \brief ValueProfRecordClosure Interface implementation for  InstrProfRecord
 171  *  class. These C wrappers are used as adaptors so that C++ code can be
 172  *  invoked as callbacks.
 173  */
 174 uint32_t getNumValueKindsInstrProf(const void *Record) {
 175   return reinterpret_cast<const InstrProfRecord *>(Record)->getNumValueKinds();
 176 }
 177
 178 uint32_t getNumValueSitesInstrProf(const void *Record, uint32_t VKind) {
 179   return reinterpret_cast<const InstrProfRecord *>(Record)
 180       ->getNumValueSites(VKind);
 181 }
 182
 183 uint32_t getNumValueDataInstrProf(const void *Record, uint32_t VKind) {
 184   return reinterpret_cast<const InstrProfRecord *>(Record)
 185       ->getNumValueData(VKind);
 186 }
 187
 188 uint32_t getNumValueDataForSiteInstrProf(const void *R, uint32_t VK,
 189                                          uint32_t S) {
 190   return reinterpret_cast<const InstrProfRecord *>(R)
 191       ->getNumValueDataForSite(VK, S);
 192 }
 193
 194 void getValueForSiteInstrProf(const void *R, InstrProfValueData *Dst,
 195                               uint32_t K, uint32_t S,
 196                               uint64_t (*Mapper)(uint32_t, uint64_t)) {
 197   return reinterpret_cast<const InstrProfRecord *>(R)
 198       ->getValueForSite(Dst, K, S, Mapper);
 199 }
 200
 201 uint64_t stringToHash(uint32_t ValueKind, uint64_t Value) {
 202   switch (ValueKind) {
 203   case IPVK_IndirectCallTarget:
 204     return IndexedInstrProf::ComputeHash(IndexedInstrProf::HashType,
 205                                          (const char *)Value);
 206     break;
 207   default:
 208     llvm_unreachable("value kind not handled !");
 209   }
 210   return Value;
 211 }
 212
 213 ValueProfData *allocValueProfDataInstrProf(size_t TotalSizeInBytes) {
 214   return (ValueProfData *)(new (::operator new(TotalSizeInBytes))
 215                                ValueProfData());
 216 }
 217
 218 static ValueProfRecordClosure InstrProfRecordClosure = {
 219     0,
 220     getNumValueKindsInstrProf,
 221     getNumValueSitesInstrProf,
 222     getNumValueDataInstrProf,
 223     getNumValueDataForSiteInstrProf,
 224     stringToHash,
 225     getValueForSiteInstrProf,
 226     allocValueProfDataInstrProf
 227 };
 228
 229 // Wrapper implementation using the closure mechanism.
 230 uint32_t ValueProfData::getSize(const InstrProfRecord &Record) {
 231   InstrProfRecordClosure.Record = &Record;
 232   return getValueProfDataSize(&InstrProfRecordClosure);
 233 }
 234
 235 // Wrapper implementation using the closure mechanism.
 236 std::unique_ptr<ValueProfData>
 237 ValueProfData::serializeFrom(const InstrProfRecord &Record) {
 238   InstrProfRecordClosure.Record = &Record;
 239
 240   std::unique_ptr<ValueProfData> VPD(
 241       serializeValueProfDataFrom(&InstrProfRecordClosure, nullptr));
 242   return VPD;
 243 }
 244
 245 void ValueProfRecord::deserializeTo(InstrProfRecord &Record,
 246                                     InstrProfRecord::ValueMapType *VMap) {
 247   Record.reserveSites(Kind, NumValueSites);
 248
 249   InstrProfValueData *ValueData = getValueProfRecordValueData(this);
 250   for (uint64_t VSite = 0; VSite < NumValueSites; ++VSite) {
 251     uint8_t ValueDataCount = this->SiteCountArray[VSite];
 252     Record.addValueData(Kind, VSite, ValueData, ValueDataCount, VMap);
 253     ValueData += ValueDataCount;
 254   }
 255 }
 256
 257 // For writing/serializing,  Old is the host endianness, and  New is
 258 // byte order intended on disk. For Reading/deserialization, Old
 259 // is the on-disk source endianness, and New is the host endianness.
 260 void ValueProfRecord::swapBytes(support::endianness Old,
 261                                 support::endianness New) {
 262   using namespace support;
 263   if (Old == New)
 264     return;
 265
 266   if (getHostEndianness() != Old) {
 267     sys::swapByteOrder<uint32_t>(NumValueSites);
 268     sys::swapByteOrder<uint32_t>(Kind);
 269   }
 270   uint32_t ND = getValueProfRecordNumValueData(this);
 271   InstrProfValueData *VD = getValueProfRecordValueData(this);
 272
 273   // No need to swap byte array: SiteCountArrray.
 274   for (uint32_t I = 0; I < ND; I++) {
 275     sys::swapByteOrder<uint64_t>(VD[I].Value);
 276     sys::swapByteOrder<uint64_t>(VD[I].Count);
 277   }
 278   if (getHostEndianness() == Old) {
 279     sys::swapByteOrder<uint32_t>(NumValueSites);
 280     sys::swapByteOrder<uint32_t>(Kind);
 281   }
 282 }
 283
 284 void ValueProfData::deserializeTo(InstrProfRecord &Record,
 285                                   InstrProfRecord::ValueMapType *VMap) {
 286   if (NumValueKinds == 0)
 287     return;
 288
 289   ValueProfRecord *VR = getFirstValueProfRecord(this);
 290   for (uint32_t K = 0; K < NumValueKinds; K++) {
 291     VR->deserializeTo(Record, VMap);
 292     VR = getValueProfRecordNext(VR);
 293   }
 294 }
 295
 296 template <class T>
 297 static T swapToHostOrder(const unsigned char *&D, support::endianness Orig) {
 298   using namespace support;
 299   if (Orig == little)
 300     return endian::readNext<T, little, unaligned>(D);
 301   else
 302     return endian::readNext<T, big, unaligned>(D);
 303 }
 304
 305 static std::unique_ptr<ValueProfData> allocValueProfData(uint32_t TotalSize) {
 306   return std::unique_ptr<ValueProfData>(new (::operator new(TotalSize))
 307                                             ValueProfData());
 308 }
 309
 310 instrprof_error ValueProfData::checkIntegrity() {
 311   if (NumValueKinds > IPVK_Last + 1)
 312     return instrprof_error::malformed;
 313   // Total size needs to be mulltiple of quadword size.
 314   if (TotalSize % sizeof(uint64_t))
 315     return instrprof_error::malformed;
 316
 317   ValueProfRecord *VR = getFirstValueProfRecord(this);
 318   for (uint32_t K = 0; K < this->NumValueKinds; K++) {
 319     if (VR->Kind > IPVK_Last)
 320       return instrprof_error::malformed;
 321     VR = getValueProfRecordNext(VR);
 322     if ((char *)VR - (char *)this > (ptrdiff_t)TotalSize)
 323       return instrprof_error::malformed;
 324   }
 325   return instrprof_error::success;
 326 }
 327
 328 ErrorOr<std::unique_ptr<ValueProfData>>
 329 ValueProfData::getValueProfData(const unsigned char *D,
 330                                 const unsigned char *const BufferEnd,
 331                                 support::endianness Endianness) {
 332   using namespace support;
 333   if (D + sizeof(ValueProfData) > BufferEnd)
 334     return instrprof_error::truncated;
 335
 336   const unsigned char *Header = D;
 337   uint32_t TotalSize = swapToHostOrder<uint32_t>(Header, Endianness);
 338   if (D + TotalSize > BufferEnd)
 339     return instrprof_error::too_large;
 340
 341   std::unique_ptr<ValueProfData> VPD = allocValueProfData(TotalSize);
 342   memcpy(VPD.get(), D, TotalSize);
 343   // Byte swap.
 344   VPD->swapBytesToHost(Endianness);
 345
 346   instrprof_error EC = VPD->checkIntegrity();
 347   if (EC != instrprof_error::success)
 348     return EC;
 349
 350   return std::move(VPD);
 351 }
 352
 353 void ValueProfData::swapBytesToHost(support::endianness Endianness) {
 354   using namespace support;
 355   if (Endianness == getHostEndianness())
 356     return;
 357
 358   sys::swapByteOrder<uint32_t>(TotalSize);
 359   sys::swapByteOrder<uint32_t>(NumValueKinds);
 360
 361   ValueProfRecord *VR = getFirstValueProfRecord(this);
 362   for (uint32_t K = 0; K < NumValueKinds; K++) {
 363     VR->swapBytes(Endianness, getHostEndianness());
 364     VR = getValueProfRecordNext(VR);
 365   }
 366 }
 367
 368 void ValueProfData::swapBytesFromHost(support::endianness Endianness) {
 369   using namespace support;
 370   if (Endianness == getHostEndianness())
 371     return;
 372
 373   ValueProfRecord *VR = getFirstValueProfRecord(this);
 374   for (uint32_t K = 0; K < NumValueKinds; K++) {
 375     ValueProfRecord *NVR = getValueProfRecordNext(VR);
 376     VR->swapBytes(getHostEndianness(), Endianness);
 377     VR = NVR;
 378   }
 379   sys::swapByteOrder<uint32_t>(TotalSize);
 380   sys::swapByteOrder<uint32_t>(NumValueKinds);
 381 }
 382
 383 }