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
  27 typedef struct Unit Unit;
  28 typedef struct UnitVTable UnitVTable;
  29 typedef enum UnitActiveState UnitActiveState;
  30 typedef enum UnitDependency UnitDependency;
  31 typedef struct UnitRef UnitRef;
  32 typedef struct UnitStatusMessageFormats UnitStatusMessageFormats;
  33
  34 #include "set.h"
  35 #include "util.h"
  36 #include "list.h"
  37 #include "socket-util.h"
  38 #include "execute.h"
  39 #include "condition.h"
  40 #include "install.h"
  41 #include "unit-name.h"
  42
  43 enum UnitActiveState {
  44         UNIT_ACTIVE,
  45         UNIT_RELOADING,
  46         UNIT_INACTIVE,
  47         UNIT_FAILED,
  48         UNIT_ACTIVATING,
  49         UNIT_DEACTIVATING,
  50         _UNIT_ACTIVE_STATE_MAX,
  51         _UNIT_ACTIVE_STATE_INVALID = -1
  52 };
  53
  54 static inline bool UNIT_IS_ACTIVE_OR_RELOADING(UnitActiveState t) {
  55         return t == UNIT_ACTIVE || t == UNIT_RELOADING;
  56 }
  57
  58 static inline bool UNIT_IS_ACTIVE_OR_ACTIVATING(UnitActiveState t) {
  59         return t == UNIT_ACTIVE || t == UNIT_ACTIVATING || t == UNIT_RELOADING;
  60 }
  61
  62 static inline bool UNIT_IS_INACTIVE_OR_DEACTIVATING(UnitActiveState t) {
  63         return t == UNIT_INACTIVE || t == UNIT_FAILED || t == UNIT_DEACTIVATING;
  64 }
  65
  66 static inline bool UNIT_IS_INACTIVE_OR_FAILED(UnitActiveState t) {
  67         return t == UNIT_INACTIVE || t == UNIT_FAILED;
  68 }
  69
  70 enum UnitDependency {
  71         /* Positive dependencies */
  72         UNIT_REQUIRES,
  73         UNIT_REQUIRES_OVERRIDABLE,
  74         UNIT_REQUISITE,
  75         UNIT_REQUISITE_OVERRIDABLE,
  76         UNIT_WANTS,
  77         UNIT_BINDS_TO,
  78         UNIT_PART_OF,
  79
  80         /* Inverse of the above */
  81         UNIT_REQUIRED_BY,             /* inverse of 'requires' and 'requisite' is 'required_by' */
  82         UNIT_REQUIRED_BY_OVERRIDABLE, /* inverse of 'requires_overridable' and 'requisite_overridable' is 'soft_required_by' */
  83         UNIT_WANTED_BY,               /* inverse of 'wants' */
  84         UNIT_BOUND_BY,                /* inverse of 'binds_to' */
  85         UNIT_CONSISTS_OF,             /* inverse of 'part_of' */
  86
  87         /* Negative dependencies */
  88         UNIT_CONFLICTS,               /* inverse of 'conflicts' is 'conflicted_by' */
  89         UNIT_CONFLICTED_BY,
  90
  91         /* Order */
  92         UNIT_BEFORE,                  /* inverse of 'before' is 'after' and vice versa */
  93         UNIT_AFTER,
  94
  95         /* On Failure */
  96         UNIT_ON_FAILURE,
  97
  98         /* Triggers (i.e. a socket triggers a service) */
  99         UNIT_TRIGGERS,
 100         UNIT_TRIGGERED_BY,
 101
 102         /* Propagate reloads */
 103         UNIT_PROPAGATES_RELOAD_TO,
 104         UNIT_RELOAD_PROPAGATED_FROM,
 105
 106         /* Reference information for GC logic */
 107         UNIT_REFERENCES,              /* Inverse of 'references' is 'referenced_by' */
 108         UNIT_REFERENCED_BY,
 109
 110         _UNIT_DEPENDENCY_MAX,
 111         _UNIT_DEPENDENCY_INVALID = -1
 112 };
 113
 114 #include "manager.h"
 115 #include "job.h"
 116 #include "cgroup.h"
 117 #include "cgroup-attr.h"
 118
 119 struct Unit {
 120         Manager *manager;
 121
 122         UnitType type;
 123         UnitLoadState load_state;
 124         Unit *merged_into;
 125
 126         char *id; /* One name is special because we use it for identification. Points to an entry in the names set */
 127         char *instance;
 128
 129         Set *names;
 130         Set *dependencies[_UNIT_DEPENDENCY_MAX];
 131
 132         char **requires_mounts_for;
 133
 134         char *description;
 135         char **documentation;
 136
 137         char *fragment_path; /* if loaded from a config file this is the primary path to it */
 138         char *source_path; /* if converted, the source file */
 139         usec_t fragment_mtime;
 140         usec_t source_mtime;
 141
 142         /* If there is something to do with this unit, then this is the installed job for it */
 143         Job *job;
 144
 145         /* JOB_NOP jobs are special and can be installed without disturbing the real job. */
 146         Job *nop_job;
 147
 148         usec_t job_timeout;
 149
 150         /* References to this */
 151         LIST_HEAD(UnitRef, refs);
 152
 153         /* Conditions to check */
 154         LIST_HEAD(Condition, conditions);
 155
 156         dual_timestamp condition_timestamp;
 157
 158         dual_timestamp inactive_exit_timestamp;
 159         dual_timestamp active_enter_timestamp;
 160         dual_timestamp active_exit_timestamp;
 161         dual_timestamp inactive_enter_timestamp;
 162
 163         /* Counterparts in the cgroup filesystem */
 164         CGroupBonding *cgroup_bondings;
 165         CGroupAttribute *cgroup_attributes;
 166
 167         /* Per type list */
 168         LIST_FIELDS(Unit, units_by_type);
 169
 170         /* All units which have requires_mounts_for set */
 171         LIST_FIELDS(Unit, has_requires_mounts_for);
 172
 173         /* Load queue */
 174         LIST_FIELDS(Unit, load_queue);
 175
 176         /* D-Bus queue */
 177         LIST_FIELDS(Unit, dbus_queue);
 178
 179         /* Cleanup queue */
 180         LIST_FIELDS(Unit, cleanup_queue);
 181
 182         /* GC queue */
 183         LIST_FIELDS(Unit, gc_queue);
 184
 185         /* Used during GC sweeps */
 186         unsigned gc_marker;
 187
 188         /* When deserializing, temporarily store the job type for this
 189          * unit here, if there was a job scheduled.
 190          * Only for deserializing from a legacy version. New style uses full
 191          * serialized jobs. */
 192         int deserialized_job; /* This is actually of type JobType */
 193
 194         /* Error code when we didn't manage to load the unit (negative) */
 195         int load_error;
 196
 197         /* Cached unit file state */
 198         UnitFileState unit_file_state;
 199
 200         /* Garbage collect us we nobody wants or requires us anymore */
 201         bool stop_when_unneeded;
 202
 203         /* Create default dependencies */
 204         bool default_dependencies;
 205
 206         /* Refuse manual starting, allow starting only indirectly via dependency. */
 207         bool refuse_manual_start;
 208
 209         /* Don't allow the user to stop this unit manually, allow stopping only indirectly via dependency. */
 210         bool refuse_manual_stop;
 211
 212         /* Allow isolation requests */
 213         bool allow_isolate;
 214
 215         /* Isolate OnFailure unit */
 216         bool on_failure_isolate;
 217
 218         /* Ignore this unit when isolating */
 219         bool ignore_on_isolate;
 220
 221         /* Ignore this unit when snapshotting */
 222         bool ignore_on_snapshot;
 223
 224         /* Did the last condition check succeed? */
 225         bool condition_result;
 226
 227         bool in_load_queue:1;
 228         bool in_dbus_queue:1;
 229         bool in_cleanup_queue:1;
 230         bool in_gc_queue:1;
 231
 232         bool sent_dbus_new_signal:1;
 233
 234         bool no_gc:1;
 235
 236         bool in_audit:1;
 237 };
 238
 239 struct UnitRef {
 240         /* Keeps tracks of references to a unit. This is useful so
 241          * that we can merge two units if necessary and correct all
 242          * references to them */
 243
 244         Unit* unit;
 245         LIST_FIELDS(UnitRef, refs);
 246 };
 247
 248 struct UnitStatusMessageFormats {
 249         const char *starting_stopping[2];
 250         const char *finished_start_job[_JOB_RESULT_MAX];
 251         const char *finished_stop_job[_JOB_RESULT_MAX];
 252 };
 253
 254 #include "service.h"
 255 #include "timer.h"
 256 #include "socket.h"
 257 #include "target.h"
 258 #include "device.h"
 259 #include "mount.h"
 260 #include "automount.h"
 261 #include "snapshot.h"
 262 #include "swap.h"
 263 #include "path.h"
 264
 265 struct UnitVTable {
 266         /* How much memory does an object of this unit type need */
 267         size_t object_size;
 268
 269         /* Config file sections this unit type understands, separated
 270          * by NUL chars */
 271         const char *sections;
 272
 273         /* This should reset all type-specific variables. This should
 274          * not allocate memory, and is called with zero-initialized
 275          * data. It should hence only initialize variables that need
 276          * to be set != 0. */
 277         void (*init)(Unit *u);
 278
 279         /* This should free all type-specific variables. It should be
 280          * idempotent. */
 281         void (*done)(Unit *u);
 282
 283         /* Actually load data from disk. This may fail, and should set
 284          * load_state to UNIT_LOADED, UNIT_MERGED or leave it at
 285          * UNIT_STUB if no configuration could be found. */
 286         int (*load)(Unit *u);
 287
 288         /* If a lot of units got created via enumerate(), this is
 289          * where to actually set the state and call unit_notify(). */
 290         int (*coldplug)(Unit *u);
 291
 292         void (*dump)(Unit *u, FILE *f, const char *prefix);
 293
 294         int (*start)(Unit *u);
 295         int (*stop)(Unit *u);
 296         int (*reload)(Unit *u);
 297
 298         int (*kill)(Unit *u, KillWho w, int signo, DBusError *error);
 299
 300         bool (*can_reload)(Unit *u);
 301
 302         /* Write all data that cannot be restored from other sources
 303          * away using unit_serialize_item() */
 304         int (*serialize)(Unit *u, FILE *f, FDSet *fds);
 305
 306         /* Restore one item from the serialization */
 307         int (*deserialize_item)(Unit *u, const char *key, const char *data, FDSet *fds);
 308
 309         /* Boils down the more complex internal state of this unit to
 310          * a simpler one that the engine can understand */
 311         UnitActiveState (*active_state)(Unit *u);
 312
 313         /* Returns the substate specific to this unit type as
 314          * string. This is purely information so that we can give the
 315          * user a more fine grained explanation in which actual state a
 316          * unit is in. */
 317         const char* (*sub_state_to_string)(Unit *u);
 318
 319         /* Return true when there is reason to keep this entry around
 320          * even nothing references it and it isn't active in any
 321          * way */
 322         bool (*check_gc)(Unit *u);
 323
 324         /* Return true when this unit is suitable for snapshotting */
 325         bool (*check_snapshot)(Unit *u);
 326
 327         void (*fd_event)(Unit *u, int fd, uint32_t events, Watch *w);
 328         void (*sigchld_event)(Unit *u, pid_t pid, int code, int status);
 329         void (*timer_event)(Unit *u, uint64_t n_elapsed, Watch *w);
 330
 331         /* Reset failed state if we are in failed state */
 332         void (*reset_failed)(Unit *u);
 333
 334         /* Called whenever any of the cgroups this unit watches for
 335          * ran empty */
 336         void (*cgroup_notify_empty)(Unit *u);
 337
 338         /* Called whenever a process of this unit sends us a message */
 339         void (*notify_message)(Unit *u, pid_t pid, char **tags);
 340
 341         /* Called whenever a name thus Unit registered for comes or
 342          * goes away. */
 343         void (*bus_name_owner_change)(Unit *u, const char *name, const char *old_owner, const char *new_owner);
 344
 345         /* Called whenever a bus PID lookup finishes */
 346         void (*bus_query_pid_done)(Unit *u, const char *name, pid_t pid);
 347
 348         /* Called for each message received on the bus */
 349         DBusHandlerResult (*bus_message_handler)(Unit *u, DBusConnection *c, DBusMessage *message);
 350
 351         /* Return the unit this unit is following */
 352         Unit *(*following)(Unit *u);
 353
 354         /* Return the set of units that are following each other */
 355         int (*following_set)(Unit *u, Set **s);
 356
 357         /* This is called for each unit type and should be used to
 358          * enumerate existing devices and load them. However,
 359          * everything that is loaded here should still stay in
 360          * inactive state. It is the job of the coldplug() call above
 361          * to put the units into the initial state.  */
 362         int (*enumerate)(Manager *m);
 363
 364         /* Type specific cleanups. */
 365         void (*shutdown)(Manager *m);
 366
 367         /* When sending out PropertiesChanged signal, which properties
 368          * shall be invalidated? This is a NUL separated list of
 369          * strings, to minimize relocations a little. */
 370         const char *bus_invalidating_properties;
 371
 372         /* The interface name */
 373         const char *bus_interface;
 374
 375         UnitStatusMessageFormats status_message_formats;
 376
 377         /* Can units of this type have multiple names? */
 378         bool no_alias:1;
 379
 380         /* Instances make no sense for this type */
 381         bool no_instances:1;
 382
 383         /* Exclude from automatic gc */
 384         bool no_gc:1;
 385 };
 386
 387 extern const UnitVTable * const unit_vtable[_UNIT_TYPE_MAX];
 388
 389 #define UNIT_VTABLE(u) unit_vtable[(u)->type]
 390
 391 /* For casting a unit into the various unit types */
 392 #define DEFINE_CAST(UPPERCASE, MixedCase)                               \
 393         static inline MixedCase* UPPERCASE(Unit *u) {                   \
 394                 if (_unlikely_(!u || u->type != UNIT_##UPPERCASE))      \
 395                         return NULL;                                    \
 396                                                                         \
 397                 return (MixedCase*) u;                                  \
 398         }
 399
 400 /* For casting the various unit types into a unit */
 401 #define UNIT(u) (&(u)->meta)
 402
 403 DEFINE_CAST(SOCKET, Socket);
 404 DEFINE_CAST(TIMER, Timer);
 405 DEFINE_CAST(SERVICE, Service);
 406 DEFINE_CAST(TARGET, Target);
 407 DEFINE_CAST(DEVICE, Device);
 408 DEFINE_CAST(MOUNT, Mount);
 409 DEFINE_CAST(AUTOMOUNT, Automount);
 410 DEFINE_CAST(SNAPSHOT, Snapshot);
 411 DEFINE_CAST(SWAP, Swap);
 412 DEFINE_CAST(PATH, Path);
 413
 414 Unit *unit_new(Manager *m, size_t size);
 415 void unit_free(Unit *u);
 416
 417 int unit_add_name(Unit *u, const char *name);
 418
 419 int unit_add_dependency(Unit *u, UnitDependency d, Unit *other, bool add_reference);
 420 int unit_add_two_dependencies(Unit *u, UnitDependency d, UnitDependency e, Unit *other, bool add_reference);
 421
 422 int unit_add_dependency_by_name(Unit *u, UnitDependency d, const char *name, const char *filename, bool add_reference);
 423 int unit_add_two_dependencies_by_name(Unit *u, UnitDependency d, UnitDependency e, const char *name, const char *path, bool add_reference);
 424
 425 int unit_add_dependency_by_name_inverse(Unit *u, UnitDependency d, const char *name, const char *filename, bool add_reference);
 426 int unit_add_two_dependencies_by_name_inverse(Unit *u, UnitDependency d, UnitDependency e, const char *name, const char *path, bool add_reference);
 427
 428 int unit_add_exec_dependencies(Unit *u, ExecContext *c);
 429
 430 int unit_add_cgroup(Unit *u, CGroupBonding *b);
 431 int unit_add_cgroup_from_text(Unit *u, const char *name);
 432 int unit_add_default_cgroups(Unit *u);
 433 CGroupBonding* unit_get_default_cgroup(Unit *u);
 434 int unit_add_cgroup_attribute(Unit *u, const char *controller, const char *name, const char *value, CGroupAttributeMapCallback map_callback);
 435
 436 int unit_choose_id(Unit *u, const char *name);
 437 int unit_set_description(Unit *u, const char *description);
 438
 439 bool unit_check_gc(Unit *u);
 440
 441 void unit_add_to_load_queue(Unit *u);
 442 void unit_add_to_dbus_queue(Unit *u);
 443 void unit_add_to_cleanup_queue(Unit *u);
 444 void unit_add_to_gc_queue(Unit *u);
 445
 446 int unit_merge(Unit *u, Unit *other);
 447 int unit_merge_by_name(Unit *u, const char *other);
 448
 449 Unit *unit_follow_merge(Unit *u);
 450
 451 int unit_load_fragment_and_dropin(Unit *u);
 452 int unit_load_fragment_and_dropin_optional(Unit *u);
 453 int unit_load(Unit *unit);
 454
 455 const char *unit_description(Unit *u);
 456
 457 bool unit_has_name(Unit *u, const char *name);
 458
 459 UnitActiveState unit_active_state(Unit *u);
 460
 461 const char* unit_sub_state_to_string(Unit *u);
 462
 463 void unit_dump(Unit *u, FILE *f, const char *prefix);
 464
 465 bool unit_can_reload(Unit *u);
 466 bool unit_can_start(Unit *u);
 467 bool unit_can_isolate(Unit *u);
 468
 469 int unit_start(Unit *u);
 470 int unit_stop(Unit *u);
 471 int unit_reload(Unit *u);
 472
 473 int unit_kill(Unit *u, KillWho w, int signo, DBusError *error);
 474
 475 void unit_notify(Unit *u, UnitActiveState os, UnitActiveState ns, bool reload_success);
 476
 477 int unit_watch_fd(Unit *u, int fd, uint32_t events, Watch *w);
 478 void unit_unwatch_fd(Unit *u, Watch *w);
 479
 480 int unit_watch_pid(Unit *u, pid_t pid);
 481 void unit_unwatch_pid(Unit *u, pid_t pid);
 482
 483 int unit_watch_timer(Unit *u, usec_t delay, Watch *w);
 484 void unit_unwatch_timer(Unit *u, Watch *w);
 485
 486 int unit_watch_bus_name(Unit *u, const char *name);
 487 void unit_unwatch_bus_name(Unit *u, const char *name);
 488
 489 bool unit_job_is_applicable(Unit *u, JobType j);
 490
 491 int set_unit_path(const char *p);
 492
 493 char *unit_dbus_path(Unit *u);
 494
 495 int unit_load_related_unit(Unit *u, const char *type, Unit **_found);
 496 int unit_get_related_unit(Unit *u, const char *type, Unit **_found);
 497
 498 bool unit_can_serialize(Unit *u);
 499 int unit_serialize(Unit *u, FILE *f, FDSet *fds, bool serialize_jobs);
 500 void unit_serialize_item_format(Unit *u, FILE *f, const char *key, const char *value, ...) _printf_attr_(4,5);
 501 void unit_serialize_item(Unit *u, FILE *f, const char *key, const char *value);
 502 int unit_deserialize(Unit *u, FILE *f, FDSet *fds);
 503
 504 int unit_add_node_link(Unit *u, const char *what, bool wants);
 505
 506 int unit_coldplug(Unit *u);
 507
 508 void unit_status_printf(Unit *u, const char *status, const char *format, ...);
 509
 510 bool unit_need_daemon_reload(Unit *u);
 511
 512 void unit_reset_failed(Unit *u);
 513
 514 Unit *unit_following(Unit *u);
 515
 516 bool unit_pending_inactive(Unit *u);
 517 bool unit_pending_active(Unit *u);
 518
 519 int unit_add_default_target_dependency(Unit *u, Unit *target);
 520
 521 char *unit_default_cgroup_path(Unit *u);
 522
 523 int unit_following_set(Unit *u, Set **s);
 524
 525 void unit_trigger_on_failure(Unit *u);
 526
 527 bool unit_condition_test(Unit *u);
 528
 529 UnitFileState unit_get_unit_file_state(Unit *u);
 530
 531 Unit* unit_ref_set(UnitRef *ref, Unit *u);
 532 void unit_ref_unset(UnitRef *ref);
 533
 534 #define UNIT_DEREF(ref) ((ref).unit)
 535
 536 int unit_add_one_mount_link(Unit *u, Mount *m);
 537 int unit_add_mount_links(Unit *u);
 538
 539 int unit_exec_context_defaults(Unit *u, ExecContext *c);
 540
 541 const char *unit_active_state_to_string(UnitActiveState i);
 542 UnitActiveState unit_active_state_from_string(const char *s);
 543
 544 const char *unit_dependency_to_string(UnitDependency i);
 545 UnitDependency unit_dependency_from_string(const char *s);