• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

systemd / systemd / 20701275481

04 Jan 2026 11:26PM UTC coverage: 72.733% (+0.03%) from 72.702%
20701275481

push

github

yuwata
meson: remove deprecated meson options

These options are deprecated since
- 87541e254 : -Dcryptolib=
- 710653d3b : -Dintegration-tests=

310340 of 426681 relevant lines covered (72.73%)

1174897.51 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

76.64
/src/core/timer.c
1
/* SPDX-License-Identifier: LGPL-2.1-or-later */
2

3
#include <stdlib.h>
4
#include <sys/stat.h>
5
#include <unistd.h>
6

7
#include "sd-bus.h"
8

9
#include "alloc-util.h"
10
#include "bus-error.h"
11
#include "calendarspec.h"
12
#include "dbus-timer.h"
13
#include "dbus-unit.h"
14
#include "fs-util.h"
15
#include "manager.h"
16
#include "random-util.h"
17
#include "serialize.h"
18
#include "siphash24.h"
19
#include "special.h"
20
#include "string-table.h"
21
#include "string-util.h"
22
#include "strv.h"
23
#include "timer.h"
24
#include "unit.h"
25
#include "user-util.h"
26
#include "virt.h"
27

28
static const UnitActiveState state_translation_table[_TIMER_STATE_MAX] = {
29
        [TIMER_DEAD]    = UNIT_INACTIVE,
30
        [TIMER_WAITING] = UNIT_ACTIVE,
31
        [TIMER_RUNNING] = UNIT_ACTIVE,
32
        [TIMER_ELAPSED] = UNIT_ACTIVE,
33
        [TIMER_FAILED]  = UNIT_FAILED,
34
};
35

36
static int timer_dispatch(sd_event_source *s, uint64_t usec, void *userdata);
37

38
static void timer_init(Unit *u) {
542✔
39
        Timer *t = ASSERT_PTR(TIMER(u));
542✔
40

41
        assert(u->load_state == UNIT_STUB);
542✔
42

43
        t->next_elapse_monotonic_or_boottime = USEC_INFINITY;
542✔
44
        t->next_elapse_realtime = USEC_INFINITY;
542✔
45
        t->accuracy_usec = u->manager->defaults.timer_accuracy_usec;
542✔
46
        t->remain_after_elapse = true;
542✔
47
}
542✔
48

49
void timer_free_values(Timer *t) {
547✔
50
        TimerValue *v;
547✔
51

52
        assert(t);
547✔
53

54
        while ((v = LIST_POP(value, t->values))) {
1,402✔
55
                calendar_spec_free(v->calendar_spec);
855✔
56
                free(v);
855✔
57
        }
58
}
547✔
59

60
static void timer_done(Unit *u) {
542✔
61
        Timer *t = ASSERT_PTR(TIMER(u));
542✔
62

63
        timer_free_values(t);
542✔
64

65
        t->monotonic_event_source = sd_event_source_disable_unref(t->monotonic_event_source);
542✔
66
        t->realtime_event_source = sd_event_source_disable_unref(t->realtime_event_source);
542✔
67

68
        t->stamp_path = mfree(t->stamp_path);
542✔
69
}
542✔
70

71
static int timer_verify(Timer *t) {
538✔
72
        assert(t);
538✔
73
        assert(UNIT(t)->load_state == UNIT_LOADED);
538✔
74

75
        if (!t->values && !t->on_clock_change && !t->on_timezone_change)
538✔
76
                return log_unit_error_errno(UNIT(t), SYNTHETIC_ERRNO(ENOEXEC), "Timer unit lacks value setting. Refusing.");
5✔
77

78
        return 0;
79
}
80

81
static int timer_add_default_dependencies(Timer *t) {
538✔
82
        int r;
538✔
83

84
        assert(t);
538✔
85

86
        if (!UNIT(t)->default_dependencies)
538✔
87
                return 0;
88

89
        r = unit_add_dependency_by_name(UNIT(t), UNIT_BEFORE, SPECIAL_TIMERS_TARGET, true, UNIT_DEPENDENCY_DEFAULT);
538✔
90
        if (r < 0)
538✔
91
                return r;
92

93
        if (MANAGER_IS_SYSTEM(UNIT(t)->manager)) {
538✔
94
                r = unit_add_two_dependencies_by_name(UNIT(t), UNIT_AFTER, UNIT_REQUIRES, SPECIAL_SYSINIT_TARGET, true, UNIT_DEPENDENCY_DEFAULT);
347✔
95
                if (r < 0)
347✔
96
                        return r;
97

98
                LIST_FOREACH(value, v, t->values) {
582✔
99
                        if (v->base != TIMER_CALENDAR)
459✔
100
                                continue;
235✔
101

102
                        FOREACH_STRING(target, SPECIAL_TIME_SYNC_TARGET, SPECIAL_TIME_SET_TARGET) {
672✔
103
                                r = unit_add_dependency_by_name(UNIT(t), UNIT_AFTER, target, true, UNIT_DEPENDENCY_DEFAULT);
448✔
104
                                if (r < 0)
448✔
105
                                        return r;
×
106
                        }
107

108
                        break;
224✔
109
                }
110
        }
111

112
        return unit_add_two_dependencies_by_name(UNIT(t), UNIT_BEFORE, UNIT_CONFLICTS, SPECIAL_SHUTDOWN_TARGET, true, UNIT_DEPENDENCY_DEFAULT);
538✔
113
}
114

115
static int timer_add_trigger_dependencies(Timer *t) {
538✔
116
        Unit *x;
538✔
117
        int r;
538✔
118

119
        assert(t);
538✔
120

121
        if (UNIT_TRIGGER(UNIT(t)))
538✔
122
                return 0;
538✔
123

124
        r = unit_load_related_unit(UNIT(t), ".service", &x);
538✔
125
        if (r < 0)
538✔
126
                return r;
127

128
        return unit_add_two_dependencies(UNIT(t), UNIT_BEFORE, UNIT_TRIGGERS, x, true, UNIT_DEPENDENCY_IMPLICIT);
538✔
129
}
130

