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