Move some setup functions from os_routing to os_net
[oonf.git] / src-api / core / os_net.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 OS_NET_H_
43 #define OS_NET_H_
44
45 #include <unistd.h>
46 #include <sys/select.h>
47
48 #include "common/avl.h"
49 #include "common/common_types.h"
50 #include "common/list.h"
51 #include "common/netaddr.h"
52 #include "core/olsr_logging.h"
53 #include "core/olsr_timer.h"
54
55 struct olsr_interface_data {
56   /* Interface addresses with mesh-wide scope (at least) */
57   struct netaddr *if_v4, *if_v6;
58
59   /* IPv6 Interface address with global scope */
60   struct netaddr *linklocal_v6_ptr;
61
62   /* mac address of interface */
63   struct netaddr mac;
64
65   /* list of all addresses of the interface */
66   struct netaddr *addresses;
67   size_t addrcount;
68
69   /* interface name */
70   char name[IF_NAMESIZE];
71
72   /* interface index */
73   unsigned index;
74
75   /* true if the interface exists and is up */
76   bool up;
77 };
78
79 struct olsr_interface {
80   /* data of interface */
81   struct olsr_interface_data data;
82
83   /*
84    * usage counter to allow multiple instances to add the same
85    * interface
86    */
87   int usage_counter;
88
89   /*
90    * usage counter to keep track of the number of users on
91    * this interface who want to send mesh traffic
92    */
93   int mesh_counter;
94
95   /*
96    * used to store internal state of interfaces before
97    * configuring them for manet data forwarding.
98    * Only used by os_specific code.
99    */
100   uint32_t _original_state;
101
102   /* hook interfaces into tree */
103   struct avl_node _node;
104
105   /* timer for lazy interface change handling */
106   struct olsr_timer_entry _change_timer;
107 };
108
109 /* pre-declare inlines */
110 static INLINE int os_net_bindto_interface(int, struct olsr_interface_data *data);
111 static INLINE int os_close(int fd);
112 static INLINE int os_select(
113     int num, fd_set *r,fd_set *w,fd_set *e, struct timeval *timeout);
114
115 /* include os-specific headers */
116 #if defined(__linux__)
117 #include "core/os_linux/os_net_linux.h"
118 #elif defined (BSD)
119 #include "core/os_bsd/os_net_bsd.h"
120 #elif defined (_WIN32)
121 #include "core/os_win32/os_net_win32.h"
122 #else
123 #error "Unknown operation system"
124 #endif
125
126 EXPORT extern struct oonf_subsystem oonf_os_net_subsystem;
127
128 /* prototypes for all os_net functions */
129 EXPORT int os_net_getsocket(union netaddr_socket *bindto,
130     bool tcp, int recvbuf, struct olsr_interface_data *, enum log_source log_src);
131 EXPORT int os_net_configsocket(int sock, union netaddr_socket *bindto,
132     int recvbuf, struct olsr_interface_data *, enum log_source log_src);
133 EXPORT int os_net_set_nonblocking(int sock);
134 EXPORT int os_net_join_mcast_recv(int sock, struct netaddr *multicast,
135     struct olsr_interface_data *oif, enum log_source log_src);
136 EXPORT int os_net_join_mcast_send(int sock, struct netaddr *multicast,
137     struct olsr_interface_data *oif, bool loop, enum log_source log_src);
138 EXPORT int os_net_update_interface(struct olsr_interface_data *, const char *);
139 EXPORT int os_recvfrom(int fd, void *buf, size_t length,
140     union netaddr_socket *source, struct olsr_interface_data *);
141 EXPORT int os_sendto(
142     int fd, const void *buf, size_t length, union netaddr_socket *dst);
143
144 EXPORT int os_net_init_mesh_if(struct olsr_interface *);
145 EXPORT void os_net_cleanup_mesh_if(struct olsr_interface *);
146
147 #endif /* OS_NET_H_ */