Align lq suffix to longword
[olsrd.git] / src / link_set.h
1
2 /*
3  * The olsr.org Optimized Link-State Routing daemon(olsrd)
4  * Copyright (c) 2004, Andreas TÃ\83¸nnesen(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 struct link_entry {
57   union olsr_ip_addr local_iface_addr;
58   union olsr_ip_addr neighbor_iface_addr;
59   const struct interface *inter;
60   char *if_name;
61   struct timer_entry *link_timer;
62   struct timer_entry *link_sym_timer;
63   clock_t ASYM_time;
64   olsr_reltime vtime;
65   struct neighbor_entry *neighbor;
66   olsr_u8_t prev_status;
67
68   /*
69    * Hysteresis
70    */
71   float L_link_quality;
72   int L_link_pending;
73   clock_t L_LOST_LINK_time;
74   struct timer_entry *link_hello_timer; /* When we should receive a new HELLO */
75   olsr_reltime last_htime;
76   olsr_bool olsr_seqno_valid;
77   olsr_u16_t olsr_seqno;
78
79   /*
80    * packet loss
81    */
82   olsr_reltime loss_helloint;
83   struct timer_entry *link_loss_timer;
84
85   /* user defined multiplies for link quality, multiplied with 65536 */
86   olsr_u32_t loss_link_multiplier;
87
88   /* cost of this link */
89   olsr_linkcost linkcost;
90
91   struct list_node link_list;          /* double linked list of all link entries */
92   olsr_u32_t linkquality[0];
93 };
94
95 /* inline to recast from link_list back to link_entry */
96 LISTNODE2STRUCT(list2link, struct link_entry, link_list);
97
98 #define OLSR_LINK_JITTER       5        /* percent */
99 #define OLSR_LINK_HELLO_JITTER 0        /* percent jitter */
100 #define OLSR_LINK_SYM_JITTER   0        /* percent jitter */
101 #define OLSR_LINK_LOSS_JITTER  0        /* percent jitter */
102
103 /* deletion safe macro for link entry traversal */
104 #define OLSR_FOR_ALL_LINK_ENTRIES(link) \
105 { \
106   struct list_node *link_head_node, *link_node, *next_link_node; \
107   link_head_node = &link_entry_head; \
108   for (link_node = link_head_node->next; \
109     link_node != link_head_node; link_node = next_link_node) { \
110     next_link_node = link_node->next; \
111     link = list2link(link_node);
112 #define OLSR_FOR_ALL_LINK_ENTRIES_END(link) }}
113
114 /* Externals */
115 extern struct list_node link_entry_head;
116 extern olsr_bool link_changes;
117
118 /* Function prototypes */
119
120 void olsr_set_link_timer(struct link_entry *, unsigned int);
121 void olsr_init_link_set(void);
122 void olsr_delete_link_entry_by_ip(const union olsr_ip_addr *);
123 void olsr_expire_link_hello_timer(void *);
124 void olsr_update_packet_loss_worker(struct link_entry *, olsr_bool);
125 void signal_link_changes(olsr_bool);   /* XXX ugly */
126
127
128 struct link_entry *get_best_link_to_neighbor(const union olsr_ip_addr *);
129
130 struct link_entry *lookup_link_entry(const union olsr_ip_addr *,
131                                      const union olsr_ip_addr *remote_main,
132                                      const struct interface *);
133
134 struct link_entry *update_link_entry(const union olsr_ip_addr *,
135                                      const union olsr_ip_addr *,
136                                      const struct hello_message *,
137                                      const struct interface *);
138
139 int check_neighbor_link(const union olsr_ip_addr *);
140 int replace_neighbor_link_set(const struct neighbor_entry *,
141                             struct neighbor_entry *);
142 int lookup_link_status(const struct link_entry *);
143 void olsr_update_packet_loss_hello_int(struct link_entry *, olsr_reltime);
144 void olsr_update_packet_loss(struct link_entry *entry);
145 void olsr_print_link_set(void);
146
147 #endif
148
149 /*
150  * Local Variables:
151  * c-basic-offset: 2
152  * End:
153  */