8d23c65d14fabfd462cbbd9a24233c16baab3d81
[olsrd.git] / src / lq_plugin_default_fpm.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 "lq_plugin.h"
45 #include "olsr_spf.h"
46 #include "lq_packet.h"
47 #include "packet.h"
48 #include "olsr.h"
49 #include "lq_plugin_default_fpm.h"
50
51 static void default_lq_initialize_fpm(void);
52 static olsr_linkcost default_lq_calc_cost_fpm(const void *lq);
53 static void default_lq_packet_loss_worker_fpm(struct link_entry *link, void *lq, bool lost);
54 static void default_lq_memorize_foreign_hello_fpm(void *local, void *foreign);
55 static int default_lq_serialize_hello_lq_pair_fpm(unsigned char *buff, void *lq);
56 static void default_lq_deserialize_hello_lq_pair_fpm(const uint8_t ** curr, void *lq);
57 static int default_lq_serialize_tc_lq_pair_fpm(unsigned char *buff, void *lq);
58 static void default_lq_deserialize_tc_lq_pair_fpm(const uint8_t ** curr, void *lq);
59 static void default_lq_copy_link2tc_fpm(void *target, void *source);
60 static void default_lq_clear_fpm(void *target);
61 static const char *default_lq_print_fpm(void *ptr, char separator, struct lqtextbuffer *buffer);
62 static const char *default_lq_print_cost_fpm(olsr_linkcost cost, struct lqtextbuffer *buffer);
63
64
65 /* etx lq plugin (fpm version) settings */
66 struct lq_handler lq_etx_fpm_handler = {
67   &default_lq_initialize_fpm,
68
69   &default_lq_calc_cost_fpm,
70   &default_lq_calc_cost_fpm,
71
72   &default_lq_packet_loss_worker_fpm,
73   &default_lq_memorize_foreign_hello_fpm,
74   &default_lq_copy_link2tc_fpm,
75   &default_lq_copy_link2tc_fpm,
76   &default_lq_clear_fpm,
77   &default_lq_clear_fpm,
78
79   &default_lq_serialize_hello_lq_pair_fpm,
80   &default_lq_serialize_tc_lq_pair_fpm,
81   &default_lq_deserialize_hello_lq_pair_fpm,
82   &default_lq_deserialize_tc_lq_pair_fpm,
83
84   &default_lq_print_fpm,
85   &default_lq_print_fpm,
86   &default_lq_print_cost_fpm,
87
88   sizeof(struct default_lq_fpm),
89   sizeof(struct default_lq_fpm)
90 };
91
92 uint32_t aging_factor_new, aging_factor_old;
93 uint32_t aging_quickstart_new, aging_quickstart_old;
94
95 static void
96 default_lq_initialize_fpm(void)
97 {
98   aging_factor_new = (uint32_t) (olsr_cnf->lq_aging * LQ_FPM_INTERNAL_MULTIPLIER);
99   aging_factor_old = LQ_FPM_INTERNAL_MULTIPLIER - aging_factor_new;
100
101   aging_quickstart_new = (uint32_t) (LQ_QUICKSTART_AGING * LQ_FPM_INTERNAL_MULTIPLIER);
102   aging_quickstart_old = LQ_FPM_INTERNAL_MULTIPLIER - aging_quickstart_new;
103 }
104
105 static olsr_linkcost
106 default_lq_calc_cost_fpm(const void *ptr)
107 {
108   const struct default_lq_fpm *lq = ptr;
109   olsr_linkcost cost;
110
111   if (lq->valueLq < (unsigned int)(255 * MINIMAL_USEFUL_LQ) || lq->valueNlq < (unsigned int)(255 * MINIMAL_USEFUL_LQ)) {
112     return LINK_COST_BROKEN;
113   }
114
115   cost = LQ_FPM_LINKCOST_MULTIPLIER * 255 / (int)lq->valueLq * 255 / (int)lq->valueNlq;
116
117   if (cost > LINK_COST_BROKEN)
118     return LINK_COST_BROKEN;
119   if (cost == 0)
120     return 1;
121   return cost;
122 }
123
124 static int
125 default_lq_serialize_hello_lq_pair_fpm(unsigned char *buff, void *ptr)
126 {
127   struct default_lq_fpm *lq = ptr;
128
129   buff[0] = (unsigned char)lq->valueLq;
130   buff[1] = (unsigned char)lq->valueNlq;
131   buff[2] = (unsigned char)(0);
132   buff[3] = (unsigned char)(0);
133
134   return 4;
135 }
136
137 static void
138 default_lq_deserialize_hello_lq_pair_fpm(const uint8_t ** curr, void *ptr)
139 {
140   struct default_lq_fpm *lq = ptr;
141
142   pkt_get_u8(curr, &lq->valueLq);
143   pkt_get_u8(curr, &lq->valueNlq);
144   pkt_ignore_u16(curr);
145 }
146
147 static int
148 default_lq_serialize_tc_lq_pair_fpm(unsigned char *buff, void *ptr)
149 {
150   struct default_lq_fpm *lq = ptr;
151
152   buff[0] = (unsigned char)lq->valueLq;
153   buff[1] = (unsigned char)lq->valueNlq;
154   buff[2] = (unsigned char)(0);
155   buff[3] = (unsigned char)(0);
156
157   return 4;
158 }
159
160 static void
161 default_lq_deserialize_tc_lq_pair_fpm(const uint8_t ** curr, void *ptr)
162 {
163   struct default_lq_fpm *lq = ptr;
164
165   pkt_get_u8(curr, &lq->valueLq);
166   pkt_get_u8(curr, &lq->valueNlq);
167   pkt_ignore_u16(curr);
168 }
169
170 static void
171 default_lq_packet_loss_worker_fpm(struct link_entry *link __attribute__ ((unused)), void *ptr, bool lost)
172 {
173   struct default_lq_fpm *tlq = ptr;
174   uint32_t alpha_old = aging_factor_old;
175   uint32_t alpha_new = aging_factor_new;
176
177   uint32_t value;
178
179   if (tlq->quickstart < LQ_QUICKSTART_STEPS) {
180     alpha_new = aging_quickstart_new;
181     alpha_old = aging_quickstart_old;
182     tlq->quickstart++;
183   }
184   // exponential moving average
185   value = (uint32_t) (tlq->valueLq) * LQ_FPM_INTERNAL_MULTIPLIER / 255;
186
187   value = (value * alpha_old + LQ_FPM_INTERNAL_MULTIPLIER - 1) / LQ_FPM_INTERNAL_MULTIPLIER;
188
189   if (!lost) {
190     uint32_t ratio;
191
192     ratio = (alpha_new * link->loss_link_multiplier + LINK_LOSS_MULTIPLIER - 1) / LINK_LOSS_MULTIPLIER;
193     value += ratio;
194   }
195   tlq->valueLq = (value * 255 + LQ_FPM_INTERNAL_MULTIPLIER - 1) / LQ_FPM_INTERNAL_MULTIPLIER;
196
197   link->linkcost = default_lq_calc_cost_fpm(ptr);
198   olsr_relevant_linkcost_change();
199 }
200
201 static void
202 default_lq_memorize_foreign_hello_fpm(void *ptrLocal, void *ptrForeign)
203 {
204   struct default_lq_fpm *local = ptrLocal;
205   struct default_lq_fpm *foreign = ptrForeign;
206
207   if (foreign) {
208     local->valueNlq = foreign->valueLq;
209   } else {
210     local->valueNlq = 0;
211   }
212 }
213
214 static void
215 default_lq_copy_link2tc_fpm(void *target, void *source)
216 {
217   memcpy(target, source, sizeof(struct default_lq_fpm));
218 }
219
220 static void
221 default_lq_clear_fpm(void *target)
222 {
223   memset(target, 0, sizeof(struct default_lq_fpm));
224 }
225
226 static const char *
227 default_lq_print_fpm(void *ptr, char separator, struct lqtextbuffer *buffer)
228 {
229   struct default_lq_fpm *lq = ptr;
230
231   snprintf(buffer->buf, sizeof(buffer->buf), "%0.3f%c%0.3f", (float)(lq->valueLq) / 255.0, separator,
232            (float)(lq->valueNlq) / 255.0);
233   return buffer->buf;
234 }
235
236 static const char *
237 default_lq_print_cost_fpm(olsr_linkcost cost, struct lqtextbuffer *buffer)
238 {
239   snprintf(buffer->buf, sizeof(buffer->buf), "%.3f", (float)(cost) / LQ_FPM_LINKCOST_MULTIPLIER);
240   return buffer->buf;
241 }
242
243 /*
244  * Local Variables:
245  * c-basic-offset: 2
246  * indent-tabs-mode: nil
247  * End:
248  */