src/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 General Public License as published by
  13   the Free Software Foundation; either version 2 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   General Public License for more details.
  20
  21   You should have received a copy of the GNU 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
  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 #include "manager.h"
  36 #include "unit.h"
  37 #include "hashmap.h"
  38 #include "list.h"
  39
  40 enum JobType {
  41         JOB_START,                  /* if a unit does not support being started, we'll just wait until it becomes active */
  42         JOB_VERIFY_ACTIVE,
  43
  44         JOB_STOP,
  45
  46         JOB_RELOAD,                 /* if running reload */
  47         JOB_RELOAD_OR_START,        /* if running reload, if not running start */
  48
  49         /* Note that restarts are first treated like JOB_STOP, but
  50          * then instead of finishing are patched to become
  51          * JOB_START. */
  52         JOB_RESTART,                /* if running stop, then start unconditionally */
  53         JOB_TRY_RESTART,            /* if running stop and then start */
  54
  55         _JOB_TYPE_MAX,
  56         _JOB_TYPE_INVALID = -1
  57 };
  58
  59 enum JobState {
  60         JOB_WAITING,
  61         JOB_RUNNING,
  62         _JOB_STATE_MAX,
  63         _JOB_STATE_INVALID = -1
  64 };
  65
  66 enum JobMode {
  67         JOB_FAIL,                /* Fail if a conflicting job is already queued */
  68         JOB_REPLACE,             /* Replace an existing conflicting job */
  69         JOB_ISOLATE,             /* Start a unit, and stop all others */
  70         JOB_IGNORE_DEPENDENCIES, /* Ignore both requirement and ordering dependencies */
  71         JOB_IGNORE_REQUIREMENTS, /* Ignore requirement dependencies */
  72         _JOB_MODE_MAX,
  73         _JOB_MODE_INVALID = -1
  74 };
  75
  76 enum JobResult {
  77         JOB_DONE,
  78         JOB_CANCELED,
  79         JOB_TIMEOUT,
  80         JOB_FAILED,
  81         JOB_DEPENDENCY,
  82         JOB_SKIPPED,
  83         _JOB_RESULT_MAX,
  84         _JOB_RESULT_INVALID = -1
  85 };
  86
  87 struct JobDependency {
  88         /* Encodes that the 'subject' job needs the 'object' job in
  89          * some way. This structure is used only while building a transaction. */
  90         Job *subject;
  91         Job *object;
  92
  93         LIST_FIELDS(JobDependency, subject);
  94         LIST_FIELDS(JobDependency, object);
  95
  96         bool matters;
  97         bool conflicts;
  98 };
  99
 100 struct Job {
 101         Manager *manager;
 102         Unit *unit;
 103
 104         LIST_FIELDS(Job, transaction);
 105         LIST_FIELDS(Job, run_queue);
 106         LIST_FIELDS(Job, dbus_queue);
 107
 108         LIST_HEAD(JobDependency, subject_list);
 109         LIST_HEAD(JobDependency, object_list);
 110
 111         /* Used for graph algs as a "I have been here" marker */
 112         Job* marker;
 113         unsigned generation;
 114
 115         uint32_t id;
 116
 117         JobType type;
 118         JobState state;
 119
 120         Watch timer_watch;
 121
 122         /* Note that this bus object is not ref counted here. */
 123         DBusConnection *bus;
 124         char *bus_client;
 125
 126         JobResult result;
 127
 128         bool installed:1;
 129         bool in_run_queue:1;
 130         bool matters_to_anchor:1;
 131         bool override:1;
 132         bool in_dbus_queue:1;
 133         bool sent_dbus_new_signal:1;
 134         bool ignore_order:1;
 135 };
 136
 137 Job* job_new(Manager *m, JobType type, Unit *unit);
 138 void job_free(Job *job);
 139 void job_dump(Job *j, FILE*f, const char *prefix);
 140
 141 JobDependency* job_dependency_new(Job *subject, Job *object, bool matters, bool conflicts);
 142 void job_dependency_free(JobDependency *l);
 143
 144 bool job_is_anchor(Job *j);
 145
 146 int job_merge(Job *j, Job *other);
 147
 148 int job_type_merge(JobType *a, JobType b);
 149 bool job_type_is_mergeable(JobType a, JobType b);
 150 bool job_type_is_superset(JobType a, JobType b);
 151 bool job_type_is_conflicting(JobType a, JobType b);
 152 bool job_type_is_redundant(JobType a, UnitActiveState b);
 153
 154 bool job_is_runnable(Job *j);
 155
 156 void job_add_to_run_queue(Job *j);
 157 void job_add_to_dbus_queue(Job *j);
 158
 159 int job_start_timer(Job *j);
 160 void job_timer_event(Job *j, uint64_t n_elapsed, Watch *w);
 161
 162 int job_run_and_invalidate(Job *j);
 163 int job_finish_and_invalidate(Job *j, JobResult result);
 164
 165 char *job_dbus_path(Job *j);
 166
 167 const char* job_type_to_string(JobType t);
 168 JobType job_type_from_string(const char *s);
 169
 170 const char* job_state_to_string(JobState t);
 171 JobState job_state_from_string(const char *s);
 172
 173 const char* job_mode_to_string(JobMode t);
 174 JobMode job_mode_from_string(const char *s);
 175
 176 const char* job_result_to_string(JobResult t);
 177 JobResult job_result_from_string(const char *s);
 178
 179 #endif