Added micro-logging framework

This patch adds small subset of logging functions and removes all
calls to perror() and substitutes them with hopefully more informative
calls using strerror().

Makefile

@@ -9,7 +9,7 @@ MANDIR  = $(PREFIX)/share/man
 
 CFLAGS  = -O2 -g -std=c99 -fno-strict-aliasing -Wall -W -D_GNU_SOURCE -I/usr/local/include
 LDFLAGS = -lssl -lcrypto -lev -L/usr/local/lib
-OBJS    = stud.o ringbuffer.o configuration.o
+OBJS    = stud.o ringbuffer.o configuration.o log.o
 
 all: realall
 

configuration.c

@@ -9,6 +9,7 @@
 #include <errno.h>
 #include <stdarg.h>
 #include <stdlib.h>
+#include <libgen.h>
 #include <ctype.h>
 #include <unistd.h>
 #include <getopt.h>
@@ -19,8 +20,10 @@
 #include <sys/stat.h>
 #include <syslog.h>
 
+#include "stud.h"
 #include "configuration.h"
 #include "version.h"
+#include "log.h"
 
 #define ADDR_LEN 150
 #define PORT_LEN 6
@@ -42,10 +45,14 @@
 #define CFG_SYSLOG "syslog"
 #define CFG_SYSLOG_FACILITY "syslog-facility"
 #define CFG_PARAM_SYSLOG_FACILITY 11015
+#define CFG_LOG_LEVEL "log-level"
+#define CFG_PARAM_LOG_LEVEL 11016
+#define CFG_PARAM_INSTANCE_NAME 11017
 #define CFG_DAEMON "daemon"
 #define CFG_WRITE_IP "write-ip"
 #define CFG_WRITE_PROXY "write-proxy"
 #define CFG_PEM_FILE "pem-file"
+#define CFG_INSTANCE_NAME "instance-name"
 
 #ifdef USE_SHARED_CACHE
   #define CFG_SHARED_CACHE "shared-cache"
@@ -90,16 +97,6 @@ char * config_error_get (void) {
   return error_buf;
 }
 
-void config_die (char *fmt, ...) {
-  va_list args;
-  va_start(args, fmt);
-  vfprintf(stderr, fmt, args);
-  va_end(args);
-  fprintf(stderr, "\n");
-
-  exit(1);
-}
-
 stud_config * config_new (void) {
   stud_config *r = NULL;
   r = malloc(sizeof(stud_config));
@@ -138,9 +135,9 @@ stud_config * config_new (void) {
   r->SHCUPD_MCASTTTL    = NULL;
 #endif
 
-  r->QUIET              = 0;
   r->SYSLOG             = 0;
   r->SYSLOG_FACILITY    = LOG_DAEMON;
+  r->LOG_LEVEL          = log_str2level(NULL);
   r->TCP_KEEPALIVE_TIME = 3600;
   r->DAEMONIZE          = 0;
   r->PREFER_SERVER_CIPHERS = 0;
@@ -619,7 +616,7 @@ void config_param_validate (char *k, char *v, stud_config *cfg, char *file, int
     }
   }
   else if (strcmp(k, CFG_QUIET) == 0) {
-    r = config_param_val_bool(v, &cfg->QUIET);
+    cfg->LOG_LEVEL = LOG_ERR;
   }
   else if (strcmp(k, CFG_SYSLOG) == 0) {
     r = config_param_val_bool(v, &cfg->SYSLOG);
@@ -665,6 +662,10 @@ void config_param_validate (char *k, char *v, stud_config *cfg, char *file, int
       r = 0;
     }
   }
+  else if (strcmp(k, CFG_LOG_LEVEL) == 0) {
+    cfg->LOG_LEVEL = log_str2level(v);
+    printf("Parsing: %s => %s => %d\n", k, v, cfg->LOG_LEVEL);
+  }
   else if (strcmp(k, CFG_DAEMON) == 0) {
     r = config_param_val_bool(v, &cfg->DAEMONIZE);
   }
@@ -687,6 +688,9 @@ void config_param_validate (char *k, char *v, stud_config *cfg, char *file, int
         config_assign_str(&cfg->CERT_FILE, v);
     }
   }
