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