1 /* SPDX-License-Identifier: LGPL-2.1+ */
7 #include <netinet/tcp.h>
11 #include <linux/sctp.h>
13 #include "alloc-util.h"
14 #include "bpf-firewall.h"
15 #include "bus-error.h"
18 #include "dbus-socket.h"
19 #include "dbus-unit.h"
21 #include "errno-list.h"
22 #include "exit-status.h"
24 #include "format-util.h"
26 #include "in-addr-util.h"
28 #include "ip-protocol-list.h"
32 #include "parse-util.h"
33 #include "path-util.h"
34 #include "process-util.h"
35 #include "selinux-util.h"
36 #include "serialize.h"
37 #include "signal-util.h"
38 #include "smack-util.h"
40 #include "socket-netlink.h"
42 #include "string-table.h"
43 #include "string-util.h"
45 #include "unit-name.h"
47 #include "user-util.h"
53 union sockaddr_union peer
;
57 static const UnitActiveState state_translation_table
[_SOCKET_STATE_MAX
] = {
58 [SOCKET_DEAD
] = UNIT_INACTIVE
,
59 [SOCKET_START_PRE
] = UNIT_ACTIVATING
,
60 [SOCKET_START_CHOWN
] = UNIT_ACTIVATING
,
61 [SOCKET_START_POST
] = UNIT_ACTIVATING
,
62 [SOCKET_LISTENING
] = UNIT_ACTIVE
,
63 [SOCKET_RUNNING
] = UNIT_ACTIVE
,
64 [SOCKET_STOP_PRE
] = UNIT_DEACTIVATING
,
65 [SOCKET_STOP_PRE_SIGTERM
] = UNIT_DEACTIVATING
,
66 [SOCKET_STOP_PRE_SIGKILL
] = UNIT_DEACTIVATING
,
67 [SOCKET_STOP_POST
] = UNIT_DEACTIVATING
,
68 [SOCKET_FINAL_SIGTERM
] = UNIT_DEACTIVATING
,
69 [SOCKET_FINAL_SIGKILL
] = UNIT_DEACTIVATING
,
70 [SOCKET_FAILED
] = UNIT_FAILED
,
71 [SOCKET_CLEANING
] = UNIT_MAINTENANCE
,
74 static int socket_dispatch_io(sd_event_source
*source
, int fd
, uint32_t revents
, void *userdata
);
75 static int socket_dispatch_timer(sd_event_source
*source
, usec_t usec
, void *userdata
);
76 static void flush_ports(Socket
*s
);
78 static void socket_init(Unit
*u
) {
79 Socket
*s
= SOCKET(u
);
82 assert(u
->load_state
== UNIT_STUB
);
84 s
->backlog
= SOMAXCONN
;
85 s
->timeout_usec
= u
->manager
->default_timeout_start_usec
;
86 s
->directory_mode
= 0755;
87 s
->socket_mode
= 0666;
89 s
->max_connections
= 64;
96 s
->exec_context
.std_output
= u
->manager
->default_std_output
;
97 s
->exec_context
.std_error
= u
->manager
->default_std_error
;
99 s
->control_command_id
= _SOCKET_EXEC_COMMAND_INVALID
;
101 s
->trigger_limit
.interval
= USEC_INFINITY
;
102 s
->trigger_limit
.burst
= (unsigned) -1;
105 static void socket_unwatch_control_pid(Socket
*s
) {
108 if (s
->control_pid
<= 0)
111 unit_unwatch_pid(UNIT(s
), s
->control_pid
);
115 static void socket_cleanup_fd_list(SocketPort
*p
) {
118 close_many(p
->auxiliary_fds
, p
->n_auxiliary_fds
);
119 p
->auxiliary_fds
= mfree(p
->auxiliary_fds
);
120 p
->n_auxiliary_fds
= 0;
123 void socket_free_ports(Socket
*s
) {
128 while ((p
= s
->ports
)) {
129 LIST_REMOVE(port
, s
->ports
, p
);
131 sd_event_source_unref(p
->event_source
);
133 socket_cleanup_fd_list(p
);
140 static void socket_done(Unit
*u
) {
141 Socket
*s
= SOCKET(u
);
146 socket_free_ports(s
);
148 while ((p
= set_steal_first(s
->peers_by_address
)))
151 s
->peers_by_address
= set_free(s
->peers_by_address
);
153 s
->exec_runtime
= exec_runtime_unref(s
->exec_runtime
, false);
154 exec_command_free_array(s
->exec_command
, _SOCKET_EXEC_COMMAND_MAX
);
155 s
->control_command
= NULL
;
157 dynamic_creds_unref(&s
->dynamic_creds
);
159 socket_unwatch_control_pid(s
);
161 unit_ref_unset(&s
->service
);
163 s
->tcp_congestion
= mfree(s
->tcp_congestion
);
164 s
->bind_to_device
= mfree(s
->bind_to_device
);
166 s
->smack
= mfree(s
->smack
);
167 s
->smack_ip_in
= mfree(s
->smack_ip_in
);
168 s
->smack_ip_out
= mfree(s
->smack_ip_out
);
170 strv_free(s
->symlinks
);
172 s
->user
= mfree(s
->user
);
173 s
->group
= mfree(s
->group
);
175 s
->fdname
= mfree(s
->fdname
);
177 s
->timer_event_source
= sd_event_source_unref(s
->timer_event_source
);
180 static int socket_arm_timer(Socket
*s
, usec_t usec
) {
185 if (s
->timer_event_source
) {
186 r
= sd_event_source_set_time(s
->timer_event_source
, usec
);
190 return sd_event_source_set_enabled(s
->timer_event_source
, SD_EVENT_ONESHOT
);
193 if (usec
== USEC_INFINITY
)
196 r
= sd_event_add_time(
197 UNIT(s
)->manager
->event
,
198 &s
->timer_event_source
,
201 socket_dispatch_timer
, s
);
205 (void) sd_event_source_set_description(s
->timer_event_source
, "socket-timer");
210 static bool have_non_accept_socket(Socket
*s
) {
218 LIST_FOREACH(port
, p
, s
->ports
) {
220 if (p
->type
!= SOCKET_SOCKET
)
223 if (!socket_address_can_accept(&p
->address
))
230 static int socket_add_mount_dependencies(Socket
*s
) {
236 LIST_FOREACH(port
, p
, s
->ports
) {
237 const char *path
= NULL
;
239 if (p
->type
== SOCKET_SOCKET
)
240 path
= socket_address_get_path(&p
->address
);
241 else if (IN_SET(p
->type
, SOCKET_FIFO
, SOCKET_SPECIAL
, SOCKET_USB_FUNCTION
))
247 r
= unit_require_mounts_for(UNIT(s
), path
, UNIT_DEPENDENCY_FILE
);
255 static int socket_add_device_dependencies(Socket
*s
) {
260 if (!s
->bind_to_device
|| streq(s
->bind_to_device
, "lo"))
263 t
= strjoina("/sys/subsystem/net/devices/", s
->bind_to_device
);
264 return unit_add_node_dependency(UNIT(s
), t
, UNIT_BINDS_TO
, UNIT_DEPENDENCY_FILE
);
267 static int socket_add_default_dependencies(Socket
*s
) {
271 if (!UNIT(s
)->default_dependencies
)
274 r
= unit_add_dependency_by_name(UNIT(s
), UNIT_BEFORE
, SPECIAL_SOCKETS_TARGET
, true, UNIT_DEPENDENCY_DEFAULT
);
278 if (MANAGER_IS_SYSTEM(UNIT(s
)->manager
)) {
279 r
= unit_add_two_dependencies_by_name(UNIT(s
), UNIT_AFTER
, UNIT_REQUIRES
, SPECIAL_SYSINIT_TARGET
, true, UNIT_DEPENDENCY_DEFAULT
);
284 return unit_add_two_dependencies_by_name(UNIT(s
), UNIT_BEFORE
, UNIT_CONFLICTS
, SPECIAL_SHUTDOWN_TARGET
, true, UNIT_DEPENDENCY_DEFAULT
);
287 _pure_
static bool socket_has_exec(Socket
*s
) {
291 for (i
= 0; i
< _SOCKET_EXEC_COMMAND_MAX
; i
++)
292 if (s
->exec_command
[i
])
298 static int socket_add_extras(Socket
*s
) {
304 /* Pick defaults for the trigger limit, if nothing was explicitly configured. We pick a relatively high limit
305 * in Accept=yes mode, and a lower limit for Accept=no. Reason: in Accept=yes mode we are invoking accept()
306 * ourselves before the trigger limit can hit, thus incoming connections are taken off the socket queue quickly
307 * and reliably. This is different for Accept=no, where the spawned service has to take the incoming traffic
308 * off the queues, which it might not necessarily do. Moreover, while Accept=no services are supposed to
309 * process whatever is queued in one go, and thus should normally never have to be started frequently. This is
310 * different for Accept=yes where each connection is processed by a new service instance, and thus frequent
311 * service starts are typical. */
313 if (s
->trigger_limit
.interval
== USEC_INFINITY
)
314 s
->trigger_limit
.interval
= 2 * USEC_PER_SEC
;
316 if (s
->trigger_limit
.burst
== (unsigned) -1) {
318 s
->trigger_limit
.burst
= 200;
320 s
->trigger_limit
.burst
= 20;
323 if (have_non_accept_socket(s
)) {
325 if (!UNIT_DEREF(s
->service
)) {
328 r
= unit_load_related_unit(u
, ".service", &x
);
332 unit_ref_set(&s
->service
, u
, x
);
335 r
= unit_add_two_dependencies(u
, UNIT_BEFORE
, UNIT_TRIGGERS
, UNIT_DEREF(s
->service
), true, UNIT_DEPENDENCY_IMPLICIT
);
340 r
= socket_add_mount_dependencies(s
);
344 r
= socket_add_device_dependencies(s
);
348 r
= unit_patch_contexts(u
);
352 if (socket_has_exec(s
)) {
353 r
= unit_add_exec_dependencies(u
, &s
->exec_context
);
358 r
= unit_set_default_slice(u
);
362 r
= socket_add_default_dependencies(s
);
369 static const char *socket_find_symlink_target(Socket
*s
) {
370 const char *found
= NULL
;
373 LIST_FOREACH(port
, p
, s
->ports
) {
374 const char *f
= NULL
;
383 f
= socket_address_get_path(&p
->address
);
401 static int socket_verify(Socket
*s
) {
403 assert(UNIT(s
)->load_state
== UNIT_LOADED
);
406 log_unit_error(UNIT(s
), "Unit has no Listen setting (ListenStream=, ListenDatagram=, ListenFIFO=, ...). Refusing.");
410 if (s
->accept
&& have_non_accept_socket(s
)) {
411 log_unit_error(UNIT(s
), "Unit configured for accepting sockets, but sockets are non-accepting. Refusing.");
415 if (s
->accept
&& s
->max_connections
<= 0) {
416 log_unit_error(UNIT(s
), "MaxConnection= setting too small. Refusing.");
420 if (s
->accept
&& UNIT_DEREF(s
->service
)) {
421 log_unit_error(UNIT(s
), "Explicit service configuration for accepting socket units not supported. Refusing.");
425 if (s
->exec_context
.pam_name
&& s
->kill_context
.kill_mode
!= KILL_CONTROL_GROUP
) {
426 log_unit_error(UNIT(s
), "Unit has PAM enabled. Kill mode must be set to 'control-group'. Refusing.");
430 if (!strv_isempty(s
->symlinks
) && !socket_find_symlink_target(s
)) {
431 log_unit_error(UNIT(s
), "Unit has symlinks set but none or more than one node in the file system. Refusing.");
438 static void peer_address_hash_func(const SocketPeer
*s
, struct siphash
*state
) {
441 if (s
->peer
.sa
.sa_family
== AF_INET
)
442 siphash24_compress(&s
->peer
.in
.sin_addr
, sizeof(s
->peer
.in
.sin_addr
), state
);
443 else if (s
->peer
.sa
.sa_family
== AF_INET6
)
444 siphash24_compress(&s
->peer
.in6
.sin6_addr
, sizeof(s
->peer
.in6
.sin6_addr
), state
);
445 else if (s
->peer
.sa
.sa_family
== AF_VSOCK
)
446 siphash24_compress(&s
->peer
.vm
.svm_cid
, sizeof(s
->peer
.vm
.svm_cid
), state
);
448 assert_not_reached("Unknown address family.");
451 static int peer_address_compare_func(const SocketPeer
*x
, const SocketPeer
*y
) {
454 r
= CMP(x
->peer
.sa
.sa_family
, y
->peer
.sa
.sa_family
);
458 switch(x
->peer
.sa
.sa_family
) {
460 return memcmp(&x
->peer
.in
.sin_addr
, &y
->peer
.in
.sin_addr
, sizeof(x
->peer
.in
.sin_addr
));
462 return memcmp(&x
->peer
.in6
.sin6_addr
, &y
->peer
.in6
.sin6_addr
, sizeof(x
->peer
.in6
.sin6_addr
));
464 return CMP(x
->peer
.vm
.svm_cid
, y
->peer
.vm
.svm_cid
);
466 assert_not_reached("Black sheep in the family!");
469 DEFINE_PRIVATE_HASH_OPS(peer_address_hash_ops
, SocketPeer
, peer_address_hash_func
, peer_address_compare_func
);
471 static int socket_load(Unit
*u
) {
472 Socket
*s
= SOCKET(u
);
476 assert(u
->load_state
== UNIT_STUB
);
478 r
= set_ensure_allocated(&s
->peers_by_address
, &peer_address_hash_ops
);
482 r
= unit_load_fragment_and_dropin(u
, true);
486 if (u
->load_state
!= UNIT_LOADED
)
489 /* This is a new unit? Then let's add in some extras */
490 r
= socket_add_extras(s
);
494 return socket_verify(s
);
497 static SocketPeer
*socket_peer_new(void) {
500 p
= new0(SocketPeer
, 1);
509 static SocketPeer
*socket_peer_free(SocketPeer
*p
) {
513 set_remove(p
->socket
->peers_by_address
, p
);
518 DEFINE_TRIVIAL_REF_UNREF_FUNC(SocketPeer
, socket_peer
, socket_peer_free
);
520 int socket_acquire_peer(Socket
*s
, int fd
, SocketPeer
**p
) {
521 _cleanup_(socket_peer_unrefp
) SocketPeer
*remote
= NULL
;
522 SocketPeer sa
= {}, *i
;
523 socklen_t salen
= sizeof(sa
.peer
);
529 r
= getpeername(fd
, &sa
.peer
.sa
, &salen
);
531 return log_unit_error_errno(UNIT(s
), errno
, "getpeername failed: %m");
533 if (!IN_SET(sa
.peer
.sa
.sa_family
, AF_INET
, AF_INET6
, AF_VSOCK
)) {
538 i
= set_get(s
->peers_by_address
, &sa
);
540 *p
= socket_peer_ref(i
);
544 remote
= socket_peer_new();
548 remote
->peer
= sa
.peer
;
549 remote
->peer_salen
= salen
;
551 r
= set_put(s
->peers_by_address
, remote
);
557 *p
= TAKE_PTR(remote
);
562 _const_
static const char* listen_lookup(int family
, int type
) {
564 if (family
== AF_NETLINK
)
565 return "ListenNetlink";
567 if (type
== SOCK_STREAM
)
568 return "ListenStream";
569 else if (type
== SOCK_DGRAM
)
570 return "ListenDatagram";
571 else if (type
== SOCK_SEQPACKET
)
572 return "ListenSequentialPacket";
574 assert_not_reached("Unknown socket type");
578 static void socket_dump(Unit
*u
, FILE *f
, const char *prefix
) {
579 char time_string
[FORMAT_TIMESPAN_MAX
];
581 Socket
*s
= SOCKET(u
);
583 const char *prefix2
, *str
;
588 prefix
= strempty(prefix
);
589 prefix2
= strjoina(prefix
, "\t");
592 "%sSocket State: %s\n"
594 "%sClean Result: %s\n"
595 "%sBindIPv6Only: %s\n"
597 "%sSocketMode: %04o\n"
598 "%sDirectoryMode: %04o\n"
602 "%sTransparent: %s\n"
604 "%sPassCredentials: %s\n"
605 "%sPassSecurity: %s\n"
606 "%sPassPacketInfo: %s\n"
607 "%sTCPCongestion: %s\n"
608 "%sRemoveOnStop: %s\n"
610 "%sFileDescriptorName: %s\n"
611 "%sSELinuxContextFromNet: %s\n",
612 prefix
, socket_state_to_string(s
->state
),
613 prefix
, socket_result_to_string(s
->result
),
614 prefix
, socket_result_to_string(s
->clean_result
),
615 prefix
, socket_address_bind_ipv6_only_to_string(s
->bind_ipv6_only
),
617 prefix
, s
->socket_mode
,
618 prefix
, s
->directory_mode
,
619 prefix
, yes_no(s
->keep_alive
),
620 prefix
, yes_no(s
->no_delay
),
621 prefix
, yes_no(s
->free_bind
),
622 prefix
, yes_no(s
->transparent
),
623 prefix
, yes_no(s
->broadcast
),
624 prefix
, yes_no(s
->pass_cred
),
625 prefix
, yes_no(s
->pass_sec
),
626 prefix
, yes_no(s
->pass_pktinfo
),
627 prefix
, strna(s
->tcp_congestion
),
628 prefix
, yes_no(s
->remove_on_stop
),
629 prefix
, yes_no(s
->writable
),
630 prefix
, socket_fdname(s
),
631 prefix
, yes_no(s
->selinux_context_from_net
));
633 if (s
->control_pid
> 0)
635 "%sControl PID: "PID_FMT
"\n",
636 prefix
, s
->control_pid
);
638 if (s
->bind_to_device
)
640 "%sBindToDevice: %s\n",
641 prefix
, s
->bind_to_device
);
646 "%sNConnections: %u\n"
647 "%sMaxConnections: %u\n"
648 "%sMaxConnectionsPerSource: %u\n",
649 prefix
, s
->n_accepted
,
650 prefix
, s
->n_connections
,
651 prefix
, s
->max_connections
,
652 prefix
, s
->max_connections_per_source
);
655 "%sFlushPending: %s\n",
656 prefix
, yes_no(s
->flush_pending
));
659 if (s
->priority
>= 0)
662 prefix
, s
->priority
);
664 if (s
->receive_buffer
> 0)
666 "%sReceiveBuffer: %zu\n",
667 prefix
, s
->receive_buffer
);
669 if (s
->send_buffer
> 0)
671 "%sSendBuffer: %zu\n",
672 prefix
, s
->send_buffer
);
684 if (s
->pipe_size
> 0)
687 prefix
, s
->pipe_size
);
694 if (s
->mq_maxmsg
> 0)
696 "%sMessageQueueMaxMessages: %li\n",
697 prefix
, s
->mq_maxmsg
);
699 if (s
->mq_msgsize
> 0)
701 "%sMessageQueueMessageSize: %li\n",
702 prefix
, s
->mq_msgsize
);
707 prefix
, yes_no(s
->reuse_port
));
711 "%sSmackLabel: %s\n",
716 "%sSmackLabelIPIn: %s\n",
717 prefix
, s
->smack_ip_in
);
721 "%sSmackLabelIPOut: %s\n",
722 prefix
, s
->smack_ip_out
);
724 if (!isempty(s
->user
) || !isempty(s
->group
))
727 "%sSocketGroup: %s\n",
728 prefix
, strna(s
->user
),
729 prefix
, strna(s
->group
));
731 if (s
->keep_alive_time
> 0)
733 "%sKeepAliveTimeSec: %s\n",
734 prefix
, format_timespan(time_string
, FORMAT_TIMESPAN_MAX
, s
->keep_alive_time
, USEC_PER_SEC
));
736 if (s
->keep_alive_interval
> 0)
738 "%sKeepAliveIntervalSec: %s\n",
739 prefix
, format_timespan(time_string
, FORMAT_TIMESPAN_MAX
, s
->keep_alive_interval
, USEC_PER_SEC
));
741 if (s
->keep_alive_cnt
> 0)
743 "%sKeepAliveProbes: %u\n",
744 prefix
, s
->keep_alive_cnt
);
746 if (s
->defer_accept
> 0)
748 "%sDeferAcceptSec: %s\n",
749 prefix
, format_timespan(time_string
, FORMAT_TIMESPAN_MAX
, s
->defer_accept
, USEC_PER_SEC
));
751 LIST_FOREACH(port
, p
, s
->ports
) {
754 case SOCKET_SOCKET
: {
755 _cleanup_free_
char *k
= NULL
;
759 r
= socket_address_print(&p
->address
, &k
);
761 t
= strerror_safe(r
);
765 fprintf(f
, "%s%s: %s\n", prefix
, listen_lookup(socket_address_family(&p
->address
), p
->address
.type
), t
);
769 fprintf(f
, "%sListenSpecial: %s\n", prefix
, p
->path
);
771 case SOCKET_USB_FUNCTION
:
772 fprintf(f
, "%sListenUSBFunction: %s\n", prefix
, p
->path
);
775 fprintf(f
, "%sListenMessageQueue: %s\n", prefix
, p
->path
);
778 fprintf(f
, "%sListenFIFO: %s\n", prefix
, p
->path
);
783 "%sTriggerLimitIntervalSec: %s\n"
784 "%sTriggerLimitBurst: %u\n",
785 prefix
, format_timespan(time_string
, FORMAT_TIMESPAN_MAX
, s
->trigger_limit
.interval
, USEC_PER_SEC
),
786 prefix
, s
->trigger_limit
.burst
);
788 str
= ip_protocol_to_name(s
->socket_protocol
);
790 fprintf(f
, "%sSocketProtocol: %s\n", prefix
, str
);
792 if (!strv_isempty(s
->symlinks
)) {
795 fprintf(f
, "%sSymlinks:", prefix
);
796 STRV_FOREACH(q
, s
->symlinks
)
797 fprintf(f
, " %s", *q
);
803 "%sTimeoutSec: %s\n",
804 prefix
, format_timespan(time_string
, FORMAT_TIMESPAN_MAX
, s
->timeout_usec
, USEC_PER_SEC
));
806 exec_context_dump(&s
->exec_context
, f
, prefix
);
807 kill_context_dump(&s
->kill_context
, f
, prefix
);
809 for (c
= 0; c
< _SOCKET_EXEC_COMMAND_MAX
; c
++) {
810 if (!s
->exec_command
[c
])
813 fprintf(f
, "%s-> %s:\n",
814 prefix
, socket_exec_command_to_string(c
));
816 exec_command_dump_list(s
->exec_command
[c
], f
, prefix2
);
819 cgroup_context_dump(UNIT(s
), f
, prefix
);
822 static int instance_from_socket(int fd
, unsigned nr
, char **instance
) {
825 union sockaddr_union local
, remote
;
831 if (getsockname(fd
, &local
.sa
, &l
) < 0)
835 if (getpeername(fd
, &remote
.sa
, &l
) < 0)
838 switch (local
.sa
.sa_family
) {
842 a
= be32toh(local
.in
.sin_addr
.s_addr
),
843 b
= be32toh(remote
.in
.sin_addr
.s_addr
);
846 "%u-%u.%u.%u.%u:%u-%u.%u.%u.%u:%u",
848 a
>> 24, (a
>> 16) & 0xFF, (a
>> 8) & 0xFF, a
& 0xFF,
849 be16toh(local
.in
.sin_port
),
850 b
>> 24, (b
>> 16) & 0xFF, (b
>> 8) & 0xFF, b
& 0xFF,
851 be16toh(remote
.in
.sin_port
)) < 0)
858 static const unsigned char ipv4_prefix
[] = {
859 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0xFF, 0xFF
862 if (memcmp(&local
.in6
.sin6_addr
, ipv4_prefix
, sizeof(ipv4_prefix
)) == 0 &&
863 memcmp(&remote
.in6
.sin6_addr
, ipv4_prefix
, sizeof(ipv4_prefix
)) == 0) {
865 *a
= local
.in6
.sin6_addr
.s6_addr
+12,
866 *b
= remote
.in6
.sin6_addr
.s6_addr
+12;
869 "%u-%u.%u.%u.%u:%u-%u.%u.%u.%u:%u",
871 a
[0], a
[1], a
[2], a
[3],
872 be16toh(local
.in6
.sin6_port
),
873 b
[0], b
[1], b
[2], b
[3],
874 be16toh(remote
.in6
.sin6_port
)) < 0)
877 char a
[INET6_ADDRSTRLEN
], b
[INET6_ADDRSTRLEN
];
882 inet_ntop(AF_INET6
, &local
.in6
.sin6_addr
, a
, sizeof(a
)),
883 be16toh(local
.in6
.sin6_port
),
884 inet_ntop(AF_INET6
, &remote
.in6
.sin6_addr
, b
, sizeof(b
)),
885 be16toh(remote
.in6
.sin6_port
)) < 0)
896 k
= getpeercred(fd
, &ucred
);
899 "%u-"PID_FMT
"-"UID_FMT
,
900 nr
, ucred
.pid
, ucred
.uid
) < 0)
902 } else if (k
== -ENODATA
) {
903 /* This handles the case where somebody is
904 * connecting from another pid/uid namespace
905 * (e.g. from outside of our container). */
920 local
.vm
.svm_cid
, local
.vm
.svm_port
,
921 remote
.vm
.svm_cid
, remote
.vm
.svm_port
) < 0)
927 assert_not_reached("Unhandled socket type.");
934 static void socket_close_fds(Socket
*s
) {
940 LIST_FOREACH(port
, p
, s
->ports
) {
943 was_open
= p
->fd
>= 0;
945 p
->event_source
= sd_event_source_unref(p
->event_source
);
946 p
->fd
= safe_close(p
->fd
);
947 socket_cleanup_fd_list(p
);
949 /* One little note: we should normally not delete any sockets in the file system here! After all some
950 * other process we spawned might still have a reference of this fd and wants to continue to use
951 * it. Therefore we normally delete sockets in the file system before we create a new one, not after we
952 * stopped using one! That all said, if the user explicitly requested this, we'll delete them here
953 * anyway, but only then. */
955 if (!was_open
|| !s
->remove_on_stop
)
961 (void) unlink(p
->path
);
965 (void) mq_unlink(p
->path
);
969 (void) socket_address_unlink(&p
->address
);
977 if (s
->remove_on_stop
)
978 STRV_FOREACH(i
, s
->symlinks
)
982 static void socket_apply_socket_options(Socket
*s
, SocketPort
*p
, int fd
) {
990 r
= setsockopt_int(fd
, SOL_SOCKET
, SO_KEEPALIVE
, true);
992 log_unit_warning_errno(UNIT(s
), r
, "SO_KEEPALIVE failed: %m");
995 if (s
->keep_alive_time
> 0) {
996 r
= setsockopt_int(fd
, SOL_TCP
, TCP_KEEPIDLE
, s
->keep_alive_time
/ USEC_PER_SEC
);
998 log_unit_warning_errno(UNIT(s
), r
, "TCP_KEEPIDLE failed: %m");
1001 if (s
->keep_alive_interval
> 0) {
1002 r
= setsockopt_int(fd
, SOL_TCP
, TCP_KEEPINTVL
, s
->keep_alive_interval
/ USEC_PER_SEC
);
1004 log_unit_warning_errno(UNIT(s
), r
, "TCP_KEEPINTVL failed: %m");
1007 if (s
->keep_alive_cnt
> 0) {
1008 r
= setsockopt_int(fd
, SOL_TCP
, TCP_KEEPCNT
, s
->keep_alive_cnt
);
1010 log_unit_warning_errno(UNIT(s
), r
, "TCP_KEEPCNT failed: %m");
1013 if (s
->defer_accept
> 0) {
1014 r
= setsockopt_int(fd
, SOL_TCP
, TCP_DEFER_ACCEPT
, s
->defer_accept
/ USEC_PER_SEC
);
1016 log_unit_warning_errno(UNIT(s
), r
, "TCP_DEFER_ACCEPT failed: %m");
1020 if (s
->socket_protocol
== IPPROTO_SCTP
) {
1021 r
= setsockopt_int(fd
, SOL_SCTP
, SCTP_NODELAY
, true);
1023 log_unit_warning_errno(UNIT(s
), r
, "SCTP_NODELAY failed: %m");
1025 r
= setsockopt_int(fd
, SOL_TCP
, TCP_NODELAY
, true);
1027 log_unit_warning_errno(UNIT(s
), r
, "TCP_NODELAY failed: %m");
1032 r
= setsockopt_int(fd
, SOL_SOCKET
, SO_BROADCAST
, true);
1034 log_unit_warning_errno(UNIT(s
), r
, "SO_BROADCAST failed: %m");
1038 r
= setsockopt_int(fd
, SOL_SOCKET
, SO_PASSCRED
, true);
1040 log_unit_warning_errno(UNIT(s
), r
, "SO_PASSCRED failed: %m");
1044 r
= setsockopt_int(fd
, SOL_SOCKET
, SO_PASSSEC
, true);
1046 log_unit_warning_errno(UNIT(s
), r
, "SO_PASSSEC failed: %m");
1049 if (s
->pass_pktinfo
) {
1050 r
= socket_set_recvpktinfo(fd
, socket_address_family(&p
->address
), true);
1052 log_unit_warning_errno(UNIT(s
), r
, "Failed to enable packet info socket option: %m");
1055 if (s
->priority
>= 0) {
1056 r
= setsockopt_int(fd
, SOL_SOCKET
, SO_PRIORITY
, s
->priority
);
1058 log_unit_warning_errno(UNIT(s
), r
, "SO_PRIORITY failed: %m");
1061 if (s
->receive_buffer
> 0) {
1062 r
= fd_set_rcvbuf(fd
, s
->receive_buffer
, false);
1064 log_unit_full_errno(UNIT(s
), ERRNO_IS_PRIVILEGE(r
) ? LOG_DEBUG
: LOG_WARNING
, r
,
1065 "SO_RCVBUF/SO_RCVBUFFORCE failed: %m");
1068 if (s
->send_buffer
> 0) {
1069 r
= fd_set_sndbuf(fd
, s
->send_buffer
, false);
1071 log_unit_full_errno(UNIT(s
), ERRNO_IS_PRIVILEGE(r
) ? LOG_DEBUG
: LOG_WARNING
, r
,
1072 "SO_SNDBUF/SO_SNDBUFFORCE failed: %m");
1076 r
= setsockopt_int(fd
, SOL_SOCKET
, SO_MARK
, s
->mark
);
1078 log_unit_warning_errno(UNIT(s
), r
, "SO_MARK failed: %m");
1081 if (s
->ip_tos
>= 0) {
1082 r
= setsockopt_int(fd
, IPPROTO_IP
, IP_TOS
, s
->ip_tos
);
1084 log_unit_warning_errno(UNIT(s
), r
, "IP_TOS failed: %m");
1087 if (s
->ip_ttl
>= 0) {
1088 r
= socket_set_ttl(fd
, socket_address_family(&p
->address
), s
->ip_ttl
);
1090 log_unit_warning_errno(UNIT(s
), r
, "IP_TTL/IPV6_UNICAST_HOPS failed: %m");
1093 if (s
->tcp_congestion
)
1094 if (setsockopt(fd
, SOL_TCP
, TCP_CONGESTION
, s
->tcp_congestion
, strlen(s
->tcp_congestion
)+1) < 0)
1095 log_unit_warning_errno(UNIT(s
), errno
, "TCP_CONGESTION failed: %m");
1097 if (s
->smack_ip_in
) {
1098 r
= mac_smack_apply_fd(fd
, SMACK_ATTR_IPIN
, s
->smack_ip_in
);
1100 log_unit_error_errno(UNIT(s
), r
, "mac_smack_apply_ip_in_fd: %m");
1103 if (s
->smack_ip_out
) {
1104 r
= mac_smack_apply_fd(fd
, SMACK_ATTR_IPOUT
, s
->smack_ip_out
);
1106 log_unit_error_errno(UNIT(s
), r
, "mac_smack_apply_ip_out_fd: %m");
1110 static void socket_apply_fifo_options(Socket
*s
, int fd
) {
1116 if (s
->pipe_size
> 0)
1117 if (fcntl(fd
, F_SETPIPE_SZ
, s
->pipe_size
) < 0)
1118 log_unit_warning_errno(UNIT(s
), errno
, "Setting pipe size failed, ignoring: %m");
1121 r
= mac_smack_apply_fd(fd
, SMACK_ATTR_ACCESS
, s
->smack
);
1123 log_unit_error_errno(UNIT(s
), r
, "SMACK relabelling failed, ignoring: %m");
1127 static int fifo_address_create(
1129 mode_t directory_mode
,
1130 mode_t socket_mode
) {
1132 _cleanup_close_
int fd
= -1;
1139 (void) mkdir_parents_label(path
, directory_mode
);
1141 r
= mac_selinux_create_file_prepare(path
, S_IFIFO
);
1145 /* Enforce the right access mode for the fifo */
1146 old_mask
= umask(~socket_mode
);
1148 /* Include the original umask in our mask */
1149 (void) umask(~socket_mode
| old_mask
);
1151 r
= mkfifo(path
, socket_mode
);
1152 (void) umask(old_mask
);
1154 if (r
< 0 && errno
!= EEXIST
) {
1159 fd
= open(path
, O_RDWR
| O_CLOEXEC
| O_NOCTTY
| O_NONBLOCK
| O_NOFOLLOW
);
1165 mac_selinux_create_file_clear();
1167 if (fstat(fd
, &st
) < 0) {
1172 if (!S_ISFIFO(st
.st_mode
) ||
1173 (st
.st_mode
& 0777) != (socket_mode
& ~old_mask
) ||
1174 st
.st_uid
!= getuid() ||
1175 st
.st_gid
!= getgid()) {
1183 mac_selinux_create_file_clear();
1187 static int special_address_create(const char *path
, bool writable
) {
1188 _cleanup_close_
int fd
= -1;
1193 fd
= open(path
, (writable
? O_RDWR
: O_RDONLY
)|O_CLOEXEC
|O_NOCTTY
|O_NONBLOCK
|O_NOFOLLOW
);
1197 if (fstat(fd
, &st
) < 0)
1200 /* Check whether this is a /proc, /sys or /dev file or char device */
1201 if (!S_ISREG(st
.st_mode
) && !S_ISCHR(st
.st_mode
))
1207 static int usbffs_address_create(const char *path
) {
1208 _cleanup_close_
int fd
= -1;
1213 fd
= open(path
, O_RDWR
|O_CLOEXEC
|O_NOCTTY
|O_NONBLOCK
|O_NOFOLLOW
);
1217 if (fstat(fd
, &st
) < 0)
1220 /* Check whether this is a regular file (ffs endpoint) */
1221 if (!S_ISREG(st
.st_mode
))
1227 static int mq_address_create(
1233 _cleanup_close_
int fd
= -1;
1236 struct mq_attr _attr
, *attr
= NULL
;
1240 if (maxmsg
> 0 && msgsize
> 0) {
1241 _attr
= (struct mq_attr
) {
1242 .mq_flags
= O_NONBLOCK
,
1243 .mq_maxmsg
= maxmsg
,
1244 .mq_msgsize
= msgsize
,
1249 /* Enforce the right access mode for the mq */
1250 old_mask
= umask(~mq_mode
);
1252 /* Include the original umask in our mask */
1253 (void) umask(~mq_mode
| old_mask
);
1254 fd
= mq_open(path
, O_RDONLY
|O_CLOEXEC
|O_NONBLOCK
|O_CREAT
, mq_mode
, attr
);
1255 (void) umask(old_mask
);
1260 if (fstat(fd
, &st
) < 0)
1263 if ((st
.st_mode
& 0777) != (mq_mode
& ~old_mask
) ||
1264 st
.st_uid
!= getuid() ||
1265 st
.st_gid
!= getgid())
1271 static int socket_symlink(Socket
*s
) {
1278 p
= socket_find_symlink_target(s
);
1282 STRV_FOREACH(i
, s
->symlinks
) {
1283 (void) mkdir_parents_label(*i
, s
->directory_mode
);
1285 r
= symlink_idempotent(p
, *i
, false);
1287 if (r
== -EEXIST
&& s
->remove_on_stop
) {
1288 /* If there's already something where we want to create the symlink, and the destructive
1289 * RemoveOnStop= mode is set, then we might as well try to remove what already exists and try
1292 if (unlink(*i
) >= 0)
1293 r
= symlink_idempotent(p
, *i
, false);
1297 log_unit_warning_errno(UNIT(s
), r
, "Failed to create symlink %s → %s, ignoring: %m", p
, *i
);
1303 static int usbffs_write_descs(int fd
, Service
*s
) {
1306 if (!s
->usb_function_descriptors
|| !s
->usb_function_strings
)
1309 r
= copy_file_fd(s
->usb_function_descriptors
, fd
, 0);
1313 return copy_file_fd(s
->usb_function_strings
, fd
, 0);
1316 static int usbffs_select_ep(const struct dirent
*d
) {
1317 return d
->d_name
[0] != '.' && !streq(d
->d_name
, "ep0");
1320 static int usbffs_dispatch_eps(SocketPort
*p
) {
1321 _cleanup_free_
struct dirent
**ent
= NULL
;
1325 r
= scandir(p
->path
, &ent
, usbffs_select_ep
, alphasort
);
1330 p
->auxiliary_fds
= new(int, n
);
1331 if (!p
->auxiliary_fds
) {
1336 p
->n_auxiliary_fds
= n
;
1339 for (i
= 0; i
< n
; ++i
) {
1340 _cleanup_free_
char *ep
= NULL
;
1342 ep
= path_make_absolute(ent
[i
]->d_name
, p
->path
);
1348 path_simplify(ep
, false);
1350 r
= usbffs_address_create(ep
);
1354 p
->auxiliary_fds
[k
++] = r
;
1361 close_many(p
->auxiliary_fds
, k
);
1362 p
->auxiliary_fds
= mfree(p
->auxiliary_fds
);
1363 p
->n_auxiliary_fds
= 0;
1366 for (i
= 0; i
< n
; ++i
)
1372 int socket_load_service_unit(Socket
*s
, int cfd
, Unit
**ret
) {
1373 /* Figure out what the unit that will be used to handle the connections on the socket looks like.
1375 * If cfd < 0, then we don't have a connection yet. In case of Accept=yes sockets, use a fake
1379 if (UNIT_ISSET(s
->service
)) {
1380 *ret
= UNIT_DEREF(s
->service
);
1387 /* Build the instance name and load the unit */
1388 _cleanup_free_
char *prefix
= NULL
, *instance
= NULL
, *name
= NULL
;
1391 r
= unit_name_to_prefix(UNIT(s
)->id
, &prefix
);
1396 r
= instance_from_socket(cfd
, s
->n_accepted
, &instance
);
1397 if (ERRNO_IS_DISCONNECT(r
))
1398 /* ENOTCONN is legitimate if TCP RST was received. Other socket families might return
1399 * different errors. This connection is over, but the socket unit lives on. */
1400 return log_unit_debug_errno(UNIT(s
), r
,
1401 "Got %s on incoming socket, assuming aborted connection attempt, ignoring.",
1407 /* For accepting sockets, we don't know how the instance will be called until we get a connection and
1408 * can figure out what the peer name is. So let's use "internal" as the instance to make it clear
1409 * that this is not an actual peer name. We use "unknown" when we cannot figure out the peer. */
1410 r
= unit_name_build(prefix
, instance
?: "internal", ".service", &name
);
1414 return manager_load_unit(UNIT(s
)->manager
, name
, NULL
, NULL
, ret
);
1417 static int socket_determine_selinux_label(Socket
*s
, char **ret
) {
1423 if (s
->selinux_context_from_net
) {
1424 /* If this is requested, get the label from the network label */
1426 r
= mac_selinux_get_our_label(ret
);
1427 if (r
== -EOPNOTSUPP
)
1431 /* Otherwise, get it from the executable we are about to start. */
1435 _cleanup_free_
char *path
= NULL
;
1437 r
= socket_load_service_unit(s
, -1, &service
);
1443 c
= SERVICE(service
)->exec_command
[SERVICE_EXEC_START
];
1447 r
= chase_symlinks(c
->path
, SERVICE(service
)->exec_context
.root_directory
, CHASE_PREFIX_ROOT
, &path
, NULL
);
1451 r
= mac_selinux_get_create_label_from_exe(path
, ret
);
1452 if (IN_SET(r
, -EPERM
, -EOPNOTSUPP
))
1463 static int socket_address_listen_do(
1465 const SocketAddress
*address
,
1466 const char *label
) {
1471 return socket_address_listen(
1473 SOCK_CLOEXEC
|SOCK_NONBLOCK
,
1485 #define log_address_error_errno(u, address, error, fmt) \
1487 _cleanup_free_ char *_t = NULL; \
1489 (void) socket_address_print(address, &_t); \
1490 log_unit_error_errno(u, error, fmt, strna(_t)); \
1493 static int fork_needed(const SocketAddress
*address
, const ExecContext
*context
) {
1499 /* Check if we need to do the cgroup or netns stuff. If not we can do things much simpler. */
1501 if (IN_SET(address
->sockaddr
.sa
.sa_family
, AF_INET
, AF_INET6
)) {
1502 r
= bpf_firewall_supported();
1505 if (r
!= BPF_FIREWALL_UNSUPPORTED
) /* If BPF firewalling isn't supported anyway — there's no point in this forking complexity */
1509 return context
->private_network
|| context
->network_namespace_path
;
1512 static int socket_address_listen_in_cgroup(
1514 const SocketAddress
*address
,
1515 const char *label
) {
1517 _cleanup_close_pair_
int pair
[2] = { -1, -1 };
1524 /* This is a wrapper around socket_address_listen(), that forks off a helper process inside the
1525 * socket's cgroup and network namespace in which the socket is actually created. This way we ensure
1526 * the socket is actually properly attached to the unit's cgroup for the purpose of BPF filtering and
1529 r
= fork_needed(address
, &s
->exec_context
);
1533 /* Shortcut things... */
1534 fd
= socket_address_listen_do(s
, address
, label
);
1536 return log_address_error_errno(UNIT(s
), address
, fd
, "Failed to create listening socket (%s): %m");
1541 r
= unit_setup_exec_runtime(UNIT(s
));
1543 return log_unit_error_errno(UNIT(s
), r
, "Failed acquire runtime: %m");
1545 if (s
->exec_context
.network_namespace_path
&&
1547 s
->exec_runtime
->netns_storage_socket
[0] >= 0) {
1548 r
= open_netns_path(s
->exec_runtime
->netns_storage_socket
, s
->exec_context
.network_namespace_path
);
1550 return log_unit_error_errno(UNIT(s
), r
, "Failed to open network namespace path %s: %m", s
->exec_context
.network_namespace_path
);
1553 if (socketpair(AF_UNIX
, SOCK_SEQPACKET
|SOCK_CLOEXEC
, 0, pair
) < 0)
1554 return log_unit_error_errno(UNIT(s
), errno
, "Failed to create communication channel: %m");
1556 r
= unit_fork_helper_process(UNIT(s
), "(sd-listen)", &pid
);
1558 return log_unit_error_errno(UNIT(s
), r
, "Failed to fork off listener stub process: %m");
1562 pair
[0] = safe_close(pair
[0]);
1564 if ((s
->exec_context
.private_network
|| s
->exec_context
.network_namespace_path
) &&
1566 s
->exec_runtime
->netns_storage_socket
[0] >= 0) {
1568 if (ns_type_supported(NAMESPACE_NET
)) {
1569 r
= setup_netns(s
->exec_runtime
->netns_storage_socket
);
1571 log_unit_error_errno(UNIT(s
), r
, "Failed to join network namespace: %m");
1572 _exit(EXIT_NETWORK
);
1574 } else if (s
->exec_context
.network_namespace_path
) {
1575 log_unit_error(UNIT(s
), "Network namespace path configured but network namespaces not supported.");
1576 _exit(EXIT_NETWORK
);
1578 log_unit_warning(UNIT(s
), "PrivateNetwork=yes is configured, but the kernel does not support network namespaces, ignoring.");
1581 fd
= socket_address_listen_do(s
, address
, label
);
1583 log_address_error_errno(UNIT(s
), address
, fd
, "Failed to create listening socket (%s): %m");
1584 _exit(EXIT_FAILURE
);
1587 r
= send_one_fd(pair
[1], fd
, 0);
1589 log_address_error_errno(UNIT(s
), address
, r
, "Failed to send listening socket (%s) to parent: %m");
1590 _exit(EXIT_FAILURE
);
1593 _exit(EXIT_SUCCESS
);
1596 pair
[1] = safe_close(pair
[1]);
1597 fd
= receive_one_fd(pair
[0], 0);
1599 /* We synchronously wait for the helper, as it shouldn't be slow */
1600 r
= wait_for_terminate_and_check("(sd-listen)", pid
, WAIT_LOG_ABNORMAL
);
1607 return log_address_error_errno(UNIT(s
), address
, fd
, "Failed to receive listening socket (%s): %m");
1612 DEFINE_TRIVIAL_CLEANUP_FUNC(Socket
*, socket_close_fds
);
1614 static int socket_open_fds(Socket
*_s
) {
1615 _cleanup_(socket_close_fdsp
) Socket
*s
= _s
;
1616 _cleanup_(mac_selinux_freep
) char *label
= NULL
;
1617 bool know_label
= false;
1623 LIST_FOREACH(port
, p
, s
->ports
) {
1633 /* Figure out the label, if we don't it know yet. We do it once for the first
1634 * socket where we need this and remember it for the rest. */
1636 r
= socket_determine_selinux_label(s
, &label
);
1638 return log_unit_error_errno(UNIT(s
), r
, "Failed to determine SELinux label: %m");
1643 /* Apply the socket protocol */
1644 switch (p
->address
.type
) {
1647 case SOCK_SEQPACKET
:
1648 if (s
->socket_protocol
== IPPROTO_SCTP
)
1649 p
->address
.protocol
= s
->socket_protocol
;
1653 if (s
->socket_protocol
== IPPROTO_UDPLITE
)
1654 p
->address
.protocol
= s
->socket_protocol
;
1658 p
->fd
= socket_address_listen_in_cgroup(s
, &p
->address
, label
);
1662 socket_apply_socket_options(s
, p
, p
->fd
);
1666 case SOCKET_SPECIAL
:
1668 p
->fd
= special_address_create(p
->path
, s
->writable
);
1670 return log_unit_error_errno(UNIT(s
), p
->fd
, "Failed to open special file %s: %m", p
->path
);
1675 p
->fd
= fifo_address_create(
1680 return log_unit_error_errno(UNIT(s
), p
->fd
, "Failed to open FIFO %s: %m", p
->path
);
1682 socket_apply_fifo_options(s
, p
->fd
);
1688 p
->fd
= mq_address_create(
1694 return log_unit_error_errno(UNIT(s
), p
->fd
, "Failed to open message queue %s: %m", p
->path
);
1697 case SOCKET_USB_FUNCTION
: {
1698 _cleanup_free_
char *ep
= NULL
;
1700 ep
= path_make_absolute("ep0", p
->path
);
1702 p
->fd
= usbffs_address_create(ep
);
1706 r
= usbffs_write_descs(p
->fd
, SERVICE(UNIT_DEREF(s
->service
)));
1710 r
= usbffs_dispatch_eps(p
);
1717 assert_not_reached("Unknown port type");
1725 static void socket_unwatch_fds(Socket
*s
) {
1731 LIST_FOREACH(port
, p
, s
->ports
) {
1735 if (!p
->event_source
)
1738 r
= sd_event_source_set_enabled(p
->event_source
, SD_EVENT_OFF
);
1740 log_unit_debug_errno(UNIT(s
), r
, "Failed to disable event source: %m");
1744 static int socket_watch_fds(Socket
*s
) {
1750 LIST_FOREACH(port
, p
, s
->ports
) {
1754 if (p
->event_source
) {
1755 r
= sd_event_source_set_enabled(p
->event_source
, SD_EVENT_ON
);
1759 r
= sd_event_add_io(UNIT(s
)->manager
->event
, &p
->event_source
, p
->fd
, EPOLLIN
, socket_dispatch_io
, p
);
1763 (void) sd_event_source_set_description(p
->event_source
, "socket-port-io");
1770 log_unit_warning_errno(UNIT(s
), r
, "Failed to watch listening fds: %m");
1771 socket_unwatch_fds(s
);
1781 static int socket_check_open(Socket
*s
) {
1782 bool have_open
= false, have_closed
= false;
1787 LIST_FOREACH(port
, p
, s
->ports
) {
1793 if (have_open
&& have_closed
)
1794 return SOCKET_OPEN_SOME
;
1798 return SOCKET_OPEN_ALL
;
1800 return SOCKET_OPEN_NONE
;
1803 static void socket_set_state(Socket
*s
, SocketState state
) {
1804 SocketState old_state
;
1807 if (s
->state
!= state
)
1808 bus_unit_send_pending_change_signal(UNIT(s
), false);
1810 old_state
= s
->state
;
1818 SOCKET_STOP_PRE_SIGTERM
,
1819 SOCKET_STOP_PRE_SIGKILL
,
1821 SOCKET_FINAL_SIGTERM
,
1822 SOCKET_FINAL_SIGKILL
,
1825 s
->timer_event_source
= sd_event_source_unref(s
->timer_event_source
);
1826 socket_unwatch_control_pid(s
);
1827 s
->control_command
= NULL
;
1828 s
->control_command_id
= _SOCKET_EXEC_COMMAND_INVALID
;
1831 if (state
!= SOCKET_LISTENING
)
1832 socket_unwatch_fds(s
);
1840 SOCKET_STOP_PRE_SIGTERM
,
1841 SOCKET_STOP_PRE_SIGKILL
,
1843 socket_close_fds(s
);
1845 if (state
!= old_state
)
1846 log_unit_debug(UNIT(s
), "Changed %s -> %s", socket_state_to_string(old_state
), socket_state_to_string(state
));
1848 unit_notify(UNIT(s
), state_translation_table
[old_state
], state_translation_table
[state
], 0);
1851 static int socket_coldplug(Unit
*u
) {
1852 Socket
*s
= SOCKET(u
);
1856 assert(s
->state
== SOCKET_DEAD
);
1858 if (s
->deserialized_state
== s
->state
)
1861 if (s
->control_pid
> 0 &&
1862 pid_is_unwaited(s
->control_pid
) &&
1863 IN_SET(s
->deserialized_state
,
1868 SOCKET_STOP_PRE_SIGTERM
,
1869 SOCKET_STOP_PRE_SIGKILL
,
1871 SOCKET_FINAL_SIGTERM
,
1872 SOCKET_FINAL_SIGKILL
,
1875 r
= unit_watch_pid(UNIT(s
), s
->control_pid
, false);
1879 r
= socket_arm_timer(s
, usec_add(u
->state_change_timestamp
.monotonic
, s
->timeout_usec
));
1884 if (IN_SET(s
->deserialized_state
,
1890 /* Originally, we used to simply reopen all sockets here that we didn't have file descriptors
1891 * for. However, this is problematic, as we won't traverse through the SOCKET_START_CHOWN state for
1892 * them, and thus the UID/GID wouldn't be right. Hence, instead simply check if we have all fds open,
1893 * and if there's a mismatch, warn loudly. */
1895 r
= socket_check_open(s
);
1896 if (r
== SOCKET_OPEN_NONE
)
1897 log_unit_warning(UNIT(s
),
1898 "Socket unit configuration has changed while unit has been running, "
1899 "no open socket file descriptor left. "
1900 "The socket unit is not functional until restarted.");
1901 else if (r
== SOCKET_OPEN_SOME
)
1902 log_unit_warning(UNIT(s
),
1903 "Socket unit configuration has changed while unit has been running, "
1904 "and some socket file descriptors have not been opened yet. "
1905 "The socket unit is not fully functional until restarted.");
1908 if (s
->deserialized_state
== SOCKET_LISTENING
) {
1909 r
= socket_watch_fds(s
);
1914 if (!IN_SET(s
->deserialized_state
, SOCKET_DEAD
, SOCKET_FAILED
, SOCKET_CLEANING
)) {
1915 (void) unit_setup_dynamic_creds(u
);
1916 (void) unit_setup_exec_runtime(u
);
1919 socket_set_state(s
, s
->deserialized_state
);
1923 static int socket_spawn(Socket
*s
, ExecCommand
*c
, pid_t
*_pid
) {
1925 _cleanup_(exec_params_clear
) ExecParameters exec_params
= {
1926 .flags
= EXEC_APPLY_SANDBOXING
|EXEC_APPLY_CHROOT
|EXEC_APPLY_TTY_STDIN
,
1939 r
= unit_prepare_exec(UNIT(s
));
1943 r
= socket_arm_timer(s
, usec_add(now(CLOCK_MONOTONIC
), s
->timeout_usec
));
1947 r
= unit_set_exec_params(UNIT(s
), &exec_params
);
1951 r
= exec_spawn(UNIT(s
),
1961 r
= unit_watch_pid(UNIT(s
), pid
, true);
1970 static int socket_chown(Socket
*s
, pid_t
*_pid
) {
1974 r
= socket_arm_timer(s
, usec_add(now(CLOCK_MONOTONIC
), s
->timeout_usec
));
1978 /* We have to resolve the user names out-of-process, hence
1979 * let's fork here. It's messy, but well, what can we do? */
1981 r
= unit_fork_helper_process(UNIT(s
), "(sd-chown)", &pid
);
1985 uid_t uid
= UID_INVALID
;
1986 gid_t gid
= GID_INVALID
;
1991 if (!isempty(s
->user
)) {
1992 const char *user
= s
->user
;
1994 r
= get_user_creds(&user
, &uid
, &gid
, NULL
, NULL
, 0);
1996 log_unit_error_errno(UNIT(s
), r
, "Failed to resolve user %s: %m", user
);
2001 if (!isempty(s
->group
)) {
2002 const char *group
= s
->group
;
2004 r
= get_group_creds(&group
, &gid
, 0);
2006 log_unit_error_errno(UNIT(s
), r
, "Failed to resolve group %s: %m", group
);
2011 LIST_FOREACH(port
, p
, s
->ports
) {
2012 const char *path
= NULL
;
2014 if (p
->type
== SOCKET_SOCKET
)
2015 path
= socket_address_get_path(&p
->address
);
2016 else if (p
->type
== SOCKET_FIFO
)
2022 if (chown(path
, uid
, gid
) < 0) {
2023 log_unit_error_errno(UNIT(s
), errno
, "Failed to chown(): %m");
2028 _exit(EXIT_SUCCESS
);
2031 r
= unit_watch_pid(UNIT(s
), pid
, true);
2039 s
->timer_event_source
= sd_event_source_unref(s
->timer_event_source
);
2043 static void socket_enter_dead(Socket
*s
, SocketResult f
) {
2046 if (s
->result
== SOCKET_SUCCESS
)
2049 if (s
->result
== SOCKET_SUCCESS
)
2050 unit_log_success(UNIT(s
));
2052 unit_log_failure(UNIT(s
), socket_result_to_string(s
->result
));
2054 unit_warn_leftover_processes(UNIT(s
), unit_log_leftover_process_stop
);
2056 socket_set_state(s
, s
->result
!= SOCKET_SUCCESS
? SOCKET_FAILED
: SOCKET_DEAD
);
2058 s
->exec_runtime
= exec_runtime_unref(s
->exec_runtime
, true);
2060 unit_destroy_runtime_data(UNIT(s
), &s
->exec_context
);
2062 unit_unref_uid_gid(UNIT(s
), true);
2064 dynamic_creds_destroy(&s
->dynamic_creds
);
2067 static void socket_enter_signal(Socket
*s
, SocketState state
, SocketResult f
);
2069 static void socket_enter_stop_post(Socket
*s
, SocketResult f
) {
2073 if (s
->result
== SOCKET_SUCCESS
)
2076 socket_unwatch_control_pid(s
);
2077 s
->control_command_id
= SOCKET_EXEC_STOP_POST
;
2078 s
->control_command
= s
->exec_command
[SOCKET_EXEC_STOP_POST
];
2080 if (s
->control_command
) {
2081 r
= socket_spawn(s
, s
->control_command
, &s
->control_pid
);
2085 socket_set_state(s
, SOCKET_STOP_POST
);
2087 socket_enter_signal(s
, SOCKET_FINAL_SIGTERM
, SOCKET_SUCCESS
);
2092 log_unit_warning_errno(UNIT(s
), r
, "Failed to run 'stop-post' task: %m");
2093 socket_enter_signal(s
, SOCKET_FINAL_SIGTERM
, SOCKET_FAILURE_RESOURCES
);
2096 static int state_to_kill_operation(Socket
*s
, SocketState state
) {
2097 if (state
== SOCKET_STOP_PRE_SIGTERM
&& unit_has_job_type(UNIT(s
), JOB_RESTART
))
2098 return KILL_RESTART
;
2100 if (state
== SOCKET_FINAL_SIGTERM
)
2101 return KILL_TERMINATE
;
2106 static void socket_enter_signal(Socket
*s
, SocketState state
, SocketResult f
) {
2111 if (s
->result
== SOCKET_SUCCESS
)
2114 r
= unit_kill_context(
2117 state_to_kill_operation(s
, state
),
2125 r
= socket_arm_timer(s
, usec_add(now(CLOCK_MONOTONIC
), s
->timeout_usec
));
2129 socket_set_state(s
, state
);
2130 } else if (state
== SOCKET_STOP_PRE_SIGTERM
)
2131 socket_enter_signal(s
, SOCKET_STOP_PRE_SIGKILL
, SOCKET_SUCCESS
);
2132 else if (state
== SOCKET_STOP_PRE_SIGKILL
)
2133 socket_enter_stop_post(s
, SOCKET_SUCCESS
);
2134 else if (state
== SOCKET_FINAL_SIGTERM
)
2135 socket_enter_signal(s
, SOCKET_FINAL_SIGKILL
, SOCKET_SUCCESS
);
2137 socket_enter_dead(s
, SOCKET_SUCCESS
);
2142 log_unit_warning_errno(UNIT(s
), r
, "Failed to kill processes: %m");
2144 if (IN_SET(state
, SOCKET_STOP_PRE_SIGTERM
, SOCKET_STOP_PRE_SIGKILL
))
2145 socket_enter_stop_post(s
, SOCKET_FAILURE_RESOURCES
);
2147 socket_enter_dead(s
, SOCKET_FAILURE_RESOURCES
);
2150 static void socket_enter_stop_pre(Socket
*s
, SocketResult f
) {
2154 if (s
->result
== SOCKET_SUCCESS
)
2157 socket_unwatch_control_pid(s
);
2158 s
->control_command_id
= SOCKET_EXEC_STOP_PRE
;
2159 s
->control_command
= s
->exec_command
[SOCKET_EXEC_STOP_PRE
];
2161 if (s
->control_command
) {
2162 r
= socket_spawn(s
, s
->control_command
, &s
->control_pid
);
2166 socket_set_state(s
, SOCKET_STOP_PRE
);
2168 socket_enter_stop_post(s
, SOCKET_SUCCESS
);
2173 log_unit_warning_errno(UNIT(s
), r
, "Failed to run 'stop-pre' task: %m");
2174 socket_enter_stop_post(s
, SOCKET_FAILURE_RESOURCES
);
2177 static void socket_enter_listening(Socket
*s
) {
2181 if (!s
->accept
&& s
->flush_pending
) {
2182 log_unit_debug(UNIT(s
), "Flushing socket before listening.");
2186 r
= socket_watch_fds(s
);
2188 log_unit_warning_errno(UNIT(s
), r
, "Failed to watch sockets: %m");
2192 socket_set_state(s
, SOCKET_LISTENING
);
2196 socket_enter_stop_pre(s
, SOCKET_FAILURE_RESOURCES
);
2199 static void socket_enter_start_post(Socket
*s
) {
2203 socket_unwatch_control_pid(s
);
2204 s
->control_command_id
= SOCKET_EXEC_START_POST
;
2205 s
->control_command
= s
->exec_command
[SOCKET_EXEC_START_POST
];
2207 if (s
->control_command
) {
2208 r
= socket_spawn(s
, s
->control_command
, &s
->control_pid
);
2210 log_unit_warning_errno(UNIT(s
), r
, "Failed to run 'start-post' task: %m");
2214 socket_set_state(s
, SOCKET_START_POST
);
2216 socket_enter_listening(s
);
2221 socket_enter_stop_pre(s
, SOCKET_FAILURE_RESOURCES
);
2224 static void socket_enter_start_chown(Socket
*s
) {
2229 r
= socket_open_fds(s
);
2231 log_unit_warning_errno(UNIT(s
), r
, "Failed to listen on sockets: %m");
2235 if (!isempty(s
->user
) || !isempty(s
->group
)) {
2237 socket_unwatch_control_pid(s
);
2238 s
->control_command_id
= SOCKET_EXEC_START_CHOWN
;
2239 s
->control_command
= NULL
;
2241 r
= socket_chown(s
, &s
->control_pid
);
2243 log_unit_warning_errno(UNIT(s
), r
, "Failed to fork 'start-chown' task: %m");
2247 socket_set_state(s
, SOCKET_START_CHOWN
);
2249 socket_enter_start_post(s
);
2254 socket_enter_stop_pre(s
, SOCKET_FAILURE_RESOURCES
);
2257 static void socket_enter_start_pre(Socket
*s
) {
2261 socket_unwatch_control_pid(s
);
2263 unit_warn_leftover_processes(UNIT(s
), unit_log_leftover_process_start
);
2265 s
->control_command_id
= SOCKET_EXEC_START_PRE
;
2266 s
->control_command
= s
->exec_command
[SOCKET_EXEC_START_PRE
];
2268 if (s
->control_command
) {
2269 r
= socket_spawn(s
, s
->control_command
, &s
->control_pid
);
2271 log_unit_warning_errno(UNIT(s
), r
, "Failed to run 'start-pre' task: %m");
2275 socket_set_state(s
, SOCKET_START_PRE
);
2277 socket_enter_start_chown(s
);
2282 socket_enter_dead(s
, SOCKET_FAILURE_RESOURCES
);
2285 static void flush_ports(Socket
*s
) {
2288 /* Flush all incoming traffic, regardless if actual bytes or new connections, so that this socket isn't busy
2291 LIST_FOREACH(port
, p
, s
->ports
) {
2295 (void) flush_accept(p
->fd
);
2296 (void) flush_fd(p
->fd
);
2300 static void socket_enter_running(Socket
*s
, int cfd_in
) {
2301 /* Note that this call takes possession of the connection fd passed. It either has to assign it
2302 * somewhere or close it. */
2303 _cleanup_close_
int cfd
= cfd_in
;
2305 _cleanup_(sd_bus_error_free
) sd_bus_error error
= SD_BUS_ERROR_NULL
;
2310 /* We don't take connections anymore if we are supposed to shut down anyway */
2311 if (unit_stop_pending(UNIT(s
))) {
2313 log_unit_debug(UNIT(s
), "Suppressing connection request since unit stop is scheduled.");
2322 if (!ratelimit_below(&s
->trigger_limit
)) {
2323 log_unit_warning(UNIT(s
), "Trigger limit hit, refusing further activation.");
2324 socket_enter_stop_pre(s
, SOCKET_FAILURE_TRIGGER_LIMIT_HIT
);
2329 bool pending
= false;
2333 /* If there's already a start pending don't bother to
2335 HASHMAP_FOREACH_KEY(v
, other
, UNIT(s
)->dependencies
[UNIT_TRIGGERS
])
2336 if (unit_active_or_pending(other
)) {
2342 if (!UNIT_ISSET(s
->service
)) {
2343 r
= log_unit_error_errno(UNIT(s
), SYNTHETIC_ERRNO(ENOENT
),
2344 "Service to activate vanished, refusing activation.");
2348 r
= manager_add_job(UNIT(s
)->manager
, JOB_START
, UNIT_DEREF(s
->service
), JOB_REPLACE
, NULL
, &error
, NULL
);
2353 socket_set_state(s
, SOCKET_RUNNING
);
2355 _cleanup_(socket_peer_unrefp
) SocketPeer
*p
= NULL
;
2358 if (s
->n_connections
>= s
->max_connections
) {
2359 log_unit_warning(UNIT(s
), "Too many incoming connections (%u), dropping connection.",
2364 if (s
->max_connections_per_source
> 0) {
2365 r
= socket_acquire_peer(s
, cfd
, &p
);
2366 if (ERRNO_IS_DISCONNECT(r
))
2368 if (r
< 0) /* We didn't have enough resources to acquire peer information, let's fail. */
2370 if (r
> 0 && p
->n_ref
> s
->max_connections_per_source
) {
2371 _cleanup_free_
char *t
= NULL
;
2373 (void) sockaddr_pretty(&p
->peer
.sa
, p
->peer_salen
, true, false, &t
);
2375 log_unit_warning(UNIT(s
),
2376 "Too many incoming connections (%u) from source %s, dropping connection.",
2377 p
->n_ref
, strnull(t
));
2382 r
= socket_load_service_unit(s
, cfd
, &service
);
2383 if (ERRNO_IS_DISCONNECT(r
))
2388 r
= unit_add_two_dependencies(UNIT(s
), UNIT_BEFORE
, UNIT_TRIGGERS
, service
,
2389 false, UNIT_DEPENDENCY_IMPLICIT
);
2395 r
= service_set_socket_fd(SERVICE(service
), cfd
, s
, s
->selinux_context_from_net
);
2396 if (ERRNO_IS_DISCONNECT(r
))
2401 TAKE_FD(cfd
); /* We passed ownership of the fd to the service now. Forget it here. */
2404 SERVICE(service
)->peer
= TAKE_PTR(p
); /* Pass ownership of the peer reference */
2406 r
= manager_add_job(UNIT(s
)->manager
, JOB_START
, service
, JOB_REPLACE
, NULL
, &error
, NULL
);
2408 /* We failed to activate the new service, but it still exists. Let's make sure the
2409 * service closes and forgets the connection fd again, immediately. */
2410 service_close_socket_fd(SERVICE(service
));
2414 /* Notify clients about changed counters */
2415 unit_add_to_dbus_queue(UNIT(s
));
2426 if (ERRNO_IS_RESOURCE(r
))
2427 log_unit_warning(UNIT(s
), "Failed to queue service startup job: %s",
2428 bus_error_message(&error
, r
));
2430 log_unit_warning(UNIT(s
), "Failed to queue service startup job (Maybe the service file is missing or not a %s unit?): %s",
2431 cfd
>= 0 ? "template" : "non-template",
2432 bus_error_message(&error
, r
));
2434 socket_enter_stop_pre(s
, SOCKET_FAILURE_RESOURCES
);
2437 static void socket_run_next(Socket
*s
) {
2441 assert(s
->control_command
);
2442 assert(s
->control_command
->command_next
);
2444 socket_unwatch_control_pid(s
);
2446 s
->control_command
= s
->control_command
->command_next
;
2448 r
= socket_spawn(s
, s
->control_command
, &s
->control_pid
);
2455 log_unit_warning_errno(UNIT(s
), r
, "Failed to run next task: %m");
2457 if (s
->state
== SOCKET_START_POST
)
2458 socket_enter_stop_pre(s
, SOCKET_FAILURE_RESOURCES
);
2459 else if (s
->state
== SOCKET_STOP_POST
)
2460 socket_enter_dead(s
, SOCKET_FAILURE_RESOURCES
);
2462 socket_enter_signal(s
, SOCKET_FINAL_SIGTERM
, SOCKET_FAILURE_RESOURCES
);
2465 static int socket_start(Unit
*u
) {
2466 Socket
*s
= SOCKET(u
);
2471 /* We cannot fulfill this request right now, try again later
2473 if (IN_SET(s
->state
,
2475 SOCKET_STOP_PRE_SIGKILL
,
2476 SOCKET_STOP_PRE_SIGTERM
,
2478 SOCKET_FINAL_SIGTERM
,
2479 SOCKET_FINAL_SIGKILL
,
2483 /* Already on it! */
2484 if (IN_SET(s
->state
,
2490 /* Cannot run this without the service being around */
2491 if (UNIT_ISSET(s
->service
)) {
2494 service
= SERVICE(UNIT_DEREF(s
->service
));
2496 if (UNIT(service
)->load_state
!= UNIT_LOADED
) {
2497 log_unit_error(u
, "Socket service %s not loaded, refusing.", UNIT(service
)->id
);
2501 /* If the service is already active we cannot start the
2503 if (!IN_SET(service
->state
, SERVICE_DEAD
, SERVICE_FAILED
, SERVICE_AUTO_RESTART
)) {
2504 log_unit_error(u
, "Socket service %s already active, refusing.", UNIT(service
)->id
);
2509 assert(IN_SET(s
->state
, SOCKET_DEAD
, SOCKET_FAILED
));
2511 r
= unit_test_start_limit(u
);
2513 socket_enter_dead(s
, SOCKET_FAILURE_START_LIMIT_HIT
);
2517 r
= unit_acquire_invocation_id(u
);
2521 s
->result
= SOCKET_SUCCESS
;
2522 exec_command_reset_status_list_array(s
->exec_command
, _SOCKET_EXEC_COMMAND_MAX
);
2524 u
->reset_accounting
= true;
2526 socket_enter_start_pre(s
);
2530 static int socket_stop(Unit
*u
) {
2531 Socket
*s
= SOCKET(u
);
2536 if (IN_SET(s
->state
,
2538 SOCKET_STOP_PRE_SIGTERM
,
2539 SOCKET_STOP_PRE_SIGKILL
,
2541 SOCKET_FINAL_SIGTERM
,
2542 SOCKET_FINAL_SIGKILL
))
2545 /* If there's already something running we go directly into
2547 if (IN_SET(s
->state
,
2550 SOCKET_START_POST
)) {
2551 socket_enter_signal(s
, SOCKET_STOP_PRE_SIGTERM
, SOCKET_SUCCESS
);
2555 /* If we are currently cleaning, then abort it, brutally. */
2556 if (s
->state
== SOCKET_CLEANING
) {
2557 socket_enter_signal(s
, SOCKET_FINAL_SIGKILL
, SOCKET_SUCCESS
);
2561 assert(IN_SET(s
->state
, SOCKET_LISTENING
, SOCKET_RUNNING
));
2563 socket_enter_stop_pre(s
, SOCKET_SUCCESS
);
2567 static int socket_serialize(Unit
*u
, FILE *f
, FDSet
*fds
) {
2568 Socket
*s
= SOCKET(u
);
2576 (void) serialize_item(f
, "state", socket_state_to_string(s
->state
));
2577 (void) serialize_item(f
, "result", socket_result_to_string(s
->result
));
2578 (void) serialize_item_format(f
, "n-accepted", "%u", s
->n_accepted
);
2579 (void) serialize_item_format(f
, "n-refused", "%u", s
->n_refused
);
2581 if (s
->control_pid
> 0)
2582 (void) serialize_item_format(f
, "control-pid", PID_FMT
, s
->control_pid
);
2584 if (s
->control_command_id
>= 0)
2585 (void) serialize_item(f
, "control-command", socket_exec_command_to_string(s
->control_command_id
));
2587 LIST_FOREACH(port
, p
, s
->ports
) {
2593 copy
= fdset_put_dup(fds
, p
->fd
);
2595 return log_unit_warning_errno(u
, copy
, "Failed to serialize socket fd: %m");
2597 if (p
->type
== SOCKET_SOCKET
) {
2598 _cleanup_free_
char *t
= NULL
;
2600 r
= socket_address_print(&p
->address
, &t
);
2602 return log_unit_error_errno(u
, r
, "Failed to format socket address: %m");
2604 if (socket_address_family(&p
->address
) == AF_NETLINK
)
2605 (void) serialize_item_format(f
, "netlink", "%i %s", copy
, t
);
2607 (void) serialize_item_format(f
, "socket", "%i %i %s", copy
, p
->address
.type
, t
);
2608 } else if (p
->type
== SOCKET_SPECIAL
)
2609 (void) serialize_item_format(f
, "special", "%i %s", copy
, p
->path
);
2610 else if (p
->type
== SOCKET_MQUEUE
)
2611 (void) serialize_item_format(f
, "mqueue", "%i %s", copy
, p
->path
);
2612 else if (p
->type
== SOCKET_USB_FUNCTION
)
2613 (void) serialize_item_format(f
, "ffs", "%i %s", copy
, p
->path
);
2615 assert(p
->type
== SOCKET_FIFO
);
2616 (void) serialize_item_format(f
, "fifo", "%i %s", copy
, p
->path
);
2623 static void socket_port_take_fd(SocketPort
*p
, FDSet
*fds
, int fd
) {
2627 p
->fd
= fdset_remove(fds
, fd
);
2630 static int socket_deserialize_item(Unit
*u
, const char *key
, const char *value
, FDSet
*fds
) {
2631 Socket
*s
= SOCKET(u
);
2637 if (streq(key
, "state")) {
2640 state
= socket_state_from_string(value
);
2642 log_unit_debug(u
, "Failed to parse state value: %s", value
);
2644 s
->deserialized_state
= state
;
2645 } else if (streq(key
, "result")) {
2648 f
= socket_result_from_string(value
);
2650 log_unit_debug(u
, "Failed to parse result value: %s", value
);
2651 else if (f
!= SOCKET_SUCCESS
)
2654 } else if (streq(key
, "n-accepted")) {
2657 if (safe_atou(value
, &k
) < 0)
2658 log_unit_debug(u
, "Failed to parse n-accepted value: %s", value
);
2661 } else if (streq(key
, "n-refused")) {
2664 if (safe_atou(value
, &k
) < 0)
2665 log_unit_debug(u
, "Failed to parse n-refused value: %s", value
);
2668 } else if (streq(key
, "control-pid")) {
2671 if (parse_pid(value
, &pid
) < 0)
2672 log_unit_debug(u
, "Failed to parse control-pid value: %s", value
);
2674 s
->control_pid
= pid
;
2675 } else if (streq(key
, "control-command")) {
2676 SocketExecCommand id
;
2678 id
= socket_exec_command_from_string(value
);
2680 log_unit_debug(u
, "Failed to parse exec-command value: %s", value
);
2682 s
->control_command_id
= id
;
2683 s
->control_command
= s
->exec_command
[id
];
2685 } else if (streq(key
, "fifo")) {
2689 if (sscanf(value
, "%i %n", &fd
, &skip
) < 1 || fd
< 0 || !fdset_contains(fds
, fd
))
2690 log_unit_debug(u
, "Failed to parse fifo value: %s", value
);
2692 LIST_FOREACH(port
, p
, s
->ports
)
2693 if (p
->type
== SOCKET_FIFO
&&
2694 path_equal_or_files_same(p
->path
, value
+skip
, 0)) {
2695 socket_port_take_fd(p
, fds
, fd
);
2699 } else if (streq(key
, "special")) {
2703 if (sscanf(value
, "%i %n", &fd
, &skip
) < 1 || fd
< 0 || !fdset_contains(fds
, fd
))
2704 log_unit_debug(u
, "Failed to parse special value: %s", value
);
2706 LIST_FOREACH(port
, p
, s
->ports
)
2707 if (p
->type
== SOCKET_SPECIAL
&&
2708 path_equal_or_files_same(p
->path
, value
+skip
, 0)) {
2709 socket_port_take_fd(p
, fds
, fd
);
2713 } else if (streq(key
, "mqueue")) {
2717 if (sscanf(value
, "%i %n", &fd
, &skip
) < 1 || fd
< 0 || !fdset_contains(fds
, fd
))
2718 log_unit_debug(u
, "Failed to parse mqueue value: %s", value
);
2720 LIST_FOREACH(port
, p
, s
->ports
)
2721 if (p
->type
== SOCKET_MQUEUE
&&
2722 streq(p
->path
, value
+skip
)) {
2723 socket_port_take_fd(p
, fds
, fd
);
2727 } else if (streq(key
, "socket")) {
2728 int fd
, type
, skip
= 0;
2731 if (sscanf(value
, "%i %i %n", &fd
, &type
, &skip
) < 2 || fd
< 0 || type
< 0 || !fdset_contains(fds
, fd
))
2732 log_unit_debug(u
, "Failed to parse socket value: %s", value
);
2734 LIST_FOREACH(port
, p
, s
->ports
)
2735 if (socket_address_is(&p
->address
, value
+skip
, type
)) {
2736 socket_port_take_fd(p
, fds
, fd
);
2740 } else if (streq(key
, "netlink")) {
2744 if (sscanf(value
, "%i %n", &fd
, &skip
) < 1 || fd
< 0 || !fdset_contains(fds
, fd
))
2745 log_unit_debug(u
, "Failed to parse socket value: %s", value
);
2747 LIST_FOREACH(port
, p
, s
->ports
)
2748 if (socket_address_is_netlink(&p
->address
, value
+skip
)) {
2749 socket_port_take_fd(p
, fds
, fd
);
2753 } else if (streq(key
, "ffs")) {
2757 if (sscanf(value
, "%i %n", &fd
, &skip
) < 1 || fd
< 0 || !fdset_contains(fds
, fd
))
2758 log_unit_debug(u
, "Failed to parse ffs value: %s", value
);
2760 LIST_FOREACH(port
, p
, s
->ports
)
2761 if (p
->type
== SOCKET_USB_FUNCTION
&&
2762 path_equal_or_files_same(p
->path
, value
+skip
, 0)) {
2763 socket_port_take_fd(p
, fds
, fd
);
2768 log_unit_debug(UNIT(s
), "Unknown serialization key: %s", key
);
2773 static void socket_distribute_fds(Unit
*u
, FDSet
*fds
) {
2774 Socket
*s
= SOCKET(u
);
2779 LIST_FOREACH(port
, p
, s
->ports
) {
2782 if (p
->type
!= SOCKET_SOCKET
)
2788 FDSET_FOREACH(fd
, fds
) {
2789 if (socket_address_matches_fd(&p
->address
, fd
)) {
2790 p
->fd
= fdset_remove(fds
, fd
);
2791 s
->deserialized_state
= SOCKET_LISTENING
;
2798 _pure_
static UnitActiveState
socket_active_state(Unit
*u
) {
2801 return state_translation_table
[SOCKET(u
)->state
];
2804 _pure_
static const char *socket_sub_state_to_string(Unit
*u
) {
2807 return socket_state_to_string(SOCKET(u
)->state
);
2810 const char* socket_port_type_to_string(SocketPort
*p
) {
2818 switch (p
->address
.type
) {
2826 case SOCK_SEQPACKET
:
2827 return "SequentialPacket";
2830 if (socket_address_family(&p
->address
) == AF_NETLINK
)
2838 case SOCKET_SPECIAL
:
2842 return "MessageQueue";
2847 case SOCKET_USB_FUNCTION
:
2848 return "USBFunction";
2855 SocketType
socket_port_type_from_string(const char *s
) {
2858 if (STR_IN_SET(s
, "Stream", "Datagram", "SequentialPacket", "Netlink"))
2859 return SOCKET_SOCKET
;
2860 else if (streq(s
, "Special"))
2861 return SOCKET_SPECIAL
;
2862 else if (streq(s
, "MessageQueue"))
2863 return SOCKET_MQUEUE
;
2864 else if (streq(s
, "FIFO"))
2866 else if (streq(s
, "USBFunction"))
2867 return SOCKET_USB_FUNCTION
;
2869 return _SOCKET_TYPE_INVALID
;
2872 _pure_
static bool socket_may_gc(Unit
*u
) {
2873 Socket
*s
= SOCKET(u
);
2877 return s
->n_connections
== 0;
2880 static int socket_accept_do(Socket
*s
, int fd
) {
2886 cfd
= accept4(fd
, NULL
, NULL
, SOCK_NONBLOCK
|SOCK_CLOEXEC
);
2888 /* Convert transient network errors into clean and well-defined EAGAIN */
2889 return ERRNO_IS_ACCEPT_AGAIN(errno
) ? -EAGAIN
: -errno
;
2894 static int socket_accept_in_cgroup(Socket
*s
, SocketPort
*p
, int fd
) {
2895 _cleanup_close_pair_
int pair
[2] = { -1, -1 };
2903 /* Similar to socket_address_listen_in_cgroup(), but for accept() rather than socket(): make sure that any
2904 * connection socket is also properly associated with the cgroup. */
2906 if (!IN_SET(p
->address
.sockaddr
.sa
.sa_family
, AF_INET
, AF_INET6
))
2909 r
= bpf_firewall_supported();
2912 if (r
== BPF_FIREWALL_UNSUPPORTED
)
2915 if (socketpair(AF_UNIX
, SOCK_SEQPACKET
|SOCK_CLOEXEC
, 0, pair
) < 0)
2916 return log_unit_error_errno(UNIT(s
), errno
, "Failed to create communication channel: %m");
2918 r
= unit_fork_helper_process(UNIT(s
), "(sd-accept)", &pid
);
2920 return log_unit_error_errno(UNIT(s
), r
, "Failed to fork off accept stub process: %m");
2924 pair
[0] = safe_close(pair
[0]);
2926 cfd
= socket_accept_do(s
, fd
);
2927 if (cfd
== -EAGAIN
) /* spurious accept() */
2928 _exit(EXIT_SUCCESS
);
2930 log_unit_error_errno(UNIT(s
), cfd
, "Failed to accept connection socket: %m");
2931 _exit(EXIT_FAILURE
);
2934 r
= send_one_fd(pair
[1], cfd
, 0);
2936 log_unit_error_errno(UNIT(s
), r
, "Failed to send connection socket to parent: %m");
2937 _exit(EXIT_FAILURE
);
2940 _exit(EXIT_SUCCESS
);
2943 pair
[1] = safe_close(pair
[1]);
2944 cfd
= receive_one_fd(pair
[0], 0);
2946 /* We synchronously wait for the helper, as it shouldn't be slow */
2947 r
= wait_for_terminate_and_check("(sd-accept)", pid
, WAIT_LOG_ABNORMAL
);
2953 /* If we received no fd, we got EIO here. If this happens with a process exit code of EXIT_SUCCESS
2954 * this is a spurious accept(), let's convert that back to EAGAIN here. */
2958 return log_unit_error_errno(UNIT(s
), cfd
, "Failed to receive connection socket: %m");
2963 cfd
= socket_accept_do(s
, fd
);
2964 if (cfd
== -EAGAIN
) /* spurious accept(), skip it silently */
2967 return log_unit_error_errno(UNIT(s
), cfd
, "Failed to accept connection socket: %m");
2972 static int socket_dispatch_io(sd_event_source
*source
, int fd
, uint32_t revents
, void *userdata
) {
2973 SocketPort
*p
= userdata
;
2979 if (p
->socket
->state
!= SOCKET_LISTENING
)
2982 log_unit_debug(UNIT(p
->socket
), "Incoming traffic");
2984 if (revents
!= EPOLLIN
) {
2985 if (revents
& EPOLLHUP
)
2986 log_unit_error(UNIT(p
->socket
), "Got POLLHUP on a listening socket. The service probably invoked shutdown() on it, and should better not do that.");
2988 log_unit_error(UNIT(p
->socket
), "Got unexpected poll event (0x%x) on socket.", revents
);
2992 if (p
->socket
->accept
&&
2993 p
->type
== SOCKET_SOCKET
&&
2994 socket_address_can_accept(&p
->address
)) {
2996 cfd
= socket_accept_in_cgroup(p
->socket
, p
, fd
);
2997 if (cfd
== -EAGAIN
) /* Spurious accept() */
3002 socket_apply_socket_options(p
->socket
, p
, cfd
);
3005 socket_enter_running(p
->socket
, cfd
);
3009 socket_enter_stop_pre(p
->socket
, SOCKET_FAILURE_RESOURCES
);
3013 static void socket_sigchld_event(Unit
*u
, pid_t pid
, int code
, int status
) {
3014 Socket
*s
= SOCKET(u
);
3020 if (pid
!= s
->control_pid
)
3025 if (is_clean_exit(code
, status
, EXIT_CLEAN_COMMAND
, NULL
))
3027 else if (code
== CLD_EXITED
)
3028 f
= SOCKET_FAILURE_EXIT_CODE
;
3029 else if (code
== CLD_KILLED
)
3030 f
= SOCKET_FAILURE_SIGNAL
;
3031 else if (code
== CLD_DUMPED
)
3032 f
= SOCKET_FAILURE_CORE_DUMP
;
3034 assert_not_reached("Unknown sigchld code");
3036 if (s
->control_command
) {
3037 exec_status_exit(&s
->control_command
->exec_status
, &s
->exec_context
, pid
, code
, status
);
3039 if (s
->control_command
->flags
& EXEC_COMMAND_IGNORE_FAILURE
)
3043 unit_log_process_exit(
3046 socket_exec_command_to_string(s
->control_command_id
),
3047 f
== SOCKET_SUCCESS
,
3050 if (s
->result
== SOCKET_SUCCESS
)
3053 if (s
->control_command
&&
3054 s
->control_command
->command_next
&&
3055 f
== SOCKET_SUCCESS
) {
3057 log_unit_debug(u
, "Running next command for state %s", socket_state_to_string(s
->state
));
3060 s
->control_command
= NULL
;
3061 s
->control_command_id
= _SOCKET_EXEC_COMMAND_INVALID
;
3063 /* No further commands for this step, so let's figure
3064 * out what to do next */
3066 log_unit_debug(u
, "Got final SIGCHLD for state %s", socket_state_to_string(s
->state
));
3070 case SOCKET_START_PRE
:
3071 if (f
== SOCKET_SUCCESS
)
3072 socket_enter_start_chown(s
);
3074 socket_enter_signal(s
, SOCKET_FINAL_SIGTERM
, f
);
3077 case SOCKET_START_CHOWN
:
3078 if (f
== SOCKET_SUCCESS
)
3079 socket_enter_start_post(s
);
3081 socket_enter_stop_pre(s
, f
);
3084 case SOCKET_START_POST
:
3085 if (f
== SOCKET_SUCCESS
)
3086 socket_enter_listening(s
);
3088 socket_enter_stop_pre(s
, f
);
3091 case SOCKET_STOP_PRE
:
3092 case SOCKET_STOP_PRE_SIGTERM
:
3093 case SOCKET_STOP_PRE_SIGKILL
:
3094 socket_enter_stop_post(s
, f
);
3097 case SOCKET_STOP_POST
:
3098 case SOCKET_FINAL_SIGTERM
:
3099 case SOCKET_FINAL_SIGKILL
:
3100 socket_enter_dead(s
, f
);
3103 case SOCKET_CLEANING
:
3105 if (s
->clean_result
== SOCKET_SUCCESS
)
3106 s
->clean_result
= f
;
3108 socket_enter_dead(s
, SOCKET_SUCCESS
);
3112 assert_not_reached("Uh, control process died at wrong time.");
3116 /* Notify clients about changed exit status */
3117 unit_add_to_dbus_queue(u
);
3120 static int socket_dispatch_timer(sd_event_source
*source
, usec_t usec
, void *userdata
) {
3121 Socket
*s
= SOCKET(userdata
);
3124 assert(s
->timer_event_source
== source
);
3128 case SOCKET_START_PRE
:
3129 log_unit_warning(UNIT(s
), "Starting timed out. Terminating.");
3130 socket_enter_signal(s
, SOCKET_FINAL_SIGTERM
, SOCKET_FAILURE_TIMEOUT
);
3133 case SOCKET_START_CHOWN
:
3134 case SOCKET_START_POST
:
3135 log_unit_warning(UNIT(s
), "Starting timed out. Stopping.");
3136 socket_enter_stop_pre(s
, SOCKET_FAILURE_TIMEOUT
);
3139 case SOCKET_STOP_PRE
:
3140 log_unit_warning(UNIT(s
), "Stopping timed out. Terminating.");
3141 socket_enter_signal(s
, SOCKET_STOP_PRE_SIGTERM
, SOCKET_FAILURE_TIMEOUT
);
3144 case SOCKET_STOP_PRE_SIGTERM
:
3145 if (s
->kill_context
.send_sigkill
) {
3146 log_unit_warning(UNIT(s
), "Stopping timed out. Killing.");
3147 socket_enter_signal(s
, SOCKET_STOP_PRE_SIGKILL
, SOCKET_FAILURE_TIMEOUT
);
3149 log_unit_warning(UNIT(s
), "Stopping timed out. Skipping SIGKILL. Ignoring.");
3150 socket_enter_stop_post(s
, SOCKET_FAILURE_TIMEOUT
);
3154 case SOCKET_STOP_PRE_SIGKILL
:
3155 log_unit_warning(UNIT(s
), "Processes still around after SIGKILL. Ignoring.");
3156 socket_enter_stop_post(s
, SOCKET_FAILURE_TIMEOUT
);
3159 case SOCKET_STOP_POST
:
3160 log_unit_warning(UNIT(s
), "Stopping timed out (2). Terminating.");
3161 socket_enter_signal(s
, SOCKET_FINAL_SIGTERM
, SOCKET_FAILURE_TIMEOUT
);
3164 case SOCKET_FINAL_SIGTERM
:
3165 if (s
->kill_context
.send_sigkill
) {
3166 log_unit_warning(UNIT(s
), "Stopping timed out (2). Killing.");
3167 socket_enter_signal(s
, SOCKET_FINAL_SIGKILL
, SOCKET_FAILURE_TIMEOUT
);
3169 log_unit_warning(UNIT(s
), "Stopping timed out (2). Skipping SIGKILL. Ignoring.");
3170 socket_enter_dead(s
, SOCKET_FAILURE_TIMEOUT
);
3174 case SOCKET_FINAL_SIGKILL
:
3175 log_unit_warning(UNIT(s
), "Still around after SIGKILL (2). Entering failed mode.");
3176 socket_enter_dead(s
, SOCKET_FAILURE_TIMEOUT
);
3179 case SOCKET_CLEANING
:
3180 log_unit_warning(UNIT(s
), "Cleaning timed out. killing.");
3182 if (s
->clean_result
== SOCKET_SUCCESS
)
3183 s
->clean_result
= SOCKET_FAILURE_TIMEOUT
;
3185 socket_enter_signal(s
, SOCKET_FINAL_SIGKILL
, 0);
3189 assert_not_reached("Timeout at wrong time.");
3195 int socket_collect_fds(Socket
*s
, int **fds
) {
3196 size_t k
= 0, n
= 0;
3203 /* Called from the service code for requesting our fds */
3205 LIST_FOREACH(port
, p
, s
->ports
) {
3208 n
+= p
->n_auxiliary_fds
;
3220 LIST_FOREACH(port
, p
, s
->ports
) {
3225 for (i
= 0; i
< p
->n_auxiliary_fds
; ++i
)
3226 rfds
[k
++] = p
->auxiliary_fds
[i
];
3235 static void socket_reset_failed(Unit
*u
) {
3236 Socket
*s
= SOCKET(u
);
3240 if (s
->state
== SOCKET_FAILED
)
3241 socket_set_state(s
, SOCKET_DEAD
);
3243 s
->result
= SOCKET_SUCCESS
;
3244 s
->clean_result
= SOCKET_SUCCESS
;
3247 void socket_connection_unref(Socket
*s
) {
3250 /* The service is dead. Yay!
3252 * This is strictly for one-instance-per-connection
3255 assert(s
->n_connections
> 0);
3258 log_unit_debug(UNIT(s
), "One connection closed, %u left.", s
->n_connections
);
3261 static void socket_trigger_notify(Unit
*u
, Unit
*other
) {
3262 Socket
*s
= SOCKET(u
);
3267 /* Filter out invocations with bogus state */
3268 assert(UNIT_IS_LOAD_COMPLETE(other
->load_state
));
3269 assert(other
->type
== UNIT_SERVICE
);
3271 /* Don't propagate state changes from the service if we are already down */
3272 if (!IN_SET(s
->state
, SOCKET_RUNNING
, SOCKET_LISTENING
))
3275 /* We don't care for the service state if we are in Accept=yes mode */
3279 /* Propagate start limit hit state */
3280 if (other
->start_limit_hit
) {
3281 socket_enter_stop_pre(s
, SOCKET_FAILURE_SERVICE_START_LIMIT_HIT
);
3285 /* Don't propagate anything if there's still a job queued */
3289 if (IN_SET(SERVICE(other
)->state
,
3290 SERVICE_DEAD
, SERVICE_FAILED
,
3291 SERVICE_FINAL_SIGTERM
, SERVICE_FINAL_SIGKILL
,
3292 SERVICE_AUTO_RESTART
))
3293 socket_enter_listening(s
);
3295 if (SERVICE(other
)->state
== SERVICE_RUNNING
)
3296 socket_set_state(s
, SOCKET_RUNNING
);
3299 static int socket_kill(Unit
*u
, KillWho who
, int signo
, sd_bus_error
*error
) {
3300 return unit_kill_common(u
, who
, signo
, -1, SOCKET(u
)->control_pid
, error
);
3303 static int socket_get_timeout(Unit
*u
, usec_t
*timeout
) {
3304 Socket
*s
= SOCKET(u
);
3308 if (!s
->timer_event_source
)
3311 r
= sd_event_source_get_time(s
->timer_event_source
, &t
);
3314 if (t
== USEC_INFINITY
)
3321 char *socket_fdname(Socket
*s
) {
3324 /* Returns the name to use for $LISTEN_NAMES. If the user
3325 * didn't specify anything specifically, use the socket unit's
3326 * name as fallback. */
3328 return s
->fdname
?: UNIT(s
)->id
;
3331 static int socket_control_pid(Unit
*u
) {
3332 Socket
*s
= SOCKET(u
);
3336 return s
->control_pid
;
3339 static int socket_clean(Unit
*u
, ExecCleanMask mask
) {
3340 _cleanup_strv_free_
char **l
= NULL
;
3341 Socket
*s
= SOCKET(u
);
3347 if (s
->state
!= SOCKET_DEAD
)
3350 r
= exec_context_get_clean_directories(&s
->exec_context
, u
->manager
->prefix
, mask
, &l
);
3354 if (strv_isempty(l
))
3357 socket_unwatch_control_pid(s
);
3358 s
->clean_result
= SOCKET_SUCCESS
;
3359 s
->control_command
= NULL
;
3360 s
->control_command_id
= _SOCKET_EXEC_COMMAND_INVALID
;
3362 r
= socket_arm_timer(s
, usec_add(now(CLOCK_MONOTONIC
), s
->exec_context
.timeout_clean_usec
));
3366 r
= unit_fork_and_watch_rm_rf(u
, l
, &s
->control_pid
);
3370 socket_set_state(s
, SOCKET_CLEANING
);
3375 log_unit_warning_errno(u
, r
, "Failed to initiate cleaning: %m");
3376 s
->clean_result
= SOCKET_FAILURE_RESOURCES
;
3377 s
->timer_event_source
= sd_event_source_unref(s
->timer_event_source
);
3381 static int socket_can_clean(Unit
*u
, ExecCleanMask
*ret
) {
3382 Socket
*s
= SOCKET(u
);
3386 return exec_context_get_clean_mask(&s
->exec_context
, ret
);
3389 static const char* const socket_exec_command_table
[_SOCKET_EXEC_COMMAND_MAX
] = {
3390 [SOCKET_EXEC_START_PRE
] = "ExecStartPre",
3391 [SOCKET_EXEC_START_CHOWN
] = "ExecStartChown",
3392 [SOCKET_EXEC_START_POST
] = "ExecStartPost",
3393 [SOCKET_EXEC_STOP_PRE
] = "ExecStopPre",
3394 [SOCKET_EXEC_STOP_POST
] = "ExecStopPost"
3397 DEFINE_STRING_TABLE_LOOKUP(socket_exec_command
, SocketExecCommand
);
3399 static const char* const socket_result_table
[_SOCKET_RESULT_MAX
] = {
3400 [SOCKET_SUCCESS
] = "success",
3401 [SOCKET_FAILURE_RESOURCES
] = "resources",
3402 [SOCKET_FAILURE_TIMEOUT
] = "timeout",
3403 [SOCKET_FAILURE_EXIT_CODE
] = "exit-code",
3404 [SOCKET_FAILURE_SIGNAL
] = "signal",
3405 [SOCKET_FAILURE_CORE_DUMP
] = "core-dump",
3406 [SOCKET_FAILURE_START_LIMIT_HIT
] = "start-limit-hit",
3407 [SOCKET_FAILURE_TRIGGER_LIMIT_HIT
] = "trigger-limit-hit",
3408 [SOCKET_FAILURE_SERVICE_START_LIMIT_HIT
] = "service-start-limit-hit"
3411 DEFINE_STRING_TABLE_LOOKUP(socket_result
, SocketResult
);
3413 const UnitVTable socket_vtable
= {
3414 .object_size
= sizeof(Socket
),
3415 .exec_context_offset
= offsetof(Socket
, exec_context
),
3416 .cgroup_context_offset
= offsetof(Socket
, cgroup_context
),
3417 .kill_context_offset
= offsetof(Socket
, kill_context
),
3418 .exec_runtime_offset
= offsetof(Socket
, exec_runtime
),
3419 .dynamic_creds_offset
= offsetof(Socket
, dynamic_creds
),
3425 .private_section
= "Socket",
3427 .can_transient
= true,
3428 .can_trigger
= true,
3431 .init
= socket_init
,
3432 .done
= socket_done
,
3433 .load
= socket_load
,
3435 .coldplug
= socket_coldplug
,
3437 .dump
= socket_dump
,
3439 .start
= socket_start
,
3440 .stop
= socket_stop
,
3442 .kill
= socket_kill
,
3443 .clean
= socket_clean
,
3444 .can_clean
= socket_can_clean
,
3446 .get_timeout
= socket_get_timeout
,
3448 .serialize
= socket_serialize
,
3449 .deserialize_item
= socket_deserialize_item
,
3450 .distribute_fds
= socket_distribute_fds
,
3452 .active_state
= socket_active_state
,
3453 .sub_state_to_string
= socket_sub_state_to_string
,
3455 .will_restart
= unit_will_restart_default
,
3457 .may_gc
= socket_may_gc
,
3459 .sigchld_event
= socket_sigchld_event
,
3461 .trigger_notify
= socket_trigger_notify
,
3463 .reset_failed
= socket_reset_failed
,
3465 .control_pid
= socket_control_pid
,
3467 .bus_set_property
= bus_socket_set_property
,
3468 .bus_commit_properties
= bus_socket_commit_properties
,
3470 .status_message_formats
= {
3471 /*.starting_stopping = {
3472 [0] = "Starting socket %s...",
3473 [1] = "Stopping socket %s...",
3475 .finished_start_job
= {
3476 [JOB_DONE
] = "Listening on %s.",
3477 [JOB_FAILED
] = "Failed to listen on %s.",
3478 [JOB_TIMEOUT
] = "Timed out starting %s.",
3480 .finished_stop_job
= {
3481 [JOB_DONE
] = "Closed %s.",
3482 [JOB_FAILED
] = "Failed stopping %s.",
3483 [JOB_TIMEOUT
] = "Timed out stopping %s.",