src/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 General Public License as published by
  10   the Free Software Foundation; either version 2 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   General Public License for more details.
  17
  18   You should have received a copy of the GNU 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 "set.h"
  28 #include "unit.h"
  29 #include "macro.h"
  30 #include "strv.h"
  31 #include "load-fragment.h"
  32 #include "load-dropin.h"
  33 #include "log.h"
  34 #include "dbus-job.h"
  35
  36 Job* job_new(Manager *m, JobType type, Unit *unit) {
  37         Job *j;
  38
  39         assert(m);
  40         assert(type < _JOB_TYPE_MAX);
  41         assert(unit);
  42
  43         if (!(j = new0(Job, 1)))
  44                 return NULL;
  45
  46         j->manager = m;
  47         j->id = m->current_job_id++;
  48         j->type = type;
  49         j->unit = unit;
  50
  51         j->timer_watch.type = WATCH_INVALID;
  52
  53         /* We don't link it here, that's what job_dependency() is for */
  54
  55         return j;
  56 }
  57
  58 void job_free(Job *j) {
  59         assert(j);
  60
  61         /* Detach from next 'bigger' objects */
  62         if (j->installed) {
  63                 bus_job_send_removed_signal(j, !j->failed);
  64
  65                 if (j->unit->meta.job == j) {
  66                         j->unit->meta.job = NULL;
  67                         unit_add_to_gc_queue(j->unit);
  68                 }
  69
  70                 hashmap_remove(j->manager->jobs, UINT32_TO_PTR(j->id));
  71                 j->installed = false;
  72         }
  73
  74         /* Detach from next 'smaller' objects */
  75         manager_transaction_unlink_job(j->manager, j, true);
  76
  77         if (j->in_run_queue)
  78                 LIST_REMOVE(Job, run_queue, j->manager->run_queue, j);
  79
  80         if (j->in_dbus_queue)
  81                 LIST_REMOVE(Job, dbus_queue, j->manager->dbus_job_queue, j);
  82
  83         if (j->timer_watch.type != WATCH_INVALID) {
  84                 assert(j->timer_watch.type == WATCH_JOB_TIMER);
  85                 assert(j->timer_watch.data.job == j);
  86                 assert(j->timer_watch.fd >= 0);
  87
  88                 assert_se(epoll_ctl(j->manager->epoll_fd, EPOLL_CTL_DEL, j->timer_watch.fd, NULL) >= 0);
  89                 close_nointr_nofail(j->timer_watch.fd);
  90         }
  91
  92         free(j->bus_client);
  93         free(j);
  94 }
  95
  96 JobDependency* job_dependency_new(Job *subject, Job *object, bool matters, bool conflicts) {
  97         JobDependency *l;
  98
  99         assert(object);
 100
 101         /* Adds a new job link, which encodes that the 'subject' job
 102          * needs the 'object' job in some way. If 'subject' is NULL
 103          * this means the 'anchor' job (i.e. the one the user
 104          * explcitily asked for) is the requester. */
 105
 106         if (!(l = new0(JobDependency, 1)))
 107                 return NULL;
 108
 109         l->subject = subject;
 110         l->object = object;
 111         l->matters = matters;
 112         l->conflicts = conflicts;
 113
 114         if (subject)
 115                 LIST_PREPEND(JobDependency, subject, subject->subject_list, l);
 116         else
 117                 LIST_PREPEND(JobDependency, subject, object->manager->transaction_anchor, l);
 118
 119         LIST_PREPEND(JobDependency, object, object->object_list, l);
 120
 121         return l;
 122 }
 123
 124 void job_dependency_free(JobDependency *l) {
 125         assert(l);
 126
 127         if (l->subject)
 128                 LIST_REMOVE(JobDependency, subject, l->subject->subject_list, l);
 129         else
 130                 LIST_REMOVE(JobDependency, subject, l->object->manager->transaction_anchor, l);
 131
 132         LIST_REMOVE(JobDependency, object, l->object->object_list, l);
 133
 134         free(l);
 135 }
 136
 137 void job_dump(Job *j, FILE*f, const char *prefix) {
 138         assert(j);
 139         assert(f);
 140
 141         if (!prefix)
 142                 prefix = "";
 143
 144         fprintf(f,
 145                 "%s-> Job %u:\n"
 146                 "%s\tAction: %s -> %s\n"
 147                 "%s\tState: %s\n"
 148                 "%s\tForced: %s\n",
 149                 prefix, j->id,
 150                 prefix, j->unit->meta.id, job_type_to_string(j->type),
 151                 prefix, job_state_to_string(j->state),
 152                 prefix, yes_no(j->override));
 153 }
 154
 155 bool job_is_anchor(Job *j) {
 156         JobDependency *l;
 157
 158         assert(j);
 159
 160         LIST_FOREACH(object, l, j->object_list)
 161                 if (!l->subject)
 162                         return true;
 163
 164         return false;
 165 }
 166
 167 static bool types_match(JobType a, JobType b, JobType c, JobType d) {
 168         return
 169                 (a == c && b == d) ||
 170                 (a == d && b == c);
 171 }
 172
 173 int job_type_merge(JobType *a, JobType b) {
 174         if (*a == b)
 175                 return 0;
 176
 177         /* Merging is associative! a merged with b merged with c is
 178          * the same as a merged with c merged with b. */
 179
 180         /* Mergeability is transitive! if a can be merged with b and b
 181          * with c then a also with c */
 182
 183         /* Also, if a merged with b cannot be merged with c, then
 184          * either a or b cannot be merged with c either */
 185
 186         if (types_match(*a, b, JOB_START, JOB_VERIFY_ACTIVE))
 187                 *a = JOB_START;
 188         else if (types_match(*a, b, JOB_START, JOB_RELOAD) ||
 189                  types_match(*a, b, JOB_START, JOB_RELOAD_OR_START) ||
 190                  types_match(*a, b, JOB_VERIFY_ACTIVE, JOB_RELOAD_OR_START) ||
 191                  types_match(*a, b, JOB_RELOAD, JOB_RELOAD_OR_START))
 192                 *a = JOB_RELOAD_OR_START;
 193         else if (types_match(*a, b, JOB_START, JOB_RESTART) ||
 194                  types_match(*a, b, JOB_START, JOB_TRY_RESTART) ||
 195                  types_match(*a, b, JOB_VERIFY_ACTIVE, JOB_RESTART) ||
 196                  types_match(*a, b, JOB_RELOAD, JOB_RESTART) ||
 197                  types_match(*a, b, JOB_RELOAD_OR_START, JOB_RESTART) ||
 198                  types_match(*a, b, JOB_RELOAD_OR_START, JOB_TRY_RESTART) ||
 199                  types_match(*a, b, JOB_RESTART, JOB_TRY_RESTART))
 200                 *a = JOB_RESTART;
 201         else if (types_match(*a, b, JOB_VERIFY_ACTIVE, JOB_RELOAD))
 202                 *a = JOB_RELOAD;
 203         else if (types_match(*a, b, JOB_VERIFY_ACTIVE, JOB_TRY_RESTART) ||
 204                  types_match(*a, b, JOB_RELOAD, JOB_TRY_RESTART))
 205                 *a = JOB_TRY_RESTART;
 206         else
 207                 return -EEXIST;
 208
 209         return 0;
 210 }
 211
 212 bool job_type_is_mergeable(JobType a, JobType b) {
 213         return job_type_merge(&a, b) >= 0;
 214 }
 215
 216 bool job_type_is_superset(JobType a, JobType b) {
 217
 218         /* Checks whether operation a is a "superset" of b in its
 219          * actions */
 220
 221         if (a == b)
 222                 return true;
 223
 224         switch (a) {
 225                 case JOB_START:
 226                         return b == JOB_VERIFY_ACTIVE;
 227
 228                 case JOB_RELOAD:
 229                         return
 230                                 b == JOB_VERIFY_ACTIVE;
 231
 232                 case JOB_RELOAD_OR_START:
 233                         return
 234                                 b == JOB_RELOAD ||
 235                                 b == JOB_START ||
 236                                 b == JOB_VERIFY_ACTIVE;
 237
 238                 case JOB_RESTART:
 239                         return
 240                                 b == JOB_START ||
 241                                 b == JOB_VERIFY_ACTIVE ||
 242                                 b == JOB_RELOAD ||
 243                                 b == JOB_RELOAD_OR_START ||
 244                                 b == JOB_TRY_RESTART;
 245
 246                 case JOB_TRY_RESTART:
 247                         return
 248                                 b == JOB_VERIFY_ACTIVE ||
 249                                 b == JOB_RELOAD;
 250                 default:
 251                         return false;
 252
 253         }
 254 }
 255
 256 bool job_type_is_conflicting(JobType a, JobType b) {
 257         assert(a >= 0 && a < _JOB_TYPE_MAX);
 258         assert(b >= 0 && b < _JOB_TYPE_MAX);
 259
 260         return (a == JOB_STOP) != (b == JOB_STOP);
 261 }
 262
 263 bool job_type_is_redundant(JobType a, UnitActiveState b) {
 264         switch (a) {
 265
 266         case JOB_START:
 267                 return
 268                         b == UNIT_ACTIVE ||
 269                         b == UNIT_RELOADING;
 270
 271         case JOB_STOP:
 272                 return
 273                         b == UNIT_INACTIVE ||
 274                         b == UNIT_FAILED;
 275
 276         case JOB_VERIFY_ACTIVE:
 277                 return
 278                         b == UNIT_ACTIVE ||
 279                         b == UNIT_RELOADING;
 280
 281         case JOB_RELOAD:
 282                 return
 283                         b == UNIT_RELOADING;
 284
 285         case JOB_RELOAD_OR_START:
 286                 return
 287                         b == UNIT_ACTIVATING ||
 288                         b == UNIT_RELOADING;
 289
 290         case JOB_RESTART:
 291                 return
 292                         b == UNIT_ACTIVATING;
 293
 294         case JOB_TRY_RESTART:
 295                 return
 296                         b == UNIT_ACTIVATING;
 297
 298         default:
 299                 assert_not_reached("Invalid job type");
 300         }
 301 }
 302
 303 bool job_is_runnable(Job *j) {
 304         Iterator i;
 305         Unit *other;
 306
 307         assert(j);
 308         assert(j->installed);
 309
 310         /* Checks whether there is any job running for the units this
 311          * job needs to be running after (in the case of a 'positive'
 312          * job type) or before (in the case of a 'negative' job type
 313          * . */
 314
 315         if (j->type == JOB_START ||
 316             j->type == JOB_VERIFY_ACTIVE ||
 317             j->type == JOB_RELOAD ||
 318             j->type == JOB_RELOAD_OR_START) {
 319
 320                 /* Immediate result is that the job is or might be
 321                  * started. In this case lets wait for the
 322                  * dependencies, regardless whether they are
 323                  * starting or stopping something. */
 324
 325                 SET_FOREACH(other, j->unit->meta.dependencies[UNIT_AFTER], i)
 326                         if (other->meta.job)
 327                                 return false;
 328         }
 329
 330         /* Also, if something else is being stopped and we should
 331          * change state after it, then lets wait. */
 332
 333         SET_FOREACH(other, j->unit->meta.dependencies[UNIT_BEFORE], i)
 334                 if (other->meta.job &&
 335                     (other->meta.job->type == JOB_STOP ||
 336                      other->meta.job->type == JOB_RESTART ||
 337                      other->meta.job->type == JOB_TRY_RESTART))
 338                         return false;
 339
 340         /* This means that for a service a and a service b where b
 341          * shall be started after a:
 342          *
 343          *  start a + start b → 1st step start a, 2nd step start b
 344          *  start a + stop b  → 1st step stop b,  2nd step start a
 345          *  stop a  + start b → 1st step stop a,  2nd step start b
 346          *  stop a  + stop b  → 1st step stop b,  2nd step stop a
 347          *
 348          *  This has the side effect that restarts are properly
 349          *  synchronized too. */
 350
 351         return true;
 352 }
 353
 354 int job_run_and_invalidate(Job *j) {
 355         int r;
 356         uint32_t id;
 357         Manager *m;
 358
 359         assert(j);
 360         assert(j->installed);
 361
 362         if (j->in_run_queue) {
 363                 LIST_REMOVE(Job, run_queue, j->manager->run_queue, j);
 364                 j->in_run_queue = false;
 365         }
 366
 367         if (j->state != JOB_WAITING)
 368                 return 0;
 369
 370         if (!job_is_runnable(j))
 371                 return -EAGAIN;
 372
 373         j->state = JOB_RUNNING;
 374         job_add_to_dbus_queue(j);
 375
 376         /* While we execute this operation the job might go away (for
 377          * example: because it is replaced by a new, conflicting
 378          * job.) To make sure we don't access a freed job later on we
 379          * store the id here, so that we can verify the job is still
 380          * valid. */
 381         id = j->id;
 382         m = j->manager;
 383
 384         switch (j->type) {
 385
 386                 case JOB_START:
 387                         r = unit_start(j->unit);
 388                         if (r == -EBADR)
 389                                 r = 0;
 390                         break;
 391
 392                 case JOB_VERIFY_ACTIVE: {
 393                         UnitActiveState t = unit_active_state(j->unit);
 394                         if (UNIT_IS_ACTIVE_OR_RELOADING(t))
 395                                 r = -EALREADY;
 396                         else if (t == UNIT_ACTIVATING)
 397                                 r = -EAGAIN;
 398                         else
 399                                 r = -ENOEXEC;
 400                         break;
 401                 }
 402
 403                 case JOB_STOP:
 404                         r = unit_stop(j->unit);
 405                         break;
 406
 407                 case JOB_RELOAD:
 408                         r = unit_reload(j->unit);
 409                         break;
 410
 411                 case JOB_RELOAD_OR_START:
 412                         if (unit_active_state(j->unit) == UNIT_ACTIVE)
 413                                 r = unit_reload(j->unit);
 414                         else
 415                                 r = unit_start(j->unit);
 416                         break;
 417
 418                 case JOB_RESTART: {
 419                         UnitActiveState t = unit_active_state(j->unit);
 420                         if (t == UNIT_INACTIVE || t == UNIT_FAILED || t == UNIT_ACTIVATING) {
 421                                 j->type = JOB_START;
 422                                 r = unit_start(j->unit);
 423                         } else
 424                                 r = unit_stop(j->unit);
 425                         break;
 426                 }
 427
 428                 case JOB_TRY_RESTART: {
 429                         UnitActiveState t = unit_active_state(j->unit);
 430                         if (t == UNIT_INACTIVE || t == UNIT_FAILED || t == UNIT_DEACTIVATING)
 431                                 r = -ENOEXEC;
 432                         else if (t == UNIT_ACTIVATING) {
 433                                 j->type = JOB_START;
 434                                 r = unit_start(j->unit);
 435                         } else
 436                                 r = unit_stop(j->unit);
 437                         break;
 438                 }
 439
 440                 default:
 441                         assert_not_reached("Unknown job type");
 442         }
 443
 444         if ((j = manager_get_job(m, id))) {
 445                 if (r == -EALREADY)
 446                         r = job_finish_and_invalidate(j, true);
 447                 else if (r == -EAGAIN)
 448                         j->state = JOB_WAITING;
 449                 else if (r < 0)
 450                         r = job_finish_and_invalidate(j, false);
 451         }
 452
 453         return r;
 454 }
 455
 456 int job_finish_and_invalidate(Job *j, bool success) {
 457         Unit *u;
 458         Unit *other;
 459         JobType t;
 460         Iterator i;
 461
 462         assert(j);
 463         assert(j->installed);
 464
 465         job_add_to_dbus_queue(j);
 466
 467         /* Patch restart jobs so that they become normal start jobs */
 468         if (success && (j->type == JOB_RESTART || j->type == JOB_TRY_RESTART)) {
 469
 470                 log_debug("Converting job %s/%s -> %s/%s",
 471                           j->unit->meta.id, job_type_to_string(j->type),
 472                           j->unit->meta.id, job_type_to_string(JOB_START));
 473
 474                 j->state = JOB_WAITING;
 475                 j->type = JOB_START;
 476
 477                 job_add_to_run_queue(j);
 478                 return 0;
 479         }
 480
 481         log_debug("Job %s/%s finished, success=%s", j->unit->meta.id, job_type_to_string(j->type), yes_no(success));
 482
 483         j->failed = !success;
 484         u = j->unit;
 485         t = j->type;
 486         job_free(j);
 487
 488         if (!success)
 489                 unit_status_printf(u, "Starting %s " ANSI_HIGHLIGHT_ON "failed" ANSI_HIGHLIGHT_OFF ".\n", unit_description(u));
 490
 491         /* Fail depending jobs on failure */
 492         if (!success) {
 493
 494                 if (t == JOB_START ||
 495                     t == JOB_VERIFY_ACTIVE ||
 496                     t == JOB_RELOAD_OR_START) {
 497
 498                         SET_FOREACH(other, u->meta.dependencies[UNIT_REQUIRED_BY], i)
 499                                 if (!other->meta.ignore_dependency_failure &&
 500                                     other->meta.job &&
 501                                     (other->meta.job->type == JOB_START ||
 502                                      other->meta.job->type == JOB_VERIFY_ACTIVE ||
 503                                      other->meta.job->type == JOB_RELOAD_OR_START))
 504                                         job_finish_and_invalidate(other->meta.job, false);
 505
 506                         SET_FOREACH(other, u->meta.dependencies[UNIT_REQUIRED_BY_OVERRIDABLE], i)
 507                                 if (!other->meta.ignore_dependency_failure &&
 508                                     other->meta.job &&
 509                                     !other->meta.job->override &&
 510                                     (other->meta.job->type == JOB_START ||
 511                                      other->meta.job->type == JOB_VERIFY_ACTIVE ||
 512                                      other->meta.job->type == JOB_RELOAD_OR_START))
 513                                         job_finish_and_invalidate(other->meta.job, false);
 514
 515                 } else if (t == JOB_STOP) {
 516
 517                         SET_FOREACH(other, u->meta.dependencies[UNIT_CONFLICTS], i)
 518                                 if (!other->meta.ignore_dependency_failure &&
 519                                     other->meta.job &&
 520                                     (other->meta.job->type == JOB_START ||
 521                                      other->meta.job->type == JOB_VERIFY_ACTIVE ||
 522                                      other->meta.job->type == JOB_RELOAD_OR_START))
 523                                         job_finish_and_invalidate(other->meta.job, false);
 524
 525                         SET_FOREACH(other, u->meta.dependencies[UNIT_CONFLICTED_BY], i)
 526                                 if (!other->meta.ignore_dependency_failure &&
 527                                     other->meta.job &&
 528                                     (other->meta.job->type == JOB_START ||
 529                                      other->meta.job->type == JOB_VERIFY_ACTIVE ||
 530                                      other->meta.job->type == JOB_RELOAD_OR_START))
 531                                         job_finish_and_invalidate(other->meta.job, false);
 532                 }
 533         }
 534
 535         /* Try to start the next jobs that can be started */
 536         SET_FOREACH(other, u->meta.dependencies[UNIT_AFTER], i)
 537                 if (other->meta.job)
 538                         job_add_to_run_queue(other->meta.job);
 539         SET_FOREACH(other, u->meta.dependencies[UNIT_BEFORE], i)
 540                 if (other->meta.job)
 541                         job_add_to_run_queue(other->meta.job);
 542
 543         return 0;
 544 }
 545
 546 int job_start_timer(Job *j) {
 547         struct itimerspec its;
 548         struct epoll_event ev;
 549         int fd, r;
 550         assert(j);
 551
 552         if (j->unit->meta.job_timeout <= 0 ||
 553             j->timer_watch.type == WATCH_JOB_TIMER)
 554                 return 0;
 555
 556         assert(j->timer_watch.type == WATCH_INVALID);
 557
 558         if ((fd = timerfd_create(CLOCK_MONOTONIC, TFD_NONBLOCK|TFD_CLOEXEC)) < 0) {
 559                 r = -errno;
 560                 goto fail;
 561         }
 562
 563         zero(its);
 564         timespec_store(&its.it_value, j->unit->meta.job_timeout);
 565
 566         if (timerfd_settime(fd, 0, &its, NULL) < 0) {
 567                 r = -errno;
 568                 goto fail;
 569         }
 570
 571         zero(ev);
 572         ev.data.ptr = &j->timer_watch;
 573         ev.events = EPOLLIN;
 574
 575         if (epoll_ctl(j->manager->epoll_fd, EPOLL_CTL_ADD, fd, &ev) < 0) {
 576                 r = -errno;
 577                 goto fail;
 578         }
 579
 580         j->timer_watch.type = WATCH_JOB_TIMER;
 581         j->timer_watch.fd = fd;
 582         j->timer_watch.data.job = j;
 583
 584         return 0;
 585
 586 fail:
 587         if (fd >= 0)
 588                 close_nointr_nofail(fd);
 589
 590         return r;
 591 }
 592
 593 void job_add_to_run_queue(Job *j) {
 594         assert(j);
 595         assert(j->installed);
 596
 597         if (j->in_run_queue)
 598                 return;
 599
 600         LIST_PREPEND(Job, run_queue, j->manager->run_queue, j);
 601         j->in_run_queue = true;
 602 }
 603
 604 void job_add_to_dbus_queue(Job *j) {
 605         assert(j);
 606         assert(j->installed);
 607
 608         if (j->in_dbus_queue)
 609                 return;
 610
 611         /* We don't check if anybody is subscribed here, since this
 612          * job might just have been created and not yet assigned to a
 613          * connection/client. */
 614
 615         LIST_PREPEND(Job, dbus_queue, j->manager->dbus_job_queue, j);
 616         j->in_dbus_queue = true;
 617 }
 618
 619 char *job_dbus_path(Job *j) {
 620         char *p;
 621
 622         assert(j);
 623
 624         if (asprintf(&p, "/org/freedesktop/systemd1/job/%lu", (unsigned long) j->id) < 0)
 625                 return NULL;
 626
 627         return p;
 628 }
 629
 630 void job_timer_event(Job *j, uint64_t n_elapsed, Watch *w) {
 631         assert(j);
 632         assert(w == &j->timer_watch);
 633
 634         log_warning("Job %s/%s timed out.", j->unit->meta.id, job_type_to_string(j->type));
 635         job_finish_and_invalidate(j, false);
 636 }
 637
 638 static const char* const job_state_table[_JOB_STATE_MAX] = {
 639         [JOB_WAITING] = "waiting",
 640         [JOB_RUNNING] = "running"
 641 };
 642
 643 DEFINE_STRING_TABLE_LOOKUP(job_state, JobState);
 644
 645 static const char* const job_type_table[_JOB_TYPE_MAX] = {
 646         [JOB_START] = "start",
 647         [JOB_VERIFY_ACTIVE] = "verify-active",
 648         [JOB_STOP] = "stop",
 649         [JOB_RELOAD] = "reload",
 650         [JOB_RELOAD_OR_START] = "reload-or-start",
 651         [JOB_RESTART] = "restart",
 652         [JOB_TRY_RESTART] = "try-restart",
 653 };
 654
 655 DEFINE_STRING_TABLE_LOOKUP(job_type, JobType);
 656
 657 static const char* const job_mode_table[_JOB_MODE_MAX] = {
 658         [JOB_FAIL] = "fail",
 659         [JOB_REPLACE] = "replace",
 660         [JOB_ISOLATE] = "isolate"
 661 };
 662
 663 DEFINE_STRING_TABLE_LOOKUP(job_mode, JobMode);