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