3b0e1d3f897014cf3cd367b38294548449cd508a
[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
55 /* etx lq plugin (freifunk fpm version) settings */
56 struct lq_handler lq_etx_ff_handler = {
57   &default_lq_initialize_ff,
58   &default_lq_calc_cost_ff,
59   &default_lq_calc_cost_ff,
60
61   &default_lq_is_relevant_costchange_ff,
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     return;
104   }
105
106   if (lq->last_seq_nr > olsr->olsr_seqno) {
107     seq_diff = (uint32_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
124 default_lq_ff_timer(void __attribute__ ((unused)) * context)
125 {
126   struct link_entry *link;
127   OLSR_FOR_ALL_LINK_ENTRIES(link) {
128     struct default_lq_ff_hello *tlq = (struct default_lq_ff_hello *)link->linkquality;
129     fpm ratio;
130     uint16_t i, received, lost;
131
132     received = 0;
133     lost = 0;
134
135     /* enlarge window if still in quickstart phase */
136     if (tlq->windowSize < LQ_FF_WINDOW) {
137       tlq->windowSize++;
138     }
139     for (i = 0; i < tlq->windowSize; i++) {
140       received += tlq->received[i];
141       lost += tlq->lost[i];
142     }
143
144     /* calculate link quality */
145     if (received + lost == 0) {
146       tlq->lq.valueLq = 0;
147     } else {
148       // start with link-loss-factor
149       ratio = fpmidiv(itofpm(link->loss_link_multiplier), 65536);
150
151       // calculate received/(received + loss) factor
152       ratio = fpmmuli(ratio, (int)received);
153       ratio = fpmidiv(ratio, (int)(received + lost));
154       ratio = fpmmuli(ratio, 255);
155
156       tlq->lq.valueLq = (uint8_t) (fpmtoi(ratio));
157     }
158     link->linkcost = default_lq_calc_cost_ff(tlq);
159
160     // shift buffer
161     tlq->activePtr = (tlq->activePtr + 1) % LQ_FF_WINDOW;
162     tlq->lost[tlq->activePtr] = 0;
163     tlq->received[tlq->activePtr] = 0;
164   } OLSR_FOR_ALL_LINK_ENTRIES_END(link);
165 }
166
167 void
168 default_lq_initialize_ff(void)
169 {
170   olsr_packetparser_add_function(&default_lq_parser_ff);
171   olsr_start_timer(1000, 0, OLSR_TIMER_PERIODIC, &default_lq_ff_timer, NULL, 0);
172 }
173
174 olsr_linkcost
175 default_lq_calc_cost_ff(const void *ptr)
176 {
177   const struct default_lq_ff *lq = ptr;
178   olsr_linkcost cost;
179
180   if (lq->valueLq < (unsigned int)(255 * MINIMAL_USEFUL_LQ) || lq->valueNlq < (unsigned int)(255 * MINIMAL_USEFUL_LQ)) {
181     return LINK_COST_BROKEN;
182   }
183
184   cost = fpmidiv(itofpm(255 * 255), (int)lq->valueLq * (int)lq->valueNlq);
185
186   if (cost > LINK_COST_BROKEN)
187     return LINK_COST_BROKEN;
188   if (cost == 0)
189     return 1;
190   return cost;
191 }
192
193 int
194 default_lq_serialize_hello_lq_pair_ff(unsigned char *buff, void *ptr)
195 {
196   struct default_lq_ff *lq = ptr;
197
198   buff[0] = (unsigned char)lq->valueLq;
199   buff[1] = (unsigned char)lq->valueNlq;
200   buff[2] = (unsigned char)(0);
201   buff[3] = (unsigned char)(0);
202
203   return 4;
204 }
205
206 void
207 default_lq_deserialize_hello_lq_pair_ff(const uint8_t ** curr, void *ptr)
208 {
209   struct default_lq_ff *lq = ptr;
210
211   pkt_get_u8(curr, &lq->valueLq);
212   pkt_get_u8(curr, &lq->valueNlq);
213   pkt_ignore_u16(curr);
214 }
215
216 bool
217 default_lq_is_relevant_costchange_ff(olsr_linkcost c1, olsr_linkcost c2)
218 {
219   if (c1 > c2) {
220     return c2 - c1 > LQ_PLUGIN_RELEVANT_COSTCHANGE_FF;
221   }
222   return c1 - c2 > LQ_PLUGIN_RELEVANT_COSTCHANGE_FF;
223 }
224
225 int
226 default_lq_serialize_tc_lq_pair_ff(unsigned char *buff, void *ptr)
227 {
228   struct default_lq_ff *lq = ptr;
229
230   buff[0] = (unsigned char)lq->valueLq;
231   buff[1] = (unsigned char)lq->valueNlq;
232   buff[2] = (unsigned char)(0);
233   buff[3] = (unsigned char)(0);
234
235   return 4;
236 }
237
238 void
239 default_lq_deserialize_tc_lq_pair_ff(const uint8_t ** curr, void *ptr)
240 {
241   struct default_lq_ff *lq = ptr;
242
243   pkt_get_u8(curr, &lq->valueLq);
244   pkt_get_u8(curr, &lq->valueNlq);
245   pkt_ignore_u16(curr);
246 }
247
248 olsr_linkcost
249 default_lq_packet_loss_worker_ff(struct link_entry
250                                  __attribute__ ((unused)) * link, void
251                                  __attribute__ ((unused)) * ptr, bool __attribute__ ((unused)) lost)
252 {
253   return link->linkcost;
254 }
255
256 void
257 default_lq_memorize_foreign_hello_ff(void *ptrLocal, void *ptrForeign)
258 {
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
270 default_lq_copy_link2tc_ff(void *target, void *source)
271 {
272   memcpy(target, source, sizeof(struct default_lq_ff));
273 }
274
275 void
276 default_lq_clear_ff(void *target)
277 {
278   memset(target, 0, sizeof(struct default_lq_ff));
279 }
280
281 void
282 default_lq_clear_ff_hello(void *target)
283 {
284   struct default_lq_ff_hello *local = target;
285   int i;
286
287   default_lq_clear_ff(&local->lq);
288   local->windowSize = LQ_FF_QUICKSTART_INIT;
289   for (i = 0; i < LQ_FF_WINDOW; i++) {
290     local->lost[i] = 3;
291   }
292 }
293
294 const char *
295 default_lq_print_ff(void *ptr, char separator, struct lqtextbuffer *buffer)
296 {
297   struct default_lq_ff *lq = ptr;
298
299   snprintf(buffer->buf, sizeof(buffer->buf), "%s%c%s", fpmtoa(fpmidiv(itofpm((int)lq->valueLq), 255)), separator,
300            fpmtoa(fpmidiv(itofpm((int)lq->valueNlq), 255)));
301   return buffer->buf;
302 }
303
304 const char *
305 default_lq_print_cost_ff(olsr_linkcost cost, struct lqtextbuffer *buffer)
306 {
307   snprintf(buffer->buf, sizeof(buffer->buf), "%s", fpmtoa(cost));
308   return buffer->buf;
309 }
310
311 /*
312  * Local Variables:
313  * c-basic-offset: 2
314  * indent-tabs-mode: nil
315  * End:
316  */