aa43407d98a55cdc7cd9eaa08568a1244e6f4714
[olsrd.git] / src / lq_plugin_default_ff.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_ff.h"
50 #include "parser.h"
51 #include "fpm.h"
52 #include "mid_set.h"
53 #include "scheduler.h"
54 #include "log.h"
55 #include <time.h>
56
57 static void default_lq_initialize_ff(void);
58
59 static olsr_linkcost default_lq_calc_cost_ff(const void *lq);
60
61 static void default_lq_packet_loss_worker_ff(struct link_entry *link, void *lq, bool lost);
62 static void default_lq_memorize_foreign_hello_ff(void *local, void *foreign);
63
64 static int default_lq_serialize_hello_lq_pair_ff(unsigned char *buff, void *lq);
65 static void default_lq_deserialize_hello_lq_pair_ff(const uint8_t ** curr, void *lq);
66 static int default_lq_serialize_tc_lq_pair_ff(unsigned char *buff, void *lq);
67 static void default_lq_deserialize_tc_lq_pair_ff(const uint8_t ** curr, void *lq);
68
69 static void default_lq_copy_link2neigh_ff(void *t, void *s);
70 static void default_lq_copy_link2tc_ff(void *target, void *source);
71 static void default_lq_clear_ff(void *target);
72 static void default_lq_clear_ff_hello(void *target);
73
74 static const char *default_lq_print_ff(void *ptr, char separator, struct lqtextbuffer *buffer);
75 static const char *default_lq_print_cost_ff(olsr_linkcost cost, struct lqtextbuffer *buffer);
76
77 /* etx lq plugin (freifunk fpm version) settings */
78 struct lq_handler lq_etx_ff_handler = {
79   &default_lq_initialize_ff,
80   &default_lq_calc_cost_ff,
81   &default_lq_calc_cost_ff,
82
83   &default_lq_packet_loss_worker_ff,
84
85   &default_lq_memorize_foreign_hello_ff,
86   &default_lq_copy_link2neigh_ff,
87   &default_lq_copy_link2tc_ff,
88   &default_lq_clear_ff_hello,
89   &default_lq_clear_ff,
90
91   &default_lq_serialize_hello_lq_pair_ff,
92   &default_lq_serialize_tc_lq_pair_ff,
93   &default_lq_deserialize_hello_lq_pair_ff,
94   &default_lq_deserialize_tc_lq_pair_ff,
95
96   &default_lq_print_ff,
97   &default_lq_print_ff,
98   &default_lq_print_cost_ff,
99
100   sizeof(struct default_lq_ff_hello),
101   sizeof(struct default_lq_ff),
102   4,
103   4
104 };
105
106 static void
107 default_lq_ff_handle_lqchange(void) {
108   struct default_lq_ff_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_ff_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 == 255 || 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 == 255 || 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_ff));
147       link->linkcost = default_lq_calc_cost_ff(&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_ff_hello *)link->linkquality;
158
159     if (lq->smoothed_lq.valueLq == 255 && lq->smoothed_lq.valueNlq == 255) {
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_ff));
168     link->linkcost = default_lq_calc_cost_ff(&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_ff(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_ff_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_ff_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 %X 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_ff_timer(void __attribute__ ((unused)) * context)
221 {
222   struct link_entry *link;
223
224   OLSR_FOR_ALL_LINK_ENTRIES(link) {
225     struct default_lq_ff_hello *tlq = (struct default_lq_ff_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_FF_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_FF_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     // shift buffer
262     tlq->activePtr = (tlq->activePtr + 1) % LQ_FF_WINDOW;
263     tlq->total[tlq->activePtr] = 0;
264     tlq->received[tlq->activePtr] = 0;
265   } OLSR_FOR_ALL_LINK_ENTRIES_END(link);
266
267   default_lq_ff_handle_lqchange();
268 }
269
270 static void
271 default_lq_initialize_ff(void)
272 {
273   olsr_packetparser_add_function(&default_lq_parser_ff);
274   olsr_start_timer(1000, 0, OLSR_TIMER_PERIODIC, &default_lq_ff_timer, NULL, 0);
275 }
276
277 static olsr_linkcost
278 default_lq_calc_cost_ff(const void *ptr)
279 {
280   const struct default_lq_ff *lq = ptr;
281   olsr_linkcost cost;
282
283   if (lq->valueLq < (unsigned int)(255 * MINIMAL_USEFUL_LQ) || lq->valueNlq < (unsigned int)(255 * MINIMAL_USEFUL_LQ)) {
284     return LINK_COST_BROKEN;
285   }
286
287   cost = fpmidiv(itofpm(255 * 255), (int)lq->valueLq * (int)lq->valueNlq);
288
289   if (cost > LINK_COST_BROKEN)
290     return LINK_COST_BROKEN;
291   if (cost == 0)
292     return 1;
293   return cost;
294 }
295
296 static int
297 default_lq_serialize_hello_lq_pair_ff(unsigned char *buff, void *ptr)
298 {
299   struct default_lq_ff *lq = ptr;
300
301   buff[0] = (unsigned char)lq->valueLq;
302   buff[1] = (unsigned char)lq->valueNlq;
303   buff[2] = (unsigned char)(0);
304   buff[3] = (unsigned char)(0);
305
306   return 4;
307 }
308
309 static void
310 default_lq_deserialize_hello_lq_pair_ff(const uint8_t ** curr, void *ptr)
311 {
312   struct default_lq_ff *lq = ptr;
313
314   pkt_get_u8(curr, &lq->valueLq);
315   pkt_get_u8(curr, &lq->valueNlq);
316   pkt_ignore_u16(curr);
317 }
318
319 static int
320 default_lq_serialize_tc_lq_pair_ff(unsigned char *buff, void *ptr)
321 {
322   struct default_lq_ff *lq = ptr;
323
324   buff[0] = (unsigned char)lq->valueLq;
325   buff[1] = (unsigned char)lq->valueNlq;
326   buff[2] = (unsigned char)(0);
327   buff[3] = (unsigned char)(0);
328
329   return 4;
330 }
331
332 static void
333 default_lq_deserialize_tc_lq_pair_ff(const uint8_t ** curr, void *ptr)
334 {
335   struct default_lq_ff *lq = ptr;
336
337   pkt_get_u8(curr, &lq->valueLq);
338   pkt_get_u8(curr, &lq->valueNlq);
339   pkt_ignore_u16(curr);
340 }
341
342 static void
343 default_lq_packet_loss_worker_ff(struct link_entry *link,
344     void __attribute__ ((unused)) *ptr, bool lost)
345 {
346   struct default_lq_ff_hello *tlq = (struct default_lq_ff_hello *)link->linkquality;
347
348   if (lost) {
349     tlq->missed_hellos++;
350   }
351   return;
352 }
353
354 static void
355 default_lq_memorize_foreign_hello_ff(void *ptrLocal, void *ptrForeign)
356 {
357   struct default_lq_ff_hello *local = ptrLocal;
358   struct default_lq_ff *foreign = ptrForeign;
359
360   if (foreign) {
361     local->lq.valueNlq = foreign->valueLq;
362   } else {
363     local->lq.valueNlq = 0;
364   }
365 }
366
367 static void
368 default_lq_copy_link2neigh_ff(void *t, void *s)
369 {
370   struct default_lq_ff *target = t;
371   struct default_lq_ff_hello *source = s;
372   *target = source->smoothed_lq;
373 }
374
375 static void
376 default_lq_copy_link2tc_ff(void *t, void *s)
377 {
378   struct default_lq_ff *target = t;
379   struct default_lq_ff_hello *source = s;
380   *target = source->smoothed_lq;
381 }
382
383 static void
384 default_lq_clear_ff(void *target)
385 {
386   memset(target, 0, sizeof(struct default_lq_ff));
387 }
388
389 static void
390 default_lq_clear_ff_hello(void *target)
391 {
392   struct default_lq_ff_hello *local = target;
393   int i;
394
395   default_lq_clear_ff(&local->lq);
396   default_lq_clear_ff(&local->smoothed_lq);
397   local->windowSize = LQ_FF_QUICKSTART_INIT;
398   for (i = 0; i < LQ_FF_WINDOW; i++) {
399     local->total[i] = 3;
400   }
401 }
402
403 static const char *
404 default_lq_print_ff(void *ptr, char separator, struct lqtextbuffer *buffer)
405 {
406   struct default_lq_ff *lq = ptr;
407
408   snprintf(buffer->buf, sizeof(buffer->buf), "%s%c%s", fpmtoa(fpmidiv(itofpm((int)lq->valueLq), 255)), separator,
409            fpmtoa(fpmidiv(itofpm((int)lq->valueNlq), 255)));
410   return buffer->buf;
411 }
412
413 static const char *
414 default_lq_print_cost_ff(olsr_linkcost cost, struct lqtextbuffer *buffer)
415 {
416   snprintf(buffer->buf, sizeof(buffer->buf), "%s", fpmtoa(cost));
417   return buffer->buf;
418 }
419
420 /*
421  * Local Variables:
422  * c-basic-offset: 2
423  * indent-tabs-mode: nil
424  * End:
425  */