1 #ifndef MESHLINK_INTERNAL_H
2 #define MESHLINK_INTERNAL_H
5 meshlink_internal.h -- Internal parts of the public API.
6 Copyright (C) 2014-2019 Guus Sliepen <guus@meshlink.io>
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License along
19 with this program; if not, write to the Free Software Foundation, Inc.,
20 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
24 #error You must not include both meshlink.h and meshlink_internal.h!
32 #include "meshlink_queue.h"
39 #define MAXSOCKETS 4 /* Probably overkill... */
41 static const char meshlink_invitation_label[] = "MeshLink invitation";
42 static const char meshlink_tcp_label[] = "MeshLink TCP";
43 static const char meshlink_udp_label[] = "MeshLink UDP";
45 #define MESHLINK_CONFIG_VERSION 2
46 #define MESHLINK_INVITATION_VERSION 2
49 struct CattaSServiceBrowser;
50 struct CattaSimplePoll;
51 struct CattaSEntryGroup;
53 typedef struct listen_socket_t {
57 sockaddr_t broadcast_sa;
60 struct meshlink_open_params {
71 meshlink_storage_policy_t storage_policy;
74 /// Device class traits
78 int fast_retry_period;
80 unsigned int min_connects;
81 unsigned int max_connects;
85 /// A handle for an instance of MeshLink.
86 struct meshlink_handle {
92 pthread_mutex_t mutex;
95 meshlink_log_cb_t log_cb;
96 meshlink_log_level_t log_level;
99 // The most important network-related members come first
102 listen_socket_t listen_socket[MAXSOCKETS];
104 meshlink_receive_cb_t receive_cb;
105 meshlink_queue_t outpacketqueue;
106 signal_t datafromapp;
108 hash_t *node_udp_cache;
110 struct splay_tree_t *nodes;
111 struct splay_tree_t *edges;
113 struct list_t *connections;
114 struct list_t *outgoings;
115 struct list_t *submeshes;
117 // Meta-connection-related members
118 struct splay_tree_t *past_request_tree;
119 timeout_t past_request_timeout;
121 int connection_burst;
122 int contradicting_add_edge;
123 int contradicting_del_edge;
125 time_t connection_burst_time;
126 time_t last_hard_try;
127 time_t last_unreachable;
129 timeout_t periodictimer;
131 struct connection_t *everyone;
132 uint64_t prng_state[4];
138 // Infrequently used callbacks
139 meshlink_node_status_cb_t node_status_cb;
140 meshlink_node_status_cb_t meta_status_cb;
141 meshlink_node_pmtu_cb_t node_pmtu_cb;
142 meshlink_channel_listen_cb_t channel_listen_cb;
143 meshlink_channel_accept_cb_t channel_accept_cb;
144 meshlink_node_duplicate_cb_t node_duplicate_cb;
145 meshlink_connection_try_cb_t connection_try_cb;
146 meshlink_error_cb_t error_cb;
147 meshlink_blacklisted_cb_t blacklisted_cb;
153 struct ecdsa *private_key;
154 struct ecdsa *invitation_key;
156 dev_class_t devclass;
158 int invitation_timeout;
161 dev_class_traits_t dev_class_traits[DEV_CLASS_COUNT];
165 bool default_blacklist;
166 bool discovery; // Whether Catta is enabled or not
167 bool inviter_commits_first;
173 char *external_address_url;
174 struct list_t *invitation_addresses;
175 meshlink_storage_policy_t storage_policy;
180 pthread_mutex_t discovery_mutex;
181 pthread_cond_t discovery_cond;
183 bool discovery_threadstarted;
186 pthread_t discovery_thread;
187 struct CattaServer *catta_server;
188 struct CattaSServiceBrowser *catta_browser;
189 struct CattaSimplePoll *catta_poll;
190 struct CattaSEntryGroup *catta_group;
191 char *catta_servicetype;
192 unsigned int catta_interfaces;
196 int *discovery_ifaces;
197 struct discovery_address *discovery_addresses;
198 int discovery_iface_count;
199 int discovery_address_count;
200 io_t discovery_sockets[2];
203 pthread_t adns_thread;
204 pthread_cond_t adns_cond;
205 meshlink_queue_t adns_queue;
206 meshlink_queue_t adns_done_queue;
207 signal_t adns_signal;
210 /// A handle for a MeshLink node.
211 struct meshlink_node {
216 /// A handle for a node Sub-Mesh.
217 struct meshlink_submesh {
223 typedef struct meshlink_aio_buffer {
229 meshlink_aio_cb_t buffer;
230 meshlink_aio_fd_cb_t fd;
233 struct meshlink_aio_buffer *next;
234 } meshlink_aio_buffer_t;
237 struct meshlink_channel {
242 struct utcp_connection *c;
243 meshlink_aio_buffer_t *aio_send;
244 meshlink_aio_buffer_t *aio_receive;
245 meshlink_channel_receive_cb_t receive_cb;
246 meshlink_channel_poll_cb_t poll_cb;
249 /// Header for data packets routed between nodes
250 typedef struct meshlink_packethdr {
251 uint8_t destination[16];
253 } __attribute__((__packed__)) meshlink_packethdr_t;
255 void meshlink_send_from_queue(event_loop_t *loop, void *mesh);
256 void update_node_status(meshlink_handle_t *mesh, struct node_t *n);
257 void update_node_pmtu(meshlink_handle_t *mesh, struct node_t *n);
258 extern meshlink_log_level_t global_log_level;
259 extern meshlink_log_cb_t global_log_cb;
260 void handle_duplicate_node(meshlink_handle_t *mesh, struct node_t *n);
261 void handle_network_change(meshlink_handle_t *mesh, bool online);
262 void call_error_cb(meshlink_handle_t *mesh, meshlink_errno_t meshlink_errno);
264 /// Per-instance PRNG
265 static inline int prng(meshlink_handle_t *mesh, uint64_t max) {
266 return xoshiro(mesh->prng_state) % max;
269 /// Fudge value of ~0.1 seconds, in microseconds.
270 static const unsigned int TIMER_FUDGE = 0x8000000;