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 {
66 meshlink_storage_policy_t storage_policy;
67 meshlink_load_cb_t load_cb;
68 meshlink_store_cb_t store_cb;
69 meshlink_ls_cb_t ls_cb;
72 /// Device class traits
76 int fast_retry_period;
78 unsigned int min_connects;
79 unsigned int max_connects;
83 /// A handle for an instance of MeshLink.
84 struct meshlink_handle {
90 pthread_mutex_t mutex;
93 meshlink_log_cb_t log_cb;
94 meshlink_log_level_t log_level;
97 // The most important network-related members come first
100 listen_socket_t listen_socket[MAXSOCKETS];
102 meshlink_receive_cb_t receive_cb;
103 meshlink_queue_t outpacketqueue;
104 signal_t datafromapp;
106 hash_t *node_udp_cache;
108 struct splay_tree_t *nodes;
109 struct splay_tree_t *edges;
111 struct list_t *connections;
112 struct list_t *outgoings;
113 struct list_t *submeshes;
115 // Meta-connection-related members
116 struct splay_tree_t *past_request_tree;
117 timeout_t past_request_timeout;
119 int connection_burst;
120 int contradicting_add_edge;
121 int contradicting_del_edge;
123 time_t connection_burst_time;
124 time_t last_hard_try;
125 time_t last_unreachable;
127 timeout_t periodictimer;
129 struct connection_t *everyone;
130 uint64_t prng_state[4];
136 // Infrequently used callbacks
137 meshlink_node_status_cb_t node_status_cb;
138 meshlink_node_status_cb_t meta_status_cb;
139 meshlink_node_pmtu_cb_t node_pmtu_cb;
140 meshlink_channel_listen_cb_t channel_listen_cb;
141 meshlink_channel_accept_cb_t channel_accept_cb;
142 meshlink_node_duplicate_cb_t node_duplicate_cb;
143 meshlink_connection_try_cb_t connection_try_cb;
144 meshlink_error_cb_t error_cb;
145 meshlink_blacklisted_cb_t blacklisted_cb;
146 meshlink_thread_status_cb_t thread_status_cb;
152 struct ecdsa *private_key;
153 struct ecdsa *invitation_key;
155 dev_class_t devclass;
157 int invitation_timeout;
160 dev_class_traits_t dev_class_traits[DEV_CLASS_COUNT];
164 bool default_blacklist;
165 bool inviter_commits_first;
171 char *external_address_url;
172 struct list_t *invitation_addresses;
173 meshlink_storage_policy_t storage_policy;
174 meshlink_load_cb_t load_cb;
175 meshlink_store_cb_t store_cb;
176 meshlink_ls_cb_t ls_cb;
190 struct discovery_address *addresses;
202 pthread_t adns_thread;
203 pthread_cond_t adns_cond;
204 meshlink_queue_t adns_queue;
205 meshlink_queue_t adns_done_queue;
206 signal_t adns_signal;
209 /// A handle for a MeshLink node.
210 struct meshlink_node {
215 /// A handle for a node Sub-Mesh.
216 struct meshlink_submesh {
222 typedef struct meshlink_aio_buffer {
228 meshlink_aio_cb_t buffer;
229 meshlink_aio_fd_cb_t fd;
232 struct meshlink_aio_buffer *next;
233 } meshlink_aio_buffer_t;
236 struct meshlink_channel {
241 struct utcp_connection *c;
242 meshlink_aio_buffer_t *aio_send;
243 meshlink_aio_buffer_t *aio_receive;
244 meshlink_channel_receive_cb_t receive_cb;
245 meshlink_channel_poll_cb_t poll_cb;
248 /// Header for data packets routed between nodes
249 typedef struct meshlink_packethdr {
250 uint8_t destination[16];
252 } __attribute__((__packed__)) meshlink_packethdr_t;
254 void meshlink_send_from_queue(event_loop_t *loop, void *mesh);
255 void update_node_status(meshlink_handle_t *mesh, struct node_t *n);
256 void update_node_pmtu(meshlink_handle_t *mesh, struct node_t *n);
257 extern meshlink_log_level_t global_log_level;
258 extern meshlink_log_cb_t global_log_cb;
259 void handle_duplicate_node(meshlink_handle_t *mesh, struct node_t *n);
260 void handle_network_change(meshlink_handle_t *mesh, bool online);
261 void call_error_cb(meshlink_handle_t *mesh, meshlink_errno_t meshlink_errno);
262 void channel_receive(meshlink_handle_t *mesh, meshlink_node_t *node, const void *data, size_t len);
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;