From 298af748ac09963f0bcacdba200ee43e081bbaa8 Mon Sep 17 00:00:00 2001 From: Martin Schwenke Date: Tue, 15 Aug 2017 11:12:35 +1000 Subject: [PATCH] util: Add become_daemon.h Rename argument no_process_group to no_session to describe what it actually does. Consistently use "daemon" for name of daemon argument. Add documentation. Signed-off-by: Martin Schwenke Reviewed-by: Andreas Schneider --- lib/util/become_daemon.c | 2 +- lib/util/become_daemon.h | 86 ++++++++++++++++++++++++++++++++++++++++ lib/util/samba_util.h | 28 +------------ 3 files changed, 88 insertions(+), 28 deletions(-) create mode 100644 lib/util/become_daemon.h diff --git a/lib/util/become_daemon.c b/lib/util/become_daemon.c index 1c674d4c918..7b84299dc28 100644 --- a/lib/util/become_daemon.c +++ b/lib/util/become_daemon.c @@ -31,7 +31,7 @@ #include "close_low_fd.h" #include "debug.h" -#include "samba_util.h" +#include "become_daemon.h" /******************************************************************* Close the low 3 fd's and open dev/null in their place. diff --git a/lib/util/become_daemon.h b/lib/util/become_daemon.h new file mode 100644 index 00000000000..d697a689cdc --- /dev/null +++ b/lib/util/become_daemon.h @@ -0,0 +1,86 @@ +/* + Unix SMB/CIFS implementation. + Samba utility functions + Copyright (C) Andrew Tridgell 1992-1998 + Copyright (C) Jeremy Allison 2001-2002 + Copyright (C) Simo Sorce 2001 + Copyright (C) Jim McDonough (jmcd@us.ibm.com) 2003. + Copyright (C) James J Myers 2003 + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . +*/ + +#ifndef _BECOME_DAEMON_H +#define _BECOME_DAEMON_H + +#include + +/** + * @file become_daemon.h + * + * @brief Utilities for demonising + */ + +/** + * @brief Close the low 3 file descriptors and open /dev/null in their place + * + * @param[in] stdin_too Should stdin be closed? + * @param[in] stdout_too Should stdout be closed? + * @param[in] stderr_too Should stderr be closed? +**/ +void close_low_fds(bool stdin_too, bool stdout_too, bool stderr_too); + +/** + * @brief Become a daemon, optionally discarding the controlling terminal + * + * @param[in] do_fork Should the process fork? + * @param[in] no_session Don't start a new session + * @param[in] log_stdour Should stdout be closed? +**/ +void become_daemon(bool do_fork, bool no_session, bool log_stdout); + +/** + * @brief Exit daemon and log an error message at ERR level + * + * Optionally report failure to systemd if systemd integration is + * enabled. + * + * @param[in] msg Message to log, generated from error if NULL + * @param[in] error Errno of error that occurred +**/ +void exit_daemon(const char *msg, int error); + +/** + * @brief Log at ERR level that the daemon is ready to serve connections + * + * Optionally report status to systemd if systemd integration is enabled. + * + * @param[in] daemon Name of daemon to include it message +**/ +void daemon_ready(const char *daemon); + +/** + * @brief Log at ERR level the specified daemon status + * + * For example if it is not ready to serve connections and is waiting + * for some event to happen. + * + * Optionally report status to systemd if systemd integration is enabled. + * + * @param[in] daemon Name of daemon to include it message + * @param[in] msg Message to log +**/ +void daemon_status(const char *daemon, const char *msg); + +#endif /* _BECOME_DAEMON_H */ diff --git a/lib/util/samba_util.h b/lib/util/samba_util.h index 0bb04b3567c..3daf3dfdfd0 100644 --- a/lib/util/samba_util.h +++ b/lib/util/samba_util.h @@ -567,33 +567,7 @@ int gen_fnmatch(const char *pattern, const char *string); #include "idtree.h" #include "idtree_random.h" -/** - Close the low 3 fd's and open dev/null in their place -**/ -_PUBLIC_ void close_low_fds(bool stdin_too, bool stdout_too, bool stderr_too); - -/** - Become a daemon, discarding the controlling terminal. -**/ -_PUBLIC_ void become_daemon(bool do_fork, bool no_process_group, bool log_stdout); - -/** - Exit daemon and print error message to the log at level 0 - Optionally report failure to systemd if systemd integration is enabled -**/ -_PUBLIC_ void exit_daemon(const char *msg, int error); - -/** - Report that the daemon is ready to serve connections to the log at level 0 - Optionally report status to systemd if systemd integration is enabled -**/ -_PUBLIC_ void daemon_ready(const char *daemon); - -/* - * Report the daemon status. For example if it is not ready to serve connections - * and is waiting for some event to happen. - */ -_PUBLIC_ void daemon_status(const char *name, const char *msg); +#include "become_daemon.h" /** * @brief Get a password from the console. -- 2.34.1