refactor: Move Logger out of Messenger into Tox.

So it can be used across other pieces we plug together in `tox_new`.

Author: iphydf

.clang-tidy

@@ -42,7 +42,7 @@ CheckOptions:
   - key:             concurrency-mt-unsafe.FunctionSet
     value:           posix
   - key:             readability-function-cognitive-complexity.Threshold
-    value:           153  # TODO(iphydf): Decrease. tox_new is the highest at the moment.
+    value:           159  # TODO(iphydf): Decrease. tox_new_system is the highest at the moment.
   - key:             cppcoreguidelines-avoid-do-while.IgnoreMacros
     value:           true
   - key:             readability-simplify-boolean-expr.SimplifyDeMorgan

testing/Messenger_test.c

@@ -102,21 +102,37 @@ int main(int argc, char *argv[])
         exit(0);
     }
 
-    Messenger_Options options = {0};
+    Messenger_Options options = {nullptr};
     options.ipv6enabled = ipv6enabled;
+
+    Logger *logger = logger_new(mem);
+
+    if (logger == nullptr) {
+        fputs("Failed to allocate logger datastructure\n", stderr);
+        mono_time_free(mem, mono_time);
+        exit(1);
+    }
+
+    options.log = logger;
+
     Messenger_Error err;
     m = new_messenger(mono_time, mem, os_random(), os_network(), &options, &err);
 
     if (!m) {
         fprintf(stderr, "Failed to allocate messenger datastructure: %u\n", err);
-        exit(0);
+        logger_kill(logger);
+        mono_time_free(mem, mono_time);
+        exit(1);
     }
 
     if (argc == argvoffset + 4) {
         const long int port_conv = strtol(argv[argvoffset + 2], nullptr, 10);
 
         if (port_conv <= 0 || port_conv > UINT16_MAX) {
             printf("Failed to convert \"%s\" into a valid port. Exiting...\n", argv[argvoffset + 2]);
+            kill_messenger(m);
+            logger_kill(logger);
+            mono_time_free(mem, mono_time);
             exit(1);
         }
 
@@ -131,6 +147,9 @@ int main(int argc, char *argv[])
 
         if (!res) {
             printf("Failed to convert \"%s\" into an IP address. Exiting...\n", argv[argvoffset + 1]);
+            kill_messenger(m);
+            logger_kill(logger);
+            mono_time_free(mem, mono_time);
             exit(1);
         }
     }
@@ -157,6 +176,9 @@ int main(int argc, char *argv[])
     printf("\nEnter the address of the friend you wish to add (38 bytes HEX format):\n");
 
     if (!fgets(temp_hex_id, sizeof(temp_hex_id), stdin)) {
+        kill_messenger(m);
+        logger_kill(logger);
+        mono_time_free(mem, mono_time);
         exit(0);
     }
 
@@ -186,6 +208,8 @@ int main(int argc, char *argv[])
         if (file == nullptr) {
             printf("Failed to open file %s\n", filename);
             kill_messenger(m);
+            logger_kill(logger);
+            mono_time_free(mem, mono_time);
             return 1;
         }
 
@@ -195,6 +219,8 @@ int main(int argc, char *argv[])
             fputs("Failed to allocate memory\n", stderr);
             fclose(file);
             kill_messenger(m);
+            logger_kill(logger);
+            mono_time_free(mem, mono_time);
             return 1;
         }
 
@@ -205,6 +231,8 @@ int main(int argc, char *argv[])
             free(buffer);
             fclose(file);
             kill_messenger(m);
+            logger_kill(logger);
+            mono_time_free(mem, mono_time);
             return 1;
         }
 

toxcore/Messenger.c

@@ -3394,6 +3394,7 @@ Messenger *new_messenger(Mono_Time *mono_time, const Memory *mem, const Random *
         return nullptr;
     }
 
+    m->log = options->log;
     m->mono_time = mono_time;
     m->mem = mem;
     m->rng = rng;
@@ -3409,16 +3410,6 @@ Messenger *new_messenger(Mono_Time *mono_time, const Memory *mem, const Random *
     }
     m->fr = fr;
 
-    Logger *log = logger_new(mem);
-    if (log == nullptr) {
-        friendreq_kill(m->fr);
-        mem_delete(mem, m);
-        return nullptr;
-    }
-    m->log = log;
-
-    logger_callback_log(m->log, options->log_callback, options->log_context, options->log_user_data);
-
     unsigned int net_err = 0;
 
     if (!options->udp_disabled && options->proxy_info.proxy_type != TCP_PROXY_NONE) {
@@ -3444,7 +3435,6 @@ Messenger *new_messenger(Mono_Time *mono_time, const Memory *mem, const Random *
             *error = MESSENGER_ERROR_PORT;
         }
 
-        logger_kill(m->log);
         mem_delete(mem, m);
         return nullptr;
     }
