blob: 6bf3ec12812f9522cf680343633720f915726990 [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 {
188 return channel()->frequency() *
189 std::chrono::duration_cast<std::chrono::duration<double>>(
190 channel_storage_duration_)
191 .count();
192 }
193
milind1f1dca32021-07-03 13:50:07 -0700194 std::chrono::nanoseconds channel_storage_duration() const {
195 return channel_storage_duration_;
196 }
197
Brian Silverman661eb8d2020-08-12 19:41:01 -0700198 // The number of extra buffers (beyond the queue) we pretend to have.
199 int number_scratch_buffers() const {
200 // We need to start creating messages before we know how many
201 // senders+readers we'll have, so we need to just pick something which is
202 // always big enough.
203 return 50;
204 }
205
206 int number_buffers() const { return queue_size() + number_scratch_buffers(); }
207
208 int GetBufferIndex() {
209 CHECK(!available_buffer_indices_.empty()) << ": This should be impossible";
210 const int result = available_buffer_indices_.back();
211 available_buffer_indices_.pop_back();
212 return result;
213 }
214
215 void FreeBufferIndex(int i) {
Austin Schuhc5047ea2021-03-20 22:00:21 -0700216 // This extra checking has a large performance hit with sanitizers that
217 // track memory accesses, so just skip it.
218#if !__has_feature(memory_sanitizer) && !__has_feature(address_sanitizer)
Brian Silverman661eb8d2020-08-12 19:41:01 -0700219 DCHECK(std::find(available_buffer_indices_.begin(),
220 available_buffer_indices_.end(),
221 i) == available_buffer_indices_.end())
222 << ": Buffer is not in use: " << i;
Brian Silvermanf3e6df22021-01-19 15:02:21 -0800223#endif
Brian Silverman661eb8d2020-08-12 19:41:01 -0700224 available_buffer_indices_.push_back(i);
225 }
Alex Perrycb7da4b2019-08-28 19:35:56 -0700226
227 // Makes a connected raw sender which calls Send below.
Austin Schuh8fb315a2020-11-19 22:33:58 -0800228 ::std::unique_ptr<RawSender> MakeRawSender(SimulatedEventLoop *event_loop);
Alex Perrycb7da4b2019-08-28 19:35:56 -0700229
230 // Makes a connected raw fetcher.
Austin Schuh39788ff2019-12-01 18:22:57 -0800231 ::std::unique_ptr<RawFetcher> MakeRawFetcher(EventLoop *event_loop);
Alex Perrycb7da4b2019-08-28 19:35:56 -0700232
233 // Registers a watcher for the queue.
Austin Schuh7d87b672019-12-01 20:23:49 -0800234 void MakeRawWatcher(SimulatedWatcher *watcher);
Austin Schuh39788ff2019-12-01 18:22:57 -0800235
Austin Schuh7d87b672019-12-01 20:23:49 -0800236 void RemoveWatcher(SimulatedWatcher *watcher) {
Austin Schuh39788ff2019-12-01 18:22:57 -0800237 watchers_.erase(std::find(watchers_.begin(), watchers_.end(), watcher));
238 }
Alex Perrycb7da4b2019-08-28 19:35:56 -0700239
Austin Schuhad154822019-12-27 15:45:13 -0800240 // Sends the message to all the connected receivers and fetchers. Returns the
milind1f1dca32021-07-03 13:50:07 -0700241 // sent queue index, or std::nullopt if messages were sent too fast.
James Kuszmaul890c2492022-04-06 14:59:31 -0700242 std::optional<uint32_t> Send(std::shared_ptr<SimulatedMessage> message,
243 CheckSentTooFast check_sent_too_fast);
Alex Perrycb7da4b2019-08-28 19:35:56 -0700244
245 // Unregisters a fetcher.
246 void UnregisterFetcher(SimulatedFetcher *fetcher);
247
248 std::shared_ptr<SimulatedMessage> latest_message() { return latest_message_; }
249
Austin Schuh39788ff2019-12-01 18:22:57 -0800250 size_t max_size() const { return channel()->max_size(); }
Alex Perrycb7da4b2019-08-28 19:35:56 -0700251
Austin Schuh5f1cc5c2019-12-01 18:01:11 -0800252 const std::string_view name() const {
Austin Schuh39788ff2019-12-01 18:22:57 -0800253 return channel()->name()->string_view();
Alex Perrycb7da4b2019-08-28 19:35:56 -0700254 }
255
Austin Schuh39788ff2019-12-01 18:22:57 -0800256 const Channel *channel() const { return channel_; }
257
Austin Schuhe516ab02020-05-06 21:37:04 -0700258 void CountSenderCreated() {
Brian Silverman661eb8d2020-08-12 19:41:01 -0700259 CheckBufferCount();
Austin Schuhe516ab02020-05-06 21:37:04 -0700260 if (sender_count_ >= channel()->num_senders()) {
261 LOG(FATAL) << "Failed to create sender on "
262 << configuration::CleanedChannelToString(channel())
263 << ", too many senders.";
264 }
265 ++sender_count_;
266 }
Brian Silverman77162972020-08-12 19:52:40 -0700267
Austin Schuhe516ab02020-05-06 21:37:04 -0700268 void CountSenderDestroyed() {
269 --sender_count_;
270 CHECK_GE(sender_count_, 0);
James Kuszmaul890c2492022-04-06 14:59:31 -0700271 if (sender_count_ == 0) {
272 allow_new_senders_ = true;
273 }
Austin Schuhe516ab02020-05-06 21:37:04 -0700274 }
275
Alex Perrycb7da4b2019-08-28 19:35:56 -0700276 private:
Brian Silverman77162972020-08-12 19:52:40 -0700277 void CheckBufferCount() {
278 int reader_count = 0;
279 if (channel()->read_method() == ReadMethod::PIN) {
280 reader_count = watchers_.size() + fetchers_.size();
281 }
282 CHECK_LT(reader_count + sender_count_, number_scratch_buffers());
283 }
284
285 void CheckReaderCount() {
286 if (channel()->read_method() != ReadMethod::PIN) {
287 return;
288 }
289 CheckBufferCount();
290 const int reader_count = watchers_.size() + fetchers_.size();
291 if (reader_count >= channel()->num_readers()) {
292 LOG(FATAL) << "Failed to create reader on "
293 << configuration::CleanedChannelToString(channel())
294 << ", too many readers.";
295 }
296 }
Brian Silverman661eb8d2020-08-12 19:41:01 -0700297
298 const Channel *const channel_;
Brian Silverman661eb8d2020-08-12 19:41:01 -0700299 const std::chrono::nanoseconds channel_storage_duration_;
Alex Perrycb7da4b2019-08-28 19:35:56 -0700300
301 // List of all watchers.
Austin Schuh7d87b672019-12-01 20:23:49 -0800302 ::std::vector<SimulatedWatcher *> watchers_;
Alex Perrycb7da4b2019-08-28 19:35:56 -0700303
304 // List of all fetchers.
305 ::std::vector<SimulatedFetcher *> fetchers_;
306 std::shared_ptr<SimulatedMessage> latest_message_;
Alex Perrycb7da4b2019-08-28 19:35:56 -0700307
308 ipc_lib::QueueIndex next_queue_index_;
Austin Schuhe516ab02020-05-06 21:37:04 -0700309
310 int sender_count_ = 0;
James Kuszmaul890c2492022-04-06 14:59:31 -0700311 // Used to track when an exclusive sender has been created (e.g., for log
312 // replay) and we want to prevent new senders from being accidentally created.
313 bool allow_new_senders_ = true;
Brian Silverman661eb8d2020-08-12 19:41:01 -0700314
315 std::vector<uint16_t> available_buffer_indices_;
Eric Schmiedebergef44b8a2022-02-28 17:30:38 -0700316
317 const EventScheduler *scheduler_;
318
319 // Queue of all the message send times in the last channel_storage_duration_
320 std::queue<monotonic_clock::time_point> last_times_;
Alex Perrycb7da4b2019-08-28 19:35:56 -0700321};
322
323namespace {
324
Brian Silverman661eb8d2020-08-12 19:41:01 -0700325std::shared_ptr<SimulatedMessage> SimulatedMessage::Make(
Tyler Chatowb7c6eba2021-07-28 14:43:23 -0700326 SimulatedChannel *channel, RawSender::SharedSpan data) {
Austin Schuh62288252020-11-18 23:26:04 -0800327 // The allocations in here are due to infrastructure and don't count in the no
328 // mallocs in RT code.
329 ScopedNotRealtime nrt;
Alex Perrycb7da4b2019-08-28 19:35:56 -0700330
Tyler Chatowb7c6eba2021-07-28 14:43:23 -0700331 auto message = std::make_shared<SimulatedMessage>(channel);
332 message->context.size = data->size();
333 message->context.data = data->data();
334 message->data = std::move(data);
335
336 return message;
Brian Silverman661eb8d2020-08-12 19:41:01 -0700337}
338
339SimulatedMessage::SimulatedMessage(SimulatedChannel *channel_in)
340 : channel(channel_in) {
Brian Silverman4f4e0612020-08-12 19:54:41 -0700341 context.buffer_index = channel->GetBufferIndex();
Brian Silverman661eb8d2020-08-12 19:41:01 -0700342}
343
344SimulatedMessage::~SimulatedMessage() {
Brian Silverman4f4e0612020-08-12 19:54:41 -0700345 channel->FreeBufferIndex(context.buffer_index);
Alex Perrycb7da4b2019-08-28 19:35:56 -0700346}
347
348class SimulatedSender : public RawSender {
349 public:
Austin Schuh8fb315a2020-11-19 22:33:58 -0800350 SimulatedSender(SimulatedChannel *simulated_channel,
351 SimulatedEventLoop *event_loop);
352 ~SimulatedSender() override;
Alex Perrycb7da4b2019-08-28 19:35:56 -0700353
354 void *data() override {
355 if (!message_) {
Austin Schuh9b1d6282022-06-10 17:03:21 -0700356 // This API is safe to use in a RT context on a RT system. So annotate it
357 // accordingly.
358 ScopedNotRealtime nrt;
359
Tyler Chatowb7c6eba2021-07-28 14:43:23 -0700360 auto [span, mutable_span] =
361 MakeSharedSpan(simulated_channel_->max_size());
362 message_ = SimulatedMessage::Make(simulated_channel_, span);
363 message_->mutable_data = mutable_span;
Alex Perrycb7da4b2019-08-28 19:35:56 -0700364 }
Tyler Chatowb7c6eba2021-07-28 14:43:23 -0700365 CHECK(message_->is_mutable());
366 return message_->mutable_data.data();
Alex Perrycb7da4b2019-08-28 19:35:56 -0700367 }
368
369 size_t size() override { return simulated_channel_->max_size(); }
370
milind1f1dca32021-07-03 13:50:07 -0700371 Error DoSend(size_t length, monotonic_clock::time_point monotonic_remote_time,
372 realtime_clock::time_point realtime_remote_time,
373 uint32_t remote_queue_index,
374 const UUID &source_boot_uuid) override;
Alex Perrycb7da4b2019-08-28 19:35:56 -0700375
milind1f1dca32021-07-03 13:50:07 -0700376 Error DoSend(const void *msg, size_t size,
377 monotonic_clock::time_point monotonic_remote_time,
378 realtime_clock::time_point realtime_remote_time,
379 uint32_t remote_queue_index,
380 const UUID &source_boot_uuid) override;
Alex Perrycb7da4b2019-08-28 19:35:56 -0700381
milind1f1dca32021-07-03 13:50:07 -0700382 Error DoSend(const SharedSpan data,
383 aos::monotonic_clock::time_point monotonic_remote_time,
384 aos::realtime_clock::time_point realtime_remote_time,
385 uint32_t remote_queue_index,
386 const UUID &source_boot_uuid) override;
Tyler Chatowb7c6eba2021-07-28 14:43:23 -0700387
Brian Silverman4f4e0612020-08-12 19:54:41 -0700388 int buffer_index() override {
389 // First, ensure message_ is allocated.
390 data();
391 return message_->context.buffer_index;
392 }
393
Alex Perrycb7da4b2019-08-28 19:35:56 -0700394 private:
395 SimulatedChannel *simulated_channel_;
Austin Schuh58646e22021-08-23 23:51:46 -0700396 SimulatedEventLoop *simulated_event_loop_;
Alex Perrycb7da4b2019-08-28 19:35:56 -0700397
398 std::shared_ptr<SimulatedMessage> message_;
399};
400} // namespace
401
402class SimulatedFetcher : public RawFetcher {
403 public:
Austin Schuhac0771c2020-01-07 18:36:30 -0800404 explicit SimulatedFetcher(EventLoop *event_loop,
405 SimulatedChannel *simulated_channel)
406 : RawFetcher(event_loop, simulated_channel->channel()),
407 simulated_channel_(simulated_channel) {}
408 ~SimulatedFetcher() { simulated_channel_->UnregisterFetcher(this); }
Alex Perrycb7da4b2019-08-28 19:35:56 -0700409
Austin Schuh39788ff2019-12-01 18:22:57 -0800410 std::pair<bool, monotonic_clock::time_point> DoFetchNext() override {
Austin Schuh62288252020-11-18 23:26:04 -0800411 // The allocations in here are due to infrastructure and don't count in the
412 // no mallocs in RT code.
413 ScopedNotRealtime nrt;
Austin Schuh39788ff2019-12-01 18:22:57 -0800414 if (msgs_.size() == 0) {
415 return std::make_pair(false, monotonic_clock::min_time);
416 }
Alex Perrycb7da4b2019-08-28 19:35:56 -0700417
James Kuszmaulbcd96fc2020-10-12 20:29:32 -0700418 CHECK(!fell_behind_) << ": Got behind on "
419 << configuration::StrippedChannelToString(
420 simulated_channel_->channel());
Brian Silverman661eb8d2020-08-12 19:41:01 -0700421
Alex Perrycb7da4b2019-08-28 19:35:56 -0700422 SetMsg(msgs_.front());
423 msgs_.pop_front();
Austin Schuha5e14192020-01-06 18:02:41 -0800424 return std::make_pair(true, event_loop()->monotonic_now());
Alex Perrycb7da4b2019-08-28 19:35:56 -0700425 }
426
Austin Schuh39788ff2019-12-01 18:22:57 -0800427 std::pair<bool, monotonic_clock::time_point> DoFetch() override {
Austin Schuh62288252020-11-18 23:26:04 -0800428 // The allocations in here are due to infrastructure and don't count in the
429 // no mallocs in RT code.
430 ScopedNotRealtime nrt;
Alex Perrycb7da4b2019-08-28 19:35:56 -0700431 if (msgs_.size() == 0) {
Austin Schuh7d87b672019-12-01 20:23:49 -0800432 // TODO(austin): Can we just do this logic unconditionally? It is a lot
433 // simpler. And call clear, obviously.
Austin Schuhac0771c2020-01-07 18:36:30 -0800434 if (!msg_ && simulated_channel_->latest_message()) {
435 SetMsg(simulated_channel_->latest_message());
Austin Schuha5e14192020-01-06 18:02:41 -0800436 return std::make_pair(true, event_loop()->monotonic_now());
Alex Perrycb7da4b2019-08-28 19:35:56 -0700437 } else {
Austin Schuh39788ff2019-12-01 18:22:57 -0800438 return std::make_pair(false, monotonic_clock::min_time);
Alex Perrycb7da4b2019-08-28 19:35:56 -0700439 }
440 }
441
442 // We've had a message enqueued, so we don't need to go looking for the
443 // latest message from before we started.
444 SetMsg(msgs_.back());
445 msgs_.clear();
Brian Silverman661eb8d2020-08-12 19:41:01 -0700446 fell_behind_ = false;
Austin Schuha5e14192020-01-06 18:02:41 -0800447 return std::make_pair(true, event_loop()->monotonic_now());
Alex Perrycb7da4b2019-08-28 19:35:56 -0700448 }
449
450 private:
451 friend class SimulatedChannel;
452
453 // Updates the state inside RawFetcher to point to the data in msg_.
454 void SetMsg(std::shared_ptr<SimulatedMessage> msg) {
Austin Schuhe6f4c8d2021-12-11 12:36:06 -0800455 msg_ = std::move(msg);
Alex Perrycb7da4b2019-08-28 19:35:56 -0700456 context_ = msg_->context;
Brian Silverman4f4e0612020-08-12 19:54:41 -0700457 if (channel()->read_method() != ReadMethod::PIN) {
458 context_.buffer_index = -1;
459 }
Austin Schuhad154822019-12-27 15:45:13 -0800460 if (context_.remote_queue_index == 0xffffffffu) {
461 context_.remote_queue_index = context_.queue_index;
462 }
Austin Schuh58646e22021-08-23 23:51:46 -0700463 if (context_.monotonic_remote_time == monotonic_clock::min_time) {
Austin Schuhad154822019-12-27 15:45:13 -0800464 context_.monotonic_remote_time = context_.monotonic_event_time;
465 }
Austin Schuh58646e22021-08-23 23:51:46 -0700466 if (context_.realtime_remote_time == realtime_clock::min_time) {
Austin Schuhad154822019-12-27 15:45:13 -0800467 context_.realtime_remote_time = context_.realtime_event_time;
468 }
Alex Perrycb7da4b2019-08-28 19:35:56 -0700469 }
470
471 // Internal method for Simulation to add a message to the buffer.
472 void Enqueue(std::shared_ptr<SimulatedMessage> buffer) {
Austin Schuhe6f4c8d2021-12-11 12:36:06 -0800473 msgs_.emplace_back(std::move(buffer));
Brian Silverman661eb8d2020-08-12 19:41:01 -0700474 if (fell_behind_ ||
475 msgs_.size() > static_cast<size_t>(simulated_channel_->queue_size())) {
476 fell_behind_ = true;
477 // Might as well empty out all the intermediate messages now.
478 while (msgs_.size() > 1) {
479 msgs_.pop_front();
480 }
481 }
Alex Perrycb7da4b2019-08-28 19:35:56 -0700482 }
483
Austin Schuhac0771c2020-01-07 18:36:30 -0800484 SimulatedChannel *simulated_channel_;
Alex Perrycb7da4b2019-08-28 19:35:56 -0700485 std::shared_ptr<SimulatedMessage> msg_;
486
487 // Messages queued up but not in use.
488 ::std::deque<std::shared_ptr<SimulatedMessage>> msgs_;
Brian Silverman661eb8d2020-08-12 19:41:01 -0700489
490 // Whether we're currently "behind", which means a FetchNext call will fail.
491 bool fell_behind_ = false;
Alex Perrycb7da4b2019-08-28 19:35:56 -0700492};
493
Austin Schuhef8f1ae2021-12-11 12:35:05 -0800494class SimulatedTimerHandler : public TimerHandler,
495 public EventScheduler::Event {
Alex Perrycb7da4b2019-08-28 19:35:56 -0700496 public:
497 explicit SimulatedTimerHandler(EventScheduler *scheduler,
Austin Schuhde8a8ff2019-11-30 15:25:36 -0800498 SimulatedEventLoop *simulated_event_loop,
Austin Schuh39788ff2019-12-01 18:22:57 -0800499 ::std::function<void()> fn);
Austin Schuh7d87b672019-12-01 20:23:49 -0800500 ~SimulatedTimerHandler() { Disable(); }
Alex Perrycb7da4b2019-08-28 19:35:56 -0700501
502 void Setup(monotonic_clock::time_point base,
Austin Schuhde8a8ff2019-11-30 15:25:36 -0800503 monotonic_clock::duration repeat_offset) override;
Alex Perrycb7da4b2019-08-28 19:35:56 -0700504
Austin Schuhf4b09c72021-12-08 12:04:37 -0800505 void HandleEvent() noexcept;
Alex Perrycb7da4b2019-08-28 19:35:56 -0700506
Austin Schuhef8f1ae2021-12-11 12:35:05 -0800507 void Handle() noexcept override;
508
Austin Schuh7d87b672019-12-01 20:23:49 -0800509 void Disable() override;
Alex Perrycb7da4b2019-08-28 19:35:56 -0700510
Alex Perrycb7da4b2019-08-28 19:35:56 -0700511 private:
Austin Schuh7d87b672019-12-01 20:23:49 -0800512 SimulatedEventLoop *simulated_event_loop_;
513 EventHandler<SimulatedTimerHandler> event_;
Alex Perrycb7da4b2019-08-28 19:35:56 -0700514 EventScheduler *scheduler_;
515 EventScheduler::Token token_;
Austin Schuhde8a8ff2019-11-30 15:25:36 -0800516
Alex Perrycb7da4b2019-08-28 19:35:56 -0700517 monotonic_clock::time_point base_;
518 monotonic_clock::duration repeat_offset_;
519};
520
Austin Schuhef8f1ae2021-12-11 12:35:05 -0800521class SimulatedPhasedLoopHandler : public PhasedLoopHandler,
522 public EventScheduler::Event {
Alex Perrycb7da4b2019-08-28 19:35:56 -0700523 public:
524 SimulatedPhasedLoopHandler(EventScheduler *scheduler,
Austin Schuhde8a8ff2019-11-30 15:25:36 -0800525 SimulatedEventLoop *simulated_event_loop,
Alex Perrycb7da4b2019-08-28 19:35:56 -0700526 ::std::function<void(int)> fn,
527 const monotonic_clock::duration interval,
Austin Schuh39788ff2019-12-01 18:22:57 -0800528 const monotonic_clock::duration offset);
Austin Schuh7d87b672019-12-01 20:23:49 -0800529 ~SimulatedPhasedLoopHandler();
Alex Perrycb7da4b2019-08-28 19:35:56 -0700530
Austin Schuhf4b09c72021-12-08 12:04:37 -0800531 void HandleEvent() noexcept;
Alex Perrycb7da4b2019-08-28 19:35:56 -0700532
Austin Schuh7d87b672019-12-01 20:23:49 -0800533 void Schedule(monotonic_clock::time_point sleep_time) override;
Alex Perrycb7da4b2019-08-28 19:35:56 -0700534
Austin Schuhef8f1ae2021-12-11 12:35:05 -0800535 void Handle() noexcept override;
536
Alex Perrycb7da4b2019-08-28 19:35:56 -0700537 private:
Austin Schuh39788ff2019-12-01 18:22:57 -0800538 SimulatedEventLoop *simulated_event_loop_;
Austin Schuh7d87b672019-12-01 20:23:49 -0800539 EventHandler<SimulatedPhasedLoopHandler> event_;
Alex Perrycb7da4b2019-08-28 19:35:56 -0700540
Austin Schuh39788ff2019-12-01 18:22:57 -0800541 EventScheduler *scheduler_;
542 EventScheduler::Token token_;
Alex Perrycb7da4b2019-08-28 19:35:56 -0700543};
544
545class SimulatedEventLoop : public EventLoop {
546 public:
547 explicit SimulatedEventLoop(
Brian Silverman661eb8d2020-08-12 19:41:01 -0700548 EventScheduler *scheduler, NodeEventLoopFactory *node_event_loop_factory,
Alex Perrycb7da4b2019-08-28 19:35:56 -0700549 absl::btree_map<SimpleChannel, std::unique_ptr<SimulatedChannel>>
550 *channels,
551 const Configuration *configuration,
Austin Schuh057d29f2021-08-21 23:05:15 -0700552 std::vector<SimulatedEventLoop *> *event_loops_, const Node *node,
James Kuszmaul890c2492022-04-06 14:59:31 -0700553 pid_t tid, EventLoopOptions options)
Austin Schuh83c7f702021-01-19 22:36:29 -0800554 : EventLoop(CHECK_NOTNULL(configuration)),
Alex Perrycb7da4b2019-08-28 19:35:56 -0700555 scheduler_(scheduler),
Austin Schuhac0771c2020-01-07 18:36:30 -0800556 node_event_loop_factory_(node_event_loop_factory),
Alex Perrycb7da4b2019-08-28 19:35:56 -0700557 channels_(channels),
Austin Schuh057d29f2021-08-21 23:05:15 -0700558 event_loops_(event_loops_),
Austin Schuh217a9782019-12-21 23:02:50 -0800559 node_(node),
Austin Schuh58646e22021-08-23 23:51:46 -0700560 tid_(tid),
James Kuszmaul890c2492022-04-06 14:59:31 -0700561 startup_tracker_(std::make_shared<StartupTracker>()),
562 options_(options) {
Austin Schuh58646e22021-08-23 23:51:46 -0700563 startup_tracker_->loop = this;
564 scheduler_->ScheduleOnStartup([startup_tracker = startup_tracker_]() {
565 if (startup_tracker->loop) {
566 startup_tracker->loop->Setup();
567 startup_tracker->has_setup = true;
568 }
Austin Schuh057d29f2021-08-21 23:05:15 -0700569 });
570
571 event_loops_->push_back(this);
Alex Perrycb7da4b2019-08-28 19:35:56 -0700572 }
Austin Schuh58646e22021-08-23 23:51:46 -0700573
Alex Perrycb7da4b2019-08-28 19:35:56 -0700574 ~SimulatedEventLoop() override {
Austin Schuh39788ff2019-12-01 18:22:57 -0800575 // Trigger any remaining senders or fetchers to be cleared before destroying
576 // the event loop so the book keeping matches.
577 timing_report_sender_.reset();
578
579 // Force everything with a registered fd with epoll to be destroyed now.
580 timers_.clear();
581 phased_loops_.clear();
582 watchers_.clear();
583
Austin Schuh58646e22021-08-23 23:51:46 -0700584 for (auto it = event_loops_->begin(); it != event_loops_->end(); ++it) {
Austin Schuh057d29f2021-08-21 23:05:15 -0700585 if (*it == this) {
586 event_loops_->erase(it);
Alex Perrycb7da4b2019-08-28 19:35:56 -0700587 break;
588 }
589 }
Austin Schuh58646e22021-08-23 23:51:46 -0700590 VLOG(1) << scheduler_->distributed_now() << " " << NodeName(node())
591 << monotonic_now() << " ~SimulatedEventLoop(\"" << name_ << "\")";
592 startup_tracker_->loop = nullptr;
Alex Perrycb7da4b2019-08-28 19:35:56 -0700593 }
594
Austin Schuh057d29f2021-08-21 23:05:15 -0700595 void SetIsRunning(bool running) {
Austin Schuh58646e22021-08-23 23:51:46 -0700596 VLOG(1) << scheduler_->distributed_now() << " " << NodeName(node())
597 << monotonic_now() << " " << name_ << " set_is_running(" << running
598 << ")";
599 CHECK(startup_tracker_->has_setup);
Austin Schuh057d29f2021-08-21 23:05:15 -0700600
601 set_is_running(running);
Austin Schuh58646e22021-08-23 23:51:46 -0700602 if (running) {
603 has_run_ = true;
604 }
Austin Schuh057d29f2021-08-21 23:05:15 -0700605 }
606
Austin Schuh8fb315a2020-11-19 22:33:58 -0800607 bool has_run() const { return has_run_; }
608
Austin Schuh7d87b672019-12-01 20:23:49 -0800609 std::chrono::nanoseconds send_delay() const { return send_delay_; }
610 void set_send_delay(std::chrono::nanoseconds send_delay) {
611 send_delay_ = send_delay;
612 }
613
Stephan Pleines559fa6c2022-01-06 17:23:51 -0800614 monotonic_clock::time_point monotonic_now() const override {
Austin Schuhac0771c2020-01-07 18:36:30 -0800615 return node_event_loop_factory_->monotonic_now();
Alex Perrycb7da4b2019-08-28 19:35:56 -0700616 }
617
Stephan Pleines559fa6c2022-01-06 17:23:51 -0800618 realtime_clock::time_point realtime_now() const override {
Austin Schuhac0771c2020-01-07 18:36:30 -0800619 return node_event_loop_factory_->realtime_now();
Alex Perrycb7da4b2019-08-28 19:35:56 -0700620 }
621
Austin Schuh58646e22021-08-23 23:51:46 -0700622 distributed_clock::time_point distributed_now() {
623 return scheduler_->distributed_now();
624 }
Alex Perrycb7da4b2019-08-28 19:35:56 -0700625
Austin Schuh58646e22021-08-23 23:51:46 -0700626 std::unique_ptr<RawSender> MakeRawSender(const Channel *channel) override;
627
628 std::unique_ptr<RawFetcher> MakeRawFetcher(const Channel *channel) override;
Alex Perrycb7da4b2019-08-28 19:35:56 -0700629
630 void MakeRawWatcher(
631 const Channel *channel,
632 ::std::function<void(const Context &context, const void *message)>
633 watcher) override;
634
635 TimerHandler *AddTimer(::std::function<void()> callback) override {
Austin Schuh39788ff2019-12-01 18:22:57 -0800636 CHECK(!is_running());
Austin Schuh8bd96322020-02-13 21:18:22 -0800637 return NewTimer(::std::unique_ptr<TimerHandler>(
638 new SimulatedTimerHandler(scheduler_, this, callback)));
Alex Perrycb7da4b2019-08-28 19:35:56 -0700639 }
640
641 PhasedLoopHandler *AddPhasedLoop(::std::function<void(int)> callback,
642 const monotonic_clock::duration interval,
643 const monotonic_clock::duration offset =
644 ::std::chrono::seconds(0)) override {
Austin Schuh8bd96322020-02-13 21:18:22 -0800645 return NewPhasedLoop(
646 ::std::unique_ptr<PhasedLoopHandler>(new SimulatedPhasedLoopHandler(
647 scheduler_, this, callback, interval, offset)));
Alex Perrycb7da4b2019-08-28 19:35:56 -0700648 }
649
650 void OnRun(::std::function<void()> on_run) override {
Austin Schuh8fb315a2020-11-19 22:33:58 -0800651 CHECK(!is_running()) << ": Cannot register OnRun callback while running.";
Austin Schuhcc6070c2020-10-10 20:25:56 -0700652 scheduler_->ScheduleOnRun([this, on_run = std::move(on_run)]() {
Austin Schuhad9e5eb2021-11-19 20:33:55 -0800653 logging::ScopedLogRestorer prev_logger;
654 if (log_impl_) {
655 prev_logger.Swap(log_impl_);
656 }
Austin Schuhcc6070c2020-10-10 20:25:56 -0700657 ScopedMarkRealtimeRestorer rt(priority() > 0);
Austin Schuha9012be2021-07-21 15:19:11 -0700658 SetTimerContext(monotonic_now());
Austin Schuhcc6070c2020-10-10 20:25:56 -0700659 on_run();
660 });
Alex Perrycb7da4b2019-08-28 19:35:56 -0700661 }
662
Austin Schuh217a9782019-12-21 23:02:50 -0800663 const Node *node() const override { return node_; }
664
James Kuszmaul3ae42262019-11-08 12:33:41 -0800665 void set_name(const std::string_view name) override {
Alex Perrycb7da4b2019-08-28 19:35:56 -0700666 name_ = std::string(name);
667 }
James Kuszmaul3ae42262019-11-08 12:33:41 -0800668 const std::string_view name() const override { return name_; }
Alex Perrycb7da4b2019-08-28 19:35:56 -0700669
670 SimulatedChannel *GetSimulatedChannel(const Channel *channel);
671
Austin Schuh39788ff2019-12-01 18:22:57 -0800672 void SetRuntimeRealtimePriority(int priority) override {
Alex Perrycb7da4b2019-08-28 19:35:56 -0700673 CHECK(!is_running()) << ": Cannot set realtime priority while running.";
Austin Schuh39788ff2019-12-01 18:22:57 -0800674 priority_ = priority;
Alex Perrycb7da4b2019-08-28 19:35:56 -0700675 }
676
Austin Schuh39788ff2019-12-01 18:22:57 -0800677 int priority() const override { return priority_; }
678
Brian Silverman6a54ff32020-04-28 16:41:39 -0700679 void SetRuntimeAffinity(const cpu_set_t & /*cpuset*/) override {
680 CHECK(!is_running()) << ": Cannot set affinity while running.";
681 }
682
Tyler Chatow67ddb032020-01-12 14:30:04 -0800683 void Setup() {
684 MaybeScheduleTimingReports();
685 if (!skip_logger_) {
Austin Schuhad9e5eb2021-11-19 20:33:55 -0800686 log_sender_.Initialize(&name_,
687 MakeSender<logging::LogMessageFbs>("/aos"));
Austin Schuha0c41ba2020-09-10 22:59:14 -0700688 log_impl_ = log_sender_.implementation();
Tyler Chatow67ddb032020-01-12 14:30:04 -0800689 }
690 }
Austin Schuh39788ff2019-12-01 18:22:57 -0800691
Brian Silverman4f4e0612020-08-12 19:54:41 -0700692 int NumberBuffers(const Channel *channel) override;
693
Austin Schuh83c7f702021-01-19 22:36:29 -0800694 const UUID &boot_uuid() const override {
695 return node_event_loop_factory_->boot_uuid();
696 }
697
James Kuszmaul890c2492022-04-06 14:59:31 -0700698 const EventLoopOptions &options() const { return options_; }
699
Alex Perrycb7da4b2019-08-28 19:35:56 -0700700 private:
Austin Schuhde8a8ff2019-11-30 15:25:36 -0800701 friend class SimulatedTimerHandler;
Austin Schuh7d87b672019-12-01 20:23:49 -0800702 friend class SimulatedPhasedLoopHandler;
703 friend class SimulatedWatcher;
704
Austin Schuh58646e22021-08-23 23:51:46 -0700705 // We have a condition where we register a startup handler, but then get shut
706 // down before it runs. This results in a segfault if we are lucky, and
707 // corruption otherwise. To handle that, allocate a small object which points
708 // back to us and can be freed when the function is freed. That object can
709 // then be updated when we get destroyed so setup is not called.
710 struct StartupTracker {
711 SimulatedEventLoop *loop = nullptr;
712 bool has_setup = false;
713 };
714
Austin Schuh7d87b672019-12-01 20:23:49 -0800715 void HandleEvent() {
716 while (true) {
717 if (EventCount() == 0 || PeekEvent()->event_time() > monotonic_now()) {
718 break;
719 }
720
721 EventLoopEvent *event = PopEvent();
722 event->HandleEvent();
723 }
724 }
Austin Schuhde8a8ff2019-11-30 15:25:36 -0800725
Austin Schuh39788ff2019-12-01 18:22:57 -0800726 pid_t GetTid() override { return tid_; }
727
Alex Perrycb7da4b2019-08-28 19:35:56 -0700728 EventScheduler *scheduler_;
Austin Schuhac0771c2020-01-07 18:36:30 -0800729 NodeEventLoopFactory *node_event_loop_factory_;
Alex Perrycb7da4b2019-08-28 19:35:56 -0700730 absl::btree_map<SimpleChannel, std::unique_ptr<SimulatedChannel>> *channels_;
Austin Schuh057d29f2021-08-21 23:05:15 -0700731 std::vector<SimulatedEventLoop *> *event_loops_;
Alex Perrycb7da4b2019-08-28 19:35:56 -0700732
733 ::std::string name_;
Austin Schuh39788ff2019-12-01 18:22:57 -0800734
735 int priority_ = 0;
736
Austin Schuh7d87b672019-12-01 20:23:49 -0800737 std::chrono::nanoseconds send_delay_;
738
Austin Schuh217a9782019-12-21 23:02:50 -0800739 const Node *const node_;
Austin Schuh39788ff2019-12-01 18:22:57 -0800740 const pid_t tid_;
Tyler Chatow67ddb032020-01-12 14:30:04 -0800741
742 AosLogToFbs log_sender_;
Austin Schuha0c41ba2020-09-10 22:59:14 -0700743 std::shared_ptr<logging::LogImplementation> log_impl_ = nullptr;
Austin Schuh8fb315a2020-11-19 22:33:58 -0800744
745 bool has_run_ = false;
Austin Schuh58646e22021-08-23 23:51:46 -0700746
747 std::shared_ptr<StartupTracker> startup_tracker_;
James Kuszmaul890c2492022-04-06 14:59:31 -0700748
749 EventLoopOptions options_;
Alex Perrycb7da4b2019-08-28 19:35:56 -0700750};
751
Austin Schuh7d87b672019-12-01 20:23:49 -0800752void SimulatedEventLoopFactory::set_send_delay(
753 std::chrono::nanoseconds send_delay) {
754 send_delay_ = send_delay;
Austin Schuh58646e22021-08-23 23:51:46 -0700755 for (std::unique_ptr<NodeEventLoopFactory> &node : node_factories_) {
Austin Schuh057d29f2021-08-21 23:05:15 -0700756 if (node) {
757 for (SimulatedEventLoop *loop : node->event_loops_) {
758 loop->set_send_delay(send_delay_);
759 }
760 }
Austin Schuh7d87b672019-12-01 20:23:49 -0800761 }
762}
763
Alex Perrycb7da4b2019-08-28 19:35:56 -0700764void SimulatedEventLoop::MakeRawWatcher(
765 const Channel *channel,
766 std::function<void(const Context &channel, const void *message)> watcher) {
Brian Silverman0fc69932020-01-24 21:54:02 -0800767 TakeWatcher(channel);
Austin Schuh217a9782019-12-21 23:02:50 -0800768
Austin Schuh057d29f2021-08-21 23:05:15 -0700769 std::unique_ptr<SimulatedWatcher> shm_watcher =
770 std::make_unique<SimulatedWatcher>(this, scheduler_, channel,
771 std::move(watcher));
Austin Schuh39788ff2019-12-01 18:22:57 -0800772
773 GetSimulatedChannel(channel)->MakeRawWatcher(shm_watcher.get());
Austin Schuh057d29f2021-08-21 23:05:15 -0700774
Austin Schuh39788ff2019-12-01 18:22:57 -0800775 NewWatcher(std::move(shm_watcher));
Austin Schuh58646e22021-08-23 23:51:46 -0700776 VLOG(1) << distributed_now() << " " << NodeName(node()) << monotonic_now()
777 << " " << name() << " MakeRawWatcher(\""
778 << configuration::StrippedChannelToString(channel) << "\")";
Austin Schuh8fb315a2020-11-19 22:33:58 -0800779
780 // Order of operations gets kinda wonky if we let people make watchers after
781 // running once. If someone has a valid use case, we can reconsider.
782 CHECK(!has_run()) << ": Can't add a watcher after running.";
Alex Perrycb7da4b2019-08-28 19:35:56 -0700783}
784
785std::unique_ptr<RawSender> SimulatedEventLoop::MakeRawSender(
786 const Channel *channel) {
Brian Silverman0fc69932020-01-24 21:54:02 -0800787 TakeSender(channel);
788
Austin Schuh58646e22021-08-23 23:51:46 -0700789 VLOG(1) << distributed_now() << " " << NodeName(node()) << monotonic_now()
790 << " " << name() << " MakeRawSender(\""
791 << configuration::StrippedChannelToString(channel) << "\")";
Alex Perrycb7da4b2019-08-28 19:35:56 -0700792 return GetSimulatedChannel(channel)->MakeRawSender(this);
793}
794
795std::unique_ptr<RawFetcher> SimulatedEventLoop::MakeRawFetcher(
796 const Channel *channel) {
Austin Schuh39788ff2019-12-01 18:22:57 -0800797 ChannelIndex(channel);
Austin Schuh217a9782019-12-21 23:02:50 -0800798
Austin Schuhca4828c2019-12-28 14:21:35 -0800799 if (!configuration::ChannelIsReadableOnNode(channel, node())) {
800 LOG(FATAL) << "Channel { \"name\": \"" << channel->name()->string_view()
801 << "\", \"type\": \"" << channel->type()->string_view()
802 << "\" } is not able to be fetched on this node. Check your "
803 "configuration.";
Austin Schuh217a9782019-12-21 23:02:50 -0800804 }
805
Austin Schuh58646e22021-08-23 23:51:46 -0700806 VLOG(1) << distributed_now() << " " << NodeName(node()) << monotonic_now()
807 << " " << name() << " MakeRawFetcher(\""
808 << configuration::StrippedChannelToString(channel) << "\")";
Austin Schuh39788ff2019-12-01 18:22:57 -0800809 return GetSimulatedChannel(channel)->MakeRawFetcher(this);
Alex Perrycb7da4b2019-08-28 19:35:56 -0700810}
811
812SimulatedChannel *SimulatedEventLoop::GetSimulatedChannel(
813 const Channel *channel) {
814 auto it = channels_->find(SimpleChannel(channel));
815 if (it == channels_->end()) {
Eric Schmiedebergef44b8a2022-02-28 17:30:38 -0700816 it = channels_
817 ->emplace(SimpleChannel(channel),
818 std::unique_ptr<SimulatedChannel>(new SimulatedChannel(
819 channel,
820 std::chrono::nanoseconds(
821 configuration()->channel_storage_duration()),
822 scheduler_)))
823 .first;
Alex Perrycb7da4b2019-08-28 19:35:56 -0700824 }
825 return it->second.get();
826}
827
Brian Silverman4f4e0612020-08-12 19:54:41 -0700828int SimulatedEventLoop::NumberBuffers(const Channel *channel) {
829 return GetSimulatedChannel(channel)->number_buffers();
830}
831
Austin Schuh7d87b672019-12-01 20:23:49 -0800832SimulatedWatcher::SimulatedWatcher(
833 SimulatedEventLoop *simulated_event_loop, EventScheduler *scheduler,
Austin Schuh8bd96322020-02-13 21:18:22 -0800834 const Channel *channel,
Austin Schuh7d87b672019-12-01 20:23:49 -0800835 std::function<void(const Context &context, const void *message)> fn)
836 : WatcherState(simulated_event_loop, channel, std::move(fn)),
837 simulated_event_loop_(simulated_event_loop),
Brian Silverman4f4e0612020-08-12 19:54:41 -0700838 channel_(channel),
Austin Schuh7d87b672019-12-01 20:23:49 -0800839 scheduler_(scheduler),
Brian Silverman4f4e0612020-08-12 19:54:41 -0700840 event_(this),
Austin Schuh58646e22021-08-23 23:51:46 -0700841 token_(scheduler_->InvalidToken()) {
842 VLOG(1) << simulated_event_loop_->distributed_now() << " "
843 << NodeName(simulated_event_loop_->node())
844 << simulated_event_loop_->monotonic_now() << " "
845 << simulated_event_loop_->name() << " Watching "
846 << configuration::StrippedChannelToString(channel_);
847}
Austin Schuh7d87b672019-12-01 20:23:49 -0800848
849SimulatedWatcher::~SimulatedWatcher() {
Austin Schuh58646e22021-08-23 23:51:46 -0700850 VLOG(1) << simulated_event_loop_->distributed_now() << " "
Austin Schuh057d29f2021-08-21 23:05:15 -0700851 << NodeName(simulated_event_loop_->node())
Austin Schuh58646e22021-08-23 23:51:46 -0700852 << simulated_event_loop_->monotonic_now() << " "
853 << simulated_event_loop_->name() << " ~Watching "
Austin Schuh057d29f2021-08-21 23:05:15 -0700854 << configuration::StrippedChannelToString(channel_);
Austin Schuh7d87b672019-12-01 20:23:49 -0800855 simulated_event_loop_->RemoveEvent(&event_);
856 if (token_ != scheduler_->InvalidToken()) {
857 scheduler_->Deschedule(token_);
858 }
Brian Silverman4f4e0612020-08-12 19:54:41 -0700859 CHECK_NOTNULL(simulated_channel_)->RemoveWatcher(this);
Austin Schuh7d87b672019-12-01 20:23:49 -0800860}
861
Austin Schuh8fb315a2020-11-19 22:33:58 -0800862bool SimulatedWatcher::has_run() const {
863 return simulated_event_loop_->has_run();
864}
865
Austin Schuh7d87b672019-12-01 20:23:49 -0800866void SimulatedWatcher::Schedule(std::shared_ptr<SimulatedMessage> message) {
Austin Schuha5e14192020-01-06 18:02:41 -0800867 monotonic_clock::time_point event_time =
868 simulated_event_loop_->monotonic_now();
Austin Schuh7d87b672019-12-01 20:23:49 -0800869
870 // Messages are queued in order. If we are the first, add ourselves.
871 // Otherwise, don't.
872 if (msgs_.size() == 0) {
Austin Schuhad154822019-12-27 15:45:13 -0800873 event_.set_event_time(message->context.monotonic_event_time);
Austin Schuh7d87b672019-12-01 20:23:49 -0800874 simulated_event_loop_->AddEvent(&event_);
875
876 DoSchedule(event_time);
877 }
878
Austin Schuhe6f4c8d2021-12-11 12:36:06 -0800879 msgs_.emplace_back(std::move(message));
Austin Schuh7d87b672019-12-01 20:23:49 -0800880}
881
Austin Schuhf4b09c72021-12-08 12:04:37 -0800882void SimulatedWatcher::HandleEvent() noexcept {
Austin Schuh7d87b672019-12-01 20:23:49 -0800883 const monotonic_clock::time_point monotonic_now =
884 simulated_event_loop_->monotonic_now();
Austin Schuh58646e22021-08-23 23:51:46 -0700885 VLOG(1) << simulated_event_loop_->distributed_now() << " "
886 << NodeName(simulated_event_loop_->node())
887 << simulated_event_loop_->monotonic_now() << " "
888 << simulated_event_loop_->name() << " Watcher "
Austin Schuh057d29f2021-08-21 23:05:15 -0700889 << configuration::StrippedChannelToString(channel_);
890 CHECK_NE(msgs_.size(), 0u) << ": No events to handle.";
891
Tyler Chatow67ddb032020-01-12 14:30:04 -0800892 logging::ScopedLogRestorer prev_logger;
Austin Schuha0c41ba2020-09-10 22:59:14 -0700893 if (simulated_event_loop_->log_impl_) {
894 prev_logger.Swap(simulated_event_loop_->log_impl_);
Tyler Chatow67ddb032020-01-12 14:30:04 -0800895 }
Austin Schuhad154822019-12-27 15:45:13 -0800896 Context context = msgs_.front()->context;
897
Brian Silverman4f4e0612020-08-12 19:54:41 -0700898 if (channel_->read_method() != ReadMethod::PIN) {
899 context.buffer_index = -1;
900 }
Austin Schuhad154822019-12-27 15:45:13 -0800901 if (context.remote_queue_index == 0xffffffffu) {
902 context.remote_queue_index = context.queue_index;
903 }
Austin Schuh58646e22021-08-23 23:51:46 -0700904 if (context.monotonic_remote_time == monotonic_clock::min_time) {
Austin Schuhad154822019-12-27 15:45:13 -0800905 context.monotonic_remote_time = context.monotonic_event_time;
906 }
Austin Schuh58646e22021-08-23 23:51:46 -0700907 if (context.realtime_remote_time == realtime_clock::min_time) {
Austin Schuhad154822019-12-27 15:45:13 -0800908 context.realtime_remote_time = context.realtime_event_time;
909 }
910
Austin Schuhcc6070c2020-10-10 20:25:56 -0700911 {
912 ScopedMarkRealtimeRestorer rt(simulated_event_loop_->priority() > 0);
913 DoCallCallback([monotonic_now]() { return monotonic_now; }, context);
914 }
Austin Schuh7d87b672019-12-01 20:23:49 -0800915
916 msgs_.pop_front();
Austin Schuheb4e4ce2020-09-10 23:04:18 -0700917 if (token_ != scheduler_->InvalidToken()) {
918 scheduler_->Deschedule(token_);
919 token_ = scheduler_->InvalidToken();
920 }
Austin Schuh7d87b672019-12-01 20:23:49 -0800921 if (msgs_.size() != 0) {
Austin Schuhad154822019-12-27 15:45:13 -0800922 event_.set_event_time(msgs_.front()->context.monotonic_event_time);
Austin Schuh7d87b672019-12-01 20:23:49 -0800923 simulated_event_loop_->AddEvent(&event_);
924
925 DoSchedule(event_.event_time());
Austin Schuh7d87b672019-12-01 20:23:49 -0800926 }
927}
928
Austin Schuhef8f1ae2021-12-11 12:35:05 -0800929void SimulatedWatcher::Handle() noexcept {
930 DCHECK(token_ != scheduler_->InvalidToken());
931 token_ = scheduler_->InvalidToken();
932 simulated_event_loop_->HandleEvent();
933}
934
Austin Schuh7d87b672019-12-01 20:23:49 -0800935void SimulatedWatcher::DoSchedule(monotonic_clock::time_point event_time) {
Austin Schuheb4e4ce2020-09-10 23:04:18 -0700936 CHECK(token_ == scheduler_->InvalidToken())
937 << ": May not schedule multiple times";
938 token_ = scheduler_->Schedule(
Austin Schuhef8f1ae2021-12-11 12:35:05 -0800939 event_time + simulated_event_loop_->send_delay(), this);
Austin Schuh7d87b672019-12-01 20:23:49 -0800940}
941
942void SimulatedChannel::MakeRawWatcher(SimulatedWatcher *watcher) {
Brian Silverman77162972020-08-12 19:52:40 -0700943 CheckReaderCount();
Austin Schuh39788ff2019-12-01 18:22:57 -0800944 watcher->SetSimulatedChannel(this);
945 watchers_.emplace_back(watcher);
Alex Perrycb7da4b2019-08-28 19:35:56 -0700946}
947
948::std::unique_ptr<RawSender> SimulatedChannel::MakeRawSender(
Austin Schuh8fb315a2020-11-19 22:33:58 -0800949 SimulatedEventLoop *event_loop) {
James Kuszmaul890c2492022-04-06 14:59:31 -0700950 CHECK(allow_new_senders_)
951 << ": Attempted to create a new sender on exclusive channel "
952 << configuration::StrippedChannelToString(channel_);
953 if (event_loop->options().exclusive_senders == ExclusiveSenders::kYes) {
954 CHECK_EQ(0, sender_count_)
955 << ": Attempted to add an exclusive sender on a channel with existing "
956 "senders: "
957 << configuration::StrippedChannelToString(channel_);
958 allow_new_senders_ = false;
959 }
Alex Perrycb7da4b2019-08-28 19:35:56 -0700960 return ::std::unique_ptr<RawSender>(new SimulatedSender(this, event_loop));
961}
962
Austin Schuh39788ff2019-12-01 18:22:57 -0800963::std::unique_ptr<RawFetcher> SimulatedChannel::MakeRawFetcher(
964 EventLoop *event_loop) {
Brian Silverman77162972020-08-12 19:52:40 -0700965 CheckReaderCount();
Austin Schuh39788ff2019-12-01 18:22:57 -0800966 ::std::unique_ptr<SimulatedFetcher> fetcher(
967 new SimulatedFetcher(event_loop, this));
Alex Perrycb7da4b2019-08-28 19:35:56 -0700968 fetchers_.push_back(fetcher.get());
969 return ::std::move(fetcher);
970}
971
milind1f1dca32021-07-03 13:50:07 -0700972std::optional<uint32_t> SimulatedChannel::Send(
Austin Schuh60e77942022-05-16 17:48:24 -0700973 std::shared_ptr<SimulatedMessage> message,
974 CheckSentTooFast check_sent_too_fast) {
Eric Schmiedebergef44b8a2022-02-28 17:30:38 -0700975 const auto now = scheduler_->monotonic_now();
976 // Remove times that are greater than or equal to a channel_storage_duration_
977 // ago
978 while (!last_times_.empty() &&
979 (now - last_times_.front() >= channel_storage_duration_)) {
980 last_times_.pop();
981 }
982
983 // Check that we are not sending messages too fast
James Kuszmaul890c2492022-04-06 14:59:31 -0700984 if (check_sent_too_fast == CheckSentTooFast::kYes &&
985 static_cast<int>(last_times_.size()) >= queue_size()) {
Eric Schmiedebergef44b8a2022-02-28 17:30:38 -0700986 return std::nullopt;
987 }
988
989 const std::optional<uint32_t> queue_index = {next_queue_index_.index()};
990 last_times_.push(now);
Tyler Chatowb7c6eba2021-07-28 14:43:23 -0700991
milind1f1dca32021-07-03 13:50:07 -0700992 message->context.queue_index = *queue_index;
Tyler Chatowb7c6eba2021-07-28 14:43:23 -0700993 // Points to the actual data depending on the size set in context. Data may
994 // allocate more than the actual size of the message, so offset from the back
995 // of that to get the actual start of the data.
996 message->context.data =
997 message->data->data() + message->data->size() - message->context.size;
Austin Schuha9df9ad2021-06-16 14:49:39 -0700998
999 DCHECK(channel()->has_schema())
1000 << ": Missing schema for channel "
1001 << configuration::StrippedChannelToString(channel());
1002 DCHECK(flatbuffers::Verify(
1003 *channel()->schema(), *channel()->schema()->root_table(),
1004 static_cast<const uint8_t *>(message->context.data),
1005 message->context.size))
1006 << ": Corrupted flatbuffer on " << channel()->name()->c_str() << " "
1007 << channel()->type()->c_str();
1008
Alex Perrycb7da4b2019-08-28 19:35:56 -07001009 next_queue_index_ = next_queue_index_.Increment();
1010
Austin Schuhe6f4c8d2021-12-11 12:36:06 -08001011 latest_message_ = std::move(message);
Austin Schuh8fb315a2020-11-19 22:33:58 -08001012 for (SimulatedWatcher *watcher : watchers_) {
1013 if (watcher->has_run()) {
Austin Schuhe6f4c8d2021-12-11 12:36:06 -08001014 watcher->Schedule(latest_message_);
Alex Perrycb7da4b2019-08-28 19:35:56 -07001015 }
1016 }
1017 for (auto &fetcher : fetchers_) {
Austin Schuhe6f4c8d2021-12-11 12:36:06 -08001018 fetcher->Enqueue(latest_message_);
Alex Perrycb7da4b2019-08-28 19:35:56 -07001019 }
Austin Schuhad154822019-12-27 15:45:13 -08001020 return queue_index;
Alex Perrycb7da4b2019-08-28 19:35:56 -07001021}
1022
1023void SimulatedChannel::UnregisterFetcher(SimulatedFetcher *fetcher) {
1024 fetchers_.erase(::std::find(fetchers_.begin(), fetchers_.end(), fetcher));
1025}
1026
Austin Schuh8fb315a2020-11-19 22:33:58 -08001027SimulatedSender::SimulatedSender(SimulatedChannel *simulated_channel,
1028 SimulatedEventLoop *event_loop)
1029 : RawSender(event_loop, simulated_channel->channel()),
1030 simulated_channel_(simulated_channel),
Austin Schuh58646e22021-08-23 23:51:46 -07001031 simulated_event_loop_(event_loop) {
Austin Schuh8fb315a2020-11-19 22:33:58 -08001032 simulated_channel_->CountSenderCreated();
1033}
1034
1035SimulatedSender::~SimulatedSender() {
1036 simulated_channel_->CountSenderDestroyed();
1037}
1038
milind1f1dca32021-07-03 13:50:07 -07001039RawSender::Error SimulatedSender::DoSend(
1040 size_t length, monotonic_clock::time_point monotonic_remote_time,
1041 realtime_clock::time_point realtime_remote_time,
1042 uint32_t remote_queue_index, const UUID &source_boot_uuid) {
Austin Schuh9b1d6282022-06-10 17:03:21 -07001043 // The allocations in here are due to infrastructure and don't count in the
1044 // no mallocs in RT code.
1045 ScopedNotRealtime nrt;
1046
Austin Schuh58646e22021-08-23 23:51:46 -07001047 VLOG(1) << simulated_event_loop_->distributed_now() << " "
1048 << NodeName(simulated_event_loop_->node())
1049 << simulated_event_loop_->monotonic_now() << " "
1050 << simulated_event_loop_->name() << " Send "
1051 << configuration::StrippedChannelToString(channel());
1052
Austin Schuh8fb315a2020-11-19 22:33:58 -08001053 CHECK_LE(length, size()) << ": Attempting to send too big a message.";
Austin Schuh58646e22021-08-23 23:51:46 -07001054 message_->context.monotonic_event_time =
1055 simulated_event_loop_->monotonic_now();
Austin Schuh8fb315a2020-11-19 22:33:58 -08001056 message_->context.monotonic_remote_time = monotonic_remote_time;
1057 message_->context.remote_queue_index = remote_queue_index;
Austin Schuh58646e22021-08-23 23:51:46 -07001058 message_->context.realtime_event_time = simulated_event_loop_->realtime_now();
Austin Schuh8fb315a2020-11-19 22:33:58 -08001059 message_->context.realtime_remote_time = realtime_remote_time;
Austin Schuha9012be2021-07-21 15:19:11 -07001060 message_->context.source_boot_uuid = source_boot_uuid;
Austin Schuh8fb315a2020-11-19 22:33:58 -08001061 CHECK_LE(length, message_->context.size);
1062 message_->context.size = length;
1063
Austin Schuh60e77942022-05-16 17:48:24 -07001064 const std::optional<uint32_t> optional_queue_index = simulated_channel_->Send(
1065 message_, simulated_event_loop_->options().check_sent_too_fast);
milind1f1dca32021-07-03 13:50:07 -07001066
1067 // Check that we are not sending messages too fast
1068 if (!optional_queue_index) {
1069 VLOG(1) << simulated_event_loop_->distributed_now() << " "
1070 << NodeName(simulated_event_loop_->node())
1071 << simulated_event_loop_->monotonic_now() << " "
1072 << simulated_event_loop_->name()
1073 << "\nMessages were sent too fast:\n"
1074 << "For channel: "
1075 << configuration::CleanedChannelToString(
1076 simulated_channel_->channel())
1077 << '\n'
1078 << "Tried to send more than " << simulated_channel_->queue_size()
1079 << " (queue size) messages in the last "
1080 << std::chrono::duration<double>(
1081 simulated_channel_->channel_storage_duration())
1082 .count()
1083 << " seconds (channel storage duration)"
1084 << "\n\n";
1085 return Error::kMessagesSentTooFast;
1086 }
1087
1088 sent_queue_index_ = *optional_queue_index;
Austin Schuh58646e22021-08-23 23:51:46 -07001089 monotonic_sent_time_ = simulated_event_loop_->monotonic_now();
1090 realtime_sent_time_ = simulated_event_loop_->realtime_now();
Austin Schuh8fb315a2020-11-19 22:33:58 -08001091
1092 // Drop the reference to the message so that we allocate a new message for
1093 // next time. Otherwise we will continue to reuse the same memory for all
1094 // messages and corrupt it.
1095 message_.reset();
milind1f1dca32021-07-03 13:50:07 -07001096 return Error::kOk;
Austin Schuh8fb315a2020-11-19 22:33:58 -08001097}
1098
milind1f1dca32021-07-03 13:50:07 -07001099RawSender::Error SimulatedSender::DoSend(
1100 const void *msg, size_t size,
1101 monotonic_clock::time_point monotonic_remote_time,
1102 realtime_clock::time_point realtime_remote_time,
1103 uint32_t remote_queue_index, const UUID &source_boot_uuid) {
Austin Schuh102667e2020-12-11 20:13:28 -08001104 CHECK_LE(size, this->size())
1105 << ": Attempting to send too big a message on "
1106 << configuration::CleanedChannelToString(simulated_channel_->channel());
Austin Schuh8fb315a2020-11-19 22:33:58 -08001107
Tyler Chatowb7c6eba2021-07-28 14:43:23 -07001108 // Allocates an aligned buffer in which to copy unaligned msg.
1109 auto [span, mutable_span] = MakeSharedSpan(size);
1110 message_ = SimulatedMessage::Make(simulated_channel_, span);
Austin Schuh8fb315a2020-11-19 22:33:58 -08001111
1112 // Now fill in the message. size is already populated above, and
Tyler Chatowb7c6eba2021-07-28 14:43:23 -07001113 // queue_index will be populated in simulated_channel_.
1114 memcpy(mutable_span.data(), msg, size);
Austin Schuh8fb315a2020-11-19 22:33:58 -08001115
1116 return DoSend(size, monotonic_remote_time, realtime_remote_time,
Austin Schuha9012be2021-07-21 15:19:11 -07001117 remote_queue_index, source_boot_uuid);
Austin Schuh8fb315a2020-11-19 22:33:58 -08001118}
1119
milind1f1dca32021-07-03 13:50:07 -07001120RawSender::Error SimulatedSender::DoSend(
1121 const RawSender::SharedSpan data,
1122 monotonic_clock::time_point monotonic_remote_time,
1123 realtime_clock::time_point realtime_remote_time,
1124 uint32_t remote_queue_index, const UUID &source_boot_uuid) {
Tyler Chatowb7c6eba2021-07-28 14:43:23 -07001125 CHECK_LE(data->size(), this->size())
1126 << ": Attempting to send too big a message on "
1127 << configuration::CleanedChannelToString(simulated_channel_->channel());
1128
1129 // Constructs a message sharing the already allocated and aligned message
1130 // data.
1131 message_ = SimulatedMessage::Make(simulated_channel_, data);
1132
1133 return DoSend(data->size(), monotonic_remote_time, realtime_remote_time,
1134 remote_queue_index, source_boot_uuid);
1135}
1136
Austin Schuh39788ff2019-12-01 18:22:57 -08001137SimulatedTimerHandler::SimulatedTimerHandler(
Austin Schuh8bd96322020-02-13 21:18:22 -08001138 EventScheduler *scheduler, SimulatedEventLoop *simulated_event_loop,
1139 ::std::function<void()> fn)
Austin Schuh39788ff2019-12-01 18:22:57 -08001140 : TimerHandler(simulated_event_loop, std::move(fn)),
Austin Schuh7d87b672019-12-01 20:23:49 -08001141 simulated_event_loop_(simulated_event_loop),
1142 event_(this),
Austin Schuh39788ff2019-12-01 18:22:57 -08001143 scheduler_(scheduler),
1144 token_(scheduler_->InvalidToken()) {}
1145
Austin Schuhde8a8ff2019-11-30 15:25:36 -08001146void SimulatedTimerHandler::Setup(monotonic_clock::time_point base,
1147 monotonic_clock::duration repeat_offset) {
Austin Schuh62288252020-11-18 23:26:04 -08001148 // The allocations in here are due to infrastructure and don't count in the no
1149 // mallocs in RT code.
1150 ScopedNotRealtime nrt;
Austin Schuhde8a8ff2019-11-30 15:25:36 -08001151 Disable();
Austin Schuh58646e22021-08-23 23:51:46 -07001152 const monotonic_clock::time_point monotonic_now =
Austin Schuha5e14192020-01-06 18:02:41 -08001153 simulated_event_loop_->monotonic_now();
Austin Schuhde8a8ff2019-11-30 15:25:36 -08001154 base_ = base;
1155 repeat_offset_ = repeat_offset;
Austin Schuhef8f1ae2021-12-11 12:35:05 -08001156 token_ = scheduler_->Schedule(std::max(base, monotonic_now), this);
Austin Schuh7d87b672019-12-01 20:23:49 -08001157 event_.set_event_time(base_);
1158 simulated_event_loop_->AddEvent(&event_);
Austin Schuhde8a8ff2019-11-30 15:25:36 -08001159}
1160
Austin Schuhef8f1ae2021-12-11 12:35:05 -08001161void SimulatedTimerHandler::Handle() noexcept {
1162 DCHECK(token_ != scheduler_->InvalidToken());
1163 token_ = scheduler_->InvalidToken();
1164 simulated_event_loop_->HandleEvent();
1165}
1166
Austin Schuhf4b09c72021-12-08 12:04:37 -08001167void SimulatedTimerHandler::HandleEvent() noexcept {
Austin Schuh58646e22021-08-23 23:51:46 -07001168 const monotonic_clock::time_point monotonic_now =
Austin Schuha5e14192020-01-06 18:02:41 -08001169 simulated_event_loop_->monotonic_now();
Austin Schuh58646e22021-08-23 23:51:46 -07001170 VLOG(1) << simulated_event_loop_->distributed_now() << " "
1171 << NodeName(simulated_event_loop_->node()) << monotonic_now << " "
1172 << simulated_event_loop_->name() << " Timer '" << name() << "'";
Tyler Chatow67ddb032020-01-12 14:30:04 -08001173 logging::ScopedLogRestorer prev_logger;
Austin Schuha0c41ba2020-09-10 22:59:14 -07001174 if (simulated_event_loop_->log_impl_) {
1175 prev_logger.Swap(simulated_event_loop_->log_impl_);
Tyler Chatow67ddb032020-01-12 14:30:04 -08001176 }
Austin Schuheb4e4ce2020-09-10 23:04:18 -07001177 if (token_ != scheduler_->InvalidToken()) {
Austin Schuh9b1d6282022-06-10 17:03:21 -07001178 {
1179 ScopedNotRealtime nrt;
1180 scheduler_->Deschedule(token_);
1181 }
Austin Schuheb4e4ce2020-09-10 23:04:18 -07001182 token_ = scheduler_->InvalidToken();
1183 }
Austin Schuh58646e22021-08-23 23:51:46 -07001184 if (repeat_offset_ != monotonic_clock::zero()) {
Austin Schuhde8a8ff2019-11-30 15:25:36 -08001185 // Reschedule.
1186 while (base_ <= monotonic_now) base_ += repeat_offset_;
Austin Schuhef8f1ae2021-12-11 12:35:05 -08001187 token_ = scheduler_->Schedule(base_, this);
Austin Schuh7d87b672019-12-01 20:23:49 -08001188 event_.set_event_time(base_);
1189 simulated_event_loop_->AddEvent(&event_);
Austin Schuhde8a8ff2019-11-30 15:25:36 -08001190 }
Austin Schuhde8a8ff2019-11-30 15:25:36 -08001191
Austin Schuhcc6070c2020-10-10 20:25:56 -07001192 {
1193 ScopedMarkRealtimeRestorer rt(simulated_event_loop_->priority() > 0);
1194 Call([monotonic_now]() { return monotonic_now; }, monotonic_now);
1195 }
Austin Schuhde8a8ff2019-11-30 15:25:36 -08001196}
1197
Austin Schuh7d87b672019-12-01 20:23:49 -08001198void SimulatedTimerHandler::Disable() {
1199 simulated_event_loop_->RemoveEvent(&event_);
1200 if (token_ != scheduler_->InvalidToken()) {
Austin Schuh9b1d6282022-06-10 17:03:21 -07001201 {
1202 ScopedNotRealtime nrt;
1203 scheduler_->Deschedule(token_);
1204 }
Austin Schuh7d87b672019-12-01 20:23:49 -08001205 token_ = scheduler_->InvalidToken();
1206 }
1207}
1208
Austin Schuh39788ff2019-12-01 18:22:57 -08001209SimulatedPhasedLoopHandler::SimulatedPhasedLoopHandler(
Austin Schuh8bd96322020-02-13 21:18:22 -08001210 EventScheduler *scheduler, SimulatedEventLoop *simulated_event_loop,
1211 ::std::function<void(int)> fn, const monotonic_clock::duration interval,
Austin Schuh39788ff2019-12-01 18:22:57 -08001212 const monotonic_clock::duration offset)
1213 : PhasedLoopHandler(simulated_event_loop, std::move(fn), interval, offset),
1214 simulated_event_loop_(simulated_event_loop),
Austin Schuh7d87b672019-12-01 20:23:49 -08001215 event_(this),
Austin Schuh39788ff2019-12-01 18:22:57 -08001216 scheduler_(scheduler),
1217 token_(scheduler_->InvalidToken()) {}
1218
Austin Schuh7d87b672019-12-01 20:23:49 -08001219SimulatedPhasedLoopHandler::~SimulatedPhasedLoopHandler() {
1220 if (token_ != scheduler_->InvalidToken()) {
1221 scheduler_->Deschedule(token_);
1222 token_ = scheduler_->InvalidToken();
1223 }
1224 simulated_event_loop_->RemoveEvent(&event_);
1225}
1226
Austin Schuhf4b09c72021-12-08 12:04:37 -08001227void SimulatedPhasedLoopHandler::HandleEvent() noexcept {
Austin Schuh39788ff2019-12-01 18:22:57 -08001228 monotonic_clock::time_point monotonic_now =
1229 simulated_event_loop_->monotonic_now();
Austin Schuh057d29f2021-08-21 23:05:15 -07001230 VLOG(1) << monotonic_now << " Phased loop " << simulated_event_loop_->name()
1231 << ", " << name();
Tyler Chatow67ddb032020-01-12 14:30:04 -08001232 logging::ScopedLogRestorer prev_logger;
Austin Schuha0c41ba2020-09-10 22:59:14 -07001233 if (simulated_event_loop_->log_impl_) {
1234 prev_logger.Swap(simulated_event_loop_->log_impl_);
Tyler Chatow67ddb032020-01-12 14:30:04 -08001235 }
Austin Schuhcc6070c2020-10-10 20:25:56 -07001236
1237 {
1238 ScopedMarkRealtimeRestorer rt(simulated_event_loop_->priority() > 0);
1239 Call([monotonic_now]() { return monotonic_now; },
1240 [this](monotonic_clock::time_point sleep_time) {
1241 Schedule(sleep_time);
1242 });
1243 }
Austin Schuh39788ff2019-12-01 18:22:57 -08001244}
Austin Schuhde8a8ff2019-11-30 15:25:36 -08001245
Austin Schuhef8f1ae2021-12-11 12:35:05 -08001246void SimulatedPhasedLoopHandler::Handle() noexcept {
1247 DCHECK(token_ != scheduler_->InvalidToken());
1248 token_ = scheduler_->InvalidToken();
1249 simulated_event_loop_->HandleEvent();
1250}
1251
Austin Schuh7d87b672019-12-01 20:23:49 -08001252void SimulatedPhasedLoopHandler::Schedule(
1253 monotonic_clock::time_point sleep_time) {
Austin Schuh62288252020-11-18 23:26:04 -08001254 // The allocations in here are due to infrastructure and don't count in the no
1255 // mallocs in RT code.
1256 ScopedNotRealtime nrt;
Austin Schuheb4e4ce2020-09-10 23:04:18 -07001257 if (token_ != scheduler_->InvalidToken()) {
1258 scheduler_->Deschedule(token_);
1259 token_ = scheduler_->InvalidToken();
1260 }
Austin Schuhef8f1ae2021-12-11 12:35:05 -08001261 token_ = scheduler_->Schedule(sleep_time, this);
Austin Schuh7d87b672019-12-01 20:23:49 -08001262 event_.set_event_time(sleep_time);
1263 simulated_event_loop_->AddEvent(&event_);
1264}
1265
Alex Perrycb7da4b2019-08-28 19:35:56 -07001266SimulatedEventLoopFactory::SimulatedEventLoopFactory(
1267 const Configuration *configuration)
Austin Schuh6f3babe2020-01-26 20:34:50 -08001268 : configuration_(CHECK_NOTNULL(configuration)),
1269 nodes_(configuration::GetNodes(configuration_)) {
Austin Schuh094d09b2020-11-20 23:26:52 -08001270 CHECK(IsInitialized()) << ": Need to initialize AOS first.";
Austin Schuhac0771c2020-01-07 18:36:30 -08001271 for (const Node *node : nodes_) {
Austin Schuh58646e22021-08-23 23:51:46 -07001272 node_factories_.emplace_back(
1273 new NodeEventLoopFactory(&scheduler_scheduler_, this, node));
Austin Schuh15649d62019-12-28 16:36:38 -08001274 }
Austin Schuh898f4972020-01-11 17:21:25 -08001275
1276 if (configuration::MultiNode(configuration)) {
1277 bridge_ = std::make_unique<message_bridge::SimulatedMessageBridge>(this);
1278 }
Austin Schuh15649d62019-12-28 16:36:38 -08001279}
1280
Alex Perrycb7da4b2019-08-28 19:35:56 -07001281SimulatedEventLoopFactory::~SimulatedEventLoopFactory() {}
1282
Austin Schuhac0771c2020-01-07 18:36:30 -08001283NodeEventLoopFactory *SimulatedEventLoopFactory::GetNodeEventLoopFactory(
Austin Schuh057d29f2021-08-21 23:05:15 -07001284 std::string_view node) {
1285 return GetNodeEventLoopFactory(configuration::GetNode(configuration(), node));
1286}
1287
1288NodeEventLoopFactory *SimulatedEventLoopFactory::GetNodeEventLoopFactory(
Austin Schuhac0771c2020-01-07 18:36:30 -08001289 const Node *node) {
1290 auto result = std::find_if(
1291 node_factories_.begin(), node_factories_.end(),
1292 [node](const std::unique_ptr<NodeEventLoopFactory> &node_factory) {
1293 return node_factory->node() == node;
1294 });
1295
1296 CHECK(result != node_factories_.end())
1297 << ": Failed to find node " << FlatbufferToJson(node);
1298
1299 return result->get();
1300}
1301
Austin Schuh87dd3832021-01-01 23:07:31 -08001302void SimulatedEventLoopFactory::SetTimeConverter(
1303 TimeConverter *time_converter) {
1304 for (std::unique_ptr<NodeEventLoopFactory> &factory : node_factories_) {
1305 factory->SetTimeConverter(time_converter);
1306 }
Austin Schuh58646e22021-08-23 23:51:46 -07001307 scheduler_scheduler_.SetTimeConverter(time_converter);
Austin Schuh87dd3832021-01-01 23:07:31 -08001308}
1309
Austin Schuh5f1cc5c2019-12-01 18:01:11 -08001310::std::unique_ptr<EventLoop> SimulatedEventLoopFactory::MakeEventLoop(
Austin Schuhac0771c2020-01-07 18:36:30 -08001311 std::string_view name, const Node *node) {
1312 if (node == nullptr) {
1313 CHECK(!configuration::MultiNode(configuration()))
1314 << ": Can't make a single node event loop in a multi-node world.";
1315 } else {
1316 CHECK(configuration::MultiNode(configuration()))
1317 << ": Can't make a multi-node event loop in a single-node world.";
1318 }
1319 return GetNodeEventLoopFactory(node)->MakeEventLoop(name);
1320}
1321
Austin Schuh057d29f2021-08-21 23:05:15 -07001322NodeEventLoopFactory::NodeEventLoopFactory(
1323 EventSchedulerScheduler *scheduler_scheduler,
1324 SimulatedEventLoopFactory *factory, const Node *node)
Austin Schuh58646e22021-08-23 23:51:46 -07001325 : scheduler_(configuration::GetNodeIndex(factory->configuration(), node)),
1326 factory_(factory),
1327 node_(node) {
Austin Schuh057d29f2021-08-21 23:05:15 -07001328 scheduler_scheduler->AddEventScheduler(&scheduler_);
Austin Schuh58646e22021-08-23 23:51:46 -07001329 scheduler_.set_started([this]() {
1330 started_ = true;
1331 for (SimulatedEventLoop *event_loop : event_loops_) {
1332 event_loop->SetIsRunning(true);
1333 }
1334 });
Austin Schuhe33c08d2022-02-03 18:15:21 -08001335 scheduler_.set_stopped([this]() {
1336 for (SimulatedEventLoop *event_loop : event_loops_) {
1337 event_loop->SetIsRunning(false);
1338 }
1339 });
Austin Schuh58646e22021-08-23 23:51:46 -07001340 scheduler_.set_on_shutdown([this]() {
1341 VLOG(1) << scheduler_.distributed_now() << " " << NodeName(this->node())
1342 << monotonic_now() << " Shutting down node.";
1343 Shutdown();
1344 ScheduleStartup();
1345 });
1346 ScheduleStartup();
Austin Schuh057d29f2021-08-21 23:05:15 -07001347}
1348
1349NodeEventLoopFactory::~NodeEventLoopFactory() {
Austin Schuh58646e22021-08-23 23:51:46 -07001350 if (started_) {
1351 for (std::function<void()> &fn : on_shutdown_) {
1352 fn();
1353 }
1354
1355 VLOG(1) << scheduler_.distributed_now() << " " << NodeName(node())
1356 << monotonic_now() << " Shutting down applications.";
1357 applications_.clear();
1358 started_ = false;
1359 }
1360
1361 if (event_loops_.size() != 0u) {
1362 for (SimulatedEventLoop *event_loop : event_loops_) {
1363 LOG(ERROR) << scheduler_.distributed_now() << " " << NodeName(node())
1364 << monotonic_now() << " Event loop '" << event_loop->name()
1365 << "' failed to shut down";
1366 }
1367 }
Austin Schuh057d29f2021-08-21 23:05:15 -07001368 CHECK_EQ(event_loops_.size(), 0u) << "Event loop didn't exit";
1369}
1370
Austin Schuh58646e22021-08-23 23:51:46 -07001371void NodeEventLoopFactory::OnStartup(std::function<void()> &&fn) {
Austin Schuh8bd96322020-02-13 21:18:22 -08001372 CHECK(!scheduler_.is_running())
Austin Schuh58646e22021-08-23 23:51:46 -07001373 << ": Can only register OnStartup handlers when not running.";
1374 on_startup_.emplace_back(std::move(fn));
1375 if (started_) {
1376 size_t on_startup_index = on_startup_.size() - 1;
1377 scheduler_.ScheduleOnStartup(
1378 [this, on_startup_index]() { on_startup_[on_startup_index](); });
1379 }
Alex Perrycb7da4b2019-08-28 19:35:56 -07001380}
1381
Austin Schuh58646e22021-08-23 23:51:46 -07001382void NodeEventLoopFactory::OnShutdown(std::function<void()> &&fn) {
1383 on_shutdown_.emplace_back(std::move(fn));
Austin Schuhc0b0f722020-12-12 18:36:06 -08001384}
Austin Schuh057d29f2021-08-21 23:05:15 -07001385
Austin Schuh58646e22021-08-23 23:51:46 -07001386void NodeEventLoopFactory::ScheduleStartup() {
1387 scheduler_.ScheduleOnStartup([this]() {
1388 UUID next_uuid = scheduler_.boot_uuid();
1389 if (boot_uuid_ != next_uuid) {
Austin Schuh188a2f62021-11-08 10:45:54 -08001390 CHECK_EQ(boot_uuid_, UUID::Zero())
1391 << ": Boot UUID changed without restarting. Did TimeConverter "
1392 "change the boot UUID without signaling a restart, or did you "
1393 "change TimeConverter?";
Austin Schuh58646e22021-08-23 23:51:46 -07001394 boot_uuid_ = next_uuid;
1395 }
1396 VLOG(1) << scheduler_.distributed_now() << " " << NodeName(this->node())
1397 << monotonic_now() << " Starting up node on boot " << boot_uuid_;
1398 Startup();
1399 });
1400}
1401
1402void NodeEventLoopFactory::Startup() {
1403 CHECK(!started_);
1404 for (size_t i = 0; i < on_startup_.size(); ++i) {
1405 on_startup_[i]();
1406 }
1407}
1408
1409void NodeEventLoopFactory::Shutdown() {
1410 for (SimulatedEventLoop *event_loop : event_loops_) {
Austin Schuhe33c08d2022-02-03 18:15:21 -08001411 CHECK(!event_loop->is_running());
Austin Schuh58646e22021-08-23 23:51:46 -07001412 }
1413
1414 CHECK(started_);
1415 started_ = false;
1416 for (std::function<void()> &fn : on_shutdown_) {
1417 fn();
1418 }
1419
1420 VLOG(1) << scheduler_.distributed_now() << " " << NodeName(node())
1421 << monotonic_now() << " Shutting down applications.";
1422 applications_.clear();
1423
1424 if (event_loops_.size() != 0u) {
1425 for (SimulatedEventLoop *event_loop : event_loops_) {
1426 LOG(ERROR) << scheduler_.distributed_now() << " " << NodeName(node())
1427 << monotonic_now() << " Event loop '" << event_loop->name()
1428 << "' failed to shut down";
1429 }
1430 }
1431 CHECK_EQ(event_loops_.size(), 0u) << "Not all event loops shut down";
1432 boot_uuid_ = UUID::Zero();
1433
1434 channels_.clear();
Austin Schuhc0b0f722020-12-12 18:36:06 -08001435}
1436
Alex Perrycb7da4b2019-08-28 19:35:56 -07001437void SimulatedEventLoopFactory::RunFor(monotonic_clock::duration duration) {
Austin Schuh58646e22021-08-23 23:51:46 -07001438 // This sets running to true too.
Austin Schuh8bd96322020-02-13 21:18:22 -08001439 scheduler_scheduler_.RunFor(duration);
Austin Schuh057d29f2021-08-21 23:05:15 -07001440 for (std::unique_ptr<NodeEventLoopFactory> &node : node_factories_) {
1441 if (node) {
1442 for (SimulatedEventLoop *loop : node->event_loops_) {
Austin Schuhe33c08d2022-02-03 18:15:21 -08001443 CHECK(!loop->is_running());
Austin Schuh057d29f2021-08-21 23:05:15 -07001444 }
1445 }
Alex Perrycb7da4b2019-08-28 19:35:56 -07001446 }
1447}
1448
1449void SimulatedEventLoopFactory::Run() {
Austin Schuh58646e22021-08-23 23:51:46 -07001450 // This sets running to true too.
Austin Schuh8bd96322020-02-13 21:18:22 -08001451 scheduler_scheduler_.Run();
Austin Schuh057d29f2021-08-21 23:05:15 -07001452 for (std::unique_ptr<NodeEventLoopFactory> &node : node_factories_) {
1453 if (node) {
1454 for (SimulatedEventLoop *loop : node->event_loops_) {
Austin Schuhe33c08d2022-02-03 18:15:21 -08001455 CHECK(!loop->is_running());
Austin Schuh057d29f2021-08-21 23:05:15 -07001456 }
1457 }
Alex Perrycb7da4b2019-08-28 19:35:56 -07001458 }
1459}
1460
Austin Schuh87dd3832021-01-01 23:07:31 -08001461void SimulatedEventLoopFactory::Exit() { scheduler_scheduler_.Exit(); }
Austin Schuh8fb315a2020-11-19 22:33:58 -08001462
Austin Schuh6f3babe2020-01-26 20:34:50 -08001463void SimulatedEventLoopFactory::DisableForwarding(const Channel *channel) {
Austin Schuh4c3b9702020-08-30 11:34:55 -07001464 CHECK(bridge_) << ": Can't disable forwarding without a message bridge.";
Austin Schuh6f3babe2020-01-26 20:34:50 -08001465 bridge_->DisableForwarding(channel);
1466}
1467
Austin Schuh4c3b9702020-08-30 11:34:55 -07001468void SimulatedEventLoopFactory::DisableStatistics() {
1469 CHECK(bridge_) << ": Can't disable statistics without a message bridge.";
1470 bridge_->DisableStatistics();
1471}
1472
Austin Schuh48205e62021-11-12 14:13:18 -08001473void SimulatedEventLoopFactory::EnableStatistics() {
1474 CHECK(bridge_) << ": Can't enable statistics without a message bridge.";
1475 bridge_->EnableStatistics();
1476}
1477
Austin Schuh2928ebe2021-02-07 22:10:27 -08001478void SimulatedEventLoopFactory::SkipTimingReport() {
1479 CHECK(bridge_) << ": Can't skip timing reports without a message bridge.";
Austin Schuh48205e62021-11-12 14:13:18 -08001480
1481 for (std::unique_ptr<NodeEventLoopFactory> &node : node_factories_) {
1482 if (node) {
1483 node->SkipTimingReport();
1484 }
1485 }
1486}
1487
1488void NodeEventLoopFactory::SkipTimingReport() {
1489 for (SimulatedEventLoop *event_loop : event_loops_) {
1490 event_loop->SkipTimingReport();
1491 }
1492 skip_timing_report_ = true;
1493}
1494
1495void NodeEventLoopFactory::EnableStatistics() {
1496 CHECK(factory_->bridge_)
1497 << ": Can't enable statistics without a message bridge.";
1498 factory_->bridge_->EnableStatistics(node_);
1499}
1500
1501void NodeEventLoopFactory::DisableStatistics() {
1502 CHECK(factory_->bridge_)
1503 << ": Can't disable statistics without a message bridge.";
1504 factory_->bridge_->DisableStatistics(node_);
Austin Schuh2928ebe2021-02-07 22:10:27 -08001505}
1506
Austin Schuh58646e22021-08-23 23:51:46 -07001507::std::unique_ptr<EventLoop> NodeEventLoopFactory::MakeEventLoop(
James Kuszmaul890c2492022-04-06 14:59:31 -07001508 std::string_view name, EventLoopOptions options) {
Austin Schuh58646e22021-08-23 23:51:46 -07001509 CHECK(!scheduler_.is_running() || !started_)
1510 << ": Can't create an event loop while running";
1511
1512 pid_t tid = tid_;
1513 ++tid_;
1514 ::std::unique_ptr<SimulatedEventLoop> result(new SimulatedEventLoop(
1515 &scheduler_, this, &channels_, factory_->configuration(), &event_loops_,
James Kuszmaul890c2492022-04-06 14:59:31 -07001516 node_, tid, options));
Austin Schuh58646e22021-08-23 23:51:46 -07001517 result->set_name(name);
1518 result->set_send_delay(factory_->send_delay());
Austin Schuh48205e62021-11-12 14:13:18 -08001519 if (skip_timing_report_) {
1520 result->SkipTimingReport();
1521 }
Austin Schuh58646e22021-08-23 23:51:46 -07001522
1523 VLOG(1) << scheduler_.distributed_now() << " " << NodeName(node())
1524 << monotonic_now() << " MakeEventLoop(\"" << result->name() << "\")";
1525 return std::move(result);
1526}
1527
Austin Schuhe33c08d2022-02-03 18:15:21 -08001528void SimulatedEventLoopFactory::AllowApplicationCreationDuring(
1529 std::function<void()> fn) {
1530 scheduler_scheduler_.TemporarilyStopAndRun(std::move(fn));
1531}
1532
Austin Schuh58646e22021-08-23 23:51:46 -07001533void NodeEventLoopFactory::Disconnect(const Node *other) {
1534 factory_->bridge_->Disconnect(node_, other);
1535}
1536
1537void NodeEventLoopFactory::Connect(const Node *other) {
1538 factory_->bridge_->Connect(node_, other);
1539}
1540
Alex Perrycb7da4b2019-08-28 19:35:56 -07001541} // namespace aos