git.meshlink.io Git - meshlink/blob - src/node.h

   1 #ifndef MESHLINK_NODE_H
   2 #define MESHLINK_NODE_H
   3
   4 /*
   5     node.h -- header for node.c
   6     Copyright (C) 2014, 2017 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 #include "event.h"
  24 #include "sockaddr.h"
  25 #include "sptps.h"
  26 #include "utcp.h"
  27 #include "submesh.h"
  28
  29 typedef struct node_status_t {
  30         uint16_t validkey: 1;               /* 1 if we currently have a valid key for him */
  31         uint16_t waitingforkey: 1;          /* 1 if we already sent out a request */
  32         uint16_t visited: 1;                /* 1 if this node has been visited by one of the graph algorithms */
  33         uint16_t reachable: 1;              /* 1 if this node is reachable in the graph */
  34         uint16_t udp_confirmed: 1;          /* 1 if the address is one that we received UDP traffic on */
  35         uint16_t broadcast: 1;              /* 1 if the next UDP packet should be broadcast to the local network */
  36         uint16_t blacklisted: 1;            /* 1 if the node is blacklist so we never want to speak with him anymore */
  37         uint16_t destroyed: 1;              /* 1 if the node is being destroyed, deallocate channels when any callback is triggered */
  38         uint16_t duplicate: 1;              /* 1 if the node is duplicate, ie. multiple nodes using the same Name are online */
  39         uint16_t dirty: 1;                  /* 1 if the configuration of the node is dirty and needs to be written out */
  40         uint16_t want_udp: 1;               /* 1 if we want working UDP because we have data to send */
  41         uint16_t tiny: 1;                   /* 1 if this is a tiny node */
  42 } node_status_t;
  43
  44 #define MAX_RECENT 5
  45
  46 typedef struct node_t {
  47         // Public member variables
  48         char *name;                             /* name of this node */
  49         void *priv;
  50
  51         // Private member variables
  52         node_status_t status;
  53         uint16_t minmtu;                        /* Probed minimum MTU */
  54         dev_class_t devclass;
  55
  56         // Used for packet I/O
  57         int sock;                               /* Socket to use for outgoing UDP packets */
  58         uint32_t session_id;                    /* Unique ID for this node's currently running process */
  59         sptps_t sptps;
  60         sockaddr_t address;                     /* his real (internet) ip to send UDP packets to */
  61
  62         struct utcp *utcp;
  63
  64         // Traffic counters
  65         uint64_t in_data;                       /* Bytes received from channels */
  66         uint64_t out_data;                      /* Bytes sent via channels */
  67         uint64_t in_forward;                    /* Bytes received for channels that need to be forwarded to other nodes */
  68         uint64_t out_forward;                   /* Bytes forwarded from channel from other nodes */
  69         uint64_t in_meta;                       /* Bytes received from meta-connections, heartbeat packets etc. */
  70         uint64_t out_meta;                      /* Bytes sent on meta-connections, heartbeat packets etc. */
  71
  72         // MTU probes
  73         timeout_t mtutimeout;                   /* Probe event */
  74         int mtuprobes;                          /* Number of probes */
  75         uint16_t mtu;                           /* Maximum size of packets to send to this node */
  76         uint16_t maxmtu;                        /* Probed maximum MTU */
  77
  78         // Used for meta-connection I/O, timeouts
  79         struct meshlink_handle *mesh;           /* The mesh this node belongs to */
  80         struct submesh_t *submesh;              /* Nodes Sub-Mesh Handle*/
  81
  82         time_t last_req_key;
  83
  84         struct ecdsa *ecdsa;                    /* His public ECDSA key */
  85
  86         struct connection_t *connection;        /* Connection associated with this node (if a direct connection exists) */
  87         time_t last_connect_try;
  88         time_t last_successfull_connection;
  89
  90         char *canonical_address;                /* The canonical address of this node, if known */
  91         sockaddr_t recent[MAX_RECENT];          /* Recently seen addresses */
  92         sockaddr_t catta_address;               /* Latest address seen by Catta */
  93
  94         // Graph-related member variables
  95         time_t last_reachable;
  96         time_t last_unreachable;
  97
  98         int distance;
  99         struct node_t *nexthop;                 /* nearest node from us to him */
 100         struct edge_t *prevedge;                /* nearest node from him to us */
 101
 102         struct splay_tree_t *edge_tree;         /* Edges with this node as one of the endpoints */
 103 } node_t;
 104
 105 void init_nodes(struct meshlink_handle *mesh);
 106 void exit_nodes(struct meshlink_handle *mesh);
 107 node_t *new_node(void) __attribute__((__malloc__));
 108 void free_node(node_t *n);
 109 void node_add(struct meshlink_handle *mesh, node_t *n);
 110 void node_del(struct meshlink_handle *mesh, node_t *n);
 111 node_t *lookup_node(struct meshlink_handle *mesh, const char *name) __attribute__((__warn_unused_result__));
 112 node_t *lookup_node_udp(struct meshlink_handle *mesh, const sockaddr_t *sa) __attribute__((__warn_unused_result__));
 113 void update_node_udp(struct meshlink_handle *mesh, node_t *n, const sockaddr_t *sa);
 114 bool node_add_recent_address(struct meshlink_handle *mesh, node_t *n, const sockaddr_t *addr);
 115
 116 #endif