2 * Copyright (c) 2014 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.
19 #include "daemon-private.h"
23 #include "ovs-thread.h"
24 #include "poll-loop.h"
25 #include "openvswitch/vlog.h"
27 VLOG_DEFINE_THIS_MODULE(daemon_windows);
29 static bool service_create; /* Was --service specified? */
30 static bool service_started; /* Have we dispatched service to start? */
32 /* --service-monitor: Should the service be restarted if it dies
36 bool detach; /* Was --detach specified? */
37 static bool detached; /* Running as the child process. */
38 static HANDLE write_handle; /* End of pipe to write to parent. */
40 char *pidfile; /* --pidfile: Name of pidfile (null if none). */
41 static FILE *filep_pidfile; /* File pointer to access the pidfile. */
43 /* Handle to the Services Manager and the created service. */
44 static SC_HANDLE manager, service;
46 /* Handle to the status information structure for the current service. */
47 static SERVICE_STATUS_HANDLE hstatus;
49 /* Hold the service's current status. */
50 static SERVICE_STATUS service_status;
52 /* Handle to an event object used to wakeup from poll_block(). */
55 /* Hold the arguments sent to the main function. */
57 static char ***sargvp;
59 static void check_service(void);
60 static void handle_scm_callback(void);
61 static void init_service_status(void);
62 static void set_config_failure_actions(void);
64 static bool detach_process(int argc, char *argv[]);
66 extern int main(int argc, char *argv[]);
72 "\nService options:\n"
73 " --service run in background as a service.\n"
74 " --service-monitor restart the service in case of an "
75 "unexpected failure. \n",
76 ovs_rundir(), program_name);
79 /* Registers the call-back and configures the actions in case of a failure
80 * with the Windows services manager. */
82 service_start(int *argcp, char **argvp[])
87 SERVICE_TABLE_ENTRY service_table[] = {
88 {(LPTSTR)program_name, (LPSERVICE_MAIN_FUNCTION)main},
92 /* If one of the command line option is "--detach", we create
93 * a new process in case of parent, wait for child to start and exit.
94 * In case of the child, we just return. We should not be creating a
95 * service in either case. */
96 if (detach_process(argc, argv)) {
100 /* 'service_started' is 'false' when service_start() is called the first
101 * time. It is 'true', when it is called the second time by the Windows
102 * services manager. */
103 if (service_started) {
104 init_service_status();
106 wevent = CreateEvent(NULL, TRUE, FALSE, NULL);
108 char *msg_buf = ovs_lasterror_to_string();
109 VLOG_FATAL("Failed to create a event (%s).", msg_buf);
112 poll_wevent_wait(wevent);
114 /* Register the control handler. This function is called by the service
115 * manager to stop the service. */
116 hstatus = RegisterServiceCtrlHandler(program_name,
117 (LPHANDLER_FUNCTION)control_handler);
119 char *msg_buf = ovs_lasterror_to_string();
120 VLOG_FATAL("Failed to register the service control handler (%s).",
125 set_config_failure_actions();
128 /* When the service control manager does the call back, it does not
129 * send the same arguments as sent to the main function during the
130 * service start. So, use the arguments passed over during the first
135 /* XXX: Windows implementation cannot have a unixctl commands in the
136 * traditional sense of unix domain sockets. If an implementation is
137 * done that involves 'unixctl' vlog commands the following call is
138 * needed to make sure that the unixctl commands for vlog get
139 * registered in a daemon, even before the first log message. */
145 assert_single_threaded();
147 /* A reference to arguments passed to the main function the first time.
148 * We need it after the call-back from service control manager. */
152 /* We are only interested in the '--service' and '--service-monitor'
153 * options before the call-back from the service control manager. */
154 for (i = 0; i < argc; i ++) {
155 if (!strcmp(argv[i], "--service")) {
156 service_create = true;
157 } else if (!strcmp(argv[i], "--service-monitor")) {
162 /* If '--service' is not a command line option, run in foreground. */
163 if (!service_create) {
167 /* If we have been configured to run as a service, then that service
168 * should already have been created either manually or through a start up
172 service_started = true;
174 /* StartServiceCtrlDispatcher blocks and returns after the service is
176 if (!StartServiceCtrlDispatcher(service_table)) {
177 char *msg_buf = ovs_lasterror_to_string();
178 VLOG_FATAL("Failed at StartServiceCtrlDispatcher (%s)", msg_buf);
183 /* This function is registered with the Windows services manager through
184 * a call to RegisterServiceCtrlHandler() and will be called by the Windows
185 * services manager asynchronously to stop the service. */
187 control_handler(DWORD request)
190 case SERVICE_CONTROL_STOP:
191 case SERVICE_CONTROL_SHUTDOWN:
192 service_status.dwCurrentState = SERVICE_STOPPED;
193 service_status.dwWin32ExitCode = NO_ERROR;
202 /* Return 'true' if the Windows services manager has called the
203 * control_handler() and asked the program to terminate. */
205 should_service_stop(void)
207 if (service_started) {
208 if (service_status.dwCurrentState != SERVICE_RUNNING) {
211 poll_wevent_wait(wevent);
217 /* Set the service as stopped. The control manager will terminate the
218 * service soon after this call. Hence, this should ideally be the last
219 * call before termination. */
223 if (!service_started) {
226 fatal_signal_atexit_handler();
231 service_status.dwCurrentState = SERVICE_STOPPED;
232 service_status.dwWin32ExitCode = NO_ERROR;
233 SetServiceStatus(hstatus, &service_status);
236 /* Call this function to signal that the daemon is ready. init_service()
237 * or control_handler() has already initalized/set the
238 * service_status.dwCurrentState .*/
240 service_complete(void)
243 SetServiceStatus(hstatus, &service_status);
247 /* Check whether 'program_name' has been created as a service. */
251 /* Establish a connection to the local service control manager. */
252 manager = OpenSCManager(NULL, NULL, SC_MANAGER_ENUMERATE_SERVICE);
254 char *msg_buf = ovs_lasterror_to_string();
255 VLOG_FATAL("Failed to open the service control manager (%s).",
259 service = OpenService(manager, program_name, SERVICE_ALL_ACCESS);
261 char *msg_buf = ovs_lasterror_to_string();
262 VLOG_FATAL("Failed to open service (%s).", msg_buf);
266 /* Service status of a service can be checked asynchronously through
267 * tools like 'sc' or through Windows services manager and is set
268 * through a call to SetServiceStatus(). */
270 init_service_status()
272 /* The service runs in its own process. */
273 service_status.dwServiceType = SERVICE_WIN32_OWN_PROCESS;
275 /* The control codes the service accepts. */
276 service_status.dwControlsAccepted = SERVICE_ACCEPT_STOP |
277 SERVICE_ACCEPT_SHUTDOWN;
279 /* Initialize the current state as SERVICE_RUNNING. */
280 service_status.dwCurrentState = SERVICE_RUNNING;
282 /* The exit code to indicate if there was an error. */
283 service_status.dwWin32ExitCode = NO_ERROR;
285 /* The checkpoint value the service increments periodically. Set as 0
286 * as we do not plan to periodically increment the value. */
287 service_status.dwCheckPoint = 0;
289 /* The estimated time required for the stop operation in ms. */
290 service_status.dwWaitHint = 1000;
293 /* In case of an unexpected termination, configure the action to be
296 set_config_failure_actions()
298 /* In case of a failure, restart the process the first two times
299 * After 'dwResetPeriod', the failure count is reset. */
300 SC_ACTION fail_action[3] = {
301 {SC_ACTION_RESTART, 0},
302 {SC_ACTION_RESTART, 0},
305 SERVICE_FAILURE_ACTIONS service_fail_action;
307 /* Reset failure count after (in seconds). */
308 service_fail_action.dwResetPeriod = 10;
310 /* Reboot message. */
311 service_fail_action.lpRebootMsg = NULL;
313 /* The command line of the process. */
314 service_fail_action.lpCommand = NULL;
316 /* Number of elements in 'fail_actions'. */
317 service_fail_action.cActions = sizeof(fail_action)/sizeof(fail_action[0]);
319 /* A pointer to an array of SC_ACTION structures. */
320 service_fail_action.lpsaActions = fail_action;
322 if (!ChangeServiceConfig2(service, SERVICE_CONFIG_FAILURE_ACTIONS,
323 &service_fail_action)) {
324 char *msg_buf = ovs_lasterror_to_string();
325 VLOG_FATAL("Failed to configure service fail actions (%s).", msg_buf);
329 /* When a daemon is passed the --detach option, we create a new
330 * process and pass an additional non-documented option called --pipe-handle.
331 * Through this option, the parent passes one end of a pipe handle. */
333 set_pipe_handle(const char *pipe_handle)
335 write_handle = (HANDLE) atoi(pipe_handle);
338 /* If one of the command line option is "--detach", creates
339 * a new process in case of parent, waits for child to start and exits.
340 * In case of the child, returns. */
342 detach_process(int argc, char *argv[])
344 SECURITY_ATTRIBUTES sa;
346 PROCESS_INFORMATION pi;
347 HANDLE read_pipe, write_pipe;
352 /* We are only interested in the '--detach' and '--pipe-handle'. */
353 for (i = 0; i < argc; i ++) {
354 if (!strcmp(argv[i], "--detach")) {
356 } else if (!strncmp(argv[i], "--pipe-handle", 13)) {
357 /* If running as a child, return. */
363 /* Nothing to do if the option --detach is not set. */
368 /* Set the security attribute such that a process created will
369 * inherit the pipe handles. */
370 sa.nLength = sizeof(sa);
371 sa.lpSecurityDescriptor = NULL;
372 sa.bInheritHandle = TRUE;
374 /* Create an anonymous pipe to communicate with the child. */
375 error = CreatePipe(&read_pipe, &write_pipe, &sa, 0);
377 VLOG_FATAL("CreatePipe failed (%s)", ovs_lasterror_to_string());
382 /* To the child, we pass an extra argument '--pipe-handle=write_pipe' */
383 buffer = xasprintf("%s %s=%ld", GetCommandLine(), "--pipe-handle",
386 /* Create a detached child */
387 error = CreateProcess(NULL, buffer, NULL, NULL, TRUE, DETACHED_PROCESS,
388 NULL, NULL, &si, &pi);
390 VLOG_FATAL("CreateProcess failed (%s)", ovs_lasterror_to_string());
393 /* Close one end of the pipe in the parent. */
394 CloseHandle(write_pipe);
396 /* Block and wait for child to say it is ready. */
397 error = ReadFile(read_pipe, &ch, 1, NULL, NULL);
399 VLOG_FATAL("Failed to read from child (%s)",
400 ovs_lasterror_to_string());
402 /* The child has successfully started and is ready. */
410 fclose(filep_pidfile);
417 /* If a pidfile has been configured, creates it and stores the running
418 * process's pid in it. Ensures that the pidfile will be deleted when the
425 error = GetFileAttributes(pidfile);
426 if (error != INVALID_FILE_ATTRIBUTES) {
427 /* pidfile exists. Try to unlink() it. */
428 error = unlink(pidfile);
430 VLOG_FATAL("Failed to delete existing pidfile %s (%s)", pidfile,
431 ovs_strerror(errno));
435 filep_pidfile = fopen(pidfile, "w");
436 if (filep_pidfile == NULL) {
437 VLOG_FATAL("failed to open %s (%s)", pidfile, ovs_strerror(errno));
440 fatal_signal_add_hook(unlink_pidfile, NULL, NULL, true);
442 fprintf(filep_pidfile, "%d\n", _getpid());
443 if (fflush(filep_pidfile) == EOF) {
444 VLOG_FATAL("Failed to write into the pidfile %s", pidfile);
447 /* Don't close the pidfile till the process exits. */
451 daemonize_start(bool access_datapath OVS_UNUSED)
459 daemonize_complete(void)
461 /* If running as a child because '--detach' option was specified,
462 * communicate with the parent to inform that the child is ready. */
466 close_standard_fds();
468 error = WriteFile(write_handle, "a", 1, NULL, NULL);
470 VLOG_FATAL("Failed to communicate with the parent (%s)",
471 ovs_lasterror_to_string());
479 daemon_become_new_user(bool access_datapath OVS_UNUSED)
483 /* Returns the file name that would be used for a pidfile if 'name' were
484 * provided to set_pidfile(). The caller must free the returned string. */
486 make_pidfile_name(const char *name)
489 if (strchr(name, ':')) {
490 return xstrdup(name);
492 return xasprintf("%s/%s", ovs_rundir(), name);
495 return xasprintf("%s/%s.pid", ovs_rundir(), program_name);
500 daemon_set_new_user(const char *user_spec OVS_UNUSED)
502 VLOG_FATAL("--user options is not currently supported.");