Hysteresis: detect multiple lost packets.
[olsrd.git] / src / link_set.h
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: link_set.h,v 1.17 2004/12/02 18:03:15 tlopatic Exp $
40  */
41
42
43 /*
44  * Link sensing database for the OLSR routing daemon
45  */
46
47
48 #include "defs.h"
49
50 #ifndef _LINK_SET_H
51 #define _LINK_SET_H
52
53 struct link_entry
54 {
55   union olsr_ip_addr local_iface_addr;
56   union olsr_ip_addr neighbor_iface_addr;
57   struct timeval SYM_time;
58   struct timeval ASYM_time;
59   struct timeval time;
60   struct neighbor_entry *neighbor;
61
62   /*
63    *Hysteresis
64    */
65   float L_link_quality;
66   int L_link_pending;
67   struct timeval L_LOST_LINK_time;
68   struct timeval hello_timeout; /* When we should receive a new HELLO */
69   double last_htime;
70   olsr_u16_t olsr_seqno;
71   olsr_bool olsr_seqno_valid;
72
73 #if defined USE_LINK_QUALITY
74   /*
75    * packet loss
76    */
77
78   double loss_hello_int;
79   struct timeval loss_timeout;
80
81   olsr_u16_t loss_seqno;
82   int loss_seqno_valid;
83   int loss_missed_hellos;
84
85   int lost_packets;
86   int total_packets;
87
88   double loss_link_quality;
89
90   int loss_window_size;
91   int loss_index;
92
93   unsigned char loss_bitmap[16];
94
95   double neigh_link_quality;
96
97   double saved_loss_link_quality;
98   double saved_neigh_link_quality;
99 #endif
100
101   /*
102    * Spy
103    */
104   olsr_u8_t                    spy_activated;
105
106   struct link_entry *next;
107 };
108
109
110 /* The link sets - one pr. interface */
111
112 struct link_entry *link_set;
113
114 /* Timers */
115 struct timeval  hold_time_neighbor;
116 struct timeval  hold_time_neighbor_nw;
117
118 /* Function prototypes */
119
120 void
121 olsr_init_link_set(void);
122
123 struct interface *
124 get_interface_link_set(union olsr_ip_addr *);
125
126 union olsr_ip_addr *
127 get_neighbor_nexthop(union olsr_ip_addr *);
128
129 struct link_entry *
130 lookup_link_entry(union olsr_ip_addr *, union olsr_ip_addr *);
131
132 struct link_entry *
133 update_link_entry(union olsr_ip_addr *, union olsr_ip_addr *, struct hello_message *, struct interface *);
134
135 int
136 check_neighbor_link(union olsr_ip_addr *);
137
138 int
139 replace_neighbor_link_set(struct neighbor_entry *,
140                           struct neighbor_entry *);
141
142 int
143 lookup_link_status(struct link_entry *);
144
145 #if defined USE_LINK_QUALITY
146 void olsr_update_packet_loss_hello_int(struct link_entry *entry, double htime);
147 void olsr_update_packet_loss(union olsr_ip_addr *rem, union olsr_ip_addr *loc,
148                         olsr_u16_t seqno);
149 void olsr_print_link_set(void);
150 struct link_entry *olsr_neighbor_best_link(union olsr_ip_addr *main);
151 struct link_entry *olsr_neighbor_best_inverse_link(union olsr_ip_addr *main);
152 #endif
153
154 #endif