131
static int timer_setup_persistent(Timer *t) {
538✔
132
        _cleanup_free_ char *stamp_path = NULL;
538✔
133
        int r;
538✔
134

135
        assert(t);
538✔
136

137
        if (!t->persistent)
538✔
138
                return 0;
139

140
        if (MANAGER_IS_SYSTEM(UNIT(t)->manager)) {
218✔
141

142
                r = unit_add_mounts_for(UNIT(t), "/var/lib/systemd/timers", UNIT_DEPENDENCY_FILE, UNIT_MOUNT_REQUIRES);
218✔
143
                if (r < 0)
218✔
144
                        return r;
145

146
                stamp_path = strjoin("/var/lib/systemd/timers/stamp-", UNIT(t)->id);
218✔
147
        } else {
148
                const char *e;
×
149

150
                e = getenv("XDG_DATA_HOME");
×
151
                if (e)
×
152
                        stamp_path = strjoin(e, "/systemd/timers/stamp-", UNIT(t)->id);
×
153
                else {
154

155
                        _cleanup_free_ char *h = NULL;
×
156

157
                        r = get_home_dir(&h);
×
158
                        if (r < 0)
×
159
                                return log_unit_error_errno(UNIT(t), r, "Failed to determine home directory: %m");
×
160

161
                        stamp_path = strjoin(h, "/.local/share/systemd/timers/stamp-", UNIT(t)->id);
×
162
                }
163
        }
164

165
        if (!stamp_path)
218✔
166
                return log_oom();
×
167

168
        return free_and_replace(t->stamp_path, stamp_path);
218✔
169
}
170

171
static uint64_t timer_get_fixed_delay_hash(Timer *t) {
×
172
        static const uint8_t hash_key[] = {
×
173
                0x51, 0x0a, 0xdb, 0x76, 0x29, 0x51, 0x42, 0xc2,
174
                0x80, 0x35, 0xea, 0xe6, 0x8e, 0x3a, 0x37, 0xbd
175
        };
176

177
        struct siphash state;
×
178
        sd_id128_t machine_id;
×
179
        uid_t uid;
×
180
        int r;
×
181

182
        assert(t);
×
183

184
        uid = getuid();
×
185
        r = sd_id128_get_machine(&machine_id);
×
186
        if (r < 0) {
×
187
                log_unit_debug_errno(UNIT(t), r,
×
188
                                     "Failed to get machine ID for the fixed delay calculation, proceeding with 0: %m");
189
                machine_id = SD_ID128_NULL;
×
190
        }
191

192
        siphash24_init(&state, hash_key);
×
193
        siphash24_compress_typesafe(machine_id, &state);
×
194
        siphash24_compress_boolean(MANAGER_IS_SYSTEM(UNIT(t)->manager), &state);
×
195
        siphash24_compress_typesafe(uid, &state);
×
196
        siphash24_compress_string(UNIT(t)->id, &state);
×
197

198
        return siphash24_finalize(&state);
×
199
}
200

201
static int timer_load(Unit *u) {
549✔
202
        Timer *t = ASSERT_PTR(TIMER(u));
549✔
203
        int r;
549✔
204

205
        assert(u->load_state == UNIT_STUB);
549✔
206

207
        r = unit_load_fragment_and_dropin(u, true);
549✔
208
        if (r < 0)
549✔
209
                return r;
210

211
        if (u->load_state != UNIT_LOADED)
538✔
212
                return 0;
213

214
        /* This is a new unit? Then let's add in some extras */
215
        r = timer_add_trigger_dependencies(t);
538✔
216
        if (r < 0)
538✔
217
                return r;
218

219
        r = timer_setup_persistent(t);
538✔
220
        if (r < 0)
538✔
221
                return r;
222

223
        r = timer_add_default_dependencies(t);
538✔
224
        if (r < 0)
538✔
225
                return r;
226

227
        return timer_verify(t);
538✔
228
}
229

230
static void timer_dump(Unit *u, FILE *f, const char *prefix) {
3✔
231
        Timer *t = ASSERT_PTR(TIMER(u));
3✔
232
        Unit *trigger;
3✔
233

234
        assert(f);
3✔
235
        assert(prefix);
3✔
236

237
        trigger = UNIT_TRIGGER(u);
3✔
238

239
        fprintf(f,
3✔
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
                "%sDeferReactivation: %s\n",
251
                prefix, timer_state_to_string(t->state),
252
                prefix, timer_result_to_string(t->result),
253
                prefix, trigger ? trigger->id : "n/a",
254
                prefix, yes_no(t->persistent),
3✔
255
                prefix, yes_no(t->wake_system),
3✔
256
                prefix, FORMAT_TIMESPAN(t->accuracy_usec, 1),
3✔
257
                prefix, yes_no(t->remain_after_elapse),
3✔
258
                prefix, yes_no(t->fixed_random_delay),
3✔
259
                prefix, yes_no(t->on_clock_change),
3✔
260
                prefix, yes_no(t->on_timezone_change),
3✔
261
                prefix, yes_no(t->defer_reactivation));
3✔
262

263
        LIST_FOREACH(value, v, t->values)
7✔
264
                if (v->base == TIMER_CALENDAR) {
4✔
265
                        _cleanup_free_ char *p = NULL;
2✔
266

267
                        (void) calendar_spec_to_string(v->calendar_spec, &p);
2✔
268

269
                        fprintf(f,
2✔
270
                                "%s%s: %s\n",
271
                                prefix,
272
                                timer_base_to_string(v->base),
273
                                strna(p));
274
                } else
275
                        fprintf(f,
2✔
276
                                "%s%s: %s\n",
277
                                prefix,
278
                                timer_base_to_string(v->base),
279
                                FORMAT_TIMESPAN(v->value, 0));
2✔
280
}
3✔
281

