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