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