1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
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 Lesser General Public License as published by
10 the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
18 You should have received a copy of the GNU Lesser General Public License
19 along with systemd; If not, see <http://www.gnu.org/licenses/>.
25 #include "unit-name.h"
27 #include "dbus-timer.h"
30 #include "bus-error.h"
32 static const UnitActiveState state_translation_table[_TIMER_STATE_MAX] = {
33 [TIMER_DEAD] = UNIT_INACTIVE,
34 [TIMER_WAITING] = UNIT_ACTIVE,
35 [TIMER_RUNNING] = UNIT_ACTIVE,
36 [TIMER_ELAPSED] = UNIT_ACTIVE,
37 [TIMER_FAILED] = UNIT_FAILED
40 static int timer_dispatch(sd_event_source *s, uint64_t usec, void *userdata);
42 static void timer_init(Unit *u) {
46 assert(u->load_state == UNIT_STUB);
48 t->next_elapse_monotonic_or_boottime = USEC_INFINITY;
49 t->next_elapse_realtime = USEC_INFINITY;
50 t->accuracy_usec = u->manager->default_timer_accuracy_usec;
53 void timer_free_values(Timer *t) {
58 while ((v = t->values)) {
59 LIST_REMOVE(value, t->values, v);
62 calendar_spec_free(v->calendar_spec);
68 static void timer_done(Unit *u) {
75 t->monotonic_event_source = sd_event_source_unref(t->monotonic_event_source);
76 t->realtime_event_source = sd_event_source_unref(t->realtime_event_source);
81 static int timer_verify(Timer *t) {
84 if (UNIT(t)->load_state != UNIT_LOADED)
88 log_unit_error(UNIT(t)->id, "%s lacks value setting. Refusing.", UNIT(t)->id);
95 static int timer_add_default_dependencies(Timer *t) {
101 r = unit_add_dependency_by_name(UNIT(t), UNIT_BEFORE, SPECIAL_TIMERS_TARGET, NULL, true);
105 if (UNIT(t)->manager->running_as == SYSTEMD_SYSTEM) {
106 r = unit_add_two_dependencies_by_name(UNIT(t), UNIT_AFTER, UNIT_REQUIRES, SPECIAL_SYSINIT_TARGET, NULL, true);
110 LIST_FOREACH(value, v, t->values) {
111 if (v->base == TIMER_CALENDAR) {
112 r = unit_add_dependency_by_name(UNIT(t), UNIT_AFTER, SPECIAL_TIME_SYNC_TARGET, NULL, true);
120 return unit_add_two_dependencies_by_name(UNIT(t), UNIT_BEFORE, UNIT_CONFLICTS, SPECIAL_SHUTDOWN_TARGET, NULL, true);
123 static int timer_setup_persistent(Timer *t) {
131 if (UNIT(t)->manager->running_as == SYSTEMD_SYSTEM) {
133 r = unit_require_mounts_for(UNIT(t), "/var/lib/systemd/timers");
137 t->stamp_path = strappend("/var/lib/systemd/timers/stamp-", UNIT(t)->id);
141 e = getenv("XDG_DATA_HOME");
143 t->stamp_path = strjoin(e, "/systemd/timers/stamp-", UNIT(t)->id, NULL);
146 _cleanup_free_ char *h = NULL;
148 r = get_home_dir(&h);
150 return log_error_errno(r, "Failed to determine home directory: %m");
152 t->stamp_path = strjoin(h, "/.local/share/systemd/timers/stamp-", UNIT(t)->id, NULL);
162 static int timer_load(Unit *u) {
167 assert(u->load_state == UNIT_STUB);
169 r = unit_load_fragment_and_dropin(u);
173 if (u->load_state == UNIT_LOADED) {
175 if (set_isempty(u->dependencies[UNIT_TRIGGERS])) {
178 r = unit_load_related_unit(u, ".service", &x);
182 r = unit_add_two_dependencies(u, UNIT_BEFORE, UNIT_TRIGGERS, x, true);
187 r = timer_setup_persistent(t);
191 if (u->default_dependencies) {
192 r = timer_add_default_dependencies(t);
198 return timer_verify(t);
201 static void timer_dump(Unit *u, FILE *f, const char *prefix) {
202 char buf[FORMAT_TIMESPAN_MAX];
207 trigger = UNIT_TRIGGER(u);
210 "%sTimer State: %s\n"
216 prefix, timer_state_to_string(t->state),
217 prefix, timer_result_to_string(t->result),
218 prefix, trigger ? trigger->id : "n/a",
219 prefix, yes_no(t->persistent),
220 prefix, yes_no(t->wake_system),
221 prefix, format_timespan(buf, sizeof(buf), t->accuracy_usec, 1));
223 LIST_FOREACH(value, v, t->values) {
225 if (v->base == TIMER_CALENDAR) {
226 _cleanup_free_ char *p = NULL;
228 calendar_spec_to_string(v->calendar_spec, &p);
233 timer_base_to_string(v->base),
236 char timespan1[FORMAT_TIMESPAN_MAX];
241 timer_base_to_string(v->base),
242 format_timespan(timespan1, sizeof(timespan1), v->value, 0));
247 static void timer_set_state(Timer *t, TimerState state) {
248 TimerState old_state;
251 old_state = t->state;
254 if (state != TIMER_WAITING) {
255 t->monotonic_event_source = sd_event_source_unref(t->monotonic_event_source);
256 t->realtime_event_source = sd_event_source_unref(t->realtime_event_source);
259 if (state != old_state)
260 log_unit_debug(UNIT(t)->id,
261 "%s changed %s -> %s", UNIT(t)->id,
262 timer_state_to_string(old_state),
263 timer_state_to_string(state));
265 unit_notify(UNIT(t), state_translation_table[old_state], state_translation_table[state], true);
268 static void timer_enter_waiting(Timer *t, bool initial);
270 static int timer_enter_waiting_coldplug(Unit *u) {
271 timer_enter_waiting(TIMER(u), false);
275 static int timer_coldplug(Unit *u, Hashmap *deferred_work) {
279 assert(t->state == TIMER_DEAD);
281 if (t->deserialized_state != t->state) {
283 if (t->deserialized_state == TIMER_WAITING) {
284 hashmap_put(deferred_work, u, &timer_enter_waiting_coldplug);
285 timer_set_state(t, TIMER_WAITING);
287 timer_set_state(t, t->deserialized_state);
293 static void timer_enter_dead(Timer *t, TimerResult f) {
296 if (f != TIMER_SUCCESS)
299 timer_set_state(t, t->result != TIMER_SUCCESS ? TIMER_FAILED : TIMER_DEAD);
302 static usec_t monotonic_to_boottime(usec_t t) {
308 a = now(CLOCK_BOOTTIME);
309 b = now(CLOCK_MONOTONIC);
317 static void timer_enter_waiting(Timer *t, bool initial) {
318 bool found_monotonic = false, found_realtime = false;
319 usec_t ts_realtime, ts_monotonic;
324 /* If we shall wake the system we use the boottime clock
325 * rather than the monotonic clock. */
327 ts_realtime = now(CLOCK_REALTIME);
328 ts_monotonic = now(t->wake_system ? CLOCK_BOOTTIME : CLOCK_MONOTONIC);
329 t->next_elapse_monotonic_or_boottime = t->next_elapse_realtime = 0;
331 LIST_FOREACH(value, v, t->values) {
336 if (v->base == TIMER_CALENDAR) {
339 /* If we know the last time this was
340 * triggered, schedule the job based relative
341 * to that. If we don't just start from
344 b = t->last_trigger.realtime > 0 ? t->last_trigger.realtime : ts_realtime;
346 r = calendar_spec_next_usec(v->calendar_spec, b, &v->next_elapse);
351 t->next_elapse_realtime = v->next_elapse;
353 t->next_elapse_realtime = MIN(t->next_elapse_realtime, v->next_elapse);
355 found_realtime = true;
361 if (state_translation_table[t->state] == UNIT_ACTIVE)
362 base = UNIT(t)->inactive_exit_timestamp.monotonic;
368 /* CLOCK_MONOTONIC equals the uptime on Linux */
373 base = UNIT(t)->manager->userspace_timestamp.monotonic;
376 case TIMER_UNIT_ACTIVE:
378 base = UNIT_TRIGGER(UNIT(t))->inactive_exit_timestamp.monotonic;
381 base = t->last_trigger.monotonic;
388 case TIMER_UNIT_INACTIVE:
390 base = UNIT_TRIGGER(UNIT(t))->inactive_enter_timestamp.monotonic;
393 base = t->last_trigger.monotonic;
401 assert_not_reached("Unknown timer base");
405 base = monotonic_to_boottime(base);
407 v->next_elapse = base + v->value;
409 if (!initial && v->next_elapse < ts_monotonic && IN_SET(v->base, TIMER_ACTIVE, TIMER_BOOT, TIMER_STARTUP)) {
410 /* This is a one time trigger, disable it now */
415 if (!found_monotonic)
416 t->next_elapse_monotonic_or_boottime = v->next_elapse;
418 t->next_elapse_monotonic_or_boottime = MIN(t->next_elapse_monotonic_or_boottime, v->next_elapse);
420 found_monotonic = true;
424 if (!found_monotonic && !found_realtime) {
425 log_unit_debug(UNIT(t)->id, "%s: Timer is elapsed.", UNIT(t)->id);
426 timer_set_state(t, TIMER_ELAPSED);
430 if (found_monotonic) {
431 char buf[FORMAT_TIMESPAN_MAX];
433 log_unit_debug(UNIT(t)->id, "%s: Monotonic timer elapses in %s.",
435 format_timespan(buf, sizeof(buf), t->next_elapse_monotonic_or_boottime > ts_monotonic ? t->next_elapse_monotonic_or_boottime - ts_monotonic : 0, 0));
437 if (t->monotonic_event_source) {
438 r = sd_event_source_set_time(t->monotonic_event_source, t->next_elapse_monotonic_or_boottime);
442 r = sd_event_source_set_enabled(t->monotonic_event_source, SD_EVENT_ONESHOT);
444 r = sd_event_add_time(
445 UNIT(t)->manager->event,
446 &t->monotonic_event_source,
447 t->wake_system ? CLOCK_BOOTTIME_ALARM : CLOCK_MONOTONIC,
448 t->next_elapse_monotonic_or_boottime, t->accuracy_usec,
453 } else if (t->monotonic_event_source) {
455 r = sd_event_source_set_enabled(t->monotonic_event_source, SD_EVENT_OFF);
460 if (found_realtime) {
461 char buf[FORMAT_TIMESTAMP_MAX];
462 log_unit_debug(UNIT(t)->id, "%s: Realtime timer elapses at %s.", UNIT(t)->id, format_timestamp(buf, sizeof(buf), t->next_elapse_realtime));
464 if (t->realtime_event_source) {
465 r = sd_event_source_set_time(t->realtime_event_source, t->next_elapse_realtime);
469 r = sd_event_source_set_enabled(t->realtime_event_source, SD_EVENT_ONESHOT);
471 r = sd_event_add_time(
472 UNIT(t)->manager->event,
473 &t->realtime_event_source,
474 t->wake_system ? CLOCK_REALTIME_ALARM : CLOCK_REALTIME,
475 t->next_elapse_realtime, t->accuracy_usec,
480 } else if (t->realtime_event_source) {
482 r = sd_event_source_set_enabled(t->realtime_event_source, SD_EVENT_OFF);
487 timer_set_state(t, TIMER_WAITING);
491 log_unit_warning_errno(UNIT(t)->id, r, "%s failed to enter waiting state: %m", UNIT(t)->id);
492 timer_enter_dead(t, TIMER_FAILURE_RESOURCES);
495 static void timer_enter_running(Timer *t) {
496 _cleanup_bus_error_free_ sd_bus_error error = SD_BUS_ERROR_NULL;
501 /* Don't start job if we are supposed to go down */
502 if (unit_stop_pending(UNIT(t)))
505 r = manager_add_job(UNIT(t)->manager, JOB_START, UNIT_TRIGGER(UNIT(t)),
506 JOB_REPLACE, true, &error, NULL);
510 dual_timestamp_get(&t->last_trigger);
513 touch_file(t->stamp_path, true, t->last_trigger.realtime, UID_INVALID, GID_INVALID, 0);
515 timer_set_state(t, TIMER_RUNNING);
519 log_unit_warning(UNIT(t)->id,
520 "%s failed to queue unit startup job: %s",
521 UNIT(t)->id, bus_error_message(&error, r));
522 timer_enter_dead(t, TIMER_FAILURE_RESOURCES);
525 static int timer_start(Unit *u) {
530 assert(t->state == TIMER_DEAD || t->state == TIMER_FAILED);
532 if (UNIT_TRIGGER(u)->load_state != UNIT_LOADED)
535 t->last_trigger = DUAL_TIMESTAMP_NULL;
537 /* Reenable all timers that depend on unit activation time */
538 LIST_FOREACH(value, v, t->values)
539 if (v->base == TIMER_ACTIVE)
545 if (stat(t->stamp_path, &st) >= 0)
546 t->last_trigger.realtime = timespec_load(&st.st_atim);
547 else if (errno == ENOENT)
548 /* The timer has never run before,
549 * make sure a stamp file exists.
551 touch_file(t->stamp_path, true, USEC_INFINITY, UID_INVALID, GID_INVALID, 0);
554 t->result = TIMER_SUCCESS;
555 timer_enter_waiting(t, true);
559 static int timer_stop(Unit *u) {
563 assert(t->state == TIMER_WAITING || t->state == TIMER_RUNNING || t->state == TIMER_ELAPSED);
565 timer_enter_dead(t, TIMER_SUCCESS);
569 static int timer_serialize(Unit *u, FILE *f, FDSet *fds) {
576 unit_serialize_item(u, f, "state", timer_state_to_string(t->state));
577 unit_serialize_item(u, f, "result", timer_result_to_string(t->result));
579 if (t->last_trigger.realtime > 0)
580 unit_serialize_item_format(u, f, "last-trigger-realtime", "%" PRIu64, t->last_trigger.realtime);
582 if (t->last_trigger.monotonic > 0)
583 unit_serialize_item_format(u, f, "last-trigger-monotonic", "%" PRIu64, t->last_trigger.monotonic);
588 static int timer_deserialize_item(Unit *u, const char *key, const char *value, FDSet *fds) {
597 if (streq(key, "state")) {
600 state = timer_state_from_string(value);
602 log_unit_debug(u->id, "Failed to parse state value %s", value);
604 t->deserialized_state = state;
605 } else if (streq(key, "result")) {
608 f = timer_result_from_string(value);
610 log_unit_debug(u->id, "Failed to parse result value %s", value);
611 else if (f != TIMER_SUCCESS)
613 } else if (streq(key, "last-trigger-realtime")) {
615 r = safe_atou64(value, &t->last_trigger.realtime);
617 log_unit_debug(u->id, "Failed to parse last-trigger-realtime value %s", value);
619 } else if (streq(key, "last-trigger-monotonic")) {
621 r = safe_atou64(value, &t->last_trigger.monotonic);
623 log_unit_debug(u->id, "Failed to parse last-trigger-monotonic value %s", value);
626 log_unit_debug(u->id, "Unknown serialization key '%s'", key);
631 _pure_ static UnitActiveState timer_active_state(Unit *u) {
634 return state_translation_table[TIMER(u)->state];
637 _pure_ static const char *timer_sub_state_to_string(Unit *u) {
640 return timer_state_to_string(TIMER(u)->state);
643 static int timer_dispatch(sd_event_source *s, uint64_t usec, void *userdata) {
644 Timer *t = TIMER(userdata);
648 if (t->state != TIMER_WAITING)
651 log_unit_debug(UNIT(t)->id, "Timer elapsed on %s", UNIT(t)->id);
652 timer_enter_running(t);
656 static void timer_trigger_notify(Unit *u, Unit *other) {
663 if (other->load_state != UNIT_LOADED)
666 /* Reenable all timers that depend on unit state */
667 LIST_FOREACH(value, v, t->values)
668 if (v->base == TIMER_UNIT_ACTIVE ||
669 v->base == TIMER_UNIT_INACTIVE)
677 /* Recalculate sleep time */
678 timer_enter_waiting(t, false);
683 if (UNIT_IS_INACTIVE_OR_FAILED(unit_active_state(other))) {
684 log_unit_debug(UNIT(t)->id, "%s got notified about unit deactivation.", UNIT(t)->id);
685 timer_enter_waiting(t, false);
694 assert_not_reached("Unknown timer state");
698 static void timer_reset_failed(Unit *u) {
703 if (t->state == TIMER_FAILED)
704 timer_set_state(t, TIMER_DEAD);
706 t->result = TIMER_SUCCESS;
709 static void timer_time_change(Unit *u) {
714 if (t->state != TIMER_WAITING)
717 log_unit_debug(u->id, "%s: time change, recalculating next elapse.", u->id);
718 timer_enter_waiting(t, false);
721 static const char* const timer_state_table[_TIMER_STATE_MAX] = {
722 [TIMER_DEAD] = "dead",
723 [TIMER_WAITING] = "waiting",
724 [TIMER_RUNNING] = "running",
725 [TIMER_ELAPSED] = "elapsed",
726 [TIMER_FAILED] = "failed"
729 DEFINE_STRING_TABLE_LOOKUP(timer_state, TimerState);
731 static const char* const timer_base_table[_TIMER_BASE_MAX] = {
732 [TIMER_ACTIVE] = "OnActiveSec",
733 [TIMER_BOOT] = "OnBootSec",
734 [TIMER_STARTUP] = "OnStartupSec",
735 [TIMER_UNIT_ACTIVE] = "OnUnitActiveSec",
736 [TIMER_UNIT_INACTIVE] = "OnUnitInactiveSec",
737 [TIMER_CALENDAR] = "OnCalendar"
740 DEFINE_STRING_TABLE_LOOKUP(timer_base, TimerBase);
742 static const char* const timer_result_table[_TIMER_RESULT_MAX] = {
743 [TIMER_SUCCESS] = "success",
744 [TIMER_FAILURE_RESOURCES] = "resources"
747 DEFINE_STRING_TABLE_LOOKUP(timer_result, TimerResult);
749 const UnitVTable timer_vtable = {
750 .object_size = sizeof(Timer),
756 .private_section = "Timer",
762 .coldplug = timer_coldplug,
766 .start = timer_start,
769 .serialize = timer_serialize,
770 .deserialize_item = timer_deserialize_item,
772 .active_state = timer_active_state,
773 .sub_state_to_string = timer_sub_state_to_string,
775 .trigger_notify = timer_trigger_notify,
777 .reset_failed = timer_reset_failed,
778 .time_change = timer_time_change,
780 .bus_interface = "org.freedesktop.systemd1.Timer",
781 .bus_vtable = bus_timer_vtable,
782 .bus_set_property = bus_timer_set_property,
784 .can_transient = true,