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