08644d65bdf30ee524940e0192d0234c4edfa7c7
[olsrd.git] / lib / lq_etx_float / src / lq_plugin_etx_float.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 "olsr_spf.h"
45 #include "lq_packet.h"
46 #include "olsr.h"
47 #include "olsr_logging.h"
48 #include "lq_plugin_etx_float.h"
49
50 #define PLUGIN_DESCR    "Floating point based ETX metric with exponential aging"
51 #define PLUGIN_AUTHOR   "Henning Rogge and others"
52
53 #define LQ_PLUGIN_LC_MULTIPLIER 1024
54
55 static int set_plugin_float(const char *, void *, set_plugin_parameter_addon);
56 static int lq_etxfloat_post_init(void);
57
58 static olsr_linkcost lq_etxfloat_calc_link_entry_cost(struct link_entry *);
59 static olsr_linkcost lq_etxfloat_calc_lq_hello_neighbor_cost(struct lq_hello_neighbor *);
60 static olsr_linkcost lq_etxfloat_calc_tc_mpr_addr_cost(struct tc_mpr_addr *);
61 static olsr_linkcost lq_etxfloat_calc_tc_edge_entry_cost(struct tc_edge_entry *);
62
63 static bool lq_etxfloat_is_relevant_costchange(olsr_linkcost c1, olsr_linkcost c2);
64
65 static olsr_linkcost lq_etxfloat_packet_loss_handler(struct link_entry *, bool);
66
67 static void lq_etxfloat_memorize_foreign_hello(struct link_entry *, struct lq_hello_neighbor *);
68 static void lq_etxfloat_copy_link_entry_lq_into_tc_mpr_addr(struct tc_mpr_addr *target, struct link_entry *source);
69 static void lq_etxfloat_copy_link_entry_lq_into_tc_edge_entry(struct tc_edge_entry *target, struct link_entry *source);
70 static void lq_etxfloat_copy_link_lq_into_neighbor(struct lq_hello_neighbor *target, struct link_entry *source);
71
72 static int lq_etxfloat_serialize_hello_lq(unsigned char *buff, struct lq_hello_neighbor *lq);
73 static int lq_etxfloat_serialize_tc_lq(unsigned char *buff, struct tc_mpr_addr *lq);
74 static void lq_etxfloat_deserialize_hello_lq(uint8_t const **curr, struct lq_hello_neighbor *lq);
75 static void lq_etxfloat_deserialize_tc_lq(uint8_t const **curr, struct tc_edge_entry *lq);
76
77 static char *lq_etxfloat_print_link_entry_lq(struct link_entry *entry, char separator, struct lqtextbuffer *buffer);
78 static char *lq_etxfloat_print_tc_edge_entry_lq(struct tc_edge_entry *ptr, char separator, struct lqtextbuffer *buffer);
79 static char *lq_etxfloat_print_cost(olsr_linkcost cost, struct lqtextbuffer *buffer);
80
81 /* etx lq plugin (freifunk fpm version) settings */
82 struct lq_handler lq_etxfloat_handler = {
83   "etx (float)",
84
85   NULL,
86   NULL,
87
88   &lq_etxfloat_calc_link_entry_cost,
89   &lq_etxfloat_calc_lq_hello_neighbor_cost,
90   &lq_etxfloat_calc_tc_mpr_addr_cost,
91   &lq_etxfloat_calc_tc_edge_entry_cost,
92
93   &lq_etxfloat_is_relevant_costchange,
94
95   &lq_etxfloat_packet_loss_handler,
96
97   &lq_etxfloat_memorize_foreign_hello,
98   &lq_etxfloat_copy_link_entry_lq_into_tc_mpr_addr,
99   &lq_etxfloat_copy_link_entry_lq_into_tc_edge_entry,
100   &lq_etxfloat_copy_link_lq_into_neighbor,
101
102   NULL,
103   NULL,
104   NULL,
105   NULL,
106
107   &lq_etxfloat_serialize_hello_lq,
108   &lq_etxfloat_serialize_tc_lq,
109   &lq_etxfloat_deserialize_hello_lq,
110   &lq_etxfloat_deserialize_tc_lq,
111
112   &lq_etxfloat_print_link_entry_lq,
113   &lq_etxfloat_print_tc_edge_entry_lq,
114   &lq_etxfloat_print_cost,
115
116   sizeof(struct lq_etxfloat_tc_edge),
117   sizeof(struct lq_etxfloat_tc_mpr_addr),
118   sizeof(struct lq_etxfloat_lq_hello_neighbor),
119   sizeof(struct lq_etxfloat_link_entry),
120
121   LQ_HELLO_MESSAGE,
122   LQ_TC_MESSAGE
123 };
124
125 static float lq_aging = DEF_LQ_AGING;
126
127 static const struct olsrd_plugin_parameters plugin_parameters[] = {
128   {.name = "LinkQualityAging",.set_plugin_parameter = &set_plugin_float,.data = &lq_aging},
129 };
130
131 DEFINE_PLUGIN6(PLUGIN_DESCR, PLUGIN_AUTHOR, NULL, lq_etxfloat_post_init, NULL, NULL, false, plugin_parameters)
132
133 static int
134 set_plugin_float(const char *value, void *data, set_plugin_parameter_addon addon __attribute__ ((unused)))
135 {
136   if (data != NULL) {
137     sscanf(value, "%f", (float *)data);
138     OLSR_INFO(LOG_LQ_PLUGINS, "%s float %f\n", "Got", *(float *)data);
139   } else {
140     OLSR_INFO(LOG_LQ_PLUGINS, "%s float %s\n", "Ignored", value);
141   }
142   return 0;
143 }
144
145 static int lq_etxfloat_post_init(void) {
146   active_lq_handler = &lq_etxfloat_handler;
147   return 0;
148 }
149
150 static olsr_linkcost
151 lq_etxfloat_calc_linkcost(struct lq_etxfloat_linkquality *lq)
152 {
153   olsr_linkcost cost;
154
155   if (lq->valueLq < MINIMAL_USEFUL_LQ || lq->valueNlq < MINIMAL_USEFUL_LQ) {
156     return LINK_COST_BROKEN;
157   }
158
159   cost = (olsr_linkcost) (1.0 / (lq->valueLq * lq->valueNlq) * LQ_PLUGIN_LC_MULTIPLIER);
160
161   if (cost > LINK_COST_BROKEN)
162     return LINK_COST_BROKEN;
163   if (cost == 0) {
164     return 1;
165   }
166   return cost;
167 }
168
169 static olsr_linkcost
170 lq_etxfloat_calc_link_entry_cost(struct link_entry *link)
171 {
172   struct lq_etxfloat_link_entry *lq_link = (struct lq_etxfloat_link_entry *)link;
173
174   return lq_etxfloat_calc_linkcost(&lq_link->lq);
175 }
176
177 static olsr_linkcost
178 lq_etxfloat_calc_lq_hello_neighbor_cost(struct lq_hello_neighbor *neigh)
179 {
180   struct lq_etxfloat_lq_hello_neighbor *lq_neigh = (struct lq_etxfloat_lq_hello_neighbor *)neigh;
181
182   return lq_etxfloat_calc_linkcost(&lq_neigh->lq);
183 }
184
185 static olsr_linkcost
186 lq_etxfloat_calc_tc_mpr_addr_cost(struct tc_mpr_addr *mpr)
187 {
188   struct lq_etxfloat_tc_mpr_addr *lq_mpr = (struct lq_etxfloat_tc_mpr_addr *)mpr;
189
190   return lq_etxfloat_calc_linkcost(&lq_mpr->lq);
191 }
192
193 static olsr_linkcost
194 lq_etxfloat_calc_tc_edge_entry_cost(struct tc_edge_entry *edge)
195 {
196   struct lq_etxfloat_tc_edge *lq_edge = (struct lq_etxfloat_tc_edge *)edge;
197
198   return lq_etxfloat_calc_linkcost(&lq_edge->lq);
199 }
200
201 static bool
202 lq_etxfloat_is_relevant_costchange(olsr_linkcost c1, olsr_linkcost c2)
203 {
204   if (c1 > c2) {
205     return c2 - c1 > LQ_PLUGIN_RELEVANT_COSTCHANGE;
206   }
207   return c1 - c2 > LQ_PLUGIN_RELEVANT_COSTCHANGE;
208 }
209
210 static olsr_linkcost
211 lq_etxfloat_packet_loss_handler(struct link_entry *link, bool loss)
212 {
213   struct lq_etxfloat_link_entry *lq_link = (struct lq_etxfloat_link_entry *)link;
214
215   float alpha = lq_aging;
216
217   if (lq_link->quickstart < LQ_QUICKSTART_STEPS) {
218     alpha = LQ_QUICKSTART_AGING;        /* fast enough to get the LQ value within 6 Hellos up to 0.9 */
219     lq_link->quickstart++;
220   }
221   // exponential moving average
222   lq_link->lq.valueLq *= (1 - alpha);
223   if (!loss) {
224     lq_link->lq.valueLq += (alpha * link->loss_link_multiplier / 65536);
225   }
226   return lq_etxfloat_calc_linkcost(&lq_link->lq);
227 }
228
229 static void
230 lq_etxfloat_memorize_foreign_hello(struct link_entry *target, struct lq_hello_neighbor *source)
231 {
232   struct lq_etxfloat_link_entry *lq_target = (struct lq_etxfloat_link_entry *)target;
233   struct lq_etxfloat_lq_hello_neighbor *lq_source = (struct lq_etxfloat_lq_hello_neighbor *)source;
234
235   if (source) {
236     lq_target->lq.valueNlq = lq_source->lq.valueLq;
237   } else {
238     lq_target->lq.valueNlq = 0;
239   }
240
241 }
242
243 static void
244 lq_etxfloat_copy_link_entry_lq_into_tc_mpr_addr(struct tc_mpr_addr *target, struct link_entry *source)
245 {
246   struct lq_etxfloat_tc_mpr_addr *lq_target = (struct lq_etxfloat_tc_mpr_addr *)target;
247   struct lq_etxfloat_link_entry *lq_source = (struct lq_etxfloat_link_entry *)source;
248
249   lq_target->lq = lq_source->lq;
250 }
251
252 static void
253 lq_etxfloat_copy_link_entry_lq_into_tc_edge_entry(struct tc_edge_entry *target, struct link_entry *source)
254 {
255   struct lq_etxfloat_tc_edge *lq_target = (struct lq_etxfloat_tc_edge *)target;
256   struct lq_etxfloat_link_entry *lq_source = (struct lq_etxfloat_link_entry *)source;
257
258   lq_target->lq = lq_source->lq;
259 }
260
261 static void
262 lq_etxfloat_copy_link_lq_into_neighbor(struct lq_hello_neighbor *target, struct link_entry *source)
263 {
264   struct lq_etxfloat_lq_hello_neighbor *lq_target = (struct lq_etxfloat_lq_hello_neighbor *)target;
265   struct lq_etxfloat_link_entry *lq_source = (struct lq_etxfloat_link_entry *)source;
266
267   lq_target->lq = lq_source->lq;
268 }
269
270 static int
271 lq_etxfloat_serialize_hello_lq(unsigned char *buff, struct lq_hello_neighbor *neigh)
272 {
273   struct lq_etxfloat_lq_hello_neighbor *lq_neigh = (struct lq_etxfloat_lq_hello_neighbor *)neigh;
274
275   buff[0] = (unsigned char)(lq_neigh->lq.valueLq * 255);
276   buff[1] = (unsigned char)(lq_neigh->lq.valueNlq * 255);
277   buff[2] = (unsigned char)(0);
278   buff[3] = (unsigned char)(0);
279
280   return 4;
281 }
282 static int
283 lq_etxfloat_serialize_tc_lq(unsigned char *buff, struct tc_mpr_addr *mpr)
284 {
285   struct lq_etxfloat_tc_mpr_addr *lq_mpr = (struct lq_etxfloat_tc_mpr_addr *)mpr;
286
287   buff[0] = (unsigned char)(lq_mpr->lq.valueLq * 255);
288   buff[1] = (unsigned char)(lq_mpr->lq.valueNlq * 255);
289   buff[2] = (unsigned char)(0);
290   buff[3] = (unsigned char)(0);
291
292   return 4;
293 }
294
295 static void
296 lq_etxfloat_deserialize_hello_lq(uint8_t const **curr, struct lq_hello_neighbor *neigh)
297 {
298   struct lq_etxfloat_lq_hello_neighbor *lq_neigh = (struct lq_etxfloat_lq_hello_neighbor *)neigh;
299
300   uint8_t lq_value, nlq_value;
301
302   pkt_get_u8(curr, &lq_value);
303   pkt_get_u8(curr, &nlq_value);
304   pkt_ignore_u16(curr);
305
306   lq_neigh->lq.valueLq = (float)lq_value / 255.0;
307   lq_neigh->lq.valueNlq = (float)nlq_value / 255.0;
308 }
309
310 static void
311 lq_etxfloat_deserialize_tc_lq(uint8_t const **curr, struct tc_edge_entry *edge)
312 {
313   struct lq_etxfloat_tc_edge *lq_edge = (struct lq_etxfloat_tc_edge *)edge;
314
315   uint8_t lq_value, nlq_value;
316
317   pkt_get_u8(curr, &lq_value);
318   pkt_get_u8(curr, &nlq_value);
319   pkt_ignore_u16(curr);
320
321   lq_edge->lq.valueLq = (float)lq_value / 255.0;
322   lq_edge->lq.valueNlq = (float)nlq_value / 255.0;
323 }
324
325 static char *
326 lq_etxfloat_print_lq(struct lq_etxfloat_linkquality *lq, char separator, struct lqtextbuffer *buffer)
327 {
328   snprintf(buffer->buf, sizeof(struct lqtextbuffer), "%2.3f%c%2.3f", lq->valueLq, separator, lq->valueNlq);
329   return buffer->buf;
330 }
331
332 static char *
333 lq_etxfloat_print_link_entry_lq(struct link_entry *link, char separator, struct lqtextbuffer *buffer)
334 {
335   struct lq_etxfloat_link_entry *lq_link = (struct lq_etxfloat_link_entry *)link;
336
337   return lq_etxfloat_print_lq(&lq_link->lq, separator, buffer);
338 }
339
340 static char *
341 lq_etxfloat_print_tc_edge_entry_lq(struct tc_edge_entry *edge, char separator, struct lqtextbuffer *buffer)
342 {
343   struct lq_etxfloat_tc_edge *lq_edge = (struct lq_etxfloat_tc_edge *)edge;
344
345   return lq_etxfloat_print_lq(&lq_edge->lq, separator, buffer);
346 }
347
348 static char *
349 lq_etxfloat_print_cost(olsr_linkcost cost, struct lqtextbuffer *buffer)
350 {
351   // must calculate
352   snprintf(buffer->buf, sizeof(struct lqtextbuffer), "%2.3f", ((float)cost) / LQ_PLUGIN_LC_MULTIPLIER);
353   return buffer->buf;
354 }
355
356 /*
357  * Local Variables:
358  * c-basic-offset: 2
359  * indent-tabs-mode: nil
360  * End:
361  */