282
static void timer_set_state(Timer *t, TimerState state) {
739✔
283
        TimerState old_state;
739✔
284

285
        assert(t);
739✔
286

287
        if (t->state != state)
739✔
288
                bus_unit_send_pending_change_signal(UNIT(t), false);
711✔
289

290
        old_state = t->state;
739✔
291
        t->state = state;
739✔
292

293
        if (state != TIMER_WAITING) {
739✔
294
                t->monotonic_event_source = sd_event_source_disable_unref(t->monotonic_event_source);
272✔
295
                t->realtime_event_source = sd_event_source_disable_unref(t->realtime_event_source);
272✔
296
                t->next_elapse_monotonic_or_boottime = USEC_INFINITY;
272✔
297
                t->next_elapse_realtime = USEC_INFINITY;
272✔
298
        }
299

300
        if (state != old_state)
739✔
301
                log_unit_debug(UNIT(t), "Changed %s -> %s", timer_state_to_string(old_state), timer_state_to_string(state));
711✔
302

303
        unit_notify(UNIT(t), state_translation_table[old_state], state_translation_table[state], /* reload_success= */ true);
739✔
304
}
739✔
305

306
static void timer_enter_waiting(Timer *t, bool time_change);
307

308
static int timer_coldplug(Unit *u) {
253✔
309
        Timer *t = ASSERT_PTR(TIMER(u));
253✔
310

311
        assert(t->state == TIMER_DEAD);
253✔
312

313
        if (t->deserialized_state == t->state)
253✔
314
                return 0;
315

316
        if (t->deserialized_state == TIMER_WAITING)
138✔
317
                timer_enter_waiting(t, false);
138✔
318
        else
319
                timer_set_state(t, t->deserialized_state);
×
320

321
        return 0;
322
}
323

324
static void timer_enter_dead(Timer *t, TimerResult f) {
262✔
325
        assert(t);
262✔
326

327
        if (t->result == TIMER_SUCCESS || f == TIMER_FAILURE_START_LIMIT_HIT)
262✔
328
                t->result = f;
262✔
329

330
        unit_log_result(UNIT(t), t->result == TIMER_SUCCESS, timer_result_to_string(t->result));
262✔
331
        timer_set_state(t, t->result != TIMER_SUCCESS ? TIMER_FAILED : TIMER_DEAD);
524✔
332
}
262✔
333

334
static void timer_enter_elapsed(Timer *t, bool leave_around) {
1✔
335
        assert(t);
1✔
336

337
        /* If a unit is marked with RemainAfterElapse=yes we leave it
338
         * around even after it elapsed once, so that starting it
339
         * later again does not necessarily mean immediate
340
         * retriggering. We unconditionally leave units with
341
         * TIMER_UNIT_ACTIVE or TIMER_UNIT_INACTIVE triggers around,
342
         * since they might be restarted automatically at any time
343
         * later on. */
344

345
        if (t->remain_after_elapse || leave_around)
1✔
346
                timer_set_state(t, TIMER_ELAPSED);
1✔
347
        else
348
                timer_enter_dead(t, TIMER_SUCCESS);
×
349
}
1✔
350

351
static void add_random_delay(Timer *t, usec_t *v) {
468✔
352
        usec_t add;
468✔
353

354
        assert(t);
468✔
355
        assert(v);
468✔
356

357
        if (t->random_delay_usec == 0)
468✔
358
                return;
359
        if (*v == USEC_INFINITY)
76✔
360
                return;
361

362
        add = (t->fixed_random_delay ? timer_get_fixed_delay_hash(t) : random_u64()) % t->random_delay_usec;
152✔
363

364
        if (*v + add < *v) /* overflow */
76✔
365
                *v = (usec_t) -2; /* Highest possible value, that is not USEC_INFINITY */
×
366
        else
367
                *v += add;
76✔
368

369
        log_unit_debug(UNIT(t), "Adding %s random time.", FORMAT_TIMESPAN(add, 0));
76✔
370
}
371

