1 /* SPDX-License-Identifier: LGPL-2.1+ */
3 This file is part of systemd.
5 Copyright 2010 Lennart Poettering
12 #include <netinet/tcp.h>
14 #include <sys/epoll.h>
17 #include <linux/sctp.h>
19 #include "alloc-util.h"
20 #include "bpf-firewall.h"
21 #include "bus-error.h"
24 #include "dbus-socket.h"
26 #include "exit-status.h"
28 #include "format-util.h"
30 #include "in-addr-util.h"
36 #include "parse-util.h"
37 #include "path-util.h"
38 #include "process-util.h"
39 #include "selinux-util.h"
40 #include "signal-util.h"
41 #include "smack-util.h"
43 #include "socket-protocol-list.h"
45 #include "string-table.h"
46 #include "string-util.h"
48 #include "unit-name.h"
50 #include "user-util.h"
56 union sockaddr_union peer
;
60 static const UnitActiveState state_translation_table
[_SOCKET_STATE_MAX
] = {
61 [SOCKET_DEAD
] = UNIT_INACTIVE
,
62 [SOCKET_START_PRE
] = UNIT_ACTIVATING
,
63 [SOCKET_START_CHOWN
] = UNIT_ACTIVATING
,
64 [SOCKET_START_POST
] = UNIT_ACTIVATING
,
65 [SOCKET_LISTENING
] = UNIT_ACTIVE
,
66 [SOCKET_RUNNING
] = UNIT_ACTIVE
,
67 [SOCKET_STOP_PRE
] = UNIT_DEACTIVATING
,
68 [SOCKET_STOP_PRE_SIGTERM
] = UNIT_DEACTIVATING
,
69 [SOCKET_STOP_PRE_SIGKILL
] = UNIT_DEACTIVATING
,
70 [SOCKET_STOP_POST
] = UNIT_DEACTIVATING
,
71 [SOCKET_FINAL_SIGTERM
] = UNIT_DEACTIVATING
,
72 [SOCKET_FINAL_SIGKILL
] = UNIT_DEACTIVATING
,
73 [SOCKET_FAILED
] = UNIT_FAILED
76 static int socket_dispatch_io(sd_event_source
*source
, int fd
, uint32_t revents
, void *userdata
);
77 static int socket_dispatch_timer(sd_event_source
*source
, usec_t usec
, void *userdata
);
79 static void socket_init(Unit
*u
) {
80 Socket
*s
= SOCKET(u
);
83 assert(u
->load_state
== UNIT_STUB
);
85 s
->backlog
= SOMAXCONN
;
86 s
->timeout_usec
= u
->manager
->default_timeout_start_usec
;
87 s
->directory_mode
= 0755;
88 s
->socket_mode
= 0666;
90 s
->max_connections
= 64;
97 s
->exec_context
.std_output
= u
->manager
->default_std_output
;
98 s
->exec_context
.std_error
= u
->manager
->default_std_error
;
100 s
->control_command_id
= _SOCKET_EXEC_COMMAND_INVALID
;
102 s
->trigger_limit
.interval
= USEC_INFINITY
;
103 s
->trigger_limit
.burst
= (unsigned) -1;
106 static void socket_unwatch_control_pid(Socket
*s
) {
109 if (s
->control_pid
<= 0)
112 unit_unwatch_pid(UNIT(s
), s
->control_pid
);
116 static void socket_cleanup_fd_list(SocketPort
*p
) {
119 close_many(p
->auxiliary_fds
, p
->n_auxiliary_fds
);
120 p
->auxiliary_fds
= mfree(p
->auxiliary_fds
);
121 p
->n_auxiliary_fds
= 0;
124 void socket_free_ports(Socket
*s
) {
129 while ((p
= s
->ports
)) {
130 LIST_REMOVE(port
, s
->ports
, p
);
132 sd_event_source_unref(p
->event_source
);
134 socket_cleanup_fd_list(p
);
141 static void socket_done(Unit
*u
) {
142 Socket
*s
= SOCKET(u
);
147 socket_free_ports(s
);
149 while ((p
= set_steal_first(s
->peers_by_address
)))
152 s
->peers_by_address
= set_free(s
->peers_by_address
);
154 s
->exec_runtime
= exec_runtime_unref(s
->exec_runtime
, false);
155 exec_command_free_array(s
->exec_command
, _SOCKET_EXEC_COMMAND_MAX
);
156 s
->control_command
= NULL
;
158 dynamic_creds_unref(&s
->dynamic_creds
);
160 socket_unwatch_control_pid(s
);
162 unit_ref_unset(&s
->service
);
164 s
->tcp_congestion
= mfree(s
->tcp_congestion
);
165 s
->bind_to_device
= mfree(s
->bind_to_device
);
167 s
->smack
= mfree(s
->smack
);
168 s
->smack_ip_in
= mfree(s
->smack_ip_in
);
169 s
->smack_ip_out
= mfree(s
->smack_ip_out
);
171 strv_free(s
->symlinks
);
173 s
->user
= mfree(s
->user
);
174 s
->group
= mfree(s
->group
);
176 s
->fdname
= mfree(s
->fdname
);
178 s
->timer_event_source
= sd_event_source_unref(s
->timer_event_source
);
181 static int socket_arm_timer(Socket
*s
, usec_t usec
) {
186 if (s
->timer_event_source
) {
187 r
= sd_event_source_set_time(s
->timer_event_source
, usec
);
191 return sd_event_source_set_enabled(s
->timer_event_source
, SD_EVENT_ONESHOT
);
194 if (usec
== USEC_INFINITY
)
197 r
= sd_event_add_time(
198 UNIT(s
)->manager
->event
,
199 &s
->timer_event_source
,
202 socket_dispatch_timer
, s
);
206 (void) sd_event_source_set_description(s
->timer_event_source
, "socket-timer");
211 int socket_instantiate_service(Socket
*s
) {
212 _cleanup_free_
char *prefix
= NULL
, *name
= NULL
;
218 /* This fills in s->service if it isn't filled in yet. For
219 * Accept=yes sockets we create the next connection service
220 * here. For Accept=no this is mostly a NOP since the service
221 * is figured out at load time anyway. */
223 if (UNIT_DEREF(s
->service
))
229 r
= unit_name_to_prefix(UNIT(s
)->id
, &prefix
);
233 if (asprintf(&name
, "%s@%u.service", prefix
, s
->n_accepted
) < 0)
236 r
= manager_load_unit(UNIT(s
)->manager
, name
, NULL
, NULL
, &u
);
240 unit_ref_set(&s
->service
, UNIT(s
), u
);
242 return unit_add_two_dependencies(UNIT(s
), UNIT_BEFORE
, UNIT_TRIGGERS
, u
, false, UNIT_DEPENDENCY_IMPLICIT
);
245 static bool have_non_accept_socket(Socket
*s
) {
253 LIST_FOREACH(port
, p
, s
->ports
) {
255 if (p
->type
!= SOCKET_SOCKET
)
258 if (!socket_address_can_accept(&p
->address
))
265 static int socket_add_mount_dependencies(Socket
*s
) {
271 LIST_FOREACH(port
, p
, s
->ports
) {
272 const char *path
= NULL
;
274 if (p
->type
== SOCKET_SOCKET
)
275 path
= socket_address_get_path(&p
->address
);
276 else if (IN_SET(p
->type
, SOCKET_FIFO
, SOCKET_SPECIAL
, SOCKET_USB_FUNCTION
))
282 r
= unit_require_mounts_for(UNIT(s
), path
, UNIT_DEPENDENCY_FILE
);
290 static int socket_add_device_dependencies(Socket
*s
) {
295 if (!s
->bind_to_device
|| streq(s
->bind_to_device
, "lo"))
298 t
= strjoina("/sys/subsystem/net/devices/", s
->bind_to_device
);
299 return unit_add_node_dependency(UNIT(s
), t
, false, UNIT_BINDS_TO
, UNIT_DEPENDENCY_FILE
);
302 static int socket_add_default_dependencies(Socket
*s
) {
306 if (!UNIT(s
)->default_dependencies
)
309 r
= unit_add_dependency_by_name(UNIT(s
), UNIT_BEFORE
, SPECIAL_SOCKETS_TARGET
, NULL
, true, UNIT_DEPENDENCY_DEFAULT
);
313 if (MANAGER_IS_SYSTEM(UNIT(s
)->manager
)) {
314 r
= unit_add_two_dependencies_by_name(UNIT(s
), UNIT_AFTER
, UNIT_REQUIRES
, SPECIAL_SYSINIT_TARGET
, NULL
, true, UNIT_DEPENDENCY_DEFAULT
);
319 return unit_add_two_dependencies_by_name(UNIT(s
), UNIT_BEFORE
, UNIT_CONFLICTS
, SPECIAL_SHUTDOWN_TARGET
, NULL
, true, UNIT_DEPENDENCY_DEFAULT
);
322 _pure_
static bool socket_has_exec(Socket
*s
) {
326 for (i
= 0; i
< _SOCKET_EXEC_COMMAND_MAX
; i
++)
327 if (s
->exec_command
[i
])
333 static int socket_add_extras(Socket
*s
) {
339 /* Pick defaults for the trigger limit, if nothing was explicitly configured. We pick a relatively high limit
340 * in Accept=yes mode, and a lower limit for Accept=no. Reason: in Accept=yes mode we are invoking accept()
341 * ourselves before the trigger limit can hit, thus incoming connections are taken off the socket queue quickly
342 * and reliably. This is different for Accept=no, where the spawned service has to take the incoming traffic
343 * off the queues, which it might not necessarily do. Moreover, while Accept=no services are supposed to
344 * process whatever is queued in one go, and thus should normally never have to be started frequently. This is
345 * different for Accept=yes where each connection is processed by a new service instance, and thus frequent
346 * service starts are typical. */
348 if (s
->trigger_limit
.interval
== USEC_INFINITY
)
349 s
->trigger_limit
.interval
= 2 * USEC_PER_SEC
;
351 if (s
->trigger_limit
.burst
== (unsigned) -1) {
353 s
->trigger_limit
.burst
= 200;
355 s
->trigger_limit
.burst
= 20;
358 if (have_non_accept_socket(s
)) {
360 if (!UNIT_DEREF(s
->service
)) {
363 r
= unit_load_related_unit(u
, ".service", &x
);
367 unit_ref_set(&s
->service
, u
, x
);
370 r
= unit_add_two_dependencies(u
, UNIT_BEFORE
, UNIT_TRIGGERS
, UNIT_DEREF(s
->service
), true, UNIT_DEPENDENCY_IMPLICIT
);
375 r
= socket_add_mount_dependencies(s
);
379 r
= socket_add_device_dependencies(s
);
383 r
= unit_patch_contexts(u
);
387 if (socket_has_exec(s
)) {
388 r
= unit_add_exec_dependencies(u
, &s
->exec_context
);
393 r
= unit_set_default_slice(u
);
397 r
= socket_add_default_dependencies(s
);
404 static const char *socket_find_symlink_target(Socket
*s
) {
405 const char *found
= NULL
;
408 LIST_FOREACH(port
, p
, s
->ports
) {
409 const char *f
= NULL
;
418 f
= socket_address_get_path(&p
->address
);
436 static int socket_verify(Socket
*s
) {
439 if (UNIT(s
)->load_state
!= UNIT_LOADED
)
443 log_unit_error(UNIT(s
), "Unit has no Listen setting (ListenStream=, ListenDatagram=, ListenFIFO=, ...). Refusing.");
447 if (s
->accept
&& have_non_accept_socket(s
)) {
448 log_unit_error(UNIT(s
), "Unit configured for accepting sockets, but sockets are non-accepting. Refusing.");
452 if (s
->accept
&& s
->max_connections
<= 0) {
453 log_unit_error(UNIT(s
), "MaxConnection= setting too small. Refusing.");
457 if (s
->accept
&& UNIT_DEREF(s
->service
)) {
458 log_unit_error(UNIT(s
), "Explicit service configuration for accepting socket units not supported. Refusing.");
462 if (s
->exec_context
.pam_name
&& s
->kill_context
.kill_mode
!= KILL_CONTROL_GROUP
) {
463 log_unit_error(UNIT(s
), "Unit has PAM enabled. Kill mode must be set to 'control-group'. Refusing.");
467 if (!strv_isempty(s
->symlinks
) && !socket_find_symlink_target(s
)) {
468 log_unit_error(UNIT(s
), "Unit has symlinks set but none or more than one node in the file system. Refusing.");
475 static void peer_address_hash_func(const void *p
, struct siphash
*state
) {
476 const SocketPeer
*s
= p
;
480 if (s
->peer
.sa
.sa_family
== AF_INET
)
481 siphash24_compress(&s
->peer
.in
.sin_addr
, sizeof(s
->peer
.in
.sin_addr
), state
);
482 else if (s
->peer
.sa
.sa_family
== AF_INET6
)
483 siphash24_compress(&s
->peer
.in6
.sin6_addr
, sizeof(s
->peer
.in6
.sin6_addr
), state
);
484 else if (s
->peer
.sa
.sa_family
== AF_VSOCK
)
485 siphash24_compress(&s
->peer
.vm
.svm_cid
, sizeof(s
->peer
.vm
.svm_cid
), state
);
487 assert_not_reached("Unknown address family.");
490 static int peer_address_compare_func(const void *a
, const void *b
) {
491 const SocketPeer
*x
= a
, *y
= b
;
493 if (x
->peer
.sa
.sa_family
< y
->peer
.sa
.sa_family
)
495 if (x
->peer
.sa
.sa_family
> y
->peer
.sa
.sa_family
)
498 switch(x
->peer
.sa
.sa_family
) {
500 return memcmp(&x
->peer
.in
.sin_addr
, &y
->peer
.in
.sin_addr
, sizeof(x
->peer
.in
.sin_addr
));
502 return memcmp(&x
->peer
.in6
.sin6_addr
, &y
->peer
.in6
.sin6_addr
, sizeof(x
->peer
.in6
.sin6_addr
));
504 if (x
->peer
.vm
.svm_cid
< y
->peer
.vm
.svm_cid
)
506 if (x
->peer
.vm
.svm_cid
> y
->peer
.vm
.svm_cid
)
510 assert_not_reached("Black sheep in the family!");
513 const struct hash_ops peer_address_hash_ops
= {
514 .hash
= peer_address_hash_func
,
515 .compare
= peer_address_compare_func
518 static int socket_load(Unit
*u
) {
519 Socket
*s
= SOCKET(u
);
523 assert(u
->load_state
== UNIT_STUB
);
525 r
= set_ensure_allocated(&s
->peers_by_address
, &peer_address_hash_ops
);
529 r
= unit_load_fragment_and_dropin(u
);
533 if (u
->load_state
== UNIT_LOADED
) {
534 /* This is a new unit? Then let's add in some extras */
535 r
= socket_add_extras(s
);
540 return socket_verify(s
);
543 static SocketPeer
*socket_peer_new(void) {
546 p
= new0(SocketPeer
, 1);
555 SocketPeer
*socket_peer_ref(SocketPeer
*p
) {
559 assert(p
->n_ref
> 0);
565 SocketPeer
*socket_peer_unref(SocketPeer
*p
) {
569 assert(p
->n_ref
> 0);
577 set_remove(p
->socket
->peers_by_address
, p
);
582 int socket_acquire_peer(Socket
*s
, int fd
, SocketPeer
**p
) {
583 _cleanup_(socket_peer_unrefp
) SocketPeer
*remote
= NULL
;
584 SocketPeer sa
= {}, *i
;
585 socklen_t salen
= sizeof(sa
.peer
);
591 r
= getpeername(fd
, &sa
.peer
.sa
, &salen
);
593 return log_error_errno(errno
, "getpeername failed: %m");
595 if (!IN_SET(sa
.peer
.sa
.sa_family
, AF_INET
, AF_INET6
, AF_VSOCK
)) {
600 i
= set_get(s
->peers_by_address
, &sa
);
602 *p
= socket_peer_ref(i
);
606 remote
= socket_peer_new();
610 remote
->peer
= sa
.peer
;
611 remote
->peer_salen
= salen
;
613 r
= set_put(s
->peers_by_address
, remote
);
619 *p
= TAKE_PTR(remote
);
624 _const_
static const char* listen_lookup(int family
, int type
) {
626 if (family
== AF_NETLINK
)
627 return "ListenNetlink";
629 if (type
== SOCK_STREAM
)
630 return "ListenStream";
631 else if (type
== SOCK_DGRAM
)
632 return "ListenDatagram";
633 else if (type
== SOCK_SEQPACKET
)
634 return "ListenSequentialPacket";
636 assert_not_reached("Unknown socket type");
640 static void socket_dump(Unit
*u
, FILE *f
, const char *prefix
) {
641 char time_string
[FORMAT_TIMESPAN_MAX
];
643 Socket
*s
= SOCKET(u
);
645 const char *prefix2
, *str
;
650 prefix
= strempty(prefix
);
651 prefix2
= strjoina(prefix
, "\t");
654 "%sSocket State: %s\n"
656 "%sBindIPv6Only: %s\n"
658 "%sSocketMode: %04o\n"
659 "%sDirectoryMode: %04o\n"
663 "%sTransparent: %s\n"
665 "%sPassCredentials: %s\n"
666 "%sPassSecurity: %s\n"
667 "%sTCPCongestion: %s\n"
668 "%sRemoveOnStop: %s\n"
670 "%sFileDescriptorName: %s\n"
671 "%sSELinuxContextFromNet: %s\n",
672 prefix
, socket_state_to_string(s
->state
),
673 prefix
, socket_result_to_string(s
->result
),
674 prefix
, socket_address_bind_ipv6_only_to_string(s
->bind_ipv6_only
),
676 prefix
, s
->socket_mode
,
677 prefix
, s
->directory_mode
,
678 prefix
, yes_no(s
->keep_alive
),
679 prefix
, yes_no(s
->no_delay
),
680 prefix
, yes_no(s
->free_bind
),
681 prefix
, yes_no(s
->transparent
),
682 prefix
, yes_no(s
->broadcast
),
683 prefix
, yes_no(s
->pass_cred
),
684 prefix
, yes_no(s
->pass_sec
),
685 prefix
, strna(s
->tcp_congestion
),
686 prefix
, yes_no(s
->remove_on_stop
),
687 prefix
, yes_no(s
->writable
),
688 prefix
, socket_fdname(s
),
689 prefix
, yes_no(s
->selinux_context_from_net
));
691 if (s
->control_pid
> 0)
693 "%sControl PID: "PID_FMT
"\n",
694 prefix
, s
->control_pid
);
696 if (s
->bind_to_device
)
698 "%sBindToDevice: %s\n",
699 prefix
, s
->bind_to_device
);
704 "%sNConnections: %u\n"
705 "%sMaxConnections: %u\n"
706 "%sMaxConnectionsPerSource: %u\n",
707 prefix
, s
->n_accepted
,
708 prefix
, s
->n_connections
,
709 prefix
, s
->max_connections
,
710 prefix
, s
->max_connections_per_source
);
712 if (s
->priority
>= 0)
715 prefix
, s
->priority
);
717 if (s
->receive_buffer
> 0)
719 "%sReceiveBuffer: %zu\n",
720 prefix
, s
->receive_buffer
);
722 if (s
->send_buffer
> 0)
724 "%sSendBuffer: %zu\n",
725 prefix
, s
->send_buffer
);
737 if (s
->pipe_size
> 0)
740 prefix
, s
->pipe_size
);
747 if (s
->mq_maxmsg
> 0)
749 "%sMessageQueueMaxMessages: %li\n",
750 prefix
, s
->mq_maxmsg
);
752 if (s
->mq_msgsize
> 0)
754 "%sMessageQueueMessageSize: %li\n",
755 prefix
, s
->mq_msgsize
);
760 prefix
, yes_no(s
->reuse_port
));
764 "%sSmackLabel: %s\n",
769 "%sSmackLabelIPIn: %s\n",
770 prefix
, s
->smack_ip_in
);
774 "%sSmackLabelIPOut: %s\n",
775 prefix
, s
->smack_ip_out
);
777 if (!isempty(s
->user
) || !isempty(s
->group
))
780 "%sSocketGroup: %s\n",
781 prefix
, strna(s
->user
),
782 prefix
, strna(s
->group
));
784 if (s
->keep_alive_time
> 0)
786 "%sKeepAliveTimeSec: %s\n",
787 prefix
, format_timespan(time_string
, FORMAT_TIMESPAN_MAX
, s
->keep_alive_time
, USEC_PER_SEC
));
789 if (s
->keep_alive_interval
> 0)
791 "%sKeepAliveIntervalSec: %s\n",
792 prefix
, format_timespan(time_string
, FORMAT_TIMESPAN_MAX
, s
->keep_alive_interval
, USEC_PER_SEC
));
794 if (s
->keep_alive_cnt
> 0)
796 "%sKeepAliveProbes: %u\n",
797 prefix
, s
->keep_alive_cnt
);
799 if (s
->defer_accept
> 0)
801 "%sDeferAcceptSec: %s\n",
802 prefix
, format_timespan(time_string
, FORMAT_TIMESPAN_MAX
, s
->defer_accept
, USEC_PER_SEC
));
804 LIST_FOREACH(port
, p
, s
->ports
) {
807 case SOCKET_SOCKET
: {
808 _cleanup_free_
char *k
= NULL
;
812 r
= socket_address_print(&p
->address
, &k
);
818 fprintf(f
, "%s%s: %s\n", prefix
, listen_lookup(socket_address_family(&p
->address
), p
->address
.type
), t
);
822 fprintf(f
, "%sListenSpecial: %s\n", prefix
, p
->path
);
824 case SOCKET_USB_FUNCTION
:
825 fprintf(f
, "%sListenUSBFunction: %s\n", prefix
, p
->path
);
828 fprintf(f
, "%sListenMessageQueue: %s\n", prefix
, p
->path
);
831 fprintf(f
, "%sListenFIFO: %s\n", prefix
, p
->path
);
836 "%sTriggerLimitIntervalSec: %s\n"
837 "%sTriggerLimitBurst: %u\n",
838 prefix
, format_timespan(time_string
, FORMAT_TIMESPAN_MAX
, s
->trigger_limit
.interval
, USEC_PER_SEC
),
839 prefix
, s
->trigger_limit
.burst
);
841 str
= socket_protocol_to_name(s
->socket_protocol
);
843 fprintf(f
, "%sSocketProtocol: %s\n", prefix
, str
);
845 if (!strv_isempty(s
->symlinks
)) {
848 fprintf(f
, "%sSymlinks:", prefix
);
849 STRV_FOREACH(q
, s
->symlinks
)
850 fprintf(f
, " %s", *q
);
856 "%sTimeoutSec: %s\n",
857 prefix
, format_timespan(time_string
, FORMAT_TIMESPAN_MAX
, s
->timeout_usec
, USEC_PER_SEC
));
859 exec_context_dump(&s
->exec_context
, f
, prefix
);
860 kill_context_dump(&s
->kill_context
, f
, prefix
);
862 for (c
= 0; c
< _SOCKET_EXEC_COMMAND_MAX
; c
++) {
863 if (!s
->exec_command
[c
])
866 fprintf(f
, "%s-> %s:\n",
867 prefix
, socket_exec_command_to_string(c
));
869 exec_command_dump_list(s
->exec_command
[c
], f
, prefix2
);
872 cgroup_context_dump(&s
->cgroup_context
, f
, prefix
);
875 static int instance_from_socket(int fd
, unsigned nr
, char **instance
) {
878 union sockaddr_union local
, remote
;
884 if (getsockname(fd
, &local
.sa
, &l
) < 0)
888 if (getpeername(fd
, &remote
.sa
, &l
) < 0)
891 switch (local
.sa
.sa_family
) {
895 a
= be32toh(local
.in
.sin_addr
.s_addr
),
896 b
= be32toh(remote
.in
.sin_addr
.s_addr
);
899 "%u-%u.%u.%u.%u:%u-%u.%u.%u.%u:%u",
901 a
>> 24, (a
>> 16) & 0xFF, (a
>> 8) & 0xFF, a
& 0xFF,
902 be16toh(local
.in
.sin_port
),
903 b
>> 24, (b
>> 16) & 0xFF, (b
>> 8) & 0xFF, b
& 0xFF,
904 be16toh(remote
.in
.sin_port
)) < 0)
911 static const unsigned char ipv4_prefix
[] = {
912 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0xFF, 0xFF
915 if (memcmp(&local
.in6
.sin6_addr
, ipv4_prefix
, sizeof(ipv4_prefix
)) == 0 &&
916 memcmp(&remote
.in6
.sin6_addr
, ipv4_prefix
, sizeof(ipv4_prefix
)) == 0) {
918 *a
= local
.in6
.sin6_addr
.s6_addr
+12,
919 *b
= remote
.in6
.sin6_addr
.s6_addr
+12;
922 "%u-%u.%u.%u.%u:%u-%u.%u.%u.%u:%u",
924 a
[0], a
[1], a
[2], a
[3],
925 be16toh(local
.in6
.sin6_port
),
926 b
[0], b
[1], b
[2], b
[3],
927 be16toh(remote
.in6
.sin6_port
)) < 0)
930 char a
[INET6_ADDRSTRLEN
], b
[INET6_ADDRSTRLEN
];
935 inet_ntop(AF_INET6
, &local
.in6
.sin6_addr
, a
, sizeof(a
)),
936 be16toh(local
.in6
.sin6_port
),
937 inet_ntop(AF_INET6
, &remote
.in6
.sin6_addr
, b
, sizeof(b
)),
938 be16toh(remote
.in6
.sin6_port
)) < 0)
949 k
= getpeercred(fd
, &ucred
);
952 "%u-"PID_FMT
"-"UID_FMT
,
953 nr
, ucred
.pid
, ucred
.uid
) < 0)
955 } else if (k
== -ENODATA
) {
956 /* This handles the case where somebody is
957 * connecting from another pid/uid namespace
958 * (e.g. from outside of our container). */
973 local
.vm
.svm_cid
, local
.vm
.svm_port
,
974 remote
.vm
.svm_cid
, remote
.vm
.svm_port
) < 0)
980 assert_not_reached("Unhandled socket type.");
987 static void socket_close_fds(Socket
*s
) {
993 LIST_FOREACH(port
, p
, s
->ports
) {
996 was_open
= p
->fd
>= 0;
998 p
->event_source
= sd_event_source_unref(p
->event_source
);
999 p
->fd
= safe_close(p
->fd
);
1000 socket_cleanup_fd_list(p
);
1002 /* One little note: we should normally not delete any sockets in the file system here! After all some
1003 * other process we spawned might still have a reference of this fd and wants to continue to use
1004 * it. Therefore we normally delete sockets in the file system before we create a new one, not after we
1005 * stopped using one! That all said, if the user explicitly requested this, we'll delete them here
1006 * anyway, but only then. */
1008 if (!was_open
|| !s
->remove_on_stop
)
1014 (void) unlink(p
->path
);
1018 (void) mq_unlink(p
->path
);
1022 (void) socket_address_unlink(&p
->address
);
1030 if (s
->remove_on_stop
)
1031 STRV_FOREACH(i
, s
->symlinks
)
1035 static void socket_apply_socket_options(Socket
*s
, int fd
) {
1041 if (s
->keep_alive
) {
1043 if (setsockopt(fd
, SOL_SOCKET
, SO_KEEPALIVE
, &one
, sizeof(one
)) < 0)
1044 log_unit_warning_errno(UNIT(s
), errno
, "SO_KEEPALIVE failed: %m");
1047 if (s
->keep_alive_time
> 0) {
1048 int value
= s
->keep_alive_time
/ USEC_PER_SEC
;
1049 if (setsockopt(fd
, SOL_TCP
, TCP_KEEPIDLE
, &value
, sizeof(value
)) < 0)
1050 log_unit_warning_errno(UNIT(s
), errno
, "TCP_KEEPIDLE failed: %m");
1053 if (s
->keep_alive_interval
> 0) {
1054 int value
= s
->keep_alive_interval
/ USEC_PER_SEC
;
1055 if (setsockopt(fd
, SOL_TCP
, TCP_KEEPINTVL
, &value
, sizeof(value
)) < 0)
1056 log_unit_warning_errno(UNIT(s
), errno
, "TCP_KEEPINTVL failed: %m");
1059 if (s
->keep_alive_cnt
> 0) {
1060 int value
= s
->keep_alive_cnt
;
1061 if (setsockopt(fd
, SOL_TCP
, TCP_KEEPCNT
, &value
, sizeof(value
)) < 0)
1062 log_unit_warning_errno(UNIT(s
), errno
, "TCP_KEEPCNT failed: %m");
1065 if (s
->defer_accept
> 0) {
1066 int value
= s
->defer_accept
/ USEC_PER_SEC
;
1067 if (setsockopt(fd
, SOL_TCP
, TCP_DEFER_ACCEPT
, &value
, sizeof(value
)) < 0)
1068 log_unit_warning_errno(UNIT(s
), errno
, "TCP_DEFER_ACCEPT failed: %m");
1074 if (s
->socket_protocol
== IPPROTO_SCTP
) {
1075 if (setsockopt(fd
, SOL_SCTP
, SCTP_NODELAY
, &one
, sizeof(one
)) < 0)
1076 log_unit_warning_errno(UNIT(s
), errno
, "SCTP_NODELAY failed: %m");
1078 if (setsockopt(fd
, SOL_TCP
, TCP_NODELAY
, &one
, sizeof(one
)) < 0)
1079 log_unit_warning_errno(UNIT(s
), errno
, "TCP_NODELAY failed: %m");
1085 if (setsockopt(fd
, SOL_SOCKET
, SO_BROADCAST
, &one
, sizeof(one
)) < 0)
1086 log_unit_warning_errno(UNIT(s
), errno
, "SO_BROADCAST failed: %m");
1091 if (setsockopt(fd
, SOL_SOCKET
, SO_PASSCRED
, &one
, sizeof(one
)) < 0)
1092 log_unit_warning_errno(UNIT(s
), errno
, "SO_PASSCRED failed: %m");
1097 if (setsockopt(fd
, SOL_SOCKET
, SO_PASSSEC
, &one
, sizeof(one
)) < 0)
1098 log_unit_warning_errno(UNIT(s
), errno
, "SO_PASSSEC failed: %m");
1101 if (s
->priority
>= 0)
1102 if (setsockopt(fd
, SOL_SOCKET
, SO_PRIORITY
, &s
->priority
, sizeof(s
->priority
)) < 0)
1103 log_unit_warning_errno(UNIT(s
), errno
, "SO_PRIORITY failed: %m");
1105 if (s
->receive_buffer
> 0) {
1106 int value
= (int) s
->receive_buffer
;
1108 /* We first try with SO_RCVBUFFORCE, in case we have the perms for that */
1109 if (setsockopt(fd
, SOL_SOCKET
, SO_RCVBUFFORCE
, &value
, sizeof(value
)) < 0)
1110 if (setsockopt(fd
, SOL_SOCKET
, SO_RCVBUF
, &value
, sizeof(value
)) < 0)
1111 log_unit_warning_errno(UNIT(s
), errno
, "SO_RCVBUF failed: %m");
1114 if (s
->send_buffer
> 0) {
1115 int value
= (int) s
->send_buffer
;
1116 if (setsockopt(fd
, SOL_SOCKET
, SO_SNDBUFFORCE
, &value
, sizeof(value
)) < 0)
1117 if (setsockopt(fd
, SOL_SOCKET
, SO_SNDBUF
, &value
, sizeof(value
)) < 0)
1118 log_unit_warning_errno(UNIT(s
), errno
, "SO_SNDBUF failed: %m");
1122 if (setsockopt(fd
, SOL_SOCKET
, SO_MARK
, &s
->mark
, sizeof(s
->mark
)) < 0)
1123 log_unit_warning_errno(UNIT(s
), errno
, "SO_MARK failed: %m");
1126 if (setsockopt(fd
, IPPROTO_IP
, IP_TOS
, &s
->ip_tos
, sizeof(s
->ip_tos
)) < 0)
1127 log_unit_warning_errno(UNIT(s
), errno
, "IP_TOS failed: %m");
1129 if (s
->ip_ttl
>= 0) {
1132 r
= setsockopt(fd
, IPPROTO_IP
, IP_TTL
, &s
->ip_ttl
, sizeof(s
->ip_ttl
));
1134 if (socket_ipv6_is_supported())
1135 x
= setsockopt(fd
, IPPROTO_IPV6
, IPV6_UNICAST_HOPS
, &s
->ip_ttl
, sizeof(s
->ip_ttl
));
1138 errno
= EAFNOSUPPORT
;
1142 log_unit_warning_errno(UNIT(s
), errno
, "IP_TTL/IPV6_UNICAST_HOPS failed: %m");
1145 if (s
->tcp_congestion
)
1146 if (setsockopt(fd
, SOL_TCP
, TCP_CONGESTION
, s
->tcp_congestion
, strlen(s
->tcp_congestion
)+1) < 0)
1147 log_unit_warning_errno(UNIT(s
), errno
, "TCP_CONGESTION failed: %m");
1149 if (s
->smack_ip_in
) {
1150 r
= mac_smack_apply_fd(fd
, SMACK_ATTR_IPIN
, s
->smack_ip_in
);
1152 log_unit_error_errno(UNIT(s
), r
, "mac_smack_apply_ip_in_fd: %m");
1155 if (s
->smack_ip_out
) {
1156 r
= mac_smack_apply_fd(fd
, SMACK_ATTR_IPOUT
, s
->smack_ip_out
);
1158 log_unit_error_errno(UNIT(s
), r
, "mac_smack_apply_ip_out_fd: %m");
1162 static void socket_apply_fifo_options(Socket
*s
, int fd
) {
1168 if (s
->pipe_size
> 0)
1169 if (fcntl(fd
, F_SETPIPE_SZ
, s
->pipe_size
) < 0)
1170 log_unit_warning_errno(UNIT(s
), errno
, "Setting pipe size failed, ignoring: %m");
1173 r
= mac_smack_apply_fd(fd
, SMACK_ATTR_ACCESS
, s
->smack
);
1175 log_unit_error_errno(UNIT(s
), r
, "SMACK relabelling failed, ignoring: %m");
1179 static int fifo_address_create(
1181 mode_t directory_mode
,
1182 mode_t socket_mode
) {
1184 _cleanup_close_
int fd
= -1;
1191 (void) mkdir_parents_label(path
, directory_mode
);
1193 r
= mac_selinux_create_file_prepare(path
, S_IFIFO
);
1197 /* Enforce the right access mode for the fifo */
1198 old_mask
= umask(~socket_mode
);
1200 /* Include the original umask in our mask */
1201 (void) umask(~socket_mode
| old_mask
);
1203 r
= mkfifo(path
, socket_mode
);
1204 (void) umask(old_mask
);
1206 if (r
< 0 && errno
!= EEXIST
) {
1211 fd
= open(path
, O_RDWR
| O_CLOEXEC
| O_NOCTTY
| O_NONBLOCK
| O_NOFOLLOW
);
1217 mac_selinux_create_file_clear();
1219 if (fstat(fd
, &st
) < 0) {
1224 if (!S_ISFIFO(st
.st_mode
) ||
1225 (st
.st_mode
& 0777) != (socket_mode
& ~old_mask
) ||
1226 st
.st_uid
!= getuid() ||
1227 st
.st_gid
!= getgid()) {
1235 mac_selinux_create_file_clear();
1239 static int special_address_create(const char *path
, bool writable
) {
1240 _cleanup_close_
int fd
= -1;
1245 fd
= open(path
, (writable
? O_RDWR
: O_RDONLY
)|O_CLOEXEC
|O_NOCTTY
|O_NONBLOCK
|O_NOFOLLOW
);
1249 if (fstat(fd
, &st
) < 0)
1252 /* Check whether this is a /proc, /sys or /dev file or char device */
1253 if (!S_ISREG(st
.st_mode
) && !S_ISCHR(st
.st_mode
))
1259 static int usbffs_address_create(const char *path
) {
1260 _cleanup_close_
int fd
= -1;
1265 fd
= open(path
, O_RDWR
|O_CLOEXEC
|O_NOCTTY
|O_NONBLOCK
|O_NOFOLLOW
);
1269 if (fstat(fd
, &st
) < 0)
1272 /* Check whether this is a regular file (ffs endpoint) */
1273 if (!S_ISREG(st
.st_mode
))
1279 static int mq_address_create(
1285 _cleanup_close_
int fd
= -1;
1288 struct mq_attr _attr
, *attr
= NULL
;
1292 if (maxmsg
> 0 && msgsize
> 0) {
1293 _attr
= (struct mq_attr
) {
1294 .mq_flags
= O_NONBLOCK
,
1295 .mq_maxmsg
= maxmsg
,
1296 .mq_msgsize
= msgsize
,
1301 /* Enforce the right access mode for the mq */
1302 old_mask
= umask(~mq_mode
);
1304 /* Include the original umask in our mask */
1305 (void) umask(~mq_mode
| old_mask
);
1306 fd
= mq_open(path
, O_RDONLY
|O_CLOEXEC
|O_NONBLOCK
|O_CREAT
, mq_mode
, attr
);
1307 (void) umask(old_mask
);
1312 if (fstat(fd
, &st
) < 0)
1315 if ((st
.st_mode
& 0777) != (mq_mode
& ~old_mask
) ||
1316 st
.st_uid
!= getuid() ||
1317 st
.st_gid
!= getgid())
1323 static int socket_symlink(Socket
*s
) {
1330 p
= socket_find_symlink_target(s
);
1334 STRV_FOREACH(i
, s
->symlinks
) {
1335 (void) mkdir_parents_label(*i
, s
->directory_mode
);
1337 r
= symlink_idempotent(p
, *i
);
1339 if (r
== -EEXIST
&& s
->remove_on_stop
) {
1340 /* If there's already something where we want to create the symlink, and the destructive
1341 * RemoveOnStop= mode is set, then we might as well try to remove what already exists and try
1344 if (unlink(*i
) >= 0)
1345 r
= symlink_idempotent(p
, *i
);
1349 log_unit_warning_errno(UNIT(s
), r
, "Failed to create symlink %s → %s, ignoring: %m", p
, *i
);
1355 static int usbffs_write_descs(int fd
, Service
*s
) {
1358 if (!s
->usb_function_descriptors
|| !s
->usb_function_strings
)
1361 r
= copy_file_fd(s
->usb_function_descriptors
, fd
, 0);
1365 return copy_file_fd(s
->usb_function_strings
, fd
, 0);
1368 static int usbffs_select_ep(const struct dirent
*d
) {
1369 return d
->d_name
[0] != '.' && !streq(d
->d_name
, "ep0");
1372 static int usbffs_dispatch_eps(SocketPort
*p
) {
1373 _cleanup_free_
struct dirent
**ent
= NULL
;
1377 r
= scandir(p
->path
, &ent
, usbffs_select_ep
, alphasort
);
1382 p
->auxiliary_fds
= new(int, n
);
1383 if (!p
->auxiliary_fds
)
1386 p
->n_auxiliary_fds
= n
;
1389 for (i
= 0; i
< n
; ++i
) {
1390 _cleanup_free_
char *ep
= NULL
;
1392 ep
= path_make_absolute(ent
[i
]->d_name
, p
->path
);
1396 path_simplify(ep
, false);
1398 r
= usbffs_address_create(ep
);
1402 p
->auxiliary_fds
[k
++] = r
;
1409 close_many(p
->auxiliary_fds
, k
);
1410 p
->auxiliary_fds
= mfree(p
->auxiliary_fds
);
1411 p
->n_auxiliary_fds
= 0;
1416 static int socket_determine_selinux_label(Socket
*s
, char **ret
) {
1419 _cleanup_free_
char *path
= NULL
;
1425 if (s
->selinux_context_from_net
) {
1426 /* If this is requested, get label from the network label */
1428 r
= mac_selinux_get_our_label(ret
);
1429 if (r
== -EOPNOTSUPP
)
1433 /* Otherwise, get it from the executable we are about to start */
1434 r
= socket_instantiate_service(s
);
1438 if (!UNIT_ISSET(s
->service
))
1441 service
= SERVICE(UNIT_DEREF(s
->service
));
1442 c
= service
->exec_command
[SERVICE_EXEC_START
];
1446 r
= chase_symlinks(c
->path
, service
->exec_context
.root_directory
, CHASE_PREFIX_ROOT
, &path
);
1450 r
= mac_selinux_get_create_label_from_exe(path
, ret
);
1451 if (IN_SET(r
, -EPERM
, -EOPNOTSUPP
))
1462 static int socket_address_listen_do(
1464 const SocketAddress
*address
,
1465 const char *label
) {
1470 return socket_address_listen(
1472 SOCK_CLOEXEC
|SOCK_NONBLOCK
,
1484 static int socket_address_listen_in_cgroup(
1486 const SocketAddress
*address
,
1487 const char *label
) {
1489 _cleanup_close_pair_
int pair
[2] = { -1, -1 };
1496 /* This is a wrapper around socket_address_listen(), that forks off a helper process inside the socket's cgroup
1497 * in which the socket is actually created. This way we ensure the socket is actually properly attached to the
1498 * unit's cgroup for the purpose of BPF filtering and such. */
1500 if (!IN_SET(address
->sockaddr
.sa
.sa_family
, AF_INET
, AF_INET6
))
1501 goto shortcut
; /* BPF filtering only applies to IPv4 + IPv6, shortcut things for other protocols */
1503 r
= bpf_firewall_supported();
1506 if (r
== BPF_FIREWALL_UNSUPPORTED
) /* If BPF firewalling isn't supported anyway — there's no point in this forking complexity */
1509 if (socketpair(AF_UNIX
, SOCK_SEQPACKET
|SOCK_CLOEXEC
, 0, pair
) < 0)
1510 return log_unit_error_errno(UNIT(s
), errno
, "Failed to create communication channel: %m");
1512 r
= unit_fork_helper_process(UNIT(s
), "(sd-listen)", &pid
);
1514 return log_unit_error_errno(UNIT(s
), r
, "Failed to fork off listener stub process: %m");
1518 pair
[0] = safe_close(pair
[0]);
1520 fd
= socket_address_listen_do(s
, address
, label
);
1522 log_unit_error_errno(UNIT(s
), fd
, "Failed to create listening socket: %m");
1523 _exit(EXIT_FAILURE
);
1526 r
= send_one_fd(pair
[1], fd
, 0);
1528 log_unit_error_errno(UNIT(s
), r
, "Failed to send listening socket to parent: %m");
1529 _exit(EXIT_FAILURE
);
1532 _exit(EXIT_SUCCESS
);
1535 pair
[1] = safe_close(pair
[1]);
1536 fd
= receive_one_fd(pair
[0], 0);
1538 /* We synchronously wait for the helper, as it shouldn't be slow */
1539 r
= wait_for_terminate_and_check("(sd-listen)", pid
, WAIT_LOG_ABNORMAL
);
1546 return log_unit_error_errno(UNIT(s
), fd
, "Failed to receive listening socket: %m");
1551 fd
= socket_address_listen_do(s
, address
, label
);
1553 return log_error_errno(fd
, "Failed to create listening socket: %m");
1558 static int socket_open_fds(Socket
*s
) {
1559 _cleanup_(mac_selinux_freep
) char *label
= NULL
;
1560 bool know_label
= false;
1566 LIST_FOREACH(port
, p
, s
->ports
) {
1576 /* Figure out label, if we don't it know yet. We do it once, for the first socket where
1577 * we need this and remember it for the rest. */
1579 r
= socket_determine_selinux_label(s
, &label
);
1586 /* Apply the socket protocol */
1587 switch (p
->address
.type
) {
1590 case SOCK_SEQPACKET
:
1591 if (s
->socket_protocol
== IPPROTO_SCTP
)
1592 p
->address
.protocol
= s
->socket_protocol
;
1596 if (s
->socket_protocol
== IPPROTO_UDPLITE
)
1597 p
->address
.protocol
= s
->socket_protocol
;
1601 r
= socket_address_listen_in_cgroup(s
, &p
->address
, label
);
1606 socket_apply_socket_options(s
, p
->fd
);
1610 case SOCKET_SPECIAL
:
1612 p
->fd
= special_address_create(p
->path
, s
->writable
);
1621 p
->fd
= fifo_address_create(
1630 socket_apply_fifo_options(s
, p
->fd
);
1636 p
->fd
= mq_address_create(
1647 case SOCKET_USB_FUNCTION
: {
1648 _cleanup_free_
char *ep
= NULL
;
1650 ep
= path_make_absolute("ep0", p
->path
);
1652 p
->fd
= usbffs_address_create(ep
);
1658 r
= usbffs_write_descs(p
->fd
, SERVICE(UNIT_DEREF(s
->service
)));
1662 r
= usbffs_dispatch_eps(p
);
1669 assert_not_reached("Unknown port type");
1676 socket_close_fds(s
);
1680 static void socket_unwatch_fds(Socket
*s
) {
1686 LIST_FOREACH(port
, p
, s
->ports
) {
1690 if (!p
->event_source
)
1693 r
= sd_event_source_set_enabled(p
->event_source
, SD_EVENT_OFF
);
1695 log_unit_debug_errno(UNIT(s
), r
, "Failed to disable event source: %m");
1699 static int socket_watch_fds(Socket
*s
) {
1705 LIST_FOREACH(port
, p
, s
->ports
) {
1709 if (p
->event_source
) {
1710 r
= sd_event_source_set_enabled(p
->event_source
, SD_EVENT_ON
);
1714 r
= sd_event_add_io(UNIT(s
)->manager
->event
, &p
->event_source
, p
->fd
, EPOLLIN
, socket_dispatch_io
, p
);
1718 (void) sd_event_source_set_description(p
->event_source
, "socket-port-io");
1725 log_unit_warning_errno(UNIT(s
), r
, "Failed to watch listening fds: %m");
1726 socket_unwatch_fds(s
);
1736 static int socket_check_open(Socket
*s
) {
1737 bool have_open
= false, have_closed
= false;
1742 LIST_FOREACH(port
, p
, s
->ports
) {
1748 if (have_open
&& have_closed
)
1749 return SOCKET_OPEN_SOME
;
1753 return SOCKET_OPEN_ALL
;
1755 return SOCKET_OPEN_NONE
;
1758 static void socket_set_state(Socket
*s
, SocketState state
) {
1759 SocketState old_state
;
1762 old_state
= s
->state
;
1770 SOCKET_STOP_PRE_SIGTERM
,
1771 SOCKET_STOP_PRE_SIGKILL
,
1773 SOCKET_FINAL_SIGTERM
,
1774 SOCKET_FINAL_SIGKILL
)) {
1776 s
->timer_event_source
= sd_event_source_unref(s
->timer_event_source
);
1777 socket_unwatch_control_pid(s
);
1778 s
->control_command
= NULL
;
1779 s
->control_command_id
= _SOCKET_EXEC_COMMAND_INVALID
;
1782 if (state
!= SOCKET_LISTENING
)
1783 socket_unwatch_fds(s
);
1791 SOCKET_STOP_PRE_SIGTERM
,
1792 SOCKET_STOP_PRE_SIGKILL
))
1793 socket_close_fds(s
);
1795 if (state
!= old_state
)
1796 log_unit_debug(UNIT(s
), "Changed %s -> %s", socket_state_to_string(old_state
), socket_state_to_string(state
));
1798 unit_notify(UNIT(s
), state_translation_table
[old_state
], state_translation_table
[state
], true);
1801 static int socket_coldplug(Unit
*u
) {
1802 Socket
*s
= SOCKET(u
);
1806 assert(s
->state
== SOCKET_DEAD
);
1808 if (s
->deserialized_state
== s
->state
)
1811 if (s
->control_pid
> 0 &&
1812 pid_is_unwaited(s
->control_pid
) &&
1813 IN_SET(s
->deserialized_state
,
1818 SOCKET_STOP_PRE_SIGTERM
,
1819 SOCKET_STOP_PRE_SIGKILL
,
1821 SOCKET_FINAL_SIGTERM
,
1822 SOCKET_FINAL_SIGKILL
)) {
1824 r
= unit_watch_pid(UNIT(s
), s
->control_pid
);
1828 r
= socket_arm_timer(s
, usec_add(u
->state_change_timestamp
.monotonic
, s
->timeout_usec
));
1833 if (IN_SET(s
->deserialized_state
,
1839 /* Originally, we used to simply reopen all sockets here that we didn't have file descriptors
1840 * for. However, this is problematic, as we won't traverse throught the SOCKET_START_CHOWN state for
1841 * them, and thus the UID/GID wouldn't be right. Hence, instead simply check if we have all fds open,
1842 * and if there's a mismatch, warn loudly. */
1844 r
= socket_check_open(s
);
1845 if (r
== SOCKET_OPEN_NONE
)
1846 log_unit_warning(UNIT(s
),
1847 "Socket unit configuration has changed while unit has been running, "
1848 "no open socket file descriptor left. "
1849 "The socket unit is not functional until restarted.");
1850 else if (r
== SOCKET_OPEN_SOME
)
1851 log_unit_warning(UNIT(s
),
1852 "Socket unit configuration has changed while unit has been running, "
1853 "and some socket file descriptors have not been opened yet. "
1854 "The socket unit is not fully functional until restarted.");
1857 if (s
->deserialized_state
== SOCKET_LISTENING
) {
1858 r
= socket_watch_fds(s
);
1863 if (!IN_SET(s
->deserialized_state
, SOCKET_DEAD
, SOCKET_FAILED
)) {
1864 (void) unit_setup_dynamic_creds(u
);
1865 (void) unit_setup_exec_runtime(u
);
1868 socket_set_state(s
, s
->deserialized_state
);
1872 static int socket_spawn(Socket
*s
, ExecCommand
*c
, pid_t
*_pid
) {
1874 ExecParameters exec_params
= {
1875 .flags
= EXEC_APPLY_SANDBOXING
|EXEC_APPLY_CHROOT
|EXEC_APPLY_TTY_STDIN
,
1887 r
= unit_prepare_exec(UNIT(s
));
1891 r
= socket_arm_timer(s
, usec_add(now(CLOCK_MONOTONIC
), s
->timeout_usec
));
1895 unit_set_exec_params(UNIT(s
), &exec_params
);
1897 exec_params
.argv
= c
->argv
;
1899 r
= exec_spawn(UNIT(s
),
1909 r
= unit_watch_pid(UNIT(s
), pid
);
1911 /* FIXME: we need to do something here */
1919 static int socket_chown(Socket
*s
, pid_t
*_pid
) {
1923 r
= socket_arm_timer(s
, usec_add(now(CLOCK_MONOTONIC
), s
->timeout_usec
));
1927 /* We have to resolve the user names out-of-process, hence
1928 * let's fork here. It's messy, but well, what can we do? */
1930 r
= unit_fork_helper_process(UNIT(s
), "(sd-chown)", &pid
);
1934 uid_t uid
= UID_INVALID
;
1935 gid_t gid
= GID_INVALID
;
1940 if (!isempty(s
->user
)) {
1941 const char *user
= s
->user
;
1943 r
= get_user_creds(&user
, &uid
, &gid
, NULL
, NULL
);
1945 log_unit_error_errno(UNIT(s
), r
, "Failed to resolve user %s: %m", user
);
1950 if (!isempty(s
->group
)) {
1951 const char *group
= s
->group
;
1953 r
= get_group_creds(&group
, &gid
);
1955 log_unit_error_errno(UNIT(s
), r
, "Failed to resolve group %s: %m", group
);
1960 LIST_FOREACH(port
, p
, s
->ports
) {
1961 const char *path
= NULL
;
1963 if (p
->type
== SOCKET_SOCKET
)
1964 path
= socket_address_get_path(&p
->address
);
1965 else if (p
->type
== SOCKET_FIFO
)
1971 if (chown(path
, uid
, gid
) < 0) {
1972 log_unit_error_errno(UNIT(s
), errno
, "Failed to chown(): %m");
1977 _exit(EXIT_SUCCESS
);
1980 r
= unit_watch_pid(UNIT(s
), pid
);
1988 s
->timer_event_source
= sd_event_source_unref(s
->timer_event_source
);
1992 static void socket_enter_dead(Socket
*s
, SocketResult f
) {
1995 if (s
->result
== SOCKET_SUCCESS
)
1998 if (s
->result
!= SOCKET_SUCCESS
)
1999 log_unit_warning(UNIT(s
), "Failed with result '%s'.", socket_result_to_string(s
->result
));
2001 socket_set_state(s
, s
->result
!= SOCKET_SUCCESS
? SOCKET_FAILED
: SOCKET_DEAD
);
2003 s
->exec_runtime
= exec_runtime_unref(s
->exec_runtime
, true);
2005 exec_context_destroy_runtime_directory(&s
->exec_context
, UNIT(s
)->manager
->prefix
[EXEC_DIRECTORY_RUNTIME
]);
2007 unit_unref_uid_gid(UNIT(s
), true);
2009 dynamic_creds_destroy(&s
->dynamic_creds
);
2012 static void socket_enter_signal(Socket
*s
, SocketState state
, SocketResult f
);
2014 static void socket_enter_stop_post(Socket
*s
, SocketResult f
) {
2018 if (s
->result
== SOCKET_SUCCESS
)
2021 socket_unwatch_control_pid(s
);
2022 s
->control_command_id
= SOCKET_EXEC_STOP_POST
;
2023 s
->control_command
= s
->exec_command
[SOCKET_EXEC_STOP_POST
];
2025 if (s
->control_command
) {
2026 r
= socket_spawn(s
, s
->control_command
, &s
->control_pid
);
2030 socket_set_state(s
, SOCKET_STOP_POST
);
2032 socket_enter_signal(s
, SOCKET_FINAL_SIGTERM
, SOCKET_SUCCESS
);
2037 log_unit_warning_errno(UNIT(s
), r
, "Failed to run 'stop-post' task: %m");
2038 socket_enter_signal(s
, SOCKET_FINAL_SIGTERM
, SOCKET_FAILURE_RESOURCES
);
2041 static void socket_enter_signal(Socket
*s
, SocketState state
, SocketResult f
) {
2046 if (s
->result
== SOCKET_SUCCESS
)
2049 r
= unit_kill_context(
2052 !IN_SET(state
, SOCKET_STOP_PRE_SIGTERM
, SOCKET_FINAL_SIGTERM
) ?
2053 KILL_KILL
: KILL_TERMINATE
,
2061 r
= socket_arm_timer(s
, usec_add(now(CLOCK_MONOTONIC
), s
->timeout_usec
));
2065 socket_set_state(s
, state
);
2066 } else if (state
== SOCKET_STOP_PRE_SIGTERM
)
2067 socket_enter_signal(s
, SOCKET_STOP_PRE_SIGKILL
, SOCKET_SUCCESS
);
2068 else if (state
== SOCKET_STOP_PRE_SIGKILL
)
2069 socket_enter_stop_post(s
, SOCKET_SUCCESS
);
2070 else if (state
== SOCKET_FINAL_SIGTERM
)
2071 socket_enter_signal(s
, SOCKET_FINAL_SIGKILL
, SOCKET_SUCCESS
);
2073 socket_enter_dead(s
, SOCKET_SUCCESS
);
2078 log_unit_warning_errno(UNIT(s
), r
, "Failed to kill processes: %m");
2080 if (IN_SET(state
, SOCKET_STOP_PRE_SIGTERM
, SOCKET_STOP_PRE_SIGKILL
))
2081 socket_enter_stop_post(s
, SOCKET_FAILURE_RESOURCES
);
2083 socket_enter_dead(s
, SOCKET_FAILURE_RESOURCES
);
2086 static void socket_enter_stop_pre(Socket
*s
, SocketResult f
) {
2090 if (s
->result
== SOCKET_SUCCESS
)
2093 socket_unwatch_control_pid(s
);
2094 s
->control_command_id
= SOCKET_EXEC_STOP_PRE
;
2095 s
->control_command
= s
->exec_command
[SOCKET_EXEC_STOP_PRE
];
2097 if (s
->control_command
) {
2098 r
= socket_spawn(s
, s
->control_command
, &s
->control_pid
);
2102 socket_set_state(s
, SOCKET_STOP_PRE
);
2104 socket_enter_stop_post(s
, SOCKET_SUCCESS
);
2109 log_unit_warning_errno(UNIT(s
), r
, "Failed to run 'stop-pre' task: %m");
2110 socket_enter_stop_post(s
, SOCKET_FAILURE_RESOURCES
);
2113 static void socket_enter_listening(Socket
*s
) {
2117 r
= socket_watch_fds(s
);
2119 log_unit_warning_errno(UNIT(s
), r
, "Failed to watch sockets: %m");
2123 socket_set_state(s
, SOCKET_LISTENING
);
2127 socket_enter_stop_pre(s
, SOCKET_FAILURE_RESOURCES
);
2130 static void socket_enter_start_post(Socket
*s
) {
2134 socket_unwatch_control_pid(s
);
2135 s
->control_command_id
= SOCKET_EXEC_START_POST
;
2136 s
->control_command
= s
->exec_command
[SOCKET_EXEC_START_POST
];
2138 if (s
->control_command
) {
2139 r
= socket_spawn(s
, s
->control_command
, &s
->control_pid
);
2141 log_unit_warning_errno(UNIT(s
), r
, "Failed to run 'start-post' task: %m");
2145 socket_set_state(s
, SOCKET_START_POST
);
2147 socket_enter_listening(s
);
2152 socket_enter_stop_pre(s
, SOCKET_FAILURE_RESOURCES
);
2155 static void socket_enter_start_chown(Socket
*s
) {
2160 r
= socket_open_fds(s
);
2162 log_unit_warning_errno(UNIT(s
), r
, "Failed to listen on sockets: %m");
2166 if (!isempty(s
->user
) || !isempty(s
->group
)) {
2168 socket_unwatch_control_pid(s
);
2169 s
->control_command_id
= SOCKET_EXEC_START_CHOWN
;
2170 s
->control_command
= NULL
;
2172 r
= socket_chown(s
, &s
->control_pid
);
2174 log_unit_warning_errno(UNIT(s
), r
, "Failed to fork 'start-chown' task: %m");
2178 socket_set_state(s
, SOCKET_START_CHOWN
);
2180 socket_enter_start_post(s
);
2185 socket_enter_stop_pre(s
, SOCKET_FAILURE_RESOURCES
);
2188 static void socket_enter_start_pre(Socket
*s
) {
2192 socket_unwatch_control_pid(s
);
2194 unit_warn_leftover_processes(UNIT(s
));
2196 s
->control_command_id
= SOCKET_EXEC_START_PRE
;
2197 s
->control_command
= s
->exec_command
[SOCKET_EXEC_START_PRE
];
2199 if (s
->control_command
) {
2200 r
= socket_spawn(s
, s
->control_command
, &s
->control_pid
);
2202 log_unit_warning_errno(UNIT(s
), r
, "Failed to run 'start-pre' task: %m");
2206 socket_set_state(s
, SOCKET_START_PRE
);
2208 socket_enter_start_chown(s
);
2213 socket_enter_dead(s
, SOCKET_FAILURE_RESOURCES
);
2216 static void flush_ports(Socket
*s
) {
2219 /* Flush all incoming traffic, regardless if actual bytes or new connections, so that this socket isn't busy
2222 LIST_FOREACH(port
, p
, s
->ports
) {
2226 (void) flush_accept(p
->fd
);
2227 (void) flush_fd(p
->fd
);
2231 static void socket_enter_running(Socket
*s
, int cfd
) {
2232 _cleanup_(sd_bus_error_free
) sd_bus_error error
= SD_BUS_ERROR_NULL
;
2235 /* Note that this call takes possession of the connection fd passed. It either has to assign it somewhere or
2240 /* We don't take connections anymore if we are supposed to shut down anyway */
2241 if (unit_stop_pending(UNIT(s
))) {
2243 log_unit_debug(UNIT(s
), "Suppressing connection request since unit stop is scheduled.");
2246 cfd
= safe_close(cfd
);
2253 if (!ratelimit_below(&s
->trigger_limit
)) {
2255 log_unit_warning(UNIT(s
), "Trigger limit hit, refusing further activation.");
2256 socket_enter_stop_pre(s
, SOCKET_FAILURE_TRIGGER_LIMIT_HIT
);
2261 bool pending
= false;
2266 /* If there's already a start pending don't bother to
2268 HASHMAP_FOREACH_KEY(v
, other
, UNIT(s
)->dependencies
[UNIT_TRIGGERS
], i
)
2269 if (unit_active_or_pending(other
)) {
2275 if (!UNIT_ISSET(s
->service
)) {
2276 log_unit_error(UNIT(s
), "Service to activate vanished, refusing activation.");
2281 r
= manager_add_job(UNIT(s
)->manager
, JOB_START
, UNIT_DEREF(s
->service
), JOB_REPLACE
, &error
, NULL
);
2286 socket_set_state(s
, SOCKET_RUNNING
);
2288 _cleanup_free_
char *prefix
= NULL
, *instance
= NULL
, *name
= NULL
;
2289 _cleanup_(socket_peer_unrefp
) SocketPeer
*p
= NULL
;
2292 if (s
->n_connections
>= s
->max_connections
) {
2293 log_unit_warning(UNIT(s
), "Too many incoming connections (%u), dropping connection.",
2299 if (s
->max_connections_per_source
> 0) {
2300 r
= socket_acquire_peer(s
, cfd
, &p
);
2304 } else if (r
> 0 && p
->n_ref
> s
->max_connections_per_source
) {
2305 _cleanup_free_
char *t
= NULL
;
2307 (void) sockaddr_pretty(&p
->peer
.sa
, p
->peer_salen
, true, false, &t
);
2309 log_unit_warning(UNIT(s
),
2310 "Too many incoming connections (%u) from source %s, dropping connection.",
2311 p
->n_ref
, strnull(t
));
2317 r
= socket_instantiate_service(s
);
2321 r
= instance_from_socket(cfd
, s
->n_accepted
, &instance
);
2326 /* ENOTCONN is legitimate if TCP RST was received.
2327 * This connection is over, but the socket unit lives on. */
2328 log_unit_debug(UNIT(s
), "Got ENOTCONN on incoming socket, assuming aborted connection attempt, ignoring.");
2333 r
= unit_name_to_prefix(UNIT(s
)->id
, &prefix
);
2337 r
= unit_name_build(prefix
, instance
, ".service", &name
);
2341 r
= unit_add_name(UNIT_DEREF(s
->service
), name
);
2345 service
= SERVICE(UNIT_DEREF(s
->service
));
2346 unit_ref_unset(&s
->service
);
2349 unit_choose_id(UNIT(service
), name
);
2351 r
= service_set_socket_fd(service
, cfd
, s
, s
->selinux_context_from_net
);
2355 cfd
= -1; /* We passed ownership of the fd to the service now. Forget it here. */
2358 service
->peer
= TAKE_PTR(p
); /* Pass ownership of the peer reference */
2360 r
= manager_add_job(UNIT(s
)->manager
, JOB_START
, UNIT(service
), JOB_REPLACE
, &error
, NULL
);
2362 /* We failed to activate the new service, but it still exists. Let's make sure the service
2363 * closes and forgets the connection fd again, immediately. */
2364 service_close_socket_fd(service
);
2368 /* Notify clients about changed counters */
2369 unit_add_to_dbus_queue(UNIT(s
));
2375 log_unit_warning(UNIT(s
), "Failed to queue service startup job (Maybe the service file is missing or not a %s unit?): %s",
2376 cfd
>= 0 ? "template" : "non-template",
2377 bus_error_message(&error
, r
));
2379 socket_enter_stop_pre(s
, SOCKET_FAILURE_RESOURCES
);
2383 static void socket_run_next(Socket
*s
) {
2387 assert(s
->control_command
);
2388 assert(s
->control_command
->command_next
);
2390 socket_unwatch_control_pid(s
);
2392 s
->control_command
= s
->control_command
->command_next
;
2394 r
= socket_spawn(s
, s
->control_command
, &s
->control_pid
);
2401 log_unit_warning_errno(UNIT(s
), r
, "Failed to run next task: %m");
2403 if (s
->state
== SOCKET_START_POST
)
2404 socket_enter_stop_pre(s
, SOCKET_FAILURE_RESOURCES
);
2405 else if (s
->state
== SOCKET_STOP_POST
)
2406 socket_enter_dead(s
, SOCKET_FAILURE_RESOURCES
);
2408 socket_enter_signal(s
, SOCKET_FINAL_SIGTERM
, SOCKET_FAILURE_RESOURCES
);
2411 static int socket_start(Unit
*u
) {
2412 Socket
*s
= SOCKET(u
);
2417 /* We cannot fulfill this request right now, try again later
2419 if (IN_SET(s
->state
,
2421 SOCKET_STOP_PRE_SIGKILL
,
2422 SOCKET_STOP_PRE_SIGTERM
,
2424 SOCKET_FINAL_SIGTERM
,
2425 SOCKET_FINAL_SIGKILL
))
2428 /* Already on it! */
2429 if (IN_SET(s
->state
,
2435 /* Cannot run this without the service being around */
2436 if (UNIT_ISSET(s
->service
)) {
2439 service
= SERVICE(UNIT_DEREF(s
->service
));
2441 if (UNIT(service
)->load_state
!= UNIT_LOADED
) {
2442 log_unit_error(u
, "Socket service %s not loaded, refusing.", UNIT(service
)->id
);
2446 /* If the service is already active we cannot start the
2448 if (!IN_SET(service
->state
, SERVICE_DEAD
, SERVICE_FAILED
, SERVICE_AUTO_RESTART
)) {
2449 log_unit_error(u
, "Socket service %s already active, refusing.", UNIT(service
)->id
);
2454 assert(IN_SET(s
->state
, SOCKET_DEAD
, SOCKET_FAILED
));
2456 r
= unit_start_limit_test(u
);
2458 socket_enter_dead(s
, SOCKET_FAILURE_START_LIMIT_HIT
);
2462 r
= unit_acquire_invocation_id(u
);
2466 s
->result
= SOCKET_SUCCESS
;
2468 u
->reset_accounting
= true;
2470 socket_enter_start_pre(s
);
2474 static int socket_stop(Unit
*u
) {
2475 Socket
*s
= SOCKET(u
);
2480 if (IN_SET(s
->state
,
2482 SOCKET_STOP_PRE_SIGTERM
,
2483 SOCKET_STOP_PRE_SIGKILL
,
2485 SOCKET_FINAL_SIGTERM
,
2486 SOCKET_FINAL_SIGKILL
))
2489 /* If there's already something running we go directly into
2491 if (IN_SET(s
->state
,
2494 SOCKET_START_POST
)) {
2495 socket_enter_signal(s
, SOCKET_STOP_PRE_SIGTERM
, SOCKET_SUCCESS
);
2499 assert(IN_SET(s
->state
, SOCKET_LISTENING
, SOCKET_RUNNING
));
2501 socket_enter_stop_pre(s
, SOCKET_SUCCESS
);
2505 static int socket_serialize(Unit
*u
, FILE *f
, FDSet
*fds
) {
2506 Socket
*s
= SOCKET(u
);
2514 unit_serialize_item(u
, f
, "state", socket_state_to_string(s
->state
));
2515 unit_serialize_item(u
, f
, "result", socket_result_to_string(s
->result
));
2516 unit_serialize_item_format(u
, f
, "n-accepted", "%u", s
->n_accepted
);
2518 if (s
->control_pid
> 0)
2519 unit_serialize_item_format(u
, f
, "control-pid", PID_FMT
, s
->control_pid
);
2521 if (s
->control_command_id
>= 0)
2522 unit_serialize_item(u
, f
, "control-command", socket_exec_command_to_string(s
->control_command_id
));
2524 LIST_FOREACH(port
, p
, s
->ports
) {
2530 copy
= fdset_put_dup(fds
, p
->fd
);
2534 if (p
->type
== SOCKET_SOCKET
) {
2535 _cleanup_free_
char *t
= NULL
;
2537 r
= socket_address_print(&p
->address
, &t
);
2541 if (socket_address_family(&p
->address
) == AF_NETLINK
)
2542 unit_serialize_item_format(u
, f
, "netlink", "%i %s", copy
, t
);
2544 unit_serialize_item_format(u
, f
, "socket", "%i %i %s", copy
, p
->address
.type
, t
);
2546 } else if (p
->type
== SOCKET_SPECIAL
)
2547 unit_serialize_item_format(u
, f
, "special", "%i %s", copy
, p
->path
);
2548 else if (p
->type
== SOCKET_MQUEUE
)
2549 unit_serialize_item_format(u
, f
, "mqueue", "%i %s", copy
, p
->path
);
2550 else if (p
->type
== SOCKET_USB_FUNCTION
)
2551 unit_serialize_item_format(u
, f
, "ffs", "%i %s", copy
, p
->path
);
2553 assert(p
->type
== SOCKET_FIFO
);
2554 unit_serialize_item_format(u
, f
, "fifo", "%i %s", copy
, p
->path
);
2561 static void socket_port_take_fd(SocketPort
*p
, FDSet
*fds
, int fd
) {
2563 p
->fd
= fdset_remove(fds
, fd
);
2566 static int socket_deserialize_item(Unit
*u
, const char *key
, const char *value
, FDSet
*fds
) {
2567 Socket
*s
= SOCKET(u
);
2573 if (streq(key
, "state")) {
2576 state
= socket_state_from_string(value
);
2578 log_unit_debug(u
, "Failed to parse state value: %s", value
);
2580 s
->deserialized_state
= state
;
2581 } else if (streq(key
, "result")) {
2584 f
= socket_result_from_string(value
);
2586 log_unit_debug(u
, "Failed to parse result value: %s", value
);
2587 else if (f
!= SOCKET_SUCCESS
)
2590 } else if (streq(key
, "n-accepted")) {
2593 if (safe_atou(value
, &k
) < 0)
2594 log_unit_debug(u
, "Failed to parse n-accepted value: %s", value
);
2597 } else if (streq(key
, "control-pid")) {
2600 if (parse_pid(value
, &pid
) < 0)
2601 log_unit_debug(u
, "Failed to parse control-pid value: %s", value
);
2603 s
->control_pid
= pid
;
2604 } else if (streq(key
, "control-command")) {
2605 SocketExecCommand id
;
2607 id
= socket_exec_command_from_string(value
);
2609 log_unit_debug(u
, "Failed to parse exec-command value: %s", value
);
2611 s
->control_command_id
= id
;
2612 s
->control_command
= s
->exec_command
[id
];
2614 } else if (streq(key
, "fifo")) {
2618 if (sscanf(value
, "%i %n", &fd
, &skip
) < 1 || fd
< 0 || !fdset_contains(fds
, fd
))
2619 log_unit_debug(u
, "Failed to parse fifo value: %s", value
);
2621 LIST_FOREACH(port
, p
, s
->ports
)
2622 if (p
->type
== SOCKET_FIFO
&&
2623 path_equal_or_files_same(p
->path
, value
+skip
, 0)) {
2624 socket_port_take_fd(p
, fds
, fd
);
2628 } else if (streq(key
, "special")) {
2632 if (sscanf(value
, "%i %n", &fd
, &skip
) < 1 || fd
< 0 || !fdset_contains(fds
, fd
))
2633 log_unit_debug(u
, "Failed to parse special value: %s", value
);
2635 LIST_FOREACH(port
, p
, s
->ports
)
2636 if (p
->type
== SOCKET_SPECIAL
&&
2637 path_equal_or_files_same(p
->path
, value
+skip
, 0)) {
2638 socket_port_take_fd(p
, fds
, fd
);
2642 } else if (streq(key
, "mqueue")) {
2646 if (sscanf(value
, "%i %n", &fd
, &skip
) < 1 || fd
< 0 || !fdset_contains(fds
, fd
))
2647 log_unit_debug(u
, "Failed to parse mqueue value: %s", value
);
2649 LIST_FOREACH(port
, p
, s
->ports
)
2650 if (p
->type
== SOCKET_MQUEUE
&&
2651 streq(p
->path
, value
+skip
)) {
2652 socket_port_take_fd(p
, fds
, fd
);
2656 } else if (streq(key
, "socket")) {
2657 int fd
, type
, skip
= 0;
2660 if (sscanf(value
, "%i %i %n", &fd
, &type
, &skip
) < 2 || fd
< 0 || type
< 0 || !fdset_contains(fds
, fd
))
2661 log_unit_debug(u
, "Failed to parse socket value: %s", value
);
2663 LIST_FOREACH(port
, p
, s
->ports
)
2664 if (socket_address_is(&p
->address
, value
+skip
, type
)) {
2665 socket_port_take_fd(p
, fds
, fd
);
2669 } else if (streq(key
, "netlink")) {
2673 if (sscanf(value
, "%i %n", &fd
, &skip
) < 1 || fd
< 0 || !fdset_contains(fds
, fd
))
2674 log_unit_debug(u
, "Failed to parse socket value: %s", value
);
2676 LIST_FOREACH(port
, p
, s
->ports
)
2677 if (socket_address_is_netlink(&p
->address
, value
+skip
)) {
2678 socket_port_take_fd(p
, fds
, fd
);
2682 } else if (streq(key
, "ffs")) {
2686 if (sscanf(value
, "%i %n", &fd
, &skip
) < 1 || fd
< 0 || !fdset_contains(fds
, fd
))
2687 log_unit_debug(u
, "Failed to parse ffs value: %s", value
);
2689 LIST_FOREACH(port
, p
, s
->ports
)
2690 if (p
->type
== SOCKET_USB_FUNCTION
&&
2691 path_equal_or_files_same(p
->path
, value
+skip
, 0)) {
2692 socket_port_take_fd(p
, fds
, fd
);
2697 log_unit_debug(UNIT(s
), "Unknown serialization key: %s", key
);
2702 static void socket_distribute_fds(Unit
*u
, FDSet
*fds
) {
2703 Socket
*s
= SOCKET(u
);
2708 LIST_FOREACH(port
, p
, s
->ports
) {
2712 if (p
->type
!= SOCKET_SOCKET
)
2718 FDSET_FOREACH(fd
, fds
, i
) {
2719 if (socket_address_matches_fd(&p
->address
, fd
)) {
2720 p
->fd
= fdset_remove(fds
, fd
);
2721 s
->deserialized_state
= SOCKET_LISTENING
;
2728 _pure_
static UnitActiveState
socket_active_state(Unit
*u
) {
2731 return state_translation_table
[SOCKET(u
)->state
];
2734 _pure_
static const char *socket_sub_state_to_string(Unit
*u
) {
2737 return socket_state_to_string(SOCKET(u
)->state
);
2740 const char* socket_port_type_to_string(SocketPort
*p
) {
2748 switch (p
->address
.type
) {
2756 case SOCK_SEQPACKET
:
2757 return "SequentialPacket";
2760 if (socket_address_family(&p
->address
) == AF_NETLINK
)
2768 case SOCKET_SPECIAL
:
2772 return "MessageQueue";
2777 case SOCKET_USB_FUNCTION
:
2778 return "USBFunction";
2785 SocketType
socket_port_type_from_string(const char *s
) {
2788 if (STR_IN_SET(s
, "Stream", "Datagram", "SequentialPacket", "Netlink"))
2789 return SOCKET_SOCKET
;
2790 else if (streq(s
, "Special"))
2791 return SOCKET_SPECIAL
;
2792 else if (streq(s
, "MessageQueue"))
2793 return SOCKET_MQUEUE
;
2794 else if (streq(s
, "FIFO"))
2796 else if (streq(s
, "USBFunction"))
2797 return SOCKET_USB_FUNCTION
;
2799 return _SOCKET_TYPE_INVALID
;
2802 _pure_
static bool socket_may_gc(Unit
*u
) {
2803 Socket
*s
= SOCKET(u
);
2807 return s
->n_connections
== 0;
2810 static int socket_accept_do(Socket
*s
, int fd
) {
2817 cfd
= accept4(fd
, NULL
, NULL
, SOCK_NONBLOCK
);
2831 static int socket_accept_in_cgroup(Socket
*s
, SocketPort
*p
, int fd
) {
2832 _cleanup_close_pair_
int pair
[2] = { -1, -1 };
2840 /* Similar to socket_address_listen_in_cgroup(), but for accept() rathern than socket(): make sure that any
2841 * connection socket is also properly associated with the cgroup. */
2843 if (!IN_SET(p
->address
.sockaddr
.sa
.sa_family
, AF_INET
, AF_INET6
))
2846 r
= bpf_firewall_supported();
2849 if (r
== BPF_FIREWALL_UNSUPPORTED
)
2852 if (socketpair(AF_UNIX
, SOCK_SEQPACKET
|SOCK_CLOEXEC
, 0, pair
) < 0)
2853 return log_unit_error_errno(UNIT(s
), errno
, "Failed to create communication channel: %m");
2855 r
= unit_fork_helper_process(UNIT(s
), "(sd-accept)", &pid
);
2857 return log_unit_error_errno(UNIT(s
), r
, "Failed to fork off accept stub process: %m");
2861 pair
[0] = safe_close(pair
[0]);
2863 cfd
= socket_accept_do(s
, fd
);
2865 log_unit_error_errno(UNIT(s
), cfd
, "Failed to accept connection socket: %m");
2866 _exit(EXIT_FAILURE
);
2869 r
= send_one_fd(pair
[1], cfd
, 0);
2871 log_unit_error_errno(UNIT(s
), r
, "Failed to send connection socket to parent: %m");
2872 _exit(EXIT_FAILURE
);
2875 _exit(EXIT_SUCCESS
);
2878 pair
[1] = safe_close(pair
[1]);
2879 cfd
= receive_one_fd(pair
[0], 0);
2881 /* We synchronously wait for the helper, as it shouldn't be slow */
2882 r
= wait_for_terminate_and_check("(sd-accept)", pid
, WAIT_LOG_ABNORMAL
);
2889 return log_unit_error_errno(UNIT(s
), cfd
, "Failed to receive connection socket: %m");
2894 cfd
= socket_accept_do(s
, fd
);
2896 return log_unit_error_errno(UNIT(s
), cfd
, "Failed to accept connection socket: %m");
2901 static int socket_dispatch_io(sd_event_source
*source
, int fd
, uint32_t revents
, void *userdata
) {
2902 SocketPort
*p
= userdata
;
2908 if (p
->socket
->state
!= SOCKET_LISTENING
)
2911 log_unit_debug(UNIT(p
->socket
), "Incoming traffic");
2913 if (revents
!= EPOLLIN
) {
2915 if (revents
& EPOLLHUP
)
2916 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.");
2918 log_unit_error(UNIT(p
->socket
), "Got unexpected poll event (0x%x) on socket.", revents
);
2922 if (p
->socket
->accept
&&
2923 p
->type
== SOCKET_SOCKET
&&
2924 socket_address_can_accept(&p
->address
)) {
2926 cfd
= socket_accept_in_cgroup(p
->socket
, p
, fd
);
2930 socket_apply_socket_options(p
->socket
, cfd
);
2933 socket_enter_running(p
->socket
, cfd
);
2937 socket_enter_stop_pre(p
->socket
, SOCKET_FAILURE_RESOURCES
);
2941 static void socket_sigchld_event(Unit
*u
, pid_t pid
, int code
, int status
) {
2942 Socket
*s
= SOCKET(u
);
2948 if (pid
!= s
->control_pid
)
2953 if (is_clean_exit(code
, status
, EXIT_CLEAN_COMMAND
, NULL
))
2955 else if (code
== CLD_EXITED
)
2956 f
= SOCKET_FAILURE_EXIT_CODE
;
2957 else if (code
== CLD_KILLED
)
2958 f
= SOCKET_FAILURE_SIGNAL
;
2959 else if (code
== CLD_DUMPED
)
2960 f
= SOCKET_FAILURE_CORE_DUMP
;
2962 assert_not_reached("Unknown sigchld code");
2964 if (s
->control_command
) {
2965 exec_status_exit(&s
->control_command
->exec_status
, &s
->exec_context
, pid
, code
, status
);
2967 if (s
->control_command
->flags
& EXEC_COMMAND_IGNORE_FAILURE
)
2971 log_unit_full(u
, f
== SOCKET_SUCCESS
? LOG_DEBUG
: LOG_NOTICE
, 0,
2972 "Control process exited, code=%s status=%i",
2973 sigchld_code_to_string(code
), status
);
2975 if (s
->result
== SOCKET_SUCCESS
)
2978 if (s
->control_command
&&
2979 s
->control_command
->command_next
&&
2980 f
== SOCKET_SUCCESS
) {
2982 log_unit_debug(u
, "Running next command for state %s", socket_state_to_string(s
->state
));
2985 s
->control_command
= NULL
;
2986 s
->control_command_id
= _SOCKET_EXEC_COMMAND_INVALID
;
2988 /* No further commands for this step, so let's figure
2989 * out what to do next */
2991 log_unit_debug(u
, "Got final SIGCHLD for state %s", socket_state_to_string(s
->state
));
2995 case SOCKET_START_PRE
:
2996 if (f
== SOCKET_SUCCESS
)
2997 socket_enter_start_chown(s
);
2999 socket_enter_signal(s
, SOCKET_FINAL_SIGTERM
, f
);
3002 case SOCKET_START_CHOWN
:
3003 if (f
== SOCKET_SUCCESS
)
3004 socket_enter_start_post(s
);
3006 socket_enter_stop_pre(s
, f
);
3009 case SOCKET_START_POST
:
3010 if (f
== SOCKET_SUCCESS
)
3011 socket_enter_listening(s
);
3013 socket_enter_stop_pre(s
, f
);
3016 case SOCKET_STOP_PRE
:
3017 case SOCKET_STOP_PRE_SIGTERM
:
3018 case SOCKET_STOP_PRE_SIGKILL
:
3019 socket_enter_stop_post(s
, f
);
3022 case SOCKET_STOP_POST
:
3023 case SOCKET_FINAL_SIGTERM
:
3024 case SOCKET_FINAL_SIGKILL
:
3025 socket_enter_dead(s
, f
);
3029 assert_not_reached("Uh, control process died at wrong time.");
3033 /* Notify clients about changed exit status */
3034 unit_add_to_dbus_queue(u
);
3037 static int socket_dispatch_timer(sd_event_source
*source
, usec_t usec
, void *userdata
) {
3038 Socket
*s
= SOCKET(userdata
);
3041 assert(s
->timer_event_source
== source
);
3045 case SOCKET_START_PRE
:
3046 log_unit_warning(UNIT(s
), "Starting timed out. Terminating.");
3047 socket_enter_signal(s
, SOCKET_FINAL_SIGTERM
, SOCKET_FAILURE_TIMEOUT
);
3050 case SOCKET_START_CHOWN
:
3051 case SOCKET_START_POST
:
3052 log_unit_warning(UNIT(s
), "Starting timed out. Stopping.");
3053 socket_enter_stop_pre(s
, SOCKET_FAILURE_TIMEOUT
);
3056 case SOCKET_STOP_PRE
:
3057 log_unit_warning(UNIT(s
), "Stopping timed out. Terminating.");
3058 socket_enter_signal(s
, SOCKET_STOP_PRE_SIGTERM
, SOCKET_FAILURE_TIMEOUT
);
3061 case SOCKET_STOP_PRE_SIGTERM
:
3062 if (s
->kill_context
.send_sigkill
) {
3063 log_unit_warning(UNIT(s
), "Stopping timed out. Killing.");
3064 socket_enter_signal(s
, SOCKET_STOP_PRE_SIGKILL
, SOCKET_FAILURE_TIMEOUT
);
3066 log_unit_warning(UNIT(s
), "Stopping timed out. Skipping SIGKILL. Ignoring.");
3067 socket_enter_stop_post(s
, SOCKET_FAILURE_TIMEOUT
);
3071 case SOCKET_STOP_PRE_SIGKILL
:
3072 log_unit_warning(UNIT(s
), "Processes still around after SIGKILL. Ignoring.");
3073 socket_enter_stop_post(s
, SOCKET_FAILURE_TIMEOUT
);
3076 case SOCKET_STOP_POST
:
3077 log_unit_warning(UNIT(s
), "Stopping timed out (2). Terminating.");
3078 socket_enter_signal(s
, SOCKET_FINAL_SIGTERM
, SOCKET_FAILURE_TIMEOUT
);
3081 case SOCKET_FINAL_SIGTERM
:
3082 if (s
->kill_context
.send_sigkill
) {
3083 log_unit_warning(UNIT(s
), "Stopping timed out (2). Killing.");
3084 socket_enter_signal(s
, SOCKET_FINAL_SIGKILL
, SOCKET_FAILURE_TIMEOUT
);
3086 log_unit_warning(UNIT(s
), "Stopping timed out (2). Skipping SIGKILL. Ignoring.");
3087 socket_enter_dead(s
, SOCKET_FAILURE_TIMEOUT
);
3091 case SOCKET_FINAL_SIGKILL
:
3092 log_unit_warning(UNIT(s
), "Still around after SIGKILL (2). Entering failed mode.");
3093 socket_enter_dead(s
, SOCKET_FAILURE_TIMEOUT
);
3097 assert_not_reached("Timeout at wrong time.");
3103 int socket_collect_fds(Socket
*s
, int **fds
) {
3104 size_t k
= 0, n
= 0;
3111 /* Called from the service code for requesting our fds */
3113 LIST_FOREACH(port
, p
, s
->ports
) {
3116 n
+= p
->n_auxiliary_fds
;
3128 LIST_FOREACH(port
, p
, s
->ports
) {
3133 for (i
= 0; i
< p
->n_auxiliary_fds
; ++i
)
3134 rfds
[k
++] = p
->auxiliary_fds
[i
];
3143 static void socket_reset_failed(Unit
*u
) {
3144 Socket
*s
= SOCKET(u
);
3148 if (s
->state
== SOCKET_FAILED
)
3149 socket_set_state(s
, SOCKET_DEAD
);
3151 s
->result
= SOCKET_SUCCESS
;
3154 void socket_connection_unref(Socket
*s
) {
3157 /* The service is dead. Yay!
3159 * This is strictly for one-instance-per-connection
3162 assert(s
->n_connections
> 0);
3165 log_unit_debug(UNIT(s
), "One connection closed, %u left.", s
->n_connections
);
3168 static void socket_trigger_notify(Unit
*u
, Unit
*other
) {
3169 Socket
*s
= SOCKET(u
);
3174 /* Filter out invocations with bogus state */
3175 if (other
->load_state
!= UNIT_LOADED
|| other
->type
!= UNIT_SERVICE
)
3178 /* Don't propagate state changes from the service if we are already down */
3179 if (!IN_SET(s
->state
, SOCKET_RUNNING
, SOCKET_LISTENING
))
3182 /* We don't care for the service state if we are in Accept=yes mode */
3186 /* Propagate start limit hit state */
3187 if (other
->start_limit_hit
) {
3188 socket_enter_stop_pre(s
, SOCKET_FAILURE_SERVICE_START_LIMIT_HIT
);
3192 /* Don't propagate anything if there's still a job queued */
3196 if (IN_SET(SERVICE(other
)->state
,
3197 SERVICE_DEAD
, SERVICE_FAILED
,
3198 SERVICE_FINAL_SIGTERM
, SERVICE_FINAL_SIGKILL
,
3199 SERVICE_AUTO_RESTART
))
3200 socket_enter_listening(s
);
3202 if (SERVICE(other
)->state
== SERVICE_RUNNING
)
3203 socket_set_state(s
, SOCKET_RUNNING
);
3206 static int socket_kill(Unit
*u
, KillWho who
, int signo
, sd_bus_error
*error
) {
3207 return unit_kill_common(u
, who
, signo
, -1, SOCKET(u
)->control_pid
, error
);
3210 static int socket_get_timeout(Unit
*u
, usec_t
*timeout
) {
3211 Socket
*s
= SOCKET(u
);
3215 if (!s
->timer_event_source
)
3218 r
= sd_event_source_get_time(s
->timer_event_source
, &t
);
3221 if (t
== USEC_INFINITY
)
3228 char *socket_fdname(Socket
*s
) {
3231 /* Returns the name to use for $LISTEN_NAMES. If the user
3232 * didn't specify anything specifically, use the socket unit's
3233 * name as fallback. */
3235 return s
->fdname
?: UNIT(s
)->id
;
3238 static int socket_control_pid(Unit
*u
) {
3239 Socket
*s
= SOCKET(u
);
3243 return s
->control_pid
;
3246 static const char* const socket_exec_command_table
[_SOCKET_EXEC_COMMAND_MAX
] = {
3247 [SOCKET_EXEC_START_PRE
] = "ExecStartPre",
3248 [SOCKET_EXEC_START_CHOWN
] = "ExecStartChown",
3249 [SOCKET_EXEC_START_POST
] = "ExecStartPost",
3250 [SOCKET_EXEC_STOP_PRE
] = "ExecStopPre",
3251 [SOCKET_EXEC_STOP_POST
] = "ExecStopPost"
3254 DEFINE_STRING_TABLE_LOOKUP(socket_exec_command
, SocketExecCommand
);
3256 static const char* const socket_result_table
[_SOCKET_RESULT_MAX
] = {
3257 [SOCKET_SUCCESS
] = "success",
3258 [SOCKET_FAILURE_RESOURCES
] = "resources",
3259 [SOCKET_FAILURE_TIMEOUT
] = "timeout",
3260 [SOCKET_FAILURE_EXIT_CODE
] = "exit-code",
3261 [SOCKET_FAILURE_SIGNAL
] = "signal",
3262 [SOCKET_FAILURE_CORE_DUMP
] = "core-dump",
3263 [SOCKET_FAILURE_START_LIMIT_HIT
] = "start-limit-hit",
3264 [SOCKET_FAILURE_TRIGGER_LIMIT_HIT
] = "trigger-limit-hit",
3265 [SOCKET_FAILURE_SERVICE_START_LIMIT_HIT
] = "service-start-limit-hit"
3268 DEFINE_STRING_TABLE_LOOKUP(socket_result
, SocketResult
);
3270 const UnitVTable socket_vtable
= {
3271 .object_size
= sizeof(Socket
),
3272 .exec_context_offset
= offsetof(Socket
, exec_context
),
3273 .cgroup_context_offset
= offsetof(Socket
, cgroup_context
),
3274 .kill_context_offset
= offsetof(Socket
, kill_context
),
3275 .exec_runtime_offset
= offsetof(Socket
, exec_runtime
),
3276 .dynamic_creds_offset
= offsetof(Socket
, dynamic_creds
),
3282 .private_section
= "Socket",
3284 .can_transient
= true,
3286 .init
= socket_init
,
3287 .done
= socket_done
,
3288 .load
= socket_load
,
3290 .coldplug
= socket_coldplug
,
3292 .dump
= socket_dump
,
3294 .start
= socket_start
,
3295 .stop
= socket_stop
,
3297 .kill
= socket_kill
,
3299 .get_timeout
= socket_get_timeout
,
3301 .serialize
= socket_serialize
,
3302 .deserialize_item
= socket_deserialize_item
,
3303 .distribute_fds
= socket_distribute_fds
,
3305 .active_state
= socket_active_state
,
3306 .sub_state_to_string
= socket_sub_state_to_string
,
3308 .may_gc
= socket_may_gc
,
3310 .sigchld_event
= socket_sigchld_event
,
3312 .trigger_notify
= socket_trigger_notify
,
3314 .reset_failed
= socket_reset_failed
,
3316 .control_pid
= socket_control_pid
,
3318 .bus_vtable
= bus_socket_vtable
,
3319 .bus_set_property
= bus_socket_set_property
,
3320 .bus_commit_properties
= bus_socket_commit_properties
,
3322 .status_message_formats
= {
3323 /*.starting_stopping = {
3324 [0] = "Starting socket %s...",
3325 [1] = "Stopping socket %s...",
3327 .finished_start_job
= {
3328 [JOB_DONE
] = "Listening on %s.",
3329 [JOB_FAILED
] = "Failed to listen on %s.",
3330 [JOB_TIMEOUT
] = "Timed out starting %s.",
3332 .finished_stop_job
= {
3333 [JOB_DONE
] = "Closed %s.",
3334 [JOB_FAILED
] = "Failed stopping %s.",
3335 [JOB_TIMEOUT
] = "Timed out stopping %s.",