Logging with colors #162
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,86 @@ | ||
| #include <stdbool.h> | ||
| #include <stdio.h> | ||
| #include "stm32xx_hal.h" | ||
|
|
||
| #ifndef LOGGING_ENABLE | ||
| #define LOGGING_ENABLE 0 | ||
| #endif | ||
|
|
||
| #ifndef LOGGING_LEVEL | ||
| #define LOGGING_LEVEL 6 | ||
| #endif | ||
|
|
||
| #define LOG_MAX_BEFORE_SIZE 32 | ||
| #define LOG_MAX_LOG_SIZE 128 | ||
|
|
||
| #define CONVERT_TO_STRING(arg) #arg | ||
| #define AS_STRING(arg) CONVERT_TO_STRING(arg) | ||
|
|
||
| static char log_buf[LOG_MAX_LOG_SIZE]; | ||
| static char log_before_buf[LOG_MAX_BEFORE_SIZE]; | ||
|
|
||
| typedef enum { | ||
| L_NONE = 0, | ||
| L_FATAL = 1, | ||
| L_ERROR = 2, | ||
| L_WARN = 3, | ||
| L_INFO = 4, | ||
| L_DEBUG = 5, | ||
| L_TRACE = 6, | ||
| } LoggingLevel; | ||
|
|
||
| static inline const char * | ||
| log_level_name(LoggingLevel level) | ||
| { | ||
| switch (level) { | ||
| case L_TRACE: return "TRACE"; | ||
| case L_DEBUG: return "DEBUG"; | ||
| case L_INFO: return "INFO"; | ||
| case L_WARN: return "WARN"; | ||
| case L_ERROR: return "ERROR"; | ||
| case L_FATAL: return "FATAL"; | ||
| case L_NONE: return "NONE"; | ||
| } | ||
| /* Should be unreachable */ | ||
| return NULL; | ||
| } | ||
|
Comment on lines
+32
to
+46
Contributor
There was a problem hiding this comment. This function returns To make the logger more robust, consider adding a static inline const char *
log_level_name(LoggingLevel level)
{
switch (level) {
case L_TRACE: return "TRACE";
case L_DEBUG: return "DEBUG";
case L_INFO: return "INFO";
case L_WARN: return "WARN";
case L_ERROR: return "ERROR";
case L_FATAL: return "FATAL";
case L_NONE: return "NONE";
default: return "?????";
}
} |
||
|
|
||
| static inline const char * | ||
| log_level_color(LoggingLevel level) | ||
| { | ||
| switch (level) { | ||
| case L_TRACE: return "\x1b[00;34m"; | ||
| case L_DEBUG: return "\x1b[00;35m"; | ||
| case L_INFO: return "\x1b[00;36m"; | ||
| case L_WARN: return "\x1b[00;33m"; | ||
| case L_ERROR: return "\x1b[00;31m"; | ||
| case L_FATAL: return "\x1b[37;41m"; | ||
| case L_NONE: return "\x1b[0m"; | ||
| } | ||
| /* Should be unreachable */ | ||
| return NULL; | ||
| } | ||
|
Comment on lines
+48
to
+62
Contributor
There was a problem hiding this comment. Similar to static inline const char *
log_level_color(LoggingLevel level)
{
switch (level) {
case L_TRACE: return "\x1b[00;34m";
case L_DEBUG: return "\x1b[00;35m";
case L_INFO: return "\x1b[00;36m";
case L_WARN: return "\x1b[00;33m";
case L_ERROR: return "\x1b[00;31m";
case L_FATAL: return "\x1b[37;41m";
case L_NONE: return "\x1b[0m";
default: return "\x1b[0m";
}
} |
||
|
|
||
| static inline void | ||
| log_printf(void) | ||
| { | ||
| printf("%-" AS_STRING(LOG_MAX_BEFORE_SIZE) "s | %s%s\n\r\r", | ||
| (char *)&log_before_buf, (char *)&log_buf, log_level_color(L_NONE)); | ||
| } | ||
|
|
||
| #if LOGGING_ENABLE == 0 || LOGGING_LEVEL == 0 | ||
| #define log(LEVEL, fmt ...) | ||
| #else | ||
| #define log(LEVEL, fmt ...) \ | ||
| do { \ | ||
| LoggingLevel level = LEVEL; \ | ||
| if (LOGGING_LEVEL >= level) { \ | ||
| snprintf(log_before_buf, LOG_MAX_BEFORE_SIZE, \ | ||
| "%s%-5s | %s() ", \ | ||
| log_level_color(level), log_level_name(level), \ | ||
| pcTaskGetTaskName(NULL)); \ | ||
| snprintf((char *)&log_buf, LOG_MAX_LOG_SIZE, fmt); \ | ||
|
Contributor
There was a problem hiding this comment. The cast snprintf(log_buf, LOG_MAX_LOG_SIZE, fmt); |
||
| log_printf(); \ | ||
| } \ | ||
| } while (0) | ||
| #endif | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,10 @@ | ||
| #pragma once | ||
|
|
||
| #include <stdbool.h> | ||
| #include <stdio.h> | ||
| #include "UART.h" | ||
|
|
||
| extern int printf ( const char * format, ... ); | ||
|
|
||
| void task_print_init(UART_HandleTypeDef *huart); | ||
| void task_print(void *huart); |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The global static buffers
log_bufandlog_before_bufare not thread-safe. This project uses FreeRTOS, and if two tasks call thelog()macro concurrently, they will write to these buffers at the same time, leading to a race condition and corrupted log output.To ensure thread safety, all operations within the
logmacro that use these shared buffers should be atomic. This can be achieved by protecting the critical section with a mutex. You'll likely need to add an initialization function for the logger to create the mutex, which should be called once at startup before any logging occurs.