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