372
static void timer_enter_waiting(Timer *t, bool time_change) {
468✔
373
        bool found_monotonic = false, found_realtime = false;
468✔
374
        bool leave_around = false;
468✔
375
        triple_timestamp ts;
468✔
376
        Unit *trigger;
468✔
377
        int r;
468✔
378

379
        assert(t);
468✔
380

381
        trigger = UNIT_TRIGGER(UNIT(t));
468✔
382
        if (!trigger) {
468✔
383
                log_unit_error(UNIT(t), "Unit to trigger vanished.");
×
384
                goto fail;
×
385
        }
386

387
        triple_timestamp_now(&ts);
468✔
388
        t->next_elapse_monotonic_or_boottime = t->next_elapse_realtime = 0;
468✔
389

390
        LIST_FOREACH(value, v, t->values) {
1,242✔
391
                if (v->disabled)
774✔
392
                        continue;
5✔
393

394
                if (v->base == TIMER_CALENDAR) {
769✔
395
                        bool rebase_after_boot_time = false;
167✔
396
                        usec_t b, random_offset = 0;
167✔
397
                        usec_t boot_monotonic = UNIT(t)->manager->timestamps[MANAGER_TIMESTAMP_USERSPACE].monotonic;
167✔
398

399
                        if (t->random_offset_usec != 0)
167✔
400
                                random_offset = timer_get_fixed_delay_hash(t) % t->random_offset_usec;
×
401

402
                        /* If DeferReactivation= is enabled, schedule the job based on the last time
403
                         * the trigger unit entered inactivity. Otherwise, if we know the last time
404
                         * this was triggered, schedule the job based relative to that. If we don't,
405
                         * just start from the activation time or realtime.
406
                         *
407
                         * Unless we have a real last-trigger time, we subtract the random_offset because
408
                         * any event that elapsed within the last random_offset has actually been delayed
409
                         * and thus hasn't truly elapsed yet. */
410

411
                        if (t->defer_reactivation &&
167✔
412
                            dual_timestamp_is_set(&trigger->inactive_enter_timestamp)) {
3✔
413
                                if (dual_timestamp_is_set(&t->last_trigger))
2✔
414
                                        b = MAX(trigger->inactive_enter_timestamp.realtime,
2✔
415
                                                t->last_trigger.realtime);
416
                                else
417
                                        b = trigger->inactive_enter_timestamp.realtime;
418
                        } else if (dual_timestamp_is_set(&t->last_trigger)) {
165✔
419
                                b = t->last_trigger.realtime;
20✔
420

421
                                /* Check if the last_trigger timestamp is older than the current machine
422
                                 * boot. If so, this means the timestamp came from a stamp file of a
423
                                 * persistent timer and we need to rebase it to make RandomizedDelaySec=
424
                                 * work (see below). */
425
                                if (t->last_trigger.monotonic < boot_monotonic)
20✔
426
                                        rebase_after_boot_time = true;
20✔
427
                        } else if (dual_timestamp_is_set(&UNIT(t)->inactive_exit_timestamp))
145✔
428
                                b = UNIT(t)->inactive_exit_timestamp.realtime - random_offset;
92✔
429
                        else {
430
                                b = ts.realtime - random_offset;
53✔
431
                                rebase_after_boot_time = true;
53✔
432
                        }
433

434
                        r = calendar_spec_next_usec(v->calendar_spec, b, &v->next_elapse);
167✔
435
                        if (r < 0)
167✔
436
                                continue;
×
437

438
                        v->next_elapse += random_offset;
167✔
439

440
                        if (rebase_after_boot_time) {
167✔
441
                                /* To make the delay due to RandomizedDelaySec= work even at boot, if the scheduled
442
                                 * time has already passed, set the time when systemd first started as the scheduled
443
                                 * time. Note that we base this on the monotonic timestamp of the boot, not the
444
                                 * realtime one, since the wallclock might have been off during boot. */
445
                                usec_t rebased = map_clock_usec(boot_monotonic, CLOCK_MONOTONIC, CLOCK_REALTIME);
73✔
446
                                if (v->next_elapse < rebased)
73✔
447
                                        v->next_elapse = rebased;
×
448
                        }
449

450
                        if (!found_realtime)
167✔
451
                                t->next_elapse_realtime = v->next_elapse;
167✔
452
                        else
453
                                t->next_elapse_realtime = MIN(t->next_elapse_realtime, v->next_elapse);
×
454

455
                        found_realtime = true;
456

457
                } else {
458
                        usec_t base;
602✔
459

460
                        switch (v->base) {
602✔
461

462
                        case TIMER_ACTIVE:
2✔
463
                                if (state_translation_table[t->state] == UNIT_ACTIVE)
2✔
464
                                        base = UNIT(t)->inactive_exit_timestamp.monotonic;
×
465
                                else
466
                                        base = ts.monotonic;
2✔
467
                                break;
468

469
                        case TIMER_BOOT:
77✔
470
                                if (detect_container() <= 0) {
77✔
471
                                        /* CLOCK_MONOTONIC equals the uptime on Linux */
472
                                        base = 0;
473
                                        break;
474
                                }
475
                                /* In a container we don't want to include the time the host
476
                                 * was already up when the container started, so count from
477
                                 * our own startup. */
478
                                _fallthrough_;
270✔
479
                        case TIMER_STARTUP:
480
                                base = UNIT(t)->manager->timestamps[MANAGER_TIMESTAMP_USERSPACE].monotonic;
270✔
481
                                break;
270✔
482

483
                        case TIMER_UNIT_ACTIVE:
301✔
484
                                leave_around = true;
301✔
485
                                base = MAX(trigger->inactive_exit_timestamp.monotonic, t->last_trigger.monotonic);
301✔
486
                                if (base <= 0)
301✔
487
                                        continue;
291✔
488
                                break;
489

490
                        case TIMER_UNIT_INACTIVE:
2✔
491
                                leave_around = true;
2✔
492
                                base = MAX(trigger->inactive_enter_timestamp.monotonic, t->last_trigger.monotonic);
2✔
493
                                if (base <= 0)
2✔
494
                                        continue;
2✔
495
                                break;
496

497
                        default:
×
498
                                assert_not_reached();
×
499
                        }
500

501
                        if (!time_change)
309✔
502
                                v->next_elapse = usec_add(usec_shift_clock(base, CLOCK_MONOTONIC, TIMER_MONOTONIC_CLOCK(t)), v->value);
894✔
503

504
                        if (dual_timestamp_is_set(&t->last_trigger) &&
309✔
505
                            !time_change &&
15✔
506
                            v->next_elapse < triple_timestamp_by_clock(&ts, TIMER_MONOTONIC_CLOCK(t)) &&
30✔
507
                            IN_SET(v->base, TIMER_ACTIVE, TIMER_BOOT, TIMER_STARTUP)) {
5✔
508
                                /* This is a one time trigger, disable it now */
509
                                v->disabled = true;
5✔
510
                                continue;
5✔
511
                        }
512

513
                        if (!found_monotonic)
304✔
514
                                t->next_elapse_monotonic_or_boottime = v->next_elapse;
301✔
515
                        else
516
                                t->next_elapse_monotonic_or_boottime = MIN(t->next_elapse_monotonic_or_boottime, v->next_elapse);
3✔
517

518
                        found_monotonic = true;
519
                }
520
        }
521

522
        if (!found_monotonic && !found_realtime && !t->on_timezone_change && !t->on_clock_change) {
468✔
523
                log_unit_debug(UNIT(t), "Timer is elapsed.");
1✔
524
                timer_enter_elapsed(t, leave_around);
1✔
525
                return;
469✔
526
        }
527

528
        if (found_monotonic) {
467✔
529
                usec_t left;
301✔
530

531
                add_random_delay(t, &t->next_elapse_monotonic_or_boottime);
301✔
532

533
                left = usec_sub_unsigned(t->next_elapse_monotonic_or_boottime, triple_timestamp_by_clock(&ts, TIMER_MONOTONIC_CLOCK(t)));
602✔
534
                log_unit_debug(UNIT(t), "Monotonic timer elapses in %s.", FORMAT_TIMESPAN(left, 0));
301✔
535

536
                if (t->monotonic_event_source) {
301✔
537
                        r = sd_event_source_set_time(t->monotonic_event_source, t->next_elapse_monotonic_or_boottime);
28✔
538
                        if (r < 0) {
28✔
539
                                log_unit_warning_errno(UNIT(t), r, "Failed to reschedule monotonic event source: %m");
×
540
                                goto fail;
×
541
                        }
542

543
                        r = sd_event_source_set_enabled(t->monotonic_event_source, SD_EVENT_ONESHOT);
28✔
544
                        if (r < 0) {
28✔
545
                                log_unit_warning_errno(UNIT(t), r, "Failed to enable monotonic event source: %m");
×
546
                                goto fail;
×
547
                        }
548
                } else {
549
                        r = sd_event_add_time(
1,092✔
550
                                        UNIT(t)->manager->event,
273✔
551
                                        &t->monotonic_event_source,
552
                                        t->wake_system ? CLOCK_BOOTTIME_ALARM : CLOCK_MONOTONIC,
273✔
553
                                        t->next_elapse_monotonic_or_boottime, t->accuracy_usec,
273✔
554
                                        timer_dispatch, t);
555
                        if (r < 0) {
273✔
556
                                log_unit_warning_errno(UNIT(t), r, "Failed to add monotonic event source: %m");
×
557
                                goto fail;
×
558
                        }
559

560
                        (void) sd_event_source_set_description(t->monotonic_event_source, "timer-monotonic");
273✔
561
                }
562

563
        } else {
564
                r = sd_event_source_set_enabled(t->monotonic_event_source, SD_EVENT_OFF);
166✔
565
                if (r < 0) {
166✔
566
                        log_unit_warning_errno(UNIT(t), r, "Failed to disable monotonic event source: %m");
×
567
                        goto fail;
×
568
                }
569
        }
570

571
        if (found_realtime) {
467✔
572
                add_random_delay(t, &t->next_elapse_realtime);
167✔
573

574
                log_unit_debug(UNIT(t), "Realtime timer elapses at %s.", FORMAT_TIMESTAMP(t->next_elapse_realtime));
167✔
575

576
                if (t->realtime_event_source) {
167✔
577
                        r = sd_event_source_set_time(t->realtime_event_source, t->next_elapse_realtime);
×
578
                        if (r < 0) {
×
579
                                log_unit_warning_errno(UNIT(t), r, "Failed to reschedule realtime event source: %m");
×
580
                                goto fail;
×
581
                        }
582

583
                        r = sd_event_source_set_enabled(t->realtime_event_source, SD_EVENT_ONESHOT);
×
584
                        if (r < 0) {
×
585
                                log_unit_warning_errno(UNIT(t), r, "Failed to enable realtime event source: %m");
×
586
                                goto fail;
×
587
                        }
588
                } else {
589
                        r = sd_event_add_time(
668✔
590
                                        UNIT(t)->manager->event,
167✔
591
                                        &t->realtime_event_source,
592
                                        t->wake_system ? CLOCK_REALTIME_ALARM : CLOCK_REALTIME,
167✔
593
                                        t->next_elapse_realtime, t->accuracy_usec,
167✔
594
                                        timer_dispatch, t);
595
                        if (r < 0) {
167✔
596
                                log_unit_warning_errno(UNIT(t), r, "Failed to add realtime event source: %m");
×
597
                                goto fail;
×
598
                        }
599

600
                        (void) sd_event_source_set_description(t->realtime_event_source, "timer-realtime");
167✔
601
                }
602

603
        } else if (t->realtime_event_source) {
300✔
604

605
                r = sd_event_source_set_enabled(t->realtime_event_source, SD_EVENT_OFF);
×
606
                if (r < 0) {
×
607
                        log_unit_warning_errno(UNIT(t), r, "Failed to disable realtime event source: %m");
×
608
                        goto fail;
×
609
                }
610
        }
611

612
        timer_set_state(t, TIMER_WAITING);
467✔
613
        return;
614

615
fail:
×
616
        timer_enter_dead(t, TIMER_FAILURE_RESOURCES);
×
617
}
618

