Add UDP discovery mechanism.
[tinc] / src / node.h
1 /*
2     node.h -- header for node.c
3     Copyright (C) 2001-2013 Guus Sliepen <guus@tinc-vpn.org>,
4                   2001-2005 Ivo Timmermans
5
6     This program is free software; you can redistribute it and/or modify
7     it under the terms of the GNU General Public License as published by
8     the Free Software Foundation; either version 2 of the License, or
9     (at your option) any later version.
10
11     This program is distributed in the hope that it will be useful,
12     but WITHOUT ANY WARRANTY; without even the implied warranty of
13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14     GNU General Public License for more details.
15
16     You should have received a copy of the GNU General Public License along
17     with this program; if not, write to the Free Software Foundation, Inc.,
18     51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
19 */
20
21 #ifndef __TINC_NODE_H__
22 #define __TINC_NODE_H__
23
24 #include "splay_tree.h"
25 #include "cipher.h"
26 #include "connection.h"
27 #include "digest.h"
28 #include "event.h"
29 #include "subnet.h"
30
31 typedef struct node_status_t {
32         unsigned int unused_active:1;           /* 1 if active (not used for nodes) */
33         unsigned int validkey:1;                /* 1 if we currently have a valid key for him */
34         unsigned int waitingforkey:1;           /* 1 if we already sent out a request */
35         unsigned int visited:1;                 /* 1 if this node has been visited by one of the graph algorithms */
36         unsigned int reachable:1;               /* 1 if this node is reachable in the graph */
37         unsigned int indirect:1;                /* 1 if this node is not directly reachable by us */
38         unsigned int sptps:1;                   /* 1 if this node supports SPTPS */
39         unsigned int udp_confirmed:1;           /* 1 if the address is one that we received UDP traffic on */
40         unsigned int send_locally:1;            /* 1 if the next UDP packet should be sent on the local network */
41         unsigned int unused:23;
42 } node_status_t;
43
44 typedef struct node_t {
45         char *name;                             /* name of this node */
46         node_id_t id;                           /* unique node ID (name hash) */
47         uint32_t options;                       /* options turned on for this node */
48
49         int sock;                               /* Socket to use for outgoing UDP packets */
50         sockaddr_t address;                     /* his real (internet) ip to send UDP packets to */
51         char *hostname;                         /* the hostname of its real ip */
52
53         node_status_t status;
54         time_t last_state_change;
55         time_t last_req_key;
56
57         ecdsa_t *ecdsa;                         /* His public ECDSA key */
58         sptps_t sptps;
59
60 #ifndef DISABLE_LEGACY
61         cipher_t *incipher;                     /* Cipher for UDP packets */
62         digest_t *indigest;                     /* Digest for UDP packets */
63
64         cipher_t *outcipher;                    /* Cipher for UDP packets */
65         digest_t *outdigest;                    /* Digest for UDP packets */
66 #endif
67
68         int incompression;                      /* Compressionlevel, 0 = no compression */
69         int outcompression;                     /* Compressionlevel, 0 = no compression */
70
71         int distance;
72         struct node_t *nexthop;                 /* nearest node from us to him */
73         struct edge_t *prevedge;                /* nearest node from him to us */
74         struct node_t *via;                     /* next hop for UDP packets */
75
76         splay_tree_t *subnet_tree;              /* Pointer to a tree of subnets belonging to this node */
77
78         splay_tree_t *edge_tree;                /* Edges with this node as one of the endpoints */
79
80         struct connection_t *connection;        /* Connection associated with this node (if a direct connection exists) */
81
82         uint32_t sent_seqno;                    /* Sequence number last sent to this node */
83         uint32_t received_seqno;                /* Sequence number last received from this node */
84         uint32_t received;                      /* Total valid packets received from this node */
85         uint32_t prev_received_seqno;
86         uint32_t prev_received;
87         uint32_t farfuture;                     /* Packets in a row that have arrived from the far future */
88         unsigned char* late;                    /* Bitfield marking late packets */
89
90         struct timeval udp_ping_sent;           /* Last time a ping probe was sent */
91         timeout_t udp_ping_timeout;             /* Ping timeout event */
92
93         length_t mtu;                           /* Maximum size of packets to send to this node */
94         length_t minmtu;                        /* Probed minimum MTU */
95         length_t maxmtu;                        /* Probed maximum MTU */
96         int mtuprobes;                          /* Number of probes */
97         timeout_t mtutimeout;                   /* Probe event */
98         struct timeval probe_time;              /* Time the last probe was sent or received */
99         int probe_counter;                      /* Number of probes received since last burst was sent */
100         float rtt;                              /* Last measured round trip time */
101         float bandwidth;                        /* Last measured bandwidth */
102         float packetloss;                       /* Last measured packet loss rate */
103
104         uint64_t in_packets;
105         uint64_t in_bytes;
106         uint64_t out_packets;
107         uint64_t out_bytes;
108 } node_t;
109
110 extern struct node_t *myself;
111 extern splay_tree_t *node_tree;
112
113 extern void init_nodes(void);
114 extern void exit_nodes(void);
115 extern node_t *new_node(void) __attribute__ ((__malloc__));
116 extern void free_node(node_t *);
117 extern void node_add(node_t *);
118 extern void node_del(node_t *);
119 extern node_t *lookup_node(char *);
120 extern node_t *lookup_node_id(const node_id_t *);
121 extern node_t *lookup_node_udp(const sockaddr_t *);
122 extern bool dump_nodes(struct connection_t *);
123 extern bool dump_traffic(struct connection_t *);
124 extern void update_node_udp(node_t *, const sockaddr_t *);
125
126 #endif /* __TINC_NODE_H__ */