1 /*-*- Mode: C; c-basic-offset: 8 -*-*/
11 #include "load-fragment.h"
12 #include "load-dropin.h"
14 static const NameVTable * const name_vtable[_NAME_TYPE_MAX] = {
15 [NAME_SERVICE] = &service_vtable,
16 [NAME_TIMER] = &timer_vtable,
17 [NAME_SOCKET] = &socket_vtable,
18 [NAME_MILESTONE] = &milestone_vtable,
19 [NAME_DEVICE] = &device_vtable,
20 [NAME_MOUNT] = &mount_vtable,
21 [NAME_AUTOMOUNT] = &automount_vtable,
22 [NAME_SNAPSHOT] = &snapshot_vtable
25 #define NAME_VTABLE(n) name_vtable[(n)->meta.type]
27 NameType name_type_from_string(const char *n) {
32 for (t = 0; t < _NAME_TYPE_MAX; t++)
33 if (endswith(n, name_vtable[t]->suffix))
36 return _NAME_TYPE_INVALID;
41 "abcdefghijklmnopqrstuvwxyz" \
42 "ABCDEFGHIJKLMNOPQRSTUVWXYZ" \
45 bool name_is_valid(const char *n) {
51 if (strlen(n) >= NAME_MAX)
54 t = name_type_from_string(n);
55 if (t < 0 || t >= _NAME_TYPE_MAX)
58 if (!(e = strrchr(n, '.')))
61 for (i = n; i < e; i++)
62 if (!strchr(VALID_CHARS, *i))
68 Name *name_new(Manager *m) {
73 if (!(n = new0(Name, 1)))
76 if (!(n->meta.names = set_new(string_hash_func, string_compare_func))) {
81 /* Not much initialization happening here at this time */
83 n->meta.type = _NAME_TYPE_INVALID;
85 /* We don't link the name here, that is left for name_link() */
90 /* FIXME: Does not rollback on failure! */
91 int name_link_names(Name *n, bool replace) {
101 /* Link all names that aren't linked yet. */
103 SET_FOREACH(t, n->meta.names, state)
105 if ((r = hashmap_replace(n->meta.manager->names, t, n)) < 0)
108 if ((r = hashmap_put(n->meta.manager->names, t, n)) < 0)
115 int name_link(Name *n) {
119 assert(!set_isempty(n->meta.names));
120 assert(!n->meta.linked);
122 if ((r = name_sanitize(n)) < 0)
125 n->meta.linked = true;
127 if ((r = name_link_names(n, false)) < 0) {
131 /* Rollback the registered names */
132 SET_FOREACH(t, n->meta.names, state)
133 hashmap_remove_value(n->meta.manager->names, t, n);
135 n->meta.linked = false;
139 if (n->meta.load_state == NAME_STUB)
140 LIST_PREPEND(Meta, n->meta.manager->load_queue, &n->meta);
145 static void bidi_set_free(Name *name, Set *s) {
151 /* Frees the set and makes sure we are dropped from the
152 * inverse pointers */
154 SET_FOREACH(other, s, state) {
157 for (d = 0; d < _NAME_DEPENDENCY_MAX; d++)
158 set_remove(other->meta.dependencies[d], name);
164 void name_free(Name *name) {
170 /* Detach from next 'bigger' objects */
171 if (name->meta.linked) {
175 SET_FOREACH(t, name->meta.names, state)
176 hashmap_remove_value(name->meta.manager->names, t, name);
178 if (name->meta.load_state == NAME_STUB)
179 LIST_REMOVE(Meta, name->meta.manager->load_queue, &name->meta);
182 /* Free data and next 'smaller' objects */
184 job_free(name->meta.job);
186 for (d = 0; d < _NAME_DEPENDENCY_MAX; d++)
187 bidi_set_free(name, name->meta.dependencies[d]);
189 if (NAME_VTABLE(name)->free_hook)
190 NAME_VTABLE(name)->free_hook(name);
192 free(name->meta.description);
194 while ((t = set_steal_first(name->meta.names)))
196 set_free(name->meta.names);
201 NameActiveState name_active_state(Name *name) {
204 if (name->meta.load_state != NAME_LOADED)
205 return NAME_INACTIVE;
207 return NAME_VTABLE(name)->active_state(name);
210 static int ensure_in_set(Set **s, void *data) {
217 if (!(*s = set_new(trivial_hash_func, trivial_compare_func)))
220 if ((r = set_put(*s, data)) < 0)
227 static int ensure_merge(Set **s, Set *other) {
233 return set_merge(*s, other);
235 if (!(*s = set_copy(other)))
241 /* FIXME: Does not rollback on failure! */
242 int name_merge(Name *name, Name *other) {
248 assert(name->meta.manager == other->meta.manager);
250 /* This merges 'other' into 'name'. FIXME: This does not
251 * rollback on failure. */
253 if (name->meta.type != other->meta.type)
256 if (other->meta.load_state != NAME_STUB)
260 if ((r = ensure_merge(&name->meta.names, other->meta.names)) < 0)
263 /* Merge dependencies */
264 for (d = 0; d < _NAME_DEPENDENCY_MAX; d++)
265 if ((r = ensure_merge(&name->meta.dependencies[d], other->meta.dependencies[d])) < 0)
268 /* Hookup new deps and names */
269 if (name->meta.linked) {
270 if ((r = name_sanitize(name)) < 0)
273 if ((r = name_link_names(name, true)) < 0)
280 /* FIXME: Does not rollback on failure! */
281 static int augment(Name *n) {
288 /* Adds in the missing links to make all dependencies
291 SET_FOREACH(other, n->meta.dependencies[NAME_BEFORE], state)
292 if ((r = ensure_in_set(&other->meta.dependencies[NAME_AFTER], n)) < 0)
294 SET_FOREACH(other, n->meta.dependencies[NAME_AFTER], state)
295 if ((r = ensure_in_set(&other->meta.dependencies[NAME_BEFORE], n)) < 0)
298 SET_FOREACH(other, n->meta.dependencies[NAME_CONFLICTS], state)
299 if ((r = ensure_in_set(&other->meta.dependencies[NAME_CONFLICTS], n)) < 0)
302 SET_FOREACH(other, n->meta.dependencies[NAME_REQUIRES], state)
303 if ((r = ensure_in_set(&other->meta.dependencies[NAME_REQUIRED_BY], n)) < 0)
305 SET_FOREACH(other, n->meta.dependencies[NAME_REQUISITE], state)
306 if ((r = ensure_in_set(&other->meta.dependencies[NAME_REQUIRED_BY], n)) < 0)
309 SET_FOREACH(other, n->meta.dependencies[NAME_SOFT_REQUIRES], state)
310 if ((r = ensure_in_set(&other->meta.dependencies[NAME_SOFT_REQUIRED_BY], n)) < 0)
313 SET_FOREACH(other, n->meta.dependencies[NAME_WANTS], state)
314 if ((r = ensure_in_set(&other->meta.dependencies[NAME_WANTED_BY], n)) < 0)
320 int name_sanitize(Name *n) {
326 for (d = 0; d < _NAME_DEPENDENCY_MAX; d++)
327 set_remove(n->meta.dependencies[d], n);
332 const char* name_id(Name *n) {
335 return set_first(n->meta.names);
338 const char *name_description(Name *n) {
341 if (n->meta.description)
342 return n->meta.description;
347 void name_dump(Name *n, FILE *f, const char *prefix) {
349 static const char* const load_state_table[_NAME_LOAD_STATE_MAX] = {
350 [NAME_STUB] = "stub",
351 [NAME_LOADED] = "loaded",
352 [NAME_FAILED] = "failed"
355 static const char* const active_state_table[_NAME_ACTIVE_STATE_MAX] = {
356 [NAME_ACTIVE] = "active",
357 [NAME_INACTIVE] = "inactive",
358 [NAME_ACTIVATING] = "activating",
359 [NAME_DEACTIVATING] = "deactivating"
362 static const char* const dependency_table[_NAME_DEPENDENCY_MAX] = {
363 [NAME_REQUIRES] = "Requires",
364 [NAME_SOFT_REQUIRES] = "SoftRequires",
365 [NAME_WANTS] = "Wants",
366 [NAME_REQUISITE] = "Requisite",
367 [NAME_SOFT_REQUISITE] = "SoftRequisite",
368 [NAME_REQUIRED_BY] = "RequiredBy",
369 [NAME_SOFT_REQUIRED_BY] = "SoftRequiredBy",
370 [NAME_WANTED_BY] = "WantedBy",
371 [NAME_CONFLICTS] = "Conflicts",
372 [NAME_BEFORE] = "Before",
373 [NAME_AFTER] = "After",
387 "%s\tDescription: %s\n"
388 "%s\tName Load State: %s\n"
389 "%s\tName Active State: %s\n",
391 prefix, name_description(n),
392 prefix, load_state_table[n->meta.load_state],
393 prefix, active_state_table[name_active_state(n)]);
395 SET_FOREACH(t, n->meta.names, state)
396 fprintf(f, "%s\tName: %s\n", prefix, t);
398 for (d = 0; d < _NAME_DEPENDENCY_MAX; d++) {
402 if (set_isempty(n->meta.dependencies[d]))
405 SET_FOREACH(other, n->meta.dependencies[d], state)
406 fprintf(f, "%s\t%s: %s\n", prefix, dependency_table[d], name_id(other));
409 if (NAME_VTABLE(n)->dump)
410 NAME_VTABLE(n)->dump(n, f, prefix);
415 if (asprintf(&p, "%s\t", prefix) >= 0)
420 job_dump(n->meta.job, f, prefix);
425 static int verify_type(Name *name) {
431 /* Checks that all aliases of this name have the same and valid type */
433 SET_FOREACH(n, name->meta.names, state) {
436 if ((t = name_type_from_string(n)) == _NAME_TYPE_INVALID)
439 if (name->meta.type == _NAME_TYPE_INVALID) {
444 if (name->meta.type != t)
448 if (name->meta.type == _NAME_TYPE_INVALID)
454 /* Common implementation for multiple backends */
455 int name_load_fragment_and_dropin(Name *n) {
460 /* Load a .socket file */
461 if ((r = name_load_fragment(n)) < 0)
464 /* Load drop-in directory data */
465 if ((r = name_load_dropin(n)) < 0)
471 int name_load(Name *name) {
476 if (name->meta.load_state != NAME_STUB)
479 if ((r = verify_type(name)) < 0)
482 if (NAME_VTABLE(name)->load)
483 if ((r = NAME_VTABLE(name)->load(name)) < 0)
486 if ((r = name_sanitize(name)) < 0)
489 if ((r = name_link_names(name, false)) < 0)
492 name->meta.load_state = NAME_LOADED;
496 name->meta.load_state = NAME_FAILED;
501 * -EBADR: This name type does not support starting.
502 * -EALREADY: Name is already started.
503 * -EAGAIN: An operation is already in progress. Retry later.
505 int name_start(Name *n) {
506 NameActiveState state;
510 if (!NAME_VTABLE(n)->start)
513 state = name_active_state(n);
514 if (NAME_IS_ACTIVE_OR_RELOADING(state))
517 if (state == NAME_ACTIVATING)
520 return NAME_VTABLE(n)->start(n);
523 bool name_type_can_start(NameType t) {
524 assert(t >= 0 && t < _NAME_TYPE_MAX);
526 return !!name_vtable[t]->start;
530 * -EBADR: This name type does not support stopping.
531 * -EALREADY: Name is already stopped.
532 * -EAGAIN: An operation is already in progress. Retry later.
534 int name_stop(Name *n) {
535 NameActiveState state;
539 if (!NAME_VTABLE(n)->stop)
542 state = name_active_state(n);
543 if (state == NAME_INACTIVE)
546 if (state == NAME_DEACTIVATING)
549 return NAME_VTABLE(n)->stop(n);
553 * -EBADR: This name type does not support reloading.
554 * -ENOEXEC: Name is not started.
555 * -EAGAIN: An operation is already in progress. Retry later.
557 int name_reload(Name *n) {
558 NameActiveState state;
562 if (!NAME_VTABLE(n)->reload)
565 state = name_active_state(n);
566 if (name_active_state(n) == NAME_ACTIVE_RELOADING)
569 if (name_active_state(n) != NAME_ACTIVE)
572 return NAME_VTABLE(n)->reload(n);
575 bool name_type_can_reload(NameType t) {
576 assert(t >= 0 && t < _NAME_TYPE_MAX);
577 return !!name_vtable[t]->reload;
580 static void retroactively_start_dependencies(Name *n) {
585 assert(NAME_IS_ACTIVE_OR_ACTIVATING(name_active_state(n)));
587 SET_FOREACH(other, n->meta.dependencies[NAME_REQUIRES], state)
588 if (!NAME_IS_ACTIVE_OR_ACTIVATING(name_active_state(other)))
589 manager_add_job(n->meta.manager, JOB_START, other, JOB_REPLACE, true, NULL);
591 SET_FOREACH(other, n->meta.dependencies[NAME_SOFT_REQUIRES], state)
592 if (!NAME_IS_ACTIVE_OR_ACTIVATING(name_active_state(other)))
593 manager_add_job(n->meta.manager, JOB_START, other, JOB_FAIL, false, NULL);
595 SET_FOREACH(other, n->meta.dependencies[NAME_REQUISITE], state)
596 if (!NAME_IS_ACTIVE_OR_ACTIVATING(name_active_state(other)))
597 manager_add_job(n->meta.manager, JOB_START, other, JOB_REPLACE, true, NULL);
599 SET_FOREACH(other, n->meta.dependencies[NAME_WANTS], state)
600 if (!NAME_IS_ACTIVE_OR_ACTIVATING(name_active_state(other)))
601 manager_add_job(n->meta.manager, JOB_START, other, JOB_FAIL, false, NULL);
603 SET_FOREACH(other, n->meta.dependencies[NAME_CONFLICTS], state)
604 if (!NAME_IS_ACTIVE_OR_ACTIVATING(name_active_state(other)))
605 manager_add_job(n->meta.manager, JOB_STOP, other, JOB_REPLACE, true, NULL);
608 static void retroactively_stop_dependencies(Name *n) {
613 assert(NAME_IS_INACTIVE_OR_DEACTIVATING(name_active_state(n)));
615 SET_FOREACH(other, n->meta.dependencies[NAME_REQUIRED_BY], state)
616 if (!NAME_IS_INACTIVE_OR_DEACTIVATING(name_active_state(other)))
617 manager_add_job(n->meta.manager, JOB_STOP, other, JOB_REPLACE, true, NULL);
620 int name_notify(Name *n, NameActiveState os, NameActiveState ns) {
622 assert(os < _NAME_ACTIVE_STATE_MAX);
623 assert(ns < _NAME_ACTIVE_STATE_MAX);
624 assert(!(os == NAME_ACTIVE && ns == NAME_ACTIVATING));
625 assert(!(os == NAME_INACTIVE && ns == NAME_DEACTIVATING));
632 if (n->meta.job->state == JOB_WAITING)
634 /* So we reached a different state for this
635 * job. Let's see if we can run it now if it
636 * failed previously due to EAGAIN. */
637 job_run_and_invalidate(n->meta.job);
640 assert(n->meta.job->state == JOB_RUNNING);
642 /* Let's check of this state change
643 * constitutes a finished job, or maybe
644 * cotradicts a running job and hence needs to
645 * invalidate jobs. */
647 switch (n->meta.job->type) {
650 case JOB_VERIFY_ACTIVE:
652 if (NAME_IS_ACTIVE_OR_RELOADING(ns))
653 return 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 return job_finish_and_invalidate(n->meta.job, true);
666 else if (ns == NAME_ACTIVATING || ns == NAME_ACTIVE_RELOADING)
669 job_finish_and_invalidate(n->meta.job, false);
675 case JOB_TRY_RESTART:
677 if (ns == NAME_INACTIVE)
678 return job_finish_and_invalidate(n->meta.job, true);
679 else if (ns == NAME_DEACTIVATING)
682 job_finish_and_invalidate(n->meta.job, false);
687 assert_not_reached("Job type unknown");
692 /* If this state change happened without being requested by a
693 * job, then let's retroactively start or stop dependencies */
695 if (NAME_IS_INACTIVE_OR_DEACTIVATING(os) && NAME_IS_ACTIVE_OR_ACTIVATING(ns))
696 retroactively_start_dependencies(n);
697 else if (NAME_IS_ACTIVE_OR_ACTIVATING(os) && NAME_IS_INACTIVE_OR_DEACTIVATING(ns))
698 retroactively_stop_dependencies(n);