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