Refactoring of olsr_interface data to if_index instead of name
[oonf.git] / src-api / core / olsr_interface.h
1
2 /*
3  * The olsr.org Optimized Link-State Routing daemon(olsrd)
4  * Copyright (c) 2004-2012, 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   /* mac address of interface */
62   struct netaddr mac;
63
64   /* interface name */
65   char name[IF_NAMESIZE];
66
67   /* interface index */
68   unsigned index;
69
70   /* true if the interface exists and is up */
71   bool up;
72 };
73
74 struct olsr_interface {
75   /* hook interfaces into tree */
76   struct avl_node node;
77
78   /* data of interface */
79   struct olsr_interface_data data;
80
81   /*
82    * usage counter to allow multiple instances to add the same
83    * interface
84    */
85   int usage_counter;
86
87   /*
88    * usage counter to keep track of the number of users on
89    * this interface who want to send mesh traffic
90    */
91   int mesh_counter;
92
93   /*
94    * used to store internal state of interfaces before
95    * configuring them for manet data forwarding.
96    * Only used by os_specific code.
97    */
98   uint32_t _original_state;
99
100   /* timer for lazy interface change handling */
101   struct olsr_timer_entry change_timer;
102 };
103
104 struct olsr_interface_listener {
105   /* hook into list of listeners */
106   struct list_entity node;
107
108   /* restrict listener to this interface */
109   uint32_t if_index;
110
111   /* name of interface, will initialize if_index if its 0 */
112   const char *name;
113
114   /*
115    * set to true if listener is on a mesh traffic interface.
116    * keep this false if in doubt, true will trigger some interface
117    * reconfiguration to allow forwarding of user traffic
118    */
119   bool mesh;
120
121   /* callback for interface change */
122   void (*process)(struct olsr_interface *, struct olsr_interface_data *old);
123 };
124
125 #define OLSR_FOR_ALL_INTERFACES(interf, ptr) avl_for_each_element_safe(&olsr_interface_tree, interf, node, ptr)
126 EXPORT extern struct avl_tree olsr_interface_tree;
127
128 EXPORT int olsr_interface_init(void) __attribute__((warn_unused_result));
129 EXPORT void olsr_interface_cleanup(void);
130
131 EXPORT struct olsr_interface *olsr_interface_add_listener(
132     struct olsr_interface_listener *);
133 EXPORT void olsr_interface_remove_listener(struct olsr_interface_listener *);
134
135 EXPORT struct olsr_interface_data *olsr_interface_get_data(uint32_t if_index);
136 EXPORT void olsr_interface_trigger_change(uint32_t if_index);
137
138 #endif /* INTERFACE_H_ */