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);
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 type) {
371 if (type == SOCK_STREAM)
372 return "ListenStream";
373 else if (type == SOCK_DGRAM)
374 return "ListenDatagram";
375 else if (type == SOCK_SEQPACKET)
376 return "ListenSequentialPacket";
378 assert_not_reached("Unknown socket type");
382 static void socket_dump(Unit *u, FILE *f, const char *prefix) {
385 Socket *s = SOCKET(u);
393 p2 = strappend(prefix, "\t");
394 prefix2 = p2 ? p2 : prefix;
397 "%sSocket State: %s\n"
398 "%sBindIPv6Only: %s\n"
400 "%sSocketMode: %04o\n"
401 "%sDirectoryMode: %04o\n"
404 "%sTCPCongestion: %s\n",
405 prefix, socket_state_to_string(s->state),
406 prefix, socket_address_bind_ipv6_only_to_string(s->bind_ipv6_only),
408 prefix, s->socket_mode,
409 prefix, s->directory_mode,
410 prefix, yes_no(s->keep_alive),
411 prefix, yes_no(s->free_bind),
412 prefix, strna(s->tcp_congestion));
414 if (s->control_pid > 0)
416 "%sControl PID: %lu\n",
417 prefix, (unsigned long) s->control_pid);
419 if (s->bind_to_device)
421 "%sBindToDevice: %s\n",
422 prefix, s->bind_to_device);
427 "%sNConnections: %u\n"
428 "%sMaxConnections: %u\n",
429 prefix, s->n_accepted,
430 prefix, s->n_connections,
431 prefix, s->max_connections);
433 if (s->priority >= 0)
436 prefix, s->priority);
438 if (s->receive_buffer > 0)
440 "%sReceiveBuffer: %zu\n",
441 prefix, s->receive_buffer);
443 if (s->send_buffer > 0)
445 "%sSendBuffer: %zu\n",
446 prefix, s->send_buffer);
458 if (s->pipe_size > 0)
461 prefix, s->pipe_size);
468 LIST_FOREACH(port, p, s->ports) {
470 if (p->type == SOCKET_SOCKET) {
475 if ((r = socket_address_print(&p->address, &k)) < 0)
480 fprintf(f, "%s%s: %s\n", prefix, listen_lookup(p->address.type), t);
483 fprintf(f, "%sListenFIFO: %s\n", prefix, p->path);
486 exec_context_dump(&s->exec_context, f, prefix);
488 for (c = 0; c < _SOCKET_EXEC_COMMAND_MAX; c++) {
489 if (!s->exec_command[c])
492 fprintf(f, "%s-> %s:\n",
493 prefix, socket_exec_command_to_string(c));
495 exec_command_dump_list(s->exec_command[c], f, prefix2);
501 static int instance_from_socket(int fd, unsigned nr, char **instance) {
506 struct sockaddr_un un;
507 struct sockaddr_in in;
508 struct sockaddr_in6 in6;
509 struct sockaddr_storage storage;
516 if (getsockname(fd, &local.sa, &l) < 0)
520 if (getpeername(fd, &remote.sa, &l) < 0)
523 switch (local.sa.sa_family) {
527 a = ntohl(local.in.sin_addr.s_addr),
528 b = ntohl(remote.in.sin_addr.s_addr);
531 "%u.%u.%u.%u:%u-%u.%u.%u.%u:%u",
532 a >> 24, (a >> 16) & 0xFF, (a >> 8) & 0xFF, a & 0xFF,
533 ntohs(local.in.sin_port),
534 b >> 24, (b >> 16) & 0xFF, (b >> 8) & 0xFF, b & 0xFF,
535 ntohs(remote.in.sin_port)) < 0)
542 static const char ipv4_prefix[] = {
543 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0xFF, 0xFF
546 if (memcmp(&local.in6.sin6_addr, ipv4_prefix, sizeof(ipv4_prefix)) == 0 &&
547 memcmp(&remote.in6.sin6_addr, ipv4_prefix, sizeof(ipv4_prefix)) == 0) {
549 *a = local.in6.sin6_addr.s6_addr+12,
550 *b = remote.in6.sin6_addr.s6_addr+12;
553 "%u.%u.%u.%u:%u-%u.%u.%u.%u:%u",
554 a[0], a[1], a[2], a[3],
555 ntohs(local.in6.sin6_port),
556 b[0], b[1], b[2], b[3],
557 ntohs(remote.in6.sin6_port)) < 0)
560 char a[INET6_ADDRSTRLEN], b[INET6_ADDRSTRLEN];
564 inet_ntop(AF_INET6, &local.in6.sin6_addr, a, sizeof(a)),
565 ntohs(local.in6.sin6_port),
566 inet_ntop(AF_INET6, &remote.in6.sin6_addr, b, sizeof(b)),
567 ntohs(remote.in6.sin6_port)) < 0)
578 if (getsockopt(fd, SOL_SOCKET, SO_PEERCRED, &ucred, &l) < 0)
584 (unsigned long) ucred.pid,
585 (unsigned long) ucred.uid) < 0)
592 assert_not_reached("Unhandled socket type.");
599 static void socket_close_fds(Socket *s) {
604 LIST_FOREACH(port, p, s->ports) {
608 unit_unwatch_fd(UNIT(s), &p->fd_watch);
609 close_nointr_nofail(p->fd);
611 /* One little note: we should never delete any sockets
612 * in the file system here! After all some other
613 * process we spawned might still have a reference of
614 * this fd and wants to continue to use it. Therefore
615 * we delete sockets in the file system before we
616 * create a new one, not after we stopped using
623 static void socket_apply_socket_options(Socket *s, int fd) {
628 int b = s->keep_alive;
629 if (setsockopt(fd, SOL_SOCKET, SO_KEEPALIVE, &b, sizeof(b)) < 0)
630 log_warning("SO_KEEPALIVE failed: %m");
633 if (s->priority >= 0)
634 if (setsockopt(fd, SOL_SOCKET, SO_PRIORITY, &s->priority, sizeof(s->priority)) < 0)
635 log_warning("SO_PRIORITY failed: %m");
637 if (s->receive_buffer > 0) {
638 int value = (int) s->receive_buffer;
639 if (setsockopt(fd, SOL_SOCKET, SO_RCVBUF, &value, sizeof(value)) < 0)
640 log_warning("SO_RCVBUF failed: %m");
643 if (s->send_buffer > 0) {
644 int value = (int) s->send_buffer;
645 if (setsockopt(fd, SOL_SOCKET, SO_SNDBUF, &value, sizeof(value)) < 0)
646 log_warning("SO_SNDBUF failed: %m");
650 if (setsockopt(fd, SOL_SOCKET, SO_MARK, &s->mark, sizeof(s->mark)) < 0)
651 log_warning("SO_MARK failed: %m");
654 if (setsockopt(fd, IPPROTO_IP, IP_TOS, &s->ip_tos, sizeof(s->ip_tos)) < 0)
655 log_warning("IP_TOS failed: %m");
657 if (s->ip_ttl >= 0) {
660 r = setsockopt(fd, IPPROTO_IP, IP_TTL, &s->ip_ttl, sizeof(s->ip_ttl));
662 if (socket_ipv6_is_supported())
663 x = setsockopt(fd, IPPROTO_IPV6, IPV6_UNICAST_HOPS, &s->ip_ttl, sizeof(s->ip_ttl));
666 errno = EAFNOSUPPORT;
670 log_warning("IP_TTL/IPV6_UNICAST_HOPS failed: %m");
673 if (s->tcp_congestion)
674 if (setsockopt(fd, SOL_TCP, TCP_CONGESTION, s->tcp_congestion, strlen(s->tcp_congestion)+1) < 0)
675 log_warning("TCP_CONGESTION failed: %m");
678 static void socket_apply_fifo_options(Socket *s, int fd) {
682 if (s->pipe_size > 0)
683 if (fcntl(fd, F_SETPIPE_SZ, s->pipe_size) < 0)
684 log_warning("F_SETPIPE_SZ: %m");
688 static int fifo_address_create(
690 mode_t directory_mode,
701 mkdir_parents(path, directory_mode);
703 if ((r = label_fifofile_set(path)) < 0)
706 /* Enforce the right access mode for the fifo */
707 old_mask = umask(~ socket_mode);
709 /* Include the original umask in our mask */
710 umask(~socket_mode | old_mask);
712 r = mkfifo(path, socket_mode);
720 if ((fd = open(path, O_RDWR|O_CLOEXEC|O_NOCTTY|O_NONBLOCK|O_NOFOLLOW)) < 0) {
727 if (fstat(fd, &st) < 0) {
732 if (!S_ISFIFO(st.st_mode) ||
733 (st.st_mode & 0777) != (socket_mode & ~old_mask) ||
734 st.st_uid != getuid() ||
735 st.st_gid != getgid()) {
748 close_nointr_nofail(fd);
753 static int socket_open_fds(Socket *s) {
757 bool know_label = false;
761 LIST_FOREACH(port, p, s->ports) {
766 if (p->type == SOCKET_SOCKET) {
770 if ((r = socket_instantiate_service(s)) < 0)
773 if (s->service && s->service->exec_command[SERVICE_EXEC_START])
774 if ((r = label_get_socket_label_from_exe(s->service->exec_command[SERVICE_EXEC_START]->path, &label)) < 0)
780 if ((r = socket_address_listen(
792 socket_apply_socket_options(s, p->fd);
794 } else if (p->type == SOCKET_FIFO) {
796 if ((r = fifo_address_create(
803 socket_apply_fifo_options(s, p->fd);
806 assert_not_reached("Unknown port type");
818 static void socket_unwatch_fds(Socket *s) {
823 LIST_FOREACH(port, p, s->ports) {
827 unit_unwatch_fd(UNIT(s), &p->fd_watch);
831 static int socket_watch_fds(Socket *s) {
837 LIST_FOREACH(port, p, s->ports) {
841 p->fd_watch.socket_accept =
843 p->type == SOCKET_SOCKET &&
844 socket_address_can_accept(&p->address);
846 if ((r = unit_watch_fd(UNIT(s), p->fd, EPOLLIN, &p->fd_watch)) < 0)
853 socket_unwatch_fds(s);
857 static void socket_set_state(Socket *s, SocketState state) {
858 SocketState old_state;
861 old_state = s->state;
864 if (state != SOCKET_START_PRE &&
865 state != SOCKET_START_POST &&
866 state != SOCKET_STOP_PRE &&
867 state != SOCKET_STOP_PRE_SIGTERM &&
868 state != SOCKET_STOP_PRE_SIGKILL &&
869 state != SOCKET_STOP_POST &&
870 state != SOCKET_FINAL_SIGTERM &&
871 state != SOCKET_FINAL_SIGKILL) {
872 unit_unwatch_timer(UNIT(s), &s->timer_watch);
873 socket_unwatch_control_pid(s);
874 s->control_command = NULL;
875 s->control_command_id = _SOCKET_EXEC_COMMAND_INVALID;
878 if (state != SOCKET_LISTENING)
879 socket_unwatch_fds(s);
881 if (state != SOCKET_START_POST &&
882 state != SOCKET_LISTENING &&
883 state != SOCKET_RUNNING &&
884 state != SOCKET_STOP_PRE &&
885 state != SOCKET_STOP_PRE_SIGTERM &&
886 state != SOCKET_STOP_PRE_SIGKILL)
889 if (state != old_state)
890 log_debug("%s changed %s -> %s",
892 socket_state_to_string(old_state),
893 socket_state_to_string(state));
895 unit_notify(UNIT(s), state_translation_table[old_state], state_translation_table[state], true);
898 static int socket_coldplug(Unit *u) {
899 Socket *s = SOCKET(u);
903 assert(s->state == SOCKET_DEAD);
905 if (s->deserialized_state != s->state) {
907 if (s->deserialized_state == SOCKET_START_PRE ||
908 s->deserialized_state == SOCKET_START_POST ||
909 s->deserialized_state == SOCKET_STOP_PRE ||
910 s->deserialized_state == SOCKET_STOP_PRE_SIGTERM ||
911 s->deserialized_state == SOCKET_STOP_PRE_SIGKILL ||
912 s->deserialized_state == SOCKET_STOP_POST ||
913 s->deserialized_state == SOCKET_FINAL_SIGTERM ||
914 s->deserialized_state == SOCKET_FINAL_SIGKILL) {
916 if (s->control_pid <= 0)
919 if ((r = unit_watch_pid(UNIT(s), s->control_pid)) < 0)
922 if ((r = unit_watch_timer(UNIT(s), s->timeout_usec, &s->timer_watch)) < 0)
926 if (s->deserialized_state == SOCKET_START_POST ||
927 s->deserialized_state == SOCKET_LISTENING ||
928 s->deserialized_state == SOCKET_RUNNING ||
929 s->deserialized_state == SOCKET_STOP_PRE ||
930 s->deserialized_state == SOCKET_STOP_PRE_SIGTERM ||
931 s->deserialized_state == SOCKET_STOP_PRE_SIGKILL)
932 if ((r = socket_open_fds(s)) < 0)
935 if (s->deserialized_state == SOCKET_LISTENING)
936 if ((r = socket_watch_fds(s)) < 0)
939 socket_set_state(s, s->deserialized_state);
945 static int socket_spawn(Socket *s, ExecCommand *c, pid_t *_pid) {
954 if ((r = unit_watch_timer(UNIT(s), s->timeout_usec, &s->timer_watch)) < 0)
957 if (!(argv = unit_full_printf_strv(UNIT(s), c->argv))) {
966 s->meta.manager->environment,
970 s->meta.manager->confirm_spawn,
971 s->meta.cgroup_bondings,
978 if ((r = unit_watch_pid(UNIT(s), pid)) < 0)
979 /* FIXME: we need to do something here */
987 unit_unwatch_timer(UNIT(s), &s->timer_watch);
992 static void socket_enter_dead(Socket *s, bool success) {
998 socket_set_state(s, s->failure ? SOCKET_FAILED : SOCKET_DEAD);
1001 static void socket_enter_signal(Socket *s, SocketState state, bool success);
1003 static void socket_enter_stop_post(Socket *s, bool success) {
1010 socket_unwatch_control_pid(s);
1012 s->control_command_id = SOCKET_EXEC_STOP_POST;
1014 if ((s->control_command = s->exec_command[SOCKET_EXEC_STOP_POST])) {
1015 if ((r = socket_spawn(s, s->control_command, &s->control_pid)) < 0)
1018 socket_set_state(s, SOCKET_STOP_POST);
1020 socket_enter_signal(s, SOCKET_FINAL_SIGTERM, true);
1025 log_warning("%s failed to run 'stop-post' task: %s", s->meta.id, strerror(-r));
1026 socket_enter_signal(s, SOCKET_FINAL_SIGTERM, false);
1029 static void socket_enter_signal(Socket *s, SocketState state, bool success) {
1031 Set *pid_set = NULL;
1032 bool wait_for_exit = false;
1039 if (s->exec_context.kill_mode != KILL_NONE) {
1040 int sig = (state == SOCKET_STOP_PRE_SIGTERM || state == SOCKET_FINAL_SIGTERM) ? s->exec_context.kill_signal : SIGKILL;
1042 if (s->control_pid > 0) {
1043 if (kill_and_sigcont(s->control_pid, sig) < 0 && errno != ESRCH)
1045 log_warning("Failed to kill control process %li: %m", (long) s->control_pid);
1047 wait_for_exit = true;
1050 if (s->exec_context.kill_mode == KILL_CONTROL_GROUP) {
1052 if (!(pid_set = set_new(trivial_hash_func, trivial_compare_func))) {
1057 /* Exclude the control pid from being killed via the cgroup */
1058 if (s->control_pid > 0)
1059 if ((r = set_put(pid_set, LONG_TO_PTR(s->control_pid))) < 0)
1062 if ((r = cgroup_bonding_kill_list(s->meta.cgroup_bondings, sig, true, pid_set)) < 0) {
1063 if (r != -EAGAIN && r != -ESRCH && r != -ENOENT)
1064 log_warning("Failed to kill control group: %s", strerror(-r));
1066 wait_for_exit = true;
1073 if (wait_for_exit) {
1074 if ((r = unit_watch_timer(UNIT(s), s->timeout_usec, &s->timer_watch)) < 0)
1077 socket_set_state(s, state);
1078 } else if (state == SOCKET_STOP_PRE_SIGTERM || state == SOCKET_STOP_PRE_SIGKILL)
1079 socket_enter_stop_post(s, true);
1081 socket_enter_dead(s, true);
1086 log_warning("%s failed to kill processes: %s", s->meta.id, strerror(-r));
1088 if (state == SOCKET_STOP_PRE_SIGTERM || state == SOCKET_STOP_PRE_SIGKILL)
1089 socket_enter_stop_post(s, false);
1091 socket_enter_dead(s, false);
1097 static void socket_enter_stop_pre(Socket *s, bool success) {
1104 socket_unwatch_control_pid(s);
1106 s->control_command_id = SOCKET_EXEC_STOP_PRE;
1108 if ((s->control_command = s->exec_command[SOCKET_EXEC_STOP_PRE])) {
1109 if ((r = socket_spawn(s, s->control_command, &s->control_pid)) < 0)
1112 socket_set_state(s, SOCKET_STOP_PRE);
1114 socket_enter_stop_post(s, true);
1119 log_warning("%s failed to run 'stop-pre' task: %s", s->meta.id, strerror(-r));
1120 socket_enter_stop_post(s, false);
1123 static void socket_enter_listening(Socket *s) {
1127 if ((r = socket_watch_fds(s)) < 0) {
1128 log_warning("%s failed to watch sockets: %s", s->meta.id, strerror(-r));
1132 socket_set_state(s, SOCKET_LISTENING);
1136 socket_enter_stop_pre(s, false);
1139 static void socket_enter_start_post(Socket *s) {
1143 if ((r = socket_open_fds(s)) < 0) {
1144 log_warning("%s failed to listen on sockets: %s", s->meta.id, strerror(-r));
1148 socket_unwatch_control_pid(s);
1150 s->control_command_id = SOCKET_EXEC_START_POST;
1152 if ((s->control_command = s->exec_command[SOCKET_EXEC_START_POST])) {
1153 if ((r = socket_spawn(s, s->control_command, &s->control_pid)) < 0) {
1154 log_warning("%s failed to run 'start-post' task: %s", s->meta.id, strerror(-r));
1158 socket_set_state(s, SOCKET_START_POST);
1160 socket_enter_listening(s);
1165 socket_enter_stop_pre(s, false);
1168 static void socket_enter_start_pre(Socket *s) {
1172 socket_unwatch_control_pid(s);
1174 s->control_command_id = SOCKET_EXEC_START_PRE;
1176 if ((s->control_command = s->exec_command[SOCKET_EXEC_START_PRE])) {
1177 if ((r = socket_spawn(s, s->control_command, &s->control_pid)) < 0)
1180 socket_set_state(s, SOCKET_START_PRE);
1182 socket_enter_start_post(s);
1187 log_warning("%s failed to run 'start-pre' task: %s", s->meta.id, strerror(-r));
1188 socket_enter_dead(s, false);
1191 static void socket_enter_running(Socket *s, int cfd) {
1196 dbus_error_init(&error);
1198 /* We don't take connections anymore if we are supposed to
1199 * shut down anyway */
1200 if (unit_pending_inactive(UNIT(s))) {
1201 log_debug("Suppressing connection request on %s since unit stop is scheduled.", s->meta.id);
1204 close_nointr_nofail(cfd);
1206 /* Flush all sockets by closing and reopening them */
1207 socket_close_fds(s);
1209 if ((r = socket_watch_fds(s)) < 0) {
1210 log_warning("%s failed to watch sockets: %s", s->meta.id, strerror(-r));
1211 socket_enter_stop_pre(s, false);
1219 bool pending = false;
1222 /* If there's already a start pending don't bother to
1224 LIST_FOREACH(units_per_type, i, s->meta.manager->units_per_type[UNIT_SERVICE]) {
1225 Service *service = (Service *) i;
1227 if (!set_get(service->configured_sockets, s))
1230 if (!unit_pending_active(UNIT(service)))
1238 if ((r = manager_add_job(s->meta.manager, JOB_START, UNIT(s->service), JOB_REPLACE, true, &error, NULL)) < 0)
1241 socket_set_state(s, SOCKET_RUNNING);
1243 char *prefix, *instance = NULL, *name;
1246 if (s->n_connections >= s->max_connections) {
1247 log_warning("Too many incoming connections (%u)", s->n_connections);
1248 close_nointr_nofail(cfd);
1252 if ((r = socket_instantiate_service(s)) < 0)
1255 if ((r = instance_from_socket(cfd, s->n_accepted, &instance)) < 0)
1258 if (!(prefix = unit_name_to_prefix(s->meta.id))) {
1264 name = unit_name_build(prefix, instance, ".service");
1273 if ((r = unit_add_name(UNIT(s->service), name)) < 0) {
1278 service = s->service;
1282 service->meta.no_gc = false;
1284 unit_choose_id(UNIT(service), name);
1287 if ((r = service_set_socket_fd(service, cfd, s)) < 0)
1291 s->n_connections ++;
1293 if ((r = manager_add_job(s->meta.manager, JOB_START, UNIT(service), JOB_REPLACE, true, &error, NULL)) < 0)
1296 /* Notify clients about changed counters */
1297 unit_add_to_dbus_queue(UNIT(s));
1303 log_warning("%s failed to queue socket startup job: %s", s->meta.id, bus_error(&error, r));
1304 socket_enter_stop_pre(s, false);
1307 close_nointr_nofail(cfd);
1309 dbus_error_free(&error);
1312 static void socket_run_next(Socket *s, bool success) {
1316 assert(s->control_command);
1317 assert(s->control_command->command_next);
1322 socket_unwatch_control_pid(s);
1324 s->control_command = s->control_command->command_next;
1326 if ((r = socket_spawn(s, s->control_command, &s->control_pid)) < 0)
1332 log_warning("%s failed to run next task: %s", s->meta.id, strerror(-r));
1334 if (s->state == SOCKET_START_POST)
1335 socket_enter_stop_pre(s, false);
1336 else if (s->state == SOCKET_STOP_POST)
1337 socket_enter_dead(s, false);
1339 socket_enter_signal(s, SOCKET_FINAL_SIGTERM, false);
1342 static int socket_start(Unit *u) {
1343 Socket *s = SOCKET(u);
1347 /* We cannot fulfill this request right now, try again later
1349 if (s->state == SOCKET_STOP_PRE ||
1350 s->state == SOCKET_STOP_PRE_SIGKILL ||
1351 s->state == SOCKET_STOP_PRE_SIGTERM ||
1352 s->state == SOCKET_STOP_POST ||
1353 s->state == SOCKET_FINAL_SIGTERM ||
1354 s->state == SOCKET_FINAL_SIGKILL)
1357 if (s->state == SOCKET_START_PRE ||
1358 s->state == SOCKET_START_POST)
1361 /* Cannot run this without the service being around */
1363 if (s->service->meta.load_state != UNIT_LOADED)
1366 /* If the service is already active we cannot start the
1368 if (s->service->state != SERVICE_DEAD &&
1369 s->service->state != SERVICE_FAILED &&
1370 s->service->state != SERVICE_AUTO_RESTART)
1373 #ifdef HAVE_SYSV_COMPAT
1374 if (s->service->sysv_path) {
1375 log_error("Using SysV services for socket activation is not supported. Refusing.");
1381 assert(s->state == SOCKET_DEAD || s->state == SOCKET_FAILED);
1384 socket_enter_start_pre(s);
1388 static int socket_stop(Unit *u) {
1389 Socket *s = SOCKET(u);
1394 if (s->state == SOCKET_STOP_PRE ||
1395 s->state == SOCKET_STOP_PRE_SIGTERM ||
1396 s->state == SOCKET_STOP_PRE_SIGKILL ||
1397 s->state == SOCKET_STOP_POST ||
1398 s->state == SOCKET_FINAL_SIGTERM ||
1399 s->state == SOCKET_FINAL_SIGKILL)
1402 /* If there's already something running we go directly into
1404 if (s->state == SOCKET_START_PRE ||
1405 s->state == SOCKET_START_POST) {
1406 socket_enter_signal(s, SOCKET_STOP_PRE_SIGTERM, true);
1410 assert(s->state == SOCKET_LISTENING || s->state == SOCKET_RUNNING);
1412 socket_enter_stop_pre(s, true);
1416 static int socket_serialize(Unit *u, FILE *f, FDSet *fds) {
1417 Socket *s = SOCKET(u);
1425 unit_serialize_item(u, f, "state", socket_state_to_string(s->state));
1426 unit_serialize_item(u, f, "failure", yes_no(s->failure));
1427 unit_serialize_item_format(u, f, "n-accepted", "%u", s->n_accepted);
1429 if (s->control_pid > 0)
1430 unit_serialize_item_format(u, f, "control-pid", "%lu", (unsigned long) s->control_pid);
1432 if (s->control_command_id >= 0)
1433 unit_serialize_item(u, f, "control-command", socket_exec_command_to_string(s->control_command_id));
1435 LIST_FOREACH(port, p, s->ports) {
1441 if ((copy = fdset_put_dup(fds, p->fd)) < 0)
1444 if (p->type == SOCKET_SOCKET) {
1447 if ((r = socket_address_print(&p->address, &t)) < 0)
1450 unit_serialize_item_format(u, f, "socket", "%i %i %s", copy, p->address.type, t);
1453 assert(p->type == SOCKET_FIFO);
1454 unit_serialize_item_format(u, f, "fifo", "%i %s", copy, p->path);
1461 static int socket_deserialize_item(Unit *u, const char *key, const char *value, FDSet *fds) {
1462 Socket *s = SOCKET(u);
1469 if (streq(key, "state")) {
1472 if ((state = socket_state_from_string(value)) < 0)
1473 log_debug("Failed to parse state value %s", value);
1475 s->deserialized_state = state;
1476 } else if (streq(key, "failure")) {
1479 if ((b = parse_boolean(value)) < 0)
1480 log_debug("Failed to parse failure value %s", value);
1482 s->failure = b || s->failure;
1484 } else if (streq(key, "n-accepted")) {
1487 if (safe_atou(value, &k) < 0)
1488 log_debug("Failed to parse n-accepted value %s", value);
1491 } else if (streq(key, "control-pid")) {
1494 if (parse_pid(value, &pid) < 0)
1495 log_debug("Failed to parse control-pid value %s", value);
1497 s->control_pid = pid;
1498 } else if (streq(key, "control-command")) {
1499 SocketExecCommand id;
1501 if ((id = socket_exec_command_from_string(value)) < 0)
1502 log_debug("Failed to parse exec-command value %s", value);
1504 s->control_command_id = id;
1505 s->control_command = s->exec_command[id];
1507 } else if (streq(key, "fifo")) {
1511 if (sscanf(value, "%i %n", &fd, &skip) < 1 || fd < 0 || !fdset_contains(fds, fd))
1512 log_debug("Failed to parse fifo value %s", value);
1515 LIST_FOREACH(port, p, s->ports)
1516 if (streq(p->path, value+skip))
1521 close_nointr_nofail(p->fd);
1522 p->fd = fdset_remove(fds, fd);
1526 } else if (streq(key, "socket")) {
1527 int fd, type, skip = 0;
1530 if (sscanf(value, "%i %i %n", &fd, &type, &skip) < 2 || fd < 0 || type < 0 || !fdset_contains(fds, fd))
1531 log_debug("Failed to parse socket value %s", value);
1534 LIST_FOREACH(port, p, s->ports)
1535 if (socket_address_is(&p->address, value+skip, type))
1540 close_nointr_nofail(p->fd);
1541 p->fd = fdset_remove(fds, fd);
1546 log_debug("Unknown serialization key '%s'", key);
1551 static UnitActiveState socket_active_state(Unit *u) {
1554 return state_translation_table[SOCKET(u)->state];
1557 static const char *socket_sub_state_to_string(Unit *u) {
1560 return socket_state_to_string(SOCKET(u)->state);
1563 static bool socket_check_gc(Unit *u) {
1564 Socket *s = SOCKET(u);
1568 return s->n_connections > 0;
1571 static void socket_fd_event(Unit *u, int fd, uint32_t events, Watch *w) {
1572 Socket *s = SOCKET(u);
1578 if (s->state != SOCKET_LISTENING)
1581 log_debug("Incoming traffic on %s", u->meta.id);
1583 if (events != EPOLLIN) {
1584 log_error("Got invalid poll event on socket.");
1588 if (w->socket_accept) {
1591 if ((cfd = accept4(fd, NULL, NULL, SOCK_NONBLOCK)) < 0) {
1596 log_error("Failed to accept socket: %m");
1603 socket_apply_socket_options(s, cfd);
1606 socket_enter_running(s, cfd);
1610 socket_enter_stop_pre(s, false);
1613 static void socket_sigchld_event(Unit *u, pid_t pid, int code, int status) {
1614 Socket *s = SOCKET(u);
1620 if (pid != s->control_pid)
1625 success = is_clean_exit(code, status);
1627 if (s->control_command) {
1628 exec_status_exit(&s->control_command->exec_status, pid, code, status, s->exec_context.utmp_id);
1630 if (s->control_command->ignore)
1634 log_full(success ? LOG_DEBUG : LOG_NOTICE,
1635 "%s control process exited, code=%s status=%i", u->meta.id, sigchld_code_to_string(code), status);
1636 s->failure = s->failure || !success;
1638 if (s->control_command && s->control_command->command_next && success) {
1639 log_debug("%s running next command for state %s", u->meta.id, socket_state_to_string(s->state));
1640 socket_run_next(s, success);
1642 s->control_command = NULL;
1643 s->control_command_id = _SOCKET_EXEC_COMMAND_INVALID;
1645 /* No further commands for this step, so let's figure
1646 * out what to do next */
1648 log_debug("%s got final SIGCHLD for state %s", u->meta.id, socket_state_to_string(s->state));
1652 case SOCKET_START_PRE:
1654 socket_enter_start_post(s);
1656 socket_enter_signal(s, SOCKET_FINAL_SIGTERM, false);
1659 case SOCKET_START_POST:
1661 socket_enter_listening(s);
1663 socket_enter_stop_pre(s, false);
1666 case SOCKET_STOP_PRE:
1667 case SOCKET_STOP_PRE_SIGTERM:
1668 case SOCKET_STOP_PRE_SIGKILL:
1669 socket_enter_stop_post(s, success);
1672 case SOCKET_STOP_POST:
1673 case SOCKET_FINAL_SIGTERM:
1674 case SOCKET_FINAL_SIGKILL:
1675 socket_enter_dead(s, success);
1679 assert_not_reached("Uh, control process died at wrong time.");
1683 /* Notify clients about changed exit status */
1684 unit_add_to_dbus_queue(u);
1687 static void socket_timer_event(Unit *u, uint64_t elapsed, Watch *w) {
1688 Socket *s = SOCKET(u);
1691 assert(elapsed == 1);
1692 assert(w == &s->timer_watch);
1696 case SOCKET_START_PRE:
1697 log_warning("%s starting timed out. Terminating.", u->meta.id);
1698 socket_enter_signal(s, SOCKET_FINAL_SIGTERM, false);
1701 case SOCKET_START_POST:
1702 log_warning("%s starting timed out. Stopping.", u->meta.id);
1703 socket_enter_stop_pre(s, false);
1706 case SOCKET_STOP_PRE:
1707 log_warning("%s stopping timed out. Terminating.", u->meta.id);
1708 socket_enter_signal(s, SOCKET_STOP_PRE_SIGTERM, false);
1711 case SOCKET_STOP_PRE_SIGTERM:
1712 if (s->exec_context.send_sigkill) {
1713 log_warning("%s stopping timed out. Killing.", u->meta.id);
1714 socket_enter_signal(s, SOCKET_STOP_PRE_SIGKILL, false);
1716 log_warning("%s stopping timed out. Skipping SIGKILL. Ignoring.", u->meta.id);
1717 socket_enter_stop_post(s, false);
1721 case SOCKET_STOP_PRE_SIGKILL:
1722 log_warning("%s still around after SIGKILL. Ignoring.", u->meta.id);
1723 socket_enter_stop_post(s, false);
1726 case SOCKET_STOP_POST:
1727 log_warning("%s stopping timed out (2). Terminating.", u->meta.id);
1728 socket_enter_signal(s, SOCKET_FINAL_SIGTERM, false);
1731 case SOCKET_FINAL_SIGTERM:
1732 if (s->exec_context.send_sigkill) {
1733 log_warning("%s stopping timed out (2). Killing.", u->meta.id);
1734 socket_enter_signal(s, SOCKET_FINAL_SIGKILL, false);
1736 log_warning("%s stopping timed out (2). Skipping SIGKILL. Ignoring.", u->meta.id);
1737 socket_enter_dead(s, false);
1741 case SOCKET_FINAL_SIGKILL:
1742 log_warning("%s still around after SIGKILL (2). Entering failed mode.", u->meta.id);
1743 socket_enter_dead(s, false);
1747 assert_not_reached("Timeout at wrong time.");
1751 int socket_collect_fds(Socket *s, int **fds, unsigned *n_fds) {
1760 /* Called from the service code for requesting our fds */
1763 LIST_FOREACH(port, p, s->ports)
1767 if (!(rfds = new(int, rn_fds)))
1771 LIST_FOREACH(port, p, s->ports)
1775 assert(k == rn_fds);
1783 void socket_notify_service_dead(Socket *s) {
1786 /* The service is dead. Dang!
1788 * This is strictly for one-instance-for-all-connections
1791 if (s->state == SOCKET_RUNNING) {
1792 log_debug("%s got notified about service death.", s->meta.id);
1793 socket_enter_listening(s);
1797 void socket_connection_unref(Socket *s) {
1800 /* The service is dead. Yay!
1802 * This is strictly for one-instance-per-connection
1805 assert(s->n_connections > 0);
1808 log_debug("%s: One connection closed, %u left.", s->meta.id, s->n_connections);
1811 static void socket_reset_failed(Unit *u) {
1812 Socket *s = SOCKET(u);
1816 if (s->state == SOCKET_FAILED)
1817 socket_set_state(s, SOCKET_DEAD);
1822 static int socket_kill(Unit *u, KillWho who, KillMode mode, int signo, DBusError *error) {
1823 Socket *s = SOCKET(u);
1825 Set *pid_set = NULL;
1829 if (who == KILL_MAIN) {
1830 dbus_set_error(error, BUS_ERROR_NO_SUCH_PROCESS, "Socket units have no main processes");
1834 if (s->control_pid <= 0 && who == KILL_CONTROL) {
1835 dbus_set_error(error, BUS_ERROR_NO_SUCH_PROCESS, "No control process to kill");
1839 if (s->control_pid > 0)
1840 if (kill(s->control_pid, signo) < 0)
1843 if (mode == KILL_CONTROL_GROUP) {
1846 if (!(pid_set = set_new(trivial_hash_func, trivial_compare_func)))
1849 /* Exclude the control pid from being killed via the cgroup */
1850 if (s->control_pid > 0)
1851 if ((q = set_put(pid_set, LONG_TO_PTR(s->control_pid))) < 0) {
1856 if ((q = cgroup_bonding_kill_list(s->meta.cgroup_bondings, signo, false, pid_set)) < 0)
1857 if (r != -EAGAIN && r != -ESRCH && r != -ENOENT)
1868 static const char* const socket_state_table[_SOCKET_STATE_MAX] = {
1869 [SOCKET_DEAD] = "dead",
1870 [SOCKET_START_PRE] = "start-pre",
1871 [SOCKET_START_POST] = "start-post",
1872 [SOCKET_LISTENING] = "listening",
1873 [SOCKET_RUNNING] = "running",
1874 [SOCKET_STOP_PRE] = "stop-pre",
1875 [SOCKET_STOP_PRE_SIGTERM] = "stop-pre-sigterm",
1876 [SOCKET_STOP_PRE_SIGKILL] = "stop-pre-sigkill",
1877 [SOCKET_STOP_POST] = "stop-post",
1878 [SOCKET_FINAL_SIGTERM] = "final-sigterm",
1879 [SOCKET_FINAL_SIGKILL] = "final-sigkill",
1880 [SOCKET_FAILED] = "failed"
1883 DEFINE_STRING_TABLE_LOOKUP(socket_state, SocketState);
1885 static const char* const socket_exec_command_table[_SOCKET_EXEC_COMMAND_MAX] = {
1886 [SOCKET_EXEC_START_PRE] = "StartPre",
1887 [SOCKET_EXEC_START_POST] = "StartPost",
1888 [SOCKET_EXEC_STOP_PRE] = "StopPre",
1889 [SOCKET_EXEC_STOP_POST] = "StopPost"
1892 DEFINE_STRING_TABLE_LOOKUP(socket_exec_command, SocketExecCommand);
1894 const UnitVTable socket_vtable = {
1895 .suffix = ".socket",
1897 .init = socket_init,
1898 .done = socket_done,
1899 .load = socket_load,
1901 .kill = socket_kill,
1903 .coldplug = socket_coldplug,
1905 .dump = socket_dump,
1907 .start = socket_start,
1908 .stop = socket_stop,
1910 .serialize = socket_serialize,
1911 .deserialize_item = socket_deserialize_item,
1913 .active_state = socket_active_state,
1914 .sub_state_to_string = socket_sub_state_to_string,
1916 .check_gc = socket_check_gc,
1918 .fd_event = socket_fd_event,
1919 .sigchld_event = socket_sigchld_event,
1920 .timer_event = socket_timer_event,
1922 .reset_failed = socket_reset_failed,
1924 .bus_interface = "org.freedesktop.systemd1.Socket",
1925 .bus_message_handler = bus_socket_message_handler,
1926 .bus_invalidating_properties = bus_socket_invalidating_properties