From 73454adc2228c9ae9f37ae3e4c10d2298d271e65 Mon Sep 17 00:00:00 2001 From: TheBrokenRail Date: Tue, 14 May 2024 01:23:16 -0400 Subject: [PATCH] Refactor Logging --- launcher/src/crash-report.c | 33 ++++++------- launcher/src/main.cpp | 1 + libreborn/include/libreborn/log.h | 13 +++++- libreborn/src/util/exec.c | 9 +--- libreborn/src/util/log.c | 78 +++++++++++++++++++++++++------ 5 files changed, 93 insertions(+), 41 deletions(-) diff --git a/launcher/src/crash-report.c b/launcher/src/crash-report.c index 1751a9b1..ccc38024 100644 --- a/launcher/src/crash-report.c +++ b/launcher/src/crash-report.c @@ -58,7 +58,6 @@ static void exit_handler(__attribute__((unused)) int signal) { #define PIPE_WRITE 1 #define MCPI_LOGS_DIR "/tmp/.minecraft-pi-logs" static char log_filename[] = MCPI_LOGS_DIR "/XXXXXX"; -static int log_file_fd = -1; void setup_log_file() { // Ensure Temporary Directory { @@ -74,16 +73,12 @@ void setup_log_file() { } // Create Temporary File - log_file_fd = mkstemp(log_filename); + int log_file_fd = mkstemp(log_filename); if (log_file_fd == -1) { ERR("Unable To Create Log File: %s", strerror(errno)); } - - // Setup Environment - char *log_file_fd_env = NULL; - safe_asprintf(&log_file_fd_env, "%i", log_file_fd); - set_and_print_env("MCPI_LOG_FILE_FD", log_file_fd_env); - free(log_file_fd_env); + close(log_file_fd); + reborn_set_log(log_filename); } void setup_crash_report() { // Store Output @@ -176,17 +171,17 @@ void setup_crash_report() { bytes_available = 0; } // Read - ssize_t bytes_read = read(poll_fds[i].fd, (void *) buf, BUFFER_SIZE); + ssize_t bytes_read = read(poll_fds[i].fd, buf, BUFFER_SIZE); if (bytes_read == -1) { - ERR("Unable To Read Log Data: %s", strerror(errno)); + ERR("Unable To Read Input: %s", strerror(errno)); } // Write To Child - if (write(input_pipe[PIPE_WRITE], (void *) buf, bytes_read) == -1) { + if (write(input_pipe[PIPE_WRITE], buf, bytes_read) == -1) { ERR("Unable To Write Input To Child: %s", strerror(errno)); } } else { // Data Available From Child's stdout/stderr - ssize_t bytes_read = read(poll_fds[i].fd, (void *) buf, BUFFER_SIZE - 1 /* Account For NULL-Terminator */); + ssize_t bytes_read = read(poll_fds[i].fd, buf, BUFFER_SIZE - 1 /* Account For NULL-Terminator */); if (bytes_read == -1) { ERR("Unable To Read Log Data: %s", strerror(errno)); } @@ -196,9 +191,11 @@ void setup_crash_report() { fprintf(poll_fds[i].fd == output_pipe[PIPE_READ] ? stdout : stderr, "%s", buf); // Write To log - if (write(log_file_fd, (void *) buf, bytes_read) == -1) { + reborn_lock_log(); + if (write(reborn_get_log_fd(), buf, bytes_read) == -1) { ERR("Unable To Write Log Data: %s", strerror(errno)); } + reborn_unlock_log(); } } else { // File Descriptor No Longer Accessible @@ -232,18 +229,18 @@ void setup_crash_report() { fprintf(stderr, "%s", exit_code_line); // Write Exit Code Log Line - if (write(log_file_fd, (void *) exit_code_line, strlen(exit_code_line)) == -1) { + reborn_lock_log(); + if (write(reborn_get_log_fd(), exit_code_line, strlen(exit_code_line)) == -1) { ERR("Unable To Write Exit Code To Log: %s", strerror(errno)); } + reborn_unlock_log(); // Free Exit Code Log Line free(exit_code_line); } - // Close Log File FD - if (close(log_file_fd) == -1) { - ERR("Unable To Close Log File Descriptor: %s", strerror(errno)); - } + // Close Log File + reborn_close_log(); // Show Crash Log #ifndef MCPI_HEADLESS_MODE diff --git a/launcher/src/main.cpp b/launcher/src/main.cpp index e9ac0a13..b48eb8ad 100644 --- a/launcher/src/main.cpp +++ b/launcher/src/main.cpp @@ -135,6 +135,7 @@ int main(int argc, char *argv[]) { reborn_debug_tag = "(Launcher) "; // Debug Logging + unsetenv(MCPI_LOG_ENV); bind_to_env(MCPI_DEBUG_ENV, options.debug); // Handle Non-Launch Commands (Copy SDK, Print Feature Flags, Etc) diff --git a/libreborn/include/libreborn/log.h b/libreborn/include/libreborn/log.h index 84420943..da5d72d7 100644 --- a/libreborn/include/libreborn/log.h +++ b/libreborn/include/libreborn/log.h @@ -7,15 +7,24 @@ extern "C" { #endif -// Debug +// Log File +#define MCPI_LOG_ENV "_MCPI_LOG" +int reborn_get_log_fd(); +void reborn_lock_log(); +void reborn_unlock_log(); +void reborn_close_log(); +void reborn_set_log(const char *file); +// Debug Logging #define MCPI_DEBUG_ENV "MCPI_DEBUG" extern const char *reborn_debug_tag; int reborn_get_debug_fd(); +void reborn_lock_debug(); +void reborn_unlock_debug(); // Logging #define INFO(format, ...) { fprintf(stderr, "[INFO]: " format "\n", ##__VA_ARGS__); } #define WARN(format, ...) { fprintf(stderr, "[WARN]: " format "\n", ##__VA_ARGS__); } -#define RAW_DEBUG(tag, format, ...) { int debug_fd = reborn_get_debug_fd(); if (debug_fd != -1) { dprintf(debug_fd, "[DEBUG]: %s" format "\n", tag, ##__VA_ARGS__); } } +#define RAW_DEBUG(tag, format, ...) { reborn_lock_debug(); dprintf(reborn_get_debug_fd(), "[DEBUG]: %s" format "\n", tag, ##__VA_ARGS__); reborn_unlock_debug(); } #define DEBUG(format, ...) RAW_DEBUG(reborn_debug_tag, format, ##__VA_ARGS__) #define ERR(format, ...) { fprintf(stderr, "[ERR]: (%s:%i): " format "\n", __FILE__, __LINE__, ##__VA_ARGS__); exit(EXIT_FAILURE); } #define IMPOSSIBLE() ERR("This Should Never Be Called") diff --git a/libreborn/src/util/exec.c b/libreborn/src/util/exec.c index 45923a64..ae2806ef 100644 --- a/libreborn/src/util/exec.c +++ b/libreborn/src/util/exec.c @@ -66,13 +66,8 @@ char *run_command(const char *const command[], int *exit_status, size_t *output_ close(output_pipe[1]); // Setup stderr - if (getenv("MCPI_DEBUG") == NULL) { - const char *log_file_fd_env = getenv("MCPI_LOG_FILE_FD"); - if (log_file_fd_env == NULL) { - IMPOSSIBLE(); - } - dup2(atoi(log_file_fd_env), STDERR_FILENO); - } + reborn_lock_debug(); // Lock Released On Process Exit + dup2(reborn_get_debug_fd(), STDERR_FILENO); // Setup Environment setup_exec_environment(0); diff --git a/libreborn/src/util/log.c b/libreborn/src/util/log.c index 0217db63..b1dea25d 100644 --- a/libreborn/src/util/log.c +++ b/libreborn/src/util/log.c @@ -1,23 +1,73 @@ #include +#include +#include +#include +#include #include +#include // Debug Tag const char *reborn_debug_tag = ""; -// Debug FD -int reborn_get_debug_fd() { - if (getenv(MCPI_DEBUG_ENV) != NULL) { - return STDERR_FILENO; - } else { - static int debug_fd = -1; - if (debug_fd == -1) { - const char *log_file_fd_env = getenv("MCPI_LOG_FILE_FD"); - if (log_file_fd_env == NULL) { - return -1; - } - debug_fd = atoi(log_file_fd_env); - } - return debug_fd; +// Log File +static int log_fd = -1; +int reborn_get_log_fd() { + if (log_fd >= 0) { + return log_fd; + } + // Open Log File + const char *file = getenv(MCPI_LOG_ENV); + if (file == NULL) { + file = "/dev/null"; + } + log_fd = open(file, O_WRONLY | O_APPEND | O_CLOEXEC); + // Check FD + if (log_fd < 0) { + ERR("Unable To Open Log: %s", strerror(errno)); + } + // Return + return reborn_get_log_fd(); +} +void reborn_lock_log() { + int ret = flock(reborn_get_log_fd(), LOCK_EX); + if (ret != 0) { + ERR("Unable To Lock Log: %s", strerror(errno)); } } +void reborn_unlock_log() { + int ret = flock(reborn_get_log_fd(), LOCK_UN); + if (ret != 0) { + ERR("Unable To Unlock Log: %s", strerror(errno)); + } +} +__attribute__((destructor)) void reborn_close_log() { + if (log_fd >= 0) { + close(log_fd); + log_fd = -1; + } +} +void reborn_set_log(const char *file) { + // Close Current Log + reborn_close_log(); + // Set Variable + set_and_print_env(MCPI_LOG_ENV, file); +} + +// Debug Logging +static int should_print_debug_to_stderr() { + return getenv(MCPI_DEBUG_ENV) != NULL; +} +int reborn_get_debug_fd() { + return should_print_debug_to_stderr() ? STDERR_FILENO : reborn_get_log_fd(); +} +void reborn_lock_debug() { + if (!should_print_debug_to_stderr()) { + reborn_lock_log(); + } +} +void reborn_unlock_debug() { + if (!should_print_debug_to_stderr()) { + reborn_unlock_log(); + } +} \ No newline at end of file