LLVM  6.0.0svn
InstrProf.cpp
Go to the documentation of this file.
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 
16 #include "llvm/ADT/ArrayRef.h"
17 #include "llvm/ADT/SmallString.h"
18 #include "llvm/ADT/SmallVector.h"
19 #include "llvm/ADT/StringExtras.h"
20 #include "llvm/ADT/StringRef.h"
21 #include "llvm/ADT/Triple.h"
22 #include "llvm/IR/Constant.h"
23 #include "llvm/IR/Constants.h"
24 #include "llvm/IR/Function.h"
25 #include "llvm/IR/GlobalValue.h"
26 #include "llvm/IR/GlobalVariable.h"
27 #include "llvm/IR/Instruction.h"
28 #include "llvm/IR/LLVMContext.h"
29 #include "llvm/IR/MDBuilder.h"
30 #include "llvm/IR/Metadata.h"
31 #include "llvm/IR/Module.h"
32 #include "llvm/IR/Type.h"
33 #include "llvm/Support/Casting.h"
35 #include "llvm/Support/Compiler.h"
37 #include "llvm/Support/Endian.h"
38 #include "llvm/Support/Error.h"
40 #include "llvm/Support/LEB128.h"
43 #include "llvm/Support/Path.h"
45 #include <algorithm>
46 #include <cassert>
47 #include <cstddef>
48 #include <cstdint>
49 #include <cstring>
50 #include <memory>
51 #include <string>
52 #include <system_error>
53 #include <utility>
54 #include <vector>
55 
56 using namespace llvm;
57 
59  "static-func-full-module-prefix", cl::init(true),
60  cl::desc("Use full module build paths in the profile counter names for "
61  "static functions."));
62 
63 // This option is tailored to users that have different top-level directory in
64 // profile-gen and profile-use compilation. Users need to specific the number
65 // of levels to strip. A value larger than the number of directories in the
66 // source file will strip all the directory names and only leave the basename.
67 //
68 // Note current ThinLTO module importing for the indirect-calls assumes
69 // the source directory name not being stripped. A non-zero option value here
70 // can potentially prevent some inter-module indirect-call-promotions.
72  "static-func-strip-dirname-prefix", cl::init(0),
73  cl::desc("Strip specified level of directory name from source path in "
74  "the profile counter name for static functions."));
75 
76 static std::string getInstrProfErrString(instrprof_error Err) {
77  switch (Err) {
79  return "Success";
81  return "End of File";
83  return "Unrecognized instrumentation profile encoding format";
85  return "Invalid instrumentation profile data (bad magic)";
87  return "Invalid instrumentation profile data (file header is corrupt)";
89  return "Unsupported instrumentation profile format version";
91  return "Unsupported instrumentation profile hash type";
93  return "Too much profile data";
95  return "Truncated profile data";
97  return "Malformed instrumentation profile data";
99  return "No profile data available for function";
101  return "Function control flow change detected (hash mismatch)";
103  return "Function basic block count change detected (counter mismatch)";
105  return "Counter overflow";
107  return "Function value site count change detected (counter mismatch)";
109  return "Failed to compress data (zlib)";
111  return "Failed to uncompress data (zlib)";
113  return "Empty raw profile file";
115  return "Profile uses zlib compression but the profile reader was built without zlib support";
116  }
117  llvm_unreachable("A value of instrprof_error has no message.");
118 }
119 
120 namespace {
121 
122 // FIXME: This class is only here to support the transition to llvm::Error. It
123 // will be removed once this transition is complete. Clients should prefer to
124 // deal with the Error value directly, rather than converting to error_code.
125 class InstrProfErrorCategoryType : public std::error_category {
126  const char *name() const noexcept override { return "llvm.instrprof"; }
127 
128  std::string message(int IE) const override {
129  return getInstrProfErrString(static_cast<instrprof_error>(IE));
130  }
131 };
132 
133 } // end anonymous namespace
134 
136 
138  return *ErrorCategory;
139 }
140 
141 namespace {
142 
143 const char *InstrProfSectNameCommon[] = {
144 #define INSTR_PROF_SECT_ENTRY(Kind, SectNameCommon, SectNameCoff, Prefix) \
145  SectNameCommon,
147 };
148 
149 const char *InstrProfSectNameCoff[] = {
150 #define INSTR_PROF_SECT_ENTRY(Kind, SectNameCommon, SectNameCoff, Prefix) \
151  SectNameCoff,
153 };
154 
155 const char *InstrProfSectNamePrefix[] = {
156 #define INSTR_PROF_SECT_ENTRY(Kind, SectNameCommon, SectNameCoff, Prefix) \
157  Prefix,
159 };
160 
161 } // namespace
162 
163 namespace llvm {
164 
167  bool AddSegmentInfo) {
168  std::string SectName;
169 
170  if (OF == Triple::MachO && AddSegmentInfo)
171  SectName = InstrProfSectNamePrefix[IPSK];
172 
173  if (OF == Triple::COFF)
174  SectName += InstrProfSectNameCoff[IPSK];
175  else
176  SectName += InstrProfSectNameCommon[IPSK];
177 
178  if (OF == Triple::MachO && IPSK == IPSK_data && AddSegmentInfo)
179  SectName += ",regular,live_support";
180 
181  return SectName;
182 }
183 
185  if (IE == instrprof_error::success)
186  return;
187 
188  if (FirstError == instrprof_error::success)
189  FirstError = IE;
190 
191  switch (IE) {
193  ++NumHashMismatches;
194  break;
196  ++NumCountMismatches;
197  break;
199  ++NumCounterOverflows;
200  break;
202  ++NumValueSiteCountMismatches;
203  break;
204  default:
205  llvm_unreachable("Not a soft error");
206  }
207 }
208 
209 std::string InstrProfError::message() const {
210  return getInstrProfErrString(Err);
211 }
212 
213 char InstrProfError::ID = 0;
214 
215 std::string getPGOFuncName(StringRef RawFuncName,
217  StringRef FileName,
218  uint64_t Version LLVM_ATTRIBUTE_UNUSED) {
219  return GlobalValue::getGlobalIdentifier(RawFuncName, Linkage, FileName);
220 }
221 
222 // Strip NumPrefix level of directory name from PathNameStr. If the number of
223 // directory separators is less than NumPrefix, strip all the directories and
224 // leave base file name only.
225 static StringRef stripDirPrefix(StringRef PathNameStr, uint32_t NumPrefix) {
226  uint32_t Count = NumPrefix;
227  uint32_t Pos = 0, LastPos = 0;
228  for (auto & CI : PathNameStr) {
229  ++Pos;
231  LastPos = Pos;
232  --Count;
233  }
234  if (Count == 0)
235  break;
236  }
237  return PathNameStr.substr(LastPos);
238 }
239 
240 // Return the PGOFuncName. This function has some special handling when called
241 // in LTO optimization. The following only applies when calling in LTO passes
242 // (when \c InLTO is true): LTO's internalization privatizes many global linkage
243 // symbols. This happens after value profile annotation, but those internal
244 // linkage functions should not have a source prefix.
245 // Additionally, for ThinLTO mode, exported internal functions are promoted
246 // and renamed. We need to ensure that the original internal PGO name is
247 // used when computing the GUID that is compared against the profiled GUIDs.
248 // To differentiate compiler generated internal symbols from original ones,
249 // PGOFuncName meta data are created and attached to the original internal
250 // symbols in the value profile annotation step
251 // (PGOUseFunc::annotateIndirectCallSites). If a symbol does not have the meta
252 // data, its original linkage must be non-internal.
253 std::string getPGOFuncName(const Function &F, bool InLTO, uint64_t Version) {
254  if (!InLTO) {
256  ? F.getParent()->getName()
259  FileName = stripDirPrefix(FileName, StaticFuncStripDirNamePrefix);
260  return getPGOFuncName(F.getName(), F.getLinkage(), FileName, Version);
261  }
262 
263  // In LTO mode (when InLTO is true), first check if there is a meta data.
264  if (MDNode *MD = getPGOFuncNameMetadata(F)) {
265  StringRef S = cast<MDString>(MD->getOperand(0))->getString();
266  return S.str();
267  }
268 
269  // If there is no meta data, the function must be a global before the value
270  // profile annotation pass. Its current linkage may be internal if it is
271  // internalized in LTO mode.
273 }
274 
276  if (FileName.empty())
277  return PGOFuncName;
278  // Drop the file name including ':'. See also getPGOFuncName.
279  if (PGOFuncName.startswith(FileName))
280  PGOFuncName = PGOFuncName.drop_front(FileName.size() + 1);
281  return PGOFuncName;
282 }
283 
284 // \p FuncName is the string used as profile lookup key for the function. A
285 // symbol is created to hold the name. Return the legalized symbol name.
286 std::string getPGOFuncNameVarName(StringRef FuncName,
287  GlobalValue::LinkageTypes Linkage) {
288  std::string VarName = getInstrProfNameVarPrefix();
289  VarName += FuncName;
290 
291  if (!GlobalValue::isLocalLinkage(Linkage))
292  return VarName;
293 
294  // Now fix up illegal chars in local VarName that may upset the assembler.
295  const char *InvalidChars = "-:<>/\"'";
296  size_t found = VarName.find_first_of(InvalidChars);
297  while (found != std::string::npos) {
298  VarName[found] = '_';
299  found = VarName.find_first_of(InvalidChars, found + 1);
300  }
301  return VarName;
302 }
303 
306  StringRef PGOFuncName) {
307  // We generally want to match the function's linkage, but available_externally
308  // and extern_weak both have the wrong semantics, and anything that doesn't
309  // need to link across compilation units doesn't need to be visible at all.
310  if (Linkage == GlobalValue::ExternalWeakLinkage)
312  else if (Linkage == GlobalValue::AvailableExternallyLinkage)
314  else if (Linkage == GlobalValue::InternalLinkage ||
315  Linkage == GlobalValue::ExternalLinkage)
316  Linkage = GlobalValue::PrivateLinkage;
317 
318  auto *Value =
319  ConstantDataArray::getString(M.getContext(), PGOFuncName, false);
320  auto FuncNameVar =
321  new GlobalVariable(M, Value->getType(), true, Linkage, Value,
322  getPGOFuncNameVarName(PGOFuncName, Linkage));
323 
324  // Hide the symbol so that we correctly get a copy for each executable.
325  if (!GlobalValue::isLocalLinkage(FuncNameVar->getLinkage()))
327 
328  return FuncNameVar;
329 }
330 
332  return createPGOFuncNameVar(*F.getParent(), F.getLinkage(), PGOFuncName);
333 }
334 
336  for (Function &F : M) {
337  // Function may not have a name: like using asm("") to overwrite the name.
338  // Ignore in this case.
339  if (!F.hasName())
340  continue;
341  const std::string &PGOFuncName = getPGOFuncName(F, InLTO);
342  if (Error E = addFuncName(PGOFuncName))
343  return E;
344  MD5FuncMap.emplace_back(Function::getGUID(PGOFuncName), &F);
345  // In ThinLTO, local function may have been promoted to global and have
346  // suffix added to the function name. We need to add the stripped function
347  // name to the symbol table so that we can find a match from profile.
348  if (InLTO) {
349  auto pos = PGOFuncName.find('.');
350  if (pos != std::string::npos) {
351  const std::string &OtherFuncName = PGOFuncName.substr(0, pos);
352  if (Error E = addFuncName(OtherFuncName))
353  return E;
354  MD5FuncMap.emplace_back(Function::getGUID(OtherFuncName), &F);
355  }
356  }
357  }
358 
359  finalizeSymtab();
360  return Error::success();
361 }
362 
364  bool doCompression, std::string &Result) {
365  assert(!NameStrs.empty() && "No name data to emit");
366 
367  uint8_t Header[16], *P = Header;
368  std::string UncompressedNameStrings =
369  join(NameStrs.begin(), NameStrs.end(), getInstrProfNameSeparator());
370 
371  assert(StringRef(UncompressedNameStrings)
372  .count(getInstrProfNameSeparator()) == (NameStrs.size() - 1) &&
373  "PGO name is invalid (contains separator token)");
374 
375  unsigned EncLen = encodeULEB128(UncompressedNameStrings.length(), P);
376  P += EncLen;
377 
378  auto WriteStringToResult = [&](size_t CompressedLen, StringRef InputStr) {
379  EncLen = encodeULEB128(CompressedLen, P);
380  P += EncLen;
381  char *HeaderStr = reinterpret_cast<char *>(&Header[0]);
382  unsigned HeaderLen = P - &Header[0];
383  Result.append(HeaderStr, HeaderLen);
384  Result += InputStr;
385  return Error::success();
386  };
387 
388  if (!doCompression) {
389  return WriteStringToResult(0, UncompressedNameStrings);
390  }
391 
392  SmallString<128> CompressedNameStrings;
393  Error E = zlib::compress(StringRef(UncompressedNameStrings),
394  CompressedNameStrings, zlib::BestSizeCompression);
395  if (E) {
396  consumeError(std::move(E));
397  return make_error<InstrProfError>(instrprof_error::compress_failed);
398  }
399 
400  return WriteStringToResult(CompressedNameStrings.size(),
401  CompressedNameStrings);
402 }
403 
405  auto *Arr = cast<ConstantDataArray>(NameVar->getInitializer());
406  StringRef NameStr =
407  Arr->isCString() ? Arr->getAsCString() : Arr->getAsString();
408  return NameStr;
409 }
410 
412  std::string &Result, bool doCompression) {
413  std::vector<std::string> NameStrs;
414  for (auto *NameVar : NameVars) {
415  NameStrs.push_back(getPGOFuncNameVarInitializer(NameVar));
416  }
418  NameStrs, zlib::isAvailable() && doCompression, Result);
419 }
420 
422  const uint8_t *P = reinterpret_cast<const uint8_t *>(NameStrings.data());
423  const uint8_t *EndP = reinterpret_cast<const uint8_t *>(NameStrings.data() +
424  NameStrings.size());
425  while (P < EndP) {
426  uint32_t N;
427  uint64_t UncompressedSize = decodeULEB128(P, &N);
428  P += N;
429  uint64_t CompressedSize = decodeULEB128(P, &N);
430  P += N;
431  bool isCompressed = (CompressedSize != 0);
432  SmallString<128> UncompressedNameStrings;
433  StringRef NameStrings;
434  if (isCompressed) {
436  return make_error<InstrProfError>(instrprof_error::zlib_unavailable);
437 
438  StringRef CompressedNameStrings(reinterpret_cast<const char *>(P),
439  CompressedSize);
440  if (Error E =
441  zlib::uncompress(CompressedNameStrings, UncompressedNameStrings,
442  UncompressedSize)) {
443  consumeError(std::move(E));
444  return make_error<InstrProfError>(instrprof_error::uncompress_failed);
445  }
446  P += CompressedSize;
447  NameStrings = StringRef(UncompressedNameStrings.data(),
448  UncompressedNameStrings.size());
449  } else {
450  NameStrings =
451  StringRef(reinterpret_cast<const char *>(P), UncompressedSize);
452  P += UncompressedSize;
453  }
454  // Now parse the name strings.
456  NameStrings.split(Names, getInstrProfNameSeparator());
457  for (StringRef &Name : Names)
458  if (Error E = Symtab.addFuncName(Name))
459  return E;
460 
461  while (P < EndP && *P == 0)
462  P++;
463  }
464  Symtab.finalizeSymtab();
465  return Error::success();
466 }
467 
469  uint64_t Weight,
470  function_ref<void(instrprof_error)> Warn) {
471  this->sortByTargetValues();
472  Input.sortByTargetValues();
473  auto I = ValueData.begin();
474  auto IE = ValueData.end();
475  for (auto J = Input.ValueData.begin(), JE = Input.ValueData.end(); J != JE;
476  ++J) {
477  while (I != IE && I->Value < J->Value)
478  ++I;
479  if (I != IE && I->Value == J->Value) {
480  bool Overflowed;
481  I->Count = SaturatingMultiplyAdd(J->Count, Weight, I->Count, &Overflowed);
482  if (Overflowed)
484  ++I;
485  continue;
486  }
487  ValueData.insert(I, *J);
488  }
489 }
490 
491 void InstrProfValueSiteRecord::scale(uint64_t Weight,
492  function_ref<void(instrprof_error)> Warn) {
493  for (auto I = ValueData.begin(), IE = ValueData.end(); I != IE; ++I) {
494  bool Overflowed;
495  I->Count = SaturatingMultiply(I->Count, Weight, &Overflowed);
496  if (Overflowed)
498  }
499 }
500 
501 // Merge Value Profile data from Src record to this record for ValueKind.
502 // Scale merged value counts by \p Weight.
503 void InstrProfRecord::mergeValueProfData(
504  uint32_t ValueKind, InstrProfRecord &Src, uint64_t Weight,
505  function_ref<void(instrprof_error)> Warn) {
506  uint32_t ThisNumValueSites = getNumValueSites(ValueKind);
507  uint32_t OtherNumValueSites = Src.getNumValueSites(ValueKind);
508  if (ThisNumValueSites != OtherNumValueSites) {
510  return;
511  }
512  if (!ThisNumValueSites)
513  return;
514  std::vector<InstrProfValueSiteRecord> &ThisSiteRecords =
515  getOrCreateValueSitesForKind(ValueKind);
517  Src.getValueSitesForKind(ValueKind);
518  for (uint32_t I = 0; I < ThisNumValueSites; I++)
519  ThisSiteRecords[I].merge(OtherSiteRecords[I], Weight, Warn);
520 }
521 
522 void InstrProfRecord::merge(InstrProfRecord &Other, uint64_t Weight,
523  function_ref<void(instrprof_error)> Warn) {
524  // If the number of counters doesn't match we either have bad data
525  // or a hash collision.
526  if (Counts.size() != Other.Counts.size()) {
528  return;
529  }
530 
531  for (size_t I = 0, E = Other.Counts.size(); I < E; ++I) {
532  bool Overflowed;
533  Counts[I] =
534  SaturatingMultiplyAdd(Other.Counts[I], Weight, Counts[I], &Overflowed);
535  if (Overflowed)
537  }
538 
539  for (uint32_t Kind = IPVK_First; Kind <= IPVK_Last; ++Kind)
540  mergeValueProfData(Kind, Other, Weight, Warn);
541 }
542 
543 void InstrProfRecord::scaleValueProfData(
544  uint32_t ValueKind, uint64_t Weight,
545  function_ref<void(instrprof_error)> Warn) {
546  for (auto &R : getValueSitesForKind(ValueKind))
547  R.scale(Weight, Warn);
548 }
549 
550 void InstrProfRecord::scale(uint64_t Weight,
551  function_ref<void(instrprof_error)> Warn) {
552  for (auto &Count : this->Counts) {
553  bool Overflowed;
554  Count = SaturatingMultiply(Count, Weight, &Overflowed);
555  if (Overflowed)
557  }
558  for (uint32_t Kind = IPVK_First; Kind <= IPVK_Last; ++Kind)
559  scaleValueProfData(Kind, Weight, Warn);
560 }
561 
562 // Map indirect call target name hash to name string.
563 uint64_t InstrProfRecord::remapValue(uint64_t Value, uint32_t ValueKind,
565  if (!ValueMap)
566  return Value;
567  switch (ValueKind) {
568  case IPVK_IndirectCallTarget: {
569  auto Result =
570  std::lower_bound(ValueMap->begin(), ValueMap->end(), Value,
571  [](const std::pair<uint64_t, uint64_t> &LHS,
572  uint64_t RHS) { return LHS.first < RHS; });
573  // Raw function pointer collected by value profiler may be from
574  // external functions that are not instrumented. They won't have
575  // mapping data to be used by the deserializer. Force the value to
576  // be 0 in this case.
577  if (Result != ValueMap->end() && Result->first == Value)
578  Value = (uint64_t)Result->second;
579  else
580  Value = 0;
581  break;
582  }
583  }
584  return Value;
585 }
586 
588  InstrProfValueData *VData, uint32_t N,
589  ValueMapType *ValueMap) {
590  for (uint32_t I = 0; I < N; I++) {
591  VData[I].Value = remapValue(VData[I].Value, ValueKind, ValueMap);
592  }
593  std::vector<InstrProfValueSiteRecord> &ValueSites =
594  getOrCreateValueSitesForKind(ValueKind);
595  if (N == 0)
596  ValueSites.emplace_back();
597  else
598  ValueSites.emplace_back(VData, VData + N);
599 }
600 
601 #define INSTR_PROF_COMMON_API_IMPL
603 
604 /*!
605  * \brief ValueProfRecordClosure Interface implementation for InstrProfRecord
606  * class. These C wrappers are used as adaptors so that C++ code can be
607  * invoked as callbacks.
608  */
610  return reinterpret_cast<const InstrProfRecord *>(Record)->getNumValueKinds();
611 }
612 
614  return reinterpret_cast<const InstrProfRecord *>(Record)
615  ->getNumValueSites(VKind);
616 }
617 
619  return reinterpret_cast<const InstrProfRecord *>(Record)
620  ->getNumValueData(VKind);
621 }
622 
624  uint32_t S) {
625  return reinterpret_cast<const InstrProfRecord *>(R)
626  ->getNumValueDataForSite(VK, S);
627 }
628 
629 void getValueForSiteInstrProf(const void *R, InstrProfValueData *Dst,
630  uint32_t K, uint32_t S) {
631  reinterpret_cast<const InstrProfRecord *>(R)->getValueForSite(Dst, K, S);
632 }
633 
634 ValueProfData *allocValueProfDataInstrProf(size_t TotalSizeInBytes) {
635  ValueProfData *VD =
636  (ValueProfData *)(new (::operator new(TotalSizeInBytes)) ValueProfData());
637  memset(VD, 0, TotalSizeInBytes);
638  return VD;
639 }
640 
641 static ValueProfRecordClosure InstrProfRecordClosure = {
642  nullptr,
647  nullptr,
650 
651 // Wrapper implementation using the closure mechanism.
652 uint32_t ValueProfData::getSize(const InstrProfRecord &Record) {
653  auto Closure = InstrProfRecordClosure;
654  Closure.Record = &Record;
655  return getValueProfDataSize(&Closure);
656 }
657 
658 // Wrapper implementation using the closure mechanism.
659 std::unique_ptr<ValueProfData>
660 ValueProfData::serializeFrom(const InstrProfRecord &Record) {
661  InstrProfRecordClosure.Record = &Record;
662 
663  std::unique_ptr<ValueProfData> VPD(
664  serializeValueProfDataFrom(&InstrProfRecordClosure, nullptr));
665  return VPD;
666 }
667 
668 void ValueProfRecord::deserializeTo(InstrProfRecord &Record,
670  Record.reserveSites(Kind, NumValueSites);
671 
672  InstrProfValueData *ValueData = getValueProfRecordValueData(this);
673  for (uint64_t VSite = 0; VSite < NumValueSites; ++VSite) {
674  uint8_t ValueDataCount = this->SiteCountArray[VSite];
675  Record.addValueData(Kind, VSite, ValueData, ValueDataCount, VMap);
676  ValueData += ValueDataCount;
677  }
678 }
679 
680 // For writing/serializing, Old is the host endianness, and New is
681 // byte order intended on disk. For Reading/deserialization, Old
682 // is the on-disk source endianness, and New is the host endianness.
683 void ValueProfRecord::swapBytes(support::endianness Old,
684  support::endianness New) {
685  using namespace support;
686 
687  if (Old == New)
688  return;
689 
690  if (getHostEndianness() != Old) {
691  sys::swapByteOrder<uint32_t>(NumValueSites);
692  sys::swapByteOrder<uint32_t>(Kind);
693  }
694  uint32_t ND = getValueProfRecordNumValueData(this);
695  InstrProfValueData *VD = getValueProfRecordValueData(this);
696 
697  // No need to swap byte array: SiteCountArrray.
698  for (uint32_t I = 0; I < ND; I++) {
699  sys::swapByteOrder<uint64_t>(VD[I].Value);
700  sys::swapByteOrder<uint64_t>(VD[I].Count);
701  }
702  if (getHostEndianness() == Old) {
703  sys::swapByteOrder<uint32_t>(NumValueSites);
704  sys::swapByteOrder<uint32_t>(Kind);
705  }
706 }
707 
708 void ValueProfData::deserializeTo(InstrProfRecord &Record,
710  if (NumValueKinds == 0)
711  return;
712 
713  ValueProfRecord *VR = getFirstValueProfRecord(this);
714  for (uint32_t K = 0; K < NumValueKinds; K++) {
715  VR->deserializeTo(Record, VMap);
716  VR = getValueProfRecordNext(VR);
717  }
718 }
719 
720 template <class T>
721 static T swapToHostOrder(const unsigned char *&D, support::endianness Orig) {
722  using namespace support;
723 
724  if (Orig == little)
725  return endian::readNext<T, little, unaligned>(D);
726  else
727  return endian::readNext<T, big, unaligned>(D);
728 }
729 
730 static std::unique_ptr<ValueProfData> allocValueProfData(uint32_t TotalSize) {
731  return std::unique_ptr<ValueProfData>(new (::operator new(TotalSize))
732  ValueProfData());
733 }
734 
735 Error ValueProfData::checkIntegrity() {
736  if (NumValueKinds > IPVK_Last + 1)
737  return make_error<InstrProfError>(instrprof_error::malformed);
738  // Total size needs to be mulltiple of quadword size.
739  if (TotalSize % sizeof(uint64_t))
740  return make_error<InstrProfError>(instrprof_error::malformed);
741 
742  ValueProfRecord *VR = getFirstValueProfRecord(this);
743  for (uint32_t K = 0; K < this->NumValueKinds; K++) {
744  if (VR->Kind > IPVK_Last)
745  return make_error<InstrProfError>(instrprof_error::malformed);
746  VR = getValueProfRecordNext(VR);
747  if ((char *)VR - (char *)this > (ptrdiff_t)TotalSize)
748  return make_error<InstrProfError>(instrprof_error::malformed);
749  }
750  return Error::success();
751 }
752 
754 ValueProfData::getValueProfData(const unsigned char *D,
755  const unsigned char *const BufferEnd,
756  support::endianness Endianness) {
757  using namespace support;
758 
759  if (D + sizeof(ValueProfData) > BufferEnd)
760  return make_error<InstrProfError>(instrprof_error::truncated);
761 
762  const unsigned char *Header = D;
763  uint32_t TotalSize = swapToHostOrder<uint32_t>(Header, Endianness);
764  if (D + TotalSize > BufferEnd)
765  return make_error<InstrProfError>(instrprof_error::too_large);
766 
767  std::unique_ptr<ValueProfData> VPD = allocValueProfData(TotalSize);
768  memcpy(VPD.get(), D, TotalSize);
769  // Byte swap.
770  VPD->swapBytesToHost(Endianness);
771 
772  Error E = VPD->checkIntegrity();
773  if (E)
774  return std::move(E);
775 
776  return std::move(VPD);
777 }
778 
779 void ValueProfData::swapBytesToHost(support::endianness Endianness) {
780  using namespace support;
781 
782  if (Endianness == getHostEndianness())
783  return;
784 
785  sys::swapByteOrder<uint32_t>(TotalSize);
786  sys::swapByteOrder<uint32_t>(NumValueKinds);
787 
788  ValueProfRecord *VR = getFirstValueProfRecord(this);
789  for (uint32_t K = 0; K < NumValueKinds; K++) {
790  VR->swapBytes(Endianness, getHostEndianness());
791  VR = getValueProfRecordNext(VR);
792  }
793 }
794 
795 void ValueProfData::swapBytesFromHost(support::endianness Endianness) {
796  using namespace support;
797 
798  if (Endianness == getHostEndianness())
799  return;
800 
801  ValueProfRecord *VR = getFirstValueProfRecord(this);
802  for (uint32_t K = 0; K < NumValueKinds; K++) {
803  ValueProfRecord *NVR = getValueProfRecordNext(VR);
804  VR->swapBytes(getHostEndianness(), Endianness);
805  VR = NVR;
806  }
807  sys::swapByteOrder<uint32_t>(TotalSize);
808  sys::swapByteOrder<uint32_t>(NumValueKinds);
809 }
810 
812  const InstrProfRecord &InstrProfR,
813  InstrProfValueKind ValueKind, uint32_t SiteIdx,
814  uint32_t MaxMDCount) {
815  uint32_t NV = InstrProfR.getNumValueDataForSite(ValueKind, SiteIdx);
816  if (!NV)
817  return;
818 
819  uint64_t Sum = 0;
820  std::unique_ptr<InstrProfValueData[]> VD =
821  InstrProfR.getValueForSite(ValueKind, SiteIdx, &Sum);
822 
823  ArrayRef<InstrProfValueData> VDs(VD.get(), NV);
824  annotateValueSite(M, Inst, VDs, Sum, ValueKind, MaxMDCount);
825 }
826 
829  uint64_t Sum, InstrProfValueKind ValueKind,
830  uint32_t MaxMDCount) {
831  LLVMContext &Ctx = M.getContext();
832  MDBuilder MDHelper(Ctx);
834  // Tag
835  Vals.push_back(MDHelper.createString("VP"));
836  // Value Kind
837  Vals.push_back(MDHelper.createConstant(
838  ConstantInt::get(Type::getInt32Ty(Ctx), ValueKind)));
839  // Total Count
840  Vals.push_back(
841  MDHelper.createConstant(ConstantInt::get(Type::getInt64Ty(Ctx), Sum)));
842 
843  // Value Profile Data
844  uint32_t MDCount = MaxMDCount;
845  for (auto &VD : VDs) {
846  Vals.push_back(MDHelper.createConstant(
847  ConstantInt::get(Type::getInt64Ty(Ctx), VD.Value)));
848  Vals.push_back(MDHelper.createConstant(
849  ConstantInt::get(Type::getInt64Ty(Ctx), VD.Count)));
850  if (--MDCount == 0)
851  break;
852  }
853  Inst.setMetadata(LLVMContext::MD_prof, MDNode::get(Ctx, Vals));
854 }
855 
857  InstrProfValueKind ValueKind,
858  uint32_t MaxNumValueData,
859  InstrProfValueData ValueData[],
860  uint32_t &ActualNumValueData, uint64_t &TotalC) {
862  if (!MD)
863  return false;
864 
865  unsigned NOps = MD->getNumOperands();
866 
867  if (NOps < 5)
868  return false;
869 
870  // Operand 0 is a string tag "VP":
871  MDString *Tag = cast<MDString>(MD->getOperand(0));
872  if (!Tag)
873  return false;
874 
875  if (!Tag->getString().equals("VP"))
876  return false;
877 
878  // Now check kind:
879  ConstantInt *KindInt = mdconst::dyn_extract<ConstantInt>(MD->getOperand(1));
880  if (!KindInt)
881  return false;
882  if (KindInt->getZExtValue() != ValueKind)
883  return false;
884 
885  // Get total count
886  ConstantInt *TotalCInt = mdconst::dyn_extract<ConstantInt>(MD->getOperand(2));
887  if (!TotalCInt)
888  return false;
889  TotalC = TotalCInt->getZExtValue();
890 
891  ActualNumValueData = 0;
892 
893  for (unsigned I = 3; I < NOps; I += 2) {
894  if (ActualNumValueData >= MaxNumValueData)
895  break;
896  ConstantInt *Value = mdconst::dyn_extract<ConstantInt>(MD->getOperand(I));
897  ConstantInt *Count =
898  mdconst::dyn_extract<ConstantInt>(MD->getOperand(I + 1));
899  if (!Value || !Count)
900  return false;
901  ValueData[ActualNumValueData].Value = Value->getZExtValue();
902  ValueData[ActualNumValueData].Count = Count->getZExtValue();
903  ActualNumValueData++;
904  }
905  return true;
906 }
907 
910 }
911 
913  // Only for internal linkage functions.
914  if (PGOFuncName == F.getName())
915  return;
916  // Don't create duplicated meta-data.
917  if (getPGOFuncNameMetadata(F))
918  return;
919  LLVMContext &C = F.getContext();
920  MDNode *N = MDNode::get(C, MDString::get(C, PGOFuncName));
922 }
923 
924 bool needsComdatForCounter(const Function &F, const Module &M) {
925  if (F.hasComdat())
926  return true;
927 
928  Triple TT(M.getTargetTriple());
929  if (!TT.isOSBinFormatELF() && !TT.isOSBinFormatWasm())
930  return false;
931 
932  // See createPGOFuncNameVar for more details. To avoid link errors, profile
933  // counters for function with available_externally linkage needs to be changed
934  // to linkonce linkage. On ELF based systems, this leads to weak symbols to be
935  // created. Without using comdat, duplicate entries won't be removed by the
936  // linker leading to increased data segement size and raw profile size. Even
937  // worse, since the referenced counter from profile per-function data object
938  // will be resolved to the common strong definition, the profile counts for
939  // available_externally functions will end up being duplicated in raw profile
940  // data. This can result in distorted profile as the counts of those dups
941  // will be accumulated by the profile merger.
943  if (Linkage != GlobalValue::ExternalWeakLinkage &&
945  return false;
946 
947  return true;
948 }
949 
950 // Check if INSTR_PROF_RAW_VERSION_VAR is defined.
951 bool isIRPGOFlagSet(const Module *M) {
952  auto IRInstrVar =
953  M->getNamedGlobal(INSTR_PROF_QUOTE(INSTR_PROF_RAW_VERSION_VAR));
954  if (!IRInstrVar || IRInstrVar->isDeclaration() ||
955  IRInstrVar->hasLocalLinkage())
956  return false;
957 
958  // Check if the flag is set.
959  if (!IRInstrVar->hasInitializer())
960  return false;
961 
962  const Constant *InitVal = IRInstrVar->getInitializer();
963  if (!InitVal)
964  return false;
965 
966  return (dyn_cast<ConstantInt>(InitVal)->getZExtValue() &
967  VARIANT_MASK_IR_PROF) != 0;
968 }
969 
970 // Check if we can safely rename this Comdat function.
971 bool canRenameComdatFunc(const Function &F, bool CheckAddressTaken) {
972  if (F.getName().empty())
973  return false;
974  if (!needsComdatForCounter(F, *(F.getParent())))
975  return false;
976  // Unsafe to rename the address-taken function (which can be used in
977  // function comparison).
978  if (CheckAddressTaken && F.hasAddressTaken())
979  return false;
980  // Only safe to do if this function may be discarded if it is not used
981  // in the compilation unit.
983  return false;
984 
985  // For AvailableExternallyLinkage functions.
986  if (!F.hasComdat()) {
988  return true;
989  }
990  return true;
991 }
992 
993 // Parse the value profile options.
995  int64_t &RangeLast) {
996  static const int64_t DefaultMemOPSizeRangeStart = 0;
997  static const int64_t DefaultMemOPSizeRangeLast = 8;
998  RangeStart = DefaultMemOPSizeRangeStart;
999  RangeLast = DefaultMemOPSizeRangeLast;
1000 
1001  if (!MemOPSizeRange.empty()) {
1002  auto Pos = MemOPSizeRange.find(':');
1003  if (Pos != std::string::npos) {
1004  if (Pos > 0)
1005  MemOPSizeRange.substr(0, Pos).getAsInteger(10, RangeStart);
1006  if (Pos < MemOPSizeRange.size() - 1)
1007  MemOPSizeRange.substr(Pos + 1).getAsInteger(10, RangeLast);
1008  } else
1009  MemOPSizeRange.getAsInteger(10, RangeLast);
1010  }
1011  assert(RangeLast >= RangeStart);
1012 }
1013 
1014 } // end namespace llvm
void setVisibility(VisibilityTypes V)
Definition: GlobalValue.h:231
void getValueForSiteInstrProf(const void *R, InstrProfValueData *Dst, uint32_t K, uint32_t S)
Definition: InstrProf.cpp:629
cl::opt< std::string > MemOPSizeRange("memop-size-range", cl::desc("Set the range of size in memory intrinsic calls to be profiled " "precisely, in a format of <start_val>:<end_val>"), cl::init(""))
uint64_t CallInst * C
bool is_separator(char value, Style style=Style::native)
Check whether the given char is a path separator on the host OS.
Definition: Path.cpp:603
const std::string & getTargetTriple() const
Get the target triple which is a string describing the target host.
Definition: Module.h:233
A symbol table used for function PGO name look-up with keys (such as pointers, md5hash values) to the...
Definition: InstrProf.h:411
static Constant * getString(LLVMContext &Context, StringRef Initializer, bool AddNull=true)
This method constructs a CDS and initializes it with a text string.
Definition: Constants.cpp:2451
void merge(InstrProfRecord &Other, uint64_t Weight, function_ref< void(instrprof_error)> Warn)
Merge the counts in Other into this one.
Definition: InstrProf.cpp:522
static StringRef stripDirPrefix(StringRef PathNameStr, uint32_t NumPrefix)
Definition: InstrProf.cpp:225
LLVM_NODISCARD std::string str() const
str - Get the contents as an std::string.
Definition: StringRef.h:228
DiagnosticInfoOptimizationBase::Argument NV
StringRef getInstrProfNameVarPrefix()
Return the name prefix of variables containing instrumented function names.
Definition: InstrProf.h:83
uint32_t getNumValueDataInstrProf(const void *Record, uint32_t VKind)
Definition: InstrProf.cpp:618
const Constant * getInitializer() const
getInitializer - Return the initializer for this global variable.
Compute iterated dominance frontiers using a linear time algorithm.
Definition: AllocatorList.h:24
ConstantAsMetadata * createConstant(Constant *C)
Return the given constant as metadata.
Definition: MDBuilder.cpp:25
A Module instance is used to store all the information related to an LLVM module. ...
Definition: Module.h:63
iterator begin() const
Definition: ArrayRef.h:137
LLVM_ATTRIBUTE_ALWAYS_INLINE size_type size() const
Definition: SmallVector.h:136
static MDString * get(LLVMContext &Context, StringRef Str)
Definition: Metadata.cpp:446
uint32_t getNumValueDataForSite(uint32_t ValueKind, uint32_t Site) const
Return the number of value data collected for ValueKind at profiling site: Site.
Definition: InstrProf.h:767
Available for inspection, not emission.
Definition: GlobalValue.h:50
LLVM_NODISCARD LLVM_ATTRIBUTE_ALWAYS_INLINE size_t size() const
size - Get the string size.
Definition: StringRef.h:138
bool canRenameComdatFunc(const Function &F, bool CheckAddressTaken=false)
Check if we can safely rename this Comdat function.
Definition: InstrProf.cpp:971
This file contains the declarations for metadata subclasses.
MDNode * getPGOFuncNameMetadata(const Function &F)
Return the PGOFuncName meta data associated with a function.
Definition: InstrProf.cpp:908
An efficient, type-erasing, non-owning reference to a callable.
Definition: STLExtras.h:89
const GlobalVariable * getNamedGlobal(StringRef Name) const
Return the global variable in the module with the specified name, of arbitrary type.
Definition: Module.h:383
Like Internal, but omit from symbol table.
Definition: GlobalValue.h:57
Externally visible function.
Definition: GlobalValue.h:49
static std::unique_ptr< ValueProfData > allocValueProfData(uint32_t TotalSize)
Definition: InstrProf.cpp:730
static T swapToHostOrder(const unsigned char *&D, support::endianness Orig)
Definition: InstrProf.cpp:721
Metadata node.
Definition: Metadata.h:862
StringRef getName() const
Get a short "name" for the module.
Definition: Module.h:220
std::string getInstrProfSectionName(InstrProfSectKind IPSK, Triple::ObjectFormatType OF, bool AddSegmentInfo=true)
Return the name of the profile section corresponding to IPSK.
Definition: InstrProf.cpp:165
F(f)
const MDOperand & getOperand(unsigned I) const
Definition: Metadata.h:1067
static IntegerType * getInt64Ty(LLVMContext &C)
Definition: Type.cpp:177
std::string getGlobalIdentifier() const
Return the modified name for this global value suitable to be used as the key for a global lookup (e...
Definition: Globals.cpp:151
static cl::opt< bool > StaticFuncFullModulePrefix("static-func-full-module-prefix", cl::init(true), cl::desc("Use full module build paths in the profile counter names for " "static functions."))
std::enable_if< std::is_unsigned< T >::value, T >::type SaturatingMultiply(T X, T Y, bool *ResultOverflowed=nullptr)
Multiply two unsigned integers, X and Y, of type T.
Definition: MathExtras.h:785
void reserveSites(uint32_t ValueKind, uint32_t NumValueSites)
Reserve space for NumValueSites sites.
Definition: InstrProf.h:803
uint32_t getNumValueSites(uint32_t ValueKind) const
Return the number of instrumented sites for ValueKind.
Definition: InstrProf.h:763
LLVM_NODISCARD LLVM_ATTRIBUTE_ALWAYS_INLINE const char * data() const
data - Get a pointer to the start of the string (which may not be null terminated).
Definition: StringRef.h:128
static bool isLocalLinkage(LinkageTypes Linkage)
Definition: GlobalValue.h:312
uint32_t getNumValueKindsInstrProf(const void *Record)
ValueProfRecordClosure Interface implementation for InstrProfRecord class.
Definition: InstrProf.cpp:609
void merge(InstrProfValueSiteRecord &Input, uint64_t Weight, function_ref< void(instrprof_error)> Warn)
Merge data from another InstrProfValueSiteRecord Optionally scale merged counts by Weight...
Definition: InstrProf.cpp:468
LLVMContext & getContext() const
Get the global data context.
Definition: Module.h:237
void scale(uint64_t Weight, function_ref< void(instrprof_error)> Warn)
Scale up profile counts (including value profile data) by Weight.
Definition: InstrProf.cpp:550
const std::error_category & instrprof_category()
Definition: InstrProf.cpp:137
MDNode * getMetadata(unsigned KindID) const
Get the current metadata attachments for the given kind, if any.
Definition: Metadata.cpp:1431
InstrProfValueKind
Definition: InstrProf.h:237
Error collectPGOFuncNameStrings(ArrayRef< std::string > NameStrs, bool doCompression, std::string &Result)
Given a vector of strings (function PGO names) NameStrs, the method generates a combined string Resul...
Definition: InstrProf.cpp:363
std::string join(IteratorT Begin, IteratorT End, StringRef Separator)
Joins the strings in the range [Begin, End), adding Separator between the elements.
Definition: StringExtras.h:327
Tagged union holding either a T or a Error.
Definition: CachePruning.h:23
InstrProfSectKind
Definition: InstrProf.h:57
LLVM_NODISCARD LLVM_ATTRIBUTE_ALWAYS_INLINE bool startswith(StringRef Prefix) const
Check if this string starts with the given Prefix.
Definition: StringRef.h:267
StringRef getFuncNameWithoutPrefix(StringRef PGOFuncName, StringRef FileName="<unknown>")
Given a PGO function name, remove the filename prefix and return the original (static) function name...
Definition: InstrProf.cpp:275
Type * getType() const
All values are typed, get the type of this value.
Definition: Value.h:245
LLVM_NODISCARD LLVM_ATTRIBUTE_ALWAYS_INLINE bool empty() const
empty - Check if the string is empty.
Definition: StringRef.h:133
MDNode * getMetadata(unsigned KindID) const
Get the metadata of given kind attached to this Instruction.
Definition: Instruction.h:194
ArrayRef - Represent a constant reference to an array (0 or more elements consecutively in memory)...
Definition: APInt.h:33
StringRef getInstrProfNameSeparator()
Return the marker used to separate PGO names during serialization.
Definition: InstrProf.h:162
auto lower_bound(R &&Range, ForwardIt I) -> decltype(adl_begin(Range))
Provide wrappers to std::lower_bound which take ranges instead of having to pass begin/end explicitly...
Definition: STLExtras.h:904
void addError(instrprof_error IE)
Track a soft error (IE) and increment its associated counter.
Definition: InstrProf.cpp:184
LinkageTypes getLinkage() const
Definition: GlobalValue.h:441
LLVM_NODISCARD LLVM_ATTRIBUTE_ALWAYS_INLINE StringRef substr(size_t Start, size_t N=npos) const
Return a reference to the substring from [Start, Start + N).
Definition: StringRef.h:598
auto count(R &&Range, const E &Element) -> typename std::iterator_traits< decltype(adl_begin(Range))>::difference_type
Wrapper function around std::count to count the number of times an element Element occurs in the give...
Definition: STLExtras.h:874
bool isIRPGOFlagSet(const Module *M)
Check if INSTR_PROF_RAW_VERSION_VAR is defined.
Definition: InstrProf.cpp:951
static ManagedStatic< InstrProfErrorCategoryType > ErrorCategory
Definition: InstrProf.cpp:135
std::string message() const override
Return the error message as a string.
Definition: InstrProf.cpp:209
StringRef getString() const
Definition: Metadata.cpp:456
void encodeULEB128(uint64_t Value, raw_ostream &OS, unsigned PadTo=0)
Utility function to encode a ULEB128 value to an output stream.
Definition: LEB128.h:77
ExternalWeak linkage description.
Definition: GlobalValue.h:58
void getMemOPSizeRangeFromOption(StringRef Str, int64_t &RangeStart, int64_t &RangeLast)
Definition: InstrProf.cpp:994
bool needsComdatForCounter(const Function &F, const Module &M)
Check if we can use Comdat for profile variables.
Definition: InstrProf.cpp:924
static MDTuple * get(LLVMContext &Context, ArrayRef< Metadata *> MDs)
Definition: Metadata.h:1164
bool isAvailable()
Definition: Compression.cpp:58
#define P(N)
Same, but only replaced by something equivalent.
Definition: GlobalValue.h:52
initializer< Ty > init(const Ty &Val)
Definition: CommandLine.h:406
bool getValueProfDataFromInst(const Instruction &Inst, InstrProfValueKind ValueKind, uint32_t MaxNumValueData, InstrProfValueData ValueData[], uint32_t &ActualNumValueData, uint64_t &TotalC)
Extract the value profile data from Inst which is annotated with value profile meta data...
Definition: InstrProf.cpp:856
uint64_t getZExtValue() const
Return the constant as a 64-bit unsigned integer value after it has been zero extended as appropriate...
Definition: Constants.h:149
MutableArrayRef - Represent a mutable reference to an array (0 or more elements consecutively in memo...
Definition: ArrayRef.h:291
void scale(uint64_t Weight, function_ref< void(instrprof_error)> Warn)
Scale up value profile data counts.
Definition: InstrProf.cpp:491
std::string getPGOFuncNameVarName(StringRef FuncName, GlobalValue::LinkageTypes Linkage)
Return the name of the global variable used to store a function name in PGO instrumentation.
Definition: InstrProf.cpp:286
This is an important class for using LLVM in a threaded context.
Definition: LLVMContext.h:69
size_t size() const
size - Get the array size.
Definition: ArrayRef.h:149
static GCRegistry::Add< CoreCLRGC > E("coreclr", "CoreCLR-compatible GC")
This is an important base class in LLVM.
Definition: Constant.h:42
ValueKind
Value kinds.
This file contains the declarations for the subclasses of Constant, which represent the different fla...
static ValueProfRecordClosure InstrProfRecordClosure
Definition: InstrProf.cpp:641
static cl::opt< unsigned > StaticFuncStripDirNamePrefix("static-func-strip-dirname-prefix", cl::init(0), cl::desc("Strip specified level of directory name from source path in " "the profile counter name for static functions."))
ValueProfData * allocValueProfDataInstrProf(size_t TotalSizeInBytes)
Definition: InstrProf.cpp:634
std::vector< std::pair< uint64_t, uint64_t > > ValueMapType
Definition: InstrProf.h:617
static ManagedStatic< _object_error_category > error_category
Definition: Error.cpp:74
uint64_t decodeULEB128(const uint8_t *p, unsigned *n=nullptr, const uint8_t *end=nullptr, const char **error=nullptr)
Utility function to decode a ULEB128 value.
Definition: LEB128.h:124
#define LLVM_ATTRIBUTE_UNUSED
Definition: Compiler.h:144
std::list< InstrProfValueData > ValueData
Value profiling data pairs at a given value site.
Definition: InstrProf.h:566
LLVMContext & getContext() const
getContext - Return a reference to the LLVMContext associated with this function. ...
Definition: Function.cpp:194
void annotateValueSite(Module &M, Instruction &Inst, const InstrProfRecord &InstrProfR, InstrProfValueKind ValueKind, uint32_t SiteIndx, uint32_t MaxMDCount=3)
Get the value profile data for value site SiteIdx from InstrProfR and annotate the instruction Inst w...
Definition: InstrProf.cpp:811
Value(Type *Ty, unsigned scid)
Definition: Value.cpp:50
void consumeError(Error Err)
Consume a Error without doing anything.
Definition: Error.h:962
void createPGOFuncNameMetadata(Function &F, StringRef PGOFuncName)
Create the PGOFuncName meta data if PGOFuncName is different from function&#39;s raw name.
Definition: InstrProf.cpp:912
Error readPGOFuncNameStrings(StringRef NameStrings, InstrProfSymtab &Symtab)
NameStrings is a string composed of one of more sub-strings encoded in the format described above...
Definition: InstrProf.cpp:421
#define llvm_unreachable(msg)
Marks that the current location is not supposed to be reachable.
void setMetadata(unsigned KindID, MDNode *Node)
Set the metadata of the specified kind to the specified node.
Definition: Metadata.cpp:1214
Triple - Helper class for working with autoconf configuration names.
Definition: Triple.h:44
void addValueData(uint32_t ValueKind, uint32_t Site, InstrProfValueData *VData, uint32_t N, ValueMapType *ValueMap)
Add ValueData for ValueKind at value Site.
Definition: InstrProf.cpp:587
bool isDiscardableIfUnused() const
Definition: GlobalValue.h:443
std::enable_if< std::numeric_limits< T >::is_signed, bool >::type getAsInteger(unsigned Radix, T &Result) const
Parse the current string as an integer of the specified radix.
Definition: StringRef.h:497
std::enable_if< std::is_unsigned< T >::value, T >::type SaturatingMultiplyAdd(T X, T Y, T A, bool *ResultOverflowed=nullptr)
Multiply two unsigned integers, X and Y, and add the unsigned integer, A to the product.
Definition: MathExtras.h:831
LLVM_NODISCARD LLVM_ATTRIBUTE_ALWAYS_INLINE StringRef drop_front(size_t N=1) const
Return a StringRef equal to &#39;this&#39; but with the first N elements dropped.
Definition: StringRef.h:645
Error create(object::SectionRef &Section)
Create InstrProfSymtab from an object file section which contains function PGO names.
static ErrorSuccess success()
Create a success value.
Definition: Error.h:313
Error compress(StringRef InputBuffer, SmallVectorImpl< char > &CompressedBuffer, CompressionLevel Level=DefaultCompression)
Definition: Compression.cpp:60
See the file comment.
Definition: ValueMap.h:86
This is the shared class of boolean and integer constants.
Definition: Constants.h:84
This is a &#39;vector&#39; (really, a variable-sized array), optimized for the case when the array is small...
Definition: SmallVector.h:864
Keep one copy of function when linking (inline)
Definition: GlobalValue.h:51
Module.h This file contains the declarations for the Module class.
LLVM_NODISCARD std::pair< StringRef, StringRef > split(char Separator) const
Split into two substrings around the first occurrence of a separator character.
Definition: StringRef.h:727
iterator end() const
Definition: ArrayRef.h:138
static std::string getInstrProfErrString(instrprof_error Err)
Definition: InstrProf.cpp:76
StringRef getPGOFuncNameMetadataName()
Definition: InstrProf.h:264
static GCRegistry::Add< StatepointGC > D("statepoint-example", "an example strategy for statepoint")
static Constant * get(Type *Ty, uint64_t V, bool isSigned=false)
If Ty is a vector type, return a Constant with a splat of the given value.
Definition: Constants.cpp:560
LinkageTypes
An enumeration for the kinds of linkage for global values.
Definition: GlobalValue.h:48
static char ID
Definition: InstrProf.h:333
GUID getGUID() const
Return a 64-bit global unique ID constructed from global value name (i.e.
Definition: GlobalValue.h:491
void sortByTargetValues()
Sort ValueData ascending by Value.
Definition: InstrProf.h:574
LLVM_NODISCARD LLVM_ATTRIBUTE_ALWAYS_INLINE bool equals(StringRef RHS) const
equals - Check for string equality, this is more efficient than compare() when the relative ordering ...
Definition: StringRef.h:169
bool hasComdat() const
Definition: GlobalObject.h:100
void setMetadata(unsigned KindID, MDNode *MD)
Set a particular kind of metadata attachment.
Definition: Metadata.cpp:1421
std::vector< uint64_t > Counts
Definition: InstrProf.h:593
pointer data()
Return a pointer to the vector&#39;s buffer, even if empty().
Definition: SmallVector.h:143
Profiling information for a single function.
Definition: InstrProf.h:592
StringRef filename(StringRef path, Style style=Style::native)
Get filename.
Definition: Path.cpp:575
static IntegerType * getInt32Ty(LLVMContext &C)
Definition: Type.cpp:176
std::string getPGOFuncName(const Function &F, bool InLTO=false, uint64_t Version=INSTR_PROF_INDEX_VERSION)
Return the modified name for function F suitable to be used the key for profile lookup.
Definition: InstrProf.cpp:253
instrprof_error
Definition: InstrProf.h:280
MDString * createString(StringRef Str)
Return the given string as metadata.
Definition: MDBuilder.cpp:21
Error addFuncName(StringRef FuncName)
Update the symtab by adding FuncName to the table.
Definition: InstrProf.h:467
StringRef getName() const
Return a constant reference to the value&#39;s name.
Definition: Value.cpp:220
#define I(x, y, z)
Definition: MD5.cpp:58
#define N
GlobalVariable * createPGOFuncNameVar(Function &F, StringRef PGOFuncName)
Create and return the global variable for function name used in PGO instrumentation.
Definition: InstrProf.cpp:331
Rename collisions when linking (static functions).
Definition: GlobalValue.h:56
const unsigned Kind
bool hasAddressTaken(const User **=nullptr) const
hasAddressTaken - returns true if there are any uses of this function other than direct calls or invo...
Definition: Function.cpp:1213
uint32_t getNumValueSitesInstrProf(const void *Record, uint32_t VKind)
Definition: InstrProf.cpp:613
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
ObjectFormatType
Definition: Triple.h:211
Module * getParent()
Get the module that this global value is contained inside of...
Definition: GlobalValue.h:556
LLVM Value Representation.
Definition: Value.h:73
static const char * name
Lightweight error class with error context and mandatory checking.
Definition: Error.h:156
support::endianness getHostEndianness()
Definition: InstrProf.h:809
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:49
A single uniqued string.
Definition: Metadata.h:602
ManagedStatic - This transparently changes the behavior of global statics to be lazily constructed on...
Definition: ManagedStatic.h:61
std::unique_ptr< InstrProfValueData[]> getValueForSite(uint32_t ValueKind, uint32_t Site, uint64_t *TotalC=nullptr) const
Return the array of profiled values at Site.
Definition: InstrProf.h:773
unsigned getNumOperands() const
Return number of MDNode operands.
Definition: Metadata.h:1073
LLVM_NODISCARD LLVM_ATTRIBUTE_ALWAYS_INLINE size_t find(char C, size_t From=0) const
Search for the first character C in the string.
Definition: StringRef.h:298
uint32_t getNumValueDataForSiteInstrProf(const void *R, uint32_t VK, uint32_t S)
Definition: InstrProf.cpp:623
Error uncompress(StringRef InputBuffer, char *UncompressedBuffer, size_t &UncompressedSize)
Definition: Compression.cpp:76
const uint64_t Version
Definition: InstrProf.h:867
StringRef getPGOFuncNameVarInitializer(GlobalVariable *NameVar)
Return the initializer in string of the PGO name var NameVar.
Definition: InstrProf.cpp:404
bool empty() const
empty - Check if the array is empty.
Definition: ArrayRef.h:144