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
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
|
/* upstart
*
* Copyright © 2011 Canonical Ltd.
* Author: James Hunt <james.hunt@canonical.com>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2, as
* published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
#ifndef INITCTL_H
#define INITCTL_H
/**
* IS_OP_AND:
* @token: string token to check.
*
* Return TRUE if @token is an 'AND' operator, else FALSE.
**/
#define IS_OP_AND(token) \
(! strcmp ((token), "/AND"))
/**
* IS_OP_OR:
* @token: string token to check.
*
* Return TRUE if @token is an 'OR' operator, else FALSE.
**/
#define IS_OP_OR(token) \
(! strcmp ((token), "/OR"))
/**
* IS_OPERATOR
* @token: string token to check.
*
* Return TRUE if @token is either an 'AND' or an 'OR' operator,
* else FALSE.
**/
#define IS_OPERATOR(token) \
IS_OP_AND (token) || IS_OP_OR (token)
/**
* GET_JOB_NAME:
*
* @var: char pointer variable which will be set to the name
* of a job, or NULL,
* @index: zero-based index of tokens where zero represents
* the first token after the initial token,
* @token: string to check.
*
* Determine name of job considering the specified token and its
* index. If not a job, sets @name to NULL.
*
* Handles the following cases:
*
* [start|stop] on <job_event> foo
* (index==0, job="foo" => name="foo")
*
* [start|stop] on <job_event> JOB=foo
* (index==0, job="JOB=foo" => name="foo")
*
* [start|stop] on <job_event> A=B JOB=foo
* (index==1, job="JOB=foo" => name="foo")
*
* [start|stop] on <job_event> A=B c=hello JOB=foo
* (index==2, job="JOB=foo" => name="foo")
*
* [start|stop] on <job_event> $JOB A=B c=hello
* (index==0, job="$JOB" => name="$JOB")
*
**/
#define GET_JOB_NAME(var, index, token) \
{ \
char *_##var; \
\
nih_assert (index >= 0); \
nih_assert (token); \
\
var = NULL; \
\
_##var = strstr (token, "JOB="); \
\
if (_##var && _##var == token) \
var = _##var + strlen ("JOB="); \
else if (index == 0 ) { \
if (!strstr (token, "=")) \
var = token; \
} \
}
/**
* IS_JOB_EVENT:
* @token: string to check.
*
* Return TRUE if specified token refers to a standard job event, else
* FALSE.
**/
#define IS_JOB_EVENT(token) \
(!strcmp (token, JOB_STARTING_EVENT) || \
!strcmp (token, JOB_STARTED_EVENT) || \
!strcmp (token, JOB_STOPPING_EVENT) || \
!strcmp (token, JOB_STOPPED_EVENT))
/**
* IS_INIT_EVENT:
* @token: string to check.
*
* Return TRUE if specified token refers to an event emitted internally,
* else FALSE.
*
* Note: the raw string entries below are required to accommodate
* production versus debug builds (STARTUP_EVENT changes name depending
* on build type).
**/
#define IS_INIT_EVENT(token) \
(!strcmp (token, STARTUP_EVENT) || \
!strcmp (token, "debug") || \
!strcmp (token, "startup") || \
!strcmp (token, CTRLALTDEL_EVENT) || \
!strcmp (token, KBDREQUEST_EVENT) || \
!strcmp (token, PWRSTATUS_EVENT) || \
(!strcmp (token, SESSION_END_EVENT) && user_mode) || \
IS_JOB_EVENT (token))
/**
* STACK_EMPTY:
* @stack: address of stack to check.
*
* Return TRUE if @stack is empty, else FALSE.
**/
#define STACK_EMPTY(stack) \
(NIH_LIST_EMPTY (stack))
/**
* STACK_CREATE:
* @name: nih_list variable to assign stack to.
**/
#define STACK_CREATE(name) \
name = NIH_MUST (nih_list_new (NULL))
/**
* STACK_SHOW_POP:
* @stack: Address of stack,
* @str: string representing element popped off stack.
*
* Display message to denote that @str has been popped off @stack.
* Does nothing if debug build not enabled.
*
* Note: we cannot assert that stack is not empty since a caller may
* have just removed the last entry before calling us. Thus, it is up to
* the caller to perform such checks.
*
* Does nothing if debug build not enabled.
**/
#ifdef DEBUG_STACK
#define STACK_SHOW_POP(stack, str) \
STACK_SHOW_CHANGE (stack, "popped", str)
#else
#define STACK_SHOW_POP(stack, str)
#endif
/**
* STACK_SHOW_PUSH:
* @stack: Address of stack,
* @str: string representing element pushed onto stack.
*
* Display message to denote that @str has been pushed onto @stack.
*
* Does nothing if debug build not enabled.
**/
#ifdef DEBUG_STACK
#define STACK_SHOW_PUSH(stack, str) \
STACK_SHOW_CHANGE (stack, "pushed", str) \
\
nih_assert (! STACK_EMPTY (stack))
#else
#define STACK_SHOW_PUSH(stack, str)
#endif
/**
* STACK_SHOW:
* @stack: Address of stack.
*
* Display contents of @stack.
*
* Does nothing if debug build not enabled.
**/
#ifdef DEBUG_STACK
#define STACK_SHOW(stack) \
{ \
size_t depth = 0; \
\
nih_assert (stack); \
\
NIH_LIST_FOREACH (stack, iter) { \
depth++; \
} \
\
if (STACK_EMPTY (stack)) { \
nih_message ("STACK@%p: empty", stack); \
} else { \
for (NihList *iter = (stack)->next; \
iter != (stack) && \
((NihListEntry *)iter)->str; \
iter = iter->next, depth--) { \
nih_message ("STACK@%p[%u]='%s'", \
(void *)stack, \
(unsigned int)(depth-1), \
((NihListEntry *)iter)->str); \
} \
} \
}
#else
#define STACK_SHOW(stack)
#endif
/**
* STACK_SHOW_CHANGE:
* @stack: Address of stack,
* @msg: message to show a stack change,
* @element_str: string representing element changed on @stack.
*
* Display a message showing that the stack has been changed.
*
* Does nothing if debug build not enabled.
**/
#ifdef DEBUG_STACK
#define STACK_SHOW_CHANGE(stack, msg, element_str) \
nih_assert (msg); \
nih_assert (element_str); \
\
nih_message ("STACK@%p: %s '%s'", \
(void *)stack, msg, element_str); \
\
STACK_SHOW (stack); \
\
nih_message (" "); /* spacer */
#else
#define STACK_SHOW_CHANGE(stack, msg, element_str)
#endif
/**
* STACK_PUSH:
* @stack: Address of stack,
* @elem: element of type NihListEntry to add to stack.
*
* Add @elem to @stack and display message showing how stack changed.
**/
#define STACK_PUSH(stack, elem) \
nih_list_add_after (stack, &(elem)->entry); \
\
STACK_SHOW_PUSH (stack, \
((NihListEntry *)(elem))->str); \
\
nih_assert (! STACK_EMPTY (stack))
/**
* STACK_PUSH_NEW_ELEM:
* @stack: Address of stack,
* @string: String to convert into a new NihListEntry
* stack element and push onto @stack.
*
* Create new stack element from @string and push onto @stack,
* displaying a message showing how stack changed.
**/
#define STACK_PUSH_NEW_ELEM(stack, string) \
{ \
NihListEntry *e; \
\
nih_assert (stack); \
nih_assert (string); \
\
e = NIH_MUST (nih_new (stack, NihListEntry)); \
nih_list_init (&e->entry); \
e->str = NIH_MUST (nih_strdup (e, string)); \
STACK_PUSH (stack, e); \
}
/**
* STACK_POP:
* @stack: Address of stack,
* @list: list which top stack element will be added to.
*
* Remove top element from @stack, returning to caller as @list
* and display message showing how stack changed.
*
* Note that @list is assumed to have had nih_list_new() called
* on it already.
**/
#define STACK_POP(stack, list) \
nih_assert (stack); \
nih_assert ((stack)->next); \
\
list = nih_list_add (list, (stack)->next); \
STACK_SHOW_POP (stack, \
((NihListEntry *)(list))->str)
/**
* STACK_PEEK:
* @stack: Address of stack.
*
* Return string value of top element on stack.
**/
#define STACK_PEEK(stack) \
(((NihListEntry *)(stack)->next)->str)
/**
* JobCondition:
*
* @list: list that @list lives on,
* @job_class: name of job class,
* @start_on: start on conditions,
* @stop_on: stop on conditions.
*
* Structure used to represent a job classes start on and stop on
* conditions.
*
* Note that @start_on and @stop_on are lists of NihListEntry
* objects containing string data.
*
*
**/
typedef struct condition {
NihList list;
const char *job_class;
NihList *start_on;
NihList *stop_on;
} JobCondition;
/**
* CheckConfigData:
*
* @job_class_hash: Job classes (.conf files)
* currently installed,
* @event_hash: Events that are documented
* as being emitted,
* @ignored_events_hash: Rvents we wish to ignore.
*
* Notes:
*
* Keys for @job_class_hash are job class names and values
* are of type JobCondition.
*
* Keys of @event_hash are event names and values are of type
* NihListEntry holding the event name as a string.
*
* Keys of @ignored_events_hash are event names and values are of type
* NihListEntry holding the event name as a string.
**/
typedef struct check_config_data {
NihHash *job_class_hash;
NihHash *event_hash;
NihHash *ignored_events_hash;
} CheckConfigData;
/**
* ConditionHandlerData:
*
* @condition_name: "start on" or "stop on",
* @job_class_name: name of *.conf file less the extension.
*
* Used to pass multiple values to job_class_get_start_on() /
* job_class_get_stop_on() handlers.
*
**/
typedef struct condition_handler_data {
const char *condition_name;
const char *job_class_name;
} ConditionHandlerData;
/**
* ExprNode:
*
* @node: tree which node lives in,
* @expr: string representing the expression,
* @job_in_error: if not NULL, points to the appropriate portion of
* @expr where the erroneous job is,
* @event_in_error: if not NULL, points to the appropriate portion of
* @expr where the erroneous event is,
* @value: Truth value of this node (and its children, if any).
*
* Node representing an expression.
*
* Notes:
*
* @expr can be one of:
*
* - operator:
* - IS_OP_AND()
* - IS_OP_OR()
* - operand:
* - "<event>"
* - "<event> <job>"
*
* @value can be:
*
* - 0 denoting node (and its children) are in error.
* - 1 denoting no errors in this node or its children.
* - -1 denoting an uninitialized value.
*/
typedef struct expression_node {
NihTree node;
char *expr;
const char *job_in_error;
const char *event_in_error;
int value;
} ExprNode;
/**
* MAKE_EXPR_NODE:
*
* @parent: parent object,
* @entry: pointer to ExprNode to initialize,
* @str: string expression which will be copied into @entry.
*
* Allocate storage for an ExprNode pointer and initialize.
**/
#define MAKE_EXPR_NODE(parent, entry, str) \
entry = NIH_MUST (nih_new (parent, ExprNode)); \
nih_tree_init (&(entry)->node); \
(entry)->expr = (str) \
? NIH_MUST (nih_strdup (entry, (str))) \
: NULL; \
(entry)->job_in_error = NULL; \
(entry)->event_in_error = NULL; \
(entry)->value = -1
/**
* MAKE_JOB_CONDITION:
*
* @parent: parent object,
* @entry: pointer to JobCondition to initialize,
* @str: string expression which will be copied into @entry.
*
* Allocate storage for an JobCondition pointer and initialize.
**/
#define MAKE_JOB_CONDITION(parent, entry, str) \
entry = NIH_MUST (nih_new (parent, JobCondition)); \
nih_list_init (&(entry)->list); \
(entry)->job_class = NIH_MUST (nih_strdup (entry, str)); \
(entry)->start_on = NIH_MUST (nih_list_new (entry)); \
(entry)->stop_on = NIH_MUST (nih_list_new (entry))
#endif /* INITCTL_H */
|