Initialize all bytes in vp data (msan error)
[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                            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   ValueProfData *VD =
215       (ValueProfData *)(new (::operator new(TotalSizeInBytes)) ValueProfData());
216   memset(VD, 0, TotalSizeInBytes);
217   return VD;
218 }
219
220 static ValueProfRecordClosure InstrProfRecordClosure = {
221     0,
222     getNumValueKindsInstrProf,
223     getNumValueSitesInstrProf,
224     getNumValueDataInstrProf,
225     getNumValueDataForSiteInstrProf,
226     stringToHash,
227     getValueForSiteInstrProf,
228     allocValueProfDataInstrProf};
229
230 // Wrapper implementation using the closure mechanism.
231 uint32_t ValueProfData::getSize(const InstrProfRecord &Record) {
232   InstrProfRecordClosure.Record = &Record;
233   return getValueProfDataSize(&InstrProfRecordClosure);
234 }
235
236 // Wrapper implementation using the closure mechanism.
237 std::unique_ptr<ValueProfData>
238 ValueProfData::serializeFrom(const InstrProfRecord &Record) {
239   InstrProfRecordClosure.Record = &Record;
240
241   std::unique_ptr<ValueProfData> VPD(
242       serializeValueProfDataFrom(&InstrProfRecordClosure, nullptr));
243   return VPD;
244 }
245
246 void ValueProfRecord::deserializeTo(InstrProfRecord &Record,
247                                     InstrProfRecord::ValueMapType *VMap) {
248   Record.reserveSites(Kind, NumValueSites);
249
250   InstrProfValueData *ValueData = getValueProfRecordValueData(this);
251   for (uint64_t VSite = 0; VSite < NumValueSites; ++VSite) {
252     uint8_t ValueDataCount = this->SiteCountArray[VSite];
253     Record.addValueData(Kind, VSite, ValueData, ValueDataCount, VMap);
254     ValueData += ValueDataCount;
255   }
256 }
257
258 // For writing/serializing,  Old is the host endianness, and  New is
259 // byte order intended on disk. For Reading/deserialization, Old
260 // is the on-disk source endianness, and New is the host endianness.
261 void ValueProfRecord::swapBytes(support::endianness Old,
262                                 support::endianness New) {
263   using namespace support;
264   if (Old == New)
265     return;
266
267   if (getHostEndianness() != Old) {
268     sys::swapByteOrder<uint32_t>(NumValueSites);
269     sys::swapByteOrder<uint32_t>(Kind);
270   }
271   uint32_t ND = getValueProfRecordNumValueData(this);
272   InstrProfValueData *VD = getValueProfRecordValueData(this);
273
274   // No need to swap byte array: SiteCountArrray.
275   for (uint32_t I = 0; I < ND; I++) {
276     sys::swapByteOrder<uint64_t>(VD[I].Value);
277     sys::swapByteOrder<uint64_t>(VD[I].Count);
278   }
279   if (getHostEndianness() == Old) {
280     sys::swapByteOrder<uint32_t>(NumValueSites);
281     sys::swapByteOrder<uint32_t>(Kind);
282   }
283 }
284
285 void ValueProfData::deserializeTo(InstrProfRecord &Record,
286                                   InstrProfRecord::ValueMapType *VMap) {
287   if (NumValueKinds == 0)
288     return;
289
290   ValueProfRecord *VR = getFirstValueProfRecord(this);
291   for (uint32_t K = 0; K < NumValueKinds; K++) {
292     VR->deserializeTo(Record, VMap);
293     VR = getValueProfRecordNext(VR);
294   }
295 }
296
297 template <class T>
298 static T swapToHostOrder(const unsigned char *&D, support::endianness Orig) {
299   using namespace support;
300   if (Orig == little)
301     return endian::readNext<T, little, unaligned>(D);
302   else
303     return endian::readNext<T, big, unaligned>(D);
304 }
305
306 static std::unique_ptr<ValueProfData> allocValueProfData(uint32_t TotalSize) {
307   return std::unique_ptr<ValueProfData>(new (::operator new(TotalSize))
308                                             ValueProfData());
309 }
310
311 instrprof_error ValueProfData::checkIntegrity() {
312   if (NumValueKinds > IPVK_Last + 1)
313     return instrprof_error::malformed;
314   // Total size needs to be mulltiple of quadword size.
315   if (TotalSize % sizeof(uint64_t))
316     return instrprof_error::malformed;
317
318   ValueProfRecord *VR = getFirstValueProfRecord(this);
319   for (uint32_t K = 0; K < this->NumValueKinds; K++) {
320     if (VR->Kind > IPVK_Last)
321       return instrprof_error::malformed;
322     VR = getValueProfRecordNext(VR);
323     if ((char *)VR - (char *)this > (ptrdiff_t)TotalSize)
324       return instrprof_error::malformed;
325   }
326   return instrprof_error::success;
327 }
328
329 ErrorOr<std::unique_ptr<ValueProfData>>
330 ValueProfData::getValueProfData(const unsigned char *D,
331                                 const unsigned char *const BufferEnd,
332                                 support::endianness Endianness) {
333   using namespace support;
334   if (D + sizeof(ValueProfData) > BufferEnd)
335     return instrprof_error::truncated;
336
337   const unsigned char *Header = D;
338   uint32_t TotalSize = swapToHostOrder<uint32_t>(Header, Endianness);
339   if (D + TotalSize > BufferEnd)
340     return instrprof_error::too_large;
341
342   std::unique_ptr<ValueProfData> VPD = allocValueProfData(TotalSize);
343   memcpy(VPD.get(), D, TotalSize);
344   // Byte swap.
345   VPD->swapBytesToHost(Endianness);
346
347   instrprof_error EC = VPD->checkIntegrity();
348   if (EC != instrprof_error::success)
349     return EC;
350
351   return std::move(VPD);
352 }
353
354 void ValueProfData::swapBytesToHost(support::endianness Endianness) {
355   using namespace support;
356   if (Endianness == getHostEndianness())
357     return;
358
359   sys::swapByteOrder<uint32_t>(TotalSize);
360   sys::swapByteOrder<uint32_t>(NumValueKinds);
361
362   ValueProfRecord *VR = getFirstValueProfRecord(this);
363   for (uint32_t K = 0; K < NumValueKinds; K++) {
364     VR->swapBytes(Endianness, getHostEndianness());
365     VR = getValueProfRecordNext(VR);
366   }
367 }
368
369 void ValueProfData::swapBytesFromHost(support::endianness Endianness) {
370   using namespace support;
371   if (Endianness == getHostEndianness())
372     return;
373
374   ValueProfRecord *VR = getFirstValueProfRecord(this);
375   for (uint32_t K = 0; K < NumValueKinds; K++) {
376     ValueProfRecord *NVR = getValueProfRecordNext(VR);
377     VR->swapBytes(getHostEndianness(), Endianness);
378     VR = NVR;
379   }
380   sys::swapByteOrder<uint32_t>(TotalSize);
381   sys::swapByteOrder<uint32_t>(NumValueKinds);
382 }
383
384 }