plugin: dot_draw: readme: make it clear, that it only opens an IPv4-socket, so a...
[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 #ifndef _OLSR_INTERFACE
43 #define _OLSR_INTERFACE
44
45 #include <sys/types.h>
46 #ifdef _MSC_VER
47 #include <WS2tcpip.h>
48 #undef interface
49 #else /* _MSC_VER */
50 #include <sys/socket.h>
51 #endif /* _MSC_VER */
52 #include <time.h>
53
54 #include "olsr_types.h"
55 #include "mantissa.h"
56
57 #define IPV6_ADDR_ANY           0x0000U
58
59 #define IPV6_ADDR_UNICAST       0x0001U
60 #define IPV6_ADDR_MULTICAST     0x0002U
61 #define IPV6_ADDR_ANYCAST       0x0004U
62
63 #define IPV6_ADDR_LOOPBACK      0x0010U
64 #define IPV6_ADDR_LINKLOCAL     0x0020U
65 #define IPV6_ADDR_SITELOCAL     0x0040U
66
67 #define IPV6_ADDR_COMPATv4      0x0080U
68
69 #define IPV6_ADDR_SCOPE_MASK    0x00f0U
70
71 #define IPV6_ADDR_MAPPED        0x1000U
72 #define IPV6_ADDR_RESERVED      0x2000U
73
74 #define MAX_IF_METRIC           100
75
76 #define WEIGHT_LOWEST           0       /* No weight            */
77 #define WEIGHT_LOW              1       /* Low                  */
78 #define WEIGHT_ETHERNET_1GBP    2       /* Ethernet 1Gb+        */
79 #define WEIGHT_ETHERNET_1GB     4       /* Ethernet 1Gb         */
80 #define WEIGHT_ETHERNET_100MB   8       /* Ethernet 100Mb       */
81 #define WEIGHT_ETHERNET_10MB    16      /* Ethernet 10Mb        */
82 #define WEIGHT_ETHERNET_DEFAULT 32      /* Ethernet unknown rate */
83 #define WEIGHT_WLAN_HIGH        64      /* >54Mb WLAN           */
84 #define WEIGHT_WLAN_54MB        128     /* 54Mb 802.11g         */
85 #define WEIGHT_WLAN_11MB        256     /* 11Mb 802.11b         */
86 #define WEIGHT_WLAN_LOW         512     /* <11Mb WLAN           */
87 #define WEIGHT_WLAN_DEFAULT     1024    /* WLAN unknown rate    */
88 #define WEIGHT_SERIAL           2048    /* Serial device        */
89 #define WEIGHT_HIGH             4096    /* High                 */
90 #define WEIGHT_HIGHEST          8192    /* Really high          */
91
92 struct if_gen_property {
93   uint32_t owner_id;
94   void *data;
95   struct if_gen_property *next;
96 };
97
98 struct vtimes {
99   uint8_t hello;
100   uint8_t tc;
101   uint8_t mid;
102   uint8_t hna;
103 };
104
105 /* Output buffer structure. This should actually be in net_olsr.h but we have circular references then.
106  */
107 struct olsr_netbuf {
108   uint8_t *buff;                       /* Pointer to the allocated buffer */
109   int bufsize;                         /* Size of the buffer */
110   int maxsize;                         /* Max bytes of payload that can be added to the buffer */
111   int pending;                         /* How much data is currently pending in the buffer */
112   int reserved;                        /* Plugins can reserve space in buffers */
113 };
114
115 /**
116  *A struct containing all necessary information about each
117  *interface participating in the OLSRD routing
118  */
119 struct interface {
120   /* IP version 4 */
121   struct sockaddr_in int_addr;         /* address */
122   struct sockaddr_in int_netmask;      /* netmask */
123   struct sockaddr_in int_broadaddr;    /* broadcast address */
124   int mode;                            /* interface mode */
125   /* IP version 6 */
126   struct sockaddr_in6 int6_addr;       /* Address */
127   struct sockaddr_in6 int6_multaddr;   /* Multicast */
128   /* IP independent */
129   union olsr_ip_addr ip_addr;
130   int is_hcif;                         /* Is this a emulated host-client if? */
131
132   int olsr_socket;                     /* The broadcast socket for this interface */
133   int send_socket;                     /* The send socket for this interface */
134
135   int int_metric;                      /* metric of interface */
136   int int_mtu;                         /* MTU of interface */
137   int int_flags;                       /* see below */
138   int if_index;                        /* Kernels index of this interface */
139   int is_wireless;                     /* wireless interface or not */
140   char *int_name;                      /* from kernel if structure */
141   uint16_t olsr_seqnum;                /* Olsr message seqno */
142
143   /* Periodic message generation timers */
144   struct timer_entry *hello_gen_timer;
145   struct timer_entry *hna_gen_timer;
146   struct timer_entry *mid_gen_timer;
147   struct timer_entry *tc_gen_timer;
148
149 #ifdef __linux__
150
151 /* Struct used to store original redirect/ingress setting */
152   struct nic_state {
153     /* The original state of icmp redirect */
154     char redirect;
155
156     /* The original state of the IP spoof filter */
157     char spoof;
158   } nic_state;
159 #endif /* __linux__ */
160
161   olsr_reltime hello_etime;
162   struct vtimes valtimes;
163
164   /* Timeout for OLSR forwarding on this if */
165   uint32_t fwdtimer;
166
167   /* the buffer to construct the packet data */
168   struct olsr_netbuf netbuf;
169
170   /* Generic interface properties */
171   struct if_gen_property *gen_properties;
172
173   /* index in TTL array for fish-eye */
174   int ttl_index;
175
176   /* Hello's are sent immediately normally, this flag prefers to send TC's */
177   bool immediate_send_tc;
178
179   /* backpointer to olsr_if configuration */
180   struct olsr_if *olsr_if;
181   struct interface *int_next;
182 };
183
184 #define OLSR_DEFAULT_MTU             1500
185
186 /* Ifchange actions */
187
188 enum olsr_ifchg_flag {
189   IFCHG_IF_ADD = 1,
190   IFCHG_IF_REMOVE = 2,
191   IFCHG_IF_UPDATE = 3
192 };
193
194 /* The interface linked-list */
195 extern struct interface *ifnet;
196
197 int olsr_init_interfacedb(void);
198 void olsr_delete_interfaces(void);
199
200 void olsr_trigger_ifchange(int if_index, struct interface *, enum olsr_ifchg_flag);
201
202 struct interface *if_ifwithsock(int);
203
204 struct interface *if_ifwithaddr(const union olsr_ip_addr *);
205
206 struct interface *if_ifwithname(const char *);
207 struct olsr_if *olsrif_ifwithname(const char *if_name);
208
209 const char *if_ifwithindex_name(const int if_index);
210
211 struct interface *if_ifwithindex(const int if_index);
212
213 struct olsr_if *olsr_create_olsrif(const char *name, int hemu);
214
215 int olsr_add_ifchange_handler(void (*f) (int if_index, struct interface *, enum olsr_ifchg_flag));
216 int olsr_remove_ifchange_handler(void (*f) (int if_index, struct interface *, enum olsr_ifchg_flag));
217
218 void olsr_remove_interface(struct olsr_if *);
219
220 extern struct olsr_cookie_info *interface_poll_timer_cookie;
221 extern struct olsr_cookie_info *hello_gen_timer_cookie;
222 extern struct olsr_cookie_info *tc_gen_timer_cookie;
223 extern struct olsr_cookie_info *mid_gen_timer_cookie;
224 extern struct olsr_cookie_info *hna_gen_timer_cookie;
225
226 #endif /* _OLSR_INTERFACE */
227
228 /*
229  * Local Variables:
230  * c-basic-offset: 2
231  * indent-tabs-mode: nil
232  * End:
233  */