1 /*-*- Mode: C; c-basic-offset: 8 -*-*/
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>
34 #include "load-dropin.h"
35 #include "load-fragment.h"
37 #include "unit-name.h"
38 #include "dbus-socket.h"
41 static const UnitActiveState state_translation_table[_SOCKET_STATE_MAX] = {
42 [SOCKET_DEAD] = UNIT_INACTIVE,
43 [SOCKET_START_PRE] = UNIT_ACTIVATING,
44 [SOCKET_START_POST] = UNIT_ACTIVATING,
45 [SOCKET_LISTENING] = UNIT_ACTIVE,
46 [SOCKET_RUNNING] = UNIT_ACTIVE,
47 [SOCKET_STOP_PRE] = UNIT_DEACTIVATING,
48 [SOCKET_STOP_PRE_SIGTERM] = UNIT_DEACTIVATING,
49 [SOCKET_STOP_PRE_SIGKILL] = UNIT_DEACTIVATING,
50 [SOCKET_STOP_POST] = UNIT_DEACTIVATING,
51 [SOCKET_FINAL_SIGTERM] = UNIT_DEACTIVATING,
52 [SOCKET_FINAL_SIGKILL] = UNIT_DEACTIVATING,
53 [SOCKET_MAINTENANCE] = UNIT_MAINTENANCE
56 static void socket_init(Unit *u) {
57 Socket *s = SOCKET(u);
60 assert(u->meta.load_state == UNIT_STUB);
62 s->backlog = SOMAXCONN;
63 s->timeout_usec = DEFAULT_TIMEOUT_USEC;
64 s->directory_mode = 0755;
65 s->socket_mode = 0666;
67 s->max_connections = 64;
69 s->keep_alive = false;
71 s->receive_buffer = 0;
79 exec_context_init(&s->exec_context);
81 s->control_command_id = _SOCKET_EXEC_COMMAND_INVALID;
84 static void socket_unwatch_control_pid(Socket *s) {
87 if (s->control_pid <= 0)
90 unit_unwatch_pid(UNIT(s), s->control_pid);
94 static void socket_done(Unit *u) {
95 Socket *s = SOCKET(u);
101 while ((p = s->ports)) {
102 LIST_REMOVE(SocketPort, port, s->ports, p);
105 unit_unwatch_fd(UNIT(s), &p->fd_watch);
106 close_nointr_nofail(p->fd);
113 exec_context_done(&s->exec_context);
114 exec_command_free_array(s->exec_command, _SOCKET_EXEC_COMMAND_MAX);
115 s->control_command = NULL;
117 socket_unwatch_control_pid(s);
121 free(s->bind_to_device);
122 s->bind_to_device = NULL;
124 unit_unwatch_timer(u, &s->timer_watch);
126 /* Make sure no service instance refers to us anymore. */
127 LIST_FOREACH(units_per_type, i, u->meta.manager->units_per_type[UNIT_SERVICE]) {
128 Service *service = (Service *) i;
130 if (service->socket == s)
131 service->socket = NULL;
135 static bool have_non_accept_socket(Socket *s) {
143 LIST_FOREACH(port, p, s->ports) {
145 if (p->type != SOCKET_SOCKET)
148 if (!socket_address_can_accept(&p->address))
155 static int socket_verify(Socket *s) {
158 if (s->meta.load_state != UNIT_LOADED)
162 log_error("%s lacks Listen setting. Refusing.", s->meta.id);
166 if (s->accept && s->max_connections <= 0) {
167 log_error("%s's MaxConnection setting too small. Refusing.", s->meta.id);
171 if (s->exec_context.pam_name && s->kill_mode != KILL_CONTROL_GROUP) {
172 log_error("%s has PAM enabled. Kill mode must be set to 'control-group'. Refusing.", s->meta.id);
179 static bool socket_needs_mount(Socket *s, const char *prefix) {
184 LIST_FOREACH(port, p, s->ports) {
186 if (p->type == SOCKET_SOCKET) {
187 if (socket_address_needs_mount(&p->address, prefix))
190 assert(p->type == SOCKET_FIFO);
191 if (path_startswith(p->path, prefix))
199 int socket_add_one_mount_link(Socket *s, Mount *m) {
205 if (s->meta.load_state != UNIT_LOADED ||
206 m->meta.load_state != UNIT_LOADED)
209 if (!socket_needs_mount(s, m->where))
212 if ((r = unit_add_dependency(UNIT(m), UNIT_BEFORE, UNIT(s), true)) < 0)
215 if ((r = unit_add_dependency(UNIT(s), UNIT_REQUIRES, UNIT(m), true)) < 0)
221 static int socket_add_mount_links(Socket *s) {
227 LIST_FOREACH(units_per_type, other, s->meta.manager->units_per_type[UNIT_MOUNT])
228 if ((r = socket_add_one_mount_link(s, (Mount*) other)) < 0)
234 static int socket_add_device_link(Socket *s) {
240 if (!s->bind_to_device)
243 if (asprintf(&t, "/sys/subsystem/net/devices/%s", s->bind_to_device) < 0)
246 r = unit_add_node_link(UNIT(s), t, false);
252 static int socket_load(Unit *u) {
253 Socket *s = SOCKET(u);
257 assert(u->meta.load_state == UNIT_STUB);
259 if ((r = unit_load_fragment_and_dropin(u)) < 0)
262 /* This is a new unit? Then let's add in some extras */
263 if (u->meta.load_state == UNIT_LOADED) {
265 if (have_non_accept_socket(s)) {
266 if ((r = unit_load_related_unit(u, ".service", (Unit**) &s->service)))
269 if ((r = unit_add_dependency(u, UNIT_BEFORE, UNIT(s->service), true)) < 0)
273 if ((r = socket_add_mount_links(s)) < 0)
276 if ((r = socket_add_device_link(s)) < 0)
279 if ((r = unit_add_exec_dependencies(u, &s->exec_context)) < 0)
282 if ((r = unit_add_default_cgroup(u)) < 0)
286 return socket_verify(s);
289 static const char* listen_lookup(int type) {
291 if (type == SOCK_STREAM)
292 return "ListenStream";
293 else if (type == SOCK_DGRAM)
294 return "ListenDatagram";
295 else if (type == SOCK_SEQPACKET)
296 return "ListenSequentialPacket";
298 assert_not_reached("Unknown socket type");
302 static void socket_dump(Unit *u, FILE *f, const char *prefix) {
305 Socket *s = SOCKET(u);
313 p2 = strappend(prefix, "\t");
314 prefix2 = p2 ? p2 : prefix;
317 "%sSocket State: %s\n"
318 "%sBindIPv6Only: %s\n"
321 "%sSocketMode: %04o\n"
322 "%sDirectoryMode: %04o\n"
325 prefix, socket_state_to_string(s->state),
326 prefix, socket_address_bind_ipv6_only_to_string(s->bind_ipv6_only),
328 prefix, kill_mode_to_string(s->kill_mode),
329 prefix, s->socket_mode,
330 prefix, s->directory_mode,
331 prefix, yes_no(s->keep_alive),
332 prefix, yes_no(s->free_bind));
334 if (s->control_pid > 0)
336 "%sControl PID: %lu\n",
337 prefix, (unsigned long) s->control_pid);
339 if (s->bind_to_device)
341 "%sBindToDevice: %s\n",
342 prefix, s->bind_to_device);
347 "%sNConnections: %u\n"
348 "%sMaxConnections: %u\n",
349 prefix, s->n_accepted,
350 prefix, s->n_connections,
351 prefix, s->max_connections);
353 if (s->priority >= 0)
356 prefix, s->priority);
358 if (s->receive_buffer > 0)
360 "%sReceiveBuffer: %zu\n",
361 prefix, s->receive_buffer);
363 if (s->send_buffer > 0)
365 "%sSendBuffer: %zu\n",
366 prefix, s->send_buffer);
378 if (s->pipe_size > 0)
381 prefix, s->pipe_size);
388 LIST_FOREACH(port, p, s->ports) {
390 if (p->type == SOCKET_SOCKET) {
395 if ((r = socket_address_print(&p->address, &k)) < 0)
400 fprintf(f, "%s%s: %s\n", prefix, listen_lookup(p->address.type), k);
403 fprintf(f, "%sListenFIFO: %s\n", prefix, p->path);
406 exec_context_dump(&s->exec_context, f, prefix);
408 for (c = 0; c < _SOCKET_EXEC_COMMAND_MAX; c++) {
409 if (!s->exec_command[c])
412 fprintf(f, "%s-> %s:\n",
413 prefix, socket_exec_command_to_string(c));
415 exec_command_dump_list(s->exec_command[c], f, prefix2);
421 static int instance_from_socket(int fd, unsigned nr, char **instance) {
426 struct sockaddr_un un;
427 struct sockaddr_in in;
428 struct sockaddr_in6 in6;
429 struct sockaddr_storage storage;
436 if (getsockname(fd, &local.sa, &l) < 0)
440 if (getpeername(fd, &remote.sa, &l) < 0)
443 switch (local.sa.sa_family) {
447 a = ntohl(local.in.sin_addr.s_addr),
448 b = ntohl(remote.in.sin_addr.s_addr);
451 "%u-%u.%u.%u.%u:%u-%u.%u.%u.%u:%u",
453 a >> 24, (a >> 16) & 0xFF, (a >> 8) & 0xFF, a & 0xFF,
454 ntohs(local.in.sin_port),
455 b >> 24, (b >> 16) & 0xFF, (b >> 8) & 0xFF, b & 0xFF,
456 ntohs(remote.in.sin_port)) < 0)
463 static const char ipv4_prefix[] = {
464 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0xFF, 0xFF
467 if (memcmp(&local.in6.sin6_addr, ipv4_prefix, sizeof(ipv4_prefix)) == 0 &&
468 memcmp(&remote.in6.sin6_addr, ipv4_prefix, sizeof(ipv4_prefix)) == 0) {
470 *a = local.in6.sin6_addr.s6_addr+12,
471 *b = remote.in6.sin6_addr.s6_addr+12;
474 "%u-%u.%u.%u.%u:%u-%u.%u.%u.%u:%u",
476 a[0], a[1], a[2], a[3],
477 ntohs(local.in6.sin6_port),
478 b[0], b[1], b[2], b[3],
479 ntohs(remote.in6.sin6_port)) < 0)
482 char a[INET6_ADDRSTRLEN], b[INET6_ADDRSTRLEN];
487 inet_ntop(AF_INET6, &local.in6.sin6_addr, a, sizeof(a)),
488 ntohs(local.in6.sin6_port),
489 inet_ntop(AF_INET6, &remote.in6.sin6_addr, b, sizeof(b)),
490 ntohs(remote.in6.sin6_port)) < 0)
501 if (getsockopt(fd, SOL_SOCKET, SO_PEERCRED, &ucred, &l) < 0)
507 (unsigned long) ucred.pid,
508 (unsigned long) ucred.uid) < 0)
515 assert_not_reached("Unhandled socket type.");
522 static void socket_close_fds(Socket *s) {
527 LIST_FOREACH(port, p, s->ports) {
531 unit_unwatch_fd(UNIT(s), &p->fd_watch);
532 close_nointr_nofail(p->fd);
534 /* One little note: we should never delete any sockets
535 * in the file system here! After all some other
536 * process we spawned might still have a reference of
537 * this fd and wants to continue to use it. Therefore
538 * we delete sockets in the file system before we
539 * create a new one, not after we stopped using
546 static void socket_apply_socket_options(Socket *s, int fd) {
551 int b = s->keep_alive;
552 if (setsockopt(fd, SOL_SOCKET, SO_KEEPALIVE, &b, sizeof(b)) < 0)
553 log_warning("SO_KEEPALIVE failed: %m");
556 if (s->priority >= 0)
557 if (setsockopt(fd, SOL_SOCKET, SO_PRIORITY, &s->priority, sizeof(s->priority)) < 0)
558 log_warning("SO_PRIORITY failed: %m");
560 if (s->receive_buffer > 0) {
561 int value = (int) s->receive_buffer;
562 if (setsockopt(fd, SOL_SOCKET, SO_RCVBUF, &value, sizeof(value)) < 0)
563 log_warning("SO_RCVBUF failed: %m");
566 if (s->send_buffer > 0) {
567 int value = (int) s->send_buffer;
568 if (setsockopt(fd, SOL_SOCKET, SO_SNDBUF, &value, sizeof(value)) < 0)
569 log_warning("SO_SNDBUF failed: %m");
573 if (setsockopt(fd, SOL_SOCKET, SO_MARK, &s->mark, sizeof(s->mark)) < 0)
574 log_warning("SO_MARK failed: %m");
577 if (setsockopt(fd, IPPROTO_IP, IP_TOS, &s->ip_tos, sizeof(s->ip_tos)) < 0)
578 log_warning("IP_TOS failed: %m");
580 if (s->ip_ttl >= 0) {
583 r = setsockopt(fd, IPPROTO_IP, IP_TTL, &s->ip_ttl, sizeof(s->ip_ttl));
584 x = setsockopt(fd, IPPROTO_IPV6, IPV6_UNICAST_HOPS, &s->ip_ttl, sizeof(s->ip_ttl));
587 log_warning("IP_TTL/IPV6_UNICAST_HOPS failed: %m");
591 static void socket_apply_pipe_options(Socket *s, int fd) {
595 if (s->pipe_size > 0)
596 if (fcntl(fd, F_SETPIPE_SZ, s->pipe_size) < 0)
597 log_warning("F_SETPIPE_SZ: %m");
600 static int socket_open_fds(Socket *s) {
606 LIST_FOREACH(port, p, s->ports) {
611 if (p->type == SOCKET_SOCKET) {
613 if ((r = socket_address_listen(
624 socket_apply_socket_options(s, p->fd);
628 assert(p->type == SOCKET_FIFO);
630 mkdir_parents(p->path, s->directory_mode);
632 if (mkfifo(p->path, s->socket_mode) < 0 && errno != EEXIST) {
637 if ((p->fd = open(p->path, O_RDWR|O_CLOEXEC|O_NOCTTY|O_NONBLOCK|O_NOFOLLOW)) < 0) {
642 if (fstat(p->fd, &st) < 0) {
647 /* FIXME verify user, access mode */
649 if (!S_ISFIFO(st.st_mode)) {
654 socket_apply_pipe_options(s, p->fd);
665 static void socket_unwatch_fds(Socket *s) {
670 LIST_FOREACH(port, p, s->ports) {
674 unit_unwatch_fd(UNIT(s), &p->fd_watch);
678 static int socket_watch_fds(Socket *s) {
684 LIST_FOREACH(port, p, s->ports) {
688 p->fd_watch.socket_accept =
690 p->type == SOCKET_SOCKET &&
691 socket_address_can_accept(&p->address);
693 if ((r = unit_watch_fd(UNIT(s), p->fd, EPOLLIN, &p->fd_watch)) < 0)
700 socket_unwatch_fds(s);
704 static void socket_set_state(Socket *s, SocketState state) {
705 SocketState old_state;
708 old_state = s->state;
711 if (state != SOCKET_START_PRE &&
712 state != SOCKET_START_POST &&
713 state != SOCKET_STOP_PRE &&
714 state != SOCKET_STOP_PRE_SIGTERM &&
715 state != SOCKET_STOP_PRE_SIGKILL &&
716 state != SOCKET_STOP_POST &&
717 state != SOCKET_FINAL_SIGTERM &&
718 state != SOCKET_FINAL_SIGKILL) {
719 unit_unwatch_timer(UNIT(s), &s->timer_watch);
720 socket_unwatch_control_pid(s);
721 s->control_command = NULL;
722 s->control_command_id = _SOCKET_EXEC_COMMAND_INVALID;
725 if (state != SOCKET_LISTENING)
726 socket_unwatch_fds(s);
728 if (state != SOCKET_START_POST &&
729 state != SOCKET_LISTENING &&
730 state != SOCKET_RUNNING &&
731 state != SOCKET_STOP_PRE &&
732 state != SOCKET_STOP_PRE_SIGTERM &&
733 state != SOCKET_STOP_PRE_SIGKILL)
736 if (state != old_state)
737 log_debug("%s changed %s -> %s",
739 socket_state_to_string(old_state),
740 socket_state_to_string(state));
742 unit_notify(UNIT(s), state_translation_table[old_state], state_translation_table[state]);
745 static int socket_coldplug(Unit *u) {
746 Socket *s = SOCKET(u);
750 assert(s->state == SOCKET_DEAD);
752 if (s->deserialized_state != s->state) {
754 if (s->deserialized_state == SOCKET_START_PRE ||
755 s->deserialized_state == SOCKET_START_POST ||
756 s->deserialized_state == SOCKET_STOP_PRE ||
757 s->deserialized_state == SOCKET_STOP_PRE_SIGTERM ||
758 s->deserialized_state == SOCKET_STOP_PRE_SIGKILL ||
759 s->deserialized_state == SOCKET_STOP_POST ||
760 s->deserialized_state == SOCKET_FINAL_SIGTERM ||
761 s->deserialized_state == SOCKET_FINAL_SIGKILL) {
763 if (s->control_pid <= 0)
766 if ((r = unit_watch_pid(UNIT(s), s->control_pid)) < 0)
769 if ((r = unit_watch_timer(UNIT(s), s->timeout_usec, &s->timer_watch)) < 0)
773 if (s->deserialized_state == SOCKET_START_POST ||
774 s->deserialized_state == SOCKET_LISTENING ||
775 s->deserialized_state == SOCKET_RUNNING ||
776 s->deserialized_state == SOCKET_STOP_PRE ||
777 s->deserialized_state == SOCKET_STOP_PRE_SIGTERM ||
778 s->deserialized_state == SOCKET_STOP_PRE_SIGKILL)
779 if ((r = socket_open_fds(s)) < 0)
782 if (s->deserialized_state == SOCKET_LISTENING)
783 if ((r = socket_watch_fds(s)) < 0)
786 socket_set_state(s, s->deserialized_state);
792 static int socket_spawn(Socket *s, ExecCommand *c, pid_t *_pid) {
801 if ((r = unit_watch_timer(UNIT(s), s->timeout_usec, &s->timer_watch)) < 0)
804 if (!(argv = unit_full_printf_strv(UNIT(s), c->argv))) {
813 s->meta.manager->environment,
816 s->meta.manager->confirm_spawn,
817 s->meta.cgroup_bondings,
824 if ((r = unit_watch_pid(UNIT(s), pid)) < 0)
825 /* FIXME: we need to do something here */
833 unit_unwatch_timer(UNIT(s), &s->timer_watch);
838 static void socket_enter_dead(Socket *s, bool success) {
844 socket_set_state(s, s->failure ? SOCKET_MAINTENANCE : SOCKET_DEAD);
847 static void socket_enter_signal(Socket *s, SocketState state, bool success);
849 static void socket_enter_stop_post(Socket *s, bool success) {
856 socket_unwatch_control_pid(s);
858 s->control_command_id = SOCKET_EXEC_STOP_POST;
860 if ((s->control_command = s->exec_command[SOCKET_EXEC_STOP_POST])) {
861 if ((r = socket_spawn(s, s->control_command, &s->control_pid)) < 0)
864 socket_set_state(s, SOCKET_STOP_POST);
866 socket_enter_signal(s, SOCKET_FINAL_SIGTERM, true);
871 log_warning("%s failed to run 'stop-post' task: %s", s->meta.id, strerror(-r));
872 socket_enter_signal(s, SOCKET_FINAL_SIGTERM, false);
875 static void socket_enter_signal(Socket *s, SocketState state, bool success) {
884 if (s->kill_mode != KILL_NONE) {
885 int sig = (state == SOCKET_STOP_PRE_SIGTERM || state == SOCKET_FINAL_SIGTERM) ? SIGTERM : SIGKILL;
887 if (s->kill_mode == KILL_CONTROL_GROUP) {
889 if ((r = cgroup_bonding_kill_list(s->meta.cgroup_bondings, sig)) < 0) {
890 if (r != -EAGAIN && r != -ESRCH)
896 if (!sent && s->control_pid > 0)
897 if (kill(s->kill_mode == KILL_PROCESS ? s->control_pid : -s->control_pid, sig) < 0 && errno != ESRCH) {
903 if (sent && s->control_pid > 0) {
904 if ((r = unit_watch_timer(UNIT(s), s->timeout_usec, &s->timer_watch)) < 0)
907 socket_set_state(s, state);
908 } else if (state == SOCKET_STOP_PRE_SIGTERM || state == SOCKET_STOP_PRE_SIGKILL)
909 socket_enter_stop_post(s, true);
911 socket_enter_dead(s, true);
916 log_warning("%s failed to kill processes: %s", s->meta.id, strerror(-r));
918 if (state == SOCKET_STOP_PRE_SIGTERM || state == SOCKET_STOP_PRE_SIGKILL)
919 socket_enter_stop_post(s, false);
921 socket_enter_dead(s, false);
924 static void socket_enter_stop_pre(Socket *s, bool success) {
931 socket_unwatch_control_pid(s);
933 s->control_command_id = SOCKET_EXEC_STOP_PRE;
935 if ((s->control_command = s->exec_command[SOCKET_EXEC_STOP_PRE])) {
936 if ((r = socket_spawn(s, s->control_command, &s->control_pid)) < 0)
939 socket_set_state(s, SOCKET_STOP_PRE);
941 socket_enter_stop_post(s, true);
946 log_warning("%s failed to run 'stop-pre' task: %s", s->meta.id, strerror(-r));
947 socket_enter_stop_post(s, false);
950 static void socket_enter_listening(Socket *s) {
954 if ((r = socket_watch_fds(s)) < 0) {
955 log_warning("%s failed to watch sockets: %s", s->meta.id, strerror(-r));
959 socket_set_state(s, SOCKET_LISTENING);
963 socket_enter_stop_pre(s, false);
966 static void socket_enter_start_post(Socket *s) {
970 if ((r = socket_open_fds(s)) < 0) {
971 log_warning("%s failed to listen on sockets: %s", s->meta.id, strerror(-r));
975 socket_unwatch_control_pid(s);
977 s->control_command_id = SOCKET_EXEC_START_POST;
979 if ((s->control_command = s->exec_command[SOCKET_EXEC_START_POST])) {
980 if ((r = socket_spawn(s, s->control_command, &s->control_pid)) < 0) {
981 log_warning("%s failed to run 'start-post' task: %s", s->meta.id, strerror(-r));
985 socket_set_state(s, SOCKET_START_POST);
987 socket_enter_listening(s);
992 socket_enter_stop_pre(s, false);
995 static void socket_enter_start_pre(Socket *s) {
999 socket_unwatch_control_pid(s);
1001 s->control_command_id = SOCKET_EXEC_START_PRE;
1003 if ((s->control_command = s->exec_command[SOCKET_EXEC_START_PRE])) {
1004 if ((r = socket_spawn(s, s->control_command, &s->control_pid)) < 0)
1007 socket_set_state(s, SOCKET_START_PRE);
1009 socket_enter_start_post(s);
1014 log_warning("%s failed to run 'start-pre' task: %s", s->meta.id, strerror(-r));
1015 socket_enter_dead(s, false);
1018 static void socket_enter_running(Socket *s, int cfd) {
1024 if ((r = manager_add_job(s->meta.manager, JOB_START, UNIT(s->service), JOB_REPLACE, true, NULL)) < 0)
1027 socket_set_state(s, SOCKET_RUNNING);
1030 char *prefix, *instance, *name;
1032 if (s->n_connections >= s->max_connections) {
1033 log_warning("Too many incoming connections (%u)", s->n_connections);
1034 close_nointr_nofail(cfd);
1038 if ((r = instance_from_socket(cfd, s->n_accepted++, &instance)) < 0)
1041 if (!(prefix = unit_name_to_prefix(s->meta.id))) {
1047 name = unit_name_build(prefix, instance, ".service");
1056 r = manager_load_unit(s->meta.manager, name, NULL, &u);
1062 if ((r = service_set_socket_fd(SERVICE(u), cfd, s)) < 0)
1067 s->n_connections ++;
1069 if ((r = manager_add_job(u->meta.manager, JOB_START, u, JOB_REPLACE, true, NULL)) < 0)
1076 log_warning("%s failed to queue socket startup job: %s", s->meta.id, strerror(-r));
1077 socket_enter_stop_pre(s, false);
1080 close_nointr_nofail(cfd);
1083 static void socket_run_next(Socket *s, bool success) {
1087 assert(s->control_command);
1088 assert(s->control_command->command_next);
1093 socket_unwatch_control_pid(s);
1095 s->control_command = s->control_command->command_next;
1097 if ((r = socket_spawn(s, s->control_command, &s->control_pid)) < 0)
1103 log_warning("%s failed to run next task: %s", s->meta.id, strerror(-r));
1105 if (s->state == SOCKET_START_POST)
1106 socket_enter_stop_pre(s, false);
1107 else if (s->state == SOCKET_STOP_POST)
1108 socket_enter_dead(s, false);
1110 socket_enter_signal(s, SOCKET_FINAL_SIGTERM, false);
1113 static int socket_start(Unit *u) {
1114 Socket *s = SOCKET(u);
1118 /* We cannot fulfill this request right now, try again later
1120 if (s->state == SOCKET_STOP_PRE ||
1121 s->state == SOCKET_STOP_PRE_SIGKILL ||
1122 s->state == SOCKET_STOP_PRE_SIGTERM ||
1123 s->state == SOCKET_STOP_POST ||
1124 s->state == SOCKET_FINAL_SIGTERM ||
1125 s->state == SOCKET_FINAL_SIGKILL)
1128 if (s->state == SOCKET_START_PRE ||
1129 s->state == SOCKET_START_POST)
1132 /* Cannot run this without the service being around */
1134 if (s->service->meta.load_state != UNIT_LOADED)
1137 /* If the service is alredy actvie we cannot start the
1139 if (s->service->state != SERVICE_DEAD &&
1140 s->service->state != SERVICE_MAINTENANCE &&
1141 s->service->state != SERVICE_AUTO_RESTART)
1145 assert(s->state == SOCKET_DEAD || s->state == SOCKET_MAINTENANCE);
1148 socket_enter_start_pre(s);
1152 static int socket_stop(Unit *u) {
1153 Socket *s = SOCKET(u);
1157 /* We cannot fulfill this request right now, try again later
1159 if (s->state == SOCKET_START_PRE ||
1160 s->state == SOCKET_START_POST)
1164 if (s->state == SOCKET_STOP_PRE ||
1165 s->state == SOCKET_STOP_PRE_SIGTERM ||
1166 s->state == SOCKET_STOP_PRE_SIGKILL ||
1167 s->state == SOCKET_STOP_POST ||
1168 s->state == SOCKET_FINAL_SIGTERM ||
1169 s->state == SOCKET_FINAL_SIGTERM)
1172 assert(s->state == SOCKET_LISTENING || s->state == SOCKET_RUNNING);
1174 socket_enter_stop_pre(s, true);
1178 static int socket_serialize(Unit *u, FILE *f, FDSet *fds) {
1179 Socket *s = SOCKET(u);
1187 unit_serialize_item(u, f, "state", socket_state_to_string(s->state));
1188 unit_serialize_item(u, f, "failure", yes_no(s->failure));
1189 unit_serialize_item_format(u, f, "n-accepted", "%u", s->n_accepted);
1191 if (s->control_pid > 0)
1192 unit_serialize_item_format(u, f, "control-pid", "%lu", (unsigned long) s->control_pid);
1194 if (s->control_command_id >= 0)
1195 unit_serialize_item(u, f, "control-command", socket_exec_command_to_string(s->control_command_id));
1197 LIST_FOREACH(port, p, s->ports) {
1203 if ((copy = fdset_put_dup(fds, p->fd)) < 0)
1206 if (p->type == SOCKET_SOCKET) {
1209 if ((r = socket_address_print(&p->address, &t)) < 0)
1212 unit_serialize_item_format(u, f, "socket", "%i %i %s", copy, p->address.type, t);
1215 assert(p->type == SOCKET_FIFO);
1216 unit_serialize_item_format(u, f, "fifo", "%i %s", copy, p->path);
1223 static int socket_deserialize_item(Unit *u, const char *key, const char *value, FDSet *fds) {
1224 Socket *s = SOCKET(u);
1232 if (streq(key, "state")) {
1235 if ((state = socket_state_from_string(value)) < 0)
1236 log_debug("Failed to parse state value %s", value);
1238 s->deserialized_state = state;
1239 } else if (streq(key, "failure")) {
1242 if ((b = parse_boolean(value)) < 0)
1243 log_debug("Failed to parse failure value %s", value);
1245 s->failure = b || s->failure;
1247 } else if (streq(key, "n-accepted")) {
1250 if ((r = safe_atou(value, &k)) < 0)
1251 log_debug("Failed to parse n-accepted value %s", value);
1254 } else if (streq(key, "control-pid")) {
1257 if ((r = parse_pid(value, &pid)) < 0)
1258 log_debug("Failed to parse control-pid value %s", value);
1260 s->control_pid = pid;
1261 } else if (streq(key, "control-command")) {
1262 SocketExecCommand id;
1264 if ((id = socket_exec_command_from_string(value)) < 0)
1265 log_debug("Failed to parse exec-command value %s", value);
1267 s->control_command_id = id;
1268 s->control_command = s->exec_command[id];
1270 } else if (streq(key, "fifo")) {
1274 if (sscanf(value, "%i %n", &fd, &skip) < 1 || fd < 0 || !fdset_contains(fds, fd))
1275 log_debug("Failed to parse fifo value %s", value);
1278 LIST_FOREACH(port, p, s->ports)
1279 if (streq(p->path, value+skip))
1284 close_nointr_nofail(p->fd);
1285 p->fd = fdset_remove(fds, fd);
1289 } else if (streq(key, "socket")) {
1290 int fd, type, skip = 0;
1293 if (sscanf(value, "%i %i %n", &fd, &type, &skip) < 2 || fd < 0 || type < 0 || !fdset_contains(fds, fd))
1294 log_debug("Failed to parse socket value %s", value);
1297 LIST_FOREACH(port, p, s->ports)
1298 if (socket_address_is(&p->address, value+skip, type))
1303 close_nointr_nofail(p->fd);
1304 p->fd = fdset_remove(fds, fd);
1309 log_debug("Unknown serialization key '%s'", key);
1314 static UnitActiveState socket_active_state(Unit *u) {
1317 return state_translation_table[SOCKET(u)->state];
1320 static const char *socket_sub_state_to_string(Unit *u) {
1323 return socket_state_to_string(SOCKET(u)->state);
1326 static bool socket_check_gc(Unit *u) {
1327 Socket *s = SOCKET(u);
1331 return s->n_connections > 0;
1334 static void socket_fd_event(Unit *u, int fd, uint32_t events, Watch *w) {
1335 Socket *s = SOCKET(u);
1341 if (s->state != SOCKET_LISTENING)
1344 log_debug("Incoming traffic on %s", u->meta.id);
1346 if (events != EPOLLIN) {
1347 log_error("Got invalid poll event on socket.");
1351 if (w->socket_accept) {
1354 if ((cfd = accept4(fd, NULL, NULL, SOCK_NONBLOCK)) < 0) {
1359 log_error("Failed to accept socket: %m");
1366 socket_apply_socket_options(s, cfd);
1369 socket_enter_running(s, cfd);
1373 socket_enter_stop_pre(s, false);
1376 static void socket_sigchld_event(Unit *u, pid_t pid, int code, int status) {
1377 Socket *s = SOCKET(u);
1383 if (pid != s->control_pid)
1388 success = is_clean_exit(code, status);
1389 s->failure = s->failure || !success;
1391 if (s->control_command)
1392 exec_status_fill(&s->control_command->exec_status, pid, code, status);
1394 log_debug("%s control process exited, code=%s status=%i", u->meta.id, sigchld_code_to_string(code), status);
1396 if (s->control_command && s->control_command->command_next && success) {
1397 log_debug("%s running next command for state %s", u->meta.id, socket_state_to_string(s->state));
1398 socket_run_next(s, success);
1400 s->control_command = NULL;
1401 s->control_command_id = _SOCKET_EXEC_COMMAND_INVALID;
1403 /* No further commands for this step, so let's figure
1404 * out what to do next */
1406 log_debug("%s got final SIGCHLD for state %s", u->meta.id, socket_state_to_string(s->state));
1410 case SOCKET_START_PRE:
1412 socket_enter_start_post(s);
1414 socket_enter_signal(s, SOCKET_FINAL_SIGTERM, false);
1417 case SOCKET_START_POST:
1419 socket_enter_listening(s);
1421 socket_enter_stop_pre(s, false);
1424 case SOCKET_STOP_PRE:
1425 case SOCKET_STOP_PRE_SIGTERM:
1426 case SOCKET_STOP_PRE_SIGKILL:
1427 socket_enter_stop_post(s, success);
1430 case SOCKET_STOP_POST:
1431 case SOCKET_FINAL_SIGTERM:
1432 case SOCKET_FINAL_SIGKILL:
1433 socket_enter_dead(s, success);
1437 assert_not_reached("Uh, control process died at wrong time.");
1442 static void socket_timer_event(Unit *u, uint64_t elapsed, Watch *w) {
1443 Socket *s = SOCKET(u);
1446 assert(elapsed == 1);
1447 assert(w == &s->timer_watch);
1451 case SOCKET_START_PRE:
1452 log_warning("%s starting timed out. Terminating.", u->meta.id);
1453 socket_enter_signal(s, SOCKET_FINAL_SIGTERM, false);
1455 case SOCKET_START_POST:
1456 log_warning("%s starting timed out. Stopping.", u->meta.id);
1457 socket_enter_stop_pre(s, false);
1460 case SOCKET_STOP_PRE:
1461 log_warning("%s stopping timed out. Terminating.", u->meta.id);
1462 socket_enter_signal(s, SOCKET_STOP_PRE_SIGTERM, false);
1465 case SOCKET_STOP_PRE_SIGTERM:
1466 log_warning("%s stopping timed out. Killing.", u->meta.id);
1467 socket_enter_signal(s, SOCKET_STOP_PRE_SIGKILL, false);
1470 case SOCKET_STOP_PRE_SIGKILL:
1471 log_warning("%s still around after SIGKILL. Ignoring.", u->meta.id);
1472 socket_enter_stop_post(s, false);
1475 case SOCKET_STOP_POST:
1476 log_warning("%s stopping timed out (2). Terminating.", u->meta.id);
1477 socket_enter_signal(s, SOCKET_FINAL_SIGTERM, false);
1480 case SOCKET_FINAL_SIGTERM:
1481 log_warning("%s stopping timed out (2). Killing.", u->meta.id);
1482 socket_enter_signal(s, SOCKET_FINAL_SIGKILL, false);
1485 case SOCKET_FINAL_SIGKILL:
1486 log_warning("%s still around after SIGKILL (2). Entering maintenance mode.", u->meta.id);
1487 socket_enter_dead(s, false);
1491 assert_not_reached("Timeout at wrong time.");
1495 int socket_collect_fds(Socket *s, int **fds, unsigned *n_fds) {
1504 /* Called from the service code for requesting our fds */
1507 LIST_FOREACH(port, p, s->ports)
1511 if (!(rfds = new(int, rn_fds)) < 0)
1515 LIST_FOREACH(port, p, s->ports)
1519 assert(k == rn_fds);
1527 void socket_notify_service_dead(Socket *s) {
1530 /* The service is dead. Dang!
1532 * This is strictly for one-instance-for-all-connections
1535 if (s->state == SOCKET_RUNNING) {
1536 log_debug("%s got notified about service death.", s->meta.id);
1537 socket_enter_listening(s);
1541 void socket_connection_unref(Socket *s) {
1544 /* The service is dead. Yay!
1546 * This is strictly for one-onstance-per-connection
1549 assert(s->n_connections > 0);
1552 log_debug("%s: One connection closed, %u left.", s->meta.id, s->n_connections);
1555 static const char* const socket_state_table[_SOCKET_STATE_MAX] = {
1556 [SOCKET_DEAD] = "dead",
1557 [SOCKET_START_PRE] = "start-pre",
1558 [SOCKET_START_POST] = "start-post",
1559 [SOCKET_LISTENING] = "listening",
1560 [SOCKET_RUNNING] = "running",
1561 [SOCKET_STOP_PRE] = "stop-pre",
1562 [SOCKET_STOP_PRE_SIGTERM] = "stop-pre-sigterm",
1563 [SOCKET_STOP_PRE_SIGKILL] = "stop-pre-sigkill",
1564 [SOCKET_STOP_POST] = "stop-post",
1565 [SOCKET_FINAL_SIGTERM] = "final-sigterm",
1566 [SOCKET_FINAL_SIGKILL] = "final-sigkill",
1567 [SOCKET_MAINTENANCE] = "maintenance"
1570 DEFINE_STRING_TABLE_LOOKUP(socket_state, SocketState);
1572 static const char* const socket_exec_command_table[_SOCKET_EXEC_COMMAND_MAX] = {
1573 [SOCKET_EXEC_START_PRE] = "StartPre",
1574 [SOCKET_EXEC_START_POST] = "StartPost",
1575 [SOCKET_EXEC_STOP_PRE] = "StopPre",
1576 [SOCKET_EXEC_STOP_POST] = "StopPost"
1579 DEFINE_STRING_TABLE_LOOKUP(socket_exec_command, SocketExecCommand);
1581 const UnitVTable socket_vtable = {
1582 .suffix = ".socket",
1584 .init = socket_init,
1585 .done = socket_done,
1586 .load = socket_load,
1588 .coldplug = socket_coldplug,
1590 .dump = socket_dump,
1592 .start = socket_start,
1593 .stop = socket_stop,
1595 .serialize = socket_serialize,
1596 .deserialize_item = socket_deserialize_item,
1598 .active_state = socket_active_state,
1599 .sub_state_to_string = socket_sub_state_to_string,
1601 .check_gc = socket_check_gc,
1603 .fd_event = socket_fd_event,
1604 .sigchld_event = socket_sigchld_event,
1605 .timer_event = socket_timer_event,
1607 .bus_message_handler = bus_socket_message_handler