Refactoring of olsr_interface data to if_index instead of name
[oonf.git] / src-api / core / os_net.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 OS_NET_H_
43 #define OS_NET_H_
44
45 #include <unistd.h>
46 #include <sys/select.h>
47
48 #include "common/common_types.h"
49 #include "common/netaddr.h"
50 #include "olsr_logging.h"
51 #include "olsr_interface.h"
52
53 /*
54  * Set one of the following defines in the os specific os_net includes
55  * to OS_SPECIFIC to define that the os code is implementing the function
56  * itself and does not use the generic function
57  * Set it to OS_GENERIC to define that the code use the default implementation.
58  *
59  * Example from os_net_linux.h:
60  *
61  * #define OS_NET_GETSOCKET    OS_GENERIC
62  * #define OS_NET_CONFIGSOCKET OS_GENERIC
63  * #define OS_NET_JOINMCAST    OS_GENERIC
64  * #define OS_NET_SETNONBLOCK  OS_GENERIC
65  * #define OS_NET_CLOSE        OS_GENERIC
66  * #define OS_NET_SELECT       OS_GENERIC
67  * #define OS_NET_RECVFROM     OS_GENERIC
68  * #define OS_NET SENDTO       OS_GENERIC
69  */
70
71 /* set the guard macro so we can include the os specific settings */
72 #define OS_NET_SPECIFIC_INCLUDE
73 #include "os_helper.h"
74
75 #ifdef OS_LINUX
76 #include "os_linux/os_net_linux.h"
77 #endif
78
79 #ifdef OS_BSD
80 #include "os_bsd/os_net_bsd.h"
81 #endif
82
83 #ifdef OS_WIN32
84 #include "os_win32/os_net_win32.h"
85 #endif
86
87 #undef OS_NET_SPECIFIC_INCLUDE
88
89 /* binary flags for os_net_getsocket */
90 enum olsr_socket_opt {
91   OS_SOCKET_UDP = 0,
92   OS_SOCKET_TCP = 1,
93   OS_SOCKET_BLOCKING = 2,
94   OS_SOCKET_MULTICAST = 4,
95 };
96
97 /* prototypes for all os_net functions */
98 EXPORT int os_net_init(void) __attribute__((warn_unused_result));
99 EXPORT void os_net_cleanup(void);
100 EXPORT int os_net_getsocket(union netaddr_socket *bindto,
101     enum olsr_socket_opt flags, int recvbuf, enum log_source log_src);
102 EXPORT int os_net_configsocket(int sock, union netaddr_socket *bindto,
103     enum olsr_socket_opt flags, int recvbuf, enum log_source log_src);
104 EXPORT int net_os_join_mcast(int sock, union netaddr_socket *multicast,
105     struct olsr_interface *oif, enum log_source log_src);
106 EXPORT int os_net_set_nonblocking(int sock);
107 EXPORT int os_net_update_interface(struct olsr_interface_data *, uint32_t if_index);
108 EXPORT int os_recvfrom(
109     int fd, void *buf, size_t length, union netaddr_socket *source);
110 EXPORT int os_sendto(
111     int fd, const void *buf, size_t length, union netaddr_socket *dst);
112 static INLINE int os_close(int fd);
113 static INLINE int os_select(
114     int num, fd_set *r,fd_set *w,fd_set *e, struct timeval *timeout);
115
116 /*
117  * INLINE implementations for generic os_net functions
118  */
119
120 #if OS_NET_CLOSE == OS_GENERIC
121 /**
122  * Close a file descriptor
123  * @param fd filedescriptor
124  */
125 static INLINE int
126 os_close(int fd) {
127   return close(fd);
128 }
129 #endif
130
131 #if OS_NET_SELECT == OS_GENERIC
132 /**
133  * polls a number of sockets for network events. If no even happens or
134  * already has happened, function will return after timeout time.
135  * see 'man select' for more details
136  * @param num
137  * @param r
138  * @param w
139  * @param e
140  * @param timeout
141  * @return
142  */
143 static INLINE int
144 os_select(int num, fd_set *r,fd_set *w,fd_set *e, struct timeval *timeout) {
145   return select(num, r, w, e, timeout);
146 }
147 #endif
148
149 #endif /* OS_NET_H_ */