619
static void timer_enter_running(Timer *t) {
9✔
620
        _cleanup_(activation_details_unrefp) ActivationDetails *details = NULL;
9✔
621
        _cleanup_(sd_bus_error_free) sd_bus_error error = SD_BUS_ERROR_NULL;
9✔
622
        Unit *trigger;
9✔
623
        Job *job;
9✔
624
        int r;
9✔
625

626
        assert(t);
9✔
627

628
        /* Don't start job if we are supposed to go down */
629
        if (unit_stop_pending(UNIT(t)))
9✔
630
                return;
631

632
        trigger = UNIT_TRIGGER(UNIT(t));
9✔
633
        if (!trigger) {
9✔
634
                log_unit_error(UNIT(t), "Unit to trigger vanished.");
×
635
                goto fail;
×
636
        }
637

638
        details = activation_details_new(UNIT(t));
9✔
639
        if (!details) {
9✔
640
                log_oom();
×
641
                goto fail;
×
642
        }
643

644
        r = manager_add_job(UNIT(t)->manager, JOB_START, trigger, JOB_REPLACE, &error, &job);
9✔
645
        if (r < 0) {
9✔
646
                log_unit_warning(UNIT(t), "Failed to queue unit startup job: %s", bus_error_message(&error, r));
×
647
                goto fail;
×
648
        }
649

650
        dual_timestamp_now(&t->last_trigger);
9✔
651
        ACTIVATION_DETAILS_TIMER(details)->last_trigger = t->last_trigger;
9✔
652

653
        job_set_activation_details(job, details);
9✔
654

655
        if (t->stamp_path)
9✔
656
                touch_file(t->stamp_path, true, t->last_trigger.realtime, UID_INVALID, GID_INVALID, MODE_INVALID);
×
657

658
        timer_set_state(t, TIMER_RUNNING);
9✔
659
        return;
660

661
fail:
×
662
        timer_enter_dead(t, TIMER_FAILURE_RESOURCES);
×
663
}
664

