db3bf908a6e69678372e2bff38a9a4b1559630ef
[oonf.git] / include / oonf / subsystems / oonf_packet_socket.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 OONF_PACKET_SOCKET_H_
47 #define OONF_PACKET_SOCKET_H_
48
49 #include <oonf/libcommon/autobuf.h>
50 #include <oonf/oonf.h>
51 #include <oonf/libcommon/list.h>
52 #include <oonf/libcommon/netaddr.h>
53 #include <oonf/libcommon/netaddr_acl.h>
54 #include <oonf/subsystems/oonf_socket.h>
55 #include <oonf/subsystems/os_interface.h>
56
57 #ifndef _WIN32
58 #include <net/if.h>
59 #endif
60
61 /*! subsystem identifier */
62 #define OONF_PACKET_SUBSYSTEM "packet_socket"
63
64 struct oonf_packet_socket;
65
66 enum
67 {
68   OONF_PACKET_ERRNO1_SUPPRESSION_THRESHOLD = 10,
69   OONF_PACKET_ERRNO1_SUPPRESSION_INTERVAL = 60000,
70 };
71
72 /**
73  * Configuraten of a packet socket
74  */
75 struct oonf_packet_config {
76   /*! pointer to buffer for incoming data */
77   void *input_buffer;
78
79   /*! length of input buffer */
80   size_t input_buffer_length;
81
82   /**
83    * Callback triggered when an UDP packet has been received
84    * @param psock packet socket
85    * @param from IP source address
86    * @param ptr pointer to packet data
87    * @param length length of packet data
88    */
89   void (*receive_data)(struct oonf_packet_socket *psock, union netaddr_socket *from, void *ptr, size_t length);
90
91   /*! true if the outgoing UDP traffic should not be routed */
92   bool dont_route;
93
94   /*! user defined pointer */
95   void *user;
96 };
97
98 /**
99  * Definition of a packet socket
100  */
101 struct oonf_packet_socket {
102   /*! hook into global list of packet sockets */
103   struct list_entity node;
104
105   /*! scheduler hook to handle incoming and outgoing data */
106   struct oonf_socket_entry scheduler_entry;
107
108   /*! address and port of the local UDP socket */
109   union netaddr_socket local_socket;
110
111   /*! IP protocol number for raw sockets */
112   int protocol;
113
114   /*! outgoing buffer */
115   struct autobuf out;
116
117   /*! interface data the socket is bound to */
118   struct os_interface *os_if;
119
120   /*! configuration of packet socket */
121   struct oonf_packet_config config;
122
123   /*! name of socket */
124   char socket_name[sizeof(struct netaddr_str) + 5];
125
126   /*! true if errno==1 suppression is active */
127   bool _errno1_suppression;
128
129   /*! begin of current errno==1 measurement interval */
130   uint64_t _errno1_measurement_time;
131
132   /*! number of suppressed errno==1 warnings */
133   uint32_t _errno1_count;
134 };
135
136 /**
137  * Configuration of a managed dualstack unicast
138  * (and optionally multicast) UDP socket
139  */
140 struct oonf_packet_managed_config {
141   /*! access control list for incoming source IP addresses */
142   struct netaddr_acl acl;
143
144   /*! name to bind to socket on */
145   char interface[IF_NAMESIZE];
146
147   /*! access control list to restrict the IPs the socket is bound to */
148   struct netaddr_acl bindto;
149
150   /*! IPv4 multicast address for socket */
151   struct netaddr multicast_v4;
152
153   /*! IPv6 multicast address for socket */
154   struct netaddr multicast_v6;
155
156   /*! unicast UDP port for socket, 0 for random port */
157   int32_t port;
158
159   /*! multicast UDP port for socket, 0 for same as unicast port */
160   int32_t multicast_port;
161
162   /*! IP protocol id for socket, used for raw sockets */
163   int32_t protocol;
164
165   /*! true if multicast should be looped locally */
166   bool loop_multicast;
167
168   /*! TTL of outgoing multicast traffic */
169   int32_t ttl_multicast;
170
171   /*! true if socket needs interface to switch to mesh mode */
172   bool mesh;
173
174   /*! true if this is a raw IP socket */
175   bool rawip;
176
177   /*! IP dscp value for outgoing traffic */
178   int32_t dscp;
179 };
180
181 /**
182  * managed dualstack UDP socket
183  */
184 struct oonf_packet_managed {
185   /**
186    * socket for send/receive IPv4 UDP unicast
187    * and sending IPv4 UDP multicast
188    */
189   struct oonf_packet_socket socket_v4;
190
191   /*! socket for receiving IPv4 UDP multicast */
192   struct oonf_packet_socket multicast_v4;
193
194   /**
195    * socket for send/receive IPv6 UDP unicast
196    * and sending IPv6 UDP multicast
197    */
198   struct oonf_packet_socket socket_v6;
199
200   /*! socket for receiving IPv4 UDP multicast */
201   struct oonf_packet_socket multicast_v6;
202
203   /*! socket configuration that will be used for all four sockets */
204   struct oonf_packet_config config;
205
206   /**
207    * Callback to inform about a change of socket settings
208    * @param managed managed socket
209    * @param changed true if one of the sockets had to be reconfigured
210    */
211   void (*cb_settings_change)(struct oonf_packet_managed *managed, bool changed);
212
213   /*! configuration of managed socket */
214   struct oonf_packet_managed_config _managed_config;
215
216   /*! interface listener to detect changes */
217   struct os_interface_listener _if_listener;
218 };
219
220 EXPORT int oonf_packet_add(struct oonf_packet_socket *, union netaddr_socket *local, struct os_interface *);
221 EXPORT int oonf_packet_raw_add(
222   struct oonf_packet_socket *, int protocol, union netaddr_socket *local, struct os_interface *os_if);
223 EXPORT void oonf_packet_remove(struct oonf_packet_socket *, bool);
224
225 EXPORT int oonf_packet_send(struct oonf_packet_socket *, union netaddr_socket *remote, const void *data, size_t length);
226 EXPORT int oonf_packet_send_managed(
227   struct oonf_packet_managed *, union netaddr_socket *remote, const void *data, size_t length);
228 EXPORT int oonf_packet_send_managed_multicast(
229   struct oonf_packet_managed *managed, const void *data, size_t length, int af_type);
230 EXPORT void oonf_packet_add_managed(struct oonf_packet_managed *);
231 EXPORT int oonf_packet_apply_managed(struct oonf_packet_managed *, const struct oonf_packet_managed_config *);
232 EXPORT void oonf_packet_remove_managed(struct oonf_packet_managed *, bool force);
233 EXPORT bool oonf_packet_managed_is_active(struct oonf_packet_managed *managed, int af_type);
234 EXPORT void oonf_packet_copy_managed_config(
235   struct oonf_packet_managed_config *dst, const struct oonf_packet_managed_config *src);
236 EXPORT void oonf_packet_free_managed_config(struct oonf_packet_managed_config *config);
237
238 /**
239  * @param sock pointer to packet socket
240  * @return true if the socket is active to send data, false otherwise
241  */
242 static INLINE bool
243 oonf_packet_is_active(struct oonf_packet_socket *sock) {
244   return list_is_node_added(&sock->node);
245 }
246
247 #endif /* OONF_PACKET_SOCKET_H_ */