src/core/transaction.c

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