src/core/unit.h

   1 #pragma once
   2
   3 /***
   4   This file is part of systemd.
   5
   6   Copyright 2010 Lennart Poettering
   7
   8   systemd is free software; you can redistribute it and/or modify it
   9   under the terms of the GNU Lesser General Public License as published by
  10   the Free Software Foundation; either version 2.1 of the License, or
  11   (at your option) any later version.
  12
  13   systemd is distributed in the hope that it will be useful, but
  14   WITHOUT ANY WARRANTY; without even the implied warranty of
  15   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  16   Lesser General Public License for more details.
  17
  18   You should have received a copy of the GNU Lesser General Public License
  19   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  20 ***/
  21
  22 #include <stdbool.h>
  23 #include <stdlib.h>
  24 #include <unistd.h>
  25
  26 typedef struct Unit Unit;
  27 typedef struct UnitVTable UnitVTable;
  28 typedef struct UnitRef UnitRef;
  29 typedef struct UnitStatusMessageFormats UnitStatusMessageFormats;
  30
  31 #include "bpf-program.h"
  32 #include "condition.h"
  33 #include "emergency-action.h"
  34 #include "install.h"
  35 #include "list.h"
  36 #include "unit-name.h"
  37 #include "cgroup.h"
  38
  39 typedef enum KillOperation {
  40         KILL_TERMINATE,
  41         KILL_TERMINATE_AND_LOG,
  42         KILL_KILL,
  43         KILL_ABORT,
  44         _KILL_OPERATION_MAX,
  45         _KILL_OPERATION_INVALID = -1
  46 } KillOperation;
  47
  48 static inline bool UNIT_IS_ACTIVE_OR_RELOADING(UnitActiveState t) {
  49         return t == UNIT_ACTIVE || t == UNIT_RELOADING;
  50 }
  51
  52 static inline bool UNIT_IS_ACTIVE_OR_ACTIVATING(UnitActiveState t) {
  53         return t == UNIT_ACTIVE || t == UNIT_ACTIVATING || t == UNIT_RELOADING;
  54 }
  55
  56 static inline bool UNIT_IS_INACTIVE_OR_DEACTIVATING(UnitActiveState t) {
  57         return t == UNIT_INACTIVE || t == UNIT_FAILED || t == UNIT_DEACTIVATING;
  58 }
  59
  60 static inline bool UNIT_IS_INACTIVE_OR_FAILED(UnitActiveState t) {
  61         return t == UNIT_INACTIVE || t == UNIT_FAILED;
  62 }
  63
  64 #include "job.h"
  65
  66 struct UnitRef {
  67         /* Keeps tracks of references to a unit. This is useful so
  68          * that we can merge two units if necessary and correct all
  69          * references to them */
  70
  71         Unit* unit;
  72         LIST_FIELDS(UnitRef, refs);
  73 };
  74
  75 typedef enum UnitCGroupBPFState {
  76         UNIT_CGROUP_BPF_OFF = 0,
  77         UNIT_CGROUP_BPF_ON = 1,
  78         UNIT_CGROUP_BPF_INVALIDATED = -1,
  79 } UnitCGroupBPFState;
  80
  81 struct Unit {
  82         Manager *manager;
  83
  84         UnitType type;
  85         UnitLoadState load_state;
  86         Unit *merged_into;
  87
  88         char *id; /* One name is special because we use it for identification. Points to an entry in the names set */
  89         char *instance;
  90
  91         Set *names;
  92         Set *dependencies[_UNIT_DEPENDENCY_MAX];
  93
  94         char **requires_mounts_for;
  95
  96         char *description;
  97         char **documentation;
  98
  99         char *fragment_path; /* if loaded from a config file this is the primary path to it */
 100         char *source_path; /* if converted, the source file */
 101         char **dropin_paths;
 102
 103         usec_t fragment_mtime;
 104         usec_t source_mtime;
 105         usec_t dropin_mtime;
 106
 107         /* If this is a transient unit we are currently writing, this is where we are writing it to */
 108         FILE *transient_file;
 109
 110         /* If there is something to do with this unit, then this is the installed job for it */
 111         Job *job;
 112
 113         /* JOB_NOP jobs are special and can be installed without disturbing the real job. */
 114         Job *nop_job;
 115
 116         /* The slot used for watching NameOwnerChanged signals */
 117         sd_bus_slot *match_bus_slot;
 118
 119         /* References to this unit from clients */
 120         sd_bus_track *bus_track;
 121         char **deserialized_refs;
 122
 123         /* Job timeout and action to take */
 124         usec_t job_timeout;
 125         usec_t job_running_timeout;
 126         EmergencyAction job_timeout_action;
 127         char *job_timeout_reboot_arg;
 128
 129         /* References to this */
 130         LIST_HEAD(UnitRef, refs);
 131
 132         /* Conditions to check */
 133         LIST_HEAD(Condition, conditions);
 134         LIST_HEAD(Condition, asserts);
 135
 136         dual_timestamp condition_timestamp;
 137         dual_timestamp assert_timestamp;
 138
 139         /* Updated whenever the low-level state changes */
 140         dual_timestamp state_change_timestamp;
 141
 142         /* Updated whenever the (high-level) active state enters or leaves the active or inactive states */
 143         dual_timestamp inactive_exit_timestamp;
 144         dual_timestamp active_enter_timestamp;
 145         dual_timestamp active_exit_timestamp;
 146         dual_timestamp inactive_enter_timestamp;
 147
 148         UnitRef slice;
 149
 150         /* Per type list */
 151         LIST_FIELDS(Unit, units_by_type);
 152
 153         /* All units which have requires_mounts_for set */
 154         LIST_FIELDS(Unit, has_requires_mounts_for);
 155
 156         /* Load queue */
 157         LIST_FIELDS(Unit, load_queue);
 158
 159         /* D-Bus queue */
 160         LIST_FIELDS(Unit, dbus_queue);
 161
 162         /* Cleanup queue */
 163         LIST_FIELDS(Unit, cleanup_queue);
 164
 165         /* GC queue */
 166         LIST_FIELDS(Unit, gc_queue);
 167
 168         /* CGroup realize members queue */
 169         LIST_FIELDS(Unit, cgroup_realize_queue);
 170
 171         /* PIDs we keep an eye on. Note that a unit might have many
 172          * more, but these are the ones we care enough about to
 173          * process SIGCHLD for */
 174         Set *pids;
 175
 176         /* Used in sigchld event invocation to avoid repeat events being invoked */
 177         uint64_t sigchldgen;
 178
 179         /* Used during GC sweeps */
 180         unsigned gc_marker;
 181
 182         /* Error code when we didn't manage to load the unit (negative) */
 183         int load_error;
 184
 185         /* Put a ratelimit on unit starting */
 186         RateLimit start_limit;
 187         EmergencyAction start_limit_action;
 188         char *reboot_arg;
 189
 190         /* Make sure we never enter endless loops with the check unneeded logic, or the BindsTo= logic */
 191         RateLimit auto_stop_ratelimit;
 192
 193         /* Reference to a specific UID/GID */
 194         uid_t ref_uid;
 195         gid_t ref_gid;
 196
 197         /* Cached unit file state and preset */
 198         UnitFileState unit_file_state;
 199         int unit_file_preset;
 200
 201         /* Where the cpu.stat or cpuacct.usage was at the time the unit was started */
 202         nsec_t cpu_usage_base;
 203         nsec_t cpu_usage_last; /* the most recently read value */
 204
 205         /* Counterparts in the cgroup filesystem */
 206         char *cgroup_path;
 207         CGroupMask cgroup_realized_mask;
 208         CGroupMask cgroup_enabled_mask;
 209         CGroupMask cgroup_subtree_mask;
 210         CGroupMask cgroup_members_mask;
 211         int cgroup_inotify_wd;
 212
 213         /* IP BPF Firewalling/accounting */
 214         int ip_accounting_ingress_map_fd;
 215         int ip_accounting_egress_map_fd;
 216
 217         int ipv4_allow_map_fd;
 218         int ipv6_allow_map_fd;
 219         int ipv4_deny_map_fd;
 220         int ipv6_deny_map_fd;
 221
 222         BPFProgram *ip_bpf_ingress;
 223         BPFProgram *ip_bpf_egress;
 224
 225         uint64_t ip_accounting_extra[_CGROUP_IP_ACCOUNTING_METRIC_MAX];
 226
 227         /* How to start OnFailure units */
 228         JobMode on_failure_job_mode;
 229
 230         /* The current invocation ID */
 231         sd_id128_t invocation_id;
 232         char invocation_id_string[SD_ID128_STRING_MAX]; /* useful when logging */
 233
 234         /* Garbage collect us we nobody wants or requires us anymore */
 235         bool stop_when_unneeded;
 236
 237         /* Create default dependencies */
 238         bool default_dependencies;
 239
 240         /* Refuse manual starting, allow starting only indirectly via dependency. */
 241         bool refuse_manual_start;
 242
 243         /* Don't allow the user to stop this unit manually, allow stopping only indirectly via dependency. */
 244         bool refuse_manual_stop;
 245
 246         /* Allow isolation requests */
 247         bool allow_isolate;
 248
 249         /* Ignore this unit when isolating */
 250         bool ignore_on_isolate;
 251
 252         /* Did the last condition check succeed? */
 253         bool condition_result;
 254         bool assert_result;
 255
 256         /* Is this a transient unit? */
 257         bool transient;
 258
 259         /* Is this a unit that is always running and cannot be stopped? */
 260         bool perpetual;
 261
 262         bool in_load_queue:1;
 263         bool in_dbus_queue:1;
 264         bool in_cleanup_queue:1;
 265         bool in_gc_queue:1;
 266         bool in_cgroup_realize_queue:1;
 267
 268         bool sent_dbus_new_signal:1;
 269
 270         bool in_audit:1;
 271
 272         bool cgroup_realized:1;
 273         bool cgroup_members_mask_valid:1;
 274         bool cgroup_subtree_mask_valid:1;
 275
 276         UnitCGroupBPFState cgroup_bpf_state:2;
 277
 278         bool start_limit_hit:1;
 279
 280         /* Did we already invoke unit_coldplug() for this unit? */
 281         bool coldplugged:1;
 282
 283         /* For transient units: whether to add a bus track reference after creating the unit */
 284         bool bus_track_add:1;
 285 };
 286
 287 struct UnitStatusMessageFormats {
 288         const char *starting_stopping[2];
 289         const char *finished_start_job[_JOB_RESULT_MAX];
 290         const char *finished_stop_job[_JOB_RESULT_MAX];
 291 };
 292
 293 typedef enum UnitSetPropertiesMode {
 294         UNIT_CHECK = 0,
 295         UNIT_RUNTIME = 1,
 296         UNIT_PERSISTENT = 2,
 297 } UnitSetPropertiesMode;
 298
 299 #include "automount.h"
 300 #include "device.h"
 301 #include "path.h"
 302 #include "scope.h"
 303 #include "slice.h"
 304 #include "socket.h"
 305 #include "swap.h"
 306 #include "target.h"
 307 #include "timer.h"
 308
 309 struct UnitVTable {
 310         /* How much memory does an object of this unit type need */
 311         size_t object_size;
 312
 313         /* If greater than 0, the offset into the object where
 314          * ExecContext is found, if the unit type has that */
 315         size_t exec_context_offset;
 316
 317         /* If greater than 0, the offset into the object where
 318          * CGroupContext is found, if the unit type has that */
 319         size_t cgroup_context_offset;
 320
 321         /* If greater than 0, the offset into the object where
 322          * KillContext is found, if the unit type has that */
 323         size_t kill_context_offset;
 324
 325         /* If greater than 0, the offset into the object where the
 326          * pointer to ExecRuntime is found, if the unit type has
 327          * that */
 328         size_t exec_runtime_offset;
 329
 330         /* If greater than 0, the offset into the object where the pointer to DynamicCreds is found, if the unit type
 331          * has that. */
 332         size_t dynamic_creds_offset;
 333
 334         /* The name of the configuration file section with the private settings of this unit */
 335         const char *private_section;
 336
 337         /* Config file sections this unit type understands, separated
 338          * by NUL chars */
 339         const char *sections;
 340
 341         /* This should reset all type-specific variables. This should
 342          * not allocate memory, and is called with zero-initialized
 343          * data. It should hence only initialize variables that need
 344          * to be set != 0. */
 345         void (*init)(Unit *u);
 346
 347         /* This should free all type-specific variables. It should be
 348          * idempotent. */
 349         void (*done)(Unit *u);
 350
 351         /* Actually load data from disk. This may fail, and should set
 352          * load_state to UNIT_LOADED, UNIT_MERGED or leave it at
 353          * UNIT_STUB if no configuration could be found. */
 354         int (*load)(Unit *u);
 355
 356         /* If a lot of units got created via enumerate(), this is
 357          * where to actually set the state and call unit_notify(). */
 358         int (*coldplug)(Unit *u);
 359
 360         void (*dump)(Unit *u, FILE *f, const char *prefix);
 361
 362         int (*start)(Unit *u);
 363         int (*stop)(Unit *u);
 364         int (*reload)(Unit *u);
 365
 366         int (*kill)(Unit *u, KillWho w, int signo, sd_bus_error *error);
 367
 368         bool (*can_reload)(Unit *u);
 369
 370         /* Write all data that cannot be restored from other sources
 371          * away using unit_serialize_item() */
 372         int (*serialize)(Unit *u, FILE *f, FDSet *fds);
 373
 374         /* Restore one item from the serialization */
 375         int (*deserialize_item)(Unit *u, const char *key, const char *data, FDSet *fds);
 376
 377         /* Try to match up fds with what we need for this unit */
 378         void (*distribute_fds)(Unit *u, FDSet *fds);
 379
 380         /* Boils down the more complex internal state of this unit to
 381          * a simpler one that the engine can understand */
 382         UnitActiveState (*active_state)(Unit *u);
 383
 384         /* Returns the substate specific to this unit type as
 385          * string. This is purely information so that we can give the
 386          * user a more fine grained explanation in which actual state a
 387          * unit is in. */
 388         const char* (*sub_state_to_string)(Unit *u);
 389
 390         /* Return true when there is reason to keep this entry around
 391          * even nothing references it and it isn't active in any
 392          * way */
 393         bool (*check_gc)(Unit *u);
 394
 395         /* When the unit is not running and no job for it queued we
 396          * shall release its runtime resources */
 397         void (*release_resources)(Unit *u, bool inactive);
 398
 399         /* Invoked on every child that died */
 400         void (*sigchld_event)(Unit *u, pid_t pid, int code, int status);
 401
 402         /* Reset failed state if we are in failed state */
 403         void (*reset_failed)(Unit *u);
 404
 405         /* Called whenever any of the cgroups this unit watches for
 406          * ran empty */
 407         void (*notify_cgroup_empty)(Unit *u);
 408
 409         /* Called whenever a process of this unit sends us a message */
 410         void (*notify_message)(Unit *u, pid_t pid, char **tags, FDSet *fds);
 411
 412         /* Called whenever a name this Unit registered for comes or goes away. */
 413         void (*bus_name_owner_change)(Unit *u, const char *name, const char *old_owner, const char *new_owner);
 414
 415         /* Called for each property that is being set */
 416         int (*bus_set_property)(Unit *u, const char *name, sd_bus_message *message, UnitSetPropertiesMode mode, sd_bus_error *error);
 417
 418         /* Called after at least one property got changed to apply the necessary change */
 419         int (*bus_commit_properties)(Unit *u);
 420
 421         /* Return the unit this unit is following */
 422         Unit *(*following)(Unit *u);
 423
 424         /* Return the set of units that are following each other */
 425         int (*following_set)(Unit *u, Set **s);
 426
 427         /* Invoked each time a unit this unit is triggering changes
 428          * state or gains/loses a job */
 429         void (*trigger_notify)(Unit *u, Unit *trigger);
 430
 431         /* Called whenever CLOCK_REALTIME made a jump */
 432         void (*time_change)(Unit *u);
 433
 434         /* Returns the next timeout of a unit */
 435         int (*get_timeout)(Unit *u, usec_t *timeout);
 436
 437         /* Returns the main PID if there is any defined, or 0. */
 438         pid_t (*main_pid)(Unit *u);
 439
 440         /* Returns the main PID if there is any defined, or 0. */
 441         pid_t (*control_pid)(Unit *u);
 442
 443         /* This is called for each unit type and should be used to
 444          * enumerate existing devices and load them. However,
 445          * everything that is loaded here should still stay in
 446          * inactive state. It is the job of the coldplug() call above
 447          * to put the units into the initial state.  */
 448         void (*enumerate)(Manager *m);
 449
 450         /* Type specific cleanups. */
 451         void (*shutdown)(Manager *m);
 452
 453         /* If this function is set and return false all jobs for units
 454          * of this type will immediately fail. */
 455         bool (*supported)(void);
 456
 457         /* The bus vtable */
 458         const sd_bus_vtable *bus_vtable;
 459
 460         /* The strings to print in status messages */
 461         UnitStatusMessageFormats status_message_formats;
 462
 463         /* True if transient units of this type are OK */
 464         bool can_transient:1;
 465
 466         /* True if queued jobs of this type should be GC'ed if no other job needs them anymore */
 467         bool gc_jobs:1;
 468 };
 469
 470 extern const UnitVTable * const unit_vtable[_UNIT_TYPE_MAX];
 471
 472 #define UNIT_VTABLE(u) unit_vtable[(u)->type]
 473
 474 /* For casting a unit into the various unit types */
 475 #define DEFINE_CAST(UPPERCASE, MixedCase)                               \
 476         static inline MixedCase* UPPERCASE(Unit *u) {                   \
 477                 if (_unlikely_(!u || u->type != UNIT_##UPPERCASE))      \
 478                         return NULL;                                    \
 479                                                                         \
 480                 return (MixedCase*) u;                                  \
 481         }
 482
 483 /* For casting the various unit types into a unit */
 484 #define UNIT(u) (&(u)->meta)
 485
 486 #define UNIT_HAS_EXEC_CONTEXT(u) (UNIT_VTABLE(u)->exec_context_offset > 0)
 487 #define UNIT_HAS_CGROUP_CONTEXT(u) (UNIT_VTABLE(u)->cgroup_context_offset > 0)
 488 #define UNIT_HAS_KILL_CONTEXT(u) (UNIT_VTABLE(u)->kill_context_offset > 0)
 489
 490 #define UNIT_TRIGGER(u) ((Unit*) set_first((u)->dependencies[UNIT_TRIGGERS]))
 491
 492 DEFINE_CAST(SERVICE, Service);
 493 DEFINE_CAST(SOCKET, Socket);
 494 DEFINE_CAST(TARGET, Target);
 495 DEFINE_CAST(DEVICE, Device);
 496 DEFINE_CAST(MOUNT, Mount);
 497 DEFINE_CAST(AUTOMOUNT, Automount);
 498 DEFINE_CAST(SWAP, Swap);
 499 DEFINE_CAST(TIMER, Timer);
 500 DEFINE_CAST(PATH, Path);
 501 DEFINE_CAST(SLICE, Slice);
 502 DEFINE_CAST(SCOPE, Scope);
 503
 504 Unit *unit_new(Manager *m, size_t size);
 505 void unit_free(Unit *u);
 506
 507 int unit_new_for_name(Manager *m, size_t size, const char *name, Unit **ret);
 508 int unit_add_name(Unit *u, const char *name);
 509
 510 int unit_add_dependency(Unit *u, UnitDependency d, Unit *other, bool add_reference);
 511 int unit_add_two_dependencies(Unit *u, UnitDependency d, UnitDependency e, Unit *other, bool add_reference);
 512
 513 int unit_add_dependency_by_name(Unit *u, UnitDependency d, const char *name, const char *filename, bool add_reference);
 514 int unit_add_two_dependencies_by_name(Unit *u, UnitDependency d, UnitDependency e, const char *name, const char *path, bool add_reference);
 515
 516 int unit_add_exec_dependencies(Unit *u, ExecContext *c);
 517
 518 int unit_choose_id(Unit *u, const char *name);
 519 int unit_set_description(Unit *u, const char *description);
 520
 521 bool unit_check_gc(Unit *u);
 522
 523 void unit_add_to_load_queue(Unit *u);
 524 void unit_add_to_dbus_queue(Unit *u);
 525 void unit_add_to_cleanup_queue(Unit *u);
 526 void unit_add_to_gc_queue(Unit *u);
 527
 528 int unit_merge(Unit *u, Unit *other);
 529 int unit_merge_by_name(Unit *u, const char *other);
 530
 531 Unit *unit_follow_merge(Unit *u) _pure_;
 532
 533 int unit_load_fragment_and_dropin(Unit *u);
 534 int unit_load_fragment_and_dropin_optional(Unit *u);
 535 int unit_load(Unit *unit);
 536
 537 int unit_set_slice(Unit *u, Unit *slice);
 538 int unit_set_default_slice(Unit *u);
 539
 540 const char *unit_description(Unit *u) _pure_;
 541
 542 bool unit_has_name(Unit *u, const char *name);
 543
 544 UnitActiveState unit_active_state(Unit *u);
 545
 546 const char* unit_sub_state_to_string(Unit *u);
 547
 548 void unit_dump(Unit *u, FILE *f, const char *prefix);
 549
 550 bool unit_can_reload(Unit *u) _pure_;
 551 bool unit_can_start(Unit *u) _pure_;
 552 bool unit_can_stop(Unit *u) _pure_;
 553 bool unit_can_isolate(Unit *u) _pure_;
 554
 555 int unit_start(Unit *u);
 556 int unit_stop(Unit *u);
 557 int unit_reload(Unit *u);
 558
 559 int unit_kill(Unit *u, KillWho w, int signo, sd_bus_error *error);
 560 int unit_kill_common(Unit *u, KillWho who, int signo, pid_t main_pid, pid_t control_pid, sd_bus_error *error);
 561
 562 void unit_notify(Unit *u, UnitActiveState os, UnitActiveState ns, bool reload_success);
 563
 564 int unit_watch_pid(Unit *u, pid_t pid);
 565 void unit_unwatch_pid(Unit *u, pid_t pid);
 566 void unit_unwatch_all_pids(Unit *u);
 567
 568 void unit_tidy_watch_pids(Unit *u, pid_t except1, pid_t except2);
 569
 570 int unit_install_bus_match(Unit *u, sd_bus *bus, const char *name);
 571 int unit_watch_bus_name(Unit *u, const char *name);
 572 void unit_unwatch_bus_name(Unit *u, const char *name);
 573
 574 bool unit_job_is_applicable(Unit *u, JobType j);
 575
 576 int set_unit_path(const char *p);
 577
 578 char *unit_dbus_path(Unit *u);
 579 char *unit_dbus_path_invocation_id(Unit *u);
 580
 581 int unit_load_related_unit(Unit *u, const char *type, Unit **_found);
 582
 583 bool unit_can_serialize(Unit *u) _pure_;
 584
 585 int unit_serialize(Unit *u, FILE *f, FDSet *fds, bool serialize_jobs);
 586 int unit_deserialize(Unit *u, FILE *f, FDSet *fds);
 587 void unit_deserialize_skip(FILE *f);
 588
 589 int unit_serialize_item(Unit *u, FILE *f, const char *key, const char *value);
 590 int unit_serialize_item_escaped(Unit *u, FILE *f, const char *key, const char *value);
 591 int unit_serialize_item_fd(Unit *u, FILE *f, FDSet *fds, const char *key, int fd);
 592 void unit_serialize_item_format(Unit *u, FILE *f, const char *key, const char *value, ...) _printf_(4,5);
 593
 594 int unit_add_node_link(Unit *u, const char *what, bool wants, UnitDependency d);
 595
 596 int unit_coldplug(Unit *u);
 597
 598 void unit_status_printf(Unit *u, const char *status, const char *unit_status_msg_format) _printf_(3, 0);
 599 void unit_status_emit_starting_stopping_reloading(Unit *u, JobType t);
 600
 601 bool unit_need_daemon_reload(Unit *u);
 602
 603 void unit_reset_failed(Unit *u);
 604
 605 Unit *unit_following(Unit *u);
 606 int unit_following_set(Unit *u, Set **s);
 607
 608 const char *unit_slice_name(Unit *u);
 609
 610 bool unit_stop_pending(Unit *u) _pure_;
 611 bool unit_inactive_or_pending(Unit *u) _pure_;
 612 bool unit_active_or_pending(Unit *u);
 613
 614 int unit_add_default_target_dependency(Unit *u, Unit *target);
 615
 616 void unit_start_on_failure(Unit *u);
 617 void unit_trigger_notify(Unit *u);
 618
 619 UnitFileState unit_get_unit_file_state(Unit *u);
 620 int unit_get_unit_file_preset(Unit *u);
 621
 622 Unit* unit_ref_set(UnitRef *ref, Unit *u);
 623 void unit_ref_unset(UnitRef *ref);
 624
 625 #define UNIT_DEREF(ref) ((ref).unit)
 626 #define UNIT_ISSET(ref) (!!(ref).unit)
 627
 628 int unit_patch_contexts(Unit *u);
 629
 630 ExecContext *unit_get_exec_context(Unit *u) _pure_;
 631 KillContext *unit_get_kill_context(Unit *u) _pure_;
 632 CGroupContext *unit_get_cgroup_context(Unit *u) _pure_;
 633
 634 ExecRuntime *unit_get_exec_runtime(Unit *u) _pure_;
 635
 636 int unit_setup_exec_runtime(Unit *u);
 637 int unit_setup_dynamic_creds(Unit *u);
 638
 639 int unit_write_drop_in(Unit *u, UnitSetPropertiesMode mode, const char *name, const char *data);
 640 int unit_write_drop_in_format(Unit *u, UnitSetPropertiesMode mode, const char *name, const char *format, ...) _printf_(4,5);
 641
 642 int unit_write_drop_in_private(Unit *u, UnitSetPropertiesMode mode, const char *name, const char *data);
 643 int unit_write_drop_in_private_format(Unit *u, UnitSetPropertiesMode mode, const char *name, const char *format, ...) _printf_(4,5);
 644
 645 int unit_kill_context(Unit *u, KillContext *c, KillOperation k, pid_t main_pid, pid_t control_pid, bool main_pid_alien);
 646
 647 int unit_make_transient(Unit *u);
 648
 649 int unit_require_mounts_for(Unit *u, const char *path);
 650
 651 bool unit_type_supported(UnitType t);
 652
 653 bool unit_is_pristine(Unit *u);
 654
 655 pid_t unit_control_pid(Unit *u);
 656 pid_t unit_main_pid(Unit *u);
 657
 658 static inline bool unit_supported(Unit *u) {
 659         return unit_type_supported(u->type);
 660 }
 661
 662 void unit_warn_if_dir_nonempty(Unit *u, const char* where);
 663 int unit_fail_if_symlink(Unit *u, const char* where);
 664
 665 int unit_start_limit_test(Unit *u);
 666
 667 void unit_unref_uid(Unit *u, bool destroy_now);
 668 int unit_ref_uid(Unit *u, uid_t uid, bool clean_ipc);
 669
 670 void unit_unref_gid(Unit *u, bool destroy_now);
 671 int unit_ref_gid(Unit *u, gid_t gid, bool clean_ipc);
 672
 673 int unit_ref_uid_gid(Unit *u, uid_t uid, gid_t gid);
 674 void unit_unref_uid_gid(Unit *u, bool destroy_now);
 675
 676 void unit_notify_user_lookup(Unit *u, uid_t uid, gid_t gid);
 677
 678 int unit_set_invocation_id(Unit *u, sd_id128_t id);
 679 int unit_acquire_invocation_id(Unit *u);
 680
 681 bool unit_shall_confirm_spawn(Unit *u);
 682
 683 void unit_set_exec_params(Unit *s, ExecParameters *p);
 684
 685 int unit_fork_helper_process(Unit *u, pid_t *ret);
 686
 687 /* Macros which append UNIT= or USER_UNIT= to the message */
 688
 689 #define log_unit_full(unit, level, error, ...)                          \
 690         ({                                                              \
 691                 const Unit *_u = (unit);                                \
 692                 _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__) : \
 693                         log_internal(level, error, __FILE__, __LINE__, __func__, ##__VA_ARGS__); \
 694         })
 695
 696 #define log_unit_debug(unit, ...)   log_unit_full(unit, LOG_DEBUG, 0, ##__VA_ARGS__)
 697 #define log_unit_info(unit, ...)    log_unit_full(unit, LOG_INFO, 0, ##__VA_ARGS__)
 698 #define log_unit_notice(unit, ...)  log_unit_full(unit, LOG_NOTICE, 0, ##__VA_ARGS__)
 699 #define log_unit_warning(unit, ...) log_unit_full(unit, LOG_WARNING, 0, ##__VA_ARGS__)
 700 #define log_unit_error(unit, ...)   log_unit_full(unit, LOG_ERR, 0, ##__VA_ARGS__)
 701
 702 #define log_unit_debug_errno(unit, error, ...)   log_unit_full(unit, LOG_DEBUG, error, ##__VA_ARGS__)
 703 #define log_unit_info_errno(unit, error, ...)    log_unit_full(unit, LOG_INFO, error, ##__VA_ARGS__)
 704 #define log_unit_notice_errno(unit, error, ...)  log_unit_full(unit, LOG_NOTICE, error, ##__VA_ARGS__)
 705 #define log_unit_warning_errno(unit, error, ...) log_unit_full(unit, LOG_WARNING, error, ##__VA_ARGS__)
 706 #define log_unit_error_errno(unit, error, ...)   log_unit_full(unit, LOG_ERR, error, ##__VA_ARGS__)
 707
 708 #define LOG_UNIT_MESSAGE(unit, fmt, ...) "MESSAGE=%s: " fmt, (unit)->id, ##__VA_ARGS__
 709 #define LOG_UNIT_ID(unit) (unit)->manager->unit_log_format_string, (unit)->id
 710 #define LOG_UNIT_INVOCATION_ID(unit) (unit)->manager->invocation_log_format_string, (unit)->invocation_id_string