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