f9530fe6abaa198725a06815e38c1efe1b9104ef
[olsrd.git] / src / gateway_default_handler.c
1 /*
2  * gateway_default_handler.c
3  *
4  *  Created on: Jan 29, 2010
5  *      Author: rogge
6  */
7 #ifdef __linux__
8
9 #include "gateway_default_handler.h"
10
11 #include "defs.h"
12 #include "gateway.h"
13 #include "lq_plugin.h"
14
15 static uint32_t gw_def_nodecount;
16 static uint32_t gw_def_stablecount;
17 static bool gw_def_finished_ipv4;
18 static bool gw_def_finished_ipv6;
19 static struct timer_entry *gw_def_timer;
20
21 /* forward declarations */
22 static void gw_default_init(void);
23 static void gw_default_cleanup(void);
24 static void gw_default_startup_handler(void);
25 static uint64_t gw_default_getcosts(struct gateway_entry *gw);
26 static void gw_default_choosegw_handler(bool ipv4, bool ipv6);
27 static void gw_default_update_handler(struct gateway_entry *);
28 static void gw_default_delete_handler(struct gateway_entry *);
29
30 /**
31  * Callback list for the gateway (default) handler
32  */
33 struct olsr_gw_handler gw_def_handler = {
34     &gw_default_init,
35     &gw_default_cleanup,
36     &gw_default_startup_handler,
37     &gw_default_getcosts,
38     &gw_default_choosegw_handler,
39     &gw_default_update_handler,
40     &gw_default_delete_handler
41 };
42
43 /*
44  * Helper functions
45  */
46
47 /**
48  * Calculate the threshold path cost.
49  *
50  * @param path_cost the path cost
51  * @return the threshold path cost
52  */
53 static inline uint64_t gw_default_calc_threshold(uint64_t path_cost) {
54   if (olsr_cnf->smart_gw_thresh == 0) {
55     return path_cost;
56   }
57
58   return ((path_cost * (uint64_t) olsr_cnf->smart_gw_thresh) + (uint64_t) 50) / (uint64_t) 100;
59 }
60
61 /**
62  * Weigh the path costs and the gateway bandwidth.
63  *
64  * If the ETX divider is zero, then no weighing is performed and only the path
65  * costs are considered (classic behaviour).
66  *
67  * If either of the uplink or downlink bandwidths is zero, then UINT64_MAX is
68  * returned.
69  *
70  * @param path_cost the (ETX) path cost to the gateway
71  * @param exitUk the gateway exit link uplink bandwidth (in kbps)
72  * @param exitDk the gateway exit link downlink bandwidth (in kbps)
73  * @return the weighed path cost
74  */
75 static inline uint64_t gw_default_weigh_costs(uint64_t path_cost, uint32_t exitUk, uint32_t exitDk) {
76   uint8_t WexitU = olsr_cnf->smart_gw_weight_exitlink_up;
77   uint8_t WexitD = olsr_cnf->smart_gw_weight_exitlink_down;
78   uint8_t Wetx = olsr_cnf->smart_gw_weight_etx;
79   uint8_t Detx = olsr_cnf->smart_gw_divider_etx;
80   uint64_t costU;
81   uint64_t costD;
82   uint64_t costE;
83
84   if (!Detx) {
85     /* only consider path costs (classic behaviour) */
86     return path_cost;
87   }
88
89   if (!exitUk || !exitDk) {
90     /* zero bandwidth */
91     return UINT64_MAX;
92   }
93
94   /*
95    * Weighing of the path costs:
96    *
97    * exitUm = the gateway exit link uplink   bandwidth, in Mbps
98    * exitDm = the gateway exit link downlink bandwidth, in Mbps
99    * WexitU = the gateway exit link uplink   bandwidth weight   (configured)
100    * WexitD = the gateway exit link downlink bandwidth weight   (configured)
101    * Wetx   = the ETX path cost weight                          (configured)
102    * Detx   = the ETX path cost divider                         (configured)
103    *
104    *                      WexitU   WexitD   Wetx
105    * path_cost_weighed =  ------ + ------ + ---- * path_cost
106    *                      exitUm   exitDm   Detx
107    *
108    * Since the gateway exit link bandwidths are in Kbps, the following formula
109    * is used to convert them to the desired Mbps:
110    *
111    *       bwK
112    * bwM = ----       bwK = bandwidth in Kbps
113    *       1000       bwM = bandwidth in Mbps
114    *
115    * exitUk = the gateway exit link uplink   bandwidth, in Kbps
116    * exitDk = the gateway exit link downlink bandwidth, in Kbps
117    *
118    *                      1000 * WexitU   1000 * WexitD   Wetx
119    * path_cost_weighed =  ------------- + ------------- + ---- * path_cost
120    *                          exitUk          exitDk      Detx
121    *
122    *
123    * Analysis of the required bit width of the result:
124    *
125    * exitUk    = 29 bits = [1,   320,000,000]
126    * exitDk    = 29 bits = [1,   320,000,000]
127    * WexitU    =  8 bits = [1,           255]
128    * WexitD    =  8 bits = [1,           255]
129    * Wetx      =  8 bits = [1,           255]
130    * Detx      =  8 bits = [1,           255]
131    * path_cost = 32 bits = [1, 4,294,967,295]
132    *
133    *                          1000 * 255   1000 * 255   255
134    * path_cost_weighed(max) = ---------- + ---------- + --- * 4,294,967,295
135    *                               1             1       1
136    *
137    * path_cost_weighed(max) = 0x3E418    + 0x3E418    + 0xFEFFFFFF01
138    * path_cost_weighed(max) = 0xFF0007C731
139    *
140    * Because we can multiply 0xFF0007C731 by 2^24 without overflowing a
141    * 64 bits number, we do this to increase accuracy.
142    */
143
144   costU = (((uint64_t) (1000 * WexitU)) << 24) / exitUk;
145   costD = (((uint64_t) (1000 * WexitD)) << 24) / exitDk;
146   costE = (((uint64_t) (Wetx * path_cost)) << 24) / Detx;
147
148   return (costU + costD + costE);
149 }
150
151 /**
152  * Look through the gateway list and select the best gateway
153  * depending on the distance to this router
154  */
155 static void gw_default_choose_gateway(void) {
156   uint64_t cost_ipv4_threshold = UINT64_MAX;
157   uint64_t cost_ipv6_threshold = UINT64_MAX;
158   bool eval_cost_ipv4_threshold = false;
159   bool eval_cost_ipv6_threshold = false;
160   struct gateway_entry *inet_ipv4 = NULL;
161   struct gateway_entry *inet_ipv6 = NULL;
162   uint64_t cost_ipv4 = UINT64_MAX;
163   uint64_t cost_ipv6 = UINT64_MAX;
164   struct gateway_entry *gw;
165   bool dual;
166
167   if (olsr_cnf->smart_gw_thresh) {
168     /* determine the path cost thresholds */
169
170     uint64_t cost = gw_default_getcosts(olsr_get_inet_gateway(false));
171     if (cost != UINT64_MAX) {
172       cost_ipv4_threshold = gw_default_calc_threshold(cost);
173       eval_cost_ipv4_threshold = true;
174     }
175
176     cost = gw_default_getcosts(olsr_get_inet_gateway(true));
177     if (cost != UINT64_MAX) {
178       cost_ipv6_threshold = gw_default_calc_threshold(cost);
179       eval_cost_ipv6_threshold = true;
180     }
181   }
182
183   OLSR_FOR_ALL_GATEWAY_ENTRIES(gw) {
184     uint64_t path_cost = gw_default_getcosts(gw);
185
186     if (path_cost == UINT64_MAX) {
187       continue;
188     }
189
190     if (!gw_def_finished_ipv4) {
191       bool gw_eligible_v4 = gw->ipv4
192           /* && (olsr_cnf->ip_version == AF_INET || olsr_cnf->use_niit) */
193           && (olsr_cnf->smart_gw_allow_nat || !gw->ipv4nat);
194       if (gw_eligible_v4 && path_cost < cost_ipv4
195           && (!eval_cost_ipv4_threshold || (path_cost < cost_ipv4_threshold))) {
196         inet_ipv4 = gw;
197         cost_ipv4 = path_cost;
198       }
199     }
200
201     if (!gw_def_finished_ipv6) {
202       bool gw_eligible_v6 = gw->ipv6
203           /* && olsr_cnf->ip_version == AF_INET6 */;
204       if (gw_eligible_v6 && path_cost < cost_ipv6
205           && (!eval_cost_ipv6_threshold || (path_cost < cost_ipv6_threshold))) {
206         inet_ipv6 = gw;
207         cost_ipv6 = path_cost;
208       }
209     }
210   } OLSR_FOR_ALL_GATEWAY_ENTRIES_END(gw)
211
212   /* determine if we found an IPv4 and IPv6 gateway */
213   gw_def_finished_ipv4 |= (inet_ipv4 != NULL);
214   gw_def_finished_ipv6 |= (inet_ipv6 != NULL);
215
216   /* determine if we are dealing with a dual stack gateway */
217   dual = (inet_ipv4 == inet_ipv6) && (inet_ipv4 != NULL);
218
219   if (inet_ipv4) {
220     /* we are dealing with an IPv4 or dual stack gateway */
221     olsr_set_inet_gateway(&inet_ipv4->originator, cost_ipv4, true, dual);
222   }
223   if (inet_ipv6 && !dual) {
224     /* we are dealing with an IPv6-only gateway */
225     olsr_set_inet_gateway(&inet_ipv6->originator, cost_ipv6, false, true);
226   }
227
228   if ((olsr_cnf->smart_gw_thresh == 0) && gw_def_finished_ipv4 && gw_def_finished_ipv6) {
229     /* stop looking for a better gateway */
230     olsr_stop_timer(gw_def_timer);
231     gw_def_timer = NULL;
232   }
233 }
234
235 /**
236  * Timer callback for lazy gateway selection
237  *
238  * @param unused unused
239  */
240 static void gw_default_timer(void *unused __attribute__ ((unused))) {
241   /* accept a 10% increase/decrease in the number of gateway nodes without triggering a stablecount reset */
242   if (((tc_tree.count * 10) <= (gw_def_nodecount * 11)) || ((tc_tree.count * 10) >= (gw_def_nodecount * 9))) {
243     gw_def_nodecount = tc_tree.count;
244   }
245
246   if (tc_tree.count == gw_def_nodecount) {
247     /* the number of gateway nodes is 'stable' */
248     gw_def_stablecount++;
249   } else {
250     /* there was a significant change in the number of gateway nodes */
251     gw_def_nodecount = tc_tree.count;
252     gw_def_stablecount = 0;
253   }
254
255   if (gw_def_stablecount >= olsr_cnf->smart_gw_stablecount) {
256     /* the number of gateway nodes is stable enough, so we should select a new gateway now */
257     gw_default_choose_gateway();
258   }
259 }
260
261 /**
262  * Lookup a new gateway
263  *
264  * @param ipv4 lookup new v4 gateway
265  * @param ipv6 lookup new v6 gateway
266  */
267 static void gw_default_lookup_gateway(bool ipv4, bool ipv6) {
268   if (ipv4) {
269     /* get a new IPv4 gateway if we use OLSRv4 or NIIT */
270     gw_def_finished_ipv4 = !(olsr_cnf->ip_version == AF_INET || olsr_cnf->use_niit);
271   }
272   if (ipv6) {
273     /* get a new IPv6 gateway if we use OLSRv6 */
274     gw_def_finished_ipv6 = !(olsr_cnf->ip_version == AF_INET6);
275   }
276
277   if (!(gw_def_finished_ipv4 && gw_def_finished_ipv6)) {
278     gw_default_choose_gateway();
279   }
280 }
281
282 /*
283  * Exported functions
284  */
285
286 /*
287  * Handler functions
288  */
289
290 /**
291  * initialization of default gateway handler
292  */
293 static void gw_default_init(void) {
294   /* initialize values */
295   gw_def_nodecount = 0;
296   gw_def_stablecount = 0;
297   gw_def_finished_ipv4 = false;
298   gw_def_finished_ipv6 = false;
299   gw_def_timer = NULL;
300 }
301
302 /**
303  * Cleanup default gateway handler
304  */
305 static void gw_default_cleanup(void) {
306 }
307
308 /**
309  * Handle gateway startup
310  */
311 static void gw_default_startup_handler(void) {
312   /* reset node count */
313   gw_def_nodecount = tc_tree.count;
314   gw_def_stablecount = 0;
315
316   /* get a new IPv4 gateway if we use OLSRv4 or NIIT */
317   gw_def_finished_ipv4 = !(olsr_cnf->ip_version == AF_INET || olsr_cnf->use_niit);
318
319   /* get a new IPv6 gateway if we use OLSRv6 */
320   gw_def_finished_ipv6 = !(olsr_cnf->ip_version == AF_INET6);
321
322   /* keep in mind we might be a gateway ourself */
323   gw_def_finished_ipv4 |= olsr_cnf->has_ipv4_gateway;
324   gw_def_finished_ipv6 |= olsr_cnf->has_ipv6_gateway;
325
326   /* (re)start gateway lazy selection timer */
327   olsr_set_timer(&gw_def_timer, olsr_cnf->smart_gw_period, 0, true, &gw_default_timer, NULL, 0);
328 }
329
330 /**
331  * Called when the costs of a gateway must be determined.
332  *
333  * @param gw the gateway
334  * @return the costs, or UINT64_MAX in case the gateway has inifinite costs
335  */
336 static uint64_t gw_default_getcosts(struct gateway_entry *gw) {
337   struct tc_entry* tc;
338
339   if (!gw) {
340     return UINT64_MAX;
341   }
342
343   tc = olsr_lookup_tc_entry(&gw->originator);
344
345   if (!tc || (tc->path_cost == ROUTE_COST_BROKEN) || (!gw->uplink || !gw->downlink)) {
346     /* gateways should not exist without tc entry */
347     /* do not consider nodes with an infinite ETX */
348     /* do not consider nodes without bandwidth or with a uni-directional link */
349     return UINT64_MAX;
350   }
351
352   /* determine the path cost */
353   return gw_default_weigh_costs(tc->path_cost, gw->uplink, gw->downlink);
354 }
355
356 /**
357  * Choose a new gateway
358  *
359  * @param ipv4 lookup new v4 gateway
360  * @param ipv6 lookup new v6 gateway
361  */
362 static void gw_default_choosegw_handler(bool ipv4, bool ipv6) {
363   gw_default_lookup_gateway(ipv4, ipv6);
364
365   if (!(gw_def_finished_ipv4 && gw_def_finished_ipv6)) {
366     gw_default_startup_handler();
367   }
368 }
369
370 /**
371  * Update a gateway entry
372  *
373  * @param gw the gateway entry
374  */
375 static void gw_default_update_handler(struct gateway_entry *gw) {
376   bool v4changed = gw && (gw == olsr_get_inet_gateway(false))
377       && (!gw->ipv4 || (gw->ipv4nat && !olsr_cnf->smart_gw_allow_nat));
378   bool v6changed = gw && (gw == olsr_get_inet_gateway(true)) && !gw->ipv6;
379
380   if (v4changed || v6changed) {
381     gw_default_lookup_gateway(v4changed, v6changed);
382   }
383 }
384
385 /**
386  * Remove a gateway entry
387  *
388  * @param gw the gateway entry
389  */
390 static void gw_default_delete_handler(struct gateway_entry *gw) {
391   bool isv4 = gw && (gw == olsr_get_inet_gateway(false));
392   bool isv6 = gw && (gw == olsr_get_inet_gateway(true));
393
394   if (isv4 || isv6) {
395     gw_default_lookup_gateway(isv4, isv6);
396   }
397 }
398 #endif /* __linux__ */