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-tiny.h and meshlink_internal.h!
31 #include "meshlink-tiny.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 struct meshlink_open_params {
59 meshlink_storage_policy_t storage_policy;
62 /// Device class traits
66 int fast_retry_period;
68 unsigned int min_connects;
69 unsigned int max_connects;
73 /// A handle for an instance of MeshLink.
74 struct meshlink_handle {
80 pthread_mutex_t mutex;
83 meshlink_log_cb_t log_cb;
84 meshlink_log_level_t log_level;
87 // The most important network-related members come first
90 meshlink_receive_cb_t receive_cb;
91 meshlink_queue_t outpacketqueue;
94 struct splay_tree_t *nodes;
96 struct list_t *connections;
97 struct list_t *outgoings;
98 struct list_t *submeshes;
100 // Meta-connection-related members
101 struct splay_tree_t *past_request_tree;
102 timeout_t past_request_timeout;
104 int connection_burst;
105 int contradicting_add_edge;
106 int contradicting_del_edge;
108 time_t connection_burst_time;
109 time_t last_hard_try;
110 time_t last_unreachable;
112 timeout_t periodictimer;
114 struct connection_t *everyone;
115 uint64_t prng_state[4];
121 // Infrequently used callbacks
122 meshlink_node_status_cb_t node_status_cb;
123 meshlink_node_status_cb_t meta_status_cb;
124 meshlink_node_pmtu_cb_t node_pmtu_cb;
125 meshlink_channel_listen_cb_t channel_listen_cb;
126 meshlink_channel_accept_cb_t channel_accept_cb;
127 meshlink_node_duplicate_cb_t node_duplicate_cb;
128 meshlink_connection_try_cb_t connection_try_cb;
129 meshlink_error_cb_t error_cb;
135 struct ecdsa *private_key;
137 dev_class_t devclass;
139 dev_class_traits_t dev_class_traits[DEV_CLASS_COUNT];
143 bool inviter_commits_first;
149 char *external_address_url;
150 meshlink_storage_policy_t storage_policy;
158 /// A handle for a MeshLink node.
159 struct meshlink_node {
164 /// A handle for a node Sub-Mesh.
165 struct meshlink_submesh {
171 typedef struct meshlink_aio_buffer {
177 meshlink_aio_cb_t buffer;
178 meshlink_aio_fd_cb_t fd;
181 struct meshlink_aio_buffer *next;
182 } meshlink_aio_buffer_t;
185 struct meshlink_channel {
190 struct utcp_connection *c;
191 meshlink_aio_buffer_t *aio_send;
192 meshlink_aio_buffer_t *aio_receive;
193 meshlink_channel_receive_cb_t receive_cb;
194 meshlink_channel_poll_cb_t poll_cb;
197 /// Header for data packets routed between nodes
198 typedef struct meshlink_packethdr {
199 uint8_t destination[16];
201 } __attribute__((__packed__)) meshlink_packethdr_t;
203 void meshlink_send_from_queue(event_loop_t *loop, void *mesh);
204 void update_node_status(meshlink_handle_t *mesh, struct node_t *n);
205 void update_node_pmtu(meshlink_handle_t *mesh, struct node_t *n);
206 extern meshlink_log_level_t global_log_level;
207 extern meshlink_log_cb_t global_log_cb;
208 void handle_duplicate_node(meshlink_handle_t *mesh, struct node_t *n);
209 void handle_network_change(meshlink_handle_t *mesh, bool online);
210 void call_error_cb(meshlink_handle_t *mesh, meshlink_errno_t meshlink_errno);
212 /// Per-instance PRNG
213 static inline int prng(meshlink_handle_t *mesh, uint64_t max) {
214 return xoshiro(mesh->prng_state) % max;
217 /// Fudge value of ~0.1 seconds, in microseconds.
218 static const unsigned int TIMER_FUDGE = 0x8000000;