blob: 7bf82034465d72430d3580261b25dbb2ed82bf24 [file] [log] [blame]
John Park398c74a2018-10-20 21:17:39 -07001#ifndef AOS_CONFIGURATION_H_
2#define AOS_CONFIGURATION_H_
Brian Silverman66f079a2013-08-26 16:24:30 -07003
4#include <stdint.h>
5#include <sys/socket.h>
6#include <netinet/in.h>
7#include <arpa/inet.h>
8
James Kuszmaul3ae42262019-11-08 12:33:41 -08009#include <string_view>
10
Austin Schuhcb108412019-10-13 16:09:54 -070011#include "aos/configuration_generated.h"
12#include "aos/flatbuffers.h"
13
Brian Silverman66f079a2013-08-26 16:24:30 -070014namespace aos {
15
16// Holds global configuration data. All of the functions are safe to call
17// from wherever.
18namespace configuration {
19
Austin Schuhcb108412019-10-13 16:09:54 -070020// Reads a json configuration. This includes all imports and merges. Note:
21// duplicate imports will result in a CHECK.
Austin Schuh40485ed2019-10-26 21:51:44 -070022FlatbufferDetachedBuffer<Configuration> ReadConfig(
James Kuszmaul3ae42262019-11-08 12:33:41 -080023 const std::string_view path);
Austin Schuhcb108412019-10-13 16:09:54 -070024
Alex Perrycb7da4b2019-08-28 19:35:56 -070025// Sorts and merges entries in a config.
26FlatbufferDetachedBuffer<Configuration> MergeConfiguration(
27 const Flatbuffer<Configuration> &config);
28
29// Adds schema definitions to a sorted and merged config from the provided
30// schema list.
31FlatbufferDetachedBuffer<Configuration> MergeConfiguration(
32 const Flatbuffer<Configuration> &config,
33 const std::vector<aos::FlatbufferString<reflection::Schema>> &schemas);
34
Austin Schuh40485ed2019-10-26 21:51:44 -070035// Returns the resolved location for a name, type, and application name. Returns
36// nullptr if none is found.
Austin Schuhcb108412019-10-13 16:09:54 -070037//
38// If the application name is empty, it is ignored. Maps are processed in
39// reverse order, and application specific first.
Austin Schuhbca6cf02019-12-22 17:28:34 -080040const Channel *GetChannel(const Configuration *config,
41 const std::string_view name,
42 const std::string_view type,
43 const std::string_view application_name,
44 const Node *node);
45inline const Channel *GetChannel(const Flatbuffer<Configuration> &config,
46 const std::string_view name,
47 const std::string_view type,
48 const std::string_view application_name,
49 const Node *node) {
50 return GetChannel(&config.message(), name, type, application_name, node);
Austin Schuh40485ed2019-10-26 21:51:44 -070051}
Austin Schuhcb108412019-10-13 16:09:54 -070052
Austin Schuh217a9782019-12-21 23:02:50 -080053// Returns the Node out of the config with the matching name, or nullptr if it
54// can't be found.
55const Node *GetNode(const Configuration *config, std::string_view name);
56// Returns the Node out of the configuration which matches our hostname.
57// CHECKs if it can't be found.
58const Node *GetMyNode(const Configuration *config);
59const Node *GetNodeFromHostname(const Configuration *config,
60 std::string_view name);
Alex Perrycb7da4b2019-08-28 19:35:56 -070061
Austin Schuh217a9782019-12-21 23:02:50 -080062// Returns true if the provided channel is sendable on the provided node.
63bool ChannelIsSendableOnNode(const Channel *channel, const Node *node);
64// Returns true if the provided channel is able to be watched or fetched on the
65// provided node.
66bool ChannelIsReadableOnNode(const Channel *channel, const Node *node);
67
Austin Schuh719946b2019-12-28 14:51:01 -080068// Returns true if the message is supposed to be logged on this node.
69bool ChannelMessageIsLoggedOnNode(const Channel *channel, const Node *node);
70
71const Connection *ConnectionToNode(const Channel *channel, const Node *node);
72// Returns true if the delivery timestamps are supposed to be logged on this
73// node.
74bool ConnectionDeliveryTimeIsLoggedOnNode(const Channel *channel,
75 const Node *node,
76 const Node *logger_node);
77bool ConnectionDeliveryTimeIsLoggedOnNode(const Connection *connection,
78 const Node *node);
79
Austin Schuhbca6cf02019-12-22 17:28:34 -080080// Prints a channel to json, but without the schema.
81std::string CleanedChannelToString(const Channel *channel);
82
Austin Schuh217a9782019-12-21 23:02:50 -080083// TODO(austin): GetSchema<T>(const Flatbuffer<Configuration> &config);
Brian Silverman66f079a2013-08-26 16:24:30 -070084
Brian Silverman66f079a2013-08-26 16:24:30 -070085} // namespace configuration
Alex Perrycb7da4b2019-08-28 19:35:56 -070086
87// Compare and equality operators for Channel. Note: these only check the name
88// and type for equality.
89bool operator<(const FlatbufferDetachedBuffer<Channel> &lhs,
90 const FlatbufferDetachedBuffer<Channel> &rhs);
91bool operator==(const FlatbufferDetachedBuffer<Channel> &lhs,
92 const FlatbufferDetachedBuffer<Channel> &rhs);
Brian Silverman66f079a2013-08-26 16:24:30 -070093} // namespace aos
94
John Park398c74a2018-10-20 21:17:39 -070095#endif // AOS_CONFIGURATION_H_