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 '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         dual_timestamp inactive_exit_timestamp;
 158         dual_timestamp active_enter_timestamp;
 159         dual_timestamp active_exit_timestamp;
 160         dual_timestamp inactive_enter_timestamp;
 161
 162         /* Counterparts in the cgroup filesystem */
 163         CGroupBonding *cgroup_bondings;
 164
 165         /* Per type list */
 166         LIST_FIELDS(Meta, units_per_type);
 167
 168         /* Load queue */
 169         LIST_FIELDS(Meta, load_queue);
 170
 171         /* D-Bus queue */
 172         LIST_FIELDS(Meta, dbus_queue);
 173
 174         /* Cleanup queue */
 175         LIST_FIELDS(Meta, cleanup_queue);
 176
 177         /* GC queue */
 178         LIST_FIELDS(Meta, gc_queue);
 179
 180         /* Used during GC sweeps */
 181         unsigned gc_marker;
 182
 183         /* If we go down, pull down everything that depends on us, too */
 184         bool recursive_stop;
 185
 186         /* Garbage collect us we nobody wants or requires us anymore */
 187         bool stop_when_unneeded;
 188
 189         /* Create default depedencies */
 190         bool default_dependencies;
 191
 192         /* Bring up this unit even if a dependency fails to start */
 193         bool ignore_dependency_failure;
 194
 195         /* Refuse manual starting, allow starting only indirectly via dependency. */
 196         bool refuse_manual_start;
 197
 198         /* Don't allow the user to stop this unit manually, allow stopping only indirectly via dependency. */
 199         bool refuse_manual_stop;
 200
 201         /* When deserializing, temporarily store the job type for this
 202          * unit here, if there was a job scheduled */
 203         int deserialized_job; /* This is actually of type JobType */
 204
 205         bool in_load_queue:1;
 206         bool in_dbus_queue:1;
 207         bool in_cleanup_queue:1;
 208         bool in_gc_queue:1;
 209
 210         bool sent_dbus_new_signal:1;
 211 };
 212
 213 #include "service.h"
 214 #include "timer.h"
 215 #include "socket.h"
 216 #include "target.h"
 217 #include "device.h"
 218 #include "mount.h"
 219 #include "automount.h"
 220 #include "snapshot.h"
 221 #include "swap.h"
 222 #include "path.h"
 223
 224 union Unit {
 225         Meta meta;
 226         Service service;
 227         Timer timer;
 228         Socket socket;
 229         Target target;
 230         Device device;
 231         Mount mount;
 232         Automount automount;
 233         Snapshot snapshot;
 234         Swap swap;
 235         Path path;
 236 };
 237
 238 struct UnitVTable {
 239         const char *suffix;
 240
 241         /* This should reset all type-specific variables. This should
 242          * not allocate memory, and is called with zero-initialized
 243          * data. It should hence only initialize variables that need
 244          * to be set != 0. */
 245         void (*init)(Unit *u);
 246
 247         /* This should free all type-specific variables. It should be
 248          * idempotent. */
 249         void (*done)(Unit *u);
 250
 251         /* Actually load data from disk. This may fail, and should set
 252          * load_state to UNIT_LOADED, UNIT_MERGED or leave it at
 253          * UNIT_STUB if no configuration could be found. */
 254         int (*load)(Unit *u);
 255
 256         /* If a a lot of units got created via enumerate(), this is
 257          * where to actually set the state and call unit_notify(). */
 258         int (*coldplug)(Unit *u);
 259
 260         void (*dump)(Unit *u, FILE *f, const char *prefix);
 261
 262         int (*start)(Unit *u);
 263         int (*stop)(Unit *u);
 264         int (*reload)(Unit *u);
 265
 266         bool (*can_reload)(Unit *u);
 267
 268         /* Write all data that cannot be restored from other sources
 269          * away using unit_serialize_item() */
 270         int (*serialize)(Unit *u, FILE *f, FDSet *fds);
 271
 272         /* Restore one item from the serialization */
 273         int (*deserialize_item)(Unit *u, const char *key, const char *data, FDSet *fds);
 274
 275         /* Boils down the more complex internal state of this unit to
 276          * a simpler one that the engine can understand */
 277         UnitActiveState (*active_state)(Unit *u);
 278
 279         /* Returns the substate specific to this unit type as
 280          * string. This is purely information so that we can give the
 281          * user a more finegrained explanation in which actual state a
 282          * unit is in. */
 283         const char* (*sub_state_to_string)(Unit *u);
 284
 285         /* Return true when there is reason to keep this entry around
 286          * even nothing references it and it isn't active in any
 287          * way */
 288         bool (*check_gc)(Unit *u);
 289
 290         /* Return true when this unit is suitable for snapshotting */
 291         bool (*check_snapshot)(Unit *u);
 292
 293         void (*fd_event)(Unit *u, int fd, uint32_t events, Watch *w);
 294         void (*sigchld_event)(Unit *u, pid_t pid, int code, int status);
 295         void (*timer_event)(Unit *u, uint64_t n_elapsed, Watch *w);
 296
 297         /* Reset maintenance state if we are in maintainance state */
 298         void (*reset_maintenance)(Unit *u);
 299
 300         /* Called whenever any of the cgroups this unit watches for
 301          * ran empty */
 302         void (*cgroup_notify_empty)(Unit *u);
 303
 304         /* Called whenever a process of this unit sends us a message */
 305         void (*notify_message)(Unit *u, pid_t pid, char **tags);
 306
 307         /* Called whenever a name thus Unit registered for comes or
 308          * goes away. */
 309         void (*bus_name_owner_change)(Unit *u, const char *name, const char *old_owner, const char *new_owner);
 310
 311         /* Called whenever a bus PID lookup finishes */
 312         void (*bus_query_pid_done)(Unit *u, const char *name, pid_t pid);
 313
 314         /* Called for each message received on the bus */
 315         DBusHandlerResult (*bus_message_handler)(Unit *u, DBusConnection *c, DBusMessage *message);
 316
 317         /* Return the unit this unit is following */
 318         Unit *(*following)(Unit *u);
 319
 320         /* This is called for each unit type and should be used to
 321          * enumerate existing devices and load them. However,
 322          * everything that is loaded here should still stay in
 323          * inactive state. It is the job of the coldplug() call above
 324          * to put the units into the initial state.  */
 325         int (*enumerate)(Manager *m);
 326
 327         /* Type specific cleanups. */
 328         void (*shutdown)(Manager *m);
 329
 330         /* Can units of this type have multiple names? */
 331         bool no_alias:1;
 332
 333         /* If true units of this types can never have "Requires"
 334          * dependencies, because state changes can only be observed,
 335          * not triggered */
 336         bool no_requires:1;
 337
 338         /* Instances make no sense for this type */
 339         bool no_instances:1;
 340
 341         /* Exclude this type from snapshots */
 342         bool no_snapshots:1;
 343
 344         /* Exclude from automatic gc */
 345         bool no_gc:1;
 346
 347         /* Exclude from isolation requests */
 348         bool no_isolate:1;
 349
 350         /* Show status updates on the console */
 351         bool show_status:1;
 352 };
 353
 354 extern const UnitVTable * const unit_vtable[_UNIT_TYPE_MAX];
 355
 356 #define UNIT_VTABLE(u) unit_vtable[(u)->meta.type]
 357
 358 /* For casting a unit into the various unit types */
 359 #define DEFINE_CAST(UPPERCASE, MixedCase)                               \
 360         static inline MixedCase* UPPERCASE(Unit *u) {                   \
 361                 if (_unlikely_(!u || u->meta.type != UNIT_##UPPERCASE)) \
 362                         return NULL;                                    \
 363                                                                         \
 364                 return (MixedCase*) u;                                  \
 365         }
 366
 367 /* For casting the various unit types into a unit */
 368 #define UNIT(u) ((Unit*) (&(u)->meta))
 369
 370 DEFINE_CAST(SOCKET, Socket);
 371 DEFINE_CAST(TIMER, Timer);
 372 DEFINE_CAST(SERVICE, Service);
 373 DEFINE_CAST(TARGET, Target);
 374 DEFINE_CAST(DEVICE, Device);
 375 DEFINE_CAST(MOUNT, Mount);
 376 DEFINE_CAST(AUTOMOUNT, Automount);
 377 DEFINE_CAST(SNAPSHOT, Snapshot);
 378 DEFINE_CAST(SWAP, Swap);
 379 DEFINE_CAST(PATH, Path);
 380
 381 Unit *unit_new(Manager *m);
 382 void unit_free(Unit *u);
 383
 384 int unit_add_name(Unit *u, const char *name);
 385
 386 int unit_add_dependency(Unit *u, UnitDependency d, Unit *other, bool add_reference);
 387 int unit_add_two_dependencies(Unit *u, UnitDependency d, UnitDependency e, Unit *other, bool add_reference);
 388
 389 int unit_add_dependency_by_name(Unit *u, UnitDependency d, const char *name, const char *filename, bool add_reference);
 390 int unit_add_two_dependencies_by_name(Unit *u, UnitDependency d, UnitDependency e, const char *name, const char *path, bool add_reference);
 391
 392 int unit_add_dependency_by_name_inverse(Unit *u, UnitDependency d, const char *name, const char *filename, bool add_reference);
 393 int unit_add_two_dependencies_by_name_inverse(Unit *u, UnitDependency d, UnitDependency e, const char *name, const char *path, bool add_reference);
 394
 395 int unit_add_exec_dependencies(Unit *u, ExecContext *c);
 396
 397 int unit_add_cgroup(Unit *u, CGroupBonding *b);
 398 int unit_add_cgroup_from_text(Unit *u, const char *name);
 399 int unit_add_default_cgroup(Unit *u);
 400 CGroupBonding* unit_get_default_cgroup(Unit *u);
 401
 402 int unit_choose_id(Unit *u, const char *name);
 403 int unit_set_description(Unit *u, const char *description);
 404
 405 bool unit_check_gc(Unit *u);
 406
 407 void unit_add_to_load_queue(Unit *u);
 408 void unit_add_to_dbus_queue(Unit *u);
 409 void unit_add_to_cleanup_queue(Unit *u);
 410 void unit_add_to_gc_queue(Unit *u);
 411
 412 int unit_merge(Unit *u, Unit *other);
 413 int unit_merge_by_name(Unit *u, const char *other);
 414
 415 Unit *unit_follow_merge(Unit *u);
 416
 417 int unit_load_fragment_and_dropin(Unit *u);
 418 int unit_load_fragment_and_dropin_optional(Unit *u);
 419 int unit_load_nop(Unit *u);
 420 int unit_load(Unit *unit);
 421
 422 const char *unit_description(Unit *u);
 423
 424 bool unit_has_name(Unit *u, const char *name);
 425
 426 UnitActiveState unit_active_state(Unit *u);
 427
 428 const char* unit_sub_state_to_string(Unit *u);
 429
 430 void unit_dump(Unit *u, FILE *f, const char *prefix);
 431
 432 bool unit_can_reload(Unit *u);
 433 bool unit_can_start(Unit *u);
 434
 435 int unit_start(Unit *u);
 436 int unit_stop(Unit *u);
 437 int unit_reload(Unit *u);
 438
 439 void unit_notify(Unit *u, UnitActiveState os, UnitActiveState ns);
 440
 441 int unit_watch_fd(Unit *u, int fd, uint32_t events, Watch *w);
 442 void unit_unwatch_fd(Unit *u, Watch *w);
 443
 444 int unit_watch_pid(Unit *u, pid_t pid);
 445 void unit_unwatch_pid(Unit *u, pid_t pid);
 446
 447 int unit_watch_timer(Unit *u, usec_t delay, Watch *w);
 448 void unit_unwatch_timer(Unit *u, Watch *w);
 449
 450 int unit_watch_bus_name(Unit *u, const char *name);
 451 void unit_unwatch_bus_name(Unit *u, const char *name);
 452
 453 bool unit_job_is_applicable(Unit *u, JobType j);
 454
 455 int set_unit_path(const char *p);
 456
 457 char *unit_dbus_path(Unit *u);
 458
 459 int unit_load_related_unit(Unit *u, const char *type, Unit **_found);
 460 int unit_get_related_unit(Unit *u, const char *type, Unit **_found);
 461
 462 char *unit_name_printf(Unit *u, const char* text);
 463 char *unit_full_printf(Unit *u, const char *text);
 464 char **unit_full_printf_strv(Unit *u, char **l);
 465
 466 bool unit_can_serialize(Unit *u);
 467 int unit_serialize(Unit *u, FILE *f, FDSet *fds);
 468 void unit_serialize_item_format(Unit *u, FILE *f, const char *key, const char *value, ...) _printf_attr_(4,5);
 469 void unit_serialize_item(Unit *u, FILE *f, const char *key, const char *value);
 470 int unit_deserialize(Unit *u, FILE *f, FDSet *fds);
 471
 472 int unit_add_node_link(Unit *u, const char *what, bool wants);
 473
 474 int unit_coldplug(Unit *u);
 475
 476 void unit_status_printf(Unit *u, const char *format, ...);
 477
 478 bool unit_need_daemon_reload(Unit *u);
 479
 480 void unit_reset_maintenance(Unit *u);
 481
 482 Unit *unit_following(Unit *u);
 483
 484 const char *unit_type_to_string(UnitType i);
 485 UnitType unit_type_from_string(const char *s);
 486
 487 const char *unit_load_state_to_string(UnitLoadState i);
 488 UnitLoadState unit_load_state_from_string(const char *s);
 489
 490 const char *unit_active_state_to_string(UnitActiveState i);
 491 UnitActiveState unit_active_state_from_string(const char *s);
 492
 493 const char *unit_dependency_to_string(UnitDependency i);
 494 UnitDependency unit_dependency_from_string(const char *s);
 495
 496 const char *kill_mode_to_string(KillMode k);
 497 KillMode kill_mode_from_string(const char *s);
 498
 499 #endif