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 ManagerState {
  39         MANAGER_STARTING,
  40         MANAGER_RUNNING,
  41         MANAGER_DEGRADED,
  42         MANAGER_MAINTENANCE,
  43         MANAGER_STOPPING,
  44         _MANAGER_STATE_MAX,
  45         _MANAGER_STATE_INVALID = -1
  46 } ManagerState;
  47
  48 typedef enum ManagerExitCode {
  49         MANAGER_OK,
  50         MANAGER_EXIT,
  51         MANAGER_RELOAD,
  52         MANAGER_REEXECUTE,
  53         MANAGER_REBOOT,
  54         MANAGER_POWEROFF,
  55         MANAGER_HALT,
  56         MANAGER_KEXEC,
  57         MANAGER_SWITCH_ROOT,
  58         _MANAGER_EXIT_CODE_MAX,
  59         _MANAGER_EXIT_CODE_INVALID = -1
  60 } ManagerExitCode;
  61
  62 #include "unit.h"
  63 #include "job.h"
  64 #include "hashmap.h"
  65 #include "list.h"
  66 #include "set.h"
  67 #include "path-lookup.h"
  68 #include "execute.h"
  69 #include "unit-name.h"
  70 #include "exit-status.h"
  71 #include "show-status.h"
  72
  73 struct Manager {
  74         /* Note that the set of units we know of is allowed to be
  75          * inconsistent. However the subset of it that is loaded may
  76          * not, and the list of jobs may neither. */
  77
  78         /* Active jobs and units */
  79         Hashmap *units;  /* name string => Unit object n:1 */
  80         Hashmap *jobs;   /* job id => Job object 1:1 */
  81
  82         /* To make it easy to iterate through the units of a specific
  83          * type we maintain a per type linked list */
  84         LIST_HEAD(Unit, units_by_type[_UNIT_TYPE_MAX]);
  85
  86         /* Units that need to be loaded */
  87         LIST_HEAD(Unit, load_queue); /* this is actually more a stack than a queue, but uh. */
  88
  89         /* Jobs that need to be run */
  90         LIST_HEAD(Job, run_queue);   /* more a stack than a queue, too */
  91
  92         /* Units and jobs that have not yet been announced via
  93          * D-Bus. When something about a job changes it is added here
  94          * if it is not in there yet. This allows easy coalescing of
  95          * D-Bus change signals. */
  96         LIST_HEAD(Unit, dbus_unit_queue);
  97         LIST_HEAD(Job, dbus_job_queue);
  98
  99         /* Units to remove */
 100         LIST_HEAD(Unit, cleanup_queue);
 101
 102         /* Units to check when doing GC */
 103         LIST_HEAD(Unit, gc_queue);
 104
 105         /* Units that should be realized */
 106         LIST_HEAD(Unit, cgroup_queue);
 107
 108         sd_event *event;
 109
 110         /* We use two hash tables here, since the same PID might be
 111          * watched by two different units: once the unit that forked
 112          * it off, and possibly a different unit to which it was
 113          * joined as cgroup member. Since we know that it is either
 114          * one or two units for each PID we just use to hashmaps
 115          * here. */
 116         Hashmap *watch_pids1;  /* pid => Unit object n:1 */
 117         Hashmap *watch_pids2;  /* pid => Unit object n:1 */
 118
 119         /* A set which contains all currently failed units */
 120         Set *failed_units;
 121
 122         sd_event_source *run_queue_event_source;
 123
 124         char *notify_socket;
 125         int notify_fd;
 126         sd_event_source *notify_event_source;
 127
 128         int signal_fd;
 129         sd_event_source *signal_event_source;
 130
 131         int time_change_fd;
 132         sd_event_source *time_change_event_source;
 133
 134         sd_event_source *jobs_in_progress_event_source;
 135
 136         unsigned n_snapshots;
 137
 138         LookupPaths lookup_paths;
 139         Set *unit_path_cache;
 140
 141         char **environment;
 142
 143         usec_t runtime_watchdog;
 144         usec_t shutdown_watchdog;
 145
 146         dual_timestamp firmware_timestamp;
 147         dual_timestamp loader_timestamp;
 148         dual_timestamp kernel_timestamp;
 149         dual_timestamp initrd_timestamp;
 150         dual_timestamp userspace_timestamp;
 151         dual_timestamp finish_timestamp;
 152         dual_timestamp security_start_timestamp;
 153         dual_timestamp security_finish_timestamp;
 154         dual_timestamp generators_start_timestamp;
 155         dual_timestamp generators_finish_timestamp;
 156         dual_timestamp units_load_start_timestamp;
 157         dual_timestamp units_load_finish_timestamp;
 158
 159         char *generator_unit_path;
 160         char *generator_unit_path_early;
 161         char *generator_unit_path_late;
 162
 163         struct udev* udev;
 164
 165         /* Data specific to the device subsystem */
 166         struct udev_monitor* udev_monitor;
 167         sd_event_source *udev_event_source;
 168         Hashmap *devices_by_sysfs;
 169
 170         /* Data specific to the mount subsystem */
 171         FILE *proc_self_mountinfo;
 172         sd_event_source *mount_event_source;
 173
 174         /* Data specific to the swap filesystem */
 175         FILE *proc_swaps;
 176         sd_event_source *swap_event_source;
 177         Hashmap *swaps_by_devnode;
 178
 179         /* Data specific to the D-Bus subsystem */
 180         sd_bus *api_bus, *system_bus;
 181         Set *private_buses;
 182         int private_listen_fd;
 183         sd_event_source *private_listen_event_source;
 184
 185         /* Contains all the clients that are subscribed to signals via
 186         the API bus. Note that private bus connections are always
 187         considered subscribes, since they last for very short only,
 188         and it is much simpler that way. */
 189         sd_bus_track *subscribed;
 190         char **deserialized_subscribed;
 191
 192         sd_bus_message *queued_message; /* This is used during reloading:
 193                                       * before the reload we queue the
 194                                       * reply message here, and
 195                                       * afterwards we send it */
 196         sd_bus *queued_message_bus; /* The connection to send the queued message on */
 197
 198         Hashmap *watch_bus;  /* D-Bus names => Unit object n:1 */
 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_dbus_queue:1;
 226
 227         bool taint_usr:1;
 228
 229         ShowStatus show_status;
 230         bool confirm_spawn;
 231         bool no_console_output;
 232
 233         ExecOutput default_std_output, default_std_error;
 234
 235         usec_t default_restart_usec, default_timeout_start_usec, default_timeout_stop_usec;
 236
 237         usec_t default_start_limit_interval;
 238         unsigned default_start_limit_burst;
 239
 240         bool default_cpu_accounting;
 241         bool default_memory_accounting;
 242         bool default_blockio_accounting;
 243         usec_t default_cpu_quota_period_usec;
 244
 245         usec_t default_timer_accuracy_usec;
 246
 247         struct rlimit *rlimit[_RLIMIT_MAX];
 248
 249         /* non-zero if we are reloading or reexecuting, */
 250         int n_reloading;
 251
 252         unsigned n_installed_jobs;
 253         unsigned n_failed_jobs;
 254
 255         /* Jobs in progress watching */
 256         unsigned n_running_jobs;
 257         unsigned n_on_console;
 258         unsigned jobs_in_progress_iteration;
 259
 260         /* Type=idle pipes */
 261         int idle_pipe[4];
 262         sd_event_source *idle_pipe_event_source;
 263
 264         char *switch_root;
 265         char *switch_root_init;
 266
 267         /* This maps all possible path prefixes to the units needing
 268          * them. It's a hashmap with a path string as key and a Set as
 269          * value where Unit objects are contained. */
 270         Hashmap *units_requiring_mounts_for;
 271
 272         /* Reference to the kdbus bus control fd */
 273         int kdbus_fd;
 274 };
 275
 276 int manager_new(SystemdRunningAs running_as, Manager **m);
 277 void manager_free(Manager *m);
 278
 279 int manager_enumerate(Manager *m);
 280 int manager_startup(Manager *m, FILE *serialization, FDSet *fds);
 281
 282 Job *manager_get_job(Manager *m, uint32_t id);
 283 Unit *manager_get_unit(Manager *m, const char *name);
 284
 285 int manager_get_unit_by_path(Manager *m, const char *path, const char *suffix, Unit **_found);
 286
 287 int manager_get_job_from_dbus_path(Manager *m, const char *s, Job **_j);
 288
 289 int manager_load_unit_prepare(Manager *m, const char *name, const char *path, sd_bus_error *e, Unit **_ret);
 290 int manager_load_unit(Manager *m, const char *name, const char *path, sd_bus_error *e, Unit **_ret);
 291 int manager_load_unit_from_dbus_path(Manager *m, const char *s, sd_bus_error *e, Unit **_u);
 292
 293 int manager_add_job(Manager *m, JobType type, Unit *unit, JobMode mode, bool force, sd_bus_error *e, Job **_ret);
 294 int manager_add_job_by_name(Manager *m, JobType type, const char *name, JobMode mode, bool force, sd_bus_error *e, Job **_ret);
 295
 296 void manager_dump_units(Manager *s, FILE *f, const char *prefix);
 297 void manager_dump_jobs(Manager *s, FILE *f, const char *prefix);
 298
 299 void manager_clear_jobs(Manager *m);
 300
 301 unsigned manager_dispatch_load_queue(Manager *m);
 302
 303 int manager_environment_add(Manager *m, char **minus, char **plus);
 304 int manager_set_default_rlimits(Manager *m, struct rlimit **default_rlimit);
 305
 306 int manager_loop(Manager *m);
 307
 308 void manager_dispatch_bus_name_owner_changed(Manager *m, const char *name, const char* old_owner, const char *new_owner);
 309
 310 int manager_open_serialization(Manager *m, FILE **_f);
 311
 312 int manager_serialize(Manager *m, FILE *f, FDSet *fds, bool switching_root);
 313 int manager_deserialize(Manager *m, FILE *f, FDSet *fds);
 314
 315 int manager_reload(Manager *m);
 316
 317 bool manager_is_reloading_or_reexecuting(Manager *m) _pure_;
 318
 319 void manager_reset_failed(Manager *m);
 320
 321 void manager_send_unit_audit(Manager *m, Unit *u, int type, bool success);
 322 void manager_send_unit_plymouth(Manager *m, Unit *u);
 323
 324 bool manager_unit_inactive_or_pending(Manager *m, const char *name);
 325
 326 void manager_check_finished(Manager *m);
 327
 328 void manager_run_generators(Manager *m);
 329 void manager_undo_generators(Manager *m);
 330
 331 void manager_recheck_journal(Manager *m);
 332
 333 void manager_set_show_status(Manager *m, ShowStatus mode);
 334 void manager_status_printf(Manager *m, bool ephemeral, const char *status, const char *format, ...) _printf_(4,5);
 335 void manager_flip_auto_status(Manager *m, bool enable);
 336
 337 Set *manager_get_units_requiring_mounts_for(Manager *m, const char *path);
 338
 339 const char *manager_get_runtime_prefix(Manager *m);
 340
 341 ManagerState manager_state(Manager *m);
 342
 343 const char *manager_state_to_string(ManagerState m) _const_;
 344 ManagerState manager_state_from_string(const char *s) _pure_;