blob: 8b2e1b8b79256ac4d47089a3ac01fc36289299e2 [file] [log] [blame]
John Park398c74a2018-10-20 21:17:39 -07001#include "aos/configuration.h"
Brian Silverman66f079a2013-08-26 16:24:30 -07002
Brian Silverman66f079a2013-08-26 16:24:30 -07003#include <arpa/inet.h>
4#include <ifaddrs.h>
Austin Schuhf1fff282020-03-28 16:57:32 -07005#include <netinet/in.h>
Austin Schuhf1fff282020-03-28 16:57:32 -07006#include <sys/types.h>
Brian Silverman66f079a2013-08-26 16:24:30 -07007#include <unistd.h>
Austin Schuhe84c3ed2019-12-14 15:29:48 -08008
Tyler Chatowbf0609c2021-07-31 16:13:27 -07009#include <cstdlib>
10#include <cstring>
Austin Schuh68d98592020-11-01 23:22:57 -080011#include <map>
Austin Schuhe84c3ed2019-12-14 15:29:48 -080012#include <set>
Austin Schuhef38cd22021-07-21 15:24:23 -070013#include <string>
James Kuszmaul3ae42262019-11-08 12:33:41 -080014#include <string_view>
Austin Schuhef38cd22021-07-21 15:24:23 -070015#include <vector>
Brian Silverman66f079a2013-08-26 16:24:30 -070016
Austin Schuhcb108412019-10-13 16:09:54 -070017#include "absl/container/btree_set.h"
Austin Schuha81454b2020-05-12 19:58:36 -070018#include "absl/strings/str_cat.h"
Austin Schuhef38cd22021-07-21 15:24:23 -070019#include "absl/strings/str_join.h"
20#include "absl/strings/str_split.h"
Austin Schuhcb108412019-10-13 16:09:54 -070021#include "aos/configuration_generated.h"
22#include "aos/flatbuffer_merge.h"
23#include "aos/json_to_flatbuffer.h"
Austin Schuh217a9782019-12-21 23:02:50 -080024#include "aos/network/team_number.h"
Austin Schuhcb108412019-10-13 16:09:54 -070025#include "aos/unique_malloc_ptr.h"
26#include "aos/util/file.h"
Austin Schuh217a9782019-12-21 23:02:50 -080027#include "gflags/gflags.h"
Austin Schuhcb108412019-10-13 16:09:54 -070028#include "glog/logging.h"
Austin Schuh217a9782019-12-21 23:02:50 -080029
Brian Silverman66f079a2013-08-26 16:24:30 -070030namespace aos {
Austin Schuh15182322020-10-10 15:25:21 -070031namespace {
Austin Schuhfb37c612022-08-11 15:24:51 -070032namespace chrono = std::chrono;
33
Austin Schuh15182322020-10-10 15:25:21 -070034bool EndsWith(std::string_view str, std::string_view end) {
35 if (str.size() < end.size()) {
36 return false;
37 }
38 if (str.substr(str.size() - end.size(), end.size()) != end) {
39 return false;
40 }
41 return true;
42}
43
44std::string MaybeReplaceExtension(std::string_view filename,
45 std::string_view extension,
46 std::string_view replacement) {
47 if (!EndsWith(filename, extension)) {
48 return std::string(filename);
49 }
50 filename.remove_suffix(extension.size());
51 return absl::StrCat(filename, replacement);
52}
53
54FlatbufferDetachedBuffer<Configuration> ReadConfigFile(std::string_view path,
55 bool binary) {
56 if (binary) {
57 FlatbufferVector<Configuration> config =
58 FileToFlatbuffer<Configuration>(path);
59 return CopySpanAsDetachedBuffer(config.span());
60 }
61
62 flatbuffers::DetachedBuffer buffer = JsonToFlatbuffer(
63 util::ReadFileToStringOrDie(path), ConfigurationTypeTable());
64
Austin Schuh84a039a2021-11-03 16:50:34 -070065 CHECK_GT(buffer.size(), 0u) << ": Failed to parse JSON file: " << path;
Austin Schuh15182322020-10-10 15:25:21 -070066
67 return FlatbufferDetachedBuffer<Configuration>(std::move(buffer));
68}
69
70} // namespace
Austin Schuh40485ed2019-10-26 21:51:44 -070071// Define the compare and equal operators for Channel and Application so we can
Austin Schuhcb108412019-10-13 16:09:54 -070072// insert them in the btree below.
Austin Schuh40485ed2019-10-26 21:51:44 -070073bool operator<(const FlatbufferDetachedBuffer<Channel> &lhs,
74 const FlatbufferDetachedBuffer<Channel> &rhs) {
Austin Schuhcb108412019-10-13 16:09:54 -070075 int name_compare = lhs.message().name()->string_view().compare(
76 rhs.message().name()->string_view());
77 if (name_compare == 0) {
78 return lhs.message().type()->string_view() <
79 rhs.message().type()->string_view();
80 } else if (name_compare < 0) {
81 return true;
82 } else {
83 return false;
84 }
85}
86
Austin Schuh40485ed2019-10-26 21:51:44 -070087bool operator==(const FlatbufferDetachedBuffer<Channel> &lhs,
88 const FlatbufferDetachedBuffer<Channel> &rhs) {
Austin Schuhcb108412019-10-13 16:09:54 -070089 return lhs.message().name()->string_view() ==
90 rhs.message().name()->string_view() &&
91 lhs.message().type()->string_view() ==
92 rhs.message().type()->string_view();
93}
94
Austin Schuha7996eb2021-10-11 19:03:24 -070095bool operator<(const FlatbufferDetachedBuffer<Connection> &lhs,
96 const FlatbufferDetachedBuffer<Connection> &rhs) {
97 return lhs.message().name()->string_view() <
98 rhs.message().name()->string_view();
99}
100
101bool operator==(const FlatbufferDetachedBuffer<Connection> &lhs,
102 const FlatbufferDetachedBuffer<Connection> &rhs) {
103 return lhs.message().name()->string_view() ==
104 rhs.message().name()->string_view();
105}
106
Austin Schuh40485ed2019-10-26 21:51:44 -0700107bool operator==(const FlatbufferDetachedBuffer<Application> &lhs,
108 const FlatbufferDetachedBuffer<Application> &rhs) {
Austin Schuhcb108412019-10-13 16:09:54 -0700109 return lhs.message().name()->string_view() ==
110 rhs.message().name()->string_view();
111}
112
Austin Schuh40485ed2019-10-26 21:51:44 -0700113bool operator<(const FlatbufferDetachedBuffer<Application> &lhs,
114 const FlatbufferDetachedBuffer<Application> &rhs) {
Austin Schuhcb108412019-10-13 16:09:54 -0700115 return lhs.message().name()->string_view() <
116 rhs.message().name()->string_view();
117}
118
Austin Schuh217a9782019-12-21 23:02:50 -0800119bool operator==(const FlatbufferDetachedBuffer<Node> &lhs,
120 const FlatbufferDetachedBuffer<Node> &rhs) {
121 return lhs.message().name()->string_view() ==
122 rhs.message().name()->string_view();
123}
124
125bool operator<(const FlatbufferDetachedBuffer<Node> &lhs,
126 const FlatbufferDetachedBuffer<Node> &rhs) {
127 return lhs.message().name()->string_view() <
128 rhs.message().name()->string_view();
129}
130
Brian Silverman66f079a2013-08-26 16:24:30 -0700131namespace configuration {
132namespace {
133
Austin Schuhcb108412019-10-13 16:09:54 -0700134// Extracts the folder part of a path. Returns ./ if there is no path.
Austin Schuhf1fff282020-03-28 16:57:32 -0700135std::string_view ExtractFolder(const std::string_view filename) {
Austin Schuhcb108412019-10-13 16:09:54 -0700136 auto last_slash_pos = filename.find_last_of("/\\");
137
James Kuszmaul3ae42262019-11-08 12:33:41 -0800138 return last_slash_pos == std::string_view::npos
139 ? std::string_view("./")
Austin Schuhcb108412019-10-13 16:09:54 -0700140 : filename.substr(0, last_slash_pos + 1);
141}
142
James Kuszmaulc0c08da2020-05-10 18:56:07 -0700143std::string AbsolutePath(const std::string_view filename) {
144 // Uses an std::string so that we know the input will be null-terminated.
145 const std::string terminated_file(filename);
146 char buffer[PATH_MAX];
147 PCHECK(NULL != realpath(terminated_file.c_str(), buffer));
148 return buffer;
149}
150
Austin Schuhef38cd22021-07-21 15:24:23 -0700151std::string RemoveDotDots(const std::string_view filename) {
152 std::vector<std::string> split = absl::StrSplit(filename, '/');
153 auto iterator = split.begin();
154 while (iterator != split.end()) {
155 if (iterator->empty()) {
156 iterator = split.erase(iterator);
157 } else if (*iterator == ".") {
158 iterator = split.erase(iterator);
159 } else if (*iterator == "..") {
160 CHECK(iterator != split.begin())
161 << ": Import path may not start with ..: " << filename;
162 auto previous = iterator;
163 --previous;
164 split.erase(iterator);
165 iterator = split.erase(previous);
166 } else {
167 ++iterator;
168 }
169 }
170 return absl::StrJoin(split, "/");
171}
172
Milind Upadhyay17098ba2022-04-15 22:18:50 -0700173std::optional<FlatbufferDetachedBuffer<Configuration>> MaybeReadConfig(
James Kuszmaulc0c08da2020-05-10 18:56:07 -0700174 const std::string_view path, absl::btree_set<std::string> *visited_paths,
175 const std::vector<std::string_view> &extra_import_paths) {
Austin Schuh15182322020-10-10 15:25:21 -0700176 std::string binary_path = MaybeReplaceExtension(path, ".json", ".bfbs");
Austin Schuhef38cd22021-07-21 15:24:23 -0700177 VLOG(1) << "Looking up: " << path << ", starting with: " << binary_path;
Austin Schuh15182322020-10-10 15:25:21 -0700178 bool binary_path_exists = util::PathExists(binary_path);
James Kuszmaulc0c08da2020-05-10 18:56:07 -0700179 std::string raw_path(path);
Austin Schuh15182322020-10-10 15:25:21 -0700180 // For each .json file, look and see if we can find a .bfbs file next to it
181 // with the same base name. If we can, assume it is the same and use it
182 // instead. It is much faster to load .bfbs files than .json files.
183 if (!binary_path_exists && !util::PathExists(raw_path)) {
184 const bool path_is_absolute = raw_path.size() > 0 && raw_path[0] == '/';
Brian Silvermand0588192022-07-26 00:35:22 -0700185 if (path_is_absolute) {
186 // Nowhere else to look up an absolute path, so fail now. Note that we
187 // always have at least one extra import path based on /proc/self/exe, so
188 // warning about those paths existing isn't helpful.
189 LOG(ERROR) << ": Failed to find file " << path << ".";
Milind Upadhyay17098ba2022-04-15 22:18:50 -0700190 return std::nullopt;
James Kuszmaulc0c08da2020-05-10 18:56:07 -0700191 }
192
193 bool found_path = false;
194 for (const auto &import_path : extra_import_paths) {
Austin Schuhef38cd22021-07-21 15:24:23 -0700195 raw_path = std::string(import_path) + "/" + RemoveDotDots(path);
Austin Schuh15182322020-10-10 15:25:21 -0700196 binary_path = MaybeReplaceExtension(raw_path, ".json", ".bfbs");
Austin Schuhef38cd22021-07-21 15:24:23 -0700197 VLOG(1) << "Checking: " << binary_path;
Austin Schuh15182322020-10-10 15:25:21 -0700198 binary_path_exists = util::PathExists(binary_path);
199 if (binary_path_exists) {
200 found_path = true;
201 break;
202 }
Austin Schuhef38cd22021-07-21 15:24:23 -0700203 VLOG(1) << "Checking: " << raw_path;
James Kuszmaulc0c08da2020-05-10 18:56:07 -0700204 if (util::PathExists(raw_path)) {
205 found_path = true;
206 break;
207 }
208 }
Milind Upadhyay17098ba2022-04-15 22:18:50 -0700209 if (!found_path) {
210 LOG(ERROR) << ": Failed to find file " << path << ".";
211 return std::nullopt;
212 }
James Kuszmaulc0c08da2020-05-10 18:56:07 -0700213 }
Alex Perrycb7da4b2019-08-28 19:35:56 -0700214
Milind Upadhyay17098ba2022-04-15 22:18:50 -0700215 std::optional<FlatbufferDetachedBuffer<Configuration>> config =
216 ReadConfigFile(binary_path_exists ? binary_path : raw_path,
217 binary_path_exists);
James Kuszmaulc0c08da2020-05-10 18:56:07 -0700218
Austin Schuhcb108412019-10-13 16:09:54 -0700219 // Depth first. Take the following example:
220 //
221 // config1.json:
222 // {
Austin Schuh40485ed2019-10-26 21:51:44 -0700223 // "channels": [
Austin Schuhcb108412019-10-13 16:09:54 -0700224 // {
225 // "name": "/foo",
226 // "type": ".aos.bar",
227 // "max_size": 5
228 // }
229 // ],
230 // "imports": [
231 // "config2.json",
232 // ]
233 // }
234 //
235 // config2.json:
236 // {
Austin Schuh40485ed2019-10-26 21:51:44 -0700237 // "channels": [
Austin Schuhcb108412019-10-13 16:09:54 -0700238 // {
239 // "name": "/foo",
240 // "type": ".aos.bar",
241 // "max_size": 7
242 // }
243 // ],
244 // }
245 //
246 // We want the main config (config1.json) to be able to override the imported
247 // config. That means that it needs to be merged into the imported configs,
248 // not the other way around.
249
Austin Schuh15182322020-10-10 15:25:21 -0700250 const std::string absolute_path =
251 AbsolutePath(binary_path_exists ? binary_path : raw_path);
252 // Track that we have seen this file before recursing. Track the path we
253 // actually loaded (which should be consistent if imported twice).
James Kuszmaulc0c08da2020-05-10 18:56:07 -0700254 if (!visited_paths->insert(absolute_path).second) {
255 for (const auto &visited_path : *visited_paths) {
256 LOG(INFO) << "Already visited: " << visited_path;
257 }
258 LOG(FATAL)
259 << "Already imported " << path << " (i.e. " << absolute_path
260 << "). See above for the files that have already been processed.";
Milind Upadhyay17098ba2022-04-15 22:18:50 -0700261 return std::nullopt;
James Kuszmaulc0c08da2020-05-10 18:56:07 -0700262 }
Austin Schuhcb108412019-10-13 16:09:54 -0700263
Milind Upadhyay17098ba2022-04-15 22:18:50 -0700264 if (config->message().has_imports()) {
Austin Schuhcb108412019-10-13 16:09:54 -0700265 // Capture the imports.
266 const flatbuffers::Vector<flatbuffers::Offset<flatbuffers::String>> *v =
Milind Upadhyay17098ba2022-04-15 22:18:50 -0700267 config->message().imports();
Austin Schuhcb108412019-10-13 16:09:54 -0700268
269 // And then wipe them. This gets GCed when we merge later.
Milind Upadhyay17098ba2022-04-15 22:18:50 -0700270 config->mutable_message()->clear_imports();
Austin Schuhcb108412019-10-13 16:09:54 -0700271
272 // Start with an empty configuration to merge into.
Austin Schuh40485ed2019-10-26 21:51:44 -0700273 FlatbufferDetachedBuffer<Configuration> merged_config =
274 FlatbufferDetachedBuffer<Configuration>::Empty();
Austin Schuhcb108412019-10-13 16:09:54 -0700275
James Kuszmaulc0c08da2020-05-10 18:56:07 -0700276 const std::string path_folder(ExtractFolder(path));
Austin Schuhcb108412019-10-13 16:09:54 -0700277 for (const flatbuffers::String *str : *v) {
James Kuszmaulc0c08da2020-05-10 18:56:07 -0700278 const std::string included_config =
279 path_folder + "/" + std::string(str->string_view());
Austin Schuhcb108412019-10-13 16:09:54 -0700280
Milind Upadhyay17098ba2022-04-15 22:18:50 -0700281 const auto optional_config =
282 MaybeReadConfig(included_config, visited_paths, extra_import_paths);
283 if (!optional_config.has_value()) {
284 return std::nullopt;
285 }
Austin Schuhcb108412019-10-13 16:09:54 -0700286 // And them merge everything in.
Milind Upadhyay17098ba2022-04-15 22:18:50 -0700287 merged_config = MergeFlatBuffers(merged_config, *optional_config);
Austin Schuhcb108412019-10-13 16:09:54 -0700288 }
289
290 // Finally, merge this file in.
Milind Upadhyay17098ba2022-04-15 22:18:50 -0700291 config = MergeFlatBuffers(merged_config, *config);
Austin Schuhcb108412019-10-13 16:09:54 -0700292 }
293 return config;
294}
295
Alex Perrycb7da4b2019-08-28 19:35:56 -0700296// Compares (c < p) a channel, and a name, type tuple.
297bool CompareChannels(const Channel *c,
James Kuszmaul3ae42262019-11-08 12:33:41 -0800298 ::std::pair<std::string_view, std::string_view> p) {
Alex Perrycb7da4b2019-08-28 19:35:56 -0700299 int name_compare = c->name()->string_view().compare(p.first);
300 if (name_compare == 0) {
301 return c->type()->string_view() < p.second;
302 } else if (name_compare < 0) {
303 return true;
304 } else {
305 return false;
306 }
307};
308
309// Compares for equality (c == p) a channel, and a name, type tuple.
310bool EqualsChannels(const Channel *c,
Austin Schuhf1fff282020-03-28 16:57:32 -0700311 ::std::pair<std::string_view, std::string_view> p) {
Alex Perrycb7da4b2019-08-28 19:35:56 -0700312 return c->name()->string_view() == p.first &&
313 c->type()->string_view() == p.second;
314}
315
316// Compares (c < p) an application, and a name;
James Kuszmaul3ae42262019-11-08 12:33:41 -0800317bool CompareApplications(const Application *a, std::string_view name) {
Alex Perrycb7da4b2019-08-28 19:35:56 -0700318 return a->name()->string_view() < name;
319};
320
321// Compares for equality (c == p) an application, and a name;
James Kuszmaul3ae42262019-11-08 12:33:41 -0800322bool EqualsApplications(const Application *a, std::string_view name) {
Alex Perrycb7da4b2019-08-28 19:35:56 -0700323 return a->name()->string_view() == name;
324}
325
Austin Schuh15182322020-10-10 15:25:21 -0700326void ValidateConfiguration(const Flatbuffer<Configuration> &config) {
327 // No imports should be left.
328 CHECK(!config.message().has_imports());
329
330 // Check that if there is a node list, all the source nodes are filled out and
331 // valid, and all the destination nodes are valid (and not the source). This
332 // is a basic consistency check.
333 if (config.message().has_channels()) {
334 const Channel *last_channel = nullptr;
335 for (const Channel *c : *config.message().channels()) {
336 CHECK(c->has_name());
337 CHECK(c->has_type());
338 if (c->name()->string_view().back() == '/') {
339 LOG(FATAL) << "Channel names can't end with '/'";
340 }
341 if (c->name()->string_view().find("//") != std::string_view::npos) {
342 LOG(FATAL) << ": Invalid channel name " << c->name()->string_view()
343 << ", can't use //.";
344 }
345 for (const char data : c->name()->string_view()) {
346 if (data >= '0' && data <= '9') {
347 continue;
348 }
349 if (data >= 'a' && data <= 'z') {
350 continue;
351 }
352 if (data >= 'A' && data <= 'Z') {
353 continue;
354 }
355 if (data == '-' || data == '_' || data == '/') {
356 continue;
357 }
358 LOG(FATAL) << "Invalid channel name " << c->name()->string_view()
359 << ", can only use [-a-zA-Z0-9_/]";
360 }
361
Austin Schuhfb37c612022-08-11 15:24:51 -0700362 CHECK_LT(QueueSize(&config.message(), c) + QueueScratchBufferSize(c),
363 std::numeric_limits<uint16_t>::max())
364 << ": More messages/second configured than the queue can hold on "
365 << CleanedChannelToString(c) << ", " << c->frequency() << "hz for "
366 << config.message().channel_storage_duration() << "ns";
367
Austin Schuha156fb22021-10-11 19:23:21 -0700368 if (c->has_logger_nodes()) {
369 // Confirm that we don't have duplicate logger nodes.
370 absl::btree_set<std::string_view> logger_nodes;
371 for (const flatbuffers::String *s : *c->logger_nodes()) {
372 logger_nodes.insert(s->string_view());
373 }
374 CHECK_EQ(static_cast<size_t>(logger_nodes.size()),
375 c->logger_nodes()->size())
376 << ": Found duplicate logger_nodes in "
377 << CleanedChannelToString(c);
378 }
379
380 if (c->has_destination_nodes()) {
381 // Confirm that we don't have duplicate timestamp logger nodes.
Austin Schuh5e95bd62021-10-11 18:40:22 -0700382 for (const Connection *d : *c->destination_nodes()) {
Austin Schuha156fb22021-10-11 19:23:21 -0700383 if (d->has_timestamp_logger_nodes()) {
384 absl::btree_set<std::string_view> timestamp_logger_nodes;
385 for (const flatbuffers::String *s : *d->timestamp_logger_nodes()) {
386 timestamp_logger_nodes.insert(s->string_view());
387 }
388 CHECK_EQ(static_cast<size_t>(timestamp_logger_nodes.size()),
389 d->timestamp_logger_nodes()->size())
390 << ": Found duplicate timestamp_logger_nodes in "
391 << CleanedChannelToString(c);
392 }
393 }
394
395 // There is no good use case today for logging timestamps but not the
396 // corresponding data. Instead of plumbing through all of this on the
397 // reader side, let'd just disallow it for now.
398 if (c->logger() == LoggerConfig::NOT_LOGGED) {
399 for (const Connection *d : *c->destination_nodes()) {
400 CHECK(d->timestamp_logger() == LoggerConfig::NOT_LOGGED)
401 << ": Logging timestamps without data is not supported. If "
402 "you have a good use case, let's talk. "
403 << CleanedChannelToString(c);
404 }
Austin Schuh5e95bd62021-10-11 18:40:22 -0700405 }
406 }
407
Austin Schuh15182322020-10-10 15:25:21 -0700408 // Make sure everything is sorted while we are here... If this fails,
409 // there will be a bunch of weird errors.
410 if (last_channel != nullptr) {
411 CHECK(CompareChannels(
412 last_channel,
413 std::make_pair(c->name()->string_view(), c->type()->string_view())))
414 << ": Channels not sorted!";
415 }
416 last_channel = c;
417 }
418 }
419
420 if (config.message().has_nodes() && config.message().has_channels()) {
421 for (const Channel *c : *config.message().channels()) {
422 CHECK(c->has_source_node()) << ": Channel " << FlatbufferToJson(c)
423 << " is missing \"source_node\"";
424 CHECK(GetNode(&config.message(), c->source_node()->string_view()) !=
425 nullptr)
426 << ": Channel " << FlatbufferToJson(c)
427 << " has an unknown \"source_node\"";
428
429 if (c->has_destination_nodes()) {
430 for (const Connection *connection : *c->destination_nodes()) {
431 CHECK(connection->has_name());
432 CHECK(GetNode(&config.message(), connection->name()->string_view()) !=
433 nullptr)
434 << ": Channel " << FlatbufferToJson(c)
435 << " has an unknown \"destination_nodes\" "
436 << connection->name()->string_view();
437
438 switch (connection->timestamp_logger()) {
439 case LoggerConfig::LOCAL_LOGGER:
440 case LoggerConfig::NOT_LOGGED:
Austin Schuhb98d02d2022-08-16 13:27:25 -0700441 CHECK(!connection->has_timestamp_logger_nodes())
442 << ": " << CleanedChannelToString(c);
Austin Schuh15182322020-10-10 15:25:21 -0700443 break;
444 case LoggerConfig::REMOTE_LOGGER:
445 case LoggerConfig::LOCAL_AND_REMOTE_LOGGER:
446 CHECK(connection->has_timestamp_logger_nodes());
447 CHECK_GT(connection->timestamp_logger_nodes()->size(), 0u);
448 for (const flatbuffers::String *timestamp_logger_node :
449 *connection->timestamp_logger_nodes()) {
450 CHECK(GetNode(&config.message(),
451 timestamp_logger_node->string_view()) != nullptr)
452 << ": Channel " << FlatbufferToJson(c)
453 << " has an unknown \"timestamp_logger_node\""
454 << connection->name()->string_view();
455 }
456 break;
457 }
458
459 CHECK_NE(connection->name()->string_view(),
460 c->source_node()->string_view())
461 << ": Channel " << FlatbufferToJson(c)
462 << " is forwarding data to itself";
463 }
464 }
465 }
466 }
467}
468
James Kuszmaulc8503f32022-06-25 16:17:12 -0700469void HandleReverseMaps(
470 const flatbuffers::Vector<flatbuffers::Offset<aos::Map>> *maps,
471 std::string_view type, const Node *node, std::set<std::string> *names) {
472 for (const Map *map : *maps) {
473 CHECK_NOTNULL(map);
474 const Channel *const match = CHECK_NOTNULL(map->match());
475 const Channel *const rename = CHECK_NOTNULL(map->rename());
476
477 // Handle type specific maps.
478 const flatbuffers::String *const match_type_string = match->type();
479 if (match_type_string != nullptr &&
480 match_type_string->string_view() != type) {
481 continue;
482 }
483
484 // Now handle node specific maps.
485 const flatbuffers::String *const match_source_node_string =
486 match->source_node();
487 if (node != nullptr && match_source_node_string != nullptr &&
488 match_source_node_string->string_view() !=
489 node->name()->string_view()) {
490 continue;
491 }
492
493 const flatbuffers::String *const match_name_string = match->name();
494 const flatbuffers::String *const rename_name_string = rename->name();
495 if (match_name_string == nullptr || rename_name_string == nullptr) {
496 continue;
497 }
498
499 const std::string rename_name = rename_name_string->str();
500 const std::string_view match_name = match_name_string->string_view();
501
502 std::set<std::string> possible_renames;
503
504 // Check if the current name(s) could have been reached using the provided
505 // rename.
506 if (match_name.back() == '*') {
507 for (const std::string &option : *names) {
508 if (option.substr(0, rename_name.size()) == rename_name) {
509 possible_renames.insert(
510 absl::StrCat(match_name.substr(0, match_name.size() - 1),
511 option.substr(rename_name.size())));
512 }
513 }
514 names->insert(possible_renames.begin(), possible_renames.end());
515 } else if (names->count(rename_name) != 0) {
516 names->insert(std::string(match_name));
517 }
518 }
519}
520
Alex Perrycb7da4b2019-08-28 19:35:56 -0700521} // namespace
522
Austin Schuh006a9f52021-04-07 16:24:18 -0700523// Maps name for the provided maps. Modifies name.
Brian Silvermanf3798cb2021-11-10 12:26:34 -0800524//
525// This is called many times during startup, and it dereferences a lot of
526// pointers. These combine to make it a performance hotspot during many tests
527// under msan, so there is some optimizing around caching intermediates instead
528// of dereferencing the pointer multiple times.
James Kuszmaulc8503f32022-06-25 16:17:12 -0700529//
530// Deliberately not in an anonymous namespace so that the log-reading code can
531// reference it.
Austin Schuh006a9f52021-04-07 16:24:18 -0700532void HandleMaps(const flatbuffers::Vector<flatbuffers::Offset<aos::Map>> *maps,
533 std::string *name, std::string_view type, const Node *node) {
534 // For the same reason we merge configs in reverse order, we want to process
535 // maps in reverse order. That lets the outer config overwrite channels from
536 // the inner configs.
537 for (auto i = maps->rbegin(); i != maps->rend(); ++i) {
Brian Silvermanf3798cb2021-11-10 12:26:34 -0800538 const Channel *const match = i->match();
539 if (!match) {
Austin Schuh006a9f52021-04-07 16:24:18 -0700540 continue;
541 }
Brian Silvermanf3798cb2021-11-10 12:26:34 -0800542 const flatbuffers::String *const match_name_string = match->name();
543 if (!match_name_string) {
544 continue;
545 }
546 const Channel *const rename = i->rename();
547 if (!rename) {
548 continue;
549 }
550 const flatbuffers::String *const rename_name_string = rename->name();
551 if (!rename_name_string) {
Austin Schuh006a9f52021-04-07 16:24:18 -0700552 continue;
553 }
554
555 // Handle normal maps (now that we know that match and rename are filled
556 // out).
Brian Silvermanf3798cb2021-11-10 12:26:34 -0800557 const std::string_view match_name = match_name_string->string_view();
Austin Schuh006a9f52021-04-07 16:24:18 -0700558 if (match_name != *name) {
559 if (match_name.back() == '*' &&
560 std::string_view(*name).substr(
561 0, std::min(name->size(), match_name.size() - 1)) ==
562 match_name.substr(0, match_name.size() - 1)) {
563 CHECK_EQ(match_name.find('*'), match_name.size() - 1);
564 } else {
565 continue;
566 }
567 }
568
569 // Handle type specific maps.
Brian Silvermanf3798cb2021-11-10 12:26:34 -0800570 const flatbuffers::String *const match_type_string = match->type();
571 if (match_type_string && match_type_string->string_view() != type) {
Austin Schuh006a9f52021-04-07 16:24:18 -0700572 continue;
573 }
574
575 // Now handle node specific maps.
Brian Silvermanf3798cb2021-11-10 12:26:34 -0800576 const flatbuffers::String *const match_source_node_string =
577 match->source_node();
578 if (node && match_source_node_string &&
579 match_source_node_string->string_view() !=
Austin Schuh006a9f52021-04-07 16:24:18 -0700580 node->name()->string_view()) {
581 continue;
582 }
583
Brian Silvermanf3798cb2021-11-10 12:26:34 -0800584 std::string new_name(rename_name_string->string_view());
Austin Schuh006a9f52021-04-07 16:24:18 -0700585 if (match_name.back() == '*') {
586 new_name += std::string(name->substr(match_name.size() - 1));
587 }
588 VLOG(1) << "Renamed \"" << *name << "\" to \"" << new_name << "\"";
589 *name = std::move(new_name);
590 }
591}
592
James Kuszmaulc8503f32022-06-25 16:17:12 -0700593std::set<std::string> GetChannelAliases(const Configuration *config,
594 std::string_view name,
595 std::string_view type,
596 const std::string_view application_name,
597 const Node *node) {
598 std::set<std::string> names{std::string(name)};
599 if (config->has_maps()) {
600 HandleReverseMaps(config->maps(), type, node, &names);
601 }
602 {
603 const Application *application =
604 GetApplication(config, node, application_name);
605 if (application != nullptr && application->has_maps()) {
606 HandleReverseMaps(application->maps(), type, node, &names);
607 }
608 }
609 return names;
610}
611
Austin Schuh40485ed2019-10-26 21:51:44 -0700612FlatbufferDetachedBuffer<Configuration> MergeConfiguration(
Austin Schuhcb108412019-10-13 16:09:54 -0700613 const Flatbuffer<Configuration> &config) {
James Kuszmaul3c998592020-07-27 21:04:47 -0700614 // auto_merge_config will contain all the fields of the Configuration that are
615 // to be passed through unmodified to the result of MergeConfiguration().
616 // In the processing below, we mutate auto_merge_config to remove any fields
617 // which we do need to alter (hence why we can't use the input config
618 // directly), and then merge auto_merge_config back in at the end.
619 aos::FlatbufferDetachedBuffer<aos::Configuration> auto_merge_config =
Austin Schuha4fc60f2020-11-01 23:06:47 -0800620 aos::RecursiveCopyFlatBuffer(&config.message());
James Kuszmaul3c998592020-07-27 21:04:47 -0700621
Austin Schuh40485ed2019-10-26 21:51:44 -0700622 // Store all the channels in a sorted set. This lets us track channels we
Austin Schuhcb108412019-10-13 16:09:54 -0700623 // have seen before and merge the updates in.
Austin Schuh40485ed2019-10-26 21:51:44 -0700624 absl::btree_set<FlatbufferDetachedBuffer<Channel>> channels;
Austin Schuhcb108412019-10-13 16:09:54 -0700625
Austin Schuh40485ed2019-10-26 21:51:44 -0700626 if (config.message().has_channels()) {
James Kuszmaul3c998592020-07-27 21:04:47 -0700627 auto_merge_config.mutable_message()->clear_channels();
Austin Schuh40485ed2019-10-26 21:51:44 -0700628 for (const Channel *c : *config.message().channels()) {
Austin Schuhcb108412019-10-13 16:09:54 -0700629 // Ignore malformed entries.
Austin Schuh40485ed2019-10-26 21:51:44 -0700630 if (!c->has_name()) {
Austin Schuhcb108412019-10-13 16:09:54 -0700631 continue;
632 }
Austin Schuh40485ed2019-10-26 21:51:44 -0700633 if (!c->has_type()) {
Austin Schuhcb108412019-10-13 16:09:54 -0700634 continue;
635 }
636
Brian Silverman77162972020-08-12 19:52:40 -0700637 CHECK_EQ(c->read_method() == ReadMethod::PIN, c->num_readers() != 0)
638 << ": num_readers may be set if and only if read_method is PIN,"
639 " if you want 0 readers do not set PIN: "
640 << CleanedChannelToString(c);
641
Austin Schuh40485ed2019-10-26 21:51:44 -0700642 // Attempt to insert the channel.
Austin Schuha4fc60f2020-11-01 23:06:47 -0800643 auto result = channels.insert(RecursiveCopyFlatBuffer(c));
Austin Schuhcb108412019-10-13 16:09:54 -0700644 if (!result.second) {
645 // Already there, so merge the new table into the original.
Austin Schuh4a5f5d22021-10-12 15:09:35 -0700646 // Schemas merge poorly, so pick the newest one.
647 if (result.first->message().has_schema() && c->has_schema()) {
648 result.first->mutable_message()->clear_schema();
649 }
Austin Schuha7996eb2021-10-11 19:03:24 -0700650 auto merged =
Austin Schuha4fc60f2020-11-01 23:06:47 -0800651 MergeFlatBuffers(*result.first, RecursiveCopyFlatBuffer(c));
Austin Schuha7996eb2021-10-11 19:03:24 -0700652
653 if (merged.message().has_destination_nodes()) {
654 absl::btree_set<FlatbufferDetachedBuffer<Connection>> connections;
655 for (const Connection *connection :
656 *merged.message().destination_nodes()) {
657 auto connection_result =
658 connections.insert(RecursiveCopyFlatBuffer(connection));
659 if (!connection_result.second) {
660 *connection_result.first =
661 MergeFlatBuffers(*connection_result.first,
662 RecursiveCopyFlatBuffer(connection));
663 }
664 }
665 if (static_cast<size_t>(connections.size()) !=
666 merged.message().destination_nodes()->size()) {
667 merged.mutable_message()->clear_destination_nodes();
668 flatbuffers::FlatBufferBuilder fbb;
669 fbb.ForceDefaults(true);
670 std::vector<flatbuffers::Offset<Connection>> connection_offsets;
671 for (const FlatbufferDetachedBuffer<Connection> &connection :
672 connections) {
673 connection_offsets.push_back(
674 RecursiveCopyFlatBuffer(&connection.message(), &fbb));
675 }
676 flatbuffers::Offset<
677 flatbuffers::Vector<flatbuffers::Offset<Connection>>>
678 destination_nodes_offset = fbb.CreateVector(connection_offsets);
679 Channel::Builder channel_builder(fbb);
680 channel_builder.add_destination_nodes(destination_nodes_offset);
681 fbb.Finish(channel_builder.Finish());
682 FlatbufferDetachedBuffer<Channel> destinations_channel(
683 fbb.Release());
684 merged = MergeFlatBuffers(merged, destinations_channel);
685 }
686 }
687
688 *result.first = std::move(merged);
Austin Schuhcb108412019-10-13 16:09:54 -0700689 }
690 }
691 }
692
693 // Now repeat this for the application list.
Austin Schuh40485ed2019-10-26 21:51:44 -0700694 absl::btree_set<FlatbufferDetachedBuffer<Application>> applications;
Austin Schuhcb108412019-10-13 16:09:54 -0700695 if (config.message().has_applications()) {
James Kuszmaul3c998592020-07-27 21:04:47 -0700696 auto_merge_config.mutable_message()->clear_applications();
Austin Schuhcb108412019-10-13 16:09:54 -0700697 for (const Application *a : *config.message().applications()) {
698 if (!a->has_name()) {
699 continue;
700 }
701
Austin Schuha4fc60f2020-11-01 23:06:47 -0800702 auto result = applications.insert(RecursiveCopyFlatBuffer(a));
Austin Schuhcb108412019-10-13 16:09:54 -0700703 if (!result.second) {
Austin Schuhf81c2522021-12-08 12:03:30 -0800704 if (a->has_args()) {
705 result.first->mutable_message()->clear_args();
706 }
Austin Schuha4fc60f2020-11-01 23:06:47 -0800707 *result.first =
708 MergeFlatBuffers(*result.first, RecursiveCopyFlatBuffer(a));
Austin Schuhcb108412019-10-13 16:09:54 -0700709 }
710 }
711 }
712
Austin Schuh217a9782019-12-21 23:02:50 -0800713 // Now repeat this for the node list.
714 absl::btree_set<FlatbufferDetachedBuffer<Node>> nodes;
715 if (config.message().has_nodes()) {
James Kuszmaul3c998592020-07-27 21:04:47 -0700716 auto_merge_config.mutable_message()->clear_nodes();
Austin Schuh217a9782019-12-21 23:02:50 -0800717 for (const Node *n : *config.message().nodes()) {
718 if (!n->has_name()) {
719 continue;
720 }
721
Austin Schuha4fc60f2020-11-01 23:06:47 -0800722 auto result = nodes.insert(RecursiveCopyFlatBuffer(n));
Austin Schuh217a9782019-12-21 23:02:50 -0800723 if (!result.second) {
Austin Schuha4fc60f2020-11-01 23:06:47 -0800724 *result.first =
725 MergeFlatBuffers(*result.first, RecursiveCopyFlatBuffer(n));
Austin Schuh217a9782019-12-21 23:02:50 -0800726 }
727 }
728 }
729
Austin Schuhcb108412019-10-13 16:09:54 -0700730 flatbuffers::FlatBufferBuilder fbb;
Austin Schuhd7b15da2020-02-17 15:06:11 -0800731 fbb.ForceDefaults(true);
Austin Schuhcb108412019-10-13 16:09:54 -0700732
733 // Start by building the vectors. They need to come before the final table.
Austin Schuh40485ed2019-10-26 21:51:44 -0700734 // Channels
735 flatbuffers::Offset<flatbuffers::Vector<flatbuffers::Offset<Channel>>>
736 channels_offset;
Austin Schuhcb108412019-10-13 16:09:54 -0700737 {
Austin Schuh40485ed2019-10-26 21:51:44 -0700738 ::std::vector<flatbuffers::Offset<Channel>> channel_offsets;
739 for (const FlatbufferDetachedBuffer<Channel> &c : channels) {
Austin Schuha4fc60f2020-11-01 23:06:47 -0800740 channel_offsets.emplace_back(
741 RecursiveCopyFlatBuffer<Channel>(&c.message(), &fbb));
Austin Schuhcb108412019-10-13 16:09:54 -0700742 }
Austin Schuh40485ed2019-10-26 21:51:44 -0700743 channels_offset = fbb.CreateVector(channel_offsets);
Austin Schuhcb108412019-10-13 16:09:54 -0700744 }
745
746 // Applications
747 flatbuffers::Offset<flatbuffers::Vector<flatbuffers::Offset<Application>>>
748 applications_offset;
749 {
750 ::std::vector<flatbuffers::Offset<Application>> applications_offsets;
Austin Schuh40485ed2019-10-26 21:51:44 -0700751 for (const FlatbufferDetachedBuffer<Application> &a : applications) {
Austin Schuhcb108412019-10-13 16:09:54 -0700752 applications_offsets.emplace_back(
Austin Schuha4fc60f2020-11-01 23:06:47 -0800753 RecursiveCopyFlatBuffer<Application>(&a.message(), &fbb));
Austin Schuhcb108412019-10-13 16:09:54 -0700754 }
755 applications_offset = fbb.CreateVector(applications_offsets);
756 }
757
Austin Schuh217a9782019-12-21 23:02:50 -0800758 // Nodes
759 flatbuffers::Offset<flatbuffers::Vector<flatbuffers::Offset<Node>>>
760 nodes_offset;
761 {
762 ::std::vector<flatbuffers::Offset<Node>> node_offsets;
763 for (const FlatbufferDetachedBuffer<Node> &n : nodes) {
Austin Schuha4fc60f2020-11-01 23:06:47 -0800764 node_offsets.emplace_back(
765 RecursiveCopyFlatBuffer<Node>(&n.message(), &fbb));
Austin Schuh217a9782019-12-21 23:02:50 -0800766 }
767 nodes_offset = fbb.CreateVector(node_offsets);
768 }
769
Austin Schuhcb108412019-10-13 16:09:54 -0700770 // And then build a Configuration with them all.
771 ConfigurationBuilder configuration_builder(fbb);
Austin Schuh40485ed2019-10-26 21:51:44 -0700772 configuration_builder.add_channels(channels_offset);
Austin Schuh217a9782019-12-21 23:02:50 -0800773 if (config.message().has_applications()) {
774 configuration_builder.add_applications(applications_offset);
775 }
776 if (config.message().has_nodes()) {
777 configuration_builder.add_nodes(nodes_offset);
778 }
Austin Schuhcb108412019-10-13 16:09:54 -0700779
780 fbb.Finish(configuration_builder.Finish());
Austin Schuh217a9782019-12-21 23:02:50 -0800781
James Kuszmaul3c998592020-07-27 21:04:47 -0700782 aos::FlatbufferDetachedBuffer<aos::Configuration> modified_config(
783 fbb.Release());
784
Austin Schuh217a9782019-12-21 23:02:50 -0800785 // Now, validate that if there is a node list, every channel has a source
786 // node.
James Kuszmaul3c998592020-07-27 21:04:47 -0700787 FlatbufferDetachedBuffer<Configuration> result =
788 MergeFlatBuffers(modified_config, auto_merge_config);
Austin Schuh217a9782019-12-21 23:02:50 -0800789
Austin Schuh15182322020-10-10 15:25:21 -0700790 ValidateConfiguration(result);
Austin Schuh217a9782019-12-21 23:02:50 -0800791
792 return result;
Austin Schuhcb108412019-10-13 16:09:54 -0700793}
794
Milind Upadhyay17098ba2022-04-15 22:18:50 -0700795std::optional<FlatbufferDetachedBuffer<Configuration>> MaybeReadConfig(
James Kuszmaulc0c08da2020-05-10 18:56:07 -0700796 const std::string_view path,
Austin Schuhef38cd22021-07-21 15:24:23 -0700797 const std::vector<std::string_view> &extra_import_paths) {
Austin Schuh89026f52022-02-25 14:24:04 -0800798 // Add the executable directory to the search path. That makes it so that
799 // tools can be run from any directory without hard-coding an absolute path to
800 // the config into all binaries.
801 std::vector<std::string_view> extra_import_paths_with_exe =
802 extra_import_paths;
803 char proc_self_exec_buffer[PATH_MAX + 1];
804 std::memset(proc_self_exec_buffer, 0, sizeof(proc_self_exec_buffer));
805 ssize_t s = readlink("/proc/self/exe", proc_self_exec_buffer, PATH_MAX);
806 if (s > 0) {
807 // If the readlink call fails, the worst thing that happens is that we don't
808 // automatically find the config next to the binary. VLOG to make it easier
809 // to debug.
810 std::string_view proc_self_exec(proc_self_exec_buffer);
811
812 extra_import_paths_with_exe.emplace_back(
813 proc_self_exec.substr(0, proc_self_exec.rfind("/")));
814 } else {
815 VLOG(1) << "Failed to read /proc/self/exe";
816 }
817
Austin Schuhcb108412019-10-13 16:09:54 -0700818 // We only want to read a file once. So track the visited files in a set.
819 absl::btree_set<std::string> visited_paths;
Milind Upadhyay17098ba2022-04-15 22:18:50 -0700820 std::optional<FlatbufferDetachedBuffer<Configuration>> read_config =
821 MaybeReadConfig(path, &visited_paths, extra_import_paths_with_exe);
822
823 if (read_config == std::nullopt) {
824 return read_config;
825 }
Austin Schuh15182322020-10-10 15:25:21 -0700826
827 // If we only read one file, and it had a .bfbs extension, it has to be a
828 // fully formatted config. Do a quick verification and return it.
829 if (visited_paths.size() == 1 && EndsWith(*visited_paths.begin(), ".bfbs")) {
Milind Upadhyay17098ba2022-04-15 22:18:50 -0700830 ValidateConfiguration(*read_config);
Austin Schuh15182322020-10-10 15:25:21 -0700831 return read_config;
832 }
833
Milind Upadhyay17098ba2022-04-15 22:18:50 -0700834 return MergeConfiguration(*read_config);
835}
836
837FlatbufferDetachedBuffer<Configuration> ReadConfig(
838 const std::string_view path,
839 const std::vector<std::string_view> &extra_import_paths) {
840 auto optional_config = MaybeReadConfig(path, extra_import_paths);
841 CHECK(optional_config) << "Could not read config. See above errors";
842 return std::move(*optional_config);
Austin Schuhcb108412019-10-13 16:09:54 -0700843}
844
Austin Schuh8d6cea82020-02-28 12:17:16 -0800845FlatbufferDetachedBuffer<Configuration> MergeWithConfig(
Brian Silverman24f5aa82020-06-23 16:21:28 -0700846 const Configuration *config, const Flatbuffer<Configuration> &addition) {
847 return MergeConfiguration(MergeFlatBuffers(config, &addition.message()));
848}
849
850FlatbufferDetachedBuffer<Configuration> MergeWithConfig(
Austin Schuh8d6cea82020-02-28 12:17:16 -0800851 const Configuration *config, std::string_view json) {
852 FlatbufferDetachedBuffer<Configuration> addition =
853 JsonToFlatbuffer(json, Configuration::MiniReflectTypeTable());
854
Brian Silverman24f5aa82020-06-23 16:21:28 -0700855 return MergeWithConfig(config, addition);
Austin Schuh8d6cea82020-02-28 12:17:16 -0800856}
857
James Kuszmaul3ae42262019-11-08 12:33:41 -0800858const Channel *GetChannel(const Configuration *config, std::string_view name,
859 std::string_view type,
Austin Schuh0de30f32020-12-06 12:44:28 -0800860 std::string_view application_name, const Node *node,
861 bool quiet) {
Brian Silverman9fcf2c72020-12-21 18:30:58 -0800862 if (!config->has_channels()) {
863 return nullptr;
864 }
865
Austin Schuhbca6cf02019-12-22 17:28:34 -0800866 const std::string_view original_name = name;
Austin Schuhf1fff282020-03-28 16:57:32 -0700867 std::string mutable_name;
Austin Schuh4c3b9702020-08-30 11:34:55 -0700868 if (node != nullptr) {
869 VLOG(1) << "Looking up { \"name\": \"" << name << "\", \"type\": \"" << type
870 << "\" } on " << aos::FlatbufferToJson(node);
871 } else {
872 VLOG(1) << "Looking up { \"name\": \"" << name << "\", \"type\": \"" << type
873 << "\" }";
874 }
Austin Schuhcb108412019-10-13 16:09:54 -0700875
876 // First handle application specific maps. Only do this if we have a matching
877 // application name, and it has maps.
Austin Schuhd2e2f6a2021-02-07 20:46:16 -0800878 {
879 const Application *application =
880 GetApplication(config, node, application_name);
881 if (application != nullptr && application->has_maps()) {
882 mutable_name = std::string(name);
883 HandleMaps(application->maps(), &mutable_name, type, node);
884 name = std::string_view(mutable_name);
Austin Schuhcb108412019-10-13 16:09:54 -0700885 }
886 }
887
888 // Now do global maps.
Austin Schuh40485ed2019-10-26 21:51:44 -0700889 if (config->has_maps()) {
Austin Schuhf1fff282020-03-28 16:57:32 -0700890 mutable_name = std::string(name);
891 HandleMaps(config->maps(), &mutable_name, type, node);
892 name = std::string_view(mutable_name);
Austin Schuhcb108412019-10-13 16:09:54 -0700893 }
894
Austin Schuhbca6cf02019-12-22 17:28:34 -0800895 if (original_name != name) {
896 VLOG(1) << "Remapped to { \"name\": \"" << name << "\", \"type\": \""
897 << type << "\" }";
898 }
Alex Perrycb7da4b2019-08-28 19:35:56 -0700899
James Kuszmaul71a81932020-12-15 21:08:01 -0800900 // Then look for the channel (note that this relies on the channels being
901 // sorted in the config).
Austin Schuh40485ed2019-10-26 21:51:44 -0700902 auto channel_iterator =
Austin Schuhf1fff282020-03-28 16:57:32 -0700903 std::lower_bound(config->channels()->cbegin(), config->channels()->cend(),
Austin Schuh40485ed2019-10-26 21:51:44 -0700904 std::make_pair(name, type), CompareChannels);
Austin Schuhcb108412019-10-13 16:09:54 -0700905
906 // Make sure we actually found it, and it matches.
Austin Schuh40485ed2019-10-26 21:51:44 -0700907 if (channel_iterator != config->channels()->cend() &&
908 EqualsChannels(*channel_iterator, std::make_pair(name, type))) {
Austin Schuhbca6cf02019-12-22 17:28:34 -0800909 if (VLOG_IS_ON(2)) {
910 VLOG(2) << "Found: " << FlatbufferToJson(*channel_iterator);
911 } else if (VLOG_IS_ON(1)) {
912 VLOG(1) << "Found: " << CleanedChannelToString(*channel_iterator);
913 }
Austin Schuh40485ed2019-10-26 21:51:44 -0700914 return *channel_iterator;
Austin Schuhcb108412019-10-13 16:09:54 -0700915 } else {
916 VLOG(1) << "No match for { \"name\": \"" << name << "\", \"type\": \""
917 << type << "\" }";
Austin Schuh0de30f32020-12-06 12:44:28 -0800918 if (original_name != name && !quiet) {
Austin Schuh4b42b252020-10-19 11:35:20 -0700919 LOG(WARNING) << "Remapped from {\"name\": \"" << original_name
920 << "\", \"type\": \"" << type << "\"}, to {\"name\": \""
921 << name << "\", \"type\": \"" << type
922 << "\"}, but no channel by that name exists.";
923 }
Austin Schuhcb108412019-10-13 16:09:54 -0700924 return nullptr;
925 }
926}
927
Austin Schuhc9e10ec2020-01-26 16:08:28 -0800928size_t ChannelIndex(const Configuration *configuration,
929 const Channel *channel) {
930 CHECK(configuration->channels() != nullptr) << ": No channels";
931
Brian Silvermana9698c92021-11-10 12:27:04 -0800932 const auto c = std::lower_bound(
933 configuration->channels()->cbegin(), configuration->channels()->cend(),
934 std::make_pair(channel->name()->string_view(),
935 channel->type()->string_view()),
936 CompareChannels);
937 CHECK(c != configuration->channels()->cend())
938 << ": Channel pointer not found in configuration()->channels()";
939 CHECK(*c == channel)
Austin Schuhc9e10ec2020-01-26 16:08:28 -0800940 << ": Channel pointer not found in configuration()->channels()";
941
Brian Silvermana9698c92021-11-10 12:27:04 -0800942 return std::distance(configuration->channels()->cbegin(), c);
Austin Schuhc9e10ec2020-01-26 16:08:28 -0800943}
944
Austin Schuhbca6cf02019-12-22 17:28:34 -0800945std::string CleanedChannelToString(const Channel *channel) {
946 FlatbufferDetachedBuffer<Channel> cleaned_channel = CopyFlatBuffer(channel);
947 cleaned_channel.mutable_message()->clear_schema();
948 return FlatbufferToJson(cleaned_channel);
949}
950
Austin Schuha81454b2020-05-12 19:58:36 -0700951std::string StrippedChannelToString(const Channel *channel) {
952 return absl::StrCat("{ \"name\": \"", channel->name()->string_view(),
953 "\", \"type\": \"", channel->type()->string_view(),
954 "\" }");
955}
956
Alex Perrycb7da4b2019-08-28 19:35:56 -0700957FlatbufferDetachedBuffer<Configuration> MergeConfiguration(
958 const Flatbuffer<Configuration> &config,
Austin Schuh0de30f32020-12-06 12:44:28 -0800959 const std::vector<aos::FlatbufferVector<reflection::Schema>> &schemas) {
Alex Perrycb7da4b2019-08-28 19:35:56 -0700960 flatbuffers::FlatBufferBuilder fbb;
Austin Schuhd7b15da2020-02-17 15:06:11 -0800961 fbb.ForceDefaults(true);
Alex Perrycb7da4b2019-08-28 19:35:56 -0700962
Austin Schuh68d98592020-11-01 23:22:57 -0800963 // Cache for holding already inserted schemas.
964 std::map<std::string_view, flatbuffers::Offset<reflection::Schema>>
965 schema_cache;
966
967 CHECK_EQ(Channel::MiniReflectTypeTable()->num_elems, 13u)
968 << ": Merging logic needs to be updated when the number of channel "
969 "fields changes.";
James Kuszmaul3c998592020-07-27 21:04:47 -0700970
Alex Perrycb7da4b2019-08-28 19:35:56 -0700971 flatbuffers::Offset<flatbuffers::Vector<flatbuffers::Offset<Channel>>>
972 channels_offset;
973 if (config.message().has_channels()) {
974 std::vector<flatbuffers::Offset<Channel>> channel_offsets;
975 for (const Channel *c : *config.message().channels()) {
Alex Perrycb7da4b2019-08-28 19:35:56 -0700976 // Search for a schema with a matching type.
Austin Schuh0de30f32020-12-06 12:44:28 -0800977 const aos::FlatbufferVector<reflection::Schema> *found_schema = nullptr;
978 for (const aos::FlatbufferVector<reflection::Schema> &schema : schemas) {
Alex Perrycb7da4b2019-08-28 19:35:56 -0700979 if (schema.message().root_table() != nullptr) {
980 if (schema.message().root_table()->name()->string_view() ==
981 c->type()->string_view()) {
982 found_schema = &schema;
983 }
984 }
985 }
986
987 CHECK(found_schema != nullptr)
988 << ": Failed to find schema for " << FlatbufferToJson(c);
989
Austin Schuh68d98592020-11-01 23:22:57 -0800990 // Now copy the message manually.
991 auto cached_schema = schema_cache.find(c->type()->string_view());
992 flatbuffers::Offset<reflection::Schema> schema_offset;
993 if (cached_schema != schema_cache.end()) {
994 schema_offset = cached_schema->second;
995 } else {
Austin Schuha4fc60f2020-11-01 23:06:47 -0800996 schema_offset = RecursiveCopyFlatBuffer<reflection::Schema>(
997 &found_schema->message(), &fbb);
Austin Schuh68d98592020-11-01 23:22:57 -0800998 schema_cache.emplace(c->type()->string_view(), schema_offset);
999 }
1000
1001 flatbuffers::Offset<flatbuffers::String> name_offset =
1002 fbb.CreateSharedString(c->name()->str());
1003 flatbuffers::Offset<flatbuffers::String> type_offset =
1004 fbb.CreateSharedString(c->type()->str());
1005 flatbuffers::Offset<flatbuffers::String> source_node_offset =
Austin Schuha4fc60f2020-11-01 23:06:47 -08001006 c->has_source_node() ? fbb.CreateSharedString(c->source_node()->str())
1007 : 0;
Austin Schuh68d98592020-11-01 23:22:57 -08001008
1009 flatbuffers::Offset<flatbuffers::Vector<flatbuffers::Offset<Connection>>>
1010 destination_nodes_offset =
Austin Schuh5c255aa2020-11-05 18:32:46 -08001011 aos::RecursiveCopyVectorTable(c->destination_nodes(), &fbb);
Austin Schuh68d98592020-11-01 23:22:57 -08001012
1013 flatbuffers::Offset<
1014 flatbuffers::Vector<flatbuffers::Offset<flatbuffers::String>>>
1015 logger_nodes_offset =
1016 aos::CopyVectorSharedString(c->logger_nodes(), &fbb);
1017
1018 Channel::Builder channel_builder(fbb);
1019 channel_builder.add_name(name_offset);
1020 channel_builder.add_type(type_offset);
1021 if (c->has_frequency()) {
1022 channel_builder.add_frequency(c->frequency());
1023 }
1024 if (c->has_max_size()) {
1025 channel_builder.add_max_size(c->max_size());
1026 }
1027 if (c->has_num_senders()) {
1028 channel_builder.add_num_senders(c->num_senders());
1029 }
1030 if (c->has_num_watchers()) {
1031 channel_builder.add_num_watchers(c->num_watchers());
1032 }
Alex Perrycb7da4b2019-08-28 19:35:56 -07001033 channel_builder.add_schema(schema_offset);
Austin Schuh68d98592020-11-01 23:22:57 -08001034 if (!source_node_offset.IsNull()) {
1035 channel_builder.add_source_node(source_node_offset);
1036 }
1037 if (!destination_nodes_offset.IsNull()) {
1038 channel_builder.add_destination_nodes(destination_nodes_offset);
1039 }
1040 if (c->has_logger()) {
1041 channel_builder.add_logger(c->logger());
1042 }
1043 if (!logger_nodes_offset.IsNull()) {
1044 channel_builder.add_logger_nodes(logger_nodes_offset);
1045 }
1046 if (c->has_read_method()) {
1047 channel_builder.add_read_method(c->read_method());
1048 }
1049 if (c->has_num_readers()) {
1050 channel_builder.add_num_readers(c->num_readers());
1051 }
1052 channel_offsets.emplace_back(channel_builder.Finish());
Alex Perrycb7da4b2019-08-28 19:35:56 -07001053 }
1054 channels_offset = fbb.CreateVector(channel_offsets);
1055 }
1056
Austin Schuh68d98592020-11-01 23:22:57 -08001057 flatbuffers::Offset<flatbuffers::Vector<flatbuffers::Offset<Map>>>
Austin Schuh5c255aa2020-11-05 18:32:46 -08001058 maps_offset =
1059 aos::RecursiveCopyVectorTable(config.message().maps(), &fbb);
Austin Schuh68d98592020-11-01 23:22:57 -08001060
1061 flatbuffers::Offset<flatbuffers::Vector<flatbuffers::Offset<Node>>>
Austin Schuh5c255aa2020-11-05 18:32:46 -08001062 nodes_offset =
1063 aos::RecursiveCopyVectorTable(config.message().nodes(), &fbb);
Austin Schuh68d98592020-11-01 23:22:57 -08001064
1065 flatbuffers::Offset<flatbuffers::Vector<flatbuffers::Offset<Application>>>
1066 applications_offset =
Austin Schuh5c255aa2020-11-05 18:32:46 -08001067 aos::RecursiveCopyVectorTable(config.message().applications(), &fbb);
Austin Schuh217a9782019-12-21 23:02:50 -08001068
1069 // Now insert everything else in unmodified.
Alex Perrycb7da4b2019-08-28 19:35:56 -07001070 ConfigurationBuilder configuration_builder(fbb);
1071 if (config.message().has_channels()) {
1072 configuration_builder.add_channels(channels_offset);
1073 }
Austin Schuh68d98592020-11-01 23:22:57 -08001074 if (!maps_offset.IsNull()) {
1075 configuration_builder.add_maps(maps_offset);
1076 }
1077 if (!nodes_offset.IsNull()) {
1078 configuration_builder.add_nodes(nodes_offset);
1079 }
1080 if (!applications_offset.IsNull()) {
1081 configuration_builder.add_applications(applications_offset);
1082 }
1083
1084 if (config.message().has_channel_storage_duration()) {
1085 configuration_builder.add_channel_storage_duration(
1086 config.message().channel_storage_duration());
1087 }
1088
1089 CHECK_EQ(Configuration::MiniReflectTypeTable()->num_elems, 6u)
1090 << ": Merging logic needs to be updated when the number of configuration "
1091 "fields changes.";
1092
Alex Perrycb7da4b2019-08-28 19:35:56 -07001093 fbb.Finish(configuration_builder.Finish());
James Kuszmaul3c998592020-07-27 21:04:47 -07001094 aos::FlatbufferDetachedBuffer<aos::Configuration> modified_config(
1095 fbb.Release());
1096
Austin Schuh68d98592020-11-01 23:22:57 -08001097 return modified_config;
Alex Perrycb7da4b2019-08-28 19:35:56 -07001098}
1099
Austin Schuh217a9782019-12-21 23:02:50 -08001100const Node *GetNodeFromHostname(const Configuration *config,
1101 std::string_view hostname) {
1102 for (const Node *node : *config->nodes()) {
Brian Silvermanaa2633f2020-02-17 21:04:14 -08001103 if (node->has_hostname() && node->hostname()->string_view() == hostname) {
Austin Schuh217a9782019-12-21 23:02:50 -08001104 return node;
1105 }
Brian Silvermanaa2633f2020-02-17 21:04:14 -08001106 if (node->has_hostnames()) {
1107 for (const auto &candidate : *node->hostnames()) {
1108 if (candidate->string_view() == hostname) {
1109 return node;
1110 }
1111 }
1112 }
Austin Schuh217a9782019-12-21 23:02:50 -08001113 }
1114 return nullptr;
1115}
Austin Schuhac0771c2020-01-07 18:36:30 -08001116
Austin Schuh217a9782019-12-21 23:02:50 -08001117const Node *GetMyNode(const Configuration *config) {
1118 const std::string hostname = (FLAGS_override_hostname.size() > 0)
1119 ? FLAGS_override_hostname
1120 : network::GetHostname();
1121 const Node *node = GetNodeFromHostname(config, hostname);
1122 if (node != nullptr) return node;
1123
1124 LOG(FATAL) << "Unknown node for host: " << hostname
1125 << ". Consider using --override_hostname if hostname detection "
1126 "is wrong.";
1127 return nullptr;
1128}
1129
Austin Schuhc9e10ec2020-01-26 16:08:28 -08001130const Node *GetNode(const Configuration *config, const Node *node) {
1131 if (!MultiNode(config)) {
1132 CHECK(node == nullptr) << ": Provided a node in a single node world.";
1133 return nullptr;
1134 } else {
1135 CHECK(node != nullptr);
1136 CHECK(node->has_name());
1137 return GetNode(config, node->name()->string_view());
1138 }
1139}
1140
Austin Schuh217a9782019-12-21 23:02:50 -08001141const Node *GetNode(const Configuration *config, std::string_view name) {
Austin Schuhfd960622020-01-01 13:22:55 -08001142 CHECK(config->has_nodes())
1143 << ": Asking for a node from a single node configuration.";
Austin Schuh217a9782019-12-21 23:02:50 -08001144 for (const Node *node : *config->nodes()) {
Austin Schuhfd960622020-01-01 13:22:55 -08001145 CHECK(node->has_name()) << ": Malformed node " << FlatbufferToJson(node);
Austin Schuh217a9782019-12-21 23:02:50 -08001146 if (node->name()->string_view() == name) {
1147 return node;
1148 }
1149 }
1150 return nullptr;
1151}
1152
Austin Schuh0ca1fd32020-12-18 22:53:05 -08001153const Node *GetNode(const Configuration *config, size_t node_index) {
1154 if (!MultiNode(config)) {
1155 CHECK_EQ(node_index, 0u) << ": Invalid node in a single node world.";
1156 return nullptr;
1157 } else {
1158 CHECK_LT(node_index, config->nodes()->size());
1159 return config->nodes()->Get(node_index);
1160 }
1161}
1162
Austin Schuhc9e10ec2020-01-26 16:08:28 -08001163const Node *GetNodeOrDie(const Configuration *config, const Node *node) {
1164 if (!MultiNode(config)) {
1165 CHECK(node == nullptr) << ": Provided a node in a single node world.";
1166 return nullptr;
1167 } else {
1168 const Node *config_node = GetNode(config, node);
1169 if (config_node == nullptr) {
1170 LOG(FATAL) << "Couldn't find node matching " << FlatbufferToJson(node);
1171 }
1172 return config_node;
1173 }
1174}
1175
Austin Schuh8bd96322020-02-13 21:18:22 -08001176namespace {
1177int GetNodeIndexFromConfig(const Configuration *config, const Node *node) {
Austin Schuhc9e10ec2020-01-26 16:08:28 -08001178 int node_index = 0;
1179 for (const Node *iterated_node : *config->nodes()) {
1180 if (iterated_node == node) {
1181 return node_index;
1182 }
1183 ++node_index;
1184 }
Austin Schuh8bd96322020-02-13 21:18:22 -08001185 return -1;
1186}
1187} // namespace
1188
Austin Schuha9df9ad2021-06-16 14:49:39 -07001189aos::FlatbufferDetachedBuffer<aos::Configuration> AddSchema(
1190 std::string_view json,
1191 const std::vector<aos::FlatbufferVector<reflection::Schema>> &schemas) {
1192 FlatbufferDetachedBuffer<Configuration> addition =
1193 JsonToFlatbuffer(json, Configuration::MiniReflectTypeTable());
1194 return MergeConfiguration(addition, schemas);
1195}
1196
Austin Schuh8bd96322020-02-13 21:18:22 -08001197int GetNodeIndex(const Configuration *config, const Node *node) {
1198 if (!MultiNode(config)) {
1199 return 0;
1200 }
1201
1202 {
1203 int node_index = GetNodeIndexFromConfig(config, node);
1204 if (node_index != -1) {
1205 return node_index;
1206 }
1207 }
1208
1209 const Node *result = GetNode(config, node);
1210 CHECK(result != nullptr);
1211
1212 {
Austin Schuh04408fc2020-02-16 21:48:54 -08001213 int node_index = GetNodeIndexFromConfig(config, result);
Austin Schuh8bd96322020-02-13 21:18:22 -08001214 if (node_index != -1) {
1215 return node_index;
1216 }
1217 }
1218
1219 LOG(FATAL) << "Node " << FlatbufferToJson(node)
1220 << " not found in the configuration.";
Austin Schuhc9e10ec2020-01-26 16:08:28 -08001221}
1222
Austin Schuh04408fc2020-02-16 21:48:54 -08001223int GetNodeIndex(const Configuration *config, std::string_view name) {
1224 if (!MultiNode(config)) {
1225 return 0;
1226 }
1227
1228 {
1229 int node_index = 0;
1230 for (const Node *iterated_node : *config->nodes()) {
1231 if (iterated_node->name()->string_view() == name) {
1232 return node_index;
1233 }
1234 ++node_index;
1235 }
1236 }
1237 LOG(FATAL) << "Node " << name << " not found in the configuration.";
1238}
1239
Austin Schuh681a2472020-12-31 23:55:40 -08001240size_t NodesCount(const Configuration *config) {
1241 if (!MultiNode(config)) {
1242 return 1u;
1243 }
1244
1245 return config->nodes()->size();
1246}
1247
Austin Schuhc9e10ec2020-01-26 16:08:28 -08001248std::vector<const Node *> GetNodes(const Configuration *config) {
1249 std::vector<const Node *> nodes;
Austin Schuh8bd96322020-02-13 21:18:22 -08001250 if (MultiNode(config)) {
Austin Schuhc9e10ec2020-01-26 16:08:28 -08001251 for (const Node *node : *config->nodes()) {
1252 nodes.emplace_back(node);
1253 }
1254 } else {
1255 nodes.emplace_back(nullptr);
1256 }
1257 return nodes;
1258}
1259
Austin Schuh65465332020-11-05 17:36:53 -08001260std::vector<const Node *> GetNodesWithTag(const Configuration *config,
1261 std::string_view tag) {
1262 std::vector<const Node *> nodes;
1263 if (!MultiNode(config)) {
1264 nodes.emplace_back(nullptr);
1265 } else {
1266 for (const Node *node : *config->nodes()) {
1267 if (!node->has_tags()) {
1268 continue;
1269 }
1270 bool did_found_tag = false;
1271 for (const flatbuffers::String *found_tag : *node->tags()) {
1272 if (found_tag->string_view() == tag) {
1273 did_found_tag = true;
1274 break;
1275 }
1276 }
1277 if (did_found_tag) {
1278 nodes.emplace_back(node);
1279 }
1280 }
1281 }
1282 return nodes;
1283}
1284
Brian Silverman631b6262021-11-10 12:25:08 -08001285bool NodeHasTag(const Node *node, std::string_view tag) {
1286 if (node == nullptr) {
1287 return true;
1288 }
1289
Austin Schuh97a52432022-08-17 15:02:59 -07001290 if (!node->has_tags()) {
1291 return false;
1292 }
1293
Brian Silverman631b6262021-11-10 12:25:08 -08001294 const auto *const tags = node->tags();
1295 return std::find_if(tags->begin(), tags->end(),
1296 [tag](const flatbuffers::String *candidate) {
1297 return candidate->string_view() == tag;
1298 }) != tags->end();
1299}
1300
Austin Schuhac0771c2020-01-07 18:36:30 -08001301bool MultiNode(const Configuration *config) { return config->has_nodes(); }
1302
Austin Schuh217a9782019-12-21 23:02:50 -08001303bool ChannelIsSendableOnNode(const Channel *channel, const Node *node) {
Austin Schuhca4828c2019-12-28 14:21:35 -08001304 if (node == nullptr) {
1305 return true;
1306 }
Austin Schuh3c5dae52020-10-06 18:55:18 -07001307 CHECK(channel->has_source_node()) << FlatbufferToJson(channel);
1308 CHECK(node->has_name()) << FlatbufferToJson(node);
Austin Schuh196a4452020-03-15 23:12:03 -07001309 return (CHECK_NOTNULL(channel)->source_node()->string_view() ==
1310 node->name()->string_view());
Austin Schuh217a9782019-12-21 23:02:50 -08001311}
1312
1313bool ChannelIsReadableOnNode(const Channel *channel, const Node *node) {
Austin Schuhca4828c2019-12-28 14:21:35 -08001314 if (node == nullptr) {
1315 return true;
1316 }
1317
Austin Schuh217a9782019-12-21 23:02:50 -08001318 if (channel->source_node()->string_view() == node->name()->string_view()) {
1319 return true;
1320 }
1321
1322 if (!channel->has_destination_nodes()) {
1323 return false;
1324 }
1325
Austin Schuh719946b2019-12-28 14:51:01 -08001326 for (const Connection *connection : *channel->destination_nodes()) {
1327 CHECK(connection->has_name());
1328 if (connection->name()->string_view() == node->name()->string_view()) {
Austin Schuh217a9782019-12-21 23:02:50 -08001329 return true;
1330 }
1331 }
1332
1333 return false;
1334}
1335
Austin Schuh719946b2019-12-28 14:51:01 -08001336bool ChannelMessageIsLoggedOnNode(const Channel *channel, const Node *node) {
Austin Schuh48e94502021-06-18 18:35:53 -07001337 if (node == nullptr) {
Austin Schuh2bb80e02021-03-20 21:46:17 -07001338 // Single node world. If there is a local logger, then we want to use
1339 // it.
Austin Schuh48e94502021-06-18 18:35:53 -07001340 if (channel->logger() == LoggerConfig::LOCAL_LOGGER) {
1341 return true;
1342 } else if (channel->logger() == LoggerConfig::NOT_LOGGED) {
1343 return false;
1344 }
1345 LOG(FATAL) << "Unsupported logging configuration in a single node world: "
1346 << CleanedChannelToString(channel);
Austin Schuh2bb80e02021-03-20 21:46:17 -07001347 }
1348 return ChannelMessageIsLoggedOnNode(
1349 channel, CHECK_NOTNULL(node)->name()->string_view());
1350}
1351
1352bool ChannelMessageIsLoggedOnNode(const Channel *channel,
1353 std::string_view node_name) {
Austin Schuhf1fff282020-03-28 16:57:32 -07001354 switch (channel->logger()) {
Austin Schuh719946b2019-12-28 14:51:01 -08001355 case LoggerConfig::LOCAL_LOGGER:
Austin Schuh2bb80e02021-03-20 21:46:17 -07001356 return channel->source_node()->string_view() == node_name;
Austin Schuh719946b2019-12-28 14:51:01 -08001357 case LoggerConfig::LOCAL_AND_REMOTE_LOGGER:
Austin Schuhda40e472020-03-28 15:15:29 -07001358 CHECK(channel->has_logger_nodes());
1359 CHECK_GT(channel->logger_nodes()->size(), 0u);
Austin Schuh719946b2019-12-28 14:51:01 -08001360
Austin Schuh2bb80e02021-03-20 21:46:17 -07001361 if (channel->source_node()->string_view() == node_name) {
Austin Schuh719946b2019-12-28 14:51:01 -08001362 return true;
1363 }
Austin Schuhda40e472020-03-28 15:15:29 -07001364
1365 [[fallthrough]];
1366 case LoggerConfig::REMOTE_LOGGER:
1367 CHECK(channel->has_logger_nodes());
1368 CHECK_GT(channel->logger_nodes()->size(), 0u);
1369 for (const flatbuffers::String *logger_node : *channel->logger_nodes()) {
Austin Schuh2bb80e02021-03-20 21:46:17 -07001370 if (logger_node->string_view() == node_name) {
Austin Schuhda40e472020-03-28 15:15:29 -07001371 return true;
1372 }
Austin Schuh719946b2019-12-28 14:51:01 -08001373 }
1374
1375 return false;
1376 case LoggerConfig::NOT_LOGGED:
1377 return false;
1378 }
1379
1380 LOG(FATAL) << "Unknown logger config " << static_cast<int>(channel->logger());
1381}
1382
Austin Schuh58646e22021-08-23 23:51:46 -07001383size_t ConnectionCount(const Channel *channel) {
1384 if (!channel->has_destination_nodes()) {
1385 return 0;
1386 }
1387 return channel->destination_nodes()->size();
1388}
1389
Austin Schuh719946b2019-12-28 14:51:01 -08001390const Connection *ConnectionToNode(const Channel *channel, const Node *node) {
1391 if (!channel->has_destination_nodes()) {
1392 return nullptr;
1393 }
1394 for (const Connection *connection : *channel->destination_nodes()) {
1395 if (connection->name()->string_view() == node->name()->string_view()) {
1396 return connection;
1397 }
1398 }
1399 return nullptr;
1400}
1401
1402bool ConnectionDeliveryTimeIsLoggedOnNode(const Channel *channel,
1403 const Node *node,
1404 const Node *logger_node) {
Austin Schuh72211ae2021-08-05 14:02:30 -07001405 return ConnectionDeliveryTimeIsLoggedOnNode(ConnectionToNode(channel, node),
1406 logger_node);
Austin Schuh719946b2019-12-28 14:51:01 -08001407}
1408
1409bool ConnectionDeliveryTimeIsLoggedOnNode(const Connection *connection,
1410 const Node *node) {
Austin Schuh72211ae2021-08-05 14:02:30 -07001411 if (connection == nullptr) {
1412 return false;
1413 }
Austin Schuh719946b2019-12-28 14:51:01 -08001414 switch (connection->timestamp_logger()) {
1415 case LoggerConfig::LOCAL_AND_REMOTE_LOGGER:
Austin Schuhda40e472020-03-28 15:15:29 -07001416 CHECK(connection->has_timestamp_logger_nodes());
1417 CHECK_GT(connection->timestamp_logger_nodes()->size(), 0u);
Austin Schuh719946b2019-12-28 14:51:01 -08001418 if (connection->name()->string_view() == node->name()->string_view()) {
1419 return true;
1420 }
1421
Austin Schuhda40e472020-03-28 15:15:29 -07001422 [[fallthrough]];
1423 case LoggerConfig::REMOTE_LOGGER:
1424 CHECK(connection->has_timestamp_logger_nodes());
1425 CHECK_GT(connection->timestamp_logger_nodes()->size(), 0u);
1426 for (const flatbuffers::String *timestamp_logger_node :
1427 *connection->timestamp_logger_nodes()) {
1428 if (timestamp_logger_node->string_view() ==
1429 node->name()->string_view()) {
1430 return true;
1431 }
Austin Schuh719946b2019-12-28 14:51:01 -08001432 }
1433
1434 return false;
1435 case LoggerConfig::LOCAL_LOGGER:
1436 return connection->name()->string_view() == node->name()->string_view();
Austin Schuh719946b2019-12-28 14:51:01 -08001437 case LoggerConfig::NOT_LOGGED:
1438 return false;
1439 }
1440
1441 LOG(FATAL) << "Unknown logger config "
1442 << static_cast<int>(connection->timestamp_logger());
1443}
1444
Austin Schuhe84c3ed2019-12-14 15:29:48 -08001445std::vector<std::string_view> SourceNodeNames(const Configuration *config,
1446 const Node *my_node) {
1447 std::set<std::string_view> result_set;
1448
1449 for (const Channel *channel : *config->channels()) {
1450 if (channel->has_destination_nodes()) {
1451 for (const Connection *connection : *channel->destination_nodes()) {
1452 if (connection->name()->string_view() ==
1453 my_node->name()->string_view()) {
1454 result_set.insert(channel->source_node()->string_view());
1455 }
1456 }
1457 }
1458 }
1459
1460 std::vector<std::string_view> result;
1461 for (const std::string_view source : result_set) {
1462 VLOG(1) << "Found a source node of " << source;
1463 result.emplace_back(source);
1464 }
1465 return result;
1466}
1467
1468std::vector<std::string_view> DestinationNodeNames(const Configuration *config,
1469 const Node *my_node) {
1470 std::vector<std::string_view> result;
1471
1472 for (const Channel *channel : *config->channels()) {
1473 if (channel->has_source_node() && channel->source_node()->string_view() ==
1474 my_node->name()->string_view()) {
1475 if (!channel->has_destination_nodes()) continue;
1476
1477 if (channel->source_node()->string_view() !=
1478 my_node->name()->string_view()) {
1479 continue;
1480 }
1481
1482 for (const Connection *connection : *channel->destination_nodes()) {
1483 if (std::find(result.begin(), result.end(),
1484 connection->name()->string_view()) == result.end()) {
1485 result.emplace_back(connection->name()->string_view());
1486 }
1487 }
1488 }
1489 }
1490
1491 for (const std::string_view destination : result) {
1492 VLOG(1) << "Found a destination node of " << destination;
1493 }
1494 return result;
1495}
1496
Austin Schuh8d7e0bb2020-10-02 17:57:00 -07001497std::vector<const Node *> TimestampNodes(const Configuration *config,
1498 const Node *my_node) {
1499 if (!configuration::MultiNode(config)) {
1500 CHECK(my_node == nullptr);
1501 return std::vector<const Node *>{};
1502 }
1503
1504 std::set<const Node *> timestamp_logger_nodes;
1505 for (const Channel *channel : *config->channels()) {
1506 if (!configuration::ChannelIsSendableOnNode(channel, my_node)) {
1507 continue;
1508 }
1509 if (!channel->has_destination_nodes()) {
1510 continue;
1511 }
1512 for (const Connection *connection : *channel->destination_nodes()) {
1513 const Node *other_node =
1514 configuration::GetNode(config, connection->name()->string_view());
1515
1516 if (configuration::ConnectionDeliveryTimeIsLoggedOnNode(connection,
1517 my_node)) {
1518 VLOG(1) << "Timestamps are logged from "
1519 << FlatbufferToJson(other_node);
1520 timestamp_logger_nodes.insert(other_node);
1521 }
1522 }
1523 }
1524
1525 std::vector<const Node *> result;
1526 for (const Node *node : timestamp_logger_nodes) {
1527 result.emplace_back(node);
1528 }
1529 return result;
1530}
1531
Austin Schuhc41fa3c2021-10-16 14:35:35 -07001532bool ApplicationShouldStart(const Configuration *config, const Node *my_node,
1533 const Application *application) {
1534 if (MultiNode(config)) {
1535 // Ok, we need
1536 CHECK(application->has_nodes());
1537 CHECK(my_node != nullptr);
1538 for (const flatbuffers::String *str : *application->nodes()) {
1539 if (str->string_view() == my_node->name()->string_view()) {
1540 return true;
1541 }
1542 }
1543 return false;
1544 } else {
1545 return true;
1546 }
1547}
1548
Austin Schuhd2e2f6a2021-02-07 20:46:16 -08001549const Application *GetApplication(const Configuration *config,
1550 const Node *my_node,
1551 std::string_view application_name) {
1552 if (config->has_applications()) {
1553 auto application_iterator = std::lower_bound(
1554 config->applications()->cbegin(), config->applications()->cend(),
1555 application_name, CompareApplications);
1556 if (application_iterator != config->applications()->cend() &&
1557 EqualsApplications(*application_iterator, application_name)) {
Austin Schuhc41fa3c2021-10-16 14:35:35 -07001558 if (ApplicationShouldStart(config, my_node, *application_iterator)) {
Austin Schuhd2e2f6a2021-02-07 20:46:16 -08001559 return *application_iterator;
1560 }
1561 }
1562 }
1563 return nullptr;
1564}
1565
Austin Schuhfc7b6a02021-07-12 21:19:07 -07001566std::vector<size_t> SourceNodeIndex(const Configuration *config) {
1567 CHECK(config->has_channels());
1568 std::vector<size_t> result;
1569 result.resize(config->channels()->size(), 0u);
1570 if (MultiNode(config)) {
1571 for (size_t i = 0; i < config->channels()->size(); ++i) {
1572 result[i] = GetNodeIndex(
1573 config, config->channels()->Get(i)->source_node()->string_view());
1574 }
1575 }
1576 return result;
1577}
1578
Austin Schuhfb37c612022-08-11 15:24:51 -07001579int QueueSize(const Configuration *config, const Channel *channel) {
1580 return QueueSize(channel->frequency(),
1581 chrono::nanoseconds(config->channel_storage_duration()));
1582}
1583
1584int QueueSize(size_t frequency, chrono::nanoseconds channel_storage_duration) {
1585 // Use integer arithmetic and round up at all cost.
1586 return static_cast<int>(
1587 (999999999 + static_cast<int64_t>(frequency) *
1588 static_cast<int64_t>(channel_storage_duration.count())) /
1589 static_cast<int64_t>(1000000000));
1590}
1591
1592int QueueScratchBufferSize(const Channel *channel) {
1593 return channel->num_readers() + channel->num_senders();
1594}
1595
Nathan Leong307c9692022-10-08 15:25:03 -07001596// Searches through configurations for schemas that include a certain type
1597const reflection::Schema *GetSchema(const Configuration *config,
1598 std::string_view schema_type) {
1599 if (config->has_channels()) {
1600 std::vector<flatbuffers::Offset<Channel>> channel_offsets;
1601 for (const Channel *c : *config->channels()) {
1602 if (schema_type == c->type()->string_view()) {
1603 return c->schema();
1604 }
1605 }
1606 }
1607 return nullptr;
1608}
1609
1610// Copy schema reflection into detached flatbuffer
1611std::optional<FlatbufferDetachedBuffer<reflection::Schema>>
1612GetSchemaDetachedBuffer(const Configuration *config,
1613 std::string_view schema_type) {
1614 const reflection::Schema *found_schema = GetSchema(config, schema_type);
1615 if (found_schema == nullptr) {
1616 return std::nullopt;
1617 }
1618 return RecursiveCopyFlatBuffer(found_schema);
1619}
1620
James Kuszmaul741a4d02023-01-05 14:59:21 -08001621aos::FlatbufferDetachedBuffer<Configuration> AddChannelToConfiguration(
1622 const Configuration *config, std::string_view name,
1623 aos::FlatbufferVector<reflection::Schema> schema, const aos::Node *node,
1624 ChannelT overrides) {
1625 overrides.name = name;
1626 overrides.type = schema.message().root_table()->name()->string_view();
1627 if (node != nullptr) {
1628 CHECK(node->has_name());
1629 overrides.source_node = node->name()->string_view();
1630 }
1631 flatbuffers::FlatBufferBuilder fbb;
1632 // Don't populate fields from overrides that the user doesn't explicitly
1633 // override.
1634 fbb.ForceDefaults(false);
1635 const flatbuffers::Offset<Channel> channel_offset =
1636 Channel::Pack(fbb, &overrides);
1637 const flatbuffers::Offset<flatbuffers::Vector<flatbuffers::Offset<Channel>>>
1638 channels_offset = fbb.CreateVector({channel_offset});
1639 Configuration::Builder config_builder(fbb);
1640 config_builder.add_channels(channels_offset);
1641 fbb.Finish(config_builder.Finish());
1642 FlatbufferDetachedBuffer<Configuration> new_channel_config = fbb.Release();
1643 new_channel_config = MergeConfiguration(new_channel_config, {schema});
1644 return MergeWithConfig(config, new_channel_config);
1645}
1646
Brian Silverman66f079a2013-08-26 16:24:30 -07001647} // namespace configuration
1648} // namespace aos