/**
* @file log.c
- * @purpose Implement logging and error handling functions
+ * @brief Implement logging and error handling functions
*/
-#include <unistd.h>
-#include <stdarg.h>
-
// --- Custom headers --- //
#include "common.h"
#include "log.h"
#include "options.h"
-// --- Static variables --- //
-static const char * unspecified_funct = "???";
+#include <unistd.h>
+#include <syslog.h>
+#include <stdarg.h>
-// --- Function implementations --- //
+static const char * unspecified_funct = "???";
-//TODO: Migrate to syslog (shouldn't be too hard; these functions basically do what syslog does)
-// Note that we will want to have a seperate log as well as syslog; give the user the option to view the log using the GUI
/**
- * Print a message to stderr
+ * Print a message to stderr and log it via syslog. The message must be
+ * less than BUFSIZ characters long, or it will be truncated.
* @param level - Specify how severe the message is.
If level is higher (less urgent) than the program's verbosity (see options.h) no message will be printed
* @param funct - String indicating the function name from which this function was called.
If this is NULL, Log will show the unspecified_funct string instead
+ * @param file - Source file containing the function
+ * @param line - Line in the source file at which Log is called
* @param fmt - A format string
* @param ... - Arguments to be printed according to the format string
*/
-void LogEx(int level, const char * funct, ...)
+void LogEx(int level, const char * funct, const char * file, int line, ...)
{
+ //Todo: consider setlogmask(3) to filter messages
const char *fmt;
+ char buffer[BUFSIZ];
va_list va;
- va_start(va, funct);
- fmt = va_arg(va, const char*);
-
- if (fmt == NULL) // sanity check
- FatalEx("Log", "Format string is NULL");
// Don't print the message unless we need to
if (level > g_options.verbosity)
return;
+ va_start(va, line);
+ fmt = va_arg(va, const char*);
+
+ if (fmt == NULL) // sanity check
+ Fatal("Format string is NULL");
+
+ vsnprintf(buffer, BUFSIZ, fmt, va);
+ va_end(va);
+
if (funct == NULL)
funct = unspecified_funct;
switch (level)
{
case LOGERR:
+ level = LOG_ERR;
severity = "ERROR";
break;
case LOGWARN:
+ level = LOG_WARNING;
severity = "WARNING";
break;
case LOGNOTE:
+ level = LOG_NOTICE;
severity = "NOTICE";
break;
case LOGINFO:
+ level = LOG_INFO;
severity = "INFO";
break;
default:
+ level = LOG_DEBUG;
severity = "DEBUG";
break;
}
- // Print: Program name, PID, severity string, function name first
- fprintf(stderr, "%s [%d] : %s : %s - ", g_options.program, getpid(), severity, funct);
-
- // Then pass additional arguments with the format string to vfprintf for printing
- vfprintf(stderr, fmt, va);
- va_end(va);
-
- // End log messages with a newline
- fprintf(stderr, "\n");
+ syslog(level, "%s: %s (%s:%d) - %s", severity, funct, file, line, buffer);
}
/**
* Handle a Fatal error in the program by printing a message and exiting the program
* CALLING THIS FUNCTION WILL CAUSE THE PROGAM TO EXIT
* @param funct - Name of the calling function
+ * @param file - Name of the source file containing the calling function
+ * @param line - Line in the source file at which Fatal is called
* @param fmt - A format string
* @param ... - Arguments to be printed according to the format string
*/
-void FatalEx(const char * funct, ...)
+void FatalEx(const char * funct, const char * file, int line, ...)
{
const char *fmt;
+ char buffer[BUFSIZ];
va_list va;
- va_start(va, funct);
+ va_start(va, line);
fmt = va_arg(va, const char*);
if (fmt == NULL)
{
// Fatal error in the Fatal function.
// (This really shouldn't happen unless someone does something insanely stupid)
- FatalEx("Fatal", "Format string is NULL");
+ Fatal("Format string is NULL");
return; // Should never get here
}
+ vsnprintf(buffer, BUFSIZ, fmt,va);
+ va_end(va);
+
if (funct == NULL)
funct = unspecified_funct;
- fprintf(stderr, "%s [%d] : %s : FATAL - ", g_options.program, getpid(), funct);
-
- vfprintf(stderr, fmt, va);
- va_end(va);
- fprintf(stderr, "\n");
+ syslog(LOG_CRIT, "FATAL: %s (%s:%d) - %s", funct, file, line, buffer);
exit(EXIT_FAILURE);
}