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>
29 #include <arpa/inet.h>
34 #include "load-dropin.h"
35 #include "load-fragment.h"
37 #include "unit-name.h"
38 #include "dbus-socket.h"
41 static const UnitActiveState state_translation_table
[_SOCKET_STATE_MAX
] = {
42 [SOCKET_DEAD
] = UNIT_INACTIVE
,
43 [SOCKET_START_PRE
] = UNIT_ACTIVATING
,
44 [SOCKET_START_POST
] = UNIT_ACTIVATING
,
45 [SOCKET_LISTENING
] = UNIT_ACTIVE
,
46 [SOCKET_RUNNING
] = UNIT_ACTIVE
,
47 [SOCKET_STOP_PRE
] = UNIT_DEACTIVATING
,
48 [SOCKET_STOP_PRE_SIGTERM
] = UNIT_DEACTIVATING
,
49 [SOCKET_STOP_PRE_SIGKILL
] = UNIT_DEACTIVATING
,
50 [SOCKET_STOP_POST
] = UNIT_DEACTIVATING
,
51 [SOCKET_FINAL_SIGTERM
] = UNIT_DEACTIVATING
,
52 [SOCKET_FINAL_SIGKILL
] = UNIT_DEACTIVATING
,
53 [SOCKET_MAINTENANCE
] = UNIT_MAINTENANCE
56 static void socket_init(Unit
*u
) {
57 Socket
*s
= SOCKET(u
);
60 assert(u
->meta
.load_state
== UNIT_STUB
);
62 s
->backlog
= SOMAXCONN
;
63 s
->timeout_usec
= DEFAULT_TIMEOUT_USEC
;
64 s
->directory_mode
= 0755;
65 s
->socket_mode
= 0666;
67 s
->max_connections
= 64;
69 s
->keep_alive
= false;
71 s
->receive_buffer
= 0;
79 exec_context_init(&s
->exec_context
);
81 s
->control_command_id
= _SOCKET_EXEC_COMMAND_INVALID
;
84 static void socket_unwatch_control_pid(Socket
*s
) {
87 if (s
->control_pid
<= 0)
90 unit_unwatch_pid(UNIT(s
), s
->control_pid
);
94 static void socket_done(Unit
*u
) {
95 Socket
*s
= SOCKET(u
);
101 while ((p
= s
->ports
)) {
102 LIST_REMOVE(SocketPort
, port
, s
->ports
, p
);
105 unit_unwatch_fd(UNIT(s
), &p
->fd_watch
);
106 close_nointr_nofail(p
->fd
);
113 exec_context_done(&s
->exec_context
);
114 exec_command_free_array(s
->exec_command
, _SOCKET_EXEC_COMMAND_MAX
);
115 s
->control_command
= NULL
;
117 socket_unwatch_control_pid(s
);
121 free(s
->bind_to_device
);
122 s
->bind_to_device
= NULL
;
124 unit_unwatch_timer(u
, &s
->timer_watch
);
126 /* Make sure no service instance refers to us anymore. */
127 LIST_FOREACH(units_per_type
, i
, u
->meta
.manager
->units_per_type
[UNIT_SERVICE
]) {
128 Service
*service
= (Service
*) i
;
130 if (service
->socket
== s
)
131 service
->socket
= NULL
;
135 static bool have_non_accept_socket(Socket
*s
) {
143 LIST_FOREACH(port
, p
, s
->ports
) {
145 if (p
->type
!= SOCKET_SOCKET
)
148 if (!socket_address_can_accept(&p
->address
))
155 static int socket_verify(Socket
*s
) {
158 if (s
->meta
.load_state
!= UNIT_LOADED
)
162 log_error("%s lacks Listen setting. Refusing.", s
->meta
.id
);
166 if (s
->accept
&& s
->max_connections
<= 0) {
167 log_error("%s's MaxConnection setting too small. Refusing.", s
->meta
.id
);
171 if (s
->exec_context
.pam_name
&& s
->kill_mode
!= KILL_CONTROL_GROUP
) {
172 log_error("%s has PAM enabled. Kill mode must be set to 'control-group'. Refusing.", s
->meta
.id
);
179 static bool socket_needs_mount(Socket
*s
, const char *prefix
) {
184 LIST_FOREACH(port
, p
, s
->ports
) {
186 if (p
->type
== SOCKET_SOCKET
) {
187 if (socket_address_needs_mount(&p
->address
, prefix
))
190 assert(p
->type
== SOCKET_FIFO
);
191 if (path_startswith(p
->path
, prefix
))
199 int socket_add_one_mount_link(Socket
*s
, Mount
*m
) {
205 if (s
->meta
.load_state
!= UNIT_LOADED
||
206 m
->meta
.load_state
!= UNIT_LOADED
)
209 if (!socket_needs_mount(s
, m
->where
))
212 if ((r
= unit_add_dependency(UNIT(m
), UNIT_BEFORE
, UNIT(s
), true)) < 0)
215 if ((r
= unit_add_dependency(UNIT(s
), UNIT_REQUIRES
, UNIT(m
), true)) < 0)
221 static int socket_add_mount_links(Socket
*s
) {
227 LIST_FOREACH(units_per_type
, other
, s
->meta
.manager
->units_per_type
[UNIT_MOUNT
])
228 if ((r
= socket_add_one_mount_link(s
, (Mount
*) other
)) < 0)
234 static int socket_add_device_link(Socket
*s
) {
240 if (!s
->bind_to_device
)
243 if (asprintf(&t
, "/sys/subsystem/net/devices/%s", s
->bind_to_device
) < 0)
246 r
= unit_add_node_link(UNIT(s
), t
, false);
252 static int socket_load(Unit
*u
) {
253 Socket
*s
= SOCKET(u
);
257 assert(u
->meta
.load_state
== UNIT_STUB
);
259 if ((r
= unit_load_fragment_and_dropin(u
)) < 0)
262 /* This is a new unit? Then let's add in some extras */
263 if (u
->meta
.load_state
== UNIT_LOADED
) {
265 if (have_non_accept_socket(s
)) {
266 if ((r
= unit_load_related_unit(u
, ".service", (Unit
**) &s
->service
)))
269 if ((r
= unit_add_dependency(u
, UNIT_BEFORE
, UNIT(s
->service
), true)) < 0)
273 if ((r
= socket_add_mount_links(s
)) < 0)
276 if ((r
= socket_add_device_link(s
)) < 0)
279 if ((r
= unit_add_exec_dependencies(u
, &s
->exec_context
)) < 0)
282 if ((r
= unit_add_default_cgroup(u
)) < 0)
286 return socket_verify(s
);
289 static const char* listen_lookup(int type
) {
291 if (type
== SOCK_STREAM
)
292 return "ListenStream";
293 else if (type
== SOCK_DGRAM
)
294 return "ListenDatagram";
295 else if (type
== SOCK_SEQPACKET
)
296 return "ListenSequentialPacket";
298 assert_not_reached("Unknown socket type");
302 static void socket_dump(Unit
*u
, FILE *f
, const char *prefix
) {
305 Socket
*s
= SOCKET(u
);
313 p2
= strappend(prefix
, "\t");
314 prefix2
= p2
? p2
: prefix
;
317 "%sSocket State: %s\n"
318 "%sBindIPv6Only: %s\n"
321 "%sSocketMode: %04o\n"
322 "%sDirectoryMode: %04o\n"
325 prefix
, socket_state_to_string(s
->state
),
326 prefix
, socket_address_bind_ipv6_only_to_string(s
->bind_ipv6_only
),
328 prefix
, kill_mode_to_string(s
->kill_mode
),
329 prefix
, s
->socket_mode
,
330 prefix
, s
->directory_mode
,
331 prefix
, yes_no(s
->keep_alive
),
332 prefix
, yes_no(s
->free_bind
));
334 if (s
->control_pid
> 0)
336 "%sControl PID: %lu\n",
337 prefix
, (unsigned long) s
->control_pid
);
339 if (s
->bind_to_device
)
341 "%sBindToDevice: %s\n",
342 prefix
, s
->bind_to_device
);
347 "%sNConnections: %u\n"
348 "%sMaxConnections: %u\n",
349 prefix
, s
->n_accepted
,
350 prefix
, s
->n_connections
,
351 prefix
, s
->max_connections
);
353 if (s
->priority
>= 0)
356 prefix
, s
->priority
);
358 if (s
->receive_buffer
> 0)
360 "%sReceiveBuffer: %zu\n",
361 prefix
, s
->receive_buffer
);
363 if (s
->send_buffer
> 0)
365 "%sSendBuffer: %zu\n",
366 prefix
, s
->send_buffer
);
378 if (s
->pipe_size
> 0)
381 prefix
, s
->pipe_size
);
388 LIST_FOREACH(port
, p
, s
->ports
) {
390 if (p
->type
== SOCKET_SOCKET
) {
395 if ((r
= socket_address_print(&p
->address
, &k
)) < 0)
400 fprintf(f
, "%s%s: %s\n", prefix
, listen_lookup(p
->address
.type
), k
);
403 fprintf(f
, "%sListenFIFO: %s\n", prefix
, p
->path
);
406 exec_context_dump(&s
->exec_context
, f
, prefix
);
408 for (c
= 0; c
< _SOCKET_EXEC_COMMAND_MAX
; c
++) {
409 if (!s
->exec_command
[c
])
412 fprintf(f
, "%s-> %s:\n",
413 prefix
, socket_exec_command_to_string(c
));
415 exec_command_dump_list(s
->exec_command
[c
], f
, prefix2
);
421 static int instance_from_socket(int fd
, unsigned nr
, char **instance
) {
426 struct sockaddr_un un
;
427 struct sockaddr_in in
;
428 struct sockaddr_in6 in6
;
429 struct sockaddr_storage storage
;
436 if (getsockname(fd
, &local
.sa
, &l
) < 0)
440 if (getpeername(fd
, &remote
.sa
, &l
) < 0)
443 switch (local
.sa
.sa_family
) {
447 a
= ntohl(local
.in
.sin_addr
.s_addr
),
448 b
= ntohl(remote
.in
.sin_addr
.s_addr
);
451 "%u-%u.%u.%u.%u:%u-%u.%u.%u.%u:%u",
453 a
>> 24, (a
>> 16) & 0xFF, (a
>> 8) & 0xFF, a
& 0xFF,
454 ntohs(local
.in
.sin_port
),
455 b
>> 24, (b
>> 16) & 0xFF, (b
>> 8) & 0xFF, b
& 0xFF,
456 ntohs(remote
.in
.sin_port
)) < 0)
463 static const char ipv4_prefix
[] = {
464 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0xFF, 0xFF
467 if (memcmp(&local
.in6
.sin6_addr
, ipv4_prefix
, sizeof(ipv4_prefix
)) == 0 &&
468 memcmp(&remote
.in6
.sin6_addr
, ipv4_prefix
, sizeof(ipv4_prefix
)) == 0) {
470 *a
= local
.in6
.sin6_addr
.s6_addr
+12,
471 *b
= remote
.in6
.sin6_addr
.s6_addr
+12;
474 "%u-%u.%u.%u.%u:%u-%u.%u.%u.%u:%u",
476 a
[0], a
[1], a
[2], a
[3],
477 ntohs(local
.in6
.sin6_port
),
478 b
[0], b
[1], b
[2], b
[3],
479 ntohs(remote
.in6
.sin6_port
)) < 0)
482 char a
[INET6_ADDRSTRLEN
], b
[INET6_ADDRSTRLEN
];
487 inet_ntop(AF_INET6
, &local
.in6
.sin6_addr
, a
, sizeof(a
)),
488 ntohs(local
.in6
.sin6_port
),
489 inet_ntop(AF_INET6
, &remote
.in6
.sin6_addr
, b
, sizeof(b
)),
490 ntohs(remote
.in6
.sin6_port
)) < 0)
501 if (getsockopt(fd
, SOL_SOCKET
, SO_PEERCRED
, &ucred
, &l
) < 0)
507 (unsigned long) ucred
.pid
,
508 (unsigned long) ucred
.uid
) < 0)
515 assert_not_reached("Unhandled socket type.");
522 static void socket_close_fds(Socket
*s
) {
527 LIST_FOREACH(port
, p
, s
->ports
) {
531 unit_unwatch_fd(UNIT(s
), &p
->fd_watch
);
532 close_nointr_nofail(p
->fd
);
534 /* One little note: we should never delete any sockets
535 * in the file system here! After all some other
536 * process we spawned might still have a reference of
537 * this fd and wants to continue to use it. Therefore
538 * we delete sockets in the file system before we
539 * create a new one, not after we stopped using
546 static void socket_apply_socket_options(Socket
*s
, int fd
) {
551 int b
= s
->keep_alive
;
552 if (setsockopt(fd
, SOL_SOCKET
, SO_KEEPALIVE
, &b
, sizeof(b
)) < 0)
553 log_warning("SO_KEEPALIVE failed: %m");
556 if (s
->priority
>= 0)
557 if (setsockopt(fd
, SOL_SOCKET
, SO_PRIORITY
, &s
->priority
, sizeof(s
->priority
)) < 0)
558 log_warning("SO_PRIORITY failed: %m");
560 if (s
->receive_buffer
> 0) {
561 int value
= (int) s
->receive_buffer
;
562 if (setsockopt(fd
, SOL_SOCKET
, SO_RCVBUF
, &value
, sizeof(value
)) < 0)
563 log_warning("SO_RCVBUF failed: %m");
566 if (s
->send_buffer
> 0) {
567 int value
= (int) s
->send_buffer
;
568 if (setsockopt(fd
, SOL_SOCKET
, SO_SNDBUF
, &value
, sizeof(value
)) < 0)
569 log_warning("SO_SNDBUF failed: %m");
573 if (setsockopt(fd
, SOL_SOCKET
, SO_MARK
, &s
->mark
, sizeof(s
->mark
)) < 0)
574 log_warning("SO_MARK failed: %m");
577 if (setsockopt(fd
, IPPROTO_IP
, IP_TOS
, &s
->ip_tos
, sizeof(s
->ip_tos
)) < 0)
578 log_warning("IP_TOS failed: %m");
581 if (setsockopt(fd
, IPPROTO_IP
, IP_TTL
, &s
->ip_ttl
, sizeof(s
->ip_ttl
)) < 0)
582 log_warning("IP_TTL failed: %m");
585 static void socket_apply_pipe_options(Socket
*s
, int fd
) {
589 if (s
->pipe_size
> 0)
590 if (fcntl(fd
, F_SETPIPE_SZ
, s
->pipe_size
) < 0)
591 log_warning("F_SETPIPE_SZ: %m");
594 static int socket_open_fds(Socket
*s
) {
600 LIST_FOREACH(port
, p
, s
->ports
) {
605 if (p
->type
== SOCKET_SOCKET
) {
607 if ((r
= socket_address_listen(
618 socket_apply_socket_options(s
, p
->fd
);
622 assert(p
->type
== SOCKET_FIFO
);
624 mkdir_parents(p
->path
, s
->directory_mode
);
626 if (mkfifo(p
->path
, s
->socket_mode
) < 0 && errno
!= EEXIST
) {
631 if ((p
->fd
= open(p
->path
, O_RDWR
|O_CLOEXEC
|O_NOCTTY
|O_NONBLOCK
|O_NOFOLLOW
)) < 0) {
636 if (fstat(p
->fd
, &st
) < 0) {
641 /* FIXME verify user, access mode */
643 if (!S_ISFIFO(st
.st_mode
)) {
648 socket_apply_pipe_options(s
, p
->fd
);
659 static void socket_unwatch_fds(Socket
*s
) {
664 LIST_FOREACH(port
, p
, s
->ports
) {
668 unit_unwatch_fd(UNIT(s
), &p
->fd_watch
);
672 static int socket_watch_fds(Socket
*s
) {
678 LIST_FOREACH(port
, p
, s
->ports
) {
682 p
->fd_watch
.socket_accept
=
684 p
->type
== SOCKET_SOCKET
&&
685 socket_address_can_accept(&p
->address
);
687 if ((r
= unit_watch_fd(UNIT(s
), p
->fd
, EPOLLIN
, &p
->fd_watch
)) < 0)
694 socket_unwatch_fds(s
);
698 static void socket_set_state(Socket
*s
, SocketState state
) {
699 SocketState old_state
;
702 old_state
= s
->state
;
705 if (state
!= SOCKET_START_PRE
&&
706 state
!= SOCKET_START_POST
&&
707 state
!= SOCKET_STOP_PRE
&&
708 state
!= SOCKET_STOP_PRE_SIGTERM
&&
709 state
!= SOCKET_STOP_PRE_SIGKILL
&&
710 state
!= SOCKET_STOP_POST
&&
711 state
!= SOCKET_FINAL_SIGTERM
&&
712 state
!= SOCKET_FINAL_SIGKILL
) {
713 unit_unwatch_timer(UNIT(s
), &s
->timer_watch
);
714 socket_unwatch_control_pid(s
);
715 s
->control_command
= NULL
;
716 s
->control_command_id
= _SOCKET_EXEC_COMMAND_INVALID
;
719 if (state
!= SOCKET_LISTENING
)
720 socket_unwatch_fds(s
);
722 if (state
!= SOCKET_START_POST
&&
723 state
!= SOCKET_LISTENING
&&
724 state
!= SOCKET_RUNNING
&&
725 state
!= SOCKET_STOP_PRE
&&
726 state
!= SOCKET_STOP_PRE_SIGTERM
&&
727 state
!= SOCKET_STOP_PRE_SIGKILL
)
730 if (state
!= old_state
)
731 log_debug("%s changed %s -> %s",
733 socket_state_to_string(old_state
),
734 socket_state_to_string(state
));
736 unit_notify(UNIT(s
), state_translation_table
[old_state
], state_translation_table
[state
]);
739 static int socket_coldplug(Unit
*u
) {
740 Socket
*s
= SOCKET(u
);
744 assert(s
->state
== SOCKET_DEAD
);
746 if (s
->deserialized_state
!= s
->state
) {
748 if (s
->deserialized_state
== SOCKET_START_PRE
||
749 s
->deserialized_state
== SOCKET_START_POST
||
750 s
->deserialized_state
== SOCKET_STOP_PRE
||
751 s
->deserialized_state
== SOCKET_STOP_PRE_SIGTERM
||
752 s
->deserialized_state
== SOCKET_STOP_PRE_SIGKILL
||
753 s
->deserialized_state
== SOCKET_STOP_POST
||
754 s
->deserialized_state
== SOCKET_FINAL_SIGTERM
||
755 s
->deserialized_state
== SOCKET_FINAL_SIGKILL
) {
757 if (s
->control_pid
<= 0)
760 if ((r
= unit_watch_pid(UNIT(s
), s
->control_pid
)) < 0)
763 if ((r
= unit_watch_timer(UNIT(s
), s
->timeout_usec
, &s
->timer_watch
)) < 0)
767 if (s
->deserialized_state
== SOCKET_START_POST
||
768 s
->deserialized_state
== SOCKET_LISTENING
||
769 s
->deserialized_state
== SOCKET_RUNNING
||
770 s
->deserialized_state
== SOCKET_STOP_PRE
||
771 s
->deserialized_state
== SOCKET_STOP_PRE_SIGTERM
||
772 s
->deserialized_state
== SOCKET_STOP_PRE_SIGKILL
)
773 if ((r
= socket_open_fds(s
)) < 0)
776 if (s
->deserialized_state
== SOCKET_LISTENING
)
777 if ((r
= socket_watch_fds(s
)) < 0)
780 socket_set_state(s
, s
->deserialized_state
);
786 static int socket_spawn(Socket
*s
, ExecCommand
*c
, pid_t
*_pid
) {
795 if ((r
= unit_watch_timer(UNIT(s
), s
->timeout_usec
, &s
->timer_watch
)) < 0)
798 if (!(argv
= unit_full_printf_strv(UNIT(s
), c
->argv
))) {
807 s
->meta
.manager
->environment
,
810 s
->meta
.manager
->confirm_spawn
,
811 s
->meta
.cgroup_bondings
,
818 if ((r
= unit_watch_pid(UNIT(s
), pid
)) < 0)
819 /* FIXME: we need to do something here */
827 unit_unwatch_timer(UNIT(s
), &s
->timer_watch
);
832 static void socket_enter_dead(Socket
*s
, bool success
) {
838 socket_set_state(s
, s
->failure
? SOCKET_MAINTENANCE
: SOCKET_DEAD
);
841 static void socket_enter_signal(Socket
*s
, SocketState state
, bool success
);
843 static void socket_enter_stop_post(Socket
*s
, bool success
) {
850 socket_unwatch_control_pid(s
);
852 s
->control_command_id
= SOCKET_EXEC_STOP_POST
;
854 if ((s
->control_command
= s
->exec_command
[SOCKET_EXEC_STOP_POST
])) {
855 if ((r
= socket_spawn(s
, s
->control_command
, &s
->control_pid
)) < 0)
858 socket_set_state(s
, SOCKET_STOP_POST
);
860 socket_enter_signal(s
, SOCKET_FINAL_SIGTERM
, true);
865 log_warning("%s failed to run 'stop-post' task: %s", s
->meta
.id
, strerror(-r
));
866 socket_enter_signal(s
, SOCKET_FINAL_SIGTERM
, false);
869 static void socket_enter_signal(Socket
*s
, SocketState state
, bool success
) {
878 if (s
->kill_mode
!= KILL_NONE
) {
879 int sig
= (state
== SOCKET_STOP_PRE_SIGTERM
|| state
== SOCKET_FINAL_SIGTERM
) ? SIGTERM
: SIGKILL
;
881 if (s
->kill_mode
== KILL_CONTROL_GROUP
) {
883 if ((r
= cgroup_bonding_kill_list(s
->meta
.cgroup_bondings
, sig
)) < 0) {
884 if (r
!= -EAGAIN
&& r
!= -ESRCH
)
890 if (!sent
&& s
->control_pid
> 0)
891 if (kill(s
->kill_mode
== KILL_PROCESS
? s
->control_pid
: -s
->control_pid
, sig
) < 0 && errno
!= ESRCH
) {
897 if (sent
&& s
->control_pid
> 0) {
898 if ((r
= unit_watch_timer(UNIT(s
), s
->timeout_usec
, &s
->timer_watch
)) < 0)
901 socket_set_state(s
, state
);
902 } else if (state
== SOCKET_STOP_PRE_SIGTERM
|| state
== SOCKET_STOP_PRE_SIGKILL
)
903 socket_enter_stop_post(s
, true);
905 socket_enter_dead(s
, true);
910 log_warning("%s failed to kill processes: %s", s
->meta
.id
, strerror(-r
));
912 if (state
== SOCKET_STOP_PRE_SIGTERM
|| state
== SOCKET_STOP_PRE_SIGKILL
)
913 socket_enter_stop_post(s
, false);
915 socket_enter_dead(s
, false);
918 static void socket_enter_stop_pre(Socket
*s
, bool success
) {
925 socket_unwatch_control_pid(s
);
927 s
->control_command_id
= SOCKET_EXEC_STOP_PRE
;
929 if ((s
->control_command
= s
->exec_command
[SOCKET_EXEC_STOP_PRE
])) {
930 if ((r
= socket_spawn(s
, s
->control_command
, &s
->control_pid
)) < 0)
933 socket_set_state(s
, SOCKET_STOP_PRE
);
935 socket_enter_stop_post(s
, true);
940 log_warning("%s failed to run 'stop-pre' task: %s", s
->meta
.id
, strerror(-r
));
941 socket_enter_stop_post(s
, false);
944 static void socket_enter_listening(Socket
*s
) {
948 if ((r
= socket_watch_fds(s
)) < 0) {
949 log_warning("%s failed to watch sockets: %s", s
->meta
.id
, strerror(-r
));
953 socket_set_state(s
, SOCKET_LISTENING
);
957 socket_enter_stop_pre(s
, false);
960 static void socket_enter_start_post(Socket
*s
) {
964 if ((r
= socket_open_fds(s
)) < 0) {
965 log_warning("%s failed to listen on sockets: %s", s
->meta
.id
, strerror(-r
));
969 socket_unwatch_control_pid(s
);
971 s
->control_command_id
= SOCKET_EXEC_START_POST
;
973 if ((s
->control_command
= s
->exec_command
[SOCKET_EXEC_START_POST
])) {
974 if ((r
= socket_spawn(s
, s
->control_command
, &s
->control_pid
)) < 0) {
975 log_warning("%s failed to run 'start-post' task: %s", s
->meta
.id
, strerror(-r
));
979 socket_set_state(s
, SOCKET_START_POST
);
981 socket_enter_listening(s
);
986 socket_enter_stop_pre(s
, false);
989 static void socket_enter_start_pre(Socket
*s
) {
993 socket_unwatch_control_pid(s
);
995 s
->control_command_id
= SOCKET_EXEC_START_PRE
;
997 if ((s
->control_command
= s
->exec_command
[SOCKET_EXEC_START_PRE
])) {
998 if ((r
= socket_spawn(s
, s
->control_command
, &s
->control_pid
)) < 0)
1001 socket_set_state(s
, SOCKET_START_PRE
);
1003 socket_enter_start_post(s
);
1008 log_warning("%s failed to run 'start-pre' task: %s", s
->meta
.id
, strerror(-r
));
1009 socket_enter_dead(s
, false);
1012 static void socket_enter_running(Socket
*s
, int cfd
) {
1018 if ((r
= manager_add_job(s
->meta
.manager
, JOB_START
, UNIT(s
->service
), JOB_REPLACE
, true, NULL
)) < 0)
1021 socket_set_state(s
, SOCKET_RUNNING
);
1024 char *prefix
, *instance
, *name
;
1026 if (s
->n_connections
>= s
->max_connections
) {
1027 log_warning("Too many incoming connections (%u)", s
->n_connections
);
1028 close_nointr_nofail(cfd
);
1032 if ((r
= instance_from_socket(cfd
, s
->n_accepted
++, &instance
)) < 0)
1035 if (!(prefix
= unit_name_to_prefix(s
->meta
.id
))) {
1041 name
= unit_name_build(prefix
, instance
, ".service");
1050 r
= manager_load_unit(s
->meta
.manager
, name
, NULL
, &u
);
1056 if ((r
= service_set_socket_fd(SERVICE(u
), cfd
, s
)) < 0)
1061 s
->n_connections
++;
1063 if ((r
= manager_add_job(u
->meta
.manager
, JOB_START
, u
, JOB_REPLACE
, true, NULL
)) < 0)
1070 log_warning("%s failed to queue socket startup job: %s", s
->meta
.id
, strerror(-r
));
1071 socket_enter_stop_pre(s
, false);
1074 close_nointr_nofail(cfd
);
1077 static void socket_run_next(Socket
*s
, bool success
) {
1081 assert(s
->control_command
);
1082 assert(s
->control_command
->command_next
);
1087 socket_unwatch_control_pid(s
);
1089 s
->control_command
= s
->control_command
->command_next
;
1091 if ((r
= socket_spawn(s
, s
->control_command
, &s
->control_pid
)) < 0)
1097 log_warning("%s failed to run next task: %s", s
->meta
.id
, strerror(-r
));
1099 if (s
->state
== SOCKET_START_POST
)
1100 socket_enter_stop_pre(s
, false);
1101 else if (s
->state
== SOCKET_STOP_POST
)
1102 socket_enter_dead(s
, false);
1104 socket_enter_signal(s
, SOCKET_FINAL_SIGTERM
, false);
1107 static int socket_start(Unit
*u
) {
1108 Socket
*s
= SOCKET(u
);
1112 /* We cannot fulfill this request right now, try again later
1114 if (s
->state
== SOCKET_STOP_PRE
||
1115 s
->state
== SOCKET_STOP_PRE_SIGKILL
||
1116 s
->state
== SOCKET_STOP_PRE_SIGTERM
||
1117 s
->state
== SOCKET_STOP_POST
||
1118 s
->state
== SOCKET_FINAL_SIGTERM
||
1119 s
->state
== SOCKET_FINAL_SIGKILL
)
1122 if (s
->state
== SOCKET_START_PRE
||
1123 s
->state
== SOCKET_START_POST
)
1126 /* Cannot run this without the service being around */
1128 if (s
->service
->meta
.load_state
!= UNIT_LOADED
)
1131 /* If the service is alredy actvie we cannot start the
1133 if (s
->service
->state
!= SERVICE_DEAD
&&
1134 s
->service
->state
!= SERVICE_MAINTENANCE
&&
1135 s
->service
->state
!= SERVICE_AUTO_RESTART
)
1139 assert(s
->state
== SOCKET_DEAD
|| s
->state
== SOCKET_MAINTENANCE
);
1142 socket_enter_start_pre(s
);
1146 static int socket_stop(Unit
*u
) {
1147 Socket
*s
= SOCKET(u
);
1151 /* We cannot fulfill this request right now, try again later
1153 if (s
->state
== SOCKET_START_PRE
||
1154 s
->state
== SOCKET_START_POST
)
1158 if (s
->state
== SOCKET_STOP_PRE
||
1159 s
->state
== SOCKET_STOP_PRE_SIGTERM
||
1160 s
->state
== SOCKET_STOP_PRE_SIGKILL
||
1161 s
->state
== SOCKET_STOP_POST
||
1162 s
->state
== SOCKET_FINAL_SIGTERM
||
1163 s
->state
== SOCKET_FINAL_SIGTERM
)
1166 assert(s
->state
== SOCKET_LISTENING
|| s
->state
== SOCKET_RUNNING
);
1168 socket_enter_stop_pre(s
, true);
1172 static int socket_serialize(Unit
*u
, FILE *f
, FDSet
*fds
) {
1173 Socket
*s
= SOCKET(u
);
1181 unit_serialize_item(u
, f
, "state", socket_state_to_string(s
->state
));
1182 unit_serialize_item(u
, f
, "failure", yes_no(s
->failure
));
1183 unit_serialize_item_format(u
, f
, "n-accepted", "%u", s
->n_accepted
);
1185 if (s
->control_pid
> 0)
1186 unit_serialize_item_format(u
, f
, "control-pid", "%lu", (unsigned long) s
->control_pid
);
1188 if (s
->control_command_id
>= 0)
1189 unit_serialize_item(u
, f
, "control-command", socket_exec_command_to_string(s
->control_command_id
));
1191 LIST_FOREACH(port
, p
, s
->ports
) {
1197 if ((copy
= fdset_put_dup(fds
, p
->fd
)) < 0)
1200 if (p
->type
== SOCKET_SOCKET
) {
1203 if ((r
= socket_address_print(&p
->address
, &t
)) < 0)
1206 unit_serialize_item_format(u
, f
, "socket", "%i %i %s", copy
, p
->address
.type
, t
);
1209 assert(p
->type
== SOCKET_FIFO
);
1210 unit_serialize_item_format(u
, f
, "fifo", "%i %s", copy
, p
->path
);
1217 static int socket_deserialize_item(Unit
*u
, const char *key
, const char *value
, FDSet
*fds
) {
1218 Socket
*s
= SOCKET(u
);
1226 if (streq(key
, "state")) {
1229 if ((state
= socket_state_from_string(value
)) < 0)
1230 log_debug("Failed to parse state value %s", value
);
1232 s
->deserialized_state
= state
;
1233 } else if (streq(key
, "failure")) {
1236 if ((b
= parse_boolean(value
)) < 0)
1237 log_debug("Failed to parse failure value %s", value
);
1239 s
->failure
= b
|| s
->failure
;
1241 } else if (streq(key
, "n-accepted")) {
1244 if ((r
= safe_atou(value
, &k
)) < 0)
1245 log_debug("Failed to parse n-accepted value %s", value
);
1248 } else if (streq(key
, "control-pid")) {
1251 if ((r
= parse_pid(value
, &pid
)) < 0)
1252 log_debug("Failed to parse control-pid value %s", value
);
1254 s
->control_pid
= pid
;
1255 } else if (streq(key
, "control-command")) {
1256 SocketExecCommand id
;
1258 if ((id
= socket_exec_command_from_string(value
)) < 0)
1259 log_debug("Failed to parse exec-command value %s", value
);
1261 s
->control_command_id
= id
;
1262 s
->control_command
= s
->exec_command
[id
];
1264 } else if (streq(key
, "fifo")) {
1268 if (sscanf(value
, "%i %n", &fd
, &skip
) < 1 || fd
< 0 || !fdset_contains(fds
, fd
))
1269 log_debug("Failed to parse fifo value %s", value
);
1272 LIST_FOREACH(port
, p
, s
->ports
)
1273 if (streq(p
->path
, value
+skip
))
1278 close_nointr_nofail(p
->fd
);
1279 p
->fd
= fdset_remove(fds
, fd
);
1283 } else if (streq(key
, "socket")) {
1284 int fd
, type
, skip
= 0;
1287 if (sscanf(value
, "%i %i %n", &fd
, &type
, &skip
) < 2 || fd
< 0 || type
< 0 || !fdset_contains(fds
, fd
))
1288 log_debug("Failed to parse socket value %s", value
);
1291 LIST_FOREACH(port
, p
, s
->ports
)
1292 if (socket_address_is(&p
->address
, value
+skip
, type
))
1297 close_nointr_nofail(p
->fd
);
1298 p
->fd
= fdset_remove(fds
, fd
);
1303 log_debug("Unknown serialization key '%s'", key
);
1308 static UnitActiveState
socket_active_state(Unit
*u
) {
1311 return state_translation_table
[SOCKET(u
)->state
];
1314 static const char *socket_sub_state_to_string(Unit
*u
) {
1317 return socket_state_to_string(SOCKET(u
)->state
);
1320 static bool socket_check_gc(Unit
*u
) {
1321 Socket
*s
= SOCKET(u
);
1325 return s
->n_connections
> 0;
1328 static void socket_fd_event(Unit
*u
, int fd
, uint32_t events
, Watch
*w
) {
1329 Socket
*s
= SOCKET(u
);
1335 if (s
->state
!= SOCKET_LISTENING
)
1338 log_debug("Incoming traffic on %s", u
->meta
.id
);
1340 if (events
!= EPOLLIN
) {
1341 log_error("Got invalid poll event on socket.");
1345 if (w
->socket_accept
) {
1348 if ((cfd
= accept4(fd
, NULL
, NULL
, SOCK_NONBLOCK
)) < 0) {
1353 log_error("Failed to accept socket: %m");
1360 socket_apply_socket_options(s
, cfd
);
1363 socket_enter_running(s
, cfd
);
1367 socket_enter_stop_pre(s
, false);
1370 static void socket_sigchld_event(Unit
*u
, pid_t pid
, int code
, int status
) {
1371 Socket
*s
= SOCKET(u
);
1377 if (pid
!= s
->control_pid
)
1382 success
= is_clean_exit(code
, status
);
1383 s
->failure
= s
->failure
|| !success
;
1385 if (s
->control_command
)
1386 exec_status_fill(&s
->control_command
->exec_status
, pid
, code
, status
);
1388 log_debug("%s control process exited, code=%s status=%i", u
->meta
.id
, sigchld_code_to_string(code
), status
);
1390 if (s
->control_command
&& s
->control_command
->command_next
&& success
) {
1391 log_debug("%s running next command for state %s", u
->meta
.id
, socket_state_to_string(s
->state
));
1392 socket_run_next(s
, success
);
1394 s
->control_command
= NULL
;
1395 s
->control_command_id
= _SOCKET_EXEC_COMMAND_INVALID
;
1397 /* No further commands for this step, so let's figure
1398 * out what to do next */
1400 log_debug("%s got final SIGCHLD for state %s", u
->meta
.id
, socket_state_to_string(s
->state
));
1404 case SOCKET_START_PRE
:
1406 socket_enter_start_post(s
);
1408 socket_enter_signal(s
, SOCKET_FINAL_SIGTERM
, false);
1411 case SOCKET_START_POST
:
1413 socket_enter_listening(s
);
1415 socket_enter_stop_pre(s
, false);
1418 case SOCKET_STOP_PRE
:
1419 case SOCKET_STOP_PRE_SIGTERM
:
1420 case SOCKET_STOP_PRE_SIGKILL
:
1421 socket_enter_stop_post(s
, success
);
1424 case SOCKET_STOP_POST
:
1425 case SOCKET_FINAL_SIGTERM
:
1426 case SOCKET_FINAL_SIGKILL
:
1427 socket_enter_dead(s
, success
);
1431 assert_not_reached("Uh, control process died at wrong time.");
1436 static void socket_timer_event(Unit
*u
, uint64_t elapsed
, Watch
*w
) {
1437 Socket
*s
= SOCKET(u
);
1440 assert(elapsed
== 1);
1441 assert(w
== &s
->timer_watch
);
1445 case SOCKET_START_PRE
:
1446 log_warning("%s starting timed out. Terminating.", u
->meta
.id
);
1447 socket_enter_signal(s
, SOCKET_FINAL_SIGTERM
, false);
1449 case SOCKET_START_POST
:
1450 log_warning("%s starting timed out. Stopping.", u
->meta
.id
);
1451 socket_enter_stop_pre(s
, false);
1454 case SOCKET_STOP_PRE
:
1455 log_warning("%s stopping timed out. Terminating.", u
->meta
.id
);
1456 socket_enter_signal(s
, SOCKET_STOP_PRE_SIGTERM
, false);
1459 case SOCKET_STOP_PRE_SIGTERM
:
1460 log_warning("%s stopping timed out. Killing.", u
->meta
.id
);
1461 socket_enter_signal(s
, SOCKET_STOP_PRE_SIGKILL
, false);
1464 case SOCKET_STOP_PRE_SIGKILL
:
1465 log_warning("%s still around after SIGKILL. Ignoring.", u
->meta
.id
);
1466 socket_enter_stop_post(s
, false);
1469 case SOCKET_STOP_POST
:
1470 log_warning("%s stopping timed out (2). Terminating.", u
->meta
.id
);
1471 socket_enter_signal(s
, SOCKET_FINAL_SIGTERM
, false);
1474 case SOCKET_FINAL_SIGTERM
:
1475 log_warning("%s stopping timed out (2). Killing.", u
->meta
.id
);
1476 socket_enter_signal(s
, SOCKET_FINAL_SIGKILL
, false);
1479 case SOCKET_FINAL_SIGKILL
:
1480 log_warning("%s still around after SIGKILL (2). Entering maintenance mode.", u
->meta
.id
);
1481 socket_enter_dead(s
, false);
1485 assert_not_reached("Timeout at wrong time.");
1489 int socket_collect_fds(Socket
*s
, int **fds
, unsigned *n_fds
) {
1498 /* Called from the service code for requesting our fds */
1501 LIST_FOREACH(port
, p
, s
->ports
)
1505 if (!(rfds
= new(int, rn_fds
)) < 0)
1509 LIST_FOREACH(port
, p
, s
->ports
)
1513 assert(k
== rn_fds
);
1521 void socket_notify_service_dead(Socket
*s
) {
1524 /* The service is dead. Dang!
1526 * This is strictly for one-instance-for-all-connections
1529 if (s
->state
== SOCKET_RUNNING
) {
1530 log_debug("%s got notified about service death.", s
->meta
.id
);
1531 socket_enter_listening(s
);
1535 void socket_connection_unref(Socket
*s
) {
1538 /* The service is dead. Yay!
1540 * This is strictly for one-onstance-per-connection
1543 assert(s
->n_connections
> 0);
1546 log_debug("%s: One connection closed, %u left.", s
->meta
.id
, s
->n_connections
);
1549 static const char* const socket_state_table
[_SOCKET_STATE_MAX
] = {
1550 [SOCKET_DEAD
] = "dead",
1551 [SOCKET_START_PRE
] = "start-pre",
1552 [SOCKET_START_POST
] = "start-post",
1553 [SOCKET_LISTENING
] = "listening",
1554 [SOCKET_RUNNING
] = "running",
1555 [SOCKET_STOP_PRE
] = "stop-pre",
1556 [SOCKET_STOP_PRE_SIGTERM
] = "stop-pre-sigterm",
1557 [SOCKET_STOP_PRE_SIGKILL
] = "stop-pre-sigkill",
1558 [SOCKET_STOP_POST
] = "stop-post",
1559 [SOCKET_FINAL_SIGTERM
] = "final-sigterm",
1560 [SOCKET_FINAL_SIGKILL
] = "final-sigkill",
1561 [SOCKET_MAINTENANCE
] = "maintenance"
1564 DEFINE_STRING_TABLE_LOOKUP(socket_state
, SocketState
);
1566 static const char* const socket_exec_command_table
[_SOCKET_EXEC_COMMAND_MAX
] = {
1567 [SOCKET_EXEC_START_PRE
] = "StartPre",
1568 [SOCKET_EXEC_START_POST
] = "StartPost",
1569 [SOCKET_EXEC_STOP_PRE
] = "StopPre",
1570 [SOCKET_EXEC_STOP_POST
] = "StopPost"
1573 DEFINE_STRING_TABLE_LOOKUP(socket_exec_command
, SocketExecCommand
);
1575 const UnitVTable socket_vtable
= {
1576 .suffix
= ".socket",
1578 .init
= socket_init
,
1579 .done
= socket_done
,
1580 .load
= socket_load
,
1582 .coldplug
= socket_coldplug
,
1584 .dump
= socket_dump
,
1586 .start
= socket_start
,
1587 .stop
= socket_stop
,
1589 .serialize
= socket_serialize
,
1590 .deserialize_item
= socket_deserialize_item
,
1592 .active_state
= socket_active_state
,
1593 .sub_state_to_string
= socket_sub_state_to_string
,
1595 .check_gc
= socket_check_gc
,
1597 .fd_event
= socket_fd_event
,
1598 .sigchld_event
= socket_sigchld_event
,
1599 .timer_event
= socket_timer_event
,
1601 .bus_message_handler
= bus_socket_message_handler