1 /*-*- Mode: C; c-basic-offset: 8 -*-*/
7 #include <sys/timerfd.h>
14 #include "load-fragment.h"
15 #include "load-dropin.h"
18 const NameVTable * const name_vtable[_NAME_TYPE_MAX] = {
19 [NAME_SERVICE] = &service_vtable,
20 [NAME_TIMER] = &timer_vtable,
21 [NAME_SOCKET] = &socket_vtable,
22 [NAME_TARGET] = &target_vtable,
23 [NAME_DEVICE] = &device_vtable,
24 [NAME_MOUNT] = &mount_vtable,
25 [NAME_AUTOMOUNT] = &automount_vtable,
26 [NAME_SNAPSHOT] = &snapshot_vtable
29 NameType name_type_from_string(const char *n) {
34 for (t = 0; t < _NAME_TYPE_MAX; t++)
35 if (endswith(n, name_vtable[t]->suffix))
38 return _NAME_TYPE_INVALID;
43 "abcdefghijklmnopqrstuvwxyz" \
44 "ABCDEFGHIJKLMNOPQRSTUVWXYZ" \
47 bool name_is_valid(const char *n) {
53 if (strlen(n) >= NAME_MAX)
56 t = name_type_from_string(n);
57 if (t < 0 || t >= _NAME_TYPE_MAX)
60 if (!(e = strrchr(n, '.')))
63 for (i = n; i < e; i++)
64 if (!strchr(VALID_CHARS, *i))
70 Name *name_new(Manager *m) {
75 if (!(n = new0(Name, 1)))
78 if (!(n->meta.names = set_new(string_hash_func, string_compare_func))) {
84 n->meta.type = _NAME_TYPE_INVALID;
89 int name_add_name(Name *n, const char *text) {
97 if ((t = name_type_from_string(text)) == _NAME_TYPE_INVALID)
100 if (n->meta.type != _NAME_TYPE_INVALID && t != n->meta.type)
103 if (!(s = strdup(text)))
106 if ((r = set_put(n->meta.names, s)) < 0) {
111 if ((r = hashmap_put(n->meta.manager->names, s, n)) < 0) {
112 set_remove(n->meta.names, s);
125 void name_add_to_load_queue(Name *n) {
128 if (n->meta.load_state != NAME_STUB || n->meta.in_load_queue)
131 LIST_PREPEND(Meta, load_queue, n->meta.manager->load_queue, &n->meta);
132 n->meta.in_load_queue = true;
135 static void bidi_set_free(Name *name, Set *s) {
141 /* Frees the set and makes sure we are dropped from the
142 * inverse pointers */
144 SET_FOREACH(other, s, i) {
147 for (d = 0; d < _NAME_DEPENDENCY_MAX; d++)
148 set_remove(other->meta.dependencies[d], name);
154 void name_free(Name *name) {
161 /* Detach from next 'bigger' objects */
163 SET_FOREACH(t, name->meta.names, i)
164 hashmap_remove_value(name->meta.manager->names, t, name);
166 if (name->meta.in_load_queue)
167 LIST_REMOVE(Meta, load_queue, name->meta.manager->load_queue, &name->meta);
169 if (name->meta.load_state == NAME_LOADED)
170 if (NAME_VTABLE(name)->done)
171 NAME_VTABLE(name)->done(name);
173 /* Free data and next 'smaller' objects */
175 job_free(name->meta.job);
177 for (d = 0; d < _NAME_DEPENDENCY_MAX; d++)
178 bidi_set_free(name, name->meta.dependencies[d]);
180 free(name->meta.description);
182 while ((t = set_steal_first(name->meta.names)))
184 set_free(name->meta.names);
189 NameActiveState name_active_state(Name *name) {
192 if (name->meta.load_state != NAME_LOADED)
193 return NAME_INACTIVE;
195 return NAME_VTABLE(name)->active_state(name);
198 static int ensure_merge(Set **s, Set *other) {
204 return set_merge(*s, other);
206 if (!(*s = set_copy(other)))
212 /* FIXME: Does not rollback on failure! */
213 int name_merge(Name *name, Name *other) {
219 assert(name->meta.manager == other->meta.manager);
221 /* This merges 'other' into 'name'. FIXME: This does not
222 * rollback on failure. */
224 if (name->meta.type != other->meta.type)
227 if (other->meta.load_state != NAME_STUB)
231 if ((r = ensure_merge(&name->meta.names, other->meta.names)) < 0)
234 /* Merge dependencies */
235 for (d = 0; d < _NAME_DEPENDENCY_MAX; d++)
236 /* fixme, the inverse mapping is missing */
237 if ((r = ensure_merge(&name->meta.dependencies[d], other->meta.dependencies[d])) < 0)
243 const char* name_id(Name *n) {
249 return set_first(n->meta.names);
252 const char *name_description(Name *n) {
255 if (n->meta.description)
256 return n->meta.description;
261 void name_dump(Name *n, FILE *f, const char *prefix) {
263 static const char* const load_state_table[_NAME_LOAD_STATE_MAX] = {
264 [NAME_STUB] = "stub",
265 [NAME_LOADED] = "loaded",
266 [NAME_FAILED] = "failed"
269 static const char* const active_state_table[_NAME_ACTIVE_STATE_MAX] = {
270 [NAME_ACTIVE] = "active",
271 [NAME_INACTIVE] = "inactive",
272 [NAME_ACTIVATING] = "activating",
273 [NAME_DEACTIVATING] = "deactivating"
276 static const char* const dependency_table[_NAME_DEPENDENCY_MAX] = {
277 [NAME_REQUIRES] = "Requires",
278 [NAME_SOFT_REQUIRES] = "SoftRequires",
279 [NAME_WANTS] = "Wants",
280 [NAME_REQUISITE] = "Requisite",
281 [NAME_SOFT_REQUISITE] = "SoftRequisite",
282 [NAME_REQUIRED_BY] = "RequiredBy",
283 [NAME_SOFT_REQUIRED_BY] = "SoftRequiredBy",
284 [NAME_WANTED_BY] = "WantedBy",
285 [NAME_CONFLICTS] = "Conflicts",
286 [NAME_BEFORE] = "Before",
287 [NAME_AFTER] = "After",
299 prefix2 = strappend(prefix, "\t");
305 "%s\tDescription: %s\n"
306 "%s\tName Load State: %s\n"
307 "%s\tName Active State: %s\n",
309 prefix, name_description(n),
310 prefix, load_state_table[n->meta.load_state],
311 prefix, active_state_table[name_active_state(n)]);
313 SET_FOREACH(t, n->meta.names, i)
314 fprintf(f, "%s\tName: %s\n", prefix, t);
316 for (d = 0; d < _NAME_DEPENDENCY_MAX; d++) {
319 if (set_isempty(n->meta.dependencies[d]))
322 SET_FOREACH(other, n->meta.dependencies[d], i)
323 fprintf(f, "%s\t%s: %s\n", prefix, dependency_table[d], name_id(other));
326 if (NAME_VTABLE(n)->dump)
327 NAME_VTABLE(n)->dump(n, f, prefix2);
330 job_dump(n->meta.job, f, prefix2);
335 static int verify_type(Name *name) {
341 /* Checks that all aliases of this name have the same and valid type */
343 SET_FOREACH(n, name->meta.names, i) {
346 if ((t = name_type_from_string(n)) == _NAME_TYPE_INVALID)
349 if (name->meta.type == _NAME_TYPE_INVALID) {
354 if (name->meta.type != t)
358 if (name->meta.type == _NAME_TYPE_INVALID)
364 /* Common implementation for multiple backends */
365 int name_load_fragment_and_dropin(Name *n) {
370 /* Load a .socket file */
371 if ((r = name_load_fragment(n)) < 0)
374 /* Load drop-in directory data */
375 if ((r = name_load_dropin(n)) < 0)
381 int name_load(Name *name) {
386 if (name->meta.in_load_queue) {
387 LIST_REMOVE(Meta, load_queue, name->meta.manager->load_queue, &name->meta);
388 name->meta.in_load_queue = false;
391 if (name->meta.load_state != NAME_STUB)
394 if ((r = verify_type(name)) < 0)
397 if (NAME_VTABLE(name)->init)
398 if ((r = NAME_VTABLE(name)->init(name)) < 0)
401 name->meta.load_state = NAME_LOADED;
405 name->meta.load_state = NAME_FAILED;
410 * -EBADR: This name type does not support starting.
411 * -EALREADY: Name is already started.
412 * -EAGAIN: An operation is already in progress. Retry later.
414 int name_start(Name *n) {
415 NameActiveState state;
419 if (!NAME_VTABLE(n)->start)
422 state = name_active_state(n);
423 if (NAME_IS_ACTIVE_OR_RELOADING(state))
426 /* We don't suppress calls to ->start() here when we are
427 * already starting, to allow this request to be used as a
428 * "hurry up" call, for example when the name is in some "auto
429 * restart" state where it waits for a holdoff timer to elapse
430 * before it will start again. */
432 return NAME_VTABLE(n)->start(n);
435 bool name_can_start(Name *n) {
438 return !!NAME_VTABLE(n)->start;
442 * -EBADR: This name type does not support stopping.
443 * -EALREADY: Name is already stopped.
444 * -EAGAIN: An operation is already in progress. Retry later.
446 int name_stop(Name *n) {
447 NameActiveState state;
451 if (!NAME_VTABLE(n)->stop)
454 state = name_active_state(n);
455 if (state == NAME_INACTIVE)
458 if (state == NAME_DEACTIVATING)
461 return NAME_VTABLE(n)->stop(n);
465 * -EBADR: This name type does not support reloading.
466 * -ENOEXEC: Name is not started.
467 * -EAGAIN: An operation is already in progress. Retry later.
469 int name_reload(Name *n) {
470 NameActiveState state;
474 if (!name_can_reload(n))
477 state = name_active_state(n);
478 if (name_active_state(n) == NAME_ACTIVE_RELOADING)
481 if (name_active_state(n) != NAME_ACTIVE)
484 return NAME_VTABLE(n)->reload(n);
487 bool name_can_reload(Name *n) {
490 if (!NAME_VTABLE(n)->reload)
493 if (!NAME_VTABLE(n)->can_reload)
496 return NAME_VTABLE(n)->can_reload(n);
499 static void retroactively_start_dependencies(Name *n) {
504 assert(NAME_IS_ACTIVE_OR_ACTIVATING(name_active_state(n)));
506 SET_FOREACH(other, n->meta.dependencies[NAME_REQUIRES], i)
507 if (!NAME_IS_ACTIVE_OR_ACTIVATING(name_active_state(other)))
508 manager_add_job(n->meta.manager, JOB_START, other, JOB_REPLACE, true, NULL);
510 SET_FOREACH(other, n->meta.dependencies[NAME_SOFT_REQUIRES], i)
511 if (!NAME_IS_ACTIVE_OR_ACTIVATING(name_active_state(other)))
512 manager_add_job(n->meta.manager, JOB_START, other, JOB_FAIL, false, NULL);
514 SET_FOREACH(other, n->meta.dependencies[NAME_REQUISITE], i)
515 if (!NAME_IS_ACTIVE_OR_ACTIVATING(name_active_state(other)))
516 manager_add_job(n->meta.manager, JOB_START, other, JOB_REPLACE, true, NULL);
518 SET_FOREACH(other, n->meta.dependencies[NAME_WANTS], i)
519 if (!NAME_IS_ACTIVE_OR_ACTIVATING(name_active_state(other)))
520 manager_add_job(n->meta.manager, JOB_START, other, JOB_FAIL, false, NULL);
522 SET_FOREACH(other, n->meta.dependencies[NAME_CONFLICTS], i)
523 if (!NAME_IS_ACTIVE_OR_ACTIVATING(name_active_state(other)))
524 manager_add_job(n->meta.manager, JOB_STOP, other, JOB_REPLACE, true, NULL);
527 static void retroactively_stop_dependencies(Name *n) {
532 assert(NAME_IS_INACTIVE_OR_DEACTIVATING(name_active_state(n)));
534 SET_FOREACH(other, n->meta.dependencies[NAME_REQUIRED_BY], i)
535 if (!NAME_IS_INACTIVE_OR_DEACTIVATING(name_active_state(other)))
536 manager_add_job(n->meta.manager, JOB_STOP, other, JOB_REPLACE, true, NULL);
539 void name_notify(Name *n, NameActiveState os, NameActiveState ns) {
541 assert(os < _NAME_ACTIVE_STATE_MAX);
542 assert(ns < _NAME_ACTIVE_STATE_MAX);
543 assert(!(os == NAME_ACTIVE && ns == NAME_ACTIVATING));
544 assert(!(os == NAME_INACTIVE && ns == NAME_DEACTIVATING));
549 if (!NAME_IS_ACTIVE_OR_RELOADING(os) && NAME_IS_ACTIVE_OR_RELOADING(ns))
550 n->meta.active_enter_timestamp = now(CLOCK_REALTIME);
551 else if (NAME_IS_ACTIVE_OR_RELOADING(os) && !NAME_IS_ACTIVE_OR_RELOADING(ns))
552 n->meta.active_exit_timestamp = now(CLOCK_REALTIME);
556 if (n->meta.job->state == JOB_WAITING)
558 /* So we reached a different state for this
559 * job. Let's see if we can run it now if it
560 * failed previously due to EAGAIN. */
561 job_schedule_run(n->meta.job);
564 assert(n->meta.job->state == JOB_RUNNING);
566 /* Let's check of this state change
567 * constitutes a finished job, or maybe
568 * cotradicts a running job and hence needs to
569 * invalidate jobs. */
571 switch (n->meta.job->type) {
574 case JOB_VERIFY_ACTIVE:
576 if (NAME_IS_ACTIVE_OR_RELOADING(ns)) {
577 job_finish_and_invalidate(n->meta.job, true);
579 } else if (ns == NAME_ACTIVATING)
582 job_finish_and_invalidate(n->meta.job, false);
587 case JOB_RELOAD_OR_START:
589 if (ns == NAME_ACTIVE) {
590 job_finish_and_invalidate(n->meta.job, true);
592 } else if (ns == NAME_ACTIVATING || ns == NAME_ACTIVE_RELOADING)
595 job_finish_and_invalidate(n->meta.job, false);
601 case JOB_TRY_RESTART:
603 if (ns == NAME_INACTIVE) {
604 job_finish_and_invalidate(n->meta.job, true);
606 } else if (ns == NAME_DEACTIVATING)
609 job_finish_and_invalidate(n->meta.job, false);
614 assert_not_reached("Job type unknown");
619 /* If this state change happened without being requested by a
620 * job, then let's retroactively start or stop dependencies */
622 if (NAME_IS_INACTIVE_OR_DEACTIVATING(os) && NAME_IS_ACTIVE_OR_ACTIVATING(ns))
623 retroactively_start_dependencies(n);
624 else if (NAME_IS_ACTIVE_OR_ACTIVATING(os) && NAME_IS_INACTIVE_OR_DEACTIVATING(ns))
625 retroactively_stop_dependencies(n);
628 int name_watch_fd(Name *n, int fd, uint32_t events) {
629 struct epoll_event ev;
637 ev.data.u32 = MANAGER_FD;
640 if (epoll_ctl(n->meta.manager->epoll_fd, EPOLL_CTL_ADD, fd, &ev) >= 0)
644 if (epoll_ctl(n->meta.manager->epoll_fd, EPOLL_CTL_MOD, fd, &ev) >= 0)
650 void name_unwatch_fd(Name *n, int fd) {
654 assert_se(epoll_ctl(n->meta.manager->epoll_fd, EPOLL_CTL_DEL, fd, NULL) >= 0 || errno == ENOENT);
657 int name_watch_pid(Name *n, pid_t pid) {
661 return hashmap_put(n->meta.manager->watch_pids, UINT32_TO_PTR(pid), n);
664 void name_unwatch_pid(Name *n, pid_t pid) {
668 hashmap_remove(n->meta.manager->watch_pids, UINT32_TO_PTR(pid));
671 int name_watch_timer(Name *n, usec_t delay, int *id) {
672 struct epoll_event ev;
674 struct itimerspec its;
681 /* This will try to reuse the old timer if there is one */
690 if ((fd = timerfd_create(CLOCK_MONOTONIC, TFD_NONBLOCK|TFD_CLOEXEC)) < 0)
697 /* Set absolute time in the past, but not 0, since we
698 * don't want to disarm the timer */
699 its.it_value.tv_sec = 0;
700 its.it_value.tv_nsec = 1;
702 flags = TFD_TIMER_ABSTIME;
704 timespec_store(&its.it_value, delay);
708 /* This will also flush the elapse counter */
709 if (timerfd_settime(fd, flags, &its, NULL) < 0)
715 ev.data.u32 = MANAGER_TIMER;
718 if (epoll_ctl(n->meta.manager->epoll_fd, EPOLL_CTL_ADD, fd, &ev) < 0)
726 assert_se(close_nointr(fd) == 0);
731 void name_unwatch_timer(Name *n, int *id) {
736 assert_se(epoll_ctl(n->meta.manager->epoll_fd, EPOLL_CTL_DEL, *id, NULL) >= 0);
737 assert_se(close_nointr(*id) == 0);
743 char *name_change_suffix(const char *t, const char *suffix) {
748 assert(name_is_valid(t));
751 assert_se(e = strrchr(t, '.'));
755 if (!(n = new(char, a + b + 1)))
759 memcpy(n+a, suffix, b+1);
764 bool name_job_is_applicable(Name *n, JobType j) {
766 assert(j >= 0 && j < _JOB_TYPE_MAX);
769 case JOB_VERIFY_ACTIVE:
775 case JOB_TRY_RESTART:
776 return name_can_start(n);
779 return name_can_reload(n);
781 case JOB_RELOAD_OR_START:
782 return name_can_reload(n) && name_can_start(n);
785 assert_not_reached("Invalid job type");
789 int name_add_dependency(Name *n, NameDependency d, Name *other) {
791 static const NameDependency inverse_table[_NAME_DEPENDENCY_MAX] = {
792 [NAME_REQUIRES] = NAME_REQUIRED_BY,
793 [NAME_SOFT_REQUIRES] = NAME_SOFT_REQUIRED_BY,
794 [NAME_WANTS] = NAME_WANTED_BY,
795 [NAME_REQUISITE] = NAME_REQUIRED_BY,
796 [NAME_SOFT_REQUISITE] = NAME_SOFT_REQUIRED_BY,
797 [NAME_REQUIRED_BY] = _NAME_DEPENDENCY_INVALID,
798 [NAME_SOFT_REQUIRED_BY] = _NAME_DEPENDENCY_INVALID,
799 [NAME_WANTED_BY] = _NAME_DEPENDENCY_INVALID,
800 [NAME_CONFLICTS] = NAME_CONFLICTS,
801 [NAME_BEFORE] = NAME_AFTER,
802 [NAME_AFTER] = NAME_BEFORE
807 assert(d >= 0 && d < _NAME_DEPENDENCY_MAX);
808 assert(inverse_table[d] != _NAME_DEPENDENCY_INVALID);
814 if ((r = set_ensure_allocated(&n->meta.dependencies[d], trivial_hash_func, trivial_compare_func)) < 0)
817 if ((r = set_ensure_allocated(&other->meta.dependencies[inverse_table[d]], trivial_hash_func, trivial_compare_func)) < 0)
820 if ((r = set_put(n->meta.dependencies[d], other)) < 0)
823 if ((r = set_put(other->meta.dependencies[inverse_table[d]], n)) < 0) {
824 set_remove(n->meta.dependencies[d], other);