manager.h

   1 /*-*- Mode: C; c-basic-offset: 8 -*-*/
   2
   3 #ifndef foomanagerhfoo
   4 #define foomanagerhfoo
   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 <inttypes.h>
  27 #include <stdio.h>
  28 #include <dbus/dbus.h>
  29
  30 #include "fdset.h"
  31
  32 /* Enforce upper limit how many names we allow */
  33 #define MANAGER_MAX_NAMES 2048
  34
  35 typedef struct Manager Manager;
  36 typedef enum WatchType WatchType;
  37 typedef struct Watch Watch;
  38
  39 typedef enum ManagerExitCode {
  40         MANAGER_RUNNING,
  41         MANAGER_EXIT,
  42         MANAGER_RELOAD,
  43         MANAGER_REEXECUTE,
  44         _MANAGER_EXIT_CODE_MAX,
  45         _MANAGER_EXIT_CODE_INVALID = -1
  46 } ManagerExitCode;
  47
  48 typedef enum ManagerRunningAs {
  49         MANAGER_INIT,      /* root and pid=1 */
  50         MANAGER_SYSTEM,    /* root and pid!=1 */
  51         MANAGER_SESSION,   /* non-root, for a session */
  52         _MANAGER_RUNNING_AS_MAX,
  53         _MANAGER_RUNNING_AS_INVALID = -1
  54 } ManagerRunningAs;
  55
  56 enum WatchType {
  57         WATCH_INVALID,
  58         WATCH_SIGNAL,
  59         WATCH_FD,
  60         WATCH_TIMER,
  61         WATCH_MOUNT,
  62         WATCH_UDEV,
  63         WATCH_DBUS_WATCH,
  64         WATCH_DBUS_TIMEOUT
  65 };
  66
  67 struct Watch {
  68         int fd;
  69         WatchType type;
  70         union {
  71                 union Unit *unit;
  72                 DBusWatch *bus_watch;
  73                 DBusTimeout *bus_timeout;
  74         } data;
  75         bool fd_is_dupped:1;
  76         bool socket_accept:1;
  77 };
  78
  79 #include "unit.h"
  80 #include "job.h"
  81 #include "hashmap.h"
  82 #include "list.h"
  83 #include "set.h"
  84 #include "dbus.h"
  85
  86 #define SPECIAL_DEFAULT_TARGET "default.target"
  87
  88 /* This is not really intended to be started by directly. This is
  89  * mostly so that other targets (reboot/halt/poweroff) can depend on
  90  * it to bring all services down that want to be brought down on
  91  * system shutdown. */
  92 #define SPECIAL_SHUTDOWN_TARGET "shutdown.target"
  93
  94 #define SPECIAL_LOGGER_SOCKET "systemd-logger.socket"
  95
  96 #define SPECIAL_KBREQUEST_TARGET "kbrequest.target"
  97 #define SPECIAL_SIGPWR_TARGET "sigpwr.target"
  98 #define SPECIAL_CTRL_ALT_DEL_TARGET "ctrl-alt-del.target"
  99
 100 #define SPECIAL_LOCAL_FS_TARGET "local-fs.target"
 101 #define SPECIAL_REMOTE_FS_TARGET "remote-fs.target"
 102 #define SPECIAL_SWAP_TARGET "swap.target"
 103 #define SPECIAL_NETWORK_TARGET "network.target"
 104 #define SPECIAL_NSS_LOOKUP_TARGET "nss-lookup.target"     /* LSB's $named */
 105 #define SPECIAL_RPCBIND_TARGET "rpcbind.target"           /* LSB's $portmap */
 106 #define SPECIAL_SYSLOG_TARGET "syslog.target"             /* Should pull in syslog.socket or syslog.service */
 107 #define SPECIAL_RTC_SET_TARGET "rtc-set.target"           /* LSB's $time */
 108
 109 #define SPECIAL_BASIC_TARGET "basic.target"
 110 #define SPECIAL_RESCUE_TARGET "rescue.target"
 111
 112 #ifndef SPECIAL_DBUS_SERVICE
 113 #define SPECIAL_DBUS_SERVICE "dbus.service"
 114 #endif
 115
 116 #ifndef SPECIAL_SYSLOG_SERVICE
 117 #define SPECIAL_SYSLOG_SERVICE "syslog.service"
 118 #endif
 119
 120 /* For SysV compatibility. Usually an alias for a saner target. On
 121  * SysV-free systems this doesn't exist. */
 122 #define SPECIAL_RUNLEVEL0_TARGET "runlevel0.target"
 123 #define SPECIAL_RUNLEVEL1_TARGET "runlevel1.target"
 124 #define SPECIAL_RUNLEVEL2_TARGET "runlevel2.target"
 125 #define SPECIAL_RUNLEVEL3_TARGET "runlevel3.target"
 126 #define SPECIAL_RUNLEVEL4_TARGET "runlevel4.target"
 127 #define SPECIAL_RUNLEVEL5_TARGET "runlevel5.target"
 128 #define SPECIAL_RUNLEVEL6_TARGET "runlevel6.target"
 129
 130 struct Manager {
 131         uint32_t current_job_id;
 132
 133         /* Note that the set of units we know of is allowed to be
 134          * incosistent. However the subset of it that is loaded may
 135          * not, and the list of jobs may neither. */
 136
 137         /* Active jobs and units */
 138         Hashmap *units;  /* name string => Unit object n:1 */
 139         Hashmap *jobs;   /* job id => Job object 1:1 */
 140
 141         /* To make it easy to iterate through the units of a specific
 142          * type we maintain a per type linked list */
 143         LIST_HEAD(Meta, units_per_type[_UNIT_TYPE_MAX]);
 144
 145         /* Units that need to be loaded */
 146         LIST_HEAD(Meta, load_queue); /* this is actually more a stack than a queue, but uh. */
 147
 148         /* Jobs that need to be run */
 149         LIST_HEAD(Job, run_queue);   /* more a stack than a queue, too */
 150
 151         /* Units and jobs that have not yet been announced via
 152          * D-Bus. When something about a job changes it is added here
 153          * if it is not in there yet. This allows easy coalescing of
 154          * D-Bus change signals. */
 155         LIST_HEAD(Meta, dbus_unit_queue);
 156         LIST_HEAD(Job, dbus_job_queue);
 157
 158         /* Units to remove */
 159         LIST_HEAD(Meta, cleanup_queue);
 160
 161         /* Units to check when doing GC */
 162         LIST_HEAD(Meta, gc_queue);
 163
 164         /* Jobs to be added */
 165         Hashmap *transaction_jobs;      /* Unit object => Job object list 1:1 */
 166         JobDependency *transaction_anchor;
 167
 168         Hashmap *watch_pids;  /* pid => Unit object n:1 */
 169
 170         Watch signal_watch;
 171
 172         int epoll_fd;
 173
 174         unsigned n_snapshots;
 175
 176         char **unit_path;
 177         char **sysvinit_path;
 178         char **sysvrcnd_path;
 179
 180         char **environment;
 181
 182         usec_t boot_timestamp;
 183
 184         /* Data specific to the device subsystem */
 185         struct udev* udev;
 186         struct udev_monitor* udev_monitor;
 187         Watch udev_watch;
 188
 189         /* Data specific to the mount subsystem */
 190         FILE *proc_self_mountinfo;
 191         Watch mount_watch;
 192
 193         /* Data specific to the swap filesystem */
 194         FILE *proc_swaps;
 195
 196         /* Data specific to the D-Bus subsystem */
 197         DBusConnection *api_bus, *system_bus;
 198         Set *subscribed;
 199         DBusMessage *queued_message; /* This is used during reloading:
 200                                       * before the reload we queue the
 201                                       * reply message here, and
 202                                       * afterwards we send it */
 203
 204         Hashmap *watch_bus;  /* D-Bus names => Unit object n:1 */
 205         int32_t name_data_slot;
 206
 207         /* Data specific to the Automount subsystem */
 208         int dev_autofs_fd;
 209
 210         /* Data specific to the cgroup subsystem */
 211         Hashmap *cgroup_bondings; /* path string => CGroupBonding object 1:n */
 212         char *cgroup_controller;
 213         char *cgroup_hierarchy;
 214
 215         usec_t gc_queue_timestamp;
 216
 217         int gc_marker;
 218         unsigned n_in_gc_queue;
 219
 220         /* Flags */
 221         ManagerRunningAs running_as;
 222         ManagerExitCode exit_code:4;
 223
 224         bool dispatching_load_queue:1;
 225         bool dispatching_run_queue:1;
 226         bool dispatching_dbus_queue:1;
 227
 228         bool request_api_bus_dispatch:1;
 229         bool request_system_bus_dispatch:1;
 230
 231         bool utmp_reboot_written:1;
 232
 233         bool confirm_spawn:1;
 234 };
 235
 236 int manager_new(ManagerRunningAs running_as, bool confirm_spawn, Manager **m);
 237 void manager_free(Manager *m);
 238
 239 int manager_enumerate(Manager *m);
 240 int manager_coldplug(Manager *m);
 241 int manager_startup(Manager *m, FILE *serialization, FDSet *fds);
 242
 243 Job *manager_get_job(Manager *m, uint32_t id);
 244 Unit *manager_get_unit(Manager *m, const char *name);
 245
 246 int manager_get_unit_from_dbus_path(Manager *m, const char *s, Unit **_u);
 247 int manager_get_job_from_dbus_path(Manager *m, const char *s, Job **_j);
 248
 249 int manager_load_unit_prepare(Manager *m, const char *name, const char *path, Unit **_ret);
 250 int manager_load_unit(Manager *m, const char *name, const char *path, Unit **_ret);
 251
 252 int manager_add_job(Manager *m, JobType type, Unit *unit, JobMode mode, bool force, Job **_ret);
 253 int manager_add_job_by_name(Manager *m, JobType type, const char *name, JobMode mode, bool force, Job **_ret);
 254
 255 void manager_dump_units(Manager *s, FILE *f, const char *prefix);
 256 void manager_dump_jobs(Manager *s, FILE *f, const char *prefix);
 257
 258 void manager_transaction_unlink_job(Manager *m, Job *j, bool delete_dependencies);
 259
 260 void manager_clear_jobs(Manager *m);
 261
 262 unsigned manager_dispatch_load_queue(Manager *m);
 263 unsigned manager_dispatch_run_queue(Manager *m);
 264 unsigned manager_dispatch_dbus_queue(Manager *m);
 265
 266 int manager_loop(Manager *m);
 267
 268 void manager_write_utmp_reboot(Manager *m);
 269 void manager_write_utmp_runlevel(Manager *m, Unit *t);
 270
 271 void manager_dispatch_bus_name_owner_changed(Manager *m, const char *name, const char* old_owner, const char *new_owner);
 272 void manager_dispatch_bus_query_pid_done(Manager *m, const char *name, pid_t pid);
 273
 274 int manager_open_serialization(FILE **_f);
 275
 276 int manager_serialize(Manager *m, FILE *f, FDSet *fds);
 277 int manager_deserialize(Manager *m, FILE *f, FDSet *fds);
 278
 279 int manager_reload(Manager *m);
 280
 281 const char *manager_running_as_to_string(ManagerRunningAs i);
 282 ManagerRunningAs manager_running_as_from_string(const char *s);
 283
 284 #endif