1 /* SPDX-License-Identifier: LGPL-2.1+ */
7 #include <netinet/tcp.h>
12 #include <linux/sctp.h>
14 #include "alloc-util.h"
15 #include "bpf-firewall.h"
16 #include "bus-error.h"
19 #include "dbus-socket.h"
20 #include "dbus-unit.h"
22 #include "exit-status.h"
24 #include "format-util.h"
26 #include "in-addr-util.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"
39 #include "socket-protocol-list.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
73 static int socket_dispatch_io(sd_event_source
*source
, int fd
, uint32_t revents
, void *userdata
);
74 static int socket_dispatch_timer(sd_event_source
*source
, usec_t usec
, void *userdata
);
76 static void socket_init(Unit
*u
) {
77 Socket
*s
= SOCKET(u
);
80 assert(u
->load_state
== UNIT_STUB
);
82 s
->backlog
= SOMAXCONN
;
83 s
->timeout_usec
= u
->manager
->default_timeout_start_usec
;
84 s
->directory_mode
= 0755;
85 s
->socket_mode
= 0666;
87 s
->max_connections
= 64;
94 s
->exec_context
.std_output
= u
->manager
->default_std_output
;
95 s
->exec_context
.std_error
= u
->manager
->default_std_error
;
97 s
->control_command_id
= _SOCKET_EXEC_COMMAND_INVALID
;
99 s
->trigger_limit
.interval
= USEC_INFINITY
;
100 s
->trigger_limit
.burst
= (unsigned) -1;
103 static void socket_unwatch_control_pid(Socket
*s
) {
106 if (s
->control_pid
<= 0)
109 unit_unwatch_pid(UNIT(s
), s
->control_pid
);
113 static void socket_cleanup_fd_list(SocketPort
*p
) {
116 close_many(p
->auxiliary_fds
, p
->n_auxiliary_fds
);
117 p
->auxiliary_fds
= mfree(p
->auxiliary_fds
);
118 p
->n_auxiliary_fds
= 0;
121 void socket_free_ports(Socket
*s
) {
126 while ((p
= s
->ports
)) {
127 LIST_REMOVE(port
, s
->ports
, p
);
129 sd_event_source_unref(p
->event_source
);
131 socket_cleanup_fd_list(p
);
138 static void socket_done(Unit
*u
) {
139 Socket
*s
= SOCKET(u
);
144 socket_free_ports(s
);
146 while ((p
= set_steal_first(s
->peers_by_address
)))
149 s
->peers_by_address
= set_free(s
->peers_by_address
);
151 s
->exec_runtime
= exec_runtime_unref(s
->exec_runtime
, false);
152 exec_command_free_array(s
->exec_command
, _SOCKET_EXEC_COMMAND_MAX
);
153 s
->control_command
= NULL
;
155 dynamic_creds_unref(&s
->dynamic_creds
);
157 socket_unwatch_control_pid(s
);
159 unit_ref_unset(&s
->service
);
161 s
->tcp_congestion
= mfree(s
->tcp_congestion
);
162 s
->bind_to_device
= mfree(s
->bind_to_device
);
164 s
->smack
= mfree(s
->smack
);
165 s
->smack_ip_in
= mfree(s
->smack_ip_in
);
166 s
->smack_ip_out
= mfree(s
->smack_ip_out
);
168 strv_free(s
->symlinks
);
170 s
->user
= mfree(s
->user
);
171 s
->group
= mfree(s
->group
);
173 s
->fdname
= mfree(s
->fdname
);
175 s
->timer_event_source
= sd_event_source_unref(s
->timer_event_source
);
178 static int socket_arm_timer(Socket
*s
, usec_t usec
) {
183 if (s
->timer_event_source
) {
184 r
= sd_event_source_set_time(s
->timer_event_source
, usec
);
188 return sd_event_source_set_enabled(s
->timer_event_source
, SD_EVENT_ONESHOT
);
191 if (usec
== USEC_INFINITY
)
194 r
= sd_event_add_time(
195 UNIT(s
)->manager
->event
,
196 &s
->timer_event_source
,
199 socket_dispatch_timer
, s
);
203 (void) sd_event_source_set_description(s
->timer_event_source
, "socket-timer");
208 int socket_instantiate_service(Socket
*s
) {
209 _cleanup_free_
char *prefix
= NULL
, *name
= NULL
;
215 /* This fills in s->service if it isn't filled in yet. For
216 * Accept=yes sockets we create the next connection service
217 * here. For Accept=no this is mostly a NOP since the service
218 * is figured out at load time anyway. */
220 if (UNIT_DEREF(s
->service
))
226 r
= unit_name_to_prefix(UNIT(s
)->id
, &prefix
);
230 if (asprintf(&name
, "%s@%u.service", prefix
, s
->n_accepted
) < 0)
233 r
= manager_load_unit(UNIT(s
)->manager
, name
, NULL
, NULL
, &u
);
237 unit_ref_set(&s
->service
, UNIT(s
), u
);
239 return unit_add_two_dependencies(UNIT(s
), UNIT_BEFORE
, UNIT_TRIGGERS
, u
, false, UNIT_DEPENDENCY_IMPLICIT
);
242 static bool have_non_accept_socket(Socket
*s
) {
250 LIST_FOREACH(port
, p
, s
->ports
) {
252 if (p
->type
!= SOCKET_SOCKET
)
255 if (!socket_address_can_accept(&p
->address
))
262 static int socket_add_mount_dependencies(Socket
*s
) {
268 LIST_FOREACH(port
, p
, s
->ports
) {
269 const char *path
= NULL
;
271 if (p
->type
== SOCKET_SOCKET
)
272 path
= socket_address_get_path(&p
->address
);
273 else if (IN_SET(p
->type
, SOCKET_FIFO
, SOCKET_SPECIAL
, SOCKET_USB_FUNCTION
))
279 r
= unit_require_mounts_for(UNIT(s
), path
, UNIT_DEPENDENCY_FILE
);
287 static int socket_add_device_dependencies(Socket
*s
) {
292 if (!s
->bind_to_device
|| streq(s
->bind_to_device
, "lo"))
295 t
= strjoina("/sys/subsystem/net/devices/", s
->bind_to_device
);
296 return unit_add_node_dependency(UNIT(s
), t
, false, UNIT_BINDS_TO
, UNIT_DEPENDENCY_FILE
);
299 static int socket_add_default_dependencies(Socket
*s
) {
303 if (!UNIT(s
)->default_dependencies
)
306 r
= unit_add_dependency_by_name(UNIT(s
), UNIT_BEFORE
, SPECIAL_SOCKETS_TARGET
, true, UNIT_DEPENDENCY_DEFAULT
);
310 if (MANAGER_IS_SYSTEM(UNIT(s
)->manager
)) {
311 r
= unit_add_two_dependencies_by_name(UNIT(s
), UNIT_AFTER
, UNIT_REQUIRES
, SPECIAL_SYSINIT_TARGET
, true, UNIT_DEPENDENCY_DEFAULT
);
316 return unit_add_two_dependencies_by_name(UNIT(s
), UNIT_BEFORE
, UNIT_CONFLICTS
, SPECIAL_SHUTDOWN_TARGET
, true, UNIT_DEPENDENCY_DEFAULT
);
319 _pure_
static bool socket_has_exec(Socket
*s
) {
323 for (i
= 0; i
< _SOCKET_EXEC_COMMAND_MAX
; i
++)
324 if (s
->exec_command
[i
])
330 static int socket_add_extras(Socket
*s
) {
336 /* Pick defaults for the trigger limit, if nothing was explicitly configured. We pick a relatively high limit
337 * in Accept=yes mode, and a lower limit for Accept=no. Reason: in Accept=yes mode we are invoking accept()
338 * ourselves before the trigger limit can hit, thus incoming connections are taken off the socket queue quickly
339 * and reliably. This is different for Accept=no, where the spawned service has to take the incoming traffic
340 * off the queues, which it might not necessarily do. Moreover, while Accept=no services are supposed to
341 * process whatever is queued in one go, and thus should normally never have to be started frequently. This is
342 * different for Accept=yes where each connection is processed by a new service instance, and thus frequent
343 * service starts are typical. */
345 if (s
->trigger_limit
.interval
== USEC_INFINITY
)
346 s
->trigger_limit
.interval
= 2 * USEC_PER_SEC
;
348 if (s
->trigger_limit
.burst
== (unsigned) -1) {
350 s
->trigger_limit
.burst
= 200;
352 s
->trigger_limit
.burst
= 20;
355 if (have_non_accept_socket(s
)) {
357 if (!UNIT_DEREF(s
->service
)) {
360 r
= unit_load_related_unit(u
, ".service", &x
);
364 unit_ref_set(&s
->service
, u
, x
);
367 r
= unit_add_two_dependencies(u
, UNIT_BEFORE
, UNIT_TRIGGERS
, UNIT_DEREF(s
->service
), true, UNIT_DEPENDENCY_IMPLICIT
);
372 r
= socket_add_mount_dependencies(s
);
376 r
= socket_add_device_dependencies(s
);
380 r
= unit_patch_contexts(u
);
384 if (socket_has_exec(s
)) {
385 r
= unit_add_exec_dependencies(u
, &s
->exec_context
);
390 r
= unit_set_default_slice(u
);
394 r
= socket_add_default_dependencies(s
);
401 static const char *socket_find_symlink_target(Socket
*s
) {
402 const char *found
= NULL
;
405 LIST_FOREACH(port
, p
, s
->ports
) {
406 const char *f
= NULL
;
415 f
= socket_address_get_path(&p
->address
);
433 static int socket_verify(Socket
*s
) {
436 if (UNIT(s
)->load_state
!= UNIT_LOADED
)
440 log_unit_error(UNIT(s
), "Unit has no Listen setting (ListenStream=, ListenDatagram=, ListenFIFO=, ...). Refusing.");
444 if (s
->accept
&& have_non_accept_socket(s
)) {
445 log_unit_error(UNIT(s
), "Unit configured for accepting sockets, but sockets are non-accepting. Refusing.");
449 if (s
->accept
&& s
->max_connections
<= 0) {
450 log_unit_error(UNIT(s
), "MaxConnection= setting too small. Refusing.");
454 if (s
->accept
&& UNIT_DEREF(s
->service
)) {
455 log_unit_error(UNIT(s
), "Explicit service configuration for accepting socket units not supported. Refusing.");
459 if (s
->exec_context
.pam_name
&& s
->kill_context
.kill_mode
!= KILL_CONTROL_GROUP
) {
460 log_unit_error(UNIT(s
), "Unit has PAM enabled. Kill mode must be set to 'control-group'. Refusing.");
464 if (!strv_isempty(s
->symlinks
) && !socket_find_symlink_target(s
)) {
465 log_unit_error(UNIT(s
), "Unit has symlinks set but none or more than one node in the file system. Refusing.");
472 static void peer_address_hash_func(const void *p
, struct siphash
*state
) {
473 const SocketPeer
*s
= p
;
477 if (s
->peer
.sa
.sa_family
== AF_INET
)
478 siphash24_compress(&s
->peer
.in
.sin_addr
, sizeof(s
->peer
.in
.sin_addr
), state
);
479 else if (s
->peer
.sa
.sa_family
== AF_INET6
)
480 siphash24_compress(&s
->peer
.in6
.sin6_addr
, sizeof(s
->peer
.in6
.sin6_addr
), state
);
481 else if (s
->peer
.sa
.sa_family
== AF_VSOCK
)
482 siphash24_compress(&s
->peer
.vm
.svm_cid
, sizeof(s
->peer
.vm
.svm_cid
), state
);
484 assert_not_reached("Unknown address family.");
487 static int peer_address_compare_func(const void *a
, const void *b
) {
488 const SocketPeer
*x
= a
, *y
= b
;
491 r
= CMP(x
->peer
.sa
.sa_family
, y
->peer
.sa
.sa_family
);
495 switch(x
->peer
.sa
.sa_family
) {
497 return memcmp(&x
->peer
.in
.sin_addr
, &y
->peer
.in
.sin_addr
, sizeof(x
->peer
.in
.sin_addr
));
499 return memcmp(&x
->peer
.in6
.sin6_addr
, &y
->peer
.in6
.sin6_addr
, sizeof(x
->peer
.in6
.sin6_addr
));
501 return CMP(x
->peer
.vm
.svm_cid
, y
->peer
.vm
.svm_cid
);
503 assert_not_reached("Black sheep in the family!");
506 const struct hash_ops peer_address_hash_ops
= {
507 .hash
= peer_address_hash_func
,
508 .compare
= peer_address_compare_func
511 static int socket_load(Unit
*u
) {
512 Socket
*s
= SOCKET(u
);
516 assert(u
->load_state
== UNIT_STUB
);
518 r
= set_ensure_allocated(&s
->peers_by_address
, &peer_address_hash_ops
);
522 r
= unit_load_fragment_and_dropin(u
);
526 if (u
->load_state
== UNIT_LOADED
) {
527 /* This is a new unit? Then let's add in some extras */
528 r
= socket_add_extras(s
);
533 return socket_verify(s
);
536 static SocketPeer
*socket_peer_new(void) {
539 p
= new0(SocketPeer
, 1);
548 static SocketPeer
*socket_peer_free(SocketPeer
*p
) {
552 set_remove(p
->socket
->peers_by_address
, p
);
557 DEFINE_TRIVIAL_REF_UNREF_FUNC(SocketPeer
, socket_peer
, socket_peer_free
);
559 int socket_acquire_peer(Socket
*s
, int fd
, SocketPeer
**p
) {
560 _cleanup_(socket_peer_unrefp
) SocketPeer
*remote
= NULL
;
561 SocketPeer sa
= {}, *i
;
562 socklen_t salen
= sizeof(sa
.peer
);
568 r
= getpeername(fd
, &sa
.peer
.sa
, &salen
);
570 return log_error_errno(errno
, "getpeername failed: %m");
572 if (!IN_SET(sa
.peer
.sa
.sa_family
, AF_INET
, AF_INET6
, AF_VSOCK
)) {
577 i
= set_get(s
->peers_by_address
, &sa
);
579 *p
= socket_peer_ref(i
);
583 remote
= socket_peer_new();
587 remote
->peer
= sa
.peer
;
588 remote
->peer_salen
= salen
;
590 r
= set_put(s
->peers_by_address
, remote
);
596 *p
= TAKE_PTR(remote
);
601 _const_
static const char* listen_lookup(int family
, int type
) {
603 if (family
== AF_NETLINK
)
604 return "ListenNetlink";
606 if (type
== SOCK_STREAM
)
607 return "ListenStream";
608 else if (type
== SOCK_DGRAM
)
609 return "ListenDatagram";
610 else if (type
== SOCK_SEQPACKET
)
611 return "ListenSequentialPacket";
613 assert_not_reached("Unknown socket type");
617 static void socket_dump(Unit
*u
, FILE *f
, const char *prefix
) {
618 char time_string
[FORMAT_TIMESPAN_MAX
];
620 Socket
*s
= SOCKET(u
);
622 const char *prefix2
, *str
;
627 prefix
= strempty(prefix
);
628 prefix2
= strjoina(prefix
, "\t");
631 "%sSocket State: %s\n"
633 "%sBindIPv6Only: %s\n"
635 "%sSocketMode: %04o\n"
636 "%sDirectoryMode: %04o\n"
640 "%sTransparent: %s\n"
642 "%sPassCredentials: %s\n"
643 "%sPassSecurity: %s\n"
644 "%sTCPCongestion: %s\n"
645 "%sRemoveOnStop: %s\n"
647 "%sFileDescriptorName: %s\n"
648 "%sSELinuxContextFromNet: %s\n",
649 prefix
, socket_state_to_string(s
->state
),
650 prefix
, socket_result_to_string(s
->result
),
651 prefix
, socket_address_bind_ipv6_only_to_string(s
->bind_ipv6_only
),
653 prefix
, s
->socket_mode
,
654 prefix
, s
->directory_mode
,
655 prefix
, yes_no(s
->keep_alive
),
656 prefix
, yes_no(s
->no_delay
),
657 prefix
, yes_no(s
->free_bind
),
658 prefix
, yes_no(s
->transparent
),
659 prefix
, yes_no(s
->broadcast
),
660 prefix
, yes_no(s
->pass_cred
),
661 prefix
, yes_no(s
->pass_sec
),
662 prefix
, strna(s
->tcp_congestion
),
663 prefix
, yes_no(s
->remove_on_stop
),
664 prefix
, yes_no(s
->writable
),
665 prefix
, socket_fdname(s
),
666 prefix
, yes_no(s
->selinux_context_from_net
));
668 if (s
->control_pid
> 0)
670 "%sControl PID: "PID_FMT
"\n",
671 prefix
, s
->control_pid
);
673 if (s
->bind_to_device
)
675 "%sBindToDevice: %s\n",
676 prefix
, s
->bind_to_device
);
681 "%sNConnections: %u\n"
682 "%sMaxConnections: %u\n"
683 "%sMaxConnectionsPerSource: %u\n",
684 prefix
, s
->n_accepted
,
685 prefix
, s
->n_connections
,
686 prefix
, s
->max_connections
,
687 prefix
, s
->max_connections_per_source
);
689 if (s
->priority
>= 0)
692 prefix
, s
->priority
);
694 if (s
->receive_buffer
> 0)
696 "%sReceiveBuffer: %zu\n",
697 prefix
, s
->receive_buffer
);
699 if (s
->send_buffer
> 0)
701 "%sSendBuffer: %zu\n",
702 prefix
, s
->send_buffer
);
714 if (s
->pipe_size
> 0)
717 prefix
, s
->pipe_size
);
724 if (s
->mq_maxmsg
> 0)
726 "%sMessageQueueMaxMessages: %li\n",
727 prefix
, s
->mq_maxmsg
);
729 if (s
->mq_msgsize
> 0)
731 "%sMessageQueueMessageSize: %li\n",
732 prefix
, s
->mq_msgsize
);
737 prefix
, yes_no(s
->reuse_port
));
741 "%sSmackLabel: %s\n",
746 "%sSmackLabelIPIn: %s\n",
747 prefix
, s
->smack_ip_in
);
751 "%sSmackLabelIPOut: %s\n",
752 prefix
, s
->smack_ip_out
);
754 if (!isempty(s
->user
) || !isempty(s
->group
))
757 "%sSocketGroup: %s\n",
758 prefix
, strna(s
->user
),
759 prefix
, strna(s
->group
));
761 if (s
->keep_alive_time
> 0)
763 "%sKeepAliveTimeSec: %s\n",
764 prefix
, format_timespan(time_string
, FORMAT_TIMESPAN_MAX
, s
->keep_alive_time
, USEC_PER_SEC
));
766 if (s
->keep_alive_interval
> 0)
768 "%sKeepAliveIntervalSec: %s\n",
769 prefix
, format_timespan(time_string
, FORMAT_TIMESPAN_MAX
, s
->keep_alive_interval
, USEC_PER_SEC
));
771 if (s
->keep_alive_cnt
> 0)
773 "%sKeepAliveProbes: %u\n",
774 prefix
, s
->keep_alive_cnt
);
776 if (s
->defer_accept
> 0)
778 "%sDeferAcceptSec: %s\n",
779 prefix
, format_timespan(time_string
, FORMAT_TIMESPAN_MAX
, s
->defer_accept
, USEC_PER_SEC
));
781 LIST_FOREACH(port
, p
, s
->ports
) {
784 case SOCKET_SOCKET
: {
785 _cleanup_free_
char *k
= NULL
;
789 r
= socket_address_print(&p
->address
, &k
);
795 fprintf(f
, "%s%s: %s\n", prefix
, listen_lookup(socket_address_family(&p
->address
), p
->address
.type
), t
);
799 fprintf(f
, "%sListenSpecial: %s\n", prefix
, p
->path
);
801 case SOCKET_USB_FUNCTION
:
802 fprintf(f
, "%sListenUSBFunction: %s\n", prefix
, p
->path
);
805 fprintf(f
, "%sListenMessageQueue: %s\n", prefix
, p
->path
);
808 fprintf(f
, "%sListenFIFO: %s\n", prefix
, p
->path
);
813 "%sTriggerLimitIntervalSec: %s\n"
814 "%sTriggerLimitBurst: %u\n",
815 prefix
, format_timespan(time_string
, FORMAT_TIMESPAN_MAX
, s
->trigger_limit
.interval
, USEC_PER_SEC
),
816 prefix
, s
->trigger_limit
.burst
);
818 str
= socket_protocol_to_name(s
->socket_protocol
);
820 fprintf(f
, "%sSocketProtocol: %s\n", prefix
, str
);
822 if (!strv_isempty(s
->symlinks
)) {
825 fprintf(f
, "%sSymlinks:", prefix
);
826 STRV_FOREACH(q
, s
->symlinks
)
827 fprintf(f
, " %s", *q
);
833 "%sTimeoutSec: %s\n",
834 prefix
, format_timespan(time_string
, FORMAT_TIMESPAN_MAX
, s
->timeout_usec
, USEC_PER_SEC
));
836 exec_context_dump(&s
->exec_context
, f
, prefix
);
837 kill_context_dump(&s
->kill_context
, f
, prefix
);
839 for (c
= 0; c
< _SOCKET_EXEC_COMMAND_MAX
; c
++) {
840 if (!s
->exec_command
[c
])
843 fprintf(f
, "%s-> %s:\n",
844 prefix
, socket_exec_command_to_string(c
));
846 exec_command_dump_list(s
->exec_command
[c
], f
, prefix2
);
849 cgroup_context_dump(&s
->cgroup_context
, f
, prefix
);
852 static int instance_from_socket(int fd
, unsigned nr
, char **instance
) {
855 union sockaddr_union local
, remote
;
861 if (getsockname(fd
, &local
.sa
, &l
) < 0)
865 if (getpeername(fd
, &remote
.sa
, &l
) < 0)
868 switch (local
.sa
.sa_family
) {
872 a
= be32toh(local
.in
.sin_addr
.s_addr
),
873 b
= be32toh(remote
.in
.sin_addr
.s_addr
);
876 "%u-%u.%u.%u.%u:%u-%u.%u.%u.%u:%u",
878 a
>> 24, (a
>> 16) & 0xFF, (a
>> 8) & 0xFF, a
& 0xFF,
879 be16toh(local
.in
.sin_port
),
880 b
>> 24, (b
>> 16) & 0xFF, (b
>> 8) & 0xFF, b
& 0xFF,
881 be16toh(remote
.in
.sin_port
)) < 0)
888 static const unsigned char ipv4_prefix
[] = {
889 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0xFF, 0xFF
892 if (memcmp(&local
.in6
.sin6_addr
, ipv4_prefix
, sizeof(ipv4_prefix
)) == 0 &&
893 memcmp(&remote
.in6
.sin6_addr
, ipv4_prefix
, sizeof(ipv4_prefix
)) == 0) {
895 *a
= local
.in6
.sin6_addr
.s6_addr
+12,
896 *b
= remote
.in6
.sin6_addr
.s6_addr
+12;
899 "%u-%u.%u.%u.%u:%u-%u.%u.%u.%u:%u",
901 a
[0], a
[1], a
[2], a
[3],
902 be16toh(local
.in6
.sin6_port
),
903 b
[0], b
[1], b
[2], b
[3],
904 be16toh(remote
.in6
.sin6_port
)) < 0)
907 char a
[INET6_ADDRSTRLEN
], b
[INET6_ADDRSTRLEN
];
912 inet_ntop(AF_INET6
, &local
.in6
.sin6_addr
, a
, sizeof(a
)),
913 be16toh(local
.in6
.sin6_port
),
914 inet_ntop(AF_INET6
, &remote
.in6
.sin6_addr
, b
, sizeof(b
)),
915 be16toh(remote
.in6
.sin6_port
)) < 0)
926 k
= getpeercred(fd
, &ucred
);
929 "%u-"PID_FMT
"-"UID_FMT
,
930 nr
, ucred
.pid
, ucred
.uid
) < 0)
932 } else if (k
== -ENODATA
) {
933 /* This handles the case where somebody is
934 * connecting from another pid/uid namespace
935 * (e.g. from outside of our container). */
950 local
.vm
.svm_cid
, local
.vm
.svm_port
,
951 remote
.vm
.svm_cid
, remote
.vm
.svm_port
) < 0)
957 assert_not_reached("Unhandled socket type.");
964 static void socket_close_fds(Socket
*s
) {
970 LIST_FOREACH(port
, p
, s
->ports
) {
973 was_open
= p
->fd
>= 0;
975 p
->event_source
= sd_event_source_unref(p
->event_source
);
976 p
->fd
= safe_close(p
->fd
);
977 socket_cleanup_fd_list(p
);
979 /* One little note: we should normally not delete any sockets in the file system here! After all some
980 * other process we spawned might still have a reference of this fd and wants to continue to use
981 * it. Therefore we normally delete sockets in the file system before we create a new one, not after we
982 * stopped using one! That all said, if the user explicitly requested this, we'll delete them here
983 * anyway, but only then. */
985 if (!was_open
|| !s
->remove_on_stop
)
991 (void) unlink(p
->path
);
995 (void) mq_unlink(p
->path
);
999 (void) socket_address_unlink(&p
->address
);
1007 if (s
->remove_on_stop
)
1008 STRV_FOREACH(i
, s
->symlinks
)
1012 static void socket_apply_socket_options(Socket
*s
, int fd
) {
1018 if (s
->keep_alive
) {
1019 r
= setsockopt_int(fd
, SOL_SOCKET
, SO_KEEPALIVE
, true);
1021 log_unit_warning_errno(UNIT(s
), r
, "SO_KEEPALIVE failed: %m");
1024 if (s
->keep_alive_time
> 0) {
1025 r
= setsockopt_int(fd
, SOL_TCP
, TCP_KEEPIDLE
, s
->keep_alive_time
/ USEC_PER_SEC
);
1027 log_unit_warning_errno(UNIT(s
), r
, "TCP_KEEPIDLE failed: %m");
1030 if (s
->keep_alive_interval
> 0) {
1031 r
= setsockopt_int(fd
, SOL_TCP
, TCP_KEEPINTVL
, s
->keep_alive_interval
/ USEC_PER_SEC
);
1033 log_unit_warning_errno(UNIT(s
), r
, "TCP_KEEPINTVL failed: %m");
1036 if (s
->keep_alive_cnt
> 0) {
1037 r
= setsockopt_int(fd
, SOL_TCP
, TCP_KEEPCNT
, s
->keep_alive_cnt
);
1039 log_unit_warning_errno(UNIT(s
), r
, "TCP_KEEPCNT failed: %m");
1042 if (s
->defer_accept
> 0) {
1043 r
= setsockopt_int(fd
, SOL_TCP
, TCP_DEFER_ACCEPT
, s
->defer_accept
/ USEC_PER_SEC
);
1045 log_unit_warning_errno(UNIT(s
), r
, "TCP_DEFER_ACCEPT failed: %m");
1049 if (s
->socket_protocol
== IPPROTO_SCTP
) {
1050 r
= setsockopt_int(fd
, SOL_SCTP
, SCTP_NODELAY
, true);
1052 log_unit_warning_errno(UNIT(s
), r
, "SCTP_NODELAY failed: %m");
1054 r
= setsockopt_int(fd
, SOL_TCP
, TCP_NODELAY
, true);
1056 log_unit_warning_errno(UNIT(s
), r
, "TCP_NODELAY failed: %m");
1061 r
= setsockopt_int(fd
, SOL_SOCKET
, SO_BROADCAST
, true);
1063 log_unit_warning_errno(UNIT(s
), r
, "SO_BROADCAST failed: %m");
1067 r
= setsockopt_int(fd
, SOL_SOCKET
, SO_PASSCRED
, true);
1069 log_unit_warning_errno(UNIT(s
), r
, "SO_PASSCRED failed: %m");
1073 r
= setsockopt_int(fd
, SOL_SOCKET
, SO_PASSSEC
, true);
1075 log_unit_warning_errno(UNIT(s
), r
, "SO_PASSSEC failed: %m");
1078 if (s
->priority
>= 0) {
1079 r
= setsockopt_int(fd
, SOL_SOCKET
, SO_PRIORITY
, s
->priority
);
1081 log_unit_warning_errno(UNIT(s
), r
, "SO_PRIORITY failed: %m");
1084 if (s
->receive_buffer
> 0) {
1085 /* We first try with SO_RCVBUFFORCE, in case we have the perms for that */
1086 if (setsockopt_int(fd
, SOL_SOCKET
, SO_RCVBUFFORCE
, s
->receive_buffer
) < 0) {
1087 r
= setsockopt_int(fd
, SOL_SOCKET
, SO_RCVBUF
, s
->receive_buffer
);
1089 log_unit_warning_errno(UNIT(s
), r
, "SO_RCVBUF failed: %m");
1093 if (s
->send_buffer
> 0) {
1094 if (setsockopt_int(fd
, SOL_SOCKET
, SO_SNDBUFFORCE
, s
->send_buffer
) < 0) {
1095 r
= setsockopt_int(fd
, SOL_SOCKET
, SO_SNDBUF
, s
->send_buffer
);
1097 log_unit_warning_errno(UNIT(s
), r
, "SO_SNDBUF failed: %m");
1102 r
= setsockopt_int(fd
, SOL_SOCKET
, SO_MARK
, s
->mark
);
1104 log_unit_warning_errno(UNIT(s
), r
, "SO_MARK failed: %m");
1107 if (s
->ip_tos
>= 0) {
1108 r
= setsockopt_int(fd
, IPPROTO_IP
, IP_TOS
, s
->ip_tos
);
1110 log_unit_warning_errno(UNIT(s
), r
, "IP_TOS failed: %m");
1113 if (s
->ip_ttl
>= 0) {
1116 r
= setsockopt_int(fd
, IPPROTO_IP
, IP_TTL
, s
->ip_ttl
);
1118 if (socket_ipv6_is_supported())
1119 x
= setsockopt_int(fd
, IPPROTO_IPV6
, IPV6_UNICAST_HOPS
, s
->ip_ttl
);
1124 log_unit_warning_errno(UNIT(s
), r
, "IP_TTL/IPV6_UNICAST_HOPS failed: %m");
1127 if (s
->tcp_congestion
)
1128 if (setsockopt(fd
, SOL_TCP
, TCP_CONGESTION
, s
->tcp_congestion
, strlen(s
->tcp_congestion
)+1) < 0)
1129 log_unit_warning_errno(UNIT(s
), errno
, "TCP_CONGESTION failed: %m");
1131 if (s
->smack_ip_in
) {
1132 r
= mac_smack_apply_fd(fd
, SMACK_ATTR_IPIN
, s
->smack_ip_in
);
1134 log_unit_error_errno(UNIT(s
), r
, "mac_smack_apply_ip_in_fd: %m");
1137 if (s
->smack_ip_out
) {
1138 r
= mac_smack_apply_fd(fd
, SMACK_ATTR_IPOUT
, s
->smack_ip_out
);
1140 log_unit_error_errno(UNIT(s
), r
, "mac_smack_apply_ip_out_fd: %m");
1144 static void socket_apply_fifo_options(Socket
*s
, int fd
) {
1150 if (s
->pipe_size
> 0)
1151 if (fcntl(fd
, F_SETPIPE_SZ
, s
->pipe_size
) < 0)
1152 log_unit_warning_errno(UNIT(s
), errno
, "Setting pipe size failed, ignoring: %m");
1155 r
= mac_smack_apply_fd(fd
, SMACK_ATTR_ACCESS
, s
->smack
);
1157 log_unit_error_errno(UNIT(s
), r
, "SMACK relabelling failed, ignoring: %m");
1161 static int fifo_address_create(
1163 mode_t directory_mode
,
1164 mode_t socket_mode
) {
1166 _cleanup_close_
int fd
= -1;
1173 (void) mkdir_parents_label(path
, directory_mode
);
1175 r
= mac_selinux_create_file_prepare(path
, S_IFIFO
);
1179 /* Enforce the right access mode for the fifo */
1180 old_mask
= umask(~socket_mode
);
1182 /* Include the original umask in our mask */
1183 (void) umask(~socket_mode
| old_mask
);
1185 r
= mkfifo(path
, socket_mode
);
1186 (void) umask(old_mask
);
1188 if (r
< 0 && errno
!= EEXIST
) {
1193 fd
= open(path
, O_RDWR
| O_CLOEXEC
| O_NOCTTY
| O_NONBLOCK
| O_NOFOLLOW
);
1199 mac_selinux_create_file_clear();
1201 if (fstat(fd
, &st
) < 0) {
1206 if (!S_ISFIFO(st
.st_mode
) ||
1207 (st
.st_mode
& 0777) != (socket_mode
& ~old_mask
) ||
1208 st
.st_uid
!= getuid() ||
1209 st
.st_gid
!= getgid()) {
1217 mac_selinux_create_file_clear();
1221 static int special_address_create(const char *path
, bool writable
) {
1222 _cleanup_close_
int fd
= -1;
1227 fd
= open(path
, (writable
? O_RDWR
: O_RDONLY
)|O_CLOEXEC
|O_NOCTTY
|O_NONBLOCK
|O_NOFOLLOW
);
1231 if (fstat(fd
, &st
) < 0)
1234 /* Check whether this is a /proc, /sys or /dev file or char device */
1235 if (!S_ISREG(st
.st_mode
) && !S_ISCHR(st
.st_mode
))
1241 static int usbffs_address_create(const char *path
) {
1242 _cleanup_close_
int fd
= -1;
1247 fd
= open(path
, O_RDWR
|O_CLOEXEC
|O_NOCTTY
|O_NONBLOCK
|O_NOFOLLOW
);
1251 if (fstat(fd
, &st
) < 0)
1254 /* Check whether this is a regular file (ffs endpoint) */
1255 if (!S_ISREG(st
.st_mode
))
1261 static int mq_address_create(
1267 _cleanup_close_
int fd
= -1;
1270 struct mq_attr _attr
, *attr
= NULL
;
1274 if (maxmsg
> 0 && msgsize
> 0) {
1275 _attr
= (struct mq_attr
) {
1276 .mq_flags
= O_NONBLOCK
,
1277 .mq_maxmsg
= maxmsg
,
1278 .mq_msgsize
= msgsize
,
1283 /* Enforce the right access mode for the mq */
1284 old_mask
= umask(~mq_mode
);
1286 /* Include the original umask in our mask */
1287 (void) umask(~mq_mode
| old_mask
);
1288 fd
= mq_open(path
, O_RDONLY
|O_CLOEXEC
|O_NONBLOCK
|O_CREAT
, mq_mode
, attr
);
1289 (void) umask(old_mask
);
1294 if (fstat(fd
, &st
) < 0)
1297 if ((st
.st_mode
& 0777) != (mq_mode
& ~old_mask
) ||
1298 st
.st_uid
!= getuid() ||
1299 st
.st_gid
!= getgid())
1305 static int socket_symlink(Socket
*s
) {
1312 p
= socket_find_symlink_target(s
);
1316 STRV_FOREACH(i
, s
->symlinks
) {
1317 (void) mkdir_parents_label(*i
, s
->directory_mode
);
1319 r
= symlink_idempotent(p
, *i
, false);
1321 if (r
== -EEXIST
&& s
->remove_on_stop
) {
1322 /* If there's already something where we want to create the symlink, and the destructive
1323 * RemoveOnStop= mode is set, then we might as well try to remove what already exists and try
1326 if (unlink(*i
) >= 0)
1327 r
= symlink_idempotent(p
, *i
, false);
1331 log_unit_warning_errno(UNIT(s
), r
, "Failed to create symlink %s → %s, ignoring: %m", p
, *i
);
1337 static int usbffs_write_descs(int fd
, Service
*s
) {
1340 if (!s
->usb_function_descriptors
|| !s
->usb_function_strings
)
1343 r
= copy_file_fd(s
->usb_function_descriptors
, fd
, 0);
1347 return copy_file_fd(s
->usb_function_strings
, fd
, 0);
1350 static int usbffs_select_ep(const struct dirent
*d
) {
1351 return d
->d_name
[0] != '.' && !streq(d
->d_name
, "ep0");
1354 static int usbffs_dispatch_eps(SocketPort
*p
) {
1355 _cleanup_free_
struct dirent
**ent
= NULL
;
1359 r
= scandir(p
->path
, &ent
, usbffs_select_ep
, alphasort
);
1364 p
->auxiliary_fds
= new(int, n
);
1365 if (!p
->auxiliary_fds
) {
1370 p
->n_auxiliary_fds
= n
;
1373 for (i
= 0; i
< n
; ++i
) {
1374 _cleanup_free_
char *ep
= NULL
;
1376 ep
= path_make_absolute(ent
[i
]->d_name
, p
->path
);
1382 path_simplify(ep
, false);
1384 r
= usbffs_address_create(ep
);
1388 p
->auxiliary_fds
[k
++] = r
;
1395 close_many(p
->auxiliary_fds
, k
);
1396 p
->auxiliary_fds
= mfree(p
->auxiliary_fds
);
1397 p
->n_auxiliary_fds
= 0;
1400 for (i
= 0; i
< n
; ++i
)
1406 static int socket_determine_selinux_label(Socket
*s
, char **ret
) {
1409 _cleanup_free_
char *path
= NULL
;
1415 if (s
->selinux_context_from_net
) {
1416 /* If this is requested, get label from the network label */
1418 r
= mac_selinux_get_our_label(ret
);
1419 if (r
== -EOPNOTSUPP
)
1423 /* Otherwise, get it from the executable we are about to start */
1424 r
= socket_instantiate_service(s
);
1428 if (!UNIT_ISSET(s
->service
))
1431 service
= SERVICE(UNIT_DEREF(s
->service
));
1432 c
= service
->exec_command
[SERVICE_EXEC_START
];
1436 r
= chase_symlinks(c
->path
, service
->exec_context
.root_directory
, CHASE_PREFIX_ROOT
, &path
);
1440 r
= mac_selinux_get_create_label_from_exe(path
, ret
);
1441 if (IN_SET(r
, -EPERM
, -EOPNOTSUPP
))
1452 static int socket_address_listen_do(
1454 const SocketAddress
*address
,
1455 const char *label
) {
1460 return socket_address_listen(
1462 SOCK_CLOEXEC
|SOCK_NONBLOCK
,
1474 static int socket_address_listen_in_cgroup(
1476 const SocketAddress
*address
,
1477 const char *label
) {
1479 _cleanup_close_pair_
int pair
[2] = { -1, -1 };
1486 /* This is a wrapper around socket_address_listen(), that forks off a helper process inside the socket's cgroup
1487 * in which the socket is actually created. This way we ensure the socket is actually properly attached to the
1488 * unit's cgroup for the purpose of BPF filtering and such. */
1490 if (!IN_SET(address
->sockaddr
.sa
.sa_family
, AF_INET
, AF_INET6
))
1491 goto shortcut
; /* BPF filtering only applies to IPv4 + IPv6, shortcut things for other protocols */
1493 r
= bpf_firewall_supported();
1496 if (r
== BPF_FIREWALL_UNSUPPORTED
) /* If BPF firewalling isn't supported anyway — there's no point in this forking complexity */
1499 if (socketpair(AF_UNIX
, SOCK_SEQPACKET
|SOCK_CLOEXEC
, 0, pair
) < 0)
1500 return log_unit_error_errno(UNIT(s
), errno
, "Failed to create communication channel: %m");
1502 r
= unit_fork_helper_process(UNIT(s
), "(sd-listen)", &pid
);
1504 return log_unit_error_errno(UNIT(s
), r
, "Failed to fork off listener stub process: %m");
1508 pair
[0] = safe_close(pair
[0]);
1510 fd
= socket_address_listen_do(s
, address
, label
);
1512 log_unit_error_errno(UNIT(s
), fd
, "Failed to create listening socket: %m");
1513 _exit(EXIT_FAILURE
);
1516 r
= send_one_fd(pair
[1], fd
, 0);
1518 log_unit_error_errno(UNIT(s
), r
, "Failed to send listening socket to parent: %m");
1519 _exit(EXIT_FAILURE
);
1522 _exit(EXIT_SUCCESS
);
1525 pair
[1] = safe_close(pair
[1]);
1526 fd
= receive_one_fd(pair
[0], 0);
1528 /* We synchronously wait for the helper, as it shouldn't be slow */
1529 r
= wait_for_terminate_and_check("(sd-listen)", pid
, WAIT_LOG_ABNORMAL
);
1536 return log_unit_error_errno(UNIT(s
), fd
, "Failed to receive listening socket: %m");
1541 fd
= socket_address_listen_do(s
, address
, label
);
1543 return log_error_errno(fd
, "Failed to create listening socket: %m");
1548 static int socket_open_fds(Socket
*s
) {
1549 _cleanup_(mac_selinux_freep
) char *label
= NULL
;
1550 bool know_label
= false;
1556 LIST_FOREACH(port
, p
, s
->ports
) {
1566 /* Figure out label, if we don't it know yet. We do it once, for the first socket where
1567 * we need this and remember it for the rest. */
1569 r
= socket_determine_selinux_label(s
, &label
);
1576 /* Apply the socket protocol */
1577 switch (p
->address
.type
) {
1580 case SOCK_SEQPACKET
:
1581 if (s
->socket_protocol
== IPPROTO_SCTP
)
1582 p
->address
.protocol
= s
->socket_protocol
;
1586 if (s
->socket_protocol
== IPPROTO_UDPLITE
)
1587 p
->address
.protocol
= s
->socket_protocol
;
1591 r
= socket_address_listen_in_cgroup(s
, &p
->address
, label
);
1596 socket_apply_socket_options(s
, p
->fd
);
1600 case SOCKET_SPECIAL
:
1602 p
->fd
= special_address_create(p
->path
, s
->writable
);
1611 p
->fd
= fifo_address_create(
1620 socket_apply_fifo_options(s
, p
->fd
);
1626 p
->fd
= mq_address_create(
1637 case SOCKET_USB_FUNCTION
: {
1638 _cleanup_free_
char *ep
= NULL
;
1640 ep
= path_make_absolute("ep0", p
->path
);
1642 p
->fd
= usbffs_address_create(ep
);
1648 r
= usbffs_write_descs(p
->fd
, SERVICE(UNIT_DEREF(s
->service
)));
1652 r
= usbffs_dispatch_eps(p
);
1659 assert_not_reached("Unknown port type");
1666 socket_close_fds(s
);
1670 static void socket_unwatch_fds(Socket
*s
) {
1676 LIST_FOREACH(port
, p
, s
->ports
) {
1680 if (!p
->event_source
)
1683 r
= sd_event_source_set_enabled(p
->event_source
, SD_EVENT_OFF
);
1685 log_unit_debug_errno(UNIT(s
), r
, "Failed to disable event source: %m");
1689 static int socket_watch_fds(Socket
*s
) {
1695 LIST_FOREACH(port
, p
, s
->ports
) {
1699 if (p
->event_source
) {
1700 r
= sd_event_source_set_enabled(p
->event_source
, SD_EVENT_ON
);
1704 r
= sd_event_add_io(UNIT(s
)->manager
->event
, &p
->event_source
, p
->fd
, EPOLLIN
, socket_dispatch_io
, p
);
1708 (void) sd_event_source_set_description(p
->event_source
, "socket-port-io");
1715 log_unit_warning_errno(UNIT(s
), r
, "Failed to watch listening fds: %m");
1716 socket_unwatch_fds(s
);
1726 static int socket_check_open(Socket
*s
) {
1727 bool have_open
= false, have_closed
= false;
1732 LIST_FOREACH(port
, p
, s
->ports
) {
1738 if (have_open
&& have_closed
)
1739 return SOCKET_OPEN_SOME
;
1743 return SOCKET_OPEN_ALL
;
1745 return SOCKET_OPEN_NONE
;
1748 static void socket_set_state(Socket
*s
, SocketState state
) {
1749 SocketState old_state
;
1752 if (s
->state
!= state
)
1753 bus_unit_send_pending_change_signal(UNIT(s
), false);
1755 old_state
= s
->state
;
1763 SOCKET_STOP_PRE_SIGTERM
,
1764 SOCKET_STOP_PRE_SIGKILL
,
1766 SOCKET_FINAL_SIGTERM
,
1767 SOCKET_FINAL_SIGKILL
)) {
1769 s
->timer_event_source
= sd_event_source_unref(s
->timer_event_source
);
1770 socket_unwatch_control_pid(s
);
1771 s
->control_command
= NULL
;
1772 s
->control_command_id
= _SOCKET_EXEC_COMMAND_INVALID
;
1775 if (state
!= SOCKET_LISTENING
)
1776 socket_unwatch_fds(s
);
1784 SOCKET_STOP_PRE_SIGTERM
,
1785 SOCKET_STOP_PRE_SIGKILL
))
1786 socket_close_fds(s
);
1788 if (state
!= old_state
)
1789 log_unit_debug(UNIT(s
), "Changed %s -> %s", socket_state_to_string(old_state
), socket_state_to_string(state
));
1791 unit_notify(UNIT(s
), state_translation_table
[old_state
], state_translation_table
[state
], 0);
1794 static int socket_coldplug(Unit
*u
) {
1795 Socket
*s
= SOCKET(u
);
1799 assert(s
->state
== SOCKET_DEAD
);
1801 if (s
->deserialized_state
== s
->state
)
1804 if (s
->control_pid
> 0 &&
1805 pid_is_unwaited(s
->control_pid
) &&
1806 IN_SET(s
->deserialized_state
,
1811 SOCKET_STOP_PRE_SIGTERM
,
1812 SOCKET_STOP_PRE_SIGKILL
,
1814 SOCKET_FINAL_SIGTERM
,
1815 SOCKET_FINAL_SIGKILL
)) {
1817 r
= unit_watch_pid(UNIT(s
), s
->control_pid
);
1821 r
= socket_arm_timer(s
, usec_add(u
->state_change_timestamp
.monotonic
, s
->timeout_usec
));
1826 if (IN_SET(s
->deserialized_state
,
1832 /* Originally, we used to simply reopen all sockets here that we didn't have file descriptors
1833 * for. However, this is problematic, as we won't traverse throught the SOCKET_START_CHOWN state for
1834 * them, and thus the UID/GID wouldn't be right. Hence, instead simply check if we have all fds open,
1835 * and if there's a mismatch, warn loudly. */
1837 r
= socket_check_open(s
);
1838 if (r
== SOCKET_OPEN_NONE
)
1839 log_unit_warning(UNIT(s
),
1840 "Socket unit configuration has changed while unit has been running, "
1841 "no open socket file descriptor left. "
1842 "The socket unit is not functional until restarted.");
1843 else if (r
== SOCKET_OPEN_SOME
)
1844 log_unit_warning(UNIT(s
),
1845 "Socket unit configuration has changed while unit has been running, "
1846 "and some socket file descriptors have not been opened yet. "
1847 "The socket unit is not fully functional until restarted.");
1850 if (s
->deserialized_state
== SOCKET_LISTENING
) {
1851 r
= socket_watch_fds(s
);
1856 if (!IN_SET(s
->deserialized_state
, SOCKET_DEAD
, SOCKET_FAILED
)) {
1857 (void) unit_setup_dynamic_creds(u
);
1858 (void) unit_setup_exec_runtime(u
);
1861 socket_set_state(s
, s
->deserialized_state
);
1865 static int socket_spawn(Socket
*s
, ExecCommand
*c
, pid_t
*_pid
) {
1867 _cleanup_(exec_params_clear
) ExecParameters exec_params
= {
1868 .flags
= EXEC_APPLY_SANDBOXING
|EXEC_APPLY_CHROOT
|EXEC_APPLY_TTY_STDIN
,
1881 r
= unit_prepare_exec(UNIT(s
));
1885 r
= socket_arm_timer(s
, usec_add(now(CLOCK_MONOTONIC
), s
->timeout_usec
));
1889 r
= unit_set_exec_params(UNIT(s
), &exec_params
);
1893 r
= exec_spawn(UNIT(s
),
1903 r
= unit_watch_pid(UNIT(s
), pid
);
1905 /* FIXME: we need to do something here */
1913 static int socket_chown(Socket
*s
, pid_t
*_pid
) {
1917 r
= socket_arm_timer(s
, usec_add(now(CLOCK_MONOTONIC
), s
->timeout_usec
));
1921 /* We have to resolve the user names out-of-process, hence
1922 * let's fork here. It's messy, but well, what can we do? */
1924 r
= unit_fork_helper_process(UNIT(s
), "(sd-chown)", &pid
);
1928 uid_t uid
= UID_INVALID
;
1929 gid_t gid
= GID_INVALID
;
1934 if (!isempty(s
->user
)) {
1935 const char *user
= s
->user
;
1937 r
= get_user_creds(&user
, &uid
, &gid
, NULL
, NULL
, 0);
1939 log_unit_error_errno(UNIT(s
), r
, "Failed to resolve user %s: %m", user
);
1944 if (!isempty(s
->group
)) {
1945 const char *group
= s
->group
;
1947 r
= get_group_creds(&group
, &gid
, 0);
1949 log_unit_error_errno(UNIT(s
), r
, "Failed to resolve group %s: %m", group
);
1954 LIST_FOREACH(port
, p
, s
->ports
) {
1955 const char *path
= NULL
;
1957 if (p
->type
== SOCKET_SOCKET
)
1958 path
= socket_address_get_path(&p
->address
);
1959 else if (p
->type
== SOCKET_FIFO
)
1965 if (chown(path
, uid
, gid
) < 0) {
1966 log_unit_error_errno(UNIT(s
), errno
, "Failed to chown(): %m");
1971 _exit(EXIT_SUCCESS
);
1974 r
= unit_watch_pid(UNIT(s
), pid
);
1982 s
->timer_event_source
= sd_event_source_unref(s
->timer_event_source
);
1986 static void socket_enter_dead(Socket
*s
, SocketResult f
) {
1989 if (s
->result
== SOCKET_SUCCESS
)
1992 if (s
->result
== SOCKET_SUCCESS
)
1993 unit_log_success(UNIT(s
));
1995 unit_log_failure(UNIT(s
), socket_result_to_string(s
->result
));
1997 socket_set_state(s
, s
->result
!= SOCKET_SUCCESS
? SOCKET_FAILED
: SOCKET_DEAD
);
1999 s
->exec_runtime
= exec_runtime_unref(s
->exec_runtime
, true);
2001 exec_context_destroy_runtime_directory(&s
->exec_context
, UNIT(s
)->manager
->prefix
[EXEC_DIRECTORY_RUNTIME
]);
2003 unit_unref_uid_gid(UNIT(s
), true);
2005 dynamic_creds_destroy(&s
->dynamic_creds
);
2008 static void socket_enter_signal(Socket
*s
, SocketState state
, SocketResult f
);
2010 static void socket_enter_stop_post(Socket
*s
, SocketResult f
) {
2014 if (s
->result
== SOCKET_SUCCESS
)
2017 socket_unwatch_control_pid(s
);
2018 s
->control_command_id
= SOCKET_EXEC_STOP_POST
;
2019 s
->control_command
= s
->exec_command
[SOCKET_EXEC_STOP_POST
];
2021 if (s
->control_command
) {
2022 r
= socket_spawn(s
, s
->control_command
, &s
->control_pid
);
2026 socket_set_state(s
, SOCKET_STOP_POST
);
2028 socket_enter_signal(s
, SOCKET_FINAL_SIGTERM
, SOCKET_SUCCESS
);
2033 log_unit_warning_errno(UNIT(s
), r
, "Failed to run 'stop-post' task: %m");
2034 socket_enter_signal(s
, SOCKET_FINAL_SIGTERM
, SOCKET_FAILURE_RESOURCES
);
2037 static void socket_enter_signal(Socket
*s
, SocketState state
, SocketResult f
) {
2042 if (s
->result
== SOCKET_SUCCESS
)
2045 r
= unit_kill_context(
2048 !IN_SET(state
, SOCKET_STOP_PRE_SIGTERM
, SOCKET_FINAL_SIGTERM
) ?
2049 KILL_KILL
: KILL_TERMINATE
,
2057 r
= socket_arm_timer(s
, usec_add(now(CLOCK_MONOTONIC
), s
->timeout_usec
));
2061 socket_set_state(s
, state
);
2062 } else if (state
== SOCKET_STOP_PRE_SIGTERM
)
2063 socket_enter_signal(s
, SOCKET_STOP_PRE_SIGKILL
, SOCKET_SUCCESS
);
2064 else if (state
== SOCKET_STOP_PRE_SIGKILL
)
2065 socket_enter_stop_post(s
, SOCKET_SUCCESS
);
2066 else if (state
== SOCKET_FINAL_SIGTERM
)
2067 socket_enter_signal(s
, SOCKET_FINAL_SIGKILL
, SOCKET_SUCCESS
);
2069 socket_enter_dead(s
, SOCKET_SUCCESS
);
2074 log_unit_warning_errno(UNIT(s
), r
, "Failed to kill processes: %m");
2076 if (IN_SET(state
, SOCKET_STOP_PRE_SIGTERM
, SOCKET_STOP_PRE_SIGKILL
))
2077 socket_enter_stop_post(s
, SOCKET_FAILURE_RESOURCES
);
2079 socket_enter_dead(s
, SOCKET_FAILURE_RESOURCES
);
2082 static void socket_enter_stop_pre(Socket
*s
, SocketResult f
) {
2086 if (s
->result
== SOCKET_SUCCESS
)
2089 socket_unwatch_control_pid(s
);
2090 s
->control_command_id
= SOCKET_EXEC_STOP_PRE
;
2091 s
->control_command
= s
->exec_command
[SOCKET_EXEC_STOP_PRE
];
2093 if (s
->control_command
) {
2094 r
= socket_spawn(s
, s
->control_command
, &s
->control_pid
);
2098 socket_set_state(s
, SOCKET_STOP_PRE
);
2100 socket_enter_stop_post(s
, SOCKET_SUCCESS
);
2105 log_unit_warning_errno(UNIT(s
), r
, "Failed to run 'stop-pre' task: %m");
2106 socket_enter_stop_post(s
, SOCKET_FAILURE_RESOURCES
);
2109 static void socket_enter_listening(Socket
*s
) {
2113 r
= socket_watch_fds(s
);
2115 log_unit_warning_errno(UNIT(s
), r
, "Failed to watch sockets: %m");
2119 socket_set_state(s
, SOCKET_LISTENING
);
2123 socket_enter_stop_pre(s
, SOCKET_FAILURE_RESOURCES
);
2126 static void socket_enter_start_post(Socket
*s
) {
2130 socket_unwatch_control_pid(s
);
2131 s
->control_command_id
= SOCKET_EXEC_START_POST
;
2132 s
->control_command
= s
->exec_command
[SOCKET_EXEC_START_POST
];
2134 if (s
->control_command
) {
2135 r
= socket_spawn(s
, s
->control_command
, &s
->control_pid
);
2137 log_unit_warning_errno(UNIT(s
), r
, "Failed to run 'start-post' task: %m");
2141 socket_set_state(s
, SOCKET_START_POST
);
2143 socket_enter_listening(s
);
2148 socket_enter_stop_pre(s
, SOCKET_FAILURE_RESOURCES
);
2151 static void socket_enter_start_chown(Socket
*s
) {
2156 r
= socket_open_fds(s
);
2158 log_unit_warning_errno(UNIT(s
), r
, "Failed to listen on sockets: %m");
2162 if (!isempty(s
->user
) || !isempty(s
->group
)) {
2164 socket_unwatch_control_pid(s
);
2165 s
->control_command_id
= SOCKET_EXEC_START_CHOWN
;
2166 s
->control_command
= NULL
;
2168 r
= socket_chown(s
, &s
->control_pid
);
2170 log_unit_warning_errno(UNIT(s
), r
, "Failed to fork 'start-chown' task: %m");
2174 socket_set_state(s
, SOCKET_START_CHOWN
);
2176 socket_enter_start_post(s
);
2181 socket_enter_stop_pre(s
, SOCKET_FAILURE_RESOURCES
);
2184 static void socket_enter_start_pre(Socket
*s
) {
2188 socket_unwatch_control_pid(s
);
2190 unit_warn_leftover_processes(UNIT(s
));
2192 s
->control_command_id
= SOCKET_EXEC_START_PRE
;
2193 s
->control_command
= s
->exec_command
[SOCKET_EXEC_START_PRE
];
2195 if (s
->control_command
) {
2196 r
= socket_spawn(s
, s
->control_command
, &s
->control_pid
);
2198 log_unit_warning_errno(UNIT(s
), r
, "Failed to run 'start-pre' task: %m");
2202 socket_set_state(s
, SOCKET_START_PRE
);
2204 socket_enter_start_chown(s
);
2209 socket_enter_dead(s
, SOCKET_FAILURE_RESOURCES
);
2212 static void flush_ports(Socket
*s
) {
2215 /* Flush all incoming traffic, regardless if actual bytes or new connections, so that this socket isn't busy
2218 LIST_FOREACH(port
, p
, s
->ports
) {
2222 (void) flush_accept(p
->fd
);
2223 (void) flush_fd(p
->fd
);
2227 static void socket_enter_running(Socket
*s
, int cfd
) {
2228 _cleanup_(sd_bus_error_free
) sd_bus_error error
= SD_BUS_ERROR_NULL
;
2231 /* Note that this call takes possession of the connection fd passed. It either has to assign it somewhere or
2236 /* We don't take connections anymore if we are supposed to shut down anyway */
2237 if (unit_stop_pending(UNIT(s
))) {
2239 log_unit_debug(UNIT(s
), "Suppressing connection request since unit stop is scheduled.");
2249 if (!ratelimit_below(&s
->trigger_limit
)) {
2250 log_unit_warning(UNIT(s
), "Trigger limit hit, refusing further activation.");
2251 socket_enter_stop_pre(s
, SOCKET_FAILURE_TRIGGER_LIMIT_HIT
);
2256 bool pending
= false;
2261 /* If there's already a start pending don't bother to
2263 HASHMAP_FOREACH_KEY(v
, other
, UNIT(s
)->dependencies
[UNIT_TRIGGERS
], i
)
2264 if (unit_active_or_pending(other
)) {
2270 if (!UNIT_ISSET(s
->service
)) {
2271 log_unit_error(UNIT(s
), "Service to activate vanished, refusing activation.");
2276 r
= manager_add_job(UNIT(s
)->manager
, JOB_START
, UNIT_DEREF(s
->service
), JOB_REPLACE
, &error
, NULL
);
2281 socket_set_state(s
, SOCKET_RUNNING
);
2283 _cleanup_free_
char *prefix
= NULL
, *instance
= NULL
, *name
= NULL
;
2284 _cleanup_(socket_peer_unrefp
) SocketPeer
*p
= NULL
;
2287 if (s
->n_connections
>= s
->max_connections
) {
2288 log_unit_warning(UNIT(s
), "Too many incoming connections (%u), dropping connection.",
2293 if (s
->max_connections_per_source
> 0) {
2294 r
= socket_acquire_peer(s
, cfd
, &p
);
2297 } else if (r
> 0 && p
->n_ref
> s
->max_connections_per_source
) {
2298 _cleanup_free_
char *t
= NULL
;
2300 (void) sockaddr_pretty(&p
->peer
.sa
, p
->peer_salen
, true, false, &t
);
2302 log_unit_warning(UNIT(s
),
2303 "Too many incoming connections (%u) from source %s, dropping connection.",
2304 p
->n_ref
, strnull(t
));
2309 r
= socket_instantiate_service(s
);
2313 r
= instance_from_socket(cfd
, s
->n_accepted
, &instance
);
2318 /* ENOTCONN is legitimate if TCP RST was received.
2319 * This connection is over, but the socket unit lives on. */
2320 log_unit_debug(UNIT(s
), "Got ENOTCONN on incoming socket, assuming aborted connection attempt, ignoring.");
2324 r
= unit_name_to_prefix(UNIT(s
)->id
, &prefix
);
2328 r
= unit_name_build(prefix
, instance
, ".service", &name
);
2332 r
= unit_add_name(UNIT_DEREF(s
->service
), name
);
2336 service
= SERVICE(UNIT_DEREF(s
->service
));
2337 unit_ref_unset(&s
->service
);
2340 unit_choose_id(UNIT(service
), name
);
2342 r
= service_set_socket_fd(service
, cfd
, s
, s
->selinux_context_from_net
);
2346 cfd
= -1; /* We passed ownership of the fd to the service now. Forget it here. */
2349 service
->peer
= TAKE_PTR(p
); /* Pass ownership of the peer reference */
2351 r
= manager_add_job(UNIT(s
)->manager
, JOB_START
, UNIT(service
), JOB_REPLACE
, &error
, NULL
);
2353 /* We failed to activate the new service, but it still exists. Let's make sure the service
2354 * closes and forgets the connection fd again, immediately. */
2355 service_close_socket_fd(service
);
2359 /* Notify clients about changed counters */
2360 unit_add_to_dbus_queue(UNIT(s
));
2371 log_unit_warning(UNIT(s
), "Failed to queue service startup job (Maybe the service file is missing or not a %s unit?): %s",
2372 cfd
>= 0 ? "template" : "non-template",
2373 bus_error_message(&error
, r
));
2375 socket_enter_stop_pre(s
, SOCKET_FAILURE_RESOURCES
);
2379 static void socket_run_next(Socket
*s
) {
2383 assert(s
->control_command
);
2384 assert(s
->control_command
->command_next
);
2386 socket_unwatch_control_pid(s
);
2388 s
->control_command
= s
->control_command
->command_next
;
2390 r
= socket_spawn(s
, s
->control_command
, &s
->control_pid
);
2397 log_unit_warning_errno(UNIT(s
), r
, "Failed to run next task: %m");
2399 if (s
->state
== SOCKET_START_POST
)
2400 socket_enter_stop_pre(s
, SOCKET_FAILURE_RESOURCES
);
2401 else if (s
->state
== SOCKET_STOP_POST
)
2402 socket_enter_dead(s
, SOCKET_FAILURE_RESOURCES
);
2404 socket_enter_signal(s
, SOCKET_FINAL_SIGTERM
, SOCKET_FAILURE_RESOURCES
);
2407 static int socket_start(Unit
*u
) {
2408 Socket
*s
= SOCKET(u
);
2413 /* We cannot fulfill this request right now, try again later
2415 if (IN_SET(s
->state
,
2417 SOCKET_STOP_PRE_SIGKILL
,
2418 SOCKET_STOP_PRE_SIGTERM
,
2420 SOCKET_FINAL_SIGTERM
,
2421 SOCKET_FINAL_SIGKILL
))
2424 /* Already on it! */
2425 if (IN_SET(s
->state
,
2431 /* Cannot run this without the service being around */
2432 if (UNIT_ISSET(s
->service
)) {
2435 service
= SERVICE(UNIT_DEREF(s
->service
));
2437 if (UNIT(service
)->load_state
!= UNIT_LOADED
) {
2438 log_unit_error(u
, "Socket service %s not loaded, refusing.", UNIT(service
)->id
);
2442 /* If the service is already active we cannot start the
2444 if (!IN_SET(service
->state
, SERVICE_DEAD
, SERVICE_FAILED
, SERVICE_AUTO_RESTART
)) {
2445 log_unit_error(u
, "Socket service %s already active, refusing.", UNIT(service
)->id
);
2450 assert(IN_SET(s
->state
, SOCKET_DEAD
, SOCKET_FAILED
));
2452 r
= unit_start_limit_test(u
);
2454 socket_enter_dead(s
, SOCKET_FAILURE_START_LIMIT_HIT
);
2458 r
= unit_acquire_invocation_id(u
);
2462 s
->result
= SOCKET_SUCCESS
;
2463 exec_command_reset_status_list_array(s
->exec_command
, _SOCKET_EXEC_COMMAND_MAX
);
2465 u
->reset_accounting
= true;
2467 socket_enter_start_pre(s
);
2471 static int socket_stop(Unit
*u
) {
2472 Socket
*s
= SOCKET(u
);
2477 if (IN_SET(s
->state
,
2479 SOCKET_STOP_PRE_SIGTERM
,
2480 SOCKET_STOP_PRE_SIGKILL
,
2482 SOCKET_FINAL_SIGTERM
,
2483 SOCKET_FINAL_SIGKILL
))
2486 /* If there's already something running we go directly into
2488 if (IN_SET(s
->state
,
2491 SOCKET_START_POST
)) {
2492 socket_enter_signal(s
, SOCKET_STOP_PRE_SIGTERM
, SOCKET_SUCCESS
);
2496 assert(IN_SET(s
->state
, SOCKET_LISTENING
, SOCKET_RUNNING
));
2498 socket_enter_stop_pre(s
, SOCKET_SUCCESS
);
2502 static int socket_serialize(Unit
*u
, FILE *f
, FDSet
*fds
) {
2503 Socket
*s
= SOCKET(u
);
2511 (void) serialize_item(f
, "state", socket_state_to_string(s
->state
));
2512 (void) serialize_item(f
, "result", socket_result_to_string(s
->result
));
2513 (void) serialize_item_format(f
, "n-accepted", "%u", s
->n_accepted
);
2514 (void) serialize_item_format(f
, "n-refused", "%u", s
->n_refused
);
2516 if (s
->control_pid
> 0)
2517 (void) serialize_item_format(f
, "control-pid", PID_FMT
, s
->control_pid
);
2519 if (s
->control_command_id
>= 0)
2520 (void) serialize_item(f
, "control-command", socket_exec_command_to_string(s
->control_command_id
));
2522 LIST_FOREACH(port
, p
, s
->ports
) {
2528 copy
= fdset_put_dup(fds
, p
->fd
);
2530 return log_warning_errno(copy
, "Failed to serialize socket fd: %m");
2532 if (p
->type
== SOCKET_SOCKET
) {
2533 _cleanup_free_
char *t
= NULL
;
2535 r
= socket_address_print(&p
->address
, &t
);
2537 return log_error_errno(r
, "Failed to format socket address: %m");
2539 if (socket_address_family(&p
->address
) == AF_NETLINK
)
2540 (void) serialize_item_format(f
, "netlink", "%i %s", copy
, t
);
2542 (void) serialize_item_format(f
, "socket", "%i %i %s", copy
, p
->address
.type
, t
);
2543 } else if (p
->type
== SOCKET_SPECIAL
)
2544 (void) serialize_item_format(f
, "special", "%i %s", copy
, p
->path
);
2545 else if (p
->type
== SOCKET_MQUEUE
)
2546 (void) serialize_item_format(f
, "mqueue", "%i %s", copy
, p
->path
);
2547 else if (p
->type
== SOCKET_USB_FUNCTION
)
2548 (void) serialize_item_format(f
, "ffs", "%i %s", copy
, p
->path
);
2550 assert(p
->type
== SOCKET_FIFO
);
2551 (void) serialize_item_format(f
, "fifo", "%i %s", copy
, p
->path
);
2558 static void socket_port_take_fd(SocketPort
*p
, FDSet
*fds
, int fd
) {
2562 p
->fd
= fdset_remove(fds
, fd
);
2565 static int socket_deserialize_item(Unit
*u
, const char *key
, const char *value
, FDSet
*fds
) {
2566 Socket
*s
= SOCKET(u
);
2572 if (streq(key
, "state")) {
2575 state
= socket_state_from_string(value
);
2577 log_unit_debug(u
, "Failed to parse state value: %s", value
);
2579 s
->deserialized_state
= state
;
2580 } else if (streq(key
, "result")) {
2583 f
= socket_result_from_string(value
);
2585 log_unit_debug(u
, "Failed to parse result value: %s", value
);
2586 else if (f
!= SOCKET_SUCCESS
)
2589 } else if (streq(key
, "n-accepted")) {
2592 if (safe_atou(value
, &k
) < 0)
2593 log_unit_debug(u
, "Failed to parse n-accepted value: %s", value
);
2596 } else if (streq(key
, "n-refused")) {
2599 if (safe_atou(value
, &k
) < 0)
2600 log_unit_debug(u
, "Failed to parse n-refused value: %s", value
);
2603 } else if (streq(key
, "control-pid")) {
2606 if (parse_pid(value
, &pid
) < 0)
2607 log_unit_debug(u
, "Failed to parse control-pid value: %s", value
);
2609 s
->control_pid
= pid
;
2610 } else if (streq(key
, "control-command")) {
2611 SocketExecCommand id
;
2613 id
= socket_exec_command_from_string(value
);
2615 log_unit_debug(u
, "Failed to parse exec-command value: %s", value
);
2617 s
->control_command_id
= id
;
2618 s
->control_command
= s
->exec_command
[id
];
2620 } else if (streq(key
, "fifo")) {
2624 if (sscanf(value
, "%i %n", &fd
, &skip
) < 1 || fd
< 0 || !fdset_contains(fds
, fd
))
2625 log_unit_debug(u
, "Failed to parse fifo value: %s", value
);
2627 LIST_FOREACH(port
, p
, s
->ports
)
2628 if (p
->type
== SOCKET_FIFO
&&
2629 path_equal_or_files_same(p
->path
, value
+skip
, 0)) {
2630 socket_port_take_fd(p
, fds
, fd
);
2634 } else if (streq(key
, "special")) {
2638 if (sscanf(value
, "%i %n", &fd
, &skip
) < 1 || fd
< 0 || !fdset_contains(fds
, fd
))
2639 log_unit_debug(u
, "Failed to parse special value: %s", value
);
2641 LIST_FOREACH(port
, p
, s
->ports
)
2642 if (p
->type
== SOCKET_SPECIAL
&&
2643 path_equal_or_files_same(p
->path
, value
+skip
, 0)) {
2644 socket_port_take_fd(p
, fds
, fd
);
2648 } else if (streq(key
, "mqueue")) {
2652 if (sscanf(value
, "%i %n", &fd
, &skip
) < 1 || fd
< 0 || !fdset_contains(fds
, fd
))
2653 log_unit_debug(u
, "Failed to parse mqueue value: %s", value
);
2655 LIST_FOREACH(port
, p
, s
->ports
)
2656 if (p
->type
== SOCKET_MQUEUE
&&
2657 streq(p
->path
, value
+skip
)) {
2658 socket_port_take_fd(p
, fds
, fd
);
2662 } else if (streq(key
, "socket")) {
2663 int fd
, type
, skip
= 0;
2666 if (sscanf(value
, "%i %i %n", &fd
, &type
, &skip
) < 2 || fd
< 0 || type
< 0 || !fdset_contains(fds
, fd
))
2667 log_unit_debug(u
, "Failed to parse socket value: %s", value
);
2669 LIST_FOREACH(port
, p
, s
->ports
)
2670 if (socket_address_is(&p
->address
, value
+skip
, type
)) {
2671 socket_port_take_fd(p
, fds
, fd
);
2675 } else if (streq(key
, "netlink")) {
2679 if (sscanf(value
, "%i %n", &fd
, &skip
) < 1 || fd
< 0 || !fdset_contains(fds
, fd
))
2680 log_unit_debug(u
, "Failed to parse socket value: %s", value
);
2682 LIST_FOREACH(port
, p
, s
->ports
)
2683 if (socket_address_is_netlink(&p
->address
, value
+skip
)) {
2684 socket_port_take_fd(p
, fds
, fd
);
2688 } else if (streq(key
, "ffs")) {
2692 if (sscanf(value
, "%i %n", &fd
, &skip
) < 1 || fd
< 0 || !fdset_contains(fds
, fd
))
2693 log_unit_debug(u
, "Failed to parse ffs value: %s", value
);
2695 LIST_FOREACH(port
, p
, s
->ports
)
2696 if (p
->type
== SOCKET_USB_FUNCTION
&&
2697 path_equal_or_files_same(p
->path
, value
+skip
, 0)) {
2698 socket_port_take_fd(p
, fds
, fd
);
2703 log_unit_debug(UNIT(s
), "Unknown serialization key: %s", key
);
2708 static void socket_distribute_fds(Unit
*u
, FDSet
*fds
) {
2709 Socket
*s
= SOCKET(u
);
2714 LIST_FOREACH(port
, p
, s
->ports
) {
2718 if (p
->type
!= SOCKET_SOCKET
)
2724 FDSET_FOREACH(fd
, fds
, i
) {
2725 if (socket_address_matches_fd(&p
->address
, fd
)) {
2726 p
->fd
= fdset_remove(fds
, fd
);
2727 s
->deserialized_state
= SOCKET_LISTENING
;
2734 _pure_
static UnitActiveState
socket_active_state(Unit
*u
) {
2737 return state_translation_table
[SOCKET(u
)->state
];
2740 _pure_
static const char *socket_sub_state_to_string(Unit
*u
) {
2743 return socket_state_to_string(SOCKET(u
)->state
);
2746 const char* socket_port_type_to_string(SocketPort
*p
) {
2754 switch (p
->address
.type
) {
2762 case SOCK_SEQPACKET
:
2763 return "SequentialPacket";
2766 if (socket_address_family(&p
->address
) == AF_NETLINK
)
2774 case SOCKET_SPECIAL
:
2778 return "MessageQueue";
2783 case SOCKET_USB_FUNCTION
:
2784 return "USBFunction";
2791 SocketType
socket_port_type_from_string(const char *s
) {
2794 if (STR_IN_SET(s
, "Stream", "Datagram", "SequentialPacket", "Netlink"))
2795 return SOCKET_SOCKET
;
2796 else if (streq(s
, "Special"))
2797 return SOCKET_SPECIAL
;
2798 else if (streq(s
, "MessageQueue"))
2799 return SOCKET_MQUEUE
;
2800 else if (streq(s
, "FIFO"))
2802 else if (streq(s
, "USBFunction"))
2803 return SOCKET_USB_FUNCTION
;
2805 return _SOCKET_TYPE_INVALID
;
2808 _pure_
static bool socket_may_gc(Unit
*u
) {
2809 Socket
*s
= SOCKET(u
);
2813 return s
->n_connections
== 0;
2816 static int socket_accept_do(Socket
*s
, int fd
) {
2823 cfd
= accept4(fd
, NULL
, NULL
, SOCK_NONBLOCK
);
2837 static int socket_accept_in_cgroup(Socket
*s
, SocketPort
*p
, int fd
) {
2838 _cleanup_close_pair_
int pair
[2] = { -1, -1 };
2846 /* Similar to socket_address_listen_in_cgroup(), but for accept() rathern than socket(): make sure that any
2847 * connection socket is also properly associated with the cgroup. */
2849 if (!IN_SET(p
->address
.sockaddr
.sa
.sa_family
, AF_INET
, AF_INET6
))
2852 r
= bpf_firewall_supported();
2855 if (r
== BPF_FIREWALL_UNSUPPORTED
)
2858 if (socketpair(AF_UNIX
, SOCK_SEQPACKET
|SOCK_CLOEXEC
, 0, pair
) < 0)
2859 return log_unit_error_errno(UNIT(s
), errno
, "Failed to create communication channel: %m");
2861 r
= unit_fork_helper_process(UNIT(s
), "(sd-accept)", &pid
);
2863 return log_unit_error_errno(UNIT(s
), r
, "Failed to fork off accept stub process: %m");
2867 pair
[0] = safe_close(pair
[0]);
2869 cfd
= socket_accept_do(s
, fd
);
2871 log_unit_error_errno(UNIT(s
), cfd
, "Failed to accept connection socket: %m");
2872 _exit(EXIT_FAILURE
);
2875 r
= send_one_fd(pair
[1], cfd
, 0);
2877 log_unit_error_errno(UNIT(s
), r
, "Failed to send connection socket to parent: %m");
2878 _exit(EXIT_FAILURE
);
2881 _exit(EXIT_SUCCESS
);
2884 pair
[1] = safe_close(pair
[1]);
2885 cfd
= receive_one_fd(pair
[0], 0);
2887 /* We synchronously wait for the helper, as it shouldn't be slow */
2888 r
= wait_for_terminate_and_check("(sd-accept)", pid
, WAIT_LOG_ABNORMAL
);
2895 return log_unit_error_errno(UNIT(s
), cfd
, "Failed to receive connection socket: %m");
2900 cfd
= socket_accept_do(s
, fd
);
2902 return log_unit_error_errno(UNIT(s
), cfd
, "Failed to accept connection socket: %m");
2907 static int socket_dispatch_io(sd_event_source
*source
, int fd
, uint32_t revents
, void *userdata
) {
2908 SocketPort
*p
= userdata
;
2914 if (p
->socket
->state
!= SOCKET_LISTENING
)
2917 log_unit_debug(UNIT(p
->socket
), "Incoming traffic");
2919 if (revents
!= EPOLLIN
) {
2921 if (revents
& EPOLLHUP
)
2922 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.");
2924 log_unit_error(UNIT(p
->socket
), "Got unexpected poll event (0x%x) on socket.", revents
);
2928 if (p
->socket
->accept
&&
2929 p
->type
== SOCKET_SOCKET
&&
2930 socket_address_can_accept(&p
->address
)) {
2932 cfd
= socket_accept_in_cgroup(p
->socket
, p
, fd
);
2936 socket_apply_socket_options(p
->socket
, cfd
);
2939 socket_enter_running(p
->socket
, cfd
);
2943 socket_enter_stop_pre(p
->socket
, SOCKET_FAILURE_RESOURCES
);
2947 static void socket_sigchld_event(Unit
*u
, pid_t pid
, int code
, int status
) {
2948 Socket
*s
= SOCKET(u
);
2954 if (pid
!= s
->control_pid
)
2959 if (is_clean_exit(code
, status
, EXIT_CLEAN_COMMAND
, NULL
))
2961 else if (code
== CLD_EXITED
)
2962 f
= SOCKET_FAILURE_EXIT_CODE
;
2963 else if (code
== CLD_KILLED
)
2964 f
= SOCKET_FAILURE_SIGNAL
;
2965 else if (code
== CLD_DUMPED
)
2966 f
= SOCKET_FAILURE_CORE_DUMP
;
2968 assert_not_reached("Unknown sigchld code");
2970 if (s
->control_command
) {
2971 exec_status_exit(&s
->control_command
->exec_status
, &s
->exec_context
, pid
, code
, status
);
2973 if (s
->control_command
->flags
& EXEC_COMMAND_IGNORE_FAILURE
)
2977 unit_log_process_exit(
2978 u
, f
== SOCKET_SUCCESS
? LOG_DEBUG
: LOG_NOTICE
,
2980 socket_exec_command_to_string(s
->control_command_id
),
2983 if (s
->result
== SOCKET_SUCCESS
)
2986 if (s
->control_command
&&
2987 s
->control_command
->command_next
&&
2988 f
== SOCKET_SUCCESS
) {
2990 log_unit_debug(u
, "Running next command for state %s", socket_state_to_string(s
->state
));
2993 s
->control_command
= NULL
;
2994 s
->control_command_id
= _SOCKET_EXEC_COMMAND_INVALID
;
2996 /* No further commands for this step, so let's figure
2997 * out what to do next */
2999 log_unit_debug(u
, "Got final SIGCHLD for state %s", socket_state_to_string(s
->state
));
3003 case SOCKET_START_PRE
:
3004 if (f
== SOCKET_SUCCESS
)
3005 socket_enter_start_chown(s
);
3007 socket_enter_signal(s
, SOCKET_FINAL_SIGTERM
, f
);
3010 case SOCKET_START_CHOWN
:
3011 if (f
== SOCKET_SUCCESS
)
3012 socket_enter_start_post(s
);
3014 socket_enter_stop_pre(s
, f
);
3017 case SOCKET_START_POST
:
3018 if (f
== SOCKET_SUCCESS
)
3019 socket_enter_listening(s
);
3021 socket_enter_stop_pre(s
, f
);
3024 case SOCKET_STOP_PRE
:
3025 case SOCKET_STOP_PRE_SIGTERM
:
3026 case SOCKET_STOP_PRE_SIGKILL
:
3027 socket_enter_stop_post(s
, f
);
3030 case SOCKET_STOP_POST
:
3031 case SOCKET_FINAL_SIGTERM
:
3032 case SOCKET_FINAL_SIGKILL
:
3033 socket_enter_dead(s
, f
);
3037 assert_not_reached("Uh, control process died at wrong time.");
3041 /* Notify clients about changed exit status */
3042 unit_add_to_dbus_queue(u
);
3045 static int socket_dispatch_timer(sd_event_source
*source
, usec_t usec
, void *userdata
) {
3046 Socket
*s
= SOCKET(userdata
);
3049 assert(s
->timer_event_source
== source
);
3053 case SOCKET_START_PRE
:
3054 log_unit_warning(UNIT(s
), "Starting timed out. Terminating.");
3055 socket_enter_signal(s
, SOCKET_FINAL_SIGTERM
, SOCKET_FAILURE_TIMEOUT
);
3058 case SOCKET_START_CHOWN
:
3059 case SOCKET_START_POST
:
3060 log_unit_warning(UNIT(s
), "Starting timed out. Stopping.");
3061 socket_enter_stop_pre(s
, SOCKET_FAILURE_TIMEOUT
);
3064 case SOCKET_STOP_PRE
:
3065 log_unit_warning(UNIT(s
), "Stopping timed out. Terminating.");
3066 socket_enter_signal(s
, SOCKET_STOP_PRE_SIGTERM
, SOCKET_FAILURE_TIMEOUT
);
3069 case SOCKET_STOP_PRE_SIGTERM
:
3070 if (s
->kill_context
.send_sigkill
) {
3071 log_unit_warning(UNIT(s
), "Stopping timed out. Killing.");
3072 socket_enter_signal(s
, SOCKET_STOP_PRE_SIGKILL
, SOCKET_FAILURE_TIMEOUT
);
3074 log_unit_warning(UNIT(s
), "Stopping timed out. Skipping SIGKILL. Ignoring.");
3075 socket_enter_stop_post(s
, SOCKET_FAILURE_TIMEOUT
);
3079 case SOCKET_STOP_PRE_SIGKILL
:
3080 log_unit_warning(UNIT(s
), "Processes still around after SIGKILL. Ignoring.");
3081 socket_enter_stop_post(s
, SOCKET_FAILURE_TIMEOUT
);
3084 case SOCKET_STOP_POST
:
3085 log_unit_warning(UNIT(s
), "Stopping timed out (2). Terminating.");
3086 socket_enter_signal(s
, SOCKET_FINAL_SIGTERM
, SOCKET_FAILURE_TIMEOUT
);
3089 case SOCKET_FINAL_SIGTERM
:
3090 if (s
->kill_context
.send_sigkill
) {
3091 log_unit_warning(UNIT(s
), "Stopping timed out (2). Killing.");
3092 socket_enter_signal(s
, SOCKET_FINAL_SIGKILL
, SOCKET_FAILURE_TIMEOUT
);
3094 log_unit_warning(UNIT(s
), "Stopping timed out (2). Skipping SIGKILL. Ignoring.");
3095 socket_enter_dead(s
, SOCKET_FAILURE_TIMEOUT
);
3099 case SOCKET_FINAL_SIGKILL
:
3100 log_unit_warning(UNIT(s
), "Still around after SIGKILL (2). Entering failed mode.");
3101 socket_enter_dead(s
, SOCKET_FAILURE_TIMEOUT
);
3105 assert_not_reached("Timeout at wrong time.");
3111 int socket_collect_fds(Socket
*s
, int **fds
) {
3112 size_t k
= 0, n
= 0;
3119 /* Called from the service code for requesting our fds */
3121 LIST_FOREACH(port
, p
, s
->ports
) {
3124 n
+= p
->n_auxiliary_fds
;
3136 LIST_FOREACH(port
, p
, s
->ports
) {
3141 for (i
= 0; i
< p
->n_auxiliary_fds
; ++i
)
3142 rfds
[k
++] = p
->auxiliary_fds
[i
];
3151 static void socket_reset_failed(Unit
*u
) {
3152 Socket
*s
= SOCKET(u
);
3156 if (s
->state
== SOCKET_FAILED
)
3157 socket_set_state(s
, SOCKET_DEAD
);
3159 s
->result
= SOCKET_SUCCESS
;
3162 void socket_connection_unref(Socket
*s
) {
3165 /* The service is dead. Yay!
3167 * This is strictly for one-instance-per-connection
3170 assert(s
->n_connections
> 0);
3173 log_unit_debug(UNIT(s
), "One connection closed, %u left.", s
->n_connections
);
3176 static void socket_trigger_notify(Unit
*u
, Unit
*other
) {
3177 Socket
*s
= SOCKET(u
);
3182 /* Filter out invocations with bogus state */
3183 if (other
->load_state
!= UNIT_LOADED
|| other
->type
!= UNIT_SERVICE
)
3186 /* Don't propagate state changes from the service if we are already down */
3187 if (!IN_SET(s
->state
, SOCKET_RUNNING
, SOCKET_LISTENING
))
3190 /* We don't care for the service state if we are in Accept=yes mode */
3194 /* Propagate start limit hit state */
3195 if (other
->start_limit_hit
) {
3196 socket_enter_stop_pre(s
, SOCKET_FAILURE_SERVICE_START_LIMIT_HIT
);
3200 /* Don't propagate anything if there's still a job queued */
3204 if (IN_SET(SERVICE(other
)->state
,
3205 SERVICE_DEAD
, SERVICE_FAILED
,
3206 SERVICE_FINAL_SIGTERM
, SERVICE_FINAL_SIGKILL
,
3207 SERVICE_AUTO_RESTART
))
3208 socket_enter_listening(s
);
3210 if (SERVICE(other
)->state
== SERVICE_RUNNING
)
3211 socket_set_state(s
, SOCKET_RUNNING
);
3214 static int socket_kill(Unit
*u
, KillWho who
, int signo
, sd_bus_error
*error
) {
3215 return unit_kill_common(u
, who
, signo
, -1, SOCKET(u
)->control_pid
, error
);
3218 static int socket_get_timeout(Unit
*u
, usec_t
*timeout
) {
3219 Socket
*s
= SOCKET(u
);
3223 if (!s
->timer_event_source
)
3226 r
= sd_event_source_get_time(s
->timer_event_source
, &t
);
3229 if (t
== USEC_INFINITY
)
3236 char *socket_fdname(Socket
*s
) {
3239 /* Returns the name to use for $LISTEN_NAMES. If the user
3240 * didn't specify anything specifically, use the socket unit's
3241 * name as fallback. */
3243 return s
->fdname
?: UNIT(s
)->id
;
3246 static int socket_control_pid(Unit
*u
) {
3247 Socket
*s
= SOCKET(u
);
3251 return s
->control_pid
;
3254 static const char* const socket_exec_command_table
[_SOCKET_EXEC_COMMAND_MAX
] = {
3255 [SOCKET_EXEC_START_PRE
] = "ExecStartPre",
3256 [SOCKET_EXEC_START_CHOWN
] = "ExecStartChown",
3257 [SOCKET_EXEC_START_POST
] = "ExecStartPost",
3258 [SOCKET_EXEC_STOP_PRE
] = "ExecStopPre",
3259 [SOCKET_EXEC_STOP_POST
] = "ExecStopPost"
3262 DEFINE_STRING_TABLE_LOOKUP(socket_exec_command
, SocketExecCommand
);
3264 static const char* const socket_result_table
[_SOCKET_RESULT_MAX
] = {
3265 [SOCKET_SUCCESS
] = "success",
3266 [SOCKET_FAILURE_RESOURCES
] = "resources",
3267 [SOCKET_FAILURE_TIMEOUT
] = "timeout",
3268 [SOCKET_FAILURE_EXIT_CODE
] = "exit-code",
3269 [SOCKET_FAILURE_SIGNAL
] = "signal",
3270 [SOCKET_FAILURE_CORE_DUMP
] = "core-dump",
3271 [SOCKET_FAILURE_START_LIMIT_HIT
] = "start-limit-hit",
3272 [SOCKET_FAILURE_TRIGGER_LIMIT_HIT
] = "trigger-limit-hit",
3273 [SOCKET_FAILURE_SERVICE_START_LIMIT_HIT
] = "service-start-limit-hit"
3276 DEFINE_STRING_TABLE_LOOKUP(socket_result
, SocketResult
);
3278 const UnitVTable socket_vtable
= {
3279 .object_size
= sizeof(Socket
),
3280 .exec_context_offset
= offsetof(Socket
, exec_context
),
3281 .cgroup_context_offset
= offsetof(Socket
, cgroup_context
),
3282 .kill_context_offset
= offsetof(Socket
, kill_context
),
3283 .exec_runtime_offset
= offsetof(Socket
, exec_runtime
),
3284 .dynamic_creds_offset
= offsetof(Socket
, dynamic_creds
),
3290 .private_section
= "Socket",
3292 .can_transient
= true,
3294 .init
= socket_init
,
3295 .done
= socket_done
,
3296 .load
= socket_load
,
3298 .coldplug
= socket_coldplug
,
3300 .dump
= socket_dump
,
3302 .start
= socket_start
,
3303 .stop
= socket_stop
,
3305 .kill
= socket_kill
,
3307 .get_timeout
= socket_get_timeout
,
3309 .serialize
= socket_serialize
,
3310 .deserialize_item
= socket_deserialize_item
,
3311 .distribute_fds
= socket_distribute_fds
,
3313 .active_state
= socket_active_state
,
3314 .sub_state_to_string
= socket_sub_state_to_string
,
3316 .may_gc
= socket_may_gc
,
3318 .sigchld_event
= socket_sigchld_event
,
3320 .trigger_notify
= socket_trigger_notify
,
3322 .reset_failed
= socket_reset_failed
,
3324 .control_pid
= socket_control_pid
,
3326 .bus_vtable
= bus_socket_vtable
,
3327 .bus_set_property
= bus_socket_set_property
,
3328 .bus_commit_properties
= bus_socket_commit_properties
,
3330 .status_message_formats
= {
3331 /*.starting_stopping = {
3332 [0] = "Starting socket %s...",
3333 [1] = "Stopping socket %s...",
3335 .finished_start_job
= {
3336 [JOB_DONE
] = "Listening on %s.",
3337 [JOB_FAILED
] = "Failed to listen on %s.",
3338 [JOB_TIMEOUT
] = "Timed out starting %s.",
3340 .finished_stop_job
= {
3341 [JOB_DONE
] = "Closed %s.",
3342 [JOB_FAILED
] = "Failed stopping %s.",
3343 [JOB_TIMEOUT
] = "Timed out stopping %s.",