src/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 General Public License as published by
  13   the Free Software Foundation; either version 2 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   General Public License for more details.
  20
  21   You should have received a copy of the GNU 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 2048
  34
  35 typedef struct Manager Manager;
  36 typedef enum WatchType WatchType;
  37 typedef struct Watch Watch;
  38
  39 typedef enum ManagerExitCode {
  40         MANAGER_RUNNING,
  41         MANAGER_EXIT,
  42         MANAGER_RELOAD,
  43         MANAGER_REEXECUTE,
  44         _MANAGER_EXIT_CODE_MAX,
  45         _MANAGER_EXIT_CODE_INVALID = -1
  46 } ManagerExitCode;
  47
  48 typedef enum ManagerRunningAs {
  49         MANAGER_SYSTEM,
  50         MANAGER_SESSION,
  51         _MANAGER_RUNNING_AS_MAX,
  52         _MANAGER_RUNNING_AS_INVALID = -1
  53 } ManagerRunningAs;
  54
  55 enum WatchType {
  56         WATCH_INVALID,
  57         WATCH_SIGNAL,
  58         WATCH_NOTIFY,
  59         WATCH_FD,
  60         WATCH_UNIT_TIMER,
  61         WATCH_JOB_TIMER,
  62         WATCH_MOUNT,
  63         WATCH_UDEV,
  64         WATCH_DBUS_WATCH,
  65         WATCH_DBUS_TIMEOUT
  66 };
  67
  68 struct Watch {
  69         int fd;
  70         WatchType type;
  71         union {
  72                 union Unit *unit;
  73                 struct Job *job;
  74                 DBusWatch *bus_watch;
  75                 DBusTimeout *bus_timeout;
  76         } data;
  77         bool fd_is_dupped:1;
  78         bool socket_accept:1;
  79 };
  80
  81 #include "unit.h"
  82 #include "job.h"
  83 #include "hashmap.h"
  84 #include "list.h"
  85 #include "set.h"
  86 #include "dbus.h"
  87 #include "path-lookup.h"
  88
  89 struct Manager {
  90         /* Note that the set of units we know of is allowed to be
  91          * incosistent. However the subset of it that is loaded may
  92          * not, and the list of jobs may neither. */
  93
  94         /* Active jobs and units */
  95         Hashmap *units;  /* name string => Unit object n:1 */
  96         Hashmap *jobs;   /* job id => Job object 1:1 */
  97
  98         /* To make it easy to iterate through the units of a specific
  99          * type we maintain a per type linked list */
 100         LIST_HEAD(Meta, units_per_type[_UNIT_TYPE_MAX]);
 101
 102         /* Units that need to be loaded */
 103         LIST_HEAD(Meta, load_queue); /* this is actually more a stack than a queue, but uh. */
 104
 105         /* Jobs that need to be run */
 106         LIST_HEAD(Job, run_queue);   /* more a stack than a queue, too */
 107
 108         /* Units and jobs that have not yet been announced via
 109          * D-Bus. When something about a job changes it is added here
 110          * if it is not in there yet. This allows easy coalescing of
 111          * D-Bus change signals. */
 112         LIST_HEAD(Meta, dbus_unit_queue);
 113         LIST_HEAD(Job, dbus_job_queue);
 114
 115         /* Units to remove */
 116         LIST_HEAD(Meta, cleanup_queue);
 117
 118         /* Units to check when doing GC */
 119         LIST_HEAD(Meta, gc_queue);
 120
 121         /* Jobs to be added */
 122         Hashmap *transaction_jobs;      /* Unit object => Job object list 1:1 */
 123         JobDependency *transaction_anchor;
 124
 125         Hashmap *watch_pids;  /* pid => Unit object n:1 */
 126
 127         char *notify_socket;
 128
 129         Watch notify_watch;
 130         Watch signal_watch;
 131
 132         int epoll_fd;
 133
 134         unsigned n_snapshots;
 135
 136         LookupPaths lookup_paths;
 137         Set *unit_path_cache;
 138
 139         char **environment;
 140
 141         dual_timestamp startup_timestamp;
 142         dual_timestamp finish_timestamp;
 143
 144         char *console;
 145
 146         /* Data specific to the device subsystem */
 147         struct udev* udev;
 148         struct udev_monitor* udev_monitor;
 149         Watch udev_watch;
 150         Hashmap *devices_by_sysfs;
 151
 152         /* Data specific to the mount subsystem */
 153         FILE *proc_self_mountinfo;
 154         Watch mount_watch;
 155
 156         /* Data specific to the swap filesystem */
 157         FILE *proc_swaps;
 158
 159         /* Data specific to the D-Bus subsystem */
 160         DBusConnection *api_bus, *system_bus;
 161         DBusServer *private_bus;
 162         Set *bus_connections, *bus_connections_for_dispatch;
 163
 164         DBusMessage *queued_message; /* This is used during reloading:
 165                                       * before the reload we queue the
 166                                       * reply message here, and
 167                                       * afterwards we send it */
 168         DBusConnection *queued_message_connection; /* The connection to send the queued message on */
 169
 170         Hashmap *watch_bus;  /* D-Bus names => Unit object n:1 */
 171         int32_t name_data_slot;
 172         int32_t subscribed_data_slot;
 173
 174         uint32_t current_job_id;
 175
 176         /* Data specific to the Automount subsystem */
 177         int dev_autofs_fd;
 178
 179         /* Data specific to the cgroup subsystem */
 180         Hashmap *cgroup_bondings; /* path string => CGroupBonding object 1:n */
 181         char *cgroup_hierarchy;
 182
 183         usec_t gc_queue_timestamp;
 184         int gc_marker;
 185         unsigned n_in_gc_queue;
 186
 187         /* Make sure the user cannot accidentaly unmount our cgroup
 188          * file system */
 189         int pin_cgroupfs_fd;
 190
 191         /* Audit fd */
 192 #ifdef HAVE_AUDIT
 193         int audit_fd;
 194 #endif
 195
 196         /* Flags */
 197         ManagerRunningAs running_as;
 198         ManagerExitCode exit_code:4;
 199
 200         bool dispatching_load_queue:1;
 201         bool dispatching_run_queue:1;
 202         bool dispatching_dbus_queue:1;
 203
 204         bool show_status;
 205         bool confirm_spawn;
 206         bool sysv_console;
 207         bool mount_auto;
 208         bool swap_auto;
 209
 210         int n_deserializing;
 211
 212         unsigned n_installed_jobs;
 213         unsigned n_failed_jobs;
 214 };
 215
 216 int manager_new(ManagerRunningAs running_as, Manager **m);
 217 void manager_free(Manager *m);
 218
 219 int manager_enumerate(Manager *m);
 220 int manager_coldplug(Manager *m);
 221 int manager_startup(Manager *m, FILE *serialization, FDSet *fds);
 222
 223 Job *manager_get_job(Manager *m, uint32_t id);
 224 Unit *manager_get_unit(Manager *m, const char *name);
 225
 226 int manager_get_unit_from_dbus_path(Manager *m, const char *s, Unit **_u);
 227 int manager_get_job_from_dbus_path(Manager *m, const char *s, Job **_j);
 228
 229 int manager_load_unit_prepare(Manager *m, const char *name, const char *path, DBusError *e, Unit **_ret);
 230 int manager_load_unit(Manager *m, const char *name, const char *path, DBusError *e, Unit **_ret);
 231
 232 int manager_add_job(Manager *m, JobType type, Unit *unit, JobMode mode, bool force, DBusError *e, Job **_ret);
 233 int manager_add_job_by_name(Manager *m, JobType type, const char *name, JobMode mode, bool force, DBusError *e, Job **_ret);
 234
 235 void manager_dump_units(Manager *s, FILE *f, const char *prefix);
 236 void manager_dump_jobs(Manager *s, FILE *f, const char *prefix);
 237
 238 void manager_transaction_unlink_job(Manager *m, Job *j, bool delete_dependencies);
 239
 240 void manager_clear_jobs(Manager *m);
 241
 242 unsigned manager_dispatch_load_queue(Manager *m);
 243 unsigned manager_dispatch_run_queue(Manager *m);
 244 unsigned manager_dispatch_dbus_queue(Manager *m);
 245
 246 int manager_set_console(Manager *m, const char *console);
 247
 248 int manager_loop(Manager *m);
 249
 250 void manager_dispatch_bus_name_owner_changed(Manager *m, const char *name, const char* old_owner, const char *new_owner);
 251 void manager_dispatch_bus_query_pid_done(Manager *m, const char *name, pid_t pid);
 252
 253 int manager_open_serialization(Manager *m, FILE **_f);
 254
 255 int manager_serialize(Manager *m, FILE *f, FDSet *fds);
 256 int manager_deserialize(Manager *m, FILE *f, FDSet *fds);
 257
 258 int manager_reload(Manager *m);
 259
 260 bool manager_is_booting_or_shutting_down(Manager *m);
 261
 262 void manager_reset_failed(Manager *m);
 263
 264 void manager_send_unit_audit(Manager *m, Unit *u, int type, bool success);
 265
 266 bool manager_unit_pending_inactive(Manager *m, const char *name);
 267
 268 void manager_check_finished(Manager *m);
 269
 270 const char *manager_running_as_to_string(ManagerRunningAs i);
 271 ManagerRunningAs manager_running_as_from_string(const char *s);
 272
 273 #endif