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