]> git.ipfire.org Git - people/ms/systemd.git/blob - unit.c
unit: free data from merged unit when we don't need it anymore
[people/ms/systemd.git] / 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
39 const UnitVTable * const unit_vtable[_UNIT_TYPE_MAX] = {
40 [UNIT_SERVICE] = &service_vtable,
41 [UNIT_TIMER] = &timer_vtable,
42 [UNIT_SOCKET] = &socket_vtable,
43 [UNIT_TARGET] = &target_vtable,
44 [UNIT_DEVICE] = &device_vtable,
45 [UNIT_MOUNT] = &mount_vtable,
46 [UNIT_AUTOMOUNT] = &automount_vtable,
47 [UNIT_SNAPSHOT] = &snapshot_vtable
48 };
49
50 UnitType unit_name_to_type(const char *n) {
51 UnitType t;
52
53 assert(n);
54
55 for (t = 0; t < _UNIT_TYPE_MAX; t++)
56 if (endswith(n, unit_vtable[t]->suffix))
57 return t;
58
59 return _UNIT_TYPE_INVALID;
60 }
61
62 #define VALID_CHARS \
63 "0123456789" \
64 "abcdefghijklmnopqrstuvwxyz" \
65 "ABCDEFGHIJKLMNOPQRSTUVWXYZ" \
66 "-_.\\"
67
68 bool unit_name_is_valid(const char *n) {
69 UnitType t;
70 const char *e, *i;
71
72 assert(n);
73
74 if (strlen(n) >= UNIT_NAME_MAX)
75 return false;
76
77 t = unit_name_to_type(n);
78 if (t < 0 || t >= _UNIT_TYPE_MAX)
79 return false;
80
81 if (!(e = strrchr(n, '.')))
82 return false;
83
84 if (e == n)
85 return false;
86
87 for (i = n; i < e; i++)
88 if (!strchr(VALID_CHARS, *i))
89 return false;
90
91 return true;
92 }
93
94 char *unit_name_change_suffix(const char *n, const char *suffix) {
95 char *e, *r;
96 size_t a, b;
97
98 assert(n);
99 assert(unit_name_is_valid(n));
100 assert(suffix);
101
102 assert_se(e = strrchr(n, '.'));
103 a = e - n;
104 b = strlen(suffix);
105
106 if (!(r = new(char, a + b + 1)))
107 return NULL;
108
109 memcpy(r, n, a);
110 memcpy(r+a, suffix, b+1);
111
112 return r;
113 }
114
115 Unit *unit_new(Manager *m) {
116 Unit *u;
117
118 assert(m);
119
120 if (!(u = new0(Unit, 1)))
121 return NULL;
122
123 if (!(u->meta.names = set_new(string_hash_func, string_compare_func))) {
124 free(u);
125 return NULL;
126 }
127
128 u->meta.manager = m;
129 u->meta.type = _UNIT_TYPE_INVALID;
130
131 return u;
132 }
133
134 bool unit_has_name(Unit *u, const char *name) {
135 assert(u);
136 assert(name);
137
138 return !!set_get(u->meta.names, (char*) name);
139 }
140
141 int unit_add_name(Unit *u, const char *text) {
142 UnitType t;
143 char *s;
144 int r;
145
146 assert(u);
147 assert(text);
148
149 if (!unit_name_is_valid(text))
150 return -EINVAL;
151
152 if ((t = unit_name_to_type(text)) == _UNIT_TYPE_INVALID)
153 return -EINVAL;
154
155 if (u->meta.type != _UNIT_TYPE_INVALID && t != u->meta.type)
156 return -EINVAL;
157
158 if (!(s = strdup(text)))
159 return -ENOMEM;
160
161 if ((r = set_put(u->meta.names, s)) < 0) {
162 free(s);
163
164 if (r == -EEXIST)
165 return 0;
166
167 return r;
168 }
169
170 if ((r = hashmap_put(u->meta.manager->units, s, u)) < 0) {
171 set_remove(u->meta.names, s);
172 free(s);
173 return r;
174 }
175
176 if (u->meta.type == _UNIT_TYPE_INVALID)
177 LIST_PREPEND(Meta, units_per_type, u->meta.manager->units_per_type[t], &u->meta);
178
179 u->meta.type = t;
180
181 if (!u->meta.id)
182 u->meta.id = s;
183
184 unit_add_to_dbus_queue(u);
185 return 0;
186 }
187
188 int unit_choose_id(Unit *u, const char *name) {
189 char *s;
190
191 assert(u);
192 assert(name);
193
194 /* Selects one of the names of this unit as the id */
195
196 if (!(s = set_get(u->meta.names, (char*) name)))
197 return -ENOENT;
198
199 u->meta.id = s;
200
201 unit_add_to_dbus_queue(u);
202 return 0;
203 }
204
205 int unit_set_description(Unit *u, const char *description) {
206 char *s;
207
208 assert(u);
209
210 if (!(s = strdup(description)))
211 return -ENOMEM;
212
213 free(u->meta.description);
214 u->meta.description = s;
215
216 unit_add_to_dbus_queue(u);
217 return 0;
218 }
219
220 void unit_add_to_load_queue(Unit *u) {
221 assert(u);
222 assert(u->meta.type != _UNIT_TYPE_INVALID);
223
224 if (u->meta.load_state != UNIT_STUB || u->meta.in_load_queue)
225 return;
226
227 LIST_PREPEND(Meta, load_queue, u->meta.manager->load_queue, &u->meta);
228 u->meta.in_load_queue = true;
229 }
230
231 void unit_add_to_cleanup_queue(Unit *u) {
232 assert(u);
233
234 if (u->meta.in_cleanup_queue)
235 return;
236
237 LIST_PREPEND(Meta, cleanup_queue, u->meta.manager->cleanup_queue, &u->meta);
238 u->meta.in_cleanup_queue = true;
239 }
240
241 void unit_add_to_dbus_queue(Unit *u) {
242 assert(u);
243 assert(u->meta.type != _UNIT_TYPE_INVALID);
244
245 if (u->meta.load_state == UNIT_STUB || u->meta.in_dbus_queue || set_isempty(u->meta.manager->subscribed))
246 return;
247
248 LIST_PREPEND(Meta, dbus_queue, u->meta.manager->dbus_unit_queue, &u->meta);
249 u->meta.in_dbus_queue = true;
250 }
251
252 static void bidi_set_free(Unit *u, Set *s) {
253 Iterator i;
254 Unit *other;
255
256 assert(u);
257
258 /* Frees the set and makes sure we are dropped from the
259 * inverse pointers */
260
261 SET_FOREACH(other, s, i) {
262 UnitDependency d;
263
264 for (d = 0; d < _UNIT_DEPENDENCY_MAX; d++)
265 set_remove(other->meta.dependencies[d], u);
266 }
267
268 set_free(s);
269 }
270
271 void unit_free(Unit *u) {
272 UnitDependency d;
273 Iterator i;
274 char *t;
275
276 assert(u);
277
278 bus_unit_send_removed_signal(u);
279
280 /* Detach from next 'bigger' objects */
281
282 cgroup_bonding_free_list(u->meta.cgroup_bondings);
283
284 SET_FOREACH(t, u->meta.names, i)
285 hashmap_remove_value(u->meta.manager->units, t, u);
286
287 if (u->meta.type != _UNIT_TYPE_INVALID)
288 LIST_REMOVE(Meta, units_per_type, u->meta.manager->units_per_type[u->meta.type], &u->meta);
289
290 if (u->meta.in_load_queue)
291 LIST_REMOVE(Meta, load_queue, u->meta.manager->load_queue, &u->meta);
292
293 if (u->meta.in_dbus_queue)
294 LIST_REMOVE(Meta, dbus_queue, u->meta.manager->dbus_unit_queue, &u->meta);
295
296 if (u->meta.in_cleanup_queue)
297 LIST_REMOVE(Meta, cleanup_queue, u->meta.manager->cleanup_queue, &u->meta);
298
299 if (u->meta.load_state != UNIT_STUB)
300 if (UNIT_VTABLE(u)->done)
301 UNIT_VTABLE(u)->done(u);
302
303 /* Free data and next 'smaller' objects */
304 if (u->meta.job)
305 job_free(u->meta.job);
306
307 for (d = 0; d < _UNIT_DEPENDENCY_MAX; d++)
308 bidi_set_free(u, u->meta.dependencies[d]);
309
310 free(u->meta.description);
311 free(u->meta.fragment_path);
312
313 while ((t = set_steal_first(u->meta.names)))
314 free(t);
315 set_free(u->meta.names);
316
317 free(u);
318 }
319
320 UnitActiveState unit_active_state(Unit *u) {
321 assert(u);
322
323 if (u->meta.load_state != UNIT_LOADED)
324 return UNIT_INACTIVE;
325
326 return UNIT_VTABLE(u)->active_state(u);
327 }
328
329 static void complete_move(Set **s, Set **other) {
330 assert(s);
331 assert(other);
332
333 if (!*other)
334 return;
335
336 if (*s)
337 set_move(*s, *other);
338 else {
339 *s = *other;
340 *other = NULL;
341 }
342 }
343
344 static void merge_names(Unit *u, Unit *other) {
345 char *t;
346 Iterator i;
347
348 assert(u);
349 assert(other);
350
351 complete_move(&u->meta.names, &other->meta.names);
352
353 while ((t = set_steal_first(other->meta.names)))
354 free(t);
355
356 set_free(other->meta.names);
357 other->meta.names = NULL;
358 other->meta.id = NULL;
359
360 SET_FOREACH(t, u->meta.names, i)
361 assert_se(hashmap_replace(u->meta.manager->units, t, u) == 0);
362 }
363
364 static void merge_dependencies(Unit *u, Unit *other, UnitDependency d) {
365 Iterator i;
366 Unit *back;
367 int r;
368
369 assert(u);
370 assert(other);
371 assert(d < _UNIT_DEPENDENCY_MAX);
372
373 SET_FOREACH(back, other->meta.dependencies[d], i) {
374 UnitDependency k;
375
376 for (k = 0; k < _UNIT_DEPENDENCY_MAX; k++)
377 if ((r = set_remove_and_put(back->meta.dependencies[k], other, u)) < 0) {
378
379 if (r == -EEXIST)
380 set_remove(back->meta.dependencies[k], other);
381 else
382 assert(r == -ENOENT);
383 }
384 }
385
386 complete_move(&u->meta.dependencies[d], &other->meta.dependencies[d]);
387
388 set_free(other->meta.dependencies[d]);
389 other->meta.dependencies[d] = NULL;
390 }
391
392 int unit_merge(Unit *u, Unit *other) {
393 UnitDependency d;
394
395 assert(u);
396 assert(other);
397 assert(u->meta.manager == other->meta.manager);
398
399 other = unit_follow_merge(other);
400
401 if (other == u)
402 return 0;
403
404 /* This merges 'other' into 'unit'. FIXME: This does not
405 * rollback on failure. */
406
407 if (u->meta.type != u->meta.type)
408 return -EINVAL;
409
410 if (other->meta.load_state != UNIT_STUB &&
411 other->meta.load_state != UNIT_FAILED)
412 return -EEXIST;
413
414 if (other->meta.job)
415 return -EEXIST;
416
417 if (unit_active_state(other) != UNIT_INACTIVE)
418 return -EEXIST;
419
420 /* Merge names */
421 merge_names(u, other);
422
423 /* Merge dependencies */
424 for (d = 0; d < _UNIT_DEPENDENCY_MAX; d++)
425 merge_dependencies(u, other, d);
426
427 other->meta.load_state = UNIT_MERGED;
428 other->meta.merged_into = u;
429
430 /* If there is still some data attached to the other node, we
431 * don't need it anymore, and can free it. */
432 if (other->meta.load_state != UNIT_STUB)
433 if (UNIT_VTABLE(other)->done)
434 UNIT_VTABLE(other)->done(other);
435
436 unit_add_to_dbus_queue(u);
437 unit_add_to_cleanup_queue(other);
438
439 return 0;
440 }
441
442 int unit_merge_by_name(Unit *u, const char *name) {
443 Unit *other;
444
445 assert(u);
446 assert(name);
447
448 if (!(other = manager_get_unit(u->meta.manager, name)))
449 return unit_add_name(u, name);
450
451 return unit_merge(u, other);
452 }
453
454 Unit* unit_follow_merge(Unit *u) {
455 assert(u);
456
457 while (u->meta.load_state == UNIT_MERGED)
458 assert_se(u = u->meta.merged_into);
459
460 return u;
461 }
462
463 int unit_add_exec_dependencies(Unit *u, ExecContext *c) {
464 int r;
465
466 assert(u);
467 assert(c);
468
469 if (c->output != EXEC_OUTPUT_KERNEL && c->output != EXEC_OUTPUT_SYSLOG)
470 return 0;
471
472 /* If syslog or kernel logging is requested, make sure our own
473 * logging daemon is run first. */
474
475 if ((r = unit_add_dependency_by_name(u, UNIT_AFTER, SPECIAL_LOGGER_SOCKET)) < 0)
476 return r;
477
478 if (u->meta.manager->running_as != MANAGER_SESSION)
479 if ((r = unit_add_dependency_by_name(u, UNIT_REQUIRES, SPECIAL_LOGGER_SOCKET)) < 0)
480 return r;
481
482 return 0;
483 }
484
485 const char* unit_id(Unit *u) {
486 assert(u);
487
488 if (u->meta.id)
489 return u->meta.id;
490
491 return set_first(u->meta.names);
492 }
493
494 const char *unit_description(Unit *u) {
495 assert(u);
496
497 if (u->meta.description)
498 return u->meta.description;
499
500 return unit_id(u);
501 }
502
503 void unit_dump(Unit *u, FILE *f, const char *prefix) {
504 char *t;
505 UnitDependency d;
506 Iterator i;
507 char *p2;
508 const char *prefix2;
509 CGroupBonding *b;
510
511 assert(u);
512
513 if (!prefix)
514 prefix = "";
515 p2 = strappend(prefix, "\t");
516 prefix2 = p2 ? p2 : prefix;
517
518 fprintf(f,
519 "%s→ Unit %s:\n"
520 "%s\tDescription: %s\n"
521 "%s\tUnit Load State: %s\n"
522 "%s\tUnit Active State: %s\n",
523 prefix, unit_id(u),
524 prefix, unit_description(u),
525 prefix, unit_load_state_to_string(u->meta.load_state),
526 prefix, unit_active_state_to_string(unit_active_state(u)));
527
528 SET_FOREACH(t, u->meta.names, i)
529 fprintf(f, "%s\tName: %s\n", prefix, t);
530
531 if (u->meta.fragment_path)
532 fprintf(f, "%s\tFragment Path: %s\n", prefix, u->meta.fragment_path);
533
534 for (d = 0; d < _UNIT_DEPENDENCY_MAX; d++) {
535 Unit *other;
536
537 if (set_isempty(u->meta.dependencies[d]))
538 continue;
539
540 SET_FOREACH(other, u->meta.dependencies[d], i)
541 fprintf(f, "%s\t%s: %s\n", prefix, unit_dependency_to_string(d), unit_id(other));
542 }
543
544 fprintf(f,
545 "%s\tRecursive Stop: %s\n"
546 "%s\tStop When Unneeded: %s\n",
547 prefix, yes_no(u->meta.recursive_stop),
548 prefix, yes_no(u->meta.stop_when_unneeded));
549
550 if (u->meta.load_state == UNIT_LOADED) {
551 LIST_FOREACH(by_unit, b, u->meta.cgroup_bondings)
552 fprintf(f, "%s\tControlGroup: %s:%s\n",
553 prefix, b->controller, b->path);
554
555 if (UNIT_VTABLE(u)->dump)
556 UNIT_VTABLE(u)->dump(u, f, prefix2);
557 }
558
559 if (u->meta.job)
560 job_dump(u->meta.job, f, prefix2);
561
562 free(p2);
563 }
564
565 /* Common implementation for multiple backends */
566 int unit_load_fragment_and_dropin(Unit *u, UnitLoadState *new_state) {
567 int r;
568
569 assert(u);
570 assert(new_state);
571 assert(*new_state == UNIT_STUB || *new_state == UNIT_LOADED);
572
573 /* Load a .service file */
574 if ((r = unit_load_fragment(u, new_state)) < 0)
575 return r;
576
577 if (*new_state == UNIT_STUB)
578 return -ENOENT;
579
580 /* Load drop-in directory data */
581 if ((r = unit_load_dropin(unit_follow_merge(u))) < 0)
582 return r;
583
584 return 0;
585 }
586
587 /* Common implementation for multiple backends */
588 int unit_load_fragment_and_dropin_optional(Unit *u, UnitLoadState *new_state) {
589 int r;
590
591 assert(u);
592 assert(new_state);
593 assert(*new_state == UNIT_STUB || *new_state == UNIT_LOADED);
594
595 /* Same as unit_load_fragment_and_dropin(), but whether
596 * something can be loaded or not doesn't matter. */
597
598 /* Load a .service file */
599 if ((r = unit_load_fragment(u, new_state)) < 0)
600 return r;
601
602 if (*new_state == UNIT_STUB)
603 *new_state = UNIT_LOADED;
604
605 /* Load drop-in directory data */
606 if ((r = unit_load_dropin(unit_follow_merge(u))) < 0)
607 return r;
608
609 return 0;
610 }
611
612 int unit_load(Unit *u) {
613 int r;
614 UnitLoadState res;
615
616 assert(u);
617
618 if (u->meta.in_load_queue) {
619 LIST_REMOVE(Meta, load_queue, u->meta.manager->load_queue, &u->meta);
620 u->meta.in_load_queue = false;
621 }
622
623 if (u->meta.load_state != UNIT_STUB)
624 return 0;
625
626 if (UNIT_VTABLE(u)->init) {
627 res = UNIT_STUB;
628 if ((r = UNIT_VTABLE(u)->init(u, &res)) < 0)
629 goto fail;
630 }
631
632 if (res == UNIT_STUB) {
633 r = -ENOENT;
634 goto fail;
635 }
636
637 u->meta.load_state = res;
638 assert((u->meta.load_state != UNIT_MERGED) == !u->meta.merged_into);
639
640 unit_add_to_dbus_queue(unit_follow_merge(u));
641
642 return 0;
643
644 fail:
645 u->meta.load_state = UNIT_FAILED;
646 unit_add_to_dbus_queue(u);
647
648 log_error("Failed to load configuration for %s: %s", unit_id(u), strerror(-r));
649
650 return r;
651 }
652
653 /* Errors:
654 * -EBADR: This unit type does not support starting.
655 * -EALREADY: Unit is already started.
656 * -EAGAIN: An operation is already in progress. Retry later.
657 */
658 int unit_start(Unit *u) {
659 UnitActiveState state;
660
661 assert(u);
662
663 /* If this is already (being) started, then this will
664 * succeed. Note that this will even succeed if this unit is
665 * not startable by the user. This is relied on to detect when
666 * we need to wait for units and when waiting is finished. */
667 state = unit_active_state(u);
668 if (UNIT_IS_ACTIVE_OR_RELOADING(state))
669 return -EALREADY;
670
671 /* If it is stopped, but we cannot start it, then fail */
672 if (!UNIT_VTABLE(u)->start)
673 return -EBADR;
674
675 /* We don't suppress calls to ->start() here when we are
676 * already starting, to allow this request to be used as a
677 * "hurry up" call, for example when the unit is in some "auto
678 * restart" state where it waits for a holdoff timer to elapse
679 * before it will start again. */
680
681 unit_add_to_dbus_queue(u);
682 return UNIT_VTABLE(u)->start(u);
683 }
684
685 bool unit_can_start(Unit *u) {
686 assert(u);
687
688 return !!UNIT_VTABLE(u)->start;
689 }
690
691 /* Errors:
692 * -EBADR: This unit type does not support stopping.
693 * -EALREADY: Unit is already stopped.
694 * -EAGAIN: An operation is already in progress. Retry later.
695 */
696 int unit_stop(Unit *u) {
697 UnitActiveState state;
698
699 assert(u);
700
701 state = unit_active_state(u);
702 if (state == UNIT_INACTIVE)
703 return -EALREADY;
704
705 if (!UNIT_VTABLE(u)->stop)
706 return -EBADR;
707
708 if (state == UNIT_DEACTIVATING)
709 return 0;
710
711 unit_add_to_dbus_queue(u);
712 return UNIT_VTABLE(u)->stop(u);
713 }
714
715 /* Errors:
716 * -EBADR: This unit type does not support reloading.
717 * -ENOEXEC: Unit is not started.
718 * -EAGAIN: An operation is already in progress. Retry later.
719 */
720 int unit_reload(Unit *u) {
721 UnitActiveState state;
722
723 assert(u);
724
725 if (!unit_can_reload(u))
726 return -EBADR;
727
728 state = unit_active_state(u);
729 if (unit_active_state(u) == UNIT_ACTIVE_RELOADING)
730 return -EALREADY;
731
732 if (unit_active_state(u) != UNIT_ACTIVE)
733 return -ENOEXEC;
734
735 unit_add_to_dbus_queue(u);
736 return UNIT_VTABLE(u)->reload(u);
737 }
738
739 bool unit_can_reload(Unit *u) {
740 assert(u);
741
742 if (!UNIT_VTABLE(u)->reload)
743 return false;
744
745 if (!UNIT_VTABLE(u)->can_reload)
746 return true;
747
748 return UNIT_VTABLE(u)->can_reload(u);
749 }
750
751 static void unit_check_uneeded(Unit *u) {
752 Iterator i;
753 Unit *other;
754
755 assert(u);
756
757 /* If this service shall be shut down when unneeded then do
758 * so. */
759
760 if (!u->meta.stop_when_unneeded)
761 return;
762
763 if (!UNIT_IS_ACTIVE_OR_ACTIVATING(unit_active_state(u)))
764 return;
765
766 SET_FOREACH(other, u->meta.dependencies[UNIT_REQUIRED_BY], i)
767 if (!UNIT_IS_INACTIVE_OR_DEACTIVATING(unit_active_state(other)))
768 return;
769
770 SET_FOREACH(other, u->meta.dependencies[UNIT_SOFT_REQUIRED_BY], i)
771 if (!UNIT_IS_INACTIVE_OR_DEACTIVATING(unit_active_state(other)))
772 return;
773
774 SET_FOREACH(other, u->meta.dependencies[UNIT_WANTED_BY], i)
775 if (!UNIT_IS_INACTIVE_OR_DEACTIVATING(unit_active_state(other)))
776 return;
777
778 log_debug("Service %s is not needed anymore. Stopping.", unit_id(u));
779
780 /* Ok, nobody needs us anymore. Sniff. Then let's commit suicide */
781 manager_add_job(u->meta.manager, JOB_STOP, u, JOB_FAIL, true, NULL);
782 }
783
784 static void retroactively_start_dependencies(Unit *u) {
785 Iterator i;
786 Unit *other;
787
788 assert(u);
789 assert(UNIT_IS_ACTIVE_OR_ACTIVATING(unit_active_state(u)));
790
791 SET_FOREACH(other, u->meta.dependencies[UNIT_REQUIRES], i)
792 if (!UNIT_IS_ACTIVE_OR_ACTIVATING(unit_active_state(other)))
793 manager_add_job(u->meta.manager, JOB_START, other, JOB_REPLACE, true, NULL);
794
795 SET_FOREACH(other, u->meta.dependencies[UNIT_SOFT_REQUIRES], i)
796 if (!UNIT_IS_ACTIVE_OR_ACTIVATING(unit_active_state(other)))
797 manager_add_job(u->meta.manager, JOB_START, other, JOB_FAIL, false, NULL);
798
799 SET_FOREACH(other, u->meta.dependencies[UNIT_REQUISITE], i)
800 if (!UNIT_IS_ACTIVE_OR_ACTIVATING(unit_active_state(other)))
801 manager_add_job(u->meta.manager, JOB_START, other, JOB_REPLACE, true, NULL);
802
803 SET_FOREACH(other, u->meta.dependencies[UNIT_WANTS], i)
804 if (!UNIT_IS_ACTIVE_OR_ACTIVATING(unit_active_state(other)))
805 manager_add_job(u->meta.manager, JOB_START, other, JOB_FAIL, false, NULL);
806
807 SET_FOREACH(other, u->meta.dependencies[UNIT_CONFLICTS], i)
808 if (!UNIT_IS_ACTIVE_OR_ACTIVATING(unit_active_state(other)))
809 manager_add_job(u->meta.manager, JOB_STOP, other, JOB_REPLACE, true, NULL);
810 }
811
812 static void retroactively_stop_dependencies(Unit *u) {
813 Iterator i;
814 Unit *other;
815
816 assert(u);
817 assert(UNIT_IS_INACTIVE_OR_DEACTIVATING(unit_active_state(u)));
818
819 if (u->meta.recursive_stop) {
820 /* Pull down units need us recursively if enabled */
821 SET_FOREACH(other, u->meta.dependencies[UNIT_REQUIRED_BY], i)
822 if (!UNIT_IS_INACTIVE_OR_DEACTIVATING(unit_active_state(other)))
823 manager_add_job(u->meta.manager, JOB_STOP, other, JOB_REPLACE, true, NULL);
824 }
825
826 /* Garbage collect services that might not be needed anymore, if enabled */
827 SET_FOREACH(other, u->meta.dependencies[UNIT_REQUIRES], i)
828 if (!UNIT_IS_INACTIVE_OR_DEACTIVATING(unit_active_state(other)))
829 unit_check_uneeded(other);
830 SET_FOREACH(other, u->meta.dependencies[UNIT_SOFT_REQUIRES], i)
831 if (!UNIT_IS_INACTIVE_OR_DEACTIVATING(unit_active_state(other)))
832 unit_check_uneeded(other);
833 SET_FOREACH(other, u->meta.dependencies[UNIT_WANTS], i)
834 if (!UNIT_IS_INACTIVE_OR_DEACTIVATING(unit_active_state(other)))
835 unit_check_uneeded(other);
836 SET_FOREACH(other, u->meta.dependencies[UNIT_REQUISITE], i)
837 if (!UNIT_IS_INACTIVE_OR_DEACTIVATING(unit_active_state(other)))
838 unit_check_uneeded(other);
839 SET_FOREACH(other, u->meta.dependencies[UNIT_SOFT_REQUISITE], i)
840 if (!UNIT_IS_INACTIVE_OR_DEACTIVATING(unit_active_state(other)))
841 unit_check_uneeded(other);
842 }
843
844 void unit_notify(Unit *u, UnitActiveState os, UnitActiveState ns) {
845 bool unexpected = false;
846
847 assert(u);
848 assert(os < _UNIT_ACTIVE_STATE_MAX);
849 assert(ns < _UNIT_ACTIVE_STATE_MAX);
850 assert(!(os == UNIT_ACTIVE && ns == UNIT_ACTIVATING));
851 assert(!(os == UNIT_INACTIVE && ns == UNIT_DEACTIVATING));
852
853 if (os == ns)
854 return;
855
856 if (!UNIT_IS_ACTIVE_OR_RELOADING(os) && UNIT_IS_ACTIVE_OR_RELOADING(ns))
857 u->meta.active_enter_timestamp = now(CLOCK_REALTIME);
858 else if (UNIT_IS_ACTIVE_OR_RELOADING(os) && !UNIT_IS_ACTIVE_OR_RELOADING(ns))
859 u->meta.active_exit_timestamp = now(CLOCK_REALTIME);
860
861 if (u->meta.job) {
862
863 if (u->meta.job->state == JOB_WAITING)
864
865 /* So we reached a different state for this
866 * job. Let's see if we can run it now if it
867 * failed previously due to EAGAIN. */
868 job_add_to_run_queue(u->meta.job);
869
870 else {
871 assert(u->meta.job->state == JOB_RUNNING);
872
873 /* Let's check whether this state change
874 * constitutes a finished job, or maybe
875 * cotradicts a running job and hence needs to
876 * invalidate jobs. */
877
878 switch (u->meta.job->type) {
879
880 case JOB_START:
881 case JOB_VERIFY_ACTIVE:
882
883 if (UNIT_IS_ACTIVE_OR_RELOADING(ns))
884 job_finish_and_invalidate(u->meta.job, true);
885 else if (ns != UNIT_ACTIVATING) {
886 unexpected = true;
887 job_finish_and_invalidate(u->meta.job, false);
888 }
889
890 break;
891
892 case JOB_RELOAD:
893 case JOB_RELOAD_OR_START:
894
895 if (ns == UNIT_ACTIVE)
896 job_finish_and_invalidate(u->meta.job, true);
897 else if (ns != UNIT_ACTIVATING && ns != UNIT_ACTIVE_RELOADING) {
898 unexpected = true;
899 job_finish_and_invalidate(u->meta.job, false);
900 }
901
902 break;
903
904 case JOB_STOP:
905 case JOB_RESTART:
906 case JOB_TRY_RESTART:
907
908 if (ns == UNIT_INACTIVE)
909 job_finish_and_invalidate(u->meta.job, true);
910 else if (ns != UNIT_DEACTIVATING) {
911 unexpected = true;
912 job_finish_and_invalidate(u->meta.job, false);
913 }
914
915 break;
916
917 default:
918 assert_not_reached("Job type unknown");
919 }
920 }
921 }
922
923 /* If this state change happened without being requested by a
924 * job, then let's retroactively start or stop dependencies */
925
926 if (unexpected) {
927 if (UNIT_IS_INACTIVE_OR_DEACTIVATING(os) && UNIT_IS_ACTIVE_OR_ACTIVATING(ns))
928 retroactively_start_dependencies(u);
929 else if (UNIT_IS_ACTIVE_OR_ACTIVATING(os) && UNIT_IS_INACTIVE_OR_DEACTIVATING(ns))
930 retroactively_stop_dependencies(u);
931 }
932
933 if (!UNIT_IS_ACTIVE_OR_RELOADING(os) && UNIT_IS_ACTIVE_OR_RELOADING(ns)) {
934
935 if (unit_has_name(u, SPECIAL_DBUS_SERVICE)) {
936 log_info("D-Bus became available, trying to reconnect.");
937 /* The bus just got started, hence try to connect to it. */
938 bus_init_system(u->meta.manager);
939 bus_init_api(u->meta.manager);
940 }
941
942 if (unit_has_name(u, SPECIAL_SYSLOG_SERVICE)) {
943 /* The syslog daemon just got started, hence try to connect to it. */
944 log_info("Syslog became available, trying to reconnect.");
945 log_open_syslog();
946 }
947
948 } else if (UNIT_IS_ACTIVE_OR_RELOADING(os) && !UNIT_IS_ACTIVE_OR_RELOADING(ns)) {
949
950 if (unit_has_name(u, SPECIAL_SYSLOG_SERVICE))
951 /* The syslog daemon just got terminated, hence try to disconnect from it. */
952 log_close_syslog();
953
954 /* We don't care about D-Bus here, since we'll get an
955 * asynchronous notification for it anyway. */
956 }
957
958 /* Maybe we finished startup and are now ready for being
959 * stopped because unneeded? */
960 unit_check_uneeded(u);
961
962 unit_add_to_dbus_queue(u);
963 }
964
965 int unit_watch_fd(Unit *u, int fd, uint32_t events, Watch *w) {
966 struct epoll_event ev;
967
968 assert(u);
969 assert(fd >= 0);
970 assert(w);
971 assert(w->type == WATCH_INVALID || (w->type == WATCH_FD && w->fd == fd && w->data.unit == u));
972
973 zero(ev);
974 ev.data.ptr = w;
975 ev.events = events;
976
977 if (epoll_ctl(u->meta.manager->epoll_fd,
978 w->type == WATCH_INVALID ? EPOLL_CTL_ADD : EPOLL_CTL_MOD,
979 fd,
980 &ev) < 0)
981 return -errno;
982
983 w->fd = fd;
984 w->type = WATCH_FD;
985 w->data.unit = u;
986
987 return 0;
988 }
989
990 void unit_unwatch_fd(Unit *u, Watch *w) {
991 assert(u);
992 assert(w);
993
994 if (w->type == WATCH_INVALID)
995 return;
996
997 assert(w->type == WATCH_FD);
998 assert(w->data.unit == u);
999 assert_se(epoll_ctl(u->meta.manager->epoll_fd, EPOLL_CTL_DEL, w->fd, NULL) >= 0);
1000
1001 w->fd = -1;
1002 w->type = WATCH_INVALID;
1003 w->data.unit = NULL;
1004 }
1005
1006 int unit_watch_pid(Unit *u, pid_t pid) {
1007 assert(u);
1008 assert(pid >= 1);
1009
1010 return hashmap_put(u->meta.manager->watch_pids, UINT32_TO_PTR(pid), u);
1011 }
1012
1013 void unit_unwatch_pid(Unit *u, pid_t pid) {
1014 assert(u);
1015 assert(pid >= 1);
1016
1017 hashmap_remove(u->meta.manager->watch_pids, UINT32_TO_PTR(pid));
1018 }
1019
1020 int unit_watch_timer(Unit *u, usec_t delay, Watch *w) {
1021 struct itimerspec its;
1022 int flags, fd;
1023 bool ours;
1024
1025 assert(u);
1026 assert(w);
1027 assert(w->type == WATCH_INVALID || (w->type == WATCH_TIMER && w->data.unit == u));
1028
1029 /* This will try to reuse the old timer if there is one */
1030
1031 if (w->type == WATCH_TIMER) {
1032 ours = false;
1033 fd = w->fd;
1034 } else {
1035 ours = true;
1036 if ((fd = timerfd_create(CLOCK_MONOTONIC, TFD_NONBLOCK|TFD_CLOEXEC)) < 0)
1037 return -errno;
1038 }
1039
1040 zero(its);
1041
1042 if (delay <= 0) {
1043 /* Set absolute time in the past, but not 0, since we
1044 * don't want to disarm the timer */
1045 its.it_value.tv_sec = 0;
1046 its.it_value.tv_nsec = 1;
1047
1048 flags = TFD_TIMER_ABSTIME;
1049 } else {
1050 timespec_store(&its.it_value, delay);
1051 flags = 0;
1052 }
1053
1054 /* This will also flush the elapse counter */
1055 if (timerfd_settime(fd, flags, &its, NULL) < 0)
1056 goto fail;
1057
1058 if (w->type == WATCH_INVALID) {
1059 struct epoll_event ev;
1060
1061 zero(ev);
1062 ev.data.ptr = w;
1063 ev.events = EPOLLIN;
1064
1065 if (epoll_ctl(u->meta.manager->epoll_fd, EPOLL_CTL_ADD, fd, &ev) < 0)
1066 goto fail;
1067 }
1068
1069 w->fd = fd;
1070 w->type = WATCH_TIMER;
1071 w->data.unit = u;
1072
1073 return 0;
1074
1075 fail:
1076 if (ours)
1077 close_nointr_nofail(fd);
1078
1079 return -errno;
1080 }
1081
1082 void unit_unwatch_timer(Unit *u, Watch *w) {
1083 assert(u);
1084 assert(w);
1085
1086 if (w->type == WATCH_INVALID)
1087 return;
1088
1089 assert(w->type == WATCH_TIMER && w->data.unit == u);
1090
1091 assert_se(epoll_ctl(u->meta.manager->epoll_fd, EPOLL_CTL_DEL, w->fd, NULL) >= 0);
1092 assert_se(close_nointr(w->fd) == 0);
1093
1094 w->fd = -1;
1095 w->type = WATCH_INVALID;
1096 w->data.unit = NULL;
1097 }
1098
1099 bool unit_job_is_applicable(Unit *u, JobType j) {
1100 assert(u);
1101 assert(j >= 0 && j < _JOB_TYPE_MAX);
1102
1103 switch (j) {
1104
1105 case JOB_VERIFY_ACTIVE:
1106 case JOB_START:
1107 return true;
1108
1109 case JOB_STOP:
1110 case JOB_RESTART:
1111 case JOB_TRY_RESTART:
1112 return unit_can_start(u);
1113
1114 case JOB_RELOAD:
1115 return unit_can_reload(u);
1116
1117 case JOB_RELOAD_OR_START:
1118 return unit_can_reload(u) && unit_can_start(u);
1119
1120 default:
1121 assert_not_reached("Invalid job type");
1122 }
1123 }
1124
1125 int unit_add_dependency(Unit *u, UnitDependency d, Unit *other) {
1126
1127 static const UnitDependency inverse_table[_UNIT_DEPENDENCY_MAX] = {
1128 [UNIT_REQUIRES] = UNIT_REQUIRED_BY,
1129 [UNIT_SOFT_REQUIRES] = UNIT_SOFT_REQUIRED_BY,
1130 [UNIT_WANTS] = UNIT_WANTED_BY,
1131 [UNIT_REQUISITE] = UNIT_REQUIRED_BY,
1132 [UNIT_SOFT_REQUISITE] = UNIT_SOFT_REQUIRED_BY,
1133 [UNIT_REQUIRED_BY] = _UNIT_DEPENDENCY_INVALID,
1134 [UNIT_SOFT_REQUIRED_BY] = _UNIT_DEPENDENCY_INVALID,
1135 [UNIT_WANTED_BY] = _UNIT_DEPENDENCY_INVALID,
1136 [UNIT_CONFLICTS] = UNIT_CONFLICTS,
1137 [UNIT_BEFORE] = UNIT_AFTER,
1138 [UNIT_AFTER] = UNIT_BEFORE
1139 };
1140 int r;
1141
1142 assert(u);
1143 assert(d >= 0 && d < _UNIT_DEPENDENCY_MAX);
1144 assert(inverse_table[d] != _UNIT_DEPENDENCY_INVALID);
1145 assert(other);
1146
1147 /* We won't allow dependencies on ourselves. We will not
1148 * consider them an error however. */
1149 if (u == other)
1150 return 0;
1151
1152 if ((r = set_ensure_allocated(&u->meta.dependencies[d], trivial_hash_func, trivial_compare_func)) < 0)
1153 return r;
1154
1155 if ((r = set_ensure_allocated(&other->meta.dependencies[inverse_table[d]], trivial_hash_func, trivial_compare_func)) < 0)
1156 return r;
1157
1158 if ((r = set_put(u->meta.dependencies[d], other)) < 0)
1159 return r;
1160
1161 if ((r = set_put(other->meta.dependencies[inverse_table[d]], u)) < 0) {
1162 set_remove(u->meta.dependencies[d], other);
1163 return r;
1164 }
1165
1166 unit_add_to_dbus_queue(u);
1167 return 0;
1168 }
1169
1170 int unit_add_dependency_by_name(Unit *u, UnitDependency d, const char *name) {
1171 Unit *other;
1172 int r;
1173
1174 if ((r = manager_load_unit(u->meta.manager, name, &other)) < 0)
1175 return r;
1176
1177 if ((r = unit_add_dependency(u, d, other)) < 0)
1178 return r;
1179
1180 return 0;
1181 }
1182
1183 int unit_add_dependency_by_name_inverse(Unit *u, UnitDependency d, const char *name) {
1184 Unit *other;
1185 int r;
1186
1187 if ((r = manager_load_unit(u->meta.manager, name, &other)) < 0)
1188 return r;
1189
1190 if ((r = unit_add_dependency(other, d, u)) < 0)
1191 return r;
1192
1193 return 0;
1194 }
1195
1196 int set_unit_path(const char *p) {
1197 char *cwd, *c;
1198 int r;
1199
1200 /* This is mostly for debug purposes */
1201
1202 if (path_is_absolute(p)) {
1203 if (!(c = strdup(p)))
1204 return -ENOMEM;
1205 } else {
1206 if (!(cwd = get_current_dir_name()))
1207 return -errno;
1208
1209 r = asprintf(&c, "%s/%s", cwd, p);
1210 free(cwd);
1211
1212 if (r < 0)
1213 return -ENOMEM;
1214 }
1215
1216 if (setenv("SYSTEMD_UNIT_PATH", c, 0) < 0) {
1217 r = -errno;
1218 free(c);
1219 return r;
1220 }
1221
1222 return 0;
1223 }
1224
1225 char *unit_name_escape_path(const char *path, const char *suffix) {
1226 char *r, *t;
1227 const char *f;
1228 size_t a, b;
1229
1230 assert(path);
1231
1232 /* Takes a path and a suffix and prefix and makes a nice
1233 * string suitable as unit name of it, escaping all weird
1234 * chars on the way.
1235 *
1236 * / becomes ., and all chars not alloweed in a unit name get
1237 * escaped as \xFF, including \ and ., of course. This
1238 * escaping is hence reversible.
1239 */
1240
1241 if (!suffix)
1242 suffix = "";
1243
1244 a = strlen(path);
1245 b = strlen(suffix);
1246
1247 if (!(r = new(char, a*4+b+1)))
1248 return NULL;
1249
1250 for (f = path, t = r; *f; f++) {
1251 if (*f == '/')
1252 *(t++) = '.';
1253 else if (*f == '.' || *f == '\\' || !strchr(VALID_CHARS, *f)) {
1254 *(t++) = '\\';
1255 *(t++) = 'x';
1256 *(t++) = hexchar(*f > 4);
1257 *(t++) = hexchar(*f);
1258 } else
1259 *(t++) = *f;
1260 }
1261
1262 memcpy(t, suffix, b+1);
1263
1264 return r;
1265 }
1266
1267 char *unit_dbus_path(Unit *u) {
1268 char *p, *e;
1269
1270 assert(u);
1271
1272 if (!(e = bus_path_escape(unit_id(u))))
1273 return NULL;
1274
1275 if (asprintf(&p, "/org/freedesktop/systemd1/unit/%s", e) < 0) {
1276 free(e);
1277 return NULL;
1278 }
1279
1280 free(e);
1281 return p;
1282 }
1283
1284 int unit_add_cgroup(Unit *u, CGroupBonding *b) {
1285 CGroupBonding *l;
1286 int r;
1287
1288 assert(u);
1289 assert(b);
1290 assert(b->path);
1291
1292 /* Ensure this hasn't been added yet */
1293 assert(!b->unit);
1294
1295 l = hashmap_get(u->meta.manager->cgroup_bondings, b->path);
1296 LIST_PREPEND(CGroupBonding, by_path, l, b);
1297
1298 if ((r = hashmap_replace(u->meta.manager->cgroup_bondings, b->path, l)) < 0) {
1299 LIST_REMOVE(CGroupBonding, by_path, l, b);
1300 return r;
1301 }
1302
1303 LIST_PREPEND(CGroupBonding, by_unit, u->meta.cgroup_bondings, b);
1304 b->unit = u;
1305
1306 return 0;
1307 }
1308
1309 int unit_add_cgroup_from_text(Unit *u, const char *name) {
1310 size_t n;
1311 const char *p;
1312 char *controller;
1313 CGroupBonding *b;
1314 int r;
1315
1316 assert(u);
1317 assert(name);
1318
1319 /* Detect controller name */
1320 n = strcspn(name, ":/");
1321
1322 /* Only controller name, no path? No path? */
1323 if (name[n] == 0)
1324 return -EINVAL;
1325
1326 if (n > 0) {
1327 if (name[n] != ':')
1328 return -EINVAL;
1329
1330 p = name+n+1;
1331 } else
1332 p = name;
1333
1334 /* Insist in absolute paths */
1335 if (p[0] != '/')
1336 return -EINVAL;
1337
1338 if (!(controller = strndup(name, n)))
1339 return -ENOMEM;
1340
1341 if (cgroup_bonding_find_list(u->meta.cgroup_bondings, controller)) {
1342 free(controller);
1343 return -EEXIST;
1344 }
1345
1346 if (!(b = new0(CGroupBonding, 1))) {
1347 free(controller);
1348 return -ENOMEM;
1349 }
1350
1351 b->controller = controller;
1352
1353 if (!(b->path = strdup(p))) {
1354 r = -ENOMEM;
1355 goto fail;
1356 }
1357
1358 b->only_us = false;
1359 b->clean_up = false;
1360
1361 if ((r = unit_add_cgroup(u, b)) < 0)
1362 goto fail;
1363
1364 return 0;
1365
1366 fail:
1367 free(b->path);
1368 free(b->controller);
1369 free(b);
1370
1371 return r;
1372 }
1373
1374 int unit_add_default_cgroup(Unit *u) {
1375 CGroupBonding *b;
1376 int r = -ENOMEM;
1377
1378 assert(u);
1379
1380 /* Adds in the default cgroup data, if it wasn't specified yet */
1381
1382 if (unit_get_default_cgroup(u))
1383 return 0;
1384
1385 if (!(b = new0(CGroupBonding, 1)))
1386 return -ENOMEM;
1387
1388 if (!(b->controller = strdup(u->meta.manager->cgroup_controller)))
1389 goto fail;
1390
1391 if (asprintf(&b->path, "%s/%s", u->meta.manager->cgroup_hierarchy, unit_id(u)) < 0)
1392 goto fail;
1393
1394 b->clean_up = true;
1395 b->only_us = true;
1396
1397 if ((r = unit_add_cgroup(u, b)) < 0)
1398 goto fail;
1399
1400 return 0;
1401
1402 fail:
1403 free(b->path);
1404 free(b->controller);
1405 free(b);
1406
1407 return r;
1408 }
1409
1410 CGroupBonding* unit_get_default_cgroup(Unit *u) {
1411 assert(u);
1412
1413 return cgroup_bonding_find_list(u->meta.cgroup_bondings, u->meta.manager->cgroup_controller);
1414 }
1415
1416 static const char* const unit_type_table[_UNIT_TYPE_MAX] = {
1417 [UNIT_SERVICE] = "service",
1418 [UNIT_TIMER] = "timer",
1419 [UNIT_SOCKET] = "socket",
1420 [UNIT_TARGET] = "target",
1421 [UNIT_DEVICE] = "device",
1422 [UNIT_MOUNT] = "mount",
1423 [UNIT_AUTOMOUNT] = "automount",
1424 [UNIT_SNAPSHOT] = "snapshot"
1425 };
1426
1427 DEFINE_STRING_TABLE_LOOKUP(unit_type, UnitType);
1428
1429 static const char* const unit_load_state_table[_UNIT_LOAD_STATE_MAX] = {
1430 [UNIT_STUB] = "stub",
1431 [UNIT_LOADED] = "loaded",
1432 [UNIT_FAILED] = "failed",
1433 [UNIT_MERGED] = "merged"
1434 };
1435
1436 DEFINE_STRING_TABLE_LOOKUP(unit_load_state, UnitLoadState);
1437
1438 static const char* const unit_active_state_table[_UNIT_ACTIVE_STATE_MAX] = {
1439 [UNIT_ACTIVE] = "active",
1440 [UNIT_INACTIVE] = "inactive",
1441 [UNIT_ACTIVATING] = "activating",
1442 [UNIT_DEACTIVATING] = "deactivating"
1443 };
1444
1445 DEFINE_STRING_TABLE_LOOKUP(unit_active_state, UnitActiveState);
1446
1447 static const char* const unit_dependency_table[_UNIT_DEPENDENCY_MAX] = {
1448 [UNIT_REQUIRES] = "Requires",
1449 [UNIT_SOFT_REQUIRES] = "SoftRequires",
1450 [UNIT_WANTS] = "Wants",
1451 [UNIT_REQUISITE] = "Requisite",
1452 [UNIT_SOFT_REQUISITE] = "SoftRequisite",
1453 [UNIT_REQUIRED_BY] = "RequiredBy",
1454 [UNIT_SOFT_REQUIRED_BY] = "SoftRequiredBy",
1455 [UNIT_WANTED_BY] = "WantedBy",
1456 [UNIT_CONFLICTS] = "Conflicts",
1457 [UNIT_BEFORE] = "Before",
1458 [UNIT_AFTER] = "After",
1459 };
1460
1461 DEFINE_STRING_TABLE_LOOKUP(unit_dependency, UnitDependency);
1462
1463 static const char* const kill_mode_table[_KILL_MODE_MAX] = {
1464 [KILL_PROCESS] = "process",
1465 [KILL_PROCESS_GROUP] = "process-group",
1466 [KILL_CONTROL_GROUP] = "control-group"
1467 };
1468
1469 DEFINE_STRING_TABLE_LOOKUP(kill_mode, KillMode);