1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
4 This file is part of systemd.
6 Copyright 2010 Lennart Poettering
8 systemd is free software; you can redistribute it and/or modify it
9 under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2 of the License, or
11 (at your option) any later version.
13 systemd is distributed in the hope that it will be useful, but
14 WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with systemd; If not, see <http://www.gnu.org/licenses/>.
22 #include <sys/types.h>
27 #include <sys/epoll.h>
29 #include <arpa/inet.h>
33 #include "netinet/tcp.h"
35 #include "load-dropin.h"
36 #include "load-fragment.h"
38 #include "unit-name.h"
39 #include "dbus-socket.h"
42 #include "bus-errors.h"
44 #include "exit-status.h"
47 static const UnitActiveState state_translation_table[_SOCKET_STATE_MAX] = {
48 [SOCKET_DEAD] = UNIT_INACTIVE,
49 [SOCKET_START_PRE] = UNIT_ACTIVATING,
50 [SOCKET_START_POST] = UNIT_ACTIVATING,
51 [SOCKET_LISTENING] = UNIT_ACTIVE,
52 [SOCKET_RUNNING] = UNIT_ACTIVE,
53 [SOCKET_STOP_PRE] = UNIT_DEACTIVATING,
54 [SOCKET_STOP_PRE_SIGTERM] = UNIT_DEACTIVATING,
55 [SOCKET_STOP_PRE_SIGKILL] = UNIT_DEACTIVATING,
56 [SOCKET_STOP_POST] = UNIT_DEACTIVATING,
57 [SOCKET_FINAL_SIGTERM] = UNIT_DEACTIVATING,
58 [SOCKET_FINAL_SIGKILL] = UNIT_DEACTIVATING,
59 [SOCKET_FAILED] = UNIT_FAILED
62 static void socket_init(Unit *u) {
63 Socket *s = SOCKET(u);
66 assert(u->meta.load_state == UNIT_STUB);
68 s->backlog = SOMAXCONN;
69 s->timeout_usec = DEFAULT_TIMEOUT_USEC;
70 s->directory_mode = 0755;
71 s->socket_mode = 0777;
73 s->max_connections = 64;
80 exec_context_init(&s->exec_context);
81 s->exec_context.std_output = u->meta.manager->default_std_output;
82 s->exec_context.std_error = u->meta.manager->default_std_error;
84 s->control_command_id = _SOCKET_EXEC_COMMAND_INVALID;
87 static void socket_unwatch_control_pid(Socket *s) {
90 if (s->control_pid <= 0)
93 unit_unwatch_pid(UNIT(s), s->control_pid);
97 static void socket_done(Unit *u) {
98 Socket *s = SOCKET(u);
104 while ((p = s->ports)) {
105 LIST_REMOVE(SocketPort, port, s->ports, p);
108 unit_unwatch_fd(UNIT(s), &p->fd_watch);
109 close_nointr_nofail(p->fd);
116 exec_context_done(&s->exec_context);
117 exec_command_free_array(s->exec_command, _SOCKET_EXEC_COMMAND_MAX);
118 s->control_command = NULL;
120 socket_unwatch_control_pid(s);
124 free(s->tcp_congestion);
125 s->tcp_congestion = NULL;
127 free(s->bind_to_device);
128 s->bind_to_device = NULL;
130 unit_unwatch_timer(u, &s->timer_watch);
132 /* Make sure no service instance refers to us anymore. */
133 LIST_FOREACH(units_per_type, i, u->meta.manager->units_per_type[UNIT_SERVICE]) {
134 Service *service = (Service *) i;
136 if (service->accept_socket == s)
137 service->accept_socket = NULL;
139 set_remove(service->configured_sockets, s);
143 static int socket_instantiate_service(Socket *s) {
150 /* This fills in s->service if it isn't filled in yet. For
151 * Accept=yes sockets we create the next connection service
152 * here. For Accept=no this is mostly a NOP since the service
153 * is figured out at load time anyway. */
160 if (!(prefix = unit_name_to_prefix(s->meta.id)))
163 r = asprintf(&name, "%s@%u.service", prefix, s->n_accepted);
169 r = manager_load_unit(s->meta.manager, name, NULL, NULL, &u);
175 #ifdef HAVE_SYSV_COMPAT
176 if (SERVICE(u)->sysv_path) {
177 log_error("Using SysV services for socket activation is not supported. Refusing.");
182 u->meta.no_gc = true;
183 s->service = SERVICE(u);
187 static bool have_non_accept_socket(Socket *s) {
195 LIST_FOREACH(port, p, s->ports) {
197 if (p->type != SOCKET_SOCKET)
200 if (!socket_address_can_accept(&p->address))
207 static int socket_verify(Socket *s) {
210 if (s->meta.load_state != UNIT_LOADED)
214 log_error("%s lacks Listen setting. Refusing.", s->meta.id);
218 if (s->accept && have_non_accept_socket(s)) {
219 log_error("%s configured for accepting sockets, but sockets are non-accepting. Refusing.", s->meta.id);
223 if (s->accept && s->max_connections <= 0) {
224 log_error("%s's MaxConnection setting too small. Refusing.", s->meta.id);
228 if (s->accept && s->service) {
229 log_error("Explicit service configuration for accepting sockets not supported on %s. Refusing.", s->meta.id);
233 if (s->exec_context.pam_name && s->exec_context.kill_mode != KILL_CONTROL_GROUP) {
234 log_error("%s has PAM enabled. Kill mode must be set to 'control-group'. Refusing.", s->meta.id);
241 static bool socket_needs_mount(Socket *s, const char *prefix) {
246 LIST_FOREACH(port, p, s->ports) {
248 if (p->type == SOCKET_SOCKET) {
249 if (socket_address_needs_mount(&p->address, prefix))
252 assert(p->type == SOCKET_FIFO || p->type == SOCKET_SPECIAL);
253 if (path_startswith(p->path, prefix))
261 int socket_add_one_mount_link(Socket *s, Mount *m) {
267 if (s->meta.load_state != UNIT_LOADED ||
268 m->meta.load_state != UNIT_LOADED)
271 if (!socket_needs_mount(s, m->where))
274 if ((r = unit_add_two_dependencies(UNIT(s), UNIT_AFTER, UNIT_REQUIRES, UNIT(m), true)) < 0)
280 static int socket_add_mount_links(Socket *s) {
286 LIST_FOREACH(units_per_type, other, s->meta.manager->units_per_type[UNIT_MOUNT])
287 if ((r = socket_add_one_mount_link(s, (Mount*) other)) < 0)
293 static int socket_add_device_link(Socket *s) {
299 if (!s->bind_to_device)
302 if (asprintf(&t, "/sys/subsystem/net/devices/%s", s->bind_to_device) < 0)
305 r = unit_add_node_link(UNIT(s), t, false);
311 static int socket_add_default_dependencies(Socket *s) {
315 if (s->meta.manager->running_as == MANAGER_SYSTEM) {
316 if ((r = unit_add_dependency_by_name(UNIT(s), UNIT_BEFORE, SPECIAL_SOCKETS_TARGET, NULL, true)) < 0)
319 if ((r = unit_add_two_dependencies_by_name(UNIT(s), UNIT_AFTER, UNIT_REQUIRES, SPECIAL_SYSINIT_TARGET, NULL, true)) < 0)
323 return unit_add_two_dependencies_by_name(UNIT(s), UNIT_BEFORE, UNIT_CONFLICTS, SPECIAL_SHUTDOWN_TARGET, NULL, true);
326 static int socket_load(Unit *u) {
327 Socket *s = SOCKET(u);
331 assert(u->meta.load_state == UNIT_STUB);
333 if ((r = unit_load_fragment_and_dropin(u)) < 0)
336 /* This is a new unit? Then let's add in some extras */
337 if (u->meta.load_state == UNIT_LOADED) {
339 if (have_non_accept_socket(s)) {
342 if ((r = unit_load_related_unit(u, ".service", (Unit**) &s->service)) < 0)
345 if ((r = unit_add_dependency(u, UNIT_BEFORE, UNIT(s->service), true)) < 0)
349 if ((r = socket_add_mount_links(s)) < 0)
352 if ((r = socket_add_device_link(s)) < 0)
355 if ((r = unit_add_exec_dependencies(u, &s->exec_context)) < 0)
358 if ((r = unit_add_default_cgroups(u)) < 0)
361 if (s->meta.default_dependencies)
362 if ((r = socket_add_default_dependencies(s)) < 0)
366 return socket_verify(s);
369 static const char* listen_lookup(int family, int type) {
371 if (family == AF_NETLINK)
372 return "ListenNetlink";
374 if (type == SOCK_STREAM)
375 return "ListenStream";
376 else if (type == SOCK_DGRAM)
377 return "ListenDatagram";
378 else if (type == SOCK_SEQPACKET)
379 return "ListenSequentialPacket";
381 assert_not_reached("Unknown socket type");
385 static void socket_dump(Unit *u, FILE *f, const char *prefix) {
388 Socket *s = SOCKET(u);
396 p2 = strappend(prefix, "\t");
397 prefix2 = p2 ? p2 : prefix;
400 "%sSocket State: %s\n"
401 "%sBindIPv6Only: %s\n"
403 "%sSocketMode: %04o\n"
404 "%sDirectoryMode: %04o\n"
407 "%sTCPCongestion: %s\n",
408 prefix, socket_state_to_string(s->state),
409 prefix, socket_address_bind_ipv6_only_to_string(s->bind_ipv6_only),
411 prefix, s->socket_mode,
412 prefix, s->directory_mode,
413 prefix, yes_no(s->keep_alive),
414 prefix, yes_no(s->free_bind),
415 prefix, strna(s->tcp_congestion));
417 if (s->control_pid > 0)
419 "%sControl PID: %lu\n",
420 prefix, (unsigned long) s->control_pid);
422 if (s->bind_to_device)
424 "%sBindToDevice: %s\n",
425 prefix, s->bind_to_device);
430 "%sNConnections: %u\n"
431 "%sMaxConnections: %u\n",
432 prefix, s->n_accepted,
433 prefix, s->n_connections,
434 prefix, s->max_connections);
436 if (s->priority >= 0)
439 prefix, s->priority);
441 if (s->receive_buffer > 0)
443 "%sReceiveBuffer: %zu\n",
444 prefix, s->receive_buffer);
446 if (s->send_buffer > 0)
448 "%sSendBuffer: %zu\n",
449 prefix, s->send_buffer);
461 if (s->pipe_size > 0)
464 prefix, s->pipe_size);
471 LIST_FOREACH(port, p, s->ports) {
473 if (p->type == SOCKET_SOCKET) {
478 if ((r = socket_address_print(&p->address, &k)) < 0)
483 fprintf(f, "%s%s: %s\n", prefix, listen_lookup(socket_address_family(&p->address), p->address.type), t);
485 } else if (p->type == SOCKET_SPECIAL)
486 fprintf(f, "%sListenSpecial: %s\n", prefix, p->path);
488 fprintf(f, "%sListenFIFO: %s\n", prefix, p->path);
491 exec_context_dump(&s->exec_context, f, prefix);
493 for (c = 0; c < _SOCKET_EXEC_COMMAND_MAX; c++) {
494 if (!s->exec_command[c])
497 fprintf(f, "%s-> %s:\n",
498 prefix, socket_exec_command_to_string(c));
500 exec_command_dump_list(s->exec_command[c], f, prefix2);
506 static int instance_from_socket(int fd, unsigned nr, char **instance) {
511 struct sockaddr_un un;
512 struct sockaddr_in in;
513 struct sockaddr_in6 in6;
514 struct sockaddr_storage storage;
521 if (getsockname(fd, &local.sa, &l) < 0)
525 if (getpeername(fd, &remote.sa, &l) < 0)
528 switch (local.sa.sa_family) {
532 a = ntohl(local.in.sin_addr.s_addr),
533 b = ntohl(remote.in.sin_addr.s_addr);
536 "%u.%u.%u.%u:%u-%u.%u.%u.%u:%u",
537 a >> 24, (a >> 16) & 0xFF, (a >> 8) & 0xFF, a & 0xFF,
538 ntohs(local.in.sin_port),
539 b >> 24, (b >> 16) & 0xFF, (b >> 8) & 0xFF, b & 0xFF,
540 ntohs(remote.in.sin_port)) < 0)
547 static const char ipv4_prefix[] = {
548 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0xFF, 0xFF
551 if (memcmp(&local.in6.sin6_addr, ipv4_prefix, sizeof(ipv4_prefix)) == 0 &&
552 memcmp(&remote.in6.sin6_addr, ipv4_prefix, sizeof(ipv4_prefix)) == 0) {
554 *a = local.in6.sin6_addr.s6_addr+12,
555 *b = remote.in6.sin6_addr.s6_addr+12;
558 "%u.%u.%u.%u:%u-%u.%u.%u.%u:%u",
559 a[0], a[1], a[2], a[3],
560 ntohs(local.in6.sin6_port),
561 b[0], b[1], b[2], b[3],
562 ntohs(remote.in6.sin6_port)) < 0)
565 char a[INET6_ADDRSTRLEN], b[INET6_ADDRSTRLEN];
569 inet_ntop(AF_INET6, &local.in6.sin6_addr, a, sizeof(a)),
570 ntohs(local.in6.sin6_port),
571 inet_ntop(AF_INET6, &remote.in6.sin6_addr, b, sizeof(b)),
572 ntohs(remote.in6.sin6_port)) < 0)
583 if (getsockopt(fd, SOL_SOCKET, SO_PEERCRED, &ucred, &l) < 0)
589 (unsigned long) ucred.pid,
590 (unsigned long) ucred.uid) < 0)
597 assert_not_reached("Unhandled socket type.");
604 static void socket_close_fds(Socket *s) {
609 LIST_FOREACH(port, p, s->ports) {
613 unit_unwatch_fd(UNIT(s), &p->fd_watch);
614 close_nointr_nofail(p->fd);
616 /* One little note: we should never delete any sockets
617 * in the file system here! After all some other
618 * process we spawned might still have a reference of
619 * this fd and wants to continue to use it. Therefore
620 * we delete sockets in the file system before we
621 * create a new one, not after we stopped using
628 static void socket_apply_socket_options(Socket *s, int fd) {
633 int b = s->keep_alive;
634 if (setsockopt(fd, SOL_SOCKET, SO_KEEPALIVE, &b, sizeof(b)) < 0)
635 log_warning("SO_KEEPALIVE failed: %m");
638 if (s->priority >= 0)
639 if (setsockopt(fd, SOL_SOCKET, SO_PRIORITY, &s->priority, sizeof(s->priority)) < 0)
640 log_warning("SO_PRIORITY failed: %m");
642 if (s->receive_buffer > 0) {
643 int value = (int) s->receive_buffer;
644 if (setsockopt(fd, SOL_SOCKET, SO_RCVBUF, &value, sizeof(value)) < 0)
645 log_warning("SO_RCVBUF failed: %m");
648 if (s->send_buffer > 0) {
649 int value = (int) s->send_buffer;
650 if (setsockopt(fd, SOL_SOCKET, SO_SNDBUF, &value, sizeof(value)) < 0)
651 log_warning("SO_SNDBUF failed: %m");
655 if (setsockopt(fd, SOL_SOCKET, SO_MARK, &s->mark, sizeof(s->mark)) < 0)
656 log_warning("SO_MARK failed: %m");
659 if (setsockopt(fd, IPPROTO_IP, IP_TOS, &s->ip_tos, sizeof(s->ip_tos)) < 0)
660 log_warning("IP_TOS failed: %m");
662 if (s->ip_ttl >= 0) {
665 r = setsockopt(fd, IPPROTO_IP, IP_TTL, &s->ip_ttl, sizeof(s->ip_ttl));
667 if (socket_ipv6_is_supported())
668 x = setsockopt(fd, IPPROTO_IPV6, IPV6_UNICAST_HOPS, &s->ip_ttl, sizeof(s->ip_ttl));
671 errno = EAFNOSUPPORT;
675 log_warning("IP_TTL/IPV6_UNICAST_HOPS failed: %m");
678 if (s->tcp_congestion)
679 if (setsockopt(fd, SOL_TCP, TCP_CONGESTION, s->tcp_congestion, strlen(s->tcp_congestion)+1) < 0)
680 log_warning("TCP_CONGESTION failed: %m");
683 static void socket_apply_fifo_options(Socket *s, int fd) {
687 if (s->pipe_size > 0)
688 if (fcntl(fd, F_SETPIPE_SZ, s->pipe_size) < 0)
689 log_warning("F_SETPIPE_SZ: %m");
692 static int fifo_address_create(
694 mode_t directory_mode,
705 mkdir_parents(path, directory_mode);
707 if ((r = label_fifofile_set(path)) < 0)
710 /* Enforce the right access mode for the fifo */
711 old_mask = umask(~ socket_mode);
713 /* Include the original umask in our mask */
714 umask(~socket_mode | old_mask);
716 r = mkfifo(path, socket_mode);
719 if (r < 0 && errno != EEXIST) {
724 if ((fd = open(path, O_RDWR|O_CLOEXEC|O_NOCTTY|O_NONBLOCK|O_NOFOLLOW)) < 0) {
731 if (fstat(fd, &st) < 0) {
736 if (!S_ISFIFO(st.st_mode) ||
737 (st.st_mode & 0777) != (socket_mode & ~old_mask) ||
738 st.st_uid != getuid() ||
739 st.st_gid != getgid()) {
752 close_nointr_nofail(fd);
757 static int special_address_create(
767 if ((fd = open(path, O_RDONLY|O_CLOEXEC|O_NOCTTY|O_NONBLOCK|O_NOFOLLOW)) < 0) {
772 if (fstat(fd, &st) < 0) {
777 /* Check whether this is a /proc, /sys or /dev file or char device */
778 if (!S_ISREG(st.st_mode) && !S_ISCHR(st.st_mode)) {
788 close_nointr_nofail(fd);
793 static int socket_open_fds(Socket *s) {
797 bool know_label = false;
801 LIST_FOREACH(port, p, s->ports) {
806 if (p->type == SOCKET_SOCKET) {
810 if ((r = socket_instantiate_service(s)) < 0)
813 if (s->service && s->service->exec_command[SERVICE_EXEC_START])
814 if ((r = label_get_socket_label_from_exe(s->service->exec_command[SERVICE_EXEC_START]->path, &label)) < 0) {
822 if ((r = socket_address_listen(
834 socket_apply_socket_options(s, p->fd);
836 } else if (p->type == SOCKET_SPECIAL) {
838 if ((r = special_address_create(
843 } else if (p->type == SOCKET_FIFO) {
845 if ((r = fifo_address_create(
852 socket_apply_fifo_options(s, p->fd);
855 assert_not_reached("Unknown port type");
867 static void socket_unwatch_fds(Socket *s) {
872 LIST_FOREACH(port, p, s->ports) {
876 unit_unwatch_fd(UNIT(s), &p->fd_watch);
880 static int socket_watch_fds(Socket *s) {
886 LIST_FOREACH(port, p, s->ports) {
890 p->fd_watch.socket_accept =
892 p->type == SOCKET_SOCKET &&
893 socket_address_can_accept(&p->address);
895 if ((r = unit_watch_fd(UNIT(s), p->fd, EPOLLIN, &p->fd_watch)) < 0)
902 socket_unwatch_fds(s);
906 static void socket_set_state(Socket *s, SocketState state) {
907 SocketState old_state;
910 old_state = s->state;
913 if (state != SOCKET_START_PRE &&
914 state != SOCKET_START_POST &&
915 state != SOCKET_STOP_PRE &&
916 state != SOCKET_STOP_PRE_SIGTERM &&
917 state != SOCKET_STOP_PRE_SIGKILL &&
918 state != SOCKET_STOP_POST &&
919 state != SOCKET_FINAL_SIGTERM &&
920 state != SOCKET_FINAL_SIGKILL) {
921 unit_unwatch_timer(UNIT(s), &s->timer_watch);
922 socket_unwatch_control_pid(s);
923 s->control_command = NULL;
924 s->control_command_id = _SOCKET_EXEC_COMMAND_INVALID;
927 if (state != SOCKET_LISTENING)
928 socket_unwatch_fds(s);
930 if (state != SOCKET_START_POST &&
931 state != SOCKET_LISTENING &&
932 state != SOCKET_RUNNING &&
933 state != SOCKET_STOP_PRE &&
934 state != SOCKET_STOP_PRE_SIGTERM &&
935 state != SOCKET_STOP_PRE_SIGKILL)
938 if (state != old_state)
939 log_debug("%s changed %s -> %s",
941 socket_state_to_string(old_state),
942 socket_state_to_string(state));
944 unit_notify(UNIT(s), state_translation_table[old_state], state_translation_table[state], true);
947 static int socket_coldplug(Unit *u) {
948 Socket *s = SOCKET(u);
952 assert(s->state == SOCKET_DEAD);
954 if (s->deserialized_state != s->state) {
956 if (s->deserialized_state == SOCKET_START_PRE ||
957 s->deserialized_state == SOCKET_START_POST ||
958 s->deserialized_state == SOCKET_STOP_PRE ||
959 s->deserialized_state == SOCKET_STOP_PRE_SIGTERM ||
960 s->deserialized_state == SOCKET_STOP_PRE_SIGKILL ||
961 s->deserialized_state == SOCKET_STOP_POST ||
962 s->deserialized_state == SOCKET_FINAL_SIGTERM ||
963 s->deserialized_state == SOCKET_FINAL_SIGKILL) {
965 if (s->control_pid <= 0)
968 if ((r = unit_watch_pid(UNIT(s), s->control_pid)) < 0)
971 if ((r = unit_watch_timer(UNIT(s), s->timeout_usec, &s->timer_watch)) < 0)
975 if (s->deserialized_state == SOCKET_START_POST ||
976 s->deserialized_state == SOCKET_LISTENING ||
977 s->deserialized_state == SOCKET_RUNNING ||
978 s->deserialized_state == SOCKET_STOP_PRE ||
979 s->deserialized_state == SOCKET_STOP_PRE_SIGTERM ||
980 s->deserialized_state == SOCKET_STOP_PRE_SIGKILL)
981 if ((r = socket_open_fds(s)) < 0)
984 if (s->deserialized_state == SOCKET_LISTENING)
985 if ((r = socket_watch_fds(s)) < 0)
988 socket_set_state(s, s->deserialized_state);
994 static int socket_spawn(Socket *s, ExecCommand *c, pid_t *_pid) {
1003 if ((r = unit_watch_timer(UNIT(s), s->timeout_usec, &s->timer_watch)) < 0)
1006 if (!(argv = unit_full_printf_strv(UNIT(s), c->argv))) {
1015 s->meta.manager->environment,
1019 s->meta.manager->confirm_spawn,
1020 s->meta.cgroup_bondings,
1027 if ((r = unit_watch_pid(UNIT(s), pid)) < 0)
1028 /* FIXME: we need to do something here */
1036 unit_unwatch_timer(UNIT(s), &s->timer_watch);
1041 static void socket_enter_dead(Socket *s, bool success) {
1047 socket_set_state(s, s->failure ? SOCKET_FAILED : SOCKET_DEAD);
1050 static void socket_enter_signal(Socket *s, SocketState state, bool success);
1052 static void socket_enter_stop_post(Socket *s, bool success) {
1059 socket_unwatch_control_pid(s);
1061 s->control_command_id = SOCKET_EXEC_STOP_POST;
1063 if ((s->control_command = s->exec_command[SOCKET_EXEC_STOP_POST])) {
1064 if ((r = socket_spawn(s, s->control_command, &s->control_pid)) < 0)
1067 socket_set_state(s, SOCKET_STOP_POST);
1069 socket_enter_signal(s, SOCKET_FINAL_SIGTERM, true);
1074 log_warning("%s failed to run 'stop-post' task: %s", s->meta.id, strerror(-r));
1075 socket_enter_signal(s, SOCKET_FINAL_SIGTERM, false);
1078 static void socket_enter_signal(Socket *s, SocketState state, bool success) {
1080 Set *pid_set = NULL;
1081 bool wait_for_exit = false;
1088 if (s->exec_context.kill_mode != KILL_NONE) {
1089 int sig = (state == SOCKET_STOP_PRE_SIGTERM || state == SOCKET_FINAL_SIGTERM) ? s->exec_context.kill_signal : SIGKILL;
1091 if (s->control_pid > 0) {
1092 if (kill_and_sigcont(s->control_pid, sig) < 0 && errno != ESRCH)
1094 log_warning("Failed to kill control process %li: %m", (long) s->control_pid);
1096 wait_for_exit = true;
1099 if (s->exec_context.kill_mode == KILL_CONTROL_GROUP) {
1101 if (!(pid_set = set_new(trivial_hash_func, trivial_compare_func))) {
1106 /* Exclude the control pid from being killed via the cgroup */
1107 if (s->control_pid > 0)
1108 if ((r = set_put(pid_set, LONG_TO_PTR(s->control_pid))) < 0)
1111 if ((r = cgroup_bonding_kill_list(s->meta.cgroup_bondings, sig, true, pid_set)) < 0) {
1112 if (r != -EAGAIN && r != -ESRCH && r != -ENOENT)
1113 log_warning("Failed to kill control group: %s", strerror(-r));
1115 wait_for_exit = true;
1122 if (wait_for_exit) {
1123 if ((r = unit_watch_timer(UNIT(s), s->timeout_usec, &s->timer_watch)) < 0)
1126 socket_set_state(s, state);
1127 } else if (state == SOCKET_STOP_PRE_SIGTERM || state == SOCKET_STOP_PRE_SIGKILL)
1128 socket_enter_stop_post(s, true);
1130 socket_enter_dead(s, true);
1135 log_warning("%s failed to kill processes: %s", s->meta.id, strerror(-r));
1137 if (state == SOCKET_STOP_PRE_SIGTERM || state == SOCKET_STOP_PRE_SIGKILL)
1138 socket_enter_stop_post(s, false);
1140 socket_enter_dead(s, false);
1146 static void socket_enter_stop_pre(Socket *s, bool success) {
1153 socket_unwatch_control_pid(s);
1155 s->control_command_id = SOCKET_EXEC_STOP_PRE;
1157 if ((s->control_command = s->exec_command[SOCKET_EXEC_STOP_PRE])) {
1158 if ((r = socket_spawn(s, s->control_command, &s->control_pid)) < 0)
1161 socket_set_state(s, SOCKET_STOP_PRE);
1163 socket_enter_stop_post(s, true);
1168 log_warning("%s failed to run 'stop-pre' task: %s", s->meta.id, strerror(-r));
1169 socket_enter_stop_post(s, false);
1172 static void socket_enter_listening(Socket *s) {
1176 if ((r = socket_watch_fds(s)) < 0) {
1177 log_warning("%s failed to watch sockets: %s", s->meta.id, strerror(-r));
1181 socket_set_state(s, SOCKET_LISTENING);
1185 socket_enter_stop_pre(s, false);
1188 static void socket_enter_start_post(Socket *s) {
1192 if ((r = socket_open_fds(s)) < 0) {
1193 log_warning("%s failed to listen on sockets: %s", s->meta.id, strerror(-r));
1197 socket_unwatch_control_pid(s);
1199 s->control_command_id = SOCKET_EXEC_START_POST;
1201 if ((s->control_command = s->exec_command[SOCKET_EXEC_START_POST])) {
1202 if ((r = socket_spawn(s, s->control_command, &s->control_pid)) < 0) {
1203 log_warning("%s failed to run 'start-post' task: %s", s->meta.id, strerror(-r));
1207 socket_set_state(s, SOCKET_START_POST);
1209 socket_enter_listening(s);
1214 socket_enter_stop_pre(s, false);
1217 static void socket_enter_start_pre(Socket *s) {
1221 socket_unwatch_control_pid(s);
1223 s->control_command_id = SOCKET_EXEC_START_PRE;
1225 if ((s->control_command = s->exec_command[SOCKET_EXEC_START_PRE])) {
1226 if ((r = socket_spawn(s, s->control_command, &s->control_pid)) < 0)
1229 socket_set_state(s, SOCKET_START_PRE);
1231 socket_enter_start_post(s);
1236 log_warning("%s failed to run 'start-pre' task: %s", s->meta.id, strerror(-r));
1237 socket_enter_dead(s, false);
1240 static void socket_enter_running(Socket *s, int cfd) {
1245 dbus_error_init(&error);
1247 /* We don't take connections anymore if we are supposed to
1248 * shut down anyway */
1249 if (unit_pending_inactive(UNIT(s))) {
1250 log_debug("Suppressing connection request on %s since unit stop is scheduled.", s->meta.id);
1253 close_nointr_nofail(cfd);
1255 /* Flush all sockets by closing and reopening them */
1256 socket_close_fds(s);
1258 if ((r = socket_watch_fds(s)) < 0) {
1259 log_warning("%s failed to watch sockets: %s", s->meta.id, strerror(-r));
1260 socket_enter_stop_pre(s, false);
1268 bool pending = false;
1271 /* If there's already a start pending don't bother to
1273 LIST_FOREACH(units_per_type, i, s->meta.manager->units_per_type[UNIT_SERVICE]) {
1274 Service *service = (Service *) i;
1276 if (!set_get(service->configured_sockets, s))
1279 if (!unit_pending_active(UNIT(service)))
1287 if ((r = manager_add_job(s->meta.manager, JOB_START, UNIT(s->service), JOB_REPLACE, true, &error, NULL)) < 0)
1290 socket_set_state(s, SOCKET_RUNNING);
1292 char *prefix, *instance = NULL, *name;
1295 if (s->n_connections >= s->max_connections) {
1296 log_warning("Too many incoming connections (%u)", s->n_connections);
1297 close_nointr_nofail(cfd);
1301 if ((r = socket_instantiate_service(s)) < 0)
1304 if ((r = instance_from_socket(cfd, s->n_accepted, &instance)) < 0)
1307 if (!(prefix = unit_name_to_prefix(s->meta.id))) {
1313 name = unit_name_build(prefix, instance, ".service");
1322 if ((r = unit_add_name(UNIT(s->service), name)) < 0) {
1327 service = s->service;
1331 service->meta.no_gc = false;
1333 unit_choose_id(UNIT(service), name);
1336 if ((r = service_set_socket_fd(service, cfd, s)) < 0)
1340 s->n_connections ++;
1342 if ((r = manager_add_job(s->meta.manager, JOB_START, UNIT(service), JOB_REPLACE, true, &error, NULL)) < 0)
1345 /* Notify clients about changed counters */
1346 unit_add_to_dbus_queue(UNIT(s));
1352 log_warning("%s failed to queue socket startup job: %s", s->meta.id, bus_error(&error, r));
1353 socket_enter_stop_pre(s, false);
1356 close_nointr_nofail(cfd);
1358 dbus_error_free(&error);
1361 static void socket_run_next(Socket *s, bool success) {
1365 assert(s->control_command);
1366 assert(s->control_command->command_next);
1371 socket_unwatch_control_pid(s);
1373 s->control_command = s->control_command->command_next;
1375 if ((r = socket_spawn(s, s->control_command, &s->control_pid)) < 0)
1381 log_warning("%s failed to run next task: %s", s->meta.id, strerror(-r));
1383 if (s->state == SOCKET_START_POST)
1384 socket_enter_stop_pre(s, false);
1385 else if (s->state == SOCKET_STOP_POST)
1386 socket_enter_dead(s, false);
1388 socket_enter_signal(s, SOCKET_FINAL_SIGTERM, false);
1391 static int socket_start(Unit *u) {
1392 Socket *s = SOCKET(u);
1396 /* We cannot fulfill this request right now, try again later
1398 if (s->state == SOCKET_STOP_PRE ||
1399 s->state == SOCKET_STOP_PRE_SIGKILL ||
1400 s->state == SOCKET_STOP_PRE_SIGTERM ||
1401 s->state == SOCKET_STOP_POST ||
1402 s->state == SOCKET_FINAL_SIGTERM ||
1403 s->state == SOCKET_FINAL_SIGKILL)
1406 if (s->state == SOCKET_START_PRE ||
1407 s->state == SOCKET_START_POST)
1410 /* Cannot run this without the service being around */
1412 if (s->service->meta.load_state != UNIT_LOADED) {
1413 log_error("Socket service %s not loaded, refusing.", s->service->meta.id);
1417 /* If the service is already active we cannot start the
1419 if (s->service->state != SERVICE_DEAD &&
1420 s->service->state != SERVICE_FAILED &&
1421 s->service->state != SERVICE_AUTO_RESTART) {
1422 log_error("Socket service %s already active, refusing.", s->service->meta.id);
1426 #ifdef HAVE_SYSV_COMPAT
1427 if (s->service->sysv_path) {
1428 log_error("Using SysV services for socket activation is not supported. Refusing.");
1434 assert(s->state == SOCKET_DEAD || s->state == SOCKET_FAILED);
1437 socket_enter_start_pre(s);
1441 static int socket_stop(Unit *u) {
1442 Socket *s = SOCKET(u);
1447 if (s->state == SOCKET_STOP_PRE ||
1448 s->state == SOCKET_STOP_PRE_SIGTERM ||
1449 s->state == SOCKET_STOP_PRE_SIGKILL ||
1450 s->state == SOCKET_STOP_POST ||
1451 s->state == SOCKET_FINAL_SIGTERM ||
1452 s->state == SOCKET_FINAL_SIGKILL)
1455 /* If there's already something running we go directly into
1457 if (s->state == SOCKET_START_PRE ||
1458 s->state == SOCKET_START_POST) {
1459 socket_enter_signal(s, SOCKET_STOP_PRE_SIGTERM, true);
1463 assert(s->state == SOCKET_LISTENING || s->state == SOCKET_RUNNING);
1465 socket_enter_stop_pre(s, true);
1469 static int socket_serialize(Unit *u, FILE *f, FDSet *fds) {
1470 Socket *s = SOCKET(u);
1478 unit_serialize_item(u, f, "state", socket_state_to_string(s->state));
1479 unit_serialize_item(u, f, "failure", yes_no(s->failure));
1480 unit_serialize_item_format(u, f, "n-accepted", "%u", s->n_accepted);
1482 if (s->control_pid > 0)
1483 unit_serialize_item_format(u, f, "control-pid", "%lu", (unsigned long) s->control_pid);
1485 if (s->control_command_id >= 0)
1486 unit_serialize_item(u, f, "control-command", socket_exec_command_to_string(s->control_command_id));
1488 LIST_FOREACH(port, p, s->ports) {
1494 if ((copy = fdset_put_dup(fds, p->fd)) < 0)
1497 if (p->type == SOCKET_SOCKET) {
1500 if ((r = socket_address_print(&p->address, &t)) < 0)
1503 if (socket_address_family(&p->address) == AF_NETLINK)
1504 unit_serialize_item_format(u, f, "netlink", "%i %s", copy, t);
1506 unit_serialize_item_format(u, f, "socket", "%i %i %s", copy, p->address.type, t);
1508 } else if (p->type == SOCKET_SPECIAL)
1509 unit_serialize_item_format(u, f, "special", "%i %s", copy, p->path);
1511 assert(p->type == SOCKET_FIFO);
1512 unit_serialize_item_format(u, f, "fifo", "%i %s", copy, p->path);
1519 static int socket_deserialize_item(Unit *u, const char *key, const char *value, FDSet *fds) {
1520 Socket *s = SOCKET(u);
1527 if (streq(key, "state")) {
1530 if ((state = socket_state_from_string(value)) < 0)
1531 log_debug("Failed to parse state value %s", value);
1533 s->deserialized_state = state;
1534 } else if (streq(key, "failure")) {
1537 if ((b = parse_boolean(value)) < 0)
1538 log_debug("Failed to parse failure value %s", value);
1540 s->failure = b || s->failure;
1542 } else if (streq(key, "n-accepted")) {
1545 if (safe_atou(value, &k) < 0)
1546 log_debug("Failed to parse n-accepted value %s", value);
1549 } else if (streq(key, "control-pid")) {
1552 if (parse_pid(value, &pid) < 0)
1553 log_debug("Failed to parse control-pid value %s", value);
1555 s->control_pid = pid;
1556 } else if (streq(key, "control-command")) {
1557 SocketExecCommand id;
1559 if ((id = socket_exec_command_from_string(value)) < 0)
1560 log_debug("Failed to parse exec-command value %s", value);
1562 s->control_command_id = id;
1563 s->control_command = s->exec_command[id];
1565 } else if (streq(key, "fifo")) {
1569 if (sscanf(value, "%i %n", &fd, &skip) < 1 || fd < 0 || !fdset_contains(fds, fd))
1570 log_debug("Failed to parse fifo value %s", value);
1573 LIST_FOREACH(port, p, s->ports)
1574 if (p->type == SOCKET_FIFO &&
1575 streq_ptr(p->path, value+skip))
1580 close_nointr_nofail(p->fd);
1581 p->fd = fdset_remove(fds, fd);
1585 } else if (streq(key, "special")) {
1589 if (sscanf(value, "%i %n", &fd, &skip) < 1 || fd < 0 || !fdset_contains(fds, fd))
1590 log_debug("Failed to parse special value %s", value);
1593 LIST_FOREACH(port, p, s->ports)
1594 if (p->type == SOCKET_SPECIAL &&
1595 streq_ptr(p->path, value+skip))
1600 close_nointr_nofail(p->fd);
1601 p->fd = fdset_remove(fds, fd);
1605 } else if (streq(key, "socket")) {
1606 int fd, type, skip = 0;
1609 if (sscanf(value, "%i %i %n", &fd, &type, &skip) < 2 || fd < 0 || type < 0 || !fdset_contains(fds, fd))
1610 log_debug("Failed to parse socket value %s", value);
1613 LIST_FOREACH(port, p, s->ports)
1614 if (socket_address_is(&p->address, value+skip, type))
1619 close_nointr_nofail(p->fd);
1620 p->fd = fdset_remove(fds, fd);
1624 } else if (streq(key, "netlink")) {
1628 if (sscanf(value, "%i %n", &fd, &skip) < 1 || fd < 0 || !fdset_contains(fds, fd))
1629 log_debug("Failed to parse socket value %s", value);
1632 LIST_FOREACH(port, p, s->ports)
1633 if (socket_address_is_netlink(&p->address, value+skip))
1638 close_nointr_nofail(p->fd);
1639 p->fd = fdset_remove(fds, fd);
1644 log_debug("Unknown serialization key '%s'", key);
1649 static UnitActiveState socket_active_state(Unit *u) {
1652 return state_translation_table[SOCKET(u)->state];
1655 static const char *socket_sub_state_to_string(Unit *u) {
1658 return socket_state_to_string(SOCKET(u)->state);
1661 static bool socket_check_gc(Unit *u) {
1662 Socket *s = SOCKET(u);
1666 return s->n_connections > 0;
1669 static void socket_fd_event(Unit *u, int fd, uint32_t events, Watch *w) {
1670 Socket *s = SOCKET(u);
1676 if (s->state != SOCKET_LISTENING)
1679 log_debug("Incoming traffic on %s", u->meta.id);
1681 if (events != EPOLLIN) {
1683 if (events & EPOLLHUP)
1684 log_error("%s: Got POLLHUP on a listening socket. The service probably invoked shutdown() on it, and should better not do that.", u->meta.id);
1686 log_error("%s: Got unexpected poll event (0x%x) on socket.", u->meta.id, events);
1691 if (w->socket_accept) {
1694 if ((cfd = accept4(fd, NULL, NULL, SOCK_NONBLOCK)) < 0) {
1699 log_error("Failed to accept socket: %m");
1706 socket_apply_socket_options(s, cfd);
1709 socket_enter_running(s, cfd);
1713 socket_enter_stop_pre(s, false);
1716 static void socket_sigchld_event(Unit *u, pid_t pid, int code, int status) {
1717 Socket *s = SOCKET(u);
1723 if (pid != s->control_pid)
1728 success = is_clean_exit(code, status);
1730 if (s->control_command) {
1731 exec_status_exit(&s->control_command->exec_status, pid, code, status, s->exec_context.utmp_id);
1733 if (s->control_command->ignore)
1737 log_full(success ? LOG_DEBUG : LOG_NOTICE,
1738 "%s control process exited, code=%s status=%i", u->meta.id, sigchld_code_to_string(code), status);
1739 s->failure = s->failure || !success;
1741 if (s->control_command && s->control_command->command_next && success) {
1742 log_debug("%s running next command for state %s", u->meta.id, socket_state_to_string(s->state));
1743 socket_run_next(s, success);
1745 s->control_command = NULL;
1746 s->control_command_id = _SOCKET_EXEC_COMMAND_INVALID;
1748 /* No further commands for this step, so let's figure
1749 * out what to do next */
1751 log_debug("%s got final SIGCHLD for state %s", u->meta.id, socket_state_to_string(s->state));
1755 case SOCKET_START_PRE:
1757 socket_enter_start_post(s);
1759 socket_enter_signal(s, SOCKET_FINAL_SIGTERM, false);
1762 case SOCKET_START_POST:
1764 socket_enter_listening(s);
1766 socket_enter_stop_pre(s, false);
1769 case SOCKET_STOP_PRE:
1770 case SOCKET_STOP_PRE_SIGTERM:
1771 case SOCKET_STOP_PRE_SIGKILL:
1772 socket_enter_stop_post(s, success);
1775 case SOCKET_STOP_POST:
1776 case SOCKET_FINAL_SIGTERM:
1777 case SOCKET_FINAL_SIGKILL:
1778 socket_enter_dead(s, success);
1782 assert_not_reached("Uh, control process died at wrong time.");
1786 /* Notify clients about changed exit status */
1787 unit_add_to_dbus_queue(u);
1790 static void socket_timer_event(Unit *u, uint64_t elapsed, Watch *w) {
1791 Socket *s = SOCKET(u);
1794 assert(elapsed == 1);
1795 assert(w == &s->timer_watch);
1799 case SOCKET_START_PRE:
1800 log_warning("%s starting timed out. Terminating.", u->meta.id);
1801 socket_enter_signal(s, SOCKET_FINAL_SIGTERM, false);
1804 case SOCKET_START_POST:
1805 log_warning("%s starting timed out. Stopping.", u->meta.id);
1806 socket_enter_stop_pre(s, false);
1809 case SOCKET_STOP_PRE:
1810 log_warning("%s stopping timed out. Terminating.", u->meta.id);
1811 socket_enter_signal(s, SOCKET_STOP_PRE_SIGTERM, false);
1814 case SOCKET_STOP_PRE_SIGTERM:
1815 if (s->exec_context.send_sigkill) {
1816 log_warning("%s stopping timed out. Killing.", u->meta.id);
1817 socket_enter_signal(s, SOCKET_STOP_PRE_SIGKILL, false);
1819 log_warning("%s stopping timed out. Skipping SIGKILL. Ignoring.", u->meta.id);
1820 socket_enter_stop_post(s, false);
1824 case SOCKET_STOP_PRE_SIGKILL:
1825 log_warning("%s still around after SIGKILL. Ignoring.", u->meta.id);
1826 socket_enter_stop_post(s, false);
1829 case SOCKET_STOP_POST:
1830 log_warning("%s stopping timed out (2). Terminating.", u->meta.id);
1831 socket_enter_signal(s, SOCKET_FINAL_SIGTERM, false);
1834 case SOCKET_FINAL_SIGTERM:
1835 if (s->exec_context.send_sigkill) {
1836 log_warning("%s stopping timed out (2). Killing.", u->meta.id);
1837 socket_enter_signal(s, SOCKET_FINAL_SIGKILL, false);
1839 log_warning("%s stopping timed out (2). Skipping SIGKILL. Ignoring.", u->meta.id);
1840 socket_enter_dead(s, false);
1844 case SOCKET_FINAL_SIGKILL:
1845 log_warning("%s still around after SIGKILL (2). Entering failed mode.", u->meta.id);
1846 socket_enter_dead(s, false);
1850 assert_not_reached("Timeout at wrong time.");
1854 int socket_collect_fds(Socket *s, int **fds, unsigned *n_fds) {
1863 /* Called from the service code for requesting our fds */
1866 LIST_FOREACH(port, p, s->ports)
1870 if (!(rfds = new(int, rn_fds)))
1874 LIST_FOREACH(port, p, s->ports)
1878 assert(k == rn_fds);
1886 void socket_notify_service_dead(Socket *s) {
1889 /* The service is dead. Dang!
1891 * This is strictly for one-instance-for-all-connections
1894 if (s->state == SOCKET_RUNNING) {
1895 log_debug("%s got notified about service death.", s->meta.id);
1896 socket_enter_listening(s);
1900 void socket_connection_unref(Socket *s) {
1903 /* The service is dead. Yay!
1905 * This is strictly for one-instance-per-connection
1908 assert(s->n_connections > 0);
1911 log_debug("%s: One connection closed, %u left.", s->meta.id, s->n_connections);
1914 static void socket_reset_failed(Unit *u) {
1915 Socket *s = SOCKET(u);
1919 if (s->state == SOCKET_FAILED)
1920 socket_set_state(s, SOCKET_DEAD);
1925 static int socket_kill(Unit *u, KillWho who, KillMode mode, int signo, DBusError *error) {
1926 Socket *s = SOCKET(u);
1928 Set *pid_set = NULL;
1932 if (who == KILL_MAIN) {
1933 dbus_set_error(error, BUS_ERROR_NO_SUCH_PROCESS, "Socket units have no main processes");
1937 if (s->control_pid <= 0 && who == KILL_CONTROL) {
1938 dbus_set_error(error, BUS_ERROR_NO_SUCH_PROCESS, "No control process to kill");
1942 if (s->control_pid > 0)
1943 if (kill(s->control_pid, signo) < 0)
1946 if (mode == KILL_CONTROL_GROUP) {
1949 if (!(pid_set = set_new(trivial_hash_func, trivial_compare_func)))
1952 /* Exclude the control pid from being killed via the cgroup */
1953 if (s->control_pid > 0)
1954 if ((q = set_put(pid_set, LONG_TO_PTR(s->control_pid))) < 0) {
1959 if ((q = cgroup_bonding_kill_list(s->meta.cgroup_bondings, signo, false, pid_set)) < 0)
1960 if (r != -EAGAIN && r != -ESRCH && r != -ENOENT)
1971 static const char* const socket_state_table[_SOCKET_STATE_MAX] = {
1972 [SOCKET_DEAD] = "dead",
1973 [SOCKET_START_PRE] = "start-pre",
1974 [SOCKET_START_POST] = "start-post",
1975 [SOCKET_LISTENING] = "listening",
1976 [SOCKET_RUNNING] = "running",
1977 [SOCKET_STOP_PRE] = "stop-pre",
1978 [SOCKET_STOP_PRE_SIGTERM] = "stop-pre-sigterm",
1979 [SOCKET_STOP_PRE_SIGKILL] = "stop-pre-sigkill",
1980 [SOCKET_STOP_POST] = "stop-post",
1981 [SOCKET_FINAL_SIGTERM] = "final-sigterm",
1982 [SOCKET_FINAL_SIGKILL] = "final-sigkill",
1983 [SOCKET_FAILED] = "failed"
1986 DEFINE_STRING_TABLE_LOOKUP(socket_state, SocketState);
1988 static const char* const socket_exec_command_table[_SOCKET_EXEC_COMMAND_MAX] = {
1989 [SOCKET_EXEC_START_PRE] = "StartPre",
1990 [SOCKET_EXEC_START_POST] = "StartPost",
1991 [SOCKET_EXEC_STOP_PRE] = "StopPre",
1992 [SOCKET_EXEC_STOP_POST] = "StopPost"
1995 DEFINE_STRING_TABLE_LOOKUP(socket_exec_command, SocketExecCommand);
1997 const UnitVTable socket_vtable = {
1998 .suffix = ".socket",
2000 .init = socket_init,
2001 .done = socket_done,
2002 .load = socket_load,
2004 .kill = socket_kill,
2006 .coldplug = socket_coldplug,
2008 .dump = socket_dump,
2010 .start = socket_start,
2011 .stop = socket_stop,
2013 .serialize = socket_serialize,
2014 .deserialize_item = socket_deserialize_item,
2016 .active_state = socket_active_state,
2017 .sub_state_to_string = socket_sub_state_to_string,
2019 .check_gc = socket_check_gc,
2021 .fd_event = socket_fd_event,
2022 .sigchld_event = socket_sigchld_event,
2023 .timer_event = socket_timer_event,
2025 .reset_failed = socket_reset_failed,
2027 .bus_interface = "org.freedesktop.systemd1.Socket",
2028 .bus_message_handler = bus_socket_message_handler,
2029 .bus_invalidating_properties = bus_socket_invalidating_properties