src/core/unit.h

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