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