34a2f27bf3478ee691cf178a7ce09d78bdd33b47
[olsrd.git] / src / lq_plugin.h
1
2 /*
3  * The olsr.org Optimized Link-State Routing daemon(olsrd)
4  * Copyright (c) 2008 Henning Rogge <rogge@fgan.de>
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 #ifndef LQPLUGIN_H_
43 #define LQPLUGIN_H_
44
45 #include "tc_set.h"
46 #include "link_set.h"
47 #include "olsr_spf.h"
48 #include "lq_packet.h"
49 #include "common/avl.h"
50
51 #define LINK_COST_BROKEN (1<<22)
52 #define ROUTE_COST_BROKEN (0xffffffff)
53 #define ZERO_ROUTE_COST 0
54
55 #define MINIMAL_USEFUL_LQ 0.1
56 #define LQ_PLUGIN_RELEVANT_COSTCHANGE 16
57
58 #define LQ_QUICKSTART_STEPS 12
59 #define LQ_QUICKSTART_AGING 0.25
60
61 struct lqtextbuffer {
62   char buf[16];
63 };
64
65 struct lq_handler {
66   void (*initialize)(void);
67
68   olsr_linkcost(*calc_hello_cost) (const void *lq);
69   olsr_linkcost(*calc_tc_cost) (const void *lq);
70
71   bool(*is_relevant_costchange) (olsr_linkcost c1, olsr_linkcost c2);
72
73   olsr_linkcost(*packet_loss_handler) (struct link_entry * entry, void *lq,
74                                        bool lost);
75
76   void (*memorize_foreign_hello) (void *local, void *foreign);
77   void (*copy_link_lq_into_tc) (void *target, void *source);
78   void (*clear_hello) (void *target);
79   void (*clear_tc) (void *target);
80
81   int (*serialize_hello_lq) (unsigned char *buff, void *lq);
82   int (*serialize_tc_lq) (unsigned char *buff, void *lq);
83   void (*deserialize_hello_lq) (const uint8_t ** curr, void *lq);
84   void (*deserialize_tc_lq) (const uint8_t ** curr, void *lq);
85
86   const char *(*print_hello_lq) (void *ptr, char separator, struct lqtextbuffer * buffer);
87   const char *(*print_tc_lq) (void *ptr, char separator, struct lqtextbuffer * buffer);
88   const char *(*print_cost) (olsr_linkcost cost, struct lqtextbuffer * buffer);
89
90   size_t hello_lq_size;
91   size_t tc_lq_size;
92 };
93
94 struct lq_handler_node {
95   struct avl_node node;
96   struct lq_handler *handler;
97   char name[0];
98 };
99
100 AVLNODE2STRUCT(lq_handler_tree2lq_handler_node, struct lq_handler_node, node);
101
102 #define OLSR_FOR_ALL_LQ_HANDLERS(lq) \
103 { \
104   struct avl_node *lq_tree_node, *next_lq_tree_node; \
105   for (lq_tree_node = avl_walk_first(&lq_handler_tree); \
106     lq_tree_node; lq_tree_node = next_lq_tree_node) { \
107     next_lq_tree_node = avl_walk_next(lq_tree_node); \
108     lq = lq_handler_tree2lq_handler_node(lq_tree_node);
109 #define OLSR_FOR_ALL_LQ_HANDLERS_END(tc) }}
110
111 void init_lq_handler_tree(void);
112
113 olsr_linkcost olsr_calc_tc_cost(const struct tc_edge_entry *);
114 bool olsr_is_relevant_costchange(olsr_linkcost c1, olsr_linkcost c2);
115
116 int olsr_serialize_hello_lq_pair(unsigned char *buff,
117                                  struct lq_hello_neighbor *neigh);
118 void olsr_deserialize_hello_lq_pair(const uint8_t ** curr,
119                                     struct lq_hello_neighbor *neigh);
120 int olsr_serialize_tc_lq_pair(unsigned char *buff, struct tc_mpr_addr *neigh);
121 void olsr_deserialize_tc_lq_pair(const uint8_t ** curr,
122                                  struct tc_edge_entry *edge);
123
124 void olsr_update_packet_loss_worker(struct link_entry *entry, bool lost);
125 void olsr_memorize_foreign_hello_lq(struct link_entry *local,
126                                     struct lq_hello_neighbor *foreign);
127
128 const char *EXPORT(get_link_entry_text)(struct link_entry *entry,
129                                 char separator,
130                                 struct lqtextbuffer *buffer);
131 const char *EXPORT(get_tc_edge_entry_text)(struct tc_edge_entry *entry,
132                                    char separator,
133                                    struct lqtextbuffer *buffer);
134 const char *get_linkcost_text(olsr_linkcost cost, bool route,
135                               struct lqtextbuffer *buffer);
136
137 void olsr_copy_hello_lq(struct lq_hello_neighbor *target,
138                         struct link_entry *source);
139 void olsr_copylq_link_entry_2_tc_mpr_addr(struct tc_mpr_addr *target,
140                                           struct link_entry *source);
141 void olsr_copylq_link_entry_2_tc_edge_entry(struct tc_edge_entry *target,
142                                             struct link_entry *source);
143 #if 0
144 void olsr_clear_tc_lq(struct tc_mpr_addr *target);
145 #endif
146
147 struct lq_hello_neighbor *olsr_malloc_hello_neighbor(const char *id);
148 struct tc_mpr_addr *olsr_malloc_tc_mpr_addr(const char *id);
149 struct lq_hello_neighbor *olsr_malloc_lq_hello_neighbor(const char *id);
150 struct link_entry *olsr_malloc_link_entry(const char *id);
151
152 /* Externals. */
153 extern struct lq_handler *active_lq_handler;
154
155 #endif /*LQPLUGIN_H_ */
156
157 /*
158  * Local Variables:
159  * c-basic-offset: 2
160  * indent-tabs-mode: nil
161  * End:
162  */