new lq-plugin (etx_ff)
[olsrd.git] / src / lq_plugin_default_fpm.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_FPM_
42 #define LQ_ETX_FPM_
43
44 #include "olsr_types.h"
45 #include "lq_plugin.h"
46
47 /* use only 1<<16 - 1 to allow the multiplication of two
48  * upscaled numbers between 0 and 1 */
49 #define LQ_FPM_INTERNAL_MULTIPLIER 65535
50 #define LQ_FPM_LINKCOST_MULTIPLIER 65535
51
52 #define LQ_PLUGIN_RELEVANT_COSTCHANGE_FPM 64
53
54 #define LQ_ALGORITHM_ETX_FPM_NAME "etx_fpm"
55
56 struct default_lq_fpm {
57         olsr_u8_t valueLq;
58         olsr_u8_t valueNlq;
59         olsr_u16_t quickstart;
60 };
61
62 void default_lq_initialize_fpm(void);
63
64 olsr_linkcost default_lq_calc_cost_fpm(const void *lq);
65
66 olsr_bool default_lq_is_relevant_costchange_fpm(olsr_linkcost c1, olsr_linkcost c2);
67
68 olsr_linkcost default_lq_packet_loss_worker_fpm(struct link_entry *link, void *lq, olsr_bool lost);
69 void default_lq_memorize_foreign_hello_fpm(void *local, void *foreign);
70
71 int default_lq_serialize_hello_lq_pair_fpm(unsigned char *buff, void *lq);
72 void default_lq_deserialize_hello_lq_pair_fpm(const olsr_u8_t **curr, void *lq);
73 int default_lq_serialize_tc_lq_pair_fpm(unsigned char *buff, void *lq);
74 void default_lq_deserialize_tc_lq_pair_fpm(const olsr_u8_t **curr, void *lq);
75
76 void default_lq_copy_link2tc_fpm(void *target, void *source);
77 void default_lq_clear_fpm(void *target);
78
79 const char *default_lq_print_fpm(void *ptr, struct lqtextbuffer *buffer);
80 const char *default_lq_print_cost_fpm(olsr_linkcost cost, struct lqtextbuffer *buffer);
81
82 extern struct lq_handler lq_etx_fpm_handler;
83
84 #endif /*LQ_ETX_FPM_*/