src/core/job.h

   1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
   2
   3 #ifndef foojobhfoo
   4 #define foojobhfoo
   5
   6 /***
   7   This file is part of systemd.
   8
   9   Copyright 2010 Lennart Poettering
  10
  11   systemd is free software; you can redistribute it and/or modify it
  12   under the terms of the GNU Lesser General Public License as published by
  13   the Free Software Foundation; either version 2.1 of the License, or
  14   (at your option) any later version.
  15
  16   systemd is distributed in the hope that it will be useful, but
  17   WITHOUT ANY WARRANTY; without even the implied warranty of
  18   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  19   Lesser General Public License for more details.
  20
  21   You should have received a copy of the GNU Lesser General Public License
  22   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  23 ***/
  24
  25 #include <stdbool.h>
  26 #include <inttypes.h>
  27 #include <errno.h>
  28
  29 typedef struct Job Job;
  30 typedef struct JobDependency JobDependency;
  31 typedef struct JobBusClient JobBusClient;
  32 typedef enum JobType JobType;
  33 typedef enum JobState JobState;
  34 typedef enum JobMode JobMode;
  35 typedef enum JobResult JobResult;
  36
  37 #include "manager.h"
  38 #include "unit.h"
  39 #include "hashmap.h"
  40 #include "list.h"
  41
  42 /* Be careful when changing the job types! Adjust job_merging_table[] accordingly! */
  43 enum JobType {
  44         JOB_START,                  /* if a unit does not support being started, we'll just wait until it becomes active */
  45         JOB_VERIFY_ACTIVE,
  46
  47         JOB_STOP,
  48
  49         JOB_RELOAD,                 /* if running reload */
  50         JOB_RELOAD_OR_START,        /* if running reload, if not running start */
  51
  52         /* Note that restarts are first treated like JOB_STOP, but
  53          * then instead of finishing are patched to become
  54          * JOB_START. */
  55         JOB_RESTART,                /* if running stop, then start unconditionally */
  56         JOB_TRY_RESTART,            /* if running stop and then start */
  57
  58         _JOB_TYPE_MAX,
  59         _JOB_TYPE_INVALID = -1
  60 };
  61
  62 enum JobState {
  63         JOB_WAITING,
  64         JOB_RUNNING,
  65         _JOB_STATE_MAX,
  66         _JOB_STATE_INVALID = -1
  67 };
  68
  69 enum JobMode {
  70         JOB_FAIL,                /* Fail if a conflicting job is already queued */
  71         JOB_REPLACE,             /* Replace an existing conflicting job */
  72         JOB_ISOLATE,             /* Start a unit, and stop all others */
  73         JOB_IGNORE_DEPENDENCIES, /* Ignore both requirement and ordering dependencies */
  74         JOB_IGNORE_REQUIREMENTS, /* Ignore requirement dependencies */
  75         _JOB_MODE_MAX,
  76         _JOB_MODE_INVALID = -1
  77 };
  78
  79 enum JobResult {
  80         JOB_DONE,
  81         JOB_CANCELED,
  82         JOB_TIMEOUT,
  83         JOB_FAILED,
  84         JOB_DEPENDENCY,
  85         JOB_SKIPPED,
  86         _JOB_RESULT_MAX,
  87         _JOB_RESULT_INVALID = -1
  88 };
  89
  90 struct JobDependency {
  91         /* Encodes that the 'subject' job needs the 'object' job in
  92          * some way. This structure is used only while building a transaction. */
  93         Job *subject;
  94         Job *object;
  95
  96         LIST_FIELDS(JobDependency, subject);
  97         LIST_FIELDS(JobDependency, object);
  98
  99         bool matters;
 100         bool conflicts;
 101 };
 102
 103 struct JobBusClient {
 104         LIST_FIELDS(JobBusClient, client);
 105         /* Note that this bus object is not ref counted here. */
 106         DBusConnection *bus;
 107         char name[0];
 108 };
 109
 110 struct Job {
 111         Manager *manager;
 112         Unit *unit;
 113
 114         LIST_FIELDS(Job, transaction);
 115         LIST_FIELDS(Job, run_queue);
 116         LIST_FIELDS(Job, dbus_queue);
 117
 118         LIST_HEAD(JobDependency, subject_list);
 119         LIST_HEAD(JobDependency, object_list);
 120
 121         /* Used for graph algs as a "I have been here" marker */
 122         Job* marker;
 123         unsigned generation;
 124
 125         uint32_t id;
 126
 127         JobType type;
 128         JobState state;
 129
 130         Watch timer_watch;
 131
 132         /* There can be more than one client, because of job merging. */
 133         LIST_HEAD(JobBusClient, bus_client_list);
 134
 135         JobResult result;
 136
 137         bool installed:1;
 138         bool in_run_queue:1;
 139         bool matters_to_anchor:1;
 140         bool override:1;
 141         bool in_dbus_queue:1;
 142         bool sent_dbus_new_signal:1;
 143         bool ignore_order:1;
 144 };
 145
 146 JobBusClient* job_bus_client_new(DBusConnection *connection, const char *name);
 147
 148 Job* job_new(Unit *unit, JobType type);
 149 void job_free(Job *job);
 150 Job* job_install(Job *j);
 151 void job_uninstall(Job *j);
 152 void job_dump(Job *j, FILE*f, const char *prefix);
 153
 154 JobDependency* job_dependency_new(Job *subject, Job *object, bool matters, bool conflicts);
 155 void job_dependency_free(JobDependency *l);
 156
 157 int job_merge(Job *j, Job *other);
 158
 159 JobType job_type_lookup_merge(JobType a, JobType b);
 160
 161 static inline int job_type_merge(JobType *a, JobType b) {
 162         JobType t = job_type_lookup_merge(*a, b);
 163         if (t < 0)
 164                 return -EEXIST;
 165         *a = t;
 166         return 0;
 167 }
 168
 169 static inline bool job_type_is_mergeable(JobType a, JobType b) {
 170         return job_type_lookup_merge(a, b) >= 0;
 171 }
 172
 173 static inline bool job_type_is_conflicting(JobType a, JobType b) {
 174         return !job_type_is_mergeable(a, b);
 175 }
 176
 177 static inline bool job_type_is_superset(JobType a, JobType b) {
 178         /* Checks whether operation a is a "superset" of b in its actions */
 179         return a == job_type_lookup_merge(a, b);
 180 }
 181
 182 bool job_type_is_redundant(JobType a, UnitActiveState b);
 183
 184 bool job_is_runnable(Job *j);
 185
 186 void job_add_to_run_queue(Job *j);
 187 void job_add_to_dbus_queue(Job *j);
 188
 189 int job_start_timer(Job *j);
 190 void job_timer_event(Job *j, uint64_t n_elapsed, Watch *w);
 191
 192 int job_run_and_invalidate(Job *j);
 193 int job_finish_and_invalidate(Job *j, JobResult result);
 194
 195 char *job_dbus_path(Job *j);
 196
 197 const char* job_type_to_string(JobType t);
 198 JobType job_type_from_string(const char *s);
 199
 200 const char* job_state_to_string(JobState t);
 201 JobState job_state_from_string(const char *s);
 202
 203 const char* job_mode_to_string(JobMode t);
 204 JobMode job_mode_from_string(const char *s);
 205
 206 const char* job_result_to_string(JobResult t);
 207 JobResult job_result_from_string(const char *s);
 208
 209 #endif