From Sven-Ola Tuecke <sven-ola@gmx.de>: add support for fixedpoint math
[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  */
40
41
42 /*
43  * Link sensing database for the OLSR routing daemon
44  */
45
46 #ifndef _LINK_SET_H
47 #define _LINK_SET_H
48
49 #include "packet.h"
50
51 #define MID_ALIAS_HACK_VTIME  10.0
52
53 struct link_entry
54 {
55   union olsr_ip_addr local_iface_addr;
56   union olsr_ip_addr neighbor_iface_addr;
57   const struct interface *inter;
58   char *if_name;
59   clock_t SYM_time;
60   clock_t ASYM_time;
61   clock_t time;
62   unsigned int vtime;
63   struct neighbor_entry *neighbor;
64   olsr_u8_t prev_status;
65
66   /*
67    *Hysteresis
68    */
69 #ifdef USE_FPM
70   fpm L_link_quality;
71 #else
72   float L_link_quality;
73 #endif
74   int L_link_pending;
75   clock_t L_LOST_LINK_time;
76   clock_t hello_timeout; /* When we should receive a new HELLO */
77   double last_htime;
78   olsr_bool olsr_seqno_valid;
79   olsr_u16_t olsr_seqno;
80
81   /*
82    * packet loss
83    */
84   olsr_u16_t loss_seqno;
85   int loss_seqno_valid;
86   int loss_missed_hellos;
87
88   double loss_hello_int;
89   clock_t loss_timeout;
90
91   unsigned int lost_packets;
92   unsigned int total_packets;
93
94 #ifdef USE_FPM
95   fpm loss_link_quality;
96   fpm loss_link_quality2;
97   fpm loss_link_multiplier;
98 #else
99   double loss_link_quality;
100   double loss_link_quality2;
101   double loss_link_multiplier;
102 #endif
103
104   unsigned int loss_index;
105
106   unsigned char loss_bitmap[16];
107
108 #ifdef USE_FPM
109   fpm neigh_link_quality, neigh_link_quality2;
110
111   fpm saved_loss_link_quality;
112   fpm saved_neigh_link_quality;
113 #else
114   double neigh_link_quality, neigh_link_quality2;
115
116   double saved_loss_link_quality;
117   double saved_neigh_link_quality;
118 #endif
119
120   struct link_entry *next;
121 };
122
123
124 extern struct link_entry *link_set;
125
126
127 /* Function prototypes */
128
129 struct link_entry *
130 get_link_set(void);
131
132 clock_t 
133 get_hold_time_neighbor(void);
134
135 void
136 olsr_init_link_set(void);
137
138 void
139 del_if_link_entries(const union olsr_ip_addr *);
140
141 struct link_entry *
142 get_best_link_to_neighbor(const union olsr_ip_addr *);
143
144 struct link_entry *
145 lookup_link_entry(const union olsr_ip_addr *, const union olsr_ip_addr *remote_main, const struct interface *);
146
147 struct link_entry *
148 update_link_entry(const union olsr_ip_addr *, const union olsr_ip_addr *, const struct hello_message *, const struct interface *);
149
150 int
151 check_neighbor_link(const union olsr_ip_addr *);
152
153 int
154 replace_neighbor_link_set(const struct neighbor_entry *,
155                           struct neighbor_entry *);
156
157 int
158 lookup_link_status(const struct link_entry *);
159
160 void 
161 olsr_update_packet_loss_hello_int(struct link_entry *, double);
162
163 void 
164 olsr_update_packet_loss(const union olsr_ip_addr *, const struct interface *, olsr_u16_t);
165
166 void 
167 olsr_print_link_set(void);
168
169 void
170 olsr_update_dijkstra_link_qualities(void);
171
172 #ifdef USE_FPM
173 fpm
174 #else
175 float
176 #endif
177 olsr_calc_link_etx(const struct link_entry *);
178
179 #endif
180
181 /*
182  * Local Variables:
183  * c-basic-offset: 2
184  * End:
185  */