1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
6 This file is part of systemd.
8 Copyright 2010 Lennart Poettering
10 systemd is free software; you can redistribute it and/or modify it
11 under the terms of the GNU Lesser General Public License as published by
12 the Free Software Foundation; either version 2.1 of the License, or
13 (at your option) any later version.
15 systemd is distributed in the hope that it will be useful, but
16 WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 Lesser General Public License for more details.
20 You should have received a copy of the GNU Lesser General Public License
21 along with systemd; If not, see <http://www.gnu.org/licenses/>.
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;
35 /* Be careful when changing the job types! Adjust job_merging_table[] accordingly! */
37 JOB_START, /* if a unit does not support being started, we'll just wait until it becomes active */
42 JOB_RELOAD, /* if running, reload */
44 /* Note that restarts are first treated like JOB_STOP, but
45 * then instead of finishing are patched to become
47 JOB_RESTART, /* If running, stop. Then start unconditionally. */
49 _JOB_TYPE_MAX_MERGING,
51 /* JOB_NOP can enter into a transaction, but as it won't pull in
52 * any dependencies, it won't have to merge with anything.
53 * job_install() avoids the problem of merging JOB_NOP too (it's
54 * special-cased, only merges with other JOB_NOPs). */
55 JOB_NOP = _JOB_TYPE_MAX_MERGING, /* do nothing */
57 _JOB_TYPE_MAX_IN_TRANSACTION,
59 /* JOB_TRY_RESTART can never appear in a transaction, because
60 * it always collapses into JOB_RESTART or JOB_NOP before entering.
61 * Thus we never need to merge it with anything. */
62 JOB_TRY_RESTART = _JOB_TYPE_MAX_IN_TRANSACTION, /* if running, stop and then start */
64 /* JOB_RELOAD_OR_START won't enter into a transaction and cannot result
65 * from transaction merging (there's no way for JOB_RELOAD and
66 * JOB_START to meet in one transaction). It can result from a merge
67 * during job installation, but then it will immediately collapse into
68 * one of the two simpler types. */
69 JOB_RELOAD_OR_START, /* if running, reload, otherwise start */
72 _JOB_TYPE_INVALID = -1
79 _JOB_STATE_INVALID = -1
83 JOB_FAIL, /* Fail if a conflicting job is already queued */
84 JOB_REPLACE, /* Replace an existing conflicting job */
85 JOB_REPLACE_IRREVERSIBLY,/* Like JOB_REPLACE + produce irreversible jobs */
86 JOB_ISOLATE, /* Start a unit, and stop all others */
87 JOB_FLUSH, /* Flush out all other queued jobs when queing this one */
88 JOB_IGNORE_DEPENDENCIES, /* Ignore both requirement and ordering dependencies */
89 JOB_IGNORE_REQUIREMENTS, /* Ignore requirement dependencies */
91 _JOB_MODE_INVALID = -1
95 JOB_DONE, /* Job completed successfully */
96 JOB_CANCELED, /* Job canceled by a conflicting job installation or by explicit cancel request */
97 JOB_TIMEOUT, /* JobTimeout elapsed */
98 JOB_FAILED, /* Job failed */
99 JOB_DEPENDENCY, /* A required dependency job did not result in JOB_DONE */
100 JOB_SKIPPED, /* JOB_RELOAD of inactive unit; negative result of JOB_VERIFY_ACTIVE */
102 _JOB_RESULT_INVALID = -1
105 #include "sd-event.h"
111 struct JobDependency {
112 /* Encodes that the 'subject' job needs the 'object' job in
113 * some way. This structure is used only while building a transaction. */
117 LIST_FIELDS(JobDependency, subject);
118 LIST_FIELDS(JobDependency, object);
128 LIST_FIELDS(Job, transaction);
129 LIST_FIELDS(Job, run_queue);
130 LIST_FIELDS(Job, dbus_queue);
132 LIST_HEAD(JobDependency, subject_list);
133 LIST_HEAD(JobDependency, object_list);
135 /* Used for graph algs as a "I have been here" marker */
144 sd_event_source *timer_event_source;
147 /* There can be more than one client, because of job merging. */
154 bool matters_to_anchor:1;
156 bool in_dbus_queue:1;
157 bool sent_dbus_new_signal:1;
162 Job* job_new(Unit *unit, JobType type);
163 Job* job_new_raw(Unit *unit);
164 void job_free(Job *job);
165 Job* job_install(Job *j);
166 int job_install_deserialized(Job *j);
167 void job_uninstall(Job *j);
168 void job_dump(Job *j, FILE*f, const char *prefix);
169 int job_serialize(Job *j, FILE *f, FDSet *fds);
170 int job_deserialize(Job *j, FILE *f, FDSet *fds);
171 int job_coldplug(Job *j);
173 JobDependency* job_dependency_new(Job *subject, Job *object, bool matters, bool conflicts);
174 void job_dependency_free(JobDependency *l);
176 int job_merge(Job *j, Job *other);
178 JobType job_type_lookup_merge(JobType a, JobType b) _pure_;
180 _pure_ static inline bool job_type_is_mergeable(JobType a, JobType b) {
181 return job_type_lookup_merge(a, b) >= 0;
184 _pure_ static inline bool job_type_is_conflicting(JobType a, JobType b) {
185 return !job_type_is_mergeable(a, b);
188 _pure_ static inline bool job_type_is_superset(JobType a, JobType b) {
189 /* Checks whether operation a is a "superset" of b in its actions */
190 return a == job_type_lookup_merge(a, b);
193 bool job_type_is_redundant(JobType a, UnitActiveState b) _pure_;
195 /* Collapses a state-dependent job type into a simpler type by observing
196 * the state of the unit which it is going to be applied to. */
197 void job_type_collapse(JobType *t, Unit *u);
199 int job_type_merge_and_collapse(JobType *a, JobType b, Unit *u);
201 void job_add_to_run_queue(Job *j);
202 void job_add_to_dbus_queue(Job *j);
204 int job_start_timer(Job *j);
206 int job_run_and_invalidate(Job *j);
207 int job_finish_and_invalidate(Job *j, JobResult result, bool recursive);
209 char *job_dbus_path(Job *j);
211 void job_shutdown_magic(Job *j);
213 const char* job_type_to_string(JobType t) _const_;
214 JobType job_type_from_string(const char *s) _pure_;
216 const char* job_state_to_string(JobState t) _const_;
217 JobState job_state_from_string(const char *s) _pure_;
219 const char* job_mode_to_string(JobMode t) _const_;
220 JobMode job_mode_from_string(const char *s) _pure_;
222 const char* job_result_to_string(JobResult t) _const_;
223 JobResult job_result_from_string(const char *s) _pure_;