Realign comments.
[oweals/tinc.git] / src / subnet.h
1 #ifndef TINC_SUBNET_H
2 #define TINC_SUBNET_H
3
4 /*
5     subnet.h -- header for subnet.c
6     Copyright (C) 2000-2009 Guus Sliepen <guus@tinc-vpn.org>,
7                   2000-2005 Ivo Timmermans
8
9     This program is free software; you can redistribute it and/or modify
10     it under the terms of the GNU General Public License as published by
11     the Free Software Foundation; either version 2 of the License, or
12     (at your option) any later version.
13
14     This program is distributed in the hope that it will be useful,
15     but WITHOUT ANY WARRANTY; without even the implied warranty of
16     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17     GNU General Public License for more details.
18
19     You should have received a copy of the GNU General Public License along
20     with this program; if not, write to the Free Software Foundation, Inc.,
21     51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
22 */
23
24 #include "net.h"
25
26 typedef enum subnet_type_t {
27         SUBNET_MAC = 0,
28         SUBNET_IPV4,
29         SUBNET_IPV6,
30         SUBNET_TYPES,          /* Guardian */
31 } subnet_type_t;
32
33 typedef struct subnet_mac_t {
34         mac_t address;
35 } subnet_mac_t;
36
37 typedef struct subnet_ipv4_t {
38         ipv4_t address;
39         int prefixlength;
40 } subnet_ipv4_t;
41
42 typedef struct subnet_ipv6_t {
43         ipv6_t address;
44         int prefixlength;
45 } subnet_ipv6_t;
46
47 #include "node.h"
48
49 typedef struct subnet_t {
50         struct node_t *owner;  /* the owner of this subnet */
51
52         subnet_type_t type;    /* subnet type (IPv4? IPv6? MAC? something even weirder?) */
53         time_t expires;        /* expiry time */
54         int weight;            /* weight (higher value is higher priority) */
55
56         /* And now for the actual subnet: */
57
58         union net {
59                 subnet_mac_t mac;
60                 subnet_ipv4_t ipv4;
61                 subnet_ipv6_t ipv6;
62         } net;
63 } subnet_t;
64
65 #define MAXNETSTR 64
66
67 extern avl_tree_t *subnet_tree;
68
69 extern int subnet_compare(const struct subnet_t *, const struct subnet_t *);
70 extern subnet_t *new_subnet(void) __attribute__((__malloc__));
71 extern void free_subnet(subnet_t *);
72 extern void init_subnets(void);
73 extern void exit_subnets(void);
74 extern avl_tree_t *new_subnet_tree(void) __attribute__((__malloc__));
75 extern void free_subnet_tree(avl_tree_t *);
76 extern void subnet_add(struct node_t *, subnet_t *);
77 extern void subnet_del(struct node_t *, subnet_t *);
78 extern void subnet_update(struct node_t *, subnet_t *, bool);
79 extern bool net2str(char *, int, const subnet_t *);
80 extern bool str2net(subnet_t *, const char *);
81 extern subnet_t *lookup_subnet(const struct node_t *, const subnet_t *);
82 extern subnet_t *lookup_subnet_mac(const struct node_t *, const mac_t *);
83 extern subnet_t *lookup_subnet_ipv4(const ipv4_t *);
84 extern subnet_t *lookup_subnet_ipv6(const ipv6_t *);
85 extern void dump_subnets(void);
86 extern void subnet_cache_flush(void);
87
88 #endif