1 /*-*- Mode: C; c-basic-offset: 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;
22 #include "socket-util.h"
27 #define DEFAULT_TIMEOUT_USEC (20*USEC_PER_SEC)
28 #define DEFAULT_RESTART_USEC (100*USEC_PER_MSEC)
40 _NAME_TYPE_INVALID = -1,
50 enum NameActiveState {
52 NAME_ACTIVE_RELOADING,
56 _NAME_ACTIVE_STATE_MAX
59 static inline bool NAME_IS_ACTIVE_OR_RELOADING(NameActiveState t) {
60 return t == NAME_ACTIVE || t == NAME_ACTIVE_RELOADING;
63 static inline bool NAME_IS_ACTIVE_OR_ACTIVATING(NameActiveState t) {
64 return t == NAME_ACTIVE || t == NAME_ACTIVATING || t == NAME_ACTIVE_RELOADING;
67 static inline bool NAME_IS_INACTIVE_OR_DEACTIVATING(NameActiveState t) {
68 return t == NAME_INACTIVE || t == NAME_DEACTIVATING;
72 /* Positive dependencies */
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' */
82 /* Negative dependencies */
83 NAME_CONFLICTS, /* inverse of 'conflicts' is 'conflicts' */
86 NAME_BEFORE, /* inverse of before is after and vice versa */
94 NameLoadState load_state;
96 char *id; /* One name is special because we use it for identification. Points to an entry in the names set */
99 Set *dependencies[_NAME_DEPENDENCY_MAX];
103 /* If there is something to do with this name, then this is
108 bool in_load_queue:1;
110 usec_t active_enter_timestamp;
111 usec_t active_exit_timestamp;
114 LIST_FIELDS(Meta, load_queue);
120 #include "milestone.h"
123 #include "automount.h"
124 #include "snapshot.h"
141 int (*init)(Name *n);
142 void (*done)(Name *n);
144 void (*dump)(Name *n, FILE *f, const char *prefix);
146 int (*start)(Name *n);
147 int (*stop)(Name *n);
148 int (*reload)(Name *n);
151 bool (*can_reload)(Name *n);
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);
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);
161 void (*retry)(Name *n);
164 extern const NameVTable * const name_vtable[_NAME_TYPE_MAX];
166 #define NAME_VTABLE(n) name_vtable[(n)->meta.type]
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) \
174 return (MixedCase*) name; \
177 /* For casting the various name types into a name */
178 #define NAME(o) ((Name*) (o))
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);
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)
194 NameType name_type_from_string(const char *n);
195 bool name_is_valid(const char *n);
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);
208 int name_add_name(Name *n, const char *text);
210 NameActiveState name_active_state(Name *name);
212 void name_dump(Name *n, FILE *f, const char *prefix);
214 int name_start(Name *n);
215 int name_stop(Name *n);
216 int name_reload(Name *n);
218 void name_notify(Name *n, NameActiveState os, NameActiveState ns);
220 int name_watch_fd(Name *n, int fd, uint32_t events);
221 void name_unwatch_fd(Name *n, int fd);
223 int name_watch_pid(Name *n, pid_t pid);
224 void name_unwatch_pid(Name *n, pid_t pid);
226 int name_watch_timer(Name *n, usec_t delay, int *id);
227 void name_unwatch_timer(Name *n, int *id);
229 char *name_change_suffix(const char *t, const char *suffix);
231 bool name_job_is_applicable(Name *n, JobType j);