michaelh/zephyr
1
0
Fork 0
Code Releases Activity

shell: Fix log messages queueing for multiple instances

Browse source 
Shell log backend was using k_fifo to enqueue log messages.
It was using field in log message that was used for same
purpose in log_core before passing message to backends.
However, this method supported only single shell as
other shell was corruption the fifo because field was
reused.

Modified shell log backend to use k_msgq for pending
messages.

Signed-off-by: Krzysztof Chruscinski <krzysztof.chruscinski@nordicsemi.no>
This commit is contained in:
Krzysztof Chruscinski 2018-11-22 11:34:41 +01:00 • committed by Anas Nashif
commit 96a610b736
2 changed files with 41 additions and 19 deletions
Download patch file Download diff file Expand all files Collapse all files

7
include/shell/shell_log_backend.h
View file

@ -34,7 +34,7 @@ struct shell_log_backend_control_block {
/** @brief Shell log backend instance structure (RO data). */ /** @brief Shell log backend instance structure (RO data). */
struct shell_log_backend { struct shell_log_backend {
const struct log_backend *backend; const struct log_backend *backend;
struct k_fifo *fifo; struct k_msgq *msgq;
const struct log_output *log_output; const struct log_output *log_output;
struct shell_log_backend_control_block *control_block; struct shell_log_backend_control_block *control_block;
}; };
@ -57,13 +57,14 @@ int shell_log_backend_output_func(u8_t *data, size_t length, void *ctx);
#if CONFIG_LOG #if CONFIG_LOG
#define SHELL_LOG_BACKEND_DEFINE(_name, _buf, _size) \ #define SHELL_LOG_BACKEND_DEFINE(_name, _buf, _size) \
LOG_BACKEND_DEFINE(_name##_backend, log_backend_shell_api, false); \ LOG_BACKEND_DEFINE(_name##_backend, log_backend_shell_api, false); \
K_FIFO_DEFINE(_name##_fifo); \ K_MSGQ_DEFINE(_name##_msgq, sizeof(void *), \
CONFIG_SHELL_MAX_LOG_MSG_BUFFERED, sizeof(void *)); \
LOG_OUTPUT_DEFINE(_name##_log_output, shell_log_backend_output_func, \ LOG_OUTPUT_DEFINE(_name##_log_output, shell_log_backend_output_func, \
_buf, _size); \ _buf, _size); \
static struct shell_log_backend_control_block _name##_control_block; \ static struct shell_log_backend_control_block _name##_control_block; \
static const struct shell_log_backend _name##_log_backend = { \ static const struct shell_log_backend _name##_log_backend = { \
.backend = &_name##_backend, \ .backend = &_name##_backend, \
.fifo = &_name##_fifo, \ .msgq = &_name##_msgq, \
.log_output = &_name##_log_output, \ .log_output = &_name##_log_output, \
.control_block = &_name##_control_block \ .control_block = &_name##_control_block \
} }

53
subsys/shell/shell_log_backend.c
View file

@ -26,41 +26,62 @@ void shell_log_backend_enable(const struct shell_log_backend *backend,
static struct log_msg *msg_from_fifo(const struct shell_log_backend *backend) static struct log_msg *msg_from_fifo(const struct shell_log_backend *backend)
{ {
struct log_msg *msg = k_fifo_get(backend->fifo, K_NO_WAIT); struct log_msg *msg;
int err;
if (msg) { err = k_msgq_get(backend->msgq, &msg, K_NO_WAIT);
atomic_dec(&backend->control_block->cnt);
}
return msg; return (err == 0) ? msg : NULL;
} }
static void fifo_flush(const struct shell_log_backend *backend) static void fifo_flush(const struct shell_log_backend *backend)
{ {
struct log_msg *msg = msg_from_fifo(backend); struct log_msg *msg;
/* Flush log messages. */ /* Flush log messages. */
while (msg) { while ((msg = msg_from_fifo(backend)) != NULL) {
log_msg_put(msg); log_msg_put(msg);
msg = msg_from_fifo(backend);
} }
} }
static void msg_to_fifo(const struct shell *shell, static void msg_to_fifo(const struct shell *shell,
struct log_msg *msg) struct log_msg *msg)
{ {
atomic_val_t cnt; int err;
k_fifo_put(shell->log_backend->fifo, msg); err = k_msgq_put(shell->log_backend->msgq, &msg, K_NO_WAIT);
cnt = atomic_inc(&shell->log_backend->control_block->cnt); switch (err) {
case 0:
break;
case -ENOMSG:
{
struct log_msg *old_msg;
/* If there is too much queued free the oldest one. */ /* drop one message */
if (cnt >= CONFIG_SHELL_MAX_LOG_MSG_BUFFERED) { old_msg = msg_from_fifo(shell->log_backend);
log_msg_put(msg_from_fifo(shell->log_backend));
if (IS_ENABLED(CONFIG_SHELL_STATS)) { if (old_msg) {
shell->stats->log_lost_cnt++; log_msg_put(old_msg);
if (IS_ENABLED(CONFIG_SHELL_STATS)) {
shell->stats->log_lost_cnt++;
}
} }
err = k_msgq_put(shell->log_backend->msgq, &msg, K_NO_WAIT);
if (err) {
/* Rather unusual sitaution as we just freed one element
* and there is no other context that puts into the
* mesq. */
__ASSERT_NO_MSG(0);
}
break;
}
default:
/* Other errors are not expected. */
__ASSERT_NO_MSG(0);
break;
} }
} }