18c2aff776a775d34a4c9893a4c72e0434d68e36artem/***************************************************************************
18c2aff776a775d34a4c9893a4c72e0434d68e36artem * CVSID: $Id$
18c2aff776a775d34a4c9893a4c72e0434d68e36artem *
18c2aff776a775d34a4c9893a4c72e0434d68e36artem * logger.c : Logging
18c2aff776a775d34a4c9893a4c72e0434d68e36artem *
18c2aff776a775d34a4c9893a4c72e0434d68e36artem * Copyright (C) 2003 David Zeuthen, <david@fubar.dk>
18c2aff776a775d34a4c9893a4c72e0434d68e36artem * Copyright (C) 2006 Danny Kukawka, <danny.kukawka@web.de>
18c2aff776a775d34a4c9893a4c72e0434d68e36artem *
18c2aff776a775d34a4c9893a4c72e0434d68e36artem * Licensed under the Academic Free License version 2.1
18c2aff776a775d34a4c9893a4c72e0434d68e36artem *
18c2aff776a775d34a4c9893a4c72e0434d68e36artem * This program is free software; you can redistribute it and/or modify
18c2aff776a775d34a4c9893a4c72e0434d68e36artem * it under the terms of the GNU General Public License as published by
18c2aff776a775d34a4c9893a4c72e0434d68e36artem * the Free Software Foundation; either version 2 of the License, or
18c2aff776a775d34a4c9893a4c72e0434d68e36artem * (at your option) any later version.
18c2aff776a775d34a4c9893a4c72e0434d68e36artem *
18c2aff776a775d34a4c9893a4c72e0434d68e36artem * This program is distributed in the hope that it will be useful,
18c2aff776a775d34a4c9893a4c72e0434d68e36artem * but WITHOUT ANY WARRANTY; without even the implied warranty of
18c2aff776a775d34a4c9893a4c72e0434d68e36artem * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18c2aff776a775d34a4c9893a4c72e0434d68e36artem * GNU General Public License for more details.
18c2aff776a775d34a4c9893a4c72e0434d68e36artem *
18c2aff776a775d34a4c9893a4c72e0434d68e36artem * You should have received a copy of the GNU General Public License
18c2aff776a775d34a4c9893a4c72e0434d68e36artem * along with this program; if not, write to the Free Software
18c2aff776a775d34a4c9893a4c72e0434d68e36artem * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
18c2aff776a775d34a4c9893a4c72e0434d68e36artem *
18c2aff776a775d34a4c9893a4c72e0434d68e36artem **************************************************************************/
18c2aff776a775d34a4c9893a4c72e0434d68e36artem
18c2aff776a775d34a4c9893a4c72e0434d68e36artem#ifdef HAVE_CONFIG_H
18c2aff776a775d34a4c9893a4c72e0434d68e36artem# include <config.h>
18c2aff776a775d34a4c9893a4c72e0434d68e36artem#endif
18c2aff776a775d34a4c9893a4c72e0434d68e36artem
18c2aff776a775d34a4c9893a4c72e0434d68e36artem#include <stdio.h>
18c2aff776a775d34a4c9893a4c72e0434d68e36artem#include <stdlib.h>
18c2aff776a775d34a4c9893a4c72e0434d68e36artem#include <string.h>
18c2aff776a775d34a4c9893a4c72e0434d68e36artem#include <stdarg.h>
18c2aff776a775d34a4c9893a4c72e0434d68e36artem#include <time.h>
18c2aff776a775d34a4c9893a4c72e0434d68e36artem#include <sys/time.h>
18c2aff776a775d34a4c9893a4c72e0434d68e36artem#include <syslog.h>
18c2aff776a775d34a4c9893a4c72e0434d68e36artem#include <unistd.h>
18c2aff776a775d34a4c9893a4c72e0434d68e36artem
18c2aff776a775d34a4c9893a4c72e0434d68e36artem#include "logger.h"
18c2aff776a775d34a4c9893a4c72e0434d68e36artem
18c2aff776a775d34a4c9893a4c72e0434d68e36artem/**
18c2aff776a775d34a4c9893a4c72e0434d68e36artem * @defgroup HalDaemonLogging Logging system
18c2aff776a775d34a4c9893a4c72e0434d68e36artem * @ingroup HalDaemon
18c2aff776a775d34a4c9893a4c72e0434d68e36artem * @brief Logging system for the HAL daemon
18c2aff776a775d34a4c9893a4c72e0434d68e36artem * @{
18c2aff776a775d34a4c9893a4c72e0434d68e36artem */
18c2aff776a775d34a4c9893a4c72e0434d68e36artem
18c2aff776a775d34a4c9893a4c72e0434d68e36artem
18c2aff776a775d34a4c9893a4c72e0434d68e36artemstatic int priority;
18c2aff776a775d34a4c9893a4c72e0434d68e36artemstatic const char *file;
18c2aff776a775d34a4c9893a4c72e0434d68e36artemstatic int line;
18c2aff776a775d34a4c9893a4c72e0434d68e36artemstatic const char *function;
18c2aff776a775d34a4c9893a4c72e0434d68e36artem
18c2aff776a775d34a4c9893a4c72e0434d68e36artemstatic int log_pid = 0;
18c2aff776a775d34a4c9893a4c72e0434d68e36artemstatic int is_enabled = 1;
18c2aff776a775d34a4c9893a4c72e0434d68e36artemstatic int syslog_enabled = 0;
18c2aff776a775d34a4c9893a4c72e0434d68e36artem
18c2aff776a775d34a4c9893a4c72e0434d68e36artem
18c2aff776a775d34a4c9893a4c72e0434d68e36artem/** Disable all logging
18c2aff776a775d34a4c9893a4c72e0434d68e36artem *
18c2aff776a775d34a4c9893a4c72e0434d68e36artem */
18c2aff776a775d34a4c9893a4c72e0434d68e36artemvoid
18c2aff776a775d34a4c9893a4c72e0434d68e36artemlogger_disable (void)
18c2aff776a775d34a4c9893a4c72e0434d68e36artem{
18c2aff776a775d34a4c9893a4c72e0434d68e36artem is_enabled = 0;
18c2aff776a775d34a4c9893a4c72e0434d68e36artem}
18c2aff776a775d34a4c9893a4c72e0434d68e36artem
18c2aff776a775d34a4c9893a4c72e0434d68e36artem/** Enable all logging
18c2aff776a775d34a4c9893a4c72e0434d68e36artem *
18c2aff776a775d34a4c9893a4c72e0434d68e36artem */
18c2aff776a775d34a4c9893a4c72e0434d68e36artemvoid
18c2aff776a775d34a4c9893a4c72e0434d68e36artemlogger_enable (void)
18c2aff776a775d34a4c9893a4c72e0434d68e36artem{
18c2aff776a775d34a4c9893a4c72e0434d68e36artem is_enabled = 1;
18c2aff776a775d34a4c9893a4c72e0434d68e36artem}
18c2aff776a775d34a4c9893a4c72e0434d68e36artem
18c2aff776a775d34a4c9893a4c72e0434d68e36artem/** enable usage of syslog for logging
18c2aff776a775d34a4c9893a4c72e0434d68e36artem *
18c2aff776a775d34a4c9893a4c72e0434d68e36artem */
18c2aff776a775d34a4c9893a4c72e0434d68e36artemvoid
18c2aff776a775d34a4c9893a4c72e0434d68e36artemlogger_enable_syslog (void)
18c2aff776a775d34a4c9893a4c72e0434d68e36artem{
18c2aff776a775d34a4c9893a4c72e0434d68e36artem syslog_enabled = 1;
18c2aff776a775d34a4c9893a4c72e0434d68e36artem}
18c2aff776a775d34a4c9893a4c72e0434d68e36artem
18c2aff776a775d34a4c9893a4c72e0434d68e36artem/** disable usage of syslog for logging
18c2aff776a775d34a4c9893a4c72e0434d68e36artem *
18c2aff776a775d34a4c9893a4c72e0434d68e36artem */
18c2aff776a775d34a4c9893a4c72e0434d68e36artemvoid
18c2aff776a775d34a4c9893a4c72e0434d68e36artemlogger_disable_syslog (void)
18c2aff776a775d34a4c9893a4c72e0434d68e36artem{
18c2aff776a775d34a4c9893a4c72e0434d68e36artem syslog_enabled = 0;
18c2aff776a775d34a4c9893a4c72e0434d68e36artem}
18c2aff776a775d34a4c9893a4c72e0434d68e36artem
18c2aff776a775d34a4c9893a4c72e0434d68e36artem/** allow setup logger from a addon/prober via the env
18c2aff776a775d34a4c9893a4c72e0434d68e36artem *
18c2aff776a775d34a4c9893a4c72e0434d68e36artem */
18c2aff776a775d34a4c9893a4c72e0434d68e36artemvoid
18c2aff776a775d34a4c9893a4c72e0434d68e36artemsetup_logger (void)
18c2aff776a775d34a4c9893a4c72e0434d68e36artem{
18c2aff776a775d34a4c9893a4c72e0434d68e36artem if ((getenv ("HALD_VERBOSE")) != NULL) {
18c2aff776a775d34a4c9893a4c72e0434d68e36artem is_enabled = 1;
18c2aff776a775d34a4c9893a4c72e0434d68e36artem log_pid = 1;
18c2aff776a775d34a4c9893a4c72e0434d68e36artem }
18c2aff776a775d34a4c9893a4c72e0434d68e36artem else
18c2aff776a775d34a4c9893a4c72e0434d68e36artem is_enabled = 0;
18c2aff776a775d34a4c9893a4c72e0434d68e36artem
18c2aff776a775d34a4c9893a4c72e0434d68e36artem if ((getenv ("HALD_USE_SYSLOG")) != NULL)
18c2aff776a775d34a4c9893a4c72e0434d68e36artem syslog_enabled = 1;
18c2aff776a775d34a4c9893a4c72e0434d68e36artem else
18c2aff776a775d34a4c9893a4c72e0434d68e36artem syslog_enabled = 0;
18c2aff776a775d34a4c9893a4c72e0434d68e36artem}
18c2aff776a775d34a4c9893a4c72e0434d68e36artem
18c2aff776a775d34a4c9893a4c72e0434d68e36artem/** Setup logging entry
18c2aff776a775d34a4c9893a4c72e0434d68e36artem *
18c2aff776a775d34a4c9893a4c72e0434d68e36artem * @param priority Logging priority, one of HAL_LOGPRI_*
18c2aff776a775d34a4c9893a4c72e0434d68e36artem * @param file Name of file where the log entry originated
18c2aff776a775d34a4c9893a4c72e0434d68e36artem * @param line Line number of file
18c2aff776a775d34a4c9893a4c72e0434d68e36artem * @param function Name of function
18c2aff776a775d34a4c9893a4c72e0434d68e36artem */
18c2aff776a775d34a4c9893a4c72e0434d68e36artemvoid
18c2aff776a775d34a4c9893a4c72e0434d68e36artemlogger_setup (int _priority, const char *_file, int _line, const char *_function)
18c2aff776a775d34a4c9893a4c72e0434d68e36artem{
18c2aff776a775d34a4c9893a4c72e0434d68e36artem priority = _priority;
18c2aff776a775d34a4c9893a4c72e0434d68e36artem file = _file;
18c2aff776a775d34a4c9893a4c72e0434d68e36artem line = _line;
18c2aff776a775d34a4c9893a4c72e0434d68e36artem function = _function;
18c2aff776a775d34a4c9893a4c72e0434d68e36artem}
18c2aff776a775d34a4c9893a4c72e0434d68e36artem
18c2aff776a775d34a4c9893a4c72e0434d68e36artem/** Emit logging entry
18c2aff776a775d34a4c9893a4c72e0434d68e36artem *
18c2aff776a775d34a4c9893a4c72e0434d68e36artem * @param format Message format string, printf style
18c2aff776a775d34a4c9893a4c72e0434d68e36artem * @param ... Parameters for message, printf style
18c2aff776a775d34a4c9893a4c72e0434d68e36artem */
18c2aff776a775d34a4c9893a4c72e0434d68e36artemvoid
18c2aff776a775d34a4c9893a4c72e0434d68e36artemlogger_emit (const char *format, ...)
18c2aff776a775d34a4c9893a4c72e0434d68e36artem{
18c2aff776a775d34a4c9893a4c72e0434d68e36artem va_list args;
18c2aff776a775d34a4c9893a4c72e0434d68e36artem char buf[512];
18c2aff776a775d34a4c9893a4c72e0434d68e36artem char *pri;
18c2aff776a775d34a4c9893a4c72e0434d68e36artem char tbuf[256];
18c2aff776a775d34a4c9893a4c72e0434d68e36artem char logmsg[1024];
18c2aff776a775d34a4c9893a4c72e0434d68e36artem struct timeval tnow;
18c2aff776a775d34a4c9893a4c72e0434d68e36artem struct tm *tlocaltime;
18c2aff776a775d34a4c9893a4c72e0434d68e36artem struct timezone tzone;
18c2aff776a775d34a4c9893a4c72e0434d68e36artem static pid_t pid = -1;
18c2aff776a775d34a4c9893a4c72e0434d68e36artem
18c2aff776a775d34a4c9893a4c72e0434d68e36artem if (!is_enabled)
18c2aff776a775d34a4c9893a4c72e0434d68e36artem return;
18c2aff776a775d34a4c9893a4c72e0434d68e36artem
18c2aff776a775d34a4c9893a4c72e0434d68e36artem va_start (args, format);
18c2aff776a775d34a4c9893a4c72e0434d68e36artem vsnprintf (buf, sizeof (buf), format, args);
18c2aff776a775d34a4c9893a4c72e0434d68e36artem
18c2aff776a775d34a4c9893a4c72e0434d68e36artem switch (priority) {
18c2aff776a775d34a4c9893a4c72e0434d68e36artem case HAL_LOGPRI_TRACE:
18c2aff776a775d34a4c9893a4c72e0434d68e36artem pri = "[T]";
18c2aff776a775d34a4c9893a4c72e0434d68e36artem break;
18c2aff776a775d34a4c9893a4c72e0434d68e36artem case HAL_LOGPRI_DEBUG:
18c2aff776a775d34a4c9893a4c72e0434d68e36artem pri = "[D]";
18c2aff776a775d34a4c9893a4c72e0434d68e36artem break;
18c2aff776a775d34a4c9893a4c72e0434d68e36artem case HAL_LOGPRI_INFO:
18c2aff776a775d34a4c9893a4c72e0434d68e36artem pri = "[I]";
18c2aff776a775d34a4c9893a4c72e0434d68e36artem break;
18c2aff776a775d34a4c9893a4c72e0434d68e36artem case HAL_LOGPRI_WARNING:
18c2aff776a775d34a4c9893a4c72e0434d68e36artem pri = "[W]";
18c2aff776a775d34a4c9893a4c72e0434d68e36artem break;
18c2aff776a775d34a4c9893a4c72e0434d68e36artem default: /* explicit fallthrough */
18c2aff776a775d34a4c9893a4c72e0434d68e36artem case HAL_LOGPRI_ERROR:
18c2aff776a775d34a4c9893a4c72e0434d68e36artem pri = "[E]";
18c2aff776a775d34a4c9893a4c72e0434d68e36artem break;
18c2aff776a775d34a4c9893a4c72e0434d68e36artem }
18c2aff776a775d34a4c9893a4c72e0434d68e36artem
18c2aff776a775d34a4c9893a4c72e0434d68e36artem gettimeofday (&tnow, &tzone);
18c2aff776a775d34a4c9893a4c72e0434d68e36artem tlocaltime = localtime (&tnow.tv_sec);
18c2aff776a775d34a4c9893a4c72e0434d68e36artem strftime (tbuf, sizeof (tbuf), "%H:%M:%S", tlocaltime);
18c2aff776a775d34a4c9893a4c72e0434d68e36artem
18c2aff776a775d34a4c9893a4c72e0434d68e36artem if (log_pid) {
18c2aff776a775d34a4c9893a4c72e0434d68e36artem if ((int) pid == -1)
18c2aff776a775d34a4c9893a4c72e0434d68e36artem pid = getpid ();
18c2aff776a775d34a4c9893a4c72e0434d68e36artem snprintf (logmsg, sizeof(logmsg), "[%d]: %s.%03d %s %s:%d: %s\n", pid, tbuf, (int)(tnow.tv_usec/1000), pri, file, line, buf);
18c2aff776a775d34a4c9893a4c72e0434d68e36artem } else {
18c2aff776a775d34a4c9893a4c72e0434d68e36artem snprintf (logmsg, sizeof(logmsg), "%s.%03d %s %s:%d: %s\n", tbuf, (int)(tnow.tv_usec/1000), pri, file, line, buf);
18c2aff776a775d34a4c9893a4c72e0434d68e36artem }
18c2aff776a775d34a4c9893a4c72e0434d68e36artem
18c2aff776a775d34a4c9893a4c72e0434d68e36artem /** @todo Make programmatic interface to logging */
18c2aff776a775d34a4c9893a4c72e0434d68e36artem if (priority != HAL_LOGPRI_TRACE && !syslog_enabled ) {
18c2aff776a775d34a4c9893a4c72e0434d68e36artem fprintf (stderr, "%s", logmsg );
18c2aff776a775d34a4c9893a4c72e0434d68e36artem } else if (priority != HAL_LOGPRI_TRACE && syslog_enabled ) {
18c2aff776a775d34a4c9893a4c72e0434d68e36artem /* use syslog for debug/log messages if HAL started as daemon */
18c2aff776a775d34a4c9893a4c72e0434d68e36artem switch (priority) {
18c2aff776a775d34a4c9893a4c72e0434d68e36artem case HAL_LOGPRI_DEBUG:
18c2aff776a775d34a4c9893a4c72e0434d68e36artem case HAL_LOGPRI_INFO:
18c2aff776a775d34a4c9893a4c72e0434d68e36artem syslog(LOG_INFO, "%s", logmsg );
18c2aff776a775d34a4c9893a4c72e0434d68e36artem break;
18c2aff776a775d34a4c9893a4c72e0434d68e36artem case HAL_LOGPRI_WARNING:
18c2aff776a775d34a4c9893a4c72e0434d68e36artem syslog(LOG_WARNING, "%s", logmsg );
18c2aff776a775d34a4c9893a4c72e0434d68e36artem break;
18c2aff776a775d34a4c9893a4c72e0434d68e36artem default: /* explicit fallthrough */
18c2aff776a775d34a4c9893a4c72e0434d68e36artem case HAL_LOGPRI_ERROR:
18c2aff776a775d34a4c9893a4c72e0434d68e36artem syslog(LOG_ERR, "%s", logmsg );
18c2aff776a775d34a4c9893a4c72e0434d68e36artem break;
18c2aff776a775d34a4c9893a4c72e0434d68e36artem }
18c2aff776a775d34a4c9893a4c72e0434d68e36artem }
18c2aff776a775d34a4c9893a4c72e0434d68e36artem
18c2aff776a775d34a4c9893a4c72e0434d68e36artem va_end (args);
18c2aff776a775d34a4c9893a4c72e0434d68e36artem}
18c2aff776a775d34a4c9893a4c72e0434d68e36artem
18c2aff776a775d34a4c9893a4c72e0434d68e36artemvoid
18c2aff776a775d34a4c9893a4c72e0434d68e36artemlogger_forward_debug (const char *format, ...)
18c2aff776a775d34a4c9893a4c72e0434d68e36artem{
18c2aff776a775d34a4c9893a4c72e0434d68e36artem va_list args;
18c2aff776a775d34a4c9893a4c72e0434d68e36artem char buf[512];
18c2aff776a775d34a4c9893a4c72e0434d68e36artem char tbuf[256];
18c2aff776a775d34a4c9893a4c72e0434d68e36artem struct timeval tnow;
18c2aff776a775d34a4c9893a4c72e0434d68e36artem struct tm *tlocaltime;
18c2aff776a775d34a4c9893a4c72e0434d68e36artem struct timezone tzone;
18c2aff776a775d34a4c9893a4c72e0434d68e36artem static pid_t pid = -1;
18c2aff776a775d34a4c9893a4c72e0434d68e36artem
18c2aff776a775d34a4c9893a4c72e0434d68e36artem if (!is_enabled)
18c2aff776a775d34a4c9893a4c72e0434d68e36artem return;
18c2aff776a775d34a4c9893a4c72e0434d68e36artem
18c2aff776a775d34a4c9893a4c72e0434d68e36artem if ((int) pid == -1)
18c2aff776a775d34a4c9893a4c72e0434d68e36artem pid = getpid ();
18c2aff776a775d34a4c9893a4c72e0434d68e36artem
18c2aff776a775d34a4c9893a4c72e0434d68e36artem va_start (args, format);
18c2aff776a775d34a4c9893a4c72e0434d68e36artem vsnprintf (buf, sizeof (buf), format, args);
18c2aff776a775d34a4c9893a4c72e0434d68e36artem
18c2aff776a775d34a4c9893a4c72e0434d68e36artem gettimeofday (&tnow, &tzone);
18c2aff776a775d34a4c9893a4c72e0434d68e36artem tlocaltime = localtime (&tnow.tv_sec);
18c2aff776a775d34a4c9893a4c72e0434d68e36artem strftime (tbuf, sizeof (tbuf), "%H:%M:%S", tlocaltime);
18c2aff776a775d34a4c9893a4c72e0434d68e36artem
18c2aff776a775d34a4c9893a4c72e0434d68e36artem if (syslog_enabled)
18c2aff776a775d34a4c9893a4c72e0434d68e36artem syslog (LOG_INFO, "%d: %s.%03d: %s", pid, tbuf, (int)(tnow.tv_usec/1000), buf);
18c2aff776a775d34a4c9893a4c72e0434d68e36artem else
18c2aff776a775d34a4c9893a4c72e0434d68e36artem fprintf (stderr, "%d: %s.%03d: %s", pid, tbuf, (int)(tnow.tv_usec/1000), buf);
18c2aff776a775d34a4c9893a4c72e0434d68e36artem
18c2aff776a775d34a4c9893a4c72e0434d68e36artem va_end (args);
18c2aff776a775d34a4c9893a4c72e0434d68e36artem}
18c2aff776a775d34a4c9893a4c72e0434d68e36artem
18c2aff776a775d34a4c9893a4c72e0434d68e36artem/** @} */