src/manager.h

   1 /*-*- Mode: C; c-basic-offset: 8 -*-*/
   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_INIT,      /* root and pid=1 */
  50         MANAGER_SYSTEM,    /* root and pid!=1 */
  51         MANAGER_SESSION,   /* non-root, for a session */
  52         _MANAGER_RUNNING_AS_MAX,
  53         _MANAGER_RUNNING_AS_INVALID = -1
  54 } ManagerRunningAs;
  55
  56 enum WatchType {
  57         WATCH_INVALID,
  58         WATCH_SIGNAL,
  59         WATCH_NOTIFY,
  60         WATCH_FD,
  61         WATCH_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                 DBusWatch *bus_watch;
  74                 DBusTimeout *bus_timeout;
  75         } data;
  76         bool fd_is_dupped:1;
  77         bool socket_accept:1;
  78 };
  79
  80 #include "unit.h"
  81 #include "job.h"
  82 #include "hashmap.h"
  83 #include "list.h"
  84 #include "set.h"
  85 #include "dbus.h"
  86 #include "path-lookup.h"
  87
  88 struct Manager {
  89         uint32_t current_job_id;
  90
  91         /* Note that the set of units we know of is allowed to be
  92          * incosistent. However the subset of it that is loaded may
  93          * not, and the list of jobs may neither. */
  94
  95         /* Active jobs and units */
  96         Hashmap *units;  /* name string => Unit object n:1 */
  97         Hashmap *jobs;   /* job id => Job object 1:1 */
  98
  99         /* To make it easy to iterate through the units of a specific
 100          * type we maintain a per type linked list */
 101         LIST_HEAD(Meta, units_per_type[_UNIT_TYPE_MAX]);
 102
 103         /* Units that need to be loaded */
 104         LIST_HEAD(Meta, load_queue); /* this is actually more a stack than a queue, but uh. */
 105
 106         /* Jobs that need to be run */
 107         LIST_HEAD(Job, run_queue);   /* more a stack than a queue, too */
 108
 109         /* Units and jobs that have not yet been announced via
 110          * D-Bus. When something about a job changes it is added here
 111          * if it is not in there yet. This allows easy coalescing of
 112          * D-Bus change signals. */
 113         LIST_HEAD(Meta, dbus_unit_queue);
 114         LIST_HEAD(Job, dbus_job_queue);
 115
 116         /* Units to remove */
 117         LIST_HEAD(Meta, cleanup_queue);
 118
 119         /* Units to check when doing GC */
 120         LIST_HEAD(Meta, gc_queue);
 121
 122         /* Jobs to be added */
 123         Hashmap *transaction_jobs;      /* Unit object => Job object list 1:1 */
 124         JobDependency *transaction_anchor;
 125
 126         Hashmap *watch_pids;  /* pid => Unit object n:1 */
 127
 128         char *notify_socket;
 129
 130         Watch notify_watch;
 131         Watch signal_watch;
 132
 133         int epoll_fd;
 134
 135         unsigned n_snapshots;
 136
 137         LookupPaths lookup_paths;
 138
 139         char **environment;
 140
 141         timestamp startup_timestamp;
 142
 143         /* Data specific to the device subsystem */
 144         struct udev* udev;
 145         struct udev_monitor* udev_monitor;
 146         Watch udev_watch;
 147
 148         /* Data specific to the mount subsystem */
 149         FILE *proc_self_mountinfo;
 150         Watch mount_watch;
 151
 152         /* Data specific to the swap filesystem */
 153         FILE *proc_swaps;
 154
 155         /* Data specific to the D-Bus subsystem */
 156         DBusConnection *api_bus, *system_bus;
 157         DBusServer *private_bus;
 158         Set *bus_connections, *bus_connections_for_dispatch;
 159
 160         Set *subscribed;
 161         DBusMessage *queued_message; /* This is used during reloading:
 162                                       * before the reload we queue the
 163                                       * reply message here, and
 164                                       * afterwards we send it */
 165
 166         Hashmap *watch_bus;  /* D-Bus names => Unit object n:1 */
 167         int32_t name_data_slot;
 168
 169         /* Data specific to the Automount subsystem */
 170         int dev_autofs_fd;
 171
 172         /* Data specific to the cgroup subsystem */
 173         Hashmap *cgroup_bondings; /* path string => CGroupBonding object 1:n */
 174         char *cgroup_controller;
 175         char *cgroup_mount_point;
 176         char *cgroup_hierarchy;
 177
 178         usec_t gc_queue_timestamp;
 179         int gc_marker;
 180         unsigned n_in_gc_queue;
 181
 182         /* Make sure the user cannot accidentaly unmount our cgroup
 183          * file system */
 184         int pin_cgroupfs_fd;
 185
 186         /* Flags */
 187         ManagerRunningAs running_as;
 188         ManagerExitCode exit_code:4;
 189
 190         bool dispatching_load_queue:1;
 191         bool dispatching_run_queue:1;
 192         bool dispatching_dbus_queue:1;
 193
 194         bool utmp_reboot_written:1;
 195
 196         bool confirm_spawn:1;
 197 };
 198
 199 int manager_new(ManagerRunningAs running_as, bool confirm_spawn, Manager **m);
 200 void manager_free(Manager *m);
 201
 202 int manager_enumerate(Manager *m);
 203 int manager_coldplug(Manager *m);
 204 int manager_startup(Manager *m, FILE *serialization, FDSet *fds);
 205
 206 Job *manager_get_job(Manager *m, uint32_t id);
 207 Unit *manager_get_unit(Manager *m, const char *name);
 208
 209 int manager_get_unit_from_dbus_path(Manager *m, const char *s, Unit **_u);
 210 int manager_get_job_from_dbus_path(Manager *m, const char *s, Job **_j);
 211
 212 int manager_load_unit_prepare(Manager *m, const char *name, const char *path, Unit **_ret);
 213 int manager_load_unit(Manager *m, const char *name, const char *path, Unit **_ret);
 214
 215 int manager_add_job(Manager *m, JobType type, Unit *unit, JobMode mode, bool force, Job **_ret);
 216 int manager_add_job_by_name(Manager *m, JobType type, const char *name, JobMode mode, bool force, Job **_ret);
 217
 218 void manager_dump_units(Manager *s, FILE *f, const char *prefix);
 219 void manager_dump_jobs(Manager *s, FILE *f, const char *prefix);
 220
 221 void manager_transaction_unlink_job(Manager *m, Job *j, bool delete_dependencies);
 222
 223 void manager_clear_jobs(Manager *m);
 224
 225 unsigned manager_dispatch_load_queue(Manager *m);
 226 unsigned manager_dispatch_run_queue(Manager *m);
 227 unsigned manager_dispatch_dbus_queue(Manager *m);
 228
 229 int manager_loop(Manager *m);
 230
 231 void manager_write_utmp_reboot(Manager *m);
 232 void manager_write_utmp_runlevel(Manager *m, Unit *t);
 233
 234 void manager_dispatch_bus_name_owner_changed(Manager *m, const char *name, const char* old_owner, const char *new_owner);
 235 void manager_dispatch_bus_query_pid_done(Manager *m, const char *name, pid_t pid);
 236
 237 int manager_open_serialization(FILE **_f);
 238
 239 int manager_serialize(Manager *m, FILE *f, FDSet *fds);
 240 int manager_deserialize(Manager *m, FILE *f, FDSet *fds);
 241
 242 int manager_reload(Manager *m);
 243
 244 const char *manager_running_as_to_string(ManagerRunningAs i);
 245 ManagerRunningAs manager_running_as_from_string(const char *s);
 246
 247 #endif