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
50 struct meshlink_open_params {
61 meshlink_storage_policy_t storage_policy;
64 /// Device class traits
68 int fast_retry_period;
70 unsigned int min_connects;
71 unsigned int max_connects;
75 /// A handle for an instance of MeshLink.
76 struct meshlink_handle {
82 pthread_mutex_t mutex;
85 meshlink_log_cb_t log_cb;
86 meshlink_log_level_t log_level;
89 // The most important network-related members come first
92 meshlink_receive_cb_t receive_cb;
93 meshlink_queue_t outpacketqueue;
97 struct connection_t *connection;
98 struct outgoing_t *outgoing;
100 int connection_burst;
101 int contradicting_add_edge;
102 int contradicting_del_edge;
104 time_t connection_burst_time;
105 time_t last_hard_try;
106 time_t last_unreachable;
108 timeout_t periodictimer;
110 struct connection_t *everyone;
111 uint64_t prng_state[4];
117 // Infrequently used callbacks
118 meshlink_node_status_cb_t node_status_cb;
119 meshlink_node_status_cb_t meta_status_cb;
120 meshlink_node_pmtu_cb_t node_pmtu_cb;
121 meshlink_channel_listen_cb_t channel_listen_cb;
122 meshlink_channel_accept_cb_t channel_accept_cb;
123 meshlink_node_duplicate_cb_t node_duplicate_cb;
124 meshlink_connection_try_cb_t connection_try_cb;
125 meshlink_error_cb_t error_cb;
131 struct ecdsa *private_key;
133 dev_class_t devclass;
135 dev_class_traits_t dev_class_traits[DEV_CLASS_COUNT];
139 bool inviter_commits_first;
145 char *external_address_url;
146 meshlink_storage_policy_t storage_policy;
154 /// A handle for a MeshLink node.
155 struct meshlink_node {
161 typedef struct meshlink_aio_buffer {
167 meshlink_aio_cb_t buffer;
168 meshlink_aio_fd_cb_t fd;
171 struct meshlink_aio_buffer *next;
172 } meshlink_aio_buffer_t;
175 struct meshlink_channel {
180 struct utcp_connection *c;
181 meshlink_aio_buffer_t *aio_send;
182 meshlink_aio_buffer_t *aio_receive;
183 meshlink_channel_receive_cb_t receive_cb;
184 meshlink_channel_poll_cb_t poll_cb;
187 /// Header for data packets routed between nodes
188 typedef struct meshlink_packethdr {
189 uint8_t destination[16];
191 } __attribute__((__packed__)) meshlink_packethdr_t;
193 void meshlink_send_from_queue(event_loop_t *loop, void *mesh);
194 void update_node_status(meshlink_handle_t *mesh, struct node_t *n);
195 void update_node_pmtu(meshlink_handle_t *mesh, struct node_t *n);
196 extern meshlink_log_level_t global_log_level;
197 extern meshlink_log_cb_t global_log_cb;
198 void handle_duplicate_node(meshlink_handle_t *mesh, struct node_t *n);
199 void handle_network_change(meshlink_handle_t *mesh, bool online);
200 void call_error_cb(meshlink_handle_t *mesh, meshlink_errno_t meshlink_errno);
202 /// Per-instance PRNG
203 static inline int prng(meshlink_handle_t *mesh, uint64_t max) {
204 return xoshiro(mesh->prng_state) % max;
207 /// Fudge value of ~0.1 seconds, in microseconds.
208 static const unsigned int TIMER_FUDGE = 0x8000000;