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