]>
Commit | Line | Data |
---|---|---|
03467c88 | 1 | /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/ |
87f0e418 | 2 | |
c2f1db8f | 3 | #pragma once |
87f0e418 | 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 | ||
87f0e418 LP |
24 | #include <stdbool.h> |
25 | #include <stdlib.h> | |
bbc9006e | 26 | #include <unistd.h> |
87f0e418 | 27 | |
ac155bb8 | 28 | typedef struct Unit Unit; |
87f0e418 | 29 | typedef struct UnitVTable UnitVTable; |
87f0e418 | 30 | typedef enum UnitActiveState UnitActiveState; |
57020a3a | 31 | typedef struct UnitRef UnitRef; |
c6918296 | 32 | typedef struct UnitStatusMessageFormats UnitStatusMessageFormats; |
87f0e418 | 33 | |
87f0e418 | 34 | #include "list.h" |
134e56dc | 35 | #include "condition.h" |
a4375746 | 36 | #include "install.h" |
0a9f8ed0 | 37 | #include "unit-name.h" |
f189ab18 | 38 | #include "failure-action.h" |
87f0e418 | 39 | |
87f0e418 LP |
40 | enum UnitActiveState { |
41 | UNIT_ACTIVE, | |
032ff4af | 42 | UNIT_RELOADING, |
87f0e418 | 43 | UNIT_INACTIVE, |
fdf20a31 | 44 | UNIT_FAILED, |
87f0e418 LP |
45 | UNIT_ACTIVATING, |
46 | UNIT_DEACTIVATING, | |
94f04347 LP |
47 | _UNIT_ACTIVE_STATE_MAX, |
48 | _UNIT_ACTIVE_STATE_INVALID = -1 | |
87f0e418 LP |
49 | }; |
50 | ||
db2cb23b UTL |
51 | typedef enum KillOperation { |
52 | KILL_TERMINATE, | |
53 | KILL_KILL, | |
54 | KILL_ABORT, | |
4940c0b0 LP |
55 | _KILL_OPERATION_MAX, |
56 | _KILL_OPERATION_INVALID = -1 | |
db2cb23b UTL |
57 | } KillOperation; |
58 | ||
87f0e418 | 59 | static inline bool UNIT_IS_ACTIVE_OR_RELOADING(UnitActiveState t) { |
032ff4af | 60 | return t == UNIT_ACTIVE || t == UNIT_RELOADING; |
87f0e418 LP |
61 | } |
62 | ||
63 | static inline bool UNIT_IS_ACTIVE_OR_ACTIVATING(UnitActiveState t) { | |
032ff4af | 64 | return t == UNIT_ACTIVE || t == UNIT_ACTIVATING || t == UNIT_RELOADING; |
87f0e418 LP |
65 | } |
66 | ||
67 | static inline bool UNIT_IS_INACTIVE_OR_DEACTIVATING(UnitActiveState t) { | |
fdf20a31 | 68 | return t == UNIT_INACTIVE || t == UNIT_FAILED || t == UNIT_DEACTIVATING; |
6124958c LP |
69 | } |
70 | ||
fdf20a31 MM |
71 | static inline bool UNIT_IS_INACTIVE_OR_FAILED(UnitActiveState t) { |
72 | return t == UNIT_INACTIVE || t == UNIT_FAILED; | |
87f0e418 LP |
73 | } |
74 | ||
ef734fd6 LP |
75 | #include "job.h" |
76 | ||
a016b922 LP |
77 | struct UnitRef { |
78 | /* Keeps tracks of references to a unit. This is useful so | |
79 | * that we can merge two units if necessary and correct all | |
80 | * references to them */ | |
81 | ||
82 | Unit* unit; | |
83 | LIST_FIELDS(UnitRef, refs); | |
84 | }; | |
85 | ||
ac155bb8 | 86 | struct Unit { |
87f0e418 | 87 | Manager *manager; |
23a177ef | 88 | |
87f0e418 LP |
89 | UnitType type; |
90 | UnitLoadState load_state; | |
23a177ef | 91 | Unit *merged_into; |
87f0e418 LP |
92 | |
93 | char *id; /* One name is special because we use it for identification. Points to an entry in the names set */ | |
9e2f7c11 | 94 | char *instance; |
87f0e418 LP |
95 | |
96 | Set *names; | |
97 | Set *dependencies[_UNIT_DEPENDENCY_MAX]; | |
98 | ||
7c8fa05c LP |
99 | char **requires_mounts_for; |
100 | ||
87f0e418 | 101 | char *description; |
49dbfa7b | 102 | char **documentation; |
faf919f1 | 103 | |
6be1e7d5 | 104 | char *fragment_path; /* if loaded from a config file this is the primary path to it */ |
1b64d026 | 105 | char *source_path; /* if converted, the source file */ |
ae7a7182 | 106 | char **dropin_paths; |
f78f265f | 107 | |
45fb0699 | 108 | usec_t fragment_mtime; |
1b64d026 | 109 | usec_t source_mtime; |
ae7a7182 | 110 | usec_t dropin_mtime; |
87f0e418 | 111 | |
e0209d83 | 112 | /* If there is something to do with this unit, then this is the installed job for it */ |
87f0e418 LP |
113 | Job *job; |
114 | ||
e0209d83 MS |
115 | /* JOB_NOP jobs are special and can be installed without disturbing the real job. */ |
116 | Job *nop_job; | |
117 | ||
bbc29086 DM |
118 | /* The slot used for watching NameOwnerChanged signals */ |
119 | sd_bus_slot *match_bus_slot; | |
120 | ||
f189ab18 | 121 | /* Job timeout and action to take */ |
faf919f1 | 122 | usec_t job_timeout; |
f189ab18 LP |
123 | FailureAction job_timeout_action; |
124 | char *job_timeout_reboot_arg; | |
faf919f1 | 125 | |
57020a3a LP |
126 | /* References to this */ |
127 | LIST_HEAD(UnitRef, refs); | |
128 | ||
52661efd LP |
129 | /* Conditions to check */ |
130 | LIST_HEAD(Condition, conditions); | |
59fccdc5 | 131 | LIST_HEAD(Condition, asserts); |
52661efd | 132 | |
90bbc946 | 133 | dual_timestamp condition_timestamp; |
59fccdc5 | 134 | dual_timestamp assert_timestamp; |
90bbc946 | 135 | |
63983207 LP |
136 | dual_timestamp inactive_exit_timestamp; |
137 | dual_timestamp active_enter_timestamp; | |
138 | dual_timestamp active_exit_timestamp; | |
139 | dual_timestamp inactive_enter_timestamp; | |
87f0e418 | 140 | |
a016b922 LP |
141 | UnitRef slice; |
142 | ||
ef734fd6 | 143 | /* Per type list */ |
ac155bb8 | 144 | LIST_FIELDS(Unit, units_by_type); |
c1e1601e | 145 | |
7c8fa05c LP |
146 | /* All units which have requires_mounts_for set */ |
147 | LIST_FIELDS(Unit, has_requires_mounts_for); | |
148 | ||
701cc384 | 149 | /* Load queue */ |
ac155bb8 | 150 | LIST_FIELDS(Unit, load_queue); |
701cc384 | 151 | |
c1e1601e | 152 | /* D-Bus queue */ |
ac155bb8 | 153 | LIST_FIELDS(Unit, dbus_queue); |
23a177ef LP |
154 | |
155 | /* Cleanup queue */ | |
ac155bb8 | 156 | LIST_FIELDS(Unit, cleanup_queue); |
9d58f1db | 157 | |
701cc384 | 158 | /* GC queue */ |
ac155bb8 | 159 | LIST_FIELDS(Unit, gc_queue); |
701cc384 | 160 | |
4ad49000 LP |
161 | /* CGroup realize members queue */ |
162 | LIST_FIELDS(Unit, cgroup_queue); | |
163 | ||
a911bb9a LP |
164 | /* PIDs we keep an eye on. Note that a unit might have many |
165 | * more, but these are the ones we care enough about to | |
166 | * process SIGCHLD for */ | |
167 | Set *pids; | |
168 | ||
701cc384 | 169 | /* Used during GC sweeps */ |
eced69b3 | 170 | unsigned gc_marker; |
701cc384 | 171 | |
8821a00f LP |
172 | /* Error code when we didn't manage to load the unit (negative) */ |
173 | int load_error; | |
174 | ||
67bfdc97 LP |
175 | /* Make sure we never enter endless loops with the check unneeded logic, or the BindsTo= logic */ |
176 | RateLimit auto_stop_ratelimit; | |
bea355da | 177 | |
d2dc52db | 178 | /* Cached unit file state and preset */ |
a4375746 | 179 | UnitFileState unit_file_state; |
d2dc52db | 180 | int unit_file_preset; |
a4375746 | 181 | |
5ad096b3 LP |
182 | /* Where the cpuacct.usage cgroup counter was at the time the unit was started */ |
183 | nsec_t cpuacct_usage_base; | |
184 | ||
7c52a17b ZJS |
185 | /* Counterparts in the cgroup filesystem */ |
186 | char *cgroup_path; | |
efdb0237 LP |
187 | CGroupMask cgroup_realized_mask; |
188 | CGroupMask cgroup_subtree_mask; | |
189 | CGroupMask cgroup_members_mask; | |
190 | int cgroup_inotify_wd; | |
7c52a17b ZJS |
191 | |
192 | /* How to start OnFailure units */ | |
193 | JobMode on_failure_job_mode; | |
194 | ||
9d58f1db LP |
195 | /* Garbage collect us we nobody wants or requires us anymore */ |
196 | bool stop_when_unneeded; | |
197 | ||
35b8ca3a | 198 | /* Create default dependencies */ |
a40eb732 LP |
199 | bool default_dependencies; |
200 | ||
b5e9dba8 LP |
201 | /* Refuse manual starting, allow starting only indirectly via dependency. */ |
202 | bool refuse_manual_start; | |
203 | ||
204 | /* Don't allow the user to stop this unit manually, allow stopping only indirectly via dependency. */ | |
205 | bool refuse_manual_stop; | |
206 | ||
2528a7a6 LP |
207 | /* Allow isolation requests */ |
208 | bool allow_isolate; | |
209 | ||
c8f4d764 LP |
210 | /* Ignore this unit when isolating */ |
211 | bool ignore_on_isolate; | |
212 | ||
7a6000a6 LP |
213 | /* Ignore this unit when snapshotting */ |
214 | bool ignore_on_snapshot; | |
215 | ||
49f43d5f | 216 | /* Did the last condition check succeed? */ |
90bbc946 | 217 | bool condition_result; |
59fccdc5 | 218 | bool assert_result; |
90bbc946 | 219 | |
c2756a68 LP |
220 | /* Is this a transient unit? */ |
221 | bool transient; | |
222 | ||
9d58f1db LP |
223 | bool in_load_queue:1; |
224 | bool in_dbus_queue:1; | |
225 | bool in_cleanup_queue:1; | |
701cc384 | 226 | bool in_gc_queue:1; |
4ad49000 | 227 | bool in_cgroup_queue:1; |
701cc384 | 228 | |
9d58f1db | 229 | bool sent_dbus_new_signal:1; |
6c073082 LP |
230 | |
231 | bool no_gc:1; | |
cd6d0a45 LP |
232 | |
233 | bool in_audit:1; | |
a57f7e2c LP |
234 | |
235 | bool cgroup_realized:1; | |
bc432dc7 LP |
236 | bool cgroup_members_mask_valid:1; |
237 | bool cgroup_subtree_mask_valid:1; | |
f78f265f LP |
238 | |
239 | /* Did we already invoke unit_coldplug() for this unit? */ | |
f8a30ce5 | 240 | bool coldplugged:1; |
87f0e418 LP |
241 | }; |
242 | ||
c6918296 MS |
243 | struct UnitStatusMessageFormats { |
244 | const char *starting_stopping[2]; | |
245 | const char *finished_start_job[_JOB_RESULT_MAX]; | |
246 | const char *finished_stop_job[_JOB_RESULT_MAX]; | |
247 | }; | |
248 | ||
8e2af478 LP |
249 | typedef enum UnitSetPropertiesMode { |
250 | UNIT_CHECK = 0, | |
251 | UNIT_RUNTIME = 1, | |
252 | UNIT_PERSISTENT = 2, | |
253 | } UnitSetPropertiesMode; | |
254 | ||
87f0e418 | 255 | #include "socket.h" |
e821075a | 256 | #include "busname.h" |
87f0e418 | 257 | #include "target.h" |
e821075a | 258 | #include "snapshot.h" |
87f0e418 | 259 | #include "device.h" |
87f0e418 | 260 | #include "automount.h" |
07b0b134 | 261 | #include "swap.h" |
e821075a | 262 | #include "timer.h" |
a016b922 | 263 | #include "slice.h" |
c1ff5570 | 264 | #include "path.h" |
6c12b52e | 265 | #include "scope.h" |
87f0e418 | 266 | |
87f0e418 | 267 | struct UnitVTable { |
7d17cfbc MS |
268 | /* How much memory does an object of this unit type need */ |
269 | size_t object_size; | |
270 | ||
3ef63c31 LP |
271 | /* If greater than 0, the offset into the object where |
272 | * ExecContext is found, if the unit type has that */ | |
273 | size_t exec_context_offset; | |
274 | ||
4ad49000 LP |
275 | /* If greater than 0, the offset into the object where |
276 | * CGroupContext is found, if the unit type has that */ | |
277 | size_t cgroup_context_offset; | |
278 | ||
718db961 LP |
279 | /* If greater than 0, the offset into the object where |
280 | * KillContext is found, if the unit type has that */ | |
281 | size_t kill_context_offset; | |
282 | ||
613b411c LP |
283 | /* If greater than 0, the offset into the object where the |
284 | * pointer to ExecRuntime is found, if the unit type has | |
285 | * that */ | |
286 | size_t exec_runtime_offset; | |
287 | ||
ee33e53a | 288 | /* The name of the configuration file section with the private settings of this unit */ |
4ad49000 | 289 | const char *private_section; |
71645aca | 290 | |
f975e971 LP |
291 | /* Config file sections this unit type understands, separated |
292 | * by NUL chars */ | |
293 | const char *sections; | |
294 | ||
e537352b | 295 | /* This should reset all type-specific variables. This should |
a16e1123 LP |
296 | * not allocate memory, and is called with zero-initialized |
297 | * data. It should hence only initialize variables that need | |
298 | * to be set != 0. */ | |
e537352b LP |
299 | void (*init)(Unit *u); |
300 | ||
a16e1123 LP |
301 | /* This should free all type-specific variables. It should be |
302 | * idempotent. */ | |
303 | void (*done)(Unit *u); | |
304 | ||
e537352b LP |
305 | /* Actually load data from disk. This may fail, and should set |
306 | * load_state to UNIT_LOADED, UNIT_MERGED or leave it at | |
307 | * UNIT_STUB if no configuration could be found. */ | |
308 | int (*load)(Unit *u); | |
309 | ||
c5315881 | 310 | /* If a lot of units got created via enumerate(), this is |
be847e82 LP |
311 | * where to actually set the state and call unit_notify(). */ |
312 | int (*coldplug)(Unit *u); | |
87f0e418 LP |
313 | |
314 | void (*dump)(Unit *u, FILE *f, const char *prefix); | |
315 | ||
316 | int (*start)(Unit *u); | |
317 | int (*stop)(Unit *u); | |
318 | int (*reload)(Unit *u); | |
319 | ||
718db961 | 320 | int (*kill)(Unit *u, KillWho w, int signo, sd_bus_error *error); |
8a0867d6 | 321 | |
87f0e418 LP |
322 | bool (*can_reload)(Unit *u); |
323 | ||
a16e1123 LP |
324 | /* Write all data that cannot be restored from other sources |
325 | * away using unit_serialize_item() */ | |
326 | int (*serialize)(Unit *u, FILE *f, FDSet *fds); | |
327 | ||
328 | /* Restore one item from the serialization */ | |
329 | int (*deserialize_item)(Unit *u, const char *key, const char *data, FDSet *fds); | |
330 | ||
01e10de3 LP |
331 | /* Try to match up fds with what we need for this unit */ |
332 | int (*distribute_fds)(Unit *u, FDSet *fds); | |
333 | ||
87f0e418 LP |
334 | /* Boils down the more complex internal state of this unit to |
335 | * a simpler one that the engine can understand */ | |
336 | UnitActiveState (*active_state)(Unit *u); | |
337 | ||
10a94420 LP |
338 | /* Returns the substate specific to this unit type as |
339 | * string. This is purely information so that we can give the | |
35b8ca3a | 340 | * user a more fine grained explanation in which actual state a |
10a94420 LP |
341 | * unit is in. */ |
342 | const char* (*sub_state_to_string)(Unit *u); | |
343 | ||
701cc384 LP |
344 | /* Return true when there is reason to keep this entry around |
345 | * even nothing references it and it isn't active in any | |
346 | * way */ | |
347 | bool (*check_gc)(Unit *u); | |
348 | ||
a354329f LP |
349 | /* When the unit is not running and no job for it queued we |
350 | * shall release its runtime resources */ | |
351 | void (*release_resources)(Unit *u); | |
352 | ||
701cc384 LP |
353 | /* Return true when this unit is suitable for snapshotting */ |
354 | bool (*check_snapshot)(Unit *u); | |
355 | ||
718db961 | 356 | /* Invoked on every child that died */ |
87f0e418 | 357 | void (*sigchld_event)(Unit *u, pid_t pid, int code, int status); |
7824bbeb | 358 | |
fdf20a31 MM |
359 | /* Reset failed state if we are in failed state */ |
360 | void (*reset_failed)(Unit *u); | |
5632e374 | 361 | |
05e343b7 LP |
362 | /* Called whenever any of the cgroups this unit watches for |
363 | * ran empty */ | |
4ad49000 | 364 | void (*notify_cgroup_empty)(Unit *u); |
8e274523 | 365 | |
8c47c732 | 366 | /* Called whenever a process of this unit sends us a message */ |
a354329f | 367 | void (*notify_message)(Unit *u, pid_t pid, char **tags, FDSet *fds); |
8c47c732 | 368 | |
3ecaa09b | 369 | /* Called whenever a name this Unit registered for comes or |
05e343b7 LP |
370 | * goes away. */ |
371 | void (*bus_name_owner_change)(Unit *u, const char *name, const char *old_owner, const char *new_owner); | |
372 | ||
8e2af478 | 373 | /* Called for each property that is being set */ |
718db961 | 374 | int (*bus_set_property)(Unit *u, const char *name, sd_bus_message *message, UnitSetPropertiesMode mode, sd_bus_error *error); |
8e2af478 LP |
375 | |
376 | /* Called after at least one property got changed to apply the necessary change */ | |
377 | int (*bus_commit_properties)(Unit *u); | |
378 | ||
a7f241db LP |
379 | /* Return the unit this unit is following */ |
380 | Unit *(*following)(Unit *u); | |
381 | ||
6210e7fc LP |
382 | /* Return the set of units that are following each other */ |
383 | int (*following_set)(Unit *u, Set **s); | |
384 | ||
3ecaa09b LP |
385 | /* Invoked each time a unit this unit is triggering changes |
386 | * state or gains/loses a job */ | |
387 | void (*trigger_notify)(Unit *u, Unit *trigger); | |
388 | ||
8742514c LP |
389 | /* Called whenever CLOCK_REALTIME made a jump */ |
390 | void (*time_change)(Unit *u); | |
391 | ||
68db7a3b ZJS |
392 | int (*get_timeout)(Unit *u, uint64_t *timeout); |
393 | ||
f50e0a01 LP |
394 | /* This is called for each unit type and should be used to |
395 | * enumerate existing devices and load them. However, | |
396 | * everything that is loaded here should still stay in | |
397 | * inactive state. It is the job of the coldplug() call above | |
398 | * to put the units into the initial state. */ | |
7824bbeb | 399 | int (*enumerate)(Manager *m); |
f50e0a01 LP |
400 | |
401 | /* Type specific cleanups. */ | |
7824bbeb | 402 | void (*shutdown)(Manager *m); |
9d58f1db | 403 | |
0faacd47 LP |
404 | /* If this function is set and return false all jobs for units |
405 | * of this type will immediately fail. */ | |
1c2e9646 | 406 | bool (*supported)(void); |
0faacd47 | 407 | |
718db961 LP |
408 | /* The bus vtable */ |
409 | const sd_bus_vtable *bus_vtable; | |
410 | ||
718db961 | 411 | /* The strings to print in status messages */ |
c6918296 MS |
412 | UnitStatusMessageFormats status_message_formats; |
413 | ||
9d58f1db LP |
414 | /* Can units of this type have multiple names? */ |
415 | bool no_alias:1; | |
416 | ||
9d58f1db LP |
417 | /* Instances make no sense for this type */ |
418 | bool no_instances:1; | |
419 | ||
701cc384 LP |
420 | /* Exclude from automatic gc */ |
421 | bool no_gc:1; | |
c2756a68 LP |
422 | |
423 | /* True if transient units of this type are OK */ | |
424 | bool can_transient:1; | |
87f0e418 LP |
425 | }; |
426 | ||
427 | extern const UnitVTable * const unit_vtable[_UNIT_TYPE_MAX]; | |
428 | ||
ac155bb8 | 429 | #define UNIT_VTABLE(u) unit_vtable[(u)->type] |
87f0e418 LP |
430 | |
431 | /* For casting a unit into the various unit types */ | |
432 | #define DEFINE_CAST(UPPERCASE, MixedCase) \ | |
433 | static inline MixedCase* UPPERCASE(Unit *u) { \ | |
ac155bb8 | 434 | if (_unlikely_(!u || u->type != UNIT_##UPPERCASE)) \ |
87f0e418 LP |
435 | return NULL; \ |
436 | \ | |
437 | return (MixedCase*) u; \ | |
438 | } | |
439 | ||
440 | /* For casting the various unit types into a unit */ | |
ac155bb8 | 441 | #define UNIT(u) (&(u)->meta) |
87f0e418 | 442 | |
35b7ff80 LP |
443 | #define UNIT_HAS_EXEC_CONTEXT(u) (UNIT_VTABLE(u)->exec_context_offset > 0) |
444 | #define UNIT_HAS_CGROUP_CONTEXT(u) (UNIT_VTABLE(u)->cgroup_context_offset > 0) | |
445 | #define UNIT_HAS_KILL_CONTEXT(u) (UNIT_VTABLE(u)->kill_context_offset > 0) | |
446 | ||
3ecaa09b LP |
447 | #define UNIT_TRIGGER(u) ((Unit*) set_first((u)->dependencies[UNIT_TRIGGERS])) |
448 | ||
87f0e418 | 449 | DEFINE_CAST(SERVICE, Service); |
e821075a LP |
450 | DEFINE_CAST(SOCKET, Socket); |
451 | DEFINE_CAST(BUSNAME, BusName); | |
87f0e418 | 452 | DEFINE_CAST(TARGET, Target); |
e821075a | 453 | DEFINE_CAST(SNAPSHOT, Snapshot); |
87f0e418 LP |
454 | DEFINE_CAST(DEVICE, Device); |
455 | DEFINE_CAST(MOUNT, Mount); | |
456 | DEFINE_CAST(AUTOMOUNT, Automount); | |
07b0b134 | 457 | DEFINE_CAST(SWAP, Swap); |
e821075a | 458 | DEFINE_CAST(TIMER, Timer); |
01f78473 | 459 | DEFINE_CAST(PATH, Path); |
a016b922 | 460 | DEFINE_CAST(SLICE, Slice); |
6c12b52e | 461 | DEFINE_CAST(SCOPE, Scope); |
87f0e418 | 462 | |
7d17cfbc | 463 | Unit *unit_new(Manager *m, size_t size); |
87f0e418 LP |
464 | void unit_free(Unit *u); |
465 | ||
466 | int unit_add_name(Unit *u, const char *name); | |
9e2f7c11 | 467 | |
701cc384 | 468 | int unit_add_dependency(Unit *u, UnitDependency d, Unit *other, bool add_reference); |
2c966c03 LP |
469 | int unit_add_two_dependencies(Unit *u, UnitDependency d, UnitDependency e, Unit *other, bool add_reference); |
470 | ||
701cc384 | 471 | int unit_add_dependency_by_name(Unit *u, UnitDependency d, const char *name, const char *filename, bool add_reference); |
2c966c03 LP |
472 | int unit_add_two_dependencies_by_name(Unit *u, UnitDependency d, UnitDependency e, const char *name, const char *path, bool add_reference); |
473 | ||
701cc384 | 474 | int unit_add_dependency_by_name_inverse(Unit *u, UnitDependency d, const char *name, const char *filename, bool add_reference); |
2c966c03 | 475 | int unit_add_two_dependencies_by_name_inverse(Unit *u, UnitDependency d, UnitDependency e, const char *name, const char *path, bool add_reference); |
0ae97ec1 | 476 | |
23a177ef LP |
477 | int unit_add_exec_dependencies(Unit *u, ExecContext *c); |
478 | ||
0ae97ec1 | 479 | int unit_choose_id(Unit *u, const char *name); |
f50e0a01 | 480 | int unit_set_description(Unit *u, const char *description); |
87f0e418 | 481 | |
701cc384 LP |
482 | bool unit_check_gc(Unit *u); |
483 | ||
87f0e418 | 484 | void unit_add_to_load_queue(Unit *u); |
c1e1601e | 485 | void unit_add_to_dbus_queue(Unit *u); |
23a177ef | 486 | void unit_add_to_cleanup_queue(Unit *u); |
701cc384 | 487 | void unit_add_to_gc_queue(Unit *u); |
87f0e418 LP |
488 | |
489 | int unit_merge(Unit *u, Unit *other); | |
23a177ef LP |
490 | int unit_merge_by_name(Unit *u, const char *other); |
491 | ||
44a6b1b6 | 492 | Unit *unit_follow_merge(Unit *u) _pure_; |
87f0e418 | 493 | |
e537352b LP |
494 | int unit_load_fragment_and_dropin(Unit *u); |
495 | int unit_load_fragment_and_dropin_optional(Unit *u); | |
87f0e418 LP |
496 | int unit_load(Unit *unit); |
497 | ||
d79200e2 LP |
498 | int unit_set_slice(Unit *u, Unit *slice); |
499 | int unit_set_default_slice(Unit *u); | |
a016b922 | 500 | |
44a6b1b6 | 501 | const char *unit_description(Unit *u) _pure_; |
87f0e418 | 502 | |
f278026d LP |
503 | bool unit_has_name(Unit *u, const char *name); |
504 | ||
87f0e418 LP |
505 | UnitActiveState unit_active_state(Unit *u); |
506 | ||
10a94420 LP |
507 | const char* unit_sub_state_to_string(Unit *u); |
508 | ||
87f0e418 LP |
509 | void unit_dump(Unit *u, FILE *f, const char *prefix); |
510 | ||
44a6b1b6 ZJS |
511 | bool unit_can_reload(Unit *u) _pure_; |
512 | bool unit_can_start(Unit *u) _pure_; | |
513 | bool unit_can_isolate(Unit *u) _pure_; | |
87f0e418 LP |
514 | |
515 | int unit_start(Unit *u); | |
516 | int unit_stop(Unit *u); | |
517 | int unit_reload(Unit *u); | |
518 | ||
718db961 LP |
519 | int unit_kill(Unit *u, KillWho w, int signo, sd_bus_error *error); |
520 | int unit_kill_common(Unit *u, KillWho who, int signo, pid_t main_pid, pid_t control_pid, sd_bus_error *error); | |
8a0867d6 | 521 | |
e2f3b44c | 522 | void unit_notify(Unit *u, UnitActiveState os, UnitActiveState ns, bool reload_success); |
87f0e418 | 523 | |
87f0e418 LP |
524 | int unit_watch_pid(Unit *u, pid_t pid); |
525 | void unit_unwatch_pid(Unit *u, pid_t pid); | |
a911bb9a LP |
526 | void unit_unwatch_all_pids(Unit *u); |
527 | ||
528 | void unit_tidy_watch_pids(Unit *u, pid_t except1, pid_t except2); | |
87f0e418 | 529 | |
bbc29086 | 530 | int unit_install_bus_match(sd_bus *bus, Unit *u, const char *name); |
05e343b7 LP |
531 | int unit_watch_bus_name(Unit *u, const char *name); |
532 | void unit_unwatch_bus_name(Unit *u, const char *name); | |
533 | ||
87f0e418 LP |
534 | bool unit_job_is_applicable(Unit *u, JobType j); |
535 | ||
0301abf4 LP |
536 | int set_unit_path(const char *p); |
537 | ||
50159e6a LP |
538 | char *unit_dbus_path(Unit *u); |
539 | ||
f6ff8c29 LP |
540 | int unit_load_related_unit(Unit *u, const char *type, Unit **_found); |
541 | ||
44a6b1b6 | 542 | bool unit_can_serialize(Unit *u) _pure_; |
6b78f9b4 | 543 | int unit_serialize(Unit *u, FILE *f, FDSet *fds, bool serialize_jobs); |
44b601bc | 544 | void unit_serialize_item_format(Unit *u, FILE *f, const char *key, const char *value, ...) _printf_(4,5); |
a16e1123 LP |
545 | void unit_serialize_item(Unit *u, FILE *f, const char *key, const char *value); |
546 | int unit_deserialize(Unit *u, FILE *f, FDSet *fds); | |
547 | ||
6e2ef85b LP |
548 | int unit_add_node_link(Unit *u, const char *what, bool wants); |
549 | ||
be847e82 | 550 | int unit_coldplug(Unit *u); |
cca098b0 | 551 | |
44b601bc | 552 | void unit_status_printf(Unit *u, const char *status, const char *unit_status_msg_format) _printf_(3, 0); |
d1a34ae9 | 553 | void unit_status_emit_starting_stopping_reloading(Unit *u, JobType t); |
9e58ff9c | 554 | |
45fb0699 LP |
555 | bool unit_need_daemon_reload(Unit *u); |
556 | ||
fdf20a31 | 557 | void unit_reset_failed(Unit *u); |
5632e374 | 558 | |
a7f241db | 559 | Unit *unit_following(Unit *u); |
eeaedb7c | 560 | int unit_following_set(Unit *u, Set **s); |
a7f241db | 561 | |
9444b1f2 LP |
562 | const char *unit_slice_name(Unit *u); |
563 | ||
44a6b1b6 ZJS |
564 | bool unit_stop_pending(Unit *u) _pure_; |
565 | bool unit_inactive_or_pending(Unit *u) _pure_; | |
31afa0a4 | 566 | bool unit_active_or_pending(Unit *u); |
18ffdfda | 567 | |
bba34eed LP |
568 | int unit_add_default_target_dependency(Unit *u, Unit *target); |
569 | ||
3ecaa09b LP |
570 | void unit_start_on_failure(Unit *u); |
571 | void unit_trigger_notify(Unit *u); | |
c0daa706 | 572 | |
a4375746 | 573 | UnitFileState unit_get_unit_file_state(Unit *u); |
d2dc52db | 574 | int unit_get_unit_file_preset(Unit *u); |
a4375746 | 575 | |
57020a3a LP |
576 | Unit* unit_ref_set(UnitRef *ref, Unit *u); |
577 | void unit_ref_unset(UnitRef *ref); | |
578 | ||
579 | #define UNIT_DEREF(ref) ((ref).unit) | |
9444b1f2 | 580 | #define UNIT_ISSET(ref) (!!(ref).unit) |
57020a3a | 581 | |
598459ce | 582 | int unit_patch_contexts(Unit *u); |
e06c73cc | 583 | |
44a6b1b6 | 584 | ExecContext *unit_get_exec_context(Unit *u) _pure_; |
718db961 | 585 | KillContext *unit_get_kill_context(Unit *u) _pure_; |
4ad49000 | 586 | CGroupContext *unit_get_cgroup_context(Unit *u) _pure_; |
598459ce | 587 | |
613b411c LP |
588 | ExecRuntime *unit_get_exec_runtime(Unit *u) _pure_; |
589 | ||
590 | int unit_setup_exec_runtime(Unit *u); | |
3ef63c31 | 591 | |
8e2af478 | 592 | int unit_write_drop_in(Unit *u, UnitSetPropertiesMode mode, const char *name, const char *data); |
44b601bc | 593 | int unit_write_drop_in_format(Unit *u, UnitSetPropertiesMode mode, const char *name, const char *format, ...) _printf_(4,5); |
b9ec9359 LP |
594 | |
595 | int unit_write_drop_in_private(Unit *u, UnitSetPropertiesMode mode, const char *name, const char *data); | |
44b601bc | 596 | int unit_write_drop_in_private_format(Unit *u, UnitSetPropertiesMode mode, const char *name, const char *format, ...) _printf_(4,5); |
b9ec9359 | 597 | |
8e2af478 | 598 | int unit_remove_drop_in(Unit *u, UnitSetPropertiesMode mode, const char *name); |
71645aca | 599 | |
db2cb23b | 600 | int unit_kill_context(Unit *u, KillContext *c, KillOperation k, pid_t main_pid, pid_t control_pid, bool main_pid_alien); |
cd2086fe | 601 | |
c2756a68 LP |
602 | int unit_make_transient(Unit *u); |
603 | ||
a57f7e2c LP |
604 | int unit_require_mounts_for(Unit *u, const char *path); |
605 | ||
1c2e9646 LP |
606 | bool unit_type_supported(UnitType t); |
607 | ||
608 | static inline bool unit_supported(Unit *u) { | |
609 | return unit_type_supported(u->type); | |
610 | } | |
611 | ||
8b4305c7 LP |
612 | void unit_warn_if_dir_nonempty(Unit *u, const char* where); |
613 | int unit_fail_if_symlink(Unit *u, const char* where); | |
614 | ||
44a6b1b6 ZJS |
615 | const char *unit_active_state_to_string(UnitActiveState i) _const_; |
616 | UnitActiveState unit_active_state_from_string(const char *s) _pure_; | |
94f04347 | 617 | |
e8e581bf ZJS |
618 | /* Macros which append UNIT= or USER_UNIT= to the message */ |
619 | ||
f2341e0a LP |
620 | #define log_unit_full(unit, level, error, ...) \ |
621 | ({ \ | |
622 | Unit *_u = (unit); \ | |
623 | _u ? log_object_internal(level, error, __FILE__, __LINE__, __func__, _u->manager->unit_log_field, _u->id, ##__VA_ARGS__) : \ | |
624 | log_internal(level, error, __FILE__, __LINE__, __func__, ##__VA_ARGS__); \ | |
625 | }) | |
626 | ||
627 | #define log_unit_debug(unit, ...) log_unit_full(unit, LOG_DEBUG, 0, ##__VA_ARGS__) | |
628 | #define log_unit_info(unit, ...) log_unit_full(unit, LOG_INFO, 0, ##__VA_ARGS__) | |
629 | #define log_unit_notice(unit, ...) log_unit_full(unit, LOG_NOTICE, 0, ##__VA_ARGS__) | |
630 | #define log_unit_warning(unit, ...) log_unit_full(unit, LOG_WARNING, 0, ##__VA_ARGS__) | |
631 | #define log_unit_error(unit, ...) log_unit_full(unit, LOG_ERR, 0, ##__VA_ARGS__) | |
632 | ||
633 | #define log_unit_debug_errno(unit, error, ...) log_unit_full(unit, LOG_DEBUG, error, ##__VA_ARGS__) | |
634 | #define log_unit_info_errno(unit, error, ...) log_unit_full(unit, LOG_INFO, error, ##__VA_ARGS__) | |
635 | #define log_unit_notice_errno(unit, error, ...) log_unit_full(unit, LOG_NOTICE, error, ##__VA_ARGS__) | |
636 | #define log_unit_warning_errno(unit, error, ...) log_unit_full(unit, LOG_WARNING, error, ##__VA_ARGS__) | |
637 | #define log_unit_error_errno(unit, error, ...) log_unit_full(unit, LOG_ERR, error, ##__VA_ARGS__) | |
638 | ||
639 | #define LOG_UNIT_MESSAGE(unit, fmt, ...) "MESSAGE=%s: " fmt, (unit)->id, ##__VA_ARGS__ | |
640 | #define LOG_UNIT_ID(unit) (unit)->manager->unit_log_format_string, (unit)->id |