2 * Copyright (C) 2005-2010 Andre Noll <maan@systemlinux.org>
4 * Licensed under the GPL v2. For licencing details see COPYING.
7 /** \file udp_send.c Para_server's udp sender. */
13 #include <sys/socket.h>
14 #include <netinet/udp.h>
19 #include "server.cmdline.h"
29 #include "portable_io.h"
33 #include "close_on_fork.h"
34 #include "chunk_queue.h"
37 * Time window during which ICMP Destination/Port Unreachable messages are
38 * ignored, covering transient receiver problems such as restarting the
39 * client, rebooting, reconfiguration, or handover.
41 #define UDP_MAX_UNREACHABLE_TIME 30
43 /** Describes one entry in the list of targets for the udp sender. */
45 /** Track time (seconds) of last ICMP Port Unreachable error */
46 time_t last_unreachable;
47 /** Common sender client data */
48 struct sender_client *sc;
49 /** The opaque structure returned by vss_add_fec_client(). */
50 struct fec_client *fc;
51 /** The FEC parameters for this target. */
52 struct fec_client_parms fcp;
55 static struct list_head targets;
56 static int sender_status;
58 static void udp_close_target(struct sender_client *sc)
61 del_close_on_fork_list(sc->fd);
67 static void udp_delete_target(struct sender_client *sc, const char *msg)
69 struct udp_target *ut = sc->private_data;
71 PARA_NOTICE_LOG("deleting %s (%s) from list\n", sc->name, msg);
73 vss_del_fec_client(ut->fc);
81 * Perform AF-independent multicast sender setup.
83 * \param sc The connected sender client.
85 * \return Zero if okay, negative on error.
87 static int mcast_sender_setup(struct sender_client *sc)
89 struct sockaddr_storage ss;
90 socklen_t sslen = sizeof(ss);
91 int ttl = conf.udp_ttl_arg, id = 0;
94 if (conf.udp_mcast_iface_given) {
95 char *iface = conf.udp_mcast_iface_arg;
97 id = if_nametoindex(iface);
99 PARA_WARNING_LOG("could not resolve interface '%s', "
100 "using default", iface);
103 if (getpeername(sc->fd, (struct sockaddr *)&ss, &sslen) < 0)
105 assert(ss.ss_family == AF_INET || ss.ss_family == AF_INET6);
107 /* RFC 3493, 5.2: -1 means 'use kernel default' */
108 if (ttl < 0 || ttl > 255)
111 switch (ss.ss_family) {
113 if (!IN_MULTICAST(htonl(((struct sockaddr_in *)&ss)->sin_addr.s_addr)))
119 memset(&mn, 0, sizeof(mn));
121 if (setsockopt(sc->fd, IPPROTO_IP, IP_MULTICAST_IF, &mn, sizeof(mn)) < 0)
124 PARA_ERROR_LOG("No support for setting outgoing IPv4 mcast interface.");
128 * Enable receiving multicast messages generated on the local host
129 * At least on Linux, this is enabled by default.
131 if (setsockopt(sc->fd, IPPROTO_IP, IP_MULTICAST_LOOP, &on, sizeof(on)) < 0)
134 /* Default: use local subnet (do not flood out into the WAN) */
137 if (setsockopt(sc->fd, IPPROTO_IP, IP_MULTICAST_TTL, &ttl, sizeof(ttl)) < 0)
141 if (!IN6_IS_ADDR_MULTICAST(&((struct sockaddr_in6 *)&ss)->sin6_addr))
144 setsockopt(sc->fd, IPPROTO_IPV6, IPV6_MULTICAST_IF, &id, sizeof(id)) < 0)
146 if (setsockopt(sc->fd, IPPROTO_IPV6, IPV6_MULTICAST_LOOP, &on, sizeof(on)) < 0)
148 if (setsockopt(sc->fd, IPPROTO_IPV6, IPV6_MULTICAST_HOPS, &ttl, sizeof(ttl)) < 0)
153 return -ERRNO_TO_PARA_ERROR(errno);
156 /** The maximal size of the per-target chunk queue. */
157 #define UDP_CQ_BYTES 40000
159 static void udp_init_session(struct sender_client *sc)
161 if (sc->cq == NULL) {
162 sc->cq = cq_new(UDP_CQ_BYTES);
163 add_close_on_fork_list(sc->fd);
164 PARA_NOTICE_LOG("sending to udp %s\n", sc->name);
168 static void udp_shutdown_targets(void)
170 struct sender_client *sc, *tmp;
172 size_t len = vss_get_fec_eof_packet(&buf);
174 list_for_each_entry_safe(sc, tmp, &targets, node)
175 if (sc->cq != NULL) {
176 /* ignore return value, closing the target anyway. */
177 (void)write(sc->fd, buf, len);
178 udp_close_target(sc);
182 static int udp_resolve_target(const char *url, struct sender_command_data *scd)
187 ret = parse_fec_url(url, scd);
190 port = scd->port > 0 ? scd->port : conf.udp_default_port_arg;
192 ret = para_connect_simple(IPPROTO_UDP, scd->host, port);
196 result = remote_name(ret);
199 if (!parse_url(result, scd->host, sizeof(scd->host), &scd->port))
200 return -E_ADDRESS_LOOKUP;
204 static int udp_com_on(__a_unused struct sender_command_data *scd)
206 sender_status = SENDER_ON;
210 static int udp_com_off(__a_unused struct sender_command_data *scd)
212 udp_shutdown_targets();
213 sender_status = SENDER_OFF;
217 static struct sender_client *udp_lookup_target(struct sender_command_data *scd)
219 struct sender_client *sc, *tmp;
220 char host[MAX_HOSTLEN];
223 list_for_each_entry_safe(sc, tmp, &targets, node) {
224 parse_url(sc->name, host, sizeof(host), &port);
226 /* Unspecified port means wildcard port match */
227 if (scd->port > 0 && scd->port != port)
229 if (strcmp(host, scd->host))
236 static int udp_com_delete(struct sender_command_data *scd)
238 struct sender_client *sc = udp_lookup_target(scd);
241 udp_delete_target(sc, "com_delete");
244 PARA_NOTICE_LOG("not deleting non-existing target '%s'\n", scd->host);
245 return -E_TARGET_NOT_FOUND;
248 /** Initialize UDP session and set maximum payload size. */
249 static int udp_init_fec(struct sender_client *sc)
253 udp_init_session(sc);
254 mps = generic_max_transport_msg_size(sc->fd) - sizeof(struct udphdr);
255 PARA_INFO_LOG("current MPS = %d bytes\n", mps);
259 /** Check and clear socket error if any. */
260 static int udp_check_socket_state(struct sender_client *sc)
262 struct udp_target *ut = sc->private_data;
264 socklen_t errlen = sizeof(ret);
266 if (getsockopt(sc->fd, SOL_SOCKET, SO_ERROR, &ret, &errlen) < 0) {
267 PARA_ERROR_LOG("SO_ERROR failed: %s\n", strerror(ret));
269 } else if (ret == 0) {
271 } else if (ret == ECONNREFUSED) {
272 time_t dist = now->tv_sec - ut->last_unreachable;
274 if (dist <= UDP_MAX_UNREACHABLE_TIME) {
276 } else if (dist > 2 * UDP_MAX_UNREACHABLE_TIME) {
277 ut->last_unreachable = now->tv_sec;
281 * unreachable_time < dist <= 2 * unreachable_time
282 * No errors are allowed during this time window.
284 PARA_NOTICE_LOG("Evicting %s after %d seconds "
285 "of connection errors.\n",
286 sc->name, (int)dist);
289 return -ERRNO_TO_PARA_ERROR(ret);
292 static int udp_send_fec(struct sender_client *sc, char *buf, size_t len)
296 if (sender_status == SENDER_OFF)
298 if (len == 0 && !cq_peek(sc->cq))
300 ret = udp_check_socket_state(sc);
303 ret = send_queued_chunks(sc->fd, sc->cq);
306 if (!ret) { /* still data left in the queue */
307 ret = cq_force_enqueue(sc->cq, buf, len);
311 ret = write_nonblock(sc->fd, buf, len);
312 if (ret == -ERRNO_TO_PARA_ERROR(ECONNREFUSED)) {
314 * Happens if meanwhile an ICMP Destination / Port Unreachable
315 * has arrived. Ignore, persistent errors will be caught above.
322 ret = cq_force_enqueue(sc->cq, buf + ret, len - ret);
327 udp_delete_target(sc, para_strerror(-ret));
331 static int udp_com_add(struct sender_command_data *scd)
334 struct udp_target *ut;
335 struct sender_client *sc = udp_lookup_target(scd);
338 PARA_NOTICE_LOG("target %s already exists - not adding it\n",
340 return -E_TARGET_EXISTS;
342 ut = para_calloc(sizeof(*ut));
343 sc = ut->sc = para_calloc(sizeof(*sc));
344 ut->fcp.slices_per_group = scd->slices_per_group;
345 ut->fcp.data_slices_per_group = scd->data_slices_per_group;
346 ut->fcp.init_fec = udp_init_fec;
347 ut->fcp.send_fec = udp_send_fec;
348 ut->fcp.need_periodic_header = true;
350 sc->private_data = ut;
352 ret = para_connect_simple(IPPROTO_UDP, scd->host, scd->port);
357 ret = mcast_sender_setup(sc);
360 ret = mark_fd_nonblocking(sc->fd);
363 sc->name = para_strdup(remote_name(sc->fd));
364 PARA_INFO_LOG("adding to target list (%s)\n", sc->name);
365 ut->fc = vss_add_fec_client(sc, &ut->fcp);
366 para_list_add(&sc->node, &targets);
371 PARA_NOTICE_LOG("failed to set up %s:%d (%s)- not adding it\n",
372 scd->host, scd->port, para_strerror(-ret));
378 static char *udp_info(void)
380 struct sender_client *sc;
381 char *ret, *tgts = NULL;
383 list_for_each_entry(sc, &targets, node) {
384 struct udp_target *ut = sc->private_data;
385 char *tmp = make_message("%s%s/%u:%u ",
386 tgts ? : "", sc->name,
387 ut->fcp.data_slices_per_group,
388 ut->fcp.slices_per_group
398 (sender_status == SENDER_ON)? "on" : "off",
399 stringify_port(conf.udp_default_port_arg, "udp"),
400 tgts? tgts : "(none)"
406 static void udp_init_target_list(void)
408 struct sender_command_data scd;
411 INIT_LIST_HEAD(&targets);
412 for (i = 0; i < conf.udp_target_given; i++) {
413 if (udp_resolve_target(conf.udp_target_arg[i], &scd) < 0)
414 PARA_CRIT_LOG("not adding requested target '%s'\n",
415 conf.udp_target_arg[i]);
421 static char *udp_help(void)
425 "usage: {add|delete} ip_address[:port][/[packet_size:]k:n]\n"
426 " - k is the number of data slices per FEC group\n"
427 " - n is the total number of slices in a FEC group\n"
428 " - packet_size reduces the slice size below path MTU\n\n"
429 "examples: add 224.0.1.38:1500 (IPv4 multicast)\n"
430 " add 224.0.1.38:8080/14:16 (explicit FEC)\n"
431 " add 10.10.1.42 (using default port)\n"
432 " add [FF05::42]:1500 (IPv6 multicast)\n"
433 " add [::1] (IPv6 localhost/default port)\n"
434 " delete myhost.net (host with port wildcard)\n"
435 " delete 10.1.2.3:456 (IPv4 with explicit port)\n"
436 " delete [badc0de::1] (IPv6 with port wildcard)\n"
441 * The init function of para_server's udp sender.
443 * \param s Pointer to the udp sender struct.
445 * It initializes all function pointers of \a s and the list of udp targets.
447 void udp_send_init(struct sender *s)
449 INIT_LIST_HEAD(&targets);
453 s->pre_select = NULL;
454 s->post_select = NULL;
455 s->shutdown_clients = udp_shutdown_targets;
456 s->resolve_target = udp_resolve_target;
457 s->client_cmds[SENDER_ON] = udp_com_on;
458 s->client_cmds[SENDER_OFF] = udp_com_off;
459 s->client_cmds[SENDER_DENY] = NULL;
460 s->client_cmds[SENDER_ALLOW] = NULL;
461 s->client_cmds[SENDER_ADD] = udp_com_add;
462 s->client_cmds[SENDER_DELETE] = udp_com_delete;
463 sender_status = SENDER_OFF;
464 udp_init_target_list();
465 if (!conf.udp_no_autostart_given)
466 sender_status = SENDER_ON;
467 PARA_DEBUG_LOG("udp sender init complete\n");