[mirror_ovs.git] / lib / daemon.h

/*
 * 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);
void daemonize_complete(void);
void daemon_set_new_user(const char * user_spec);
void daemon_become_new_user(bool access_datapath);
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 */
Commit	Line	Data
064af421	1	/*
e0edde6f	2	* Copyright (c) 2008, 2009, 2010, 2011, 2012 Nicira, Inc.
064af421	3	*
a14bc59f BP	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:
064af421	7	*
a14bc59f BP	8	* http://www.apache.org/licenses/LICENSE-2.0
	9	*
	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.
064af421 BP	15	*/
	16
	17	#ifndef DAEMON_H
	18	#define DAEMON_H 1
	19
91a1e24d	20	#include <limits.h>
064af421 BP	21	#include <stdbool.h>
	22	#include <sys/types.h>
	23
fda546bd GS	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
3834bcf2	30	* in daemon-unix.c (for POSIX platforms) and daemon-windows.c (for Windows).
fda546bd GS	31
	32	* The DAEMON_OPTION_ENUMS, DAEMON_LONG_OPTIONS and DAEMON_OPTION_HANDLERS
	33	* macros are useful for parsing command-line options in individual utilities.
4ec4776c GS	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.
fda546bd GS	37	*/
	38
	39	#ifndef _WIN32
8274ae95 BP	40	#define DAEMON_OPTION_ENUMS \
8274ae95 BP	41	OPT_DETACH, \
81d2f75c	42	OPT_NO_SELF_CONFINEMENT, \
8274ae95 BP	43	OPT_NO_CHDIR, \
	44	OPT_OVERWRITE_PIDFILE, \
	45	OPT_PIDFILE, \
e91b927d AZ	46	OPT_MONITOR, \
e91b927d AZ	47	OPT_USER_GROUP
91a1e24d	48
e91b927d AZ	49	#define DAEMON_LONG_OPTIONS \
e91b927d AZ	50	{"detach", no_argument, NULL, OPT_DETACH}, \
81d2f75c	51	{"no-self-confinement", no_argument, NULL, OPT_NO_SELF_CONFINEMENT}, \
e91b927d AZ	52	{"no-chdir", no_argument, NULL, OPT_NO_CHDIR}, \
e91b927d AZ	53	{"pidfile", optional_argument, NULL, OPT_PIDFILE}, \
e3c17733	54	{"overwrite-pidfile", no_argument, NULL, OPT_OVERWRITE_PIDFILE}, \
e91b927d AZ	55	{"monitor", no_argument, NULL, OPT_MONITOR}, \
e91b927d AZ	56	{"user", required_argument, NULL, OPT_USER_GROUP}
064af421 BP	57
064af421 BP	58	#define DAEMON_OPTION_HANDLERS \
e7bd7d78	59	case OPT_DETACH: \
064af421 BP	60	set_detach(); \
	61	break; \
	62	\
81d2f75c AA	63	case OPT_NO_SELF_CONFINEMENT: \
	64	daemon_disable_self_confinement(); \
	65	break; \
	66	\
91a1e24d JP	67	case OPT_NO_CHDIR: \
	68	set_no_chdir(); \
	69	break; \
	70	\
e7bd7d78	71	case OPT_PIDFILE: \
064af421 BP	72	set_pidfile(optarg); \
	73	break; \
	74	\
e7bd7d78	75	case OPT_OVERWRITE_PIDFILE: \
064af421	76	ignore_existing_pidfile(); \
ff8decf1 BP	77	break; \
	78	\
	79	case OPT_MONITOR: \
	80	daemon_set_monitor(); \
e91b927d AZ	81	break; \
	82	\
	83	case OPT_USER_GROUP: \
	84	daemon_set_new_user(optarg); \
064af421 BP	85	break;
064af421 BP	86
7e5f6b1e BP	87	#define DAEMON_OPTION_CASES \
	88	case OPT_DETACH: \
	89	case OPT_NO_SELF_CONFINEMENT: \
	90	case OPT_NO_CHDIR: \
	91	case OPT_PIDFILE: \
	92	case OPT_OVERWRITE_PIDFILE: \
	93	case OPT_MONITOR: \
	94	case OPT_USER_GROUP:
	95
fda546bd GS	96	void set_detach(void);
fda546bd GS	97	void daemon_set_monitor(void);
91a1e24d	98	void set_no_chdir(void);
fda546bd GS	99	void ignore_existing_pidfile(void);
	100	pid_t read_pidfile(const char *name);
	101	#else
