blob: f9e673c8378775ad4fb57b3d4a803d4f1c0e5c68 [file] [log] [blame]
Alex Perrycb7da4b2019-08-28 19:35:56 -07001#include "aos/events/event_loop_param_test.h"
Parker Schuhe4a70d62017-12-27 20:10:20 -08002
Austin Schuh52d325c2019-06-23 18:59:06 -07003#include <chrono>
Brian Silverman4f4e0612020-08-12 19:54:41 -07004#include <unordered_map>
5#include <unordered_set>
Austin Schuh52d325c2019-06-23 18:59:06 -07006
Eric Schmiedebergef44b8a2022-02-28 17:30:38 -07007#include "aos/events/test_message_generated.h"
Austin Schuh54cf95f2019-11-29 13:14:18 -08008#include "aos/flatbuffer_merge.h"
Austin Schuhad9e5eb2021-11-19 20:33:55 -08009#include "aos/logging/log_message_generated.h"
10#include "aos/logging/logging.h"
Austin Schuhcc6070c2020-10-10 20:25:56 -070011#include "aos/realtime.h"
Austin Schuh54cf95f2019-11-29 13:14:18 -080012#include "glog/logging.h"
Tyler Chatow67ddb032020-01-12 14:30:04 -080013#include "gmock/gmock.h"
14#include "gtest/gtest.h"
Austin Schuh9fe68f72019-08-10 19:32:03 -070015
Parker Schuhe4a70d62017-12-27 20:10:20 -080016namespace aos {
17namespace testing {
Austin Schuh52d325c2019-06-23 18:59:06 -070018namespace {
19namespace chrono = ::std::chrono;
20} // namespace
Parker Schuhe4a70d62017-12-27 20:10:20 -080021
Brian Silverman4f4e0612020-08-12 19:54:41 -070022::std::unique_ptr<EventLoop> AbstractEventLoopTest::Make(
23 std::string_view name) {
24 std::string name_copy(name);
25 if (name == "") {
26 name_copy = "loop";
27 name_copy += std::to_string(event_loop_count_);
28 }
29 ++event_loop_count_;
Austin Schuh6bae8252021-02-07 22:01:49 -080030 auto result = factory_->Make(name_copy);
31 if (do_timing_reports() == DoTimingReports::kNo) {
32 result->SkipTimingReport();
33 }
34 return result;
Brian Silverman4f4e0612020-08-12 19:54:41 -070035}
36
37void AbstractEventLoopTest::VerifyBuffers(
38 int number_buffers,
39 std::vector<std::reference_wrapper<const Fetcher<TestMessage>>> fetchers,
40 std::vector<std::reference_wrapper<const Sender<TestMessage>>> senders) {
41 // The buffers which are in a sender.
42 std::unordered_set<int> in_sender;
43 for (const Sender<TestMessage> &sender : senders) {
44 const int this_buffer = sender.buffer_index();
45 CHECK_GE(this_buffer, 0);
46 CHECK_LT(this_buffer, number_buffers);
47 CHECK(in_sender.insert(this_buffer).second) << ": " << this_buffer;
48 }
49
50 if (read_method() != ReadMethod::PIN) {
51 // If we're not using PIN, we can't really verify anything about what
52 // buffers the fetchers have.
53 return;
54 }
55
56 // Mapping from TestMessage::value to buffer index.
57 std::unordered_map<int, int> fetcher_values;
58 for (const Fetcher<TestMessage> &fetcher : fetchers) {
59 if (!fetcher.get()) {
60 continue;
61 }
62 const int this_buffer = fetcher.context().buffer_index;
63 CHECK_GE(this_buffer, 0);
64 CHECK_LT(this_buffer, number_buffers);
65 CHECK(in_sender.count(this_buffer) == 0) << ": " << this_buffer;
66 const auto insert_result = fetcher_values.insert(
67 std::make_pair(fetcher.get()->value(), this_buffer));
68 if (!insert_result.second) {
69 CHECK_EQ(this_buffer, insert_result.first->second);
70 }
71 }
72}
73
Austin Schuh6b6dfa52019-06-12 20:16:20 -070074// Tests that watcher can receive messages from a sender.
Parker Schuhe4a70d62017-12-27 20:10:20 -080075// Also tests that OnRun() works.
76TEST_P(AbstractEventLoopTest, Basic) {
77 auto loop1 = Make();
Austin Schuh6b6dfa52019-06-12 20:16:20 -070078 auto loop2 = MakePrimary();
79
Alex Perrycb7da4b2019-08-28 19:35:56 -070080 aos::Sender<TestMessage> sender = loop1->MakeSender<TestMessage>("/test");
Austin Schuh6b6dfa52019-06-12 20:16:20 -070081
82 bool happened = false;
83
84 loop2->OnRun([&]() {
85 happened = true;
86
Alex Perrycb7da4b2019-08-28 19:35:56 -070087 aos::Sender<TestMessage>::Builder msg = sender.MakeBuilder();
88 TestMessage::Builder builder = msg.MakeBuilder<TestMessage>();
89 builder.add_value(200);
milind1f1dca32021-07-03 13:50:07 -070090 msg.CheckOk(msg.Send(builder.Finish()));
Austin Schuh6b6dfa52019-06-12 20:16:20 -070091 });
92
93 loop2->MakeWatcher("/test", [&](const TestMessage &message) {
Alex Perrycb7da4b2019-08-28 19:35:56 -070094 EXPECT_EQ(message.value(), 200);
Austin Schuh9fe68f72019-08-10 19:32:03 -070095 this->Exit();
Austin Schuh6b6dfa52019-06-12 20:16:20 -070096 });
97
98 EXPECT_FALSE(happened);
99 Run();
100 EXPECT_TRUE(happened);
101}
102
Brian Silverman341b57e2020-06-23 16:23:18 -0700103// Tests that watcher can receive messages from a sender, sent via SendDetached.
104TEST_P(AbstractEventLoopTest, BasicSendDetached) {
105 auto loop1 = Make();
106 auto loop2 = MakePrimary();
107
108 aos::Sender<TestMessage> sender = loop1->MakeSender<TestMessage>("/test");
109
110 FlatbufferDetachedBuffer<TestMessage> detached =
111 flatbuffers::DetachedBuffer();
112 {
113 aos::Sender<TestMessage>::Builder msg = sender.MakeBuilder();
114 TestMessage::Builder builder = msg.MakeBuilder<TestMessage>();
115 builder.add_value(100);
116 detached = msg.Detach(builder.Finish());
117 }
118 detached = flatbuffers::DetachedBuffer();
119 {
120 aos::Sender<TestMessage>::Builder msg = sender.MakeBuilder();
121 TestMessage::Builder builder = msg.MakeBuilder<TestMessage>();
122 builder.add_value(200);
123 detached = msg.Detach(builder.Finish());
124 }
milind1f1dca32021-07-03 13:50:07 -0700125 sender.CheckOk(sender.SendDetached(std::move(detached)));
Brian Silverman341b57e2020-06-23 16:23:18 -0700126
127 auto fetcher = loop2->MakeFetcher<TestMessage>("/test");
128 ASSERT_TRUE(fetcher.Fetch());
129 EXPECT_EQ(fetcher->value(), 200);
130}
131
Brian Silverman6b8a3c32020-03-06 11:26:14 -0800132// Verifies that a no-arg watcher will not have a data pointer.
133TEST_P(AbstractEventLoopTest, NoArgNoData) {
134 auto loop1 = Make();
135 auto loop2 = MakePrimary();
136
137 aos::Sender<TestMessage> sender = loop1->MakeSender<TestMessage>("/test");
138
139 bool happened = false;
140
141 loop2->OnRun([&]() {
142 happened = true;
143
144 aos::Sender<TestMessage>::Builder msg = sender.MakeBuilder();
145 TestMessage::Builder builder = msg.MakeBuilder<TestMessage>();
milind1f1dca32021-07-03 13:50:07 -0700146 msg.CheckOk(msg.Send(builder.Finish()));
Brian Silverman6b8a3c32020-03-06 11:26:14 -0800147 });
148
149 loop2->MakeNoArgWatcher<TestMessage>("/test", [&]() {
150 EXPECT_GT(loop2->context().size, 0u);
151 EXPECT_EQ(nullptr, loop2->context().data);
Brian Silverman4f4e0612020-08-12 19:54:41 -0700152 EXPECT_EQ(-1, loop2->context().buffer_index);
Brian Silverman6b8a3c32020-03-06 11:26:14 -0800153 this->Exit();
154 });
155
156 EXPECT_FALSE(happened);
157 Run();
158 EXPECT_TRUE(happened);
159}
160
Brian Silverman454bc112020-03-05 14:21:25 -0800161// Tests that no-arg watcher can receive messages from a sender.
162// Also tests that OnRun() works.
163TEST_P(AbstractEventLoopTest, BasicNoArg) {
164 auto loop1 = Make();
165 auto loop2 = MakePrimary();
166
167 aos::Sender<TestMessage> sender = loop1->MakeSender<TestMessage>("/test");
168
169 bool happened = false;
170
171 loop2->OnRun([&]() {
172 happened = true;
173
174 aos::Sender<TestMessage>::Builder msg = sender.MakeBuilder();
175 TestMessage::Builder builder = msg.MakeBuilder<TestMessage>();
176 builder.add_value(200);
milind1f1dca32021-07-03 13:50:07 -0700177 msg.CheckOk(msg.Send(builder.Finish()));
Brian Silverman454bc112020-03-05 14:21:25 -0800178 });
179
180 aos::Fetcher<TestMessage> fetcher = loop2->MakeFetcher<TestMessage>("/test");
181 loop2->MakeNoArgWatcher<TestMessage>("/test", [&]() {
182 ASSERT_TRUE(fetcher.Fetch());
183 EXPECT_EQ(fetcher->value(), 200);
184 this->Exit();
185 });
186
187 EXPECT_FALSE(happened);
188 Run();
189 EXPECT_TRUE(happened);
190}
191
192// Tests that a watcher can be created with an std::function.
193TEST_P(AbstractEventLoopTest, BasicFunction) {
194 auto loop1 = Make();
195 auto loop2 = MakePrimary();
196
197 aos::Sender<TestMessage> sender = loop1->MakeSender<TestMessage>("/test");
198
199 bool happened = false;
200
201 loop2->OnRun([&]() {
202 happened = true;
203
204 aos::Sender<TestMessage>::Builder msg = sender.MakeBuilder();
205 TestMessage::Builder builder = msg.MakeBuilder<TestMessage>();
206 builder.add_value(200);
milind1f1dca32021-07-03 13:50:07 -0700207 msg.CheckOk(msg.Send(builder.Finish()));
Brian Silverman454bc112020-03-05 14:21:25 -0800208 });
209
210 loop2->MakeWatcher("/test", std::function<void(const TestMessage &)>(
211 [&](const TestMessage &message) {
212 EXPECT_EQ(message.value(), 200);
213 this->Exit();
214 }));
215
216 EXPECT_FALSE(happened);
217 Run();
218 EXPECT_TRUE(happened);
219}
220
Brian Silverman0fc69932020-01-24 21:54:02 -0800221// Tests that watcher can receive messages from two senders.
222// Also tests that OnRun() works.
223TEST_P(AbstractEventLoopTest, BasicTwoSenders) {
224 auto loop1 = Make();
225 auto loop2 = MakePrimary();
226
227 aos::Sender<TestMessage> sender1 = loop1->MakeSender<TestMessage>("/test");
228 aos::Sender<TestMessage> sender2 = loop1->MakeSender<TestMessage>("/test");
229
230 bool happened = false;
231
232 loop2->OnRun([&]() {
233 happened = true;
234
235 {
236 aos::Sender<TestMessage>::Builder msg = sender1.MakeBuilder();
237 TestMessage::Builder builder = msg.MakeBuilder<TestMessage>();
238 builder.add_value(200);
milind1f1dca32021-07-03 13:50:07 -0700239 msg.CheckOk(msg.Send(builder.Finish()));
Brian Silverman0fc69932020-01-24 21:54:02 -0800240 }
241 {
242 aos::Sender<TestMessage>::Builder msg = sender2.MakeBuilder();
243 TestMessage::Builder builder = msg.MakeBuilder<TestMessage>();
244 builder.add_value(200);
milind1f1dca32021-07-03 13:50:07 -0700245 msg.CheckOk(msg.Send(builder.Finish()));
Brian Silverman0fc69932020-01-24 21:54:02 -0800246 }
247 });
248
249 int messages_received = 0;
250 loop2->MakeWatcher("/test", [&](const TestMessage &message) {
251 EXPECT_EQ(message.value(), 200);
252 this->Exit();
253 ++messages_received;
254 });
255
256 EXPECT_FALSE(happened);
257 Run();
258 EXPECT_TRUE(happened);
259 EXPECT_EQ(messages_received, 2);
260}
261
Austin Schuh6b6dfa52019-06-12 20:16:20 -0700262// Tests that a fetcher can fetch from a sender.
263// Also tests that OnRun() works.
264TEST_P(AbstractEventLoopTest, FetchWithoutRun) {
265 auto loop1 = Make();
Parker Schuhe4a70d62017-12-27 20:10:20 -0800266 auto loop2 = Make();
Austin Schuh44019f92019-05-19 19:58:27 -0700267 auto loop3 = MakePrimary();
Parker Schuhe4a70d62017-12-27 20:10:20 -0800268
269 auto sender = loop1->MakeSender<TestMessage>("/test");
270
271 auto fetcher = loop2->MakeFetcher<TestMessage>("/test");
272
Austin Schuhbbce72d2019-05-26 15:11:46 -0700273 EXPECT_FALSE(fetcher.Fetch());
Austin Schuh39788ff2019-12-01 18:22:57 -0800274 EXPECT_EQ(fetcher.get(), nullptr);
275
Austin Schuhad154822019-12-27 15:45:13 -0800276 EXPECT_EQ(fetcher.context().monotonic_event_time, monotonic_clock::min_time);
277 EXPECT_EQ(fetcher.context().monotonic_remote_time, monotonic_clock::min_time);
278 EXPECT_EQ(fetcher.context().realtime_event_time, realtime_clock::min_time);
279 EXPECT_EQ(fetcher.context().realtime_remote_time, realtime_clock::min_time);
Austin Schuha9012be2021-07-21 15:19:11 -0700280 EXPECT_EQ(fetcher.context().source_boot_uuid, UUID::Zero());
Austin Schuh39788ff2019-12-01 18:22:57 -0800281 EXPECT_EQ(fetcher.context().queue_index, 0xffffffffu);
282 EXPECT_EQ(fetcher.context().size, 0u);
283 EXPECT_EQ(fetcher.context().data, nullptr);
Brian Silverman4f4e0612020-08-12 19:54:41 -0700284 EXPECT_EQ(fetcher.context().buffer_index, -1);
Austin Schuhbbce72d2019-05-26 15:11:46 -0700285
Alex Perrycb7da4b2019-08-28 19:35:56 -0700286 aos::Sender<TestMessage>::Builder msg = sender.MakeBuilder();
287 TestMessage::Builder builder = msg.MakeBuilder<TestMessage>();
288 builder.add_value(200);
milind1f1dca32021-07-03 13:50:07 -0700289 msg.CheckOk(msg.Send(builder.Finish()));
Austin Schuh3578a2e2019-05-25 18:17:59 -0700290
291 EXPECT_TRUE(fetcher.Fetch());
292 ASSERT_FALSE(fetcher.get() == nullptr);
Alex Perrycb7da4b2019-08-28 19:35:56 -0700293 EXPECT_EQ(fetcher.get()->value(), 200);
Austin Schuh39788ff2019-12-01 18:22:57 -0800294
295 const chrono::milliseconds kEpsilon(100);
296
Austin Schuhad154822019-12-27 15:45:13 -0800297 const aos::monotonic_clock::time_point monotonic_now = loop2->monotonic_now();
298 const aos::realtime_clock::time_point realtime_now = loop2->realtime_now();
299 EXPECT_EQ(fetcher.context().monotonic_event_time,
300 fetcher.context().monotonic_remote_time);
301 EXPECT_EQ(fetcher.context().realtime_event_time,
302 fetcher.context().realtime_remote_time);
303
304 EXPECT_GE(fetcher.context().monotonic_event_time, monotonic_now - kEpsilon);
305 EXPECT_LE(fetcher.context().monotonic_event_time, monotonic_now + kEpsilon);
306 EXPECT_GE(fetcher.context().realtime_event_time, realtime_now - kEpsilon);
307 EXPECT_LE(fetcher.context().realtime_event_time, realtime_now + kEpsilon);
Austin Schuha9012be2021-07-21 15:19:11 -0700308 EXPECT_EQ(fetcher.context().source_boot_uuid, loop2->boot_uuid());
Austin Schuh39788ff2019-12-01 18:22:57 -0800309 EXPECT_EQ(fetcher.context().queue_index, 0x0u);
310 EXPECT_EQ(fetcher.context().size, 20u);
311 EXPECT_NE(fetcher.context().data, nullptr);
Brian Silverman4f4e0612020-08-12 19:54:41 -0700312 if (read_method() == ReadMethod::PIN) {
313 EXPECT_GE(fetcher.context().buffer_index, 0);
314 EXPECT_LT(fetcher.context().buffer_index,
315 loop2->NumberBuffers(fetcher.channel()));
316 } else {
317 EXPECT_EQ(fetcher.context().buffer_index, -1);
318 }
Parker Schuhe4a70d62017-12-27 20:10:20 -0800319}
320
Austin Schuh3578a2e2019-05-25 18:17:59 -0700321// Tests that watcher will receive all messages sent if they are sent after
322// initialization and before running.
323TEST_P(AbstractEventLoopTest, DoubleSendAtStartup) {
324 auto loop1 = Make();
325 auto loop2 = MakePrimary();
326
327 auto sender = loop1->MakeSender<TestMessage>("/test");
328
329 ::std::vector<int> values;
330
331 loop2->MakeWatcher("/test", [&](const TestMessage &message) {
Alex Perrycb7da4b2019-08-28 19:35:56 -0700332 values.push_back(message.value());
Austin Schuh3578a2e2019-05-25 18:17:59 -0700333 if (values.size() == 2) {
Austin Schuh9fe68f72019-08-10 19:32:03 -0700334 this->Exit();
Austin Schuh3578a2e2019-05-25 18:17:59 -0700335 }
336 });
337
Austin Schuh6b6dfa52019-06-12 20:16:20 -0700338 // Before Run, should be ignored.
Austin Schuh3578a2e2019-05-25 18:17:59 -0700339 {
Alex Perrycb7da4b2019-08-28 19:35:56 -0700340 aos::Sender<TestMessage>::Builder msg = sender.MakeBuilder();
341 TestMessage::Builder builder = msg.MakeBuilder<TestMessage>();
342 builder.add_value(199);
milind1f1dca32021-07-03 13:50:07 -0700343 msg.CheckOk(msg.Send(builder.Finish()));
Austin Schuh3578a2e2019-05-25 18:17:59 -0700344 }
Austin Schuh6b6dfa52019-06-12 20:16:20 -0700345
346 loop2->OnRun([&]() {
347 {
Alex Perrycb7da4b2019-08-28 19:35:56 -0700348 aos::Sender<TestMessage>::Builder msg = sender.MakeBuilder();
349 TestMessage::Builder builder = msg.MakeBuilder<TestMessage>();
350 builder.add_value(200);
milind1f1dca32021-07-03 13:50:07 -0700351 msg.CheckOk(msg.Send(builder.Finish()));
Austin Schuh6b6dfa52019-06-12 20:16:20 -0700352 }
353 {
Alex Perrycb7da4b2019-08-28 19:35:56 -0700354 aos::Sender<TestMessage>::Builder msg = sender.MakeBuilder();
355 TestMessage::Builder builder = msg.MakeBuilder<TestMessage>();
356 builder.add_value(201);
milind1f1dca32021-07-03 13:50:07 -0700357 msg.CheckOk(msg.Send(builder.Finish()));
Austin Schuh6b6dfa52019-06-12 20:16:20 -0700358 }
359 });
Austin Schuh3578a2e2019-05-25 18:17:59 -0700360
361 Run();
362
363 EXPECT_THAT(values, ::testing::ElementsAreArray({200, 201}));
364}
365
366// Tests that watcher will not receive messages sent before the watcher is
367// created.
368TEST_P(AbstractEventLoopTest, DoubleSendAfterStartup) {
369 auto loop1 = Make();
370 auto loop2 = MakePrimary();
371
372 auto sender = loop1->MakeSender<TestMessage>("/test");
373
374 ::std::vector<int> values;
375
376 {
Alex Perrycb7da4b2019-08-28 19:35:56 -0700377 aos::Sender<TestMessage>::Builder msg = sender.MakeBuilder();
378 TestMessage::Builder builder = msg.MakeBuilder<TestMessage>();
379 builder.add_value(200);
milind1f1dca32021-07-03 13:50:07 -0700380 msg.CheckOk(msg.Send(builder.Finish()));
Austin Schuh3578a2e2019-05-25 18:17:59 -0700381 }
382 {
Alex Perrycb7da4b2019-08-28 19:35:56 -0700383 aos::Sender<TestMessage>::Builder msg = sender.MakeBuilder();
384 TestMessage::Builder builder = msg.MakeBuilder<TestMessage>();
385 builder.add_value(201);
milind1f1dca32021-07-03 13:50:07 -0700386 msg.CheckOk(msg.Send(builder.Finish()));
Austin Schuh3578a2e2019-05-25 18:17:59 -0700387 }
388
389 loop2->MakeWatcher("/test", [&](const TestMessage &message) {
Alex Perrycb7da4b2019-08-28 19:35:56 -0700390 values.push_back(message.value());
Austin Schuh3578a2e2019-05-25 18:17:59 -0700391 });
392
393 // Add a timer to actually quit.
Austin Schuh9fe68f72019-08-10 19:32:03 -0700394 auto test_timer = loop2->AddTimer([this]() { this->Exit(); });
Austin Schuh3578a2e2019-05-25 18:17:59 -0700395 loop2->OnRun([&test_timer, &loop2]() {
396 test_timer->Setup(loop2->monotonic_now(), ::std::chrono::milliseconds(100));
397 });
398
399 Run();
400 EXPECT_EQ(0, values.size());
401}
402
Austin Schuhbbce72d2019-05-26 15:11:46 -0700403// Tests that FetchNext gets all the messages sent after it is constructed.
404TEST_P(AbstractEventLoopTest, FetchNext) {
405 auto loop1 = Make();
406 auto loop2 = MakePrimary();
407
408 auto sender = loop1->MakeSender<TestMessage>("/test");
409 auto fetcher = loop2->MakeFetcher<TestMessage>("/test");
410
411 ::std::vector<int> values;
412
413 {
Alex Perrycb7da4b2019-08-28 19:35:56 -0700414 aos::Sender<TestMessage>::Builder msg = sender.MakeBuilder();
415 TestMessage::Builder builder = msg.MakeBuilder<TestMessage>();
416 builder.add_value(200);
milind1f1dca32021-07-03 13:50:07 -0700417 msg.CheckOk(msg.Send(builder.Finish()));
Austin Schuhbbce72d2019-05-26 15:11:46 -0700418 }
419 {
Alex Perrycb7da4b2019-08-28 19:35:56 -0700420 aos::Sender<TestMessage>::Builder msg = sender.MakeBuilder();
421 TestMessage::Builder builder = msg.MakeBuilder<TestMessage>();
422 builder.add_value(201);
milind1f1dca32021-07-03 13:50:07 -0700423 msg.CheckOk(msg.Send(builder.Finish()));
Austin Schuhbbce72d2019-05-26 15:11:46 -0700424 }
425
426 // Add a timer to actually quit.
Austin Schuh9fe68f72019-08-10 19:32:03 -0700427 auto test_timer = loop2->AddTimer([&fetcher, &values, this]() {
Austin Schuhbbce72d2019-05-26 15:11:46 -0700428 while (fetcher.FetchNext()) {
Alex Perrycb7da4b2019-08-28 19:35:56 -0700429 values.push_back(fetcher.get()->value());
Austin Schuhbbce72d2019-05-26 15:11:46 -0700430 }
Austin Schuh9fe68f72019-08-10 19:32:03 -0700431 this->Exit();
Austin Schuhbbce72d2019-05-26 15:11:46 -0700432 });
433
434 loop2->OnRun([&test_timer, &loop2]() {
435 test_timer->Setup(loop2->monotonic_now(), ::std::chrono::milliseconds(100));
436 });
437
438 Run();
439 EXPECT_THAT(values, ::testing::ElementsAreArray({200, 201}));
440}
441
442// Tests that FetchNext gets no messages sent before it is constructed.
443TEST_P(AbstractEventLoopTest, FetchNextAfterSend) {
444 auto loop1 = Make();
445 auto loop2 = MakePrimary();
446
447 auto sender = loop1->MakeSender<TestMessage>("/test");
448
449 ::std::vector<int> values;
450
451 {
Alex Perrycb7da4b2019-08-28 19:35:56 -0700452 aos::Sender<TestMessage>::Builder msg = sender.MakeBuilder();
453 TestMessage::Builder builder = msg.MakeBuilder<TestMessage>();
454 builder.add_value(200);
milind1f1dca32021-07-03 13:50:07 -0700455 msg.CheckOk(msg.Send(builder.Finish()));
Austin Schuhbbce72d2019-05-26 15:11:46 -0700456 }
457 {
Alex Perrycb7da4b2019-08-28 19:35:56 -0700458 aos::Sender<TestMessage>::Builder msg = sender.MakeBuilder();
459 TestMessage::Builder builder = msg.MakeBuilder<TestMessage>();
460 builder.add_value(201);
milind1f1dca32021-07-03 13:50:07 -0700461 msg.CheckOk(msg.Send(builder.Finish()));
Austin Schuhbbce72d2019-05-26 15:11:46 -0700462 }
463
464 auto fetcher = loop2->MakeFetcher<TestMessage>("/test");
465
466 // Add a timer to actually quit.
Austin Schuh9fe68f72019-08-10 19:32:03 -0700467 auto test_timer = loop2->AddTimer([&fetcher, &values, this]() {
Austin Schuhbbce72d2019-05-26 15:11:46 -0700468 while (fetcher.FetchNext()) {
Alex Perrycb7da4b2019-08-28 19:35:56 -0700469 values.push_back(fetcher.get()->value());
Austin Schuhbbce72d2019-05-26 15:11:46 -0700470 }
Austin Schuh9fe68f72019-08-10 19:32:03 -0700471 this->Exit();
Austin Schuhbbce72d2019-05-26 15:11:46 -0700472 });
473
474 loop2->OnRun([&test_timer, &loop2]() {
475 test_timer->Setup(loop2->monotonic_now(), ::std::chrono::milliseconds(100));
476 });
477
478 Run();
479 EXPECT_THAT(0, values.size());
480}
481
482// Tests that Fetch returns the last message created before the loop was
483// started.
484TEST_P(AbstractEventLoopTest, FetchDataFromBeforeCreation) {
485 auto loop1 = Make();
486 auto loop2 = MakePrimary();
487
488 auto sender = loop1->MakeSender<TestMessage>("/test");
489
490 ::std::vector<int> values;
491
492 {
Alex Perrycb7da4b2019-08-28 19:35:56 -0700493 aos::Sender<TestMessage>::Builder msg = sender.MakeBuilder();
494 TestMessage::Builder builder = msg.MakeBuilder<TestMessage>();
495 builder.add_value(200);
milind1f1dca32021-07-03 13:50:07 -0700496 msg.CheckOk(msg.Send(builder.Finish()));
Austin Schuhbbce72d2019-05-26 15:11:46 -0700497 }
498 {
Alex Perrycb7da4b2019-08-28 19:35:56 -0700499 aos::Sender<TestMessage>::Builder msg = sender.MakeBuilder();
500 TestMessage::Builder builder = msg.MakeBuilder<TestMessage>();
501 builder.add_value(201);
milind1f1dca32021-07-03 13:50:07 -0700502 msg.CheckOk(msg.Send(builder.Finish()));
Austin Schuhbbce72d2019-05-26 15:11:46 -0700503 }
504
505 auto fetcher = loop2->MakeFetcher<TestMessage>("/test");
506
507 // Add a timer to actually quit.
Austin Schuh9fe68f72019-08-10 19:32:03 -0700508 auto test_timer = loop2->AddTimer([&fetcher, &values, this]() {
Austin Schuhbbce72d2019-05-26 15:11:46 -0700509 if (fetcher.Fetch()) {
Alex Perrycb7da4b2019-08-28 19:35:56 -0700510 values.push_back(fetcher.get()->value());
Austin Schuhbbce72d2019-05-26 15:11:46 -0700511 }
512 // Do it again to make sure we don't double fetch.
513 if (fetcher.Fetch()) {
Alex Perrycb7da4b2019-08-28 19:35:56 -0700514 values.push_back(fetcher.get()->value());
Austin Schuhbbce72d2019-05-26 15:11:46 -0700515 }
Austin Schuh9fe68f72019-08-10 19:32:03 -0700516 this->Exit();
Austin Schuhbbce72d2019-05-26 15:11:46 -0700517 });
518
519 loop2->OnRun([&test_timer, &loop2]() {
520 test_timer->Setup(loop2->monotonic_now(), ::std::chrono::milliseconds(100));
521 });
522
523 Run();
524 EXPECT_THAT(values, ::testing::ElementsAreArray({201}));
525}
526
527// Tests that Fetch and FetchNext interleave as expected.
528TEST_P(AbstractEventLoopTest, FetchAndFetchNextTogether) {
529 auto loop1 = Make();
530 auto loop2 = MakePrimary();
531
532 auto sender = loop1->MakeSender<TestMessage>("/test");
533
534 ::std::vector<int> values;
535
536 {
Alex Perrycb7da4b2019-08-28 19:35:56 -0700537 aos::Sender<TestMessage>::Builder msg = sender.MakeBuilder();
538 TestMessage::Builder builder = msg.MakeBuilder<TestMessage>();
539 builder.add_value(200);
milind1f1dca32021-07-03 13:50:07 -0700540 msg.CheckOk(msg.Send(builder.Finish()));
Austin Schuhbbce72d2019-05-26 15:11:46 -0700541 }
542 {
Alex Perrycb7da4b2019-08-28 19:35:56 -0700543 aos::Sender<TestMessage>::Builder msg = sender.MakeBuilder();
544 TestMessage::Builder builder = msg.MakeBuilder<TestMessage>();
545 builder.add_value(201);
milind1f1dca32021-07-03 13:50:07 -0700546 msg.CheckOk(msg.Send(builder.Finish()));
Austin Schuhbbce72d2019-05-26 15:11:46 -0700547 }
548
549 auto fetcher = loop2->MakeFetcher<TestMessage>("/test");
550
551 // Add a timer to actually quit.
Austin Schuh9fe68f72019-08-10 19:32:03 -0700552 auto test_timer = loop2->AddTimer([&fetcher, &values, &sender, this]() {
Austin Schuhbbce72d2019-05-26 15:11:46 -0700553 if (fetcher.Fetch()) {
Alex Perrycb7da4b2019-08-28 19:35:56 -0700554 values.push_back(fetcher.get()->value());
Austin Schuhbbce72d2019-05-26 15:11:46 -0700555 }
556
557 {
Alex Perrycb7da4b2019-08-28 19:35:56 -0700558 aos::Sender<TestMessage>::Builder msg = sender.MakeBuilder();
559 TestMessage::Builder builder = msg.MakeBuilder<TestMessage>();
560 builder.add_value(202);
milind1f1dca32021-07-03 13:50:07 -0700561 msg.CheckOk(msg.Send(builder.Finish()));
Austin Schuhbbce72d2019-05-26 15:11:46 -0700562 }
563 {
Alex Perrycb7da4b2019-08-28 19:35:56 -0700564 aos::Sender<TestMessage>::Builder msg = sender.MakeBuilder();
565 TestMessage::Builder builder = msg.MakeBuilder<TestMessage>();
566 builder.add_value(203);
milind1f1dca32021-07-03 13:50:07 -0700567 msg.CheckOk(msg.Send(builder.Finish()));
Austin Schuhbbce72d2019-05-26 15:11:46 -0700568 }
569 {
Alex Perrycb7da4b2019-08-28 19:35:56 -0700570 aos::Sender<TestMessage>::Builder msg = sender.MakeBuilder();
571 TestMessage::Builder builder = msg.MakeBuilder<TestMessage>();
572 builder.add_value(204);
milind1f1dca32021-07-03 13:50:07 -0700573 msg.CheckOk(msg.Send(builder.Finish()));
Austin Schuhbbce72d2019-05-26 15:11:46 -0700574 }
575
576 if (fetcher.FetchNext()) {
Alex Perrycb7da4b2019-08-28 19:35:56 -0700577 values.push_back(fetcher.get()->value());
Austin Schuhbbce72d2019-05-26 15:11:46 -0700578 }
579
580 if (fetcher.Fetch()) {
Alex Perrycb7da4b2019-08-28 19:35:56 -0700581 values.push_back(fetcher.get()->value());
Austin Schuhbbce72d2019-05-26 15:11:46 -0700582 }
583
Austin Schuh9fe68f72019-08-10 19:32:03 -0700584 this->Exit();
Austin Schuhbbce72d2019-05-26 15:11:46 -0700585 });
586
587 loop2->OnRun([&test_timer, &loop2]() {
588 test_timer->Setup(loop2->monotonic_now(), ::std::chrono::milliseconds(100));
589 });
590
591 Run();
592 EXPECT_THAT(values, ::testing::ElementsAreArray({201, 202, 204}));
593}
594
Austin Schuh3115a202019-05-27 21:02:14 -0700595// Tests that FetchNext behaves correctly when we get two messages in the queue
596// but don't consume the first until after the second has been sent.
597TEST_P(AbstractEventLoopTest, FetchNextTest) {
Austin Schuh3115a202019-05-27 21:02:14 -0700598 auto send_loop = Make();
599 auto fetch_loop = Make();
600 auto sender = send_loop->MakeSender<TestMessage>("/test");
601 Fetcher<TestMessage> fetcher = fetch_loop->MakeFetcher<TestMessage>("/test");
602
603 {
Tyler Chatow67ddb032020-01-12 14:30:04 -0800604 aos::Sender<TestMessage>::Builder msg = sender.MakeBuilder();
605 TestMessage::Builder builder = msg.MakeBuilder<TestMessage>();
606 builder.add_value(100);
milind1f1dca32021-07-03 13:50:07 -0700607 msg.CheckOk(msg.Send(builder.Finish()));
Austin Schuh3115a202019-05-27 21:02:14 -0700608 }
609
610 {
Alex Perrycb7da4b2019-08-28 19:35:56 -0700611 aos::Sender<TestMessage>::Builder msg = sender.MakeBuilder();
612 TestMessage::Builder builder = msg.MakeBuilder<TestMessage>();
613 builder.add_value(200);
milind1f1dca32021-07-03 13:50:07 -0700614 msg.CheckOk(msg.Send(builder.Finish()));
Austin Schuh3115a202019-05-27 21:02:14 -0700615 }
616
617 ASSERT_TRUE(fetcher.FetchNext());
618 ASSERT_NE(nullptr, fetcher.get());
Alex Perrycb7da4b2019-08-28 19:35:56 -0700619 EXPECT_EQ(100, fetcher.get()->value());
Austin Schuh3115a202019-05-27 21:02:14 -0700620
621 ASSERT_TRUE(fetcher.FetchNext());
622 ASSERT_NE(nullptr, fetcher.get());
Alex Perrycb7da4b2019-08-28 19:35:56 -0700623 EXPECT_EQ(200, fetcher.get()->value());
Austin Schuh3115a202019-05-27 21:02:14 -0700624
625 // When we run off the end of the queue, expect to still have the old message:
626 ASSERT_FALSE(fetcher.FetchNext());
627 ASSERT_NE(nullptr, fetcher.get());
Alex Perrycb7da4b2019-08-28 19:35:56 -0700628 EXPECT_EQ(200, fetcher.get()->value());
Austin Schuh3115a202019-05-27 21:02:14 -0700629}
630
Brian Silverman77162972020-08-12 19:52:40 -0700631// Verify that a fetcher still holds its data, even after falling behind.
632TEST_P(AbstractEventLoopTest, FetcherBehindData) {
633 auto send_loop = Make();
634 auto fetch_loop = Make();
635 auto sender = send_loop->MakeSender<TestMessage>("/test");
636 Fetcher<TestMessage> fetcher = fetch_loop->MakeFetcher<TestMessage>("/test");
637 {
638 aos::Sender<TestMessage>::Builder msg = sender.MakeBuilder();
639 TestMessage::Builder builder = msg.MakeBuilder<TestMessage>();
640 builder.add_value(1);
milind1f1dca32021-07-03 13:50:07 -0700641 msg.CheckOk(msg.Send(builder.Finish()));
Brian Silverman77162972020-08-12 19:52:40 -0700642 }
643 ASSERT_TRUE(fetcher.Fetch());
644 EXPECT_EQ(1, fetcher.get()->value());
645 for (int i = 0; i < 300; ++i) {
646 aos::Sender<TestMessage>::Builder msg = sender.MakeBuilder();
647 TestMessage::Builder builder = msg.MakeBuilder<TestMessage>();
648 builder.add_value(i + 2);
milind1f1dca32021-07-03 13:50:07 -0700649 msg.CheckOk(msg.Send(builder.Finish()));
Brian Silverman77162972020-08-12 19:52:40 -0700650 }
651 EXPECT_EQ(1, fetcher.get()->value());
652}
653
654// Try a bunch of orderings of operations with fetchers and senders. Verify that
655// all the fetchers have the correct data at each step.
656TEST_P(AbstractEventLoopTest, FetcherPermutations) {
657 for (int max_save = 0; max_save < 5; ++max_save) {
658 SCOPED_TRACE("max_save=" + std::to_string(max_save));
659
660 auto send_loop = Make();
661 auto fetch_loop = Make();
662 auto sender = send_loop->MakeSender<TestMessage>("/test");
663 const auto send_message = [&sender](int i) {
664 aos::Sender<TestMessage>::Builder msg = sender.MakeBuilder();
665 TestMessage::Builder builder = msg.MakeBuilder<TestMessage>();
666 builder.add_value(i);
milind1f1dca32021-07-03 13:50:07 -0700667 msg.CheckOk(msg.Send(builder.Finish()));
Brian Silverman77162972020-08-12 19:52:40 -0700668 };
669 std::vector<Fetcher<TestMessage>> fetchers;
670 for (int i = 0; i < 10; ++i) {
671 fetchers.emplace_back(fetch_loop->MakeFetcher<TestMessage>("/test"));
672 }
673 send_message(1);
Brian Silverman4f4e0612020-08-12 19:54:41 -0700674 const auto verify_buffers = [&]() {
675 std::vector<std::reference_wrapper<const Fetcher<TestMessage>>>
676 fetchers_copy;
677 for (const auto &fetcher : fetchers) {
678 fetchers_copy.emplace_back(fetcher);
679 }
680 std::vector<std::reference_wrapper<const Sender<TestMessage>>>
681 senders_copy;
682 senders_copy.emplace_back(sender);
683 VerifyBuffers(send_loop->NumberBuffers(sender.channel()), fetchers_copy,
684 senders_copy);
685 };
Brian Silverman77162972020-08-12 19:52:40 -0700686 for (auto &fetcher : fetchers) {
687 ASSERT_TRUE(fetcher.Fetch());
Brian Silverman4f4e0612020-08-12 19:54:41 -0700688 verify_buffers();
Brian Silverman77162972020-08-12 19:52:40 -0700689 EXPECT_EQ(1, fetcher.get()->value());
690 }
691
692 for (int save = 1; save <= max_save; ++save) {
693 SCOPED_TRACE("save=" + std::to_string(save));
694 send_message(100 + save);
Brian Silverman4f4e0612020-08-12 19:54:41 -0700695 verify_buffers();
Brian Silverman77162972020-08-12 19:52:40 -0700696 for (size_t i = 0; i < fetchers.size() - save; ++i) {
697 SCOPED_TRACE("fetcher=" + std::to_string(i));
698 ASSERT_TRUE(fetchers[i].Fetch());
Brian Silverman4f4e0612020-08-12 19:54:41 -0700699 verify_buffers();
Brian Silverman77162972020-08-12 19:52:40 -0700700 EXPECT_EQ(100 + save, fetchers[i].get()->value());
701 }
702 for (size_t i = fetchers.size() - save; i < fetchers.size() - 1; ++i) {
703 SCOPED_TRACE("fetcher=" + std::to_string(i));
704 EXPECT_EQ(100 + (fetchers.size() - 1 - i), fetchers[i].get()->value());
705 }
706 EXPECT_EQ(1, fetchers.back().get()->value());
707 }
708
709 for (int i = 0; i < 300; ++i) {
710 send_message(200 + i);
Brian Silverman4f4e0612020-08-12 19:54:41 -0700711 verify_buffers();
Brian Silverman77162972020-08-12 19:52:40 -0700712 }
713
714 for (size_t i = 0; i < fetchers.size() - max_save; ++i) {
715 SCOPED_TRACE("fetcher=" + std::to_string(i));
716 if (max_save > 0) {
717 EXPECT_EQ(100 + max_save, fetchers[i].get()->value());
718 } else {
719 EXPECT_EQ(1, fetchers[i].get()->value());
720 }
721 }
722 for (size_t i = fetchers.size() - max_save; i < fetchers.size() - 1; ++i) {
723 SCOPED_TRACE("fetcher=" + std::to_string(i));
724 EXPECT_EQ(100 + (fetchers.size() - 1 - i), fetchers[i].get()->value());
725 }
726 EXPECT_EQ(1, fetchers.back().get()->value());
727 }
728}
729
Austin Schuh81fc9cc2019-02-02 23:25:47 -0800730// Verify that making a fetcher and watcher for "/test" succeeds.
731TEST_P(AbstractEventLoopTest, FetcherAndWatcher) {
Parker Schuhe4a70d62017-12-27 20:10:20 -0800732 auto loop = Make();
733 auto fetcher = loop->MakeFetcher<TestMessage>("/test");
Austin Schuh81fc9cc2019-02-02 23:25:47 -0800734 loop->MakeWatcher("/test", [&](const TestMessage &) {});
Parker Schuhe4a70d62017-12-27 20:10:20 -0800735}
736
Austin Schuh81fc9cc2019-02-02 23:25:47 -0800737// Verify that making 2 fetchers for "/test" succeeds.
Parker Schuhe4a70d62017-12-27 20:10:20 -0800738TEST_P(AbstractEventLoopTest, TwoFetcher) {
739 auto loop = Make();
740 auto fetcher = loop->MakeFetcher<TestMessage>("/test");
Austin Schuh81fc9cc2019-02-02 23:25:47 -0800741 auto fetcher2 = loop->MakeFetcher<TestMessage>("/test");
Parker Schuhe4a70d62017-12-27 20:10:20 -0800742}
743
Alex Perrycb7da4b2019-08-28 19:35:56 -0700744// Verify that registering a watcher for an invalid channel name dies.
745TEST_P(AbstractEventLoopDeathTest, InvalidChannelName) {
746 auto loop = Make();
747 EXPECT_DEATH(
748 { loop->MakeWatcher("/test/invalid", [&](const TestMessage &) {}); },
749 "/test/invalid");
Brian Silverman454bc112020-03-05 14:21:25 -0800750 EXPECT_DEATH(
751 { loop->MakeNoArgWatcher<TestMessage>("/test/invalid", [&]() {}); },
752 "/test/invalid");
Alex Perrycb7da4b2019-08-28 19:35:56 -0700753}
754
Austin Schuh81fc9cc2019-02-02 23:25:47 -0800755// Verify that registering a watcher twice for "/test" fails.
Austin Schuh6b6dfa52019-06-12 20:16:20 -0700756TEST_P(AbstractEventLoopDeathTest, TwoWatcher) {
Parker Schuhe4a70d62017-12-27 20:10:20 -0800757 auto loop = Make();
758 loop->MakeWatcher("/test", [&](const TestMessage &) {});
Austin Schuh81fc9cc2019-02-02 23:25:47 -0800759 EXPECT_DEATH(loop->MakeWatcher("/test", [&](const TestMessage &) {}),
760 "/test");
Brian Silverman454bc112020-03-05 14:21:25 -0800761 EXPECT_DEATH(loop->MakeNoArgWatcher<TestMessage>("/test", [&]() {}), "/test");
762}
763
764// Verify that registering a no-arg watcher twice for "/test" fails.
765TEST_P(AbstractEventLoopDeathTest, TwoNoArgWatcher) {
766 auto loop = Make();
767 loop->MakeNoArgWatcher<TestMessage>("/test", [&]() {});
768 EXPECT_DEATH(loop->MakeWatcher("/test", [&](const TestMessage &) {}),
769 "/test");
770 EXPECT_DEATH(loop->MakeNoArgWatcher<TestMessage>("/test", [&]() {}), "/test");
Austin Schuh81fc9cc2019-02-02 23:25:47 -0800771}
772
Austin Schuh3115a202019-05-27 21:02:14 -0700773// Verify that SetRuntimeRealtimePriority fails while running.
Austin Schuh6b6dfa52019-06-12 20:16:20 -0700774TEST_P(AbstractEventLoopDeathTest, SetRuntimeRealtimePriority) {
Austin Schuh3115a202019-05-27 21:02:14 -0700775 auto loop = MakePrimary();
776 // Confirm that runtime priority calls work when not realtime.
777 loop->SetRuntimeRealtimePriority(5);
778
779 loop->OnRun([&]() { loop->SetRuntimeRealtimePriority(5); });
780
781 EXPECT_DEATH(Run(), "realtime");
782}
783
Brian Silverman6a54ff32020-04-28 16:41:39 -0700784// Verify that SetRuntimeAffinity fails while running.
785TEST_P(AbstractEventLoopDeathTest, SetRuntimeAffinity) {
Austin Schuhde973292021-10-12 18:09:49 -0700786 const cpu_set_t available = GetCurrentThreadAffinity();
787 int first_cpu = -1;
788 for (int i = 0; i < CPU_SETSIZE; ++i) {
789 if (CPU_ISSET(i, &available)) {
790 first_cpu = i;
791 break;
792 continue;
793 }
794 }
795 CHECK_NE(first_cpu, -1) << ": Default affinity has no CPUs?";
796
Brian Silverman6a54ff32020-04-28 16:41:39 -0700797 auto loop = MakePrimary();
798 // Confirm that runtime priority calls work when not running.
Austin Schuhde973292021-10-12 18:09:49 -0700799 loop->SetRuntimeAffinity(MakeCpusetFromCpus({first_cpu}));
Brian Silverman6a54ff32020-04-28 16:41:39 -0700800
Austin Schuhde973292021-10-12 18:09:49 -0700801 loop->OnRun(
802 [&]() { loop->SetRuntimeAffinity(MakeCpusetFromCpus({first_cpu})); });
Brian Silverman6a54ff32020-04-28 16:41:39 -0700803
804 EXPECT_DEATH(Run(), "Cannot set affinity while running");
805}
806
Austin Schuh81fc9cc2019-02-02 23:25:47 -0800807// Verify that registering a watcher and a sender for "/test" fails.
Austin Schuh6b6dfa52019-06-12 20:16:20 -0700808TEST_P(AbstractEventLoopDeathTest, WatcherAndSender) {
Austin Schuh81fc9cc2019-02-02 23:25:47 -0800809 auto loop = Make();
810 auto sender = loop->MakeSender<TestMessage>("/test");
811 EXPECT_DEATH(loop->MakeWatcher("/test", [&](const TestMessage &) {}),
812 "/test");
Parker Schuhe4a70d62017-12-27 20:10:20 -0800813}
814
Austin Schuhe516ab02020-05-06 21:37:04 -0700815// Verify that creating too many senders fails.
816TEST_P(AbstractEventLoopDeathTest, TooManySenders) {
817 auto loop = Make();
818 std::vector<aos::Sender<TestMessage>> senders;
819 for (int i = 0; i < 10; ++i) {
820 senders.emplace_back(loop->MakeSender<TestMessage>("/test"));
821 }
822 EXPECT_DEATH({ loop->MakeSender<TestMessage>("/test"); },
823 "Failed to create sender on \\{ \"name\": \"/test\", \"type\": "
Brian Silverman77162972020-08-12 19:52:40 -0700824 "\"aos.TestMessage\"[^}]*\\ }, too many senders.");
825}
826
827// Verify that creating too many fetchers fails.
828TEST_P(AbstractEventLoopDeathTest, TooManyFetchers) {
829 if (read_method() != ReadMethod::PIN) {
830 // Other read methods don't limit the number of readers, so just skip this.
831 return;
832 }
833
834 auto loop = Make();
835 std::vector<aos::Fetcher<TestMessage>> fetchers;
836 for (int i = 0; i < 10; ++i) {
837 fetchers.emplace_back(loop->MakeFetcher<TestMessage>("/test"));
838 }
839 EXPECT_DEATH({ loop->MakeFetcher<TestMessage>("/test"); },
840 "Failed to create reader on \\{ \"name\": \"/test\", \"type\": "
841 "\"aos.TestMessage\"[^}]*\\ }, too many readers.");
842}
843
844// Verify that creating too many fetchers, split between two event loops, fails.
845TEST_P(AbstractEventLoopDeathTest, TooManyFetchersTwoLoops) {
846 if (read_method() != ReadMethod::PIN) {
847 // Other read methods don't limit the number of readers, so just skip this.
848 return;
849 }
850
851 auto loop = Make();
852 auto loop2 = Make();
853 std::vector<aos::Fetcher<TestMessage>> fetchers;
854 for (int i = 0; i < 5; ++i) {
855 fetchers.emplace_back(loop->MakeFetcher<TestMessage>("/test"));
856 fetchers.emplace_back(loop2->MakeFetcher<TestMessage>("/test"));
857 }
858 EXPECT_DEATH({ loop->MakeFetcher<TestMessage>("/test"); },
859 "Failed to create reader on \\{ \"name\": \"/test\", \"type\": "
860 "\"aos.TestMessage\"[^}]*\\ }, too many readers.");
861}
862
863// Verify that creating too many watchers fails.
864TEST_P(AbstractEventLoopDeathTest, TooManyWatchers) {
865 if (read_method() != ReadMethod::PIN) {
866 // Other read methods don't limit the number of readers, so just skip this.
867 return;
868 }
869
870 std::vector<std::unique_ptr<EventLoop>> loops;
871 for (int i = 0; i < 10; ++i) {
872 loops.emplace_back(Make());
873 loops.back()->MakeWatcher("/test", [](const TestMessage &) {});
874 }
875 EXPECT_DEATH({ Make()->MakeWatcher("/test", [](const TestMessage &) {}); },
876 "Failed to create reader on \\{ \"name\": \"/test\", \"type\": "
877 "\"aos.TestMessage\"[^}]*\\ }, too many readers.");
878}
879
880// Verify that creating too many watchers and fetchers combined fails.
881TEST_P(AbstractEventLoopDeathTest, TooManyWatchersAndFetchers) {
882 if (read_method() != ReadMethod::PIN) {
883 // Other read methods don't limit the number of readers, so just skip this.
884 return;
885 }
886
887 auto loop = Make();
888 std::vector<aos::Fetcher<TestMessage>> fetchers;
889 std::vector<std::unique_ptr<EventLoop>> loops;
890 for (int i = 0; i < 5; ++i) {
891 fetchers.emplace_back(loop->MakeFetcher<TestMessage>("/test"));
892 loops.emplace_back(Make());
893 loops.back()->MakeWatcher("/test", [](const TestMessage &) {});
894 }
895 EXPECT_DEATH({ loop->MakeFetcher<TestMessage>("/test"); },
896 "Failed to create reader on \\{ \"name\": \"/test\", \"type\": "
897 "\"aos.TestMessage\"[^}]*\\ }, too many readers.");
Austin Schuhe516ab02020-05-06 21:37:04 -0700898}
899
Austin Schuh6b6dfa52019-06-12 20:16:20 -0700900// Verify that we can't create a sender inside OnRun.
901TEST_P(AbstractEventLoopDeathTest, SenderInOnRun) {
902 auto loop1 = MakePrimary();
903
904 loop1->OnRun(
905 [&]() { auto sender = loop1->MakeSender<TestMessage>("/test2"); });
906
907 EXPECT_DEATH(Run(), "running");
908}
909
910// Verify that we can't create a watcher inside OnRun.
911TEST_P(AbstractEventLoopDeathTest, WatcherInOnRun) {
912 auto loop1 = MakePrimary();
913
914 loop1->OnRun(
915 [&]() { loop1->MakeWatcher("/test", [&](const TestMessage &) {}); });
916
917 EXPECT_DEATH(Run(), "running");
918}
919
Brian Silverman454bc112020-03-05 14:21:25 -0800920// Verify that we can't create a no-arg watcher inside OnRun.
921TEST_P(AbstractEventLoopDeathTest, NoArgWatcherInOnRun) {
922 auto loop1 = MakePrimary();
923
924 loop1->OnRun(
925 [&]() { loop1->MakeNoArgWatcher<TestMessage>("/test", [&]() {}); });
926
927 EXPECT_DEATH(Run(), "running");
928}
929
Parker Schuhe4a70d62017-12-27 20:10:20 -0800930// Verify that Quit() works when there are multiple watchers.
Austin Schuh81fc9cc2019-02-02 23:25:47 -0800931TEST_P(AbstractEventLoopTest, MultipleWatcherQuit) {
932 auto loop1 = Make();
Austin Schuh44019f92019-05-19 19:58:27 -0700933 auto loop2 = MakePrimary();
Parker Schuhe4a70d62017-12-27 20:10:20 -0800934
Austin Schuh3578a2e2019-05-25 18:17:59 -0700935 loop2->MakeWatcher("/test1", [&](const TestMessage &) {});
936 loop2->MakeWatcher("/test2", [&](const TestMessage &message) {
Alex Perrycb7da4b2019-08-28 19:35:56 -0700937 EXPECT_EQ(message.value(), 200);
Austin Schuh9fe68f72019-08-10 19:32:03 -0700938 this->Exit();
Austin Schuh3578a2e2019-05-25 18:17:59 -0700939 });
940
Austin Schuh81fc9cc2019-02-02 23:25:47 -0800941 auto sender = loop1->MakeSender<TestMessage>("/test2");
Austin Schuh6b6dfa52019-06-12 20:16:20 -0700942
943 loop2->OnRun([&]() {
Alex Perrycb7da4b2019-08-28 19:35:56 -0700944 aos::Sender<TestMessage>::Builder msg = sender.MakeBuilder();
945 TestMessage::Builder builder = msg.MakeBuilder<TestMessage>();
946 builder.add_value(200);
milind1f1dca32021-07-03 13:50:07 -0700947 msg.CheckOk(msg.Send(builder.Finish()));
Austin Schuh6b6dfa52019-06-12 20:16:20 -0700948 });
Parker Schuhe4a70d62017-12-27 20:10:20 -0800949
Austin Schuh44019f92019-05-19 19:58:27 -0700950 Run();
Parker Schuhe4a70d62017-12-27 20:10:20 -0800951}
952
Austin Schuhad9e5eb2021-11-19 20:33:55 -0800953// Verify that AOS_LOG has the right name.
954TEST_P(AbstractEventLoopTest, AOSLog) {
955 auto loop2 = MakePrimary("loop1");
956 auto loop1 = Make("loop0");
957
958 auto fetcher = loop1->MakeFetcher<aos::logging::LogMessageFbs>("/aos");
959
960 EXPECT_FALSE(fetcher.Fetch());
961
962 loop2->OnRun([&]() {
963 AOS_LOG(INFO, "Testing123");
964 this->Exit();
965 });
966
967 Run();
968 EXPECT_TRUE(fetcher.Fetch());
969 EXPECT_EQ(fetcher->name()->string_view(), "loop1");
970}
971
972// Verify that AOS_LOG has the right name in a watcher.
973TEST_P(AbstractEventLoopTest, AOSLogWatcher) {
974 auto loop2 = MakePrimary("loop1");
975 auto loop1 = Make("loop0");
976
977 auto fetcher = loop1->MakeFetcher<aos::logging::LogMessageFbs>("/aos");
978
979 EXPECT_FALSE(fetcher.Fetch());
980
981 auto sender = loop1->MakeSender<TestMessage>("/test2");
982
983 loop2->MakeWatcher("/test2", [&](const TestMessage & /*message*/) {
984 AOS_LOG(INFO, "Testing123");
985 this->Exit();
986 });
987
988 loop2->OnRun([&]() {
989 aos::Sender<TestMessage>::Builder msg = sender.MakeBuilder();
990 TestMessage::Builder builder = msg.MakeBuilder<TestMessage>();
991 builder.add_value(200);
milind1f1dca32021-07-03 13:50:07 -0700992 msg.CheckOk(msg.Send(builder.Finish()));
Austin Schuhad9e5eb2021-11-19 20:33:55 -0800993 });
994
995 Run();
996 EXPECT_TRUE(fetcher.Fetch());
997 EXPECT_EQ(fetcher->name()->string_view(), "loop1");
998}
999
1000// Verify that AOS_LOG has the right name in a timer.
1001TEST_P(AbstractEventLoopTest, AOSLogTimer) {
1002 auto loop2 = MakePrimary("loop1");
1003 auto loop1 = Make("loop0");
1004
1005 auto fetcher = loop1->MakeFetcher<aos::logging::LogMessageFbs>("/aos");
1006
1007 EXPECT_FALSE(fetcher.Fetch());
1008
1009 auto test_timer = loop2->AddTimer([&]() {
1010 AOS_LOG(INFO, "Testing123");
1011 this->Exit();
1012 });
1013
1014 loop2->OnRun([&]() { test_timer->Setup(loop2->monotonic_now()); });
1015
1016 Run();
1017 EXPECT_TRUE(fetcher.Fetch());
1018 EXPECT_EQ(fetcher->name()->string_view(), "loop1");
1019}
1020
Neil Balch229001a2018-01-07 18:22:52 -08001021// Verify that timer intervals and duration function properly.
1022TEST_P(AbstractEventLoopTest, TimerIntervalAndDuration) {
Stephan Pleines3dce7ea2021-06-22 13:19:26 -07001023 // Force a slower rate so we are guaranteed to have reports for our timer.
Austin Schuh39788ff2019-12-01 18:22:57 -08001024 FLAGS_timing_report_ms = 2000;
1025
Austin Schuhde8a8ff2019-11-30 15:25:36 -08001026 const int kCount = 5;
Neil Balch229001a2018-01-07 18:22:52 -08001027
Austin Schuhde8a8ff2019-11-30 15:25:36 -08001028 auto loop = MakePrimary();
Austin Schuh39788ff2019-12-01 18:22:57 -08001029 auto loop2 = Make();
1030
Austin Schuhde8a8ff2019-11-30 15:25:36 -08001031 ::std::vector<::aos::monotonic_clock::time_point> times;
1032 ::std::vector<::aos::monotonic_clock::time_point> expected_times;
1033
Austin Schuh39788ff2019-12-01 18:22:57 -08001034 Fetcher<timing::Report> report_fetcher =
1035 loop2->MakeFetcher<timing::Report>("/aos");
1036 EXPECT_FALSE(report_fetcher.Fetch());
1037
Austin Schuhde8a8ff2019-11-30 15:25:36 -08001038 auto test_timer = loop->AddTimer([this, &times, &expected_times, &loop]() {
1039 times.push_back(loop->monotonic_now());
Austin Schuhad154822019-12-27 15:45:13 -08001040 EXPECT_EQ(loop->context().monotonic_remote_time, monotonic_clock::min_time);
1041 EXPECT_EQ(loop->context().realtime_event_time, realtime_clock::min_time);
1042 EXPECT_EQ(loop->context().realtime_remote_time, realtime_clock::min_time);
Austin Schuha9012be2021-07-21 15:19:11 -07001043 EXPECT_EQ(loop->context().source_boot_uuid, loop->boot_uuid());
Austin Schuh39788ff2019-12-01 18:22:57 -08001044 EXPECT_EQ(loop->context().queue_index, 0xffffffffu);
1045 EXPECT_EQ(loop->context().size, 0u);
1046 EXPECT_EQ(loop->context().data, nullptr);
Brian Silverman4f4e0612020-08-12 19:54:41 -07001047 EXPECT_EQ(loop->context().buffer_index, -1);
Austin Schuh39788ff2019-12-01 18:22:57 -08001048
Austin Schuhad154822019-12-27 15:45:13 -08001049 expected_times.push_back(loop->context().monotonic_event_time);
Austin Schuhde8a8ff2019-11-30 15:25:36 -08001050 if (times.size() == kCount) {
1051 this->Exit();
1052 }
Neil Balch229001a2018-01-07 18:22:52 -08001053 });
Austin Schuh39788ff2019-12-01 18:22:57 -08001054 test_timer->set_name("Test loop");
Neil Balch229001a2018-01-07 18:22:52 -08001055
Austin Schuh39788ff2019-12-01 18:22:57 -08001056 const monotonic_clock::time_point start_time = loop->monotonic_now();
Austin Schuh52d325c2019-06-23 18:59:06 -07001057 // TODO(austin): This should be an error... Should be done in OnRun only.
Austin Schuhde8a8ff2019-11-30 15:25:36 -08001058 test_timer->Setup(start_time + chrono::seconds(1), chrono::seconds(1));
1059
Austin Schuh44019f92019-05-19 19:58:27 -07001060 Run();
Neil Balch229001a2018-01-07 18:22:52 -08001061
Austin Schuhde8a8ff2019-11-30 15:25:36 -08001062 // Confirm that we got both the right number of samples, and it's odd.
Stephan Pleines3dce7ea2021-06-22 13:19:26 -07001063 ASSERT_EQ(times.size(), static_cast<size_t>(kCount));
1064 ASSERT_EQ(times.size(), expected_times.size());
1065 ASSERT_EQ((times.size() % 2), 1);
Austin Schuhde8a8ff2019-11-30 15:25:36 -08001066
1067 // Grab the middle sample.
1068 ::aos::monotonic_clock::time_point average_time = times[times.size() / 2];
1069
1070 // Add up all the delays of all the times.
1071 ::aos::monotonic_clock::duration sum = chrono::seconds(0);
1072 for (const ::aos::monotonic_clock::time_point time : times) {
1073 sum += time - average_time;
1074 }
1075
1076 // Average and add to the middle to find the average time.
1077 sum /= times.size();
1078 average_time += sum;
1079
1080 // Compute the offset from the average and the expected average. It
1081 // should be pretty close to 0.
1082 const ::aos::monotonic_clock::duration remainder =
1083 average_time - start_time - chrono::seconds(times.size() / 2 + 1);
1084
1085 const chrono::milliseconds kEpsilon(100);
1086 EXPECT_LT(remainder, +kEpsilon);
1087 EXPECT_GT(remainder, -kEpsilon);
1088
1089 // Make sure that the average duration is close to 1 second.
1090 EXPECT_NEAR(chrono::duration_cast<chrono::duration<double>>(times.back() -
1091 times.front())
1092 .count() /
1093 static_cast<double>(times.size() - 1),
1094 1.0, 0.1);
1095
1096 // Confirm that the ideal wakeup times increment correctly.
1097 for (size_t i = 1; i < expected_times.size(); ++i) {
1098 EXPECT_EQ(expected_times[i], expected_times[i - 1] + chrono::seconds(1));
1099 }
1100
1101 for (size_t i = 0; i < expected_times.size(); ++i) {
1102 EXPECT_EQ((expected_times[i] - start_time) % chrono::seconds(1),
1103 chrono::seconds(0));
1104 }
1105
1106 EXPECT_LT(expected_times[expected_times.size() / 2], average_time + kEpsilon);
1107 EXPECT_GT(expected_times[expected_times.size() / 2], average_time - kEpsilon);
Austin Schuh39788ff2019-12-01 18:22:57 -08001108
Austin Schuh6bae8252021-02-07 22:01:49 -08001109 if (do_timing_reports() == DoTimingReports::kYes) {
1110 // And, since we are here, check that the timing report makes sense.
1111 // Start by looking for our event loop's timing.
1112 FlatbufferDetachedBuffer<timing::Report> report =
1113 FlatbufferDetachedBuffer<timing::Report>::Empty();
1114 while (report_fetcher.FetchNext()) {
1115 if (report_fetcher->name()->string_view() == "primary") {
1116 report = CopyFlatBuffer(report_fetcher.get());
1117 }
Austin Schuh39788ff2019-12-01 18:22:57 -08001118 }
Austin Schuh6bae8252021-02-07 22:01:49 -08001119
1120 // Confirm that we have the right number of reports, and the contents are
1121 // sane.
1122 VLOG(1) << FlatbufferToJson(report, {.multi_line = true});
1123
1124 EXPECT_EQ(report.message().name()->string_view(), "primary");
1125
1126 ASSERT_NE(report.message().senders(), nullptr);
1127 EXPECT_EQ(report.message().senders()->size(), 2);
1128
1129 ASSERT_NE(report.message().timers(), nullptr);
1130 EXPECT_EQ(report.message().timers()->size(), 2);
1131
1132 EXPECT_EQ(report.message().timers()->Get(0)->name()->string_view(),
1133 "Test loop");
1134 EXPECT_GE(report.message().timers()->Get(0)->count(), 1);
1135
1136 EXPECT_EQ(report.message().timers()->Get(1)->name()->string_view(),
1137 "timing_reports");
1138 EXPECT_EQ(report.message().timers()->Get(1)->count(), 1);
1139
1140 // Make sure there is a single phased loop report with our report in it.
1141 ASSERT_EQ(report.message().phased_loops(), nullptr);
1142 } else {
1143 ASSERT_FALSE(report_fetcher.Fetch());
Austin Schuh39788ff2019-12-01 18:22:57 -08001144 }
Neil Balch229001a2018-01-07 18:22:52 -08001145}
1146
1147// Verify that we can change a timer's parameters during execution.
1148TEST_P(AbstractEventLoopTest, TimerChangeParameters) {
Austin Schuh44019f92019-05-19 19:58:27 -07001149 auto loop = MakePrimary();
Austin Schuhd892f102021-10-12 18:01:46 -07001150 loop->SetRuntimeRealtimePriority(1);
Austin Schuh7f20f512021-01-31 17:56:16 -08001151 std::vector<monotonic_clock::time_point> iteration_list;
Neil Balch229001a2018-01-07 18:22:52 -08001152
1153 auto test_timer = loop->AddTimer([&iteration_list, &loop]() {
Austin Schuh7f20f512021-01-31 17:56:16 -08001154 iteration_list.push_back(loop->context().monotonic_event_time);
Neil Balch229001a2018-01-07 18:22:52 -08001155 });
1156
Austin Schuh7f20f512021-01-31 17:56:16 -08001157 monotonic_clock::time_point s;
1158 auto modifier_timer = loop->AddTimer([&test_timer, &s]() {
Austin Schuhd892f102021-10-12 18:01:46 -07001159 test_timer->Setup(s + chrono::milliseconds(1750),
1160 chrono::milliseconds(600));
Neil Balch229001a2018-01-07 18:22:52 -08001161 });
1162
Austin Schuh7f20f512021-01-31 17:56:16 -08001163 s = loop->monotonic_now();
Austin Schuhd892f102021-10-12 18:01:46 -07001164 test_timer->Setup(s, chrono::milliseconds(500));
1165 modifier_timer->Setup(s + chrono::milliseconds(1250));
1166 EndEventLoop(loop.get(), chrono::milliseconds(3950));
Austin Schuh44019f92019-05-19 19:58:27 -07001167 Run();
Neil Balch229001a2018-01-07 18:22:52 -08001168
Austin Schuhd892f102021-10-12 18:01:46 -07001169 EXPECT_THAT(
1170 iteration_list,
1171 ::testing::ElementsAre(
1172 s, s + chrono::milliseconds(500), s + chrono::milliseconds(1000),
1173 s + chrono::milliseconds(1750), s + chrono::milliseconds(2350),
1174 s + chrono::milliseconds(2950), s + chrono::milliseconds(3550)));
Neil Balch229001a2018-01-07 18:22:52 -08001175}
1176
1177// Verify that we can disable a timer during execution.
1178TEST_P(AbstractEventLoopTest, TimerDisable) {
Austin Schuh44019f92019-05-19 19:58:27 -07001179 auto loop = MakePrimary();
Austin Schuhd892f102021-10-12 18:01:46 -07001180 loop->SetRuntimeRealtimePriority(1);
Neil Balch229001a2018-01-07 18:22:52 -08001181 ::std::vector<::aos::monotonic_clock::time_point> iteration_list;
1182
1183 auto test_timer = loop->AddTimer([&iteration_list, &loop]() {
Austin Schuhd892f102021-10-12 18:01:46 -07001184 iteration_list.push_back(loop->context().monotonic_event_time);
Neil Balch229001a2018-01-07 18:22:52 -08001185 });
1186
Tyler Chatow67ddb032020-01-12 14:30:04 -08001187 auto ender_timer = loop->AddTimer([&test_timer]() { test_timer->Disable(); });
Neil Balch229001a2018-01-07 18:22:52 -08001188
Austin Schuhd892f102021-10-12 18:01:46 -07001189 monotonic_clock::time_point s = loop->monotonic_now();
Austin Schuh73d99502021-12-08 12:05:39 -08001190 test_timer->Setup(s, ::std::chrono::milliseconds(500));
1191 ender_timer->Setup(s + ::std::chrono::milliseconds(1250));
1192 EndEventLoop(loop.get(), ::std::chrono::milliseconds(2000));
Austin Schuh44019f92019-05-19 19:58:27 -07001193 Run();
Neil Balch229001a2018-01-07 18:22:52 -08001194
Austin Schuhd892f102021-10-12 18:01:46 -07001195 EXPECT_THAT(iteration_list,
Austin Schuh73d99502021-12-08 12:05:39 -08001196 ::testing::ElementsAre(s, s + chrono::milliseconds(500),
1197 s + chrono::milliseconds(1000)));
Neil Balch229001a2018-01-07 18:22:52 -08001198}
Austin Schuh7267c532019-05-19 19:55:53 -07001199
Brian Silvermanaf9a4d82020-10-06 15:10:58 -07001200// Verify that a timer can disable itself.
1201//
1202// TODO(Brian): Do something similar with phased loops, both with a quick
1203// handler and a handler that would miss a cycle except it got deferred. Current
1204// behavior doing that is a mess.
1205TEST_P(AbstractEventLoopTest, TimerDisableSelf) {
1206 auto loop = MakePrimary();
1207
1208 int count = 0;
1209 aos::TimerHandler *test_timer;
1210 test_timer = loop->AddTimer([&count, &test_timer]() {
1211 ++count;
1212 test_timer->Disable();
1213 });
1214
1215 test_timer->Setup(loop->monotonic_now(), ::std::chrono::milliseconds(20));
1216 EndEventLoop(loop.get(), ::std::chrono::milliseconds(80));
1217 Run();
1218
1219 EXPECT_EQ(count, 1);
1220}
1221
Brian Silvermanbd405c02020-06-23 16:25:23 -07001222// Verify that we can disable a timer during execution of another timer
1223// scheduled for the same time, with one ordering of creation for the timers.
1224//
1225// Also schedule some more events to reshuffle the heap in EventLoop used for
1226// tracking events to change up the order. This used to segfault
1227// SimulatedEventLoop.
1228TEST_P(AbstractEventLoopTest, TimerDisableOther) {
1229 for (bool creation_order : {true, false}) {
1230 for (bool setup_order : {true, false}) {
1231 for (int shuffle_events = 0; shuffle_events < 5; ++shuffle_events) {
1232 auto loop = MakePrimary();
1233 aos::TimerHandler *test_timer, *ender_timer;
1234 if (creation_order) {
1235 test_timer = loop->AddTimer([]() {});
1236 ender_timer =
1237 loop->AddTimer([&test_timer]() { test_timer->Disable(); });
1238 } else {
1239 ender_timer =
1240 loop->AddTimer([&test_timer]() { test_timer->Disable(); });
1241 test_timer = loop->AddTimer([]() {});
1242 }
1243
1244 const auto start = loop->monotonic_now();
1245
1246 for (int i = 0; i < shuffle_events; ++i) {
1247 loop->AddTimer([]() {})->Setup(start + std::chrono::milliseconds(10));
1248 }
1249
1250 if (setup_order) {
1251 test_timer->Setup(start + ::std::chrono::milliseconds(20));
1252 ender_timer->Setup(start + ::std::chrono::milliseconds(20));
1253 } else {
1254 ender_timer->Setup(start + ::std::chrono::milliseconds(20));
1255 test_timer->Setup(start + ::std::chrono::milliseconds(20));
1256 }
1257 EndEventLoop(loop.get(), ::std::chrono::milliseconds(40));
1258 Run();
1259 }
1260 }
1261 }
1262}
1263
Austin Schuh54cf95f2019-11-29 13:14:18 -08001264// Verifies that the event loop implementations detect when Channel is not a
Brian Silverman631b6262021-11-10 12:25:08 -08001265// pointer into configuration(), or a name doesn't map to a channel in
1266// configuration().
Austin Schuh54cf95f2019-11-29 13:14:18 -08001267TEST_P(AbstractEventLoopDeathTest, InvalidChannel) {
1268 auto loop = MakePrimary();
1269
Tyler Chatow67ddb032020-01-12 14:30:04 -08001270 const Channel *channel = configuration::GetChannel(
1271 loop->configuration(), "/test", "aos.TestMessage", "", nullptr);
Austin Schuh54cf95f2019-11-29 13:14:18 -08001272
1273 FlatbufferDetachedBuffer<Channel> channel_copy = CopyFlatBuffer(channel);
1274
1275 EXPECT_DEATH(
Brian Silverman631b6262021-11-10 12:25:08 -08001276 loop->MakeRawSender(&channel_copy.message()),
Austin Schuh54cf95f2019-11-29 13:14:18 -08001277 "Channel pointer not found in configuration\\(\\)->channels\\(\\)");
1278
1279 EXPECT_DEATH(
Brian Silverman631b6262021-11-10 12:25:08 -08001280 loop->MakeSender<TestMessage>("/testbad"),
1281 "Channel \\{ \"name\": \"/testbad\", \"type\": \"aos.TestMessage\" \\}"
1282 " not found in config");
1283
1284 EXPECT_FALSE(loop->TryMakeSender<TestMessage>("/testbad"));
1285
1286 EXPECT_DEATH(
1287 loop->MakeRawFetcher(&channel_copy.message()),
Austin Schuh54cf95f2019-11-29 13:14:18 -08001288 "Channel pointer not found in configuration\\(\\)->channels\\(\\)");
1289
1290 EXPECT_DEATH(
Brian Silverman631b6262021-11-10 12:25:08 -08001291 loop->MakeFetcher<TestMessage>("/testbad"),
1292 "Channel \\{ \"name\": \"/testbad\", \"type\": \"aos.TestMessage\" \\}"
1293 " not found in config");
1294
1295 EXPECT_FALSE(loop->TryMakeFetcher<TestMessage>("/testbad").valid());
1296
1297 EXPECT_DEATH(
Austin Schuh54cf95f2019-11-29 13:14:18 -08001298 {
1299 loop->MakeRawWatcher(&channel_copy.message(),
1300 [](const Context, const void *) {});
1301 },
1302 "Channel pointer not found in configuration\\(\\)->channels\\(\\)");
Brian Silverman631b6262021-11-10 12:25:08 -08001303
1304 EXPECT_DEATH(
1305 { loop->MakeWatcher("/testbad", [](const TestMessage &) {}); },
1306 "Channel \\{ \"name\": \"/testbad\", \"type\": \"aos.TestMessage\" \\}"
1307 " not found in config");
1308}
1309
1310// Verifies that the event loop handles a channel which is not readable or
1311// writable on the current node nicely.
1312TEST_P(AbstractEventLoopDeathTest, InaccessibleChannel) {
1313 EnableNodes("me");
1314 auto loop = MakePrimary("me");
1315 auto loop2 = Make("them");
1316
1317 const Channel *channel = configuration::GetChannel(
1318 loop->configuration(), "/test_noforward", "aos.TestMessage", "", nullptr);
1319
1320 FlatbufferDetachedBuffer<Channel> channel_copy = CopyFlatBuffer(channel);
1321
1322 EXPECT_DEATH(
1323 loop2->MakeSender<TestMessage>("/test_forward"),
1324 "Channel"
1325 " \\{ \"name\": \"/test_forward\", \"type\": \"aos.TestMessage\" \\}"
1326 " is not able to be sent on this node");
1327
1328 EXPECT_FALSE(loop2->TryMakeSender<TestMessage>("/test_forward"));
1329
1330 EXPECT_DEATH(
1331 loop2->MakeRawFetcher(channel),
1332 "Channel"
1333 " \\{ \"name\": \"/test_noforward\", \"type\": \"aos.TestMessage\" \\}"
1334 " is not able to be fetched on this node");
1335
1336 EXPECT_DEATH(
1337 loop2->MakeFetcher<TestMessage>("/test_noforward"),
1338 "Channel"
1339 " \\{ \"name\": \"/test_noforward\", \"type\": \"aos.TestMessage\" \\}"
1340 " is not able to be fetched on this node");
1341
1342 EXPECT_FALSE(loop2->TryMakeFetcher<TestMessage>("/test_noforward").valid());
1343
1344 EXPECT_DEATH(
1345 { loop2->MakeRawWatcher(channel, [](const Context, const void *) {}); },
1346 "\\{ \"name\": \"/test_noforward\", \"type\": \"aos.TestMessage\", "
1347 "\"source_node\": \"them\" \\}"
1348 " is not able to be watched on this node");
1349
1350 EXPECT_DEATH(
1351 { loop2->MakeWatcher("/test_noforward", [](const TestMessage &) {}); },
1352 "\\{ \"name\": \"/test_noforward\", \"type\": \"aos.TestMessage\", "
1353 "\"source_node\": \"them\" \\}"
1354 " is not able to be watched on this node");
Austin Schuh54cf95f2019-11-29 13:14:18 -08001355}
1356
Austin Schuhd54780b2020-10-03 16:26:02 -07001357// Verifies that the event loop implementations detect when Channel has an
1358// invalid alignment.
1359TEST_P(AbstractEventLoopDeathTest, InvalidChannelAlignment) {
1360 const char *const kError = "multiple of alignment";
1361 InvalidChannelAlignment();
1362
1363 auto loop = MakePrimary();
1364
1365 const Channel *channel = configuration::GetChannel(
1366 loop->configuration(), "/test", "aos.TestMessage", "", nullptr);
1367
1368 EXPECT_DEATH({ loop->MakeRawSender(channel); }, kError);
1369 EXPECT_DEATH({ loop->MakeSender<TestMessage>("/test"); }, kError);
1370
1371 EXPECT_DEATH({ loop->MakeRawFetcher(channel); }, kError);
1372 EXPECT_DEATH({ loop->MakeFetcher<TestMessage>("/test"); }, kError);
1373
1374 EXPECT_DEATH(
1375 { loop->MakeRawWatcher(channel, [](const Context &, const void *) {}); },
1376 kError);
1377 EXPECT_DEATH({ loop->MakeRawNoArgWatcher(channel, [](const Context &) {}); },
1378 kError);
1379
1380 EXPECT_DEATH({ loop->MakeNoArgWatcher<TestMessage>("/test", []() {}); },
1381 kError);
1382 EXPECT_DEATH({ loop->MakeWatcher("/test", [](const TestMessage &) {}); },
1383 kError);
1384}
1385
Brian Silverman454bc112020-03-05 14:21:25 -08001386// Verify that the send time on a message is roughly right when using a watcher.
Austin Schuh7267c532019-05-19 19:55:53 -07001387TEST_P(AbstractEventLoopTest, MessageSendTime) {
Austin Schuh44019f92019-05-19 19:58:27 -07001388 auto loop1 = MakePrimary();
Austin Schuh7267c532019-05-19 19:55:53 -07001389 auto loop2 = Make();
Austin Schuhad154822019-12-27 15:45:13 -08001390 auto sender = loop2->MakeSender<TestMessage>("/test");
Austin Schuh7267c532019-05-19 19:55:53 -07001391 auto fetcher = loop2->MakeFetcher<TestMessage>("/test");
1392
1393 auto test_timer = loop1->AddTimer([&sender]() {
Alex Perrycb7da4b2019-08-28 19:35:56 -07001394 aos::Sender<TestMessage>::Builder msg = sender.MakeBuilder();
1395 TestMessage::Builder builder = msg.MakeBuilder<TestMessage>();
1396 builder.add_value(200);
milind1f1dca32021-07-03 13:50:07 -07001397 msg.CheckOk(msg.Send(builder.Finish()));
Alex Perrycb7da4b2019-08-28 19:35:56 -07001398 });
1399
Austin Schuhad154822019-12-27 15:45:13 -08001400 bool triggered = false;
Brian Silverman454bc112020-03-05 14:21:25 -08001401 loop1->MakeWatcher("/test", [&](const TestMessage &msg) {
Austin Schuhad154822019-12-27 15:45:13 -08001402 // Confirm that the data pointer makes sense from a watcher, and all the
1403 // timestamps look right.
1404 EXPECT_GT(&msg, loop1->context().data);
1405 EXPECT_EQ(loop1->context().monotonic_remote_time,
1406 loop1->context().monotonic_event_time);
1407 EXPECT_EQ(loop1->context().realtime_remote_time,
1408 loop1->context().realtime_event_time);
Austin Schuha9012be2021-07-21 15:19:11 -07001409 EXPECT_EQ(loop1->context().source_boot_uuid, loop1->boot_uuid());
Austin Schuhad154822019-12-27 15:45:13 -08001410
1411 const aos::monotonic_clock::time_point monotonic_now =
1412 loop1->monotonic_now();
Tyler Chatow67ddb032020-01-12 14:30:04 -08001413 const aos::realtime_clock::time_point realtime_now = loop1->realtime_now();
Austin Schuhad154822019-12-27 15:45:13 -08001414
1415 EXPECT_LE(loop1->context().monotonic_event_time, monotonic_now);
1416 EXPECT_LE(loop1->context().realtime_event_time, realtime_now);
1417 EXPECT_GE(loop1->context().monotonic_event_time + chrono::milliseconds(500),
1418 monotonic_now);
1419 EXPECT_GE(loop1->context().realtime_event_time + chrono::milliseconds(500),
1420 realtime_now);
1421
Brian Silvermaneaa41d62020-07-08 19:47:35 -07001422 EXPECT_LT(&msg, reinterpret_cast<const void *>(
1423 reinterpret_cast<const char *>(loop1->context().data) +
Austin Schuhad154822019-12-27 15:45:13 -08001424 loop1->context().size));
Brian Silverman4f4e0612020-08-12 19:54:41 -07001425 if (read_method() == ReadMethod::PIN) {
1426 EXPECT_GE(loop1->context().buffer_index, 0);
1427 EXPECT_LT(loop1->context().buffer_index,
1428 loop1->NumberBuffers(
1429 configuration::GetChannel(loop1->configuration(), "/test",
1430 "aos.TestMessage", "", nullptr)));
1431 } else {
1432 EXPECT_EQ(-1, loop1->context().buffer_index);
1433 }
Austin Schuhad154822019-12-27 15:45:13 -08001434 triggered = true;
Austin Schuh7267c532019-05-19 19:55:53 -07001435 });
1436
1437 test_timer->Setup(loop1->monotonic_now() + ::std::chrono::seconds(1));
1438
1439 EndEventLoop(loop1.get(), ::std::chrono::seconds(2));
Austin Schuh44019f92019-05-19 19:58:27 -07001440 Run();
Austin Schuh7267c532019-05-19 19:55:53 -07001441
Austin Schuhad154822019-12-27 15:45:13 -08001442 EXPECT_TRUE(triggered);
1443
Brian Silverman454bc112020-03-05 14:21:25 -08001444 ASSERT_TRUE(fetcher.Fetch());
1445
1446 monotonic_clock::duration monotonic_time_offset =
1447 fetcher.context().monotonic_event_time -
1448 (loop1->monotonic_now() - ::std::chrono::seconds(1));
1449 realtime_clock::duration realtime_time_offset =
1450 fetcher.context().realtime_event_time -
1451 (loop1->realtime_now() - ::std::chrono::seconds(1));
1452
1453 EXPECT_EQ(fetcher.context().realtime_event_time,
1454 fetcher.context().realtime_remote_time);
1455 EXPECT_EQ(fetcher.context().monotonic_event_time,
1456 fetcher.context().monotonic_remote_time);
Austin Schuha9012be2021-07-21 15:19:11 -07001457 EXPECT_EQ(fetcher.context().source_boot_uuid, loop1->boot_uuid());
Brian Silverman454bc112020-03-05 14:21:25 -08001458
1459 EXPECT_TRUE(monotonic_time_offset > ::std::chrono::milliseconds(-500))
1460 << ": Got "
1461 << fetcher.context().monotonic_event_time.time_since_epoch().count()
1462 << " expected " << loop1->monotonic_now().time_since_epoch().count();
1463 // Confirm that the data pointer makes sense.
1464 EXPECT_GT(fetcher.get(), fetcher.context().data);
1465 EXPECT_LT(fetcher.get(),
Brian Silvermaneaa41d62020-07-08 19:47:35 -07001466 reinterpret_cast<const void *>(
1467 reinterpret_cast<const char *>(fetcher.context().data) +
Brian Silverman454bc112020-03-05 14:21:25 -08001468 fetcher.context().size));
1469 EXPECT_TRUE(monotonic_time_offset < ::std::chrono::milliseconds(500))
1470 << ": Got "
1471 << fetcher.context().monotonic_event_time.time_since_epoch().count()
1472 << " expected " << loop1->monotonic_now().time_since_epoch().count();
1473
1474 EXPECT_TRUE(realtime_time_offset > ::std::chrono::milliseconds(-500))
1475 << ": Got "
1476 << fetcher.context().realtime_event_time.time_since_epoch().count()
1477 << " expected " << loop1->realtime_now().time_since_epoch().count();
1478 EXPECT_TRUE(realtime_time_offset < ::std::chrono::milliseconds(500))
1479 << ": Got "
1480 << fetcher.context().realtime_event_time.time_since_epoch().count()
1481 << " expected " << loop1->realtime_now().time_since_epoch().count();
1482}
1483
1484// Verify that the send time on a message is roughly right when using a no-arg
1485// watcher. To get a message, we need to use a fetcher to actually access the
1486// message. This is also the main use case for no-arg fetchers.
1487TEST_P(AbstractEventLoopTest, MessageSendTimeNoArg) {
1488 auto loop1 = MakePrimary();
1489 auto loop2 = Make();
1490 auto sender = loop2->MakeSender<TestMessage>("/test");
1491 auto fetcher = loop1->MakeFetcher<TestMessage>("/test");
1492
1493 auto test_timer = loop1->AddTimer([&sender]() {
1494 aos::Sender<TestMessage>::Builder msg = sender.MakeBuilder();
1495 TestMessage::Builder builder = msg.MakeBuilder<TestMessage>();
1496 builder.add_value(200);
milind1f1dca32021-07-03 13:50:07 -07001497 msg.CheckOk(msg.Send(builder.Finish()));
Brian Silverman454bc112020-03-05 14:21:25 -08001498 });
1499
1500 bool triggered = false;
1501 loop1->MakeNoArgWatcher<TestMessage>("/test", [&]() {
1502 // Confirm that we can indeed use a fetcher on this channel from this
1503 // context, and it results in a sane data pointer and timestamps.
1504 ASSERT_TRUE(fetcher.Fetch());
1505
1506 EXPECT_EQ(loop1->context().monotonic_remote_time,
1507 loop1->context().monotonic_event_time);
1508 EXPECT_EQ(loop1->context().realtime_remote_time,
1509 loop1->context().realtime_event_time);
Austin Schuha9012be2021-07-21 15:19:11 -07001510 EXPECT_EQ(loop1->context().source_boot_uuid, loop1->boot_uuid());
Brian Silverman454bc112020-03-05 14:21:25 -08001511
1512 const aos::monotonic_clock::time_point monotonic_now =
1513 loop1->monotonic_now();
1514 const aos::realtime_clock::time_point realtime_now = loop1->realtime_now();
1515
1516 EXPECT_LE(loop1->context().monotonic_event_time, monotonic_now);
1517 EXPECT_LE(loop1->context().realtime_event_time, realtime_now);
1518 EXPECT_GE(loop1->context().monotonic_event_time + chrono::milliseconds(500),
1519 monotonic_now);
1520 EXPECT_GE(loop1->context().realtime_event_time + chrono::milliseconds(500),
1521 realtime_now);
1522
1523 triggered = true;
1524 });
1525
1526 test_timer->Setup(loop1->monotonic_now() + ::std::chrono::seconds(1));
1527
1528 EndEventLoop(loop1.get(), ::std::chrono::seconds(2));
1529 Run();
1530
1531 ASSERT_TRUE(triggered);
Austin Schuh7267c532019-05-19 19:55:53 -07001532
Alex Perrycb7da4b2019-08-28 19:35:56 -07001533 monotonic_clock::duration monotonic_time_offset =
Austin Schuhad154822019-12-27 15:45:13 -08001534 fetcher.context().monotonic_event_time -
Alex Perrycb7da4b2019-08-28 19:35:56 -07001535 (loop1->monotonic_now() - ::std::chrono::seconds(1));
1536 realtime_clock::duration realtime_time_offset =
Austin Schuhad154822019-12-27 15:45:13 -08001537 fetcher.context().realtime_event_time -
Alex Perrycb7da4b2019-08-28 19:35:56 -07001538 (loop1->realtime_now() - ::std::chrono::seconds(1));
Austin Schuh7267c532019-05-19 19:55:53 -07001539
Austin Schuhad154822019-12-27 15:45:13 -08001540 EXPECT_EQ(fetcher.context().realtime_event_time,
1541 fetcher.context().realtime_remote_time);
1542 EXPECT_EQ(fetcher.context().monotonic_event_time,
1543 fetcher.context().monotonic_remote_time);
Austin Schuha9012be2021-07-21 15:19:11 -07001544 EXPECT_EQ(fetcher.context().source_boot_uuid, loop1->boot_uuid());
Austin Schuhad154822019-12-27 15:45:13 -08001545
Alex Perrycb7da4b2019-08-28 19:35:56 -07001546 EXPECT_TRUE(monotonic_time_offset > ::std::chrono::milliseconds(-500))
1547 << ": Got "
Austin Schuhad154822019-12-27 15:45:13 -08001548 << fetcher.context().monotonic_event_time.time_since_epoch().count()
Austin Schuh52d325c2019-06-23 18:59:06 -07001549 << " expected " << loop1->monotonic_now().time_since_epoch().count();
Alex Perrycb7da4b2019-08-28 19:35:56 -07001550 // Confirm that the data pointer makes sense.
1551 EXPECT_GT(fetcher.get(), fetcher.context().data);
1552 EXPECT_LT(fetcher.get(),
Brian Silvermaneaa41d62020-07-08 19:47:35 -07001553 reinterpret_cast<const void *>(
1554 reinterpret_cast<const char *>(fetcher.context().data) +
Alex Perrycb7da4b2019-08-28 19:35:56 -07001555 fetcher.context().size));
1556 EXPECT_TRUE(monotonic_time_offset < ::std::chrono::milliseconds(500))
1557 << ": Got "
Austin Schuhad154822019-12-27 15:45:13 -08001558 << fetcher.context().monotonic_event_time.time_since_epoch().count()
Austin Schuh7267c532019-05-19 19:55:53 -07001559 << " expected " << loop1->monotonic_now().time_since_epoch().count();
Alex Perrycb7da4b2019-08-28 19:35:56 -07001560
1561 EXPECT_TRUE(realtime_time_offset > ::std::chrono::milliseconds(-500))
1562 << ": Got "
Austin Schuhad154822019-12-27 15:45:13 -08001563 << fetcher.context().realtime_event_time.time_since_epoch().count()
Alex Perrycb7da4b2019-08-28 19:35:56 -07001564 << " expected " << loop1->realtime_now().time_since_epoch().count();
1565 EXPECT_TRUE(realtime_time_offset < ::std::chrono::milliseconds(500))
1566 << ": Got "
Austin Schuhad154822019-12-27 15:45:13 -08001567 << fetcher.context().realtime_event_time.time_since_epoch().count()
Alex Perrycb7da4b2019-08-28 19:35:56 -07001568 << " expected " << loop1->realtime_now().time_since_epoch().count();
Austin Schuh7267c532019-05-19 19:55:53 -07001569}
1570
Austin Schuh52d325c2019-06-23 18:59:06 -07001571// Tests that a couple phased loops run in a row result in the correct offset
1572// and period.
1573TEST_P(AbstractEventLoopTest, PhasedLoopTest) {
Stephan Pleines3dce7ea2021-06-22 13:19:26 -07001574 // Force a slower rate so we are guaranteed to have reports for our phased
Austin Schuh39788ff2019-12-01 18:22:57 -08001575 // loop.
1576 FLAGS_timing_report_ms = 2000;
1577
Austin Schuh52d325c2019-06-23 18:59:06 -07001578 const chrono::milliseconds kOffset = chrono::milliseconds(400);
1579 const int kCount = 5;
1580
1581 auto loop1 = MakePrimary();
Austin Schuh39788ff2019-12-01 18:22:57 -08001582 auto loop2 = Make();
1583
1584 Fetcher<timing::Report> report_fetcher =
1585 loop2->MakeFetcher<timing::Report>("/aos");
1586 EXPECT_FALSE(report_fetcher.Fetch());
Austin Schuh52d325c2019-06-23 18:59:06 -07001587
1588 // Collect up a couple of samples.
1589 ::std::vector<::aos::monotonic_clock::time_point> times;
Austin Schuhde8a8ff2019-11-30 15:25:36 -08001590 ::std::vector<::aos::monotonic_clock::time_point> expected_times;
Austin Schuh52d325c2019-06-23 18:59:06 -07001591
1592 // Run kCount iterations.
Austin Schuh39788ff2019-12-01 18:22:57 -08001593 loop1
1594 ->AddPhasedLoop(
1595 [&times, &expected_times, &loop1, this](int count) {
1596 EXPECT_EQ(count, 1);
1597 times.push_back(loop1->monotonic_now());
Austin Schuhad154822019-12-27 15:45:13 -08001598 expected_times.push_back(loop1->context().monotonic_event_time);
Austin Schuh39788ff2019-12-01 18:22:57 -08001599
Austin Schuhad154822019-12-27 15:45:13 -08001600 EXPECT_EQ(loop1->context().monotonic_remote_time,
1601 monotonic_clock::min_time);
Austin Schuha9012be2021-07-21 15:19:11 -07001602 EXPECT_EQ(loop1->context().source_boot_uuid, loop1->boot_uuid());
Austin Schuhad154822019-12-27 15:45:13 -08001603 EXPECT_EQ(loop1->context().realtime_event_time,
1604 realtime_clock::min_time);
1605 EXPECT_EQ(loop1->context().realtime_remote_time,
Austin Schuh39788ff2019-12-01 18:22:57 -08001606 realtime_clock::min_time);
1607 EXPECT_EQ(loop1->context().queue_index, 0xffffffffu);
1608 EXPECT_EQ(loop1->context().size, 0u);
1609 EXPECT_EQ(loop1->context().data, nullptr);
Brian Silverman4f4e0612020-08-12 19:54:41 -07001610 EXPECT_EQ(loop1->context().buffer_index, -1);
Austin Schuh39788ff2019-12-01 18:22:57 -08001611
1612 if (times.size() == kCount) {
1613 LOG(INFO) << "Exiting";
1614 this->Exit();
1615 }
1616 },
1617 chrono::seconds(1), kOffset)
1618 ->set_name("Test loop");
Austin Schuh52d325c2019-06-23 18:59:06 -07001619
1620 // Add a delay to make sure that delay during startup doesn't result in a
1621 // "missed cycle".
1622 SleepFor(chrono::seconds(2));
1623
1624 Run();
1625
1626 // Confirm that we got both the right number of samples, and it's odd.
Stephan Pleines3dce7ea2021-06-22 13:19:26 -07001627 ASSERT_EQ(times.size(), static_cast<size_t>(kCount));
1628 ASSERT_EQ(times.size(), expected_times.size());
1629 ASSERT_EQ((times.size() % 2), 1);
Austin Schuh52d325c2019-06-23 18:59:06 -07001630
1631 // Grab the middle sample.
Austin Schuhde8a8ff2019-11-30 15:25:36 -08001632 ::aos::monotonic_clock::time_point average_time = times[times.size() / 2];
Austin Schuh52d325c2019-06-23 18:59:06 -07001633
1634 // Add up all the delays of all the times.
1635 ::aos::monotonic_clock::duration sum = chrono::seconds(0);
1636 for (const ::aos::monotonic_clock::time_point time : times) {
Austin Schuhde8a8ff2019-11-30 15:25:36 -08001637 sum += time - average_time;
Austin Schuh52d325c2019-06-23 18:59:06 -07001638 }
1639
1640 // Average and add to the middle to find the average time.
1641 sum /= times.size();
Austin Schuhde8a8ff2019-11-30 15:25:36 -08001642 average_time += sum;
Austin Schuh52d325c2019-06-23 18:59:06 -07001643
1644 // Compute the offset from the start of the second of the average time. This
1645 // should be pretty close to the offset.
1646 const ::aos::monotonic_clock::duration remainder =
Austin Schuhde8a8ff2019-11-30 15:25:36 -08001647 average_time.time_since_epoch() -
1648 chrono::duration_cast<chrono::seconds>(average_time.time_since_epoch());
Austin Schuh52d325c2019-06-23 18:59:06 -07001649
1650 const chrono::milliseconds kEpsilon(100);
1651 EXPECT_LT(remainder, kOffset + kEpsilon);
1652 EXPECT_GT(remainder, kOffset - kEpsilon);
1653
1654 // Make sure that the average duration is close to 1 second.
1655 EXPECT_NEAR(chrono::duration_cast<chrono::duration<double>>(times.back() -
1656 times.front())
1657 .count() /
1658 static_cast<double>(times.size() - 1),
1659 1.0, 0.1);
Austin Schuhde8a8ff2019-11-30 15:25:36 -08001660
1661 // Confirm that the ideal wakeup times increment correctly.
1662 for (size_t i = 1; i < expected_times.size(); ++i) {
1663 EXPECT_EQ(expected_times[i], expected_times[i - 1] + chrono::seconds(1));
1664 }
1665
1666 for (size_t i = 0; i < expected_times.size(); ++i) {
1667 EXPECT_EQ(expected_times[i].time_since_epoch() % chrono::seconds(1),
1668 kOffset);
1669 }
1670
1671 EXPECT_LT(expected_times[expected_times.size() / 2], average_time + kEpsilon);
1672 EXPECT_GT(expected_times[expected_times.size() / 2], average_time - kEpsilon);
Austin Schuh39788ff2019-12-01 18:22:57 -08001673
Austin Schuh6bae8252021-02-07 22:01:49 -08001674 if (do_timing_reports() == DoTimingReports::kYes) {
1675 // And, since we are here, check that the timing report makes sense.
1676 // Start by looking for our event loop's timing.
1677 FlatbufferDetachedBuffer<timing::Report> report =
1678 FlatbufferDetachedBuffer<timing::Report>::Empty();
1679 while (report_fetcher.FetchNext()) {
1680 if (report_fetcher->name()->string_view() == "primary") {
1681 report = CopyFlatBuffer(report_fetcher.get());
1682 }
Austin Schuh39788ff2019-12-01 18:22:57 -08001683 }
Austin Schuh6bae8252021-02-07 22:01:49 -08001684
1685 VLOG(1) << FlatbufferToJson(report, {.multi_line = true});
1686
1687 EXPECT_EQ(report.message().name()->string_view(), "primary");
1688
1689 ASSERT_NE(report.message().senders(), nullptr);
1690 EXPECT_EQ(report.message().senders()->size(), 2);
1691
1692 ASSERT_NE(report.message().timers(), nullptr);
1693 EXPECT_EQ(report.message().timers()->size(), 1);
1694
1695 // Make sure there is a single phased loop report with our report in it.
1696 ASSERT_NE(report.message().phased_loops(), nullptr);
1697 ASSERT_EQ(report.message().phased_loops()->size(), 1);
1698 EXPECT_EQ(report.message().phased_loops()->Get(0)->name()->string_view(),
1699 "Test loop");
1700 EXPECT_GE(report.message().phased_loops()->Get(0)->count(), 1);
1701 } else {
1702 ASSERT_FALSE(report_fetcher.Fetch());
Austin Schuh39788ff2019-12-01 18:22:57 -08001703 }
Austin Schuh39788ff2019-12-01 18:22:57 -08001704}
1705
Milind Upadhyay42589bb2021-05-19 20:05:16 -07001706// Tests that a phased loop responds correctly to a changing offset.
1707TEST_P(AbstractEventLoopTest, PhasedLoopChangingOffsetTest) {
1708 // Force a slower rate so we are guaranteed to have reports for our phased
1709 // loop.
1710 FLAGS_timing_report_ms = 2000;
1711
1712 const chrono::milliseconds kOffset = chrono::milliseconds(400);
1713 const chrono::milliseconds kInterval = chrono::milliseconds(1000);
1714 const int kCount = 5;
1715
1716 auto loop1 = MakePrimary();
1717
1718 // Collect up a couple of samples.
1719 ::std::vector<::aos::monotonic_clock::time_point> times;
1720 ::std::vector<::aos::monotonic_clock::time_point> expected_times;
1721
1722 PhasedLoopHandler *phased_loop;
1723
1724 // Run kCount iterations.
1725 phased_loop = loop1->AddPhasedLoop(
1726 [&phased_loop, &times, &expected_times, &loop1, this, kOffset,
1727 kInterval](int count) {
1728 EXPECT_EQ(count, 1);
1729 times.push_back(loop1->monotonic_now());
1730
1731 expected_times.push_back(loop1->context().monotonic_event_time);
1732
1733 phased_loop->set_interval_and_offset(
1734 kInterval, kOffset - chrono::milliseconds(times.size()));
1735 LOG(INFO) << "new offset: "
1736 << (kOffset - chrono::milliseconds(times.size())).count();
1737
1738 if (times.size() == kCount) {
1739 LOG(INFO) << "Exiting";
1740 this->Exit();
1741 }
1742 },
1743 kInterval, kOffset);
1744 phased_loop->set_name("Test loop");
1745
1746 // Add a delay to make sure that delay during startup doesn't result in a
1747 // "missed cycle".
1748 SleepFor(chrono::seconds(2));
1749
1750 Run();
1751 // Confirm that we got both the right number of samples, and it's odd.
1752 EXPECT_EQ(times.size(), static_cast<size_t>(kCount));
1753 EXPECT_EQ(times.size(), expected_times.size());
1754 EXPECT_EQ((times.size() % 2), 1);
1755
1756 // Grab the middle sample.
1757 ::aos::monotonic_clock::time_point average_time = times[times.size() / 2];
1758
1759 // Add up all the delays of all the times.
1760 ::aos::monotonic_clock::duration sum = chrono::seconds(0);
1761 for (const ::aos::monotonic_clock::time_point time : times) {
1762 sum += time - average_time;
1763 }
1764
1765 // Average and add to the middle to find the average time.
1766 sum /= times.size();
1767 average_time += sum;
1768
1769 // Compute the offset from the start of the second of the average time. This
1770 // should be pretty close to the offset.
1771 const ::aos::monotonic_clock::duration remainder =
1772 average_time.time_since_epoch() -
1773 chrono::duration_cast<chrono::seconds>(average_time.time_since_epoch());
1774
1775 const chrono::milliseconds kEpsilon(100);
1776 EXPECT_LT(remainder, kOffset + kEpsilon);
1777 EXPECT_GT(remainder, kOffset - kEpsilon);
1778
1779 // Make sure that the average duration is close to 1 second.
1780 EXPECT_NEAR(chrono::duration_cast<chrono::duration<double>>(times.back() -
1781 times.front())
1782 .count() /
1783 static_cast<double>(times.size() - 1),
1784 1.0, 0.1);
1785
1786 // Confirm that the ideal wakeup times increment correctly.
1787 for (size_t i = 1; i < expected_times.size(); ++i) {
1788 LOG(INFO) << i - 1 << ": " << expected_times[i - 1] << ", " << i << ": "
1789 << expected_times[i];
1790 EXPECT_EQ(expected_times[i], expected_times[i - 1] + chrono::seconds(1) -
1791 chrono::milliseconds(1));
1792 }
1793
1794 for (size_t i = 0; i < expected_times.size(); ++i) {
1795 EXPECT_EQ(expected_times[i].time_since_epoch() % chrono::seconds(1),
1796 kOffset - chrono::milliseconds(i));
1797 }
1798
1799 EXPECT_LT(expected_times[expected_times.size() / 2], average_time + kEpsilon);
1800 EXPECT_GT(expected_times[expected_times.size() / 2], average_time - kEpsilon);
1801}
1802
Austin Schuh39788ff2019-12-01 18:22:57 -08001803// Tests that senders count correctly in the timing report.
1804TEST_P(AbstractEventLoopTest, SenderTimingReport) {
1805 FLAGS_timing_report_ms = 1000;
1806 auto loop1 = MakePrimary();
1807
1808 auto loop2 = Make("watcher_loop");
1809 loop2->MakeWatcher("/test", [](const TestMessage &) {});
1810
1811 auto loop3 = Make();
1812
1813 Fetcher<timing::Report> report_fetcher =
1814 loop3->MakeFetcher<timing::Report>("/aos");
1815 EXPECT_FALSE(report_fetcher.Fetch());
1816
1817 auto sender = loop1->MakeSender<TestMessage>("/test");
1818
James Kuszmaul78514332022-04-06 15:08:34 -07001819 // Sanity check channel frequencies to ensure that we've designed the test
1820 // correctly.
1821 ASSERT_EQ(800, sender.channel()->frequency());
1822 ASSERT_EQ(2000000000, loop1->configuration()->channel_storage_duration());
1823 constexpr int kMaxAllowedMessages = 800 * 2;
1824 constexpr int kSendMessages = kMaxAllowedMessages * 2;
1825 constexpr int kDroppedMessages = kSendMessages - kMaxAllowedMessages;
1826
Austin Schuh39788ff2019-12-01 18:22:57 -08001827 // Add a timer to actually quit.
1828 auto test_timer = loop1->AddTimer([&sender]() {
James Kuszmaul78514332022-04-06 15:08:34 -07001829 for (int i = 0; i < kSendMessages; ++i) {
Austin Schuh39788ff2019-12-01 18:22:57 -08001830 aos::Sender<TestMessage>::Builder msg = sender.MakeBuilder();
1831 TestMessage::Builder builder = msg.MakeBuilder<TestMessage>();
1832 builder.add_value(200 + i);
James Kuszmaul78514332022-04-06 15:08:34 -07001833 if (i < kMaxAllowedMessages) {
1834 msg.CheckOk(msg.Send(builder.Finish()));
1835 } else {
1836 EXPECT_EQ(RawSender::Error::kMessagesSentTooFast,
1837 msg.Send(builder.Finish()));
1838 }
Austin Schuh39788ff2019-12-01 18:22:57 -08001839 }
1840 });
1841
1842 // Quit after 1 timing report, mid way through the next cycle.
1843 EndEventLoop(loop1.get(), chrono::milliseconds(2500));
1844
1845 loop1->OnRun([&test_timer, &loop1]() {
1846 test_timer->Setup(loop1->monotonic_now() + chrono::milliseconds(1500));
1847 });
1848
1849 Run();
1850
Austin Schuh6bae8252021-02-07 22:01:49 -08001851 if (do_timing_reports() == DoTimingReports::kYes) {
1852 // And, since we are here, check that the timing report makes sense.
1853 // Start by looking for our event loop's timing.
1854 FlatbufferDetachedBuffer<timing::Report> primary_report =
1855 FlatbufferDetachedBuffer<timing::Report>::Empty();
1856 while (report_fetcher.FetchNext()) {
Austin Schuh8902fa52021-03-14 22:39:24 -07001857 VLOG(1) << "Report " << FlatbufferToJson(report_fetcher.get());
Austin Schuh6bae8252021-02-07 22:01:49 -08001858 if (report_fetcher->name()->string_view() == "primary") {
1859 primary_report = CopyFlatBuffer(report_fetcher.get());
1860 }
Austin Schuh39788ff2019-12-01 18:22:57 -08001861 }
Austin Schuh6bae8252021-02-07 22:01:49 -08001862
Austin Schuh8902fa52021-03-14 22:39:24 -07001863 VLOG(1) << FlatbufferToJson(primary_report, {.multi_line = true});
Austin Schuh6bae8252021-02-07 22:01:49 -08001864
1865 EXPECT_EQ(primary_report.message().name()->string_view(), "primary");
1866
1867 ASSERT_NE(primary_report.message().senders(), nullptr);
1868 EXPECT_EQ(primary_report.message().senders()->size(), 3);
1869
1870 // Confirm that the sender looks sane.
1871 EXPECT_EQ(
1872 loop1->configuration()
1873 ->channels()
1874 ->Get(primary_report.message().senders()->Get(0)->channel_index())
1875 ->name()
1876 ->string_view(),
1877 "/test");
James Kuszmaul78514332022-04-06 15:08:34 -07001878 EXPECT_EQ(primary_report.message().senders()->Get(0)->count(),
1879 kMaxAllowedMessages);
1880 ASSERT_TRUE(primary_report.message().senders()->Get(0)->has_error_counts());
1881 ASSERT_EQ(
1882 primary_report.message().senders()->Get(0)->error_counts()->size(), 2u);
1883 EXPECT_EQ(
1884 primary_report.message()
1885 .senders()
1886 ->Get(0)
1887 ->error_counts()
1888 ->Get(static_cast<size_t>(timing::SendError::MESSAGE_SENT_TOO_FAST))
1889 ->count(),
1890 kDroppedMessages)
1891 << aos::FlatbufferToJson(primary_report);
1892 EXPECT_EQ(primary_report.message()
1893 .senders()
1894 ->Get(0)
1895 ->error_counts()
1896 ->Get(static_cast<size_t>(timing::SendError::INVALID_REDZONE))
1897 ->count(),
1898 0);
Austin Schuh6bae8252021-02-07 22:01:49 -08001899
1900 // Confirm that the timing primary_report sender looks sane.
1901 EXPECT_EQ(
1902 loop1->configuration()
1903 ->channels()
1904 ->Get(primary_report.message().senders()->Get(1)->channel_index())
1905 ->name()
1906 ->string_view(),
1907 "/aos");
1908 EXPECT_EQ(primary_report.message().senders()->Get(1)->count(), 1);
1909
1910 ASSERT_NE(primary_report.message().timers(), nullptr);
1911 EXPECT_EQ(primary_report.message().timers()->size(), 3);
1912
1913 // Make sure there are no phased loops or watchers.
1914 ASSERT_EQ(primary_report.message().phased_loops(), nullptr);
1915 ASSERT_EQ(primary_report.message().watchers(), nullptr);
1916 } else {
1917 ASSERT_FALSE(report_fetcher.Fetch());
Austin Schuh39788ff2019-12-01 18:22:57 -08001918 }
Austin Schuh39788ff2019-12-01 18:22:57 -08001919}
1920
James Kuszmaul93abac12022-04-14 15:05:10 -07001921// Tests that the RawSender::Send(void*, size_t) overload tracks things properly
1922// in its timing report.
1923TEST_P(AbstractEventLoopTest, CopySenderTimingReport) {
1924 gflags::FlagSaver flag_saver;
1925 FLAGS_timing_report_ms = 1000;
1926 auto loop1 = Make();
1927 auto loop2 = MakePrimary();
1928
1929 const FlatbufferDetachedBuffer<TestMessage> kMessage =
1930 JsonToFlatbuffer<TestMessage>("{}");
1931
1932 std::unique_ptr<aos::RawSender> sender =
1933 loop2->MakeRawSender(configuration::GetChannel(
1934 loop2->configuration(), "/test", "aos.TestMessage", "", nullptr));
1935
1936 Fetcher<timing::Report> report_fetcher =
1937 loop1->MakeFetcher<timing::Report>("/aos");
1938 EXPECT_FALSE(report_fetcher.Fetch());
1939
1940 loop2->OnRun([&]() {
1941 for (int ii = 0; ii < TestChannelQueueSize(loop2.get()); ++ii) {
1942 EXPECT_EQ(sender->Send(kMessage.span().data(), kMessage.span().size()),
1943 RawSender::Error::kOk);
1944 }
1945 EXPECT_EQ(sender->Send(kMessage.span().data(), kMessage.span().size()),
1946 RawSender::Error::kMessagesSentTooFast);
1947 });
1948 // Quit after 1 timing report, mid way through the next cycle.
1949 EndEventLoop(loop2.get(), chrono::milliseconds(1500));
1950
1951 Run();
1952
1953 if (do_timing_reports() == DoTimingReports::kYes) {
1954 // Check that the sent too fast actually got recorded by the timing report.
1955 FlatbufferDetachedBuffer<timing::Report> primary_report =
1956 FlatbufferDetachedBuffer<timing::Report>::Empty();
1957 while (report_fetcher.FetchNext()) {
1958 if (report_fetcher->name()->string_view() == "primary") {
1959 primary_report = CopyFlatBuffer(report_fetcher.get());
1960 }
1961 }
1962
1963 EXPECT_EQ(primary_report.message().name()->string_view(), "primary");
1964
1965 ASSERT_NE(primary_report.message().senders(), nullptr);
1966 EXPECT_EQ(primary_report.message().senders()->size(), 3);
1967 EXPECT_EQ(
1968 primary_report.message()
1969 .senders()
1970 ->Get(0)
1971 ->error_counts()
1972 ->Get(static_cast<size_t>(timing::SendError::MESSAGE_SENT_TOO_FAST))
1973 ->count(),
1974 1);
1975 }
1976}
1977
Austin Schuh39788ff2019-12-01 18:22:57 -08001978// Tests that senders count correctly in the timing report.
1979TEST_P(AbstractEventLoopTest, WatcherTimingReport) {
1980 FLAGS_timing_report_ms = 1000;
1981 auto loop1 = MakePrimary();
1982 loop1->MakeWatcher("/test", [](const TestMessage &) {});
1983
1984 auto loop2 = Make("sender_loop");
1985
1986 auto loop3 = Make();
1987
1988 Fetcher<timing::Report> report_fetcher =
1989 loop3->MakeFetcher<timing::Report>("/aos");
1990 EXPECT_FALSE(report_fetcher.Fetch());
1991
1992 auto sender = loop2->MakeSender<TestMessage>("/test");
1993
1994 // Add a timer to actually quit.
1995 auto test_timer = loop1->AddTimer([&sender]() {
1996 for (int i = 0; i < 10; ++i) {
1997 aos::Sender<TestMessage>::Builder msg = sender.MakeBuilder();
1998 TestMessage::Builder builder = msg.MakeBuilder<TestMessage>();
1999 builder.add_value(200 + i);
milind1f1dca32021-07-03 13:50:07 -07002000 msg.CheckOk(msg.Send(builder.Finish()));
Austin Schuh39788ff2019-12-01 18:22:57 -08002001 }
2002 });
2003
2004 // Quit after 1 timing report, mid way through the next cycle.
2005 EndEventLoop(loop1.get(), chrono::milliseconds(2500));
2006
2007 loop1->OnRun([&test_timer, &loop1]() {
2008 test_timer->Setup(loop1->monotonic_now() + chrono::milliseconds(1500));
2009 });
2010
2011 Run();
2012
Austin Schuh6bae8252021-02-07 22:01:49 -08002013 if (do_timing_reports() == DoTimingReports::kYes) {
2014 // And, since we are here, check that the timing report makes sense.
2015 // Start by looking for our event loop's timing.
2016 FlatbufferDetachedBuffer<timing::Report> primary_report =
2017 FlatbufferDetachedBuffer<timing::Report>::Empty();
2018 while (report_fetcher.FetchNext()) {
2019 LOG(INFO) << "Report " << FlatbufferToJson(report_fetcher.get());
2020 if (report_fetcher->name()->string_view() == "primary") {
2021 primary_report = CopyFlatBuffer(report_fetcher.get());
2022 }
Austin Schuh39788ff2019-12-01 18:22:57 -08002023 }
Austin Schuh6bae8252021-02-07 22:01:49 -08002024
2025 // Check the watcher report.
2026 VLOG(1) << FlatbufferToJson(primary_report, {.multi_line = true});
2027
2028 EXPECT_EQ(primary_report.message().name()->string_view(), "primary");
2029
2030 // Just the timing report timer.
2031 ASSERT_NE(primary_report.message().timers(), nullptr);
2032 EXPECT_EQ(primary_report.message().timers()->size(), 3);
2033
2034 // No phased loops
2035 ASSERT_EQ(primary_report.message().phased_loops(), nullptr);
2036
2037 ASSERT_NE(primary_report.message().watchers(), nullptr);
2038 ASSERT_EQ(primary_report.message().watchers()->size(), 1);
2039 EXPECT_EQ(primary_report.message().watchers()->Get(0)->count(), 10);
2040 } else {
2041 ASSERT_FALSE(report_fetcher.Fetch());
Austin Schuh39788ff2019-12-01 18:22:57 -08002042 }
Austin Schuh39788ff2019-12-01 18:22:57 -08002043}
2044
2045// Tests that fetchers count correctly in the timing report.
2046TEST_P(AbstractEventLoopTest, FetcherTimingReport) {
2047 FLAGS_timing_report_ms = 1000;
2048 auto loop1 = MakePrimary();
2049 auto loop2 = Make("sender_loop");
2050
2051 auto loop3 = Make();
2052
2053 Fetcher<timing::Report> report_fetcher =
2054 loop3->MakeFetcher<timing::Report>("/aos");
2055 EXPECT_FALSE(report_fetcher.Fetch());
2056
2057 auto sender = loop2->MakeSender<TestMessage>("/test");
2058 auto fetcher1 = loop1->MakeFetcher<TestMessage>("/test");
2059 auto fetcher2 = loop1->MakeFetcher<TestMessage>("/test");
2060 fetcher1.Fetch();
2061 fetcher2.Fetch();
2062
2063 // Add a timer to actually quit.
2064 auto test_timer = loop1->AddTimer([&sender]() {
2065 for (int i = 0; i < 10; ++i) {
2066 aos::Sender<TestMessage>::Builder msg = sender.MakeBuilder();
2067 TestMessage::Builder builder = msg.MakeBuilder<TestMessage>();
2068 builder.add_value(200 + i);
milind1f1dca32021-07-03 13:50:07 -07002069 msg.CheckOk(msg.Send(builder.Finish()));
Austin Schuh39788ff2019-12-01 18:22:57 -08002070 }
2071 });
2072
2073 auto test_timer2 = loop1->AddTimer([&fetcher1, &fetcher2]() {
2074 fetcher1.Fetch();
2075 while (fetcher2.FetchNext()) {
2076 }
2077 });
2078
2079 // Quit after 1 timing report, mid way through the next cycle.
2080 EndEventLoop(loop1.get(), chrono::milliseconds(2500));
2081
2082 loop1->OnRun([test_timer, test_timer2, &loop1]() {
2083 test_timer->Setup(loop1->monotonic_now() + chrono::milliseconds(1400));
2084 test_timer2->Setup(loop1->monotonic_now() + chrono::milliseconds(1600));
2085 });
2086
2087 Run();
2088
Austin Schuh6bae8252021-02-07 22:01:49 -08002089 if (do_timing_reports() == DoTimingReports::kYes) {
2090 // And, since we are here, check that the timing report makes sense.
2091 // Start by looking for our event loop's timing.
2092 FlatbufferDetachedBuffer<timing::Report> primary_report =
2093 FlatbufferDetachedBuffer<timing::Report>::Empty();
2094 while (report_fetcher.FetchNext()) {
2095 if (report_fetcher->name()->string_view() == "primary") {
2096 primary_report = CopyFlatBuffer(report_fetcher.get());
2097 }
Austin Schuh39788ff2019-12-01 18:22:57 -08002098 }
Austin Schuh6bae8252021-02-07 22:01:49 -08002099
2100 VLOG(1) << FlatbufferToJson(primary_report, {.multi_line = true});
2101
2102 EXPECT_EQ(primary_report.message().name()->string_view(), "primary");
2103
2104 ASSERT_NE(primary_report.message().senders(), nullptr);
2105 EXPECT_EQ(primary_report.message().senders()->size(), 2);
2106
2107 ASSERT_NE(primary_report.message().timers(), nullptr);
2108 EXPECT_EQ(primary_report.message().timers()->size(), 4);
2109
2110 // Make sure there are no phased loops or watchers.
2111 ASSERT_EQ(primary_report.message().phased_loops(), nullptr);
2112 ASSERT_EQ(primary_report.message().watchers(), nullptr);
2113
2114 // Now look at the fetchrs.
2115 ASSERT_NE(primary_report.message().fetchers(), nullptr);
2116 ASSERT_EQ(primary_report.message().fetchers()->size(), 2);
2117
2118 EXPECT_EQ(primary_report.message().fetchers()->Get(0)->count(), 1);
2119 EXPECT_GE(primary_report.message().fetchers()->Get(0)->latency()->average(),
2120 0.1);
2121 EXPECT_GE(primary_report.message().fetchers()->Get(0)->latency()->min(),
2122 0.1);
2123 EXPECT_GE(primary_report.message().fetchers()->Get(0)->latency()->max(),
2124 0.1);
2125 EXPECT_EQ(primary_report.message()
2126 .fetchers()
2127 ->Get(0)
2128 ->latency()
2129 ->standard_deviation(),
2130 0.0);
2131
2132 EXPECT_EQ(primary_report.message().fetchers()->Get(1)->count(), 10);
2133 } else {
2134 ASSERT_FALSE(report_fetcher.Fetch());
Austin Schuh39788ff2019-12-01 18:22:57 -08002135 }
Austin Schuh52d325c2019-06-23 18:59:06 -07002136}
2137
Austin Schuh67420a42019-12-21 21:55:04 -08002138// Tests that a raw watcher and raw fetcher can receive messages from a raw
2139// sender without messing up offsets.
2140TEST_P(AbstractEventLoopTest, RawBasic) {
2141 auto loop1 = Make();
2142 auto loop2 = MakePrimary();
2143 auto loop3 = Make();
2144
Austin Schuha9df9ad2021-06-16 14:49:39 -07002145 const FlatbufferDetachedBuffer<TestMessage> kMessage =
2146 JsonToFlatbuffer<TestMessage>("{}");
Austin Schuh67420a42019-12-21 21:55:04 -08002147
2148 std::unique_ptr<aos::RawSender> sender =
Tyler Chatow67ddb032020-01-12 14:30:04 -08002149 loop1->MakeRawSender(configuration::GetChannel(
2150 loop1->configuration(), "/test", "aos.TestMessage", "", nullptr));
Austin Schuh67420a42019-12-21 21:55:04 -08002151
2152 std::unique_ptr<aos::RawFetcher> fetcher =
Tyler Chatow67ddb032020-01-12 14:30:04 -08002153 loop3->MakeRawFetcher(configuration::GetChannel(
2154 loop3->configuration(), "/test", "aos.TestMessage", "", nullptr));
Austin Schuh67420a42019-12-21 21:55:04 -08002155
Austin Schuha9df9ad2021-06-16 14:49:39 -07002156 loop2->OnRun([&]() {
milind1f1dca32021-07-03 13:50:07 -07002157 EXPECT_EQ(sender->Send(kMessage.span().data(), kMessage.span().size()),
2158 RawSender::Error::kOk);
Austin Schuha9df9ad2021-06-16 14:49:39 -07002159 });
Austin Schuh67420a42019-12-21 21:55:04 -08002160
2161 bool happened = false;
2162 loop2->MakeRawWatcher(
Tyler Chatow67ddb032020-01-12 14:30:04 -08002163 configuration::GetChannel(loop2->configuration(), "/test",
2164 "aos.TestMessage", "", nullptr),
Austin Schuha9df9ad2021-06-16 14:49:39 -07002165 [this, &kMessage, &fetcher, &happened](const Context &context,
2166 const void *message) {
Austin Schuh67420a42019-12-21 21:55:04 -08002167 happened = true;
Austin Schuha9df9ad2021-06-16 14:49:39 -07002168 EXPECT_EQ(
2169 kMessage.span(),
2170 absl::Span<const uint8_t>(
2171 reinterpret_cast<const uint8_t *>(message), context.size));
2172 EXPECT_EQ(message, context.data);
Austin Schuh67420a42019-12-21 21:55:04 -08002173
2174 ASSERT_TRUE(fetcher->Fetch());
2175
Austin Schuha9df9ad2021-06-16 14:49:39 -07002176 EXPECT_EQ(kMessage.span(),
2177 absl::Span<const uint8_t>(reinterpret_cast<const uint8_t *>(
2178 fetcher->context().data),
2179 fetcher->context().size));
Austin Schuh67420a42019-12-21 21:55:04 -08002180
2181 this->Exit();
2182 });
2183
2184 EXPECT_FALSE(happened);
2185 Run();
2186 EXPECT_TRUE(happened);
2187}
2188
Austin Schuhad154822019-12-27 15:45:13 -08002189// Tests that a raw watcher and raw fetcher can receive messages from a raw
Brian Silvermanbf889922021-11-10 12:41:57 -08002190// sender without messing up offsets, using the RawSpan overload.
2191TEST_P(AbstractEventLoopTest, RawBasicSharedSpan) {
2192 auto loop1 = Make();
2193 auto loop2 = MakePrimary();
2194 auto loop3 = Make();
2195
2196 const FlatbufferDetachedBuffer<TestMessage> kMessage =
2197 JsonToFlatbuffer<TestMessage>("{}");
2198
2199 std::unique_ptr<aos::RawSender> sender =
2200 loop1->MakeRawSender(configuration::GetChannel(
2201 loop1->configuration(), "/test", "aos.TestMessage", "", nullptr));
2202
2203 std::unique_ptr<aos::RawFetcher> fetcher =
2204 loop3->MakeRawFetcher(configuration::GetChannel(
2205 loop3->configuration(), "/test", "aos.TestMessage", "", nullptr));
2206
2207 loop2->OnRun([&]() {
milind1f1dca32021-07-03 13:50:07 -07002208 EXPECT_EQ(sender->Send(std::make_shared<absl::Span<const uint8_t>>(
2209 kMessage.span().data(), kMessage.span().size())),
2210 RawSender::Error::kOk);
Brian Silvermanbf889922021-11-10 12:41:57 -08002211 });
2212
2213 bool happened = false;
2214 loop2->MakeRawWatcher(
2215 configuration::GetChannel(loop2->configuration(), "/test",
2216 "aos.TestMessage", "", nullptr),
2217 [this, &kMessage, &fetcher, &happened](const Context &context,
2218 const void *message) {
2219 happened = true;
2220 EXPECT_EQ(
2221 kMessage.span(),
2222 absl::Span<const uint8_t>(
2223 reinterpret_cast<const uint8_t *>(message), context.size));
2224 EXPECT_EQ(message, context.data);
2225
2226 ASSERT_TRUE(fetcher->Fetch());
2227
2228 EXPECT_EQ(kMessage.span(),
2229 absl::Span<const uint8_t>(reinterpret_cast<const uint8_t *>(
2230 fetcher->context().data),
2231 fetcher->context().size));
2232
2233 this->Exit();
2234 });
2235
2236 EXPECT_FALSE(happened);
2237 Run();
2238 EXPECT_TRUE(happened);
2239}
2240
2241// Tests that a raw watcher and raw fetcher can receive messages from a raw
Austin Schuhad154822019-12-27 15:45:13 -08002242// sender with remote times filled out.
2243TEST_P(AbstractEventLoopTest, RawRemoteTimes) {
2244 auto loop1 = Make();
2245 auto loop2 = MakePrimary();
2246 auto loop3 = Make();
2247
Austin Schuha9df9ad2021-06-16 14:49:39 -07002248 const FlatbufferDetachedBuffer<TestMessage> kMessage =
2249 JsonToFlatbuffer<TestMessage>("{}");
Austin Schuhad154822019-12-27 15:45:13 -08002250
2251 const aos::monotonic_clock::time_point monotonic_remote_time =
2252 aos::monotonic_clock::time_point(chrono::seconds(1501));
2253 const aos::realtime_clock::time_point realtime_remote_time =
2254 aos::realtime_clock::time_point(chrono::seconds(3132));
Austin Schuhb5c6f972021-03-14 21:53:07 -07002255 const uint32_t remote_queue_index = 0x254971;
Austin Schuha9012be2021-07-21 15:19:11 -07002256 const UUID source_boot_uuid = UUID::Random();
Austin Schuhad154822019-12-27 15:45:13 -08002257
2258 std::unique_ptr<aos::RawSender> sender =
Tyler Chatow67ddb032020-01-12 14:30:04 -08002259 loop1->MakeRawSender(configuration::GetChannel(
2260 loop1->configuration(), "/test", "aos.TestMessage", "", nullptr));
Austin Schuhad154822019-12-27 15:45:13 -08002261
2262 std::unique_ptr<aos::RawFetcher> fetcher =
Tyler Chatow67ddb032020-01-12 14:30:04 -08002263 loop3->MakeRawFetcher(configuration::GetChannel(
2264 loop3->configuration(), "/test", "aos.TestMessage", "", nullptr));
Austin Schuhad154822019-12-27 15:45:13 -08002265
2266 loop2->OnRun([&]() {
milind1f1dca32021-07-03 13:50:07 -07002267 EXPECT_EQ(sender->Send(kMessage.span().data(), kMessage.span().size(),
2268 monotonic_remote_time, realtime_remote_time,
2269 remote_queue_index, source_boot_uuid),
2270 RawSender::Error::kOk);
Austin Schuhad154822019-12-27 15:45:13 -08002271 });
2272
2273 bool happened = false;
2274 loop2->MakeRawWatcher(
Tyler Chatow67ddb032020-01-12 14:30:04 -08002275 configuration::GetChannel(loop2->configuration(), "/test",
2276 "aos.TestMessage", "", nullptr),
Austin Schuha9012be2021-07-21 15:19:11 -07002277 [this, monotonic_remote_time, realtime_remote_time, source_boot_uuid,
Austin Schuhb5c6f972021-03-14 21:53:07 -07002278 remote_queue_index, &fetcher,
2279 &happened](const Context &context, const void * /*message*/) {
Austin Schuhad154822019-12-27 15:45:13 -08002280 happened = true;
2281 EXPECT_EQ(monotonic_remote_time, context.monotonic_remote_time);
2282 EXPECT_EQ(realtime_remote_time, context.realtime_remote_time);
Austin Schuha9012be2021-07-21 15:19:11 -07002283 EXPECT_EQ(source_boot_uuid, context.source_boot_uuid);
Austin Schuhb5c6f972021-03-14 21:53:07 -07002284 EXPECT_EQ(remote_queue_index, context.remote_queue_index);
Austin Schuhad154822019-12-27 15:45:13 -08002285
2286 ASSERT_TRUE(fetcher->Fetch());
2287 EXPECT_EQ(monotonic_remote_time,
2288 fetcher->context().monotonic_remote_time);
2289 EXPECT_EQ(realtime_remote_time,
2290 fetcher->context().realtime_remote_time);
2291
2292 this->Exit();
2293 });
2294
2295 EXPECT_FALSE(happened);
2296 Run();
2297 EXPECT_TRUE(happened);
2298}
2299
2300// Tests that a raw sender fills out sent data.
2301TEST_P(AbstractEventLoopTest, RawSenderSentData) {
2302 auto loop1 = MakePrimary();
2303
Austin Schuha9df9ad2021-06-16 14:49:39 -07002304 const FlatbufferDetachedBuffer<TestMessage> kMessage =
2305 JsonToFlatbuffer<TestMessage>("{}");
Austin Schuhad154822019-12-27 15:45:13 -08002306
2307 std::unique_ptr<aos::RawSender> sender =
Tyler Chatow67ddb032020-01-12 14:30:04 -08002308 loop1->MakeRawSender(configuration::GetChannel(
2309 loop1->configuration(), "/test", "aos.TestMessage", "", nullptr));
Austin Schuhad154822019-12-27 15:45:13 -08002310
Tyler Chatow67ddb032020-01-12 14:30:04 -08002311 const aos::monotonic_clock::time_point monotonic_now = loop1->monotonic_now();
2312 const aos::realtime_clock::time_point realtime_now = loop1->realtime_now();
Austin Schuhad154822019-12-27 15:45:13 -08002313
milind1f1dca32021-07-03 13:50:07 -07002314 EXPECT_EQ(sender->Send(kMessage.span().data(), kMessage.span().size()),
2315 RawSender::Error::kOk);
Austin Schuhad154822019-12-27 15:45:13 -08002316
2317 EXPECT_GE(sender->monotonic_sent_time(), monotonic_now);
2318 EXPECT_LE(sender->monotonic_sent_time(),
2319 monotonic_now + chrono::milliseconds(100));
2320 EXPECT_GE(sender->realtime_sent_time(), realtime_now);
2321 EXPECT_LE(sender->realtime_sent_time(),
2322 realtime_now + chrono::milliseconds(100));
2323 EXPECT_EQ(sender->sent_queue_index(), 0u);
2324
milind1f1dca32021-07-03 13:50:07 -07002325 EXPECT_EQ(sender->Send(kMessage.span().data(), kMessage.span().size()),
2326 RawSender::Error::kOk);
Austin Schuhad154822019-12-27 15:45:13 -08002327
2328 EXPECT_GE(sender->monotonic_sent_time(), monotonic_now);
2329 EXPECT_LE(sender->monotonic_sent_time(),
2330 monotonic_now + chrono::milliseconds(100));
2331 EXPECT_GE(sender->realtime_sent_time(), realtime_now);
2332 EXPECT_LE(sender->realtime_sent_time(),
2333 realtime_now + chrono::milliseconds(100));
2334 EXPECT_EQ(sender->sent_queue_index(), 1u);
2335}
2336
Austin Schuh217a9782019-12-21 23:02:50 -08002337// Tests that not setting up nodes results in no node.
2338TEST_P(AbstractEventLoopTest, NoNode) {
2339 auto loop1 = Make();
2340 auto loop2 = MakePrimary();
2341
2342 EXPECT_EQ(loop1->node(), nullptr);
2343 EXPECT_EQ(loop2->node(), nullptr);
2344}
2345
2346// Tests that setting up nodes results in node being set.
2347TEST_P(AbstractEventLoopTest, Node) {
2348 EnableNodes("me");
2349
2350 auto loop1 = Make();
2351 auto loop2 = MakePrimary();
2352
2353 EXPECT_NE(loop1->node(), nullptr);
2354 EXPECT_NE(loop2->node(), nullptr);
2355}
2356
2357// Tests that watchers work with a node setup.
2358TEST_P(AbstractEventLoopTest, NodeWatcher) {
2359 EnableNodes("me");
2360
2361 auto loop1 = Make();
2362 auto loop2 = Make();
2363 loop1->MakeWatcher("/test", [](const TestMessage &) {});
Tyler Chatow67ddb032020-01-12 14:30:04 -08002364 loop2->MakeRawWatcher(
2365 configuration::GetChannel(configuration(), "/test", "aos.TestMessage", "",
2366 nullptr),
2367 [](const Context &, const void *) {});
Austin Schuh217a9782019-12-21 23:02:50 -08002368}
2369
Brian Silverman454bc112020-03-05 14:21:25 -08002370// Tests that no-arg watchers work with a node setup.
2371TEST_P(AbstractEventLoopTest, NodeNoArgWatcher) {
2372 EnableNodes("me");
2373
2374 auto loop1 = Make();
2375 auto loop2 = Make();
2376 loop1->MakeWatcher("/test", [](const TestMessage &) {});
2377 loop2->MakeRawNoArgWatcher(
2378 configuration::GetChannel(configuration(), "/test", "aos.TestMessage", "",
2379 nullptr),
2380 [](const Context &) {});
2381}
2382
Austin Schuh217a9782019-12-21 23:02:50 -08002383// Tests that fetcher work with a node setup.
2384TEST_P(AbstractEventLoopTest, NodeFetcher) {
2385 EnableNodes("me");
2386 auto loop1 = Make();
2387
2388 auto fetcher = loop1->MakeFetcher<TestMessage>("/test");
Tyler Chatow67ddb032020-01-12 14:30:04 -08002389 auto raw_fetcher = loop1->MakeRawFetcher(configuration::GetChannel(
2390 configuration(), "/test", "aos.TestMessage", "", nullptr));
Austin Schuh217a9782019-12-21 23:02:50 -08002391}
2392
2393// Tests that sender work with a node setup.
2394TEST_P(AbstractEventLoopTest, NodeSender) {
2395 EnableNodes("me");
2396 auto loop1 = Make();
2397
2398 aos::Sender<TestMessage> sender = loop1->MakeSender<TestMessage>("/test");
2399}
2400
Austin Schuhcc6070c2020-10-10 20:25:56 -07002401// Tests that a non-realtime event loop timer is marked non-realtime.
2402TEST_P(AbstractEventLoopTest, NonRealtimeEventLoopTimer) {
2403 auto loop1 = MakePrimary();
2404
2405 // Add a timer to actually quit.
2406 auto test_timer = loop1->AddTimer([this]() {
2407 CheckNotRealtime();
2408 this->Exit();
2409 });
2410
2411 loop1->OnRun([&test_timer, &loop1]() {
2412 CheckNotRealtime();
2413 test_timer->Setup(loop1->monotonic_now(), ::std::chrono::milliseconds(100));
2414 });
2415
2416 Run();
2417}
2418
2419// Tests that a realtime event loop timer is marked realtime.
2420TEST_P(AbstractEventLoopTest, RealtimeEventLoopTimer) {
2421 auto loop1 = MakePrimary();
2422
2423 loop1->SetRuntimeRealtimePriority(1);
2424
2425 // Add a timer to actually quit.
2426 auto test_timer = loop1->AddTimer([this]() {
2427 CheckRealtime();
2428 this->Exit();
2429 });
2430
2431 loop1->OnRun([&test_timer, &loop1]() {
2432 CheckRealtime();
2433 test_timer->Setup(loop1->monotonic_now(), ::std::chrono::milliseconds(100));
2434 });
2435
2436 Run();
2437}
2438
2439// Tests that a non-realtime event loop phased loop is marked non-realtime.
2440TEST_P(AbstractEventLoopTest, NonRealtimeEventLoopPhasedLoop) {
2441 auto loop1 = MakePrimary();
2442
2443 // Add a timer to actually quit.
2444 loop1->AddPhasedLoop(
2445 [this](int) {
2446 CheckNotRealtime();
2447 this->Exit();
2448 },
2449 chrono::seconds(1), chrono::seconds(0));
2450
2451 Run();
2452}
2453
2454// Tests that a realtime event loop phased loop is marked realtime.
2455TEST_P(AbstractEventLoopTest, RealtimeEventLoopPhasedLoop) {
2456 auto loop1 = MakePrimary();
2457
2458 loop1->SetRuntimeRealtimePriority(1);
2459
2460 // Add a timer to actually quit.
2461 loop1->AddPhasedLoop(
2462 [this](int) {
2463 CheckRealtime();
2464 this->Exit();
2465 },
2466 chrono::seconds(1), chrono::seconds(0));
2467
2468 Run();
2469}
2470
2471// Tests that a non-realtime event loop watcher is marked non-realtime.
2472TEST_P(AbstractEventLoopTest, NonRealtimeEventLoopWatcher) {
2473 auto loop1 = MakePrimary();
2474 auto loop2 = Make();
2475
2476 aos::Sender<TestMessage> sender = loop2->MakeSender<TestMessage>("/test");
2477
2478 loop1->OnRun([&]() {
2479 aos::Sender<TestMessage>::Builder msg = sender.MakeBuilder();
2480 TestMessage::Builder builder = msg.MakeBuilder<TestMessage>();
milind1f1dca32021-07-03 13:50:07 -07002481 msg.CheckOk(msg.Send(builder.Finish()));
Austin Schuhcc6070c2020-10-10 20:25:56 -07002482 });
2483
2484 loop1->MakeWatcher("/test", [&](const TestMessage &) {
2485 CheckNotRealtime();
2486 this->Exit();
2487 });
2488
2489 Run();
2490}
2491
2492// Tests that a realtime event loop watcher is marked realtime.
2493TEST_P(AbstractEventLoopTest, RealtimeEventLoopWatcher) {
2494 auto loop1 = MakePrimary();
2495 auto loop2 = Make();
2496
2497 loop1->SetRuntimeRealtimePriority(1);
2498
2499 aos::Sender<TestMessage> sender = loop2->MakeSender<TestMessage>("/test");
2500
2501 loop1->OnRun([&]() {
2502 aos::Sender<TestMessage>::Builder msg = sender.MakeBuilder();
2503 TestMessage::Builder builder = msg.MakeBuilder<TestMessage>();
milind1f1dca32021-07-03 13:50:07 -07002504 msg.CheckOk(msg.Send(builder.Finish()));
Austin Schuhcc6070c2020-10-10 20:25:56 -07002505 });
2506
2507 loop1->MakeWatcher("/test", [&](const TestMessage &) {
2508 CheckRealtime();
2509 this->Exit();
2510 });
2511
2512 Run();
2513}
2514
Austin Schuha9012be2021-07-21 15:19:11 -07002515// Tests that event loop's context's monotonic time is set to a value on OnRun.
2516TEST_P(AbstractEventLoopTest, SetContextOnRun) {
2517 auto loop = MakePrimary();
2518
2519 // We want to check that monotonic event time is before monotonic now
2520 // called inside of callback, but after time point obtained callback.
2521 aos::monotonic_clock::time_point monotonic_event_time_on_run;
2522
2523 loop->OnRun([&]() {
2524 monotonic_event_time_on_run = loop->context().monotonic_event_time;
2525 EXPECT_LE(monotonic_event_time_on_run, loop->monotonic_now());
2526 EXPECT_EQ(loop->context().monotonic_remote_time, monotonic_clock::min_time);
2527 EXPECT_EQ(loop->context().realtime_event_time, realtime_clock::min_time);
2528 EXPECT_EQ(loop->context().realtime_remote_time, realtime_clock::min_time);
2529 EXPECT_EQ(loop->context().source_boot_uuid, loop->boot_uuid());
2530 EXPECT_EQ(loop->context().queue_index, 0xffffffffu);
2531 EXPECT_EQ(loop->context().size, 0u);
2532 EXPECT_EQ(loop->context().data, nullptr);
2533 EXPECT_EQ(loop->context().buffer_index, -1);
2534 });
2535
2536 EndEventLoop(loop.get(), ::std::chrono::milliseconds(200));
2537
2538 const aos::monotonic_clock::time_point before_run_time =
2539 loop->monotonic_now();
2540 Run();
2541 EXPECT_GE(monotonic_event_time_on_run, before_run_time);
2542}
2543
Austin Schuh217a9782019-12-21 23:02:50 -08002544// Tests that watchers fail when created on the wrong node.
2545TEST_P(AbstractEventLoopDeathTest, NodeWatcher) {
2546 EnableNodes("them");
2547
2548 auto loop1 = Make();
2549 auto loop2 = Make();
2550 EXPECT_DEATH({ loop1->MakeWatcher("/test", [](const TestMessage &) {}); },
2551 "node");
2552 EXPECT_DEATH(
2553 {
Tyler Chatow67ddb032020-01-12 14:30:04 -08002554 loop2->MakeRawWatcher(
2555 configuration::GetChannel(configuration(), "/test",
2556 "aos.TestMessage", "", nullptr),
2557 [](const Context &, const void *) {});
Austin Schuh217a9782019-12-21 23:02:50 -08002558 },
2559 "node");
Brian Silverman454bc112020-03-05 14:21:25 -08002560 EXPECT_DEATH({ loop1->MakeNoArgWatcher<TestMessage>("/test", []() {}); },
2561 "node");
2562 EXPECT_DEATH(
2563 {
2564 loop2->MakeRawNoArgWatcher(
2565 configuration::GetChannel(configuration(), "/test",
2566 "aos.TestMessage", "", nullptr),
2567 [](const Context &) {});
2568 },
2569 "node");
Austin Schuh217a9782019-12-21 23:02:50 -08002570}
2571
2572// Tests that fetchers fail when created on the wrong node.
2573TEST_P(AbstractEventLoopDeathTest, NodeFetcher) {
2574 EnableNodes("them");
2575 auto loop1 = Make();
2576
2577 EXPECT_DEATH({ auto fetcher = loop1->MakeFetcher<TestMessage>("/test"); },
2578 "node");
2579 EXPECT_DEATH(
2580 {
Tyler Chatow67ddb032020-01-12 14:30:04 -08002581 auto raw_fetcher = loop1->MakeRawFetcher(configuration::GetChannel(
2582 configuration(), "/test", "aos.TestMessage", "", nullptr));
Austin Schuh217a9782019-12-21 23:02:50 -08002583 },
2584 "node");
2585}
2586
2587// Tests that senders fail when created on the wrong node.
2588TEST_P(AbstractEventLoopDeathTest, NodeSender) {
2589 EnableNodes("them");
2590 auto loop1 = Make();
2591
2592 EXPECT_DEATH(
2593 {
2594 aos::Sender<TestMessage> sender =
2595 loop1->MakeSender<TestMessage>("/test");
2596 },
2597 "node");
2598
2599 // Note: Creating raw senders is always supported. Right now, this lets us
2600 // use them to create message_gateway.
2601}
2602
Brian Silverman341b57e2020-06-23 16:23:18 -07002603// Tests creating multiple Builders from a single Sender at the same time.
2604TEST_P(AbstractEventLoopDeathTest, MultipleBuilders) {
2605 auto loop1 = Make();
2606 aos::Sender<TestMessage> sender = loop1->MakeSender<TestMessage>("/test");
2607
2608 { auto builder = sender.MakeBuilder(); }
2609 {
2610 auto builder = sender.MakeBuilder();
2611 builder.MakeBuilder<TestMessage>().Finish();
2612 }
2613 {
2614 // Creating this after the first one was destroyed should be fine.
2615 auto builder = sender.MakeBuilder();
2616 builder.MakeBuilder<TestMessage>().Finish();
2617 // But not a second one.
2618 EXPECT_DEATH(sender.MakeBuilder().MakeBuilder<TestMessage>().Finish(),
2619 "May not overwrite in-use allocator");
2620 }
2621
2622 FlatbufferDetachedBuffer<TestMessage> detached =
2623 flatbuffers::DetachedBuffer();
2624 {
2625 auto builder = sender.MakeBuilder();
2626 detached = builder.Detach(builder.MakeBuilder<TestMessage>().Finish());
2627 }
2628 {
2629 // This is the second one, after the detached one, so it should fail.
2630 EXPECT_DEATH(sender.MakeBuilder().MakeBuilder<TestMessage>().Finish(),
2631 "May not overwrite in-use allocator");
2632 }
2633
2634 // Clear the detached one, and then we should be able to create another.
2635 detached = flatbuffers::DetachedBuffer();
2636 {
2637 auto builder = sender.MakeBuilder();
2638 builder.MakeBuilder<TestMessage>().Finish();
2639 }
2640
2641 // And then detach another one.
2642 {
2643 auto builder = sender.MakeBuilder();
2644 detached = builder.Detach(builder.MakeBuilder<TestMessage>().Finish());
2645 }
2646}
2647
2648// Tests sending a buffer detached from a different builder.
2649TEST_P(AbstractEventLoopDeathTest, WrongDetachedBuffer) {
2650 auto loop1 = Make();
2651 aos::Sender<TestMessage> sender1 = loop1->MakeSender<TestMessage>("/test");
2652 aos::Sender<TestMessage> sender2 = loop1->MakeSender<TestMessage>("/test");
2653
2654 auto builder = sender1.MakeBuilder();
2655 FlatbufferDetachedBuffer<TestMessage> detached =
2656 builder.Detach(builder.MakeBuilder<TestMessage>().Finish());
milind1f1dca32021-07-03 13:50:07 -07002657 EXPECT_DEATH(sender2.CheckOk(sender2.SendDetached(std::move(detached))),
Brian Silverman341b57e2020-06-23 16:23:18 -07002658 "May only send the buffer detached from this Sender");
2659}
2660
Eric Schmiedebergef44b8a2022-02-28 17:30:38 -07002661int TestChannelFrequency(EventLoop *event_loop) {
2662 return event_loop->GetChannel<TestMessage>("/test")->frequency();
2663}
2664
2665int TestChannelQueueSize(EventLoop *event_loop) {
2666 const int frequency = TestChannelFrequency(event_loop);
2667 const auto channel_storage_duration = std::chrono::nanoseconds(
2668 event_loop->configuration()->channel_storage_duration());
2669 const int queue_size =
2670 frequency * std::chrono::duration_cast<std::chrono::duration<double>>(
2671 channel_storage_duration)
2672 .count();
2673
2674 return queue_size;
2675}
2676
2677RawSender::Error SendTestMessage(aos::Sender<TestMessage> &sender) {
2678 aos::Sender<TestMessage>::Builder builder = sender.MakeBuilder();
2679 TestMessage::Builder test_message_builder =
2680 builder.MakeBuilder<TestMessage>();
2681 test_message_builder.add_value(0);
2682 return builder.Send(test_message_builder.Finish());
2683}
2684
2685// Test that sending messages too fast returns
2686// RawSender::Error::kMessagesSentTooFast.
2687TEST_P(AbstractEventLoopTest, SendingMessagesTooFast) {
2688 auto event_loop = MakePrimary();
2689
2690 auto sender = event_loop->MakeSender<TestMessage>("/test");
2691
2692 // Send one message in the beginning, then wait until the
2693 // channel_storage_duration is almost done and start sending messages rapidly,
2694 // having some come in the next chanel_storage_duration. The queue_size is
2695 // 1600, so the 1601st message will be the last valid one (the initial message
2696 // having being sent more than a channel_storage_duration ago), and trying to
2697 // send the 1602nd message should return
2698 // RawSender::Error::kMessagesSentTooFast.
2699 EXPECT_EQ(SendTestMessage(sender), RawSender::Error::kOk);
2700 int msgs_sent = 1;
2701 const int queue_size = TestChannelQueueSize(event_loop.get());
2702
2703 const auto timer = event_loop->AddTimer([&]() {
2704 const bool done = (msgs_sent == queue_size + 1);
2705 ASSERT_EQ(
2706 SendTestMessage(sender),
2707 done ? RawSender::Error::kMessagesSentTooFast : RawSender::Error::kOk);
2708 msgs_sent++;
2709 if (done) {
2710 Exit();
2711 }
2712 });
2713
2714 const auto kRepeatOffset = std::chrono::milliseconds(1);
2715 const auto base_offset =
2716 std::chrono::nanoseconds(
2717 event_loop->configuration()->channel_storage_duration()) -
2718 (kRepeatOffset * (queue_size / 2));
2719 event_loop->OnRun([&event_loop, &timer, &base_offset, &kRepeatOffset]() {
2720 timer->Setup(event_loop->monotonic_now() + base_offset, kRepeatOffset);
2721 });
2722
2723 Run();
2724}
2725
2726// Tests that we are able to send messages successfully after sending messages
2727// too fast and waiting while continuously attempting to send messages.
2728// Also tests that SendFailureCounter is working correctly in this
2729// situation
2730TEST_P(AbstractEventLoopTest, SendingAfterSendingTooFast) {
2731 auto event_loop = MakePrimary();
2732
2733 auto sender = event_loop->MakeSender<TestMessage>("/test");
2734
2735 // We are sending messages at 1 kHz, so we will be sending too fast after
2736 // queue_size (1600) ms. After this, keep sending messages, and exactly a
2737 // channel storage duration (2s) after we send the first message we should
2738 // be able to successfully send a message.
2739
2740 const monotonic_clock::duration kInterval = std::chrono::milliseconds(1);
2741 const monotonic_clock::duration channel_storage_duration =
2742 std::chrono::nanoseconds(
2743 event_loop->configuration()->channel_storage_duration());
2744 const int queue_size = TestChannelQueueSize(event_loop.get());
2745
2746 int msgs_sent = 0;
2747 SendFailureCounter counter;
2748 auto start = monotonic_clock::min_time;
2749
2750 event_loop->AddPhasedLoop(
2751 [&](int) {
2752 const auto actual_err = SendTestMessage(sender);
2753 const bool done_waiting = (start != monotonic_clock::min_time &&
2754 sender.monotonic_sent_time() >=
2755 (start + channel_storage_duration));
2756 const auto expected_err =
2757 (msgs_sent < queue_size || done_waiting
2758 ? RawSender::Error::kOk
2759 : RawSender::Error::kMessagesSentTooFast);
2760
2761 if (start == monotonic_clock::min_time) {
2762 start = sender.monotonic_sent_time();
2763 }
2764
2765 ASSERT_EQ(actual_err, expected_err);
2766 counter.Count(actual_err);
2767 msgs_sent++;
2768
2769 EXPECT_EQ(counter.failures(),
2770 msgs_sent <= queue_size
2771 ? 0
2772 : (msgs_sent - queue_size) -
2773 (actual_err == RawSender::Error::kOk ? 1 : 0));
2774 EXPECT_EQ(counter.just_failed(), actual_err != RawSender::Error::kOk);
2775
2776 if (done_waiting) {
2777 Exit();
2778 }
2779 },
2780 kInterval);
2781 Run();
2782}
2783
2784// Tests that RawSender::Error::kMessagesSentTooFast is returned
2785// when messages are sent too fast from senders in different loops
2786TEST_P(AbstractEventLoopTest, SendingTooFastWithMultipleLoops) {
2787 auto loop1 = MakePrimary();
2788 auto loop2 = Make();
2789
2790 auto sender1 = loop1->MakeSender<TestMessage>("/test");
2791 auto sender2 = loop2->MakeSender<TestMessage>("/test");
2792
2793 // Send queue_size messages split between the senders.
2794 const int queue_size = TestChannelQueueSize(loop1.get());
2795 for (int i = 0; i < queue_size / 2; i++) {
2796 ASSERT_EQ(SendTestMessage(sender1), RawSender::Error::kOk);
2797 ASSERT_EQ(SendTestMessage(sender2), RawSender::Error::kOk);
2798 }
2799
2800 // Since queue_size messages have been sent, this should return an error
2801 EXPECT_EQ(SendTestMessage(sender2), RawSender::Error::kMessagesSentTooFast);
2802}
2803
Parker Schuhe4a70d62017-12-27 20:10:20 -08002804} // namespace testing
2805} // namespace aos