Allow dynamic linking of framework to application
[oonf.git] / src / core / olsr_interface.h
1
2 /*
3  * The olsr.org Optimized Link-State Routing daemon(olsrd)
4  * Copyright (c) 2004-2011, the olsr.org team - see HISTORY file
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 INTERFACE_H_
43 #define INTERFACE_H_
44
45 #include <net/if.h>
46
47 #include "common/common_types.h"
48 #include "common/avl.h"
49 #include "common/list.h"
50 #include "common/netaddr.h"
51
52 #include "olsr_timer.h"
53
54 struct olsr_interface_data {
55   /* Interface addresses with mesh-wide scope (at least) */
56   struct netaddr if_v4, if_v6;
57
58   /* IPv6 Interface address with global scope */
59   struct netaddr linklocal_v6;
60
61   /* interface index */
62   unsigned index;
63
64   /* true if the interface exists and is up */
65   bool up;
66 };
67
68 struct olsr_interface {
69   /* hook interfaces into tree */
70   struct avl_node node;
71
72   /* name of interface */
73   const char *name;
74
75   /* data of interface */
76   struct olsr_interface_data data;
77
78   /*
79    * usage counter to allow multiple instances to add the same
80    * interface
81    */
82   int usage_counter;
83
84   /*
85    * usage counter to keep track of the number of users on
86    * this interface who want to send mesh traffic
87    */
88   int mesh_counter;
89
90   /*
91    * used to store internal state of interfaces before
92    * configuring them for manet data forwarding.
93    * Only used by os_specific code.
94    */
95   uint32_t _original_state;
96
97   /* timer for lazy interface change handling */
98   struct olsr_timer_entry *change_timer;
99 };
100
101 struct olsr_interface_listener {
102   /* hook into list of listeners */
103   struct list_entity node;
104
105   /* restrict listener to one interface or NULL for all interfaces */
106   const char *name;
107
108   /*
109    * set to true if listener is on a mesh traffic interface.
110    * keep this false if in doubt, true will trigger some interface
111    * reconfiguration to allow forwarding of user traffic
112    */
113   bool mesh;
114
115   /* callback for interface change */
116   void (*process)(struct olsr_interface *, struct olsr_interface_data *old);
117 };
118
119 #define OLSR_FOR_ALL_INTERFACES(interf, ptr) avl_for_each_element_safe(&olsr_interface_tree, interf, node, ptr)
120 EXPORT extern struct avl_tree olsr_interface_tree;
121
122 EXPORT int olsr_interface_init(void) __attribute__((warn_unused_result));
123 EXPORT void olsr_interface_cleanup(void);
124
125 EXPORT struct olsr_interface *olsr_interface_add_listener(
126     struct olsr_interface_listener *);
127 EXPORT void olsr_interface_remove_listener(struct olsr_interface_listener *);
128
129 EXPORT void olsr_interface_trigger_change(const char *name);
130
131 #endif /* INTERFACE_H_ */