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