src/core/unit.h

   1 /* SPDX-License-Identifier: LGPL-2.1+ */
   2 #pragma once
   3
   4 /***
   5   This file is part of systemd.
   6
   7   Copyright 2010 Lennart Poettering
   8 ***/
   9
  10 #include <stdbool.h>
  11 #include <stdlib.h>
  12 #include <unistd.h>
  13
  14 #include "bpf-program.h"
  15 #include "condition.h"
  16 #include "emergency-action.h"
  17 #include "install.h"
  18 #include "list.h"
  19 #include "unit-name.h"
  20 #include "cgroup.h"
  21
  22 typedef struct UnitRef UnitRef;
  23
  24 typedef enum KillOperation {
  25         KILL_TERMINATE,
  26         KILL_TERMINATE_AND_LOG,
  27         KILL_KILL,
  28         KILL_ABORT,
  29         _KILL_OPERATION_MAX,
  30         _KILL_OPERATION_INVALID = -1
  31 } KillOperation;
  32
  33 typedef enum CollectMode {
  34         COLLECT_INACTIVE,
  35         COLLECT_INACTIVE_OR_FAILED,
  36         _COLLECT_MODE_MAX,
  37         _COLLECT_MODE_INVALID = -1,
  38 } CollectMode;
  39
  40 static inline bool UNIT_IS_ACTIVE_OR_RELOADING(UnitActiveState t) {
  41         return IN_SET(t, UNIT_ACTIVE, UNIT_RELOADING);
  42 }
  43
  44 static inline bool UNIT_IS_ACTIVE_OR_ACTIVATING(UnitActiveState t) {
  45         return IN_SET(t, UNIT_ACTIVE, UNIT_ACTIVATING, UNIT_RELOADING);
  46 }
  47
  48 static inline bool UNIT_IS_INACTIVE_OR_DEACTIVATING(UnitActiveState t) {
  49         return IN_SET(t, UNIT_INACTIVE, UNIT_FAILED, UNIT_DEACTIVATING);
  50 }
  51
  52 static inline bool UNIT_IS_INACTIVE_OR_FAILED(UnitActiveState t) {
  53         return IN_SET(t, UNIT_INACTIVE, UNIT_FAILED);
  54 }
  55
  56 /* Stores the 'reason' a dependency was created as a bit mask, i.e. due to which configuration source it came to be. We
  57  * use this so that we can selectively flush out parts of dependencies again. Note that the same dependency might be
  58  * created as a result of multiple "reasons", hence the bitmask. */
  59 typedef enum UnitDependencyMask {
  60         /* Configured directly by the unit file, .wants/.requries symlink or drop-in, or as an immediate result of a
  61          * non-dependency option configured that way.  */
  62         UNIT_DEPENDENCY_FILE               = 1 << 0,
  63
  64         /* As unconditional implicit dependency (not affected by unit configuration — except by the unit name and
  65          * type) */
  66         UNIT_DEPENDENCY_IMPLICIT           = 1 << 1,
  67
  68         /* A dependency effected by DefaultDependencies=yes. Note that dependencies marked this way are conceptually
  69          * just a subset of UNIT_DEPENDENCY_FILE, as DefaultDependencies= is itself a unit file setting that can only
  70          * be set in unit files. We make this two separate bits only to help debugging how dependencies came to be. */
  71         UNIT_DEPENDENCY_DEFAULT            = 1 << 2,
  72
  73         /* A dependency created from udev rules */
  74         UNIT_DEPENDENCY_UDEV               = 1 << 3,
  75
  76         /* A dependency created because of some unit's RequiresMountsFor= setting */
  77         UNIT_DEPENDENCY_PATH               = 1 << 4,
  78
  79         /* A dependency created because of data read from /proc/self/mountinfo and no other configuration source */
  80         UNIT_DEPENDENCY_MOUNTINFO_IMPLICIT = 1 << 5,
  81
  82         /* A dependency created because of data read from /proc/self/mountinfo, but conditionalized by
  83          * DefaultDependencies= and thus also involving configuration from UNIT_DEPENDENCY_FILE sources */
  84         UNIT_DEPENDENCY_MOUNTINFO_DEFAULT  = 1 << 6,
  85
  86         /* A dependency created because of data read from /proc/swaps and no other configuration source */
  87         UNIT_DEPENDENCY_PROC_SWAP          = 1 << 7,
  88
  89         _UNIT_DEPENDENCY_MASK_FULL         = (1 << 8) - 1,
  90 } UnitDependencyMask;
  91
  92 /* The Unit's dependencies[] hashmaps use this structure as value. It has the same size as a void pointer, and thus can
  93  * be stored directly as hashmap value, without any indirection. Note that this stores two masks, as both the origin
  94  * and the destination of a dependency might have created it. */
  95 typedef union UnitDependencyInfo {
  96         void *data;
  97         struct {
  98                 UnitDependencyMask origin_mask:16;
  99                 UnitDependencyMask destination_mask:16;
 100         } _packed_;
 101 } UnitDependencyInfo;
 102
 103 #include "job.h"
 104
 105 struct UnitRef {
 106         /* Keeps tracks of references to a unit. This is useful so
 107          * that we can merge two units if necessary and correct all
 108          * references to them */
 109
 110         Unit *source, *target;
 111         LIST_FIELDS(UnitRef, refs_by_target);
 112 };
 113
 114 typedef enum UnitCGroupBPFState {
 115         UNIT_CGROUP_BPF_OFF = 0,
 116         UNIT_CGROUP_BPF_ON = 1,
 117         UNIT_CGROUP_BPF_INVALIDATED = -1,
 118 } UnitCGroupBPFState;
 119
 120 typedef struct Unit {
 121         Manager *manager;
 122
 123         UnitType type;
 124         UnitLoadState load_state;
 125         Unit *merged_into;
 126
 127         char *id; /* One name is special because we use it for identification. Points to an entry in the names set */
 128         char *instance;
 129
 130         Set *names;
 131
 132         /* For each dependency type we maintain a Hashmap whose key is the Unit* object, and the value encodes why the
 133          * dependency exists, using the UnitDependencyInfo type */
 134         Hashmap *dependencies[_UNIT_DEPENDENCY_MAX];
 135
 136         /* Similar, for RequiresMountsFor= path dependencies. The key is the path, the value the UnitDependencyInfo type */
 137         Hashmap *requires_mounts_for;
 138
 139         char *description;
 140         char **documentation;
 141
 142         char *fragment_path; /* if loaded from a config file this is the primary path to it */
 143         char *source_path; /* if converted, the source file */
 144         char **dropin_paths;
 145
 146         usec_t fragment_mtime;
 147         usec_t source_mtime;
 148         usec_t dropin_mtime;
 149
 150         /* If this is a transient unit we are currently writing, this is where we are writing it to */
 151         FILE *transient_file;
 152
 153         /* If there is something to do with this unit, then this is the installed job for it */
 154         Job *job;
 155
 156         /* JOB_NOP jobs are special and can be installed without disturbing the real job. */
 157         Job *nop_job;
 158
 159         /* The slot used for watching NameOwnerChanged signals */
 160         sd_bus_slot *match_bus_slot;
 161
 162         /* References to this unit from clients */
 163         sd_bus_track *bus_track;
 164         char **deserialized_refs;
 165
 166         /* Job timeout and action to take */
 167         usec_t job_timeout;
 168         usec_t job_running_timeout;
 169         bool job_running_timeout_set:1;
 170         EmergencyAction job_timeout_action;
 171         char *job_timeout_reboot_arg;
 172
 173         /* References to this */
 174         LIST_HEAD(UnitRef, refs_by_target);
 175
 176         /* Conditions to check */
 177         LIST_HEAD(Condition, conditions);
 178         LIST_HEAD(Condition, asserts);
 179
 180         dual_timestamp condition_timestamp;
 181         dual_timestamp assert_timestamp;
 182
 183         /* Updated whenever the low-level state changes */
 184         dual_timestamp state_change_timestamp;
 185
 186         /* Updated whenever the (high-level) active state enters or leaves the active or inactive states */
 187         dual_timestamp inactive_exit_timestamp;
 188         dual_timestamp active_enter_timestamp;
 189         dual_timestamp active_exit_timestamp;
 190         dual_timestamp inactive_enter_timestamp;
 191
 192         UnitRef slice;
 193
 194         /* Per type list */
 195         LIST_FIELDS(Unit, units_by_type);
 196
 197         /* All units which have requires_mounts_for set */
 198         LIST_FIELDS(Unit, has_requires_mounts_for);
 199
 200         /* Load queue */
 201         LIST_FIELDS(Unit, load_queue);
 202
 203         /* D-Bus queue */
 204         LIST_FIELDS(Unit, dbus_queue);
 205
 206         /* Cleanup queue */
 207         LIST_FIELDS(Unit, cleanup_queue);
 208
 209         /* GC queue */
 210         LIST_FIELDS(Unit, gc_queue);
 211
 212         /* CGroup realize members queue */
 213         LIST_FIELDS(Unit, cgroup_realize_queue);
 214
 215         /* cgroup empty queue */
 216         LIST_FIELDS(Unit, cgroup_empty_queue);
 217
 218         /* Target dependencies queue */
 219         LIST_FIELDS(Unit, target_deps_queue);
 220
 221         /* PIDs we keep an eye on. Note that a unit might have many
 222          * more, but these are the ones we care enough about to
 223          * process SIGCHLD for */
 224         Set *pids;
 225
 226         /* Used in SIGCHLD and sd_notify() message event invocation logic to avoid that we dispatch the same event
 227          * multiple times on the same unit. */
 228         unsigned sigchldgen;
 229         unsigned notifygen;
 230
 231         /* Used during GC sweeps */
 232         unsigned gc_marker;
 233
 234         /* Error code when we didn't manage to load the unit (negative) */
 235         int load_error;
 236
 237         /* Put a ratelimit on unit starting */
 238         RateLimit start_limit;
 239         EmergencyAction start_limit_action;
 240
 241         EmergencyAction failure_action;
 242         EmergencyAction success_action;
 243         char *reboot_arg;
 244
 245         /* Make sure we never enter endless loops with the check unneeded logic, or the BindsTo= logic */
 246         RateLimit auto_stop_ratelimit;
 247
 248         /* Reference to a specific UID/GID */
 249         uid_t ref_uid;
 250         gid_t ref_gid;
 251
 252         /* Cached unit file state and preset */
 253         UnitFileState unit_file_state;
 254         int unit_file_preset;
 255
 256         /* Where the cpu.stat or cpuacct.usage was at the time the unit was started */
 257         nsec_t cpu_usage_base;
 258         nsec_t cpu_usage_last; /* the most recently read value */
 259
 260         /* Counterparts in the cgroup filesystem */
 261         char *cgroup_path;
 262         CGroupMask cgroup_realized_mask;
 263         CGroupMask cgroup_enabled_mask;
 264         CGroupMask cgroup_subtree_mask;
 265         CGroupMask cgroup_members_mask;
 266         int cgroup_inotify_wd;
 267
 268         /* IP BPF Firewalling/accounting */
 269         int ip_accounting_ingress_map_fd;
 270         int ip_accounting_egress_map_fd;
 271
 272         int ipv4_allow_map_fd;
 273         int ipv6_allow_map_fd;
 274         int ipv4_deny_map_fd;
 275         int ipv6_deny_map_fd;
 276
 277         BPFProgram *ip_bpf_ingress, *ip_bpf_ingress_installed;
 278         BPFProgram *ip_bpf_egress, *ip_bpf_egress_installed;
 279
 280         uint64_t ip_accounting_extra[_CGROUP_IP_ACCOUNTING_METRIC_MAX];
 281
 282         /* Low-priority event source which is used to remove watched PIDs that have gone away, and subscribe to any new
 283          * ones which might have appeared. */
 284         sd_event_source *rewatch_pids_event_source;
 285
 286         /* How to start OnFailure units */
 287         JobMode on_failure_job_mode;
 288
 289         /* Tweaking the GC logic */
 290         CollectMode collect_mode;
 291
 292         /* The current invocation ID */
 293         sd_id128_t invocation_id;
 294         char invocation_id_string[SD_ID128_STRING_MAX]; /* useful when logging */
 295
 296         /* Garbage collect us we nobody wants or requires us anymore */
 297         bool stop_when_unneeded;
 298
 299         /* Create default dependencies */
 300         bool default_dependencies;
 301
 302         /* Refuse manual starting, allow starting only indirectly via dependency. */
 303         bool refuse_manual_start;
 304
 305         /* Don't allow the user to stop this unit manually, allow stopping only indirectly via dependency. */
 306         bool refuse_manual_stop;
 307
 308         /* Allow isolation requests */
 309         bool allow_isolate;
 310
 311         /* Ignore this unit when isolating */
 312         bool ignore_on_isolate;
 313
 314         /* Did the last condition check succeed? */
 315         bool condition_result;
 316         bool assert_result;
 317
 318         /* Is this a transient unit? */
 319         bool transient;
 320
 321         /* Is this a unit that is always running and cannot be stopped? */
 322         bool perpetual;
 323
 324         bool in_load_queue:1;
 325         bool in_dbus_queue:1;
 326         bool in_cleanup_queue:1;
 327         bool in_gc_queue:1;
 328         bool in_cgroup_realize_queue:1;
 329         bool in_cgroup_empty_queue:1;
 330         bool in_target_deps_queue:1;
 331
 332         bool sent_dbus_new_signal:1;
 333
 334         bool in_audit:1;
 335         bool on_console:1;
 336
 337         bool cgroup_realized:1;
 338         bool cgroup_members_mask_valid:1;
 339         bool cgroup_subtree_mask_valid:1;
 340
 341         UnitCGroupBPFState cgroup_bpf_state:2;
 342
 343         /* Reset cgroup accounting next time we fork something off */
 344         bool reset_accounting:1;
 345
 346         bool start_limit_hit:1;
 347
 348         /* Did we already invoke unit_coldplug() for this unit? */
 349         bool coldplugged:1;
 350
 351         /* For transient units: whether to add a bus track reference after creating the unit */
 352         bool bus_track_add:1;
 353
 354         /* Remember which unit state files we created */
 355         bool exported_invocation_id:1;
 356         bool exported_log_level_max:1;
 357         bool exported_log_extra_fields:1;
 358
 359         /* When writing transient unit files, stores which section we stored last. If < 0, we didn't write any yet. If
 360          * == 0 we are in the [Unit] section, if > 0 we are in the unit type-specific section. */
 361         int last_section_private:2;
 362 } Unit;
 363
 364 typedef struct UnitStatusMessageFormats {
 365         const char *starting_stopping[2];
 366         const char *finished_start_job[_JOB_RESULT_MAX];
 367         const char *finished_stop_job[_JOB_RESULT_MAX];
 368 } UnitStatusMessageFormats;
 369
 370 /* Flags used when writing drop-in files or transient unit files */
 371 typedef enum UnitWriteFlags {
 372         /* Write a runtime unit file or drop-in (i.e. one below /run) */
 373         UNIT_RUNTIME           = 1 << 0,
 374
 375         /* Write a persistent drop-in (i.e. one below /etc) */
 376         UNIT_PERSISTENT        = 1 << 1,
 377
 378         /* Place this item in the per-unit-type private section, instead of [Unit] */
 379         UNIT_PRIVATE           = 1 << 2,
 380
 381         /* Apply specifier escaping before writing */
 382         UNIT_ESCAPE_SPECIFIERS = 1 << 3,
 383
 384         /* Apply C escaping before writing */
 385         UNIT_ESCAPE_C          = 1 << 4,
 386 } UnitWriteFlags;
 387
 388 /* Returns true if neither persistent, nor runtime storage is requested, i.e. this is a check invocation only */
 389 #define UNIT_WRITE_FLAGS_NOOP(flags) (((flags) & (UNIT_RUNTIME|UNIT_PERSISTENT)) == 0)
 390
 391 #include "kill.h"
 392
 393 typedef struct UnitVTable {
 394         /* How much memory does an object of this unit type need */
 395         size_t object_size;
 396
 397         /* If greater than 0, the offset into the object where
 398          * ExecContext is found, if the unit type has that */
 399         size_t exec_context_offset;
 400
 401         /* If greater than 0, the offset into the object where
 402          * CGroupContext is found, if the unit type has that */
 403         size_t cgroup_context_offset;
 404
 405         /* If greater than 0, the offset into the object where
 406          * KillContext is found, if the unit type has that */
 407         size_t kill_context_offset;
 408
 409         /* If greater than 0, the offset into the object where the
 410          * pointer to ExecRuntime is found, if the unit type has
 411          * that */
 412         size_t exec_runtime_offset;
 413
 414         /* If greater than 0, the offset into the object where the pointer to DynamicCreds is found, if the unit type
 415          * has that. */
 416         size_t dynamic_creds_offset;
 417
 418         /* The name of the configuration file section with the private settings of this unit */
 419         const char *private_section;
 420
 421         /* Config file sections this unit type understands, separated
 422          * by NUL chars */
 423         const char *sections;
 424
 425         /* This should reset all type-specific variables. This should
 426          * not allocate memory, and is called with zero-initialized
 427          * data. It should hence only initialize variables that need
 428          * to be set != 0. */
 429         void (*init)(Unit *u);
 430
 431         /* This should free all type-specific variables. It should be
 432          * idempotent. */
 433         void (*done)(Unit *u);
 434
 435         /* Actually load data from disk. This may fail, and should set
 436          * load_state to UNIT_LOADED, UNIT_MERGED or leave it at
 437          * UNIT_STUB if no configuration could be found. */
 438         int (*load)(Unit *u);
 439
 440         /* During deserialization we only record the intended state to return to. With coldplug() we actually put the
 441          * deserialized state in effect. This is where unit_notify() should be called to start things up. */
 442         int (*coldplug)(Unit *u);
 443
 444         /* This is called shortly after all units' coldplug() call was invoked. It's supposed to catch up state changes
 445          * we missed so far (for example because they took place while we were reloading/reexecing) */
 446         void (*catchup)(Unit *u);
 447
 448         void (*dump)(Unit *u, FILE *f, const char *prefix);
 449
 450         int (*start)(Unit *u);
 451         int (*stop)(Unit *u);
 452         int (*reload)(Unit *u);
 453
 454         int (*kill)(Unit *u, KillWho w, int signo, sd_bus_error *error);
 455
 456         bool (*can_reload)(Unit *u);
 457
 458         /* Write all data that cannot be restored from other sources
 459          * away using unit_serialize_item() */
 460         int (*serialize)(Unit *u, FILE *f, FDSet *fds);
 461
 462         /* Restore one item from the serialization */
 463         int (*deserialize_item)(Unit *u, const char *key, const char *data, FDSet *fds);
 464
 465         /* Try to match up fds with what we need for this unit */
 466         void (*distribute_fds)(Unit *u, FDSet *fds);
 467
 468         /* Boils down the more complex internal state of this unit to
 469          * a simpler one that the engine can understand */
 470         UnitActiveState (*active_state)(Unit *u);
 471
 472         /* Returns the substate specific to this unit type as
 473          * string. This is purely information so that we can give the
 474          * user a more fine grained explanation in which actual state a
 475          * unit is in. */
 476         const char* (*sub_state_to_string)(Unit *u);
 477
 478         /* Additionally to UnitActiveState determine whether unit is to be restarted. */
 479         bool (*will_restart)(Unit *u);
 480
 481         /* Return false when there is a reason to prevent this unit from being gc'ed
 482          * even though nothing references it and it isn't active in any way. */
 483         bool (*may_gc)(Unit *u);
 484
 485         /* When the unit is not running and no job for it queued we shall release its runtime resources */
 486         void (*release_resources)(Unit *u);
 487
 488         /* Invoked on every child that died */
 489         void (*sigchld_event)(Unit *u, pid_t pid, int code, int status);
 490
 491         /* Reset failed state if we are in failed state */
 492         void (*reset_failed)(Unit *u);
 493
 494         /* Called whenever any of the cgroups this unit watches for
 495          * ran empty */
 496         void (*notify_cgroup_empty)(Unit *u);
 497
 498         /* Called whenever a process of this unit sends us a message */
 499         void (*notify_message)(Unit *u, const struct ucred *ucred, char **tags, FDSet *fds);
 500
 501         /* Called whenever a name this Unit registered for comes or goes away. */
 502         void (*bus_name_owner_change)(Unit *u, const char *name, const char *old_owner, const char *new_owner);
 503
 504         /* Called for each property that is being set */
 505         int (*bus_set_property)(Unit *u, const char *name, sd_bus_message *message, UnitWriteFlags flags, sd_bus_error *error);
 506
 507         /* Called after at least one property got changed to apply the necessary change */
 508         int (*bus_commit_properties)(Unit *u);
 509
 510         /* Return the unit this unit is following */
 511         Unit *(*following)(Unit *u);
 512
 513         /* Return the set of units that are following each other */
 514         int (*following_set)(Unit *u, Set **s);
 515
 516         /* Invoked each time a unit this unit is triggering changes
 517          * state or gains/loses a job */
 518         void (*trigger_notify)(Unit *u, Unit *trigger);
 519
 520         /* Called whenever CLOCK_REALTIME made a jump */
 521         void (*time_change)(Unit *u);
 522
 523         /* Called whenever /etc/localtime was modified */
 524         void (*timezone_change)(Unit *u);
 525
 526         /* Returns the next timeout of a unit */
 527         int (*get_timeout)(Unit *u, usec_t *timeout);
 528
 529         /* Returns the main PID if there is any defined, or 0. */
 530         pid_t (*main_pid)(Unit *u);
 531
 532         /* Returns the main PID if there is any defined, or 0. */
 533         pid_t (*control_pid)(Unit *u);
 534
 535         /* Returns true if the unit currently needs access to the console */
 536         bool (*needs_console)(Unit *u);
 537
 538         /* Like the enumerate() callback further down, but only enumerates the perpetual units, i.e. all units that
 539          * unconditionally exist and are always active. The main reason to keep both enumeration functions separate is
 540          * philosophical: the state of perpetual units should be put in place by coldplug(), while the state of those
 541          * discovered through regular enumeration should be put in place by catchup(), see below. */
 542         void (*enumerate_perpetual)(Manager *m);
 543
 544         /* This is called for each unit type and should be used to enumerate units already existing in the system
 545          * internally and load them. However, everything that is loaded here should still stay in inactive state. It is
 546          * the job of the catchup() call above to put the units into the discovered state. */
 547         void (*enumerate)(Manager *m);
 548
 549         /* Type specific cleanups. */
 550         void (*shutdown)(Manager *m);
 551
 552         /* If this function is set and return false all jobs for units
 553          * of this type will immediately fail. */
 554         bool (*supported)(void);
 555
 556         /* The bus vtable */
 557         const sd_bus_vtable *bus_vtable;
 558
 559         /* The strings to print in status messages */
 560         UnitStatusMessageFormats status_message_formats;
 561
 562         /* True if transient units of this type are OK */
 563         bool can_transient:1;
 564
 565         /* True if cgroup delegation is permissible */
 566         bool can_delegate:1;
 567
 568         /* True if units of this type shall be startable only once and then never again */
 569         bool once_only:1;
 570
 571         /* True if queued jobs of this type should be GC'ed if no other job needs them anymore */
 572         bool gc_jobs:1;
 573 } UnitVTable;
 574
 575 extern const UnitVTable * const unit_vtable[_UNIT_TYPE_MAX];
 576
 577 #define UNIT_VTABLE(u) unit_vtable[(u)->type]
 578
 579 /* For casting a unit into the various unit types */
 580 #define DEFINE_CAST(UPPERCASE, MixedCase)                               \
 581         static inline MixedCase* UPPERCASE(Unit *u) {                   \
 582                 if (_unlikely_(!u || u->type != UNIT_##UPPERCASE))      \
 583                         return NULL;                                    \
 584                                                                         \
 585                 return (MixedCase*) u;                                  \
 586         }
 587
 588 /* For casting the various unit types into a unit */
 589 #define UNIT(u) (&(u)->meta)
 590
 591 #define UNIT_HAS_EXEC_CONTEXT(u) (UNIT_VTABLE(u)->exec_context_offset > 0)
 592 #define UNIT_HAS_CGROUP_CONTEXT(u) (UNIT_VTABLE(u)->cgroup_context_offset > 0)
 593 #define UNIT_HAS_KILL_CONTEXT(u) (UNIT_VTABLE(u)->kill_context_offset > 0)
 594
 595 #define UNIT_TRIGGER(u) ((Unit*) hashmap_first_key((u)->dependencies[UNIT_TRIGGERS]))
 596
 597 Unit *unit_new(Manager *m, size_t size);
 598 void unit_free(Unit *u);
 599 DEFINE_TRIVIAL_CLEANUP_FUNC(Unit *, unit_free);
 600
 601 int unit_new_for_name(Manager *m, size_t size, const char *name, Unit **ret);
 602 int unit_add_name(Unit *u, const char *name);
 603
 604 int unit_add_dependency(Unit *u, UnitDependency d, Unit *other, bool add_reference, UnitDependencyMask mask);
 605 int unit_add_two_dependencies(Unit *u, UnitDependency d, UnitDependency e, Unit *other, bool add_reference, UnitDependencyMask mask);
 606
 607 int unit_add_dependency_by_name(Unit *u, UnitDependency d, const char *name, const char *filename, bool add_reference, UnitDependencyMask mask);
 608 int unit_add_two_dependencies_by_name(Unit *u, UnitDependency d, UnitDependency e, const char *name, const char *path, bool add_reference, UnitDependencyMask mask);
 609
 610 int unit_add_exec_dependencies(Unit *u, ExecContext *c);
 611
 612 int unit_choose_id(Unit *u, const char *name);
 613 int unit_set_description(Unit *u, const char *description);
 614
 615 bool unit_may_gc(Unit *u);
 616
 617 void unit_add_to_load_queue(Unit *u);
 618 void unit_add_to_dbus_queue(Unit *u);
 619 void unit_add_to_cleanup_queue(Unit *u);
 620 void unit_add_to_gc_queue(Unit *u);
 621 void unit_add_to_target_deps_queue(Unit *u);
 622
 623 int unit_merge(Unit *u, Unit *other);
 624 int unit_merge_by_name(Unit *u, const char *other);
 625
 626 Unit *unit_follow_merge(Unit *u) _pure_;
 627
 628 int unit_load_fragment_and_dropin(Unit *u);
 629 int unit_load_fragment_and_dropin_optional(Unit *u);
 630 int unit_load(Unit *unit);
 631
 632 int unit_set_slice(Unit *u, Unit *slice);
 633 int unit_set_default_slice(Unit *u);
 634
 635 const char *unit_description(Unit *u) _pure_;
 636
 637 bool unit_has_name(Unit *u, const char *name);
 638
 639 UnitActiveState unit_active_state(Unit *u);
 640
 641 const char* unit_sub_state_to_string(Unit *u);
 642
 643 void unit_dump(Unit *u, FILE *f, const char *prefix);
 644
 645 bool unit_can_reload(Unit *u) _pure_;
 646 bool unit_can_start(Unit *u) _pure_;
 647 bool unit_can_stop(Unit *u) _pure_;
 648 bool unit_can_isolate(Unit *u) _pure_;
 649
 650 int unit_start(Unit *u);
 651 int unit_stop(Unit *u);
 652 int unit_reload(Unit *u);
 653
 654 int unit_kill(Unit *u, KillWho w, int signo, sd_bus_error *error);
 655 int unit_kill_common(Unit *u, KillWho who, int signo, pid_t main_pid, pid_t control_pid, sd_bus_error *error);
 656
 657 typedef enum UnitNotifyFlags {
 658         UNIT_NOTIFY_RELOAD_FAILURE    = 1 << 0,
 659         UNIT_NOTIFY_WILL_AUTO_RESTART = 1 << 1,
 660 } UnitNotifyFlags;
 661
 662 void unit_notify(Unit *u, UnitActiveState os, UnitActiveState ns, UnitNotifyFlags flags);
 663
 664 int unit_watch_pid(Unit *u, pid_t pid);
 665 void unit_unwatch_pid(Unit *u, pid_t pid);
 666 void unit_unwatch_all_pids(Unit *u);
 667
 668 int unit_enqueue_rewatch_pids(Unit *u);
 669 void unit_dequeue_rewatch_pids(Unit *u);
 670
 671 int unit_install_bus_match(Unit *u, sd_bus *bus, const char *name);
 672 int unit_watch_bus_name(Unit *u, const char *name);
 673 void unit_unwatch_bus_name(Unit *u, const char *name);
 674
 675 bool unit_job_is_applicable(Unit *u, JobType j);
 676
 677 int set_unit_path(const char *p);
 678
 679 char *unit_dbus_path(Unit *u);
 680 char *unit_dbus_path_invocation_id(Unit *u);
 681
 682 int unit_load_related_unit(Unit *u, const char *type, Unit **_found);
 683
 684 bool unit_can_serialize(Unit *u) _pure_;
 685
 686 int unit_serialize(Unit *u, FILE *f, FDSet *fds, bool serialize_jobs);
 687 int unit_deserialize(Unit *u, FILE *f, FDSet *fds);
 688 void unit_deserialize_skip(FILE *f);
 689
 690 int unit_serialize_item(Unit *u, FILE *f, const char *key, const char *value);
 691 int unit_serialize_item_escaped(Unit *u, FILE *f, const char *key, const char *value);
 692 int unit_serialize_item_fd(Unit *u, FILE *f, FDSet *fds, const char *key, int fd);
 693 void unit_serialize_item_format(Unit *u, FILE *f, const char *key, const char *value, ...) _printf_(4,5);
 694
 695 int unit_add_node_dependency(Unit *u, const char *what, bool wants, UnitDependency d, UnitDependencyMask mask);
 696
 697 int unit_coldplug(Unit *u);
 698 void unit_catchup(Unit *u);
 699
 700 void unit_status_printf(Unit *u, const char *status, const char *unit_status_msg_format) _printf_(3, 0);
 701 void unit_status_emit_starting_stopping_reloading(Unit *u, JobType t);
 702
 703 bool unit_need_daemon_reload(Unit *u);
 704
 705 void unit_reset_failed(Unit *u);
 706
 707 Unit *unit_following(Unit *u);
 708 int unit_following_set(Unit *u, Set **s);
 709
 710 const char *unit_slice_name(Unit *u);
 711
 712 bool unit_stop_pending(Unit *u) _pure_;
 713 bool unit_inactive_or_pending(Unit *u) _pure_;
 714 bool unit_active_or_pending(Unit *u);
 715 bool unit_will_restart(Unit *u);
 716
 717 int unit_add_default_target_dependency(Unit *u, Unit *target);
 718
 719 void unit_start_on_failure(Unit *u);
 720 void unit_trigger_notify(Unit *u);
 721
 722 UnitFileState unit_get_unit_file_state(Unit *u);
 723 int unit_get_unit_file_preset(Unit *u);
 724
 725 Unit* unit_ref_set(UnitRef *ref, Unit *source, Unit *target);
 726 void unit_ref_unset(UnitRef *ref);
 727
 728 #define UNIT_DEREF(ref) ((ref).target)
 729 #define UNIT_ISSET(ref) (!!(ref).target)
 730
 731 int unit_patch_contexts(Unit *u);
 732
 733 ExecContext *unit_get_exec_context(Unit *u) _pure_;
 734 KillContext *unit_get_kill_context(Unit *u) _pure_;
 735 CGroupContext *unit_get_cgroup_context(Unit *u) _pure_;
 736
 737 ExecRuntime *unit_get_exec_runtime(Unit *u) _pure_;
 738
 739 int unit_setup_exec_runtime(Unit *u);
 740 int unit_setup_dynamic_creds(Unit *u);
 741
 742 char* unit_escape_setting(const char *s, UnitWriteFlags flags, char **buf);
 743 char* unit_concat_strv(char **l, UnitWriteFlags flags);
 744
 745 int unit_write_setting(Unit *u, UnitWriteFlags flags, const char *name, const char *data);
 746 int unit_write_settingf(Unit *u, UnitWriteFlags mode, const char *name, const char *format, ...) _printf_(4,5);
 747
 748 int unit_kill_context(Unit *u, KillContext *c, KillOperation k, pid_t main_pid, pid_t control_pid, bool main_pid_alien);
 749
 750 int unit_make_transient(Unit *u);
 751
 752 int unit_require_mounts_for(Unit *u, const char *path, UnitDependencyMask mask);
 753
 754 bool unit_type_supported(UnitType t);
 755
 756 bool unit_is_pristine(Unit *u);
 757
 758 pid_t unit_control_pid(Unit *u);
 759 pid_t unit_main_pid(Unit *u);
 760
 761 static inline bool unit_supported(Unit *u) {
 762         return unit_type_supported(u->type);
 763 }
 764
 765 void unit_warn_if_dir_nonempty(Unit *u, const char* where);
 766 int unit_fail_if_noncanonical(Unit *u, const char* where);
 767
 768 int unit_start_limit_test(Unit *u);
 769
 770 void unit_unref_uid(Unit *u, bool destroy_now);
 771 int unit_ref_uid(Unit *u, uid_t uid, bool clean_ipc);
 772
 773 void unit_unref_gid(Unit *u, bool destroy_now);
 774 int unit_ref_gid(Unit *u, gid_t gid, bool clean_ipc);
 775
 776 int unit_ref_uid_gid(Unit *u, uid_t uid, gid_t gid);
 777 void unit_unref_uid_gid(Unit *u, bool destroy_now);
 778
 779 void unit_notify_user_lookup(Unit *u, uid_t uid, gid_t gid);
 780
 781 int unit_set_invocation_id(Unit *u, sd_id128_t id);
 782 int unit_acquire_invocation_id(Unit *u);
 783
 784 bool unit_shall_confirm_spawn(Unit *u);
 785
 786 void unit_set_exec_params(Unit *s, ExecParameters *p);
 787
 788 int unit_fork_helper_process(Unit *u, const char *name, pid_t *ret);
 789
 790 void unit_remove_dependencies(Unit *u, UnitDependencyMask mask);
 791
 792 void unit_export_state_files(Unit *u);
 793 void unit_unlink_state_files(Unit *u);
 794
 795 int unit_prepare_exec(Unit *u);
 796
 797 void unit_warn_leftover_processes(Unit *u);
 798
 799 bool unit_needs_console(Unit *u);
 800
 801 const char *unit_label_path(Unit *u);
 802
 803 int unit_pid_attachable(Unit *unit, pid_t pid, sd_bus_error *error);
 804
 805 /* Macros which append UNIT= or USER_UNIT= to the message */
 806
 807 #define log_unit_full(unit, level, error, ...)                          \
 808         ({                                                              \
 809                 const Unit *_u = (unit);                                \
 810                 _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__) : \
 811                         log_internal(level, error, __FILE__, __LINE__, __func__, ##__VA_ARGS__); \
 812         })
 813
 814 #define log_unit_debug(unit, ...)   log_unit_full(unit, LOG_DEBUG, 0, ##__VA_ARGS__)
 815 #define log_unit_info(unit, ...)    log_unit_full(unit, LOG_INFO, 0, ##__VA_ARGS__)
 816 #define log_unit_notice(unit, ...)  log_unit_full(unit, LOG_NOTICE, 0, ##__VA_ARGS__)
 817 #define log_unit_warning(unit, ...) log_unit_full(unit, LOG_WARNING, 0, ##__VA_ARGS__)
 818 #define log_unit_error(unit, ...)   log_unit_full(unit, LOG_ERR, 0, ##__VA_ARGS__)
 819
 820 #define log_unit_debug_errno(unit, error, ...)   log_unit_full(unit, LOG_DEBUG, error, ##__VA_ARGS__)
 821 #define log_unit_info_errno(unit, error, ...)    log_unit_full(unit, LOG_INFO, error, ##__VA_ARGS__)
 822 #define log_unit_notice_errno(unit, error, ...)  log_unit_full(unit, LOG_NOTICE, error, ##__VA_ARGS__)
 823 #define log_unit_warning_errno(unit, error, ...) log_unit_full(unit, LOG_WARNING, error, ##__VA_ARGS__)
 824 #define log_unit_error_errno(unit, error, ...)   log_unit_full(unit, LOG_ERR, error, ##__VA_ARGS__)
 825
 826 #define LOG_UNIT_MESSAGE(unit, fmt, ...) "MESSAGE=%s: " fmt, (unit)->id, ##__VA_ARGS__
 827 #define LOG_UNIT_ID(unit) (unit)->manager->unit_log_format_string, (unit)->id
 828 #define LOG_UNIT_INVOCATION_ID(unit) (unit)->manager->invocation_log_format_string, (unit)->invocation_id_string
 829
 830 const char* collect_mode_to_string(CollectMode m) _const_;
 831 CollectMode collect_mode_from_string(const char *s) _pure_;