78519770457be9a202133b838a64d9ddef799eee
[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_startup_handler(void);
23 static void gw_default_choosegw_handler(bool ipv4, bool ipv6);
24 static void gw_default_update_handler(struct gateway_entry *);
25 static void gw_default_delete_handler(struct gateway_entry *);
26
27 /**
28  * Callback list for the gateway (default) handler
29  */
30 static struct olsr_gw_handler gw_def_handler = {
31   &gw_default_startup_handler,
32   &gw_default_choosegw_handler,
33   &gw_default_update_handler,
34   &gw_default_delete_handler
35 };
36
37 /*
38  * Helper functions
39  */
40
41 /**
42  * Look through the gateway list and select the best gateway
43  * depending on the distance to this router
44  */
45 static void gw_default_choose_gateway(void) {
46   struct tc_entry *tc;
47   struct gateway_entry *inet_ipv4, *inet_ipv6;
48   olsr_linkcost cost_ipv4, cost_ipv6;
49   struct gateway_entry *gw;
50   bool dual;
51   olsr_linkcost path_cost_times_threshold;
52
53   cost_ipv4 = ROUTE_COST_BROKEN;
54   cost_ipv6 = ROUTE_COST_BROKEN;
55
56   inet_ipv4 = NULL;
57   inet_ipv6 = NULL;
58
59   OLSR_FOR_ALL_GATEWAY_ENTRIES(gw) {
60     /* gateways should not exist without tc entry */
61     if ((tc = olsr_lookup_tc_entry(&gw->originator)) == NULL) {
62       continue;
63     }
64
65     if (olsr_cnf->smart_gw_thresh == 0) {
66       path_cost_times_threshold = tc->path_cost;
67     } else {
68       path_cost_times_threshold = ((long long)tc->path_cost * (long long)olsr_cnf->smart_gw_thresh + 50LL) / 100LL;
69     }
70     if (!gw_def_finished_ipv4 && gw->ipv4 && gw->ipv4nat == olsr_cnf->smart_gw_allow_nat && path_cost_times_threshold < cost_ipv4) {
71       inet_ipv4 = gw;
72       cost_ipv4 = path_cost_times_threshold;
73     }
74     if (!gw_def_finished_ipv6 && gw->ipv6 && path_cost_times_threshold < cost_ipv6) {
75       inet_ipv6 = gw;
76       cost_ipv6 = path_cost_times_threshold;
77     }
78   } OLSR_FOR_ALL_GATEWAY_ENTRIES_END(gw)
79
80   /* found an IPv4 gateway ? */
81   gw_def_finished_ipv4 |= inet_ipv4 != NULL;
82   gw_def_finished_ipv6 |= inet_ipv6 != NULL;
83   dual = inet_ipv4 == inet_ipv6;
84   if (inet_ipv4) {
85     olsr_set_inet_gateway(&inet_ipv4->originator, true, dual, false);
86   }
87   if (inet_ipv6 && !dual) {
88     olsr_set_inet_gateway(&inet_ipv6->originator, false, true, false);
89   }
90
91   /* finished ? */
92   if ((olsr_cnf->smart_gw_thresh == 0) && gw_def_finished_ipv4 && gw_def_finished_ipv6) {
93     olsr_stop_timer(gw_def_timer);
94     gw_def_timer = NULL;
95   }
96 }
97
98 /**
99  * Timer callback for lazy gateway selection
100  *
101  * @param unused unused
102  */
103 static void gw_default_timer(void *unused __attribute__ ((unused))) {
104   /* accept a 10% increase/decrease in the number of gateway nodes without triggering a stablecount reset */
105   if (((tc_tree.count * 10) <= (gw_def_nodecount * 11)) ||
106       ((tc_tree.count * 10) >= (gw_def_nodecount *  9))) {
107     gw_def_nodecount = tc_tree.count;
108   }
109
110   if (tc_tree.count == gw_def_nodecount) {
111     /* the number of gateway nodes is 'stable' */
112     gw_def_stablecount++;
113   }
114   else {
115     /* there was a significant change in the number of gateway nodes */
116     gw_def_nodecount = tc_tree.count;
117     gw_def_stablecount = 0;
118   }
119
120   if (gw_def_stablecount >= olsr_cnf->smart_gw_stablecount) {
121     /* the number of gateway nodes is stable enough, so we should select a new gateway now */
122     gw_default_choose_gateway();
123   }
124 }
125
126 /**
127  * Lookup a new gateway based on distance metric
128  *
129  * @param ipv4 lookup new v4 gateway
130  * @param ipv6 lookup new v6 gateway
131  */
132 static void olsr_gw_default_lookup_gateway(bool ipv4, bool ipv6) {
133   if (ipv4) {
134     /* get new ipv4 GW if we use OLSRv4 or NIIT */
135     gw_def_finished_ipv4 = !(olsr_cnf->ip_version == AF_INET || olsr_cnf->use_niit);
136   }
137   if (ipv6) {
138     /* get new ipv6 GW if we use OLSRv6 */
139     gw_def_finished_ipv6 = !(olsr_cnf->ip_version == AF_INET6);
140   }
141
142   if (!(gw_def_finished_ipv4 && gw_def_finished_ipv6)) {
143     gw_default_choose_gateway();
144   }
145 }
146
147 /*
148  * Exported functions
149  */
150
151 /**
152  * initialization of default gateway handler
153  */
154 void olsr_gw_default_init(void) {
155   /* initialize values */
156   gw_def_nodecount = 0;
157   gw_def_stablecount = 0;
158   gw_def_finished_ipv4 = false;
159   gw_def_finished_ipv6 = false;
160   gw_def_timer = NULL;
161
162   /* setup default handler */
163   olsr_set_inetgw_handler(&gw_def_handler);
164 }
165
166 /*
167  * Handler functions
168  */
169
170 /* gateway handler callbacks */
171 static void gw_default_startup_handler(void) {
172   /* reset node count */
173   gw_def_nodecount = tc_tree.count;
174   gw_def_stablecount = 0;
175
176   /* get new ipv4 GW if we use OLSRv4 or NIIT */
177   gw_def_finished_ipv4 = !(olsr_cnf->ip_version == AF_INET || olsr_cnf->use_niit);
178
179   /* get new ipv6 GW if we use OLSRv6 */
180   gw_def_finished_ipv6 = !(olsr_cnf->ip_version == AF_INET6);
181
182   /* keep in mind we might be a gateway ourself */
183   gw_def_finished_ipv4 |= olsr_cnf->has_ipv4_gateway;
184   gw_def_finished_ipv6 |= olsr_cnf->has_ipv6_gateway;
185
186   /* start gateway selection timer */
187   olsr_set_timer(&gw_def_timer, olsr_cnf->smart_gw_period, 0, true, &gw_default_timer, NULL, 0);
188 }
189
190 static void gw_default_choosegw_handler(bool ipv4, bool ipv6) {
191   olsr_gw_default_lookup_gateway(ipv4, ipv6);
192
193   if (!(gw_def_finished_ipv4 && gw_def_finished_ipv6)) {
194     gw_default_startup_handler();
195   }
196 }
197
198 static void gw_default_update_handler(struct gateway_entry *gw) {
199   bool v4changed, v6changed;
200
201   v4changed = (gw == olsr_get_ipv4_inet_gateway(NULL))
202       && (!gw->ipv4 || (gw->ipv4nat && !olsr_cnf->smart_gw_allow_nat));
203   v6changed = (gw == olsr_get_ipv6_inet_gateway(NULL)) && !gw->ipv6;
204
205   if (v4changed || v6changed) {
206     olsr_gw_default_lookup_gateway(v4changed, v6changed);
207   }
208 }
209
210 static void gw_default_delete_handler(struct gateway_entry *gw) {
211   bool isv4, isv6;
212
213   isv4 = gw == olsr_get_ipv4_inet_gateway(NULL);
214   isv6 = gw == olsr_get_ipv6_inet_gateway(NULL);
215
216   if (gw != NULL && (isv4 || isv6)) {
217     olsr_gw_default_lookup_gateway(isv4, isv6);
218   }
219 }
220 #endif /* linux */