665
static int timer_start(Unit *u) {
295✔
666
        Timer *t = ASSERT_PTR(TIMER(u));
295✔
667
        int r;
295✔
668

669
        assert(IN_SET(t->state, TIMER_DEAD, TIMER_FAILED));
295✔
670

671
        r = unit_acquire_invocation_id(u);
295✔
672
        if (r < 0)
295✔
673
                return r;
674

675
        /* Reenable all timers that depend on unit activation time */
676
        LIST_FOREACH(value, v, t->values)
815✔
677
                if (v->base == TIMER_ACTIVE)
520✔
678
                        v->disabled = false;
2✔
679

680
        if (t->stamp_path) {
295✔
681
                struct stat st;
73✔
682

683
                if (stat(t->stamp_path, &st) >= 0) {
73✔
684
                        usec_t ft;
20✔
685

686
                        /* Load the file timestamp, but only if it is actually in the past. If it is in the future,
687
                         * something is wrong with the system clock. */
688

689
                        ft = timespec_load(&st.st_mtim);
20✔
690
                        if (ft < now(CLOCK_REALTIME))
20✔
691
                                t->last_trigger.realtime = ft;
20✔
692
                        else
693
                                log_unit_warning(u, "Not using persistent file timestamp %s as it is in the future.",
×
694
                                                 FORMAT_TIMESTAMP(ft));
695

696
                } else if (errno == ENOENT)
53✔
697
                        /* The timer has never run before, make sure a stamp file exists. */
698
                        (void) touch_file(t->stamp_path, true, USEC_INFINITY, UID_INVALID, GID_INVALID, MODE_INVALID);
53✔
699
        }
700

701
        t->result = TIMER_SUCCESS;
295✔
702
        timer_enter_waiting(t, false);
295✔
703
        return 1;
295✔
704
}
705

706
static int timer_stop(Unit *u) {
262✔
707
        Timer *t = ASSERT_PTR(TIMER(u));
262✔
708

709
        assert(IN_SET(t->state, TIMER_WAITING, TIMER_RUNNING, TIMER_ELAPSED));
262✔
710

711
        timer_enter_dead(t, TIMER_SUCCESS);
262✔
712
        return 1;
262✔
713
}
714

715
static int timer_serialize(Unit *u, FILE *f, FDSet *fds) {
193✔
716
        Timer *t = ASSERT_PTR(TIMER(u));
193✔
717

718
        assert(f);
193✔
719
        assert(fds);
193✔
720

721
        (void) serialize_item(f, "state", timer_state_to_string(t->state));
193✔
722
        (void) serialize_item(f, "result", timer_result_to_string(t->result));
193✔
723

724
        if (dual_timestamp_is_set(&t->last_trigger))
193✔
725
                (void) serialize_usec(f, "last-trigger-realtime", t->last_trigger.realtime);
×
726

727
        if (t->last_trigger.monotonic > 0)
193✔
728
                (void) serialize_usec(f, "last-trigger-monotonic", t->last_trigger.monotonic);
×
729

730
        return 0;
193✔
731
}
732

733
static int timer_deserialize_item(Unit *u, const char *key, const char *value, FDSet *fds) {
288✔
734
        Timer *t = ASSERT_PTR(TIMER(u));
288✔
735

736
        assert(key);
288✔
737
        assert(value);
288✔
738
        assert(fds);
288✔
739

740
        if (streq(key, "state")) {
288✔
741
                TimerState state;
144✔
742

743
                state = timer_state_from_string(value);
144✔
744
                if (state < 0)
144✔
745
                        log_unit_debug(u, "Failed to parse state value: %s", value);
×
746
                else
747
                        t->deserialized_state = state;
144✔
748

749
        } else if (streq(key, "result")) {
144✔
750
                TimerResult f;
144✔
751

752
                f = timer_result_from_string(value);
144✔
753
                if (f < 0)
144✔
754
                        log_unit_debug(u, "Failed to parse result value: %s", value);
×
755
                else if (f != TIMER_SUCCESS)
144✔
756
                        t->result = f;
×
757

758
        } else if (streq(key, "last-trigger-realtime"))
×
759
                (void) deserialize_usec(value, &t->last_trigger.realtime);
×
760
        else if (streq(key, "last-trigger-monotonic"))
×
761
                (void) deserialize_usec(value, &t->last_trigger.monotonic);
×
762
        else
763
                log_unit_debug(u, "Unknown serialization key: %s", key);
×
764

765
        return 0;
288✔
766
}
767

768
static UnitActiveState timer_active_state(Unit *u) {
14,168✔
769
        Timer *t = ASSERT_PTR(TIMER(u));
14,168✔
770

771
        return state_translation_table[t->state];
14,168✔
772
}
773

774
static const char *timer_sub_state_to_string(Unit *u) {
473✔
775
        Timer *t = ASSERT_PTR(TIMER(u));
473✔
776

777
        return timer_state_to_string(t->state);
473✔
778
}
779

780
static int timer_dispatch(sd_event_source *s, uint64_t usec, void *userdata) {
9✔
781
        Timer *t = ASSERT_PTR(TIMER(userdata));
9✔
782

783
        if (t->state != TIMER_WAITING)
9✔
784
                return 0;
785

786
        log_unit_debug(UNIT(t), "Timer elapsed.");
9✔
787
        timer_enter_running(t);
9✔
788
        return 0;
9✔
789
}
790

