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>
33 #include "load-dropin.h"
34 #include "load-fragment.h"
36 static const UnitActiveState state_translation_table[_SOCKET_STATE_MAX] = {
37 [SOCKET_DEAD] = UNIT_INACTIVE,
38 [SOCKET_START_PRE] = UNIT_ACTIVATING,
39 [SOCKET_START_POST] = UNIT_ACTIVATING,
40 [SOCKET_LISTENING] = UNIT_ACTIVE,
41 [SOCKET_RUNNING] = UNIT_ACTIVE,
42 [SOCKET_STOP_PRE] = UNIT_DEACTIVATING,
43 [SOCKET_STOP_PRE_SIGTERM] = UNIT_DEACTIVATING,
44 [SOCKET_STOP_PRE_SIGKILL] = UNIT_DEACTIVATING,
45 [SOCKET_STOP_POST] = UNIT_DEACTIVATING,
46 [SOCKET_STOP_POST_SIGTERM] = UNIT_DEACTIVATING,
47 [SOCKET_STOP_POST_SIGKILL] = UNIT_DEACTIVATING,
48 [SOCKET_MAINTAINANCE] = UNIT_INACTIVE,
51 static const char* const state_string_table[_SOCKET_STATE_MAX] = {
52 [SOCKET_DEAD] = "dead",
53 [SOCKET_START_PRE] = "start-pre",
54 [SOCKET_START_POST] = "start-post",
55 [SOCKET_LISTENING] = "listening",
56 [SOCKET_RUNNING] = "running",
57 [SOCKET_STOP_PRE] = "stop-pre",
58 [SOCKET_STOP_PRE_SIGTERM] = "stop-pre-sigterm",
59 [SOCKET_STOP_PRE_SIGKILL] = "stop-pre-sigkill",
60 [SOCKET_STOP_POST] = "stop-post",
61 [SOCKET_STOP_POST_SIGTERM] = "stop-post-sigterm",
62 [SOCKET_STOP_POST_SIGKILL] = "stop-post-sigkill",
63 [SOCKET_MAINTAINANCE] = "maintainance"
66 static void socket_done(Unit *u) {
67 Socket *s = SOCKET(u);
72 while ((p = s->ports)) {
73 LIST_REMOVE(SocketPort, port, s->ports, p);
81 exec_context_done(&s->exec_context);
82 exec_command_free_array(s->exec_command, _SOCKET_EXEC_MAX);
83 s->control_command = NULL;
85 if (s->control_pid > 0) {
86 unit_unwatch_pid(u, s->control_pid);
92 free(s->bind_to_device);
94 unit_unwatch_timer(u, &s->timer_watch);
97 static int socket_init(Unit *u, UnitLoadState *new_state) {
98 Socket *s = SOCKET(u);
102 /* First, reset everything to the defaults, in case this is a
106 s->timer_watch.type = WATCH_INVALID;
107 s->bind_ipv6_only = false;
108 s->backlog = SOMAXCONN;
109 s->timeout_usec = DEFAULT_TIMEOUT_USEC;
110 s->directory_mode = 0755;
111 s->socket_mode = 0666;
112 exec_context_init(&s->exec_context);
114 if ((r = unit_load_fragment(u, new_state)) < 0)
117 if (*new_state == UNIT_STUB)
120 if ((r = unit_load_dropin(unit_follow_merge(u))) < 0)
123 /* This is a new unit? Then let's add in some extras */
124 if (*new_state == UNIT_LOADED) {
126 if (!(t = unit_name_change_suffix(unit_id(u), ".service")))
129 r = manager_load_unit(u->meta.manager, t, (Unit**) &s->service);
135 if ((r = unit_add_dependency(u, UNIT_BEFORE, UNIT(s->service))) < 0)
138 if ((r = unit_add_exec_dependencies(u, &s->exec_context)) < 0)
141 if ((r = unit_add_default_cgroup(u)) < 0)
148 static const char* listen_lookup(int type) {
150 if (type == SOCK_STREAM)
151 return "ListenStream";
152 else if (type == SOCK_DGRAM)
153 return "ListenDatagram";
154 else if (type == SOCK_SEQPACKET)
155 return "ListenSequentialPacket";
157 assert_not_reached("Unknown socket type");
161 static void socket_dump(Unit *u, FILE *f, const char *prefix) {
163 static const char* const command_table[_SOCKET_EXEC_MAX] = {
164 [SOCKET_EXEC_START_PRE] = "StartPre",
165 [SOCKET_EXEC_START_POST] = "StartPost",
166 [SOCKET_EXEC_STOP_PRE] = "StopPre",
167 [SOCKET_EXEC_STOP_POST] = "StopPost"
171 Socket *s = SOCKET(u);
179 p2 = strappend(prefix, "\t");
180 prefix2 = p2 ? p2 : prefix;
183 "%sSocket State: %s\n"
184 "%sBindIPv6Only: %s\n"
186 "%sSocketMode: %04o\n"
187 "%sDirectoryMode: %04o\n",
188 prefix, state_string_table[s->state],
189 prefix, yes_no(s->bind_ipv6_only),
191 prefix, s->socket_mode,
192 prefix, s->directory_mode);
194 if (s->bind_to_device)
196 "%sBindToDevice: %s\n",
197 prefix, s->bind_to_device);
199 LIST_FOREACH(port, p, s->ports) {
201 if (p->type == SOCKET_SOCKET) {
206 if ((r = socket_address_print(&p->address, &k)) < 0)
211 fprintf(f, "%s%s: %s\n", prefix, listen_lookup(p->address.type), k);
214 fprintf(f, "%sListenFIFO: %s\n", prefix, p->path);
217 exec_context_dump(&s->exec_context, f, prefix);
219 for (c = 0; c < _SOCKET_EXEC_MAX; c++) {
220 if (!s->exec_command[c])
223 fprintf(f, "%s→ %s:\n",
224 prefix, command_table[c]);
226 exec_command_dump_list(s->exec_command[c], f, prefix2);
232 static void socket_close_fds(Socket *s) {
237 LIST_FOREACH(port, p, s->ports) {
241 unit_unwatch_fd(UNIT(s), &p->fd_watch);
242 assert_se(close_nointr(p->fd) >= 0);
248 static int socket_open_fds(Socket *s) {
254 LIST_FOREACH(port, p, s->ports) {
259 if (p->type == SOCKET_SOCKET) {
261 if ((r = socket_address_listen(
273 assert(p->type == SOCKET_FIFO);
275 mkdir_parents(p->path, s->directory_mode);
277 if (mkfifo(p->path, s->socket_mode) < 0 && errno != EEXIST) {
282 if ((p->fd = open(p->path, O_RDWR|O_CLOEXEC|O_NOCTTY|O_NONBLOCK|O_NOFOLLOW)) < 0) {
287 if (fstat(p->fd, &st) < 0) {
292 /* FIXME verify user, access mode */
294 if (!S_ISFIFO(st.st_mode)) {
308 static void socket_unwatch_fds(Socket *s) {
313 LIST_FOREACH(port, p, s->ports) {
317 unit_unwatch_fd(UNIT(s), &p->fd_watch);
321 static int socket_watch_fds(Socket *s) {
327 LIST_FOREACH(port, p, s->ports) {
331 if ((r = unit_watch_fd(UNIT(s), p->fd, EPOLLIN, &p->fd_watch)) < 0)
338 socket_unwatch_fds(s);
342 static void socket_set_state(Socket *s, SocketState state) {
343 SocketState old_state;
346 old_state = s->state;
349 if (state != SOCKET_START_PRE &&
350 state != SOCKET_START_POST &&
351 state != SOCKET_STOP_PRE &&
352 state != SOCKET_STOP_PRE_SIGTERM &&
353 state != SOCKET_STOP_PRE_SIGKILL &&
354 state != SOCKET_STOP_POST &&
355 state != SOCKET_STOP_POST_SIGTERM &&
356 state != SOCKET_STOP_POST_SIGKILL)
357 unit_unwatch_timer(UNIT(s), &s->timer_watch);
359 if (state != SOCKET_START_PRE &&
360 state != SOCKET_START_POST &&
361 state != SOCKET_STOP_PRE &&
362 state != SOCKET_STOP_PRE_SIGTERM &&
363 state != SOCKET_STOP_PRE_SIGKILL &&
364 state != SOCKET_STOP_POST &&
365 state != SOCKET_STOP_POST_SIGTERM &&
366 state != SOCKET_STOP_POST_SIGKILL)
367 if (s->control_pid > 0) {
368 unit_unwatch_pid(UNIT(s), s->control_pid);
372 if (state != SOCKET_START_PRE &&
373 state != SOCKET_START_POST &&
374 state != SOCKET_STOP_PRE &&
375 state != SOCKET_STOP_POST)
376 s->control_command = NULL;
378 if (state != SOCKET_START_POST &&
379 state != SOCKET_LISTENING &&
380 state != SOCKET_RUNNING &&
381 state != SOCKET_STOP_PRE &&
382 state != SOCKET_STOP_PRE_SIGTERM &&
383 state != SOCKET_STOP_PRE_SIGKILL)
386 if (state != SOCKET_LISTENING)
387 socket_unwatch_fds(s);
389 log_debug("%s changed %s → %s", unit_id(UNIT(s)), state_string_table[old_state], state_string_table[state]);
391 unit_notify(UNIT(s), state_translation_table[old_state], state_translation_table[state]);
394 static int socket_spawn(Socket *s, ExecCommand *c, bool timeout, pid_t *_pid) {
403 if ((r = unit_watch_timer(UNIT(s), s->timeout_usec, &s->timer_watch)) < 0)
406 unit_unwatch_timer(UNIT(s), &s->timer_watch);
408 if ((r = exec_spawn(c,
413 UNIT(s)->meta.cgroup_bondings,
417 if ((r = unit_watch_pid(UNIT(s), pid)) < 0)
418 /* FIXME: we need to do something here */
427 unit_unwatch_timer(UNIT(s), &s->timer_watch);
432 static void socket_enter_dead(Socket *s, bool success) {
438 socket_set_state(s, s->failure ? SOCKET_MAINTAINANCE : SOCKET_DEAD);
441 static void socket_enter_stop_post(Socket *s, bool success) {
448 if ((s->control_command = s->exec_command[SOCKET_EXEC_STOP_POST]))
449 if ((r = socket_spawn(s, s->control_command, true, &s->control_pid)) < 0)
452 socket_set_state(s, SOCKET_STOP_POST);
454 if (!s->control_command)
455 socket_enter_dead(s, true);
460 log_warning("%s failed to run stop-post executable: %s", unit_id(UNIT(s)), strerror(-r));
461 socket_enter_dead(s, false);
464 static void socket_enter_signal(Socket *s, SocketState state, bool success) {
472 if (s->control_pid > 0) {
475 sig = (state == SOCKET_STOP_PRE_SIGTERM || state == SOCKET_STOP_POST_SIGTERM) ? SIGTERM : SIGKILL;
477 if (kill(s->control_pid, sig) < 0 && errno != ESRCH) {
483 socket_set_state(s, state);
485 if (s->control_pid <= 0)
486 socket_enter_dead(s, true);
491 log_warning("%s failed to kill processes: %s", unit_id(UNIT(s)), strerror(-r));
493 if (state == SOCKET_STOP_PRE_SIGTERM || state == SOCKET_STOP_PRE_SIGKILL)
494 socket_enter_stop_post(s, false);
496 socket_enter_dead(s, false);
499 static void socket_enter_stop_pre(Socket *s, bool success) {
506 if ((s->control_command = s->exec_command[SOCKET_EXEC_STOP_PRE]))
507 if ((r = socket_spawn(s, s->control_command, true, &s->control_pid)) < 0)
510 socket_set_state(s, SOCKET_STOP_PRE);
512 if (!s->control_command)
513 socket_enter_stop_post(s, true);
518 log_warning("%s failed to run stop-pre executable: %s", unit_id(UNIT(s)), strerror(-r));
519 socket_enter_stop_post(s, false);
522 static void socket_enter_listening(Socket *s) {
526 if ((r = socket_watch_fds(s)) < 0) {
527 log_warning("%s failed to watch sockets: %s", unit_id(UNIT(s)), strerror(-r));
531 socket_set_state(s, SOCKET_LISTENING);
535 socket_enter_stop_pre(s, false);
538 static void socket_enter_start_post(Socket *s) {
542 if ((r = socket_open_fds(s)) < 0) {
543 log_warning("%s failed to listen on sockets: %s", unit_id(UNIT(s)), strerror(-r));
547 if ((s->control_command = s->exec_command[SOCKET_EXEC_START_POST]))
548 if ((r = socket_spawn(s, s->control_command, true, &s->control_pid)) < 0) {
549 log_warning("%s failed to run start-post executable: %s", unit_id(UNIT(s)), strerror(-r));
553 socket_set_state(s, SOCKET_START_POST);
555 if (!s->control_command)
556 socket_enter_listening(s);
561 socket_enter_stop_pre(s, false);
564 static void socket_enter_start_pre(Socket *s) {
568 if ((s->control_command = s->exec_command[SOCKET_EXEC_START_PRE]))
569 if ((r = socket_spawn(s, s->control_command, true, &s->control_pid)) < 0)
572 socket_set_state(s, SOCKET_START_PRE);
574 if (!s->control_command)
575 socket_enter_start_post(s);
580 log_warning("%s failed to run start-pre exectuable: %s", unit_id(UNIT(s)), strerror(-r));
581 socket_enter_dead(s, false);
584 static void socket_enter_running(Socket *s) {
589 if ((r = manager_add_job(UNIT(s)->meta.manager, JOB_START, UNIT(s->service), JOB_REPLACE, true, NULL)) < 0)
592 socket_set_state(s, SOCKET_RUNNING);
596 log_warning("%s failed to queue socket startup job: %s", unit_id(UNIT(s)), strerror(-r));
597 socket_enter_dead(s, false);
600 static void socket_run_next(Socket *s, bool success) {
604 assert(s->control_command);
605 assert(s->control_command->command_next);
610 s->control_command = s->control_command->command_next;
612 if ((r = socket_spawn(s, s->control_command, true, &s->control_pid)) < 0)
618 if (s->state == SOCKET_STOP_PRE)
619 socket_enter_stop_post(s, false);
620 else if (s->state == SOCKET_STOP_POST)
621 socket_enter_dead(s, false);
623 socket_enter_stop_pre(s, false);
626 static int socket_start(Unit *u) {
627 Socket *s = SOCKET(u);
631 /* We cannot fulfill this request right now, try again later
633 if (s->state == SOCKET_STOP_PRE ||
634 s->state == SOCKET_STOP_PRE_SIGKILL ||
635 s->state == SOCKET_STOP_PRE_SIGTERM ||
636 s->state == SOCKET_STOP_POST ||
637 s->state == SOCKET_STOP_POST_SIGTERM ||
638 s->state == SOCKET_STOP_POST_SIGKILL)
641 if (s->state == SOCKET_START_PRE ||
642 s->state == SOCKET_START_POST)
645 /* Cannot run this without the service being around */
646 if (s->service->meta.load_state != UNIT_LOADED)
649 assert(s->state == SOCKET_DEAD || s->state == SOCKET_MAINTAINANCE);
652 socket_enter_start_pre(s);
656 static int socket_stop(Unit *u) {
657 Socket *s = SOCKET(u);
661 /* We cannot fulfill this request right now, try again later
663 if (s->state == SOCKET_START_PRE ||
664 s->state == SOCKET_START_POST)
667 assert(s->state == SOCKET_LISTENING || s->state == SOCKET_RUNNING);
669 socket_enter_stop_pre(s, true);
673 static UnitActiveState socket_active_state(Unit *u) {
676 return state_translation_table[SOCKET(u)->state];
679 static void socket_fd_event(Unit *u, int fd, uint32_t events, Watch *w) {
680 Socket *s = SOCKET(u);
684 log_debug("Incoming traffic on %s", unit_id(u));
686 if (events != EPOLLIN)
687 socket_enter_stop_pre(s, false);
689 socket_enter_running(s);
692 static void socket_sigchld_event(Unit *u, pid_t pid, int code, int status) {
693 Socket *s = SOCKET(u);
699 success = code == CLD_EXITED && status == 0;
700 s->failure = s->failure || !success;
702 assert(s->control_pid == pid);
703 assert(s->control_command);
705 exec_status_fill(&s->control_command->exec_status, pid, code, status);
708 log_debug("%s control process exited, code=%s status=%i", unit_id(u), sigchld_code_to_string(code), status);
710 if (s->control_command->command_next &&
711 (success || (s->state == SOCKET_STOP_PRE || s->state == SOCKET_STOP_POST))) {
712 log_debug("%s running next command for the state %s", unit_id(u), state_string_table[s->state]);
713 socket_run_next(s, success);
715 /* No further commands for this step, so let's figure
716 * out what to do next */
718 log_debug("%s got final SIGCHLD for state %s", unit_id(u), state_string_table[s->state]);
722 case SOCKET_START_PRE:
724 socket_enter_start_post(s);
726 socket_enter_stop_pre(s, false);
729 case SOCKET_START_POST:
731 socket_enter_listening(s);
733 socket_enter_stop_pre(s, false);
736 case SOCKET_STOP_PRE:
737 case SOCKET_STOP_PRE_SIGTERM:
738 case SOCKET_STOP_PRE_SIGKILL:
739 socket_enter_stop_post(s, success);
742 case SOCKET_STOP_POST:
743 case SOCKET_STOP_POST_SIGTERM:
744 case SOCKET_STOP_POST_SIGKILL:
745 socket_enter_dead(s, success);
749 assert_not_reached("Uh, control process died at wrong time.");
754 static void socket_timer_event(Unit *u, uint64_t elapsed, Watch *w) {
755 Socket *s = SOCKET(u);
758 assert(elapsed == 1);
760 assert(w == &s->timer_watch);
764 case SOCKET_START_PRE:
765 case SOCKET_START_POST:
766 log_warning("%s operation timed out. Stopping.", unit_id(u));
767 socket_enter_stop_pre(s, false);
770 case SOCKET_STOP_PRE:
771 log_warning("%s stopping timed out. Terminating.", unit_id(u));
772 socket_enter_signal(s, SOCKET_STOP_PRE_SIGTERM, false);
775 case SOCKET_STOP_PRE_SIGTERM:
776 log_warning("%s stopping timed out. Killing.", unit_id(u));
777 socket_enter_signal(s, SOCKET_STOP_PRE_SIGKILL, false);
780 case SOCKET_STOP_PRE_SIGKILL:
781 log_warning("%s still around after SIGKILL. Ignoring.", unit_id(u));
782 socket_enter_stop_post(s, false);
785 case SOCKET_STOP_POST:
786 log_warning("%s stopping timed out (2). Terminating.", unit_id(u));
787 socket_enter_signal(s, SOCKET_STOP_POST_SIGTERM, false);
790 case SOCKET_STOP_POST_SIGTERM:
791 log_warning("%s stopping timed out (2). Killing.", unit_id(u));
792 socket_enter_signal(s, SOCKET_STOP_POST_SIGKILL, false);
795 case SOCKET_STOP_POST_SIGKILL:
796 log_warning("%s still around after SIGKILL (2). Entering maintainance mode.", unit_id(u));
797 socket_enter_dead(s, false);
801 assert_not_reached("Timeout at wrong time.");
805 int socket_collect_fds(Socket *s, int **fds, unsigned *n_fds) {
814 /* Called from the service code for requesting our fds */
817 LIST_FOREACH(port, p, s->ports)
821 if (!(rfds = new(int, rn_fds)) < 0)
825 LIST_FOREACH(port, p, s->ports)
837 void socket_notify_service_dead(Socket *s) {
840 /* The service is dead. Dang. */
842 if (s->state == SOCKET_RUNNING) {
843 log_debug("%s got notified about service death.", unit_id(UNIT(s)));
844 socket_enter_listening(s);
848 const UnitVTable socket_vtable = {
856 .start = socket_start,
859 .active_state = socket_active_state,
861 .fd_event = socket_fd_event,
862 .sigchld_event = socket_sigchld_event,
863 .timer_event = socket_timer_event