47fdddf14f68ece40e30dbd51f3190490b05d6fa
[oonf.git] / include / oonf / subsystems / os_linux / os_interface_linux.h
1
2 /*
3  * The olsr.org Optimized Link-State Routing daemon version 2 (olsrd2)
4  * Copyright (c) 2004-2015, 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 /**
43  * @file
44  */
45
46 #ifndef OS_INTERFACE_LINUX_H_
47 #define OS_INTERFACE_LINUX_H_
48
49 #include <linux/netlink.h>
50 #include <linux/rtnetlink.h>
51
52 #include <oonf/oonf.h>
53 #include <oonf/subsystems/os_generic/os_interface_generic.h>
54 #include <oonf/subsystems/os_interface.h>
55
56 enum
57 {
58   /*! interval until an interface change trigger will be activated again */
59   OS_INTERFACE_CHANGE_TRIGGER_INTERVAL = 200,
60 };
61
62 #define OS_INTERFACE_ANY "any"
63
64 EXPORT struct os_interface *os_interface_linux_add(struct os_interface_listener *);
65 EXPORT void os_interface_linux_remove(struct os_interface_listener *);
66 EXPORT struct avl_tree *os_interface_linux_get_tree(void);
67
68 EXPORT void os_interface_linux_trigger_handler(struct os_interface_listener *);
69
70 EXPORT int os_interface_linux_state_set(struct os_interface *, bool up);
71 EXPORT int os_interface_linux_mac_set(struct os_interface *interf, struct netaddr *mac);
72
73 EXPORT int os_interface_linux_address_set(struct os_interface_ip_change *addr);
74 EXPORT void os_interface_linux_address_interrupt(struct os_interface_ip_change *addr);
75
76 /**
77  * Add an interface to the OONF handling
78  * @param interf network interface
79  * @return interface data object
80  */
81 static INLINE struct os_interface *
82 os_interface_add(struct os_interface_listener *interf) {
83   return os_interface_linux_add(interf);
84 }
85
86 /**
87  * Remove an interface from the OONF handling
88  * @param interf network interface
89  */
90 static INLINE void
91 os_interface_remove(struct os_interface_listener *interf) {
92   os_interface_linux_remove(interf);
93 }
94
95 /**
96  * @return tree of network interfaces
97  */
98 static INLINE struct avl_tree *
99 os_interface_get_tree(void) {
100   return os_interface_linux_get_tree();
101 }
102
103 /**
104  * Trigger an interface change handler
105  * @param interf network interface
106  */
107 static INLINE void
108 os_interface_trigger_handler(struct os_interface_listener *interf) {
109   os_interface_linux_trigger_handler(interf);
110 }
111
112 /**
113  * Set interface up or down
114  * @param os_if network interface
115  * @param up true if interface should be up, false if down
116  * @return -1 if an error happened, 0 otherwise
117  */
118 static INLINE int
119 os_interface_state_set(struct os_interface *os_if, bool up) {
120   return os_interface_linux_state_set(os_if, up);
121 }
122
123 /**
124  * Set or remove an IP address from an interface
125  * @param addr interface address change request
126  * @return -1 if the request could not be sent to the server,
127  *   0 otherwise
128  */
129 static INLINE int
130 os_interface_address_set(struct os_interface_ip_change *addr) {
131   return os_interface_linux_address_set(addr);
132 }
133
134 /**
135  * Stop processing an interface address change
136  * @param addr interface address change request
137  */
138 static INLINE void
139 os_interface_address_interrupt(struct os_interface_ip_change *addr) {
140   os_interface_linux_address_interrupt(addr);
141 }
142
143 /**
144  * Set mac address of interface
145  * @param os_if interface data object
146  * @param mac new mac address
147  * @return -1 if an error happened, 0 otherwise
148  */
149 static INLINE int
150 os_interface_mac_set(struct os_interface *os_if, struct netaddr *mac) {
151   return os_interface_linux_mac_set(os_if, mac);
152 }
153
154 static INLINE struct os_interface *
155 os_interface_get_data_by_ifindex(unsigned ifindex) {
156   return os_interface_generic_get_data_by_ifindex(ifindex);
157 }
158
159 static INLINE struct os_interface *
160 os_interface_get_data_by_ifbaseindex(unsigned ifindex) {
161   return os_interface_generic_get_data_by_ifbaseindex(ifindex);
162 }
163
164 static INLINE const struct netaddr *
165 os_interface_get_bindaddress(int af_type, struct netaddr_acl *filter, struct os_interface *ifdata) {
166   return os_interface_generic_get_bindaddress(af_type, filter, ifdata);
167 }
168
169 static INLINE const struct os_interface_ip *
170 os_interface_get_prefix_from_dst(struct netaddr *destination, struct os_interface *ifdata) {
171   return os_interface_generic_get_prefix_from_dst(destination, ifdata);
172 }
173
174 #endif /* OS_INTERFACE_LINUX_H_ */