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