src/core/job.h

   1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
   2 #pragma once
   3
   4 #include <stdbool.h>
   5
   6 #include "sd-event.h"
   7
   8 #include "list.h"
   9 #include "unit-dependency-atom.h"
  10 #include "unit-name.h"
  11 #include "unit.h"
  12
  13 typedef struct ActivationDetails ActivationDetails;
  14 typedef struct Job Job;
  15 typedef struct JobDependency JobDependency;
  16 typedef enum JobType JobType;
  17 typedef enum JobState JobState;
  18 typedef enum JobMode JobMode;
  19 typedef enum JobResult JobResult;
  20
  21 /* Be careful when changing the job types! Adjust job_merging_table[] accordingly! */
  22 enum JobType {
  23         JOB_START,                  /* if a unit does not support being started, we'll just wait until it becomes active */
  24         JOB_VERIFY_ACTIVE,
  25
  26         JOB_STOP,
  27
  28         JOB_RELOAD,                 /* if running, reload */
  29
  30         /* Note that restarts are first treated like JOB_STOP, but
  31          * then instead of finishing are patched to become
  32          * JOB_START. */
  33         JOB_RESTART,                /* If running, stop. Then start unconditionally. */
  34
  35         _JOB_TYPE_MAX_MERGING,
  36
  37         /* JOB_NOP can enter into a transaction, but as it won't pull in
  38          * any dependencies and it uses the special 'nop_job' slot in Unit,
  39          * it won't have to merge with anything (except possibly into another
  40          * JOB_NOP, previously installed). JOB_NOP is special-cased in
  41          * job_type_is_*() functions so that the transaction can be
  42          * activated. */
  43         JOB_NOP = _JOB_TYPE_MAX_MERGING, /* do nothing */
  44
  45         _JOB_TYPE_MAX_IN_TRANSACTION,
  46
  47         /* JOB_TRY_RESTART can never appear in a transaction, because
  48          * it always collapses into JOB_RESTART or JOB_NOP before entering.
  49          * Thus we never need to merge it with anything. */
  50         JOB_TRY_RESTART = _JOB_TYPE_MAX_IN_TRANSACTION, /* if running, stop and then start */
  51
  52         /* Similar to JOB_TRY_RESTART but collapses to JOB_RELOAD or JOB_NOP */
  53         JOB_TRY_RELOAD,
  54
  55         /* JOB_RELOAD_OR_START won't enter into a transaction and cannot result
  56          * from transaction merging (there's no way for JOB_RELOAD and
  57          * JOB_START to meet in one transaction). It can result from a merge
  58          * during job installation, but then it will immediately collapse into
  59          * one of the two simpler types. */
  60         JOB_RELOAD_OR_START,        /* if running, reload, otherwise start */
  61
  62         _JOB_TYPE_MAX,
  63         _JOB_TYPE_INVALID = -EINVAL,
  64 };
  65
  66 enum JobState {
  67         JOB_WAITING,
  68         JOB_RUNNING,
  69         _JOB_STATE_MAX,
  70         _JOB_STATE_INVALID = -EINVAL,
  71 };
  72
  73 enum JobMode {
  74         JOB_FAIL,                /* Fail if a conflicting job is already queued */
  75         JOB_REPLACE,             /* Replace an existing conflicting job */
  76         JOB_REPLACE_IRREVERSIBLY,/* Like JOB_REPLACE + produce irreversible jobs */
  77         JOB_ISOLATE,             /* Start a unit, and stop all others */
  78         JOB_FLUSH,               /* Flush out all other queued jobs when queueing this one */
  79         JOB_IGNORE_DEPENDENCIES, /* Ignore both requirement and ordering dependencies */
  80         JOB_IGNORE_REQUIREMENTS, /* Ignore requirement dependencies */
  81         JOB_TRIGGERING,          /* Adds TRIGGERED_BY dependencies to the same transaction */
  82         _JOB_MODE_MAX,
  83         _JOB_MODE_INVALID = -EINVAL,
  84 };
  85
  86 enum JobResult {
  87         JOB_DONE,                /* Job completed successfully (or skipped due to an unmet ConditionXYZ=) */
  88         JOB_CANCELED,            /* Job canceled by a conflicting job installation or by explicit cancel request */
  89         JOB_TIMEOUT,             /* Job timeout elapsed */
  90         JOB_FAILED,              /* Job failed */
  91         JOB_DEPENDENCY,          /* A required dependency job did not result in JOB_DONE */
  92         JOB_SKIPPED,             /* Negative result of JOB_VERIFY_ACTIVE or skip due to ExecCondition= */
  93         JOB_INVALID,             /* JOB_RELOAD of inactive unit */
  94         JOB_ASSERT,              /* Couldn't start a unit, because an assert didn't hold */
  95         JOB_UNSUPPORTED,         /* Couldn't start a unit, because the unit type is not supported on the system */
  96         JOB_COLLECTED,           /* Job was garbage collected, since nothing needed it anymore */
  97         JOB_ONCE,                /* Unit was started before, and hence can't be started again */
  98         _JOB_RESULT_MAX,
  99         _JOB_RESULT_INVALID = -EINVAL,
 100 };
 101
 102 struct JobDependency {
 103         /* Encodes that the 'subject' job needs the 'object' job in
 104          * some way. This structure is used only while building a transaction. */
 105         Job *subject;
 106         Job *object;
 107
 108         LIST_FIELDS(JobDependency, subject);
 109         LIST_FIELDS(JobDependency, object);
 110
 111         bool matters:1;
 112         bool conflicts:1;
 113 };
 114
 115 struct Job {
 116         Manager *manager;
 117         Unit *unit;
 118
 119         LIST_FIELDS(Job, transaction);
 120         LIST_FIELDS(Job, dbus_queue);
 121         LIST_FIELDS(Job, gc_queue);
 122
 123         LIST_HEAD(JobDependency, subject_list);
 124         LIST_HEAD(JobDependency, object_list);
 125
 126         /* Used for graph algs as a "I have been here" marker */
 127         Job* marker;
 128         unsigned generation;
 129
 130         uint32_t id;
 131
 132         JobType type;
 133         JobState state;
 134
 135         sd_event_source *timer_event_source;
 136         usec_t begin_usec;
 137         usec_t begin_running_usec;
 138
 139         /*
 140          * This tracks where to send signals, and also which clients
 141          * are allowed to call DBus methods on the job (other than
 142          * root).
 143          *
 144          * There can be more than one client, because of job merging.
 145          */
 146         sd_bus_track *bus_track;
 147         char **deserialized_clients;
 148
 149         JobResult result;
 150
 151         unsigned run_queue_idx;
 152
 153         /* If the job had a specific trigger that needs to be advertised (eg: a path unit), store it. */
 154         ActivationDetails *activation_details;
 155
 156         bool installed:1;
 157         bool in_run_queue:1;
 158         bool matters_to_anchor:1;
 159         bool in_dbus_queue:1;
 160         bool sent_dbus_new_signal:1;
 161         bool ignore_order:1;
 162         bool irreversible:1;
 163         bool in_gc_queue:1;
 164         bool ref_by_private_bus:1;
 165 };
 166
 167 Job* job_new(Unit *unit, JobType type);
 168 Job* job_new_raw(Unit *unit);
 169 void job_unlink(Job *job);
 170 Job* job_free(Job *job);
 171 Job* job_install(Job *j);
 172 int job_install_deserialized(Job *j);
 173 void job_uninstall(Job *j);
 174 void job_dump(Job *j, FILE *f, const char *prefix);
 175 int job_serialize(Job *j, FILE *f);
 176 int job_deserialize(Job *j, FILE *f);
 177 int job_coldplug(Job *j);
 178
 179 JobDependency* job_dependency_new(Job *subject, Job *object, bool matters, bool conflicts);
 180 void job_dependency_free(JobDependency *l);
 181
 182 int job_merge(Job *j, Job *other);
 183
 184 JobType job_type_lookup_merge(JobType a, JobType b) _pure_;
 185
 186 _pure_ static inline bool job_type_is_mergeable(JobType a, JobType b) {
 187         return job_type_lookup_merge(a, b) >= 0;
 188 }
 189
 190 _pure_ static inline bool job_type_is_conflicting(JobType a, JobType b) {
 191         return a != JOB_NOP && b != JOB_NOP && !job_type_is_mergeable(a, b);
 192 }
 193
 194 _pure_ static inline bool job_type_is_superset(JobType a, JobType b) {
 195         /* Checks whether operation a is a "superset" of b in its actions */
 196         if (b == JOB_NOP)
 197                 return true;
 198         if (a == JOB_NOP)
 199                 return false;
 200         return a == job_type_lookup_merge(a, b);
 201 }
 202
 203 bool job_type_is_redundant(JobType a, UnitActiveState b) _pure_;
 204
 205 /* Collapses a state-dependent job type into a simpler type by observing
 206  * the state of the unit which it is going to be applied to. */
 207 JobType job_type_collapse(JobType t, Unit *u);
 208
 209 int job_type_merge_and_collapse(JobType *a, JobType b, Unit *u);
 210
 211 void job_add_to_run_queue(Job *j);
 212 void job_add_to_dbus_queue(Job *j);
 213
 214 int job_start_timer(Job *j, bool job_running);
 215
 216 int job_run_and_invalidate(Job *j);
 217 int job_finish_and_invalidate(Job *j, JobResult result, bool recursive, bool already);
 218
 219 char *job_dbus_path(Job *j);
 220
 221 void job_shutdown_magic(Job *j);
 222
 223 int job_get_timeout(Job *j, usec_t *timeout);
 224
 225 bool job_may_gc(Job *j);
 226 void job_add_to_gc_queue(Job *j);
 227
 228 int job_get_before(Job *j, Job*** ret);
 229 int job_get_after(Job *j, Job*** ret);
 230
 231 DEFINE_TRIVIAL_CLEANUP_FUNC(Job*, job_free);
 232
 233 const char* job_type_to_string(JobType t) _const_;
 234 JobType job_type_from_string(const char *s) _pure_;
 235
 236 const char* job_state_to_string(JobState t) _const_;
 237 JobState job_state_from_string(const char *s) _pure_;
 238
 239 const char* job_mode_to_string(JobMode t) _const_;
 240 JobMode job_mode_from_string(const char *s) _pure_;
 241
 242 const char* job_result_to_string(JobResult t) _const_;
 243 JobResult job_result_from_string(const char *s) _pure_;
 244
 245 const char* job_type_to_access_method(JobType t);
 246
 247 int job_compare(Job *a, Job *b, UnitDependencyAtom assume_dep);
 248
 249 void job_set_activation_details(Job *j, ActivationDetails *info);