1 /*-*- Mode: C; c-basic-offset: 8 -*-*/
7 #include <sys/timerfd.h>
16 #include "load-fragment.h"
17 #include "load-dropin.h"
20 const UnitVTable
* const unit_vtable
[_UNIT_TYPE_MAX
] = {
21 [UNIT_SERVICE
] = &service_vtable
,
22 [UNIT_TIMER
] = &timer_vtable
,
23 [UNIT_SOCKET
] = &socket_vtable
,
24 [UNIT_TARGET
] = &target_vtable
,
25 [UNIT_DEVICE
] = &device_vtable
,
26 [UNIT_MOUNT
] = &mount_vtable
,
27 [UNIT_AUTOMOUNT
] = &automount_vtable
,
28 [UNIT_SNAPSHOT
] = &snapshot_vtable
31 UnitType
unit_name_to_type(const char *n
) {
36 for (t
= 0; t
< _UNIT_TYPE_MAX
; t
++)
37 if (endswith(n
, unit_vtable
[t
]->suffix
))
40 return _UNIT_TYPE_INVALID
;
45 "abcdefghijklmnopqrstuvwxyz" \
46 "ABCDEFGHIJKLMNOPQRSTUVWXYZ" \
49 bool unit_name_is_valid(const char *n
) {
55 if (strlen(n
) >= UNIT_NAME_MAX
)
58 t
= unit_name_to_type(n
);
59 if (t
< 0 || t
>= _UNIT_TYPE_MAX
)
62 if (!(e
= strrchr(n
, '.')))
68 for (i
= n
; i
< e
; i
++)
69 if (!strchr(VALID_CHARS
, *i
))
75 char *unit_name_change_suffix(const char *n
, const char *suffix
) {
80 assert(unit_name_is_valid(n
));
83 assert_se(e
= strrchr(n
, '.'));
87 if (!(r
= new(char, a
+ b
+ 1)))
91 memcpy(r
+a
, suffix
, b
+1);
96 Unit
*unit_new(Manager
*m
) {
101 if (!(u
= new0(Unit
, 1)))
104 if (!(u
->meta
.names
= set_new(string_hash_func
, string_compare_func
))) {
110 u
->meta
.type
= _UNIT_TYPE_INVALID
;
115 int unit_add_name(Unit
*u
, const char *text
) {
123 if (!unit_name_is_valid(text
))
126 if ((t
= unit_name_to_type(text
)) == _UNIT_TYPE_INVALID
)
129 if (u
->meta
.type
!= _UNIT_TYPE_INVALID
&& t
!= u
->meta
.type
)
132 if (!(s
= strdup(text
)))
135 if ((r
= set_put(u
->meta
.names
, s
)) < 0) {
144 if ((r
= hashmap_put(u
->meta
.manager
->units
, s
, u
)) < 0) {
145 set_remove(u
->meta
.names
, s
);
158 void unit_add_to_load_queue(Unit
*u
) {
161 if (u
->meta
.load_state
!= UNIT_STUB
|| u
->meta
.in_load_queue
)
164 LIST_PREPEND(Meta
, load_queue
, u
->meta
.manager
->load_queue
, &u
->meta
);
165 u
->meta
.in_load_queue
= true;
168 static void bidi_set_free(Unit
*u
, Set
*s
) {
174 /* Frees the set and makes sure we are dropped from the
175 * inverse pointers */
177 SET_FOREACH(other
, s
, i
) {
180 for (d
= 0; d
< _UNIT_DEPENDENCY_MAX
; d
++)
181 set_remove(other
->meta
.dependencies
[d
], u
);
187 void unit_free(Unit
*u
) {
194 /* Detach from next 'bigger' objects */
196 SET_FOREACH(t
, u
->meta
.names
, i
)
197 hashmap_remove_value(u
->meta
.manager
->units
, t
, u
);
199 if (u
->meta
.in_load_queue
)
200 LIST_REMOVE(Meta
, load_queue
, u
->meta
.manager
->load_queue
, &u
->meta
);
202 if (u
->meta
.load_state
== UNIT_LOADED
)
203 if (UNIT_VTABLE(u
)->done
)
204 UNIT_VTABLE(u
)->done(u
);
206 /* Free data and next 'smaller' objects */
208 job_free(u
->meta
.job
);
210 for (d
= 0; d
< _UNIT_DEPENDENCY_MAX
; d
++)
211 bidi_set_free(u
, u
->meta
.dependencies
[d
]);
213 free(u
->meta
.description
);
214 free(u
->meta
.load_path
);
216 while ((t
= set_steal_first(u
->meta
.names
)))
218 set_free(u
->meta
.names
);
223 UnitActiveState
unit_active_state(Unit
*u
) {
226 if (u
->meta
.load_state
!= UNIT_LOADED
)
227 return UNIT_INACTIVE
;
229 return UNIT_VTABLE(u
)->active_state(u
);
232 static int ensure_merge(Set
**s
, Set
*other
) {
238 return set_merge(*s
, other
);
240 if (!(*s
= set_copy(other
)))
246 /* FIXME: Does not rollback on failure! Needs to fix special unit
247 * pointers. Needs to merge names and dependencies properly.*/
248 int unit_merge(Unit
*u
, Unit
*other
) {
254 assert(u
->meta
.manager
== other
->meta
.manager
);
256 /* This merges 'other' into 'unit'. FIXME: This does not
257 * rollback on failure. */
259 if (u
->meta
.type
!= u
->meta
.type
)
262 if (u
->meta
.load_state
!= UNIT_STUB
)
266 if ((r
= ensure_merge(&u
->meta
.names
, other
->meta
.names
)) < 0)
269 /* Merge dependencies */
270 for (d
= 0; d
< _UNIT_DEPENDENCY_MAX
; d
++)
271 /* fixme, the inverse mapping is missing */
272 if ((r
= ensure_merge(&u
->meta
.dependencies
[d
], other
->meta
.dependencies
[d
])) < 0)
278 const char* unit_id(Unit
*u
) {
284 return set_first(u
->meta
.names
);
287 const char *unit_description(Unit
*u
) {
290 if (u
->meta
.description
)
291 return u
->meta
.description
;
296 void unit_dump(Unit
*u
, FILE *f
, const char *prefix
) {
298 static const char* const load_state_table
[_UNIT_LOAD_STATE_MAX
] = {
299 [UNIT_STUB
] = "stub",
300 [UNIT_LOADED
] = "loaded",
301 [UNIT_FAILED
] = "failed"
304 static const char* const active_state_table
[_UNIT_ACTIVE_STATE_MAX
] = {
305 [UNIT_ACTIVE
] = "active",
306 [UNIT_INACTIVE
] = "inactive",
307 [UNIT_ACTIVATING
] = "activating",
308 [UNIT_DEACTIVATING
] = "deactivating"
311 static const char* const dependency_table
[_UNIT_DEPENDENCY_MAX
] = {
312 [UNIT_REQUIRES
] = "Requires",
313 [UNIT_SOFT_REQUIRES
] = "SoftRequires",
314 [UNIT_WANTS
] = "Wants",
315 [UNIT_REQUISITE
] = "Requisite",
316 [UNIT_SOFT_REQUISITE
] = "SoftRequisite",
317 [UNIT_REQUIRED_BY
] = "RequiredBy",
318 [UNIT_SOFT_REQUIRED_BY
] = "SoftRequiredBy",
319 [UNIT_WANTED_BY
] = "WantedBy",
320 [UNIT_CONFLICTS
] = "Conflicts",
321 [UNIT_BEFORE
] = "Before",
322 [UNIT_AFTER
] = "After",
334 prefix2
= strappend(prefix
, "\t");
340 "%s\tDescription: %s\n"
341 "%s\tUnit Load State: %s\n"
342 "%s\tUnit Active State: %s\n",
344 prefix
, unit_description(u
),
345 prefix
, load_state_table
[u
->meta
.load_state
],
346 prefix
, active_state_table
[unit_active_state(u
)]);
348 if (u
->meta
.load_path
)
349 fprintf(f
, "%s\tLoad Path: %s\n", prefix
, u
->meta
.load_path
);
351 SET_FOREACH(t
, u
->meta
.names
, i
)
352 fprintf(f
, "%s\tName: %s\n", prefix
, t
);
354 for (d
= 0; d
< _UNIT_DEPENDENCY_MAX
; d
++) {
357 if (set_isempty(u
->meta
.dependencies
[d
]))
360 SET_FOREACH(other
, u
->meta
.dependencies
[d
], i
)
361 fprintf(f
, "%s\t%s: %s\n", prefix
, dependency_table
[d
], unit_id(other
));
364 if (UNIT_VTABLE(u
)->dump
)
365 UNIT_VTABLE(u
)->dump(u
, f
, prefix2
);
368 job_dump(u
->meta
.job
, f
, prefix2
);
373 /* Common implementation for multiple backends */
374 int unit_load_fragment_and_dropin(Unit
*u
) {
379 /* Load a .socket file */
380 if ((r
= unit_load_fragment(u
)) < 0)
385 /* Load drop-in directory data */
386 if ((r
= unit_load_dropin(u
)) < 0)
392 int unit_load(Unit
*u
) {
397 if (u
->meta
.in_load_queue
) {
398 LIST_REMOVE(Meta
, load_queue
, u
->meta
.manager
->load_queue
, &u
->meta
);
399 u
->meta
.in_load_queue
= false;
402 if (u
->meta
.load_state
!= UNIT_STUB
)
405 if (UNIT_VTABLE(u
)->init
)
406 if ((r
= UNIT_VTABLE(u
)->init(u
)) < 0)
409 u
->meta
.load_state
= UNIT_LOADED
;
413 u
->meta
.load_state
= UNIT_FAILED
;
418 * -EBADR: This unit type does not support starting.
419 * -EALREADY: Unit is already started.
420 * -EAGAIN: An operation is already in progress. Retry later.
422 int unit_start(Unit
*u
) {
423 UnitActiveState state
;
427 if (!UNIT_VTABLE(u
)->start
)
430 state
= unit_active_state(u
);
431 if (UNIT_IS_ACTIVE_OR_RELOADING(state
))
434 /* We don't suppress calls to ->start() here when we are
435 * already starting, to allow this request to be used as a
436 * "hurry up" call, for example when the unit is in some "auto
437 * restart" state where it waits for a holdoff timer to elapse
438 * before it will start again. */
440 return UNIT_VTABLE(u
)->start(u
);
443 bool unit_can_start(Unit
*u
) {
446 return !!UNIT_VTABLE(u
)->start
;
450 * -EBADR: This unit type does not support stopping.
451 * -EALREADY: Unit is already stopped.
452 * -EAGAIN: An operation is already in progress. Retry later.
454 int unit_stop(Unit
*u
) {
455 UnitActiveState state
;
459 if (!UNIT_VTABLE(u
)->stop
)
462 state
= unit_active_state(u
);
463 if (state
== UNIT_INACTIVE
)
466 if (state
== UNIT_DEACTIVATING
)
469 return UNIT_VTABLE(u
)->stop(u
);
473 * -EBADR: This unit type does not support reloading.
474 * -ENOEXEC: Unit is not started.
475 * -EAGAIN: An operation is already in progress. Retry later.
477 int unit_reload(Unit
*u
) {
478 UnitActiveState state
;
482 if (!unit_can_reload(u
))
485 state
= unit_active_state(u
);
486 if (unit_active_state(u
) == UNIT_ACTIVE_RELOADING
)
489 if (unit_active_state(u
) != UNIT_ACTIVE
)
492 return UNIT_VTABLE(u
)->reload(u
);
495 bool unit_can_reload(Unit
*u
) {
498 if (!UNIT_VTABLE(u
)->reload
)
501 if (!UNIT_VTABLE(u
)->can_reload
)
504 return UNIT_VTABLE(u
)->can_reload(u
);
507 static void retroactively_start_dependencies(Unit
*u
) {
512 assert(UNIT_IS_ACTIVE_OR_ACTIVATING(unit_active_state(u
)));
514 SET_FOREACH(other
, u
->meta
.dependencies
[UNIT_REQUIRES
], i
)
515 if (!UNIT_IS_ACTIVE_OR_ACTIVATING(unit_active_state(other
)))
516 manager_add_job(u
->meta
.manager
, JOB_START
, other
, JOB_REPLACE
, true, NULL
);
518 SET_FOREACH(other
, u
->meta
.dependencies
[UNIT_SOFT_REQUIRES
], i
)
519 if (!UNIT_IS_ACTIVE_OR_ACTIVATING(unit_active_state(other
)))
520 manager_add_job(u
->meta
.manager
, JOB_START
, other
, JOB_FAIL
, false, NULL
);
522 SET_FOREACH(other
, u
->meta
.dependencies
[UNIT_REQUISITE
], i
)
523 if (!UNIT_IS_ACTIVE_OR_ACTIVATING(unit_active_state(other
)))
524 manager_add_job(u
->meta
.manager
, JOB_START
, other
, JOB_REPLACE
, true, NULL
);
526 SET_FOREACH(other
, u
->meta
.dependencies
[UNIT_WANTS
], i
)
527 if (!UNIT_IS_ACTIVE_OR_ACTIVATING(unit_active_state(other
)))
528 manager_add_job(u
->meta
.manager
, JOB_START
, other
, JOB_FAIL
, false, NULL
);
530 SET_FOREACH(other
, u
->meta
.dependencies
[UNIT_CONFLICTS
], i
)
531 if (!UNIT_IS_ACTIVE_OR_ACTIVATING(unit_active_state(other
)))
532 manager_add_job(u
->meta
.manager
, JOB_STOP
, other
, JOB_REPLACE
, true, NULL
);
535 static void retroactively_stop_dependencies(Unit
*u
) {
540 assert(UNIT_IS_INACTIVE_OR_DEACTIVATING(unit_active_state(u
)));
542 SET_FOREACH(other
, u
->meta
.dependencies
[UNIT_REQUIRED_BY
], i
)
543 if (!UNIT_IS_INACTIVE_OR_DEACTIVATING(unit_active_state(other
)))
544 manager_add_job(u
->meta
.manager
, JOB_STOP
, other
, JOB_REPLACE
, true, NULL
);
547 void unit_notify(Unit
*u
, UnitActiveState os
, UnitActiveState ns
) {
549 assert(os
< _UNIT_ACTIVE_STATE_MAX
);
550 assert(ns
< _UNIT_ACTIVE_STATE_MAX
);
551 assert(!(os
== UNIT_ACTIVE
&& ns
== UNIT_ACTIVATING
));
552 assert(!(os
== UNIT_INACTIVE
&& ns
== UNIT_DEACTIVATING
));
557 if (!UNIT_IS_ACTIVE_OR_RELOADING(os
) && UNIT_IS_ACTIVE_OR_RELOADING(ns
))
558 u
->meta
.active_enter_timestamp
= now(CLOCK_REALTIME
);
559 else if (UNIT_IS_ACTIVE_OR_RELOADING(os
) && !UNIT_IS_ACTIVE_OR_RELOADING(ns
))
560 u
->meta
.active_exit_timestamp
= now(CLOCK_REALTIME
);
564 if (u
->meta
.job
->state
== JOB_WAITING
)
566 /* So we reached a different state for this
567 * job. Let's see if we can run it now if it
568 * failed previously due to EAGAIN. */
569 job_schedule_run(u
->meta
.job
);
572 assert(u
->meta
.job
->state
== JOB_RUNNING
);
574 /* Let's check of this state change
575 * constitutes a finished job, or maybe
576 * cotradicts a running job and hence needs to
577 * invalidate jobs. */
579 switch (u
->meta
.job
->type
) {
582 case JOB_VERIFY_ACTIVE
:
584 if (UNIT_IS_ACTIVE_OR_RELOADING(ns
)) {
585 job_finish_and_invalidate(u
->meta
.job
, true);
587 } else if (ns
== UNIT_ACTIVATING
)
590 job_finish_and_invalidate(u
->meta
.job
, false);
595 case JOB_RELOAD_OR_START
:
597 if (ns
== UNIT_ACTIVE
) {
598 job_finish_and_invalidate(u
->meta
.job
, true);
600 } else if (ns
== UNIT_ACTIVATING
|| ns
== UNIT_ACTIVE_RELOADING
)
603 job_finish_and_invalidate(u
->meta
.job
, false);
609 case JOB_TRY_RESTART
:
611 if (ns
== UNIT_INACTIVE
) {
612 job_finish_and_invalidate(u
->meta
.job
, true);
614 } else if (ns
== UNIT_DEACTIVATING
)
617 job_finish_and_invalidate(u
->meta
.job
, false);
622 assert_not_reached("Job type unknown");
627 /* If this state change happened without being requested by a
628 * job, then let's retroactively start or stop dependencies */
630 if (UNIT_IS_INACTIVE_OR_DEACTIVATING(os
) && UNIT_IS_ACTIVE_OR_ACTIVATING(ns
))
631 retroactively_start_dependencies(u
);
632 else if (UNIT_IS_ACTIVE_OR_ACTIVATING(os
) && UNIT_IS_INACTIVE_OR_DEACTIVATING(ns
))
633 retroactively_stop_dependencies(u
);
636 int unit_watch_fd(Unit
*u
, int fd
, uint32_t events
, Watch
*w
) {
637 struct epoll_event ev
;
642 assert(w
->type
== WATCH_INVALID
|| (w
->type
== WATCH_FD
&& w
->fd
== fd
&& w
->unit
== u
));
648 if (epoll_ctl(u
->meta
.manager
->epoll_fd
,
649 w
->type
== WATCH_INVALID
? EPOLL_CTL_ADD
: EPOLL_CTL_MOD
,
661 void unit_unwatch_fd(Unit
*u
, Watch
*w
) {
665 if (w
->type
== WATCH_INVALID
)
668 assert(w
->type
== WATCH_FD
&& w
->unit
== u
);
669 assert_se(epoll_ctl(u
->meta
.manager
->epoll_fd
, EPOLL_CTL_DEL
, w
->fd
, NULL
) >= 0);
672 w
->type
= WATCH_INVALID
;
676 int unit_watch_pid(Unit
*u
, pid_t pid
) {
680 return hashmap_put(u
->meta
.manager
->watch_pids
, UINT32_TO_PTR(pid
), u
);
683 void unit_unwatch_pid(Unit
*u
, pid_t pid
) {
687 hashmap_remove(u
->meta
.manager
->watch_pids
, UINT32_TO_PTR(pid
));
690 int unit_watch_timer(Unit
*u
, usec_t delay
, Watch
*w
) {
691 struct itimerspec its
;
697 assert(w
->type
== WATCH_INVALID
|| (w
->type
== WATCH_TIMER
&& w
->unit
== u
));
699 /* This will try to reuse the old timer if there is one */
701 if (w
->type
== WATCH_TIMER
) {
706 if ((fd
= timerfd_create(CLOCK_MONOTONIC
, TFD_NONBLOCK
|TFD_CLOEXEC
)) < 0)
713 /* Set absolute time in the past, but not 0, since we
714 * don't want to disarm the timer */
715 its
.it_value
.tv_sec
= 0;
716 its
.it_value
.tv_nsec
= 1;
718 flags
= TFD_TIMER_ABSTIME
;
720 timespec_store(&its
.it_value
, delay
);
724 /* This will also flush the elapse counter */
725 if (timerfd_settime(fd
, flags
, &its
, NULL
) < 0)
728 if (w
->type
== WATCH_INVALID
) {
729 struct epoll_event ev
;
735 if (epoll_ctl(u
->meta
.manager
->epoll_fd
, EPOLL_CTL_ADD
, fd
, &ev
) < 0)
740 w
->type
= WATCH_TIMER
;
747 assert_se(close_nointr(fd
) == 0);
752 void unit_unwatch_timer(Unit
*u
, Watch
*w
) {
756 if (w
->type
== WATCH_INVALID
)
759 assert(w
->type
== WATCH_TIMER
&& w
->unit
== u
);
761 assert_se(epoll_ctl(u
->meta
.manager
->epoll_fd
, EPOLL_CTL_DEL
, w
->fd
, NULL
) >= 0);
762 assert_se(close_nointr(w
->fd
) == 0);
765 w
->type
= WATCH_INVALID
;
769 bool unit_job_is_applicable(Unit
*u
, JobType j
) {
771 assert(j
>= 0 && j
< _JOB_TYPE_MAX
);
775 case JOB_VERIFY_ACTIVE
:
781 case JOB_TRY_RESTART
:
782 return unit_can_start(u
);
785 return unit_can_reload(u
);
787 case JOB_RELOAD_OR_START
:
788 return unit_can_reload(u
) && unit_can_start(u
);
791 assert_not_reached("Invalid job type");
795 int unit_add_dependency(Unit
*u
, UnitDependency d
, Unit
*other
) {
797 static const UnitDependency inverse_table
[_UNIT_DEPENDENCY_MAX
] = {
798 [UNIT_REQUIRES
] = UNIT_REQUIRED_BY
,
799 [UNIT_SOFT_REQUIRES
] = UNIT_SOFT_REQUIRED_BY
,
800 [UNIT_WANTS
] = UNIT_WANTED_BY
,
801 [UNIT_REQUISITE
] = UNIT_REQUIRED_BY
,
802 [UNIT_SOFT_REQUISITE
] = UNIT_SOFT_REQUIRED_BY
,
803 [UNIT_REQUIRED_BY
] = _UNIT_DEPENDENCY_INVALID
,
804 [UNIT_SOFT_REQUIRED_BY
] = _UNIT_DEPENDENCY_INVALID
,
805 [UNIT_WANTED_BY
] = _UNIT_DEPENDENCY_INVALID
,
806 [UNIT_CONFLICTS
] = UNIT_CONFLICTS
,
807 [UNIT_BEFORE
] = UNIT_AFTER
,
808 [UNIT_AFTER
] = UNIT_BEFORE
813 assert(d
>= 0 && d
< _UNIT_DEPENDENCY_MAX
);
814 assert(inverse_table
[d
] != _UNIT_DEPENDENCY_INVALID
);
817 /* We won't allow dependencies on ourselves. We will not
818 * consider them an error however. */
822 if ((r
= set_ensure_allocated(&u
->meta
.dependencies
[d
], trivial_hash_func
, trivial_compare_func
)) < 0)
825 if ((r
= set_ensure_allocated(&other
->meta
.dependencies
[inverse_table
[d
]], trivial_hash_func
, trivial_compare_func
)) < 0)
828 if ((r
= set_put(u
->meta
.dependencies
[d
], other
)) < 0)
831 if ((r
= set_put(other
->meta
.dependencies
[inverse_table
[d
]], u
)) < 0) {
832 set_remove(u
->meta
.dependencies
[d
], other
);
839 int unit_add_dependency_by_name(Unit
*u
, UnitDependency d
, const char *name
) {
843 if ((r
= manager_load_unit(u
->meta
.manager
, name
, &other
)) < 0)
846 if ((r
= unit_add_dependency(u
, d
, other
)) < 0)
852 const char *unit_path(void) {
855 if ((e
= getenv("UNIT_PATH")))
856 if (path_is_absolute(e
))
862 int set_unit_path(const char *p
) {
866 /* This is mostly for debug purposes */
868 if (path_is_absolute(p
)) {
869 if (!(c
= strdup(p
)))
872 if (!(cwd
= get_current_dir_name()))
875 r
= asprintf(&c
, "%s/%s", cwd
, p
);
882 if (setenv("UNIT_PATH", c
, 0) < 0) {
891 char *unit_name_escape_path(const char *path
, const char *suffix
) {
899 /* Takes a path and a util suffix and makes a nice unit name
900 * of it, escaping all weird chars on the way.
902 * / becomes _, and all chars not alloweed in a unit name get
903 * escaped as \xFF, including the _ and the \ itself, of
904 * course. This escaping is hence reversible.
910 if (!(r
= new(char, a
*4+b
+1)))
913 for (f
= path
, t
= r
; *f
; f
++) {
916 else if (*f
== '_' || *f
== '\\' || !strchr(VALID_CHARS
, *f
)) {
919 *(t
++) = hexchar(*f
> 4);
920 *(t
++) = hexchar(*f
);
925 memcpy(t
, suffix
, b
+1);