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>
33 #include "load-dropin.h"
34 #include "load-fragment.h"
36 static const UnitActiveState state_translation_table
[_SOCKET_STATE_MAX
] = {
37 [SOCKET_DEAD
] = UNIT_INACTIVE
,
38 [SOCKET_START_PRE
] = UNIT_ACTIVATING
,
39 [SOCKET_START_POST
] = UNIT_ACTIVATING
,
40 [SOCKET_LISTENING
] = UNIT_ACTIVE
,
41 [SOCKET_RUNNING
] = UNIT_ACTIVE
,
42 [SOCKET_STOP_PRE
] = UNIT_DEACTIVATING
,
43 [SOCKET_STOP_PRE_SIGTERM
] = UNIT_DEACTIVATING
,
44 [SOCKET_STOP_PRE_SIGKILL
] = UNIT_DEACTIVATING
,
45 [SOCKET_STOP_POST
] = UNIT_DEACTIVATING
,
46 [SOCKET_STOP_POST_SIGTERM
] = UNIT_DEACTIVATING
,
47 [SOCKET_STOP_POST_SIGKILL
] = UNIT_DEACTIVATING
,
48 [SOCKET_MAINTAINANCE
] = UNIT_INACTIVE
,
51 static const char* const state_string_table
[_SOCKET_STATE_MAX
] = {
52 [SOCKET_DEAD
] = "dead",
53 [SOCKET_START_PRE
] = "start-pre",
54 [SOCKET_START_POST
] = "start-post",
55 [SOCKET_LISTENING
] = "listening",
56 [SOCKET_RUNNING
] = "running",
57 [SOCKET_STOP_PRE
] = "stop-pre",
58 [SOCKET_STOP_PRE_SIGTERM
] = "stop-pre-sigterm",
59 [SOCKET_STOP_PRE_SIGKILL
] = "stop-pre-sigkill",
60 [SOCKET_STOP_POST
] = "stop-post",
61 [SOCKET_STOP_POST_SIGTERM
] = "stop-post-sigterm",
62 [SOCKET_STOP_POST_SIGKILL
] = "stop-post-sigkill",
63 [SOCKET_MAINTAINANCE
] = "maintainance"
66 static void socket_done(Unit
*u
) {
67 Socket
*s
= SOCKET(u
);
72 while ((p
= s
->ports
)) {
73 LIST_REMOVE(SocketPort
, port
, s
->ports
, p
);
81 exec_context_done(&s
->exec_context
);
82 exec_command_free_array(s
->exec_command
, _SOCKET_EXEC_MAX
);
83 s
->control_command
= NULL
;
85 if (s
->control_pid
> 0) {
86 unit_unwatch_pid(u
, s
->control_pid
);
92 free(s
->bind_to_device
);
94 unit_unwatch_timer(u
, &s
->timer_watch
);
97 static int socket_init(Unit
*u
, UnitLoadState
*new_state
) {
98 Socket
*s
= SOCKET(u
);
102 /* First, reset everything to the defaults, in case this is a
106 s
->timer_watch
.type
= WATCH_INVALID
;
107 s
->bind_ipv6_only
= false;
108 s
->backlog
= SOMAXCONN
;
109 s
->timeout_usec
= DEFAULT_TIMEOUT_USEC
;
110 s
->directory_mode
= 0755;
111 s
->socket_mode
= 0666;
115 exec_context_init(&s
->exec_context
);
117 if ((r
= unit_load_fragment(u
, new_state
)) < 0)
120 if (*new_state
== UNIT_STUB
)
123 if ((r
= unit_load_dropin(unit_follow_merge(u
))) < 0)
126 /* This is a new unit? Then let's add in some extras */
127 if (*new_state
== UNIT_LOADED
) {
129 if (!(t
= unit_name_change_suffix(unit_id(u
), ".service")))
132 r
= manager_load_unit(u
->meta
.manager
, t
, (Unit
**) &s
->service
);
138 if ((r
= unit_add_dependency(u
, UNIT_BEFORE
, UNIT(s
->service
))) < 0)
141 if ((r
= unit_add_exec_dependencies(u
, &s
->exec_context
)) < 0)
144 if ((r
= unit_add_default_cgroup(u
)) < 0)
151 static const char* listen_lookup(int type
) {
153 if (type
== SOCK_STREAM
)
154 return "ListenStream";
155 else if (type
== SOCK_DGRAM
)
156 return "ListenDatagram";
157 else if (type
== SOCK_SEQPACKET
)
158 return "ListenSequentialPacket";
160 assert_not_reached("Unknown socket type");
164 static void socket_dump(Unit
*u
, FILE *f
, const char *prefix
) {
166 static const char* const command_table
[_SOCKET_EXEC_MAX
] = {
167 [SOCKET_EXEC_START_PRE
] = "StartPre",
168 [SOCKET_EXEC_START_POST
] = "StartPost",
169 [SOCKET_EXEC_STOP_PRE
] = "StopPre",
170 [SOCKET_EXEC_STOP_POST
] = "StopPost"
174 Socket
*s
= SOCKET(u
);
182 p2
= strappend(prefix
, "\t");
183 prefix2
= p2
? p2
: prefix
;
186 "%sSocket State: %s\n"
187 "%sBindIPv6Only: %s\n"
190 "%sSocketMode: %04o\n"
191 "%sDirectoryMode: %04o\n",
192 prefix
, state_string_table
[s
->state
],
193 prefix
, yes_no(s
->bind_ipv6_only
),
195 prefix
, kill_mode_to_string(s
->kill_mode
),
196 prefix
, s
->socket_mode
,
197 prefix
, s
->directory_mode
);
199 if (s
->bind_to_device
)
201 "%sBindToDevice: %s\n",
202 prefix
, s
->bind_to_device
);
204 LIST_FOREACH(port
, p
, s
->ports
) {
206 if (p
->type
== SOCKET_SOCKET
) {
211 if ((r
= socket_address_print(&p
->address
, &k
)) < 0)
216 fprintf(f
, "%s%s: %s\n", prefix
, listen_lookup(p
->address
.type
), k
);
219 fprintf(f
, "%sListenFIFO: %s\n", prefix
, p
->path
);
222 exec_context_dump(&s
->exec_context
, f
, prefix
);
224 for (c
= 0; c
< _SOCKET_EXEC_MAX
; c
++) {
225 if (!s
->exec_command
[c
])
228 fprintf(f
, "%s→ %s:\n",
229 prefix
, command_table
[c
]);
231 exec_command_dump_list(s
->exec_command
[c
], f
, prefix2
);
237 static void socket_close_fds(Socket
*s
) {
242 LIST_FOREACH(port
, p
, s
->ports
) {
246 unit_unwatch_fd(UNIT(s
), &p
->fd_watch
);
247 assert_se(close_nointr(p
->fd
) >= 0);
253 static int socket_open_fds(Socket
*s
) {
259 LIST_FOREACH(port
, p
, s
->ports
) {
264 if (p
->type
== SOCKET_SOCKET
) {
266 if ((r
= socket_address_listen(
278 assert(p
->type
== SOCKET_FIFO
);
280 mkdir_parents(p
->path
, s
->directory_mode
);
282 if (mkfifo(p
->path
, s
->socket_mode
) < 0 && errno
!= EEXIST
) {
287 if ((p
->fd
= open(p
->path
, O_RDWR
|O_CLOEXEC
|O_NOCTTY
|O_NONBLOCK
|O_NOFOLLOW
)) < 0) {
292 if (fstat(p
->fd
, &st
) < 0) {
297 /* FIXME verify user, access mode */
299 if (!S_ISFIFO(st
.st_mode
)) {
313 static void socket_unwatch_fds(Socket
*s
) {
318 LIST_FOREACH(port
, p
, s
->ports
) {
322 unit_unwatch_fd(UNIT(s
), &p
->fd_watch
);
326 static int socket_watch_fds(Socket
*s
) {
332 LIST_FOREACH(port
, p
, s
->ports
) {
336 if ((r
= unit_watch_fd(UNIT(s
), p
->fd
, EPOLLIN
, &p
->fd_watch
)) < 0)
343 socket_unwatch_fds(s
);
347 static void socket_set_state(Socket
*s
, SocketState state
) {
348 SocketState old_state
;
351 old_state
= s
->state
;
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 unit_unwatch_timer(UNIT(s
), &s
->timer_watch
);
364 if (state
!= SOCKET_START_PRE
&&
365 state
!= SOCKET_START_POST
&&
366 state
!= SOCKET_STOP_PRE
&&
367 state
!= SOCKET_STOP_PRE_SIGTERM
&&
368 state
!= SOCKET_STOP_PRE_SIGKILL
&&
369 state
!= SOCKET_STOP_POST
&&
370 state
!= SOCKET_STOP_POST_SIGTERM
&&
371 state
!= SOCKET_STOP_POST_SIGKILL
)
372 if (s
->control_pid
> 0) {
373 unit_unwatch_pid(UNIT(s
), s
->control_pid
);
377 if (state
!= SOCKET_START_PRE
&&
378 state
!= SOCKET_START_POST
&&
379 state
!= SOCKET_STOP_PRE
&&
380 state
!= SOCKET_STOP_POST
)
381 s
->control_command
= NULL
;
383 if (state
!= SOCKET_START_POST
&&
384 state
!= SOCKET_LISTENING
&&
385 state
!= SOCKET_RUNNING
&&
386 state
!= SOCKET_STOP_PRE
&&
387 state
!= SOCKET_STOP_PRE_SIGTERM
&&
388 state
!= SOCKET_STOP_PRE_SIGKILL
)
391 if (state
!= SOCKET_LISTENING
)
392 socket_unwatch_fds(s
);
394 if (state
== old_state
)
397 log_debug("%s changed %s → %s", unit_id(UNIT(s
)), state_string_table
[old_state
], state_string_table
[state
]);
399 unit_notify(UNIT(s
), state_translation_table
[old_state
], state_translation_table
[state
]);
402 static int socket_spawn(Socket
*s
, ExecCommand
*c
, bool timeout
, pid_t
*_pid
) {
411 if ((r
= unit_watch_timer(UNIT(s
), s
->timeout_usec
, &s
->timer_watch
)) < 0)
414 unit_unwatch_timer(UNIT(s
), &s
->timer_watch
);
416 if ((r
= exec_spawn(c
,
421 UNIT(s
)->meta
.cgroup_bondings
,
425 if ((r
= unit_watch_pid(UNIT(s
), pid
)) < 0)
426 /* FIXME: we need to do something here */
435 unit_unwatch_timer(UNIT(s
), &s
->timer_watch
);
440 static void socket_enter_dead(Socket
*s
, bool success
) {
446 socket_set_state(s
, s
->failure
? SOCKET_MAINTAINANCE
: SOCKET_DEAD
);
449 static void socket_enter_stop_post(Socket
*s
, bool success
) {
456 if ((s
->control_command
= s
->exec_command
[SOCKET_EXEC_STOP_POST
]))
457 if ((r
= socket_spawn(s
, s
->control_command
, true, &s
->control_pid
)) < 0)
460 socket_set_state(s
, SOCKET_STOP_POST
);
462 if (!s
->control_command
)
463 socket_enter_dead(s
, true);
468 log_warning("%s failed to run stop-post executable: %s", unit_id(UNIT(s
)), strerror(-r
));
469 socket_enter_dead(s
, false);
472 static void socket_enter_signal(Socket
*s
, SocketState state
, bool success
) {
480 if (s
->control_pid
> 0) {
484 sig
= (state
== SOCKET_STOP_PRE_SIGTERM
|| state
== SOCKET_STOP_POST_SIGTERM
) ? SIGTERM
: SIGKILL
;
486 if (s
->kill_mode
== KILL_CONTROL_GROUP
) {
488 if ((r
= cgroup_bonding_kill_list(UNIT(s
)->meta
.cgroup_bondings
, sig
)) < 0) {
489 if (r
!= -EAGAIN
&& r
!= -ESRCH
)
496 if (kill(s
->kill_mode
== KILL_PROCESS
? s
->control_pid
: -s
->control_pid
, sig
) < 0 && errno
!= ESRCH
) {
503 socket_set_state(s
, state
);
505 if (s
->control_pid
<= 0)
506 socket_enter_dead(s
, true);
511 log_warning("%s failed to kill processes: %s", unit_id(UNIT(s
)), strerror(-r
));
513 if (state
== SOCKET_STOP_PRE_SIGTERM
|| state
== SOCKET_STOP_PRE_SIGKILL
)
514 socket_enter_stop_post(s
, false);
516 socket_enter_dead(s
, false);
519 static void socket_enter_stop_pre(Socket
*s
, bool success
) {
526 if ((s
->control_command
= s
->exec_command
[SOCKET_EXEC_STOP_PRE
]))
527 if ((r
= socket_spawn(s
, s
->control_command
, true, &s
->control_pid
)) < 0)
530 socket_set_state(s
, SOCKET_STOP_PRE
);
532 if (!s
->control_command
)
533 socket_enter_stop_post(s
, true);
538 log_warning("%s failed to run stop-pre executable: %s", unit_id(UNIT(s
)), strerror(-r
));
539 socket_enter_stop_post(s
, false);
542 static void socket_enter_listening(Socket
*s
) {
546 if ((r
= socket_watch_fds(s
)) < 0) {
547 log_warning("%s failed to watch sockets: %s", unit_id(UNIT(s
)), strerror(-r
));
551 socket_set_state(s
, SOCKET_LISTENING
);
555 socket_enter_stop_pre(s
, false);
558 static void socket_enter_start_post(Socket
*s
) {
562 if ((r
= socket_open_fds(s
)) < 0) {
563 log_warning("%s failed to listen on sockets: %s", unit_id(UNIT(s
)), strerror(-r
));
567 if ((s
->control_command
= s
->exec_command
[SOCKET_EXEC_START_POST
]))
568 if ((r
= socket_spawn(s
, s
->control_command
, true, &s
->control_pid
)) < 0) {
569 log_warning("%s failed to run start-post executable: %s", unit_id(UNIT(s
)), strerror(-r
));
573 socket_set_state(s
, SOCKET_START_POST
);
575 if (!s
->control_command
)
576 socket_enter_listening(s
);
581 socket_enter_stop_pre(s
, false);
584 static void socket_enter_start_pre(Socket
*s
) {
588 if ((s
->control_command
= s
->exec_command
[SOCKET_EXEC_START_PRE
]))
589 if ((r
= socket_spawn(s
, s
->control_command
, true, &s
->control_pid
)) < 0)
592 socket_set_state(s
, SOCKET_START_PRE
);
594 if (!s
->control_command
)
595 socket_enter_start_post(s
);
600 log_warning("%s failed to run start-pre exectuable: %s", unit_id(UNIT(s
)), strerror(-r
));
601 socket_enter_dead(s
, false);
604 static void socket_enter_running(Socket
*s
) {
609 if ((r
= manager_add_job(UNIT(s
)->meta
.manager
, JOB_START
, UNIT(s
->service
), JOB_REPLACE
, true, NULL
)) < 0)
612 socket_set_state(s
, SOCKET_RUNNING
);
616 log_warning("%s failed to queue socket startup job: %s", unit_id(UNIT(s
)), strerror(-r
));
617 socket_enter_dead(s
, false);
620 static void socket_run_next(Socket
*s
, bool success
) {
624 assert(s
->control_command
);
625 assert(s
->control_command
->command_next
);
630 s
->control_command
= s
->control_command
->command_next
;
632 if ((r
= socket_spawn(s
, s
->control_command
, true, &s
->control_pid
)) < 0)
638 if (s
->state
== SOCKET_STOP_PRE
)
639 socket_enter_stop_post(s
, false);
640 else if (s
->state
== SOCKET_STOP_POST
)
641 socket_enter_dead(s
, false);
643 socket_enter_stop_pre(s
, false);
646 static int socket_start(Unit
*u
) {
647 Socket
*s
= SOCKET(u
);
651 /* We cannot fulfill this request right now, try again later
653 if (s
->state
== SOCKET_STOP_PRE
||
654 s
->state
== SOCKET_STOP_PRE_SIGKILL
||
655 s
->state
== SOCKET_STOP_PRE_SIGTERM
||
656 s
->state
== SOCKET_STOP_POST
||
657 s
->state
== SOCKET_STOP_POST_SIGTERM
||
658 s
->state
== SOCKET_STOP_POST_SIGKILL
)
661 if (s
->state
== SOCKET_START_PRE
||
662 s
->state
== SOCKET_START_POST
)
665 /* Cannot run this without the service being around */
666 if (s
->service
->meta
.load_state
!= UNIT_LOADED
)
669 assert(s
->state
== SOCKET_DEAD
|| s
->state
== SOCKET_MAINTAINANCE
);
672 socket_enter_start_pre(s
);
676 static int socket_stop(Unit
*u
) {
677 Socket
*s
= SOCKET(u
);
681 /* We cannot fulfill this request right now, try again later
683 if (s
->state
== SOCKET_START_PRE
||
684 s
->state
== SOCKET_START_POST
)
687 assert(s
->state
== SOCKET_LISTENING
|| s
->state
== SOCKET_RUNNING
);
689 socket_enter_stop_pre(s
, true);
693 static UnitActiveState
socket_active_state(Unit
*u
) {
696 return state_translation_table
[SOCKET(u
)->state
];
699 static void socket_fd_event(Unit
*u
, int fd
, uint32_t events
, Watch
*w
) {
700 Socket
*s
= SOCKET(u
);
704 log_debug("Incoming traffic on %s", unit_id(u
));
706 if (events
!= EPOLLIN
)
707 socket_enter_stop_pre(s
, false);
709 socket_enter_running(s
);
712 static void socket_sigchld_event(Unit
*u
, pid_t pid
, int code
, int status
) {
713 Socket
*s
= SOCKET(u
);
719 success
= code
== CLD_EXITED
&& status
== 0;
720 s
->failure
= s
->failure
|| !success
;
722 assert(s
->control_pid
== pid
);
723 assert(s
->control_command
);
725 exec_status_fill(&s
->control_command
->exec_status
, pid
, code
, status
);
728 log_debug("%s control process exited, code=%s status=%i", unit_id(u
), sigchld_code_to_string(code
), status
);
730 if (s
->control_command
->command_next
&&
731 (success
|| (s
->state
== SOCKET_STOP_PRE
|| s
->state
== SOCKET_STOP_POST
))) {
732 log_debug("%s running next command for the state %s", unit_id(u
), state_string_table
[s
->state
]);
733 socket_run_next(s
, success
);
735 /* No further commands for this step, so let's figure
736 * out what to do next */
738 log_debug("%s got final SIGCHLD for state %s", unit_id(u
), state_string_table
[s
->state
]);
742 case SOCKET_START_PRE
:
744 socket_enter_start_post(s
);
746 socket_enter_stop_pre(s
, false);
749 case SOCKET_START_POST
:
751 socket_enter_listening(s
);
753 socket_enter_stop_pre(s
, false);
756 case SOCKET_STOP_PRE
:
757 case SOCKET_STOP_PRE_SIGTERM
:
758 case SOCKET_STOP_PRE_SIGKILL
:
759 socket_enter_stop_post(s
, success
);
762 case SOCKET_STOP_POST
:
763 case SOCKET_STOP_POST_SIGTERM
:
764 case SOCKET_STOP_POST_SIGKILL
:
765 socket_enter_dead(s
, success
);
769 assert_not_reached("Uh, control process died at wrong time.");
774 static void socket_timer_event(Unit
*u
, uint64_t elapsed
, Watch
*w
) {
775 Socket
*s
= SOCKET(u
);
778 assert(elapsed
== 1);
780 assert(w
== &s
->timer_watch
);
784 case SOCKET_START_PRE
:
785 case SOCKET_START_POST
:
786 log_warning("%s operation timed out. Stopping.", unit_id(u
));
787 socket_enter_stop_pre(s
, false);
790 case SOCKET_STOP_PRE
:
791 log_warning("%s stopping timed out. Terminating.", unit_id(u
));
792 socket_enter_signal(s
, SOCKET_STOP_PRE_SIGTERM
, false);
795 case SOCKET_STOP_PRE_SIGTERM
:
796 log_warning("%s stopping timed out. Killing.", unit_id(u
));
797 socket_enter_signal(s
, SOCKET_STOP_PRE_SIGKILL
, false);
800 case SOCKET_STOP_PRE_SIGKILL
:
801 log_warning("%s still around after SIGKILL. Ignoring.", unit_id(u
));
802 socket_enter_stop_post(s
, false);
805 case SOCKET_STOP_POST
:
806 log_warning("%s stopping timed out (2). Terminating.", unit_id(u
));
807 socket_enter_signal(s
, SOCKET_STOP_POST_SIGTERM
, false);
810 case SOCKET_STOP_POST_SIGTERM
:
811 log_warning("%s stopping timed out (2). Killing.", unit_id(u
));
812 socket_enter_signal(s
, SOCKET_STOP_POST_SIGKILL
, false);
815 case SOCKET_STOP_POST_SIGKILL
:
816 log_warning("%s still around after SIGKILL (2). Entering maintainance mode.", unit_id(u
));
817 socket_enter_dead(s
, false);
821 assert_not_reached("Timeout at wrong time.");
825 int socket_collect_fds(Socket
*s
, int **fds
, unsigned *n_fds
) {
834 /* Called from the service code for requesting our fds */
837 LIST_FOREACH(port
, p
, s
->ports
)
841 if (!(rfds
= new(int, rn_fds
)) < 0)
845 LIST_FOREACH(port
, p
, s
->ports
)
857 void socket_notify_service_dead(Socket
*s
) {
860 /* The service is dead. Dang. */
862 if (s
->state
== SOCKET_RUNNING
) {
863 log_debug("%s got notified about service death.", unit_id(UNIT(s
)));
864 socket_enter_listening(s
);
868 const UnitVTable socket_vtable
= {
876 .start
= socket_start
,
879 .active_state
= socket_active_state
,
881 .fd_event
= socket_fd_event
,
882 .sigchld_event
= socket_sigchld_event
,
883 .timer_event
= socket_timer_event