/*
- * Copyright (C) 1997-2010 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 1997 Andre Noll <maan@tuebingen.mpg.de>
*
* Licensed under the GPL v2. For licencing details see COPYING.
*/
#include <pwd.h>
#include <sys/types.h> /* getgrnam() */
#include <grp.h>
-#include <sys/time.h>
-#include <stdbool.h>
+#include <signal.h>
+#include <sys/resource.h>
#include "para.h"
#include "daemon.h"
char *logfile_name;
/** Current loglevel, see \ref daemon_set_loglevel(). */
int loglevel;
-
/** Used by \ref server_uptime() and \ref uptime_str(). */
time_t startuptime;
/** The file pointer if the logfile is open. */
static struct daemon the_daemon, *me = &the_daemon;
-/**
- * Activate default log colors.
- *
- * This should be called early if color support is wanted.
- */
-void daemon_set_default_log_colors(void)
+static void daemon_set_default_log_colors(void)
{
int i;
static const char *default_log_colors[NUM_LOGLEVELS] = {
[LL_CRIT] = "magenta bold",
[LL_EMERG] = "red bold",
};
- for (i = 0; i < NUM_LOGLEVELS; i++) {
- int ret = color_parse(default_log_colors[i], me->log_colors[i]);
- assert(ret >= 0);
- }
+ for (i = 0; i < NUM_LOGLEVELS; i++)
+ color_parse_or_die(default_log_colors[i], me->log_colors[i]);
}
-/**
+/*
* Set the color for one loglevel.
*
- * \param arg The loglevel/color specifier.
- *
- * \a arg must be of the form "ll:[fg [bg]] [attr]".
- *
- * \return 1 On success, -1 on errors.
+ * arg must be of the form "ll:[fg [bg]] [attr]".
*/
-int daemon_set_log_color(char const *arg)
+static void daemon_set_log_color_or_die(char const *arg)
{
char *p = strchr(arg, ':');
int ret, ll;
goto err;
ll = ret;
p++;
- ret = color_parse(p, me->log_colors[ll]);
- if (ret < 0)
- goto err;
- return 1;
+ color_parse_or_die(p, me->log_colors[ll]);
+ return;
err:
- PARA_ERROR_LOG("%s: color syntax error\n", arg);
- return -1;
+ PARA_EMERG_LOG("%s: color syntax error\n", arg);
+ exit(EXIT_FAILURE);
+}
+/**
+ * Initialize color mode if necessary.
+ *
+ * \param color_arg The argument given to --color.
+ * \param color_arg_auto The value for automatic color detection.
+ * \param color_arg_no The value to disable colored log messages.
+ * \param logfile_given In auto mode colors are disabled if this value is true.
+ * \param log_color_argv Color specifiers given to --log-color.
+ * \param argc Number of color specifiers in \a log_color_argv.
+ *
+ * If \a color_arg equals \a color_arg_no, color mode is disabled, i.e., calls
+ * to \a para_log() will not produce colored output. If \a color_arg == \a
+ * color_arg_auto, the function autodetects whether to activate colors.
+ * Otherwise color mode is enabled.
+ *
+ * If color mode is to be enabled, the strings in \a log_color_argv are parsed
+ * and the color scheme is updated accordingly. For each loglevel, the default
+ * colors apply if there is no log_color_argv for this loglevel.
+ */
+void daemon_init_colors_or_die(int color_arg, int color_arg_auto,
+ int color_arg_no, bool logfile_given, char **log_color_argv,
+ int argc)
+{
+ int i;
+
+ if (color_arg == color_arg_no)
+ return;
+ if (color_arg == color_arg_auto) {
+ if (logfile_given)
+ return;
+ if (!isatty(STDERR_FILENO))
+ return;
+ }
+ daemon_set_flag(DF_COLOR_LOG);
+ daemon_set_default_log_colors();
+ for (i = 0; i < argc; i++)
+ daemon_set_log_color_or_die(log_color_argv[i]);
}
/**
me->flags |= flag;
}
-/**
- * Clear one of the daemon config flags.
- *
- * \param flag The flag to clear.
- *
- * \sa \ref daemon_flags.
- */
-void daemon_clear_flag(unsigned flag)
+static bool daemon_test_flag(unsigned flag)
{
- me->flags &= ~flag;
+ return me->flags & flag;
}
-static bool daemon_test_flag(unsigned flag)
+static void dummy_sighandler(__a_unused int s)
{
- return me->flags & flag;
}
/**
* Do the usual stuff to become a daemon.
*
- * Fork, become session leader, dup fd 0, 1, 2 to /dev/null.
+ * \param parent_waits Whether the parent process should pause before exit.
+ *
+ * Fork, become session leader, cd to /, and dup fd 0, 1, 2 to /dev/null. If \a
+ * parent_waits is false, the parent process terminates immediately.
+ * Otherwise, it calls pause() to sleep until it receives \p SIGTERM or \p
+ * SIGCHLD and exits successfully thereafter. This behaviour is useful if the
+ * daemon process should not detach from the console until the child process
+ * has completed its setup.
*
- * \sa fork(2), setsid(2), dup(2).
+ * \sa fork(2), setsid(2), dup(2), pause(2).
*/
-void daemonize(void)
+void daemonize(bool parent_waits)
{
pid_t pid;
int null;
pid = fork();
if (pid < 0)
goto err;
- if (pid)
+ if (pid) {
+ if (parent_waits) {
+ signal(SIGTERM, dummy_sighandler);
+ signal(SIGCHLD, dummy_sighandler);
+ pause();
+ }
exit(EXIT_SUCCESS); /* parent exits */
+ }
/* become session leader */
if (setsid() < 0)
goto err;
if (chdir("/") < 0)
goto err;
- null = open("/dev/null", O_RDONLY);
+ null = open("/dev/null", O_RDWR);
if (null < 0)
goto err;
if (dup2(null, STDIN_FILENO) < 0)
strerror(errno));
exit(EXIT_FAILURE);
}
- setlinebuf(me->logfile);
+ /* equivalent to setlinebuf(), but portable */
+ setvbuf(me->logfile, NULL, _IOLBF, 0);
}
/**
* Log the startup message containing the paraslash version.
+ *
+ * \param name The name of the executable.
+ *
+ * First the given \a name is prefixed with the string "para_". Next the git
+ * version is appended. The resulting string is logged with priority "INFO".
*/
-void log_welcome(const char *whoami)
+void daemon_log_welcome(const char *name)
{
- PARA_INFO_LOG("welcome to %s " PACKAGE_VERSION " ("BUILD_DATE")\n",
- whoami);
+ PARA_INFO_LOG("welcome to para_%s-" PACKAGE_VERSION " \n", name);
+}
+
+/**
+ * Renice the calling process.
+ *
+ * \param prio The priority value to set.
+ *
+ * Errors are not considered fatal, but a warning message is logged if the
+ * underlying call to setpriority(2) fails.
+ */
+void daemon_set_priority(int prio)
+{
+ if (setpriority(PRIO_PROCESS, 0, prio) < 0)
+ PARA_WARNING_LOG("could not set priority to %d: %s\n", prio,
+ strerror(errno));
}
/**
*
* \sa getpwnam(3), getuid(2), setuid(2), getgrnam(2), setgid(2)
*/
-void drop_privileges_or_die(const char *username, const char *groupname)
+void daemon_drop_privileges_or_die(const char *username, const char *groupname)
{
struct passwd *p;
char *tmp;
}
/**
- * Set/get the server uptime.
+ * Set the startup time.
*
- * \param set_or_get Chose one of the two modes.
+ * This should be called once on startup. It sets the start time to the
+ * current time. The stored time is used for retrieving the server uptime.
*
- * This should be called at startup time with \a set_or_get equal to \p
- * UPTIME_SET which sets the uptime to zero. Subsequent calls with \a
- * set_or_get equal to \p UPTIME_GET return the uptime.
+ * \sa time(2), \ref daemon_get_uptime(), \ref daemon_get_uptime_str().
+ */
+void daemon_set_start_time(void)
+{
+ time(&me->startuptime);
+}
- * \return Zero if called with \a set_or_get equal to \p UPTIME_SET, the number
- * of seconds elapsed since the last reset otherwise.
+/**
+ * Get the uptime.
+ *
+ * \param current_time The current time.
*
- * \sa time(2), difftime(3).
+ * The \a current_time pointer may be \p NULL. In this case the function
+ * obtains the current time from the system.
+ *
+ * \return This returns the server uptime in seconds, i.e. the difference
+ * between the current time and the value stored previously via \ref
+ * daemon_set_start_time().
*/
-time_t server_uptime(enum uptime set_or_get)
+time_t daemon_get_uptime(const struct timeval *current_time)
{
- time_t now;
- double diff;
+ time_t t;
- if (set_or_get == UPTIME_SET) {
- time(&me->startuptime);
- return 0;
- }
- time(&now);
- diff = difftime(now, me->startuptime);
- return (time_t) diff;
+ if (current_time)
+ return current_time->tv_sec - me->startuptime;
+ time(&t);
+ return difftime(t, me->startuptime);
}
/**
- * Construct string containing uptime.
+ * Construct a string containing the current uptime.
+ *
+ * \param current_time See a \ref daemon_get_uptime().
*
* \return A dynamically allocated string of the form "days:hours:minutes".
*
* \sa server_uptime.
*/
-__malloc char *uptime_str(void)
+__malloc char *daemon_get_uptime_str(const struct timeval *current_time)
{
- long t = server_uptime(UPTIME_GET);
+ long t = daemon_get_uptime(current_time);
return make_message("%li:%02li:%02li", t / 86400,
(t / 3600) % 24, (t / 60) % 60);
}
* \param ll The log level.
* \param fmt The format string describing the log message.
*/
-__printf_2_3 void para_log(int ll, const char* fmt,...)
+__printf_2_3 void daemon_log(int ll, const char* fmt,...)
{
va_list argp;
FILE *fp;
fprintf(fp, "%s", color);
if (log_time || log_timing) {
struct timeval tv;
- gettimeofday(&tv, NULL);
+ clock_get_realtime(&tv);
if (daemon_test_flag(DF_LOG_TIME)) { /* print date and time */
time_t t1 = tv.tv_sec;
char str[100];