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 struct JobBusClient JobBusClient;
31 typedef enum JobType JobType;
32 typedef enum JobState JobState;
33 typedef enum JobMode JobMode;
34 typedef enum JobResult JobResult;
36 /* Be careful when changing the job types! Adjust job_merging_table[] accordingly! */
38 JOB_START, /* if a unit does not support being started, we'll just wait until it becomes active */
43 JOB_RELOAD, /* if running, reload */
45 /* Note that restarts are first treated like JOB_STOP, but
46 * then instead of finishing are patched to become
48 JOB_RESTART, /* If running, stop. Then start unconditionally. */
50 _JOB_TYPE_MAX_MERGING,
52 /* JOB_NOP can enter into a transaction, but as it won't pull in
53 * any dependencies, it won't have to merge with anything.
54 * job_install() avoids the problem of merging JOB_NOP too (it's
55 * special-cased, only merges with other JOB_NOPs). */
56 JOB_NOP = _JOB_TYPE_MAX_MERGING, /* do nothing */
58 _JOB_TYPE_MAX_IN_TRANSACTION,
60 /* JOB_TRY_RESTART can never appear in a transaction, because
61 * it always collapses into JOB_RESTART or JOB_NOP before entering.
62 * Thus we never need to merge it with anything. */
63 JOB_TRY_RESTART = _JOB_TYPE_MAX_IN_TRANSACTION, /* if running, stop and then start */
65 /* JOB_RELOAD_OR_START won't enter into a transaction and cannot result
66 * from transaction merging (there's no way for JOB_RELOAD and
67 * JOB_START to meet in one transaction). It can result from a merge
68 * during job installation, but then it will immediately collapse into
69 * one of the two simpler types. */
70 JOB_RELOAD_OR_START, /* if running, reload, otherwise start */
73 _JOB_TYPE_INVALID = -1
80 _JOB_STATE_INVALID = -1
84 JOB_FAIL, /* Fail if a conflicting job is already queued */
85 JOB_REPLACE, /* Replace an existing conflicting job */
86 JOB_ISOLATE, /* Start a unit, and stop all others */
87 JOB_IGNORE_DEPENDENCIES, /* Ignore both requirement and ordering dependencies */
88 JOB_IGNORE_REQUIREMENTS, /* Ignore requirement dependencies */
90 _JOB_MODE_INVALID = -1
101 _JOB_RESULT_INVALID = -1
109 struct JobDependency {
110 /* Encodes that the 'subject' job needs the 'object' job in
111 * some way. This structure is used only while building a transaction. */
115 LIST_FIELDS(JobDependency, subject);
116 LIST_FIELDS(JobDependency, object);
122 struct JobBusClient {
123 LIST_FIELDS(JobBusClient, client);
124 /* Note that this bus object is not ref counted here. */
133 LIST_FIELDS(Job, transaction);
134 LIST_FIELDS(Job, run_queue);
135 LIST_FIELDS(Job, dbus_queue);
137 LIST_HEAD(JobDependency, subject_list);
138 LIST_HEAD(JobDependency, object_list);
140 /* Used for graph algs as a "I have been here" marker */
151 /* There can be more than one client, because of job merging. */
152 LIST_HEAD(JobBusClient, bus_client_list);
158 bool matters_to_anchor:1;
160 bool in_dbus_queue:1;
161 bool sent_dbus_new_signal:1;
163 bool forgot_bus_clients:1;
166 JobBusClient* job_bus_client_new(DBusConnection *connection, const char *name);
168 Job* job_new(Unit *unit, JobType type);
169 Job* job_new_raw(Unit *unit);
170 void job_free(Job *job);
171 Job* job_install(Job *j);
172 int job_install_deserialized(Job *j);
173 void job_uninstall(Job *j);
174 void job_dump(Job *j, FILE*f, const char *prefix);
175 int job_serialize(Job *j, FILE *f, FDSet *fds);
176 int job_deserialize(Job *j, FILE *f, FDSet *fds);
177 int job_coldplug(Job *j);
179 JobDependency* job_dependency_new(Job *subject, Job *object, bool matters, bool conflicts);
180 void job_dependency_free(JobDependency *l);
182 int job_merge(Job *j, Job *other);
184 JobType job_type_lookup_merge(JobType a, JobType b);
186 static inline bool job_type_is_mergeable(JobType a, JobType b) {
187 return job_type_lookup_merge(a, b) >= 0;
190 static inline bool job_type_is_conflicting(JobType a, JobType b) {
191 return !job_type_is_mergeable(a, b);
194 static inline bool job_type_is_superset(JobType a, JobType b) {
195 /* Checks whether operation a is a "superset" of b in its actions */
196 return a == job_type_lookup_merge(a, b);
199 bool job_type_is_redundant(JobType a, UnitActiveState b);
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 void job_type_collapse(JobType *t, Unit *u);
205 int job_type_merge_and_collapse(JobType *a, JobType b, Unit *u);
207 bool job_is_runnable(Job *j);
209 void job_add_to_run_queue(Job *j);
210 void job_add_to_dbus_queue(Job *j);
212 int job_start_timer(Job *j);
213 void job_timer_event(Job *j, uint64_t n_elapsed, Watch *w);
215 int job_run_and_invalidate(Job *j);
216 int job_finish_and_invalidate(Job *j, JobResult result, bool recursive);
218 char *job_dbus_path(Job *j);
220 const char* job_type_to_string(JobType t);
221 JobType job_type_from_string(const char *s);
223 const char* job_state_to_string(JobState t);
224 JobState job_state_from_string(const char *s);
226 const char* job_mode_to_string(JobMode t);
227 JobMode job_mode_from_string(const char *s);
229 const char* job_result_to_string(JobResult t);
230 JobResult job_result_from_string(const char *s);