Improvement for lq_ff metric (goes slowly down if no packages are received over a...
[olsrd.git] / lib / lq_etx_ff / src / lq_plugin_etx_ff.c
1 /*
2  * The olsr.org Optimized Link-State Routing daemon(olsrd)
3  * Copyright (c) 2004-2009, the olsr.org team - see HISTORY file
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  *
10  * * Redistributions of source code must retain the above copyright
11  *   notice, this list of conditions and the following disclaimer.
12  * * Redistributions in binary form must reproduce the above copyright
13  *   notice, this list of conditions and the following disclaimer in
14  *   the documentation and/or other materials provided with the
15  *   distribution.
16  * * Neither the name of olsr.org, olsrd nor the names of its
17  *   contributors may be used to endorse or promote products derived
18  *   from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
24  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
26  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
27  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
28  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
30  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31  * POSSIBILITY OF SUCH DAMAGE.
32  *
33  * Visit http://www.olsr.org for more information.
34  *
35  * If you find this software useful feel free to make a donation
36  * to the project. For more information see the website or contact
37  * the copyright holders.
38  *
39  */
40
41 #include "tc_set.h"
42 #include "link_set.h"
43 #include "lq_plugin.h"
44 #include "olsr_spf.h"
45 #include "lq_packet.h"
46 #include "olsr.h"
47 #include "lq_plugin_etx_ff.h"
48 #include "parser.h"
49 #include "mid_set.h"
50 #include "scheduler.h"
51
52 #define LQ_PLUGIN_RELEVANT_COSTCHANGE_FF 16
53
54 static void lq_etxff_initialize(void);
55 static void lq_etxff_deinitialize(void);
56
57 static olsr_linkcost lq_etxff_calc_link_entry_cost(struct link_entry *);
58 static olsr_linkcost lq_etxff_calc_lq_hello_neighbor_cost(
59     struct lq_hello_neighbor *);
60 static olsr_linkcost lq_etxff_calc_tc_mpr_addr_cost(struct tc_mpr_addr *);
61 static olsr_linkcost lq_etxff_calc_tc_edge_entry_cost(struct tc_edge_entry *);
62
63 static bool lq_etxff_is_relevant_costchange(olsr_linkcost c1, olsr_linkcost c2);
64
65 static olsr_linkcost lq_etxff_packet_loss_handler(struct link_entry *, bool);
66
67 static void lq_etxff_memorize_foreign_hello(struct link_entry *,
68     struct lq_hello_neighbor *);
69 static void lq_etxff_copy_link_entry_lq_into_tc_mpr_addr(
70     struct tc_mpr_addr *target, struct link_entry *source);
71 static void lq_etxff_copy_link_entry_lq_into_tc_edge_entry(
72     struct tc_edge_entry *target, struct link_entry *source);
73 static void lq_etxff_copy_link_lq_into_neighbor(struct lq_hello_neighbor *target,
74     struct link_entry *source);
75
76 static void lq_etxff_clear_link_entry(struct link_entry *);
77
78 static int lq_etxff_serialize_hello_lq(unsigned char *buff,
79     struct lq_hello_neighbor *lq);
80 static int lq_etxff_serialize_tc_lq(unsigned char *buff, struct tc_mpr_addr *lq);
81 static void lq_etxff_deserialize_hello_lq(uint8_t const ** curr,
82     struct lq_hello_neighbor *lq);
83 static void lq_etxff_deserialize_tc_lq(uint8_t const ** curr,
84     struct tc_edge_entry *lq);
85
86 static char *lq_etxff_print_link_entry_lq(struct link_entry *entry, char separator,
87     struct lqtextbuffer *buffer);
88 static char *lq_etxff_print_tc_edge_entry_lq(struct tc_edge_entry *ptr,
89     char separator, struct lqtextbuffer * buffer);
90 static char *lq_etxff_print_cost(olsr_linkcost cost, struct lqtextbuffer * buffer);
91
92 static struct olsr_cookie_info *default_lq_ff_timer_cookie = NULL;
93
94 /* etx lq plugin (freifunk fpm version) settings */
95 struct lq_handler lq_etxff_handler = {
96   &lq_etxff_initialize,
97   &lq_etxff_deinitialize,
98
99   &lq_etxff_calc_link_entry_cost,
100   &lq_etxff_calc_lq_hello_neighbor_cost,
101   &lq_etxff_calc_tc_mpr_addr_cost,
102   &lq_etxff_calc_tc_edge_entry_cost,
103
104   &lq_etxff_is_relevant_costchange,
105
106   &lq_etxff_packet_loss_handler,
107
108   &lq_etxff_memorize_foreign_hello,
109   &lq_etxff_copy_link_entry_lq_into_tc_mpr_addr,
110   &lq_etxff_copy_link_entry_lq_into_tc_edge_entry,
111   &lq_etxff_copy_link_lq_into_neighbor,
112
113   &lq_etxff_clear_link_entry,
114   NULL,
115   NULL,
116   NULL,
117
118   &lq_etxff_serialize_hello_lq,
119   &lq_etxff_serialize_tc_lq,
120   &lq_etxff_deserialize_hello_lq,
121   &lq_etxff_deserialize_tc_lq,
122
123   &lq_etxff_print_link_entry_lq,
124   &lq_etxff_print_tc_edge_entry_lq,
125   &lq_etxff_print_cost,
126
127   sizeof(struct lq_etxff_tc_edge),
128   sizeof(struct lq_etxff_tc_mpr_addr),
129   sizeof(struct lq_etxff_lq_hello_neighbor),
130   sizeof(struct lq_etxff_link_entry),
131
132   LQ_HELLO_MESSAGE,
133   LQ_TC_MESSAGE
134 };
135
136 static void lq_etxff_packet_parser(struct olsr *olsr, struct interface *in_if,
137     union olsr_ip_addr *from_addr) {
138   const union olsr_ip_addr *main_addr;
139   struct lq_etxff_link_entry *lnk;
140   uint32_t seq_diff;
141
142   /* Find main address */
143   main_addr = olsr_lookup_main_addr_by_alias(from_addr);
144
145   /* Loopup link entry */
146   lnk = (struct lq_etxff_link_entry *) lookup_link_entry(from_addr, main_addr,
147       in_if);
148   if (lnk == NULL) {
149     return;
150   }
151
152   if (lnk->last_seq_nr > olsr->olsr_seqno) {
153     seq_diff = (uint32_t) olsr->olsr_seqno + 65536 - lnk->last_seq_nr;
154   } else {
155     seq_diff = olsr->olsr_seqno - lnk->last_seq_nr;
156   }
157
158   /* Jump in sequence numbers ? */
159   if (seq_diff > 256) {
160     seq_diff = 1;
161   }
162
163   lnk->received[lnk->activePtr]++;
164   lnk->lost[lnk->activePtr] += (seq_diff - 1);
165
166   lnk->last_seq_nr = olsr->olsr_seqno;
167   lnk->missed_seconds = 0;
168 }
169
170 static void lq_etxff_timer(void __attribute__((unused)) *context) {
171   struct link_entry *link;
172   OLSR_FOR_ALL_LINK_ENTRIES(link)
173   {
174     struct lq_etxff_link_entry *lq_link;
175     uint32_t ratio;
176     uint16_t i, received, lost;
177
178 #if !defined(NODEBUG) && defined(DEBUG)
179     struct ipaddr_str buf;
180     struct lqtextbuffer lqbuffer;
181 #endif
182
183     lq_link = (struct lq_etxff_link_entry *)link;
184
185 #if !defined(NODEBUG) && defined(DEBUG)
186     OLSR_PRINTF(3, "LQ-FF new entry for %s: rec: %d lost: %d",
187         olsr_ip_to_string(&buf, &link->neighbor_iface_addr),
188         lq_link->received[lq_link->activePtr], lq_link->lost[lq_link->activePtr]);
189 #endif
190
191     received = 0;
192     lost = 0;
193
194     /* enlarge window if still in quickstart phase */
195     if (lq_link->windowSize < LQ_FF_WINDOW) {
196       lq_link->windowSize++;
197     }
198     for (i=0; i < lq_link->windowSize; i++) {
199       received += lq_link->received[i];
200       lost += lq_link->lost[i];
201     }
202
203 #if !defined(NODEBUG) && defined(DEBUG)
204     OLSR_PRINTF(3, " total-rec: %d total-lost: %d", received, lost);
205 #endif
206     /* calculate link quality */
207     if (received + lost == 0) {
208       lq_link->lq.valueLq = 0;
209     }
210     else {
211       /* keep missed hello periods in mind (round up hello interval to seconds) */
212       lost += lq_link->missed_seconds / ((lq_link->core.link_loss_timer->timer_period + 999) / 1000);
213
214       // start with link-loss-factor
215       ratio = link->loss_link_multiplier;
216
217       // calculate received/(received + loss) factor
218       ratio = ratio * received;
219       ratio = ratio / (received + lost);
220       ratio = (ratio * 255) >> 16;
221
222       lq_link->lq.valueLq = (uint8_t)(ratio);
223     }
224     link->linkcost = lq_etxff_calc_link_entry_cost(link);
225
226 #if !defined(NODEBUG) && defined(DEBUG)
227     OLSR_PRINTF(3, " linkcost: %s\n", lq_etxff_print_cost(link->linkcost, &lqbuffer));
228 #endif
229
230     // shift buffer
231     lq_link->activePtr = (lq_link->activePtr + 1) % LQ_FF_WINDOW;
232     lq_link->lost[lq_link->activePtr] = 0;
233     lq_link->received[lq_link->activePtr] = 0;
234     lq_link->missed_seconds++;
235   }OLSR_FOR_ALL_LINK_ENTRIES_END(link);
236 }
237
238 static struct timer_entry *lq_etxff_timer_struct = NULL;
239
240 static void lq_etxff_initialize(void) {
241   /* Some cookies for stats keeping */
242   olsr_packetparser_add_function(&lq_etxff_packet_parser);
243   default_lq_ff_timer_cookie = olsr_alloc_cookie("Default Freifunk LQ",
244       OLSR_COOKIE_TYPE_TIMER);
245   lq_etxff_timer_struct = olsr_start_timer(1000, 0, OLSR_TIMER_PERIODIC,
246       &lq_etxff_timer, NULL, default_lq_ff_timer_cookie->ci_id);
247 }
248
249 static void lq_etxff_deinitialize(void) {
250   olsr_stop_timer(lq_etxff_timer_struct);
251   olsr_packetparser_remove_function(&lq_etxff_packet_parser);
252 }
253
254 static olsr_linkcost lq_etxff_calc_linkcost(struct lq_etxff_linkquality *lq) {
255   olsr_linkcost cost;
256
257   if (lq->valueLq < (unsigned int) (255 * MINIMAL_USEFUL_LQ) || lq->valueNlq
258       < (unsigned int) (255 * MINIMAL_USEFUL_LQ)) {
259     return LINK_COST_BROKEN;
260   }
261
262   cost = 65536 * 255/(int)lq->valueLq * 255/(int)lq->valueNlq;
263
264   if (cost > LINK_COST_BROKEN)
265     return LINK_COST_BROKEN;
266   if (cost == 0)
267     return 1;
268   return cost;
269 }
270
271 static olsr_linkcost lq_etxff_calc_link_entry_cost(struct link_entry *link) {
272   struct lq_etxff_link_entry *lq_link = (struct lq_etxff_link_entry *) link;
273
274   return lq_etxff_calc_linkcost(&lq_link->lq);
275 }
276
277 static olsr_linkcost lq_etxff_calc_lq_hello_neighbor_cost(
278     struct lq_hello_neighbor *neigh) {
279   struct lq_etxff_lq_hello_neighbor *lq_neigh =
280       (struct lq_etxff_lq_hello_neighbor *) neigh;
281
282   return lq_etxff_calc_linkcost(&lq_neigh->lq);
283 }
284
285 static olsr_linkcost lq_etxff_calc_tc_mpr_addr_cost(struct tc_mpr_addr *mpr) {
286   struct lq_etxff_tc_mpr_addr *lq_mpr = (struct lq_etxff_tc_mpr_addr *) mpr;
287
288   return lq_etxff_calc_linkcost(&lq_mpr->lq);
289 }
290
291 static olsr_linkcost lq_etxff_calc_tc_edge_entry_cost(struct tc_edge_entry *edge) {
292   struct lq_etxff_tc_edge *lq_edge = (struct lq_etxff_tc_edge *) edge;
293
294   return lq_etxff_calc_linkcost(&lq_edge->lq);
295 }
296
297 static bool lq_etxff_is_relevant_costchange(olsr_linkcost c1, olsr_linkcost c2) {
298   if (c1 > c2) {
299     return c2 - c1 > LQ_PLUGIN_RELEVANT_COSTCHANGE_FF;
300   }
301   return c1 - c2 > LQ_PLUGIN_RELEVANT_COSTCHANGE_FF;
302 }
303
304 static olsr_linkcost lq_etxff_packet_loss_handler(struct link_entry *link,
305     bool loss __attribute__((unused))) {
306   return link->linkcost;
307 }
308
309 static void lq_etxff_memorize_foreign_hello(struct link_entry *target,
310     struct lq_hello_neighbor *source) {
311   struct lq_etxff_link_entry *lq_target = (struct lq_etxff_link_entry *) target;
312   struct lq_etxff_lq_hello_neighbor *lq_source =
313       (struct lq_etxff_lq_hello_neighbor *) source;
314
315   if (source) {
316     lq_target->lq.valueNlq = lq_source->lq.valueLq;
317   } else {
318     lq_target->lq.valueNlq = 0;
319   }
320
321 }
322
323 static void lq_etxff_copy_link_entry_lq_into_tc_mpr_addr(
324     struct tc_mpr_addr *target, struct link_entry *source) {
325   struct lq_etxff_tc_mpr_addr *lq_target = (struct lq_etxff_tc_mpr_addr *) target;
326   struct lq_etxff_link_entry *lq_source = (struct lq_etxff_link_entry *) source;
327
328   lq_target->lq = lq_source->lq;
329 }
330
331 static void lq_etxff_copy_link_entry_lq_into_tc_edge_entry(
332     struct tc_edge_entry *target, struct link_entry *source) {
333   struct lq_etxff_tc_edge *lq_target = (struct lq_etxff_tc_edge *) target;
334   struct lq_etxff_link_entry *lq_source = (struct lq_etxff_link_entry *) source;
335
336   lq_target->lq = lq_source->lq;
337 }
338
339 static void lq_etxff_copy_link_lq_into_neighbor(struct lq_hello_neighbor *target,
340     struct link_entry *source) {
341   struct lq_etxff_lq_hello_neighbor *lq_target =
342       (struct lq_etxff_lq_hello_neighbor *) target;
343   struct lq_etxff_link_entry *lq_source = (struct lq_etxff_link_entry *) source;
344
345   lq_target->lq = lq_source->lq;
346 }
347
348 static void lq_etxff_clear_link_entry(struct link_entry *link) {
349   struct lq_etxff_link_entry *lq_link = (struct lq_etxff_link_entry *) link;
350   int i;
351
352   lq_link->windowSize = LQ_FF_QUICKSTART_INIT;
353   for (i = 0; i < LQ_FF_WINDOW; i++) {
354     lq_link->lost[i] = 3;
355   }
356 }
357
358 static int lq_etxff_serialize_hello_lq(unsigned char *buff,
359     struct lq_hello_neighbor *neigh) {
360   struct lq_etxff_lq_hello_neighbor *lq_neigh =
361       (struct lq_etxff_lq_hello_neighbor *) neigh;
362
363   buff[0] = (unsigned char) lq_neigh->lq.valueLq;
364   buff[1] = (unsigned char) lq_neigh->lq.valueNlq;
365   buff[2] = (unsigned char) (0);
366   buff[3] = (unsigned char) (0);
367
368   return 4;
369 }
370 static int lq_etxff_serialize_tc_lq(unsigned char *buff, struct tc_mpr_addr *mpr) {
371   struct lq_etxff_tc_mpr_addr *lq_mpr = (struct lq_etxff_tc_mpr_addr *) mpr;
372
373   buff[0] = (unsigned char) lq_mpr->lq.valueLq;
374   buff[1] = (unsigned char) lq_mpr->lq.valueNlq;
375   buff[2] = (unsigned char) (0);
376   buff[3] = (unsigned char) (0);
377
378   return 4;
379 }
380
381 static void lq_etxff_deserialize_hello_lq(uint8_t const ** curr,
382     struct lq_hello_neighbor *neigh) {
383   struct lq_etxff_lq_hello_neighbor *lq_neigh =
384       (struct lq_etxff_lq_hello_neighbor *) neigh;
385
386   pkt_get_u8(curr, &lq_neigh->lq.valueLq);
387   pkt_get_u8(curr, &lq_neigh->lq.valueNlq);
388   pkt_ignore_u16(curr);
389
390 }
391 static void lq_etxff_deserialize_tc_lq(uint8_t const ** curr,
392     struct tc_edge_entry *edge) {
393   struct lq_etxff_tc_edge *lq_edge = (struct lq_etxff_tc_edge *) edge;
394
395   pkt_get_u8(curr, &lq_edge->lq.valueLq);
396   pkt_get_u8(curr, &lq_edge->lq.valueNlq);
397   pkt_ignore_u16(curr);
398 }
399
400 static char *lq_etxff_print_lq(struct lq_etxff_linkquality *lq, char separator,
401     struct lqtextbuffer *buffer) {
402   int i = 0;
403
404   if (lq->valueLq == 255) {
405         strcpy(buffer->buf, "1.000");
406         i += 5;
407   }
408   else {
409     i = sprintf(buffer->buf, "0.%03d", (lq->valueLq * 1000)/255);
410   }
411   buffer->buf[i++] = separator;
412
413   if (lq->valueNlq == 255) {
414     strcpy(&buffer->buf[i], "1.000");
415   }
416   else {
417     sprintf(&buffer->buf[i], "0.%03d", (lq->valueNlq * 1000) / 255);
418   }
419   return buffer->buf;
420 }
421
422 static char *lq_etxff_print_link_entry_lq(struct link_entry *link, char separator,
423     struct lqtextbuffer *buffer) {
424   struct lq_etxff_link_entry *lq_link = (struct lq_etxff_link_entry *) link;
425
426   return lq_etxff_print_lq(&lq_link->lq, separator, buffer);
427 }
428
429 static char *lq_etxff_print_tc_edge_entry_lq(struct tc_edge_entry *edge,
430     char separator, struct lqtextbuffer * buffer) {
431   struct lq_etxff_tc_edge *lq_edge = (struct lq_etxff_tc_edge *) edge;
432
433   return lq_etxff_print_lq(&lq_edge->lq, separator, buffer);
434 }
435
436 static char *lq_etxff_print_cost(olsr_linkcost cost, struct lqtextbuffer * buffer) {
437   // must calculate
438   uint32_t roundDown = cost >> 16;
439   uint32_t fraction = ((cost & 0xffff) * 1000) >> 16;
440
441   sprintf(buffer->buf, "%u.%03u", roundDown, fraction);
442   return buffer->buf;
443 }
444
445 /*
446  * Local Variables:
447  * c-basic-offset: 2
448  * indent-tabs-mode: nil
449  * End:
450  */