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