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