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 typedef enum proxytype_t {
68 struct meshlink_open_params {
80 /// Device class traits
84 int fast_retry_period;
85 unsigned int min_connects;
86 unsigned int max_connects;
90 /// A handle for an instance of MeshLink.
91 struct meshlink_handle {
97 pthread_mutex_t mutex;
100 meshlink_log_cb_t log_cb;
101 meshlink_log_level_t log_level;
103 // The most important network-related members come first
106 listen_socket_t listen_socket[MAXSOCKETS];
108 meshlink_receive_cb_t receive_cb;
109 meshlink_queue_t outpacketqueue;
110 signal_t datafromapp;
112 hash_t *node_udp_cache;
114 struct splay_tree_t *nodes;
115 struct splay_tree_t *edges;
117 struct list_t *connections;
118 struct list_t *outgoings;
119 struct list_t *submeshes;
121 // Meta-connection-related members
122 struct splay_tree_t *past_request_tree;
123 timeout_t past_request_timeout;
125 int connection_burst;
126 int contradicting_add_edge;
127 int contradicting_del_edge;
129 time_t connection_burst_time;
130 time_t last_hard_try;
131 time_t last_unreachable;
133 timeout_t periodictimer;
135 struct connection_t *everyone;
136 uint64_t prng_state[4];
142 // Infrequently used callbacks
143 meshlink_node_status_cb_t node_status_cb;
144 meshlink_node_pmtu_cb_t node_pmtu_cb;
145 meshlink_channel_accept_cb_t channel_accept_cb;
146 meshlink_node_duplicate_cb_t node_duplicate_cb;
147 meshlink_connection_try_cb_t connection_try_cb;
148 meshlink_error_cb_t error_cb;
154 struct ecdsa *private_key;
155 struct ecdsa *invitation_key;
157 dev_class_t devclass;
159 int invitation_timeout;
163 dev_class_traits_t dev_class_traits[DEV_CLASS_COUNT];
167 bool default_blacklist;
168 bool discovery; // Whether Catta is enabled or not
169 bool inviter_commits_first;
175 char *external_address_url;
176 struct list_t *invitation_addresses;
181 pthread_mutex_t discovery_mutex;
182 pthread_cond_t discovery_cond;
184 bool discovery_threadstarted;
187 pthread_t discovery_thread;
188 struct CattaServer *catta_server;
189 struct CattaSServiceBrowser *catta_browser;
190 struct CattaSimplePoll *catta_poll;
191 struct CattaSEntryGroup *catta_group;
192 char *catta_servicetype;
193 unsigned int catta_interfaces;
195 // Proxy configuration, currently not exposed.
200 proxytype_t proxytype;
203 /// A handle for a MeshLink node.
204 struct meshlink_node {
209 /// A handle for a node Sub-Mesh.
210 struct meshlink_submesh {
216 typedef struct meshlink_aio_buffer {
222 meshlink_aio_cb_t buffer;
223 meshlink_aio_fd_cb_t fd;
226 struct meshlink_aio_buffer *next;
227 } meshlink_aio_buffer_t;
230 struct meshlink_channel {
234 struct utcp_connection *c;
235 meshlink_aio_buffer_t *aio_send;
236 meshlink_aio_buffer_t *aio_receive;
237 meshlink_channel_receive_cb_t receive_cb;
238 meshlink_channel_poll_cb_t poll_cb;
241 /// Header for data packets routed between nodes
242 typedef struct meshlink_packethdr {
243 uint8_t destination[16];
245 } __attribute__((__packed__)) meshlink_packethdr_t;
247 extern void meshlink_send_from_queue(event_loop_t *loop, void *mesh);
248 extern void update_node_status(meshlink_handle_t *mesh, struct node_t *n);
249 extern void update_node_pmtu(meshlink_handle_t *mesh, struct node_t *n);
250 extern meshlink_log_level_t global_log_level;
251 extern meshlink_log_cb_t global_log_cb;
252 extern void handle_duplicate_node(meshlink_handle_t *mesh, struct node_t *n);
253 extern void handle_network_change(meshlink_handle_t *mesh, bool online);
254 extern void call_error_cb(meshlink_handle_t *mesh, meshlink_errno_t meshlink_errno);
256 /// Per-instance PRNG
257 static inline int prng(meshlink_handle_t *mesh, uint64_t max) {
258 return xoshiro(mesh->prng_state) % max;
261 /// Fudge value of ~0.1 seconds, in microseconds.
262 static const unsigned int TIMER_FUDGE = 0x8000000;