src/core/unit.h

   1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
   2
   3 #pragma once
   4
   5 /***
   6   This file is part of systemd.
   7
   8   Copyright 2010 Lennart Poettering
   9
  10   systemd is free software; you can redistribute it and/or modify it
  11   under the terms of the GNU Lesser General Public License as published by
  12   the Free Software Foundation; either version 2.1 of the License, or
  13   (at your option) any later version.
  14
  15   systemd is distributed in the hope that it will be useful, but
  16   WITHOUT ANY WARRANTY; without even the implied warranty of
  17   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  18   Lesser General Public License for more details.
  19
  20   You should have received a copy of the GNU Lesser General Public License
  21   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  22 ***/
  23
  24 #include <stdbool.h>
  25 #include <stdlib.h>
  26 #include <unistd.h>
  27
  28 typedef struct Unit Unit;
  29 typedef struct UnitVTable UnitVTable;
  30 typedef enum UnitActiveState UnitActiveState;
  31 typedef struct UnitRef UnitRef;
  32 typedef struct UnitStatusMessageFormats UnitStatusMessageFormats;
  33
  34 #include "sd-event.h"
  35 #include "set.h"
  36 #include "util.h"
  37 #include "list.h"
  38 #include "socket-util.h"
  39 #include "execute.h"
  40 #include "cgroup.h"
  41 #include "condition.h"
  42 #include "install.h"
  43 #include "unit-name.h"
  44 #include "failure-action.h"
  45
  46 enum UnitActiveState {
  47         UNIT_ACTIVE,
  48         UNIT_RELOADING,
  49         UNIT_INACTIVE,
  50         UNIT_FAILED,
  51         UNIT_ACTIVATING,
  52         UNIT_DEACTIVATING,
  53         _UNIT_ACTIVE_STATE_MAX,
  54         _UNIT_ACTIVE_STATE_INVALID = -1
  55 };
  56
  57 typedef enum KillOperation {
  58         KILL_TERMINATE,
  59         KILL_KILL,
  60         KILL_ABORT,
  61 } KillOperation;
  62
  63 static inline bool UNIT_IS_ACTIVE_OR_RELOADING(UnitActiveState t) {
  64         return t == UNIT_ACTIVE || t == UNIT_RELOADING;
  65 }
  66
  67 static inline bool UNIT_IS_ACTIVE_OR_ACTIVATING(UnitActiveState t) {
  68         return t == UNIT_ACTIVE || t == UNIT_ACTIVATING || t == UNIT_RELOADING;
  69 }
  70
  71 static inline bool UNIT_IS_INACTIVE_OR_DEACTIVATING(UnitActiveState t) {
  72         return t == UNIT_INACTIVE || t == UNIT_FAILED || t == UNIT_DEACTIVATING;
  73 }
  74
  75 static inline bool UNIT_IS_INACTIVE_OR_FAILED(UnitActiveState t) {
  76         return t == UNIT_INACTIVE || t == UNIT_FAILED;
  77 }
  78
  79 #include "manager.h"
  80 #include "job.h"
  81
  82 struct UnitRef {
  83         /* Keeps tracks of references to a unit. This is useful so
  84          * that we can merge two units if necessary and correct all
  85          * references to them */
  86
  87         Unit* unit;
  88         LIST_FIELDS(UnitRef, refs);
  89 };
  90
  91 struct Unit {
  92         Manager *manager;
  93
  94         UnitType type;
  95         UnitLoadState load_state;
  96         Unit *merged_into;
  97
  98         char *id; /* One name is special because we use it for identification. Points to an entry in the names set */
  99         char *instance;
 100
 101         Set *names;
 102         Set *dependencies[_UNIT_DEPENDENCY_MAX];
 103
 104         char **requires_mounts_for;
 105
 106         char *description;
 107         char **documentation;
 108
 109         char *fragment_path; /* if loaded from a config file this is the primary path to it */
 110         char *source_path; /* if converted, the source file */
 111         char **dropin_paths;
 112         usec_t fragment_mtime;
 113         usec_t source_mtime;
 114         usec_t dropin_mtime;
 115
 116         /* If there is something to do with this unit, then this is the installed job for it */
 117         Job *job;
 118
 119         /* JOB_NOP jobs are special and can be installed without disturbing the real job. */
 120         Job *nop_job;
 121
 122         /* Job timeout and action to take */
 123         usec_t job_timeout;
 124         FailureAction job_timeout_action;
 125         char *job_timeout_reboot_arg;
 126
 127         /* References to this */
 128         LIST_HEAD(UnitRef, refs);
 129
 130         /* Conditions to check */
 131         LIST_HEAD(Condition, conditions);
 132         LIST_HEAD(Condition, asserts);
 133
 134         dual_timestamp condition_timestamp;
 135         dual_timestamp assert_timestamp;
 136
 137         dual_timestamp inactive_exit_timestamp;
 138         dual_timestamp active_enter_timestamp;
 139         dual_timestamp active_exit_timestamp;
 140         dual_timestamp inactive_enter_timestamp;
 141
 142         UnitRef slice;
 143
 144         /* Per type list */
 145         LIST_FIELDS(Unit, units_by_type);
 146
 147         /* All units which have requires_mounts_for set */
 148         LIST_FIELDS(Unit, has_requires_mounts_for);
 149
 150         /* Load queue */
 151         LIST_FIELDS(Unit, load_queue);
 152
 153         /* D-Bus queue */
 154         LIST_FIELDS(Unit, dbus_queue);
 155
 156         /* Cleanup queue */
 157         LIST_FIELDS(Unit, cleanup_queue);
 158
 159         /* GC queue */
 160         LIST_FIELDS(Unit, gc_queue);
 161
 162         /* CGroup realize members queue */
 163         LIST_FIELDS(Unit, cgroup_queue);
 164
 165         /* PIDs we keep an eye on. Note that a unit might have many
 166          * more, but these are the ones we care enough about to
 167          * process SIGCHLD for */
 168         Set *pids;
 169
 170         /* Used during GC sweeps */
 171         unsigned gc_marker;
 172
 173         /* When deserializing, temporarily store the job type for this
 174          * unit here, if there was a job scheduled.
 175          * Only for deserializing from a legacy version. New style uses full
 176          * serialized jobs. */
 177         int deserialized_job; /* This is actually of type JobType */
 178
 179         /* Error code when we didn't manage to load the unit (negative) */
 180         int load_error;
 181
 182         /* Cached unit file state */
 183         UnitFileState unit_file_state;
 184
 185         /* Counterparts in the cgroup filesystem */
 186         char *cgroup_path;
 187         CGroupControllerMask cgroup_realized_mask;
 188         CGroupControllerMask cgroup_subtree_mask;
 189         CGroupControllerMask cgroup_members_mask;
 190
 191         /* How to start OnFailure units */
 192         JobMode on_failure_job_mode;
 193
 194         /* Garbage collect us we nobody wants or requires us anymore */
 195         bool stop_when_unneeded;
 196
 197         /* Create default dependencies */
 198         bool default_dependencies;
 199
 200         /* Refuse manual starting, allow starting only indirectly via dependency. */
 201         bool refuse_manual_start;
 202
 203         /* Don't allow the user to stop this unit manually, allow stopping only indirectly via dependency. */
 204         bool refuse_manual_stop;
 205
 206         /* Allow isolation requests */
 207         bool allow_isolate;
 208
 209         /* Ignore this unit when isolating */
 210         bool ignore_on_isolate;
 211
 212         /* Ignore this unit when snapshotting */
 213         bool ignore_on_snapshot;
 214
 215         /* Did the last condition check succeed? */
 216         bool condition_result;
 217         bool assert_result;
 218
 219         /* Is this a transient unit? */
 220         bool transient;
 221
 222         bool in_load_queue:1;
 223         bool in_dbus_queue:1;
 224         bool in_cleanup_queue:1;
 225         bool in_gc_queue:1;
 226         bool in_cgroup_queue:1;
 227
 228         bool sent_dbus_new_signal:1;
 229
 230         bool no_gc:1;
 231
 232         bool in_audit:1;
 233
 234         bool cgroup_realized:1;
 235         bool cgroup_members_mask_valid:1;
 236         bool cgroup_subtree_mask_valid:1;
 237 };
 238
 239 struct UnitStatusMessageFormats {
 240         const char *starting_stopping[2];
 241         const char *finished_start_job[_JOB_RESULT_MAX];
 242         const char *finished_stop_job[_JOB_RESULT_MAX];
 243 };
 244
 245 typedef enum UnitSetPropertiesMode {
 246         UNIT_CHECK = 0,
 247         UNIT_RUNTIME = 1,
 248         UNIT_PERSISTENT = 2,
 249 } UnitSetPropertiesMode;
 250
 251 #include "service.h"
 252 #include "socket.h"
 253 #include "busname.h"
 254 #include "target.h"
 255 #include "snapshot.h"
 256 #include "device.h"
 257 #include "mount.h"
 258 #include "automount.h"
 259 #include "swap.h"
 260 #include "timer.h"
 261 #include "path.h"
 262 #include "slice.h"
 263 #include "scope.h"
 264
 265 struct UnitVTable {
 266         /* How much memory does an object of this unit type need */
 267         size_t object_size;
 268
 269         /* If greater than 0, the offset into the object where
 270          * ExecContext is found, if the unit type has that */
 271         size_t exec_context_offset;
 272
 273         /* If greater than 0, the offset into the object where
 274          * CGroupContext is found, if the unit type has that */
 275         size_t cgroup_context_offset;
 276
 277         /* If greater than 0, the offset into the object where
 278          * KillContext is found, if the unit type has that */
 279         size_t kill_context_offset;
 280
 281         /* If greater than 0, the offset into the object where the
 282          * pointer to ExecRuntime is found, if the unit type has
 283          * that */
 284         size_t exec_runtime_offset;
 285
 286         /* The name of the configuration file section with the private settings of this unit*/
 287         const char *private_section;
 288
 289         /* Config file sections this unit type understands, separated
 290          * by NUL chars */
 291         const char *sections;
 292
 293         /* This should reset all type-specific variables. This should
 294          * not allocate memory, and is called with zero-initialized
 295          * data. It should hence only initialize variables that need
 296          * to be set != 0. */
 297         void (*init)(Unit *u);
 298
 299         /* This should free all type-specific variables. It should be
 300          * idempotent. */
 301         void (*done)(Unit *u);
 302
 303         /* Actually load data from disk. This may fail, and should set
 304          * load_state to UNIT_LOADED, UNIT_MERGED or leave it at
 305          * UNIT_STUB if no configuration could be found. */
 306         int (*load)(Unit *u);
 307
 308         /* If a lot of units got created via enumerate(), this is
 309          * where to actually set the state and call unit_notify(). */
 310         int (*coldplug)(Unit *u);
 311
 312         void (*dump)(Unit *u, FILE *f, const char *prefix);
 313
 314         int (*start)(Unit *u);
 315         int (*stop)(Unit *u);
 316         int (*reload)(Unit *u);
 317
 318         int (*kill)(Unit *u, KillWho w, int signo, sd_bus_error *error);
 319
 320         bool (*can_reload)(Unit *u);
 321
 322         /* Write all data that cannot be restored from other sources
 323          * away using unit_serialize_item() */
 324         int (*serialize)(Unit *u, FILE *f, FDSet *fds);
 325
 326         /* Restore one item from the serialization */
 327         int (*deserialize_item)(Unit *u, const char *key, const char *data, FDSet *fds);
 328
 329         /* Try to match up fds with what we need for this unit */
 330         int (*distribute_fds)(Unit *u, FDSet *fds);
 331
 332         /* Boils down the more complex internal state of this unit to
 333          * a simpler one that the engine can understand */
 334         UnitActiveState (*active_state)(Unit *u);
 335
 336         /* Returns the substate specific to this unit type as
 337          * string. This is purely information so that we can give the
 338          * user a more fine grained explanation in which actual state a
 339          * unit is in. */
 340         const char* (*sub_state_to_string)(Unit *u);
 341
 342         /* Return true when there is reason to keep this entry around
 343          * even nothing references it and it isn't active in any
 344          * way */
 345         bool (*check_gc)(Unit *u);
 346
 347         /* Return true when this unit is suitable for snapshotting */
 348         bool (*check_snapshot)(Unit *u);
 349
 350         /* Invoked on every child that died */
 351         void (*sigchld_event)(Unit *u, pid_t pid, int code, int status);
 352
 353         /* Reset failed state if we are in failed state */
 354         void (*reset_failed)(Unit *u);
 355
 356         /* Called whenever any of the cgroups this unit watches for
 357          * ran empty */
 358         void (*notify_cgroup_empty)(Unit *u);
 359
 360         /* Called whenever a process of this unit sends us a message */
 361         void (*notify_message)(Unit *u, pid_t pid, char **tags);
 362
 363         /* Called whenever a name this Unit registered for comes or
 364          * goes away. */
 365         void (*bus_name_owner_change)(Unit *u, const char *name, const char *old_owner, const char *new_owner);
 366
 367         /* Called for each property that is being set */
 368         int (*bus_set_property)(Unit *u, const char *name, sd_bus_message *message, UnitSetPropertiesMode mode, sd_bus_error *error);
 369
 370         /* Called after at least one property got changed to apply the necessary change */
 371         int (*bus_commit_properties)(Unit *u);
 372
 373         /* Return the unit this unit is following */
 374         Unit *(*following)(Unit *u);
 375
 376         /* Return the set of units that are following each other */
 377         int (*following_set)(Unit *u, Set **s);
 378
 379         /* Invoked each time a unit this unit is triggering changes
 380          * state or gains/loses a job */
 381         void (*trigger_notify)(Unit *u, Unit *trigger);
 382
 383         /* Called whenever CLOCK_REALTIME made a jump */
 384         void (*time_change)(Unit *u);
 385
 386         int (*get_timeout)(Unit *u, uint64_t *timeout);
 387
 388         /* This is called for each unit type and should be used to
 389          * enumerate existing devices and load them. However,
 390          * everything that is loaded here should still stay in
 391          * inactive state. It is the job of the coldplug() call above
 392          * to put the units into the initial state.  */
 393         int (*enumerate)(Manager *m);
 394
 395         /* Type specific cleanups. */
 396         void (*shutdown)(Manager *m);
 397
 398         /* The interface name */
 399         const char *bus_interface;
 400
 401         /* The bus vtable */
 402         const sd_bus_vtable *bus_vtable;
 403
 404         /* The strings to print in status messages */
 405         UnitStatusMessageFormats status_message_formats;
 406
 407         /* Can units of this type have multiple names? */
 408         bool no_alias:1;
 409
 410         /* Instances make no sense for this type */
 411         bool no_instances:1;
 412
 413         /* Exclude from automatic gc */
 414         bool no_gc:1;
 415
 416         /* True if transient units of this type are OK */
 417         bool can_transient:1;
 418 };
 419
 420 extern const UnitVTable * const unit_vtable[_UNIT_TYPE_MAX];
 421
 422 #define UNIT_VTABLE(u) unit_vtable[(u)->type]
 423
 424 /* For casting a unit into the various unit types */
 425 #define DEFINE_CAST(UPPERCASE, MixedCase)                               \
 426         static inline MixedCase* UPPERCASE(Unit *u) {                   \
 427                 if (_unlikely_(!u || u->type != UNIT_##UPPERCASE))      \
 428                         return NULL;                                    \
 429                                                                         \
 430                 return (MixedCase*) u;                                  \
 431         }
 432
 433 /* For casting the various unit types into a unit */
 434 #define UNIT(u) (&(u)->meta)
 435
 436 #define UNIT_TRIGGER(u) ((Unit*) set_first((u)->dependencies[UNIT_TRIGGERS]))
 437
 438 DEFINE_CAST(SERVICE, Service);
 439 DEFINE_CAST(SOCKET, Socket);
 440 DEFINE_CAST(BUSNAME, BusName);
 441 DEFINE_CAST(TARGET, Target);
 442 DEFINE_CAST(SNAPSHOT, Snapshot);
 443 DEFINE_CAST(DEVICE, Device);
 444 DEFINE_CAST(MOUNT, Mount);
 445 DEFINE_CAST(AUTOMOUNT, Automount);
 446 DEFINE_CAST(SWAP, Swap);
 447 DEFINE_CAST(TIMER, Timer);
 448 DEFINE_CAST(PATH, Path);
 449 DEFINE_CAST(SLICE, Slice);
 450 DEFINE_CAST(SCOPE, Scope);
 451
 452 Unit *unit_new(Manager *m, size_t size);
 453 void unit_free(Unit *u);
 454
 455 int unit_add_name(Unit *u, const char *name);
 456
 457 int unit_add_dependency(Unit *u, UnitDependency d, Unit *other, bool add_reference);
 458 int unit_add_two_dependencies(Unit *u, UnitDependency d, UnitDependency e, Unit *other, bool add_reference);
 459
 460 int unit_add_dependency_by_name(Unit *u, UnitDependency d, const char *name, const char *filename, bool add_reference);
 461 int unit_add_two_dependencies_by_name(Unit *u, UnitDependency d, UnitDependency e, const char *name, const char *path, bool add_reference);
 462
 463 int unit_add_dependency_by_name_inverse(Unit *u, UnitDependency d, const char *name, const char *filename, bool add_reference);
 464 int unit_add_two_dependencies_by_name_inverse(Unit *u, UnitDependency d, UnitDependency e, const char *name, const char *path, bool add_reference);
 465
 466 int unit_add_exec_dependencies(Unit *u, ExecContext *c);
 467
 468 int unit_choose_id(Unit *u, const char *name);
 469 int unit_set_description(Unit *u, const char *description);
 470
 471 bool unit_check_gc(Unit *u);
 472
 473 void unit_add_to_load_queue(Unit *u);
 474 void unit_add_to_dbus_queue(Unit *u);
 475 void unit_add_to_cleanup_queue(Unit *u);
 476 void unit_add_to_gc_queue(Unit *u);
 477
 478 int unit_merge(Unit *u, Unit *other);
 479 int unit_merge_by_name(Unit *u, const char *other);
 480
 481 Unit *unit_follow_merge(Unit *u) _pure_;
 482
 483 int unit_load_fragment_and_dropin(Unit *u);
 484 int unit_load_fragment_and_dropin_optional(Unit *u);
 485 int unit_load(Unit *unit);
 486
 487 int unit_add_default_slice(Unit *u, CGroupContext *c);
 488
 489 const char *unit_description(Unit *u) _pure_;
 490
 491 bool unit_has_name(Unit *u, const char *name);
 492
 493 UnitActiveState unit_active_state(Unit *u);
 494
 495 const char* unit_sub_state_to_string(Unit *u);
 496
 497 void unit_dump(Unit *u, FILE *f, const char *prefix);
 498
 499 bool unit_can_reload(Unit *u) _pure_;
 500 bool unit_can_start(Unit *u) _pure_;
 501 bool unit_can_isolate(Unit *u) _pure_;
 502
 503 int unit_start(Unit *u);
 504 int unit_stop(Unit *u);
 505 int unit_reload(Unit *u);
 506
 507 int unit_kill(Unit *u, KillWho w, int signo, sd_bus_error *error);
 508 int unit_kill_common(Unit *u, KillWho who, int signo, pid_t main_pid, pid_t control_pid, sd_bus_error *error);
 509
 510 void unit_notify(Unit *u, UnitActiveState os, UnitActiveState ns, bool reload_success);
 511
 512 int unit_watch_pid(Unit *u, pid_t pid);
 513 void unit_unwatch_pid(Unit *u, pid_t pid);
 514 int unit_watch_all_pids(Unit *u);
 515 void unit_unwatch_all_pids(Unit *u);
 516
 517 void unit_tidy_watch_pids(Unit *u, pid_t except1, pid_t except2);
 518
 519 int unit_watch_bus_name(Unit *u, const char *name);
 520 void unit_unwatch_bus_name(Unit *u, const char *name);
 521
 522 bool unit_job_is_applicable(Unit *u, JobType j);
 523
 524 int set_unit_path(const char *p);
 525
 526 char *unit_dbus_path(Unit *u);
 527
 528 int unit_load_related_unit(Unit *u, const char *type, Unit **_found);
 529
 530 bool unit_can_serialize(Unit *u) _pure_;
 531 int unit_serialize(Unit *u, FILE *f, FDSet *fds, bool serialize_jobs);
 532 void unit_serialize_item_format(Unit *u, FILE *f, const char *key, const char *value, ...) _printf_(4,5);
 533 void unit_serialize_item(Unit *u, FILE *f, const char *key, const char *value);
 534 int unit_deserialize(Unit *u, FILE *f, FDSet *fds);
 535
 536 int unit_add_node_link(Unit *u, const char *what, bool wants);
 537
 538 int unit_coldplug(Unit *u);
 539
 540 void unit_status_printf(Unit *u, const char *status, const char *unit_status_msg_format) _printf_(3, 0);
 541
 542 bool unit_need_daemon_reload(Unit *u);
 543
 544 void unit_reset_failed(Unit *u);
 545
 546 Unit *unit_following(Unit *u);
 547 int unit_following_set(Unit *u, Set **s);
 548
 549 const char *unit_slice_name(Unit *u);
 550
 551 bool unit_stop_pending(Unit *u) _pure_;
 552 bool unit_inactive_or_pending(Unit *u) _pure_;
 553 bool unit_active_or_pending(Unit *u);
 554
 555 int unit_add_default_target_dependency(Unit *u, Unit *target);
 556
 557 char *unit_default_cgroup_path(Unit *u);
 558
 559 void unit_start_on_failure(Unit *u);
 560 void unit_trigger_notify(Unit *u);
 561
 562 UnitFileState unit_get_unit_file_state(Unit *u);
 563
 564 Unit* unit_ref_set(UnitRef *ref, Unit *u);
 565 void unit_ref_unset(UnitRef *ref);
 566
 567 #define UNIT_DEREF(ref) ((ref).unit)
 568 #define UNIT_ISSET(ref) (!!(ref).unit)
 569
 570 int unit_patch_contexts(Unit *u);
 571
 572 ExecContext *unit_get_exec_context(Unit *u) _pure_;
 573 KillContext *unit_get_kill_context(Unit *u) _pure_;
 574 CGroupContext *unit_get_cgroup_context(Unit *u) _pure_;
 575
 576 ExecRuntime *unit_get_exec_runtime(Unit *u) _pure_;
 577
 578 int unit_setup_exec_runtime(Unit *u);
 579
 580 int unit_write_drop_in(Unit *u, UnitSetPropertiesMode mode, const char *name, const char *data);
 581 int unit_write_drop_in_format(Unit *u, UnitSetPropertiesMode mode, const char *name, const char *format, ...) _printf_(4,5);
 582
 583 int unit_write_drop_in_private(Unit *u, UnitSetPropertiesMode mode, const char *name, const char *data);
 584 int unit_write_drop_in_private_format(Unit *u, UnitSetPropertiesMode mode, const char *name, const char *format, ...) _printf_(4,5);
 585
 586 int unit_remove_drop_in(Unit *u, UnitSetPropertiesMode mode, const char *name);
 587
 588 int unit_kill_context(Unit *u, KillContext *c, KillOperation k, pid_t main_pid, pid_t control_pid, bool main_pid_alien);
 589
 590 int unit_make_transient(Unit *u);
 591
 592 int unit_require_mounts_for(Unit *u, const char *path);
 593
 594 const char *unit_active_state_to_string(UnitActiveState i) _const_;
 595 UnitActiveState unit_active_state_from_string(const char *s) _pure_;
 596
 597 /* Macros which append UNIT= or USER_UNIT= to the message */
 598
 599 #define log_full_unit(level, unit, ...) log_meta_object(level, __FILE__, __LINE__, __func__, getpid() == 1 ? "UNIT=" : "USER_UNIT=", unit, __VA_ARGS__)
 600 #define log_debug_unit(unit, ...)       log_full_unit(LOG_DEBUG, unit, __VA_ARGS__)
 601 #define log_info_unit(unit, ...)        log_full_unit(LOG_INFO, unit, __VA_ARGS__)
 602 #define log_notice_unit(unit, ...)      log_full_unit(LOG_NOTICE, unit, __VA_ARGS__)
 603 #define log_warning_unit(unit, ...)     log_full_unit(LOG_WARNING, unit, __VA_ARGS__)
 604 #define log_error_unit(unit, ...)       log_full_unit(LOG_ERR, unit, __VA_ARGS__)
 605
 606 #define log_struct_unit(level, unit, ...) log_struct(level, getpid() == 1 ? "UNIT=%s" : "USER_UNIT=%s", unit, __VA_ARGS__)