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 changed %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
]))
397 if ((r
= socket_spawn(s
, s
->control_command
, true, &s
->control_pid
)) < 0)
400 socket_set_state(s
, SOCKET_STOP_POST
);
402 if (!s
->control_command
)
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
) {
431 socket_set_state(s
, state
);
433 if (s
->control_pid
<= 0)
434 socket_enter_dead(s
, true);
439 log_warning("%s failed to kill processes: %s", unit_id(UNIT(s
)), strerror(-r
));
441 if (state
== SOCKET_STOP_PRE_SIGTERM
|| state
== SOCKET_STOP_PRE_SIGKILL
)
442 socket_enter_stop_post(s
, false);
444 socket_enter_dead(s
, false);
447 static void socket_enter_stop_pre(Socket
*s
, bool success
) {
454 if ((s
->control_command
= s
->exec_command
[SOCKET_EXEC_STOP_PRE
]))
455 if ((r
= socket_spawn(s
, s
->control_command
, true, &s
->control_pid
)) < 0)
458 socket_set_state(s
, SOCKET_STOP_PRE
);
460 if (!s
->control_command
)
461 socket_enter_stop_post(s
, true);
466 log_warning("%s failed to run stop-pre executable: %s", unit_id(UNIT(s
)), strerror(-r
));
467 socket_enter_stop_post(s
, false);
470 static void socket_enter_listening(Socket
*s
) {
474 if ((r
= socket_watch_fds(s
)) < 0) {
475 log_warning("%s failed to watch sockets: %s", unit_id(UNIT(s
)), strerror(-r
));
479 socket_set_state(s
, SOCKET_LISTENING
);
483 socket_enter_stop_pre(s
, false);
486 static void socket_enter_start_post(Socket
*s
) {
490 if ((r
= socket_open_fds(s
)) < 0) {
491 log_warning("%s failed to listen on sockets: %s", unit_id(UNIT(s
)), strerror(-r
));
495 if ((s
->control_command
= s
->exec_command
[SOCKET_EXEC_START_POST
]))
496 if ((r
= socket_spawn(s
, s
->control_command
, true, &s
->control_pid
)) < 0) {
497 log_warning("%s failed to run start-post executable: %s", unit_id(UNIT(s
)), strerror(-r
));
501 socket_set_state(s
, SOCKET_START_POST
);
503 if (!s
->control_command
)
504 socket_enter_listening(s
);
509 socket_enter_stop_pre(s
, false);
512 static void socket_enter_start_pre(Socket
*s
) {
516 if ((s
->control_command
= s
->exec_command
[SOCKET_EXEC_START_PRE
]))
517 if ((r
= socket_spawn(s
, s
->control_command
, true, &s
->control_pid
)) < 0)
520 socket_set_state(s
, SOCKET_START_PRE
);
522 if (!s
->control_command
)
523 socket_enter_start_post(s
);
528 log_warning("%s failed to run start-pre exectuable: %s", unit_id(UNIT(s
)), strerror(-r
));
529 socket_enter_dead(s
, false);
532 static void socket_enter_running(Socket
*s
) {
537 if ((r
= manager_add_job(UNIT(s
)->meta
.manager
, JOB_START
, UNIT(s
->service
), JOB_REPLACE
, true, NULL
)) < 0)
540 socket_set_state(s
, SOCKET_RUNNING
);
544 log_warning("%s failed to queue socket startup job: %s", unit_id(UNIT(s
)), strerror(-r
));
545 socket_enter_dead(s
, false);
548 static void socket_run_next(Socket
*s
, bool success
) {
552 assert(s
->control_command
);
553 assert(s
->control_command
->command_next
);
558 s
->control_command
= s
->control_command
->command_next
;
560 if ((r
= socket_spawn(s
, s
->control_command
, true, &s
->control_pid
)) < 0)
566 if (s
->state
== SOCKET_STOP_PRE
)
567 socket_enter_stop_post(s
, false);
568 else if (s
->state
== SOCKET_STOP_POST
)
569 socket_enter_dead(s
, false);
571 socket_enter_stop_pre(s
, false);
574 static int socket_start(Unit
*u
) {
575 Socket
*s
= SOCKET(u
);
579 /* We cannot fulfill this request right now, try again later
581 if (s
->state
== SOCKET_STOP_PRE
||
582 s
->state
== SOCKET_STOP_PRE_SIGKILL
||
583 s
->state
== SOCKET_STOP_PRE_SIGTERM
||
584 s
->state
== SOCKET_STOP_POST
||
585 s
->state
== SOCKET_STOP_POST_SIGTERM
||
586 s
->state
== SOCKET_STOP_POST_SIGKILL
)
589 if (s
->state
== SOCKET_START_PRE
||
590 s
->state
== SOCKET_START_POST
)
593 /* Cannot run this without the service being around */
594 if (s
->service
->meta
.load_state
!= UNIT_LOADED
)
597 assert(s
->state
== SOCKET_DEAD
|| s
->state
== SOCKET_MAINTAINANCE
);
600 socket_enter_start_pre(s
);
604 static int socket_stop(Unit
*u
) {
605 Socket
*s
= SOCKET(u
);
609 /* We cannot fulfill this request right now, try again later
611 if (s
->state
== SOCKET_START_PRE
||
612 s
->state
== SOCKET_START_POST
)
615 assert(s
->state
== SOCKET_LISTENING
|| s
->state
== SOCKET_RUNNING
);
617 socket_enter_stop_pre(s
, true);
621 static UnitActiveState
socket_active_state(Unit
*u
) {
624 return state_translation_table
[SOCKET(u
)->state
];
627 static void socket_fd_event(Unit
*u
, int fd
, uint32_t events
, Watch
*w
) {
628 Socket
*s
= SOCKET(u
);
632 log_debug("Incoming traffic on %s", unit_id(u
));
634 if (events
!= POLLIN
)
635 socket_enter_stop_pre(s
, false);
637 socket_enter_running(s
);
640 static void socket_sigchld_event(Unit
*u
, pid_t pid
, int code
, int status
) {
641 Socket
*s
= SOCKET(u
);
647 success
= code
== CLD_EXITED
&& status
== 0;
648 s
->failure
= s
->failure
|| !success
;
650 assert(s
->control_pid
== pid
);
651 assert(s
->control_command
);
653 exec_status_fill(&s
->control_command
->exec_status
, pid
, code
, status
);
656 log_debug("%s control process exited, code=%s status=%i", unit_id(u
), sigchld_code(code
), status
);
658 if (s
->control_command
->command_next
&&
659 (success
|| (s
->state
== SOCKET_EXEC_STOP_PRE
|| s
->state
== SOCKET_EXEC_STOP_POST
))) {
660 log_debug("%s running next command for the state %s", unit_id(u
), state_string_table
[s
->state
]);
661 socket_run_next(s
, success
);
663 /* No further commands for this step, so let's figure
664 * out what to do next */
666 log_debug("%s got final SIGCHLD for state %s", unit_id(u
), state_string_table
[s
->state
]);
670 case SOCKET_START_PRE
:
672 socket_enter_start_post(s
);
674 socket_enter_stop_pre(s
, false);
677 case SOCKET_START_POST
:
679 socket_enter_listening(s
);
681 socket_enter_stop_pre(s
, false);
684 case SOCKET_STOP_PRE
:
685 case SOCKET_STOP_PRE_SIGTERM
:
686 case SOCKET_STOP_PRE_SIGKILL
:
687 socket_enter_stop_post(s
, success
);
690 case SOCKET_STOP_POST
:
691 case SOCKET_STOP_POST_SIGTERM
:
692 case SOCKET_STOP_POST_SIGKILL
:
693 socket_enter_dead(s
, success
);
697 assert_not_reached("Uh, control process died at wrong time.");
702 static void socket_timer_event(Unit
*u
, uint64_t elapsed
, Watch
*w
) {
703 Socket
*s
= SOCKET(u
);
706 assert(elapsed
== 1);
708 assert(w
== &s
->timer_watch
);
712 case SOCKET_START_PRE
:
713 case SOCKET_START_POST
:
714 log_warning("%s operation timed out. Stopping.", unit_id(u
));
715 socket_enter_stop_pre(s
, false);
718 case SOCKET_STOP_PRE
:
719 log_warning("%s stopping timed out. Terminating.", unit_id(u
));
720 socket_enter_signal(s
, SOCKET_STOP_PRE_SIGTERM
, false);
723 case SOCKET_STOP_PRE_SIGTERM
:
724 log_warning("%s stopping timed out. Killing.", unit_id(u
));
725 socket_enter_signal(s
, SOCKET_STOP_PRE_SIGKILL
, false);
728 case SOCKET_STOP_PRE_SIGKILL
:
729 log_warning("%s still around after SIGKILL. Ignoring.", unit_id(u
));
730 socket_enter_stop_post(s
, false);
733 case SOCKET_STOP_POST
:
734 log_warning("%s stopping timed out (2). Terminating.", unit_id(u
));
735 socket_enter_signal(s
, SOCKET_STOP_POST_SIGTERM
, false);
738 case SOCKET_STOP_POST_SIGTERM
:
739 log_warning("%s stopping timed out (2). Killing.", unit_id(u
));
740 socket_enter_signal(s
, SOCKET_STOP_POST_SIGKILL
, false);
743 case SOCKET_STOP_POST_SIGKILL
:
744 log_warning("%s still around after SIGKILL (2). Entering maintainance mode.", unit_id(u
));
745 socket_enter_dead(s
, false);
749 assert_not_reached("Timeout at wrong time.");
753 int socket_collect_fds(Socket
*s
, int **fds
, unsigned *n_fds
) {
762 /* Called from the service code for requesting our fds */
765 LIST_FOREACH(port
, p
, s
->ports
)
769 if (!(rfds
= new(int, rn_fds
)) < 0)
773 LIST_FOREACH(port
, p
, s
->ports
)
785 void socket_notify_service_dead(Socket
*s
) {
788 /* The service is dead. Dang. */
790 if (s
->state
== SOCKET_RUNNING
) {
791 log_debug("%s got notified about service death.", unit_id(UNIT(s
)));
792 socket_enter_listening(s
);
796 const UnitVTable socket_vtable
= {
804 .start
= socket_start
,
807 .active_state
= socket_active_state
,
809 .fd_event
= socket_fd_event
,
810 .sigchld_event
= socket_sigchld_event
,
811 .timer_event
= socket_timer_event