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