63bb1c4d53049f00788ea870af10145c78091b70
[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.29 2006/12/14 11:29:19 bernd67 Exp $
40  */
41
42
43 /*
44  * Link sensing database for the OLSR routing daemon
45  */
46
47 #ifndef _LINK_SET_H
48 #define _LINK_SET_H
49
50 #include "packet.h"
51
52 #define MID_ALIAS_HACK_VTIME  10.0
53
54 struct link_entry
55 {
56   union olsr_ip_addr local_iface_addr;
57   union olsr_ip_addr neighbor_iface_addr;
58   char *if_name;
59   clock_t SYM_time;
60   clock_t ASYM_time;
61   clock_t time;
62   struct neighbor_entry *neighbor;
63   olsr_u8_t prev_status;
64   /*
65    *Hysteresis
66    */
67   float L_link_quality;
68   int L_link_pending;
69   clock_t L_LOST_LINK_time;
70   clock_t hello_timeout; /* When we should receive a new HELLO */
71   double last_htime;
72   olsr_u16_t olsr_seqno;
73   olsr_bool olsr_seqno_valid;
74
75   /*
76    * packet loss
77    */
78
79   double loss_hello_int;
80   clock_t loss_timeout;
81
82   olsr_u16_t loss_seqno;
83   int loss_seqno_valid;
84   int loss_missed_hellos;
85
86   int lost_packets;
87   int total_packets;
88
89   double loss_link_quality, loss_link_quality2;
90   double loss_link_multiplier;
91
92   int loss_window_size;
93   int loss_index;
94
95   unsigned char loss_bitmap[16];
96
97   double neigh_link_quality, neigh_link_quality2;
98
99   double saved_loss_link_quality;
100   double saved_neigh_link_quality;
101
102   struct link_entry *next;
103 };
104
105
106 extern struct link_entry *link_set;
107
108
109 /* Function prototypes */
110
111 struct link_entry *
112 get_link_set(void);
113
114 clock_t 
115 get_hold_time_neighbor(void);
116
117 void
118 olsr_init_link_set(void);
119
120 struct link_entry *
121 get_best_link_to_neighbor(union olsr_ip_addr *);
122
123 struct link_entry *
124 lookup_link_entry(union olsr_ip_addr *, struct interface *);
125
126 struct link_entry *
127 update_link_entry(union olsr_ip_addr *, union olsr_ip_addr *, struct hello_message *, struct interface *);
128
129 int
130 check_neighbor_link(union olsr_ip_addr *);
131
132 int
133 replace_neighbor_link_set(struct neighbor_entry *,
134                           struct neighbor_entry *);
135
136 int
137 lookup_link_status(struct link_entry *);
138
139 void 
140 olsr_update_packet_loss_hello_int(struct link_entry *, double);
141
142 void 
143 olsr_update_packet_loss(union olsr_ip_addr *, struct interface *, olsr_u16_t);
144
145 void 
146 olsr_print_link_set(void);
147
148 void
149 olsr_update_dijkstra_link_qualities(void);
150
151 #endif