Improvement for lq_ff metric (goes slowly down if no packages are received over a...
[olsrd.git] / lib / lq_etx_ff / src / lq_plugin_etx_ff.h
1 /*
2  * The olsr.org Optimized Link-State Routing daemon(olsrd)
3  * Copyright (c) 2004-2009, the olsr.org team - see HISTORY file
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_PLUGIN_ETX_FF_
42 #define LQ_PLUGIN_ETX_FF_
43
44 #include "olsr_types.h"
45 #include "tc_set.h"
46 #include "link_set.h"
47 #include "lq_packet.h"
48 #include "lq_plugin.h"
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 lq_etxff_linkquality {
57   uint8_t valueLq;
58   uint8_t valueNlq;
59 };
60
61 struct lq_etxff_tc_edge {
62   struct tc_entry core;
63   struct lq_etxff_linkquality lq;
64 };
65
66 struct lq_etxff_tc_mpr_addr {
67   struct tc_mpr_addr core;
68   struct lq_etxff_linkquality lq;
69 };
70
71 struct lq_etxff_lq_hello_neighbor {
72   struct lq_hello_neighbor core;
73   struct lq_etxff_linkquality lq;
74 };
75
76 struct lq_etxff_link_entry {
77   struct link_entry core;
78   struct lq_etxff_linkquality lq;
79   uint8_t windowSize, activePtr;
80   uint16_t last_seq_nr;
81   uint16_t missed_seconds;
82   uint16_t received[LQ_FF_WINDOW], lost[LQ_FF_WINDOW];
83 };
84
85 extern struct lq_handler lq_etxff_handler;
86
87 #endif /*LQ_PLUGIN_ETX_FF_*/
88
89 /*
90  * Local Variables:
91  * c-basic-offset: 2
92  * indent-tabs-mode: nil
93  * End:
94  */