791
static void timer_trigger_notify(Unit *u, Unit *other) {
26✔
792
        Timer *t = ASSERT_PTR(TIMER(u));
26✔
793

794
        assert(other);
26✔
795

796
        /* Filter out invocations with bogus state */
797
        assert(UNIT_IS_LOAD_COMPLETE(other->load_state));
26✔
798

799
        /* Reenable all timers that depend on unit state */
800
        LIST_FOREACH(value, v, t->values)
85✔
801
                if (IN_SET(v->base, TIMER_UNIT_ACTIVE, TIMER_UNIT_INACTIVE))
59✔
802
                        v->disabled = false;
21✔
803

804
        switch (t->state) {
26✔
805

806
        case TIMER_WAITING:
5✔
807
        case TIMER_ELAPSED:
808

809
                /* Recalculate sleep time */
810
                timer_enter_waiting(t, false);
5✔
811
                break;
5✔
812

813
        case TIMER_RUNNING:
21✔
814

815
                if (UNIT_IS_INACTIVE_OR_FAILED(unit_active_state(other))) {
21✔
816
                        log_unit_debug(UNIT(t), "Got notified about unit deactivation.");
7✔
817
                        timer_enter_waiting(t, false);
7✔
818
                }
819
                break;
820

821
        case TIMER_DEAD:
822
        case TIMER_FAILED:
823
                break;
824

825
        default:
×
826
                assert_not_reached();
×
827
        }
828
}
26✔
829

830
static void timer_reset_failed(Unit *u) {
3✔
831
        Timer *t = ASSERT_PTR(TIMER(u));
3✔
832

833
        if (t->state == TIMER_FAILED)
3✔
834
                timer_set_state(t, TIMER_DEAD);
×
835

836
        t->result = TIMER_SUCCESS;
3✔
837
}
3✔
838

839
static void timer_time_change(Unit *u) {
11✔
840
        Timer *t = ASSERT_PTR(TIMER(u));
11✔
841
        usec_t ts;
11✔
842

843
        if (t->state != TIMER_WAITING)
11✔
844
                return;
845

846
        /* If we appear to have triggered in the future, the system clock must
847
         * have been set backwards.  So let's rewind our own clock and allow
848
         * the future triggers to happen again :).  Exactly the same as when
849
         * you start a timer unit with Persistent=yes. */
850
        ts = now(CLOCK_REALTIME);
11✔
851
        if (t->last_trigger.realtime > ts)
11✔
852
                t->last_trigger.realtime = ts;
×
853

854
        if (t->on_clock_change) {
11✔
855
                log_unit_debug(u, "Time change, triggering activation.");
×
856
                timer_enter_running(t);
×
857
        } else {
858
                log_unit_debug(u, "Time change, recalculating next elapse.");
11✔
859
                timer_enter_waiting(t, true);
11✔
860
        }
861
}
862

863
static void timer_timezone_change(Unit *u) {
75✔
864
        Timer *t = ASSERT_PTR(TIMER(u));
75✔
865

866
        if (t->state != TIMER_WAITING)
75✔
867
                return;
868

869
        if (t->on_timezone_change) {
12✔
870
                log_unit_debug(u, "Timezone change, triggering activation.");
×
871
                timer_enter_running(t);
×
872
        } else {
873
                log_unit_debug(u, "Timezone change, recalculating next elapse.");
12✔
874
                timer_enter_waiting(t, false);
12✔
875
        }
876
}
877

878
static int timer_clean(Unit *u, ExecCleanMask mask) {
×
879
        Timer *t = ASSERT_PTR(TIMER(u));
×
880
        int r;
×
881

882
        assert(mask != 0);
×
883

884
        if (t->state != TIMER_DEAD)
×
885
                return -EBUSY;
886

887
        if (mask != EXEC_CLEAN_STATE)
×
888
                return -EUNATCH;
889

890
        r = timer_setup_persistent(t);
×
891
        if (r < 0)
×
892
                return r;
893

894
        if (!t->stamp_path)
×
895
                return -EUNATCH;
896

897
        if (unlink(t->stamp_path) && errno != ENOENT)
×
898
                return log_unit_error_errno(u, errno, "Failed to clean stamp file of timer: %m");
×
899

900
        return 0;
901
}
902

903
static int timer_can_clean(Unit *u, ExecCleanMask *ret) {
7✔
904
        Timer *t = ASSERT_PTR(TIMER(u));
7✔
905

906
        assert(ret);
7✔
907

908
        *ret = t->persistent ? EXEC_CLEAN_STATE : 0;
7✔
909
        return 0;
7✔
910
}
911

912
static int timer_test_startable(Unit *u) {
295✔
913
        Timer *t = ASSERT_PTR(TIMER(u));
295✔
914
        int r;
295✔
915

916
        r = unit_test_trigger_loaded(u);
295✔
917
        if (r < 0)
295✔
918
                return r;
919

920
        r = unit_test_start_limit(u);
295✔
921
        if (r < 0) {
295✔
922
                timer_enter_dead(t, TIMER_FAILURE_START_LIMIT_HIT);
×
923
                return r;
×
924
        }
925

926
        return true;
927
}
928

929
static void activation_details_timer_serialize(const ActivationDetails *details, FILE *f) {
×
930
        const ActivationDetailsTimer *t = ASSERT_PTR(ACTIVATION_DETAILS_TIMER(details));
×
931

932
        assert(f);
×
933
        assert(t);
×
934

935
        (void) serialize_dual_timestamp(f, "activation-details-timer-last-trigger", &t->last_trigger);
×
936
}
×
937

938
static int activation_details_timer_deserialize(const char *key, const char *value, ActivationDetails **details) {
×
939
        int r;
×
940

941
        assert(key);
×
942
        assert(value);
×
943

944
        if (!details || !*details)
×
945
                return -EINVAL;
946

947
        ActivationDetailsTimer *t = ACTIVATION_DETAILS_TIMER(*details);
×
948
        if (!t)
×
949
                return -EINVAL;
950

951
        if (!streq(key, "activation-details-timer-last-trigger"))
×
952
                return -EINVAL;
953

954
        r = deserialize_dual_timestamp(value, &t->last_trigger);
×
955
        if (r < 0)
×
956
                return r;
×
957

958
        return 0;
959
}
960

