Re-implement zebra socket reconnecting
[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 };
90
91 static void
92 default_lq_initialize_float(void)
93 {
94   return;
95 }
96
97 static olsr_linkcost
98 default_lq_calc_cost_float(const void *ptr)
99 {
100   const struct default_lq_float *lq = ptr;
101   olsr_linkcost cost;
102
103   if (lq->lq < MINIMAL_USEFUL_LQ || lq->nlq < MINIMAL_USEFUL_LQ) {
104     return LINK_COST_BROKEN;
105   }
106
107   cost = (olsr_linkcost) (1.0 / (lq->lq * lq->nlq) * LQ_PLUGIN_LC_MULTIPLIER);
108
109   if (cost > LINK_COST_BROKEN)
110     return LINK_COST_BROKEN;
111   if (cost == 0) {
112     return 1;
113   }
114   return cost;
115 }
116
117 static int
118 default_lq_serialize_hello_lq_pair_float(unsigned char *buff, void *ptr)
119 {
120   struct default_lq_float *lq = ptr;
121
122   buff[0] = (unsigned char)(lq->lq * 255);
123   buff[1] = (unsigned char)(lq->nlq * 255);
124   buff[2] = 0;
125   buff[3] = 0;
126
127   return 4;
128 }
129
130 static void
131 default_lq_deserialize_hello_lq_pair_float(const uint8_t ** curr, void *ptr)
132 {
133   struct default_lq_float *lq = ptr;
134   uint8_t lq_value, nlq_value;
135
136   pkt_get_u8(curr, &lq_value);
137   pkt_get_u8(curr, &nlq_value);
138   pkt_ignore_u16(curr);
139
140   lq->lq = (float)lq_value / 255.0;
141   lq->nlq = (float)nlq_value / 255.0;
142 }
143
144 static int
145 default_lq_serialize_tc_lq_pair_float(unsigned char *buff, void *ptr)
146 {
147   struct default_lq_float *lq = ptr;
148
149   buff[0] = (unsigned char)(lq->lq * 255);
150   buff[1] = (unsigned char)(lq->nlq * 255);
151   buff[2] = 0;
152   buff[3] = 0;
153
154   return 4;
155 }
156
157 static void
158 default_lq_deserialize_tc_lq_pair_float(const uint8_t ** curr, void *ptr)
159 {
160   struct default_lq_float *lq = ptr;
161   uint8_t lq_value, nlq_value;
162
163   pkt_get_u8(curr, &lq_value);
164   pkt_get_u8(curr, &nlq_value);
165   pkt_ignore_u16(curr);
166
167   lq->lq = (float)lq_value / 255.0;
168   lq->nlq = (float)nlq_value / 255.0;
169 }
170
171 static void
172 default_lq_packet_loss_worker_float(struct link_entry *link, void *ptr, bool lost)
173 {
174   struct default_lq_float *tlq = ptr;
175   float alpha = olsr_cnf->lq_aging;
176
177   if (tlq->quickstart < LQ_QUICKSTART_STEPS) {
178     alpha = LQ_QUICKSTART_AGING;        /* fast enough to get the LQ value within 6 Hellos up to 0.9 */
179     tlq->quickstart++;
180   }
181   // exponential moving average
182   tlq->lq *= (1 - alpha);
183   if (lost == 0) {
184     tlq->lq += (alpha * link->loss_link_multiplier / 65536);
185   }
186   link->linkcost = default_lq_calc_cost_float(ptr);
187   olsr_relevant_linkcost_change();
188 }
189
190 static void
191 default_lq_memorize_foreign_hello_float(void *ptrLocal, void *ptrForeign)
192 {
193   struct default_lq_float *local = ptrLocal;
194   struct default_lq_float *foreign = ptrForeign;
195
196   if (foreign) {
197     local->nlq = foreign->lq;
198   } else {
199     local->nlq = 0;
200   }
201 }
202
203 static void
204 default_lq_copy_link2tc_float(void *target, void *source)
205 {
206   memcpy(target, source, sizeof(struct default_lq_float));
207 }
208
209 static void
210 default_lq_clear_float(void *target)
211 {
212   memset(target, 0, sizeof(struct default_lq_float));
213 }
214
215 static const char *
216 default_lq_print_float(void *ptr, char separator, struct lqtextbuffer *buffer)
217 {
218   struct default_lq_float *lq = ptr;
219
220   snprintf(buffer->buf, sizeof(struct lqtextbuffer), "%2.3f%c%2.3f", lq->lq, separator, lq->nlq);
221   return buffer->buf;
222 }
223
224 static const char *
225 default_lq_print_cost_float(olsr_linkcost cost, struct lqtextbuffer *buffer)
226 {
227   snprintf(buffer->buf, sizeof(struct lqtextbuffer), "%2.3f", ((float)cost) / LQ_PLUGIN_LC_MULTIPLIER);
228
229   return buffer->buf;
230 }
231
232 /*
233  * Local Variables:
234  * c-basic-offset: 2
235  * indent-tabs-mode: nil
236  * End:
237  */