src/job.c

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