Fix bug in ext_fpm I introduced two months ago.
[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
56 /* etx lq plugin (freifunk fpm version) settings */
57 struct lq_handler lq_etx_ff_handler = {
58   &default_lq_initialize_ff,
59   &default_lq_calc_cost_ff,
60   &default_lq_calc_cost_ff,
61
62   &default_lq_packet_loss_worker_ff,
63
64   &default_lq_memorize_foreign_hello_ff,
65   &default_lq_copy_link2tc_ff,
66   &default_lq_clear_ff_hello,
67   &default_lq_clear_ff,
68
69   &default_lq_serialize_hello_lq_pair_ff,
70   &default_lq_serialize_tc_lq_pair_ff,
71   &default_lq_deserialize_hello_lq_pair_ff,
72   &default_lq_deserialize_tc_lq_pair_ff,
73
74   &default_lq_print_ff,
75   &default_lq_print_ff,
76   &default_lq_print_cost_ff,
77
78   sizeof(struct default_lq_ff_hello),
79   sizeof(struct default_lq_ff)
80 };
81
82 static void
83 default_lq_parser_ff(struct olsr *olsr, struct interface *in_if, union olsr_ip_addr *from_addr)
84 {
85   const union olsr_ip_addr *main_addr;
86   struct link_entry *lnk;
87   struct default_lq_ff_hello *lq;
88   uint32_t seq_diff;
89
90   /* Find main address */
91   main_addr = mid_lookup_main_addr(from_addr);
92
93   /* Loopup link entry */
94   lnk = lookup_link_entry(from_addr, main_addr, in_if);
95   if (lnk == NULL) {
96     return;
97   }
98
99   lq = (struct default_lq_ff_hello *)lnk->linkquality;
100
101   /* ignore double package */
102   if (lq->last_seq_nr == olsr->olsr_seqno) {
103     struct ipaddr_str buf;
104     olsr_syslog(OLSR_LOG_INFO, "detected duplicate packet with seqnr %d from %s on %s (%d Bytes)",
105                 olsr->olsr_seqno,olsr_ip_to_string(&buf, from_addr),in_if->int_name,ntohs(olsr->olsr_packlen));
106     return;
107   }
108
109   if (lq->last_seq_nr > olsr->olsr_seqno) {
110     seq_diff = (uint32_t) olsr->olsr_seqno + 65536 - lq->last_seq_nr;
111   } else {
112     seq_diff = olsr->olsr_seqno - lq->last_seq_nr;
113   }
114
115   /* Jump in sequence numbers ? */
116   if (seq_diff > 256) {
117     seq_diff = 1;
118   }
119
120   lq->received[lq->activePtr]++;
121   lq->lost[lq->activePtr] += (seq_diff - 1);
122
123   lq->last_seq_nr = olsr->olsr_seqno;
124 }
125
126 static void
127 default_lq_ff_timer(void __attribute__ ((unused)) * context)
128 {
129   struct link_entry *link;
130   OLSR_FOR_ALL_LINK_ENTRIES(link) {
131     struct default_lq_ff_hello *tlq = (struct default_lq_ff_hello *)link->linkquality;
132     fpm ratio;
133     uint16_t i, received, lost;
134
135     received = 0;
136     lost = 0;
137
138     /* enlarge window if still in quickstart phase */
139     if (tlq->windowSize < LQ_FF_WINDOW) {
140       tlq->windowSize++;
141     }
142     for (i = 0; i < tlq->windowSize; i++) {
143       received += tlq->received[i];
144       lost += tlq->lost[i];
145     }
146
147     /* calculate link quality */
148     if (received + lost == 0) {
149       tlq->lq.valueLq = 0;
150     } else {
151       // start with link-loss-factor
152       ratio = fpmidiv(itofpm(link->loss_link_multiplier), 65536);
153
154       // calculate received/(received + loss) factor
155       ratio = fpmmuli(ratio, (int)received);
156       ratio = fpmidiv(ratio, (int)(received + lost));
157       ratio = fpmmuli(ratio, 255);
158
159       tlq->lq.valueLq = (uint8_t) (fpmtoi(ratio));
160     }
161     link->linkcost = default_lq_calc_cost_ff(tlq);
162
163     // shift buffer
164     tlq->activePtr = (tlq->activePtr + 1) % LQ_FF_WINDOW;
165     tlq->lost[tlq->activePtr] = 0;
166     tlq->received[tlq->activePtr] = 0;
167   } OLSR_FOR_ALL_LINK_ENTRIES_END(link);
168 }
169
170 void
171 default_lq_initialize_ff(void)
172 {
173   olsr_packetparser_add_function(&default_lq_parser_ff);
174   olsr_start_timer(1000, 0, OLSR_TIMER_PERIODIC, &default_lq_ff_timer, NULL, 0);
175 }
176
177 olsr_linkcost
178 default_lq_calc_cost_ff(const void *ptr)
179 {
180   const struct default_lq_ff *lq = ptr;
181   olsr_linkcost cost;
182
183   if (lq->valueLq < (unsigned int)(255 * MINIMAL_USEFUL_LQ) || lq->valueNlq < (unsigned int)(255 * MINIMAL_USEFUL_LQ)) {
184     return LINK_COST_BROKEN;
185   }
186
187   cost = fpmidiv(itofpm(255 * 255), (int)lq->valueLq * (int)lq->valueNlq);
188
189   if (cost > LINK_COST_BROKEN)
190     return LINK_COST_BROKEN;
191   if (cost == 0)
192     return 1;
193   return cost;
194 }
195
196 int
197 default_lq_serialize_hello_lq_pair_ff(unsigned char *buff, void *ptr)
198 {
199   struct default_lq_ff *lq = ptr;
200
201   buff[0] = (unsigned char)lq->valueLq;
202   buff[1] = (unsigned char)lq->valueNlq;
203   buff[2] = (unsigned char)(0);
204   buff[3] = (unsigned char)(0);
205
206   return 4;
207 }
208
209 void
210 default_lq_deserialize_hello_lq_pair_ff(const uint8_t ** curr, void *ptr)
211 {
212   struct default_lq_ff *lq = ptr;
213
214   pkt_get_u8(curr, &lq->valueLq);
215   pkt_get_u8(curr, &lq->valueNlq);
216   pkt_ignore_u16(curr);
217 }
218
219 int
220 default_lq_serialize_tc_lq_pair_ff(unsigned char *buff, void *ptr)
221 {
222   struct default_lq_ff *lq = ptr;
223
224   buff[0] = (unsigned char)lq->valueLq;
225   buff[1] = (unsigned char)lq->valueNlq;
226   buff[2] = (unsigned char)(0);
227   buff[3] = (unsigned char)(0);
228
229   return 4;
230 }
231
232 void
233 default_lq_deserialize_tc_lq_pair_ff(const uint8_t ** curr, void *ptr)
234 {
235   struct default_lq_ff *lq = ptr;
236
237   pkt_get_u8(curr, &lq->valueLq);
238   pkt_get_u8(curr, &lq->valueNlq);
239   pkt_ignore_u16(curr);
240 }
241
242 olsr_linkcost
243 default_lq_packet_loss_worker_ff(struct link_entry
244                                  __attribute__ ((unused)) * link, void
245                                  __attribute__ ((unused)) * ptr, bool __attribute__ ((unused)) lost)
246 {
247   return link->linkcost;
248 }
249
250 void
251 default_lq_memorize_foreign_hello_ff(void *ptrLocal, void *ptrForeign)
252 {
253   struct default_lq_ff *local = ptrLocal;
254   struct default_lq_ff *foreign = ptrForeign;
255
256   if (foreign) {
257     local->valueNlq = foreign->valueLq;
258   } else {
259     local->valueNlq = 0;
260   }
261 }
262
263 void
264 default_lq_copy_link2tc_ff(void *target, void *source)
265 {
266   memcpy(target, source, sizeof(struct default_lq_ff));
267 }
268
269 void
270 default_lq_clear_ff(void *target)
271 {
272   memset(target, 0, sizeof(struct default_lq_ff));
273 }
274
275 void
276 default_lq_clear_ff_hello(void *target)
277 {
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 *
289 default_lq_print_ff(void *ptr, char separator, struct lqtextbuffer *buffer)
290 {
291   struct default_lq_ff *lq = ptr;
292
293   snprintf(buffer->buf, sizeof(buffer->buf), "%s%c%s", fpmtoa(fpmidiv(itofpm((int)lq->valueLq), 255)), separator,
294            fpmtoa(fpmidiv(itofpm((int)lq->valueNlq), 255)));
295   return buffer->buf;
296 }
297
298 const char *
299 default_lq_print_cost_ff(olsr_linkcost cost, struct lqtextbuffer *buffer)
300 {
301   snprintf(buffer->buf, sizeof(buffer->buf), "%s", fpmtoa(cost));
302   return buffer->buf;
303 }
304
305 /*
306  * Local Variables:
307  * c-basic-offset: 2
308  * indent-tabs-mode: nil
309  * End:
310  */