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         /* Units that need to be loaded */
 107         LIST_HEAD(Unit, load_queue); /* this is actually more a stack than a queue, but uh. */
 108
 109         /* Jobs that need to be run */
 110         LIST_HEAD(Job, run_queue);   /* more a stack than a queue, too */
 111
 112         /* Units and jobs that have not yet been announced via
 113          * D-Bus. When something about a job changes it is added here
 114          * if it is not in there yet. This allows easy coalescing of
 115          * D-Bus change signals. */
 116         LIST_HEAD(Unit, dbus_unit_queue);
 117         LIST_HEAD(Job, dbus_job_queue);
 118
 119         /* Units to remove */
 120         LIST_HEAD(Unit, cleanup_queue);
 121
 122         /* Units to check when doing GC */
 123         LIST_HEAD(Unit, gc_queue);
 124
 125         /* Units that should be realized */
 126         LIST_HEAD(Unit, cgroup_queue);
 127
 128         Hashmap *watch_pids;  /* pid => Unit object n:1 */
 129
 130         char *notify_socket;
 131
 132         Watch notify_watch;
 133         Watch signal_watch;
 134         Watch time_change_watch;
 135         Watch jobs_in_progress_watch;
 136         Watch idle_pipe_watch;
 137
 138         int epoll_fd;
 139
 140         unsigned n_snapshots;
 141
 142         LookupPaths lookup_paths;
 143         Set *unit_path_cache;
 144
 145         char **environment;
 146
 147         usec_t runtime_watchdog;
 148         usec_t shutdown_watchdog;
 149
 150         dual_timestamp firmware_timestamp;
 151         dual_timestamp loader_timestamp;
 152         dual_timestamp kernel_timestamp;
 153         dual_timestamp initrd_timestamp;
 154         dual_timestamp userspace_timestamp;
 155         dual_timestamp finish_timestamp;
 156         dual_timestamp generators_start_timestamp;
 157         dual_timestamp generators_finish_timestamp;
 158         dual_timestamp unitsload_start_timestamp;
 159         dual_timestamp unitsload_finish_timestamp;
 160
 161         char *generator_unit_path;
 162         char *generator_unit_path_early;
 163         char *generator_unit_path_late;
 164
 165         /* Data specific to the device subsystem */
 166         struct udev* udev;
 167         struct udev_monitor* udev_monitor;
 168         Watch udev_watch;
 169         Hashmap *devices_by_sysfs;
 170
 171         /* Data specific to the mount subsystem */
 172         FILE *proc_self_mountinfo;
 173         Watch mount_watch;
 174
 175         /* Data specific to the swap filesystem */
 176         FILE *proc_swaps;
 177         Hashmap *swaps_by_proc_swaps;
 178         bool request_reload;
 179         Watch swap_watch;
 180
 181         /* Data specific to the D-Bus subsystem */
 182         DBusConnection *api_bus, *system_bus;
 183         DBusServer *private_bus;
 184         Set *bus_connections, *bus_connections_for_dispatch;
 185
 186         DBusMessage *queued_message; /* This is used during reloading:
 187                                       * before the reload we queue the
 188                                       * reply message here, and
 189                                       * afterwards we send it */
 190         DBusConnection *queued_message_connection; /* The connection to send the queued message on */
 191
 192         Hashmap *watch_bus;  /* D-Bus names => Unit object n:1 */
 193         int32_t name_data_slot;
 194         int32_t conn_data_slot;
 195         int32_t subscribed_data_slot;
 196
 197         bool send_reloading_done;
 198
 199         uint32_t current_job_id;
 200         uint32_t default_unit_job_id;
 201
 202         /* Data specific to the Automount subsystem */
 203         int dev_autofs_fd;
 204
 205         /* Data specific to the cgroup subsystem */
 206         Hashmap *cgroup_unit;
 207         CGroupControllerMask cgroup_supported;
 208         char *cgroup_root;
 209
 210         int gc_marker;
 211         unsigned n_in_gc_queue;
 212
 213         /* Make sure the user cannot accidentally unmount our cgroup
 214          * file system */
 215         int pin_cgroupfs_fd;
 216
 217         /* Flags */
 218         SystemdRunningAs running_as;
 219         ManagerExitCode exit_code:5;
 220
 221         bool dispatching_load_queue:1;
 222         bool dispatching_run_queue:1;
 223         bool dispatching_dbus_queue:1;
 224
 225         bool taint_usr:1;
 226
 227         bool show_status;
 228         bool confirm_spawn;
 229         bool no_console_output;
 230
 231         ExecOutput default_std_output, default_std_error;
 232
 233         usec_t default_restart_usec, default_timeout_start_usec,
 234                 default_timeout_stop_usec;
 235
 236         usec_t default_start_limit_interval;
 237         unsigned default_start_limit_burst;
 238
 239         struct rlimit *rlimit[RLIMIT_NLIMITS];
 240
 241         /* non-zero if we are reloading or reexecuting, */
 242         int n_reloading;
 243
 244         unsigned n_installed_jobs;
 245         unsigned n_failed_jobs;
 246
 247         /* Jobs in progress watching */
 248         unsigned n_running_jobs;
 249         unsigned n_on_console;
 250         unsigned jobs_in_progress_iteration;
 251
 252         /* Type=idle pipes */
 253         int idle_pipe[4];
 254
 255         char *switch_root;
 256         char *switch_root_init;
 257
 258         /* This maps all possible path prefixes to the units needing
 259          * them. It's a hashmap with a path string as key and a Set as
 260          * value where Unit objects are contained. */
 261         Hashmap *units_requiring_mounts_for;
 262 };
 263
 264 int manager_new(SystemdRunningAs running_as, bool reexecuting, Manager **m);
 265 void manager_free(Manager *m);
 266
 267 int manager_enumerate(Manager *m);
 268 int manager_coldplug(Manager *m);
 269 int manager_startup(Manager *m, FILE *serialization, FDSet *fds);
 270
 271 Job *manager_get_job(Manager *m, uint32_t id);
 272 Unit *manager_get_unit(Manager *m, const char *name);
 273
 274 int manager_get_unit_by_path(Manager *m, const char *path, const char *suffix, Unit **_found);
 275
 276 int manager_get_job_from_dbus_path(Manager *m, const char *s, Job **_j);
 277
 278 int manager_load_unit_prepare(Manager *m, const char *name, const char *path, DBusError *e, Unit **_ret);
 279 int manager_load_unit(Manager *m, const char *name, const char *path, DBusError *e, Unit **_ret);
 280 int manager_load_unit_from_dbus_path(Manager *m, const char *s, DBusError *e, Unit **_u);
 281
 282 int manager_add_job(Manager *m, JobType type, Unit *unit, JobMode mode, bool force, DBusError *e, Job **_ret);
 283 int manager_add_job_by_name(Manager *m, JobType type, const char *name, JobMode mode, bool force, DBusError *e, Job **_ret);
 284
 285 void manager_dump_units(Manager *s, FILE *f, const char *prefix);
 286 void manager_dump_jobs(Manager *s, FILE *f, const char *prefix);
 287
 288 void manager_clear_jobs(Manager *m);
 289
 290 unsigned manager_dispatch_load_queue(Manager *m);
 291 unsigned manager_dispatch_run_queue(Manager *m);
 292 unsigned manager_dispatch_dbus_queue(Manager *m);
 293
 294 int manager_environment_add(Manager *m, char **environment);
 295 int manager_set_default_rlimits(Manager *m, struct rlimit **default_rlimit);
 296
 297 int manager_loop(Manager *m);
 298
 299 void manager_dispatch_bus_name_owner_changed(Manager *m, const char *name, const char* old_owner, const char *new_owner);
 300 void manager_dispatch_bus_query_pid_done(Manager *m, const char *name, pid_t pid);
 301
 302 int manager_open_serialization(Manager *m, FILE **_f);
 303
 304 int manager_serialize(Manager *m, FILE *f, FDSet *fds, bool switching_root);
 305 int manager_deserialize(Manager *m, FILE *f, FDSet *fds);
 306 int manager_distribute_fds(Manager *m, FDSet *fds);
 307
 308 int manager_reload(Manager *m);
 309
 310 bool manager_is_reloading_or_reexecuting(Manager *m) _pure_;
 311
 312 void manager_reset_failed(Manager *m);
 313
 314 void manager_send_unit_audit(Manager *m, Unit *u, int type, bool success);
 315 void manager_send_unit_plymouth(Manager *m, Unit *u);
 316
 317 bool manager_unit_inactive_or_pending(Manager *m, const char *name);
 318
 319 void manager_check_finished(Manager *m);
 320
 321 void manager_run_generators(Manager *m);
 322 void manager_undo_generators(Manager *m);
 323
 324 void manager_recheck_journal(Manager *m);
 325
 326 void manager_set_show_status(Manager *m, bool b);
 327 void manager_status_printf(Manager *m, bool ephemeral, const char *status, const char *format, ...) _printf_(4,5);
 328
 329 Set *manager_get_units_requiring_mounts_for(Manager *m, const char *path);
 330
 331 void watch_init(Watch *w);