Rename olsr_time.[ch] to olsr_clock.[ch]
[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 /* prototype declaration to break loop with olsr_cnf.h */
56 struct interface;
57
58 #include "olsr_types.h"
59 #include "olsr_cfg_data.h"
60 #include "olsr_cfg.h"
61 #include "olsr_clock.h"
62 #include "common/list.h"
63 #include "common/avl.h"
64
65 #define _PATH_PROCNET_IFINET6           "/proc/net/if_inet6"
66
67
68 #define IPV6_ADDR_ANY           0x0000U
69
70 #define IPV6_ADDR_UNICAST       0x0001U
71 #define IPV6_ADDR_MULTICAST     0x0002U
72 #define IPV6_ADDR_ANYCAST       0x0004U
73
74 #define IPV6_ADDR_LOOPBACK      0x0010U
75 #define IPV6_ADDR_LINKLOCAL     0x0020U
76 #define IPV6_ADDR_SITELOCAL     0x0040U
77
78 #define IPV6_ADDR_COMPATv4      0x0080U
79
80 #define IPV6_ADDR_SCOPE_MASK    0x00f0U
81
82 #define IPV6_ADDR_MAPPED        0x1000U
83 #define IPV6_ADDR_RESERVED      0x2000U
84
85
86 #define MAX_IF_METRIC           100
87
88 #define WEIGHT_LOWEST           0       /* No weight            */
89 #define WEIGHT_LOW              1       /* Low                  */
90 #define WEIGHT_ETHERNET_1GBP    2       /* Ethernet 1Gb+        */
91 #define WEIGHT_ETHERNET_1GB     4       /* Ethernet 1Gb         */
92 #define WEIGHT_ETHERNET_100MB   8       /* Ethernet 100Mb       */
93 #define WEIGHT_ETHERNET_10MB    16      /* Ethernet 10Mb        */
94 #define WEIGHT_ETHERNET_DEFAULT 32      /* Ethernet unknown rate */
95 #define WEIGHT_WLAN_HIGH        64      /* >54Mb WLAN           */
96 #define WEIGHT_WLAN_54MB        128     /* 54Mb 802.11g         */
97 #define WEIGHT_WLAN_11MB        256     /* 11Mb 802.11b         */
98 #define WEIGHT_WLAN_LOW         512     /* <11Mb WLAN           */
99 #define WEIGHT_WLAN_DEFAULT     1024    /* WLAN unknown rate    */
100 #define WEIGHT_SERIAL           2048    /* Serial device        */
101 #define WEIGHT_HIGH             4096    /* High                 */
102 #define WEIGHT_HIGHEST          8192    /* Really high          */
103
104 #if 0
105 struct if_gen_property {
106   uint32_t owner_id;
107   void *data;
108   struct if_gen_property *next;
109 };
110 #endif
111
112 /*
113  * Output buffer structure. This should actually be in net_olsr.h
114  * but we have circular references then.
115  */
116 struct olsr_netbuf {
117   uint8_t *buff;                       /* Pointer to the allocated buffer */
118   int bufsize;                         /* Size of the buffer */
119   int maxsize;                         /* Max bytes of payload that can be added */
120   int pending;                         /* How much data is currently pending */
121   int reserved;                        /* Plugins can reserve space in buffers */
122 };
123
124 /**
125  * A struct containing all necessary information about each
126  * interface participating in the OLSRD routing
127  */
128 struct interface {
129   struct list_entity int_node;         /* List of all interfaces */
130
131   enum interface_mode mode;            /* mode of the interface, default is mesh */
132
133   /* sockaddr objects for src and (multicast) destination IP of interface */
134   union olsr_sockaddr int_src;
135   union olsr_sockaddr int_multicast;
136
137   /* source IP of interface */
138   union olsr_ip_addr ip_addr;
139
140   /* The broadcast socket for this interface */
141   struct olsr_socket_entry *olsr_socket;
142
143   /* The send socket for this interface */
144   struct olsr_socket_entry *send_socket;
145
146   /* interface data */
147   int int_mtu;                         /* MTU of interface */
148   int if_index;                        /* Kernels index of this interface */
149   char *int_name;                      /* from kernel if structure */
150
151   /* current packet sequence number for this interface */
152   uint16_t olsr_seqnum;
153
154   /* Periodic message generation timers */
155   struct olsr_timer_entry *hello_gen_timer;
156
157   /* Message build related  */
158   struct olsr_timer_entry *buffer_hold_timer;        /* Timer for message batching */
159   struct olsr_netbuf netbuf;           /* the build buffer */
160
161 #ifdef linux
162
163 /* Struct used to store original redirect/ingress setting */
164   struct nic_state {
165     char redirect;                     /* The original state of icmp redirect */
166     char spoof;                        /* The original state of spoof filter */
167   } nic_state;
168 #endif
169
170   uint32_t hello_interval;
171   uint32_t hello_validity;
172
173   uint32_t refcount;
174 };
175
176 /* deletion safe macro for interface list traversal */
177 #define OLSR_FOR_ALL_INTERFACES(interface, iterator) list_for_each_element_safe(&interface_head, interface, int_node, iterator)
178
179 struct interface_lost {
180   struct avl_node node;
181   union olsr_ip_addr ip;
182   uint32_t valid_until;
183 };
184
185 #define OLSR_FOR_ALL_LOSTIF_ENTRIES(lostif, iterator) avl_for_each_element_safe(&interface_lost_tree, lostif, node, iterator)
186
187 #define OLSR_BUFFER_HOLD_JITTER 25      /* percent */
188 #define OLSR_BUFFER_HOLD_TIME  100      /* milliseconds */
189
190 #define OLSR_DEFAULT_MTU      1500
191
192 /* Ifchange actions */
193
194 #define IFCHG_IF_ADD           1
195 #define IFCHG_IF_REMOVE        2
196 #define IFCHG_IF_UPDATE        3
197
198 /* The interface list head */
199 extern struct list_entity EXPORT(interface_head);
200
201 typedef int (*ifchg_cb_func) (struct interface *, int);
202
203
204 bool init_interfaces(void);
205 bool EXPORT(is_lost_interface_ip)(union olsr_ip_addr *ip);
206 void destroy_interfaces(void);
207 struct interface *add_interface(struct olsr_if_config *iface);
208 void remove_interface(struct interface *);
209 void run_ifchg_cbs(struct interface *, int);
210 struct interface *if_ifwithsock(int);
211 struct interface *EXPORT(if_ifwithaddr) (const union olsr_ip_addr *);
212 struct interface *if_ifwithname(const char *);
213 const char *if_ifwithindex_name(const int if_index);
214 struct interface *if_ifwithindex(const int if_index);
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 #endif
223
224 /*
225  * Local Variables:
226  * c-basic-offset: 2
227  * indent-tabs-mode: nil
228  * End:
229  */