lib/daemon.h

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011, 2012 Nicira, Inc.
   3  *
   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:
   7  *
   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.
  15  */
  16
  17 #ifndef DAEMON_H
  18 #define DAEMON_H 1
  19
  20 #include <limits.h>
  21 #include <stdbool.h>
  22 #include <sys/types.h>
  23
  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).
  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.
  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.
  37  */
  38
  39 #ifndef _WIN32
  40 #define DAEMON_OPTION_ENUMS                     \
  41     OPT_DETACH,                                 \
  42     OPT_NO_SELF_CONFINEMENT,                    \
  43     OPT_NO_CHDIR,                               \
  44     OPT_OVERWRITE_PIDFILE,                      \
  45     OPT_PIDFILE,                                \
  46     OPT_MONITOR,                                \
  47     OPT_USER_GROUP
  48
  49 #define DAEMON_LONG_OPTIONS                                              \
  50         {"detach",            no_argument, NULL, OPT_DETACH},            \
  51         {"no-self-confinement", no_argument, NULL, OPT_NO_SELF_CONFINEMENT}, \
  52         {"no-chdir",          no_argument, NULL, OPT_NO_CHDIR},          \
  53         {"pidfile",           optional_argument, NULL, OPT_PIDFILE},     \
  54         {"overwrite-pidfile", no_argument, NULL, OPT_OVERWRITE_PIDFILE}, \
  55         {"monitor",           no_argument, NULL, OPT_MONITOR},           \
  56         {"user",              required_argument, NULL, OPT_USER_GROUP}
  57
  58 #define DAEMON_OPTION_HANDLERS                  \
  59         case OPT_DETACH:                        \
  60             set_detach();                       \
  61             break;                              \
  62                                                 \
  63         case OPT_NO_SELF_CONFINEMENT:           \
  64             daemon_disable_self_confinement();  \
  65             break;                              \
  66                                                 \
  67         case OPT_NO_CHDIR:                      \
  68             set_no_chdir();                     \
  69             break;                              \
  70                                                 \
  71         case OPT_PIDFILE:                       \
  72             set_pidfile(optarg);                \
  73             break;                              \
  74                                                 \
  75         case OPT_OVERWRITE_PIDFILE:             \
  76             ignore_existing_pidfile();          \
  77             break;                              \
  78                                                 \
  79         case OPT_MONITOR:                       \
  80             daemon_set_monitor();               \
  81             break;                              \
  82                                                 \
  83         case OPT_USER_GROUP:                    \
  84             daemon_set_new_user(optarg);        \
  85             break;
  86
  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
  96 void set_detach(void);
  97 void daemon_set_monitor(void);
  98 void set_no_chdir(void);
  99 void ignore_existing_pidfile(void);
 100 pid_t read_pidfile(const char *name);
 101 #else
 102 #define DAEMON_OPTION_ENUMS                    \
 103     OPT_DETACH,                                \
 104     OPT_NO_SELF_CONFINEMENT,                   \
 105     OPT_NO_CHDIR,                              \
 106     OPT_PIDFILE,                               \
 107     OPT_PIPE_HANDLE,                           \
 108     OPT_SERVICE,                               \
 109     OPT_SERVICE_MONITOR,                       \
 110     OPT_USER_GROUP
 111
 112 #define DAEMON_LONG_OPTIONS                                               \
 113         {"detach",             no_argument, NULL, OPT_DETACH},            \
 114         {"no-self-confinement", no_argument, NULL, OPT_NO_SELF_CONFINEMENT}, \
 115         {"no-chdir",           no_argument, NULL, OPT_NO_CHDIR},          \
 116         {"pidfile",            optional_argument, NULL, OPT_PIDFILE},     \
 117         {"pipe-handle",        required_argument, NULL, OPT_PIPE_HANDLE}, \
 118         {"service",            no_argument, NULL, OPT_SERVICE},           \
 119         {"service-monitor",    no_argument, NULL, OPT_SERVICE_MONITOR},   \
 120         {"user",               required_argument, NULL, OPT_USER_GROUP}
 121
 122 #define DAEMON_OPTION_HANDLERS                  \
 123         case OPT_DETACH:                        \
 124             set_detach();                       \
 125             break;                              \
 126                                                 \
 127         case OPT_NO_SELF_CONFINEMENT:           \
 128             daemon_disable_self_confinement();  \
 129             break;                              \
 130                                                 \
 131         case OPT_NO_CHDIR:                      \
 132             break;                              \
 133                                                 \
 134         case OPT_PIDFILE:                       \
 135             set_pidfile(optarg);                \
 136             break;                              \
 137                                                 \
 138         case OPT_PIPE_HANDLE:                   \
 139             set_pipe_handle(optarg);            \
 140             break;                              \
 141                                                 \
 142         case OPT_SERVICE:                       \
 143             set_detach();                       \
 144             break;                              \
 145                                                 \
 146         case OPT_SERVICE_MONITOR:               \
 147             break;                              \
 148                                                 \
 149         case OPT_USER_GROUP:                    \
 150             daemon_set_new_user(optarg);
 151
 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
 162 void control_handler(DWORD request);
 163 void set_pipe_handle(const char *pipe_handle);
 164 void set_detach(void);
 165 #endif /* _WIN32 */
 166
 167 bool get_detach(void);
 168 void daemon_save_fd(int fd);
 169 void daemonize(void);
 170 void daemonize_start(bool access_datapath);
 171 void daemonize_complete(void);
 172 void daemon_set_new_user(const char * user_spec);
 173 void daemon_become_new_user(bool access_datapath);
 174 void daemon_usage(void);
 175 void daemon_disable_self_confinement(void);
 176 bool daemon_should_self_confine(void);
 177 void service_start(int *argcp, char **argvp[]);
 178 void service_stop(void);
 179 bool should_service_stop(void);
 180 void set_pidfile(const char *name);
 181 void close_standard_fds(void);
 182
 183 #endif /* daemon.h */