chiark / gitweb /
units: automatically generated syslog.target
[elogind.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_MAINTAINANCE] = 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->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
72 static 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
82 static 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
114 static 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
134 static 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
148 static 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
168 int 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
190 static 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
203 static 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
221 static 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
258 static 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
271 static 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, yes_no(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
347 static 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                 char a[INET6_ADDRSTRLEN], b[INET6_ADDRSTRLEN];
390
391                 if (asprintf(&r,
392                              "%u-%s:%u-%s:%u",
393                              nr,
394                              inet_ntop(AF_INET6, &local.in6.sin6_addr, a, sizeof(a)),
395                              ntohs(local.in6.sin6_port),
396                              inet_ntop(AF_INET6, &remote.in6.sin6_addr, b, sizeof(b)),
397                              ntohs(remote.in6.sin6_port)) < 0)
398                         return -ENOMEM;
399
400                 break;
401         }
402
403         case AF_UNIX: {
404                 struct ucred ucred;
405
406                 l = sizeof(ucred);
407                 if (getsockopt(fd, SOL_SOCKET, SO_PEERCRED, &ucred, &l) < 0)
408                         return -errno;
409
410                 if (asprintf(&r,
411                              "%u-%llu-%llu",
412                              nr,
413                              (unsigned long long) ucred.pid,
414                              (unsigned long long) ucred.uid) < 0)
415                         return -ENOMEM;
416
417                 break;
418         }
419
420         default:
421                 assert_not_reached("Unhandled socket type.");
422         }
423
424         *instance = r;
425         return 0;
426 }
427
428 static void socket_close_fds(Socket *s) {
429         SocketPort *p;
430
431         assert(s);
432
433         LIST_FOREACH(port, p, s->ports) {
434                 if (p->fd < 0)
435                         continue;
436
437                 unit_unwatch_fd(UNIT(s), &p->fd_watch);
438                 close_nointr_nofail(p->fd);
439
440                 /* One little note: we should never delete any sockets
441                  * in the file system here! After all some other
442                  * process we spawned might still have a reference of
443                  * this fd and wants to continue to use it. Therefore
444                  * we delete sockets in the file system before we
445                  * create a new one, not after we stopped using
446                  * one! */
447
448                 p->fd = -1;
449         }
450 }
451
452 static int socket_open_fds(Socket *s) {
453         SocketPort *p;
454         int r;
455
456         assert(s);
457
458         LIST_FOREACH(port, p, s->ports) {
459
460                 if (p->fd >= 0)
461                         continue;
462
463                 if (p->type == SOCKET_SOCKET) {
464
465                         if ((r = socket_address_listen(
466                                              &p->address,
467                                              s->backlog,
468                                              s->bind_ipv6_only,
469                                              s->bind_to_device,
470                                              s->directory_mode,
471                                              s->socket_mode,
472                                              &p->fd)) < 0)
473                                 goto rollback;
474
475                 } else {
476                         struct stat st;
477                         assert(p->type == SOCKET_FIFO);
478
479                         mkdir_parents(p->path, s->directory_mode);
480
481                         if (mkfifo(p->path, s->socket_mode) < 0 && errno != EEXIST) {
482                                 r = -errno;
483                                 goto rollback;
484                         }
485
486                         if ((p->fd = open(p->path, O_RDWR|O_CLOEXEC|O_NOCTTY|O_NONBLOCK|O_NOFOLLOW)) < 0) {
487                                 r = -errno;
488                                 goto rollback;
489                         }
490
491                         if (fstat(p->fd, &st) < 0) {
492                                 r = -errno;
493                                 goto rollback;
494                         }
495
496                         /* FIXME verify user, access mode */
497
498                         if (!S_ISFIFO(st.st_mode)) {
499                                 r = -EEXIST;
500                                 goto rollback;
501                         }
502                 }
503         }
504
505         return 0;
506
507 rollback:
508         socket_close_fds(s);
509         return r;
510 }
511
512 static void socket_unwatch_fds(Socket *s) {
513         SocketPort *p;
514
515         assert(s);
516
517         LIST_FOREACH(port, p, s->ports) {
518                 if (p->fd < 0)
519                         continue;
520
521                 unit_unwatch_fd(UNIT(s), &p->fd_watch);
522         }
523 }
524
525 static int socket_watch_fds(Socket *s) {
526         SocketPort *p;
527         int r;
528
529         assert(s);
530
531         LIST_FOREACH(port, p, s->ports) {
532                 if (p->fd < 0)
533                         continue;
534
535                 p->fd_watch.socket_accept =
536                         s->accept &&
537                         p->type == SOCKET_SOCKET &&
538                         socket_address_can_accept(&p->address);
539
540                 if ((r = unit_watch_fd(UNIT(s), p->fd, EPOLLIN, &p->fd_watch)) < 0)
541                         goto fail;
542         }
543
544         return 0;
545
546 fail:
547         socket_unwatch_fds(s);
548         return r;
549 }
550
551 static void socket_set_state(Socket *s, SocketState state) {
552         SocketState old_state;
553         assert(s);
554
555         old_state = s->state;
556         s->state = state;
557
558         if (state != SOCKET_START_PRE &&
559             state != SOCKET_START_POST &&
560             state != SOCKET_STOP_PRE &&
561             state != SOCKET_STOP_PRE_SIGTERM &&
562             state != SOCKET_STOP_PRE_SIGKILL &&
563             state != SOCKET_STOP_POST &&
564             state != SOCKET_FINAL_SIGTERM &&
565             state != SOCKET_FINAL_SIGKILL) {
566                 unit_unwatch_timer(UNIT(s), &s->timer_watch);
567                 socket_unwatch_control_pid(s);
568                 s->control_command = NULL;
569                 s->control_command_id = _SOCKET_EXEC_COMMAND_INVALID;
570         }
571
572         if (state != SOCKET_LISTENING)
573                 socket_unwatch_fds(s);
574
575         if (state != SOCKET_START_POST &&
576             state != SOCKET_LISTENING &&
577             state != SOCKET_RUNNING &&
578             state != SOCKET_STOP_PRE &&
579             state != SOCKET_STOP_PRE_SIGTERM &&
580             state != SOCKET_STOP_PRE_SIGKILL)
581                 socket_close_fds(s);
582
583         if (state != old_state)
584                 log_debug("%s changed %s -> %s",
585                           s->meta.id,
586                           socket_state_to_string(old_state),
587                           socket_state_to_string(state));
588
589         unit_notify(UNIT(s), state_translation_table[old_state], state_translation_table[state]);
590 }
591
592 static int socket_coldplug(Unit *u) {
593         Socket *s = SOCKET(u);
594         int r;
595
596         assert(s);
597         assert(s->state == SOCKET_DEAD);
598
599         if (s->deserialized_state != s->state) {
600
601                 if (s->deserialized_state == SOCKET_START_PRE ||
602                     s->deserialized_state == SOCKET_START_POST ||
603                     s->deserialized_state == SOCKET_STOP_PRE ||
604                     s->deserialized_state == SOCKET_STOP_PRE_SIGTERM ||
605                     s->deserialized_state == SOCKET_STOP_PRE_SIGKILL ||
606                     s->deserialized_state == SOCKET_STOP_POST ||
607                     s->deserialized_state == SOCKET_FINAL_SIGTERM ||
608                     s->deserialized_state == SOCKET_FINAL_SIGKILL) {
609
610                         if (s->control_pid <= 0)
611                                 return -EBADMSG;
612
613                         if ((r = unit_watch_pid(UNIT(s), s->control_pid)) < 0)
614                                 return r;
615
616                         if ((r = unit_watch_timer(UNIT(s), s->timeout_usec, &s->timer_watch)) < 0)
617                                 return r;
618                 }
619
620                 if (s->deserialized_state == SOCKET_START_POST ||
621                     s->deserialized_state == SOCKET_LISTENING ||
622                     s->deserialized_state == SOCKET_RUNNING ||
623                     s->deserialized_state == SOCKET_STOP_PRE ||
624                     s->deserialized_state == SOCKET_STOP_PRE_SIGTERM ||
625                     s->deserialized_state == SOCKET_STOP_PRE_SIGKILL)
626                         if ((r = socket_open_fds(s)) < 0)
627                                 return r;
628
629                 if (s->deserialized_state == SOCKET_LISTENING)
630                         if ((r = socket_watch_fds(s)) < 0)
631                                 return r;
632
633                 socket_set_state(s, s->deserialized_state);
634         }
635
636         return 0;
637 }
638
639 static int socket_spawn(Socket *s, ExecCommand *c, pid_t *_pid) {
640         pid_t pid;
641         int r;
642         char **argv;
643
644         assert(s);
645         assert(c);
646         assert(_pid);
647
648         if ((r = unit_watch_timer(UNIT(s), s->timeout_usec, &s->timer_watch)) < 0)
649                 goto fail;
650
651         if (!(argv = unit_full_printf_strv(UNIT(s), c->argv))) {
652                 r = -ENOMEM;
653                 goto fail;
654         }
655
656         r = exec_spawn(c,
657                        argv,
658                        &s->exec_context,
659                        NULL, 0,
660                        s->meta.manager->environment,
661                        true,
662                        true,
663                        UNIT(s)->meta.manager->confirm_spawn,
664                        UNIT(s)->meta.cgroup_bondings,
665                        &pid);
666
667         strv_free(argv);
668         if (r < 0)
669                 goto fail;
670
671         if ((r = unit_watch_pid(UNIT(s), pid)) < 0)
672                 /* FIXME: we need to do something here */
673                 goto fail;
674
675         *_pid = pid;
676
677         return 0;
678
679 fail:
680         unit_unwatch_timer(UNIT(s), &s->timer_watch);
681
682         return r;
683 }
684
685 static void socket_enter_dead(Socket *s, bool success) {
686         assert(s);
687
688         if (!success)
689                 s->failure = true;
690
691         socket_set_state(s, s->failure ? SOCKET_MAINTAINANCE : SOCKET_DEAD);
692 }
693
694 static void socket_enter_signal(Socket *s, SocketState state, bool success);
695
696 static void socket_enter_stop_post(Socket *s, bool success) {
697         int r;
698         assert(s);
699
700         if (!success)
701                 s->failure = true;
702
703         socket_unwatch_control_pid(s);
704
705         s->control_command_id = SOCKET_EXEC_STOP_POST;
706
707         if ((s->control_command = s->exec_command[SOCKET_EXEC_STOP_POST])) {
708                 if ((r = socket_spawn(s, s->control_command, &s->control_pid)) < 0)
709                         goto fail;
710
711                 socket_set_state(s, SOCKET_STOP_POST);
712         } else
713                 socket_enter_signal(s, SOCKET_FINAL_SIGTERM, true);
714
715         return;
716
717 fail:
718         log_warning("%s failed to run stop-post executable: %s", s->meta.id, strerror(-r));
719         socket_enter_signal(s, SOCKET_FINAL_SIGTERM, false);
720 }
721
722 static void socket_enter_signal(Socket *s, SocketState state, bool success) {
723         int r;
724         bool sent = false;
725
726         assert(s);
727
728         if (!success)
729                 s->failure = true;
730
731         if (s->kill_mode != KILL_NONE) {
732                 int sig = (state == SOCKET_STOP_PRE_SIGTERM || state == SOCKET_FINAL_SIGTERM) ? SIGTERM : SIGKILL;
733
734                 if (s->kill_mode == KILL_CONTROL_GROUP) {
735
736                         if ((r = cgroup_bonding_kill_list(UNIT(s)->meta.cgroup_bondings, sig)) < 0) {
737                                 if (r != -EAGAIN && r != -ESRCH)
738                                         goto fail;
739                         } else
740                                 sent = true;
741                 }
742
743                 if (!sent && s->control_pid > 0)
744                         if (kill(s->kill_mode == KILL_PROCESS ? s->control_pid : -s->control_pid, sig) < 0 && errno != ESRCH) {
745                                 r = -errno;
746                                 goto fail;
747                         }
748         }
749
750         if (sent && s->control_pid > 0) {
751                 if ((r = unit_watch_timer(UNIT(s), s->timeout_usec, &s->timer_watch)) < 0)
752                         goto fail;
753
754                 socket_set_state(s, state);
755         } else if (state == SOCKET_STOP_PRE_SIGTERM || state == SOCKET_STOP_PRE_SIGKILL)
756                 socket_enter_stop_post(s, true);
757         else
758                 socket_enter_dead(s, true);
759
760         return;
761
762 fail:
763         log_warning("%s failed to kill processes: %s", s->meta.id, strerror(-r));
764
765         if (state == SOCKET_STOP_PRE_SIGTERM || state == SOCKET_STOP_PRE_SIGKILL)
766                 socket_enter_stop_post(s, false);
767         else
768                 socket_enter_dead(s, false);
769 }
770
771 static void socket_enter_stop_pre(Socket *s, bool success) {
772         int r;
773         assert(s);
774
775         if (!success)
776                 s->failure = true;
777
778         socket_unwatch_control_pid(s);
779
780         s->control_command_id = SOCKET_EXEC_STOP_PRE;
781
782         if ((s->control_command = s->exec_command[SOCKET_EXEC_STOP_PRE])) {
783                 if ((r = socket_spawn(s, s->control_command, &s->control_pid)) < 0)
784                         goto fail;
785
786                 socket_set_state(s, SOCKET_STOP_PRE);
787         } else
788                 socket_enter_stop_post(s, true);
789
790         return;
791
792 fail:
793         log_warning("%s failed to run stop-pre executable: %s", s->meta.id, strerror(-r));
794         socket_enter_stop_post(s, false);
795 }
796
797 static void socket_enter_listening(Socket *s) {
798         int r;
799         assert(s);
800
801         if ((r = socket_watch_fds(s)) < 0) {
802                 log_warning("%s failed to watch sockets: %s", s->meta.id, strerror(-r));
803                 goto fail;
804         }
805
806         socket_set_state(s, SOCKET_LISTENING);
807         return;
808
809 fail:
810         socket_enter_stop_pre(s, false);
811 }
812
813 static void socket_enter_start_post(Socket *s) {
814         int r;
815         assert(s);
816
817         if ((r = socket_open_fds(s)) < 0) {
818                 log_warning("%s failed to listen on sockets: %s", s->meta.id, strerror(-r));
819                 goto fail;
820         }
821
822         socket_unwatch_control_pid(s);
823
824         s->control_command_id = SOCKET_EXEC_START_POST;
825
826         if ((s->control_command = s->exec_command[SOCKET_EXEC_START_POST])) {
827                 if ((r = socket_spawn(s, s->control_command, &s->control_pid)) < 0) {
828                         log_warning("%s failed to run start-post executable: %s", s->meta.id, strerror(-r));
829                         goto fail;
830                 }
831
832                 socket_set_state(s, SOCKET_START_POST);
833         } else
834                 socket_enter_listening(s);
835
836         return;
837
838 fail:
839         socket_enter_stop_pre(s, false);
840 }
841
842 static void socket_enter_start_pre(Socket *s) {
843         int r;
844         assert(s);
845
846         socket_unwatch_control_pid(s);
847
848         s->control_command_id = SOCKET_EXEC_START_PRE;
849
850         if ((s->control_command = s->exec_command[SOCKET_EXEC_START_PRE])) {
851                 if ((r = socket_spawn(s, s->control_command, &s->control_pid)) < 0)
852                         goto fail;
853
854                 socket_set_state(s, SOCKET_START_PRE);
855         } else
856                 socket_enter_start_post(s);
857
858         return;
859
860 fail:
861         log_warning("%s failed to run start-pre exectuable: %s", s->meta.id, strerror(-r));
862         socket_enter_dead(s, false);
863 }
864
865 static void socket_enter_running(Socket *s, int cfd) {
866         int r;
867
868         assert(s);
869
870         if (cfd < 0) {
871                 if ((r = manager_add_job(UNIT(s)->meta.manager, JOB_START, UNIT(s->service), JOB_REPLACE, true, NULL)) < 0)
872                         goto fail;
873
874                 socket_set_state(s, SOCKET_RUNNING);
875         } else {
876                 Unit *u;
877                 char *prefix, *instance, *name;
878
879                 if ((r = instance_from_socket(cfd, s->n_accepted++, &instance)))
880                         goto fail;
881
882                 if (!(prefix = unit_name_to_prefix(UNIT(s)->meta.id))) {
883                         free(instance);
884                         r = -ENOMEM;
885                         goto fail;
886                 }
887
888                 name = unit_name_build(prefix, instance, ".service");
889                 free(prefix);
890                 free(instance);
891
892                 if (!name)
893                         r = -ENOMEM;
894
895                 r = manager_load_unit(UNIT(s)->meta.manager, name, NULL, &u);
896                 free(name);
897
898                 if (r < 0)
899                         goto fail;
900
901                 if ((r = service_set_socket_fd(SERVICE(u), cfd) < 0))
902                         goto fail;
903
904                 cfd = -1;
905
906                 if ((r = manager_add_job(u->meta.manager, JOB_START, u, JOB_REPLACE, true, NULL)) < 0)
907                         goto fail;
908         }
909
910         return;
911
912 fail:
913         log_warning("%s failed to queue socket startup job: %s", s->meta.id, strerror(-r));
914         socket_enter_stop_pre(s, false);
915
916         if (cfd >= 0)
917                 close_nointr_nofail(cfd);
918 }
919
920 static void socket_run_next(Socket *s, bool success) {
921         int r;
922
923         assert(s);
924         assert(s->control_command);
925         assert(s->control_command->command_next);
926
927         if (!success)
928                 s->failure = true;
929
930         socket_unwatch_control_pid(s);
931
932         s->control_command = s->control_command->command_next;
933
934         if ((r = socket_spawn(s, s->control_command, &s->control_pid)) < 0)
935                 goto fail;
936
937         return;
938
939 fail:
940         log_warning("%s failed to run spawn next executable: %s", s->meta.id, strerror(-r));
941
942         if (s->state == SOCKET_START_POST)
943                 socket_enter_stop_pre(s, false);
944         else if (s->state == SOCKET_STOP_POST)
945                 socket_enter_dead(s, false);
946         else
947                 socket_enter_signal(s, SOCKET_FINAL_SIGTERM, false);
948 }
949
950 static int socket_start(Unit *u) {
951         Socket *s = SOCKET(u);
952
953         assert(s);
954
955         /* We cannot fulfill this request right now, try again later
956          * please! */
957         if (s->state == SOCKET_STOP_PRE ||
958             s->state == SOCKET_STOP_PRE_SIGKILL ||
959             s->state == SOCKET_STOP_PRE_SIGTERM ||
960             s->state == SOCKET_STOP_POST ||
961             s->state == SOCKET_FINAL_SIGTERM ||
962             s->state == SOCKET_FINAL_SIGKILL)
963                 return -EAGAIN;
964
965         if (s->state == SOCKET_START_PRE ||
966             s->state == SOCKET_START_POST)
967                 return 0;
968
969         /* Cannot run this without the service being around */
970         if (s->service) {
971                 if (s->service->meta.load_state != UNIT_LOADED)
972                         return -ENOENT;
973
974                 /* If the service is alredy actvie we cannot start the
975                  * socket */
976                 if (s->service->state != SERVICE_DEAD &&
977                     s->service->state != SERVICE_MAINTAINANCE &&
978                     s->service->state != SERVICE_AUTO_RESTART)
979                         return -EBUSY;
980         }
981
982         assert(s->state == SOCKET_DEAD || s->state == SOCKET_MAINTAINANCE);
983
984         s->failure = false;
985         socket_enter_start_pre(s);
986         return 0;
987 }
988
989 static int socket_stop(Unit *u) {
990         Socket *s = SOCKET(u);
991
992         assert(s);
993
994         /* We cannot fulfill this request right now, try again later
995          * please! */
996         if (s->state == SOCKET_START_PRE ||
997             s->state == SOCKET_START_POST)
998                 return -EAGAIN;
999
1000         /* Already on it */
1001         if (s->state == SOCKET_STOP_PRE ||
1002             s->state == SOCKET_STOP_PRE_SIGTERM ||
1003             s->state == SOCKET_STOP_PRE_SIGKILL ||
1004             s->state == SOCKET_STOP_POST ||
1005             s->state == SOCKET_FINAL_SIGTERM ||
1006             s->state == SOCKET_FINAL_SIGTERM)
1007                 return 0;
1008
1009         assert(s->state == SOCKET_LISTENING || s->state == SOCKET_RUNNING);
1010
1011         socket_enter_stop_pre(s, true);
1012         return 0;
1013 }
1014
1015 static int socket_serialize(Unit *u, FILE *f, FDSet *fds) {
1016         Socket *s = SOCKET(u);
1017         SocketPort *p;
1018         int r;
1019
1020         assert(u);
1021         assert(f);
1022         assert(fds);
1023
1024         unit_serialize_item(u, f, "state", socket_state_to_string(s->state));
1025         unit_serialize_item(u, f, "failure", yes_no(s->failure));
1026         unit_serialize_item_format(u, f, "n-accepted", "%u", s->n_accepted);
1027
1028         if (s->control_pid > 0)
1029                 unit_serialize_item_format(u, f, "control-pid", "%u", (unsigned) s->control_pid);
1030
1031         if (s->control_command_id >= 0)
1032                 unit_serialize_item(u, f, "control-command", socket_exec_command_to_string(s->control_command_id));
1033
1034         LIST_FOREACH(port, p, s->ports) {
1035                 int copy;
1036
1037                 if (p->fd < 0)
1038                         continue;
1039
1040                 if ((copy = fdset_put_dup(fds, p->fd)) < 0)
1041                         return copy;
1042
1043                 if (p->type == SOCKET_SOCKET) {
1044                         char *t;
1045
1046                         if ((r = socket_address_print(&p->address, &t)) < 0)
1047                                 return r;
1048
1049                         unit_serialize_item_format(u, f, "socket", "%i %s", copy, t);
1050                         free(t);
1051                 } else {
1052                         assert(p->type == SOCKET_FIFO);
1053                         unit_serialize_item_format(u, f, "fifo", "%i %s", copy, p->path);
1054                 }
1055         }
1056
1057         return 0;
1058 }
1059
1060 static int socket_deserialize_item(Unit *u, const char *key, const char *value, FDSet *fds) {
1061         Socket *s = SOCKET(u);
1062         int r;
1063
1064         assert(u);
1065         assert(key);
1066         assert(value);
1067         assert(fds);
1068
1069         if (streq(key, "state")) {
1070                 SocketState state;
1071
1072                 if ((state = socket_state_from_string(value)) < 0)
1073                         log_debug("Failed to parse state value %s", value);
1074                 else
1075                         s->deserialized_state = state;
1076         } else if (streq(key, "failure")) {
1077                 int b;
1078
1079                 if ((b = parse_boolean(value)) < 0)
1080                         log_debug("Failed to parse failure value %s", value);
1081                 else
1082                         s->failure = b || s->failure;
1083
1084         } else if (streq(key, "n-accepted")) {
1085                 unsigned k;
1086
1087                 if ((r = safe_atou(value, &k)) < 0)
1088                         log_debug("Failed to parse n-accepted value %s", value);
1089                 else
1090                         s->n_accepted += k;
1091         } else if (streq(key, "control-pid")) {
1092                 unsigned pid;
1093
1094                 if ((r = safe_atou(value, &pid)) < 0 || pid <= 0)
1095                         log_debug("Failed to parse control-pid value %s", value);
1096                 else
1097                         s->control_pid = (pid_t) pid;
1098         } else if (streq(key, "control-command")) {
1099                 SocketExecCommand id;
1100
1101                 if ((id = socket_exec_command_from_string(value)) < 0)
1102                         log_debug("Failed to parse exec-command value %s", value);
1103                 else {
1104                         s->control_command_id = id;
1105                         s->control_command = s->exec_command[id];
1106                 }
1107         } else if (streq(key, "fifo")) {
1108                 int fd, skip = 0;
1109                 SocketPort *p;
1110
1111                 if (sscanf(value, "%i %n", &fd, &skip) < 1 || fd < 0 || !fdset_contains(fds, fd))
1112                         log_debug("Failed to parse fifo value %s", value);
1113                 else {
1114
1115                         LIST_FOREACH(port, p, s->ports)
1116                                 if (streq(p->path, value+skip))
1117                                         break;
1118
1119                         if (p) {
1120                                 if (p->fd >= 0)
1121                                         close_nointr_nofail(p->fd);
1122                                 p->fd = fdset_remove(fds, fd);
1123                         }
1124                 }
1125
1126         } else if (streq(key, "socket")) {
1127                 int fd, skip = 0;
1128                 SocketPort *p;
1129
1130                 if (sscanf(value, "%i %n", &fd, &skip) < 1 || fd < 0 || !fdset_contains(fds, fd))
1131                         log_debug("Failed to parse socket value %s", value);
1132                 else {
1133
1134                         LIST_FOREACH(port, p, s->ports)
1135                                 if (socket_address_is(&p->address, value+skip))
1136                                         break;
1137
1138                         if (p) {
1139                                 if (p->fd >= 0)
1140                                         close_nointr_nofail(p->fd);
1141                                 p->fd = fdset_remove(fds, fd);
1142                         }
1143                 }
1144
1145         } else
1146                 log_debug("Unknown serialization key '%s'", key);
1147
1148         return 0;
1149 }
1150
1151 static UnitActiveState socket_active_state(Unit *u) {
1152         assert(u);
1153
1154         return state_translation_table[SOCKET(u)->state];
1155 }
1156
1157 static const char *socket_sub_state_to_string(Unit *u) {
1158         assert(u);
1159
1160         return socket_state_to_string(SOCKET(u)->state);
1161 }
1162
1163 static void socket_fd_event(Unit *u, int fd, uint32_t events, Watch *w) {
1164         Socket *s = SOCKET(u);
1165         int cfd = -1;
1166
1167         assert(s);
1168         assert(fd >= 0);
1169
1170         log_debug("Incoming traffic on %s", u->meta.id);
1171
1172         if (events != EPOLLIN) {
1173                 log_error("Got invalid poll event on socket.");
1174                 goto fail;
1175         }
1176
1177         if (w->socket_accept) {
1178                 for (;;) {
1179
1180                         if ((cfd = accept4(fd, NULL, NULL, SOCK_NONBLOCK)) < 0) {
1181
1182                                 if (errno == EINTR)
1183                                         continue;
1184
1185                                 log_error("Failed to accept socket: %m");
1186                                 goto fail;
1187                         }
1188
1189                         break;
1190                 }
1191         }
1192
1193         socket_enter_running(s, cfd);
1194         return;
1195
1196 fail:
1197         socket_enter_stop_pre(s, false);
1198 }
1199
1200 static void socket_sigchld_event(Unit *u, pid_t pid, int code, int status) {
1201         Socket *s = SOCKET(u);
1202         bool success;
1203
1204         assert(s);
1205         assert(pid >= 0);
1206
1207         success = is_clean_exit(code, status);
1208         s->failure = s->failure || !success;
1209
1210         assert(s->control_pid == pid);
1211         s->control_pid = 0;
1212
1213         if (s->control_command)
1214                 exec_status_fill(&s->control_command->exec_status, pid, code, status);
1215
1216         log_debug("%s control process exited, code=%s status=%i", u->meta.id, sigchld_code_to_string(code), status);
1217
1218         if (s->control_command && s->control_command->command_next && success) {
1219                 log_debug("%s running next command for state %s", u->meta.id, socket_state_to_string(s->state));
1220                 socket_run_next(s, success);
1221         } else {
1222                 s->control_command = NULL;
1223                 s->control_command_id = _SOCKET_EXEC_COMMAND_INVALID;
1224
1225                 /* No further commands for this step, so let's figure
1226                  * out what to do next */
1227
1228                 log_debug("%s got final SIGCHLD for state %s", u->meta.id, socket_state_to_string(s->state));
1229
1230                 switch (s->state) {
1231
1232                 case SOCKET_START_PRE:
1233                         if (success)
1234                                 socket_enter_start_post(s);
1235                         else
1236                                 socket_enter_signal(s, SOCKET_FINAL_SIGTERM, false);
1237                         break;
1238
1239                 case SOCKET_START_POST:
1240                         if (success)
1241                                 socket_enter_listening(s);
1242                         else
1243                                 socket_enter_stop_pre(s, false);
1244                         break;
1245
1246                 case SOCKET_STOP_PRE:
1247                 case SOCKET_STOP_PRE_SIGTERM:
1248                 case SOCKET_STOP_PRE_SIGKILL:
1249                         socket_enter_stop_post(s, success);
1250                         break;
1251
1252                 case SOCKET_STOP_POST:
1253                 case SOCKET_FINAL_SIGTERM:
1254                 case SOCKET_FINAL_SIGKILL:
1255                         socket_enter_dead(s, success);
1256                         break;
1257
1258                 default:
1259                         assert_not_reached("Uh, control process died at wrong time.");
1260                 }
1261         }
1262 }
1263
1264 static void socket_timer_event(Unit *u, uint64_t elapsed, Watch *w) {
1265         Socket *s = SOCKET(u);
1266
1267         assert(s);
1268         assert(elapsed == 1);
1269         assert(w == &s->timer_watch);
1270
1271         switch (s->state) {
1272
1273         case SOCKET_START_PRE:
1274                 log_warning("%s starting timed out. Terminating.", u->meta.id);
1275                 socket_enter_signal(s, SOCKET_FINAL_SIGTERM, false);
1276
1277         case SOCKET_START_POST:
1278                 log_warning("%s starting timed out. Stopping.", u->meta.id);
1279                 socket_enter_stop_pre(s, false);
1280                 break;
1281
1282         case SOCKET_STOP_PRE:
1283                 log_warning("%s stopping timed out. Terminating.", u->meta.id);
1284                 socket_enter_signal(s, SOCKET_STOP_PRE_SIGTERM, false);
1285                 break;
1286
1287         case SOCKET_STOP_PRE_SIGTERM:
1288                 log_warning("%s stopping timed out. Killing.", u->meta.id);
1289                 socket_enter_signal(s, SOCKET_STOP_PRE_SIGKILL, false);
1290                 break;
1291
1292         case SOCKET_STOP_PRE_SIGKILL:
1293                 log_warning("%s still around after SIGKILL. Ignoring.", u->meta.id);
1294                 socket_enter_stop_post(s, false);
1295                 break;
1296
1297         case SOCKET_STOP_POST:
1298                 log_warning("%s stopping timed out (2). Terminating.", u->meta.id);
1299                 socket_enter_signal(s, SOCKET_FINAL_SIGTERM, false);
1300                 break;
1301
1302         case SOCKET_FINAL_SIGTERM:
1303                 log_warning("%s stopping timed out (2). Killing.", u->meta.id);
1304                 socket_enter_signal(s, SOCKET_FINAL_SIGKILL, false);
1305                 break;
1306
1307         case SOCKET_FINAL_SIGKILL:
1308                 log_warning("%s still around after SIGKILL (2). Entering maintainance mode.", u->meta.id);
1309                 socket_enter_dead(s, false);
1310                 break;
1311
1312         default:
1313                 assert_not_reached("Timeout at wrong time.");
1314         }
1315 }
1316
1317 int socket_collect_fds(Socket *s, int **fds, unsigned *n_fds) {
1318         int *rfds;
1319         unsigned rn_fds, k;
1320         SocketPort *p;
1321
1322         assert(s);
1323         assert(fds);
1324         assert(n_fds);
1325
1326         /* Called from the service code for requesting our fds */
1327
1328         rn_fds = 0;
1329         LIST_FOREACH(port, p, s->ports)
1330                 if (p->fd >= 0)
1331                         rn_fds++;
1332
1333         if (!(rfds = new(int, rn_fds)) < 0)
1334                 return -ENOMEM;
1335
1336         k = 0;
1337         LIST_FOREACH(port, p, s->ports)
1338                 if (p->fd >= 0)
1339                         rfds[k++] = p->fd;
1340
1341         assert(k == rn_fds);
1342
1343         *fds = rfds;
1344         *n_fds = rn_fds;
1345
1346         return 0;
1347 }
1348
1349 void socket_notify_service_dead(Socket *s) {
1350         assert(s);
1351
1352         /* The service is dead. Dang. */
1353
1354         if (s->state == SOCKET_RUNNING) {
1355                 log_debug("%s got notified about service death.", s->meta.id);
1356                 socket_enter_listening(s);
1357         }
1358 }
1359
1360 static const char* const socket_state_table[_SOCKET_STATE_MAX] = {
1361         [SOCKET_DEAD] = "dead",
1362         [SOCKET_START_PRE] = "start-pre",
1363         [SOCKET_START_POST] = "start-post",
1364         [SOCKET_LISTENING] = "listening",
1365         [SOCKET_RUNNING] = "running",
1366         [SOCKET_STOP_PRE] = "stop-pre",
1367         [SOCKET_STOP_PRE_SIGTERM] = "stop-pre-sigterm",
1368         [SOCKET_STOP_PRE_SIGKILL] = "stop-pre-sigkill",
1369         [SOCKET_STOP_POST] = "stop-post",
1370         [SOCKET_FINAL_SIGTERM] = "final-sigterm",
1371         [SOCKET_FINAL_SIGKILL] = "final-sigkill",
1372         [SOCKET_MAINTAINANCE] = "maintainance"
1373 };
1374
1375 DEFINE_STRING_TABLE_LOOKUP(socket_state, SocketState);
1376
1377 static const char* const socket_exec_command_table[_SOCKET_EXEC_COMMAND_MAX] = {
1378         [SOCKET_EXEC_START_PRE] = "StartPre",
1379         [SOCKET_EXEC_START_POST] = "StartPost",
1380         [SOCKET_EXEC_STOP_PRE] = "StopPre",
1381         [SOCKET_EXEC_STOP_POST] = "StopPost"
1382 };
1383
1384 DEFINE_STRING_TABLE_LOOKUP(socket_exec_command, SocketExecCommand);
1385
1386 const UnitVTable socket_vtable = {
1387         .suffix = ".socket",
1388
1389         .init = socket_init,
1390         .done = socket_done,
1391         .load = socket_load,
1392
1393         .coldplug = socket_coldplug,
1394
1395         .dump = socket_dump,
1396
1397         .start = socket_start,
1398         .stop = socket_stop,
1399
1400         .serialize = socket_serialize,
1401         .deserialize_item = socket_deserialize_item,
1402
1403         .active_state = socket_active_state,
1404         .sub_state_to_string = socket_sub_state_to_string,
1405
1406         .fd_event = socket_fd_event,
1407         .sigchld_event = socket_sigchld_event,
1408         .timer_event = socket_timer_event,
1409
1410         .bus_message_handler = bus_socket_message_handler
1411 };