]> git.ipfire.org Git - thirdparty/systemd.git/blob - src/core/job.c
projects / thirdparty / systemd.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
job: let's remove one comparison and reduce indentation level by one
[thirdparty/systemd.git] / src / core / job.c
1 /* SPDX-License-Identifier: LGPL-2.1+ */
2
3 #include <errno.h>
4
5 #include "sd-id128.h"
6 #include "sd-messages.h"
7
8 #include "alloc-util.h"
9 #include "async.h"
10 #include "dbus-job.h"
11 #include "dbus.h"
12 #include "escape.h"
13 #include "fileio.h"
14 #include "job.h"
15 #include "log.h"
16 #include "macro.h"
17 #include "parse-util.h"
18 #include "serialize.h"
19 #include "set.h"
20 #include "special.h"
21 #include "stdio-util.h"
22 #include "string-table.h"
23 #include "string-util.h"
24 #include "strv.h"
25 #include "terminal-util.h"
26 #include "unit.h"
27 #include "virt.h"
28
29 Job* job_new_raw(Unit *unit) {
30 Job *j;
31
32 /* used for deserialization */
33
34 assert(unit);
35
36 j = new(Job, 1);
37 if (!j)
38 return NULL;
39
40 *j = (Job) {
41 .manager = unit->manager,
42 .unit = unit,
43 .type = _JOB_TYPE_INVALID,
44 };
45
46 return j;
47 }
48
49 Job* 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
61 /* We don't link it here, that's what job_dependency() is for */
62
63 return j;
64 }
65
66 void job_unlink(Job *j) {
67 assert(j);
68 assert(!j->installed);
69 assert(!j->transaction_prev);
70 assert(!j->transaction_next);
71 assert(!j->subject_list);
72 assert(!j->object_list);
73
74 if (j->in_run_queue) {
75 LIST_REMOVE(run_queue, j->manager->run_queue, j);
76 j->in_run_queue = false;
77 }
78
79 if (j->in_dbus_queue) {
80 LIST_REMOVE(dbus_queue, j->manager->dbus_job_queue, j);
81 j->in_dbus_queue = false;
82 }
83
84 if (j->in_gc_queue) {
85 LIST_REMOVE(gc_queue, j->manager->gc_job_queue, j);
86 j->in_gc_queue = false;
87 }
88
89 j->timer_event_source = sd_event_source_unref(j->timer_event_source);
90 }
91
92 void 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);
101
102 sd_bus_track_unref(j->bus_track);
103 strv_free(j->deserialized_clients);
104
105 free(j);
106 }
107
108 static 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
134 void job_uninstall(Job *j) {
135 Job **pj;
136
137 assert(j->installed);
138
139 job_set_state(j, JOB_WAITING);
140
141 pj = (j->type == JOB_NOP) ? &j->unit->nop_job : &j->unit->job;
142 assert(*pj == j);
143
144 /* Detach from next 'bigger' objects */
145
146 /* daemon-reload should be transparent to job observers */
147 if (!MANAGER_IS_RELOADING(j->manager))
148 bus_job_send_removed_signal(j);
149
150 *pj = NULL;
151
152 unit_add_to_gc_queue(j->unit);
153
154 hashmap_remove(j->manager->jobs, UINT32_TO_PTR(j->id));
155 j->installed = false;
156 }
157
158 static 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. */
172 return t != JOB_RELOAD;
173 }
174
175 static void job_merge_into_installed(Job *j, Job *other) {
176 assert(j->installed);
177 assert(j->unit == other->unit);
178
179 if (j->type != JOB_NOP)
180 assert_se(job_type_merge_and_collapse(&j->type, other->type, j->unit) == 0);
181 else
182 assert(other->type == JOB_NOP);
183
184 j->irreversible = j->irreversible || other->irreversible;
185 j->ignore_order = j->ignore_order || other->ignore_order;
186 }
187
188 Job* job_install(Job *j) {
189 Job **pj;
190 Job *uj;
191
192 assert(!j->installed);
193 assert(j->type < _JOB_TYPE_MAX_IN_TRANSACTION);
194 assert(j->state == JOB_WAITING);
195
196 pj = (j->type == JOB_NOP) ? &j->unit->nop_job : &j->unit->job;
197 uj = *pj;
198
199 if (uj) {
200 if (job_type_is_conflicting(uj->type, j->type))
201 job_finish_and_invalidate(uj, JOB_CANCELED, false, false);
202 else {
203 /* not conflicting, i.e. mergeable */
204
205 if (uj->state == JOB_WAITING ||
206 (job_type_allows_late_merge(j->type) && job_type_is_superset(uj->type, j->type))) {
207 job_merge_into_installed(uj, j);
208 log_unit_debug(uj->unit,
209 "Merged into installed job %s/%s as %u",
210 uj->unit->id, job_type_to_string(uj->type), (unsigned) uj->id);
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);
218 log_unit_debug(uj->unit,
219 "Merged into running job, re-running: %s/%s as %u",
220 uj->unit->id, job_type_to_string(uj->type), (unsigned) uj->id);
221
222 job_set_state(uj, JOB_WAITING);
223 return uj;
224 }
225 }
226 }
227
228 /* Install the job */
229 *pj = j;
230 j->installed = true;
231
232 j->manager->n_installed_jobs++;
233 log_unit_debug(j->unit,
234 "Installed new job %s/%s as %u",
235 j->unit->id, job_type_to_string(j->type), (unsigned) j->id);
236
237 job_add_to_gc_queue(j);
238
239 return j;
240 }
241
242 int job_install_deserialized(Job *j) {
243 Job **pj;
244
245 assert(!j->installed);
246
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;
253 if (*pj) {
254 log_unit_debug(j->unit, "Unit already has a job installed. Not installing deserialized job.");
255 return -EEXIST;
256 }
257
258 *pj = j;
259 j->installed = true;
260 j->reloaded = true;
261
262 if (j->state == JOB_RUNNING)
263 j->unit->manager->n_running_jobs++;
264
265 log_unit_debug(j->unit,
266 "Reinstalled deserialized job %s/%s as %u",
267 j->unit->id, job_type_to_string(j->type), (unsigned) j->id);
268 return 0;
269 }
270
271 JobDependency* job_dependency_new(Job *subject, Job *object, bool matters, bool conflicts) {
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
279 * explicitly asked for) is the requester. */
280
281 l = new0(JobDependency, 1);
282 if (!l)
283 return NULL;
284
285 l->subject = subject;
286 l->object = object;
287 l->matters = matters;
288 l->conflicts = conflicts;
289
290 if (subject)
291 LIST_PREPEND(subject, subject->subject_list, l);
292
293 LIST_PREPEND(object, object->object_list, l);
294
295 return l;
296 }
297
298 void job_dependency_free(JobDependency *l) {
299 assert(l);
300
301 if (l->subject)
302 LIST_REMOVE(subject, l->subject->subject_list, l);
303
304 LIST_REMOVE(object, l->object->object_list, l);
305
306 free(l);
307 }
308
309 void job_dump(Job *j, FILE*f, const char *prefix) {
310 assert(j);
311 assert(f);
312
313 prefix = strempty(prefix);
314
315 fprintf(f,
316 "%s-> Job %u:\n"
317 "%s\tAction: %s -> %s\n"
318 "%s\tState: %s\n"
319 "%s\tIrreversible: %s\n"
320 "%s\tMay GC: %s\n",
321 prefix, j->id,
322 prefix, j->unit->id, job_type_to_string(j->type),
323 prefix, job_state_to_string(j->state),
324 prefix, yes_no(j->irreversible),
325 prefix, yes_no(job_may_gc(j)));
326 }
327
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 *
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 *
337 * Merging is associative! A merged with B, and then merged with C is the same
338 * as A merged with the result of B merged with C.
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 */
346 static const JobType job_merging_table[] = {
347 /* What \ With * JOB_START JOB_VERIFY_ACTIVE JOB_STOP JOB_RELOAD */
348 /*********************************************************************************/
349 /*JOB_START */
350 /*JOB_VERIFY_ACTIVE */ JOB_START,
351 /*JOB_STOP */ -1, -1,
352 /*JOB_RELOAD */ JOB_RELOAD_OR_START, JOB_RELOAD, -1,
353 /*JOB_RESTART */ JOB_RESTART, JOB_RESTART, -1, JOB_RESTART,
354 };
355
356 JobType job_type_lookup_merge(JobType a, JobType b) {
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);
360
361 if (a == b)
362 return a;
363
364 if (a < b) {
365 JobType tmp = a;
366 a = b;
367 b = tmp;
368 }
369
370 return job_merging_table[(a - 1) * a / 2 + b];
371 }
372
373 bool job_type_is_redundant(JobType a, UnitActiveState b) {
374 switch (a) {
375
376 case JOB_START:
377 return IN_SET(b, UNIT_ACTIVE, UNIT_RELOADING);
378
379 case JOB_STOP:
380 return IN_SET(b, UNIT_INACTIVE, UNIT_FAILED);
381
382 case JOB_VERIFY_ACTIVE:
383 return IN_SET(b, UNIT_ACTIVE, UNIT_RELOADING);
384
385 case JOB_RELOAD:
386 return
387 b == UNIT_RELOADING;
388
389 case JOB_RESTART:
390 return
391 b == UNIT_ACTIVATING;
392
393 case JOB_NOP:
394 return true;
395
396 default:
397 assert_not_reached("Invalid job type");
398 }
399 }
400
401 JobType job_type_collapse(JobType t, Unit *u) {
402 UnitActiveState s;
403
404 switch (t) {
405
406 case JOB_TRY_RESTART:
407 s = unit_active_state(u);
408 if (UNIT_IS_INACTIVE_OR_DEACTIVATING(s))
409 return JOB_NOP;
410
411 return JOB_RESTART;
412
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
420 case JOB_RELOAD_OR_START:
421 s = unit_active_state(u);
422 if (UNIT_IS_INACTIVE_OR_DEACTIVATING(s))
423 return JOB_START;
424
425 return JOB_RELOAD;
426
427 default:
428 return t;
429 }
430 }
431
432 int job_type_merge_and_collapse(JobType *a, JobType b, Unit *u) {
433 JobType t;
434
435 t = job_type_lookup_merge(*a, b);
436 if (t < 0)
437 return -EEXIST;
438
439 *a = job_type_collapse(t, u);
440 return 0;
441 }
442
443 static bool job_is_runnable(Job *j) {
444 Iterator i;
445 Unit *other;
446 void *v;
447
448 assert(j);
449 assert(j->installed);
450
451 /* Checks whether there is any job running for the units this
452 * job needs to be running after (in the case of a 'positive'
453 * job type) or before (in the case of a 'negative' job
454 * type. */
455
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
461 /* First check if there is an override */
462 if (j->ignore_order)
463 return true;
464
465 if (j->type == JOB_NOP)
466 return true;
467
468 if (IN_SET(j->type, JOB_START, JOB_VERIFY_ACTIVE, JOB_RELOAD)) {
469 /* Immediate result is that the job is or might be
470 * started. In this case let's wait for the
471 * dependencies, regardless whether they are
472 * starting or stopping something. */
473
474 HASHMAP_FOREACH_KEY(v, other, j->unit->dependencies[UNIT_AFTER], i)
475 if (other->job)
476 return false;
477 }
478
479 /* Also, if something else is being stopped and we should
480 * change state after it, then let's wait. */
481
482 HASHMAP_FOREACH_KEY(v, other, j->unit->dependencies[UNIT_BEFORE], i)
483 if (other->job &&
484 IN_SET(other->job->type, JOB_STOP, JOB_RESTART))
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
501 static void job_change_type(Job *j, JobType newtype) {
502 assert(j);
503
504 log_unit_debug(j->unit,
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));
508
509 j->type = newtype;
510 }
511
512 _pure_ static const char* job_get_begin_status_message_format(Unit *u, JobType t) {
513 const UnitStatusMessageFormats *format_table;
514 const char *format;
515
516 assert(u);
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;
528 }
529
530 /* Return generic strings */
531 if (t == JOB_START)
532 return "Starting %s.";
533 else {
534 assert(t == JOB_STOP);
535 return "Stopping %s.";
536 }
537 }
538
539 static 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
555 static void job_log_begin_status_message(Unit *u, uint32_t job_id, JobType t) {
556 const char *format, *mid;
557 char buf[LINE_MAX];
558
559 assert(u);
560 assert(t >= 0);
561 assert(t < _JOB_TYPE_MAX);
562
563 if (!IN_SET(t, JOB_START, JOB_STOP, JOB_RELOAD))
564 return;
565
566 if (log_on_console())
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),
589 "JOB_ID=%" PRIu32, job_id,
590 "JOB_TYPE=%s", job_type_to_string(t),
591 LOG_UNIT_ID(u),
592 LOG_UNIT_INVOCATION_ID(u),
593 mid);
594 }
595
596 static void job_emit_begin_status_message(Unit *u, uint32_t job_id, JobType t) {
597 assert(u);
598 assert(t >= 0);
599 assert(t < _JOB_TYPE_MAX);
600
601 job_log_begin_status_message(u, job_id, t);
602 job_print_begin_status_message(u, t);
603 }
604
605 static int job_perform_on_unit(Job **j) {
606 uint32_t id;
607 Manager *m;
608 JobType t;
609 Unit *u;
610 int r;
611
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
626 switch (t) {
627 case JOB_START:
628 r = unit_start(u);
629 break;
630
631 case JOB_RESTART:
632 t = JOB_STOP;
633 _fallthrough_;
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
646 /* Log if the job still exists and the start/stop/reload function
647 * actually did something. */
648 *j = manager_get_job(m, id);
649 if (*j && r > 0)
650 job_emit_begin_status_message(u, id, t);
651
652 return r;
653 }
654
655 int job_run_and_invalidate(Job *j) {
656 int r;
657
658 assert(j);
659 assert(j->installed);
660 assert(j->type < _JOB_TYPE_MAX_IN_TRANSACTION);
661 assert(j->in_run_queue);
662
663 LIST_REMOVE(run_queue, j->manager->run_queue, j);
664 j->in_run_queue = false;
665
666 if (j->state != JOB_WAITING)
667 return 0;
668
669 if (!job_is_runnable(j))
670 return -EAGAIN;
671
672 job_start_timer(j, true);
673 job_set_state(j, JOB_RUNNING);
674 job_add_to_dbus_queue(j);
675
676 switch (j->type) {
677
678 case JOB_VERIFY_ACTIVE: {
679 UnitActiveState t;
680
681 t = unit_active_state(j->unit);
682 if (UNIT_IS_ACTIVE_OR_RELOADING(t))
683 r = -EALREADY;
684 else if (t == UNIT_ACTIVATING)
685 r = -EAGAIN;
686 else
687 r = -EBADR;
688 break;
689 }
690
691 case JOB_START:
692 case JOB_STOP:
693 case JOB_RESTART:
694 r = job_perform_on_unit(&j);
695
696 /* If the unit type does not support starting/stopping, then simply wait. */
697 if (r == -EBADR)
698 r = 0;
699 break;
700
701 case JOB_RELOAD:
702 r = job_perform_on_unit(&j);
703 break;
704
705 case JOB_NOP:
706 r = -EALREADY;
707 break;
708
709 default:
710 assert_not_reached("Unknown job type");
711 }
712
713 if (j) {
714 if (r == -EAGAIN)
715 job_set_state(j, JOB_WAITING); /* Hmm, not ready after all, let's return to JOB_WAITING state */
716 else if (r == -EALREADY)
717 r = job_finish_and_invalidate(j, JOB_DONE, true, true);
718 else if (r == -EBADR)
719 r = job_finish_and_invalidate(j, JOB_SKIPPED, true, false);
720 else if (r == -ENOEXEC)
721 r = job_finish_and_invalidate(j, JOB_INVALID, true, false);
722 else if (r == -EPROTO)
723 r = job_finish_and_invalidate(j, JOB_ASSERT, true, false);
724 else if (r == -EOPNOTSUPP)
725 r = job_finish_and_invalidate(j, JOB_UNSUPPORTED, true, false);
726 else if (r == -ENOLINK)
727 r = job_finish_and_invalidate(j, JOB_DEPENDENCY, true, false);
728 else if (r == -ESTALE)
729 r = job_finish_and_invalidate(j, JOB_ONCE, true, false);
730 else if (r < 0)
731 r = job_finish_and_invalidate(j, JOB_FAILED, true, false);
732 }
733
734 return r;
735 }
736
737 _pure_ static const char *job_get_done_status_message_format(Unit *u, JobType t, JobResult result) {
738
739 static const char *const generic_finished_start_job[_JOB_RESULT_MAX] = {
740 [JOB_DONE] = "Started %s.",
741 [JOB_TIMEOUT] = "Timed out starting %s.",
742 [JOB_FAILED] = "Failed to start %s.",
743 [JOB_DEPENDENCY] = "Dependency failed for %s.",
744 [JOB_ASSERT] = "Assertion failed for %s.",
745 [JOB_UNSUPPORTED] = "Starting of %s not supported.",
746 [JOB_COLLECTED] = "Unnecessary job for %s was removed.",
747 [JOB_ONCE] = "Unit %s has been started before and cannot be started again."
748 };
749 static const char *const generic_finished_stop_job[_JOB_RESULT_MAX] = {
750 [JOB_DONE] = "Stopped %s.",
751 [JOB_FAILED] = "Stopped (with error) %s.",
752 [JOB_TIMEOUT] = "Timed out stopping %s.",
753 };
754 static const char *const generic_finished_reload_job[_JOB_RESULT_MAX] = {
755 [JOB_DONE] = "Reloaded %s.",
756 [JOB_FAILED] = "Reload failed for %s.",
757 [JOB_TIMEOUT] = "Timed out reloading %s.",
758 };
759 /* When verify-active detects the unit is inactive, report it.
760 * Most likely a DEPEND warning from a requisiting unit will
761 * occur next and it's nice to see what was requisited. */
762 static const char *const generic_finished_verify_active_job[_JOB_RESULT_MAX] = {
763 [JOB_SKIPPED] = "%s is not active.",
764 };
765
766 const UnitStatusMessageFormats *format_table;
767 const char *format;
768
769 assert(u);
770 assert(t >= 0);
771 assert(t < _JOB_TYPE_MAX);
772
773 if (IN_SET(t, JOB_START, JOB_STOP, JOB_RESTART)) {
774 format_table = &UNIT_VTABLE(u)->status_message_formats;
775 if (format_table) {
776 format = t == JOB_START ? format_table->finished_start_job[result] :
777 format_table->finished_stop_job[result];
778 if (format)
779 return format;
780 }
781 }
782
783 /* Return generic strings */
784 if (t == JOB_START)
785 return generic_finished_start_job[result];
786 else if (IN_SET(t, JOB_STOP, JOB_RESTART))
787 return generic_finished_stop_job[result];
788 else if (t == JOB_RELOAD)
789 return generic_finished_reload_job[result];
790 else if (t == JOB_VERIFY_ACTIVE)
791 return generic_finished_verify_active_job[result];
792
793 return NULL;
794 }
795
796 static const struct {
797 const char *color, *word;
798 } job_print_done_status_messages[_JOB_RESULT_MAX] = {
799 [JOB_DONE] = { ANSI_OK_COLOR, " OK " },
800 [JOB_TIMEOUT] = { ANSI_HIGHLIGHT_RED, " TIME " },
801 [JOB_FAILED] = { ANSI_HIGHLIGHT_RED, "FAILED" },
802 [JOB_DEPENDENCY] = { ANSI_HIGHLIGHT_YELLOW, "DEPEND" },
803 [JOB_SKIPPED] = { ANSI_HIGHLIGHT, " INFO " },
804 [JOB_ASSERT] = { ANSI_HIGHLIGHT_YELLOW, "ASSERT" },
805 [JOB_UNSUPPORTED] = { ANSI_HIGHLIGHT_YELLOW, "UNSUPP" },
806 /* JOB_COLLECTED */
807 [JOB_ONCE] = { ANSI_HIGHLIGHT_RED, " ONCE " },
808 };
809
810 static void job_print_done_status_message(Unit *u, JobType t, JobResult result) {
811 const char *format;
812 const char *status;
813
814 assert(u);
815 assert(t >= 0);
816 assert(t < _JOB_TYPE_MAX);
817
818 /* Reload status messages have traditionally not been printed to console. */
819 if (t == JOB_RELOAD)
820 return;
821
822 if (!job_print_done_status_messages[result].word)
823 return;
824
825 format = job_get_done_status_message_format(u, t, result);
826 if (!format)
827 return;
828
829 if (log_get_show_color())
830 status = strjoina(job_print_done_status_messages[result].color,
831 job_print_done_status_messages[result].word,
832 ANSI_NORMAL);
833 else
834 status = job_print_done_status_messages[result].word;
835
836 if (result != JOB_DONE)
837 manager_flip_auto_status(u->manager, true);
838
839 DISABLE_WARNING_FORMAT_NONLITERAL;
840 unit_status_printf(u, status, format);
841 REENABLE_WARNING;
842
843 if (t == JOB_START && result == JOB_FAILED) {
844 _cleanup_free_ char *quoted;
845
846 quoted = shell_maybe_quote(u->id, ESCAPE_BACKSLASH);
847 manager_status_printf(u->manager, STATUS_TYPE_NORMAL, NULL, "See 'systemctl status %s' for details.", strna(quoted));
848 }
849 }
850
851 static void job_log_done_status_message(Unit *u, uint32_t job_id, JobType t, JobResult result) {
852 const char *format, *mid;
853 char buf[LINE_MAX];
854 static const int job_result_log_level[_JOB_RESULT_MAX] = {
855 [JOB_DONE] = LOG_INFO,
856 [JOB_CANCELED] = LOG_INFO,
857 [JOB_TIMEOUT] = LOG_ERR,
858 [JOB_FAILED] = LOG_ERR,
859 [JOB_DEPENDENCY] = LOG_WARNING,
860 [JOB_SKIPPED] = LOG_NOTICE,
861 [JOB_INVALID] = LOG_INFO,
862 [JOB_ASSERT] = LOG_WARNING,
863 [JOB_UNSUPPORTED] = LOG_WARNING,
864 [JOB_COLLECTED] = LOG_INFO,
865 [JOB_ONCE] = LOG_ERR,
866 };
867
868 assert(u);
869 assert(t >= 0);
870 assert(t < _JOB_TYPE_MAX);
871
872 /* Skip printing if output goes to the console, and job_print_status_message()
873 will actually print something to the console. */
874 if (log_on_console() && job_print_done_status_messages[result].word)
875 return;
876
877 format = job_get_done_status_message_format(u, t, result);
878 if (!format)
879 return;
880
881 /* The description might be longer than the buffer, but that's OK,
882 * we'll just truncate it here. Note that we use snprintf() rather than
883 * xsprintf() on purpose here: we are fine with truncation and don't
884 * consider that an error. */
885 DISABLE_WARNING_FORMAT_NONLITERAL;
886 (void) snprintf(buf, sizeof(buf), format, unit_description(u));
887 REENABLE_WARNING;
888
889 switch (t) {
890
891 case JOB_START:
892 if (result == JOB_DONE)
893 mid = "MESSAGE_ID=" SD_MESSAGE_UNIT_STARTED_STR;
894 else
895 mid = "MESSAGE_ID=" SD_MESSAGE_UNIT_FAILED_STR;
896 break;
897
898 case JOB_RELOAD:
899 mid = "MESSAGE_ID=" SD_MESSAGE_UNIT_RELOADED_STR;
900 break;
901
902 case JOB_STOP:
903 case JOB_RESTART:
904 mid = "MESSAGE_ID=" SD_MESSAGE_UNIT_STOPPED_STR;
905 break;
906
907 default:
908 log_struct(job_result_log_level[result],
909 LOG_MESSAGE("%s", buf),
910 "JOB_ID=%" PRIu32, job_id,
911 "JOB_TYPE=%s", job_type_to_string(t),
912 "JOB_RESULT=%s", job_result_to_string(result),
913 LOG_UNIT_ID(u),
914 LOG_UNIT_INVOCATION_ID(u));
915 return;
916 }
917
918 log_struct(job_result_log_level[result],
919 LOG_MESSAGE("%s", buf),
920 "JOB_ID=%" PRIu32, job_id,
921 "JOB_TYPE=%s", job_type_to_string(t),
922 "JOB_RESULT=%s", job_result_to_string(result),
923 LOG_UNIT_ID(u),
924 LOG_UNIT_INVOCATION_ID(u),
925 mid);
926 }
927
928 static void job_emit_done_status_message(Unit *u, uint32_t job_id, JobType t, JobResult result) {
929 assert(u);
930
931 /* No message if the job did not actually do anything due to failed condition. */
932 if (t == JOB_START && result == JOB_DONE && !u->condition_result)
933 return;
934
935 job_log_done_status_message(u, job_id, t, result);
936 job_print_done_status_message(u, t, result);
937 }
938
939 static void job_fail_dependencies(Unit *u, UnitDependency d) {
940 Unit *other;
941 Iterator i;
942 void *v;
943
944 assert(u);
945
946 HASHMAP_FOREACH_KEY(v, other, u->dependencies[d], i) {
947 Job *j = other->job;
948
949 if (!j)
950 continue;
951 if (!IN_SET(j->type, JOB_START, JOB_VERIFY_ACTIVE))
952 continue;
953
954 job_finish_and_invalidate(j, JOB_DEPENDENCY, true, false);
955 }
956 }
957
958 static int job_save_pending_finished_job(Job *j) {
959 int r;
960
961 assert(j);
962
963 r = set_ensure_allocated(&j->manager->pending_finished_jobs, NULL);
964 if (r < 0)
965 return r;
966
967 job_unlink(j);
968 return set_put(j->manager->pending_finished_jobs, j);
969 }
970
971 int job_finish_and_invalidate(Job *j, JobResult result, bool recursive, bool already) {
972 Unit *u;
973 Unit *other;
974 JobType t;
975 Iterator i;
976 void *v;
977
978 assert(j);
979 assert(j->installed);
980 assert(j->type < _JOB_TYPE_MAX_IN_TRANSACTION);
981
982 u = j->unit;
983 t = j->type;
984
985 j->result = result;
986
987 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));
988
989 /* If this job did nothing to respective unit we don't log the status message */
990 if (!already)
991 job_emit_done_status_message(u, j->id, t, result);
992
993 /* Patch restart jobs so that they become normal start jobs */
994 if (result == JOB_DONE && t == JOB_RESTART) {
995
996 job_change_type(j, JOB_START);
997 job_set_state(j, JOB_WAITING);
998
999 job_add_to_dbus_queue(j);
1000 job_add_to_run_queue(j);
1001 job_add_to_gc_queue(j);
1002
1003 goto finish;
1004 }
1005
1006 if (IN_SET(result, JOB_FAILED, JOB_INVALID))
1007 j->manager->n_failed_jobs++;
1008
1009 job_uninstall(j);
1010 /* Keep jobs started before the reload to send singal later, free all others */
1011 if (!MANAGER_IS_RELOADING(j->manager) ||
1012 !j->reloaded ||
1013 job_save_pending_finished_job(j) < 0)
1014 job_free(j);
1015
1016 /* Fail depending jobs on failure */
1017 if (result != JOB_DONE && recursive) {
1018 if (IN_SET(t, JOB_START, JOB_VERIFY_ACTIVE)) {
1019 job_fail_dependencies(u, UNIT_REQUIRED_BY);
1020 job_fail_dependencies(u, UNIT_REQUISITE_OF);
1021 job_fail_dependencies(u, UNIT_BOUND_BY);
1022 } else if (t == JOB_STOP)
1023 job_fail_dependencies(u, UNIT_CONFLICTED_BY);
1024 }
1025
1026 /* Trigger OnFailure dependencies that are not generated by
1027 * the unit itself. We don't treat JOB_CANCELED as failure in
1028 * this context. And JOB_FAILURE is already handled by the
1029 * unit itself. */
1030 if (IN_SET(result, JOB_TIMEOUT, JOB_DEPENDENCY)) {
1031 log_struct(LOG_NOTICE,
1032 "JOB_TYPE=%s", job_type_to_string(t),
1033 "JOB_RESULT=%s", job_result_to_string(result),
1034 LOG_UNIT_ID(u),
1035 LOG_UNIT_MESSAGE(u, "Job %s/%s failed with result '%s'.",
1036 u->id,
1037 job_type_to_string(t),
1038 job_result_to_string(result)));
1039
1040 unit_start_on_failure(u);
1041 }
1042
1043 unit_trigger_notify(u);
1044
1045 finish:
1046 /* Try to start the next jobs that can be started */
1047 HASHMAP_FOREACH_KEY(v, other, u->dependencies[UNIT_AFTER], i)
1048 if (other->job) {
1049 job_add_to_run_queue(other->job);
1050 job_add_to_gc_queue(other->job);
1051 }
1052 HASHMAP_FOREACH_KEY(v, other, u->dependencies[UNIT_BEFORE], i)
1053 if (other->job) {
1054 job_add_to_run_queue(other->job);
1055 job_add_to_gc_queue(other->job);
1056 }
1057
1058 manager_check_finished(u->manager);
1059
1060 return 0;
1061 }
1062
1063 static int job_dispatch_timer(sd_event_source *s, uint64_t monotonic, void *userdata) {
1064 Job *j = userdata;
1065 Unit *u;
1066
1067 assert(j);
1068 assert(s == j->timer_event_source);
1069
1070 log_unit_warning(j->unit, "Job %s/%s timed out.", j->unit->id, job_type_to_string(j->type));
1071
1072 u = j->unit;
1073 job_finish_and_invalidate(j, JOB_TIMEOUT, true, false);
1074
1075 emergency_action(u->manager, u->job_timeout_action,
1076 EMERGENCY_ACTION_IS_WATCHDOG|EMERGENCY_ACTION_WARN,
1077 u->job_timeout_reboot_arg, "job timed out");
1078
1079 return 0;
1080 }
1081
1082 int job_start_timer(Job *j, bool job_running) {
1083 int r;
1084 usec_t timeout_time, old_timeout_time;
1085
1086 if (job_running) {
1087 j->begin_running_usec = now(CLOCK_MONOTONIC);
1088
1089 if (j->unit->job_running_timeout == USEC_INFINITY)
1090 return 0;
1091
1092 timeout_time = usec_add(j->begin_running_usec, j->unit->job_running_timeout);
1093
1094 if (j->timer_event_source) {
1095 /* Update only if JobRunningTimeoutSec= results in earlier timeout */
1096 r = sd_event_source_get_time(j->timer_event_source, &old_timeout_time);
1097 if (r < 0)
1098 return r;
1099
1100 if (old_timeout_time <= timeout_time)
1101 return 0;
1102
1103 return sd_event_source_set_time(j->timer_event_source, timeout_time);
1104 }
1105 } else {
1106 if (j->timer_event_source)
1107 return 0;
1108
1109 j->begin_usec = now(CLOCK_MONOTONIC);
1110
1111 if (j->unit->job_timeout == USEC_INFINITY)
1112 return 0;
1113
1114 timeout_time = usec_add(j->begin_usec, j->unit->job_timeout);
1115 }
1116
1117 r = sd_event_add_time(
1118 j->manager->event,
1119 &j->timer_event_source,
1120 CLOCK_MONOTONIC,
1121 timeout_time, 0,
1122 job_dispatch_timer, j);
1123 if (r < 0)
1124 return r;
1125
1126 (void) sd_event_source_set_description(j->timer_event_source, "job-start");
1127
1128 return 0;
1129 }
1130
1131 void job_add_to_run_queue(Job *j) {
1132 int r;
1133
1134 assert(j);
1135 assert(j->installed);
1136
1137 if (j->in_run_queue)
1138 return;
1139
1140 if (!j->manager->run_queue) {
1141 r = sd_event_source_set_enabled(j->manager->run_queue_event_source, SD_EVENT_ONESHOT);
1142 if (r < 0)
1143 log_warning_errno(r, "Failed to enable job run queue event source, ignoring: %m");
1144 }
1145
1146 LIST_PREPEND(run_queue, j->manager->run_queue, j);
1147 j->in_run_queue = true;
1148 }
1149
1150 void job_add_to_dbus_queue(Job *j) {
1151 assert(j);
1152 assert(j->installed);
1153
1154 if (j->in_dbus_queue)
1155 return;
1156
1157 /* We don't check if anybody is subscribed here, since this
1158 * job might just have been created and not yet assigned to a
1159 * connection/client. */
1160
1161 LIST_PREPEND(dbus_queue, j->manager->dbus_job_queue, j);
1162 j->in_dbus_queue = true;
1163 }
1164
1165 char *job_dbus_path(Job *j) {
1166 char *p;
1167
1168 assert(j);
1169
1170 if (asprintf(&p, "/org/freedesktop/systemd1/job/%"PRIu32, j->id) < 0)
1171 return NULL;
1172
1173 return p;
1174 }
1175
1176 int job_serialize(Job *j, FILE *f) {
1177 assert(j);
1178 assert(f);
1179
1180 (void) serialize_item_format(f, "job-id", "%u", j->id);
1181 (void) serialize_item(f, "job-type", job_type_to_string(j->type));
1182 (void) serialize_item(f, "job-state", job_state_to_string(j->state));
1183 (void) serialize_bool(f, "job-irreversible", j->irreversible);
1184 (void) serialize_bool(f, "job-sent-dbus-new-signal", j->sent_dbus_new_signal);
1185 (void) serialize_bool(f, "job-ignore-order", j->ignore_order);
1186
1187 if (j->begin_usec > 0)
1188 (void) serialize_usec(f, "job-begin", j->begin_usec);
1189 if (j->begin_running_usec > 0)
1190 (void) serialize_usec(f, "job-begin-running", j->begin_running_usec);
1191
1192 bus_track_serialize(j->bus_track, f, "subscribed");
1193
1194 /* End marker */
1195 fputc('\n', f);
1196 return 0;
1197 }
1198
1199 int job_deserialize(Job *j, FILE *f) {
1200 int r;
1201
1202 assert(j);
1203 assert(f);
1204
1205 for (;;) {
1206 _cleanup_free_ char *line = NULL;
1207 char *l, *v;
1208 size_t k;
1209
1210 r = read_line(f, LONG_LINE_MAX, &line);
1211 if (r < 0)
1212 return log_error_errno(r, "Failed to read serialization line: %m");
1213 if (r == 0)
1214 return 0;
1215
1216 l = strstrip(line);
1217
1218 /* End marker */
1219 if (isempty(l))
1220 return 0;
1221
1222 k = strcspn(l, "=");
1223
1224 if (l[k] == '=') {
1225 l[k] = 0;
1226 v = l+k+1;
1227 } else
1228 v = l+k;
1229
1230 if (streq(l, "job-id")) {
1231
1232 if (safe_atou32(v, &j->id) < 0)
1233 log_debug("Failed to parse job id value: %s", v);
1234
1235 } else if (streq(l, "job-type")) {
1236 JobType t;
1237
1238 t = job_type_from_string(v);
1239 if (t < 0)
1240 log_debug("Failed to parse job type: %s", v);
1241 else if (t >= _JOB_TYPE_MAX_IN_TRANSACTION)
1242 log_debug("Cannot deserialize job of type: %s", v);
1243 else
1244 j->type = t;
1245
1246 } else if (streq(l, "job-state")) {
1247 JobState s;
1248
1249 s = job_state_from_string(v);
1250 if (s < 0)
1251 log_debug("Failed to parse job state: %s", v);
1252 else
1253 job_set_state(j, s);
1254
1255 } else if (streq(l, "job-irreversible")) {
1256 int b;
1257
1258 b = parse_boolean(v);
1259 if (b < 0)
1260 log_debug("Failed to parse job irreversible flag: %s", v);
1261 else
1262 j->irreversible = j->irreversible || b;
1263
1264 } else if (streq(l, "job-sent-dbus-new-signal")) {
1265 int b;
1266
1267 b = parse_boolean(v);
1268 if (b < 0)
1269 log_debug("Failed to parse job sent_dbus_new_signal flag: %s", v);
1270 else
1271 j->sent_dbus_new_signal = j->sent_dbus_new_signal || b;
1272
1273 } else if (streq(l, "job-ignore-order")) {
1274 int b;
1275
1276 b = parse_boolean(v);
1277 if (b < 0)
1278 log_debug("Failed to parse job ignore_order flag: %s", v);
1279 else
1280 j->ignore_order = j->ignore_order || b;
1281
1282 } else if (streq(l, "job-begin"))
1283 (void) deserialize_usec(v, &j->begin_usec);
1284
1285 else if (streq(l, "job-begin-running"))
1286 (void) deserialize_usec(v, &j->begin_running_usec);
1287
1288 else if (streq(l, "subscribed")) {
1289 if (strv_extend(&j->deserialized_clients, v) < 0)
1290 return log_oom();
1291 } else
1292 log_debug("Unknown job serialization key: %s", l);
1293 }
1294 }
1295
1296 int job_coldplug(Job *j) {
1297 int r;
1298 usec_t timeout_time = USEC_INFINITY;
1299
1300 assert(j);
1301
1302 /* After deserialization is complete and the bus connection
1303 * set up again, let's start watching our subscribers again */
1304 (void) bus_job_coldplug_bus_track(j);
1305
1306 if (j->state == JOB_WAITING)
1307 job_add_to_run_queue(j);
1308
1309 /* Maybe due to new dependencies we don't actually need this job anymore? */
1310 job_add_to_gc_queue(j);
1311
1312 /* Create timer only when job began or began running and the respective timeout is finite.
1313 * Follow logic of job_start_timer() if both timeouts are finite */
1314 if (j->begin_usec == 0)
1315 return 0;
1316
1317 if (j->unit->job_timeout != USEC_INFINITY)
1318 timeout_time = usec_add(j->begin_usec, j->unit->job_timeout);
1319
1320 if (j->begin_running_usec > 0 && j->unit->job_running_timeout != USEC_INFINITY)
1321 timeout_time = MIN(timeout_time, usec_add(j->begin_running_usec, j->unit->job_running_timeout));
1322
1323 if (timeout_time == USEC_INFINITY)
1324 return 0;
1325
1326 j->timer_event_source = sd_event_source_unref(j->timer_event_source);
1327
1328 r = sd_event_add_time(
1329 j->manager->event,
1330 &j->timer_event_source,
1331 CLOCK_MONOTONIC,
1332 timeout_time, 0,
1333 job_dispatch_timer, j);
1334 if (r < 0)
1335 log_debug_errno(r, "Failed to restart timeout for job: %m");
1336
1337 (void) sd_event_source_set_description(j->timer_event_source, "job-timeout");
1338
1339 return r;
1340 }
1341
1342 void job_shutdown_magic(Job *j) {
1343 assert(j);
1344
1345 /* The shutdown target gets some special treatment here: we
1346 * tell the kernel to begin with flushing its disk caches, to
1347 * optimize shutdown time a bit. Ideally we wouldn't hardcode
1348 * this magic into PID 1. However all other processes aren't
1349 * options either since they'd exit much sooner than PID 1 and
1350 * asynchronous sync() would cause their exit to be
1351 * delayed. */
1352
1353 if (j->type != JOB_START)
1354 return;
1355
1356 if (!MANAGER_IS_SYSTEM(j->unit->manager))
1357 return;
1358
1359 if (!unit_has_name(j->unit, SPECIAL_SHUTDOWN_TARGET))
1360 return;
1361
1362 /* In case messages on console has been disabled on boot */
1363 j->unit->manager->no_console_output = false;
1364
1365 if (detect_container() > 0)
1366 return;
1367
1368 (void) asynchronous_sync(NULL);
1369 }
1370
1371 int job_get_timeout(Job *j, usec_t *timeout) {
1372 usec_t x = USEC_INFINITY, y = USEC_INFINITY;
1373 Unit *u = j->unit;
1374 int r;
1375
1376 assert(u);
1377
1378 if (j->timer_event_source) {
1379 r = sd_event_source_get_time(j->timer_event_source, &x);
1380 if (r < 0)
1381 return r;
1382 }
1383
1384 if (UNIT_VTABLE(u)->get_timeout) {
1385 r = UNIT_VTABLE(u)->get_timeout(u, &y);
1386 if (r < 0)
1387 return r;
1388 }
1389
1390 if (x == USEC_INFINITY && y == USEC_INFINITY)
1391 return 0;
1392
1393 *timeout = MIN(x, y);
1394 return 1;
1395 }
1396
1397 bool job_may_gc(Job *j) {
1398 Unit *other;
1399 Iterator i;
1400 void *v;
1401
1402 assert(j);
1403
1404 /* Checks whether this job should be GC'ed away. We only do this for jobs of units that have no effect on their
1405 * own and just track external state. For now the only unit type that qualifies for this are .device units.
1406 * Returns true if the job can be collected. */
1407
1408 if (!UNIT_VTABLE(j->unit)->gc_jobs)
1409 return false;
1410
1411 if (sd_bus_track_count(j->bus_track) > 0)
1412 return false;
1413
1414 /* FIXME: So this is a bit ugly: for now we don't properly track references made via private bus connections
1415 * (because it's nasty, as sd_bus_track doesn't apply to it). We simply remember that the job was once
1416 * referenced by one, and reset this whenever we notice that no private bus connections are around. This means
1417 * the GC is a bit too conservative when it comes to jobs created by private bus connections. */
1418 if (j->ref_by_private_bus) {
1419 if (set_isempty(j->unit->manager->private_buses))
1420 j->ref_by_private_bus = false;
1421 else
1422 return false;
1423 }
1424
1425 if (j->type == JOB_NOP)
1426 return false;
1427
1428 /* If a job is ordered after ours, and is to be started, then it needs to wait for us, regardless if we stop or
1429 * start, hence let's not GC in that case. */
1430 HASHMAP_FOREACH_KEY(v, other, j->unit->dependencies[UNIT_BEFORE], i) {
1431 if (!other->job)
1432 continue;
1433
1434 if (other->job->ignore_order)
1435 continue;
1436
1437 if (IN_SET(other->job->type, JOB_START, JOB_VERIFY_ACTIVE, JOB_RELOAD))
1438 return false;
1439 }
1440
1441 /* If we are going down, but something else is ordered After= us, then it needs to wait for us */
1442 if (IN_SET(j->type, JOB_STOP, JOB_RESTART))
1443 HASHMAP_FOREACH_KEY(v, other, j->unit->dependencies[UNIT_AFTER], i) {
1444 if (!other->job)
1445 continue;
1446
1447 if (other->job->ignore_order)
1448 continue;
1449
1450 return false;
1451 }
1452
1453 /* The logic above is kinda the inverse of the job_is_runnable() logic. Specifically, if the job "we" is
1454 * ordered before the job "other":
1455 *
1456 * we start + other start → stay
1457 * we start + other stop → gc
1458 * we stop + other start → stay
1459 * we stop + other stop → gc
1460 *
1461 * "we" are ordered after "other":
1462 *
1463 * we start + other start → gc
1464 * we start + other stop → gc
1465 * we stop + other start → stay
1466 * we stop + other stop → stay
1467 */
1468
1469 return true;
1470 }
1471
1472 void job_add_to_gc_queue(Job *j) {
1473 assert(j);
1474
1475 if (j->in_gc_queue)
1476 return;
1477
1478 if (!job_may_gc(j))
1479 return;
1480
1481 LIST_PREPEND(gc_queue, j->unit->manager->gc_job_queue, j);
1482 j->in_gc_queue = true;
1483 }
1484
1485 static int job_compare(Job * const *a, Job * const *b) {
1486 return CMP((*a)->id, (*b)->id);
1487 }
1488
1489 static size_t sort_job_list(Job **list, size_t n) {
1490 Job *previous = NULL;
1491 size_t a, b;
1492
1493 /* Order by numeric IDs */
1494 typesafe_qsort(list, n, job_compare);
1495
1496 /* Filter out duplicates */
1497 for (a = 0, b = 0; a < n; a++) {
1498
1499 if (previous == list[a])
1500 continue;
1501
1502 previous = list[b++] = list[a];
1503 }
1504
1505 return b;
1506 }
1507
1508 int job_get_before(Job *j, Job*** ret) {
1509 _cleanup_free_ Job** list = NULL;
1510 size_t n = 0, n_allocated = 0;
1511 Unit *other = NULL;
1512 Iterator i;
1513 void *v;
1514
1515 /* Returns a list of all pending jobs that need to finish before this job may be started. */
1516
1517 assert(j);
1518 assert(ret);
1519
1520 if (j->ignore_order) {
1521 *ret = NULL;
1522 return 0;
1523 }
1524
1525 if (IN_SET(j->type, JOB_START, JOB_VERIFY_ACTIVE, JOB_RELOAD)) {
1526
1527 HASHMAP_FOREACH_KEY(v, other, j->unit->dependencies[UNIT_AFTER], i) {
1528 if (!other->job)
1529 continue;
1530
1531 if (!GREEDY_REALLOC(list, n_allocated, n+1))
1532 return -ENOMEM;
1533 list[n++] = other->job;
1534 }
1535 }
1536
1537 HASHMAP_FOREACH_KEY(v, other, j->unit->dependencies[UNIT_BEFORE], i) {
1538 if (!other->job)
1539 continue;
1540
1541 if (!IN_SET(other->job->type, JOB_STOP, JOB_RESTART))
1542 continue;
1543
1544 if (!GREEDY_REALLOC(list, n_allocated, n+1))
1545 return -ENOMEM;
1546 list[n++] = other->job;
1547 }
1548
1549 n = sort_job_list(list, n);
1550
1551 *ret = TAKE_PTR(list);
1552
1553 return (int) n;
1554 }
1555
1556 int job_get_after(Job *j, Job*** ret) {
1557 _cleanup_free_ Job** list = NULL;
1558 size_t n = 0, n_allocated = 0;
1559 Unit *other = NULL;
1560 void *v;
1561 Iterator i;
1562
1563 assert(j);
1564 assert(ret);
1565
1566 /* Returns a list of all pending jobs that are waiting for this job to finish. */
1567
1568 HASHMAP_FOREACH_KEY(v, other, j->unit->dependencies[UNIT_BEFORE], i) {
1569 if (!other->job)
1570 continue;
1571
1572 if (other->job->ignore_order)
1573 continue;
1574
1575 if (!IN_SET(other->job->type, JOB_START, JOB_VERIFY_ACTIVE, JOB_RELOAD))
1576 continue;
1577
1578 if (!GREEDY_REALLOC(list, n_allocated, n+1))
1579 return -ENOMEM;
1580 list[n++] = other->job;
1581 }
1582
1583 if (IN_SET(j->type, JOB_STOP, JOB_RESTART)) {
1584
1585 HASHMAP_FOREACH_KEY(v, other, j->unit->dependencies[UNIT_AFTER], i) {
1586 if (!other->job)
1587 continue;
1588
1589 if (other->job->ignore_order)
1590 continue;
1591
1592 if (!GREEDY_REALLOC(list, n_allocated, n+1))
1593 return -ENOMEM;
1594 list[n++] = other->job;
1595 }
1596 }
1597
1598 n = sort_job_list(list, n);
1599
1600 *ret = TAKE_PTR(list);
1601
1602 return (int) n;
1603 }
1604
1605 static const char* const job_state_table[_JOB_STATE_MAX] = {
1606 [JOB_WAITING] = "waiting",
1607 [JOB_RUNNING] = "running",
1608 };
1609
1610 DEFINE_STRING_TABLE_LOOKUP(job_state, JobState);
1611
1612 static const char* const job_type_table[_JOB_TYPE_MAX] = {
1613 [JOB_START] = "start",
1614 [JOB_VERIFY_ACTIVE] = "verify-active",
1615 [JOB_STOP] = "stop",
1616 [JOB_RELOAD] = "reload",
1617 [JOB_RELOAD_OR_START] = "reload-or-start",
1618 [JOB_RESTART] = "restart",
1619 [JOB_TRY_RESTART] = "try-restart",
1620 [JOB_TRY_RELOAD] = "try-reload",
1621 [JOB_NOP] = "nop",
1622 };
1623
1624 DEFINE_STRING_TABLE_LOOKUP(job_type, JobType);
1625
1626 static const char* const job_mode_table[_JOB_MODE_MAX] = {
1627 [JOB_FAIL] = "fail",
1628 [JOB_REPLACE] = "replace",
1629 [JOB_REPLACE_IRREVERSIBLY] = "replace-irreversibly",
1630 [JOB_ISOLATE] = "isolate",
1631 [JOB_FLUSH] = "flush",
1632 [JOB_IGNORE_DEPENDENCIES] = "ignore-dependencies",
1633 [JOB_IGNORE_REQUIREMENTS] = "ignore-requirements",
1634 };
1635
1636 DEFINE_STRING_TABLE_LOOKUP(job_mode, JobMode);
1637
1638 static const char* const job_result_table[_JOB_RESULT_MAX] = {
1639 [JOB_DONE] = "done",
1640 [JOB_CANCELED] = "canceled",
1641 [JOB_TIMEOUT] = "timeout",
1642 [JOB_FAILED] = "failed",
1643 [JOB_DEPENDENCY] = "dependency",
1644 [JOB_SKIPPED] = "skipped",
1645 [JOB_INVALID] = "invalid",
1646 [JOB_ASSERT] = "assert",
1647 [JOB_UNSUPPORTED] = "unsupported",
1648 [JOB_COLLECTED] = "collected",
1649 [JOB_ONCE] = "once",
1650 };
1651
1652 DEFINE_STRING_TABLE_LOOKUP(job_result, JobResult);
1653
1654 const char* job_type_to_access_method(JobType t) {
1655 assert(t >= 0);
1656 assert(t < _JOB_TYPE_MAX);
1657
1658 if (IN_SET(t, JOB_START, JOB_RESTART, JOB_TRY_RESTART))
1659 return "start";
1660 else if (t == JOB_STOP)
1661 return "stop";
1662 else
1663 return "reload";
1664 }
Unnamed repository; edit this file 'description' to name the repository.