]> git.ipfire.org Git - thirdparty/systemd.git/blob - src/core/job.c
projects / thirdparty / systemd.git / blob
? search:


012cf72d1fa1f59968329512fce0d47139e0d4c2
[thirdparty/systemd.git] / src / core / job.c
1 /***
2 This file is part of systemd.
3
4 Copyright 2010 Lennart Poettering
5
6 systemd is free software; you can redistribute it and/or modify it
7 under the terms of the GNU Lesser General Public License as published by
8 the Free Software Foundation; either version 2.1 of the License, or
9 (at your option) any later version.
10
11 systemd is distributed in the hope that it will be useful, but
12 WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 Lesser General Public License for more details.
15
16 You should have received a copy of the GNU Lesser General Public License
17 along with systemd; If not, see <http://www.gnu.org/licenses/>.
18 ***/
19
20 #include <errno.h>
21
22 #include "sd-id128.h"
23 #include "sd-messages.h"
24
25 #include "alloc-util.h"
26 #include "async.h"
27 #include "dbus-job.h"
28 #include "dbus.h"
29 #include "escape.h"
30 #include "job.h"
31 #include "log.h"
32 #include "macro.h"
33 #include "parse-util.h"
34 #include "set.h"
35 #include "special.h"
36 #include "stdio-util.h"
37 #include "string-table.h"
38 #include "string-util.h"
39 #include "strv.h"
40 #include "terminal-util.h"
41 #include "unit.h"
42 #include "virt.h"
43
44 Job* job_new_raw(Unit *unit) {
45 Job *j;
46
47 /* used for deserialization */
48
49 assert(unit);
50
51 j = new0(Job, 1);
52 if (!j)
53 return NULL;
54
55 j->manager = unit->manager;
56 j->unit = unit;
57 j->type = _JOB_TYPE_INVALID;
58
59 return j;
60 }
61
62 Job* job_new(Unit *unit, JobType type) {
63 Job *j;
64
65 assert(type < _JOB_TYPE_MAX);
66
67 j = job_new_raw(unit);
68 if (!j)
69 return NULL;
70
71 j->id = j->manager->current_job_id++;
72 j->type = type;
73
74 /* We don't link it here, that's what job_dependency() is for */
75
76 return j;
77 }
78
79 void job_free(Job *j) {
80 assert(j);
81 assert(!j->installed);
82 assert(!j->transaction_prev);
83 assert(!j->transaction_next);
84 assert(!j->subject_list);
85 assert(!j->object_list);
86
87 if (j->in_run_queue)
88 LIST_REMOVE(run_queue, j->manager->run_queue, j);
89
90 if (j->in_dbus_queue)
91 LIST_REMOVE(dbus_queue, j->manager->dbus_job_queue, j);
92
93 sd_event_source_unref(j->timer_event_source);
94
95 sd_bus_track_unref(j->clients);
96 strv_free(j->deserialized_clients);
97
98 free(j);
99 }
100
101 static void job_set_state(Job *j, JobState state) {
102 assert(j);
103 assert(state >= 0);
104 assert(state < _JOB_STATE_MAX);
105
106 if (j->state == state)
107 return;
108
109 j->state = state;
110
111 if (!j->installed)
112 return;
113
114 if (j->state == JOB_RUNNING)
115 j->unit->manager->n_running_jobs++;
116 else {
117 assert(j->state == JOB_WAITING);
118 assert(j->unit->manager->n_running_jobs > 0);
119
120 j->unit->manager->n_running_jobs--;
121
122 if (j->unit->manager->n_running_jobs <= 0)
123 j->unit->manager->jobs_in_progress_event_source = sd_event_source_unref(j->unit->manager->jobs_in_progress_event_source);
124 }
125 }
126
127 void job_uninstall(Job *j) {
128 Job **pj;
129
130 assert(j->installed);
131
132 job_set_state(j, JOB_WAITING);
133
134 pj = (j->type == JOB_NOP) ? &j->unit->nop_job : &j->unit->job;
135 assert(*pj == j);
136
137 /* Detach from next 'bigger' objects */
138
139 /* daemon-reload should be transparent to job observers */
140 if (j->manager->n_reloading <= 0)
141 bus_job_send_removed_signal(j);
142
143 *pj = NULL;
144
145 unit_add_to_gc_queue(j->unit);
146
147 hashmap_remove(j->manager->jobs, UINT32_TO_PTR(j->id));
148 j->installed = false;
149 }
150
151 static bool job_type_allows_late_merge(JobType t) {
152 /* Tells whether it is OK to merge a job of type 't' with an already
153 * running job.
154 * Reloads cannot be merged this way. Think of the sequence:
155 * 1. Reload of a daemon is in progress; the daemon has already loaded
156 * its config file, but hasn't completed the reload operation yet.
157 * 2. Edit foo's config file.
158 * 3. Trigger another reload to have the daemon use the new config.
159 * Should the second reload job be merged into the first one, the daemon
160 * would not know about the new config.
161 * JOB_RESTART jobs on the other hand can be merged, because they get
162 * patched into JOB_START after stopping the unit. So if we see a
163 * JOB_RESTART running, it means the unit hasn't stopped yet and at
164 * this time the merge is still allowed. */
165 return t != JOB_RELOAD;
166 }
167
168 static void job_merge_into_installed(Job *j, Job *other) {
169 assert(j->installed);
170 assert(j->unit == other->unit);
171
172 if (j->type != JOB_NOP)
173 job_type_merge_and_collapse(&j->type, other->type, j->unit);
174 else
175 assert(other->type == JOB_NOP);
176
177 j->irreversible = j->irreversible || other->irreversible;
178 j->ignore_order = j->ignore_order || other->ignore_order;
179 }
180
181 Job* job_install(Job *j) {
182 Job **pj;
183 Job *uj;
184
185 assert(!j->installed);
186 assert(j->type < _JOB_TYPE_MAX_IN_TRANSACTION);
187 assert(j->state == JOB_WAITING);
188
189 pj = (j->type == JOB_NOP) ? &j->unit->nop_job : &j->unit->job;
190 uj = *pj;
191
192 if (uj) {
193 if (job_type_is_conflicting(uj->type, j->type))
194 job_finish_and_invalidate(uj, JOB_CANCELED, false);
195 else {
196 /* not conflicting, i.e. mergeable */
197
198 if (uj->state == JOB_WAITING ||
199 (job_type_allows_late_merge(j->type) && job_type_is_superset(uj->type, j->type))) {
200 job_merge_into_installed(uj, j);
201 log_unit_debug(uj->unit,
202 "Merged into installed job %s/%s as %u",
203 uj->unit->id, job_type_to_string(uj->type), (unsigned) uj->id);
204 return uj;
205 } else {
206 /* already running and not safe to merge into */
207 /* Patch uj to become a merged job and re-run it. */
208 /* XXX It should be safer to queue j to run after uj finishes, but it is
209 * not currently possible to have more than one installed job per unit. */
210 job_merge_into_installed(uj, j);
211 log_unit_debug(uj->unit,
212 "Merged into running job, re-running: %s/%s as %u",
213 uj->unit->id, job_type_to_string(uj->type), (unsigned) uj->id);
214
215 job_set_state(uj, JOB_WAITING);
216 return uj;
217 }
218 }
219 }
220
221 /* Install the job */
222 *pj = j;
223 j->installed = true;
224
225 j->manager->n_installed_jobs++;
226 log_unit_debug(j->unit,
227 "Installed new job %s/%s as %u",
228 j->unit->id, job_type_to_string(j->type), (unsigned) j->id);
229 return j;
230 }
231
232 int job_install_deserialized(Job *j) {
233 Job **pj;
234
235 assert(!j->installed);
236
237 if (j->type < 0 || j->type >= _JOB_TYPE_MAX_IN_TRANSACTION) {
238 log_debug("Invalid job type %s in deserialization.", strna(job_type_to_string(j->type)));
239 return -EINVAL;
240 }
241
242 pj = (j->type == JOB_NOP) ? &j->unit->nop_job : &j->unit->job;
243 if (*pj) {
244 log_unit_debug(j->unit, "Unit already has a job installed. Not installing deserialized job.");
245 return -EEXIST;
246 }
247
248 *pj = j;
249 j->installed = true;
250
251 if (j->state == JOB_RUNNING)
252 j->unit->manager->n_running_jobs++;
253
254 log_unit_debug(j->unit,
255 "Reinstalled deserialized job %s/%s as %u",
256 j->unit->id, job_type_to_string(j->type), (unsigned) j->id);
257 return 0;
258 }
259
260 JobDependency* job_dependency_new(Job *subject, Job *object, bool matters, bool conflicts) {
261 JobDependency *l;
262
263 assert(object);
264
265 /* Adds a new job link, which encodes that the 'subject' job
266 * needs the 'object' job in some way. If 'subject' is NULL
267 * this means the 'anchor' job (i.e. the one the user
268 * explicitly asked for) is the requester. */
269
270 if (!(l = new0(JobDependency, 1)))
271 return NULL;
272
273 l->subject = subject;
274 l->object = object;
275 l->matters = matters;
276 l->conflicts = conflicts;
277
278 if (subject)
279 LIST_PREPEND(subject, subject->subject_list, l);
280
281 LIST_PREPEND(object, object->object_list, l);
282
283 return l;
284 }
285
286 void job_dependency_free(JobDependency *l) {
287 assert(l);
288
289 if (l->subject)
290 LIST_REMOVE(subject, l->subject->subject_list, l);
291
292 LIST_REMOVE(object, l->object->object_list, l);
293
294 free(l);
295 }
296
297 void job_dump(Job *j, FILE*f, const char *prefix) {
298 assert(j);
299 assert(f);
300
301 if (!prefix)
302 prefix = "";
303
304 fprintf(f,
305 "%s-> Job %u:\n"
306 "%s\tAction: %s -> %s\n"
307 "%s\tState: %s\n"
308 "%s\tIrreversible: %s\n",
309 prefix, j->id,
310 prefix, j->unit->id, job_type_to_string(j->type),
311 prefix, job_state_to_string(j->state),
312 prefix, yes_no(j->irreversible));
313 }
314
315 /*
316 * Merging is commutative, so imagine the matrix as symmetric. We store only
317 * its lower triangle to avoid duplication. We don't store the main diagonal,
318 * because A merged with A is simply A.
319 *
320 * If the resulting type is collapsed immediately afterwards (to get rid of
321 * the JOB_RELOAD_OR_START, which lies outside the lookup function's domain),
322 * the following properties hold:
323 *
324 * Merging is associative! A merged with B, and then merged with C is the same
325 * as A merged with the result of B merged with C.
326 *
327 * Mergeability is transitive! If A can be merged with B and B with C then
328 * A also with C.
329 *
330 * Also, if A merged with B cannot be merged with C, then either A or B cannot
331 * be merged with C either.
332 */
333 static const JobType job_merging_table[] = {
334 /* What \ With * JOB_START JOB_VERIFY_ACTIVE JOB_STOP JOB_RELOAD */
335 /*********************************************************************************/
336 /*JOB_START */
337 /*JOB_VERIFY_ACTIVE */ JOB_START,
338 /*JOB_STOP */ -1, -1,
339 /*JOB_RELOAD */ JOB_RELOAD_OR_START, JOB_RELOAD, -1,
340 /*JOB_RESTART */ JOB_RESTART, JOB_RESTART, -1, JOB_RESTART,
341 };
342
343 JobType job_type_lookup_merge(JobType a, JobType b) {
344 assert_cc(ELEMENTSOF(job_merging_table) == _JOB_TYPE_MAX_MERGING * (_JOB_TYPE_MAX_MERGING - 1) / 2);
345 assert(a >= 0 && a < _JOB_TYPE_MAX_MERGING);
346 assert(b >= 0 && b < _JOB_TYPE_MAX_MERGING);
347
348 if (a == b)
349 return a;
350
351 if (a < b) {
352 JobType tmp = a;
353 a = b;
354 b = tmp;
355 }
356
357 return job_merging_table[(a - 1) * a / 2 + b];
358 }
359
360 bool job_type_is_redundant(JobType a, UnitActiveState b) {
361 switch (a) {
362
363 case JOB_START:
364 return
365 b == UNIT_ACTIVE ||
366 b == UNIT_RELOADING;
367
368 case JOB_STOP:
369 return
370 b == UNIT_INACTIVE ||
371 b == UNIT_FAILED;
372
373 case JOB_VERIFY_ACTIVE:
374 return
375 b == UNIT_ACTIVE ||
376 b == UNIT_RELOADING;
377
378 case JOB_RELOAD:
379 return
380 b == UNIT_RELOADING;
381
382 case JOB_RESTART:
383 return
384 b == UNIT_ACTIVATING;
385
386 case JOB_NOP:
387 return true;
388
389 default:
390 assert_not_reached("Invalid job type");
391 }
392 }
393
394 JobType job_type_collapse(JobType t, Unit *u) {
395 UnitActiveState s;
396
397 switch (t) {
398
399 case JOB_TRY_RESTART:
400 s = unit_active_state(u);
401 if (UNIT_IS_INACTIVE_OR_DEACTIVATING(s))
402 return JOB_NOP;
403
404 return JOB_RESTART;
405
406 case JOB_TRY_RELOAD:
407 s = unit_active_state(u);
408 if (UNIT_IS_INACTIVE_OR_DEACTIVATING(s))
409 return JOB_NOP;
410
411 return JOB_RELOAD;
412
413 case JOB_RELOAD_OR_START:
414 s = unit_active_state(u);
415 if (UNIT_IS_INACTIVE_OR_DEACTIVATING(s))
416 return JOB_START;
417
418 return JOB_RELOAD;
419
420 default:
421 return t;
422 }
423 }
424
425 int job_type_merge_and_collapse(JobType *a, JobType b, Unit *u) {
426 JobType t;
427
428 t = job_type_lookup_merge(*a, b);
429 if (t < 0)
430 return -EEXIST;
431
432 *a = job_type_collapse(t, u);
433 return 0;
434 }
435
436 static bool job_is_runnable(Job *j) {
437 Iterator i;
438 Unit *other;
439
440 assert(j);
441 assert(j->installed);
442
443 /* Checks whether there is any job running for the units this
444 * job needs to be running after (in the case of a 'positive'
445 * job type) or before (in the case of a 'negative' job
446 * type. */
447
448 /* Note that unit types have a say in what is runnable,
449 * too. For example, if they return -EAGAIN from
450 * unit_start() they can indicate they are not
451 * runnable yet. */
452
453 /* First check if there is an override */
454 if (j->ignore_order)
455 return true;
456
457 if (j->type == JOB_NOP)
458 return true;
459
460 if (j->type == JOB_START ||
461 j->type == JOB_VERIFY_ACTIVE ||
462 j->type == JOB_RELOAD) {
463
464 /* Immediate result is that the job is or might be
465 * started. In this case let's wait for the
466 * dependencies, regardless whether they are
467 * starting or stopping something. */
468
469 SET_FOREACH(other, j->unit->dependencies[UNIT_AFTER], i)
470 if (other->job)
471 return false;
472 }
473
474 /* Also, if something else is being stopped and we should
475 * change state after it, then let's wait. */
476
477 SET_FOREACH(other, j->unit->dependencies[UNIT_BEFORE], i)
478 if (other->job &&
479 (other->job->type == JOB_STOP ||
480 other->job->type == JOB_RESTART))
481 return false;
482
483 /* This means that for a service a and a service b where b
484 * shall be started after a:
485 *
486 * start a + start b → 1st step start a, 2nd step start b
487 * start a + stop b → 1st step stop b, 2nd step start a
488 * stop a + start b → 1st step stop a, 2nd step start b
489 * stop a + stop b → 1st step stop b, 2nd step stop a
490 *
491 * This has the side effect that restarts are properly
492 * synchronized too. */
493
494 return true;
495 }
496
497 static void job_change_type(Job *j, JobType newtype) {
498 assert(j);
499
500 log_unit_debug(j->unit,
501 "Converting job %s/%s -> %s/%s",
502 j->unit->id, job_type_to_string(j->type),
503 j->unit->id, job_type_to_string(newtype));
504
505 j->type = newtype;
506 }
507
508 static int job_perform_on_unit(Job **j) {
509 uint32_t id;
510 Manager *m;
511 JobType t;
512 Unit *u;
513 int r;
514
515 /* While we execute this operation the job might go away (for
516 * example: because it finishes immediately or is replaced by
517 * a new, conflicting job.) To make sure we don't access a
518 * freed job later on we store the id here, so that we can
519 * verify the job is still valid. */
520
521 assert(j);
522 assert(*j);
523
524 m = (*j)->manager;
525 u = (*j)->unit;
526 t = (*j)->type;
527 id = (*j)->id;
528
529 switch (t) {
530 case JOB_START:
531 r = unit_start(u);
532 break;
533
534 case JOB_RESTART:
535 t = JOB_STOP;
536 /* fall through */
537 case JOB_STOP:
538 r = unit_stop(u);
539 break;
540
541 case JOB_RELOAD:
542 r = unit_reload(u);
543 break;
544
545 default:
546 assert_not_reached("Invalid job type");
547 }
548
549 /* Log if the job still exists and the start/stop/reload function
550 * actually did something. */
551 *j = manager_get_job(m, id);
552 if (*j && r > 0)
553 unit_status_emit_starting_stopping_reloading(u, t);
554
555 return r;
556 }
557
558 int job_run_and_invalidate(Job *j) {
559 int r;
560
561 assert(j);
562 assert(j->installed);
563 assert(j->type < _JOB_TYPE_MAX_IN_TRANSACTION);
564 assert(j->in_run_queue);
565
566 LIST_REMOVE(run_queue, j->manager->run_queue, j);
567 j->in_run_queue = false;
568
569 if (j->state != JOB_WAITING)
570 return 0;
571
572 if (!job_is_runnable(j))
573 return -EAGAIN;
574
575 job_set_state(j, JOB_RUNNING);
576 job_add_to_dbus_queue(j);
577
578
579 switch (j->type) {
580
581 case JOB_VERIFY_ACTIVE: {
582 UnitActiveState t = unit_active_state(j->unit);
583 if (UNIT_IS_ACTIVE_OR_RELOADING(t))
584 r = -EALREADY;
585 else if (t == UNIT_ACTIVATING)
586 r = -EAGAIN;
587 else
588 r = -EBADR;
589 break;
590 }
591
592 case JOB_START:
593 case JOB_STOP:
594 case JOB_RESTART:
595 r = job_perform_on_unit(&j);
596
597 /* If the unit type does not support starting/stopping,
598 * then simply wait. */
599 if (r == -EBADR)
600 r = 0;
601 break;
602
603 case JOB_RELOAD:
604 r = job_perform_on_unit(&j);
605 break;
606
607 case JOB_NOP:
608 r = -EALREADY;
609 break;
610
611 default:
612 assert_not_reached("Unknown job type");
613 }
614
615 if (j) {
616 if (r == -EALREADY)
617 r = job_finish_and_invalidate(j, JOB_DONE, true);
618 else if (r == -EBADR)
619 r = job_finish_and_invalidate(j, JOB_SKIPPED, true);
620 else if (r == -ENOEXEC)
621 r = job_finish_and_invalidate(j, JOB_INVALID, true);
622 else if (r == -EPROTO)
623 r = job_finish_and_invalidate(j, JOB_ASSERT, true);
624 else if (r == -EOPNOTSUPP)
625 r = job_finish_and_invalidate(j, JOB_UNSUPPORTED, true);
626 else if (r == -EAGAIN)
627 job_set_state(j, JOB_WAITING);
628 else if (r < 0)
629 r = job_finish_and_invalidate(j, JOB_FAILED, true);
630 }
631
632 return r;
633 }
634
635 _pure_ static const char *job_get_status_message_format(Unit *u, JobType t, JobResult result) {
636
637 static const char *const generic_finished_start_job[_JOB_RESULT_MAX] = {
638 [JOB_DONE] = "Started %s.",
639 [JOB_TIMEOUT] = "Timed out starting %s.",
640 [JOB_FAILED] = "Failed to start %s.",
641 [JOB_DEPENDENCY] = "Dependency failed for %s.",
642 [JOB_ASSERT] = "Assertion failed for %s.",
643 [JOB_UNSUPPORTED] = "Starting of %s not supported.",
644 };
645 static const char *const generic_finished_stop_job[_JOB_RESULT_MAX] = {
646 [JOB_DONE] = "Stopped %s.",
647 [JOB_FAILED] = "Stopped (with error) %s.",
648 [JOB_TIMEOUT] = "Timed out stoppping %s.",
649 };
650 static const char *const generic_finished_reload_job[_JOB_RESULT_MAX] = {
651 [JOB_DONE] = "Reloaded %s.",
652 [JOB_FAILED] = "Reload failed for %s.",
653 [JOB_TIMEOUT] = "Timed out reloading %s.",
654 };
655 /* When verify-active detects the unit is inactive, report it.
656 * Most likely a DEPEND warning from a requisiting unit will
657 * occur next and it's nice to see what was requisited. */
658 static const char *const generic_finished_verify_active_job[_JOB_RESULT_MAX] = {
659 [JOB_SKIPPED] = "%s is not active.",
660 };
661
662 const UnitStatusMessageFormats *format_table;
663 const char *format;
664
665 assert(u);
666 assert(t >= 0);
667 assert(t < _JOB_TYPE_MAX);
668
669 if (IN_SET(t, JOB_START, JOB_STOP, JOB_RESTART)) {
670 format_table = &UNIT_VTABLE(u)->status_message_formats;
671 if (format_table) {
672 format = t == JOB_START ? format_table->finished_start_job[result] :
673 format_table->finished_stop_job[result];
674 if (format)
675 return format;
676 }
677 }
678
679 /* Return generic strings */
680 if (t == JOB_START)
681 return generic_finished_start_job[result];
682 else if (t == JOB_STOP || t == JOB_RESTART)
683 return generic_finished_stop_job[result];
684 else if (t == JOB_RELOAD)
685 return generic_finished_reload_job[result];
686 else if (t == JOB_VERIFY_ACTIVE)
687 return generic_finished_verify_active_job[result];
688
689 return NULL;
690 }
691
692 static void job_print_status_message(Unit *u, JobType t, JobResult result) {
693 static const char* const job_result_status_table[_JOB_RESULT_MAX] = {
694 [JOB_DONE] = ANSI_GREEN " OK " ANSI_NORMAL,
695 [JOB_TIMEOUT] = ANSI_HIGHLIGHT_RED " TIME " ANSI_NORMAL,
696 [JOB_FAILED] = ANSI_HIGHLIGHT_RED "FAILED" ANSI_NORMAL,
697 [JOB_DEPENDENCY] = ANSI_HIGHLIGHT_YELLOW "DEPEND" ANSI_NORMAL,
698 [JOB_SKIPPED] = ANSI_HIGHLIGHT " INFO " ANSI_NORMAL,
699 [JOB_ASSERT] = ANSI_HIGHLIGHT_YELLOW "ASSERT" ANSI_NORMAL,
700 [JOB_UNSUPPORTED] = ANSI_HIGHLIGHT_YELLOW "UNSUPP" ANSI_NORMAL,
701 };
702
703 const char *format;
704
705 assert(u);
706 assert(t >= 0);
707 assert(t < _JOB_TYPE_MAX);
708
709 /* Reload status messages have traditionally not been printed to console. */
710 if (t == JOB_RELOAD)
711 return;
712
713 format = job_get_status_message_format(u, t, result);
714 if (!format)
715 return;
716
717 if (result != JOB_DONE)
718 manager_flip_auto_status(u->manager, true);
719
720 DISABLE_WARNING_FORMAT_NONLITERAL;
721 unit_status_printf(u, job_result_status_table[result], format);
722 REENABLE_WARNING;
723
724 if (t == JOB_START && result == JOB_FAILED) {
725 _cleanup_free_ char *quoted;
726
727 quoted = shell_maybe_quote(u->id);
728 manager_status_printf(u->manager, STATUS_TYPE_NORMAL, NULL, "See 'systemctl status %s' for details.", strna(quoted));
729 }
730 }
731
732 static void job_log_status_message(Unit *u, JobType t, JobResult result) {
733 const char *format;
734 char buf[LINE_MAX];
735 sd_id128_t mid;
736 static const int job_result_log_level[_JOB_RESULT_MAX] = {
737 [JOB_DONE] = LOG_INFO,
738 [JOB_CANCELED] = LOG_INFO,
739 [JOB_TIMEOUT] = LOG_ERR,
740 [JOB_FAILED] = LOG_ERR,
741 [JOB_DEPENDENCY] = LOG_WARNING,
742 [JOB_SKIPPED] = LOG_NOTICE,
743 [JOB_INVALID] = LOG_INFO,
744 [JOB_ASSERT] = LOG_WARNING,
745 [JOB_UNSUPPORTED] = LOG_WARNING,
746 };
747
748 assert(u);
749 assert(t >= 0);
750 assert(t < _JOB_TYPE_MAX);
751
752 /* Skip this if it goes to the console. since we already print
753 * to the console anyway... */
754
755 if (log_on_console())
756 return;
757
758 format = job_get_status_message_format(u, t, result);
759 if (!format)
760 return;
761
762 DISABLE_WARNING_FORMAT_NONLITERAL;
763 xsprintf(buf, format, unit_description(u));
764 REENABLE_WARNING;
765
766 switch (t) {
767
768 case JOB_START:
769 mid = result == JOB_DONE ? SD_MESSAGE_UNIT_STARTED : SD_MESSAGE_UNIT_FAILED;
770 break;
771
772 case JOB_RELOAD:
773 mid = SD_MESSAGE_UNIT_RELOADED;
774 break;
775
776 case JOB_STOP:
777 case JOB_RESTART:
778 mid = SD_MESSAGE_UNIT_STOPPED;
779 break;
780
781 default:
782 log_struct(job_result_log_level[result],
783 LOG_UNIT_ID(u),
784 LOG_MESSAGE("%s", buf),
785 "RESULT=%s", job_result_to_string(result),
786 NULL);
787 return;
788 }
789
790 log_struct(job_result_log_level[result],
791 LOG_MESSAGE_ID(mid),
792 LOG_UNIT_ID(u),
793 LOG_MESSAGE("%s", buf),
794 "RESULT=%s", job_result_to_string(result),
795 NULL);
796 }
797
798 static void job_emit_status_message(Unit *u, JobType t, JobResult result) {
799
800 /* No message if the job did not actually do anything due to failed condition. */
801 if (t == JOB_START && result == JOB_DONE && !u->condition_result)
802 return;
803
804 job_log_status_message(u, t, result);
805 job_print_status_message(u, t, result);
806 }
807
808 static void job_fail_dependencies(Unit *u, UnitDependency d) {
809 Unit *other;
810 Iterator i;
811
812 assert(u);
813
814 SET_FOREACH(other, u->dependencies[d], i) {
815 Job *j = other->job;
816
817 if (!j)
818 continue;
819 if (!IN_SET(j->type, JOB_START, JOB_VERIFY_ACTIVE))
820 continue;
821
822 job_finish_and_invalidate(j, JOB_DEPENDENCY, true);
823 }
824 }
825
826 int job_finish_and_invalidate(Job *j, JobResult result, bool recursive) {
827 Unit *u;
828 Unit *other;
829 JobType t;
830 Iterator i;
831
832 assert(j);
833 assert(j->installed);
834 assert(j->type < _JOB_TYPE_MAX_IN_TRANSACTION);
835
836 u = j->unit;
837 t = j->type;
838
839 j->result = result;
840
841 log_unit_debug(u, "Job %s/%s finished, result=%s", u->id, job_type_to_string(t), job_result_to_string(result));
842
843 job_emit_status_message(u, t, result);
844
845 job_add_to_dbus_queue(j);
846
847 /* Patch restart jobs so that they become normal start jobs */
848 if (result == JOB_DONE && t == JOB_RESTART) {
849
850 job_change_type(j, JOB_START);
851 job_set_state(j, JOB_WAITING);
852
853 job_add_to_run_queue(j);
854
855 goto finish;
856 }
857
858 if (result == JOB_FAILED || result == JOB_INVALID)
859 j->manager->n_failed_jobs++;
860
861 job_uninstall(j);
862 job_free(j);
863
864 /* Fail depending jobs on failure */
865 if (result != JOB_DONE && recursive) {
866 if (IN_SET(t, JOB_START, JOB_VERIFY_ACTIVE)) {
867 job_fail_dependencies(u, UNIT_REQUIRED_BY);
868 job_fail_dependencies(u, UNIT_REQUISITE_OF);
869 job_fail_dependencies(u, UNIT_BOUND_BY);
870 } else if (t == JOB_STOP)
871 job_fail_dependencies(u, UNIT_CONFLICTED_BY);
872 }
873
874 /* Trigger OnFailure dependencies that are not generated by
875 * the unit itself. We don't treat JOB_CANCELED as failure in
876 * this context. And JOB_FAILURE is already handled by the
877 * unit itself. */
878 if (result == JOB_TIMEOUT || result == JOB_DEPENDENCY) {
879 log_struct(LOG_NOTICE,
880 "JOB_TYPE=%s", job_type_to_string(t),
881 "JOB_RESULT=%s", job_result_to_string(result),
882 LOG_UNIT_ID(u),
883 LOG_UNIT_MESSAGE(u, "Job %s/%s failed with result '%s'.",
884 u->id,
885 job_type_to_string(t),
886 job_result_to_string(result)),
887 NULL);
888
889 unit_start_on_failure(u);
890 }
891
892 unit_trigger_notify(u);
893
894 finish:
895 /* Try to start the next jobs that can be started */
896 SET_FOREACH(other, u->dependencies[UNIT_AFTER], i)
897 if (other->job)
898 job_add_to_run_queue(other->job);
899 SET_FOREACH(other, u->dependencies[UNIT_BEFORE], i)
900 if (other->job)
901 job_add_to_run_queue(other->job);
902
903 manager_check_finished(u->manager);
904
905 return 0;
906 }
907
908 static int job_dispatch_timer(sd_event_source *s, uint64_t monotonic, void *userdata) {
909 Job *j = userdata;
910 Unit *u;
911
912 assert(j);
913 assert(s == j->timer_event_source);
914
915 log_unit_warning(j->unit, "Job %s/%s timed out.", j->unit->id, job_type_to_string(j->type));
916
917 u = j->unit;
918 job_finish_and_invalidate(j, JOB_TIMEOUT, true);
919
920 failure_action(u->manager, u->job_timeout_action, u->job_timeout_reboot_arg);
921
922 return 0;
923 }
924
925 int job_start_timer(Job *j) {
926 int r;
927
928 if (j->timer_event_source)
929 return 0;
930
931 j->begin_usec = now(CLOCK_MONOTONIC);
932
933 if (j->unit->job_timeout == USEC_INFINITY)
934 return 0;
935
936 r = sd_event_add_time(
937 j->manager->event,
938 &j->timer_event_source,
939 CLOCK_MONOTONIC,
940 usec_add(j->begin_usec, j->unit->job_timeout), 0,
941 job_dispatch_timer, j);
942 if (r < 0)
943 return r;
944
945 (void) sd_event_source_set_description(j->timer_event_source, "job-start");
946
947 return 0;
948 }
949
950 void job_add_to_run_queue(Job *j) {
951 assert(j);
952 assert(j->installed);
953
954 if (j->in_run_queue)
955 return;
956
957 if (!j->manager->run_queue)
958 sd_event_source_set_enabled(j->manager->run_queue_event_source, SD_EVENT_ONESHOT);
959
960 LIST_PREPEND(run_queue, j->manager->run_queue, j);
961 j->in_run_queue = true;
962 }
963
964 void job_add_to_dbus_queue(Job *j) {
965 assert(j);
966 assert(j->installed);
967
968 if (j->in_dbus_queue)
969 return;
970
971 /* We don't check if anybody is subscribed here, since this
972 * job might just have been created and not yet assigned to a
973 * connection/client. */
974
975 LIST_PREPEND(dbus_queue, j->manager->dbus_job_queue, j);
976 j->in_dbus_queue = true;
977 }
978
979 char *job_dbus_path(Job *j) {
980 char *p;
981
982 assert(j);
983
984 if (asprintf(&p, "/org/freedesktop/systemd1/job/%"PRIu32, j->id) < 0)
985 return NULL;
986
987 return p;
988 }
989
990 int job_serialize(Job *j, FILE *f, FDSet *fds) {
991 fprintf(f, "job-id=%u\n", j->id);
992 fprintf(f, "job-type=%s\n", job_type_to_string(j->type));
993 fprintf(f, "job-state=%s\n", job_state_to_string(j->state));
994 fprintf(f, "job-irreversible=%s\n", yes_no(j->irreversible));
995 fprintf(f, "job-sent-dbus-new-signal=%s\n", yes_no(j->sent_dbus_new_signal));
996 fprintf(f, "job-ignore-order=%s\n", yes_no(j->ignore_order));
997
998 if (j->begin_usec > 0)
999 fprintf(f, "job-begin="USEC_FMT"\n", j->begin_usec);
1000
1001 bus_track_serialize(j->clients, f);
1002
1003 /* End marker */
1004 fputc('\n', f);
1005 return 0;
1006 }
1007
1008 int job_deserialize(Job *j, FILE *f, FDSet *fds) {
1009 assert(j);
1010
1011 for (;;) {
1012 char line[LINE_MAX], *l, *v;
1013 size_t k;
1014
1015 if (!fgets(line, sizeof(line), f)) {
1016 if (feof(f))
1017 return 0;
1018 return -errno;
1019 }
1020
1021 char_array_0(line);
1022 l = strstrip(line);
1023
1024 /* End marker */
1025 if (l[0] == 0)
1026 return 0;
1027
1028 k = strcspn(l, "=");
1029
1030 if (l[k] == '=') {
1031 l[k] = 0;
1032 v = l+k+1;
1033 } else
1034 v = l+k;
1035
1036 if (streq(l, "job-id")) {
1037
1038 if (safe_atou32(v, &j->id) < 0)
1039 log_debug("Failed to parse job id value %s", v);
1040
1041 } else if (streq(l, "job-type")) {
1042 JobType t;
1043
1044 t = job_type_from_string(v);
1045 if (t < 0)
1046 log_debug("Failed to parse job type %s", v);
1047 else if (t >= _JOB_TYPE_MAX_IN_TRANSACTION)
1048 log_debug("Cannot deserialize job of type %s", v);
1049 else
1050 j->type = t;
1051
1052 } else if (streq(l, "job-state")) {
1053 JobState s;
1054
1055 s = job_state_from_string(v);
1056 if (s < 0)
1057 log_debug("Failed to parse job state %s", v);
1058 else
1059 job_set_state(j, s);
1060
1061 } else if (streq(l, "job-irreversible")) {
1062 int b;
1063
1064 b = parse_boolean(v);
1065 if (b < 0)
1066 log_debug("Failed to parse job irreversible flag %s", v);
1067 else
1068 j->irreversible = j->irreversible || b;
1069
1070 } else if (streq(l, "job-sent-dbus-new-signal")) {
1071 int b;
1072
1073 b = parse_boolean(v);
1074 if (b < 0)
1075 log_debug("Failed to parse job sent_dbus_new_signal flag %s", v);
1076 else
1077 j->sent_dbus_new_signal = j->sent_dbus_new_signal || b;
1078
1079 } else if (streq(l, "job-ignore-order")) {
1080 int b;
1081
1082 b = parse_boolean(v);
1083 if (b < 0)
1084 log_debug("Failed to parse job ignore_order flag %s", v);
1085 else
1086 j->ignore_order = j->ignore_order || b;
1087
1088 } else if (streq(l, "job-begin")) {
1089 unsigned long long ull;
1090
1091 if (sscanf(v, "%llu", &ull) != 1)
1092 log_debug("Failed to parse job-begin value %s", v);
1093 else
1094 j->begin_usec = ull;
1095
1096 } else if (streq(l, "subscribed")) {
1097
1098 if (strv_extend(&j->deserialized_clients, v) < 0)
1099 return log_oom();
1100 }
1101 }
1102 }
1103
1104 int job_coldplug(Job *j) {
1105 int r;
1106
1107 assert(j);
1108
1109 /* After deserialization is complete and the bus connection
1110 * set up again, let's start watching our subscribers again */
1111 r = bus_track_coldplug(j->manager, &j->clients, &j->deserialized_clients);
1112 if (r < 0)
1113 return r;
1114
1115 if (j->state == JOB_WAITING)
1116 job_add_to_run_queue(j);
1117
1118 if (j->begin_usec == 0 || j->unit->job_timeout == USEC_INFINITY)
1119 return 0;
1120
1121 j->timer_event_source = sd_event_source_unref(j->timer_event_source);
1122
1123 r = sd_event_add_time(
1124 j->manager->event,
1125 &j->timer_event_source,
1126 CLOCK_MONOTONIC,
1127 usec_add(j->begin_usec, j->unit->job_timeout), 0,
1128 job_dispatch_timer, j);
1129 if (r < 0)
1130 log_debug_errno(r, "Failed to restart timeout for job: %m");
1131
1132 (void) sd_event_source_set_description(j->timer_event_source, "job-timeout");
1133
1134 return r;
1135 }
1136
1137 void job_shutdown_magic(Job *j) {
1138 assert(j);
1139
1140 /* The shutdown target gets some special treatment here: we
1141 * tell the kernel to begin with flushing its disk caches, to
1142 * optimize shutdown time a bit. Ideally we wouldn't hardcode
1143 * this magic into PID 1. However all other processes aren't
1144 * options either since they'd exit much sooner than PID 1 and
1145 * asynchronous sync() would cause their exit to be
1146 * delayed. */
1147
1148 if (j->type != JOB_START)
1149 return;
1150
1151 if (j->unit->manager->running_as != MANAGER_SYSTEM)
1152 return;
1153
1154 if (!unit_has_name(j->unit, SPECIAL_SHUTDOWN_TARGET))
1155 return;
1156
1157 /* In case messages on console has been disabled on boot */
1158 j->unit->manager->no_console_output = false;
1159
1160 if (detect_container() > 0)
1161 return;
1162
1163 asynchronous_sync();
1164 }
1165
1166 int job_get_timeout(Job *j, usec_t *timeout) {
1167 usec_t x = USEC_INFINITY, y = USEC_INFINITY;
1168 Unit *u = j->unit;
1169 int r;
1170
1171 assert(u);
1172
1173 if (j->timer_event_source) {
1174 r = sd_event_source_get_time(j->timer_event_source, &x);
1175 if (r < 0)
1176 return r;
1177 }
1178
1179 if (UNIT_VTABLE(u)->get_timeout) {
1180 r = UNIT_VTABLE(u)->get_timeout(u, &y);
1181 if (r < 0)
1182 return r;
1183 }
1184
1185 if (x == USEC_INFINITY && y == USEC_INFINITY)
1186 return 0;
1187
1188 *timeout = MIN(x, y);
1189 return 1;
1190 }
1191
1192 static const char* const job_state_table[_JOB_STATE_MAX] = {
1193 [JOB_WAITING] = "waiting",
1194 [JOB_RUNNING] = "running"
1195 };
1196
1197 DEFINE_STRING_TABLE_LOOKUP(job_state, JobState);
1198
1199 static const char* const job_type_table[_JOB_TYPE_MAX] = {
1200 [JOB_START] = "start",
1201 [JOB_VERIFY_ACTIVE] = "verify-active",
1202 [JOB_STOP] = "stop",
1203 [JOB_RELOAD] = "reload",
1204 [JOB_RELOAD_OR_START] = "reload-or-start",
1205 [JOB_RESTART] = "restart",
1206 [JOB_TRY_RESTART] = "try-restart",
1207 [JOB_TRY_RELOAD] = "try-reload",
1208 [JOB_NOP] = "nop",
1209 };
1210
1211 DEFINE_STRING_TABLE_LOOKUP(job_type, JobType);
1212
1213 static const char* const job_mode_table[_JOB_MODE_MAX] = {
1214 [JOB_FAIL] = "fail",
1215 [JOB_REPLACE] = "replace",
1216 [JOB_REPLACE_IRREVERSIBLY] = "replace-irreversibly",
1217 [JOB_ISOLATE] = "isolate",
1218 [JOB_FLUSH] = "flush",
1219 [JOB_IGNORE_DEPENDENCIES] = "ignore-dependencies",
1220 [JOB_IGNORE_REQUIREMENTS] = "ignore-requirements",
1221 };
1222
1223 DEFINE_STRING_TABLE_LOOKUP(job_mode, JobMode);
1224
1225 static const char* const job_result_table[_JOB_RESULT_MAX] = {
1226 [JOB_DONE] = "done",
1227 [JOB_CANCELED] = "canceled",
1228 [JOB_TIMEOUT] = "timeout",
1229 [JOB_FAILED] = "failed",
1230 [JOB_DEPENDENCY] = "dependency",
1231 [JOB_SKIPPED] = "skipped",
1232 [JOB_INVALID] = "invalid",
1233 [JOB_ASSERT] = "assert",
1234 [JOB_UNSUPPORTED] = "unsupported",
1235 };
1236
1237 DEFINE_STRING_TABLE_LOOKUP(job_result, JobResult);
1238
1239 const char* job_type_to_access_method(JobType t) {
1240 assert(t >= 0);
1241 assert(t < _JOB_TYPE_MAX);
1242
1243 if (IN_SET(t, JOB_START, JOB_RESTART, JOB_TRY_RESTART))
1244 return "start";
1245 else if (t == JOB_STOP)
1246 return "stop";
1247 else
1248 return "reload";
1249 }
Unnamed repository; edit this file 'description' to name the repository.