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
  28 #include "sd-bus.h"
  29 #include "sd-event.h"
  30 #include "fdset.h"
  31 #include "cgroup-util.h"
  32
  33 /* Enforce upper limit how many names we allow */
  34 #define MANAGER_MAX_NAMES 131072 /* 128K */
  35
  36 typedef struct Manager Manager;
  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 #include "unit.h"
  53 #include "job.h"
  54 #include "hashmap.h"
  55 #include "list.h"
  56 #include "set.h"
  57 #include "path-lookup.h"
  58 #include "execute.h"
  59 #include "unit-name.h"
  60 #include "exit-status.h"
  61
  62 struct Manager {
  63         /* Note that the set of units we know of is allowed to be
  64          * inconsistent. However the subset of it that is loaded may
  65          * not, and the list of jobs may neither. */
  66
  67         /* Active jobs and units */
  68         Hashmap *units;  /* name string => Unit object n:1 */
  69         Hashmap *jobs;   /* job id => Job object 1:1 */
  70
  71         /* To make it easy to iterate through the units of a specific
  72          * type we maintain a per type linked list */
  73         LIST_HEAD(Unit, units_by_type[_UNIT_TYPE_MAX]);
  74
  75         /* Units that need to be loaded */
  76         LIST_HEAD(Unit, load_queue); /* this is actually more a stack than a queue, but uh. */
  77
  78         /* Jobs that need to be run */
  79         LIST_HEAD(Job, run_queue);   /* more a stack than a queue, too */
  80
  81         /* Units and jobs that have not yet been announced via
  82          * D-Bus. When something about a job changes it is added here
  83          * if it is not in there yet. This allows easy coalescing of
  84          * D-Bus change signals. */
  85         LIST_HEAD(Unit, dbus_unit_queue);
  86         LIST_HEAD(Job, dbus_job_queue);
  87
  88         /* Units to remove */
  89         LIST_HEAD(Unit, cleanup_queue);
  90
  91         /* Units to check when doing GC */
  92         LIST_HEAD(Unit, gc_queue);
  93
  94         /* Units that should be realized */
  95         LIST_HEAD(Unit, cgroup_queue);
  96
  97         sd_event *event;
  98
  99         Hashmap *watch_pids;  /* pid => Unit object n:1 */
 100
 101         sd_event_source *run_queue_event_source;
 102
 103         char *notify_socket;
 104         int notify_fd;
 105         sd_event_source *notify_event_source;
 106
 107         int signal_fd;
 108         sd_event_source *signal_event_source;
 109
 110         int time_change_fd;
 111         sd_event_source *time_change_event_source;
 112
 113         sd_event_source *jobs_in_progress_event_source;
 114
 115         unsigned n_snapshots;
 116
 117         LookupPaths lookup_paths;
 118         Set *unit_path_cache;
 119
 120         char **environment;
 121
 122         usec_t runtime_watchdog;
 123         usec_t shutdown_watchdog;
 124
 125         dual_timestamp firmware_timestamp;
 126         dual_timestamp loader_timestamp;
 127         dual_timestamp kernel_timestamp;
 128         dual_timestamp initrd_timestamp;
 129         dual_timestamp userspace_timestamp;
 130         dual_timestamp finish_timestamp;
 131         dual_timestamp security_start_timestamp;
 132         dual_timestamp security_finish_timestamp;
 133         dual_timestamp generators_start_timestamp;
 134         dual_timestamp generators_finish_timestamp;
 135         dual_timestamp units_load_start_timestamp;
 136         dual_timestamp units_load_finish_timestamp;
 137
 138         char *generator_unit_path;
 139         char *generator_unit_path_early;
 140         char *generator_unit_path_late;
 141
 142         struct udev* udev;
 143
 144         /* Data specific to the device subsystem */
 145         struct udev_monitor* udev_monitor;
 146         sd_event_source *udev_event_source;
 147         Hashmap *devices_by_sysfs;
 148
 149         /* Data specific to the mount subsystem */
 150         FILE *proc_self_mountinfo;
 151         sd_event_source *mount_event_source;
 152
 153         /* Data specific to the swap filesystem */
 154         FILE *proc_swaps;
 155         sd_event_source *swap_event_source;
 156         Hashmap *swaps_by_devnode;
 157
 158         /* Data specific to the D-Bus subsystem */
 159         sd_bus *api_bus, *system_bus;
 160         Set *private_buses;
 161         int private_listen_fd;
 162         sd_event_source *private_listen_event_source;
 163         Set *subscribed;
 164
 165         sd_bus_message *queued_message; /* This is used during reloading:
 166                                       * before the reload we queue the
 167                                       * reply message here, and
 168                                       * afterwards we send it */
 169         sd_bus *queued_message_bus; /* The connection to send the queued message on */
 170
 171         Hashmap *watch_bus;  /* D-Bus names => Unit object n:1 */
 172
 173         bool send_reloading_done;
 174
 175         uint32_t current_job_id;
 176         uint32_t default_unit_job_id;
 177
 178         /* Data specific to the Automount subsystem */
 179         int dev_autofs_fd;
 180
 181         /* Data specific to the cgroup subsystem */
 182         Hashmap *cgroup_unit;
 183         CGroupControllerMask cgroup_supported;
 184         char *cgroup_root;
 185
 186         int gc_marker;
 187         unsigned n_in_gc_queue;
 188
 189         /* Make sure the user cannot accidentally unmount our cgroup
 190          * file system */
 191         int pin_cgroupfs_fd;
 192
 193         /* Flags */
 194         SystemdRunningAs running_as;
 195         ManagerExitCode exit_code:5;
 196
 197         bool dispatching_load_queue:1;
 198         bool dispatching_dbus_queue:1;
 199
 200         bool taint_usr:1;
 201
 202         ShowStatus show_status;
 203         bool confirm_spawn;
 204         bool no_console_output;
 205
 206         ExecOutput default_std_output, default_std_error;
 207
 208         usec_t default_restart_usec, default_timeout_start_usec,
 209                 default_timeout_stop_usec;
 210
 211         usec_t default_start_limit_interval;
 212         unsigned default_start_limit_burst;
 213
 214         struct rlimit *rlimit[RLIMIT_NLIMITS];
 215
 216         /* non-zero if we are reloading or reexecuting, */
 217         int n_reloading;
 218
 219         unsigned n_installed_jobs;
 220         unsigned n_failed_jobs;
 221
 222         /* Jobs in progress watching */
 223         unsigned n_running_jobs;
 224         unsigned n_on_console;
 225         unsigned jobs_in_progress_iteration;
 226
 227         /* Type=idle pipes */
 228         int idle_pipe[4];
 229         sd_event_source *idle_pipe_event_source;
 230
 231         char *switch_root;
 232         char *switch_root_init;
 233
 234         /* This maps all possible path prefixes to the units needing
 235          * them. It's a hashmap with a path string as key and a Set as
 236          * value where Unit objects are contained. */
 237         Hashmap *units_requiring_mounts_for;
 238
 239         /* Reference to the kdbus bus control fd */
 240         int kdbus_fd;
 241 };
 242
 243 int manager_new(SystemdRunningAs running_as, Manager **m);
 244 void manager_free(Manager *m);
 245
 246 int manager_enumerate(Manager *m);
 247 int manager_startup(Manager *m, FILE *serialization, FDSet *fds);
 248
 249 Job *manager_get_job(Manager *m, uint32_t id);
 250 Unit *manager_get_unit(Manager *m, const char *name);
 251
 252 int manager_get_unit_by_path(Manager *m, const char *path, const char *suffix, Unit **_found);
 253
 254 int manager_get_job_from_dbus_path(Manager *m, const char *s, Job **_j);
 255
 256 int manager_load_unit_prepare(Manager *m, const char *name, const char *path, sd_bus_error *e, Unit **_ret);
 257 int manager_load_unit(Manager *m, const char *name, const char *path, sd_bus_error *e, Unit **_ret);
 258 int manager_load_unit_from_dbus_path(Manager *m, const char *s, sd_bus_error *e, Unit **_u);
 259
 260 int manager_add_job(Manager *m, JobType type, Unit *unit, JobMode mode, bool force, sd_bus_error *e, Job **_ret);
 261 int manager_add_job_by_name(Manager *m, JobType type, const char *name, JobMode mode, bool force, sd_bus_error *e, Job **_ret);
 262
 263 void manager_dump_units(Manager *s, FILE *f, const char *prefix);
 264 void manager_dump_jobs(Manager *s, FILE *f, const char *prefix);
 265
 266 void manager_clear_jobs(Manager *m);
 267
 268 unsigned manager_dispatch_load_queue(Manager *m);
 269
 270 int manager_environment_add(Manager *m, char **minus, char **plus);
 271 int manager_set_default_rlimits(Manager *m, struct rlimit **default_rlimit);
 272
 273 int manager_loop(Manager *m);
 274
 275 void manager_dispatch_bus_name_owner_changed(Manager *m, const char *name, const char* old_owner, const char *new_owner);
 276
 277 int manager_open_serialization(Manager *m, FILE **_f);
 278
 279 int manager_serialize(Manager *m, FILE *f, FDSet *fds, bool switching_root);
 280 int manager_deserialize(Manager *m, FILE *f, FDSet *fds);
 281
 282 int manager_reload(Manager *m);
 283
 284 bool manager_is_reloading_or_reexecuting(Manager *m) _pure_;
 285
 286 void manager_reset_failed(Manager *m);
 287
 288 void manager_send_unit_audit(Manager *m, Unit *u, int type, bool success);
 289 void manager_send_unit_plymouth(Manager *m, Unit *u);
 290
 291 bool manager_unit_inactive_or_pending(Manager *m, const char *name);
 292
 293 void manager_check_finished(Manager *m);
 294
 295 void manager_run_generators(Manager *m);
 296 void manager_undo_generators(Manager *m);
 297
 298 void manager_recheck_journal(Manager *m);
 299
 300 void manager_set_show_status(Manager *m, ShowStatus mode);
 301 void manager_status_printf(Manager *m, bool ephemeral, const char *status, const char *format, ...) _printf_(4,5);
 302
 303 Set *manager_get_units_requiring_mounts_for(Manager *m, const char *path);