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