name.h

   1 /*-*- Mode: C; c-basic-offset: 8 -*-*/
   2
   3 #ifndef foonamehfoo
   4 #define foonamehfoo
   5
   6 #include <stdbool.h>
   7 #include <stdlib.h>
   8
   9 typedef union Name Name;
  10 typedef struct Meta Meta;
  11 typedef struct NameVTable NameVTable;
  12 typedef enum NameType NameType;
  13 typedef enum NameLoadState NameLoadState;
  14 typedef enum NameActiveState NameActiveState;
  15 typedef enum NameDependency NameDependency;
  16
  17 #include "job.h"
  18 #include "manager.h"
  19 #include "set.h"
  20 #include "util.h"
  21 #include "list.h"
  22 #include "socket-util.h"
  23 #include "execute.h"
  24 #include "util.h"
  25
  26 #define NAME_MAX 32
  27 #define DEFAULT_TIMEOUT_USEC (20*USEC_PER_SEC)
  28 #define DEFAULT_RESTART_USEC (100*USEC_PER_MSEC)
  29
  30 enum NameType {
  31         NAME_SERVICE = 0,
  32         NAME_TIMER,
  33         NAME_SOCKET,
  34         NAME_MILESTONE,
  35         NAME_DEVICE,
  36         NAME_MOUNT,
  37         NAME_AUTOMOUNT,
  38         NAME_SNAPSHOT,
  39         _NAME_TYPE_MAX,
  40         _NAME_TYPE_INVALID = -1,
  41 };
  42
  43 enum NameLoadState {
  44         NAME_STUB,
  45         NAME_LOADED,
  46         NAME_FAILED,
  47         _NAME_LOAD_STATE_MAX
  48 };
  49
  50 enum NameActiveState {
  51         NAME_ACTIVE,
  52         NAME_ACTIVE_RELOADING,
  53         NAME_INACTIVE,
  54         NAME_ACTIVATING,
  55         NAME_DEACTIVATING,
  56         _NAME_ACTIVE_STATE_MAX
  57 };
  58
  59 static inline bool NAME_IS_ACTIVE_OR_RELOADING(NameActiveState t) {
  60         return t == NAME_ACTIVE || t == NAME_ACTIVE_RELOADING;
  61 }
  62
  63 static inline bool NAME_IS_ACTIVE_OR_ACTIVATING(NameActiveState t) {
  64         return t == NAME_ACTIVE || t == NAME_ACTIVATING || t == NAME_ACTIVE_RELOADING;
  65 }
  66
  67 static inline bool NAME_IS_INACTIVE_OR_DEACTIVATING(NameActiveState t) {
  68         return t == NAME_INACTIVE || t == NAME_DEACTIVATING;
  69 }
  70
  71 enum NameDependency {
  72         /* Positive dependencies */
  73         NAME_REQUIRES,
  74         NAME_SOFT_REQUIRES,
  75         NAME_WANTS,
  76         NAME_REQUISITE,
  77         NAME_SOFT_REQUISITE,
  78         NAME_REQUIRED_BY,       /* inverse of 'requires' and 'requisite' is 'required_by' */
  79         NAME_SOFT_REQUIRED_BY,  /* inverse of 'soft_requires' and 'soft_requisite' is 'soft_required_by' */
  80         NAME_WANTED_BY,         /* inverse of 'wants' */
  81
  82         /* Negative dependencies */
  83         NAME_CONFLICTS,         /* inverse of 'conflicts' is 'conflicts' */
  84
  85         /* Order */
  86         NAME_BEFORE,            /* inverse of before is after and vice versa */
  87         NAME_AFTER,
  88         _NAME_DEPENDENCY_MAX
  89 };
  90
  91 struct Meta {
  92         Manager *manager;
  93         NameType type;
  94         NameLoadState load_state;
  95
  96         char *id; /* One name is special because we use it for identification. Points to an entry in the names set */
  97
  98         Set *names;
  99         Set *dependencies[_NAME_DEPENDENCY_MAX];
 100
 101         char *description;
 102
 103         /* If there is something to do with this name, then this is
 104          * the job for it */
 105         Job *job;
 106
 107         bool linked:1;
 108         bool in_load_queue:1;
 109
 110         usec_t active_enter_timestamp;
 111         usec_t active_exit_timestamp;
 112
 113         /* Load queue */
 114         LIST_FIELDS(Meta, load_queue);
 115 };
 116
 117 #include "service.h"
 118 #include "timer.h"
 119 #include "socket.h"
 120 #include "milestone.h"
 121 #include "device.h"
 122 #include "mount.h"
 123 #include "automount.h"
 124 #include "snapshot.h"
 125
 126 union Name {
 127         Meta meta;
 128         Service service;
 129         Timer timer;
 130         Socket socket;
 131         Milestone milestone;
 132         Device device;
 133         Mount mount;
 134         Automount automount;
 135         Snapshot snapshot;
 136 };
 137
 138 struct NameVTable {
 139         const char *suffix;
 140
 141         int (*init)(Name *n);
 142         void (*done)(Name *n);
 143
 144         void (*dump)(Name *n, FILE *f, const char *prefix);
 145
 146         int (*start)(Name *n);
 147         int (*stop)(Name *n);
 148         int (*reload)(Name *n);
 149
 150
 151         bool (*can_reload)(Name *n);
 152
 153         /* Boils down the more complex internal state of this name to
 154          * a simpler one that the engine can understand */
 155         NameActiveState (*active_state)(Name *n);
 156
 157         void (*fd_event)(Name *n, int fd, uint32_t events);
 158         void (*sigchld_event)(Name *n, pid_t pid, int code, int status);
 159         void (*timer_event)(Name *n, int id, uint64_t n_elapsed);
 160
 161         void (*retry)(Name *n);
 162 };
 163
 164 extern const NameVTable * const name_vtable[_NAME_TYPE_MAX];
 165
 166 #define NAME_VTABLE(n) name_vtable[(n)->meta.type]
 167
 168 /* For casting a name into the various name types */
 169 #define DEFINE_CAST(UPPERCASE, MixedCase)                               \
 170         static inline MixedCase* UPPERCASE(Name *name) {                \
 171                 if (!name || name->meta.type != NAME_##UPPERCASE)       \
 172                         return NULL;                                    \
 173                                                                         \
 174                 return (MixedCase*) name;                               \
 175         }
 176
 177 /* For casting the various name types into a name */
 178 #define NAME(o) ((Name*) (o))
 179
 180 DEFINE_CAST(SOCKET, Socket);
 181 DEFINE_CAST(TIMER, Timer);
 182 DEFINE_CAST(SERVICE, Service);
 183 DEFINE_CAST(MILESTONE, Milestone);
 184 DEFINE_CAST(DEVICE, Device);
 185 DEFINE_CAST(MOUNT, Mount);
 186 DEFINE_CAST(AUTOMOUNT, Automount);
 187 DEFINE_CAST(SNAPSHOT, Snapshot);
 188
 189 bool name_type_can_start(NameType t);
 190 bool name_type_can_reload(NameType t);
 191 bool name_can_reload(Name *n);
 192 #define name_can_start(n) name_type_can_start((n)->meta.type)
 193
 194 NameType name_type_from_string(const char *n);
 195 bool name_is_valid(const char *n);
 196
 197 Name *name_new(Manager *m);
 198 void name_free(Name *name);
 199 int name_link(Name *name);
 200 int name_link_names(Name *name, bool replace);
 201 int name_merge(Name *name, Name *other);
 202 int name_sanitize(Name *n);
 203 int name_load_fragment_and_dropin(Name *n);
 204 int name_load(Name *name);
 205 const char* name_id(Name *n);
 206 const char *name_description(Name *n);
 207
 208 int name_add_name(Name *n, const char *text);
 209
 210 NameActiveState name_active_state(Name *name);
 211
 212 void name_dump(Name *n, FILE *f, const char *prefix);
 213
 214 int name_start(Name *n);
 215 int name_stop(Name *n);
 216 int name_reload(Name *n);
 217
 218 void name_notify(Name *n, NameActiveState os, NameActiveState ns);
 219
 220 int name_watch_fd(Name *n, int fd, uint32_t events);
 221 void name_unwatch_fd(Name *n, int fd);
 222
 223 int name_watch_pid(Name *n, pid_t pid);
 224 void name_unwatch_pid(Name *n, pid_t pid);
 225
 226 int name_watch_timer(Name *n, usec_t delay, int *id);
 227 void name_unwatch_timer(Name *n, int *id);
 228
 229 char *name_change_suffix(const char *t, const char *suffix);
 230
 231 bool name_job_is_applicable(Name *n, JobType j);
 232
 233 #endif