]> git.ipfire.org Git - thirdparty/systemd.git/blob - src/socket.c
service: rework PID parsing logic everywhere
[thirdparty/systemd.git] / src / socket.c
1 /*-*- Mode: C; c-basic-offset: 8 -*-*/
2
3 /***
4 This file is part of systemd.
5
6 Copyright 2010 Lennart Poettering
7
8 systemd is free software; you can redistribute it and/or modify it
9 under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2 of the License, or
11 (at your option) any later version.
12
13 systemd is distributed in the hope that it will be useful, but
14 WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 General Public License for more details.
17
18 You should have received a copy of the GNU General Public License
19 along with systemd; If not, see <http://www.gnu.org/licenses/>.
20 ***/
21
22 #include <sys/types.h>
23 #include <sys/stat.h>
24 #include <unistd.h>
25 #include <errno.h>
26 #include <fcntl.h>
27 #include <sys/epoll.h>
28 #include <signal.h>
29 #include <arpa/inet.h>
30
31 #include "unit.h"
32 #include "socket.h"
33 #include "log.h"
34 #include "load-dropin.h"
35 #include "load-fragment.h"
36 #include "strv.h"
37 #include "unit-name.h"
38 #include "dbus-socket.h"
39
40 static const UnitActiveState state_translation_table[_SOCKET_STATE_MAX] = {
41 [SOCKET_DEAD] = UNIT_INACTIVE,
42 [SOCKET_START_PRE] = UNIT_ACTIVATING,
43 [SOCKET_START_POST] = UNIT_ACTIVATING,
44 [SOCKET_LISTENING] = UNIT_ACTIVE,
45 [SOCKET_RUNNING] = UNIT_ACTIVE,
46 [SOCKET_STOP_PRE] = UNIT_DEACTIVATING,
47 [SOCKET_STOP_PRE_SIGTERM] = UNIT_DEACTIVATING,
48 [SOCKET_STOP_PRE_SIGKILL] = UNIT_DEACTIVATING,
49 [SOCKET_STOP_POST] = UNIT_DEACTIVATING,
50 [SOCKET_FINAL_SIGTERM] = UNIT_DEACTIVATING,
51 [SOCKET_FINAL_SIGKILL] = UNIT_DEACTIVATING,
52 [SOCKET_MAINTENANCE] = UNIT_INACTIVE,
53 };
54
55 static void socket_init(Unit *u) {
56 Socket *s = SOCKET(u);
57
58 assert(u);
59 assert(u->meta.load_state == UNIT_STUB);
60
61 s->backlog = SOMAXCONN;
62 s->timeout_usec = DEFAULT_TIMEOUT_USEC;
63 s->directory_mode = 0755;
64 s->socket_mode = 0666;
65
66 exec_context_init(&s->exec_context);
67
68 s->control_command_id = _SOCKET_EXEC_COMMAND_INVALID;
69 }
70
71 static void socket_unwatch_control_pid(Socket *s) {
72 assert(s);
73
74 if (s->control_pid <= 0)
75 return;
76
77 unit_unwatch_pid(UNIT(s), s->control_pid);
78 s->control_pid = 0;
79 }
80
81 static void socket_done(Unit *u) {
82 Socket *s = SOCKET(u);
83 SocketPort *p;
84
85 assert(s);
86
87 while ((p = s->ports)) {
88 LIST_REMOVE(SocketPort, port, s->ports, p);
89
90 if (p->fd >= 0) {
91 unit_unwatch_fd(UNIT(s), &p->fd_watch);
92 close_nointr_nofail(p->fd);
93 }
94
95 free(p->path);
96 free(p);
97 }
98
99 exec_context_done(&s->exec_context);
100 exec_command_free_array(s->exec_command, _SOCKET_EXEC_COMMAND_MAX);
101 s->control_command = NULL;
102
103 socket_unwatch_control_pid(s);
104
105 s->service = NULL;
106
107 free(s->bind_to_device);
108 s->bind_to_device = NULL;
109
110 unit_unwatch_timer(u, &s->timer_watch);
111 }
112
113 static bool have_non_accept_socket(Socket *s) {
114 SocketPort *p;
115
116 assert(s);
117
118 if (!s->accept)
119 return true;
120
121 LIST_FOREACH(port, p, s->ports) {
122
123 if (p->type != SOCKET_SOCKET)
124 return true;
125
126 if (!socket_address_can_accept(&p->address))
127 return true;
128 }
129
130 return false;
131 }
132
133 static int socket_verify(Socket *s) {
134 assert(s);
135
136 if (UNIT(s)->meta.load_state != UNIT_LOADED)
137 return 0;
138
139 if (!s->ports) {
140 log_error("%s lacks Listen setting. Refusing.", UNIT(s)->meta.id);
141 return -EINVAL;
142 }
143
144 return 0;
145 }
146
147 static bool socket_needs_mount(Socket *s, const char *prefix) {
148 SocketPort *p;
149
150 assert(s);
151
152 LIST_FOREACH(port, p, s->ports) {
153
154 if (p->type == SOCKET_SOCKET) {
155 if (socket_address_needs_mount(&p->address, prefix))
156 return true;
157 } else {
158 assert(p->type == SOCKET_FIFO);
159 if (path_startswith(p->path, prefix))
160 return true;
161 }
162 }
163
164 return false;
165 }
166
167 int socket_add_one_mount_link(Socket *s, Mount *m) {
168 int r;
169
170 assert(s);
171 assert(m);
172
173 if (s->meta.load_state != UNIT_LOADED ||
174 m->meta.load_state != UNIT_LOADED)
175 return 0;
176
177 if (!socket_needs_mount(s, m->where))
178 return 0;
179
180 if ((r = unit_add_dependency(UNIT(m), UNIT_BEFORE, UNIT(s), true)) < 0)
181 return r;
182
183 if ((r = unit_add_dependency(UNIT(s), UNIT_REQUIRES, UNIT(m), true)) < 0)
184 return r;
185
186 return 0;
187 }
188
189 static int socket_add_mount_links(Socket *s) {
190 Meta *other;
191 int r;
192
193 assert(s);
194
195 LIST_FOREACH(units_per_type, other, s->meta.manager->units_per_type[UNIT_MOUNT])
196 if ((r = socket_add_one_mount_link(s, (Mount*) other)) < 0)
197 return r;
198
199 return 0;
200 }
201
202 static int socket_add_device_link(Socket *s) {
203 char *t;
204 int r;
205
206 assert(s);
207
208 if (!s->bind_to_device)
209 return 0;
210
211 if (asprintf(&t, "/sys/subsystem/net/devices/%s", s->bind_to_device) < 0)
212 return -ENOMEM;
213
214 r = unit_add_node_link(UNIT(s), t, false);
215 free(t);
216
217 return r;
218 }
219
220 static int socket_load(Unit *u) {
221 Socket *s = SOCKET(u);
222 int r;
223
224 assert(u);
225 assert(u->meta.load_state == UNIT_STUB);
226
227 if ((r = unit_load_fragment_and_dropin(u)) < 0)
228 return r;
229
230 /* This is a new unit? Then let's add in some extras */
231 if (u->meta.load_state == UNIT_LOADED) {
232
233 if (have_non_accept_socket(s)) {
234 if ((r = unit_load_related_unit(u, ".service", (Unit**) &s->service)))
235 return r;
236
237 if ((r = unit_add_dependency(u, UNIT_BEFORE, UNIT(s->service), true)) < 0)
238 return r;
239 }
240
241 if ((r = socket_add_mount_links(s)) < 0)
242 return r;
243
244 if ((r = socket_add_device_link(s)) < 0)
245 return r;
246
247 if ((r = unit_add_exec_dependencies(u, &s->exec_context)) < 0)
248 return r;
249
250 if ((r = unit_add_default_cgroup(u)) < 0)
251 return r;
252 }
253
254 return socket_verify(s);
255 }
256
257 static const char* listen_lookup(int type) {
258
259 if (type == SOCK_STREAM)
260 return "ListenStream";
261 else if (type == SOCK_DGRAM)
262 return "ListenDatagram";
263 else if (type == SOCK_SEQPACKET)
264 return "ListenSequentialPacket";
265
266 assert_not_reached("Unknown socket type");
267 return NULL;
268 }
269
270 static void socket_dump(Unit *u, FILE *f, const char *prefix) {
271
272 SocketExecCommand c;
273 Socket *s = SOCKET(u);
274 SocketPort *p;
275 const char *prefix2;
276 char *p2;
277
278 assert(s);
279 assert(f);
280
281 p2 = strappend(prefix, "\t");
282 prefix2 = p2 ? p2 : prefix;
283
284 fprintf(f,
285 "%sSocket State: %s\n"
286 "%sBindIPv6Only: %s\n"
287 "%sBacklog: %u\n"
288 "%sKillMode: %s\n"
289 "%sSocketMode: %04o\n"
290 "%sDirectoryMode: %04o\n",
291 prefix, socket_state_to_string(s->state),
292 prefix, socket_address_bind_ipv6_only_to_string(s->bind_ipv6_only),
293 prefix, s->backlog,
294 prefix, kill_mode_to_string(s->kill_mode),
295 prefix, s->socket_mode,
296 prefix, s->directory_mode);
297
298 if (s->control_pid > 0)
299 fprintf(f,
300 "%sControl PID: %llu\n",
301 prefix, (unsigned long long) s->control_pid);
302
303 if (s->bind_to_device)
304 fprintf(f,
305 "%sBindToDevice: %s\n",
306 prefix, s->bind_to_device);
307
308 if (s->accept)
309 fprintf(f,
310 "%sAccepted: %u\n",
311 prefix, s->n_accepted);
312
313 LIST_FOREACH(port, p, s->ports) {
314
315 if (p->type == SOCKET_SOCKET) {
316 const char *t;
317 int r;
318 char *k;
319
320 if ((r = socket_address_print(&p->address, &k)) < 0)
321 t = strerror(-r);
322 else
323 t = k;
324
325 fprintf(f, "%s%s: %s\n", prefix, listen_lookup(p->address.type), k);
326 free(k);
327 } else
328 fprintf(f, "%sListenFIFO: %s\n", prefix, p->path);
329 }
330
331 exec_context_dump(&s->exec_context, f, prefix);
332
333 for (c = 0; c < _SOCKET_EXEC_COMMAND_MAX; c++) {
334 if (!s->exec_command[c])
335 continue;
336
337 fprintf(f, "%s-> %s:\n",
338 prefix, socket_exec_command_to_string(c));
339
340 exec_command_dump_list(s->exec_command[c], f, prefix2);
341 }
342
343 free(p2);
344 }
345
346 static int instance_from_socket(int fd, unsigned nr, char **instance) {
347 socklen_t l;
348 char *r;
349 union {
350 struct sockaddr sa;
351 struct sockaddr_un un;
352 struct sockaddr_in in;
353 struct sockaddr_in6 in6;
354 struct sockaddr_storage storage;
355 } local, remote;
356
357 assert(fd >= 0);
358 assert(instance);
359
360 l = sizeof(local);
361 if (getsockname(fd, &local.sa, &l) < 0)
362 return -errno;
363
364 l = sizeof(remote);
365 if (getpeername(fd, &remote.sa, &l) < 0)
366 return -errno;
367
368 switch (local.sa.sa_family) {
369
370 case AF_INET: {
371 uint32_t
372 a = ntohl(local.in.sin_addr.s_addr),
373 b = ntohl(remote.in.sin_addr.s_addr);
374
375 if (asprintf(&r,
376 "%u-%u.%u.%u.%u:%u-%u.%u.%u.%u:%u",
377 nr,
378 a >> 24, (a >> 16) & 0xFF, (a >> 8) & 0xFF, a & 0xFF,
379 ntohs(local.in.sin_port),
380 b >> 24, (b >> 16) & 0xFF, (b >> 8) & 0xFF, b & 0xFF,
381 ntohs(remote.in.sin_port)) < 0)
382 return -ENOMEM;
383
384 break;
385 }
386
387 case AF_INET6: {
388 static const char ipv4_prefix[] = {
389 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0xFF, 0xFF
390 };
391
392 if (memcmp(&local.in6.sin6_addr, ipv4_prefix, sizeof(ipv4_prefix)) == 0 &&
393 memcmp(&remote.in6.sin6_addr, ipv4_prefix, sizeof(ipv4_prefix)) == 0) {
394 const uint8_t
395 *a = local.in6.sin6_addr.s6_addr+12,
396 *b = remote.in6.sin6_addr.s6_addr+12;
397
398 if (asprintf(&r,
399 "%u-%u.%u.%u.%u:%u-%u.%u.%u.%u:%u",
400 nr,
401 a[0], a[1], a[2], a[3],
402 ntohs(local.in6.sin6_port),
403 b[0], b[1], b[2], b[3],
404 ntohs(remote.in6.sin6_port)) < 0)
405 return -ENOMEM;
406 } else {
407 char a[INET6_ADDRSTRLEN], b[INET6_ADDRSTRLEN];
408
409 if (asprintf(&r,
410 "%u-%s:%u-%s:%u",
411 nr,
412 inet_ntop(AF_INET6, &local.in6.sin6_addr, a, sizeof(a)),
413 ntohs(local.in6.sin6_port),
414 inet_ntop(AF_INET6, &remote.in6.sin6_addr, b, sizeof(b)),
415 ntohs(remote.in6.sin6_port)) < 0)
416 return -ENOMEM;
417 }
418
419 break;
420 }
421
422 case AF_UNIX: {
423 struct ucred ucred;
424
425 l = sizeof(ucred);
426 if (getsockopt(fd, SOL_SOCKET, SO_PEERCRED, &ucred, &l) < 0)
427 return -errno;
428
429 if (asprintf(&r,
430 "%u-%llu-%llu",
431 nr,
432 (unsigned long long) ucred.pid,
433 (unsigned long long) ucred.uid) < 0)
434 return -ENOMEM;
435
436 break;
437 }
438
439 default:
440 assert_not_reached("Unhandled socket type.");
441 }
442
443 *instance = r;
444 return 0;
445 }
446
447 static void socket_close_fds(Socket *s) {
448 SocketPort *p;
449
450 assert(s);
451
452 LIST_FOREACH(port, p, s->ports) {
453 if (p->fd < 0)
454 continue;
455
456 unit_unwatch_fd(UNIT(s), &p->fd_watch);
457 close_nointr_nofail(p->fd);
458
459 /* One little note: we should never delete any sockets
460 * in the file system here! After all some other
461 * process we spawned might still have a reference of
462 * this fd and wants to continue to use it. Therefore
463 * we delete sockets in the file system before we
464 * create a new one, not after we stopped using
465 * one! */
466
467 p->fd = -1;
468 }
469 }
470
471 static int socket_open_fds(Socket *s) {
472 SocketPort *p;
473 int r;
474
475 assert(s);
476
477 LIST_FOREACH(port, p, s->ports) {
478
479 if (p->fd >= 0)
480 continue;
481
482 if (p->type == SOCKET_SOCKET) {
483
484 if ((r = socket_address_listen(
485 &p->address,
486 s->backlog,
487 s->bind_ipv6_only,
488 s->bind_to_device,
489 s->directory_mode,
490 s->socket_mode,
491 &p->fd)) < 0)
492 goto rollback;
493
494 } else {
495 struct stat st;
496 assert(p->type == SOCKET_FIFO);
497
498 mkdir_parents(p->path, s->directory_mode);
499
500 if (mkfifo(p->path, s->socket_mode) < 0 && errno != EEXIST) {
501 r = -errno;
502 goto rollback;
503 }
504
505 if ((p->fd = open(p->path, O_RDWR|O_CLOEXEC|O_NOCTTY|O_NONBLOCK|O_NOFOLLOW)) < 0) {
506 r = -errno;
507 goto rollback;
508 }
509
510 if (fstat(p->fd, &st) < 0) {
511 r = -errno;
512 goto rollback;
513 }
514
515 /* FIXME verify user, access mode */
516
517 if (!S_ISFIFO(st.st_mode)) {
518 r = -EEXIST;
519 goto rollback;
520 }
521 }
522 }
523
524 return 0;
525
526 rollback:
527 socket_close_fds(s);
528 return r;
529 }
530
531 static void socket_unwatch_fds(Socket *s) {
532 SocketPort *p;
533
534 assert(s);
535
536 LIST_FOREACH(port, p, s->ports) {
537 if (p->fd < 0)
538 continue;
539
540 unit_unwatch_fd(UNIT(s), &p->fd_watch);
541 }
542 }
543
544 static int socket_watch_fds(Socket *s) {
545 SocketPort *p;
546 int r;
547
548 assert(s);
549
550 LIST_FOREACH(port, p, s->ports) {
551 if (p->fd < 0)
552 continue;
553
554 p->fd_watch.socket_accept =
555 s->accept &&
556 p->type == SOCKET_SOCKET &&
557 socket_address_can_accept(&p->address);
558
559 if ((r = unit_watch_fd(UNIT(s), p->fd, EPOLLIN, &p->fd_watch)) < 0)
560 goto fail;
561 }
562
563 return 0;
564
565 fail:
566 socket_unwatch_fds(s);
567 return r;
568 }
569
570 static void socket_set_state(Socket *s, SocketState state) {
571 SocketState old_state;
572 assert(s);
573
574 old_state = s->state;
575 s->state = state;
576
577 if (state != SOCKET_START_PRE &&
578 state != SOCKET_START_POST &&
579 state != SOCKET_STOP_PRE &&
580 state != SOCKET_STOP_PRE_SIGTERM &&
581 state != SOCKET_STOP_PRE_SIGKILL &&
582 state != SOCKET_STOP_POST &&
583 state != SOCKET_FINAL_SIGTERM &&
584 state != SOCKET_FINAL_SIGKILL) {
585 unit_unwatch_timer(UNIT(s), &s->timer_watch);
586 socket_unwatch_control_pid(s);
587 s->control_command = NULL;
588 s->control_command_id = _SOCKET_EXEC_COMMAND_INVALID;
589 }
590
591 if (state != SOCKET_LISTENING)
592 socket_unwatch_fds(s);
593
594 if (state != SOCKET_START_POST &&
595 state != SOCKET_LISTENING &&
596 state != SOCKET_RUNNING &&
597 state != SOCKET_STOP_PRE &&
598 state != SOCKET_STOP_PRE_SIGTERM &&
599 state != SOCKET_STOP_PRE_SIGKILL)
600 socket_close_fds(s);
601
602 if (state != old_state)
603 log_debug("%s changed %s -> %s",
604 s->meta.id,
605 socket_state_to_string(old_state),
606 socket_state_to_string(state));
607
608 unit_notify(UNIT(s), state_translation_table[old_state], state_translation_table[state]);
609 }
610
611 static int socket_coldplug(Unit *u) {
612 Socket *s = SOCKET(u);
613 int r;
614
615 assert(s);
616 assert(s->state == SOCKET_DEAD);
617
618 if (s->deserialized_state != s->state) {
619
620 if (s->deserialized_state == SOCKET_START_PRE ||
621 s->deserialized_state == SOCKET_START_POST ||
622 s->deserialized_state == SOCKET_STOP_PRE ||
623 s->deserialized_state == SOCKET_STOP_PRE_SIGTERM ||
624 s->deserialized_state == SOCKET_STOP_PRE_SIGKILL ||
625 s->deserialized_state == SOCKET_STOP_POST ||
626 s->deserialized_state == SOCKET_FINAL_SIGTERM ||
627 s->deserialized_state == SOCKET_FINAL_SIGKILL) {
628
629 if (s->control_pid <= 0)
630 return -EBADMSG;
631
632 if ((r = unit_watch_pid(UNIT(s), s->control_pid)) < 0)
633 return r;
634
635 if ((r = unit_watch_timer(UNIT(s), s->timeout_usec, &s->timer_watch)) < 0)
636 return r;
637 }
638
639 if (s->deserialized_state == SOCKET_START_POST ||
640 s->deserialized_state == SOCKET_LISTENING ||
641 s->deserialized_state == SOCKET_RUNNING ||
642 s->deserialized_state == SOCKET_STOP_PRE ||
643 s->deserialized_state == SOCKET_STOP_PRE_SIGTERM ||
644 s->deserialized_state == SOCKET_STOP_PRE_SIGKILL)
645 if ((r = socket_open_fds(s)) < 0)
646 return r;
647
648 if (s->deserialized_state == SOCKET_LISTENING)
649 if ((r = socket_watch_fds(s)) < 0)
650 return r;
651
652 socket_set_state(s, s->deserialized_state);
653 }
654
655 return 0;
656 }
657
658 static int socket_spawn(Socket *s, ExecCommand *c, pid_t *_pid) {
659 pid_t pid;
660 int r;
661 char **argv;
662
663 assert(s);
664 assert(c);
665 assert(_pid);
666
667 if ((r = unit_watch_timer(UNIT(s), s->timeout_usec, &s->timer_watch)) < 0)
668 goto fail;
669
670 if (!(argv = unit_full_printf_strv(UNIT(s), c->argv))) {
671 r = -ENOMEM;
672 goto fail;
673 }
674
675 r = exec_spawn(c,
676 argv,
677 &s->exec_context,
678 NULL, 0,
679 s->meta.manager->environment,
680 true,
681 true,
682 UNIT(s)->meta.manager->confirm_spawn,
683 UNIT(s)->meta.cgroup_bondings,
684 &pid);
685
686 strv_free(argv);
687 if (r < 0)
688 goto fail;
689
690 if ((r = unit_watch_pid(UNIT(s), pid)) < 0)
691 /* FIXME: we need to do something here */
692 goto fail;
693
694 *_pid = pid;
695
696 return 0;
697
698 fail:
699 unit_unwatch_timer(UNIT(s), &s->timer_watch);
700
701 return r;
702 }
703
704 static void socket_enter_dead(Socket *s, bool success) {
705 assert(s);
706
707 if (!success)
708 s->failure = true;
709
710 socket_set_state(s, s->failure ? SOCKET_MAINTENANCE : SOCKET_DEAD);
711 }
712
713 static void socket_enter_signal(Socket *s, SocketState state, bool success);
714
715 static void socket_enter_stop_post(Socket *s, bool success) {
716 int r;
717 assert(s);
718
719 if (!success)
720 s->failure = true;
721
722 socket_unwatch_control_pid(s);
723
724 s->control_command_id = SOCKET_EXEC_STOP_POST;
725
726 if ((s->control_command = s->exec_command[SOCKET_EXEC_STOP_POST])) {
727 if ((r = socket_spawn(s, s->control_command, &s->control_pid)) < 0)
728 goto fail;
729
730 socket_set_state(s, SOCKET_STOP_POST);
731 } else
732 socket_enter_signal(s, SOCKET_FINAL_SIGTERM, true);
733
734 return;
735
736 fail:
737 log_warning("%s failed to run stop-post executable: %s", s->meta.id, strerror(-r));
738 socket_enter_signal(s, SOCKET_FINAL_SIGTERM, false);
739 }
740
741 static void socket_enter_signal(Socket *s, SocketState state, bool success) {
742 int r;
743 bool sent = false;
744
745 assert(s);
746
747 if (!success)
748 s->failure = true;
749
750 if (s->kill_mode != KILL_NONE) {
751 int sig = (state == SOCKET_STOP_PRE_SIGTERM || state == SOCKET_FINAL_SIGTERM) ? SIGTERM : SIGKILL;
752
753 if (s->kill_mode == KILL_CONTROL_GROUP) {
754
755 if ((r = cgroup_bonding_kill_list(UNIT(s)->meta.cgroup_bondings, sig)) < 0) {
756 if (r != -EAGAIN && r != -ESRCH)
757 goto fail;
758 } else
759 sent = true;
760 }
761
762 if (!sent && s->control_pid > 0)
763 if (kill(s->kill_mode == KILL_PROCESS ? s->control_pid : -s->control_pid, sig) < 0 && errno != ESRCH) {
764 r = -errno;
765 goto fail;
766 }
767 }
768
769 if (sent && s->control_pid > 0) {
770 if ((r = unit_watch_timer(UNIT(s), s->timeout_usec, &s->timer_watch)) < 0)
771 goto fail;
772
773 socket_set_state(s, state);
774 } else if (state == SOCKET_STOP_PRE_SIGTERM || state == SOCKET_STOP_PRE_SIGKILL)
775 socket_enter_stop_post(s, true);
776 else
777 socket_enter_dead(s, true);
778
779 return;
780
781 fail:
782 log_warning("%s failed to kill processes: %s", s->meta.id, strerror(-r));
783
784 if (state == SOCKET_STOP_PRE_SIGTERM || state == SOCKET_STOP_PRE_SIGKILL)
785 socket_enter_stop_post(s, false);
786 else
787 socket_enter_dead(s, false);
788 }
789
790 static void socket_enter_stop_pre(Socket *s, bool success) {
791 int r;
792 assert(s);
793
794 if (!success)
795 s->failure = true;
796
797 socket_unwatch_control_pid(s);
798
799 s->control_command_id = SOCKET_EXEC_STOP_PRE;
800
801 if ((s->control_command = s->exec_command[SOCKET_EXEC_STOP_PRE])) {
802 if ((r = socket_spawn(s, s->control_command, &s->control_pid)) < 0)
803 goto fail;
804
805 socket_set_state(s, SOCKET_STOP_PRE);
806 } else
807 socket_enter_stop_post(s, true);
808
809 return;
810
811 fail:
812 log_warning("%s failed to run stop-pre executable: %s", s->meta.id, strerror(-r));
813 socket_enter_stop_post(s, false);
814 }
815
816 static void socket_enter_listening(Socket *s) {
817 int r;
818 assert(s);
819
820 if ((r = socket_watch_fds(s)) < 0) {
821 log_warning("%s failed to watch sockets: %s", s->meta.id, strerror(-r));
822 goto fail;
823 }
824
825 socket_set_state(s, SOCKET_LISTENING);
826 return;
827
828 fail:
829 socket_enter_stop_pre(s, false);
830 }
831
832 static void socket_enter_start_post(Socket *s) {
833 int r;
834 assert(s);
835
836 if ((r = socket_open_fds(s)) < 0) {
837 log_warning("%s failed to listen on sockets: %s", s->meta.id, strerror(-r));
838 goto fail;
839 }
840
841 socket_unwatch_control_pid(s);
842
843 s->control_command_id = SOCKET_EXEC_START_POST;
844
845 if ((s->control_command = s->exec_command[SOCKET_EXEC_START_POST])) {
846 if ((r = socket_spawn(s, s->control_command, &s->control_pid)) < 0) {
847 log_warning("%s failed to run start-post executable: %s", s->meta.id, strerror(-r));
848 goto fail;
849 }
850
851 socket_set_state(s, SOCKET_START_POST);
852 } else
853 socket_enter_listening(s);
854
855 return;
856
857 fail:
858 socket_enter_stop_pre(s, false);
859 }
860
861 static void socket_enter_start_pre(Socket *s) {
862 int r;
863 assert(s);
864
865 socket_unwatch_control_pid(s);
866
867 s->control_command_id = SOCKET_EXEC_START_PRE;
868
869 if ((s->control_command = s->exec_command[SOCKET_EXEC_START_PRE])) {
870 if ((r = socket_spawn(s, s->control_command, &s->control_pid)) < 0)
871 goto fail;
872
873 socket_set_state(s, SOCKET_START_PRE);
874 } else
875 socket_enter_start_post(s);
876
877 return;
878
879 fail:
880 log_warning("%s failed to run start-pre exectuable: %s", s->meta.id, strerror(-r));
881 socket_enter_dead(s, false);
882 }
883
884 static void socket_enter_running(Socket *s, int cfd) {
885 int r;
886
887 assert(s);
888
889 if (cfd < 0) {
890 if ((r = manager_add_job(UNIT(s)->meta.manager, JOB_START, UNIT(s->service), JOB_REPLACE, true, NULL)) < 0)
891 goto fail;
892
893 socket_set_state(s, SOCKET_RUNNING);
894 } else {
895 Unit *u;
896 char *prefix, *instance, *name;
897
898 if ((r = instance_from_socket(cfd, s->n_accepted++, &instance)) < 0)
899 goto fail;
900
901 if (!(prefix = unit_name_to_prefix(UNIT(s)->meta.id))) {
902 free(instance);
903 r = -ENOMEM;
904 goto fail;
905 }
906
907 name = unit_name_build(prefix, instance, ".service");
908 free(prefix);
909 free(instance);
910
911 if (!name) {
912 r = -ENOMEM;
913 goto fail;
914 }
915
916 r = manager_load_unit(UNIT(s)->meta.manager, name, NULL, &u);
917 free(name);
918
919 if (r < 0)
920 goto fail;
921
922 if ((r = service_set_socket_fd(SERVICE(u), cfd)) < 0)
923 goto fail;
924
925 cfd = -1;
926
927 if ((r = manager_add_job(u->meta.manager, JOB_START, u, JOB_REPLACE, true, NULL)) < 0)
928 goto fail;
929 }
930
931 return;
932
933 fail:
934 log_warning("%s failed to queue socket startup job: %s", s->meta.id, strerror(-r));
935 socket_enter_stop_pre(s, false);
936
937 if (cfd >= 0)
938 close_nointr_nofail(cfd);
939 }
940
941 static void socket_run_next(Socket *s, bool success) {
942 int r;
943
944 assert(s);
945 assert(s->control_command);
946 assert(s->control_command->command_next);
947
948 if (!success)
949 s->failure = true;
950
951 socket_unwatch_control_pid(s);
952
953 s->control_command = s->control_command->command_next;
954
955 if ((r = socket_spawn(s, s->control_command, &s->control_pid)) < 0)
956 goto fail;
957
958 return;
959
960 fail:
961 log_warning("%s failed to run spawn next executable: %s", s->meta.id, strerror(-r));
962
963 if (s->state == SOCKET_START_POST)
964 socket_enter_stop_pre(s, false);
965 else if (s->state == SOCKET_STOP_POST)
966 socket_enter_dead(s, false);
967 else
968 socket_enter_signal(s, SOCKET_FINAL_SIGTERM, false);
969 }
970
971 static int socket_start(Unit *u) {
972 Socket *s = SOCKET(u);
973
974 assert(s);
975
976 /* We cannot fulfill this request right now, try again later
977 * please! */
978 if (s->state == SOCKET_STOP_PRE ||
979 s->state == SOCKET_STOP_PRE_SIGKILL ||
980 s->state == SOCKET_STOP_PRE_SIGTERM ||
981 s->state == SOCKET_STOP_POST ||
982 s->state == SOCKET_FINAL_SIGTERM ||
983 s->state == SOCKET_FINAL_SIGKILL)
984 return -EAGAIN;
985
986 if (s->state == SOCKET_START_PRE ||
987 s->state == SOCKET_START_POST)
988 return 0;
989
990 /* Cannot run this without the service being around */
991 if (s->service) {
992 if (s->service->meta.load_state != UNIT_LOADED)
993 return -ENOENT;
994
995 /* If the service is alredy actvie we cannot start the
996 * socket */
997 if (s->service->state != SERVICE_DEAD &&
998 s->service->state != SERVICE_MAINTENANCE &&
999 s->service->state != SERVICE_AUTO_RESTART)
1000 return -EBUSY;
1001 }
1002
1003 assert(s->state == SOCKET_DEAD || s->state == SOCKET_MAINTENANCE);
1004
1005 s->failure = false;
1006 socket_enter_start_pre(s);
1007 return 0;
1008 }
1009
1010 static int socket_stop(Unit *u) {
1011 Socket *s = SOCKET(u);
1012
1013 assert(s);
1014
1015 /* We cannot fulfill this request right now, try again later
1016 * please! */
1017 if (s->state == SOCKET_START_PRE ||
1018 s->state == SOCKET_START_POST)
1019 return -EAGAIN;
1020
1021 /* Already on it */
1022 if (s->state == SOCKET_STOP_PRE ||
1023 s->state == SOCKET_STOP_PRE_SIGTERM ||
1024 s->state == SOCKET_STOP_PRE_SIGKILL ||
1025 s->state == SOCKET_STOP_POST ||
1026 s->state == SOCKET_FINAL_SIGTERM ||
1027 s->state == SOCKET_FINAL_SIGTERM)
1028 return 0;
1029
1030 assert(s->state == SOCKET_LISTENING || s->state == SOCKET_RUNNING);
1031
1032 socket_enter_stop_pre(s, true);
1033 return 0;
1034 }
1035
1036 static int socket_serialize(Unit *u, FILE *f, FDSet *fds) {
1037 Socket *s = SOCKET(u);
1038 SocketPort *p;
1039 int r;
1040
1041 assert(u);
1042 assert(f);
1043 assert(fds);
1044
1045 unit_serialize_item(u, f, "state", socket_state_to_string(s->state));
1046 unit_serialize_item(u, f, "failure", yes_no(s->failure));
1047 unit_serialize_item_format(u, f, "n-accepted", "%u", s->n_accepted);
1048
1049 if (s->control_pid > 0)
1050 unit_serialize_item_format(u, f, "control-pid", "%lu", (unsigned long) s->control_pid);
1051
1052 if (s->control_command_id >= 0)
1053 unit_serialize_item(u, f, "control-command", socket_exec_command_to_string(s->control_command_id));
1054
1055 LIST_FOREACH(port, p, s->ports) {
1056 int copy;
1057
1058 if (p->fd < 0)
1059 continue;
1060
1061 if ((copy = fdset_put_dup(fds, p->fd)) < 0)
1062 return copy;
1063
1064 if (p->type == SOCKET_SOCKET) {
1065 char *t;
1066
1067 if ((r = socket_address_print(&p->address, &t)) < 0)
1068 return r;
1069
1070 unit_serialize_item_format(u, f, "socket", "%i %i %s", copy, p->address.type, t);
1071 free(t);
1072 } else {
1073 assert(p->type == SOCKET_FIFO);
1074 unit_serialize_item_format(u, f, "fifo", "%i %s", copy, p->path);
1075 }
1076 }
1077
1078 return 0;
1079 }
1080
1081 static int socket_deserialize_item(Unit *u, const char *key, const char *value, FDSet *fds) {
1082 Socket *s = SOCKET(u);
1083 int r;
1084
1085 assert(u);
1086 assert(key);
1087 assert(value);
1088 assert(fds);
1089
1090 if (streq(key, "state")) {
1091 SocketState state;
1092
1093 if ((state = socket_state_from_string(value)) < 0)
1094 log_debug("Failed to parse state value %s", value);
1095 else
1096 s->deserialized_state = state;
1097 } else if (streq(key, "failure")) {
1098 int b;
1099
1100 if ((b = parse_boolean(value)) < 0)
1101 log_debug("Failed to parse failure value %s", value);
1102 else
1103 s->failure = b || s->failure;
1104
1105 } else if (streq(key, "n-accepted")) {
1106 unsigned k;
1107
1108 if ((r = safe_atou(value, &k)) < 0)
1109 log_debug("Failed to parse n-accepted value %s", value);
1110 else
1111 s->n_accepted += k;
1112 } else if (streq(key, "control-pid")) {
1113 pid_t pid;
1114
1115 if ((r = parse_pid(value, &pid)) < 0)
1116 log_debug("Failed to parse control-pid value %s", value);
1117 else
1118 s->control_pid = pid;
1119 } else if (streq(key, "control-command")) {
1120 SocketExecCommand id;
1121
1122 if ((id = socket_exec_command_from_string(value)) < 0)
1123 log_debug("Failed to parse exec-command value %s", value);
1124 else {
1125 s->control_command_id = id;
1126 s->control_command = s->exec_command[id];
1127 }
1128 } else if (streq(key, "fifo")) {
1129 int fd, skip = 0;
1130 SocketPort *p;
1131
1132 if (sscanf(value, "%i %n", &fd, &skip) < 1 || fd < 0 || !fdset_contains(fds, fd))
1133 log_debug("Failed to parse fifo value %s", value);
1134 else {
1135
1136 LIST_FOREACH(port, p, s->ports)
1137 if (streq(p->path, value+skip))
1138 break;
1139
1140 if (p) {
1141 if (p->fd >= 0)
1142 close_nointr_nofail(p->fd);
1143 p->fd = fdset_remove(fds, fd);
1144 }
1145 }
1146
1147 } else if (streq(key, "socket")) {
1148 int fd, type, skip = 0;
1149 SocketPort *p;
1150
1151 if (sscanf(value, "%i %i %n", &fd, &type, &skip) < 2 || fd < 0 || type < 0 || !fdset_contains(fds, fd))
1152 log_debug("Failed to parse socket value %s", value);
1153 else {
1154
1155 LIST_FOREACH(port, p, s->ports)
1156 if (socket_address_is(&p->address, value+skip, type))
1157 break;
1158
1159 if (p) {
1160 if (p->fd >= 0)
1161 close_nointr_nofail(p->fd);
1162 p->fd = fdset_remove(fds, fd);
1163 }
1164 }
1165
1166 } else
1167 log_debug("Unknown serialization key '%s'", key);
1168
1169 return 0;
1170 }
1171
1172 static UnitActiveState socket_active_state(Unit *u) {
1173 assert(u);
1174
1175 return state_translation_table[SOCKET(u)->state];
1176 }
1177
1178 static const char *socket_sub_state_to_string(Unit *u) {
1179 assert(u);
1180
1181 return socket_state_to_string(SOCKET(u)->state);
1182 }
1183
1184 static void socket_fd_event(Unit *u, int fd, uint32_t events, Watch *w) {
1185 Socket *s = SOCKET(u);
1186 int cfd = -1;
1187
1188 assert(s);
1189 assert(fd >= 0);
1190
1191 if (s->state != SOCKET_LISTENING)
1192 return;
1193
1194 log_debug("Incoming traffic on %s", u->meta.id);
1195
1196 if (events != EPOLLIN) {
1197 log_error("Got invalid poll event on socket.");
1198 goto fail;
1199 }
1200
1201 if (w->socket_accept) {
1202 for (;;) {
1203
1204 if ((cfd = accept4(fd, NULL, NULL, SOCK_NONBLOCK)) < 0) {
1205
1206 if (errno == EINTR)
1207 continue;
1208
1209 log_error("Failed to accept socket: %m");
1210 goto fail;
1211 }
1212
1213 break;
1214 }
1215 }
1216
1217 socket_enter_running(s, cfd);
1218 return;
1219
1220 fail:
1221 socket_enter_stop_pre(s, false);
1222 }
1223
1224 static void socket_sigchld_event(Unit *u, pid_t pid, int code, int status) {
1225 Socket *s = SOCKET(u);
1226 bool success;
1227
1228 assert(s);
1229 assert(pid >= 0);
1230
1231 if (pid != s->control_pid)
1232 return;
1233
1234 s->control_pid = 0;
1235
1236 success = is_clean_exit(code, status);
1237 s->failure = s->failure || !success;
1238
1239 if (s->control_command)
1240 exec_status_fill(&s->control_command->exec_status, pid, code, status);
1241
1242 log_debug("%s control process exited, code=%s status=%i", u->meta.id, sigchld_code_to_string(code), status);
1243
1244 if (s->control_command && s->control_command->command_next && success) {
1245 log_debug("%s running next command for state %s", u->meta.id, socket_state_to_string(s->state));
1246 socket_run_next(s, success);
1247 } else {
1248 s->control_command = NULL;
1249 s->control_command_id = _SOCKET_EXEC_COMMAND_INVALID;
1250
1251 /* No further commands for this step, so let's figure
1252 * out what to do next */
1253
1254 log_debug("%s got final SIGCHLD for state %s", u->meta.id, socket_state_to_string(s->state));
1255
1256 switch (s->state) {
1257
1258 case SOCKET_START_PRE:
1259 if (success)
1260 socket_enter_start_post(s);
1261 else
1262 socket_enter_signal(s, SOCKET_FINAL_SIGTERM, false);
1263 break;
1264
1265 case SOCKET_START_POST:
1266 if (success)
1267 socket_enter_listening(s);
1268 else
1269 socket_enter_stop_pre(s, false);
1270 break;
1271
1272 case SOCKET_STOP_PRE:
1273 case SOCKET_STOP_PRE_SIGTERM:
1274 case SOCKET_STOP_PRE_SIGKILL:
1275 socket_enter_stop_post(s, success);
1276 break;
1277
1278 case SOCKET_STOP_POST:
1279 case SOCKET_FINAL_SIGTERM:
1280 case SOCKET_FINAL_SIGKILL:
1281 socket_enter_dead(s, success);
1282 break;
1283
1284 default:
1285 assert_not_reached("Uh, control process died at wrong time.");
1286 }
1287 }
1288 }
1289
1290 static void socket_timer_event(Unit *u, uint64_t elapsed, Watch *w) {
1291 Socket *s = SOCKET(u);
1292
1293 assert(s);
1294 assert(elapsed == 1);
1295 assert(w == &s->timer_watch);
1296
1297 switch (s->state) {
1298
1299 case SOCKET_START_PRE:
1300 log_warning("%s starting timed out. Terminating.", u->meta.id);
1301 socket_enter_signal(s, SOCKET_FINAL_SIGTERM, false);
1302
1303 case SOCKET_START_POST:
1304 log_warning("%s starting timed out. Stopping.", u->meta.id);
1305 socket_enter_stop_pre(s, false);
1306 break;
1307
1308 case SOCKET_STOP_PRE:
1309 log_warning("%s stopping timed out. Terminating.", u->meta.id);
1310 socket_enter_signal(s, SOCKET_STOP_PRE_SIGTERM, false);
1311 break;
1312
1313 case SOCKET_STOP_PRE_SIGTERM:
1314 log_warning("%s stopping timed out. Killing.", u->meta.id);
1315 socket_enter_signal(s, SOCKET_STOP_PRE_SIGKILL, false);
1316 break;
1317
1318 case SOCKET_STOP_PRE_SIGKILL:
1319 log_warning("%s still around after SIGKILL. Ignoring.", u->meta.id);
1320 socket_enter_stop_post(s, false);
1321 break;
1322
1323 case SOCKET_STOP_POST:
1324 log_warning("%s stopping timed out (2). Terminating.", u->meta.id);
1325 socket_enter_signal(s, SOCKET_FINAL_SIGTERM, false);
1326 break;
1327
1328 case SOCKET_FINAL_SIGTERM:
1329 log_warning("%s stopping timed out (2). Killing.", u->meta.id);
1330 socket_enter_signal(s, SOCKET_FINAL_SIGKILL, false);
1331 break;
1332
1333 case SOCKET_FINAL_SIGKILL:
1334 log_warning("%s still around after SIGKILL (2). Entering maintenance mode.", u->meta.id);
1335 socket_enter_dead(s, false);
1336 break;
1337
1338 default:
1339 assert_not_reached("Timeout at wrong time.");
1340 }
1341 }
1342
1343 int socket_collect_fds(Socket *s, int **fds, unsigned *n_fds) {
1344 int *rfds;
1345 unsigned rn_fds, k;
1346 SocketPort *p;
1347
1348 assert(s);
1349 assert(fds);
1350 assert(n_fds);
1351
1352 /* Called from the service code for requesting our fds */
1353
1354 rn_fds = 0;
1355 LIST_FOREACH(port, p, s->ports)
1356 if (p->fd >= 0)
1357 rn_fds++;
1358
1359 if (!(rfds = new(int, rn_fds)) < 0)
1360 return -ENOMEM;
1361
1362 k = 0;
1363 LIST_FOREACH(port, p, s->ports)
1364 if (p->fd >= 0)
1365 rfds[k++] = p->fd;
1366
1367 assert(k == rn_fds);
1368
1369 *fds = rfds;
1370 *n_fds = rn_fds;
1371
1372 return 0;
1373 }
1374
1375 void socket_notify_service_dead(Socket *s) {
1376 assert(s);
1377
1378 /* The service is dead. Dang. */
1379
1380 if (s->state == SOCKET_RUNNING) {
1381 log_debug("%s got notified about service death.", s->meta.id);
1382 socket_enter_listening(s);
1383 }
1384 }
1385
1386 static const char* const socket_state_table[_SOCKET_STATE_MAX] = {
1387 [SOCKET_DEAD] = "dead",
1388 [SOCKET_START_PRE] = "start-pre",
1389 [SOCKET_START_POST] = "start-post",
1390 [SOCKET_LISTENING] = "listening",
1391 [SOCKET_RUNNING] = "running",
1392 [SOCKET_STOP_PRE] = "stop-pre",
1393 [SOCKET_STOP_PRE_SIGTERM] = "stop-pre-sigterm",
1394 [SOCKET_STOP_PRE_SIGKILL] = "stop-pre-sigkill",
1395 [SOCKET_STOP_POST] = "stop-post",
1396 [SOCKET_FINAL_SIGTERM] = "final-sigterm",
1397 [SOCKET_FINAL_SIGKILL] = "final-sigkill",
1398 [SOCKET_MAINTENANCE] = "maintenance"
1399 };
1400
1401 DEFINE_STRING_TABLE_LOOKUP(socket_state, SocketState);
1402
1403 static const char* const socket_exec_command_table[_SOCKET_EXEC_COMMAND_MAX] = {
1404 [SOCKET_EXEC_START_PRE] = "StartPre",
1405 [SOCKET_EXEC_START_POST] = "StartPost",
1406 [SOCKET_EXEC_STOP_PRE] = "StopPre",
1407 [SOCKET_EXEC_STOP_POST] = "StopPost"
1408 };
1409
1410 DEFINE_STRING_TABLE_LOOKUP(socket_exec_command, SocketExecCommand);
1411
1412 const UnitVTable socket_vtable = {
1413 .suffix = ".socket",
1414
1415 .init = socket_init,
1416 .done = socket_done,
1417 .load = socket_load,
1418
1419 .coldplug = socket_coldplug,
1420
1421 .dump = socket_dump,
1422
1423 .start = socket_start,
1424 .stop = socket_stop,
1425
1426 .serialize = socket_serialize,
1427 .deserialize_item = socket_deserialize_item,
1428
1429 .active_state = socket_active_state,
1430 .sub_state_to_string = socket_sub_state_to_string,
1431
1432 .fd_event = socket_fd_event,
1433 .sigchld_event = socket_sigchld_event,
1434 .timer_event = socket_timer_event,
1435
1436 .bus_message_handler = bus_socket_message_handler
1437 };