1 /*-*- Mode: C; c-basic-offset: 8 -*-*/
15 static const UnitActiveState state_translation_table[_SOCKET_STATE_MAX] = {
16 [SOCKET_DEAD] = UNIT_INACTIVE,
17 [SOCKET_START_PRE] = UNIT_ACTIVATING,
18 [SOCKET_START_POST] = UNIT_ACTIVATING,
19 [SOCKET_LISTENING] = UNIT_ACTIVE,
20 [SOCKET_RUNNING] = UNIT_ACTIVE,
21 [SOCKET_STOP_PRE] = UNIT_DEACTIVATING,
22 [SOCKET_STOP_PRE_SIGTERM] = UNIT_DEACTIVATING,
23 [SOCKET_STOP_PRE_SIGKILL] = UNIT_DEACTIVATING,
24 [SOCKET_STOP_POST] = UNIT_DEACTIVATING,
25 [SOCKET_STOP_POST_SIGTERM] = UNIT_DEACTIVATING,
26 [SOCKET_STOP_POST_SIGKILL] = UNIT_DEACTIVATING,
27 [SOCKET_MAINTAINANCE] = UNIT_INACTIVE,
30 static const char* const state_string_table[_SOCKET_STATE_MAX] = {
31 [SOCKET_DEAD] = "dead",
32 [SOCKET_START_PRE] = "start-pre",
33 [SOCKET_START_POST] = "start-post",
34 [SOCKET_LISTENING] = "listening",
35 [SOCKET_RUNNING] = "running",
36 [SOCKET_STOP_PRE] = "stop-pre",
37 [SOCKET_STOP_PRE_SIGTERM] = "stop-pre-sigterm",
38 [SOCKET_STOP_PRE_SIGKILL] = "stop-pre-sigkill",
39 [SOCKET_STOP_POST] = "stop-post",
40 [SOCKET_STOP_POST_SIGTERM] = "stop-post-sigterm",
41 [SOCKET_STOP_POST_SIGKILL] = "stop-post-sigkill",
42 [SOCKET_MAINTAINANCE] = "maintainance"
45 static void socket_done(Unit *u) {
46 Socket *s = SOCKET(u);
51 while ((p = s->ports)) {
52 LIST_REMOVE(SocketPort, port, s->ports, p);
60 exec_context_done(&s->exec_context);
61 exec_command_free_array(s->exec_command, _SOCKET_EXEC_MAX);
62 s->control_command = NULL;
64 if (s->control_pid > 0) {
65 unit_unwatch_pid(u, s->control_pid);
71 free(s->bind_to_device);
73 unit_unwatch_timer(u, &s->timer_watch);
76 static int socket_init(Unit *u) {
77 Socket *s = SOCKET(u);
81 /* First, reset everything to the defaults, in case this is a
85 s->timer_watch.type = WATCH_INVALID;
86 s->bind_ipv6_only = false;
87 s->backlog = SOMAXCONN;
88 s->timeout_usec = DEFAULT_TIMEOUT_USEC;
89 exec_context_init(&s->exec_context);
91 if ((r = unit_load_fragment_and_dropin(u)) < 0)
94 if (!(t = unit_name_change_suffix(unit_id(u), ".service"))) {
99 r = manager_load_unit(u->meta.manager, t, (Unit**) &s->service);
105 if ((r = unit_add_dependency(u, UNIT_BEFORE, UNIT(s->service))) < 0)
115 static const char* listen_lookup(int type) {
117 if (type == SOCK_STREAM)
118 return "ListenStream";
119 else if (type == SOCK_DGRAM)
120 return "ListenDatagram";
121 else if (type == SOCK_SEQPACKET)
122 return "ListenSequentialPacket";
124 assert_not_reached("Unknown socket type");
128 static void socket_dump(Unit *u, FILE *f, const char *prefix) {
130 static const char* const command_table[_SOCKET_EXEC_MAX] = {
131 [SOCKET_EXEC_START_PRE] = "StartPre",
132 [SOCKET_EXEC_START_POST] = "StartPost",
133 [SOCKET_EXEC_STOP_PRE] = "StopPre",
134 [SOCKET_EXEC_STOP_POST] = "StopPost"
138 Socket *s = SOCKET(u);
145 prefix2 = strappend(prefix, "\t");
150 "%sSocket State: %s\n"
151 "%sBindIPv6Only: %s\n"
153 prefix, state_string_table[s->state],
154 prefix, yes_no(s->bind_ipv6_only),
157 if (s->bind_to_device)
159 "%sBindToDevice: %s\n",
160 prefix, s->bind_to_device);
162 LIST_FOREACH(port, p, s->ports) {
164 if (p->type == SOCKET_SOCKET) {
169 if ((r = socket_address_print(&p->address, &k)) < 0)
174 fprintf(f, "%s%s: %s\n", prefix, listen_lookup(p->address.type), k);
177 fprintf(f, "%sListenFIFO: %s\n", prefix, p->path);
180 exec_context_dump(&s->exec_context, f, prefix);
182 for (c = 0; c < _SOCKET_EXEC_MAX; c++) {
183 if (!s->exec_command[c])
186 fprintf(f, "%s→ %s:\n",
187 prefix, command_table[c]);
189 exec_command_dump_list(s->exec_command[c], f, prefix2);
195 static void socket_close_fds(Socket *s) {
200 LIST_FOREACH(port, p, s->ports) {
204 unit_unwatch_fd(UNIT(s), &p->fd_watch);
205 assert_se(close_nointr(p->fd) >= 0);
211 static int socket_open_fds(Socket *s) {
217 LIST_FOREACH(port, p, s->ports) {
222 if (p->type == SOCKET_SOCKET) {
224 if ((r = socket_address_listen(&p->address, s->backlog, s->bind_ipv6_only, s->bind_to_device, &p->fd)) < 0)
229 assert(p->type == SOCKET_FIFO);
231 if (mkfifo(p->path, 0666 & ~s->exec_context.umask) < 0 && errno != EEXIST) {
236 if ((p->fd = open(p->path, O_RDWR|O_CLOEXEC|O_NOCTTY|O_NONBLOCK|O_NOFOLLOW)) < 0) {
241 if (fstat(p->fd, &st) < 0) {
246 /* FIXME verify user, access mode */
248 if (!S_ISFIFO(st.st_mode)) {
262 static void socket_unwatch_fds(Socket *s) {
267 LIST_FOREACH(port, p, s->ports) {
271 unit_unwatch_fd(UNIT(s), &p->fd_watch);
275 static int socket_watch_fds(Socket *s) {
281 LIST_FOREACH(port, p, s->ports) {
285 if ((r = unit_watch_fd(UNIT(s), p->fd, POLLIN, &p->fd_watch)) < 0)
292 socket_unwatch_fds(s);
296 static void socket_set_state(Socket *s, SocketState state) {
297 SocketState old_state;
300 old_state = s->state;
303 if (state != SOCKET_START_PRE &&
304 state != SOCKET_START_POST &&
305 state != SOCKET_STOP_PRE &&
306 state != SOCKET_STOP_PRE_SIGTERM &&
307 state != SOCKET_STOP_PRE_SIGKILL &&
308 state != SOCKET_STOP_POST &&
309 state != SOCKET_STOP_POST_SIGTERM &&
310 state != SOCKET_STOP_POST_SIGKILL)
311 unit_unwatch_timer(UNIT(s), &s->timer_watch);
313 if (state != SOCKET_START_PRE &&
314 state != SOCKET_START_POST &&
315 state != SOCKET_STOP_PRE &&
316 state != SOCKET_STOP_PRE_SIGTERM &&
317 state != SOCKET_STOP_PRE_SIGKILL &&
318 state != SOCKET_STOP_POST &&
319 state != SOCKET_STOP_POST_SIGTERM &&
320 state != SOCKET_STOP_POST_SIGKILL)
321 if (s->control_pid > 0) {
322 unit_unwatch_pid(UNIT(s), s->control_pid);
326 if (state != SOCKET_START_PRE &&
327 state != SOCKET_START_POST &&
328 state != SOCKET_STOP_PRE &&
329 state != SOCKET_STOP_POST)
330 s->control_command = NULL;
332 if (state != SOCKET_START_POST &&
333 state != SOCKET_LISTENING &&
334 state != SOCKET_RUNNING &&
335 state != SOCKET_STOP_PRE &&
336 state != SOCKET_STOP_PRE_SIGTERM &&
337 state != SOCKET_STOP_PRE_SIGKILL)
340 if (state != SOCKET_LISTENING)
341 socket_unwatch_fds(s);
343 log_debug("%s changing %s → %s", unit_id(UNIT(s)), state_string_table[old_state], state_string_table[state]);
345 unit_notify(UNIT(s), state_translation_table[old_state], state_translation_table[state]);
348 static int socket_spawn(Socket *s, ExecCommand *c, bool timeout, pid_t *_pid) {
357 if ((r = unit_watch_timer(UNIT(s), s->timeout_usec, &s->timer_watch)) < 0)
360 unit_unwatch_timer(UNIT(s), &s->timer_watch);
362 if ((r = exec_spawn(c, &s->exec_context, NULL, 0, &pid)) < 0)
365 if ((r = unit_watch_pid(UNIT(s), pid)) < 0)
366 /* FIXME: we need to do something here */
375 unit_unwatch_timer(UNIT(s), &s->timer_watch);
380 static void socket_enter_dead(Socket *s, bool success) {
386 socket_set_state(s, s->failure ? SOCKET_MAINTAINANCE : SOCKET_DEAD);
389 static void socket_enter_stop_post(Socket *s, bool success) {
396 if ((s->control_command = s->exec_command[SOCKET_EXEC_STOP_POST])) {
398 if ((r = socket_spawn(s, s->control_command, true, &s->control_pid)) < 0)
401 socket_set_state(s, SOCKET_STOP_POST);
403 socket_enter_dead(s, true);
408 log_warning("%s failed to run stop-post executable: %s", unit_id(UNIT(s)), strerror(-r));
409 socket_enter_dead(s, false);
412 static void socket_enter_signal(Socket *s, SocketState state, bool success) {
420 if (s->control_pid > 0) {
423 sig = (state == SOCKET_STOP_PRE_SIGTERM || state == SOCKET_STOP_POST_SIGTERM) ? SIGTERM : SIGKILL;
425 if (kill(s->control_pid, sig) < 0 && errno != ESRCH) {
430 socket_set_state(s, state);
432 socket_enter_dead(s, true);
437 log_warning("%s failed to kill processes: %s", unit_id(UNIT(s)), strerror(-r));
439 if (state == SOCKET_STOP_PRE_SIGTERM || state == SOCKET_STOP_PRE_SIGKILL)
440 socket_enter_stop_post(s, false);
442 socket_enter_dead(s, false);
445 static void socket_enter_stop_pre(Socket *s, bool success) {
452 if ((s->control_command = s->exec_command[SOCKET_EXEC_STOP_PRE])) {
454 if ((r = socket_spawn(s, s->control_command, true, &s->control_pid)) < 0)
457 socket_set_state(s, SOCKET_STOP_PRE);
459 socket_enter_stop_post(s, true);
464 log_warning("%s failed to run stop-pre executable: %s", unit_id(UNIT(s)), strerror(-r));
465 socket_enter_stop_post(s, false);
468 static void socket_enter_listening(Socket *s) {
472 if ((r = socket_watch_fds(s)) < 0) {
473 log_warning("%s failed to watch sockets: %s", unit_id(UNIT(s)), strerror(-r));
477 socket_set_state(s, SOCKET_LISTENING);
481 socket_enter_stop_pre(s, false);
484 static void socket_enter_start_post(Socket *s) {
488 if ((r = socket_open_fds(s)) < 0) {
489 log_warning("%s failed to listen on sockets: %s", unit_id(UNIT(s)), strerror(-r));
493 if ((s->control_command = s->exec_command[SOCKET_EXEC_START_POST])) {
495 if ((r = socket_spawn(s, s->control_command, true, &s->control_pid)) < 0) {
496 log_warning("%s failed to run start-post executable: %s", unit_id(UNIT(s)), strerror(-r));
500 socket_set_state(s, SOCKET_START_POST);
502 socket_enter_listening(s);
507 socket_enter_stop_pre(s, false);
510 static void socket_enter_start_pre(Socket *s) {
514 if ((s->control_command = s->exec_command[SOCKET_EXEC_START_PRE])) {
516 if ((r = socket_spawn(s, s->control_command, true, &s->control_pid)) < 0)
519 socket_set_state(s, SOCKET_START_PRE);
521 socket_enter_start_post(s);
526 log_warning("%s failed to run start-pre exectuable: %s", unit_id(UNIT(s)), strerror(-r));
527 socket_enter_dead(s, false);
530 static void socket_enter_running(Socket *s) {
535 if ((r = manager_add_job(UNIT(s)->meta.manager, JOB_START, UNIT(s->service), JOB_REPLACE, true, NULL)) < 0)
538 socket_set_state(s, SOCKET_RUNNING);
542 log_warning("%s failed to queue socket startup job: %s", unit_id(UNIT(s)), strerror(-r));
543 socket_enter_dead(s, false);
546 static void socket_run_next(Socket *s, bool success) {
550 assert(s->control_command);
551 assert(s->control_command->command_next);
556 s->control_command = s->control_command->command_next;
558 if ((r = socket_spawn(s, s->control_command, true, &s->control_pid)) < 0)
564 if (s->state == SOCKET_STOP_PRE)
565 socket_enter_stop_post(s, false);
566 else if (s->state == SOCKET_STOP_POST)
567 socket_enter_dead(s, false);
569 socket_enter_stop_pre(s, false);
572 static int socket_start(Unit *u) {
573 Socket *s = SOCKET(u);
577 /* We cannot fulfill this request right now, try again later
579 if (s->state == SOCKET_STOP_PRE ||
580 s->state == SOCKET_STOP_PRE_SIGKILL ||
581 s->state == SOCKET_STOP_PRE_SIGTERM ||
582 s->state == SOCKET_STOP_POST ||
583 s->state == SOCKET_STOP_POST_SIGTERM ||
584 s->state == SOCKET_STOP_POST_SIGKILL)
587 if (s->state == SOCKET_START_PRE ||
588 s->state == SOCKET_START_POST)
591 /* Cannot run this without the service being around */
592 if (s->service->meta.load_state != UNIT_LOADED)
595 assert(s->state == SOCKET_DEAD || s->state == SOCKET_MAINTAINANCE);
598 socket_enter_start_pre(s);
602 static int socket_stop(Unit *u) {
603 Socket *s = SOCKET(u);
607 /* We cannot fulfill this request right now, try again later
609 if (s->state == SOCKET_START_PRE ||
610 s->state == SOCKET_START_POST)
613 assert(s->state == SOCKET_LISTENING || s->state == SOCKET_RUNNING);
615 socket_enter_stop_pre(s, true);
619 static UnitActiveState socket_active_state(Unit *u) {
622 return state_translation_table[SOCKET(u)->state];
625 static void socket_fd_event(Unit *u, int fd, uint32_t events, Watch *w) {
626 Socket *s = SOCKET(u);
630 log_debug("Incoming traffic on %s", unit_id(u));
632 if (events != POLLIN)
633 socket_enter_stop_pre(s, false);
635 socket_enter_running(s);
638 static void socket_sigchld_event(Unit *u, pid_t pid, int code, int status) {
639 Socket *s = SOCKET(u);
645 success = code == CLD_EXITED && status == 0;
646 s->failure = s->failure || !success;
648 assert(s->control_pid == pid);
649 assert(s->control_command);
651 exec_status_fill(&s->control_command->exec_status, pid, code, status);
654 log_debug("%s control process exited, code=%s status=%i", unit_id(u), sigchld_code(code), status);
656 if (s->control_command->command_next &&
657 (success || (s->state == SOCKET_EXEC_STOP_PRE || s->state == SOCKET_EXEC_STOP_POST))) {
658 log_debug("%s running next command for the state %s", unit_id(u), state_string_table[s->state]);
659 socket_run_next(s, success);
661 /* No further commands for this step, so let's figure
662 * out what to do next */
664 log_debug("%s got final SIGCHLD for state %s", unit_id(u), state_string_table[s->state]);
668 case SOCKET_START_PRE:
670 socket_enter_start_post(s);
672 socket_enter_stop_pre(s, false);
675 case SOCKET_START_POST:
677 socket_enter_listening(s);
679 socket_enter_stop_pre(s, false);
682 case SOCKET_STOP_PRE:
683 case SOCKET_STOP_PRE_SIGTERM:
684 case SOCKET_STOP_PRE_SIGKILL:
685 socket_enter_stop_post(s, success);
688 case SOCKET_STOP_POST:
689 case SOCKET_STOP_POST_SIGTERM:
690 case SOCKET_STOP_POST_SIGKILL:
691 socket_enter_dead(s, success);
695 assert_not_reached("Uh, control process died at wrong time.");
700 static void socket_timer_event(Unit *u, uint64_t elapsed, Watch *w) {
701 Socket *s = SOCKET(u);
704 assert(elapsed == 1);
706 assert(w == &s->timer_watch);
710 case SOCKET_START_PRE:
711 case SOCKET_START_POST:
712 log_warning("%s operation timed out. Stopping.", unit_id(u));
713 socket_enter_stop_pre(s, false);
716 case SOCKET_STOP_PRE:
717 log_warning("%s stopping timed out. Terminating.", unit_id(u));
718 socket_enter_signal(s, SOCKET_STOP_PRE_SIGTERM, false);
721 case SOCKET_STOP_PRE_SIGTERM:
722 log_warning("%s stopping timed out. Killing.", unit_id(u));
723 socket_enter_signal(s, SOCKET_STOP_PRE_SIGKILL, false);
726 case SOCKET_STOP_PRE_SIGKILL:
727 log_warning("%s still around after SIGKILL. Ignoring.", unit_id(u));
728 socket_enter_stop_post(s, false);
731 case SOCKET_STOP_POST:
732 log_warning("%s stopping timed out (2). Terminating.", unit_id(u));
733 socket_enter_signal(s, SOCKET_STOP_POST_SIGTERM, false);
736 case SOCKET_STOP_POST_SIGTERM:
737 log_warning("%s stopping timed out (2). Killing.", unit_id(u));
738 socket_enter_signal(s, SOCKET_STOP_POST_SIGKILL, false);
741 case SOCKET_STOP_POST_SIGKILL:
742 log_warning("%s still around after SIGKILL (2). Entering maintainance mode.", unit_id(u));
743 socket_enter_dead(s, false);
747 assert_not_reached("Timeout at wrong time.");
751 int socket_collect_fds(Socket *s, int **fds, unsigned *n_fds) {
760 /* Called from the service code for requesting our fds */
763 LIST_FOREACH(port, p, s->ports)
767 if (!(rfds = new(int, rn_fds)) < 0)
771 LIST_FOREACH(port, p, s->ports)
783 void socket_notify_service_dead(Socket *s) {
786 /* The service is dead. Dang. */
788 if (s->state == SOCKET_RUNNING) {
789 log_debug("%s got notified about service death.", unit_id(UNIT(s)));
790 socket_enter_listening(s);
794 const UnitVTable socket_vtable = {
802 .start = socket_start,
805 .active_state = socket_active_state,
807 .fd_event = socket_fd_event,
808 .sigchld_event = socket_sigchld_event,
809 .timer_event = socket_timer_event