1 //===- sanstats.cpp - Sanitizer statistics dumper -------------------------===//
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 tool dumps statistics information from files in the format produced
11 // by clang's -fsanitize-stats feature.
12 //
13 //===----------------------------------------------------------------------===//
14 
15 #include "llvm/DebugInfo/Symbolize/Symbolize.h"
16 #include "llvm/Support/CommandLine.h"
17 #include "llvm/Support/ErrorOr.h"
18 #include "llvm/Support/FileSystem.h"
19 #include "llvm/Support/MemoryBuffer.h"
20 #include "llvm/Support/Path.h"
21 #include "llvm/Transforms/Utils/SanitizerStats.h"
22 #include <stdint.h>
23 
24 using namespace llvm;
25 
26 static cl::opt<std::string> ClInputFile(cl::Positional, cl::Required,
27                                         cl::desc("<filename>"));
28 
29 static cl::opt<bool> ClDemangle("demangle", cl::init(false),
30                                 cl::desc("Print demangled function name."));
31 
32 inline uint64_t KindFromData(uint64_t Data, char SizeofPtr) {
33   return Data >> (SizeofPtr * 8 - kSanitizerStatKindBits);
34 }
35 
36 inline uint64_t CountFromData(uint64_t Data, char SizeofPtr) {
37   return Data & ((1ull << (SizeofPtr * 8 - kSanitizerStatKindBits)) - 1);
38 }
39 
40 uint64_t ReadLE(char Size, const char *Begin, const char *End) {
41   uint64_t Result = 0;
42   char Pos = 0;
43   while (Begin < End && Pos != Size) {
44     Result |= uint64_t(uint8_t(*Begin)) << (Pos * 8);
45     ++Begin;
46     ++Pos;
47   }
48   return Result;
49 }
50 
51 const char *ReadModule(char SizeofPtr, const char *Begin, const char *End) {
52   const char *FilenameBegin = Begin;
53   while (Begin != End && *Begin)
54     ++Begin;
55   if (Begin == End)
56     return nullptr;
57   std::string Filename(FilenameBegin, Begin - FilenameBegin);
58 
59   if (!llvm::sys::fs::exists(Filename))
60     Filename = std::string(llvm::sys::path::parent_path(ClInputFile)) +
61                std::string(llvm::sys::path::filename(Filename));
62 
63   ++Begin;
64   if (Begin == End)
65     return nullptr;
66 
67   symbolize::LLVMSymbolizer::Options SymbolizerOptions;
68   SymbolizerOptions.Demangle = ClDemangle;
69   SymbolizerOptions.UseSymbolTable = true;
70   symbolize::LLVMSymbolizer Symbolizer(SymbolizerOptions);
71 
72   while (1) {
73     uint64_t Addr = ReadLE(SizeofPtr, Begin, End);
74     Begin += SizeofPtr;
75     uint64_t Data = ReadLE(SizeofPtr, Begin, End);
76     Begin += SizeofPtr;
77 
78     if (Begin > End)
79       return nullptr;
80     if (Addr == 0 && Data == 0)
81       return Begin;
82     if (Begin == End)
83       return nullptr;
84 
85     // As the instrumentation tracks the return address and not
86     // the address of the call to `__sanitizer_stat_report` we
87     // remove one from the address to get the correct DI.
88     if (Expected<DILineInfo> LineInfo =
89             Symbolizer.symbolizeCode(Filename, Addr - 1)) {
90       llvm::outs() << format_hex(Addr - 1, 18) << ' ' << LineInfo->FileName
91                    << ':' << LineInfo->Line << ' ' << LineInfo->FunctionName
92                    << ' ';
93     } else {
94       logAllUnhandledErrors(LineInfo.takeError(), llvm::outs(), "<error> ");
95     }
96 
97     switch (KindFromData(Data, SizeofPtr)) {
98     case SanStat_CFI_VCall:
99       llvm::outs() << "cfi-vcall";
100       break;
101     case SanStat_CFI_NVCall:
102       llvm::outs() << "cfi-nvcall";
103       break;
104     case SanStat_CFI_DerivedCast:
105       llvm::outs() << "cfi-derived-cast";
106       break;
107     case SanStat_CFI_UnrelatedCast:
108       llvm::outs() << "cfi-unrelated-cast";
109       break;
110     case SanStat_CFI_ICall:
111       llvm::outs() << "cfi-icall";
112       break;
113     default:
114       llvm::outs() << "<unknown>";
115       break;
116     }
117 
118     llvm::outs() << " " << CountFromData(Data, SizeofPtr) << '\n';
119   }
120 }
121 
122 int main(int argc, char **argv) {
123   cl::ParseCommandLineOptions(argc, argv,
124                               "Sanitizer Statistics Processing Tool");
125 
126   ErrorOr<std::unique_ptr<MemoryBuffer>> MBOrErr =
127       MemoryBuffer::getFile(ClInputFile, -1, false);
128   if (!MBOrErr) {
129     errs() << argv[0] << ": " << ClInputFile << ": "
130            << MBOrErr.getError().message() << '\n';
131     return 1;
132   }
133   std::unique_ptr<MemoryBuffer> MB = std::move(MBOrErr.get());
134   const char *Begin = MB->getBufferStart(), *End = MB->getBufferEnd();
135   if (Begin == End) {
136     errs() << argv[0] << ": " << ClInputFile << ": short read\n";
137     return 1;
138   }
139   char SizeofPtr = *Begin++;
140   while (Begin != End) {
141     Begin = ReadModule(SizeofPtr, Begin, End);
142     if (Begin == nullptr) {
143       errs() << argv[0] << ": " << ClInputFile << ": short read\n";
144       return 1;
145     }
146     assert(Begin <= End);
147   }
148 }
149