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