info: java: update workspace
[olsrd.git] / src / gateway.h
1 /*
2  * The olsr.org Optimized Link-State Routing daemon (olsrd)
3  *
4  * (c) by the OLSR project
5  *
6  * See our Git repository to find out who worked on this file
7  * and thus is a copyright holder on it.
8  *
9  * All rights reserved.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  *
15  * * Redistributions of source code must retain the above copyright
16  *   notice, this list of conditions and the following disclaimer.
17  * * Redistributions in binary form must reproduce the above copyright
18  *   notice, this list of conditions and the following disclaimer in
19  *   the documentation and/or other materials provided with the
20  *   distribution.
21  * * Neither the name of olsr.org, olsrd nor the names of its
22  *   contributors may be used to endorse or promote products derived
23  *   from this software without specific prior written permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
28  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
29  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
30  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
31  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
32  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
33  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
35  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36  * POSSIBILITY OF SUCH DAMAGE.
37  *
38  * Visit http://www.olsr.org for more information.
39  *
40  * If you find this software useful feel free to make a donation
41  * to the project. For more information see the website or contact
42  * the copyright holders.
43  *
44  */
45
46 #ifndef GATEWAY_H_
47 #define GATEWAY_H_
48
49 #include "common/avl.h"
50 #include "common/list.h"
51 #include "defs.h"
52 #include "olsr.h"
53 #include "scheduler.h"
54 #include "gateway_list.h"
55 #include <net/if.h>
56 #include <stdbool.h>
57
58 /** used to signal to olsr_delete_gateway_entry to force deletion */
59 #define FORCE_DELETE_GW_ENTRY 255
60
61 /** the interval (in milliseconds) on which to run gateway cleanup */
62 #define GW_CLEANUP_INTERVAL 30000
63
64 /**
65  * @return true if multi-gateway mode is enabled
66  */
67 static INLINE bool multi_gateway_mode(void) {
68   return (olsr_cnf->smart_gw_use_count > 1);
69 }
70
71 /*
72  * hack for Vienna network:
73  * set MAXIMUM_GATEWAY_PREFIX_LENGTH to 1 to remove 0.0.0.0/128.0.0.0 and
74  * 128.0.0.0/128.0.0.0 routes
75  */
76 // #define MAXIMUM_GATEWAY_PREFIX_LENGTH 1
77
78 /** gateway HNA flags */
79 enum gateway_hna_flags {
80   GW_HNA_FLAG_LINKSPEED   = 1u << 0,
81   GW_HNA_FLAG_IPV4        = 1u << 1,
82   GW_HNA_FLAG_IPV4_NAT    = 1u << 2,
83   GW_HNA_FLAG_IPV6        = 1u << 3,
84   GW_HNA_FLAG_IPV6PREFIX  = 1u << 4
85 };
86
87 /** gateway HNA field byte offsets in the netmask field of the HNA */
88 enum gateway_hna_fields {
89   GW_HNA_PAD              = 0,
90   GW_HNA_FLAGS            = 1,
91   GW_HNA_UPLINK           = 2,
92   GW_HNA_DOWNLINK         = 3,
93   GW_HNA_V6PREFIXLEN      = 4,
94   GW_HNA_V6PREFIX         = 5
95 };
96
97 /** a gateway entry */
98 struct gateway_entry {
99     struct avl_node node;
100     union olsr_ip_addr originator;
101     struct olsr_ip_prefix external_prefix;
102     uint32_t uplink;
103     uint32_t downlink;
104     int64_t path_cost; /**< the gateway path costs */
105     bool ipv4;
106     bool ipv4nat;
107     bool ipv6;
108
109     struct timer_entry *expire_timer;
110     struct timer_entry *cleanup_timer;
111     uint16_t seqno;
112 };
113
114 enum sgw_multi_change_phase {
115   GW_MULTI_CHANGE_PHASE_STARTUP = 0,
116   GW_MULTI_CHANGE_PHASE_RUNTIME = 1,
117   GW_MULTI_CHANGE_PHASE_SHUTDOWN = 2
118 };
119
120 #ifdef __linux__
121 /** structure that holds an interface name, mark and a pointer to the gateway that uses it */
122 struct interfaceName {
123   char name[IFNAMSIZ]; /**< interface name */
124   uint8_t tableNr; /**< routing table number */
125   uint8_t ruleNr; /**< IP rule number */
126   uint8_t bypassRuleNr; /**< bypass IP rule number */
127   struct gateway_entry *gw; /**< gateway that uses this interface name */
128 };
129 #endif /* __linux__ */
130
131 /**
132  * static INLINE struct gateway_entry * node2gateway (struct avl_node *ptr)
133  *
134  * Converts a node into a gateway entry
135  */
136 AVLNODE2STRUCT(node2gateway, struct gateway_entry, node);
137
138 /**
139  * Loop over all gateway entries and put the iterated gateway entry in gw
140  */
141 #define OLSR_FOR_ALL_GATEWAY_ENTRIES(gw) \
142 { \
143   struct avl_node *gw_node, *next_gw_node; \
144   for (gw_node = avl_walk_first(&gateway_tree); \
145     gw_node; gw_node = next_gw_node) { \
146     next_gw_node = avl_walk_next(gw_node); \
147     gw = node2gateway(gw_node); \
148     if (gw) {
149 #define OLSR_FOR_ALL_GATEWAY_ENTRIES_END(gw) }}}
150
151 /** the gateway tree */
152 extern struct avl_tree gateway_tree;
153
154 /** the list IPv4 gateways */
155 extern struct gw_list gw_list_ipv4;
156
157 /** the list IPv6 gateways */
158 extern struct gw_list gw_list_ipv6;
159
160 /**
161  * Function pointer table for gateway plugin hooks.
162  */
163 struct olsr_gw_handler {
164     /**
165      * Called on olsrd startup to initialise the plugin.
166      */
167     void (*init)(void);
168
169     /**
170      * Called on olsrd shutdown to cleanup the plugin.
171      */
172     void (*cleanup)(void);
173
174     /**
175      * Called on olsrd startup to perform the initial gateway selection.
176      */
177     void (*startup)(void);
178
179     /**
180      * Called when the costs of a gateway must be determined.
181      *
182      * @param gw the gateway
183      * @return the costs
184      */
185     int64_t (*getcosts)(struct gateway_entry *gw);
186
187     /**
188      * Called when a new gateway must be chosen.
189      *
190      * @param ipv4 true when an IPv4 gateway must be chosen
191      * @param ipv6 true when an IPv6 gateway must be chosen
192      */
193     void (*choose)(bool ipv4, bool ipv6);
194
195     /**
196      * Called when a gateway HNA is received.
197      *
198      * @param gw the gateway entry
199      */
200     void (*update)(struct gateway_entry * gw);
201
202     /**
203      * Called when a TC or a HNA is removed.
204      *
205      * @param gw the gateway entry
206      */
207     void (* delete)(struct gateway_entry * gw);
208 };
209
210 /*
211  * Main Interface
212  */
213
214 int olsr_init_gateways(void);
215 int olsr_startup_gateways(void);
216 void olsr_shutdown_gateways(void);
217 void olsr_cleanup_gateways(void);
218 void olsr_trigger_inetgw_startup(void);
219 #ifndef NODEBUG
220 void olsr_print_gateway_entries(void);
221 #else
222 #define olsr_print_gateway_entries() do { } while(0)
223 #endif
224
225 /*
226  * Tx Path Interface
227  */
228
229 void olsr_modifiy_inetgw_netmask(union olsr_ip_addr *mask, int prefixlen, bool zero);
230
231 /*
232  * Interface to adjust uplink/downlink speed
233  */
234
235 void refresh_smartgw_netmask(void);
236
237 /*
238  * TC/SPF/HNA Interface
239  */
240
241 bool olsr_is_smart_gateway(struct olsr_ip_prefix *prefix, union olsr_ip_addr *net);
242 void olsr_update_gateway_entry(union olsr_ip_addr *originator, union olsr_ip_addr *mask, int prefixlen, uint16_t seqno, olsr_reltime vtime);
243 void olsr_delete_gateway_entry(union olsr_ip_addr *originator, uint8_t prefixlen, bool immediate);
244 void olsr_trigger_gatewayloss_check(void);
245
246 /*
247  * Gateway Plugin Functions
248  */
249
250 bool olsr_set_inet_gateway(struct gateway_entry * chosen_gw, bool ipv4, bool ipv6);
251 struct gateway_entry *olsr_get_inet_gateway(bool ipv6);
252
253 /*
254  * Multi Smart Gateway functions
255  */
256
257 void doRoutesMultiGw(bool egressChanged, bool olsrChanged, enum sgw_multi_change_phase phase);
258 bool isEgressSelected(struct sgw_egress_if * egress_if);
259
260 #endif /* GATEWAY_H_ */