]>
Commit | Line | Data |
---|---|---|
53e1b683 | 1 | /* SPDX-License-Identifier: LGPL-2.1+ */ |
c2f1db8f | 2 | #pragma once |
60918275 LP |
3 | |
4 | #include <stdbool.h> | |
60918275 | 5 | |
07630cea LP |
6 | #include "sd-event.h" |
7 | ||
8 | #include "list.h" | |
71d35b6b | 9 | #include "unit-name.h" |
07630cea | 10 | |
60918275 | 11 | typedef struct Job Job; |
e5b5ae50 | 12 | typedef struct JobDependency JobDependency; |
60918275 | 13 | typedef enum JobType JobType; |
e5b5ae50 | 14 | typedef enum JobState JobState; |
5cb5a6ff | 15 | typedef enum JobMode JobMode; |
5d44db4a | 16 | typedef enum JobResult JobResult; |
60918275 | 17 | |
348e27fe | 18 | /* Be careful when changing the job types! Adjust job_merging_table[] accordingly! */ |
60918275 | 19 | enum JobType { |
87f0e418 | 20 | JOB_START, /* if a unit does not support being started, we'll just wait until it becomes active */ |
5cb5a6ff LP |
21 | JOB_VERIFY_ACTIVE, |
22 | ||
60918275 | 23 | JOB_STOP, |
5cb5a6ff | 24 | |
e0209d83 | 25 | JOB_RELOAD, /* if running, reload */ |
5cb5a6ff LP |
26 | |
27 | /* Note that restarts are first treated like JOB_STOP, but | |
28 | * then instead of finishing are patched to become | |
29 | * JOB_START. */ | |
e0209d83 MS |
30 | JOB_RESTART, /* If running, stop. Then start unconditionally. */ |
31 | ||
32 | _JOB_TYPE_MAX_MERGING, | |
33 | ||
34 | /* JOB_NOP can enter into a transaction, but as it won't pull in | |
7e803f5e MS |
35 | * any dependencies and it uses the special 'nop_job' slot in Unit, |
36 | * it won't have to merge with anything (except possibly into another | |
37 | * JOB_NOP, previously installed). JOB_NOP is special-cased in | |
38 | * job_type_is_*() functions so that the transaction can be | |
39 | * activated. */ | |
e0209d83 MS |
40 | JOB_NOP = _JOB_TYPE_MAX_MERGING, /* do nothing */ |
41 | ||
42 | _JOB_TYPE_MAX_IN_TRANSACTION, | |
43 | ||
44 | /* JOB_TRY_RESTART can never appear in a transaction, because | |
45 | * it always collapses into JOB_RESTART or JOB_NOP before entering. | |
46 | * Thus we never need to merge it with anything. */ | |
47 | JOB_TRY_RESTART = _JOB_TYPE_MAX_IN_TRANSACTION, /* if running, stop and then start */ | |
48 | ||
3282591d LP |
49 | /* Similar to JOB_TRY_RESTART but collapses to JOB_RELOAD or JOB_NOP */ |
50 | JOB_TRY_RELOAD, | |
51 | ||
e0209d83 MS |
52 | /* JOB_RELOAD_OR_START won't enter into a transaction and cannot result |
53 | * from transaction merging (there's no way for JOB_RELOAD and | |
54 | * JOB_START to meet in one transaction). It can result from a merge | |
55 | * during job installation, but then it will immediately collapse into | |
56 | * one of the two simpler types. */ | |
57 | JOB_RELOAD_OR_START, /* if running, reload, otherwise start */ | |
5cb5a6ff | 58 | |
e5b5ae50 LP |
59 | _JOB_TYPE_MAX, |
60 | _JOB_TYPE_INVALID = -1 | |
60918275 LP |
61 | }; |
62 | ||
e5b5ae50 | 63 | enum JobState { |
60918275 LP |
64 | JOB_WAITING, |
65 | JOB_RUNNING, | |
94f04347 LP |
66 | _JOB_STATE_MAX, |
67 | _JOB_STATE_INVALID = -1 | |
e5b5ae50 | 68 | }; |
60918275 LP |
69 | |
70 | enum JobMode { | |
cebe0d41 LP |
71 | JOB_FAIL, /* Fail if a conflicting job is already queued */ |
72 | JOB_REPLACE, /* Replace an existing conflicting job */ | |
d420282b | 73 | JOB_REPLACE_IRREVERSIBLY,/* Like JOB_REPLACE + produce irreversible jobs */ |
cebe0d41 | 74 | JOB_ISOLATE, /* Start a unit, and stop all others */ |
5238e957 | 75 | JOB_FLUSH, /* Flush out all other queued jobs when queueing this one */ |
cebe0d41 LP |
76 | JOB_IGNORE_DEPENDENCIES, /* Ignore both requirement and ordering dependencies */ |
77 | JOB_IGNORE_REQUIREMENTS, /* Ignore requirement dependencies */ | |
1f0f9f21 | 78 | JOB_TRIGGERING, /* Adds TRIGGERED_BY dependencies to the same transaction */ |
b548631a LP |
79 | _JOB_MODE_MAX, |
80 | _JOB_MODE_INVALID = -1 | |
60918275 LP |
81 | }; |
82 | ||
5d44db4a | 83 | enum JobResult { |
6d4150cb | 84 | JOB_DONE, /* Job completed successfully (or skipped due to a failed ConditionXYZ=) */ |
65eb544e | 85 | JOB_CANCELED, /* Job canceled by a conflicting job installation or by explicit cancel request */ |
0faacd47 | 86 | JOB_TIMEOUT, /* Job timeout elapsed */ |
65eb544e MS |
87 | JOB_FAILED, /* Job failed */ |
88 | JOB_DEPENDENCY, /* A required dependency job did not result in JOB_DONE */ | |
31cd5f63 | 89 | JOB_SKIPPED, /* Negative result of JOB_VERIFY_ACTIVE or skip due to ExecCondition= */ |
6a371e23 | 90 | JOB_INVALID, /* JOB_RELOAD of inactive unit */ |
59fccdc5 | 91 | JOB_ASSERT, /* Couldn't start a unit, because an assert didn't hold */ |
0faacd47 | 92 | JOB_UNSUPPORTED, /* Couldn't start a unit, because the unit type is not supported on the system */ |
c5a97ed1 | 93 | JOB_COLLECTED, /* Job was garbage collected, since nothing needed it anymore */ |
d4fd1cf2 | 94 | JOB_ONCE, /* Unit was started before, and hence can't be started again */ |
5d44db4a LP |
95 | _JOB_RESULT_MAX, |
96 | _JOB_RESULT_INVALID = -1 | |
97 | }; | |
98 | ||
c6918296 | 99 | #include "unit.h" |
c6918296 | 100 | |
e5b5ae50 LP |
101 | struct JobDependency { |
102 | /* Encodes that the 'subject' job needs the 'object' job in | |
103 | * some way. This structure is used only while building a transaction. */ | |
104 | Job *subject; | |
105 | Job *object; | |
106 | ||
034c6ed7 LP |
107 | LIST_FIELDS(JobDependency, subject); |
108 | LIST_FIELDS(JobDependency, object); | |
9d58f1db | 109 | |
0a23a627 LP |
110 | bool matters:1; |
111 | bool conflicts:1; | |
e5b5ae50 LP |
112 | }; |
113 | ||
60918275 LP |
114 | struct Job { |
115 | Manager *manager; | |
87f0e418 | 116 | Unit *unit; |
e5b5ae50 | 117 | |
034c6ed7 | 118 | LIST_FIELDS(Job, transaction); |
c1e1601e | 119 | LIST_FIELDS(Job, dbus_queue); |
c5a97ed1 | 120 | LIST_FIELDS(Job, gc_queue); |
e5b5ae50 | 121 | |
44d8db9e LP |
122 | LIST_HEAD(JobDependency, subject_list); |
123 | LIST_HEAD(JobDependency, object_list); | |
e5b5ae50 | 124 | |
5cb5a6ff | 125 | /* Used for graph algs as a "I have been here" marker */ |
e5b5ae50 LP |
126 | Job* marker; |
127 | unsigned generation; | |
034c6ed7 | 128 | |
9d58f1db LP |
129 | uint32_t id; |
130 | ||
131 | JobType type; | |
132 | JobState state; | |
133 | ||
718db961 LP |
134 | sd_event_source *timer_event_source; |
135 | usec_t begin_usec; | |
171f12ce | 136 | usec_t begin_running_usec; |
faf919f1 | 137 | |
b39a2770 SW |
138 | /* |
139 | * This tracks where to send signals, and also which clients | |
140 | * are allowed to call DBus methods on the job (other than | |
141 | * root). | |
142 | * | |
143 | * There can be more than one client, because of job merging. | |
144 | */ | |
1a465207 | 145 | sd_bus_track *bus_track; |
b39a2770 | 146 | char **deserialized_clients; |
a567261a | 147 | |
5d44db4a LP |
148 | JobResult result; |
149 | ||
da8e1782 MO |
150 | unsigned run_queue_idx; |
151 | ||
9d58f1db LP |
152 | bool installed:1; |
153 | bool in_run_queue:1; | |
154 | bool matters_to_anchor:1; | |
9d58f1db LP |
155 | bool in_dbus_queue:1; |
156 | bool sent_dbus_new_signal:1; | |
cebe0d41 | 157 | bool ignore_order:1; |
23ade460 | 158 | bool irreversible:1; |
c5a97ed1 LP |
159 | bool in_gc_queue:1; |
160 | bool ref_by_private_bus:1; | |
60918275 LP |
161 | }; |
162 | ||
668ad332 | 163 | Job* job_new(Unit *unit, JobType type); |
39a18c60 | 164 | Job* job_new_raw(Unit *unit); |
a7a7163d | 165 | void job_unlink(Job *job); |
728ba51e | 166 | Job* 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); |
f2a3de01 | 170 | void job_dump(Job *j, FILE *f, const char *prefix); |
05a98afd LP |
171 | int job_serialize(Job *j, FILE *f); |
172 | int job_deserialize(Job *j, FILE *f); | |
39a18c60 | 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) { |
7e803f5e | 187 | return a != JOB_NOP && b != JOB_NOP && !job_type_is_mergeable(a, b); |
348e27fe MS |
188 | } |
189 | ||
44a6b1b6 | 190 | _pure_ static inline bool job_type_is_superset(JobType a, JobType b) { |
348e27fe | 191 | /* Checks whether operation a is a "superset" of b in its actions */ |
7e803f5e MS |
192 | if (b == JOB_NOP) |
193 | return true; | |
194 | if (a == JOB_NOP) | |
195 | return false; | |
348e27fe MS |
196 | return a == job_type_lookup_merge(a, b); |
197 | } | |
198 | ||
cc479760 | 199 | bool job_type_is_redundant(JobType a, UnitActiveState b) _pure_; |
5cb5a6ff | 200 | |
e0209d83 MS |
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. */ | |
c6497ccb | 203 | JobType job_type_collapse(JobType t, Unit *u); |
e0209d83 MS |
204 | |
205 | int job_type_merge_and_collapse(JobType *a, JobType b, Unit *u); | |
206 | ||
c1e1601e LP |
207 | void job_add_to_run_queue(Job *j); |
208 | void job_add_to_dbus_queue(Job *j); | |
209 | ||
a2df3ea4 | 210 | int job_start_timer(Job *j, bool job_running); |
faf919f1 | 211 | |
5cb5a6ff | 212 | int job_run_and_invalidate(Job *j); |
833f92ad | 213 | int job_finish_and_invalidate(Job *j, JobResult result, bool recursive, bool already); |
1ffba6fe | 214 | |
faf919f1 LP |
215 | char *job_dbus_path(Job *j); |
216 | ||
c65eb836 LP |
217 | void job_shutdown_magic(Job *j); |
218 | ||
7a7821c8 LP |
219 | int job_get_timeout(Job *j, usec_t *timeout) _pure_; |
220 | ||
2ab3050f | 221 | bool job_may_gc(Job *j); |
c5a97ed1 LP |
222 | void job_add_to_gc_queue(Job *j); |
223 | ||
15ea79f8 LP |
224 | int job_get_before(Job *j, Job*** ret); |
225 | int job_get_after(Job *j, Job*** ret); | |
226 | ||
b17c9620 LP |
227 | DEFINE_TRIVIAL_CLEANUP_FUNC(Job*, job_free); |
228 | ||
44a6b1b6 ZJS |
229 | const char* job_type_to_string(JobType t) _const_; |
230 | JobType job_type_from_string(const char *s) _pure_; | |
94f04347 | 231 | |
44a6b1b6 ZJS |
232 | const char* job_state_to_string(JobState t) _const_; |
233 | JobState job_state_from_string(const char *s) _pure_; | |
94f04347 | 234 | |
44a6b1b6 ZJS |
235 | const char* job_mode_to_string(JobMode t) _const_; |
236 | JobMode job_mode_from_string(const char *s) _pure_; | |
b548631a | 237 | |
44a6b1b6 ZJS |
238 | const char* job_result_to_string(JobResult t) _const_; |
239 | JobResult job_result_from_string(const char *s) _pure_; | |
68db7a3b | 240 | |
94bd7323 | 241 | const char* job_type_to_access_method(JobType t); |
e602f152 MK |
242 | |
243 | int job_compare(Job *a, Job *b, UnitDependency assume_dep); |