1be34ebae8a8d4508618ff24a94cf20bba28e2f1
[olsrd.git] / src / lq_plugin_default.c
1 /*
2  * The olsr.org Optimized Link-State Routing daemon(olsrd)
3  * Copyright (c) 2008 Henning Rogge <rogge@fgan.de>
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without 
7  * modification, are permitted provided that the following conditions 
8  * are met:
9  *
10  * * Redistributions of source code must retain the above copyright 
11  *   notice, this list of conditions and the following disclaimer.
12  * * Redistributions in binary form must reproduce the above copyright 
13  *   notice, this list of conditions and the following disclaimer in 
14  *   the documentation and/or other materials provided with the 
15  *   distribution.
16  * * Neither the name of olsr.org, olsrd nor the names of its 
17  *   contributors may be used to endorse or promote products derived 
18  *   from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 
23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 
24  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
26  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
27  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
28  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 
30  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
31  * POSSIBILITY OF SUCH DAMAGE.
32  *
33  * Visit http://www.olsr.org for more information.
34  *
35  * If you find this software useful feel free to make a donation
36  * to the project. For more information see the website or contact
37  * the copyright holders.
38  *
39  */
40
41 #include "tc_set.h"
42 #include "link_set.h"
43 #include "lq_route.h"
44 #include "lq_packet.h"
45 #include "packet.h"
46 #include "olsr.h"
47 #include "lq_plugin_default.h"
48
49 olsr_linkcost default_calc_cost(const void *ptr) {
50   const struct default_lq *lq = ptr;
51   
52   float etx = (lq->lq < 0.1 || lq->nlq < 0.1 ? LINK_COST_BROKEN : 1.0/(lq->lq * lq->nlq));
53   olsr_linkcost cost = (olsr_linkcost)(etx  * LQ_PLUGIN_LC_MULTIPLIER);
54   
55   if (cost > LINK_COST_BROKEN)
56     return LINK_COST_BROKEN;
57   if (cost == 0)
58     return 1;
59   return cost;
60 }
61
62 int default_olsr_serialize_hello_lq_pair(unsigned char *buff, void *ptr) {
63   struct default_lq *lq = ptr;
64   
65   olsr_u16_t lq_value = (olsr_u16_t)(lq->lq * 65535);
66   olsr_u16_t nlq_value = (olsr_u16_t)(lq->nlq * 65535);
67   
68   buff[0] = (unsigned char)(lq_value / 256);
69   buff[1] = (unsigned char)(nlq_value / 256);
70   buff[2] = (unsigned char)(lq_value & 255);
71   buff[3] = (unsigned char)(nlq_value & 255);
72   
73   return 4;
74 }
75
76 void default_olsr_deserialize_hello_lq_pair(const olsr_u8_t **curr, void *ptr) {
77   struct default_lq *lq = ptr;
78   
79   olsr_u8_t lq_high, lq_low, nlq_high, nlq_low;
80   olsr_u16_t lq_value, nlq_value;
81   
82   pkt_get_u8(curr, &lq_high);
83   pkt_get_u8(curr, &nlq_high);
84   pkt_get_u8(curr, &lq_low);
85   pkt_get_u8(curr, &nlq_low);
86   
87   lq_value = 256 * (olsr_u16_t)lq_high + (olsr_u16_t)lq_low;
88   nlq_value = 256 * (olsr_u16_t)nlq_high + (olsr_u16_t)nlq_low;
89   
90   lq->lq = (float)lq_value / 65535.0;
91   lq->nlq = (float)nlq_value / 65535.0;
92 }
93
94 olsr_bool default_olsr_is_relevant_costchange(olsr_linkcost c1, olsr_linkcost c2) {
95   if (c1 > c2) {
96     return c2 - c1 > LQ_PLUGIN_RELEVANT_COSTCHANGE;
97   }
98   return c1 - c2 > LQ_PLUGIN_RELEVANT_COSTCHANGE;
99 }
100
101 int default_olsr_serialize_tc_lq_pair(unsigned char *buff, void *ptr) {
102   struct default_lq *lq = ptr;
103   
104   olsr_u16_t lq_value = (olsr_u16_t)(lq->lq * 65535);
105   olsr_u16_t nlq_value = (olsr_u16_t)(lq->nlq * 65535);
106   
107   buff[0] = (unsigned char)(lq_value / 256);
108   buff[1] = (unsigned char)(nlq_value / 256);
109   buff[2] = (unsigned char)(lq_value & 255);
110   buff[3] = (unsigned char)(nlq_value & 255);
111   
112   return 4;
113 }
114
115 void default_olsr_deserialize_tc_lq_pair(const olsr_u8_t **curr, void *ptr) {
116   struct default_lq *lq = ptr;
117   
118   olsr_u8_t lq_high, lq_low, nlq_high, nlq_low;
119   olsr_u16_t lq_value, nlq_value;
120   
121   pkt_get_u8(curr, &lq_high);
122   pkt_get_u8(curr, &nlq_high);
123   pkt_get_u8(curr, &lq_low);
124   pkt_get_u8(curr, &nlq_low);
125   
126   lq_value = 256 * (olsr_u16_t)lq_high + (olsr_u16_t)lq_low;
127   nlq_value = 256 * (olsr_u16_t)nlq_high + (olsr_u16_t)nlq_low;
128   
129   lq->lq = (float)lq_value / 65535.0;
130   lq->nlq = (float)nlq_value / 65535.0;
131 }
132
133 olsr_linkcost default_packet_loss_worker(void *ptr, olsr_bool lost) {
134   struct default_lq *tlq = ptr;
135   float alpha;
136   
137   // calculate exponental factor for the new link quality, could be directly done in configuration !
138   alpha = 1 / (float)(olsr_cnf->lq_wsize);
139   
140   // exponential moving average
141   tlq->lq *= (1 - alpha);
142   if (lost == 0) {
143     tlq->lq += alpha;
144   }
145   return default_calc_cost(ptr);
146 }
147
148 void default_olsr_memorize_foreign_hello_lq(void *ptrLocal, void *ptrForeign) {
149   struct default_lq *local = ptrLocal;
150   struct default_lq *foreign = ptrForeign;
151   
152   if (foreign) {
153     local->nlq = foreign->lq;
154   }
155   else {
156     local->nlq = 0;
157   }
158 }
159
160 void default_olsr_copy_link_lq_into_tc(void *target, void *source) {
161   memcpy(target, source, sizeof(struct default_lq));
162 }
163
164 void default_olsr_clear_lq(void *target) {
165   memset(target, 0, sizeof(struct default_lq));
166 }
167
168 const char *default_olsr_print_lq(void *ptr, struct lqtextbuffer *buffer) {
169   struct default_lq *lq = ptr;
170   
171   sprintf(buffer->buf, "%2.3f/%2.3f", lq->lq, lq->nlq);
172   return buffer->buf;
173 }
174
175 const char *default_olsr_print_cost(olsr_linkcost cost, struct lqtextbuffer *buffer) {
176   sprintf(buffer->buf, "%2.3f", ((float)cost)/LQ_PLUGIN_LC_MULTIPLIER);
177   return buffer->buf;
178 }