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