]> git.ipfire.org Git - thirdparty/systemd.git/blame - src/core/job.c
job: when a job was skipped due to a failed condition, log about it
[thirdparty/systemd.git] / src / core / job.c
CommitLineData
53e1b683 1/* SPDX-License-Identifier: LGPL-2.1+ */
a7334b09 2
1ffba6fe 3#include <errno.h>
60918275 4
718db961
LP
5#include "sd-id128.h"
6#include "sd-messages.h"
4f5dd394 7
b5efdb8a 8#include "alloc-util.h"
f485606b 9#include "async.h"
4f5dd394 10#include "dbus-job.h"
8f8f05a9 11#include "dbus.h"
4f5dd394 12#include "escape.h"
8948b341 13#include "fileio.h"
6bedfcbb 14#include "job.h"
4f5dd394
LP
15#include "log.h"
16#include "macro.h"
6bedfcbb 17#include "parse-util.h"
d68c645b 18#include "serialize.h"
4f5dd394
LP
19#include "set.h"
20#include "special.h"
d054f0a4 21#include "stdio-util.h"
8b43440b 22#include "string-table.h"
07630cea 23#include "string-util.h"
4f5dd394 24#include "strv.h"
288a74cc 25#include "terminal-util.h"
4f5dd394
LP
26#include "unit.h"
27#include "virt.h"
97e6a119 28
39a18c60 29Job* job_new_raw(Unit *unit) {
60918275
LP
30 Job *j;
31
39a18c60
MS
32 /* used for deserialization */
33
87f0e418 34 assert(unit);
60918275 35
08ac00f2 36 j = new(Job, 1);
39a18c60 37 if (!j)
60918275
LP
38 return NULL;
39
08ac00f2
LP
40 *j = (Job) {
41 .manager = unit->manager,
42 .unit = unit,
43 .type = _JOB_TYPE_INVALID,
44 };
faf919f1 45
39a18c60
MS
46 return j;
47}
48
49Job* job_new(Unit *unit, JobType type) {
50 Job *j;
51
52 assert(type < _JOB_TYPE_MAX);
53
54 j = job_new_raw(unit);
55 if (!j)
56 return NULL;
57
58 j->id = j->manager->current_job_id++;
59 j->type = type;
60
e5b5ae50 61 /* We don't link it here, that's what job_dependency() is for */
60918275
LP
62
63 return j;
64}
65
a7a7163d 66void job_unlink(Job *j) {
97e7d748
MS
67 assert(j);
68 assert(!j->installed);
02a3bcc6
MS
69 assert(!j->transaction_prev);
70 assert(!j->transaction_next);
71 assert(!j->subject_list);
72 assert(!j->object_list);
60918275 73
a7a7163d 74 if (j->in_run_queue) {
71fda00f 75 LIST_REMOVE(run_queue, j->manager->run_queue, j);
a7a7163d
DT
76 j->in_run_queue = false;
77 }
c1e1601e 78
a7a7163d 79 if (j->in_dbus_queue) {
71fda00f 80 LIST_REMOVE(dbus_queue, j->manager->dbus_job_queue, j);
a7a7163d
DT
81 j->in_dbus_queue = false;
82 }
c1e1601e 83
a7a7163d 84 if (j->in_gc_queue) {
c5a97ed1 85 LIST_REMOVE(gc_queue, j->manager->gc_job_queue, j);
a7a7163d
DT
86 j->in_gc_queue = false;
87 }
c5a97ed1 88
a7a7163d
DT
89 j->timer_event_source = sd_event_source_unref(j->timer_event_source);
90}
91
92void job_free(Job *j) {
93 assert(j);
94 assert(!j->installed);
95 assert(!j->transaction_prev);
96 assert(!j->transaction_next);
97 assert(!j->subject_list);
98 assert(!j->object_list);
99
100 job_unlink(j);
faf919f1 101
1a465207 102 sd_bus_track_unref(j->bus_track);
b39a2770 103 strv_free(j->deserialized_clients);
faf919f1 104
60918275
LP
105 free(j);
106}
a66d02c3 107
9c3349e2
LP
108static void job_set_state(Job *j, JobState state) {
109 assert(j);
110 assert(state >= 0);
111 assert(state < _JOB_STATE_MAX);
112
113 if (j->state == state)
114 return;
115
116 j->state = state;
117
118 if (!j->installed)
119 return;
120
121 if (j->state == JOB_RUNNING)
122 j->unit->manager->n_running_jobs++;
123 else {
124 assert(j->state == JOB_WAITING);
125 assert(j->unit->manager->n_running_jobs > 0);
126
127 j->unit->manager->n_running_jobs--;
128
129 if (j->unit->manager->n_running_jobs <= 0)
130 j->unit->manager->jobs_in_progress_event_source = sd_event_source_unref(j->unit->manager->jobs_in_progress_event_source);
131 }
132}
133
05d576f1 134void job_uninstall(Job *j) {
e0209d83
MS
135 Job **pj;
136
05d576f1 137 assert(j->installed);
e0209d83 138
9c3349e2
LP
139 job_set_state(j, JOB_WAITING);
140
e0209d83
MS
141 pj = (j->type == JOB_NOP) ? &j->unit->nop_job : &j->unit->job;
142 assert(*pj == j);
143
05d576f1
MS
144 /* Detach from next 'bigger' objects */
145
39a18c60 146 /* daemon-reload should be transparent to job observers */
2c289ea8 147 if (!MANAGER_IS_RELOADING(j->manager))
39a18c60 148 bus_job_send_removed_signal(j);
05d576f1 149
e0209d83
MS
150 *pj = NULL;
151
d6a093d0 152 unit_add_to_gc_queue(j->unit);
05d576f1
MS
153
154 hashmap_remove(j->manager->jobs, UINT32_TO_PTR(j->id));
155 j->installed = false;
156}
157
656bbffc
MS
158static bool job_type_allows_late_merge(JobType t) {
159 /* Tells whether it is OK to merge a job of type 't' with an already
160 * running job.
161 * Reloads cannot be merged this way. Think of the sequence:
162 * 1. Reload of a daemon is in progress; the daemon has already loaded
163 * its config file, but hasn't completed the reload operation yet.
164 * 2. Edit foo's config file.
165 * 3. Trigger another reload to have the daemon use the new config.
166 * Should the second reload job be merged into the first one, the daemon
167 * would not know about the new config.
168 * JOB_RESTART jobs on the other hand can be merged, because they get
169 * patched into JOB_START after stopping the unit. So if we see a
170 * JOB_RESTART running, it means the unit hasn't stopped yet and at
171 * this time the merge is still allowed. */
e0209d83 172 return t != JOB_RELOAD;
656bbffc
MS
173}
174
175static void job_merge_into_installed(Job *j, Job *other) {
176 assert(j->installed);
177 assert(j->unit == other->unit);
178
e0209d83 179 if (j->type != JOB_NOP)
53a2383b 180 assert_se(job_type_merge_and_collapse(&j->type, other->type, j->unit) == 0);
e0209d83
MS
181 else
182 assert(other->type == JOB_NOP);
656bbffc 183
23ade460 184 j->irreversible = j->irreversible || other->irreversible;
e45460d6 185 j->ignore_order = j->ignore_order || other->ignore_order;
656bbffc
MS
186}
187
188Job* job_install(Job *j) {
e0209d83
MS
189 Job **pj;
190 Job *uj;
05d576f1 191
656bbffc 192 assert(!j->installed);
e0209d83 193 assert(j->type < _JOB_TYPE_MAX_IN_TRANSACTION);
9c3349e2 194 assert(j->state == JOB_WAITING);
e0209d83
MS
195
196 pj = (j->type == JOB_NOP) ? &j->unit->nop_job : &j->unit->job;
197 uj = *pj;
656bbffc 198
05d576f1 199 if (uj) {
61da906a 200 if (job_type_is_conflicting(uj->type, j->type))
833f92ad 201 job_finish_and_invalidate(uj, JOB_CANCELED, false, false);
656bbffc
MS
202 else {
203 /* not conflicting, i.e. mergeable */
204
61da906a 205 if (uj->state == JOB_WAITING ||
656bbffc
MS
206 (job_type_allows_late_merge(j->type) && job_type_is_superset(uj->type, j->type))) {
207 job_merge_into_installed(uj, j);
f2341e0a 208 log_unit_debug(uj->unit,
66870f90
ZJS
209 "Merged into installed job %s/%s as %u",
210 uj->unit->id, job_type_to_string(uj->type), (unsigned) uj->id);
656bbffc
MS
211 return uj;
212 } else {
213 /* already running and not safe to merge into */
214 /* Patch uj to become a merged job and re-run it. */
215 /* XXX It should be safer to queue j to run after uj finishes, but it is
216 * not currently possible to have more than one installed job per unit. */
217 job_merge_into_installed(uj, j);
f2341e0a 218 log_unit_debug(uj->unit,
66870f90
ZJS
219 "Merged into running job, re-running: %s/%s as %u",
220 uj->unit->id, job_type_to_string(uj->type), (unsigned) uj->id);
9c3349e2
LP
221
222 job_set_state(uj, JOB_WAITING);
656bbffc
MS
223 return uj;
224 }
225 }
05d576f1
MS
226 }
227
656bbffc 228 /* Install the job */
e0209d83 229 *pj = j;
05d576f1 230 j->installed = true;
9c3349e2 231
313cefa1 232 j->manager->n_installed_jobs++;
f2341e0a 233 log_unit_debug(j->unit,
66870f90
ZJS
234 "Installed new job %s/%s as %u",
235 j->unit->id, job_type_to_string(j->type), (unsigned) j->id);
c5a97ed1
LP
236
237 job_add_to_gc_queue(j);
238
656bbffc 239 return j;
05d576f1
MS
240}
241
e0209d83
MS
242int job_install_deserialized(Job *j) {
243 Job **pj;
244
39a18c60
MS
245 assert(!j->installed);
246
e0209d83
MS
247 if (j->type < 0 || j->type >= _JOB_TYPE_MAX_IN_TRANSACTION) {
248 log_debug("Invalid job type %s in deserialization.", strna(job_type_to_string(j->type)));
249 return -EINVAL;
250 }
251
252 pj = (j->type == JOB_NOP) ? &j->unit->nop_job : &j->unit->job;
e0209d83 253 if (*pj) {
f2341e0a 254 log_unit_debug(j->unit, "Unit already has a job installed. Not installing deserialized job.");
e0209d83 255 return -EEXIST;
39a18c60 256 }
9c3349e2 257
e0209d83 258 *pj = j;
39a18c60 259 j->installed = true;
a7a7163d 260 j->reloaded = true;
9c3349e2
LP
261
262 if (j->state == JOB_RUNNING)
263 j->unit->manager->n_running_jobs++;
264
f2341e0a 265 log_unit_debug(j->unit,
66870f90
ZJS
266 "Reinstalled deserialized job %s/%s as %u",
267 j->unit->id, job_type_to_string(j->type), (unsigned) j->id);
e0209d83 268 return 0;
39a18c60
MS
269}
270
1da4264f 271JobDependency* job_dependency_new(Job *subject, Job *object, bool matters, bool conflicts) {
e5b5ae50
LP
272 JobDependency *l;
273
274 assert(object);
275
276 /* Adds a new job link, which encodes that the 'subject' job
277 * needs the 'object' job in some way. If 'subject' is NULL
278 * this means the 'anchor' job (i.e. the one the user
35b8ca3a 279 * explicitly asked for) is the requester. */
e5b5ae50 280
0a23a627
LP
281 l = new0(JobDependency, 1);
282 if (!l)
e5b5ae50
LP
283 return NULL;
284
285 l->subject = subject;
286 l->object = object;
287 l->matters = matters;
69dd2852 288 l->conflicts = conflicts;
e5b5ae50 289
44d8db9e 290 if (subject)
71fda00f 291 LIST_PREPEND(subject, subject->subject_list, l);
e5b5ae50 292
71fda00f 293 LIST_PREPEND(object, object->object_list, l);
e5b5ae50
LP
294
295 return l;
296}
297
1da4264f 298void job_dependency_free(JobDependency *l) {
e5b5ae50
LP
299 assert(l);
300
44d8db9e 301 if (l->subject)
71fda00f 302 LIST_REMOVE(subject, l->subject->subject_list, l);
e5b5ae50 303
71fda00f 304 LIST_REMOVE(object, l->object->object_list, l);
e5b5ae50
LP
305
306 free(l);
307}
308
1ffba6fe 309void job_dump(Job *j, FILE*f, const char *prefix) {
a66d02c3
LP
310 assert(j);
311 assert(f);
312
ad5d4b17 313 prefix = strempty(prefix);
9eb63b3c 314
ceed3570 315 fprintf(f,
40d50879
LP
316 "%s-> Job %u:\n"
317 "%s\tAction: %s -> %s\n"
5cb5a6ff 318 "%s\tState: %s\n"
f698d99c
ZJS
319 "%s\tIrreversible: %s\n"
320 "%s\tMay GC: %s\n",
ceed3570 321 prefix, j->id,
ac155bb8 322 prefix, j->unit->id, job_type_to_string(j->type),
94f04347 323 prefix, job_state_to_string(j->state),
f698d99c
ZJS
324 prefix, yes_no(j->irreversible),
325 prefix, yes_no(job_may_gc(j)));
a66d02c3 326}
e5b5ae50 327
348e27fe
MS
328/*
329 * Merging is commutative, so imagine the matrix as symmetric. We store only
330 * its lower triangle to avoid duplication. We don't store the main diagonal,
331 * because A merged with A is simply A.
332 *
e0209d83
MS
333 * If the resulting type is collapsed immediately afterwards (to get rid of
334 * the JOB_RELOAD_OR_START, which lies outside the lookup function's domain),
335 * the following properties hold:
336 *
48b4eab4 337 * Merging is associative! A merged with B, and then merged with C is the same
103635db 338 * as A merged with the result of B merged with C.
348e27fe
MS
339 *
340 * Mergeability is transitive! If A can be merged with B and B with C then
341 * A also with C.
342 *
343 * Also, if A merged with B cannot be merged with C, then either A or B cannot
344 * be merged with C either.
345 */
346static const JobType job_merging_table[] = {
e0209d83
MS
347/* What \ With * JOB_START JOB_VERIFY_ACTIVE JOB_STOP JOB_RELOAD */
348/*********************************************************************************/
348e27fe
MS
349/*JOB_START */
350/*JOB_VERIFY_ACTIVE */ JOB_START,
351/*JOB_STOP */ -1, -1,
352/*JOB_RELOAD */ JOB_RELOAD_OR_START, JOB_RELOAD, -1,
e0209d83 353/*JOB_RESTART */ JOB_RESTART, JOB_RESTART, -1, JOB_RESTART,
348e27fe
MS
354};
355
356JobType job_type_lookup_merge(JobType a, JobType b) {
e0209d83
MS
357 assert_cc(ELEMENTSOF(job_merging_table) == _JOB_TYPE_MAX_MERGING * (_JOB_TYPE_MAX_MERGING - 1) / 2);
358 assert(a >= 0 && a < _JOB_TYPE_MAX_MERGING);
359 assert(b >= 0 && b < _JOB_TYPE_MAX_MERGING);
1ffba6fe
LP
360
361 if (a == b)
348e27fe 362 return a;
1ffba6fe 363
348e27fe
MS
364 if (a < b) {
365 JobType tmp = a;
366 a = b;
367 b = tmp;
1ffba6fe 368 }
e094e853 369
348e27fe 370 return job_merging_table[(a - 1) * a / 2 + b];
e094e853 371}
cd2dbd7d 372
593fbdd2
LP
373bool job_type_is_redundant(JobType a, UnitActiveState b) {
374 switch (a) {
375
376 case JOB_START:
3742095b 377 return IN_SET(b, UNIT_ACTIVE, UNIT_RELOADING);
593fbdd2
LP
378
379 case JOB_STOP:
3742095b 380 return IN_SET(b, UNIT_INACTIVE, UNIT_FAILED);
593fbdd2
LP
381
382 case JOB_VERIFY_ACTIVE:
3742095b 383 return IN_SET(b, UNIT_ACTIVE, UNIT_RELOADING);
593fbdd2
LP
384
385 case JOB_RELOAD:
386 return
032ff4af 387 b == UNIT_RELOADING;
593fbdd2 388
593fbdd2
LP
389 case JOB_RESTART:
390 return
391 b == UNIT_ACTIVATING;
392
7e803f5e
MS
393 case JOB_NOP:
394 return true;
395
e0209d83
MS
396 default:
397 assert_not_reached("Invalid job type");
398 }
399}
400
c6497ccb 401JobType job_type_collapse(JobType t, Unit *u) {
e0209d83
MS
402 UnitActiveState s;
403
c6497ccb 404 switch (t) {
e0209d83 405
593fbdd2 406 case JOB_TRY_RESTART:
e0209d83
MS
407 s = unit_active_state(u);
408 if (UNIT_IS_INACTIVE_OR_DEACTIVATING(s))
c6497ccb
LP
409 return JOB_NOP;
410
411 return JOB_RESTART;
e0209d83 412
3282591d
LP
413 case JOB_TRY_RELOAD:
414 s = unit_active_state(u);
415 if (UNIT_IS_INACTIVE_OR_DEACTIVATING(s))
416 return JOB_NOP;
417
418 return JOB_RELOAD;
419
e0209d83
MS
420 case JOB_RELOAD_OR_START:
421 s = unit_active_state(u);
422 if (UNIT_IS_INACTIVE_OR_DEACTIVATING(s))
c6497ccb
LP
423 return JOB_START;
424
425 return JOB_RELOAD;
593fbdd2
LP
426
427 default:
c6497ccb 428 return t;
593fbdd2
LP
429 }
430}
431
e0209d83 432int job_type_merge_and_collapse(JobType *a, JobType b, Unit *u) {
c6497ccb
LP
433 JobType t;
434
435 t = job_type_lookup_merge(*a, b);
e0209d83
MS
436 if (t < 0)
437 return -EEXIST;
c6497ccb
LP
438
439 *a = job_type_collapse(t, u);
e0209d83
MS
440 return 0;
441}
442
9588bc32 443static bool job_is_runnable(Job *j) {
034c6ed7 444 Iterator i;
87f0e418 445 Unit *other;
eef85c4a 446 void *v;
5cb5a6ff
LP
447
448 assert(j);
ac1135be 449 assert(j->installed);
5cb5a6ff 450
87f0e418 451 /* Checks whether there is any job running for the units this
5cb5a6ff 452 * job needs to be running after (in the case of a 'positive'
e67c3609
LP
453 * job type) or before (in the case of a 'negative' job
454 * type. */
455
66ca4ec4
LP
456 /* Note that unit types have a say in what is runnable,
457 * too. For example, if they return -EAGAIN from
458 * unit_start() they can indicate they are not
459 * runnable yet. */
460
e67c3609 461 /* First check if there is an override */
cebe0d41 462 if (j->ignore_order)
e67c3609 463 return true;
5cb5a6ff 464
e0209d83
MS
465 if (j->type == JOB_NOP)
466 return true;
467
0a23a627 468 if (IN_SET(j->type, JOB_START, JOB_VERIFY_ACTIVE, JOB_RELOAD)) {
5cb5a6ff 469 /* Immediate result is that the job is or might be
fc08079e 470 * started. In this case let's wait for the
5cb5a6ff
LP
471 * dependencies, regardless whether they are
472 * starting or stopping something. */
473
eef85c4a 474 HASHMAP_FOREACH_KEY(v, other, j->unit->dependencies[UNIT_AFTER], i)
ac155bb8 475 if (other->job)
5cb5a6ff
LP
476 return false;
477 }
478
479 /* Also, if something else is being stopped and we should
fc08079e 480 * change state after it, then let's wait. */
5cb5a6ff 481
eef85c4a 482 HASHMAP_FOREACH_KEY(v, other, j->unit->dependencies[UNIT_BEFORE], i)
ac155bb8 483 if (other->job &&
0a23a627 484 IN_SET(other->job->type, JOB_STOP, JOB_RESTART))
5cb5a6ff
LP
485 return false;
486
487 /* This means that for a service a and a service b where b
488 * shall be started after a:
489 *
490 * start a + start b → 1st step start a, 2nd step start b
491 * start a + stop b → 1st step stop b, 2nd step start a
492 * stop a + start b → 1st step stop a, 2nd step start b
493 * stop a + stop b → 1st step stop b, 2nd step stop a
494 *
495 * This has the side effect that restarts are properly
496 * synchronized too. */
497
498 return true;
499}
500
bbd1a837 501static void job_change_type(Job *j, JobType newtype) {
f2341e0a
LP
502 assert(j);
503
504 log_unit_debug(j->unit,
66870f90
ZJS
505 "Converting job %s/%s -> %s/%s",
506 j->unit->id, job_type_to_string(j->type),
507 j->unit->id, job_type_to_string(newtype));
bbd1a837
MS
508
509 j->type = newtype;
510}
511
33a3fdd9 512_pure_ static const char* job_get_begin_status_message_format(Unit *u, JobType t) {
33a3fdd9 513 const UnitStatusMessageFormats *format_table;
a69b3872 514 const char *format;
33a3fdd9
LP
515
516 assert(u);
a69b3872
LP
517
518 if (t == JOB_RELOAD)
519 return "Reloading %s.";
520
521 assert(IN_SET(t, JOB_START, JOB_STOP));
522
523 format_table = &UNIT_VTABLE(u)->status_message_formats;
524 if (format_table) {
525 format = format_table->starting_stopping[t == JOB_STOP];
526 if (format)
527 return format;
33a3fdd9
LP
528 }
529
530 /* Return generic strings */
531 if (t == JOB_START)
532 return "Starting %s.";
a69b3872
LP
533 else {
534 assert(t == JOB_STOP);
33a3fdd9 535 return "Stopping %s.";
a69b3872 536 }
33a3fdd9
LP
537}
538
539static void job_print_begin_status_message(Unit *u, JobType t) {
540 const char *format;
541
542 assert(u);
543
544 /* Reload status messages have traditionally not been printed to console. */
545 if (!IN_SET(t, JOB_START, JOB_STOP))
546 return;
547
548 format = job_get_begin_status_message_format(u, t);
549
550 DISABLE_WARNING_FORMAT_NONLITERAL;
551 unit_status_printf(u, "", format);
552 REENABLE_WARNING;
553}
554
b344b363 555static void job_log_begin_status_message(Unit *u, uint32_t job_id, JobType t) {
33a3fdd9
LP
556 const char *format, *mid;
557 char buf[LINE_MAX];
558
559 assert(u);
b344b363
LP
560 assert(t >= 0);
561 assert(t < _JOB_TYPE_MAX);
33a3fdd9
LP
562
563 if (!IN_SET(t, JOB_START, JOB_STOP, JOB_RELOAD))
564 return;
565
0e2b4a82 566 if (log_on_console()) /* Skip this if it would only go on the console anyway */
33a3fdd9
LP
567 return;
568
569 /* We log status messages for all units and all operations. */
570
571 format = job_get_begin_status_message_format(u, t);
572
573 DISABLE_WARNING_FORMAT_NONLITERAL;
574 (void) snprintf(buf, sizeof buf, format, unit_description(u));
575 REENABLE_WARNING;
576
577 mid = t == JOB_START ? "MESSAGE_ID=" SD_MESSAGE_UNIT_STARTING_STR :
578 t == JOB_STOP ? "MESSAGE_ID=" SD_MESSAGE_UNIT_STOPPING_STR :
579 "MESSAGE_ID=" SD_MESSAGE_UNIT_RELOADING_STR;
580
581 /* Note that we deliberately use LOG_MESSAGE() instead of
582 * LOG_UNIT_MESSAGE() here, since this is supposed to mimic
583 * closely what is written to screen using the status output,
584 * which is supposed the highest level, friendliest output
585 * possible, which means we should avoid the low-level unit
586 * name. */
587 log_struct(LOG_INFO,
588 LOG_MESSAGE("%s", buf),
b344b363
LP
589 "JOB_ID=%" PRIu32, job_id,
590 "JOB_TYPE=%s", job_type_to_string(t),
33a3fdd9
LP
591 LOG_UNIT_ID(u),
592 LOG_UNIT_INVOCATION_ID(u),
593 mid);
594}
595
b344b363 596static void job_emit_begin_status_message(Unit *u, uint32_t job_id, JobType t) {
33a3fdd9
LP
597 assert(u);
598 assert(t >= 0);
599 assert(t < _JOB_TYPE_MAX);
600
b344b363 601 job_log_begin_status_message(u, job_id, t);
33a3fdd9
LP
602 job_print_begin_status_message(u, t);
603}
604
d1a34ae9 605static int job_perform_on_unit(Job **j) {
df446f96
LP
606 uint32_t id;
607 Manager *m;
608 JobType t;
609 Unit *u;
d1a34ae9
MS
610 int r;
611
df446f96
LP
612 /* While we execute this operation the job might go away (for
613 * example: because it finishes immediately or is replaced by
614 * a new, conflicting job.) To make sure we don't access a
615 * freed job later on we store the id here, so that we can
616 * verify the job is still valid. */
617
618 assert(j);
619 assert(*j);
620
621 m = (*j)->manager;
622 u = (*j)->unit;
623 t = (*j)->type;
624 id = (*j)->id;
625
d1a34ae9
MS
626 switch (t) {
627 case JOB_START:
628 r = unit_start(u);
629 break;
630
631 case JOB_RESTART:
632 t = JOB_STOP;
4831981d 633 _fallthrough_;
d1a34ae9
MS
634 case JOB_STOP:
635 r = unit_stop(u);
636 break;
637
638 case JOB_RELOAD:
639 r = unit_reload(u);
640 break;
641
642 default:
643 assert_not_reached("Invalid job type");
644 }
645
0e2b4a82
LP
646 /* Log if the job still exists and the start/stop/reload function actually did something. Note that this means
647 * for units for which there's no 'activating' phase (i.e. because we transition directly from 'inactive' to
648 * 'active') we'll possibly skip the "Starting..." message. */
d1a34ae9
MS
649 *j = manager_get_job(m, id);
650 if (*j && r > 0)
b344b363 651 job_emit_begin_status_message(u, id, t);
d1a34ae9
MS
652
653 return r;
654}
655
5cb5a6ff
LP
656int job_run_and_invalidate(Job *j) {
657 int r;
ac1135be 658
5cb5a6ff 659 assert(j);
ac1135be 660 assert(j->installed);
e0209d83 661 assert(j->type < _JOB_TYPE_MAX_IN_TRANSACTION);
66aa6f7f 662 assert(j->in_run_queue);
5cb5a6ff 663
71fda00f 664 LIST_REMOVE(run_queue, j->manager->run_queue, j);
66aa6f7f 665 j->in_run_queue = false;
5cb5a6ff
LP
666
667 if (j->state != JOB_WAITING)
668 return 0;
669
034c6ed7
LP
670 if (!job_is_runnable(j))
671 return -EAGAIN;
672
a2df3ea4 673 job_start_timer(j, true);
9c3349e2 674 job_set_state(j, JOB_RUNNING);
c1e1601e 675 job_add_to_dbus_queue(j);
83c60c9f 676
5cb5a6ff
LP
677 switch (j->type) {
678
5cb5a6ff 679 case JOB_VERIFY_ACTIVE: {
ea2c0e45
LP
680 UnitActiveState t;
681
682 t = unit_active_state(j->unit);
87f0e418 683 if (UNIT_IS_ACTIVE_OR_RELOADING(t))
5cb5a6ff 684 r = -EALREADY;
87f0e418 685 else if (t == UNIT_ACTIVATING)
5cb5a6ff
LP
686 r = -EAGAIN;
687 else
6a371e23 688 r = -EBADR;
5cb5a6ff
LP
689 break;
690 }
691
d1a34ae9 692 case JOB_START:
5cb5a6ff 693 case JOB_STOP:
dd17d388 694 case JOB_RESTART:
d1a34ae9 695 r = job_perform_on_unit(&j);
57339f47 696
ea2c0e45 697 /* If the unit type does not support starting/stopping, then simply wait. */
57339f47
LP
698 if (r == -EBADR)
699 r = 0;
5cb5a6ff
LP
700 break;
701
702 case JOB_RELOAD:
d1a34ae9 703 r = job_perform_on_unit(&j);
5cb5a6ff
LP
704 break;
705
e0209d83
MS
706 case JOB_NOP:
707 r = -EALREADY;
708 break;
709
5cb5a6ff 710 default:
44d8db9e 711 assert_not_reached("Unknown job type");
5cb5a6ff
LP
712 }
713
e0209d83 714 if (j) {
8ebd9175
LP
715 if (r == -EAGAIN)
716 job_set_state(j, JOB_WAITING); /* Hmm, not ready after all, let's return to JOB_WAITING state */
6e64994d 717 else if (r == -EALREADY) /* already being executed */
833f92ad 718 r = job_finish_and_invalidate(j, JOB_DONE, true, true);
6e64994d
LP
719 else if (r == -ECOMM) /* condition failed, but all is good */
720 r = job_finish_and_invalidate(j, JOB_DONE, true, false);
6a371e23 721 else if (r == -EBADR)
833f92ad 722 r = job_finish_and_invalidate(j, JOB_SKIPPED, true, false);
6a371e23 723 else if (r == -ENOEXEC)
833f92ad 724 r = job_finish_and_invalidate(j, JOB_INVALID, true, false);
59fccdc5 725 else if (r == -EPROTO)
833f92ad 726 r = job_finish_and_invalidate(j, JOB_ASSERT, true, false);
15411c0c 727 else if (r == -EOPNOTSUPP)
833f92ad 728 r = job_finish_and_invalidate(j, JOB_UNSUPPORTED, true, false);
631b676b
LP
729 else if (r == -ENOLINK)
730 r = job_finish_and_invalidate(j, JOB_DEPENDENCY, true, false);
d4fd1cf2
LP
731 else if (r == -ESTALE)
732 r = job_finish_and_invalidate(j, JOB_ONCE, true, false);
9c3349e2 733 else if (r < 0)
833f92ad 734 r = job_finish_and_invalidate(j, JOB_FAILED, true, false);
2cf19a7a 735 }
5cb5a6ff
LP
736
737 return r;
738}
739
33a3fdd9 740_pure_ static const char *job_get_done_status_message_format(Unit *u, JobType t, JobResult result) {
df446f96 741
aa49ab5f
MS
742 static const char *const generic_finished_start_job[_JOB_RESULT_MAX] = {
743 [JOB_DONE] = "Started %s.",
744 [JOB_TIMEOUT] = "Timed out starting %s.",
745 [JOB_FAILED] = "Failed to start %s.",
746 [JOB_DEPENDENCY] = "Dependency failed for %s.",
747 [JOB_ASSERT] = "Assertion failed for %s.",
748 [JOB_UNSUPPORTED] = "Starting of %s not supported.",
4332edf6 749 [JOB_COLLECTED] = "Unnecessary job for %s was removed.",
d4fd1cf2 750 [JOB_ONCE] = "Unit %s has been started before and cannot be started again."
aa49ab5f
MS
751 };
752 static const char *const generic_finished_stop_job[_JOB_RESULT_MAX] = {
753 [JOB_DONE] = "Stopped %s.",
754 [JOB_FAILED] = "Stopped (with error) %s.",
b59f0ecd 755 [JOB_TIMEOUT] = "Timed out stopping %s.",
aa49ab5f
MS
756 };
757 static const char *const generic_finished_reload_job[_JOB_RESULT_MAX] = {
758 [JOB_DONE] = "Reloaded %s.",
759 [JOB_FAILED] = "Reload failed for %s.",
760 [JOB_TIMEOUT] = "Timed out reloading %s.",
761 };
762 /* When verify-active detects the unit is inactive, report it.
763 * Most likely a DEPEND warning from a requisiting unit will
764 * occur next and it's nice to see what was requisited. */
765 static const char *const generic_finished_verify_active_job[_JOB_RESULT_MAX] = {
766 [JOB_SKIPPED] = "%s is not active.",
767 };
877d54e9 768
df446f96
LP
769 const UnitStatusMessageFormats *format_table;
770 const char *format;
771
877d54e9
LP
772 assert(u);
773 assert(t >= 0);
774 assert(t < _JOB_TYPE_MAX);
c6918296 775
df446f96 776 if (IN_SET(t, JOB_START, JOB_STOP, JOB_RESTART)) {
aa49ab5f
MS
777 format_table = &UNIT_VTABLE(u)->status_message_formats;
778 if (format_table) {
779 format = t == JOB_START ? format_table->finished_start_job[result] :
780 format_table->finished_stop_job[result];
781 if (format)
782 return format;
783 }
784 }
877d54e9 785
aa49ab5f 786 /* Return generic strings */
877d54e9 787 if (t == JOB_START)
aa49ab5f 788 return generic_finished_start_job[result];
4c701096 789 else if (IN_SET(t, JOB_STOP, JOB_RESTART))
aa49ab5f
MS
790 return generic_finished_stop_job[result];
791 else if (t == JOB_RELOAD)
792 return generic_finished_reload_job[result];
793 else if (t == JOB_VERIFY_ACTIVE)
794 return generic_finished_verify_active_job[result];
877d54e9
LP
795
796 return NULL;
797}
798
047d7219
ZJS
799static const struct {
800 const char *color, *word;
33a3fdd9 801} job_print_done_status_messages[_JOB_RESULT_MAX] = {
96164a39 802 [JOB_DONE] = { ANSI_OK_COLOR, " OK " },
047d7219
ZJS
803 [JOB_TIMEOUT] = { ANSI_HIGHLIGHT_RED, " TIME " },
804 [JOB_FAILED] = { ANSI_HIGHLIGHT_RED, "FAILED" },
805 [JOB_DEPENDENCY] = { ANSI_HIGHLIGHT_YELLOW, "DEPEND" },
806 [JOB_SKIPPED] = { ANSI_HIGHLIGHT, " INFO " },
807 [JOB_ASSERT] = { ANSI_HIGHLIGHT_YELLOW, "ASSERT" },
808 [JOB_UNSUPPORTED] = { ANSI_HIGHLIGHT_YELLOW, "UNSUPP" },
809 /* JOB_COLLECTED */
d4fd1cf2 810 [JOB_ONCE] = { ANSI_HIGHLIGHT_RED, " ONCE " },
047d7219 811};
e02cd6f7 812
33a3fdd9 813static void job_print_done_status_message(Unit *u, JobType t, JobResult result) {
df446f96 814 const char *format;
dc9b5816 815 const char *status;
df446f96 816
877d54e9
LP
817 assert(u);
818 assert(t >= 0);
819 assert(t < _JOB_TYPE_MAX);
820
df446f96
LP
821 /* Reload status messages have traditionally not been printed to console. */
822 if (t == JOB_RELOAD)
823 return;
824
9a80f2f4
LP
825 /* No message if the job did not actually do anything due to failed condition. */
826 if (t == JOB_START && result == JOB_DONE && !u->condition_result)
827 return;
828
33a3fdd9 829 if (!job_print_done_status_messages[result].word)
047d7219
ZJS
830 return;
831
33a3fdd9 832 format = job_get_done_status_message_format(u, t, result);
aa49ab5f
MS
833 if (!format)
834 return;
e02cd6f7 835
dc9b5816 836 if (log_get_show_color())
33a3fdd9
LP
837 status = strjoina(job_print_done_status_messages[result].color,
838 job_print_done_status_messages[result].word,
047d7219 839 ANSI_NORMAL);
dc9b5816 840 else
33a3fdd9 841 status = job_print_done_status_messages[result].word;
dc9b5816 842
aa49ab5f
MS
843 if (result != JOB_DONE)
844 manager_flip_auto_status(u->manager, true);
e02cd6f7 845
aa49ab5f 846 DISABLE_WARNING_FORMAT_NONLITERAL;
dc9b5816 847 unit_status_printf(u, status, format);
aa49ab5f 848 REENABLE_WARNING;
7cf82e0b 849
aa49ab5f 850 if (t == JOB_START && result == JOB_FAILED) {
df446f96 851 _cleanup_free_ char *quoted;
7cf82e0b 852
804ee07c 853 quoted = shell_maybe_quote(u->id, ESCAPE_BACKSLASH);
df446f96 854 manager_status_printf(u->manager, STATUS_TYPE_NORMAL, NULL, "See 'systemctl status %s' for details.", strna(quoted));
e02cd6f7
LP
855 }
856}
857
33a3fdd9 858static void job_log_done_status_message(Unit *u, uint32_t job_id, JobType t, JobResult result) {
2b044526 859 const char *format, *mid;
877d54e9 860 char buf[LINE_MAX];
64f575d2
MS
861 static const int job_result_log_level[_JOB_RESULT_MAX] = {
862 [JOB_DONE] = LOG_INFO,
863 [JOB_CANCELED] = LOG_INFO,
864 [JOB_TIMEOUT] = LOG_ERR,
865 [JOB_FAILED] = LOG_ERR,
866 [JOB_DEPENDENCY] = LOG_WARNING,
867 [JOB_SKIPPED] = LOG_NOTICE,
868 [JOB_INVALID] = LOG_INFO,
869 [JOB_ASSERT] = LOG_WARNING,
870 [JOB_UNSUPPORTED] = LOG_WARNING,
c5a97ed1 871 [JOB_COLLECTED] = LOG_INFO,
d4fd1cf2 872 [JOB_ONCE] = LOG_ERR,
64f575d2 873 };
877d54e9
LP
874
875 assert(u);
876 assert(t >= 0);
877 assert(t < _JOB_TYPE_MAX);
878
047d7219
ZJS
879 /* Skip printing if output goes to the console, and job_print_status_message()
880 will actually print something to the console. */
33a3fdd9 881 if (log_on_console() && job_print_done_status_messages[result].word)
81270860
LP
882 return;
883
9a80f2f4
LP
884 /* Show condition check message if the job did not actually do anything due to failed condition. */
885 if (t == JOB_START && result == JOB_DONE && !u->condition_result) {
886 log_struct(LOG_INFO,
887 "MESSAGE=Condition check resulted in %s being skipped.", unit_description(u),
888 "JOB_ID=%" PRIu32, job_id,
889 "JOB_TYPE=%s", job_type_to_string(t),
890 "JOB_RESULT=%s", job_result_to_string(result),
891 LOG_UNIT_ID(u),
892 LOG_UNIT_INVOCATION_ID(u),
893 "MESSAGE_ID=" SD_MESSAGE_UNIT_STARTED_STR);
894
895 return;
896 }
897
33a3fdd9 898 format = job_get_done_status_message_format(u, t, result);
877d54e9
LP
899 if (!format)
900 return;
901
574432f8
ILG
902 /* The description might be longer than the buffer, but that's OK,
903 * we'll just truncate it here. Note that we use snprintf() rather than
904 * xsprintf() on purpose here: we are fine with truncation and don't
905 * consider that an error. */
bcfce235 906 DISABLE_WARNING_FORMAT_NONLITERAL;
574432f8 907 (void) snprintf(buf, sizeof(buf), format, unit_description(u));
bcfce235 908 REENABLE_WARNING;
877d54e9 909
df446f96
LP
910 switch (t) {
911
912 case JOB_START:
2b044526
ZJS
913 if (result == JOB_DONE)
914 mid = "MESSAGE_ID=" SD_MESSAGE_UNIT_STARTED_STR;
915 else
916 mid = "MESSAGE_ID=" SD_MESSAGE_UNIT_FAILED_STR;
df446f96
LP
917 break;
918
919 case JOB_RELOAD:
2b044526 920 mid = "MESSAGE_ID=" SD_MESSAGE_UNIT_RELOADED_STR;
df446f96
LP
921 break;
922
923 case JOB_STOP:
924 case JOB_RESTART:
2b044526 925 mid = "MESSAGE_ID=" SD_MESSAGE_UNIT_STOPPED_STR;
df446f96
LP
926 break;
927
928 default:
64f575d2 929 log_struct(job_result_log_level[result],
4f29c6fe 930 LOG_MESSAGE("%s", buf),
1cd81629 931 "JOB_ID=%" PRIu32, job_id,
646cc98d
LP
932 "JOB_TYPE=%s", job_type_to_string(t),
933 "JOB_RESULT=%s", job_result_to_string(result),
ba360bb0 934 LOG_UNIT_ID(u),
a1230ff9 935 LOG_UNIT_INVOCATION_ID(u));
b81bbe53
MS
936 return;
937 }
938
64f575d2 939 log_struct(job_result_log_level[result],
b81bbe53 940 LOG_MESSAGE("%s", buf),
1cd81629 941 "JOB_ID=%" PRIu32, job_id,
646cc98d
LP
942 "JOB_TYPE=%s", job_type_to_string(t),
943 "JOB_RESULT=%s", job_result_to_string(result),
ba360bb0 944 LOG_UNIT_ID(u),
f1c50bec 945 LOG_UNIT_INVOCATION_ID(u),
a1230ff9 946 mid);
877d54e9 947}
877d54e9 948
33a3fdd9 949static void job_emit_done_status_message(Unit *u, uint32_t job_id, JobType t, JobResult result) {
646cc98d 950 assert(u);
30961fa3 951
33a3fdd9
LP
952 job_log_done_status_message(u, job_id, t, result);
953 job_print_done_status_message(u, t, result);
30961fa3
MS
954}
955
be7d9ff7
LP
956static void job_fail_dependencies(Unit *u, UnitDependency d) {
957 Unit *other;
958 Iterator i;
eef85c4a 959 void *v;
be7d9ff7
LP
960
961 assert(u);
962
eef85c4a 963 HASHMAP_FOREACH_KEY(v, other, u->dependencies[d], i) {
be7d9ff7
LP
964 Job *j = other->job;
965
966 if (!j)
967 continue;
968 if (!IN_SET(j->type, JOB_START, JOB_VERIFY_ACTIVE))
969 continue;
970
833f92ad 971 job_finish_and_invalidate(j, JOB_DEPENDENCY, true, false);
be7d9ff7
LP
972 }
973}
974
a7a7163d
DT
975static int job_save_pending_finished_job(Job *j) {
976 int r;
977
978 assert(j);
979
980 r = set_ensure_allocated(&j->manager->pending_finished_jobs, NULL);
981 if (r < 0)
982 return r;
983
984 job_unlink(j);
985 return set_put(j->manager->pending_finished_jobs, j);
986}
987
833f92ad 988int job_finish_and_invalidate(Job *j, JobResult result, bool recursive, bool already) {
87f0e418
LP
989 Unit *u;
990 Unit *other;
b866264a 991 JobType t;
034c6ed7 992 Iterator i;
eef85c4a 993 void *v;
5cb5a6ff
LP
994
995 assert(j);
ac1135be 996 assert(j->installed);
e0209d83 997 assert(j->type < _JOB_TYPE_MAX_IN_TRANSACTION);
5cb5a6ff 998
c6918296
MS
999 u = j->unit;
1000 t = j->type;
1001
1002 j->result = result;
1003
1cd81629 1004 log_unit_debug(u, "Job %" PRIu32 " %s/%s finished, result=%s", j->id, u->id, job_type_to_string(t), job_result_to_string(result));
c6918296 1005
833f92ad
MS
1006 /* If this job did nothing to respective unit we don't log the status message */
1007 if (!already)
33a3fdd9 1008 job_emit_done_status_message(u, j->id, t, result);
c6918296 1009
034c6ed7 1010 /* Patch restart jobs so that they become normal start jobs */
c6918296 1011 if (result == JOB_DONE && t == JOB_RESTART) {
f50e0a01 1012
bbd1a837 1013 job_change_type(j, JOB_START);
9c3349e2 1014 job_set_state(j, JOB_WAITING);
cc42e081 1015
fec7615c 1016 job_add_to_dbus_queue(j);
cc42e081 1017 job_add_to_run_queue(j);
c5a97ed1 1018 job_add_to_gc_queue(j);
57981b98 1019
57981b98 1020 goto finish;
5cb5a6ff
LP
1021 }
1022
3742095b 1023 if (IN_SET(result, JOB_FAILED, JOB_INVALID))
313cefa1 1024 j->manager->n_failed_jobs++;
76bf48b7 1025
97e7d748 1026 job_uninstall(j);
509ad789
ZJS
1027 /* Keep jobs started before the reload to send singal later, free all others */
1028 if (!MANAGER_IS_RELOADING(j->manager) ||
1029 !j->reloaded ||
1030 job_save_pending_finished_job(j) < 0)
a7a7163d 1031 job_free(j);
5cb5a6ff
LP
1032
1033 /* Fail depending jobs on failure */
5273510e 1034 if (result != JOB_DONE && recursive) {
be7d9ff7
LP
1035 if (IN_SET(t, JOB_START, JOB_VERIFY_ACTIVE)) {
1036 job_fail_dependencies(u, UNIT_REQUIRED_BY);
1037 job_fail_dependencies(u, UNIT_REQUISITE_OF);
1038 job_fail_dependencies(u, UNIT_BOUND_BY);
be7d9ff7
LP
1039 } else if (t == JOB_STOP)
1040 job_fail_dependencies(u, UNIT_CONFLICTED_BY);
5cb5a6ff
LP
1041 }
1042
c0daa706 1043 /* Trigger OnFailure dependencies that are not generated by
66870f90 1044 * the unit itself. We don't treat JOB_CANCELED as failure in
c0daa706
LP
1045 * this context. And JOB_FAILURE is already handled by the
1046 * unit itself. */
646cc98d 1047 if (IN_SET(result, JOB_TIMEOUT, JOB_DEPENDENCY)) {
f2341e0a
LP
1048 log_struct(LOG_NOTICE,
1049 "JOB_TYPE=%s", job_type_to_string(t),
1050 "JOB_RESULT=%s", job_result_to_string(result),
1051 LOG_UNIT_ID(u),
1052 LOG_UNIT_MESSAGE(u, "Job %s/%s failed with result '%s'.",
e2cc6eca
LP
1053 u->id,
1054 job_type_to_string(t),
a1230ff9 1055 job_result_to_string(result)));
222ae6a8 1056
3ecaa09b 1057 unit_start_on_failure(u);
222ae6a8 1058 }
c0daa706 1059
3ecaa09b
LP
1060 unit_trigger_notify(u);
1061
57981b98 1062finish:
5cb5a6ff 1063 /* Try to start the next jobs that can be started */
eef85c4a 1064 HASHMAP_FOREACH_KEY(v, other, u->dependencies[UNIT_AFTER], i)
c5a97ed1 1065 if (other->job) {
ac155bb8 1066 job_add_to_run_queue(other->job);
c5a97ed1
LP
1067 job_add_to_gc_queue(other->job);
1068 }
eef85c4a 1069 HASHMAP_FOREACH_KEY(v, other, u->dependencies[UNIT_BEFORE], i)
c5a97ed1 1070 if (other->job) {
ac155bb8 1071 job_add_to_run_queue(other->job);
c5a97ed1
LP
1072 job_add_to_gc_queue(other->job);
1073 }
5cb5a6ff 1074
ac155bb8 1075 manager_check_finished(u->manager);
b0c918b9 1076
5273510e 1077 return 0;
5cb5a6ff 1078}
034c6ed7 1079
718db961
LP
1080static int job_dispatch_timer(sd_event_source *s, uint64_t monotonic, void *userdata) {
1081 Job *j = userdata;
f189ab18 1082 Unit *u;
faf919f1 1083
718db961
LP
1084 assert(j);
1085 assert(s == j->timer_event_source);
faf919f1 1086
f2341e0a 1087 log_unit_warning(j->unit, "Job %s/%s timed out.", j->unit->id, job_type_to_string(j->type));
faf919f1 1088
f189ab18 1089 u = j->unit;
833f92ad 1090 job_finish_and_invalidate(j, JOB_TIMEOUT, true, false);
f189ab18 1091
c7adcb1a
ZJS
1092 emergency_action(u->manager, u->job_timeout_action,
1093 EMERGENCY_ACTION_IS_WATCHDOG|EMERGENCY_ACTION_WARN,
1710d4be 1094 u->job_timeout_reboot_arg, "job timed out");
f189ab18 1095
718db961
LP
1096 return 0;
1097}
faf919f1 1098
a2df3ea4 1099int job_start_timer(Job *j, bool job_running) {
718db961 1100 int r;
171f12ce 1101 usec_t timeout_time, old_timeout_time;
faf919f1 1102
a2df3ea4 1103 if (job_running) {
171f12ce
MK
1104 j->begin_running_usec = now(CLOCK_MONOTONIC);
1105
a2df3ea4
MK
1106 if (j->unit->job_running_timeout == USEC_INFINITY)
1107 return 0;
faf919f1 1108
171f12ce 1109 timeout_time = usec_add(j->begin_running_usec, j->unit->job_running_timeout);
faf919f1 1110
a2df3ea4
MK
1111 if (j->timer_event_source) {
1112 /* Update only if JobRunningTimeoutSec= results in earlier timeout */
1113 r = sd_event_source_get_time(j->timer_event_source, &old_timeout_time);
1114 if (r < 0)
1115 return r;
1116
1117 if (old_timeout_time <= timeout_time)
1118 return 0;
1119
1120 return sd_event_source_set_time(j->timer_event_source, timeout_time);
1121 }
1122 } else {
1123 if (j->timer_event_source)
1124 return 0;
1125
1126 j->begin_usec = now(CLOCK_MONOTONIC);
1127
1128 if (j->unit->job_timeout == USEC_INFINITY)
1129 return 0;
1130
1131 timeout_time = usec_add(j->begin_usec, j->unit->job_timeout);
1132 }
8bb310c3 1133
6a0f1f6d
LP
1134 r = sd_event_add_time(
1135 j->manager->event,
1136 &j->timer_event_source,
1137 CLOCK_MONOTONIC,
a2df3ea4 1138 timeout_time, 0,
6a0f1f6d 1139 job_dispatch_timer, j);
718db961
LP
1140 if (r < 0)
1141 return r;
faf919f1 1142
7dfbe2e3
TG
1143 (void) sd_event_source_set_description(j->timer_event_source, "job-start");
1144
718db961 1145 return 0;
faf919f1
LP
1146}
1147
c1e1601e 1148void job_add_to_run_queue(Job *j) {
f8c34706
LP
1149 int r;
1150
034c6ed7 1151 assert(j);
ac1135be 1152 assert(j->installed);
034c6ed7
LP
1153
1154 if (j->in_run_queue)
1155 return;
1156
f8c34706
LP
1157 if (!j->manager->run_queue) {
1158 r = sd_event_source_set_enabled(j->manager->run_queue_event_source, SD_EVENT_ONESHOT);
1159 if (r < 0)
1160 log_warning_errno(r, "Failed to enable job run queue event source, ignoring: %m");
1161 }
752b5905 1162
71fda00f 1163 LIST_PREPEND(run_queue, j->manager->run_queue, j);
034c6ed7
LP
1164 j->in_run_queue = true;
1165}
94f04347 1166
c1e1601e
LP
1167void job_add_to_dbus_queue(Job *j) {
1168 assert(j);
1169 assert(j->installed);
1170
1171 if (j->in_dbus_queue)
1172 return;
1173
a567261a
LP
1174 /* We don't check if anybody is subscribed here, since this
1175 * job might just have been created and not yet assigned to a
1176 * connection/client. */
94b6dfa2 1177
71fda00f 1178 LIST_PREPEND(dbus_queue, j->manager->dbus_job_queue, j);
c1e1601e
LP
1179 j->in_dbus_queue = true;
1180}
1181
ea430986
LP
1182char *job_dbus_path(Job *j) {
1183 char *p;
1184
1185 assert(j);
1186
ccd06097 1187 if (asprintf(&p, "/org/freedesktop/systemd1/job/%"PRIu32, j->id) < 0)
ea430986
LP
1188 return NULL;
1189
1190 return p;
1191}
1192
05a98afd
LP
1193int job_serialize(Job *j, FILE *f) {
1194 assert(j);
1195 assert(f);
1196
d68c645b
LP
1197 (void) serialize_item_format(f, "job-id", "%u", j->id);
1198 (void) serialize_item(f, "job-type", job_type_to_string(j->type));
1199 (void) serialize_item(f, "job-state", job_state_to_string(j->state));
1200 (void) serialize_bool(f, "job-irreversible", j->irreversible);
1201 (void) serialize_bool(f, "job-sent-dbus-new-signal", j->sent_dbus_new_signal);
1202 (void) serialize_bool(f, "job-ignore-order", j->ignore_order);
718db961
LP
1203
1204 if (j->begin_usec > 0)
d68c645b 1205 (void) serialize_usec(f, "job-begin", j->begin_usec);
171f12ce 1206 if (j->begin_running_usec > 0)
d68c645b 1207 (void) serialize_usec(f, "job-begin-running", j->begin_running_usec);
718db961 1208
1a465207 1209 bus_track_serialize(j->bus_track, f, "subscribed");
39a18c60
MS
1210
1211 /* End marker */
1212 fputc('\n', f);
1213 return 0;
1214}
1215
05a98afd 1216int job_deserialize(Job *j, FILE *f) {
8948b341
LP
1217 int r;
1218
718db961 1219 assert(j);
05a98afd 1220 assert(f);
718db961 1221
39a18c60 1222 for (;;) {
8948b341
LP
1223 _cleanup_free_ char *line = NULL;
1224 char *l, *v;
39a18c60
MS
1225 size_t k;
1226
8948b341
LP
1227 r = read_line(f, LONG_LINE_MAX, &line);
1228 if (r < 0)
1229 return log_error_errno(r, "Failed to read serialization line: %m");
1230 if (r == 0)
1231 return 0;
39a18c60 1232
39a18c60
MS
1233 l = strstrip(line);
1234
1235 /* End marker */
8948b341 1236 if (isempty(l))
39a18c60
MS
1237 return 0;
1238
1239 k = strcspn(l, "=");
1240
1241 if (l[k] == '=') {
1242 l[k] = 0;
1243 v = l+k+1;
1244 } else
1245 v = l+k;
1246
1247 if (streq(l, "job-id")) {
718db961 1248
39a18c60 1249 if (safe_atou32(v, &j->id) < 0)
15ec1021 1250 log_debug("Failed to parse job id value: %s", v);
718db961 1251
39a18c60 1252 } else if (streq(l, "job-type")) {
718db961
LP
1253 JobType t;
1254
1255 t = job_type_from_string(v);
39a18c60 1256 if (t < 0)
15ec1021 1257 log_debug("Failed to parse job type: %s", v);
e0209d83 1258 else if (t >= _JOB_TYPE_MAX_IN_TRANSACTION)
15ec1021 1259 log_debug("Cannot deserialize job of type: %s", v);
39a18c60
MS
1260 else
1261 j->type = t;
718db961 1262
39a18c60 1263 } else if (streq(l, "job-state")) {
718db961
LP
1264 JobState s;
1265
1266 s = job_state_from_string(v);
39a18c60 1267 if (s < 0)
15ec1021 1268 log_debug("Failed to parse job state: %s", v);
39a18c60 1269 else
9c3349e2 1270 job_set_state(j, s);
718db961 1271
23ade460 1272 } else if (streq(l, "job-irreversible")) {
718db961
LP
1273 int b;
1274
1275 b = parse_boolean(v);
23ade460 1276 if (b < 0)
15ec1021 1277 log_debug("Failed to parse job irreversible flag: %s", v);
23ade460
MS
1278 else
1279 j->irreversible = j->irreversible || b;
718db961 1280
39a18c60 1281 } else if (streq(l, "job-sent-dbus-new-signal")) {
718db961
LP
1282 int b;
1283
1284 b = parse_boolean(v);
39a18c60 1285 if (b < 0)
15ec1021 1286 log_debug("Failed to parse job sent_dbus_new_signal flag: %s", v);
39a18c60
MS
1287 else
1288 j->sent_dbus_new_signal = j->sent_dbus_new_signal || b;
718db961 1289
39a18c60 1290 } else if (streq(l, "job-ignore-order")) {
718db961
LP
1291 int b;
1292
1293 b = parse_boolean(v);
39a18c60 1294 if (b < 0)
15ec1021 1295 log_debug("Failed to parse job ignore_order flag: %s", v);
39a18c60
MS
1296 else
1297 j->ignore_order = j->ignore_order || b;
718db961 1298
d68c645b
LP
1299 } else if (streq(l, "job-begin"))
1300 (void) deserialize_usec(v, &j->begin_usec);
718db961 1301
d68c645b
LP
1302 else if (streq(l, "job-begin-running"))
1303 (void) deserialize_usec(v, &j->begin_running_usec);
718db961 1304
d68c645b 1305 else if (streq(l, "subscribed")) {
b39a2770 1306 if (strv_extend(&j->deserialized_clients, v) < 0)
d68c645b
LP
1307 return log_oom();
1308 } else
1309 log_debug("Unknown job serialization key: %s", l);
39a18c60
MS
1310 }
1311}
1312
1313int job_coldplug(Job *j) {
718db961 1314 int r;
171f12ce 1315 usec_t timeout_time = USEC_INFINITY;
718db961
LP
1316
1317 assert(j);
39a18c60 1318
8f8f05a9
LP
1319 /* After deserialization is complete and the bus connection
1320 * set up again, let's start watching our subscribers again */
c5a97ed1 1321 (void) bus_job_coldplug_bus_track(j);
8f8f05a9 1322
1727a595
MM
1323 if (j->state == JOB_WAITING)
1324 job_add_to_run_queue(j);
1325
c5a97ed1
LP
1326 /* Maybe due to new dependencies we don't actually need this job anymore? */
1327 job_add_to_gc_queue(j);
1328
171f12ce
MK
1329 /* Create timer only when job began or began running and the respective timeout is finite.
1330 * Follow logic of job_start_timer() if both timeouts are finite */
1331 if (j->begin_usec == 0)
1332 return 0;
1333
1334 if (j->unit->job_timeout != USEC_INFINITY)
1335 timeout_time = usec_add(j->begin_usec, j->unit->job_timeout);
1336
1337 if (j->begin_running_usec > 0 && j->unit->job_running_timeout != USEC_INFINITY)
1338 timeout_time = MIN(timeout_time, usec_add(j->begin_running_usec, j->unit->job_running_timeout));
1339
1340 if (timeout_time == USEC_INFINITY)
39a18c60
MS
1341 return 0;
1342
36c16a7c 1343 j->timer_event_source = sd_event_source_unref(j->timer_event_source);
39a18c60 1344
6a0f1f6d
LP
1345 r = sd_event_add_time(
1346 j->manager->event,
1347 &j->timer_event_source,
1348 CLOCK_MONOTONIC,
171f12ce 1349 timeout_time, 0,
6a0f1f6d 1350 job_dispatch_timer, j);
718db961 1351 if (r < 0)
da927ba9 1352 log_debug_errno(r, "Failed to restart timeout for job: %m");
718db961 1353
7dfbe2e3
TG
1354 (void) sd_event_source_set_description(j->timer_event_source, "job-timeout");
1355
718db961 1356 return r;
39a18c60
MS
1357}
1358
c65eb836
LP
1359void job_shutdown_magic(Job *j) {
1360 assert(j);
1361
1362 /* The shutdown target gets some special treatment here: we
1363 * tell the kernel to begin with flushing its disk caches, to
1364 * optimize shutdown time a bit. Ideally we wouldn't hardcode
1365 * this magic into PID 1. However all other processes aren't
1366 * options either since they'd exit much sooner than PID 1 and
1367 * asynchronous sync() would cause their exit to be
1368 * delayed. */
1369
c2756a68 1370 if (j->type != JOB_START)
c65eb836
LP
1371 return;
1372
463d0d15 1373 if (!MANAGER_IS_SYSTEM(j->unit->manager))
c2756a68
LP
1374 return;
1375
1376 if (!unit_has_name(j->unit, SPECIAL_SHUTDOWN_TARGET))
c65eb836
LP
1377 return;
1378
5b1869ea
OB
1379 /* In case messages on console has been disabled on boot */
1380 j->unit->manager->no_console_output = false;
1381
75f86906 1382 if (detect_container() > 0)
c65eb836
LP
1383 return;
1384
d00c2631 1385 (void) asynchronous_sync(NULL);
c65eb836
LP
1386}
1387
7a7821c8
LP
1388int job_get_timeout(Job *j, usec_t *timeout) {
1389 usec_t x = USEC_INFINITY, y = USEC_INFINITY;
68db7a3b 1390 Unit *u = j->unit;
7a7821c8 1391 int r;
68db7a3b
ZJS
1392
1393 assert(u);
1394
1395 if (j->timer_event_source) {
1396 r = sd_event_source_get_time(j->timer_event_source, &x);
1397 if (r < 0)
1398 return r;
68db7a3b
ZJS
1399 }
1400
1401 if (UNIT_VTABLE(u)->get_timeout) {
7a7821c8
LP
1402 r = UNIT_VTABLE(u)->get_timeout(u, &y);
1403 if (r < 0)
1404 return r;
68db7a3b
ZJS
1405 }
1406
7a7821c8 1407 if (x == USEC_INFINITY && y == USEC_INFINITY)
68db7a3b
ZJS
1408 return 0;
1409
1410 *timeout = MIN(x, y);
68db7a3b
ZJS
1411 return 1;
1412}
1413
2ab3050f 1414bool job_may_gc(Job *j) {
c5a97ed1
LP
1415 Unit *other;
1416 Iterator i;
eef85c4a 1417 void *v;
c5a97ed1
LP
1418
1419 assert(j);
1420
1421 /* Checks whether this job should be GC'ed away. We only do this for jobs of units that have no effect on their
2ab3050f
ZJS
1422 * own and just track external state. For now the only unit type that qualifies for this are .device units.
1423 * Returns true if the job can be collected. */
c5a97ed1
LP
1424
1425 if (!UNIT_VTABLE(j->unit)->gc_jobs)
2ab3050f 1426 return false;
c5a97ed1
LP
1427
1428 if (sd_bus_track_count(j->bus_track) > 0)
2ab3050f 1429 return false;
c5a97ed1
LP
1430
1431 /* FIXME: So this is a bit ugly: for now we don't properly track references made via private bus connections
1432 * (because it's nasty, as sd_bus_track doesn't apply to it). We simply remember that the job was once
1433 * referenced by one, and reset this whenever we notice that no private bus connections are around. This means
1434 * the GC is a bit too conservative when it comes to jobs created by private bus connections. */
1435 if (j->ref_by_private_bus) {
1436 if (set_isempty(j->unit->manager->private_buses))
1437 j->ref_by_private_bus = false;
1438 else
2ab3050f 1439 return false;
c5a97ed1
LP
1440 }
1441
1442 if (j->type == JOB_NOP)
2ab3050f 1443 return false;
c5a97ed1
LP
1444
1445 /* If a job is ordered after ours, and is to be started, then it needs to wait for us, regardless if we stop or
1446 * start, hence let's not GC in that case. */
eef85c4a 1447 HASHMAP_FOREACH_KEY(v, other, j->unit->dependencies[UNIT_BEFORE], i) {
c5a97ed1
LP
1448 if (!other->job)
1449 continue;
1450
1451 if (other->job->ignore_order)
1452 continue;
1453
1454 if (IN_SET(other->job->type, JOB_START, JOB_VERIFY_ACTIVE, JOB_RELOAD))
2ab3050f 1455 return false;
c5a97ed1
LP
1456 }
1457
047d7219
ZJS
1458 /* If we are going down, but something else is ordered After= us, then it needs to wait for us */
1459 if (IN_SET(j->type, JOB_STOP, JOB_RESTART))
eef85c4a 1460 HASHMAP_FOREACH_KEY(v, other, j->unit->dependencies[UNIT_AFTER], i) {
c5a97ed1
LP
1461 if (!other->job)
1462 continue;
1463
1464 if (other->job->ignore_order)
1465 continue;
1466
2ab3050f 1467 return false;
c5a97ed1 1468 }
c5a97ed1
LP
1469
1470 /* The logic above is kinda the inverse of the job_is_runnable() logic. Specifically, if the job "we" is
1471 * ordered before the job "other":
1472 *
1473 * we start + other start → stay
1474 * we start + other stop → gc
1475 * we stop + other start → stay
1476 * we stop + other stop → gc
1477 *
1478 * "we" are ordered after "other":
1479 *
1480 * we start + other start → gc
1481 * we start + other stop → gc
1482 * we stop + other start → stay
1483 * we stop + other stop → stay
c5a97ed1
LP
1484 */
1485
2ab3050f 1486 return true;
c5a97ed1
LP
1487}
1488
1489void job_add_to_gc_queue(Job *j) {
1490 assert(j);
1491
1492 if (j->in_gc_queue)
1493 return;
1494
2ab3050f 1495 if (!job_may_gc(j))
c5a97ed1
LP
1496 return;
1497
1498 LIST_PREPEND(gc_queue, j->unit->manager->gc_job_queue, j);
1499 j->in_gc_queue = true;
1500}
1501
93bab288
YW
1502static int job_compare(Job * const *a, Job * const *b) {
1503 return CMP((*a)->id, (*b)->id);
15ea79f8
LP
1504}
1505
1506static size_t sort_job_list(Job **list, size_t n) {
1507 Job *previous = NULL;
1508 size_t a, b;
1509
1510 /* Order by numeric IDs */
93bab288 1511 typesafe_qsort(list, n, job_compare);
15ea79f8
LP
1512
1513 /* Filter out duplicates */
1514 for (a = 0, b = 0; a < n; a++) {
1515
1516 if (previous == list[a])
1517 continue;
1518
1519 previous = list[b++] = list[a];
1520 }
1521
1522 return b;
1523}
1524
1525int job_get_before(Job *j, Job*** ret) {
1526 _cleanup_free_ Job** list = NULL;
1527 size_t n = 0, n_allocated = 0;
1528 Unit *other = NULL;
1529 Iterator i;
eef85c4a 1530 void *v;
15ea79f8
LP
1531
1532 /* Returns a list of all pending jobs that need to finish before this job may be started. */
1533
1534 assert(j);
1535 assert(ret);
1536
1537 if (j->ignore_order) {
1538 *ret = NULL;
1539 return 0;
1540 }
1541
1542 if (IN_SET(j->type, JOB_START, JOB_VERIFY_ACTIVE, JOB_RELOAD)) {
1543
eef85c4a 1544 HASHMAP_FOREACH_KEY(v, other, j->unit->dependencies[UNIT_AFTER], i) {
15ea79f8
LP
1545 if (!other->job)
1546 continue;
1547
1548 if (!GREEDY_REALLOC(list, n_allocated, n+1))
1549 return -ENOMEM;
1550 list[n++] = other->job;
1551 }
1552 }
1553
eef85c4a 1554 HASHMAP_FOREACH_KEY(v, other, j->unit->dependencies[UNIT_BEFORE], i) {
15ea79f8
LP
1555 if (!other->job)
1556 continue;
1557
1558 if (!IN_SET(other->job->type, JOB_STOP, JOB_RESTART))
1559 continue;
1560
1561 if (!GREEDY_REALLOC(list, n_allocated, n+1))
1562 return -ENOMEM;
1563 list[n++] = other->job;
1564 }
1565
1566 n = sort_job_list(list, n);
1567
1cc6c93a 1568 *ret = TAKE_PTR(list);
15ea79f8
LP
1569
1570 return (int) n;
1571}
1572
1573int job_get_after(Job *j, Job*** ret) {
1574 _cleanup_free_ Job** list = NULL;
1575 size_t n = 0, n_allocated = 0;
1576 Unit *other = NULL;
eef85c4a 1577 void *v;
15ea79f8
LP
1578 Iterator i;
1579
1580 assert(j);
1581 assert(ret);
1582
1583 /* Returns a list of all pending jobs that are waiting for this job to finish. */
1584
eef85c4a 1585 HASHMAP_FOREACH_KEY(v, other, j->unit->dependencies[UNIT_BEFORE], i) {
15ea79f8
LP
1586 if (!other->job)
1587 continue;
1588
1589 if (other->job->ignore_order)
1590 continue;
1591
1592 if (!IN_SET(other->job->type, JOB_START, JOB_VERIFY_ACTIVE, JOB_RELOAD))
1593 continue;
1594
1595 if (!GREEDY_REALLOC(list, n_allocated, n+1))
1596 return -ENOMEM;
1597 list[n++] = other->job;
1598 }
1599
1600 if (IN_SET(j->type, JOB_STOP, JOB_RESTART)) {
1601
eef85c4a 1602 HASHMAP_FOREACH_KEY(v, other, j->unit->dependencies[UNIT_AFTER], i) {
15ea79f8
LP
1603 if (!other->job)
1604 continue;
1605
1606 if (other->job->ignore_order)
1607 continue;
1608
1609 if (!GREEDY_REALLOC(list, n_allocated, n+1))
1610 return -ENOMEM;
1611 list[n++] = other->job;
1612 }
1613 }
1614
1615 n = sort_job_list(list, n);
1616
1cc6c93a 1617 *ret = TAKE_PTR(list);
15ea79f8
LP
1618
1619 return (int) n;
1620}
1621
94f04347
LP
1622static const char* const job_state_table[_JOB_STATE_MAX] = {
1623 [JOB_WAITING] = "waiting",
0a23a627 1624 [JOB_RUNNING] = "running",
94f04347
LP
1625};
1626
1627DEFINE_STRING_TABLE_LOOKUP(job_state, JobState);
1628
1629static const char* const job_type_table[_JOB_TYPE_MAX] = {
1630 [JOB_START] = "start",
1631 [JOB_VERIFY_ACTIVE] = "verify-active",
1632 [JOB_STOP] = "stop",
1633 [JOB_RELOAD] = "reload",
1634 [JOB_RELOAD_OR_START] = "reload-or-start",
1635 [JOB_RESTART] = "restart",
1636 [JOB_TRY_RESTART] = "try-restart",
3282591d 1637 [JOB_TRY_RELOAD] = "try-reload",
e0209d83 1638 [JOB_NOP] = "nop",
94f04347
LP
1639};
1640
1641DEFINE_STRING_TABLE_LOOKUP(job_type, JobType);
b548631a
LP
1642
1643static const char* const job_mode_table[_JOB_MODE_MAX] = {
1644 [JOB_FAIL] = "fail",
c497c7a9 1645 [JOB_REPLACE] = "replace",
23ade460 1646 [JOB_REPLACE_IRREVERSIBLY] = "replace-irreversibly",
e67c3609 1647 [JOB_ISOLATE] = "isolate",
2c5859af 1648 [JOB_FLUSH] = "flush",
cebe0d41 1649 [JOB_IGNORE_DEPENDENCIES] = "ignore-dependencies",
255baef6 1650 [JOB_IGNORE_REQUIREMENTS] = "ignore-requirements",
b548631a
LP
1651};
1652
1653DEFINE_STRING_TABLE_LOOKUP(job_mode, JobMode);
5d44db4a
LP
1654
1655static const char* const job_result_table[_JOB_RESULT_MAX] = {
1656 [JOB_DONE] = "done",
1657 [JOB_CANCELED] = "canceled",
1658 [JOB_TIMEOUT] = "timeout",
1659 [JOB_FAILED] = "failed",
d68201e9 1660 [JOB_DEPENDENCY] = "dependency",
6a371e23
ZJS
1661 [JOB_SKIPPED] = "skipped",
1662 [JOB_INVALID] = "invalid",
59fccdc5 1663 [JOB_ASSERT] = "assert",
0faacd47 1664 [JOB_UNSUPPORTED] = "unsupported",
c5a97ed1 1665 [JOB_COLLECTED] = "collected",
d4fd1cf2 1666 [JOB_ONCE] = "once",
5d44db4a
LP
1667};
1668
1669DEFINE_STRING_TABLE_LOOKUP(job_result, JobResult);
94bd7323
EV
1670
1671const char* job_type_to_access_method(JobType t) {
1672 assert(t >= 0);
1673 assert(t < _JOB_TYPE_MAX);
1674
1675 if (IN_SET(t, JOB_START, JOB_RESTART, JOB_TRY_RESTART))
1676 return "start";
1677 else if (t == JOB_STOP)
1678 return "stop";
1679 else
1680 return "reload";
1681}