1 /*-*- Mode: C; c-basic-offset: 8 -*-*/
15 static const UnitActiveState state_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 void socket_done(Unit
*u
) {
31 Socket
*s
= SOCKET(u
);
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 unit_unwatch_pid(u
, s
->control_pid
);
56 unit_unwatch_timer(u
, &s
->timer_id
);
59 static int socket_init(Unit
*u
) {
60 Socket
*s
= SOCKET(u
);
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
= unit_load_fragment_and_dropin(u
)) < 0)
77 if (!(t
= unit_name_change_suffix(unit_id(u
), ".service"))) {
82 r
= manager_load_unit(u
->meta
.manager
, t
, (Unit
**) &s
->service
);
88 if ((r
= unit_add_dependency(u
, UNIT_BEFORE
, UNIT(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(Unit
*u
, 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(u
);
142 prefix2
= strappend(prefix
, "\t");
147 "%sSocket State: %s\n"
148 "%sBindIPv6Only: %s\n"
150 prefix
, state_table
[s
->state
],
151 prefix
, yes_no(s
->bind_ipv6_only
),
154 LIST_FOREACH(port
, p
, s
->ports
) {
156 if (p
->type
== SOCKET_SOCKET
) {
161 if ((r
= socket_address_print(&p
->address
, &k
)) < 0)
166 fprintf(f
, "%s%s: %s\n", prefix
, listen_lookup(p
->address
.type
), k
);
169 fprintf(f
, "%sListenFIFO: %s\n", prefix
, p
->path
);
172 exec_context_dump(&s
->exec_context
, f
, prefix
);
174 for (c
= 0; c
< _SOCKET_EXEC_MAX
; c
++) {
175 if (!s
->exec_command
[c
])
178 fprintf(f
, "%s→ %s:\n",
179 prefix
, command_table
[c
]);
181 exec_command_dump_list(s
->exec_command
[c
], f
, prefix2
);
187 static void socket_close_fds(Socket
*s
) {
192 LIST_FOREACH(port
, p
, s
->ports
) {
196 unit_unwatch_fd(UNIT(s
), p
->fd
);
197 assert_se(close_nointr(p
->fd
) >= 0);
203 static int socket_open_fds(Socket
*s
) {
209 LIST_FOREACH(port
, p
, s
->ports
) {
214 if (p
->type
== SOCKET_SOCKET
) {
216 if ((r
= socket_address_listen(&p
->address
, s
->backlog
, s
->bind_ipv6_only
, &p
->fd
)) < 0)
221 assert(p
->type
== SOCKET_FIFO
);
223 if (mkfifo(p
->path
, 0666 & ~s
->exec_context
.umask
) < 0 && errno
!= EEXIST
) {
228 if ((p
->fd
= open(p
->path
, O_RDWR
|O_CLOEXEC
|O_NOCTTY
|O_NONBLOCK
|O_NOFOLLOW
)) < 0) {
233 if (fstat(p
->fd
, &st
) < 0) {
238 /* FIXME verify user, access mode */
240 if (!S_ISFIFO(st
.st_mode
)) {
254 static void socket_unwatch_fds(Socket
*s
) {
259 LIST_FOREACH(port
, p
, s
->ports
) {
263 unit_unwatch_fd(UNIT(s
), p
->fd
);
267 static int socket_watch_fds(Socket
*s
) {
273 LIST_FOREACH(port
, p
, s
->ports
) {
277 if ((r
= unit_watch_fd(UNIT(s
), p
->fd
, POLLIN
)) < 0)
284 socket_unwatch_fds(s
);
288 static void socket_set_state(Socket
*s
, SocketState state
) {
289 SocketState old_state
;
292 old_state
= s
->state
;
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 unit_unwatch_timer(UNIT(s
), &s
->timer_id
);
305 if (state
!= SOCKET_START_PRE
&&
306 state
!= SOCKET_START_POST
&&
307 state
!= SOCKET_STOP_PRE
&&
308 state
!= SOCKET_STOP_PRE_SIGTERM
&&
309 state
!= SOCKET_STOP_PRE_SIGKILL
&&
310 state
!= SOCKET_STOP_POST
&&
311 state
!= SOCKET_STOP_POST_SIGTERM
&&
312 state
!= SOCKET_STOP_POST_SIGKILL
)
313 if (s
->control_pid
>= 0) {
314 unit_unwatch_pid(UNIT(s
), s
->control_pid
);
318 if (state
!= SOCKET_START_PRE
&&
319 state
!= SOCKET_START_POST
&&
320 state
!= SOCKET_STOP_PRE
&&
321 state
!= SOCKET_STOP_POST
)
322 s
->control_command
= NULL
;
324 if (state
!= SOCKET_START_POST
&&
325 state
!= SOCKET_LISTENING
&&
326 state
!= SOCKET_RUNNING
&&
327 state
!= SOCKET_STOP_PRE
&&
328 state
!= SOCKET_STOP_PRE_SIGTERM
&&
329 state
!= SOCKET_STOP_PRE_SIGKILL
)
332 if (state
!= SOCKET_LISTENING
)
333 socket_unwatch_fds(s
);
335 unit_notify(UNIT(s
), state_table
[old_state
], state_table
[s
->state
]);
338 static int socket_spawn(Socket
*s
, ExecCommand
*c
, bool timeout
, pid_t
*_pid
) {
347 if ((r
= unit_watch_timer(UNIT(s
), s
->timeout_usec
, &s
->timer_id
)) < 0)
350 unit_unwatch_timer(UNIT(s
), &s
->timer_id
);
352 if ((r
= exec_spawn(c
, &s
->exec_context
, NULL
, 0, &pid
)) < 0)
355 if ((r
= unit_watch_pid(UNIT(s
), pid
)) < 0)
356 /* FIXME: we need to do something here */
365 unit_unwatch_timer(UNIT(s
), &s
->timer_id
);
370 static void socket_enter_dead(Socket
*s
, bool success
) {
376 socket_set_state(s
, s
->failure
? SOCKET_MAINTAINANCE
: SOCKET_DEAD
);
379 static void socket_enter_stop_post(Socket
*s
, bool success
) {
386 if ((s
->control_command
= s
->exec_command
[SOCKET_EXEC_STOP_POST
])) {
388 if ((r
= socket_spawn(s
, s
->control_command
, true, &s
->control_pid
)) < 0)
391 socket_set_state(s
, SOCKET_STOP_POST
);
393 socket_enter_dead(s
, true);
398 log_warning("%s failed to run stop-post executable: %s", unit_id(UNIT(s
)), strerror(-r
));
399 socket_enter_dead(s
, false);
402 static void socket_enter_signal(Socket
*s
, SocketState state
, bool success
) {
410 if (s
->control_pid
> 0) {
413 sig
= (state
== SOCKET_STOP_PRE_SIGTERM
|| state
== SOCKET_STOP_POST_SIGTERM
) ? SIGTERM
: SIGKILL
;
415 if (kill(s
->control_pid
, sig
) < 0 && errno
!= ESRCH
) {
420 socket_set_state(s
, state
);
422 socket_enter_dead(s
, true);
427 log_warning("%s failed to kill processes: %s", unit_id(UNIT(s
)), strerror(-r
));
429 if (state
== SOCKET_STOP_PRE_SIGTERM
|| state
== SOCKET_STOP_PRE_SIGKILL
)
430 socket_enter_stop_post(s
, false);
432 socket_enter_dead(s
, false);
435 static void socket_enter_stop_pre(Socket
*s
, bool success
) {
442 if ((s
->control_command
= s
->exec_command
[SOCKET_EXEC_STOP_PRE
])) {
444 if ((r
= socket_spawn(s
, s
->control_command
, true, &s
->control_pid
)) < 0)
447 socket_set_state(s
, SOCKET_STOP_PRE
);
449 socket_enter_stop_post(s
, true);
454 log_warning("%s failed to run stop-pre executable: %s", unit_id(UNIT(s
)), strerror(-r
));
455 socket_enter_stop_post(s
, false);
458 static void socket_enter_start_post(Socket
*s
) {
462 if ((r
= socket_open_fds(s
)) < 0 ||
463 (r
= socket_watch_fds(s
)) < 0) {
464 log_warning("%s failed to listen on sockets: %s", unit_id(UNIT(s
)), strerror(-r
));
468 if ((s
->control_command
= s
->exec_command
[SOCKET_EXEC_START_POST
])) {
470 if ((r
= socket_spawn(s
, s
->control_command
, true, &s
->control_pid
)) < 0) {
471 log_warning("%s failed to run start-post executable: %s", unit_id(UNIT(s
)), strerror(-r
));
475 socket_set_state(s
, SOCKET_START_POST
);
477 socket_set_state(s
, SOCKET_LISTENING
);
482 socket_enter_stop_pre(s
, false);
485 static void socket_enter_start_pre(Socket
*s
) {
489 if ((s
->control_command
= s
->exec_command
[SOCKET_EXEC_START_PRE
])) {
491 if ((r
= socket_spawn(s
, s
->control_command
, true, &s
->control_pid
)) < 0)
494 socket_set_state(s
, SOCKET_START_PRE
);
496 socket_enter_start_post(s
);
501 log_warning("%s failed to run start-pre exectuable: %s", unit_id(UNIT(s
)), strerror(-r
));
502 socket_enter_dead(s
, false);
505 static void socket_enter_running(Socket
*s
) {
510 if ((r
= manager_add_job(UNIT(s
)->meta
.manager
, JOB_START
, UNIT(s
->service
), JOB_REPLACE
, true, NULL
)) < 0)
513 socket_set_state(s
, SOCKET_RUNNING
);
517 log_warning("%s failed to queue socket startup job: %s", unit_id(UNIT(s
)), strerror(-r
));
518 socket_enter_dead(s
, false);
521 static void socket_run_next(Socket
*s
, bool success
) {
525 assert(s
->control_command
);
526 assert(s
->control_command
->command_next
);
531 s
->control_command
= s
->control_command
->command_next
;
533 if ((r
= socket_spawn(s
, s
->control_command
, true, &s
->control_pid
)) < 0)
539 if (s
->state
== SOCKET_STOP_PRE
)
540 socket_enter_stop_post(s
, false);
541 else if (s
->state
== SOCKET_STOP_POST
)
542 socket_enter_dead(s
, false);
544 socket_enter_stop_pre(s
, false);
547 static int socket_start(Unit
*u
) {
548 Socket
*s
= SOCKET(u
);
552 /* We cannot fulfill this request right now, try again later
554 if (s
->state
== SOCKET_STOP_PRE
||
555 s
->state
== SOCKET_STOP_PRE_SIGKILL
||
556 s
->state
== SOCKET_STOP_PRE_SIGTERM
||
557 s
->state
== SOCKET_STOP_POST
||
558 s
->state
== SOCKET_STOP_POST_SIGTERM
||
559 s
->state
== SOCKET_STOP_POST_SIGKILL
)
562 if (s
->state
== SOCKET_START_PRE
||
563 s
->state
== SOCKET_START_POST
)
566 /* Cannot run this without the service being around */
567 if (s
->service
->meta
.load_state
!= UNIT_LOADED
)
570 assert(s
->state
== SOCKET_DEAD
|| s
->state
== SOCKET_MAINTAINANCE
);
573 socket_enter_start_pre(s
);
577 static int socket_stop(Unit
*u
) {
578 Socket
*s
= SOCKET(u
);
582 /* We cannot fulfill this request right now, try again later
584 if (s
->state
== SOCKET_START_PRE
||
585 s
->state
== SOCKET_START_POST
)
588 assert(s
->state
== SOCKET_LISTENING
|| s
->state
== SOCKET_RUNNING
);
590 socket_enter_stop_pre(s
, true);
594 static UnitActiveState
socket_active_state(Unit
*u
) {
597 return state_table
[SOCKET(u
)->state
];
600 static void socket_fd_event(Unit
*u
, int fd
, uint32_t events
) {
601 Socket
*s
= SOCKET(u
);
605 log_info("Incoming traffic on %s", unit_id(u
));
607 if (events
!= POLLIN
)
608 socket_enter_stop_pre(s
, false);
610 socket_enter_running(s
);
613 static void socket_sigchld_event(Unit
*u
, pid_t pid
, int code
, int status
) {
614 Socket
*s
= SOCKET(u
);
620 success
= code
== CLD_EXITED
|| status
== 0;
621 s
->failure
= s
->failure
|| !success
;
623 assert(s
->control_pid
== pid
);
624 assert(s
->control_command
);
626 exec_status_fill(&s
->control_command
->exec_status
, pid
, code
, status
);
629 log_debug("%s: control process exited, code=%s status=%i", unit_id(u
), sigchld_code(code
), status
);
631 if (s
->control_command
->command_next
&&
632 (success
|| (s
->state
== SOCKET_EXEC_STOP_PRE
|| s
->state
== SOCKET_EXEC_STOP_POST
)))
633 socket_run_next(s
, success
);
635 /* No further commands for this step, so let's figure
636 * out what to do next */
640 case SOCKET_START_PRE
:
642 socket_enter_start_pre(s
);
644 socket_enter_stop_pre(s
, false);
647 case SOCKET_START_POST
:
649 socket_set_state(s
, SOCKET_LISTENING
);
651 socket_enter_stop_pre(s
, false);
654 case SOCKET_STOP_PRE
:
655 case SOCKET_STOP_PRE_SIGTERM
:
656 case SOCKET_STOP_PRE_SIGKILL
:
657 socket_enter_stop_post(s
, success
);
660 case SOCKET_STOP_POST
:
661 case SOCKET_STOP_POST_SIGTERM
:
662 case SOCKET_STOP_POST_SIGKILL
:
663 socket_enter_dead(s
, success
);
667 assert_not_reached("Uh, control process died at wrong time.");
672 static void socket_timer_event(Unit
*u
, int id
, uint64_t elapsed
) {
673 Socket
*s
= SOCKET(u
);
676 assert(elapsed
== 1);
678 assert(s
->timer_id
== id
);
682 case SOCKET_START_PRE
:
683 case SOCKET_START_POST
:
684 log_warning("%s operation timed out. Stopping.", unit_id(u
));
685 socket_enter_stop_pre(s
, false);
688 case SOCKET_STOP_PRE
:
689 log_warning("%s stopping timed out. Terminating.", unit_id(u
));
690 socket_enter_signal(s
, SOCKET_STOP_PRE_SIGTERM
, false);
693 case SOCKET_STOP_PRE_SIGTERM
:
694 log_warning("%s stopping timed out. Killing.", unit_id(u
));
695 socket_enter_signal(s
, SOCKET_STOP_PRE_SIGKILL
, false);
698 case SOCKET_STOP_PRE_SIGKILL
:
699 log_warning("%s still around after SIGKILL. Ignoring.", unit_id(u
));
700 socket_enter_stop_post(s
, false);
703 case SOCKET_STOP_POST
:
704 log_warning("%s stopping timed out (2). Terminating.", unit_id(u
));
705 socket_enter_signal(s
, SOCKET_STOP_POST_SIGTERM
, false);
708 case SOCKET_STOP_POST_SIGTERM
:
709 log_warning("%s stopping timed out (2). Killing.", unit_id(u
));
710 socket_enter_signal(s
, SOCKET_STOP_POST_SIGKILL
, false);
713 case SOCKET_STOP_POST_SIGKILL
:
714 log_warning("%s still around after SIGKILL (2). Entering maintainance mode.", unit_id(u
));
715 socket_enter_dead(s
, false);
719 assert_not_reached("Timeout at wrong time.");
723 int socket_collect_fds(Socket
*s
, int **fds
, unsigned *n_fds
) {
732 /* Called from the service code for requesting our fds */
735 LIST_FOREACH(port
, p
, s
->ports
)
739 if (!(rfds
= new(int, rn_fds
)) < 0)
743 LIST_FOREACH(port
, p
, s
->ports
)
755 const UnitVTable socket_vtable
= {
763 .start
= socket_start
,
766 .active_state
= socket_active_state
,
768 .fd_event
= socket_fd_event
,
769 .sigchld_event
= socket_sigchld_event
,
770 .timer_event
= socket_timer_event