f63b82273a473586b2a62fff84d1600dccdaf3f8
[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 "olsr_time.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 /*
109  * Output buffer structure. This should actually be in net_olsr.h
110  * but we have circular references then.
111  */
112 struct olsr_netbuf {
113   uint8_t *buff;                       /* Pointer to the allocated buffer */
114   int bufsize;                         /* Size of the buffer */
115   int maxsize;                         /* Max bytes of payload that can be added */
116   int pending;                         /* How much data is currently pending */
117   int reserved;                        /* Plugins can reserve space in buffers */
118 };
119
120 /**
121  * A struct containing all necessary information about each
122  * interface participating in the OLSRD routing
123  */
124 struct interface {
125   struct list_entity int_node;         /* List of all interfaces */
126
127   enum interface_mode mode;            /* mode of the interface, default is mesh */
128
129   /* IP version 4 */
130   struct sockaddr_in int_addr;         /* address */
131   struct sockaddr_in int_netmask;      /* netmask */
132   struct sockaddr_in int_broadaddr;    /* broadcast address */
133   /* IP version 6 */
134   struct sockaddr_in6 int6_addr;       /* Address */
135   struct sockaddr_in6 int6_multaddr;   /* Multicast */
136   /* IP independent */
137   union olsr_ip_addr ip_addr;
138   int olsr_socket;                     /* The broadcast socket for this interface */
139   int send_socket;                     /* The send socket for this interface */
140   int int_metric;                      /* metric of interface */
141   int int_mtu;                         /* MTU of interface */
142   int int_flags;                       /* see below */
143   int if_index;                        /* Kernels index of this interface */
144   int is_wireless;                     /* wireless interface or not */
145   char *int_name;                      /* from kernel if structure */
146   uint16_t olsr_seqnum;                /* Olsr message seqno */
147
148   /* Periodic message generation timers */
149   struct timer_entry *hello_gen_timer;
150
151   /* Message build related  */
152   struct timer_entry *buffer_hold_timer;        /* Timer for message batching */
153   struct olsr_netbuf netbuf;           /* the build buffer */
154
155 #ifdef linux
156
157 /* Struct used to store original redirect/ingress setting */
158   struct nic_state {
159     char redirect;                     /* The original state of icmp redirect */
160     char spoof;                        /* The original state of spoof filter */
161   } nic_state;
162 #endif
163
164   uint32_t hello_interval;
165   uint32_t hello_validity;
166 #if 0
167   struct if_gen_property *gen_properties;       /* Generic interface properties */
168 #endif
169
170   uint32_t refcount;                   /* Refcount */
171 };
172
173 /* deletion safe macro for interface list traversal */
174 #define OLSR_FOR_ALL_INTERFACES(interface, iterator) list_for_each_element_safe(&interface_head, interface, int_node, iterator.loop, iterator.safe)
175
176 struct interface_lost {
177   struct avl_node node;
178   union olsr_ip_addr ip;
179   uint32_t valid_until;
180 };
181
182 #define OLSR_FOR_ALL_LOSTIF_ENTRIES(lostif, iterator) avl_for_each_element_safe(&interface_lost_tree, lostif, node, iterator.loop, iterator.safe)
183
184 #define OLSR_BUFFER_HOLD_JITTER 25      /* percent */
185 #define OLSR_BUFFER_HOLD_TIME  100      /* milliseconds */
186
187 #define OLSR_DEFAULT_MTU      1500
188
189 /* Ifchange actions */
190
191 #define IFCHG_IF_ADD           1
192 #define IFCHG_IF_REMOVE        2
193 #define IFCHG_IF_UPDATE        3
194
195 /* The interface list head */
196 extern struct list_entity EXPORT(interface_head);
197
198 typedef int (*ifchg_cb_func) (struct interface *, int);
199
200
201 bool init_interfaces(void);
202 bool EXPORT(is_lost_interface_ip)(union olsr_ip_addr *ip);
203 void destroy_interfaces(void);
204 void remove_interface(struct interface **);
205 void run_ifchg_cbs(struct interface *, int);
206 struct interface *if_ifwithsock(int);
207 struct interface *EXPORT(if_ifwithaddr) (const union olsr_ip_addr *);
208 struct interface *if_ifwithname(const char *);
209 #if 0
210 const char *if_ifwithindex_name(const int if_index);
211 #endif
212 #if 0
213 struct interface *if_ifwithindex(const int if_index);
214 #endif
215 void EXPORT(add_ifchgf) (ifchg_cb_func f);
216 #if 0
217 int del_ifchgf(ifchg_cb_func f);
218 #endif
219 void lock_interface(struct interface *);
220 void unlock_interface(struct interface *);
221
222 extern struct olsr_cookie_info *interface_mem_cookie;
223 extern struct olsr_cookie_info *interface_poll_timer_cookie;    /* Maybe static */
224 extern struct olsr_cookie_info *hello_gen_timer_cookie;
225 extern struct olsr_cookie_info *tc_gen_timer_cookie;
226 extern struct olsr_cookie_info *mid_gen_timer_cookie;
227 extern struct olsr_cookie_info *hna_gen_timer_cookie;
228 extern struct olsr_cookie_info *buffer_hold_timer_cookie;
229
230 #endif
231
232 /*
233  * Local Variables:
234  * c-basic-offset: 2
235  * indent-tabs-mode: nil
236  * End:
237  */