Some more exports
[olsrd.git] / src / tc_set.h
1 /*
2  * The olsr.org Optimized Link-State Routing daemon(olsrd)
3  * Copyright (c) 2004, Andreas Tonnesen(andreto@olsr.org)
4  * LSDB rewrite (c) 2007, Hannes Gredler (hannes@gredler.at)
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 #ifndef _OLSR_TOP_SET
42 #define _OLSR_TOP_SET
43
44 #include "defs.h"
45 #include "common/avl.h"
46 #include "common/list.h"
47 #include "olsr_protocol.h"
48 #include "lq_packet.h"
49 #include "scheduler.h"
50 #include "olsr_cookie.h"
51
52 /*
53  * This file holds the definitions for the link state database.
54  * The lsdb consists of nodes and edges.
55  * During input parsing all nodes and edges are extracted and synthesized.
56  * The SPF calculation operates on these datasets.
57  */
58
59 struct tc_edge_entry {
60   struct avl_node edge_node;           /* edge_tree node in tc_entry */
61   union olsr_ip_addr T_dest_addr;      /* edge_node key */
62   struct tc_edge_entry *edge_inv;      /* shortcut, used during SPF calculation */
63   struct tc_entry *tc;                 /* backpointer to owning tc entry */
64   olsr_linkcost cost;                  /* metric used for SPF calculation */
65   uint16_t ansn;                       /* ansn of this edge, used for multipart msgs */
66   uint32_t linkquality[0];
67 };
68
69 AVLNODE2STRUCT(edge_tree2tc_edge, struct tc_edge_entry, edge_node);
70
71 struct tc_entry {
72   struct avl_node vertex_node;         /* node keyed by ip address */
73   union olsr_ip_addr addr;             /* vertex_node key */
74   struct avl_node cand_tree_node;      /* SPF candidate heap, node keyed by path_etx */
75   olsr_linkcost path_cost;             /* SPF calculated distance, cand_tree_node key */
76   struct list_node path_list_node;     /* SPF result list */
77   struct avl_tree edge_tree;           /* subtree for edges */
78   struct avl_tree prefix_tree;         /* subtree for prefixes */
79   struct avl_tree mid_tree;            /* subtree for MID entries */
80   struct avl_tree hna_tree;            /* subtree for HNA entries */
81   struct timer_entry *mid_timer;       /* aging timer for MID advertisements */
82   struct link_entry *next_hop;         /* SPF calculated link to the 1st hop neighbor */
83   struct timer_entry *edge_gc_timer;   /* used for edge garbage collection */
84   struct timer_entry *validity_timer;  /* tc validity time */
85   uint32_t refcount;                   /* reference counter */
86   uint16_t msg_seq;                    /* sequence number of the tc message */
87   uint8_t msg_hops;                    /* hopcount as per the tc message */
88   uint8_t hops;                /* SPF calculated hopcount */
89   uint16_t ansn;                       /* ANSN number of the tc message */
90   uint16_t ignored;                    /* how many TC messages ignored in a sequence
91                                           (kindof emergency brake) */
92   uint16_t err_seq;                    /* sequence number of an unplausible TC */
93   bool err_seq_valid;          /* do we have an error (unplauible seq/ansn) */
94 };
95
96 /*
97  * Garbage collection time for edges.
98  * This is used for multipart messages.
99  */
100 #define OLSR_TC_EDGE_GC_TIME (2*1000)   /* milliseconds */
101 #define OLSR_TC_EDGE_GC_JITTER 5        /* percent */
102
103 #define OLSR_TC_VTIME_JITTER 25 /* percent */
104
105
106 AVLNODE2STRUCT(vertex_tree2tc, struct tc_entry, vertex_node);
107 AVLNODE2STRUCT(cand_tree2tc, struct tc_entry, cand_tree_node);
108 LISTNODE2STRUCT(pathlist2tc, struct tc_entry, path_list_node);
109
110 /*
111  * macros for traversing vertices, edges and prefixes in the link state database.
112  * it is recommended to use this because it hides all the internal
113  * datastructure from the callers.
114  *
115  * the loop prefetches the next node in order to not loose context if
116  * for example the caller wants to delete the current entry.
117  */
118 #define OLSR_FOR_ALL_TC_ENTRIES(tc) \
119 { \
120   struct avl_node *tc_tree_node, *next_tc_tree_node; \
121   for (tc_tree_node = avl_walk_first(&tc_tree); \
122     tc_tree_node; tc_tree_node = next_tc_tree_node) { \
123     next_tc_tree_node = avl_walk_next(tc_tree_node); \
124     tc = vertex_tree2tc(tc_tree_node);
125 #define OLSR_FOR_ALL_TC_ENTRIES_END(tc) }}
126
127 #define OLSR_FOR_ALL_TC_EDGE_ENTRIES(tc, tc_edge) \
128 { \
129   struct avl_node *tc_edge_node, *next_tc_edge_node; \
130   for (tc_edge_node = avl_walk_first(&tc->edge_tree); \
131     tc_edge_node; tc_edge_node = next_tc_edge_node) { \
132     next_tc_edge_node = avl_walk_next(tc_edge_node); \
133     tc_edge = edge_tree2tc_edge(tc_edge_node);
134 #define OLSR_FOR_ALL_TC_EDGE_ENTRIES_END(tc, tc_edge) }}
135
136 #define OLSR_FOR_ALL_PREFIX_ENTRIES(tc, rtp) \
137 { \
138   struct avl_node *rtp_node, *next_rtp_node; \
139   for (rtp_node = avl_walk_first(&tc->prefix_tree); \
140     rtp_node; rtp_node = next_rtp_node) { \
141     next_rtp_node = avl_walk_next(rtp_node); \
142     rtp = rtp_prefix_tree2rtp(rtp_node);
143 #define OLSR_FOR_ALL_PREFIX_ENTRIES_END(tc, rtp) }}
144
145 extern struct avl_tree EXPORT(tc_tree);
146 extern struct tc_entry *tc_myself;
147 extern struct olsr_cookie_info *tc_mem_cookie;
148 extern struct olsr_cookie_info *spf_backoff_timer_cookie;
149
150 void olsr_init_tc(void);
151 void olsr_change_myself_tc(void);
152 void olsr_print_tc_table(void);
153 void olsr_time_out_tc_set(void);
154
155 /* tc msg input parser */
156 bool olsr_input_tc(union olsr_message *, struct interface *,
157                    union olsr_ip_addr *from);
158
159 /* tc_entry manipulation */
160 struct tc_entry *EXPORT(olsr_lookup_tc_entry)(const union olsr_ip_addr *);
161 struct tc_entry *olsr_locate_tc_entry(const union olsr_ip_addr *);
162 /*
163  * Increment the reference counter.
164  */
165 static INLINE void olsr_lock_tc_entry(struct tc_entry *tc) { tc->refcount++; }
166 /*
167  * Unlock and free a tc_entry once all references are gone.
168  */
169 static INLINE void olsr_unlock_tc_entry(struct tc_entry *tc) { if (--tc->refcount == 0) { /* All references are gone. */ olsr_cookie_free(tc_mem_cookie, tc); } }
170
171 /* tc_edge_entry manipulation */
172 struct tc_edge_entry *EXPORT(olsr_lookup_tc_edge)(struct tc_entry *,
173                                           union olsr_ip_addr *);
174 struct tc_edge_entry *olsr_add_tc_edge_entry(struct tc_entry *,
175                                              union olsr_ip_addr *, uint16_t);
176 void olsr_delete_tc_entry(struct tc_entry *);
177 void olsr_delete_tc_edge_entry(struct tc_edge_entry *);
178 bool olsr_calc_tc_edge_entry_etx(struct tc_edge_entry *);
179 void olsr_set_tc_edge_timer(struct tc_edge_entry *, unsigned int);
180
181 #endif
182
183 /*
184  * Local Variables:
185  * c-basic-offset: 2
186  * indent-tabs-mode: nil
187  * End:
188  */