blob: c218df6a4ebc489a9a081b640b017f9d23578248 [file] [log] [blame]
Alex Perrycb7da4b2019-08-28 19:35:56 -07001#include "aos/events/simulated_event_loop.h"
2
3#include <algorithm>
4#include <deque>
milind1f1dca32021-07-03 13:50:07 -07005#include <optional>
6#include <queue>
Austin Schuh5f1cc5c2019-12-01 18:01:11 -08007#include <string_view>
Brian Silverman661eb8d2020-08-12 19:41:01 -07008#include <vector>
Alex Perrycb7da4b2019-08-28 19:35:56 -07009
10#include "absl/container/btree_map.h"
Brian Silverman661eb8d2020-08-12 19:41:01 -070011#include "aos/events/aos_logging.h"
Austin Schuh898f4972020-01-11 17:21:25 -080012#include "aos/events/simulated_network_bridge.h"
Austin Schuh094d09b2020-11-20 23:26:52 -080013#include "aos/init.h"
Alex Perrycb7da4b2019-08-28 19:35:56 -070014#include "aos/json_to_flatbuffer.h"
Austin Schuhcc6070c2020-10-10 20:25:56 -070015#include "aos/realtime.h"
Alex Perrycb7da4b2019-08-28 19:35:56 -070016#include "aos/util/phased_loop.h"
17
Austin Schuh9b1d6282022-06-10 17:03:21 -070018// TODO(austin): If someone runs a SimulatedEventLoop on a RT thread with
19// die_on_malloc set, it won't die. Really, we need to go RT, or fall back to
20// the base thread's original RT state to be actually accurate.
21
Alex Perrycb7da4b2019-08-28 19:35:56 -070022namespace aos {
23
Brian Silverman661eb8d2020-08-12 19:41:01 -070024class SimulatedEventLoop;
25class SimulatedFetcher;
26class SimulatedChannel;
27
James Kuszmaul890c2492022-04-06 14:59:31 -070028using CheckSentTooFast = NodeEventLoopFactory::CheckSentTooFast;
29using ExclusiveSenders = NodeEventLoopFactory::ExclusiveSenders;
30using EventLoopOptions = NodeEventLoopFactory::EventLoopOptions;
31
Brian Silverman661eb8d2020-08-12 19:41:01 -070032namespace {
33
Austin Schuh057d29f2021-08-21 23:05:15 -070034std::string NodeName(const Node *node) {
35 if (node == nullptr) {
36 return "";
37 }
38
39 return absl::StrCat(node->name()->string_view(), " ");
40}
41
Austin Schuhcc6070c2020-10-10 20:25:56 -070042class ScopedMarkRealtimeRestorer {
43 public:
44 ScopedMarkRealtimeRestorer(bool rt) : rt_(rt), prior_(MarkRealtime(rt)) {}
45 ~ScopedMarkRealtimeRestorer() { CHECK_EQ(rt_, MarkRealtime(prior_)); }
46
47 private:
48 const bool rt_;
49 const bool prior_;
50};
51
Tyler Chatowb7c6eba2021-07-28 14:43:23 -070052// Holds storage for a span object and the data referenced by that span for
53// compatibility with RawSender::SharedSpan users. If constructed with
54// MakeSharedSpan, span points to only the aligned segment of the entire data.
55struct AlignedOwningSpan {
56 AlignedOwningSpan(const AlignedOwningSpan &) = delete;
57 AlignedOwningSpan &operator=(const AlignedOwningSpan &) = delete;
58 absl::Span<const uint8_t> span;
59 char data[];
60};
61
62// Constructs a span which owns its data through a shared_ptr. The owning span
63// points to a const view of the data; also returns a temporary mutable span
64// which is only valid while the const shared span is kept alive.
65std::pair<RawSender::SharedSpan, absl::Span<uint8_t>> MakeSharedSpan(
66 size_t size) {
67 AlignedOwningSpan *const span = reinterpret_cast<AlignedOwningSpan *>(
68 malloc(sizeof(AlignedOwningSpan) + size + kChannelDataAlignment - 1));
69
70 absl::Span mutable_span(
71 reinterpret_cast<uint8_t *>(RoundChannelData(&span->data[0], size)),
72 size);
73 new (span) AlignedOwningSpan{.span = mutable_span};
74
75 return std::make_pair(
76 RawSender::SharedSpan(
77 std::shared_ptr<AlignedOwningSpan>(span,
78 [](AlignedOwningSpan *s) {
79 s->~AlignedOwningSpan();
80 free(s);
81 }),
82 &span->span),
83 mutable_span);
84}
85
Alex Perrycb7da4b2019-08-28 19:35:56 -070086// Container for both a message, and the context for it for simulation. This
87// makes tracking the timestamps associated with the data easy.
Brian Silverman661eb8d2020-08-12 19:41:01 -070088struct SimulatedMessage final {
89 SimulatedMessage(const SimulatedMessage &) = delete;
90 SimulatedMessage &operator=(const SimulatedMessage &) = delete;
Tyler Chatowb7c6eba2021-07-28 14:43:23 -070091 ~SimulatedMessage();
Brian Silverman661eb8d2020-08-12 19:41:01 -070092
93 // Creates a SimulatedMessage with size bytes of storage.
94 // This is a shared_ptr so we don't have to implement refcounting or copying.
Tyler Chatowb7c6eba2021-07-28 14:43:23 -070095 static std::shared_ptr<SimulatedMessage> Make(
96 SimulatedChannel *channel, const RawSender::SharedSpan data);
Brian Silverman661eb8d2020-08-12 19:41:01 -070097
Alex Perrycb7da4b2019-08-28 19:35:56 -070098 // Context for the data.
99 Context context;
100
Brian Silverman661eb8d2020-08-12 19:41:01 -0700101 SimulatedChannel *const channel = nullptr;
Brian Silverman661eb8d2020-08-12 19:41:01 -0700102
Tyler Chatowb7c6eba2021-07-28 14:43:23 -0700103 // Owning span to this message's data. Depending on the sender may either
104 // represent the data of just the flatbuffer, or max channel size.
105 RawSender::SharedSpan data;
Alex Perrycb7da4b2019-08-28 19:35:56 -0700106
Tyler Chatowb7c6eba2021-07-28 14:43:23 -0700107 // Mutable view of above data. If empty, this message is not mutable.
108 absl::Span<uint8_t> mutable_data;
Brian Silverman661eb8d2020-08-12 19:41:01 -0700109
Tyler Chatowb7c6eba2021-07-28 14:43:23 -0700110 // Determines whether this message is mutable. Used for Send where the user
111 // fills out a message stored internally then gives us the size of data used.
112 bool is_mutable() const { return data->size() == mutable_data.size(); }
113
114 // Note: this should be private but make_shared requires it to be public. Use
115 // Make() above to construct.
Brian Silverman661eb8d2020-08-12 19:41:01 -0700116 SimulatedMessage(SimulatedChannel *channel_in);
Alex Perrycb7da4b2019-08-28 19:35:56 -0700117};
118
Brian Silverman661eb8d2020-08-12 19:41:01 -0700119} // namespace
Austin Schuh39788ff2019-12-01 18:22:57 -0800120
Brian Silverman661eb8d2020-08-12 19:41:01 -0700121// TODO(Brian): This should be in the anonymous namespace, but that annoys GCC
122// for some reason...
Austin Schuhef8f1ae2021-12-11 12:35:05 -0800123class SimulatedWatcher : public WatcherState, public EventScheduler::Event {
Austin Schuh39788ff2019-12-01 18:22:57 -0800124 public:
Austin Schuh7d87b672019-12-01 20:23:49 -0800125 SimulatedWatcher(
126 SimulatedEventLoop *simulated_event_loop, EventScheduler *scheduler,
127 const Channel *channel,
128 std::function<void(const Context &context, const void *message)> fn);
Austin Schuh39788ff2019-12-01 18:22:57 -0800129
Austin Schuh7d87b672019-12-01 20:23:49 -0800130 ~SimulatedWatcher() override;
Austin Schuh39788ff2019-12-01 18:22:57 -0800131
Austin Schuh8fb315a2020-11-19 22:33:58 -0800132 bool has_run() const;
133
Austin Schuhef8f1ae2021-12-11 12:35:05 -0800134 void Handle() noexcept override;
135
Austin Schuh39788ff2019-12-01 18:22:57 -0800136 void Startup(EventLoop * /*event_loop*/) override {}
137
Austin Schuh7d87b672019-12-01 20:23:49 -0800138 void Schedule(std::shared_ptr<SimulatedMessage> message);
139
Austin Schuhf4b09c72021-12-08 12:04:37 -0800140 void HandleEvent() noexcept;
Austin Schuh39788ff2019-12-01 18:22:57 -0800141
142 void SetSimulatedChannel(SimulatedChannel *channel) {
143 simulated_channel_ = channel;
144 }
145
146 private:
Austin Schuh7d87b672019-12-01 20:23:49 -0800147 void DoSchedule(monotonic_clock::time_point event_time);
148
149 ::std::deque<std::shared_ptr<SimulatedMessage>> msgs_;
150
Brian Silverman4f4e0612020-08-12 19:54:41 -0700151 SimulatedEventLoop *const simulated_event_loop_;
152 const Channel *const channel_;
153 EventScheduler *const scheduler_;
Austin Schuh7d87b672019-12-01 20:23:49 -0800154 EventHandler<SimulatedWatcher> event_;
Austin Schuh7d87b672019-12-01 20:23:49 -0800155 EventScheduler::Token token_;
Austin Schuh39788ff2019-12-01 18:22:57 -0800156 SimulatedChannel *simulated_channel_ = nullptr;
157};
Alex Perrycb7da4b2019-08-28 19:35:56 -0700158
159class SimulatedChannel {
160 public:
Austin Schuh8fb315a2020-11-19 22:33:58 -0800161 explicit SimulatedChannel(const Channel *channel,
Eric Schmiedebergef44b8a2022-02-28 17:30:38 -0700162 std::chrono::nanoseconds channel_storage_duration,
163 const EventScheduler *scheduler)
Austin Schuh39788ff2019-12-01 18:22:57 -0800164 : channel_(channel),
Brian Silverman661eb8d2020-08-12 19:41:01 -0700165 channel_storage_duration_(channel_storage_duration),
Eric Schmiedebergef44b8a2022-02-28 17:30:38 -0700166 next_queue_index_(ipc_lib::QueueIndex::Zero(number_buffers())),
167 scheduler_(scheduler) {
Brian Silvermanbc596c62021-10-15 14:04:54 -0700168 available_buffer_indices_.resize(number_buffers());
Brian Silverman661eb8d2020-08-12 19:41:01 -0700169 for (int i = 0; i < number_buffers(); ++i) {
Brian Silvermanbc596c62021-10-15 14:04:54 -0700170 available_buffer_indices_[i] = i;
Brian Silverman661eb8d2020-08-12 19:41:01 -0700171 }
172 }
Alex Perrycb7da4b2019-08-28 19:35:56 -0700173
Brian Silverman661eb8d2020-08-12 19:41:01 -0700174 ~SimulatedChannel() {
175 latest_message_.reset();
176 CHECK_EQ(static_cast<size_t>(number_buffers()),
177 available_buffer_indices_.size());
James Kuszmaul4f106fb2021-01-05 20:53:02 -0800178 CHECK_EQ(0u, fetchers_.size())
179 << configuration::StrippedChannelToString(channel());
180 CHECK_EQ(0u, watchers_.size())
181 << configuration::StrippedChannelToString(channel());
182 CHECK_EQ(0, sender_count_)
183 << configuration::StrippedChannelToString(channel());
Brian Silverman661eb8d2020-08-12 19:41:01 -0700184 }
185
186 // The number of messages we pretend to have in the queue.
187 int queue_size() const {
Austin Schuhfb37c612022-08-11 15:24:51 -0700188 return configuration::QueueSize(channel()->frequency(),
189 channel_storage_duration_);
Brian Silverman661eb8d2020-08-12 19:41:01 -0700190 }
191
milind1f1dca32021-07-03 13:50:07 -0700192 std::chrono::nanoseconds channel_storage_duration() const {
193 return channel_storage_duration_;
194 }
195
Brian Silverman661eb8d2020-08-12 19:41:01 -0700196 // The number of extra buffers (beyond the queue) we pretend to have.
197 int number_scratch_buffers() const {
Austin Schuhfb37c612022-08-11 15:24:51 -0700198 return configuration::QueueScratchBufferSize(channel());
Brian Silverman661eb8d2020-08-12 19:41:01 -0700199 }
200
201 int number_buffers() const { return queue_size() + number_scratch_buffers(); }
202
203 int GetBufferIndex() {
204 CHECK(!available_buffer_indices_.empty()) << ": This should be impossible";
205 const int result = available_buffer_indices_.back();
206 available_buffer_indices_.pop_back();
207 return result;
208 }
209
210 void FreeBufferIndex(int i) {
Austin Schuhc5047ea2021-03-20 22:00:21 -0700211 // This extra checking has a large performance hit with sanitizers that
212 // track memory accesses, so just skip it.
213#if !__has_feature(memory_sanitizer) && !__has_feature(address_sanitizer)
Brian Silverman661eb8d2020-08-12 19:41:01 -0700214 DCHECK(std::find(available_buffer_indices_.begin(),
215 available_buffer_indices_.end(),
216 i) == available_buffer_indices_.end())
217 << ": Buffer is not in use: " << i;
Brian Silvermanf3e6df22021-01-19 15:02:21 -0800218#endif
Brian Silverman661eb8d2020-08-12 19:41:01 -0700219 available_buffer_indices_.push_back(i);
220 }
Alex Perrycb7da4b2019-08-28 19:35:56 -0700221
222 // Makes a connected raw sender which calls Send below.
Austin Schuh8fb315a2020-11-19 22:33:58 -0800223 ::std::unique_ptr<RawSender> MakeRawSender(SimulatedEventLoop *event_loop);
Alex Perrycb7da4b2019-08-28 19:35:56 -0700224
225 // Makes a connected raw fetcher.
Austin Schuh39788ff2019-12-01 18:22:57 -0800226 ::std::unique_ptr<RawFetcher> MakeRawFetcher(EventLoop *event_loop);
Alex Perrycb7da4b2019-08-28 19:35:56 -0700227
228 // Registers a watcher for the queue.
Austin Schuh7d87b672019-12-01 20:23:49 -0800229 void MakeRawWatcher(SimulatedWatcher *watcher);
Austin Schuh39788ff2019-12-01 18:22:57 -0800230
Austin Schuh7d87b672019-12-01 20:23:49 -0800231 void RemoveWatcher(SimulatedWatcher *watcher) {
Austin Schuh39788ff2019-12-01 18:22:57 -0800232 watchers_.erase(std::find(watchers_.begin(), watchers_.end(), watcher));
233 }
Alex Perrycb7da4b2019-08-28 19:35:56 -0700234
Austin Schuhad154822019-12-27 15:45:13 -0800235 // Sends the message to all the connected receivers and fetchers. Returns the
milind1f1dca32021-07-03 13:50:07 -0700236 // sent queue index, or std::nullopt if messages were sent too fast.
James Kuszmaul890c2492022-04-06 14:59:31 -0700237 std::optional<uint32_t> Send(std::shared_ptr<SimulatedMessage> message,
238 CheckSentTooFast check_sent_too_fast);
Alex Perrycb7da4b2019-08-28 19:35:56 -0700239
240 // Unregisters a fetcher.
241 void UnregisterFetcher(SimulatedFetcher *fetcher);
242
243 std::shared_ptr<SimulatedMessage> latest_message() { return latest_message_; }
244
Austin Schuh39788ff2019-12-01 18:22:57 -0800245 size_t max_size() const { return channel()->max_size(); }
Alex Perrycb7da4b2019-08-28 19:35:56 -0700246
Austin Schuh5f1cc5c2019-12-01 18:01:11 -0800247 const std::string_view name() const {
Austin Schuh39788ff2019-12-01 18:22:57 -0800248 return channel()->name()->string_view();
Alex Perrycb7da4b2019-08-28 19:35:56 -0700249 }
250
Austin Schuh39788ff2019-12-01 18:22:57 -0800251 const Channel *channel() const { return channel_; }
252
Austin Schuhe516ab02020-05-06 21:37:04 -0700253 void CountSenderCreated() {
254 if (sender_count_ >= channel()->num_senders()) {
255 LOG(FATAL) << "Failed to create sender on "
256 << configuration::CleanedChannelToString(channel())
257 << ", too many senders.";
258 }
Austin Schuhfb37c612022-08-11 15:24:51 -0700259 CheckBufferCount();
Austin Schuhe516ab02020-05-06 21:37:04 -0700260 ++sender_count_;
261 }
Brian Silverman77162972020-08-12 19:52:40 -0700262
Austin Schuhe516ab02020-05-06 21:37:04 -0700263 void CountSenderDestroyed() {
264 --sender_count_;
265 CHECK_GE(sender_count_, 0);
James Kuszmaul890c2492022-04-06 14:59:31 -0700266 if (sender_count_ == 0) {
267 allow_new_senders_ = true;
268 }
Austin Schuhe516ab02020-05-06 21:37:04 -0700269 }
270
Alex Perrycb7da4b2019-08-28 19:35:56 -0700271 private:
Brian Silverman77162972020-08-12 19:52:40 -0700272 void CheckBufferCount() {
273 int reader_count = 0;
274 if (channel()->read_method() == ReadMethod::PIN) {
275 reader_count = watchers_.size() + fetchers_.size();
276 }
277 CHECK_LT(reader_count + sender_count_, number_scratch_buffers());
278 }
279
280 void CheckReaderCount() {
281 if (channel()->read_method() != ReadMethod::PIN) {
282 return;
283 }
284 CheckBufferCount();
285 const int reader_count = watchers_.size() + fetchers_.size();
286 if (reader_count >= channel()->num_readers()) {
287 LOG(FATAL) << "Failed to create reader on "
288 << configuration::CleanedChannelToString(channel())
289 << ", too many readers.";
290 }
291 }
Brian Silverman661eb8d2020-08-12 19:41:01 -0700292
293 const Channel *const channel_;
Brian Silverman661eb8d2020-08-12 19:41:01 -0700294 const std::chrono::nanoseconds channel_storage_duration_;
Alex Perrycb7da4b2019-08-28 19:35:56 -0700295
296 // List of all watchers.
Austin Schuh7d87b672019-12-01 20:23:49 -0800297 ::std::vector<SimulatedWatcher *> watchers_;
Alex Perrycb7da4b2019-08-28 19:35:56 -0700298
299 // List of all fetchers.
300 ::std::vector<SimulatedFetcher *> fetchers_;
301 std::shared_ptr<SimulatedMessage> latest_message_;
Alex Perrycb7da4b2019-08-28 19:35:56 -0700302
303 ipc_lib::QueueIndex next_queue_index_;
Austin Schuhe516ab02020-05-06 21:37:04 -0700304
305 int sender_count_ = 0;
James Kuszmaul890c2492022-04-06 14:59:31 -0700306 // Used to track when an exclusive sender has been created (e.g., for log
307 // replay) and we want to prevent new senders from being accidentally created.
308 bool allow_new_senders_ = true;
Brian Silverman661eb8d2020-08-12 19:41:01 -0700309
310 std::vector<uint16_t> available_buffer_indices_;
Eric Schmiedebergef44b8a2022-02-28 17:30:38 -0700311
312 const EventScheduler *scheduler_;
313
314 // Queue of all the message send times in the last channel_storage_duration_
315 std::queue<monotonic_clock::time_point> last_times_;
Alex Perrycb7da4b2019-08-28 19:35:56 -0700316};
317
318namespace {
319
Brian Silverman661eb8d2020-08-12 19:41:01 -0700320std::shared_ptr<SimulatedMessage> SimulatedMessage::Make(
Tyler Chatowb7c6eba2021-07-28 14:43:23 -0700321 SimulatedChannel *channel, RawSender::SharedSpan data) {
Austin Schuh62288252020-11-18 23:26:04 -0800322 // The allocations in here are due to infrastructure and don't count in the no
323 // mallocs in RT code.
324 ScopedNotRealtime nrt;
Alex Perrycb7da4b2019-08-28 19:35:56 -0700325
Tyler Chatowb7c6eba2021-07-28 14:43:23 -0700326 auto message = std::make_shared<SimulatedMessage>(channel);
327 message->context.size = data->size();
328 message->context.data = data->data();
329 message->data = std::move(data);
330
331 return message;
Brian Silverman661eb8d2020-08-12 19:41:01 -0700332}
333
334SimulatedMessage::SimulatedMessage(SimulatedChannel *channel_in)
335 : channel(channel_in) {
Brian Silverman4f4e0612020-08-12 19:54:41 -0700336 context.buffer_index = channel->GetBufferIndex();
Brian Silverman661eb8d2020-08-12 19:41:01 -0700337}
338
339SimulatedMessage::~SimulatedMessage() {
Brian Silverman4f4e0612020-08-12 19:54:41 -0700340 channel->FreeBufferIndex(context.buffer_index);
Alex Perrycb7da4b2019-08-28 19:35:56 -0700341}
342
343class SimulatedSender : public RawSender {
344 public:
Austin Schuh8fb315a2020-11-19 22:33:58 -0800345 SimulatedSender(SimulatedChannel *simulated_channel,
346 SimulatedEventLoop *event_loop);
347 ~SimulatedSender() override;
Alex Perrycb7da4b2019-08-28 19:35:56 -0700348
349 void *data() override {
350 if (!message_) {
Austin Schuh9b1d6282022-06-10 17:03:21 -0700351 // This API is safe to use in a RT context on a RT system. So annotate it
352 // accordingly.
353 ScopedNotRealtime nrt;
354
Tyler Chatowb7c6eba2021-07-28 14:43:23 -0700355 auto [span, mutable_span] =
356 MakeSharedSpan(simulated_channel_->max_size());
357 message_ = SimulatedMessage::Make(simulated_channel_, span);
358 message_->mutable_data = mutable_span;
Alex Perrycb7da4b2019-08-28 19:35:56 -0700359 }
Tyler Chatowb7c6eba2021-07-28 14:43:23 -0700360 CHECK(message_->is_mutable());
361 return message_->mutable_data.data();
Alex Perrycb7da4b2019-08-28 19:35:56 -0700362 }
363
364 size_t size() override { return simulated_channel_->max_size(); }
365
milind1f1dca32021-07-03 13:50:07 -0700366 Error DoSend(size_t length, monotonic_clock::time_point monotonic_remote_time,
367 realtime_clock::time_point realtime_remote_time,
368 uint32_t remote_queue_index,
369 const UUID &source_boot_uuid) override;
Alex Perrycb7da4b2019-08-28 19:35:56 -0700370
milind1f1dca32021-07-03 13:50:07 -0700371 Error DoSend(const void *msg, size_t size,
372 monotonic_clock::time_point monotonic_remote_time,
373 realtime_clock::time_point realtime_remote_time,
374 uint32_t remote_queue_index,
375 const UUID &source_boot_uuid) override;
Alex Perrycb7da4b2019-08-28 19:35:56 -0700376
milind1f1dca32021-07-03 13:50:07 -0700377 Error DoSend(const SharedSpan data,
378 aos::monotonic_clock::time_point monotonic_remote_time,
379 aos::realtime_clock::time_point realtime_remote_time,
380 uint32_t remote_queue_index,
381 const UUID &source_boot_uuid) override;
Tyler Chatowb7c6eba2021-07-28 14:43:23 -0700382
Brian Silverman4f4e0612020-08-12 19:54:41 -0700383 int buffer_index() override {
384 // First, ensure message_ is allocated.
385 data();
386 return message_->context.buffer_index;
387 }
388
Alex Perrycb7da4b2019-08-28 19:35:56 -0700389 private:
390 SimulatedChannel *simulated_channel_;
Austin Schuh58646e22021-08-23 23:51:46 -0700391 SimulatedEventLoop *simulated_event_loop_;
Alex Perrycb7da4b2019-08-28 19:35:56 -0700392
393 std::shared_ptr<SimulatedMessage> message_;
394};
395} // namespace
396
397class SimulatedFetcher : public RawFetcher {
398 public:
Austin Schuhac0771c2020-01-07 18:36:30 -0800399 explicit SimulatedFetcher(EventLoop *event_loop,
400 SimulatedChannel *simulated_channel)
401 : RawFetcher(event_loop, simulated_channel->channel()),
402 simulated_channel_(simulated_channel) {}
403 ~SimulatedFetcher() { simulated_channel_->UnregisterFetcher(this); }
Alex Perrycb7da4b2019-08-28 19:35:56 -0700404
Austin Schuh39788ff2019-12-01 18:22:57 -0800405 std::pair<bool, monotonic_clock::time_point> DoFetchNext() override {
Austin Schuh62288252020-11-18 23:26:04 -0800406 // The allocations in here are due to infrastructure and don't count in the
407 // no mallocs in RT code.
408 ScopedNotRealtime nrt;
Austin Schuh39788ff2019-12-01 18:22:57 -0800409 if (msgs_.size() == 0) {
410 return std::make_pair(false, monotonic_clock::min_time);
411 }
Alex Perrycb7da4b2019-08-28 19:35:56 -0700412
James Kuszmaulbcd96fc2020-10-12 20:29:32 -0700413 CHECK(!fell_behind_) << ": Got behind on "
414 << configuration::StrippedChannelToString(
415 simulated_channel_->channel());
Brian Silverman661eb8d2020-08-12 19:41:01 -0700416
Alex Perrycb7da4b2019-08-28 19:35:56 -0700417 SetMsg(msgs_.front());
418 msgs_.pop_front();
Austin Schuha5e14192020-01-06 18:02:41 -0800419 return std::make_pair(true, event_loop()->monotonic_now());
Alex Perrycb7da4b2019-08-28 19:35:56 -0700420 }
421
Austin Schuh39788ff2019-12-01 18:22:57 -0800422 std::pair<bool, monotonic_clock::time_point> DoFetch() override {
Austin Schuh62288252020-11-18 23:26:04 -0800423 // The allocations in here are due to infrastructure and don't count in the
424 // no mallocs in RT code.
425 ScopedNotRealtime nrt;
Alex Perrycb7da4b2019-08-28 19:35:56 -0700426 if (msgs_.size() == 0) {
Austin Schuh7d87b672019-12-01 20:23:49 -0800427 // TODO(austin): Can we just do this logic unconditionally? It is a lot
428 // simpler. And call clear, obviously.
Austin Schuhac0771c2020-01-07 18:36:30 -0800429 if (!msg_ && simulated_channel_->latest_message()) {
430 SetMsg(simulated_channel_->latest_message());
Austin Schuha5e14192020-01-06 18:02:41 -0800431 return std::make_pair(true, event_loop()->monotonic_now());
Alex Perrycb7da4b2019-08-28 19:35:56 -0700432 } else {
Austin Schuh39788ff2019-12-01 18:22:57 -0800433 return std::make_pair(false, monotonic_clock::min_time);
Alex Perrycb7da4b2019-08-28 19:35:56 -0700434 }
435 }
436
437 // We've had a message enqueued, so we don't need to go looking for the
438 // latest message from before we started.
439 SetMsg(msgs_.back());
440 msgs_.clear();
Brian Silverman661eb8d2020-08-12 19:41:01 -0700441 fell_behind_ = false;
Austin Schuha5e14192020-01-06 18:02:41 -0800442 return std::make_pair(true, event_loop()->monotonic_now());
Alex Perrycb7da4b2019-08-28 19:35:56 -0700443 }
444
445 private:
446 friend class SimulatedChannel;
447
448 // Updates the state inside RawFetcher to point to the data in msg_.
449 void SetMsg(std::shared_ptr<SimulatedMessage> msg) {
Austin Schuhe6f4c8d2021-12-11 12:36:06 -0800450 msg_ = std::move(msg);
Alex Perrycb7da4b2019-08-28 19:35:56 -0700451 context_ = msg_->context;
Brian Silverman4f4e0612020-08-12 19:54:41 -0700452 if (channel()->read_method() != ReadMethod::PIN) {
453 context_.buffer_index = -1;
454 }
Austin Schuhad154822019-12-27 15:45:13 -0800455 if (context_.remote_queue_index == 0xffffffffu) {
456 context_.remote_queue_index = context_.queue_index;
457 }
Austin Schuh58646e22021-08-23 23:51:46 -0700458 if (context_.monotonic_remote_time == monotonic_clock::min_time) {
Austin Schuhad154822019-12-27 15:45:13 -0800459 context_.monotonic_remote_time = context_.monotonic_event_time;
460 }
Austin Schuh58646e22021-08-23 23:51:46 -0700461 if (context_.realtime_remote_time == realtime_clock::min_time) {
Austin Schuhad154822019-12-27 15:45:13 -0800462 context_.realtime_remote_time = context_.realtime_event_time;
463 }
Alex Perrycb7da4b2019-08-28 19:35:56 -0700464 }
465
466 // Internal method for Simulation to add a message to the buffer.
467 void Enqueue(std::shared_ptr<SimulatedMessage> buffer) {
Austin Schuhe6f4c8d2021-12-11 12:36:06 -0800468 msgs_.emplace_back(std::move(buffer));
Brian Silverman661eb8d2020-08-12 19:41:01 -0700469 if (fell_behind_ ||
470 msgs_.size() > static_cast<size_t>(simulated_channel_->queue_size())) {
471 fell_behind_ = true;
472 // Might as well empty out all the intermediate messages now.
473 while (msgs_.size() > 1) {
474 msgs_.pop_front();
475 }
476 }
Alex Perrycb7da4b2019-08-28 19:35:56 -0700477 }
478
Austin Schuhac0771c2020-01-07 18:36:30 -0800479 SimulatedChannel *simulated_channel_;
Alex Perrycb7da4b2019-08-28 19:35:56 -0700480 std::shared_ptr<SimulatedMessage> msg_;
481
482 // Messages queued up but not in use.
483 ::std::deque<std::shared_ptr<SimulatedMessage>> msgs_;
Brian Silverman661eb8d2020-08-12 19:41:01 -0700484
485 // Whether we're currently "behind", which means a FetchNext call will fail.
486 bool fell_behind_ = false;
Alex Perrycb7da4b2019-08-28 19:35:56 -0700487};
488
Austin Schuhef8f1ae2021-12-11 12:35:05 -0800489class SimulatedTimerHandler : public TimerHandler,
490 public EventScheduler::Event {
Alex Perrycb7da4b2019-08-28 19:35:56 -0700491 public:
492 explicit SimulatedTimerHandler(EventScheduler *scheduler,
Austin Schuhde8a8ff2019-11-30 15:25:36 -0800493 SimulatedEventLoop *simulated_event_loop,
Austin Schuh39788ff2019-12-01 18:22:57 -0800494 ::std::function<void()> fn);
Austin Schuh7d87b672019-12-01 20:23:49 -0800495 ~SimulatedTimerHandler() { Disable(); }
Alex Perrycb7da4b2019-08-28 19:35:56 -0700496
497 void Setup(monotonic_clock::time_point base,
Austin Schuhde8a8ff2019-11-30 15:25:36 -0800498 monotonic_clock::duration repeat_offset) override;
Alex Perrycb7da4b2019-08-28 19:35:56 -0700499
Austin Schuhf4b09c72021-12-08 12:04:37 -0800500 void HandleEvent() noexcept;
Alex Perrycb7da4b2019-08-28 19:35:56 -0700501
Austin Schuhef8f1ae2021-12-11 12:35:05 -0800502 void Handle() noexcept override;
503
Austin Schuh7d87b672019-12-01 20:23:49 -0800504 void Disable() override;
Alex Perrycb7da4b2019-08-28 19:35:56 -0700505
Alex Perrycb7da4b2019-08-28 19:35:56 -0700506 private:
Austin Schuh7d87b672019-12-01 20:23:49 -0800507 SimulatedEventLoop *simulated_event_loop_;
508 EventHandler<SimulatedTimerHandler> event_;
Alex Perrycb7da4b2019-08-28 19:35:56 -0700509 EventScheduler *scheduler_;
510 EventScheduler::Token token_;
Austin Schuhde8a8ff2019-11-30 15:25:36 -0800511
Alex Perrycb7da4b2019-08-28 19:35:56 -0700512 monotonic_clock::time_point base_;
513 monotonic_clock::duration repeat_offset_;
514};
515
Austin Schuhef8f1ae2021-12-11 12:35:05 -0800516class SimulatedPhasedLoopHandler : public PhasedLoopHandler,
517 public EventScheduler::Event {
Alex Perrycb7da4b2019-08-28 19:35:56 -0700518 public:
519 SimulatedPhasedLoopHandler(EventScheduler *scheduler,
Austin Schuhde8a8ff2019-11-30 15:25:36 -0800520 SimulatedEventLoop *simulated_event_loop,
Alex Perrycb7da4b2019-08-28 19:35:56 -0700521 ::std::function<void(int)> fn,
522 const monotonic_clock::duration interval,
Austin Schuh39788ff2019-12-01 18:22:57 -0800523 const monotonic_clock::duration offset);
Austin Schuh7d87b672019-12-01 20:23:49 -0800524 ~SimulatedPhasedLoopHandler();
Alex Perrycb7da4b2019-08-28 19:35:56 -0700525
Austin Schuhf4b09c72021-12-08 12:04:37 -0800526 void HandleEvent() noexcept;
Alex Perrycb7da4b2019-08-28 19:35:56 -0700527
Austin Schuh7d87b672019-12-01 20:23:49 -0800528 void Schedule(monotonic_clock::time_point sleep_time) override;
Alex Perrycb7da4b2019-08-28 19:35:56 -0700529
Austin Schuhef8f1ae2021-12-11 12:35:05 -0800530 void Handle() noexcept override;
531
Alex Perrycb7da4b2019-08-28 19:35:56 -0700532 private:
Austin Schuh39788ff2019-12-01 18:22:57 -0800533 SimulatedEventLoop *simulated_event_loop_;
Austin Schuh7d87b672019-12-01 20:23:49 -0800534 EventHandler<SimulatedPhasedLoopHandler> event_;
Alex Perrycb7da4b2019-08-28 19:35:56 -0700535
Austin Schuh39788ff2019-12-01 18:22:57 -0800536 EventScheduler *scheduler_;
537 EventScheduler::Token token_;
Alex Perrycb7da4b2019-08-28 19:35:56 -0700538};
539
540class SimulatedEventLoop : public EventLoop {
541 public:
542 explicit SimulatedEventLoop(
Brian Silverman661eb8d2020-08-12 19:41:01 -0700543 EventScheduler *scheduler, NodeEventLoopFactory *node_event_loop_factory,
Alex Perrycb7da4b2019-08-28 19:35:56 -0700544 absl::btree_map<SimpleChannel, std::unique_ptr<SimulatedChannel>>
545 *channels,
546 const Configuration *configuration,
Austin Schuh057d29f2021-08-21 23:05:15 -0700547 std::vector<SimulatedEventLoop *> *event_loops_, const Node *node,
James Kuszmaul890c2492022-04-06 14:59:31 -0700548 pid_t tid, EventLoopOptions options)
Austin Schuh83c7f702021-01-19 22:36:29 -0800549 : EventLoop(CHECK_NOTNULL(configuration)),
Alex Perrycb7da4b2019-08-28 19:35:56 -0700550 scheduler_(scheduler),
Austin Schuhac0771c2020-01-07 18:36:30 -0800551 node_event_loop_factory_(node_event_loop_factory),
Alex Perrycb7da4b2019-08-28 19:35:56 -0700552 channels_(channels),
Austin Schuh057d29f2021-08-21 23:05:15 -0700553 event_loops_(event_loops_),
Austin Schuh217a9782019-12-21 23:02:50 -0800554 node_(node),
Austin Schuh58646e22021-08-23 23:51:46 -0700555 tid_(tid),
James Kuszmaul890c2492022-04-06 14:59:31 -0700556 startup_tracker_(std::make_shared<StartupTracker>()),
557 options_(options) {
Austin Schuh58646e22021-08-23 23:51:46 -0700558 startup_tracker_->loop = this;
559 scheduler_->ScheduleOnStartup([startup_tracker = startup_tracker_]() {
560 if (startup_tracker->loop) {
561 startup_tracker->loop->Setup();
562 startup_tracker->has_setup = true;
563 }
Austin Schuh057d29f2021-08-21 23:05:15 -0700564 });
565
566 event_loops_->push_back(this);
Alex Perrycb7da4b2019-08-28 19:35:56 -0700567 }
Austin Schuh58646e22021-08-23 23:51:46 -0700568
Alex Perrycb7da4b2019-08-28 19:35:56 -0700569 ~SimulatedEventLoop() override {
Austin Schuh39788ff2019-12-01 18:22:57 -0800570 // Trigger any remaining senders or fetchers to be cleared before destroying
571 // the event loop so the book keeping matches.
572 timing_report_sender_.reset();
573
574 // Force everything with a registered fd with epoll to be destroyed now.
575 timers_.clear();
576 phased_loops_.clear();
577 watchers_.clear();
578
Austin Schuh58646e22021-08-23 23:51:46 -0700579 for (auto it = event_loops_->begin(); it != event_loops_->end(); ++it) {
Austin Schuh057d29f2021-08-21 23:05:15 -0700580 if (*it == this) {
581 event_loops_->erase(it);
Alex Perrycb7da4b2019-08-28 19:35:56 -0700582 break;
583 }
584 }
Austin Schuh58646e22021-08-23 23:51:46 -0700585 VLOG(1) << scheduler_->distributed_now() << " " << NodeName(node())
586 << monotonic_now() << " ~SimulatedEventLoop(\"" << name_ << "\")";
587 startup_tracker_->loop = nullptr;
Alex Perrycb7da4b2019-08-28 19:35:56 -0700588 }
589
Austin Schuh057d29f2021-08-21 23:05:15 -0700590 void SetIsRunning(bool running) {
Austin Schuh58646e22021-08-23 23:51:46 -0700591 VLOG(1) << scheduler_->distributed_now() << " " << NodeName(node())
592 << monotonic_now() << " " << name_ << " set_is_running(" << running
593 << ")";
594 CHECK(startup_tracker_->has_setup);
Austin Schuh057d29f2021-08-21 23:05:15 -0700595
596 set_is_running(running);
Austin Schuh58646e22021-08-23 23:51:46 -0700597 if (running) {
598 has_run_ = true;
599 }
Austin Schuh057d29f2021-08-21 23:05:15 -0700600 }
601
Austin Schuh8fb315a2020-11-19 22:33:58 -0800602 bool has_run() const { return has_run_; }
603
Austin Schuh7d87b672019-12-01 20:23:49 -0800604 std::chrono::nanoseconds send_delay() const { return send_delay_; }
605 void set_send_delay(std::chrono::nanoseconds send_delay) {
606 send_delay_ = send_delay;
607 }
608
Stephan Pleines559fa6c2022-01-06 17:23:51 -0800609 monotonic_clock::time_point monotonic_now() const override {
Austin Schuhac0771c2020-01-07 18:36:30 -0800610 return node_event_loop_factory_->monotonic_now();
Alex Perrycb7da4b2019-08-28 19:35:56 -0700611 }
612
Stephan Pleines559fa6c2022-01-06 17:23:51 -0800613 realtime_clock::time_point realtime_now() const override {
Austin Schuhac0771c2020-01-07 18:36:30 -0800614 return node_event_loop_factory_->realtime_now();
Alex Perrycb7da4b2019-08-28 19:35:56 -0700615 }
616
Austin Schuh58646e22021-08-23 23:51:46 -0700617 distributed_clock::time_point distributed_now() {
618 return scheduler_->distributed_now();
619 }
Alex Perrycb7da4b2019-08-28 19:35:56 -0700620
Austin Schuh58646e22021-08-23 23:51:46 -0700621 std::unique_ptr<RawSender> MakeRawSender(const Channel *channel) override;
622
623 std::unique_ptr<RawFetcher> MakeRawFetcher(const Channel *channel) override;
Alex Perrycb7da4b2019-08-28 19:35:56 -0700624
625 void MakeRawWatcher(
626 const Channel *channel,
627 ::std::function<void(const Context &context, const void *message)>
628 watcher) override;
629
630 TimerHandler *AddTimer(::std::function<void()> callback) override {
Austin Schuh39788ff2019-12-01 18:22:57 -0800631 CHECK(!is_running());
Austin Schuh8bd96322020-02-13 21:18:22 -0800632 return NewTimer(::std::unique_ptr<TimerHandler>(
633 new SimulatedTimerHandler(scheduler_, this, callback)));
Alex Perrycb7da4b2019-08-28 19:35:56 -0700634 }
635
636 PhasedLoopHandler *AddPhasedLoop(::std::function<void(int)> callback,
637 const monotonic_clock::duration interval,
638 const monotonic_clock::duration offset =
639 ::std::chrono::seconds(0)) override {
Austin Schuh8bd96322020-02-13 21:18:22 -0800640 return NewPhasedLoop(
641 ::std::unique_ptr<PhasedLoopHandler>(new SimulatedPhasedLoopHandler(
642 scheduler_, this, callback, interval, offset)));
Alex Perrycb7da4b2019-08-28 19:35:56 -0700643 }
644
645 void OnRun(::std::function<void()> on_run) override {
Austin Schuh8fb315a2020-11-19 22:33:58 -0800646 CHECK(!is_running()) << ": Cannot register OnRun callback while running.";
Austin Schuhcc6070c2020-10-10 20:25:56 -0700647 scheduler_->ScheduleOnRun([this, on_run = std::move(on_run)]() {
Austin Schuhad9e5eb2021-11-19 20:33:55 -0800648 logging::ScopedLogRestorer prev_logger;
649 if (log_impl_) {
650 prev_logger.Swap(log_impl_);
651 }
Austin Schuhcc6070c2020-10-10 20:25:56 -0700652 ScopedMarkRealtimeRestorer rt(priority() > 0);
Austin Schuha9012be2021-07-21 15:19:11 -0700653 SetTimerContext(monotonic_now());
Austin Schuhcc6070c2020-10-10 20:25:56 -0700654 on_run();
655 });
Alex Perrycb7da4b2019-08-28 19:35:56 -0700656 }
657
Austin Schuh217a9782019-12-21 23:02:50 -0800658 const Node *node() const override { return node_; }
659
James Kuszmaul3ae42262019-11-08 12:33:41 -0800660 void set_name(const std::string_view name) override {
Alex Perrycb7da4b2019-08-28 19:35:56 -0700661 name_ = std::string(name);
662 }
James Kuszmaul3ae42262019-11-08 12:33:41 -0800663 const std::string_view name() const override { return name_; }
Alex Perrycb7da4b2019-08-28 19:35:56 -0700664
665 SimulatedChannel *GetSimulatedChannel(const Channel *channel);
666
Austin Schuh39788ff2019-12-01 18:22:57 -0800667 void SetRuntimeRealtimePriority(int priority) override {
Alex Perrycb7da4b2019-08-28 19:35:56 -0700668 CHECK(!is_running()) << ": Cannot set realtime priority while running.";
Austin Schuh39788ff2019-12-01 18:22:57 -0800669 priority_ = priority;
Alex Perrycb7da4b2019-08-28 19:35:56 -0700670 }
671
Austin Schuh39788ff2019-12-01 18:22:57 -0800672 int priority() const override { return priority_; }
673
Brian Silverman6a54ff32020-04-28 16:41:39 -0700674 void SetRuntimeAffinity(const cpu_set_t & /*cpuset*/) override {
675 CHECK(!is_running()) << ": Cannot set affinity while running.";
676 }
677
Tyler Chatow67ddb032020-01-12 14:30:04 -0800678 void Setup() {
679 MaybeScheduleTimingReports();
680 if (!skip_logger_) {
Austin Schuhad9e5eb2021-11-19 20:33:55 -0800681 log_sender_.Initialize(&name_,
682 MakeSender<logging::LogMessageFbs>("/aos"));
Austin Schuha0c41ba2020-09-10 22:59:14 -0700683 log_impl_ = log_sender_.implementation();
Tyler Chatow67ddb032020-01-12 14:30:04 -0800684 }
685 }
Austin Schuh39788ff2019-12-01 18:22:57 -0800686
Brian Silverman4f4e0612020-08-12 19:54:41 -0700687 int NumberBuffers(const Channel *channel) override;
688
Austin Schuh83c7f702021-01-19 22:36:29 -0800689 const UUID &boot_uuid() const override {
690 return node_event_loop_factory_->boot_uuid();
691 }
692
James Kuszmaul890c2492022-04-06 14:59:31 -0700693 const EventLoopOptions &options() const { return options_; }
694
Alex Perrycb7da4b2019-08-28 19:35:56 -0700695 private:
Austin Schuhde8a8ff2019-11-30 15:25:36 -0800696 friend class SimulatedTimerHandler;
Austin Schuh7d87b672019-12-01 20:23:49 -0800697 friend class SimulatedPhasedLoopHandler;
698 friend class SimulatedWatcher;
699
Austin Schuh58646e22021-08-23 23:51:46 -0700700 // We have a condition where we register a startup handler, but then get shut
701 // down before it runs. This results in a segfault if we are lucky, and
702 // corruption otherwise. To handle that, allocate a small object which points
703 // back to us and can be freed when the function is freed. That object can
704 // then be updated when we get destroyed so setup is not called.
705 struct StartupTracker {
706 SimulatedEventLoop *loop = nullptr;
707 bool has_setup = false;
708 };
709
Austin Schuh7d87b672019-12-01 20:23:49 -0800710 void HandleEvent() {
711 while (true) {
712 if (EventCount() == 0 || PeekEvent()->event_time() > monotonic_now()) {
713 break;
714 }
715
716 EventLoopEvent *event = PopEvent();
717 event->HandleEvent();
718 }
719 }
Austin Schuhde8a8ff2019-11-30 15:25:36 -0800720
Austin Schuh39788ff2019-12-01 18:22:57 -0800721 pid_t GetTid() override { return tid_; }
722
Alex Perrycb7da4b2019-08-28 19:35:56 -0700723 EventScheduler *scheduler_;
Austin Schuhac0771c2020-01-07 18:36:30 -0800724 NodeEventLoopFactory *node_event_loop_factory_;
Alex Perrycb7da4b2019-08-28 19:35:56 -0700725 absl::btree_map<SimpleChannel, std::unique_ptr<SimulatedChannel>> *channels_;
Austin Schuh057d29f2021-08-21 23:05:15 -0700726 std::vector<SimulatedEventLoop *> *event_loops_;
Alex Perrycb7da4b2019-08-28 19:35:56 -0700727
728 ::std::string name_;
Austin Schuh39788ff2019-12-01 18:22:57 -0800729
730 int priority_ = 0;
731
Austin Schuh7d87b672019-12-01 20:23:49 -0800732 std::chrono::nanoseconds send_delay_;
733
Austin Schuh217a9782019-12-21 23:02:50 -0800734 const Node *const node_;
Austin Schuh39788ff2019-12-01 18:22:57 -0800735 const pid_t tid_;
Tyler Chatow67ddb032020-01-12 14:30:04 -0800736
737 AosLogToFbs log_sender_;
Austin Schuha0c41ba2020-09-10 22:59:14 -0700738 std::shared_ptr<logging::LogImplementation> log_impl_ = nullptr;
Austin Schuh8fb315a2020-11-19 22:33:58 -0800739
740 bool has_run_ = false;
Austin Schuh58646e22021-08-23 23:51:46 -0700741
742 std::shared_ptr<StartupTracker> startup_tracker_;
James Kuszmaul890c2492022-04-06 14:59:31 -0700743
744 EventLoopOptions options_;
Alex Perrycb7da4b2019-08-28 19:35:56 -0700745};
746
Austin Schuh7d87b672019-12-01 20:23:49 -0800747void SimulatedEventLoopFactory::set_send_delay(
748 std::chrono::nanoseconds send_delay) {
749 send_delay_ = send_delay;
Austin Schuh58646e22021-08-23 23:51:46 -0700750 for (std::unique_ptr<NodeEventLoopFactory> &node : node_factories_) {
Austin Schuh057d29f2021-08-21 23:05:15 -0700751 if (node) {
752 for (SimulatedEventLoop *loop : node->event_loops_) {
753 loop->set_send_delay(send_delay_);
754 }
755 }
Austin Schuh7d87b672019-12-01 20:23:49 -0800756 }
757}
758
James Kuszmaulb67409b2022-06-20 16:25:03 -0700759void SimulatedEventLoopFactory::SetRealtimeReplayRate(double replay_rate) {
760 scheduler_scheduler_.SetReplayRate(replay_rate);
761}
762
Alex Perrycb7da4b2019-08-28 19:35:56 -0700763void SimulatedEventLoop::MakeRawWatcher(
764 const Channel *channel,
765 std::function<void(const Context &channel, const void *message)> watcher) {
Brian Silverman0fc69932020-01-24 21:54:02 -0800766 TakeWatcher(channel);
Austin Schuh217a9782019-12-21 23:02:50 -0800767
Austin Schuh057d29f2021-08-21 23:05:15 -0700768 std::unique_ptr<SimulatedWatcher> shm_watcher =
769 std::make_unique<SimulatedWatcher>(this, scheduler_, channel,
770 std::move(watcher));
Austin Schuh39788ff2019-12-01 18:22:57 -0800771
772 GetSimulatedChannel(channel)->MakeRawWatcher(shm_watcher.get());
Austin Schuh057d29f2021-08-21 23:05:15 -0700773
Austin Schuh39788ff2019-12-01 18:22:57 -0800774 NewWatcher(std::move(shm_watcher));
Austin Schuh58646e22021-08-23 23:51:46 -0700775 VLOG(1) << distributed_now() << " " << NodeName(node()) << monotonic_now()
776 << " " << name() << " MakeRawWatcher(\""
777 << configuration::StrippedChannelToString(channel) << "\")";
Austin Schuh8fb315a2020-11-19 22:33:58 -0800778
779 // Order of operations gets kinda wonky if we let people make watchers after
780 // running once. If someone has a valid use case, we can reconsider.
781 CHECK(!has_run()) << ": Can't add a watcher after running.";
Alex Perrycb7da4b2019-08-28 19:35:56 -0700782}
783
784std::unique_ptr<RawSender> SimulatedEventLoop::MakeRawSender(
785 const Channel *channel) {
Brian Silverman0fc69932020-01-24 21:54:02 -0800786 TakeSender(channel);
787
Austin Schuh58646e22021-08-23 23:51:46 -0700788 VLOG(1) << distributed_now() << " " << NodeName(node()) << monotonic_now()
789 << " " << name() << " MakeRawSender(\""
790 << configuration::StrippedChannelToString(channel) << "\")";
Alex Perrycb7da4b2019-08-28 19:35:56 -0700791 return GetSimulatedChannel(channel)->MakeRawSender(this);
792}
793
794std::unique_ptr<RawFetcher> SimulatedEventLoop::MakeRawFetcher(
795 const Channel *channel) {
Austin Schuh39788ff2019-12-01 18:22:57 -0800796 ChannelIndex(channel);
Austin Schuh217a9782019-12-21 23:02:50 -0800797
Austin Schuhca4828c2019-12-28 14:21:35 -0800798 if (!configuration::ChannelIsReadableOnNode(channel, node())) {
799 LOG(FATAL) << "Channel { \"name\": \"" << channel->name()->string_view()
800 << "\", \"type\": \"" << channel->type()->string_view()
801 << "\" } is not able to be fetched on this node. Check your "
802 "configuration.";
Austin Schuh217a9782019-12-21 23:02:50 -0800803 }
804
Austin Schuh58646e22021-08-23 23:51:46 -0700805 VLOG(1) << distributed_now() << " " << NodeName(node()) << monotonic_now()
806 << " " << name() << " MakeRawFetcher(\""
807 << configuration::StrippedChannelToString(channel) << "\")";
Austin Schuh39788ff2019-12-01 18:22:57 -0800808 return GetSimulatedChannel(channel)->MakeRawFetcher(this);
Alex Perrycb7da4b2019-08-28 19:35:56 -0700809}
810
811SimulatedChannel *SimulatedEventLoop::GetSimulatedChannel(
812 const Channel *channel) {
813 auto it = channels_->find(SimpleChannel(channel));
814 if (it == channels_->end()) {
Eric Schmiedebergef44b8a2022-02-28 17:30:38 -0700815 it = channels_
816 ->emplace(SimpleChannel(channel),
817 std::unique_ptr<SimulatedChannel>(new SimulatedChannel(
818 channel,
819 std::chrono::nanoseconds(
820 configuration()->channel_storage_duration()),
821 scheduler_)))
822 .first;
Alex Perrycb7da4b2019-08-28 19:35:56 -0700823 }
824 return it->second.get();
825}
826
Brian Silverman4f4e0612020-08-12 19:54:41 -0700827int SimulatedEventLoop::NumberBuffers(const Channel *channel) {
828 return GetSimulatedChannel(channel)->number_buffers();
829}
830
Austin Schuh7d87b672019-12-01 20:23:49 -0800831SimulatedWatcher::SimulatedWatcher(
832 SimulatedEventLoop *simulated_event_loop, EventScheduler *scheduler,
Austin Schuh8bd96322020-02-13 21:18:22 -0800833 const Channel *channel,
Austin Schuh7d87b672019-12-01 20:23:49 -0800834 std::function<void(const Context &context, const void *message)> fn)
835 : WatcherState(simulated_event_loop, channel, std::move(fn)),
836 simulated_event_loop_(simulated_event_loop),
Brian Silverman4f4e0612020-08-12 19:54:41 -0700837 channel_(channel),
Austin Schuh7d87b672019-12-01 20:23:49 -0800838 scheduler_(scheduler),
Brian Silverman4f4e0612020-08-12 19:54:41 -0700839 event_(this),
Austin Schuh58646e22021-08-23 23:51:46 -0700840 token_(scheduler_->InvalidToken()) {
841 VLOG(1) << simulated_event_loop_->distributed_now() << " "
842 << NodeName(simulated_event_loop_->node())
843 << simulated_event_loop_->monotonic_now() << " "
844 << simulated_event_loop_->name() << " Watching "
845 << configuration::StrippedChannelToString(channel_);
846}
Austin Schuh7d87b672019-12-01 20:23:49 -0800847
848SimulatedWatcher::~SimulatedWatcher() {
Austin Schuh58646e22021-08-23 23:51:46 -0700849 VLOG(1) << simulated_event_loop_->distributed_now() << " "
Austin Schuh057d29f2021-08-21 23:05:15 -0700850 << NodeName(simulated_event_loop_->node())
Austin Schuh58646e22021-08-23 23:51:46 -0700851 << simulated_event_loop_->monotonic_now() << " "
852 << simulated_event_loop_->name() << " ~Watching "
Austin Schuh057d29f2021-08-21 23:05:15 -0700853 << configuration::StrippedChannelToString(channel_);
Austin Schuh7d87b672019-12-01 20:23:49 -0800854 simulated_event_loop_->RemoveEvent(&event_);
855 if (token_ != scheduler_->InvalidToken()) {
856 scheduler_->Deschedule(token_);
857 }
Brian Silverman4f4e0612020-08-12 19:54:41 -0700858 CHECK_NOTNULL(simulated_channel_)->RemoveWatcher(this);
Austin Schuh7d87b672019-12-01 20:23:49 -0800859}
860
Austin Schuh8fb315a2020-11-19 22:33:58 -0800861bool SimulatedWatcher::has_run() const {
862 return simulated_event_loop_->has_run();
863}
864
Austin Schuh7d87b672019-12-01 20:23:49 -0800865void SimulatedWatcher::Schedule(std::shared_ptr<SimulatedMessage> message) {
Austin Schuha5e14192020-01-06 18:02:41 -0800866 monotonic_clock::time_point event_time =
867 simulated_event_loop_->monotonic_now();
Austin Schuh7d87b672019-12-01 20:23:49 -0800868
869 // Messages are queued in order. If we are the first, add ourselves.
870 // Otherwise, don't.
871 if (msgs_.size() == 0) {
Austin Schuhad154822019-12-27 15:45:13 -0800872 event_.set_event_time(message->context.monotonic_event_time);
Austin Schuh7d87b672019-12-01 20:23:49 -0800873 simulated_event_loop_->AddEvent(&event_);
874
875 DoSchedule(event_time);
876 }
877
Austin Schuhe6f4c8d2021-12-11 12:36:06 -0800878 msgs_.emplace_back(std::move(message));
Austin Schuh7d87b672019-12-01 20:23:49 -0800879}
880
Austin Schuhf4b09c72021-12-08 12:04:37 -0800881void SimulatedWatcher::HandleEvent() noexcept {
Austin Schuh7d87b672019-12-01 20:23:49 -0800882 const monotonic_clock::time_point monotonic_now =
883 simulated_event_loop_->monotonic_now();
Austin Schuh58646e22021-08-23 23:51:46 -0700884 VLOG(1) << simulated_event_loop_->distributed_now() << " "
885 << NodeName(simulated_event_loop_->node())
886 << simulated_event_loop_->monotonic_now() << " "
887 << simulated_event_loop_->name() << " Watcher "
Austin Schuh057d29f2021-08-21 23:05:15 -0700888 << configuration::StrippedChannelToString(channel_);
889 CHECK_NE(msgs_.size(), 0u) << ": No events to handle.";
890
Tyler Chatow67ddb032020-01-12 14:30:04 -0800891 logging::ScopedLogRestorer prev_logger;
Austin Schuha0c41ba2020-09-10 22:59:14 -0700892 if (simulated_event_loop_->log_impl_) {
893 prev_logger.Swap(simulated_event_loop_->log_impl_);
Tyler Chatow67ddb032020-01-12 14:30:04 -0800894 }
Austin Schuhad154822019-12-27 15:45:13 -0800895 Context context = msgs_.front()->context;
896
Brian Silverman4f4e0612020-08-12 19:54:41 -0700897 if (channel_->read_method() != ReadMethod::PIN) {
898 context.buffer_index = -1;
899 }
Austin Schuhad154822019-12-27 15:45:13 -0800900 if (context.remote_queue_index == 0xffffffffu) {
901 context.remote_queue_index = context.queue_index;
902 }
Austin Schuh58646e22021-08-23 23:51:46 -0700903 if (context.monotonic_remote_time == monotonic_clock::min_time) {
Austin Schuhad154822019-12-27 15:45:13 -0800904 context.monotonic_remote_time = context.monotonic_event_time;
905 }
Austin Schuh58646e22021-08-23 23:51:46 -0700906 if (context.realtime_remote_time == realtime_clock::min_time) {
Austin Schuhad154822019-12-27 15:45:13 -0800907 context.realtime_remote_time = context.realtime_event_time;
908 }
909
Austin Schuhcc6070c2020-10-10 20:25:56 -0700910 {
911 ScopedMarkRealtimeRestorer rt(simulated_event_loop_->priority() > 0);
912 DoCallCallback([monotonic_now]() { return monotonic_now; }, context);
913 }
Austin Schuh7d87b672019-12-01 20:23:49 -0800914
915 msgs_.pop_front();
Austin Schuheb4e4ce2020-09-10 23:04:18 -0700916 if (token_ != scheduler_->InvalidToken()) {
917 scheduler_->Deschedule(token_);
918 token_ = scheduler_->InvalidToken();
919 }
Austin Schuh7d87b672019-12-01 20:23:49 -0800920 if (msgs_.size() != 0) {
Austin Schuhad154822019-12-27 15:45:13 -0800921 event_.set_event_time(msgs_.front()->context.monotonic_event_time);
Austin Schuh7d87b672019-12-01 20:23:49 -0800922 simulated_event_loop_->AddEvent(&event_);
923
924 DoSchedule(event_.event_time());
Austin Schuh7d87b672019-12-01 20:23:49 -0800925 }
926}
927
Austin Schuhef8f1ae2021-12-11 12:35:05 -0800928void SimulatedWatcher::Handle() noexcept {
929 DCHECK(token_ != scheduler_->InvalidToken());
930 token_ = scheduler_->InvalidToken();
931 simulated_event_loop_->HandleEvent();
932}
933
Austin Schuh7d87b672019-12-01 20:23:49 -0800934void SimulatedWatcher::DoSchedule(monotonic_clock::time_point event_time) {
Austin Schuheb4e4ce2020-09-10 23:04:18 -0700935 CHECK(token_ == scheduler_->InvalidToken())
936 << ": May not schedule multiple times";
937 token_ = scheduler_->Schedule(
Austin Schuhef8f1ae2021-12-11 12:35:05 -0800938 event_time + simulated_event_loop_->send_delay(), this);
Austin Schuh7d87b672019-12-01 20:23:49 -0800939}
940
941void SimulatedChannel::MakeRawWatcher(SimulatedWatcher *watcher) {
Brian Silverman77162972020-08-12 19:52:40 -0700942 CheckReaderCount();
Austin Schuh39788ff2019-12-01 18:22:57 -0800943 watcher->SetSimulatedChannel(this);
944 watchers_.emplace_back(watcher);
Alex Perrycb7da4b2019-08-28 19:35:56 -0700945}
946
947::std::unique_ptr<RawSender> SimulatedChannel::MakeRawSender(
Austin Schuh8fb315a2020-11-19 22:33:58 -0800948 SimulatedEventLoop *event_loop) {
James Kuszmaul890c2492022-04-06 14:59:31 -0700949 CHECK(allow_new_senders_)
950 << ": Attempted to create a new sender on exclusive channel "
951 << configuration::StrippedChannelToString(channel_);
952 if (event_loop->options().exclusive_senders == ExclusiveSenders::kYes) {
953 CHECK_EQ(0, sender_count_)
954 << ": Attempted to add an exclusive sender on a channel with existing "
955 "senders: "
956 << configuration::StrippedChannelToString(channel_);
957 allow_new_senders_ = false;
958 }
Alex Perrycb7da4b2019-08-28 19:35:56 -0700959 return ::std::unique_ptr<RawSender>(new SimulatedSender(this, event_loop));
960}
961
Austin Schuh39788ff2019-12-01 18:22:57 -0800962::std::unique_ptr<RawFetcher> SimulatedChannel::MakeRawFetcher(
963 EventLoop *event_loop) {
Brian Silverman77162972020-08-12 19:52:40 -0700964 CheckReaderCount();
Austin Schuh39788ff2019-12-01 18:22:57 -0800965 ::std::unique_ptr<SimulatedFetcher> fetcher(
966 new SimulatedFetcher(event_loop, this));
Alex Perrycb7da4b2019-08-28 19:35:56 -0700967 fetchers_.push_back(fetcher.get());
968 return ::std::move(fetcher);
969}
970
milind1f1dca32021-07-03 13:50:07 -0700971std::optional<uint32_t> SimulatedChannel::Send(
Austin Schuh60e77942022-05-16 17:48:24 -0700972 std::shared_ptr<SimulatedMessage> message,
973 CheckSentTooFast check_sent_too_fast) {
Eric Schmiedebergef44b8a2022-02-28 17:30:38 -0700974 const auto now = scheduler_->monotonic_now();
975 // Remove times that are greater than or equal to a channel_storage_duration_
976 // ago
977 while (!last_times_.empty() &&
978 (now - last_times_.front() >= channel_storage_duration_)) {
979 last_times_.pop();
980 }
981
982 // Check that we are not sending messages too fast
James Kuszmaul890c2492022-04-06 14:59:31 -0700983 if (check_sent_too_fast == CheckSentTooFast::kYes &&
984 static_cast<int>(last_times_.size()) >= queue_size()) {
Eric Schmiedebergef44b8a2022-02-28 17:30:38 -0700985 return std::nullopt;
986 }
987
988 const std::optional<uint32_t> queue_index = {next_queue_index_.index()};
989 last_times_.push(now);
Tyler Chatowb7c6eba2021-07-28 14:43:23 -0700990
milind1f1dca32021-07-03 13:50:07 -0700991 message->context.queue_index = *queue_index;
Tyler Chatowb7c6eba2021-07-28 14:43:23 -0700992 // Points to the actual data depending on the size set in context. Data may
993 // allocate more than the actual size of the message, so offset from the back
994 // of that to get the actual start of the data.
995 message->context.data =
996 message->data->data() + message->data->size() - message->context.size;
Austin Schuha9df9ad2021-06-16 14:49:39 -0700997
998 DCHECK(channel()->has_schema())
999 << ": Missing schema for channel "
1000 << configuration::StrippedChannelToString(channel());
1001 DCHECK(flatbuffers::Verify(
1002 *channel()->schema(), *channel()->schema()->root_table(),
1003 static_cast<const uint8_t *>(message->context.data),
1004 message->context.size))
1005 << ": Corrupted flatbuffer on " << channel()->name()->c_str() << " "
1006 << channel()->type()->c_str();
1007
Alex Perrycb7da4b2019-08-28 19:35:56 -07001008 next_queue_index_ = next_queue_index_.Increment();
1009
Austin Schuhe6f4c8d2021-12-11 12:36:06 -08001010 latest_message_ = std::move(message);
Austin Schuh8fb315a2020-11-19 22:33:58 -08001011 for (SimulatedWatcher *watcher : watchers_) {
1012 if (watcher->has_run()) {
Austin Schuhe6f4c8d2021-12-11 12:36:06 -08001013 watcher->Schedule(latest_message_);
Alex Perrycb7da4b2019-08-28 19:35:56 -07001014 }
1015 }
1016 for (auto &fetcher : fetchers_) {
Austin Schuhe6f4c8d2021-12-11 12:36:06 -08001017 fetcher->Enqueue(latest_message_);
Alex Perrycb7da4b2019-08-28 19:35:56 -07001018 }
Austin Schuhad154822019-12-27 15:45:13 -08001019 return queue_index;
Alex Perrycb7da4b2019-08-28 19:35:56 -07001020}
1021
1022void SimulatedChannel::UnregisterFetcher(SimulatedFetcher *fetcher) {
1023 fetchers_.erase(::std::find(fetchers_.begin(), fetchers_.end(), fetcher));
1024}
1025
Austin Schuh8fb315a2020-11-19 22:33:58 -08001026SimulatedSender::SimulatedSender(SimulatedChannel *simulated_channel,
1027 SimulatedEventLoop *event_loop)
1028 : RawSender(event_loop, simulated_channel->channel()),
1029 simulated_channel_(simulated_channel),
Austin Schuh58646e22021-08-23 23:51:46 -07001030 simulated_event_loop_(event_loop) {
Austin Schuh8fb315a2020-11-19 22:33:58 -08001031 simulated_channel_->CountSenderCreated();
1032}
1033
1034SimulatedSender::~SimulatedSender() {
1035 simulated_channel_->CountSenderDestroyed();
1036}
1037
milind1f1dca32021-07-03 13:50:07 -07001038RawSender::Error SimulatedSender::DoSend(
1039 size_t length, monotonic_clock::time_point monotonic_remote_time,
1040 realtime_clock::time_point realtime_remote_time,
1041 uint32_t remote_queue_index, const UUID &source_boot_uuid) {
Austin Schuh9b1d6282022-06-10 17:03:21 -07001042 // The allocations in here are due to infrastructure and don't count in the
1043 // no mallocs in RT code.
1044 ScopedNotRealtime nrt;
1045
Austin Schuh58646e22021-08-23 23:51:46 -07001046 VLOG(1) << simulated_event_loop_->distributed_now() << " "
1047 << NodeName(simulated_event_loop_->node())
1048 << simulated_event_loop_->monotonic_now() << " "
1049 << simulated_event_loop_->name() << " Send "
1050 << configuration::StrippedChannelToString(channel());
1051
Austin Schuh8fb315a2020-11-19 22:33:58 -08001052 CHECK_LE(length, size()) << ": Attempting to send too big a message.";
Austin Schuh58646e22021-08-23 23:51:46 -07001053 message_->context.monotonic_event_time =
1054 simulated_event_loop_->monotonic_now();
Austin Schuh8fb315a2020-11-19 22:33:58 -08001055 message_->context.monotonic_remote_time = monotonic_remote_time;
1056 message_->context.remote_queue_index = remote_queue_index;
Austin Schuh58646e22021-08-23 23:51:46 -07001057 message_->context.realtime_event_time = simulated_event_loop_->realtime_now();
Austin Schuh8fb315a2020-11-19 22:33:58 -08001058 message_->context.realtime_remote_time = realtime_remote_time;
Austin Schuha9012be2021-07-21 15:19:11 -07001059 message_->context.source_boot_uuid = source_boot_uuid;
Austin Schuh8fb315a2020-11-19 22:33:58 -08001060 CHECK_LE(length, message_->context.size);
1061 message_->context.size = length;
1062
Austin Schuh60e77942022-05-16 17:48:24 -07001063 const std::optional<uint32_t> optional_queue_index = simulated_channel_->Send(
1064 message_, simulated_event_loop_->options().check_sent_too_fast);
milind1f1dca32021-07-03 13:50:07 -07001065
1066 // Check that we are not sending messages too fast
1067 if (!optional_queue_index) {
1068 VLOG(1) << simulated_event_loop_->distributed_now() << " "
1069 << NodeName(simulated_event_loop_->node())
1070 << simulated_event_loop_->monotonic_now() << " "
1071 << simulated_event_loop_->name()
1072 << "\nMessages were sent too fast:\n"
1073 << "For channel: "
1074 << configuration::CleanedChannelToString(
1075 simulated_channel_->channel())
1076 << '\n'
1077 << "Tried to send more than " << simulated_channel_->queue_size()
1078 << " (queue size) messages in the last "
1079 << std::chrono::duration<double>(
1080 simulated_channel_->channel_storage_duration())
1081 .count()
1082 << " seconds (channel storage duration)"
1083 << "\n\n";
1084 return Error::kMessagesSentTooFast;
1085 }
1086
1087 sent_queue_index_ = *optional_queue_index;
Austin Schuh58646e22021-08-23 23:51:46 -07001088 monotonic_sent_time_ = simulated_event_loop_->monotonic_now();
1089 realtime_sent_time_ = simulated_event_loop_->realtime_now();
Austin Schuh8fb315a2020-11-19 22:33:58 -08001090
1091 // Drop the reference to the message so that we allocate a new message for
1092 // next time. Otherwise we will continue to reuse the same memory for all
1093 // messages and corrupt it.
1094 message_.reset();
milind1f1dca32021-07-03 13:50:07 -07001095 return Error::kOk;
Austin Schuh8fb315a2020-11-19 22:33:58 -08001096}
1097
milind1f1dca32021-07-03 13:50:07 -07001098RawSender::Error SimulatedSender::DoSend(
1099 const void *msg, size_t size,
1100 monotonic_clock::time_point monotonic_remote_time,
1101 realtime_clock::time_point realtime_remote_time,
1102 uint32_t remote_queue_index, const UUID &source_boot_uuid) {
Austin Schuh102667e2020-12-11 20:13:28 -08001103 CHECK_LE(size, this->size())
1104 << ": Attempting to send too big a message on "
1105 << configuration::CleanedChannelToString(simulated_channel_->channel());
Austin Schuh8fb315a2020-11-19 22:33:58 -08001106
Tyler Chatowb7c6eba2021-07-28 14:43:23 -07001107 // Allocates an aligned buffer in which to copy unaligned msg.
1108 auto [span, mutable_span] = MakeSharedSpan(size);
1109 message_ = SimulatedMessage::Make(simulated_channel_, span);
Austin Schuh8fb315a2020-11-19 22:33:58 -08001110
1111 // Now fill in the message. size is already populated above, and
Tyler Chatowb7c6eba2021-07-28 14:43:23 -07001112 // queue_index will be populated in simulated_channel_.
1113 memcpy(mutable_span.data(), msg, size);
Austin Schuh8fb315a2020-11-19 22:33:58 -08001114
1115 return DoSend(size, monotonic_remote_time, realtime_remote_time,
Austin Schuha9012be2021-07-21 15:19:11 -07001116 remote_queue_index, source_boot_uuid);
Austin Schuh8fb315a2020-11-19 22:33:58 -08001117}
1118
milind1f1dca32021-07-03 13:50:07 -07001119RawSender::Error SimulatedSender::DoSend(
1120 const RawSender::SharedSpan data,
1121 monotonic_clock::time_point monotonic_remote_time,
1122 realtime_clock::time_point realtime_remote_time,
1123 uint32_t remote_queue_index, const UUID &source_boot_uuid) {
Tyler Chatowb7c6eba2021-07-28 14:43:23 -07001124 CHECK_LE(data->size(), this->size())
1125 << ": Attempting to send too big a message on "
1126 << configuration::CleanedChannelToString(simulated_channel_->channel());
1127
1128 // Constructs a message sharing the already allocated and aligned message
1129 // data.
1130 message_ = SimulatedMessage::Make(simulated_channel_, data);
1131
1132 return DoSend(data->size(), monotonic_remote_time, realtime_remote_time,
1133 remote_queue_index, source_boot_uuid);
1134}
1135
Austin Schuh39788ff2019-12-01 18:22:57 -08001136SimulatedTimerHandler::SimulatedTimerHandler(
Austin Schuh8bd96322020-02-13 21:18:22 -08001137 EventScheduler *scheduler, SimulatedEventLoop *simulated_event_loop,
1138 ::std::function<void()> fn)
Austin Schuh39788ff2019-12-01 18:22:57 -08001139 : TimerHandler(simulated_event_loop, std::move(fn)),
Austin Schuh7d87b672019-12-01 20:23:49 -08001140 simulated_event_loop_(simulated_event_loop),
1141 event_(this),
Austin Schuh39788ff2019-12-01 18:22:57 -08001142 scheduler_(scheduler),
1143 token_(scheduler_->InvalidToken()) {}
1144
Austin Schuhde8a8ff2019-11-30 15:25:36 -08001145void SimulatedTimerHandler::Setup(monotonic_clock::time_point base,
1146 monotonic_clock::duration repeat_offset) {
Austin Schuh62288252020-11-18 23:26:04 -08001147 // The allocations in here are due to infrastructure and don't count in the no
1148 // mallocs in RT code.
1149 ScopedNotRealtime nrt;
Austin Schuhde8a8ff2019-11-30 15:25:36 -08001150 Disable();
Austin Schuh58646e22021-08-23 23:51:46 -07001151 const monotonic_clock::time_point monotonic_now =
Austin Schuha5e14192020-01-06 18:02:41 -08001152 simulated_event_loop_->monotonic_now();
Austin Schuhde8a8ff2019-11-30 15:25:36 -08001153 base_ = base;
1154 repeat_offset_ = repeat_offset;
Austin Schuhef8f1ae2021-12-11 12:35:05 -08001155 token_ = scheduler_->Schedule(std::max(base, monotonic_now), this);
Austin Schuh7d87b672019-12-01 20:23:49 -08001156 event_.set_event_time(base_);
1157 simulated_event_loop_->AddEvent(&event_);
Austin Schuhde8a8ff2019-11-30 15:25:36 -08001158}
1159
Austin Schuhef8f1ae2021-12-11 12:35:05 -08001160void SimulatedTimerHandler::Handle() noexcept {
1161 DCHECK(token_ != scheduler_->InvalidToken());
1162 token_ = scheduler_->InvalidToken();
1163 simulated_event_loop_->HandleEvent();
1164}
1165
Austin Schuhf4b09c72021-12-08 12:04:37 -08001166void SimulatedTimerHandler::HandleEvent() noexcept {
Austin Schuh58646e22021-08-23 23:51:46 -07001167 const monotonic_clock::time_point monotonic_now =
Austin Schuha5e14192020-01-06 18:02:41 -08001168 simulated_event_loop_->monotonic_now();
Austin Schuh58646e22021-08-23 23:51:46 -07001169 VLOG(1) << simulated_event_loop_->distributed_now() << " "
1170 << NodeName(simulated_event_loop_->node()) << monotonic_now << " "
1171 << simulated_event_loop_->name() << " Timer '" << name() << "'";
Tyler Chatow67ddb032020-01-12 14:30:04 -08001172 logging::ScopedLogRestorer prev_logger;
Austin Schuha0c41ba2020-09-10 22:59:14 -07001173 if (simulated_event_loop_->log_impl_) {
1174 prev_logger.Swap(simulated_event_loop_->log_impl_);
Tyler Chatow67ddb032020-01-12 14:30:04 -08001175 }
Austin Schuheb4e4ce2020-09-10 23:04:18 -07001176 if (token_ != scheduler_->InvalidToken()) {
Austin Schuh9b1d6282022-06-10 17:03:21 -07001177 {
1178 ScopedNotRealtime nrt;
1179 scheduler_->Deschedule(token_);
1180 }
Austin Schuheb4e4ce2020-09-10 23:04:18 -07001181 token_ = scheduler_->InvalidToken();
1182 }
Austin Schuh58646e22021-08-23 23:51:46 -07001183 if (repeat_offset_ != monotonic_clock::zero()) {
Austin Schuhde8a8ff2019-11-30 15:25:36 -08001184 // Reschedule.
1185 while (base_ <= monotonic_now) base_ += repeat_offset_;
Austin Schuhef8f1ae2021-12-11 12:35:05 -08001186 token_ = scheduler_->Schedule(base_, this);
Austin Schuh7d87b672019-12-01 20:23:49 -08001187 event_.set_event_time(base_);
1188 simulated_event_loop_->AddEvent(&event_);
Austin Schuhde8a8ff2019-11-30 15:25:36 -08001189 }
Austin Schuhde8a8ff2019-11-30 15:25:36 -08001190
Austin Schuhcc6070c2020-10-10 20:25:56 -07001191 {
1192 ScopedMarkRealtimeRestorer rt(simulated_event_loop_->priority() > 0);
1193 Call([monotonic_now]() { return monotonic_now; }, monotonic_now);
1194 }
Austin Schuhde8a8ff2019-11-30 15:25:36 -08001195}
1196
Austin Schuh7d87b672019-12-01 20:23:49 -08001197void SimulatedTimerHandler::Disable() {
1198 simulated_event_loop_->RemoveEvent(&event_);
1199 if (token_ != scheduler_->InvalidToken()) {
Austin Schuh9b1d6282022-06-10 17:03:21 -07001200 {
1201 ScopedNotRealtime nrt;
1202 scheduler_->Deschedule(token_);
1203 }
Austin Schuh7d87b672019-12-01 20:23:49 -08001204 token_ = scheduler_->InvalidToken();
1205 }
1206}
1207
Austin Schuh39788ff2019-12-01 18:22:57 -08001208SimulatedPhasedLoopHandler::SimulatedPhasedLoopHandler(
Austin Schuh8bd96322020-02-13 21:18:22 -08001209 EventScheduler *scheduler, SimulatedEventLoop *simulated_event_loop,
1210 ::std::function<void(int)> fn, const monotonic_clock::duration interval,
Austin Schuh39788ff2019-12-01 18:22:57 -08001211 const monotonic_clock::duration offset)
1212 : PhasedLoopHandler(simulated_event_loop, std::move(fn), interval, offset),
1213 simulated_event_loop_(simulated_event_loop),
Austin Schuh7d87b672019-12-01 20:23:49 -08001214 event_(this),
Austin Schuh39788ff2019-12-01 18:22:57 -08001215 scheduler_(scheduler),
1216 token_(scheduler_->InvalidToken()) {}
1217
Austin Schuh7d87b672019-12-01 20:23:49 -08001218SimulatedPhasedLoopHandler::~SimulatedPhasedLoopHandler() {
1219 if (token_ != scheduler_->InvalidToken()) {
1220 scheduler_->Deschedule(token_);
1221 token_ = scheduler_->InvalidToken();
1222 }
1223 simulated_event_loop_->RemoveEvent(&event_);
1224}
1225
Austin Schuhf4b09c72021-12-08 12:04:37 -08001226void SimulatedPhasedLoopHandler::HandleEvent() noexcept {
Austin Schuh39788ff2019-12-01 18:22:57 -08001227 monotonic_clock::time_point monotonic_now =
1228 simulated_event_loop_->monotonic_now();
Austin Schuh057d29f2021-08-21 23:05:15 -07001229 VLOG(1) << monotonic_now << " Phased loop " << simulated_event_loop_->name()
1230 << ", " << name();
Tyler Chatow67ddb032020-01-12 14:30:04 -08001231 logging::ScopedLogRestorer prev_logger;
Austin Schuha0c41ba2020-09-10 22:59:14 -07001232 if (simulated_event_loop_->log_impl_) {
1233 prev_logger.Swap(simulated_event_loop_->log_impl_);
Tyler Chatow67ddb032020-01-12 14:30:04 -08001234 }
Austin Schuhcc6070c2020-10-10 20:25:56 -07001235
1236 {
1237 ScopedMarkRealtimeRestorer rt(simulated_event_loop_->priority() > 0);
1238 Call([monotonic_now]() { return monotonic_now; },
1239 [this](monotonic_clock::time_point sleep_time) {
1240 Schedule(sleep_time);
1241 });
1242 }
Austin Schuh39788ff2019-12-01 18:22:57 -08001243}
Austin Schuhde8a8ff2019-11-30 15:25:36 -08001244
Austin Schuhef8f1ae2021-12-11 12:35:05 -08001245void SimulatedPhasedLoopHandler::Handle() noexcept {
1246 DCHECK(token_ != scheduler_->InvalidToken());
1247 token_ = scheduler_->InvalidToken();
1248 simulated_event_loop_->HandleEvent();
1249}
1250
Austin Schuh7d87b672019-12-01 20:23:49 -08001251void SimulatedPhasedLoopHandler::Schedule(
1252 monotonic_clock::time_point sleep_time) {
Austin Schuh62288252020-11-18 23:26:04 -08001253 // The allocations in here are due to infrastructure and don't count in the no
1254 // mallocs in RT code.
1255 ScopedNotRealtime nrt;
Austin Schuheb4e4ce2020-09-10 23:04:18 -07001256 if (token_ != scheduler_->InvalidToken()) {
1257 scheduler_->Deschedule(token_);
1258 token_ = scheduler_->InvalidToken();
1259 }
Austin Schuhef8f1ae2021-12-11 12:35:05 -08001260 token_ = scheduler_->Schedule(sleep_time, this);
Austin Schuh7d87b672019-12-01 20:23:49 -08001261 event_.set_event_time(sleep_time);
1262 simulated_event_loop_->AddEvent(&event_);
1263}
1264
Alex Perrycb7da4b2019-08-28 19:35:56 -07001265SimulatedEventLoopFactory::SimulatedEventLoopFactory(
1266 const Configuration *configuration)
Austin Schuh6f3babe2020-01-26 20:34:50 -08001267 : configuration_(CHECK_NOTNULL(configuration)),
1268 nodes_(configuration::GetNodes(configuration_)) {
Austin Schuh094d09b2020-11-20 23:26:52 -08001269 CHECK(IsInitialized()) << ": Need to initialize AOS first.";
Austin Schuhac0771c2020-01-07 18:36:30 -08001270 for (const Node *node : nodes_) {
Austin Schuh58646e22021-08-23 23:51:46 -07001271 node_factories_.emplace_back(
1272 new NodeEventLoopFactory(&scheduler_scheduler_, this, node));
Austin Schuh15649d62019-12-28 16:36:38 -08001273 }
Austin Schuh898f4972020-01-11 17:21:25 -08001274
1275 if (configuration::MultiNode(configuration)) {
1276 bridge_ = std::make_unique<message_bridge::SimulatedMessageBridge>(this);
1277 }
Austin Schuh15649d62019-12-28 16:36:38 -08001278}
1279
Alex Perrycb7da4b2019-08-28 19:35:56 -07001280SimulatedEventLoopFactory::~SimulatedEventLoopFactory() {}
1281
Austin Schuhac0771c2020-01-07 18:36:30 -08001282NodeEventLoopFactory *SimulatedEventLoopFactory::GetNodeEventLoopFactory(
Austin Schuh057d29f2021-08-21 23:05:15 -07001283 std::string_view node) {
1284 return GetNodeEventLoopFactory(configuration::GetNode(configuration(), node));
1285}
1286
1287NodeEventLoopFactory *SimulatedEventLoopFactory::GetNodeEventLoopFactory(
Austin Schuhac0771c2020-01-07 18:36:30 -08001288 const Node *node) {
1289 auto result = std::find_if(
1290 node_factories_.begin(), node_factories_.end(),
1291 [node](const std::unique_ptr<NodeEventLoopFactory> &node_factory) {
1292 return node_factory->node() == node;
1293 });
1294
1295 CHECK(result != node_factories_.end())
1296 << ": Failed to find node " << FlatbufferToJson(node);
1297
1298 return result->get();
1299}
1300
Austin Schuh87dd3832021-01-01 23:07:31 -08001301void SimulatedEventLoopFactory::SetTimeConverter(
1302 TimeConverter *time_converter) {
1303 for (std::unique_ptr<NodeEventLoopFactory> &factory : node_factories_) {
1304 factory->SetTimeConverter(time_converter);
1305 }
Austin Schuh58646e22021-08-23 23:51:46 -07001306 scheduler_scheduler_.SetTimeConverter(time_converter);
Austin Schuh87dd3832021-01-01 23:07:31 -08001307}
1308
Austin Schuh5f1cc5c2019-12-01 18:01:11 -08001309::std::unique_ptr<EventLoop> SimulatedEventLoopFactory::MakeEventLoop(
Austin Schuhac0771c2020-01-07 18:36:30 -08001310 std::string_view name, const Node *node) {
1311 if (node == nullptr) {
1312 CHECK(!configuration::MultiNode(configuration()))
1313 << ": Can't make a single node event loop in a multi-node world.";
1314 } else {
1315 CHECK(configuration::MultiNode(configuration()))
1316 << ": Can't make a multi-node event loop in a single-node world.";
1317 }
1318 return GetNodeEventLoopFactory(node)->MakeEventLoop(name);
1319}
1320
Austin Schuh057d29f2021-08-21 23:05:15 -07001321NodeEventLoopFactory::NodeEventLoopFactory(
1322 EventSchedulerScheduler *scheduler_scheduler,
1323 SimulatedEventLoopFactory *factory, const Node *node)
Austin Schuh58646e22021-08-23 23:51:46 -07001324 : scheduler_(configuration::GetNodeIndex(factory->configuration(), node)),
1325 factory_(factory),
1326 node_(node) {
Austin Schuh057d29f2021-08-21 23:05:15 -07001327 scheduler_scheduler->AddEventScheduler(&scheduler_);
Austin Schuh58646e22021-08-23 23:51:46 -07001328 scheduler_.set_started([this]() {
1329 started_ = true;
1330 for (SimulatedEventLoop *event_loop : event_loops_) {
1331 event_loop->SetIsRunning(true);
1332 }
1333 });
Austin Schuhe33c08d2022-02-03 18:15:21 -08001334 scheduler_.set_stopped([this]() {
1335 for (SimulatedEventLoop *event_loop : event_loops_) {
1336 event_loop->SetIsRunning(false);
1337 }
1338 });
Austin Schuh58646e22021-08-23 23:51:46 -07001339 scheduler_.set_on_shutdown([this]() {
1340 VLOG(1) << scheduler_.distributed_now() << " " << NodeName(this->node())
1341 << monotonic_now() << " Shutting down node.";
1342 Shutdown();
1343 ScheduleStartup();
1344 });
1345 ScheduleStartup();
Austin Schuh057d29f2021-08-21 23:05:15 -07001346}
1347
1348NodeEventLoopFactory::~NodeEventLoopFactory() {
Austin Schuh58646e22021-08-23 23:51:46 -07001349 if (started_) {
1350 for (std::function<void()> &fn : on_shutdown_) {
1351 fn();
1352 }
1353
1354 VLOG(1) << scheduler_.distributed_now() << " " << NodeName(node())
1355 << monotonic_now() << " Shutting down applications.";
1356 applications_.clear();
1357 started_ = false;
1358 }
1359
1360 if (event_loops_.size() != 0u) {
1361 for (SimulatedEventLoop *event_loop : event_loops_) {
1362 LOG(ERROR) << scheduler_.distributed_now() << " " << NodeName(node())
1363 << monotonic_now() << " Event loop '" << event_loop->name()
1364 << "' failed to shut down";
1365 }
1366 }
Austin Schuh057d29f2021-08-21 23:05:15 -07001367 CHECK_EQ(event_loops_.size(), 0u) << "Event loop didn't exit";
1368}
1369
Austin Schuh58646e22021-08-23 23:51:46 -07001370void NodeEventLoopFactory::OnStartup(std::function<void()> &&fn) {
Austin Schuh8bd96322020-02-13 21:18:22 -08001371 CHECK(!scheduler_.is_running())
Austin Schuh58646e22021-08-23 23:51:46 -07001372 << ": Can only register OnStartup handlers when not running.";
1373 on_startup_.emplace_back(std::move(fn));
1374 if (started_) {
1375 size_t on_startup_index = on_startup_.size() - 1;
1376 scheduler_.ScheduleOnStartup(
1377 [this, on_startup_index]() { on_startup_[on_startup_index](); });
1378 }
Alex Perrycb7da4b2019-08-28 19:35:56 -07001379}
1380
Austin Schuh58646e22021-08-23 23:51:46 -07001381void NodeEventLoopFactory::OnShutdown(std::function<void()> &&fn) {
1382 on_shutdown_.emplace_back(std::move(fn));
Austin Schuhc0b0f722020-12-12 18:36:06 -08001383}
Austin Schuh057d29f2021-08-21 23:05:15 -07001384
Austin Schuh58646e22021-08-23 23:51:46 -07001385void NodeEventLoopFactory::ScheduleStartup() {
1386 scheduler_.ScheduleOnStartup([this]() {
1387 UUID next_uuid = scheduler_.boot_uuid();
1388 if (boot_uuid_ != next_uuid) {
Austin Schuh188a2f62021-11-08 10:45:54 -08001389 CHECK_EQ(boot_uuid_, UUID::Zero())
1390 << ": Boot UUID changed without restarting. Did TimeConverter "
1391 "change the boot UUID without signaling a restart, or did you "
1392 "change TimeConverter?";
Austin Schuh58646e22021-08-23 23:51:46 -07001393 boot_uuid_ = next_uuid;
1394 }
1395 VLOG(1) << scheduler_.distributed_now() << " " << NodeName(this->node())
1396 << monotonic_now() << " Starting up node on boot " << boot_uuid_;
1397 Startup();
1398 });
1399}
1400
1401void NodeEventLoopFactory::Startup() {
1402 CHECK(!started_);
1403 for (size_t i = 0; i < on_startup_.size(); ++i) {
1404 on_startup_[i]();
1405 }
1406}
1407
1408void NodeEventLoopFactory::Shutdown() {
1409 for (SimulatedEventLoop *event_loop : event_loops_) {
Austin Schuhe33c08d2022-02-03 18:15:21 -08001410 CHECK(!event_loop->is_running());
Austin Schuh58646e22021-08-23 23:51:46 -07001411 }
1412
1413 CHECK(started_);
1414 started_ = false;
1415 for (std::function<void()> &fn : on_shutdown_) {
1416 fn();
1417 }
1418
1419 VLOG(1) << scheduler_.distributed_now() << " " << NodeName(node())
1420 << monotonic_now() << " Shutting down applications.";
1421 applications_.clear();
1422
1423 if (event_loops_.size() != 0u) {
1424 for (SimulatedEventLoop *event_loop : event_loops_) {
1425 LOG(ERROR) << scheduler_.distributed_now() << " " << NodeName(node())
1426 << monotonic_now() << " Event loop '" << event_loop->name()
1427 << "' failed to shut down";
1428 }
1429 }
1430 CHECK_EQ(event_loops_.size(), 0u) << "Not all event loops shut down";
1431 boot_uuid_ = UUID::Zero();
1432
1433 channels_.clear();
Austin Schuhc0b0f722020-12-12 18:36:06 -08001434}
1435
Alex Perrycb7da4b2019-08-28 19:35:56 -07001436void SimulatedEventLoopFactory::RunFor(monotonic_clock::duration duration) {
Austin Schuh58646e22021-08-23 23:51:46 -07001437 // This sets running to true too.
Austin Schuh8bd96322020-02-13 21:18:22 -08001438 scheduler_scheduler_.RunFor(duration);
Austin Schuh057d29f2021-08-21 23:05:15 -07001439 for (std::unique_ptr<NodeEventLoopFactory> &node : node_factories_) {
1440 if (node) {
1441 for (SimulatedEventLoop *loop : node->event_loops_) {
Austin Schuhe33c08d2022-02-03 18:15:21 -08001442 CHECK(!loop->is_running());
Austin Schuh057d29f2021-08-21 23:05:15 -07001443 }
1444 }
Alex Perrycb7da4b2019-08-28 19:35:56 -07001445 }
1446}
1447
1448void SimulatedEventLoopFactory::Run() {
Austin Schuh58646e22021-08-23 23:51:46 -07001449 // This sets running to true too.
Austin Schuh8bd96322020-02-13 21:18:22 -08001450 scheduler_scheduler_.Run();
Austin Schuh057d29f2021-08-21 23:05:15 -07001451 for (std::unique_ptr<NodeEventLoopFactory> &node : node_factories_) {
1452 if (node) {
1453 for (SimulatedEventLoop *loop : node->event_loops_) {
Austin Schuhe33c08d2022-02-03 18:15:21 -08001454 CHECK(!loop->is_running());
Austin Schuh057d29f2021-08-21 23:05:15 -07001455 }
1456 }
Alex Perrycb7da4b2019-08-28 19:35:56 -07001457 }
1458}
1459
Austin Schuh87dd3832021-01-01 23:07:31 -08001460void SimulatedEventLoopFactory::Exit() { scheduler_scheduler_.Exit(); }
Austin Schuh8fb315a2020-11-19 22:33:58 -08001461
Austin Schuh6f3babe2020-01-26 20:34:50 -08001462void SimulatedEventLoopFactory::DisableForwarding(const Channel *channel) {
Austin Schuh4c3b9702020-08-30 11:34:55 -07001463 CHECK(bridge_) << ": Can't disable forwarding without a message bridge.";
Austin Schuh6f3babe2020-01-26 20:34:50 -08001464 bridge_->DisableForwarding(channel);
1465}
1466
Austin Schuh4c3b9702020-08-30 11:34:55 -07001467void SimulatedEventLoopFactory::DisableStatistics() {
1468 CHECK(bridge_) << ": Can't disable statistics without a message bridge.";
1469 bridge_->DisableStatistics();
1470}
1471
Austin Schuh48205e62021-11-12 14:13:18 -08001472void SimulatedEventLoopFactory::EnableStatistics() {
1473 CHECK(bridge_) << ": Can't enable statistics without a message bridge.";
1474 bridge_->EnableStatistics();
1475}
1476
Austin Schuh2928ebe2021-02-07 22:10:27 -08001477void SimulatedEventLoopFactory::SkipTimingReport() {
1478 CHECK(bridge_) << ": Can't skip timing reports without a message bridge.";
Austin Schuh48205e62021-11-12 14:13:18 -08001479
1480 for (std::unique_ptr<NodeEventLoopFactory> &node : node_factories_) {
1481 if (node) {
1482 node->SkipTimingReport();
1483 }
1484 }
1485}
1486
1487void NodeEventLoopFactory::SkipTimingReport() {
1488 for (SimulatedEventLoop *event_loop : event_loops_) {
1489 event_loop->SkipTimingReport();
1490 }
1491 skip_timing_report_ = true;
1492}
1493
1494void NodeEventLoopFactory::EnableStatistics() {
1495 CHECK(factory_->bridge_)
1496 << ": Can't enable statistics without a message bridge.";
1497 factory_->bridge_->EnableStatistics(node_);
1498}
1499
1500void NodeEventLoopFactory::DisableStatistics() {
1501 CHECK(factory_->bridge_)
1502 << ": Can't disable statistics without a message bridge.";
1503 factory_->bridge_->DisableStatistics(node_);
Austin Schuh2928ebe2021-02-07 22:10:27 -08001504}
1505
Austin Schuh58646e22021-08-23 23:51:46 -07001506::std::unique_ptr<EventLoop> NodeEventLoopFactory::MakeEventLoop(
James Kuszmaul890c2492022-04-06 14:59:31 -07001507 std::string_view name, EventLoopOptions options) {
Austin Schuh58646e22021-08-23 23:51:46 -07001508 CHECK(!scheduler_.is_running() || !started_)
1509 << ": Can't create an event loop while running";
1510
1511 pid_t tid = tid_;
1512 ++tid_;
1513 ::std::unique_ptr<SimulatedEventLoop> result(new SimulatedEventLoop(
1514 &scheduler_, this, &channels_, factory_->configuration(), &event_loops_,
James Kuszmaul890c2492022-04-06 14:59:31 -07001515 node_, tid, options));
Austin Schuh58646e22021-08-23 23:51:46 -07001516 result->set_name(name);
1517 result->set_send_delay(factory_->send_delay());
Austin Schuh48205e62021-11-12 14:13:18 -08001518 if (skip_timing_report_) {
1519 result->SkipTimingReport();
1520 }
Austin Schuh58646e22021-08-23 23:51:46 -07001521
1522 VLOG(1) << scheduler_.distributed_now() << " " << NodeName(node())
1523 << monotonic_now() << " MakeEventLoop(\"" << result->name() << "\")";
1524 return std::move(result);
1525}
1526
Austin Schuhe33c08d2022-02-03 18:15:21 -08001527void SimulatedEventLoopFactory::AllowApplicationCreationDuring(
1528 std::function<void()> fn) {
1529 scheduler_scheduler_.TemporarilyStopAndRun(std::move(fn));
1530}
1531
Austin Schuh58646e22021-08-23 23:51:46 -07001532void NodeEventLoopFactory::Disconnect(const Node *other) {
1533 factory_->bridge_->Disconnect(node_, other);
1534}
1535
1536void NodeEventLoopFactory::Connect(const Node *other) {
1537 factory_->bridge_->Connect(node_, other);
1538}
1539
Alex Perrycb7da4b2019-08-28 19:35:56 -07001540} // namespace aos