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 typedef enum proxytype_t {
  61         PROXY_NONE = 0,
  62         PROXY_SOCKS4,
  63         PROXY_SOCKS4A,
  64         PROXY_SOCKS5,
  65         PROXY_HTTP,
  66 } proxytype_t;
  67
  68 struct meshlink_open_params {
  69         char *confbase;
  70         char *appname;
  71         char *name;
  72         dev_class_t devclass;
  73
  74         int netns;
  75
  76         const void *key;
  77         size_t keylen;
  78 };
  79
  80 /// Device class traits
  81 typedef struct {
  82         int pinginterval;
  83         int pingtimeout;
  84         int fast_retry_period;
  85         unsigned int min_connects;
  86         unsigned int max_connects;
  87         int edge_weight;
  88 } dev_class_traits_t;
  89
  90 /// A handle for an instance of MeshLink.
  91 struct meshlink_handle {
  92         // public members
  93         char *name;
  94         void *priv;
  95
  96         // private members
  97         pthread_mutex_t mutex;
  98         event_loop_t loop;
  99         struct node_t *self;
 100         meshlink_log_cb_t log_cb;
 101         meshlink_log_level_t log_level;
 102         void *packet;
 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_hard_try;
 132         time_t last_unreachable;
 133         timeout_t pingtimer;
 134         timeout_t periodictimer;
 135
 136         struct connection_t *everyone;
 137         uint64_t prng_state[4];
 138         uint32_t session_id;
 139
 140         int next_pit;
 141         int pits[10];
 142
 143         // Infrequently used callbacks
 144         meshlink_node_status_cb_t node_status_cb;
 145         meshlink_node_pmtu_cb_t node_pmtu_cb;
 146         meshlink_channel_accept_cb_t channel_accept_cb;
 147         meshlink_node_duplicate_cb_t node_duplicate_cb;
 148         meshlink_connection_try_cb_t connection_try_cb;
 149         meshlink_error_cb_t error_cb;
 150
 151         // Mesh parameters
 152         char *appname;
 153         char *myport;
 154
 155         struct ecdsa *private_key;
 156         struct ecdsa *invitation_key;
 157
 158         dev_class_t devclass;
 159
 160         int invitation_timeout;
 161         int maxtimeout;
 162         int udp_choice;
 163
 164         dev_class_traits_t dev_class_traits[DEV_CLASS_COUNT];
 165
 166         int netns;
 167
 168         bool default_blacklist;
 169         bool discovery;         // Whether Catta is enabled or not
 170         bool inviter_commits_first;
 171
 172         // Configuration
 173         char *confbase;
 174         FILE *lockfile;
 175         void *config_key;
 176         char *external_address_url;
 177         struct list_t *invitation_addresses;
 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         // ADNS
 197         pthread_t adns_thread;
 198         pthread_cond_t adns_cond;
 199         meshlink_queue_t adns_queue;
 200         meshlink_queue_t adns_done_queue;
 201         signal_t adns_signal;
 202
 203         // Proxy configuration, currently not exposed.
 204         char *proxyhost;
 205         char *proxyport;
 206         char *proxyuser;
 207         char *proxypass;
 208         proxytype_t proxytype;
 209 };
 210
 211 /// A handle for a MeshLink node.
 212 struct meshlink_node {
 213         const char *name;
 214         void *priv;
 215 };
 216
 217 /// A handle for a node Sub-Mesh.
 218 struct meshlink_submesh {
 219         const char *name;
 220         void *priv;
 221 };
 222
 223 /// An AIO buffer.
 224 typedef struct meshlink_aio_buffer {
 225         const void *data;
 226         int fd;
 227         size_t len;
 228         size_t done;
 229         union {
 230                 meshlink_aio_cb_t buffer;
 231                 meshlink_aio_fd_cb_t fd;
 232         } cb;
 233         void *priv;
 234         struct meshlink_aio_buffer *next;
 235 } meshlink_aio_buffer_t;
 236
 237 /// A channel.
 238 struct meshlink_channel {
 239         struct node_t *node;
 240         void *priv;
 241
 242         struct utcp_connection *c;
 243         meshlink_aio_buffer_t *aio_send;
 244         meshlink_aio_buffer_t *aio_receive;
 245         meshlink_channel_receive_cb_t receive_cb;
 246         meshlink_channel_poll_cb_t poll_cb;
 247 };
 248
 249 /// Header for data packets routed between nodes
 250 typedef struct meshlink_packethdr {
 251         uint8_t destination[16];
 252         uint8_t source[16];
 253 } __attribute__((__packed__)) meshlink_packethdr_t;
 254
 255 extern void meshlink_send_from_queue(event_loop_t *loop, void *mesh);
 256 extern void update_node_status(meshlink_handle_t *mesh, struct node_t *n);
 257 extern void update_node_pmtu(meshlink_handle_t *mesh, struct node_t *n);
 258 extern meshlink_log_level_t global_log_level;
 259 extern meshlink_log_cb_t global_log_cb;
 260 extern void handle_duplicate_node(meshlink_handle_t *mesh, struct node_t *n);
 261 extern void handle_network_change(meshlink_handle_t *mesh, bool online);
 262 extern void call_error_cb(meshlink_handle_t *mesh, meshlink_errno_t meshlink_errno);
 263
 264 /// Per-instance PRNG
 265 static inline int prng(meshlink_handle_t *mesh, uint64_t max) {
 266         return xoshiro(mesh->prng_state) % max;
 267 }
 268
 269 /// Fudge value of ~0.1 seconds, in microseconds.
 270 static const unsigned int TIMER_FUDGE = 0x8000000;
 271
 272 #endif