udev: String substitutions can be done in ENV, too
[systemd_ALT.git] / src / core / socket.c
blob75034ac357e80977d88b35cf9c48bf18cb639a47
1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
3 #include <arpa/inet.h>
4 #include <errno.h>
5 #include <fcntl.h>
6 #include <mqueue.h>
7 #include <netinet/tcp.h>
8 #include <sys/epoll.h>
9 #include <sys/stat.h>
10 #include <unistd.h>
11 #include <linux/sctp.h>
13 #include "alloc-util.h"
14 #include "bpf-firewall.h"
15 #include "bus-error.h"
16 #include "bus-util.h"
17 #include "chase.h"
18 #include "constants.h"
19 #include "copy.h"
20 #include "dbus-socket.h"
21 #include "dbus-unit.h"
22 #include "errno-list.h"
23 #include "exit-status.h"
24 #include "fd-util.h"
25 #include "format-util.h"
26 #include "in-addr-util.h"
27 #include "io-util.h"
28 #include "ip-protocol-list.h"
29 #include "label-util.h"
30 #include "log.h"
31 #include "mkdir-label.h"
32 #include "parse-util.h"
33 #include "path-util.h"
34 #include "process-util.h"
35 #include "selinux-util.h"
36 #include "serialize.h"
37 #include "service.h"
38 #include "signal-util.h"
39 #include "smack-util.h"
40 #include "socket.h"
41 #include "socket-netlink.h"
42 #include "special.h"
43 #include "string-table.h"
44 #include "string-util.h"
45 #include "strv.h"
46 #include "unit-name.h"
47 #include "unit.h"
48 #include "user-util.h"
50 struct SocketPeer {
51 unsigned n_ref;
53 Socket *socket;
54 union sockaddr_union peer;
55 socklen_t peer_salen;
58 static const UnitActiveState state_translation_table[_SOCKET_STATE_MAX] = {
59 [SOCKET_DEAD] = UNIT_INACTIVE,
60 [SOCKET_START_PRE] = UNIT_ACTIVATING,
61 [SOCKET_START_CHOWN] = UNIT_ACTIVATING,
62 [SOCKET_START_POST] = UNIT_ACTIVATING,
63 [SOCKET_LISTENING] = UNIT_ACTIVE,
64 [SOCKET_RUNNING] = UNIT_ACTIVE,
65 [SOCKET_STOP_PRE] = UNIT_DEACTIVATING,
66 [SOCKET_STOP_PRE_SIGTERM] = UNIT_DEACTIVATING,
67 [SOCKET_STOP_PRE_SIGKILL] = UNIT_DEACTIVATING,
68 [SOCKET_STOP_POST] = UNIT_DEACTIVATING,
69 [SOCKET_FINAL_SIGTERM] = UNIT_DEACTIVATING,
70 [SOCKET_FINAL_SIGKILL] = UNIT_DEACTIVATING,
71 [SOCKET_FAILED] = UNIT_FAILED,
72 [SOCKET_CLEANING] = UNIT_MAINTENANCE,
75 static int socket_dispatch_io(sd_event_source *source, int fd, uint32_t revents, void *userdata);
76 static int socket_dispatch_timer(sd_event_source *source, usec_t usec, void *userdata);
77 static void flush_ports(Socket *s);
79 static void socket_init(Unit *u) {
80 Socket *s = SOCKET(u);
82 assert(u);
83 assert(u->load_state == UNIT_STUB);
85 s->backlog = SOMAXCONN_DELUXE;
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;
92 s->priority = -1;
93 s->ip_tos = -1;
94 s->ip_ttl = -1;
95 s->mark = -1;
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 = UINT_MAX;
106 static void socket_unwatch_control_pid(Socket *s) {
107 assert(s);
109 if (s->control_pid <= 0)
110 return;
112 unit_unwatch_pid(UNIT(s), TAKE_PID(s->control_pid));
115 static void socket_cleanup_fd_list(SocketPort *p) {
116 assert(p);
118 close_many(p->auxiliary_fds, p->n_auxiliary_fds);
119 p->auxiliary_fds = mfree(p->auxiliary_fds);
120 p->n_auxiliary_fds = 0;
123 SocketPort *socket_port_free(SocketPort *p) {
124 if (!p)
125 return NULL;
127 sd_event_source_unref(p->event_source);
129 socket_cleanup_fd_list(p);
130 safe_close(p->fd);
131 free(p->path);
133 return mfree(p);
136 void socket_free_ports(Socket *s) {
137 SocketPort *p;
139 assert(s);
141 while ((p = s->ports)) {
142 LIST_REMOVE(port, s->ports, p);
143 socket_port_free(p);
147 static void socket_done(Unit *u) {
148 Socket *s = SOCKET(u);
149 SocketPeer *p;
151 assert(s);
153 socket_free_ports(s);
155 while ((p = set_steal_first(s->peers_by_address)))
156 p->socket = NULL;
158 s->peers_by_address = set_free(s->peers_by_address);
160 s->exec_runtime = exec_runtime_free(s->exec_runtime);
161 exec_command_free_array(s->exec_command, _SOCKET_EXEC_COMMAND_MAX);
162 s->control_command = NULL;
164 socket_unwatch_control_pid(s);
166 unit_ref_unset(&s->service);
168 s->tcp_congestion = mfree(s->tcp_congestion);
169 s->bind_to_device = mfree(s->bind_to_device);
171 s->smack = mfree(s->smack);
172 s->smack_ip_in = mfree(s->smack_ip_in);
173 s->smack_ip_out = mfree(s->smack_ip_out);
175 strv_free(s->symlinks);
177 s->user = mfree(s->user);
178 s->group = mfree(s->group);
180 s->fdname = mfree(s->fdname);
182 s->timer_event_source = sd_event_source_disable_unref(s->timer_event_source);
185 static int socket_arm_timer(Socket *s, usec_t usec) {
186 int r;
188 assert(s);
190 if (s->timer_event_source) {
191 r = sd_event_source_set_time(s->timer_event_source, usec);
192 if (r < 0)
193 return r;
195 return sd_event_source_set_enabled(s->timer_event_source, SD_EVENT_ONESHOT);
198 if (usec == USEC_INFINITY)
199 return 0;
201 r = sd_event_add_time(
202 UNIT(s)->manager->event,
203 &s->timer_event_source,
204 CLOCK_MONOTONIC,
205 usec, 0,
206 socket_dispatch_timer, s);
207 if (r < 0)
208 return r;
210 (void) sd_event_source_set_description(s->timer_event_source, "socket-timer");
212 return 0;
215 static bool have_non_accept_socket(Socket *s) {
216 assert(s);
218 if (!s->accept)
219 return true;
221 LIST_FOREACH(port, p, s->ports) {
223 if (p->type != SOCKET_SOCKET)
224 return true;
226 if (!socket_address_can_accept(&p->address))
227 return true;
230 return false;
233 static int socket_add_mount_dependencies(Socket *s) {
234 int r;
236 assert(s);
238 LIST_FOREACH(port, p, s->ports) {
239 const char *path = NULL;
241 if (p->type == SOCKET_SOCKET)
242 path = socket_address_get_path(&p->address);
243 else if (IN_SET(p->type, SOCKET_FIFO, SOCKET_SPECIAL, SOCKET_USB_FUNCTION))
244 path = p->path;
246 if (!path)
247 continue;
249 r = unit_require_mounts_for(UNIT(s), path, UNIT_DEPENDENCY_FILE);
250 if (r < 0)
251 return r;
254 return 0;
257 static int socket_add_device_dependencies(Socket *s) {
258 char *t;
260 assert(s);
262 if (!s->bind_to_device || streq(s->bind_to_device, "lo"))
263 return 0;
265 t = strjoina("/sys/subsystem/net/devices/", s->bind_to_device);
266 return unit_add_node_dependency(UNIT(s), t, UNIT_BINDS_TO, UNIT_DEPENDENCY_FILE);
269 static int socket_add_default_dependencies(Socket *s) {
270 int r;
271 assert(s);
273 if (!UNIT(s)->default_dependencies)
274 return 0;
276 r = unit_add_dependency_by_name(UNIT(s), UNIT_BEFORE, SPECIAL_SOCKETS_TARGET, true, UNIT_DEPENDENCY_DEFAULT);
277 if (r < 0)
278 return r;
280 if (MANAGER_IS_SYSTEM(UNIT(s)->manager)) {
281 r = unit_add_two_dependencies_by_name(UNIT(s), UNIT_AFTER, UNIT_REQUIRES, SPECIAL_SYSINIT_TARGET, true, UNIT_DEPENDENCY_DEFAULT);
282 if (r < 0)
283 return r;
286 return unit_add_two_dependencies_by_name(UNIT(s), UNIT_BEFORE, UNIT_CONFLICTS, SPECIAL_SHUTDOWN_TARGET, true, UNIT_DEPENDENCY_DEFAULT);
289 _pure_ static bool socket_has_exec(Socket *s) {
290 unsigned i;
291 assert(s);
293 for (i = 0; i < _SOCKET_EXEC_COMMAND_MAX; i++)
294 if (s->exec_command[i])
295 return true;
297 return false;
300 static int socket_add_extras(Socket *s) {
301 Unit *u = UNIT(s);
302 int r;
304 assert(s);
306 /* Pick defaults for the trigger limit, if nothing was explicitly configured. We pick a relatively high limit
307 * in Accept=yes mode, and a lower limit for Accept=no. Reason: in Accept=yes mode we are invoking accept()
308 * ourselves before the trigger limit can hit, thus incoming connections are taken off the socket queue quickly
309 * and reliably. This is different for Accept=no, where the spawned service has to take the incoming traffic
310 * off the queues, which it might not necessarily do. Moreover, while Accept=no services are supposed to
311 * process whatever is queued in one go, and thus should normally never have to be started frequently. This is
312 * different for Accept=yes where each connection is processed by a new service instance, and thus frequent
313 * service starts are typical. */
315 if (s->trigger_limit.interval == USEC_INFINITY)
316 s->trigger_limit.interval = 2 * USEC_PER_SEC;
318 if (s->trigger_limit.burst == UINT_MAX) {
319 if (s->accept)
320 s->trigger_limit.burst = 200;
321 else
322 s->trigger_limit.burst = 20;
325 if (have_non_accept_socket(s)) {
327 if (!UNIT_DEREF(s->service)) {
328 Unit *x;
330 r = unit_load_related_unit(u, ".service", &x);
331 if (r < 0)
332 return r;
334 unit_ref_set(&s->service, u, x);
337 r = unit_add_two_dependencies(u, UNIT_BEFORE, UNIT_TRIGGERS, UNIT_DEREF(s->service), true, UNIT_DEPENDENCY_IMPLICIT);
338 if (r < 0)
339 return r;
342 r = socket_add_mount_dependencies(s);
343 if (r < 0)
344 return r;
346 r = socket_add_device_dependencies(s);
347 if (r < 0)
348 return r;
350 r = unit_patch_contexts(u);
351 if (r < 0)
352 return r;
354 if (socket_has_exec(s)) {
355 r = unit_add_exec_dependencies(u, &s->exec_context);
356 if (r < 0)
357 return r;
360 r = unit_set_default_slice(u);
361 if (r < 0)
362 return r;
364 r = socket_add_default_dependencies(s);
365 if (r < 0)
366 return r;
368 return 0;
371 static const char *socket_find_symlink_target(Socket *s) {
372 const char *found = NULL;
374 LIST_FOREACH(port, p, s->ports) {
375 const char *f = NULL;
377 switch (p->type) {
379 case SOCKET_FIFO:
380 f = p->path;
381 break;
383 case SOCKET_SOCKET:
384 f = socket_address_get_path(&p->address);
385 break;
387 default:
388 break;
391 if (f) {
392 if (found)
393 return NULL;
395 found = f;
399 return found;
402 static int socket_verify(Socket *s) {
403 assert(s);
404 assert(UNIT(s)->load_state == UNIT_LOADED);
406 if (!s->ports)
407 return log_unit_error_errno(UNIT(s), SYNTHETIC_ERRNO(ENOEXEC), "Unit has no Listen setting (ListenStream=, ListenDatagram=, ListenFIFO=, ...). Refusing.");
409 if (s->accept && have_non_accept_socket(s))
410 return log_unit_error_errno(UNIT(s), SYNTHETIC_ERRNO(ENOEXEC), "Unit configured for accepting sockets, but sockets are non-accepting. Refusing.");
412 if (s->accept && s->max_connections <= 0)
413 return log_unit_error_errno(UNIT(s), SYNTHETIC_ERRNO(ENOEXEC), "MaxConnection= setting too small. Refusing.");
415 if (s->accept && UNIT_DEREF(s->service))
416 return log_unit_error_errno(UNIT(s), SYNTHETIC_ERRNO(ENOEXEC), "Explicit service configuration for accepting socket units not supported. Refusing.");
418 if (s->exec_context.pam_name && s->kill_context.kill_mode != KILL_CONTROL_GROUP)
419 return log_unit_error_errno(UNIT(s), SYNTHETIC_ERRNO(ENOEXEC), "Unit has PAM enabled. Kill mode must be set to 'control-group'. Refusing.");
421 if (!strv_isempty(s->symlinks) && !socket_find_symlink_target(s))
422 return log_unit_error_errno(UNIT(s), SYNTHETIC_ERRNO(ENOEXEC), "Unit has symlinks set but none or more than one node in the file system. Refusing.");
424 return 0;
427 static void peer_address_hash_func(const SocketPeer *s, struct siphash *state) {
428 assert(s);
430 if (s->peer.sa.sa_family == AF_INET)
431 siphash24_compress(&s->peer.in.sin_addr, sizeof(s->peer.in.sin_addr), state);
432 else if (s->peer.sa.sa_family == AF_INET6)
433 siphash24_compress(&s->peer.in6.sin6_addr, sizeof(s->peer.in6.sin6_addr), state);
434 else if (s->peer.sa.sa_family == AF_VSOCK)
435 siphash24_compress(&s->peer.vm.svm_cid, sizeof(s->peer.vm.svm_cid), state);
436 else
437 assert_not_reached();
440 static int peer_address_compare_func(const SocketPeer *x, const SocketPeer *y) {
441 int r;
443 r = CMP(x->peer.sa.sa_family, y->peer.sa.sa_family);
444 if (r != 0)
445 return r;
447 switch (x->peer.sa.sa_family) {
448 case AF_INET:
449 return memcmp(&x->peer.in.sin_addr, &y->peer.in.sin_addr, sizeof(x->peer.in.sin_addr));
450 case AF_INET6:
451 return memcmp(&x->peer.in6.sin6_addr, &y->peer.in6.sin6_addr, sizeof(x->peer.in6.sin6_addr));
452 case AF_VSOCK:
453 return CMP(x->peer.vm.svm_cid, y->peer.vm.svm_cid);
455 assert_not_reached();
458 DEFINE_PRIVATE_HASH_OPS(peer_address_hash_ops, SocketPeer, peer_address_hash_func, peer_address_compare_func);
460 static int socket_load(Unit *u) {
461 Socket *s = SOCKET(u);
462 int r;
464 assert(u);
465 assert(u->load_state == UNIT_STUB);
467 r = unit_load_fragment_and_dropin(u, true);
468 if (r < 0)
469 return r;
471 if (u->load_state != UNIT_LOADED)
472 return 0;
474 /* This is a new unit? Then let's add in some extras */
475 r = socket_add_extras(s);
476 if (r < 0)
477 return r;
479 return socket_verify(s);
482 static SocketPeer *socket_peer_new(void) {
483 SocketPeer *p;
485 p = new(SocketPeer, 1);
486 if (!p)
487 return NULL;
489 *p = (SocketPeer) {
490 .n_ref = 1,
492 return p;
495 static SocketPeer *socket_peer_free(SocketPeer *p) {
496 assert(p);
498 if (p->socket)
499 set_remove(p->socket->peers_by_address, p);
501 return mfree(p);
504 DEFINE_TRIVIAL_REF_UNREF_FUNC(SocketPeer, socket_peer, socket_peer_free);
506 int socket_acquire_peer(Socket *s, int fd, SocketPeer **p) {
507 _cleanup_(socket_peer_unrefp) SocketPeer *remote = NULL;
508 SocketPeer sa = {
509 .peer_salen = sizeof(union sockaddr_union),
510 }, *i;
511 int r;
513 assert(fd >= 0);
514 assert(s);
516 if (getpeername(fd, &sa.peer.sa, &sa.peer_salen) < 0)
517 return log_unit_error_errno(UNIT(s), errno, "getpeername failed: %m");
519 if (!IN_SET(sa.peer.sa.sa_family, AF_INET, AF_INET6, AF_VSOCK)) {
520 *p = NULL;
521 return 0;
524 r = set_ensure_allocated(&s->peers_by_address, &peer_address_hash_ops);
525 if (r < 0)
526 return r;
528 i = set_get(s->peers_by_address, &sa);
529 if (i) {
530 *p = socket_peer_ref(i);
531 return 1;
534 remote = socket_peer_new();
535 if (!remote)
536 return log_oom();
538 remote->peer = sa.peer;
539 remote->peer_salen = sa.peer_salen;
541 r = set_put(s->peers_by_address, remote);
542 if (r < 0)
543 return r;
545 remote->socket = s;
547 *p = TAKE_PTR(remote);
548 return 1;
551 _const_ static const char* listen_lookup(int family, int type) {
553 if (family == AF_NETLINK)
554 return "ListenNetlink";
556 if (type == SOCK_STREAM)
557 return "ListenStream";
558 else if (type == SOCK_DGRAM)
559 return "ListenDatagram";
560 else if (type == SOCK_SEQPACKET)
561 return "ListenSequentialPacket";
563 assert_not_reached();
564 return NULL;
567 static void socket_dump(Unit *u, FILE *f, const char *prefix) {
568 Socket *s = SOCKET(u);
569 const char *prefix2, *str;
571 assert(s);
572 assert(f);
574 prefix = strempty(prefix);
575 prefix2 = strjoina(prefix, "\t");
577 fprintf(f,
578 "%sSocket State: %s\n"
579 "%sResult: %s\n"
580 "%sClean Result: %s\n"
581 "%sBindIPv6Only: %s\n"
582 "%sBacklog: %u\n"
583 "%sSocketMode: %04o\n"
584 "%sDirectoryMode: %04o\n"
585 "%sKeepAlive: %s\n"
586 "%sNoDelay: %s\n"
587 "%sFreeBind: %s\n"
588 "%sTransparent: %s\n"
589 "%sBroadcast: %s\n"
590 "%sPassCredentials: %s\n"
591 "%sPassSecurity: %s\n"
592 "%sPassPacketInfo: %s\n"
593 "%sTCPCongestion: %s\n"
594 "%sRemoveOnStop: %s\n"
595 "%sWritable: %s\n"
596 "%sFileDescriptorName: %s\n"
597 "%sSELinuxContextFromNet: %s\n",
598 prefix, socket_state_to_string(s->state),
599 prefix, socket_result_to_string(s->result),
600 prefix, socket_result_to_string(s->clean_result),
601 prefix, socket_address_bind_ipv6_only_to_string(s->bind_ipv6_only),
602 prefix, s->backlog,
603 prefix, s->socket_mode,
604 prefix, s->directory_mode,
605 prefix, yes_no(s->keep_alive),
606 prefix, yes_no(s->no_delay),
607 prefix, yes_no(s->free_bind),
608 prefix, yes_no(s->transparent),
609 prefix, yes_no(s->broadcast),
610 prefix, yes_no(s->pass_cred),
611 prefix, yes_no(s->pass_sec),
612 prefix, yes_no(s->pass_pktinfo),
613 prefix, strna(s->tcp_congestion),
614 prefix, yes_no(s->remove_on_stop),
615 prefix, yes_no(s->writable),
616 prefix, socket_fdname(s),
617 prefix, yes_no(s->selinux_context_from_net));
619 if (s->timestamping != SOCKET_TIMESTAMPING_OFF)
620 fprintf(f,
621 "%sTimestamping: %s\n",
622 prefix, socket_timestamping_to_string(s->timestamping));
624 if (s->control_pid > 0)
625 fprintf(f,
626 "%sControl PID: "PID_FMT"\n",
627 prefix, s->control_pid);
629 if (s->bind_to_device)
630 fprintf(f,
631 "%sBindToDevice: %s\n",
632 prefix, s->bind_to_device);
634 if (s->accept)
635 fprintf(f,
636 "%sAccepted: %u\n"
637 "%sNConnections: %u\n"
638 "%sMaxConnections: %u\n"
639 "%sMaxConnectionsPerSource: %u\n",
640 prefix, s->n_accepted,
641 prefix, s->n_connections,
642 prefix, s->max_connections,
643 prefix, s->max_connections_per_source);
644 else
645 fprintf(f,
646 "%sFlushPending: %s\n",
647 prefix, yes_no(s->flush_pending));
650 if (s->priority >= 0)
651 fprintf(f,
652 "%sPriority: %i\n",
653 prefix, s->priority);
655 if (s->receive_buffer > 0)
656 fprintf(f,
657 "%sReceiveBuffer: %zu\n",
658 prefix, s->receive_buffer);
660 if (s->send_buffer > 0)
661 fprintf(f,
662 "%sSendBuffer: %zu\n",
663 prefix, s->send_buffer);
665 if (s->ip_tos >= 0)
666 fprintf(f,
667 "%sIPTOS: %i\n",
668 prefix, s->ip_tos);
670 if (s->ip_ttl >= 0)
671 fprintf(f,
672 "%sIPTTL: %i\n",
673 prefix, s->ip_ttl);
675 if (s->pipe_size > 0)
676 fprintf(f,
677 "%sPipeSize: %zu\n",
678 prefix, s->pipe_size);
680 if (s->mark >= 0)
681 fprintf(f,
682 "%sMark: %i\n",
683 prefix, s->mark);
685 if (s->mq_maxmsg > 0)
686 fprintf(f,
687 "%sMessageQueueMaxMessages: %li\n",
688 prefix, s->mq_maxmsg);
690 if (s->mq_msgsize > 0)
691 fprintf(f,
692 "%sMessageQueueMessageSize: %li\n",
693 prefix, s->mq_msgsize);
695 if (s->reuse_port)
696 fprintf(f,
697 "%sReusePort: %s\n",
698 prefix, yes_no(s->reuse_port));
700 if (s->smack)
701 fprintf(f,
702 "%sSmackLabel: %s\n",
703 prefix, s->smack);
705 if (s->smack_ip_in)
706 fprintf(f,
707 "%sSmackLabelIPIn: %s\n",
708 prefix, s->smack_ip_in);
710 if (s->smack_ip_out)
711 fprintf(f,
712 "%sSmackLabelIPOut: %s\n",
713 prefix, s->smack_ip_out);
715 if (!isempty(s->user) || !isempty(s->group))
716 fprintf(f,
717 "%sSocketUser: %s\n"
718 "%sSocketGroup: %s\n",
719 prefix, strna(s->user),
720 prefix, strna(s->group));
722 if (timestamp_is_set(s->keep_alive_time))
723 fprintf(f,
724 "%sKeepAliveTimeSec: %s\n",
725 prefix, FORMAT_TIMESPAN(s->keep_alive_time, USEC_PER_SEC));
727 if (s->keep_alive_interval > 0)
728 fprintf(f,
729 "%sKeepAliveIntervalSec: %s\n",
730 prefix, FORMAT_TIMESPAN(s->keep_alive_interval, USEC_PER_SEC));
732 if (s->keep_alive_cnt > 0)
733 fprintf(f,
734 "%sKeepAliveProbes: %u\n",
735 prefix, s->keep_alive_cnt);
737 if (s->defer_accept > 0)
738 fprintf(f,
739 "%sDeferAcceptSec: %s\n",
740 prefix, FORMAT_TIMESPAN(s->defer_accept, USEC_PER_SEC));
742 LIST_FOREACH(port, p, s->ports) {
744 switch (p->type) {
745 case SOCKET_SOCKET: {
746 _cleanup_free_ char *k = NULL;
747 int r;
749 r = socket_address_print(&p->address, &k);
750 if (r < 0) {
751 errno = -r;
752 fprintf(f, "%s%s: %m\n", prefix, listen_lookup(socket_address_family(&p->address), p->address.type));
753 } else
754 fprintf(f, "%s%s: %s\n", prefix, listen_lookup(socket_address_family(&p->address), p->address.type), k);
755 break;
757 case SOCKET_SPECIAL:
758 fprintf(f, "%sListenSpecial: %s\n", prefix, p->path);
759 break;
760 case SOCKET_USB_FUNCTION:
761 fprintf(f, "%sListenUSBFunction: %s\n", prefix, p->path);
762 break;
763 case SOCKET_MQUEUE:
764 fprintf(f, "%sListenMessageQueue: %s\n", prefix, p->path);
765 break;
766 default:
767 fprintf(f, "%sListenFIFO: %s\n", prefix, p->path);
771 fprintf(f,
772 "%sTriggerLimitIntervalSec: %s\n"
773 "%sTriggerLimitBurst: %u\n",
774 prefix, FORMAT_TIMESPAN(s->trigger_limit.interval, USEC_PER_SEC),
775 prefix, s->trigger_limit.burst);
777 str = ip_protocol_to_name(s->socket_protocol);
778 if (str)
779 fprintf(f, "%sSocketProtocol: %s\n", prefix, str);
781 if (!strv_isempty(s->symlinks)) {
782 fprintf(f, "%sSymlinks:", prefix);
783 STRV_FOREACH(q, s->symlinks)
784 fprintf(f, " %s", *q);
786 fprintf(f, "\n");
789 fprintf(f,
790 "%sTimeoutSec: %s\n",
791 prefix, FORMAT_TIMESPAN(s->timeout_usec, USEC_PER_SEC));
793 exec_context_dump(&s->exec_context, f, prefix);
794 kill_context_dump(&s->kill_context, f, prefix);
796 for (SocketExecCommand c = 0; c < _SOCKET_EXEC_COMMAND_MAX; c++) {
797 if (!s->exec_command[c])
798 continue;
800 fprintf(f, "%s-> %s:\n",
801 prefix, socket_exec_command_to_string(c));
803 exec_command_dump_list(s->exec_command[c], f, prefix2);
806 cgroup_context_dump(UNIT(s), f, prefix);
809 static int instance_from_socket(int fd, unsigned nr, char **instance) {
810 socklen_t l;
811 char *r;
812 union sockaddr_union local, remote;
814 assert(fd >= 0);
815 assert(instance);
817 l = sizeof(local);
818 if (getsockname(fd, &local.sa, &l) < 0)
819 return -errno;
821 l = sizeof(remote);
822 if (getpeername(fd, &remote.sa, &l) < 0)
823 return -errno;
825 switch (local.sa.sa_family) {
827 case AF_INET: {
828 uint32_t
829 a = be32toh(local.in.sin_addr.s_addr),
830 b = be32toh(remote.in.sin_addr.s_addr);
832 if (asprintf(&r,
833 "%u-%u.%u.%u.%u:%u-%u.%u.%u.%u:%u",
835 a >> 24, (a >> 16) & 0xFF, (a >> 8) & 0xFF, a & 0xFF,
836 be16toh(local.in.sin_port),
837 b >> 24, (b >> 16) & 0xFF, (b >> 8) & 0xFF, b & 0xFF,
838 be16toh(remote.in.sin_port)) < 0)
839 return -ENOMEM;
841 break;
844 case AF_INET6: {
845 static const unsigned char ipv4_prefix[] = {
846 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0xFF, 0xFF
849 if (memcmp(&local.in6.sin6_addr, ipv4_prefix, sizeof(ipv4_prefix)) == 0 &&
850 memcmp(&remote.in6.sin6_addr, ipv4_prefix, sizeof(ipv4_prefix)) == 0) {
851 const uint8_t
852 *a = local.in6.sin6_addr.s6_addr+12,
853 *b = remote.in6.sin6_addr.s6_addr+12;
855 if (asprintf(&r,
856 "%u-%u.%u.%u.%u:%u-%u.%u.%u.%u:%u",
858 a[0], a[1], a[2], a[3],
859 be16toh(local.in6.sin6_port),
860 b[0], b[1], b[2], b[3],
861 be16toh(remote.in6.sin6_port)) < 0)
862 return -ENOMEM;
863 } else {
864 if (asprintf(&r,
865 "%u-%s:%u-%s:%u",
867 IN6_ADDR_TO_STRING(&local.in6.sin6_addr),
868 be16toh(local.in6.sin6_port),
869 IN6_ADDR_TO_STRING(&remote.in6.sin6_addr),
870 be16toh(remote.in6.sin6_port)) < 0)
871 return -ENOMEM;
874 break;
877 case AF_UNIX: {
878 struct ucred ucred;
879 int k;
881 k = getpeercred(fd, &ucred);
882 if (k >= 0) {
883 if (asprintf(&r,
884 "%u-"PID_FMT"-"UID_FMT,
885 nr, ucred.pid, ucred.uid) < 0)
886 return -ENOMEM;
887 } else if (k == -ENODATA) {
888 /* This handles the case where somebody is
889 * connecting from another pid/uid namespace
890 * (e.g. from outside of our container). */
891 if (asprintf(&r,
892 "%u-unknown",
893 nr) < 0)
894 return -ENOMEM;
895 } else
896 return k;
898 break;
901 case AF_VSOCK:
902 if (asprintf(&r,
903 "%u-%u:%u-%u:%u",
905 local.vm.svm_cid, local.vm.svm_port,
906 remote.vm.svm_cid, remote.vm.svm_port) < 0)
907 return -ENOMEM;
909 break;
911 default:
912 assert_not_reached();
915 *instance = r;
916 return 0;
919 static void socket_close_fds(Socket *s) {
920 assert(s);
922 LIST_FOREACH(port, p, s->ports) {
923 bool was_open;
925 was_open = p->fd >= 0;
927 p->event_source = sd_event_source_disable_unref(p->event_source);
928 p->fd = safe_close(p->fd);
929 socket_cleanup_fd_list(p);
931 /* One little note: we should normally not delete any sockets in the file system here! After all some
932 * other process we spawned might still have a reference of this fd and wants to continue to use
933 * it. Therefore we normally delete sockets in the file system before we create a new one, not after we
934 * stopped using one! That all said, if the user explicitly requested this, we'll delete them here
935 * anyway, but only then. */
937 if (!was_open || !s->remove_on_stop)
938 continue;
940 switch (p->type) {
942 case SOCKET_FIFO:
943 (void) unlink(p->path);
944 break;
946 case SOCKET_MQUEUE:
947 (void) mq_unlink(p->path);
948 break;
950 case SOCKET_SOCKET:
951 (void) socket_address_unlink(&p->address);
952 break;
954 default:
955 break;
959 if (s->remove_on_stop)
960 STRV_FOREACH(i, s->symlinks)
961 (void) unlink(*i);
963 /* Note that we don't return NULL here, since s has not been freed. */
966 static void socket_apply_socket_options(Socket *s, SocketPort *p, int fd) {
967 int r;
969 assert(s);
970 assert(p);
971 assert(fd >= 0);
973 if (s->keep_alive) {
974 r = setsockopt_int(fd, SOL_SOCKET, SO_KEEPALIVE, true);
975 if (r < 0)
976 log_unit_warning_errno(UNIT(s), r, "SO_KEEPALIVE failed: %m");
979 if (timestamp_is_set(s->keep_alive_time)) {
980 r = setsockopt_int(fd, SOL_TCP, TCP_KEEPIDLE, s->keep_alive_time / USEC_PER_SEC);
981 if (r < 0)
982 log_unit_warning_errno(UNIT(s), r, "TCP_KEEPIDLE failed: %m");
985 if (s->keep_alive_interval > 0) {
986 r = setsockopt_int(fd, SOL_TCP, TCP_KEEPINTVL, s->keep_alive_interval / USEC_PER_SEC);
987 if (r < 0)
988 log_unit_warning_errno(UNIT(s), r, "TCP_KEEPINTVL failed: %m");
991 if (s->keep_alive_cnt > 0) {
992 r = setsockopt_int(fd, SOL_TCP, TCP_KEEPCNT, s->keep_alive_cnt);
993 if (r < 0)
994 log_unit_warning_errno(UNIT(s), r, "TCP_KEEPCNT failed: %m");
997 if (s->defer_accept > 0) {
998 r = setsockopt_int(fd, SOL_TCP, TCP_DEFER_ACCEPT, s->defer_accept / USEC_PER_SEC);
999 if (r < 0)
1000 log_unit_warning_errno(UNIT(s), r, "TCP_DEFER_ACCEPT failed: %m");
1003 if (s->no_delay) {
1004 if (s->socket_protocol == IPPROTO_SCTP) {
1005 r = setsockopt_int(fd, SOL_SCTP, SCTP_NODELAY, true);
1006 if (r < 0)
1007 log_unit_warning_errno(UNIT(s), r, "SCTP_NODELAY failed: %m");
1008 } else {
1009 r = setsockopt_int(fd, SOL_TCP, TCP_NODELAY, true);
1010 if (r < 0)
1011 log_unit_warning_errno(UNIT(s), r, "TCP_NODELAY failed: %m");
1015 if (s->broadcast) {
1016 r = setsockopt_int(fd, SOL_SOCKET, SO_BROADCAST, true);
1017 if (r < 0)
1018 log_unit_warning_errno(UNIT(s), r, "SO_BROADCAST failed: %m");
1021 if (s->pass_cred) {
1022 r = setsockopt_int(fd, SOL_SOCKET, SO_PASSCRED, true);
1023 if (r < 0)
1024 log_unit_warning_errno(UNIT(s), r, "SO_PASSCRED failed: %m");
1027 if (s->pass_sec) {
1028 r = setsockopt_int(fd, SOL_SOCKET, SO_PASSSEC, true);
1029 if (r < 0)
1030 log_unit_warning_errno(UNIT(s), r, "SO_PASSSEC failed: %m");
1033 if (s->pass_pktinfo) {
1034 r = socket_set_recvpktinfo(fd, socket_address_family(&p->address), true);
1035 if (r < 0)
1036 log_unit_warning_errno(UNIT(s), r, "Failed to enable packet info socket option: %m");
1039 if (s->timestamping != SOCKET_TIMESTAMPING_OFF) {
1040 r = setsockopt_int(fd, SOL_SOCKET,
1041 s->timestamping == SOCKET_TIMESTAMPING_NS ? SO_TIMESTAMPNS : SO_TIMESTAMP,
1042 true);
1043 if (r < 0)
1044 log_unit_warning_errno(UNIT(s), r, "Failed to enable timestamping socket option, ignoring: %m");
1047 if (s->priority >= 0) {
1048 r = setsockopt_int(fd, SOL_SOCKET, SO_PRIORITY, s->priority);
1049 if (r < 0)
1050 log_unit_warning_errno(UNIT(s), r, "SO_PRIORITY failed: %m");
1053 if (s->receive_buffer > 0) {
1054 r = fd_set_rcvbuf(fd, s->receive_buffer, false);
1055 if (r < 0)
1056 log_unit_full_errno(UNIT(s), ERRNO_IS_PRIVILEGE(r) ? LOG_DEBUG : LOG_WARNING, r,
1057 "SO_RCVBUF/SO_RCVBUFFORCE failed: %m");
1060 if (s->send_buffer > 0) {
1061 r = fd_set_sndbuf(fd, s->send_buffer, false);
1062 if (r < 0)
1063 log_unit_full_errno(UNIT(s), ERRNO_IS_PRIVILEGE(r) ? LOG_DEBUG : LOG_WARNING, r,
1064 "SO_SNDBUF/SO_SNDBUFFORCE failed: %m");
1067 if (s->mark >= 0) {
1068 r = setsockopt_int(fd, SOL_SOCKET, SO_MARK, s->mark);
1069 if (r < 0)
1070 log_unit_warning_errno(UNIT(s), r, "SO_MARK failed: %m");
1073 if (s->ip_tos >= 0) {
1074 r = setsockopt_int(fd, IPPROTO_IP, IP_TOS, s->ip_tos);
1075 if (r < 0)
1076 log_unit_warning_errno(UNIT(s), r, "IP_TOS failed: %m");
1079 if (s->ip_ttl >= 0) {
1080 r = socket_set_ttl(fd, socket_address_family(&p->address), s->ip_ttl);
1081 if (r < 0)
1082 log_unit_warning_errno(UNIT(s), r, "IP_TTL/IPV6_UNICAST_HOPS failed: %m");
1085 if (s->tcp_congestion)
1086 if (setsockopt(fd, SOL_TCP, TCP_CONGESTION, s->tcp_congestion, strlen(s->tcp_congestion)+1) < 0)
1087 log_unit_warning_errno(UNIT(s), errno, "TCP_CONGESTION failed: %m");
1089 if (s->smack_ip_in) {
1090 r = mac_smack_apply_fd(fd, SMACK_ATTR_IPIN, s->smack_ip_in);
1091 if (r < 0)
1092 log_unit_error_errno(UNIT(s), r, "mac_smack_apply_ip_in_fd: %m");
1095 if (s->smack_ip_out) {
1096 r = mac_smack_apply_fd(fd, SMACK_ATTR_IPOUT, s->smack_ip_out);
1097 if (r < 0)
1098 log_unit_error_errno(UNIT(s), r, "mac_smack_apply_ip_out_fd: %m");
1102 static void socket_apply_fifo_options(Socket *s, int fd) {
1103 int r;
1105 assert(s);
1106 assert(fd >= 0);
1108 if (s->pipe_size > 0)
1109 if (fcntl(fd, F_SETPIPE_SZ, s->pipe_size) < 0)
1110 log_unit_warning_errno(UNIT(s), errno, "Setting pipe size failed, ignoring: %m");
1112 if (s->smack) {
1113 r = mac_smack_apply_fd(fd, SMACK_ATTR_ACCESS, s->smack);
1114 if (r < 0)
1115 log_unit_error_errno(UNIT(s), r, "SMACK relabelling failed, ignoring: %m");
1119 static int fifo_address_create(
1120 const char *path,
1121 mode_t directory_mode,
1122 mode_t socket_mode) {
1124 _cleanup_close_ int fd = -EBADF;
1125 mode_t old_mask;
1126 struct stat st;
1127 int r;
1129 assert(path);
1131 (void) mkdir_parents_label(path, directory_mode);
1133 r = mac_selinux_create_file_prepare(path, S_IFIFO);
1134 if (r < 0)
1135 return r;
1137 /* Enforce the right access mode for the fifo */
1138 old_mask = umask(~socket_mode);
1140 /* Include the original umask in our mask */
1141 (void) umask(~socket_mode | old_mask);
1143 r = mkfifo(path, socket_mode);
1144 (void) umask(old_mask);
1146 if (r < 0 && errno != EEXIST) {
1147 r = -errno;
1148 goto fail;
1151 fd = open(path, O_RDWR | O_CLOEXEC | O_NOCTTY | O_NONBLOCK | O_NOFOLLOW);
1152 if (fd < 0) {
1153 r = -errno;
1154 goto fail;
1157 mac_selinux_create_file_clear();
1159 if (fstat(fd, &st) < 0) {
1160 r = -errno;
1161 goto fail;
1164 if (!S_ISFIFO(st.st_mode) ||
1165 (st.st_mode & 0777) != (socket_mode & ~old_mask) ||
1166 st.st_uid != getuid() ||
1167 st.st_gid != getgid()) {
1168 r = -EEXIST;
1169 goto fail;
1172 return TAKE_FD(fd);
1174 fail:
1175 mac_selinux_create_file_clear();
1176 return r;
1179 static int special_address_create(const char *path, bool writable) {
1180 _cleanup_close_ int fd = -EBADF;
1181 struct stat st;
1183 assert(path);
1185 fd = open(path, (writable ? O_RDWR : O_RDONLY)|O_CLOEXEC|O_NOCTTY|O_NONBLOCK|O_NOFOLLOW);
1186 if (fd < 0)
1187 return -errno;
1189 if (fstat(fd, &st) < 0)
1190 return -errno;
1192 /* Check whether this is a /proc, /sys or /dev file or char device */
1193 if (!S_ISREG(st.st_mode) && !S_ISCHR(st.st_mode))
1194 return -EEXIST;
1196 return TAKE_FD(fd);
1199 static int usbffs_address_create(const char *path) {
1200 _cleanup_close_ int fd = -EBADF;
1201 struct stat st;
1203 assert(path);
1205 fd = open(path, O_RDWR|O_CLOEXEC|O_NOCTTY|O_NONBLOCK|O_NOFOLLOW);
1206 if (fd < 0)
1207 return -errno;
1209 if (fstat(fd, &st) < 0)
1210 return -errno;
1212 /* Check whether this is a regular file (ffs endpoint) */
1213 if (!S_ISREG(st.st_mode))
1214 return -EEXIST;
1216 return TAKE_FD(fd);
1219 static int mq_address_create(
1220 const char *path,
1221 mode_t mq_mode,
1222 long maxmsg,
1223 long msgsize) {
1225 _cleanup_close_ int fd = -EBADF;
1226 struct stat st;
1227 mode_t old_mask;
1228 struct mq_attr _attr, *attr = NULL;
1230 assert(path);
1232 if (maxmsg > 0 && msgsize > 0) {
1233 _attr = (struct mq_attr) {
1234 .mq_flags = O_NONBLOCK,
1235 .mq_maxmsg = maxmsg,
1236 .mq_msgsize = msgsize,
1238 attr = &_attr;
1241 /* Enforce the right access mode for the mq */
1242 old_mask = umask(~mq_mode);
1244 /* Include the original umask in our mask */
1245 (void) umask(~mq_mode | old_mask);
1246 fd = mq_open(path, O_RDONLY|O_CLOEXEC|O_NONBLOCK|O_CREAT, mq_mode, attr);
1247 (void) umask(old_mask);
1249 if (fd < 0)
1250 return -errno;
1252 if (fstat(fd, &st) < 0)
1253 return -errno;
1255 if ((st.st_mode & 0777) != (mq_mode & ~old_mask) ||
1256 st.st_uid != getuid() ||
1257 st.st_gid != getgid())
1258 return -EEXIST;
1260 return TAKE_FD(fd);
1263 static int socket_symlink(Socket *s) {
1264 const char *p;
1265 int r;
1267 assert(s);
1269 p = socket_find_symlink_target(s);
1270 if (!p)
1271 return 0;
1273 STRV_FOREACH(i, s->symlinks) {
1274 (void) mkdir_parents_label(*i, s->directory_mode);
1276 r = symlink_idempotent(p, *i, false);
1278 if (r == -EEXIST && s->remove_on_stop) {
1279 /* If there's already something where we want to create the symlink, and the destructive
1280 * RemoveOnStop= mode is set, then we might as well try to remove what already exists and try
1281 * again. */
1283 if (unlink(*i) >= 0)
1284 r = symlink_idempotent(p, *i, false);
1287 if (r < 0)
1288 log_unit_warning_errno(UNIT(s), r, "Failed to create symlink %s %s %s, ignoring: %m",
1289 p, special_glyph(SPECIAL_GLYPH_ARROW_RIGHT), *i);
1292 return 0;
1295 static int usbffs_write_descs(int fd, Service *s) {
1296 int r;
1298 if (!s->usb_function_descriptors || !s->usb_function_strings)
1299 return -EINVAL;
1301 r = copy_file_fd(s->usb_function_descriptors, fd, 0);
1302 if (r < 0)
1303 return r;
1305 return copy_file_fd(s->usb_function_strings, fd, 0);
1308 static int usbffs_select_ep(const struct dirent *d) {
1309 return d->d_name[0] != '.' && !streq(d->d_name, "ep0");
1312 static int usbffs_dispatch_eps(SocketPort *p) {
1313 _cleanup_free_ struct dirent **ent = NULL;
1314 size_t n, k;
1315 int r;
1317 r = scandir(p->path, &ent, usbffs_select_ep, alphasort);
1318 if (r < 0)
1319 return -errno;
1321 n = (size_t) r;
1322 p->auxiliary_fds = new(int, n);
1323 if (!p->auxiliary_fds) {
1324 r = -ENOMEM;
1325 goto clear;
1328 p->n_auxiliary_fds = n;
1330 k = 0;
1331 for (size_t i = 0; i < n; ++i) {
1332 _cleanup_free_ char *ep = NULL;
1334 ep = path_make_absolute(ent[i]->d_name, p->path);
1335 if (!ep) {
1336 r = -ENOMEM;
1337 goto fail;
1340 path_simplify(ep);
1342 r = usbffs_address_create(ep);
1343 if (r < 0)
1344 goto fail;
1346 p->auxiliary_fds[k++] = r;
1349 r = 0;
1350 goto clear;
1352 fail:
1353 close_many(p->auxiliary_fds, k);
1354 p->auxiliary_fds = mfree(p->auxiliary_fds);
1355 p->n_auxiliary_fds = 0;
1357 clear:
1358 for (size_t i = 0; i < n; ++i)
1359 free(ent[i]);
1361 return r;
1364 int socket_load_service_unit(Socket *s, int cfd, Unit **ret) {
1365 /* Figure out what the unit that will be used to handle the connections on the socket looks like.
1367 * If cfd < 0, then we don't have a connection yet. In case of Accept=yes sockets, use a fake
1368 * instance name.
1371 if (UNIT_ISSET(s->service)) {
1372 *ret = UNIT_DEREF(s->service);
1373 return 0;
1376 if (!s->accept)
1377 return -ENODATA;
1379 /* Build the instance name and load the unit */
1380 _cleanup_free_ char *prefix = NULL, *instance = NULL, *name = NULL;
1381 int r;
1383 r = unit_name_to_prefix(UNIT(s)->id, &prefix);
1384 if (r < 0)
1385 return r;
1387 if (cfd >= 0) {
1388 r = instance_from_socket(cfd, s->n_accepted, &instance);
1389 if (ERRNO_IS_DISCONNECT(r))
1390 /* ENOTCONN is legitimate if TCP RST was received. Other socket families might return
1391 * different errors. This connection is over, but the socket unit lives on. */
1392 return log_unit_debug_errno(UNIT(s), r,
1393 "Got %s on incoming socket, assuming aborted connection attempt, ignoring.",
1394 errno_to_name(r));
1395 if (r < 0)
1396 return r;
1399 /* For accepting sockets, we don't know how the instance will be called until we get a connection and
1400 * can figure out what the peer name is. So let's use "internal" as the instance to make it clear
1401 * that this is not an actual peer name. We use "unknown" when we cannot figure out the peer. */
1402 r = unit_name_build(prefix, instance ?: "internal", ".service", &name);
1403 if (r < 0)
1404 return r;
1406 return manager_load_unit(UNIT(s)->manager, name, NULL, NULL, ret);
1409 static int socket_determine_selinux_label(Socket *s, char **ret) {
1410 int r;
1412 assert(s);
1413 assert(ret);
1415 Unit *service;
1416 ExecCommand *c;
1417 const char *exec_context;
1418 _cleanup_free_ char *path = NULL;
1420 r = socket_load_service_unit(s, -1, &service);
1421 if (r == -ENODATA)
1422 goto no_label;
1423 if (r < 0)
1424 return r;
1426 exec_context = SERVICE(service)->exec_context.selinux_context;
1427 if (exec_context) {
1428 char *con;
1430 con = strdup(exec_context);
1431 if (!con)
1432 return -ENOMEM;
1434 *ret = TAKE_PTR(con);
1435 return 0;
1438 c = SERVICE(service)->exec_command[SERVICE_EXEC_START];
1439 if (!c)
1440 goto no_label;
1442 r = chase(c->path, SERVICE(service)->exec_context.root_directory, CHASE_PREFIX_ROOT, &path, NULL);
1443 if (r < 0)
1444 goto no_label;
1446 r = mac_selinux_get_create_label_from_exe(path, ret);
1447 if (IN_SET(r, -EPERM, -EOPNOTSUPP))
1448 goto no_label;
1449 return r;
1451 no_label:
1452 *ret = NULL;
1453 return 0;
1456 static int socket_address_listen_do(
1457 Socket *s,
1458 const SocketAddress *address,
1459 const char *label) {
1461 assert(s);
1462 assert(address);
1464 return socket_address_listen(
1465 address,
1466 SOCK_CLOEXEC|SOCK_NONBLOCK,
1467 s->backlog,
1468 s->bind_ipv6_only,
1469 s->bind_to_device,
1470 s->reuse_port,
1471 s->free_bind,
1472 s->transparent,
1473 s->directory_mode,
1474 s->socket_mode,
1475 label);
1478 #define log_address_error_errno(u, address, error, fmt) \
1479 ({ \
1480 _cleanup_free_ char *_t = NULL; \
1482 (void) socket_address_print(address, &_t); \
1483 log_unit_error_errno(u, error, fmt, strna(_t)); \
1486 static int fork_needed(const SocketAddress *address, const ExecContext *context) {
1487 int r;
1489 assert(address);
1490 assert(context);
1492 /* Check if we need to do the cgroup or netns stuff. If not we can do things much simpler. */
1494 if (IN_SET(address->sockaddr.sa.sa_family, AF_INET, AF_INET6)) {
1495 r = bpf_firewall_supported();
1496 if (r < 0)
1497 return r;
1498 if (r != BPF_FIREWALL_UNSUPPORTED) /* If BPF firewalling isn't supported anyway — there's no point in this forking complexity */
1499 return true;
1502 return exec_needs_network_namespace(context);
1505 static int socket_address_listen_in_cgroup(
1506 Socket *s,
1507 const SocketAddress *address,
1508 const char *label) {
1510 _cleanup_close_pair_ int pair[2] = PIPE_EBADF;
1511 int fd, r;
1512 pid_t pid;
1514 assert(s);
1515 assert(address);
1517 /* This is a wrapper around socket_address_listen(), that forks off a helper process inside the
1518 * socket's cgroup and network namespace in which the socket is actually created. This way we ensure
1519 * the socket is actually properly attached to the unit's cgroup for the purpose of BPF filtering and
1520 * such. */
1522 r = fork_needed(address, &s->exec_context);
1523 if (r < 0)
1524 return r;
1525 if (r == 0) {
1526 /* Shortcut things... */
1527 fd = socket_address_listen_do(s, address, label);
1528 if (fd < 0)
1529 return log_address_error_errno(UNIT(s), address, fd, "Failed to create listening socket (%s): %m");
1531 return fd;
1534 r = unit_setup_exec_runtime(UNIT(s));
1535 if (r < 0)
1536 return log_unit_error_errno(UNIT(s), r, "Failed acquire runtime: %m");
1538 if (s->exec_context.network_namespace_path &&
1539 s->exec_runtime &&
1540 s->exec_runtime->shared &&
1541 s->exec_runtime->shared->netns_storage_socket[0] >= 0) {
1542 r = open_shareable_ns_path(s->exec_runtime->shared->netns_storage_socket, s->exec_context.network_namespace_path, CLONE_NEWNET);
1543 if (r < 0)
1544 return log_unit_error_errno(UNIT(s), r, "Failed to open network namespace path %s: %m", s->exec_context.network_namespace_path);
1547 if (s->exec_context.ipc_namespace_path &&
1548 s->exec_runtime &&
1549 s->exec_runtime->shared &&
1550 s->exec_runtime->shared->ipcns_storage_socket[0] >= 0) {
1551 r = open_shareable_ns_path(s->exec_runtime->shared->ipcns_storage_socket, s->exec_context.ipc_namespace_path, CLONE_NEWIPC);
1552 if (r < 0)
1553 return log_unit_error_errno(UNIT(s), r, "Failed to open IPC namespace path %s: %m", s->exec_context.ipc_namespace_path);
1556 if (socketpair(AF_UNIX, SOCK_SEQPACKET|SOCK_CLOEXEC, 0, pair) < 0)
1557 return log_unit_error_errno(UNIT(s), errno, "Failed to create communication channel: %m");
1559 r = unit_fork_helper_process(UNIT(s), "(sd-listen)", &pid);
1560 if (r < 0)
1561 return log_unit_error_errno(UNIT(s), r, "Failed to fork off listener stub process: %m");
1562 if (r == 0) {
1563 /* Child */
1565 pair[0] = safe_close(pair[0]);
1567 if (exec_needs_network_namespace(&s->exec_context) &&
1568 s->exec_runtime &&
1569 s->exec_runtime->shared &&
1570 s->exec_runtime->shared->netns_storage_socket[0] >= 0) {
1572 if (ns_type_supported(NAMESPACE_NET)) {
1573 r = setup_shareable_ns(s->exec_runtime->shared->netns_storage_socket, CLONE_NEWNET);
1574 if (r < 0) {
1575 log_unit_error_errno(UNIT(s), r, "Failed to join network namespace: %m");
1576 _exit(EXIT_NETWORK);
1578 } else if (s->exec_context.network_namespace_path) {
1579 log_unit_error(UNIT(s), "Network namespace path configured but network namespaces not supported.");
1580 _exit(EXIT_NETWORK);
1581 } else
1582 log_unit_warning(UNIT(s), "PrivateNetwork=yes is configured, but the kernel does not support network namespaces, ignoring.");
1585 fd = socket_address_listen_do(s, address, label);
1586 if (fd < 0) {
1587 log_address_error_errno(UNIT(s), address, fd, "Failed to create listening socket (%s): %m");
1588 _exit(EXIT_FAILURE);
1591 r = send_one_fd(pair[1], fd, 0);
1592 if (r < 0) {
1593 log_address_error_errno(UNIT(s), address, r, "Failed to send listening socket (%s) to parent: %m");
1594 _exit(EXIT_FAILURE);
1597 _exit(EXIT_SUCCESS);
1600 pair[1] = safe_close(pair[1]);
1601 fd = receive_one_fd(pair[0], 0);
1603 /* We synchronously wait for the helper, as it shouldn't be slow */
1604 r = wait_for_terminate_and_check("(sd-listen)", pid, WAIT_LOG_ABNORMAL);
1605 if (r < 0) {
1606 safe_close(fd);
1607 return r;
1610 if (fd < 0)
1611 return log_address_error_errno(UNIT(s), address, fd, "Failed to receive listening socket (%s): %m");
1613 return fd;
1616 DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(Socket *, socket_close_fds, NULL);
1618 static int socket_open_fds(Socket *orig_s) {
1619 _cleanup_(socket_close_fdsp) Socket *s = orig_s;
1620 _cleanup_(mac_selinux_freep) char *label = NULL;
1621 bool know_label = false;
1622 int r;
1624 assert(s);
1626 LIST_FOREACH(port, p, s->ports) {
1628 if (p->fd >= 0)
1629 continue;
1631 switch (p->type) {
1633 case SOCKET_SOCKET:
1635 if (!know_label) {
1636 /* Figure out the label, if we don't it know yet. We do it once for the first
1637 * socket where we need this and remember it for the rest. */
1639 r = socket_determine_selinux_label(s, &label);
1640 if (r < 0)
1641 return log_unit_error_errno(UNIT(s), r, "Failed to determine SELinux label: %m");
1643 know_label = true;
1646 /* Apply the socket protocol */
1647 switch (p->address.type) {
1649 case SOCK_STREAM:
1650 case SOCK_SEQPACKET:
1651 if (s->socket_protocol == IPPROTO_SCTP)
1652 p->address.protocol = s->socket_protocol;
1653 break;
1655 case SOCK_DGRAM:
1656 if (s->socket_protocol == IPPROTO_UDPLITE)
1657 p->address.protocol = s->socket_protocol;
1658 break;
1661 p->fd = socket_address_listen_in_cgroup(s, &p->address, label);
1662 if (p->fd < 0)
1663 return p->fd;
1665 socket_apply_socket_options(s, p, p->fd);
1666 socket_symlink(s);
1667 break;
1669 case SOCKET_SPECIAL:
1671 p->fd = special_address_create(p->path, s->writable);
1672 if (p->fd < 0)
1673 return log_unit_error_errno(UNIT(s), p->fd, "Failed to open special file %s: %m", p->path);
1674 break;
1676 case SOCKET_FIFO:
1678 p->fd = fifo_address_create(
1679 p->path,
1680 s->directory_mode,
1681 s->socket_mode);
1682 if (p->fd < 0)
1683 return log_unit_error_errno(UNIT(s), p->fd, "Failed to open FIFO %s: %m", p->path);
1685 socket_apply_fifo_options(s, p->fd);
1686 socket_symlink(s);
1687 break;
1689 case SOCKET_MQUEUE:
1691 p->fd = mq_address_create(
1692 p->path,
1693 s->socket_mode,
1694 s->mq_maxmsg,
1695 s->mq_msgsize);
1696 if (p->fd < 0)
1697 return log_unit_error_errno(UNIT(s), p->fd, "Failed to open message queue %s: %m", p->path);
1698 break;
1700 case SOCKET_USB_FUNCTION: {
1701 _cleanup_free_ char *ep = NULL;
1703 ep = path_make_absolute("ep0", p->path);
1704 if (!ep)
1705 return -ENOMEM;
1707 p->fd = usbffs_address_create(ep);
1708 if (p->fd < 0)
1709 return p->fd;
1711 r = usbffs_write_descs(p->fd, SERVICE(UNIT_DEREF(s->service)));
1712 if (r < 0)
1713 return r;
1715 r = usbffs_dispatch_eps(p);
1716 if (r < 0)
1717 return r;
1719 break;
1721 default:
1722 assert_not_reached();
1726 s = NULL;
1727 return 0;
1730 static void socket_unwatch_fds(Socket *s) {
1731 int r;
1733 assert(s);
1735 LIST_FOREACH(port, p, s->ports) {
1736 if (p->fd < 0)
1737 continue;
1739 if (!p->event_source)
1740 continue;
1742 r = sd_event_source_set_enabled(p->event_source, SD_EVENT_OFF);
1743 if (r < 0)
1744 log_unit_debug_errno(UNIT(s), r, "Failed to disable event source: %m");
1748 static int socket_watch_fds(Socket *s) {
1749 int r;
1751 assert(s);
1753 LIST_FOREACH(port, p, s->ports) {
1754 if (p->fd < 0)
1755 continue;
1757 if (p->event_source) {
1758 r = sd_event_source_set_enabled(p->event_source, SD_EVENT_ON);
1759 if (r < 0)
1760 goto fail;
1761 } else {
1762 r = sd_event_add_io(UNIT(s)->manager->event, &p->event_source, p->fd, EPOLLIN, socket_dispatch_io, p);
1763 if (r < 0)
1764 goto fail;
1766 (void) sd_event_source_set_description(p->event_source, "socket-port-io");
1770 return 0;
1772 fail:
1773 log_unit_warning_errno(UNIT(s), r, "Failed to watch listening fds: %m");
1774 socket_unwatch_fds(s);
1775 return r;
1778 enum {
1779 SOCKET_OPEN_NONE,
1780 SOCKET_OPEN_SOME,
1781 SOCKET_OPEN_ALL,
1784 static int socket_check_open(Socket *s) {
1785 bool have_open = false, have_closed = false;
1787 assert(s);
1789 LIST_FOREACH(port, p, s->ports) {
1790 if (p->fd < 0)
1791 have_closed = true;
1792 else
1793 have_open = true;
1795 if (have_open && have_closed)
1796 return SOCKET_OPEN_SOME;
1799 if (have_open)
1800 return SOCKET_OPEN_ALL;
1802 return SOCKET_OPEN_NONE;
1805 static void socket_set_state(Socket *s, SocketState state) {
1806 SocketState old_state;
1807 assert(s);
1809 if (s->state != state)
1810 bus_unit_send_pending_change_signal(UNIT(s), false);
1812 old_state = s->state;
1813 s->state = state;
1815 if (!IN_SET(state,
1816 SOCKET_START_PRE,
1817 SOCKET_START_CHOWN,
1818 SOCKET_START_POST,
1819 SOCKET_STOP_PRE,
1820 SOCKET_STOP_PRE_SIGTERM,
1821 SOCKET_STOP_PRE_SIGKILL,
1822 SOCKET_STOP_POST,
1823 SOCKET_FINAL_SIGTERM,
1824 SOCKET_FINAL_SIGKILL,
1825 SOCKET_CLEANING)) {
1827 s->timer_event_source = sd_event_source_disable_unref(s->timer_event_source);
1828 socket_unwatch_control_pid(s);
1829 s->control_command = NULL;
1830 s->control_command_id = _SOCKET_EXEC_COMMAND_INVALID;
1833 if (state != SOCKET_LISTENING)
1834 socket_unwatch_fds(s);
1836 if (!IN_SET(state,
1837 SOCKET_START_CHOWN,
1838 SOCKET_START_POST,
1839 SOCKET_LISTENING,
1840 SOCKET_RUNNING,
1841 SOCKET_STOP_PRE,
1842 SOCKET_STOP_PRE_SIGTERM,
1843 SOCKET_STOP_PRE_SIGKILL,
1844 SOCKET_CLEANING))
1845 socket_close_fds(s);
1847 if (state != old_state)
1848 log_unit_debug(UNIT(s), "Changed %s -> %s", socket_state_to_string(old_state), socket_state_to_string(state));
1850 unit_notify(UNIT(s), state_translation_table[old_state], state_translation_table[state], /* reload_success = */ true);
1853 static int socket_coldplug(Unit *u) {
1854 Socket *s = SOCKET(u);
1855 int r;
1857 assert(s);
1858 assert(s->state == SOCKET_DEAD);
1860 if (s->deserialized_state == s->state)
1861 return 0;
1863 if (s->control_pid > 0 &&
1864 pid_is_unwaited(s->control_pid) &&
1865 IN_SET(s->deserialized_state,
1866 SOCKET_START_PRE,
1867 SOCKET_START_CHOWN,
1868 SOCKET_START_POST,
1869 SOCKET_STOP_PRE,
1870 SOCKET_STOP_PRE_SIGTERM,
1871 SOCKET_STOP_PRE_SIGKILL,
1872 SOCKET_STOP_POST,
1873 SOCKET_FINAL_SIGTERM,
1874 SOCKET_FINAL_SIGKILL,
1875 SOCKET_CLEANING)) {
1877 r = unit_watch_pid(UNIT(s), s->control_pid, false);
1878 if (r < 0)
1879 return r;
1881 r = socket_arm_timer(s, usec_add(u->state_change_timestamp.monotonic, s->timeout_usec));
1882 if (r < 0)
1883 return r;
1886 if (IN_SET(s->deserialized_state,
1887 SOCKET_START_CHOWN,
1888 SOCKET_START_POST,
1889 SOCKET_LISTENING,
1890 SOCKET_RUNNING)) {
1892 /* Originally, we used to simply reopen all sockets here that we didn't have file descriptors
1893 * for. However, this is problematic, as we won't traverse through the SOCKET_START_CHOWN state for
1894 * them, and thus the UID/GID wouldn't be right. Hence, instead simply check if we have all fds open,
1895 * and if there's a mismatch, warn loudly. */
1897 r = socket_check_open(s);
1898 if (r == SOCKET_OPEN_NONE)
1899 log_unit_warning(UNIT(s),
1900 "Socket unit configuration has changed while unit has been running, "
1901 "no open socket file descriptor left. "
1902 "The socket unit is not functional until restarted.");
1903 else if (r == SOCKET_OPEN_SOME)
1904 log_unit_warning(UNIT(s),
1905 "Socket unit configuration has changed while unit has been running, "
1906 "and some socket file descriptors have not been opened yet. "
1907 "The socket unit is not fully functional until restarted.");
1910 if (s->deserialized_state == SOCKET_LISTENING) {
1911 r = socket_watch_fds(s);
1912 if (r < 0)
1913 return r;
1916 if (!IN_SET(s->deserialized_state, SOCKET_DEAD, SOCKET_FAILED, SOCKET_CLEANING))
1917 (void) unit_setup_exec_runtime(u);
1919 socket_set_state(s, s->deserialized_state);
1920 return 0;
1923 static int socket_spawn(Socket *s, ExecCommand *c, pid_t *_pid) {
1925 _cleanup_(exec_params_clear) ExecParameters exec_params = {
1926 .flags = EXEC_APPLY_SANDBOXING|EXEC_APPLY_CHROOT|EXEC_APPLY_TTY_STDIN,
1927 .stdin_fd = -EBADF,
1928 .stdout_fd = -EBADF,
1929 .stderr_fd = -EBADF,
1930 .exec_fd = -EBADF,
1932 pid_t pid;
1933 int r;
1935 assert(s);
1936 assert(c);
1937 assert(_pid);
1939 r = unit_prepare_exec(UNIT(s));
1940 if (r < 0)
1941 return r;
1943 r = socket_arm_timer(s, usec_add(now(CLOCK_MONOTONIC), s->timeout_usec));
1944 if (r < 0)
1945 return r;
1947 r = unit_set_exec_params(UNIT(s), &exec_params);
1948 if (r < 0)
1949 return r;
1951 r = exec_spawn(UNIT(s),
1953 &s->exec_context,
1954 &exec_params,
1955 s->exec_runtime,
1956 &s->cgroup_context,
1957 &pid);
1958 if (r < 0)
1959 return r;
1961 r = unit_watch_pid(UNIT(s), pid, true);
1962 if (r < 0)
1963 return r;
1965 *_pid = pid;
1967 return 0;
1970 static int socket_chown(Socket *s, pid_t *_pid) {
1971 pid_t pid;
1972 int r;
1974 r = socket_arm_timer(s, usec_add(now(CLOCK_MONOTONIC), s->timeout_usec));
1975 if (r < 0)
1976 goto fail;
1978 /* We have to resolve the user names out-of-process, hence
1979 * let's fork here. It's messy, but well, what can we do? */
1981 r = unit_fork_helper_process(UNIT(s), "(sd-chown)", &pid);
1982 if (r < 0)
1983 return r;
1984 if (r == 0) {
1985 uid_t uid = UID_INVALID;
1986 gid_t gid = GID_INVALID;
1988 /* Child */
1990 if (!isempty(s->user)) {
1991 const char *user = s->user;
1993 r = get_user_creds(&user, &uid, &gid, NULL, NULL, 0);
1994 if (r < 0) {
1995 log_unit_error_errno(UNIT(s), r, "Failed to resolve user %s: %m", user);
1996 _exit(EXIT_USER);
2000 if (!isempty(s->group)) {
2001 const char *group = s->group;
2003 r = get_group_creds(&group, &gid, 0);
2004 if (r < 0) {
2005 log_unit_error_errno(UNIT(s), r, "Failed to resolve group %s: %m", group);
2006 _exit(EXIT_GROUP);
2010 LIST_FOREACH(port, p, s->ports) {
2011 const char *path = NULL;
2013 if (p->type == SOCKET_SOCKET)
2014 path = socket_address_get_path(&p->address);
2015 else if (p->type == SOCKET_FIFO)
2016 path = p->path;
2018 if (!path)
2019 continue;
2021 if (chown(path, uid, gid) < 0) {
2022 log_unit_error_errno(UNIT(s), errno, "Failed to chown(): %m");
2023 _exit(EXIT_CHOWN);
2027 _exit(EXIT_SUCCESS);
2030 r = unit_watch_pid(UNIT(s), pid, true);
2031 if (r < 0)
2032 goto fail;
2034 *_pid = pid;
2035 return 0;
2037 fail:
2038 s->timer_event_source = sd_event_source_disable_unref(s->timer_event_source);
2039 return r;
2042 static void socket_enter_dead(Socket *s, SocketResult f) {
2043 assert(s);
2045 if (s->result == SOCKET_SUCCESS)
2046 s->result = f;
2048 if (s->result == SOCKET_SUCCESS)
2049 unit_log_success(UNIT(s));
2050 else
2051 unit_log_failure(UNIT(s), socket_result_to_string(s->result));
2053 unit_warn_leftover_processes(UNIT(s), unit_log_leftover_process_stop);
2055 socket_set_state(s, s->result != SOCKET_SUCCESS ? SOCKET_FAILED : SOCKET_DEAD);
2057 s->exec_runtime = exec_runtime_destroy(s->exec_runtime);
2059 unit_destroy_runtime_data(UNIT(s), &s->exec_context);
2061 unit_unref_uid_gid(UNIT(s), true);
2064 static void socket_enter_signal(Socket *s, SocketState state, SocketResult f);
2066 static void socket_enter_stop_post(Socket *s, SocketResult f) {
2067 int r;
2068 assert(s);
2070 if (s->result == SOCKET_SUCCESS)
2071 s->result = f;
2073 socket_unwatch_control_pid(s);
2074 s->control_command_id = SOCKET_EXEC_STOP_POST;
2075 s->control_command = s->exec_command[SOCKET_EXEC_STOP_POST];
2077 if (s->control_command) {
2078 r = socket_spawn(s, s->control_command, &s->control_pid);
2079 if (r < 0)
2080 goto fail;
2082 socket_set_state(s, SOCKET_STOP_POST);
2083 } else
2084 socket_enter_signal(s, SOCKET_FINAL_SIGTERM, SOCKET_SUCCESS);
2086 return;
2088 fail:
2089 log_unit_warning_errno(UNIT(s), r, "Failed to run 'stop-post' task: %m");
2090 socket_enter_signal(s, SOCKET_FINAL_SIGTERM, SOCKET_FAILURE_RESOURCES);
2093 static int state_to_kill_operation(Socket *s, SocketState state) {
2094 if (state == SOCKET_STOP_PRE_SIGTERM && unit_has_job_type(UNIT(s), JOB_RESTART))
2095 return KILL_RESTART;
2097 if (state == SOCKET_FINAL_SIGTERM)
2098 return KILL_TERMINATE;
2100 return KILL_KILL;
2103 static void socket_enter_signal(Socket *s, SocketState state, SocketResult f) {
2104 int r;
2106 assert(s);
2108 if (s->result == SOCKET_SUCCESS)
2109 s->result = f;
2111 r = unit_kill_context(
2112 UNIT(s),
2113 &s->kill_context,
2114 state_to_kill_operation(s, state),
2116 s->control_pid,
2117 false);
2118 if (r < 0)
2119 goto fail;
2121 if (r > 0) {
2122 r = socket_arm_timer(s, usec_add(now(CLOCK_MONOTONIC), s->timeout_usec));
2123 if (r < 0)
2124 goto fail;
2126 socket_set_state(s, state);
2127 } else if (state == SOCKET_STOP_PRE_SIGTERM)
2128 socket_enter_signal(s, SOCKET_STOP_PRE_SIGKILL, SOCKET_SUCCESS);
2129 else if (state == SOCKET_STOP_PRE_SIGKILL)
2130 socket_enter_stop_post(s, SOCKET_SUCCESS);
2131 else if (state == SOCKET_FINAL_SIGTERM)
2132 socket_enter_signal(s, SOCKET_FINAL_SIGKILL, SOCKET_SUCCESS);
2133 else
2134 socket_enter_dead(s, SOCKET_SUCCESS);
2136 return;
2138 fail:
2139 log_unit_warning_errno(UNIT(s), r, "Failed to kill processes: %m");
2141 if (IN_SET(state, SOCKET_STOP_PRE_SIGTERM, SOCKET_STOP_PRE_SIGKILL))
2142 socket_enter_stop_post(s, SOCKET_FAILURE_RESOURCES);
2143 else
2144 socket_enter_dead(s, SOCKET_FAILURE_RESOURCES);
2147 static void socket_enter_stop_pre(Socket *s, SocketResult f) {
2148 int r;
2149 assert(s);
2151 if (s->result == SOCKET_SUCCESS)
2152 s->result = f;
2154 socket_unwatch_control_pid(s);
2155 s->control_command_id = SOCKET_EXEC_STOP_PRE;
2156 s->control_command = s->exec_command[SOCKET_EXEC_STOP_PRE];
2158 if (s->control_command) {
2159 r = socket_spawn(s, s->control_command, &s->control_pid);
2160 if (r < 0)
2161 goto fail;
2163 socket_set_state(s, SOCKET_STOP_PRE);
2164 } else
2165 socket_enter_stop_post(s, SOCKET_SUCCESS);
2167 return;
2169 fail:
2170 log_unit_warning_errno(UNIT(s), r, "Failed to run 'stop-pre' task: %m");
2171 socket_enter_stop_post(s, SOCKET_FAILURE_RESOURCES);
2174 static void socket_enter_listening(Socket *s) {
2175 int r;
2176 assert(s);
2178 if (!s->accept && s->flush_pending) {
2179 log_unit_debug(UNIT(s), "Flushing socket before listening.");
2180 flush_ports(s);
2183 r = socket_watch_fds(s);
2184 if (r < 0) {
2185 log_unit_warning_errno(UNIT(s), r, "Failed to watch sockets: %m");
2186 goto fail;
2189 socket_set_state(s, SOCKET_LISTENING);
2190 return;
2192 fail:
2193 socket_enter_stop_pre(s, SOCKET_FAILURE_RESOURCES);
2196 static void socket_enter_start_post(Socket *s) {
2197 int r;
2198 assert(s);
2200 socket_unwatch_control_pid(s);
2201 s->control_command_id = SOCKET_EXEC_START_POST;
2202 s->control_command = s->exec_command[SOCKET_EXEC_START_POST];
2204 if (s->control_command) {
2205 r = socket_spawn(s, s->control_command, &s->control_pid);
2206 if (r < 0) {
2207 log_unit_warning_errno(UNIT(s), r, "Failed to run 'start-post' task: %m");
2208 goto fail;
2211 socket_set_state(s, SOCKET_START_POST);
2212 } else
2213 socket_enter_listening(s);
2215 return;
2217 fail:
2218 socket_enter_stop_pre(s, SOCKET_FAILURE_RESOURCES);
2221 static void socket_enter_start_chown(Socket *s) {
2222 int r;
2224 assert(s);
2226 r = socket_open_fds(s);
2227 if (r < 0) {
2228 log_unit_warning_errno(UNIT(s), r, "Failed to listen on sockets: %m");
2229 goto fail;
2232 if (!isempty(s->user) || !isempty(s->group)) {
2234 socket_unwatch_control_pid(s);
2235 s->control_command_id = SOCKET_EXEC_START_CHOWN;
2236 s->control_command = NULL;
2238 r = socket_chown(s, &s->control_pid);
2239 if (r < 0) {
2240 log_unit_warning_errno(UNIT(s), r, "Failed to fork 'start-chown' task: %m");
2241 goto fail;
2244 socket_set_state(s, SOCKET_START_CHOWN);
2245 } else
2246 socket_enter_start_post(s);
2248 return;
2250 fail:
2251 socket_enter_stop_pre(s, SOCKET_FAILURE_RESOURCES);
2254 static void socket_enter_start_pre(Socket *s) {
2255 int r;
2256 assert(s);
2258 socket_unwatch_control_pid(s);
2260 unit_warn_leftover_processes(UNIT(s), unit_log_leftover_process_start);
2262 s->control_command_id = SOCKET_EXEC_START_PRE;
2263 s->control_command = s->exec_command[SOCKET_EXEC_START_PRE];
2265 if (s->control_command) {
2266 r = socket_spawn(s, s->control_command, &s->control_pid);
2267 if (r < 0) {
2268 log_unit_warning_errno(UNIT(s), r, "Failed to run 'start-pre' task: %m");
2269 goto fail;
2272 socket_set_state(s, SOCKET_START_PRE);
2273 } else
2274 socket_enter_start_chown(s);
2276 return;
2278 fail:
2279 socket_enter_dead(s, SOCKET_FAILURE_RESOURCES);
2282 static void flush_ports(Socket *s) {
2283 assert(s);
2285 /* Flush all incoming traffic, regardless if actual bytes or new connections, so that this socket isn't busy
2286 * anymore */
2288 LIST_FOREACH(port, p, s->ports) {
2289 if (p->fd < 0)
2290 continue;
2292 (void) flush_accept(p->fd);
2293 (void) flush_fd(p->fd);
2297 static void socket_enter_running(Socket *s, int cfd_in) {
2298 /* Note that this call takes possession of the connection fd passed. It either has to assign it
2299 * somewhere or close it. */
2300 _cleanup_close_ int cfd = cfd_in;
2302 _cleanup_(sd_bus_error_free) sd_bus_error error = SD_BUS_ERROR_NULL;
2303 int r;
2305 assert(s);
2307 /* We don't take connections anymore if we are supposed to shut down anyway */
2308 if (unit_stop_pending(UNIT(s))) {
2310 log_unit_debug(UNIT(s), "Suppressing connection request since unit stop is scheduled.");
2312 if (cfd >= 0)
2313 goto refuse;
2315 flush_ports(s);
2316 return;
2319 if (!ratelimit_below(&s->trigger_limit)) {
2320 log_unit_warning(UNIT(s), "Trigger limit hit, refusing further activation.");
2321 socket_enter_stop_pre(s, SOCKET_FAILURE_TRIGGER_LIMIT_HIT);
2322 goto refuse;
2325 if (cfd < 0) {
2326 bool pending = false;
2327 Unit *other;
2329 /* If there's already a start pending don't bother to do anything */
2330 UNIT_FOREACH_DEPENDENCY(other, UNIT(s), UNIT_ATOM_TRIGGERS)
2331 if (unit_active_or_pending(other)) {
2332 pending = true;
2333 break;
2336 if (!pending) {
2337 if (!UNIT_ISSET(s->service)) {
2338 r = log_unit_error_errno(UNIT(s), SYNTHETIC_ERRNO(ENOENT),
2339 "Service to activate vanished, refusing activation.");
2340 goto fail;
2343 r = manager_add_job(UNIT(s)->manager, JOB_START, UNIT_DEREF(s->service), JOB_REPLACE, NULL, &error, NULL);
2344 if (r < 0)
2345 goto fail;
2348 socket_set_state(s, SOCKET_RUNNING);
2349 } else {
2350 _cleanup_(socket_peer_unrefp) SocketPeer *p = NULL;
2351 Unit *service;
2353 if (s->n_connections >= s->max_connections) {
2354 log_unit_warning(UNIT(s), "Too many incoming connections (%u), dropping connection.",
2355 s->n_connections);
2356 goto refuse;
2359 if (s->max_connections_per_source > 0) {
2360 r = socket_acquire_peer(s, cfd, &p);
2361 if (r < 0) {
2362 if (ERRNO_IS_DISCONNECT(r))
2363 return;
2364 /* We didn't have enough resources to acquire peer information, let's fail. */
2365 goto fail;
2367 if (r > 0 && p->n_ref > s->max_connections_per_source) {
2368 _cleanup_free_ char *t = NULL;
2370 (void) sockaddr_pretty(&p->peer.sa, p->peer_salen, true, false, &t);
2372 log_unit_warning(UNIT(s),
2373 "Too many incoming connections (%u) from source %s, dropping connection.",
2374 p->n_ref, strnull(t));
2375 goto refuse;
2379 r = socket_load_service_unit(s, cfd, &service);
2380 if (ERRNO_IS_DISCONNECT(r))
2381 return;
2382 if (r < 0)
2383 goto fail;
2385 r = unit_add_two_dependencies(UNIT(s), UNIT_BEFORE, UNIT_TRIGGERS, service,
2386 false, UNIT_DEPENDENCY_IMPLICIT);
2387 if (r < 0)
2388 goto fail;
2390 s->n_accepted++;
2392 r = service_set_socket_fd(SERVICE(service), cfd, s, p, s->selinux_context_from_net);
2393 if (ERRNO_IS_DISCONNECT(r))
2394 return;
2395 if (r < 0)
2396 goto fail;
2398 TAKE_FD(cfd); /* We passed ownership of the fd to the service now. Forget it here. */
2399 s->n_connections++;
2401 r = manager_add_job(UNIT(s)->manager, JOB_START, service, JOB_REPLACE, NULL, &error, NULL);
2402 if (r < 0) {
2403 /* We failed to activate the new service, but it still exists. Let's make sure the
2404 * service closes and forgets the connection fd again, immediately. */
2405 service_release_socket_fd(SERVICE(service));
2406 goto fail;
2409 /* Notify clients about changed counters */
2410 unit_add_to_dbus_queue(UNIT(s));
2413 TAKE_FD(cfd);
2414 return;
2416 refuse:
2417 s->n_refused++;
2418 return;
2420 fail:
2421 if (ERRNO_IS_RESOURCE(r))
2422 log_unit_warning(UNIT(s), "Failed to queue service startup job: %s",
2423 bus_error_message(&error, r));
2424 else
2425 log_unit_warning(UNIT(s), "Failed to queue service startup job (Maybe the service file is missing or not a %s unit?): %s",
2426 cfd >= 0 ? "template" : "non-template",
2427 bus_error_message(&error, r));
2429 socket_enter_stop_pre(s, SOCKET_FAILURE_RESOURCES);
2432 static void socket_run_next(Socket *s) {
2433 int r;
2435 assert(s);
2436 assert(s->control_command);
2437 assert(s->control_command->command_next);
2439 socket_unwatch_control_pid(s);
2441 s->control_command = s->control_command->command_next;
2443 r = socket_spawn(s, s->control_command, &s->control_pid);
2444 if (r < 0)
2445 goto fail;
2447 return;
2449 fail:
2450 log_unit_warning_errno(UNIT(s), r, "Failed to run next task: %m");
2452 if (s->state == SOCKET_START_POST)
2453 socket_enter_stop_pre(s, SOCKET_FAILURE_RESOURCES);
2454 else if (s->state == SOCKET_STOP_POST)
2455 socket_enter_dead(s, SOCKET_FAILURE_RESOURCES);
2456 else
2457 socket_enter_signal(s, SOCKET_FINAL_SIGTERM, SOCKET_FAILURE_RESOURCES);
2460 static int socket_start(Unit *u) {
2461 Socket *s = SOCKET(u);
2462 int r;
2464 assert(s);
2466 /* We cannot fulfill this request right now, try again later
2467 * please! */
2468 if (IN_SET(s->state,
2469 SOCKET_STOP_PRE,
2470 SOCKET_STOP_PRE_SIGKILL,
2471 SOCKET_STOP_PRE_SIGTERM,
2472 SOCKET_STOP_POST,
2473 SOCKET_FINAL_SIGTERM,
2474 SOCKET_FINAL_SIGKILL,
2475 SOCKET_CLEANING))
2476 return -EAGAIN;
2478 /* Already on it! */
2479 if (IN_SET(s->state,
2480 SOCKET_START_PRE,
2481 SOCKET_START_CHOWN,
2482 SOCKET_START_POST))
2483 return 0;
2485 /* Cannot run this without the service being around */
2486 if (UNIT_ISSET(s->service)) {
2487 Service *service;
2489 service = SERVICE(UNIT_DEREF(s->service));
2491 if (UNIT(service)->load_state != UNIT_LOADED)
2492 return log_unit_error_errno(u, SYNTHETIC_ERRNO(ENOENT),
2493 "Socket service %s not loaded, refusing.", UNIT(service)->id);
2495 /* If the service is already active we cannot start the
2496 * socket */
2497 if (!IN_SET(service->state,
2498 SERVICE_DEAD, SERVICE_DEAD_BEFORE_AUTO_RESTART, SERVICE_FAILED, SERVICE_FAILED_BEFORE_AUTO_RESTART,
2499 SERVICE_AUTO_RESTART, SERVICE_AUTO_RESTART_QUEUED))
2500 return log_unit_error_errno(u, SYNTHETIC_ERRNO(EBUSY),
2501 "Socket service %s already active, refusing.", UNIT(service)->id);
2504 assert(IN_SET(s->state, SOCKET_DEAD, SOCKET_FAILED));
2506 r = unit_acquire_invocation_id(u);
2507 if (r < 0)
2508 return r;
2510 s->result = SOCKET_SUCCESS;
2511 exec_command_reset_status_list_array(s->exec_command, _SOCKET_EXEC_COMMAND_MAX);
2513 u->reset_accounting = true;
2515 socket_enter_start_pre(s);
2516 return 1;
2519 static int socket_stop(Unit *u) {
2520 Socket *s = SOCKET(u);
2522 assert(s);
2524 /* Already on it */
2525 if (IN_SET(s->state,
2526 SOCKET_STOP_PRE,
2527 SOCKET_STOP_PRE_SIGTERM,
2528 SOCKET_STOP_PRE_SIGKILL,
2529 SOCKET_STOP_POST,
2530 SOCKET_FINAL_SIGTERM,
2531 SOCKET_FINAL_SIGKILL))
2532 return 0;
2534 /* If there's already something running we go directly into
2535 * kill mode. */
2536 if (IN_SET(s->state,
2537 SOCKET_START_PRE,
2538 SOCKET_START_CHOWN,
2539 SOCKET_START_POST)) {
2540 socket_enter_signal(s, SOCKET_STOP_PRE_SIGTERM, SOCKET_SUCCESS);
2541 return -EAGAIN;
2544 /* If we are currently cleaning, then abort it, brutally. */
2545 if (s->state == SOCKET_CLEANING) {
2546 socket_enter_signal(s, SOCKET_FINAL_SIGKILL, SOCKET_SUCCESS);
2547 return 0;
2550 assert(IN_SET(s->state, SOCKET_LISTENING, SOCKET_RUNNING));
2552 socket_enter_stop_pre(s, SOCKET_SUCCESS);
2553 return 1;
2556 static int socket_serialize(Unit *u, FILE *f, FDSet *fds) {
2557 Socket *s = SOCKET(u);
2558 int r;
2560 assert(u);
2561 assert(f);
2562 assert(fds);
2564 (void) serialize_item(f, "state", socket_state_to_string(s->state));
2565 (void) serialize_item(f, "result", socket_result_to_string(s->result));
2566 (void) serialize_item_format(f, "n-accepted", "%u", s->n_accepted);
2567 (void) serialize_item_format(f, "n-refused", "%u", s->n_refused);
2569 if (s->control_pid > 0)
2570 (void) serialize_item_format(f, "control-pid", PID_FMT, s->control_pid);
2572 if (s->control_command_id >= 0)
2573 (void) serialize_item(f, "control-command", socket_exec_command_to_string(s->control_command_id));
2575 LIST_FOREACH(port, p, s->ports) {
2576 int copy;
2578 if (p->fd < 0)
2579 continue;
2581 copy = fdset_put_dup(fds, p->fd);
2582 if (copy < 0)
2583 return log_unit_warning_errno(u, copy, "Failed to serialize socket fd: %m");
2585 if (p->type == SOCKET_SOCKET) {
2586 _cleanup_free_ char *t = NULL;
2588 r = socket_address_print(&p->address, &t);
2589 if (r < 0)
2590 return log_unit_error_errno(u, r, "Failed to format socket address: %m");
2592 if (socket_address_family(&p->address) == AF_NETLINK)
2593 (void) serialize_item_format(f, "netlink", "%i %s", copy, t);
2594 else
2595 (void) serialize_item_format(f, "socket", "%i %i %s", copy, p->address.type, t);
2596 } else if (p->type == SOCKET_SPECIAL)
2597 (void) serialize_item_format(f, "special", "%i %s", copy, p->path);
2598 else if (p->type == SOCKET_MQUEUE)
2599 (void) serialize_item_format(f, "mqueue", "%i %s", copy, p->path);
2600 else if (p->type == SOCKET_USB_FUNCTION)
2601 (void) serialize_item_format(f, "ffs", "%i %s", copy, p->path);
2602 else {
2603 assert(p->type == SOCKET_FIFO);
2604 (void) serialize_item_format(f, "fifo", "%i %s", copy, p->path);
2608 return 0;
2611 static int socket_deserialize_item(Unit *u, const char *key, const char *value, FDSet *fds) {
2612 Socket *s = SOCKET(u);
2613 int r;
2615 assert(u);
2616 assert(key);
2617 assert(value);
2619 if (streq(key, "state")) {
2620 SocketState state;
2622 state = socket_state_from_string(value);
2623 if (state < 0)
2624 log_unit_debug(u, "Failed to parse state value: %s", value);
2625 else
2626 s->deserialized_state = state;
2627 } else if (streq(key, "result")) {
2628 SocketResult f;
2630 f = socket_result_from_string(value);
2631 if (f < 0)
2632 log_unit_debug(u, "Failed to parse result value: %s", value);
2633 else if (f != SOCKET_SUCCESS)
2634 s->result = f;
2636 } else if (streq(key, "n-accepted")) {
2637 unsigned k;
2639 if (safe_atou(value, &k) < 0)
2640 log_unit_debug(u, "Failed to parse n-accepted value: %s", value);
2641 else
2642 s->n_accepted += k;
2643 } else if (streq(key, "n-refused")) {
2644 unsigned k;
2646 if (safe_atou(value, &k) < 0)
2647 log_unit_debug(u, "Failed to parse n-refused value: %s", value);
2648 else
2649 s->n_refused += k;
2650 } else if (streq(key, "control-pid")) {
2651 pid_t pid;
2653 if (parse_pid(value, &pid) < 0)
2654 log_unit_debug(u, "Failed to parse control-pid value: %s", value);
2655 else
2656 s->control_pid = pid;
2657 } else if (streq(key, "control-command")) {
2658 SocketExecCommand id;
2660 id = socket_exec_command_from_string(value);
2661 if (id < 0)
2662 log_unit_debug(u, "Failed to parse exec-command value: %s", value);
2663 else {
2664 s->control_command_id = id;
2665 s->control_command = s->exec_command[id];
2667 } else if (streq(key, "fifo")) {
2668 _cleanup_free_ char *fdv = NULL;
2669 bool found = false;
2670 int fd;
2672 r = extract_first_word(&value, &fdv, NULL, 0);
2673 if (r <= 0) {
2674 log_unit_debug(u, "Failed to parse fifo value: %s", value);
2675 return 0;
2678 fd = parse_fd(fdv);
2679 if (fd < 0 || !fdset_contains(fds, fd)) {
2680 log_unit_debug(u, "Invalid fifo value: %s", fdv);
2681 return 0;
2684 LIST_FOREACH(port, p, s->ports)
2685 if (p->fd < 0 &&
2686 p->type == SOCKET_FIFO &&
2687 path_equal_or_inode_same(p->path, value, 0)) {
2688 p->fd = fdset_remove(fds, fd);
2689 found = true;
2690 break;
2692 if (!found)
2693 log_unit_debug(u, "No matching fifo socket found: %s", value);
2695 } else if (streq(key, "special")) {
2696 _cleanup_free_ char *fdv = NULL;
2697 bool found = false;
2698 int fd;
2700 r = extract_first_word(&value, &fdv, NULL, 0);
2701 if (r <= 0) {
2702 log_unit_debug(u, "Failed to parse special value: %s", value);
2703 return 0;
2706 fd = parse_fd(fdv);
2707 if (fd < 0 || !fdset_contains(fds, fd)) {
2708 log_unit_debug(u, "Invalid special value: %s", fdv);
2709 return 0;
2712 LIST_FOREACH(port, p, s->ports)
2713 if (p->fd < 0 &&
2714 p->type == SOCKET_SPECIAL &&
2715 path_equal_or_inode_same(p->path, value, 0)) {
2716 p->fd = fdset_remove(fds, fd);
2717 found = true;
2718 break;
2720 if (!found)
2721 log_unit_debug(u, "No matching special socket found: %s", value);
2723 } else if (streq(key, "mqueue")) {
2724 _cleanup_free_ char *fdv = NULL;
2725 bool found = false;
2726 int fd;
2728 r = extract_first_word(&value, &fdv, NULL, 0);
2729 if (r <= 0) {
2730 log_unit_debug(u, "Failed to parse mqueue value: %s", value);
2731 return 0;
2734 fd = parse_fd(fdv);
2735 if (fd < 0 || !fdset_contains(fds, fd)) {
2736 log_unit_debug(u, "Invalid mqueue value: %s", fdv);
2737 return 0;
2740 LIST_FOREACH(port, p, s->ports)
2741 if (p->fd < 0 &&
2742 p->type == SOCKET_MQUEUE &&
2743 streq(p->path, value)) {
2744 p->fd = fdset_remove(fds, fd);
2745 found = true;
2746 break;
2748 if (!found)
2749 log_unit_debug(u, "No matching mqueue socket found: %s", value);
2751 } else if (streq(key, "socket")) {
2752 _cleanup_free_ char *fdv = NULL, *typev = NULL;
2753 bool found = false;
2754 int fd, type;
2756 r = extract_first_word(&value, &fdv, NULL, 0);
2757 if (r <= 0) {
2758 log_unit_debug(u, "Failed to parse socket fd from value: %s", value);
2759 return 0;
2762 fd = parse_fd(fdv);
2763 if (fd < 0 || !fdset_contains(fds, fd)) {
2764 log_unit_debug(u, "Invalid socket fd: %s", fdv);
2765 return 0;
2768 r = extract_first_word(&value, &typev, NULL, 0);
2769 if (r <= 0) {
2770 log_unit_debug(u, "Failed to parse socket type from value: %s", value);
2771 return 0;
2774 if (safe_atoi(typev, &type) < 0 || type < 0) {
2775 log_unit_debug(u, "Invalid socket type: %s", typev);
2776 return 0;
2779 LIST_FOREACH(port, p, s->ports)
2780 if (p->fd < 0 &&
2781 socket_address_is(&p->address, value, type)) {
2782 p->fd = fdset_remove(fds, fd);
2783 found = true;
2784 break;
2786 if (!found)
2787 log_unit_debug(u, "No matching %s socket found: %s",
2788 socket_address_type_to_string(type), value);
2790 } else if (streq(key, "netlink")) {
2791 _cleanup_free_ char *fdv = NULL;
2792 bool found = false;
2793 int fd;
2795 r = extract_first_word(&value, &fdv, NULL, 0);
2796 if (r <= 0) {
2797 log_unit_debug(u, "Failed to parse socket value: %s", value);
2798 return 0;
2801 fd = parse_fd(fdv);
2802 if (fd < 0 || !fdset_contains(fds, fd)) {
2803 log_unit_debug(u, "Invalid socket value: %s", fdv);
2804 return 0;
2807 LIST_FOREACH(port, p, s->ports)
2808 if (p->fd < 0 &&
2809 socket_address_is_netlink(&p->address, value)) {
2810 p->fd = fdset_remove(fds, fd);
2811 found = true;
2812 break;
2814 if (!found)
2815 log_unit_debug(u, "No matching netlink socket found: %s", value);
2817 } else if (streq(key, "ffs")) {
2818 _cleanup_free_ char *fdv = NULL;
2819 bool found = false;
2820 int fd;
2822 r = extract_first_word(&value, &fdv, NULL, 0);
2823 if (r <= 0) {
2824 log_unit_debug(u, "Failed to parse ffs value: %s", value);
2825 return 0;
2828 fd = parse_fd(fdv);
2829 if (fd < 0 || !fdset_contains(fds, fd)) {
2830 log_unit_debug(u, "Invalid ffs value: %s", fdv);
2831 return 0;
2834 LIST_FOREACH(port, p, s->ports)
2835 if (p->fd < 0 &&
2836 p->type == SOCKET_USB_FUNCTION &&
2837 path_equal_or_inode_same(p->path, value, 0)) {
2838 p->fd = fdset_remove(fds, fd);
2839 found = true;
2840 break;
2842 if (!found)
2843 log_unit_debug(u, "No matching ffs socket found: %s", value);
2845 } else
2846 log_unit_debug(UNIT(s), "Unknown serialization key: %s", key);
2848 return 0;
2851 static void socket_distribute_fds(Unit *u, FDSet *fds) {
2852 Socket *s = SOCKET(u);
2854 assert(u);
2856 LIST_FOREACH(port, p, s->ports) {
2857 int fd;
2859 if (p->type != SOCKET_SOCKET)
2860 continue;
2862 if (p->fd >= 0)
2863 continue;
2865 FDSET_FOREACH(fd, fds) {
2866 if (socket_address_matches_fd(&p->address, fd)) {
2867 p->fd = fdset_remove(fds, fd);
2868 s->deserialized_state = SOCKET_LISTENING;
2869 break;
2875 _pure_ static UnitActiveState socket_active_state(Unit *u) {
2876 assert(u);
2878 return state_translation_table[SOCKET(u)->state];
2881 _pure_ static const char *socket_sub_state_to_string(Unit *u) {
2882 assert(u);
2884 return socket_state_to_string(SOCKET(u)->state);
2887 const char* socket_port_type_to_string(SocketPort *p) {
2889 assert(p);
2891 switch (p->type) {
2893 case SOCKET_SOCKET:
2895 switch (p->address.type) {
2897 case SOCK_STREAM:
2898 return "Stream";
2900 case SOCK_DGRAM:
2901 return "Datagram";
2903 case SOCK_SEQPACKET:
2904 return "SequentialPacket";
2906 case SOCK_RAW:
2907 if (socket_address_family(&p->address) == AF_NETLINK)
2908 return "Netlink";
2910 _fallthrough_;
2911 default:
2912 return NULL;
2915 case SOCKET_SPECIAL:
2916 return "Special";
2918 case SOCKET_MQUEUE:
2919 return "MessageQueue";
2921 case SOCKET_FIFO:
2922 return "FIFO";
2924 case SOCKET_USB_FUNCTION:
2925 return "USBFunction";
2927 default:
2928 return NULL;
2932 SocketType socket_port_type_from_string(const char *s) {
2933 assert(s);
2935 if (STR_IN_SET(s, "Stream", "Datagram", "SequentialPacket", "Netlink"))
2936 return SOCKET_SOCKET;
2937 else if (streq(s, "Special"))
2938 return SOCKET_SPECIAL;
2939 else if (streq(s, "MessageQueue"))
2940 return SOCKET_MQUEUE;
2941 else if (streq(s, "FIFO"))
2942 return SOCKET_FIFO;
2943 else if (streq(s, "USBFunction"))
2944 return SOCKET_USB_FUNCTION;
2945 else
2946 return _SOCKET_TYPE_INVALID;
2949 _pure_ static bool socket_may_gc(Unit *u) {
2950 Socket *s = SOCKET(u);
2952 assert(u);
2954 return s->n_connections == 0;
2957 static int socket_accept_do(Socket *s, int fd) {
2958 int cfd;
2960 assert(s);
2961 assert(fd >= 0);
2963 cfd = accept4(fd, NULL, NULL, SOCK_NONBLOCK|SOCK_CLOEXEC);
2964 if (cfd < 0)
2965 /* Convert transient network errors into clean and well-defined EAGAIN */
2966 return ERRNO_IS_ACCEPT_AGAIN(errno) ? -EAGAIN : -errno;
2968 return cfd;
2971 static int socket_accept_in_cgroup(Socket *s, SocketPort *p, int fd) {
2972 _cleanup_close_pair_ int pair[2] = PIPE_EBADF;
2973 int cfd, r;
2974 pid_t pid;
2976 assert(s);
2977 assert(p);
2978 assert(fd >= 0);
2980 /* Similar to socket_address_listen_in_cgroup(), but for accept() rather than socket(): make sure that any
2981 * connection socket is also properly associated with the cgroup. */
2983 if (!IN_SET(p->address.sockaddr.sa.sa_family, AF_INET, AF_INET6))
2984 goto shortcut;
2986 r = bpf_firewall_supported();
2987 if (r < 0)
2988 return r;
2989 if (r == BPF_FIREWALL_UNSUPPORTED)
2990 goto shortcut;
2992 if (socketpair(AF_UNIX, SOCK_SEQPACKET|SOCK_CLOEXEC, 0, pair) < 0)
2993 return log_unit_error_errno(UNIT(s), errno, "Failed to create communication channel: %m");
2995 r = unit_fork_helper_process(UNIT(s), "(sd-accept)", &pid);
2996 if (r < 0)
2997 return log_unit_error_errno(UNIT(s), r, "Failed to fork off accept stub process: %m");
2998 if (r == 0) {
2999 /* Child */
3001 pair[0] = safe_close(pair[0]);
3003 cfd = socket_accept_do(s, fd);
3004 if (cfd == -EAGAIN) /* spurious accept() */
3005 _exit(EXIT_SUCCESS);
3006 if (cfd < 0) {
3007 log_unit_error_errno(UNIT(s), cfd, "Failed to accept connection socket: %m");
3008 _exit(EXIT_FAILURE);
3011 r = send_one_fd(pair[1], cfd, 0);
3012 if (r < 0) {
3013 log_unit_error_errno(UNIT(s), r, "Failed to send connection socket to parent: %m");
3014 _exit(EXIT_FAILURE);
3017 _exit(EXIT_SUCCESS);
3020 pair[1] = safe_close(pair[1]);
3021 cfd = receive_one_fd(pair[0], 0);
3023 /* We synchronously wait for the helper, as it shouldn't be slow */
3024 r = wait_for_terminate_and_check("(sd-accept)", pid, WAIT_LOG_ABNORMAL);
3025 if (r < 0) {
3026 safe_close(cfd);
3027 return r;
3030 /* If we received no fd, we got EIO here. If this happens with a process exit code of EXIT_SUCCESS
3031 * this is a spurious accept(), let's convert that back to EAGAIN here. */
3032 if (cfd == -EIO)
3033 return -EAGAIN;
3034 if (cfd < 0)
3035 return log_unit_error_errno(UNIT(s), cfd, "Failed to receive connection socket: %m");
3037 return cfd;
3039 shortcut:
3040 cfd = socket_accept_do(s, fd);
3041 if (cfd == -EAGAIN) /* spurious accept(), skip it silently */
3042 return -EAGAIN;
3043 if (cfd < 0)
3044 return log_unit_error_errno(UNIT(s), cfd, "Failed to accept connection socket: %m");
3046 return cfd;
3049 static int socket_dispatch_io(sd_event_source *source, int fd, uint32_t revents, void *userdata) {
3050 SocketPort *p = ASSERT_PTR(userdata);
3051 int cfd = -EBADF;
3053 assert(fd >= 0);
3055 if (p->socket->state != SOCKET_LISTENING)
3056 return 0;
3058 log_unit_debug(UNIT(p->socket), "Incoming traffic");
3060 if (revents != EPOLLIN) {
3061 if (revents & EPOLLHUP)
3062 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.");
3063 else
3064 log_unit_error(UNIT(p->socket), "Got unexpected poll event (0x%x) on socket.", revents);
3065 goto fail;
3068 if (p->socket->accept &&
3069 p->type == SOCKET_SOCKET &&
3070 socket_address_can_accept(&p->address)) {
3072 cfd = socket_accept_in_cgroup(p->socket, p, fd);
3073 if (cfd == -EAGAIN) /* Spurious accept() */
3074 return 0;
3075 if (cfd < 0)
3076 goto fail;
3078 socket_apply_socket_options(p->socket, p, cfd);
3081 socket_enter_running(p->socket, cfd);
3082 return 0;
3084 fail:
3085 socket_enter_stop_pre(p->socket, SOCKET_FAILURE_RESOURCES);
3086 return 0;
3089 static void socket_sigchld_event(Unit *u, pid_t pid, int code, int status) {
3090 Socket *s = SOCKET(u);
3091 SocketResult f;
3093 assert(s);
3094 assert(pid >= 0);
3096 if (pid != s->control_pid)
3097 return;
3099 s->control_pid = 0;
3101 if (is_clean_exit(code, status, EXIT_CLEAN_COMMAND, NULL))
3102 f = SOCKET_SUCCESS;
3103 else if (code == CLD_EXITED)
3104 f = SOCKET_FAILURE_EXIT_CODE;
3105 else if (code == CLD_KILLED)
3106 f = SOCKET_FAILURE_SIGNAL;
3107 else if (code == CLD_DUMPED)
3108 f = SOCKET_FAILURE_CORE_DUMP;
3109 else
3110 assert_not_reached();
3112 if (s->control_command) {
3113 exec_status_exit(&s->control_command->exec_status, &s->exec_context, pid, code, status);
3115 if (s->control_command->flags & EXEC_COMMAND_IGNORE_FAILURE)
3116 f = SOCKET_SUCCESS;
3119 unit_log_process_exit(
3121 "Control process",
3122 socket_exec_command_to_string(s->control_command_id),
3123 f == SOCKET_SUCCESS,
3124 code, status);
3126 if (s->result == SOCKET_SUCCESS)
3127 s->result = f;
3129 if (s->control_command &&
3130 s->control_command->command_next &&
3131 f == SOCKET_SUCCESS) {
3133 log_unit_debug(u, "Running next command for state %s", socket_state_to_string(s->state));
3134 socket_run_next(s);
3135 } else {
3136 s->control_command = NULL;
3137 s->control_command_id = _SOCKET_EXEC_COMMAND_INVALID;
3139 /* No further commands for this step, so let's figure
3140 * out what to do next */
3142 log_unit_debug(u, "Got final SIGCHLD for state %s", socket_state_to_string(s->state));
3144 switch (s->state) {
3146 case SOCKET_START_PRE:
3147 if (f == SOCKET_SUCCESS)
3148 socket_enter_start_chown(s);
3149 else
3150 socket_enter_signal(s, SOCKET_FINAL_SIGTERM, f);
3151 break;
3153 case SOCKET_START_CHOWN:
3154 if (f == SOCKET_SUCCESS)
3155 socket_enter_start_post(s);
3156 else
3157 socket_enter_stop_pre(s, f);
3158 break;
3160 case SOCKET_START_POST:
3161 if (f == SOCKET_SUCCESS)
3162 socket_enter_listening(s);
3163 else
3164 socket_enter_stop_pre(s, f);
3165 break;
3167 case SOCKET_STOP_PRE:
3168 case SOCKET_STOP_PRE_SIGTERM:
3169 case SOCKET_STOP_PRE_SIGKILL:
3170 socket_enter_stop_post(s, f);
3171 break;
3173 case SOCKET_STOP_POST:
3174 case SOCKET_FINAL_SIGTERM:
3175 case SOCKET_FINAL_SIGKILL:
3176 socket_enter_dead(s, f);
3177 break;
3179 case SOCKET_CLEANING:
3181 if (s->clean_result == SOCKET_SUCCESS)
3182 s->clean_result = f;
3184 socket_enter_dead(s, SOCKET_SUCCESS);
3185 break;
3187 default:
3188 assert_not_reached();
3192 /* Notify clients about changed exit status */
3193 unit_add_to_dbus_queue(u);
3196 static int socket_dispatch_timer(sd_event_source *source, usec_t usec, void *userdata) {
3197 Socket *s = SOCKET(userdata);
3199 assert(s);
3200 assert(s->timer_event_source == source);
3202 switch (s->state) {
3204 case SOCKET_START_PRE:
3205 log_unit_warning(UNIT(s), "Starting timed out. Terminating.");
3206 socket_enter_signal(s, SOCKET_FINAL_SIGTERM, SOCKET_FAILURE_TIMEOUT);
3207 break;
3209 case SOCKET_START_CHOWN:
3210 case SOCKET_START_POST:
3211 log_unit_warning(UNIT(s), "Starting timed out. Stopping.");
3212 socket_enter_stop_pre(s, SOCKET_FAILURE_TIMEOUT);
3213 break;
3215 case SOCKET_STOP_PRE:
3216 log_unit_warning(UNIT(s), "Stopping timed out. Terminating.");
3217 socket_enter_signal(s, SOCKET_STOP_PRE_SIGTERM, SOCKET_FAILURE_TIMEOUT);
3218 break;
3220 case SOCKET_STOP_PRE_SIGTERM:
3221 if (s->kill_context.send_sigkill) {
3222 log_unit_warning(UNIT(s), "Stopping timed out. Killing.");
3223 socket_enter_signal(s, SOCKET_STOP_PRE_SIGKILL, SOCKET_FAILURE_TIMEOUT);
3224 } else {
3225 log_unit_warning(UNIT(s), "Stopping timed out. Skipping SIGKILL. Ignoring.");
3226 socket_enter_stop_post(s, SOCKET_FAILURE_TIMEOUT);
3228 break;
3230 case SOCKET_STOP_PRE_SIGKILL:
3231 log_unit_warning(UNIT(s), "Processes still around after SIGKILL. Ignoring.");
3232 socket_enter_stop_post(s, SOCKET_FAILURE_TIMEOUT);
3233 break;
3235 case SOCKET_STOP_POST:
3236 log_unit_warning(UNIT(s), "Stopping timed out (2). Terminating.");
3237 socket_enter_signal(s, SOCKET_FINAL_SIGTERM, SOCKET_FAILURE_TIMEOUT);
3238 break;
3240 case SOCKET_FINAL_SIGTERM:
3241 if (s->kill_context.send_sigkill) {
3242 log_unit_warning(UNIT(s), "Stopping timed out (2). Killing.");
3243 socket_enter_signal(s, SOCKET_FINAL_SIGKILL, SOCKET_FAILURE_TIMEOUT);
3244 } else {
3245 log_unit_warning(UNIT(s), "Stopping timed out (2). Skipping SIGKILL. Ignoring.");
3246 socket_enter_dead(s, SOCKET_FAILURE_TIMEOUT);
3248 break;
3250 case SOCKET_FINAL_SIGKILL:
3251 log_unit_warning(UNIT(s), "Still around after SIGKILL (2). Entering failed mode.");
3252 socket_enter_dead(s, SOCKET_FAILURE_TIMEOUT);
3253 break;
3255 case SOCKET_CLEANING:
3256 log_unit_warning(UNIT(s), "Cleaning timed out. killing.");
3258 if (s->clean_result == SOCKET_SUCCESS)
3259 s->clean_result = SOCKET_FAILURE_TIMEOUT;
3261 socket_enter_signal(s, SOCKET_FINAL_SIGKILL, 0);
3262 break;
3264 default:
3265 assert_not_reached();
3268 return 0;
3271 int socket_collect_fds(Socket *s, int **fds) {
3272 size_t k = 0, n = 0;
3273 int *rfds;
3275 assert(s);
3276 assert(fds);
3278 /* Called from the service code for requesting our fds */
3280 LIST_FOREACH(port, p, s->ports) {
3281 if (p->fd >= 0)
3282 n++;
3283 n += p->n_auxiliary_fds;
3286 if (n <= 0) {
3287 *fds = NULL;
3288 return 0;
3291 rfds = new(int, n);
3292 if (!rfds)
3293 return -ENOMEM;
3295 LIST_FOREACH(port, p, s->ports) {
3296 if (p->fd >= 0)
3297 rfds[k++] = p->fd;
3298 for (size_t i = 0; i < p->n_auxiliary_fds; ++i)
3299 rfds[k++] = p->auxiliary_fds[i];
3302 assert(k == n);
3304 *fds = rfds;
3305 return (int) n;
3308 static void socket_reset_failed(Unit *u) {
3309 Socket *s = SOCKET(u);
3311 assert(s);
3313 if (s->state == SOCKET_FAILED)
3314 socket_set_state(s, SOCKET_DEAD);
3316 s->result = SOCKET_SUCCESS;
3317 s->clean_result = SOCKET_SUCCESS;
3320 void socket_connection_unref(Socket *s) {
3321 assert(s);
3323 /* The service is dead. Yay!
3325 * This is strictly for one-instance-per-connection
3326 * services. */
3328 assert(s->n_connections > 0);
3329 s->n_connections--;
3331 log_unit_debug(UNIT(s), "One connection closed, %u left.", s->n_connections);
3334 static void socket_trigger_notify(Unit *u, Unit *other) {
3335 Socket *s = SOCKET(u);
3337 assert(u);
3338 assert(other);
3340 /* Filter out invocations with bogus state */
3341 assert(UNIT_IS_LOAD_COMPLETE(other->load_state));
3342 assert(other->type == UNIT_SERVICE);
3344 /* Don't propagate state changes from the service if we are already down */
3345 if (!IN_SET(s->state, SOCKET_RUNNING, SOCKET_LISTENING))
3346 return;
3348 /* We don't care for the service state if we are in Accept=yes mode */
3349 if (s->accept)
3350 return;
3352 /* Propagate start limit hit state */
3353 if (other->start_limit_hit) {
3354 socket_enter_stop_pre(s, SOCKET_FAILURE_SERVICE_START_LIMIT_HIT);
3355 return;
3358 /* Don't propagate anything if there's still a job queued */
3359 if (other->job)
3360 return;
3362 if (IN_SET(SERVICE(other)->state,
3363 SERVICE_DEAD, SERVICE_DEAD_BEFORE_AUTO_RESTART, SERVICE_FAILED, SERVICE_FAILED_BEFORE_AUTO_RESTART,
3364 SERVICE_FINAL_SIGTERM, SERVICE_FINAL_SIGKILL,
3365 SERVICE_AUTO_RESTART, SERVICE_AUTO_RESTART_QUEUED))
3366 socket_enter_listening(s);
3368 if (SERVICE(other)->state == SERVICE_RUNNING)
3369 socket_set_state(s, SOCKET_RUNNING);
3372 static int socket_kill(Unit *u, KillWho who, int signo, int code, int value, sd_bus_error *error) {
3373 return unit_kill_common(u, who, signo, code, value, -1, SOCKET(u)->control_pid, error);
3376 static int socket_get_timeout(Unit *u, usec_t *timeout) {
3377 Socket *s = SOCKET(u);
3378 usec_t t;
3379 int r;
3381 if (!s->timer_event_source)
3382 return 0;
3384 r = sd_event_source_get_time(s->timer_event_source, &t);
3385 if (r < 0)
3386 return r;
3387 if (t == USEC_INFINITY)
3388 return 0;
3390 *timeout = t;
3391 return 1;
3394 char *socket_fdname(Socket *s) {
3395 assert(s);
3397 /* Returns the name to use for $LISTEN_NAMES. If the user
3398 * didn't specify anything specifically, use the socket unit's
3399 * name as fallback. */
3401 return s->fdname ?: UNIT(s)->id;
3404 static int socket_control_pid(Unit *u) {
3405 Socket *s = SOCKET(u);
3407 assert(s);
3409 return s->control_pid;
3412 static int socket_clean(Unit *u, ExecCleanMask mask) {
3413 _cleanup_strv_free_ char **l = NULL;
3414 Socket *s = SOCKET(u);
3415 int r;
3417 assert(s);
3418 assert(mask != 0);
3420 if (s->state != SOCKET_DEAD)
3421 return -EBUSY;
3423 r = exec_context_get_clean_directories(&s->exec_context, u->manager->prefix, mask, &l);
3424 if (r < 0)
3425 return r;
3427 if (strv_isempty(l))
3428 return -EUNATCH;
3430 socket_unwatch_control_pid(s);
3431 s->clean_result = SOCKET_SUCCESS;
3432 s->control_command = NULL;
3433 s->control_command_id = _SOCKET_EXEC_COMMAND_INVALID;
3435 r = socket_arm_timer(s, usec_add(now(CLOCK_MONOTONIC), s->exec_context.timeout_clean_usec));
3436 if (r < 0)
3437 goto fail;
3439 r = unit_fork_and_watch_rm_rf(u, l, &s->control_pid);
3440 if (r < 0)
3441 goto fail;
3443 socket_set_state(s, SOCKET_CLEANING);
3445 return 0;
3447 fail:
3448 log_unit_warning_errno(u, r, "Failed to initiate cleaning: %m");
3449 s->clean_result = SOCKET_FAILURE_RESOURCES;
3450 s->timer_event_source = sd_event_source_disable_unref(s->timer_event_source);
3451 return r;
3454 static int socket_can_clean(Unit *u, ExecCleanMask *ret) {
3455 Socket *s = SOCKET(u);
3457 assert(s);
3459 return exec_context_get_clean_mask(&s->exec_context, ret);
3462 static int socket_can_start(Unit *u) {
3463 Socket *s = SOCKET(u);
3464 int r;
3466 assert(s);
3468 r = unit_test_start_limit(u);
3469 if (r < 0) {
3470 socket_enter_dead(s, SOCKET_FAILURE_START_LIMIT_HIT);
3471 return r;
3474 return 1;
3477 static const char* const socket_exec_command_table[_SOCKET_EXEC_COMMAND_MAX] = {
3478 [SOCKET_EXEC_START_PRE] = "ExecStartPre",
3479 [SOCKET_EXEC_START_CHOWN] = "ExecStartChown",
3480 [SOCKET_EXEC_START_POST] = "ExecStartPost",
3481 [SOCKET_EXEC_STOP_PRE] = "ExecStopPre",
3482 [SOCKET_EXEC_STOP_POST] = "ExecStopPost"
3485 DEFINE_STRING_TABLE_LOOKUP(socket_exec_command, SocketExecCommand);
3487 static const char* const socket_result_table[_SOCKET_RESULT_MAX] = {
3488 [SOCKET_SUCCESS] = "success",
3489 [SOCKET_FAILURE_RESOURCES] = "resources",
3490 [SOCKET_FAILURE_TIMEOUT] = "timeout",
3491 [SOCKET_FAILURE_EXIT_CODE] = "exit-code",
3492 [SOCKET_FAILURE_SIGNAL] = "signal",
3493 [SOCKET_FAILURE_CORE_DUMP] = "core-dump",
3494 [SOCKET_FAILURE_START_LIMIT_HIT] = "start-limit-hit",
3495 [SOCKET_FAILURE_TRIGGER_LIMIT_HIT] = "trigger-limit-hit",
3496 [SOCKET_FAILURE_SERVICE_START_LIMIT_HIT] = "service-start-limit-hit"
3499 DEFINE_STRING_TABLE_LOOKUP(socket_result, SocketResult);
3501 static const char* const socket_timestamping_table[_SOCKET_TIMESTAMPING_MAX] = {
3502 [SOCKET_TIMESTAMPING_OFF] = "off",
3503 [SOCKET_TIMESTAMPING_US] = "us",
3504 [SOCKET_TIMESTAMPING_NS] = "ns",
3507 DEFINE_STRING_TABLE_LOOKUP(socket_timestamping, SocketTimestamping);
3509 SocketTimestamping socket_timestamping_from_string_harder(const char *p) {
3510 SocketTimestamping t;
3511 int r;
3513 if (!p)
3514 return _SOCKET_TIMESTAMPING_INVALID;
3516 t = socket_timestamping_from_string(p);
3517 if (t >= 0)
3518 return t;
3520 /* Let's alternatively support the various other aliases parse_time() accepts for ns and µs here,
3521 * too. */
3522 if (streq(p, "nsec"))
3523 return SOCKET_TIMESTAMPING_NS;
3524 if (STR_IN_SET(p, "usec", "µs", "μs")) /* Accept both small greek letter mu + micro sign unicode codepoints */
3525 return SOCKET_TIMESTAMPING_US;
3527 r = parse_boolean(p);
3528 if (r < 0)
3529 return _SOCKET_TIMESTAMPING_INVALID;
3531 return r ? SOCKET_TIMESTAMPING_NS : SOCKET_TIMESTAMPING_OFF; /* If boolean yes, default to ns accuracy */
3534 const UnitVTable socket_vtable = {
3535 .object_size = sizeof(Socket),
3536 .exec_context_offset = offsetof(Socket, exec_context),
3537 .cgroup_context_offset = offsetof(Socket, cgroup_context),
3538 .kill_context_offset = offsetof(Socket, kill_context),
3539 .exec_runtime_offset = offsetof(Socket, exec_runtime),
3541 .sections =
3542 "Unit\0"
3543 "Socket\0"
3544 "Install\0",
3545 .private_section = "Socket",
3547 .can_transient = true,
3548 .can_trigger = true,
3549 .can_fail = true,
3551 .init = socket_init,
3552 .done = socket_done,
3553 .load = socket_load,
3555 .coldplug = socket_coldplug,
3557 .dump = socket_dump,
3559 .start = socket_start,
3560 .stop = socket_stop,
3562 .kill = socket_kill,
3563 .clean = socket_clean,
3564 .can_clean = socket_can_clean,
3566 .get_timeout = socket_get_timeout,
3568 .serialize = socket_serialize,
3569 .deserialize_item = socket_deserialize_item,
3570 .distribute_fds = socket_distribute_fds,
3572 .active_state = socket_active_state,
3573 .sub_state_to_string = socket_sub_state_to_string,
3575 .will_restart = unit_will_restart_default,
3577 .may_gc = socket_may_gc,
3579 .sigchld_event = socket_sigchld_event,
3581 .trigger_notify = socket_trigger_notify,
3583 .reset_failed = socket_reset_failed,
3585 .control_pid = socket_control_pid,
3587 .bus_set_property = bus_socket_set_property,
3588 .bus_commit_properties = bus_socket_commit_properties,
3590 .status_message_formats = {
3591 .finished_start_job = {
3592 [JOB_DONE] = "Listening on %s.",
3593 [JOB_FAILED] = "Failed to listen on %s.",
3594 [JOB_TIMEOUT] = "Timed out starting %s.",
3596 .finished_stop_job = {
3597 [JOB_DONE] = "Closed %s.",
3598 [JOB_FAILED] = "Failed stopping %s.",
3599 [JOB_TIMEOUT] = "Timed out stopping %s.",
3603 .can_start = socket_can_start,