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->socket == s)
133 service->socket = NULL;
137 static int socket_instantiate_service(Socket *s) {
144 /* This fills in s->service if it isn't filled in yet. For
145 * Accept=yes sockets we create the next connection service
146 * here. For Accept=no this is mostly a NOP since the service
147 * is figured out at load time anyway. */
154 if (!(prefix = unit_name_to_prefix(s->meta.id)))
157 r = asprintf(&name, "%s@%u.service", prefix, s->n_accepted);
163 r = manager_load_unit(s->meta.manager, name, NULL, NULL, &u);
169 u->meta.no_gc = true;
170 s->service = SERVICE(u);
174 static bool have_non_accept_socket(Socket *s) {
182 LIST_FOREACH(port, p, s->ports) {
184 if (p->type != SOCKET_SOCKET)
187 if (!socket_address_can_accept(&p->address))
194 static int socket_verify(Socket *s) {
197 if (s->meta.load_state != UNIT_LOADED)
201 log_error("%s lacks Listen setting. Refusing.", s->meta.id);
205 if (s->accept && have_non_accept_socket(s)) {
206 log_error("%s configured for accepting sockets, but sockets are non-accepting. Refusing.", s->meta.id);
210 if (s->accept && s->max_connections <= 0) {
211 log_error("%s's MaxConnection setting too small. Refusing.", s->meta.id);
215 if (s->accept && s->service) {
216 log_error("Explicit service configuration for accepting sockets not supported on %s. Refusing.", s->meta.id);
220 if (s->exec_context.pam_name && s->exec_context.kill_mode != KILL_CONTROL_GROUP) {
221 log_error("%s has PAM enabled. Kill mode must be set to 'control-group'. Refusing.", s->meta.id);
228 static bool socket_needs_mount(Socket *s, const char *prefix) {
233 LIST_FOREACH(port, p, s->ports) {
235 if (p->type == SOCKET_SOCKET) {
236 if (socket_address_needs_mount(&p->address, prefix))
239 assert(p->type == SOCKET_FIFO);
240 if (path_startswith(p->path, prefix))
248 int socket_add_one_mount_link(Socket *s, Mount *m) {
254 if (s->meta.load_state != UNIT_LOADED ||
255 m->meta.load_state != UNIT_LOADED)
258 if (!socket_needs_mount(s, m->where))
261 if ((r = unit_add_two_dependencies(UNIT(s), UNIT_AFTER, UNIT_REQUIRES, UNIT(m), true)) < 0)
267 static int socket_add_mount_links(Socket *s) {
273 LIST_FOREACH(units_per_type, other, s->meta.manager->units_per_type[UNIT_MOUNT])
274 if ((r = socket_add_one_mount_link(s, (Mount*) other)) < 0)
280 static int socket_add_device_link(Socket *s) {
286 if (!s->bind_to_device)
289 if (asprintf(&t, "/sys/subsystem/net/devices/%s", s->bind_to_device) < 0)
292 r = unit_add_node_link(UNIT(s), t, false);
298 static int socket_add_default_dependencies(Socket *s) {
302 if (s->meta.manager->running_as == MANAGER_SYSTEM)
303 if ((r = unit_add_two_dependencies_by_name(UNIT(s), UNIT_AFTER, UNIT_REQUIRES, SPECIAL_SYSINIT_TARGET, NULL, true)) < 0)
306 return unit_add_two_dependencies_by_name(UNIT(s), UNIT_BEFORE, UNIT_CONFLICTED_BY, SPECIAL_SHUTDOWN_TARGET, NULL, true);
309 static int socket_load(Unit *u) {
310 Socket *s = SOCKET(u);
314 assert(u->meta.load_state == UNIT_STUB);
316 if ((r = unit_load_fragment_and_dropin(u)) < 0)
319 /* This is a new unit? Then let's add in some extras */
320 if (u->meta.load_state == UNIT_LOADED) {
322 if (have_non_accept_socket(s)) {
325 if ((r = unit_load_related_unit(u, ".service", (Unit**) &s->service)) < 0)
328 if ((r = unit_add_dependency(u, UNIT_BEFORE, UNIT(s->service), true)) < 0)
332 if ((r = socket_add_mount_links(s)) < 0)
335 if ((r = socket_add_device_link(s)) < 0)
338 if ((r = unit_add_exec_dependencies(u, &s->exec_context)) < 0)
341 if ((r = unit_add_default_cgroup(u)) < 0)
344 if (s->meta.default_dependencies)
345 if ((r = socket_add_default_dependencies(s)) < 0)
349 return socket_verify(s);
352 static const char* listen_lookup(int type) {
354 if (type == SOCK_STREAM)
355 return "ListenStream";
356 else if (type == SOCK_DGRAM)
357 return "ListenDatagram";
358 else if (type == SOCK_SEQPACKET)
359 return "ListenSequentialPacket";
361 assert_not_reached("Unknown socket type");
365 static void socket_dump(Unit *u, FILE *f, const char *prefix) {
368 Socket *s = SOCKET(u);
376 p2 = strappend(prefix, "\t");
377 prefix2 = p2 ? p2 : prefix;
380 "%sSocket State: %s\n"
381 "%sBindIPv6Only: %s\n"
383 "%sSocketMode: %04o\n"
384 "%sDirectoryMode: %04o\n"
387 "%sTCPCongestion: %s\n",
388 prefix, socket_state_to_string(s->state),
389 prefix, socket_address_bind_ipv6_only_to_string(s->bind_ipv6_only),
391 prefix, s->socket_mode,
392 prefix, s->directory_mode,
393 prefix, yes_no(s->keep_alive),
394 prefix, yes_no(s->free_bind),
395 prefix, strna(s->tcp_congestion));
397 if (s->control_pid > 0)
399 "%sControl PID: %lu\n",
400 prefix, (unsigned long) s->control_pid);
402 if (s->bind_to_device)
404 "%sBindToDevice: %s\n",
405 prefix, s->bind_to_device);
410 "%sNConnections: %u\n"
411 "%sMaxConnections: %u\n",
412 prefix, s->n_accepted,
413 prefix, s->n_connections,
414 prefix, s->max_connections);
416 if (s->priority >= 0)
419 prefix, s->priority);
421 if (s->receive_buffer > 0)
423 "%sReceiveBuffer: %zu\n",
424 prefix, s->receive_buffer);
426 if (s->send_buffer > 0)
428 "%sSendBuffer: %zu\n",
429 prefix, s->send_buffer);
441 if (s->pipe_size > 0)
444 prefix, s->pipe_size);
451 LIST_FOREACH(port, p, s->ports) {
453 if (p->type == SOCKET_SOCKET) {
458 if ((r = socket_address_print(&p->address, &k)) < 0)
463 fprintf(f, "%s%s: %s\n", prefix, listen_lookup(p->address.type), t);
466 fprintf(f, "%sListenFIFO: %s\n", prefix, p->path);
469 exec_context_dump(&s->exec_context, f, prefix);
471 for (c = 0; c < _SOCKET_EXEC_COMMAND_MAX; c++) {
472 if (!s->exec_command[c])
475 fprintf(f, "%s-> %s:\n",
476 prefix, socket_exec_command_to_string(c));
478 exec_command_dump_list(s->exec_command[c], f, prefix2);
484 static int instance_from_socket(int fd, unsigned nr, char **instance) {
489 struct sockaddr_un un;
490 struct sockaddr_in in;
491 struct sockaddr_in6 in6;
492 struct sockaddr_storage storage;
499 if (getsockname(fd, &local.sa, &l) < 0)
503 if (getpeername(fd, &remote.sa, &l) < 0)
506 switch (local.sa.sa_family) {
510 a = ntohl(local.in.sin_addr.s_addr),
511 b = ntohl(remote.in.sin_addr.s_addr);
514 "%u.%u.%u.%u:%u-%u.%u.%u.%u:%u",
515 a >> 24, (a >> 16) & 0xFF, (a >> 8) & 0xFF, a & 0xFF,
516 ntohs(local.in.sin_port),
517 b >> 24, (b >> 16) & 0xFF, (b >> 8) & 0xFF, b & 0xFF,
518 ntohs(remote.in.sin_port)) < 0)
525 static const char ipv4_prefix[] = {
526 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0xFF, 0xFF
529 if (memcmp(&local.in6.sin6_addr, ipv4_prefix, sizeof(ipv4_prefix)) == 0 &&
530 memcmp(&remote.in6.sin6_addr, ipv4_prefix, sizeof(ipv4_prefix)) == 0) {
532 *a = local.in6.sin6_addr.s6_addr+12,
533 *b = remote.in6.sin6_addr.s6_addr+12;
536 "%u.%u.%u.%u:%u-%u.%u.%u.%u:%u",
537 a[0], a[1], a[2], a[3],
538 ntohs(local.in6.sin6_port),
539 b[0], b[1], b[2], b[3],
540 ntohs(remote.in6.sin6_port)) < 0)
543 char a[INET6_ADDRSTRLEN], b[INET6_ADDRSTRLEN];
547 inet_ntop(AF_INET6, &local.in6.sin6_addr, a, sizeof(a)),
548 ntohs(local.in6.sin6_port),
549 inet_ntop(AF_INET6, &remote.in6.sin6_addr, b, sizeof(b)),
550 ntohs(remote.in6.sin6_port)) < 0)
561 if (getsockopt(fd, SOL_SOCKET, SO_PEERCRED, &ucred, &l) < 0)
567 (unsigned long) ucred.pid,
568 (unsigned long) ucred.uid) < 0)
575 assert_not_reached("Unhandled socket type.");
582 static void socket_close_fds(Socket *s) {
587 LIST_FOREACH(port, p, s->ports) {
591 unit_unwatch_fd(UNIT(s), &p->fd_watch);
592 close_nointr_nofail(p->fd);
594 /* One little note: we should never delete any sockets
595 * in the file system here! After all some other
596 * process we spawned might still have a reference of
597 * this fd and wants to continue to use it. Therefore
598 * we delete sockets in the file system before we
599 * create a new one, not after we stopped using
606 static void socket_apply_socket_options(Socket *s, int fd) {
611 int b = s->keep_alive;
612 if (setsockopt(fd, SOL_SOCKET, SO_KEEPALIVE, &b, sizeof(b)) < 0)
613 log_warning("SO_KEEPALIVE failed: %m");
616 if (s->priority >= 0)
617 if (setsockopt(fd, SOL_SOCKET, SO_PRIORITY, &s->priority, sizeof(s->priority)) < 0)
618 log_warning("SO_PRIORITY failed: %m");
620 if (s->receive_buffer > 0) {
621 int value = (int) s->receive_buffer;
622 if (setsockopt(fd, SOL_SOCKET, SO_RCVBUF, &value, sizeof(value)) < 0)
623 log_warning("SO_RCVBUF failed: %m");
626 if (s->send_buffer > 0) {
627 int value = (int) s->send_buffer;
628 if (setsockopt(fd, SOL_SOCKET, SO_SNDBUF, &value, sizeof(value)) < 0)
629 log_warning("SO_SNDBUF failed: %m");
633 if (setsockopt(fd, SOL_SOCKET, SO_MARK, &s->mark, sizeof(s->mark)) < 0)
634 log_warning("SO_MARK failed: %m");
637 if (setsockopt(fd, IPPROTO_IP, IP_TOS, &s->ip_tos, sizeof(s->ip_tos)) < 0)
638 log_warning("IP_TOS failed: %m");
640 if (s->ip_ttl >= 0) {
643 r = setsockopt(fd, IPPROTO_IP, IP_TTL, &s->ip_ttl, sizeof(s->ip_ttl));
645 if (socket_ipv6_is_supported())
646 x = setsockopt(fd, IPPROTO_IPV6, IPV6_UNICAST_HOPS, &s->ip_ttl, sizeof(s->ip_ttl));
649 errno = EAFNOSUPPORT;
653 log_warning("IP_TTL/IPV6_UNICAST_HOPS failed: %m");
656 if (s->tcp_congestion)
657 if (setsockopt(fd, SOL_TCP, TCP_CONGESTION, s->tcp_congestion, strlen(s->tcp_congestion)+1) < 0)
658 log_warning("TCP_CONGESTION failed: %m");
661 static void socket_apply_fifo_options(Socket *s, int fd) {
665 if (s->pipe_size > 0)
666 if (fcntl(fd, F_SETPIPE_SZ, s->pipe_size) < 0)
667 log_warning("F_SETPIPE_SZ: %m");
671 static int fifo_address_create(
673 mode_t directory_mode,
684 mkdir_parents(path, directory_mode);
686 if ((r = label_fifofile_set(path)) < 0)
689 /* Enforce the right access mode for the fifo */
690 old_mask = umask(~ socket_mode);
692 /* Include the original umask in our mask */
693 umask(~socket_mode | old_mask);
695 r = mkfifo(path, socket_mode);
703 if ((fd = open(path, O_RDWR|O_CLOEXEC|O_NOCTTY|O_NONBLOCK|O_NOFOLLOW)) < 0) {
710 if (fstat(fd, &st) < 0) {
715 if (!S_ISFIFO(st.st_mode) ||
716 (st.st_mode & 0777) != (socket_mode & ~old_mask) ||
717 st.st_uid != getuid() ||
718 st.st_gid != getgid()) {
731 close_nointr_nofail(fd);
736 static int socket_open_fds(Socket *s) {
740 bool know_label = false;
744 LIST_FOREACH(port, p, s->ports) {
749 if (p->type == SOCKET_SOCKET) {
753 if ((r = socket_instantiate_service(s)) < 0)
756 if ((r = label_get_socket_label_from_exe(s->service->exec_command[SERVICE_EXEC_START]->path, &label)) < 0)
762 if ((r = socket_address_listen(
774 socket_apply_socket_options(s, p->fd);
776 } else if (p->type == SOCKET_FIFO) {
778 if ((r = fifo_address_create(
785 socket_apply_fifo_options(s, p->fd);
788 assert_not_reached("Unknown port type");
800 static void socket_unwatch_fds(Socket *s) {
805 LIST_FOREACH(port, p, s->ports) {
809 unit_unwatch_fd(UNIT(s), &p->fd_watch);
813 static int socket_watch_fds(Socket *s) {
819 LIST_FOREACH(port, p, s->ports) {
823 p->fd_watch.socket_accept =
825 p->type == SOCKET_SOCKET &&
826 socket_address_can_accept(&p->address);
828 if ((r = unit_watch_fd(UNIT(s), p->fd, EPOLLIN, &p->fd_watch)) < 0)
835 socket_unwatch_fds(s);
839 static void socket_set_state(Socket *s, SocketState state) {
840 SocketState old_state;
843 old_state = s->state;
846 if (state != SOCKET_START_PRE &&
847 state != SOCKET_START_POST &&
848 state != SOCKET_STOP_PRE &&
849 state != SOCKET_STOP_PRE_SIGTERM &&
850 state != SOCKET_STOP_PRE_SIGKILL &&
851 state != SOCKET_STOP_POST &&
852 state != SOCKET_FINAL_SIGTERM &&
853 state != SOCKET_FINAL_SIGKILL) {
854 unit_unwatch_timer(UNIT(s), &s->timer_watch);
855 socket_unwatch_control_pid(s);
856 s->control_command = NULL;
857 s->control_command_id = _SOCKET_EXEC_COMMAND_INVALID;
860 if (state != SOCKET_LISTENING)
861 socket_unwatch_fds(s);
863 if (state != SOCKET_START_POST &&
864 state != SOCKET_LISTENING &&
865 state != SOCKET_RUNNING &&
866 state != SOCKET_STOP_PRE &&
867 state != SOCKET_STOP_PRE_SIGTERM &&
868 state != SOCKET_STOP_PRE_SIGKILL)
871 if (state != old_state)
872 log_debug("%s changed %s -> %s",
874 socket_state_to_string(old_state),
875 socket_state_to_string(state));
877 unit_notify(UNIT(s), state_translation_table[old_state], state_translation_table[state]);
880 static int socket_coldplug(Unit *u) {
881 Socket *s = SOCKET(u);
885 assert(s->state == SOCKET_DEAD);
887 if (s->deserialized_state != s->state) {
889 if (s->deserialized_state == SOCKET_START_PRE ||
890 s->deserialized_state == SOCKET_START_POST ||
891 s->deserialized_state == SOCKET_STOP_PRE ||
892 s->deserialized_state == SOCKET_STOP_PRE_SIGTERM ||
893 s->deserialized_state == SOCKET_STOP_PRE_SIGKILL ||
894 s->deserialized_state == SOCKET_STOP_POST ||
895 s->deserialized_state == SOCKET_FINAL_SIGTERM ||
896 s->deserialized_state == SOCKET_FINAL_SIGKILL) {
898 if (s->control_pid <= 0)
901 if ((r = unit_watch_pid(UNIT(s), s->control_pid)) < 0)
904 if ((r = unit_watch_timer(UNIT(s), s->timeout_usec, &s->timer_watch)) < 0)
908 if (s->deserialized_state == SOCKET_START_POST ||
909 s->deserialized_state == SOCKET_LISTENING ||
910 s->deserialized_state == SOCKET_RUNNING ||
911 s->deserialized_state == SOCKET_STOP_PRE ||
912 s->deserialized_state == SOCKET_STOP_PRE_SIGTERM ||
913 s->deserialized_state == SOCKET_STOP_PRE_SIGKILL)
914 if ((r = socket_open_fds(s)) < 0)
917 if (s->deserialized_state == SOCKET_LISTENING)
918 if ((r = socket_watch_fds(s)) < 0)
921 socket_set_state(s, s->deserialized_state);
927 static int socket_spawn(Socket *s, ExecCommand *c, pid_t *_pid) {
936 if ((r = unit_watch_timer(UNIT(s), s->timeout_usec, &s->timer_watch)) < 0)
939 if (!(argv = unit_full_printf_strv(UNIT(s), c->argv))) {
948 s->meta.manager->environment,
952 s->meta.manager->confirm_spawn,
953 s->meta.cgroup_bondings,
960 if ((r = unit_watch_pid(UNIT(s), pid)) < 0)
961 /* FIXME: we need to do something here */
969 unit_unwatch_timer(UNIT(s), &s->timer_watch);
974 static void socket_enter_dead(Socket *s, bool success) {
980 socket_set_state(s, s->failure ? SOCKET_FAILED : SOCKET_DEAD);
983 static void socket_enter_signal(Socket *s, SocketState state, bool success);
985 static void socket_enter_stop_post(Socket *s, bool success) {
992 socket_unwatch_control_pid(s);
994 s->control_command_id = SOCKET_EXEC_STOP_POST;
996 if ((s->control_command = s->exec_command[SOCKET_EXEC_STOP_POST])) {
997 if ((r = socket_spawn(s, s->control_command, &s->control_pid)) < 0)
1000 socket_set_state(s, SOCKET_STOP_POST);
1002 socket_enter_signal(s, SOCKET_FINAL_SIGTERM, true);
1007 log_warning("%s failed to run 'stop-post' task: %s", s->meta.id, strerror(-r));
1008 socket_enter_signal(s, SOCKET_FINAL_SIGTERM, false);
1011 static void socket_enter_signal(Socket *s, SocketState state, bool success) {
1013 Set *pid_set = NULL;
1014 bool wait_for_exit = false;
1021 if (s->exec_context.kill_mode != KILL_NONE) {
1022 int sig = (state == SOCKET_STOP_PRE_SIGTERM || state == SOCKET_FINAL_SIGTERM) ? s->exec_context.kill_signal : SIGKILL;
1024 if (s->control_pid > 0) {
1025 if (kill(s->exec_context.kill_mode == KILL_PROCESS_GROUP ?
1027 s->control_pid, sig) < 0 && errno != ESRCH)
1029 log_warning("Failed to kill control process %li: %m", (long) s->control_pid);
1031 wait_for_exit = true;
1034 if (s->exec_context.kill_mode == KILL_CONTROL_GROUP) {
1036 if (!(pid_set = set_new(trivial_hash_func, trivial_compare_func))) {
1041 /* Exclude the control pid from being killed via the cgroup */
1042 if (s->control_pid > 0)
1043 if ((r = set_put(pid_set, LONG_TO_PTR(s->control_pid))) < 0)
1046 if ((r = cgroup_bonding_kill_list(s->meta.cgroup_bondings, sig, pid_set)) < 0) {
1047 if (r != -EAGAIN && r != -ESRCH && r != -ENOENT)
1048 log_warning("Failed to kill control group: %s", strerror(-r));
1050 wait_for_exit = true;
1056 if (wait_for_exit) {
1057 if ((r = unit_watch_timer(UNIT(s), s->timeout_usec, &s->timer_watch)) < 0)
1060 socket_set_state(s, state);
1061 } else if (state == SOCKET_STOP_PRE_SIGTERM || state == SOCKET_STOP_PRE_SIGKILL)
1062 socket_enter_stop_post(s, true);
1064 socket_enter_dead(s, true);
1069 log_warning("%s failed to kill processes: %s", s->meta.id, strerror(-r));
1071 if (state == SOCKET_STOP_PRE_SIGTERM || state == SOCKET_STOP_PRE_SIGKILL)
1072 socket_enter_stop_post(s, false);
1074 socket_enter_dead(s, false);
1080 static void socket_enter_stop_pre(Socket *s, bool success) {
1087 socket_unwatch_control_pid(s);
1089 s->control_command_id = SOCKET_EXEC_STOP_PRE;
1091 if ((s->control_command = s->exec_command[SOCKET_EXEC_STOP_PRE])) {
1092 if ((r = socket_spawn(s, s->control_command, &s->control_pid)) < 0)
1095 socket_set_state(s, SOCKET_STOP_PRE);
1097 socket_enter_stop_post(s, true);
1102 log_warning("%s failed to run 'stop-pre' task: %s", s->meta.id, strerror(-r));
1103 socket_enter_stop_post(s, false);
1106 static void socket_enter_listening(Socket *s) {
1110 if ((r = socket_watch_fds(s)) < 0) {
1111 log_warning("%s failed to watch sockets: %s", s->meta.id, strerror(-r));
1115 socket_set_state(s, SOCKET_LISTENING);
1119 socket_enter_stop_pre(s, false);
1122 static void socket_enter_start_post(Socket *s) {
1126 if ((r = socket_open_fds(s)) < 0) {
1127 log_warning("%s failed to listen on sockets: %s", s->meta.id, strerror(-r));
1131 socket_unwatch_control_pid(s);
1133 s->control_command_id = SOCKET_EXEC_START_POST;
1135 if ((s->control_command = s->exec_command[SOCKET_EXEC_START_POST])) {
1136 if ((r = socket_spawn(s, s->control_command, &s->control_pid)) < 0) {
1137 log_warning("%s failed to run 'start-post' task: %s", s->meta.id, strerror(-r));
1141 socket_set_state(s, SOCKET_START_POST);
1143 socket_enter_listening(s);
1148 socket_enter_stop_pre(s, false);
1151 static void socket_enter_start_pre(Socket *s) {
1155 socket_unwatch_control_pid(s);
1157 s->control_command_id = SOCKET_EXEC_START_PRE;
1159 if ((s->control_command = s->exec_command[SOCKET_EXEC_START_PRE])) {
1160 if ((r = socket_spawn(s, s->control_command, &s->control_pid)) < 0)
1163 socket_set_state(s, SOCKET_START_PRE);
1165 socket_enter_start_post(s);
1170 log_warning("%s failed to run 'start-pre' task: %s", s->meta.id, strerror(-r));
1171 socket_enter_dead(s, false);
1174 static void socket_enter_running(Socket *s, int cfd) {
1179 dbus_error_init(&error);
1181 /* We don't take connections anymore if we are supposed to
1182 * shut down anyway */
1183 if (unit_pending_inactive(UNIT(s))) {
1185 close_nointr_nofail(cfd);
1187 /* Flush all sockets by closing and reopening them */
1188 socket_close_fds(s);
1190 if ((r = socket_watch_fds(s)) < 0) {
1191 log_warning("%s failed to watch sockets: %s", s->meta.id, strerror(-r));
1192 socket_enter_stop_pre(s, false);
1200 if ((r = manager_add_job(s->meta.manager, JOB_START, UNIT(s->service), JOB_REPLACE, true, &error, NULL)) < 0)
1203 socket_set_state(s, SOCKET_RUNNING);
1205 char *prefix, *instance = NULL, *name;
1208 if (s->n_connections >= s->max_connections) {
1209 log_warning("Too many incoming connections (%u)", s->n_connections);
1210 close_nointr_nofail(cfd);
1214 if ((r = socket_instantiate_service(s)) < 0)
1217 if ((r = instance_from_socket(cfd, s->n_accepted, &instance)) < 0)
1220 if (!(prefix = unit_name_to_prefix(s->meta.id))) {
1226 name = unit_name_build(prefix, instance, ".service");
1235 if ((r = unit_add_name(UNIT(s->service), name)) < 0) {
1240 service = s->service;
1244 service->meta.no_gc = false;
1246 unit_choose_id(UNIT(service), name);
1249 if ((r = service_set_socket_fd(service, cfd, s)) < 0)
1253 s->n_connections ++;
1255 if ((r = manager_add_job(s->meta.manager, JOB_START, UNIT(service), JOB_REPLACE, true, &error, NULL)) < 0)
1258 /* Notify clients about changed counters */
1259 unit_add_to_dbus_queue(UNIT(s));
1265 log_warning("%s failed to queue socket startup job: %s", s->meta.id, bus_error(&error, r));
1266 socket_enter_stop_pre(s, false);
1269 close_nointr_nofail(cfd);
1271 dbus_error_free(&error);
1274 static void socket_run_next(Socket *s, bool success) {
1278 assert(s->control_command);
1279 assert(s->control_command->command_next);
1284 socket_unwatch_control_pid(s);
1286 s->control_command = s->control_command->command_next;
1288 if ((r = socket_spawn(s, s->control_command, &s->control_pid)) < 0)
1294 log_warning("%s failed to run next task: %s", s->meta.id, strerror(-r));
1296 if (s->state == SOCKET_START_POST)
1297 socket_enter_stop_pre(s, false);
1298 else if (s->state == SOCKET_STOP_POST)
1299 socket_enter_dead(s, false);
1301 socket_enter_signal(s, SOCKET_FINAL_SIGTERM, false);
1304 static int socket_start(Unit *u) {
1305 Socket *s = SOCKET(u);
1309 /* We cannot fulfill this request right now, try again later
1311 if (s->state == SOCKET_STOP_PRE ||
1312 s->state == SOCKET_STOP_PRE_SIGKILL ||
1313 s->state == SOCKET_STOP_PRE_SIGTERM ||
1314 s->state == SOCKET_STOP_POST ||
1315 s->state == SOCKET_FINAL_SIGTERM ||
1316 s->state == SOCKET_FINAL_SIGKILL)
1319 if (s->state == SOCKET_START_PRE ||
1320 s->state == SOCKET_START_POST)
1323 /* Cannot run this without the service being around */
1325 if (s->service->meta.load_state != UNIT_LOADED)
1328 /* If the service is alredy actvie we cannot start the
1330 if (s->service->state != SERVICE_DEAD &&
1331 s->service->state != SERVICE_FAILED &&
1332 s->service->state != SERVICE_AUTO_RESTART)
1336 assert(s->state == SOCKET_DEAD || s->state == SOCKET_FAILED);
1339 socket_enter_start_pre(s);
1343 static int socket_stop(Unit *u) {
1344 Socket *s = SOCKET(u);
1349 if (s->state == SOCKET_STOP_PRE ||
1350 s->state == SOCKET_STOP_PRE_SIGTERM ||
1351 s->state == SOCKET_STOP_PRE_SIGKILL ||
1352 s->state == SOCKET_STOP_POST ||
1353 s->state == SOCKET_FINAL_SIGTERM ||
1354 s->state == SOCKET_FINAL_SIGKILL)
1357 /* If there's already something running we go directly into
1359 if (s->state == SOCKET_START_PRE ||
1360 s->state == SOCKET_START_POST) {
1361 socket_enter_signal(s, SOCKET_STOP_PRE_SIGTERM, true);
1365 assert(s->state == SOCKET_LISTENING || s->state == SOCKET_RUNNING);
1367 socket_enter_stop_pre(s, true);
1371 static int socket_serialize(Unit *u, FILE *f, FDSet *fds) {
1372 Socket *s = SOCKET(u);
1380 unit_serialize_item(u, f, "state", socket_state_to_string(s->state));
1381 unit_serialize_item(u, f, "failure", yes_no(s->failure));
1382 unit_serialize_item_format(u, f, "n-accepted", "%u", s->n_accepted);
1384 if (s->control_pid > 0)
1385 unit_serialize_item_format(u, f, "control-pid", "%lu", (unsigned long) s->control_pid);
1387 if (s->control_command_id >= 0)
1388 unit_serialize_item(u, f, "control-command", socket_exec_command_to_string(s->control_command_id));
1390 LIST_FOREACH(port, p, s->ports) {
1396 if ((copy = fdset_put_dup(fds, p->fd)) < 0)
1399 if (p->type == SOCKET_SOCKET) {
1402 if ((r = socket_address_print(&p->address, &t)) < 0)
1405 unit_serialize_item_format(u, f, "socket", "%i %i %s", copy, p->address.type, t);
1408 assert(p->type == SOCKET_FIFO);
1409 unit_serialize_item_format(u, f, "fifo", "%i %s", copy, p->path);
1416 static int socket_deserialize_item(Unit *u, const char *key, const char *value, FDSet *fds) {
1417 Socket *s = SOCKET(u);
1424 if (streq(key, "state")) {
1427 if ((state = socket_state_from_string(value)) < 0)
1428 log_debug("Failed to parse state value %s", value);
1430 s->deserialized_state = state;
1431 } else if (streq(key, "failure")) {
1434 if ((b = parse_boolean(value)) < 0)
1435 log_debug("Failed to parse failure value %s", value);
1437 s->failure = b || s->failure;
1439 } else if (streq(key, "n-accepted")) {
1442 if (safe_atou(value, &k) < 0)
1443 log_debug("Failed to parse n-accepted value %s", value);
1446 } else if (streq(key, "control-pid")) {
1449 if (parse_pid(value, &pid) < 0)
1450 log_debug("Failed to parse control-pid value %s", value);
1452 s->control_pid = pid;
1453 } else if (streq(key, "control-command")) {
1454 SocketExecCommand id;
1456 if ((id = socket_exec_command_from_string(value)) < 0)
1457 log_debug("Failed to parse exec-command value %s", value);
1459 s->control_command_id = id;
1460 s->control_command = s->exec_command[id];
1462 } else if (streq(key, "fifo")) {
1466 if (sscanf(value, "%i %n", &fd, &skip) < 1 || fd < 0 || !fdset_contains(fds, fd))
1467 log_debug("Failed to parse fifo value %s", value);
1470 LIST_FOREACH(port, p, s->ports)
1471 if (streq(p->path, value+skip))
1476 close_nointr_nofail(p->fd);
1477 p->fd = fdset_remove(fds, fd);
1481 } else if (streq(key, "socket")) {
1482 int fd, type, skip = 0;
1485 if (sscanf(value, "%i %i %n", &fd, &type, &skip) < 2 || fd < 0 || type < 0 || !fdset_contains(fds, fd))
1486 log_debug("Failed to parse socket value %s", value);
1489 LIST_FOREACH(port, p, s->ports)
1490 if (socket_address_is(&p->address, value+skip, type))
1495 close_nointr_nofail(p->fd);
1496 p->fd = fdset_remove(fds, fd);
1501 log_debug("Unknown serialization key '%s'", key);
1506 static UnitActiveState socket_active_state(Unit *u) {
1509 return state_translation_table[SOCKET(u)->state];
1512 static const char *socket_sub_state_to_string(Unit *u) {
1515 return socket_state_to_string(SOCKET(u)->state);
1518 static bool socket_check_gc(Unit *u) {
1519 Socket *s = SOCKET(u);
1523 return s->n_connections > 0;
1526 static void socket_fd_event(Unit *u, int fd, uint32_t events, Watch *w) {
1527 Socket *s = SOCKET(u);
1533 if (s->state != SOCKET_LISTENING)
1536 log_debug("Incoming traffic on %s", u->meta.id);
1538 if (events != EPOLLIN) {
1539 log_error("Got invalid poll event on socket.");
1543 if (w->socket_accept) {
1546 if ((cfd = accept4(fd, NULL, NULL, SOCK_NONBLOCK)) < 0) {
1551 log_error("Failed to accept socket: %m");
1558 socket_apply_socket_options(s, cfd);
1561 socket_enter_running(s, cfd);
1565 socket_enter_stop_pre(s, false);
1568 static void socket_sigchld_event(Unit *u, pid_t pid, int code, int status) {
1569 Socket *s = SOCKET(u);
1575 if (pid != s->control_pid)
1580 success = is_clean_exit(code, status);
1582 if (s->control_command) {
1583 exec_status_exit(&s->control_command->exec_status, pid, code, status);
1585 if (s->control_command->ignore)
1589 log_full(success ? LOG_DEBUG : LOG_NOTICE,
1590 "%s control process exited, code=%s status=%i", u->meta.id, sigchld_code_to_string(code), status);
1591 s->failure = s->failure || !success;
1593 if (s->control_command && s->control_command->command_next && success) {
1594 log_debug("%s running next command for state %s", u->meta.id, socket_state_to_string(s->state));
1595 socket_run_next(s, success);
1597 s->control_command = NULL;
1598 s->control_command_id = _SOCKET_EXEC_COMMAND_INVALID;
1600 /* No further commands for this step, so let's figure
1601 * out what to do next */
1603 log_debug("%s got final SIGCHLD for state %s", u->meta.id, socket_state_to_string(s->state));
1607 case SOCKET_START_PRE:
1609 socket_enter_start_post(s);
1611 socket_enter_signal(s, SOCKET_FINAL_SIGTERM, false);
1614 case SOCKET_START_POST:
1616 socket_enter_listening(s);
1618 socket_enter_stop_pre(s, false);
1621 case SOCKET_STOP_PRE:
1622 case SOCKET_STOP_PRE_SIGTERM:
1623 case SOCKET_STOP_PRE_SIGKILL:
1624 socket_enter_stop_post(s, success);
1627 case SOCKET_STOP_POST:
1628 case SOCKET_FINAL_SIGTERM:
1629 case SOCKET_FINAL_SIGKILL:
1630 socket_enter_dead(s, success);
1634 assert_not_reached("Uh, control process died at wrong time.");
1638 /* Notify clients about changed exit status */
1639 unit_add_to_dbus_queue(u);
1642 static void socket_timer_event(Unit *u, uint64_t elapsed, Watch *w) {
1643 Socket *s = SOCKET(u);
1646 assert(elapsed == 1);
1647 assert(w == &s->timer_watch);
1651 case SOCKET_START_PRE:
1652 log_warning("%s starting timed out. Terminating.", u->meta.id);
1653 socket_enter_signal(s, SOCKET_FINAL_SIGTERM, false);
1655 case SOCKET_START_POST:
1656 log_warning("%s starting timed out. Stopping.", u->meta.id);
1657 socket_enter_stop_pre(s, false);
1660 case SOCKET_STOP_PRE:
1661 log_warning("%s stopping timed out. Terminating.", u->meta.id);
1662 socket_enter_signal(s, SOCKET_STOP_PRE_SIGTERM, false);
1665 case SOCKET_STOP_PRE_SIGTERM:
1666 log_warning("%s stopping timed out. Killing.", u->meta.id);
1667 socket_enter_signal(s, SOCKET_STOP_PRE_SIGKILL, false);
1670 case SOCKET_STOP_PRE_SIGKILL:
1671 log_warning("%s still around after SIGKILL. Ignoring.", u->meta.id);
1672 socket_enter_stop_post(s, false);
1675 case SOCKET_STOP_POST:
1676 log_warning("%s stopping timed out (2). Terminating.", u->meta.id);
1677 socket_enter_signal(s, SOCKET_FINAL_SIGTERM, false);
1680 case SOCKET_FINAL_SIGTERM:
1681 log_warning("%s stopping timed out (2). Killing.", u->meta.id);
1682 socket_enter_signal(s, SOCKET_FINAL_SIGKILL, false);
1685 case SOCKET_FINAL_SIGKILL:
1686 log_warning("%s still around after SIGKILL (2). Entering failed mode.", u->meta.id);
1687 socket_enter_dead(s, false);
1691 assert_not_reached("Timeout at wrong time.");
1695 int socket_collect_fds(Socket *s, int **fds, unsigned *n_fds) {
1704 /* Called from the service code for requesting our fds */
1707 LIST_FOREACH(port, p, s->ports)
1711 if (!(rfds = new(int, rn_fds)))
1715 LIST_FOREACH(port, p, s->ports)
1719 assert(k == rn_fds);
1727 void socket_notify_service_dead(Socket *s) {
1730 /* The service is dead. Dang!
1732 * This is strictly for one-instance-for-all-connections
1735 if (s->state == SOCKET_RUNNING) {
1736 log_debug("%s got notified about service death.", s->meta.id);
1737 socket_enter_listening(s);
1741 void socket_connection_unref(Socket *s) {
1744 /* The service is dead. Yay!
1746 * This is strictly for one-onstance-per-connection
1749 assert(s->n_connections > 0);
1752 log_debug("%s: One connection closed, %u left.", s->meta.id, s->n_connections);
1755 static void socket_reset_failed(Unit *u) {
1756 Socket *s = SOCKET(u);
1760 if (s->state == SOCKET_FAILED)
1761 socket_set_state(s, SOCKET_DEAD);
1766 static const char* const socket_state_table[_SOCKET_STATE_MAX] = {
1767 [SOCKET_DEAD] = "dead",
1768 [SOCKET_START_PRE] = "start-pre",
1769 [SOCKET_START_POST] = "start-post",
1770 [SOCKET_LISTENING] = "listening",
1771 [SOCKET_RUNNING] = "running",
1772 [SOCKET_STOP_PRE] = "stop-pre",
1773 [SOCKET_STOP_PRE_SIGTERM] = "stop-pre-sigterm",
1774 [SOCKET_STOP_PRE_SIGKILL] = "stop-pre-sigkill",
1775 [SOCKET_STOP_POST] = "stop-post",
1776 [SOCKET_FINAL_SIGTERM] = "final-sigterm",
1777 [SOCKET_FINAL_SIGKILL] = "final-sigkill",
1778 [SOCKET_FAILED] = "failed"
1781 DEFINE_STRING_TABLE_LOOKUP(socket_state, SocketState);
1783 static const char* const socket_exec_command_table[_SOCKET_EXEC_COMMAND_MAX] = {
1784 [SOCKET_EXEC_START_PRE] = "StartPre",
1785 [SOCKET_EXEC_START_POST] = "StartPost",
1786 [SOCKET_EXEC_STOP_PRE] = "StopPre",
1787 [SOCKET_EXEC_STOP_POST] = "StopPost"
1790 DEFINE_STRING_TABLE_LOOKUP(socket_exec_command, SocketExecCommand);
1792 const UnitVTable socket_vtable = {
1793 .suffix = ".socket",
1795 .init = socket_init,
1796 .done = socket_done,
1797 .load = socket_load,
1799 .coldplug = socket_coldplug,
1801 .dump = socket_dump,
1803 .start = socket_start,
1804 .stop = socket_stop,
1806 .serialize = socket_serialize,
1807 .deserialize_item = socket_deserialize_item,
1809 .active_state = socket_active_state,
1810 .sub_state_to_string = socket_sub_state_to_string,
1812 .check_gc = socket_check_gc,
1814 .fd_event = socket_fd_event,
1815 .sigchld_event = socket_sigchld_event,
1816 .timer_event = socket_timer_event,
1818 .reset_failed = socket_reset_failed,
1820 .bus_interface = "org.freedesktop.systemd1.Socket",
1821 .bus_message_handler = bus_socket_message_handler,
1822 .bus_invalidating_properties = bus_socket_invalidating_properties