dea4a68bfa1ff4b61e9039fb5bfdf319df7387e1
[oonf.git] / src-api / core / olsr_interface.h
1
2 /*
3  * The olsr.org Optimized Link-State Routing daemon(olsrd)
4  * Copyright (c) 2004-2013, 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 <ifaddrs.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 "core/olsr_timer.h"
53 #include "core/os_net.h"
54
55 struct olsr_interface {
56   /* data of interface */
57   struct olsr_interface_data data;
58
59   /*
60    * usage counter to allow multiple instances to add the same
61    * interface
62    */
63   int usage_counter;
64
65   /*
66    * usage counter to keep track of the number of users on
67    * this interface who want to send mesh traffic
68    */
69   int mesh_counter;
70
71   /*
72    * used to store internal state of interfaces before
73    * configuring them for manet data forwarding.
74    * Only used by os_specific code.
75    */
76   uint32_t _original_state;
77
78   /* hook interfaces into tree */
79   struct avl_node _node;
80
81   /* timer for lazy interface change handling */
82   struct olsr_timer_entry _change_timer;
83 };
84
85 struct olsr_interface_listener {
86   /* name of interface */
87   const char *name;
88
89   /*
90    * set to true if listener is on a mesh traffic interface.
91    * keep this false if in doubt, true will trigger some interface
92    * reconfiguration to allow forwarding of user traffic
93    */
94   bool mesh;
95
96   /* callback for interface change */
97   void (*process)(struct olsr_interface_listener *);
98
99   /*
100    * pointer to the interface this listener is registered to, will be
101    * set by the core while process() is called
102    */
103   struct olsr_interface *interface;
104
105   /*
106    * pointer to the interface data before the change happened, will be
107    * set by the core while process() is called
108    */
109   struct olsr_interface_data *old;
110
111   /* hook into list of listeners */
112   struct list_entity _node;
113 };
114
115 EXPORT extern struct avl_tree olsr_interface_tree;
116 EXPORT extern struct oonf_subsystem oonf_interface_subsystem;
117
118 EXPORT int olsr_interface_add_listener(struct olsr_interface_listener *);
119 EXPORT void olsr_interface_remove_listener(struct olsr_interface_listener *);
120
121 EXPORT struct olsr_interface_data *olsr_interface_get_data(const char *name);
122 EXPORT void olsr_interface_trigger_change(const char *name, bool down);
123 EXPORT void olsr_interface_trigger_handler(struct olsr_interface *interf);
124
125 EXPORT int olsr_interface_find_address(struct netaddr *dst,
126     struct netaddr *prefix, struct olsr_interface_data *);
127
128 #endif /* INTERFACE_H_ */