]>
Commit | Line | Data |
---|---|---|
53e1b683 | 1 | /* SPDX-License-Identifier: LGPL-2.1+ */ |
a7334b09 LP |
2 | /*** |
3 | This file is part of systemd. | |
4 | ||
5 | Copyright 2010 Lennart Poettering | |
a7334b09 LP |
6 | ***/ |
7 | ||
d46de8a1 LP |
8 | #include <errno.h> |
9 | ||
b5efdb8a | 10 | #include "alloc-util.h" |
07630cea LP |
11 | #include "bus-error.h" |
12 | #include "bus-util.h" | |
871d7de4 | 13 | #include "dbus-timer.h" |
f4f15635 | 14 | #include "fs-util.h" |
6bedfcbb | 15 | #include "parse-util.h" |
744c7693 | 16 | #include "random-util.h" |
a40eb732 | 17 | #include "special.h" |
8b43440b | 18 | #include "string-table.h" |
07630cea | 19 | #include "string-util.h" |
b1d4f8e1 | 20 | #include "timer.h" |
07630cea LP |
21 | #include "unit-name.h" |
22 | #include "unit.h" | |
b1d4f8e1 | 23 | #include "user-util.h" |
c1d9ba99 | 24 | #include "virt.h" |
871d7de4 LP |
25 | |
26 | static const UnitActiveState state_translation_table[_TIMER_STATE_MAX] = { | |
27 | [TIMER_DEAD] = UNIT_INACTIVE, | |
28 | [TIMER_WAITING] = UNIT_ACTIVE, | |
29 | [TIMER_RUNNING] = UNIT_ACTIVE, | |
30 | [TIMER_ELAPSED] = UNIT_ACTIVE, | |
fdf20a31 | 31 | [TIMER_FAILED] = UNIT_FAILED |
871d7de4 LP |
32 | }; |
33 | ||
718db961 LP |
34 | static int timer_dispatch(sd_event_source *s, uint64_t usec, void *userdata); |
35 | ||
871d7de4 LP |
36 | static void timer_init(Unit *u) { |
37 | Timer *t = TIMER(u); | |
38 | ||
39 | assert(u); | |
ac155bb8 | 40 | assert(u->load_state == UNIT_STUB); |
871d7de4 | 41 | |
3a43da28 KS |
42 | t->next_elapse_monotonic_or_boottime = USEC_INFINITY; |
43 | t->next_elapse_realtime = USEC_INFINITY; | |
bd8f585b | 44 | t->accuracy_usec = u->manager->default_timer_accuracy_usec; |
3e0c30ac | 45 | t->remain_after_elapse = true; |
871d7de4 | 46 | } |
5cb5a6ff | 47 | |
74051b9b | 48 | void timer_free_values(Timer *t) { |
871d7de4 LP |
49 | TimerValue *v; |
50 | ||
51 | assert(t); | |
52 | ||
53 | while ((v = t->values)) { | |
71fda00f | 54 | LIST_REMOVE(value, t->values, v); |
3e044c49 | 55 | calendar_spec_free(v->calendar_spec); |
871d7de4 LP |
56 | free(v); |
57 | } | |
74051b9b LP |
58 | } |
59 | ||
60 | static void timer_done(Unit *u) { | |
61 | Timer *t = TIMER(u); | |
62 | ||
63 | assert(t); | |
64 | ||
65 | timer_free_values(t); | |
871d7de4 | 66 | |
718db961 LP |
67 | t->monotonic_event_source = sd_event_source_unref(t->monotonic_event_source); |
68 | t->realtime_event_source = sd_event_source_unref(t->realtime_event_source); | |
06642d17 LP |
69 | |
70 | free(t->stamp_path); | |
871d7de4 LP |
71 | } |
72 | ||
73 | static int timer_verify(Timer *t) { | |
74 | assert(t); | |
75 | ||
1124fe6f | 76 | if (UNIT(t)->load_state != UNIT_LOADED) |
871d7de4 LP |
77 | return 0; |
78 | ||
79 | if (!t->values) { | |
f2341e0a | 80 | log_unit_error(UNIT(t), "Timer unit lacks value setting. Refusing."); |
871d7de4 LP |
81 | return -EINVAL; |
82 | } | |
83 | ||
84 | return 0; | |
85 | } | |
86 | ||
6c155fe3 LP |
87 | static int timer_add_default_dependencies(Timer *t) { |
88 | int r; | |
19f8d037 | 89 | TimerValue *v; |
6c155fe3 LP |
90 | |
91 | assert(t); | |
92 | ||
4c9ea260 LP |
93 | if (!UNIT(t)->default_dependencies) |
94 | return 0; | |
95 | ||
eef85c4a | 96 | r = unit_add_dependency_by_name(UNIT(t), UNIT_BEFORE, SPECIAL_TIMERS_TARGET, NULL, true, UNIT_DEPENDENCY_DEFAULT); |
e3d84721 LP |
97 | if (r < 0) |
98 | return r; | |
2a77d31d | 99 | |
463d0d15 | 100 | if (MANAGER_IS_SYSTEM(UNIT(t)->manager)) { |
eef85c4a | 101 | r = unit_add_two_dependencies_by_name(UNIT(t), UNIT_AFTER, UNIT_REQUIRES, SPECIAL_SYSINIT_TARGET, NULL, true, UNIT_DEPENDENCY_DEFAULT); |
36697dc0 | 102 | if (r < 0) |
6c155fe3 | 103 | return r; |
19f8d037 TGR |
104 | |
105 | LIST_FOREACH(value, v, t->values) { | |
106 | if (v->base == TIMER_CALENDAR) { | |
eef85c4a | 107 | r = unit_add_dependency_by_name(UNIT(t), UNIT_AFTER, SPECIAL_TIME_SYNC_TARGET, NULL, true, UNIT_DEPENDENCY_DEFAULT); |
19f8d037 TGR |
108 | if (r < 0) |
109 | return r; | |
110 | break; | |
111 | } | |
112 | } | |
2a77d31d | 113 | } |
6c155fe3 | 114 | |
eef85c4a LP |
115 | return unit_add_two_dependencies_by_name(UNIT(t), UNIT_BEFORE, UNIT_CONFLICTS, SPECIAL_SHUTDOWN_TARGET, NULL, true, UNIT_DEPENDENCY_DEFAULT); |
116 | } | |
117 | ||
118 | static int timer_add_trigger_dependencies(Timer *t) { | |
119 | Unit *x; | |
120 | int r; | |
121 | ||
122 | assert(t); | |
123 | ||
124 | if (!hashmap_isempty(UNIT(t)->dependencies[UNIT_TRIGGERS])) | |
125 | return 0; | |
126 | ||
127 | r = unit_load_related_unit(UNIT(t), ".service", &x); | |
128 | if (r < 0) | |
129 | return r; | |
130 | ||
131 | return unit_add_two_dependencies(UNIT(t), UNIT_BEFORE, UNIT_TRIGGERS, x, true, UNIT_DEPENDENCY_IMPLICIT); | |
6c155fe3 LP |
132 | } |
133 | ||
06642d17 LP |
134 | static int timer_setup_persistent(Timer *t) { |
135 | int r; | |
136 | ||
137 | assert(t); | |
138 | ||
139 | if (!t->persistent) | |
140 | return 0; | |
141 | ||
463d0d15 | 142 | if (MANAGER_IS_SYSTEM(UNIT(t)->manager)) { |
06642d17 | 143 | |
eef85c4a | 144 | r = unit_require_mounts_for(UNIT(t), "/var/lib/systemd/timers", UNIT_DEPENDENCY_FILE); |
06642d17 LP |
145 | if (r < 0) |
146 | return r; | |
147 | ||
148 | t->stamp_path = strappend("/var/lib/systemd/timers/stamp-", UNIT(t)->id); | |
149 | } else { | |
150 | const char *e; | |
151 | ||
152 | e = getenv("XDG_DATA_HOME"); | |
153 | if (e) | |
605405c6 | 154 | t->stamp_path = strjoin(e, "/systemd/timers/stamp-", UNIT(t)->id); |
06642d17 LP |
155 | else { |
156 | ||
157 | _cleanup_free_ char *h = NULL; | |
158 | ||
159 | r = get_home_dir(&h); | |
23bbb0de | 160 | if (r < 0) |
f2341e0a | 161 | return log_unit_error_errno(UNIT(t), r, "Failed to determine home directory: %m"); |
06642d17 | 162 | |
605405c6 | 163 | t->stamp_path = strjoin(h, "/.local/share/systemd/timers/stamp-", UNIT(t)->id); |
06642d17 LP |
164 | } |
165 | } | |
166 | ||
167 | if (!t->stamp_path) | |
168 | return log_oom(); | |
169 | ||
170 | return 0; | |
171 | } | |
172 | ||
871d7de4 LP |
173 | static int timer_load(Unit *u) { |
174 | Timer *t = TIMER(u); | |
175 | int r; | |
176 | ||
177 | assert(u); | |
ac155bb8 | 178 | assert(u->load_state == UNIT_STUB); |
871d7de4 | 179 | |
36697dc0 LP |
180 | r = unit_load_fragment_and_dropin(u); |
181 | if (r < 0) | |
871d7de4 LP |
182 | return r; |
183 | ||
ac155bb8 | 184 | if (u->load_state == UNIT_LOADED) { |
871d7de4 | 185 | |
eef85c4a LP |
186 | r = timer_add_trigger_dependencies(t); |
187 | if (r < 0) | |
188 | return r; | |
57020a3a | 189 | |
06642d17 LP |
190 | r = timer_setup_persistent(t); |
191 | if (r < 0) | |
192 | return r; | |
193 | ||
4c9ea260 LP |
194 | r = timer_add_default_dependencies(t); |
195 | if (r < 0) | |
196 | return r; | |
871d7de4 LP |
197 | } |
198 | ||
199 | return timer_verify(t); | |
200 | } | |
201 | ||
202 | static void timer_dump(Unit *u, FILE *f, const char *prefix) { | |
9f5eb56a | 203 | char buf[FORMAT_TIMESPAN_MAX]; |
871d7de4 | 204 | Timer *t = TIMER(u); |
3ecaa09b | 205 | Unit *trigger; |
871d7de4 | 206 | TimerValue *v; |
034c6ed7 | 207 | |
3ecaa09b LP |
208 | trigger = UNIT_TRIGGER(u); |
209 | ||
871d7de4 LP |
210 | fprintf(f, |
211 | "%sTimer State: %s\n" | |
067d72c9 | 212 | "%sResult: %s\n" |
9f5eb56a | 213 | "%sUnit: %s\n" |
dedabea4 LP |
214 | "%sPersistent: %s\n" |
215 | "%sWakeSystem: %s\n" | |
3e0c30ac LP |
216 | "%sAccuracy: %s\n" |
217 | "%sRemainAfterElapse: %s\n", | |
871d7de4 | 218 | prefix, timer_state_to_string(t->state), |
067d72c9 | 219 | prefix, timer_result_to_string(t->result), |
9f5eb56a | 220 | prefix, trigger ? trigger->id : "n/a", |
dedabea4 LP |
221 | prefix, yes_no(t->persistent), |
222 | prefix, yes_no(t->wake_system), | |
3e0c30ac LP |
223 | prefix, format_timespan(buf, sizeof(buf), t->accuracy_usec, 1), |
224 | prefix, yes_no(t->remain_after_elapse)); | |
871d7de4 | 225 | |
36697dc0 LP |
226 | LIST_FOREACH(value, v, t->values) { |
227 | ||
228 | if (v->base == TIMER_CALENDAR) { | |
229 | _cleanup_free_ char *p = NULL; | |
230 | ||
25cb94d4 | 231 | (void) calendar_spec_to_string(v->calendar_spec, &p); |
36697dc0 LP |
232 | |
233 | fprintf(f, | |
234 | "%s%s: %s\n", | |
235 | prefix, | |
236 | timer_base_to_string(v->base), | |
237 | strna(p)); | |
238 | } else { | |
239 | char timespan1[FORMAT_TIMESPAN_MAX]; | |
240 | ||
241 | fprintf(f, | |
242 | "%s%s: %s\n", | |
243 | prefix, | |
244 | timer_base_to_string(v->base), | |
b1d6dcf5 | 245 | format_timespan(timespan1, sizeof(timespan1), v->value, 0)); |
36697dc0 LP |
246 | } |
247 | } | |
871d7de4 LP |
248 | } |
249 | ||
250 | static void timer_set_state(Timer *t, TimerState state) { | |
251 | TimerState old_state; | |
034c6ed7 | 252 | assert(t); |
871d7de4 LP |
253 | |
254 | old_state = t->state; | |
255 | t->state = state; | |
256 | ||
36697dc0 | 257 | if (state != TIMER_WAITING) { |
718db961 LP |
258 | t->monotonic_event_source = sd_event_source_unref(t->monotonic_event_source); |
259 | t->realtime_event_source = sd_event_source_unref(t->realtime_event_source); | |
6e2c9ce1 ZJS |
260 | t->next_elapse_monotonic_or_boottime = USEC_INFINITY; |
261 | t->next_elapse_realtime = USEC_INFINITY; | |
36697dc0 | 262 | } |
871d7de4 LP |
263 | |
264 | if (state != old_state) | |
f2341e0a | 265 | log_unit_debug(UNIT(t), "Changed %s -> %s", timer_state_to_string(old_state), timer_state_to_string(state)); |
871d7de4 | 266 | |
2ad2e41a | 267 | unit_notify(UNIT(t), state_translation_table[old_state], state_translation_table[state], 0); |
871d7de4 LP |
268 | } |
269 | ||
270 | static void timer_enter_waiting(Timer *t, bool initial); | |
271 | ||
be847e82 | 272 | static int timer_coldplug(Unit *u) { |
871d7de4 LP |
273 | Timer *t = TIMER(u); |
274 | ||
275 | assert(t); | |
276 | assert(t->state == TIMER_DEAD); | |
277 | ||
3e0c30ac LP |
278 | if (t->deserialized_state == t->state) |
279 | return 0; | |
871d7de4 | 280 | |
3e0c30ac LP |
281 | if (t->deserialized_state == TIMER_WAITING) |
282 | timer_enter_waiting(t, false); | |
283 | else | |
284 | timer_set_state(t, t->deserialized_state); | |
871d7de4 LP |
285 | |
286 | return 0; | |
287 | } | |
288 | ||
067d72c9 | 289 | static void timer_enter_dead(Timer *t, TimerResult f) { |
871d7de4 LP |
290 | assert(t); |
291 | ||
a0fef983 | 292 | if (t->result == TIMER_SUCCESS) |
067d72c9 | 293 | t->result = f; |
871d7de4 | 294 | |
ed77d407 LP |
295 | if (t->result != TIMER_SUCCESS) |
296 | log_unit_warning(UNIT(t), "Failed with result '%s'.", timer_result_to_string(t->result)); | |
297 | ||
067d72c9 | 298 | timer_set_state(t, t->result != TIMER_SUCCESS ? TIMER_FAILED : TIMER_DEAD); |
871d7de4 LP |
299 | } |
300 | ||
3e0c30ac LP |
301 | static void timer_enter_elapsed(Timer *t, bool leave_around) { |
302 | assert(t); | |
303 | ||
304 | /* If a unit is marked with RemainAfterElapse=yes we leave it | |
305 | * around even after it elapsed once, so that starting it | |
306 | * later again does not necessarily mean immediate | |
307 | * retriggering. We unconditionally leave units with | |
308 | * TIMER_UNIT_ACTIVE or TIMER_UNIT_INACTIVE triggers around, | |
309 | * since they might be restarted automatically at any time | |
310 | * later on. */ | |
311 | ||
312 | if (t->remain_after_elapse || leave_around) | |
313 | timer_set_state(t, TIMER_ELAPSED); | |
314 | else | |
315 | timer_enter_dead(t, TIMER_SUCCESS); | |
316 | } | |
317 | ||
744c7693 LP |
318 | static void add_random(Timer *t, usec_t *v) { |
319 | char s[FORMAT_TIMESPAN_MAX]; | |
320 | usec_t add; | |
321 | ||
322 | assert(t); | |
3f51aec8 | 323 | assert(v); |
744c7693 LP |
324 | |
325 | if (t->random_usec == 0) | |
326 | return; | |
327 | if (*v == USEC_INFINITY) | |
328 | return; | |
329 | ||
330 | add = random_u64() % t->random_usec; | |
331 | ||
332 | if (*v + add < *v) /* overflow */ | |
333 | *v = (usec_t) -2; /* Highest possible value, that is not USEC_INFINITY */ | |
334 | else | |
335 | *v += add; | |
336 | ||
382852fd | 337 | log_unit_debug(UNIT(t), "Adding %s random time.", format_timespan(s, sizeof(s), add, 0)); |
744c7693 LP |
338 | } |
339 | ||
871d7de4 | 340 | static void timer_enter_waiting(Timer *t, bool initial) { |
36697dc0 | 341 | bool found_monotonic = false, found_realtime = false; |
3e0c30ac | 342 | bool leave_around = false; |
c54be90b | 343 | triple_timestamp ts; |
dedabea4 | 344 | TimerValue *v; |
e903182e | 345 | Unit *trigger; |
871d7de4 LP |
346 | int r; |
347 | ||
e903182e LP |
348 | assert(t); |
349 | ||
350 | trigger = UNIT_TRIGGER(UNIT(t)); | |
351 | if (!trigger) { | |
352 | log_unit_error(UNIT(t), "Unit to trigger vanished."); | |
353 | timer_enter_dead(t, TIMER_FAILURE_RESOURCES); | |
354 | return; | |
355 | } | |
356 | ||
c54be90b | 357 | triple_timestamp_get(&ts); |
dedabea4 | 358 | t->next_elapse_monotonic_or_boottime = t->next_elapse_realtime = 0; |
871d7de4 LP |
359 | |
360 | LIST_FOREACH(value, v, t->values) { | |
871d7de4 LP |
361 | if (v->disabled) |
362 | continue; | |
363 | ||
36697dc0 | 364 | if (v->base == TIMER_CALENDAR) { |
06642d17 LP |
365 | usec_t b; |
366 | ||
367 | /* If we know the last time this was | |
368 | * triggered, schedule the job based relative | |
9ea9faff AJ |
369 | * to that. If we don't, just start from |
370 | * the activation time. */ | |
371 | ||
372 | if (t->last_trigger.realtime > 0) | |
373 | b = t->last_trigger.realtime; | |
374 | else { | |
375 | if (state_translation_table[t->state] == UNIT_ACTIVE) | |
376 | b = UNIT(t)->inactive_exit_timestamp.realtime; | |
377 | else | |
378 | b = ts.realtime; | |
379 | } | |
06642d17 LP |
380 | |
381 | r = calendar_spec_next_usec(v->calendar_spec, b, &v->next_elapse); | |
36697dc0 LP |
382 | if (r < 0) |
383 | continue; | |
384 | ||
36697dc0 LP |
385 | if (!found_realtime) |
386 | t->next_elapse_realtime = v->next_elapse; | |
10717a1a | 387 | else |
36697dc0 | 388 | t->next_elapse_realtime = MIN(t->next_elapse_realtime, v->next_elapse); |
871d7de4 | 389 | |
36697dc0 | 390 | found_realtime = true; |
871d7de4 | 391 | |
60933bb8 AJ |
392 | } else { |
393 | usec_t base; | |
c54be90b | 394 | |
36697dc0 | 395 | switch (v->base) { |
871d7de4 | 396 | |
36697dc0 LP |
397 | case TIMER_ACTIVE: |
398 | if (state_translation_table[t->state] == UNIT_ACTIVE) | |
399 | base = UNIT(t)->inactive_exit_timestamp.monotonic; | |
400 | else | |
c54be90b | 401 | base = ts.monotonic; |
36697dc0 | 402 | break; |
871d7de4 | 403 | |
36697dc0 | 404 | case TIMER_BOOT: |
c1d9ba99 MS |
405 | if (detect_container() <= 0) { |
406 | /* CLOCK_MONOTONIC equals the uptime on Linux */ | |
407 | base = 0; | |
408 | break; | |
409 | } | |
410 | /* In a container we don't want to include the time the host | |
411 | * was already up when the container started, so count from | |
ec251fe7 | 412 | * our own startup. */ |
4831981d | 413 | _fallthrough_; |
36697dc0 | 414 | case TIMER_STARTUP: |
9f9f0342 | 415 | base = UNIT(t)->manager->timestamps[MANAGER_TIMESTAMP_USERSPACE].monotonic; |
36697dc0 | 416 | break; |
871d7de4 | 417 | |
36697dc0 | 418 | case TIMER_UNIT_ACTIVE: |
3e0c30ac | 419 | leave_around = true; |
e903182e | 420 | base = trigger->inactive_exit_timestamp.monotonic; |
e41e1943 LP |
421 | |
422 | if (base <= 0) | |
06642d17 | 423 | base = t->last_trigger.monotonic; |
e41e1943 LP |
424 | |
425 | if (base <= 0) | |
36697dc0 | 426 | continue; |
204d140c | 427 | base = MAX(base, t->last_trigger.monotonic); |
871d7de4 | 428 | |
36697dc0 | 429 | break; |
871d7de4 | 430 | |
36697dc0 | 431 | case TIMER_UNIT_INACTIVE: |
3e0c30ac | 432 | leave_around = true; |
e903182e | 433 | base = trigger->inactive_enter_timestamp.monotonic; |
e41e1943 LP |
434 | |
435 | if (base <= 0) | |
06642d17 | 436 | base = t->last_trigger.monotonic; |
e41e1943 LP |
437 | |
438 | if (base <= 0) | |
36697dc0 | 439 | continue; |
204d140c | 440 | base = MAX(base, t->last_trigger.monotonic); |
871d7de4 | 441 | |
36697dc0 | 442 | break; |
871d7de4 | 443 | |
36697dc0 LP |
444 | default: |
445 | assert_not_reached("Unknown timer base"); | |
446 | } | |
871d7de4 | 447 | |
c54be90b | 448 | v->next_elapse = usec_add(usec_shift_clock(base, CLOCK_MONOTONIC, TIMER_MONOTONIC_CLOCK(t)), v->value); |
36697dc0 | 449 | |
c54be90b LP |
450 | if (!initial && |
451 | v->next_elapse < triple_timestamp_by_clock(&ts, TIMER_MONOTONIC_CLOCK(t)) && | |
452 | IN_SET(v->base, TIMER_ACTIVE, TIMER_BOOT, TIMER_STARTUP)) { | |
e41e1943 | 453 | /* This is a one time trigger, disable it now */ |
36697dc0 LP |
454 | v->disabled = true; |
455 | continue; | |
456 | } | |
457 | ||
458 | if (!found_monotonic) | |
dedabea4 | 459 | t->next_elapse_monotonic_or_boottime = v->next_elapse; |
36697dc0 | 460 | else |
dedabea4 | 461 | t->next_elapse_monotonic_or_boottime = MIN(t->next_elapse_monotonic_or_boottime, v->next_elapse); |
36697dc0 LP |
462 | |
463 | found_monotonic = true; | |
464 | } | |
871d7de4 LP |
465 | } |
466 | ||
36697dc0 | 467 | if (!found_monotonic && !found_realtime) { |
f2341e0a | 468 | log_unit_debug(UNIT(t), "Timer is elapsed."); |
3e0c30ac | 469 | timer_enter_elapsed(t, leave_around); |
871d7de4 LP |
470 | return; |
471 | } | |
472 | ||
36697dc0 LP |
473 | if (found_monotonic) { |
474 | char buf[FORMAT_TIMESPAN_MAX]; | |
3e0c30ac | 475 | usec_t left; |
dedabea4 | 476 | |
744c7693 LP |
477 | add_random(t, &t->next_elapse_monotonic_or_boottime); |
478 | ||
c54be90b | 479 | left = usec_sub_unsigned(t->next_elapse_monotonic_or_boottime, triple_timestamp_by_clock(&ts, TIMER_MONOTONIC_CLOCK(t))); |
3e0c30ac | 480 | log_unit_debug(UNIT(t), "Monotonic timer elapses in %s.", format_timespan(buf, sizeof(buf), left, 0)); |
871d7de4 | 481 | |
718db961 | 482 | if (t->monotonic_event_source) { |
dedabea4 | 483 | r = sd_event_source_set_time(t->monotonic_event_source, t->next_elapse_monotonic_or_boottime); |
718db961 LP |
484 | if (r < 0) |
485 | goto fail; | |
486 | ||
487 | r = sd_event_source_set_enabled(t->monotonic_event_source, SD_EVENT_ONESHOT); | |
cbf60d0a LP |
488 | if (r < 0) |
489 | goto fail; | |
490 | } else { | |
491 | ||
6a0f1f6d LP |
492 | r = sd_event_add_time( |
493 | UNIT(t)->manager->event, | |
494 | &t->monotonic_event_source, | |
dedabea4 LP |
495 | t->wake_system ? CLOCK_BOOTTIME_ALARM : CLOCK_MONOTONIC, |
496 | t->next_elapse_monotonic_or_boottime, t->accuracy_usec, | |
6a0f1f6d | 497 | timer_dispatch, t); |
cbf60d0a LP |
498 | if (r < 0) |
499 | goto fail; | |
718db961 | 500 | |
cbf60d0a LP |
501 | (void) sd_event_source_set_description(t->monotonic_event_source, "timer-monotonic"); |
502 | } | |
7dfbe2e3 | 503 | |
718db961 | 504 | } else if (t->monotonic_event_source) { |
718db961 | 505 | |
06642d17 | 506 | r = sd_event_source_set_enabled(t->monotonic_event_source, SD_EVENT_OFF); |
718db961 LP |
507 | if (r < 0) |
508 | goto fail; | |
509 | } | |
36697dc0 LP |
510 | |
511 | if (found_realtime) { | |
512 | char buf[FORMAT_TIMESTAMP_MAX]; | |
744c7693 LP |
513 | |
514 | add_random(t, &t->next_elapse_realtime); | |
515 | ||
f2341e0a | 516 | log_unit_debug(UNIT(t), "Realtime timer elapses at %s.", format_timestamp(buf, sizeof(buf), t->next_elapse_realtime)); |
36697dc0 | 517 | |
718db961 LP |
518 | if (t->realtime_event_source) { |
519 | r = sd_event_source_set_time(t->realtime_event_source, t->next_elapse_realtime); | |
520 | if (r < 0) | |
521 | goto fail; | |
522 | ||
523 | r = sd_event_source_set_enabled(t->realtime_event_source, SD_EVENT_ONESHOT); | |
cbf60d0a LP |
524 | if (r < 0) |
525 | goto fail; | |
526 | } else { | |
6a0f1f6d LP |
527 | r = sd_event_add_time( |
528 | UNIT(t)->manager->event, | |
529 | &t->realtime_event_source, | |
dedabea4 | 530 | t->wake_system ? CLOCK_REALTIME_ALARM : CLOCK_REALTIME, |
6a0f1f6d LP |
531 | t->next_elapse_realtime, t->accuracy_usec, |
532 | timer_dispatch, t); | |
cbf60d0a LP |
533 | if (r < 0) |
534 | goto fail; | |
718db961 | 535 | |
cbf60d0a LP |
536 | (void) sd_event_source_set_description(t->realtime_event_source, "timer-realtime"); |
537 | } | |
7dfbe2e3 | 538 | |
718db961 | 539 | } else if (t->realtime_event_source) { |
718db961 | 540 | |
06642d17 | 541 | r = sd_event_source_set_enabled(t->realtime_event_source, SD_EVENT_OFF); |
718db961 LP |
542 | if (r < 0) |
543 | goto fail; | |
544 | } | |
871d7de4 LP |
545 | |
546 | timer_set_state(t, TIMER_WAITING); | |
547 | return; | |
548 | ||
549 | fail: | |
f2341e0a | 550 | log_unit_warning_errno(UNIT(t), r, "Failed to enter waiting state: %m"); |
067d72c9 | 551 | timer_enter_dead(t, TIMER_FAILURE_RESOURCES); |
871d7de4 LP |
552 | } |
553 | ||
554 | static void timer_enter_running(Timer *t) { | |
4afd3348 | 555 | _cleanup_(sd_bus_error_free) sd_bus_error error = SD_BUS_ERROR_NULL; |
e903182e | 556 | Unit *trigger; |
871d7de4 | 557 | int r; |
398ef8ba | 558 | |
871d7de4 LP |
559 | assert(t); |
560 | ||
ba3e67a7 | 561 | /* Don't start job if we are supposed to go down */ |
31afa0a4 | 562 | if (unit_stop_pending(UNIT(t))) |
ba3e67a7 LP |
563 | return; |
564 | ||
e903182e LP |
565 | trigger = UNIT_TRIGGER(UNIT(t)); |
566 | if (!trigger) { | |
567 | log_unit_error(UNIT(t), "Unit to trigger vanished."); | |
568 | timer_enter_dead(t, TIMER_FAILURE_RESOURCES); | |
569 | return; | |
570 | } | |
571 | ||
572 | r = manager_add_job(UNIT(t)->manager, JOB_START, trigger, JOB_REPLACE, &error, NULL); | |
36697dc0 | 573 | if (r < 0) |
871d7de4 LP |
574 | goto fail; |
575 | ||
06642d17 LP |
576 | dual_timestamp_get(&t->last_trigger); |
577 | ||
472fc28f | 578 | if (t->stamp_path) |
ee735086 | 579 | touch_file(t->stamp_path, true, t->last_trigger.realtime, UID_INVALID, GID_INVALID, MODE_INVALID); |
e41e1943 | 580 | |
871d7de4 LP |
581 | timer_set_state(t, TIMER_RUNNING); |
582 | return; | |
583 | ||
584 | fail: | |
f2341e0a | 585 | log_unit_warning(UNIT(t), "Failed to queue unit startup job: %s", bus_error_message(&error, r)); |
067d72c9 | 586 | timer_enter_dead(t, TIMER_FAILURE_RESOURCES); |
871d7de4 LP |
587 | } |
588 | ||
589 | static int timer_start(Unit *u) { | |
590 | Timer *t = TIMER(u); | |
779042e7 | 591 | TimerValue *v; |
e903182e | 592 | Unit *trigger; |
07299350 | 593 | int r; |
871d7de4 LP |
594 | |
595 | assert(t); | |
3742095b | 596 | assert(IN_SET(t->state, TIMER_DEAD, TIMER_FAILED)); |
01f78473 | 597 | |
e903182e LP |
598 | trigger = UNIT_TRIGGER(u); |
599 | if (!trigger || trigger->load_state != UNIT_LOADED) { | |
600 | log_unit_error(u, "Refusing to start, unit to trigger not loaded."); | |
01f78473 | 601 | return -ENOENT; |
e903182e | 602 | } |
871d7de4 | 603 | |
07299350 LP |
604 | r = unit_start_limit_test(u); |
605 | if (r < 0) { | |
606 | timer_enter_dead(t, TIMER_FAILURE_START_LIMIT_HIT); | |
607 | return r; | |
608 | } | |
609 | ||
4b58153d LP |
610 | r = unit_acquire_invocation_id(u); |
611 | if (r < 0) | |
612 | return r; | |
613 | ||
06642d17 LP |
614 | t->last_trigger = DUAL_TIMESTAMP_NULL; |
615 | ||
779042e7 MC |
616 | /* Reenable all timers that depend on unit activation time */ |
617 | LIST_FOREACH(value, v, t->values) | |
618 | if (v->base == TIMER_ACTIVE) | |
619 | v->disabled = false; | |
620 | ||
06642d17 LP |
621 | if (t->stamp_path) { |
622 | struct stat st; | |
623 | ||
77542a79 LP |
624 | if (stat(t->stamp_path, &st) >= 0) { |
625 | usec_t ft; | |
626 | ||
627 | /* Load the file timestamp, but only if it is actually in the past. If it is in the future, | |
628 | * something is wrong with the system clock. */ | |
629 | ||
630 | ft = timespec_load(&st.st_mtim); | |
631 | if (ft < now(CLOCK_REALTIME)) | |
632 | t->last_trigger.realtime = ft; | |
633 | else { | |
634 | char z[FORMAT_TIMESTAMP_MAX]; | |
635 | ||
636 | log_unit_warning(u, "Not using persistent file timestamp %s as it is in the future.", | |
637 | format_timestamp(z, sizeof(z), ft)); | |
638 | } | |
639 | ||
640 | } else if (errno == ENOENT) | |
472fc28f TB |
641 | /* The timer has never run before, |
642 | * make sure a stamp file exists. | |
643 | */ | |
4b58153d | 644 | (void) touch_file(t->stamp_path, true, USEC_INFINITY, UID_INVALID, GID_INVALID, MODE_INVALID); |
06642d17 LP |
645 | } |
646 | ||
067d72c9 | 647 | t->result = TIMER_SUCCESS; |
871d7de4 | 648 | timer_enter_waiting(t, true); |
82a2b6bb | 649 | return 1; |
871d7de4 LP |
650 | } |
651 | ||
652 | static int timer_stop(Unit *u) { | |
653 | Timer *t = TIMER(u); | |
654 | ||
655 | assert(t); | |
3742095b | 656 | assert(IN_SET(t->state, TIMER_WAITING, TIMER_RUNNING, TIMER_ELAPSED)); |
871d7de4 | 657 | |
067d72c9 | 658 | timer_enter_dead(t, TIMER_SUCCESS); |
82a2b6bb | 659 | return 1; |
871d7de4 LP |
660 | } |
661 | ||
662 | static int timer_serialize(Unit *u, FILE *f, FDSet *fds) { | |
663 | Timer *t = TIMER(u); | |
664 | ||
665 | assert(u); | |
666 | assert(f); | |
667 | assert(fds); | |
668 | ||
669 | unit_serialize_item(u, f, "state", timer_state_to_string(t->state)); | |
067d72c9 | 670 | unit_serialize_item(u, f, "result", timer_result_to_string(t->result)); |
871d7de4 | 671 | |
06642d17 LP |
672 | if (t->last_trigger.realtime > 0) |
673 | unit_serialize_item_format(u, f, "last-trigger-realtime", "%" PRIu64, t->last_trigger.realtime); | |
674 | ||
675 | if (t->last_trigger.monotonic > 0) | |
676 | unit_serialize_item_format(u, f, "last-trigger-monotonic", "%" PRIu64, t->last_trigger.monotonic); | |
677 | ||
871d7de4 LP |
678 | return 0; |
679 | } | |
680 | ||
681 | static int timer_deserialize_item(Unit *u, const char *key, const char *value, FDSet *fds) { | |
682 | Timer *t = TIMER(u); | |
06642d17 | 683 | int r; |
871d7de4 LP |
684 | |
685 | assert(u); | |
686 | assert(key); | |
687 | assert(value); | |
688 | assert(fds); | |
689 | ||
690 | if (streq(key, "state")) { | |
691 | TimerState state; | |
692 | ||
36697dc0 LP |
693 | state = timer_state_from_string(value); |
694 | if (state < 0) | |
f2341e0a | 695 | log_unit_debug(u, "Failed to parse state value: %s", value); |
871d7de4 LP |
696 | else |
697 | t->deserialized_state = state; | |
067d72c9 LP |
698 | } else if (streq(key, "result")) { |
699 | TimerResult f; | |
700 | ||
701 | f = timer_result_from_string(value); | |
702 | if (f < 0) | |
f2341e0a | 703 | log_unit_debug(u, "Failed to parse result value: %s", value); |
067d72c9 LP |
704 | else if (f != TIMER_SUCCESS) |
705 | t->result = f; | |
06642d17 LP |
706 | } else if (streq(key, "last-trigger-realtime")) { |
707 | ||
708 | r = safe_atou64(value, &t->last_trigger.realtime); | |
709 | if (r < 0) | |
f2341e0a | 710 | log_unit_debug(u, "Failed to parse last-trigger-realtime value: %s", value); |
06642d17 LP |
711 | |
712 | } else if (streq(key, "last-trigger-monotonic")) { | |
713 | ||
714 | r = safe_atou64(value, &t->last_trigger.monotonic); | |
715 | if (r < 0) | |
f2341e0a | 716 | log_unit_debug(u, "Failed to parse last-trigger-monotonic value: %s", value); |
067d72c9 | 717 | |
871d7de4 | 718 | } else |
f2341e0a | 719 | log_unit_debug(u, "Unknown serialization key: %s", key); |
871d7de4 LP |
720 | |
721 | return 0; | |
034c6ed7 LP |
722 | } |
723 | ||
44a6b1b6 | 724 | _pure_ static UnitActiveState timer_active_state(Unit *u) { |
871d7de4 LP |
725 | assert(u); |
726 | ||
727 | return state_translation_table[TIMER(u)->state]; | |
728 | } | |
729 | ||
44a6b1b6 | 730 | _pure_ static const char *timer_sub_state_to_string(Unit *u) { |
871d7de4 LP |
731 | assert(u); |
732 | ||
733 | return timer_state_to_string(TIMER(u)->state); | |
734 | } | |
735 | ||
718db961 LP |
736 | static int timer_dispatch(sd_event_source *s, uint64_t usec, void *userdata) { |
737 | Timer *t = TIMER(userdata); | |
871d7de4 LP |
738 | |
739 | assert(t); | |
5cb5a6ff | 740 | |
871d7de4 | 741 | if (t->state != TIMER_WAITING) |
718db961 | 742 | return 0; |
5cb5a6ff | 743 | |
f2341e0a | 744 | log_unit_debug(UNIT(t), "Timer elapsed."); |
871d7de4 | 745 | timer_enter_running(t); |
718db961 | 746 | return 0; |
5cb5a6ff LP |
747 | } |
748 | ||
3ecaa09b LP |
749 | static void timer_trigger_notify(Unit *u, Unit *other) { |
750 | Timer *t = TIMER(u); | |
751 | TimerValue *v; | |
871d7de4 | 752 | |
3ecaa09b LP |
753 | assert(u); |
754 | assert(other); | |
871d7de4 | 755 | |
3ecaa09b LP |
756 | if (other->load_state != UNIT_LOADED) |
757 | return; | |
871d7de4 | 758 | |
3ecaa09b LP |
759 | /* Reenable all timers that depend on unit state */ |
760 | LIST_FOREACH(value, v, t->values) | |
3742095b | 761 | if (IN_SET(v->base, TIMER_UNIT_ACTIVE, TIMER_UNIT_INACTIVE)) |
3ecaa09b | 762 | v->disabled = false; |
01f78473 | 763 | |
3ecaa09b | 764 | switch (t->state) { |
871d7de4 | 765 | |
3ecaa09b LP |
766 | case TIMER_WAITING: |
767 | case TIMER_ELAPSED: | |
871d7de4 | 768 | |
3ecaa09b LP |
769 | /* Recalculate sleep time */ |
770 | timer_enter_waiting(t, false); | |
771 | break; | |
871d7de4 | 772 | |
3ecaa09b | 773 | case TIMER_RUNNING: |
871d7de4 | 774 | |
3ecaa09b | 775 | if (UNIT_IS_INACTIVE_OR_FAILED(unit_active_state(other))) { |
f2341e0a | 776 | log_unit_debug(UNIT(t), "Got notified about unit deactivation."); |
871d7de4 | 777 | timer_enter_waiting(t, false); |
3ecaa09b LP |
778 | } |
779 | break; | |
871d7de4 | 780 | |
3ecaa09b LP |
781 | case TIMER_DEAD: |
782 | case TIMER_FAILED: | |
783 | break; | |
871d7de4 | 784 | |
3ecaa09b LP |
785 | default: |
786 | assert_not_reached("Unknown timer state"); | |
871d7de4 | 787 | } |
871d7de4 LP |
788 | } |
789 | ||
fdf20a31 | 790 | static void timer_reset_failed(Unit *u) { |
5632e374 LP |
791 | Timer *t = TIMER(u); |
792 | ||
793 | assert(t); | |
794 | ||
fdf20a31 | 795 | if (t->state == TIMER_FAILED) |
5632e374 LP |
796 | timer_set_state(t, TIMER_DEAD); |
797 | ||
067d72c9 | 798 | t->result = TIMER_SUCCESS; |
5632e374 LP |
799 | } |
800 | ||
8742514c LP |
801 | static void timer_time_change(Unit *u) { |
802 | Timer *t = TIMER(u); | |
13f512d3 | 803 | usec_t ts; |
8742514c LP |
804 | |
805 | assert(u); | |
806 | ||
807 | if (t->state != TIMER_WAITING) | |
808 | return; | |
809 | ||
13f512d3 AJ |
810 | /* If we appear to have triggered in the future, the system clock must |
811 | * have been set backwards. So let's rewind our own clock and allow | |
812 | * the future trigger(s) to happen again :). Exactly the same as when | |
813 | * you start a timer unit with Persistent=yes. */ | |
814 | ts = now(CLOCK_REALTIME); | |
815 | if (t->last_trigger.realtime > ts) | |
816 | t->last_trigger.realtime = ts; | |
817 | ||
f2341e0a | 818 | log_unit_debug(u, "Time change, recalculating next elapse."); |
8742514c LP |
819 | timer_enter_waiting(t, false); |
820 | } | |
821 | ||
871d7de4 | 822 | static const char* const timer_base_table[_TIMER_BASE_MAX] = { |
03fae018 LP |
823 | [TIMER_ACTIVE] = "OnActiveSec", |
824 | [TIMER_BOOT] = "OnBootSec", | |
825 | [TIMER_STARTUP] = "OnStartupSec", | |
826 | [TIMER_UNIT_ACTIVE] = "OnUnitActiveSec", | |
36697dc0 LP |
827 | [TIMER_UNIT_INACTIVE] = "OnUnitInactiveSec", |
828 | [TIMER_CALENDAR] = "OnCalendar" | |
871d7de4 LP |
829 | }; |
830 | ||
831 | DEFINE_STRING_TABLE_LOOKUP(timer_base, TimerBase); | |
832 | ||
067d72c9 LP |
833 | static const char* const timer_result_table[_TIMER_RESULT_MAX] = { |
834 | [TIMER_SUCCESS] = "success", | |
07299350 LP |
835 | [TIMER_FAILURE_RESOURCES] = "resources", |
836 | [TIMER_FAILURE_START_LIMIT_HIT] = "start-limit-hit", | |
067d72c9 LP |
837 | }; |
838 | ||
839 | DEFINE_STRING_TABLE_LOOKUP(timer_result, TimerResult); | |
840 | ||
87f0e418 | 841 | const UnitVTable timer_vtable = { |
7d17cfbc | 842 | .object_size = sizeof(Timer), |
718db961 | 843 | |
f975e971 LP |
844 | .sections = |
845 | "Unit\0" | |
846 | "Timer\0" | |
847 | "Install\0", | |
d8a812d1 | 848 | .private_section = "Timer", |
5cb5a6ff | 849 | |
871d7de4 | 850 | .init = timer_init, |
034c6ed7 | 851 | .done = timer_done, |
871d7de4 LP |
852 | .load = timer_load, |
853 | ||
854 | .coldplug = timer_coldplug, | |
855 | ||
856 | .dump = timer_dump, | |
857 | ||
858 | .start = timer_start, | |
859 | .stop = timer_stop, | |
860 | ||
861 | .serialize = timer_serialize, | |
862 | .deserialize_item = timer_deserialize_item, | |
863 | ||
864 | .active_state = timer_active_state, | |
865 | .sub_state_to_string = timer_sub_state_to_string, | |
866 | ||
3ecaa09b LP |
867 | .trigger_notify = timer_trigger_notify, |
868 | ||
fdf20a31 | 869 | .reset_failed = timer_reset_failed, |
8742514c | 870 | .time_change = timer_time_change, |
5632e374 | 871 | |
718db961 | 872 | .bus_vtable = bus_timer_vtable, |
d8a812d1 WC |
873 | .bus_set_property = bus_timer_set_property, |
874 | ||
875 | .can_transient = true, | |
5cb5a6ff | 876 | }; |