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 uint64_t stringToHash(uint32_t ValueKind, uint64_t Value) {
 135   switch (ValueKind) {
 136   case IPVK_IndirectCallTarget:
 137     return IndexedInstrProf::ComputeHash(IndexedInstrProf::HashType,
 138                                          (const char *)Value);
 139     break;
 140   default:
 141     llvm_unreachable("value kind not handled !");
 142   }
 143   return Value;
 144 }
 145
 146 void ValueProfRecord::deserializeTo(InstrProfRecord &Record,
 147                                     InstrProfRecord::ValueMapType *VMap) {
 148   Record.reserveSites(Kind, NumValueSites);
 149
 150   InstrProfValueData *ValueData = getValueProfRecordValueData(this);
 151   for (uint64_t VSite = 0; VSite < NumValueSites; ++VSite) {
 152     uint8_t ValueDataCount = this->SiteCountArray[VSite];
 153     Record.addValueData(Kind, VSite, ValueData, ValueDataCount, VMap);
 154     ValueData += ValueDataCount;
 155   }
 156 }
 157
 158 void ValueProfRecord::serializeFrom(const InstrProfRecord &Record,
 159                                     uint32_t ValueKind,
 160                                     uint32_t NumValueSites) {
 161   Kind = ValueKind;
 162   this->NumValueSites = NumValueSites;
 163   InstrProfValueData *DstVD = getValueProfRecordValueData(this);
 164   for (uint32_t S = 0; S < NumValueSites; S++) {
 165     uint32_t ND = Record.getNumValueDataForSite(ValueKind, S);
 166     SiteCountArray[S] = ND;
 167     Record.getValueForSite(DstVD, ValueKind, S, stringToHash);
 168     DstVD += ND;
 169   }
 170 }
 171
 172 template <class T>
 173 static T swapToHostOrder(const unsigned char *&D, support::endianness Orig) {
 174   using namespace support;
 175   if (Orig == little)
 176     return endian::readNext<T, little, unaligned>(D);
 177   else
 178     return endian::readNext<T, big, unaligned>(D);
 179 }
 180
 181 // For writing/serializing,  Old is the host endianness, and  New is
 182 // byte order intended on disk. For Reading/deserialization, Old
 183 // is the on-disk source endianness, and New is the host endianness.
 184 void ValueProfRecord::swapBytes(support::endianness Old,
 185                                 support::endianness New) {
 186   using namespace support;
 187   if (Old == New)
 188     return;
 189
 190   if (getHostEndianness() != Old) {
 191     sys::swapByteOrder<uint32_t>(NumValueSites);
 192     sys::swapByteOrder<uint32_t>(Kind);
 193   }
 194   uint32_t ND = getValueProfRecordNumValueData(this);
 195   InstrProfValueData *VD = getValueProfRecordValueData(this);
 196
 197   // No need to swap byte array: SiteCountArrray.
 198   for (uint32_t I = 0; I < ND; I++) {
 199     sys::swapByteOrder<uint64_t>(VD[I].Value);
 200     sys::swapByteOrder<uint64_t>(VD[I].Count);
 201   }
 202   if (getHostEndianness() == Old) {
 203     sys::swapByteOrder<uint32_t>(NumValueSites);
 204     sys::swapByteOrder<uint32_t>(Kind);
 205   }
 206 }
 207
 208 uint32_t ValueProfData::getSize(const InstrProfRecord &Record) {
 209   uint32_t TotalSize = sizeof(ValueProfData);
 210   uint32_t NumValueKinds = Record.getNumValueKinds();
 211   if (NumValueKinds == 0)
 212     return TotalSize;
 213
 214   for (uint32_t Kind = IPVK_First; Kind <= IPVK_Last; Kind++) {
 215     uint32_t NumValueSites = Record.getNumValueSites(Kind);
 216     if (!NumValueSites)
 217       continue;
 218     TotalSize +=
 219         getValueProfRecordSize(NumValueSites, Record.getNumValueData(Kind));
 220   }
 221   return TotalSize;
 222 }
 223
 224 void ValueProfData::deserializeTo(InstrProfRecord &Record,
 225                                   InstrProfRecord::ValueMapType *VMap) {
 226   if (NumValueKinds == 0)
 227     return;
 228
 229   ValueProfRecord *VR = getFirstValueProfRecord();
 230   for (uint32_t K = 0; K < NumValueKinds; K++) {
 231     VR->deserializeTo(Record, VMap);
 232     VR = getValueProfRecordNext(VR);
 233   }
 234 }
 235
 236 static std::unique_ptr<ValueProfData> AllocValueProfData(uint32_t TotalSize) {
 237   return std::unique_ptr<ValueProfData>(new (::operator new(TotalSize))
 238                                             ValueProfData());
 239 }
 240
 241 std::unique_ptr<ValueProfData>
 242 ValueProfData::serializeFrom(const InstrProfRecord &Record) {
 243   uint32_t TotalSize = getSize(Record);
 244
 245   std::unique_ptr<ValueProfData> VPD = AllocValueProfData(TotalSize);
 246
 247   VPD->TotalSize = TotalSize;
 248   VPD->NumValueKinds = Record.getNumValueKinds();
 249   ValueProfRecord *VR = VPD->getFirstValueProfRecord();
 250   for (uint32_t Kind = IPVK_First; Kind <= IPVK_Last; Kind++) {
 251     uint32_t NumValueSites = Record.getNumValueSites(Kind);
 252     if (!NumValueSites)
 253       continue;
 254     VR->serializeFrom(Record, Kind, NumValueSites);
 255     VR = getValueProfRecordNext(VR);
 256   }
 257   return VPD;
 258 }
 259
 260 ErrorOr<std::unique_ptr<ValueProfData>>
 261 ValueProfData::getValueProfData(const unsigned char *D,
 262                                 const unsigned char *const BufferEnd,
 263                                 support::endianness Endianness) {
 264   using namespace support;
 265   if (D + sizeof(ValueProfData) > BufferEnd)
 266     return instrprof_error::truncated;
 267
 268   const unsigned char *Header = D;
 269   uint32_t TotalSize = swapToHostOrder<uint32_t>(Header, Endianness);
 270   uint32_t NumValueKinds = swapToHostOrder<uint32_t>(Header, Endianness);
 271
 272   if (D + TotalSize > BufferEnd)
 273     return instrprof_error::too_large;
 274   if (NumValueKinds > IPVK_Last + 1)
 275     return instrprof_error::malformed;
 276   // Total size needs to be mulltiple of quadword size.
 277   if (TotalSize % sizeof(uint64_t))
 278     return instrprof_error::malformed;
 279
 280   std::unique_ptr<ValueProfData> VPD = AllocValueProfData(TotalSize);
 281
 282   memcpy(VPD.get(), D, TotalSize);
 283   // Byte swap.
 284   VPD->swapBytesToHost(Endianness);
 285
 286   // Data integrity check:
 287   ValueProfRecord *VR = VPD->getFirstValueProfRecord();
 288   for (uint32_t K = 0; K < VPD->NumValueKinds; K++) {
 289     if (VR->Kind > IPVK_Last)
 290       return instrprof_error::malformed;
 291     VR = getValueProfRecordNext(VR);
 292     if ((char *)VR - (char *)VPD.get() > (ptrdiff_t)TotalSize)
 293       return instrprof_error::malformed;
 294   }
 295
 296   return std::move(VPD);
 297 }
 298
 299 void ValueProfData::swapBytesToHost(support::endianness Endianness) {
 300   using namespace support;
 301   if (Endianness == getHostEndianness())
 302     return;
 303
 304   sys::swapByteOrder<uint32_t>(TotalSize);
 305   sys::swapByteOrder<uint32_t>(NumValueKinds);
 306
 307   ValueProfRecord *VR = getFirstValueProfRecord();
 308   for (uint32_t K = 0; K < NumValueKinds; K++) {
 309     VR->swapBytes(Endianness, getHostEndianness());
 310     VR = getValueProfRecordNext(VR);
 311   }
 312 }
 313
 314 void ValueProfData::swapBytesFromHost(support::endianness Endianness) {
 315   using namespace support;
 316   if (Endianness == getHostEndianness())
 317     return;
 318
 319   ValueProfRecord *VR = getFirstValueProfRecord();
 320   for (uint32_t K = 0; K < NumValueKinds; K++) {
 321     ValueProfRecord *NVR = getValueProfRecordNext(VR);
 322     VR->swapBytes(getHostEndianness(), Endianness);
 323     VR = NVR;
 324   }
 325   sys::swapByteOrder<uint32_t>(TotalSize);
 326   sys::swapByteOrder<uint32_t>(NumValueKinds);
 327 }
 328
 329 ValueProfRecord *ValueProfData::getFirstValueProfRecord() {
 330   return reinterpret_cast<ValueProfRecord *>((char *)this +
 331                                              sizeof(ValueProfData));
 332 }
 333 }