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
48 typedef struct listen_socket_t {
52 sockaddr_t broadcast_sa;
55 struct meshlink_open_params {
67 /// Device class traits
71 int fast_retry_period;
73 unsigned int min_connects;
74 unsigned int max_connects;
78 /// A handle for an instance of MeshLink.
79 struct meshlink_handle {
85 pthread_mutex_t mutex;
88 meshlink_log_cb_t log_cb;
89 meshlink_log_level_t log_level;
92 // The most important network-related members come first
95 listen_socket_t listen_socket[MAXSOCKETS];
97 meshlink_receive_cb_t receive_cb;
98 meshlink_queue_t outpacketqueue;
101 hash_t *node_udp_cache;
103 struct splay_tree_t *nodes;
104 struct splay_tree_t *edges;
106 struct list_t *connections;
107 struct list_t *outgoings;
108 struct list_t *submeshes;
110 // Meta-connection-related members
111 struct splay_tree_t *past_request_tree;
112 timeout_t past_request_timeout;
114 int connection_burst;
115 int contradicting_add_edge;
116 int contradicting_del_edge;
118 time_t connection_burst_time;
119 time_t last_hard_try;
120 time_t last_unreachable;
122 timeout_t periodictimer;
124 struct connection_t *everyone;
125 uint64_t prng_state[4];
131 // Infrequently used callbacks
132 meshlink_node_status_cb_t node_status_cb;
133 meshlink_node_status_cb_t meta_status_cb;
134 meshlink_node_pmtu_cb_t node_pmtu_cb;
135 meshlink_channel_listen_cb_t channel_listen_cb;
136 meshlink_channel_accept_cb_t channel_accept_cb;
137 meshlink_node_duplicate_cb_t node_duplicate_cb;
138 meshlink_connection_try_cb_t connection_try_cb;
139 meshlink_error_cb_t error_cb;
140 meshlink_blacklisted_cb_t blacklisted_cb;
146 struct ecdsa *private_key;
147 struct ecdsa *invitation_key;
149 dev_class_t devclass;
151 int invitation_timeout;
154 dev_class_traits_t dev_class_traits[DEV_CLASS_COUNT];
158 bool default_blacklist;
159 bool inviter_commits_first;
165 char *external_address_url;
166 struct list_t *invitation_addresses;
178 struct discovery_address *addresses;
185 pthread_t adns_thread;
186 pthread_cond_t adns_cond;
187 meshlink_queue_t adns_queue;
188 meshlink_queue_t adns_done_queue;
189 signal_t adns_signal;
192 /// A handle for a MeshLink node.
193 struct meshlink_node {
198 /// A handle for a node Sub-Mesh.
199 struct meshlink_submesh {
205 typedef struct meshlink_aio_buffer {
211 meshlink_aio_cb_t buffer;
212 meshlink_aio_fd_cb_t fd;
215 struct meshlink_aio_buffer *next;
216 } meshlink_aio_buffer_t;
219 struct meshlink_channel {
224 struct utcp_connection *c;
225 meshlink_aio_buffer_t *aio_send;
226 meshlink_aio_buffer_t *aio_receive;
227 meshlink_channel_receive_cb_t receive_cb;
228 meshlink_channel_poll_cb_t poll_cb;
231 /// Header for data packets routed between nodes
232 typedef struct meshlink_packethdr {
233 uint8_t destination[16];
235 } __attribute__((__packed__)) meshlink_packethdr_t;
237 void meshlink_send_from_queue(event_loop_t *loop, void *mesh);
238 void update_node_status(meshlink_handle_t *mesh, struct node_t *n);
239 void update_node_pmtu(meshlink_handle_t *mesh, struct node_t *n);
240 extern meshlink_log_level_t global_log_level;
241 extern meshlink_log_cb_t global_log_cb;
242 void handle_duplicate_node(meshlink_handle_t *mesh, struct node_t *n);
243 void handle_network_change(meshlink_handle_t *mesh, bool online);
244 void call_error_cb(meshlink_handle_t *mesh, meshlink_errno_t meshlink_errno);
246 /// Per-instance PRNG
247 static inline int prng(meshlink_handle_t *mesh, uint64_t max) {
248 return xoshiro(mesh->prng_state) % max;
251 /// Fudge value of ~0.1 seconds, in microseconds.
252 static const unsigned int TIMER_FUDGE = 0x8000000;