Makefile: WARNINGS: add -Wdouble-promotion
[olsrd.git] / src / lq_plugin_default_float.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 "olsr_spf.h"
45 #include "lq_packet.h"
46 #include "packet.h"
47 #include "olsr.h"
48 #include "lq_plugin_default_float.h"
49
50 static void default_lq_initialize_float(void);
51 static olsr_linkcost default_lq_calc_cost_float(const void *lq);
52 static void default_lq_packet_loss_worker_float(struct link_entry *link, void *lq, bool lost);
53 static void default_lq_memorize_foreign_hello_float(void *local, void *foreign);
54 static int default_lq_serialize_hello_lq_pair_float(unsigned char *buff, void *lq);
55 static void default_lq_deserialize_hello_lq_pair_float(const uint8_t ** curr, void *lq);
56 static int default_lq_serialize_tc_lq_pair_float(unsigned char *buff, void *lq);
57 static void default_lq_deserialize_tc_lq_pair_float(const uint8_t ** curr, void *lq);
58 static void default_lq_copy_link2tc_float(void *target, void *source);
59 static void default_lq_clear_float(void *target);
60 static const char *default_lq_print_float(void *ptr, char separator, struct lqtextbuffer *buffer);
61 static const char *default_lq_print_cost_float(olsr_linkcost cost, struct lqtextbuffer *buffer);
62
63
64 /* Default lq plugin settings */
65 struct lq_handler lq_etx_float_handler = {
66   &default_lq_initialize_float,
67
68   &default_lq_calc_cost_float,
69   &default_lq_calc_cost_float,
70
71   &default_lq_packet_loss_worker_float,
72   &default_lq_memorize_foreign_hello_float,
73   &default_lq_copy_link2tc_float,
74   &default_lq_copy_link2tc_float,
75   &default_lq_clear_float,
76   &default_lq_clear_float,
77
78   &default_lq_serialize_hello_lq_pair_float,
79   &default_lq_serialize_tc_lq_pair_float,
80   &default_lq_deserialize_hello_lq_pair_float,
81   &default_lq_deserialize_tc_lq_pair_float,
82
83   &default_lq_print_float,
84   &default_lq_print_float,
85   &default_lq_print_cost_float,
86
87   sizeof(struct default_lq_float),
88   sizeof(struct default_lq_float),
89   4,
90   4
91 };
92
93 static void
94 default_lq_initialize_float(void)
95 {
96   return;
97 }
98
99 static olsr_linkcost
100 default_lq_calc_cost_float(const void *ptr)
101 {
102   const struct default_lq_float *lq = ptr;
103   olsr_linkcost cost;
104
105   if (lq->lq < (float)MINIMAL_USEFUL_LQ || lq->nlq < (float)MINIMAL_USEFUL_LQ) {
106     return LINK_COST_BROKEN;
107   }
108
109   cost = (olsr_linkcost) (1.0f / (lq->lq * lq->nlq) * (float)LQ_PLUGIN_LC_MULTIPLIER);
110
111   if (cost > LINK_COST_BROKEN)
112     return LINK_COST_BROKEN;
113   if (cost == 0) {
114     return 1;
115   }
116   return cost;
117 }
118
119 static int
120 default_lq_serialize_hello_lq_pair_float(unsigned char *buff, void *ptr)
121 {
122   struct default_lq_float *lq = ptr;
123
124   buff[0] = (unsigned char)(lq->lq * 255);
125   buff[1] = (unsigned char)(lq->nlq * 255);
126   buff[2] = 0;
127   buff[3] = 0;
128
129   return 4;
130 }
131
132 static void
133 default_lq_deserialize_hello_lq_pair_float(const uint8_t ** curr, void *ptr)
134 {
135   struct default_lq_float *lq = ptr;
136   uint8_t lq_value, nlq_value;
137
138   pkt_get_u8(curr, &lq_value);
139   pkt_get_u8(curr, &nlq_value);
140   pkt_ignore_u16(curr);
141
142   lq->lq = (float)lq_value / 255.0f;
143   lq->nlq = (float)nlq_value / 255.0f;
144 }
145
146 static int
147 default_lq_serialize_tc_lq_pair_float(unsigned char *buff, void *ptr)
148 {
149   struct default_lq_float *lq = ptr;
150
151   buff[0] = (unsigned char)(lq->lq * 255);
152   buff[1] = (unsigned char)(lq->nlq * 255);
153   buff[2] = 0;
154   buff[3] = 0;
155
156   return 4;
157 }
158
159 static void
160 default_lq_deserialize_tc_lq_pair_float(const uint8_t ** curr, void *ptr)
161 {
162   struct default_lq_float *lq = ptr;
163   uint8_t lq_value, nlq_value;
164
165   pkt_get_u8(curr, &lq_value);
166   pkt_get_u8(curr, &nlq_value);
167   pkt_ignore_u16(curr);
168
169   lq->lq = (float)lq_value / 255.0f;
170   lq->nlq = (float)nlq_value / 255.0f;
171 }
172
173 static void
174 default_lq_packet_loss_worker_float(struct link_entry *link, void *ptr, bool lost)
175 {
176   struct default_lq_float *tlq = ptr;
177   float alpha = olsr_cnf->lq_aging;
178
179   if (tlq->quickstart < LQ_QUICKSTART_STEPS) {
180     alpha = LQ_QUICKSTART_AGING;        /* fast enough to get the LQ value within 6 Hellos up to 0.9 */
181     tlq->quickstart++;
182   }
183   // exponential moving average
184   tlq->lq *= (1 - alpha);
185   if (lost == 0) {
186     tlq->lq += (alpha * link->loss_link_multiplier / 65536);
187   }
188   link->linkcost = default_lq_calc_cost_float(ptr);
189   olsr_relevant_linkcost_change();
190 }
191
192 static void
193 default_lq_memorize_foreign_hello_float(void *ptrLocal, void *ptrForeign)
194 {
195   struct default_lq_float *local = ptrLocal;
196   struct default_lq_float *foreign = ptrForeign;
197
198   if (foreign) {
199     local->nlq = foreign->lq;
200   } else {
201     local->nlq = 0;
202   }
203 }
204
205 static void
206 default_lq_copy_link2tc_float(void *target, void *source)
207 {
208   memcpy(target, source, sizeof(struct default_lq_float));
209 }
210
211 static void
212 default_lq_clear_float(void *target)
213 {
214   memset(target, 0, sizeof(struct default_lq_float));
215 }
216
217 static const char *
218 default_lq_print_float(void *ptr, char separator, struct lqtextbuffer *buffer)
219 {
220   struct default_lq_float *lq = ptr;
221
222   snprintf(buffer->buf, sizeof(struct lqtextbuffer), "%2.3f%c%2.3f", (double)lq->lq, separator, (double)lq->nlq);
223   return buffer->buf;
224 }
225
226 static const char *
227 default_lq_print_cost_float(olsr_linkcost cost, struct lqtextbuffer *buffer)
228 {
229   snprintf(buffer->buf, sizeof(struct lqtextbuffer), "%2.3f", (double)(((float)cost) / (float)LQ_PLUGIN_LC_MULTIPLIER));
230
231   return buffer->buf;
232 }
233
234 /*
235  * Local Variables:
236  * c-basic-offset: 2
237  * indent-tabs-mode: nil
238  * End:
239  */