udp_send.c: Remove pointless function.
[paraslash.git] / udp_send.c
1 /*
2 * Copyright (C) 2005 Andre Noll <maan@tuebingen.mpg.de>
3 *
4 * Licensed under the GPL v2. For licencing details see COPYING.
5 */
6
7 /** \file udp_send.c Para_server's udp sender. */
8
9 #include <netinet/in.h>
10 #include <sys/socket.h>
11 #include <regex.h>
12 #include <sys/types.h>
13 #include <netinet/udp.h>
14 #include <net/if.h>
15 #include <arpa/inet.h>
16 #include <sys/un.h>
17 #include <netdb.h>
18
19 #include "server.cmdline.h"
20 #include "para.h"
21 #include "error.h"
22 #include "string.h"
23 #include "afh.h"
24 #include "server.h"
25 #include "list.h"
26 #include "send.h"
27 #include "sched.h"
28 #include "vss.h"
29 #include "portable_io.h"
30 #include "net.h"
31 #include "fd.h"
32 #include "close_on_fork.h"
33
34 /**
35 * Time window during which ICMP Destination/Port Unreachable messages are
36 * ignored, covering transient receiver problems such as restarting the
37 * client, rebooting, reconfiguration, or handover.
38 */
39 #define UDP_MAX_UNREACHABLE_TIME 30
40
41 /** Describes one entry in the list of targets for the udp sender. */
42 struct udp_target {
43 /** Track time (seconds) of last ICMP Port Unreachable error */
44 time_t last_unreachable;
45 /** The opaque structure returned by vss_add_fec_client(). */
46 struct fec_client *fc;
47 /** The FEC parameters for this target. */
48 struct fec_client_parms fcp;
49 };
50
51 static struct list_head targets;
52 static int sender_status;
53
54 static void udp_close_target(struct sender_client *sc)
55 {
56 const char *buf;
57 size_t len = vss_get_fec_eof_packet(&buf);
58
59 /*
60 * Ignore the return value of write() since we are closing the target
61 * anyway. The sole purpose of the "do_nothing" statement is to silence
62 * gcc.
63 */
64 if (write(sc->fd, buf, len))
65 do_nothing;
66 }
67
68 static void udp_delete_target(struct sender_client *sc, const char *msg)
69 {
70 struct udp_target *ut = sc->private_data;
71
72 PARA_NOTICE_LOG("deleting %s (%s) from list\n", sc->name, msg);
73 udp_close_target(sc);
74 close(sc->fd);
75 del_close_on_fork_list(sc->fd);
76 vss_del_fec_client(ut->fc);
77 list_del(&sc->node);
78 free(sc->name);
79 free(sc);
80 free(ut);
81 }
82
83 /**
84 * Perform AF-independent multicast sender setup.
85 *
86 * \param sc The connected sender client.
87 *
88 * \return Zero if okay, negative on error.
89 */
90 static int mcast_sender_setup(struct sender_client *sc)
91 {
92 struct sockaddr_storage ss;
93 socklen_t sslen = sizeof(ss);
94 int ttl = conf.udp_ttl_arg, id = 0;
95 const int on = 1;
96
97 if (conf.udp_mcast_iface_given) {
98 char *iface = conf.udp_mcast_iface_arg;
99
100 id = if_nametoindex(iface);
101 if (id == 0)
102 PARA_WARNING_LOG("could not resolve interface '%s', "
103 "using default", iface);
104 }
105
106 if (getpeername(sc->fd, (struct sockaddr *)&ss, &sslen) < 0)
107 goto err;
108 assert(ss.ss_family == AF_INET || ss.ss_family == AF_INET6);
109
110 /* RFC 3493, 5.2: -1 means 'use kernel default' */
111 if (ttl < 0 || ttl > 255)
112 ttl = -1;
113
114 switch (ss.ss_family) {
115 case AF_INET:
116 if (!IN_MULTICAST(htonl(((struct sockaddr_in *)&ss)->sin_addr.s_addr)))
117 return 0;
118 if (id != 0) {
119 #ifdef HAVE_IP_MREQN
120 struct ip_mreqn mn;
121
122 memset(&mn, 0, sizeof(mn));
123 mn.imr_ifindex = id;
124 if (setsockopt(sc->fd, IPPROTO_IP, IP_MULTICAST_IF, &mn, sizeof(mn)) < 0)
125 goto err;
126 #else
127 PARA_ERROR_LOG("No support for setting outgoing IPv4 mcast interface.");
128 #endif
129 }
130 /*
131 * Enable receiving multicast messages generated on the local host
132 * At least on Linux, this is enabled by default.
133 */
134 if (setsockopt(sc->fd, IPPROTO_IP, IP_MULTICAST_LOOP, &on, sizeof(on)) < 0)
135 break;
136
137 /* Default: use local subnet (do not flood out into the WAN) */
138 if (ttl == -1)
139 ttl = 1;
140 if (setsockopt(sc->fd, IPPROTO_IP, IP_MULTICAST_TTL, &ttl, sizeof(ttl)) < 0)
141 break;
142 return 0;
143 case AF_INET6:
144 if (!IN6_IS_ADDR_MULTICAST(&((struct sockaddr_in6 *)&ss)->sin6_addr))
145 return 0;
146 if (id != 0 &&
147 setsockopt(sc->fd, IPPROTO_IPV6, IPV6_MULTICAST_IF, &id, sizeof(id)) < 0)
148 break;
149 if (setsockopt(sc->fd, IPPROTO_IPV6, IPV6_MULTICAST_LOOP, &on, sizeof(on)) < 0)
150 break;
151 if (setsockopt(sc->fd, IPPROTO_IPV6, IPV6_MULTICAST_HOPS, &ttl, sizeof(ttl)) < 0)
152 break;
153 return 0;
154 }
155 err:
156 return -ERRNO_TO_PARA_ERROR(errno);
157 }
158
159 static void udp_shutdown_targets(void)
160 {
161 struct sender_client *sc, *tmp;
162 list_for_each_entry_safe(sc, tmp, &targets, node)
163 udp_close_target(sc);
164 }
165
166 static int udp_resolve_target(const char *url, struct sender_command_data *scd)
167 {
168 const char *result;
169 int ret, port;
170
171 ret = parse_fec_url(url, scd);
172 if (ret)
173 return ret;
174 port = scd->port > 0 ? scd->port : conf.udp_default_port_arg;
175
176 ret = para_connect_simple(IPPROTO_UDP, scd->host, port);
177 if (ret < 0)
178 return ret;
179
180 result = remote_name(ret);
181 close(ret);
182
183 if (!parse_url(result, scd->host, sizeof(scd->host), &scd->port))
184 return -E_ADDRESS_LOOKUP;
185 return 1;
186 }
187
188 static int udp_com_on(__a_unused struct sender_command_data *scd)
189 {
190 sender_status = SENDER_ON;
191 return 1;
192 }
193
194 static int udp_com_off(__a_unused struct sender_command_data *scd)
195 {
196 udp_shutdown_targets();
197 sender_status = SENDER_OFF;
198 return 1;
199 }
200
201 static struct sender_client *udp_lookup_target(struct sender_command_data *scd)
202 {
203 struct sender_client *sc, *tmp;
204 char host[MAX_HOSTLEN];
205 int32_t port;
206
207 list_for_each_entry_safe(sc, tmp, &targets, node) {
208 parse_url(sc->name, host, sizeof(host), &port);
209
210 /* Unspecified port means wildcard port match */
211 if (scd->port > 0 && scd->port != port)
212 continue;
213 if (strcmp(host, scd->host))
214 continue;
215 return sc;
216 }
217 return NULL;
218 }
219
220 static int udp_com_delete(struct sender_command_data *scd)
221 {
222 struct sender_client *sc = udp_lookup_target(scd);
223
224 if (sc) {
225 udp_delete_target(sc, "com_delete");
226 return 1;
227 }
228 PARA_NOTICE_LOG("not deleting non-existing target '%s'\n", scd->host);
229 return -E_TARGET_NOT_FOUND;
230 }
231
232 /** Initialize UDP session and set maximum payload size. */
233 static int udp_init_fec(struct sender_client *sc)
234 {
235 int mps;
236
237 PARA_NOTICE_LOG("sending to udp %s\n", sc->name);
238 mps = generic_max_transport_msg_size(sc->fd) - sizeof(struct udphdr);
239 PARA_INFO_LOG("current MPS = %d bytes\n", mps);
240 return mps;
241 }
242
243 /** Check and clear socket error if any. */
244 static int udp_check_socket_state(struct sender_client *sc)
245 {
246 struct udp_target *ut = sc->private_data;
247 int ret;
248 socklen_t errlen = sizeof(ret);
249
250 if (getsockopt(sc->fd, SOL_SOCKET, SO_ERROR, &ret, &errlen) < 0) {
251 PARA_ERROR_LOG("SO_ERROR failed: %s\n", strerror(ret));
252 return 0;
253 } else if (ret == 0) {
254 return 0;
255 } else if (ret == ECONNREFUSED) {
256 time_t dist = now->tv_sec - ut->last_unreachable;
257
258 if (dist <= UDP_MAX_UNREACHABLE_TIME) {
259 return 0;
260 } else if (dist > 2 * UDP_MAX_UNREACHABLE_TIME) {
261 ut->last_unreachable = now->tv_sec;
262 return 0;
263 } else {
264 /*
265 * unreachable_time < dist <= 2 * unreachable_time
266 * No errors are allowed during this time window.
267 */
268 PARA_NOTICE_LOG("Evicting %s after %d seconds "
269 "of connection errors.\n",
270 sc->name, (int)dist);
271 }
272 }
273 return -ERRNO_TO_PARA_ERROR(ret);
274 }
275
276 static void udp_send_fec(struct sender_client *sc, char *buf, size_t len)
277 {
278 int ret;
279
280 if (sender_status == SENDER_OFF)
281 return;
282 if (len == 0)
283 return;
284 ret = udp_check_socket_state(sc);
285 if (ret < 0)
286 goto fail;
287 ret = xwrite(sc->fd, buf, len);
288 if (ret == -ERRNO_TO_PARA_ERROR(ECONNREFUSED)) {
289 /*
290 * Happens if meanwhile an ICMP Destination / Port Unreachable
291 * has arrived. Ignore, persistent errors will be caught above.
292 */
293 ret = 0;
294 }
295 if (ret < 0)
296 goto fail;
297 return;
298 fail:
299 udp_delete_target(sc, para_strerror(-ret));
300 }
301
302 static int udp_com_add(struct sender_command_data *scd)
303 {
304 int ret;
305 struct udp_target *ut;
306 struct sender_client *sc = udp_lookup_target(scd);
307
308 if (sc) {
309 PARA_NOTICE_LOG("target %s already exists - not adding it\n",
310 sc->name);
311 return -E_TARGET_EXISTS;
312 }
313 ut = para_calloc(sizeof(*ut));
314 sc = para_calloc(sizeof(*sc));
315 ut->fcp.slices_per_group = scd->slices_per_group;
316 ut->fcp.data_slices_per_group = scd->data_slices_per_group;
317 ut->fcp.init_fec = udp_init_fec;
318 ut->fcp.send_fec = udp_send_fec;
319 ut->fcp.need_periodic_header = true;
320
321 sc->private_data = ut;
322 sc->fd = -1;
323 ret = para_connect_simple(IPPROTO_UDP, scd->host, scd->port);
324 if (ret < 0)
325 goto err;
326 sc->fd = ret;
327
328 ret = mcast_sender_setup(sc);
329 if (ret < 0)
330 goto err;
331 ret = mark_fd_nonblocking(sc->fd);
332 if (ret < 0)
333 goto err;
334 sc->name = para_strdup(remote_name(sc->fd));
335 PARA_INFO_LOG("adding to target list (%s)\n", sc->name);
336 ut->fc = vss_add_fec_client(sc, &ut->fcp);
337 para_list_add(&sc->node, &targets);
338 add_close_on_fork_list(sc->fd);
339 return 1;
340 err:
341 if (sc->fd >= 0)
342 close(sc->fd);
343 PARA_NOTICE_LOG("failed to set up %s:%d (%s)- not adding it\n",
344 scd->host, scd->port, para_strerror(-ret));
345 free(sc);
346 free(ut);
347 return ret;
348 }
349
350 static char *udp_status(void)
351 {
352 struct sender_client *sc;
353 char *ret, *tgts = NULL;
354
355 list_for_each_entry(sc, &targets, node) {
356 struct udp_target *ut = sc->private_data;
357 char *tmp = make_message("%s%s/%u:%u ",
358 tgts ? : "", sc->name,
359 ut->fcp.data_slices_per_group,
360 ut->fcp.slices_per_group
361 );
362 free(tgts);
363 tgts = tmp;
364 }
365 ret = make_message(
366 "status: %s\n"
367 "port: %s\n"
368 "targets: %s\n",
369 (sender_status == SENDER_ON)? "on" : "off",
370 stringify_port(conf.udp_default_port_arg, "udp"),
371 tgts? tgts : "(none)"
372 );
373 free(tgts);
374 return ret;
375 }
376
377 static void udp_init_target_list(void)
378 {
379 struct sender_command_data scd;
380 int i;
381
382 INIT_LIST_HEAD(&targets);
383 for (i = 0; i < conf.udp_target_given; i++) {
384 if (udp_resolve_target(conf.udp_target_arg[i], &scd) < 0)
385 PARA_CRIT_LOG("not adding requested target '%s'\n",
386 conf.udp_target_arg[i]);
387 else
388 udp_com_add(&scd);
389 }
390 }
391
392 static char *udp_help(void)
393 {
394 return make_message(
395 "usage: {on|off}\n"
396 "usage: {add|delete} ip_address[:port][/[packet_size:]k:n]\n"
397 " - k is the number of data slices per FEC group\n"
398 " - n is the total number of slices in a FEC group\n"
399 " - packet_size reduces the slice size below path MTU\n\n"
400 "examples: add 224.0.1.38:1500 (IPv4 multicast)\n"
401 " add 224.0.1.38:8080/14:16 (explicit FEC)\n"
402 " add 10.10.1.42 (using default port)\n"
403 " add [FF05::42]:1500 (IPv6 multicast)\n"
404 " add [::1] (IPv6 localhost/default port)\n"
405 " delete myhost.net (host with port wildcard)\n"
406 " delete 10.1.2.3:456 (IPv4 with explicit port)\n"
407 " delete [badc0de::1] (IPv6 with port wildcard)\n"
408 );
409 }
410
411 /**
412 * The init function of para_server's udp sender.
413 *
414 * \param s Pointer to the udp sender struct.
415 *
416 * It initializes all function pointers of \a s and the list of udp targets.
417 */
418 void udp_send_init(struct sender *s)
419 {
420 INIT_LIST_HEAD(&targets);
421 s->status = udp_status;
422 s->help = udp_help;
423 s->send = NULL;
424 s->pre_select = NULL;
425 s->post_select = NULL;
426 s->shutdown_clients = udp_shutdown_targets;
427 s->resolve_target = udp_resolve_target;
428 s->client_cmds[SENDER_ON] = udp_com_on;
429 s->client_cmds[SENDER_OFF] = udp_com_off;
430 s->client_cmds[SENDER_DENY] = NULL;
431 s->client_cmds[SENDER_ALLOW] = NULL;
432 s->client_cmds[SENDER_ADD] = udp_com_add;
433 s->client_cmds[SENDER_DELETE] = udp_com_delete;
434 sender_status = SENDER_OFF;
435 udp_init_target_list();
436 if (!conf.udp_no_autostart_given)
437 sender_status = SENDER_ON;
438 PARA_DEBUG_LOG("udp sender init complete\n");
439 }