]> git.ipfire.org Git - thirdparty/systemd.git/blame - src/core/transaction.c
coccinelle: add a transformation for GNU conditionals
[thirdparty/systemd.git] / src / core / transaction.c
CommitLineData
db9ecf05 1/* SPDX-License-Identifier: LGPL-2.1-or-later */
7c0436b9 2
f2b68789 3#include <fcntl.h>
cf0fbc49 4#include <unistd.h>
f2b68789 5
b5efdb8a 6#include "alloc-util.h"
96aad8d1 7#include "bus-common-errors.h"
718db961 8#include "bus-error.h"
5cfa33e0
ZJS
9#include "dbus-unit.h"
10#include "strv.h"
288a74cc 11#include "terminal-util.h"
b5efdb8a 12#include "transaction.h"
75778e21
MS
13
14static void transaction_unlink_job(Transaction *tr, Job *j, bool delete_dependencies);
15
16static void transaction_delete_job(Transaction *tr, Job *j, bool delete_dependencies) {
17 assert(tr);
18 assert(j);
19
20 /* Deletes one job from the transaction */
21
22 transaction_unlink_job(tr, j, delete_dependencies);
23
d6a093d0 24 job_free(j);
75778e21
MS
25}
26
27static void transaction_delete_unit(Transaction *tr, Unit *u) {
28 Job *j;
29
30 /* Deletes all jobs associated with a certain unit from the
31 * transaction */
32
33 while ((j = hashmap_get(tr->jobs, u)))
34 transaction_delete_job(tr, j, true);
35}
36
37void transaction_abort(Transaction *tr) {
38 Job *j;
39
40 assert(tr);
41
42 while ((j = hashmap_first(tr->jobs)))
1b9cea0c 43 transaction_delete_job(tr, j, false);
75778e21
MS
44
45 assert(hashmap_isempty(tr->jobs));
75778e21
MS
46}
47
0d9989aa 48static void transaction_find_jobs_that_matter_to_anchor(Job *j, unsigned generation) {
03677889 49 assert(j);
75778e21 50
75778e21
MS
51 /* A recursive sweep through the graph that marks all units
52 * that matter to the anchor job, i.e. are directly or
53 * indirectly a dependency of the anchor job via paths that
54 * are fully marked as mattering. */
55
0d9989aa
MS
56 j->matters_to_anchor = true;
57 j->generation = generation;
75778e21 58
0d9989aa 59 LIST_FOREACH(subject, l, j->subject_list) {
75778e21
MS
60
61 /* This link does not matter */
62 if (!l->matters)
63 continue;
64
65 /* This unit has already been marked */
66 if (l->object->generation == generation)
67 continue;
68
0d9989aa 69 transaction_find_jobs_that_matter_to_anchor(l->object, generation);
75778e21
MS
70 }
71}
72
73static void transaction_merge_and_delete_job(Transaction *tr, Job *j, Job *other, JobType t) {
03677889 74 JobDependency *last;
75778e21
MS
75
76 assert(j);
77 assert(other);
78 assert(j->unit == other->unit);
79 assert(!j->installed);
80
81 /* Merges 'other' into 'j' and then deletes 'other'. */
82
83 j->type = t;
84 j->state = JOB_WAITING;
23ade460 85 j->irreversible = j->irreversible || other->irreversible;
75778e21
MS
86 j->matters_to_anchor = j->matters_to_anchor || other->matters_to_anchor;
87
88 /* Patch us in as new owner of the JobDependency objects */
89 last = NULL;
90 LIST_FOREACH(subject, l, other->subject_list) {
91 assert(l->subject == other);
92 l->subject = j;
93 last = l;
94 }
95
96 /* Merge both lists */
97 if (last) {
98 last->subject_next = j->subject_list;
99 if (j->subject_list)
100 j->subject_list->subject_prev = last;
101 j->subject_list = other->subject_list;
102 }
103
104 /* Patch us in as new owner of the JobDependency objects */
105 last = NULL;
106 LIST_FOREACH(object, l, other->object_list) {
107 assert(l->object == other);
108 l->object = j;
109 last = l;
110 }
111
112 /* Merge both lists */
113 if (last) {
114 last->object_next = j->object_list;
115 if (j->object_list)
116 j->object_list->object_prev = last;
117 j->object_list = other->object_list;
118 }
119
120 /* Kill the other job */
121 other->subject_list = NULL;
122 other->object_list = NULL;
123 transaction_delete_job(tr, other, true);
124}
125
44a6b1b6 126_pure_ static bool job_is_conflicted_by(Job *j) {
75778e21
MS
127 assert(j);
128
129 /* Returns true if this job is pulled in by a least one
130 * ConflictedBy dependency. */
131
132 LIST_FOREACH(object, l, j->object_list)
133 if (l->conflicts)
134 return true;
135
136 return false;
137}
138
03677889
YW
139static int delete_one_unmergeable_job(Transaction *tr, Job *job) {
140 assert(job);
75778e21
MS
141
142 /* Tries to delete one item in the linked list
143 * j->transaction_next->transaction_next->... that conflicts
144 * with another one, in an attempt to make an inconsistent
145 * transaction work. */
146
147 /* We rely here on the fact that if a merged with b does not
148 * merge with c, either a or b merge with c neither */
03677889 149 LIST_FOREACH(transaction, j, job)
75778e21
MS
150 LIST_FOREACH(transaction, k, j->transaction_next) {
151 Job *d;
152
153 /* Is this one mergeable? Then skip it */
154 if (job_type_is_mergeable(j->type, k->type))
155 continue;
156
157 /* Ok, we found two that conflict, let's see if we can
158 * drop one of them */
159 if (!j->matters_to_anchor && !k->matters_to_anchor) {
160
161 /* Both jobs don't matter, so let's
162 * find the one that is smarter to
163 * remove. Let's think positive and
164 * rather remove stops then starts --
165 * except if something is being
166 * stopped because it is conflicted by
167 * another unit in which case we
168 * rather remove the start. */
169
f2341e0a 170 log_unit_debug(j->unit,
66870f90
ZJS
171 "Looking at job %s/%s conflicted_by=%s",
172 j->unit->id, job_type_to_string(j->type),
173 yes_no(j->type == JOB_STOP && job_is_conflicted_by(j)));
f2341e0a 174 log_unit_debug(k->unit,
66870f90
ZJS
175 "Looking at job %s/%s conflicted_by=%s",
176 k->unit->id, job_type_to_string(k->type),
177 yes_no(k->type == JOB_STOP && job_is_conflicted_by(k)));
75778e21
MS
178
179 if (j->type == JOB_STOP) {
180
181 if (job_is_conflicted_by(j))
182 d = k;
183 else
184 d = j;
185
186 } else if (k->type == JOB_STOP) {
187
188 if (job_is_conflicted_by(k))
189 d = j;
190 else
191 d = k;
192 } else
193 d = j;
194
195 } else if (!j->matters_to_anchor)
196 d = j;
197 else if (!k->matters_to_anchor)
198 d = k;
199 else
200 return -ENOEXEC;
201
202 /* Ok, we can drop one, so let's do so. */
f2341e0a 203 log_unit_debug(d->unit,
75cb8502
ZJS
204 "Fixing conflicting jobs %s/%s,%s/%s by deleting job %s/%s",
205 j->unit->id, job_type_to_string(j->type),
206 k->unit->id, job_type_to_string(k->type),
66870f90 207 d->unit->id, job_type_to_string(d->type));
75778e21
MS
208 transaction_delete_job(tr, d, true);
209 return 0;
210 }
211
212 return -EINVAL;
213}
214
718db961 215static int transaction_merge_jobs(Transaction *tr, sd_bus_error *e) {
75778e21 216 Job *j;
75778e21
MS
217 int r;
218
219 assert(tr);
220
221 /* First step, check whether any of the jobs for one specific
222 * task conflict. If so, try to drop one of them. */
90e74a66 223 HASHMAP_FOREACH(j, tr->jobs) {
75778e21 224 JobType t;
75778e21
MS
225
226 t = j->type;
227 LIST_FOREACH(transaction, k, j->transaction_next) {
e0209d83 228 if (job_type_merge_and_collapse(&t, k->type, j->unit) >= 0)
75778e21
MS
229 continue;
230
231 /* OK, we could not merge all jobs for this
232 * action. Let's see if we can get rid of one
233 * of them */
234
235 r = delete_one_unmergeable_job(tr, j);
236 if (r >= 0)
237 /* Ok, we managed to drop one, now
238 * let's ask our callers to call us
239 * again after garbage collecting */
240 return -EAGAIN;
241
242 /* We couldn't merge anything. Failure */
7358dc02
ZJS
243 return sd_bus_error_setf(e, BUS_ERROR_TRANSACTION_JOBS_CONFLICTING,
244 "Transaction contains conflicting jobs '%s' and '%s' for %s. "
245 "Probably contradicting requirement dependencies configured.",
246 job_type_to_string(t),
247 job_type_to_string(k->type),
248 k->unit->id);
75778e21
MS
249 }
250 }
251
252 /* Second step, merge the jobs. */
90e74a66 253 HASHMAP_FOREACH(j, tr->jobs) {
75778e21 254 JobType t = j->type;
75778e21 255
e0209d83 256 /* Merge all transaction jobs for j->unit */
75778e21 257 LIST_FOREACH(transaction, k, j->transaction_next)
e0209d83 258 assert_se(job_type_merge_and_collapse(&t, k->type, j->unit) == 0);
75778e21 259
03677889 260 Job *k;
75778e21 261 while ((k = j->transaction_next)) {
656bbffc 262 if (tr->anchor_job == k) {
75778e21
MS
263 transaction_merge_and_delete_job(tr, k, j, t);
264 j = k;
265 } else
266 transaction_merge_and_delete_job(tr, j, k, t);
267 }
268
75778e21
MS
269 assert(!j->transaction_next);
270 assert(!j->transaction_prev);
271 }
272
273 return 0;
274}
275
cc479760 276static void transaction_drop_redundant(Transaction *tr) {
ca006fc6 277 bool again;
75778e21 278
ca006fc6
LP
279 /* Goes through the transaction and removes all jobs of the units whose jobs are all noops. If not
280 * all of a unit's jobs are redundant, they are kept. */
75778e21 281
055163ad 282 assert(tr);
75778e21 283
ca006fc6 284 do {
ca006fc6
LP
285 Job *j;
286
287 again = false;
288
90e74a66 289 HASHMAP_FOREACH(j, tr->jobs) {
ca006fc6 290 bool keep = false;
ca006fc6
LP
291
292 LIST_FOREACH(transaction, k, j)
293 if (tr->anchor_job == k ||
cc479760 294 !job_type_is_redundant(k->type, unit_active_state(k->unit)) ||
ca006fc6
LP
295 (k->unit->job && job_type_is_conflicting(k->type, k->unit->job->type))) {
296 keep = true;
297 break;
298 }
299
300 if (!keep) {
301 log_trace("Found redundant job %s/%s, dropping from transaction.",
302 j->unit->id, job_type_to_string(j->type));
303 transaction_delete_job(tr, j, false);
304 again = true;
305 break;
306 }
75778e21 307 }
ca006fc6 308 } while (again);
75778e21
MS
309}
310
03677889 311_pure_ static bool unit_matters_to_anchor(Unit *u, Job *job) {
75778e21 312 assert(u);
03677889
YW
313 assert(job);
314 assert(!job->transaction_prev);
75778e21
MS
315
316 /* Checks whether at least one of the jobs for this unit
317 * matters to the anchor. */
318
03677889 319 LIST_FOREACH(transaction, j, job)
75778e21
MS
320 if (j->matters_to_anchor)
321 return true;
322
323 return false;
324}
325
924775e8 326static char* merge_unit_ids(const char* unit_log_field, char **pairs) {
de010b0b 327 char *ans = NULL;
319a4f4b 328 size_t size = 0, next;
924775e8
ZJS
329
330 STRV_FOREACH_PAIR(unit_id, job_type, pairs) {
331 next = strlen(unit_log_field) + strlen(*unit_id);
319a4f4b 332 if (!GREEDY_REALLOC(ans, size + next + 1))
5fecf46d 333 return mfree(ans);
924775e8
ZJS
334
335 sprintf(ans + size, "%s%s", unit_log_field, *unit_id);
336 if (*(unit_id+1))
337 ans[size + next] = '\n';
338 size += next + 1;
339 }
340
341 return ans;
342}
343
718db961 344static int transaction_verify_order_one(Transaction *tr, Job *j, Job *from, unsigned generation, sd_bus_error *e) {
15ed3c3a
LP
345
346 static const UnitDependencyAtom directions[] = {
347 UNIT_ATOM_BEFORE,
348 UNIT_ATOM_AFTER,
dfd79eca 349 };
15ed3c3a
LP
350
351 int r;
75778e21
MS
352
353 assert(tr);
354 assert(j);
355 assert(!j->transaction_prev);
356
defe63b0
LP
357 /* Does a recursive sweep through the ordering graph, looking for a cycle. If we find a cycle we try
358 * to break it. */
75778e21
MS
359
360 /* Have we seen this before? */
361 if (j->generation == generation) {
924775e8
ZJS
362 Job *k, *delete = NULL;
363 _cleanup_free_ char **array = NULL, *unit_ids = NULL;
75778e21 364
defe63b0
LP
365 /* If the marker is NULL we have been here already and decided the job was loop-free from
366 * here. Hence shortcut things and return right-away. */
75778e21
MS
367 if (!j->marker)
368 return 0;
369
defe63b0
LP
370 /* So, the marker is not NULL and we already have been here. We have a cycle. Let's try to
371 * break it. We go backwards in our path and try to find a suitable job to remove. We use the
372 * marker to find our way back, since smart how we are we stored our way back in there. */
75778e21
MS
373 for (k = from; k; k = ((k->generation == generation && k->marker != k) ? k->marker : NULL)) {
374
924775e8
ZJS
375 /* For logging below */
376 if (strv_push_pair(&array, k->unit->id, (char*) job_type_to_string(k->type)) < 0)
377 log_oom();
75778e21 378
ece174c5 379 if (!delete && hashmap_get(tr->jobs, k->unit) && !unit_matters_to_anchor(k->unit, k))
924775e8 380 /* Ok, we can drop this one, so let's do so. */
75778e21 381 delete = k;
75778e21 382
924775e8 383 /* Check if this in fact was the beginning of the cycle */
75778e21
MS
384 if (k == j)
385 break;
386 }
387
924775e8
ZJS
388 unit_ids = merge_unit_ids(j->manager->unit_log_field, array); /* ignore error */
389
390 STRV_FOREACH_PAIR(unit_id, job_type, array)
391 /* logging for j not k here to provide a consistent narrative */
392 log_struct(LOG_WARNING,
f66020ab
ZJS
393 LOG_UNIT_MESSAGE(j->unit,
394 "Found %s on %s/%s",
395 unit_id == array ? "ordering cycle" : "dependency",
396 *unit_id, *job_type),
7325a2b2 397 "%s", unit_ids);
75778e21
MS
398
399 if (delete) {
dc9b5816 400 const char *status;
924775e8
ZJS
401 /* logging for j not k here to provide a consistent narrative */
402 log_struct(LOG_ERR,
f66020ab
ZJS
403 LOG_UNIT_MESSAGE(j->unit,
404 "Job %s/%s deleted to break ordering cycle starting with %s/%s",
405 delete->unit->id, job_type_to_string(delete->type),
406 j->unit->id, job_type_to_string(j->type)),
7325a2b2 407 "%s", unit_ids);
dc9b5816
ZJS
408
409 if (log_get_show_color())
410 status = ANSI_HIGHLIGHT_RED " SKIP " ANSI_NORMAL;
411 else
412 status = " SKIP ";
413
5bcf34eb
ZJS
414 unit_status_printf(delete->unit,
415 STATUS_TYPE_NOTICE,
416 status,
04d232d8
ZJS
417 "Ordering cycle found, skipping %s",
418 unit_status_string(delete->unit, NULL));
75778e21
MS
419 transaction_delete_unit(tr, delete->unit);
420 return -EAGAIN;
421 }
422
924775e8 423 log_struct(LOG_ERR,
f66020ab
ZJS
424 LOG_UNIT_MESSAGE(j->unit, "Unable to break cycle starting with %s/%s",
425 j->unit->id, job_type_to_string(j->type)),
7325a2b2 426 "%s", unit_ids);
75778e21 427
7358dc02
ZJS
428 return sd_bus_error_setf(e, BUS_ERROR_TRANSACTION_ORDER_IS_CYCLIC,
429 "Transaction order is cyclic. See system logs for details.");
75778e21
MS
430 }
431
432 /* Make the marker point to where we come from, so that we can
433 * find our way backwards if we want to break a cycle. We use
434 * a special marker for the beginning: we point to
435 * ourselves. */
436 j->marker = from ? from : j;
437 j->generation = generation;
438
dfd79eca
MK
439 /* Actual ordering of jobs depends on the unit ordering dependency and job types. We need to traverse
440 * the graph over 'before' edges in the actual job execution order. We traverse over both unit
441 * ordering dependencies and we test with job_compare() whether it is the 'before' edge in the job
442 * execution ordering. */
15ed3c3a
LP
443 for (size_t d = 0; d < ELEMENTSOF(directions); d++) {
444 Unit *u;
445
446 UNIT_FOREACH_DEPENDENCY(u, j->unit, directions[d]) {
dfd79eca
MK
447 Job *o;
448
449 /* Is there a job for this unit? */
450 o = hashmap_get(tr->jobs, u);
451 if (!o) {
defe63b0
LP
452 /* Ok, there is no job for this in the transaction, but maybe there is
453 * already one running? */
dfd79eca
MK
454 o = u->job;
455 if (!o)
456 continue;
457 }
458
459 /* Cut traversing if the job j is not really *before* o. */
460 if (job_compare(j, o, directions[d]) >= 0)
75778e21 461 continue;
75778e21 462
dfd79eca
MK
463 r = transaction_verify_order_one(tr, o, j, generation, e);
464 if (r < 0)
465 return r;
466 }
75778e21
MS
467 }
468
469 /* Ok, let's backtrack, and remember that this entry is not on
470 * our path anymore. */
471 j->marker = NULL;
472
473 return 0;
474}
475
718db961 476static int transaction_verify_order(Transaction *tr, unsigned *generation, sd_bus_error *e) {
75778e21
MS
477 Job *j;
478 int r;
75778e21
MS
479 unsigned g;
480
481 assert(tr);
482 assert(generation);
483
484 /* Check if the ordering graph is cyclic. If it is, try to fix
485 * that up by dropping one of the jobs. */
486
487 g = (*generation)++;
488
90e74a66 489 HASHMAP_FOREACH(j, tr->jobs) {
3cc2aff1
LP
490 r = transaction_verify_order_one(tr, j, NULL, g, e);
491 if (r < 0)
75778e21 492 return r;
3cc2aff1 493 }
75778e21
MS
494
495 return 0;
496}
497
498static void transaction_collect_garbage(Transaction *tr) {
ca006fc6 499 bool again;
75778e21
MS
500
501 assert(tr);
502
503 /* Drop jobs that are not required by any other job */
504
ca006fc6 505 do {
ca006fc6
LP
506 Job *j;
507
508 again = false;
509
90e74a66 510 HASHMAP_FOREACH(j, tr->jobs) {
ca006fc6
LP
511 if (tr->anchor_job == j)
512 continue;
513
514 if (!j->object_list) {
515 log_trace("Garbage collecting job %s/%s", j->unit->id, job_type_to_string(j->type));
516 transaction_delete_job(tr, j, true);
517 again = true;
518 break;
519 }
520
78218e62
JK
521 log_trace("Keeping job %s/%s because of %s/%s",
522 j->unit->id, job_type_to_string(j->type),
523 j->object_list->subject ? j->object_list->subject->unit->id : "root",
524 j->object_list->subject ? job_type_to_string(j->object_list->subject->type) : "root");
75778e21
MS
525 }
526
ca006fc6 527 } while (again);
75778e21
MS
528}
529
718db961 530static int transaction_is_destructive(Transaction *tr, JobMode mode, sd_bus_error *e) {
75778e21
MS
531 Job *j;
532
533 assert(tr);
534
535 /* Checks whether applying this transaction means that
536 * existing jobs would be replaced */
537
90e74a66 538 HASHMAP_FOREACH(j, tr->jobs) {
75778e21
MS
539
540 /* Assume merged */
541 assert(!j->transaction_prev);
542 assert(!j->transaction_next);
543
23ade460 544 if (j->unit->job && (mode == JOB_FAIL || j->unit->job->irreversible) &&
c21b92ff 545 job_type_is_conflicting(j->unit->job->type, j->type))
7358dc02 546 return sd_bus_error_setf(e, BUS_ERROR_TRANSACTION_IS_DESTRUCTIVE,
cf99f8ea
LP
547 "Transaction for %s/%s is destructive (%s has '%s' job queued, but '%s' is included in transaction).",
548 tr->anchor_job->unit->id, job_type_to_string(tr->anchor_job->type),
549 j->unit->id, job_type_to_string(j->unit->job->type), job_type_to_string(j->type));
75778e21
MS
550 }
551
552 return 0;
553}
554
555static void transaction_minimize_impact(Transaction *tr) {
03677889 556 Job *head;
055163ad 557
75778e21
MS
558 assert(tr);
559
560 /* Drops all unnecessary jobs that reverse already active jobs
561 * or that stop a running service. */
562
055163ad 563rescan:
03677889
YW
564 HASHMAP_FOREACH(head, tr->jobs) {
565 LIST_FOREACH(transaction, j, head) {
055163ad 566 bool stops_running_service, changes_existing_job;
75778e21 567
055163ad
MS
568 /* If it matters, we shouldn't drop it */
569 if (j->matters_to_anchor)
570 continue;
75778e21 571
055163ad
MS
572 /* Would this stop a running service?
573 * Would this change an existing job?
574 * If so, let's drop this entry */
75778e21 575
055163ad
MS
576 stops_running_service =
577 j->type == JOB_STOP && UNIT_IS_ACTIVE_OR_ACTIVATING(unit_active_state(j->unit));
75778e21 578
055163ad
MS
579 changes_existing_job =
580 j->unit->job &&
581 job_type_is_conflicting(j->type, j->unit->job->type);
75778e21 582
055163ad
MS
583 if (!stops_running_service && !changes_existing_job)
584 continue;
75778e21 585
055163ad 586 if (stops_running_service)
f2341e0a 587 log_unit_debug(j->unit,
66870f90
ZJS
588 "%s/%s would stop a running service.",
589 j->unit->id, job_type_to_string(j->type));
75778e21 590
055163ad 591 if (changes_existing_job)
f2341e0a 592 log_unit_debug(j->unit,
66870f90
ZJS
593 "%s/%s would change existing job.",
594 j->unit->id, job_type_to_string(j->type));
75778e21 595
055163ad 596 /* Ok, let's get rid of this */
f2341e0a 597 log_unit_debug(j->unit,
66870f90
ZJS
598 "Deleting %s/%s to minimize impact.",
599 j->unit->id, job_type_to_string(j->type));
75778e21 600
055163ad
MS
601 transaction_delete_job(tr, j, true);
602 goto rescan;
75778e21 603 }
055163ad 604 }
75778e21
MS
605}
606
50cbaba4
LP
607static int transaction_apply(
608 Transaction *tr,
609 Manager *m,
610 JobMode mode,
611 Set *affected_jobs) {
612
75778e21
MS
613 Job *j;
614 int r;
615
616 /* Moves the transaction jobs to the set of active jobs */
617
3742095b 618 if (IN_SET(mode, JOB_ISOLATE, JOB_FLUSH)) {
75778e21
MS
619
620 /* When isolating first kill all installed jobs which
621 * aren't part of the new transaction */
90e74a66 622 HASHMAP_FOREACH(j, m->jobs) {
75778e21
MS
623 assert(j->installed);
624
2de0b9e9
MO
625 if (j->unit->ignore_on_isolate)
626 continue;
627
75778e21
MS
628 if (hashmap_get(tr->jobs, j->unit))
629 continue;
630
5273510e
MS
631 /* Not invalidating recursively. Avoids triggering
632 * OnFailure= actions of dependent jobs. Also avoids
633 * invalidating our iterator. */
833f92ad 634 job_finish_and_invalidate(j, JOB_CANCELED, false, false);
75778e21
MS
635 }
636 }
637
90e74a66 638 HASHMAP_FOREACH(j, tr->jobs) {
75778e21
MS
639 /* Assume merged */
640 assert(!j->transaction_prev);
641 assert(!j->transaction_next);
642
acf56b72 643 r = hashmap_ensure_put(&m->jobs, NULL, UINT32_TO_PTR(j->id), j);
75778e21
MS
644 if (r < 0)
645 goto rollback;
646 }
647
648 while ((j = hashmap_steal_first(tr->jobs))) {
656bbffc
MS
649 Job *installed_job;
650
75778e21
MS
651 /* Clean the job dependencies */
652 transaction_unlink_job(tr, j, false);
653
656bbffc
MS
654 installed_job = job_install(j);
655 if (installed_job != j) {
656 /* j has been merged into a previously installed job */
657 if (tr->anchor_job == j)
658 tr->anchor_job = installed_job;
659 hashmap_remove(m->jobs, UINT32_TO_PTR(j->id));
660 job_free(j);
661 j = installed_job;
662 }
05d576f1 663
75778e21
MS
664 job_add_to_run_queue(j);
665 job_add_to_dbus_queue(j);
a2df3ea4 666 job_start_timer(j, false);
c65eb836 667 job_shutdown_magic(j);
50cbaba4
LP
668
669 /* When 'affected' is specified, let's track all in it all jobs that were touched because of
670 * this transaction. */
671 if (affected_jobs)
672 (void) set_put(affected_jobs, j);
75778e21
MS
673 }
674
75778e21
MS
675 return 0;
676
677rollback:
678
90e74a66 679 HASHMAP_FOREACH(j, tr->jobs)
75778e21 680 hashmap_remove(m->jobs, UINT32_TO_PTR(j->id));
75778e21
MS
681
682 return r;
683}
684
50cbaba4
LP
685int transaction_activate(
686 Transaction *tr,
687 Manager *m,
688 JobMode mode,
689 Set *affected_jobs,
690 sd_bus_error *e) {
691
4e7bd268 692 Job *j;
75778e21
MS
693 int r;
694 unsigned generation = 1;
695
696 assert(tr);
697
698 /* This applies the changes recorded in tr->jobs to
699 * the actual list of jobs, if possible. */
700
4e7bd268
MS
701 /* Reset the generation counter of all installed jobs. The detection of cycles
702 * looks at installed jobs. If they had a non-zero generation from some previous
703 * walk of the graph, the algorithm would break. */
90e74a66 704 HASHMAP_FOREACH(j, m->jobs)
4e7bd268
MS
705 j->generation = 0;
706
75778e21 707 /* First step: figure out which jobs matter */
0d9989aa 708 transaction_find_jobs_that_matter_to_anchor(tr->anchor_job, generation++);
75778e21
MS
709
710 /* Second step: Try not to stop any running services if
711 * we don't have to. Don't try to reverse running
712 * jobs if we don't have to. */
713 if (mode == JOB_FAIL)
714 transaction_minimize_impact(tr);
715
716 /* Third step: Drop redundant jobs */
cc479760 717 transaction_drop_redundant(tr);
75778e21
MS
718
719 for (;;) {
720 /* Fourth step: Let's remove unneeded jobs that might
721 * be lurking. */
722 if (mode != JOB_ISOLATE)
723 transaction_collect_garbage(tr);
724
725 /* Fifth step: verify order makes sense and correct
726 * cycles if necessary and possible */
727 r = transaction_verify_order(tr, &generation, e);
728 if (r >= 0)
729 break;
730
4ae25393
YW
731 if (r != -EAGAIN)
732 return log_warning_errno(r, "Requested transaction contains an unfixable cyclic ordering dependency: %s", bus_error_message(e, r));
75778e21
MS
733
734 /* Let's see if the resulting transaction ordering
735 * graph is still cyclic... */
736 }
737
738 for (;;) {
739 /* Sixth step: let's drop unmergeable entries if
740 * necessary and possible, merge entries we can
741 * merge */
742 r = transaction_merge_jobs(tr, e);
743 if (r >= 0)
744 break;
745
4ae25393
YW
746 if (r != -EAGAIN)
747 return log_warning_errno(r, "Requested transaction contains unmergeable jobs: %s", bus_error_message(e, r));
75778e21
MS
748
749 /* Seventh step: an entry got dropped, let's garbage
750 * collect its dependencies. */
751 if (mode != JOB_ISOLATE)
752 transaction_collect_garbage(tr);
753
754 /* Let's see if the resulting transaction still has
755 * unmergeable entries ... */
756 }
757
758 /* Eights step: Drop redundant jobs again, if the merging now allows us to drop more. */
cc479760 759 transaction_drop_redundant(tr);
75778e21
MS
760
761 /* Ninth step: check whether we can actually apply this */
23ade460 762 r = transaction_is_destructive(tr, mode, e);
4ae25393
YW
763 if (r < 0)
764 return log_notice_errno(r, "Requested transaction contradicts existing jobs: %s", bus_error_message(e, r));
75778e21
MS
765
766 /* Tenth step: apply changes */
50cbaba4 767 r = transaction_apply(tr, m, mode, affected_jobs);
23bbb0de
MS
768 if (r < 0)
769 return log_warning_errno(r, "Failed to apply transaction: %m");
75778e21
MS
770
771 assert(hashmap_isempty(tr->jobs));
75778e21 772
f2b68789
LP
773 if (!hashmap_isempty(m->jobs)) {
774 /* Are there any jobs now? Then make sure we have the
775 * idle pipe around. We don't really care too much
776 * whether this works or not, as the idle pipe is a
777 * feature for cosmetics, not actually useful for
778 * anything beyond that. */
779
31a7eb86
ZJS
780 if (m->idle_pipe[0] < 0 && m->idle_pipe[1] < 0 &&
781 m->idle_pipe[2] < 0 && m->idle_pipe[3] < 0) {
1afaa7e8
LP
782 (void) pipe2(m->idle_pipe, O_NONBLOCK|O_CLOEXEC);
783 (void) pipe2(m->idle_pipe + 2, O_NONBLOCK|O_CLOEXEC);
31a7eb86 784 }
f2b68789
LP
785 }
786
75778e21
MS
787 return 0;
788}
789
4bd29fe5 790static Job* transaction_add_one_job(Transaction *tr, JobType type, Unit *unit, bool *is_new) {
75778e21
MS
791 Job *j, *f;
792
793 assert(tr);
794 assert(unit);
795
796 /* Looks for an existing prospective job and returns that. If
797 * it doesn't exist it is created and added to the prospective
798 * jobs list. */
799
800 f = hashmap_get(tr->jobs, unit);
801
03677889
YW
802 LIST_FOREACH(transaction, i, f) {
803 assert(i->unit == unit);
75778e21 804
03677889 805 if (i->type == type) {
75778e21
MS
806 if (is_new)
807 *is_new = false;
03677889 808 return i;
75778e21
MS
809 }
810 }
811
3c956cfe
MS
812 j = job_new(unit, type);
813 if (!j)
814 return NULL;
75778e21
MS
815
816 j->generation = 0;
817 j->marker = NULL;
818 j->matters_to_anchor = false;
23ade460 819 j->irreversible = tr->irreversible;
75778e21 820
71fda00f 821 LIST_PREPEND(transaction, f, j);
75778e21
MS
822
823 if (hashmap_replace(tr->jobs, unit, f) < 0) {
71fda00f 824 LIST_REMOVE(transaction, f, j);
75778e21
MS
825 job_free(j);
826 return NULL;
827 }
828
829 if (is_new)
830 *is_new = true;
831
78218e62 832 log_trace("Added job %s/%s to transaction.", unit->id, job_type_to_string(type));
75778e21
MS
833
834 return j;
835}
836
837static void transaction_unlink_job(Transaction *tr, Job *j, bool delete_dependencies) {
838 assert(tr);
839 assert(j);
840
841 if (j->transaction_prev)
842 j->transaction_prev->transaction_next = j->transaction_next;
843 else if (j->transaction_next)
844 hashmap_replace(tr->jobs, j->unit, j->transaction_next);
845 else
846 hashmap_remove_value(tr->jobs, j->unit, j);
847
848 if (j->transaction_next)
849 j->transaction_next->transaction_prev = j->transaction_prev;
850
851 j->transaction_prev = j->transaction_next = NULL;
852
853 while (j->subject_list)
e6eda1f2 854 job_dependency_free(j->subject_list);
75778e21
MS
855
856 while (j->object_list) {
857 Job *other = j->object_list->matters ? j->object_list->subject : NULL;
858
e6eda1f2 859 job_dependency_free(j->object_list);
75778e21
MS
860
861 if (other && delete_dependencies) {
f2341e0a 862 log_unit_debug(other->unit,
66870f90
ZJS
863 "Deleting job %s/%s as dependency of job %s/%s",
864 other->unit->id, job_type_to_string(other->type),
865 j->unit->id, job_type_to_string(j->type));
75778e21
MS
866 transaction_delete_job(tr, other, delete_dependencies);
867 }
868 }
869}
870
15d167f8 871void transaction_add_propagate_reload_jobs(Transaction *tr, Unit *unit, Job *by, bool ignore_order, sd_bus_error *e) {
15d167f8 872 JobType nt;
eef85c4a 873 Unit *dep;
15d167f8
JW
874 int r;
875
876 assert(tr);
877 assert(unit);
878
15ed3c3a 879 UNIT_FOREACH_DEPENDENCY(dep, unit, UNIT_ATOM_PROPAGATES_RELOAD_TO) {
15d167f8
JW
880 nt = job_type_collapse(JOB_TRY_RELOAD, dep);
881 if (nt == JOB_NOP)
882 continue;
883
884 r = transaction_add_job_and_dependencies(tr, nt, dep, by, false, false, false, ignore_order, e);
885 if (r < 0) {
886 log_unit_warning(dep,
887 "Cannot add dependency reload job, ignoring: %s",
888 bus_error_message(e, r));
889 sd_bus_error_free(e);
890 }
891 }
892}
893
75778e21
MS
894int transaction_add_job_and_dependencies(
895 Transaction *tr,
896 JobType type,
897 Unit *unit,
898 Job *by,
899 bool matters,
75778e21
MS
900 bool conflicts,
901 bool ignore_requirements,
902 bool ignore_order,
718db961 903 sd_bus_error *e) {
eef85c4a
LP
904
905 bool is_new;
75778e21 906 Unit *dep;
eef85c4a 907 Job *ret;
75778e21 908 int r;
75778e21
MS
909
910 assert(tr);
911 assert(type < _JOB_TYPE_MAX);
e0209d83 912 assert(type < _JOB_TYPE_MAX_IN_TRANSACTION);
75778e21
MS
913 assert(unit);
914
43706330
IS
915 /* Before adding jobs for this unit, let's ensure that its state has been loaded
916 * This matters when jobs are spawned as part of coldplugging itself (see e. g. path_coldplug()).
917 * This way, we "recursively" coldplug units, ensuring that we do not look at state of
918 * not-yet-coldplugged units. */
2c289ea8 919 if (MANAGER_IS_RELOADING(unit->manager))
43706330
IS
920 unit_coldplug(unit);
921
78218e62
JK
922 if (by)
923 log_trace("Pulling in %s/%s from %s/%s", unit->id, job_type_to_string(type), by->unit->id, job_type_to_string(by->type));
75778e21 924
c4555ad8
LP
925 /* Safety check that the unit is a valid state, i.e. not in UNIT_STUB or UNIT_MERGED which should only be set
926 * temporarily. */
0377cd29 927 if (!UNIT_IS_LOAD_COMPLETE(unit->load_state))
c6497ccb 928 return sd_bus_error_setf(e, BUS_ERROR_LOAD_FAILED, "Unit %s is not loaded properly.", unit->id);
75778e21 929
ee87525c 930 if (type != JOB_STOP) {
e49da001 931 r = bus_unit_validate_load_state(unit, e);
cda66772
LB
932 /* The time-based cache allows to start new units without daemon-reload,
933 * but if they are already referenced (because of dependencies or ordering)
934 * then we have to force a load of the fragment. As an optimization, check
935 * first if anything in the usual paths was modified since the last time
936 * the cache was loaded. Also check if the last time an attempt to load the
937 * unit was made was before the most recent cache refresh, so that we know
81be2388 938 * we need to try again — even if the cache is current, it might have been
cda66772
LB
939 * updated in a different context before we had a chance to retry loading
940 * this particular unit.
81be2388 941 *
cda66772
LB
942 * Given building up the transaction is a synchronous operation, attempt
943 * to load the unit immediately. */
81be2388 944 if (r < 0 && manager_unit_cache_should_retry_load(unit)) {
94efaa31 945 sd_bus_error_free(e);
cda66772
LB
946 unit->load_state = UNIT_STUB;
947 r = unit_load(unit);
948 if (r < 0 || unit->load_state == UNIT_STUB)
949 unit->load_state = UNIT_NOT_FOUND;
950 r = bus_unit_validate_load_state(unit, e);
951 }
ee87525c
FB
952 if (r < 0)
953 return r;
75778e21
MS
954 }
955
7358dc02
ZJS
956 if (!unit_job_is_applicable(unit, type))
957 return sd_bus_error_setf(e, BUS_ERROR_JOB_TYPE_NOT_APPLICABLE,
958 "Job type %s is not applicable for unit %s.",
959 job_type_to_string(type), unit->id);
75778e21 960
75778e21 961 /* First add the job. */
4bd29fe5 962 ret = transaction_add_one_job(tr, type, unit, &is_new);
75778e21
MS
963 if (!ret)
964 return -ENOMEM;
965
966 ret->ignore_order = ret->ignore_order || ignore_order;
967
968 /* Then, add a link to the job. */
e6eda1f2
MS
969 if (by) {
970 if (!job_dependency_new(by, ret, matters, conflicts))
971 return -ENOMEM;
972 } else {
973 /* If the job has no parent job, it is the anchor job. */
4483f694
MS
974 assert(!tr->anchor_job);
975 tr->anchor_job = ret;
b94fbd30 976 }
e0209d83
MS
977
978 if (is_new && !ignore_requirements && type != JOB_NOP) {
fd55b2e5 979 _cleanup_set_free_ Set *following = NULL;
75778e21
MS
980
981 /* If we are following some other unit, make sure we
982 * add all dependencies of everybody following. */
fd55b2e5 983 if (unit_following_set(ret->unit, &following) > 0)
90e74a66 984 SET_FOREACH(dep, following) {
4bd29fe5 985 r = transaction_add_job_and_dependencies(tr, type, dep, ret, false, false, false, ignore_order, e);
75778e21 986 if (r < 0) {
8ed6f81b
YW
987 log_unit_full_errno(dep, r == -ERFKILL ? LOG_INFO : LOG_WARNING, r,
988 "Cannot add dependency job, ignoring: %s",
989 bus_error_message(e, r));
69301c17 990 sd_bus_error_free(e);
75778e21
MS
991 }
992 }
993
75778e21 994 /* Finally, recursively add in all dependencies. */
3742095b 995 if (IN_SET(type, JOB_START, JOB_RESTART)) {
15ed3c3a 996 UNIT_FOREACH_DEPENDENCY(dep, ret->unit, UNIT_ATOM_PULL_IN_START) {
4bd29fe5 997 r = transaction_add_job_and_dependencies(tr, JOB_START, dep, ret, true, false, false, ignore_order, e);
75778e21 998 if (r < 0) {
114400df 999 if (r != -EBADR) /* job type not applicable */
65a2493e 1000 return r;
75778e21 1001
69301c17 1002 sd_bus_error_free(e);
75778e21
MS
1003 }
1004 }
1005
15ed3c3a 1006 UNIT_FOREACH_DEPENDENCY(dep, ret->unit, UNIT_ATOM_PULL_IN_START_IGNORED) {
4bd29fe5 1007 r = transaction_add_job_and_dependencies(tr, JOB_START, dep, ret, false, false, false, ignore_order, e);
75778e21 1008 if (r < 0) {
114400df 1009 /* unit masked, job type not applicable and unit not found are not considered as errors. */
8ed6f81b
YW
1010 log_unit_full_errno(dep,
1011 IN_SET(r, -ERFKILL, -EBADR, -ENOENT) ? LOG_DEBUG : LOG_WARNING,
1012 r, "Cannot add dependency job, ignoring: %s",
1013 bus_error_message(e, r));
69301c17 1014 sd_bus_error_free(e);
75778e21
MS
1015 }
1016 }
1017
15ed3c3a 1018 UNIT_FOREACH_DEPENDENCY(dep, ret->unit, UNIT_ATOM_PULL_IN_VERIFY) {
4bd29fe5 1019 r = transaction_add_job_and_dependencies(tr, JOB_VERIFY_ACTIVE, dep, ret, true, false, false, ignore_order, e);
75778e21 1020 if (r < 0) {
114400df 1021 if (r != -EBADR) /* job type not applicable */
65a2493e 1022 return r;
75778e21 1023
69301c17 1024 sd_bus_error_free(e);
75778e21
MS
1025 }
1026 }
1027
15ed3c3a 1028 UNIT_FOREACH_DEPENDENCY(dep, ret->unit, UNIT_ATOM_PULL_IN_STOP) {
4bd29fe5 1029 r = transaction_add_job_and_dependencies(tr, JOB_STOP, dep, ret, true, true, false, ignore_order, e);
75778e21 1030 if (r < 0) {
114400df 1031 if (r != -EBADR) /* job type not applicable */
65a2493e 1032 return r;
75778e21 1033
69301c17 1034 sd_bus_error_free(e);
75778e21
MS
1035 }
1036 }
1037
15ed3c3a 1038 UNIT_FOREACH_DEPENDENCY(dep, ret->unit, UNIT_ATOM_PULL_IN_STOP_IGNORED) {
4bd29fe5 1039 r = transaction_add_job_and_dependencies(tr, JOB_STOP, dep, ret, false, false, false, ignore_order, e);
75778e21 1040 if (r < 0) {
f2341e0a
LP
1041 log_unit_warning(dep,
1042 "Cannot add dependency job, ignoring: %s",
1043 bus_error_message(e, r));
69301c17 1044 sd_bus_error_free(e);
75778e21
MS
1045 }
1046 }
75778e21
MS
1047 }
1048
3742095b 1049 if (IN_SET(type, JOB_STOP, JOB_RESTART)) {
017a7ba4 1050 _cleanup_set_free_ Set *propagated_restart = NULL;
15ed3c3a 1051 /* We propagate STOP as STOP, but RESTART only as TRY_RESTART, in order not to start
c6497ccb 1052 * dependencies that are not around. */
c6497ccb 1053
017a7ba4
MY
1054 if (type == JOB_RESTART)
1055 UNIT_FOREACH_DEPENDENCY(dep, ret->unit, UNIT_ATOM_PROPAGATE_RESTART) {
1056 JobType nt;
1057
1058 r = set_ensure_put(&propagated_restart, NULL, dep);
1059 if (r < 0)
1060 return r;
1061
1062 nt = job_type_collapse(JOB_TRY_RESTART, dep);
1063 if (nt == JOB_NOP)
1064 continue;
1065
1066 r = transaction_add_job_and_dependencies(tr, nt, dep, ret, true, false, false, ignore_order, e);
1067 if (r < 0) {
1068 if (r != -EBADR) /* job type not applicable */
1069 return r;
1070
1071 sd_bus_error_free(e);
1072 }
1073 }
85e9a101 1074
017a7ba4
MY
1075 /* The 'stop' part of a restart job is also propagated to
1076 * units with UNIT_ATOM_PROPAGATE_STOP */
1077 UNIT_FOREACH_DEPENDENCY(dep, ret->unit, UNIT_ATOM_PROPAGATE_STOP) {
1078 /* Units experienced restart propagation are skipped */
1079 if (set_contains(propagated_restart, dep))
15ed3c3a 1080 continue;
48894cd0 1081
017a7ba4 1082 r = transaction_add_job_and_dependencies(tr, JOB_STOP, dep, ret, true, false, false, ignore_order, e);
15ed3c3a
LP
1083 if (r < 0) {
1084 if (r != -EBADR) /* job type not applicable */
65a2493e 1085 return r;
85e9a101 1086
15ed3c3a 1087 sd_bus_error_free(e);
85e9a101 1088 }
15ed3c3a 1089 }
75778e21
MS
1090 }
1091
15d167f8
JW
1092 if (type == JOB_RELOAD)
1093 transaction_add_propagate_reload_jobs(tr, ret->unit, ret, ignore_order, e);
75778e21 1094
78218e62 1095 /* JOB_VERIFY_ACTIVE requires no dependency handling */
75778e21
MS
1096 }
1097
75778e21 1098 return 0;
75778e21
MS
1099}
1100
32d6707d
LP
1101static bool shall_stop_on_isolate(Transaction *tr, Unit *u) {
1102 assert(tr);
1103 assert(u);
1104
1105 if (u->ignore_on_isolate)
1106 return false;
1107
1108 /* Is there already something listed for this? */
1109 if (hashmap_get(tr->jobs, u))
1110 return false;
1111
1112 return true;
1113}
1114
75778e21 1115int transaction_add_isolate_jobs(Transaction *tr, Manager *m) {
75778e21
MS
1116 Unit *u;
1117 char *k;
1118 int r;
1119
1120 assert(tr);
1121 assert(m);
1122
90e74a66 1123 HASHMAP_FOREACH_KEY(u, k, m->units) {
32d6707d 1124 Unit *o;
75778e21 1125
32d6707d 1126 /* Ignore aliases */
75778e21
MS
1127 if (u->id != k)
1128 continue;
1129
32d6707d
LP
1130 /* No need to stop inactive units */
1131 if (UNIT_IS_INACTIVE_OR_FAILED(unit_active_state(u)) && !u->job)
75778e21
MS
1132 continue;
1133
32d6707d 1134 if (!shall_stop_on_isolate(tr, u))
75778e21
MS
1135 continue;
1136
32d6707d
LP
1137 /* Keep units that are triggered by units we want to keep around. */
1138 bool keep = false;
1139 UNIT_FOREACH_DEPENDENCY(o, u, UNIT_ATOM_TRIGGERED_BY)
1140 if (!shall_stop_on_isolate(tr, o)) {
1141 keep = true;
1142 break;
1143 }
1144 if (keep)
75778e21
MS
1145 continue;
1146
4bd29fe5 1147 r = transaction_add_job_and_dependencies(tr, JOB_STOP, u, tr->anchor_job, true, false, false, false, NULL);
75778e21 1148 if (r < 0)
f2341e0a 1149 log_unit_warning_errno(u, r, "Cannot add isolate job, ignoring: %m");
75778e21
MS
1150 }
1151
1152 return 0;
1153}
1154
1f0f9f21 1155int transaction_add_triggering_jobs(Transaction *tr, Unit *u) {
1f0f9f21
KK
1156 Unit *trigger;
1157 int r;
1158
1159 assert(tr);
132e0b53 1160 assert(u);
1f0f9f21 1161
15ed3c3a
LP
1162 UNIT_FOREACH_DEPENDENCY(trigger, u, UNIT_ATOM_TRIGGERED_BY) {
1163
1f0f9f21
KK
1164 /* No need to stop inactive jobs */
1165 if (UNIT_IS_INACTIVE_OR_FAILED(unit_active_state(trigger)) && !trigger->job)
1166 continue;
1167
1168 /* Is there already something listed for this? */
1169 if (hashmap_get(tr->jobs, trigger))
1170 continue;
1171
1172 r = transaction_add_job_and_dependencies(tr, JOB_STOP, trigger, tr->anchor_job, true, false, false, false, NULL);
1173 if (r < 0)
1174 log_unit_warning_errno(u, r, "Cannot add triggered by job, ignoring: %m");
1175 }
1176
1177 return 0;
1178}
1179
23ade460 1180Transaction *transaction_new(bool irreversible) {
75778e21
MS
1181 Transaction *tr;
1182
1183 tr = new0(Transaction, 1);
1184 if (!tr)
1185 return NULL;
1186
d5099efc 1187 tr->jobs = hashmap_new(NULL);
6b430fdb
ZJS
1188 if (!tr->jobs)
1189 return mfree(tr);
75778e21 1190
23ade460
MS
1191 tr->irreversible = irreversible;
1192
75778e21
MS
1193 return tr;
1194}
1195
1196void transaction_free(Transaction *tr) {
1197 assert(hashmap_isempty(tr->jobs));
1198 hashmap_free(tr->jobs);
1199 free(tr);
1200}