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
)
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
)
796 "%sKeepAliveProbes: %u\n",
797 prefix
, s
->keep_alive_cnt
);
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
) {
806 if (p
->type
== SOCKET_SOCKET
) {
811 r
= socket_address_print(&p
->address
, &k
);
817 fprintf(f
, "%s%s: %s\n", prefix
, listen_lookup(socket_address_family(&p
->address
), p
->address
.type
), t
);
819 } else if (p
->type
== SOCKET_SPECIAL
)
820 fprintf(f
, "%sListenSpecial: %s\n", prefix
, p
->path
);
821 else if (p
->type
== SOCKET_USB_FUNCTION
)
822 fprintf(f
, "%sListenUSBFunction: %s\n", prefix
, p
->path
);
823 else if (p
->type
== SOCKET_MQUEUE
)
824 fprintf(f
, "%sListenMessageQueue: %s\n", prefix
, p
->path
);
826 fprintf(f
, "%sListenFIFO: %s\n", prefix
, p
->path
);
830 "%sTriggerLimitIntervalSec: %s\n"
831 "%sTriggerLimitBurst: %u\n",
832 prefix
, format_timespan(time_string
, FORMAT_TIMESPAN_MAX
, s
->trigger_limit
.interval
, USEC_PER_SEC
),
833 prefix
, s
->trigger_limit
.burst
);
835 str
= socket_protocol_to_name(s
->socket_protocol
);
837 fprintf(f
, "%sSocketProtocol: %s\n", prefix
, str
);
839 if (!strv_isempty(s
->symlinks
)) {
842 fprintf(f
, "%sSymlinks:", prefix
);
843 STRV_FOREACH(q
, s
->symlinks
)
844 fprintf(f
, " %s", *q
);
850 "%sTimeoutSec: %s\n",
851 prefix
, format_timespan(time_string
, FORMAT_TIMESPAN_MAX
, s
->timeout_usec
, USEC_PER_SEC
));
853 exec_context_dump(&s
->exec_context
, f
, prefix
);
854 kill_context_dump(&s
->kill_context
, f
, prefix
);
856 for (c
= 0; c
< _SOCKET_EXEC_COMMAND_MAX
; c
++) {
857 if (!s
->exec_command
[c
])
860 fprintf(f
, "%s-> %s:\n",
861 prefix
, socket_exec_command_to_string(c
));
863 exec_command_dump_list(s
->exec_command
[c
], f
, prefix2
);
866 cgroup_context_dump(&s
->cgroup_context
, f
, prefix
);
869 static int instance_from_socket(int fd
, unsigned nr
, char **instance
) {
872 union sockaddr_union local
, remote
;
878 if (getsockname(fd
, &local
.sa
, &l
) < 0)
882 if (getpeername(fd
, &remote
.sa
, &l
) < 0)
885 switch (local
.sa
.sa_family
) {
889 a
= be32toh(local
.in
.sin_addr
.s_addr
),
890 b
= be32toh(remote
.in
.sin_addr
.s_addr
);
893 "%u-%u.%u.%u.%u:%u-%u.%u.%u.%u:%u",
895 a
>> 24, (a
>> 16) & 0xFF, (a
>> 8) & 0xFF, a
& 0xFF,
896 be16toh(local
.in
.sin_port
),
897 b
>> 24, (b
>> 16) & 0xFF, (b
>> 8) & 0xFF, b
& 0xFF,
898 be16toh(remote
.in
.sin_port
)) < 0)
905 static const unsigned char ipv4_prefix
[] = {
906 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0xFF, 0xFF
909 if (memcmp(&local
.in6
.sin6_addr
, ipv4_prefix
, sizeof(ipv4_prefix
)) == 0 &&
910 memcmp(&remote
.in6
.sin6_addr
, ipv4_prefix
, sizeof(ipv4_prefix
)) == 0) {
912 *a
= local
.in6
.sin6_addr
.s6_addr
+12,
913 *b
= remote
.in6
.sin6_addr
.s6_addr
+12;
916 "%u-%u.%u.%u.%u:%u-%u.%u.%u.%u:%u",
918 a
[0], a
[1], a
[2], a
[3],
919 be16toh(local
.in6
.sin6_port
),
920 b
[0], b
[1], b
[2], b
[3],
921 be16toh(remote
.in6
.sin6_port
)) < 0)
924 char a
[INET6_ADDRSTRLEN
], b
[INET6_ADDRSTRLEN
];
929 inet_ntop(AF_INET6
, &local
.in6
.sin6_addr
, a
, sizeof(a
)),
930 be16toh(local
.in6
.sin6_port
),
931 inet_ntop(AF_INET6
, &remote
.in6
.sin6_addr
, b
, sizeof(b
)),
932 be16toh(remote
.in6
.sin6_port
)) < 0)
943 k
= getpeercred(fd
, &ucred
);
946 "%u-"PID_FMT
"-"UID_FMT
,
947 nr
, ucred
.pid
, ucred
.uid
) < 0)
949 } else if (k
== -ENODATA
) {
950 /* This handles the case where somebody is
951 * connecting from another pid/uid namespace
952 * (e.g. from outside of our container). */
967 local
.vm
.svm_cid
, local
.vm
.svm_port
,
968 remote
.vm
.svm_cid
, remote
.vm
.svm_port
) < 0)
974 assert_not_reached("Unhandled socket type.");
981 static void socket_close_fds(Socket
*s
) {
987 LIST_FOREACH(port
, p
, s
->ports
) {
990 was_open
= p
->fd
>= 0;
992 p
->event_source
= sd_event_source_unref(p
->event_source
);
993 p
->fd
= safe_close(p
->fd
);
994 socket_cleanup_fd_list(p
);
996 /* One little note: we should normally not delete any sockets in the file system here! After all some
997 * other process we spawned might still have a reference of this fd and wants to continue to use
998 * it. Therefore we normally delete sockets in the file system before we create a new one, not after we
999 * stopped using one! That all said, if the user explicitly requested this, we'll delete them here
1000 * anyway, but only then. */
1002 if (!was_open
|| !s
->remove_on_stop
)
1008 (void) unlink(p
->path
);
1012 (void) mq_unlink(p
->path
);
1016 (void) socket_address_unlink(&p
->address
);
1024 if (s
->remove_on_stop
)
1025 STRV_FOREACH(i
, s
->symlinks
)
1029 static void socket_apply_socket_options(Socket
*s
, int fd
) {
1035 if (s
->keep_alive
) {
1036 int b
= s
->keep_alive
;
1037 if (setsockopt(fd
, SOL_SOCKET
, SO_KEEPALIVE
, &b
, sizeof(b
)) < 0)
1038 log_unit_warning_errno(UNIT(s
), errno
, "SO_KEEPALIVE failed: %m");
1041 if (s
->keep_alive_time
) {
1042 int value
= s
->keep_alive_time
/ USEC_PER_SEC
;
1043 if (setsockopt(fd
, SOL_TCP
, TCP_KEEPIDLE
, &value
, sizeof(value
)) < 0)
1044 log_unit_warning_errno(UNIT(s
), errno
, "TCP_KEEPIDLE failed: %m");
1047 if (s
->keep_alive_interval
) {
1048 int value
= s
->keep_alive_interval
/ USEC_PER_SEC
;
1049 if (setsockopt(fd
, SOL_TCP
, TCP_KEEPINTVL
, &value
, sizeof(value
)) < 0)
1050 log_unit_warning_errno(UNIT(s
), errno
, "TCP_KEEPINTVL failed: %m");
1053 if (s
->keep_alive_cnt
) {
1054 int value
= s
->keep_alive_cnt
;
1055 if (setsockopt(fd
, SOL_TCP
, TCP_KEEPCNT
, &value
, sizeof(value
)) < 0)
1056 log_unit_warning_errno(UNIT(s
), errno
, "TCP_KEEPCNT failed: %m");
1059 if (s
->defer_accept
) {
1060 int value
= s
->defer_accept
/ USEC_PER_SEC
;
1061 if (setsockopt(fd
, SOL_TCP
, TCP_DEFER_ACCEPT
, &value
, sizeof(value
)) < 0)
1062 log_unit_warning_errno(UNIT(s
), errno
, "TCP_DEFER_ACCEPT failed: %m");
1066 int b
= s
->no_delay
;
1068 if (s
->socket_protocol
== IPPROTO_SCTP
) {
1069 if (setsockopt(fd
, SOL_SCTP
, SCTP_NODELAY
, &b
, sizeof(b
)) < 0)
1070 log_unit_warning_errno(UNIT(s
), errno
, "SCTP_NODELAY failed: %m");
1072 if (setsockopt(fd
, SOL_TCP
, TCP_NODELAY
, &b
, sizeof(b
)) < 0)
1073 log_unit_warning_errno(UNIT(s
), errno
, "TCP_NODELAY failed: %m");
1079 if (setsockopt(fd
, SOL_SOCKET
, SO_BROADCAST
, &one
, sizeof(one
)) < 0)
1080 log_unit_warning_errno(UNIT(s
), errno
, "SO_BROADCAST failed: %m");
1085 if (setsockopt(fd
, SOL_SOCKET
, SO_PASSCRED
, &one
, sizeof(one
)) < 0)
1086 log_unit_warning_errno(UNIT(s
), errno
, "SO_PASSCRED failed: %m");
1091 if (setsockopt(fd
, SOL_SOCKET
, SO_PASSSEC
, &one
, sizeof(one
)) < 0)
1092 log_unit_warning_errno(UNIT(s
), errno
, "SO_PASSSEC failed: %m");
1095 if (s
->priority
>= 0)
1096 if (setsockopt(fd
, SOL_SOCKET
, SO_PRIORITY
, &s
->priority
, sizeof(s
->priority
)) < 0)
1097 log_unit_warning_errno(UNIT(s
), errno
, "SO_PRIORITY failed: %m");
1099 if (s
->receive_buffer
> 0) {
1100 int value
= (int) s
->receive_buffer
;
1102 /* We first try with SO_RCVBUFFORCE, in case we have the perms for that */
1104 if (setsockopt(fd
, SOL_SOCKET
, SO_RCVBUFFORCE
, &value
, sizeof(value
)) < 0)
1105 if (setsockopt(fd
, SOL_SOCKET
, SO_RCVBUF
, &value
, sizeof(value
)) < 0)
1106 log_unit_warning_errno(UNIT(s
), errno
, "SO_RCVBUF failed: %m");
1109 if (s
->send_buffer
> 0) {
1110 int value
= (int) s
->send_buffer
;
1111 if (setsockopt(fd
, SOL_SOCKET
, SO_SNDBUFFORCE
, &value
, sizeof(value
)) < 0)
1112 if (setsockopt(fd
, SOL_SOCKET
, SO_SNDBUF
, &value
, sizeof(value
)) < 0)
1113 log_unit_warning_errno(UNIT(s
), errno
, "SO_SNDBUF failed: %m");
1117 if (setsockopt(fd
, SOL_SOCKET
, SO_MARK
, &s
->mark
, sizeof(s
->mark
)) < 0)
1118 log_unit_warning_errno(UNIT(s
), errno
, "SO_MARK failed: %m");
1121 if (setsockopt(fd
, IPPROTO_IP
, IP_TOS
, &s
->ip_tos
, sizeof(s
->ip_tos
)) < 0)
1122 log_unit_warning_errno(UNIT(s
), errno
, "IP_TOS failed: %m");
1124 if (s
->ip_ttl
>= 0) {
1127 r
= setsockopt(fd
, IPPROTO_IP
, IP_TTL
, &s
->ip_ttl
, sizeof(s
->ip_ttl
));
1129 if (socket_ipv6_is_supported())
1130 x
= setsockopt(fd
, IPPROTO_IPV6
, IPV6_UNICAST_HOPS
, &s
->ip_ttl
, sizeof(s
->ip_ttl
));
1133 errno
= EAFNOSUPPORT
;
1137 log_unit_warning_errno(UNIT(s
), errno
, "IP_TTL/IPV6_UNICAST_HOPS failed: %m");
1140 if (s
->tcp_congestion
)
1141 if (setsockopt(fd
, SOL_TCP
, TCP_CONGESTION
, s
->tcp_congestion
, strlen(s
->tcp_congestion
)+1) < 0)
1142 log_unit_warning_errno(UNIT(s
), errno
, "TCP_CONGESTION failed: %m");
1144 if (s
->smack_ip_in
) {
1145 r
= mac_smack_apply_fd(fd
, SMACK_ATTR_IPIN
, s
->smack_ip_in
);
1147 log_unit_error_errno(UNIT(s
), r
, "mac_smack_apply_ip_in_fd: %m");
1150 if (s
->smack_ip_out
) {
1151 r
= mac_smack_apply_fd(fd
, SMACK_ATTR_IPOUT
, s
->smack_ip_out
);
1153 log_unit_error_errno(UNIT(s
), r
, "mac_smack_apply_ip_out_fd: %m");
1157 static void socket_apply_fifo_options(Socket
*s
, int fd
) {
1163 if (s
->pipe_size
> 0)
1164 if (fcntl(fd
, F_SETPIPE_SZ
, s
->pipe_size
) < 0)
1165 log_unit_warning_errno(UNIT(s
), errno
, "Setting pipe size failed, ignoring: %m");
1168 r
= mac_smack_apply_fd(fd
, SMACK_ATTR_ACCESS
, s
->smack
);
1170 log_unit_error_errno(UNIT(s
), r
, "SMACK relabelling failed, ignoring: %m");
1174 static int fifo_address_create(
1176 mode_t directory_mode
,
1177 mode_t socket_mode
) {
1179 _cleanup_close_
int fd
= -1;
1186 (void) mkdir_parents_label(path
, directory_mode
);
1188 r
= mac_selinux_create_file_prepare(path
, S_IFIFO
);
1192 /* Enforce the right access mode for the fifo */
1193 old_mask
= umask(~ socket_mode
);
1195 /* Include the original umask in our mask */
1196 (void) umask(~socket_mode
| old_mask
);
1198 r
= mkfifo(path
, socket_mode
);
1199 (void) umask(old_mask
);
1201 if (r
< 0 && errno
!= EEXIST
) {
1206 fd
= open(path
, O_RDWR
| O_CLOEXEC
| O_NOCTTY
| O_NONBLOCK
| O_NOFOLLOW
);
1212 mac_selinux_create_file_clear();
1214 if (fstat(fd
, &st
) < 0) {
1219 if (!S_ISFIFO(st
.st_mode
) ||
1220 (st
.st_mode
& 0777) != (socket_mode
& ~old_mask
) ||
1221 st
.st_uid
!= getuid() ||
1222 st
.st_gid
!= getgid()) {
1230 mac_selinux_create_file_clear();
1234 static int special_address_create(const char *path
, bool writable
) {
1235 _cleanup_close_
int fd
= -1;
1240 fd
= open(path
, (writable
? O_RDWR
: O_RDONLY
)|O_CLOEXEC
|O_NOCTTY
|O_NONBLOCK
|O_NOFOLLOW
);
1244 if (fstat(fd
, &st
) < 0)
1247 /* Check whether this is a /proc, /sys or /dev file or char device */
1248 if (!S_ISREG(st
.st_mode
) && !S_ISCHR(st
.st_mode
))
1254 static int usbffs_address_create(const char *path
) {
1255 _cleanup_close_
int fd
= -1;
1260 fd
= open(path
, O_RDWR
|O_CLOEXEC
|O_NOCTTY
|O_NONBLOCK
|O_NOFOLLOW
);
1264 if (fstat(fd
, &st
) < 0)
1267 /* Check whether this is a regular file (ffs endpoint) */
1268 if (!S_ISREG(st
.st_mode
))
1274 static int mq_address_create(
1280 _cleanup_close_
int fd
= -1;
1283 struct mq_attr _attr
, *attr
= NULL
;
1287 if (maxmsg
> 0 && msgsize
> 0) {
1288 _attr
= (struct mq_attr
) {
1289 .mq_flags
= O_NONBLOCK
,
1290 .mq_maxmsg
= maxmsg
,
1291 .mq_msgsize
= msgsize
,
1296 /* Enforce the right access mode for the mq */
1297 old_mask
= umask(~ mq_mode
);
1299 /* Include the original umask in our mask */
1300 (void) umask(~mq_mode
| old_mask
);
1301 fd
= mq_open(path
, O_RDONLY
|O_CLOEXEC
|O_NONBLOCK
|O_CREAT
, mq_mode
, attr
);
1302 (void) umask(old_mask
);
1307 if (fstat(fd
, &st
) < 0)
1310 if ((st
.st_mode
& 0777) != (mq_mode
& ~old_mask
) ||
1311 st
.st_uid
!= getuid() ||
1312 st
.st_gid
!= getgid())
1318 static int socket_symlink(Socket
*s
) {
1325 p
= socket_find_symlink_target(s
);
1329 STRV_FOREACH(i
, s
->symlinks
) {
1330 (void) mkdir_parents_label(*i
, s
->directory_mode
);
1332 r
= symlink_idempotent(p
, *i
);
1334 if (r
== -EEXIST
&& s
->remove_on_stop
) {
1335 /* If there's already something where we want to create the symlink, and the destructive
1336 * RemoveOnStop= mode is set, then we might as well try to remove what already exists and try
1339 if (unlink(*i
) >= 0)
1340 r
= symlink_idempotent(p
, *i
);
1344 log_unit_warning_errno(UNIT(s
), r
, "Failed to create symlink %s → %s, ignoring: %m", p
, *i
);
1350 static int usbffs_write_descs(int fd
, Service
*s
) {
1353 if (!s
->usb_function_descriptors
|| !s
->usb_function_strings
)
1356 r
= copy_file_fd(s
->usb_function_descriptors
, fd
, 0);
1360 return copy_file_fd(s
->usb_function_strings
, fd
, 0);
1363 static int usbffs_select_ep(const struct dirent
*d
) {
1364 return d
->d_name
[0] != '.' && !streq(d
->d_name
, "ep0");
1367 static int usbffs_dispatch_eps(SocketPort
*p
) {
1368 _cleanup_free_
struct dirent
**ent
= NULL
;
1372 r
= scandir(p
->path
, &ent
, usbffs_select_ep
, alphasort
);
1377 p
->auxiliary_fds
= new(int, n
);
1378 if (!p
->auxiliary_fds
)
1381 p
->n_auxiliary_fds
= n
;
1384 for (i
= 0; i
< n
; ++i
) {
1385 _cleanup_free_
char *ep
= NULL
;
1387 ep
= path_make_absolute(ent
[i
]->d_name
, p
->path
);
1391 path_kill_slashes(ep
);
1393 r
= usbffs_address_create(ep
);
1397 p
->auxiliary_fds
[k
++] = r
;
1404 close_many(p
->auxiliary_fds
, k
);
1405 p
->auxiliary_fds
= mfree(p
->auxiliary_fds
);
1406 p
->n_auxiliary_fds
= 0;
1411 static int socket_determine_selinux_label(Socket
*s
, char **ret
) {
1414 _cleanup_free_
char *path
= NULL
;
1420 if (s
->selinux_context_from_net
) {
1421 /* If this is requested, get label from the network label */
1423 r
= mac_selinux_get_our_label(ret
);
1424 if (r
== -EOPNOTSUPP
)
1428 /* Otherwise, get it from the executable we are about to start */
1429 r
= socket_instantiate_service(s
);
1433 if (!UNIT_ISSET(s
->service
))
1436 service
= SERVICE(UNIT_DEREF(s
->service
));
1437 c
= service
->exec_command
[SERVICE_EXEC_START
];
1441 r
= chase_symlinks(c
->path
, service
->exec_context
.root_directory
, CHASE_PREFIX_ROOT
, &path
);
1445 r
= mac_selinux_get_create_label_from_exe(path
, ret
);
1446 if (IN_SET(r
, -EPERM
, -EOPNOTSUPP
))
1457 static int socket_address_listen_do(
1459 const SocketAddress
*address
,
1460 const char *label
) {
1465 return socket_address_listen(
1467 SOCK_CLOEXEC
|SOCK_NONBLOCK
,
1479 static int socket_address_listen_in_cgroup(
1481 const SocketAddress
*address
,
1482 const char *label
) {
1484 _cleanup_close_pair_
int pair
[2] = { -1, -1 };
1491 /* This is a wrapper around socket_address_listen(), that forks off a helper process inside the socket's cgroup
1492 * in which the socket is actually created. This way we ensure the socket is actually properly attached to the
1493 * unit's cgroup for the purpose of BPF filtering and such. */
1495 if (!IN_SET(address
->sockaddr
.sa
.sa_family
, AF_INET
, AF_INET6
))
1496 goto shortcut
; /* BPF filtering only applies to IPv4 + IPv6, shortcut things for other protocols */
1498 r
= bpf_firewall_supported();
1501 if (r
== BPF_FIREWALL_UNSUPPORTED
) /* If BPF firewalling isn't supported anyway — there's no point in this forking complexity */
1504 if (socketpair(AF_UNIX
, SOCK_SEQPACKET
|SOCK_CLOEXEC
, 0, pair
) < 0)
1505 return log_unit_error_errno(UNIT(s
), errno
, "Failed to create communication channel: %m");
1507 r
= unit_fork_helper_process(UNIT(s
), "(sd-listen)", &pid
);
1509 return log_unit_error_errno(UNIT(s
), r
, "Failed to fork off listener stub process: %m");
1513 pair
[0] = safe_close(pair
[0]);
1515 fd
= socket_address_listen_do(s
, address
, label
);
1517 log_unit_error_errno(UNIT(s
), fd
, "Failed to create listening socket: %m");
1518 _exit(EXIT_FAILURE
);
1521 r
= send_one_fd(pair
[1], fd
, 0);
1523 log_unit_error_errno(UNIT(s
), r
, "Failed to send listening socket to parent: %m");
1524 _exit(EXIT_FAILURE
);
1527 _exit(EXIT_SUCCESS
);
1530 pair
[1] = safe_close(pair
[1]);
1531 fd
= receive_one_fd(pair
[0], 0);
1533 /* We synchronously wait for the helper, as it shouldn't be slow */
1534 r
= wait_for_terminate_and_check("(sd-listen)", pid
, WAIT_LOG_ABNORMAL
);
1541 return log_unit_error_errno(UNIT(s
), fd
, "Failed to receive listening socket: %m");
1546 fd
= socket_address_listen_do(s
, address
, label
);
1548 return log_error_errno(fd
, "Failed to create listening socket: %m");
1553 static int socket_open_fds(Socket
*s
) {
1554 _cleanup_(mac_selinux_freep
) char *label
= NULL
;
1555 bool know_label
= false;
1561 LIST_FOREACH(port
, p
, s
->ports
) {
1571 /* Figure out label, if we don't it know yet. We do it once, for the first socket where
1572 * we need this and remember it for the rest. */
1574 r
= socket_determine_selinux_label(s
, &label
);
1581 /* Apply the socket protocol */
1582 switch (p
->address
.type
) {
1585 case SOCK_SEQPACKET
:
1586 if (s
->socket_protocol
== IPPROTO_SCTP
)
1587 p
->address
.protocol
= s
->socket_protocol
;
1591 if (s
->socket_protocol
== IPPROTO_UDPLITE
)
1592 p
->address
.protocol
= s
->socket_protocol
;
1596 r
= socket_address_listen_in_cgroup(s
, &p
->address
, label
);
1601 socket_apply_socket_options(s
, p
->fd
);
1605 case SOCKET_SPECIAL
:
1607 p
->fd
= special_address_create(p
->path
, s
->writable
);
1616 p
->fd
= fifo_address_create(
1625 socket_apply_fifo_options(s
, p
->fd
);
1631 p
->fd
= mq_address_create(
1642 case SOCKET_USB_FUNCTION
: {
1643 _cleanup_free_
char *ep
= NULL
;
1645 ep
= path_make_absolute("ep0", p
->path
);
1647 p
->fd
= usbffs_address_create(ep
);
1653 r
= usbffs_write_descs(p
->fd
, SERVICE(UNIT_DEREF(s
->service
)));
1657 r
= usbffs_dispatch_eps(p
);
1664 assert_not_reached("Unknown port type");
1671 socket_close_fds(s
);
1675 static void socket_unwatch_fds(Socket
*s
) {
1681 LIST_FOREACH(port
, p
, s
->ports
) {
1685 if (!p
->event_source
)
1688 r
= sd_event_source_set_enabled(p
->event_source
, SD_EVENT_OFF
);
1690 log_unit_debug_errno(UNIT(s
), r
, "Failed to disable event source: %m");
1694 static int socket_watch_fds(Socket
*s
) {
1700 LIST_FOREACH(port
, p
, s
->ports
) {
1704 if (p
->event_source
) {
1705 r
= sd_event_source_set_enabled(p
->event_source
, SD_EVENT_ON
);
1709 r
= sd_event_add_io(UNIT(s
)->manager
->event
, &p
->event_source
, p
->fd
, EPOLLIN
, socket_dispatch_io
, p
);
1713 (void) sd_event_source_set_description(p
->event_source
, "socket-port-io");
1720 log_unit_warning_errno(UNIT(s
), r
, "Failed to watch listening fds: %m");
1721 socket_unwatch_fds(s
);
1731 static int socket_check_open(Socket
*s
) {
1732 bool have_open
= false, have_closed
= false;
1737 LIST_FOREACH(port
, p
, s
->ports
) {
1743 if (have_open
&& have_closed
)
1744 return SOCKET_OPEN_SOME
;
1748 return SOCKET_OPEN_ALL
;
1750 return SOCKET_OPEN_NONE
;
1753 static void socket_set_state(Socket
*s
, SocketState state
) {
1754 SocketState old_state
;
1757 old_state
= s
->state
;
1765 SOCKET_STOP_PRE_SIGTERM
,
1766 SOCKET_STOP_PRE_SIGKILL
,
1768 SOCKET_FINAL_SIGTERM
,
1769 SOCKET_FINAL_SIGKILL
)) {
1771 s
->timer_event_source
= sd_event_source_unref(s
->timer_event_source
);
1772 socket_unwatch_control_pid(s
);
1773 s
->control_command
= NULL
;
1774 s
->control_command_id
= _SOCKET_EXEC_COMMAND_INVALID
;
1777 if (state
!= SOCKET_LISTENING
)
1778 socket_unwatch_fds(s
);
1786 SOCKET_STOP_PRE_SIGTERM
,
1787 SOCKET_STOP_PRE_SIGKILL
))
1788 socket_close_fds(s
);
1790 if (state
!= old_state
)
1791 log_unit_debug(UNIT(s
), "Changed %s -> %s", socket_state_to_string(old_state
), socket_state_to_string(state
));
1793 unit_notify(UNIT(s
), state_translation_table
[old_state
], state_translation_table
[state
], true);
1796 static int socket_coldplug(Unit
*u
) {
1797 Socket
*s
= SOCKET(u
);
1801 assert(s
->state
== SOCKET_DEAD
);
1803 if (s
->deserialized_state
== s
->state
)
1806 if (s
->control_pid
> 0 &&
1807 pid_is_unwaited(s
->control_pid
) &&
1808 IN_SET(s
->deserialized_state
,
1813 SOCKET_STOP_PRE_SIGTERM
,
1814 SOCKET_STOP_PRE_SIGKILL
,
1816 SOCKET_FINAL_SIGTERM
,
1817 SOCKET_FINAL_SIGKILL
)) {
1819 r
= unit_watch_pid(UNIT(s
), s
->control_pid
);
1823 r
= socket_arm_timer(s
, usec_add(u
->state_change_timestamp
.monotonic
, s
->timeout_usec
));
1828 if (IN_SET(s
->deserialized_state
,
1834 /* Originally, we used to simply reopen all sockets here that we didn't have file descriptors
1835 * for. However, this is problematic, as we won't traverse throught the SOCKET_START_CHOWN state for
1836 * them, and thus the UID/GID wouldn't be right. Hence, instead simply check if we have all fds open,
1837 * and if there's a mismatch, warn loudly. */
1839 r
= socket_check_open(s
);
1840 if (r
== SOCKET_OPEN_NONE
)
1841 log_unit_warning(UNIT(s
),
1842 "Socket unit configuration has changed while unit has been running, "
1843 "no open socket file descriptor left. "
1844 "The socket unit is not functional until restarted.");
1845 else if (r
== SOCKET_OPEN_SOME
)
1846 log_unit_warning(UNIT(s
),
1847 "Socket unit configuration has changed while unit has been running, "
1848 "and some socket file descriptors have not been opened yet. "
1849 "The socket unit is not fully functional until restarted.");
1852 if (s
->deserialized_state
== SOCKET_LISTENING
) {
1853 r
= socket_watch_fds(s
);
1858 if (!IN_SET(s
->deserialized_state
, SOCKET_DEAD
, SOCKET_FAILED
)) {
1859 (void) unit_setup_dynamic_creds(u
);
1860 (void) unit_setup_exec_runtime(u
);
1863 socket_set_state(s
, s
->deserialized_state
);
1867 static int socket_spawn(Socket
*s
, ExecCommand
*c
, pid_t
*_pid
) {
1869 ExecParameters exec_params
= {
1870 .flags
= EXEC_APPLY_SANDBOXING
|EXEC_APPLY_CHROOT
|EXEC_APPLY_TTY_STDIN
,
1882 r
= unit_prepare_exec(UNIT(s
));
1886 r
= socket_arm_timer(s
, usec_add(now(CLOCK_MONOTONIC
), s
->timeout_usec
));
1890 unit_set_exec_params(UNIT(s
), &exec_params
);
1892 exec_params
.argv
= c
->argv
;
1894 r
= exec_spawn(UNIT(s
),
1904 r
= unit_watch_pid(UNIT(s
), pid
);
1906 /* FIXME: we need to do something here */
1914 static int socket_chown(Socket
*s
, pid_t
*_pid
) {
1918 r
= socket_arm_timer(s
, usec_add(now(CLOCK_MONOTONIC
), s
->timeout_usec
));
1922 /* We have to resolve the user names out-of-process, hence
1923 * let's fork here. It's messy, but well, what can we do? */
1925 r
= unit_fork_helper_process(UNIT(s
), "(sd-chown)", &pid
);
1929 uid_t uid
= UID_INVALID
;
1930 gid_t gid
= GID_INVALID
;
1935 if (!isempty(s
->user
)) {
1936 const char *user
= s
->user
;
1938 r
= get_user_creds(&user
, &uid
, &gid
, NULL
, NULL
);
1940 log_unit_error_errno(UNIT(s
), r
, "Failed to resolve user %s: %m", user
);
1945 if (!isempty(s
->group
)) {
1946 const char *group
= s
->group
;
1948 r
= get_group_creds(&group
, &gid
);
1950 log_unit_error_errno(UNIT(s
), r
, "Failed to resolve group %s: %m", group
);
1955 LIST_FOREACH(port
, p
, s
->ports
) {
1956 const char *path
= NULL
;
1958 if (p
->type
== SOCKET_SOCKET
)
1959 path
= socket_address_get_path(&p
->address
);
1960 else if (p
->type
== SOCKET_FIFO
)
1966 if (chown(path
, uid
, gid
) < 0) {
1967 log_unit_error_errno(UNIT(s
), errno
, "Failed to chown(): %m");
1972 _exit(EXIT_SUCCESS
);
1975 r
= unit_watch_pid(UNIT(s
), pid
);
1983 s
->timer_event_source
= sd_event_source_unref(s
->timer_event_source
);
1987 static void socket_enter_dead(Socket
*s
, SocketResult f
) {
1990 if (s
->result
== SOCKET_SUCCESS
)
1993 if (s
->result
!= SOCKET_SUCCESS
)
1994 log_unit_warning(UNIT(s
), "Failed with result '%s'.", socket_result_to_string(s
->result
));
1996 socket_set_state(s
, s
->result
!= SOCKET_SUCCESS
? SOCKET_FAILED
: SOCKET_DEAD
);
1998 s
->exec_runtime
= exec_runtime_unref(s
->exec_runtime
, true);
2000 exec_context_destroy_runtime_directory(&s
->exec_context
, UNIT(s
)->manager
->prefix
[EXEC_DIRECTORY_RUNTIME
]);
2002 unit_unref_uid_gid(UNIT(s
), true);
2004 dynamic_creds_destroy(&s
->dynamic_creds
);
2007 static void socket_enter_signal(Socket
*s
, SocketState state
, SocketResult f
);
2009 static void socket_enter_stop_post(Socket
*s
, SocketResult f
) {
2013 if (s
->result
== SOCKET_SUCCESS
)
2016 socket_unwatch_control_pid(s
);
2017 s
->control_command_id
= SOCKET_EXEC_STOP_POST
;
2018 s
->control_command
= s
->exec_command
[SOCKET_EXEC_STOP_POST
];
2020 if (s
->control_command
) {
2021 r
= socket_spawn(s
, s
->control_command
, &s
->control_pid
);
2025 socket_set_state(s
, SOCKET_STOP_POST
);
2027 socket_enter_signal(s
, SOCKET_FINAL_SIGTERM
, SOCKET_SUCCESS
);
2032 log_unit_warning_errno(UNIT(s
), r
, "Failed to run 'stop-post' task: %m");
2033 socket_enter_signal(s
, SOCKET_FINAL_SIGTERM
, SOCKET_FAILURE_RESOURCES
);
2036 static void socket_enter_signal(Socket
*s
, SocketState state
, SocketResult f
) {
2041 if (s
->result
== SOCKET_SUCCESS
)
2044 r
= unit_kill_context(
2047 !IN_SET(state
, SOCKET_STOP_PRE_SIGTERM
, SOCKET_FINAL_SIGTERM
) ?
2048 KILL_KILL
: KILL_TERMINATE
,
2056 r
= socket_arm_timer(s
, usec_add(now(CLOCK_MONOTONIC
), s
->timeout_usec
));
2060 socket_set_state(s
, state
);
2061 } else if (state
== SOCKET_STOP_PRE_SIGTERM
)
2062 socket_enter_signal(s
, SOCKET_STOP_PRE_SIGKILL
, SOCKET_SUCCESS
);
2063 else if (state
== SOCKET_STOP_PRE_SIGKILL
)
2064 socket_enter_stop_post(s
, SOCKET_SUCCESS
);
2065 else if (state
== SOCKET_FINAL_SIGTERM
)
2066 socket_enter_signal(s
, SOCKET_FINAL_SIGKILL
, SOCKET_SUCCESS
);
2068 socket_enter_dead(s
, SOCKET_SUCCESS
);
2073 log_unit_warning_errno(UNIT(s
), r
, "Failed to kill processes: %m");
2075 if (IN_SET(state
, SOCKET_STOP_PRE_SIGTERM
, SOCKET_STOP_PRE_SIGKILL
))
2076 socket_enter_stop_post(s
, SOCKET_FAILURE_RESOURCES
);
2078 socket_enter_dead(s
, SOCKET_FAILURE_RESOURCES
);
2081 static void socket_enter_stop_pre(Socket
*s
, SocketResult f
) {
2085 if (s
->result
== SOCKET_SUCCESS
)
2088 socket_unwatch_control_pid(s
);
2089 s
->control_command_id
= SOCKET_EXEC_STOP_PRE
;
2090 s
->control_command
= s
->exec_command
[SOCKET_EXEC_STOP_PRE
];
2092 if (s
->control_command
) {
2093 r
= socket_spawn(s
, s
->control_command
, &s
->control_pid
);
2097 socket_set_state(s
, SOCKET_STOP_PRE
);
2099 socket_enter_stop_post(s
, SOCKET_SUCCESS
);
2104 log_unit_warning_errno(UNIT(s
), r
, "Failed to run 'stop-pre' task: %m");
2105 socket_enter_stop_post(s
, SOCKET_FAILURE_RESOURCES
);
2108 static void socket_enter_listening(Socket
*s
) {
2112 r
= socket_watch_fds(s
);
2114 log_unit_warning_errno(UNIT(s
), r
, "Failed to watch sockets: %m");
2118 socket_set_state(s
, SOCKET_LISTENING
);
2122 socket_enter_stop_pre(s
, SOCKET_FAILURE_RESOURCES
);
2125 static void socket_enter_start_post(Socket
*s
) {
2129 socket_unwatch_control_pid(s
);
2130 s
->control_command_id
= SOCKET_EXEC_START_POST
;
2131 s
->control_command
= s
->exec_command
[SOCKET_EXEC_START_POST
];
2133 if (s
->control_command
) {
2134 r
= socket_spawn(s
, s
->control_command
, &s
->control_pid
);
2136 log_unit_warning_errno(UNIT(s
), r
, "Failed to run 'start-post' task: %m");
2140 socket_set_state(s
, SOCKET_START_POST
);
2142 socket_enter_listening(s
);
2147 socket_enter_stop_pre(s
, SOCKET_FAILURE_RESOURCES
);
2150 static void socket_enter_start_chown(Socket
*s
) {
2155 r
= socket_open_fds(s
);
2157 log_unit_warning_errno(UNIT(s
), r
, "Failed to listen on sockets: %m");
2161 if (!isempty(s
->user
) || !isempty(s
->group
)) {
2163 socket_unwatch_control_pid(s
);
2164 s
->control_command_id
= SOCKET_EXEC_START_CHOWN
;
2165 s
->control_command
= NULL
;
2167 r
= socket_chown(s
, &s
->control_pid
);
2169 log_unit_warning_errno(UNIT(s
), r
, "Failed to fork 'start-chown' task: %m");
2173 socket_set_state(s
, SOCKET_START_CHOWN
);
2175 socket_enter_start_post(s
);
2180 socket_enter_stop_pre(s
, SOCKET_FAILURE_RESOURCES
);
2183 static void socket_enter_start_pre(Socket
*s
) {
2187 socket_unwatch_control_pid(s
);
2189 unit_warn_leftover_processes(UNIT(s
));
2191 s
->control_command_id
= SOCKET_EXEC_START_PRE
;
2192 s
->control_command
= s
->exec_command
[SOCKET_EXEC_START_PRE
];
2194 if (s
->control_command
) {
2195 r
= socket_spawn(s
, s
->control_command
, &s
->control_pid
);
2197 log_unit_warning_errno(UNIT(s
), r
, "Failed to run 'start-pre' task: %m");
2201 socket_set_state(s
, SOCKET_START_PRE
);
2203 socket_enter_start_chown(s
);
2208 socket_enter_dead(s
, SOCKET_FAILURE_RESOURCES
);
2211 static void flush_ports(Socket
*s
) {
2214 /* Flush all incoming traffic, regardless if actual bytes or new connections, so that this socket isn't busy
2217 LIST_FOREACH(port
, p
, s
->ports
) {
2221 (void) flush_accept(p
->fd
);
2222 (void) flush_fd(p
->fd
);
2226 static void socket_enter_running(Socket
*s
, int cfd
) {
2227 _cleanup_(sd_bus_error_free
) sd_bus_error error
= SD_BUS_ERROR_NULL
;
2230 /* Note that this call takes possession of the connection fd passed. It either has to assign it somewhere or
2235 /* We don't take connections anymore if we are supposed to shut down anyway */
2236 if (unit_stop_pending(UNIT(s
))) {
2238 log_unit_debug(UNIT(s
), "Suppressing connection request since unit stop is scheduled.");
2241 cfd
= safe_close(cfd
);
2248 if (!ratelimit_test(&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.",
2294 if (s
->max_connections_per_source
> 0) {
2295 r
= socket_acquire_peer(s
, cfd
, &p
);
2299 } else if (r
> 0 && p
->n_ref
> s
->max_connections_per_source
) {
2300 _cleanup_free_
char *t
= NULL
;
2302 (void) sockaddr_pretty(&p
->peer
.sa
, p
->peer_salen
, true, false, &t
);
2304 log_unit_warning(UNIT(s
),
2305 "Too many incoming connections (%u) from source %s, dropping connection.",
2306 p
->n_ref
, strnull(t
));
2312 r
= socket_instantiate_service(s
);
2316 r
= instance_from_socket(cfd
, s
->n_accepted
, &instance
);
2321 /* ENOTCONN is legitimate if TCP RST was received.
2322 * This connection is over, but the socket unit lives on. */
2323 log_unit_debug(UNIT(s
), "Got ENOTCONN on incoming socket, assuming aborted connection attempt, ignoring.");
2328 r
= unit_name_to_prefix(UNIT(s
)->id
, &prefix
);
2332 r
= unit_name_build(prefix
, instance
, ".service", &name
);
2336 r
= unit_add_name(UNIT_DEREF(s
->service
), name
);
2340 service
= SERVICE(UNIT_DEREF(s
->service
));
2341 unit_ref_unset(&s
->service
);
2344 unit_choose_id(UNIT(service
), name
);
2346 r
= service_set_socket_fd(service
, cfd
, s
, s
->selinux_context_from_net
);
2350 cfd
= -1; /* We passed ownership of the fd to the service now. Forget it here. */
2353 service
->peer
= TAKE_PTR(p
); /* Pass ownership of the peer reference */
2355 r
= manager_add_job(UNIT(s
)->manager
, JOB_START
, UNIT(service
), JOB_REPLACE
, &error
, NULL
);
2357 /* We failed to activate the new service, but it still exists. Let's make sure the service
2358 * closes and forgets the connection fd again, immediately. */
2359 service_close_socket_fd(service
);
2363 /* Notify clients about changed counters */
2364 unit_add_to_dbus_queue(UNIT(s
));
2370 log_unit_warning(UNIT(s
), "Failed to queue service startup job (Maybe the service file is missing or not a %s unit?): %s",
2371 cfd
>= 0 ? "template" : "non-template",
2372 bus_error_message(&error
, r
));
2374 socket_enter_stop_pre(s
, SOCKET_FAILURE_RESOURCES
);
2378 static void socket_run_next(Socket
*s
) {
2382 assert(s
->control_command
);
2383 assert(s
->control_command
->command_next
);
2385 socket_unwatch_control_pid(s
);
2387 s
->control_command
= s
->control_command
->command_next
;
2389 r
= socket_spawn(s
, s
->control_command
, &s
->control_pid
);
2396 log_unit_warning_errno(UNIT(s
), r
, "Failed to run next task: %m");
2398 if (s
->state
== SOCKET_START_POST
)
2399 socket_enter_stop_pre(s
, SOCKET_FAILURE_RESOURCES
);
2400 else if (s
->state
== SOCKET_STOP_POST
)
2401 socket_enter_dead(s
, SOCKET_FAILURE_RESOURCES
);
2403 socket_enter_signal(s
, SOCKET_FINAL_SIGTERM
, SOCKET_FAILURE_RESOURCES
);
2406 static int socket_start(Unit
*u
) {
2407 Socket
*s
= SOCKET(u
);
2412 /* We cannot fulfill this request right now, try again later
2414 if (IN_SET(s
->state
,
2416 SOCKET_STOP_PRE_SIGKILL
,
2417 SOCKET_STOP_PRE_SIGTERM
,
2419 SOCKET_FINAL_SIGTERM
,
2420 SOCKET_FINAL_SIGKILL
))
2423 /* Already on it! */
2424 if (IN_SET(s
->state
,
2430 /* Cannot run this without the service being around */
2431 if (UNIT_ISSET(s
->service
)) {
2434 service
= SERVICE(UNIT_DEREF(s
->service
));
2436 if (UNIT(service
)->load_state
!= UNIT_LOADED
) {
2437 log_unit_error(u
, "Socket service %s not loaded, refusing.", UNIT(service
)->id
);
2441 /* If the service is already active we cannot start the
2443 if (!IN_SET(service
->state
, SERVICE_DEAD
, SERVICE_FAILED
, SERVICE_AUTO_RESTART
)) {
2444 log_unit_error(u
, "Socket service %s already active, refusing.", UNIT(service
)->id
);
2449 assert(IN_SET(s
->state
, SOCKET_DEAD
, SOCKET_FAILED
));
2451 r
= unit_start_limit_test(u
);
2453 socket_enter_dead(s
, SOCKET_FAILURE_START_LIMIT_HIT
);
2457 r
= unit_acquire_invocation_id(u
);
2461 s
->result
= SOCKET_SUCCESS
;
2463 u
->reset_accounting
= true;
2465 socket_enter_start_pre(s
);
2469 static int socket_stop(Unit
*u
) {
2470 Socket
*s
= SOCKET(u
);
2475 if (IN_SET(s
->state
,
2477 SOCKET_STOP_PRE_SIGTERM
,
2478 SOCKET_STOP_PRE_SIGKILL
,
2480 SOCKET_FINAL_SIGTERM
,
2481 SOCKET_FINAL_SIGKILL
))
2484 /* If there's already something running we go directly into
2486 if (IN_SET(s
->state
,
2489 SOCKET_START_POST
)) {
2490 socket_enter_signal(s
, SOCKET_STOP_PRE_SIGTERM
, SOCKET_SUCCESS
);
2494 assert(IN_SET(s
->state
, SOCKET_LISTENING
, SOCKET_RUNNING
));
2496 socket_enter_stop_pre(s
, SOCKET_SUCCESS
);
2500 static int socket_serialize(Unit
*u
, FILE *f
, FDSet
*fds
) {
2501 Socket
*s
= SOCKET(u
);
2509 unit_serialize_item(u
, f
, "state", socket_state_to_string(s
->state
));
2510 unit_serialize_item(u
, f
, "result", socket_result_to_string(s
->result
));
2511 unit_serialize_item_format(u
, f
, "n-accepted", "%u", s
->n_accepted
);
2513 if (s
->control_pid
> 0)
2514 unit_serialize_item_format(u
, f
, "control-pid", PID_FMT
, s
->control_pid
);
2516 if (s
->control_command_id
>= 0)
2517 unit_serialize_item(u
, f
, "control-command", socket_exec_command_to_string(s
->control_command_id
));
2519 LIST_FOREACH(port
, p
, s
->ports
) {
2525 copy
= fdset_put_dup(fds
, p
->fd
);
2529 if (p
->type
== SOCKET_SOCKET
) {
2530 _cleanup_free_
char *t
= NULL
;
2532 r
= socket_address_print(&p
->address
, &t
);
2536 if (socket_address_family(&p
->address
) == AF_NETLINK
)
2537 unit_serialize_item_format(u
, f
, "netlink", "%i %s", copy
, t
);
2539 unit_serialize_item_format(u
, f
, "socket", "%i %i %s", copy
, p
->address
.type
, t
);
2541 } else if (p
->type
== SOCKET_SPECIAL
)
2542 unit_serialize_item_format(u
, f
, "special", "%i %s", copy
, p
->path
);
2543 else if (p
->type
== SOCKET_MQUEUE
)
2544 unit_serialize_item_format(u
, f
, "mqueue", "%i %s", copy
, p
->path
);
2545 else if (p
->type
== SOCKET_USB_FUNCTION
)
2546 unit_serialize_item_format(u
, f
, "ffs", "%i %s", copy
, p
->path
);
2548 assert(p
->type
== SOCKET_FIFO
);
2549 unit_serialize_item_format(u
, f
, "fifo", "%i %s", copy
, p
->path
);
2556 static void socket_port_take_fd(SocketPort
*p
, FDSet
*fds
, int fd
) {
2558 p
->fd
= fdset_remove(fds
, fd
);
2561 static int socket_deserialize_item(Unit
*u
, const char *key
, const char *value
, FDSet
*fds
) {
2562 Socket
*s
= SOCKET(u
);
2568 if (streq(key
, "state")) {
2571 state
= socket_state_from_string(value
);
2573 log_unit_debug(u
, "Failed to parse state value: %s", value
);
2575 s
->deserialized_state
= state
;
2576 } else if (streq(key
, "result")) {
2579 f
= socket_result_from_string(value
);
2581 log_unit_debug(u
, "Failed to parse result value: %s", value
);
2582 else if (f
!= SOCKET_SUCCESS
)
2585 } else if (streq(key
, "n-accepted")) {
2588 if (safe_atou(value
, &k
) < 0)
2589 log_unit_debug(u
, "Failed to parse n-accepted value: %s", value
);
2592 } else if (streq(key
, "control-pid")) {
2595 if (parse_pid(value
, &pid
) < 0)
2596 log_unit_debug(u
, "Failed to parse control-pid value: %s", value
);
2598 s
->control_pid
= pid
;
2599 } else if (streq(key
, "control-command")) {
2600 SocketExecCommand id
;
2602 id
= socket_exec_command_from_string(value
);
2604 log_unit_debug(u
, "Failed to parse exec-command value: %s", value
);
2606 s
->control_command_id
= id
;
2607 s
->control_command
= s
->exec_command
[id
];
2609 } else if (streq(key
, "fifo")) {
2613 if (sscanf(value
, "%i %n", &fd
, &skip
) < 1 || fd
< 0 || !fdset_contains(fds
, fd
))
2614 log_unit_debug(u
, "Failed to parse fifo value: %s", value
);
2616 LIST_FOREACH(port
, p
, s
->ports
)
2617 if (p
->type
== SOCKET_FIFO
&&
2618 path_equal_or_files_same(p
->path
, value
+skip
, 0)) {
2619 socket_port_take_fd(p
, fds
, fd
);
2623 } else if (streq(key
, "special")) {
2627 if (sscanf(value
, "%i %n", &fd
, &skip
) < 1 || fd
< 0 || !fdset_contains(fds
, fd
))
2628 log_unit_debug(u
, "Failed to parse special value: %s", value
);
2630 LIST_FOREACH(port
, p
, s
->ports
)
2631 if (p
->type
== SOCKET_SPECIAL
&&
2632 path_equal_or_files_same(p
->path
, value
+skip
, 0)) {
2633 socket_port_take_fd(p
, fds
, fd
);
2637 } else if (streq(key
, "mqueue")) {
2641 if (sscanf(value
, "%i %n", &fd
, &skip
) < 1 || fd
< 0 || !fdset_contains(fds
, fd
))
2642 log_unit_debug(u
, "Failed to parse mqueue value: %s", value
);
2644 LIST_FOREACH(port
, p
, s
->ports
)
2645 if (p
->type
== SOCKET_MQUEUE
&&
2646 streq(p
->path
, value
+skip
)) {
2647 socket_port_take_fd(p
, fds
, fd
);
2651 } else if (streq(key
, "socket")) {
2652 int fd
, type
, skip
= 0;
2655 if (sscanf(value
, "%i %i %n", &fd
, &type
, &skip
) < 2 || fd
< 0 || type
< 0 || !fdset_contains(fds
, fd
))
2656 log_unit_debug(u
, "Failed to parse socket value: %s", value
);
2658 LIST_FOREACH(port
, p
, s
->ports
)
2659 if (socket_address_is(&p
->address
, value
+skip
, type
)) {
2660 socket_port_take_fd(p
, fds
, fd
);
2664 } else if (streq(key
, "netlink")) {
2668 if (sscanf(value
, "%i %n", &fd
, &skip
) < 1 || fd
< 0 || !fdset_contains(fds
, fd
))
2669 log_unit_debug(u
, "Failed to parse socket value: %s", value
);
2671 LIST_FOREACH(port
, p
, s
->ports
)
2672 if (socket_address_is_netlink(&p
->address
, value
+skip
)) {
2673 socket_port_take_fd(p
, fds
, fd
);
2677 } else if (streq(key
, "ffs")) {
2681 if (sscanf(value
, "%i %n", &fd
, &skip
) < 1 || fd
< 0 || !fdset_contains(fds
, fd
))
2682 log_unit_debug(u
, "Failed to parse ffs value: %s", value
);
2684 LIST_FOREACH(port
, p
, s
->ports
)
2685 if (p
->type
== SOCKET_USB_FUNCTION
&&
2686 path_equal_or_files_same(p
->path
, value
+skip
, 0)) {
2687 socket_port_take_fd(p
, fds
, fd
);
2692 log_unit_debug(UNIT(s
), "Unknown serialization key: %s", key
);
2697 static void socket_distribute_fds(Unit
*u
, FDSet
*fds
) {
2698 Socket
*s
= SOCKET(u
);
2703 LIST_FOREACH(port
, p
, s
->ports
) {
2707 if (p
->type
!= SOCKET_SOCKET
)
2713 FDSET_FOREACH(fd
, fds
, i
) {
2714 if (socket_address_matches_fd(&p
->address
, fd
)) {
2715 p
->fd
= fdset_remove(fds
, fd
);
2716 s
->deserialized_state
= SOCKET_LISTENING
;
2723 _pure_
static UnitActiveState
socket_active_state(Unit
*u
) {
2726 return state_translation_table
[SOCKET(u
)->state
];
2729 _pure_
static const char *socket_sub_state_to_string(Unit
*u
) {
2732 return socket_state_to_string(SOCKET(u
)->state
);
2735 const char* socket_port_type_to_string(SocketPort
*p
) {
2743 switch (p
->address
.type
) {
2751 case SOCK_SEQPACKET
:
2752 return "SequentialPacket";
2755 if (socket_address_family(&p
->address
) == AF_NETLINK
)
2763 case SOCKET_SPECIAL
:
2767 return "MessageQueue";
2772 case SOCKET_USB_FUNCTION
:
2773 return "USBFunction";
2780 SocketType
socket_port_type_from_string(const char *s
) {
2783 if (STR_IN_SET(s
, "Stream", "Datagram", "SequentialPacket", "Netlink"))
2784 return SOCKET_SOCKET
;
2785 else if (streq(s
, "Special"))
2786 return SOCKET_SPECIAL
;
2787 else if (streq(s
, "MessageQueue"))
2788 return SOCKET_MQUEUE
;
2789 else if (streq(s
, "FIFO"))
2791 else if (streq(s
, "USBFunction"))
2792 return SOCKET_USB_FUNCTION
;
2794 return _SOCKET_TYPE_INVALID
;
2797 _pure_
static bool socket_may_gc(Unit
*u
) {
2798 Socket
*s
= SOCKET(u
);
2802 return s
->n_connections
== 0;
2805 static int socket_accept_do(Socket
*s
, int fd
) {
2812 cfd
= accept4(fd
, NULL
, NULL
, SOCK_NONBLOCK
);
2826 static int socket_accept_in_cgroup(Socket
*s
, SocketPort
*p
, int fd
) {
2827 _cleanup_close_pair_
int pair
[2] = { -1, -1 };
2835 /* Similar to socket_address_listen_in_cgroup(), but for accept() rathern than socket(): make sure that any
2836 * connection socket is also properly associated with the cgroup. */
2838 if (!IN_SET(p
->address
.sockaddr
.sa
.sa_family
, AF_INET
, AF_INET6
))
2841 r
= bpf_firewall_supported();
2844 if (r
== BPF_FIREWALL_UNSUPPORTED
)
2847 if (socketpair(AF_UNIX
, SOCK_SEQPACKET
|SOCK_CLOEXEC
, 0, pair
) < 0)
2848 return log_unit_error_errno(UNIT(s
), errno
, "Failed to create communication channel: %m");
2850 r
= unit_fork_helper_process(UNIT(s
), "(sd-accept)", &pid
);
2852 return log_unit_error_errno(UNIT(s
), r
, "Failed to fork off accept stub process: %m");
2856 pair
[0] = safe_close(pair
[0]);
2858 cfd
= socket_accept_do(s
, fd
);
2860 log_unit_error_errno(UNIT(s
), cfd
, "Failed to accept connection socket: %m");
2861 _exit(EXIT_FAILURE
);
2864 r
= send_one_fd(pair
[1], cfd
, 0);
2866 log_unit_error_errno(UNIT(s
), r
, "Failed to send connection socket to parent: %m");
2867 _exit(EXIT_FAILURE
);
2870 _exit(EXIT_SUCCESS
);
2873 pair
[1] = safe_close(pair
[1]);
2874 cfd
= receive_one_fd(pair
[0], 0);
2876 /* We synchronously wait for the helper, as it shouldn't be slow */
2877 r
= wait_for_terminate_and_check("(sd-accept)", pid
, WAIT_LOG_ABNORMAL
);
2884 return log_unit_error_errno(UNIT(s
), cfd
, "Failed to receive connection socket: %m");
2889 cfd
= socket_accept_do(s
, fd
);
2891 return log_unit_error_errno(UNIT(s
), cfd
, "Failed to accept connection socket: %m");
2896 static int socket_dispatch_io(sd_event_source
*source
, int fd
, uint32_t revents
, void *userdata
) {
2897 SocketPort
*p
= userdata
;
2903 if (p
->socket
->state
!= SOCKET_LISTENING
)
2906 log_unit_debug(UNIT(p
->socket
), "Incoming traffic");
2908 if (revents
!= EPOLLIN
) {
2910 if (revents
& EPOLLHUP
)
2911 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.");
2913 log_unit_error(UNIT(p
->socket
), "Got unexpected poll event (0x%x) on socket.", revents
);
2917 if (p
->socket
->accept
&&
2918 p
->type
== SOCKET_SOCKET
&&
2919 socket_address_can_accept(&p
->address
)) {
2921 cfd
= socket_accept_in_cgroup(p
->socket
, p
, fd
);
2925 socket_apply_socket_options(p
->socket
, cfd
);
2928 socket_enter_running(p
->socket
, cfd
);
2932 socket_enter_stop_pre(p
->socket
, SOCKET_FAILURE_RESOURCES
);
2936 static void socket_sigchld_event(Unit
*u
, pid_t pid
, int code
, int status
) {
2937 Socket
*s
= SOCKET(u
);
2943 if (pid
!= s
->control_pid
)
2948 if (is_clean_exit(code
, status
, EXIT_CLEAN_COMMAND
, NULL
))
2950 else if (code
== CLD_EXITED
)
2951 f
= SOCKET_FAILURE_EXIT_CODE
;
2952 else if (code
== CLD_KILLED
)
2953 f
= SOCKET_FAILURE_SIGNAL
;
2954 else if (code
== CLD_DUMPED
)
2955 f
= SOCKET_FAILURE_CORE_DUMP
;
2957 assert_not_reached("Unknown sigchld code");
2959 if (s
->control_command
) {
2960 exec_status_exit(&s
->control_command
->exec_status
, &s
->exec_context
, pid
, code
, status
);
2962 if (s
->control_command
->flags
& EXEC_COMMAND_IGNORE_FAILURE
)
2966 log_unit_full(u
, f
== SOCKET_SUCCESS
? LOG_DEBUG
: LOG_NOTICE
, 0,
2967 "Control process exited, code=%s status=%i",
2968 sigchld_code_to_string(code
), status
);
2970 if (s
->result
== SOCKET_SUCCESS
)
2973 if (s
->control_command
&&
2974 s
->control_command
->command_next
&&
2975 f
== SOCKET_SUCCESS
) {
2977 log_unit_debug(u
, "Running next command for state %s", socket_state_to_string(s
->state
));
2980 s
->control_command
= NULL
;
2981 s
->control_command_id
= _SOCKET_EXEC_COMMAND_INVALID
;
2983 /* No further commands for this step, so let's figure
2984 * out what to do next */
2986 log_unit_debug(u
, "Got final SIGCHLD for state %s", socket_state_to_string(s
->state
));
2990 case SOCKET_START_PRE
:
2991 if (f
== SOCKET_SUCCESS
)
2992 socket_enter_start_chown(s
);
2994 socket_enter_signal(s
, SOCKET_FINAL_SIGTERM
, f
);
2997 case SOCKET_START_CHOWN
:
2998 if (f
== SOCKET_SUCCESS
)
2999 socket_enter_start_post(s
);
3001 socket_enter_stop_pre(s
, f
);
3004 case SOCKET_START_POST
:
3005 if (f
== SOCKET_SUCCESS
)
3006 socket_enter_listening(s
);
3008 socket_enter_stop_pre(s
, f
);
3011 case SOCKET_STOP_PRE
:
3012 case SOCKET_STOP_PRE_SIGTERM
:
3013 case SOCKET_STOP_PRE_SIGKILL
:
3014 socket_enter_stop_post(s
, f
);
3017 case SOCKET_STOP_POST
:
3018 case SOCKET_FINAL_SIGTERM
:
3019 case SOCKET_FINAL_SIGKILL
:
3020 socket_enter_dead(s
, f
);
3024 assert_not_reached("Uh, control process died at wrong time.");
3028 /* Notify clients about changed exit status */
3029 unit_add_to_dbus_queue(u
);
3032 static int socket_dispatch_timer(sd_event_source
*source
, usec_t usec
, void *userdata
) {
3033 Socket
*s
= SOCKET(userdata
);
3036 assert(s
->timer_event_source
== source
);
3040 case SOCKET_START_PRE
:
3041 log_unit_warning(UNIT(s
), "Starting timed out. Terminating.");
3042 socket_enter_signal(s
, SOCKET_FINAL_SIGTERM
, SOCKET_FAILURE_TIMEOUT
);
3045 case SOCKET_START_CHOWN
:
3046 case SOCKET_START_POST
:
3047 log_unit_warning(UNIT(s
), "Starting timed out. Stopping.");
3048 socket_enter_stop_pre(s
, SOCKET_FAILURE_TIMEOUT
);
3051 case SOCKET_STOP_PRE
:
3052 log_unit_warning(UNIT(s
), "Stopping timed out. Terminating.");
3053 socket_enter_signal(s
, SOCKET_STOP_PRE_SIGTERM
, SOCKET_FAILURE_TIMEOUT
);
3056 case SOCKET_STOP_PRE_SIGTERM
:
3057 if (s
->kill_context
.send_sigkill
) {
3058 log_unit_warning(UNIT(s
), "Stopping timed out. Killing.");
3059 socket_enter_signal(s
, SOCKET_STOP_PRE_SIGKILL
, SOCKET_FAILURE_TIMEOUT
);
3061 log_unit_warning(UNIT(s
), "Stopping timed out. Skipping SIGKILL. Ignoring.");
3062 socket_enter_stop_post(s
, SOCKET_FAILURE_TIMEOUT
);
3066 case SOCKET_STOP_PRE_SIGKILL
:
3067 log_unit_warning(UNIT(s
), "Processes still around after SIGKILL. Ignoring.");
3068 socket_enter_stop_post(s
, SOCKET_FAILURE_TIMEOUT
);
3071 case SOCKET_STOP_POST
:
3072 log_unit_warning(UNIT(s
), "Stopping timed out (2). Terminating.");
3073 socket_enter_signal(s
, SOCKET_FINAL_SIGTERM
, SOCKET_FAILURE_TIMEOUT
);
3076 case SOCKET_FINAL_SIGTERM
:
3077 if (s
->kill_context
.send_sigkill
) {
3078 log_unit_warning(UNIT(s
), "Stopping timed out (2). Killing.");
3079 socket_enter_signal(s
, SOCKET_FINAL_SIGKILL
, SOCKET_FAILURE_TIMEOUT
);
3081 log_unit_warning(UNIT(s
), "Stopping timed out (2). Skipping SIGKILL. Ignoring.");
3082 socket_enter_dead(s
, SOCKET_FAILURE_TIMEOUT
);
3086 case SOCKET_FINAL_SIGKILL
:
3087 log_unit_warning(UNIT(s
), "Still around after SIGKILL (2). Entering failed mode.");
3088 socket_enter_dead(s
, SOCKET_FAILURE_TIMEOUT
);
3092 assert_not_reached("Timeout at wrong time.");
3098 int socket_collect_fds(Socket
*s
, int **fds
) {
3099 size_t k
= 0, n
= 0;
3106 /* Called from the service code for requesting our fds */
3108 LIST_FOREACH(port
, p
, s
->ports
) {
3111 n
+= p
->n_auxiliary_fds
;
3123 LIST_FOREACH(port
, p
, s
->ports
) {
3128 for (i
= 0; i
< p
->n_auxiliary_fds
; ++i
)
3129 rfds
[k
++] = p
->auxiliary_fds
[i
];
3138 static void socket_reset_failed(Unit
*u
) {
3139 Socket
*s
= SOCKET(u
);
3143 if (s
->state
== SOCKET_FAILED
)
3144 socket_set_state(s
, SOCKET_DEAD
);
3146 s
->result
= SOCKET_SUCCESS
;
3149 void socket_connection_unref(Socket
*s
) {
3152 /* The service is dead. Yay!
3154 * This is strictly for one-instance-per-connection
3157 assert(s
->n_connections
> 0);
3160 log_unit_debug(UNIT(s
), "One connection closed, %u left.", s
->n_connections
);
3163 static void socket_trigger_notify(Unit
*u
, Unit
*other
) {
3164 Socket
*s
= SOCKET(u
);
3169 /* Filter out invocations with bogus state */
3170 if (other
->load_state
!= UNIT_LOADED
|| other
->type
!= UNIT_SERVICE
)
3173 /* Don't propagate state changes from the service if we are already down */
3174 if (!IN_SET(s
->state
, SOCKET_RUNNING
, SOCKET_LISTENING
))
3177 /* We don't care for the service state if we are in Accept=yes mode */
3181 /* Propagate start limit hit state */
3182 if (other
->start_limit_hit
) {
3183 socket_enter_stop_pre(s
, SOCKET_FAILURE_SERVICE_START_LIMIT_HIT
);
3187 /* Don't propagate anything if there's still a job queued */
3191 if (IN_SET(SERVICE(other
)->state
,
3192 SERVICE_DEAD
, SERVICE_FAILED
,
3193 SERVICE_FINAL_SIGTERM
, SERVICE_FINAL_SIGKILL
,
3194 SERVICE_AUTO_RESTART
))
3195 socket_enter_listening(s
);
3197 if (SERVICE(other
)->state
== SERVICE_RUNNING
)
3198 socket_set_state(s
, SOCKET_RUNNING
);
3201 static int socket_kill(Unit
*u
, KillWho who
, int signo
, sd_bus_error
*error
) {
3202 return unit_kill_common(u
, who
, signo
, -1, SOCKET(u
)->control_pid
, error
);
3205 static int socket_get_timeout(Unit
*u
, usec_t
*timeout
) {
3206 Socket
*s
= SOCKET(u
);
3210 if (!s
->timer_event_source
)
3213 r
= sd_event_source_get_time(s
->timer_event_source
, &t
);
3216 if (t
== USEC_INFINITY
)
3223 char *socket_fdname(Socket
*s
) {
3226 /* Returns the name to use for $LISTEN_NAMES. If the user
3227 * didn't specify anything specifically, use the socket unit's
3228 * name as fallback. */
3230 return s
->fdname
?: UNIT(s
)->id
;
3233 static int socket_control_pid(Unit
*u
) {
3234 Socket
*s
= SOCKET(u
);
3238 return s
->control_pid
;
3241 static const char* const socket_exec_command_table
[_SOCKET_EXEC_COMMAND_MAX
] = {
3242 [SOCKET_EXEC_START_PRE
] = "ExecStartPre",
3243 [SOCKET_EXEC_START_CHOWN
] = "ExecStartChown",
3244 [SOCKET_EXEC_START_POST
] = "ExecStartPost",
3245 [SOCKET_EXEC_STOP_PRE
] = "ExecStopPre",
3246 [SOCKET_EXEC_STOP_POST
] = "ExecStopPost"
3249 DEFINE_STRING_TABLE_LOOKUP(socket_exec_command
, SocketExecCommand
);
3251 static const char* const socket_result_table
[_SOCKET_RESULT_MAX
] = {
3252 [SOCKET_SUCCESS
] = "success",
3253 [SOCKET_FAILURE_RESOURCES
] = "resources",
3254 [SOCKET_FAILURE_TIMEOUT
] = "timeout",
3255 [SOCKET_FAILURE_EXIT_CODE
] = "exit-code",
3256 [SOCKET_FAILURE_SIGNAL
] = "signal",
3257 [SOCKET_FAILURE_CORE_DUMP
] = "core-dump",
3258 [SOCKET_FAILURE_START_LIMIT_HIT
] = "start-limit-hit",
3259 [SOCKET_FAILURE_TRIGGER_LIMIT_HIT
] = "trigger-limit-hit",
3260 [SOCKET_FAILURE_SERVICE_START_LIMIT_HIT
] = "service-start-limit-hit"
3263 DEFINE_STRING_TABLE_LOOKUP(socket_result
, SocketResult
);
3265 const UnitVTable socket_vtable
= {
3266 .object_size
= sizeof(Socket
),
3267 .exec_context_offset
= offsetof(Socket
, exec_context
),
3268 .cgroup_context_offset
= offsetof(Socket
, cgroup_context
),
3269 .kill_context_offset
= offsetof(Socket
, kill_context
),
3270 .exec_runtime_offset
= offsetof(Socket
, exec_runtime
),
3271 .dynamic_creds_offset
= offsetof(Socket
, dynamic_creds
),
3277 .private_section
= "Socket",
3279 .can_transient
= true,
3281 .init
= socket_init
,
3282 .done
= socket_done
,
3283 .load
= socket_load
,
3285 .coldplug
= socket_coldplug
,
3287 .dump
= socket_dump
,
3289 .start
= socket_start
,
3290 .stop
= socket_stop
,
3292 .kill
= socket_kill
,
3294 .get_timeout
= socket_get_timeout
,
3296 .serialize
= socket_serialize
,
3297 .deserialize_item
= socket_deserialize_item
,
3298 .distribute_fds
= socket_distribute_fds
,
3300 .active_state
= socket_active_state
,
3301 .sub_state_to_string
= socket_sub_state_to_string
,
3303 .may_gc
= socket_may_gc
,
3305 .sigchld_event
= socket_sigchld_event
,
3307 .trigger_notify
= socket_trigger_notify
,
3309 .reset_failed
= socket_reset_failed
,
3311 .control_pid
= socket_control_pid
,
3313 .bus_vtable
= bus_socket_vtable
,
3314 .bus_set_property
= bus_socket_set_property
,
3315 .bus_commit_properties
= bus_socket_commit_properties
,
3317 .status_message_formats
= {
3318 /*.starting_stopping = {
3319 [0] = "Starting socket %s...",
3320 [1] = "Stopping socket %s...",
3322 .finished_start_job
= {
3323 [JOB_DONE
] = "Listening on %s.",
3324 [JOB_FAILED
] = "Failed to listen on %s.",
3325 [JOB_TIMEOUT
] = "Timed out starting %s.",
3327 .finished_stop_job
= {
3328 [JOB_DONE
] = "Closed %s.",
3329 [JOB_FAILED
] = "Failed stopping %s.",
3330 [JOB_TIMEOUT
] = "Timed out stopping %s.",