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