4ec4776c GS	102	#define DAEMON_OPTION_ENUMS \
4ec4776c GS	103	OPT_DETACH, \
81d2f75c	104	OPT_NO_SELF_CONFINEMENT, \
fd9164cd	105	OPT_NO_CHDIR, \
a9e9db79	106	OPT_PIDFILE, \
4ec4776c GS	107	OPT_PIPE_HANDLE, \
4ec4776c GS	108	OPT_SERVICE, \
f9280ca7 GS	109	OPT_SERVICE_MONITOR, \
f9280ca7 GS	110	OPT_USER_GROUP
fda546bd	111
4ec4776c GS	112	#define DAEMON_LONG_OPTIONS \
4ec4776c GS	113	{"detach", no_argument, NULL, OPT_DETACH}, \
117ec423	114	{"no-self-confinement", no_argument, NULL, OPT_NO_SELF_CONFINEMENT}, \
fd9164cd	115	{"no-chdir", no_argument, NULL, OPT_NO_CHDIR}, \
a9e9db79	116	{"pidfile", optional_argument, NULL, OPT_PIDFILE}, \
4ec4776c GS	117	{"pipe-handle", required_argument, NULL, OPT_PIPE_HANDLE}, \
4ec4776c GS	118	{"service", no_argument, NULL, OPT_SERVICE}, \
f9280ca7	119	{"service-monitor", no_argument, NULL, OPT_SERVICE_MONITOR}, \
e91b927d	120	{"user", required_argument, NULL, OPT_USER_GROUP}
fda546bd GS	121
fda546bd GS	122	#define DAEMON_OPTION_HANDLERS \
4ec4776c	123	case OPT_DETACH: \
2ef3f753	124	set_detach(); \
4ec4776c GS	125	break; \
4ec4776c GS	126	\
81d2f75c AA	127	case OPT_NO_SELF_CONFINEMENT: \
	128	daemon_disable_self_confinement(); \
	129	break; \
	130	\
fd9164cd GS	131	case OPT_NO_CHDIR: \
	132	break; \
	133	\
a9e9db79 GS	134	case OPT_PIDFILE: \
	135	set_pidfile(optarg); \
	136	break; \
	137	\
4ec4776c GS	138	case OPT_PIPE_HANDLE: \
	139	set_pipe_handle(optarg); \
	140	break; \
	141	\
fda546bd	142	case OPT_SERVICE: \
2ef3f753	143	set_detach(); \
fda546bd GS	144	break; \
	145	\
	146	case OPT_SERVICE_MONITOR: \
e91b927d AZ	147	break; \
	148	\
	149	case OPT_USER_GROUP: \
f9280ca7	150	daemon_set_new_user(optarg);
fda546bd	151
7e5f6b1e BP	152	#define DAEMON_OPTION_CASES \
	153	case OPT_DETACH: \
	154	case OPT_NO_SELF_CONFINEMENT: \
	155	case OPT_NO_CHDIR: \
	156	case OPT_PIDFILE: \
	157	case OPT_PIPE_HANDLE: \
	158	case OPT_SERVICE: \
	159	case OPT_SERVICE_MONITOR: \
	160	case OPT_USER_GROUP:
	161
fda546bd	162	void control_handler(DWORD request);
4ec4776c	163	void set_pipe_handle(const char *pipe_handle);
2ef3f753	164	void set_detach(void);
fda546bd GS	165	#endif /* _WIN32 */
fda546bd GS	166
eb077b26	167	bool get_detach(void);
7d0c5973	168	void daemon_save_fd(int fd);
064af421	169	void daemonize(void);
e91b927d	170	void daemonize_start(bool access_datapath);
95440284	171	void daemonize_complete(void);
e91b927d AZ	172	void daemon_set_new_user(const char * user_spec);
e91b927d AZ	173	void daemon_become_new_user(bool access_datapath);
064af421	174	void daemon_usage(void);
81d2f75c AA	175	void daemon_disable_self_confinement(void);
81d2f75c AA	176	bool daemon_should_self_confine(void);
fda546bd GS	177	void service_start(int argcp, char *argvp[]);
	178	void service_stop(void);
	179	bool should_service_stop(void);
a9e9db79	180	void set_pidfile(const char *name);
d6bc33f3	181	void close_standard_fds(void);
8aee05cc	182
064af421	183	#endif /* daemon.h */