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
  36 #include <pthread.h>
  37
  38 #define MAXSOCKETS 4    /* Probably overkill... */
  39
  40 static const char meshlink_invitation_label[] = "MeshLink invitation";
  41 static const char meshlink_tcp_label[] = "MeshLink TCP";
  42 static const char meshlink_udp_label[] = "MeshLink UDP";
  43
  44 #define MESHLINK_CONFIG_VERSION 1
  45 #define MESHLINK_INVITATION_VERSION 1
  46
  47 struct CattaServer;
  48 struct CattaSServiceBrowser;
  49 struct CattaSimplePoll;
  50 struct CattaSEntryGroup;
  51
  52 typedef struct listen_socket_t {
  53         struct io_t tcp;
  54         struct io_t udp;
  55         sockaddr_t sa;
  56         bool bindto;
  57 } listen_socket_t;
  58
  59 typedef enum proxytype_t {
  60         PROXY_NONE = 0,
  61         PROXY_SOCKS4,
  62         PROXY_SOCKS4A,
  63         PROXY_SOCKS5,
  64         PROXY_HTTP,
  65 } proxytype_t;
  66
  67 struct meshlink_open_params {
  68         char *confbase;
  69         char *appname;
  70         char *name;
  71         dev_class_t devclass;
  72
  73         int netns;
  74
  75         const void *key;
  76         size_t keylen;
  77 };
  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 mesh_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
  92         // The most important network-related members come first
  93         int listen_sockets;
  94         listen_socket_t listen_socket[MAXSOCKETS];
  95
  96         meshlink_receive_cb_t receive_cb;
  97         meshlink_queue_t outpacketqueue;
  98         signal_t datafromapp;
  99
 100         hash_t *node_udp_cache;
 101
 102         struct splay_tree_t *nodes;
 103         struct splay_tree_t *edges;
 104
 105         struct list_t *connections;
 106         struct list_t *outgoings;
 107         struct list_t *submeshes;
 108
 109         // Meta-connection-related members
 110         struct splay_tree_t *past_request_tree;
 111         timeout_t past_request_timeout;
 112
 113         int connection_burst;
 114         int contradicting_add_edge;
 115         int contradicting_del_edge;
 116         int sleeptime;
 117         time_t connection_burst_time;
 118         time_t last_config_check;
 119         time_t last_hard_try;
 120         timeout_t pingtimer;
 121         timeout_t periodictimer;
 122
 123         struct connection_t *everyone;
 124
 125         int next_pit;
 126         int pits[10];
 127
 128         // Infrequently used callbacks
 129         meshlink_node_status_cb_t node_status_cb;
 130         meshlink_channel_accept_cb_t channel_accept_cb;
 131         meshlink_node_duplicate_cb_t node_duplicate_cb;
 132         meshlink_connection_try_cb_t connection_try_cb;
 133
 134         // Mesh parameters
 135         char *appname;
 136         char *myport;
 137
 138         struct ecdsa *private_key;
 139         struct ecdsa *invitation_key;
 140
 141         int32_t devclass;
 142
 143         int invitation_timeout;
 144         int pinginterval;       /* seconds between pings */
 145         int pingtimeout;        /* seconds to wait for response */
 146         int maxtimeout;
 147         int udp_choice;
 148
 149         int netns;
 150
 151         bool default_blacklist;
 152         bool discovery;         // Whether Catta is enabled or not
 153
 154
 155         // Configuration
 156         char *confbase;
 157         FILE *conffile;
 158         void *config_key;
 159
 160         // Thread management
 161         pthread_t thread;
 162         pthread_cond_t cond;
 163         pthread_mutex_t discovery_mutex;
 164         pthread_cond_t discovery_cond;
 165         bool threadstarted;
 166         bool discovery_threadstarted;
 167
 168         // Catta
 169         pthread_t discovery_thread;
 170         struct CattaServer *catta_server;
 171         struct CattaSServiceBrowser *catta_browser;
 172         struct CattaSimplePoll *catta_poll;
 173         struct CattaSEntryGroup *catta_group;
 174         char *catta_servicetype;
 175         unsigned int catta_interfaces;
 176
 177         // State used for meshlink_join()
 178         int sock;
 179         char cookie[18], hash[18];
 180         bool success;
 181         sptps_t sptps;
 182         char *data;
 183         size_t thedatalen;
 184         size_t blen;
 185         char line[4096];
 186         char buffer[4096];
 187
 188         // Proxy configuration, currently not exposed.
 189         char *proxyhost;
 190         char *proxyport;
 191         char *proxyuser;
 192         char *proxypass;
 193         proxytype_t proxytype;
 194 };
 195
 196 /// A handle for a MeshLink node.
 197 struct meshlink_node {
 198         const char *name;
 199         void *priv;
 200 };
 201
 202 /// A handle for a node Sub-Mesh.
 203 struct meshlink_submesh {
 204         const char *name;
 205         void *priv;
 206 };
 207
 208 /// An AIO buffer.
 209 typedef struct meshlink_aio_buffer {
 210         const void *data;
 211         size_t len;
 212         size_t done;
 213         meshlink_aio_cb_t cb;
 214         void *priv;
 215         struct meshlink_aio_buffer *next;
 216 } meshlink_aio_buffer_t;
 217
 218 /// A channel.
 219 struct meshlink_channel {
 220         struct node_t *node;
 221         void *priv;
 222
 223         struct utcp_connection *c;
 224         meshlink_aio_buffer_t *aio_send;
 225         meshlink_aio_buffer_t *aio_receive;
 226         meshlink_channel_receive_cb_t receive_cb;
 227         meshlink_channel_poll_cb_t poll_cb;
 228 };
 229
 230 /// Header for data packets routed between nodes
 231 typedef struct meshlink_packethdr {
 232         uint8_t destination[16];
 233         uint8_t source[16];
 234 } __attribute__((__packed__)) meshlink_packethdr_t;
 235
 236 extern void meshlink_send_from_queue(event_loop_t *el, meshlink_handle_t *mesh);
 237 extern void update_node_status(meshlink_handle_t *mesh, struct node_t *n);
 238 extern meshlink_log_level_t global_log_level;
 239 extern meshlink_log_cb_t global_log_cb;
 240 extern int check_port(meshlink_handle_t *mesh);
 241 extern void handle_duplicate_node(meshlink_handle_t *mesh, struct node_t *n);
 242 extern void handle_network_change(meshlink_handle_t *mesh, bool online);
 243
 244 /// Device class traits
 245 typedef struct {
 246         unsigned int min_connects;
 247         unsigned int max_connects;
 248         int edge_weight;
 249 } dev_class_traits_t;
 250
 251 extern const dev_class_traits_t dev_class_traits[];
 252
 253 #endif