@@ -3454,7 +3444,6 @@ Messenger *new_messenger(Mono_Time *mono_time, const Memory *mem, const Random *
     if (dht == nullptr) {
         kill_networking(m->net);
         friendreq_kill(m->fr);
-        logger_kill(m->log);
         mem_delete(mem, m);
         return nullptr;
     }
@@ -3466,7 +3455,6 @@ Messenger *new_messenger(Mono_Time *mono_time, const Memory *mem, const Random *
         kill_dht(m->dht);
         kill_networking(m->net);
         friendreq_kill(m->fr);
-        logger_kill(m->log);
         mem_delete(mem, m);
         return nullptr;
     }
@@ -3481,7 +3469,6 @@ Messenger *new_messenger(Mono_Time *mono_time, const Memory *mem, const Random *
         kill_dht(m->dht);
         kill_networking(m->net);
         friendreq_kill(m->fr);
-        logger_kill(m->log);
         mem_delete(mem, m);
         return nullptr;
     }
@@ -3496,7 +3483,6 @@ Messenger *new_messenger(Mono_Time *mono_time, const Memory *mem, const Random *
         kill_dht(m->dht);
         kill_networking(m->net);
         friendreq_kill(m->fr);
-        logger_kill(m->log);
         mem_delete(mem, m);
         return nullptr;
     }
@@ -3534,7 +3520,6 @@ Messenger *new_messenger(Mono_Time *mono_time, const Memory *mem, const Random *
         kill_dht(m->dht);
         kill_networking(m->net);
         friendreq_kill(m->fr);
-        logger_kill(m->log);
         mem_delete(mem, m);
         return nullptr;
     }
@@ -3561,7 +3546,6 @@ Messenger *new_messenger(Mono_Time *mono_time, const Memory *mem, const Random *
         kill_dht(m->dht);
         kill_networking(m->net);
         friendreq_kill(m->fr);
-        logger_kill(m->log);
         mem_delete(mem, m);
         return nullptr;
     }
@@ -3588,7 +3572,6 @@ Messenger *new_messenger(Mono_Time *mono_time, const Memory *mem, const Random *
             kill_dht(m->dht);
             kill_networking(m->net);
             friendreq_kill(m->fr);
-            logger_kill(m->log);
             mem_delete(mem, m);
 
             if (error != nullptr) {
@@ -3652,7 +3635,6 @@ void kill_messenger(Messenger *m)
     friendreq_kill(m->fr);
 
     mem_delete(m->mem, m->options.state_plugins);
-    logger_kill(m->log);
     mem_delete(m->mem, m);
 }
 

toxcore/Messenger.h

@@ -74,6 +74,8 @@ typedef struct Messenger_State_Plugin {
 } Messenger_State_Plugin;
 
 typedef struct Messenger_Options {
+    Logger *_Nonnull log;
+
     bool ipv6enabled;
     bool udp_disabled;
     TCP_Proxy_Info proxy_info;
@@ -85,10 +87,6 @@ typedef struct Messenger_Options {
     bool dht_announcements_enabled;
     bool groups_persistence_enabled;
 
-    logger_cb *_Nullable log_callback;
-    void *_Nullable log_context;
-    void *_Nullable log_user_data;
-
     Messenger_State_Plugin *_Nullable state_plugins;
     uint8_t state_plugins_length;
 

toxcore/tox.c

@@ -674,7 +674,7 @@ static Tox *tox_new_system(const struct Tox_Options *_Nullable options, Tox_Err_
     const Network *const ns = sys->ns;
     const Memory *const mem = sys->mem;
 
-    Messenger_Options m_options = {false};
+    Messenger_Options m_options = {nullptr};
 
     m_options.dns_enabled = !tox_options_get_experimental_disable_dns(opts);
 
@@ -736,9 +736,21 @@ static Tox *tox_new_system(const struct Tox_Options *_Nullable options, Tox_Err_
     }
 
     tox->log_callback = tox_options_get_log_callback(opts);
-    m_options.log_callback = tox_log_handler;
-    m_options.log_context = tox;
-    m_options.log_user_data = tox_options_get_log_user_data(opts);
+
+    Logger *log = logger_new(mem);
+
+    if (log == nullptr) {
+        SET_ERROR_PARAMETER(error, TOX_ERR_NEW_MALLOC);
+        mem_delete(mem, tox);
+        tox_options_free(default_options);
+        return nullptr;
+    }
+
+    tox->log = log;
+
+    m_options.log = tox->log;
+
+    logger_callback_log(tox->log, tox_log_handler, tox, tox_options_get_log_user_data(opts));
 
     switch (tox_options_get_proxy_type(opts)) {
         case TOX_PROXY_TYPE_HTTP: {
@@ -758,6 +770,7 @@ static Tox *tox_new_system(const struct Tox_Options *_Nullable options, Tox_Err_
 
         default: {
             SET_ERROR_PARAMETER(error, TOX_ERR_NEW_PROXY_BAD_TYPE);
+            logger_kill(tox->log);
             mem_delete(mem, tox);
             tox_options_free(default_options);
             return nullptr;
@@ -769,6 +782,7 @@ static Tox *tox_new_system(const struct Tox_Options *_Nullable options, Tox_Err_
     if (m_options.proxy_info.proxy_type != TCP_PROXY_NONE) {
         if (tox_options_get_proxy_port(opts) == 0) {
             SET_ERROR_PARAMETER(error, TOX_ERR_NEW_PROXY_BAD_PORT);
+            logger_kill(tox->log);
             mem_delete(mem, tox);
             tox_options_free(default_options);
             return nullptr;
@@ -787,6 +801,7 @@ static Tox *tox_new_system(const struct Tox_Options *_Nullable options, Tox_Err_
                 || !addr_resolve_or_parse_ip(ns, mem, proxy_host, &m_options.proxy_info.ip_port.ip, nullptr, dns_enabled)) {
             SET_ERROR_PARAMETER(error, TOX_ERR_NEW_PROXY_BAD_HOST);
             // TODO(irungentoo): TOX_ERR_NEW_PROXY_NOT_FOUND if domain.
+            logger_kill(tox->log);
             mem_delete(mem, tox);
             tox_options_free(default_options);
             return nullptr;
@@ -799,6 +814,7 @@ static Tox *tox_new_system(const struct Tox_Options *_Nullable options, Tox_Err_
 
     if (temp_mono_time == nullptr) {
         SET_ERROR_PARAMETER(error, TOX_ERR_NEW_MALLOC);
+        logger_kill(tox->log);
         mem_delete(mem, tox);
         tox_options_free(default_options);
         return nullptr;
@@ -810,6 +826,8 @@ static Tox *tox_new_system(const struct Tox_Options *_Nullable options, Tox_Err_
 
         if (mutex == nullptr) {
             SET_ERROR_PARAMETER(error, TOX_ERR_NEW_MALLOC);
+            mono_time_free(mem, tox->mono_time);
+            logger_kill(tox->log);
             mem_delete(mem, tox);
             tox_options_free(default_options);
             return nullptr;
@@ -849,6 +867,7 @@ static Tox *tox_new_system(const struct Tox_Options *_Nullable options, Tox_Err_
         }
 
         mem_delete(mem, tox->mutex);
+        logger_kill(tox->log);
         mem_delete(mem, tox);
         tox_options_free(default_options);
         return nullptr;
@@ -868,6 +887,7 @@ static Tox *tox_new_system(const struct Tox_Options *_Nullable options, Tox_Err_
         }
 
         mem_delete(mem, tox->mutex);
+        logger_kill(tox->log);
         mem_delete(mem, tox);
 
         SET_ERROR_PARAMETER(error, TOX_ERR_NEW_MALLOC);
@@ -888,6 +908,7 @@ static Tox *tox_new_system(const struct Tox_Options *_Nullable options, Tox_Err_
         }
 
         mem_delete(mem, tox->mutex);
+        logger_kill(tox->log);
         mem_delete(mem, tox);
 
         SET_ERROR_PARAMETER(error, TOX_ERR_NEW_LOAD_BAD_FORMAT);
@@ -990,6 +1011,7 @@ void tox_kill(Tox *tox)
     LOGGER_ASSERT(tox->m->log, tox->toxav_object == nullptr, "Attempted to kill tox while toxav is still alive");
     kill_groupchats(tox->m->conferences_object);
     kill_messenger(tox->m);
+    logger_kill(tox->log);
     mono_time_free(tox->sys.mem, tox->mono_time);
     tox_unlock(tox);
 

toxcore/tox_struct.h

@@ -18,6 +18,7 @@ extern "C" {
 #endif
 
 struct Tox {
+    struct Logger *_Nonnull log;
     struct Messenger *_Nonnull m;
     Mono_Time *_Nonnull mono_time;
     Tox_System sys;