Moved logging functins to their own module

Author: codepr

CMakeLists.txt

@@ -2,6 +2,7 @@ cmake_minimum_required(VERSION 2.8)
 
 project(sol)
 set (VERSION 0.17.1)
+set (CMAKE_EXPORT_COMPILE_COMMANDS ON)
 
 OPTION(DEBUG "add debug flags" OFF)
 
@@ -13,7 +14,7 @@ set(EXECUTABLE_OUTPUT_PATH ${CMAKE_BINARY_DIR})
 include_directories(include)
 file(GLOB SOURCES src/*.c)
 file(GLOB TEST src/hashtable.c src/bst.c src/config.c src/list.c src/trie.c
-    src/util.c src/iterator.c tests/*.c)
+    src/util.c src/iterator.c src/logging.c tests/*.c)
 
 set(AUTHOR "Andrea Giacomo Baldan")
 set(LICENSE "BSD2 license")

src/config.c

@@ -35,6 +35,7 @@
 #include "util.h"
 #include "config.h"
 #include "network.h"
+#include "logging.h"
 
 /* The main configuration structure */
 static struct config config;

src/config.h

@@ -28,6 +28,7 @@
 #ifndef CONFIG_H
 #define CONFIG_H
 
+#include <stdbool.h>
 #include "uthash.h"
 
 // Eventloop backend check

src/handlers.c

@@ -27,9 +27,9 @@
 
 #include <stdio.h>
 #include "mqtt.h"
-#include "util.h"
 #include "config.h"
 #include "server.h"
+#include "logging.h"
 #include "sol_internal.h"
 #include "handlers.h"
 

src/logging.c

@@ -0,0 +1,84 @@
+/* BSD 2-Clause License
+ *
+ * Copyright (c) 2020, Andrea Giacomo Baldan All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * * Redistributions of source code must retain the above copyright notice,
+ * this list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following disclaimer in the documentation
+ * and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#include <time.h>
+#include <stdio.h>
+#include <stdarg.h>
+#include <string.h>
+#include <assert.h>
+#include "logging.h"
+
+#define MAX_LOG_SIZE 120
+
+static FILE *fh = NULL;
+static int logging_level = DEBUG;
+
+void sol_log_init(const char *file, int level) {
+    if (!file) return;
+    fh = fopen(file, "a+");
+    logging_level = level;
+    if (!fh)
+        printf("%lu * WARNING: Unable to open file %s\n",
+               (unsigned long) time(NULL), file);
+}
+
+void sol_log_close(void) {
+    if (fh) {
+        fflush(fh);
+        fclose(fh);
+    }
+}
+
+void sol_log(int level, const char *fmt, ...) {
+
+    if (level < logging_level)
+        return;
+
+    assert(fmt);
+
+    va_list ap;
+    char msg[MAX_LOG_SIZE + 4];
+
+    va_start(ap, fmt);
+    vsnprintf(msg, sizeof(msg), fmt, ap);
+    va_end(ap);
+
+    /* Truncate message too long and copy 3 bytes to make space for 3 dots */
+    memcpy(msg + MAX_LOG_SIZE, "...", 3);
+    msg[MAX_LOG_SIZE + 3] = '\0';
+
+    // Open two handler, one for standard output and a second for the
+    // persistent log file
+    FILE *fp = stdout;
+
+    if (!fp)
+        return;
+
+    fprintf(fp, "%lu %s\n", (unsigned long) time(NULL), msg);
+    if (fh)
+        fprintf(fh, "%lu %s\n", (unsigned long) time(NULL), msg);
+}

src/logging.h

