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