1 /*-*- Mode: C; c-basic-offset: 8 -*-*/
4 This file is part of systemd.
6 Copyright 2010 Lennart Poettering
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.
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.
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/>.
25 #include <sys/epoll.h>
26 #include <sys/timerfd.h>
35 #include "load-fragment.h"
36 #include "load-dropin.h"
38 #include "unit-name.h"
39 #include "specifier.h"
40 #include "dbus-unit.h"
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 [UNIT_PATH] = &path_vtable
55 Unit *unit_new(Manager *m) {
60 if (!(u = new0(Unit, 1)))
63 if (!(u->meta.names = set_new(string_hash_func, string_compare_func))) {
69 u->meta.type = _UNIT_TYPE_INVALID;
70 u->meta.deserialized_job = _JOB_TYPE_INVALID;
75 bool unit_has_name(Unit *u, const char *name) {
79 return !!set_get(u->meta.names, (char*) name);
82 int unit_add_name(Unit *u, const char *text) {
84 char *s = NULL, *i = NULL;
90 if (unit_name_is_template(text)) {
91 if (!u->meta.instance)
94 s = unit_name_replace_instance(text, u->meta.instance);
101 if (!unit_name_is_valid(s)) {
106 assert_se((t = unit_name_to_type(s)) >= 0);
108 if (u->meta.type != _UNIT_TYPE_INVALID && t != u->meta.type) {
113 if ((r = unit_name_to_instance(s, &i)) < 0)
116 if (i && unit_vtable[t]->no_instances)
119 if (u->meta.type != _UNIT_TYPE_INVALID && !streq_ptr(u->meta.instance, i)) {
124 if (unit_vtable[t]->no_alias &&
125 !set_isempty(u->meta.names) &&
126 !set_get(u->meta.names, s)) {
131 if (hashmap_size(u->meta.manager->units) >= MANAGER_MAX_NAMES) {
136 if ((r = set_put(u->meta.names, s)) < 0) {
142 if ((r = hashmap_put(u->meta.manager->units, s, u)) < 0) {
143 set_remove(u->meta.names, s);
147 if (u->meta.type == _UNIT_TYPE_INVALID) {
151 u->meta.instance = i;
153 LIST_PREPEND(Meta, units_per_type, u->meta.manager->units_per_type[t], &u->meta);
155 if (UNIT_VTABLE(u)->init)
156 UNIT_VTABLE(u)->init(u);
160 unit_add_to_dbus_queue(u);
170 int unit_choose_id(Unit *u, const char *name) {
176 if (unit_name_is_template(name)) {
178 if (!u->meta.instance)
181 if (!(t = unit_name_replace_instance(name, u->meta.instance)))
187 /* Selects one of the names of this unit as the id */
188 s = set_get(u->meta.names, (char*) name);
195 unit_add_to_dbus_queue(u);
200 int unit_set_description(Unit *u, const char *description) {
205 if (!(s = strdup(description)))
208 free(u->meta.description);
209 u->meta.description = s;
211 unit_add_to_dbus_queue(u);
215 bool unit_check_gc(Unit *u) {
218 if (u->meta.load_state == UNIT_STUB)
221 if (UNIT_VTABLE(u)->no_gc)
227 if (unit_active_state(u) != UNIT_INACTIVE)
230 if (UNIT_VTABLE(u)->check_gc)
231 if (UNIT_VTABLE(u)->check_gc(u))
237 void unit_add_to_load_queue(Unit *u) {
239 assert(u->meta.type != _UNIT_TYPE_INVALID);
241 if (u->meta.load_state != UNIT_STUB || u->meta.in_load_queue)
244 LIST_PREPEND(Meta, load_queue, u->meta.manager->load_queue, &u->meta);
245 u->meta.in_load_queue = true;
248 void unit_add_to_cleanup_queue(Unit *u) {
251 if (u->meta.in_cleanup_queue)
254 LIST_PREPEND(Meta, cleanup_queue, u->meta.manager->cleanup_queue, &u->meta);
255 u->meta.in_cleanup_queue = true;
258 void unit_add_to_gc_queue(Unit *u) {
261 if (u->meta.in_gc_queue || u->meta.in_cleanup_queue)
264 if (unit_check_gc(u))
267 LIST_PREPEND(Meta, gc_queue, u->meta.manager->gc_queue, &u->meta);
268 u->meta.in_gc_queue = true;
270 u->meta.manager->n_in_gc_queue ++;
272 if (u->meta.manager->gc_queue_timestamp <= 0)
273 u->meta.manager->gc_queue_timestamp = now(CLOCK_MONOTONIC);
276 void unit_add_to_dbus_queue(Unit *u) {
278 assert(u->meta.type != _UNIT_TYPE_INVALID);
280 if (u->meta.load_state == UNIT_STUB || u->meta.in_dbus_queue)
283 if (set_isempty(u->meta.manager->subscribed)) {
284 u->meta.sent_dbus_new_signal = true;
288 LIST_PREPEND(Meta, dbus_queue, u->meta.manager->dbus_unit_queue, &u->meta);
289 u->meta.in_dbus_queue = true;
292 static void bidi_set_free(Unit *u, Set *s) {
298 /* Frees the set and makes sure we are dropped from the
299 * inverse pointers */
301 SET_FOREACH(other, s, i) {
304 for (d = 0; d < _UNIT_DEPENDENCY_MAX; d++)
305 set_remove(other->meta.dependencies[d], u);
307 unit_add_to_gc_queue(other);
313 void unit_free(Unit *u) {
320 bus_unit_send_removed_signal(u);
322 /* Detach from next 'bigger' objects */
323 SET_FOREACH(t, u->meta.names, i)
324 hashmap_remove_value(u->meta.manager->units, t, u);
326 if (u->meta.type != _UNIT_TYPE_INVALID)
327 LIST_REMOVE(Meta, units_per_type, u->meta.manager->units_per_type[u->meta.type], &u->meta);
329 if (u->meta.in_load_queue)
330 LIST_REMOVE(Meta, load_queue, u->meta.manager->load_queue, &u->meta);
332 if (u->meta.in_dbus_queue)
333 LIST_REMOVE(Meta, dbus_queue, u->meta.manager->dbus_unit_queue, &u->meta);
335 if (u->meta.in_cleanup_queue)
336 LIST_REMOVE(Meta, cleanup_queue, u->meta.manager->cleanup_queue, &u->meta);
338 if (u->meta.in_gc_queue) {
339 LIST_REMOVE(Meta, gc_queue, u->meta.manager->gc_queue, &u->meta);
340 u->meta.manager->n_in_gc_queue--;
343 /* Free data and next 'smaller' objects */
345 job_free(u->meta.job);
347 if (u->meta.load_state != UNIT_STUB)
348 if (UNIT_VTABLE(u)->done)
349 UNIT_VTABLE(u)->done(u);
351 cgroup_bonding_free_list(u->meta.cgroup_bondings);
353 for (d = 0; d < _UNIT_DEPENDENCY_MAX; d++)
354 bidi_set_free(u, u->meta.dependencies[d]);
356 free(u->meta.description);
357 free(u->meta.fragment_path);
359 while ((t = set_steal_first(u->meta.names)))
361 set_free(u->meta.names);
363 free(u->meta.instance);
368 UnitActiveState unit_active_state(Unit *u) {
371 if (u->meta.load_state != UNIT_LOADED)
372 return UNIT_INACTIVE;
374 return UNIT_VTABLE(u)->active_state(u);
377 const char* unit_sub_state_to_string(Unit *u) {
380 return UNIT_VTABLE(u)->sub_state_to_string(u);
383 static void complete_move(Set **s, Set **other) {
391 set_move(*s, *other);
398 static void merge_names(Unit *u, Unit *other) {
405 complete_move(&u->meta.names, &other->meta.names);
407 while ((t = set_steal_first(other->meta.names)))
410 set_free(other->meta.names);
411 other->meta.names = NULL;
412 other->meta.id = NULL;
414 SET_FOREACH(t, u->meta.names, i)
415 assert_se(hashmap_replace(u->meta.manager->units, t, u) == 0);
418 static void merge_dependencies(Unit *u, Unit *other, UnitDependency d) {
425 assert(d < _UNIT_DEPENDENCY_MAX);
427 SET_FOREACH(back, other->meta.dependencies[d], i) {
430 for (k = 0; k < _UNIT_DEPENDENCY_MAX; k++)
431 if ((r = set_remove_and_put(back->meta.dependencies[k], other, u)) < 0) {
434 set_remove(back->meta.dependencies[k], other);
436 assert(r == -ENOENT);
440 complete_move(&u->meta.dependencies[d], &other->meta.dependencies[d]);
442 set_free(other->meta.dependencies[d]);
443 other->meta.dependencies[d] = NULL;
446 int unit_merge(Unit *u, Unit *other) {
451 assert(u->meta.manager == other->meta.manager);
452 assert(u->meta.type != _UNIT_TYPE_INVALID);
454 other = unit_follow_merge(other);
459 if (u->meta.type != other->meta.type)
462 if (!streq_ptr(u->meta.instance, other->meta.instance))
465 if (other->meta.load_state != UNIT_STUB &&
466 other->meta.load_state != UNIT_FAILED)
472 if (unit_active_state(other) != UNIT_INACTIVE)
476 merge_names(u, other);
478 /* Merge dependencies */
479 for (d = 0; d < _UNIT_DEPENDENCY_MAX; d++)
480 merge_dependencies(u, other, d);
482 other->meta.load_state = UNIT_MERGED;
483 other->meta.merged_into = u;
485 /* If there is still some data attached to the other node, we
486 * don't need it anymore, and can free it. */
487 if (other->meta.load_state != UNIT_STUB)
488 if (UNIT_VTABLE(other)->done)
489 UNIT_VTABLE(other)->done(other);
491 unit_add_to_dbus_queue(u);
492 unit_add_to_cleanup_queue(other);
497 int unit_merge_by_name(Unit *u, const char *name) {
505 if (unit_name_is_template(name)) {
506 if (!u->meta.instance)
509 if (!(s = unit_name_replace_instance(name, u->meta.instance)))
515 if (!(other = manager_get_unit(u->meta.manager, name)))
516 r = unit_add_name(u, name);
518 r = unit_merge(u, other);
524 Unit* unit_follow_merge(Unit *u) {
527 while (u->meta.load_state == UNIT_MERGED)
528 assert_se(u = u->meta.merged_into);
533 int unit_add_exec_dependencies(Unit *u, ExecContext *c) {
539 if (c->std_output != EXEC_OUTPUT_KMSG &&
540 c->std_output != EXEC_OUTPUT_SYSLOG &&
541 c->std_error != EXEC_OUTPUT_KMSG &&
542 c->std_error != EXEC_OUTPUT_SYSLOG)
545 /* If syslog or kernel logging is requested, make sure our own
546 * logging daemon is run first. */
548 if ((r = unit_add_dependency_by_name(u, UNIT_AFTER, SPECIAL_LOGGER_SOCKET, NULL, true)) < 0)
551 if (u->meta.manager->running_as != MANAGER_SESSION)
552 if ((r = unit_add_dependency_by_name(u, UNIT_REQUIRES, SPECIAL_LOGGER_SOCKET, NULL, true)) < 0)
558 const char *unit_description(Unit *u) {
561 if (u->meta.description)
562 return u->meta.description;
567 void unit_dump(Unit *u, FILE *f, const char *prefix) {
575 timestamp1[FORMAT_TIMESTAMP_MAX],
576 timestamp2[FORMAT_TIMESTAMP_MAX],
577 timestamp3[FORMAT_TIMESTAMP_MAX],
578 timestamp4[FORMAT_TIMESTAMP_MAX];
581 assert(u->meta.type >= 0);
585 p2 = strappend(prefix, "\t");
586 prefix2 = p2 ? p2 : prefix;
590 "%s\tDescription: %s\n"
592 "%s\tUnit Load State: %s\n"
593 "%s\tUnit Active State: %s\n"
594 "%s\tInactive Exit Timestamp: %s\n"
595 "%s\tActive Enter Timestamp: %s\n"
596 "%s\tActive Exit Timestamp: %s\n"
597 "%s\tInactive Enter Timestamp: %s\n"
598 "%s\tGC Check Good: %s\n"
599 "%s\tOnly By Dependency: %s\n",
601 prefix, unit_description(u),
602 prefix, strna(u->meta.instance),
603 prefix, unit_load_state_to_string(u->meta.load_state),
604 prefix, unit_active_state_to_string(unit_active_state(u)),
605 prefix, strna(format_timestamp(timestamp1, sizeof(timestamp1), u->meta.inactive_exit_timestamp.realtime)),
606 prefix, strna(format_timestamp(timestamp2, sizeof(timestamp2), u->meta.active_enter_timestamp.realtime)),
607 prefix, strna(format_timestamp(timestamp3, sizeof(timestamp3), u->meta.active_exit_timestamp.realtime)),
608 prefix, strna(format_timestamp(timestamp4, sizeof(timestamp4), u->meta.inactive_enter_timestamp.realtime)),
609 prefix, yes_no(unit_check_gc(u)),
610 prefix, yes_no(u->meta.only_by_dependency));
612 SET_FOREACH(t, u->meta.names, i)
613 fprintf(f, "%s\tName: %s\n", prefix, t);
615 if (u->meta.fragment_path)
616 fprintf(f, "%s\tFragment Path: %s\n", prefix, u->meta.fragment_path);
618 for (d = 0; d < _UNIT_DEPENDENCY_MAX; d++) {
621 SET_FOREACH(other, u->meta.dependencies[d], i)
622 fprintf(f, "%s\t%s: %s\n", prefix, unit_dependency_to_string(d), other->meta.id);
625 if (u->meta.load_state == UNIT_LOADED) {
627 "%s\tRecursive Stop: %s\n"
628 "%s\tStop When Unneeded: %s\n",
629 prefix, yes_no(u->meta.recursive_stop),
630 prefix, yes_no(u->meta.stop_when_unneeded));
632 LIST_FOREACH(by_unit, b, u->meta.cgroup_bondings)
633 fprintf(f, "%s\tControlGroup: %s:%s\n",
634 prefix, b->controller, b->path);
636 if (UNIT_VTABLE(u)->dump)
637 UNIT_VTABLE(u)->dump(u, f, prefix2);
639 } else if (u->meta.load_state == UNIT_MERGED)
641 "%s\tMerged into: %s\n",
642 prefix, u->meta.merged_into->meta.id);
645 job_dump(u->meta.job, f, prefix2);
650 /* Common implementation for multiple backends */
651 int unit_load_fragment_and_dropin(Unit *u) {
656 /* Load a .service file */
657 if ((r = unit_load_fragment(u)) < 0)
660 if (u->meta.load_state == UNIT_STUB)
663 /* Load drop-in directory data */
664 if ((r = unit_load_dropin(unit_follow_merge(u))) < 0)
670 /* Common implementation for multiple backends */
671 int unit_load_fragment_and_dropin_optional(Unit *u) {
676 /* Same as unit_load_fragment_and_dropin(), but whether
677 * something can be loaded or not doesn't matter. */
679 /* Load a .service file */
680 if ((r = unit_load_fragment(u)) < 0)
683 if (u->meta.load_state == UNIT_STUB)
684 u->meta.load_state = UNIT_LOADED;
686 /* Load drop-in directory data */
687 if ((r = unit_load_dropin(unit_follow_merge(u))) < 0)
693 /* Common implementation for multiple backends */
694 int unit_load_nop(Unit *u) {
697 if (u->meta.load_state == UNIT_STUB)
698 u->meta.load_state = UNIT_LOADED;
703 int unit_load(Unit *u) {
708 if (u->meta.in_load_queue) {
709 LIST_REMOVE(Meta, load_queue, u->meta.manager->load_queue, &u->meta);
710 u->meta.in_load_queue = false;
713 if (u->meta.type == _UNIT_TYPE_INVALID)
716 if (u->meta.load_state != UNIT_STUB)
719 if (UNIT_VTABLE(u)->load)
720 if ((r = UNIT_VTABLE(u)->load(u)) < 0)
723 if (u->meta.load_state == UNIT_STUB) {
728 assert((u->meta.load_state != UNIT_MERGED) == !u->meta.merged_into);
730 unit_add_to_dbus_queue(unit_follow_merge(u));
731 unit_add_to_gc_queue(u);
736 u->meta.load_state = UNIT_FAILED;
737 unit_add_to_dbus_queue(u);
739 log_debug("Failed to load configuration for %s: %s", u->meta.id, strerror(-r));
745 * -EBADR: This unit type does not support starting.
746 * -EALREADY: Unit is already started.
747 * -EAGAIN: An operation is already in progress. Retry later.
748 * -ECANCELED: Too many requests for now.
750 int unit_start(Unit *u) {
751 UnitActiveState state;
755 /* If this is already (being) started, then this will
756 * succeed. Note that this will even succeed if this unit is
757 * not startable by the user. This is relied on to detect when
758 * we need to wait for units and when waiting is finished. */
759 state = unit_active_state(u);
760 if (UNIT_IS_ACTIVE_OR_RELOADING(state))
763 /* If it is stopped, but we cannot start it, then fail */
764 if (!UNIT_VTABLE(u)->start)
767 /* We don't suppress calls to ->start() here when we are
768 * already starting, to allow this request to be used as a
769 * "hurry up" call, for example when the unit is in some "auto
770 * restart" state where it waits for a holdoff timer to elapse
771 * before it will start again. */
773 unit_add_to_dbus_queue(u);
774 return UNIT_VTABLE(u)->start(u);
777 bool unit_can_start(Unit *u) {
780 return !!UNIT_VTABLE(u)->start;
784 * -EBADR: This unit type does not support stopping.
785 * -EALREADY: Unit is already stopped.
786 * -EAGAIN: An operation is already in progress. Retry later.
788 int unit_stop(Unit *u) {
789 UnitActiveState state;
793 state = unit_active_state(u);
794 if (state == UNIT_INACTIVE)
797 if (!UNIT_VTABLE(u)->stop)
800 unit_add_to_dbus_queue(u);
801 return UNIT_VTABLE(u)->stop(u);
805 * -EBADR: This unit type does not support reloading.
806 * -ENOEXEC: Unit is not started.
807 * -EAGAIN: An operation is already in progress. Retry later.
809 int unit_reload(Unit *u) {
810 UnitActiveState state;
814 if (!unit_can_reload(u))
817 state = unit_active_state(u);
818 if (unit_active_state(u) == UNIT_ACTIVE_RELOADING)
821 if (unit_active_state(u) != UNIT_ACTIVE)
824 unit_add_to_dbus_queue(u);
825 return UNIT_VTABLE(u)->reload(u);
828 bool unit_can_reload(Unit *u) {
831 if (!UNIT_VTABLE(u)->reload)
834 if (!UNIT_VTABLE(u)->can_reload)
837 return UNIT_VTABLE(u)->can_reload(u);
840 static void unit_check_uneeded(Unit *u) {
846 /* If this service shall be shut down when unneeded then do
849 if (!u->meta.stop_when_unneeded)
852 if (!UNIT_IS_ACTIVE_OR_ACTIVATING(unit_active_state(u)))
855 SET_FOREACH(other, u->meta.dependencies[UNIT_REQUIRED_BY], i)
856 if (!UNIT_IS_INACTIVE_OR_DEACTIVATING(unit_active_state(other)))
859 SET_FOREACH(other, u->meta.dependencies[UNIT_REQUIRED_BY_OVERRIDABLE], i)
860 if (!UNIT_IS_INACTIVE_OR_DEACTIVATING(unit_active_state(other)))
863 SET_FOREACH(other, u->meta.dependencies[UNIT_WANTED_BY], i)
864 if (!UNIT_IS_INACTIVE_OR_DEACTIVATING(unit_active_state(other)))
867 log_debug("Service %s is not needed anymore. Stopping.", u->meta.id);
869 /* Ok, nobody needs us anymore. Sniff. Then let's commit suicide */
870 manager_add_job(u->meta.manager, JOB_STOP, u, JOB_FAIL, true, NULL);
873 static void retroactively_start_dependencies(Unit *u) {
878 assert(UNIT_IS_ACTIVE_OR_ACTIVATING(unit_active_state(u)));
880 SET_FOREACH(other, u->meta.dependencies[UNIT_REQUIRES], i)
881 if (!UNIT_IS_ACTIVE_OR_ACTIVATING(unit_active_state(other)))
882 manager_add_job(u->meta.manager, JOB_START, other, JOB_REPLACE, true, NULL);
884 SET_FOREACH(other, u->meta.dependencies[UNIT_REQUIRES_OVERRIDABLE], i)
885 if (!UNIT_IS_ACTIVE_OR_ACTIVATING(unit_active_state(other)))
886 manager_add_job(u->meta.manager, JOB_START, other, JOB_FAIL, false, NULL);
888 SET_FOREACH(other, u->meta.dependencies[UNIT_REQUISITE], i)
889 if (!UNIT_IS_ACTIVE_OR_ACTIVATING(unit_active_state(other)))
890 manager_add_job(u->meta.manager, JOB_START, other, JOB_REPLACE, true, NULL);
892 SET_FOREACH(other, u->meta.dependencies[UNIT_WANTS], i)
893 if (!UNIT_IS_ACTIVE_OR_ACTIVATING(unit_active_state(other)))
894 manager_add_job(u->meta.manager, JOB_START, other, JOB_FAIL, false, NULL);
896 SET_FOREACH(other, u->meta.dependencies[UNIT_CONFLICTS], i)
897 if (!UNIT_IS_ACTIVE_OR_ACTIVATING(unit_active_state(other)))
898 manager_add_job(u->meta.manager, JOB_STOP, other, JOB_REPLACE, true, NULL);
901 static void retroactively_stop_dependencies(Unit *u) {
906 assert(UNIT_IS_INACTIVE_OR_DEACTIVATING(unit_active_state(u)));
908 if (u->meta.recursive_stop) {
909 /* Pull down units need us recursively if enabled */
910 SET_FOREACH(other, u->meta.dependencies[UNIT_REQUIRED_BY], i)
911 if (!UNIT_IS_INACTIVE_OR_DEACTIVATING(unit_active_state(other)))
912 manager_add_job(u->meta.manager, JOB_STOP, other, JOB_REPLACE, true, NULL);
915 /* Garbage collect services that might not be needed anymore, if enabled */
916 SET_FOREACH(other, u->meta.dependencies[UNIT_REQUIRES], i)
917 if (!UNIT_IS_INACTIVE_OR_DEACTIVATING(unit_active_state(other)))
918 unit_check_uneeded(other);
919 SET_FOREACH(other, u->meta.dependencies[UNIT_REQUIRES_OVERRIDABLE], i)
920 if (!UNIT_IS_INACTIVE_OR_DEACTIVATING(unit_active_state(other)))
921 unit_check_uneeded(other);
922 SET_FOREACH(other, u->meta.dependencies[UNIT_WANTS], i)
923 if (!UNIT_IS_INACTIVE_OR_DEACTIVATING(unit_active_state(other)))
924 unit_check_uneeded(other);
925 SET_FOREACH(other, u->meta.dependencies[UNIT_REQUISITE], i)
926 if (!UNIT_IS_INACTIVE_OR_DEACTIVATING(unit_active_state(other)))
927 unit_check_uneeded(other);
928 SET_FOREACH(other, u->meta.dependencies[UNIT_REQUISITE_OVERRIDABLE], i)
929 if (!UNIT_IS_INACTIVE_OR_DEACTIVATING(unit_active_state(other)))
930 unit_check_uneeded(other);
933 void unit_notify(Unit *u, UnitActiveState os, UnitActiveState ns) {
934 bool unexpected = false;
938 assert(os < _UNIT_ACTIVE_STATE_MAX);
939 assert(ns < _UNIT_ACTIVE_STATE_MAX);
941 /* Note that this is called for all low-level state changes,
942 * even if they might map to the same high-level
943 * UnitActiveState! That means that ns == os is OK an expected
944 * behaviour here. For example: if a mount point is remounted
945 * this function will be called too and the utmp code below
950 if (os == UNIT_INACTIVE && ns != UNIT_INACTIVE)
951 u->meta.inactive_exit_timestamp = ts;
952 else if (os != UNIT_INACTIVE && ns == UNIT_INACTIVE)
953 u->meta.inactive_enter_timestamp = ts;
955 if (!UNIT_IS_ACTIVE_OR_RELOADING(os) && UNIT_IS_ACTIVE_OR_RELOADING(ns))
956 u->meta.active_enter_timestamp = ts;
957 else if (UNIT_IS_ACTIVE_OR_RELOADING(os) && !UNIT_IS_ACTIVE_OR_RELOADING(ns))
958 u->meta.active_exit_timestamp = ts;
960 timer_unit_notify(u, ns);
961 path_unit_notify(u, ns);
965 if (u->meta.job->state == JOB_WAITING)
967 /* So we reached a different state for this
968 * job. Let's see if we can run it now if it
969 * failed previously due to EAGAIN. */
970 job_add_to_run_queue(u->meta.job);
973 assert(u->meta.job->state == JOB_RUNNING);
975 /* Let's check whether this state change
976 * constitutes a finished job, or maybe
977 * cotradicts a running job and hence needs to
978 * invalidate jobs. */
980 switch (u->meta.job->type) {
983 case JOB_VERIFY_ACTIVE:
985 if (UNIT_IS_ACTIVE_OR_RELOADING(ns))
986 job_finish_and_invalidate(u->meta.job, true);
987 else if (ns != UNIT_ACTIVATING) {
989 job_finish_and_invalidate(u->meta.job, false);
995 case JOB_RELOAD_OR_START:
997 if (ns == UNIT_ACTIVE)
998 job_finish_and_invalidate(u->meta.job, true);
999 else if (ns != UNIT_ACTIVATING && ns != UNIT_ACTIVE_RELOADING) {
1001 job_finish_and_invalidate(u->meta.job, false);
1008 case JOB_TRY_RESTART:
1010 if (ns == UNIT_INACTIVE)
1011 job_finish_and_invalidate(u->meta.job, true);
1012 else if (ns != UNIT_DEACTIVATING) {
1014 job_finish_and_invalidate(u->meta.job, false);
1020 assert_not_reached("Job type unknown");
1025 /* If this state change happened without being requested by a
1026 * job, then let's retroactively start or stop dependencies */
1029 if (UNIT_IS_INACTIVE_OR_DEACTIVATING(os) && UNIT_IS_ACTIVE_OR_ACTIVATING(ns))
1030 retroactively_start_dependencies(u);
1031 else if (UNIT_IS_ACTIVE_OR_ACTIVATING(os) && UNIT_IS_INACTIVE_OR_DEACTIVATING(ns))
1032 retroactively_stop_dependencies(u);
1035 /* Some names are special */
1036 if (UNIT_IS_ACTIVE_OR_RELOADING(ns)) {
1037 if (unit_has_name(u, SPECIAL_DBUS_SERVICE)) {
1038 /* The bus just might have become available,
1039 * hence try to connect to it, if we aren't
1041 bus_init_system(u->meta.manager);
1042 bus_init_api(u->meta.manager);
1045 if (unit_has_name(u, SPECIAL_SYSLOG_SERVICE))
1046 /* The syslog daemon just might have become
1047 * available, hence try to connect to it, if
1048 * we aren't yet connected. */
1051 if (u->meta.type == UNIT_MOUNT)
1052 /* Another directory became available, let's
1053 * check if that is enough to write our utmp
1055 manager_write_utmp_reboot(u->meta.manager);
1057 if (u->meta.type == UNIT_TARGET)
1058 /* A target got activated, maybe this is a runlevel? */
1059 manager_write_utmp_runlevel(u->meta.manager, u);
1061 } else if (!UNIT_IS_ACTIVE_OR_RELOADING(ns)) {
1063 if (unit_has_name(u, SPECIAL_SYSLOG_SERVICE))
1064 /* The syslog daemon might just have
1065 * terminated, hence try to disconnect from
1069 /* We don't care about D-Bus here, since we'll get an
1070 * asynchronous notification for it anyway. */
1073 /* Maybe we finished startup and are now ready for being
1074 * stopped because unneeded? */
1075 unit_check_uneeded(u);
1077 unit_add_to_dbus_queue(u);
1078 unit_add_to_gc_queue(u);
1081 int unit_watch_fd(Unit *u, int fd, uint32_t events, Watch *w) {
1082 struct epoll_event ev;
1087 assert(w->type == WATCH_INVALID || (w->type == WATCH_FD && w->fd == fd && w->data.unit == u));
1093 if (epoll_ctl(u->meta.manager->epoll_fd,
1094 w->type == WATCH_INVALID ? EPOLL_CTL_ADD : EPOLL_CTL_MOD,
1106 void unit_unwatch_fd(Unit *u, Watch *w) {
1110 if (w->type == WATCH_INVALID)
1113 assert(w->type == WATCH_FD);
1114 assert(w->data.unit == u);
1115 assert_se(epoll_ctl(u->meta.manager->epoll_fd, EPOLL_CTL_DEL, w->fd, NULL) >= 0);
1118 w->type = WATCH_INVALID;
1119 w->data.unit = NULL;
1122 int unit_watch_pid(Unit *u, pid_t pid) {
1126 /* Watch a specific PID. We only support one unit watching
1127 * each PID for now. */
1129 return hashmap_put(u->meta.manager->watch_pids, UINT32_TO_PTR(pid), u);
1132 void unit_unwatch_pid(Unit *u, pid_t pid) {
1136 hashmap_remove_value(u->meta.manager->watch_pids, UINT32_TO_PTR(pid), u);
1139 int unit_watch_timer(Unit *u, usec_t delay, Watch *w) {
1140 struct itimerspec its;
1146 assert(w->type == WATCH_INVALID || (w->type == WATCH_TIMER && w->data.unit == u));
1148 /* This will try to reuse the old timer if there is one */
1150 if (w->type == WATCH_TIMER) {
1155 if ((fd = timerfd_create(CLOCK_MONOTONIC, TFD_NONBLOCK|TFD_CLOEXEC)) < 0)
1162 /* Set absolute time in the past, but not 0, since we
1163 * don't want to disarm the timer */
1164 its.it_value.tv_sec = 0;
1165 its.it_value.tv_nsec = 1;
1167 flags = TFD_TIMER_ABSTIME;
1169 timespec_store(&its.it_value, delay);
1173 /* This will also flush the elapse counter */
1174 if (timerfd_settime(fd, flags, &its, NULL) < 0)
1177 if (w->type == WATCH_INVALID) {
1178 struct epoll_event ev;
1182 ev.events = EPOLLIN;
1184 if (epoll_ctl(u->meta.manager->epoll_fd, EPOLL_CTL_ADD, fd, &ev) < 0)
1189 w->type = WATCH_TIMER;
1196 close_nointr_nofail(fd);
1201 void unit_unwatch_timer(Unit *u, Watch *w) {
1205 if (w->type == WATCH_INVALID)
1208 assert(w->type == WATCH_TIMER && w->data.unit == u);
1210 assert_se(epoll_ctl(u->meta.manager->epoll_fd, EPOLL_CTL_DEL, w->fd, NULL) >= 0);
1211 close_nointr_nofail(w->fd);
1214 w->type = WATCH_INVALID;
1215 w->data.unit = NULL;
1218 bool unit_job_is_applicable(Unit *u, JobType j) {
1220 assert(j >= 0 && j < _JOB_TYPE_MAX);
1224 case JOB_VERIFY_ACTIVE:
1230 case JOB_TRY_RESTART:
1231 return unit_can_start(u);
1234 return unit_can_reload(u);
1236 case JOB_RELOAD_OR_START:
1237 return unit_can_reload(u) && unit_can_start(u);
1240 assert_not_reached("Invalid job type");
1244 int unit_add_dependency(Unit *u, UnitDependency d, Unit *other, bool add_reference) {
1246 static const UnitDependency inverse_table[_UNIT_DEPENDENCY_MAX] = {
1247 [UNIT_REQUIRES] = UNIT_REQUIRED_BY,
1248 [UNIT_REQUIRES_OVERRIDABLE] = UNIT_REQUIRED_BY_OVERRIDABLE,
1249 [UNIT_WANTS] = UNIT_WANTED_BY,
1250 [UNIT_REQUISITE] = UNIT_REQUIRED_BY,
1251 [UNIT_REQUISITE_OVERRIDABLE] = UNIT_REQUIRED_BY_OVERRIDABLE,
1252 [UNIT_REQUIRED_BY] = _UNIT_DEPENDENCY_INVALID,
1253 [UNIT_REQUIRED_BY_OVERRIDABLE] = _UNIT_DEPENDENCY_INVALID,
1254 [UNIT_WANTED_BY] = _UNIT_DEPENDENCY_INVALID,
1255 [UNIT_CONFLICTS] = UNIT_CONFLICTS,
1256 [UNIT_BEFORE] = UNIT_AFTER,
1257 [UNIT_AFTER] = UNIT_BEFORE,
1258 [UNIT_REFERENCES] = UNIT_REFERENCED_BY,
1259 [UNIT_REFERENCED_BY] = UNIT_REFERENCES
1261 int r, q = 0, v = 0, w = 0;
1264 assert(d >= 0 && d < _UNIT_DEPENDENCY_MAX);
1265 assert(inverse_table[d] != _UNIT_DEPENDENCY_INVALID);
1268 /* We won't allow dependencies on ourselves. We will not
1269 * consider them an error however. */
1273 if (UNIT_VTABLE(u)->no_requires &&
1274 (d == UNIT_REQUIRES ||
1275 d == UNIT_REQUIRES_OVERRIDABLE ||
1276 d == UNIT_REQUISITE ||
1277 d == UNIT_REQUISITE_OVERRIDABLE)) {
1281 if ((r = set_ensure_allocated(&u->meta.dependencies[d], trivial_hash_func, trivial_compare_func)) < 0 ||
1282 (r = set_ensure_allocated(&other->meta.dependencies[inverse_table[d]], trivial_hash_func, trivial_compare_func)) < 0)
1286 if ((r = set_ensure_allocated(&u->meta.dependencies[UNIT_REFERENCES], trivial_hash_func, trivial_compare_func)) < 0 ||
1287 (r = set_ensure_allocated(&other->meta.dependencies[UNIT_REFERENCED_BY], trivial_hash_func, trivial_compare_func)) < 0)
1290 if ((q = set_put(u->meta.dependencies[d], other)) < 0)
1293 if ((v = set_put(other->meta.dependencies[inverse_table[d]], u)) < 0) {
1298 if (add_reference) {
1299 if ((w = set_put(u->meta.dependencies[UNIT_REFERENCES], other)) < 0) {
1304 if ((r = set_put(other->meta.dependencies[UNIT_REFERENCED_BY], u)) < 0)
1308 unit_add_to_dbus_queue(u);
1313 set_remove(u->meta.dependencies[d], other);
1316 set_remove(other->meta.dependencies[inverse_table[d]], u);
1319 set_remove(u->meta.dependencies[UNIT_REFERENCES], other);
1324 static const char *resolve_template(Unit *u, const char *name, const char*path, char **p) {
1328 assert(name || path);
1331 name = file_name_from_path(path);
1333 if (!unit_name_is_template(name)) {
1338 if (u->meta.instance)
1339 s = unit_name_replace_instance(name, u->meta.instance);
1343 if (!(i = unit_name_to_prefix(u->meta.id)))
1346 s = unit_name_replace_instance(name, i);
1357 int unit_add_dependency_by_name(Unit *u, UnitDependency d, const char *name, const char *path, bool add_reference) {
1363 assert(name || path);
1365 if (!(name = resolve_template(u, name, path, &s)))
1368 if ((r = manager_load_unit(u->meta.manager, name, path, &other)) < 0)
1371 r = unit_add_dependency(u, d, other, add_reference);
1378 int unit_add_dependency_by_name_inverse(Unit *u, UnitDependency d, const char *name, const char *path, bool add_reference) {
1384 assert(name || path);
1386 if (!(name = resolve_template(u, name, path, &s)))
1389 if ((r = manager_load_unit(u->meta.manager, name, path, &other)) < 0)
1392 r = unit_add_dependency(other, d, u, add_reference);
1399 int set_unit_path(const char *p) {
1403 /* This is mostly for debug purposes */
1405 if (path_is_absolute(p)) {
1406 if (!(c = strdup(p)))
1409 if (!(cwd = get_current_dir_name()))
1412 r = asprintf(&c, "%s/%s", cwd, p);
1419 if (setenv("SYSTEMD_UNIT_PATH", c, 0) < 0) {
1428 char *unit_dbus_path(Unit *u) {
1433 if (!(e = bus_path_escape(u->meta.id)))
1436 if (asprintf(&p, "/org/freedesktop/systemd1/unit/%s", e) < 0) {
1445 int unit_add_cgroup(Unit *u, CGroupBonding *b) {
1453 /* Ensure this hasn't been added yet */
1456 l = hashmap_get(u->meta.manager->cgroup_bondings, b->path);
1457 LIST_PREPEND(CGroupBonding, by_path, l, b);
1459 if ((r = hashmap_replace(u->meta.manager->cgroup_bondings, b->path, l)) < 0) {
1460 LIST_REMOVE(CGroupBonding, by_path, l, b);
1464 LIST_PREPEND(CGroupBonding, by_unit, u->meta.cgroup_bondings, b);
1470 static char *default_cgroup_path(Unit *u) {
1476 if (u->meta.instance) {
1479 if (!(t = unit_name_template(u->meta.id)))
1482 r = asprintf(&p, "%s/%s/%s", u->meta.manager->cgroup_hierarchy, t, u->meta.instance);
1485 r = asprintf(&p, "%s/%s", u->meta.manager->cgroup_hierarchy, u->meta.id);
1487 return r < 0 ? NULL : p;
1490 int unit_add_cgroup_from_text(Unit *u, const char *name) {
1492 char *controller = NULL, *path = NULL;
1493 CGroupBonding *b = NULL;
1499 /* Detect controller name */
1500 n = strcspn(name, ":");
1503 (name[n] == ':' && name[n+1] == 0)) {
1505 /* Only controller name, no path? */
1507 if (!(path = default_cgroup_path(u)))
1513 /* Controller name, and path. */
1516 if (!path_is_absolute(p))
1519 if (!(path = strdup(p)))
1524 controller = strndup(name, n);
1526 controller = strdup(u->meta.manager->cgroup_controller);
1533 if (cgroup_bonding_find_list(u->meta.cgroup_bondings, controller)) {
1538 if (!(b = new0(CGroupBonding, 1))) {
1543 b->controller = controller;
1546 b->clean_up = false;
1548 if ((r = unit_add_cgroup(u, b)) < 0)
1561 int unit_add_default_cgroup(Unit *u) {
1567 /* Adds in the default cgroup data, if it wasn't specified yet */
1569 if (unit_get_default_cgroup(u))
1572 if (!(b = new0(CGroupBonding, 1)))
1575 if (!(b->controller = strdup(u->meta.manager->cgroup_controller)))
1578 if (!(b->path = default_cgroup_path(u)))
1584 if ((r = unit_add_cgroup(u, b)) < 0)
1591 free(b->controller);
1597 CGroupBonding* unit_get_default_cgroup(Unit *u) {
1600 return cgroup_bonding_find_list(u->meta.cgroup_bondings, u->meta.manager->cgroup_controller);
1603 int unit_load_related_unit(Unit *u, const char *type, Unit **_found) {
1611 if (!(t = unit_name_change_suffix(u->meta.id, type)))
1614 assert(!unit_has_name(u, t));
1616 r = manager_load_unit(u->meta.manager, t, NULL, _found);
1619 assert(r < 0 || *_found != u);
1624 int unit_get_related_unit(Unit *u, const char *type, Unit **_found) {
1632 if (!(t = unit_name_change_suffix(u->meta.id, type)))
1635 assert(!unit_has_name(u, t));
1637 found = manager_get_unit(u->meta.manager, t);
1647 static char *specifier_prefix_and_instance(char specifier, void *data, void *userdata) {
1651 return unit_name_to_prefix_and_instance(u->meta.id);
1654 static char *specifier_prefix(char specifier, void *data, void *userdata) {
1658 return unit_name_to_prefix(u->meta.id);
1661 static char *specifier_prefix_unescaped(char specifier, void *data, void *userdata) {
1667 if (!(p = unit_name_to_prefix(u->meta.id)))
1670 r = unit_name_unescape(p);
1676 static char *specifier_instance_unescaped(char specifier, void *data, void *userdata) {
1680 if (u->meta.instance)
1681 return unit_name_unescape(u->meta.instance);
1686 char *unit_name_printf(Unit *u, const char* format) {
1689 * This will use the passed string as format string and
1690 * replace the following specifiers:
1692 * %n: the full id of the unit (foo@bar.waldo)
1693 * %N: the id of the unit without the suffix (foo@bar)
1694 * %p: the prefix (foo)
1695 * %i: the instance (bar)
1698 const Specifier table[] = {
1699 { 'n', specifier_string, u->meta.id },
1700 { 'N', specifier_prefix_and_instance, NULL },
1701 { 'p', specifier_prefix, NULL },
1702 { 'i', specifier_string, u->meta.instance },
1709 return specifier_printf(format, table, u);
1712 char *unit_full_printf(Unit *u, const char *format) {
1714 /* This is similar to unit_name_printf() but also supports
1717 const Specifier table[] = {
1718 { 'n', specifier_string, u->meta.id },
1719 { 'N', specifier_prefix_and_instance, NULL },
1720 { 'p', specifier_prefix, NULL },
1721 { 'P', specifier_prefix_unescaped, NULL },
1722 { 'i', specifier_string, u->meta.instance },
1723 { 'I', specifier_instance_unescaped, NULL },
1730 return specifier_printf(format, table, u);
1733 char **unit_full_printf_strv(Unit *u, char **l) {
1737 /* Applies unit_full_printf to every entry in l */
1742 if (!(r = new(char*, n+1)))
1745 for (i = l, j = r; *i; i++, j++)
1746 if (!(*j = unit_full_printf(u, *i)))
1762 int unit_watch_bus_name(Unit *u, const char *name) {
1766 /* Watch a specific name on the bus. We only support one unit
1767 * watching each name for now. */
1769 return hashmap_put(u->meta.manager->watch_bus, name, u);
1772 void unit_unwatch_bus_name(Unit *u, const char *name) {
1776 hashmap_remove_value(u->meta.manager->watch_bus, name, u);
1779 bool unit_can_serialize(Unit *u) {
1782 return UNIT_VTABLE(u)->serialize && UNIT_VTABLE(u)->deserialize_item;
1785 int unit_serialize(Unit *u, FILE *f, FDSet *fds) {
1792 if (!unit_can_serialize(u))
1795 if ((r = UNIT_VTABLE(u)->serialize(u, f, fds)) < 0)
1799 unit_serialize_item(u, f, "job", job_type_to_string(u->meta.job->type));
1806 void unit_serialize_item_format(Unit *u, FILE *f, const char *key, const char *format, ...) {
1817 va_start(ap, format);
1818 vfprintf(f, format, ap);
1824 void unit_serialize_item(Unit *u, FILE *f, const char *key, const char *value) {
1830 fprintf(f, "%s=%s\n", key, value);
1833 int unit_deserialize(Unit *u, FILE *f, FDSet *fds) {
1840 if (!unit_can_serialize(u))
1844 char line[1024], *l, *v;
1847 if (!fgets(line, sizeof(line), f)) {
1859 k = strcspn(l, "=");
1867 if (streq(l, "job")) {
1870 if ((type = job_type_from_string(v)) < 0)
1871 log_debug("Failed to parse job type value %s", v);
1873 u->meta.deserialized_job = type;
1878 if ((r = UNIT_VTABLE(u)->deserialize_item(u, l, v, fds)) < 0)
1883 int unit_add_node_link(Unit *u, const char *what, bool wants) {
1893 /* Adds in links to the device node that this unit is based on */
1895 if (!is_device_path(what))
1898 if (!(e = unit_name_build_escape(what+1, NULL, ".device")))
1901 r = manager_load_unit(u->meta.manager, e, NULL, &device);
1907 if ((r = unit_add_dependency(u, UNIT_AFTER, device, true)) < 0)
1910 if ((r = unit_add_dependency(u, UNIT_REQUIRES, device, true)) < 0)
1914 if ((r = unit_add_dependency(device, UNIT_WANTS, u, false)) < 0)
1920 int unit_coldplug(Unit *u) {
1925 if (UNIT_VTABLE(u)->coldplug)
1926 if ((r = UNIT_VTABLE(u)->coldplug(u)) < 0)
1929 if (u->meta.deserialized_job >= 0) {
1930 if ((r = manager_add_job(u->meta.manager, u->meta.deserialized_job, u, JOB_FAIL, false, NULL)) < 0)
1933 u->meta.deserialized_job = _JOB_TYPE_INVALID;
1939 static const char* const unit_type_table[_UNIT_TYPE_MAX] = {
1940 [UNIT_SERVICE] = "service",
1941 [UNIT_TIMER] = "timer",
1942 [UNIT_SOCKET] = "socket",
1943 [UNIT_TARGET] = "target",
1944 [UNIT_DEVICE] = "device",
1945 [UNIT_MOUNT] = "mount",
1946 [UNIT_AUTOMOUNT] = "automount",
1947 [UNIT_SNAPSHOT] = "snapshot",
1948 [UNIT_SWAP] = "swap"
1951 DEFINE_STRING_TABLE_LOOKUP(unit_type, UnitType);
1953 static const char* const unit_load_state_table[_UNIT_LOAD_STATE_MAX] = {
1954 [UNIT_STUB] = "stub",
1955 [UNIT_LOADED] = "loaded",
1956 [UNIT_FAILED] = "failed",
1957 [UNIT_MERGED] = "merged"
1960 DEFINE_STRING_TABLE_LOOKUP(unit_load_state, UnitLoadState);
1962 static const char* const unit_active_state_table[_UNIT_ACTIVE_STATE_MAX] = {
1963 [UNIT_ACTIVE] = "active",
1964 [UNIT_INACTIVE] = "inactive",
1965 [UNIT_ACTIVATING] = "activating",
1966 [UNIT_DEACTIVATING] = "deactivating"
1969 DEFINE_STRING_TABLE_LOOKUP(unit_active_state, UnitActiveState);
1971 static const char* const unit_dependency_table[_UNIT_DEPENDENCY_MAX] = {
1972 [UNIT_REQUIRES] = "Requires",
1973 [UNIT_REQUIRES_OVERRIDABLE] = "RequiresOverridable",
1974 [UNIT_WANTS] = "Wants",
1975 [UNIT_REQUISITE] = "Requisite",
1976 [UNIT_REQUISITE_OVERRIDABLE] = "RequisiteOverridable",
1977 [UNIT_REQUIRED_BY] = "RequiredBy",
1978 [UNIT_REQUIRED_BY_OVERRIDABLE] = "RequiredByOverridable",
1979 [UNIT_WANTED_BY] = "WantedBy",
1980 [UNIT_CONFLICTS] = "Conflicts",
1981 [UNIT_BEFORE] = "Before",
1982 [UNIT_AFTER] = "After",
1983 [UNIT_REFERENCES] = "References",
1984 [UNIT_REFERENCED_BY] = "ReferencedBy"
1987 DEFINE_STRING_TABLE_LOOKUP(unit_dependency, UnitDependency);
1989 static const char* const kill_mode_table[_KILL_MODE_MAX] = {
1990 [KILL_CONTROL_GROUP] = "control-group",
1991 [KILL_PROCESS_GROUP] = "process-group",
1992 [KILL_PROCESS] = "process",
1993 [KILL_NONE] = "none"
1996 DEFINE_STRING_TABLE_LOOKUP(kill_mode, KillMode);