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 *units_by_invocation_id;
  85         Hashmap *jobs;   /* job id => Job object 1:1 */
  86
  87         /* To make it easy to iterate through the units of a specific
  88          * type we maintain a per type linked list */
  89         LIST_HEAD(Unit, units_by_type[_UNIT_TYPE_MAX]);
  90
  91         /* Units that need to be loaded */
  92         LIST_HEAD(Unit, load_queue); /* this is actually more a stack than a queue, but uh. */
  93
  94         /* Jobs that need to be run */
  95         LIST_HEAD(Job, run_queue);   /* more a stack than a queue, too */
  96
  97         /* Units and jobs that have not yet been announced via
  98          * D-Bus. When something about a job changes it is added here
  99          * if it is not in there yet. This allows easy coalescing of
 100          * D-Bus change signals. */
 101         LIST_HEAD(Unit, dbus_unit_queue);
 102         LIST_HEAD(Job, dbus_job_queue);
 103
 104         /* Units to remove */
 105         LIST_HEAD(Unit, cleanup_queue);
 106
 107         /* Units to check when doing GC */
 108         LIST_HEAD(Unit, gc_queue);
 109
 110         /* Units that should be realized */
 111         LIST_HEAD(Unit, cgroup_queue);
 112
 113         sd_event *event;
 114
 115         /* We use two hash tables here, since the same PID might be
 116          * watched by two different units: once the unit that forked
 117          * it off, and possibly a different unit to which it was
 118          * joined as cgroup member. Since we know that it is either
 119          * one or two units for each PID we just use to hashmaps
 120          * here. */
 121         Hashmap *watch_pids1;  /* pid => Unit object n:1 */
 122         Hashmap *watch_pids2;  /* pid => Unit object n:1 */
 123
 124         /* A set contains all units which cgroup should be refreshed after startup */
 125         Set *startup_units;
 126
 127         /* A set which contains all currently failed units */
 128         Set *failed_units;
 129
 130         sd_event_source *run_queue_event_source;
 131
 132         char *notify_socket;
 133         int notify_fd;
 134         sd_event_source *notify_event_source;
 135
 136         int cgroups_agent_fd;
 137         sd_event_source *cgroups_agent_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         int user_lookup_fds[2];
 148         sd_event_source *user_lookup_event_source;
 149
 150         UnitFileScope unit_file_scope;
 151         LookupPaths lookup_paths;
 152         Set *unit_path_cache;
 153
 154         char **environment;
 155
 156         usec_t runtime_watchdog;
 157         usec_t shutdown_watchdog;
 158
 159         dual_timestamp firmware_timestamp;
 160         dual_timestamp loader_timestamp;
 161         dual_timestamp kernel_timestamp;
 162         dual_timestamp initrd_timestamp;
 163         dual_timestamp userspace_timestamp;
 164         dual_timestamp finish_timestamp;
 165
 166         dual_timestamp security_start_timestamp;
 167         dual_timestamp security_finish_timestamp;
 168         dual_timestamp generators_start_timestamp;
 169         dual_timestamp generators_finish_timestamp;
 170         dual_timestamp units_load_start_timestamp;
 171         dual_timestamp units_load_finish_timestamp;
 172
 173         struct udev* udev;
 174
 175         /* Data specific to the device subsystem */
 176         struct udev_monitor* udev_monitor;
 177         sd_event_source *udev_event_source;
 178         Hashmap *devices_by_sysfs;
 179
 180         /* Data specific to the mount subsystem */
 181         struct libmnt_monitor *mount_monitor;
 182         sd_event_source *mount_event_source;
 183
 184         /* Data specific to the swap filesystem */
 185         FILE *proc_swaps;
 186         sd_event_source *swap_event_source;
 187         Hashmap *swaps_by_devnode;
 188
 189         /* Data specific to the D-Bus subsystem */
 190         sd_bus *api_bus, *system_bus;
 191         Set *private_buses;
 192         int private_listen_fd;
 193         sd_event_source *private_listen_event_source;
 194
 195         /* Contains all the clients that are subscribed to signals via
 196         the API bus. Note that private bus connections are always
 197         considered subscribes, since they last for very short only,
 198         and it is much simpler that way. */
 199         sd_bus_track *subscribed;
 200         char **deserialized_subscribed;
 201
 202         /* This is used during reloading: before the reload we queue
 203          * the reply message here, and afterwards we send it */
 204         sd_bus_message *queued_message;
 205
 206         Hashmap *watch_bus;  /* D-Bus names => Unit object n:1 */
 207
 208         bool send_reloading_done;
 209
 210         uint32_t current_job_id;
 211         uint32_t default_unit_job_id;
 212
 213         /* Data specific to the Automount subsystem */
 214         int dev_autofs_fd;
 215
 216         /* Data specific to the cgroup subsystem */
 217         Hashmap *cgroup_unit;
 218         CGroupMask cgroup_supported;
 219         char *cgroup_root;
 220
 221         /* Notifications from cgroups, when the unified hierarchy is
 222          * used is done via inotify. */
 223         int cgroup_inotify_fd;
 224         sd_event_source *cgroup_inotify_event_source;
 225         Hashmap *cgroup_inotify_wd_unit;
 226
 227         /* Make sure the user cannot accidentally unmount our cgroup
 228          * file system */
 229         int pin_cgroupfs_fd;
 230
 231         int gc_marker;
 232         unsigned n_in_gc_queue;
 233
 234         /* Flags */
 235         ManagerExitCode exit_code:5;
 236
 237         bool dispatching_load_queue:1;
 238         bool dispatching_dbus_queue:1;
 239
 240         bool taint_usr:1;
 241         bool test_run:1;
 242
 243         /* If non-zero, exit with the following value when the systemd
 244          * process terminate. Useful for containers: systemd-nspawn could get
 245          * the return value. */
 246         uint8_t return_value;
 247
 248         ShowStatus show_status;
 249         bool confirm_spawn;
 250         bool no_console_output;
 251
 252         ExecOutput default_std_output, default_std_error;
 253
 254         usec_t default_restart_usec, default_timeout_start_usec, default_timeout_stop_usec;
 255
 256         usec_t default_start_limit_interval;
 257         unsigned default_start_limit_burst;
 258
 259         bool default_cpu_accounting;
 260         bool default_memory_accounting;
 261         bool default_io_accounting;
 262         bool default_blockio_accounting;
 263         bool default_tasks_accounting;
 264
 265         uint64_t default_tasks_max;
 266         usec_t default_timer_accuracy_usec;
 267
 268         struct rlimit *rlimit[_RLIMIT_MAX];
 269
 270         /* non-zero if we are reloading or reexecuting, */
 271         int n_reloading;
 272
 273         unsigned n_installed_jobs;
 274         unsigned n_failed_jobs;
 275
 276         /* Jobs in progress watching */
 277         unsigned n_running_jobs;
 278         unsigned n_on_console;
 279         unsigned jobs_in_progress_iteration;
 280
 281         /* Do we have any outstanding password prompts? */
 282         int have_ask_password;
 283         int ask_password_inotify_fd;
 284         sd_event_source *ask_password_event_source;
 285
 286         /* Type=idle pipes */
 287         int idle_pipe[4];
 288         sd_event_source *idle_pipe_event_source;
 289
 290         char *switch_root;
 291         char *switch_root_init;
 292
 293         /* This maps all possible path prefixes to the units needing
 294          * them. It's a hashmap with a path string as key and a Set as
 295          * value where Unit objects are contained. */
 296         Hashmap *units_requiring_mounts_for;
 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         /* Keep track of all UIDs and GIDs any of our services currently use. This is useful for the RemoveIPC= logic. */
 305         Hashmap *uid_refs;
 306         Hashmap *gid_refs;
 307
 308         /* When the user hits C-A-D more than 7 times per 2s, do something immediately... */
 309         RateLimit ctrl_alt_del_ratelimit;
 310         EmergencyAction cad_burst_action;
 311
 312         const char *unit_log_field;
 313         const char *unit_log_format_string;
 314
 315         const char *invocation_log_field;
 316         const char *invocation_log_format_string;
 317
 318         int first_boot; /* tri-state */
 319 };
 320
 321 #define MANAGER_IS_SYSTEM(m) ((m)->unit_file_scope == UNIT_FILE_SYSTEM)
 322 #define MANAGER_IS_USER(m) ((m)->unit_file_scope != UNIT_FILE_SYSTEM)
 323
 324 #define MANAGER_IS_RELOADING(m) ((m)->n_reloading > 0)
 325
 326 int manager_new(UnitFileScope scope, bool test_run, Manager **m);
 327 Manager* manager_free(Manager *m);
 328
 329 void manager_enumerate(Manager *m);
 330 int manager_startup(Manager *m, FILE *serialization, FDSet *fds);
 331
 332 Job *manager_get_job(Manager *m, uint32_t id);
 333 Unit *manager_get_unit(Manager *m, const char *name);
 334
 335 int manager_get_job_from_dbus_path(Manager *m, const char *s, Job **_j);
 336
 337 int manager_load_unit_prepare(Manager *m, const char *name, const char *path, sd_bus_error *e, Unit **_ret);
 338 int manager_load_unit(Manager *m, const char *name, const char *path, sd_bus_error *e, Unit **_ret);
 339 int manager_load_unit_from_dbus_path(Manager *m, const char *s, sd_bus_error *e, Unit **_u);
 340
 341 int manager_add_job(Manager *m, JobType type, Unit *unit, JobMode mode, sd_bus_error *e, Job **_ret);
 342 int manager_add_job_by_name(Manager *m, JobType type, const char *name, JobMode mode, sd_bus_error *e, Job **_ret);
 343 int manager_add_job_by_name_and_warn(Manager *m, JobType type, const char *name, JobMode mode, Job **ret);
 344
 345 void manager_dump_units(Manager *s, FILE *f, const char *prefix);
 346 void manager_dump_jobs(Manager *s, FILE *f, const char *prefix);
 347
 348 void manager_clear_jobs(Manager *m);
 349
 350 unsigned manager_dispatch_load_queue(Manager *m);
 351
 352 int manager_environment_add(Manager *m, char **minus, char **plus);
 353 int manager_set_default_rlimits(Manager *m, struct rlimit **default_rlimit);
 354
 355 int manager_loop(Manager *m);
 356
 357 int manager_open_serialization(Manager *m, FILE **_f);
 358
 359 int manager_serialize(Manager *m, FILE *f, FDSet *fds, bool switching_root);
 360 int manager_deserialize(Manager *m, FILE *f, FDSet *fds);
 361
 362 int manager_reload(Manager *m);
 363
 364 void manager_reset_failed(Manager *m);
 365
 366 void manager_send_unit_audit(Manager *m, Unit *u, int type, bool success);
 367 void manager_send_unit_plymouth(Manager *m, Unit *u);
 368
 369 bool manager_unit_inactive_or_pending(Manager *m, const char *name);
 370
 371 void manager_check_finished(Manager *m);
 372
 373 void manager_recheck_journal(Manager *m);
 374
 375 void manager_set_show_status(Manager *m, ShowStatus mode);
 376 void manager_set_first_boot(Manager *m, bool b);
 377
 378 void manager_status_printf(Manager *m, StatusType type, const char *status, const char *format, ...) _printf_(4,5);
 379 void manager_flip_auto_status(Manager *m, bool enable);
 380
 381 Set *manager_get_units_requiring_mounts_for(Manager *m, const char *path);
 382
 383 const char *manager_get_runtime_prefix(Manager *m);
 384
 385 ManagerState manager_state(Manager *m);
 386
 387 int manager_update_failed_units(Manager *m, Unit *u, bool failed);
 388
 389 void manager_unref_uid(Manager *m, uid_t uid, bool destroy_now);
 390 int manager_ref_uid(Manager *m, uid_t uid, bool clean_ipc);
 391
 392 void manager_unref_gid(Manager *m, gid_t gid, bool destroy_now);
 393 int manager_ref_gid(Manager *m, gid_t gid, bool destroy_now);
 394
 395 void manager_vacuum_uid_refs(Manager *m);
 396 void manager_vacuum_gid_refs(Manager *m);
 397
 398 void manager_serialize_uid_refs(Manager *m, FILE *f);
 399 void manager_deserialize_uid_refs_one(Manager *m, const char *value);
 400
 401 void manager_serialize_gid_refs(Manager *m, FILE *f);
 402 void manager_deserialize_gid_refs_one(Manager *m, const char *value);
 403
 404 const char *manager_state_to_string(ManagerState m) _const_;
 405 ManagerState manager_state_from_string(const char *s) _pure_;