961
static int activation_details_timer_append_env(const ActivationDetails *details, char ***strv) {
9✔
962
        const ActivationDetailsTimer *t = ASSERT_PTR(ACTIVATION_DETAILS_TIMER(details));
9✔
963
        int r;
9✔
964

965
        assert(strv);
9✔
966
        assert(t);
9✔
967

968
        if (!dual_timestamp_is_set(&t->last_trigger))
9✔
969
                return 0;
970

971
        r = strv_extendf(strv, "TRIGGER_TIMER_REALTIME_USEC=" USEC_FMT, t->last_trigger.realtime);
9✔
972
        if (r < 0)
9✔
973
                return r;
974

975
        r = strv_extendf(strv, "TRIGGER_TIMER_MONOTONIC_USEC=" USEC_FMT, t->last_trigger.monotonic);
9✔
976
        if (r < 0)
9✔
977
                return r;
×
978

979
        return 2; /* Return the number of variables added to the env block */
980
}
981

982
static int activation_details_timer_append_pair(const ActivationDetails *details, char ***strv) {
32✔
983
        const ActivationDetailsTimer *t = ASSERT_PTR(ACTIVATION_DETAILS_TIMER(details));
32✔
984
        int r;
32✔
985

986
        assert(strv);
32✔
987
        assert(t);
32✔
988

989
        if (!dual_timestamp_is_set(&t->last_trigger))
32✔
990
                return 0;
991

992
        r = strv_extend(strv, "trigger_timer_realtime_usec");
32✔
993
        if (r < 0)
32✔
994
                return r;
995

996
        r = strv_extendf(strv, USEC_FMT, t->last_trigger.realtime);
32✔
997
        if (r < 0)
32✔
998
                return r;
999

1000
        r = strv_extend(strv, "trigger_timer_monotonic_usec");
32✔
1001
        if (r < 0)
32✔
1002
                return r;
1003

1004
        r = strv_extendf(strv, USEC_FMT, t->last_trigger.monotonic);
32✔
1005
        if (r < 0)
32✔
1006
                return r;
×
1007

1008
        return 2; /* Return the number of pairs added to the env block */
1009
}
1010

1011
uint64_t timer_next_elapse_monotonic(const Timer *t) {
433✔
1012
        assert(t);
433✔
1013

1014
        return (uint64_t) usec_shift_clock(t->next_elapse_monotonic_or_boottime,
433✔
1015
                                           TIMER_MONOTONIC_CLOCK(t), CLOCK_MONOTONIC);
433✔
1016
}
1017

1018
static const char* const timer_base_table[_TIMER_BASE_MAX] = {
1019
        [TIMER_ACTIVE]        = "OnActiveSec",
1020
        [TIMER_BOOT]          = "OnBootSec",
1021
        [TIMER_STARTUP]       = "OnStartupSec",
1022
        [TIMER_UNIT_ACTIVE]   = "OnUnitActiveSec",
1023
        [TIMER_UNIT_INACTIVE] = "OnUnitInactiveSec",
1024
        [TIMER_CALENDAR]      = "OnCalendar",
1025
};
1026

1027
DEFINE_STRING_TABLE_LOOKUP(timer_base, TimerBase);
94✔
1028

1029
char* timer_base_to_usec_string(TimerBase i) {
4✔
1030
        _cleanup_free_ char *buf = NULL;
8✔
1031
        const char *s;
4✔
1032
        size_t l;
4✔
1033

1034
        s = timer_base_to_string(i);
4✔
1035

1036
        if (endswith(s, "Sec")) {
4✔
1037
                /* s/Sec/USec/ */
1038
                l = strlen(s);
4✔
1039
                buf = new(char, l+2);
4✔
1040
                if (!buf)
4✔
1041
                        return NULL;
1042

1043
                memcpy(buf, s, l-3);
4✔
1044
                memcpy(buf+l-3, "USec", 5);
4✔
1045
        } else {
1046
                buf = strdup(s);
×
1047
                if (!buf)
×
1048
                        return NULL;
×
1049
        }
1050

1051
        return TAKE_PTR(buf);
1052
}
1053

1054
static const char* const timer_result_table[_TIMER_RESULT_MAX] = {
1055
        [TIMER_SUCCESS]                 = "success",
1056
        [TIMER_FAILURE_RESOURCES]       = "resources",
1057
        [TIMER_FAILURE_START_LIMIT_HIT] = "start-limit-hit",
1058
};
1059

1060
DEFINE_STRING_TABLE_LOOKUP(timer_result, TimerResult);
1,087✔
1061

1062
const UnitVTable timer_vtable = {
1063
        .object_size = sizeof(Timer),
1064

1065
        .sections =
1066
                "Unit\0"
1067
                "Timer\0"
1068
                "Install\0",
1069
        .private_section = "Timer",
1070

1071
        .can_transient = true,
1072
        .can_fail = true,
1073
        .can_trigger = true,
1074

1075
        .init = timer_init,
1076
        .done = timer_done,
1077
        .load = timer_load,
1078

1079
        .coldplug = timer_coldplug,
1080

1081
        .dump = timer_dump,
1082

1083
        .start = timer_start,
1084
        .stop = timer_stop,
1085

1086
        .clean = timer_clean,
1087
        .can_clean = timer_can_clean,
1088

1089
        .serialize = timer_serialize,
1090
        .deserialize_item = timer_deserialize_item,
1091

1092
        .active_state = timer_active_state,
1093
        .sub_state_to_string = timer_sub_state_to_string,
1094

1095
        .trigger_notify = timer_trigger_notify,
1096

1097
        .reset_failed = timer_reset_failed,
1098
        .time_change = timer_time_change,
1099
        .timezone_change = timer_timezone_change,
1100

1101
        .bus_set_property = bus_timer_set_property,
1102

1103
        .test_startable = timer_test_startable,
1104
};
1105

1106
const ActivationDetailsVTable activation_details_timer_vtable = {
1107
        .object_size = sizeof(ActivationDetailsTimer),
1108

1109
        .serialize = activation_details_timer_serialize,
1110
        .deserialize = activation_details_timer_deserialize,
1111
        .append_env = activation_details_timer_append_env,
1112
        .append_pair = activation_details_timer_append_pair,
1113
};
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2026 Coveralls, Inc