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