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