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
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
|
#include <array>
#include <atomic>
#include <condition_variable>
#include <iostream>
#include <memory>
#include <random>
#include <utility>
#include <vector>
#include <fmt/format.h>
#include <gtest/gtest.h>
#include <ATen/Parallel.h>
#include <ATen/record_function.h>
#include <c10/util/irange.h>
// Test that we can add and remove callbacks (both global and thread local.)
TEST(RecordFunctionTest, AddRemove) {
at::clearCallbacks();
ASSERT_FALSE(at::hasCallbacks());
auto start_callback =
[](const at::RecordFunction& fn) -> std::unique_ptr<at::ObserverContext> {
return nullptr;
};
auto end_callback = [](const at::RecordFunction& fn, at::ObserverContext*) {};
auto handle = at::addThreadLocalCallback(
at::RecordFunctionCallback(start_callback, end_callback));
ASSERT_TRUE(at::hasCallbacks());
ASSERT_TRUE(at::hasThreadLocalCallbacks());
ASSERT_FALSE(at::hasGlobalCallbacks());
at::removeCallback(handle);
ASSERT_FALSE(at::hasCallbacks());
handle = at::addGlobalCallback(
at::RecordFunctionCallback(start_callback, end_callback));
ASSERT_TRUE(at::hasCallbacks());
ASSERT_FALSE(at::hasThreadLocalCallbacks());
ASSERT_TRUE(at::hasGlobalCallbacks());
at::removeCallback(handle);
ASSERT_FALSE(at::hasCallbacks());
}
// Test that the callbacks that we register are actually run.
TEST(RecordFunctionTest, ThreadLocalState) {
at::clearCallbacks();
ASSERT_FALSE(at::hasCallbacks());
static int tls_test_start_counter;
static int tls_test_end_counter;
tls_test_start_counter = 0;
tls_test_end_counter = 0;
auto start_callback =
[](const at::RecordFunction&) -> std::unique_ptr<at::ObserverContext> {
++tls_test_start_counter;
return nullptr;
};
auto end_callback = [](const at::RecordFunction&, at::ObserverContext*) {
++tls_test_end_counter;
};
auto handle = at::addThreadLocalCallback(
at::RecordFunctionCallback(start_callback, end_callback));
{
at::RecordFunction guard(at::RecordScope::USER_SCOPE);
guard.before("Test");
EXPECT_EQ(tls_test_start_counter, 1);
EXPECT_EQ(tls_test_end_counter, 0);
}
EXPECT_EQ(tls_test_start_counter, 1);
EXPECT_EQ(tls_test_end_counter, 1);
{
tls_test_start_counter = 0;
tls_test_end_counter = 0;
at::DisableRecordFunctionGuard no_profile_guard;
at::RecordFunction guard(at::RecordScope::USER_SCOPE);
guard.before("Test");
EXPECT_EQ(tls_test_start_counter, 0);
EXPECT_EQ(tls_test_end_counter, 0);
}
EXPECT_EQ(tls_test_start_counter, 0);
EXPECT_EQ(tls_test_end_counter, 0);
{
tls_test_start_counter = 0;
tls_test_end_counter = 0;
RECORD_FUNCTION("Test", {});
EXPECT_EQ(tls_test_start_counter, 1);
EXPECT_EQ(tls_test_end_counter, 0);
}
EXPECT_EQ(tls_test_start_counter, 1);
EXPECT_EQ(tls_test_end_counter, 1);
at::removeCallback(handle);
ASSERT_FALSE(at::hasCallbacks());
}
// Test that callbacks are run in the order that they are registered.
TEST(RecordFunctionTest, CallOrder) {
at::clearCallbacks();
ASSERT_FALSE(at::hasCallbacks());
static int current_index;
current_index = 0;
static std::array<std::string, 8> expected_order = {
"Start Callback 0 Outer",
"Start Callback 1 Outer",
"Start Callback 0 Inner",
"Start Callback 1 Inner",
"End Callback 0 Inner",
"End Callback 1 Inner",
"End Callback 0 Outer",
"End Callback 1 Outer",
};
#define REGISTER_CALLBACK(index) \
at::addThreadLocalCallback( \
at::RecordFunctionCallback( \
[](const at::RecordFunction& fn) \
-> std::unique_ptr<at::ObserverContext> { \
EXPECT_EQ( \
fmt::format("Start Callback {} {}", index, fn.name()), \
expected_order[current_index++]); \
return nullptr; \
}, \
[](const at::RecordFunction& fn, at::ObserverContext*) { \
EXPECT_EQ( \
fmt::format("End Callback {} {}", index, fn.name()), \
expected_order[current_index++]); \
}) \
.scopes({at::RecordScope::FUNCTION}))
REGISTER_CALLBACK(0);
REGISTER_CALLBACK(1);
#undef REGISTER_CALLBACK
RECORD_FUNCTION("Outer", {});
{ RECORD_FUNCTION("Inner", {}); }
at::clearCallbacks();
ASSERT_FALSE(at::hasCallbacks());
}
// Make sure TLS migrates when tasks are launched.
TEST(RecordFunctionTest, ThreadMigration) {
at::clearCallbacks();
ASSERT_FALSE(at::hasCallbacks());
static int call_count;
call_count = 0;
auto handle = at::addThreadLocalCallback(
at::RecordFunctionCallback(
[](const at::RecordFunction&)
-> std::unique_ptr<at::ObserverContext> { return nullptr; },
[](const at::RecordFunction&, at::ObserverContext*) { ++call_count; })
.scopes({at::RecordScope::FUNCTION}));
EXPECT_EQ(call_count, 0);
std::condition_variable cv;
std::mutex lock;
at::launch([&cv]() {
RECORD_FUNCTION("Test", {});
cv.notify_all();
});
auto guard = std::unique_lock<std::mutex>(lock);
cv.wait(guard, [] { return call_count > 0; });
EXPECT_EQ(call_count, 1);
at::removeCallback(handle);
ASSERT_FALSE(at::hasCallbacks());
}
// Test sampling logic and validate that callbacks fire at the correct times.
TEST(RecordFunctionTest, Sampling) {
at::clearCallbacks();
ASSERT_FALSE(at::hasCallbacks());
static int sample_test_counter;
sample_test_counter = 0;
uint32_t seed = 12345;
double p = 0.25;
at::set_record_function_seed_for_testing(seed);
std::mt19937 generator;
generator.seed(seed);
auto dist = std::geometric_distribution<int>(p);
// Make sure we know which steps should fire.
auto outcomes = std::array<int, 5>{7, 0, 0, 6, 2};
for (const auto i : c10::irange(outcomes.size())) {
ASSERT_EQ(dist(generator), outcomes[i]);
}
std::vector<int> expected_counts;
int running_count = 0;
for (const auto i : c10::irange(outcomes.size())) {
for (const auto j : c10::irange(outcomes[i])) {
expected_counts.push_back(running_count);
}
expected_counts.push_back(++running_count);
}
auto start_callback =
[](const at::RecordFunction& fn) -> std::unique_ptr<at::ObserverContext> {
++sample_test_counter;
return nullptr;
};
auto end_callback = [](const at::RecordFunction& fn, at::ObserverContext*) {};
auto handle = at::addThreadLocalCallback(
at::RecordFunctionCallback(start_callback, end_callback)
.samplingProb(p)
.scopes({at::RecordScope::FUNCTION}));
for (const auto i : c10::irange(expected_counts.size())) {
RECORD_FUNCTION("Test", {});
EXPECT_EQ(sample_test_counter, expected_counts[i]);
}
at::removeCallback(handle);
ASSERT_FALSE(at::hasCallbacks());
}
// Validate sampling against a simple reference implementation for a complex set
// of registered callbacks.
TEST(RecordFunctionTest, MultipleCallbacks) {
at::clearCallbacks();
ASSERT_FALSE(at::hasCallbacks());
uint32_t seed = 54321;
std::mt19937 generator;
generator.seed(seed);
auto sample = [&](double p) {
return (p < 1.0 ? std::geometric_distribution<int>(p)(generator) : 0) + 1;
};
std::array<double, 4> probabilities{0.1, 1.0, 1.0, 0.3};
std::array<int, 4> next_call;
std::array<int, 4> counts;
static std::array<int, 4> counts_from_rec_fn;
counts_from_rec_fn.fill(0);
auto start_callback_0 =
[](const at::RecordFunction& fn) -> std::unique_ptr<at::ObserverContext> {
++counts_from_rec_fn[0];
return nullptr;
};
auto end_callback = [](const at::RecordFunction& fn, at::ObserverContext*) {};
#define REGISTER_CALLBACK(register_fn, index) \
register_fn(at::RecordFunctionCallback( \
[](const at::RecordFunction& fn) \
-> std::unique_ptr<at::ObserverContext> { \
++counts_from_rec_fn[index]; \
return nullptr; \
}, \
end_callback) \
.samplingProb(probabilities[index]) \
.scopes({at::RecordScope::FUNCTION}))
REGISTER_CALLBACK(at::addGlobalCallback, 0);
REGISTER_CALLBACK(at::addGlobalCallback, 1);
REGISTER_CALLBACK(at::addThreadLocalCallback, 2);
// The RecordFunction machinery will rebuild callbacks whenever a new observer
// is registered, so we need to wait until the last callback to seed the
// random number generator.
at::set_record_function_seed_for_testing(seed);
REGISTER_CALLBACK(at::addThreadLocalCallback, 3);
#undef REGISTER_CALLBACK
for (const auto i : c10::irange(probabilities.size())) {
next_call[i] = sample(probabilities[i]);
}
for (const auto i : c10::irange(50)) {
RECORD_FUNCTION("Test", {});
for (const auto j : c10::irange(next_call.size())) {
if (!(--next_call[j])) {
++counts[j];
next_call[j] = sample(probabilities[j]);
}
EXPECT_EQ(counts[j], counts_from_rec_fn[j]);
}
}
at::clearCallbacks();
ASSERT_FALSE(at::hasCallbacks());
}
|
