summaryrefslogtreecommitdiff
path: root/name.h
blob: 116523453763e2a5bdf1c7aa35fc176851c598a5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
/*-*- Mode: C; c-basic-offset: 8 -*-*/

#ifndef foonamehfoo
#define foonamehfoo

#include <stdbool.h>
#include <stdlib.h>

typedef union Name Name;
typedef struct Meta Meta;
typedef struct Service Service;
typedef struct Timer Timer;
typedef struct Socket Socket;
typedef struct Milestone Milestone;
typedef struct Device Device;
typedef struct Mount Mount;
typedef struct Automount Automount;
typedef struct Snapshot Snapshot;

#include "job.h"
#include "manager.h"
#include "set.h"
#include "util.h"
#include "list.h"

typedef enum NameType {
        NAME_SERVICE = 0,
        NAME_TIMER,
        NAME_SOCKET,
        NAME_MILESTONE,
        NAME_DEVICE,
        NAME_MOUNT,
        NAME_AUTOMOUNT,
        NAME_SNAPSHOT,
        _NAME_TYPE_MAX,
        _NAME_TYPE_INVALID = -1,
} NameType;

typedef enum NameState {
        NAME_STUB,
        NAME_LOADED,
        NAME_FAILED,
        _NAME_STATE_MAX
} NameState;

typedef enum NameDependency {
        /* Positive dependencies */
        NAME_REQUIRES,
        NAME_SOFT_REQUIRES,
        NAME_WANTS,
        NAME_REQUISITE,
        NAME_SOFT_REQUISITE,
        NAME_REQUIRED_BY,   /* inverse of 'requires' and 'requisite' is 'required_by' */
        NAME_WANTED_BY,     /* inverse of 'wants', 'soft_requires' and 'soft_requisite' is 'wanted_by' */

        /* Negative dependencies */
        NAME_CONFLICTS,     /* inverse of 'conflicts' is 'conflicts' */

        /* Order */
        NAME_BEFORE,        /* inverse of before is after and vice versa */
        NAME_AFTER,
        _NAME_DEPENDENCY_MAX
} NameDependency;

struct Meta {
        Manager *manager;
        NameType type;
        NameState state;

        Set *names;
        Set *dependencies[_NAME_DEPENDENCY_MAX];

        char *description;

        /* If there is something to do with this name, then this is
         * the job for it */
        Job *job;

        bool linked:1;

        /* Load queue */
        LIST_FIELDS(Meta);
};

typedef enum ServiceState {
        SERVICE_DEAD,
        SERVICE_BEFORE,
        SERVICE_START_PRE,
        SERVICE_START,
        SERVICE_START_POST,
        SERVICE_RUNNING,
        SERVICE_RELOAD_PRE,
        SERVICE_RELOAD,
        SERVICE_RELOAD_POST,
        SERVICE_STOP_PRE,
        SERVICE_STOP,
        SERVICE_SIGTERM,
        SERVICE_SIGKILL,
        SERVICE_STOP_POST,
        SERVICE_HOLDOFF,
        SERVICE_MAINTAINANCE
} ServiceState;

typedef enum ServiceMode {
        SERVICE_ONCE,
        SERVICE_RESTART
} ServiceMode;

struct Service {
        Meta meta;

        ServiceState state;
        ServiceMode mode;
};

typedef enum TimerState {
        TIMER_DEAD,
        TIMER_BEFORE,
        TIMER_START_PRE,
        TIMER_START,
        TIMER_START_POST,
        TIMER_WAITING,
        TIMER_RUNNING,
        TIMER_STOP_PRE,
        TIMER_STOP,
        TIMER_STOP_POST,
        TIMER_MAINTAINANCE
} TimerState;

struct Timer {
        Meta meta;

        TimerState state;
        Service *subject;

        clockid_t clock_id;
        usec_t next_elapse;
};

typedef enum SocketState {
        SOCKET_DEAD,
        SOCKET_BEFORE,
        SOCKET_START_PRE,
        SOCKET_START,
        SOCKET_START_POST,
        SOCKET_LISTENING,
        SOCKET_RUNNING,
        SOCKET_STOP_PRE,
        SOCKET_STOP,
        SOCKET_STOP_POST,
        SOCKET_MAINTAINANCE
} SocketState;

struct Socket {
        Meta meta;

        SocketState state;
        int *fds;
        unsigned n_fds;

        Service *subject;
};

typedef enum MilestoneState {
        MILESTONE_DEAD,
        MILESTONE_BEFORE,
        MILESTONE_ACTIVE
} MilestoneState;

struct Milestone {
        Meta meta;

        MilestoneState state;
};

typedef enum DeviceState {
        DEVICE_DEAD,
        DEVICE_BEFORE,
        DEVICE_AVAILABLE
} DeviceState;

struct Device {
        Meta meta;

        DeviceState state;
        char *sysfs;
};

typedef enum MountState {
        MOUNT_DEAD,
        MOUNT_BEFORE,
        MOUNT_MOUNTED
} MountState;

struct Mount {
        Meta meta;

        MountState state;
        char *path;
};

typedef enum AutomountState {
        AUTOMOUNT_DEAD,
        AUTOMOUNT_BEFORE,
        AUTOMOUNT_START_PRE,
        AUTOMOUNT_START,
        AUTOMOUNT_START_POST,
        AUTOMOUNT_WAITING,
        AUTOMOUNT_RUNNING,
        AUTOMOUNT_STOP_PRE,
        AUTOMOUNT_STOP,
        AUTOMOUNT_STOP_POST,
        AUTOMOUNT_MAINTAINANCE
} AutomountState;

struct Automount {
        Meta meta;

        AutomountState state;
        char *path;
        Mount *subject;
};

typedef enum SnapshotState {
        SNAPSHOT_DEAD,
        SNAPSHOT_BEFORE,
        SNAPSHOT_ACTIVE
} SnapshotState;

struct Snapshot {
        Meta meta;

        SnapshotState state;
        bool cleanup:1;
};

union Name {
        Meta meta;
        Service service;
        Timer timer;
        Socket socket;
        Milestone milestone;
        Device device;
        Mount mount;
        Automount automount;
        Snapshot snapshot;
};

/* For casting a name into the various name types */

#define DEFINE_CAST(UPPERCASE, MixedCase, lowercase)                    \
        static inline MixedCase* UPPERCASE(Name *name) {                \
                if (name->meta.type != NAME_##UPPERCASE)                \
                        return NULL;                                    \
                                                                        \
                return &name->lowercase;                                \
        }

DEFINE_CAST(SERVICE, Service, service);
DEFINE_CAST(TIMER, Timer, timer);
DEFINE_CAST(SOCKET, Socket, socket);
DEFINE_CAST(MILESTONE, Milestone, milestone);
DEFINE_CAST(DEVICE, Device, device);
DEFINE_CAST(MOUNT, Mount, mount);
DEFINE_CAST(AUTOMOUNT, Automount, automount);
DEFINE_CAST(SNAPSHOT, Snapshot, snapshot);

/* For casting the various name types into a name */
#define NAME(o) ((Name*) (o))

bool name_is_ready(Name *name);
NameType name_type_from_string(const char *n);
bool name_is_valid(const char *n);

Name *name_new(Manager *m);
void name_free(Name *name);
int name_link(Name *name);
int name_merge(Name *name, Name *other);
int name_augment(Name *n);
const char* name_id(Name *n);

void name_dump(Name *n, FILE *f);

#endif