08f0d93cbb
If burst of log messages was passed to the shell log backend, it was likely that messages were lost because shell had no means to control arrivals of log messages. Added log message enqueueing timeout to the shell instance to allow blocking logger thread if short-term arrival rate exceeded shell capabilities. Added kconfig option for setting log message queue size and timeout in RTT and UART instances. Added section in shell documentation which explains interaction between the logger and shell instance acting as a logger backend. Signed-off-by: Krzysztof Chruscinski <krzysztof.chruscinski@nordicsemi.no>
111 lines
3.3 KiB
C
111 lines
3.3 KiB
C
/*
|
|
* Copyright (c) 2018 Nordic Semiconductor ASA
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
#ifndef SHELL_LOG_BACKEND_H__
|
|
#define SHELL_LOG_BACKEND_H__
|
|
|
|
#include <zephyr.h>
|
|
#include <logging/log_backend.h>
|
|
#include <logging/log_output.h>
|
|
#include <atomic.h>
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
extern const struct log_backend_api log_backend_shell_api;
|
|
|
|
/** @brief Shell log backend states. */
|
|
enum shell_log_backend_state {
|
|
SHELL_LOG_BACKEND_UNINIT,
|
|
SHELL_LOG_BACKEND_ENABLED,
|
|
SHELL_LOG_BACKEND_DISABLED,
|
|
SHELL_LOG_BACKEND_PANIC,
|
|
};
|
|
|
|
/** @brief Shell log backend control block (RW data). */
|
|
struct shell_log_backend_control_block {
|
|
atomic_t cnt;
|
|
enum shell_log_backend_state state;
|
|
};
|
|
|
|
/** @brief Shell log backend instance structure (RO data). */
|
|
struct shell_log_backend {
|
|
const struct log_backend *backend;
|
|
struct k_msgq *msgq;
|
|
const struct log_output *log_output;
|
|
struct shell_log_backend_control_block *control_block;
|
|
u32_t timeout;
|
|
};
|
|
|
|
/** @brief Prototype of function outputing processed data. */
|
|
int shell_log_backend_output_func(u8_t *data, size_t length, void *ctx);
|
|
|
|
/** @def SHELL_LOG_BACKEND_DEFINE
|
|
* @brief Macro for creating instance of shell log backend.
|
|
*
|
|
* @param _name Shell name.
|
|
* @param _buf Output buffer.
|
|
* @param _size Output buffer size.
|
|
* @param _queue_size Log message queue size.
|
|
* @param _timeout Timeout in milliseconds for pending on queue full.
|
|
* Message is dropped on timeout.
|
|
*/
|
|
/** @def SHELL_LOG_BACKEND_PTR
|
|
* @brief Macro for retrieving pointer to the instance of shell log backend.
|
|
*
|
|
* @param _name Shell name.
|
|
*/
|
|
#if CONFIG_LOG
|
|
#define SHELL_LOG_BACKEND_DEFINE(_name, _buf, _size, _queue_size, _timeout) \
|
|
LOG_BACKEND_DEFINE(_name##_backend, log_backend_shell_api, false); \
|
|
K_MSGQ_DEFINE(_name##_msgq, sizeof(void *), \
|
|
_queue_size, sizeof(void *)); \
|
|
LOG_OUTPUT_DEFINE(_name##_log_output, shell_log_backend_output_func, \
|
|
_buf, _size); \
|
|
static struct shell_log_backend_control_block _name##_control_block; \
|
|
static const struct shell_log_backend _name##_log_backend = { \
|
|
.backend = &_name##_backend, \
|
|
.msgq = &_name##_msgq, \
|
|
.log_output = &_name##_log_output, \
|
|
.control_block = &_name##_control_block, \
|
|
.timeout = _timeout \
|
|
}
|
|
|
|
#define SHELL_LOG_BACKEND_PTR(_name) (&_name##_log_backend)
|
|
#else /* CONFIG_LOG */
|
|
#define SHELL_LOG_BACKEND_DEFINE(_name, _buf, _size, _queue_size, _timeout)
|
|
#define SHELL_LOG_BACKEND_PTR(_name) NULL
|
|
#endif /* CONFIG_LOG */
|
|
|
|
/** @brief Enable shell log backend.
|
|
*
|
|
* @param backend Shell log backend instance.
|
|
* @param ctx Pointer to shell instance.
|
|
* @param init_log_level Initial log level set to all logging sources.
|
|
*/
|
|
void shell_log_backend_enable(const struct shell_log_backend *backend,
|
|
void *ctx, u32_t init_log_level);
|
|
|
|
/** @brief Disable shell log backend.
|
|
*
|
|
* @param backend Shell log backend instance.
|
|
*/
|
|
void shell_log_backend_disable(const struct shell_log_backend *backend);
|
|
|
|
/** @brief Trigger processing of one log entry.
|
|
*
|
|
* @param backend Shell log backend instance.
|
|
*
|
|
* @return True if message was processed, false if FIFO was empty
|
|
*/
|
|
bool shell_log_backend_process(const struct shell_log_backend *backend);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* SHELL_LOG_BACKEND_H__ */
|