Convert etx_lq_fpm plugin to new plugin interface
[olsrd.git] / lib / lq_etx_ff / src / lq_plugin_etx_ff.c
1
2 /*
3  * The olsr.org Optimized Link-State Routing daemon(olsrd)
4  * Copyright (c) 2004-2009, the olsr.org team - see HISTORY file
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 "olsr.h"
48 #include "lq_plugin_etx_ff.h"
49 #include "parser.h"
50 #include "mid_set.h"
51 #include "scheduler.h"
52 #include "olsr_logging.h"
53
54 #define PLUGIN_DESCR "Freifunk ETX metric based on the original design of Elektra and Thomas Lopatic"
55 #define PLUGIN_AUTHOR "Henning Rogge"
56
57 #define LQ_ALGORITHM_ETX_FF_NAME "etx_ff"
58
59 #define LQ_FF_QUICKSTART_INIT 4
60
61 #define LQ_PLUGIN_RELEVANT_COSTCHANGE_FF 16
62
63 static int lq_etxff_post_init(void);
64
65 static void lq_etxff_initialize(void);
66 static void lq_etxff_deinitialize(void);
67
68 static olsr_linkcost lq_etxff_calc_link_entry_cost(struct link_entry *);
69 static olsr_linkcost lq_etxff_calc_lq_hello_neighbor_cost(struct lq_hello_neighbor *);
70 static olsr_linkcost lq_etxff_calc_tc_mpr_addr_cost(struct tc_mpr_addr *);
71 static olsr_linkcost lq_etxff_calc_tc_edge_entry_cost(struct tc_edge_entry *);
72
73 static bool lq_etxff_is_relevant_costchange(olsr_linkcost c1, olsr_linkcost c2);
74
75 static olsr_linkcost lq_etxff_packet_loss_handler(struct link_entry *, bool);
76
77 static void lq_etxff_memorize_foreign_hello(struct link_entry *, struct lq_hello_neighbor *);
78 static void lq_etxff_copy_link_entry_lq_into_tc_mpr_addr(struct tc_mpr_addr *target, struct link_entry *source);
79 static void lq_etxff_copy_link_entry_lq_into_tc_edge_entry(struct tc_edge_entry *target, struct link_entry *source);
80 static void lq_etxff_copy_link_lq_into_neighbor(struct lq_hello_neighbor *target, struct link_entry *source);
81
82 static void lq_etxff_clear_link_entry(struct link_entry *);
83
84 static int lq_etxff_serialize_hello_lq(unsigned char *buff, struct lq_hello_neighbor *lq);
85 static int lq_etxff_serialize_tc_lq(unsigned char *buff, struct tc_mpr_addr *lq);
86 static void lq_etxff_deserialize_hello_lq(uint8_t const **curr, struct lq_hello_neighbor *lq);
87 static void lq_etxff_deserialize_tc_lq(uint8_t const **curr, struct tc_edge_entry *lq);
88
89 static char *lq_etxff_print_link_entry_lq(struct link_entry *entry, char separator, struct lqtextbuffer *buffer);
90 static char *lq_etxff_print_tc_edge_entry_lq(struct tc_edge_entry *ptr, char separator, struct lqtextbuffer *buffer);
91 static char *lq_etxff_print_cost(olsr_linkcost cost, struct lqtextbuffer *buffer);
92
93 static struct olsr_cookie_info *default_lq_ff_timer_cookie = NULL;
94
95 DEFINE_PLUGIN6_NP(PLUGIN_DESCR, PLUGIN_AUTHOR, NULL, lq_etxff_post_init, NULL, NULL, false)
96
97 /* etx lq plugin (freifunk fpm version) settings */
98 struct lq_handler lq_etxff_handler = {
99   "etx (freifunk)",
100
101   &lq_etxff_initialize,
102   &lq_etxff_deinitialize,
103
104   &lq_etxff_calc_link_entry_cost,
105   &lq_etxff_calc_lq_hello_neighbor_cost,
106   &lq_etxff_calc_tc_mpr_addr_cost,
107   &lq_etxff_calc_tc_edge_entry_cost,
108
109   &lq_etxff_is_relevant_costchange,
110
111   &lq_etxff_packet_loss_handler,
112
113   &lq_etxff_memorize_foreign_hello,
114   &lq_etxff_copy_link_entry_lq_into_tc_mpr_addr,
115   &lq_etxff_copy_link_entry_lq_into_tc_edge_entry,
116   &lq_etxff_copy_link_lq_into_neighbor,
117
118   &lq_etxff_clear_link_entry,
119   NULL,
120   NULL,
121   NULL,
122
123   &lq_etxff_serialize_hello_lq,
124   &lq_etxff_serialize_tc_lq,
125   &lq_etxff_deserialize_hello_lq,
126   &lq_etxff_deserialize_tc_lq,
127
128   &lq_etxff_print_link_entry_lq,
129   &lq_etxff_print_tc_edge_entry_lq,
130   &lq_etxff_print_cost,
131
132   sizeof(struct lq_etxff_tc_edge),
133   sizeof(struct lq_etxff_tc_mpr_addr),
134   sizeof(struct lq_etxff_lq_hello_neighbor),
135   sizeof(struct lq_etxff_link_entry),
136
137   LQ_HELLO_MESSAGE,
138   LQ_TC_MESSAGE
139 };
140
141 static int lq_etxff_post_init(void) {
142   active_lq_handler = &lq_etxff_handler;
143   return 0;
144 }
145
146 static void
147 lq_etxff_packet_parser(struct olsr *olsr, struct interface *in_if, union olsr_ip_addr *from_addr)
148 {
149   const union olsr_ip_addr *main_addr;
150   struct lq_etxff_link_entry *lnk;
151   uint32_t seq_diff;
152
153   /* Find main address */
154   main_addr = olsr_lookup_main_addr_by_alias(from_addr);
155
156   /* Loopup link entry */
157   lnk = (struct lq_etxff_link_entry *)lookup_link_entry(from_addr, main_addr, in_if);
158   if (lnk == NULL) {
159     return;
160   }
161
162   if (lnk->last_seq_nr == olsr->olsr_seqno) {
163 #ifndef REMOVE_LOG_WARN
164     struct ipaddr_str buf;
165 #endif
166     OLSR_WARN(LOG_LQ_PLUGINS, "Got package with same sequence number from %s\n", olsr_ip_to_string(&buf, from_addr));
167     return;
168   }
169   if (lnk->last_seq_nr > olsr->olsr_seqno) {
170     seq_diff = (uint32_t) olsr->olsr_seqno + 65536 - lnk->last_seq_nr;
171   } else {
172     seq_diff = olsr->olsr_seqno - lnk->last_seq_nr;
173   }
174
175   /* Jump in sequence numbers ? */
176   if (seq_diff > 256) {
177     seq_diff = 1;
178   }
179
180   lnk->received[lnk->activePtr]++;
181   lnk->lost[lnk->activePtr] += (seq_diff - 1);
182
183   lnk->last_seq_nr = olsr->olsr_seqno;
184   lnk->missed_seconds = 0;
185 }
186
187 static void
188 lq_etxff_timer(void __attribute__ ((unused)) * context)
189 {
190   struct link_entry *link;
191   OLSR_FOR_ALL_LINK_ENTRIES(link) {
192     struct lq_etxff_link_entry *lq_link;
193     uint32_t ratio;
194     uint16_t i, received, lost;
195
196 #ifndef REMOVE_LOG_DEBUG
197     struct ipaddr_str buf;
198     // struct lqtextbuffer lqbuffer;
199 #endif
200     lq_link = (struct lq_etxff_link_entry *)link;
201
202     OLSR_DEBUG(LOG_LQ_PLUGINS, "LQ-FF new entry for %s: rec: %d lost: %d",
203                olsr_ip_to_string(&buf, &link->neighbor_iface_addr),
204                lq_link->received[lq_link->activePtr], lq_link->lost[lq_link->activePtr]);
205
206     received = 0;
207     lost = 0;
208
209     /* enlarge window if still in quickstart phase */
210     if (lq_link->windowSize < LQ_FF_WINDOW) {
211       lq_link->windowSize++;
212     }
213     for (i = 0; i < lq_link->windowSize; i++) {
214       received += lq_link->received[i];
215       lost += lq_link->lost[i];
216     }
217
218     OLSR_DEBUG(LOG_LQ_PLUGINS, " total-rec: %d total-lost: %d", received, lost);
219
220     /* calculate link quality */
221     if (received + lost == 0) {
222       lq_link->lq.valueLq = 0;
223     } else {
224
225       /* keep missed hello periods in mind (round up hello interval to seconds) */
226       uint32_t missed_hello_cost = lq_link->missed_seconds / ((lq_link->core.link_loss_timer->timer_period + 999) / 1000);
227       lost += missed_hello_cost * missed_hello_cost;
228
229       // start with link-loss-factor
230       ratio = link->loss_link_multiplier;
231
232       // calculate received/(received + loss) factor
233       ratio = ratio * received;
234       ratio = ratio / (received + lost);
235       ratio = (ratio * 255) >> 16;
236
237       lq_link->lq.valueLq = (uint8_t) (ratio);
238     }
239
240     // shift buffer
241     lq_link->activePtr = (lq_link->activePtr + 1) % LQ_FF_WINDOW;
242     lq_link->lost[lq_link->activePtr] = 0;
243     lq_link->received[lq_link->activePtr] = 0;
244     lq_link->missed_seconds++;
245   }
246   OLSR_FOR_ALL_LINK_ENTRIES_END(link);
247 }
248
249 static struct timer_entry *lq_etxff_timer_struct = NULL;
250
251 static void
252 lq_etxff_initialize(void)
253 {
254   /* Some cookies for stats keeping */
255   olsr_packetparser_add_function(&lq_etxff_packet_parser);
256   default_lq_ff_timer_cookie = olsr_alloc_cookie("Default Freifunk LQ", OLSR_COOKIE_TYPE_TIMER);
257   lq_etxff_timer_struct = olsr_start_timer(1000, 0, OLSR_TIMER_PERIODIC, &lq_etxff_timer, NULL, default_lq_ff_timer_cookie);
258 }
259
260 static void
261 lq_etxff_deinitialize(void)
262 {
263   olsr_stop_timer(lq_etxff_timer_struct);
264   olsr_packetparser_remove_function(&lq_etxff_packet_parser);
265 }
266
267 static olsr_linkcost
268 lq_etxff_calc_linkcost(struct lq_etxff_linkquality *lq)
269 {
270   olsr_linkcost cost;
271
272   if (lq->valueLq < (unsigned int)(255 * MINIMAL_USEFUL_LQ) || lq->valueNlq < (unsigned int)(255 * MINIMAL_USEFUL_LQ)) {
273     return LINK_COST_BROKEN;
274   }
275
276   cost = 65536 * 255 / (int)lq->valueLq * 255 / (int)lq->valueNlq;
277
278   if (cost > LINK_COST_BROKEN)
279     return LINK_COST_BROKEN;
280   if (cost == 0)
281     return 1;
282   return cost;
283 }
284
285 static olsr_linkcost
286 lq_etxff_calc_link_entry_cost(struct link_entry *link)
287 {
288   struct lq_etxff_link_entry *lq_link = (struct lq_etxff_link_entry *)link;
289
290   return lq_etxff_calc_linkcost(&lq_link->lq);
291 }
292
293 static olsr_linkcost
294 lq_etxff_calc_lq_hello_neighbor_cost(struct lq_hello_neighbor *neigh)
295 {
296   struct lq_etxff_lq_hello_neighbor *lq_neigh = (struct lq_etxff_lq_hello_neighbor *)neigh;
297
298   return lq_etxff_calc_linkcost(&lq_neigh->lq);
299 }
300
301 static olsr_linkcost
302 lq_etxff_calc_tc_mpr_addr_cost(struct tc_mpr_addr *mpr)
303 {
304   struct lq_etxff_tc_mpr_addr *lq_mpr = (struct lq_etxff_tc_mpr_addr *)mpr;
305
306   return lq_etxff_calc_linkcost(&lq_mpr->lq);
307 }
308
309 static olsr_linkcost
310 lq_etxff_calc_tc_edge_entry_cost(struct tc_edge_entry *edge)
311 {
312   struct lq_etxff_tc_edge *lq_edge = (struct lq_etxff_tc_edge *)edge;
313
314   return lq_etxff_calc_linkcost(&lq_edge->lq);
315 }
316
317 static bool
318 lq_etxff_is_relevant_costchange(olsr_linkcost c1, olsr_linkcost c2)
319 {
320   if (c1 > c2) {
321     return c2 - c1 > LQ_PLUGIN_RELEVANT_COSTCHANGE_FF;
322   }
323   return c1 - c2 > LQ_PLUGIN_RELEVANT_COSTCHANGE_FF;
324 }
325
326 static olsr_linkcost
327 lq_etxff_packet_loss_handler(struct link_entry *link, bool loss __attribute__ ((unused)))
328 {
329   return lq_etxff_calc_link_entry_cost(link);
330 }
331
332 static void
333 lq_etxff_memorize_foreign_hello(struct link_entry *target, struct lq_hello_neighbor *source)
334 {
335   struct lq_etxff_link_entry *lq_target = (struct lq_etxff_link_entry *)target;
336   struct lq_etxff_lq_hello_neighbor *lq_source = (struct lq_etxff_lq_hello_neighbor *)source;
337
338   if (source) {
339     lq_target->lq.valueNlq = lq_source->lq.valueLq;
340   } else {
341     lq_target->lq.valueNlq = 0;
342   }
343
344 }
345
346 static void
347 lq_etxff_copy_link_entry_lq_into_tc_mpr_addr(struct tc_mpr_addr *target, struct link_entry *source)
348 {
349   struct lq_etxff_tc_mpr_addr *lq_target = (struct lq_etxff_tc_mpr_addr *)target;
350   struct lq_etxff_link_entry *lq_source = (struct lq_etxff_link_entry *)source;
351
352   lq_target->lq = lq_source->lq;
353 }
354
355 static void
356 lq_etxff_copy_link_entry_lq_into_tc_edge_entry(struct tc_edge_entry *target, struct link_entry *source)
357 {
358   struct lq_etxff_tc_edge *lq_target = (struct lq_etxff_tc_edge *)target;
359   struct lq_etxff_link_entry *lq_source = (struct lq_etxff_link_entry *)source;
360
361   lq_target->lq = lq_source->lq;
362 }
363
364 static void
365 lq_etxff_copy_link_lq_into_neighbor(struct lq_hello_neighbor *target, struct link_entry *source)
366 {
367   struct lq_etxff_lq_hello_neighbor *lq_target = (struct lq_etxff_lq_hello_neighbor *)target;
368   struct lq_etxff_link_entry *lq_source = (struct lq_etxff_link_entry *)source;
369
370   lq_target->lq = lq_source->lq;
371 }
372
373 static void
374 lq_etxff_clear_link_entry(struct link_entry *link)
375 {
376   struct lq_etxff_link_entry *lq_link = (struct lq_etxff_link_entry *)link;
377   int i;
378
379   lq_link->windowSize = LQ_FF_QUICKSTART_INIT;
380   for (i = 0; i < LQ_FF_WINDOW; i++) {
381     lq_link->lost[i] = 3;
382   }
383 }
384
385 static int
386 lq_etxff_serialize_hello_lq(unsigned char *buff, struct lq_hello_neighbor *neigh)
387 {
388   struct lq_etxff_lq_hello_neighbor *lq_neigh = (struct lq_etxff_lq_hello_neighbor *)neigh;
389
390   buff[0] = (unsigned char)lq_neigh->lq.valueLq;
391   buff[1] = (unsigned char)lq_neigh->lq.valueNlq;
392   buff[2] = (unsigned char)(0);
393   buff[3] = (unsigned char)(0);
394
395   return 4;
396 }
397 static int
398 lq_etxff_serialize_tc_lq(unsigned char *buff, struct tc_mpr_addr *mpr)
399 {
400   struct lq_etxff_tc_mpr_addr *lq_mpr = (struct lq_etxff_tc_mpr_addr *)mpr;
401
402   buff[0] = (unsigned char)lq_mpr->lq.valueLq;
403   buff[1] = (unsigned char)lq_mpr->lq.valueNlq;
404   buff[2] = (unsigned char)(0);
405   buff[3] = (unsigned char)(0);
406
407   return 4;
408 }
409
410 static void
411 lq_etxff_deserialize_hello_lq(uint8_t const **curr, struct lq_hello_neighbor *neigh)
412 {
413   struct lq_etxff_lq_hello_neighbor *lq_neigh = (struct lq_etxff_lq_hello_neighbor *)neigh;
414
415   pkt_get_u8(curr, &lq_neigh->lq.valueLq);
416   pkt_get_u8(curr, &lq_neigh->lq.valueNlq);
417   pkt_ignore_u16(curr);
418
419 }
420 static void
421 lq_etxff_deserialize_tc_lq(uint8_t const **curr, struct tc_edge_entry *edge)
422 {
423   struct lq_etxff_tc_edge *lq_edge = (struct lq_etxff_tc_edge *)edge;
424
425   pkt_get_u8(curr, &lq_edge->lq.valueLq);
426   pkt_get_u8(curr, &lq_edge->lq.valueNlq);
427   pkt_ignore_u16(curr);
428 }
429
430 static char *
431 lq_etxff_print_lq(struct lq_etxff_linkquality *lq, char separator, struct lqtextbuffer *buffer)
432 {
433   int i = 0;
434
435   if (lq->valueLq == 255) {
436     strcpy(buffer->buf, "1.000");
437     i += 5;
438   } else {
439     i = sprintf(buffer->buf, "0.%03d", (lq->valueLq * 1000) / 255);
440   }
441   buffer->buf[i++] = separator;
442
443   if (lq->valueNlq == 255) {
444     strcpy(&buffer->buf[i], "1.000");
445   } else {
446     sprintf(&buffer->buf[i], "0.%03d", (lq->valueNlq * 1000) / 255);
447   }
448   return buffer->buf;
449 }
450
451 static char *
452 lq_etxff_print_link_entry_lq(struct link_entry *link, char separator, struct lqtextbuffer *buffer)
453 {
454   struct lq_etxff_link_entry *lq_link = (struct lq_etxff_link_entry *)link;
455
456   return lq_etxff_print_lq(&lq_link->lq, separator, buffer);
457 }
458
459 static char *
460 lq_etxff_print_tc_edge_entry_lq(struct tc_edge_entry *edge, char separator, struct lqtextbuffer *buffer)
461 {
462   struct lq_etxff_tc_edge *lq_edge = (struct lq_etxff_tc_edge *)edge;
463
464   return lq_etxff_print_lq(&lq_edge->lq, separator, buffer);
465 }
466
467 static char *
468 lq_etxff_print_cost(olsr_linkcost cost, struct lqtextbuffer *buffer)
469 {
470   // must calculate
471   uint32_t roundDown = cost >> 16;
472   uint32_t fraction = ((cost & 0xffff) * 1000) >> 16;
473
474   sprintf(buffer->buf, "%u.%03u", roundDown, fraction);
475   return buffer->buf;
476 }
477
478 /*
479  * Local Variables:
480  * c-basic-offset: 2
481  * indent-tabs-mode: nil
482  * End:
483  */