src/core/manager.h

   1 #pragma once
   2
   3 /***
   4   This file is part of systemd.
   5
   6   Copyright 2010 Lennart Poettering
   7
   8   systemd is free software; you can redistribute it and/or modify it
   9   under the terms of the GNU Lesser General Public License as published by
  10   the Free Software Foundation; either version 2.1 of the License, or
  11   (at your option) any later version.
  12
  13   systemd is distributed in the hope that it will be useful, but
  14   WITHOUT ANY WARRANTY; without even the implied warranty of
  15   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  16   Lesser General Public License for more details.
  17
  18   You should have received a copy of the GNU Lesser General Public License
  19   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  20 ***/
  21
  22 #include <libmount.h>
  23 #include <stdbool.h>
  24 #include <stdio.h>
  25
  26 #include "sd-bus.h"
  27 #include "sd-event.h"
  28
  29 #include "cgroup-util.h"
  30 #include "fdset.h"
  31 #include "hashmap.h"
  32 #include "list.h"
  33 #include "ratelimit.h"
  34
  35 /* Enforce upper limit how many names we allow */
  36 #define MANAGER_MAX_NAMES 131072 /* 128K */
  37
  38 typedef struct Manager Manager;
  39
  40 typedef enum ManagerState {
  41         MANAGER_INITIALIZING,
  42         MANAGER_STARTING,
  43         MANAGER_RUNNING,
  44         MANAGER_DEGRADED,
  45         MANAGER_MAINTENANCE,
  46         MANAGER_STOPPING,
  47         _MANAGER_STATE_MAX,
  48         _MANAGER_STATE_INVALID = -1
  49 } ManagerState;
  50
  51 typedef enum ManagerExitCode {
  52         MANAGER_OK,
  53         MANAGER_EXIT,
  54         MANAGER_RELOAD,
  55         MANAGER_REEXECUTE,
  56         MANAGER_REBOOT,
  57         MANAGER_POWEROFF,
  58         MANAGER_HALT,
  59         MANAGER_KEXEC,
  60         MANAGER_SWITCH_ROOT,
  61         _MANAGER_EXIT_CODE_MAX,
  62         _MANAGER_EXIT_CODE_INVALID = -1
  63 } ManagerExitCode;
  64
  65 typedef enum StatusType {
  66         STATUS_TYPE_EPHEMERAL,
  67         STATUS_TYPE_NORMAL,
  68         STATUS_TYPE_EMERGENCY,
  69 } StatusType;
  70
  71 #include "execute.h"
  72 #include "job.h"
  73 #include "path-lookup.h"
  74 #include "show-status.h"
  75 #include "unit-name.h"
  76
  77 struct Manager {
  78         /* Note that the set of units we know of is allowed to be
  79          * inconsistent. However the subset of it that is loaded may
  80          * not, and the list of jobs may neither. */
  81
  82         /* Active jobs and units */
  83         Hashmap *units;  /* name string => Unit object n:1 */
  84         Hashmap *jobs;   /* job id => Job object 1:1 */
  85
  86         /* To make it easy to iterate through the units of a specific
  87          * type we maintain a per type linked list */
  88         LIST_HEAD(Unit, units_by_type[_UNIT_TYPE_MAX]);
  89
  90         /* Units that need to be loaded */
  91         LIST_HEAD(Unit, load_queue); /* this is actually more a stack than a queue, but uh. */
  92
  93         /* Jobs that need to be run */
  94         LIST_HEAD(Job, run_queue);   /* more a stack than a queue, too */
  95
  96         /* Units and jobs that have not yet been announced via
  97          * D-Bus. When something about a job changes it is added here
  98          * if it is not in there yet. This allows easy coalescing of
  99          * D-Bus change signals. */
 100         LIST_HEAD(Unit, dbus_unit_queue);
 101         LIST_HEAD(Job, dbus_job_queue);
 102
 103         /* Units to remove */
 104         LIST_HEAD(Unit, cleanup_queue);
 105
 106         /* Units to check when doing GC */
 107         LIST_HEAD(Unit, gc_queue);
 108
 109         /* Units that should be realized */
 110         LIST_HEAD(Unit, cgroup_queue);
 111
 112         sd_event *event;
 113
 114         /* We use two hash tables here, since the same PID might be
 115          * watched by two different units: once the unit that forked
 116          * it off, and possibly a different unit to which it was
 117          * joined as cgroup member. Since we know that it is either
 118          * one or two units for each PID we just use to hashmaps
 119          * here. */
 120         Hashmap *watch_pids1;  /* pid => Unit object n:1 */
 121         Hashmap *watch_pids2;  /* pid => Unit object n:1 */
 122
 123         /* A set contains all units which cgroup should be refreshed after startup */
 124         Set *startup_units;
 125
 126         /* A set which contains all currently failed units */
 127         Set *failed_units;
 128
 129         sd_event_source *run_queue_event_source;
 130
 131         char *notify_socket;
 132         int notify_fd;
 133         sd_event_source *notify_event_source;
 134
 135         int cgroups_agent_fd;
 136         sd_event_source *cgroups_agent_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         UnitFileScope unit_file_scope;
 147         LookupPaths lookup_paths;
 148         Set *unit_path_cache;
 149
 150         char **environment;
 151
 152         usec_t runtime_watchdog;
 153         usec_t shutdown_watchdog;
 154
 155         dual_timestamp firmware_timestamp;
 156         dual_timestamp loader_timestamp;
 157         dual_timestamp kernel_timestamp;
 158         dual_timestamp initrd_timestamp;
 159         dual_timestamp userspace_timestamp;
 160         dual_timestamp finish_timestamp;
 161
 162         dual_timestamp security_start_timestamp;
 163         dual_timestamp security_finish_timestamp;
 164         dual_timestamp generators_start_timestamp;
 165         dual_timestamp generators_finish_timestamp;
 166         dual_timestamp units_load_start_timestamp;
 167         dual_timestamp units_load_finish_timestamp;
 168
 169         struct udev* udev;
 170
 171         /* Data specific to the device subsystem */
 172         struct udev_monitor* udev_monitor;
 173         sd_event_source *udev_event_source;
 174         Hashmap *devices_by_sysfs;
 175
 176         /* Data specific to the mount subsystem */
 177         struct libmnt_monitor *mount_monitor;
 178         sd_event_source *mount_event_source;
 179
 180         /* Data specific to the swap filesystem */
 181         FILE *proc_swaps;
 182         sd_event_source *swap_event_source;
 183         Hashmap *swaps_by_devnode;
 184
 185         /* Data specific to the D-Bus subsystem */
 186         sd_bus *api_bus, *system_bus;
 187         Set *private_buses;
 188         int private_listen_fd;
 189         sd_event_source *private_listen_event_source;
 190
 191         /* Contains all the clients that are subscribed to signals via
 192         the API bus. Note that private bus connections are always
 193         considered subscribes, since they last for very short only,
 194         and it is much simpler that way. */
 195         sd_bus_track *subscribed;
 196         char **deserialized_subscribed;
 197
 198         /* This is used during reloading: before the reload we queue
 199          * the reply message here, and afterwards we send it */
 200         sd_bus_message *queued_message;
 201
 202         Hashmap *watch_bus;  /* D-Bus names => Unit object n:1 */
 203
 204         bool send_reloading_done;
 205
 206         uint32_t current_job_id;
 207         uint32_t default_unit_job_id;
 208
 209         /* Data specific to the Automount subsystem */
 210         int dev_autofs_fd;
 211
 212         /* Data specific to the cgroup subsystem */
 213         Hashmap *cgroup_unit;
 214         CGroupMask cgroup_supported;
 215         char *cgroup_root;
 216
 217         /* Notifications from cgroups, when the unified hierarchy is
 218          * used is done via inotify. */
 219         int cgroup_inotify_fd;
 220         sd_event_source *cgroup_inotify_event_source;
 221         Hashmap *cgroup_inotify_wd_unit;
 222
 223         /* Make sure the user cannot accidentally unmount our cgroup
 224          * file system */
 225         int pin_cgroupfs_fd;
 226
 227         int gc_marker;
 228         unsigned n_in_gc_queue;
 229
 230         /* Flags */
 231         ManagerExitCode exit_code:5;
 232
 233         bool dispatching_load_queue:1;
 234         bool dispatching_dbus_queue:1;
 235
 236         bool taint_usr:1;
 237
 238         bool test_run:1;
 239
 240         /* If non-zero, exit with the following value when the systemd
 241          * process terminate. Useful for containers: systemd-nspawn could get
 242          * the return value. */
 243         uint8_t return_value;
 244
 245         ShowStatus show_status;
 246         bool confirm_spawn;
 247         bool no_console_output;
 248
 249         ExecOutput default_std_output, default_std_error;
 250
 251         usec_t default_restart_usec, default_timeout_start_usec, default_timeout_stop_usec;
 252
 253         usec_t default_start_limit_interval;
 254         unsigned default_start_limit_burst;
 255
 256         bool default_cpu_accounting;
 257         bool default_memory_accounting;
 258         bool default_io_accounting;
 259         bool default_blockio_accounting;
 260         bool default_tasks_accounting;
 261
 262         uint64_t default_tasks_max;
 263         usec_t default_timer_accuracy_usec;
 264
 265         struct rlimit *rlimit[_RLIMIT_MAX];
 266
 267         /* non-zero if we are reloading or reexecuting, */
 268         int n_reloading;
 269
 270         unsigned n_installed_jobs;
 271         unsigned n_failed_jobs;
 272
 273         /* Jobs in progress watching */
 274         unsigned n_running_jobs;
 275         unsigned n_on_console;
 276         unsigned jobs_in_progress_iteration;
 277
 278         /* Do we have any outstanding password prompts? */
 279         int have_ask_password;
 280         int ask_password_inotify_fd;
 281         sd_event_source *ask_password_event_source;
 282
 283         /* Type=idle pipes */
 284         int idle_pipe[4];
 285         sd_event_source *idle_pipe_event_source;
 286
 287         char *switch_root;
 288         char *switch_root_init;
 289
 290         /* This maps all possible path prefixes to the units needing
 291          * them. It's a hashmap with a path string as key and a Set as
 292          * value where Unit objects are contained. */
 293         Hashmap *units_requiring_mounts_for;
 294
 295         /* Reference to the kdbus bus control fd */
 296         int kdbus_fd;
 297
 298         /* Used for processing polkit authorization responses */
 299         Hashmap *polkit_registry;
 300
 301         /* Dynamic users/groups, indexed by their name */
 302         Hashmap *dynamic_users;
 303
 304         /* When the user hits C-A-D more than 7 times per 2s, reboot immediately... */
 305         RateLimit ctrl_alt_del_ratelimit;
 306
 307         const char *unit_log_field;
 308         const char *unit_log_format_string;
 309
 310         int first_boot; /* tri-state */
 311 };
 312
 313 #define MANAGER_IS_SYSTEM(m) ((m)->unit_file_scope == UNIT_FILE_SYSTEM)
 314 #define MANAGER_IS_USER(m) ((m)->unit_file_scope != UNIT_FILE_SYSTEM)
 315
 316 #define MANAGER_IS_RELOADING(m) ((m)->n_reloading > 0)
 317
 318 int manager_new(UnitFileScope scope, bool test_run, Manager **m);
 319 Manager* manager_free(Manager *m);
 320
 321 void manager_enumerate(Manager *m);
 322 int manager_startup(Manager *m, FILE *serialization, FDSet *fds);
 323
 324 Job *manager_get_job(Manager *m, uint32_t id);
 325 Unit *manager_get_unit(Manager *m, const char *name);
 326
 327 int manager_get_job_from_dbus_path(Manager *m, const char *s, Job **_j);
 328
 329 int manager_load_unit_prepare(Manager *m, const char *name, const char *path, sd_bus_error *e, Unit **_ret);
 330 int manager_load_unit(Manager *m, const char *name, const char *path, sd_bus_error *e, Unit **_ret);
 331 int manager_load_unit_from_dbus_path(Manager *m, const char *s, sd_bus_error *e, Unit **_u);
 332
 333 int manager_add_job(Manager *m, JobType type, Unit *unit, JobMode mode, sd_bus_error *e, Job **_ret);
 334 int manager_add_job_by_name(Manager *m, JobType type, const char *name, JobMode mode, sd_bus_error *e, Job **_ret);
 335 int manager_add_job_by_name_and_warn(Manager *m, JobType type, const char *name, JobMode mode, Job **ret);
 336
 337 void manager_dump_units(Manager *s, FILE *f, const char *prefix);
 338 void manager_dump_jobs(Manager *s, FILE *f, const char *prefix);
 339
 340 void manager_clear_jobs(Manager *m);
 341
 342 unsigned manager_dispatch_load_queue(Manager *m);
 343
 344 int manager_environment_add(Manager *m, char **minus, char **plus);
 345 int manager_set_default_rlimits(Manager *m, struct rlimit **default_rlimit);
 346
 347 int manager_loop(Manager *m);
 348
 349 int manager_open_serialization(Manager *m, FILE **_f);
 350
 351 int manager_serialize(Manager *m, FILE *f, FDSet *fds, bool switching_root);
 352 int manager_deserialize(Manager *m, FILE *f, FDSet *fds);
 353
 354 int manager_reload(Manager *m);
 355
 356 void manager_reset_failed(Manager *m);
 357
 358 void manager_send_unit_audit(Manager *m, Unit *u, int type, bool success);
 359 void manager_send_unit_plymouth(Manager *m, Unit *u);
 360
 361 bool manager_unit_inactive_or_pending(Manager *m, const char *name);
 362
 363 void manager_check_finished(Manager *m);
 364
 365 void manager_recheck_journal(Manager *m);
 366
 367 void manager_set_show_status(Manager *m, ShowStatus mode);
 368 void manager_set_first_boot(Manager *m, bool b);
 369
 370 void manager_status_printf(Manager *m, StatusType type, const char *status, const char *format, ...) _printf_(4,5);
 371 void manager_flip_auto_status(Manager *m, bool enable);
 372
 373 Set *manager_get_units_requiring_mounts_for(Manager *m, const char *path);
 374
 375 const char *manager_get_runtime_prefix(Manager *m);
 376
 377 ManagerState manager_state(Manager *m);
 378
 379 int manager_update_failed_units(Manager *m, Unit *u, bool failed);
 380
 381 const char *manager_state_to_string(ManagerState m) _const_;
 382 ManagerState manager_state_from_string(const char *s) _pure_;