]> git.ipfire.org Git - thirdparty/systemd.git/blame - src/core/timer.c
systemctl: port systemctl over to the new LookupPaths configuration directory fields
[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
b2c23da8 112 if (UNIT(t)->manager->running_as == MANAGER_SYSTEM) {
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
b2c23da8 138 if (UNIT(t)->manager->running_as == MANAGER_SYSTEM) {
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)
bd34b310 150 t->stamp_path = strjoin(e, "/systemd/timers/stamp-", UNIT(t)->id, NULL);
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
LP
158
159 t->stamp_path = strjoin(h, "/.local/share/systemd/timers/stamp-", UNIT(t)->id, NULL);
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
235 calendar_spec_to_string(v->calendar_spec, &p);
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);
36697dc0 264 }
871d7de4
LP
265
266 if (state != old_state)
f2341e0a 267 log_unit_debug(UNIT(t), "Changed %s -> %s", timer_state_to_string(old_state), timer_state_to_string(state));
871d7de4 268
e2f3b44c 269 unit_notify(UNIT(t), state_translation_table[old_state], state_translation_table[state], true);
871d7de4
LP
270}
271
272static void timer_enter_waiting(Timer *t, bool initial);
273
be847e82 274static int timer_coldplug(Unit *u) {
871d7de4
LP
275 Timer *t = TIMER(u);
276
277 assert(t);
278 assert(t->state == TIMER_DEAD);
279
3e0c30ac
LP
280 if (t->deserialized_state == t->state)
281 return 0;
871d7de4 282
3e0c30ac
LP
283 if (t->deserialized_state == TIMER_WAITING)
284 timer_enter_waiting(t, false);
285 else
286 timer_set_state(t, t->deserialized_state);
871d7de4
LP
287
288 return 0;
289}
290
067d72c9 291static void timer_enter_dead(Timer *t, TimerResult f) {
871d7de4
LP
292 assert(t);
293
067d72c9
LP
294 if (f != TIMER_SUCCESS)
295 t->result = f;
871d7de4 296
067d72c9 297 timer_set_state(t, t->result != TIMER_SUCCESS ? TIMER_FAILED : TIMER_DEAD);
871d7de4
LP
298}
299
3e0c30ac
LP
300static void timer_enter_elapsed(Timer *t, bool leave_around) {
301 assert(t);
302
303 /* If a unit is marked with RemainAfterElapse=yes we leave it
304 * around even after it elapsed once, so that starting it
305 * later again does not necessarily mean immediate
306 * retriggering. We unconditionally leave units with
307 * TIMER_UNIT_ACTIVE or TIMER_UNIT_INACTIVE triggers around,
308 * since they might be restarted automatically at any time
309 * later on. */
310
311 if (t->remain_after_elapse || leave_around)
312 timer_set_state(t, TIMER_ELAPSED);
313 else
314 timer_enter_dead(t, TIMER_SUCCESS);
315}
316
dedabea4
LP
317static usec_t monotonic_to_boottime(usec_t t) {
318 usec_t a, b;
319
320 if (t <= 0)
321 return 0;
322
323 a = now(CLOCK_BOOTTIME);
324 b = now(CLOCK_MONOTONIC);
325
326 if (t + a > b)
327 return t + a - b;
328 else
329 return 0;
330}
331
744c7693
LP
332static void add_random(Timer *t, usec_t *v) {
333 char s[FORMAT_TIMESPAN_MAX];
334 usec_t add;
335
336 assert(t);
3f51aec8 337 assert(v);
744c7693
LP
338
339 if (t->random_usec == 0)
340 return;
341 if (*v == USEC_INFINITY)
342 return;
343
344 add = random_u64() % t->random_usec;
345
346 if (*v + add < *v) /* overflow */
347 *v = (usec_t) -2; /* Highest possible value, that is not USEC_INFINITY */
348 else
349 *v += add;
350
351 log_unit_info(UNIT(t), "Adding %s random time.", format_timespan(s, sizeof(s), add, 0));
352}
353
871d7de4 354static void timer_enter_waiting(Timer *t, bool initial) {
36697dc0 355 bool found_monotonic = false, found_realtime = false;
dedabea4
LP
356 usec_t ts_realtime, ts_monotonic;
357 usec_t base = 0;
3e0c30ac 358 bool leave_around = false;
dedabea4 359 TimerValue *v;
e903182e 360 Unit *trigger;
871d7de4
LP
361 int r;
362
e903182e
LP
363 assert(t);
364
365 trigger = UNIT_TRIGGER(UNIT(t));
366 if (!trigger) {
367 log_unit_error(UNIT(t), "Unit to trigger vanished.");
368 timer_enter_dead(t, TIMER_FAILURE_RESOURCES);
369 return;
370 }
371
dedabea4
LP
372 /* If we shall wake the system we use the boottime clock
373 * rather than the monotonic clock. */
374
375 ts_realtime = now(CLOCK_REALTIME);
376 ts_monotonic = now(t->wake_system ? CLOCK_BOOTTIME : CLOCK_MONOTONIC);
377 t->next_elapse_monotonic_or_boottime = t->next_elapse_realtime = 0;
871d7de4
LP
378
379 LIST_FOREACH(value, v, t->values) {
380
381 if (v->disabled)
382 continue;
383
36697dc0 384 if (v->base == TIMER_CALENDAR) {
06642d17
LP
385 usec_t b;
386
387 /* If we know the last time this was
388 * triggered, schedule the job based relative
389 * to that. If we don't just start from
390 * now. */
36697dc0 391
dedabea4 392 b = t->last_trigger.realtime > 0 ? t->last_trigger.realtime : ts_realtime;
06642d17
LP
393
394 r = calendar_spec_next_usec(v->calendar_spec, b, &v->next_elapse);
36697dc0
LP
395 if (r < 0)
396 continue;
397
36697dc0
LP
398 if (!found_realtime)
399 t->next_elapse_realtime = v->next_elapse;
10717a1a 400 else
36697dc0 401 t->next_elapse_realtime = MIN(t->next_elapse_realtime, v->next_elapse);
871d7de4 402
36697dc0 403 found_realtime = true;
871d7de4 404
36697dc0
LP
405 } else {
406 switch (v->base) {
871d7de4 407
36697dc0
LP
408 case TIMER_ACTIVE:
409 if (state_translation_table[t->state] == UNIT_ACTIVE)
410 base = UNIT(t)->inactive_exit_timestamp.monotonic;
411 else
dedabea4 412 base = ts_monotonic;
36697dc0 413 break;
871d7de4 414
36697dc0 415 case TIMER_BOOT:
c1d9ba99
MS
416 if (detect_container() <= 0) {
417 /* CLOCK_MONOTONIC equals the uptime on Linux */
418 base = 0;
419 break;
420 }
421 /* In a container we don't want to include the time the host
422 * was already up when the container started, so count from
423 * our own startup. Fall through. */
36697dc0
LP
424 case TIMER_STARTUP:
425 base = UNIT(t)->manager->userspace_timestamp.monotonic;
426 break;
871d7de4 427
36697dc0 428 case TIMER_UNIT_ACTIVE:
3e0c30ac 429 leave_around = true;
e903182e 430 base = trigger->inactive_exit_timestamp.monotonic;
e41e1943
LP
431
432 if (base <= 0)
06642d17 433 base = t->last_trigger.monotonic;
e41e1943
LP
434
435 if (base <= 0)
36697dc0 436 continue;
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;
871d7de4 449
36697dc0 450 break;
871d7de4 451
36697dc0
LP
452 default:
453 assert_not_reached("Unknown timer base");
454 }
871d7de4 455
dedabea4
LP
456 if (t->wake_system)
457 base = monotonic_to_boottime(base);
458
36697dc0
LP
459 v->next_elapse = base + v->value;
460
dedabea4 461 if (!initial && v->next_elapse < ts_monotonic && IN_SET(v->base, TIMER_ACTIVE, TIMER_BOOT, TIMER_STARTUP)) {
e41e1943 462 /* This is a one time trigger, disable it now */
36697dc0
LP
463 v->disabled = true;
464 continue;
465 }
466
467 if (!found_monotonic)
dedabea4 468 t->next_elapse_monotonic_or_boottime = v->next_elapse;
36697dc0 469 else
dedabea4 470 t->next_elapse_monotonic_or_boottime = MIN(t->next_elapse_monotonic_or_boottime, v->next_elapse);
36697dc0
LP
471
472 found_monotonic = true;
473 }
871d7de4
LP
474 }
475
36697dc0 476 if (!found_monotonic && !found_realtime) {
f2341e0a 477 log_unit_debug(UNIT(t), "Timer is elapsed.");
3e0c30ac 478 timer_enter_elapsed(t, leave_around);
871d7de4
LP
479 return;
480 }
481
36697dc0
LP
482 if (found_monotonic) {
483 char buf[FORMAT_TIMESPAN_MAX];
3e0c30ac 484 usec_t left;
dedabea4 485
744c7693
LP
486 add_random(t, &t->next_elapse_monotonic_or_boottime);
487
3e0c30ac
LP
488 left = t->next_elapse_monotonic_or_boottime > ts_monotonic ? t->next_elapse_monotonic_or_boottime - ts_monotonic : 0;
489 log_unit_debug(UNIT(t), "Monotonic timer elapses in %s.", format_timespan(buf, sizeof(buf), left, 0));
871d7de4 490
718db961 491 if (t->monotonic_event_source) {
dedabea4 492 r = sd_event_source_set_time(t->monotonic_event_source, t->next_elapse_monotonic_or_boottime);
718db961
LP
493 if (r < 0)
494 goto fail;
495
496 r = sd_event_source_set_enabled(t->monotonic_event_source, SD_EVENT_ONESHOT);
cbf60d0a
LP
497 if (r < 0)
498 goto fail;
499 } else {
500
6a0f1f6d
LP
501 r = sd_event_add_time(
502 UNIT(t)->manager->event,
503 &t->monotonic_event_source,
dedabea4
LP
504 t->wake_system ? CLOCK_BOOTTIME_ALARM : CLOCK_MONOTONIC,
505 t->next_elapse_monotonic_or_boottime, t->accuracy_usec,
6a0f1f6d 506 timer_dispatch, t);
cbf60d0a
LP
507 if (r < 0)
508 goto fail;
718db961 509
cbf60d0a
LP
510 (void) sd_event_source_set_description(t->monotonic_event_source, "timer-monotonic");
511 }
7dfbe2e3 512
718db961 513 } else if (t->monotonic_event_source) {
718db961 514
06642d17 515 r = sd_event_source_set_enabled(t->monotonic_event_source, SD_EVENT_OFF);
718db961
LP
516 if (r < 0)
517 goto fail;
518 }
36697dc0
LP
519
520 if (found_realtime) {
521 char buf[FORMAT_TIMESTAMP_MAX];
744c7693
LP
522
523 add_random(t, &t->next_elapse_realtime);
524
f2341e0a 525 log_unit_debug(UNIT(t), "Realtime timer elapses at %s.", format_timestamp(buf, sizeof(buf), t->next_elapse_realtime));
36697dc0 526
718db961
LP
527 if (t->realtime_event_source) {
528 r = sd_event_source_set_time(t->realtime_event_source, t->next_elapse_realtime);
529 if (r < 0)
530 goto fail;
531
532 r = sd_event_source_set_enabled(t->realtime_event_source, SD_EVENT_ONESHOT);
cbf60d0a
LP
533 if (r < 0)
534 goto fail;
535 } else {
6a0f1f6d
LP
536 r = sd_event_add_time(
537 UNIT(t)->manager->event,
538 &t->realtime_event_source,
dedabea4 539 t->wake_system ? CLOCK_REALTIME_ALARM : CLOCK_REALTIME,
6a0f1f6d
LP
540 t->next_elapse_realtime, t->accuracy_usec,
541 timer_dispatch, t);
cbf60d0a
LP
542 if (r < 0)
543 goto fail;
718db961 544
cbf60d0a
LP
545 (void) sd_event_source_set_description(t->realtime_event_source, "timer-realtime");
546 }
7dfbe2e3 547
718db961 548 } else if (t->realtime_event_source) {
718db961 549
06642d17 550 r = sd_event_source_set_enabled(t->realtime_event_source, SD_EVENT_OFF);
718db961
LP
551 if (r < 0)
552 goto fail;
553 }
871d7de4
LP
554
555 timer_set_state(t, TIMER_WAITING);
556 return;
557
558fail:
f2341e0a 559 log_unit_warning_errno(UNIT(t), r, "Failed to enter waiting state: %m");
067d72c9 560 timer_enter_dead(t, TIMER_FAILURE_RESOURCES);
871d7de4
LP
561}
562
563static void timer_enter_running(Timer *t) {
4afd3348 564 _cleanup_(sd_bus_error_free) sd_bus_error error = SD_BUS_ERROR_NULL;
e903182e 565 Unit *trigger;
871d7de4 566 int r;
398ef8ba 567
871d7de4
LP
568 assert(t);
569
ba3e67a7 570 /* Don't start job if we are supposed to go down */
31afa0a4 571 if (unit_stop_pending(UNIT(t)))
ba3e67a7
LP
572 return;
573
e903182e
LP
574 trigger = UNIT_TRIGGER(UNIT(t));
575 if (!trigger) {
576 log_unit_error(UNIT(t), "Unit to trigger vanished.");
577 timer_enter_dead(t, TIMER_FAILURE_RESOURCES);
578 return;
579 }
580
581 r = manager_add_job(UNIT(t)->manager, JOB_START, trigger, JOB_REPLACE, &error, NULL);
36697dc0 582 if (r < 0)
871d7de4
LP
583 goto fail;
584
06642d17
LP
585 dual_timestamp_get(&t->last_trigger);
586
472fc28f 587 if (t->stamp_path)
ee735086 588 touch_file(t->stamp_path, true, t->last_trigger.realtime, UID_INVALID, GID_INVALID, MODE_INVALID);
e41e1943 589
871d7de4
LP
590 timer_set_state(t, TIMER_RUNNING);
591 return;
592
593fail:
f2341e0a 594 log_unit_warning(UNIT(t), "Failed to queue unit startup job: %s", bus_error_message(&error, r));
067d72c9 595 timer_enter_dead(t, TIMER_FAILURE_RESOURCES);
871d7de4
LP
596}
597
598static int timer_start(Unit *u) {
599 Timer *t = TIMER(u);
779042e7 600 TimerValue *v;
e903182e 601 Unit *trigger;
871d7de4
LP
602
603 assert(t);
fdf20a31 604 assert(t->state == TIMER_DEAD || t->state == TIMER_FAILED);
01f78473 605
e903182e
LP
606 trigger = UNIT_TRIGGER(u);
607 if (!trigger || trigger->load_state != UNIT_LOADED) {
608 log_unit_error(u, "Refusing to start, unit to trigger not loaded.");
01f78473 609 return -ENOENT;
e903182e 610 }
871d7de4 611
06642d17
LP
612 t->last_trigger = DUAL_TIMESTAMP_NULL;
613
779042e7
MC
614 /* Reenable all timers that depend on unit activation time */
615 LIST_FOREACH(value, v, t->values)
616 if (v->base == TIMER_ACTIVE)
617 v->disabled = false;
618
06642d17
LP
619 if (t->stamp_path) {
620 struct stat st;
621
622 if (stat(t->stamp_path, &st) >= 0)
623 t->last_trigger.realtime = timespec_load(&st.st_atim);
472fc28f
TB
624 else if (errno == ENOENT)
625 /* The timer has never run before,
626 * make sure a stamp file exists.
627 */
ee735086 628 touch_file(t->stamp_path, true, USEC_INFINITY, UID_INVALID, GID_INVALID, MODE_INVALID);
06642d17
LP
629 }
630
067d72c9 631 t->result = TIMER_SUCCESS;
871d7de4 632 timer_enter_waiting(t, true);
82a2b6bb 633 return 1;
871d7de4
LP
634}
635
636static int timer_stop(Unit *u) {
637 Timer *t = TIMER(u);
638
639 assert(t);
640 assert(t->state == TIMER_WAITING || t->state == TIMER_RUNNING || t->state == TIMER_ELAPSED);
641
067d72c9 642 timer_enter_dead(t, TIMER_SUCCESS);
82a2b6bb 643 return 1;
871d7de4
LP
644}
645
646static int timer_serialize(Unit *u, FILE *f, FDSet *fds) {
647 Timer *t = TIMER(u);
648
649 assert(u);
650 assert(f);
651 assert(fds);
652
653 unit_serialize_item(u, f, "state", timer_state_to_string(t->state));
067d72c9 654 unit_serialize_item(u, f, "result", timer_result_to_string(t->result));
871d7de4 655
06642d17
LP
656 if (t->last_trigger.realtime > 0)
657 unit_serialize_item_format(u, f, "last-trigger-realtime", "%" PRIu64, t->last_trigger.realtime);
658
659 if (t->last_trigger.monotonic > 0)
660 unit_serialize_item_format(u, f, "last-trigger-monotonic", "%" PRIu64, t->last_trigger.monotonic);
661
871d7de4
LP
662 return 0;
663}
664
665static int timer_deserialize_item(Unit *u, const char *key, const char *value, FDSet *fds) {
666 Timer *t = TIMER(u);
06642d17 667 int r;
871d7de4
LP
668
669 assert(u);
670 assert(key);
671 assert(value);
672 assert(fds);
673
674 if (streq(key, "state")) {
675 TimerState state;
676
36697dc0
LP
677 state = timer_state_from_string(value);
678 if (state < 0)
f2341e0a 679 log_unit_debug(u, "Failed to parse state value: %s", value);
871d7de4
LP
680 else
681 t->deserialized_state = state;
067d72c9
LP
682 } else if (streq(key, "result")) {
683 TimerResult f;
684
685 f = timer_result_from_string(value);
686 if (f < 0)
f2341e0a 687 log_unit_debug(u, "Failed to parse result value: %s", value);
067d72c9
LP
688 else if (f != TIMER_SUCCESS)
689 t->result = f;
06642d17
LP
690 } else if (streq(key, "last-trigger-realtime")) {
691
692 r = safe_atou64(value, &t->last_trigger.realtime);
693 if (r < 0)
f2341e0a 694 log_unit_debug(u, "Failed to parse last-trigger-realtime value: %s", value);
06642d17
LP
695
696 } else if (streq(key, "last-trigger-monotonic")) {
697
698 r = safe_atou64(value, &t->last_trigger.monotonic);
699 if (r < 0)
f2341e0a 700 log_unit_debug(u, "Failed to parse last-trigger-monotonic value: %s", value);
067d72c9 701
871d7de4 702 } else
f2341e0a 703 log_unit_debug(u, "Unknown serialization key: %s", key);
871d7de4
LP
704
705 return 0;
034c6ed7
LP
706}
707
44a6b1b6 708_pure_ static UnitActiveState timer_active_state(Unit *u) {
871d7de4
LP
709 assert(u);
710
711 return state_translation_table[TIMER(u)->state];
712}
713
44a6b1b6 714_pure_ static const char *timer_sub_state_to_string(Unit *u) {
871d7de4
LP
715 assert(u);
716
717 return timer_state_to_string(TIMER(u)->state);
718}
719
718db961
LP
720static int timer_dispatch(sd_event_source *s, uint64_t usec, void *userdata) {
721 Timer *t = TIMER(userdata);
871d7de4
LP
722
723 assert(t);
5cb5a6ff 724
871d7de4 725 if (t->state != TIMER_WAITING)
718db961 726 return 0;
5cb5a6ff 727
f2341e0a 728 log_unit_debug(UNIT(t), "Timer elapsed.");
871d7de4 729 timer_enter_running(t);
718db961 730 return 0;
5cb5a6ff
LP
731}
732
3ecaa09b
LP
733static void timer_trigger_notify(Unit *u, Unit *other) {
734 Timer *t = TIMER(u);
735 TimerValue *v;
871d7de4 736
3ecaa09b
LP
737 assert(u);
738 assert(other);
871d7de4 739
3ecaa09b
LP
740 if (other->load_state != UNIT_LOADED)
741 return;
871d7de4 742
3ecaa09b
LP
743 /* Reenable all timers that depend on unit state */
744 LIST_FOREACH(value, v, t->values)
745 if (v->base == TIMER_UNIT_ACTIVE ||
746 v->base == TIMER_UNIT_INACTIVE)
747 v->disabled = false;
01f78473 748
3ecaa09b 749 switch (t->state) {
871d7de4 750
3ecaa09b
LP
751 case TIMER_WAITING:
752 case TIMER_ELAPSED:
871d7de4 753
3ecaa09b
LP
754 /* Recalculate sleep time */
755 timer_enter_waiting(t, false);
756 break;
871d7de4 757
3ecaa09b 758 case TIMER_RUNNING:
871d7de4 759
3ecaa09b 760 if (UNIT_IS_INACTIVE_OR_FAILED(unit_active_state(other))) {
f2341e0a 761 log_unit_debug(UNIT(t), "Got notified about unit deactivation.");
871d7de4 762 timer_enter_waiting(t, false);
3ecaa09b
LP
763 }
764 break;
871d7de4 765
3ecaa09b
LP
766 case TIMER_DEAD:
767 case TIMER_FAILED:
768 break;
871d7de4 769
3ecaa09b
LP
770 default:
771 assert_not_reached("Unknown timer state");
871d7de4 772 }
871d7de4
LP
773}
774
fdf20a31 775static void timer_reset_failed(Unit *u) {
5632e374
LP
776 Timer *t = TIMER(u);
777
778 assert(t);
779
fdf20a31 780 if (t->state == TIMER_FAILED)
5632e374
LP
781 timer_set_state(t, TIMER_DEAD);
782
067d72c9 783 t->result = TIMER_SUCCESS;
5632e374
LP
784}
785
8742514c
LP
786static void timer_time_change(Unit *u) {
787 Timer *t = TIMER(u);
788
789 assert(u);
790
791 if (t->state != TIMER_WAITING)
792 return;
793
f2341e0a 794 log_unit_debug(u, "Time change, recalculating next elapse.");
8742514c
LP
795 timer_enter_waiting(t, false);
796}
797
871d7de4 798static const char* const timer_base_table[_TIMER_BASE_MAX] = {
03fae018
LP
799 [TIMER_ACTIVE] = "OnActiveSec",
800 [TIMER_BOOT] = "OnBootSec",
801 [TIMER_STARTUP] = "OnStartupSec",
802 [TIMER_UNIT_ACTIVE] = "OnUnitActiveSec",
36697dc0
LP
803 [TIMER_UNIT_INACTIVE] = "OnUnitInactiveSec",
804 [TIMER_CALENDAR] = "OnCalendar"
871d7de4
LP
805};
806
807DEFINE_STRING_TABLE_LOOKUP(timer_base, TimerBase);
808
067d72c9
LP
809static const char* const timer_result_table[_TIMER_RESULT_MAX] = {
810 [TIMER_SUCCESS] = "success",
811 [TIMER_FAILURE_RESOURCES] = "resources"
812};
813
814DEFINE_STRING_TABLE_LOOKUP(timer_result, TimerResult);
815
87f0e418 816const UnitVTable timer_vtable = {
7d17cfbc 817 .object_size = sizeof(Timer),
718db961 818
f975e971
LP
819 .sections =
820 "Unit\0"
821 "Timer\0"
822 "Install\0",
d8a812d1 823 .private_section = "Timer",
5cb5a6ff 824
871d7de4 825 .init = timer_init,
034c6ed7 826 .done = timer_done,
871d7de4
LP
827 .load = timer_load,
828
829 .coldplug = timer_coldplug,
830
831 .dump = timer_dump,
832
833 .start = timer_start,
834 .stop = timer_stop,
835
836 .serialize = timer_serialize,
837 .deserialize_item = timer_deserialize_item,
838
839 .active_state = timer_active_state,
840 .sub_state_to_string = timer_sub_state_to_string,
841
3ecaa09b
LP
842 .trigger_notify = timer_trigger_notify,
843
fdf20a31 844 .reset_failed = timer_reset_failed,
8742514c 845 .time_change = timer_time_change,
5632e374 846
718db961 847 .bus_vtable = bus_timer_vtable,
d8a812d1
WC
848 .bus_set_property = bus_timer_set_property,
849
850 .can_transient = true,
5cb5a6ff 851};