]> git.meshlink.io Git - meshlink/blob - src/meshlink_internal.h
Ensure the flush timer is started if we never had any full packets to send.
[meshlink] / src / meshlink_internal.h
1 #ifndef MESHLINK_INTERNAL_H
2 #define MESHLINK_INTERNAL_H
3
4 /*
5     meshlink_internal.h -- Internal parts of the public API.
6     Copyright (C) 2014-2019 Guus Sliepen <guus@meshlink.io>
7
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.
12
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.
17
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.
21 */
22
23 #ifdef MESHLINK_H
24 #error You must not include both meshlink.h and meshlink_internal.h!
25 #endif
26
27 #include "system.h"
28
29 #include "event.h"
30 #include "hash.h"
31 #include "meshlink.h"
32 #include "meshlink_queue.h"
33 #include "sockaddr.h"
34 #include "sptps.h"
35 #include "xoshiro.h"
36
37 #include <pthread.h>
38
39 #define MAXSOCKETS 4    /* Probably overkill... */
40
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";
44
45 #define MESHLINK_CONFIG_VERSION 2
46 #define MESHLINK_INVITATION_VERSION 2
47
48 struct CattaServer;
49 struct CattaSServiceBrowser;
50 struct CattaSimplePoll;
51 struct CattaSEntryGroup;
52
53 typedef struct listen_socket_t {
54         struct io_t tcp;
55         struct io_t udp;
56         sockaddr_t sa;
57         sockaddr_t broadcast_sa;
58 } listen_socket_t;
59
60 struct meshlink_open_params {
61         char *confbase;
62         char *appname;
63         char *name;
64         dev_class_t devclass;
65
66         int netns;
67
68         const void *key;
69         size_t keylen;
70 };
71
72 /// Device class traits
73 typedef struct {
74         int pinginterval;
75         int pingtimeout;
76         int fast_retry_period;
77         unsigned int min_connects;
78         unsigned int max_connects;
79         int edge_weight;
80 } dev_class_traits_t;
81
82 /// A handle for an instance of MeshLink.
83 struct meshlink_handle {
84         // public members
85         char *name;
86         void *priv;
87
88         // private members
89         pthread_mutex_t mutex;
90         event_loop_t loop;
91         struct node_t *self;
92         meshlink_log_cb_t log_cb;
93         meshlink_log_level_t log_level;
94         void *packet;
95
96         // The most important network-related members come first
97         int reachable;
98         int listen_sockets;
99         listen_socket_t listen_socket[MAXSOCKETS];
100
101         meshlink_receive_cb_t receive_cb;
102         meshlink_queue_t outpacketqueue;
103         signal_t datafromapp;
104
105         hash_t *node_udp_cache;
106
107         struct splay_tree_t *nodes;
108         struct splay_tree_t *edges;
109
110         struct list_t *connections;
111         struct list_t *outgoings;
112         struct list_t *submeshes;
113
114         // Meta-connection-related members
115         struct splay_tree_t *past_request_tree;
116         timeout_t past_request_timeout;
117
118         int connection_burst;
119         int contradicting_add_edge;
120         int contradicting_del_edge;
121         int sleeptime;
122         time_t connection_burst_time;
123         time_t last_hard_try;
124         time_t last_unreachable;
125         timeout_t pingtimer;
126         timeout_t periodictimer;
127
128         struct connection_t *everyone;
129         uint64_t prng_state[4];
130         uint32_t session_id;
131
132         int next_pit;
133         int pits[10];
134
135         // Infrequently used callbacks
136         meshlink_node_status_cb_t node_status_cb;
137         meshlink_node_pmtu_cb_t node_pmtu_cb;
138         meshlink_channel_accept_cb_t channel_accept_cb;
139         meshlink_node_duplicate_cb_t node_duplicate_cb;
140         meshlink_connection_try_cb_t connection_try_cb;
141         meshlink_error_cb_t error_cb;
142
143         // Mesh parameters
144         char *appname;
145         char *myport;
146
147         struct ecdsa *private_key;
148         struct ecdsa *invitation_key;
149
150         dev_class_t devclass;
151
152         int invitation_timeout;
153         int maxtimeout;
154         int udp_choice;
155
156         dev_class_traits_t dev_class_traits[DEV_CLASS_COUNT];
157
158         int netns;
159
160         bool default_blacklist;
161         bool discovery;         // Whether Catta is enabled or not
162         bool inviter_commits_first;
163
164         // Configuration
165         char *confbase;
166         FILE *lockfile;
167         void *config_key;
168         char *external_address_url;
169         struct list_t *invitation_addresses;
170
171         // Thread management
172         pthread_t thread;
173         pthread_cond_t cond;
174         pthread_mutex_t discovery_mutex;
175         pthread_cond_t discovery_cond;
176         bool threadstarted;
177         bool discovery_threadstarted;
178
179         // Catta
180         pthread_t discovery_thread;
181         struct CattaServer *catta_server;
182         struct CattaSServiceBrowser *catta_browser;
183         struct CattaSimplePoll *catta_poll;
184         struct CattaSEntryGroup *catta_group;
185         char *catta_servicetype;
186         unsigned int catta_interfaces;
187
188         // ADNS
189         pthread_t adns_thread;
190         pthread_cond_t adns_cond;
191         meshlink_queue_t adns_queue;
192         meshlink_queue_t adns_done_queue;
193         signal_t adns_signal;
194 };
195
196 /// A handle for a MeshLink node.
197 struct meshlink_node {
198         const char *name;
199         void *priv;
200 };
201
202 /// A handle for a node Sub-Mesh.
203 struct meshlink_submesh {
204         const char *name;
205         void *priv;
206 };
207
208 /// An AIO buffer.
209 typedef struct meshlink_aio_buffer {
210         const void *data;
211         int fd;
212         size_t len;
213         size_t done;
214         union {
215                 meshlink_aio_cb_t buffer;
216                 meshlink_aio_fd_cb_t fd;
217         } cb;
218         void *priv;
219         struct meshlink_aio_buffer *next;
220 } meshlink_aio_buffer_t;
221
222 /// A channel.
223 struct meshlink_channel {
224         struct node_t *node;
225         void *priv;
226         bool in_callback;
227
228         struct utcp_connection *c;
229         meshlink_aio_buffer_t *aio_send;
230         meshlink_aio_buffer_t *aio_receive;
231         meshlink_channel_receive_cb_t receive_cb;
232         meshlink_channel_poll_cb_t poll_cb;
233 };
234
235 /// Header for data packets routed between nodes
236 typedef struct meshlink_packethdr {
237         uint8_t destination[16];
238         uint8_t source[16];
239 } __attribute__((__packed__)) meshlink_packethdr_t;
240
241 void meshlink_send_from_queue(event_loop_t *loop, void *mesh);
242 void update_node_status(meshlink_handle_t *mesh, struct node_t *n);
243 void update_node_pmtu(meshlink_handle_t *mesh, struct node_t *n);
244 extern meshlink_log_level_t global_log_level;
245 extern meshlink_log_cb_t global_log_cb;
246 void handle_duplicate_node(meshlink_handle_t *mesh, struct node_t *n);
247 void handle_network_change(meshlink_handle_t *mesh, bool online);
248 void call_error_cb(meshlink_handle_t *mesh, meshlink_errno_t meshlink_errno);
249
250 /// Per-instance PRNG
251 static inline int prng(meshlink_handle_t *mesh, uint64_t max) {
252         return xoshiro(mesh->prng_state) % max;
253 }
254
255 /// Fudge value of ~0.1 seconds, in microseconds.
256 static const unsigned int TIMER_FUDGE = 0x8000000;
257
258 #endif