Rename 'struct interface' to 'struct interface_olsr'
[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 (lq->smoothed_lq.valueLq < lq->lq.valueLq) {
119       if (lq->lq.valueLq == 255 || lq->lq.valueLq - lq->smoothed_lq.valueLq > lq->smoothed_lq.valueLq/10) {
120         relevant = true;
121       }
122     }
123     else if (lq->smoothed_lq.valueLq > lq->lq.valueLq) {
124       if (lq->smoothed_lq.valueLq - lq->lq.valueLq > lq->smoothed_lq.valueLq/10) {
125         relevant = true;
126       }
127     }
128     if (lq->smoothed_lq.valueNlq < lq->lq.valueNlq) {
129       if (lq->lq.valueNlq == 255 || lq->lq.valueNlq - lq->smoothed_lq.valueNlq > lq->smoothed_lq.valueNlq/10) {
130         relevant = true;
131       }
132     }
133     else if (lq->smoothed_lq.valueNlq > lq->lq.valueNlq) {
134       if (lq->smoothed_lq.valueNlq - lq->lq.valueNlq > lq->smoothed_lq.valueNlq/10) {
135         relevant = true;
136       }
137     }
138
139     if (relevant) {
140       memcpy(&lq->smoothed_lq, &lq->lq, sizeof(struct default_lq_ff));
141       link->linkcost = default_lq_calc_cost_ff(&lq->smoothed_lq);
142       triggered = true;
143     }
144   } OLSR_FOR_ALL_LINK_ENTRIES_END(link)
145
146   if (!triggered) {
147     return;
148   }
149
150   OLSR_FOR_ALL_LINK_ENTRIES(link) {
151     lq = (struct default_lq_ff_hello *)link->linkquality;
152
153     if (lq->smoothed_lq.valueLq == 255 && lq->smoothed_lq.valueNlq == 255) {
154       continue;
155     }
156
157     if (lq->smoothed_lq.valueLq == lq->lq.valueLq && lq->smoothed_lq.valueNlq == lq->lq.valueNlq) {
158       continue;
159     }
160
161     memcpy(&lq->smoothed_lq, &lq->lq, sizeof(struct default_lq_ff));
162     link->linkcost = default_lq_calc_cost_ff(&lq->smoothed_lq);
163   } OLSR_FOR_ALL_LINK_ENTRIES_END(link)
164
165   olsr_relevant_linkcost_change();
166 }
167
168 static void
169 default_lq_parser_ff(struct olsr *olsr, struct interface_olsr *in_if, union olsr_ip_addr *from_addr)
170 {
171   const union olsr_ip_addr *main_addr;
172   struct link_entry *lnk;
173   struct default_lq_ff_hello *lq;
174   uint32_t seq_diff;
175
176   /* Find main address */
177   main_addr = mid_lookup_main_addr(from_addr);
178
179   /* Loopup link entry */
180   lnk = lookup_link_entry(from_addr, main_addr, in_if);
181   if (lnk == NULL) {
182     return;
183   }
184
185   lq = (struct default_lq_ff_hello *)lnk->linkquality;
186
187   /* ignore double package */
188   if (lq->last_seq_nr == olsr->olsr_seqno) {
189     struct ipaddr_str buf;
190     olsr_syslog(OLSR_LOG_INFO, "detected duplicate packet with seqnr 0x%x from %s on %s (%d Bytes)",
191                 olsr->olsr_seqno,olsr_ip_to_string(&buf, from_addr),in_if->int_name,ntohs(olsr->olsr_packlen));
192     return;
193   }
194
195   if (lq->last_seq_nr > olsr->olsr_seqno) {
196     seq_diff = (uint32_t) olsr->olsr_seqno + 65536 - lq->last_seq_nr;
197   } else {
198     seq_diff = olsr->olsr_seqno - lq->last_seq_nr;
199   }
200
201   /* Jump in sequence numbers ? */
202   if (seq_diff > 256) {
203     seq_diff = 1;
204   }
205
206   lq->received[lq->activePtr]++;
207   lq->total[lq->activePtr] += seq_diff;
208
209   lq->last_seq_nr = olsr->olsr_seqno;
210   lq->missed_hellos = 0;
211 }
212
213 static void
214 default_lq_ff_timer(void __attribute__ ((unused)) * context)
215 {
216   struct link_entry *link;
217
218   OLSR_FOR_ALL_LINK_ENTRIES(link) {
219     struct default_lq_ff_hello *tlq = (struct default_lq_ff_hello *)link->linkquality;
220     fpm ratio;
221     int i, received, total;
222
223     received = 0;
224     total = 0;
225
226     /* enlarge window if still in quickstart phase */
227     if (tlq->windowSize < LQ_FF_WINDOW) {
228       tlq->windowSize++;
229     }
230     for (i = 0; i < tlq->windowSize; i++) {
231       received += tlq->received[i];
232       total += tlq->total[i];
233     }
234
235     /* calculate link quality */
236     if (total == 0) {
237       tlq->lq.valueLq = 0;
238     } else {
239       // start with link-loss-factor
240       ratio = fpmidiv(itofpm(link->loss_link_multiplier), LINK_LOSS_MULTIPLIER);
241
242       /* don't forget missing hellos */
243       if (tlq->missed_hellos > 1) {
244         uint32_t interval;
245
246         interval = tlq->missed_hellos * link->loss_helloint / 1000;
247         if (interval > LQ_FF_WINDOW) {
248           received = 0;
249         }
250         else {
251           received = (received * (LQ_FF_WINDOW - interval)) / LQ_FF_WINDOW;
252         }
253       }
254
255       // calculate received/total factor
256       ratio = fpmmuli(ratio, received);
257       ratio = fpmidiv(ratio, total);
258       ratio = fpmmuli(ratio, 255);
259
260       tlq->lq.valueLq = (uint8_t) (fpmtoi(ratio));
261     }
262
263     // shift buffer
264     tlq->activePtr = (tlq->activePtr + 1) % LQ_FF_WINDOW;
265     tlq->total[tlq->activePtr] = 0;
266     tlq->received[tlq->activePtr] = 0;
267   } OLSR_FOR_ALL_LINK_ENTRIES_END(link);
268
269   default_lq_ff_handle_lqchange();
270 }
271
272 static void
273 default_lq_initialize_ff(void)
274 {
275   olsr_packetparser_add_function(&default_lq_parser_ff);
276   olsr_start_timer(1000, 0, OLSR_TIMER_PERIODIC, &default_lq_ff_timer, NULL, 0);
277 }
278
279 static olsr_linkcost
280 default_lq_calc_cost_ff(const void *ptr)
281 {
282   const struct default_lq_ff *lq = ptr;
283   olsr_linkcost cost;
284
285   if (lq->valueLq < (unsigned int)(255 * MINIMAL_USEFUL_LQ) || lq->valueNlq < (unsigned int)(255 * MINIMAL_USEFUL_LQ)) {
286     return LINK_COST_BROKEN;
287   }
288
289   cost = fpmidiv(itofpm(255 * 255), (int)lq->valueLq * (int)lq->valueNlq);
290
291   if (cost > LINK_COST_BROKEN)
292     return LINK_COST_BROKEN;
293   if (cost == 0)
294     return 1;
295   return cost;
296 }
297
298 static int
299 default_lq_serialize_hello_lq_pair_ff(unsigned char *buff, void *ptr)
300 {
301   struct default_lq_ff *lq = ptr;
302
303   buff[0] = (unsigned char)lq->valueLq;
304   buff[1] = (unsigned char)lq->valueNlq;
305   buff[2] = (unsigned char)(0);
306   buff[3] = (unsigned char)(0);
307
308   return 4;
309 }
310
311 static void
312 default_lq_deserialize_hello_lq_pair_ff(const uint8_t ** curr, void *ptr)
313 {
314   struct default_lq_ff *lq = ptr;
315
316   pkt_get_u8(curr, &lq->valueLq);
317   pkt_get_u8(curr, &lq->valueNlq);
318   pkt_ignore_u16(curr);
319 }
320
321 static int
322 default_lq_serialize_tc_lq_pair_ff(unsigned char *buff, void *ptr)
323 {
324   struct default_lq_ff *lq = ptr;
325
326   buff[0] = (unsigned char)lq->valueLq;
327   buff[1] = (unsigned char)lq->valueNlq;
328   buff[2] = (unsigned char)(0);
329   buff[3] = (unsigned char)(0);
330
331   return 4;
332 }
333
334 static void
335 default_lq_deserialize_tc_lq_pair_ff(const uint8_t ** curr, void *ptr)
336 {
337   struct default_lq_ff *lq = ptr;
338
339   pkt_get_u8(curr, &lq->valueLq);
340   pkt_get_u8(curr, &lq->valueNlq);
341   pkt_ignore_u16(curr);
342 }
343
344 static void
345 default_lq_packet_loss_worker_ff(struct link_entry *link,
346     void __attribute__ ((unused)) *ptr, bool lost)
347 {
348   struct default_lq_ff_hello *tlq = (struct default_lq_ff_hello *)link->linkquality;
349
350   if (lost) {
351     tlq->missed_hellos++;
352   }
353   return;
354 }
355
356 static void
357 default_lq_memorize_foreign_hello_ff(void *ptrLocal, void *ptrForeign)
358 {
359   struct default_lq_ff_hello *local = ptrLocal;
360   struct default_lq_ff *foreign = ptrForeign;
361
362   if (foreign) {
363     local->lq.valueNlq = foreign->valueLq;
364   } else {
365     local->lq.valueNlq = 0;
366   }
367 }
368
369 static void
370 default_lq_copy_link2neigh_ff(void *t, void *s)
371 {
372   struct default_lq_ff *target = t;
373   struct default_lq_ff_hello *source = s;
374   *target = source->smoothed_lq;
375 }
376
377 static void
378 default_lq_copy_link2tc_ff(void *t, void *s)
379 {
380   struct default_lq_ff *target = t;
381   struct default_lq_ff_hello *source = s;
382   *target = source->smoothed_lq;
383 }
384
385 static void
386 default_lq_clear_ff(void *target)
387 {
388   memset(target, 0, sizeof(struct default_lq_ff));
389 }
390
391 static void
392 default_lq_clear_ff_hello(void *target)
393 {
394   struct default_lq_ff_hello *local = target;
395   int i;
396
397   default_lq_clear_ff(&local->lq);
398   default_lq_clear_ff(&local->smoothed_lq);
399   local->windowSize = LQ_FF_QUICKSTART_INIT;
400   for (i = 0; i < LQ_FF_WINDOW; i++) {
401     local->total[i] = 3;
402   }
403 }
404
405 static const char *
406 default_lq_print_ff(void *ptr, char separator, struct lqtextbuffer *buffer)
407 {
408   struct default_lq_ff *lq = ptr;
409
410   snprintf(buffer->buf, sizeof(buffer->buf), "%s%c%s", fpmtoa(fpmidiv(itofpm((int)lq->valueLq), 255)), separator,
411            fpmtoa(fpmidiv(itofpm((int)lq->valueNlq), 255)));
412   return buffer->buf;
413 }
414
415 static const char *
416 default_lq_print_cost_ff(olsr_linkcost cost, struct lqtextbuffer *buffer)
417 {
418   snprintf(buffer->buf, sizeof(buffer->buf), "%s", fpmtoa(cost));
419   return buffer->buf;
420 }
421
422 /*
423  * Local Variables:
424  * c-basic-offset: 2
425  * indent-tabs-mode: nil
426  * End:
427  */