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