]>
Commit | Line | Data |
---|---|---|
03467c88 | 1 | /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/ |
60918275 | 2 | |
c2f1db8f | 3 | #pragma once |
60918275 | 4 | |
a7334b09 LP |
5 | /*** |
6 | This file is part of systemd. | |
7 | ||
8 | Copyright 2010 Lennart Poettering | |
9 | ||
10 | systemd is free software; you can redistribute it and/or modify it | |
5430f7f2 LP |
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 | |
a7334b09 LP |
13 | (at your option) any later version. |
14 | ||
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 | |
5430f7f2 | 18 | Lesser General Public License for more details. |
a7334b09 | 19 | |
5430f7f2 | 20 | You should have received a copy of the GNU Lesser General Public License |
a7334b09 LP |
21 | along with systemd; If not, see <http://www.gnu.org/licenses/>. |
22 | ***/ | |
23 | ||
60918275 LP |
24 | #include <stdbool.h> |
25 | #include <inttypes.h> | |
348e27fe | 26 | #include <errno.h> |
60918275 LP |
27 | |
28 | typedef struct Job Job; | |
e5b5ae50 | 29 | typedef struct JobDependency JobDependency; |
60918275 | 30 | typedef enum JobType JobType; |
e5b5ae50 | 31 | typedef enum JobState JobState; |
5cb5a6ff | 32 | typedef enum JobMode JobMode; |
5d44db4a | 33 | typedef enum JobResult JobResult; |
60918275 | 34 | |
348e27fe | 35 | /* Be careful when changing the job types! Adjust job_merging_table[] accordingly! */ |
60918275 | 36 | enum JobType { |
87f0e418 | 37 | JOB_START, /* if a unit does not support being started, we'll just wait until it becomes active */ |
5cb5a6ff LP |
38 | JOB_VERIFY_ACTIVE, |
39 | ||
60918275 | 40 | JOB_STOP, |
5cb5a6ff | 41 | |
e0209d83 | 42 | JOB_RELOAD, /* if running, reload */ |
5cb5a6ff LP |
43 | |
44 | /* Note that restarts are first treated like JOB_STOP, but | |
45 | * then instead of finishing are patched to become | |
46 | * JOB_START. */ | |
e0209d83 MS |
47 | JOB_RESTART, /* If running, stop. Then start unconditionally. */ |
48 | ||
49 | _JOB_TYPE_MAX_MERGING, | |
50 | ||
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 */ | |
56 | ||
57 | _JOB_TYPE_MAX_IN_TRANSACTION, | |
58 | ||
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 */ | |
63 | ||
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 */ | |
5cb5a6ff | 70 | |
e5b5ae50 LP |
71 | _JOB_TYPE_MAX, |
72 | _JOB_TYPE_INVALID = -1 | |
60918275 LP |
73 | }; |
74 | ||
e5b5ae50 | 75 | enum JobState { |
60918275 LP |
76 | JOB_WAITING, |
77 | JOB_RUNNING, | |
94f04347 LP |
78 | _JOB_STATE_MAX, |
79 | _JOB_STATE_INVALID = -1 | |
e5b5ae50 | 80 | }; |
60918275 LP |
81 | |
82 | enum JobMode { | |
cebe0d41 LP |
83 | JOB_FAIL, /* Fail if a conflicting job is already queued */ |
84 | JOB_REPLACE, /* Replace an existing conflicting job */ | |
d420282b | 85 | JOB_REPLACE_IRREVERSIBLY,/* Like JOB_REPLACE + produce irreversible jobs */ |
cebe0d41 | 86 | JOB_ISOLATE, /* Start a unit, and stop all others */ |
255baef6 | 87 | JOB_FLUSH, /* Flush out all other queued jobs when queing this one */ |
cebe0d41 LP |
88 | JOB_IGNORE_DEPENDENCIES, /* Ignore both requirement and ordering dependencies */ |
89 | JOB_IGNORE_REQUIREMENTS, /* Ignore requirement dependencies */ | |
b548631a LP |
90 | _JOB_MODE_MAX, |
91 | _JOB_MODE_INVALID = -1 | |
60918275 LP |
92 | }; |
93 | ||
5d44db4a | 94 | enum JobResult { |
65eb544e MS |
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 */ | |
6a371e23 ZJS |
100 | JOB_SKIPPED, /* Negative result of JOB_VERIFY_ACTIVE */ |
101 | JOB_INVALID, /* JOB_RELOAD of inactive unit */ | |
5d44db4a LP |
102 | _JOB_RESULT_MAX, |
103 | _JOB_RESULT_INVALID = -1 | |
104 | }; | |
105 | ||
718db961 | 106 | #include "sd-event.h" |
c6918296 MS |
107 | #include "manager.h" |
108 | #include "unit.h" | |
109 | #include "hashmap.h" | |
110 | #include "list.h" | |
111 | ||
e5b5ae50 LP |
112 | struct JobDependency { |
113 | /* Encodes that the 'subject' job needs the 'object' job in | |
114 | * some way. This structure is used only while building a transaction. */ | |
115 | Job *subject; | |
116 | Job *object; | |
117 | ||
034c6ed7 LP |
118 | LIST_FIELDS(JobDependency, subject); |
119 | LIST_FIELDS(JobDependency, object); | |
9d58f1db LP |
120 | |
121 | bool matters; | |
69dd2852 | 122 | bool conflicts; |
e5b5ae50 LP |
123 | }; |
124 | ||
60918275 LP |
125 | struct Job { |
126 | Manager *manager; | |
87f0e418 | 127 | Unit *unit; |
e5b5ae50 | 128 | |
034c6ed7 LP |
129 | LIST_FIELDS(Job, transaction); |
130 | LIST_FIELDS(Job, run_queue); | |
c1e1601e | 131 | LIST_FIELDS(Job, dbus_queue); |
e5b5ae50 | 132 | |
44d8db9e LP |
133 | LIST_HEAD(JobDependency, subject_list); |
134 | LIST_HEAD(JobDependency, object_list); | |
e5b5ae50 | 135 | |
5cb5a6ff | 136 | /* Used for graph algs as a "I have been here" marker */ |
e5b5ae50 LP |
137 | Job* marker; |
138 | unsigned generation; | |
034c6ed7 | 139 | |
9d58f1db LP |
140 | uint32_t id; |
141 | ||
142 | JobType type; | |
143 | JobState state; | |
144 | ||
718db961 LP |
145 | sd_event_source *timer_event_source; |
146 | usec_t begin_usec; | |
faf919f1 | 147 | |
97e6a119 | 148 | /* There can be more than one client, because of job merging. */ |
8f8f05a9 LP |
149 | sd_bus_track *subscribed; |
150 | char **deserialized_subscribed; | |
a567261a | 151 | |
5d44db4a LP |
152 | JobResult result; |
153 | ||
9d58f1db LP |
154 | bool installed:1; |
155 | bool in_run_queue:1; | |
156 | bool matters_to_anchor:1; | |
157 | bool override:1; | |
158 | bool in_dbus_queue:1; | |
159 | bool sent_dbus_new_signal:1; | |
cebe0d41 | 160 | bool ignore_order:1; |
23ade460 | 161 | bool irreversible:1; |
60918275 LP |
162 | }; |
163 | ||
668ad332 | 164 | Job* job_new(Unit *unit, JobType type); |
39a18c60 | 165 | Job* job_new_raw(Unit *unit); |
60918275 | 166 | void job_free(Job *job); |
656bbffc | 167 | Job* job_install(Job *j); |
e0209d83 | 168 | int job_install_deserialized(Job *j); |
05d576f1 | 169 | void job_uninstall(Job *j); |
ceed3570 | 170 | void job_dump(Job *j, FILE*f, const char *prefix); |
39a18c60 MS |
171 | int job_serialize(Job *j, FILE *f, FDSet *fds); |
172 | int job_deserialize(Job *j, FILE *f, FDSet *fds); | |
173 | int job_coldplug(Job *j); | |
60918275 | 174 | |
1da4264f MS |
175 | JobDependency* job_dependency_new(Job *subject, Job *object, bool matters, bool conflicts); |
176 | void job_dependency_free(JobDependency *l); | |
e5b5ae50 | 177 | |
e5b5ae50 LP |
178 | int job_merge(Job *j, Job *other); |
179 | ||
44a6b1b6 | 180 | JobType job_type_lookup_merge(JobType a, JobType b) _pure_; |
348e27fe | 181 | |
44a6b1b6 | 182 | _pure_ static inline bool job_type_is_mergeable(JobType a, JobType b) { |
348e27fe MS |
183 | return job_type_lookup_merge(a, b) >= 0; |
184 | } | |
185 | ||
44a6b1b6 | 186 | _pure_ static inline bool job_type_is_conflicting(JobType a, JobType b) { |
348e27fe MS |
187 | return !job_type_is_mergeable(a, b); |
188 | } | |
189 | ||
44a6b1b6 | 190 | _pure_ static inline bool job_type_is_superset(JobType a, JobType b) { |
348e27fe MS |
191 | /* Checks whether operation a is a "superset" of b in its actions */ |
192 | return a == job_type_lookup_merge(a, b); | |
193 | } | |
194 | ||
44a6b1b6 | 195 | bool job_type_is_redundant(JobType a, UnitActiveState b) _pure_; |
5cb5a6ff | 196 | |
e0209d83 MS |
197 | /* Collapses a state-dependent job type into a simpler type by observing |
198 | * the state of the unit which it is going to be applied to. */ | |
199 | void job_type_collapse(JobType *t, Unit *u); | |
200 | ||
201 | int job_type_merge_and_collapse(JobType *a, JobType b, Unit *u); | |
202 | ||
c1e1601e LP |
203 | void job_add_to_run_queue(Job *j); |
204 | void job_add_to_dbus_queue(Job *j); | |
205 | ||
faf919f1 | 206 | int job_start_timer(Job *j); |
faf919f1 | 207 | |
5cb5a6ff | 208 | int job_run_and_invalidate(Job *j); |
5273510e | 209 | int job_finish_and_invalidate(Job *j, JobResult result, bool recursive); |
1ffba6fe | 210 | |
faf919f1 LP |
211 | char *job_dbus_path(Job *j); |
212 | ||
c65eb836 LP |
213 | void job_shutdown_magic(Job *j); |
214 | ||
44a6b1b6 ZJS |
215 | const char* job_type_to_string(JobType t) _const_; |
216 | JobType job_type_from_string(const char *s) _pure_; | |
94f04347 | 217 | |
44a6b1b6 ZJS |
218 | const char* job_state_to_string(JobState t) _const_; |
219 | JobState job_state_from_string(const char *s) _pure_; | |
94f04347 | 220 | |
44a6b1b6 ZJS |
221 | const char* job_mode_to_string(JobMode t) _const_; |
222 | JobMode job_mode_from_string(const char *s) _pure_; | |
b548631a | 223 | |
44a6b1b6 ZJS |
224 | const char* job_result_to_string(JobResult t) _const_; |
225 | JobResult job_result_from_string(const char *s) _pure_; | |
68db7a3b ZJS |
226 | |
227 | int job_get_timeout(Job *j, uint64_t *timeout) _pure_; |