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