1 /*-*- Mode: C; c-basic-offset: 8 -*-*/
12 #include "load-fragment.h"
13 #include "load-dropin.h"
15 const NameVTable * const name_vtable[_NAME_TYPE_MAX] = {
16 [NAME_SERVICE] = &service_vtable,
17 [NAME_TIMER] = &timer_vtable,
18 [NAME_SOCKET] = &socket_vtable,
19 [NAME_MILESTONE] = &milestone_vtable,
20 [NAME_DEVICE] = &device_vtable,
21 [NAME_MOUNT] = &mount_vtable,
22 [NAME_AUTOMOUNT] = &automount_vtable,
23 [NAME_SNAPSHOT] = &snapshot_vtable
26 NameType name_type_from_string(const char *n) {
31 for (t = 0; t < _NAME_TYPE_MAX; t++)
32 if (endswith(n, name_vtable[t]->suffix))
35 return _NAME_TYPE_INVALID;
40 "abcdefghijklmnopqrstuvwxyz" \
41 "ABCDEFGHIJKLMNOPQRSTUVWXYZ" \
44 bool name_is_valid(const char *n) {
50 if (strlen(n) >= NAME_MAX)
53 t = name_type_from_string(n);
54 if (t < 0 || t >= _NAME_TYPE_MAX)
57 if (!(e = strrchr(n, '.')))
60 for (i = n; i < e; i++)
61 if (!strchr(VALID_CHARS, *i))
67 Name *name_new(Manager *m) {
72 if (!(n = new0(Name, 1)))
75 if (!(n->meta.names = set_new(string_hash_func, string_compare_func))) {
80 /* Not much initialization happening here at this time */
82 n->meta.type = _NAME_TYPE_INVALID;
84 /* We don't link the name here, that is left for name_link() */
89 /* FIXME: Does not rollback on failure! */
90 int name_link_names(Name *n, bool replace) {
100 /* Link all names that aren't linked yet. */
102 SET_FOREACH(t, n->meta.names, state)
104 if ((r = hashmap_replace(n->meta.manager->names, t, n)) < 0)
107 if ((r = hashmap_put(n->meta.manager->names, t, n)) < 0)
114 int name_link(Name *n) {
118 assert(!set_isempty(n->meta.names));
119 assert(!n->meta.linked);
121 if ((r = name_sanitize(n)) < 0)
124 n->meta.linked = true;
126 if ((r = name_link_names(n, false)) < 0) {
130 /* Rollback the registered names */
131 SET_FOREACH(t, n->meta.names, state)
132 hashmap_remove_value(n->meta.manager->names, t, n);
134 n->meta.linked = false;
138 if (n->meta.load_state == NAME_STUB)
139 LIST_PREPEND(Meta, n->meta.manager->load_queue, &n->meta);
144 static void bidi_set_free(Name *name, Set *s) {
150 /* Frees the set and makes sure we are dropped from the
151 * inverse pointers */
153 SET_FOREACH(other, s, state) {
156 for (d = 0; d < _NAME_DEPENDENCY_MAX; d++)
157 set_remove(other->meta.dependencies[d], name);
163 void name_free(Name *name) {
169 /* Detach from next 'bigger' objects */
170 if (name->meta.linked) {
174 SET_FOREACH(t, name->meta.names, state)
175 hashmap_remove_value(name->meta.manager->names, t, name);
177 if (name->meta.load_state == NAME_STUB)
178 LIST_REMOVE(Meta, name->meta.manager->load_queue, &name->meta);
181 /* Free data and next 'smaller' objects */
183 job_free(name->meta.job);
185 for (d = 0; d < _NAME_DEPENDENCY_MAX; d++)
186 bidi_set_free(name, name->meta.dependencies[d]);
188 if (NAME_VTABLE(name)->free_hook)
189 NAME_VTABLE(name)->free_hook(name);
191 free(name->meta.description);
193 while ((t = set_steal_first(name->meta.names)))
195 set_free(name->meta.names);
200 NameActiveState name_active_state(Name *name) {
203 if (name->meta.load_state != NAME_LOADED)
204 return NAME_INACTIVE;
206 return NAME_VTABLE(name)->active_state(name);
209 static int ensure_in_set(Set **s, void *data) {
216 if (!(*s = set_new(trivial_hash_func, trivial_compare_func)))
219 if ((r = set_put(*s, data)) < 0)
226 static int ensure_merge(Set **s, Set *other) {
232 return set_merge(*s, other);
234 if (!(*s = set_copy(other)))
240 /* FIXME: Does not rollback on failure! */
241 int name_merge(Name *name, Name *other) {
247 assert(name->meta.manager == other->meta.manager);
249 /* This merges 'other' into 'name'. FIXME: This does not
250 * rollback on failure. */
252 if (name->meta.type != other->meta.type)
255 if (other->meta.load_state != NAME_STUB)
259 if ((r = ensure_merge(&name->meta.names, other->meta.names)) < 0)
262 /* Merge dependencies */
263 for (d = 0; d < _NAME_DEPENDENCY_MAX; d++)
264 if ((r = ensure_merge(&name->meta.dependencies[d], other->meta.dependencies[d])) < 0)
267 /* Hookup new deps and names */
268 if (name->meta.linked) {
269 if ((r = name_sanitize(name)) < 0)
272 if ((r = name_link_names(name, true)) < 0)
279 /* FIXME: Does not rollback on failure! */
280 static int augment(Name *n) {
287 /* Adds in the missing links to make all dependencies
290 SET_FOREACH(other, n->meta.dependencies[NAME_BEFORE], state)
291 if ((r = ensure_in_set(&other->meta.dependencies[NAME_AFTER], n)) < 0)
293 SET_FOREACH(other, n->meta.dependencies[NAME_AFTER], state)
294 if ((r = ensure_in_set(&other->meta.dependencies[NAME_BEFORE], n)) < 0)
297 SET_FOREACH(other, n->meta.dependencies[NAME_CONFLICTS], state)
298 if ((r = ensure_in_set(&other->meta.dependencies[NAME_CONFLICTS], n)) < 0)
301 SET_FOREACH(other, n->meta.dependencies[NAME_REQUIRES], state)
302 if ((r = ensure_in_set(&other->meta.dependencies[NAME_REQUIRED_BY], n)) < 0)
304 SET_FOREACH(other, n->meta.dependencies[NAME_REQUISITE], state)
305 if ((r = ensure_in_set(&other->meta.dependencies[NAME_REQUIRED_BY], n)) < 0)
308 SET_FOREACH(other, n->meta.dependencies[NAME_SOFT_REQUIRES], state)
309 if ((r = ensure_in_set(&other->meta.dependencies[NAME_SOFT_REQUIRED_BY], n)) < 0)
312 SET_FOREACH(other, n->meta.dependencies[NAME_WANTS], state)
313 if ((r = ensure_in_set(&other->meta.dependencies[NAME_WANTED_BY], n)) < 0)
319 int name_sanitize(Name *n) {
325 for (d = 0; d < _NAME_DEPENDENCY_MAX; d++)
326 set_remove(n->meta.dependencies[d], n);
331 const char* name_id(Name *n) {
334 return set_first(n->meta.names);
337 const char *name_description(Name *n) {
340 if (n->meta.description)
341 return n->meta.description;
346 void name_dump(Name *n, FILE *f, const char *prefix) {
348 static const char* const load_state_table[_NAME_LOAD_STATE_MAX] = {
349 [NAME_STUB] = "stub",
350 [NAME_LOADED] = "loaded",
351 [NAME_FAILED] = "failed"
354 static const char* const active_state_table[_NAME_ACTIVE_STATE_MAX] = {
355 [NAME_ACTIVE] = "active",
356 [NAME_INACTIVE] = "inactive",
357 [NAME_ACTIVATING] = "activating",
358 [NAME_DEACTIVATING] = "deactivating"
361 static const char* const dependency_table[_NAME_DEPENDENCY_MAX] = {
362 [NAME_REQUIRES] = "Requires",
363 [NAME_SOFT_REQUIRES] = "SoftRequires",
364 [NAME_WANTS] = "Wants",
365 [NAME_REQUISITE] = "Requisite",
366 [NAME_SOFT_REQUISITE] = "SoftRequisite",
367 [NAME_REQUIRED_BY] = "RequiredBy",
368 [NAME_SOFT_REQUIRED_BY] = "SoftRequiredBy",
369 [NAME_WANTED_BY] = "WantedBy",
370 [NAME_CONFLICTS] = "Conflicts",
371 [NAME_BEFORE] = "Before",
372 [NAME_AFTER] = "After",
386 "%s\tDescription: %s\n"
387 "%s\tName Load State: %s\n"
388 "%s\tName Active State: %s\n",
390 prefix, name_description(n),
391 prefix, load_state_table[n->meta.load_state],
392 prefix, active_state_table[name_active_state(n)]);
394 SET_FOREACH(t, n->meta.names, state)
395 fprintf(f, "%s\tName: %s\n", prefix, t);
397 for (d = 0; d < _NAME_DEPENDENCY_MAX; d++) {
401 if (set_isempty(n->meta.dependencies[d]))
404 SET_FOREACH(other, n->meta.dependencies[d], state)
405 fprintf(f, "%s\t%s: %s\n", prefix, dependency_table[d], name_id(other));
408 if (NAME_VTABLE(n)->dump)
409 NAME_VTABLE(n)->dump(n, f, prefix);
414 if (asprintf(&p, "%s\t", prefix) >= 0)
419 job_dump(n->meta.job, f, prefix);
424 static int verify_type(Name *name) {
430 /* Checks that all aliases of this name have the same and valid type */
432 SET_FOREACH(n, name->meta.names, state) {
435 if ((t = name_type_from_string(n)) == _NAME_TYPE_INVALID)
438 if (name->meta.type == _NAME_TYPE_INVALID) {
443 if (name->meta.type != t)
447 if (name->meta.type == _NAME_TYPE_INVALID)
453 /* Common implementation for multiple backends */
454 int name_load_fragment_and_dropin(Name *n) {
459 /* Load a .socket file */
460 if ((r = name_load_fragment(n)) < 0)
463 /* Load drop-in directory data */
464 if ((r = name_load_dropin(n)) < 0)
470 int name_load(Name *name) {
475 if (name->meta.load_state != NAME_STUB)
478 if ((r = verify_type(name)) < 0)
481 if (NAME_VTABLE(name)->load)
482 if ((r = NAME_VTABLE(name)->load(name)) < 0)
485 if ((r = name_sanitize(name)) < 0)
488 if ((r = name_link_names(name, false)) < 0)
491 name->meta.load_state = NAME_LOADED;
495 name->meta.load_state = NAME_FAILED;
500 * -EBADR: This name type does not support starting.
501 * -EALREADY: Name is already started.
502 * -EAGAIN: An operation is already in progress. Retry later.
504 int name_start(Name *n) {
505 NameActiveState state;
509 if (!NAME_VTABLE(n)->start)
512 state = name_active_state(n);
513 if (NAME_IS_ACTIVE_OR_RELOADING(state))
516 if (state == NAME_ACTIVATING)
519 return NAME_VTABLE(n)->start(n);
522 bool name_type_can_start(NameType t) {
523 assert(t >= 0 && t < _NAME_TYPE_MAX);
525 return !!name_vtable[t]->start;
529 * -EBADR: This name type does not support stopping.
530 * -EALREADY: Name is already stopped.
531 * -EAGAIN: An operation is already in progress. Retry later.
533 int name_stop(Name *n) {
534 NameActiveState state;
538 if (!NAME_VTABLE(n)->stop)
541 state = name_active_state(n);
542 if (state == NAME_INACTIVE)
545 if (state == NAME_DEACTIVATING)
548 return NAME_VTABLE(n)->stop(n);
552 * -EBADR: This name type does not support reloading.
553 * -ENOEXEC: Name is not started.
554 * -EAGAIN: An operation is already in progress. Retry later.
556 int name_reload(Name *n) {
557 NameActiveState state;
561 if (!NAME_VTABLE(n)->reload)
564 state = name_active_state(n);
565 if (name_active_state(n) == NAME_ACTIVE_RELOADING)
568 if (name_active_state(n) != NAME_ACTIVE)
571 return NAME_VTABLE(n)->reload(n);
574 bool name_type_can_reload(NameType t) {
575 assert(t >= 0 && t < _NAME_TYPE_MAX);
576 return !!name_vtable[t]->reload;
579 static void retroactively_start_dependencies(Name *n) {
584 assert(NAME_IS_ACTIVE_OR_ACTIVATING(name_active_state(n)));
586 SET_FOREACH(other, n->meta.dependencies[NAME_REQUIRES], state)
587 if (!NAME_IS_ACTIVE_OR_ACTIVATING(name_active_state(other)))
588 manager_add_job(n->meta.manager, JOB_START, other, JOB_REPLACE, true, NULL);
590 SET_FOREACH(other, n->meta.dependencies[NAME_SOFT_REQUIRES], state)
591 if (!NAME_IS_ACTIVE_OR_ACTIVATING(name_active_state(other)))
592 manager_add_job(n->meta.manager, JOB_START, other, JOB_FAIL, false, NULL);
594 SET_FOREACH(other, n->meta.dependencies[NAME_REQUISITE], state)
595 if (!NAME_IS_ACTIVE_OR_ACTIVATING(name_active_state(other)))
596 manager_add_job(n->meta.manager, JOB_START, other, JOB_REPLACE, true, NULL);
598 SET_FOREACH(other, n->meta.dependencies[NAME_WANTS], state)
599 if (!NAME_IS_ACTIVE_OR_ACTIVATING(name_active_state(other)))
600 manager_add_job(n->meta.manager, JOB_START, other, JOB_FAIL, false, NULL);
602 SET_FOREACH(other, n->meta.dependencies[NAME_CONFLICTS], state)
603 if (!NAME_IS_ACTIVE_OR_ACTIVATING(name_active_state(other)))
604 manager_add_job(n->meta.manager, JOB_STOP, other, JOB_REPLACE, true, NULL);
607 static void retroactively_stop_dependencies(Name *n) {
612 assert(NAME_IS_INACTIVE_OR_DEACTIVATING(name_active_state(n)));
614 SET_FOREACH(other, n->meta.dependencies[NAME_REQUIRED_BY], state)
615 if (!NAME_IS_INACTIVE_OR_DEACTIVATING(name_active_state(other)))
616 manager_add_job(n->meta.manager, JOB_STOP, other, JOB_REPLACE, true, NULL);
619 void name_notify(Name *n, NameActiveState os, NameActiveState ns) {
621 assert(os < _NAME_ACTIVE_STATE_MAX);
622 assert(ns < _NAME_ACTIVE_STATE_MAX);
623 assert(!(os == NAME_ACTIVE && ns == NAME_ACTIVATING));
624 assert(!(os == NAME_INACTIVE && ns == NAME_DEACTIVATING));
631 if (n->meta.job->state == JOB_WAITING)
633 /* So we reached a different state for this
634 * job. Let's see if we can run it now if it
635 * failed previously due to EAGAIN. */
636 job_run_and_invalidate(n->meta.job);
639 assert(n->meta.job->state == JOB_RUNNING);
641 /* Let's check of this state change
642 * constitutes a finished job, or maybe
643 * cotradicts a running job and hence needs to
644 * invalidate jobs. */
646 switch (n->meta.job->type) {
649 case JOB_VERIFY_ACTIVE:
651 if (NAME_IS_ACTIVE_OR_RELOADING(ns)) {
652 job_finish_and_invalidate(n->meta.job, true);
654 } else if (ns == NAME_ACTIVATING)
657 job_finish_and_invalidate(n->meta.job, false);
662 case JOB_RELOAD_OR_START:
664 if (ns == NAME_ACTIVE) {
665 job_finish_and_invalidate(n->meta.job, true);
667 } else if (ns == NAME_ACTIVATING || ns == NAME_ACTIVE_RELOADING)
670 job_finish_and_invalidate(n->meta.job, false);
676 case JOB_TRY_RESTART:
678 if (ns == NAME_INACTIVE) {
679 job_finish_and_invalidate(n->meta.job, true);
681 } else if (ns == NAME_DEACTIVATING)
684 job_finish_and_invalidate(n->meta.job, false);
689 assert_not_reached("Job type unknown");
694 /* If this state change happened without being requested by a
695 * job, then let's retroactively start or stop dependencies */
697 if (NAME_IS_INACTIVE_OR_DEACTIVATING(os) && NAME_IS_ACTIVE_OR_ACTIVATING(ns))
698 retroactively_start_dependencies(n);
699 else if (NAME_IS_ACTIVE_OR_ACTIVATING(os) && NAME_IS_INACTIVE_OR_DEACTIVATING(ns))
700 retroactively_stop_dependencies(n);
703 int name_watch_fd(Name *n, int fd, uint32_t events) {
704 struct epoll_event ev;
714 if (epoll_ctl(n->meta.manager->epoll_fd, EPOLL_CTL_ADD, fd, &ev) < 0)
720 void name_unwatch_fd(Name *n, int fd) {
724 assert_se(epoll_ctl(n->meta.manager->epoll_fd, EPOLL_CTL_DEL, fd, NULL) >= 0 || errno == ENOENT);
727 int name_watch_pid(Name *n, pid_t pid) {
731 return hashmap_put(n->meta.manager->watch_pids, UINT32_TO_PTR(pid), n);
734 void name_unwatch_pid(Name *n, pid_t pid) {
738 hashmap_remove(n->meta.manager->watch_pids, UINT32_TO_PTR(pid));