chiark / gitweb /
2af2685e0d8be8eeac67737bd37928d1b9b3241a
[elogind.git] / src / unit.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 <assert.h>
23 #include <errno.h>
24 #include <string.h>
25 #include <sys/epoll.h>
26 #include <sys/timerfd.h>
27 #include <sys/poll.h>
28 #include <stdlib.h>
29 #include <unistd.h>
30
31 #include "set.h"
32 #include "unit.h"
33 #include "macro.h"
34 #include "strv.h"
35 #include "load-fragment.h"
36 #include "load-dropin.h"
37 #include "log.h"
38 #include "unit-name.h"
39 #include "specifier.h"
40 #include "dbus-unit.h"
41
42 const UnitVTable * const unit_vtable[_UNIT_TYPE_MAX] = {
43         [UNIT_SERVICE] = &service_vtable,
44         [UNIT_TIMER] = &timer_vtable,
45         [UNIT_SOCKET] = &socket_vtable,
46         [UNIT_TARGET] = &target_vtable,
47         [UNIT_DEVICE] = &device_vtable,
48         [UNIT_MOUNT] = &mount_vtable,
49         [UNIT_AUTOMOUNT] = &automount_vtable,
50         [UNIT_SNAPSHOT] = &snapshot_vtable,
51         [UNIT_SWAP] = &swap_vtable
52 };
53
54 Unit *unit_new(Manager *m) {
55         Unit *u;
56
57         assert(m);
58
59         if (!(u = new0(Unit, 1)))
60                 return NULL;
61
62         if (!(u->meta.names = set_new(string_hash_func, string_compare_func))) {
63                 free(u);
64                 return NULL;
65         }
66
67         u->meta.manager = m;
68         u->meta.type = _UNIT_TYPE_INVALID;
69
70         return u;
71 }
72
73 bool unit_has_name(Unit *u, const char *name) {
74         assert(u);
75         assert(name);
76
77         return !!set_get(u->meta.names, (char*) name);
78 }
79
80 int unit_add_name(Unit *u, const char *text) {
81         UnitType t;
82         char *s = NULL, *i = NULL;
83         int r;
84
85         assert(u);
86         assert(text);
87
88         if (unit_name_is_template(text)) {
89                 if (!u->meta.instance)
90                         return -EINVAL;
91
92                 s = unit_name_replace_instance(text, u->meta.instance);
93         } else
94                 s = strdup(text);
95
96         if (!s)
97                 return -ENOMEM;
98
99         if (!unit_name_is_valid(s)) {
100                 r = -EINVAL;
101                 goto fail;
102         }
103
104         assert_se((t = unit_name_to_type(s)) >= 0);
105
106         if (u->meta.type != _UNIT_TYPE_INVALID && t != u->meta.type) {
107                 r = -EINVAL;
108                 goto fail;
109         }
110
111         if ((r = unit_name_to_instance(s, &i)) < 0)
112                 goto fail;
113
114         if (i && unit_vtable[t]->no_instances)
115                 goto fail;
116
117         if (u->meta.type != _UNIT_TYPE_INVALID && !streq_ptr(u->meta.instance, i)) {
118                 r = -EINVAL;
119                 goto fail;
120         }
121
122         if (unit_vtable[t]->no_alias &&
123             !set_isempty(u->meta.names) &&
124             !set_get(u->meta.names, s)) {
125                 r = -EEXIST;
126                 goto fail;
127         }
128
129         if (hashmap_size(u->meta.manager->units) >= MANAGER_MAX_NAMES) {
130                 r = -E2BIG;
131                 goto fail;
132         }
133
134         if ((r = set_put(u->meta.names, s)) < 0) {
135                 if (r == -EEXIST)
136                         r = 0;
137                 goto fail;
138         }
139
140         if ((r = hashmap_put(u->meta.manager->units, s, u)) < 0) {
141                 set_remove(u->meta.names, s);
142                 goto fail;
143         }
144
145         if (u->meta.type == _UNIT_TYPE_INVALID) {
146
147                 u->meta.type = t;
148                 u->meta.id = s;
149                 u->meta.instance = i;
150
151                 LIST_PREPEND(Meta, units_per_type, u->meta.manager->units_per_type[t], &u->meta);
152
153                 if (UNIT_VTABLE(u)->init)
154                         UNIT_VTABLE(u)->init(u);
155         } else
156                 free(i);
157
158         unit_add_to_dbus_queue(u);
159         return 0;
160
161 fail:
162         free(s);
163         free(i);
164
165         return r;
166 }
167
168 int unit_choose_id(Unit *u, const char *name) {
169         char *s, *t = NULL;
170
171         assert(u);
172         assert(name);
173
174         if (unit_name_is_template(name)) {
175
176                 if (!u->meta.instance)
177                         return -EINVAL;
178
179                 if (!(t = unit_name_replace_instance(name, u->meta.instance)))
180                         return -ENOMEM;
181
182                 name = t;
183         }
184
185         /* Selects one of the names of this unit as the id */
186         s = set_get(u->meta.names, (char*) name);
187         free(t);
188
189         if (!s)
190                 return -ENOENT;
191
192         u->meta.id = s;
193         unit_add_to_dbus_queue(u);
194
195         return 0;
196 }
197
198 int unit_set_description(Unit *u, const char *description) {
199         char *s;
200
201         assert(u);
202
203         if (!(s = strdup(description)))
204                 return -ENOMEM;
205
206         free(u->meta.description);
207         u->meta.description = s;
208
209         unit_add_to_dbus_queue(u);
210         return 0;
211 }
212
213 bool unit_check_gc(Unit *u) {
214         assert(u);
215
216         if (u->meta.load_state == UNIT_STUB)
217                 return true;
218
219         if (UNIT_VTABLE(u)->no_gc)
220                 return true;
221
222         if (u->meta.job)
223                 return true;
224
225         if (unit_active_state(u) != UNIT_INACTIVE)
226                 return true;
227
228         if (UNIT_VTABLE(u)->check_gc)
229                 if (UNIT_VTABLE(u)->check_gc(u))
230                         return true;
231
232         return false;
233 }
234
235 void unit_add_to_load_queue(Unit *u) {
236         assert(u);
237         assert(u->meta.type != _UNIT_TYPE_INVALID);
238
239         if (u->meta.load_state != UNIT_STUB || u->meta.in_load_queue)
240                 return;
241
242         LIST_PREPEND(Meta, load_queue, u->meta.manager->load_queue, &u->meta);
243         u->meta.in_load_queue = true;
244 }
245
246 void unit_add_to_cleanup_queue(Unit *u) {
247         assert(u);
248
249         if (u->meta.in_cleanup_queue)
250                 return;
251
252         LIST_PREPEND(Meta, cleanup_queue, u->meta.manager->cleanup_queue, &u->meta);
253         u->meta.in_cleanup_queue = true;
254 }
255
256 void unit_add_to_gc_queue(Unit *u) {
257         assert(u);
258
259         if (u->meta.in_gc_queue || u->meta.in_cleanup_queue)
260                 return;
261
262         if (unit_check_gc(u))
263                 return;
264
265         LIST_PREPEND(Meta, gc_queue, u->meta.manager->gc_queue, &u->meta);
266         u->meta.in_gc_queue = true;
267
268         u->meta.manager->n_in_gc_queue ++;
269
270         if (u->meta.manager->gc_queue_timestamp <= 0)
271                 u->meta.manager->gc_queue_timestamp = now(CLOCK_MONOTONIC);
272 }
273
274 void unit_add_to_dbus_queue(Unit *u) {
275         assert(u);
276         assert(u->meta.type != _UNIT_TYPE_INVALID);
277
278         if (u->meta.load_state == UNIT_STUB || u->meta.in_dbus_queue)
279                 return;
280
281         if (set_isempty(u->meta.manager->subscribed)) {
282                 u->meta.sent_dbus_new_signal = true;
283                 return;
284         }
285
286         LIST_PREPEND(Meta, dbus_queue, u->meta.manager->dbus_unit_queue, &u->meta);
287         u->meta.in_dbus_queue = true;
288 }
289
290 static void bidi_set_free(Unit *u, Set *s) {
291         Iterator i;
292         Unit *other;
293
294         assert(u);
295
296         /* Frees the set and makes sure we are dropped from the
297          * inverse pointers */
298
299         SET_FOREACH(other, s, i) {
300                 UnitDependency d;
301
302                 for (d = 0; d < _UNIT_DEPENDENCY_MAX; d++)
303                         set_remove(other->meta.dependencies[d], u);
304
305                 unit_add_to_gc_queue(other);
306         }
307
308         set_free(s);
309 }
310
311 void unit_free(Unit *u) {
312         UnitDependency d;
313         Iterator i;
314         char *t;
315
316         assert(u);
317
318         bus_unit_send_removed_signal(u);
319
320         /* Detach from next 'bigger' objects */
321         SET_FOREACH(t, u->meta.names, i)
322                 hashmap_remove_value(u->meta.manager->units, t, u);
323
324         if (u->meta.type != _UNIT_TYPE_INVALID)
325                 LIST_REMOVE(Meta, units_per_type, u->meta.manager->units_per_type[u->meta.type], &u->meta);
326
327         if (u->meta.in_load_queue)
328                 LIST_REMOVE(Meta, load_queue, u->meta.manager->load_queue, &u->meta);
329
330         if (u->meta.in_dbus_queue)
331                 LIST_REMOVE(Meta, dbus_queue, u->meta.manager->dbus_unit_queue, &u->meta);
332
333         if (u->meta.in_cleanup_queue)
334                 LIST_REMOVE(Meta, cleanup_queue, u->meta.manager->cleanup_queue, &u->meta);
335
336         if (u->meta.in_gc_queue) {
337                 LIST_REMOVE(Meta, gc_queue, u->meta.manager->gc_queue, &u->meta);
338                 u->meta.manager->n_in_gc_queue--;
339         }
340
341         /* Free data and next 'smaller' objects */
342         if (u->meta.job)
343                 job_free(u->meta.job);
344
345         if (u->meta.load_state != UNIT_STUB)
346                 if (UNIT_VTABLE(u)->done)
347                         UNIT_VTABLE(u)->done(u);
348
349         cgroup_bonding_free_list(u->meta.cgroup_bondings);
350
351         for (d = 0; d < _UNIT_DEPENDENCY_MAX; d++)
352                 bidi_set_free(u, u->meta.dependencies[d]);
353
354         free(u->meta.description);
355         free(u->meta.fragment_path);
356
357         while ((t = set_steal_first(u->meta.names)))
358                 free(t);
359         set_free(u->meta.names);
360
361         free(u->meta.instance);
362
363         free(u);
364 }
365
366 UnitActiveState unit_active_state(Unit *u) {
367         assert(u);
368
369         if (u->meta.load_state != UNIT_LOADED)
370                 return UNIT_INACTIVE;
371
372         return UNIT_VTABLE(u)->active_state(u);
373 }
374
375 const char* unit_sub_state_to_string(Unit *u) {
376         assert(u);
377
378         return UNIT_VTABLE(u)->sub_state_to_string(u);
379 }
380
381 static void complete_move(Set **s, Set **other) {
382         assert(s);
383         assert(other);
384
385         if (!*other)
386                 return;
387
388         if (*s)
389                 set_move(*s, *other);
390         else {
391                 *s = *other;
392                 *other = NULL;
393         }
394 }
395
396 static void merge_names(Unit *u, Unit *other) {
397         char *t;
398         Iterator i;
399
400         assert(u);
401         assert(other);
402
403         complete_move(&u->meta.names, &other->meta.names);
404
405         while ((t = set_steal_first(other->meta.names)))
406                 free(t);
407
408         set_free(other->meta.names);
409         other->meta.names = NULL;
410         other->meta.id = NULL;
411
412         SET_FOREACH(t, u->meta.names, i)
413                 assert_se(hashmap_replace(u->meta.manager->units, t, u) == 0);
414 }
415
416 static void merge_dependencies(Unit *u, Unit *other, UnitDependency d) {
417         Iterator i;
418         Unit *back;
419         int r;
420
421         assert(u);
422         assert(other);
423         assert(d < _UNIT_DEPENDENCY_MAX);
424
425         SET_FOREACH(back, other->meta.dependencies[d], i) {
426                 UnitDependency k;
427
428                 for (k = 0; k < _UNIT_DEPENDENCY_MAX; k++)
429                         if ((r = set_remove_and_put(back->meta.dependencies[k], other, u)) < 0) {
430
431                                 if (r == -EEXIST)
432                                         set_remove(back->meta.dependencies[k], other);
433                                 else
434                                         assert(r == -ENOENT);
435                         }
436         }
437
438         complete_move(&u->meta.dependencies[d], &other->meta.dependencies[d]);
439
440         set_free(other->meta.dependencies[d]);
441         other->meta.dependencies[d] = NULL;
442 }
443
444 int unit_merge(Unit *u, Unit *other) {
445         UnitDependency d;
446
447         assert(u);
448         assert(other);
449         assert(u->meta.manager == other->meta.manager);
450         assert(u->meta.type != _UNIT_TYPE_INVALID);
451
452         other = unit_follow_merge(other);
453
454         if (other == u)
455                 return 0;
456
457         if (u->meta.type != other->meta.type)
458                 return -EINVAL;
459
460         if (!streq_ptr(u->meta.instance, other->meta.instance))
461                 return -EINVAL;
462
463         if (other->meta.load_state != UNIT_STUB &&
464             other->meta.load_state != UNIT_FAILED)
465                 return -EEXIST;
466
467         if (other->meta.job)
468                 return -EEXIST;
469
470         if (unit_active_state(other) != UNIT_INACTIVE)
471                 return -EEXIST;
472
473         /* Merge names */
474         merge_names(u, other);
475
476         /* Merge dependencies */
477         for (d = 0; d < _UNIT_DEPENDENCY_MAX; d++)
478                 merge_dependencies(u, other, d);
479
480         other->meta.load_state = UNIT_MERGED;
481         other->meta.merged_into = u;
482
483         /* If there is still some data attached to the other node, we
484          * don't need it anymore, and can free it. */
485         if (other->meta.load_state != UNIT_STUB)
486                 if (UNIT_VTABLE(other)->done)
487                         UNIT_VTABLE(other)->done(other);
488
489         unit_add_to_dbus_queue(u);
490         unit_add_to_cleanup_queue(other);
491
492         return 0;
493 }
494
495 int unit_merge_by_name(Unit *u, const char *name) {
496         Unit *other;
497         int r;
498         char *s = NULL;
499
500         assert(u);
501         assert(name);
502
503         if (unit_name_is_template(name)) {
504                 if (!u->meta.instance)
505                         return -EINVAL;
506
507                 if (!(s = unit_name_replace_instance(name, u->meta.instance)))
508                         return -ENOMEM;
509
510                 name = s;
511         }
512
513         if (!(other = manager_get_unit(u->meta.manager, name)))
514                 r = unit_add_name(u, name);
515         else
516                 r = unit_merge(u, other);
517
518         free(s);
519         return r;
520 }
521
522 Unit* unit_follow_merge(Unit *u) {
523         assert(u);
524
525         while (u->meta.load_state == UNIT_MERGED)
526                 assert_se(u = u->meta.merged_into);
527
528         return u;
529 }
530
531 int unit_add_exec_dependencies(Unit *u, ExecContext *c) {
532         int r;
533
534         assert(u);
535         assert(c);
536
537         if (c->std_output != EXEC_OUTPUT_KMSG &&
538             c->std_output != EXEC_OUTPUT_SYSLOG &&
539             c->std_error != EXEC_OUTPUT_KMSG &&
540             c->std_error != EXEC_OUTPUT_SYSLOG)
541                 return 0;
542
543         /* If syslog or kernel logging is requested, make sure our own
544          * logging daemon is run first. */
545
546         if ((r = unit_add_dependency_by_name(u, UNIT_AFTER, SPECIAL_LOGGER_SOCKET, NULL, true)) < 0)
547                 return r;
548
549         if (u->meta.manager->running_as != MANAGER_SESSION)
550                 if ((r = unit_add_dependency_by_name(u, UNIT_REQUIRES, SPECIAL_LOGGER_SOCKET, NULL, true)) < 0)
551                         return r;
552
553         return 0;
554 }
555
556 const char *unit_description(Unit *u) {
557         assert(u);
558
559         if (u->meta.description)
560                 return u->meta.description;
561
562         return u->meta.id;
563 }
564
565 void unit_dump(Unit *u, FILE *f, const char *prefix) {
566         char *t;
567         UnitDependency d;
568         Iterator i;
569         char *p2;
570         const char *prefix2;
571         CGroupBonding *b;
572         char
573                 timestamp1[FORMAT_TIMESTAMP_MAX],
574                 timestamp2[FORMAT_TIMESTAMP_MAX],
575                 timestamp3[FORMAT_TIMESTAMP_MAX],
576                 timestamp4[FORMAT_TIMESTAMP_MAX];
577
578         assert(u);
579         assert(u->meta.type >= 0);
580
581         if (!prefix)
582                 prefix = "";
583         p2 = strappend(prefix, "\t");
584         prefix2 = p2 ? p2 : prefix;
585
586         fprintf(f,
587                 "%s-> Unit %s:\n"
588                 "%s\tDescription: %s\n"
589                 "%s\tInstance: %s\n"
590                 "%s\tUnit Load State: %s\n"
591                 "%s\tUnit Active State: %s\n"
592                 "%s\tInactive Exit Timestamp: %s\n"
593                 "%s\tActive Enter Timestamp: %s\n"
594                 "%s\tActive Exit Timestamp: %s\n"
595                 "%s\tInactive Enter Timestamp: %s\n"
596                 "%s\tGC Check Good: %s\n"
597                 "%s\tOnly By Dependency: %s\n",
598                 prefix, u->meta.id,
599                 prefix, unit_description(u),
600                 prefix, strna(u->meta.instance),
601                 prefix, unit_load_state_to_string(u->meta.load_state),
602                 prefix, unit_active_state_to_string(unit_active_state(u)),
603                 prefix, strna(format_timestamp(timestamp1, sizeof(timestamp1), u->meta.inactive_exit_timestamp.realtime)),
604                 prefix, strna(format_timestamp(timestamp2, sizeof(timestamp2), u->meta.active_enter_timestamp.realtime)),
605                 prefix, strna(format_timestamp(timestamp3, sizeof(timestamp3), u->meta.active_exit_timestamp.realtime)),
606                 prefix, strna(format_timestamp(timestamp4, sizeof(timestamp4), u->meta.inactive_enter_timestamp.realtime)),
607                 prefix, yes_no(unit_check_gc(u)),
608                 prefix, yes_no(u->meta.only_by_dependency));
609
610         SET_FOREACH(t, u->meta.names, i)
611                 fprintf(f, "%s\tName: %s\n", prefix, t);
612
613         if (u->meta.fragment_path)
614                 fprintf(f, "%s\tFragment Path: %s\n", prefix, u->meta.fragment_path);
615
616         for (d = 0; d < _UNIT_DEPENDENCY_MAX; d++) {
617                 Unit *other;
618
619                 SET_FOREACH(other, u->meta.dependencies[d], i)
620                         fprintf(f, "%s\t%s: %s\n", prefix, unit_dependency_to_string(d), other->meta.id);
621         }
622
623         if (u->meta.load_state == UNIT_LOADED) {
624                 fprintf(f,
625                         "%s\tRecursive Stop: %s\n"
626                         "%s\tStop When Unneeded: %s\n",
627                         prefix, yes_no(u->meta.recursive_stop),
628                         prefix, yes_no(u->meta.stop_when_unneeded));
629
630                 LIST_FOREACH(by_unit, b, u->meta.cgroup_bondings)
631                         fprintf(f, "%s\tControlGroup: %s:%s\n",
632                                 prefix, b->controller, b->path);
633
634                 if (UNIT_VTABLE(u)->dump)
635                         UNIT_VTABLE(u)->dump(u, f, prefix2);
636
637         } else if (u->meta.load_state == UNIT_MERGED)
638                 fprintf(f,
639                         "%s\tMerged into: %s\n",
640                         prefix, u->meta.merged_into->meta.id);
641
642         if (u->meta.job)
643                 job_dump(u->meta.job, f, prefix2);
644
645         free(p2);
646 }
647
648 /* Common implementation for multiple backends */
649 int unit_load_fragment_and_dropin(Unit *u) {
650         int r;
651
652         assert(u);
653
654         /* Load a .service file */
655         if ((r = unit_load_fragment(u)) < 0)
656                 return r;
657
658         if (u->meta.load_state == UNIT_STUB)
659                 return -ENOENT;
660
661         /* Load drop-in directory data */
662         if ((r = unit_load_dropin(unit_follow_merge(u))) < 0)
663                 return r;
664
665         return 0;
666 }
667
668 /* Common implementation for multiple backends */
669 int unit_load_fragment_and_dropin_optional(Unit *u) {
670         int r;
671
672         assert(u);
673
674         /* Same as unit_load_fragment_and_dropin(), but whether
675          * something can be loaded or not doesn't matter. */
676
677         /* Load a .service file */
678         if ((r = unit_load_fragment(u)) < 0)
679                 return r;
680
681         if (u->meta.load_state == UNIT_STUB)
682                 u->meta.load_state = UNIT_LOADED;
683
684         /* Load drop-in directory data */
685         if ((r = unit_load_dropin(unit_follow_merge(u))) < 0)
686                 return r;
687
688         return 0;
689 }
690
691 /* Common implementation for multiple backends */
692 int unit_load_nop(Unit *u) {
693         assert(u);
694
695         if (u->meta.load_state == UNIT_STUB)
696                 u->meta.load_state = UNIT_LOADED;
697
698         return 0;
699 }
700
701 int unit_load(Unit *u) {
702         int r;
703
704         assert(u);
705
706         if (u->meta.in_load_queue) {
707                 LIST_REMOVE(Meta, load_queue, u->meta.manager->load_queue, &u->meta);
708                 u->meta.in_load_queue = false;
709         }
710
711         if (u->meta.type == _UNIT_TYPE_INVALID)
712                 return -EINVAL;
713
714         if (u->meta.load_state != UNIT_STUB)
715                 return 0;
716
717         if (UNIT_VTABLE(u)->load)
718                 if ((r = UNIT_VTABLE(u)->load(u)) < 0)
719                         goto fail;
720
721         if (u->meta.load_state == UNIT_STUB) {
722                 r = -ENOENT;
723                 goto fail;
724         }
725
726         assert((u->meta.load_state != UNIT_MERGED) == !u->meta.merged_into);
727
728         unit_add_to_dbus_queue(unit_follow_merge(u));
729         unit_add_to_gc_queue(u);
730
731         return 0;
732
733 fail:
734         u->meta.load_state = UNIT_FAILED;
735         unit_add_to_dbus_queue(u);
736
737         log_debug("Failed to load configuration for %s: %s", u->meta.id, strerror(-r));
738
739         return r;
740 }
741
742 /* Errors:
743  *         -EBADR:     This unit type does not support starting.
744  *         -EALREADY:  Unit is already started.
745  *         -EAGAIN:    An operation is already in progress. Retry later.
746  *         -ECANCELED: Too many requests for now.
747  */
748 int unit_start(Unit *u) {
749         UnitActiveState state;
750
751         assert(u);
752
753         /* If this is already (being) started, then this will
754          * succeed. Note that this will even succeed if this unit is
755          * not startable by the user. This is relied on to detect when
756          * we need to wait for units and when waiting is finished. */
757         state = unit_active_state(u);
758         if (UNIT_IS_ACTIVE_OR_RELOADING(state))
759                 return -EALREADY;
760
761         /* If it is stopped, but we cannot start it, then fail */
762         if (!UNIT_VTABLE(u)->start)
763                 return -EBADR;
764
765         /* We don't suppress calls to ->start() here when we are
766          * already starting, to allow this request to be used as a
767          * "hurry up" call, for example when the unit is in some "auto
768          * restart" state where it waits for a holdoff timer to elapse
769          * before it will start again. */
770
771         unit_add_to_dbus_queue(u);
772         return UNIT_VTABLE(u)->start(u);
773 }
774
775 bool unit_can_start(Unit *u) {
776         assert(u);
777
778         return !!UNIT_VTABLE(u)->start;
779 }
780
781 /* Errors:
782  *         -EBADR:    This unit type does not support stopping.
783  *         -EALREADY: Unit is already stopped.
784  *         -EAGAIN:   An operation is already in progress. Retry later.
785  */
786 int unit_stop(Unit *u) {
787         UnitActiveState state;
788
789         assert(u);
790
791         state = unit_active_state(u);
792         if (state == UNIT_INACTIVE)
793                 return -EALREADY;
794
795         if (!UNIT_VTABLE(u)->stop)
796                 return -EBADR;
797
798         unit_add_to_dbus_queue(u);
799         return UNIT_VTABLE(u)->stop(u);
800 }
801
802 /* Errors:
803  *         -EBADR:    This unit type does not support reloading.
804  *         -ENOEXEC:  Unit is not started.
805  *         -EAGAIN:   An operation is already in progress. Retry later.
806  */
807 int unit_reload(Unit *u) {
808         UnitActiveState state;
809
810         assert(u);
811
812         if (!unit_can_reload(u))
813                 return -EBADR;
814
815         state = unit_active_state(u);
816         if (unit_active_state(u) == UNIT_ACTIVE_RELOADING)
817                 return -EALREADY;
818
819         if (unit_active_state(u) != UNIT_ACTIVE)
820                 return -ENOEXEC;
821
822         unit_add_to_dbus_queue(u);
823         return UNIT_VTABLE(u)->reload(u);
824 }
825
826 bool unit_can_reload(Unit *u) {
827         assert(u);
828
829         if (!UNIT_VTABLE(u)->reload)
830                 return false;
831
832         if (!UNIT_VTABLE(u)->can_reload)
833                 return true;
834
835         return UNIT_VTABLE(u)->can_reload(u);
836 }
837
838 static void unit_check_uneeded(Unit *u) {
839         Iterator i;
840         Unit *other;
841
842         assert(u);
843
844         /* If this service shall be shut down when unneeded then do
845          * so. */
846
847         if (!u->meta.stop_when_unneeded)
848                 return;
849
850         if (!UNIT_IS_ACTIVE_OR_ACTIVATING(unit_active_state(u)))
851                 return;
852
853         SET_FOREACH(other, u->meta.dependencies[UNIT_REQUIRED_BY], i)
854                 if (!UNIT_IS_INACTIVE_OR_DEACTIVATING(unit_active_state(other)))
855                         return;
856
857         SET_FOREACH(other, u->meta.dependencies[UNIT_REQUIRED_BY_OVERRIDABLE], i)
858                 if (!UNIT_IS_INACTIVE_OR_DEACTIVATING(unit_active_state(other)))
859                         return;
860
861         SET_FOREACH(other, u->meta.dependencies[UNIT_WANTED_BY], i)
862                 if (!UNIT_IS_INACTIVE_OR_DEACTIVATING(unit_active_state(other)))
863                         return;
864
865         log_debug("Service %s is not needed anymore. Stopping.", u->meta.id);
866
867         /* Ok, nobody needs us anymore. Sniff. Then let's commit suicide */
868         manager_add_job(u->meta.manager, JOB_STOP, u, JOB_FAIL, true, NULL);
869 }
870
871 static void retroactively_start_dependencies(Unit *u) {
872         Iterator i;
873         Unit *other;
874
875         assert(u);
876         assert(UNIT_IS_ACTIVE_OR_ACTIVATING(unit_active_state(u)));
877
878         SET_FOREACH(other, u->meta.dependencies[UNIT_REQUIRES], i)
879                 if (!UNIT_IS_ACTIVE_OR_ACTIVATING(unit_active_state(other)))
880                         manager_add_job(u->meta.manager, JOB_START, other, JOB_REPLACE, true, NULL);
881
882         SET_FOREACH(other, u->meta.dependencies[UNIT_REQUIRES_OVERRIDABLE], i)
883                 if (!UNIT_IS_ACTIVE_OR_ACTIVATING(unit_active_state(other)))
884                         manager_add_job(u->meta.manager, JOB_START, other, JOB_FAIL, false, NULL);
885
886         SET_FOREACH(other, u->meta.dependencies[UNIT_REQUISITE], i)
887                 if (!UNIT_IS_ACTIVE_OR_ACTIVATING(unit_active_state(other)))
888                         manager_add_job(u->meta.manager, JOB_START, other, JOB_REPLACE, true, NULL);
889
890         SET_FOREACH(other, u->meta.dependencies[UNIT_WANTS], i)
891                 if (!UNIT_IS_ACTIVE_OR_ACTIVATING(unit_active_state(other)))
892                         manager_add_job(u->meta.manager, JOB_START, other, JOB_FAIL, false, NULL);
893
894         SET_FOREACH(other, u->meta.dependencies[UNIT_CONFLICTS], i)
895                 if (!UNIT_IS_ACTIVE_OR_ACTIVATING(unit_active_state(other)))
896                         manager_add_job(u->meta.manager, JOB_STOP, other, JOB_REPLACE, true, NULL);
897 }
898
899 static void retroactively_stop_dependencies(Unit *u) {
900         Iterator i;
901         Unit *other;
902
903         assert(u);
904         assert(UNIT_IS_INACTIVE_OR_DEACTIVATING(unit_active_state(u)));
905
906         if (u->meta.recursive_stop) {
907                 /* Pull down units need us recursively if enabled */
908                 SET_FOREACH(other, u->meta.dependencies[UNIT_REQUIRED_BY], i)
909                         if (!UNIT_IS_INACTIVE_OR_DEACTIVATING(unit_active_state(other)))
910                                 manager_add_job(u->meta.manager, JOB_STOP, other, JOB_REPLACE, true, NULL);
911         }
912
913         /* Garbage collect services that might not be needed anymore, if enabled */
914         SET_FOREACH(other, u->meta.dependencies[UNIT_REQUIRES], i)
915                 if (!UNIT_IS_INACTIVE_OR_DEACTIVATING(unit_active_state(other)))
916                         unit_check_uneeded(other);
917         SET_FOREACH(other, u->meta.dependencies[UNIT_REQUIRES_OVERRIDABLE], i)
918                 if (!UNIT_IS_INACTIVE_OR_DEACTIVATING(unit_active_state(other)))
919                         unit_check_uneeded(other);
920         SET_FOREACH(other, u->meta.dependencies[UNIT_WANTS], i)
921                 if (!UNIT_IS_INACTIVE_OR_DEACTIVATING(unit_active_state(other)))
922                         unit_check_uneeded(other);
923         SET_FOREACH(other, u->meta.dependencies[UNIT_REQUISITE], i)
924                 if (!UNIT_IS_INACTIVE_OR_DEACTIVATING(unit_active_state(other)))
925                         unit_check_uneeded(other);
926         SET_FOREACH(other, u->meta.dependencies[UNIT_REQUISITE_OVERRIDABLE], i)
927                 if (!UNIT_IS_INACTIVE_OR_DEACTIVATING(unit_active_state(other)))
928                         unit_check_uneeded(other);
929 }
930
931 void unit_notify(Unit *u, UnitActiveState os, UnitActiveState ns) {
932         bool unexpected = false;
933         timestamp ts;
934
935         assert(u);
936         assert(os < _UNIT_ACTIVE_STATE_MAX);
937         assert(ns < _UNIT_ACTIVE_STATE_MAX);
938
939         /* Note that this is called for all low-level state changes,
940          * even if they might map to the same high-level
941          * UnitActiveState! That means that ns == os is OK an expected
942          * behaviour here. For example: if a mount point is remounted
943          * this function will be called too and the utmp code below
944          * relies on that! */
945
946         timestamp_get(&ts);
947
948         if (os == UNIT_INACTIVE && ns != UNIT_INACTIVE)
949                 u->meta.inactive_exit_timestamp = ts;
950         else if (os != UNIT_INACTIVE && ns == UNIT_INACTIVE)
951                 u->meta.inactive_enter_timestamp = ts;
952
953         if (!UNIT_IS_ACTIVE_OR_RELOADING(os) && UNIT_IS_ACTIVE_OR_RELOADING(ns))
954                 u->meta.active_enter_timestamp = ts;
955         else if (UNIT_IS_ACTIVE_OR_RELOADING(os) && !UNIT_IS_ACTIVE_OR_RELOADING(ns))
956                 u->meta.active_exit_timestamp = ts;
957
958         timer_unit_notify(u, ns);
959
960         if (u->meta.job) {
961
962                 if (u->meta.job->state == JOB_WAITING)
963
964                         /* So we reached a different state for this
965                          * job. Let's see if we can run it now if it
966                          * failed previously due to EAGAIN. */
967                         job_add_to_run_queue(u->meta.job);
968
969                 else {
970                         assert(u->meta.job->state == JOB_RUNNING);
971
972                         /* Let's check whether this state change
973                          * constitutes a finished job, or maybe
974                          * cotradicts a running job and hence needs to
975                          * invalidate jobs. */
976
977                         switch (u->meta.job->type) {
978
979                         case JOB_START:
980                         case JOB_VERIFY_ACTIVE:
981
982                                 if (UNIT_IS_ACTIVE_OR_RELOADING(ns))
983                                         job_finish_and_invalidate(u->meta.job, true);
984                                 else if (ns != UNIT_ACTIVATING) {
985                                         unexpected = true;
986                                         job_finish_and_invalidate(u->meta.job, false);
987                                 }
988
989                                 break;
990
991                         case JOB_RELOAD:
992                         case JOB_RELOAD_OR_START:
993
994                                 if (ns == UNIT_ACTIVE)
995                                         job_finish_and_invalidate(u->meta.job, true);
996                                 else if (ns != UNIT_ACTIVATING && ns != UNIT_ACTIVE_RELOADING) {
997                                         unexpected = true;
998                                         job_finish_and_invalidate(u->meta.job, false);
999                                 }
1000
1001                                 break;
1002
1003                         case JOB_STOP:
1004                         case JOB_RESTART:
1005                         case JOB_TRY_RESTART:
1006
1007                                 if (ns == UNIT_INACTIVE)
1008                                         job_finish_and_invalidate(u->meta.job, true);
1009                                 else if (ns != UNIT_DEACTIVATING) {
1010                                         unexpected = true;
1011                                         job_finish_and_invalidate(u->meta.job, false);
1012                                 }
1013
1014                                 break;
1015
1016                         default:
1017                                 assert_not_reached("Job type unknown");
1018                         }
1019                 }
1020         }
1021
1022         /* If this state change happened without being requested by a
1023          * job, then let's retroactively start or stop dependencies */
1024
1025         if (unexpected) {
1026                 if (UNIT_IS_INACTIVE_OR_DEACTIVATING(os) && UNIT_IS_ACTIVE_OR_ACTIVATING(ns))
1027                         retroactively_start_dependencies(u);
1028                 else if (UNIT_IS_ACTIVE_OR_ACTIVATING(os) && UNIT_IS_INACTIVE_OR_DEACTIVATING(ns))
1029                         retroactively_stop_dependencies(u);
1030         }
1031
1032         /* Some names are special */
1033         if (UNIT_IS_ACTIVE_OR_RELOADING(ns)) {
1034                 if (unit_has_name(u, SPECIAL_DBUS_SERVICE)) {
1035                         /* The bus just might have become available,
1036                          * hence try to connect to it, if we aren't
1037                          * yet connected. */
1038                         bus_init_system(u->meta.manager);
1039                         bus_init_api(u->meta.manager);
1040                 }
1041
1042                 if (unit_has_name(u, SPECIAL_SYSLOG_SERVICE))
1043                         /* The syslog daemon just might have become
1044                          * available, hence try to connect to it, if
1045                          * we aren't yet connected. */
1046                         log_open();
1047
1048                 if (u->meta.type == UNIT_MOUNT)
1049                         /* Another directory became available, let's
1050                          * check if that is enough to write our utmp
1051                          * entry. */
1052                         manager_write_utmp_reboot(u->meta.manager);
1053
1054                 if (u->meta.type == UNIT_TARGET)
1055                         /* A target got activated, maybe this is a runlevel? */
1056                         manager_write_utmp_runlevel(u->meta.manager, u);
1057
1058         } else if (!UNIT_IS_ACTIVE_OR_RELOADING(ns)) {
1059
1060                 if (unit_has_name(u, SPECIAL_SYSLOG_SERVICE))
1061                         /* The syslog daemon might just have
1062                          * terminated, hence try to disconnect from
1063                          * it. */
1064                         log_close_syslog();
1065
1066                 /* We don't care about D-Bus here, since we'll get an
1067                  * asynchronous notification for it anyway. */
1068         }
1069
1070         /* Maybe we finished startup and are now ready for being
1071          * stopped because unneeded? */
1072         unit_check_uneeded(u);
1073
1074         unit_add_to_dbus_queue(u);
1075         unit_add_to_gc_queue(u);
1076 }
1077
1078 int unit_watch_fd(Unit *u, int fd, uint32_t events, Watch *w) {
1079         struct epoll_event ev;
1080
1081         assert(u);
1082         assert(fd >= 0);
1083         assert(w);
1084         assert(w->type == WATCH_INVALID || (w->type == WATCH_FD && w->fd == fd && w->data.unit == u));
1085
1086         zero(ev);
1087         ev.data.ptr = w;
1088         ev.events = events;
1089
1090         if (epoll_ctl(u->meta.manager->epoll_fd,
1091                       w->type == WATCH_INVALID ? EPOLL_CTL_ADD : EPOLL_CTL_MOD,
1092                       fd,
1093                       &ev) < 0)
1094                 return -errno;
1095
1096         w->fd = fd;
1097         w->type = WATCH_FD;
1098         w->data.unit = u;
1099
1100         return 0;
1101 }
1102
1103 void unit_unwatch_fd(Unit *u, Watch *w) {
1104         assert(u);
1105         assert(w);
1106
1107         if (w->type == WATCH_INVALID)
1108                 return;
1109
1110         assert(w->type == WATCH_FD);
1111         assert(w->data.unit == u);
1112         assert_se(epoll_ctl(u->meta.manager->epoll_fd, EPOLL_CTL_DEL, w->fd, NULL) >= 0);
1113
1114         w->fd = -1;
1115         w->type = WATCH_INVALID;
1116         w->data.unit = NULL;
1117 }
1118
1119 int unit_watch_pid(Unit *u, pid_t pid) {
1120         assert(u);
1121         assert(pid >= 1);
1122
1123         /* Watch a specific PID. We only support one unit watching
1124          * each PID for now. */
1125
1126         return hashmap_put(u->meta.manager->watch_pids, UINT32_TO_PTR(pid), u);
1127 }
1128
1129 void unit_unwatch_pid(Unit *u, pid_t pid) {
1130         assert(u);
1131         assert(pid >= 1);
1132
1133         hashmap_remove_value(u->meta.manager->watch_pids, UINT32_TO_PTR(pid), u);
1134 }
1135
1136 int unit_watch_timer(Unit *u, usec_t delay, Watch *w) {
1137         struct itimerspec its;
1138         int flags, fd;
1139         bool ours;
1140
1141         assert(u);
1142         assert(w);
1143         assert(w->type == WATCH_INVALID || (w->type == WATCH_TIMER && w->data.unit == u));
1144
1145         /* This will try to reuse the old timer if there is one */
1146
1147         if (w->type == WATCH_TIMER) {
1148                 ours = false;
1149                 fd = w->fd;
1150         } else {
1151                 ours = true;
1152                 if ((fd = timerfd_create(CLOCK_MONOTONIC, TFD_NONBLOCK|TFD_CLOEXEC)) < 0)
1153                         return -errno;
1154         }
1155
1156         zero(its);
1157
1158         if (delay <= 0) {
1159                 /* Set absolute time in the past, but not 0, since we
1160                  * don't want to disarm the timer */
1161                 its.it_value.tv_sec = 0;
1162                 its.it_value.tv_nsec = 1;
1163
1164                 flags = TFD_TIMER_ABSTIME;
1165         } else {
1166                 timespec_store(&its.it_value, delay);
1167                 flags = 0;
1168         }
1169
1170         /* This will also flush the elapse counter */
1171         if (timerfd_settime(fd, flags, &its, NULL) < 0)
1172                 goto fail;
1173
1174         if (w->type == WATCH_INVALID) {
1175                 struct epoll_event ev;
1176
1177                 zero(ev);
1178                 ev.data.ptr = w;
1179                 ev.events = EPOLLIN;
1180
1181                 if (epoll_ctl(u->meta.manager->epoll_fd, EPOLL_CTL_ADD, fd, &ev) < 0)
1182                         goto fail;
1183         }
1184
1185         w->fd = fd;
1186         w->type = WATCH_TIMER;
1187         w->data.unit = u;
1188
1189         return 0;
1190
1191 fail:
1192         if (ours)
1193                 close_nointr_nofail(fd);
1194
1195         return -errno;
1196 }
1197
1198 void unit_unwatch_timer(Unit *u, Watch *w) {
1199         assert(u);
1200         assert(w);
1201
1202         if (w->type == WATCH_INVALID)
1203                 return;
1204
1205         assert(w->type == WATCH_TIMER && w->data.unit == u);
1206
1207         assert_se(epoll_ctl(u->meta.manager->epoll_fd, EPOLL_CTL_DEL, w->fd, NULL) >= 0);
1208         close_nointr_nofail(w->fd);
1209
1210         w->fd = -1;
1211         w->type = WATCH_INVALID;
1212         w->data.unit = NULL;
1213 }
1214
1215 bool unit_job_is_applicable(Unit *u, JobType j) {
1216         assert(u);
1217         assert(j >= 0 && j < _JOB_TYPE_MAX);
1218
1219         switch (j) {
1220
1221         case JOB_VERIFY_ACTIVE:
1222         case JOB_START:
1223                 return true;
1224
1225         case JOB_STOP:
1226         case JOB_RESTART:
1227         case JOB_TRY_RESTART:
1228                 return unit_can_start(u);
1229
1230         case JOB_RELOAD:
1231                 return unit_can_reload(u);
1232
1233         case JOB_RELOAD_OR_START:
1234                 return unit_can_reload(u) && unit_can_start(u);
1235
1236         default:
1237                 assert_not_reached("Invalid job type");
1238         }
1239 }
1240
1241 int unit_add_dependency(Unit *u, UnitDependency d, Unit *other, bool add_reference) {
1242
1243         static const UnitDependency inverse_table[_UNIT_DEPENDENCY_MAX] = {
1244                 [UNIT_REQUIRES] = UNIT_REQUIRED_BY,
1245                 [UNIT_REQUIRES_OVERRIDABLE] = UNIT_REQUIRED_BY_OVERRIDABLE,
1246                 [UNIT_WANTS] = UNIT_WANTED_BY,
1247                 [UNIT_REQUISITE] = UNIT_REQUIRED_BY,
1248                 [UNIT_REQUISITE_OVERRIDABLE] = UNIT_REQUIRED_BY_OVERRIDABLE,
1249                 [UNIT_REQUIRED_BY] = _UNIT_DEPENDENCY_INVALID,
1250                 [UNIT_REQUIRED_BY_OVERRIDABLE] = _UNIT_DEPENDENCY_INVALID,
1251                 [UNIT_WANTED_BY] = _UNIT_DEPENDENCY_INVALID,
1252                 [UNIT_CONFLICTS] = UNIT_CONFLICTS,
1253                 [UNIT_BEFORE] = UNIT_AFTER,
1254                 [UNIT_AFTER] = UNIT_BEFORE,
1255                 [UNIT_REFERENCES] = UNIT_REFERENCED_BY,
1256                 [UNIT_REFERENCED_BY] = UNIT_REFERENCES
1257         };
1258         int r, q = 0, v = 0, w = 0;
1259
1260         assert(u);
1261         assert(d >= 0 && d < _UNIT_DEPENDENCY_MAX);
1262         assert(inverse_table[d] != _UNIT_DEPENDENCY_INVALID);
1263         assert(other);
1264
1265         /* We won't allow dependencies on ourselves. We will not
1266          * consider them an error however. */
1267         if (u == other)
1268                 return 0;
1269
1270         if (UNIT_VTABLE(u)->no_requires &&
1271             (d == UNIT_REQUIRES ||
1272              d == UNIT_REQUIRES_OVERRIDABLE ||
1273              d == UNIT_REQUISITE ||
1274              d == UNIT_REQUISITE_OVERRIDABLE)) {
1275                     return -EINVAL;
1276         }
1277
1278         if ((r = set_ensure_allocated(&u->meta.dependencies[d], trivial_hash_func, trivial_compare_func)) < 0 ||
1279             (r = set_ensure_allocated(&other->meta.dependencies[inverse_table[d]], trivial_hash_func, trivial_compare_func)) < 0)
1280                 return r;
1281
1282         if (add_reference)
1283                 if ((r = set_ensure_allocated(&u->meta.dependencies[UNIT_REFERENCES], trivial_hash_func, trivial_compare_func)) < 0 ||
1284                     (r = set_ensure_allocated(&other->meta.dependencies[UNIT_REFERENCED_BY], trivial_hash_func, trivial_compare_func)) < 0)
1285                         return r;
1286
1287         if ((q = set_put(u->meta.dependencies[d], other)) < 0)
1288                 return q;
1289
1290         if ((v = set_put(other->meta.dependencies[inverse_table[d]], u)) < 0) {
1291                 r = v;
1292                 goto fail;
1293         }
1294
1295         if (add_reference) {
1296                 if ((w = set_put(u->meta.dependencies[UNIT_REFERENCES], other)) < 0) {
1297                         r = w;
1298                         goto fail;
1299                 }
1300
1301                 if ((r = set_put(other->meta.dependencies[UNIT_REFERENCED_BY], u)) < 0)
1302                         goto fail;
1303         }
1304
1305         unit_add_to_dbus_queue(u);
1306         return 0;
1307
1308 fail:
1309         if (q > 0)
1310                 set_remove(u->meta.dependencies[d], other);
1311
1312         if (v > 0)
1313                 set_remove(other->meta.dependencies[inverse_table[d]], u);
1314
1315         if (w > 0)
1316                 set_remove(u->meta.dependencies[UNIT_REFERENCES], other);
1317
1318         return r;
1319 }
1320
1321 static const char *resolve_template(Unit *u, const char *name, const char*path, char **p) {
1322         char *s;
1323
1324         assert(u);
1325         assert(name || path);
1326
1327         if (!name)
1328                 name = file_name_from_path(path);
1329
1330         if (!unit_name_is_template(name)) {
1331                 *p = NULL;
1332                 return name;
1333         }
1334
1335         if (u->meta.instance)
1336                 s = unit_name_replace_instance(name, u->meta.instance);
1337         else {
1338                 char *i;
1339
1340                 if (!(i = unit_name_to_prefix(u->meta.id)))
1341                         return NULL;
1342
1343                 s = unit_name_replace_instance(name, i);
1344                 free(i);
1345         }
1346
1347         if (!s)
1348                 return NULL;
1349
1350         *p = s;
1351         return s;
1352 }
1353
1354 int unit_add_dependency_by_name(Unit *u, UnitDependency d, const char *name, const char *path, bool add_reference) {
1355         Unit *other;
1356         int r;
1357         char *s;
1358
1359         assert(u);
1360         assert(name || path);
1361
1362         if (!(name = resolve_template(u, name, path, &s)))
1363                 return -ENOMEM;
1364
1365         if ((r = manager_load_unit(u->meta.manager, name, path, &other)) < 0)
1366                 goto finish;
1367
1368         r = unit_add_dependency(u, d, other, add_reference);
1369
1370 finish:
1371         free(s);
1372         return r;
1373 }
1374
1375 int unit_add_dependency_by_name_inverse(Unit *u, UnitDependency d, const char *name, const char *path, bool add_reference) {
1376         Unit *other;
1377         int r;
1378         char *s;
1379
1380         assert(u);
1381         assert(name || path);
1382
1383         if (!(name = resolve_template(u, name, path, &s)))
1384                 return -ENOMEM;
1385
1386         if ((r = manager_load_unit(u->meta.manager, name, path, &other)) < 0)
1387                 goto finish;
1388
1389         r = unit_add_dependency(other, d, u, add_reference);
1390
1391 finish:
1392         free(s);
1393         return r;
1394 }
1395
1396 int set_unit_path(const char *p) {
1397         char *cwd, *c;
1398         int r;
1399
1400         /* This is mostly for debug purposes */
1401
1402         if (path_is_absolute(p)) {
1403                 if (!(c = strdup(p)))
1404                         return -ENOMEM;
1405         } else {
1406                 if (!(cwd = get_current_dir_name()))
1407                         return -errno;
1408
1409                 r = asprintf(&c, "%s/%s", cwd, p);
1410                 free(cwd);
1411
1412                 if (r < 0)
1413                         return -ENOMEM;
1414         }
1415
1416         if (setenv("SYSTEMD_UNIT_PATH", c, 0) < 0) {
1417                 r = -errno;
1418                 free(c);
1419                 return r;
1420         }
1421
1422         return 0;
1423 }
1424
1425 char *unit_dbus_path(Unit *u) {
1426         char *p, *e;
1427
1428         assert(u);
1429
1430         if (!(e = bus_path_escape(u->meta.id)))
1431                 return NULL;
1432
1433         if (asprintf(&p, "/org/freedesktop/systemd1/unit/%s", e) < 0) {
1434                 free(e);
1435                 return NULL;
1436         }
1437
1438         free(e);
1439         return p;
1440 }
1441
1442 int unit_add_cgroup(Unit *u, CGroupBonding *b) {
1443         CGroupBonding *l;
1444         int r;
1445
1446         assert(u);
1447         assert(b);
1448         assert(b->path);
1449
1450         /* Ensure this hasn't been added yet */
1451         assert(!b->unit);
1452
1453         l = hashmap_get(u->meta.manager->cgroup_bondings, b->path);
1454         LIST_PREPEND(CGroupBonding, by_path, l, b);
1455
1456         if ((r = hashmap_replace(u->meta.manager->cgroup_bondings, b->path, l)) < 0) {
1457                 LIST_REMOVE(CGroupBonding, by_path, l, b);
1458                 return r;
1459         }
1460
1461         LIST_PREPEND(CGroupBonding, by_unit, u->meta.cgroup_bondings, b);
1462         b->unit = u;
1463
1464         return 0;
1465 }
1466
1467 static char *default_cgroup_path(Unit *u) {
1468         char *p;
1469         int r;
1470
1471         assert(u);
1472
1473         if (u->meta.instance) {
1474                 char *t;
1475
1476                 if (!(t = unit_name_template(u->meta.id)))
1477                         return NULL;
1478
1479                 r = asprintf(&p, "%s/%s/%s", u->meta.manager->cgroup_hierarchy, t, u->meta.instance);
1480                 free(t);
1481         } else
1482                 r = asprintf(&p, "%s/%s", u->meta.manager->cgroup_hierarchy, u->meta.id);
1483
1484         return r < 0 ? NULL : p;
1485 }
1486
1487 int unit_add_cgroup_from_text(Unit *u, const char *name) {
1488         size_t n;
1489         char *controller = NULL, *path = NULL;
1490         CGroupBonding *b = NULL;
1491         int r;
1492
1493         assert(u);
1494         assert(name);
1495
1496         /* Detect controller name */
1497         n = strcspn(name, ":");
1498
1499         if (name[n] == 0 ||
1500             (name[n] == ':' && name[n+1] == 0)) {
1501
1502                 /* Only controller name, no path? */
1503
1504                 if (!(path = default_cgroup_path(u)))
1505                         return -ENOMEM;
1506
1507         } else {
1508                 const char *p;
1509
1510                 /* Controller name, and path. */
1511                 p = name+n+1;
1512
1513                 if (!path_is_absolute(p))
1514                         return -EINVAL;
1515
1516                 if (!(path = strdup(p)))
1517                         return -ENOMEM;
1518         }
1519
1520         if (n > 0)
1521                 controller = strndup(name, n);
1522         else
1523                 controller = strdup(u->meta.manager->cgroup_controller);
1524
1525         if (!controller) {
1526                 r = -ENOMEM;
1527                 goto fail;
1528         }
1529
1530         if (cgroup_bonding_find_list(u->meta.cgroup_bondings, controller)) {
1531                 r = -EEXIST;
1532                 goto fail;
1533         }
1534
1535         if (!(b = new0(CGroupBonding, 1))) {
1536                 r = -ENOMEM;
1537                 goto fail;
1538         }
1539
1540         b->controller = controller;
1541         b->path = path;
1542         b->only_us = false;
1543         b->clean_up = false;
1544
1545         if ((r = unit_add_cgroup(u, b)) < 0)
1546                 goto fail;
1547
1548         return 0;
1549
1550 fail:
1551         free(path);
1552         free(controller);
1553         free(b);
1554
1555         return r;
1556 }
1557
1558 int unit_add_default_cgroup(Unit *u) {
1559         CGroupBonding *b;
1560         int r = -ENOMEM;
1561
1562         assert(u);
1563
1564         /* Adds in the default cgroup data, if it wasn't specified yet */
1565
1566         if (unit_get_default_cgroup(u))
1567                 return 0;
1568
1569         if (!(b = new0(CGroupBonding, 1)))
1570                 return -ENOMEM;
1571
1572         if (!(b->controller = strdup(u->meta.manager->cgroup_controller)))
1573                 goto fail;
1574
1575         if (!(b->path = default_cgroup_path(u)))
1576                 goto fail;
1577
1578         b->clean_up = true;
1579         b->only_us = true;
1580
1581         if ((r = unit_add_cgroup(u, b)) < 0)
1582                 goto fail;
1583
1584         return 0;
1585
1586 fail:
1587         free(b->path);
1588         free(b->controller);
1589         free(b);
1590
1591         return r;
1592 }
1593
1594 CGroupBonding* unit_get_default_cgroup(Unit *u) {
1595         assert(u);
1596
1597         return cgroup_bonding_find_list(u->meta.cgroup_bondings, u->meta.manager->cgroup_controller);
1598 }
1599
1600 int unit_load_related_unit(Unit *u, const char *type, Unit **_found) {
1601         char *t;
1602         int r;
1603
1604         assert(u);
1605         assert(type);
1606         assert(_found);
1607
1608         if (!(t = unit_name_change_suffix(u->meta.id, type)))
1609                 return -ENOMEM;
1610
1611         assert(!unit_has_name(u, t));
1612
1613         r = manager_load_unit(u->meta.manager, t, NULL, _found);
1614         free(t);
1615
1616         assert(r < 0 || *_found != u);
1617
1618         return r;
1619 }
1620
1621 int unit_get_related_unit(Unit *u, const char *type, Unit **_found) {
1622         Unit *found;
1623         char *t;
1624
1625         assert(u);
1626         assert(type);
1627         assert(_found);
1628
1629         if (!(t = unit_name_change_suffix(u->meta.id, type)))
1630                 return -ENOMEM;
1631
1632         assert(!unit_has_name(u, t));
1633
1634         found = manager_get_unit(u->meta.manager, t);
1635         free(t);
1636
1637         if (!found)
1638                 return -ENOENT;
1639
1640         *_found = found;
1641         return 0;
1642 }
1643
1644 static char *specifier_prefix_and_instance(char specifier, void *data, void *userdata) {
1645         Unit *u = userdata;
1646         assert(u);
1647
1648         return unit_name_to_prefix_and_instance(u->meta.id);
1649 }
1650
1651 static char *specifier_prefix(char specifier, void *data, void *userdata) {
1652         Unit *u = userdata;
1653         assert(u);
1654
1655         return unit_name_to_prefix(u->meta.id);
1656 }
1657
1658 static char *specifier_prefix_unescaped(char specifier, void *data, void *userdata) {
1659         Unit *u = userdata;
1660         char *p, *r;
1661
1662         assert(u);
1663
1664         if (!(p = unit_name_to_prefix(u->meta.id)))
1665                 return NULL;
1666
1667         r = unit_name_unescape(p);
1668         free(p);
1669
1670         return r;
1671 }
1672
1673 static char *specifier_instance_unescaped(char specifier, void *data, void *userdata) {
1674         Unit *u = userdata;
1675         assert(u);
1676
1677         if (u->meta.instance)
1678                 return unit_name_unescape(u->meta.instance);
1679
1680         return strdup("");
1681 }
1682
1683 char *unit_name_printf(Unit *u, const char* format) {
1684
1685         /*
1686          * This will use the passed string as format string and
1687          * replace the following specifiers:
1688          *
1689          * %n: the full id of the unit                 (foo@bar.waldo)
1690          * %N: the id of the unit without the suffix   (foo@bar)
1691          * %p: the prefix                              (foo)
1692          * %i: the instance                            (bar)
1693          */
1694
1695         const Specifier table[] = {
1696                 { 'n', specifier_string,              u->meta.id },
1697                 { 'N', specifier_prefix_and_instance, NULL },
1698                 { 'p', specifier_prefix,              NULL },
1699                 { 'i', specifier_string,              u->meta.instance },
1700                 { 0, NULL, NULL }
1701         };
1702
1703         assert(u);
1704         assert(format);
1705
1706         return specifier_printf(format, table, u);
1707 }
1708
1709 char *unit_full_printf(Unit *u, const char *format) {
1710
1711         /* This is similar to unit_name_printf() but also supports
1712          * unescaping */
1713
1714         const Specifier table[] = {
1715                 { 'n', specifier_string,              u->meta.id },
1716                 { 'N', specifier_prefix_and_instance, NULL },
1717                 { 'p', specifier_prefix,              NULL },
1718                 { 'P', specifier_prefix_unescaped,    NULL },
1719                 { 'i', specifier_string,              u->meta.instance },
1720                 { 'I', specifier_instance_unescaped,  NULL },
1721                 { 0, NULL, NULL }
1722         };
1723
1724         assert(u);
1725         assert(format);
1726
1727         return specifier_printf(format, table, u);
1728 }
1729
1730 char **unit_full_printf_strv(Unit *u, char **l) {
1731         size_t n;
1732         char **r, **i, **j;
1733
1734         /* Applies unit_full_printf to every entry in l */
1735
1736         assert(u);
1737
1738         n = strv_length(l);
1739         if (!(r = new(char*, n+1)))
1740                 return NULL;
1741
1742         for (i = l, j = r; *i; i++, j++)
1743                 if (!(*j = unit_full_printf(u, *i)))
1744                         goto fail;
1745
1746         *j = NULL;
1747         return r;
1748
1749 fail:
1750         j--;
1751         while (j >= r)
1752                 free(*j);
1753
1754         free(r);
1755
1756         return NULL;
1757 }
1758
1759 int unit_watch_bus_name(Unit *u, const char *name) {
1760         assert(u);
1761         assert(name);
1762
1763         /* Watch a specific name on the bus. We only support one unit
1764          * watching each name for now. */
1765
1766         return hashmap_put(u->meta.manager->watch_bus, name, u);
1767 }
1768
1769 void unit_unwatch_bus_name(Unit *u, const char *name) {
1770         assert(u);
1771         assert(name);
1772
1773         hashmap_remove_value(u->meta.manager->watch_bus, name, u);
1774 }
1775
1776 bool unit_can_serialize(Unit *u) {
1777         assert(u);
1778
1779         return UNIT_VTABLE(u)->serialize && UNIT_VTABLE(u)->deserialize_item;
1780 }
1781
1782 int unit_serialize(Unit *u, FILE *f, FDSet *fds) {
1783         int r;
1784
1785         assert(u);
1786         assert(f);
1787         assert(fds);
1788
1789         if (!unit_can_serialize(u))
1790                 return 0;
1791
1792         if ((r = UNIT_VTABLE(u)->serialize(u, f, fds)) < 0)
1793                 return r;
1794
1795         /* End marker */
1796         fputc('\n', f);
1797         return 0;
1798 }
1799
1800 void unit_serialize_item_format(Unit *u, FILE *f, const char *key, const char *format, ...) {
1801         va_list ap;
1802
1803         assert(u);
1804         assert(f);
1805         assert(key);
1806         assert(format);
1807
1808         fputs(key, f);
1809         fputc('=', f);
1810
1811         va_start(ap, format);
1812         vfprintf(f, format, ap);
1813         va_end(ap);
1814
1815         fputc('\n', f);
1816 }
1817
1818 void unit_serialize_item(Unit *u, FILE *f, const char *key, const char *value) {
1819         assert(u);
1820         assert(f);
1821         assert(key);
1822         assert(value);
1823
1824         fprintf(f, "%s=%s\n", key, value);
1825 }
1826
1827 int unit_deserialize(Unit *u, FILE *f, FDSet *fds) {
1828         int r;
1829
1830         assert(u);
1831         assert(f);
1832         assert(fds);
1833
1834         if (!unit_can_serialize(u))
1835                 return 0;
1836
1837         for (;;) {
1838                 char line[1024], *l, *v;
1839                 size_t k;
1840
1841                 if (!fgets(line, sizeof(line), f)) {
1842                         if (feof(f))
1843                                 return 0;
1844                         return -errno;
1845                 }
1846
1847                 l = strstrip(line);
1848
1849                 /* End marker */
1850                 if (l[0] == 0)
1851                         return 0;
1852
1853                 k = strcspn(l, "=");
1854
1855                 if (l[k] == '=') {
1856                         l[k] = 0;
1857                         v = l+k+1;
1858                 } else
1859                         v = l+k;
1860
1861                 if ((r = UNIT_VTABLE(u)->deserialize_item(u, l, v, fds)) < 0)
1862                         return r;
1863         }
1864 }
1865
1866 int unit_add_node_link(Unit *u, const char *what, bool wants) {
1867         Unit *device;
1868         char *e;
1869         int r;
1870
1871         assert(u);
1872
1873         if (!what)
1874                 return 0;
1875
1876         /* Adds in links to the device node that this unit is based on */
1877
1878         if (!is_device_path(what))
1879                 return 0;
1880
1881         if (!(e = unit_name_build_escape(what+1, NULL, ".device")))
1882                 return -ENOMEM;
1883
1884         r = manager_load_unit(u->meta.manager, e, NULL, &device);
1885         free(e);
1886
1887         if (r < 0)
1888                 return r;
1889
1890         if ((r = unit_add_dependency(u, UNIT_AFTER, device, true)) < 0)
1891                 return r;
1892
1893         if ((r = unit_add_dependency(u, UNIT_REQUIRES, device, true)) < 0)
1894                 return r;
1895
1896         if (wants)
1897                 if ((r = unit_add_dependency(device, UNIT_WANTS, u, false)) < 0)
1898                         return r;
1899
1900         return 0;
1901 }
1902
1903 static const char* const unit_type_table[_UNIT_TYPE_MAX] = {
1904         [UNIT_SERVICE] = "service",
1905         [UNIT_TIMER] = "timer",
1906         [UNIT_SOCKET] = "socket",
1907         [UNIT_TARGET] = "target",
1908         [UNIT_DEVICE] = "device",
1909         [UNIT_MOUNT] = "mount",
1910         [UNIT_AUTOMOUNT] = "automount",
1911         [UNIT_SNAPSHOT] = "snapshot",
1912         [UNIT_SWAP] = "swap"
1913 };
1914
1915 DEFINE_STRING_TABLE_LOOKUP(unit_type, UnitType);
1916
1917 static const char* const unit_load_state_table[_UNIT_LOAD_STATE_MAX] = {
1918         [UNIT_STUB] = "stub",
1919         [UNIT_LOADED] = "loaded",
1920         [UNIT_FAILED] = "failed",
1921         [UNIT_MERGED] = "merged"
1922 };
1923
1924 DEFINE_STRING_TABLE_LOOKUP(unit_load_state, UnitLoadState);
1925
1926 static const char* const unit_active_state_table[_UNIT_ACTIVE_STATE_MAX] = {
1927         [UNIT_ACTIVE] = "active",
1928         [UNIT_INACTIVE] = "inactive",
1929         [UNIT_ACTIVATING] = "activating",
1930         [UNIT_DEACTIVATING] = "deactivating"
1931 };
1932
1933 DEFINE_STRING_TABLE_LOOKUP(unit_active_state, UnitActiveState);
1934
1935 static const char* const unit_dependency_table[_UNIT_DEPENDENCY_MAX] = {
1936         [UNIT_REQUIRES] = "Requires",
1937         [UNIT_REQUIRES_OVERRIDABLE] = "RequiresOverridable",
1938         [UNIT_WANTS] = "Wants",
1939         [UNIT_REQUISITE] = "Requisite",
1940         [UNIT_REQUISITE_OVERRIDABLE] = "RequisiteOverridable",
1941         [UNIT_REQUIRED_BY] = "RequiredBy",
1942         [UNIT_REQUIRED_BY_OVERRIDABLE] = "RequiredByOverridable",
1943         [UNIT_WANTED_BY] = "WantedBy",
1944         [UNIT_CONFLICTS] = "Conflicts",
1945         [UNIT_BEFORE] = "Before",
1946         [UNIT_AFTER] = "After",
1947         [UNIT_REFERENCES] = "References",
1948         [UNIT_REFERENCED_BY] = "ReferencedBy"
1949 };
1950
1951 DEFINE_STRING_TABLE_LOOKUP(unit_dependency, UnitDependency);
1952
1953 static const char* const kill_mode_table[_KILL_MODE_MAX] = {
1954         [KILL_CONTROL_GROUP] = "control-group",
1955         [KILL_PROCESS_GROUP] = "process-group",
1956         [KILL_PROCESS] = "process",
1957         [KILL_NONE] = "none"
1958 };
1959
1960 DEFINE_STRING_TABLE_LOOKUP(kill_mode, KillMode);