-
Notifications
You must be signed in to change notification settings - Fork 4
/
svcbatch.h
477 lines (399 loc) · 15.6 KB
/
svcbatch.h
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
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
/**
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
#ifndef _SVCBATCH_H_INCLUDED_
#define _SVCBATCH_H_INCLUDED_
#if defined(_MSC_VER)
/**
* Disable or reduce the frequency of...
* C4057: indirection to slightly different base types
* C4100: unreferenced formal parameter
* C4244: int to char/short - precision loss
* C4702: unreachable code
*/
# pragma warning(disable: 4057 4100 4244 4702)
#endif
#if defined(_MSC_VER)
# define CPP_INT64_C(_v) (_v##I64)
# define CPP_UINT64_C(_v) (_v##UI64)
# define INT64_ZERO 0I64
# define UINT64_ZERO 0UI64
#else
# define CPP_INT64_C(_v) (_v##LL)
# define CPP_UINT64_C(_v) (_v##ULL)
# define INT64_ZERO 0LL
# define UINT64_ZERO 0ULL
#endif
/**
* Helper macros for properly quoting a value as a
* string in the C preprocessor
*/
#define CPP_TOSTR_HELPER(n) #n
#define CPP_TOSTR(n) CPP_TOSTR_HELPER(n)
#define CPP_TOWCS_HELPER(n) L ## #n
#define CPP_TOWCS(n) CPP_TOWCS_HELPER(n)
#define CPP_WIDEN_HELPER(n) L ## n
#define CPP_WIDEN(n) CPP_WIDEN_HELPER(n)
/**
* Version info
*/
#define SVCBATCH_MAJOR_VERSION 3
#define SVCBATCH_MINOR_VERSION 0
#define SVCBATCH_PATCH_VERSION 1
#define SVCBATCH_MICRO_VERSION 0
#define SVCBATCH_VERSION_NUM (SVCBATCH_MAJOR_VERSION * 10000 + SVCBATCH_MINOR_VERSION * 100 + SVCBATCH_PATCH_VERSION)
/**
* Set to zero for release versions
*/
#define SVCBATCH_ISDEV_VERSION 1
#if defined(PROGRAM_NAME)
# define SVCBATCH_PROGRAM_NAME CPP_TOSTR(PROGRAM_NAME)
#else
# define SVCBATCH_PROGRAM_NAME "SvcBatch"
#endif
#if defined(PROGRAM_BASE)
# define SVCBATCH_PROGRAM_BASE CPP_TOSTR(PROGRAM_BASE)
#else
# define SVCBATCH_PROGRAM_BASE "svcbatch"
#endif
#if defined(PROGRAM_EEXT)
# define SVCBATCH_PROGRAM_EXT CPP_TOSTR(PROGRAM_EEXT)
#else
# define SVCBATCH_PROGRAM_EXT ""
#endif
#define SVCBATCH_NAME SVCBATCH_PROGRAM_NAME
#define SVCBATCH_BASENAME SVCBATCH_PROGRAM_BASE
#define SVCBATCH_APPNAME SVCBATCH_PROGRAM_NAME " Service"
#define SHUTDOWN_APPNAME SVCBATCH_PROGRAM_NAME " Shutdown"
#define SVCBATCH_LOGNAME CPP_WIDEN(SVCBATCH_PROGRAM_NAME) L".log"
#define SVCBATCH_LOGSTOP CPP_WIDEN(SVCBATCH_PROGRAM_NAME) L".stop.log"
#define SVCBATCH_LOGSDIR L"Logs"
#define SVCBATCH_MMAPPFX L"Local\\mm-"
#ifndef RC_INVOKED
/**
* Registry key where SvcBatch saves
* and reads the service parameters
*/
#define SVCBATCH_PARAMS_KEY L"Parameters"
/**
* Default options for cmd.exe
*
* /D Disable execution of AutoRun commands from registry
* /E:ON Enable command extensions
* In a batch file, the SETLOCAL ENABLEEXTENSIONS
or DISABLEEXTENSIONS arguments takes precedence
* over this switch.
*
* /V:OFF Disable delayed environment expansion.
* In a batch file the SETLOCAL ENABLEDELAYEDEXPANSION
* or DISABLEDELAYEDEXPANSION arguments takes precedence
* over this switch.
*
*/
#define SVCBATCH_DEF_OPTS L"/D /E:ON /V:OFF /C"
/**
* Maximum number of the SvcBatch.log.N files
*/
#define SVCBATCH_MAX_LOGS 9
/**
* Default number of the SvcBatch.log.N
* and SvcBatch.shutdown.log.N files
*/
#define SVCBATCH_DEF_LOGS 2
/**
* Maximum number of arguments for service and
* shutdown batch file.
*/
#define SVCBATCH_MAX_ARGS 32
/**
* Maximum length for the path and
* file names. Although the C Runtime
* supports path lengths up to 32768 characters
* in length, we set the limit to more
* realistic number.
*/
#define SVCBATCH_PATH_MAX 2048
/**
* Maximum safe path length that
* allows inserting \\?\ for long paths.
* This value must be SVCBATCH_PATH_MAX - 8
*/
#define SVCBATCH_PATH_SIZ 2040
/**
* Maximum length for the object names.
*
* Although some object names are limited
* to MAX_PATH (260 characters), we limit that
* to _MAX_FNAME (256) characters
*/
#define SVCBATCH_NAME_MAX 256
/**
* Size of the pipe read buffer in bytes.
*/
#define SVCBATCH_PIPE_LEN 8192
/**
* Maximum number of characters in one line
* written to the file or event log
*/
#define SVCBATCH_LINE_MAX 2048
/**
* Timing definitions
*/
#define SVCBATCH_START_HINT 10000
#define SVCBATCH_STOP_HINT 20000
#define SVCBATCH_STOP_WAIT 5000
#define SVCBATCH_STOP_SYNC 2000
#define SVCBATCH_STOP_STEP 1000
#define SVCBATCH_STOP_TDEF 3000
#define SVCBATCH_STOP_TMIN 2000
#define SVCBATCH_STOP_TMAX 180000
#define SVCBATCH_WAIT_TMAX 120
/**
* Default stop timeout in milliseconds
*/
#define SVCBATCH_STOP_TIMEOUT 10000
/**
* Custom SCM control code that
* will send a signal to rotate the log files
* if log rotation is enabled
*
* eg. C:\>sc control SvcBatchServiceName 234
*
* Check documentation for more details
*/
#define SVCBATCH_CTRL_ROTATE 234
/**
* Minimum rotate size in bytes
*/
#define SVCBATCH_MIN_ROTATE_SIZ 1000
/**
* Minimum time between two log
* rotations in minutes
*/
#define SVCBATCH_MIN_ROTATE_INT 2
#define SVCBATCH_MAX_ROTATE_INT 100000
#define SVCBATCH_ROTATE_READY 120000
/**
* Service manager default wait timeout
* in seconds
*/
#define SVCBATCH_SCM_WAIT_DEF 30
/**
* Maximum process tree kill depth
*/
#define SVCBATCH_MAX_KILLDEPTH 4
#define ONE_SECOND 1000
#define MS_IN_DAY 86400000
#define MS_IN_SECOND CPP_INT64_C(1000)
#define MS_IN_MINUTE CPP_INT64_C(60000)
#define MS_IN_HOUR CPP_INT64_C(3600000)
#define ONE_MINUTE CPP_INT64_C(600000000)
#define ONE_HOUR CPP_INT64_C(36000000000)
#define ONE_DAY CPP_INT64_C(864000000000)
#define KILOBYTES(_x) (CPP_INT64_C(_x) * CPP_INT64_C(1024))
#define MEGABYTES(_x) (CPP_INT64_C(_x) * CPP_INT64_C(1048576))
/** Memory alignment */
#define MEM_ALIGN(size, boundary) \
(((size) + ((boundary) - 1)) & ~((boundary) - 1))
#define MEM_ALIGN_DEFAULT(size) MEM_ALIGN(size, MEMORY_ALLOCATION_ALIGNMENT)
#define MEM_ALIGN_WORD(size) \
(((size) + 1) & 0xFFFFFFFE)
/**
* Start of the custom error messages
*/
#define SVCBATCH_START_ERROR 90000
#define SVCBATCH_EEINVAL (SVCBATCH_START_ERROR + 1)
/**
* Process state
*/
#define SVCBATCH_PROCESS_STOPPED 0x00000001 /* The process is not running */
#define SVCBATCH_PROCESS_STARTING 0x00000002 /* The process is starting */
#define SVCBATCH_PROCESS_STOPPING 0x00000003 /* The process is stopping */
#define SVCBATCH_PROCESS_RUNNING 0x00000004 /* The process is running */
/**
* Runtime options
*/
#define SVCBATCH_OPT_WRSTDIN 0x00000001 /* Write data to stdin on run */
#define SVCBATCH_OPT_LOCALTIME 0x00000002 /* Use local time */
#define SVCBATCH_OPT_QUIET 0x00000004 /* Disable logging */
#define SVCBATCH_OPT_CTRL_BREAK 0x00000008 /* Send CTRL_BREAK on stop */
#define SVCBATCH_OPT_PRESHUTDOWN 0x00000010 /* Allow service PRESHUTDOWN */
#define SVCBATCH_OPT_MASK 0x000000FF
#define SVCBATCH_OPT_TRUNCATE 0x00000100 /* Truncate log on rotation */
#define SVCBATCH_OPT_ROTATE 0x00000200 /* Enable log rotation */
#define SVCBATCH_OPT_ROTATE_BY_SIG 0x00001000 /* Rotate by signal */
#define SVCBATCH_OPT_ROTATE_BY_SIZE 0x00002000 /* Rotate by size */
#define SVCBATCH_OPT_ROTATE_BY_TIME 0x00004000 /* Rotate by time */
#define SVCBATCH_FAIL_NONE 0 /* Do not set error if run ends without stop */
#define SVCBATCH_FAIL_ERROR 1 /* Set service error if run endeded without stop */
#define SVCBATCH_FAIL_EXIT 2 /* Call exit() on stop without scm CTRL_STOP */
/**
* Helper macros
*/
#define WNUL L'\0'
#define CNUL '\0'
#define IS_INVALID_HANDLE(_h) (((_h) == NULL) || ((_h) == INVALID_HANDLE_VALUE))
#define IS_VALID_HANDLE(_h) (((_h) != NULL) && ((_h) != INVALID_HANDLE_VALUE))
#define IS_EMPTY_WCS(_s) (((_s) == NULL) || (*(_s) == WNUL))
#define IS_EMPTY_STR(_s) (((_s) == NULL) || (*(_s) == CNUL))
#define IS_VALID_WCS(_s) (((_s) != NULL) && (*(_s) != WNUL))
#define IS_OPT_SET(_o) ((svcoptions & (_o)) == (_o))
#define IS_NOT_OPT(_o) ((svcoptions & (_o)) != (_o))
#define SVCOPT_SET(_o) InterlockedOr(&svcoptions, (_o))
#define SVCOPT_CLR(_o) InterlockedAnd(&svcoptions, ~(_o))
#define DSIZEOF(_s) (DWORD)(sizeof(_s))
#define SVCBATCH_CS_INIT(_o) if (_o) InitializeCriticalSection(&((_o)->cs))
#define SVCBATCH_CS_CLOSE(_o) if (_o) DeleteCriticalSection(&((_o)->cs))
#define SVCBATCH_CS_ENTER(_o) if (_o) EnterCriticalSection(&((_o)->cs))
#define SVCBATCH_CS_LEAVE(_o) if (_o) LeaveCriticalSection(&((_o)->cs))
/**
* Assertion macros
*/
#define ASSERT_WSTR(_s, _r) \
if (((_s) == NULL) || (*(_s) == WNUL)) { \
SetLastError(ERROR_INVALID_PARAMETER); \
return (_r); \
} (void)0
#define ASSERT_CSTR(_s, _r) \
if (((_s) == NULL) || (*(_s) == CNUL)) { \
SetLastError(ERROR_INVALID_PARAMETER); \
return (_r); \
} (void)0
#define ASSERT_ZERO(_v, _r) \
if ((_v) <= 0) { \
SetLastError(ERROR_INVALID_PARAMETER); \
return (_r); \
} (void)0
#define ASSERT_SPAN(_v, _m, _x, _r) \
if (((_v) < (_m)) || ((_v) > (_x))) { \
SetLastError(ERROR_INVALID_PARAMETER); \
return (_r); \
} (void)0
#define ASSERT_NULL(_p, _r) \
if ((_p) == NULL) { \
SetLastError(ERROR_INVALID_ADDRESS); \
return (_r); \
} (void)0
#define ASSERT_SIZE(_s, _m, _r) \
if ((_s) < (_m)) { \
SetLastError(ERROR_INSUFFICIENT_BUFFER); \
return (_r); \
} (void)0
#define ASSERT_LESS(_v, _s, _r) \
if ((_v) >= (_s)) { \
SetLastError(ERROR_INSUFFICIENT_BUFFER); \
return (_r); \
} (void)0
#define ASSERT_HANDLE(_h, _r) \
if (((_h) == NULL) || ((_h) == INVALID_HANDLE_VALUE)) { \
SetLastError(ERROR_INVALID_HANDLE); \
return (_r); \
} (void)0
#define SAFE_CLOSE_HANDLE(_h) \
if (((_h) != NULL) && ((_h) != INVALID_HANDLE_VALUE)) \
CloseHandle(_h); \
(_h) = NULL
#define SAFE_MEM_FREE(_m) \
xfree(_m); \
(_m) = NULL
#define WAIT_OBJECT_1 (WAIT_OBJECT_0 + 1)
#define WAIT_OBJECT_2 (WAIT_OBJECT_0 + 2)
#define WAIT_OBJECT_3 (WAIT_OBJECT_0 + 3)
#endif /* RC_INVOKED */
#if SVCBATCH_ISDEV_VERSION
# if defined(_MSC_VER)
# define SVCBATCH_BUILD_CC " (msc " CPP_TOSTR(_MSC_FULL_VER) "." \
CPP_TOSTR(_MSC_BUILD) ")"
# elif defined(__GNUC__)
# define SVCBATCH_BUILD_CC " (gcc " CPP_TOSTR(__GNUC__) "." \
CPP_TOSTR(__GNUC_MINOR__) "." \
CPP_TOSTR(__GNUC_PATCHLEVEL__) ")"
# else
# define SVCBATCH_BUILD_CC ""
# endif
#else
# define SVCBATCH_BUILD_CC ""
#endif
#if defined(_DEBUG)
# if SVCBATCH_ISDEV_VERSION
# define SVCBATCH_VERSION_DBG "_2.dbg"
# else
# define SVCBATCH_VERSION_DBG "_1.dbg"
# endif
#else
# if SVCBATCH_ISDEV_VERSION
# define SVCBATCH_VERSION_DBG "_1.dev"
# endif
#endif
#if !defined(SVCBATCH_VERSION_DBG)
# if defined(PROGRAM_EEXT)
# define SVCBATCH_VERSION_DBG "_1"
# else
# define SVCBATCH_VERSION_DBG ""
# endif
#endif
#if defined(VERSION_SFX)
# define SVCBATCH_VERSION_SFX CPP_TOSTR(VERSION_SFX)
#else
# define SVCBATCH_VERSION_SFX SVCBATCH_VERSION_DBG SVCBATCH_PROGRAM_EXT
#endif
/**
* Macro for .rc files using numeric csv representation
*/
#define SVCBATCH_VERSION_CSV SVCBATCH_MAJOR_VERSION, \
SVCBATCH_MINOR_VERSION, \
SVCBATCH_PATCH_VERSION, \
SVCBATCH_MICRO_VERSION
#define SVCBATCH_VERSION_STR \
CPP_TOSTR(SVCBATCH_MAJOR_VERSION) "." \
CPP_TOSTR(SVCBATCH_MINOR_VERSION) "." \
CPP_TOSTR(SVCBATCH_PATCH_VERSION) "." \
CPP_TOSTR(SVCBATCH_MICRO_VERSION)
#define SVCBATCH_VERSION_WCS \
CPP_TOWCS(SVCBATCH_MAJOR_VERSION) L"." \
CPP_TOWCS(SVCBATCH_MINOR_VERSION) L"." \
CPP_TOWCS(SVCBATCH_PATCH_VERSION) L"." \
CPP_TOWCS(SVCBATCH_MICRO_VERSION)
#define SVCBATCH_VERSION_VER \
CPP_TOWCS(SVCBATCH_MAJOR_VERSION) L"." \
CPP_TOWCS(SVCBATCH_MINOR_VERSION) L"." \
CPP_TOWCS(SVCBATCH_PATCH_VERSION)
#define SVCBATCH_VERSION_REL \
SVCBATCH_VERSION_WCS \
CPP_WIDEN(SVCBATCH_VERSION_SFX)
#define SVCBATCH_VERSION_TXT \
SVCBATCH_VERSION_STR \
SVCBATCH_VERSION_SFX \
SVCBATCH_BUILD_CC
#define SVCBATCH_PROJECT_URL \
"https://github.com/mturk/svcbatch"
#define SVCBATCH_DESCRIPTION \
"Run files as Windows Services"
#define SVCBATCH_COPYRIGHT \
"Copyright (c) 1964-2024 The Acme Corporation or its " \
"licensors, as applicable."
#define SVCBATCH_COMPANY_NAME "Acme Corporation"
#define SVCBATCH_LICENSE_SHORT \
"Licensed under the Apache-2.0 License"
#define SVCBATCH_LICENSE \
"Licensed under the Apache License, Version 2.0 (the ""License"");\n" \
"you may not use this file except in compliance with the License.\n" \
"You may obtain a copy of the License at\n\n" \
"http://www.apache.org/licenses/LICENSE-2.0\n\n" \
"Unless required by applicable law or agreed to in writing, software\n" \
"distributed under the License is distributed on an ""AS IS"" BASIS,\n" \
"WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n"\
"See the License for the specific language governing permissions and\n" \
"limitations under the License."
#endif /* _SVCBATCH_H_INCLUDED_ */