aa8aa722293f97d56b387bda8b3651d54a3475f9
[olsrd.git] / src / interfaces.h
1
2 /*
3  * The olsr.org Optimized Link-State Routing daemon(olsrd)
4  * Copyright (c) 2004, Andreas Tonnesen(andreto@olsr.org)
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 "mantissa.h"
57 #include "common/list.h"
58
59 #define _PATH_PROCNET_IFINET6           "/proc/net/if_inet6"
60
61
62 #define IPV6_ADDR_ANY           0x0000U
63
64 #define IPV6_ADDR_UNICAST       0x0001U
65 #define IPV6_ADDR_MULTICAST     0x0002U
66 #define IPV6_ADDR_ANYCAST       0x0004U
67
68 #define IPV6_ADDR_LOOPBACK      0x0010U
69 #define IPV6_ADDR_LINKLOCAL     0x0020U
70 #define IPV6_ADDR_SITELOCAL     0x0040U
71
72 #define IPV6_ADDR_COMPATv4      0x0080U
73
74 #define IPV6_ADDR_SCOPE_MASK    0x00f0U
75
76 #define IPV6_ADDR_MAPPED        0x1000U
77 #define IPV6_ADDR_RESERVED      0x2000U
78
79
80 #define MAX_IF_METRIC           100
81
82 #define WEIGHT_LOWEST           0       /* No weight            */
83 #define WEIGHT_LOW              1       /* Low                  */
84 #define WEIGHT_ETHERNET_1GBP    2       /* Ethernet 1Gb+        */
85 #define WEIGHT_ETHERNET_1GB     4       /* Ethernet 1Gb         */
86 #define WEIGHT_ETHERNET_100MB   8       /* Ethernet 100Mb       */
87 #define WEIGHT_ETHERNET_10MB    16      /* Ethernet 10Mb        */
88 #define WEIGHT_ETHERNET_DEFAULT 32      /* Ethernet unknown rate */
89 #define WEIGHT_WLAN_HIGH        64      /* >54Mb WLAN           */
90 #define WEIGHT_WLAN_54MB        128     /* 54Mb 802.11g         */
91 #define WEIGHT_WLAN_11MB        256     /* 11Mb 802.11b         */
92 #define WEIGHT_WLAN_LOW         512     /* <11Mb WLAN           */
93 #define WEIGHT_WLAN_DEFAULT     1024    /* WLAN unknown rate    */
94 #define WEIGHT_SERIAL           2048    /* Serial device        */
95 #define WEIGHT_HIGH             4096    /* High                 */
96 #define WEIGHT_HIGHEST          8192    /* Really high          */
97
98 #if 0
99 struct if_gen_property {
100   uint32_t owner_id;
101   void *data;
102   struct if_gen_property *next;
103 };
104 #endif
105
106 struct vtimes {
107   uint8_t hello;
108   uint8_t tc;
109   uint8_t mid;
110   uint8_t hna;
111 };
112
113 /*
114  * Output buffer structure. This should actually be in net_olsr.h
115  * but we have circular references then.
116  */
117 struct olsr_netbuf {
118   uint8_t *buff;                       /* Pointer to the allocated buffer */
119   int bufsize;                         /* Size of the buffer */
120   int maxsize;                         /* Max bytes of payload that can be added */
121   int pending;                         /* How much data is currently pending */
122   int reserved;                        /* Plugins can reserve space in buffers */
123 };
124
125 /**
126  * A struct containing all necessary information about each
127  * interface participating in the OLSRD routing
128  */
129 struct interface {
130   struct list_node int_node;           /* List of all interfaces */
131
132   /* IP version 4 */
133   struct sockaddr_in int_addr;         /* address */
134   struct sockaddr_in int_netmask;      /* netmask */
135   struct sockaddr_in int_broadaddr;    /* broadcast address */
136   /* IP version 6 */
137   struct sockaddr_in6 int6_addr;       /* Address */
138   struct sockaddr_in6 int6_multaddr;   /* Multicast */
139   /* IP independent */
140   union olsr_ip_addr ip_addr;
141   int is_hcif;                         /* Is this a emulated host-client if? */
142   int olsr_socket;                     /* The broadcast socket for this interface */
143   int int_metric;                      /* metric of interface */
144   int int_mtu;                         /* MTU of interface */
145   int int_flags;                       /* see below */
146   int if_index;                        /* Kernels index of this interface */
147   int is_wireless;                     /* wireless interface or not */
148   char *int_name;                      /* from kernel if structure */
149   uint16_t olsr_seqnum;        /* Olsr message seqno */
150
151   /* Periodic message generation timers */
152   struct timer_entry *hello_gen_timer;
153   struct timer_entry *hna_gen_timer;
154   struct timer_entry *mid_gen_timer;
155   struct timer_entry *tc_gen_timer;
156
157   /* Message build related  */
158   struct timer_entry *buffer_hold_timer; /* Timer for message batching */
159   struct olsr_netbuf netbuf;           /* the build buffer */
160   bool immediate_send_tc;              /* Hello's are sent immediately normally,
161                                           this flag prefers to send TC's */
162
163 #ifdef linux
164 /* Struct used to store original redirect/ingress setting */
165   struct nic_state {
166     char redirect;                     /* The original state of icmp redirect */
167     char spoof;                        /* The original state of spoof filter */
168   } nic_state;
169 #endif
170
171   olsr_reltime hello_etime;
172   struct vtimes valtimes;
173 #if 0
174   struct if_gen_property *gen_properties; /* Generic interface properties */
175 #endif
176   int ttl_index;                       /* index in TTL array for fish-eye */
177
178   uint32_t refcount;                    /* Refcount */
179 };
180
181 LISTNODE2STRUCT(list2interface, struct interface, int_node);
182
183 /* deletion safe macro for interface list traversal */
184 #define OLSR_FOR_ALL_INTERFACES(interface) \
185 { \
186   struct list_node *_interface_node, *_next_interface_node; \
187   for (_interface_node = interface_head.next; \
188     _interface_node != &interface_head; \
189     _interface_node = _next_interface_node) { \
190     _next_interface_node = _interface_node->next; \
191     interface = list2interface(_interface_node);
192 #define OLSR_FOR_ALL_INTERFACES_END(interface) }}
193
194
195 #define OLSR_BUFFER_HOLD_JITTER 25      /* percent */
196 #define OLSR_BUFFER_HOLD_TIME 1000      /* milliseconds */
197
198 #define OLSR_DEFAULT_MTU             1500
199
200 /* Ifchange actions */
201
202 #define IFCHG_IF_ADD           1
203 #define IFCHG_IF_REMOVE        2
204 #define IFCHG_IF_UPDATE        3
205
206 /* The interface list head */
207 extern struct list_node interface_head;
208
209 typedef int (*ifchg_cb_func)(struct interface *, int);
210
211
212 bool ifinit(void);
213 void run_ifchg_cbs(struct interface *, int);
214 struct interface *if_ifwithsock(int);
215 struct interface *EXPORT(if_ifwithaddr)(const union olsr_ip_addr *);
216 struct interface *if_ifwithname(const char *);
217 #if 0
218 const char *if_ifwithindex_name(const int if_index);
219 #endif
220 #if 0
221 struct interface *if_ifwithindex(const int if_index);
222 #endif
223 struct olsr_if *queue_if(const char *, int);
224 void EXPORT(add_ifchgf)(ifchg_cb_func f);
225 #if 0
226 int del_ifchgf(ifchg_cb_func f);
227 #endif
228 void lock_interface(struct interface *);
229 void unlock_interface(struct interface *);
230
231 extern struct olsr_cookie_info *interface_mem_cookie;
232 extern struct olsr_cookie_info *interface_poll_timer_cookie; /* Maybe static */
233 extern struct olsr_cookie_info *hello_gen_timer_cookie;
234 extern struct olsr_cookie_info *tc_gen_timer_cookie;
235 extern struct olsr_cookie_info *mid_gen_timer_cookie;
236 extern struct olsr_cookie_info *hna_gen_timer_cookie;
237 extern struct olsr_cookie_info *buffer_hold_timer_cookie;
238
239 #endif
240
241 /*
242  * Local Variables:
243  * c-basic-offset: 2
244  * indent-tabs-mode: nil
245  * End:
246  */