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
  29 #include <dbus/dbus.h>
  30
  31 typedef struct Manager Manager;
  32 typedef enum WatchType WatchType;
  33 typedef struct Watch Watch;
  34
  35 typedef enum ManagerRunningAs {
  36         MANAGER_INIT,      /* root and pid=1 */
  37         MANAGER_SYSTEM,    /* root and pid!=1 */
  38         MANAGER_SESSION,   /* non-root */
  39         _MANAGER_RUNNING_AS_MAX,
  40         _MANAGER_RUNNING_AS_INVALID = -1
  41 } ManagerRunningAs;
  42
  43 enum WatchType {
  44         WATCH_INVALID,
  45         WATCH_SIGNAL,
  46         WATCH_FD,
  47         WATCH_TIMER,
  48         WATCH_MOUNT,
  49         WATCH_UDEV,
  50         WATCH_DBUS_WATCH,
  51         WATCH_DBUS_TIMEOUT
  52 };
  53
  54 struct Watch {
  55         int fd;
  56         WatchType type;
  57         bool fd_is_dupped;
  58         union {
  59                 union Unit *unit;
  60                 DBusWatch *bus_watch;
  61                 DBusTimeout *bus_timeout;
  62         } data;
  63 };
  64
  65 #include "unit.h"
  66 #include "job.h"
  67 #include "hashmap.h"
  68 #include "list.h"
  69 #include "set.h"
  70 #include "dbus.h"
  71
  72 #define SPECIAL_DEFAULT_TARGET "default.target"
  73 #define SPECIAL_LOGGER_SOCKET "systemd-logger.socket"
  74 #define SPECIAL_KBREQUEST_TARGET "kbrequest.target"
  75 #define SPECIAL_CTRL_ALT_DEL_TARGET "ctrl-alt-del.target"
  76 #define SPECIAL_LOCAL_FS_TARGET "local-fs.target"
  77 #define SPECIAL_NETWORK_TARGET "network.target"
  78 #define SPECIAL_NSS_LOOKUP_TARGET "nss-lookup.target"     /* LSB's $named */
  79 #define SPECIAL_RPCBIND_TARGET "rpcbind.target"           /* LSB's $portmap */
  80 #define SPECIAL_REMOTE_FS_TARGET "remote-fs.target"
  81 #define SPECIAL_SYSLOG_TARGET "syslog.target"             /* Should pull in syslog.socket or syslog.service */
  82 #define SPECIAL_RTC_SET_TARGET "rtc-set.target"           /* LSB's $time */
  83 #define SPECIAL_BASIC_TARGET "basic.target"
  84 #define SPECIAL_RESCUE_TARGET "rescue.target"
  85
  86 #ifndef SPECIAL_DBUS_SERVICE
  87 #define SPECIAL_DBUS_SERVICE "dbus.service"
  88 #endif
  89
  90 #ifndef SPECIAL_SYSLOG_SERVICE
  91 #define SPECIAL_SYSLOG_SERVICE "syslog.service"
  92 #endif
  93
  94 /* For SysV compatibility. Usually an alias for a saner target. On
  95  * SysV-free systems this doesn't exist. */
  96 #define SPECIAL_RUNLEVEL0_TARGET "runlevel0.target"
  97 #define SPECIAL_RUNLEVEL1_TARGET "runlevel1.target"
  98 #define SPECIAL_RUNLEVEL2_TARGET "runlevel2.target"
  99 #define SPECIAL_RUNLEVEL3_TARGET "runlevel3.target"
 100 #define SPECIAL_RUNLEVEL4_TARGET "runlevel4.target"
 101 #define SPECIAL_RUNLEVEL5_TARGET "runlevel5.target"
 102 #define SPECIAL_RUNLEVEL6_TARGET "runlevel6.target"
 103
 104 struct Manager {
 105         /* In which mode are we running */
 106         ManagerRunningAs running_as;
 107
 108         uint32_t current_job_id;
 109
 110         /* Note that the set of units we know of is allowed to be
 111          * incosistent. However the subset of it that is loaded may
 112          * not, and the list of jobs may neither. */
 113
 114         /* Active jobs and units */
 115         Hashmap *units;  /* name string => Unit object n:1 */
 116         Hashmap *jobs;   /* job id => Job object 1:1 */
 117
 118         /* To make it easy to iterate through the units of a specific
 119          * type we maintain a per type linked list */
 120         LIST_HEAD(Meta, units_per_type[_UNIT_TYPE_MAX]);
 121
 122         /* Units that need to be loaded */
 123         LIST_HEAD(Meta, load_queue); /* this is actually more a stack than a queue, but uh. */
 124
 125         /* Jobs that need to be run */
 126         LIST_HEAD(Job, run_queue);   /* more a stack than a queue, too */
 127
 128         /* Units and jobs that have not yet been announced via
 129          * D-Bus. When something about a job changes it is added here
 130          * if it is not in there yet. This allows easy coalescing of
 131          * D-Bus change signals. */
 132         LIST_HEAD(Meta, dbus_unit_queue);
 133         LIST_HEAD(Job, dbus_job_queue);
 134
 135         LIST_HEAD(Meta, cleanup_queue);
 136
 137         /* Jobs to be added */
 138         Hashmap *transaction_jobs;      /* Unit object => Job object list 1:1 */
 139         JobDependency *transaction_anchor;
 140
 141         bool dispatching_load_queue:1;
 142         bool dispatching_run_queue:1;
 143         bool dispatching_dbus_queue:1;
 144
 145         bool request_api_bus_dispatch:1;
 146         bool request_system_bus_dispatch:1;
 147
 148         Hashmap *watch_pids;  /* pid => Unit object n:1 */
 149
 150         int epoll_fd;
 151
 152         Watch signal_watch;
 153
 154         char **unit_path;
 155         char **sysvinit_path;
 156         char **sysvrcnd_path;
 157
 158         /* Data specific to the device subsystem */
 159         struct udev* udev;
 160         struct udev_monitor* udev_monitor;
 161         Watch udev_watch;
 162
 163         /* Data specific to the mount subsystem */
 164         FILE *proc_self_mountinfo;
 165         Watch mount_watch;
 166
 167         /* Data specific to the D-Bus subsystem */
 168         DBusConnection *api_bus, *system_bus;
 169         Set *subscribed;
 170
 171         /* Data specific to the cgroup subsystem */
 172         Hashmap *cgroup_bondings; /* path string => CGroupBonding object 1:n */
 173         char *cgroup_controller;
 174         char *cgroup_hierarchy;
 175 };
 176
 177 int manager_new(ManagerRunningAs running_as, Manager **m);
 178 void manager_free(Manager *m);
 179
 180 int manager_coldplug(Manager *m);
 181
 182 Job *manager_get_job(Manager *m, uint32_t id);
 183 Unit *manager_get_unit(Manager *m, const char *name);
 184
 185 int manager_get_unit_from_dbus_path(Manager *m, const char *s, Unit **_u);
 186 int manager_get_job_from_dbus_path(Manager *m, const char *s, Job **_j);
 187
 188 int manager_load_unit(Manager *m, const char *path_or_name, Unit **_ret);
 189 int manager_add_job(Manager *m, JobType type, Unit *unit, JobMode mode, bool force, Job **_ret);
 190
 191 void manager_dump_units(Manager *s, FILE *f, const char *prefix);
 192 void manager_dump_jobs(Manager *s, FILE *f, const char *prefix);
 193
 194 void manager_transaction_unlink_job(Manager *m, Job *j, bool delete_dependencies);
 195
 196 void manager_clear_jobs(Manager *m);
 197
 198 unsigned manager_dispatch_load_queue(Manager *m);
 199 unsigned manager_dispatch_run_queue(Manager *m);
 200 unsigned manager_dispatch_dbus_queue(Manager *m);
 201
 202 int manager_loop(Manager *m);
 203
 204 const char *manager_running_as_to_string(ManagerRunningAs i);
 205 ManagerRunningAs manager_running_as_from_string(const char *s);
 206
 207 #endif