]> git.ipfire.org Git - thirdparty/systemd.git/blob - src/core/timer.c
projects / thirdparty / systemd.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
Merge pull request #29343 from DaanDeMeyer/tmp
[thirdparty/systemd.git] / src / core / timer.c
1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
2
3 #include <sys/stat.h>
4 #include <sys/types.h>
5 #include <unistd.h>
6
7 #include <errno.h>
8
9 #include "alloc-util.h"
10 #include "bus-error.h"
11 #include "bus-util.h"
12 #include "dbus-timer.h"
13 #include "dbus-unit.h"
14 #include "fs-util.h"
15 #include "parse-util.h"
16 #include "random-util.h"
17 #include "serialize.h"
18 #include "special.h"
19 #include "string-table.h"
20 #include "string-util.h"
21 #include "timer.h"
22 #include "unit-name.h"
23 #include "unit.h"
24 #include "user-util.h"
25 #include "virt.h"
26
27 static 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,
32 [TIMER_FAILED] = UNIT_FAILED
33 };
34
35 static int timer_dispatch(sd_event_source *s, uint64_t usec, void *userdata);
36
37 static void timer_init(Unit *u) {
38 Timer *t = TIMER(u);
39
40 assert(u);
41 assert(u->load_state == UNIT_STUB);
42
43 t->next_elapse_monotonic_or_boottime = USEC_INFINITY;
44 t->next_elapse_realtime = USEC_INFINITY;
45 t->accuracy_usec = u->manager->defaults.timer_accuracy_usec;
46 t->remain_after_elapse = true;
47 }
48
49 void timer_free_values(Timer *t) {
50 TimerValue *v;
51
52 assert(t);
53
54 while ((v = LIST_POP(value, t->values))) {
55 calendar_spec_free(v->calendar_spec);
56 free(v);
57 }
58 }
59
60 static void timer_done(Unit *u) {
61 Timer *t = TIMER(u);
62
63 assert(t);
64
65 timer_free_values(t);
66
67 t->monotonic_event_source = sd_event_source_disable_unref(t->monotonic_event_source);
68 t->realtime_event_source = sd_event_source_disable_unref(t->realtime_event_source);
69
70 t->stamp_path = mfree(t->stamp_path);
71 }
72
73 static int timer_verify(Timer *t) {
74 assert(t);
75 assert(UNIT(t)->load_state == UNIT_LOADED);
76
77 if (!t->values && !t->on_clock_change && !t->on_timezone_change)
78 return log_unit_error_errno(UNIT(t), SYNTHETIC_ERRNO(ENOEXEC), "Timer unit lacks value setting. Refusing.");
79
80 return 0;
81 }
82
83 static int timer_add_default_dependencies(Timer *t) {
84 int r;
85
86 assert(t);
87
88 if (!UNIT(t)->default_dependencies)
89 return 0;
90
91 r = unit_add_dependency_by_name(UNIT(t), UNIT_BEFORE, SPECIAL_TIMERS_TARGET, true, UNIT_DEPENDENCY_DEFAULT);
92 if (r < 0)
93 return r;
94
95 if (MANAGER_IS_SYSTEM(UNIT(t)->manager)) {
96 r = unit_add_two_dependencies_by_name(UNIT(t), UNIT_AFTER, UNIT_REQUIRES, SPECIAL_SYSINIT_TARGET, true, UNIT_DEPENDENCY_DEFAULT);
97 if (r < 0)
98 return r;
99
100 LIST_FOREACH(value, v, t->values) {
101 if (v->base != TIMER_CALENDAR)
102 continue;
103
104 FOREACH_STRING(target, SPECIAL_TIME_SYNC_TARGET, SPECIAL_TIME_SET_TARGET) {
105 r = unit_add_dependency_by_name(UNIT(t), UNIT_AFTER, target, true, UNIT_DEPENDENCY_DEFAULT);
106 if (r < 0)
107 return r;
108 }
109
110 break;
111 }
112 }
113
114 return unit_add_two_dependencies_by_name(UNIT(t), UNIT_BEFORE, UNIT_CONFLICTS, SPECIAL_SHUTDOWN_TARGET, true, UNIT_DEPENDENCY_DEFAULT);
115 }
116
117 static int timer_add_trigger_dependencies(Timer *t) {
118 Unit *x;
119 int r;
120
121 assert(t);
122
123 if (UNIT_TRIGGER(UNIT(t)))
124 return 0;
125
126 r = unit_load_related_unit(UNIT(t), ".service", &x);
127 if (r < 0)
128 return r;
129
130 return unit_add_two_dependencies(UNIT(t), UNIT_BEFORE, UNIT_TRIGGERS, x, true, UNIT_DEPENDENCY_IMPLICIT);
131 }
132
133 static int timer_setup_persistent(Timer *t) {
134 _cleanup_free_ char *stamp_path = NULL;
135 int r;
136
137 assert(t);
138
139 if (!t->persistent)
140 return 0;
141
142 if (MANAGER_IS_SYSTEM(UNIT(t)->manager)) {
143
144 r = unit_require_mounts_for(UNIT(t), "/var/lib/systemd/timers", UNIT_DEPENDENCY_FILE);
145 if (r < 0)
146 return r;
147
148 stamp_path = strjoin("/var/lib/systemd/timers/stamp-", UNIT(t)->id);
149 } else {
150 const char *e;
151
152 e = getenv("XDG_DATA_HOME");
153 if (e)
154 stamp_path = strjoin(e, "/systemd/timers/stamp-", UNIT(t)->id);
155 else {
156
157 _cleanup_free_ char *h = NULL;
158
159 r = get_home_dir(&h);
160 if (r < 0)
161 return log_unit_error_errno(UNIT(t), r, "Failed to determine home directory: %m");
162
163 stamp_path = strjoin(h, "/.local/share/systemd/timers/stamp-", UNIT(t)->id);
164 }
165 }
166
167 if (!stamp_path)
168 return log_oom();
169
170 return free_and_replace(t->stamp_path, stamp_path);
171 }
172
173 static uint64_t timer_get_fixed_delay_hash(Timer *t) {
174 static const uint8_t hash_key[] = {
175 0x51, 0x0a, 0xdb, 0x76, 0x29, 0x51, 0x42, 0xc2,
176 0x80, 0x35, 0xea, 0xe6, 0x8e, 0x3a, 0x37, 0xbd
177 };
178
179 struct siphash state;
180 sd_id128_t machine_id;
181 uid_t uid;
182 int r;
183
184 assert(t);
185
186 uid = getuid();
187 r = sd_id128_get_machine(&machine_id);
188 if (r < 0) {
189 log_unit_debug_errno(UNIT(t), r,
190 "Failed to get machine ID for the fixed delay calculation, proceeding with 0: %m");
191 machine_id = SD_ID128_NULL;
192 }
193
194 siphash24_init(&state, hash_key);
195 siphash24_compress(&machine_id, sizeof(sd_id128_t), &state);
196 siphash24_compress_boolean(MANAGER_IS_SYSTEM(UNIT(t)->manager), &state);
197 siphash24_compress(&uid, sizeof(uid_t), &state);
198 siphash24_compress_string(UNIT(t)->id, &state);
199
200 return siphash24_finalize(&state);
201 }
202
203 static int timer_load(Unit *u) {
204 Timer *t = TIMER(u);
205 int r;
206
207 assert(u);
208 assert(u->load_state == UNIT_STUB);
209
210 r = unit_load_fragment_and_dropin(u, true);
211 if (r < 0)
212 return r;
213
214 if (u->load_state != UNIT_LOADED)
215 return 0;
216
217 /* This is a new unit? Then let's add in some extras */
218 r = timer_add_trigger_dependencies(t);
219 if (r < 0)
220 return r;
221
222 r = timer_setup_persistent(t);
223 if (r < 0)
224 return r;
225
226 r = timer_add_default_dependencies(t);
227 if (r < 0)
228 return r;
229
230 return timer_verify(t);
231 }
232
233 static void timer_dump(Unit *u, FILE *f, const char *prefix) {
234 Timer *t = TIMER(u);
235 Unit *trigger;
236
237 trigger = UNIT_TRIGGER(u);
238
239 fprintf(f,
240 "%sTimer State: %s\n"
241 "%sResult: %s\n"
242 "%sUnit: %s\n"
243 "%sPersistent: %s\n"
244 "%sWakeSystem: %s\n"
245 "%sAccuracy: %s\n"
246 "%sRemainAfterElapse: %s\n"
247 "%sFixedRandomDelay: %s\n"
248 "%sOnClockChange: %s\n"
249 "%sOnTimeZoneChange: %s\n",
250 prefix, timer_state_to_string(t->state),
251 prefix, timer_result_to_string(t->result),
252 prefix, trigger ? trigger->id : "n/a",
253 prefix, yes_no(t->persistent),
254 prefix, yes_no(t->wake_system),
255 prefix, FORMAT_TIMESPAN(t->accuracy_usec, 1),
256 prefix, yes_no(t->remain_after_elapse),
257 prefix, yes_no(t->fixed_random_delay),
258 prefix, yes_no(t->on_clock_change),
259 prefix, yes_no(t->on_timezone_change));
260
261 LIST_FOREACH(value, v, t->values)
262 if (v->base == TIMER_CALENDAR) {
263 _cleanup_free_ char *p = NULL;
264
265 (void) calendar_spec_to_string(v->calendar_spec, &p);
266
267 fprintf(f,
268 "%s%s: %s\n",
269 prefix,
270 timer_base_to_string(v->base),
271 strna(p));
272 } else
273 fprintf(f,
274 "%s%s: %s\n",
275 prefix,
276 timer_base_to_string(v->base),
277 FORMAT_TIMESPAN(v->value, 0));
278 }
279
280 static void timer_set_state(Timer *t, TimerState state) {
281 TimerState old_state;
282 assert(t);
283
284 if (t->state != state)
285 bus_unit_send_pending_change_signal(UNIT(t), false);
286
287 old_state = t->state;
288 t->state = state;
289
290 if (state != TIMER_WAITING) {
291 t->monotonic_event_source = sd_event_source_disable_unref(t->monotonic_event_source);
292 t->realtime_event_source = sd_event_source_disable_unref(t->realtime_event_source);
293 t->next_elapse_monotonic_or_boottime = USEC_INFINITY;
294 t->next_elapse_realtime = USEC_INFINITY;
295 }
296
297 if (state != old_state)
298 log_unit_debug(UNIT(t), "Changed %s -> %s", timer_state_to_string(old_state), timer_state_to_string(state));
299
300 unit_notify(UNIT(t), state_translation_table[old_state], state_translation_table[state], /* reload_success = */ true);
301 }
302
303 static void timer_enter_waiting(Timer *t, bool time_change);
304
305 static int timer_coldplug(Unit *u) {
306 Timer *t = TIMER(u);
307
308 assert(t);
309 assert(t->state == TIMER_DEAD);
310
311 if (t->deserialized_state == t->state)
312 return 0;
313
314 if (t->deserialized_state == TIMER_WAITING)
315 timer_enter_waiting(t, false);
316 else
317 timer_set_state(t, t->deserialized_state);
318
319 return 0;
320 }
321
322 static void timer_enter_dead(Timer *t, TimerResult f) {
323 assert(t);
324
325 if (t->result == TIMER_SUCCESS)
326 t->result = f;
327
328 unit_log_result(UNIT(t), t->result == TIMER_SUCCESS, timer_result_to_string(t->result));
329 timer_set_state(t, t->result != TIMER_SUCCESS ? TIMER_FAILED : TIMER_DEAD);
330 }
331
332 static void timer_enter_elapsed(Timer *t, bool leave_around) {
333 assert(t);
334
335 /* If a unit is marked with RemainAfterElapse=yes we leave it
336 * around even after it elapsed once, so that starting it
337 * later again does not necessarily mean immediate
338 * retriggering. We unconditionally leave units with
339 * TIMER_UNIT_ACTIVE or TIMER_UNIT_INACTIVE triggers around,
340 * since they might be restarted automatically at any time
341 * later on. */
342
343 if (t->remain_after_elapse || leave_around)
344 timer_set_state(t, TIMER_ELAPSED);
345 else
346 timer_enter_dead(t, TIMER_SUCCESS);
347 }
348
349 static void add_random(Timer *t, usec_t *v) {
350 usec_t add;
351
352 assert(t);
353 assert(v);
354
355 if (t->random_usec == 0)
356 return;
357 if (*v == USEC_INFINITY)
358 return;
359
360 add = (t->fixed_random_delay ? timer_get_fixed_delay_hash(t) : random_u64()) % t->random_usec;
361
362 if (*v + add < *v) /* overflow */
363 *v = (usec_t) -2; /* Highest possible value, that is not USEC_INFINITY */
364 else
365 *v += add;
366
367 log_unit_debug(UNIT(t), "Adding %s random time.", FORMAT_TIMESPAN(add, 0));
368 }
369
370 static void timer_enter_waiting(Timer *t, bool time_change) {
371 bool found_monotonic = false, found_realtime = false;
372 bool leave_around = false;
373 triple_timestamp ts;
374 Unit *trigger;
375 int r;
376
377 assert(t);
378
379 trigger = UNIT_TRIGGER(UNIT(t));
380 if (!trigger) {
381 log_unit_error(UNIT(t), "Unit to trigger vanished.");
382 goto fail;
383 }
384
385 triple_timestamp_get(&ts);
386 t->next_elapse_monotonic_or_boottime = t->next_elapse_realtime = 0;
387
388 LIST_FOREACH(value, v, t->values) {
389 if (v->disabled)
390 continue;
391
392 if (v->base == TIMER_CALENDAR) {
393 usec_t b, rebased;
394
395 /* If we know the last time this was
396 * triggered, schedule the job based relative
397 * to that. If we don't, just start from
398 * the activation time. */
399
400 if (dual_timestamp_is_set(&t->last_trigger))
401 b = t->last_trigger.realtime;
402 else if (dual_timestamp_is_set(&UNIT(t)->inactive_exit_timestamp))
403 b = UNIT(t)->inactive_exit_timestamp.realtime;
404 else
405 b = ts.realtime;
406
407 r = calendar_spec_next_usec(v->calendar_spec, b, &v->next_elapse);
408 if (r < 0)
409 continue;
410
411 /* To make the delay due to RandomizedDelaySec= work even at boot, if the scheduled
412 * time has already passed, set the time when systemd first started as the scheduled
413 * time. Note that we base this on the monotonic timestamp of the boot, not the
414 * realtime one, since the wallclock might have been off during boot. */
415 rebased = map_clock_usec(UNIT(t)->manager->timestamps[MANAGER_TIMESTAMP_USERSPACE].monotonic,
416 CLOCK_MONOTONIC, CLOCK_REALTIME);
417 if (v->next_elapse < rebased)
418 v->next_elapse = rebased;
419
420 if (!found_realtime)
421 t->next_elapse_realtime = v->next_elapse;
422 else
423 t->next_elapse_realtime = MIN(t->next_elapse_realtime, v->next_elapse);
424
425 found_realtime = true;
426
427 } else {
428 usec_t base;
429
430 switch (v->base) {
431
432 case TIMER_ACTIVE:
433 if (state_translation_table[t->state] == UNIT_ACTIVE)
434 base = UNIT(t)->inactive_exit_timestamp.monotonic;
435 else
436 base = ts.monotonic;
437 break;
438
439 case TIMER_BOOT:
440 if (detect_container() <= 0) {
441 /* CLOCK_MONOTONIC equals the uptime on Linux */
442 base = 0;
443 break;
444 }
445 /* In a container we don't want to include the time the host
446 * was already up when the container started, so count from
447 * our own startup. */
448 _fallthrough_;
449 case TIMER_STARTUP:
450 base = UNIT(t)->manager->timestamps[MANAGER_TIMESTAMP_USERSPACE].monotonic;
451 break;
452
453 case TIMER_UNIT_ACTIVE:
454 leave_around = true;
455 base = MAX(trigger->inactive_exit_timestamp.monotonic, t->last_trigger.monotonic);
456 if (base <= 0)
457 continue;
458 break;
459
460 case TIMER_UNIT_INACTIVE:
461 leave_around = true;
462 base = MAX(trigger->inactive_enter_timestamp.monotonic, t->last_trigger.monotonic);
463 if (base <= 0)
464 continue;
465 break;
466
467 default:
468 assert_not_reached();
469 }
470
471 v->next_elapse = usec_add(usec_shift_clock(base, CLOCK_MONOTONIC, TIMER_MONOTONIC_CLOCK(t)), v->value);
472
473 if (dual_timestamp_is_set(&t->last_trigger) &&
474 !time_change &&
475 v->next_elapse < triple_timestamp_by_clock(&ts, TIMER_MONOTONIC_CLOCK(t)) &&
476 IN_SET(v->base, TIMER_ACTIVE, TIMER_BOOT, TIMER_STARTUP)) {
477 /* This is a one time trigger, disable it now */
478 v->disabled = true;
479 continue;
480 }
481
482 if (!found_monotonic)
483 t->next_elapse_monotonic_or_boottime = v->next_elapse;
484 else
485 t->next_elapse_monotonic_or_boottime = MIN(t->next_elapse_monotonic_or_boottime, v->next_elapse);
486
487 found_monotonic = true;
488 }
489 }
490
491 if (!found_monotonic && !found_realtime && !t->on_timezone_change && !t->on_clock_change) {
492 log_unit_debug(UNIT(t), "Timer is elapsed.");
493 timer_enter_elapsed(t, leave_around);
494 return;
495 }
496
497 if (found_monotonic) {
498 usec_t left;
499
500 add_random(t, &t->next_elapse_monotonic_or_boottime);
501
502 left = usec_sub_unsigned(t->next_elapse_monotonic_or_boottime, triple_timestamp_by_clock(&ts, TIMER_MONOTONIC_CLOCK(t)));
503 log_unit_debug(UNIT(t), "Monotonic timer elapses in %s.", FORMAT_TIMESPAN(left, 0));
504
505 if (t->monotonic_event_source) {
506 r = sd_event_source_set_time(t->monotonic_event_source, t->next_elapse_monotonic_or_boottime);
507 if (r < 0) {
508 log_unit_warning_errno(UNIT(t), r, "Failed to reschedule monotonic event source: %m");
509 goto fail;
510 }
511
512 r = sd_event_source_set_enabled(t->monotonic_event_source, SD_EVENT_ONESHOT);
513 if (r < 0) {
514 log_unit_warning_errno(UNIT(t), r, "Failed to enable monotonic event source: %m");
515 goto fail;
516 }
517 } else {
518
519 r = sd_event_add_time(
520 UNIT(t)->manager->event,
521 &t->monotonic_event_source,
522 t->wake_system ? CLOCK_BOOTTIME_ALARM : CLOCK_MONOTONIC,
523 t->next_elapse_monotonic_or_boottime, t->accuracy_usec,
524 timer_dispatch, t);
525 if (r < 0) {
526 log_unit_warning_errno(UNIT(t), r, "Failed to add monotonic event source: %m");
527 goto fail;
528 }
529
530 (void) sd_event_source_set_description(t->monotonic_event_source, "timer-monotonic");
531 }
532
533 } else if (t->monotonic_event_source) {
534
535 r = sd_event_source_set_enabled(t->monotonic_event_source, SD_EVENT_OFF);
536 if (r < 0) {
537 log_unit_warning_errno(UNIT(t), r, "Failed to disable monotonic event source: %m");
538 goto fail;
539 }
540 }
541
542 if (found_realtime) {
543 add_random(t, &t->next_elapse_realtime);
544
545 log_unit_debug(UNIT(t), "Realtime timer elapses at %s.", FORMAT_TIMESTAMP(t->next_elapse_realtime));
546
547 if (t->realtime_event_source) {
548 r = sd_event_source_set_time(t->realtime_event_source, t->next_elapse_realtime);
549 if (r < 0) {
550 log_unit_warning_errno(UNIT(t), r, "Failed to reschedule realtime event source: %m");
551 goto fail;
552 }
553
554 r = sd_event_source_set_enabled(t->realtime_event_source, SD_EVENT_ONESHOT);
555 if (r < 0) {
556 log_unit_warning_errno(UNIT(t), r, "Failed to enable realtime event source: %m");
557 goto fail;
558 }
559 } else {
560 r = sd_event_add_time(
561 UNIT(t)->manager->event,
562 &t->realtime_event_source,
563 t->wake_system ? CLOCK_REALTIME_ALARM : CLOCK_REALTIME,
564 t->next_elapse_realtime, t->accuracy_usec,
565 timer_dispatch, t);
566 if (r < 0) {
567 log_unit_warning_errno(UNIT(t), r, "Failed to add realtime event source: %m");
568 goto fail;
569 }
570
571 (void) sd_event_source_set_description(t->realtime_event_source, "timer-realtime");
572 }
573
574 } else if (t->realtime_event_source) {
575
576 r = sd_event_source_set_enabled(t->realtime_event_source, SD_EVENT_OFF);
577 if (r < 0) {
578 log_unit_warning_errno(UNIT(t), r, "Failed to disable realtime event source: %m");
579 goto fail;
580 }
581 }
582
583 timer_set_state(t, TIMER_WAITING);
584 return;
585
586 fail:
587 timer_enter_dead(t, TIMER_FAILURE_RESOURCES);
588 }
589
590 static void timer_enter_running(Timer *t) {
591 _cleanup_(activation_details_unrefp) ActivationDetails *details = NULL;
592 _cleanup_(sd_bus_error_free) sd_bus_error error = SD_BUS_ERROR_NULL;
593 Unit *trigger;
594 Job *job;
595 int r;
596
597 assert(t);
598
599 /* Don't start job if we are supposed to go down */
600 if (unit_stop_pending(UNIT(t)))
601 return;
602
603 trigger = UNIT_TRIGGER(UNIT(t));
604 if (!trigger) {
605 log_unit_error(UNIT(t), "Unit to trigger vanished.");
606 goto fail;
607 }
608
609 details = activation_details_new(UNIT(t));
610 if (!details) {
611 log_oom();
612 goto fail;
613 }
614
615 r = manager_add_job(UNIT(t)->manager, JOB_START, trigger, JOB_REPLACE, NULL, &error, &job);
616 if (r < 0) {
617 log_unit_warning(UNIT(t), "Failed to queue unit startup job: %s", bus_error_message(&error, r));
618 goto fail;
619 }
620
621 dual_timestamp_get(&t->last_trigger);
622 ACTIVATION_DETAILS_TIMER(details)->last_trigger = t->last_trigger;
623
624 job_set_activation_details(job, details);
625
626 if (t->stamp_path)
627 touch_file(t->stamp_path, true, t->last_trigger.realtime, UID_INVALID, GID_INVALID, MODE_INVALID);
628
629 timer_set_state(t, TIMER_RUNNING);
630 return;
631
632 fail:
633 timer_enter_dead(t, TIMER_FAILURE_RESOURCES);
634 }
635
636 static int timer_start(Unit *u) {
637 Timer *t = TIMER(u);
638 int r;
639
640 assert(t);
641 assert(IN_SET(t->state, TIMER_DEAD, TIMER_FAILED));
642
643 r = unit_test_trigger_loaded(u);
644 if (r < 0)
645 return r;
646
647 r = unit_acquire_invocation_id(u);
648 if (r < 0)
649 return r;
650
651 t->last_trigger = DUAL_TIMESTAMP_NULL;
652
653 /* Reenable all timers that depend on unit activation time */
654 LIST_FOREACH(value, v, t->values)
655 if (v->base == TIMER_ACTIVE)
656 v->disabled = false;
657
658 if (t->stamp_path) {
659 struct stat st;
660
661 if (stat(t->stamp_path, &st) >= 0) {
662 usec_t ft;
663
664 /* Load the file timestamp, but only if it is actually in the past. If it is in the future,
665 * something is wrong with the system clock. */
666
667 ft = timespec_load(&st.st_mtim);
668 if (ft < now(CLOCK_REALTIME))
669 t->last_trigger.realtime = ft;
670 else
671 log_unit_warning(u, "Not using persistent file timestamp %s as it is in the future.",
672 FORMAT_TIMESTAMP(ft));
673
674 } else if (errno == ENOENT)
675 /* The timer has never run before, make sure a stamp file exists. */
676 (void) touch_file(t->stamp_path, true, USEC_INFINITY, UID_INVALID, GID_INVALID, MODE_INVALID);
677 }
678
679 t->result = TIMER_SUCCESS;
680 timer_enter_waiting(t, false);
681 return 1;
682 }
683
684 static int timer_stop(Unit *u) {
685 Timer *t = TIMER(u);
686
687 assert(t);
688 assert(IN_SET(t->state, TIMER_WAITING, TIMER_RUNNING, TIMER_ELAPSED));
689
690 timer_enter_dead(t, TIMER_SUCCESS);
691 return 1;
692 }
693
694 static int timer_serialize(Unit *u, FILE *f, FDSet *fds) {
695 Timer *t = TIMER(u);
696
697 assert(u);
698 assert(f);
699 assert(fds);
700
701 (void) serialize_item(f, "state", timer_state_to_string(t->state));
702 (void) serialize_item(f, "result", timer_result_to_string(t->result));
703
704 if (dual_timestamp_is_set(&t->last_trigger))
705 (void) serialize_usec(f, "last-trigger-realtime", t->last_trigger.realtime);
706
707 if (t->last_trigger.monotonic > 0)
708 (void) serialize_usec(f, "last-trigger-monotonic", t->last_trigger.monotonic);
709
710 return 0;
711 }
712
713 static int timer_deserialize_item(Unit *u, const char *key, const char *value, FDSet *fds) {
714 Timer *t = TIMER(u);
715
716 assert(u);
717 assert(key);
718 assert(value);
719 assert(fds);
720
721 if (streq(key, "state")) {
722 TimerState state;
723
724 state = timer_state_from_string(value);
725 if (state < 0)
726 log_unit_debug(u, "Failed to parse state value: %s", value);
727 else
728 t->deserialized_state = state;
729
730 } else if (streq(key, "result")) {
731 TimerResult f;
732
733 f = timer_result_from_string(value);
734 if (f < 0)
735 log_unit_debug(u, "Failed to parse result value: %s", value);
736 else if (f != TIMER_SUCCESS)
737 t->result = f;
738
739 } else if (streq(key, "last-trigger-realtime"))
740 (void) deserialize_usec(value, &t->last_trigger.realtime);
741 else if (streq(key, "last-trigger-monotonic"))
742 (void) deserialize_usec(value, &t->last_trigger.monotonic);
743 else
744 log_unit_debug(u, "Unknown serialization key: %s", key);
745
746 return 0;
747 }
748
749 static UnitActiveState timer_active_state(Unit *u) {
750 assert(u);
751
752 return state_translation_table[TIMER(u)->state];
753 }
754
755 static const char *timer_sub_state_to_string(Unit *u) {
756 assert(u);
757
758 return timer_state_to_string(TIMER(u)->state);
759 }
760
761 static int timer_dispatch(sd_event_source *s, uint64_t usec, void *userdata) {
762 Timer *t = TIMER(userdata);
763
764 assert(t);
765
766 if (t->state != TIMER_WAITING)
767 return 0;
768
769 log_unit_debug(UNIT(t), "Timer elapsed.");
770 timer_enter_running(t);
771 return 0;
772 }
773
774 static void timer_trigger_notify(Unit *u, Unit *other) {
775 Timer *t = TIMER(u);
776
777 assert(u);
778 assert(other);
779
780 /* Filter out invocations with bogus state */
781 assert(UNIT_IS_LOAD_COMPLETE(other->load_state));
782
783 /* Reenable all timers that depend on unit state */
784 LIST_FOREACH(value, v, t->values)
785 if (IN_SET(v->base, TIMER_UNIT_ACTIVE, TIMER_UNIT_INACTIVE))
786 v->disabled = false;
787
788 switch (t->state) {
789
790 case TIMER_WAITING:
791 case TIMER_ELAPSED:
792
793 /* Recalculate sleep time */
794 timer_enter_waiting(t, false);
795 break;
796
797 case TIMER_RUNNING:
798
799 if (UNIT_IS_INACTIVE_OR_FAILED(unit_active_state(other))) {
800 log_unit_debug(UNIT(t), "Got notified about unit deactivation.");
801 timer_enter_waiting(t, false);
802 }
803 break;
804
805 case TIMER_DEAD:
806 case TIMER_FAILED:
807 break;
808
809 default:
810 assert_not_reached();
811 }
812 }
813
814 static void timer_reset_failed(Unit *u) {
815 Timer *t = TIMER(u);
816
817 assert(t);
818
819 if (t->state == TIMER_FAILED)
820 timer_set_state(t, TIMER_DEAD);
821
822 t->result = TIMER_SUCCESS;
823 }
824
825 static void timer_time_change(Unit *u) {
826 Timer *t = TIMER(u);
827 usec_t ts;
828
829 assert(u);
830
831 if (t->state != TIMER_WAITING)
832 return;
833
834 /* If we appear to have triggered in the future, the system clock must
835 * have been set backwards. So let's rewind our own clock and allow
836 * the future triggers to happen again :). Exactly the same as when
837 * you start a timer unit with Persistent=yes. */
838 ts = now(CLOCK_REALTIME);
839 if (t->last_trigger.realtime > ts)
840 t->last_trigger.realtime = ts;
841
842 if (t->on_clock_change) {
843 log_unit_debug(u, "Time change, triggering activation.");
844 timer_enter_running(t);
845 } else {
846 log_unit_debug(u, "Time change, recalculating next elapse.");
847 timer_enter_waiting(t, true);
848 }
849 }
850
851 static void timer_timezone_change(Unit *u) {
852 Timer *t = TIMER(u);
853
854 assert(u);
855
856 if (t->state != TIMER_WAITING)
857 return;
858
859 if (t->on_timezone_change) {
860 log_unit_debug(u, "Timezone change, triggering activation.");
861 timer_enter_running(t);
862 } else {
863 log_unit_debug(u, "Timezone change, recalculating next elapse.");
864 timer_enter_waiting(t, false);
865 }
866 }
867
868 static int timer_clean(Unit *u, ExecCleanMask mask) {
869 Timer *t = TIMER(u);
870 int r;
871
872 assert(t);
873 assert(mask != 0);
874
875 if (t->state != TIMER_DEAD)
876 return -EBUSY;
877
878 if (mask != EXEC_CLEAN_STATE)
879 return -EUNATCH;
880
881 r = timer_setup_persistent(t);
882 if (r < 0)
883 return r;
884
885 if (!t->stamp_path)
886 return -EUNATCH;
887
888 if (unlink(t->stamp_path) && errno != ENOENT)
889 return log_unit_error_errno(u, errno, "Failed to clean stamp file of timer: %m");
890
891 return 0;
892 }
893
894 static int timer_can_clean(Unit *u, ExecCleanMask *ret) {
895 Timer *t = TIMER(u);
896
897 assert(t);
898 assert(ret);
899
900 *ret = t->persistent ? EXEC_CLEAN_STATE : 0;
901 return 0;
902 }
903
904 static int timer_can_start(Unit *u) {
905 Timer *t = TIMER(u);
906 int r;
907
908 assert(t);
909
910 r = unit_test_start_limit(u);
911 if (r < 0) {
912 timer_enter_dead(t, TIMER_FAILURE_START_LIMIT_HIT);
913 return r;
914 }
915
916 return 1;
917 }
918
919 static void activation_details_timer_serialize(ActivationDetails *details, FILE *f) {
920 ActivationDetailsTimer *t = ACTIVATION_DETAILS_TIMER(details);
921
922 assert(details);
923 assert(f);
924 assert(t);
925
926 (void) serialize_dual_timestamp(f, "activation-details-timer-last-trigger", &t->last_trigger);
927 }
928
929 static int activation_details_timer_deserialize(const char *key, const char *value, ActivationDetails **details) {
930 int r;
931
932 assert(key);
933 assert(value);
934
935 if (!details || !*details)
936 return -EINVAL;
937
938 ActivationDetailsTimer *t = ACTIVATION_DETAILS_TIMER(*details);
939 if (!t)
940 return -EINVAL;
941
942 if (!streq(key, "activation-details-timer-last-trigger"))
943 return -EINVAL;
944
945 r = deserialize_dual_timestamp(value, &t->last_trigger);
946 if (r < 0)
947 return r;
948
949 return 0;
950 }
951
952 static int activation_details_timer_append_env(ActivationDetails *details, char ***strv) {
953 ActivationDetailsTimer *t = ACTIVATION_DETAILS_TIMER(details);
954 int r;
955
956 assert(details);
957 assert(strv);
958 assert(t);
959
960 if (!dual_timestamp_is_set(&t->last_trigger))
961 return 0;
962
963 r = strv_extendf(strv, "TRIGGER_TIMER_REALTIME_USEC=" USEC_FMT, t->last_trigger.realtime);
964 if (r < 0)
965 return r;
966
967 r = strv_extendf(strv, "TRIGGER_TIMER_MONOTONIC_USEC=" USEC_FMT, t->last_trigger.monotonic);
968 if (r < 0)
969 return r;
970
971 return 2; /* Return the number of variables added to the env block */
972 }
973
974 static int activation_details_timer_append_pair(ActivationDetails *details, char ***strv) {
975 ActivationDetailsTimer *t = ACTIVATION_DETAILS_TIMER(details);
976 int r;
977
978 assert(details);
979 assert(strv);
980 assert(t);
981
982 if (!dual_timestamp_is_set(&t->last_trigger))
983 return 0;
984
985 r = strv_extend(strv, "trigger_timer_realtime_usec");
986 if (r < 0)
987 return r;
988
989 r = strv_extendf(strv, USEC_FMT, t->last_trigger.realtime);
990 if (r < 0)
991 return r;
992
993 r = strv_extend(strv, "trigger_timer_monotonic_usec");
994 if (r < 0)
995 return r;
996
997 r = strv_extendf(strv, USEC_FMT, t->last_trigger.monotonic);
998 if (r < 0)
999 return r;
1000
1001 return 2; /* Return the number of pairs added to the env block */
1002 }
1003
1004 static const char* const timer_base_table[_TIMER_BASE_MAX] = {
1005 [TIMER_ACTIVE] = "OnActiveSec",
1006 [TIMER_BOOT] = "OnBootSec",
1007 [TIMER_STARTUP] = "OnStartupSec",
1008 [TIMER_UNIT_ACTIVE] = "OnUnitActiveSec",
1009 [TIMER_UNIT_INACTIVE] = "OnUnitInactiveSec",
1010 [TIMER_CALENDAR] = "OnCalendar"
1011 };
1012
1013 DEFINE_STRING_TABLE_LOOKUP(timer_base, TimerBase);
1014
1015 static const char* const timer_result_table[_TIMER_RESULT_MAX] = {
1016 [TIMER_SUCCESS] = "success",
1017 [TIMER_FAILURE_RESOURCES] = "resources",
1018 [TIMER_FAILURE_START_LIMIT_HIT] = "start-limit-hit",
1019 };
1020
1021 DEFINE_STRING_TABLE_LOOKUP(timer_result, TimerResult);
1022
1023 const UnitVTable timer_vtable = {
1024 .object_size = sizeof(Timer),
1025
1026 .sections =
1027 "Unit\0"
1028 "Timer\0"
1029 "Install\0",
1030 .private_section = "Timer",
1031
1032 .can_transient = true,
1033 .can_fail = true,
1034 .can_trigger = true,
1035
1036 .init = timer_init,
1037 .done = timer_done,
1038 .load = timer_load,
1039
1040 .coldplug = timer_coldplug,
1041
1042 .dump = timer_dump,
1043
1044 .start = timer_start,
1045 .stop = timer_stop,
1046
1047 .clean = timer_clean,
1048 .can_clean = timer_can_clean,
1049
1050 .serialize = timer_serialize,
1051 .deserialize_item = timer_deserialize_item,
1052
1053 .active_state = timer_active_state,
1054 .sub_state_to_string = timer_sub_state_to_string,
1055
1056 .trigger_notify = timer_trigger_notify,
1057
1058 .reset_failed = timer_reset_failed,
1059 .time_change = timer_time_change,
1060 .timezone_change = timer_timezone_change,
1061
1062 .bus_set_property = bus_timer_set_property,
1063
1064 .can_start = timer_can_start,
1065 };
1066
1067 const ActivationDetailsVTable activation_details_timer_vtable = {
1068 .object_size = sizeof(ActivationDetailsTimer),
1069
1070 .serialize = activation_details_timer_serialize,
1071 .deserialize = activation_details_timer_deserialize,
1072 .append_env = activation_details_timer_append_env,
1073 .append_pair = activation_details_timer_append_pair,
1074 };
Unnamed repository; edit this file 'description' to name the repository.