5ee36f33314d8a0f85aa5177e84bf7b590f42349
[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   olsr_linkcost cost;
52   
53   if (lq->lq < 0.1 || lq->nlq < 0.1) {
54     return LINK_COST_BROKEN;
55   }
56   
57   cost = (olsr_linkcost)(1.0/(lq->lq * lq->nlq) * LQ_PLUGIN_LC_MULTIPLIER);
58   
59   if (cost > LINK_COST_BROKEN)
60     return LINK_COST_BROKEN;
61   if (cost == 0) {
62     return 1;
63   }
64   return cost;
65 }
66
67 int default_olsr_serialize_hello_lq_pair(unsigned char *buff, void *ptr) {
68   struct default_lq *lq = ptr;
69   
70   olsr_u16_t lq_value = (olsr_u16_t)(lq->lq * 65535);
71   olsr_u16_t nlq_value = (olsr_u16_t)(lq->nlq * 65535);
72   
73   buff[0] = (unsigned char)(lq_value / 256);
74   buff[1] = (unsigned char)(nlq_value / 256);
75   buff[2] = (unsigned char)(lq_value & 255);
76   buff[3] = (unsigned char)(nlq_value & 255);
77   
78   return 4;
79 }
80
81 void default_olsr_deserialize_hello_lq_pair(const olsr_u8_t **curr, void *ptr) {
82   struct default_lq *lq = ptr;
83   
84   olsr_u8_t lq_high, lq_low, nlq_high, nlq_low;
85   olsr_u16_t lq_value, nlq_value;
86   
87   pkt_get_u8(curr, &lq_high);
88   pkt_get_u8(curr, &nlq_high);
89   pkt_get_u8(curr, &lq_low);
90   pkt_get_u8(curr, &nlq_low);
91   
92   lq_value = 256 * (olsr_u16_t)lq_high + (olsr_u16_t)lq_low;
93   nlq_value = 256 * (olsr_u16_t)nlq_high + (olsr_u16_t)nlq_low;
94   
95   lq->lq = (float)lq_value / 65535.0;
96   lq->nlq = (float)nlq_value / 65535.0;
97 }
98
99 olsr_bool default_olsr_is_relevant_costchange(olsr_linkcost c1, olsr_linkcost c2) {
100   if (c1 > c2) {
101     return c2 - c1 > LQ_PLUGIN_RELEVANT_COSTCHANGE;
102   }
103   return c1 - c2 > LQ_PLUGIN_RELEVANT_COSTCHANGE;
104 }
105
106 int default_olsr_serialize_tc_lq_pair(unsigned char *buff, void *ptr) {
107   struct default_lq *lq = ptr;
108   
109   olsr_u16_t lq_value = (olsr_u16_t)(lq->lq * 65535);
110   olsr_u16_t nlq_value = (olsr_u16_t)(lq->nlq * 65535);
111   
112   buff[0] = (unsigned char)(lq_value / 256);
113   buff[1] = (unsigned char)(nlq_value / 256);
114   buff[2] = (unsigned char)(lq_value & 255);
115   buff[3] = (unsigned char)(nlq_value & 255);
116   
117   return 4;
118 }
119
120 void default_olsr_deserialize_tc_lq_pair(const olsr_u8_t **curr, void *ptr) {
121   struct default_lq *lq = ptr;
122   
123   olsr_u8_t lq_high, lq_low, nlq_high, nlq_low;
124   olsr_u16_t lq_value, nlq_value;
125   
126   pkt_get_u8(curr, &lq_high);
127   pkt_get_u8(curr, &nlq_high);
128   pkt_get_u8(curr, &lq_low);
129   pkt_get_u8(curr, &nlq_low);
130   
131   lq_value = 256 * (olsr_u16_t)lq_high + (olsr_u16_t)lq_low;
132   nlq_value = 256 * (olsr_u16_t)nlq_high + (olsr_u16_t)nlq_low;
133   
134   lq->lq = (float)lq_value / 65535.0;
135   lq->nlq = (float)nlq_value / 65535.0;
136 }
137
138 olsr_linkcost default_packet_loss_worker(struct link_entry *link, void *ptr, olsr_bool lost) {
139   struct default_lq *tlq = ptr;
140   
141   // exponential moving average
142   tlq->lq *= (1 - olsr_cnf->lq_aging);
143   if (lost == 0) {
144     tlq->lq += (olsr_cnf->lq_aging * link->loss_link_multiplier / 65536);
145   }
146   return default_calc_cost(ptr);
147 }
148
149 void default_olsr_memorize_foreign_hello_lq(void *ptrLocal, void *ptrForeign) {
150   struct default_lq *local = ptrLocal;
151   struct default_lq *foreign = ptrForeign;
152   
153   if (foreign) {
154     local->nlq = foreign->lq;
155   }
156   else {
157     local->nlq = 0;
158   }
159 }
160
161 void default_olsr_copy_link_lq_into_tc(void *target, void *source) {
162   memcpy(target, source, sizeof(struct default_lq));
163 }
164
165 void default_olsr_clear_lq(void *target) {
166   memset(target, 0, sizeof(struct default_lq));
167 }
168
169 const char *default_olsr_print_lq(void *ptr, struct lqtextbuffer *buffer) {
170   struct default_lq *lq = ptr;
171   
172   sprintf(buffer->buf, "%2.3f/%2.3f", lq->lq, lq->nlq);
173   return buffer->buf;
174 }
175
176 const char *default_olsr_print_cost(olsr_linkcost cost, struct lqtextbuffer *buffer) {
177   sprintf(buffer->buf, "%2.3f", ((float)cost)/LQ_PLUGIN_LC_MULTIPLIER);
178   return buffer->buf;
179 }