Merge branch 'release-0.6.5'
[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 "packet.h"
50 #include "common/avl.h"
51
52 #define LINK_COST_BROKEN (1<<22)
53 #define ROUTE_COST_BROKEN (0xffffffff)
54 #define ZERO_ROUTE_COST 0
55
56 #define MINIMAL_USEFUL_LQ 0.1
57 #define LQ_PLUGIN_RELEVANT_COSTCHANGE 16
58
59 #define LQ_QUICKSTART_STEPS 12
60 #define LQ_QUICKSTART_AGING 0.25
61
62 struct lqtextbuffer {
63   char buf[16];
64 };
65
66 struct lq_handler {
67   void (*initialize) (void);
68
69   olsr_linkcost (*calc_hello_cost) (const void *lq);
70   olsr_linkcost (*calc_tc_cost) (const void *lq);
71
72   void (*packet_loss_handler) (struct link_entry * entry, void *lq, bool lost);
73
74   void (*memorize_foreign_hello) (void *local, void *foreign);
75   void (*copy_link_lq_into_neigh) (void *target, void *source);
76   void (*copy_link_lq_into_tc) (void *target, void *source);
77   void (*clear_hello) (void *target);
78   void (*clear_tc) (void *target);
79
80   int (*serialize_hello_lq) (unsigned char *buff, void *lq);
81   int (*serialize_tc_lq) (unsigned char *buff, void *lq);
82   void (*deserialize_hello_lq) (const uint8_t ** curr, void *lq);
83   void (*deserialize_tc_lq) (const uint8_t ** curr, void *lq);
84
85   const char *(*print_hello_lq) (void *ptr, char separator, struct lqtextbuffer * buffer);
86   const char *(*print_tc_lq) (void *ptr, char separator, struct lqtextbuffer * buffer);
87   const char *(*print_cost) (olsr_linkcost cost, struct lqtextbuffer * buffer);
88
89   size_t hello_lq_size;
90   size_t tc_lq_size;
91   size_t hello_lqdata_size;
92   size_t tc_lqdata_size;
93 };
94
95 struct lq_handler_node {
96   struct avl_node node;
97   struct lq_handler *handler;
98   char name[0];
99 };
100
101 AVLNODE2STRUCT(lq_handler_tree2lq_handler_node, struct lq_handler_node, node);
102
103 #define OLSR_FOR_ALL_LQ_HANDLERS(lq) \
104 { \
105   struct avl_node *lq_tree_node, *next_lq_tree_node; \
106   for (lq_tree_node = avl_walk_first(&lq_handler_tree); \
107     lq_tree_node; lq_tree_node = next_lq_tree_node) { \
108     next_lq_tree_node = avl_walk_next(lq_tree_node); \
109     lq = lq_handler_tree2lq_handler_node(lq_tree_node);
110 #define OLSR_FOR_ALL_LQ_HANDLERS_END(tc) }}
111
112 int avl_strcasecmp(const void *str1, const void *str2);
113 void init_lq_handler_tree(void);
114
115 void register_lq_handler(struct lq_handler *handler, const char *name);
116
117 olsr_linkcost olsr_calc_tc_cost(const struct tc_edge_entry *);
118
119 int olsr_serialize_hello_lq_pair(unsigned char *buff, struct lq_hello_neighbor *neigh);
120 void olsr_deserialize_hello_lq_pair(const uint8_t ** curr, struct hello_neighbor *neigh);
121 int olsr_serialize_tc_lq_pair(unsigned char *buff, struct tc_mpr_addr *neigh);
122 void olsr_deserialize_tc_lq_pair(const uint8_t ** curr, 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, struct hello_neighbor *foreign);
126
127 const char *get_link_entry_text(struct link_entry *entry, char separator, struct lqtextbuffer *buffer);
128 const char *get_tc_edge_entry_text(struct tc_edge_entry *entry, char separator, struct lqtextbuffer *buffer);
129 const char *get_linkcost_text(olsr_linkcost cost, bool route, struct lqtextbuffer *buffer);
130
131 void olsr_clear_hello_lq(struct link_entry */*link*/);
132 void olsr_copy_hello_lq(struct lq_hello_neighbor *target, struct link_entry *source);
133 void olsr_copylq_link_entry_2_tc_mpr_addr(struct tc_mpr_addr *target, struct link_entry *source);
134 void olsr_copylq_link_entry_2_tc_edge_entry(struct tc_edge_entry *target, struct link_entry *source);
135 void olsr_clear_tc_lq(struct tc_mpr_addr *target);
136
137 struct hello_neighbor *olsr_malloc_hello_neighbor(const char *id);
138 struct tc_mpr_addr *olsr_malloc_tc_mpr_addr(const char *id);
139 struct lq_hello_neighbor *olsr_malloc_lq_hello_neighbor(const char *id);
140 struct link_entry *olsr_malloc_link_entry(const char *id);
141
142 size_t olsr_sizeof_hello_lqdata(void);
143 size_t olsr_sizeof_tc_lqdata(void);
144
145 void olsr_relevant_linkcost_change(void);
146
147 /* Externals. */
148 extern struct lq_handler *active_lq_handler;
149
150 #endif /* LQPLUGIN_H_ */
151
152 /*
153  * Local Variables:
154  * c-basic-offset: 2
155  * indent-tabs-mode: nil
156  * End:
157  */