@@ -0,0 +1,47 @@
+/* BSD 2-Clause License
+ *
+ * Copyright (c) 2020, Andrea Giacomo Baldan All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * * Redistributions of source code must retain the above copyright notice,
+ * this list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following disclaimer in the documentation
+ * and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#ifndef LOGGING_H
+#define LOGGING_H
+
+enum log_level { DEBUG, INFORMATION, WARNING, ERROR, FATAL };
+
+void sol_log_init(const char *, int);
+void sol_log_close(void);
+void sol_log(int, const char *, ...);
+
+#define log(...) sol_log( __VA_ARGS__ )
+#define log_debug(...) log(DEBUG, __VA_ARGS__)
+#define log_warning(...) log(WARNING, __VA_ARGS__)
+#define log_error(...) log(ERROR, __VA_ARGS__)
+#define log_info(...) log(INFORMATION, __VA_ARGS__)
+#define log_fatal(...) do {      \
+    log(FATAL, __VA_ARGS__);     \
+    exit(EXIT_FAILURE);             \
+} while(0);
+
+#endif

src/server.c

@@ -30,10 +30,10 @@
 #include <unistd.h>
 #include <pthread.h>
 #include "network.h"
-#include "util.h"
 #include "config.h"
 #include "sol_internal.h"
 #include "server.h"
+#include "logging.h"
 #include "handlers.h"
 #include "memorypool.h"
 #include "ev.h"
@@ -966,8 +966,8 @@ int start_server(const char *addr, const char *port) {
     server.authentications = NULL;
     server.pool = memorypool_new(BASE_CLIENTS_NUM, sizeof(struct client));
     if (!server.pool)
-        die("Failed to allocate %d sized memory pool for clients",
-            BASE_CLIENTS_NUM);
+        log_fatal("Failed to allocate %d sized memory pool for clients",
+                  BASE_CLIENTS_NUM);
     server.clients_map = NULL;
     server.sessions = NULL;
     server.wildcards = list_new(wildcard_destructor);

src/sol.c

@@ -33,6 +33,7 @@
 #include "util.h"
 #include "config.h"
 #include "server.h"
+#include "logging.h"
 
 // Stops epoll_wait loops by sending an event
 static void sigint_handler(int signum) {
@@ -115,7 +116,7 @@ int main (int argc, char **argv) {
     // Try to load a configuration, if found
     config_load(confpath);
 
-    sol_log_init(conf->logpath);
+    sol_log_init(conf->logpath, conf->loglevel);
 
     if (daemon == 1)
         daemonize();

src/util.c

@@ -1,6 +1,6 @@
 /* BSD 2-Clause License
  *
- * Copyright (c) 2019, Andrea Giacomo Baldan All rights reserved.
+ * Copyright (c) 2020, Andrea Giacomo Baldan All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are met:
@@ -40,53 +40,6 @@
 
 static atomic_size_t memory = ATOMIC_VAR_INIT(0);
 
-static FILE *fh = NULL;
-
-void sol_log_init(const char *file) {
-    if (!file) return;
-    fh = fopen(file, "a+");
-    if (!fh)
-        printf("%lu * WARNING: Unable to open file %s\n",
-               (unsigned long) time(NULL), file);
-}
-
-void sol_log_close(void) {
-    if (fh) {
-        fflush(fh);
-        fclose(fh);
-    }
-}
-
-void sol_log(int level, const char *fmt, ...) {
-
-    if (level < conf->loglevel)
-        return;
-
-    assert(fmt);
-
-    va_list ap;
-    char msg[MAX_LOG_SIZE + 4];
-
-    va_start(ap, fmt);
-    vsnprintf(msg, sizeof(msg), fmt, ap);
-    va_end(ap);
-
-    /* Truncate message too long and copy 3 bytes to make space for 3 dots */
-    memcpy(msg + MAX_LOG_SIZE, "...", 3);
-    msg[MAX_LOG_SIZE + 3] = '\0';
-
-    // Open two handler, one for standard output and a second for the
-    // persistent log file
-    FILE *fp = stdout;
-
-    if (!fp)
-        return;
-
-    fprintf(fp, "%lu %s\n", (unsigned long) time(NULL), msg);
-    if (fh)
-        fprintf(fh, "%lu %s\n", (unsigned long) time(NULL), msg);
-}
-
 /* Auxiliary function to check wether a string is an integer */
 bool is_integer(const char *string) {
     for (; *string; ++string)
@@ -326,15 +279,3 @@ long get_fh_soft_limit(void) {
     }
     return limit.rlim_cur;
 }
-
-void die(const char *msg, ...) {
-    va_list ap;
-    char error[MAX_LOG_SIZE];
-
-    va_start(ap, msg);
-    vsnprintf(error, sizeof(error), msg, ap);
-    va_end(ap);
-    fprintf(stderr, "%s: Out of memory\n", error);
-    fflush(stderr);
-    abort();
-}

src/util.h

@@ -1,6 +1,6 @@
 /* BSD 2-Clause License
  *
- * Copyright (c) 2019, Andrea Giacomo Baldan All rights reserved.
+ * Copyright (c) 2020, Andrea Giacomo Baldan All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are met:
@@ -33,22 +33,13 @@
 #include <stdint.h>
 #include <stdbool.h>
 
-#define MAX_LOG_SIZE 119
-
 #define SOL_PREFIX   "sol"
 
-enum log_level { DEBUG, INFORMATION, WARNING, ERROR, FATAL };
-
 bool is_integer(const char *);
 int parse_int(const char *);
 int number_len(size_t);
 void generate_random_id(char *);
 
-/* Logging */
-void sol_log_init(const char *);
-void sol_log_close(void);
-void sol_log(int, const char *, ...);
-
 /* Memory management */
 void *xmalloc(size_t);
 void *xcalloc(size_t, size_t);
@@ -59,22 +50,11 @@ char *xstrdup(const char *);
 char *remove_occur(char *, char);
 char *append_string(const char *, char *, size_t);
 bool check_passwd(const char *, const char *);
-void die(const char *, ...);
 
 size_t memory_used(void);
 
 long get_fh_soft_limit(void);
 
-#define log(...) sol_log( __VA_ARGS__ )
-#define log_debug(...) log(DEBUG, __VA_ARGS__)
-#define log_warning(...) log(WARNING, __VA_ARGS__)
-#define log_error(...) log(ERROR, __VA_ARGS__)
-#define log_info(...) log(INFORMATION, __VA_ARGS__)
-#define log_fatal(...) do {      \
-    log(FATAL, __VA_ARGS__);     \
-    exit(EXIT_FAILURE);             \
-} while(0);
-
 #define STREQ(s1, s2, len) strncasecmp(s1, s2, len) == 0 ? true : false
 
 #define container_of(ptr, type, field) \