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