From e91ab667862b9ce7a8d1d7dfd02e3b610f955de3 Mon Sep 17 00:00:00 2001 From: iphydf Date: Thu, 30 Jan 2025 16:20:50 +0000 Subject: [PATCH] refactor: Add file/line to tox-bootstrapd logging. Also, allow trace logging in bootstrapd (disabled by default, but enabled on the websockify docker image so we can debug things there). --- other/bootstrap_daemon/docker/Dockerfile | 45 +++---- .../docker/Dockerfile.dockerignore | 22 ++++ other/bootstrap_daemon/docker/build.sh | 12 ++ .../docker/tox-bootstrapd.sha256 | 2 +- .../src/command_line_arguments.c | 23 ++-- other/bootstrap_daemon/src/config.c | 112 +++++++++--------- other/bootstrap_daemon/src/log.c | 17 ++- other/bootstrap_daemon/src/log.h | 16 ++- .../bootstrap_daemon/src/log_backend_stdout.c | 37 +++++- .../bootstrap_daemon/src/log_backend_stdout.h | 2 +- .../bootstrap_daemon/src/log_backend_syslog.c | 7 +- .../bootstrap_daemon/src/log_backend_syslog.h | 2 +- other/bootstrap_daemon/src/tox-bootstrapd.c | 88 +++++++------- other/bootstrap_daemon/websocket/Dockerfile | 4 +- other/bootstrap_daemon/websocket/build.sh | 12 ++ .../bootstrap_daemon/websocket/entrypoint.sh | 2 +- .../websocket/tox-bootstrapd.conf | 21 ++++ other/docker/autotools/run | 2 +- other/docker/clang-tidy/run | 2 +- other/docker/compcert/run | 2 +- other/docker/coverage/run | 2 +- other/docker/cppcheck/run | 2 +- other/docker/goblint/run | 2 +- other/docker/infer/run | 2 +- other/docker/misra/run | 2 +- other/docker/rpm/run | 2 +- other/docker/slimcc/run | 2 +- other/docker/sources/{build => build.sh} | 0 other/docker/sparse/run | 2 +- other/docker/tcc/run | 2 +- other/docker/tokstyle/run | 2 +- 31 files changed, 295 insertions(+), 155 deletions(-) create mode 100644 other/bootstrap_daemon/docker/Dockerfile.dockerignore create mode 100755 other/bootstrap_daemon/docker/build.sh create mode 100755 other/bootstrap_daemon/websocket/build.sh create mode 100644 other/bootstrap_daemon/websocket/tox-bootstrapd.conf rename other/docker/sources/{build => build.sh} (100%) diff --git a/other/bootstrap_daemon/docker/Dockerfile b/other/bootstrap_daemon/docker/Dockerfile index 3d150e02f6..f3f8bf8163 100644 --- a/other/bootstrap_daemon/docker/Dockerfile +++ b/other/bootstrap_daemon/docker/Dockerfile @@ -1,6 +1,6 @@ ########################################################### # Builder image: we compile the code here (static build) -FROM alpine:3.19.0 AS build +FROM alpine:3.21.0 AS build RUN ["apk", "--no-cache", "add",\ "clang",\ @@ -26,33 +26,32 @@ COPY other/bootstrap_node_packets.[ch] other/ COPY other/DHT_bootstrap.c other/ COPY other/pkgconfig other/pkgconfig COPY other/rpm other/rpm -COPY testing/misc_tools.[ch] testing/ +COPY testing testing COPY toxcore toxcore COPY toxencryptsave toxencryptsave COPY third_party third_party COPY CMakeLists.txt so.version ./ COPY other/bootstrap_daemon/CMakeLists.txt other/bootstrap_daemon/CMakeLists.txt -COPY testing/CMakeLists.txt testing/CMakeLists.txt RUN CC=clang cmake -B_build -H. \ - -GNinja \ - -DCMAKE_C_FLAGS="-DTCP_SERVER_USE_EPOLL -fsanitize=alignment,return,returns-nonnull-attribute,vla-bound,unreachable,float-cast-overflow,null -fsanitize-trap=all -fstack-protector-all" \ - -DCMAKE_UNITY_BUILD=ON \ - -DCMAKE_BUILD_TYPE=Release \ - -DFULLY_STATIC=ON \ - -DMIN_LOGGER_LEVEL=DEBUG \ - -DBUILD_TOXAV=OFF \ - -DBOOTSTRAP_DAEMON=ON && \ - cmake --build _build --target install + -GNinja \ + -DCMAKE_C_FLAGS="-DTCP_SERVER_USE_EPOLL -fsanitize=alignment,return,returns-nonnull-attribute,vla-bound,unreachable,float-cast-overflow,null -fsanitize-trap=all -fstack-protector-all" \ + -DCMAKE_UNITY_BUILD=ON \ + -DCMAKE_BUILD_TYPE=Release \ + -DFULLY_STATIC=ON \ + -DMIN_LOGGER_LEVEL=TRACE \ + -DBUILD_TOXAV=OFF \ + -DBOOTSTRAP_DAEMON=ON \ + && cmake --build _build --target install # Verify checksum from dev-built binary, so we can be sure Docker Hub doesn't # mess with your binaries. COPY other/bootstrap_daemon/docker/tox-bootstrapd.sha256 other/bootstrap_daemon/docker/ ARG CHECK=sha256sum -RUN SHA256="$("$CHECK" /usr/local/bin/tox-bootstrapd)" && \ - ("$CHECK" -c other/bootstrap_daemon/docker/tox-bootstrapd.sha256 || \ - (echo "::error file=other/bootstrap_daemon/docker/tox-bootstrapd.sha256,line=1::$SHA256" && \ - false)) +RUN SHA256="$("$CHECK" /usr/local/bin/tox-bootstrapd)" \ + && ("$CHECK" -c other/bootstrap_daemon/docker/tox-bootstrapd.sha256 || \ + (echo "::error file=other/bootstrap_daemon/docker/tox-bootstrapd.sha256,line=1::$SHA256" \ + && false)) # Remove all the example bootstrap nodes from the config file. COPY other/bootstrap_daemon/tox-bootstrapd.conf other/bootstrap_daemon/ @@ -69,12 +68,14 @@ FROM debian:bookworm-slim COPY --from=build /usr/local/bin/tox-bootstrapd /usr/local/bin/ COPY --from=build /src/c-toxcore/other/bootstrap_daemon/tox-bootstrapd.conf /etc/tox-bootstrapd.conf -RUN useradd --home-dir /var/lib/tox-bootstrapd --create-home \ - --system --shell /sbin/nologin \ - --comment "Account to run the Tox DHT bootstrap daemon" \ - --user-group tox-bootstrapd && \ - chmod 644 /etc/tox-bootstrapd.conf && \ - chmod 700 /var/lib/tox-bootstrapd +RUN useradd \ + --home-dir /var/lib/tox-bootstrapd \ + --create-home \ + --system --shell /sbin/nologin \ + --comment "Account to run the Tox DHT bootstrap daemon" \ + --user-group tox-bootstrapd \ + && chmod 644 /etc/tox-bootstrapd.conf \ + && chmod 700 /var/lib/tox-bootstrapd WORKDIR /var/lib/tox-bootstrapd diff --git a/other/bootstrap_daemon/docker/Dockerfile.dockerignore b/other/bootstrap_daemon/docker/Dockerfile.dockerignore new file mode 100644 index 0000000000..369d49483c --- /dev/null +++ b/other/bootstrap_daemon/docker/Dockerfile.dockerignore @@ -0,0 +1,22 @@ +# Very selectively add files to the image, because we may have random stuff +# lying around. In particular, we don't need to rebuild the docker image when +# toxav changes or the Dockerfile changes down from the build. +**/* +!cmake/* +!other/bootstrap_daemon/bash-completion/* +!other/bootstrap_daemon/docker/get-nodes.py +!other/bootstrap_daemon/docker/tox-bootstrapd.sha256 +!other/bootstrap_daemon/src/* +!other/bootstrap_daemon/tox-bootstrapd.conf +!other/bootstrap_node_packets.[ch] +!other/DHT_bootstrap.c +!other/pkgconfig/* +!other/rpm/* +!testing/misc_tools.[ch] +!toxcore/**/* +!toxencryptsave/**/* +!third_party/cmp/cmp.[ch] +!CMakeLists.txt +!so.version +!other/bootstrap_daemon/CMakeLists.txt +!testing/CMakeLists.txt diff --git a/other/bootstrap_daemon/docker/build.sh b/other/bootstrap_daemon/docker/build.sh new file mode 100755 index 0000000000..2d489623dc --- /dev/null +++ b/other/bootstrap_daemon/docker/build.sh @@ -0,0 +1,12 @@ +#!/bin/sh + +set -eux -o pipefail + +GIT_ROOT="$(git rev-parse --show-toplevel)" +cd "$GIT_ROOT" + +docker build \ + -t toxchat/bootstrap-node \ + -f other/bootstrap_daemon/docker/Dockerfile \ + --build-arg CHECK=true \ + . diff --git a/other/bootstrap_daemon/docker/tox-bootstrapd.sha256 b/other/bootstrap_daemon/docker/tox-bootstrapd.sha256 index 33ace212cb..3ec20de73d 100644 --- a/other/bootstrap_daemon/docker/tox-bootstrapd.sha256 +++ b/other/bootstrap_daemon/docker/tox-bootstrapd.sha256 @@ -1 +1 @@ -9ec2993a28988bd147bf8f4f21a824c2fc5dbf7255e391b3ce517d337ebce5c1 /usr/local/bin/tox-bootstrapd +82b1733dea0f650607da7759ec79c827eede6f4646ac1c1afc832ca924e0e3c3 /usr/local/bin/tox-bootstrapd diff --git a/other/bootstrap_daemon/src/command_line_arguments.c b/other/bootstrap_daemon/src/command_line_arguments.c index 8181210d93..907567e5de 100644 --- a/other/bootstrap_daemon/src/command_line_arguments.c +++ b/other/bootstrap_daemon/src/command_line_arguments.c @@ -9,7 +9,7 @@ */ #include "command_line_arguments.h" -#include "global.h" +#include "global.h" // IWYU pragma: keep #include "log.h" #include "../../../toxcore/ccompat.h" @@ -26,7 +26,7 @@ static void print_help(void) // 2 space indent // Make sure all lines fit into 80 columns // Make sure options are listed in alphabetical order - log_write(LOG_LEVEL_INFO, + LOG_WRITE(LOG_LEVEL_INFO, "Usage: tox-bootstrapd [OPTION]... --config=FILE_PATH\n" "\n" "Options:\n" @@ -43,6 +43,7 @@ static void print_help(void) " Default option when no --log-backend is\n" " specified.\n" " stdout Writes log messages to stdout/stderr.\n" + " --trace Enable verbose network trace logging in toxcore.\n" " --version Print version information.\n"); } @@ -51,7 +52,7 @@ Cli_Status handle_command_line_arguments( bool *run_in_foreground) { if (argc < 2) { - log_write(LOG_LEVEL_ERROR, "Error: No arguments provided.\n\n"); + LOG_WRITE(LOG_LEVEL_ERROR, "Error: No arguments provided.\n\n"); print_help(); return CLI_STATUS_ERROR; } @@ -64,6 +65,7 @@ Cli_Status handle_command_line_arguments( {"help", no_argument, nullptr, 'h'}, {"log-backend", required_argument, nullptr, 'l'}, // optional, defaults to syslog {"version", no_argument, nullptr, 'v'}, + {"trace", no_argument, nullptr, 't'}, {nullptr, 0, nullptr, 0 } }; @@ -99,7 +101,7 @@ Cli_Status handle_command_line_arguments( *log_backend = LOG_BACKEND_STDOUT; log_backend_set = true; } else { - log_write(LOG_LEVEL_ERROR, "Error: Invalid BACKEND value for --log-backend option passed: %s\n\n", optarg); + LOG_WRITE(LOG_LEVEL_ERROR, "Error: Invalid BACKEND value for --log-backend option passed: %s\n\n", optarg); print_help(); return CLI_STATUS_ERROR; } @@ -107,16 +109,21 @@ Cli_Status handle_command_line_arguments( break; case 'v': - log_write(LOG_LEVEL_INFO, "Version: %lu\n", DAEMON_VERSION_NUMBER); + LOG_WRITE(LOG_LEVEL_INFO, "Version: %lu\n", DAEMON_VERSION_NUMBER); return CLI_STATUS_DONE; + case 't': + LOG_WRITE(LOG_LEVEL_INFO, "Enabling trace logging in toxcore.\n"); + log_enable_trace(true); + break; + case '?': - log_write(LOG_LEVEL_ERROR, "Error: Unrecognized option %s\n\n", argv[optind - 1]); + LOG_WRITE(LOG_LEVEL_ERROR, "Error: Unrecognized option %s\n\n", argv[optind - 1]); print_help(); return CLI_STATUS_ERROR; case ':': - log_write(LOG_LEVEL_ERROR, "Error: No argument provided for option %s\n\n", argv[optind - 1]); + LOG_WRITE(LOG_LEVEL_ERROR, "Error: No argument provided for option %s\n\n", argv[optind - 1]); print_help(); return CLI_STATUS_ERROR; } @@ -127,7 +134,7 @@ Cli_Status handle_command_line_arguments( } if (!cfg_file_path_set) { - log_write(LOG_LEVEL_ERROR, "Error: The required --config option wasn't specified\n\n"); + LOG_WRITE(LOG_LEVEL_ERROR, "Error: The required --config option wasn't specified\n\n"); print_help(); return CLI_STATUS_ERROR; } diff --git a/other/bootstrap_daemon/src/config.c b/other/bootstrap_daemon/src/config.c index 43ff1511fe..1ba697d4d3 100644 --- a/other/bootstrap_daemon/src/config.c +++ b/other/bootstrap_daemon/src/config.c @@ -41,8 +41,8 @@ static void parse_tcp_relay_ports_config(config_t *cfg, uint16_t **tcp_relay_por config_setting_t *ports_array = config_lookup(cfg, NAME_TCP_RELAY_PORTS); if (ports_array == nullptr) { - log_write(LOG_LEVEL_WARNING, "No '%s' setting in the configuration file.\n", NAME_TCP_RELAY_PORTS); - log_write(LOG_LEVEL_WARNING, "Using default '%s':\n", NAME_TCP_RELAY_PORTS); + LOG_WRITE(LOG_LEVEL_WARNING, "No '%s' setting in the configuration file.\n", NAME_TCP_RELAY_PORTS); + LOG_WRITE(LOG_LEVEL_WARNING, "Using default '%s':\n", NAME_TCP_RELAY_PORTS); const uint16_t default_ports[] = {DEFAULT_TCP_RELAY_PORTS}; @@ -53,13 +53,13 @@ static void parse_tcp_relay_ports_config(config_t *cfg, uint16_t **tcp_relay_por const size_t default_ports_count = sizeof(default_ports) / sizeof(*default_ports); for (size_t i = 0; i < default_ports_count; ++i) { - log_write(LOG_LEVEL_INFO, "Port #%zu: %u\n", i, default_ports[i]); + LOG_WRITE(LOG_LEVEL_INFO, "Port #%zu: %u\n", i, default_ports[i]); } // Similar procedure to the one of reading config file below *tcp_relay_ports = (uint16_t *)malloc(default_ports_count * sizeof(uint16_t)); if (*tcp_relay_ports == nullptr) { - log_write(LOG_LEVEL_ERROR, "Allocation failure.\n"); + LOG_WRITE(LOG_LEVEL_ERROR, "Allocation failure.\n"); return; } @@ -69,7 +69,7 @@ static void parse_tcp_relay_ports_config(config_t *cfg, uint16_t **tcp_relay_por if ((*tcp_relay_ports)[*tcp_relay_port_count] < MIN_ALLOWED_PORT || (*tcp_relay_ports)[*tcp_relay_port_count] > MAX_ALLOWED_PORT) { - log_write(LOG_LEVEL_WARNING, "Port #%zu: Invalid port: %u, should be in [%d, %d]. Skipping.\n", i, + LOG_WRITE(LOG_LEVEL_WARNING, "Port #%zu: Invalid port: %u, should be in [%d, %d]. Skipping.\n", i, (*tcp_relay_ports)[*tcp_relay_port_count], MIN_ALLOWED_PORT, MAX_ALLOWED_PORT); continue; } @@ -87,7 +87,7 @@ static void parse_tcp_relay_ports_config(config_t *cfg, uint16_t **tcp_relay_por } if (config_setting_is_array(ports_array) == CONFIG_FALSE) { - log_write(LOG_LEVEL_ERROR, "'%s' setting should be an array. Array syntax: 'setting = [value1, value2, ...]'.\n", + LOG_WRITE(LOG_LEVEL_ERROR, "'%s' setting should be an array. Array syntax: 'setting = [value1, value2, ...]'.\n", NAME_TCP_RELAY_PORTS); return; } @@ -95,13 +95,13 @@ static void parse_tcp_relay_ports_config(config_t *cfg, uint16_t **tcp_relay_por const int config_port_count = config_setting_length(ports_array); if (config_port_count == 0) { - log_write(LOG_LEVEL_ERROR, "'%s' is empty.\n", NAME_TCP_RELAY_PORTS); + LOG_WRITE(LOG_LEVEL_ERROR, "'%s' is empty.\n", NAME_TCP_RELAY_PORTS); return; } *tcp_relay_ports = (uint16_t *)malloc(config_port_count * sizeof(uint16_t)); if (*tcp_relay_ports == nullptr) { - log_write(LOG_LEVEL_ERROR, "Allocation failure.\n"); + LOG_WRITE(LOG_LEVEL_ERROR, "Allocation failure.\n"); return; } @@ -110,12 +110,12 @@ static void parse_tcp_relay_ports_config(config_t *cfg, uint16_t **tcp_relay_por if (elem == nullptr) { // It's NULL if `ports_array` is not an array (we have that check earlier) or if `i` is out of range, which should not be - log_write(LOG_LEVEL_WARNING, "Port #%d: Something went wrong while parsing the port. Stopping reading ports.\n", i); + LOG_WRITE(LOG_LEVEL_WARNING, "Port #%d: Something went wrong while parsing the port. Stopping reading ports.\n", i); break; } if (config_setting_is_number(elem) == CONFIG_FALSE) { - log_write(LOG_LEVEL_WARNING, "Port #%d: Not a number. Skipping.\n", i); + LOG_WRITE(LOG_LEVEL_WARNING, "Port #%d: Not a number. Skipping.\n", i); continue; } @@ -123,7 +123,7 @@ static void parse_tcp_relay_ports_config(config_t *cfg, uint16_t **tcp_relay_por if ((*tcp_relay_ports)[*tcp_relay_port_count] < MIN_ALLOWED_PORT || (*tcp_relay_ports)[*tcp_relay_port_count] > MAX_ALLOWED_PORT) { - log_write(LOG_LEVEL_WARNING, "Port #%d: Invalid port: %u, should be in [%d, %d]. Skipping.\n", i, + LOG_WRITE(LOG_LEVEL_WARNING, "Port #%d: Invalid port: %u, should be in [%d, %d]. Skipping.\n", i, (*tcp_relay_ports)[*tcp_relay_port_count], MIN_ALLOWED_PORT, MAX_ALLOWED_PORT); continue; } @@ -169,15 +169,15 @@ bool get_general_config(const char *cfg_file_path, char **pid_file_path, char ** // Read the file. If there is an error, report it and exit. if (config_read_file(&cfg, cfg_file_path) == CONFIG_FALSE) { - log_write(LOG_LEVEL_ERROR, "%s:%d - %s\n", config_error_file(&cfg), config_error_line(&cfg), config_error_text(&cfg)); + LOG_WRITE(LOG_LEVEL_ERROR, "%s:%d - %s\n", config_error_file(&cfg), config_error_line(&cfg), config_error_text(&cfg)); config_destroy(&cfg); return false; } // Get port if (config_lookup_int(&cfg, NAME_PORT, port) == CONFIG_FALSE) { - log_write(LOG_LEVEL_WARNING, "No '%s' setting in configuration file.\n", NAME_PORT); - log_write(LOG_LEVEL_WARNING, "Using default '%s': %d\n", NAME_PORT, DEFAULT_PORT); + LOG_WRITE(LOG_LEVEL_WARNING, "No '%s' setting in configuration file.\n", NAME_PORT); + LOG_WRITE(LOG_LEVEL_WARNING, "Using default '%s': %d\n", NAME_PORT, DEFAULT_PORT); *port = DEFAULT_PORT; } @@ -185,15 +185,15 @@ bool get_general_config(const char *cfg_file_path, char **pid_file_path, char ** const char *tmp_pid_file; if (config_lookup_string(&cfg, NAME_PID_FILE_PATH, &tmp_pid_file) == CONFIG_FALSE) { - log_write(LOG_LEVEL_WARNING, "No '%s' setting in configuration file.\n", NAME_PID_FILE_PATH); - log_write(LOG_LEVEL_WARNING, "Using default '%s': %s\n", NAME_PID_FILE_PATH, DEFAULT_PID_FILE_PATH); + LOG_WRITE(LOG_LEVEL_WARNING, "No '%s' setting in configuration file.\n", NAME_PID_FILE_PATH); + LOG_WRITE(LOG_LEVEL_WARNING, "Using default '%s': %s\n", NAME_PID_FILE_PATH, DEFAULT_PID_FILE_PATH); tmp_pid_file = DEFAULT_PID_FILE_PATH; } const size_t pid_file_path_len = strlen(tmp_pid_file) + 1; *pid_file_path = (char *)malloc(pid_file_path_len); if (*pid_file_path == nullptr) { - log_write(LOG_LEVEL_ERROR, "Allocation failure.\n"); + LOG_WRITE(LOG_LEVEL_ERROR, "Allocation failure.\n"); return false; } memcpy(*pid_file_path, tmp_pid_file, pid_file_path_len); @@ -202,15 +202,15 @@ bool get_general_config(const char *cfg_file_path, char **pid_file_path, char ** const char *tmp_keys_file; if (config_lookup_string(&cfg, NAME_KEYS_FILE_PATH, &tmp_keys_file) == CONFIG_FALSE) { - log_write(LOG_LEVEL_WARNING, "No '%s' setting in configuration file.\n", NAME_KEYS_FILE_PATH); - log_write(LOG_LEVEL_WARNING, "Using default '%s': %s\n", NAME_KEYS_FILE_PATH, DEFAULT_KEYS_FILE_PATH); + LOG_WRITE(LOG_LEVEL_WARNING, "No '%s' setting in configuration file.\n", NAME_KEYS_FILE_PATH); + LOG_WRITE(LOG_LEVEL_WARNING, "Using default '%s': %s\n", NAME_KEYS_FILE_PATH, DEFAULT_KEYS_FILE_PATH); tmp_keys_file = DEFAULT_KEYS_FILE_PATH; } const size_t keys_file_path_len = strlen(tmp_keys_file) + 1; *keys_file_path = (char *)malloc(keys_file_path_len); if (*keys_file_path == nullptr) { - log_write(LOG_LEVEL_ERROR, "Allocation failure.\n"); + LOG_WRITE(LOG_LEVEL_ERROR, "Allocation failure.\n"); free(*pid_file_path); *pid_file_path = nullptr; return false; @@ -219,31 +219,31 @@ bool get_general_config(const char *cfg_file_path, char **pid_file_path, char ** // Get IPv6 option if (tox_config_lookup_bool(&cfg, NAME_ENABLE_IPV6, enable_ipv6) == CONFIG_FALSE) { - log_write(LOG_LEVEL_WARNING, "No '%s' setting in configuration file.\n", NAME_ENABLE_IPV6); - log_write(LOG_LEVEL_WARNING, "Using default '%s': %s\n", NAME_ENABLE_IPV6, DEFAULT_ENABLE_IPV6 ? "true" : "false"); + LOG_WRITE(LOG_LEVEL_WARNING, "No '%s' setting in configuration file.\n", NAME_ENABLE_IPV6); + LOG_WRITE(LOG_LEVEL_WARNING, "Using default '%s': %s\n", NAME_ENABLE_IPV6, DEFAULT_ENABLE_IPV6 ? "true" : "false"); *enable_ipv6 = DEFAULT_ENABLE_IPV6; } // Get IPv4 fallback option if (tox_config_lookup_bool(&cfg, NAME_ENABLE_IPV4_FALLBACK, enable_ipv4_fallback) == CONFIG_FALSE) { - log_write(LOG_LEVEL_WARNING, "No '%s' setting in configuration file.\n", NAME_ENABLE_IPV4_FALLBACK); - log_write(LOG_LEVEL_WARNING, "Using default '%s': %s\n", NAME_ENABLE_IPV4_FALLBACK, + LOG_WRITE(LOG_LEVEL_WARNING, "No '%s' setting in configuration file.\n", NAME_ENABLE_IPV4_FALLBACK); + LOG_WRITE(LOG_LEVEL_WARNING, "Using default '%s': %s\n", NAME_ENABLE_IPV4_FALLBACK, DEFAULT_ENABLE_IPV4_FALLBACK ? "true" : "false"); *enable_ipv4_fallback = DEFAULT_ENABLE_IPV4_FALLBACK; } // Get LAN discovery option if (tox_config_lookup_bool(&cfg, NAME_ENABLE_LAN_DISCOVERY, enable_lan_discovery) == CONFIG_FALSE) { - log_write(LOG_LEVEL_WARNING, "No '%s' setting in configuration file.\n", NAME_ENABLE_LAN_DISCOVERY); - log_write(LOG_LEVEL_WARNING, "Using default '%s': %s\n", NAME_ENABLE_LAN_DISCOVERY, + LOG_WRITE(LOG_LEVEL_WARNING, "No '%s' setting in configuration file.\n", NAME_ENABLE_LAN_DISCOVERY); + LOG_WRITE(LOG_LEVEL_WARNING, "Using default '%s': %s\n", NAME_ENABLE_LAN_DISCOVERY, DEFAULT_ENABLE_LAN_DISCOVERY ? "true" : "false"); *enable_lan_discovery = DEFAULT_ENABLE_LAN_DISCOVERY; } // Get TCP relay option if (tox_config_lookup_bool(&cfg, NAME_ENABLE_TCP_RELAY, enable_tcp_relay) == CONFIG_FALSE) { - log_write(LOG_LEVEL_WARNING, "No '%s' setting in configuration file.\n", NAME_ENABLE_TCP_RELAY); - log_write(LOG_LEVEL_WARNING, "Using default '%s': %s\n", NAME_ENABLE_TCP_RELAY, + LOG_WRITE(LOG_LEVEL_WARNING, "No '%s' setting in configuration file.\n", NAME_ENABLE_TCP_RELAY); + LOG_WRITE(LOG_LEVEL_WARNING, "Using default '%s': %s\n", NAME_ENABLE_TCP_RELAY, DEFAULT_ENABLE_TCP_RELAY ? "true" : "false"); *enable_tcp_relay = DEFAULT_ENABLE_TCP_RELAY; } @@ -256,8 +256,8 @@ bool get_general_config(const char *cfg_file_path, char **pid_file_path, char ** // Get MOTD option if (tox_config_lookup_bool(&cfg, NAME_ENABLE_MOTD, enable_motd) == CONFIG_FALSE) { - log_write(LOG_LEVEL_WARNING, "No '%s' setting in configuration file.\n", NAME_ENABLE_MOTD); - log_write(LOG_LEVEL_WARNING, "Using default '%s': %s\n", NAME_ENABLE_MOTD, + LOG_WRITE(LOG_LEVEL_WARNING, "No '%s' setting in configuration file.\n", NAME_ENABLE_MOTD); + LOG_WRITE(LOG_LEVEL_WARNING, "Using default '%s': %s\n", NAME_ENABLE_MOTD, DEFAULT_ENABLE_MOTD ? "true" : "false"); *enable_motd = DEFAULT_ENABLE_MOTD; } @@ -267,8 +267,8 @@ bool get_general_config(const char *cfg_file_path, char **pid_file_path, char ** const char *tmp_motd; if (config_lookup_string(&cfg, NAME_MOTD, &tmp_motd) == CONFIG_FALSE) { - log_write(LOG_LEVEL_WARNING, "No '%s' setting in configuration file.\n", NAME_MOTD); - log_write(LOG_LEVEL_WARNING, "Using default '%s': %s\n", NAME_MOTD, DEFAULT_MOTD); + LOG_WRITE(LOG_LEVEL_WARNING, "No '%s' setting in configuration file.\n", NAME_MOTD); + LOG_WRITE(LOG_LEVEL_WARNING, "Using default '%s': %s\n", NAME_MOTD, DEFAULT_MOTD); tmp_motd = DEFAULT_MOTD; } @@ -280,33 +280,33 @@ bool get_general_config(const char *cfg_file_path, char **pid_file_path, char ** config_destroy(&cfg); - log_write(LOG_LEVEL_INFO, "Successfully read:\n"); - log_write(LOG_LEVEL_INFO, "'%s': %s\n", NAME_PID_FILE_PATH, *pid_file_path); - log_write(LOG_LEVEL_INFO, "'%s': %s\n", NAME_KEYS_FILE_PATH, *keys_file_path); - log_write(LOG_LEVEL_INFO, "'%s': %d\n", NAME_PORT, *port); - log_write(LOG_LEVEL_INFO, "'%s': %s\n", NAME_ENABLE_IPV6, *enable_ipv6 ? "true" : "false"); - log_write(LOG_LEVEL_INFO, "'%s': %s\n", NAME_ENABLE_IPV4_FALLBACK, *enable_ipv4_fallback ? "true" : "false"); - log_write(LOG_LEVEL_INFO, "'%s': %s\n", NAME_ENABLE_LAN_DISCOVERY, *enable_lan_discovery ? "true" : "false"); + LOG_WRITE(LOG_LEVEL_INFO, "Successfully read:\n"); + LOG_WRITE(LOG_LEVEL_INFO, "'%s': %s\n", NAME_PID_FILE_PATH, *pid_file_path); + LOG_WRITE(LOG_LEVEL_INFO, "'%s': %s\n", NAME_KEYS_FILE_PATH, *keys_file_path); + LOG_WRITE(LOG_LEVEL_INFO, "'%s': %d\n", NAME_PORT, *port); + LOG_WRITE(LOG_LEVEL_INFO, "'%s': %s\n", NAME_ENABLE_IPV6, *enable_ipv6 ? "true" : "false"); + LOG_WRITE(LOG_LEVEL_INFO, "'%s': %s\n", NAME_ENABLE_IPV4_FALLBACK, *enable_ipv4_fallback ? "true" : "false"); + LOG_WRITE(LOG_LEVEL_INFO, "'%s': %s\n", NAME_ENABLE_LAN_DISCOVERY, *enable_lan_discovery ? "true" : "false"); - log_write(LOG_LEVEL_INFO, "'%s': %s\n", NAME_ENABLE_TCP_RELAY, *enable_tcp_relay ? "true" : "false"); + LOG_WRITE(LOG_LEVEL_INFO, "'%s': %s\n", NAME_ENABLE_TCP_RELAY, *enable_tcp_relay ? "true" : "false"); // Show info about tcp ports only if tcp relay is enabled if (*enable_tcp_relay) { if (*tcp_relay_port_count == 0) { - log_write(LOG_LEVEL_ERROR, "No TCP ports could be read.\n"); + LOG_WRITE(LOG_LEVEL_ERROR, "No TCP ports could be read.\n"); } else { - log_write(LOG_LEVEL_INFO, "Read %d TCP ports:\n", *tcp_relay_port_count); + LOG_WRITE(LOG_LEVEL_INFO, "Read %d TCP ports:\n", *tcp_relay_port_count); for (int i = 0; i < *tcp_relay_port_count; ++i) { - log_write(LOG_LEVEL_INFO, "Port #%d: %u\n", i, (*tcp_relay_ports)[i]); + LOG_WRITE(LOG_LEVEL_INFO, "Port #%d: %u\n", i, (*tcp_relay_ports)[i]); } } } - log_write(LOG_LEVEL_INFO, "'%s': %s\n", NAME_ENABLE_MOTD, *enable_motd ? "true" : "false"); + LOG_WRITE(LOG_LEVEL_INFO, "'%s': %s\n", NAME_ENABLE_MOTD, *enable_motd ? "true" : "false"); if (*enable_motd) { - log_write(LOG_LEVEL_INFO, "'%s': %s\n", NAME_MOTD, *motd); + LOG_WRITE(LOG_LEVEL_INFO, "'%s': %s\n", NAME_MOTD, *motd); } return true; @@ -330,7 +330,7 @@ static uint8_t *bootstrap_hex_string_to_bin(const char *hex_string) const size_t len = strlen(hex_string) / 2; uint8_t *ret = (uint8_t *)malloc(len); if (ret == nullptr) { - log_write(LOG_LEVEL_ERROR, "Allocation failure.\n"); + LOG_WRITE(LOG_LEVEL_ERROR, "Allocation failure.\n"); return nullptr; } @@ -358,7 +358,7 @@ bool bootstrap_from_config(const char *cfg_file_path, DHT *dht, bool enable_ipv6 config_init(&cfg); if (config_read_file(&cfg, cfg_file_path) == CONFIG_FALSE) { - log_write(LOG_LEVEL_ERROR, "%s:%d - %s\n", config_error_file(&cfg), config_error_line(&cfg), config_error_text(&cfg)); + LOG_WRITE(LOG_LEVEL_ERROR, "%s:%d - %s\n", config_error_file(&cfg), config_error_line(&cfg), config_error_text(&cfg)); config_destroy(&cfg); return false; } @@ -366,14 +366,14 @@ bool bootstrap_from_config(const char *cfg_file_path, DHT *dht, bool enable_ipv6 config_setting_t *node_list = config_lookup(&cfg, NAME_BOOTSTRAP_NODES); if (node_list == nullptr) { - log_write(LOG_LEVEL_WARNING, "No '%s' setting in the configuration file. Skipping bootstrapping.\n", + LOG_WRITE(LOG_LEVEL_WARNING, "No '%s' setting in the configuration file. Skipping bootstrapping.\n", NAME_BOOTSTRAP_NODES); config_destroy(&cfg); return true; } if (config_setting_length(node_list) == 0) { - log_write(LOG_LEVEL_WARNING, "No bootstrap nodes found. Skipping bootstrapping.\n"); + LOG_WRITE(LOG_LEVEL_WARNING, "No bootstrap nodes found. Skipping bootstrapping.\n"); config_destroy(&cfg); return true; } @@ -402,30 +402,30 @@ bool bootstrap_from_config(const char *cfg_file_path, DHT *dht, bool enable_ipv6 // Check that all settings are present if (config_setting_lookup_string(node, NAME_PUBLIC_KEY, &bs_public_key) == CONFIG_FALSE) { - log_write(LOG_LEVEL_WARNING, "Bootstrap node #%d: Couldn't find '%s' setting. Skipping the node.\n", i, + LOG_WRITE(LOG_LEVEL_WARNING, "Bootstrap node #%d: Couldn't find '%s' setting. Skipping the node.\n", i, NAME_PUBLIC_KEY); goto next; } if (config_setting_lookup_int(node, NAME_PORT, &bs_port) == CONFIG_FALSE) { - log_write(LOG_LEVEL_WARNING, "Bootstrap node #%d: Couldn't find '%s' setting. Skipping the node.\n", i, NAME_PORT); + LOG_WRITE(LOG_LEVEL_WARNING, "Bootstrap node #%d: Couldn't find '%s' setting. Skipping the node.\n", i, NAME_PORT); goto next; } if (config_setting_lookup_string(node, NAME_ADDRESS, &bs_address) == CONFIG_FALSE) { - log_write(LOG_LEVEL_WARNING, "Bootstrap node #%d: Couldn't find '%s' setting. Skipping the node.\n", i, NAME_ADDRESS); + LOG_WRITE(LOG_LEVEL_WARNING, "Bootstrap node #%d: Couldn't find '%s' setting. Skipping the node.\n", i, NAME_ADDRESS); goto next; } // Process settings if (strlen(bs_public_key) != CRYPTO_PUBLIC_KEY_SIZE * 2) { - log_write(LOG_LEVEL_WARNING, "Bootstrap node #%d: Invalid '%s': %s. Skipping the node.\n", i, NAME_PUBLIC_KEY, + LOG_WRITE(LOG_LEVEL_WARNING, "Bootstrap node #%d: Invalid '%s': %s. Skipping the node.\n", i, NAME_PUBLIC_KEY, bs_public_key); goto next; } if (bs_port < MIN_ALLOWED_PORT || bs_port > MAX_ALLOWED_PORT) { - log_write(LOG_LEVEL_WARNING, "Bootstrap node #%d: Invalid '%s': %d, should be in [%d, %d]. Skipping the node.\n", i, + LOG_WRITE(LOG_LEVEL_WARNING, "Bootstrap node #%d: Invalid '%s': %d, should be in [%d, %d]. Skipping the node.\n", i, NAME_PORT, bs_port, MIN_ALLOWED_PORT, MAX_ALLOWED_PORT); goto next; @@ -437,11 +437,11 @@ bool bootstrap_from_config(const char *cfg_file_path, DHT *dht, bool enable_ipv6 free(bs_public_key_bin); if (!address_resolved) { - log_write(LOG_LEVEL_WARNING, "Bootstrap node #%d: Invalid '%s': %s. Skipping the node.\n", i, NAME_ADDRESS, bs_address); + LOG_WRITE(LOG_LEVEL_WARNING, "Bootstrap node #%d: Invalid '%s': %s. Skipping the node.\n", i, NAME_ADDRESS, bs_address); goto next; } - log_write(LOG_LEVEL_INFO, "Successfully added bootstrap node #%d: %s:%d %s\n", i, bs_address, bs_port, bs_public_key); + LOG_WRITE(LOG_LEVEL_INFO, "Successfully added bootstrap node #%d: %s:%d %s\n", i, bs_address, bs_port, bs_public_key); next: // config_setting_lookup_string() allocates string inside and doesn't allow us to free it directly diff --git a/other/bootstrap_daemon/src/log.c b/other/bootstrap_daemon/src/log.c index 48d70470ad..57c8de3526 100644 --- a/other/bootstrap_daemon/src/log.c +++ b/other/bootstrap_daemon/src/log.c @@ -15,6 +15,12 @@ #define INVALID_BACKEND ((LOG_BACKEND)-1u) static LOG_BACKEND current_backend = INVALID_BACKEND; +static bool log_toxcore_trace = false; + +void log_enable_trace(bool enable) +{ + log_toxcore_trace = enable; +} bool log_open(LOG_BACKEND backend) { @@ -58,22 +64,27 @@ bool log_close(void) return true; } -bool log_write(LOG_LEVEL level, const char *format, ...) +bool log_write(LOG_LEVEL level, const char *category, const char *file, int line, const char *format, ...) { if (current_backend == INVALID_BACKEND) { return false; } + if (level == LOG_LEVEL_TRACE && !log_toxcore_trace) { + // By default, no trace logging. + return true; + } + va_list args; va_start(args, format); switch (current_backend) { case LOG_BACKEND_STDOUT: - log_backend_stdout_write(level, format, args); + log_backend_stdout_write(level, category, file, line, format, args); break; case LOG_BACKEND_SYSLOG: - log_backend_syslog_write(level, format, args); + log_backend_syslog_write(level, category, file, line, format, args); break; } diff --git a/other/bootstrap_daemon/src/log.h b/other/bootstrap_daemon/src/log.h index ba812fab0a..55aad042af 100644 --- a/other/bootstrap_daemon/src/log.h +++ b/other/bootstrap_daemon/src/log.h @@ -20,11 +20,18 @@ typedef enum LOG_BACKEND { } LOG_BACKEND; typedef enum LOG_LEVEL { + LOG_LEVEL_TRACE, LOG_LEVEL_INFO, LOG_LEVEL_WARNING, LOG_LEVEL_ERROR } LOG_LEVEL; +/** + * Enables or disables logging of trace messages from toxcore. + * @param enable true to enable, false to disable. + */ +void log_enable_trace(bool enable); + /** * Initializes logger. * @param backend Specifies which backend to use. @@ -45,6 +52,13 @@ bool log_close(void); * @param ... Zero or more arguments, similar to printf function. * @return true on success, false if log is closed. */ -bool log_write(LOG_LEVEL level, const char *format, ...) GNU_PRINTF(2, 3); +bool log_write(LOG_LEVEL level, const char *category, const char *file, int line, const char *format, ...) GNU_PRINTF(5, 6); + +enum { + LOG_PATH_PREFIX = sizeof(__FILE__) - sizeof("log.h") +}; + +#define LOG_WRITEC(level, category, ...) log_write(level, category, &__FILE__[LOG_PATH_PREFIX], __LINE__, __VA_ARGS__) +#define LOG_WRITE(level, ...) LOG_WRITEC(level, "tox.bootstrap", __VA_ARGS__) #endif // C_TOXCORE_OTHER_BOOTSTRAP_DAEMON_SRC_LOG_H diff --git a/other/bootstrap_daemon/src/log_backend_stdout.c b/other/bootstrap_daemon/src/log_backend_stdout.c index 2ef7bf75eb..d0126e186f 100644 --- a/other/bootstrap_daemon/src/log_backend_stdout.c +++ b/other/bootstrap_daemon/src/log_backend_stdout.c @@ -11,12 +11,15 @@ #include #include +#include +#include "../../../toxcore/ccompat.h" #include "log.h" static FILE *log_backend_stdout_level(LOG_LEVEL level) { switch (level) { + case LOG_LEVEL_TRACE: // intentional fallthrough case LOG_LEVEL_INFO: return stdout; @@ -28,8 +31,36 @@ static FILE *log_backend_stdout_level(LOG_LEVEL level) return stdout; } -void log_backend_stdout_write(LOG_LEVEL level, const char *format, va_list args) +static const char *log_level_string(LOG_LEVEL level) { - vfprintf(log_backend_stdout_level(level), format, args); - fflush(log_backend_stdout_level(level)); + switch (level) { + case LOG_LEVEL_TRACE: + return "Debug"; + + case LOG_LEVEL_INFO: + return "Info"; + + case LOG_LEVEL_WARNING: + return "Warning"; + + case LOG_LEVEL_ERROR: + return "Critical"; // Qt-compatible. + } + + return "Debug"; // Just in case. Shouldn't happen. +} + +// Output bootstrap node log messages in the standard Tox log format: +// [15:02:46.433 UTC] (tox.bootstrap) config.c:444 : Info: Successfully added bootstrap node ... +void log_backend_stdout_write(LOG_LEVEL level, const char *category, const char *file, int line, const char *format, va_list args) +{ + struct timeval tv = {0}; + gettimeofday(&tv, nullptr); + + FILE *stream = log_backend_stdout_level(level); + fprintf(stream, "[%02d:%02d:%02d.%03d UTC] (%s) %s:%d : %s: ", + (int)(tv.tv_sec / 3600 % 24), (int)(tv.tv_sec / 60 % 60), (int)(tv.tv_sec % 60), (int)(tv.tv_usec / 1000), + category, file, line, log_level_string(level)); + vfprintf(stream, format, args); + fflush(stream); } diff --git a/other/bootstrap_daemon/src/log_backend_stdout.h b/other/bootstrap_daemon/src/log_backend_stdout.h index bb6d2cc457..c8d0f2667a 100644 --- a/other/bootstrap_daemon/src/log_backend_stdout.h +++ b/other/bootstrap_daemon/src/log_backend_stdout.h @@ -15,6 +15,6 @@ #include "../../../toxcore/attributes.h" #include "log.h" -void log_backend_stdout_write(LOG_LEVEL level, const char *format, va_list args) GNU_PRINTF(2, 0); +void log_backend_stdout_write(LOG_LEVEL level, const char *category, const char *file, int line, const char *format, va_list args) GNU_PRINTF(5, 0); #endif // C_TOXCORE_OTHER_BOOTSTRAP_DAEMON_SRC_LOG_BACKEND_STDOUT_H diff --git a/other/bootstrap_daemon/src/log_backend_syslog.c b/other/bootstrap_daemon/src/log_backend_syslog.c index de6d228768..33622e016e 100644 --- a/other/bootstrap_daemon/src/log_backend_syslog.c +++ b/other/bootstrap_daemon/src/log_backend_syslog.c @@ -33,6 +33,9 @@ void log_backend_syslog_close(void) static int log_backend_syslog_level(LOG_LEVEL level) { switch (level) { + case LOG_LEVEL_TRACE: + return LOG_DEBUG; + case LOG_LEVEL_INFO: return LOG_INFO; @@ -46,7 +49,7 @@ static int log_backend_syslog_level(LOG_LEVEL level) return LOG_INFO; } -void log_backend_syslog_write(LOG_LEVEL level, const char *format, va_list args) +void log_backend_syslog_write(LOG_LEVEL level, const char *category, const char *file, int line, const char *format, va_list args) { va_list args2; @@ -66,6 +69,6 @@ void log_backend_syslog_write(LOG_LEVEL level, const char *format, va_list args) } vsnprintf(buf, size + 1, format, args); - syslog(log_backend_syslog_level(level), "%s", buf); + syslog(log_backend_syslog_level(level), "(%s) %s", category, buf); free(buf); } diff --git a/other/bootstrap_daemon/src/log_backend_syslog.h b/other/bootstrap_daemon/src/log_backend_syslog.h index 1538c92d9c..f3230816f0 100644 --- a/other/bootstrap_daemon/src/log_backend_syslog.h +++ b/other/bootstrap_daemon/src/log_backend_syslog.h @@ -17,6 +17,6 @@ void log_backend_syslog_open(void); void log_backend_syslog_close(void); -void log_backend_syslog_write(LOG_LEVEL level, const char *format, va_list args) GNU_PRINTF(2, 0); +void log_backend_syslog_write(LOG_LEVEL level, const char *category, const char *file, int line, const char *format, va_list args) GNU_PRINTF(5, 0); #endif // C_TOXCORE_OTHER_BOOTSTRAP_DAEMON_SRC_LOG_BACKEND_SYSLOG_H diff --git a/other/bootstrap_daemon/src/tox-bootstrapd.c b/other/bootstrap_daemon/src/tox-bootstrapd.c index 6f80e9d64b..d619a17136 100644 --- a/other/bootstrap_daemon/src/tox-bootstrapd.c +++ b/other/bootstrap_daemon/src/tox-bootstrapd.c @@ -116,7 +116,7 @@ static void print_public_key(const uint8_t *public_key) index += snprintf(buffer + index, sizeof(buffer) - index, "%02X", public_key[i]); } - log_write(LOG_LEVEL_INFO, "Public Key: %s\n", buffer); + LOG_WRITE(LOG_LEVEL_INFO, "Public Key: %s\n", buffer); } // Demonizes the process, appending PID to the PID file and closing file descriptors based on log backend @@ -128,7 +128,7 @@ static Cli_Status daemonize(LOG_BACKEND log_backend, char *pid_file_path) FILE *pid_file = fopen(pid_file_path, "r"); if (pid_file != nullptr) { - log_write(LOG_LEVEL_WARNING, "Another instance of the daemon is already running, PID file %s exists.\n", pid_file_path); + LOG_WRITE(LOG_LEVEL_WARNING, "Another instance of the daemon is already running, PID file %s exists.\n", pid_file_path); fclose(pid_file); } @@ -136,7 +136,7 @@ static Cli_Status daemonize(LOG_BACKEND log_backend, char *pid_file_path) pid_file = fopen(pid_file_path, "a+"); if (pid_file == nullptr) { - log_write(LOG_LEVEL_ERROR, "Couldn't open the PID file for writing: %s. Exiting.\n", pid_file_path); + LOG_WRITE(LOG_LEVEL_ERROR, "Couldn't open the PID file for writing: %s. Exiting.\n", pid_file_path); return CLI_STATUS_ERROR; } @@ -146,26 +146,26 @@ static Cli_Status daemonize(LOG_BACKEND log_backend, char *pid_file_path) if (pid > 0) { fprintf(pid_file, "%d", pid); fclose(pid_file); - log_write(LOG_LEVEL_INFO, "Forked successfully: PID: %d.\n", pid); + LOG_WRITE(LOG_LEVEL_INFO, "Forked successfully: PID: %d.\n", pid); return CLI_STATUS_DONE; } else { fclose(pid_file); } if (pid < 0) { - log_write(LOG_LEVEL_ERROR, "Forking failed. Exiting.\n"); + LOG_WRITE(LOG_LEVEL_ERROR, "Forking failed. Exiting.\n"); return CLI_STATUS_ERROR; } // Create a new SID for the child process if (setsid() < 0) { - log_write(LOG_LEVEL_ERROR, "SID creation failure. Exiting.\n"); + LOG_WRITE(LOG_LEVEL_ERROR, "SID creation failure. Exiting.\n"); return CLI_STATUS_ERROR; } // Change the current working directory if ((chdir("/")) < 0) { - log_write(LOG_LEVEL_ERROR, "Couldn't change working directory to '/'. Exiting.\n"); + LOG_WRITE(LOG_LEVEL_ERROR, "Couldn't change working directory to '/'. Exiting.\n"); return CLI_STATUS_ERROR; } @@ -185,6 +185,8 @@ static LOG_LEVEL logger_level_to_log_level(Logger_Level level) { switch (level) { case LOGGER_LEVEL_TRACE: + return LOG_LEVEL_TRACE; + case LOGGER_LEVEL_DEBUG: case LOGGER_LEVEL_INFO: return LOG_LEVEL_INFO; @@ -203,7 +205,11 @@ static LOG_LEVEL logger_level_to_log_level(Logger_Level level) static void toxcore_logger_callback(void *context, Logger_Level level, const char *file, uint32_t line, const char *func, const char *message, void *userdata) { - log_write(logger_level_to_log_level(level), "%s:%u(%s) %s\n", file, line, func, message); + const char *category = "tox.core"; + if (level == LOGGER_LEVEL_TRACE) { + category = "tox.trace"; + } + log_write(logger_level_to_log_level(level), category, file, line, "%s\n", message); } static volatile sig_atomic_t caught_signal = 0; @@ -235,7 +241,7 @@ int main(int argc, char *argv[]) log_open(log_backend); - log_write(LOG_LEVEL_INFO, "Running \"%s\" version %lu.\n", DAEMON_NAME, DAEMON_VERSION_NUMBER); + LOG_WRITE(LOG_LEVEL_INFO, "Running \"%s\" version %lu.\n", DAEMON_NAME, DAEMON_VERSION_NUMBER); char *pid_file_path = nullptr; char *keys_file_path = nullptr; @@ -251,14 +257,14 @@ int main(int argc, char *argv[]) if (get_general_config(cfg_file_path, &pid_file_path, &keys_file_path, &start_port, &enable_ipv6, &enable_ipv4_fallback, &enable_lan_discovery, &enable_tcp_relay, &tcp_relay_ports, &tcp_relay_port_count, &enable_motd, &motd)) { - log_write(LOG_LEVEL_INFO, "General config read successfully\n"); + LOG_WRITE(LOG_LEVEL_INFO, "General config read successfully\n"); } else { - log_write(LOG_LEVEL_ERROR, "Couldn't read config file: %s. Exiting.\n", cfg_file_path); + LOG_WRITE(LOG_LEVEL_ERROR, "Couldn't read config file: %s. Exiting.\n", cfg_file_path); return 1; } if (start_port < MIN_ALLOWED_PORT || start_port > MAX_ALLOWED_PORT) { - log_write(LOG_LEVEL_ERROR, "Invalid port: %d, should be in [%d, %d]. Exiting.\n", start_port, MIN_ALLOWED_PORT, + LOG_WRITE(LOG_LEVEL_ERROR, "Invalid port: %d, should be in [%d, %d]. Exiting.\n", start_port, MIN_ALLOWED_PORT, MAX_ALLOWED_PORT); free(motd); free(tcp_relay_ports); @@ -289,22 +295,20 @@ int main(int argc, char *argv[]) Logger *logger = logger_new(mem); - if (MIN_LOGGER_LEVEL <= LOGGER_LEVEL_DEBUG) { - logger_callback_log(logger, toxcore_logger_callback, nullptr, nullptr); - } + logger_callback_log(logger, toxcore_logger_callback, nullptr, nullptr); const uint16_t end_port = start_port + (TOX_PORTRANGE_TO - TOX_PORTRANGE_FROM); Networking_Core *net = new_networking_ex(logger, mem, ns, &ip, start_port, end_port, nullptr); if (net == nullptr) { if (enable_ipv6 && enable_ipv4_fallback) { - log_write(LOG_LEVEL_WARNING, "Couldn't initialize IPv6 networking. Falling back to using IPv4.\n"); + LOG_WRITE(LOG_LEVEL_WARNING, "Couldn't initialize IPv6 networking. Falling back to using IPv4.\n"); enable_ipv6 = false; ip_init(&ip, enable_ipv6); net = new_networking_ex(logger, mem, ns, &ip, start_port, end_port, nullptr); if (net == nullptr) { - log_write(LOG_LEVEL_ERROR, "Couldn't fallback to IPv4. Exiting.\n"); + LOG_WRITE(LOG_LEVEL_ERROR, "Couldn't fallback to IPv4. Exiting.\n"); logger_kill(logger); free(motd); free(tcp_relay_ports); @@ -312,7 +316,7 @@ int main(int argc, char *argv[]) return 1; } } else { - log_write(LOG_LEVEL_ERROR, "Couldn't initialize networking. Exiting.\n"); + LOG_WRITE(LOG_LEVEL_ERROR, "Couldn't initialize networking. Exiting.\n"); logger_kill(logger); free(motd); free(tcp_relay_ports); @@ -324,7 +328,7 @@ int main(int argc, char *argv[]) Mono_Time *const mono_time = mono_time_new(mem, nullptr, nullptr); if (mono_time == nullptr) { - log_write(LOG_LEVEL_ERROR, "Couldn't initialize monotonic timer. Exiting.\n"); + LOG_WRITE(LOG_LEVEL_ERROR, "Couldn't initialize monotonic timer. Exiting.\n"); kill_networking(net); logger_kill(logger); free(motd); @@ -338,7 +342,7 @@ int main(int argc, char *argv[]) DHT *const dht = new_dht(logger, mem, rng, ns, mono_time, net, true, enable_lan_discovery); if (dht == nullptr) { - log_write(LOG_LEVEL_ERROR, "Couldn't initialize Tox DHT instance. Exiting.\n"); + LOG_WRITE(LOG_LEVEL_ERROR, "Couldn't initialize Tox DHT instance. Exiting.\n"); mono_time_free(mem, mono_time); kill_networking(net); logger_kill(logger); @@ -351,7 +355,7 @@ int main(int argc, char *argv[]) Forwarding *forwarding = new_forwarding(logger, mem, rng, mono_time, dht); if (forwarding == nullptr) { - log_write(LOG_LEVEL_ERROR, "Couldn't initialize forwarding. Exiting.\n"); + LOG_WRITE(LOG_LEVEL_ERROR, "Couldn't initialize forwarding. Exiting.\n"); kill_dht(dht); mono_time_free(mem, mono_time); kill_networking(net); @@ -365,7 +369,7 @@ int main(int argc, char *argv[]) Announcements *announce = new_announcements(logger, mem, rng, mono_time, forwarding); if (announce == nullptr) { - log_write(LOG_LEVEL_ERROR, "Couldn't initialize DHT announcements. Exiting.\n"); + LOG_WRITE(LOG_LEVEL_ERROR, "Couldn't initialize DHT announcements. Exiting.\n"); kill_forwarding(forwarding); kill_dht(dht); mono_time_free(mem, mono_time); @@ -380,7 +384,7 @@ int main(int argc, char *argv[]) GC_Announces_List *group_announce = new_gca_list(mem); if (group_announce == nullptr) { - log_write(LOG_LEVEL_ERROR, "Couldn't initialize group announces. Exiting.\n"); + LOG_WRITE(LOG_LEVEL_ERROR, "Couldn't initialize group announces. Exiting.\n"); kill_announcements(announce); kill_forwarding(forwarding); kill_dht(dht); @@ -396,7 +400,7 @@ int main(int argc, char *argv[]) Onion *onion = new_onion(logger, mem, mono_time, rng, dht); if (onion == nullptr) { - log_write(LOG_LEVEL_ERROR, "Couldn't initialize Tox Onion. Exiting.\n"); + LOG_WRITE(LOG_LEVEL_ERROR, "Couldn't initialize Tox Onion. Exiting.\n"); kill_gca(group_announce); kill_announcements(announce); kill_forwarding(forwarding); @@ -413,7 +417,7 @@ int main(int argc, char *argv[]) Onion_Announce *onion_a = new_onion_announce(logger, mem, rng, mono_time, dht); if (onion_a == nullptr) { - log_write(LOG_LEVEL_ERROR, "Couldn't initialize Tox Onion Announce. Exiting.\n"); + LOG_WRITE(LOG_LEVEL_ERROR, "Couldn't initialize Tox Onion Announce. Exiting.\n"); kill_gca(group_announce); kill_onion(onion); kill_announcements(announce); @@ -432,10 +436,10 @@ int main(int argc, char *argv[]) if (enable_motd) { if (bootstrap_set_callbacks(dht_get_net(dht), DAEMON_VERSION_NUMBER, (uint8_t *)motd, strlen(motd) + 1) == 0) { - log_write(LOG_LEVEL_INFO, "Set MOTD successfully.\n"); + LOG_WRITE(LOG_LEVEL_INFO, "Set MOTD successfully.\n"); free(motd); } else { - log_write(LOG_LEVEL_ERROR, "Couldn't set MOTD: %s. Exiting.\n", motd); + LOG_WRITE(LOG_LEVEL_ERROR, "Couldn't set MOTD: %s. Exiting.\n", motd); kill_onion_announce(onion_a); kill_gca(group_announce); kill_onion(onion); @@ -453,10 +457,10 @@ int main(int argc, char *argv[]) } if (manage_keys(dht, keys_file_path)) { - log_write(LOG_LEVEL_INFO, "Keys are managed successfully.\n"); + LOG_WRITE(LOG_LEVEL_INFO, "Keys are managed successfully.\n"); free(keys_file_path); } else { - log_write(LOG_LEVEL_ERROR, "Couldn't read/write: %s. Exiting.\n", keys_file_path); + LOG_WRITE(LOG_LEVEL_ERROR, "Couldn't read/write: %s. Exiting.\n", keys_file_path); kill_onion_announce(onion_a); kill_gca(group_announce); kill_onion(onion); @@ -475,7 +479,7 @@ int main(int argc, char *argv[]) if (enable_tcp_relay) { if (tcp_relay_port_count == 0) { - log_write(LOG_LEVEL_ERROR, "No TCP relay ports read. Exiting.\n"); + LOG_WRITE(LOG_LEVEL_ERROR, "No TCP relay ports read. Exiting.\n"); kill_onion_announce(onion_a); kill_gca(group_announce); kill_announcements(announce); @@ -496,7 +500,7 @@ int main(int argc, char *argv[]) free(tcp_relay_ports); if (tcp_server != nullptr) { - log_write(LOG_LEVEL_INFO, "Initialized Tox TCP server successfully.\n"); + LOG_WRITE(LOG_LEVEL_INFO, "Initialized Tox TCP server successfully.\n"); struct rlimit limit; @@ -515,14 +519,14 @@ int main(int argc, char *argv[]) } if (getrlimit(RLIMIT_NOFILE, &limit) == 0 && limit.rlim_cur < rlim_min) { - log_write(LOG_LEVEL_WARNING, + LOG_WRITE(LOG_LEVEL_WARNING, "Current limit on the number of files this process can open (%ju) is rather low for the proper functioning of the TCP server. " "Consider raising the limit to at least %ju or the recommended %ju. " "Continuing using the current limit (%ju).\n", (uintmax_t)limit.rlim_cur, (uintmax_t)rlim_min, (uintmax_t)rlim_suggested, (uintmax_t)limit.rlim_cur); } } else { - log_write(LOG_LEVEL_ERROR, "Couldn't initialize Tox TCP server. Exiting.\n"); + LOG_WRITE(LOG_LEVEL_ERROR, "Couldn't initialize Tox TCP server. Exiting.\n"); kill_onion_announce(onion_a); kill_gca(group_announce); kill_onion(onion); @@ -537,9 +541,9 @@ int main(int argc, char *argv[]) } if (bootstrap_from_config(cfg_file_path, dht, enable_ipv6)) { - log_write(LOG_LEVEL_INFO, "List of bootstrap nodes read successfully.\n"); + LOG_WRITE(LOG_LEVEL_INFO, "List of bootstrap nodes read successfully.\n"); } else { - log_write(LOG_LEVEL_ERROR, "Couldn't read list of bootstrap nodes in %s. Exiting.\n", cfg_file_path); + LOG_WRITE(LOG_LEVEL_ERROR, "Couldn't read list of bootstrap nodes in %s. Exiting.\n", cfg_file_path); kill_tcp_server(tcp_server); kill_onion_announce(onion_a); kill_gca(group_announce); @@ -564,7 +568,7 @@ int main(int argc, char *argv[]) if (enable_lan_discovery) { broadcast = lan_discovery_init(mem, ns); - log_write(LOG_LEVEL_INFO, "Initialized LAN discovery successfully.\n"); + LOG_WRITE(LOG_LEVEL_INFO, "Initialized LAN discovery successfully.\n"); } struct sigaction sa; @@ -578,11 +582,11 @@ int main(int argc, char *argv[]) sigfillset(&sa.sa_mask); if (sigaction(SIGINT, &sa, nullptr) != 0) { - log_write(LOG_LEVEL_WARNING, "Couldn't set signal handler for SIGINT. Continuing without the signal handler set.\n"); + LOG_WRITE(LOG_LEVEL_WARNING, "Couldn't set signal handler for SIGINT. Continuing without the signal handler set.\n"); } if (sigaction(SIGTERM, &sa, nullptr) != 0) { - log_write(LOG_LEVEL_WARNING, "Couldn't set signal handler for SIGTERM. Continuing without the signal handler set.\n"); + LOG_WRITE(LOG_LEVEL_WARNING, "Couldn't set signal handler for SIGTERM. Continuing without the signal handler set.\n"); } while (caught_signal == 0) { @@ -604,7 +608,7 @@ int main(int argc, char *argv[]) networking_poll(dht_get_net(dht), nullptr); if (waiting_for_dht_connection && dht_isconnected(dht)) { - log_write(LOG_LEVEL_INFO, "Connected to another bootstrap node successfully.\n"); + LOG_WRITE(LOG_LEVEL_INFO, "Connected to another bootstrap node successfully.\n"); waiting_for_dht_connection = false; } @@ -613,15 +617,15 @@ int main(int argc, char *argv[]) switch (caught_signal) { case SIGINT: - log_write(LOG_LEVEL_INFO, "Received SIGINT (%d) signal. Exiting.\n", SIGINT); + LOG_WRITE(LOG_LEVEL_INFO, "Received SIGINT (%d) signal. Exiting.\n", SIGINT); break; case SIGTERM: - log_write(LOG_LEVEL_INFO, "Received SIGTERM (%d) signal. Exiting.\n", SIGTERM); + LOG_WRITE(LOG_LEVEL_INFO, "Received SIGTERM (%d) signal. Exiting.\n", SIGTERM); break; default: - log_write(LOG_LEVEL_INFO, "Received (%ld) signal. Exiting.\n", (long)caught_signal); + LOG_WRITE(LOG_LEVEL_INFO, "Received (%ld) signal. Exiting.\n", (long)caught_signal); } lan_discovery_kill(broadcast); diff --git a/other/bootstrap_daemon/websocket/Dockerfile b/other/bootstrap_daemon/websocket/Dockerfile index 5e48c7e16f..7e6d855bd2 100644 --- a/other/bootstrap_daemon/websocket/Dockerfile +++ b/other/bootstrap_daemon/websocket/Dockerfile @@ -1,6 +1,6 @@ # Stage 1 - Compile websockify. FROM toxchat/bootstrap-node:latest AS tox -FROM golang:1.17-alpine AS websockify +FROM golang:1.23-alpine3.21 AS websockify COPY websockify /work/websockify RUN cd /work/websockify && go mod download github.com/gorilla/websocket && go install @@ -25,5 +25,7 @@ USER tox #RUN /usr/local/bin/tox-bootstrapd --config /etc/tox-bootstrapd.conf --log-backend stdout \ # && sleep 1 +COPY tox-bootstrapd.conf /etc/ + WORKDIR /web CMD ["/entrypoint.sh"] diff --git a/other/bootstrap_daemon/websocket/build.sh b/other/bootstrap_daemon/websocket/build.sh new file mode 100755 index 0000000000..39379366c4 --- /dev/null +++ b/other/bootstrap_daemon/websocket/build.sh @@ -0,0 +1,12 @@ +#!/bin/sh + +set -eux -o pipefail + +GIT_ROOT="$(git rev-parse --show-toplevel)" + +# Build bootstrap daemon first. +"$GIT_ROOT/other/bootstrap_daemon/docker/build.sh" + +# Build websocket server. +cd "$GIT_ROOT/other/bootstrap_daemon/websocket" +docker build -t toxchat/bootstrap-node:latest-websocket . diff --git a/other/bootstrap_daemon/websocket/entrypoint.sh b/other/bootstrap_daemon/websocket/entrypoint.sh index 7284bdb3be..4f215f9189 100755 --- a/other/bootstrap_daemon/websocket/entrypoint.sh +++ b/other/bootstrap_daemon/websocket/entrypoint.sh @@ -2,5 +2,5 @@ set -eux -/usr/local/bin/tox-bootstrapd --config /etc/tox-bootstrapd.conf --log-backend stdout +/usr/local/bin/tox-bootstrapd --config /etc/tox-bootstrapd.conf --log-backend stdout --trace /usr/local/bin/websockify -l "0.0.0.0:$PORT" -t 127.0.0.1:33445 diff --git a/other/bootstrap_daemon/websocket/tox-bootstrapd.conf b/other/bootstrap_daemon/websocket/tox-bootstrapd.conf new file mode 100644 index 0000000000..e1892df2c4 --- /dev/null +++ b/other/bootstrap_daemon/websocket/tox-bootstrapd.conf @@ -0,0 +1,21 @@ +# Tox WebSocket bootstrap daemon configuration file. + +port = 33445 + +keys_file_path = "/var/lib/tox-bootstrapd/keys" + +pid_file_path = "/var/run/tox-bootstrapd/tox-bootstrapd.pid" + +enable_ipv6 = false +enable_ipv4_fallback = true +enable_lan_discovery = false + +enable_tcp_relay = true +tcp_relay_ports = [443, 3389, 33445] + +enable_motd = true + +motd = "tox-bootstrapd" + +# No bootstrap nodes for now, since none of them support WebSocket. +bootstrap_nodes = () diff --git a/other/docker/autotools/run b/other/docker/autotools/run index 300465b00b..c92013fe30 100755 --- a/other/docker/autotools/run +++ b/other/docker/autotools/run @@ -2,5 +2,5 @@ set -eux BUILD=autotools -other/docker/sources/build +other/docker/sources/build.sh docker build -t "toxchat/c-toxcore:$BUILD" -f "other/docker/$BUILD/$BUILD.Dockerfile" . diff --git a/other/docker/clang-tidy/run b/other/docker/clang-tidy/run index ab830de0b0..9d3abf2a16 100755 --- a/other/docker/clang-tidy/run +++ b/other/docker/clang-tidy/run @@ -2,5 +2,5 @@ set -eux BUILD=clang-tidy -other/docker/sources/build +other/docker/sources/build.sh docker build -t "toxchat/c-toxcore:$BUILD" -f "other/docker/$BUILD/$BUILD.Dockerfile" . diff --git a/other/docker/compcert/run b/other/docker/compcert/run index 885f811ae9..bf11d09a6a 100755 --- a/other/docker/compcert/run +++ b/other/docker/compcert/run @@ -2,5 +2,5 @@ set -eux BUILD=compcert -other/docker/sources/build +other/docker/sources/build.sh docker build -t "toxchat/c-toxcore:$BUILD" -f "other/docker/$BUILD/$BUILD.Dockerfile" . diff --git a/other/docker/coverage/run b/other/docker/coverage/run index e4f5133914..aa23abfb35 100755 --- a/other/docker/coverage/run +++ b/other/docker/coverage/run @@ -5,7 +5,7 @@ set -eux read -a ci_env <<<"$(bash <(curl -s https://codecov.io/env))" BUILD=coverage -other/docker/sources/build +other/docker/sources/build.sh docker build -t "toxchat/c-toxcore:$BUILD" -f "other/docker/$BUILD/$BUILD.Dockerfile" . docker run "${ci_env[@]}" -e CI=true --name toxcore-coverage --rm -t toxchat/c-toxcore:coverage /usr/local/bin/codecov diff --git a/other/docker/cppcheck/run b/other/docker/cppcheck/run index 4cc18bac9a..b7853fd56b 100755 --- a/other/docker/cppcheck/run +++ b/other/docker/cppcheck/run @@ -2,5 +2,5 @@ set -eux BUILD=cppcheck -other/docker/sources/build +other/docker/sources/build.sh docker build -t "toxchat/c-toxcore:$BUILD" -f "other/docker/$BUILD/$BUILD.Dockerfile" . diff --git a/other/docker/goblint/run b/other/docker/goblint/run index f2bbceea7a..8c97cb51bf 100755 --- a/other/docker/goblint/run +++ b/other/docker/goblint/run @@ -2,5 +2,5 @@ set -eux BUILD=goblint -other/docker/sources/build +other/docker/sources/build.sh docker build -t "toxchat/c-toxcore:$BUILD" -f "other/docker/$BUILD/$BUILD.Dockerfile" . diff --git a/other/docker/infer/run b/other/docker/infer/run index f605d14068..a7ae629874 100755 --- a/other/docker/infer/run +++ b/other/docker/infer/run @@ -2,5 +2,5 @@ set -eux BUILD=infer -other/docker/sources/build +other/docker/sources/build.sh docker build -t "toxchat/c-toxcore:$BUILD" -f "other/docker/$BUILD/$BUILD.Dockerfile" . diff --git a/other/docker/misra/run b/other/docker/misra/run index a2692a37ad..1dec98b666 100755 --- a/other/docker/misra/run +++ b/other/docker/misra/run @@ -2,5 +2,5 @@ set -eux BUILD=misra -other/docker/sources/build +other/docker/sources/build.sh docker build -t "toxchat/c-toxcore:$BUILD" -f "other/docker/$BUILD/$BUILD.Dockerfile" . diff --git a/other/docker/rpm/run b/other/docker/rpm/run index ea71cc358e..1f40925d09 100755 --- a/other/docker/rpm/run +++ b/other/docker/rpm/run @@ -6,7 +6,7 @@ PROJECT_COMMIT_ID="$(git rev-parse HEAD)" PROJECT_COMMIT_ID_SHORT="$(git rev-parse --short HEAD)" BUILD=rpm -other/docker/sources/build +other/docker/sources/build.sh docker build -t "toxchat/c-toxcore:$BUILD" -f "other/docker/$BUILD/$BUILD.Dockerfile" . \ --build-arg="PROJECT_VERSION=$PROJECT_VERSION" \ --build-arg="PROJECT_COMMIT_ID=$PROJECT_COMMIT_ID" \ diff --git a/other/docker/slimcc/run b/other/docker/slimcc/run index 82d7112041..e30b329cf2 100755 --- a/other/docker/slimcc/run +++ b/other/docker/slimcc/run @@ -2,5 +2,5 @@ set -eux BUILD=slimcc -other/docker/sources/build +other/docker/sources/build.sh docker build -t "toxchat/c-toxcore:$BUILD" -f "other/docker/$BUILD/$BUILD.Dockerfile" . diff --git a/other/docker/sources/build b/other/docker/sources/build.sh similarity index 100% rename from other/docker/sources/build rename to other/docker/sources/build.sh diff --git a/other/docker/sparse/run b/other/docker/sparse/run index 6b87e91b8a..6407355106 100755 --- a/other/docker/sparse/run +++ b/other/docker/sparse/run @@ -2,5 +2,5 @@ set -eux BUILD=sparse -other/docker/sources/build +other/docker/sources/build.sh docker build -t "toxchat/c-toxcore:$BUILD" -f "other/docker/$BUILD/$BUILD.Dockerfile" . diff --git a/other/docker/tcc/run b/other/docker/tcc/run index 63412b55f6..e9e29ff6d2 100755 --- a/other/docker/tcc/run +++ b/other/docker/tcc/run @@ -2,5 +2,5 @@ set -eux BUILD=tcc -other/docker/sources/build +other/docker/sources/build.sh docker build -t "toxchat/c-toxcore:$BUILD" -f "other/docker/$BUILD/$BUILD.Dockerfile" . diff --git a/other/docker/tokstyle/run b/other/docker/tokstyle/run index 1d92173d66..847cd3223f 100755 --- a/other/docker/tokstyle/run +++ b/other/docker/tokstyle/run @@ -2,5 +2,5 @@ set -eux BUILD=tokstyle -other/docker/sources/build +other/docker/sources/build.sh docker build -t "toxchat/c-toxcore:$BUILD" -f "other/docker/$BUILD/$BUILD.Dockerfile" .