+  else if (strcmp(k, CFG_INSTANCE_NAME) == 0) {
+    stud_instance_name(v);
+  }
   else {
     fprintf(
       stderr,
@@ -696,17 +700,19 @@ void config_param_validate (char *k, char *v, stud_config *cfg, char *file, int
   }
 
   if (! r) {
-    if (file != NULL)
-      config_die("Error in configuration file '%s', line %d: %s\n", file, line, config_error_get()); 
-    else
-      config_die("Invalid parameter '%s': %s", k, config_error_get());
+    if (file != NULL) {
+      die("Error in configuration file '%s', line %d: %s\n", file, line, config_error_get()); 
+    } else {
+      die("Invalid parameter '%s': %s", k, config_error_get());
+    }
   }
 }
 
 #ifndef NO_CONFIG_FILE
 int config_file_parse (char *file, stud_config *cfg) {
-  if (cfg == NULL)
-    config_die("Undefined stud options; THIS IS A BUG!\n");
+  if (cfg == NULL) {
+    die("Undefined stud options; THIS IS A BUG!\n");
+  }
 
   char line[CONFIG_BUF_SIZE];
   FILE *fd = NULL;
@@ -717,8 +723,25 @@ int config_file_parse (char *file, stud_config *cfg) {
   } else {
     fd = fopen(file, "r");
   }
-  if (fd == NULL)
-      config_die("Unable to open configuration file '%s': %s\n", file, strerror(errno));
+  if (fd == NULL) {
+      die("Unable to open configuration file '%s': %s\n", file, strerror(errno));
+  }
+
+  // assign stud instance name
+  char *bn = strdup(basename(file));
+  if (bn != NULL) {
+    char *ptr = bn + strlen(bn);
+    while (ptr > bn) {
+      if (*ptr == '.') {
+        *ptr = '\0';
+        break;
+      }
+      ptr--;
+    }
+    str_trim(bn);
+    stud_instance_name(bn);
+    free(bn);
+  }
 
   // read config
   int i = 0;
@@ -737,8 +760,6 @@ int config_file_parse (char *file, stud_config *cfg) {
     if (val == NULL) continue;
     str_trim(val);
 
-    // printf("File '%s', line %d, key: '%s', value: '%s'\n", file, i, key, val);
-
     // validate configuration key => value
     config_param_validate(key, val, cfg, file, i);
   }
@@ -894,6 +915,8 @@ void config_print_usage_fd (char *prog, stud_config *cfg, FILE *out) {
   fprintf(out, "  -q  --quiet                Be quiet; emit only error messages\n");
   fprintf(out, "  -s  --syslog               Send log message to syslog in addition to stderr/stdout\n");
   fprintf(out, "  --syslog-facility=FACILITY Syslog facility to use (Default: \"%s\")\n", config_disp_log_facility(cfg->SYSLOG_FACILITY));
+  fprintf(out, "      --log-level=NAME       Log level (Default: \"%s\")\n", config_disp_str(log_level2str(cfg->LOG_LEVEL)));
+  fprintf(out, "      --instance-name        Instance name (Default: \"%s\")\n", config_disp_str(stud_instance_name(NULL)));
   fprintf(out, "\n");
   fprintf(out, "OTHER OPTIONS:\n");
   fprintf(out, "      --daemon               Fork into background and become a daemon (Default: %s)\n", config_disp_bool(cfg->DAEMONIZE));
@@ -1044,12 +1067,6 @@ void config_print_default (FILE *fd, stud_config *cfg) {
   fprintf(fd, FMT_QSTR, CFG_GROUP, config_disp_gid(cfg->GID));
   fprintf(fd, "\n");
 
-  fprintf(fd, "# Quiet execution, report only error messages\n");
-  fprintf(fd, "#\n");
-  fprintf(fd, "# type: boolean\n");
-  fprintf(fd, FMT_STR, CFG_QUIET, config_disp_bool(cfg->QUIET));
-  fprintf(fd, "\n");
-
   fprintf(fd, "# Use syslog for logging\n");
   fprintf(fd, "#\n");
   fprintf(fd, "# type: boolean\n");
@@ -1062,6 +1079,17 @@ void config_print_default (FILE *fd, stud_config *cfg) {
   fprintf(fd, FMT_QSTR, CFG_SYSLOG_FACILITY, config_disp_log_facility(cfg->SYSLOG_FACILITY));
   fprintf(fd, "\n");
 
+  fprintf(fd, "# Log level\n");
+  fprintf(fd, "# Available levels: fatal, error, warning, notice, info, debug\n");
+  fprintf(fd, "# type: string\n");
+  fprintf(fd, FMT_QSTR, CFG_LOG_LEVEL, config_disp_str(log_level2str(cfg->LOG_LEVEL)));
+  fprintf(fd, "\n");
+
+  fprintf(fd, "# Instance name (used for syslog ident)\n");
+  fprintf(fd, "# type: string\n");
+  fprintf(fd, FMT_QSTR, CFG_INSTANCE_NAME, config_disp_str(stud_instance_name(NULL)));
+  fprintf(fd, "\n");
+
   fprintf(fd, "# Run as daemon\n");
   fprintf(fd, "#\n");
   fprintf(fd, "# type: boolean\n");
@@ -1127,6 +1155,8 @@ void config_parse_cli(int argc, char **argv, stud_config *cfg) {
     { CFG_QUIET, 0, NULL, 'q' },
     { CFG_SYSLOG, 0, NULL, 's' },
     { CFG_SYSLOG_FACILITY, 1, NULL, CFG_PARAM_SYSLOG_FACILITY },
+    { CFG_LOG_LEVEL, 1, NULL, CFG_PARAM_LOG_LEVEL },
+    { CFG_INSTANCE_NAME, 1, NULL, CFG_PARAM_INSTANCE_NAME },
     { CFG_DAEMON, 0, &cfg->DAEMONIZE, 1 },
     { CFG_WRITE_IP, 0, &cfg->WRITE_IP_OCTET, 1 },
     { CFG_WRITE_PROXY, 0, &cfg->WRITE_PROXY_LINE, 1 },
@@ -1153,8 +1183,9 @@ void config_parse_cli(int argc, char **argv, stud_config *cfg) {
         break;
 #ifndef NO_CONFIG_FILE
       case CFG_PARAM_CFGFILE:
-        if (!config_file_parse(optarg, cfg))
-          config_die("%s", config_error_get());
+        if (!config_file_parse(optarg, cfg)) {
+          die("%s", config_error_get());
+        }
         break;
       case CFG_PARAM_DEFCFG:
         config_print_default(stdout, cfg);
@@ -1164,6 +1195,9 @@ void config_parse_cli(int argc, char **argv, stud_config *cfg) {
       case CFG_PARAM_SYSLOG_FACILITY:
         config_param_validate(CFG_SYSLOG_FACILITY, optarg, cfg, NULL, 0);
         break;
+      case CFG_PARAM_LOG_LEVEL:
+        config_param_validate(CFG_LOG_LEVEL, optarg, cfg, NULL, 0);
+        break;
       case 'c':
         config_param_validate(CFG_CIPHERS, optarg, cfg, NULL, 0);
         break;
@@ -1212,7 +1246,10 @@ void config_parse_cli(int argc, char **argv, stud_config *cfg) {
         config_param_validate(CFG_GROUP, optarg, cfg, NULL, 0);
         break;
       case 'q':
-        config_param_validate(CFG_QUIET, CFG_BOOL_ON, cfg, NULL, 0);
+        config_param_validate(CFG_LOG_LEVEL, LSTR_ERR, cfg, NULL, 0);
+        break;
+      case CFG_PARAM_INSTANCE_NAME:
+        config_param_validate(CFG_INSTANCE_NAME, optarg, cfg, NULL, 0);
         break;
       case 's':
         config_param_validate(CFG_SYSLOG, CFG_BOOL_ON, cfg, NULL, 0);
@@ -1230,47 +1267,50 @@ void config_parse_cli(int argc, char **argv, stud_config *cfg) {
         break;
 
       default:
-        config_die("Invalid command line parameters. Run %s --help for instructions.", basename(argv[0]));
+        die("Invalid command line parameters. Run %s --help for instructions.", basename(argv[0]));
     }
   }
 
   prog = argv[0];
 
-  if (tls && ssl)
-    config_die("Options --tls and --ssl are mutually exclusive.");
+  if (tls && ssl) {
+    die("Options --tls and --ssl are mutually exclusive.");
+  }
   else {
     if (ssl)
       cfg->ETYPE = ENC_SSL;
     else if (tls)
       cfg->ETYPE = ENC_TLS;
   }
 
-  if (cfg->WRITE_IP_OCTET && cfg->WRITE_PROXY_LINE)
-    config_die("Options --write-ip and --write-proxy are mutually exclusive.");
+  if (cfg->WRITE_IP_OCTET && cfg->WRITE_PROXY_LINE) {
+    die("Options --write-ip and --write-proxy are mutually exclusive.");
+  }
 
   if (cfg->DAEMONIZE) {
     cfg->SYSLOG = 1;
-    cfg->QUIET = 1;
   }
 
 #ifdef USE_SHARED_CACHE
-  if (cfg->SHCUPD_IP != NULL && ! cfg->SHARED_CACHE)
-    config_die("Shared cache update listener is defined, but shared cache is disabled.");
+  if (cfg->SHCUPD_IP != NULL && ! cfg->SHARED_CACHE) {
+    die("Shared cache update listener is defined, but shared cache is disabled.");
+  }
 #endif
 
   // argv leftovers, do we have pem file as an argument?
   argc -= optind;
   argv += optind;
   if (argv != NULL && argv[0] != NULL)
     config_param_validate(CFG_PEM_FILE, argv[0], cfg, NULL, 0);
-  else if (cfg->CERT_FILE == NULL || strlen(cfg->CERT_FILE) < 1)
-    config_die("No x509 certificate PEM file specified!");
+  else if (cfg->CERT_FILE == NULL || strlen(cfg->CERT_FILE) < 1) {
+    fail("No x509 certificate PEM file specified!");
+  }
 
   // was this only a test?
   if (test_only) {
     fprintf(stderr, "Trying to initialize SSL context with certificate '%s'\n", cfg->CERT_FILE);
     if (! init_openssl())
-      config_die("Error initializing OpenSSL.");
+      die("Error initializing OpenSSL.");
     printf("%s configuration looks ok.\n", basename(prog));
     exit(0);
   }

configuration.h

@@ -51,9 +51,9 @@ struct __stud_config {
     char *SHCUPD_MCASTIF;
     char *SHCUPD_MCASTTTL;
 #endif
-    int QUIET;
     int SYSLOG;
     int SYSLOG_FACILITY;
+    int LOG_LEVEL;
     int TCP_KEEPALIVE_TIME;
     int DAEMONIZE;
     int PREFER_SERVER_CIPHERS;