1 //===- sanstats.cpp - Sanitizer statistics dumper -------------------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This tool dumps statistics information from files in the format produced
10 // by clang's -fsanitize-stats feature.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #include "llvm/DebugInfo/Symbolize/SymbolizableModule.h"
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 static 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 static const char *ReadModule(char SizeofPtr, const char *Begin,
52                               const char *End) {
53   const char *FilenameBegin = Begin;
54   while (Begin != End && *Begin)
55     ++Begin;
56   if (Begin == End)
57     return nullptr;
58   std::string Filename(FilenameBegin, Begin - FilenameBegin);
59 
60   if (!llvm::sys::fs::exists(Filename))
61     Filename = std::string(llvm::sys::path::parent_path(ClInputFile)) +
62                std::string(llvm::sys::path::filename(Filename));
63 
64   ++Begin;
65   if (Begin == End)
66     return nullptr;
67 
68   symbolize::LLVMSymbolizer::Options SymbolizerOptions;
69   SymbolizerOptions.Demangle = ClDemangle;
70   SymbolizerOptions.UseSymbolTable = true;
71   symbolize::LLVMSymbolizer Symbolizer(SymbolizerOptions);
72 
73   while (true) {
74     uint64_t Addr = ReadLE(SizeofPtr, Begin, End);
75     Begin += SizeofPtr;
76     uint64_t Data = ReadLE(SizeofPtr, Begin, End);
77     Begin += SizeofPtr;
78 
79     if (Begin > End)
80       return nullptr;
81     if (Addr == 0 && Data == 0)
82       return Begin;
83     if (Begin == End)
84       return nullptr;
85 
86     // As the instrumentation tracks the return address and not
87     // the address of the call to `__sanitizer_stat_report` we
88     // remove one from the address to get the correct DI.
89     // TODO: it would be neccessary to set proper section index here.
90     // object::SectionedAddress::UndefSection works for only absolute addresses.
91     if (Expected<DILineInfo> LineInfo = Symbolizer.symbolizeCode(
92             Filename, {Addr - 1, object::SectionedAddress::UndefSection})) {
93       llvm::outs() << format_hex(Addr - 1, 18) << ' ' << LineInfo->FileName
94                    << ':' << LineInfo->Line << ' ' << LineInfo->FunctionName
95                    << ' ';
96     } else {
97       logAllUnhandledErrors(LineInfo.takeError(), llvm::outs(), "<error> ");
98     }
99 
100     switch (KindFromData(Data, SizeofPtr)) {
101     case SanStat_CFI_VCall:
102       llvm::outs() << "cfi-vcall";
103       break;
104     case SanStat_CFI_NVCall:
105       llvm::outs() << "cfi-nvcall";
106       break;
107     case SanStat_CFI_DerivedCast:
108       llvm::outs() << "cfi-derived-cast";
109       break;
110     case SanStat_CFI_UnrelatedCast:
111       llvm::outs() << "cfi-unrelated-cast";
112       break;
113     case SanStat_CFI_ICall:
114       llvm::outs() << "cfi-icall";
115       break;
116     default:
117       llvm::outs() << "<unknown>";
118       break;
119     }
120 
121     llvm::outs() << " " << CountFromData(Data, SizeofPtr) << '\n';
122   }
123 }
124 
125 int main(int argc, char **argv) {
126   cl::ParseCommandLineOptions(argc, argv,
127                               "Sanitizer Statistics Processing Tool");
128 
129   ErrorOr<std::unique_ptr<MemoryBuffer>> MBOrErr = MemoryBuffer::getFile(
130       ClInputFile, /*IsText=*/false, /*RequiresNullTerminator=*/false);
131   if (!MBOrErr) {
132     errs() << argv[0] << ": " << ClInputFile << ": "
133            << MBOrErr.getError().message() << '\n';
134     return 1;
135   }
136   std::unique_ptr<MemoryBuffer> MB = std::move(MBOrErr.get());
137   const char *Begin = MB->getBufferStart(), *End = MB->getBufferEnd();
138   if (Begin == End) {
139     errs() << argv[0] << ": " << ClInputFile << ": short read\n";
140     return 1;
141   }
142   char SizeofPtr = *Begin++;
143   while (Begin != End) {
144     Begin = ReadModule(SizeofPtr, Begin, End);
145     if (Begin == nullptr) {
146       errs() << argv[0] << ": " << ClInputFile << ": short read\n";
147       return 1;
148     }
149     assert(Begin <= End);
150   }
151 }
152