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