2 * Copyright (c) 2008, 2009, 2010, 2011, 2012 Nicira, Inc.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
22 #include <sys/types.h>
24 /* This file provides an interface for utilities to run in the background
25 * as daemons on POSIX platforms like Linux or as services on Windows platform.
26 * Some of the functionalities defined in this file are only applicable to
27 * POSIX platforms and some are applicable only on Windows. As such, the
28 * function definitions unique to each platform are separated out with
29 * ifdef macros. More descriptive comments on individual functions are provided
30 * in daemon-unix.c (for POSIX platforms) and daemon-windows.c (for Windows).
32 * The DAEMON_OPTION_ENUMS, DAEMON_LONG_OPTIONS and DAEMON_OPTION_HANDLERS
33 * macros are useful for parsing command-line options in individual utilities.
34 * For e.g., the command-line option "--monitor" is recognized on Linux
35 * and results in calling the daemon_set_monitor() function. The same option is
36 * not recognized on Windows platform.
40 #define DAEMON_OPTION_ENUMS \
43 OPT_OVERWRITE_PIDFILE, \
48 #define DAEMON_LONG_OPTIONS \
49 {"detach", no_argument, NULL, OPT_DETACH}, \
50 {"no-chdir", no_argument, NULL, OPT_NO_CHDIR}, \
51 {"pidfile", optional_argument, NULL, OPT_PIDFILE}, \
52 {"overwrite-pidfile", no_argument, NULL, OPT_OVERWRITE_PIDFILE}, \
53 {"monitor", no_argument, NULL, OPT_MONITOR}, \
54 {"user", required_argument, NULL, OPT_USER_GROUP}
56 #define DAEMON_OPTION_HANDLERS \
66 set_pidfile(optarg); \
69 case OPT_OVERWRITE_PIDFILE: \
70 ignore_existing_pidfile(); \
74 daemon_set_monitor(); \
77 case OPT_USER_GROUP: \
78 daemon_set_new_user(optarg); \
81 void set_detach(void);
82 void daemon_set_monitor(void);
83 void set_no_chdir(void);
84 void ignore_existing_pidfile(void);
85 pid_t read_pidfile(const char *name);
87 #define DAEMON_OPTION_ENUMS \
93 OPT_SERVICE_MONITOR, \
96 #define DAEMON_LONG_OPTIONS \
97 {"detach", no_argument, NULL, OPT_DETACH}, \
98 {"no-chdir", no_argument, NULL, OPT_NO_CHDIR}, \
99 {"pidfile", optional_argument, NULL, OPT_PIDFILE}, \
100 {"pipe-handle", required_argument, NULL, OPT_PIPE_HANDLE}, \
101 {"service", no_argument, NULL, OPT_SERVICE}, \
102 {"service-monitor", no_argument, NULL, OPT_SERVICE_MONITOR}, \
103 {"user", required_argument, NULL, OPT_USER_GROUP}
105 #define DAEMON_OPTION_HANDLERS \
113 set_pidfile(optarg); \
116 case OPT_PIPE_HANDLE: \
117 set_pipe_handle(optarg); \
123 case OPT_SERVICE_MONITOR: \
126 case OPT_USER_GROUP: \
127 daemon_set_new_user(optarg);
129 void control_handler(DWORD request);
130 void set_pipe_handle(const char *pipe_handle);
133 bool get_detach(void);
134 void daemon_save_fd(int fd);
135 void daemonize(void);
136 void daemonize_start(bool access_datapath);
137 void daemonize_complete(void);
138 void daemon_set_new_user(const char * user_spec);
139 void daemon_become_new_user(bool access_datapath);
140 void daemon_usage(void);
141 void service_start(int *argcp, char **argvp[]);
142 void service_stop(void);
143 bool should_service_stop(void);
144 void set_pidfile(const char *name);
145 void close_standard_fds(void);
147 #endif /* daemon.h */