5b30827c4be8c712a39b798599933686b523331b
[olsrd.git] / src / interfaces.h
1
2 /*
3  * The olsr.org Optimized Link-State Routing daemon(olsrd)
4  * Copyright (c) 2004-2009, the olsr.org team - see HISTORY file
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * * Redistributions of source code must retain the above copyright
12  *   notice, this list of conditions and the following disclaimer.
13  * * Redistributions in binary form must reproduce the above copyright
14  *   notice, this list of conditions and the following disclaimer in
15  *   the documentation and/or other materials provided with the
16  *   distribution.
17  * * Neither the name of olsr.org, olsrd nor the names of its
18  *   contributors may be used to endorse or promote products derived
19  *   from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32  * POSSIBILITY OF SUCH DAMAGE.
33  *
34  * Visit http://www.olsr.org for more information.
35  *
36  * If you find this software useful feel free to make a donation
37  * to the project. For more information see the website or contact
38  * the copyright holders.
39  *
40  */
41
42
43 #ifndef _OLSR_INTERFACE
44 #define _OLSR_INTERFACE
45
46 #include <sys/types.h>
47 #ifdef _MSC_VER
48 #include <WS2tcpip.h>
49 #undef interface
50 #else
51 #include <sys/socket.h>
52 #endif
53 #include <time.h>
54
55 #include "olsr_types.h"
56 #include "olsr_cfg_data.h"
57 #include "mantissa.h"
58 #include "common/list.h"
59 #include "common/avl.h"
60
61 #define _PATH_PROCNET_IFINET6           "/proc/net/if_inet6"
62
63
64 #define IPV6_ADDR_ANY           0x0000U
65
66 #define IPV6_ADDR_UNICAST       0x0001U
67 #define IPV6_ADDR_MULTICAST     0x0002U
68 #define IPV6_ADDR_ANYCAST       0x0004U
69
70 #define IPV6_ADDR_LOOPBACK      0x0010U
71 #define IPV6_ADDR_LINKLOCAL     0x0020U
72 #define IPV6_ADDR_SITELOCAL     0x0040U
73
74 #define IPV6_ADDR_COMPATv4      0x0080U
75
76 #define IPV6_ADDR_SCOPE_MASK    0x00f0U
77
78 #define IPV6_ADDR_MAPPED        0x1000U
79 #define IPV6_ADDR_RESERVED      0x2000U
80
81
82 #define MAX_IF_METRIC           100
83
84 #define WEIGHT_LOWEST           0       /* No weight            */
85 #define WEIGHT_LOW              1       /* Low                  */
86 #define WEIGHT_ETHERNET_1GBP    2       /* Ethernet 1Gb+        */
87 #define WEIGHT_ETHERNET_1GB     4       /* Ethernet 1Gb         */
88 #define WEIGHT_ETHERNET_100MB   8       /* Ethernet 100Mb       */
89 #define WEIGHT_ETHERNET_10MB    16      /* Ethernet 10Mb        */
90 #define WEIGHT_ETHERNET_DEFAULT 32      /* Ethernet unknown rate */
91 #define WEIGHT_WLAN_HIGH        64      /* >54Mb WLAN           */
92 #define WEIGHT_WLAN_54MB        128     /* 54Mb 802.11g         */
93 #define WEIGHT_WLAN_11MB        256     /* 11Mb 802.11b         */
94 #define WEIGHT_WLAN_LOW         512     /* <11Mb WLAN           */
95 #define WEIGHT_WLAN_DEFAULT     1024    /* WLAN unknown rate    */
96 #define WEIGHT_SERIAL           2048    /* Serial device        */
97 #define WEIGHT_HIGH             4096    /* High                 */
98 #define WEIGHT_HIGHEST          8192    /* Really high          */
99
100 #if 0
101 struct if_gen_property {
102   uint32_t owner_id;
103   void *data;
104   struct if_gen_property *next;
105 };
106 #endif
107
108 struct vtimes {
109   uint8_t hello;
110   uint8_t tc;
111   uint8_t mid;
112   uint8_t hna;
113 };
114
115 /*
116  * Output buffer structure. This should actually be in net_olsr.h
117  * but we have circular references then.
118  */
119 struct olsr_netbuf {
120   uint8_t *buff;                       /* Pointer to the allocated buffer */
121   int bufsize;                         /* Size of the buffer */
122   int maxsize;                         /* Max bytes of payload that can be added */
123   int pending;                         /* How much data is currently pending */
124   int reserved;                        /* Plugins can reserve space in buffers */
125 };
126
127 /**
128  * A struct containing all necessary information about each
129  * interface participating in the OLSRD routing
130  */
131 struct interface {
132   struct list_node int_node;           /* List of all interfaces */
133
134   enum interface_mode mode;            /* mode of the interface, default is mesh */
135
136   /* IP version 4 */
137   struct sockaddr_in int_addr;         /* address */
138   struct sockaddr_in int_netmask;      /* netmask */
139   struct sockaddr_in int_broadaddr;    /* broadcast address */
140   /* IP version 6 */
141   struct sockaddr_in6 int6_addr;       /* Address */
142   struct sockaddr_in6 int6_multaddr;   /* Multicast */
143   /* IP independent */
144   union olsr_ip_addr ip_addr;
145   int is_hcif;                         /* Is this a emulated host-client if? */
146   int olsr_socket;                     /* The broadcast socket for this interface */
147   int int_metric;                      /* metric of interface */
148   int int_mtu;                         /* MTU of interface */
149   int int_flags;                       /* see below */
150   int if_index;                        /* Kernels index of this interface */
151   int is_wireless;                     /* wireless interface or not */
152   char *int_name;                      /* from kernel if structure */
153   uint16_t olsr_seqnum;                /* Olsr message seqno */
154
155   /* Periodic message generation timers */
156   struct timer_entry *hello_gen_timer;
157   struct timer_entry *hna_gen_timer;
158   struct timer_entry *mid_gen_timer;
159   struct timer_entry *tc_gen_timer;
160
161   /* Message build related  */
162   struct timer_entry *buffer_hold_timer;        /* Timer for message batching */
163   struct olsr_netbuf netbuf;           /* the build buffer */
164   bool immediate_send_tc;              /* Hello's are sent immediately normally,
165                                           this flag prefers to send TC's */
166
167 #ifdef linux
168
169 /* Struct used to store original redirect/ingress setting */
170   struct nic_state {
171     char redirect;                     /* The original state of icmp redirect */
172     char spoof;                        /* The original state of spoof filter */
173   } nic_state;
174 #endif
175
176   olsr_reltime hello_etime;
177   struct vtimes valtimes;
178 #if 0
179   struct if_gen_property *gen_properties;       /* Generic interface properties */
180 #endif
181   int ttl_index;                       /* index in TTL array for fish-eye */
182
183   uint32_t refcount;                   /* Refcount */
184 };
185
186 LISTNODE2STRUCT(list2interface, struct interface, int_node);
187
188 /* deletion safe macro for interface list traversal */
189 #define OLSR_FOR_ALL_INTERFACES(interface) \
190 { \
191   struct list_node *_interface_node, *_next_interface_node; \
192   for (_interface_node = interface_head.next; \
193     _interface_node != &interface_head; \
194     _interface_node = _next_interface_node) { \
195     _next_interface_node = _interface_node->next; \
196     interface = list2interface(_interface_node);
197 #define OLSR_FOR_ALL_INTERFACES_END(interface) }}
198
199
200 struct interface_lost {
201   struct avl_node node;
202   union olsr_ip_addr ip;
203   uint32_t valid_until;
204 };
205
206 AVLNODE2STRUCT(node_tree2lostif, struct interface_lost, node);
207
208 #define OLSR_FOR_ALL_LOSTIF_ENTRIES(lostif) \
209 { \
210   struct avl_node *lostif_tree_node, *next_lostif_tree_node; \
211   for (lostif_tree_node = avl_walk_first(&interface_lost_tree); \
212     lostif_tree_node; lostif_tree_node = next_lostif_tree_node) { \
213     next_lostif_tree_node = avl_walk_next(lostif_tree_node); \
214     lostif = node_tree2lostif(lostif_tree_node);
215 #define OLSR_FOR_ALL_LOSTIF_ENTRIES_END(lostif) }}
216
217 #define OLSR_BUFFER_HOLD_JITTER 25      /* percent */
218 #define OLSR_BUFFER_HOLD_TIME 1000      /* milliseconds */
219
220 #define OLSR_DEFAULT_MTU             1500
221
222 /* Ifchange actions */
223
224 #define IFCHG_IF_ADD           1
225 #define IFCHG_IF_REMOVE        2
226 #define IFCHG_IF_UPDATE        3
227
228 /* The interface list head */
229 extern struct list_node EXPORT(interface_head);
230
231 typedef int (*ifchg_cb_func) (struct interface *, int);
232
233
234 bool ifinit(void);
235 bool EXPORT(is_lost_interface_ip)(union olsr_ip_addr *ip);
236 void remove_interface(struct interface **);
237 void run_ifchg_cbs(struct interface *, int);
238 struct interface *if_ifwithsock(int);
239 struct interface *EXPORT(if_ifwithaddr) (const union olsr_ip_addr *);
240 struct interface *if_ifwithname(const char *);
241 #if 0
242 const char *if_ifwithindex_name(const int if_index);
243 #endif
244 #if 0
245 struct interface *if_ifwithindex(const int if_index);
246 #endif
247 void EXPORT(add_ifchgf) (ifchg_cb_func f);
248 #if 0
249 int del_ifchgf(ifchg_cb_func f);
250 #endif
251 void lock_interface(struct interface *);
252 void unlock_interface(struct interface *);
253
254 extern struct olsr_cookie_info *interface_mem_cookie;
255 extern struct olsr_cookie_info *interface_poll_timer_cookie;    /* Maybe static */
256 extern struct olsr_cookie_info *hello_gen_timer_cookie;
257 extern struct olsr_cookie_info *tc_gen_timer_cookie;
258 extern struct olsr_cookie_info *mid_gen_timer_cookie;
259 extern struct olsr_cookie_info *hna_gen_timer_cookie;
260 extern struct olsr_cookie_info *buffer_hold_timer_cookie;
261
262 #endif
263
264 /*
265  * Local Variables:
266  * c-basic-offset: 2
267  * indent-tabs-mode: nil
268  * End:
269  */