src/core/unit.h

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