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
|
//===-- sanitizer_stackdepot_test.cpp -------------------------------------===//
//
// 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
//
//===----------------------------------------------------------------------===//
//
// This file is a part of ThreadSanitizer/AddressSanitizer runtime.
//
//===----------------------------------------------------------------------===//
#include "sanitizer_common/sanitizer_stackdepot.h"
#include <atomic>
#include <numeric>
#include <regex>
#include <sstream>
#include <string>
#include <thread>
#include "gtest/gtest.h"
#include "sanitizer_common/sanitizer_internal_defs.h"
#include "sanitizer_common/sanitizer_libc.h"
namespace __sanitizer {
class StackDepotTest : public testing::Test {
protected:
void SetUp() override { StackDepotTestOnlyUnmap(); }
void TearDown() override {
StackDepotStats stack_depot_stats = StackDepotGetStats();
Printf("StackDepot: %zd ids; %zdM allocated\n",
stack_depot_stats.n_uniq_ids, stack_depot_stats.allocated >> 20);
StackDepotTestOnlyUnmap();
}
};
TEST_F(StackDepotTest, Basic) {
uptr array[] = {1, 2, 3, 4, 5};
StackTrace s1(array, ARRAY_SIZE(array));
u32 i1 = StackDepotPut(s1);
StackTrace stack = StackDepotGet(i1);
EXPECT_NE(stack.trace, (uptr*)0);
EXPECT_EQ(ARRAY_SIZE(array), stack.size);
EXPECT_EQ(0, internal_memcmp(stack.trace, array, sizeof(array)));
}
TEST_F(StackDepotTest, Absent) {
StackTrace stack = StackDepotGet((1 << 30) - 1);
EXPECT_EQ((uptr*)0, stack.trace);
}
TEST_F(StackDepotTest, EmptyStack) {
u32 i1 = StackDepotPut(StackTrace());
StackTrace stack = StackDepotGet(i1);
EXPECT_EQ((uptr*)0, stack.trace);
}
TEST_F(StackDepotTest, ZeroId) {
StackTrace stack = StackDepotGet(0);
EXPECT_EQ((uptr*)0, stack.trace);
}
TEST_F(StackDepotTest, Same) {
uptr array[] = {1, 2, 3, 4, 6};
StackTrace s1(array, ARRAY_SIZE(array));
u32 i1 = StackDepotPut(s1);
u32 i2 = StackDepotPut(s1);
EXPECT_EQ(i1, i2);
StackTrace stack = StackDepotGet(i1);
EXPECT_NE(stack.trace, (uptr*)0);
EXPECT_EQ(ARRAY_SIZE(array), stack.size);
EXPECT_EQ(0, internal_memcmp(stack.trace, array, sizeof(array)));
}
TEST_F(StackDepotTest, Several) {
uptr array1[] = {1, 2, 3, 4, 7};
StackTrace s1(array1, ARRAY_SIZE(array1));
u32 i1 = StackDepotPut(s1);
uptr array2[] = {1, 2, 3, 4, 8, 9};
StackTrace s2(array2, ARRAY_SIZE(array2));
u32 i2 = StackDepotPut(s2);
EXPECT_NE(i1, i2);
}
TEST_F(StackDepotTest, Print) {
uptr array1[] = {0x111, 0x222, 0x333, 0x444, 0x777};
StackTrace s1(array1, ARRAY_SIZE(array1));
u32 i1 = StackDepotPut(s1);
uptr array2[] = {0x1111, 0x2222, 0x3333, 0x4444, 0x8888, 0x9999};
StackTrace s2(array2, ARRAY_SIZE(array2));
u32 i2 = StackDepotPut(s2);
EXPECT_NE(i1, i2);
auto fix_regex = [](const std::string& s) -> std::string {
if (!SANITIZER_WINDOWS)
return s;
return std::regex_replace(s, std::regex("\\.\\*"), ".*\\n.*");
};
EXPECT_EXIT(
(StackDepotPrintAll(), exit(0)), ::testing::ExitedWithCode(0),
fix_regex("Stack for id .*#0 0x1.*#1 0x2.*#2 0x3.*#3 0x4.*#4 0x7.*"));
EXPECT_EXIT(
(StackDepotPrintAll(), exit(0)), ::testing::ExitedWithCode(0),
fix_regex(
"Stack for id .*#0 0x1.*#1 0x2.*#2 0x3.*#3 0x4.*#4 0x8.*#5 0x9.*"));
}
TEST_F(StackDepotTest, PrintNoLock) {
u32 n = 2000;
std::vector<u32> idx2id(n);
for (u32 i = 0; i < n; ++i) {
uptr array[] = {0x111, 0x222, i, 0x444, 0x777};
StackTrace s(array, ARRAY_SIZE(array));
idx2id[i] = StackDepotPut(s);
}
StackDepotPrintAll();
for (u32 i = 0; i < n; ++i) {
uptr array[] = {0x111, 0x222, i, 0x444, 0x777};
StackTrace s(array, ARRAY_SIZE(array));
CHECK_EQ(idx2id[i], StackDepotPut(s));
}
}
static struct StackDepotBenchmarkParams {
int UniqueStacksPerThread;
int RepeatPerThread;
int Threads;
bool UniqueThreads;
bool UseCount;
} params[] = {
// All traces are unique, very unusual.
{10000000, 1, 1, false, false},
{8000000, 1, 4, false, false},
{8000000, 1, 16, false, false},
// Probably most realistic sets.
{3000000, 10, 1, false, false},
{3000000, 10, 4, false, false},
{3000000, 10, 16, false, false},
// Update use count as msan/dfsan.
{3000000, 10, 1, false, true},
{3000000, 10, 4, false, true},
{3000000, 10, 16, false, true},
// Unrealistic, as above, but traces are unique inside of thread.
{4000000, 1, 4, true, false},
{2000000, 1, 16, true, false},
{2000000, 10, 4, true, false},
{500000, 10, 16, true, false},
{1500000, 10, 4, true, true},
{800000, 10, 16, true, true},
};
static std::string PrintStackDepotBenchmarkParams(
const testing::TestParamInfo<StackDepotBenchmarkParams>& info) {
std::stringstream name;
name << info.param.UniqueStacksPerThread << "_" << info.param.RepeatPerThread
<< "_" << info.param.Threads << (info.param.UseCount ? "_UseCount" : "")
<< (info.param.UniqueThreads ? "_UniqueThreads" : "");
return name.str();
}
class StackDepotBenchmark
: public StackDepotTest,
public testing::WithParamInterface<StackDepotBenchmarkParams> {};
// Test which can be used as a simple benchmark. It's disabled to avoid slowing
// down check-sanitizer.
// Usage: Sanitizer-<ARCH>-Test --gtest_also_run_disabled_tests \
// '--gtest_filter=*Benchmark*'
TEST_P(StackDepotBenchmark, DISABLED_Benchmark) {
auto Param = GetParam();
std::atomic<unsigned int> here = {};
auto thread = [&](int idx) {
here++;
while (here < Param.UniqueThreads) std::this_thread::yield();
std::vector<uptr> frames(64);
for (int r = 0; r < Param.RepeatPerThread; ++r) {
std::iota(frames.begin(), frames.end(), idx + 1);
for (int i = 0; i < Param.UniqueStacksPerThread; ++i) {
StackTrace s(frames.data(), frames.size());
auto h = StackDepotPut_WithHandle(s);
if (Param.UseCount)
h.inc_use_count_unsafe();
std::next_permutation(frames.begin(), frames.end());
};
}
};
std::vector<std::thread> threads;
for (int i = 0; i < Param.Threads; ++i)
threads.emplace_back(thread, Param.UniqueThreads * i);
for (auto& t : threads) t.join();
}
INSTANTIATE_TEST_SUITE_P(StackDepotBenchmarkSuite, StackDepotBenchmark,
testing::ValuesIn(params),
PrintStackDepotBenchmarkParams);
} // namespace __sanitizer
|
