]> git.ipfire.org Git - thirdparty/systemd.git/blob - src/core/socket.c
bb7164d255b3b9bd0a6a779d4d1946e5cfa3a4d4
[thirdparty/systemd.git] / src / core / socket.c
1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
2
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>
12
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"
49
50 struct SocketPeer {
51 unsigned n_ref;
52
53 Socket *socket;
54 union sockaddr_union peer;
55 socklen_t peer_salen;
56 };
57
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,
73 };
74
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);
78
79 static void socket_init(Unit *u) {
80 Socket *s = SOCKET(u);
81
82 assert(u);
83 assert(u->load_state == UNIT_STUB);
84
85 s->backlog = SOMAXCONN_DELUXE;
86 s->timeout_usec = u->manager->defaults.timeout_start_usec;
87 s->directory_mode = 0755;
88 s->socket_mode = 0666;
89
90 s->max_connections = 64;
91
92 s->priority = -1;
93 s->ip_tos = -1;
94 s->ip_ttl = -1;
95 s->mark = -1;
96
97 s->exec_context.std_output = u->manager->defaults.std_output;
98 s->exec_context.std_error = u->manager->defaults.std_error;
99
100 s->control_pid = PIDREF_NULL;
101 s->control_command_id = _SOCKET_EXEC_COMMAND_INVALID;
102
103 s->trigger_limit.interval = USEC_INFINITY;
104 s->trigger_limit.burst = UINT_MAX;
105
106 s->poll_limit_interval = USEC_INFINITY;
107 s->poll_limit_burst = UINT_MAX;
108 }
109
110 static void socket_unwatch_control_pid(Socket *s) {
111 assert(s);
112
113 if (!pidref_is_set(&s->control_pid))
114 return;
115
116 unit_unwatch_pidref(UNIT(s), &s->control_pid);
117 pidref_done(&s->control_pid);
118 }
119
120 static void socket_cleanup_fd_list(SocketPort *p) {
121 assert(p);
122
123 close_many(p->auxiliary_fds, p->n_auxiliary_fds);
124 p->auxiliary_fds = mfree(p->auxiliary_fds);
125 p->n_auxiliary_fds = 0;
126 }
127
128 SocketPort *socket_port_free(SocketPort *p) {
129 if (!p)
130 return NULL;
131
132 sd_event_source_unref(p->event_source);
133
134 socket_cleanup_fd_list(p);
135 safe_close(p->fd);
136 free(p->path);
137
138 return mfree(p);
139 }
140
141 void socket_free_ports(Socket *s) {
142 assert(s);
143
144 LIST_CLEAR(port, s->ports, socket_port_free);
145 }
146
147 static void socket_done(Unit *u) {
148 Socket *s = SOCKET(u);
149 SocketPeer *p;
150
151 assert(s);
152
153 socket_free_ports(s);
154
155 while ((p = set_steal_first(s->peers_by_address)))
156 p->socket = NULL;
157
158 s->peers_by_address = set_free(s->peers_by_address);
159
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;
163
164 socket_unwatch_control_pid(s);
165
166 unit_ref_unset(&s->service);
167
168 s->tcp_congestion = mfree(s->tcp_congestion);
169 s->bind_to_device = mfree(s->bind_to_device);
170
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);
174
175 strv_free(s->symlinks);
176
177 s->user = mfree(s->user);
178 s->group = mfree(s->group);
179
180 s->fdname = mfree(s->fdname);
181
182 s->timer_event_source = sd_event_source_disable_unref(s->timer_event_source);
183 }
184
185 static int socket_arm_timer(Socket *s, bool relative, usec_t usec) {
186 assert(s);
187
188 return unit_arm_timer(UNIT(s), &s->timer_event_source, relative, usec, socket_dispatch_timer);
189 }
190
191 static bool have_non_accept_socket(Socket *s) {
192 assert(s);
193
194 if (!s->accept)
195 return true;
196
197 LIST_FOREACH(port, p, s->ports) {
198
199 if (p->type != SOCKET_SOCKET)
200 return true;
201
202 if (!socket_address_can_accept(&p->address))
203 return true;
204 }
205
206 return false;
207 }
208
209 static int socket_add_mount_dependencies(Socket *s) {
210 int r;
211
212 assert(s);
213
214 LIST_FOREACH(port, p, s->ports) {
215 const char *path = NULL;
216
217 if (p->type == SOCKET_SOCKET)
218 path = socket_address_get_path(&p->address);
219 else if (IN_SET(p->type, SOCKET_FIFO, SOCKET_SPECIAL, SOCKET_USB_FUNCTION))
220 path = p->path;
221
222 if (!path)
223 continue;
224
225 r = unit_require_mounts_for(UNIT(s), path, UNIT_DEPENDENCY_FILE);
226 if (r < 0)
227 return r;
228 }
229
230 return 0;
231 }
232
233 static int socket_add_device_dependencies(Socket *s) {
234 char *t;
235
236 assert(s);
237
238 if (!s->bind_to_device || streq(s->bind_to_device, "lo"))
239 return 0;
240
241 t = strjoina("/sys/subsystem/net/devices/", s->bind_to_device);
242 return unit_add_node_dependency(UNIT(s), t, UNIT_BINDS_TO, UNIT_DEPENDENCY_FILE);
243 }
244
245 static int socket_add_default_dependencies(Socket *s) {
246 int r;
247 assert(s);
248
249 if (!UNIT(s)->default_dependencies)
250 return 0;
251
252 r = unit_add_dependency_by_name(UNIT(s), UNIT_BEFORE, SPECIAL_SOCKETS_TARGET, true, UNIT_DEPENDENCY_DEFAULT);
253 if (r < 0)
254 return r;
255
256 if (MANAGER_IS_SYSTEM(UNIT(s)->manager)) {
257 r = unit_add_two_dependencies_by_name(UNIT(s), UNIT_AFTER, UNIT_REQUIRES, SPECIAL_SYSINIT_TARGET, true, UNIT_DEPENDENCY_DEFAULT);
258 if (r < 0)
259 return r;
260 }
261
262 return unit_add_two_dependencies_by_name(UNIT(s), UNIT_BEFORE, UNIT_CONFLICTS, SPECIAL_SHUTDOWN_TARGET, true, UNIT_DEPENDENCY_DEFAULT);
263 }
264
265 static bool socket_has_exec(Socket *s) {
266 unsigned i;
267 assert(s);
268
269 for (i = 0; i < _SOCKET_EXEC_COMMAND_MAX; i++)
270 if (s->exec_command[i])
271 return true;
272
273 return false;
274 }
275
276 static int socket_add_extras(Socket *s) {
277 Unit *u = UNIT(s);
278 int r;
279
280 assert(s);
281
282 /* Pick defaults for the trigger limit, if nothing was explicitly configured. We pick a relatively high limit
283 * in Accept=yes mode, and a lower limit for Accept=no. Reason: in Accept=yes mode we are invoking accept()
284 * ourselves before the trigger limit can hit, thus incoming connections are taken off the socket queue quickly
285 * and reliably. This is different for Accept=no, where the spawned service has to take the incoming traffic
286 * off the queues, which it might not necessarily do. Moreover, while Accept=no services are supposed to
287 * process whatever is queued in one go, and thus should normally never have to be started frequently. This is
288 * different for Accept=yes where each connection is processed by a new service instance, and thus frequent
289 * service starts are typical.
290 *
291 * For the poll limit we follow a similar rule, but use 3/4th of the trigger limit parameters, to
292 * trigger this earlier. */
293
294 if (s->trigger_limit.interval == USEC_INFINITY)
295 s->trigger_limit.interval = 2 * USEC_PER_SEC;
296 if (s->trigger_limit.burst == UINT_MAX)
297 s->trigger_limit.burst = s->accept ? 200 : 20;
298
299 if (s->poll_limit_interval == USEC_INFINITY)
300 s->poll_limit_interval = 2 * USEC_PER_SEC;
301 if (s->poll_limit_burst == UINT_MAX)
302 s->poll_limit_burst = s->accept ? 150 : 15;
303
304 if (have_non_accept_socket(s)) {
305
306 if (!UNIT_DEREF(s->service)) {
307 Unit *x;
308
309 r = unit_load_related_unit(u, ".service", &x);
310 if (r < 0)
311 return r;
312
313 unit_ref_set(&s->service, u, x);
314 }
315
316 r = unit_add_two_dependencies(u, UNIT_BEFORE, UNIT_TRIGGERS, UNIT_DEREF(s->service), true, UNIT_DEPENDENCY_IMPLICIT);
317 if (r < 0)
318 return r;
319 }
320
321 r = socket_add_mount_dependencies(s);
322 if (r < 0)
323 return r;
324
325 r = socket_add_device_dependencies(s);
326 if (r < 0)
327 return r;
328
329 r = unit_patch_contexts(u);
330 if (r < 0)
331 return r;
332
333 if (socket_has_exec(s)) {
334 r = unit_add_exec_dependencies(u, &s->exec_context);
335 if (r < 0)
336 return r;
337 }
338
339 r = unit_set_default_slice(u);
340 if (r < 0)
341 return r;
342
343 r = socket_add_default_dependencies(s);
344 if (r < 0)
345 return r;
346
347 return 0;
348 }
349
350 static const char *socket_find_symlink_target(Socket *s) {
351 const char *found = NULL;
352
353 LIST_FOREACH(port, p, s->ports) {
354 const char *f = NULL;
355
356 switch (p->type) {
357
358 case SOCKET_FIFO:
359 f = p->path;
360 break;
361
362 case SOCKET_SOCKET:
363 f = socket_address_get_path(&p->address);
364 break;
365
366 default:
367 break;
368 }
369
370 if (f) {
371 if (found)
372 return NULL;
373
374 found = f;
375 }
376 }
377
378 return found;
379 }
380
381 static int socket_verify(Socket *s) {
382 assert(s);
383 assert(UNIT(s)->load_state == UNIT_LOADED);
384
385 if (!s->ports)
386 return log_unit_error_errno(UNIT(s), SYNTHETIC_ERRNO(ENOEXEC), "Unit has no Listen setting (ListenStream=, ListenDatagram=, ListenFIFO=, ...). Refusing.");
387
388 if (s->accept && have_non_accept_socket(s))
389 return log_unit_error_errno(UNIT(s), SYNTHETIC_ERRNO(ENOEXEC), "Unit configured for accepting sockets, but sockets are non-accepting. Refusing.");
390
391 if (s->accept && s->max_connections <= 0)
392 return log_unit_error_errno(UNIT(s), SYNTHETIC_ERRNO(ENOEXEC), "MaxConnection= setting too small. Refusing.");
393
394 if (s->accept && UNIT_DEREF(s->service))
395 return log_unit_error_errno(UNIT(s), SYNTHETIC_ERRNO(ENOEXEC), "Explicit service configuration for accepting socket units not supported. Refusing.");
396
397 if (s->exec_context.pam_name && s->kill_context.kill_mode != KILL_CONTROL_GROUP)
398 return log_unit_error_errno(UNIT(s), SYNTHETIC_ERRNO(ENOEXEC), "Unit has PAM enabled. Kill mode must be set to 'control-group'. Refusing.");
399
400 if (!strv_isempty(s->symlinks) && !socket_find_symlink_target(s))
401 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.");
402
403 return 0;
404 }
405
406 static void peer_address_hash_func(const SocketPeer *s, struct siphash *state) {
407 assert(s);
408
409 if (s->peer.sa.sa_family == AF_INET)
410 siphash24_compress(&s->peer.in.sin_addr, sizeof(s->peer.in.sin_addr), state);
411 else if (s->peer.sa.sa_family == AF_INET6)
412 siphash24_compress(&s->peer.in6.sin6_addr, sizeof(s->peer.in6.sin6_addr), state);
413 else if (s->peer.sa.sa_family == AF_VSOCK)
414 siphash24_compress(&s->peer.vm.svm_cid, sizeof(s->peer.vm.svm_cid), state);
415 else
416 assert_not_reached();
417 }
418
419 static int peer_address_compare_func(const SocketPeer *x, const SocketPeer *y) {
420 int r;
421
422 r = CMP(x->peer.sa.sa_family, y->peer.sa.sa_family);
423 if (r != 0)
424 return r;
425
426 switch (x->peer.sa.sa_family) {
427 case AF_INET:
428 return memcmp(&x->peer.in.sin_addr, &y->peer.in.sin_addr, sizeof(x->peer.in.sin_addr));
429 case AF_INET6:
430 return memcmp(&x->peer.in6.sin6_addr, &y->peer.in6.sin6_addr, sizeof(x->peer.in6.sin6_addr));
431 case AF_VSOCK:
432 return CMP(x->peer.vm.svm_cid, y->peer.vm.svm_cid);
433 }
434 assert_not_reached();
435 }
436
437 DEFINE_PRIVATE_HASH_OPS(peer_address_hash_ops, SocketPeer, peer_address_hash_func, peer_address_compare_func);
438
439 static int socket_load(Unit *u) {
440 Socket *s = SOCKET(u);
441 int r;
442
443 assert(u);
444 assert(u->load_state == UNIT_STUB);
445
446 r = unit_load_fragment_and_dropin(u, true);
447 if (r < 0)
448 return r;
449
450 if (u->load_state != UNIT_LOADED)
451 return 0;
452
453 /* This is a new unit? Then let's add in some extras */
454 r = socket_add_extras(s);
455 if (r < 0)
456 return r;
457
458 return socket_verify(s);
459 }
460
461 static SocketPeer *socket_peer_new(void) {
462 SocketPeer *p;
463
464 p = new(SocketPeer, 1);
465 if (!p)
466 return NULL;
467
468 *p = (SocketPeer) {
469 .n_ref = 1,
470 };
471 return p;
472 }
473
474 static SocketPeer *socket_peer_free(SocketPeer *p) {
475 assert(p);
476
477 if (p->socket)
478 set_remove(p->socket->peers_by_address, p);
479
480 return mfree(p);
481 }
482
483 DEFINE_TRIVIAL_REF_UNREF_FUNC(SocketPeer, socket_peer, socket_peer_free);
484
485 int socket_acquire_peer(Socket *s, int fd, SocketPeer **ret) {
486 _cleanup_(socket_peer_unrefp) SocketPeer *remote = NULL;
487 SocketPeer sa = {
488 .peer_salen = sizeof(union sockaddr_union),
489 }, *i;
490 int r;
491
492 assert(fd >= 0);
493 assert(s);
494 assert(ret);
495
496 if (getpeername(fd, &sa.peer.sa, &sa.peer_salen) < 0)
497 return log_unit_error_errno(UNIT(s), errno, "getpeername() failed: %m");
498
499 if (!IN_SET(sa.peer.sa.sa_family, AF_INET, AF_INET6, AF_VSOCK)) {
500 *ret = NULL;
501 return 0;
502 }
503
504 i = set_get(s->peers_by_address, &sa);
505 if (i) {
506 *ret = socket_peer_ref(i);
507 return 1;
508 }
509
510 remote = socket_peer_new();
511 if (!remote)
512 return log_oom();
513
514 remote->peer = sa.peer;
515 remote->peer_salen = sa.peer_salen;
516
517 r = set_ensure_put(&s->peers_by_address, &peer_address_hash_ops, remote);
518 if (r < 0)
519 return log_unit_error_errno(UNIT(s), r, "Failed to insert peer info into hash table: %m");
520
521 remote->socket = s;
522
523 *ret = TAKE_PTR(remote);
524 return 1;
525 }
526
527 static const char* listen_lookup(int family, int type) {
528
529 if (family == AF_NETLINK)
530 return "ListenNetlink";
531
532 if (type == SOCK_STREAM)
533 return "ListenStream";
534 else if (type == SOCK_DGRAM)
535 return "ListenDatagram";
536 else if (type == SOCK_SEQPACKET)
537 return "ListenSequentialPacket";
538
539 assert_not_reached();
540 return NULL;
541 }
542
543 static void socket_dump(Unit *u, FILE *f, const char *prefix) {
544 Socket *s = SOCKET(u);
545 const char *prefix2, *str;
546
547 assert(s);
548 assert(f);
549
550 prefix = strempty(prefix);
551 prefix2 = strjoina(prefix, "\t");
552
553 fprintf(f,
554 "%sSocket State: %s\n"
555 "%sResult: %s\n"
556 "%sClean Result: %s\n"
557 "%sBindIPv6Only: %s\n"
558 "%sBacklog: %u\n"
559 "%sSocketMode: %04o\n"
560 "%sDirectoryMode: %04o\n"
561 "%sKeepAlive: %s\n"
562 "%sNoDelay: %s\n"
563 "%sFreeBind: %s\n"
564 "%sTransparent: %s\n"
565 "%sBroadcast: %s\n"
566 "%sPassCredentials: %s\n"
567 "%sPassSecurity: %s\n"
568 "%sPassPacketInfo: %s\n"
569 "%sTCPCongestion: %s\n"
570 "%sRemoveOnStop: %s\n"
571 "%sWritable: %s\n"
572 "%sFileDescriptorName: %s\n"
573 "%sSELinuxContextFromNet: %s\n",
574 prefix, socket_state_to_string(s->state),
575 prefix, socket_result_to_string(s->result),
576 prefix, socket_result_to_string(s->clean_result),
577 prefix, socket_address_bind_ipv6_only_to_string(s->bind_ipv6_only),
578 prefix, s->backlog,
579 prefix, s->socket_mode,
580 prefix, s->directory_mode,
581 prefix, yes_no(s->keep_alive),
582 prefix, yes_no(s->no_delay),
583 prefix, yes_no(s->free_bind),
584 prefix, yes_no(s->transparent),
585 prefix, yes_no(s->broadcast),
586 prefix, yes_no(s->pass_cred),
587 prefix, yes_no(s->pass_sec),
588 prefix, yes_no(s->pass_pktinfo),
589 prefix, strna(s->tcp_congestion),
590 prefix, yes_no(s->remove_on_stop),
591 prefix, yes_no(s->writable),
592 prefix, socket_fdname(s),
593 prefix, yes_no(s->selinux_context_from_net));
594
595 if (s->timestamping != SOCKET_TIMESTAMPING_OFF)
596 fprintf(f,
597 "%sTimestamping: %s\n",
598 prefix, socket_timestamping_to_string(s->timestamping));
599
600 if (pidref_is_set(&s->control_pid))
601 fprintf(f,
602 "%sControl PID: "PID_FMT"\n",
603 prefix, s->control_pid.pid);
604
605 if (s->bind_to_device)
606 fprintf(f,
607 "%sBindToDevice: %s\n",
608 prefix, s->bind_to_device);
609
610 if (s->accept)
611 fprintf(f,
612 "%sAccepted: %u\n"
613 "%sNConnections: %u\n"
614 "%sMaxConnections: %u\n"
615 "%sMaxConnectionsPerSource: %u\n",
616 prefix, s->n_accepted,
617 prefix, s->n_connections,
618 prefix, s->max_connections,
619 prefix, s->max_connections_per_source);
620 else
621 fprintf(f,
622 "%sFlushPending: %s\n",
623 prefix, yes_no(s->flush_pending));
624
625
626 if (s->priority >= 0)
627 fprintf(f,
628 "%sPriority: %i\n",
629 prefix, s->priority);
630
631 if (s->receive_buffer > 0)
632 fprintf(f,
633 "%sReceiveBuffer: %zu\n",
634 prefix, s->receive_buffer);
635
636 if (s->send_buffer > 0)
637 fprintf(f,
638 "%sSendBuffer: %zu\n",
639 prefix, s->send_buffer);
640
641 if (s->ip_tos >= 0)
642 fprintf(f,
643 "%sIPTOS: %i\n",
644 prefix, s->ip_tos);
645
646 if (s->ip_ttl >= 0)
647 fprintf(f,
648 "%sIPTTL: %i\n",
649 prefix, s->ip_ttl);
650
651 if (s->pipe_size > 0)
652 fprintf(f,
653 "%sPipeSize: %zu\n",
654 prefix, s->pipe_size);
655
656 if (s->mark >= 0)
657 fprintf(f,
658 "%sMark: %i\n",
659 prefix, s->mark);
660
661 if (s->mq_maxmsg > 0)
662 fprintf(f,
663 "%sMessageQueueMaxMessages: %li\n",
664 prefix, s->mq_maxmsg);
665
666 if (s->mq_msgsize > 0)
667 fprintf(f,
668 "%sMessageQueueMessageSize: %li\n",
669 prefix, s->mq_msgsize);
670
671 if (s->reuse_port)
672 fprintf(f,
673 "%sReusePort: %s\n",
674 prefix, yes_no(s->reuse_port));
675
676 if (s->smack)
677 fprintf(f,
678 "%sSmackLabel: %s\n",
679 prefix, s->smack);
680
681 if (s->smack_ip_in)
682 fprintf(f,
683 "%sSmackLabelIPIn: %s\n",
684 prefix, s->smack_ip_in);
685
686 if (s->smack_ip_out)
687 fprintf(f,
688 "%sSmackLabelIPOut: %s\n",
689 prefix, s->smack_ip_out);
690
691 if (!isempty(s->user) || !isempty(s->group))
692 fprintf(f,
693 "%sSocketUser: %s\n"
694 "%sSocketGroup: %s\n",
695 prefix, strna(s->user),
696 prefix, strna(s->group));
697
698 if (timestamp_is_set(s->keep_alive_time))
699 fprintf(f,
700 "%sKeepAliveTimeSec: %s\n",
701 prefix, FORMAT_TIMESPAN(s->keep_alive_time, USEC_PER_SEC));
702
703 if (s->keep_alive_interval > 0)
704 fprintf(f,
705 "%sKeepAliveIntervalSec: %s\n",
706 prefix, FORMAT_TIMESPAN(s->keep_alive_interval, USEC_PER_SEC));
707
708 if (s->keep_alive_cnt > 0)
709 fprintf(f,
710 "%sKeepAliveProbes: %u\n",
711 prefix, s->keep_alive_cnt);
712
713 if (s->defer_accept > 0)
714 fprintf(f,
715 "%sDeferAcceptSec: %s\n",
716 prefix, FORMAT_TIMESPAN(s->defer_accept, USEC_PER_SEC));
717
718 LIST_FOREACH(port, p, s->ports) {
719
720 switch (p->type) {
721 case SOCKET_SOCKET: {
722 _cleanup_free_ char *k = NULL;
723 int r;
724
725 r = socket_address_print(&p->address, &k);
726 if (r < 0) {
727 errno = -r;
728 fprintf(f, "%s%s: %m\n", prefix, listen_lookup(socket_address_family(&p->address), p->address.type));
729 } else
730 fprintf(f, "%s%s: %s\n", prefix, listen_lookup(socket_address_family(&p->address), p->address.type), k);
731 break;
732 }
733 case SOCKET_SPECIAL:
734 fprintf(f, "%sListenSpecial: %s\n", prefix, p->path);
735 break;
736 case SOCKET_USB_FUNCTION:
737 fprintf(f, "%sListenUSBFunction: %s\n", prefix, p->path);
738 break;
739 case SOCKET_MQUEUE:
740 fprintf(f, "%sListenMessageQueue: %s\n", prefix, p->path);
741 break;
742 default:
743 fprintf(f, "%sListenFIFO: %s\n", prefix, p->path);
744 }
745 }
746
747 fprintf(f,
748 "%sTriggerLimitIntervalSec: %s\n"
749 "%sTriggerLimitBurst: %u\n"
750 "%sPollLimitIntervalSec: %s\n"
751 "%sPollLimitBurst: %u\n",
752 prefix, FORMAT_TIMESPAN(s->trigger_limit.interval, USEC_PER_SEC),
753 prefix, s->trigger_limit.burst,
754 prefix, FORMAT_TIMESPAN(s->poll_limit_interval, USEC_PER_SEC),
755 prefix, s->poll_limit_burst);
756
757 str = ip_protocol_to_name(s->socket_protocol);
758 if (str)
759 fprintf(f, "%sSocketProtocol: %s\n", prefix, str);
760
761 if (!strv_isempty(s->symlinks)) {
762 fprintf(f, "%sSymlinks:", prefix);
763 STRV_FOREACH(q, s->symlinks)
764 fprintf(f, " %s", *q);
765
766 fprintf(f, "\n");
767 }
768
769 fprintf(f,
770 "%sTimeoutSec: %s\n",
771 prefix, FORMAT_TIMESPAN(s->timeout_usec, USEC_PER_SEC));
772
773 exec_context_dump(&s->exec_context, f, prefix);
774 kill_context_dump(&s->kill_context, f, prefix);
775
776 for (SocketExecCommand c = 0; c < _SOCKET_EXEC_COMMAND_MAX; c++) {
777 if (!s->exec_command[c])
778 continue;
779
780 fprintf(f, "%s-> %s:\n",
781 prefix, socket_exec_command_to_string(c));
782
783 exec_command_dump_list(s->exec_command[c], f, prefix2);
784 }
785
786 cgroup_context_dump(UNIT(s), f, prefix);
787 }
788
789 static int instance_from_socket(int fd, unsigned nr, char **instance) {
790 socklen_t l;
791 char *r;
792 union sockaddr_union local, remote;
793
794 assert(fd >= 0);
795 assert(instance);
796
797 l = sizeof(local);
798 if (getsockname(fd, &local.sa, &l) < 0)
799 return -errno;
800
801 l = sizeof(remote);
802 if (getpeername(fd, &remote.sa, &l) < 0)
803 return -errno;
804
805 switch (local.sa.sa_family) {
806
807 case AF_INET: {
808 uint32_t
809 a = be32toh(local.in.sin_addr.s_addr),
810 b = be32toh(remote.in.sin_addr.s_addr);
811
812 if (asprintf(&r,
813 "%u-%u.%u.%u.%u:%u-%u.%u.%u.%u:%u",
814 nr,
815 a >> 24, (a >> 16) & 0xFF, (a >> 8) & 0xFF, a & 0xFF,
816 be16toh(local.in.sin_port),
817 b >> 24, (b >> 16) & 0xFF, (b >> 8) & 0xFF, b & 0xFF,
818 be16toh(remote.in.sin_port)) < 0)
819 return -ENOMEM;
820
821 break;
822 }
823
824 case AF_INET6: {
825 static const unsigned char ipv4_prefix[] = {
826 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0xFF, 0xFF
827 };
828
829 if (memcmp(&local.in6.sin6_addr, ipv4_prefix, sizeof(ipv4_prefix)) == 0 &&
830 memcmp(&remote.in6.sin6_addr, ipv4_prefix, sizeof(ipv4_prefix)) == 0) {
831 const uint8_t
832 *a = local.in6.sin6_addr.s6_addr+12,
833 *b = remote.in6.sin6_addr.s6_addr+12;
834
835 if (asprintf(&r,
836 "%u-%u.%u.%u.%u:%u-%u.%u.%u.%u:%u",
837 nr,
838 a[0], a[1], a[2], a[3],
839 be16toh(local.in6.sin6_port),
840 b[0], b[1], b[2], b[3],
841 be16toh(remote.in6.sin6_port)) < 0)
842 return -ENOMEM;
843 } else {
844 if (asprintf(&r,
845 "%u-%s:%u-%s:%u",
846 nr,
847 IN6_ADDR_TO_STRING(&local.in6.sin6_addr),
848 be16toh(local.in6.sin6_port),
849 IN6_ADDR_TO_STRING(&remote.in6.sin6_addr),
850 be16toh(remote.in6.sin6_port)) < 0)
851 return -ENOMEM;
852 }
853
854 break;
855 }
856
857 case AF_UNIX: {
858 struct ucred ucred;
859 int k;
860
861 k = getpeercred(fd, &ucred);
862 if (k >= 0) {
863 if (asprintf(&r,
864 "%u-"PID_FMT"-"UID_FMT,
865 nr, ucred.pid, ucred.uid) < 0)
866 return -ENOMEM;
867 } else if (k == -ENODATA) {
868 /* This handles the case where somebody is
869 * connecting from another pid/uid namespace
870 * (e.g. from outside of our container). */
871 if (asprintf(&r,
872 "%u-unknown",
873 nr) < 0)
874 return -ENOMEM;
875 } else
876 return k;
877
878 break;
879 }
880
881 case AF_VSOCK:
882 if (asprintf(&r,
883 "%u-%u:%u-%u:%u",
884 nr,
885 local.vm.svm_cid, local.vm.svm_port,
886 remote.vm.svm_cid, remote.vm.svm_port) < 0)
887 return -ENOMEM;
888
889 break;
890
891 default:
892 assert_not_reached();
893 }
894
895 *instance = r;
896 return 0;
897 }
898
899 static void socket_close_fds(Socket *s) {
900 assert(s);
901
902 LIST_FOREACH(port, p, s->ports) {
903 bool was_open;
904
905 was_open = p->fd >= 0;
906
907 p->event_source = sd_event_source_disable_unref(p->event_source);
908 p->fd = safe_close(p->fd);
909 socket_cleanup_fd_list(p);
910
911 /* One little note: we should normally not delete any sockets in the file system here! After all some
912 * other process we spawned might still have a reference of this fd and wants to continue to use
913 * it. Therefore we normally delete sockets in the file system before we create a new one, not after we
914 * stopped using one! That all said, if the user explicitly requested this, we'll delete them here
915 * anyway, but only then. */
916
917 if (!was_open || !s->remove_on_stop)
918 continue;
919
920 switch (p->type) {
921
922 case SOCKET_FIFO:
923 (void) unlink(p->path);
924 break;
925
926 case SOCKET_MQUEUE:
927 (void) mq_unlink(p->path);
928 break;
929
930 case SOCKET_SOCKET:
931 (void) socket_address_unlink(&p->address);
932 break;
933
934 default:
935 break;
936 }
937 }
938
939 if (s->remove_on_stop)
940 STRV_FOREACH(i, s->symlinks)
941 (void) unlink(*i);
942
943 /* Note that we don't return NULL here, since s has not been freed. */
944 }
945
946 static void socket_apply_socket_options(Socket *s, SocketPort *p, int fd) {
947 int r;
948
949 assert(s);
950 assert(p);
951 assert(fd >= 0);
952
953 if (s->keep_alive) {
954 r = setsockopt_int(fd, SOL_SOCKET, SO_KEEPALIVE, true);
955 if (r < 0)
956 log_unit_warning_errno(UNIT(s), r, "SO_KEEPALIVE failed: %m");
957 }
958
959 if (timestamp_is_set(s->keep_alive_time)) {
960 r = setsockopt_int(fd, SOL_TCP, TCP_KEEPIDLE, s->keep_alive_time / USEC_PER_SEC);
961 if (r < 0)
962 log_unit_warning_errno(UNIT(s), r, "TCP_KEEPIDLE failed: %m");
963 }
964
965 if (s->keep_alive_interval > 0) {
966 r = setsockopt_int(fd, SOL_TCP, TCP_KEEPINTVL, s->keep_alive_interval / USEC_PER_SEC);
967 if (r < 0)
968 log_unit_warning_errno(UNIT(s), r, "TCP_KEEPINTVL failed: %m");
969 }
970
971 if (s->keep_alive_cnt > 0) {
972 r = setsockopt_int(fd, SOL_TCP, TCP_KEEPCNT, s->keep_alive_cnt);
973 if (r < 0)
974 log_unit_warning_errno(UNIT(s), r, "TCP_KEEPCNT failed: %m");
975 }
976
977 if (s->defer_accept > 0) {
978 r = setsockopt_int(fd, SOL_TCP, TCP_DEFER_ACCEPT, s->defer_accept / USEC_PER_SEC);
979 if (r < 0)
980 log_unit_warning_errno(UNIT(s), r, "TCP_DEFER_ACCEPT failed: %m");
981 }
982
983 if (s->no_delay) {
984 if (s->socket_protocol == IPPROTO_SCTP) {
985 r = setsockopt_int(fd, SOL_SCTP, SCTP_NODELAY, true);
986 if (r < 0)
987 log_unit_warning_errno(UNIT(s), r, "SCTP_NODELAY failed: %m");
988 } else {
989 r = setsockopt_int(fd, SOL_TCP, TCP_NODELAY, true);
990 if (r < 0)
991 log_unit_warning_errno(UNIT(s), r, "TCP_NODELAY failed: %m");
992 }
993 }
994
995 if (s->broadcast) {
996 r = setsockopt_int(fd, SOL_SOCKET, SO_BROADCAST, true);
997 if (r < 0)
998 log_unit_warning_errno(UNIT(s), r, "SO_BROADCAST failed: %m");
999 }
1000
1001 if (s->pass_cred) {
1002 r = setsockopt_int(fd, SOL_SOCKET, SO_PASSCRED, true);
1003 if (r < 0)
1004 log_unit_warning_errno(UNIT(s), r, "SO_PASSCRED failed: %m");
1005 }
1006
1007 if (s->pass_sec) {
1008 r = setsockopt_int(fd, SOL_SOCKET, SO_PASSSEC, true);
1009 if (r < 0)
1010 log_unit_warning_errno(UNIT(s), r, "SO_PASSSEC failed: %m");
1011 }
1012
1013 if (s->pass_pktinfo) {
1014 r = socket_set_recvpktinfo(fd, socket_address_family(&p->address), true);
1015 if (r < 0)
1016 log_unit_warning_errno(UNIT(s), r, "Failed to enable packet info socket option: %m");
1017 }
1018
1019 if (s->timestamping != SOCKET_TIMESTAMPING_OFF) {
1020 r = setsockopt_int(fd, SOL_SOCKET,
1021 s->timestamping == SOCKET_TIMESTAMPING_NS ? SO_TIMESTAMPNS : SO_TIMESTAMP,
1022 true);
1023 if (r < 0)
1024 log_unit_warning_errno(UNIT(s), r, "Failed to enable timestamping socket option, ignoring: %m");
1025 }
1026
1027 if (s->priority >= 0) {
1028 r = setsockopt_int(fd, SOL_SOCKET, SO_PRIORITY, s->priority);
1029 if (r < 0)
1030 log_unit_warning_errno(UNIT(s), r, "SO_PRIORITY failed: %m");
1031 }
1032
1033 if (s->receive_buffer > 0) {
1034 r = fd_set_rcvbuf(fd, s->receive_buffer, false);
1035 if (r < 0)
1036 log_unit_full_errno(UNIT(s), ERRNO_IS_PRIVILEGE(r) ? LOG_DEBUG : LOG_WARNING, r,
1037 "SO_RCVBUF/SO_RCVBUFFORCE failed: %m");
1038 }
1039
1040 if (s->send_buffer > 0) {
1041 r = fd_set_sndbuf(fd, s->send_buffer, false);
1042 if (r < 0)
1043 log_unit_full_errno(UNIT(s), ERRNO_IS_PRIVILEGE(r) ? LOG_DEBUG : LOG_WARNING, r,
1044 "SO_SNDBUF/SO_SNDBUFFORCE failed: %m");
1045 }
1046
1047 if (s->mark >= 0) {
1048 r = setsockopt_int(fd, SOL_SOCKET, SO_MARK, s->mark);
1049 if (r < 0)
1050 log_unit_warning_errno(UNIT(s), r, "SO_MARK failed: %m");
1051 }
1052
1053 if (s->ip_tos >= 0) {
1054 r = setsockopt_int(fd, IPPROTO_IP, IP_TOS, s->ip_tos);
1055 if (r < 0)
1056 log_unit_warning_errno(UNIT(s), r, "IP_TOS failed: %m");
1057 }
1058
1059 if (s->ip_ttl >= 0) {
1060 r = socket_set_ttl(fd, socket_address_family(&p->address), s->ip_ttl);
1061 if (r < 0)
1062 log_unit_warning_errno(UNIT(s), r, "IP_TTL/IPV6_UNICAST_HOPS failed: %m");
1063 }
1064
1065 if (s->tcp_congestion)
1066 if (setsockopt(fd, SOL_TCP, TCP_CONGESTION, s->tcp_congestion, strlen(s->tcp_congestion)+1) < 0)
1067 log_unit_warning_errno(UNIT(s), errno, "TCP_CONGESTION failed: %m");
1068
1069 if (s->smack_ip_in) {
1070 r = mac_smack_apply_fd(fd, SMACK_ATTR_IPIN, s->smack_ip_in);
1071 if (r < 0)
1072 log_unit_error_errno(UNIT(s), r, "mac_smack_apply_ip_in_fd: %m");
1073 }
1074
1075 if (s->smack_ip_out) {
1076 r = mac_smack_apply_fd(fd, SMACK_ATTR_IPOUT, s->smack_ip_out);
1077 if (r < 0)
1078 log_unit_error_errno(UNIT(s), r, "mac_smack_apply_ip_out_fd: %m");
1079 }
1080 }
1081
1082 static void socket_apply_fifo_options(Socket *s, int fd) {
1083 int r;
1084
1085 assert(s);
1086 assert(fd >= 0);
1087
1088 if (s->pipe_size > 0)
1089 if (fcntl(fd, F_SETPIPE_SZ, s->pipe_size) < 0)
1090 log_unit_warning_errno(UNIT(s), errno, "Setting pipe size failed, ignoring: %m");
1091
1092 if (s->smack) {
1093 r = mac_smack_apply_fd(fd, SMACK_ATTR_ACCESS, s->smack);
1094 if (r < 0)
1095 log_unit_error_errno(UNIT(s), r, "SMACK relabelling failed, ignoring: %m");
1096 }
1097 }
1098
1099 static int fifo_address_create(
1100 const char *path,
1101 mode_t directory_mode,
1102 mode_t socket_mode) {
1103
1104 _cleanup_close_ int fd = -EBADF;
1105 mode_t old_mask;
1106 struct stat st;
1107 int r;
1108
1109 assert(path);
1110
1111 (void) mkdir_parents_label(path, directory_mode);
1112
1113 r = mac_selinux_create_file_prepare(path, S_IFIFO);
1114 if (r < 0)
1115 return r;
1116
1117 /* Enforce the right access mode for the fifo */
1118 old_mask = umask(~socket_mode);
1119
1120 /* Include the original umask in our mask */
1121 (void) umask(~socket_mode | old_mask);
1122
1123 r = mkfifo(path, socket_mode);
1124 (void) umask(old_mask);
1125
1126 if (r < 0 && errno != EEXIST) {
1127 r = -errno;
1128 goto fail;
1129 }
1130
1131 fd = open(path, O_RDWR | O_CLOEXEC | O_NOCTTY | O_NONBLOCK | O_NOFOLLOW);
1132 if (fd < 0) {
1133 r = -errno;
1134 goto fail;
1135 }
1136
1137 mac_selinux_create_file_clear();
1138
1139 if (fstat(fd, &st) < 0) {
1140 r = -errno;
1141 goto fail;
1142 }
1143
1144 if (!S_ISFIFO(st.st_mode) ||
1145 (st.st_mode & 0777) != (socket_mode & ~old_mask) ||
1146 st.st_uid != getuid() ||
1147 st.st_gid != getgid()) {
1148 r = -EEXIST;
1149 goto fail;
1150 }
1151
1152 return TAKE_FD(fd);
1153
1154 fail:
1155 mac_selinux_create_file_clear();
1156 return r;
1157 }
1158
1159 static int special_address_create(const char *path, bool writable) {
1160 _cleanup_close_ int fd = -EBADF;
1161 struct stat st;
1162
1163 assert(path);
1164
1165 fd = open(path, (writable ? O_RDWR : O_RDONLY)|O_CLOEXEC|O_NOCTTY|O_NONBLOCK|O_NOFOLLOW);
1166 if (fd < 0)
1167 return -errno;
1168
1169 if (fstat(fd, &st) < 0)
1170 return -errno;
1171
1172 /* Check whether this is a /proc, /sys or /dev file or char device */
1173 if (!S_ISREG(st.st_mode) && !S_ISCHR(st.st_mode))
1174 return -EEXIST;
1175
1176 return TAKE_FD(fd);
1177 }
1178
1179 static int usbffs_address_create(const char *path) {
1180 _cleanup_close_ int fd = -EBADF;
1181 struct stat st;
1182
1183 assert(path);
1184
1185 fd = open(path, O_RDWR|O_CLOEXEC|O_NOCTTY|O_NONBLOCK|O_NOFOLLOW);
1186 if (fd < 0)
1187 return -errno;
1188
1189 if (fstat(fd, &st) < 0)
1190 return -errno;
1191
1192 /* Check whether this is a regular file (ffs endpoint) */
1193 if (!S_ISREG(st.st_mode))
1194 return -EEXIST;
1195
1196 return TAKE_FD(fd);
1197 }
1198
1199 static int mq_address_create(
1200 const char *path,
1201 mode_t mq_mode,
1202 long maxmsg,
1203 long msgsize) {
1204
1205 _cleanup_close_ int fd = -EBADF;
1206 struct stat st;
1207 mode_t old_mask;
1208 struct mq_attr _attr, *attr = NULL;
1209
1210 assert(path);
1211
1212 if (maxmsg > 0 && msgsize > 0) {
1213 _attr = (struct mq_attr) {
1214 .mq_flags = O_NONBLOCK,
1215 .mq_maxmsg = maxmsg,
1216 .mq_msgsize = msgsize,
1217 };
1218 attr = &_attr;
1219 }
1220
1221 /* Enforce the right access mode for the mq */
1222 old_mask = umask(~mq_mode);
1223
1224 /* Include the original umask in our mask */
1225 (void) umask(~mq_mode | old_mask);
1226 fd = mq_open(path, O_RDONLY|O_CLOEXEC|O_NONBLOCK|O_CREAT, mq_mode, attr);
1227 (void) umask(old_mask);
1228
1229 if (fd < 0)
1230 return -errno;
1231
1232 if (fstat(fd, &st) < 0)
1233 return -errno;
1234
1235 if ((st.st_mode & 0777) != (mq_mode & ~old_mask) ||
1236 st.st_uid != getuid() ||
1237 st.st_gid != getgid())
1238 return -EEXIST;
1239
1240 return TAKE_FD(fd);
1241 }
1242
1243 static int socket_symlink(Socket *s) {
1244 const char *p;
1245 int r;
1246
1247 assert(s);
1248
1249 p = socket_find_symlink_target(s);
1250 if (!p)
1251 return 0;
1252
1253 STRV_FOREACH(i, s->symlinks) {
1254 (void) mkdir_parents_label(*i, s->directory_mode);
1255
1256 r = symlink_idempotent(p, *i, false);
1257
1258 if (r == -EEXIST && s->remove_on_stop) {
1259 /* If there's already something where we want to create the symlink, and the destructive
1260 * RemoveOnStop= mode is set, then we might as well try to remove what already exists and try
1261 * again. */
1262
1263 if (unlink(*i) >= 0)
1264 r = symlink_idempotent(p, *i, false);
1265 }
1266
1267 if (r < 0)
1268 log_unit_warning_errno(UNIT(s), r, "Failed to create symlink %s %s %s, ignoring: %m",
1269 p, special_glyph(SPECIAL_GLYPH_ARROW_RIGHT), *i);
1270 }
1271
1272 return 0;
1273 }
1274
1275 static int usbffs_write_descs(int fd, Service *s) {
1276 int r;
1277
1278 if (!s->usb_function_descriptors || !s->usb_function_strings)
1279 return -EINVAL;
1280
1281 r = copy_file_fd(s->usb_function_descriptors, fd, 0);
1282 if (r < 0)
1283 return r;
1284
1285 return copy_file_fd(s->usb_function_strings, fd, 0);
1286 }
1287
1288 static int usbffs_select_ep(const struct dirent *d) {
1289 return d->d_name[0] != '.' && !streq(d->d_name, "ep0");
1290 }
1291
1292 static int usbffs_dispatch_eps(SocketPort *p) {
1293 _cleanup_free_ struct dirent **ent = NULL;
1294 size_t n, k;
1295 int r;
1296
1297 r = scandir(p->path, &ent, usbffs_select_ep, alphasort);
1298 if (r < 0)
1299 return -errno;
1300
1301 n = (size_t) r;
1302 p->auxiliary_fds = new(int, n);
1303 if (!p->auxiliary_fds) {
1304 r = -ENOMEM;
1305 goto clear;
1306 }
1307
1308 p->n_auxiliary_fds = n;
1309
1310 k = 0;
1311 for (size_t i = 0; i < n; ++i) {
1312 _cleanup_free_ char *ep = NULL;
1313
1314 ep = path_make_absolute(ent[i]->d_name, p->path);
1315 if (!ep) {
1316 r = -ENOMEM;
1317 goto fail;
1318 }
1319
1320 path_simplify(ep);
1321
1322 r = usbffs_address_create(ep);
1323 if (r < 0)
1324 goto fail;
1325
1326 p->auxiliary_fds[k++] = r;
1327 }
1328
1329 r = 0;
1330 goto clear;
1331
1332 fail:
1333 close_many(p->auxiliary_fds, k);
1334 p->auxiliary_fds = mfree(p->auxiliary_fds);
1335 p->n_auxiliary_fds = 0;
1336
1337 clear:
1338 free_many((void**) ent, n);
1339 return r;
1340 }
1341
1342 int socket_load_service_unit(Socket *s, int cfd, Unit **ret) {
1343 /* Figure out what the unit that will be used to handle the connections on the socket looks like.
1344 *
1345 * If cfd < 0, then we don't have a connection yet. In case of Accept=yes sockets, use a fake
1346 * instance name.
1347 */
1348
1349 if (UNIT_ISSET(s->service)) {
1350 *ret = UNIT_DEREF(s->service);
1351 return 0;
1352 }
1353
1354 if (!s->accept)
1355 return -ENODATA;
1356
1357 /* Build the instance name and load the unit */
1358 _cleanup_free_ char *prefix = NULL, *instance = NULL, *name = NULL;
1359 int r;
1360
1361 r = unit_name_to_prefix(UNIT(s)->id, &prefix);
1362 if (r < 0)
1363 return r;
1364
1365 if (cfd >= 0) {
1366 r = instance_from_socket(cfd, s->n_accepted, &instance);
1367 if (r < 0) {
1368 if (ERRNO_IS_DISCONNECT(r))
1369 /* ENOTCONN is legitimate if TCP RST was received. Other socket families might return
1370 * different errors. This connection is over, but the socket unit lives on. */
1371 return log_unit_debug_errno(UNIT(s), r,
1372 "Got %s on incoming socket, assuming aborted connection attempt, ignoring.",
1373 errno_to_name(r));
1374 return r;
1375 }
1376 }
1377
1378 /* For accepting sockets, we don't know how the instance will be called until we get a connection and
1379 * can figure out what the peer name is. So let's use "internal" as the instance to make it clear
1380 * that this is not an actual peer name. We use "unknown" when we cannot figure out the peer. */
1381 r = unit_name_build(prefix, instance ?: "internal", ".service", &name);
1382 if (r < 0)
1383 return r;
1384
1385 return manager_load_unit(UNIT(s)->manager, name, NULL, NULL, ret);
1386 }
1387
1388 static int socket_determine_selinux_label(Socket *s, char **ret) {
1389 int r;
1390
1391 assert(s);
1392 assert(ret);
1393
1394 Unit *service;
1395 ExecCommand *c;
1396 const char *exec_context;
1397 _cleanup_free_ char *path = NULL;
1398
1399 r = socket_load_service_unit(s, -1, &service);
1400 if (r == -ENODATA)
1401 goto no_label;
1402 if (r < 0)
1403 return r;
1404
1405 exec_context = SERVICE(service)->exec_context.selinux_context;
1406 if (exec_context) {
1407 char *con;
1408
1409 con = strdup(exec_context);
1410 if (!con)
1411 return -ENOMEM;
1412
1413 *ret = TAKE_PTR(con);
1414 return 0;
1415 }
1416
1417 c = SERVICE(service)->exec_command[SERVICE_EXEC_START];
1418 if (!c)
1419 goto no_label;
1420
1421 r = chase(c->path, SERVICE(service)->exec_context.root_directory, CHASE_PREFIX_ROOT, &path, NULL);
1422 if (r < 0)
1423 goto no_label;
1424
1425 r = mac_selinux_get_create_label_from_exe(path, ret);
1426 if (IN_SET(r, -EPERM, -EOPNOTSUPP))
1427 goto no_label;
1428 return r;
1429
1430 no_label:
1431 *ret = NULL;
1432 return 0;
1433 }
1434
1435 static int socket_address_listen_do(
1436 Socket *s,
1437 const SocketAddress *address,
1438 const char *label) {
1439
1440 assert(s);
1441 assert(address);
1442
1443 return socket_address_listen(
1444 address,
1445 SOCK_CLOEXEC|SOCK_NONBLOCK,
1446 s->backlog,
1447 s->bind_ipv6_only,
1448 s->bind_to_device,
1449 s->reuse_port,
1450 s->free_bind,
1451 s->transparent,
1452 s->directory_mode,
1453 s->socket_mode,
1454 label);
1455 }
1456
1457 #define log_address_error_errno(u, address, error, fmt) \
1458 ({ \
1459 _cleanup_free_ char *_t = NULL; \
1460 \
1461 (void) socket_address_print(address, &_t); \
1462 log_unit_error_errno(u, error, fmt, strna(_t)); \
1463 })
1464
1465 static int fork_needed(const SocketAddress *address, Socket *s) {
1466 int r;
1467
1468 assert(address);
1469 assert(s);
1470
1471 /* Check if we need to do the cgroup or netns stuff. If not we can do things much simpler. */
1472
1473 /* If there are any NFTSet= directives with cgroup source, we need the cgroup */
1474 Unit *u = UNIT(s);
1475 CGroupContext *c = unit_get_cgroup_context(u);
1476 if (c)
1477 FOREACH_ARRAY(nft_set, c->nft_set_context.sets, c->nft_set_context.n_sets)
1478 if (nft_set->source == NFT_SET_SOURCE_CGROUP)
1479 return true;
1480
1481 if (IN_SET(address->sockaddr.sa.sa_family, AF_INET, AF_INET6)) {
1482 r = bpf_firewall_supported();
1483 if (r < 0)
1484 return r;
1485 if (r != BPF_FIREWALL_UNSUPPORTED) /* If BPF firewalling isn't supported anyway — there's no point in this forking complexity */
1486 return true;
1487 }
1488
1489 return exec_needs_network_namespace(&s->exec_context);
1490 }
1491
1492 static int socket_address_listen_in_cgroup(
1493 Socket *s,
1494 const SocketAddress *address,
1495 const char *label) {
1496
1497 _cleanup_(pidref_done) PidRef pid = PIDREF_NULL;
1498 _cleanup_close_pair_ int pair[2] = PIPE_EBADF;
1499 int fd, r;
1500
1501 assert(s);
1502 assert(address);
1503
1504 /* This is a wrapper around socket_address_listen(), that forks off a helper process inside the
1505 * socket's cgroup and network namespace in which the socket is actually created. This way we ensure
1506 * the socket is actually properly attached to the unit's cgroup for the purpose of BPF filtering and
1507 * such. */
1508
1509 r = fork_needed(address, s);
1510 if (r < 0)
1511 return r;
1512 if (r == 0) {
1513 /* Shortcut things... */
1514 fd = socket_address_listen_do(s, address, label);
1515 if (fd < 0)
1516 return log_address_error_errno(UNIT(s), address, fd, "Failed to create listening socket (%s): %m");
1517
1518 return fd;
1519 }
1520
1521 r = unit_setup_exec_runtime(UNIT(s));
1522 if (r < 0)
1523 return log_unit_error_errno(UNIT(s), r, "Failed acquire runtime: %m");
1524
1525 if (s->exec_context.network_namespace_path &&
1526 s->exec_runtime &&
1527 s->exec_runtime->shared &&
1528 s->exec_runtime->shared->netns_storage_socket[0] >= 0) {
1529 r = open_shareable_ns_path(s->exec_runtime->shared->netns_storage_socket, s->exec_context.network_namespace_path, CLONE_NEWNET);
1530 if (r < 0)
1531 return log_unit_error_errno(UNIT(s), r, "Failed to open network namespace path %s: %m", s->exec_context.network_namespace_path);
1532 }
1533
1534 if (s->exec_context.ipc_namespace_path &&
1535 s->exec_runtime &&
1536 s->exec_runtime->shared &&
1537 s->exec_runtime->shared->ipcns_storage_socket[0] >= 0) {
1538 r = open_shareable_ns_path(s->exec_runtime->shared->ipcns_storage_socket, s->exec_context.ipc_namespace_path, CLONE_NEWIPC);
1539 if (r < 0)
1540 return log_unit_error_errno(UNIT(s), r, "Failed to open IPC namespace path %s: %m", s->exec_context.ipc_namespace_path);
1541 }
1542
1543 if (socketpair(AF_UNIX, SOCK_SEQPACKET|SOCK_CLOEXEC, 0, pair) < 0)
1544 return log_unit_error_errno(UNIT(s), errno, "Failed to create communication channel: %m");
1545
1546 r = unit_fork_helper_process(UNIT(s), "(sd-listen)", &pid);
1547 if (r < 0)
1548 return log_unit_error_errno(UNIT(s), r, "Failed to fork off listener stub process: %m");
1549 if (r == 0) {
1550 /* Child */
1551
1552 pair[0] = safe_close(pair[0]);
1553
1554 if (exec_needs_network_namespace(&s->exec_context) &&
1555 s->exec_runtime &&
1556 s->exec_runtime->shared &&
1557 s->exec_runtime->shared->netns_storage_socket[0] >= 0) {
1558
1559 if (ns_type_supported(NAMESPACE_NET)) {
1560 r = setup_shareable_ns(s->exec_runtime->shared->netns_storage_socket, CLONE_NEWNET);
1561 if (r < 0) {
1562 log_unit_error_errno(UNIT(s), r, "Failed to join network namespace: %m");
1563 _exit(EXIT_NETWORK);
1564 }
1565 } else if (s->exec_context.network_namespace_path) {
1566 log_unit_error(UNIT(s), "Network namespace path configured but network namespaces not supported.");
1567 _exit(EXIT_NETWORK);
1568 } else
1569 log_unit_warning(UNIT(s), "PrivateNetwork=yes is configured, but the kernel does not support network namespaces, ignoring.");
1570 }
1571
1572 fd = socket_address_listen_do(s, address, label);
1573 if (fd < 0) {
1574 log_address_error_errno(UNIT(s), address, fd, "Failed to create listening socket (%s): %m");
1575 _exit(EXIT_FAILURE);
1576 }
1577
1578 r = send_one_fd(pair[1], fd, 0);
1579 if (r < 0) {
1580 log_address_error_errno(UNIT(s), address, r, "Failed to send listening socket (%s) to parent: %m");
1581 _exit(EXIT_FAILURE);
1582 }
1583
1584 _exit(EXIT_SUCCESS);
1585 }
1586
1587 pair[1] = safe_close(pair[1]);
1588 fd = receive_one_fd(pair[0], 0);
1589
1590 /* We synchronously wait for the helper, as it shouldn't be slow */
1591 r = wait_for_terminate_and_check("(sd-listen)", pid.pid, WAIT_LOG_ABNORMAL);
1592 if (r < 0) {
1593 safe_close(fd);
1594 return r;
1595 }
1596
1597 if (fd < 0)
1598 return log_address_error_errno(UNIT(s), address, fd, "Failed to receive listening socket (%s): %m");
1599
1600 return fd;
1601 }
1602
1603 DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(Socket *, socket_close_fds, NULL);
1604
1605 static int socket_open_fds(Socket *orig_s) {
1606 _cleanup_(socket_close_fdsp) Socket *s = orig_s;
1607 _cleanup_(mac_selinux_freep) char *label = NULL;
1608 bool know_label = false;
1609 int r;
1610
1611 assert(s);
1612
1613 LIST_FOREACH(port, p, s->ports) {
1614
1615 if (p->fd >= 0)
1616 continue;
1617
1618 switch (p->type) {
1619
1620 case SOCKET_SOCKET:
1621
1622 if (!know_label) {
1623 /* Figure out the label, if we don't it know yet. We do it once for the first
1624 * socket where we need this and remember it for the rest. */
1625
1626 r = socket_determine_selinux_label(s, &label);
1627 if (r < 0)
1628 return log_unit_error_errno(UNIT(s), r, "Failed to determine SELinux label: %m");
1629
1630 know_label = true;
1631 }
1632
1633 /* Apply the socket protocol */
1634 switch (p->address.type) {
1635
1636 case SOCK_STREAM:
1637 case SOCK_SEQPACKET:
1638 if (s->socket_protocol == IPPROTO_SCTP)
1639 p->address.protocol = s->socket_protocol;
1640 break;
1641
1642 case SOCK_DGRAM:
1643 if (s->socket_protocol == IPPROTO_UDPLITE)
1644 p->address.protocol = s->socket_protocol;
1645 break;
1646 }
1647
1648 p->fd = socket_address_listen_in_cgroup(s, &p->address, label);
1649 if (p->fd < 0)
1650 return p->fd;
1651
1652 socket_apply_socket_options(s, p, p->fd);
1653 socket_symlink(s);
1654 break;
1655
1656 case SOCKET_SPECIAL:
1657
1658 p->fd = special_address_create(p->path, s->writable);
1659 if (p->fd < 0)
1660 return log_unit_error_errno(UNIT(s), p->fd, "Failed to open special file %s: %m", p->path);
1661 break;
1662
1663 case SOCKET_FIFO:
1664
1665 p->fd = fifo_address_create(
1666 p->path,
1667 s->directory_mode,
1668 s->socket_mode);
1669 if (p->fd < 0)
1670 return log_unit_error_errno(UNIT(s), p->fd, "Failed to open FIFO %s: %m", p->path);
1671
1672 socket_apply_fifo_options(s, p->fd);
1673 socket_symlink(s);
1674 break;
1675
1676 case SOCKET_MQUEUE:
1677
1678 p->fd = mq_address_create(
1679 p->path,
1680 s->socket_mode,
1681 s->mq_maxmsg,
1682 s->mq_msgsize);
1683 if (p->fd < 0)
1684 return log_unit_error_errno(UNIT(s), p->fd, "Failed to open message queue %s: %m", p->path);
1685 break;
1686
1687 case SOCKET_USB_FUNCTION: {
1688 _cleanup_free_ char *ep = NULL;
1689
1690 ep = path_make_absolute("ep0", p->path);
1691 if (!ep)
1692 return -ENOMEM;
1693
1694 p->fd = usbffs_address_create(ep);
1695 if (p->fd < 0)
1696 return p->fd;
1697
1698 r = usbffs_write_descs(p->fd, SERVICE(UNIT_DEREF(s->service)));
1699 if (r < 0)
1700 return r;
1701
1702 r = usbffs_dispatch_eps(p);
1703 if (r < 0)
1704 return r;
1705
1706 break;
1707 }
1708 default:
1709 assert_not_reached();
1710 }
1711 }
1712
1713 s = NULL;
1714 return 0;
1715 }
1716
1717 static void socket_unwatch_fds(Socket *s) {
1718 int r;
1719
1720 assert(s);
1721
1722 LIST_FOREACH(port, p, s->ports) {
1723 if (p->fd < 0)
1724 continue;
1725
1726 if (!p->event_source)
1727 continue;
1728
1729 r = sd_event_source_set_enabled(p->event_source, SD_EVENT_OFF);
1730 if (r < 0)
1731 log_unit_debug_errno(UNIT(s), r, "Failed to disable event source: %m");
1732 }
1733 }
1734
1735 static int socket_watch_fds(Socket *s) {
1736 int r;
1737
1738 assert(s);
1739
1740 LIST_FOREACH(port, p, s->ports) {
1741 if (p->fd < 0)
1742 continue;
1743
1744 if (p->event_source) {
1745 r = sd_event_source_set_enabled(p->event_source, SD_EVENT_ON);
1746 if (r < 0)
1747 goto fail;
1748 } else {
1749 r = sd_event_add_io(UNIT(s)->manager->event, &p->event_source, p->fd, EPOLLIN, socket_dispatch_io, p);
1750 if (r < 0)
1751 goto fail;
1752
1753 (void) sd_event_source_set_description(p->event_source, "socket-port-io");
1754 }
1755
1756 r = sd_event_source_set_ratelimit(p->event_source, s->poll_limit_interval, s->poll_limit_burst);
1757 if (r < 0)
1758 log_unit_debug_errno(UNIT(s), r, "Failed to set poll limit on I/O event source, ignoring: %m");
1759 }
1760
1761 return 0;
1762
1763 fail:
1764 log_unit_warning_errno(UNIT(s), r, "Failed to watch listening fds: %m");
1765 socket_unwatch_fds(s);
1766 return r;
1767 }
1768
1769 enum {
1770 SOCKET_OPEN_NONE,
1771 SOCKET_OPEN_SOME,
1772 SOCKET_OPEN_ALL,
1773 };
1774
1775 static int socket_check_open(Socket *s) {
1776 bool have_open = false, have_closed = false;
1777
1778 assert(s);
1779
1780 LIST_FOREACH(port, p, s->ports) {
1781 if (p->fd < 0)
1782 have_closed = true;
1783 else
1784 have_open = true;
1785
1786 if (have_open && have_closed)
1787 return SOCKET_OPEN_SOME;
1788 }
1789
1790 if (have_open)
1791 return SOCKET_OPEN_ALL;
1792
1793 return SOCKET_OPEN_NONE;
1794 }
1795
1796 static void socket_set_state(Socket *s, SocketState state) {
1797 SocketState old_state;
1798 assert(s);
1799
1800 if (s->state != state)
1801 bus_unit_send_pending_change_signal(UNIT(s), false);
1802
1803 old_state = s->state;
1804 s->state = state;
1805
1806 if (!IN_SET(state,
1807 SOCKET_START_PRE,
1808 SOCKET_START_CHOWN,
1809 SOCKET_START_POST,
1810 SOCKET_STOP_PRE,
1811 SOCKET_STOP_PRE_SIGTERM,
1812 SOCKET_STOP_PRE_SIGKILL,
1813 SOCKET_STOP_POST,
1814 SOCKET_FINAL_SIGTERM,
1815 SOCKET_FINAL_SIGKILL,
1816 SOCKET_CLEANING)) {
1817
1818 s->timer_event_source = sd_event_source_disable_unref(s->timer_event_source);
1819 socket_unwatch_control_pid(s);
1820 s->control_command = NULL;
1821 s->control_command_id = _SOCKET_EXEC_COMMAND_INVALID;
1822 }
1823
1824 if (state != SOCKET_LISTENING)
1825 socket_unwatch_fds(s);
1826
1827 if (!IN_SET(state,
1828 SOCKET_START_CHOWN,
1829 SOCKET_START_POST,
1830 SOCKET_LISTENING,
1831 SOCKET_RUNNING,
1832 SOCKET_STOP_PRE,
1833 SOCKET_STOP_PRE_SIGTERM,
1834 SOCKET_STOP_PRE_SIGKILL,
1835 SOCKET_CLEANING))
1836 socket_close_fds(s);
1837
1838 if (state != old_state)
1839 log_unit_debug(UNIT(s), "Changed %s -> %s", socket_state_to_string(old_state), socket_state_to_string(state));
1840
1841 unit_notify(UNIT(s), state_translation_table[old_state], state_translation_table[state], /* reload_success = */ true);
1842 }
1843
1844 static int socket_coldplug(Unit *u) {
1845 Socket *s = SOCKET(u);
1846 int r;
1847
1848 assert(s);
1849 assert(s->state == SOCKET_DEAD);
1850
1851 if (s->deserialized_state == s->state)
1852 return 0;
1853
1854 if (pidref_is_set(&s->control_pid) &&
1855 pidref_is_unwaited(&s->control_pid) > 0 &&
1856 IN_SET(s->deserialized_state,
1857 SOCKET_START_PRE,
1858 SOCKET_START_CHOWN,
1859 SOCKET_START_POST,
1860 SOCKET_STOP_PRE,
1861 SOCKET_STOP_PRE_SIGTERM,
1862 SOCKET_STOP_PRE_SIGKILL,
1863 SOCKET_STOP_POST,
1864 SOCKET_FINAL_SIGTERM,
1865 SOCKET_FINAL_SIGKILL,
1866 SOCKET_CLEANING)) {
1867
1868 r = unit_watch_pidref(UNIT(s), &s->control_pid, /* exclusive= */ false);
1869 if (r < 0)
1870 return r;
1871
1872 r = socket_arm_timer(s, /* relative= */ false, usec_add(u->state_change_timestamp.monotonic, s->timeout_usec));
1873 if (r < 0)
1874 return r;
1875 }
1876
1877 if (IN_SET(s->deserialized_state,
1878 SOCKET_START_CHOWN,
1879 SOCKET_START_POST,
1880 SOCKET_LISTENING,
1881 SOCKET_RUNNING)) {
1882
1883 /* Originally, we used to simply reopen all sockets here that we didn't have file descriptors
1884 * for. However, this is problematic, as we won't traverse through the SOCKET_START_CHOWN state for
1885 * them, and thus the UID/GID wouldn't be right. Hence, instead simply check if we have all fds open,
1886 * and if there's a mismatch, warn loudly. */
1887
1888 r = socket_check_open(s);
1889 if (r == SOCKET_OPEN_NONE)
1890 log_unit_warning(UNIT(s),
1891 "Socket unit configuration has changed while unit has been running, "
1892 "no open socket file descriptor left. "
1893 "The socket unit is not functional until restarted.");
1894 else if (r == SOCKET_OPEN_SOME)
1895 log_unit_warning(UNIT(s),
1896 "Socket unit configuration has changed while unit has been running, "
1897 "and some socket file descriptors have not been opened yet. "
1898 "The socket unit is not fully functional until restarted.");
1899 }
1900
1901 if (s->deserialized_state == SOCKET_LISTENING) {
1902 r = socket_watch_fds(s);
1903 if (r < 0)
1904 return r;
1905 }
1906
1907 if (!IN_SET(s->deserialized_state, SOCKET_DEAD, SOCKET_FAILED, SOCKET_CLEANING))
1908 (void) unit_setup_exec_runtime(u);
1909
1910 socket_set_state(s, s->deserialized_state);
1911 return 0;
1912 }
1913
1914 static int socket_spawn(Socket *s, ExecCommand *c, PidRef *ret_pid) {
1915
1916 _cleanup_(exec_params_clear) ExecParameters exec_params = EXEC_PARAMETERS_INIT(
1917 EXEC_APPLY_SANDBOXING|EXEC_APPLY_CHROOT|EXEC_APPLY_TTY_STDIN);
1918 _cleanup_(pidref_done) PidRef pidref = PIDREF_NULL;
1919 pid_t pid;
1920 int r;
1921
1922 assert(s);
1923 assert(c);
1924 assert(ret_pid);
1925
1926 r = unit_prepare_exec(UNIT(s));
1927 if (r < 0)
1928 return r;
1929
1930 r = socket_arm_timer(s, /* relative= */ true, s->timeout_usec);
1931 if (r < 0)
1932 return r;
1933
1934 r = unit_set_exec_params(UNIT(s), &exec_params);
1935 if (r < 0)
1936 return r;
1937
1938 r = exec_spawn(UNIT(s),
1939 c,
1940 &s->exec_context,
1941 &exec_params,
1942 s->exec_runtime,
1943 &s->cgroup_context,
1944 &pid);
1945 if (r < 0)
1946 return r;
1947
1948 r = pidref_set_pid(&pidref, pid);
1949 if (r < 0)
1950 return r;
1951
1952 r = unit_watch_pidref(UNIT(s), &pidref, /* exclusive= */ true);
1953 if (r < 0)
1954 return r;
1955
1956 *ret_pid = TAKE_PIDREF(pidref);
1957 return 0;
1958 }
1959
1960 static int socket_chown(Socket *s, PidRef *ret_pid) {
1961 _cleanup_(pidref_done) PidRef pid = PIDREF_NULL;
1962 int r;
1963
1964 assert(s);
1965
1966 r = socket_arm_timer(s, /* relative= */ true, s->timeout_usec);
1967 if (r < 0)
1968 return r;
1969
1970 /* We have to resolve the user names out-of-process, hence
1971 * let's fork here. It's messy, but well, what can we do? */
1972
1973 r = unit_fork_helper_process(UNIT(s), "(sd-chown)", &pid);
1974 if (r < 0)
1975 return r;
1976 if (r == 0) {
1977 uid_t uid = UID_INVALID;
1978 gid_t gid = GID_INVALID;
1979
1980 /* Child */
1981
1982 if (!isempty(s->user)) {
1983 const char *user = s->user;
1984
1985 r = get_user_creds(&user, &uid, &gid, NULL, NULL, 0);
1986 if (r < 0) {
1987 log_unit_error_errno(UNIT(s), r, "Failed to resolve user %s: %m", user);
1988 _exit(EXIT_USER);
1989 }
1990 }
1991
1992 if (!isempty(s->group)) {
1993 const char *group = s->group;
1994
1995 r = get_group_creds(&group, &gid, 0);
1996 if (r < 0) {
1997 log_unit_error_errno(UNIT(s), r, "Failed to resolve group %s: %m", group);
1998 _exit(EXIT_GROUP);
1999 }
2000 }
2001
2002 LIST_FOREACH(port, p, s->ports) {
2003 const char *path = NULL;
2004
2005 if (p->type == SOCKET_SOCKET)
2006 path = socket_address_get_path(&p->address);
2007 else if (p->type == SOCKET_FIFO)
2008 path = p->path;
2009
2010 if (!path)
2011 continue;
2012
2013 if (chown(path, uid, gid) < 0) {
2014 log_unit_error_errno(UNIT(s), errno, "Failed to chown(): %m");
2015 _exit(EXIT_CHOWN);
2016 }
2017 }
2018
2019 _exit(EXIT_SUCCESS);
2020 }
2021
2022 r = unit_watch_pidref(UNIT(s), &pid, /* exclusive= */ true);
2023 if (r < 0)
2024 return r;
2025
2026 *ret_pid = TAKE_PIDREF(pid);
2027 return 0;
2028 }
2029
2030 static void socket_enter_dead(Socket *s, SocketResult f) {
2031 assert(s);
2032
2033 if (s->result == SOCKET_SUCCESS)
2034 s->result = f;
2035
2036 if (s->result == SOCKET_SUCCESS)
2037 unit_log_success(UNIT(s));
2038 else
2039 unit_log_failure(UNIT(s), socket_result_to_string(s->result));
2040
2041 unit_warn_leftover_processes(UNIT(s), unit_log_leftover_process_stop);
2042
2043 socket_set_state(s, s->result != SOCKET_SUCCESS ? SOCKET_FAILED : SOCKET_DEAD);
2044
2045 s->exec_runtime = exec_runtime_destroy(s->exec_runtime);
2046
2047 unit_destroy_runtime_data(UNIT(s), &s->exec_context);
2048
2049 unit_unref_uid_gid(UNIT(s), true);
2050 }
2051
2052 static void socket_enter_signal(Socket *s, SocketState state, SocketResult f);
2053
2054 static void socket_enter_stop_post(Socket *s, SocketResult f) {
2055 int r;
2056 assert(s);
2057
2058 if (s->result == SOCKET_SUCCESS)
2059 s->result = f;
2060
2061 socket_unwatch_control_pid(s);
2062 s->control_command_id = SOCKET_EXEC_STOP_POST;
2063 s->control_command = s->exec_command[SOCKET_EXEC_STOP_POST];
2064
2065 if (s->control_command) {
2066 pidref_done(&s->control_pid);
2067
2068 r = socket_spawn(s, s->control_command, &s->control_pid);
2069 if (r < 0) {
2070 log_unit_warning_errno(UNIT(s), r, "Failed to spawn 'stop-post' task: %m");
2071 socket_enter_signal(s, SOCKET_FINAL_SIGTERM, SOCKET_FAILURE_RESOURCES);
2072 return;
2073 }
2074
2075 socket_set_state(s, SOCKET_STOP_POST);
2076 } else
2077 socket_enter_signal(s, SOCKET_FINAL_SIGTERM, SOCKET_SUCCESS);
2078 }
2079
2080 static int state_to_kill_operation(Socket *s, SocketState state) {
2081 if (state == SOCKET_STOP_PRE_SIGTERM && unit_has_job_type(UNIT(s), JOB_RESTART))
2082 return KILL_RESTART;
2083
2084 if (state == SOCKET_FINAL_SIGTERM)
2085 return KILL_TERMINATE;
2086
2087 return KILL_KILL;
2088 }
2089
2090 static void socket_enter_signal(Socket *s, SocketState state, SocketResult f) {
2091 int r;
2092
2093 assert(s);
2094
2095 if (s->result == SOCKET_SUCCESS)
2096 s->result = f;
2097
2098 r = unit_kill_context(
2099 UNIT(s),
2100 &s->kill_context,
2101 state_to_kill_operation(s, state),
2102 /* main_pid= */ NULL,
2103 &s->control_pid,
2104 /* main_pid_alien= */ false);
2105 if (r < 0) {
2106 log_unit_warning_errno(UNIT(s), r, "Failed to kill processes: %m");
2107 goto fail;
2108 }
2109
2110 if (r > 0) {
2111 r = socket_arm_timer(s, /* relative= */ true, s->timeout_usec);
2112 if (r < 0) {
2113 log_unit_warning_errno(UNIT(s), r, "Failed to install timer: %m");
2114 goto fail;
2115 }
2116
2117 socket_set_state(s, state);
2118 } else if (state == SOCKET_STOP_PRE_SIGTERM)
2119 socket_enter_signal(s, SOCKET_STOP_PRE_SIGKILL, SOCKET_SUCCESS);
2120 else if (state == SOCKET_STOP_PRE_SIGKILL)
2121 socket_enter_stop_post(s, SOCKET_SUCCESS);
2122 else if (state == SOCKET_FINAL_SIGTERM)
2123 socket_enter_signal(s, SOCKET_FINAL_SIGKILL, SOCKET_SUCCESS);
2124 else
2125 socket_enter_dead(s, SOCKET_SUCCESS);
2126
2127 return;
2128
2129 fail:
2130 if (IN_SET(state, SOCKET_STOP_PRE_SIGTERM, SOCKET_STOP_PRE_SIGKILL))
2131 socket_enter_stop_post(s, SOCKET_FAILURE_RESOURCES);
2132 else
2133 socket_enter_dead(s, SOCKET_FAILURE_RESOURCES);
2134 }
2135
2136 static void socket_enter_stop_pre(Socket *s, SocketResult f) {
2137 int r;
2138 assert(s);
2139
2140 if (s->result == SOCKET_SUCCESS)
2141 s->result = f;
2142
2143 socket_unwatch_control_pid(s);
2144 s->control_command_id = SOCKET_EXEC_STOP_PRE;
2145 s->control_command = s->exec_command[SOCKET_EXEC_STOP_PRE];
2146
2147 if (s->control_command) {
2148 pidref_done(&s->control_pid);
2149
2150 r = socket_spawn(s, s->control_command, &s->control_pid);
2151 if (r < 0) {
2152 log_unit_warning_errno(UNIT(s), r, "Failed to spawn 'stop-pre' task: %m");
2153 socket_enter_stop_post(s, SOCKET_FAILURE_RESOURCES);
2154 return;
2155 }
2156
2157 socket_set_state(s, SOCKET_STOP_PRE);
2158 } else
2159 socket_enter_stop_post(s, SOCKET_SUCCESS);
2160 }
2161
2162 static void socket_enter_listening(Socket *s) {
2163 int r;
2164 assert(s);
2165
2166 if (!s->accept && s->flush_pending) {
2167 log_unit_debug(UNIT(s), "Flushing socket before listening.");
2168 flush_ports(s);
2169 }
2170
2171 r = socket_watch_fds(s);
2172 if (r < 0) {
2173 log_unit_warning_errno(UNIT(s), r, "Failed to watch sockets: %m");
2174 socket_enter_stop_pre(s, SOCKET_FAILURE_RESOURCES);
2175 return;
2176 }
2177
2178 socket_set_state(s, SOCKET_LISTENING);
2179 }
2180
2181 static void socket_enter_start_post(Socket *s) {
2182 int r;
2183 assert(s);
2184
2185 socket_unwatch_control_pid(s);
2186 s->control_command_id = SOCKET_EXEC_START_POST;
2187 s->control_command = s->exec_command[SOCKET_EXEC_START_POST];
2188
2189 if (s->control_command) {
2190 pidref_done(&s->control_pid);
2191
2192 r = socket_spawn(s, s->control_command, &s->control_pid);
2193 if (r < 0) {
2194 log_unit_warning_errno(UNIT(s), r, "Failed to spawn 'start-post' task: %m");
2195 socket_enter_stop_pre(s, SOCKET_FAILURE_RESOURCES);
2196 return;
2197 }
2198
2199 socket_set_state(s, SOCKET_START_POST);
2200 } else
2201 socket_enter_listening(s);
2202 }
2203
2204 static void socket_enter_start_chown(Socket *s) {
2205 int r;
2206
2207 assert(s);
2208
2209 r = socket_open_fds(s);
2210 if (r < 0) {
2211 log_unit_warning_errno(UNIT(s), r, "Failed to listen on sockets: %m");
2212 goto fail;
2213 }
2214
2215 if (!isempty(s->user) || !isempty(s->group)) {
2216
2217 socket_unwatch_control_pid(s);
2218 s->control_command_id = SOCKET_EXEC_START_CHOWN;
2219 s->control_command = NULL;
2220
2221 r = socket_chown(s, &s->control_pid);
2222 if (r < 0) {
2223 log_unit_warning_errno(UNIT(s), r, "Failed to spawn 'start-chown' task: %m");
2224 goto fail;
2225 }
2226
2227 socket_set_state(s, SOCKET_START_CHOWN);
2228 } else
2229 socket_enter_start_post(s);
2230
2231 return;
2232
2233 fail:
2234 socket_enter_stop_pre(s, SOCKET_FAILURE_RESOURCES);
2235 }
2236
2237 static void socket_enter_start_pre(Socket *s) {
2238 int r;
2239 assert(s);
2240
2241 socket_unwatch_control_pid(s);
2242
2243 unit_warn_leftover_processes(UNIT(s), unit_log_leftover_process_start);
2244
2245 s->control_command_id = SOCKET_EXEC_START_PRE;
2246 s->control_command = s->exec_command[SOCKET_EXEC_START_PRE];
2247
2248 if (s->control_command) {
2249 pidref_done(&s->control_pid);
2250
2251 r = socket_spawn(s, s->control_command, &s->control_pid);
2252 if (r < 0) {
2253 log_unit_warning_errno(UNIT(s), r, "Failed to spawn 'start-pre' task: %m");
2254 socket_enter_dead(s, SOCKET_FAILURE_RESOURCES);
2255 return;
2256 }
2257
2258 socket_set_state(s, SOCKET_START_PRE);
2259 } else
2260 socket_enter_start_chown(s);
2261 }
2262
2263 static void flush_ports(Socket *s) {
2264 assert(s);
2265
2266 /* Flush all incoming traffic, regardless if actual bytes or new connections, so that this socket isn't busy
2267 * anymore */
2268
2269 LIST_FOREACH(port, p, s->ports) {
2270 if (p->fd < 0)
2271 continue;
2272
2273 (void) flush_accept(p->fd);
2274 (void) flush_fd(p->fd);
2275 }
2276 }
2277
2278 static void socket_enter_running(Socket *s, int cfd_in) {
2279 /* Note that this call takes possession of the connection fd passed. It either has to assign it
2280 * somewhere or close it. */
2281 _cleanup_close_ int cfd = cfd_in;
2282
2283 _cleanup_(sd_bus_error_free) sd_bus_error error = SD_BUS_ERROR_NULL;
2284 int r;
2285
2286 assert(s);
2287
2288 /* We don't take connections anymore if we are supposed to shut down anyway */
2289 if (unit_stop_pending(UNIT(s))) {
2290
2291 log_unit_debug(UNIT(s), "Suppressing connection request since unit stop is scheduled.");
2292
2293 if (cfd >= 0)
2294 goto refuse;
2295
2296 flush_ports(s);
2297 return;
2298 }
2299
2300 if (!ratelimit_below(&s->trigger_limit)) {
2301 log_unit_warning(UNIT(s), "Trigger limit hit, refusing further activation.");
2302 socket_enter_stop_pre(s, SOCKET_FAILURE_TRIGGER_LIMIT_HIT);
2303 goto refuse;
2304 }
2305
2306 if (cfd < 0) { /* Accept=no case */
2307 bool pending = false;
2308 Unit *other;
2309
2310 /* If there's already a start pending don't bother to do anything */
2311 UNIT_FOREACH_DEPENDENCY(other, UNIT(s), UNIT_ATOM_TRIGGERS)
2312 if (unit_active_or_pending(other)) {
2313 pending = true;
2314 break;
2315 }
2316
2317 if (!pending) {
2318 if (!UNIT_ISSET(s->service)) {
2319 r = log_unit_warning_errno(UNIT(s), SYNTHETIC_ERRNO(ENOENT),
2320 "Service to activate vanished, refusing activation.");
2321 goto fail;
2322 }
2323
2324 r = manager_add_job(UNIT(s)->manager, JOB_START, UNIT_DEREF(s->service), JOB_REPLACE, NULL, &error, NULL);
2325 if (r < 0)
2326 goto queue_error;
2327 }
2328
2329 socket_set_state(s, SOCKET_RUNNING);
2330 } else { /* Accept=yes case */
2331 _cleanup_(socket_peer_unrefp) SocketPeer *p = NULL;
2332 Unit *service;
2333
2334 if (s->n_connections >= s->max_connections) {
2335 log_unit_warning(UNIT(s), "Too many incoming connections (%u), dropping connection.",
2336 s->n_connections);
2337 goto refuse;
2338 }
2339
2340 if (s->max_connections_per_source > 0) {
2341 r = socket_acquire_peer(s, cfd, &p);
2342 if (r < 0) {
2343 if (ERRNO_IS_DISCONNECT(r))
2344 return;
2345 /* We didn't have enough resources to acquire peer information, let's fail. */
2346 goto fail;
2347 }
2348 if (r > 0 && p->n_ref > s->max_connections_per_source) {
2349 _cleanup_free_ char *t = NULL;
2350
2351 (void) sockaddr_pretty(&p->peer.sa, p->peer_salen, true, false, &t);
2352
2353 log_unit_warning(UNIT(s),
2354 "Too many incoming connections (%u) from source %s, dropping connection.",
2355 p->n_ref, strnull(t));
2356 goto refuse;
2357 }
2358 }
2359
2360 r = socket_load_service_unit(s, cfd, &service);
2361 if (r < 0) {
2362 if (ERRNO_IS_DISCONNECT(r))
2363 return;
2364
2365 log_unit_warning_errno(UNIT(s), r, "Failed to load connection service unit: %m");
2366 goto fail;
2367 }
2368
2369 r = unit_add_two_dependencies(UNIT(s), UNIT_BEFORE, UNIT_TRIGGERS, service,
2370 false, UNIT_DEPENDENCY_IMPLICIT);
2371 if (r < 0) {
2372 log_unit_warning_errno(UNIT(s), r, "Failed to add Before=/Triggers= dependencies on connection unit: %m");
2373 goto fail;
2374 }
2375
2376 s->n_accepted++;
2377
2378 r = service_set_socket_fd(SERVICE(service), cfd, s, p, s->selinux_context_from_net);
2379 if (r < 0) {
2380 if (ERRNO_IS_DISCONNECT(r))
2381 return;
2382
2383 log_unit_warning_errno(UNIT(s), r, "Failed to set socket on service: %m");
2384 goto fail;
2385 }
2386
2387 TAKE_FD(cfd); /* We passed ownership of the fd to the service now. Forget it here. */
2388 s->n_connections++;
2389
2390 r = manager_add_job(UNIT(s)->manager, JOB_START, service, JOB_REPLACE, NULL, &error, NULL);
2391 if (r < 0) {
2392 /* We failed to activate the new service, but it still exists. Let's make sure the
2393 * service closes and forgets the connection fd again, immediately. */
2394 service_release_socket_fd(SERVICE(service));
2395 goto queue_error;
2396 }
2397
2398 /* Notify clients about changed counters */
2399 unit_add_to_dbus_queue(UNIT(s));
2400 }
2401
2402 return;
2403
2404 refuse:
2405 s->n_refused++;
2406 return;
2407
2408 queue_error:
2409 if (ERRNO_IS_RESOURCE(r))
2410 log_unit_warning(UNIT(s), "Failed to queue service startup job: %s",
2411 bus_error_message(&error, r));
2412 else
2413 log_unit_warning(UNIT(s), "Failed to queue service startup job (Maybe the service file is missing or not a %s unit?): %s",
2414 cfd >= 0 ? "template" : "non-template",
2415 bus_error_message(&error, r));
2416
2417 fail:
2418 socket_enter_stop_pre(s, SOCKET_FAILURE_RESOURCES);
2419 }
2420
2421 static void socket_run_next(Socket *s) {
2422 int r;
2423
2424 assert(s);
2425 assert(s->control_command);
2426 assert(s->control_command->command_next);
2427
2428 socket_unwatch_control_pid(s);
2429
2430 s->control_command = s->control_command->command_next;
2431
2432 pidref_done(&s->control_pid);
2433
2434 r = socket_spawn(s, s->control_command, &s->control_pid);
2435 if (r < 0) {
2436 log_unit_warning_errno(UNIT(s), r, "Failed to spawn next task: %m");
2437
2438 if (s->state == SOCKET_START_POST)
2439 socket_enter_stop_pre(s, SOCKET_FAILURE_RESOURCES);
2440 else if (s->state == SOCKET_STOP_POST)
2441 socket_enter_dead(s, SOCKET_FAILURE_RESOURCES);
2442 else
2443 socket_enter_signal(s, SOCKET_FINAL_SIGTERM, SOCKET_FAILURE_RESOURCES);
2444 }
2445 }
2446
2447 static int socket_start(Unit *u) {
2448 Socket *s = SOCKET(u);
2449 int r;
2450
2451 assert(s);
2452
2453 /* We cannot fulfill this request right now, try again later
2454 * please! */
2455 if (IN_SET(s->state,
2456 SOCKET_STOP_PRE,
2457 SOCKET_STOP_PRE_SIGKILL,
2458 SOCKET_STOP_PRE_SIGTERM,
2459 SOCKET_STOP_POST,
2460 SOCKET_FINAL_SIGTERM,
2461 SOCKET_FINAL_SIGKILL,
2462 SOCKET_CLEANING))
2463 return -EAGAIN;
2464
2465 /* Already on it! */
2466 if (IN_SET(s->state,
2467 SOCKET_START_PRE,
2468 SOCKET_START_CHOWN,
2469 SOCKET_START_POST))
2470 return 0;
2471
2472 /* Cannot run this without the service being around */
2473 if (UNIT_ISSET(s->service)) {
2474 Service *service;
2475
2476 service = SERVICE(UNIT_DEREF(s->service));
2477
2478 if (UNIT(service)->load_state != UNIT_LOADED)
2479 return log_unit_error_errno(u, SYNTHETIC_ERRNO(ENOENT),
2480 "Socket service %s not loaded, refusing.", UNIT(service)->id);
2481
2482 /* If the service is already active we cannot start the
2483 * socket */
2484 if (!IN_SET(service->state,
2485 SERVICE_DEAD, SERVICE_DEAD_BEFORE_AUTO_RESTART, SERVICE_FAILED, SERVICE_FAILED_BEFORE_AUTO_RESTART,
2486 SERVICE_AUTO_RESTART, SERVICE_AUTO_RESTART_QUEUED))
2487 return log_unit_error_errno(u, SYNTHETIC_ERRNO(EBUSY),
2488 "Socket service %s already active, refusing.", UNIT(service)->id);
2489 }
2490
2491 assert(IN_SET(s->state, SOCKET_DEAD, SOCKET_FAILED));
2492
2493 r = unit_acquire_invocation_id(u);
2494 if (r < 0)
2495 return r;
2496
2497 s->result = SOCKET_SUCCESS;
2498 exec_command_reset_status_list_array(s->exec_command, _SOCKET_EXEC_COMMAND_MAX);
2499
2500 u->reset_accounting = true;
2501
2502 socket_enter_start_pre(s);
2503 return 1;
2504 }
2505
2506 static int socket_stop(Unit *u) {
2507 Socket *s = SOCKET(u);
2508
2509 assert(s);
2510
2511 /* Already on it */
2512 if (IN_SET(s->state,
2513 SOCKET_STOP_PRE,
2514 SOCKET_STOP_PRE_SIGTERM,
2515 SOCKET_STOP_PRE_SIGKILL,
2516 SOCKET_STOP_POST,
2517 SOCKET_FINAL_SIGTERM,
2518 SOCKET_FINAL_SIGKILL))
2519 return 0;
2520
2521 /* If there's already something running we go directly into
2522 * kill mode. */
2523 if (IN_SET(s->state,
2524 SOCKET_START_PRE,
2525 SOCKET_START_CHOWN,
2526 SOCKET_START_POST)) {
2527 socket_enter_signal(s, SOCKET_STOP_PRE_SIGTERM, SOCKET_SUCCESS);
2528 return -EAGAIN;
2529 }
2530
2531 /* If we are currently cleaning, then abort it, brutally. */
2532 if (s->state == SOCKET_CLEANING) {
2533 socket_enter_signal(s, SOCKET_FINAL_SIGKILL, SOCKET_SUCCESS);
2534 return 0;
2535 }
2536
2537 assert(IN_SET(s->state, SOCKET_LISTENING, SOCKET_RUNNING));
2538
2539 socket_enter_stop_pre(s, SOCKET_SUCCESS);
2540 return 1;
2541 }
2542
2543 static int socket_serialize(Unit *u, FILE *f, FDSet *fds) {
2544 Socket *s = SOCKET(u);
2545 int r;
2546
2547 assert(u);
2548 assert(f);
2549 assert(fds);
2550
2551 (void) serialize_item(f, "state", socket_state_to_string(s->state));
2552 (void) serialize_item(f, "result", socket_result_to_string(s->result));
2553 (void) serialize_item_format(f, "n-accepted", "%u", s->n_accepted);
2554 (void) serialize_item_format(f, "n-refused", "%u", s->n_refused);
2555 (void) serialize_pidref(f, fds, "control-pid", &s->control_pid);
2556
2557 if (s->control_command_id >= 0)
2558 (void) serialize_item(f, "control-command", socket_exec_command_to_string(s->control_command_id));
2559
2560 LIST_FOREACH(port, p, s->ports) {
2561 int copy;
2562
2563 if (p->fd < 0)
2564 continue;
2565
2566 copy = fdset_put_dup(fds, p->fd);
2567 if (copy < 0)
2568 return log_unit_warning_errno(u, copy, "Failed to serialize socket fd: %m");
2569
2570 if (p->type == SOCKET_SOCKET) {
2571 _cleanup_free_ char *t = NULL;
2572
2573 r = socket_address_print(&p->address, &t);
2574 if (r < 0)
2575 return log_unit_error_errno(u, r, "Failed to format socket address: %m");
2576
2577 if (socket_address_family(&p->address) == AF_NETLINK)
2578 (void) serialize_item_format(f, "netlink", "%i %s", copy, t);
2579 else
2580 (void) serialize_item_format(f, "socket", "%i %i %s", copy, p->address.type, t);
2581 } else if (p->type == SOCKET_SPECIAL)
2582 (void) serialize_item_format(f, "special", "%i %s", copy, p->path);
2583 else if (p->type == SOCKET_MQUEUE)
2584 (void) serialize_item_format(f, "mqueue", "%i %s", copy, p->path);
2585 else if (p->type == SOCKET_USB_FUNCTION)
2586 (void) serialize_item_format(f, "ffs", "%i %s", copy, p->path);
2587 else {
2588 assert(p->type == SOCKET_FIFO);
2589 (void) serialize_item_format(f, "fifo", "%i %s", copy, p->path);
2590 }
2591 }
2592
2593 return 0;
2594 }
2595
2596 static int socket_deserialize_item(Unit *u, const char *key, const char *value, FDSet *fds) {
2597 Socket *s = SOCKET(u);
2598 int r;
2599
2600 assert(u);
2601 assert(key);
2602 assert(value);
2603
2604 if (streq(key, "state")) {
2605 SocketState state;
2606
2607 state = socket_state_from_string(value);
2608 if (state < 0)
2609 log_unit_debug(u, "Failed to parse state value: %s", value);
2610 else
2611 s->deserialized_state = state;
2612 } else if (streq(key, "result")) {
2613 SocketResult f;
2614
2615 f = socket_result_from_string(value);
2616 if (f < 0)
2617 log_unit_debug(u, "Failed to parse result value: %s", value);
2618 else if (f != SOCKET_SUCCESS)
2619 s->result = f;
2620
2621 } else if (streq(key, "n-accepted")) {
2622 unsigned k;
2623
2624 if (safe_atou(value, &k) < 0)
2625 log_unit_debug(u, "Failed to parse n-accepted value: %s", value);
2626 else
2627 s->n_accepted += k;
2628 } else if (streq(key, "n-refused")) {
2629 unsigned k;
2630
2631 if (safe_atou(value, &k) < 0)
2632 log_unit_debug(u, "Failed to parse n-refused value: %s", value);
2633 else
2634 s->n_refused += k;
2635 } else if (streq(key, "control-pid")) {
2636 pidref_done(&s->control_pid);
2637 (void) deserialize_pidref(fds, value, &s->control_pid);
2638
2639 } else if (streq(key, "control-command")) {
2640 SocketExecCommand id;
2641
2642 id = socket_exec_command_from_string(value);
2643 if (id < 0)
2644 log_unit_debug(u, "Failed to parse exec-command value: %s", value);
2645 else {
2646 s->control_command_id = id;
2647 s->control_command = s->exec_command[id];
2648 }
2649 } else if (streq(key, "fifo")) {
2650 _cleanup_free_ char *fdv = NULL;
2651 bool found = false;
2652 int fd;
2653
2654 r = extract_first_word(&value, &fdv, NULL, 0);
2655 if (r <= 0) {
2656 log_unit_debug(u, "Failed to parse fifo value: %s", value);
2657 return 0;
2658 }
2659
2660 fd = parse_fd(fdv);
2661 if (fd < 0 || !fdset_contains(fds, fd)) {
2662 log_unit_debug(u, "Invalid fifo value: %s", fdv);
2663 return 0;
2664 }
2665
2666 LIST_FOREACH(port, p, s->ports)
2667 if (p->fd < 0 &&
2668 p->type == SOCKET_FIFO &&
2669 path_equal_or_inode_same(p->path, value, 0)) {
2670 p->fd = fdset_remove(fds, fd);
2671 found = true;
2672 break;
2673 }
2674 if (!found)
2675 log_unit_debug(u, "No matching fifo socket found: %s", value);
2676
2677 } else if (streq(key, "special")) {
2678 _cleanup_free_ char *fdv = NULL;
2679 bool found = false;
2680 int fd;
2681
2682 r = extract_first_word(&value, &fdv, NULL, 0);
2683 if (r <= 0) {
2684 log_unit_debug(u, "Failed to parse special value: %s", value);
2685 return 0;
2686 }
2687
2688 fd = parse_fd(fdv);
2689 if (fd < 0 || !fdset_contains(fds, fd)) {
2690 log_unit_debug(u, "Invalid special value: %s", fdv);
2691 return 0;
2692 }
2693
2694 LIST_FOREACH(port, p, s->ports)
2695 if (p->fd < 0 &&
2696 p->type == SOCKET_SPECIAL &&
2697 path_equal_or_inode_same(p->path, value, 0)) {
2698 p->fd = fdset_remove(fds, fd);
2699 found = true;
2700 break;
2701 }
2702 if (!found)
2703 log_unit_debug(u, "No matching special socket found: %s", value);
2704
2705 } else if (streq(key, "mqueue")) {
2706 _cleanup_free_ char *fdv = NULL;
2707 bool found = false;
2708 int fd;
2709
2710 r = extract_first_word(&value, &fdv, NULL, 0);
2711 if (r <= 0) {
2712 log_unit_debug(u, "Failed to parse mqueue value: %s", value);
2713 return 0;
2714 }
2715
2716 fd = parse_fd(fdv);
2717 if (fd < 0 || !fdset_contains(fds, fd)) {
2718 log_unit_debug(u, "Invalid mqueue value: %s", fdv);
2719 return 0;
2720 }
2721
2722 LIST_FOREACH(port, p, s->ports)
2723 if (p->fd < 0 &&
2724 p->type == SOCKET_MQUEUE &&
2725 streq(p->path, value)) {
2726 p->fd = fdset_remove(fds, fd);
2727 found = true;
2728 break;
2729 }
2730 if (!found)
2731 log_unit_debug(u, "No matching mqueue socket found: %s", value);
2732
2733 } else if (streq(key, "socket")) {
2734 _cleanup_free_ char *fdv = NULL, *typev = NULL;
2735 bool found = false;
2736 int fd, type;
2737
2738 r = extract_first_word(&value, &fdv, NULL, 0);
2739 if (r <= 0) {
2740 log_unit_debug(u, "Failed to parse socket fd from value: %s", value);
2741 return 0;
2742 }
2743
2744 fd = parse_fd(fdv);
2745 if (fd < 0 || !fdset_contains(fds, fd)) {
2746 log_unit_debug(u, "Invalid socket fd: %s", fdv);
2747 return 0;
2748 }
2749
2750 r = extract_first_word(&value, &typev, NULL, 0);
2751 if (r <= 0) {
2752 log_unit_debug(u, "Failed to parse socket type from value: %s", value);
2753 return 0;
2754 }
2755
2756 if (safe_atoi(typev, &type) < 0 || type < 0) {
2757 log_unit_debug(u, "Invalid socket type: %s", typev);
2758 return 0;
2759 }
2760
2761 LIST_FOREACH(port, p, s->ports)
2762 if (p->fd < 0 &&
2763 socket_address_is(&p->address, value, type)) {
2764 p->fd = fdset_remove(fds, fd);
2765 found = true;
2766 break;
2767 }
2768 if (!found)
2769 log_unit_debug(u, "No matching %s socket found: %s",
2770 socket_address_type_to_string(type), value);
2771
2772 } else if (streq(key, "netlink")) {
2773 _cleanup_free_ char *fdv = NULL;
2774 bool found = false;
2775 int fd;
2776
2777 r = extract_first_word(&value, &fdv, NULL, 0);
2778 if (r <= 0) {
2779 log_unit_debug(u, "Failed to parse socket value: %s", value);
2780 return 0;
2781 }
2782
2783 fd = parse_fd(fdv);
2784 if (fd < 0 || !fdset_contains(fds, fd)) {
2785 log_unit_debug(u, "Invalid socket value: %s", fdv);
2786 return 0;
2787 }
2788
2789 LIST_FOREACH(port, p, s->ports)
2790 if (p->fd < 0 &&
2791 socket_address_is_netlink(&p->address, value)) {
2792 p->fd = fdset_remove(fds, fd);
2793 found = true;
2794 break;
2795 }
2796 if (!found)
2797 log_unit_debug(u, "No matching netlink socket found: %s", value);
2798
2799 } else if (streq(key, "ffs")) {
2800 _cleanup_free_ char *fdv = NULL;
2801 bool found = false;
2802 int fd;
2803
2804 r = extract_first_word(&value, &fdv, NULL, 0);
2805 if (r <= 0) {
2806 log_unit_debug(u, "Failed to parse ffs value: %s", value);
2807 return 0;
2808 }
2809
2810 fd = parse_fd(fdv);
2811 if (fd < 0 || !fdset_contains(fds, fd)) {
2812 log_unit_debug(u, "Invalid ffs value: %s", fdv);
2813 return 0;
2814 }
2815
2816 LIST_FOREACH(port, p, s->ports)
2817 if (p->fd < 0 &&
2818 p->type == SOCKET_USB_FUNCTION &&
2819 path_equal_or_inode_same(p->path, value, 0)) {
2820 p->fd = fdset_remove(fds, fd);
2821 found = true;
2822 break;
2823 }
2824 if (!found)
2825 log_unit_debug(u, "No matching ffs socket found: %s", value);
2826
2827 } else
2828 log_unit_debug(UNIT(s), "Unknown serialization key: %s", key);
2829
2830 return 0;
2831 }
2832
2833 static void socket_distribute_fds(Unit *u, FDSet *fds) {
2834 Socket *s = SOCKET(u);
2835
2836 assert(u);
2837
2838 LIST_FOREACH(port, p, s->ports) {
2839 int fd;
2840
2841 if (p->type != SOCKET_SOCKET)
2842 continue;
2843
2844 if (p->fd >= 0)
2845 continue;
2846
2847 FDSET_FOREACH(fd, fds) {
2848 if (socket_address_matches_fd(&p->address, fd)) {
2849 p->fd = fdset_remove(fds, fd);
2850 s->deserialized_state = SOCKET_LISTENING;
2851 break;
2852 }
2853 }
2854 }
2855 }
2856
2857 static UnitActiveState socket_active_state(Unit *u) {
2858 assert(u);
2859
2860 return state_translation_table[SOCKET(u)->state];
2861 }
2862
2863 static const char *socket_sub_state_to_string(Unit *u) {
2864 assert(u);
2865
2866 return socket_state_to_string(SOCKET(u)->state);
2867 }
2868
2869 int socket_port_to_address(const SocketPort *p, char **ret) {
2870 _cleanup_free_ char *address = NULL;
2871 int r;
2872
2873 assert(p);
2874 assert(ret);
2875
2876 switch (p->type) {
2877 case SOCKET_SOCKET: {
2878 r = socket_address_print(&p->address, &address);
2879 if (r < 0)
2880 return r;
2881
2882 break;
2883 }
2884
2885 case SOCKET_SPECIAL:
2886 case SOCKET_MQUEUE:
2887 case SOCKET_FIFO:
2888 case SOCKET_USB_FUNCTION:
2889 address = strdup(p->path);
2890 if (!address)
2891 return -ENOMEM;
2892 break;
2893
2894 default:
2895 assert_not_reached();
2896 }
2897
2898 *ret = TAKE_PTR(address);
2899
2900 return 0;
2901 }
2902
2903 const char* socket_port_type_to_string(SocketPort *p) {
2904
2905 assert(p);
2906
2907 switch (p->type) {
2908
2909 case SOCKET_SOCKET:
2910
2911 switch (p->address.type) {
2912
2913 case SOCK_STREAM:
2914 return "Stream";
2915
2916 case SOCK_DGRAM:
2917 return "Datagram";
2918
2919 case SOCK_SEQPACKET:
2920 return "SequentialPacket";
2921
2922 case SOCK_RAW:
2923 if (socket_address_family(&p->address) == AF_NETLINK)
2924 return "Netlink";
2925
2926 _fallthrough_;
2927 default:
2928 return NULL;
2929 }
2930
2931 case SOCKET_SPECIAL:
2932 return "Special";
2933
2934 case SOCKET_MQUEUE:
2935 return "MessageQueue";
2936
2937 case SOCKET_FIFO:
2938 return "FIFO";
2939
2940 case SOCKET_USB_FUNCTION:
2941 return "USBFunction";
2942
2943 default:
2944 return NULL;
2945 }
2946 }
2947
2948 SocketType socket_port_type_from_string(const char *s) {
2949 assert(s);
2950
2951 if (STR_IN_SET(s, "Stream", "Datagram", "SequentialPacket", "Netlink"))
2952 return SOCKET_SOCKET;
2953 else if (streq(s, "Special"))
2954 return SOCKET_SPECIAL;
2955 else if (streq(s, "MessageQueue"))
2956 return SOCKET_MQUEUE;
2957 else if (streq(s, "FIFO"))
2958 return SOCKET_FIFO;
2959 else if (streq(s, "USBFunction"))
2960 return SOCKET_USB_FUNCTION;
2961 else
2962 return _SOCKET_TYPE_INVALID;
2963 }
2964
2965 static bool socket_may_gc(Unit *u) {
2966 Socket *s = SOCKET(u);
2967
2968 assert(u);
2969
2970 return s->n_connections == 0;
2971 }
2972
2973 static int socket_accept_do(Socket *s, int fd) {
2974 int cfd;
2975
2976 assert(s);
2977 assert(fd >= 0);
2978
2979 cfd = accept4(fd, NULL, NULL, SOCK_NONBLOCK|SOCK_CLOEXEC);
2980 if (cfd < 0)
2981 /* Convert transient network errors into clean and well-defined EAGAIN */
2982 return ERRNO_IS_ACCEPT_AGAIN(errno) ? -EAGAIN : -errno;
2983
2984 return cfd;
2985 }
2986
2987 static int socket_accept_in_cgroup(Socket *s, SocketPort *p, int fd) {
2988 _cleanup_(pidref_done) PidRef pid = PIDREF_NULL;
2989 _cleanup_close_pair_ int pair[2] = PIPE_EBADF;
2990 int cfd, r;
2991
2992 assert(s);
2993 assert(p);
2994 assert(fd >= 0);
2995
2996 /* Similar to socket_address_listen_in_cgroup(), but for accept() rather than socket(): make sure that any
2997 * connection socket is also properly associated with the cgroup. */
2998
2999 if (!IN_SET(p->address.sockaddr.sa.sa_family, AF_INET, AF_INET6))
3000 goto shortcut;
3001
3002 r = bpf_firewall_supported();
3003 if (r < 0)
3004 return r;
3005 if (r == BPF_FIREWALL_UNSUPPORTED)
3006 goto shortcut;
3007
3008 if (socketpair(AF_UNIX, SOCK_SEQPACKET|SOCK_CLOEXEC, 0, pair) < 0)
3009 return log_unit_error_errno(UNIT(s), errno, "Failed to create communication channel: %m");
3010
3011 r = unit_fork_helper_process(UNIT(s), "(sd-accept)", &pid);
3012 if (r < 0)
3013 return log_unit_error_errno(UNIT(s), r, "Failed to fork off accept stub process: %m");
3014 if (r == 0) {
3015 /* Child */
3016
3017 pair[0] = safe_close(pair[0]);
3018
3019 cfd = socket_accept_do(s, fd);
3020 if (cfd == -EAGAIN) /* spurious accept() */
3021 _exit(EXIT_SUCCESS);
3022 if (cfd < 0) {
3023 log_unit_error_errno(UNIT(s), cfd, "Failed to accept connection socket: %m");
3024 _exit(EXIT_FAILURE);
3025 }
3026
3027 r = send_one_fd(pair[1], cfd, 0);
3028 if (r < 0) {
3029 log_unit_error_errno(UNIT(s), r, "Failed to send connection socket to parent: %m");
3030 _exit(EXIT_FAILURE);
3031 }
3032
3033 _exit(EXIT_SUCCESS);
3034 }
3035
3036 pair[1] = safe_close(pair[1]);
3037 cfd = receive_one_fd(pair[0], 0);
3038
3039 /* We synchronously wait for the helper, as it shouldn't be slow */
3040 r = wait_for_terminate_and_check("(sd-accept)", pid.pid, WAIT_LOG_ABNORMAL);
3041 if (r < 0) {
3042 safe_close(cfd);
3043 return r;
3044 }
3045
3046 /* If we received no fd, we got EIO here. If this happens with a process exit code of EXIT_SUCCESS
3047 * this is a spurious accept(), let's convert that back to EAGAIN here. */
3048 if (cfd == -EIO)
3049 return -EAGAIN;
3050 if (cfd < 0)
3051 return log_unit_error_errno(UNIT(s), cfd, "Failed to receive connection socket: %m");
3052
3053 return cfd;
3054
3055 shortcut:
3056 cfd = socket_accept_do(s, fd);
3057 if (cfd == -EAGAIN) /* spurious accept(), skip it silently */
3058 return -EAGAIN;
3059 if (cfd < 0)
3060 return log_unit_error_errno(UNIT(s), cfd, "Failed to accept connection socket: %m");
3061
3062 return cfd;
3063 }
3064
3065 static int socket_dispatch_io(sd_event_source *source, int fd, uint32_t revents, void *userdata) {
3066 SocketPort *p = ASSERT_PTR(userdata);
3067 int cfd = -EBADF;
3068
3069 assert(fd >= 0);
3070
3071 if (p->socket->state != SOCKET_LISTENING)
3072 return 0;
3073
3074 log_unit_debug(UNIT(p->socket), "Incoming traffic");
3075
3076 if (revents != EPOLLIN) {
3077 if (revents & EPOLLHUP)
3078 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.");
3079 else
3080 log_unit_error(UNIT(p->socket), "Got unexpected poll event (0x%x) on socket.", revents);
3081 goto fail;
3082 }
3083
3084 if (p->socket->accept &&
3085 p->type == SOCKET_SOCKET &&
3086 socket_address_can_accept(&p->address)) {
3087
3088 cfd = socket_accept_in_cgroup(p->socket, p, fd);
3089 if (cfd == -EAGAIN) /* Spurious accept() */
3090 return 0;
3091 if (cfd < 0)
3092 goto fail;
3093
3094 socket_apply_socket_options(p->socket, p, cfd);
3095 }
3096
3097 socket_enter_running(p->socket, cfd);
3098 return 0;
3099
3100 fail:
3101 socket_enter_stop_pre(p->socket, SOCKET_FAILURE_RESOURCES);
3102 return 0;
3103 }
3104
3105 static void socket_sigchld_event(Unit *u, pid_t pid, int code, int status) {
3106 Socket *s = SOCKET(u);
3107 SocketResult f;
3108
3109 assert(s);
3110 assert(pid >= 0);
3111
3112 if (pid != s->control_pid.pid)
3113 return;
3114
3115 pidref_done(&s->control_pid);
3116
3117 if (is_clean_exit(code, status, EXIT_CLEAN_COMMAND, NULL))
3118 f = SOCKET_SUCCESS;
3119 else if (code == CLD_EXITED)
3120 f = SOCKET_FAILURE_EXIT_CODE;
3121 else if (code == CLD_KILLED)
3122 f = SOCKET_FAILURE_SIGNAL;
3123 else if (code == CLD_DUMPED)
3124 f = SOCKET_FAILURE_CORE_DUMP;
3125 else
3126 assert_not_reached();
3127
3128 if (s->control_command) {
3129 exec_status_exit(&s->control_command->exec_status, &s->exec_context, pid, code, status);
3130
3131 if (s->control_command->flags & EXEC_COMMAND_IGNORE_FAILURE)
3132 f = SOCKET_SUCCESS;
3133 }
3134
3135 unit_log_process_exit(
3136 u,
3137 "Control process",
3138 socket_exec_command_to_string(s->control_command_id),
3139 f == SOCKET_SUCCESS,
3140 code, status);
3141
3142 if (s->result == SOCKET_SUCCESS)
3143 s->result = f;
3144
3145 if (s->control_command &&
3146 s->control_command->command_next &&
3147 f == SOCKET_SUCCESS) {
3148
3149 log_unit_debug(u, "Running next command for state %s", socket_state_to_string(s->state));
3150 socket_run_next(s);
3151 } else {
3152 s->control_command = NULL;
3153 s->control_command_id = _SOCKET_EXEC_COMMAND_INVALID;
3154
3155 /* No further commands for this step, so let's figure
3156 * out what to do next */
3157
3158 log_unit_debug(u, "Got final SIGCHLD for state %s", socket_state_to_string(s->state));
3159
3160 switch (s->state) {
3161
3162 case SOCKET_START_PRE:
3163 if (f == SOCKET_SUCCESS)
3164 socket_enter_start_chown(s);
3165 else
3166 socket_enter_signal(s, SOCKET_FINAL_SIGTERM, f);
3167 break;
3168
3169 case SOCKET_START_CHOWN:
3170 if (f == SOCKET_SUCCESS)
3171 socket_enter_start_post(s);
3172 else
3173 socket_enter_stop_pre(s, f);
3174 break;
3175
3176 case SOCKET_START_POST:
3177 if (f == SOCKET_SUCCESS)
3178 socket_enter_listening(s);
3179 else
3180 socket_enter_stop_pre(s, f);
3181 break;
3182
3183 case SOCKET_STOP_PRE:
3184 case SOCKET_STOP_PRE_SIGTERM:
3185 case SOCKET_STOP_PRE_SIGKILL:
3186 socket_enter_stop_post(s, f);
3187 break;
3188
3189 case SOCKET_STOP_POST:
3190 case SOCKET_FINAL_SIGTERM:
3191 case SOCKET_FINAL_SIGKILL:
3192 socket_enter_dead(s, f);
3193 break;
3194
3195 case SOCKET_CLEANING:
3196
3197 if (s->clean_result == SOCKET_SUCCESS)
3198 s->clean_result = f;
3199
3200 socket_enter_dead(s, SOCKET_SUCCESS);
3201 break;
3202
3203 default:
3204 assert_not_reached();
3205 }
3206 }
3207
3208 /* Notify clients about changed exit status */
3209 unit_add_to_dbus_queue(u);
3210 }
3211
3212 static int socket_dispatch_timer(sd_event_source *source, usec_t usec, void *userdata) {
3213 Socket *s = SOCKET(userdata);
3214
3215 assert(s);
3216 assert(s->timer_event_source == source);
3217
3218 switch (s->state) {
3219
3220 case SOCKET_START_PRE:
3221 log_unit_warning(UNIT(s), "Starting timed out. Terminating.");
3222 socket_enter_signal(s, SOCKET_FINAL_SIGTERM, SOCKET_FAILURE_TIMEOUT);
3223 break;
3224
3225 case SOCKET_START_CHOWN:
3226 case SOCKET_START_POST:
3227 log_unit_warning(UNIT(s), "Starting timed out. Stopping.");
3228 socket_enter_stop_pre(s, SOCKET_FAILURE_TIMEOUT);
3229 break;
3230
3231 case SOCKET_STOP_PRE:
3232 log_unit_warning(UNIT(s), "Stopping timed out. Terminating.");
3233 socket_enter_signal(s, SOCKET_STOP_PRE_SIGTERM, SOCKET_FAILURE_TIMEOUT);
3234 break;
3235
3236 case SOCKET_STOP_PRE_SIGTERM:
3237 if (s->kill_context.send_sigkill) {
3238 log_unit_warning(UNIT(s), "Stopping timed out. Killing.");
3239 socket_enter_signal(s, SOCKET_STOP_PRE_SIGKILL, SOCKET_FAILURE_TIMEOUT);
3240 } else {
3241 log_unit_warning(UNIT(s), "Stopping timed out. Skipping SIGKILL. Ignoring.");
3242 socket_enter_stop_post(s, SOCKET_FAILURE_TIMEOUT);
3243 }
3244 break;
3245
3246 case SOCKET_STOP_PRE_SIGKILL:
3247 log_unit_warning(UNIT(s), "Processes still around after SIGKILL. Ignoring.");
3248 socket_enter_stop_post(s, SOCKET_FAILURE_TIMEOUT);
3249 break;
3250
3251 case SOCKET_STOP_POST:
3252 log_unit_warning(UNIT(s), "Stopping timed out (2). Terminating.");
3253 socket_enter_signal(s, SOCKET_FINAL_SIGTERM, SOCKET_FAILURE_TIMEOUT);
3254 break;
3255
3256 case SOCKET_FINAL_SIGTERM:
3257 if (s->kill_context.send_sigkill) {
3258 log_unit_warning(UNIT(s), "Stopping timed out (2). Killing.");
3259 socket_enter_signal(s, SOCKET_FINAL_SIGKILL, SOCKET_FAILURE_TIMEOUT);
3260 } else {
3261 log_unit_warning(UNIT(s), "Stopping timed out (2). Skipping SIGKILL. Ignoring.");
3262 socket_enter_dead(s, SOCKET_FAILURE_TIMEOUT);
3263 }
3264 break;
3265
3266 case SOCKET_FINAL_SIGKILL:
3267 log_unit_warning(UNIT(s), "Still around after SIGKILL (2). Entering failed mode.");
3268 socket_enter_dead(s, SOCKET_FAILURE_TIMEOUT);
3269 break;
3270
3271 case SOCKET_CLEANING:
3272 log_unit_warning(UNIT(s), "Cleaning timed out. killing.");
3273
3274 if (s->clean_result == SOCKET_SUCCESS)
3275 s->clean_result = SOCKET_FAILURE_TIMEOUT;
3276
3277 socket_enter_signal(s, SOCKET_FINAL_SIGKILL, 0);
3278 break;
3279
3280 default:
3281 assert_not_reached();
3282 }
3283
3284 return 0;
3285 }
3286
3287 int socket_collect_fds(Socket *s, int **fds) {
3288 size_t k = 0, n = 0;
3289 int *rfds;
3290
3291 assert(s);
3292 assert(fds);
3293
3294 /* Called from the service code for requesting our fds */
3295
3296 LIST_FOREACH(port, p, s->ports) {
3297 if (p->fd >= 0)
3298 n++;
3299 n += p->n_auxiliary_fds;
3300 }
3301
3302 if (n <= 0) {
3303 *fds = NULL;
3304 return 0;
3305 }
3306
3307 rfds = new(int, n);
3308 if (!rfds)
3309 return -ENOMEM;
3310
3311 LIST_FOREACH(port, p, s->ports) {
3312 if (p->fd >= 0)
3313 rfds[k++] = p->fd;
3314 for (size_t i = 0; i < p->n_auxiliary_fds; ++i)
3315 rfds[k++] = p->auxiliary_fds[i];
3316 }
3317
3318 assert(k == n);
3319
3320 *fds = rfds;
3321 return (int) n;
3322 }
3323
3324 static void socket_reset_failed(Unit *u) {
3325 Socket *s = SOCKET(u);
3326
3327 assert(s);
3328
3329 if (s->state == SOCKET_FAILED)
3330 socket_set_state(s, SOCKET_DEAD);
3331
3332 s->result = SOCKET_SUCCESS;
3333 s->clean_result = SOCKET_SUCCESS;
3334 }
3335
3336 void socket_connection_unref(Socket *s) {
3337 assert(s);
3338
3339 /* The service is dead. Yay!
3340 *
3341 * This is strictly for one-instance-per-connection
3342 * services. */
3343
3344 assert(s->n_connections > 0);
3345 s->n_connections--;
3346
3347 log_unit_debug(UNIT(s), "One connection closed, %u left.", s->n_connections);
3348 }
3349
3350 static void socket_trigger_notify(Unit *u, Unit *other) {
3351 Socket *s = SOCKET(u);
3352
3353 assert(u);
3354 assert(other);
3355
3356 /* Filter out invocations with bogus state */
3357 assert(UNIT_IS_LOAD_COMPLETE(other->load_state));
3358 assert(other->type == UNIT_SERVICE);
3359
3360 /* Don't propagate state changes from the service if we are already down */
3361 if (!IN_SET(s->state, SOCKET_RUNNING, SOCKET_LISTENING))
3362 return;
3363
3364 /* We don't care for the service state if we are in Accept=yes mode */
3365 if (s->accept)
3366 return;
3367
3368 /* Propagate start limit hit state */
3369 if (other->start_limit_hit) {
3370 socket_enter_stop_pre(s, SOCKET_FAILURE_SERVICE_START_LIMIT_HIT);
3371 return;
3372 }
3373
3374 /* Don't propagate anything if there's still a job queued */
3375 if (other->job)
3376 return;
3377
3378 if (IN_SET(SERVICE(other)->state,
3379 SERVICE_DEAD, SERVICE_DEAD_BEFORE_AUTO_RESTART, SERVICE_FAILED, SERVICE_FAILED_BEFORE_AUTO_RESTART,
3380 SERVICE_FINAL_SIGTERM, SERVICE_FINAL_SIGKILL,
3381 SERVICE_AUTO_RESTART, SERVICE_AUTO_RESTART_QUEUED))
3382 socket_enter_listening(s);
3383
3384 if (SERVICE(other)->state == SERVICE_RUNNING)
3385 socket_set_state(s, SOCKET_RUNNING);
3386 }
3387
3388 static int socket_get_timeout(Unit *u, usec_t *timeout) {
3389 Socket *s = SOCKET(u);
3390 usec_t t;
3391 int r;
3392
3393 if (!s->timer_event_source)
3394 return 0;
3395
3396 r = sd_event_source_get_time(s->timer_event_source, &t);
3397 if (r < 0)
3398 return r;
3399 if (t == USEC_INFINITY)
3400 return 0;
3401
3402 *timeout = t;
3403 return 1;
3404 }
3405
3406 char *socket_fdname(Socket *s) {
3407 assert(s);
3408
3409 /* Returns the name to use for $LISTEN_NAMES. If the user
3410 * didn't specify anything specifically, use the socket unit's
3411 * name as fallback. */
3412
3413 return s->fdname ?: UNIT(s)->id;
3414 }
3415
3416 static PidRef *socket_control_pid(Unit *u) {
3417 return &ASSERT_PTR(SOCKET(u))->control_pid;
3418 }
3419
3420 static int socket_clean(Unit *u, ExecCleanMask mask) {
3421 _cleanup_strv_free_ char **l = NULL;
3422 Socket *s = SOCKET(u);
3423 int r;
3424
3425 assert(s);
3426 assert(mask != 0);
3427
3428 if (s->state != SOCKET_DEAD)
3429 return -EBUSY;
3430
3431 r = exec_context_get_clean_directories(&s->exec_context, u->manager->prefix, mask, &l);
3432 if (r < 0)
3433 return r;
3434
3435 if (strv_isempty(l))
3436 return -EUNATCH;
3437
3438 socket_unwatch_control_pid(s);
3439 s->clean_result = SOCKET_SUCCESS;
3440 s->control_command = NULL;
3441 s->control_command_id = _SOCKET_EXEC_COMMAND_INVALID;
3442
3443 r = socket_arm_timer(s, /* relative= */ true, s->exec_context.timeout_clean_usec);
3444 if (r < 0) {
3445 log_unit_warning_errno(u, r, "Failed to install timer: %m");
3446 goto fail;
3447 }
3448
3449 r = unit_fork_and_watch_rm_rf(u, l, &s->control_pid);
3450 if (r < 0) {
3451 log_unit_warning_errno(u, r, "Failed to spawn cleaning task: %m");
3452 goto fail;
3453 }
3454
3455 socket_set_state(s, SOCKET_CLEANING);
3456 return 0;
3457
3458 fail:
3459 s->clean_result = SOCKET_FAILURE_RESOURCES;
3460 s->timer_event_source = sd_event_source_disable_unref(s->timer_event_source);
3461 return r;
3462 }
3463
3464 static int socket_can_clean(Unit *u, ExecCleanMask *ret) {
3465 Socket *s = SOCKET(u);
3466
3467 assert(s);
3468
3469 return exec_context_get_clean_mask(&s->exec_context, ret);
3470 }
3471
3472 static int socket_can_start(Unit *u) {
3473 Socket *s = SOCKET(u);
3474 int r;
3475
3476 assert(s);
3477
3478 r = unit_test_start_limit(u);
3479 if (r < 0) {
3480 socket_enter_dead(s, SOCKET_FAILURE_START_LIMIT_HIT);
3481 return r;
3482 }
3483
3484 return 1;
3485 }
3486
3487 static const char* const socket_exec_command_table[_SOCKET_EXEC_COMMAND_MAX] = {
3488 [SOCKET_EXEC_START_PRE] = "ExecStartPre",
3489 [SOCKET_EXEC_START_CHOWN] = "ExecStartChown",
3490 [SOCKET_EXEC_START_POST] = "ExecStartPost",
3491 [SOCKET_EXEC_STOP_PRE] = "ExecStopPre",
3492 [SOCKET_EXEC_STOP_POST] = "ExecStopPost"
3493 };
3494
3495 DEFINE_STRING_TABLE_LOOKUP(socket_exec_command, SocketExecCommand);
3496
3497 static const char* const socket_result_table[_SOCKET_RESULT_MAX] = {
3498 [SOCKET_SUCCESS] = "success",
3499 [SOCKET_FAILURE_RESOURCES] = "resources",
3500 [SOCKET_FAILURE_TIMEOUT] = "timeout",
3501 [SOCKET_FAILURE_EXIT_CODE] = "exit-code",
3502 [SOCKET_FAILURE_SIGNAL] = "signal",
3503 [SOCKET_FAILURE_CORE_DUMP] = "core-dump",
3504 [SOCKET_FAILURE_START_LIMIT_HIT] = "start-limit-hit",
3505 [SOCKET_FAILURE_TRIGGER_LIMIT_HIT] = "trigger-limit-hit",
3506 [SOCKET_FAILURE_SERVICE_START_LIMIT_HIT] = "service-start-limit-hit"
3507 };
3508
3509 DEFINE_STRING_TABLE_LOOKUP(socket_result, SocketResult);
3510
3511 static const char* const socket_timestamping_table[_SOCKET_TIMESTAMPING_MAX] = {
3512 [SOCKET_TIMESTAMPING_OFF] = "off",
3513 [SOCKET_TIMESTAMPING_US] = "us",
3514 [SOCKET_TIMESTAMPING_NS] = "ns",
3515 };
3516
3517 DEFINE_STRING_TABLE_LOOKUP(socket_timestamping, SocketTimestamping);
3518
3519 SocketTimestamping socket_timestamping_from_string_harder(const char *p) {
3520 SocketTimestamping t;
3521 int r;
3522
3523 if (!p)
3524 return _SOCKET_TIMESTAMPING_INVALID;
3525
3526 t = socket_timestamping_from_string(p);
3527 if (t >= 0)
3528 return t;
3529
3530 /* Let's alternatively support the various other aliases parse_time() accepts for ns and µs here,
3531 * too. */
3532 if (streq(p, "nsec"))
3533 return SOCKET_TIMESTAMPING_NS;
3534 if (STR_IN_SET(p, "usec", "µs", "μs")) /* Accept both small greek letter mu + micro sign unicode codepoints */
3535 return SOCKET_TIMESTAMPING_US;
3536
3537 r = parse_boolean(p);
3538 if (r < 0)
3539 return _SOCKET_TIMESTAMPING_INVALID;
3540
3541 return r ? SOCKET_TIMESTAMPING_NS : SOCKET_TIMESTAMPING_OFF; /* If boolean yes, default to ns accuracy */
3542 }
3543
3544 const UnitVTable socket_vtable = {
3545 .object_size = sizeof(Socket),
3546 .exec_context_offset = offsetof(Socket, exec_context),
3547 .cgroup_context_offset = offsetof(Socket, cgroup_context),
3548 .kill_context_offset = offsetof(Socket, kill_context),
3549 .exec_runtime_offset = offsetof(Socket, exec_runtime),
3550
3551 .sections =
3552 "Unit\0"
3553 "Socket\0"
3554 "Install\0",
3555 .private_section = "Socket",
3556
3557 .can_transient = true,
3558 .can_trigger = true,
3559 .can_fail = true,
3560
3561 .init = socket_init,
3562 .done = socket_done,
3563 .load = socket_load,
3564
3565 .coldplug = socket_coldplug,
3566
3567 .dump = socket_dump,
3568
3569 .start = socket_start,
3570 .stop = socket_stop,
3571
3572 .clean = socket_clean,
3573 .can_clean = socket_can_clean,
3574
3575 .get_timeout = socket_get_timeout,
3576
3577 .serialize = socket_serialize,
3578 .deserialize_item = socket_deserialize_item,
3579 .distribute_fds = socket_distribute_fds,
3580
3581 .active_state = socket_active_state,
3582 .sub_state_to_string = socket_sub_state_to_string,
3583
3584 .will_restart = unit_will_restart_default,
3585
3586 .may_gc = socket_may_gc,
3587
3588 .sigchld_event = socket_sigchld_event,
3589
3590 .trigger_notify = socket_trigger_notify,
3591
3592 .reset_failed = socket_reset_failed,
3593
3594 .control_pid = socket_control_pid,
3595
3596 .bus_set_property = bus_socket_set_property,
3597 .bus_commit_properties = bus_socket_commit_properties,
3598
3599 .status_message_formats = {
3600 .finished_start_job = {
3601 [JOB_DONE] = "Listening on %s.",
3602 [JOB_FAILED] = "Failed to listen on %s.",
3603 [JOB_TIMEOUT] = "Timed out starting %s.",
3604 },
3605 .finished_stop_job = {
3606 [JOB_DONE] = "Closed %s.",
3607 [JOB_FAILED] = "Failed stopping %s.",
3608 [JOB_TIMEOUT] = "Timed out stopping %s.",
3609 },
3610 },
3611
3612 .can_start = socket_can_start,
3613 };