1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
|
//===- EntryPointStats.cpp --------------------------------------*- C++ -*-===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
#include "clang/StaticAnalyzer/Core/PathSensitive/EntryPointStats.h"
#include "clang/AST/DeclBase.h"
#include "clang/Analysis/AnalysisDeclContext.h"
#include "llvm/ADT/STLExtras.h"
#include "llvm/ADT/StringExtras.h"
#include "llvm/ADT/StringRef.h"
#include "llvm/Support/FileSystem.h"
#include "llvm/Support/ManagedStatic.h"
#include "llvm/Support/raw_ostream.h"
#include <iterator>
using namespace clang;
using namespace ento;
namespace {
struct Registry {
std::vector<BoolEPStat *> BoolStats;
std::vector<CounterEPStat *> CounterStats;
std::vector<UnsignedMaxEPStat *> UnsignedMaxStats;
std::vector<UnsignedEPStat *> UnsignedStats;
bool IsLocked = false;
struct Snapshot {
const Decl *EntryPoint;
std::vector<bool> BoolStatValues;
std::vector<unsigned> UnsignedStatValues;
void dumpAsCSV(llvm::raw_ostream &OS) const;
};
std::vector<Snapshot> Snapshots;
};
} // namespace
static llvm::ManagedStatic<Registry> StatsRegistry;
namespace {
template <typename Callback> void enumerateStatVectors(const Callback &Fn) {
Fn(StatsRegistry->BoolStats);
Fn(StatsRegistry->CounterStats);
Fn(StatsRegistry->UnsignedMaxStats);
Fn(StatsRegistry->UnsignedStats);
}
} // namespace
static void checkStatName(const EntryPointStat *M) {
#ifdef NDEBUG
return;
#endif // NDEBUG
constexpr std::array AllowedSpecialChars = {
'+', '-', '_', '=', ':', '(', ')', '@', '!', '~',
'$', '%', '^', '&', '*', '\'', ';', '<', '>', '/'};
for (unsigned char C : M->name()) {
if (!std::isalnum(C) && !llvm::is_contained(AllowedSpecialChars, C)) {
llvm::errs() << "Stat name \"" << M->name() << "\" contains character '"
<< C << "' (" << static_cast<int>(C)
<< ") that is not allowed.";
assert(false && "The Stat name contains unallowed character");
}
}
}
void EntryPointStat::lockRegistry() {
auto CmpByNames = [](const EntryPointStat *L, const EntryPointStat *R) {
return L->name() < R->name();
};
enumerateStatVectors(
[CmpByNames](auto &Stats) { llvm::sort(Stats, CmpByNames); });
enumerateStatVectors(
[](const auto &Stats) { llvm::for_each(Stats, checkStatName); });
StatsRegistry->IsLocked = true;
}
[[maybe_unused]] static bool isRegistered(llvm::StringLiteral Name) {
auto ByName = [Name](const EntryPointStat *M) { return M->name() == Name; };
bool Result = false;
enumerateStatVectors([ByName, &Result](const auto &Stats) {
Result = Result || llvm::any_of(Stats, ByName);
});
return Result;
}
BoolEPStat::BoolEPStat(llvm::StringLiteral Name) : EntryPointStat(Name) {
assert(!StatsRegistry->IsLocked);
assert(!isRegistered(Name));
StatsRegistry->BoolStats.push_back(this);
}
CounterEPStat::CounterEPStat(llvm::StringLiteral Name) : EntryPointStat(Name) {
assert(!StatsRegistry->IsLocked);
assert(!isRegistered(Name));
StatsRegistry->CounterStats.push_back(this);
}
UnsignedMaxEPStat::UnsignedMaxEPStat(llvm::StringLiteral Name)
: EntryPointStat(Name) {
assert(!StatsRegistry->IsLocked);
assert(!isRegistered(Name));
StatsRegistry->UnsignedMaxStats.push_back(this);
}
UnsignedEPStat::UnsignedEPStat(llvm::StringLiteral Name)
: EntryPointStat(Name) {
assert(!StatsRegistry->IsLocked);
assert(!isRegistered(Name));
StatsRegistry->UnsignedStats.push_back(this);
}
static std::vector<unsigned> consumeUnsignedStats() {
std::vector<unsigned> Result;
Result.reserve(StatsRegistry->CounterStats.size() +
StatsRegistry->UnsignedMaxStats.size() +
StatsRegistry->UnsignedStats.size());
for (auto *M : StatsRegistry->CounterStats) {
Result.push_back(M->value());
M->reset();
}
for (auto *M : StatsRegistry->UnsignedMaxStats) {
Result.push_back(M->value());
M->reset();
}
for (auto *M : StatsRegistry->UnsignedStats) {
Result.push_back(M->value());
M->reset();
}
return Result;
}
static std::vector<llvm::StringLiteral> getStatNames() {
std::vector<llvm::StringLiteral> Ret;
auto GetName = [](const EntryPointStat *M) { return M->name(); };
enumerateStatVectors([GetName, &Ret](const auto &Stats) {
transform(Stats, std::back_inserter(Ret), GetName);
});
return Ret;
}
void Registry::Snapshot::dumpAsCSV(llvm::raw_ostream &OS) const {
OS << '"';
llvm::printEscapedString(
clang::AnalysisDeclContext::getFunctionName(EntryPoint), OS);
OS << "\", ";
auto PrintAsBool = [&OS](bool B) { OS << (B ? "true" : "false"); };
llvm::interleaveComma(BoolStatValues, OS, PrintAsBool);
OS << ((BoolStatValues.empty() || UnsignedStatValues.empty()) ? "" : ", ");
llvm::interleaveComma(UnsignedStatValues, OS);
}
static std::vector<bool> consumeBoolStats() {
std::vector<bool> Result;
Result.reserve(StatsRegistry->BoolStats.size());
for (auto *M : StatsRegistry->BoolStats) {
Result.push_back(M->value());
M->reset();
}
return Result;
}
void EntryPointStat::takeSnapshot(const Decl *EntryPoint) {
auto BoolValues = consumeBoolStats();
auto UnsignedValues = consumeUnsignedStats();
StatsRegistry->Snapshots.push_back(
{EntryPoint, std::move(BoolValues), std::move(UnsignedValues)});
}
void EntryPointStat::dumpStatsAsCSV(llvm::StringRef FileName) {
std::error_code EC;
llvm::raw_fd_ostream File(FileName, EC, llvm::sys::fs::OF_Text);
if (EC)
return;
dumpStatsAsCSV(File);
}
void EntryPointStat::dumpStatsAsCSV(llvm::raw_ostream &OS) {
OS << "EntryPoint, ";
llvm::interleaveComma(getStatNames(), OS);
OS << "\n";
std::vector<std::string> Rows;
Rows.reserve(StatsRegistry->Snapshots.size());
for (const auto &Snapshot : StatsRegistry->Snapshots) {
std::string Row;
llvm::raw_string_ostream RowOs(Row);
Snapshot.dumpAsCSV(RowOs);
RowOs << "\n";
Rows.push_back(RowOs.str());
}
llvm::sort(Rows);
for (const auto &Row : Rows) {
OS << Row;
}
}
|
