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->exec_context.pam_name && s->exec_context.kill_mode != KILL_CONTROL_GROUP) {
216 log_error("%s has PAM enabled. Kill mode must be set to 'control-group'. Refusing.", s->meta.id);
223 static bool socket_needs_mount(Socket *s, const char *prefix) {
228 LIST_FOREACH(port, p, s->ports) {
230 if (p->type == SOCKET_SOCKET) {
231 if (socket_address_needs_mount(&p->address, prefix))
234 assert(p->type == SOCKET_FIFO);
235 if (path_startswith(p->path, prefix))
243 int socket_add_one_mount_link(Socket *s, Mount *m) {
249 if (s->meta.load_state != UNIT_LOADED ||
250 m->meta.load_state != UNIT_LOADED)
253 if (!socket_needs_mount(s, m->where))
256 if ((r = unit_add_two_dependencies(UNIT(s), UNIT_AFTER, UNIT_REQUIRES, UNIT(m), true)) < 0)
262 static int socket_add_mount_links(Socket *s) {
268 LIST_FOREACH(units_per_type, other, s->meta.manager->units_per_type[UNIT_MOUNT])
269 if ((r = socket_add_one_mount_link(s, (Mount*) other)) < 0)
275 static int socket_add_device_link(Socket *s) {
281 if (!s->bind_to_device)
284 if (asprintf(&t, "/sys/subsystem/net/devices/%s", s->bind_to_device) < 0)
287 r = unit_add_node_link(UNIT(s), t, false);
293 static int socket_add_default_dependencies(Socket *s) {
297 if (s->meta.manager->running_as == MANAGER_SYSTEM)
298 if ((r = unit_add_two_dependencies_by_name(UNIT(s), UNIT_AFTER, UNIT_REQUIRES, SPECIAL_SYSINIT_TARGET, NULL, true)) < 0)
301 return unit_add_two_dependencies_by_name(UNIT(s), UNIT_BEFORE, UNIT_CONFLICTED_BY, SPECIAL_SHUTDOWN_TARGET, NULL, true);
304 static int socket_load(Unit *u) {
305 Socket *s = SOCKET(u);
309 assert(u->meta.load_state == UNIT_STUB);
311 if ((r = unit_load_fragment_and_dropin(u)) < 0)
314 /* This is a new unit? Then let's add in some extras */
315 if (u->meta.load_state == UNIT_LOADED) {
317 if (have_non_accept_socket(s)) {
318 if ((r = unit_load_related_unit(u, ".service", (Unit**) &s->service)) < 0)
321 if ((r = unit_add_dependency(u, UNIT_BEFORE, UNIT(s->service), true)) < 0)
325 if ((r = socket_add_mount_links(s)) < 0)
328 if ((r = socket_add_device_link(s)) < 0)
331 if ((r = unit_add_exec_dependencies(u, &s->exec_context)) < 0)
334 if ((r = unit_add_default_cgroup(u)) < 0)
337 if (s->meta.default_dependencies)
338 if ((r = socket_add_default_dependencies(s)) < 0)
342 return socket_verify(s);
345 static const char* listen_lookup(int type) {
347 if (type == SOCK_STREAM)
348 return "ListenStream";
349 else if (type == SOCK_DGRAM)
350 return "ListenDatagram";
351 else if (type == SOCK_SEQPACKET)
352 return "ListenSequentialPacket";
354 assert_not_reached("Unknown socket type");
358 static void socket_dump(Unit *u, FILE *f, const char *prefix) {
361 Socket *s = SOCKET(u);
369 p2 = strappend(prefix, "\t");
370 prefix2 = p2 ? p2 : prefix;
373 "%sSocket State: %s\n"
374 "%sBindIPv6Only: %s\n"
376 "%sSocketMode: %04o\n"
377 "%sDirectoryMode: %04o\n"
380 "%sTCPCongestion: %s\n",
381 prefix, socket_state_to_string(s->state),
382 prefix, socket_address_bind_ipv6_only_to_string(s->bind_ipv6_only),
384 prefix, s->socket_mode,
385 prefix, s->directory_mode,
386 prefix, yes_no(s->keep_alive),
387 prefix, yes_no(s->free_bind),
388 prefix, strna(s->tcp_congestion));
390 if (s->control_pid > 0)
392 "%sControl PID: %lu\n",
393 prefix, (unsigned long) s->control_pid);
395 if (s->bind_to_device)
397 "%sBindToDevice: %s\n",
398 prefix, s->bind_to_device);
403 "%sNConnections: %u\n"
404 "%sMaxConnections: %u\n",
405 prefix, s->n_accepted,
406 prefix, s->n_connections,
407 prefix, s->max_connections);
409 if (s->priority >= 0)
412 prefix, s->priority);
414 if (s->receive_buffer > 0)
416 "%sReceiveBuffer: %zu\n",
417 prefix, s->receive_buffer);
419 if (s->send_buffer > 0)
421 "%sSendBuffer: %zu\n",
422 prefix, s->send_buffer);
434 if (s->pipe_size > 0)
437 prefix, s->pipe_size);
444 LIST_FOREACH(port, p, s->ports) {
446 if (p->type == SOCKET_SOCKET) {
451 if ((r = socket_address_print(&p->address, &k)) < 0)
456 fprintf(f, "%s%s: %s\n", prefix, listen_lookup(p->address.type), t);
459 fprintf(f, "%sListenFIFO: %s\n", prefix, p->path);
462 exec_context_dump(&s->exec_context, f, prefix);
464 for (c = 0; c < _SOCKET_EXEC_COMMAND_MAX; c++) {
465 if (!s->exec_command[c])
468 fprintf(f, "%s-> %s:\n",
469 prefix, socket_exec_command_to_string(c));
471 exec_command_dump_list(s->exec_command[c], f, prefix2);
477 static int instance_from_socket(int fd, unsigned nr, char **instance) {
482 struct sockaddr_un un;
483 struct sockaddr_in in;
484 struct sockaddr_in6 in6;
485 struct sockaddr_storage storage;
492 if (getsockname(fd, &local.sa, &l) < 0)
496 if (getpeername(fd, &remote.sa, &l) < 0)
499 switch (local.sa.sa_family) {
503 a = ntohl(local.in.sin_addr.s_addr),
504 b = ntohl(remote.in.sin_addr.s_addr);
507 "%u.%u.%u.%u:%u-%u.%u.%u.%u:%u",
508 a >> 24, (a >> 16) & 0xFF, (a >> 8) & 0xFF, a & 0xFF,
509 ntohs(local.in.sin_port),
510 b >> 24, (b >> 16) & 0xFF, (b >> 8) & 0xFF, b & 0xFF,
511 ntohs(remote.in.sin_port)) < 0)
518 static const char ipv4_prefix[] = {
519 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0xFF, 0xFF
522 if (memcmp(&local.in6.sin6_addr, ipv4_prefix, sizeof(ipv4_prefix)) == 0 &&
523 memcmp(&remote.in6.sin6_addr, ipv4_prefix, sizeof(ipv4_prefix)) == 0) {
525 *a = local.in6.sin6_addr.s6_addr+12,
526 *b = remote.in6.sin6_addr.s6_addr+12;
529 "%u.%u.%u.%u:%u-%u.%u.%u.%u:%u",
530 a[0], a[1], a[2], a[3],
531 ntohs(local.in6.sin6_port),
532 b[0], b[1], b[2], b[3],
533 ntohs(remote.in6.sin6_port)) < 0)
536 char a[INET6_ADDRSTRLEN], b[INET6_ADDRSTRLEN];
540 inet_ntop(AF_INET6, &local.in6.sin6_addr, a, sizeof(a)),
541 ntohs(local.in6.sin6_port),
542 inet_ntop(AF_INET6, &remote.in6.sin6_addr, b, sizeof(b)),
543 ntohs(remote.in6.sin6_port)) < 0)
554 if (getsockopt(fd, SOL_SOCKET, SO_PEERCRED, &ucred, &l) < 0)
560 (unsigned long) ucred.pid,
561 (unsigned long) ucred.uid) < 0)
568 assert_not_reached("Unhandled socket type.");
575 static void socket_close_fds(Socket *s) {
580 LIST_FOREACH(port, p, s->ports) {
584 unit_unwatch_fd(UNIT(s), &p->fd_watch);
585 close_nointr_nofail(p->fd);
587 /* One little note: we should never delete any sockets
588 * in the file system here! After all some other
589 * process we spawned might still have a reference of
590 * this fd and wants to continue to use it. Therefore
591 * we delete sockets in the file system before we
592 * create a new one, not after we stopped using
599 static void socket_apply_socket_options(Socket *s, int fd) {
604 int b = s->keep_alive;
605 if (setsockopt(fd, SOL_SOCKET, SO_KEEPALIVE, &b, sizeof(b)) < 0)
606 log_warning("SO_KEEPALIVE failed: %m");
609 if (s->priority >= 0)
610 if (setsockopt(fd, SOL_SOCKET, SO_PRIORITY, &s->priority, sizeof(s->priority)) < 0)
611 log_warning("SO_PRIORITY failed: %m");
613 if (s->receive_buffer > 0) {
614 int value = (int) s->receive_buffer;
615 if (setsockopt(fd, SOL_SOCKET, SO_RCVBUF, &value, sizeof(value)) < 0)
616 log_warning("SO_RCVBUF failed: %m");
619 if (s->send_buffer > 0) {
620 int value = (int) s->send_buffer;
621 if (setsockopt(fd, SOL_SOCKET, SO_SNDBUF, &value, sizeof(value)) < 0)
622 log_warning("SO_SNDBUF failed: %m");
626 if (setsockopt(fd, SOL_SOCKET, SO_MARK, &s->mark, sizeof(s->mark)) < 0)
627 log_warning("SO_MARK failed: %m");
630 if (setsockopt(fd, IPPROTO_IP, IP_TOS, &s->ip_tos, sizeof(s->ip_tos)) < 0)
631 log_warning("IP_TOS failed: %m");
633 if (s->ip_ttl >= 0) {
636 r = setsockopt(fd, IPPROTO_IP, IP_TTL, &s->ip_ttl, sizeof(s->ip_ttl));
637 x = setsockopt(fd, IPPROTO_IPV6, IPV6_UNICAST_HOPS, &s->ip_ttl, sizeof(s->ip_ttl));
640 log_warning("IP_TTL/IPV6_UNICAST_HOPS failed: %m");
643 if (s->tcp_congestion)
644 if (setsockopt(fd, SOL_TCP, TCP_CONGESTION, s->tcp_congestion, strlen(s->tcp_congestion)+1) < 0)
645 log_warning("TCP_CONGESTION failed: %m");
648 static void socket_apply_fifo_options(Socket *s, int fd) {
652 if (s->pipe_size > 0)
653 if (fcntl(fd, F_SETPIPE_SZ, s->pipe_size) < 0)
654 log_warning("F_SETPIPE_SZ: %m");
658 static int fifo_address_create(
660 mode_t directory_mode,
671 mkdir_parents(path, directory_mode);
673 if ((r = label_fifofile_set(path)) < 0)
676 /* Enforce the right access mode for the fifo */
677 old_mask = umask(~ socket_mode);
679 /* Include the original umask in our mask */
680 umask(~socket_mode | old_mask);
682 r = mkfifo(path, socket_mode);
690 if ((fd = open(path, O_RDWR|O_CLOEXEC|O_NOCTTY|O_NONBLOCK|O_NOFOLLOW)) < 0) {
697 if (fstat(fd, &st) < 0) {
702 if (!S_ISFIFO(st.st_mode) ||
703 (st.st_mode & 0777) != (socket_mode & ~old_mask) ||
704 st.st_uid != getuid() ||
705 st.st_gid != getgid()) {
718 close_nointr_nofail(fd);
723 static int socket_open_fds(Socket *s) {
727 bool know_label = false;
731 LIST_FOREACH(port, p, s->ports) {
736 if (p->type == SOCKET_SOCKET) {
740 if ((r = socket_instantiate_service(s)) < 0)
743 if ((r = label_get_socket_label_from_exe(s->service->exec_command[SERVICE_EXEC_START]->path, &label)) < 0)
749 if ((r = socket_address_listen(
761 socket_apply_socket_options(s, p->fd);
763 } else if (p->type == SOCKET_FIFO) {
765 if ((r = fifo_address_create(
772 socket_apply_fifo_options(s, p->fd);
775 assert_not_reached("Unknown port type");
787 static void socket_unwatch_fds(Socket *s) {
792 LIST_FOREACH(port, p, s->ports) {
796 unit_unwatch_fd(UNIT(s), &p->fd_watch);
800 static int socket_watch_fds(Socket *s) {
806 LIST_FOREACH(port, p, s->ports) {
810 p->fd_watch.socket_accept =
812 p->type == SOCKET_SOCKET &&
813 socket_address_can_accept(&p->address);
815 if ((r = unit_watch_fd(UNIT(s), p->fd, EPOLLIN, &p->fd_watch)) < 0)
822 socket_unwatch_fds(s);
826 static void socket_set_state(Socket *s, SocketState state) {
827 SocketState old_state;
830 old_state = s->state;
833 if (state != SOCKET_START_PRE &&
834 state != SOCKET_START_POST &&
835 state != SOCKET_STOP_PRE &&
836 state != SOCKET_STOP_PRE_SIGTERM &&
837 state != SOCKET_STOP_PRE_SIGKILL &&
838 state != SOCKET_STOP_POST &&
839 state != SOCKET_FINAL_SIGTERM &&
840 state != SOCKET_FINAL_SIGKILL) {
841 unit_unwatch_timer(UNIT(s), &s->timer_watch);
842 socket_unwatch_control_pid(s);
843 s->control_command = NULL;
844 s->control_command_id = _SOCKET_EXEC_COMMAND_INVALID;
847 if (state != SOCKET_LISTENING)
848 socket_unwatch_fds(s);
850 if (state != SOCKET_START_POST &&
851 state != SOCKET_LISTENING &&
852 state != SOCKET_RUNNING &&
853 state != SOCKET_STOP_PRE &&
854 state != SOCKET_STOP_PRE_SIGTERM &&
855 state != SOCKET_STOP_PRE_SIGKILL)
858 if (state != old_state)
859 log_debug("%s changed %s -> %s",
861 socket_state_to_string(old_state),
862 socket_state_to_string(state));
864 unit_notify(UNIT(s), state_translation_table[old_state], state_translation_table[state]);
867 static int socket_coldplug(Unit *u) {
868 Socket *s = SOCKET(u);
872 assert(s->state == SOCKET_DEAD);
874 if (s->deserialized_state != s->state) {
876 if (s->deserialized_state == SOCKET_START_PRE ||
877 s->deserialized_state == SOCKET_START_POST ||
878 s->deserialized_state == SOCKET_STOP_PRE ||
879 s->deserialized_state == SOCKET_STOP_PRE_SIGTERM ||
880 s->deserialized_state == SOCKET_STOP_PRE_SIGKILL ||
881 s->deserialized_state == SOCKET_STOP_POST ||
882 s->deserialized_state == SOCKET_FINAL_SIGTERM ||
883 s->deserialized_state == SOCKET_FINAL_SIGKILL) {
885 if (s->control_pid <= 0)
888 if ((r = unit_watch_pid(UNIT(s), s->control_pid)) < 0)
891 if ((r = unit_watch_timer(UNIT(s), s->timeout_usec, &s->timer_watch)) < 0)
895 if (s->deserialized_state == SOCKET_START_POST ||
896 s->deserialized_state == SOCKET_LISTENING ||
897 s->deserialized_state == SOCKET_RUNNING ||
898 s->deserialized_state == SOCKET_STOP_PRE ||
899 s->deserialized_state == SOCKET_STOP_PRE_SIGTERM ||
900 s->deserialized_state == SOCKET_STOP_PRE_SIGKILL)
901 if ((r = socket_open_fds(s)) < 0)
904 if (s->deserialized_state == SOCKET_LISTENING)
905 if ((r = socket_watch_fds(s)) < 0)
908 socket_set_state(s, s->deserialized_state);
914 static int socket_spawn(Socket *s, ExecCommand *c, pid_t *_pid) {
923 if ((r = unit_watch_timer(UNIT(s), s->timeout_usec, &s->timer_watch)) < 0)
926 if (!(argv = unit_full_printf_strv(UNIT(s), c->argv))) {
935 s->meta.manager->environment,
939 s->meta.manager->confirm_spawn,
940 s->meta.cgroup_bondings,
947 if ((r = unit_watch_pid(UNIT(s), pid)) < 0)
948 /* FIXME: we need to do something here */
956 unit_unwatch_timer(UNIT(s), &s->timer_watch);
961 static void socket_enter_dead(Socket *s, bool success) {
967 socket_set_state(s, s->failure ? SOCKET_FAILED : SOCKET_DEAD);
970 static void socket_enter_signal(Socket *s, SocketState state, bool success);
972 static void socket_enter_stop_post(Socket *s, bool success) {
979 socket_unwatch_control_pid(s);
981 s->control_command_id = SOCKET_EXEC_STOP_POST;
983 if ((s->control_command = s->exec_command[SOCKET_EXEC_STOP_POST])) {
984 if ((r = socket_spawn(s, s->control_command, &s->control_pid)) < 0)
987 socket_set_state(s, SOCKET_STOP_POST);
989 socket_enter_signal(s, SOCKET_FINAL_SIGTERM, true);
994 log_warning("%s failed to run 'stop-post' task: %s", s->meta.id, strerror(-r));
995 socket_enter_signal(s, SOCKET_FINAL_SIGTERM, false);
998 static void socket_enter_signal(Socket *s, SocketState state, bool success) {
1000 Set *pid_set = NULL;
1001 bool wait_for_exit = false;
1008 if (s->exec_context.kill_mode != KILL_NONE) {
1009 int sig = (state == SOCKET_STOP_PRE_SIGTERM || state == SOCKET_FINAL_SIGTERM) ? s->exec_context.kill_signal : SIGKILL;
1011 if (s->control_pid > 0) {
1012 if (kill(s->exec_context.kill_mode == KILL_PROCESS_GROUP ?
1014 s->control_pid, sig) < 0 && errno != ESRCH)
1016 log_warning("Failed to kill control process %li: %m", (long) s->control_pid);
1018 wait_for_exit = true;
1021 if (s->exec_context.kill_mode == KILL_CONTROL_GROUP) {
1023 if (!(pid_set = set_new(trivial_hash_func, trivial_compare_func))) {
1028 /* Exclude the control pid from being killed via the cgroup */
1029 if (s->control_pid > 0)
1030 if ((r = set_put(pid_set, LONG_TO_PTR(s->control_pid))) < 0)
1033 if ((r = cgroup_bonding_kill_list(s->meta.cgroup_bondings, sig, pid_set)) < 0) {
1034 if (r != -EAGAIN && r != -ESRCH && r != -ENOENT)
1035 log_warning("Failed to kill control group: %s", strerror(-r));
1037 wait_for_exit = true;
1043 if (wait_for_exit) {
1044 if ((r = unit_watch_timer(UNIT(s), s->timeout_usec, &s->timer_watch)) < 0)
1047 socket_set_state(s, state);
1048 } else if (state == SOCKET_STOP_PRE_SIGTERM || state == SOCKET_STOP_PRE_SIGKILL)
1049 socket_enter_stop_post(s, true);
1051 socket_enter_dead(s, true);
1056 log_warning("%s failed to kill processes: %s", s->meta.id, strerror(-r));
1058 if (state == SOCKET_STOP_PRE_SIGTERM || state == SOCKET_STOP_PRE_SIGKILL)
1059 socket_enter_stop_post(s, false);
1061 socket_enter_dead(s, false);
1067 static void socket_enter_stop_pre(Socket *s, bool success) {
1074 socket_unwatch_control_pid(s);
1076 s->control_command_id = SOCKET_EXEC_STOP_PRE;
1078 if ((s->control_command = s->exec_command[SOCKET_EXEC_STOP_PRE])) {
1079 if ((r = socket_spawn(s, s->control_command, &s->control_pid)) < 0)
1082 socket_set_state(s, SOCKET_STOP_PRE);
1084 socket_enter_stop_post(s, true);
1089 log_warning("%s failed to run 'stop-pre' task: %s", s->meta.id, strerror(-r));
1090 socket_enter_stop_post(s, false);
1093 static void socket_enter_listening(Socket *s) {
1097 if ((r = socket_watch_fds(s)) < 0) {
1098 log_warning("%s failed to watch sockets: %s", s->meta.id, strerror(-r));
1102 socket_set_state(s, SOCKET_LISTENING);
1106 socket_enter_stop_pre(s, false);
1109 static void socket_enter_start_post(Socket *s) {
1113 if ((r = socket_open_fds(s)) < 0) {
1114 log_warning("%s failed to listen on sockets: %s", s->meta.id, strerror(-r));
1118 socket_unwatch_control_pid(s);
1120 s->control_command_id = SOCKET_EXEC_START_POST;
1122 if ((s->control_command = s->exec_command[SOCKET_EXEC_START_POST])) {
1123 if ((r = socket_spawn(s, s->control_command, &s->control_pid)) < 0) {
1124 log_warning("%s failed to run 'start-post' task: %s", s->meta.id, strerror(-r));
1128 socket_set_state(s, SOCKET_START_POST);
1130 socket_enter_listening(s);
1135 socket_enter_stop_pre(s, false);
1138 static void socket_enter_start_pre(Socket *s) {
1142 socket_unwatch_control_pid(s);
1144 s->control_command_id = SOCKET_EXEC_START_PRE;
1146 if ((s->control_command = s->exec_command[SOCKET_EXEC_START_PRE])) {
1147 if ((r = socket_spawn(s, s->control_command, &s->control_pid)) < 0)
1150 socket_set_state(s, SOCKET_START_PRE);
1152 socket_enter_start_post(s);
1157 log_warning("%s failed to run 'start-pre' task: %s", s->meta.id, strerror(-r));
1158 socket_enter_dead(s, false);
1161 static void socket_enter_running(Socket *s, int cfd) {
1166 dbus_error_init(&error);
1168 /* We don't take connections anymore if we are supposed to
1169 * shut down anyway */
1170 if (unit_pending_inactive(UNIT(s))) {
1172 close_nointr_nofail(cfd);
1174 /* Flush all sockets by closing and reopening them */
1175 socket_close_fds(s);
1177 if ((r = socket_watch_fds(s)) < 0) {
1178 log_warning("%s failed to watch sockets: %s", s->meta.id, strerror(-r));
1179 socket_enter_stop_pre(s, false);
1187 if ((r = manager_add_job(s->meta.manager, JOB_START, UNIT(s->service), JOB_REPLACE, true, &error, NULL)) < 0)
1190 socket_set_state(s, SOCKET_RUNNING);
1192 char *prefix, *instance = NULL, *name;
1195 if (s->n_connections >= s->max_connections) {
1196 log_warning("Too many incoming connections (%u)", s->n_connections);
1197 close_nointr_nofail(cfd);
1201 if ((r = socket_instantiate_service(s)) < 0)
1204 if ((r = instance_from_socket(cfd, s->n_accepted, &instance)) < 0)
1207 if (!(prefix = unit_name_to_prefix(s->meta.id))) {
1213 name = unit_name_build(prefix, instance, ".service");
1222 if ((r = unit_add_name(UNIT(s->service), name)) < 0) {
1227 service = s->service;
1231 service->meta.no_gc = false;
1233 unit_choose_id(UNIT(service), name);
1236 if ((r = service_set_socket_fd(service, cfd, s)) < 0)
1240 s->n_connections ++;
1242 if ((r = manager_add_job(s->meta.manager, JOB_START, UNIT(service), JOB_REPLACE, true, &error, NULL)) < 0)
1245 /* Notify clients about changed counters */
1246 unit_add_to_dbus_queue(UNIT(s));
1252 log_warning("%s failed to queue socket startup job: %s", s->meta.id, bus_error(&error, r));
1253 socket_enter_stop_pre(s, false);
1256 close_nointr_nofail(cfd);
1258 dbus_error_free(&error);
1261 static void socket_run_next(Socket *s, bool success) {
1265 assert(s->control_command);
1266 assert(s->control_command->command_next);
1271 socket_unwatch_control_pid(s);
1273 s->control_command = s->control_command->command_next;
1275 if ((r = socket_spawn(s, s->control_command, &s->control_pid)) < 0)
1281 log_warning("%s failed to run next task: %s", s->meta.id, strerror(-r));
1283 if (s->state == SOCKET_START_POST)
1284 socket_enter_stop_pre(s, false);
1285 else if (s->state == SOCKET_STOP_POST)
1286 socket_enter_dead(s, false);
1288 socket_enter_signal(s, SOCKET_FINAL_SIGTERM, false);
1291 static int socket_start(Unit *u) {
1292 Socket *s = SOCKET(u);
1296 /* We cannot fulfill this request right now, try again later
1298 if (s->state == SOCKET_STOP_PRE ||
1299 s->state == SOCKET_STOP_PRE_SIGKILL ||
1300 s->state == SOCKET_STOP_PRE_SIGTERM ||
1301 s->state == SOCKET_STOP_POST ||
1302 s->state == SOCKET_FINAL_SIGTERM ||
1303 s->state == SOCKET_FINAL_SIGKILL)
1306 if (s->state == SOCKET_START_PRE ||
1307 s->state == SOCKET_START_POST)
1310 /* Cannot run this without the service being around */
1312 if (s->service->meta.load_state != UNIT_LOADED)
1315 /* If the service is alredy actvie we cannot start the
1317 if (s->service->state != SERVICE_DEAD &&
1318 s->service->state != SERVICE_FAILED &&
1319 s->service->state != SERVICE_AUTO_RESTART)
1323 assert(s->state == SOCKET_DEAD || s->state == SOCKET_FAILED);
1326 socket_enter_start_pre(s);
1330 static int socket_stop(Unit *u) {
1331 Socket *s = SOCKET(u);
1336 if (s->state == SOCKET_STOP_PRE ||
1337 s->state == SOCKET_STOP_PRE_SIGTERM ||
1338 s->state == SOCKET_STOP_PRE_SIGKILL ||
1339 s->state == SOCKET_STOP_POST ||
1340 s->state == SOCKET_FINAL_SIGTERM ||
1341 s->state == SOCKET_FINAL_SIGKILL)
1344 /* If there's already something running we go directly into
1346 if (s->state == SOCKET_START_PRE ||
1347 s->state == SOCKET_START_POST) {
1348 socket_enter_signal(s, SOCKET_STOP_PRE_SIGTERM, true);
1352 assert(s->state == SOCKET_LISTENING || s->state == SOCKET_RUNNING);
1354 socket_enter_stop_pre(s, true);
1358 static int socket_serialize(Unit *u, FILE *f, FDSet *fds) {
1359 Socket *s = SOCKET(u);
1367 unit_serialize_item(u, f, "state", socket_state_to_string(s->state));
1368 unit_serialize_item(u, f, "failure", yes_no(s->failure));
1369 unit_serialize_item_format(u, f, "n-accepted", "%u", s->n_accepted);
1371 if (s->control_pid > 0)
1372 unit_serialize_item_format(u, f, "control-pid", "%lu", (unsigned long) s->control_pid);
1374 if (s->control_command_id >= 0)
1375 unit_serialize_item(u, f, "control-command", socket_exec_command_to_string(s->control_command_id));
1377 LIST_FOREACH(port, p, s->ports) {
1383 if ((copy = fdset_put_dup(fds, p->fd)) < 0)
1386 if (p->type == SOCKET_SOCKET) {
1389 if ((r = socket_address_print(&p->address, &t)) < 0)
1392 unit_serialize_item_format(u, f, "socket", "%i %i %s", copy, p->address.type, t);
1395 assert(p->type == SOCKET_FIFO);
1396 unit_serialize_item_format(u, f, "fifo", "%i %s", copy, p->path);
1403 static int socket_deserialize_item(Unit *u, const char *key, const char *value, FDSet *fds) {
1404 Socket *s = SOCKET(u);
1411 if (streq(key, "state")) {
1414 if ((state = socket_state_from_string(value)) < 0)
1415 log_debug("Failed to parse state value %s", value);
1417 s->deserialized_state = state;
1418 } else if (streq(key, "failure")) {
1421 if ((b = parse_boolean(value)) < 0)
1422 log_debug("Failed to parse failure value %s", value);
1424 s->failure = b || s->failure;
1426 } else if (streq(key, "n-accepted")) {
1429 if (safe_atou(value, &k) < 0)
1430 log_debug("Failed to parse n-accepted value %s", value);
1433 } else if (streq(key, "control-pid")) {
1436 if (parse_pid(value, &pid) < 0)
1437 log_debug("Failed to parse control-pid value %s", value);
1439 s->control_pid = pid;
1440 } else if (streq(key, "control-command")) {
1441 SocketExecCommand id;
1443 if ((id = socket_exec_command_from_string(value)) < 0)
1444 log_debug("Failed to parse exec-command value %s", value);
1446 s->control_command_id = id;
1447 s->control_command = s->exec_command[id];
1449 } else if (streq(key, "fifo")) {
1453 if (sscanf(value, "%i %n", &fd, &skip) < 1 || fd < 0 || !fdset_contains(fds, fd))
1454 log_debug("Failed to parse fifo value %s", value);
1457 LIST_FOREACH(port, p, s->ports)
1458 if (streq(p->path, value+skip))
1463 close_nointr_nofail(p->fd);
1464 p->fd = fdset_remove(fds, fd);
1468 } else if (streq(key, "socket")) {
1469 int fd, type, skip = 0;
1472 if (sscanf(value, "%i %i %n", &fd, &type, &skip) < 2 || fd < 0 || type < 0 || !fdset_contains(fds, fd))
1473 log_debug("Failed to parse socket value %s", value);
1476 LIST_FOREACH(port, p, s->ports)
1477 if (socket_address_is(&p->address, value+skip, type))
1482 close_nointr_nofail(p->fd);
1483 p->fd = fdset_remove(fds, fd);
1488 log_debug("Unknown serialization key '%s'", key);
1493 static UnitActiveState socket_active_state(Unit *u) {
1496 return state_translation_table[SOCKET(u)->state];
1499 static const char *socket_sub_state_to_string(Unit *u) {
1502 return socket_state_to_string(SOCKET(u)->state);
1505 static bool socket_check_gc(Unit *u) {
1506 Socket *s = SOCKET(u);
1510 return s->n_connections > 0;
1513 static void socket_fd_event(Unit *u, int fd, uint32_t events, Watch *w) {
1514 Socket *s = SOCKET(u);
1520 if (s->state != SOCKET_LISTENING)
1523 log_debug("Incoming traffic on %s", u->meta.id);
1525 if (events != EPOLLIN) {
1526 log_error("Got invalid poll event on socket.");
1530 if (w->socket_accept) {
1533 if ((cfd = accept4(fd, NULL, NULL, SOCK_NONBLOCK)) < 0) {
1538 log_error("Failed to accept socket: %m");
1545 socket_apply_socket_options(s, cfd);
1548 socket_enter_running(s, cfd);
1552 socket_enter_stop_pre(s, false);
1555 static void socket_sigchld_event(Unit *u, pid_t pid, int code, int status) {
1556 Socket *s = SOCKET(u);
1562 if (pid != s->control_pid)
1567 success = is_clean_exit(code, status);
1569 if (s->control_command) {
1570 exec_status_exit(&s->control_command->exec_status, pid, code, status);
1572 if (s->control_command->ignore)
1576 log_full(success ? LOG_DEBUG : LOG_NOTICE,
1577 "%s control process exited, code=%s status=%i", u->meta.id, sigchld_code_to_string(code), status);
1578 s->failure = s->failure || !success;
1580 if (s->control_command && s->control_command->command_next && success) {
1581 log_debug("%s running next command for state %s", u->meta.id, socket_state_to_string(s->state));
1582 socket_run_next(s, success);
1584 s->control_command = NULL;
1585 s->control_command_id = _SOCKET_EXEC_COMMAND_INVALID;
1587 /* No further commands for this step, so let's figure
1588 * out what to do next */
1590 log_debug("%s got final SIGCHLD for state %s", u->meta.id, socket_state_to_string(s->state));
1594 case SOCKET_START_PRE:
1596 socket_enter_start_post(s);
1598 socket_enter_signal(s, SOCKET_FINAL_SIGTERM, false);
1601 case SOCKET_START_POST:
1603 socket_enter_listening(s);
1605 socket_enter_stop_pre(s, false);
1608 case SOCKET_STOP_PRE:
1609 case SOCKET_STOP_PRE_SIGTERM:
1610 case SOCKET_STOP_PRE_SIGKILL:
1611 socket_enter_stop_post(s, success);
1614 case SOCKET_STOP_POST:
1615 case SOCKET_FINAL_SIGTERM:
1616 case SOCKET_FINAL_SIGKILL:
1617 socket_enter_dead(s, success);
1621 assert_not_reached("Uh, control process died at wrong time.");
1625 /* Notify clients about changed exit status */
1626 unit_add_to_dbus_queue(u);
1629 static void socket_timer_event(Unit *u, uint64_t elapsed, Watch *w) {
1630 Socket *s = SOCKET(u);
1633 assert(elapsed == 1);
1634 assert(w == &s->timer_watch);
1638 case SOCKET_START_PRE:
1639 log_warning("%s starting timed out. Terminating.", u->meta.id);
1640 socket_enter_signal(s, SOCKET_FINAL_SIGTERM, false);
1642 case SOCKET_START_POST:
1643 log_warning("%s starting timed out. Stopping.", u->meta.id);
1644 socket_enter_stop_pre(s, false);
1647 case SOCKET_STOP_PRE:
1648 log_warning("%s stopping timed out. Terminating.", u->meta.id);
1649 socket_enter_signal(s, SOCKET_STOP_PRE_SIGTERM, false);
1652 case SOCKET_STOP_PRE_SIGTERM:
1653 log_warning("%s stopping timed out. Killing.", u->meta.id);
1654 socket_enter_signal(s, SOCKET_STOP_PRE_SIGKILL, false);
1657 case SOCKET_STOP_PRE_SIGKILL:
1658 log_warning("%s still around after SIGKILL. Ignoring.", u->meta.id);
1659 socket_enter_stop_post(s, false);
1662 case SOCKET_STOP_POST:
1663 log_warning("%s stopping timed out (2). Terminating.", u->meta.id);
1664 socket_enter_signal(s, SOCKET_FINAL_SIGTERM, false);
1667 case SOCKET_FINAL_SIGTERM:
1668 log_warning("%s stopping timed out (2). Killing.", u->meta.id);
1669 socket_enter_signal(s, SOCKET_FINAL_SIGKILL, false);
1672 case SOCKET_FINAL_SIGKILL:
1673 log_warning("%s still around after SIGKILL (2). Entering failed mode.", u->meta.id);
1674 socket_enter_dead(s, false);
1678 assert_not_reached("Timeout at wrong time.");
1682 int socket_collect_fds(Socket *s, int **fds, unsigned *n_fds) {
1691 /* Called from the service code for requesting our fds */
1694 LIST_FOREACH(port, p, s->ports)
1698 if (!(rfds = new(int, rn_fds)))
1702 LIST_FOREACH(port, p, s->ports)
1706 assert(k == rn_fds);
1714 void socket_notify_service_dead(Socket *s) {
1717 /* The service is dead. Dang!
1719 * This is strictly for one-instance-for-all-connections
1722 if (s->state == SOCKET_RUNNING) {
1723 log_debug("%s got notified about service death.", s->meta.id);
1724 socket_enter_listening(s);
1728 void socket_connection_unref(Socket *s) {
1731 /* The service is dead. Yay!
1733 * This is strictly for one-onstance-per-connection
1736 assert(s->n_connections > 0);
1739 log_debug("%s: One connection closed, %u left.", s->meta.id, s->n_connections);
1742 static void socket_reset_failed(Unit *u) {
1743 Socket *s = SOCKET(u);
1747 if (s->state == SOCKET_FAILED)
1748 socket_set_state(s, SOCKET_DEAD);
1753 static const char* const socket_state_table[_SOCKET_STATE_MAX] = {
1754 [SOCKET_DEAD] = "dead",
1755 [SOCKET_START_PRE] = "start-pre",
1756 [SOCKET_START_POST] = "start-post",
1757 [SOCKET_LISTENING] = "listening",
1758 [SOCKET_RUNNING] = "running",
1759 [SOCKET_STOP_PRE] = "stop-pre",
1760 [SOCKET_STOP_PRE_SIGTERM] = "stop-pre-sigterm",
1761 [SOCKET_STOP_PRE_SIGKILL] = "stop-pre-sigkill",
1762 [SOCKET_STOP_POST] = "stop-post",
1763 [SOCKET_FINAL_SIGTERM] = "final-sigterm",
1764 [SOCKET_FINAL_SIGKILL] = "final-sigkill",
1765 [SOCKET_FAILED] = "failed"
1768 DEFINE_STRING_TABLE_LOOKUP(socket_state, SocketState);
1770 static const char* const socket_exec_command_table[_SOCKET_EXEC_COMMAND_MAX] = {
1771 [SOCKET_EXEC_START_PRE] = "StartPre",
1772 [SOCKET_EXEC_START_POST] = "StartPost",
1773 [SOCKET_EXEC_STOP_PRE] = "StopPre",
1774 [SOCKET_EXEC_STOP_POST] = "StopPost"
1777 DEFINE_STRING_TABLE_LOOKUP(socket_exec_command, SocketExecCommand);
1779 const UnitVTable socket_vtable = {
1780 .suffix = ".socket",
1782 .init = socket_init,
1783 .done = socket_done,
1784 .load = socket_load,
1786 .coldplug = socket_coldplug,
1788 .dump = socket_dump,
1790 .start = socket_start,
1791 .stop = socket_stop,
1793 .serialize = socket_serialize,
1794 .deserialize_item = socket_deserialize_item,
1796 .active_state = socket_active_state,
1797 .sub_state_to_string = socket_sub_state_to_string,
1799 .check_gc = socket_check_gc,
1801 .fd_event = socket_fd_event,
1802 .sigchld_event = socket_sigchld_event,
1803 .timer_event = socket_timer_event,
1805 .reset_failed = socket_reset_failed,
1807 .bus_interface = "org.freedesktop.systemd1.Socket",
1808 .bus_message_handler = bus_socket_message_handler,
1809 .bus_invalidating_properties = bus_socket_invalidating_properties