Update version after release of v0.6.5.2
[olsrd.git] / src / lq_plugin_default_ffeth.c
1
2 /*
3  * The olsr.org Optimized Link-State Routing daemon(olsrd)
4  * Copyright (c) 2008 Henning Rogge <rogge@fgan.de>
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 #include "tc_set.h"
43 #include "link_set.h"
44 #include "lq_plugin.h"
45 #include "olsr_spf.h"
46 #include "lq_packet.h"
47 #include "packet.h"
48 #include "olsr.h"
49 #include "lq_plugin_default_ffeth.h"
50 #include "parser.h"
51 #include "fpm.h"
52 #include "mid_set.h"
53 #include "scheduler.h"
54 #include "log.h"
55
56 #define LQ_PLUGIN_LC_MULTIPLIER 1024
57 #define LQ_PLUGIN_RELEVANT_COSTCHANGE_FF 16
58
59 static void default_lq_initialize_ffeth(void);
60
61 static olsr_linkcost default_lq_calc_cost_ffeth(const void *lq);
62
63 static void default_lq_packet_loss_worker_ffeth(struct link_entry *link, void *lq, bool lost);
64 static void default_lq_memorize_foreign_hello_ffeth(void *local, void *foreign);
65
66 static int default_lq_serialize_hello_lq_pair_ffeth(unsigned char *buff, void *lq);
67 static void default_lq_deserialize_hello_lq_pair_ffeth(const uint8_t ** curr, void *lq);
68 static int default_lq_serialize_tc_lq_pair_ffeth(unsigned char *buff, void *lq);
69 static void default_lq_deserialize_tc_lq_pair_ffeth(const uint8_t ** curr, void *lq);
70
71 static void default_lq_copy_link2neigh_ffeth(void *t, void *s);
72 static void default_lq_copy_link2tc_ffeth(void *target, void *source);
73 static void default_lq_clear_ffeth(void *target);
74 static void default_lq_clear_ffeth_hello(void *target);
75
76 static const char *default_lq_print_ffeth(void *ptr, char separator, struct lqtextbuffer *buffer);
77 static const char *default_lq_print_cost_ffeth(olsr_linkcost cost, struct lqtextbuffer *buffer);
78
79 /* etx lq plugin (freifunk fpm version) settings */
80 struct lq_handler lq_etx_ffeth_handler = {
81   &default_lq_initialize_ffeth,
82   &default_lq_calc_cost_ffeth,
83   &default_lq_calc_cost_ffeth,
84
85   &default_lq_packet_loss_worker_ffeth,
86
87   &default_lq_memorize_foreign_hello_ffeth,
88   &default_lq_copy_link2neigh_ffeth,
89   &default_lq_copy_link2tc_ffeth,
90   &default_lq_clear_ffeth_hello,
91   &default_lq_clear_ffeth,
92
93   &default_lq_serialize_hello_lq_pair_ffeth,
94   &default_lq_serialize_tc_lq_pair_ffeth,
95   &default_lq_deserialize_hello_lq_pair_ffeth,
96   &default_lq_deserialize_tc_lq_pair_ffeth,
97
98   &default_lq_print_ffeth,
99   &default_lq_print_ffeth,
100   &default_lq_print_cost_ffeth,
101
102   sizeof(struct default_lq_ffeth_hello),
103   sizeof(struct default_lq_ffeth),
104   4,
105   4
106 };
107
108 static void
109 default_lq_ffeth_handle_lqchange(void) {
110   struct default_lq_ffeth_hello *lq;
111   struct ipaddr_str buf;
112   struct link_entry *link;
113
114   bool triggered = false;
115
116   OLSR_FOR_ALL_LINK_ENTRIES(link) {
117     bool relevant = false;
118     lq = (struct default_lq_ffeth_hello *)link->linkquality;
119
120     if (lq->smoothed_lq.valueLq < lq->lq.valueLq) {
121       if (lq->lq.valueLq >= 254 || lq->lq.valueLq - lq->smoothed_lq.valueLq > lq->smoothed_lq.valueLq/10) {
122         relevant = true;
123       }
124     }
125     else if (lq->smoothed_lq.valueLq > lq->lq.valueLq) {
126       if (lq->smoothed_lq.valueLq - lq->lq.valueLq > lq->smoothed_lq.valueLq/10) {
127         relevant = true;
128       }
129     }
130     if (lq->smoothed_lq.valueNlq < lq->lq.valueNlq) {
131       if (lq->lq.valueNlq >= 254 || lq->lq.valueNlq - lq->smoothed_lq.valueNlq > lq->smoothed_lq.valueNlq/10) {
132         relevant = true;
133       }
134     }
135     else if (lq->smoothed_lq.valueNlq > lq->lq.valueNlq) {
136       if (lq->smoothed_lq.valueNlq - lq->lq.valueNlq > lq->smoothed_lq.valueNlq/10) {
137         relevant = true;
138       }
139     }
140
141     if (relevant) {
142       memcpy(&lq->smoothed_lq, &lq->lq, sizeof(struct default_lq_ffeth));
143       link->linkcost = default_lq_calc_cost_ffeth(&lq->smoothed_lq);
144       triggered = true;
145     }
146   } OLSR_FOR_ALL_LINK_ENTRIES_END(link)
147
148   if (!triggered) {
149     return;
150   }
151
152   OLSR_FOR_ALL_LINK_ENTRIES(link) {
153     lq = (struct default_lq_ffeth_hello *)link->linkquality;
154
155     if (lq->smoothed_lq.valueLq >= 254 && lq->smoothed_lq.valueNlq >= 254) {
156       continue;
157     }
158
159     if (lq->smoothed_lq.valueLq == lq->lq.valueLq && lq->smoothed_lq.valueNlq == lq->lq.valueNlq) {
160       continue;
161     }
162
163     memcpy(&lq->smoothed_lq, &lq->lq, sizeof(struct default_lq_ffeth));
164     link->linkcost = default_lq_calc_cost_ffeth(&lq->smoothed_lq);
165   } OLSR_FOR_ALL_LINK_ENTRIES_END(link)
166
167   olsr_relevant_linkcost_change();
168 }
169
170 static void
171 default_lq_parser_ffeth(struct olsr *olsr, struct interface *in_if, union olsr_ip_addr *from_addr)
172 {
173   const union olsr_ip_addr *main_addr;
174   struct link_entry *lnk;
175   struct default_lq_ffeth_hello *lq;
176   uint32_t seq_diff;
177
178   /* Find main address */
179   main_addr = mid_lookup_main_addr(from_addr);
180
181   /* Loopup link entry */
182   lnk = lookup_link_entry(from_addr, main_addr, in_if);
183   if (lnk == NULL) {
184     return;
185   }
186
187   lq = (struct default_lq_ffeth_hello *)lnk->linkquality;
188
189   /* ignore double package */
190   if (lq->last_seq_nr == olsr->olsr_seqno) {
191     struct ipaddr_str buf;
192     olsr_syslog(OLSR_LOG_INFO, "detected duplicate packet with seqnr %d from %s on %s (%d Bytes)",
193                 olsr->olsr_seqno,olsr_ip_to_string(&buf, from_addr),in_if->int_name,ntohs(olsr->olsr_packlen));
194     return;
195   }
196
197   if (lq->last_seq_nr > olsr->olsr_seqno) {
198     seq_diff = (uint32_t) olsr->olsr_seqno + 65536 - lq->last_seq_nr;
199   } else {
200     seq_diff = olsr->olsr_seqno - lq->last_seq_nr;
201   }
202
203   /* Jump in sequence numbers ? */
204   if (seq_diff > 256) {
205     seq_diff = 1;
206   }
207
208   lq->received[lq->activePtr]++;
209   lq->total[lq->activePtr] += seq_diff;
210
211   lq->last_seq_nr = olsr->olsr_seqno;
212   lq->missed_hellos = 0;
213 }
214
215 static void
216 default_lq_ffeth_timer(void __attribute__ ((unused)) * context)
217 {
218   struct link_entry *link;
219
220   OLSR_FOR_ALL_LINK_ENTRIES(link) {
221     struct default_lq_ffeth_hello *tlq = (struct default_lq_ffeth_hello *)link->linkquality;
222     fpm ratio;
223     int i, received, total;
224
225     received = 0;
226     total = 0;
227
228     /* enlarge window if still in quickstart phase */
229     if (tlq->windowSize < LQ_FFETH_WINDOW) {
230       tlq->windowSize++;
231     }
232     for (i = 0; i < tlq->windowSize; i++) {
233       received += tlq->received[i];
234       total += tlq->total[i];
235     }
236
237     /* calculate link quality */
238     if (total == 0) {
239       tlq->lq.valueLq = 0;
240     } else {
241       // start with link-loss-factor
242       ratio = fpmidiv(itofpm(link->loss_link_multiplier), LINK_LOSS_MULTIPLIER);
243
244       /* keep missed hello periods in mind (round up hello interval to seconds) */
245       if (tlq->missed_hellos > 1) {
246         received = received - received * tlq->missed_hellos * link->inter->hello_etime/1000 / LQ_FFETH_WINDOW;
247       }
248
249       // calculate received/total factor
250       ratio = fpmmuli(ratio, received);
251       ratio = fpmidiv(ratio, total);
252       ratio = fpmmuli(ratio, 255);
253
254       tlq->lq.valueLq = (uint8_t) (fpmtoi(ratio));
255     }
256
257     /* ethernet booster */
258     if (link->inter->mode == IF_MODE_ETHER) {
259       if (tlq->lq.valueLq > (uint8_t)(0.95 * 255)) {
260         tlq->perfect_eth = true;
261       }
262       else if (tlq->lq.valueLq > (uint8_t)(0.90 * 255)) {
263         tlq->perfect_eth = false;
264       }
265
266       if (tlq->perfect_eth) {
267         tlq->lq.valueLq = 255;
268       }
269     }
270     else if (link->inter->mode != IF_MODE_ETHER && tlq->lq.valueLq > 0) {
271       tlq->lq.valueLq--;
272     }
273
274     // shift buffer
275     tlq->activePtr = (tlq->activePtr + 1) % LQ_FFETH_WINDOW;
276     tlq->total[tlq->activePtr] = 0;
277     tlq->received[tlq->activePtr] = 0;
278   } OLSR_FOR_ALL_LINK_ENTRIES_END(link);
279
280   default_lq_ffeth_handle_lqchange();
281 }
282
283 static void
284 default_lq_initialize_ffeth(void)
285 {
286   if (olsr_cnf->lq_nat_thresh < 1.0f) {
287     fprintf(stderr, "Warning, nat_treshold < 1.0 is more likely to produce loops with etx_ffeth\n");
288   }
289   olsr_packetparser_add_function(&default_lq_parser_ffeth);
290   olsr_start_timer(1000, 0, OLSR_TIMER_PERIODIC, &default_lq_ffeth_timer, NULL, 0);
291 }
292
293 static olsr_linkcost
294 default_lq_calc_cost_ffeth(const void *ptr)
295 {
296   const struct default_lq_ffeth *lq = ptr;
297   olsr_linkcost cost;
298   bool ether;
299   int lq_int, nlq_int;
300
301   if (lq->valueLq < (unsigned int)(255 * MINIMAL_USEFUL_LQ) || lq->valueNlq < (unsigned int)(255 * MINIMAL_USEFUL_LQ)) {
302     return LINK_COST_BROKEN;
303   }
304
305   ether = lq->valueLq == 255 && lq->valueNlq == 255;
306
307   lq_int = (int)lq->valueLq;
308   if (lq_int > 0 && lq_int < 255) {
309     lq_int++;
310   }
311
312   nlq_int = (int)lq->valueNlq;
313   if (nlq_int > 0 && nlq_int < 255) {
314     nlq_int++;
315   }
316   cost = fpmidiv(itofpm(255 * 255), lq_int * nlq_int);
317   if (ether) {
318     /* ethernet boost */
319     cost /= 10;
320   }
321
322   if (cost > LINK_COST_BROKEN)
323     return LINK_COST_BROKEN;
324   if (cost == 0)
325     return 1;
326   return cost;
327 }
328
329 static int
330 default_lq_serialize_hello_lq_pair_ffeth(unsigned char *buff, void *ptr)
331 {
332   struct default_lq_ffeth *lq = ptr;
333
334   buff[0] = (unsigned char)(0);
335   buff[1] = (unsigned char)(0);
336   buff[2] = (unsigned char)lq->valueLq;
337   buff[3] = (unsigned char)lq->valueNlq;
338
339   return 4;
340 }
341
342 static void
343 default_lq_deserialize_hello_lq_pair_ffeth(const uint8_t ** curr, void *ptr)
344 {
345   struct default_lq_ffeth *lq = ptr;
346
347   pkt_ignore_u16(curr);
348   pkt_get_u8(curr, &lq->valueLq);
349   pkt_get_u8(curr, &lq->valueNlq);
350 }
351
352 static int
353 default_lq_serialize_tc_lq_pair_ffeth(unsigned char *buff, void *ptr)
354 {
355   struct default_lq_ffeth *lq = ptr;
356
357   buff[0] = (unsigned char)(0);
358   buff[1] = (unsigned char)(0);
359   buff[2] = (unsigned char)lq->valueLq;
360   buff[3] = (unsigned char)lq->valueNlq;
361
362   return 4;
363 }
364
365 static void
366 default_lq_deserialize_tc_lq_pair_ffeth(const uint8_t ** curr, void *ptr)
367 {
368   struct default_lq_ffeth *lq = ptr;
369
370   pkt_ignore_u16(curr);
371   pkt_get_u8(curr, &lq->valueLq);
372   pkt_get_u8(curr, &lq->valueNlq);
373 }
374
375 static void
376 default_lq_packet_loss_worker_ffeth(struct link_entry *link,
377     void __attribute__ ((unused)) *ptr, bool lost)
378 {
379   struct default_lq_ffeth_hello *tlq = (struct default_lq_ffeth_hello *)link->linkquality;
380
381   if (lost) {
382     tlq->missed_hellos++;
383   }
384   return;
385 }
386
387 static void
388 default_lq_memorize_foreign_hello_ffeth(void *ptrLocal, void *ptrForeign)
389 {
390   struct default_lq_ffeth_hello *local = ptrLocal;
391   struct default_lq_ffeth *foreign = ptrForeign;
392
393   if (foreign) {
394     local->lq.valueNlq = foreign->valueLq;
395   } else {
396     local->lq.valueNlq = 0;
397   }
398 }
399
400 static void
401 default_lq_copy_link2neigh_ffeth(void *t, void *s)
402 {
403   struct default_lq_ffeth *target = t;
404   struct default_lq_ffeth_hello *source = s;
405   *target = source->smoothed_lq;
406 }
407
408 static void
409 default_lq_copy_link2tc_ffeth(void *t, void *s)
410 {
411   struct default_lq_ffeth *target = t;
412   struct default_lq_ffeth_hello *source = s;
413   *target = source->smoothed_lq;
414 }
415
416 static void
417 default_lq_clear_ffeth(void *target)
418 {
419   memset(target, 0, sizeof(struct default_lq_ffeth));
420 }
421
422 static void
423 default_lq_clear_ffeth_hello(void *target)
424 {
425   struct default_lq_ffeth_hello *local = target;
426   int i;
427
428   default_lq_clear_ffeth(&local->lq);
429   default_lq_clear_ffeth(&local->smoothed_lq);
430   local->windowSize = LQ_FFETH_QUICKSTART_INIT;
431   for (i = 0; i < LQ_FFETH_WINDOW; i++) {
432     local->total[i] = 3;
433   }
434 }
435
436 static const char *
437 default_lq_print_ffeth(void *ptr, char separator, struct lqtextbuffer *buffer)
438 {
439   struct default_lq_ffeth *lq = ptr;
440   int lq_int, nlq_int;
441
442   lq_int = (int)lq->valueLq;
443   if (lq_int > 0 && lq_int < 255) {
444     lq_int++;
445   }
446
447   nlq_int = (int)lq->valueNlq;
448   if (nlq_int > 0 && nlq_int < 255) {
449     nlq_int++;
450   }
451
452   snprintf(buffer->buf, sizeof(buffer->buf), "%s%c%s", fpmtoa(fpmidiv(itofpm(lq_int), 255)), separator,
453            fpmtoa(fpmidiv(itofpm(nlq_int), 255)));
454   return buffer->buf;
455 }
456
457 static const char *
458 default_lq_print_cost_ffeth(olsr_linkcost cost, struct lqtextbuffer *buffer)
459 {
460   snprintf(buffer->buf, sizeof(buffer->buf), "%s", fpmtoa(cost));
461   return buffer->buf;
462 }
463
464 /*
465  * Local Variables:
466  * c-basic-offset: 2
467  * indent-tabs-mode: nil
468  * End:
469  */