src/core/job.c

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