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