Bugfix for etx_ff
[olsrd.git] / lib / lq_etx_ff / src / lq_plugin_etx_ff.c
1 /*
2  * The olsr.org Optimized Link-State Routing daemon(olsrd)
3  * Copyright (c) 2004-2009, the olsr.org team - see HISTORY file
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  *
10  * * Redistributions of source code must retain the above copyright
11  *   notice, this list of conditions and the following disclaimer.
12  * * Redistributions in binary form must reproduce the above copyright
13  *   notice, this list of conditions and the following disclaimer in
14  *   the documentation and/or other materials provided with the
15  *   distribution.
16  * * Neither the name of olsr.org, olsrd nor the names of its
17  *   contributors may be used to endorse or promote products derived
18  *   from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
24  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
26  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
27  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
28  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
30  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31  * POSSIBILITY OF SUCH DAMAGE.
32  *
33  * Visit http://www.olsr.org for more information.
34  *
35  * If you find this software useful feel free to make a donation
36  * to the project. For more information see the website or contact
37  * the copyright holders.
38  *
39  */
40
41 #include "tc_set.h"
42 #include "link_set.h"
43 #include "lq_plugin.h"
44 #include "olsr_spf.h"
45 #include "lq_packet.h"
46 #include "olsr.h"
47 #include "lq_plugin_etx_ff.h"
48 #include "parser.h"
49 #include "mid_set.h"
50 #include "scheduler.h"
51 #include "olsr_logging.h"
52
53 #define LQ_PLUGIN_RELEVANT_COSTCHANGE_FF 16
54
55 static void lq_etxff_initialize(void);
56 static void lq_etxff_deinitialize(void);
57
58 static olsr_linkcost lq_etxff_calc_link_entry_cost(struct link_entry *);
59 static olsr_linkcost lq_etxff_calc_lq_hello_neighbor_cost(
60     struct lq_hello_neighbor *);
61 static olsr_linkcost lq_etxff_calc_tc_mpr_addr_cost(struct tc_mpr_addr *);
62 static olsr_linkcost lq_etxff_calc_tc_edge_entry_cost(struct tc_edge_entry *);
63
64 static bool lq_etxff_is_relevant_costchange(olsr_linkcost c1, olsr_linkcost c2);
65
66 static olsr_linkcost lq_etxff_packet_loss_handler(struct link_entry *, bool);
67
68 static void lq_etxff_memorize_foreign_hello(struct link_entry *,
69     struct lq_hello_neighbor *);
70 static void lq_etxff_copy_link_entry_lq_into_tc_mpr_addr(
71     struct tc_mpr_addr *target, struct link_entry *source);
72 static void lq_etxff_copy_link_entry_lq_into_tc_edge_entry(
73     struct tc_edge_entry *target, struct link_entry *source);
74 static void lq_etxff_copy_link_lq_into_neighbor(struct lq_hello_neighbor *target,
75     struct link_entry *source);
76
77 static void lq_etxff_clear_link_entry(struct link_entry *);
78
79 static int lq_etxff_serialize_hello_lq(unsigned char *buff,
80     struct lq_hello_neighbor *lq);
81 static int lq_etxff_serialize_tc_lq(unsigned char *buff, struct tc_mpr_addr *lq);
82 static void lq_etxff_deserialize_hello_lq(uint8_t const ** curr,
83     struct lq_hello_neighbor *lq);
84 static void lq_etxff_deserialize_tc_lq(uint8_t const ** curr,
85     struct tc_edge_entry *lq);
86
87 static char *lq_etxff_print_link_entry_lq(struct link_entry *entry, char separator,
88     struct lqtextbuffer *buffer);
89 static char *lq_etxff_print_tc_edge_entry_lq(struct tc_edge_entry *ptr,
90     char separator, struct lqtextbuffer * buffer);
91 static char *lq_etxff_print_cost(olsr_linkcost cost, struct lqtextbuffer * buffer);
92
93 static struct olsr_cookie_info *default_lq_ff_timer_cookie = NULL;
94
95 /* etx lq plugin (freifunk fpm version) settings */
96 struct lq_handler lq_etxff_handler = {
97   &lq_etxff_initialize,
98   &lq_etxff_deinitialize,
99
100   &lq_etxff_calc_link_entry_cost,
101   &lq_etxff_calc_lq_hello_neighbor_cost,
102   &lq_etxff_calc_tc_mpr_addr_cost,
103   &lq_etxff_calc_tc_edge_entry_cost,
104
105   &lq_etxff_is_relevant_costchange,
106
107   &lq_etxff_packet_loss_handler,
108
109   &lq_etxff_memorize_foreign_hello,
110   &lq_etxff_copy_link_entry_lq_into_tc_mpr_addr,
111   &lq_etxff_copy_link_entry_lq_into_tc_edge_entry,
112   &lq_etxff_copy_link_lq_into_neighbor,
113
114   &lq_etxff_clear_link_entry,
115   NULL,
116   NULL,
117   NULL,
118
119   &lq_etxff_serialize_hello_lq,
120   &lq_etxff_serialize_tc_lq,
121   &lq_etxff_deserialize_hello_lq,
122   &lq_etxff_deserialize_tc_lq,
123
124   &lq_etxff_print_link_entry_lq,
125   &lq_etxff_print_tc_edge_entry_lq,
126   &lq_etxff_print_cost,
127
128   sizeof(struct lq_etxff_tc_edge),
129   sizeof(struct lq_etxff_tc_mpr_addr),
130   sizeof(struct lq_etxff_lq_hello_neighbor),
131   sizeof(struct lq_etxff_link_entry),
132
133   LQ_HELLO_MESSAGE,
134   LQ_TC_MESSAGE
135 };
136
137 static void lq_etxff_packet_parser(struct olsr *olsr, struct interface *in_if,
138     union olsr_ip_addr *from_addr) {
139   const union olsr_ip_addr *main_addr;
140   struct lq_etxff_link_entry *lnk;
141   uint32_t seq_diff;
142
143   /* Find main address */
144   main_addr = olsr_lookup_main_addr_by_alias(from_addr);
145
146   /* Loopup link entry */
147   lnk = (struct lq_etxff_link_entry *) lookup_link_entry(from_addr, main_addr,
148       in_if);
149   if (lnk == NULL) {
150     return;
151   }
152
153   if (lnk->last_seq_nr > olsr->olsr_seqno) {
154     seq_diff = (uint32_t) olsr->olsr_seqno + 65536 - lnk->last_seq_nr;
155   } else {
156     seq_diff = olsr->olsr_seqno - lnk->last_seq_nr;
157   }
158
159   /* Jump in sequence numbers ? */
160   if (seq_diff > 256) {
161     seq_diff = 1;
162   }
163
164   lnk->received[lnk->activePtr]++;
165   lnk->lost[lnk->activePtr] += (seq_diff - 1);
166
167   lnk->last_seq_nr = olsr->olsr_seqno;
168   lnk->missed_seconds = 0;
169 }
170
171 static void lq_etxff_timer(void __attribute__((unused)) *context) {
172   struct link_entry *link;
173   OLSR_FOR_ALL_LINK_ENTRIES(link)
174   {
175     struct lq_etxff_link_entry *lq_link;
176     uint32_t ratio;
177     uint16_t i, received, lost;
178
179 #ifndef REMOVE_LOG_DEBUG
180     struct ipaddr_str buf;
181     // struct lqtextbuffer lqbuffer;
182 #endif
183     lq_link = (struct lq_etxff_link_entry *)link;
184
185     OLSR_DEBUG(LOG_LQ_PLUGINS, "LQ-FF new entry for %s: rec: %d lost: %d",
186       olsr_ip_to_string(&buf, &link->neighbor_iface_addr),
187       lq_link->received[lq_link->activePtr], lq_link->lost[lq_link->activePtr]);
188
189     received = 0;
190     lost = 0;
191
192     /* enlarge window if still in quickstart phase */
193     if (lq_link->windowSize < LQ_FF_WINDOW) {
194       lq_link->windowSize++;
195     }
196     for (i=0; i < lq_link->windowSize; i++) {
197       received += lq_link->received[i];
198       lost += lq_link->lost[i];
199     }
200
201     OLSR_DEBUG(LOG_LQ_PLUGINS, " total-rec: %d total-lost: %d", received, lost);
202
203     /* calculate link quality */
204     if (received + lost == 0) {
205       lq_link->lq.valueLq = 0;
206     }
207     else {
208
209       /* keep missed hello periods in mind (round up hello interval to seconds) */
210       uint32_t missed_hello_cost = lq_link->missed_seconds / ((lq_link->core.link_loss_timer->timer_period + 999) / 1000);
211       lost += missed_hello_cost * missed_hello_cost;
212
213       // start with link-loss-factor
214       ratio = link->loss_link_multiplier;
215
216       // calculate received/(received + loss) factor
217       ratio = ratio * received;
218       ratio = ratio / (received + lost);
219       ratio = (ratio * 255) >> 16;
220
221       lq_link->lq.valueLq = (uint8_t)(ratio);
222     }
223
224     // shift buffer
225     lq_link->activePtr = (lq_link->activePtr + 1) % LQ_FF_WINDOW;
226     lq_link->lost[lq_link->activePtr] = 0;
227     lq_link->received[lq_link->activePtr] = 0;
228     lq_link->missed_seconds++;
229   }OLSR_FOR_ALL_LINK_ENTRIES_END(link);
230 }
231
232 static struct timer_entry *lq_etxff_timer_struct = NULL;
233
234 static void lq_etxff_initialize(void) {
235   /* Some cookies for stats keeping */
236   olsr_packetparser_add_function(&lq_etxff_packet_parser);
237   default_lq_ff_timer_cookie = olsr_alloc_cookie("Default Freifunk LQ",
238       OLSR_COOKIE_TYPE_TIMER);
239   lq_etxff_timer_struct = olsr_start_timer(1000, 0, OLSR_TIMER_PERIODIC,
240       &lq_etxff_timer, NULL, default_lq_ff_timer_cookie->ci_id);
241 }
242
243 static void lq_etxff_deinitialize(void) {
244   olsr_stop_timer(lq_etxff_timer_struct);
245   olsr_packetparser_remove_function(&lq_etxff_packet_parser);
246 }
247
248 static olsr_linkcost lq_etxff_calc_linkcost(struct lq_etxff_linkquality *lq) {
249   olsr_linkcost cost;
250
251   if (lq->valueLq < (unsigned int) (255 * MINIMAL_USEFUL_LQ) || lq->valueNlq
252       < (unsigned int) (255 * MINIMAL_USEFUL_LQ)) {
253     return LINK_COST_BROKEN;
254   }
255
256   cost = 65536 * 255/(int)lq->valueLq * 255/(int)lq->valueNlq;
257
258   if (cost > LINK_COST_BROKEN)
259     return LINK_COST_BROKEN;
260   if (cost == 0)
261     return 1;
262   return cost;
263 }
264
265 static olsr_linkcost lq_etxff_calc_link_entry_cost(struct link_entry *link) {
266   struct lq_etxff_link_entry *lq_link = (struct lq_etxff_link_entry *) link;
267
268   return lq_etxff_calc_linkcost(&lq_link->lq);
269 }
270
271 static olsr_linkcost lq_etxff_calc_lq_hello_neighbor_cost(
272     struct lq_hello_neighbor *neigh) {
273   struct lq_etxff_lq_hello_neighbor *lq_neigh =
274       (struct lq_etxff_lq_hello_neighbor *) neigh;
275
276   return lq_etxff_calc_linkcost(&lq_neigh->lq);
277 }
278
279 static olsr_linkcost lq_etxff_calc_tc_mpr_addr_cost(struct tc_mpr_addr *mpr) {
280   struct lq_etxff_tc_mpr_addr *lq_mpr = (struct lq_etxff_tc_mpr_addr *) mpr;
281
282   return lq_etxff_calc_linkcost(&lq_mpr->lq);
283 }
284
285 static olsr_linkcost lq_etxff_calc_tc_edge_entry_cost(struct tc_edge_entry *edge) {
286   struct lq_etxff_tc_edge *lq_edge = (struct lq_etxff_tc_edge *) edge;
287
288   return lq_etxff_calc_linkcost(&lq_edge->lq);
289 }
290
291 static bool lq_etxff_is_relevant_costchange(olsr_linkcost c1, olsr_linkcost c2) {
292   if (c1 > c2) {
293     return c2 - c1 > LQ_PLUGIN_RELEVANT_COSTCHANGE_FF;
294   }
295   return c1 - c2 > LQ_PLUGIN_RELEVANT_COSTCHANGE_FF;
296 }
297
298 static olsr_linkcost lq_etxff_packet_loss_handler(struct link_entry *link,
299     bool loss __attribute__((unused))) {
300   return lq_etxff_calc_link_entry_cost(link);
301 }
302
303 static void lq_etxff_memorize_foreign_hello(struct link_entry *target,
304     struct lq_hello_neighbor *source) {
305   struct lq_etxff_link_entry *lq_target = (struct lq_etxff_link_entry *) target;
306   struct lq_etxff_lq_hello_neighbor *lq_source =
307       (struct lq_etxff_lq_hello_neighbor *) source;
308
309   if (source) {
310     lq_target->lq.valueNlq = lq_source->lq.valueLq;
311   } else {
312     lq_target->lq.valueNlq = 0;
313   }
314
315 }
316
317 static void lq_etxff_copy_link_entry_lq_into_tc_mpr_addr(
318     struct tc_mpr_addr *target, struct link_entry *source) {
319   struct lq_etxff_tc_mpr_addr *lq_target = (struct lq_etxff_tc_mpr_addr *) target;
320   struct lq_etxff_link_entry *lq_source = (struct lq_etxff_link_entry *) source;
321
322   lq_target->lq = lq_source->lq;
323 }
324
325 static void lq_etxff_copy_link_entry_lq_into_tc_edge_entry(
326     struct tc_edge_entry *target, struct link_entry *source) {
327   struct lq_etxff_tc_edge *lq_target = (struct lq_etxff_tc_edge *) target;
328   struct lq_etxff_link_entry *lq_source = (struct lq_etxff_link_entry *) source;
329
330   lq_target->lq = lq_source->lq;
331 }
332
333 static void lq_etxff_copy_link_lq_into_neighbor(struct lq_hello_neighbor *target,
334     struct link_entry *source) {
335   struct lq_etxff_lq_hello_neighbor *lq_target =
336       (struct lq_etxff_lq_hello_neighbor *) target;
337   struct lq_etxff_link_entry *lq_source = (struct lq_etxff_link_entry *) source;
338
339   lq_target->lq = lq_source->lq;
340 }
341
342 static void lq_etxff_clear_link_entry(struct link_entry *link) {
343   struct lq_etxff_link_entry *lq_link = (struct lq_etxff_link_entry *) link;
344   int i;
345
346   lq_link->windowSize = LQ_FF_QUICKSTART_INIT;
347   for (i = 0; i < LQ_FF_WINDOW; i++) {
348     lq_link->lost[i] = 3;
349   }
350 }
351
352 static int lq_etxff_serialize_hello_lq(unsigned char *buff,
353     struct lq_hello_neighbor *neigh) {
354   struct lq_etxff_lq_hello_neighbor *lq_neigh =
355       (struct lq_etxff_lq_hello_neighbor *) neigh;
356
357   buff[0] = (unsigned char) lq_neigh->lq.valueLq;
358   buff[1] = (unsigned char) lq_neigh->lq.valueNlq;
359   buff[2] = (unsigned char) (0);
360   buff[3] = (unsigned char) (0);
361
362   return 4;
363 }
364 static int lq_etxff_serialize_tc_lq(unsigned char *buff, struct tc_mpr_addr *mpr) {
365   struct lq_etxff_tc_mpr_addr *lq_mpr = (struct lq_etxff_tc_mpr_addr *) mpr;
366
367   buff[0] = (unsigned char) lq_mpr->lq.valueLq;
368   buff[1] = (unsigned char) lq_mpr->lq.valueNlq;
369   buff[2] = (unsigned char) (0);
370   buff[3] = (unsigned char) (0);
371
372   return 4;
373 }
374
375 static void lq_etxff_deserialize_hello_lq(uint8_t const ** curr,
376     struct lq_hello_neighbor *neigh) {
377   struct lq_etxff_lq_hello_neighbor *lq_neigh =
378       (struct lq_etxff_lq_hello_neighbor *) neigh;
379
380   pkt_get_u8(curr, &lq_neigh->lq.valueLq);
381   pkt_get_u8(curr, &lq_neigh->lq.valueNlq);
382   pkt_ignore_u16(curr);
383
384 }
385 static void lq_etxff_deserialize_tc_lq(uint8_t const ** curr,
386     struct tc_edge_entry *edge) {
387   struct lq_etxff_tc_edge *lq_edge = (struct lq_etxff_tc_edge *) edge;
388
389   pkt_get_u8(curr, &lq_edge->lq.valueLq);
390   pkt_get_u8(curr, &lq_edge->lq.valueNlq);
391   pkt_ignore_u16(curr);
392 }
393
394 static char *lq_etxff_print_lq(struct lq_etxff_linkquality *lq, char separator,
395     struct lqtextbuffer *buffer) {
396   int i = 0;
397
398   if (lq->valueLq == 255) {
399         strcpy(buffer->buf, "1.000");
400         i += 5;
401   }
402   else {
403     i = sprintf(buffer->buf, "0.%03d", (lq->valueLq * 1000)/255);
404   }
405   buffer->buf[i++] = separator;
406
407   if (lq->valueNlq == 255) {
408     strcpy(&buffer->buf[i], "1.000");
409   }
410   else {
411     sprintf(&buffer->buf[i], "0.%03d", (lq->valueNlq * 1000) / 255);
412   }
413   return buffer->buf;
414 }
415
416 static char *lq_etxff_print_link_entry_lq(struct link_entry *link, char separator,
417     struct lqtextbuffer *buffer) {
418   struct lq_etxff_link_entry *lq_link = (struct lq_etxff_link_entry *) link;
419
420   return lq_etxff_print_lq(&lq_link->lq, separator, buffer);
421 }
422
423 static char *lq_etxff_print_tc_edge_entry_lq(struct tc_edge_entry *edge,
424     char separator, struct lqtextbuffer * buffer) {
425   struct lq_etxff_tc_edge *lq_edge = (struct lq_etxff_tc_edge *) edge;
426
427   return lq_etxff_print_lq(&lq_edge->lq, separator, buffer);
428 }
429
430 static char *lq_etxff_print_cost(olsr_linkcost cost, struct lqtextbuffer * buffer) {
431   // must calculate
432   uint32_t roundDown = cost >> 16;
433   uint32_t fraction = ((cost & 0xffff) * 1000) >> 16;
434
435   sprintf(buffer->buf, "%u.%03u", roundDown, fraction);
436   return buffer->buf;
437 }
438
439 /*
440  * Local Variables:
441  * c-basic-offset: 2
442  * indent-tabs-mode: nil
443  * End:
444  */