aae4dd62fe83424b48658559dfdcfd0a5bae9a3f
[oonf.git] / include / oonf / subsystems / os_linux / os_system_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_SYSTEM_LINUX_H_
47 #define OS_SYSTEM_LINUX_H_
48
49 #include <linux/netlink.h>
50 #include <linux/rtnetlink.h>
51
52 #include <oonf/libcommon/netaddr.h>
53 #include <oonf/libcore/oonf_subsystem.h>
54 #include <oonf/subsystems/oonf_socket.h>
55 #include <oonf/subsystems/oonf_timer.h>
56
57 /*! default timeout for netlink messages */
58 #define OS_SYSTEM_NETLINK_TIMEOUT 1000
59
60 /**
61  * A buffer for transmitting netlink commands to the operation system
62  */
63 struct os_system_netlink_buffer {
64   /*! hook into list of currently used buffers */
65   struct list_entity _node;
66
67   /*! total number of bytes in buffer */
68   uint32_t total;
69
70   /*! total number of messages in buffer */
71   uint32_t messages;
72 };
73
74 /**
75  * Linux netlink handler
76  */
77 struct os_system_netlink {
78   /*! name of netlink handler */
79   const char *name;
80
81   /*! socket handler for netlink communication */
82   struct oonf_socket_entry socket;
83
84   /*! output buffer for netlink data */
85   struct autobuf out;
86
87   /*! number of messages in output buffer */
88   uint32_t out_messages;
89
90   /*! link of data buffers to transmit */
91   struct list_entity buffered;
92
93   /*! subsystem that uses this netlink handler */
94   struct oonf_subsystem *used_by;
95
96   /*! pointer to currently processed netlink message header */
97   struct nlmsghdr *in;
98
99   /*! number of bytes of currently processed netlink message */
100   size_t in_len;
101
102   /*! number of messages in transit to the kernel */
103   int msg_in_transit;
104
105   /**
106    * Callback to handle incoming message from the kernel
107    * @param hdr netlink message header
108    */
109   void (*cb_message)(struct nlmsghdr *hdr);
110
111   /**
112    * Callback to handle error message of kernel
113    * @param seq netlink sequence number that triggered the error
114    * @param error error code
115    */
116   void (*cb_error)(uint32_t seq, int error);
117
118   /**
119    * Callback to notify the netlink communication timed out
120    */
121   void (*cb_timeout)(void);
122
123   /**
124    * Callback to notify that a netlink message has been processed
125    * @param seq sequence number of the processed netlink message
126    */
127   void (*cb_done)(uint32_t seq);
128
129   /*! netlink timeout handler */
130   struct oonf_timer_instance timeout;
131 };
132
133 EXPORT bool os_system_linux_is_ipv6_supported(void);
134
135 EXPORT bool os_system_linux_is_minimal_kernel(int v1, int v2, int v3);
136 EXPORT int os_system_linux_netlink_add(struct os_system_netlink *, int protocol);
137 EXPORT void os_system_linux_netlink_remove(struct os_system_netlink *);
138 EXPORT int os_system_linux_netlink_send(struct os_system_netlink *fd, struct nlmsghdr *nl_hdr);
139 EXPORT int os_system_linux_netlink_add_mc(struct os_system_netlink *, const uint32_t *groups, size_t groupcount);
140 EXPORT int os_system_linux_netlink_drop_mc(struct os_system_netlink *, const int *groups, size_t groupcount);
141
142 EXPORT int os_system_linux_netlink_addreq(
143   struct os_system_netlink *nl, struct nlmsghdr *n, int type, const void *data, int len);
144
145 EXPORT int os_system_linux_linux_get_ioctl_fd(int af_type);
146
147 /**
148  * @return true if IPv6 is supported, false otherwise
149  */
150 static INLINE bool
151 os_system_is_ipv6_supported(void) {
152   return os_system_linux_is_ipv6_supported();
153 }
154
155 /**
156  * Adds an address TLV to a netlink stream
157  * @param nl netlink handler
158  * @param n netlink message header
159  * @param type netlink TLV type
160  * @param addr address
161  * @return -1 if an error happened, 0 otherwise
162  */
163 static INLINE int
164 os_system_linux_netlink_addnetaddr(
165   struct os_system_netlink *nl, struct nlmsghdr *n, int type, const struct netaddr *addr) {
166   return os_system_linux_netlink_addreq(nl, n, type, netaddr_get_binptr(addr), netaddr_get_maxprefix(addr) / 8);
167 }
168
169 #endif /* OS_SYSTEM_LINUX_H_ */