Rename olsr_time.[ch] to olsr_clock.[ch]
[olsrd.git] / src / link_set.h
1
2 /*
3  * The olsr.org Optimized Link-State Routing daemon(olsrd)
4  * Copyright (c) 2004-2009, the olsr.org team - see HISTORY file
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_packet.h"
50 #include "lq_plugin.h"
51 #include "common/list.h"
52 #include "olsr_clock.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   struct interface *inter;
62   char *if_name;
63   struct olsr_timer_entry *link_timer;
64   struct olsr_timer_entry *link_sym_timer;
65   uint32_t ASYM_time;
66   uint32_t vtime;
67   struct nbr_entry *neighbor;
68   uint8_t status;
69
70   bool is_mpr, is_mprs;
71
72   /* for faster hello packet generation */
73   uint8_t iflocal_link_status, iflocal_neigh_status;
74
75   /*
76    * packet loss
77    */
78   uint32_t loss_helloint;
79   struct olsr_timer_entry *link_loss_timer;
80
81   /* user defined multiplies for link quality, multiplied with 65536 */
82   uint32_t loss_link_multiplier;
83
84   /* cost of this link */
85   olsr_linkcost linkcost;
86
87   struct list_entity link_list;          /* double linked list of all link entries */
88 };
89
90 #define OLSR_LINK_JITTER       5        /* percent */
91 #define OLSR_LINK_HELLO_JITTER 0        /* percent jitter */
92 #define OLSR_LINK_SYM_JITTER   0        /* percent jitter */
93 #define OLSR_LINK_LOSS_JITTER  0        /* percent jitter */
94
95 /* deletion safe macro for link entry traversal */
96 #define OLSR_FOR_ALL_LINK_ENTRIES(link, iterator) list_for_each_element_safe(&link_entry_head, link, link_list, iterator)
97
98 /* Externals */
99 extern struct list_entity EXPORT(link_entry_head);
100 extern bool link_changes;
101
102 /* Function prototypes */
103
104 void olsr_init_link_set(void);
105 void olsr_delete_link_entry_by_if(const struct interface *);
106 void olsr_expire_link_hello_timer(void *);
107 void olsr_lq_hello_handler(struct link_entry *, bool);
108 void signal_link_changes(bool);        /* XXX ugly */
109
110
111 struct link_entry *EXPORT(get_best_link_to_neighbor)(struct nbr_entry *nbr);
112
113 struct link_entry *EXPORT(get_best_link_to_neighbor_ip) (const union olsr_ip_addr *);
114
115 struct link_entry *EXPORT(lookup_link_entry) (const union olsr_ip_addr *,
116                                               const union olsr_ip_addr * remote_main, const struct interface *);
117
118 struct link_entry *update_link_entry(const union olsr_ip_addr *,
119                                      const union olsr_ip_addr *, struct lq_hello_message *, struct interface *);
120
121 int EXPORT(check_neighbor_link) (const union olsr_ip_addr *);
122 int replace_neighbor_link_set(const struct nbr_entry *, struct nbr_entry *);
123 int lookup_link_status(const struct link_entry *);
124 void olsr_update_packet_loss_hello_int(struct link_entry *, uint32_t);
125 void olsr_update_packet_loss(struct link_entry *entry);
126 void olsr_print_link_set(void);
127 void generate_hello(void *);
128 #endif
129
130 /*
131  * Local Variables:
132  * c-basic-offset: 2
133  * indent-tabs-mode: nil
134  * End:
135  */