Added licence header for lq_plugin files
[olsrd.git] / src / lq_plugin_default.c
1 /*
2  * The olsr.org Optimized Link-State Routing daemon(olsrd)
3  * Copyright (c) 2004, Thomas Lopatic (thomas@lopatic.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   buff[0] = (unsigned char)(lq->lq * 255);
66   buff[1] = (unsigned char)(lq->nlq * 255);
67   buff[2] = (unsigned char)(0);
68   buff[3] = (unsigned char)(0);
69   
70   return 4;
71 }
72
73 void default_olsr_deserialize_hello_lq_pair(const olsr_u8_t **curr, void *ptr) {
74   struct default_lq *lq = ptr;
75   
76   pkt_get_lq(curr, &lq->lq);
77   pkt_get_lq(curr, &lq->nlq);
78   pkt_ignore_u16(curr);
79 }
80
81 olsr_bool default_olsr_is_relevant_costchange(olsr_linkcost c1, olsr_linkcost c2) {
82   if (c1 > c2) {
83     return c2 - c1 > LQ_PLUGIN_RELEVANT_COSTCHANGE;
84   }
85   return c1 - c2 > LQ_PLUGIN_RELEVANT_COSTCHANGE;
86 }
87
88 int default_olsr_serialize_tc_lq_pair(unsigned char *buff, void *ptr) {
89   struct default_lq *lq = ptr;
90   
91   buff[0] = (unsigned char)(lq->lq * 255);
92   buff[1] = (unsigned char)(lq->nlq * 255);
93   buff[2] = (unsigned char)(0);
94   buff[3] = (unsigned char)(0);
95   
96   return 4;
97 }
98
99 void default_olsr_deserialize_tc_lq_pair(const olsr_u8_t **curr, void *ptr) {
100   struct default_lq *lq = ptr;
101   
102   pkt_get_lq(curr, &lq->lq);
103   pkt_get_lq(curr, &lq->nlq);
104   pkt_ignore_u16(curr);
105 }
106
107 olsr_linkcost default_packet_loss_worker(void *ptr, olsr_bool lost) {
108   struct default_lq *tlq = ptr;
109   float alpha;
110   
111   // calculate exponental factor for the new link quality, could be directly done in configuration !
112   alpha = 1 / (float)(olsr_cnf->lq_wsize);
113   
114   // exponential moving average
115   tlq->lq *= (1 - alpha);
116   if (lost == 0) {
117     tlq->lq += alpha;
118   }
119   return default_calc_cost(ptr);
120 }
121
122 void default_olsr_memorize_foreign_hello_lq(void *ptrLocal, void *ptrForeign) {
123   struct default_lq *local = ptrLocal;
124   struct default_lq *foreign = ptrForeign;
125   
126   if (foreign) {
127     local->nlq = foreign->lq;
128   }
129   else {
130     local->nlq = 0;
131   }
132 }
133
134 void default_olsr_copy_link_lq_into_tc(void *target, void *source) {
135   memcpy(target, source, sizeof(struct default_lq));
136 }
137
138 void default_olsr_clear_lq(void *target) {
139   memset(target, 0, sizeof(struct default_lq));
140 }
141
142 char *default_olsr_print_lq(void *ptr) {
143   static char output_buffer[16];
144   struct default_lq *lq = ptr;
145   
146   sprintf(output_buffer, "%2.3f/%2.3f", lq->lq, lq->nlq);
147   return output_buffer;
148 }
149
150 char *default_olsr_print_cost(olsr_linkcost cost) {
151   static char output_buffer[16];
152   sprintf(output_buffer, "%2.3f", ((float)cost)/LQ_PLUGIN_LC_MULTIPLIER);
153   return output_buffer;
154 }