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         int user_lookup_fds[2];
 147         sd_event_source *user_lookup_event_source;
 148
 149         UnitFileScope unit_file_scope;
 150         LookupPaths lookup_paths;
 151         Set *unit_path_cache;
 152
 153         char **environment;
 154
 155         usec_t runtime_watchdog;
 156         usec_t shutdown_watchdog;
 157
 158         dual_timestamp firmware_timestamp;
 159         dual_timestamp loader_timestamp;
 160         dual_timestamp kernel_timestamp;
 161         dual_timestamp initrd_timestamp;
 162         dual_timestamp userspace_timestamp;
 163         dual_timestamp finish_timestamp;
 164
 165         dual_timestamp security_start_timestamp;
 166         dual_timestamp security_finish_timestamp;
 167         dual_timestamp generators_start_timestamp;
 168         dual_timestamp generators_finish_timestamp;
 169         dual_timestamp units_load_start_timestamp;
 170         dual_timestamp units_load_finish_timestamp;
 171
 172         struct udev* udev;
 173
 174         /* Data specific to the device subsystem */
 175         struct udev_monitor* udev_monitor;
 176         sd_event_source *udev_event_source;
 177         Hashmap *devices_by_sysfs;
 178
 179         /* Data specific to the mount subsystem */
 180         struct libmnt_monitor *mount_monitor;
 181         sd_event_source *mount_event_source;
 182
 183         /* Data specific to the swap filesystem */
 184         FILE *proc_swaps;
 185         sd_event_source *swap_event_source;
 186         Hashmap *swaps_by_devnode;
 187
 188         /* Data specific to the D-Bus subsystem */
 189         sd_bus *api_bus, *system_bus;
 190         Set *private_buses;
 191         int private_listen_fd;
 192         sd_event_source *private_listen_event_source;
 193
 194         /* Contains all the clients that are subscribed to signals via
 195         the API bus. Note that private bus connections are always
 196         considered subscribes, since they last for very short only,
 197         and it is much simpler that way. */
 198         sd_bus_track *subscribed;
 199         char **deserialized_subscribed;
 200
 201         /* This is used during reloading: before the reload we queue
 202          * the reply message here, and afterwards we send it */
 203         sd_bus_message *queued_message;
 204
 205         Hashmap *watch_bus;  /* D-Bus names => Unit object n:1 */
 206
 207         bool send_reloading_done;
 208
 209         uint32_t current_job_id;
 210         uint32_t default_unit_job_id;
 211
 212         /* Data specific to the Automount subsystem */
 213         int dev_autofs_fd;
 214
 215         /* Data specific to the cgroup subsystem */
 216         Hashmap *cgroup_unit;
 217         CGroupMask cgroup_supported;
 218         char *cgroup_root;
 219
 220         /* Notifications from cgroups, when the unified hierarchy is
 221          * used is done via inotify. */
 222         int cgroup_inotify_fd;
 223         sd_event_source *cgroup_inotify_event_source;
 224         Hashmap *cgroup_inotify_wd_unit;
 225
 226         /* Make sure the user cannot accidentally unmount our cgroup
 227          * file system */
 228         int pin_cgroupfs_fd;
 229
 230         int gc_marker;
 231         unsigned n_in_gc_queue;
 232
 233         /* Flags */
 234         ManagerExitCode exit_code:5;
 235
 236         bool dispatching_load_queue:1;
 237         bool dispatching_dbus_queue:1;
 238
 239         bool taint_usr:1;
 240         bool test_run:1;
 241
 242         /* If non-zero, exit with the following value when the systemd
 243          * process terminate. Useful for containers: systemd-nspawn could get
 244          * the return value. */
 245         uint8_t return_value;
 246
 247         ShowStatus show_status;
 248         bool confirm_spawn;
 249         bool no_console_output;
 250
 251         ExecOutput default_std_output, default_std_error;
 252
 253         usec_t default_restart_usec, default_timeout_start_usec, default_timeout_stop_usec;
 254
 255         usec_t default_start_limit_interval;
 256         unsigned default_start_limit_burst;
 257
 258         bool default_cpu_accounting;
 259         bool default_memory_accounting;
 260         bool default_io_accounting;
 261         bool default_blockio_accounting;
 262         bool default_tasks_accounting;
 263
 264         uint64_t default_tasks_max;
 265         usec_t default_timer_accuracy_usec;
 266
 267         struct rlimit *rlimit[_RLIMIT_MAX];
 268
 269         /* non-zero if we are reloading or reexecuting, */
 270         int n_reloading;
 271
 272         unsigned n_installed_jobs;
 273         unsigned n_failed_jobs;
 274
 275         /* Jobs in progress watching */
 276         unsigned n_running_jobs;
 277         unsigned n_on_console;
 278         unsigned jobs_in_progress_iteration;
 279
 280         /* Do we have any outstanding password prompts? */
 281         int have_ask_password;
 282         int ask_password_inotify_fd;
 283         sd_event_source *ask_password_event_source;
 284
 285         /* Type=idle pipes */
 286         int idle_pipe[4];
 287         sd_event_source *idle_pipe_event_source;
 288
 289         char *switch_root;
 290         char *switch_root_init;
 291
 292         /* This maps all possible path prefixes to the units needing
 293          * them. It's a hashmap with a path string as key and a Set as
 294          * value where Unit objects are contained. */
 295         Hashmap *units_requiring_mounts_for;
 296
 297         /* Reference to the kdbus bus control fd */
 298         int kdbus_fd;
 299
 300         /* Used for processing polkit authorization responses */
 301         Hashmap *polkit_registry;
 302
 303         /* Dynamic users/groups, indexed by their name */
 304         Hashmap *dynamic_users;
 305
 306         /* Keep track of all UIDs and GIDs any of our services currently use. This is useful for the RemoveIPC= logic. */
 307         Hashmap *uid_refs;
 308         Hashmap *gid_refs;
 309
 310         /* When the user hits C-A-D more than 7 times per 2s, reboot immediately... */
 311         RateLimit ctrl_alt_del_ratelimit;
 312
 313         const char *unit_log_field;
 314         const char *unit_log_format_string;
 315
 316         int first_boot; /* tri-state */
 317 };
 318
 319 #define MANAGER_IS_SYSTEM(m) ((m)->unit_file_scope == UNIT_FILE_SYSTEM)
 320 #define MANAGER_IS_USER(m) ((m)->unit_file_scope != UNIT_FILE_SYSTEM)
 321
 322 #define MANAGER_IS_RELOADING(m) ((m)->n_reloading > 0)
 323
 324 int manager_new(UnitFileScope scope, bool test_run, Manager **m);
 325 Manager* manager_free(Manager *m);
 326
 327 void manager_enumerate(Manager *m);
 328 int manager_startup(Manager *m, FILE *serialization, FDSet *fds);
 329
 330 Job *manager_get_job(Manager *m, uint32_t id);
 331 Unit *manager_get_unit(Manager *m, const char *name);
 332
 333 int manager_get_job_from_dbus_path(Manager *m, const char *s, Job **_j);
 334
 335 int manager_load_unit_prepare(Manager *m, const char *name, const char *path, sd_bus_error *e, Unit **_ret);
 336 int manager_load_unit(Manager *m, const char *name, const char *path, sd_bus_error *e, Unit **_ret);
 337 int manager_load_unit_from_dbus_path(Manager *m, const char *s, sd_bus_error *e, Unit **_u);
 338
 339 int manager_add_job(Manager *m, JobType type, Unit *unit, JobMode mode, sd_bus_error *e, Job **_ret);
 340 int manager_add_job_by_name(Manager *m, JobType type, const char *name, JobMode mode, sd_bus_error *e, Job **_ret);
 341 int manager_add_job_by_name_and_warn(Manager *m, JobType type, const char *name, JobMode mode, Job **ret);
 342
 343 void manager_dump_units(Manager *s, FILE *f, const char *prefix);
 344 void manager_dump_jobs(Manager *s, FILE *f, const char *prefix);
 345
 346 void manager_clear_jobs(Manager *m);
 347
 348 unsigned manager_dispatch_load_queue(Manager *m);
 349
 350 int manager_environment_add(Manager *m, char **minus, char **plus);
 351 int manager_set_default_rlimits(Manager *m, struct rlimit **default_rlimit);
 352
 353 int manager_loop(Manager *m);
 354
 355 int manager_open_serialization(Manager *m, FILE **_f);
 356
 357 int manager_serialize(Manager *m, FILE *f, FDSet *fds, bool switching_root);
 358 int manager_deserialize(Manager *m, FILE *f, FDSet *fds);
 359
 360 int manager_reload(Manager *m);
 361
 362 void manager_reset_failed(Manager *m);
 363
 364 void manager_send_unit_audit(Manager *m, Unit *u, int type, bool success);
 365 void manager_send_unit_plymouth(Manager *m, Unit *u);
 366
 367 bool manager_unit_inactive_or_pending(Manager *m, const char *name);
 368
 369 void manager_check_finished(Manager *m);
 370
 371 void manager_recheck_journal(Manager *m);
 372
 373 void manager_set_show_status(Manager *m, ShowStatus mode);
 374 void manager_set_first_boot(Manager *m, bool b);
 375
 376 void manager_status_printf(Manager *m, StatusType type, const char *status, const char *format, ...) _printf_(4,5);
 377 void manager_flip_auto_status(Manager *m, bool enable);
 378
 379 Set *manager_get_units_requiring_mounts_for(Manager *m, const char *path);
 380
 381 const char *manager_get_runtime_prefix(Manager *m);
 382
 383 ManagerState manager_state(Manager *m);
 384
 385 int manager_update_failed_units(Manager *m, Unit *u, bool failed);
 386
 387 void manager_unref_uid(Manager *m, uid_t uid, bool destroy_now);
 388 int manager_ref_uid(Manager *m, uid_t uid, bool clean_ipc);
 389
 390 void manager_unref_gid(Manager *m, gid_t gid, bool destroy_now);
 391 int manager_ref_gid(Manager *m, gid_t gid, bool destroy_now);
 392
 393 void manager_vacuum_uid_refs(Manager *m);
 394 void manager_vacuum_gid_refs(Manager *m);
 395
 396 void manager_serialize_uid_refs(Manager *m, FILE *f);
 397 void manager_deserialize_uid_refs_one(Manager *m, const char *value);
 398
 399 void manager_serialize_gid_refs(Manager *m, FILE *f);
 400 void manager_deserialize_gid_refs_one(Manager *m, const char *value);
 401
 402 const char *manager_state_to_string(ManagerState m) _const_;
 403 ManagerState manager_state_from_string(const char *s) _pure_;