ef8c2e92840336a2eb792c5bc909971d823a3fc1
[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
23
24 #include <time.h>
25
26 #include "olsr_protocol.h"
27 #include "hysteresis.h"
28 #include "defs.h"
29 #include "olsr.h"
30
31
32 inline float
33 olsr_hyst_calc_stability(float old_quality)
34 {
35   return (((1 - hyst_scaling) * old_quality) + hyst_scaling);
36 }
37
38
39
40 inline float
41 olsr_hyst_calc_instability(float old_quality)
42 {
43   return ((1 - hyst_scaling) * old_quality);
44 }
45
46
47
48 int
49 olsr_process_hysteresis(struct link_entry *entry)
50 {
51   struct timeval tmp_timer;
52
53   //printf("PROCESSING QUALITY: %f\n", entry->L_link_quality);
54   if(entry->L_link_quality > hyst_threshold_high)
55     {
56       if(entry->L_link_pending == 1)
57         {
58           olsr_printf(1, "HYST[%s] link set to NOT pending!\n", 
59                       olsr_ip_to_string(&entry->neighbor_iface_addr));
60           changes_neighborhood = UP;
61         }
62
63       /* Pending = false */
64       entry->L_link_pending = 0;
65
66       if(!TIMED_OUT(&entry->L_LOST_LINK_time))
67         changes_neighborhood = UP;
68
69       /* time = now -1 */
70       entry->L_LOST_LINK_time = now;
71       entry->L_LOST_LINK_time.tv_sec -= 1;
72
73       return 1;
74     }
75
76   if(entry->L_link_quality < hyst_threshold_low)
77     {
78       if(entry->L_link_pending == 0)
79         {
80           olsr_printf(1, "HYST[%s] link set to pending!\n", 
81                       olsr_ip_to_string(&entry->neighbor_iface_addr));
82           changes_neighborhood = UP;
83         }
84       
85       /* Pending = true */
86       entry->L_link_pending = 1;
87
88       if(TIMED_OUT(&entry->L_LOST_LINK_time))
89         changes_neighborhood = UP;
90
91       /* Timer = min (L_time, current time + NEIGHB_HOLD_TIME) */
92       //tmp_timer = now;
93       //tmp_timer.tv_sec += NEIGHB_HOLD_TIME; /* Takafumi fix */
94         timeradd(&now, &hold_time_neighbor, &tmp_timer);
95
96         entry->L_LOST_LINK_time = 
97         (timercmp(&entry->time, &tmp_timer, >) > 0) ? tmp_timer : entry->time;
98
99       /* (the link is then considered as lost according to section
100          8.5 and this may produce a neighbor loss).
101          WTF?
102       */
103       return -1;
104     }
105
106   /*
107    *If we get here then:
108    *(HYST_THRESHOLD_LOW <= entry->L_link_quality <= HYST_THRESHOLD_HIGH)
109    */
110
111   /* L_link_pending and L_LOST_LINK_time remain unchanged. */
112   return 0;
113
114
115 }
116
117 /**
118  *Update the hello timeout of a hysteresis link
119  *entry
120  *
121  *@param entry the link entry to update
122  *@param htime the hello interval to use
123  *
124  *@return nada
125  */
126 void
127 olsr_update_hysteresis_hello(struct link_entry *entry, double htime)
128 {
129 #ifdef DEBUG
130   olsr_printf(3, "HYST[%s]: HELLO update vtime %f\n", olsr_ip_to_string(&entry->neighbor_iface_addr), htime*1.5);
131 #endif
132   /* hello timeout = current time + hint time */
133   /* SET TIMER TO 1.5 TIMES THE INTERVAL */
134   /* Update timer */
135
136   olsr_get_timestamp((olsr_u32_t) htime*1500, &entry->hello_timeout);
137
138   return;
139 }
140
141
142
143 void
144 update_hysteresis_incoming(union olsr_ip_addr *remote, union olsr_ip_addr *local, olsr_u16_t seqno)
145 {
146   struct link_entry *link;
147
148   link = lookup_link_entry(remote, local);
149
150   /* Calculate new quality */      
151   if(link != NULL)
152     {
153       link->L_link_quality = olsr_hyst_calc_stability(link->L_link_quality);
154 #ifdef DEBUG
155       olsr_printf(3, "HYST[%s]: %0.3f\n", olsr_ip_to_string(remote), link->L_link_quality);
156 #endif
157       /* Check for missing packets - AVOID WRAP AROUND and FIRST TIME
158        * checking for 0 is kind of a ugly hack...
159        */
160       if((link->olsr_seqno + 1 < seqno) &&
161          (link->olsr_seqno != 0) &&
162          (seqno != 0))
163         {
164           //printf("HYS: packet lost.. last seqno %d received seqno %d!\n", link->olsr_seqno, seqno);
165           link->L_link_quality = olsr_hyst_calc_instability(link->L_link_quality);
166 #ifdef DEBUG
167           olsr_printf(5, "HYST[%s] PACKET LOSS! %0.3f\n", olsr_ip_to_string(remote), link->L_link_quality);
168 #endif
169         }
170       /* Set seqno */
171       link->olsr_seqno = seqno;
172       //printf("Updating seqno to: %d\n", link->olsr_seqno);
173     }
174   return;
175 }