3abb5fffddd3695032b3229c05b43182a7e199a3
[olsrd.git] / src / link_set.h
1
2 /*
3  * The olsr.org Optimized Link-State Routing daemon(olsrd)
4  * Copyright (c) 2004, Andreas Tonnesen(andreto@olsr.org)
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without 
8  * modification, are permitted provided that the following conditions 
9  * are met:
10  *
11  * * Redistributions of source code must retain the above copyright 
12  *   notice, this list of conditions and the following disclaimer.
13  * * Redistributions in binary form must reproduce the above copyright 
14  *   notice, this list of conditions and the following disclaimer in 
15  *   the documentation and/or other materials provided with the 
16  *   distribution.
17  * * Neither the name of olsr.org, olsrd nor the names of its 
18  *   contributors may be used to endorse or promote products derived 
19  *   from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
22  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 
25  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
29  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 
31  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
32  * POSSIBILITY OF SUCH DAMAGE.
33  *
34  * Visit http://www.olsr.org for more information.
35  *
36  * If you find this software useful feel free to make a donation
37  * to the project. For more information see the website or contact
38  * the copyright holders.
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 "lq_plugin.h"
50 #include "packet.h"
51 #include "common/list.h"
52 #include "mantissa.h"
53
54 #define MID_ALIAS_HACK_VTIME  10.0
55
56 #define LINK_LOSS_MULTIPLIER (1<<16)
57
58 struct link_entry {
59   union olsr_ip_addr local_iface_addr;
60   union olsr_ip_addr neighbor_iface_addr;
61   const struct interface *inter;
62   char *if_name;
63   struct timer_entry *link_timer;
64   struct timer_entry *link_sym_timer;
65   clock_t ASYM_time;
66   olsr_reltime vtime;
67   struct neighbor_entry *neighbor;
68   olsr_u8_t prev_status;
69
70   /*
71    * Hysteresis
72    */
73   olsr_bool olsr_seqno_valid;
74   olsr_u16_t olsr_seqno;
75   float L_link_quality;
76   int L_link_pending;
77   clock_t L_LOST_LINK_time;
78   struct timer_entry *link_hello_timer; /* When we should receive a new HELLO */
79   olsr_reltime last_htime;
80
81   /*
82    * packet loss
83    */
84   olsr_reltime loss_helloint;
85   struct timer_entry *link_loss_timer;
86
87   /* user defined multiplies for link quality, multiplied with 65536 */
88   olsr_u32_t loss_link_multiplier;
89
90   /* cost of this link */
91   olsr_linkcost linkcost;
92
93   struct list_node link_list;          /* double linked list of all link entries */
94   olsr_u32_t linkquality[0];
95 };
96
97 /* inline to recast from link_list back to link_entry */
98 LISTNODE2STRUCT(list2link, struct link_entry, link_list);
99
100 #define OLSR_LINK_JITTER       5        /* percent */
101 #define OLSR_LINK_HELLO_JITTER 0        /* percent jitter */
102 #define OLSR_LINK_SYM_JITTER   0        /* percent jitter */
103 #define OLSR_LINK_LOSS_JITTER  0        /* percent jitter */
104
105 /* deletion safe macro for link entry traversal */
106 #define OLSR_FOR_ALL_LINK_ENTRIES(link) \
107 { \
108   struct list_node *link_head_node, *link_node, *next_link_node; \
109   link_head_node = &link_entry_head; \
110   for (link_node = link_head_node->next; \
111     link_node != link_head_node; link_node = next_link_node) { \
112     next_link_node = link_node->next; \
113     link = list2link(link_node);
114 #define OLSR_FOR_ALL_LINK_ENTRIES_END(link) }}
115
116 /* Externals */
117 extern struct list_node link_entry_head;
118 extern olsr_bool link_changes;
119
120 /* Function prototypes */
121
122 void olsr_set_link_timer(struct link_entry *, unsigned int);
123 void olsr_init_link_set(void);
124 void olsr_delete_link_entry_by_ip(const union olsr_ip_addr *);
125 void olsr_expire_link_hello_timer(void *);
126 void olsr_update_packet_loss_worker(struct link_entry *, olsr_bool);
127 void signal_link_changes(olsr_bool);   /* XXX ugly */
128
129
130 struct link_entry *get_best_link_to_neighbor(const union olsr_ip_addr *);
131
132 struct link_entry *lookup_link_entry(const union olsr_ip_addr *,
133                                      const union olsr_ip_addr *remote_main,
134                                      const struct interface *);
135
136 struct link_entry *update_link_entry(const union olsr_ip_addr *,
137                                      const union olsr_ip_addr *,
138                                      const struct hello_message *,
139                                      const struct interface *);
140
141 int check_neighbor_link(const union olsr_ip_addr *);
142 int replace_neighbor_link_set(const struct neighbor_entry *,
143                             struct neighbor_entry *);
144 int lookup_link_status(const struct link_entry *);
145 void olsr_update_packet_loss_hello_int(struct link_entry *, olsr_reltime);
146 void olsr_update_packet_loss(struct link_entry *entry);
147 void olsr_print_link_set(void);
148
149 #endif
150
151 /*
152  * Local Variables:
153  * c-basic-offset: 2
154  * indent-tabs-mode: nil
155  * End:
156  */