6ad417b5a4d04642932408c788e9d79ff5089b5b
[olsrd.git] / src / lq_plugin_default_ff.c
1 /*
2  * The olsr.org Optimized Link-State Routing daemon(olsrd)
3  * Copyright (c) 2008 Henning Rogge <rogge@fgan.de>
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 "packet.h"
47 #include "olsr.h"
48 #include "lq_plugin_default_ff.h"
49 #include "parser.h"
50 #include "mid_set.h"
51 #include "scheduler.h"
52
53 /* etx lq plugin (freifunk fpm version) settings */
54 struct lq_handler lq_etx_ff_handler = {
55     &default_lq_initialize_ff,
56     &default_lq_calc_cost_ff,
57     &default_lq_calc_cost_ff,
58
59     &default_lq_is_relevant_costchange_ff,
60     &default_lq_packet_loss_worker_ff,
61
62     &default_lq_memorize_foreign_hello_ff,
63     &default_lq_copy_link2tc_ff,
64     &default_lq_clear_ff_hello,
65     &default_lq_clear_ff,
66
67     &default_lq_serialize_hello_lq_pair_ff,
68     &default_lq_serialize_tc_lq_pair_ff,
69     &default_lq_deserialize_hello_lq_pair_ff,
70     &default_lq_deserialize_tc_lq_pair_ff,
71
72     &default_lq_print_ff,
73     &default_lq_print_ff,
74     &default_lq_print_cost_ff,
75
76     sizeof(struct default_lq_ff_hello),
77     sizeof(struct default_lq_ff)
78 };
79
80 static char *default_lq_ff_linkcost2text(struct lqtextbuffer *buffer, olsr_linkcost cost) {
81         // must calculate
82         olsr_u32_t roundDown = cost >> 16;
83         olsr_u32_t fraction = ((cost & 0xffff) * 1000) >> 16;
84
85         sprintf(buffer->buf, "%u.%u", roundDown, fraction);
86         return buffer->buf;
87 }
88
89 static void default_lq_parser_ff(struct olsr *olsr, struct interface *in_if, union olsr_ip_addr *from_addr) {
90   const union olsr_ip_addr *main_addr;
91   struct link_entry *lnk;
92   struct default_lq_ff_hello *lq;
93   olsr_u32_t seq_diff;
94
95   /* Find main address */
96   main_addr = olsr_lookup_main_addr_by_alias(from_addr);
97
98   /* Loopup link entry */
99   lnk = lookup_link_entry(from_addr, main_addr, in_if);
100   if (lnk == NULL) {
101     return;
102   }
103
104   lq = (struct default_lq_ff_hello *)lnk->linkquality;
105
106   if (lq->last_seq_nr > olsr->olsr_seqno) {
107     seq_diff = (olsr_u32_t)olsr->olsr_seqno + 65536 - lq->last_seq_nr;
108   } else {
109     seq_diff = olsr->olsr_seqno - lq->last_seq_nr;
110   }
111
112   /* Jump in sequence numbers ? */
113   if (seq_diff > 256) {
114     seq_diff = 1;
115   }
116
117   lq->received[lq->activePtr]++;
118   lq->lost[lq->activePtr] += (seq_diff - 1);
119
120   lq->last_seq_nr = olsr->olsr_seqno;
121 }
122
123 static void default_lq_ff_timer(void __attribute__((unused)) *context) {
124   struct link_entry *link;
125   OLSR_FOR_ALL_LINK_ENTRIES(link) {
126     struct default_lq_ff_hello *tlq = (struct default_lq_ff_hello *)link->linkquality;
127     olsr_u32_t ratio;
128     olsr_u16_t i, received, lost;
129
130 #if !defined(NODEBUG) && defined(DEBUG)
131     struct ipaddr_str buf;
132     struct lqtextbuffer lqbuffer;
133
134     OLSR_PRINTF(3, "LQ-FF new entry for %s: rec: %u lost: %u",
135                 olsr_ip_to_string(&buf, &link->neighbor_iface_addr),
136                 tlq->received[tlq->activePtr], tlq->lost[tlq->activePtr]);
137 #endif
138     received = 0;
139     lost = 0;
140
141     /* enlarge window if still in quickstart phase */
142     if (tlq->windowSize < LQ_FF_WINDOW) {
143       tlq->windowSize++;
144     }
145     for (i=0; i < tlq->windowSize; i++) {
146       received += tlq->received[i];
147       lost += tlq->lost[i];
148     }
149
150 #if !defined(NODEBUG) && defined(DEBUG)
151     OLSR_PRINTF(3, " total-rec: %u total-lost: %u", received, lost);
152 #endif
153     /* calculate link quality */
154     if (received + lost == 0) {
155       tlq->lq.valueLq = 0;
156     }
157     else {
158       // start with link-loss-factor
159       ratio = link->loss_link_multiplier;
160
161       // calculate received/(received + loss) factor
162       ratio = ratio * received;
163       ratio = ratio / (received + lost);
164       ratio = (ratio * 255) >> 16;
165
166       tlq->lq.valueLq = (olsr_u8_t)(ratio);
167     }
168     link->linkcost = default_lq_calc_cost_ff(tlq);
169
170 #if !defined(NODEBUG) && defined(DEBUG)
171     OLSR_PRINTF(3, " linkcost: %s\n", default_lq_ff_linkcost2text(&lqbuffer, link->linkcost));
172 #endif
173
174     // shift buffer
175     tlq->activePtr = (tlq->activePtr + 1) % LQ_FF_WINDOW;
176     tlq->lost[tlq->activePtr] = 0;
177     tlq->received[tlq->activePtr] = 0;
178   }OLSR_FOR_ALL_LINK_ENTRIES_END(link);
179 }
180
181 void default_lq_initialize_ff(void) {
182   /* Some cookies for stats keeping */
183   static struct olsr_cookie_info *default_lq_ff_timer_cookie = NULL;
184
185   olsr_packetparser_add_function(&default_lq_parser_ff);
186   default_lq_ff_timer_cookie = olsr_alloc_cookie("Default Freifunk LQ",
187                                                  OLSR_COOKIE_TYPE_TIMER);
188   olsr_start_timer(1000, 0, OLSR_TIMER_PERIODIC, &default_lq_ff_timer, NULL,
189                    default_lq_ff_timer_cookie->ci_id);
190 }
191
192 olsr_linkcost default_lq_calc_cost_ff(const void *ptr) {
193   const struct default_lq_ff *lq = ptr;
194   olsr_linkcost cost;
195
196   if (lq->valueLq < (unsigned int)(255 * MINIMAL_USEFUL_LQ) || lq->valueNlq < (unsigned int)(255 * MINIMAL_USEFUL_LQ)) {
197     return LINK_COST_BROKEN;
198   }
199
200   cost = 65536 * lq->valueLq / 255 * lq->valueNlq / 255;
201
202   if (cost > LINK_COST_BROKEN)
203     return LINK_COST_BROKEN;
204   if (cost == 0)
205     return 1;
206   return cost;
207 }
208
209 int default_lq_serialize_hello_lq_pair_ff(unsigned char *buff, void *ptr) {
210   struct default_lq_ff *lq = ptr;
211
212   buff[0] = (unsigned char)lq->valueLq;
213   buff[1] = (unsigned char)lq->valueNlq;
214   buff[2] = (unsigned char)(0);
215   buff[3] = (unsigned char)(0);
216
217   return 4;
218 }
219
220 void default_lq_deserialize_hello_lq_pair_ff(const olsr_u8_t **curr, void *ptr) {
221   struct default_lq_ff *lq = ptr;
222
223   pkt_get_u8(curr, &lq->valueLq);
224   pkt_get_u8(curr, &lq->valueNlq);
225   pkt_ignore_u16(curr);
226 }
227
228 olsr_bool default_lq_is_relevant_costchange_ff(olsr_linkcost c1, olsr_linkcost c2) {
229   if (c1 > c2) {
230     return c2 - c1 > LQ_PLUGIN_RELEVANT_COSTCHANGE_FF;
231   }
232   return c1 - c2 > LQ_PLUGIN_RELEVANT_COSTCHANGE_FF;
233 }
234
235 int default_lq_serialize_tc_lq_pair_ff(unsigned char *buff, void *ptr) {
236   struct default_lq_ff *lq = ptr;
237
238   buff[0] = (unsigned char)lq->valueLq;
239   buff[1] = (unsigned char)lq->valueNlq;
240   buff[2] = (unsigned char)(0);
241   buff[3] = (unsigned char)(0);
242
243   return 4;
244 }
245
246 void default_lq_deserialize_tc_lq_pair_ff(const olsr_u8_t **curr, void *ptr) {
247   struct default_lq_ff *lq = ptr;
248
249   pkt_get_u8(curr, &lq->valueLq);
250   pkt_get_u8(curr, &lq->valueNlq);
251   pkt_ignore_u16(curr);
252 }
253
254 olsr_linkcost default_lq_packet_loss_worker_ff(struct link_entry __attribute__((unused)) *link, void __attribute__((unused)) *ptr, olsr_bool __attribute__((unused)) lost) {
255   return link->linkcost;
256 }
257
258 void default_lq_memorize_foreign_hello_ff(void *ptrLocal, void *ptrForeign) {
259   struct default_lq_ff *local = ptrLocal;
260   struct default_lq_ff *foreign = ptrForeign;
261
262   if (foreign) {
263     local->valueNlq = foreign->valueLq;
264   } else {
265     local->valueNlq = 0;
266   }
267 }
268
269 void default_lq_copy_link2tc_ff(void *target, void *source) {
270   memcpy(target, source, sizeof(struct default_lq_ff));
271 }
272
273 void default_lq_clear_ff(void *target) {
274   memset(target, 0, sizeof(struct default_lq_ff));
275 }
276
277 void default_lq_clear_ff_hello(void *target) {
278   struct default_lq_ff_hello *local = target;
279   int i;
280
281   default_lq_clear_ff(&local->lq);
282   local->windowSize = LQ_FF_QUICKSTART_INIT;
283   for (i=0; i<LQ_FF_WINDOW; i++) {
284     local->lost[i] = 3;
285   }
286 }
287
288 const char *default_lq_print_ff(void *ptr, char separator, struct lqtextbuffer *buffer) {
289   struct default_lq_ff *lq = ptr;
290   int i = 0;
291
292   memset(buffer, 0, sizeof(struct lqtextbuffer));
293
294   if (lq->valueLq == 255) {
295         strcpy(buffer->buf, "1.000");
296         i += 5;
297   }
298   else {
299         i = sprintf(buffer->buf, "0.%03ul", (lq->valueLq * 1000)/255);
300   }
301   buffer->buf[i++] = separator;
302
303   if (lq->valueNlq == 255) {
304         strcpy(&buffer->buf[i], "1.000");
305   }
306   else {
307         sprintf(&buffer->buf[i], "0.%03ul", (lq->valueNlq * 1000) / 255);
308   }
309   return buffer->buf;
310 }
311
312 const char *default_lq_print_cost_ff(olsr_linkcost cost, struct lqtextbuffer *buffer) {
313         default_lq_ff_linkcost2text(buffer, cost);
314   return buffer->buf;
315 }
316
317 /*
318  * Local Variables:
319  * c-basic-offset: 2
320  * indent-tabs-mode: nil
321  * End:
322  */