58d1684d6a47e50c9a3838da6114421df3605a8c
[olsrd.git] / src / hysteresis.c
1 /*
2  * The olsr.org Optimized Link-State Routing daemon(olsrd)
3  * Copyright (c) 2004, Andreas T√łnnesen(andreto@olsr.org)
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
42 #include <time.h>
43
44 #include "olsr_protocol.h"
45 #include "hysteresis.h"
46 #include "defs.h"
47 #include "olsr.h"
48 #include "net_olsr.h"
49 #include "ipcalc.h"
50
51 #define hscaling olsr_cnf->hysteresis_param.scaling
52 #define hhigh    olsr_cnf->hysteresis_param.thr_high
53 #define hlow     olsr_cnf->hysteresis_param.thr_low
54
55 float
56 olsr_hyst_calc_stability(float old_quality)
57 {
58   return (((1 - hscaling) * old_quality) + hscaling);
59 }
60
61
62
63 float
64 olsr_hyst_calc_instability(float old_quality)
65 {
66   return ((1 - hscaling) * old_quality);
67 }
68
69
70
71 int
72 olsr_process_hysteresis(struct link_entry *entry)
73 {
74   clock_t tmp_timer;
75
76   //printf("PROCESSING QUALITY: %f\n", entry->L_link_quality);
77   if(entry->L_link_quality > hhigh)
78     {
79       if(entry->L_link_pending == 1)
80         {
81 #ifndef NODEBUG
82           struct ipaddr_str buf;
83 #endif
84           OLSR_PRINTF(1, "HYST[%s] link set to NOT pending!\n", 
85                       olsr_ip_to_string(&buf, &entry->neighbor_iface_addr));
86           changes_neighborhood = OLSR_TRUE;
87         }
88
89       /* Pending = false */
90       entry->L_link_pending = 0;
91
92       if(!TIMED_OUT(entry->L_LOST_LINK_time))
93         changes_neighborhood = OLSR_TRUE;
94
95       /* time = now -1 */
96       entry->L_LOST_LINK_time = now_times - 1;
97
98       return 1;
99     }
100
101   if(entry->L_link_quality < hlow)
102     {
103       if(entry->L_link_pending == 0)
104         {
105 #ifndef NODEBUG
106           struct ipaddr_str buf;
107 #endif
108           OLSR_PRINTF(1, "HYST[%s] link set to pending!\n", 
109                       olsr_ip_to_string(&buf, &entry->neighbor_iface_addr));
110           changes_neighborhood = OLSR_TRUE;
111         }
112       
113       /* Pending = true */
114       entry->L_link_pending = 1;
115
116       if(TIMED_OUT(entry->L_LOST_LINK_time))
117         changes_neighborhood = OLSR_TRUE;
118
119       /* Timer = min (L_time, current time + NEIGHB_HOLD_TIME) */
120       //tmp_timer = now;
121       //tmp_timer.tv_sec += NEIGHB_HOLD_TIME; /* Takafumi fix */
122       tmp_timer = now_times + get_hold_time_neighbor();
123
124         entry->L_LOST_LINK_time = 
125           entry->time > tmp_timer ? tmp_timer : entry->time;
126
127       /* (the link is then considered as lost according to section
128          8.5 and this may produce a neighbor loss).
129          WTF?
130       */
131       return -1;
132     }
133
134   /*
135    *If we get here then:
136    *(HYST_THRESHOLD_LOW <= entry->L_link_quality <= HYST_THRESHOLD_HIGH)
137    */
138
139   /* L_link_pending and L_LOST_LINK_time remain unchanged. */
140   return 0;
141
142
143 }
144
145 /**
146  *Update the hello timeout of a hysteresis link
147  *entry
148  *
149  *@param entry the link entry to update
150  *@param htime the hello interval to use
151  *
152  *@return nada
153  */
154 void
155 olsr_update_hysteresis_hello(struct link_entry *entry, double htime)
156 {
157 #ifndef NODEBUG
158   struct ipaddr_str buf;
159 #endif
160   OLSR_PRINTF(3, "HYST[%s]: HELLO update vtime %f\n", olsr_ip_to_string(&buf, &entry->neighbor_iface_addr), htime*1.5);
161   /* hello timeout = current time + hint time */
162   /* SET TIMER TO 1.5 TIMES THE INTERVAL */
163   /* Update timer */
164
165   entry->hello_timeout = GET_TIMESTAMP(htime*1500);
166
167   return;
168 }
169
170
171
172 void
173 update_hysteresis_incoming(union olsr_ip_addr *remote, struct interface *local, olsr_u16_t seqno)
174 {
175   struct link_entry *lnk = lookup_link_entry(remote, NULL, local);
176
177   /* Calculate new quality */
178   if(lnk != NULL)
179     {
180 #if !defined(NODEBUG) && defined(DEBUG)
181       struct ipaddr_str buf;
182 #endif
183       lnk->L_link_quality = olsr_hyst_calc_stability(lnk->L_link_quality);
184 #ifdef DEBUG
185       OLSR_PRINTF(3, "HYST[%s]: %0.3f\n", olsr_ip_to_string(&buf, remote), lnk->L_link_quality);
186 #endif
187
188       /* 
189        * see how many packets we have missed and update the link quality
190        * for each missed packet; HELLOs have already been accounted for by
191        * the timeout function and the number of missed HELLOs has already
192        * been added to olsr_seqno there
193        */
194
195       if (lnk->olsr_seqno_valid && 
196           (unsigned short)(seqno - lnk->olsr_seqno) < 100)
197           while (lnk->olsr_seqno != seqno)
198             {
199               lnk->L_link_quality = olsr_hyst_calc_instability(lnk->L_link_quality);
200 #ifdef DEBUG
201               OLSR_PRINTF(5, "HYST[%s] PACKET LOSS! %0.3f\n",
202                           olsr_ip_to_string(&buf, remote), lnk->L_link_quality);
203 #endif
204               if(lnk->L_link_quality < olsr_cnf->hysteresis_param.thr_low)
205                 break;
206
207               lnk->olsr_seqno++;
208             }
209
210
211       lnk->olsr_seqno = seqno + 1;
212       lnk->olsr_seqno_valid = OLSR_TRUE;
213
214       //printf("Updating seqno to: %d\n", lnk->olsr_seqno);
215     }
216   return;
217 }