src/core/job.h

   1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
   2
   3 #pragma once
   4
   5 /***
   6   This file is part of systemd.
   7
   8   Copyright 2010 Lennart Poettering
   9
  10   systemd is free software; you can redistribute it and/or modify it
  11   under the terms of the GNU Lesser General Public License as published by
  12   the Free Software Foundation; either version 2.1 of the License, or
  13   (at your option) any later version.
  14
  15   systemd is distributed in the hope that it will be useful, but
  16   WITHOUT ANY WARRANTY; without even the implied warranty of
  17   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  18   Lesser General Public License for more details.
  19
  20   You should have received a copy of the GNU Lesser General Public License
  21   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  22 ***/
  23
  24 #include <stdbool.h>
  25 #include <inttypes.h>
  26 #include <errno.h>
  27
  28 typedef struct Job Job;
  29 typedef struct JobDependency JobDependency;
  30 typedef enum JobType JobType;
  31 typedef enum JobState JobState;
  32 typedef enum JobMode JobMode;
  33 typedef enum JobResult JobResult;
  34
  35 /* Be careful when changing the job types! Adjust job_merging_table[] accordingly! */
  36 enum JobType {
  37         JOB_START,                  /* if a unit does not support being started, we'll just wait until it becomes active */
  38         JOB_VERIFY_ACTIVE,
  39
  40         JOB_STOP,
  41
  42         JOB_RELOAD,                 /* if running, reload */
  43
  44         /* Note that restarts are first treated like JOB_STOP, but
  45          * then instead of finishing are patched to become
  46          * JOB_START. */
  47         JOB_RESTART,                /* If running, stop. Then start unconditionally. */
  48
  49         _JOB_TYPE_MAX_MERGING,
  50
  51         /* JOB_NOP can enter into a transaction, but as it won't pull in
  52          * any dependencies, it won't have to merge with anything.
  53          * job_install() avoids the problem of merging JOB_NOP too (it's
  54          * special-cased, only merges with other JOB_NOPs). */
  55         JOB_NOP = _JOB_TYPE_MAX_MERGING, /* do nothing */
  56
  57         _JOB_TYPE_MAX_IN_TRANSACTION,
  58
  59         /* JOB_TRY_RESTART can never appear in a transaction, because
  60          * it always collapses into JOB_RESTART or JOB_NOP before entering.
  61          * Thus we never need to merge it with anything. */
  62         JOB_TRY_RESTART = _JOB_TYPE_MAX_IN_TRANSACTION, /* if running, stop and then start */
  63
  64         /* JOB_RELOAD_OR_START won't enter into a transaction and cannot result
  65          * from transaction merging (there's no way for JOB_RELOAD and
  66          * JOB_START to meet in one transaction). It can result from a merge
  67          * during job installation, but then it will immediately collapse into
  68          * one of the two simpler types. */
  69         JOB_RELOAD_OR_START,        /* if running, reload, otherwise start */
  70
  71         _JOB_TYPE_MAX,
  72         _JOB_TYPE_INVALID = -1
  73 };
  74
  75 enum JobState {
  76         JOB_WAITING,
  77         JOB_RUNNING,
  78         _JOB_STATE_MAX,
  79         _JOB_STATE_INVALID = -1
  80 };
  81
  82 enum JobMode {
  83         JOB_FAIL,                /* Fail if a conflicting job is already queued */
  84         JOB_REPLACE,             /* Replace an existing conflicting job */
  85         JOB_REPLACE_IRREVERSIBLY,/* Like JOB_REPLACE + produce irreversible jobs */
  86         JOB_ISOLATE,             /* Start a unit, and stop all others */
  87         JOB_FLUSH,               /* Flush out all other queued jobs when queing this one */
  88         JOB_IGNORE_DEPENDENCIES, /* Ignore both requirement and ordering dependencies */
  89         JOB_IGNORE_REQUIREMENTS, /* Ignore requirement dependencies */
  90         _JOB_MODE_MAX,
  91         _JOB_MODE_INVALID = -1
  92 };
  93
  94 enum JobResult {
  95         JOB_DONE,                /* Job completed successfully */
  96         JOB_CANCELED,            /* Job canceled by a conflicting job installation or by explicit cancel request */
  97         JOB_TIMEOUT,             /* JobTimeout elapsed */
  98         JOB_FAILED,              /* Job failed */
  99         JOB_DEPENDENCY,          /* A required dependency job did not result in JOB_DONE */
 100         JOB_SKIPPED,             /* Negative result of JOB_VERIFY_ACTIVE */
 101         JOB_INVALID,             /* JOB_RELOAD of inactive unit */
 102         JOB_ASSERT,              /* Couldn't start a unit, because an assert didn't hold */
 103         _JOB_RESULT_MAX,
 104         _JOB_RESULT_INVALID = -1
 105 };
 106
 107 #include "sd-event.h"
 108 #include "manager.h"
 109 #include "unit.h"
 110 #include "hashmap.h"
 111 #include "list.h"
 112
 113 struct JobDependency {
 114         /* Encodes that the 'subject' job needs the 'object' job in
 115          * some way. This structure is used only while building a transaction. */
 116         Job *subject;
 117         Job *object;
 118
 119         LIST_FIELDS(JobDependency, subject);
 120         LIST_FIELDS(JobDependency, object);
 121
 122         bool matters;
 123         bool conflicts;
 124 };
 125
 126 struct Job {
 127         Manager *manager;
 128         Unit *unit;
 129
 130         LIST_FIELDS(Job, transaction);
 131         LIST_FIELDS(Job, run_queue);
 132         LIST_FIELDS(Job, dbus_queue);
 133
 134         LIST_HEAD(JobDependency, subject_list);
 135         LIST_HEAD(JobDependency, object_list);
 136
 137         /* Used for graph algs as a "I have been here" marker */
 138         Job* marker;
 139         unsigned generation;
 140
 141         uint32_t id;
 142
 143         JobType type;
 144         JobState state;
 145
 146         sd_event_source *timer_event_source;
 147         usec_t begin_usec;
 148
 149         /*
 150          * This tracks where to send signals, and also which clients
 151          * are allowed to call DBus methods on the job (other than
 152          * root).
 153          *
 154          * There can be more than one client, because of job merging.
 155          */
 156         sd_bus_track *clients;
 157         char **deserialized_clients;
 158
 159         JobResult result;
 160
 161         bool installed:1;
 162         bool in_run_queue:1;
 163         bool matters_to_anchor:1;
 164         bool override:1;
 165         bool in_dbus_queue:1;
 166         bool sent_dbus_new_signal:1;
 167         bool ignore_order:1;
 168         bool irreversible:1;
 169 };
 170
 171 Job* job_new(Unit *unit, JobType type);
 172 Job* job_new_raw(Unit *unit);
 173 void job_free(Job *job);
 174 Job* job_install(Job *j);
 175 int job_install_deserialized(Job *j);
 176 void job_uninstall(Job *j);
 177 void job_dump(Job *j, FILE*f, const char *prefix);
 178 int job_serialize(Job *j, FILE *f, FDSet *fds);
 179 int job_deserialize(Job *j, FILE *f, FDSet *fds);
 180 int job_coldplug(Job *j);
 181
 182 JobDependency* job_dependency_new(Job *subject, Job *object, bool matters, bool conflicts);
 183 void job_dependency_free(JobDependency *l);
 184
 185 int job_merge(Job *j, Job *other);
 186
 187 JobType job_type_lookup_merge(JobType a, JobType b) _pure_;
 188
 189 _pure_ static inline bool job_type_is_mergeable(JobType a, JobType b) {
 190         return job_type_lookup_merge(a, b) >= 0;
 191 }
 192
 193 _pure_ static inline bool job_type_is_conflicting(JobType a, JobType b) {
 194         return !job_type_is_mergeable(a, b);
 195 }
 196
 197 _pure_ static inline bool job_type_is_superset(JobType a, JobType b) {
 198         /* Checks whether operation a is a "superset" of b in its actions */
 199         return a == job_type_lookup_merge(a, b);
 200 }
 201
 202 bool job_type_is_redundant(JobType a, UnitActiveState b) _pure_;
 203
 204 /* Collapses a state-dependent job type into a simpler type by observing
 205  * the state of the unit which it is going to be applied to. */
 206 void job_type_collapse(JobType *t, Unit *u);
 207
 208 int job_type_merge_and_collapse(JobType *a, JobType b, Unit *u);
 209
 210 void job_add_to_run_queue(Job *j);
 211 void job_add_to_dbus_queue(Job *j);
 212
 213 int job_start_timer(Job *j);
 214
 215 int job_run_and_invalidate(Job *j);
 216 int job_finish_and_invalidate(Job *j, JobResult result, bool recursive);
 217
 218 char *job_dbus_path(Job *j);
 219
 220 void job_shutdown_magic(Job *j);
 221
 222 const char* job_type_to_string(JobType t) _const_;
 223 JobType job_type_from_string(const char *s) _pure_;
 224
 225 const char* job_state_to_string(JobState t) _const_;
 226 JobState job_state_from_string(const char *s) _pure_;
 227
 228 const char* job_mode_to_string(JobMode t) _const_;
 229 JobMode job_mode_from_string(const char *s) _pure_;
 230
 231 const char* job_result_to_string(JobResult t) _const_;
 232 JobResult job_result_from_string(const char *s) _pure_;
 233
 234 int job_get_timeout(Job *j, uint64_t *timeout) _pure_;