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) {
97 if (!(t
= unit_name_change_suffix(unit_id(u
), ".service"))) {
102 r
= manager_load_unit(u
->meta
.manager
, t
, (Unit
**) &s
->service
);
108 if ((r
= unit_add_dependency(u
, UNIT_BEFORE
, UNIT(s
->service
))) < 0)
118 static const char* listen_lookup(int type
) {
120 if (type
== SOCK_STREAM
)
121 return "ListenStream";
122 else if (type
== SOCK_DGRAM
)
123 return "ListenDatagram";
124 else if (type
== SOCK_SEQPACKET
)
125 return "ListenSequentialPacket";
127 assert_not_reached("Unknown socket type");
131 static void socket_dump(Unit
*u
, FILE *f
, const char *prefix
) {
133 static const char* const command_table
[_SOCKET_EXEC_MAX
] = {
134 [SOCKET_EXEC_START_PRE
] = "StartPre",
135 [SOCKET_EXEC_START_POST
] = "StartPost",
136 [SOCKET_EXEC_STOP_PRE
] = "StopPre",
137 [SOCKET_EXEC_STOP_POST
] = "StopPost"
141 Socket
*s
= SOCKET(u
);
148 prefix2
= strappend(prefix
, "\t");
153 "%sSocket State: %s\n"
154 "%sBindIPv6Only: %s\n"
156 prefix
, state_string_table
[s
->state
],
157 prefix
, yes_no(s
->bind_ipv6_only
),
160 if (s
->bind_to_device
)
162 "%sBindToDevice: %s\n",
163 prefix
, s
->bind_to_device
);
165 LIST_FOREACH(port
, p
, s
->ports
) {
167 if (p
->type
== SOCKET_SOCKET
) {
172 if ((r
= socket_address_print(&p
->address
, &k
)) < 0)
177 fprintf(f
, "%s%s: %s\n", prefix
, listen_lookup(p
->address
.type
), k
);
180 fprintf(f
, "%sListenFIFO: %s\n", prefix
, p
->path
);
183 exec_context_dump(&s
->exec_context
, f
, prefix
);
185 for (c
= 0; c
< _SOCKET_EXEC_MAX
; c
++) {
186 if (!s
->exec_command
[c
])
189 fprintf(f
, "%s→ %s:\n",
190 prefix
, command_table
[c
]);
192 exec_command_dump_list(s
->exec_command
[c
], f
, prefix2
);
198 static void socket_close_fds(Socket
*s
) {
203 LIST_FOREACH(port
, p
, s
->ports
) {
207 unit_unwatch_fd(UNIT(s
), &p
->fd_watch
);
208 assert_se(close_nointr(p
->fd
) >= 0);
214 static int socket_open_fds(Socket
*s
) {
220 LIST_FOREACH(port
, p
, s
->ports
) {
225 if (p
->type
== SOCKET_SOCKET
) {
227 if ((r
= socket_address_listen(&p
->address
, s
->backlog
, s
->bind_ipv6_only
, s
->bind_to_device
, &p
->fd
)) < 0)
232 assert(p
->type
== SOCKET_FIFO
);
234 if (mkfifo(p
->path
, 0666 & ~s
->exec_context
.umask
) < 0 && errno
!= EEXIST
) {
239 if ((p
->fd
= open(p
->path
, O_RDWR
|O_CLOEXEC
|O_NOCTTY
|O_NONBLOCK
|O_NOFOLLOW
)) < 0) {
244 if (fstat(p
->fd
, &st
) < 0) {
249 /* FIXME verify user, access mode */
251 if (!S_ISFIFO(st
.st_mode
)) {
265 static void socket_unwatch_fds(Socket
*s
) {
270 LIST_FOREACH(port
, p
, s
->ports
) {
274 unit_unwatch_fd(UNIT(s
), &p
->fd_watch
);
278 static int socket_watch_fds(Socket
*s
) {
284 LIST_FOREACH(port
, p
, s
->ports
) {
288 if ((r
= unit_watch_fd(UNIT(s
), p
->fd
, EPOLLIN
, &p
->fd_watch
)) < 0)
295 socket_unwatch_fds(s
);
299 static void socket_set_state(Socket
*s
, SocketState state
) {
300 SocketState old_state
;
303 old_state
= s
->state
;
306 if (state
!= SOCKET_START_PRE
&&
307 state
!= SOCKET_START_POST
&&
308 state
!= SOCKET_STOP_PRE
&&
309 state
!= SOCKET_STOP_PRE_SIGTERM
&&
310 state
!= SOCKET_STOP_PRE_SIGKILL
&&
311 state
!= SOCKET_STOP_POST
&&
312 state
!= SOCKET_STOP_POST_SIGTERM
&&
313 state
!= SOCKET_STOP_POST_SIGKILL
)
314 unit_unwatch_timer(UNIT(s
), &s
->timer_watch
);
316 if (state
!= SOCKET_START_PRE
&&
317 state
!= SOCKET_START_POST
&&
318 state
!= SOCKET_STOP_PRE
&&
319 state
!= SOCKET_STOP_PRE_SIGTERM
&&
320 state
!= SOCKET_STOP_PRE_SIGKILL
&&
321 state
!= SOCKET_STOP_POST
&&
322 state
!= SOCKET_STOP_POST_SIGTERM
&&
323 state
!= SOCKET_STOP_POST_SIGKILL
)
324 if (s
->control_pid
> 0) {
325 unit_unwatch_pid(UNIT(s
), s
->control_pid
);
329 if (state
!= SOCKET_START_PRE
&&
330 state
!= SOCKET_START_POST
&&
331 state
!= SOCKET_STOP_PRE
&&
332 state
!= SOCKET_STOP_POST
)
333 s
->control_command
= NULL
;
335 if (state
!= SOCKET_START_POST
&&
336 state
!= SOCKET_LISTENING
&&
337 state
!= SOCKET_RUNNING
&&
338 state
!= SOCKET_STOP_PRE
&&
339 state
!= SOCKET_STOP_PRE_SIGTERM
&&
340 state
!= SOCKET_STOP_PRE_SIGKILL
)
343 if (state
!= SOCKET_LISTENING
)
344 socket_unwatch_fds(s
);
346 log_debug("%s changed %s → %s", unit_id(UNIT(s
)), state_string_table
[old_state
], state_string_table
[state
]);
348 unit_notify(UNIT(s
), state_translation_table
[old_state
], state_translation_table
[state
]);
351 static int socket_spawn(Socket
*s
, ExecCommand
*c
, bool timeout
, pid_t
*_pid
) {
360 if ((r
= unit_watch_timer(UNIT(s
), s
->timeout_usec
, &s
->timer_watch
)) < 0)
363 unit_unwatch_timer(UNIT(s
), &s
->timer_watch
);
365 if ((r
= exec_spawn(c
, &s
->exec_context
, NULL
, 0, &pid
)) < 0)
368 if ((r
= unit_watch_pid(UNIT(s
), pid
)) < 0)
369 /* FIXME: we need to do something here */
378 unit_unwatch_timer(UNIT(s
), &s
->timer_watch
);
383 static void socket_enter_dead(Socket
*s
, bool success
) {
389 socket_set_state(s
, s
->failure
? SOCKET_MAINTAINANCE
: SOCKET_DEAD
);
392 static void socket_enter_stop_post(Socket
*s
, bool success
) {
399 if ((s
->control_command
= s
->exec_command
[SOCKET_EXEC_STOP_POST
]))
400 if ((r
= socket_spawn(s
, s
->control_command
, true, &s
->control_pid
)) < 0)
403 socket_set_state(s
, SOCKET_STOP_POST
);
405 if (!s
->control_command
)
406 socket_enter_dead(s
, true);
411 log_warning("%s failed to run stop-post executable: %s", unit_id(UNIT(s
)), strerror(-r
));
412 socket_enter_dead(s
, false);
415 static void socket_enter_signal(Socket
*s
, SocketState state
, bool success
) {
423 if (s
->control_pid
> 0) {
426 sig
= (state
== SOCKET_STOP_PRE_SIGTERM
|| state
== SOCKET_STOP_POST_SIGTERM
) ? SIGTERM
: SIGKILL
;
428 if (kill(s
->control_pid
, sig
) < 0 && errno
!= ESRCH
) {
434 socket_set_state(s
, state
);
436 if (s
->control_pid
<= 0)
437 socket_enter_dead(s
, true);
442 log_warning("%s failed to kill processes: %s", unit_id(UNIT(s
)), strerror(-r
));
444 if (state
== SOCKET_STOP_PRE_SIGTERM
|| state
== SOCKET_STOP_PRE_SIGKILL
)
445 socket_enter_stop_post(s
, false);
447 socket_enter_dead(s
, false);
450 static void socket_enter_stop_pre(Socket
*s
, bool success
) {
457 if ((s
->control_command
= s
->exec_command
[SOCKET_EXEC_STOP_PRE
]))
458 if ((r
= socket_spawn(s
, s
->control_command
, true, &s
->control_pid
)) < 0)
461 socket_set_state(s
, SOCKET_STOP_PRE
);
463 if (!s
->control_command
)
464 socket_enter_stop_post(s
, true);
469 log_warning("%s failed to run stop-pre executable: %s", unit_id(UNIT(s
)), strerror(-r
));
470 socket_enter_stop_post(s
, false);
473 static void socket_enter_listening(Socket
*s
) {
477 if ((r
= socket_watch_fds(s
)) < 0) {
478 log_warning("%s failed to watch sockets: %s", unit_id(UNIT(s
)), strerror(-r
));
482 socket_set_state(s
, SOCKET_LISTENING
);
486 socket_enter_stop_pre(s
, false);
489 static void socket_enter_start_post(Socket
*s
) {
493 if ((r
= socket_open_fds(s
)) < 0) {
494 log_warning("%s failed to listen on sockets: %s", unit_id(UNIT(s
)), strerror(-r
));
498 if ((s
->control_command
= s
->exec_command
[SOCKET_EXEC_START_POST
]))
499 if ((r
= socket_spawn(s
, s
->control_command
, true, &s
->control_pid
)) < 0) {
500 log_warning("%s failed to run start-post executable: %s", unit_id(UNIT(s
)), strerror(-r
));
504 socket_set_state(s
, SOCKET_START_POST
);
506 if (!s
->control_command
)
507 socket_enter_listening(s
);
512 socket_enter_stop_pre(s
, false);
515 static void socket_enter_start_pre(Socket
*s
) {
519 if ((s
->control_command
= s
->exec_command
[SOCKET_EXEC_START_PRE
]))
520 if ((r
= socket_spawn(s
, s
->control_command
, true, &s
->control_pid
)) < 0)
523 socket_set_state(s
, SOCKET_START_PRE
);
525 if (!s
->control_command
)
526 socket_enter_start_post(s
);
531 log_warning("%s failed to run start-pre exectuable: %s", unit_id(UNIT(s
)), strerror(-r
));
532 socket_enter_dead(s
, false);
535 static void socket_enter_running(Socket
*s
) {
540 if ((r
= manager_add_job(UNIT(s
)->meta
.manager
, JOB_START
, UNIT(s
->service
), JOB_REPLACE
, true, NULL
)) < 0)
543 socket_set_state(s
, SOCKET_RUNNING
);
547 log_warning("%s failed to queue socket startup job: %s", unit_id(UNIT(s
)), strerror(-r
));
548 socket_enter_dead(s
, false);
551 static void socket_run_next(Socket
*s
, bool success
) {
555 assert(s
->control_command
);
556 assert(s
->control_command
->command_next
);
561 s
->control_command
= s
->control_command
->command_next
;
563 if ((r
= socket_spawn(s
, s
->control_command
, true, &s
->control_pid
)) < 0)
569 if (s
->state
== SOCKET_STOP_PRE
)
570 socket_enter_stop_post(s
, false);
571 else if (s
->state
== SOCKET_STOP_POST
)
572 socket_enter_dead(s
, false);
574 socket_enter_stop_pre(s
, false);
577 static int socket_start(Unit
*u
) {
578 Socket
*s
= SOCKET(u
);
582 /* We cannot fulfill this request right now, try again later
584 if (s
->state
== SOCKET_STOP_PRE
||
585 s
->state
== SOCKET_STOP_PRE_SIGKILL
||
586 s
->state
== SOCKET_STOP_PRE_SIGTERM
||
587 s
->state
== SOCKET_STOP_POST
||
588 s
->state
== SOCKET_STOP_POST_SIGTERM
||
589 s
->state
== SOCKET_STOP_POST_SIGKILL
)
592 if (s
->state
== SOCKET_START_PRE
||
593 s
->state
== SOCKET_START_POST
)
596 /* Cannot run this without the service being around */
597 if (s
->service
->meta
.load_state
!= UNIT_LOADED
)
600 assert(s
->state
== SOCKET_DEAD
|| s
->state
== SOCKET_MAINTAINANCE
);
603 socket_enter_start_pre(s
);
607 static int socket_stop(Unit
*u
) {
608 Socket
*s
= SOCKET(u
);
612 /* We cannot fulfill this request right now, try again later
614 if (s
->state
== SOCKET_START_PRE
||
615 s
->state
== SOCKET_START_POST
)
618 assert(s
->state
== SOCKET_LISTENING
|| s
->state
== SOCKET_RUNNING
);
620 socket_enter_stop_pre(s
, true);
624 static UnitActiveState
socket_active_state(Unit
*u
) {
627 return state_translation_table
[SOCKET(u
)->state
];
630 static void socket_fd_event(Unit
*u
, int fd
, uint32_t events
, Watch
*w
) {
631 Socket
*s
= SOCKET(u
);
635 log_debug("Incoming traffic on %s", unit_id(u
));
637 if (events
!= EPOLLIN
)
638 socket_enter_stop_pre(s
, false);
640 socket_enter_running(s
);
643 static void socket_sigchld_event(Unit
*u
, pid_t pid
, int code
, int status
) {
644 Socket
*s
= SOCKET(u
);
650 success
= code
== CLD_EXITED
&& status
== 0;
651 s
->failure
= s
->failure
|| !success
;
653 assert(s
->control_pid
== pid
);
654 assert(s
->control_command
);
656 exec_status_fill(&s
->control_command
->exec_status
, pid
, code
, status
);
659 log_debug("%s control process exited, code=%s status=%i", unit_id(u
), sigchld_code(code
), status
);
661 if (s
->control_command
->command_next
&&
662 (success
|| (s
->state
== SOCKET_EXEC_STOP_PRE
|| s
->state
== SOCKET_EXEC_STOP_POST
))) {
663 log_debug("%s running next command for the state %s", unit_id(u
), state_string_table
[s
->state
]);
664 socket_run_next(s
, success
);
666 /* No further commands for this step, so let's figure
667 * out what to do next */
669 log_debug("%s got final SIGCHLD for state %s", unit_id(u
), state_string_table
[s
->state
]);
673 case SOCKET_START_PRE
:
675 socket_enter_start_post(s
);
677 socket_enter_stop_pre(s
, false);
680 case SOCKET_START_POST
:
682 socket_enter_listening(s
);
684 socket_enter_stop_pre(s
, false);
687 case SOCKET_STOP_PRE
:
688 case SOCKET_STOP_PRE_SIGTERM
:
689 case SOCKET_STOP_PRE_SIGKILL
:
690 socket_enter_stop_post(s
, success
);
693 case SOCKET_STOP_POST
:
694 case SOCKET_STOP_POST_SIGTERM
:
695 case SOCKET_STOP_POST_SIGKILL
:
696 socket_enter_dead(s
, success
);
700 assert_not_reached("Uh, control process died at wrong time.");
705 static void socket_timer_event(Unit
*u
, uint64_t elapsed
, Watch
*w
) {
706 Socket
*s
= SOCKET(u
);
709 assert(elapsed
== 1);
711 assert(w
== &s
->timer_watch
);
715 case SOCKET_START_PRE
:
716 case SOCKET_START_POST
:
717 log_warning("%s operation timed out. Stopping.", unit_id(u
));
718 socket_enter_stop_pre(s
, false);
721 case SOCKET_STOP_PRE
:
722 log_warning("%s stopping timed out. Terminating.", unit_id(u
));
723 socket_enter_signal(s
, SOCKET_STOP_PRE_SIGTERM
, false);
726 case SOCKET_STOP_PRE_SIGTERM
:
727 log_warning("%s stopping timed out. Killing.", unit_id(u
));
728 socket_enter_signal(s
, SOCKET_STOP_PRE_SIGKILL
, false);
731 case SOCKET_STOP_PRE_SIGKILL
:
732 log_warning("%s still around after SIGKILL. Ignoring.", unit_id(u
));
733 socket_enter_stop_post(s
, false);
736 case SOCKET_STOP_POST
:
737 log_warning("%s stopping timed out (2). Terminating.", unit_id(u
));
738 socket_enter_signal(s
, SOCKET_STOP_POST_SIGTERM
, false);
741 case SOCKET_STOP_POST_SIGTERM
:
742 log_warning("%s stopping timed out (2). Killing.", unit_id(u
));
743 socket_enter_signal(s
, SOCKET_STOP_POST_SIGKILL
, false);
746 case SOCKET_STOP_POST_SIGKILL
:
747 log_warning("%s still around after SIGKILL (2). Entering maintainance mode.", unit_id(u
));
748 socket_enter_dead(s
, false);
752 assert_not_reached("Timeout at wrong time.");
756 int socket_collect_fds(Socket
*s
, int **fds
, unsigned *n_fds
) {
765 /* Called from the service code for requesting our fds */
768 LIST_FOREACH(port
, p
, s
->ports
)
772 if (!(rfds
= new(int, rn_fds
)) < 0)
776 LIST_FOREACH(port
, p
, s
->ports
)
788 void socket_notify_service_dead(Socket
*s
) {
791 /* The service is dead. Dang. */
793 if (s
->state
== SOCKET_RUNNING
) {
794 log_debug("%s got notified about service death.", unit_id(UNIT(s
)));
795 socket_enter_listening(s
);
799 const UnitVTable socket_vtable
= {
807 .start
= socket_start
,
810 .active_state
= socket_active_state
,
812 .fd_event
= socket_fd_event
,
813 .sigchld_event
= socket_sigchld_event
,
814 .timer_event
= socket_timer_event