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