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