b663daf0092f81fcda1a860e4dc4c06e82654699
[olsrd.git] / src / hysteresis.c
1 /*
2  * OLSR ad-hoc routing table management protocol
3  * Copyright (C) 2003 Andreas T√łnnesen (andreto@ifi.uio.no)
4  *
5  * This file is part of the olsr.org OLSR daemon.
6  *
7  * olsr.org is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2 of the License, or
10  * (at your option) any later version.
11  *
12  * olsr.org is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with olsr.org; if not, write to the Free Software
19  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
20  * 
21  * 
22  * $Id: hysteresis.c,v 1.5 2004/09/21 19:08:57 kattemat Exp $
23  *
24  */
25
26
27 #include <time.h>
28
29 #include "olsr_protocol.h"
30 #include "hysteresis.h"
31 #include "defs.h"
32 #include "olsr.h"
33
34
35 inline float
36 olsr_hyst_calc_stability(float old_quality)
37 {
38   return (((1 - hyst_scaling) * old_quality) + hyst_scaling);
39 }
40
41
42
43 inline float
44 olsr_hyst_calc_instability(float old_quality)
45 {
46   return ((1 - hyst_scaling) * old_quality);
47 }
48
49
50
51 int
52 olsr_process_hysteresis(struct link_entry *entry)
53 {
54   struct timeval tmp_timer;
55
56   //printf("PROCESSING QUALITY: %f\n", entry->L_link_quality);
57   if(entry->L_link_quality > hyst_threshold_high)
58     {
59       if(entry->L_link_pending == 1)
60         {
61           olsr_printf(1, "HYST[%s] link set to NOT pending!\n", 
62                       olsr_ip_to_string(&entry->neighbor_iface_addr));
63           changes_neighborhood = UP;
64         }
65
66       /* Pending = false */
67       entry->L_link_pending = 0;
68
69       if(!TIMED_OUT(&entry->L_LOST_LINK_time))
70         changes_neighborhood = UP;
71
72       /* time = now -1 */
73       entry->L_LOST_LINK_time = now;
74       entry->L_LOST_LINK_time.tv_sec -= 1;
75
76       return 1;
77     }
78
79   if(entry->L_link_quality < hyst_threshold_low)
80     {
81       if(entry->L_link_pending == 0)
82         {
83           olsr_printf(1, "HYST[%s] link set to pending!\n", 
84                       olsr_ip_to_string(&entry->neighbor_iface_addr));
85           changes_neighborhood = UP;
86         }
87       
88       /* Pending = true */
89       entry->L_link_pending = 1;
90
91       if(TIMED_OUT(&entry->L_LOST_LINK_time))
92         changes_neighborhood = UP;
93
94       /* Timer = min (L_time, current time + NEIGHB_HOLD_TIME) */
95       //tmp_timer = now;
96       //tmp_timer.tv_sec += NEIGHB_HOLD_TIME; /* Takafumi fix */
97         timeradd(&now, &hold_time_neighbor, &tmp_timer);
98
99         entry->L_LOST_LINK_time = 
100         (timercmp(&entry->time, &tmp_timer, >) > 0) ? tmp_timer : entry->time;
101
102       /* (the link is then considered as lost according to section
103          8.5 and this may produce a neighbor loss).
104          WTF?
105       */
106       return -1;
107     }
108
109   /*
110    *If we get here then:
111    *(HYST_THRESHOLD_LOW <= entry->L_link_quality <= HYST_THRESHOLD_HIGH)
112    */
113
114   /* L_link_pending and L_LOST_LINK_time remain unchanged. */
115   return 0;
116
117
118 }
119
120 /**
121  *Update the hello timeout of a hysteresis link
122  *entry
123  *
124  *@param entry the link entry to update
125  *@param htime the hello interval to use
126  *
127  *@return nada
128  */
129 void
130 olsr_update_hysteresis_hello(struct link_entry *entry, double htime)
131 {
132 #ifdef DEBUG
133   olsr_printf(3, "HYST[%s]: HELLO update vtime %f\n", olsr_ip_to_string(&entry->neighbor_iface_addr), htime*1.5);
134 #endif
135   /* hello timeout = current time + hint time */
136   /* SET TIMER TO 1.5 TIMES THE INTERVAL */
137   /* Update timer */
138
139   olsr_get_timestamp((olsr_u32_t) htime*1500, &entry->hello_timeout);
140
141   return;
142 }
143
144
145
146 void
147 update_hysteresis_incoming(union olsr_ip_addr *remote, union olsr_ip_addr *local, olsr_u16_t seqno)
148 {
149   struct link_entry *link;
150
151   link = lookup_link_entry(remote, local);
152
153   /* Calculate new quality */      
154   if(link != NULL)
155     {
156       link->L_link_quality = olsr_hyst_calc_stability(link->L_link_quality);
157 #ifdef DEBUG
158       olsr_printf(3, "HYST[%s]: %0.3f\n", olsr_ip_to_string(remote), link->L_link_quality);
159 #endif
160       /* Check for missing packets - AVOID WRAP AROUND and FIRST TIME
161        * checking for 0 is kind of a ugly hack...
162        */
163       if((link->olsr_seqno + 1 < seqno) &&
164          (link->olsr_seqno != 0) &&
165          (seqno != 0))
166         {
167           //printf("HYS: packet lost.. last seqno %d received seqno %d!\n", link->olsr_seqno, seqno);
168           link->L_link_quality = olsr_hyst_calc_instability(link->L_link_quality);
169 #ifdef DEBUG
170           olsr_printf(5, "HYST[%s] PACKET LOSS! %0.3f\n", olsr_ip_to_string(remote), link->L_link_quality);
171 #endif
172         }
173       /* Set seqno */
174       link->olsr_seqno = seqno;
175       //printf("Updating seqno to: %d\n", link->olsr_seqno);
176     }
177   return;
178 }