src/unit.h

   1 /*-*- Mode: C; c-basic-offset: 8 -*-*/
   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
  42 #define UNIT_NAME_MAX 256
  43 #define DEFAULT_TIMEOUT_USEC (60*USEC_PER_SEC)
  44 #define DEFAULT_RESTART_USEC (100*USEC_PER_MSEC)
  45
  46 enum UnitType {
  47         UNIT_SERVICE = 0,
  48         UNIT_SOCKET,
  49         UNIT_TARGET,
  50         UNIT_DEVICE,
  51         UNIT_MOUNT,
  52         UNIT_AUTOMOUNT,
  53         UNIT_SNAPSHOT,
  54         UNIT_TIMER,
  55         UNIT_SWAP,
  56         UNIT_PATH,
  57         _UNIT_TYPE_MAX,
  58         _UNIT_TYPE_INVALID = -1
  59 };
  60
  61 enum UnitLoadState {
  62         UNIT_STUB,
  63         UNIT_LOADED,
  64         UNIT_FAILED,
  65         UNIT_MERGED,
  66         _UNIT_LOAD_STATE_MAX,
  67         _UNIT_LOAD_STATE_INVALID = -1
  68 };
  69
  70 enum UnitActiveState {
  71         UNIT_ACTIVE,
  72         UNIT_RELOADING,
  73         UNIT_INACTIVE,
  74         UNIT_MAINTENANCE,
  75         UNIT_ACTIVATING,
  76         UNIT_DEACTIVATING,
  77         _UNIT_ACTIVE_STATE_MAX,
  78         _UNIT_ACTIVE_STATE_INVALID = -1
  79 };
  80
  81 static inline bool UNIT_IS_ACTIVE_OR_RELOADING(UnitActiveState t) {
  82         return t == UNIT_ACTIVE || t == UNIT_RELOADING;
  83 }
  84
  85 static inline bool UNIT_IS_ACTIVE_OR_ACTIVATING(UnitActiveState t) {
  86         return t == UNIT_ACTIVE || t == UNIT_ACTIVATING || t == UNIT_RELOADING;
  87 }
  88
  89 static inline bool UNIT_IS_INACTIVE_OR_DEACTIVATING(UnitActiveState t) {
  90         return t == UNIT_INACTIVE || t == UNIT_MAINTENANCE || t == UNIT_DEACTIVATING;
  91 }
  92
  93 static inline bool UNIT_IS_INACTIVE_OR_MAINTENANCE(UnitActiveState t) {
  94         return t == UNIT_INACTIVE || t == UNIT_MAINTENANCE;
  95 }
  96
  97 enum UnitDependency {
  98         /* Positive dependencies */
  99         UNIT_REQUIRES,
 100         UNIT_REQUIRES_OVERRIDABLE,
 101         UNIT_REQUISITE,
 102         UNIT_REQUISITE_OVERRIDABLE,
 103         UNIT_WANTS,
 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 'soft_requires' and 'soft_requisite' is 'soft_required_by' */
 108         UNIT_WANTED_BY,               /* inverse of 'wants' */
 109
 110         /* Negative dependencies */
 111         UNIT_CONFLICTS,               /* inverse of 'conflicts' is 'conflicts' */
 112
 113         /* Order */
 114         UNIT_BEFORE,                  /* inverse of 'before' is 'after' and vice versa */
 115         UNIT_AFTER,
 116
 117         /* On Failure */
 118         UNIT_ON_FAILURE,
 119
 120         /* Reference information for GC logic */
 121         UNIT_REFERENCES,              /* Inverse of 'references' is 'referenced_by' */
 122         UNIT_REFERENCED_BY,
 123
 124         _UNIT_DEPENDENCY_MAX,
 125         _UNIT_DEPENDENCY_INVALID = -1
 126 };
 127
 128 #include "manager.h"
 129 #include "job.h"
 130 #include "cgroup.h"
 131
 132 struct Meta {
 133         Manager *manager;
 134
 135         UnitType type;
 136         UnitLoadState load_state;
 137         Unit *merged_into;
 138
 139         char *id; /* One name is special because we use it for identification. Points to an entry in the names set */
 140         char *instance;
 141
 142         Set *names;
 143         Set *dependencies[_UNIT_DEPENDENCY_MAX];
 144
 145         char *description;
 146
 147         char *fragment_path; /* if loaded from a config file this is the primary path to it */
 148         usec_t fragment_mtime;
 149
 150         /* If there is something to do with this unit, then this is
 151          * the job for it */
 152         Job *job;
 153
 154         usec_t job_timeout;
 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
 164         /* Per type list */
 165         LIST_FIELDS(Meta, units_per_type);
 166
 167         /* Load queue */
 168         LIST_FIELDS(Meta, load_queue);
 169
 170         /* D-Bus queue */
 171         LIST_FIELDS(Meta, dbus_queue);
 172
 173         /* Cleanup queue */
 174         LIST_FIELDS(Meta, cleanup_queue);
 175
 176         /* GC queue */
 177         LIST_FIELDS(Meta, gc_queue);
 178
 179         /* Used during GC sweeps */
 180         unsigned gc_marker;
 181
 182         /* If we go down, pull down everything that depends on us, too */
 183         bool recursive_stop;
 184
 185         /* Garbage collect us we nobody wants or requires us anymore */
 186         bool stop_when_unneeded;
 187
 188         /* Refuse manual starting, allow starting only indirectly via dependency. */
 189         bool only_by_dependency;
 190
 191         /* Create default depedencies */
 192         bool default_dependencies;
 193
 194         /* Bring up this unit even if a dependency fails to start */
 195         bool ignore_dependency_failure;
 196
 197         /* When deserializing, temporarily store the job type for this
 198          * unit here, if there was a job scheduled */
 199         int deserialized_job; /* This is actually of type JobType */
 200
 201         bool in_load_queue:1;
 202         bool in_dbus_queue:1;
 203         bool in_cleanup_queue:1;
 204         bool in_gc_queue:1;
 205
 206         bool sent_dbus_new_signal:1;
 207 };
 208
 209 #include "service.h"
 210 #include "timer.h"
 211 #include "socket.h"
 212 #include "target.h"
 213 #include "device.h"
 214 #include "mount.h"
 215 #include "automount.h"
 216 #include "snapshot.h"
 217 #include "swap.h"
 218 #include "path.h"
 219
 220 union Unit {
 221         Meta meta;
 222         Service service;
 223         Timer timer;
 224         Socket socket;
 225         Target target;
 226         Device device;
 227         Mount mount;
 228         Automount automount;
 229         Snapshot snapshot;
 230         Swap swap;
 231         Path path;
 232 };
 233
 234 struct UnitVTable {
 235         const char *suffix;
 236
 237         /* This should reset all type-specific variables. This should
 238          * not allocate memory, and is called with zero-initialized
 239          * data. It should hence only initialize variables that need
 240          * to be set != 0. */
 241         void (*init)(Unit *u);
 242
 243         /* This should free all type-specific variables. It should be
 244          * idempotent. */
 245         void (*done)(Unit *u);
 246
 247         /* Actually load data from disk. This may fail, and should set
 248          * load_state to UNIT_LOADED, UNIT_MERGED or leave it at
 249          * UNIT_STUB if no configuration could be found. */
 250         int (*load)(Unit *u);
 251
 252         /* If a a lot of units got created via enumerate(), this is
 253          * where to actually set the state and call unit_notify(). */
 254         int (*coldplug)(Unit *u);
 255
 256         void (*dump)(Unit *u, FILE *f, const char *prefix);
 257
 258         int (*start)(Unit *u);
 259         int (*stop)(Unit *u);
 260         int (*reload)(Unit *u);
 261
 262         bool (*can_reload)(Unit *u);
 263
 264         /* Write all data that cannot be restored from other sources
 265          * away using unit_serialize_item() */
 266         int (*serialize)(Unit *u, FILE *f, FDSet *fds);
 267
 268         /* Restore one item from the serialization */
 269         int (*deserialize_item)(Unit *u, const char *key, const char *data, FDSet *fds);
 270
 271         /* Boils down the more complex internal state of this unit to
 272          * a simpler one that the engine can understand */
 273         UnitActiveState (*active_state)(Unit *u);
 274
 275         /* Returns the substate specific to this unit type as
 276          * string. This is purely information so that we can give the
 277          * user a more finegrained explanation in which actual state a
 278          * unit is in. */
 279         const char* (*sub_state_to_string)(Unit *u);
 280
 281         /* Return true when there is reason to keep this entry around
 282          * even nothing references it and it isn't active in any
 283          * way */
 284         bool (*check_gc)(Unit *u);
 285
 286         /* Return true when this unit is suitable for snapshotting */
 287         bool (*check_snapshot)(Unit *u);
 288
 289         void (*fd_event)(Unit *u, int fd, uint32_t events, Watch *w);
 290         void (*sigchld_event)(Unit *u, pid_t pid, int code, int status);
 291         void (*timer_event)(Unit *u, uint64_t n_elapsed, Watch *w);
 292
 293         /* Reset maintenance state if we are in maintainance state */
 294         void (*reset_maintenance)(Unit *u);
 295
 296         /* Called whenever any of the cgroups this unit watches for
 297          * ran empty */
 298         void (*cgroup_notify_empty)(Unit *u);
 299
 300         /* Called whenever a process of this unit sends us a message */
 301         void (*notify_message)(Unit *u, pid_t pid, char **tags);
 302
 303         /* Called whenever a name thus Unit registered for comes or
 304          * goes away. */
 305         void (*bus_name_owner_change)(Unit *u, const char *name, const char *old_owner, const char *new_owner);
 306
 307         /* Called whenever a bus PID lookup finishes */
 308         void (*bus_query_pid_done)(Unit *u, const char *name, pid_t pid);
 309
 310         /* Called for each message received on the bus */
 311         DBusHandlerResult (*bus_message_handler)(Unit *u, DBusConnection *c, DBusMessage *message);
 312
 313         /* Return the unit this unit is following */
 314         Unit *(*following)(Unit *u);
 315
 316         /* This is called for each unit type and should be used to
 317          * enumerate existing devices and load them. However,
 318          * everything that is loaded here should still stay in
 319          * inactive state. It is the job of the coldplug() call above
 320          * to put the units into the initial state.  */
 321         int (*enumerate)(Manager *m);
 322
 323         /* Type specific cleanups. */
 324         void (*shutdown)(Manager *m);
 325
 326         /* Can units of this type have multiple names? */
 327         bool no_alias:1;
 328
 329         /* If true units of this types can never have "Requires"
 330          * dependencies, because state changes can only be observed,
 331          * not triggered */
 332         bool no_requires:1;
 333
 334         /* Instances make no sense for this type */
 335         bool no_instances:1;
 336
 337         /* Exclude this type from snapshots */
 338         bool no_snapshots:1;
 339
 340         /* Exclude from automatic gc */
 341         bool no_gc:1;
 342
 343         /* Exclude from isolation requests */
 344         bool no_isolate:1;
 345
 346         /* Show status updates on the console */
 347         bool show_status:1;
 348 };
 349
 350 extern const UnitVTable * const unit_vtable[_UNIT_TYPE_MAX];
 351
 352 #define UNIT_VTABLE(u) unit_vtable[(u)->meta.type]
 353
 354 /* For casting a unit into the various unit types */
 355 #define DEFINE_CAST(UPPERCASE, MixedCase)                               \
 356         static inline MixedCase* UPPERCASE(Unit *u) {                   \
 357                 if (_unlikely_(!u || u->meta.type != UNIT_##UPPERCASE)) \
 358                         return NULL;                                    \
 359                                                                         \
 360                 return (MixedCase*) u;                                  \
 361         }
 362
 363 /* For casting the various unit types into a unit */
 364 #define UNIT(u) ((Unit*) (&(u)->meta))
 365
 366 DEFINE_CAST(SOCKET, Socket);
 367 DEFINE_CAST(TIMER, Timer);
 368 DEFINE_CAST(SERVICE, Service);
 369 DEFINE_CAST(TARGET, Target);
 370 DEFINE_CAST(DEVICE, Device);
 371 DEFINE_CAST(MOUNT, Mount);
 372 DEFINE_CAST(AUTOMOUNT, Automount);
 373 DEFINE_CAST(SNAPSHOT, Snapshot);
 374 DEFINE_CAST(SWAP, Swap);
 375 DEFINE_CAST(PATH, Path);
 376
 377 Unit *unit_new(Manager *m);
 378 void unit_free(Unit *u);
 379
 380 int unit_add_name(Unit *u, const char *name);
 381
 382 int unit_add_dependency(Unit *u, UnitDependency d, Unit *other, bool add_reference);
 383 int unit_add_two_dependencies(Unit *u, UnitDependency d, UnitDependency e, Unit *other, bool add_reference);
 384
 385 int unit_add_dependency_by_name(Unit *u, UnitDependency d, const char *name, const char *filename, bool add_reference);
 386 int unit_add_two_dependencies_by_name(Unit *u, UnitDependency d, UnitDependency e, const char *name, const char *path, bool add_reference);
 387
 388 int unit_add_dependency_by_name_inverse(Unit *u, UnitDependency d, const char *name, const char *filename, bool add_reference);
 389 int unit_add_two_dependencies_by_name_inverse(Unit *u, UnitDependency d, UnitDependency e, const char *name, const char *path, bool add_reference);
 390
 391 int unit_add_exec_dependencies(Unit *u, ExecContext *c);
 392
 393 int unit_add_cgroup(Unit *u, CGroupBonding *b);
 394 int unit_add_cgroup_from_text(Unit *u, const char *name);
 395 int unit_add_default_cgroup(Unit *u);
 396 CGroupBonding* unit_get_default_cgroup(Unit *u);
 397
 398 int unit_choose_id(Unit *u, const char *name);
 399 int unit_set_description(Unit *u, const char *description);
 400
 401 bool unit_check_gc(Unit *u);
 402
 403 void unit_add_to_load_queue(Unit *u);
 404 void unit_add_to_dbus_queue(Unit *u);
 405 void unit_add_to_cleanup_queue(Unit *u);
 406 void unit_add_to_gc_queue(Unit *u);
 407
 408 int unit_merge(Unit *u, Unit *other);
 409 int unit_merge_by_name(Unit *u, const char *other);
 410
 411 Unit *unit_follow_merge(Unit *u);
 412
 413 int unit_load_fragment_and_dropin(Unit *u);
 414 int unit_load_fragment_and_dropin_optional(Unit *u);
 415 int unit_load_nop(Unit *u);
 416 int unit_load(Unit *unit);
 417
 418 const char *unit_description(Unit *u);
 419
 420 bool unit_has_name(Unit *u, const char *name);
 421
 422 UnitActiveState unit_active_state(Unit *u);
 423
 424 const char* unit_sub_state_to_string(Unit *u);
 425
 426 void unit_dump(Unit *u, FILE *f, const char *prefix);
 427
 428 bool unit_can_reload(Unit *u);
 429 bool unit_can_start(Unit *u);
 430
 431 int unit_start(Unit *u);
 432 int unit_stop(Unit *u);
 433 int unit_reload(Unit *u);
 434
 435 void unit_notify(Unit *u, UnitActiveState os, UnitActiveState ns);
 436
 437 int unit_watch_fd(Unit *u, int fd, uint32_t events, Watch *w);
 438 void unit_unwatch_fd(Unit *u, Watch *w);
 439
 440 int unit_watch_pid(Unit *u, pid_t pid);
 441 void unit_unwatch_pid(Unit *u, pid_t pid);
 442
 443 int unit_watch_timer(Unit *u, usec_t delay, Watch *w);
 444 void unit_unwatch_timer(Unit *u, Watch *w);
 445
 446 int unit_watch_bus_name(Unit *u, const char *name);
 447 void unit_unwatch_bus_name(Unit *u, const char *name);
 448
 449 bool unit_job_is_applicable(Unit *u, JobType j);
 450
 451 int set_unit_path(const char *p);
 452
 453 char *unit_dbus_path(Unit *u);
 454
 455 int unit_load_related_unit(Unit *u, const char *type, Unit **_found);
 456 int unit_get_related_unit(Unit *u, const char *type, Unit **_found);
 457
 458 char *unit_name_printf(Unit *u, const char* text);
 459 char *unit_full_printf(Unit *u, const char *text);
 460 char **unit_full_printf_strv(Unit *u, char **l);
 461
 462 bool unit_can_serialize(Unit *u);
 463 int unit_serialize(Unit *u, FILE *f, FDSet *fds);
 464 void unit_serialize_item_format(Unit *u, FILE *f, const char *key, const char *value, ...) _printf_attr_(4,5);
 465 void unit_serialize_item(Unit *u, FILE *f, const char *key, const char *value);
 466 int unit_deserialize(Unit *u, FILE *f, FDSet *fds);
 467
 468 int unit_add_node_link(Unit *u, const char *what, bool wants);
 469
 470 int unit_coldplug(Unit *u);
 471
 472 void unit_status_printf(Unit *u, const char *format, ...);
 473
 474 bool unit_need_daemon_reload(Unit *u);
 475
 476 void unit_reset_maintenance(Unit *u);
 477
 478 Unit *unit_following(Unit *u);
 479
 480 const char *unit_type_to_string(UnitType i);
 481 UnitType unit_type_from_string(const char *s);
 482
 483 const char *unit_load_state_to_string(UnitLoadState i);
 484 UnitLoadState unit_load_state_from_string(const char *s);
 485
 486 const char *unit_active_state_to_string(UnitActiveState i);
 487 UnitActiveState unit_active_state_from_string(const char *s);
 488
 489 const char *unit_dependency_to_string(UnitDependency i);
 490 UnitDependency unit_dependency_from_string(const char *s);
 491
 492 const char *kill_mode_to_string(KillMode k);
 493 KillMode kill_mode_from_string(const char *s);
 494
 495 #endif