src/core/manager.h

   1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
   2
   3 #ifndef foomanagerhfoo
   4 #define foomanagerhfoo
   5
   6 /***
   7   This file is part of systemd.
   8
   9   Copyright 2010 Lennart Poettering
  10
  11   systemd is free software; you can redistribute it and/or modify it
  12   under the terms of the GNU Lesser General Public License as published by
  13   the Free Software Foundation; either version 2.1 of the License, or
  14   (at your option) any later version.
  15
  16   systemd is distributed in the hope that it will be useful, but
  17   WITHOUT ANY WARRANTY; without even the implied warranty of
  18   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  19   Lesser General Public License for more details.
  20
  21   You should have received a copy of the GNU Lesser General Public License
  22   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  23 ***/
  24
  25 #include <stdbool.h>
  26 #include <inttypes.h>
  27 #include <stdio.h>
  28 #include <dbus/dbus.h>
  29
  30 #include "fdset.h"
  31
  32 /* Enforce upper limit how many names we allow */
  33 #define MANAGER_MAX_NAMES 131072 /* 128K */
  34
  35 typedef struct Manager Manager;
  36 typedef struct Transaction Transaction;
  37 typedef enum WatchType WatchType;
  38 typedef struct Watch Watch;
  39
  40 typedef enum ManagerExitCode {
  41         MANAGER_RUNNING,
  42         MANAGER_EXIT,
  43         MANAGER_RELOAD,
  44         MANAGER_REEXECUTE,
  45         MANAGER_REBOOT,
  46         MANAGER_POWEROFF,
  47         MANAGER_HALT,
  48         MANAGER_KEXEC,
  49         _MANAGER_EXIT_CODE_MAX,
  50         _MANAGER_EXIT_CODE_INVALID = -1
  51 } ManagerExitCode;
  52
  53 typedef enum ManagerRunningAs {
  54         MANAGER_SYSTEM,
  55         MANAGER_USER,
  56         _MANAGER_RUNNING_AS_MAX,
  57         _MANAGER_RUNNING_AS_INVALID = -1
  58 } ManagerRunningAs;
  59
  60 enum WatchType {
  61         WATCH_INVALID,
  62         WATCH_SIGNAL,
  63         WATCH_NOTIFY,
  64         WATCH_FD,
  65         WATCH_UNIT_TIMER,
  66         WATCH_JOB_TIMER,
  67         WATCH_MOUNT,
  68         WATCH_SWAP,
  69         WATCH_UDEV,
  70         WATCH_DBUS_WATCH,
  71         WATCH_DBUS_TIMEOUT
  72 };
  73
  74 struct Watch {
  75         int fd;
  76         WatchType type;
  77         union {
  78                 struct Unit *unit;
  79                 struct Job *job;
  80                 DBusWatch *bus_watch;
  81                 DBusTimeout *bus_timeout;
  82         } data;
  83         bool fd_is_dupped:1;
  84         bool socket_accept:1;
  85 };
  86
  87 #include "unit.h"
  88 #include "job.h"
  89 #include "hashmap.h"
  90 #include "list.h"
  91 #include "set.h"
  92 #include "dbus.h"
  93 #include "path-lookup.h"
  94
  95 struct Transaction {
  96         /* Jobs to be added */
  97         Hashmap *jobs;      /* Unit object => Job object list 1:1 */
  98         JobDependency *anchor;
  99 };
 100
 101 struct Manager {
 102         /* Note that the set of units we know of is allowed to be
 103          * inconsistent. However the subset of it that is loaded may
 104          * not, and the list of jobs may neither. */
 105
 106         /* Active jobs and units */
 107         Hashmap *units;  /* name string => Unit object n:1 */
 108         Hashmap *jobs;   /* job id => Job object 1:1 */
 109
 110         /* To make it easy to iterate through the units of a specific
 111          * type we maintain a per type linked list */
 112         LIST_HEAD(Unit, units_by_type[_UNIT_TYPE_MAX]);
 113
 114         /* Units that need to be loaded */
 115         LIST_HEAD(Unit, load_queue); /* this is actually more a stack than a queue, but uh. */
 116
 117         /* Jobs that need to be run */
 118         LIST_HEAD(Job, run_queue);   /* more a stack than a queue, too */
 119
 120         /* Units and jobs that have not yet been announced via
 121          * D-Bus. When something about a job changes it is added here
 122          * if it is not in there yet. This allows easy coalescing of
 123          * D-Bus change signals. */
 124         LIST_HEAD(Unit, dbus_unit_queue);
 125         LIST_HEAD(Job, dbus_job_queue);
 126
 127         /* Units to remove */
 128         LIST_HEAD(Unit, cleanup_queue);
 129
 130         /* Units to check when doing GC */
 131         LIST_HEAD(Unit, gc_queue);
 132
 133         Hashmap *watch_pids;  /* pid => Unit object n:1 */
 134
 135         char *notify_socket;
 136
 137         Watch notify_watch;
 138         Watch signal_watch;
 139
 140         int epoll_fd;
 141
 142         unsigned n_snapshots;
 143
 144         LookupPaths lookup_paths;
 145         Set *unit_path_cache;
 146
 147         char **environment;
 148         char **default_controllers;
 149
 150         usec_t runtime_watchdog;
 151         usec_t shutdown_watchdog;
 152
 153         dual_timestamp initrd_timestamp;
 154         dual_timestamp startup_timestamp;
 155         dual_timestamp finish_timestamp;
 156
 157         char *generator_unit_path;
 158
 159         /* Data specific to the device subsystem */
 160         struct udev* udev;
 161         struct udev_monitor* udev_monitor;
 162         Watch udev_watch;
 163         Hashmap *devices_by_sysfs;
 164
 165         /* Data specific to the mount subsystem */
 166         FILE *proc_self_mountinfo;
 167         Watch mount_watch;
 168
 169         /* Data specific to the swap filesystem */
 170         FILE *proc_swaps;
 171         Hashmap *swaps_by_proc_swaps;
 172         bool request_reload;
 173         Watch swap_watch;
 174
 175         /* Data specific to the D-Bus subsystem */
 176         DBusConnection *api_bus, *system_bus;
 177         DBusServer *private_bus;
 178         Set *bus_connections, *bus_connections_for_dispatch;
 179
 180         DBusMessage *queued_message; /* This is used during reloading:
 181                                       * before the reload we queue the
 182                                       * reply message here, and
 183                                       * afterwards we send it */
 184         DBusConnection *queued_message_connection; /* The connection to send the queued message on */
 185
 186         Hashmap *watch_bus;  /* D-Bus names => Unit object n:1 */
 187         int32_t name_data_slot;
 188         int32_t conn_data_slot;
 189         int32_t subscribed_data_slot;
 190
 191         uint32_t current_job_id;
 192         uint32_t default_unit_job_id;
 193
 194         /* Data specific to the Automount subsystem */
 195         int dev_autofs_fd;
 196
 197         /* Data specific to the cgroup subsystem */
 198         Hashmap *cgroup_bondings; /* path string => CGroupBonding object 1:n */
 199         char *cgroup_hierarchy;
 200
 201         usec_t gc_queue_timestamp;
 202         int gc_marker;
 203         unsigned n_in_gc_queue;
 204
 205         /* Make sure the user cannot accidentally unmount our cgroup
 206          * file system */
 207         int pin_cgroupfs_fd;
 208
 209         /* Audit fd */
 210 #ifdef HAVE_AUDIT
 211         int audit_fd;
 212 #endif
 213
 214         /* Flags */
 215         ManagerRunningAs running_as;
 216         ManagerExitCode exit_code:5;
 217
 218         bool dispatching_load_queue:1;
 219         bool dispatching_run_queue:1;
 220         bool dispatching_dbus_queue:1;
 221
 222         bool taint_usr:1;
 223
 224         bool show_status;
 225         bool confirm_spawn;
 226 #ifdef HAVE_SYSV_COMPAT
 227         bool sysv_console;
 228 #endif
 229         bool mount_auto;
 230         bool swap_auto;
 231
 232         ExecOutput default_std_output, default_std_error;
 233
 234         /* non-zero if we are reloading or reexecuting, */
 235         int n_reloading;
 236
 237         unsigned n_installed_jobs;
 238         unsigned n_failed_jobs;
 239 };
 240
 241 int manager_new(ManagerRunningAs running_as, Manager **m);
 242 void manager_free(Manager *m);
 243
 244 int manager_enumerate(Manager *m);
 245 int manager_coldplug(Manager *m);
 246 int manager_startup(Manager *m, FILE *serialization, FDSet *fds);
 247
 248 Job *manager_get_job(Manager *m, uint32_t id);
 249 Unit *manager_get_unit(Manager *m, const char *name);
 250
 251 int manager_get_unit_from_dbus_path(Manager *m, const char *s, Unit **_u);
 252 int manager_get_job_from_dbus_path(Manager *m, const char *s, Job **_j);
 253
 254 int manager_load_unit_prepare(Manager *m, const char *name, const char *path, DBusError *e, Unit **_ret);
 255 int manager_load_unit(Manager *m, const char *name, const char *path, DBusError *e, Unit **_ret);
 256
 257 int manager_add_job(Manager *m, JobType type, Unit *unit, JobMode mode, bool force, DBusError *e, Job **_ret);
 258 int manager_add_job_by_name(Manager *m, JobType type, const char *name, JobMode mode, bool force, DBusError *e, Job **_ret);
 259
 260 void manager_dump_units(Manager *s, FILE *f, const char *prefix);
 261 void manager_dump_jobs(Manager *s, FILE *f, const char *prefix);
 262
 263 void manager_clear_jobs(Manager *m);
 264
 265 unsigned manager_dispatch_load_queue(Manager *m);
 266 unsigned manager_dispatch_run_queue(Manager *m);
 267 unsigned manager_dispatch_dbus_queue(Manager *m);
 268
 269 int manager_set_default_controllers(Manager *m, char **controllers);
 270
 271 int manager_loop(Manager *m);
 272
 273 void manager_dispatch_bus_name_owner_changed(Manager *m, const char *name, const char* old_owner, const char *new_owner);
 274 void manager_dispatch_bus_query_pid_done(Manager *m, const char *name, pid_t pid);
 275
 276 int manager_open_serialization(Manager *m, FILE **_f);
 277
 278 int manager_serialize(Manager *m, FILE *f, FDSet *fds);
 279 int manager_deserialize(Manager *m, FILE *f, FDSet *fds);
 280
 281 int manager_reload(Manager *m);
 282
 283 bool manager_is_booting_or_shutting_down(Manager *m);
 284
 285 void manager_reset_failed(Manager *m);
 286
 287 void manager_send_unit_audit(Manager *m, Unit *u, int type, bool success);
 288 void manager_send_unit_plymouth(Manager *m, Unit *u);
 289
 290 bool manager_unit_pending_inactive(Manager *m, const char *name);
 291
 292 void manager_check_finished(Manager *m);
 293
 294 void manager_run_generators(Manager *m);
 295 void manager_undo_generators(Manager *m);
 296
 297 void manager_recheck_journal(Manager *m);
 298
 299 void manager_set_show_status(Manager *m, bool b);
 300 bool manager_get_show_status(Manager *m);
 301
 302 const char *manager_running_as_to_string(ManagerRunningAs i);
 303 ManagerRunningAs manager_running_as_from_string(const char *s);
 304
 305 #endif