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_two_dependencies_by_name(UNIT(s), UNIT_AFTER, UNIT_REQUIRES, SPECIAL_SYSINIT_TARGET, NULL, true)) < 0)
308 return unit_add_two_dependencies_by_name(UNIT(s), UNIT_BEFORE, UNIT_CONFLICTED_BY, SPECIAL_SHUTDOWN_TARGET, NULL, true);
311 static int socket_load(Unit *u) {
312 Socket *s = SOCKET(u);
316 assert(u->meta.load_state == UNIT_STUB);
318 if ((r = unit_load_fragment_and_dropin(u)) < 0)
321 /* This is a new unit? Then let's add in some extras */
322 if (u->meta.load_state == UNIT_LOADED) {
324 if (have_non_accept_socket(s)) {
327 if ((r = unit_load_related_unit(u, ".service", (Unit**) &s->service)) < 0)
330 if ((r = unit_add_dependency(u, UNIT_BEFORE, UNIT(s->service), true)) < 0)
334 if ((r = socket_add_mount_links(s)) < 0)
337 if ((r = socket_add_device_link(s)) < 0)
340 if ((r = unit_add_exec_dependencies(u, &s->exec_context)) < 0)
343 if ((r = unit_add_default_cgroup(u)) < 0)
346 if (s->meta.default_dependencies)
347 if ((r = socket_add_default_dependencies(s)) < 0)
351 return socket_verify(s);
354 static const char* listen_lookup(int type) {
356 if (type == SOCK_STREAM)
357 return "ListenStream";
358 else if (type == SOCK_DGRAM)
359 return "ListenDatagram";
360 else if (type == SOCK_SEQPACKET)
361 return "ListenSequentialPacket";
363 assert_not_reached("Unknown socket type");
367 static void socket_dump(Unit *u, FILE *f, const char *prefix) {
370 Socket *s = SOCKET(u);
378 p2 = strappend(prefix, "\t");
379 prefix2 = p2 ? p2 : prefix;
382 "%sSocket State: %s\n"
383 "%sBindIPv6Only: %s\n"
385 "%sSocketMode: %04o\n"
386 "%sDirectoryMode: %04o\n"
389 "%sTCPCongestion: %s\n",
390 prefix, socket_state_to_string(s->state),
391 prefix, socket_address_bind_ipv6_only_to_string(s->bind_ipv6_only),
393 prefix, s->socket_mode,
394 prefix, s->directory_mode,
395 prefix, yes_no(s->keep_alive),
396 prefix, yes_no(s->free_bind),
397 prefix, strna(s->tcp_congestion));
399 if (s->control_pid > 0)
401 "%sControl PID: %lu\n",
402 prefix, (unsigned long) s->control_pid);
404 if (s->bind_to_device)
406 "%sBindToDevice: %s\n",
407 prefix, s->bind_to_device);
412 "%sNConnections: %u\n"
413 "%sMaxConnections: %u\n",
414 prefix, s->n_accepted,
415 prefix, s->n_connections,
416 prefix, s->max_connections);
418 if (s->priority >= 0)
421 prefix, s->priority);
423 if (s->receive_buffer > 0)
425 "%sReceiveBuffer: %zu\n",
426 prefix, s->receive_buffer);
428 if (s->send_buffer > 0)
430 "%sSendBuffer: %zu\n",
431 prefix, s->send_buffer);
443 if (s->pipe_size > 0)
446 prefix, s->pipe_size);
453 LIST_FOREACH(port, p, s->ports) {
455 if (p->type == SOCKET_SOCKET) {
460 if ((r = socket_address_print(&p->address, &k)) < 0)
465 fprintf(f, "%s%s: %s\n", prefix, listen_lookup(p->address.type), t);
468 fprintf(f, "%sListenFIFO: %s\n", prefix, p->path);
471 exec_context_dump(&s->exec_context, f, prefix);
473 for (c = 0; c < _SOCKET_EXEC_COMMAND_MAX; c++) {
474 if (!s->exec_command[c])
477 fprintf(f, "%s-> %s:\n",
478 prefix, socket_exec_command_to_string(c));
480 exec_command_dump_list(s->exec_command[c], f, prefix2);
486 static int instance_from_socket(int fd, unsigned nr, char **instance) {
491 struct sockaddr_un un;
492 struct sockaddr_in in;
493 struct sockaddr_in6 in6;
494 struct sockaddr_storage storage;
501 if (getsockname(fd, &local.sa, &l) < 0)
505 if (getpeername(fd, &remote.sa, &l) < 0)
508 switch (local.sa.sa_family) {
512 a = ntohl(local.in.sin_addr.s_addr),
513 b = ntohl(remote.in.sin_addr.s_addr);
516 "%u.%u.%u.%u:%u-%u.%u.%u.%u:%u",
517 a >> 24, (a >> 16) & 0xFF, (a >> 8) & 0xFF, a & 0xFF,
518 ntohs(local.in.sin_port),
519 b >> 24, (b >> 16) & 0xFF, (b >> 8) & 0xFF, b & 0xFF,
520 ntohs(remote.in.sin_port)) < 0)
527 static const char ipv4_prefix[] = {
528 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0xFF, 0xFF
531 if (memcmp(&local.in6.sin6_addr, ipv4_prefix, sizeof(ipv4_prefix)) == 0 &&
532 memcmp(&remote.in6.sin6_addr, ipv4_prefix, sizeof(ipv4_prefix)) == 0) {
534 *a = local.in6.sin6_addr.s6_addr+12,
535 *b = remote.in6.sin6_addr.s6_addr+12;
538 "%u.%u.%u.%u:%u-%u.%u.%u.%u:%u",
539 a[0], a[1], a[2], a[3],
540 ntohs(local.in6.sin6_port),
541 b[0], b[1], b[2], b[3],
542 ntohs(remote.in6.sin6_port)) < 0)
545 char a[INET6_ADDRSTRLEN], b[INET6_ADDRSTRLEN];
549 inet_ntop(AF_INET6, &local.in6.sin6_addr, a, sizeof(a)),
550 ntohs(local.in6.sin6_port),
551 inet_ntop(AF_INET6, &remote.in6.sin6_addr, b, sizeof(b)),
552 ntohs(remote.in6.sin6_port)) < 0)
563 if (getsockopt(fd, SOL_SOCKET, SO_PEERCRED, &ucred, &l) < 0)
569 (unsigned long) ucred.pid,
570 (unsigned long) ucred.uid) < 0)
577 assert_not_reached("Unhandled socket type.");
584 static void socket_close_fds(Socket *s) {
589 LIST_FOREACH(port, p, s->ports) {
593 unit_unwatch_fd(UNIT(s), &p->fd_watch);
594 close_nointr_nofail(p->fd);
596 /* One little note: we should never delete any sockets
597 * in the file system here! After all some other
598 * process we spawned might still have a reference of
599 * this fd and wants to continue to use it. Therefore
600 * we delete sockets in the file system before we
601 * create a new one, not after we stopped using
608 static void socket_apply_socket_options(Socket *s, int fd) {
613 int b = s->keep_alive;
614 if (setsockopt(fd, SOL_SOCKET, SO_KEEPALIVE, &b, sizeof(b)) < 0)
615 log_warning("SO_KEEPALIVE failed: %m");
618 if (s->priority >= 0)
619 if (setsockopt(fd, SOL_SOCKET, SO_PRIORITY, &s->priority, sizeof(s->priority)) < 0)
620 log_warning("SO_PRIORITY failed: %m");
622 if (s->receive_buffer > 0) {
623 int value = (int) s->receive_buffer;
624 if (setsockopt(fd, SOL_SOCKET, SO_RCVBUF, &value, sizeof(value)) < 0)
625 log_warning("SO_RCVBUF failed: %m");
628 if (s->send_buffer > 0) {
629 int value = (int) s->send_buffer;
630 if (setsockopt(fd, SOL_SOCKET, SO_SNDBUF, &value, sizeof(value)) < 0)
631 log_warning("SO_SNDBUF failed: %m");
635 if (setsockopt(fd, SOL_SOCKET, SO_MARK, &s->mark, sizeof(s->mark)) < 0)
636 log_warning("SO_MARK failed: %m");
639 if (setsockopt(fd, IPPROTO_IP, IP_TOS, &s->ip_tos, sizeof(s->ip_tos)) < 0)
640 log_warning("IP_TOS failed: %m");
642 if (s->ip_ttl >= 0) {
645 r = setsockopt(fd, IPPROTO_IP, IP_TTL, &s->ip_ttl, sizeof(s->ip_ttl));
647 if (socket_ipv6_is_supported())
648 x = setsockopt(fd, IPPROTO_IPV6, IPV6_UNICAST_HOPS, &s->ip_ttl, sizeof(s->ip_ttl));
651 errno = EAFNOSUPPORT;
655 log_warning("IP_TTL/IPV6_UNICAST_HOPS failed: %m");
658 if (s->tcp_congestion)
659 if (setsockopt(fd, SOL_TCP, TCP_CONGESTION, s->tcp_congestion, strlen(s->tcp_congestion)+1) < 0)
660 log_warning("TCP_CONGESTION failed: %m");
663 static void socket_apply_fifo_options(Socket *s, int fd) {
667 if (s->pipe_size > 0)
668 if (fcntl(fd, F_SETPIPE_SZ, s->pipe_size) < 0)
669 log_warning("F_SETPIPE_SZ: %m");
673 static int fifo_address_create(
675 mode_t directory_mode,
686 mkdir_parents(path, directory_mode);
688 if ((r = label_fifofile_set(path)) < 0)
691 /* Enforce the right access mode for the fifo */
692 old_mask = umask(~ socket_mode);
694 /* Include the original umask in our mask */
695 umask(~socket_mode | old_mask);
697 r = mkfifo(path, socket_mode);
705 if ((fd = open(path, O_RDWR|O_CLOEXEC|O_NOCTTY|O_NONBLOCK|O_NOFOLLOW)) < 0) {
712 if (fstat(fd, &st) < 0) {
717 if (!S_ISFIFO(st.st_mode) ||
718 (st.st_mode & 0777) != (socket_mode & ~old_mask) ||
719 st.st_uid != getuid() ||
720 st.st_gid != getgid()) {
733 close_nointr_nofail(fd);
738 static int socket_open_fds(Socket *s) {
742 bool know_label = false;
746 LIST_FOREACH(port, p, s->ports) {
751 if (p->type == SOCKET_SOCKET) {
755 if ((r = socket_instantiate_service(s)) < 0)
758 if ((r = label_get_socket_label_from_exe(s->service->exec_command[SERVICE_EXEC_START]->path, &label)) < 0)
764 if ((r = socket_address_listen(
776 socket_apply_socket_options(s, p->fd);
778 } else if (p->type == SOCKET_FIFO) {
780 if ((r = fifo_address_create(
787 socket_apply_fifo_options(s, p->fd);
790 assert_not_reached("Unknown port type");
802 static void socket_unwatch_fds(Socket *s) {
807 LIST_FOREACH(port, p, s->ports) {
811 unit_unwatch_fd(UNIT(s), &p->fd_watch);
815 static int socket_watch_fds(Socket *s) {
821 LIST_FOREACH(port, p, s->ports) {
825 p->fd_watch.socket_accept =
827 p->type == SOCKET_SOCKET &&
828 socket_address_can_accept(&p->address);
830 if ((r = unit_watch_fd(UNIT(s), p->fd, EPOLLIN, &p->fd_watch)) < 0)
837 socket_unwatch_fds(s);
841 static void socket_set_state(Socket *s, SocketState state) {
842 SocketState old_state;
845 old_state = s->state;
848 if (state != SOCKET_START_PRE &&
849 state != SOCKET_START_POST &&
850 state != SOCKET_STOP_PRE &&
851 state != SOCKET_STOP_PRE_SIGTERM &&
852 state != SOCKET_STOP_PRE_SIGKILL &&
853 state != SOCKET_STOP_POST &&
854 state != SOCKET_FINAL_SIGTERM &&
855 state != SOCKET_FINAL_SIGKILL) {
856 unit_unwatch_timer(UNIT(s), &s->timer_watch);
857 socket_unwatch_control_pid(s);
858 s->control_command = NULL;
859 s->control_command_id = _SOCKET_EXEC_COMMAND_INVALID;
862 if (state != SOCKET_LISTENING)
863 socket_unwatch_fds(s);
865 if (state != SOCKET_START_POST &&
866 state != SOCKET_LISTENING &&
867 state != SOCKET_RUNNING &&
868 state != SOCKET_STOP_PRE &&
869 state != SOCKET_STOP_PRE_SIGTERM &&
870 state != SOCKET_STOP_PRE_SIGKILL)
873 if (state != old_state)
874 log_debug("%s changed %s -> %s",
876 socket_state_to_string(old_state),
877 socket_state_to_string(state));
879 unit_notify(UNIT(s), state_translation_table[old_state], state_translation_table[state]);
882 static int socket_coldplug(Unit *u) {
883 Socket *s = SOCKET(u);
887 assert(s->state == SOCKET_DEAD);
889 if (s->deserialized_state != s->state) {
891 if (s->deserialized_state == SOCKET_START_PRE ||
892 s->deserialized_state == SOCKET_START_POST ||
893 s->deserialized_state == SOCKET_STOP_PRE ||
894 s->deserialized_state == SOCKET_STOP_PRE_SIGTERM ||
895 s->deserialized_state == SOCKET_STOP_PRE_SIGKILL ||
896 s->deserialized_state == SOCKET_STOP_POST ||
897 s->deserialized_state == SOCKET_FINAL_SIGTERM ||
898 s->deserialized_state == SOCKET_FINAL_SIGKILL) {
900 if (s->control_pid <= 0)
903 if ((r = unit_watch_pid(UNIT(s), s->control_pid)) < 0)
906 if ((r = unit_watch_timer(UNIT(s), s->timeout_usec, &s->timer_watch)) < 0)
910 if (s->deserialized_state == SOCKET_START_POST ||
911 s->deserialized_state == SOCKET_LISTENING ||
912 s->deserialized_state == SOCKET_RUNNING ||
913 s->deserialized_state == SOCKET_STOP_PRE ||
914 s->deserialized_state == SOCKET_STOP_PRE_SIGTERM ||
915 s->deserialized_state == SOCKET_STOP_PRE_SIGKILL)
916 if ((r = socket_open_fds(s)) < 0)
919 if (s->deserialized_state == SOCKET_LISTENING)
920 if ((r = socket_watch_fds(s)) < 0)
923 socket_set_state(s, s->deserialized_state);
929 static int socket_spawn(Socket *s, ExecCommand *c, pid_t *_pid) {
938 if ((r = unit_watch_timer(UNIT(s), s->timeout_usec, &s->timer_watch)) < 0)
941 if (!(argv = unit_full_printf_strv(UNIT(s), c->argv))) {
950 s->meta.manager->environment,
954 s->meta.manager->confirm_spawn,
955 s->meta.cgroup_bondings,
962 if ((r = unit_watch_pid(UNIT(s), pid)) < 0)
963 /* FIXME: we need to do something here */
971 unit_unwatch_timer(UNIT(s), &s->timer_watch);
976 static void socket_enter_dead(Socket *s, bool success) {
982 socket_set_state(s, s->failure ? SOCKET_FAILED : SOCKET_DEAD);
985 static void socket_enter_signal(Socket *s, SocketState state, bool success);
987 static void socket_enter_stop_post(Socket *s, bool success) {
994 socket_unwatch_control_pid(s);
996 s->control_command_id = SOCKET_EXEC_STOP_POST;
998 if ((s->control_command = s->exec_command[SOCKET_EXEC_STOP_POST])) {
999 if ((r = socket_spawn(s, s->control_command, &s->control_pid)) < 0)
1002 socket_set_state(s, SOCKET_STOP_POST);
1004 socket_enter_signal(s, SOCKET_FINAL_SIGTERM, true);
1009 log_warning("%s failed to run 'stop-post' task: %s", s->meta.id, strerror(-r));
1010 socket_enter_signal(s, SOCKET_FINAL_SIGTERM, false);
1013 static void socket_enter_signal(Socket *s, SocketState state, bool success) {
1015 Set *pid_set = NULL;
1016 bool wait_for_exit = false;
1023 if (s->exec_context.kill_mode != KILL_NONE) {
1024 int sig = (state == SOCKET_STOP_PRE_SIGTERM || state == SOCKET_FINAL_SIGTERM) ? s->exec_context.kill_signal : SIGKILL;
1026 if (s->control_pid > 0) {
1027 if (kill(s->exec_context.kill_mode == KILL_PROCESS_GROUP ?
1029 s->control_pid, sig) < 0 && errno != ESRCH)
1031 log_warning("Failed to kill control process %li: %m", (long) s->control_pid);
1033 wait_for_exit = true;
1036 if (s->exec_context.kill_mode == KILL_CONTROL_GROUP) {
1038 if (!(pid_set = set_new(trivial_hash_func, trivial_compare_func))) {
1043 /* Exclude the control pid from being killed via the cgroup */
1044 if (s->control_pid > 0)
1045 if ((r = set_put(pid_set, LONG_TO_PTR(s->control_pid))) < 0)
1048 if ((r = cgroup_bonding_kill_list(s->meta.cgroup_bondings, sig, pid_set)) < 0) {
1049 if (r != -EAGAIN && r != -ESRCH && r != -ENOENT)
1050 log_warning("Failed to kill control group: %s", strerror(-r));
1052 wait_for_exit = true;
1058 if (wait_for_exit) {
1059 if ((r = unit_watch_timer(UNIT(s), s->timeout_usec, &s->timer_watch)) < 0)
1062 socket_set_state(s, state);
1063 } else if (state == SOCKET_STOP_PRE_SIGTERM || state == SOCKET_STOP_PRE_SIGKILL)
1064 socket_enter_stop_post(s, true);
1066 socket_enter_dead(s, true);
1071 log_warning("%s failed to kill processes: %s", s->meta.id, strerror(-r));
1073 if (state == SOCKET_STOP_PRE_SIGTERM || state == SOCKET_STOP_PRE_SIGKILL)
1074 socket_enter_stop_post(s, false);
1076 socket_enter_dead(s, false);
1082 static void socket_enter_stop_pre(Socket *s, bool success) {
1089 socket_unwatch_control_pid(s);
1091 s->control_command_id = SOCKET_EXEC_STOP_PRE;
1093 if ((s->control_command = s->exec_command[SOCKET_EXEC_STOP_PRE])) {
1094 if ((r = socket_spawn(s, s->control_command, &s->control_pid)) < 0)
1097 socket_set_state(s, SOCKET_STOP_PRE);
1099 socket_enter_stop_post(s, true);
1104 log_warning("%s failed to run 'stop-pre' task: %s", s->meta.id, strerror(-r));
1105 socket_enter_stop_post(s, false);
1108 static void socket_enter_listening(Socket *s) {
1112 if ((r = socket_watch_fds(s)) < 0) {
1113 log_warning("%s failed to watch sockets: %s", s->meta.id, strerror(-r));
1117 socket_set_state(s, SOCKET_LISTENING);
1121 socket_enter_stop_pre(s, false);
1124 static void socket_enter_start_post(Socket *s) {
1128 if ((r = socket_open_fds(s)) < 0) {
1129 log_warning("%s failed to listen on sockets: %s", s->meta.id, strerror(-r));
1133 socket_unwatch_control_pid(s);
1135 s->control_command_id = SOCKET_EXEC_START_POST;
1137 if ((s->control_command = s->exec_command[SOCKET_EXEC_START_POST])) {
1138 if ((r = socket_spawn(s, s->control_command, &s->control_pid)) < 0) {
1139 log_warning("%s failed to run 'start-post' task: %s", s->meta.id, strerror(-r));
1143 socket_set_state(s, SOCKET_START_POST);
1145 socket_enter_listening(s);
1150 socket_enter_stop_pre(s, false);
1153 static void socket_enter_start_pre(Socket *s) {
1157 socket_unwatch_control_pid(s);
1159 s->control_command_id = SOCKET_EXEC_START_PRE;
1161 if ((s->control_command = s->exec_command[SOCKET_EXEC_START_PRE])) {
1162 if ((r = socket_spawn(s, s->control_command, &s->control_pid)) < 0)
1165 socket_set_state(s, SOCKET_START_PRE);
1167 socket_enter_start_post(s);
1172 log_warning("%s failed to run 'start-pre' task: %s", s->meta.id, strerror(-r));
1173 socket_enter_dead(s, false);
1176 static void socket_enter_running(Socket *s, int cfd) {
1181 dbus_error_init(&error);
1183 /* We don't take connections anymore if we are supposed to
1184 * shut down anyway */
1185 if (unit_pending_inactive(UNIT(s))) {
1187 close_nointr_nofail(cfd);
1189 /* Flush all sockets by closing and reopening them */
1190 socket_close_fds(s);
1192 if ((r = socket_watch_fds(s)) < 0) {
1193 log_warning("%s failed to watch sockets: %s", s->meta.id, strerror(-r));
1194 socket_enter_stop_pre(s, false);
1202 bool pending = false;
1205 /* If there's already a start pending don't bother to
1207 LIST_FOREACH(units_per_type, i, s->meta.manager->units_per_type[UNIT_SERVICE]) {
1208 Service *service = (Service *) i;
1210 if (!set_get(service->configured_sockets, s))
1213 if (!unit_pending_active(UNIT(service)))
1221 if ((r = manager_add_job(s->meta.manager, JOB_START, UNIT(s->service), JOB_REPLACE, true, &error, NULL)) < 0)
1224 socket_set_state(s, SOCKET_RUNNING);
1226 char *prefix, *instance = NULL, *name;
1229 if (s->n_connections >= s->max_connections) {
1230 log_warning("Too many incoming connections (%u)", s->n_connections);
1231 close_nointr_nofail(cfd);
1235 if ((r = socket_instantiate_service(s)) < 0)
1238 if ((r = instance_from_socket(cfd, s->n_accepted, &instance)) < 0)
1241 if (!(prefix = unit_name_to_prefix(s->meta.id))) {
1247 name = unit_name_build(prefix, instance, ".service");
1256 if ((r = unit_add_name(UNIT(s->service), name)) < 0) {
1261 service = s->service;
1265 service->meta.no_gc = false;
1267 unit_choose_id(UNIT(service), name);
1270 if ((r = service_set_socket_fd(service, cfd, s)) < 0)
1274 s->n_connections ++;
1276 if ((r = manager_add_job(s->meta.manager, JOB_START, UNIT(service), JOB_REPLACE, true, &error, NULL)) < 0)
1279 /* Notify clients about changed counters */
1280 unit_add_to_dbus_queue(UNIT(s));
1286 log_warning("%s failed to queue socket startup job: %s", s->meta.id, bus_error(&error, r));
1287 socket_enter_stop_pre(s, false);
1290 close_nointr_nofail(cfd);
1292 dbus_error_free(&error);
1295 static void socket_run_next(Socket *s, bool success) {
1299 assert(s->control_command);
1300 assert(s->control_command->command_next);
1305 socket_unwatch_control_pid(s);
1307 s->control_command = s->control_command->command_next;
1309 if ((r = socket_spawn(s, s->control_command, &s->control_pid)) < 0)
1315 log_warning("%s failed to run next task: %s", s->meta.id, strerror(-r));
1317 if (s->state == SOCKET_START_POST)
1318 socket_enter_stop_pre(s, false);
1319 else if (s->state == SOCKET_STOP_POST)
1320 socket_enter_dead(s, false);
1322 socket_enter_signal(s, SOCKET_FINAL_SIGTERM, false);
1325 static int socket_start(Unit *u) {
1326 Socket *s = SOCKET(u);
1330 /* We cannot fulfill this request right now, try again later
1332 if (s->state == SOCKET_STOP_PRE ||
1333 s->state == SOCKET_STOP_PRE_SIGKILL ||
1334 s->state == SOCKET_STOP_PRE_SIGTERM ||
1335 s->state == SOCKET_STOP_POST ||
1336 s->state == SOCKET_FINAL_SIGTERM ||
1337 s->state == SOCKET_FINAL_SIGKILL)
1340 if (s->state == SOCKET_START_PRE ||
1341 s->state == SOCKET_START_POST)
1344 /* Cannot run this without the service being around */
1346 if (s->service->meta.load_state != UNIT_LOADED)
1349 /* If the service is alredy actvie we cannot start the
1351 if (s->service->state != SERVICE_DEAD &&
1352 s->service->state != SERVICE_FAILED &&
1353 s->service->state != SERVICE_AUTO_RESTART)
1357 assert(s->state == SOCKET_DEAD || s->state == SOCKET_FAILED);
1360 socket_enter_start_pre(s);
1364 static int socket_stop(Unit *u) {
1365 Socket *s = SOCKET(u);
1370 if (s->state == SOCKET_STOP_PRE ||
1371 s->state == SOCKET_STOP_PRE_SIGTERM ||
1372 s->state == SOCKET_STOP_PRE_SIGKILL ||
1373 s->state == SOCKET_STOP_POST ||
1374 s->state == SOCKET_FINAL_SIGTERM ||
1375 s->state == SOCKET_FINAL_SIGKILL)
1378 /* If there's already something running we go directly into
1380 if (s->state == SOCKET_START_PRE ||
1381 s->state == SOCKET_START_POST) {
1382 socket_enter_signal(s, SOCKET_STOP_PRE_SIGTERM, true);
1386 assert(s->state == SOCKET_LISTENING || s->state == SOCKET_RUNNING);
1388 socket_enter_stop_pre(s, true);
1392 static int socket_serialize(Unit *u, FILE *f, FDSet *fds) {
1393 Socket *s = SOCKET(u);
1401 unit_serialize_item(u, f, "state", socket_state_to_string(s->state));
1402 unit_serialize_item(u, f, "failure", yes_no(s->failure));
1403 unit_serialize_item_format(u, f, "n-accepted", "%u", s->n_accepted);
1405 if (s->control_pid > 0)
1406 unit_serialize_item_format(u, f, "control-pid", "%lu", (unsigned long) s->control_pid);
1408 if (s->control_command_id >= 0)
1409 unit_serialize_item(u, f, "control-command", socket_exec_command_to_string(s->control_command_id));
1411 LIST_FOREACH(port, p, s->ports) {
1417 if ((copy = fdset_put_dup(fds, p->fd)) < 0)
1420 if (p->type == SOCKET_SOCKET) {
1423 if ((r = socket_address_print(&p->address, &t)) < 0)
1426 unit_serialize_item_format(u, f, "socket", "%i %i %s", copy, p->address.type, t);
1429 assert(p->type == SOCKET_FIFO);
1430 unit_serialize_item_format(u, f, "fifo", "%i %s", copy, p->path);
1437 static int socket_deserialize_item(Unit *u, const char *key, const char *value, FDSet *fds) {
1438 Socket *s = SOCKET(u);
1445 if (streq(key, "state")) {
1448 if ((state = socket_state_from_string(value)) < 0)
1449 log_debug("Failed to parse state value %s", value);
1451 s->deserialized_state = state;
1452 } else if (streq(key, "failure")) {
1455 if ((b = parse_boolean(value)) < 0)
1456 log_debug("Failed to parse failure value %s", value);
1458 s->failure = b || s->failure;
1460 } else if (streq(key, "n-accepted")) {
1463 if (safe_atou(value, &k) < 0)
1464 log_debug("Failed to parse n-accepted value %s", value);
1467 } else if (streq(key, "control-pid")) {
1470 if (parse_pid(value, &pid) < 0)
1471 log_debug("Failed to parse control-pid value %s", value);
1473 s->control_pid = pid;
1474 } else if (streq(key, "control-command")) {
1475 SocketExecCommand id;
1477 if ((id = socket_exec_command_from_string(value)) < 0)
1478 log_debug("Failed to parse exec-command value %s", value);
1480 s->control_command_id = id;
1481 s->control_command = s->exec_command[id];
1483 } else if (streq(key, "fifo")) {
1487 if (sscanf(value, "%i %n", &fd, &skip) < 1 || fd < 0 || !fdset_contains(fds, fd))
1488 log_debug("Failed to parse fifo value %s", value);
1491 LIST_FOREACH(port, p, s->ports)
1492 if (streq(p->path, value+skip))
1497 close_nointr_nofail(p->fd);
1498 p->fd = fdset_remove(fds, fd);
1502 } else if (streq(key, "socket")) {
1503 int fd, type, skip = 0;
1506 if (sscanf(value, "%i %i %n", &fd, &type, &skip) < 2 || fd < 0 || type < 0 || !fdset_contains(fds, fd))
1507 log_debug("Failed to parse socket value %s", value);
1510 LIST_FOREACH(port, p, s->ports)
1511 if (socket_address_is(&p->address, value+skip, type))
1516 close_nointr_nofail(p->fd);
1517 p->fd = fdset_remove(fds, fd);
1522 log_debug("Unknown serialization key '%s'", key);
1527 static UnitActiveState socket_active_state(Unit *u) {
1530 return state_translation_table[SOCKET(u)->state];
1533 static const char *socket_sub_state_to_string(Unit *u) {
1536 return socket_state_to_string(SOCKET(u)->state);
1539 static bool socket_check_gc(Unit *u) {
1540 Socket *s = SOCKET(u);
1544 return s->n_connections > 0;
1547 static void socket_fd_event(Unit *u, int fd, uint32_t events, Watch *w) {
1548 Socket *s = SOCKET(u);
1554 if (s->state != SOCKET_LISTENING)
1557 log_debug("Incoming traffic on %s", u->meta.id);
1559 if (events != EPOLLIN) {
1560 log_error("Got invalid poll event on socket.");
1564 if (w->socket_accept) {
1567 if ((cfd = accept4(fd, NULL, NULL, SOCK_NONBLOCK)) < 0) {
1572 log_error("Failed to accept socket: %m");
1579 socket_apply_socket_options(s, cfd);
1582 socket_enter_running(s, cfd);
1586 socket_enter_stop_pre(s, false);
1589 static void socket_sigchld_event(Unit *u, pid_t pid, int code, int status) {
1590 Socket *s = SOCKET(u);
1596 if (pid != s->control_pid)
1601 success = is_clean_exit(code, status);
1603 if (s->control_command) {
1604 exec_status_exit(&s->control_command->exec_status, pid, code, status, s->exec_context.utmp_id);
1606 if (s->control_command->ignore)
1610 log_full(success ? LOG_DEBUG : LOG_NOTICE,
1611 "%s control process exited, code=%s status=%i", u->meta.id, sigchld_code_to_string(code), status);
1612 s->failure = s->failure || !success;
1614 if (s->control_command && s->control_command->command_next && success) {
1615 log_debug("%s running next command for state %s", u->meta.id, socket_state_to_string(s->state));
1616 socket_run_next(s, success);
1618 s->control_command = NULL;
1619 s->control_command_id = _SOCKET_EXEC_COMMAND_INVALID;
1621 /* No further commands for this step, so let's figure
1622 * out what to do next */
1624 log_debug("%s got final SIGCHLD for state %s", u->meta.id, socket_state_to_string(s->state));
1628 case SOCKET_START_PRE:
1630 socket_enter_start_post(s);
1632 socket_enter_signal(s, SOCKET_FINAL_SIGTERM, false);
1635 case SOCKET_START_POST:
1637 socket_enter_listening(s);
1639 socket_enter_stop_pre(s, false);
1642 case SOCKET_STOP_PRE:
1643 case SOCKET_STOP_PRE_SIGTERM:
1644 case SOCKET_STOP_PRE_SIGKILL:
1645 socket_enter_stop_post(s, success);
1648 case SOCKET_STOP_POST:
1649 case SOCKET_FINAL_SIGTERM:
1650 case SOCKET_FINAL_SIGKILL:
1651 socket_enter_dead(s, success);
1655 assert_not_reached("Uh, control process died at wrong time.");
1659 /* Notify clients about changed exit status */
1660 unit_add_to_dbus_queue(u);
1663 static void socket_timer_event(Unit *u, uint64_t elapsed, Watch *w) {
1664 Socket *s = SOCKET(u);
1667 assert(elapsed == 1);
1668 assert(w == &s->timer_watch);
1672 case SOCKET_START_PRE:
1673 log_warning("%s starting timed out. Terminating.", u->meta.id);
1674 socket_enter_signal(s, SOCKET_FINAL_SIGTERM, false);
1676 case SOCKET_START_POST:
1677 log_warning("%s starting timed out. Stopping.", u->meta.id);
1678 socket_enter_stop_pre(s, false);
1681 case SOCKET_STOP_PRE:
1682 log_warning("%s stopping timed out. Terminating.", u->meta.id);
1683 socket_enter_signal(s, SOCKET_STOP_PRE_SIGTERM, false);
1686 case SOCKET_STOP_PRE_SIGTERM:
1687 log_warning("%s stopping timed out. Killing.", u->meta.id);
1688 socket_enter_signal(s, SOCKET_STOP_PRE_SIGKILL, false);
1691 case SOCKET_STOP_PRE_SIGKILL:
1692 log_warning("%s still around after SIGKILL. Ignoring.", u->meta.id);
1693 socket_enter_stop_post(s, false);
1696 case SOCKET_STOP_POST:
1697 log_warning("%s stopping timed out (2). Terminating.", u->meta.id);
1698 socket_enter_signal(s, SOCKET_FINAL_SIGTERM, false);
1701 case SOCKET_FINAL_SIGTERM:
1702 log_warning("%s stopping timed out (2). Killing.", u->meta.id);
1703 socket_enter_signal(s, SOCKET_FINAL_SIGKILL, false);
1706 case SOCKET_FINAL_SIGKILL:
1707 log_warning("%s still around after SIGKILL (2). Entering failed mode.", u->meta.id);
1708 socket_enter_dead(s, false);
1712 assert_not_reached("Timeout at wrong time.");
1716 int socket_collect_fds(Socket *s, int **fds, unsigned *n_fds) {
1725 /* Called from the service code for requesting our fds */
1728 LIST_FOREACH(port, p, s->ports)
1732 if (!(rfds = new(int, rn_fds)))
1736 LIST_FOREACH(port, p, s->ports)
1740 assert(k == rn_fds);
1748 void socket_notify_service_dead(Socket *s) {
1751 /* The service is dead. Dang!
1753 * This is strictly for one-instance-for-all-connections
1756 if (s->state == SOCKET_RUNNING) {
1757 log_debug("%s got notified about service death.", s->meta.id);
1758 socket_enter_listening(s);
1762 void socket_connection_unref(Socket *s) {
1765 /* The service is dead. Yay!
1767 * This is strictly for one-onstance-per-connection
1770 assert(s->n_connections > 0);
1773 log_debug("%s: One connection closed, %u left.", s->meta.id, s->n_connections);
1776 static void socket_reset_failed(Unit *u) {
1777 Socket *s = SOCKET(u);
1781 if (s->state == SOCKET_FAILED)
1782 socket_set_state(s, SOCKET_DEAD);
1787 static int socket_kill(Unit *u, KillWho who, KillMode mode, int signo, DBusError *error) {
1788 Socket *s = SOCKET(u);
1790 Set *pid_set = NULL;
1794 if (who == KILL_MAIN) {
1795 dbus_set_error(error, BUS_ERROR_NO_SUCH_PROCESS, "Socket units have no main processes");
1799 if (s->control_pid <= 0 && who == KILL_CONTROL) {
1800 dbus_set_error(error, BUS_ERROR_NO_SUCH_PROCESS, "No control process to kill");
1804 if (s->control_pid > 0)
1805 if (kill(mode == KILL_PROCESS_GROUP ? -s->control_pid : s->control_pid, signo) < 0)
1808 if (mode == KILL_CONTROL_GROUP) {
1811 if (!(pid_set = set_new(trivial_hash_func, trivial_compare_func)))
1814 /* Exclude the control pid from being killed via the cgroup */
1815 if (s->control_pid > 0)
1816 if ((q = set_put(pid_set, LONG_TO_PTR(s->control_pid))) < 0) {
1821 if ((q = cgroup_bonding_kill_list(s->meta.cgroup_bondings, signo, pid_set)) < 0)
1822 if (r != -EAGAIN && r != -ESRCH && r != -ENOENT)
1833 static const char* const socket_state_table[_SOCKET_STATE_MAX] = {
1834 [SOCKET_DEAD] = "dead",
1835 [SOCKET_START_PRE] = "start-pre",
1836 [SOCKET_START_POST] = "start-post",
1837 [SOCKET_LISTENING] = "listening",
1838 [SOCKET_RUNNING] = "running",
1839 [SOCKET_STOP_PRE] = "stop-pre",
1840 [SOCKET_STOP_PRE_SIGTERM] = "stop-pre-sigterm",
1841 [SOCKET_STOP_PRE_SIGKILL] = "stop-pre-sigkill",
1842 [SOCKET_STOP_POST] = "stop-post",
1843 [SOCKET_FINAL_SIGTERM] = "final-sigterm",
1844 [SOCKET_FINAL_SIGKILL] = "final-sigkill",
1845 [SOCKET_FAILED] = "failed"
1848 DEFINE_STRING_TABLE_LOOKUP(socket_state, SocketState);
1850 static const char* const socket_exec_command_table[_SOCKET_EXEC_COMMAND_MAX] = {
1851 [SOCKET_EXEC_START_PRE] = "StartPre",
1852 [SOCKET_EXEC_START_POST] = "StartPost",
1853 [SOCKET_EXEC_STOP_PRE] = "StopPre",
1854 [SOCKET_EXEC_STOP_POST] = "StopPost"
1857 DEFINE_STRING_TABLE_LOOKUP(socket_exec_command, SocketExecCommand);
1859 const UnitVTable socket_vtable = {
1860 .suffix = ".socket",
1862 .init = socket_init,
1863 .done = socket_done,
1864 .load = socket_load,
1866 .kill = socket_kill,
1868 .coldplug = socket_coldplug,
1870 .dump = socket_dump,
1872 .start = socket_start,
1873 .stop = socket_stop,
1875 .serialize = socket_serialize,
1876 .deserialize_item = socket_deserialize_item,
1878 .active_state = socket_active_state,
1879 .sub_state_to_string = socket_sub_state_to_string,
1881 .check_gc = socket_check_gc,
1883 .fd_event = socket_fd_event,
1884 .sigchld_event = socket_sigchld_event,
1885 .timer_event = socket_timer_event,
1887 .reset_failed = socket_reset_failed,
1889 .bus_interface = "org.freedesktop.systemd1.Socket",
1890 .bus_message_handler = bus_socket_message_handler,
1891 .bus_invalidating_properties = bus_socket_invalidating_properties