git.meshlink.io Git - meshlink-tiny/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-tiny.h and meshlink_internal.h!
  25 #endif
  26
  27 #include "system.h"
  28
  29 #include "event.h"
  30 #include "hash.h"
  31 #include "meshlink-tiny.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 typedef struct listen_socket_t {
  49         struct io_t tcp;
  50         sockaddr_t sa;
  51         sockaddr_t broadcast_sa;
  52 } listen_socket_t;
  53
  54 struct meshlink_open_params {
  55         char *confbase;
  56         char *lock_filename;
  57         char *appname;
  58         char *name;
  59         dev_class_t devclass;
  60
  61         int netns;
  62
  63         const void *key;
  64         size_t keylen;
  65         meshlink_storage_policy_t storage_policy;
  66 };
  67
  68 /// Device class traits
  69 typedef struct {
  70         int pinginterval;
  71         int pingtimeout;
  72         int fast_retry_period;
  73         int maxtimeout;
  74         unsigned int min_connects;
  75         unsigned int max_connects;
  76         int edge_weight;
  77 } dev_class_traits_t;
  78
  79 /// A handle for an instance of MeshLink.
  80 struct meshlink_handle {
  81         // public members
  82         char *name;
  83         void *priv;
  84
  85         // private members
  86         pthread_mutex_t mutex;
  87         event_loop_t loop;
  88         struct node_t *self;
  89         meshlink_log_cb_t log_cb;
  90         meshlink_log_level_t log_level;
  91         void *packet;
  92
  93         // The most important network-related members come first
  94         int reachable;
  95         int listen_sockets;
  96         listen_socket_t listen_socket[MAXSOCKETS];
  97
  98         meshlink_receive_cb_t receive_cb;
  99         meshlink_queue_t outpacketqueue;
 100         signal_t datafromapp;
 101
 102         struct splay_tree_t *nodes;
 103
 104         struct list_t *connections;
 105         struct list_t *outgoings;
 106         struct list_t *submeshes;
 107
 108         // Meta-connection-related members
 109         struct splay_tree_t *past_request_tree;
 110         timeout_t past_request_timeout;
 111
 112         int connection_burst;
 113         int contradicting_add_edge;
 114         int contradicting_del_edge;
 115         int sleeptime;
 116         time_t connection_burst_time;
 117         time_t last_hard_try;
 118         time_t last_unreachable;
 119         timeout_t pingtimer;
 120         timeout_t periodictimer;
 121
 122         struct connection_t *everyone;
 123         uint64_t prng_state[4];
 124         uint32_t session_id;
 125
 126         int next_pit;
 127         int pits[10];
 128
 129         // Infrequently used callbacks
 130         meshlink_node_status_cb_t node_status_cb;
 131         meshlink_node_status_cb_t meta_status_cb;
 132         meshlink_node_pmtu_cb_t node_pmtu_cb;
 133         meshlink_channel_listen_cb_t channel_listen_cb;
 134         meshlink_channel_accept_cb_t channel_accept_cb;
 135         meshlink_node_duplicate_cb_t node_duplicate_cb;
 136         meshlink_connection_try_cb_t connection_try_cb;
 137         meshlink_error_cb_t error_cb;
 138
 139         // Mesh parameters
 140         char *appname;
 141         char *myport;
 142
 143         struct ecdsa *private_key;
 144
 145         dev_class_t devclass;
 146
 147         dev_class_traits_t dev_class_traits[DEV_CLASS_COUNT];
 148
 149         int netns;
 150
 151         bool inviter_commits_first;
 152
 153         // Configuration
 154         char *confbase;
 155         FILE *lockfile;
 156         void *config_key;
 157         char *external_address_url;
 158         meshlink_storage_policy_t storage_policy;
 159
 160         // Thread management
 161         pthread_t thread;
 162         pthread_cond_t cond;
 163         bool threadstarted;
 164 };
 165
 166 /// A handle for a MeshLink node.
 167 struct meshlink_node {
 168         const char *name;
 169         void *priv;
 170 };
 171
 172 /// A handle for a node Sub-Mesh.
 173 struct meshlink_submesh {
 174         const char *name;
 175         void *priv;
 176 };
 177
 178 /// An AIO buffer.
 179 typedef struct meshlink_aio_buffer {
 180         const void *data;
 181         int fd;
 182         size_t len;
 183         size_t done;
 184         union {
 185                 meshlink_aio_cb_t buffer;
 186                 meshlink_aio_fd_cb_t fd;
 187         } cb;
 188         void *priv;
 189         struct meshlink_aio_buffer *next;
 190 } meshlink_aio_buffer_t;
 191
 192 /// A channel.
 193 struct meshlink_channel {
 194         struct node_t *node;
 195         void *priv;
 196         bool in_callback;
 197
 198         struct utcp_connection *c;
 199         meshlink_aio_buffer_t *aio_send;
 200         meshlink_aio_buffer_t *aio_receive;
 201         meshlink_channel_receive_cb_t receive_cb;
 202         meshlink_channel_poll_cb_t poll_cb;
 203 };
 204
 205 /// Header for data packets routed between nodes
 206 typedef struct meshlink_packethdr {
 207         uint8_t destination[16];
 208         uint8_t source[16];
 209 } __attribute__((__packed__)) meshlink_packethdr_t;
 210
 211 void meshlink_send_from_queue(event_loop_t *loop, void *mesh);
 212 void update_node_status(meshlink_handle_t *mesh, struct node_t *n);
 213 void update_node_pmtu(meshlink_handle_t *mesh, struct node_t *n);
 214 extern meshlink_log_level_t global_log_level;
 215 extern meshlink_log_cb_t global_log_cb;
 216 void handle_duplicate_node(meshlink_handle_t *mesh, struct node_t *n);
 217 void handle_network_change(meshlink_handle_t *mesh, bool online);
 218 void call_error_cb(meshlink_handle_t *mesh, meshlink_errno_t meshlink_errno);
 219
 220 /// Per-instance PRNG
 221 static inline int prng(meshlink_handle_t *mesh, uint64_t max) {
 222         return xoshiro(mesh->prng_state) % max;
 223 }
 224
 225 /// Fudge value of ~0.1 seconds, in microseconds.
 226 static const unsigned int TIMER_FUDGE = 0x8000000;
 227
 228 #endif