src/core/manager.h

   1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
   2
   3 #pragma once
   4
   5 /***
   6   This file is part of systemd.
   7
   8   Copyright 2010 Lennart Poettering
   9
  10   systemd is free software; you can redistribute it and/or modify it
  11   under the terms of the GNU Lesser General Public License as published by
  12   the Free Software Foundation; either version 2.1 of the License, or
  13   (at your option) any later version.
  14
  15   systemd is distributed in the hope that it will be useful, but
  16   WITHOUT ANY WARRANTY; without even the implied warranty of
  17   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  18   Lesser General Public License for more details.
  19
  20   You should have received a copy of the GNU Lesser General Public License
  21   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  22 ***/
  23
  24 #include <stdbool.h>
  25 #include <inttypes.h>
  26 #include <stdio.h>
  27 #include <dbus/dbus.h>
  28
  29 #include "fdset.h"
  30
  31 /* Enforce upper limit how many names we allow */
  32 #define MANAGER_MAX_NAMES 131072 /* 128K */
  33
  34 typedef struct Manager Manager;
  35 typedef enum WatchType WatchType;
  36 typedef struct Watch Watch;
  37
  38 typedef enum ManagerExitCode {
  39         MANAGER_RUNNING,
  40         MANAGER_EXIT,
  41         MANAGER_RELOAD,
  42         MANAGER_REEXECUTE,
  43         MANAGER_REBOOT,
  44         MANAGER_POWEROFF,
  45         MANAGER_HALT,
  46         MANAGER_KEXEC,
  47         MANAGER_SWITCH_ROOT,
  48         _MANAGER_EXIT_CODE_MAX,
  49         _MANAGER_EXIT_CODE_INVALID = -1
  50 } ManagerExitCode;
  51
  52 typedef enum ManagerRunningAs {
  53         MANAGER_SYSTEM,
  54         MANAGER_USER,
  55         _MANAGER_RUNNING_AS_MAX,
  56         _MANAGER_RUNNING_AS_INVALID = -1
  57 } ManagerRunningAs;
  58
  59 enum WatchType {
  60         WATCH_INVALID,
  61         WATCH_SIGNAL,
  62         WATCH_NOTIFY,
  63         WATCH_FD,
  64         WATCH_UNIT_TIMER,
  65         WATCH_JOB_TIMER,
  66         WATCH_MOUNT,
  67         WATCH_SWAP,
  68         WATCH_UDEV,
  69         WATCH_DBUS_WATCH,
  70         WATCH_DBUS_TIMEOUT
  71 };
  72
  73 struct Watch {
  74         int fd;
  75         WatchType type;
  76         union {
  77                 struct Unit *unit;
  78                 struct Job *job;
  79                 DBusWatch *bus_watch;
  80                 DBusTimeout *bus_timeout;
  81         } data;
  82         bool fd_is_dupped:1;
  83         bool socket_accept:1;
  84 };
  85
  86 #include "unit.h"
  87 #include "job.h"
  88 #include "hashmap.h"
  89 #include "list.h"
  90 #include "set.h"
  91 #include "dbus.h"
  92 #include "path-lookup.h"
  93
  94 struct Manager {
  95         /* Note that the set of units we know of is allowed to be
  96          * inconsistent. However the subset of it that is loaded may
  97          * not, and the list of jobs may neither. */
  98
  99         /* Active jobs and units */
 100         Hashmap *units;  /* name string => Unit object n:1 */
 101         Hashmap *jobs;   /* job id => Job object 1:1 */
 102
 103         /* To make it easy to iterate through the units of a specific
 104          * type we maintain a per type linked list */
 105         LIST_HEAD(Unit, units_by_type[_UNIT_TYPE_MAX]);
 106
 107         /* To optimize iteration of units that have requires_mounts_for set */
 108         LIST_HEAD(Unit, has_requires_mounts_for);
 109
 110         /* Units that need to be loaded */
 111         LIST_HEAD(Unit, load_queue); /* this is actually more a stack than a queue, but uh. */
 112
 113         /* Jobs that need to be run */
 114         LIST_HEAD(Job, run_queue);   /* more a stack than a queue, too */
 115
 116         /* Units and jobs that have not yet been announced via
 117          * D-Bus. When something about a job changes it is added here
 118          * if it is not in there yet. This allows easy coalescing of
 119          * D-Bus change signals. */
 120         LIST_HEAD(Unit, dbus_unit_queue);
 121         LIST_HEAD(Job, dbus_job_queue);
 122
 123         /* Units to remove */
 124         LIST_HEAD(Unit, cleanup_queue);
 125
 126         /* Units to check when doing GC */
 127         LIST_HEAD(Unit, gc_queue);
 128
 129         Hashmap *watch_pids;  /* pid => Unit object n:1 */
 130
 131         char *notify_socket;
 132
 133         Watch notify_watch;
 134         Watch signal_watch;
 135
 136         int epoll_fd;
 137
 138         unsigned n_snapshots;
 139
 140         LookupPaths lookup_paths;
 141         Set *unit_path_cache;
 142
 143         char **environment;
 144         char **default_controllers;
 145
 146         usec_t runtime_watchdog;
 147         usec_t shutdown_watchdog;
 148
 149         dual_timestamp firmware_timestamp;
 150         dual_timestamp loader_timestamp;
 151         dual_timestamp kernel_timestamp;
 152         dual_timestamp initrd_timestamp;
 153         dual_timestamp userspace_timestamp;
 154         dual_timestamp finish_timestamp;
 155
 156         char *generator_unit_path;
 157         char *generator_unit_path_early;
 158         char *generator_unit_path_late;
 159
 160         /* Data specific to the device subsystem */
 161         struct udev* udev;
 162         struct udev_monitor* udev_monitor;
 163         Watch udev_watch;
 164         Hashmap *devices_by_sysfs;
 165
 166         /* Data specific to the mount subsystem */
 167         FILE *proc_self_mountinfo;
 168         Watch mount_watch;
 169
 170         /* Data specific to the swap filesystem */
 171         FILE *proc_swaps;
 172         Hashmap *swaps_by_proc_swaps;
 173         bool request_reload;
 174         Watch swap_watch;
 175
 176         /* Data specific to the D-Bus subsystem */
 177         DBusConnection *api_bus, *system_bus;
 178         DBusServer *private_bus;
 179         Set *bus_connections, *bus_connections_for_dispatch;
 180
 181         DBusMessage *queued_message; /* This is used during reloading:
 182                                       * before the reload we queue the
 183                                       * reply message here, and
 184                                       * afterwards we send it */
 185         DBusConnection *queued_message_connection; /* The connection to send the queued message on */
 186
 187         Hashmap *watch_bus;  /* D-Bus names => Unit object n:1 */
 188         int32_t name_data_slot;
 189         int32_t conn_data_slot;
 190         int32_t subscribed_data_slot;
 191
 192         uint32_t current_job_id;
 193         uint32_t default_unit_job_id;
 194
 195         /* Data specific to the Automount subsystem */
 196         int dev_autofs_fd;
 197
 198         /* Data specific to the cgroup subsystem */
 199         Hashmap *cgroup_bondings; /* path string => CGroupBonding object 1:n */
 200         char *cgroup_hierarchy;
 201
 202         usec_t gc_queue_timestamp;
 203         int gc_marker;
 204         unsigned n_in_gc_queue;
 205
 206         /* Make sure the user cannot accidentally unmount our cgroup
 207          * file system */
 208         int pin_cgroupfs_fd;
 209
 210         /* Audit fd */
 211 #ifdef HAVE_AUDIT
 212         int audit_fd;
 213 #endif
 214
 215         /* Flags */
 216         ManagerRunningAs running_as;
 217         ManagerExitCode exit_code:5;
 218
 219         bool dispatching_load_queue:1;
 220         bool dispatching_run_queue:1;
 221         bool dispatching_dbus_queue:1;
 222
 223         bool taint_usr:1;
 224
 225         bool show_status;
 226         bool confirm_spawn;
 227
 228         ExecOutput default_std_output, default_std_error;
 229
 230         struct rlimit *rlimit[RLIMIT_NLIMITS];
 231
 232         /* non-zero if we are reloading or reexecuting, */
 233         int n_reloading;
 234
 235         unsigned n_installed_jobs;
 236         unsigned n_failed_jobs;
 237
 238         /* Type=idle pipes */
 239         int idle_pipe[2];
 240
 241         char *switch_root;
 242         char *switch_root_init;
 243 };
 244
 245 int manager_new(ManagerRunningAs running_as, Manager **m);
 246 void manager_free(Manager *m);
 247
 248 int manager_enumerate(Manager *m);
 249 int manager_coldplug(Manager *m);
 250 int manager_startup(Manager *m, FILE *serialization, FDSet *fds);
 251
 252 Job *manager_get_job(Manager *m, uint32_t id);
 253 Unit *manager_get_unit(Manager *m, const char *name);
 254
 255 int manager_get_job_from_dbus_path(Manager *m, const char *s, Job **_j);
 256
 257 int manager_load_unit_prepare(Manager *m, const char *name, const char *path, DBusError *e, Unit **_ret);
 258 int manager_load_unit(Manager *m, const char *name, const char *path, DBusError *e, Unit **_ret);
 259 int manager_load_unit_from_dbus_path(Manager *m, const char *s, DBusError *e, Unit **_u);
 260
 261 int manager_add_job(Manager *m, JobType type, Unit *unit, JobMode mode, bool force, DBusError *e, Job **_ret);
 262 int manager_add_job_by_name(Manager *m, JobType type, const char *name, JobMode mode, bool force, DBusError *e, Job **_ret);
 263
 264 void manager_dump_units(Manager *s, FILE *f, const char *prefix);
 265 void manager_dump_jobs(Manager *s, FILE *f, const char *prefix);
 266
 267 void manager_clear_jobs(Manager *m);
 268
 269 unsigned manager_dispatch_load_queue(Manager *m);
 270 unsigned manager_dispatch_run_queue(Manager *m);
 271 unsigned manager_dispatch_dbus_queue(Manager *m);
 272
 273 int manager_set_default_controllers(Manager *m, char **controllers);
 274 int manager_set_default_rlimits(Manager *m, struct rlimit **default_rlimit);
 275
 276 int manager_loop(Manager *m);
 277
 278 void manager_dispatch_bus_name_owner_changed(Manager *m, const char *name, const char* old_owner, const char *new_owner);
 279 void manager_dispatch_bus_query_pid_done(Manager *m, const char *name, pid_t pid);
 280
 281 int manager_open_serialization(Manager *m, FILE **_f);
 282
 283 int manager_serialize(Manager *m, FILE *f, FDSet *fds, bool serialize_jobs);
 284 int manager_deserialize(Manager *m, FILE *f, FDSet *fds);
 285
 286 int manager_reload(Manager *m);
 287
 288 bool manager_is_booting_or_shutting_down(Manager *m);
 289
 290 void manager_reset_failed(Manager *m);
 291
 292 void manager_send_unit_audit(Manager *m, Unit *u, int type, bool success);
 293 void manager_send_unit_plymouth(Manager *m, Unit *u);
 294
 295 bool manager_unit_pending_inactive(Manager *m, const char *name);
 296
 297 void manager_check_finished(Manager *m);
 298
 299 void manager_run_generators(Manager *m);
 300 void manager_undo_generators(Manager *m);
 301
 302 void manager_recheck_journal(Manager *m);
 303
 304 void manager_set_show_status(Manager *m, bool b);
 305 bool manager_get_show_status(Manager *m);
 306
 307 const char *manager_running_as_to_string(ManagerRunningAs i);
 308 ManagerRunningAs manager_running_as_from_string(const char *s);