* rearranged fields a little bit to save space
[olsrd.git] / src / link_set.h
1 /*
2  * The olsr.org Optimized Link-State Routing daemon(olsrd)
3  * Copyright (c) 2004, Andreas TÃ\83¸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.34 2007/11/25 21:38:13 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   /*
66    *Hysteresis
67    */
68   float L_link_quality;
69   int L_link_pending;
70   clock_t L_LOST_LINK_time;
71   clock_t hello_timeout; /* When we should receive a new HELLO */
72   double last_htime;
73   olsr_u16_t olsr_seqno;
74   olsr_bool olsr_seqno_valid;
75
76   /*
77    * packet loss
78    */
79
80   double loss_hello_int;
81   clock_t loss_timeout;
82
83   olsr_u16_t loss_seqno;
84   int loss_seqno_valid;
85   int loss_missed_hellos;
86
87   unsigned int lost_packets;
88   unsigned int total_packets;
89
90   double loss_link_quality
91   double loss_link_quality2;
92   double loss_link_multiplier;
93
94   unsigned int loss_index;
95
96   unsigned char loss_bitmap[16];
97
98   double neigh_link_quality, neigh_link_quality2;
99
100   double saved_loss_link_quality;
101   double saved_neigh_link_quality;
102
103   struct link_entry *next;
104 };
105
106
107 extern struct link_entry *link_set;
108
109
110 /* Function prototypes */
111
112 struct link_entry *
113 get_link_set(void);
114
115 clock_t 
116 get_hold_time_neighbor(void);
117
118 void
119 olsr_init_link_set(void);
120
121 void
122 del_if_link_entries(const union olsr_ip_addr *);
123
124 struct link_entry *
125 get_best_link_to_neighbor(const union olsr_ip_addr *);
126
127 struct link_entry *
128 lookup_link_entry(const union olsr_ip_addr *, const union olsr_ip_addr *remote_main, const struct interface *);
129
130 struct link_entry *
131 update_link_entry(const union olsr_ip_addr *, const union olsr_ip_addr *, const struct hello_message *, const struct interface *);
132
133 int
134 check_neighbor_link(const union olsr_ip_addr *);
135
136 int
137 replace_neighbor_link_set(const struct neighbor_entry *,
138                           struct neighbor_entry *);
139
140 int
141 lookup_link_status(const struct link_entry *);
142
143 void 
144 olsr_update_packet_loss_hello_int(struct link_entry *, double);
145
146 void 
147 olsr_update_packet_loss(const union olsr_ip_addr *, const struct interface *, olsr_u16_t);
148
149 void 
150 olsr_print_link_set(void);
151
152 void
153 olsr_update_dijkstra_link_qualities(void);
154
155 float olsr_calc_link_etx(const struct link_entry *);
156
157 #endif