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