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