Remove the olsr-specific duplicated types
[olsrd.git] / src / hysteresis.c
1 /*
2  * The olsr.org Optimized Link-State Routing daemon(olsrd)
3  * Copyright (c) 2004, Andreas Tonnesen(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 int
53 olsr_process_hysteresis(struct link_entry *entry)
54 {
55   //printf("PROCESSING QUALITY: %f\n", entry->L_link_quality);
56   if (entry->L_link_quality > olsr_cnf->hysteresis_param.thr_high) {
57     if (entry->L_link_pending == 1) {
58       struct ipaddr_str buf;
59       OLSR_PRINTF(1, "HYST[%s] link set to NOT pending!\n", 
60                   olsr_ip_to_string(&buf, &entry->neighbor_iface_addr));
61       changes_neighborhood = true;
62     }
63
64     /* Pending = false */
65     entry->L_link_pending = 0;
66
67     if (!TIMED_OUT(entry->L_LOST_LINK_time)) {
68       changes_neighborhood = true;
69     }
70     /* time = now -1 */
71     entry->L_LOST_LINK_time = now_times - 1;
72
73     return 1;
74   }
75
76   if (entry->L_link_quality < olsr_cnf->hysteresis_param.thr_low) {
77     if (entry->L_link_pending == 0) {
78       struct ipaddr_str buf;
79       OLSR_PRINTF(1, "HYST[%s] link set to pending!\n", 
80                   olsr_ip_to_string(&buf, &entry->neighbor_iface_addr));
81       changes_neighborhood = true;
82     }
83       
84     /* Pending = true */
85     entry->L_link_pending = 1;
86
87     if (TIMED_OUT(entry->L_LOST_LINK_time)) {
88         changes_neighborhood = true;
89     }
90     /* Timer = min (L_time, current time + NEIGHB_HOLD_TIME) */
91     entry->L_LOST_LINK_time = MIN(GET_TIMESTAMP(NEIGHB_HOLD_TIME * MSEC_PER_SEC),
92                                   entry->link_timer->timer_clock);
93
94     /* (the link is then considered as lost according to section
95        8.5 and this may produce a neighbor loss).
96        WTF?
97     */
98     return -1;
99   }
100
101   /*
102    *If we get here then:
103    *(HYST_THRESHOLD_LOW <= entry->L_link_quality <= HYST_THRESHOLD_HIGH)
104    */
105
106   /* L_link_pending and L_LOST_LINK_time remain unchanged. */
107   return 0;
108 }
109
110 /**
111  *Update the hello timeout of a hysteresis link
112  *entry
113  *
114  *@param entry the link entry to update
115  *@param htime the hello interval to use
116  *
117  *@return nada
118  */
119 void
120 olsr_update_hysteresis_hello(struct link_entry *entry, olsr_reltime htime)
121 {
122   struct ipaddr_str buf;
123   OLSR_PRINTF(3, "HYST[%s]: HELLO update vtime %u ms\n",
124               olsr_ip_to_string(&buf, &entry->neighbor_iface_addr), htime+htime/2);
125
126   olsr_set_timer(&entry->link_hello_timer, htime + htime/2, OLSR_LINK_HELLO_JITTER,
127                  OLSR_TIMER_PERIODIC, &olsr_expire_link_hello_timer, entry, 0);
128 }
129
130
131
132 void
133 update_hysteresis_incoming(union olsr_ip_addr *remote, struct interface *local, uint16_t seqno)
134 {
135   struct link_entry *lnk = lookup_link_entry(remote, NULL, local);
136
137   /* Calculate new quality */
138   if (lnk != NULL) {
139 #ifdef DEBUG
140     struct ipaddr_str buf;
141 #endif
142     lnk->L_link_quality = olsr_hyst_calc_stability(lnk->L_link_quality);
143 #ifdef DEBUG
144     OLSR_PRINTF(3, "HYST[%s]: %f\n", olsr_ip_to_string(&buf, remote), lnk->L_link_quality);
145 #endif
146
147     /* 
148      * see how many packets we have missed and update the link quality
149      * for each missed packet; HELLOs have already been accounted for by
150      * the timeout function and the number of missed HELLOs has already
151      * been added to olsr_seqno there
152      */
153     if (lnk->olsr_seqno_valid && 
154         (unsigned short)(seqno - lnk->olsr_seqno) < 100) {
155       while (lnk->olsr_seqno != seqno) {
156         lnk->L_link_quality = olsr_hyst_calc_instability(lnk->L_link_quality);
157 #ifdef DEBUG
158         OLSR_PRINTF(5, "HYST[%s] PACKET LOSS! %f\n",
159                     olsr_ip_to_string(&buf, remote), lnk->L_link_quality);
160 #endif
161         if (lnk->L_link_quality < olsr_cnf->hysteresis_param.thr_low) {
162           break;
163         }
164         lnk->olsr_seqno++;
165       }
166     }
167
168     lnk->olsr_seqno = seqno + 1;
169     lnk->olsr_seqno_valid = true;
170
171     //printf("Updating seqno to: %d\n", lnk->olsr_seqno);
172   }
173 }
174
175 /*
176  * Local Variables:
177  * c-basic-offset: 2
178  * indent-tabs-mode: nil
179  * End:
180  */