src/core/unit.h

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