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"
45 static const UnitActiveState state_translation_table[_SOCKET_STATE_MAX] = {
46 [SOCKET_DEAD] = UNIT_INACTIVE,
47 [SOCKET_START_PRE] = UNIT_ACTIVATING,
48 [SOCKET_START_POST] = UNIT_ACTIVATING,
49 [SOCKET_LISTENING] = UNIT_ACTIVE,
50 [SOCKET_RUNNING] = UNIT_ACTIVE,
51 [SOCKET_STOP_PRE] = UNIT_DEACTIVATING,
52 [SOCKET_STOP_PRE_SIGTERM] = UNIT_DEACTIVATING,
53 [SOCKET_STOP_PRE_SIGKILL] = UNIT_DEACTIVATING,
54 [SOCKET_STOP_POST] = UNIT_DEACTIVATING,
55 [SOCKET_FINAL_SIGTERM] = UNIT_DEACTIVATING,
56 [SOCKET_FINAL_SIGKILL] = UNIT_DEACTIVATING,
57 [SOCKET_FAILED] = UNIT_FAILED
60 static void socket_init(Unit *u) {
61 Socket *s = SOCKET(u);
64 assert(u->meta.load_state == UNIT_STUB);
66 s->backlog = SOMAXCONN;
67 s->timeout_usec = DEFAULT_TIMEOUT_USEC;
68 s->directory_mode = 0755;
69 s->socket_mode = 0666;
71 s->max_connections = 64;
78 exec_context_init(&s->exec_context);
80 s->control_command_id = _SOCKET_EXEC_COMMAND_INVALID;
83 static void socket_unwatch_control_pid(Socket *s) {
86 if (s->control_pid <= 0)
89 unit_unwatch_pid(UNIT(s), s->control_pid);
93 static void socket_done(Unit *u) {
94 Socket *s = SOCKET(u);
100 while ((p = s->ports)) {
101 LIST_REMOVE(SocketPort, port, s->ports, p);
104 unit_unwatch_fd(UNIT(s), &p->fd_watch);
105 close_nointr_nofail(p->fd);
112 exec_context_done(&s->exec_context);
113 exec_command_free_array(s->exec_command, _SOCKET_EXEC_COMMAND_MAX);
114 s->control_command = NULL;
116 socket_unwatch_control_pid(s);
120 free(s->tcp_congestion);
121 s->tcp_congestion = NULL;
123 free(s->bind_to_device);
124 s->bind_to_device = NULL;
126 unit_unwatch_timer(u, &s->timer_watch);
128 /* Make sure no service instance refers to us anymore. */
129 LIST_FOREACH(units_per_type, i, u->meta.manager->units_per_type[UNIT_SERVICE]) {
130 Service *service = (Service *) i;
132 if (service->accept_socket == s)
133 service->accept_socket = NULL;
135 set_remove(service->configured_sockets, s);
139 static int socket_instantiate_service(Socket *s) {
146 /* This fills in s->service if it isn't filled in yet. For
147 * Accept=yes sockets we create the next connection service
148 * here. For Accept=no this is mostly a NOP since the service
149 * is figured out at load time anyway. */
156 if (!(prefix = unit_name_to_prefix(s->meta.id)))
159 r = asprintf(&name, "%s@%u.service", prefix, s->n_accepted);
165 r = manager_load_unit(s->meta.manager, name, NULL, NULL, &u);
171 u->meta.no_gc = true;
172 s->service = SERVICE(u);
176 static bool have_non_accept_socket(Socket *s) {
184 LIST_FOREACH(port, p, s->ports) {
186 if (p->type != SOCKET_SOCKET)
189 if (!socket_address_can_accept(&p->address))
196 static int socket_verify(Socket *s) {
199 if (s->meta.load_state != UNIT_LOADED)
203 log_error("%s lacks Listen setting. Refusing.", s->meta.id);
207 if (s->accept && have_non_accept_socket(s)) {
208 log_error("%s configured for accepting sockets, but sockets are non-accepting. Refusing.", s->meta.id);
212 if (s->accept && s->max_connections <= 0) {
213 log_error("%s's MaxConnection setting too small. Refusing.", s->meta.id);
217 if (s->accept && s->service) {
218 log_error("Explicit service configuration for accepting sockets not supported on %s. Refusing.", s->meta.id);
222 if (s->exec_context.pam_name && s->exec_context.kill_mode != KILL_CONTROL_GROUP) {
223 log_error("%s has PAM enabled. Kill mode must be set to 'control-group'. Refusing.", s->meta.id);
230 static bool socket_needs_mount(Socket *s, const char *prefix) {
235 LIST_FOREACH(port, p, s->ports) {
237 if (p->type == SOCKET_SOCKET) {
238 if (socket_address_needs_mount(&p->address, prefix))
241 assert(p->type == SOCKET_FIFO);
242 if (path_startswith(p->path, prefix))
250 int socket_add_one_mount_link(Socket *s, Mount *m) {
256 if (s->meta.load_state != UNIT_LOADED ||
257 m->meta.load_state != UNIT_LOADED)
260 if (!socket_needs_mount(s, m->where))
263 if ((r = unit_add_two_dependencies(UNIT(s), UNIT_AFTER, UNIT_REQUIRES, UNIT(m), true)) < 0)
269 static int socket_add_mount_links(Socket *s) {
275 LIST_FOREACH(units_per_type, other, s->meta.manager->units_per_type[UNIT_MOUNT])
276 if ((r = socket_add_one_mount_link(s, (Mount*) other)) < 0)
282 static int socket_add_device_link(Socket *s) {
288 if (!s->bind_to_device)
291 if (asprintf(&t, "/sys/subsystem/net/devices/%s", s->bind_to_device) < 0)
294 r = unit_add_node_link(UNIT(s), t, false);
300 static int socket_add_default_dependencies(Socket *s) {
304 if (s->meta.manager->running_as == MANAGER_SYSTEM) {
305 if ((r = unit_add_dependency_by_name(UNIT(s), UNIT_BEFORE, SPECIAL_SOCKETS_TARGET, NULL, true)) < 0)
308 if ((r = unit_add_two_dependencies_by_name(UNIT(s), UNIT_AFTER, UNIT_REQUIRES, SPECIAL_SYSINIT_TARGET, NULL, true)) < 0)
312 return unit_add_two_dependencies_by_name(UNIT(s), UNIT_BEFORE, UNIT_CONFLICTS, SPECIAL_SHUTDOWN_TARGET, NULL, true);
315 static int socket_load(Unit *u) {
316 Socket *s = SOCKET(u);
320 assert(u->meta.load_state == UNIT_STUB);
322 if ((r = unit_load_fragment_and_dropin(u)) < 0)
325 /* This is a new unit? Then let's add in some extras */
326 if (u->meta.load_state == UNIT_LOADED) {
328 if (have_non_accept_socket(s)) {
331 if ((r = unit_load_related_unit(u, ".service", (Unit**) &s->service)) < 0)
334 if ((r = unit_add_dependency(u, UNIT_BEFORE, UNIT(s->service), true)) < 0)
338 if ((r = socket_add_mount_links(s)) < 0)
341 if ((r = socket_add_device_link(s)) < 0)
344 if ((r = unit_add_exec_dependencies(u, &s->exec_context)) < 0)
347 if ((r = unit_add_default_cgroup(u)) < 0)
350 if (s->meta.default_dependencies)
351 if ((r = socket_add_default_dependencies(s)) < 0)
355 return socket_verify(s);
358 static const char* listen_lookup(int type) {
360 if (type == SOCK_STREAM)
361 return "ListenStream";
362 else if (type == SOCK_DGRAM)
363 return "ListenDatagram";
364 else if (type == SOCK_SEQPACKET)
365 return "ListenSequentialPacket";
367 assert_not_reached("Unknown socket type");
371 static void socket_dump(Unit *u, FILE *f, const char *prefix) {
374 Socket *s = SOCKET(u);
382 p2 = strappend(prefix, "\t");
383 prefix2 = p2 ? p2 : prefix;
386 "%sSocket State: %s\n"
387 "%sBindIPv6Only: %s\n"
389 "%sSocketMode: %04o\n"
390 "%sDirectoryMode: %04o\n"
393 "%sTCPCongestion: %s\n",
394 prefix, socket_state_to_string(s->state),
395 prefix, socket_address_bind_ipv6_only_to_string(s->bind_ipv6_only),
397 prefix, s->socket_mode,
398 prefix, s->directory_mode,
399 prefix, yes_no(s->keep_alive),
400 prefix, yes_no(s->free_bind),
401 prefix, strna(s->tcp_congestion));
403 if (s->control_pid > 0)
405 "%sControl PID: %lu\n",
406 prefix, (unsigned long) s->control_pid);
408 if (s->bind_to_device)
410 "%sBindToDevice: %s\n",
411 prefix, s->bind_to_device);
416 "%sNConnections: %u\n"
417 "%sMaxConnections: %u\n",
418 prefix, s->n_accepted,
419 prefix, s->n_connections,
420 prefix, s->max_connections);
422 if (s->priority >= 0)
425 prefix, s->priority);
427 if (s->receive_buffer > 0)
429 "%sReceiveBuffer: %zu\n",
430 prefix, s->receive_buffer);
432 if (s->send_buffer > 0)
434 "%sSendBuffer: %zu\n",
435 prefix, s->send_buffer);
447 if (s->pipe_size > 0)
450 prefix, s->pipe_size);
457 LIST_FOREACH(port, p, s->ports) {
459 if (p->type == SOCKET_SOCKET) {
464 if ((r = socket_address_print(&p->address, &k)) < 0)
469 fprintf(f, "%s%s: %s\n", prefix, listen_lookup(p->address.type), t);
472 fprintf(f, "%sListenFIFO: %s\n", prefix, p->path);
475 exec_context_dump(&s->exec_context, f, prefix);
477 for (c = 0; c < _SOCKET_EXEC_COMMAND_MAX; c++) {
478 if (!s->exec_command[c])
481 fprintf(f, "%s-> %s:\n",
482 prefix, socket_exec_command_to_string(c));
484 exec_command_dump_list(s->exec_command[c], f, prefix2);
490 static int instance_from_socket(int fd, unsigned nr, char **instance) {
495 struct sockaddr_un un;
496 struct sockaddr_in in;
497 struct sockaddr_in6 in6;
498 struct sockaddr_storage storage;
505 if (getsockname(fd, &local.sa, &l) < 0)
509 if (getpeername(fd, &remote.sa, &l) < 0)
512 switch (local.sa.sa_family) {
516 a = ntohl(local.in.sin_addr.s_addr),
517 b = ntohl(remote.in.sin_addr.s_addr);
520 "%u.%u.%u.%u:%u-%u.%u.%u.%u:%u",
521 a >> 24, (a >> 16) & 0xFF, (a >> 8) & 0xFF, a & 0xFF,
522 ntohs(local.in.sin_port),
523 b >> 24, (b >> 16) & 0xFF, (b >> 8) & 0xFF, b & 0xFF,
524 ntohs(remote.in.sin_port)) < 0)
531 static const char ipv4_prefix[] = {
532 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0xFF, 0xFF
535 if (memcmp(&local.in6.sin6_addr, ipv4_prefix, sizeof(ipv4_prefix)) == 0 &&
536 memcmp(&remote.in6.sin6_addr, ipv4_prefix, sizeof(ipv4_prefix)) == 0) {
538 *a = local.in6.sin6_addr.s6_addr+12,
539 *b = remote.in6.sin6_addr.s6_addr+12;
542 "%u.%u.%u.%u:%u-%u.%u.%u.%u:%u",
543 a[0], a[1], a[2], a[3],
544 ntohs(local.in6.sin6_port),
545 b[0], b[1], b[2], b[3],
546 ntohs(remote.in6.sin6_port)) < 0)
549 char a[INET6_ADDRSTRLEN], b[INET6_ADDRSTRLEN];
553 inet_ntop(AF_INET6, &local.in6.sin6_addr, a, sizeof(a)),
554 ntohs(local.in6.sin6_port),
555 inet_ntop(AF_INET6, &remote.in6.sin6_addr, b, sizeof(b)),
556 ntohs(remote.in6.sin6_port)) < 0)
567 if (getsockopt(fd, SOL_SOCKET, SO_PEERCRED, &ucred, &l) < 0)
573 (unsigned long) ucred.pid,
574 (unsigned long) ucred.uid) < 0)
581 assert_not_reached("Unhandled socket type.");
588 static void socket_close_fds(Socket *s) {
593 LIST_FOREACH(port, p, s->ports) {
597 unit_unwatch_fd(UNIT(s), &p->fd_watch);
598 close_nointr_nofail(p->fd);
600 /* One little note: we should never delete any sockets
601 * in the file system here! After all some other
602 * process we spawned might still have a reference of
603 * this fd and wants to continue to use it. Therefore
604 * we delete sockets in the file system before we
605 * create a new one, not after we stopped using
612 static void socket_apply_socket_options(Socket *s, int fd) {
617 int b = s->keep_alive;
618 if (setsockopt(fd, SOL_SOCKET, SO_KEEPALIVE, &b, sizeof(b)) < 0)
619 log_warning("SO_KEEPALIVE failed: %m");
622 if (s->priority >= 0)
623 if (setsockopt(fd, SOL_SOCKET, SO_PRIORITY, &s->priority, sizeof(s->priority)) < 0)
624 log_warning("SO_PRIORITY failed: %m");
626 if (s->receive_buffer > 0) {
627 int value = (int) s->receive_buffer;
628 if (setsockopt(fd, SOL_SOCKET, SO_RCVBUF, &value, sizeof(value)) < 0)
629 log_warning("SO_RCVBUF failed: %m");
632 if (s->send_buffer > 0) {
633 int value = (int) s->send_buffer;
634 if (setsockopt(fd, SOL_SOCKET, SO_SNDBUF, &value, sizeof(value)) < 0)
635 log_warning("SO_SNDBUF failed: %m");
639 if (setsockopt(fd, SOL_SOCKET, SO_MARK, &s->mark, sizeof(s->mark)) < 0)
640 log_warning("SO_MARK failed: %m");
643 if (setsockopt(fd, IPPROTO_IP, IP_TOS, &s->ip_tos, sizeof(s->ip_tos)) < 0)
644 log_warning("IP_TOS failed: %m");
646 if (s->ip_ttl >= 0) {
649 r = setsockopt(fd, IPPROTO_IP, IP_TTL, &s->ip_ttl, sizeof(s->ip_ttl));
651 if (socket_ipv6_is_supported())
652 x = setsockopt(fd, IPPROTO_IPV6, IPV6_UNICAST_HOPS, &s->ip_ttl, sizeof(s->ip_ttl));
655 errno = EAFNOSUPPORT;
659 log_warning("IP_TTL/IPV6_UNICAST_HOPS failed: %m");
662 if (s->tcp_congestion)
663 if (setsockopt(fd, SOL_TCP, TCP_CONGESTION, s->tcp_congestion, strlen(s->tcp_congestion)+1) < 0)
664 log_warning("TCP_CONGESTION failed: %m");
667 static void socket_apply_fifo_options(Socket *s, int fd) {
671 if (s->pipe_size > 0)
672 if (fcntl(fd, F_SETPIPE_SZ, s->pipe_size) < 0)
673 log_warning("F_SETPIPE_SZ: %m");
677 static int fifo_address_create(
679 mode_t directory_mode,
690 mkdir_parents(path, directory_mode);
692 if ((r = label_fifofile_set(path)) < 0)
695 /* Enforce the right access mode for the fifo */
696 old_mask = umask(~ socket_mode);
698 /* Include the original umask in our mask */
699 umask(~socket_mode | old_mask);
701 r = mkfifo(path, socket_mode);
709 if ((fd = open(path, O_RDWR|O_CLOEXEC|O_NOCTTY|O_NONBLOCK|O_NOFOLLOW)) < 0) {
716 if (fstat(fd, &st) < 0) {
721 if (!S_ISFIFO(st.st_mode) ||
722 (st.st_mode & 0777) != (socket_mode & ~old_mask) ||
723 st.st_uid != getuid() ||
724 st.st_gid != getgid()) {
737 close_nointr_nofail(fd);
742 static int socket_open_fds(Socket *s) {
746 bool know_label = false;
750 LIST_FOREACH(port, p, s->ports) {
755 if (p->type == SOCKET_SOCKET) {
759 if ((r = socket_instantiate_service(s)) < 0)
762 if ((r = label_get_socket_label_from_exe(s->service->exec_command[SERVICE_EXEC_START]->path, &label)) < 0)
768 if ((r = socket_address_listen(
780 socket_apply_socket_options(s, p->fd);
782 } else if (p->type == SOCKET_FIFO) {
784 if ((r = fifo_address_create(
791 socket_apply_fifo_options(s, p->fd);
794 assert_not_reached("Unknown port type");
806 static void socket_unwatch_fds(Socket *s) {
811 LIST_FOREACH(port, p, s->ports) {
815 unit_unwatch_fd(UNIT(s), &p->fd_watch);
819 static int socket_watch_fds(Socket *s) {
825 LIST_FOREACH(port, p, s->ports) {
829 p->fd_watch.socket_accept =
831 p->type == SOCKET_SOCKET &&
832 socket_address_can_accept(&p->address);
834 if ((r = unit_watch_fd(UNIT(s), p->fd, EPOLLIN, &p->fd_watch)) < 0)
841 socket_unwatch_fds(s);
845 static void socket_set_state(Socket *s, SocketState state) {
846 SocketState old_state;
849 old_state = s->state;
852 if (state != SOCKET_START_PRE &&
853 state != SOCKET_START_POST &&
854 state != SOCKET_STOP_PRE &&
855 state != SOCKET_STOP_PRE_SIGTERM &&
856 state != SOCKET_STOP_PRE_SIGKILL &&
857 state != SOCKET_STOP_POST &&
858 state != SOCKET_FINAL_SIGTERM &&
859 state != SOCKET_FINAL_SIGKILL) {
860 unit_unwatch_timer(UNIT(s), &s->timer_watch);
861 socket_unwatch_control_pid(s);
862 s->control_command = NULL;
863 s->control_command_id = _SOCKET_EXEC_COMMAND_INVALID;
866 if (state != SOCKET_LISTENING)
867 socket_unwatch_fds(s);
869 if (state != SOCKET_START_POST &&
870 state != SOCKET_LISTENING &&
871 state != SOCKET_RUNNING &&
872 state != SOCKET_STOP_PRE &&
873 state != SOCKET_STOP_PRE_SIGTERM &&
874 state != SOCKET_STOP_PRE_SIGKILL)
877 if (state != old_state)
878 log_debug("%s changed %s -> %s",
880 socket_state_to_string(old_state),
881 socket_state_to_string(state));
883 unit_notify(UNIT(s), state_translation_table[old_state], state_translation_table[state]);
886 static int socket_coldplug(Unit *u) {
887 Socket *s = SOCKET(u);
891 assert(s->state == SOCKET_DEAD);
893 if (s->deserialized_state != s->state) {
895 if (s->deserialized_state == SOCKET_START_PRE ||
896 s->deserialized_state == SOCKET_START_POST ||
897 s->deserialized_state == SOCKET_STOP_PRE ||
898 s->deserialized_state == SOCKET_STOP_PRE_SIGTERM ||
899 s->deserialized_state == SOCKET_STOP_PRE_SIGKILL ||
900 s->deserialized_state == SOCKET_STOP_POST ||
901 s->deserialized_state == SOCKET_FINAL_SIGTERM ||
902 s->deserialized_state == SOCKET_FINAL_SIGKILL) {
904 if (s->control_pid <= 0)
907 if ((r = unit_watch_pid(UNIT(s), s->control_pid)) < 0)
910 if ((r = unit_watch_timer(UNIT(s), s->timeout_usec, &s->timer_watch)) < 0)
914 if (s->deserialized_state == SOCKET_START_POST ||
915 s->deserialized_state == SOCKET_LISTENING ||
916 s->deserialized_state == SOCKET_RUNNING ||
917 s->deserialized_state == SOCKET_STOP_PRE ||
918 s->deserialized_state == SOCKET_STOP_PRE_SIGTERM ||
919 s->deserialized_state == SOCKET_STOP_PRE_SIGKILL)
920 if ((r = socket_open_fds(s)) < 0)
923 if (s->deserialized_state == SOCKET_LISTENING)
924 if ((r = socket_watch_fds(s)) < 0)
927 socket_set_state(s, s->deserialized_state);
933 static int socket_spawn(Socket *s, ExecCommand *c, pid_t *_pid) {
942 if ((r = unit_watch_timer(UNIT(s), s->timeout_usec, &s->timer_watch)) < 0)
945 if (!(argv = unit_full_printf_strv(UNIT(s), c->argv))) {
954 s->meta.manager->environment,
958 s->meta.manager->confirm_spawn,
959 s->meta.cgroup_bondings,
966 if ((r = unit_watch_pid(UNIT(s), pid)) < 0)
967 /* FIXME: we need to do something here */
975 unit_unwatch_timer(UNIT(s), &s->timer_watch);
980 static void socket_enter_dead(Socket *s, bool success) {
986 socket_set_state(s, s->failure ? SOCKET_FAILED : SOCKET_DEAD);
989 static void socket_enter_signal(Socket *s, SocketState state, bool success);
991 static void socket_enter_stop_post(Socket *s, bool success) {
998 socket_unwatch_control_pid(s);
1000 s->control_command_id = SOCKET_EXEC_STOP_POST;
1002 if ((s->control_command = s->exec_command[SOCKET_EXEC_STOP_POST])) {
1003 if ((r = socket_spawn(s, s->control_command, &s->control_pid)) < 0)
1006 socket_set_state(s, SOCKET_STOP_POST);
1008 socket_enter_signal(s, SOCKET_FINAL_SIGTERM, true);
1013 log_warning("%s failed to run 'stop-post' task: %s", s->meta.id, strerror(-r));
1014 socket_enter_signal(s, SOCKET_FINAL_SIGTERM, false);
1017 static void socket_enter_signal(Socket *s, SocketState state, bool success) {
1019 Set *pid_set = NULL;
1020 bool wait_for_exit = false;
1027 if (s->exec_context.kill_mode != KILL_NONE) {
1028 int sig = (state == SOCKET_STOP_PRE_SIGTERM || state == SOCKET_FINAL_SIGTERM) ? s->exec_context.kill_signal : SIGKILL;
1030 if (s->control_pid > 0) {
1031 if (kill(s->exec_context.kill_mode == KILL_PROCESS_GROUP ?
1033 s->control_pid, sig) < 0 && errno != ESRCH)
1035 log_warning("Failed to kill control process %li: %m", (long) s->control_pid);
1037 wait_for_exit = true;
1040 if (s->exec_context.kill_mode == KILL_CONTROL_GROUP) {
1042 if (!(pid_set = set_new(trivial_hash_func, trivial_compare_func))) {
1047 /* Exclude the control pid from being killed via the cgroup */
1048 if (s->control_pid > 0)
1049 if ((r = set_put(pid_set, LONG_TO_PTR(s->control_pid))) < 0)
1052 if ((r = cgroup_bonding_kill_list(s->meta.cgroup_bondings, sig, pid_set)) < 0) {
1053 if (r != -EAGAIN && r != -ESRCH && r != -ENOENT)
1054 log_warning("Failed to kill control group: %s", strerror(-r));
1056 wait_for_exit = true;
1062 if (wait_for_exit) {
1063 if ((r = unit_watch_timer(UNIT(s), s->timeout_usec, &s->timer_watch)) < 0)
1066 socket_set_state(s, state);
1067 } else if (state == SOCKET_STOP_PRE_SIGTERM || state == SOCKET_STOP_PRE_SIGKILL)
1068 socket_enter_stop_post(s, true);
1070 socket_enter_dead(s, true);
1075 log_warning("%s failed to kill processes: %s", s->meta.id, strerror(-r));
1077 if (state == SOCKET_STOP_PRE_SIGTERM || state == SOCKET_STOP_PRE_SIGKILL)
1078 socket_enter_stop_post(s, false);
1080 socket_enter_dead(s, false);
1086 static void socket_enter_stop_pre(Socket *s, bool success) {
1093 socket_unwatch_control_pid(s);
1095 s->control_command_id = SOCKET_EXEC_STOP_PRE;
1097 if ((s->control_command = s->exec_command[SOCKET_EXEC_STOP_PRE])) {
1098 if ((r = socket_spawn(s, s->control_command, &s->control_pid)) < 0)
1101 socket_set_state(s, SOCKET_STOP_PRE);
1103 socket_enter_stop_post(s, true);
1108 log_warning("%s failed to run 'stop-pre' task: %s", s->meta.id, strerror(-r));
1109 socket_enter_stop_post(s, false);
1112 static void socket_enter_listening(Socket *s) {
1116 if ((r = socket_watch_fds(s)) < 0) {
1117 log_warning("%s failed to watch sockets: %s", s->meta.id, strerror(-r));
1121 socket_set_state(s, SOCKET_LISTENING);
1125 socket_enter_stop_pre(s, false);
1128 static void socket_enter_start_post(Socket *s) {
1132 if ((r = socket_open_fds(s)) < 0) {
1133 log_warning("%s failed to listen on sockets: %s", s->meta.id, strerror(-r));
1137 socket_unwatch_control_pid(s);
1139 s->control_command_id = SOCKET_EXEC_START_POST;
1141 if ((s->control_command = s->exec_command[SOCKET_EXEC_START_POST])) {
1142 if ((r = socket_spawn(s, s->control_command, &s->control_pid)) < 0) {
1143 log_warning("%s failed to run 'start-post' task: %s", s->meta.id, strerror(-r));
1147 socket_set_state(s, SOCKET_START_POST);
1149 socket_enter_listening(s);
1154 socket_enter_stop_pre(s, false);
1157 static void socket_enter_start_pre(Socket *s) {
1161 socket_unwatch_control_pid(s);
1163 s->control_command_id = SOCKET_EXEC_START_PRE;
1165 if ((s->control_command = s->exec_command[SOCKET_EXEC_START_PRE])) {
1166 if ((r = socket_spawn(s, s->control_command, &s->control_pid)) < 0)
1169 socket_set_state(s, SOCKET_START_PRE);
1171 socket_enter_start_post(s);
1176 log_warning("%s failed to run 'start-pre' task: %s", s->meta.id, strerror(-r));
1177 socket_enter_dead(s, false);
1180 static void socket_enter_running(Socket *s, int cfd) {
1185 dbus_error_init(&error);
1187 /* We don't take connections anymore if we are supposed to
1188 * shut down anyway */
1189 if (unit_pending_inactive(UNIT(s))) {
1191 close_nointr_nofail(cfd);
1193 /* Flush all sockets by closing and reopening them */
1194 socket_close_fds(s);
1196 if ((r = socket_watch_fds(s)) < 0) {
1197 log_warning("%s failed to watch sockets: %s", s->meta.id, strerror(-r));
1198 socket_enter_stop_pre(s, false);
1206 bool pending = false;
1209 /* If there's already a start pending don't bother to
1211 LIST_FOREACH(units_per_type, i, s->meta.manager->units_per_type[UNIT_SERVICE]) {
1212 Service *service = (Service *) i;
1214 if (!set_get(service->configured_sockets, s))
1217 if (!unit_pending_active(UNIT(service)))
1225 if ((r = manager_add_job(s->meta.manager, JOB_START, UNIT(s->service), JOB_REPLACE, true, &error, NULL)) < 0)
1228 socket_set_state(s, SOCKET_RUNNING);
1230 char *prefix, *instance = NULL, *name;
1233 if (s->n_connections >= s->max_connections) {
1234 log_warning("Too many incoming connections (%u)", s->n_connections);
1235 close_nointr_nofail(cfd);
1239 if ((r = socket_instantiate_service(s)) < 0)
1242 if ((r = instance_from_socket(cfd, s->n_accepted, &instance)) < 0)
1245 if (!(prefix = unit_name_to_prefix(s->meta.id))) {
1251 name = unit_name_build(prefix, instance, ".service");
1260 if ((r = unit_add_name(UNIT(s->service), name)) < 0) {
1265 service = s->service;
1269 service->meta.no_gc = false;
1271 unit_choose_id(UNIT(service), name);
1274 if ((r = service_set_socket_fd(service, cfd, s)) < 0)
1278 s->n_connections ++;
1280 if ((r = manager_add_job(s->meta.manager, JOB_START, UNIT(service), JOB_REPLACE, true, &error, NULL)) < 0)
1283 /* Notify clients about changed counters */
1284 unit_add_to_dbus_queue(UNIT(s));
1290 log_warning("%s failed to queue socket startup job: %s", s->meta.id, bus_error(&error, r));
1291 socket_enter_stop_pre(s, false);
1294 close_nointr_nofail(cfd);
1296 dbus_error_free(&error);
1299 static void socket_run_next(Socket *s, bool success) {
1303 assert(s->control_command);
1304 assert(s->control_command->command_next);
1309 socket_unwatch_control_pid(s);
1311 s->control_command = s->control_command->command_next;
1313 if ((r = socket_spawn(s, s->control_command, &s->control_pid)) < 0)
1319 log_warning("%s failed to run next task: %s", s->meta.id, strerror(-r));
1321 if (s->state == SOCKET_START_POST)
1322 socket_enter_stop_pre(s, false);
1323 else if (s->state == SOCKET_STOP_POST)
1324 socket_enter_dead(s, false);
1326 socket_enter_signal(s, SOCKET_FINAL_SIGTERM, false);
1329 static int socket_start(Unit *u) {
1330 Socket *s = SOCKET(u);
1334 /* We cannot fulfill this request right now, try again later
1336 if (s->state == SOCKET_STOP_PRE ||
1337 s->state == SOCKET_STOP_PRE_SIGKILL ||
1338 s->state == SOCKET_STOP_PRE_SIGTERM ||
1339 s->state == SOCKET_STOP_POST ||
1340 s->state == SOCKET_FINAL_SIGTERM ||
1341 s->state == SOCKET_FINAL_SIGKILL)
1344 if (s->state == SOCKET_START_PRE ||
1345 s->state == SOCKET_START_POST)
1348 /* Cannot run this without the service being around */
1350 if (s->service->meta.load_state != UNIT_LOADED)
1353 /* If the service is alredy actvie we cannot start the
1355 if (s->service->state != SERVICE_DEAD &&
1356 s->service->state != SERVICE_FAILED &&
1357 s->service->state != SERVICE_AUTO_RESTART)
1361 assert(s->state == SOCKET_DEAD || s->state == SOCKET_FAILED);
1364 socket_enter_start_pre(s);
1368 static int socket_stop(Unit *u) {
1369 Socket *s = SOCKET(u);
1374 if (s->state == SOCKET_STOP_PRE ||
1375 s->state == SOCKET_STOP_PRE_SIGTERM ||
1376 s->state == SOCKET_STOP_PRE_SIGKILL ||
1377 s->state == SOCKET_STOP_POST ||
1378 s->state == SOCKET_FINAL_SIGTERM ||
1379 s->state == SOCKET_FINAL_SIGKILL)
1382 /* If there's already something running we go directly into
1384 if (s->state == SOCKET_START_PRE ||
1385 s->state == SOCKET_START_POST) {
1386 socket_enter_signal(s, SOCKET_STOP_PRE_SIGTERM, true);
1390 assert(s->state == SOCKET_LISTENING || s->state == SOCKET_RUNNING);
1392 socket_enter_stop_pre(s, true);
1396 static int socket_serialize(Unit *u, FILE *f, FDSet *fds) {
1397 Socket *s = SOCKET(u);
1405 unit_serialize_item(u, f, "state", socket_state_to_string(s->state));
1406 unit_serialize_item(u, f, "failure", yes_no(s->failure));
1407 unit_serialize_item_format(u, f, "n-accepted", "%u", s->n_accepted);
1409 if (s->control_pid > 0)
1410 unit_serialize_item_format(u, f, "control-pid", "%lu", (unsigned long) s->control_pid);
1412 if (s->control_command_id >= 0)
1413 unit_serialize_item(u, f, "control-command", socket_exec_command_to_string(s->control_command_id));
1415 LIST_FOREACH(port, p, s->ports) {
1421 if ((copy = fdset_put_dup(fds, p->fd)) < 0)
1424 if (p->type == SOCKET_SOCKET) {
1427 if ((r = socket_address_print(&p->address, &t)) < 0)
1430 unit_serialize_item_format(u, f, "socket", "%i %i %s", copy, p->address.type, t);
1433 assert(p->type == SOCKET_FIFO);
1434 unit_serialize_item_format(u, f, "fifo", "%i %s", copy, p->path);
1441 static int socket_deserialize_item(Unit *u, const char *key, const char *value, FDSet *fds) {
1442 Socket *s = SOCKET(u);
1449 if (streq(key, "state")) {
1452 if ((state = socket_state_from_string(value)) < 0)
1453 log_debug("Failed to parse state value %s", value);
1455 s->deserialized_state = state;
1456 } else if (streq(key, "failure")) {
1459 if ((b = parse_boolean(value)) < 0)
1460 log_debug("Failed to parse failure value %s", value);
1462 s->failure = b || s->failure;
1464 } else if (streq(key, "n-accepted")) {
1467 if (safe_atou(value, &k) < 0)
1468 log_debug("Failed to parse n-accepted value %s", value);
1471 } else if (streq(key, "control-pid")) {
1474 if (parse_pid(value, &pid) < 0)
1475 log_debug("Failed to parse control-pid value %s", value);
1477 s->control_pid = pid;
1478 } else if (streq(key, "control-command")) {
1479 SocketExecCommand id;
1481 if ((id = socket_exec_command_from_string(value)) < 0)
1482 log_debug("Failed to parse exec-command value %s", value);
1484 s->control_command_id = id;
1485 s->control_command = s->exec_command[id];
1487 } else if (streq(key, "fifo")) {
1491 if (sscanf(value, "%i %n", &fd, &skip) < 1 || fd < 0 || !fdset_contains(fds, fd))
1492 log_debug("Failed to parse fifo value %s", value);
1495 LIST_FOREACH(port, p, s->ports)
1496 if (streq(p->path, value+skip))
1501 close_nointr_nofail(p->fd);
1502 p->fd = fdset_remove(fds, fd);
1506 } else if (streq(key, "socket")) {
1507 int fd, type, skip = 0;
1510 if (sscanf(value, "%i %i %n", &fd, &type, &skip) < 2 || fd < 0 || type < 0 || !fdset_contains(fds, fd))
1511 log_debug("Failed to parse socket value %s", value);
1514 LIST_FOREACH(port, p, s->ports)
1515 if (socket_address_is(&p->address, value+skip, type))
1520 close_nointr_nofail(p->fd);
1521 p->fd = fdset_remove(fds, fd);
1526 log_debug("Unknown serialization key '%s'", key);
1531 static UnitActiveState socket_active_state(Unit *u) {
1534 return state_translation_table[SOCKET(u)->state];
1537 static const char *socket_sub_state_to_string(Unit *u) {
1540 return socket_state_to_string(SOCKET(u)->state);
1543 static bool socket_check_gc(Unit *u) {
1544 Socket *s = SOCKET(u);
1548 return s->n_connections > 0;
1551 static void socket_fd_event(Unit *u, int fd, uint32_t events, Watch *w) {
1552 Socket *s = SOCKET(u);
1558 if (s->state != SOCKET_LISTENING)
1561 log_debug("Incoming traffic on %s", u->meta.id);
1563 if (events != EPOLLIN) {
1564 log_error("Got invalid poll event on socket.");
1568 if (w->socket_accept) {
1571 if ((cfd = accept4(fd, NULL, NULL, SOCK_NONBLOCK)) < 0) {
1576 log_error("Failed to accept socket: %m");
1583 socket_apply_socket_options(s, cfd);
1586 socket_enter_running(s, cfd);
1590 socket_enter_stop_pre(s, false);
1593 static void socket_sigchld_event(Unit *u, pid_t pid, int code, int status) {
1594 Socket *s = SOCKET(u);
1600 if (pid != s->control_pid)
1605 success = is_clean_exit(code, status);
1607 if (s->control_command) {
1608 exec_status_exit(&s->control_command->exec_status, pid, code, status, s->exec_context.utmp_id);
1610 if (s->control_command->ignore)
1614 log_full(success ? LOG_DEBUG : LOG_NOTICE,
1615 "%s control process exited, code=%s status=%i", u->meta.id, sigchld_code_to_string(code), status);
1616 s->failure = s->failure || !success;
1618 if (s->control_command && s->control_command->command_next && success) {
1619 log_debug("%s running next command for state %s", u->meta.id, socket_state_to_string(s->state));
1620 socket_run_next(s, success);
1622 s->control_command = NULL;
1623 s->control_command_id = _SOCKET_EXEC_COMMAND_INVALID;
1625 /* No further commands for this step, so let's figure
1626 * out what to do next */
1628 log_debug("%s got final SIGCHLD for state %s", u->meta.id, socket_state_to_string(s->state));
1632 case SOCKET_START_PRE:
1634 socket_enter_start_post(s);
1636 socket_enter_signal(s, SOCKET_FINAL_SIGTERM, false);
1639 case SOCKET_START_POST:
1641 socket_enter_listening(s);
1643 socket_enter_stop_pre(s, false);
1646 case SOCKET_STOP_PRE:
1647 case SOCKET_STOP_PRE_SIGTERM:
1648 case SOCKET_STOP_PRE_SIGKILL:
1649 socket_enter_stop_post(s, success);
1652 case SOCKET_STOP_POST:
1653 case SOCKET_FINAL_SIGTERM:
1654 case SOCKET_FINAL_SIGKILL:
1655 socket_enter_dead(s, success);
1659 assert_not_reached("Uh, control process died at wrong time.");
1663 /* Notify clients about changed exit status */
1664 unit_add_to_dbus_queue(u);
1667 static void socket_timer_event(Unit *u, uint64_t elapsed, Watch *w) {
1668 Socket *s = SOCKET(u);
1671 assert(elapsed == 1);
1672 assert(w == &s->timer_watch);
1676 case SOCKET_START_PRE:
1677 log_warning("%s starting timed out. Terminating.", u->meta.id);
1678 socket_enter_signal(s, SOCKET_FINAL_SIGTERM, false);
1680 case SOCKET_START_POST:
1681 log_warning("%s starting timed out. Stopping.", u->meta.id);
1682 socket_enter_stop_pre(s, false);
1685 case SOCKET_STOP_PRE:
1686 log_warning("%s stopping timed out. Terminating.", u->meta.id);
1687 socket_enter_signal(s, SOCKET_STOP_PRE_SIGTERM, false);
1690 case SOCKET_STOP_PRE_SIGTERM:
1691 log_warning("%s stopping timed out. Killing.", u->meta.id);
1692 socket_enter_signal(s, SOCKET_STOP_PRE_SIGKILL, false);
1695 case SOCKET_STOP_PRE_SIGKILL:
1696 log_warning("%s still around after SIGKILL. Ignoring.", u->meta.id);
1697 socket_enter_stop_post(s, false);
1700 case SOCKET_STOP_POST:
1701 log_warning("%s stopping timed out (2). Terminating.", u->meta.id);
1702 socket_enter_signal(s, SOCKET_FINAL_SIGTERM, false);
1705 case SOCKET_FINAL_SIGTERM:
1706 log_warning("%s stopping timed out (2). Killing.", u->meta.id);
1707 socket_enter_signal(s, SOCKET_FINAL_SIGKILL, false);
1710 case SOCKET_FINAL_SIGKILL:
1711 log_warning("%s still around after SIGKILL (2). Entering failed mode.", u->meta.id);
1712 socket_enter_dead(s, false);
1716 assert_not_reached("Timeout at wrong time.");
1720 int socket_collect_fds(Socket *s, int **fds, unsigned *n_fds) {
1729 /* Called from the service code for requesting our fds */
1732 LIST_FOREACH(port, p, s->ports)
1736 if (!(rfds = new(int, rn_fds)))
1740 LIST_FOREACH(port, p, s->ports)
1744 assert(k == rn_fds);
1752 void socket_notify_service_dead(Socket *s) {
1755 /* The service is dead. Dang!
1757 * This is strictly for one-instance-for-all-connections
1760 if (s->state == SOCKET_RUNNING) {
1761 log_debug("%s got notified about service death.", s->meta.id);
1762 socket_enter_listening(s);
1766 void socket_connection_unref(Socket *s) {
1769 /* The service is dead. Yay!
1771 * This is strictly for one-onstance-per-connection
1774 assert(s->n_connections > 0);
1777 log_debug("%s: One connection closed, %u left.", s->meta.id, s->n_connections);
1780 static void socket_reset_failed(Unit *u) {
1781 Socket *s = SOCKET(u);
1785 if (s->state == SOCKET_FAILED)
1786 socket_set_state(s, SOCKET_DEAD);
1791 static int socket_kill(Unit *u, KillWho who, KillMode mode, int signo, DBusError *error) {
1792 Socket *s = SOCKET(u);
1794 Set *pid_set = NULL;
1798 if (who == KILL_MAIN) {
1799 dbus_set_error(error, BUS_ERROR_NO_SUCH_PROCESS, "Socket units have no main processes");
1803 if (s->control_pid <= 0 && who == KILL_CONTROL) {
1804 dbus_set_error(error, BUS_ERROR_NO_SUCH_PROCESS, "No control process to kill");
1808 if (s->control_pid > 0)
1809 if (kill(mode == KILL_PROCESS_GROUP ? -s->control_pid : s->control_pid, signo) < 0)
1812 if (mode == KILL_CONTROL_GROUP) {
1815 if (!(pid_set = set_new(trivial_hash_func, trivial_compare_func)))
1818 /* Exclude the control pid from being killed via the cgroup */
1819 if (s->control_pid > 0)
1820 if ((q = set_put(pid_set, LONG_TO_PTR(s->control_pid))) < 0) {
1825 if ((q = cgroup_bonding_kill_list(s->meta.cgroup_bondings, signo, pid_set)) < 0)
1826 if (r != -EAGAIN && r != -ESRCH && r != -ENOENT)
1837 static const char* const socket_state_table[_SOCKET_STATE_MAX] = {
1838 [SOCKET_DEAD] = "dead",
1839 [SOCKET_START_PRE] = "start-pre",
1840 [SOCKET_START_POST] = "start-post",
1841 [SOCKET_LISTENING] = "listening",
1842 [SOCKET_RUNNING] = "running",
1843 [SOCKET_STOP_PRE] = "stop-pre",
1844 [SOCKET_STOP_PRE_SIGTERM] = "stop-pre-sigterm",
1845 [SOCKET_STOP_PRE_SIGKILL] = "stop-pre-sigkill",
1846 [SOCKET_STOP_POST] = "stop-post",
1847 [SOCKET_FINAL_SIGTERM] = "final-sigterm",
1848 [SOCKET_FINAL_SIGKILL] = "final-sigkill",
1849 [SOCKET_FAILED] = "failed"
1852 DEFINE_STRING_TABLE_LOOKUP(socket_state, SocketState);
1854 static const char* const socket_exec_command_table[_SOCKET_EXEC_COMMAND_MAX] = {
1855 [SOCKET_EXEC_START_PRE] = "StartPre",
1856 [SOCKET_EXEC_START_POST] = "StartPost",
1857 [SOCKET_EXEC_STOP_PRE] = "StopPre",
1858 [SOCKET_EXEC_STOP_POST] = "StopPost"
1861 DEFINE_STRING_TABLE_LOOKUP(socket_exec_command, SocketExecCommand);
1863 const UnitVTable socket_vtable = {
1864 .suffix = ".socket",
1866 .init = socket_init,
1867 .done = socket_done,
1868 .load = socket_load,
1870 .kill = socket_kill,
1872 .coldplug = socket_coldplug,
1874 .dump = socket_dump,
1876 .start = socket_start,
1877 .stop = socket_stop,
1879 .serialize = socket_serialize,
1880 .deserialize_item = socket_deserialize_item,
1882 .active_state = socket_active_state,
1883 .sub_state_to_string = socket_sub_state_to_string,
1885 .check_gc = socket_check_gc,
1887 .fd_event = socket_fd_event,
1888 .sigchld_event = socket_sigchld_event,
1889 .timer_event = socket_timer_event,
1891 .reset_failed = socket_reset_failed,
1893 .bus_interface = "org.freedesktop.systemd1.Socket",
1894 .bus_message_handler = bus_socket_message_handler,
1895 .bus_invalidating_properties = bus_socket_invalidating_properties