X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=daemon.c;h=c47aa954fd8a1bfc94cd3a3c379500ddc8a22a93;hp=f7a19221aa78fddd860415e6d4ab8b368c146992;hb=d0d27cfa56d05eaa0e5567c75adfe606eab2957e;hpb=6bdac07456cb5872f824028912d1049883a9c21f diff --git a/daemon.c b/daemon.c index f7a19221..c47aa954 100644 --- a/daemon.c +++ b/daemon.c @@ -1,28 +1,166 @@ /* - * Copyright (C) 1997-2009 Andre Noll + * Copyright (C) 1997-2012 Andre Noll * * Licensed under the GPL v2. For licencing details see COPYING. */ /** \file daemon.c Some helpers for programs that detach from the console. */ -#include "para.h" -#include "daemon.h" -#include -/* getgrnam() */ -#include +#include +#include +#include /* getgrnam() */ #include +#include +#include +#include "para.h" +#include "daemon.h" #include "string.h" +#include "color.h" + +/** The internal state of the daemon. */ +struct daemon { + /** See \ref daemon_flags. */ + unsigned flags; + /** Set by \ref daemon_set_logfile(). */ + 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. */ + FILE *logfile; + /** Used by para_log() if \p DF_LOG_HOSTNAME is set. */ + char *hostname; + /** Used for colored log messages. */ + char log_colors[NUM_LOGLEVELS][COLOR_MAXLEN]; +}; + +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) +{ + int i; + static const char *default_log_colors[NUM_LOGLEVELS] = { + [LL_DEBUG] = "normal", + [LL_INFO] = "normal", + [LL_NOTICE] = "normal", + [LL_WARNING] = "yellow", + [LL_ERROR] = "red", + [LL_CRIT] = "magenta bold", + [LL_EMERG] = "red bold", + }; + 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. + */ +void daemon_set_log_color_or_die(char const *arg) +{ + char *p = strchr(arg, ':'); + int ret, ll; + + if (!p) + goto err; + ret = get_loglevel_by_name(arg); + if (ret < 0) + goto err; + ll = ret; + p++; + color_parse_or_die(p, me->log_colors[ll]); + return; +err: + PARA_EMERG_LOG("%s: color syntax error\n", arg); + exit(EXIT_FAILURE); +} + +/** + * Init or change the name of the log file. + * + * \param logfile_name The full path of the logfile. + */ +void daemon_set_logfile(char *logfile_name) +{ + free(me->logfile_name); + me->logfile_name = NULL; + if (logfile_name) + me->logfile_name = para_strdup(logfile_name); +} + +/** + * Suppress log messages with severity lower than the given loglevel. + * + * \param loglevel The smallest level that should be logged. + */ +void daemon_set_loglevel(char *loglevel) +{ + int ret = get_loglevel_by_name(loglevel); + + assert(ret >= 0); + me->loglevel = ret; +} + +/** + * Set one of the daemon config flags. + * + * \param flag The flag to set. + * + * \sa \ref daemon_flags. + */ +void daemon_set_flag(unsigned flag) +{ + 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) +{ + me->flags &= ~flag; +} + +static bool daemon_test_flag(unsigned flag) +{ + return me->flags & flag; +} + +static void dummy_sighandler(__a_unused int s) +{ +} /** * 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. * - * \sa fork(2), setsid(2), dup(2). + * 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), pause(2). */ -void daemon_init(void) +void daemonize(bool parent_waits) { pid_t pid; int null; @@ -31,14 +169,19 @@ void daemon_init(void) 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; - umask(0); null = open("/dev/null", O_RDONLY); if (null < 0) goto err; @@ -56,50 +199,43 @@ err: } /** - * fopen() the given file in append mode. - * - * \param logfile_name The name of the file to open. - * - * \return Either calls exit() or returns a valid file handle. + * Close the log file of the daemon. */ -FILE *open_log(const char *logfile_name) +void daemon_close_log(void) { - FILE *logfile; - - assert(logfile_name); - logfile = fopen(logfile_name, "a"); - if (!logfile) { - PARA_EMERG_LOG("can not open %s: %s\n", logfile_name, - strerror(errno)); - exit(EXIT_FAILURE); - } - setlinebuf(logfile); - return logfile; + if (!me->logfile) + return; + PARA_INFO_LOG("closing logfile\n"); + fclose(me->logfile); + me->logfile = NULL; } /** - * Close the log file of the daemon. - * - * \param logfile The log file handle. + * fopen() the logfile in append mode. * - * It's OK to call this with logfile == \p NULL. + * \return Either succeeds or exits. */ -void close_log(FILE* logfile) +void daemon_open_log_or_die(void) { - if (!logfile) + daemon_close_log(); + if (!me->logfile_name) return; - PARA_INFO_LOG("closing logfile\n"); - fclose(logfile); + me->logfile = fopen(me->logfile_name, "a"); + if (!me->logfile) { + PARA_EMERG_LOG("can not open %s: %s\n", me->logfile_name, + strerror(errno)); + exit(EXIT_FAILURE); + } + setlinebuf(me->logfile); } /** * Log the startup message containing the paraslash version. */ -void log_welcome(const char *whoami, int loglevel) +void log_welcome(const char *whoami) { PARA_INFO_LOG("welcome to %s " PACKAGE_VERSION " ("BUILD_DATE")\n", whoami); - PARA_DEBUG_LOG("using loglevel %d\n", loglevel); } /** @@ -116,7 +252,7 @@ void log_welcome(const char *whoami, int loglevel) * * \sa getpwnam(3), getuid(2), setuid(2), getgrnam(2), setgid(2) */ -void para_drop_privileges(const char *username, const char *groupname) +void drop_privileges_or_die(const char *username, const char *groupname) { struct passwd *p; char *tmp; @@ -148,49 +284,123 @@ void para_drop_privileges(const char *username, const char *groupname) exit(EXIT_FAILURE); } PARA_INFO_LOG("dropping root privileges\n"); - setuid(p->pw_uid); + if (setuid(p->pw_uid) < 0) { + PARA_EMERG_LOG("failed to set effective user ID (%s)", + strerror(errno)); + exit(EXIT_FAILURE); + } PARA_DEBUG_LOG("uid: %d, euid: %d\n", (int)getuid(), (int)geteuid()); } /** - * Set/get the server uptime. + * Set the server startup time. * - * \param set_or_get Chose one of the two modes. + * \param startuptime The value to store as the server start time. * - * 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. + * This should be called once on startup with \a startuptime either NULL or a + * pointer to a struct timeval which contains the current time. If \a + * startuptime is NULL, the server start time is set to the current time. + * + * \sa time(2), difftime(3) \ref get_server_uptime(), \ref + * get_server_uptime_str(). + */ +void set_server_start_time(const struct timeval *startuptime) +{ + if (startuptime) + me->startuptime = startuptime->tv_sec; + else + time(&me->startuptime); +} - * \return Zero if called with \a set_or_get equal to \p UPTIME_SET, the number - * of seconds ellapsed since the last reset otherwise. +/** + * Get the server 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 + * set_server_start_time(). */ -time_t server_uptime(enum uptime set_or_get) +time_t get_server_uptime(const struct timeval *current_time) { - static time_t startuptime; - time_t now; - double diff; + time_t t; - if (set_or_get == UPTIME_SET) { - time(&startuptime); - return 0; - } - time(&now); - diff = difftime(now, 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 get_server_uptime(). * * \return A dynamically allocated string of the form "days:hours:minutes". * * \sa server_uptime. */ -__malloc char *uptime_str(void) +__malloc char *get_server_uptime_str(const struct timeval *current_time) { - long t = server_uptime(UPTIME_GET); + long t = get_server_uptime(current_time); return make_message("%li:%02li:%02li", t / 86400, (t / 3600) % 24, (t / 60) % 60); } + +/** + * The log function for para_server and para_audiod. + * + * \param ll The log level. + * \param fmt The format string describing the log message. + */ +__printf_2_3 void daemon_log(int ll, const char* fmt,...) +{ + va_list argp; + FILE *fp; + struct tm *tm; + char *color; + bool log_time = daemon_test_flag(DF_LOG_TIME), log_timing = + daemon_test_flag(DF_LOG_TIMING); + + ll = PARA_MIN(ll, NUM_LOGLEVELS - 1); + ll = PARA_MAX(ll, LL_DEBUG); + if (ll < me->loglevel) + return; + + fp = me->logfile? me->logfile : stderr; + color = daemon_test_flag(DF_COLOR_LOG)? me->log_colors[ll] : NULL; + if (color) + fprintf(fp, "%s", color); + if (log_time || log_timing) { + struct timeval tv; + gettimeofday(&tv, NULL); + if (daemon_test_flag(DF_LOG_TIME)) { /* print date and time */ + time_t t1 = tv.tv_sec; + char str[100]; + tm = localtime(&t1); + strftime(str, sizeof(str), "%b %d %H:%M:%S", tm); + fprintf(fp, "%s%s", str, log_timing? ":" : " "); + } + if (log_timing) /* print milliseconds */ + fprintf(fp, "%04lu ", (long unsigned)tv.tv_usec / 1000); + } + if (daemon_test_flag(DF_LOG_HOSTNAME)) { + if (!me->hostname) + me->hostname = para_hostname(); + fprintf(fp, "%s ", me->hostname); + } + if (daemon_test_flag(DF_LOG_LL)) /* log loglevel */ + fprintf(fp, "(%d) ", ll); + if (daemon_test_flag(DF_LOG_PID)) { /* log pid */ + pid_t mypid = getpid(); + fprintf(fp, "(%d) ", (int)mypid); + } + va_start(argp, fmt); + vfprintf(fp, fmt, argp); + va_end(argp); + if (color) + fprintf(fp, "%s", COLOR_RESET); +}