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