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