1 /*-*- Mode: C; c-basic-offset: 8 -*-*/
15 static const NameActiveState state_table[_SOCKET_STATE_MAX] = {
16 [SOCKET_DEAD] = NAME_INACTIVE,
17 [SOCKET_START_PRE] = NAME_ACTIVATING,
18 [SOCKET_START_POST] = NAME_ACTIVATING,
19 [SOCKET_LISTENING] = NAME_ACTIVE,
20 [SOCKET_RUNNING] = NAME_ACTIVE,
21 [SOCKET_STOP_PRE] = NAME_DEACTIVATING,
22 [SOCKET_STOP_PRE_SIGTERM] = NAME_DEACTIVATING,
23 [SOCKET_STOP_PRE_SIGKILL] = NAME_DEACTIVATING,
24 [SOCKET_STOP_POST] = NAME_DEACTIVATING,
25 [SOCKET_STOP_POST_SIGTERM] = NAME_DEACTIVATING,
26 [SOCKET_STOP_POST_SIGKILL] = NAME_DEACTIVATING,
27 [SOCKET_MAINTAINANCE] = NAME_INACTIVE,
30 static void socket_done(Name *n) {
31 Socket *s = SOCKET(n);
36 while ((p = s->ports)) {
37 LIST_REMOVE(SocketPort, port, s->ports, p);
45 exec_context_done(&s->exec_context);
46 exec_command_free_array(s->exec_command, _SOCKET_EXEC_MAX);
47 s->control_command = NULL;
49 if (s->control_pid > 0) {
50 name_unwatch_pid(n, s->control_pid);
56 name_unwatch_timer(n, &s->timer_id);
59 static int socket_init(Name *n) {
60 Socket *s = SOCKET(n);
64 /* First, reset everything to the defaults, in case this is a
69 s->bind_ipv6_only = false;
70 s->backlog = SOMAXCONN;
71 s->timeout_usec = DEFAULT_TIMEOUT_USEC;
72 exec_context_init(&s->exec_context);
74 if ((r = name_load_fragment_and_dropin(n)) < 0)
77 if (!(t = name_change_suffix(name_id(n), ".service"))) {
82 r = manager_load_name(n->meta.manager, t, (Name**) &s->service);
88 if ((r = name_add_dependency(n, NAME_BEFORE, NAME(s->service))) < 0)
98 static const char* listen_lookup(int type) {
100 if (type == SOCK_STREAM)
101 return "ListenStream";
102 else if (type == SOCK_DGRAM)
103 return "ListenDatagram";
104 else if (type == SOCK_SEQPACKET)
105 return "ListenSequentialPacket";
107 assert_not_reached("Unknown socket type");
111 static void socket_dump(Name *n, FILE *f, const char *prefix) {
113 static const char* const state_table[_SOCKET_STATE_MAX] = {
114 [SOCKET_DEAD] = "dead",
115 [SOCKET_START_PRE] = "start-pre",
116 [SOCKET_START_POST] = "start-post",
117 [SOCKET_LISTENING] = "listening",
118 [SOCKET_RUNNING] = "running",
119 [SOCKET_STOP_PRE] = "stop-pre",
120 [SOCKET_STOP_PRE_SIGTERM] = "stop-pre-sigterm",
121 [SOCKET_STOP_PRE_SIGKILL] = "stop-pre-sigkill",
122 [SOCKET_STOP_POST] = "stop-post",
123 [SOCKET_STOP_POST_SIGTERM] = "stop-post-sigterm",
124 [SOCKET_STOP_POST_SIGKILL] = "stop-post-sigkill",
125 [SOCKET_MAINTAINANCE] = "maintainance"
128 static const char* const command_table[_SOCKET_EXEC_MAX] = {
129 [SOCKET_EXEC_START_PRE] = "StartPre",
130 [SOCKET_EXEC_START_POST] = "StartPost",
131 [SOCKET_EXEC_STOP_PRE] = "StopPre",
132 [SOCKET_EXEC_STOP_POST] = "StopPost"
136 Socket *s = SOCKET(n);
142 "%sSocket State: %s\n"
143 "%sBindIPv6Only: %s\n"
145 prefix, state_table[s->state],
146 prefix, yes_no(s->bind_ipv6_only),
149 LIST_FOREACH(port, p, s->ports) {
151 if (p->type == SOCKET_SOCKET) {
156 if ((r = socket_address_print(&p->address, &k)) < 0)
161 fprintf(f, "%s%s: %s\n", prefix, listen_lookup(p->address.type), k);
164 fprintf(f, "%sListenFIFO: %s\n", prefix, p->path);
167 exec_context_dump(&s->exec_context, f, prefix);
169 for (c = 0; c < _SOCKET_EXEC_MAX; c++) {
172 LIST_FOREACH(command, i, s->exec_command[c])
173 fprintf(f, "%s%s: %s\n", prefix, command_table[c], i->path);
177 static void socket_close_fds(Socket *s) {
182 LIST_FOREACH(port, p, s->ports) {
186 name_unwatch_fd(NAME(s), p->fd);
187 assert_se(close_nointr(p->fd) >= 0);
193 static int socket_open_fds(Socket *s) {
199 LIST_FOREACH(port, p, s->ports) {
204 if (p->type == SOCKET_SOCKET) {
206 if ((r = socket_address_listen(&p->address, s->backlog, s->bind_ipv6_only, &p->fd)) < 0)
211 assert(p->type == SOCKET_FIFO);
213 if (mkfifo(p->path, 0666 & ~s->exec_context.umask) < 0 && errno != EEXIST) {
218 if ((p->fd = open(p->path, O_RDWR|O_CLOEXEC|O_NOCTTY|O_NONBLOCK|O_NOFOLLOW)) < 0) {
223 if (fstat(p->fd, &st) < 0) {
228 /* FIXME verify user, access mode */
230 if (!S_ISFIFO(st.st_mode)) {
244 static void socket_unwatch_fds(Socket *s) {
249 LIST_FOREACH(port, p, s->ports) {
253 name_unwatch_fd(NAME(s), p->fd);
257 static int socket_watch_fds(Socket *s) {
263 LIST_FOREACH(port, p, s->ports) {
267 if ((r = name_watch_fd(NAME(s), p->fd, POLLIN)) < 0)
274 socket_unwatch_fds(s);
278 static void socket_set_state(Socket *s, SocketState state) {
279 SocketState old_state;
282 old_state = s->state;
285 if (state != SOCKET_START_PRE &&
286 state != SOCKET_START_POST &&
287 state != SOCKET_STOP_PRE &&
288 state != SOCKET_STOP_PRE_SIGTERM &&
289 state != SOCKET_STOP_PRE_SIGKILL &&
290 state != SOCKET_STOP_POST &&
291 state != SOCKET_STOP_POST_SIGTERM &&
292 state != SOCKET_STOP_POST_SIGKILL)
293 name_unwatch_timer(NAME(s), &s->timer_id);
295 if (state != SOCKET_START_PRE &&
296 state != SOCKET_START_POST &&
297 state != SOCKET_STOP_PRE &&
298 state != SOCKET_STOP_PRE_SIGTERM &&
299 state != SOCKET_STOP_PRE_SIGKILL &&
300 state != SOCKET_STOP_POST &&
301 state != SOCKET_STOP_POST_SIGTERM &&
302 state != SOCKET_STOP_POST_SIGKILL)
303 if (s->control_pid >= 0) {
304 name_unwatch_pid(NAME(s), s->control_pid);
308 if (state != SOCKET_START_PRE &&
309 state != SOCKET_START_POST &&
310 state != SOCKET_STOP_PRE &&
311 state != SOCKET_STOP_POST)
312 s->control_command = NULL;
314 if (state != SOCKET_START_POST &&
315 state != SOCKET_LISTENING &&
316 state != SOCKET_RUNNING &&
317 state != SOCKET_STOP_PRE &&
318 state != SOCKET_STOP_PRE_SIGTERM &&
319 state != SOCKET_STOP_PRE_SIGKILL)
322 if (state != SOCKET_LISTENING)
323 socket_unwatch_fds(s);
325 name_notify(NAME(s), state_table[old_state], state_table[s->state]);
328 static int socket_spawn(Socket *s, ExecCommand *c, bool timeout, pid_t *_pid) {
337 if ((r = name_watch_timer(NAME(s), s->timeout_usec, &s->timer_id)) < 0)
340 name_unwatch_timer(NAME(s), &s->timer_id);
342 if ((r = exec_spawn(c, &s->exec_context, NULL, 0, &pid)) < 0)
345 if ((r = name_watch_pid(NAME(s), pid)) < 0)
346 /* FIXME: we need to do something here */
355 name_unwatch_timer(NAME(s), &s->timer_id);
360 static void socket_enter_dead(Socket *s, bool success) {
366 socket_set_state(s, s->failure ? SOCKET_MAINTAINANCE : SOCKET_DEAD);
369 static void socket_enter_stop_post(Socket *s, bool success) {
376 if ((s->control_command = s->exec_command[SOCKET_EXEC_STOP_POST])) {
378 if ((r = socket_spawn(s, s->control_command, true, &s->control_pid)) < 0)
381 socket_set_state(s, SOCKET_STOP_POST);
383 socket_enter_dead(s, true);
388 log_warning("%s failed to run stop-post executable: %s", name_id(NAME(s)), strerror(-r));
389 socket_enter_dead(s, false);
392 static void socket_enter_signal(Socket *s, SocketState state, bool success) {
400 if (s->control_pid > 0) {
403 sig = (state == SOCKET_STOP_PRE_SIGTERM || state == SOCKET_STOP_POST_SIGTERM) ? SIGTERM : SIGKILL;
405 if (kill(s->control_pid, sig) < 0 && errno != ESRCH) {
410 socket_set_state(s, state);
412 socket_enter_dead(s, true);
417 log_warning("%s failed to kill processes: %s", name_id(NAME(s)), strerror(-r));
419 if (state == SOCKET_STOP_PRE_SIGTERM || state == SOCKET_STOP_PRE_SIGKILL)
420 socket_enter_stop_post(s, false);
422 socket_enter_dead(s, false);
425 static void socket_enter_stop_pre(Socket *s, bool success) {
432 if ((s->control_command = s->exec_command[SOCKET_EXEC_STOP_PRE])) {
434 if ((r = socket_spawn(s, s->control_command, true, &s->control_pid)) < 0)
437 socket_set_state(s, SOCKET_STOP_PRE);
439 socket_enter_stop_post(s, true);
444 log_warning("%s failed to run stop-pre executable: %s", name_id(NAME(s)), strerror(-r));
445 socket_enter_stop_post(s, false);
448 static void socket_enter_start_post(Socket *s) {
452 if ((r = socket_open_fds(s)) < 0 ||
453 (r = socket_watch_fds(s)) < 0) {
454 log_warning("%s failed to listen on sockets: %s", name_id(NAME(s)), strerror(-r));
458 if ((s->control_command = s->exec_command[SOCKET_EXEC_START_POST])) {
460 if ((r = socket_spawn(s, s->control_command, true, &s->control_pid)) < 0) {
461 log_warning("%s failed to run start-post executable: %s", name_id(NAME(s)), strerror(-r));
465 socket_set_state(s, SOCKET_START_POST);
467 socket_set_state(s, SOCKET_LISTENING);
472 socket_enter_stop_pre(s, false);
475 static void socket_enter_start_pre(Socket *s) {
479 if ((s->control_command = s->exec_command[SOCKET_EXEC_START_PRE])) {
481 if ((r = socket_spawn(s, s->control_command, true, &s->control_pid)) < 0)
484 socket_set_state(s, SOCKET_START_PRE);
486 socket_enter_start_post(s);
491 log_warning("%s failed to run start-pre exectuable: %s", name_id(NAME(s)), strerror(-r));
492 socket_enter_dead(s, false);
495 static void socket_enter_running(Socket *s) {
500 if ((r = manager_add_job(NAME(s)->meta.manager, JOB_START, NAME(s->service), JOB_REPLACE, true, NULL)) < 0)
503 socket_set_state(s, SOCKET_RUNNING);
507 log_warning("%s failed to queue socket startup job: %s", name_id(NAME(s)), strerror(-r));
508 socket_enter_dead(s, false);
511 static void socket_run_next(Socket *s, bool success) {
515 assert(s->control_command);
516 assert(s->control_command->command_next);
521 s->control_command = s->control_command->command_next;
523 if ((r = socket_spawn(s, s->control_command, true, &s->control_pid)) < 0)
529 if (s->state == SOCKET_STOP_PRE)
530 socket_enter_stop_post(s, false);
531 else if (s->state == SOCKET_STOP_POST)
532 socket_enter_dead(s, false);
534 socket_enter_stop_pre(s, false);
537 static int socket_start(Name *n) {
538 Socket *s = SOCKET(n);
542 /* We cannot fulfill this request right now, try again later
544 if (s->state == SOCKET_STOP_PRE ||
545 s->state == SOCKET_STOP_PRE_SIGKILL ||
546 s->state == SOCKET_STOP_PRE_SIGTERM ||
547 s->state == SOCKET_STOP_POST ||
548 s->state == SOCKET_STOP_POST_SIGTERM ||
549 s->state == SOCKET_STOP_POST_SIGKILL)
552 if (s->state == SOCKET_START_PRE ||
553 s->state == SOCKET_START_POST)
556 /* Cannot run this without the service being around */
557 if (s->service->meta.load_state != NAME_LOADED)
560 assert(s->state == SOCKET_DEAD || s->state == SOCKET_MAINTAINANCE);
563 socket_enter_start_pre(s);
567 static int socket_stop(Name *n) {
568 Socket *s = SOCKET(n);
572 /* We cannot fulfill this request right now, try again later
574 if (s->state == SOCKET_START_PRE ||
575 s->state == SOCKET_START_POST)
578 assert(s->state == SOCKET_LISTENING || s->state == SOCKET_RUNNING);
580 socket_enter_stop_pre(s, true);
584 static NameActiveState socket_active_state(Name *n) {
587 return state_table[SOCKET(n)->state];
590 static void socket_fd_event(Name *n, int fd, uint32_t events) {
591 Socket *s = SOCKET(n);
595 log_info("Incoming traffic on %s", name_id(n));
597 if (events != POLLIN)
598 socket_enter_stop_pre(s, false);
600 socket_enter_running(s);
603 static void socket_sigchld_event(Name *n, pid_t pid, int code, int status) {
604 Socket *s = SOCKET(n);
610 success = code == CLD_EXITED || status == 0;
611 s->failure = s->failure || !success;
613 assert(s->control_pid == pid);
614 assert(s->control_command);
616 exec_status_fill(&s->control_command->exec_status, pid, code, status);
619 log_debug("%s: control process exited, code=%s status=%i", name_id(n), sigchld_code(code), status);
621 if (s->control_command->command_next &&
622 (success || (s->state == SOCKET_EXEC_STOP_PRE || s->state == SOCKET_EXEC_STOP_POST)))
623 socket_run_next(s, success);
625 /* No further commands for this step, so let's figure
626 * out what to do next */
630 case SOCKET_START_PRE:
632 socket_enter_start_pre(s);
634 socket_enter_stop_pre(s, false);
637 case SOCKET_START_POST:
639 socket_set_state(s, SOCKET_LISTENING);
641 socket_enter_stop_pre(s, false);
644 case SOCKET_STOP_PRE:
645 case SOCKET_STOP_PRE_SIGTERM:
646 case SOCKET_STOP_PRE_SIGKILL:
647 socket_enter_stop_post(s, success);
650 case SOCKET_STOP_POST:
651 case SOCKET_STOP_POST_SIGTERM:
652 case SOCKET_STOP_POST_SIGKILL:
653 socket_enter_dead(s, success);
657 assert_not_reached("Uh, control process died at wrong time.");
662 static void socket_timer_event(Name *n, int id, uint64_t elapsed) {
663 Socket *s = SOCKET(n);
666 assert(elapsed == 1);
668 assert(s->timer_id == id);
672 case SOCKET_START_PRE:
673 case SOCKET_START_POST:
674 log_warning("%s operation timed out. Stopping.", name_id(n));
675 socket_enter_stop_pre(s, false);
678 case SOCKET_STOP_PRE:
679 log_warning("%s stopping timed out. Terminating.", name_id(n));
680 socket_enter_signal(s, SOCKET_STOP_PRE_SIGTERM, false);
683 case SOCKET_STOP_PRE_SIGTERM:
684 log_warning("%s stopping timed out. Killing.", name_id(n));
685 socket_enter_signal(s, SOCKET_STOP_PRE_SIGKILL, false);
688 case SOCKET_STOP_PRE_SIGKILL:
689 log_warning("%s still around after SIGKILL. Ignoring.", name_id(n));
690 socket_enter_stop_post(s, false);
693 case SOCKET_STOP_POST:
694 log_warning("%s stopping timed out (2). Terminating.", name_id(n));
695 socket_enter_signal(s, SOCKET_STOP_POST_SIGTERM, false);
698 case SOCKET_STOP_POST_SIGTERM:
699 log_warning("%s stopping timed out (2). Killing.", name_id(n));
700 socket_enter_signal(s, SOCKET_STOP_POST_SIGKILL, false);
703 case SOCKET_STOP_POST_SIGKILL:
704 log_warning("%s still around after SIGKILL (2). Entering maintainance mode.", name_id(n));
705 socket_enter_dead(s, false);
709 assert_not_reached("Timeout at wrong time.");
713 int socket_collect_fds(Socket *s, int **fds, unsigned *n_fds) {
722 /* Called from the service code for requesting our fds */
725 LIST_FOREACH(port, p, s->ports)
729 if (!(rfds = new(int, rn_fds)) < 0)
733 LIST_FOREACH(port, p, s->ports)
745 const NameVTable socket_vtable = {
753 .start = socket_start,
756 .active_state = socket_active_state,
758 .fd_event = socket_fd_event,
759 .sigchld_event = socket_sigchld_event,
760 .timer_event = socket_timer_event