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
|
/*
* Copyright (c) 2008, 2009, 2010, 2011, 2012 Nicira, Inc.
*
* 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 DAEMON_H
#define DAEMON_H 1
#include <limits.h>
#include <stdbool.h>
#include <sys/types.h>
/* This file provides an interface for utilities to run in the background
* as daemons on POSIX platforms like Linux or as services on Windows platform.
* Some of the functionalities defined in this file are only applicable to
* POSIX platforms and some are applicable only on Windows. As such, the
* function definitions unique to each platform are separated out with
* ifdef macros. More descriptive comments on individual functions are provided
* in daemon-unix.c (for POSIX platforms) and daemon-windows.c (for Windows).
* The DAEMON_OPTION_ENUMS, DAEMON_LONG_OPTIONS and DAEMON_OPTION_HANDLERS
* macros are useful for parsing command-line options in individual utilities.
* For e.g., the command-line option "--monitor" is recognized on Linux
* and results in calling the daemon_set_monitor() function. The same option is
* not recognized on Windows platform.
*/
#ifndef _WIN32
#define DAEMON_OPTION_ENUMS \
OPT_DETACH, \
OPT_NO_SELF_CONFINEMENT, \
OPT_NO_CHDIR, \
OPT_OVERWRITE_PIDFILE, \
OPT_PIDFILE, \
OPT_MONITOR, \
OPT_USER_GROUP
#define DAEMON_LONG_OPTIONS \
{"detach", no_argument, NULL, OPT_DETACH}, \
{"no-self-confinement", no_argument, NULL, OPT_NO_SELF_CONFINEMENT}, \
{"no-chdir", no_argument, NULL, OPT_NO_CHDIR}, \
{"pidfile", optional_argument, NULL, OPT_PIDFILE}, \
{"overwrite-pidfile", no_argument, NULL, OPT_OVERWRITE_PIDFILE}, \
{"monitor", no_argument, NULL, OPT_MONITOR}, \
{"user", required_argument, NULL, OPT_USER_GROUP}
#define DAEMON_OPTION_HANDLERS \
case OPT_DETACH: \
set_detach(); \
break; \
\
case OPT_NO_SELF_CONFINEMENT: \
daemon_disable_self_confinement(); \
break; \
\
case OPT_NO_CHDIR: \
set_no_chdir(); \
break; \
\
case OPT_PIDFILE: \
set_pidfile(optarg); \
break; \
\
case OPT_OVERWRITE_PIDFILE: \
ignore_existing_pidfile(); \
break; \
\
case OPT_MONITOR: \
daemon_set_monitor(); \
break; \
\
case OPT_USER_GROUP: \
daemon_set_new_user(optarg); \
break;
#define DAEMON_OPTION_CASES \
case OPT_DETACH: \
case OPT_NO_SELF_CONFINEMENT: \
case OPT_NO_CHDIR: \
case OPT_PIDFILE: \
case OPT_OVERWRITE_PIDFILE: \
case OPT_MONITOR: \
case OPT_USER_GROUP:
void set_detach(void);
void daemon_set_monitor(void);
void set_no_chdir(void);
void ignore_existing_pidfile(void);
pid_t read_pidfile(const char *name);
#else
#define DAEMON_OPTION_ENUMS \
OPT_DETACH, \
OPT_NO_SELF_CONFINEMENT, \
OPT_NO_CHDIR, \
OPT_PIDFILE, \
OPT_PIPE_HANDLE, \
OPT_SERVICE, \
OPT_SERVICE_MONITOR, \
OPT_USER_GROUP
#define DAEMON_LONG_OPTIONS \
{"detach", no_argument, NULL, OPT_DETACH}, \
{"no-self-confinement", no_argument, NULL, OPT_NO_SELF_CONFINEMENT}, \
{"no-chdir", no_argument, NULL, OPT_NO_CHDIR}, \
{"pidfile", optional_argument, NULL, OPT_PIDFILE}, \
{"pipe-handle", required_argument, NULL, OPT_PIPE_HANDLE}, \
{"service", no_argument, NULL, OPT_SERVICE}, \
{"service-monitor", no_argument, NULL, OPT_SERVICE_MONITOR}, \
{"user", required_argument, NULL, OPT_USER_GROUP}
#define DAEMON_OPTION_HANDLERS \
case OPT_DETACH: \
set_detach(); \
break; \
\
case OPT_NO_SELF_CONFINEMENT: \
daemon_disable_self_confinement(); \
break; \
\
case OPT_NO_CHDIR: \
break; \
\
case OPT_PIDFILE: \
set_pidfile(optarg); \
break; \
\
case OPT_PIPE_HANDLE: \
set_pipe_handle(optarg); \
break; \
\
case OPT_SERVICE: \
set_detach(); \
break; \
\
case OPT_SERVICE_MONITOR: \
break; \
\
case OPT_USER_GROUP: \
daemon_set_new_user(optarg);
#define DAEMON_OPTION_CASES \
case OPT_DETACH: \
case OPT_NO_SELF_CONFINEMENT: \
case OPT_NO_CHDIR: \
case OPT_PIDFILE: \
case OPT_PIPE_HANDLE: \
case OPT_SERVICE: \
case OPT_SERVICE_MONITOR: \
case OPT_USER_GROUP:
void control_handler(DWORD request);
void set_pipe_handle(const char *pipe_handle);
void set_detach(void);
#endif /* _WIN32 */
bool get_detach(void);
void daemon_save_fd(int fd);
void daemonize(void);
void daemonize_start(bool access_datapath, bool access_hardware_ports);
void daemonize_complete(void);
void daemon_set_new_user(const char * user_spec);
void daemon_become_new_user(bool access_datapath, bool access_hardware_ports);
void daemon_usage(void);
void daemon_disable_self_confinement(void);
bool daemon_should_self_confine(void);
void service_start(int *argcp, char **argvp[]);
void service_stop(void);
bool should_service_stop(void);
void set_pidfile(const char *name);
void close_standard_fds(void);
#endif /* daemon.h */
|
