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