Smooth LQ calculation if link suddenly breaks.
[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       /* don't forget missing hellos */
245       if (tlq->missed_hellos > 1) {
246         uint32_t interval;
247
248         interval = tlq->missed_hellos * link->loss_helloint / 1000;
249         if (interval > LQ_FF_WINDOW) {
250           received = 0;
251         }
252         else {
253           received = (received * (LQ_FF_WINDOW - interval)) / LQ_FF_WINDOW;
254         }
255       }
256
257       // calculate received/total factor
258       ratio = fpmmuli(ratio, received);
259       ratio = fpmidiv(ratio, total);
260       ratio = fpmmuli(ratio, 255);
261
262       tlq->lq.valueLq = (uint8_t) (fpmtoi(ratio));
263     }
264
265     /* ethernet booster */
266     if (link->inter->mode == IF_MODE_ETHER) {
267       if (tlq->lq.valueLq > (uint8_t)(0.95 * 255)) {
268         tlq->perfect_eth = true;
269       }
270       else if (tlq->lq.valueLq > (uint8_t)(0.90 * 255)) {
271         tlq->perfect_eth = false;
272       }
273
274       if (tlq->perfect_eth) {
275         tlq->lq.valueLq = 255;
276       }
277     }
278     else if (link->inter->mode != IF_MODE_ETHER && tlq->lq.valueLq > 0) {
279       tlq->lq.valueLq--;
280     }
281
282     // shift buffer
283     tlq->activePtr = (tlq->activePtr + 1) % LQ_FFETH_WINDOW;
284     tlq->total[tlq->activePtr] = 0;
285     tlq->received[tlq->activePtr] = 0;
286   } OLSR_FOR_ALL_LINK_ENTRIES_END(link);
287
288   default_lq_ffeth_handle_lqchange();
289 }
290
291 static void
292 default_lq_initialize_ffeth(void)
293 {
294   if (olsr_cnf->lq_nat_thresh < 1.0f) {
295     fprintf(stderr, "Warning, nat_treshold < 1.0 is more likely to produce loops with etx_ffeth\n");
296   }
297   olsr_packetparser_add_function(&default_lq_parser_ffeth);
298   olsr_start_timer(1000, 0, OLSR_TIMER_PERIODIC, &default_lq_ffeth_timer, NULL, 0);
299 }
300
301 static olsr_linkcost
302 default_lq_calc_cost_ffeth(const void *ptr)
303 {
304   const struct default_lq_ffeth *lq = ptr;
305   olsr_linkcost cost;
306   bool ether;
307   int lq_int, nlq_int;
308
309   if (lq->valueLq < (unsigned int)(255 * MINIMAL_USEFUL_LQ) || lq->valueNlq < (unsigned int)(255 * MINIMAL_USEFUL_LQ)) {
310     return LINK_COST_BROKEN;
311   }
312
313   ether = lq->valueLq == 255 && lq->valueNlq == 255;
314
315   lq_int = (int)lq->valueLq;
316   if (lq_int > 0 && lq_int < 255) {
317     lq_int++;
318   }
319
320   nlq_int = (int)lq->valueNlq;
321   if (nlq_int > 0 && nlq_int < 255) {
322     nlq_int++;
323   }
324   cost = fpmidiv(itofpm(255 * 255), lq_int * nlq_int);
325   if (ether) {
326     /* ethernet boost */
327     cost /= 10;
328   }
329
330   if (cost > LINK_COST_BROKEN)
331     return LINK_COST_BROKEN;
332   if (cost == 0)
333     return 1;
334   return cost;
335 }
336
337 static int
338 default_lq_serialize_hello_lq_pair_ffeth(unsigned char *buff, void *ptr)
339 {
340   struct default_lq_ffeth *lq = ptr;
341
342   buff[0] = (unsigned char)(0);
343   buff[1] = (unsigned char)(0);
344   buff[2] = (unsigned char)lq->valueLq;
345   buff[3] = (unsigned char)lq->valueNlq;
346
347   return 4;
348 }
349
350 static void
351 default_lq_deserialize_hello_lq_pair_ffeth(const uint8_t ** curr, void *ptr)
352 {
353   struct default_lq_ffeth *lq = ptr;
354
355   pkt_ignore_u16(curr);
356   pkt_get_u8(curr, &lq->valueLq);
357   pkt_get_u8(curr, &lq->valueNlq);
358 }
359
360 static int
361 default_lq_serialize_tc_lq_pair_ffeth(unsigned char *buff, void *ptr)
362 {
363   struct default_lq_ffeth *lq = ptr;
364
365   buff[0] = (unsigned char)(0);
366   buff[1] = (unsigned char)(0);
367   buff[2] = (unsigned char)lq->valueLq;
368   buff[3] = (unsigned char)lq->valueNlq;
369
370   return 4;
371 }
372
373 static void
374 default_lq_deserialize_tc_lq_pair_ffeth(const uint8_t ** curr, void *ptr)
375 {
376   struct default_lq_ffeth *lq = ptr;
377
378   pkt_ignore_u16(curr);
379   pkt_get_u8(curr, &lq->valueLq);
380   pkt_get_u8(curr, &lq->valueNlq);
381 }
382
383 static void
384 default_lq_packet_loss_worker_ffeth(struct link_entry *link,
385     void __attribute__ ((unused)) *ptr, bool lost)
386 {
387   struct default_lq_ffeth_hello *tlq = (struct default_lq_ffeth_hello *)link->linkquality;
388
389   if (lost) {
390     tlq->missed_hellos++;
391   }
392   return;
393 }
394
395 static void
396 default_lq_memorize_foreign_hello_ffeth(void *ptrLocal, void *ptrForeign)
397 {
398   struct default_lq_ffeth_hello *local = ptrLocal;
399   struct default_lq_ffeth *foreign = ptrForeign;
400
401   if (foreign) {
402     local->lq.valueNlq = foreign->valueLq;
403   } else {
404     local->lq.valueNlq = 0;
405   }
406 }
407
408 static void
409 default_lq_copy_link2neigh_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_copy_link2tc_ffeth(void *t, void *s)
418 {
419   struct default_lq_ffeth *target = t;
420   struct default_lq_ffeth_hello *source = s;
421   *target = source->smoothed_lq;
422 }
423
424 static void
425 default_lq_clear_ffeth(void *target)
426 {
427   memset(target, 0, sizeof(struct default_lq_ffeth));
428 }
429
430 static void
431 default_lq_clear_ffeth_hello(void *target)
432 {
433   struct default_lq_ffeth_hello *local = target;
434   int i;
435
436   default_lq_clear_ffeth(&local->lq);
437   default_lq_clear_ffeth(&local->smoothed_lq);
438   local->windowSize = LQ_FFETH_QUICKSTART_INIT;
439   for (i = 0; i < LQ_FFETH_WINDOW; i++) {
440     local->total[i] = 3;
441   }
442 }
443
444 static const char *
445 default_lq_print_ffeth(void *ptr, char separator, struct lqtextbuffer *buffer)
446 {
447   struct default_lq_ffeth *lq = ptr;
448   int lq_int, nlq_int;
449
450   lq_int = (int)lq->valueLq;
451   if (lq_int > 0 && lq_int < 255) {
452     lq_int++;
453   }
454
455   nlq_int = (int)lq->valueNlq;
456   if (nlq_int > 0 && nlq_int < 255) {
457     nlq_int++;
458   }
459
460   snprintf(buffer->buf, sizeof(buffer->buf), "%s%c%s", fpmtoa(fpmidiv(itofpm(lq_int), 255)), separator,
461            fpmtoa(fpmidiv(itofpm(nlq_int), 255)));
462   return buffer->buf;
463 }
464
465 static const char *
466 default_lq_print_cost_ffeth(olsr_linkcost cost, struct lqtextbuffer *buffer)
467 {
468   snprintf(buffer->buf, sizeof(buffer->buf), "%s", fpmtoa(cost));
469   return buffer->buf;
470 }
471
472 /*
473  * Local Variables:
474  * c-basic-offset: 2
475  * indent-tabs-mode: nil
476  * End:
477  */