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