2 This file is part of systemd.
4 Copyright 2010 Lennart Poettering
6 systemd is free software; you can redistribute it and/or modify it
7 under the terms of the GNU Lesser General Public License as published by
8 the Free Software Foundation; either version 2.1 of the License, or
9 (at your option) any later version.
11 systemd is distributed in the hope that it will be useful, but
12 WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 Lesser General Public License for more details.
16 You should have received a copy of the GNU Lesser General Public License
17 along with systemd; If not, see <http://www.gnu.org/licenses/>.
22 #include "alloc-util.h"
23 #include "bus-error.h"
25 #include "dbus-timer.h"
27 #include "parse-util.h"
28 #include "random-util.h"
30 #include "string-table.h"
31 #include "string-util.h"
33 #include "unit-name.h"
35 #include "user-util.h"
38 static const UnitActiveState state_translation_table
[_TIMER_STATE_MAX
] = {
39 [TIMER_DEAD
] = UNIT_INACTIVE
,
40 [TIMER_WAITING
] = UNIT_ACTIVE
,
41 [TIMER_RUNNING
] = UNIT_ACTIVE
,
42 [TIMER_ELAPSED
] = UNIT_ACTIVE
,
43 [TIMER_FAILED
] = UNIT_FAILED
46 static int timer_dispatch(sd_event_source
*s
, uint64_t usec
, void *userdata
);
48 static void timer_init(Unit
*u
) {
52 assert(u
->load_state
== UNIT_STUB
);
54 t
->next_elapse_monotonic_or_boottime
= USEC_INFINITY
;
55 t
->next_elapse_realtime
= USEC_INFINITY
;
56 t
->accuracy_usec
= u
->manager
->default_timer_accuracy_usec
;
57 t
->remain_after_elapse
= true;
60 void timer_free_values(Timer
*t
) {
65 while ((v
= t
->values
)) {
66 LIST_REMOVE(value
, t
->values
, v
);
67 calendar_spec_free(v
->calendar_spec
);
72 static void timer_done(Unit
*u
) {
79 t
->monotonic_event_source
= sd_event_source_unref(t
->monotonic_event_source
);
80 t
->realtime_event_source
= sd_event_source_unref(t
->realtime_event_source
);
85 static int timer_verify(Timer
*t
) {
88 if (UNIT(t
)->load_state
!= UNIT_LOADED
)
92 log_unit_error(UNIT(t
), "Timer unit lacks value setting. Refusing.");
99 static int timer_add_default_dependencies(Timer
*t
) {
105 if (!UNIT(t
)->default_dependencies
)
108 r
= unit_add_dependency_by_name(UNIT(t
), UNIT_BEFORE
, SPECIAL_TIMERS_TARGET
, NULL
, true);
112 if (MANAGER_IS_SYSTEM(UNIT(t
)->manager
)) {
113 r
= unit_add_two_dependencies_by_name(UNIT(t
), UNIT_AFTER
, UNIT_REQUIRES
, SPECIAL_SYSINIT_TARGET
, NULL
, true);
117 LIST_FOREACH(value
, v
, t
->values
) {
118 if (v
->base
== TIMER_CALENDAR
) {
119 r
= unit_add_dependency_by_name(UNIT(t
), UNIT_AFTER
, SPECIAL_TIME_SYNC_TARGET
, NULL
, true);
127 return unit_add_two_dependencies_by_name(UNIT(t
), UNIT_BEFORE
, UNIT_CONFLICTS
, SPECIAL_SHUTDOWN_TARGET
, NULL
, true);
130 static int timer_setup_persistent(Timer
*t
) {
138 if (MANAGER_IS_SYSTEM(UNIT(t
)->manager
)) {
140 r
= unit_require_mounts_for(UNIT(t
), "/var/lib/systemd/timers");
144 t
->stamp_path
= strappend("/var/lib/systemd/timers/stamp-", UNIT(t
)->id
);
148 e
= getenv("XDG_DATA_HOME");
150 t
->stamp_path
= strjoin(e
, "/systemd/timers/stamp-", UNIT(t
)->id
);
153 _cleanup_free_
char *h
= NULL
;
155 r
= get_home_dir(&h
);
157 return log_unit_error_errno(UNIT(t
), r
, "Failed to determine home directory: %m");
159 t
->stamp_path
= strjoin(h
, "/.local/share/systemd/timers/stamp-", UNIT(t
)->id
);
169 static int timer_load(Unit
*u
) {
174 assert(u
->load_state
== UNIT_STUB
);
176 r
= unit_load_fragment_and_dropin(u
);
180 if (u
->load_state
== UNIT_LOADED
) {
182 if (set_isempty(u
->dependencies
[UNIT_TRIGGERS
])) {
185 r
= unit_load_related_unit(u
, ".service", &x
);
189 r
= unit_add_two_dependencies(u
, UNIT_BEFORE
, UNIT_TRIGGERS
, x
, true);
194 r
= timer_setup_persistent(t
);
198 r
= timer_add_default_dependencies(t
);
203 return timer_verify(t
);
206 static void timer_dump(Unit
*u
, FILE *f
, const char *prefix
) {
207 char buf
[FORMAT_TIMESPAN_MAX
];
212 trigger
= UNIT_TRIGGER(u
);
215 "%sTimer State: %s\n"
221 "%sRemainAfterElapse: %s\n",
222 prefix
, timer_state_to_string(t
->state
),
223 prefix
, timer_result_to_string(t
->result
),
224 prefix
, trigger
? trigger
->id
: "n/a",
225 prefix
, yes_no(t
->persistent
),
226 prefix
, yes_no(t
->wake_system
),
227 prefix
, format_timespan(buf
, sizeof(buf
), t
->accuracy_usec
, 1),
228 prefix
, yes_no(t
->remain_after_elapse
));
230 LIST_FOREACH(value
, v
, t
->values
) {
232 if (v
->base
== TIMER_CALENDAR
) {
233 _cleanup_free_
char *p
= NULL
;
235 (void) calendar_spec_to_string(v
->calendar_spec
, &p
);
240 timer_base_to_string(v
->base
),
243 char timespan1
[FORMAT_TIMESPAN_MAX
];
248 timer_base_to_string(v
->base
),
249 format_timespan(timespan1
, sizeof(timespan1
), v
->value
, 0));
254 static void timer_set_state(Timer
*t
, TimerState state
) {
255 TimerState old_state
;
258 old_state
= t
->state
;
261 if (state
!= TIMER_WAITING
) {
262 t
->monotonic_event_source
= sd_event_source_unref(t
->monotonic_event_source
);
263 t
->realtime_event_source
= sd_event_source_unref(t
->realtime_event_source
);
264 t
->next_elapse_monotonic_or_boottime
= USEC_INFINITY
;
265 t
->next_elapse_realtime
= USEC_INFINITY
;
268 if (state
!= old_state
)
269 log_unit_debug(UNIT(t
), "Changed %s -> %s", timer_state_to_string(old_state
), timer_state_to_string(state
));
271 unit_notify(UNIT(t
), state_translation_table
[old_state
], state_translation_table
[state
], true);
274 static void timer_enter_waiting(Timer
*t
, bool initial
);
276 static int timer_coldplug(Unit
*u
) {
280 assert(t
->state
== TIMER_DEAD
);
282 if (t
->deserialized_state
== t
->state
)
285 if (t
->deserialized_state
== TIMER_WAITING
)
286 timer_enter_waiting(t
, false);
288 timer_set_state(t
, t
->deserialized_state
);
293 static void timer_enter_dead(Timer
*t
, TimerResult f
) {
296 if (t
->result
== TIMER_SUCCESS
)
299 if (t
->result
!= TIMER_SUCCESS
)
300 log_unit_warning(UNIT(t
), "Failed with result '%s'.", timer_result_to_string(t
->result
));
302 timer_set_state(t
, t
->result
!= TIMER_SUCCESS
? TIMER_FAILED
: TIMER_DEAD
);
305 static void timer_enter_elapsed(Timer
*t
, bool leave_around
) {
308 /* If a unit is marked with RemainAfterElapse=yes we leave it
309 * around even after it elapsed once, so that starting it
310 * later again does not necessarily mean immediate
311 * retriggering. We unconditionally leave units with
312 * TIMER_UNIT_ACTIVE or TIMER_UNIT_INACTIVE triggers around,
313 * since they might be restarted automatically at any time
316 if (t
->remain_after_elapse
|| leave_around
)
317 timer_set_state(t
, TIMER_ELAPSED
);
319 timer_enter_dead(t
, TIMER_SUCCESS
);
322 static void add_random(Timer
*t
, usec_t
*v
) {
323 char s
[FORMAT_TIMESPAN_MAX
];
329 if (t
->random_usec
== 0)
331 if (*v
== USEC_INFINITY
)
334 add
= random_u64() % t
->random_usec
;
336 if (*v
+ add
< *v
) /* overflow */
337 *v
= (usec_t
) -2; /* Highest possible value, that is not USEC_INFINITY */
341 log_unit_debug(UNIT(t
), "Adding %s random time.", format_timespan(s
, sizeof(s
), add
, 0));
344 static void timer_enter_waiting(Timer
*t
, bool initial
) {
345 bool found_monotonic
= false, found_realtime
= false;
346 bool leave_around
= false;
355 trigger
= UNIT_TRIGGER(UNIT(t
));
357 log_unit_error(UNIT(t
), "Unit to trigger vanished.");
358 timer_enter_dead(t
, TIMER_FAILURE_RESOURCES
);
362 triple_timestamp_get(&ts
);
363 t
->next_elapse_monotonic_or_boottime
= t
->next_elapse_realtime
= 0;
365 LIST_FOREACH(value
, v
, t
->values
) {
370 if (v
->base
== TIMER_CALENDAR
) {
373 /* If we know the last time this was
374 * triggered, schedule the job based relative
375 * to that. If we don't just start from
378 b
= t
->last_trigger
.realtime
> 0 ? t
->last_trigger
.realtime
: ts
.realtime
;
380 r
= calendar_spec_next_usec(v
->calendar_spec
, b
, &v
->next_elapse
);
385 t
->next_elapse_realtime
= v
->next_elapse
;
387 t
->next_elapse_realtime
= MIN(t
->next_elapse_realtime
, v
->next_elapse
);
389 found_realtime
= true;
396 if (state_translation_table
[t
->state
] == UNIT_ACTIVE
)
397 base
= UNIT(t
)->inactive_exit_timestamp
.monotonic
;
403 if (detect_container() <= 0) {
404 /* CLOCK_MONOTONIC equals the uptime on Linux */
408 /* In a container we don't want to include the time the host
409 * was already up when the container started, so count from
410 * our own startup. */
413 base
= UNIT(t
)->manager
->userspace_timestamp
.monotonic
;
416 case TIMER_UNIT_ACTIVE
:
418 base
= trigger
->inactive_exit_timestamp
.monotonic
;
421 base
= t
->last_trigger
.monotonic
;
428 case TIMER_UNIT_INACTIVE
:
430 base
= trigger
->inactive_enter_timestamp
.monotonic
;
433 base
= t
->last_trigger
.monotonic
;
441 assert_not_reached("Unknown timer base");
444 v
->next_elapse
= usec_add(usec_shift_clock(base
, CLOCK_MONOTONIC
, TIMER_MONOTONIC_CLOCK(t
)), v
->value
);
447 v
->next_elapse
< triple_timestamp_by_clock(&ts
, TIMER_MONOTONIC_CLOCK(t
)) &&
448 IN_SET(v
->base
, TIMER_ACTIVE
, TIMER_BOOT
, TIMER_STARTUP
)) {
449 /* This is a one time trigger, disable it now */
454 if (!found_monotonic
)
455 t
->next_elapse_monotonic_or_boottime
= v
->next_elapse
;
457 t
->next_elapse_monotonic_or_boottime
= MIN(t
->next_elapse_monotonic_or_boottime
, v
->next_elapse
);
459 found_monotonic
= true;
463 if (!found_monotonic
&& !found_realtime
) {
464 log_unit_debug(UNIT(t
), "Timer is elapsed.");
465 timer_enter_elapsed(t
, leave_around
);
469 if (found_monotonic
) {
470 char buf
[FORMAT_TIMESPAN_MAX
];
473 add_random(t
, &t
->next_elapse_monotonic_or_boottime
);
475 left
= usec_sub_unsigned(t
->next_elapse_monotonic_or_boottime
, triple_timestamp_by_clock(&ts
, TIMER_MONOTONIC_CLOCK(t
)));
476 log_unit_debug(UNIT(t
), "Monotonic timer elapses in %s.", format_timespan(buf
, sizeof(buf
), left
, 0));
478 if (t
->monotonic_event_source
) {
479 r
= sd_event_source_set_time(t
->monotonic_event_source
, t
->next_elapse_monotonic_or_boottime
);
483 r
= sd_event_source_set_enabled(t
->monotonic_event_source
, SD_EVENT_ONESHOT
);
488 r
= sd_event_add_time(
489 UNIT(t
)->manager
->event
,
490 &t
->monotonic_event_source
,
491 t
->wake_system
? CLOCK_BOOTTIME_ALARM
: CLOCK_MONOTONIC
,
492 t
->next_elapse_monotonic_or_boottime
, t
->accuracy_usec
,
497 (void) sd_event_source_set_description(t
->monotonic_event_source
, "timer-monotonic");
500 } else if (t
->monotonic_event_source
) {
502 r
= sd_event_source_set_enabled(t
->monotonic_event_source
, SD_EVENT_OFF
);
507 if (found_realtime
) {
508 char buf
[FORMAT_TIMESTAMP_MAX
];
510 add_random(t
, &t
->next_elapse_realtime
);
512 log_unit_debug(UNIT(t
), "Realtime timer elapses at %s.", format_timestamp(buf
, sizeof(buf
), t
->next_elapse_realtime
));
514 if (t
->realtime_event_source
) {
515 r
= sd_event_source_set_time(t
->realtime_event_source
, t
->next_elapse_realtime
);
519 r
= sd_event_source_set_enabled(t
->realtime_event_source
, SD_EVENT_ONESHOT
);
523 r
= sd_event_add_time(
524 UNIT(t
)->manager
->event
,
525 &t
->realtime_event_source
,
526 t
->wake_system
? CLOCK_REALTIME_ALARM
: CLOCK_REALTIME
,
527 t
->next_elapse_realtime
, t
->accuracy_usec
,
532 (void) sd_event_source_set_description(t
->realtime_event_source
, "timer-realtime");
535 } else if (t
->realtime_event_source
) {
537 r
= sd_event_source_set_enabled(t
->realtime_event_source
, SD_EVENT_OFF
);
542 timer_set_state(t
, TIMER_WAITING
);
546 log_unit_warning_errno(UNIT(t
), r
, "Failed to enter waiting state: %m");
547 timer_enter_dead(t
, TIMER_FAILURE_RESOURCES
);
550 static void timer_enter_running(Timer
*t
) {
551 _cleanup_(sd_bus_error_free
) sd_bus_error error
= SD_BUS_ERROR_NULL
;
557 /* Don't start job if we are supposed to go down */
558 if (unit_stop_pending(UNIT(t
)))
561 trigger
= UNIT_TRIGGER(UNIT(t
));
563 log_unit_error(UNIT(t
), "Unit to trigger vanished.");
564 timer_enter_dead(t
, TIMER_FAILURE_RESOURCES
);
568 r
= manager_add_job(UNIT(t
)->manager
, JOB_START
, trigger
, JOB_REPLACE
, &error
, NULL
);
572 dual_timestamp_get(&t
->last_trigger
);
575 touch_file(t
->stamp_path
, true, t
->last_trigger
.realtime
, UID_INVALID
, GID_INVALID
, MODE_INVALID
);
577 timer_set_state(t
, TIMER_RUNNING
);
581 log_unit_warning(UNIT(t
), "Failed to queue unit startup job: %s", bus_error_message(&error
, r
));
582 timer_enter_dead(t
, TIMER_FAILURE_RESOURCES
);
585 static int timer_start(Unit
*u
) {
592 assert(t
->state
== TIMER_DEAD
|| t
->state
== TIMER_FAILED
);
594 trigger
= UNIT_TRIGGER(u
);
595 if (!trigger
|| trigger
->load_state
!= UNIT_LOADED
) {
596 log_unit_error(u
, "Refusing to start, unit to trigger not loaded.");
600 r
= unit_start_limit_test(u
);
602 timer_enter_dead(t
, TIMER_FAILURE_START_LIMIT_HIT
);
606 r
= unit_acquire_invocation_id(u
);
610 t
->last_trigger
= DUAL_TIMESTAMP_NULL
;
612 /* Reenable all timers that depend on unit activation time */
613 LIST_FOREACH(value
, v
, t
->values
)
614 if (v
->base
== TIMER_ACTIVE
)
620 if (stat(t
->stamp_path
, &st
) >= 0) {
623 /* Load the file timestamp, but only if it is actually in the past. If it is in the future,
624 * something is wrong with the system clock. */
626 ft
= timespec_load(&st
.st_mtim
);
627 if (ft
< now(CLOCK_REALTIME
))
628 t
->last_trigger
.realtime
= ft
;
630 char z
[FORMAT_TIMESTAMP_MAX
];
632 log_unit_warning(u
, "Not using persistent file timestamp %s as it is in the future.",
633 format_timestamp(z
, sizeof(z
), ft
));
636 } else if (errno
== ENOENT
)
637 /* The timer has never run before,
638 * make sure a stamp file exists.
640 (void) touch_file(t
->stamp_path
, true, USEC_INFINITY
, UID_INVALID
, GID_INVALID
, MODE_INVALID
);
643 t
->result
= TIMER_SUCCESS
;
644 timer_enter_waiting(t
, true);
648 static int timer_stop(Unit
*u
) {
652 assert(t
->state
== TIMER_WAITING
|| t
->state
== TIMER_RUNNING
|| t
->state
== TIMER_ELAPSED
);
654 timer_enter_dead(t
, TIMER_SUCCESS
);
658 static int timer_serialize(Unit
*u
, FILE *f
, FDSet
*fds
) {
665 unit_serialize_item(u
, f
, "state", timer_state_to_string(t
->state
));
666 unit_serialize_item(u
, f
, "result", timer_result_to_string(t
->result
));
668 if (t
->last_trigger
.realtime
> 0)
669 unit_serialize_item_format(u
, f
, "last-trigger-realtime", "%" PRIu64
, t
->last_trigger
.realtime
);
671 if (t
->last_trigger
.monotonic
> 0)
672 unit_serialize_item_format(u
, f
, "last-trigger-monotonic", "%" PRIu64
, t
->last_trigger
.monotonic
);
677 static int timer_deserialize_item(Unit
*u
, const char *key
, const char *value
, FDSet
*fds
) {
686 if (streq(key
, "state")) {
689 state
= timer_state_from_string(value
);
691 log_unit_debug(u
, "Failed to parse state value: %s", value
);
693 t
->deserialized_state
= state
;
694 } else if (streq(key
, "result")) {
697 f
= timer_result_from_string(value
);
699 log_unit_debug(u
, "Failed to parse result value: %s", value
);
700 else if (f
!= TIMER_SUCCESS
)
702 } else if (streq(key
, "last-trigger-realtime")) {
704 r
= safe_atou64(value
, &t
->last_trigger
.realtime
);
706 log_unit_debug(u
, "Failed to parse last-trigger-realtime value: %s", value
);
708 } else if (streq(key
, "last-trigger-monotonic")) {
710 r
= safe_atou64(value
, &t
->last_trigger
.monotonic
);
712 log_unit_debug(u
, "Failed to parse last-trigger-monotonic value: %s", value
);
715 log_unit_debug(u
, "Unknown serialization key: %s", key
);
720 _pure_
static UnitActiveState
timer_active_state(Unit
*u
) {
723 return state_translation_table
[TIMER(u
)->state
];
726 _pure_
static const char *timer_sub_state_to_string(Unit
*u
) {
729 return timer_state_to_string(TIMER(u
)->state
);
732 static int timer_dispatch(sd_event_source
*s
, uint64_t usec
, void *userdata
) {
733 Timer
*t
= TIMER(userdata
);
737 if (t
->state
!= TIMER_WAITING
)
740 log_unit_debug(UNIT(t
), "Timer elapsed.");
741 timer_enter_running(t
);
745 static void timer_trigger_notify(Unit
*u
, Unit
*other
) {
752 if (other
->load_state
!= UNIT_LOADED
)
755 /* Reenable all timers that depend on unit state */
756 LIST_FOREACH(value
, v
, t
->values
)
757 if (v
->base
== TIMER_UNIT_ACTIVE
||
758 v
->base
== TIMER_UNIT_INACTIVE
)
766 /* Recalculate sleep time */
767 timer_enter_waiting(t
, false);
772 if (UNIT_IS_INACTIVE_OR_FAILED(unit_active_state(other
))) {
773 log_unit_debug(UNIT(t
), "Got notified about unit deactivation.");
774 timer_enter_waiting(t
, false);
783 assert_not_reached("Unknown timer state");
787 static void timer_reset_failed(Unit
*u
) {
792 if (t
->state
== TIMER_FAILED
)
793 timer_set_state(t
, TIMER_DEAD
);
795 t
->result
= TIMER_SUCCESS
;
798 static void timer_time_change(Unit
*u
) {
803 if (t
->state
!= TIMER_WAITING
)
806 log_unit_debug(u
, "Time change, recalculating next elapse.");
807 timer_enter_waiting(t
, false);
810 static const char* const timer_base_table
[_TIMER_BASE_MAX
] = {
811 [TIMER_ACTIVE
] = "OnActiveSec",
812 [TIMER_BOOT
] = "OnBootSec",
813 [TIMER_STARTUP
] = "OnStartupSec",
814 [TIMER_UNIT_ACTIVE
] = "OnUnitActiveSec",
815 [TIMER_UNIT_INACTIVE
] = "OnUnitInactiveSec",
816 [TIMER_CALENDAR
] = "OnCalendar"
819 DEFINE_STRING_TABLE_LOOKUP(timer_base
, TimerBase
);
821 static const char* const timer_result_table
[_TIMER_RESULT_MAX
] = {
822 [TIMER_SUCCESS
] = "success",
823 [TIMER_FAILURE_RESOURCES
] = "resources",
824 [TIMER_FAILURE_START_LIMIT_HIT
] = "start-limit-hit",
827 DEFINE_STRING_TABLE_LOOKUP(timer_result
, TimerResult
);
829 const UnitVTable timer_vtable
= {
830 .object_size
= sizeof(Timer
),
836 .private_section
= "Timer",
842 .coldplug
= timer_coldplug
,
846 .start
= timer_start
,
849 .serialize
= timer_serialize
,
850 .deserialize_item
= timer_deserialize_item
,
852 .active_state
= timer_active_state
,
853 .sub_state_to_string
= timer_sub_state_to_string
,
855 .trigger_notify
= timer_trigger_notify
,
857 .reset_failed
= timer_reset_failed
,
858 .time_change
= timer_time_change
,
860 .bus_vtable
= bus_timer_vtable
,
861 .bus_set_property
= bus_timer_set_property
,
863 .can_transient
= true,