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 enum WatchType {
  53         WATCH_INVALID,
  54         WATCH_SIGNAL,
  55         WATCH_NOTIFY,
  56         WATCH_FD,
  57         WATCH_UNIT_TIMER,
  58         WATCH_JOB_TIMER,
  59         WATCH_MOUNT,
  60         WATCH_SWAP,
  61         WATCH_UDEV,
  62         WATCH_DBUS_WATCH,
  63         WATCH_DBUS_TIMEOUT,
  64         WATCH_TIME_CHANGE
  65 };
  66
  67 struct Watch {
  68         int fd;
  69         WatchType type;
  70         union {
  71                 struct Unit *unit;
  72                 struct Job *job;
  73                 DBusWatch *bus_watch;
  74                 DBusTimeout *bus_timeout;
  75         } data;
  76         bool fd_is_dupped:1;
  77         bool socket_accept:1;
  78 };
  79
  80 #include "unit.h"
  81 #include "job.h"
  82 #include "hashmap.h"
  83 #include "list.h"
  84 #include "set.h"
  85 #include "dbus.h"
  86 #include "path-lookup.h"
  87
  88 struct Manager {
  89         /* Note that the set of units we know of is allowed to be
  90          * inconsistent. However the subset of it that is loaded may
  91          * not, and the list of jobs may neither. */
  92
  93         /* Active jobs and units */
  94         Hashmap *units;  /* name string => Unit object n:1 */
  95         Hashmap *jobs;   /* job id => Job object 1:1 */
  96
  97         /* To make it easy to iterate through the units of a specific
  98          * type we maintain a per type linked list */
  99         LIST_HEAD(Unit, units_by_type[_UNIT_TYPE_MAX]);
 100
 101         /* To optimize iteration of units that have requires_mounts_for set */
 102         LIST_HEAD(Unit, has_requires_mounts_for);
 103
 104         /* Units that need to be loaded */
 105         LIST_HEAD(Unit, load_queue); /* this is actually more a stack than a queue, but uh. */
 106
 107         /* Jobs that need to be run */
 108         LIST_HEAD(Job, run_queue);   /* more a stack than a queue, too */
 109
 110         /* Units and jobs that have not yet been announced via
 111          * D-Bus. When something about a job changes it is added here
 112          * if it is not in there yet. This allows easy coalescing of
 113          * D-Bus change signals. */
 114         LIST_HEAD(Unit, dbus_unit_queue);
 115         LIST_HEAD(Job, dbus_job_queue);
 116
 117         /* Units to remove */
 118         LIST_HEAD(Unit, cleanup_queue);
 119
 120         /* Units to check when doing GC */
 121         LIST_HEAD(Unit, gc_queue);
 122
 123         Hashmap *watch_pids;  /* pid => Unit object n:1 */
 124
 125         char *notify_socket;
 126
 127         Watch notify_watch;
 128         Watch signal_watch;
 129         Watch time_change_watch;
 130
 131         int epoll_fd;
 132
 133         unsigned n_snapshots;
 134
 135         LookupPaths lookup_paths;
 136         Set *unit_path_cache;
 137
 138         char **environment;
 139         char **default_controllers;
 140
 141         usec_t runtime_watchdog;
 142         usec_t shutdown_watchdog;
 143
 144         dual_timestamp firmware_timestamp;
 145         dual_timestamp loader_timestamp;
 146         dual_timestamp kernel_timestamp;
 147         dual_timestamp initrd_timestamp;
 148         dual_timestamp userspace_timestamp;
 149         dual_timestamp finish_timestamp;
 150
 151         char *generator_unit_path;
 152         char *generator_unit_path_early;
 153         char *generator_unit_path_late;
 154
 155         /* Data specific to the device subsystem */
 156         struct udev* udev;
 157         struct udev_monitor* udev_monitor;
 158         Watch udev_watch;
 159         Hashmap *devices_by_sysfs;
 160
 161         /* Data specific to the mount subsystem */
 162         FILE *proc_self_mountinfo;
 163         Watch mount_watch;
 164
 165         /* Data specific to the swap filesystem */
 166         FILE *proc_swaps;
 167         Hashmap *swaps_by_proc_swaps;
 168         bool request_reload;
 169         Watch swap_watch;
 170
 171         /* Data specific to the D-Bus subsystem */
 172         DBusConnection *api_bus, *system_bus;
 173         DBusServer *private_bus;
 174         Set *bus_connections, *bus_connections_for_dispatch;
 175
 176         DBusMessage *queued_message; /* This is used during reloading:
 177                                       * before the reload we queue the
 178                                       * reply message here, and
 179                                       * afterwards we send it */
 180         DBusConnection *queued_message_connection; /* The connection to send the queued message on */
 181
 182         Hashmap *watch_bus;  /* D-Bus names => Unit object n:1 */
 183         int32_t name_data_slot;
 184         int32_t conn_data_slot;
 185         int32_t subscribed_data_slot;
 186
 187         uint32_t current_job_id;
 188         uint32_t default_unit_job_id;
 189
 190         /* Data specific to the Automount subsystem */
 191         int dev_autofs_fd;
 192
 193         /* Data specific to the cgroup subsystem */
 194         Hashmap *cgroup_bondings; /* path string => CGroupBonding object 1:n */
 195         char *cgroup_hierarchy;
 196
 197         usec_t gc_queue_timestamp;
 198         int gc_marker;
 199         unsigned n_in_gc_queue;
 200
 201         /* Make sure the user cannot accidentally unmount our cgroup
 202          * file system */
 203         int pin_cgroupfs_fd;
 204
 205         /* Flags */
 206         SystemdRunningAs running_as;
 207         ManagerExitCode exit_code:5;
 208
 209         bool dispatching_load_queue:1;
 210         bool dispatching_run_queue:1;
 211         bool dispatching_dbus_queue:1;
 212
 213         bool taint_usr:1;
 214
 215         bool show_status;
 216         bool confirm_spawn;
 217
 218         ExecOutput default_std_output, default_std_error;
 219
 220         struct rlimit *rlimit[RLIMIT_NLIMITS];
 221
 222         /* non-zero if we are reloading or reexecuting, */
 223         int n_reloading;
 224
 225         unsigned n_installed_jobs;
 226         unsigned n_failed_jobs;
 227
 228         unsigned n_running_jobs;
 229
 230         /* Type=idle pipes */
 231         int idle_pipe[2];
 232
 233         char *switch_root;
 234         char *switch_root_init;
 235 };
 236
 237 int manager_new(SystemdRunningAs running_as, Manager **m);
 238 void manager_free(Manager *m);
 239
 240 int manager_enumerate(Manager *m);
 241 int manager_coldplug(Manager *m);
 242 int manager_startup(Manager *m, FILE *serialization, FDSet *fds);
 243
 244 Job *manager_get_job(Manager *m, uint32_t id);
 245 Unit *manager_get_unit(Manager *m, const char *name);
 246
 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, DBusError *e, Unit **_ret);
 250 int manager_load_unit(Manager *m, const char *name, const char *path, DBusError *e, Unit **_ret);
 251 int manager_load_unit_from_dbus_path(Manager *m, const char *s, DBusError *e, Unit **_u);
 252
 253 int manager_add_job(Manager *m, JobType type, Unit *unit, JobMode mode, bool force, DBusError *e, Job **_ret);
 254 int manager_add_job_by_name(Manager *m, JobType type, const char *name, JobMode mode, bool force, DBusError *e, Job **_ret);
 255
 256 void manager_dump_units(Manager *s, FILE *f, const char *prefix);
 257 void manager_dump_jobs(Manager *s, FILE *f, const char *prefix);
 258
 259 void manager_clear_jobs(Manager *m);
 260
 261 unsigned manager_dispatch_load_queue(Manager *m);
 262 unsigned manager_dispatch_run_queue(Manager *m);
 263 unsigned manager_dispatch_dbus_queue(Manager *m);
 264
 265 int manager_set_default_controllers(Manager *m, char **controllers);
 266 int manager_set_default_rlimits(Manager *m, struct rlimit **default_rlimit);
 267
 268 int manager_loop(Manager *m);
 269
 270 void manager_dispatch_bus_name_owner_changed(Manager *m, const char *name, const char* old_owner, const char *new_owner);
 271 void manager_dispatch_bus_query_pid_done(Manager *m, const char *name, pid_t pid);
 272
 273 int manager_open_serialization(Manager *m, FILE **_f);
 274
 275 int manager_serialize(Manager *m, FILE *f, FDSet *fds, bool serialize_jobs);
 276 int manager_deserialize(Manager *m, FILE *f, FDSet *fds);
 277 int manager_distribute_fds(Manager *m, FDSet *fds);
 278
 279 int manager_reload(Manager *m);
 280
 281 bool manager_is_booting_or_shutting_down(Manager *m);
 282
 283 void manager_reset_failed(Manager *m);
 284
 285 void manager_send_unit_audit(Manager *m, Unit *u, int type, bool success);
 286 void manager_send_unit_plymouth(Manager *m, Unit *u);
 287
 288 bool manager_unit_pending_inactive(Manager *m, const char *name);
 289
 290 void manager_check_finished(Manager *m);
 291
 292 void manager_run_generators(Manager *m);
 293 void manager_undo_generators(Manager *m);
 294
 295 void manager_recheck_journal(Manager *m);
 296
 297 void manager_set_show_status(Manager *m, bool b);
 298 void manager_status_printf(Manager *m, const char *status, const char *format, ...);
 299 bool manager_get_show_status(Manager *m);
 300
 301 void watch_init(Watch *w);