718283fda1f91935c98ef0d78cc42b3aef2c102f
[olsrd.git] / src / lq_plugin_default_ff.h
1 /*
2  * The olsr.org Optimized Link-State Routing daemon(olsrd)
3  * Copyright (c) 2008 Henning Rogge <rogge@fgan.de>
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  *
10  * * Redistributions of source code must retain the above copyright
11  *   notice, this list of conditions and the following disclaimer.
12  * * Redistributions in binary form must reproduce the above copyright
13  *   notice, this list of conditions and the following disclaimer in
14  *   the documentation and/or other materials provided with the
15  *   distribution.
16  * * Neither the name of olsr.org, olsrd nor the names of its
17  *   contributors may be used to endorse or promote products derived
18  *   from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
24  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
26  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
27  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
28  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
30  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31  * POSSIBILITY OF SUCH DAMAGE.
32  *
33  * Visit http://www.olsr.org for more information.
34  *
35  * If you find this software useful feel free to make a donation
36  * to the project. For more information see the website or contact
37  * the copyright holders.
38  *
39  */
40
41 #ifndef LQ_ETX_FF_
42 #define LQ_ETX_FF_
43
44 #include "olsr_types.h"
45 #include "lq_plugin.h"
46
47 #define LQ_PLUGIN_LC_MULTIPLIER 1024
48 #define LQ_PLUGIN_RELEVANT_COSTCHANGE_FF 16
49
50 #define LQ_ALGORITHM_ETX_FF_NAME "etx_ff"
51
52 /* 16,32,64 and max. 128 */
53 #define LQ_FF_WINDOW 64
54 #define LQ_FF_QUICKSTART_INIT 4
55
56 struct default_lq_ff {
57   olsr_u8_t valueLq;
58   olsr_u8_t valueNlq;
59 };
60
61 struct default_lq_ff_hello {
62   struct default_lq_ff lq;
63         olsr_u8_t windowSize, activePtr;
64         olsr_u16_t last_seq_nr;
65         olsr_u16_t received[LQ_FF_WINDOW], lost[LQ_FF_WINDOW];
66 };
67
68 void default_lq_initialize_ff(void);
69
70 olsr_linkcost default_lq_calc_cost_ff(const void *lq);
71
72 olsr_bool default_lq_is_relevant_costchange_ff(olsr_linkcost c1, olsr_linkcost c2);
73
74 olsr_linkcost default_lq_packet_loss_worker_ff(struct link_entry *link, void *lq, olsr_bool lost);
75 void default_lq_memorize_foreign_hello_ff(void *local, void *foreign);
76
77 int default_lq_serialize_hello_lq_pair_ff(unsigned char *buff, void *lq);
78 void default_lq_deserialize_hello_lq_pair_ff(const olsr_u8_t **curr, void *lq);
79 int default_lq_serialize_tc_lq_pair_ff(unsigned char *buff, void *lq);
80 void default_lq_deserialize_tc_lq_pair_ff(const olsr_u8_t **curr, void *lq);
81
82 void default_lq_copy_link2tc_ff(void *target, void *source);
83 void default_lq_clear_ff(void *target);
84 void default_lq_clear_ff_hello(void *target);
85
86 const char *default_lq_print_ff(void *ptr, char separator, struct lqtextbuffer *buffer);
87 const char *default_lq_print_cost_ff(olsr_linkcost cost, struct lqtextbuffer *buffer);
88
89 extern struct lq_handler lq_etx_ff_handler;
90
91 #endif /*LQ_ETX_FF_*/
92
93 /*
94  * Local Variables:
95  * c-basic-offset: 2
96  * indent-tabs-mode: nil
97  * End:
98  */