1 /*-*- Mode: C; c-basic-offset: 8 -*-*/
4 This file is part of systemd.
6 Copyright 2010 Lennart Poettering
8 systemd is free software; you can redistribute it and/or modify it
9 under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2 of the License, or
11 (at your option) any later version.
13 systemd is distributed in the hope that it will be useful, but
14 WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with systemd; If not, see <http://www.gnu.org/licenses/>.
22 #include <sys/types.h>
27 #include <sys/epoll.h>
34 static const UnitActiveState state_translation_table
[_SOCKET_STATE_MAX
] = {
35 [SOCKET_DEAD
] = UNIT_INACTIVE
,
36 [SOCKET_START_PRE
] = UNIT_ACTIVATING
,
37 [SOCKET_START_POST
] = UNIT_ACTIVATING
,
38 [SOCKET_LISTENING
] = UNIT_ACTIVE
,
39 [SOCKET_RUNNING
] = UNIT_ACTIVE
,
40 [SOCKET_STOP_PRE
] = UNIT_DEACTIVATING
,
41 [SOCKET_STOP_PRE_SIGTERM
] = UNIT_DEACTIVATING
,
42 [SOCKET_STOP_PRE_SIGKILL
] = UNIT_DEACTIVATING
,
43 [SOCKET_STOP_POST
] = UNIT_DEACTIVATING
,
44 [SOCKET_STOP_POST_SIGTERM
] = UNIT_DEACTIVATING
,
45 [SOCKET_STOP_POST_SIGKILL
] = UNIT_DEACTIVATING
,
46 [SOCKET_MAINTAINANCE
] = UNIT_INACTIVE
,
49 static const char* const state_string_table
[_SOCKET_STATE_MAX
] = {
50 [SOCKET_DEAD
] = "dead",
51 [SOCKET_START_PRE
] = "start-pre",
52 [SOCKET_START_POST
] = "start-post",
53 [SOCKET_LISTENING
] = "listening",
54 [SOCKET_RUNNING
] = "running",
55 [SOCKET_STOP_PRE
] = "stop-pre",
56 [SOCKET_STOP_PRE_SIGTERM
] = "stop-pre-sigterm",
57 [SOCKET_STOP_PRE_SIGKILL
] = "stop-pre-sigkill",
58 [SOCKET_STOP_POST
] = "stop-post",
59 [SOCKET_STOP_POST_SIGTERM
] = "stop-post-sigterm",
60 [SOCKET_STOP_POST_SIGKILL
] = "stop-post-sigkill",
61 [SOCKET_MAINTAINANCE
] = "maintainance"
64 static void socket_done(Unit
*u
) {
65 Socket
*s
= SOCKET(u
);
70 while ((p
= s
->ports
)) {
71 LIST_REMOVE(SocketPort
, port
, s
->ports
, p
);
79 exec_context_done(&s
->exec_context
);
80 exec_command_free_array(s
->exec_command
, _SOCKET_EXEC_MAX
);
81 s
->control_command
= NULL
;
83 if (s
->control_pid
> 0) {
84 unit_unwatch_pid(u
, s
->control_pid
);
90 free(s
->bind_to_device
);
92 unit_unwatch_timer(u
, &s
->timer_watch
);
95 static int socket_init(Unit
*u
) {
96 Socket
*s
= SOCKET(u
);
100 /* First, reset everything to the defaults, in case this is a
104 s
->timer_watch
.type
= WATCH_INVALID
;
105 s
->bind_ipv6_only
= false;
106 s
->backlog
= SOMAXCONN
;
107 s
->timeout_usec
= DEFAULT_TIMEOUT_USEC
;
108 s
->directory_mode
= 0755;
109 s
->socket_mode
= 0666;
110 exec_context_init(&s
->exec_context
);
112 if ((r
= unit_load_fragment_and_dropin(u
)) <= 0) {
118 if (!(t
= unit_name_change_suffix(unit_id(u
), ".service"))) {
123 r
= manager_load_unit(u
->meta
.manager
, t
, (Unit
**) &s
->service
);
129 if ((r
= unit_add_dependency(u
, UNIT_BEFORE
, UNIT(s
->service
))) < 0)
132 /* Add default cgroup */
133 if ((r
= unit_add_default_cgroup(u
)) < 0)
143 static const char* listen_lookup(int type
) {
145 if (type
== SOCK_STREAM
)
146 return "ListenStream";
147 else if (type
== SOCK_DGRAM
)
148 return "ListenDatagram";
149 else if (type
== SOCK_SEQPACKET
)
150 return "ListenSequentialPacket";
152 assert_not_reached("Unknown socket type");
156 static void socket_dump(Unit
*u
, FILE *f
, const char *prefix
) {
158 static const char* const command_table
[_SOCKET_EXEC_MAX
] = {
159 [SOCKET_EXEC_START_PRE
] = "StartPre",
160 [SOCKET_EXEC_START_POST
] = "StartPost",
161 [SOCKET_EXEC_STOP_PRE
] = "StopPre",
162 [SOCKET_EXEC_STOP_POST
] = "StopPost"
166 Socket
*s
= SOCKET(u
);
174 p2
= strappend(prefix
, "\t");
175 prefix2
= p2
? p2
: prefix
;
178 "%sSocket State: %s\n"
179 "%sBindIPv6Only: %s\n"
181 "%sSocketMode: %04o\n"
182 "%sDirectoryMode: %04o\n",
183 prefix
, state_string_table
[s
->state
],
184 prefix
, yes_no(s
->bind_ipv6_only
),
186 prefix
, s
->socket_mode
,
187 prefix
, s
->directory_mode
);
189 if (s
->bind_to_device
)
191 "%sBindToDevice: %s\n",
192 prefix
, s
->bind_to_device
);
194 LIST_FOREACH(port
, p
, s
->ports
) {
196 if (p
->type
== SOCKET_SOCKET
) {
201 if ((r
= socket_address_print(&p
->address
, &k
)) < 0)
206 fprintf(f
, "%s%s: %s\n", prefix
, listen_lookup(p
->address
.type
), k
);
209 fprintf(f
, "%sListenFIFO: %s\n", prefix
, p
->path
);
212 exec_context_dump(&s
->exec_context
, f
, prefix
);
214 for (c
= 0; c
< _SOCKET_EXEC_MAX
; c
++) {
215 if (!s
->exec_command
[c
])
218 fprintf(f
, "%s→ %s:\n",
219 prefix
, command_table
[c
]);
221 exec_command_dump_list(s
->exec_command
[c
], f
, prefix2
);
227 static void socket_close_fds(Socket
*s
) {
232 LIST_FOREACH(port
, p
, s
->ports
) {
236 unit_unwatch_fd(UNIT(s
), &p
->fd_watch
);
237 assert_se(close_nointr(p
->fd
) >= 0);
243 static int socket_open_fds(Socket
*s
) {
249 LIST_FOREACH(port
, p
, s
->ports
) {
254 if (p
->type
== SOCKET_SOCKET
) {
256 if ((r
= socket_address_listen(
268 assert(p
->type
== SOCKET_FIFO
);
270 mkdir_parents(p
->path
, s
->directory_mode
);
272 if (mkfifo(p
->path
, s
->socket_mode
) < 0 && errno
!= EEXIST
) {
277 if ((p
->fd
= open(p
->path
, O_RDWR
|O_CLOEXEC
|O_NOCTTY
|O_NONBLOCK
|O_NOFOLLOW
)) < 0) {
282 if (fstat(p
->fd
, &st
) < 0) {
287 /* FIXME verify user, access mode */
289 if (!S_ISFIFO(st
.st_mode
)) {
303 static void socket_unwatch_fds(Socket
*s
) {
308 LIST_FOREACH(port
, p
, s
->ports
) {
312 unit_unwatch_fd(UNIT(s
), &p
->fd_watch
);
316 static int socket_watch_fds(Socket
*s
) {
322 LIST_FOREACH(port
, p
, s
->ports
) {
326 if ((r
= unit_watch_fd(UNIT(s
), p
->fd
, EPOLLIN
, &p
->fd_watch
)) < 0)
333 socket_unwatch_fds(s
);
337 static void socket_set_state(Socket
*s
, SocketState state
) {
338 SocketState old_state
;
341 old_state
= s
->state
;
344 if (state
!= SOCKET_START_PRE
&&
345 state
!= SOCKET_START_POST
&&
346 state
!= SOCKET_STOP_PRE
&&
347 state
!= SOCKET_STOP_PRE_SIGTERM
&&
348 state
!= SOCKET_STOP_PRE_SIGKILL
&&
349 state
!= SOCKET_STOP_POST
&&
350 state
!= SOCKET_STOP_POST_SIGTERM
&&
351 state
!= SOCKET_STOP_POST_SIGKILL
)
352 unit_unwatch_timer(UNIT(s
), &s
->timer_watch
);
354 if (state
!= SOCKET_START_PRE
&&
355 state
!= SOCKET_START_POST
&&
356 state
!= SOCKET_STOP_PRE
&&
357 state
!= SOCKET_STOP_PRE_SIGTERM
&&
358 state
!= SOCKET_STOP_PRE_SIGKILL
&&
359 state
!= SOCKET_STOP_POST
&&
360 state
!= SOCKET_STOP_POST_SIGTERM
&&
361 state
!= SOCKET_STOP_POST_SIGKILL
)
362 if (s
->control_pid
> 0) {
363 unit_unwatch_pid(UNIT(s
), s
->control_pid
);
367 if (state
!= SOCKET_START_PRE
&&
368 state
!= SOCKET_START_POST
&&
369 state
!= SOCKET_STOP_PRE
&&
370 state
!= SOCKET_STOP_POST
)
371 s
->control_command
= NULL
;
373 if (state
!= SOCKET_START_POST
&&
374 state
!= SOCKET_LISTENING
&&
375 state
!= SOCKET_RUNNING
&&
376 state
!= SOCKET_STOP_PRE
&&
377 state
!= SOCKET_STOP_PRE_SIGTERM
&&
378 state
!= SOCKET_STOP_PRE_SIGKILL
)
381 if (state
!= SOCKET_LISTENING
)
382 socket_unwatch_fds(s
);
384 log_debug("%s changed %s → %s", unit_id(UNIT(s
)), state_string_table
[old_state
], state_string_table
[state
]);
386 unit_notify(UNIT(s
), state_translation_table
[old_state
], state_translation_table
[state
]);
389 static int socket_spawn(Socket
*s
, ExecCommand
*c
, bool timeout
, pid_t
*_pid
) {
398 if ((r
= unit_watch_timer(UNIT(s
), s
->timeout_usec
, &s
->timer_watch
)) < 0)
401 unit_unwatch_timer(UNIT(s
), &s
->timer_watch
);
403 if ((r
= exec_spawn(c
,
408 UNIT(s
)->meta
.cgroup_bondings
,
412 if ((r
= unit_watch_pid(UNIT(s
), pid
)) < 0)
413 /* FIXME: we need to do something here */
422 unit_unwatch_timer(UNIT(s
), &s
->timer_watch
);
427 static void socket_enter_dead(Socket
*s
, bool success
) {
433 socket_set_state(s
, s
->failure
? SOCKET_MAINTAINANCE
: SOCKET_DEAD
);
436 static void socket_enter_stop_post(Socket
*s
, bool success
) {
443 if ((s
->control_command
= s
->exec_command
[SOCKET_EXEC_STOP_POST
]))
444 if ((r
= socket_spawn(s
, s
->control_command
, true, &s
->control_pid
)) < 0)
447 socket_set_state(s
, SOCKET_STOP_POST
);
449 if (!s
->control_command
)
450 socket_enter_dead(s
, true);
455 log_warning("%s failed to run stop-post executable: %s", unit_id(UNIT(s
)), strerror(-r
));
456 socket_enter_dead(s
, false);
459 static void socket_enter_signal(Socket
*s
, SocketState state
, bool success
) {
467 if (s
->control_pid
> 0) {
470 sig
= (state
== SOCKET_STOP_PRE_SIGTERM
|| state
== SOCKET_STOP_POST_SIGTERM
) ? SIGTERM
: SIGKILL
;
472 if (kill(s
->control_pid
, sig
) < 0 && errno
!= ESRCH
) {
478 socket_set_state(s
, state
);
480 if (s
->control_pid
<= 0)
481 socket_enter_dead(s
, true);
486 log_warning("%s failed to kill processes: %s", unit_id(UNIT(s
)), strerror(-r
));
488 if (state
== SOCKET_STOP_PRE_SIGTERM
|| state
== SOCKET_STOP_PRE_SIGKILL
)
489 socket_enter_stop_post(s
, false);
491 socket_enter_dead(s
, false);
494 static void socket_enter_stop_pre(Socket
*s
, bool success
) {
501 if ((s
->control_command
= s
->exec_command
[SOCKET_EXEC_STOP_PRE
]))
502 if ((r
= socket_spawn(s
, s
->control_command
, true, &s
->control_pid
)) < 0)
505 socket_set_state(s
, SOCKET_STOP_PRE
);
507 if (!s
->control_command
)
508 socket_enter_stop_post(s
, true);
513 log_warning("%s failed to run stop-pre executable: %s", unit_id(UNIT(s
)), strerror(-r
));
514 socket_enter_stop_post(s
, false);
517 static void socket_enter_listening(Socket
*s
) {
521 if ((r
= socket_watch_fds(s
)) < 0) {
522 log_warning("%s failed to watch sockets: %s", unit_id(UNIT(s
)), strerror(-r
));
526 socket_set_state(s
, SOCKET_LISTENING
);
530 socket_enter_stop_pre(s
, false);
533 static void socket_enter_start_post(Socket
*s
) {
537 if ((r
= socket_open_fds(s
)) < 0) {
538 log_warning("%s failed to listen on sockets: %s", unit_id(UNIT(s
)), strerror(-r
));
542 if ((s
->control_command
= s
->exec_command
[SOCKET_EXEC_START_POST
]))
543 if ((r
= socket_spawn(s
, s
->control_command
, true, &s
->control_pid
)) < 0) {
544 log_warning("%s failed to run start-post executable: %s", unit_id(UNIT(s
)), strerror(-r
));
548 socket_set_state(s
, SOCKET_START_POST
);
550 if (!s
->control_command
)
551 socket_enter_listening(s
);
556 socket_enter_stop_pre(s
, false);
559 static void socket_enter_start_pre(Socket
*s
) {
563 if ((s
->control_command
= s
->exec_command
[SOCKET_EXEC_START_PRE
]))
564 if ((r
= socket_spawn(s
, s
->control_command
, true, &s
->control_pid
)) < 0)
567 socket_set_state(s
, SOCKET_START_PRE
);
569 if (!s
->control_command
)
570 socket_enter_start_post(s
);
575 log_warning("%s failed to run start-pre exectuable: %s", unit_id(UNIT(s
)), strerror(-r
));
576 socket_enter_dead(s
, false);
579 static void socket_enter_running(Socket
*s
) {
584 if ((r
= manager_add_job(UNIT(s
)->meta
.manager
, JOB_START
, UNIT(s
->service
), JOB_REPLACE
, true, NULL
)) < 0)
587 socket_set_state(s
, SOCKET_RUNNING
);
591 log_warning("%s failed to queue socket startup job: %s", unit_id(UNIT(s
)), strerror(-r
));
592 socket_enter_dead(s
, false);
595 static void socket_run_next(Socket
*s
, bool success
) {
599 assert(s
->control_command
);
600 assert(s
->control_command
->command_next
);
605 s
->control_command
= s
->control_command
->command_next
;
607 if ((r
= socket_spawn(s
, s
->control_command
, true, &s
->control_pid
)) < 0)
613 if (s
->state
== SOCKET_STOP_PRE
)
614 socket_enter_stop_post(s
, false);
615 else if (s
->state
== SOCKET_STOP_POST
)
616 socket_enter_dead(s
, false);
618 socket_enter_stop_pre(s
, false);
621 static int socket_start(Unit
*u
) {
622 Socket
*s
= SOCKET(u
);
626 /* We cannot fulfill this request right now, try again later
628 if (s
->state
== SOCKET_STOP_PRE
||
629 s
->state
== SOCKET_STOP_PRE_SIGKILL
||
630 s
->state
== SOCKET_STOP_PRE_SIGTERM
||
631 s
->state
== SOCKET_STOP_POST
||
632 s
->state
== SOCKET_STOP_POST_SIGTERM
||
633 s
->state
== SOCKET_STOP_POST_SIGKILL
)
636 if (s
->state
== SOCKET_START_PRE
||
637 s
->state
== SOCKET_START_POST
)
640 /* Cannot run this without the service being around */
641 if (s
->service
->meta
.load_state
!= UNIT_LOADED
)
644 assert(s
->state
== SOCKET_DEAD
|| s
->state
== SOCKET_MAINTAINANCE
);
647 socket_enter_start_pre(s
);
651 static int socket_stop(Unit
*u
) {
652 Socket
*s
= SOCKET(u
);
656 /* We cannot fulfill this request right now, try again later
658 if (s
->state
== SOCKET_START_PRE
||
659 s
->state
== SOCKET_START_POST
)
662 assert(s
->state
== SOCKET_LISTENING
|| s
->state
== SOCKET_RUNNING
);
664 socket_enter_stop_pre(s
, true);
668 static UnitActiveState
socket_active_state(Unit
*u
) {
671 return state_translation_table
[SOCKET(u
)->state
];
674 static void socket_fd_event(Unit
*u
, int fd
, uint32_t events
, Watch
*w
) {
675 Socket
*s
= SOCKET(u
);
679 log_debug("Incoming traffic on %s", unit_id(u
));
681 if (events
!= EPOLLIN
)
682 socket_enter_stop_pre(s
, false);
684 socket_enter_running(s
);
687 static void socket_sigchld_event(Unit
*u
, pid_t pid
, int code
, int status
) {
688 Socket
*s
= SOCKET(u
);
694 success
= code
== CLD_EXITED
&& status
== 0;
695 s
->failure
= s
->failure
|| !success
;
697 assert(s
->control_pid
== pid
);
698 assert(s
->control_command
);
700 exec_status_fill(&s
->control_command
->exec_status
, pid
, code
, status
);
703 log_debug("%s control process exited, code=%s status=%i", unit_id(u
), sigchld_code_to_string(code
), status
);
705 if (s
->control_command
->command_next
&&
706 (success
|| (s
->state
== SOCKET_STOP_PRE
|| s
->state
== SOCKET_STOP_POST
))) {
707 log_debug("%s running next command for the state %s", unit_id(u
), state_string_table
[s
->state
]);
708 socket_run_next(s
, success
);
710 /* No further commands for this step, so let's figure
711 * out what to do next */
713 log_debug("%s got final SIGCHLD for state %s", unit_id(u
), state_string_table
[s
->state
]);
717 case SOCKET_START_PRE
:
719 socket_enter_start_post(s
);
721 socket_enter_stop_pre(s
, false);
724 case SOCKET_START_POST
:
726 socket_enter_listening(s
);
728 socket_enter_stop_pre(s
, false);
731 case SOCKET_STOP_PRE
:
732 case SOCKET_STOP_PRE_SIGTERM
:
733 case SOCKET_STOP_PRE_SIGKILL
:
734 socket_enter_stop_post(s
, success
);
737 case SOCKET_STOP_POST
:
738 case SOCKET_STOP_POST_SIGTERM
:
739 case SOCKET_STOP_POST_SIGKILL
:
740 socket_enter_dead(s
, success
);
744 assert_not_reached("Uh, control process died at wrong time.");
749 static void socket_timer_event(Unit
*u
, uint64_t elapsed
, Watch
*w
) {
750 Socket
*s
= SOCKET(u
);
753 assert(elapsed
== 1);
755 assert(w
== &s
->timer_watch
);
759 case SOCKET_START_PRE
:
760 case SOCKET_START_POST
:
761 log_warning("%s operation timed out. Stopping.", unit_id(u
));
762 socket_enter_stop_pre(s
, false);
765 case SOCKET_STOP_PRE
:
766 log_warning("%s stopping timed out. Terminating.", unit_id(u
));
767 socket_enter_signal(s
, SOCKET_STOP_PRE_SIGTERM
, false);
770 case SOCKET_STOP_PRE_SIGTERM
:
771 log_warning("%s stopping timed out. Killing.", unit_id(u
));
772 socket_enter_signal(s
, SOCKET_STOP_PRE_SIGKILL
, false);
775 case SOCKET_STOP_PRE_SIGKILL
:
776 log_warning("%s still around after SIGKILL. Ignoring.", unit_id(u
));
777 socket_enter_stop_post(s
, false);
780 case SOCKET_STOP_POST
:
781 log_warning("%s stopping timed out (2). Terminating.", unit_id(u
));
782 socket_enter_signal(s
, SOCKET_STOP_POST_SIGTERM
, false);
785 case SOCKET_STOP_POST_SIGTERM
:
786 log_warning("%s stopping timed out (2). Killing.", unit_id(u
));
787 socket_enter_signal(s
, SOCKET_STOP_POST_SIGKILL
, false);
790 case SOCKET_STOP_POST_SIGKILL
:
791 log_warning("%s still around after SIGKILL (2). Entering maintainance mode.", unit_id(u
));
792 socket_enter_dead(s
, false);
796 assert_not_reached("Timeout at wrong time.");
800 int socket_collect_fds(Socket
*s
, int **fds
, unsigned *n_fds
) {
809 /* Called from the service code for requesting our fds */
812 LIST_FOREACH(port
, p
, s
->ports
)
816 if (!(rfds
= new(int, rn_fds
)) < 0)
820 LIST_FOREACH(port
, p
, s
->ports
)
832 void socket_notify_service_dead(Socket
*s
) {
835 /* The service is dead. Dang. */
837 if (s
->state
== SOCKET_RUNNING
) {
838 log_debug("%s got notified about service death.", unit_id(UNIT(s
)));
839 socket_enter_listening(s
);
843 const UnitVTable socket_vtable
= {
851 .start
= socket_start
,
854 .active_state
= socket_active_state
,
856 .fd_event
= socket_fd_event
,
857 .sigchld_event
= socket_sigchld_event
,
858 .timer_event
= socket_timer_event