michaelh/zephyr
1
0
Fork 0
Code Releases Activity

logging: avoid identifier collisions

Browse source 
MISRA-C Rule 5.3 states that identifiers in inner scope should
not hide identifiers in outer scope.

The log output instances all named "log_output" in backends
collide with the "log_output" parameter of various functions.
This renames the variables in the backends to make them
more descriptive. Same goes for the buffers for some of
these instances as they are all named "buf", and "hostname"
being used in the network backend,  so they are renamed.

There are a few places where variables are overriden within
an inner scope (e.g. inside loop and if block) so they are
also renamed.

Signed-off-by: Daniel Leung <daniel.leung@intel.com>
This commit is contained in:
Daniel Leung 2020-07-23 14:39:34 -07:00 • committed by Anas Nashif
commit 3c2d0f37a3
10 changed files with 65 additions and 59 deletions
Download patch file Download diff file Expand all files Collapse all files

13
subsys/logging/log_backend_native_posix.c
View file

@ -55,7 +55,7 @@ static int char_out(uint8_t *data, size_t length, void *ctx)
return length;
}
LOG_OUTPUT_DEFINE(log_output, char_out, buf, sizeof(buf));
LOG_OUTPUT_DEFINE(log_output_posix, char_out, buf, sizeof(buf));
static void put(const struct log_backend *const backend,
struct log_msg *msg)
@ -74,7 +74,7 @@ static void put(const struct log_backend *const backend,
flags |= LOG_OUTPUT_FLAG_FORMAT_TIMESTAMP;
}
log_output_msg_process(&log_output, msg, flags);
log_output_msg_process(&log_output_posix, msg, flags);
log_msg_put(msg);
@ -82,14 +82,14 @@ static void put(const struct log_backend *const backend,
static void panic(struct log_backend const *const backend)
{
log_output_flush(&log_output);
log_output_flush(&log_output_posix);
}
static void dropped(const struct log_backend *const backend, uint32_t cnt)
{
ARG_UNUSED(backend);
log_output_dropped_process(&log_output, cnt);
log_output_dropped_process(&log_output_posix, cnt);
}
static void sync_string(const struct log_backend *const backend,
@ -108,7 +108,8 @@ static void sync_string(const struct log_backend *const backend,
}
key = irq_lock();
log_output_string(&log_output, src_level, timestamp, fmt, ap, flags);
log_output_string(&log_output_posix, src_level,
timestamp, fmt, ap, flags);
irq_unlock(key);
}
@ -128,7 +129,7 @@ static void sync_hexdump(const struct log_backend *const backend,
}
key = irq_lock();
log_output_hexdump(&log_output, src_level, timestamp,
log_output_hexdump(&log_output_posix, src_level, timestamp,
metadata, data, length, flags);
irq_unlock(key);
}

19
subsys/logging/log_backend_net.c
View file

@ -29,7 +29,7 @@ LOG_MODULE_REGISTER(log_backend_net, CONFIG_LOG_DEFAULT_LEVEL);
#define MAX_HOSTNAME_LEN NET_IPV4_ADDR_LEN
#endif
static char hostname[MAX_HOSTNAME_LEN + 1];
static char dev_hostname[MAX_HOSTNAME_LEN + 1];
static uint8_t output_buf[CONFIG_LOG_BACKEND_NET_MAX_BUF_SIZE];
static bool net_init_done;
@ -73,7 +73,7 @@ fail:
return length;
}
LOG_OUTPUT_DEFINE(log_output, line_out, output_buf, sizeof(output_buf));
LOG_OUTPUT_DEFINE(log_output_net, line_out, output_buf, sizeof(output_buf));
static int do_net_init(void)
{
@ -111,7 +111,7 @@ static int do_net_init(void)
}
if (IS_ENABLED(CONFIG_NET_HOSTNAME_ENABLE)) {
(void)strncpy(hostname, net_hostname_get(), MAX_HOSTNAME_LEN);
(void)strncpy(dev_hostname, net_hostname_get(), MAX_HOSTNAME_LEN);
} else if (IS_ENABLED(CONFIG_NET_IPV6) &&
server_addr.sa_family == AF_INET6) {
@ -120,7 +120,7 @@ static int do_net_init(void)
src = net_if_ipv6_select_src_addr(
NULL, &net_sin6(&server_addr)->sin6_addr);
if (src) {
net_addr_ntop(AF_INET6, src, hostname,
net_addr_ntop(AF_INET6, src, dev_hostname,
MAX_HOSTNAME_LEN);
net_ipaddr_copy(&local_addr6.sin6_addr, src);
@ -140,7 +140,7 @@ static int do_net_init(void)
net_ipaddr_copy(&local_addr4.sin_addr,
&ipv4->unicast[0].address.in_addr);
net_addr_ntop(AF_INET, &local_addr4.sin_addr, hostname,
net_addr_ntop(AF_INET, &local_addr4.sin_addr, dev_hostname,
MAX_HOSTNAME_LEN);
} else {
unknown:
@ -164,8 +164,8 @@ static int do_net_init(void)
net_context_setup_pools(ctx, get_tx_slab, get_data_pool);
log_output_ctx_set(&log_output, ctx);
log_output_hostname_set(&log_output, hostname);
log_output_ctx_set(&log_output_net, ctx);
log_output_hostname_set(&log_output_net, dev_hostname);
return 0;
}
@ -183,7 +183,7 @@ static void send_output(const struct log_backend *const backend,
log_msg_get(msg);
log_output_msg_process(&log_output, msg,
log_output_msg_process(&log_output_net, msg,
LOG_OUTPUT_FLAG_FORMAT_SYSLOG |
LOG_OUTPUT_FLAG_TIMESTAMP |
(IS_ENABLED(CONFIG_LOG_BACKEND_NET_SYST_ENABLE) ?
@ -229,7 +229,8 @@ static void sync_string(const struct log_backend *const backend,
}
key = irq_lock();
log_output_string(&log_output, src_level, timestamp, fmt, ap, flags);
log_output_string(&log_output_net, src_level,
timestamp, fmt, ap, flags);
irq_unlock(key);
}

15
subsys/logging/log_backend_rb.c
View file

@ -81,9 +81,9 @@ static int char_out(uint8_t *data, size_t length, void *ctx)
}
/* magic and log id takes space */
static uint8_t buf[CONFIG_LOG_BACKEND_RB_SLOT_SIZE - 4];
static uint8_t rb_log_buf[CONFIG_LOG_BACKEND_RB_SLOT_SIZE - 4];
LOG_OUTPUT_DEFINE(log_output, char_out, buf, sizeof(buf));
LOG_OUTPUT_DEFINE(log_output_rb, char_out, rb_log_buf, sizeof(rb_log_buf));
static void put(const struct log_backend *const backend,
struct log_msg *msg)
@ -96,21 +96,21 @@ static void put(const struct log_backend *const backend,
flags |= LOG_OUTPUT_FLAG_FORMAT_TIMESTAMP;
}
log_output_msg_process(&log_output, msg, flags);
log_output_msg_process(&log_output_rb, msg, flags);
log_msg_put(msg);
}
static void panic(struct log_backend const *const backend)
{
log_output_flush(&log_output);
log_output_flush(&log_output_rb);
}
static void dropped(const struct log_backend *const backend, uint32_t cnt)
{
ARG_UNUSED(backend);
log_output_dropped_process(&log_output, cnt);
log_output_dropped_process(&log_output_rb, cnt);
}
static void sync_string(const struct log_backend *const backend,
@ -125,7 +125,8 @@ static void sync_string(const struct log_backend *const backend,
}
key = irq_lock();
log_output_string(&log_output, src_level, timestamp, fmt, ap, flags);
log_output_string(&log_output_rb, src_level,
timestamp, fmt, ap, flags);
irq_unlock(key);
}
@ -141,7 +142,7 @@ static void sync_hexdump(const struct log_backend *const backend,
}
key = irq_lock();
log_output_hexdump(&log_output, src_level, timestamp,
log_output_hexdump(&log_output_rb, src_level, timestamp,
metadata, data, length, flags);
irq_unlock(key);
}

15
subsys/logging/log_backend_rtt.c
View file

@ -225,8 +225,9 @@ static int data_out_block_mode(uint8_t *data, size_t length, void *ctx)
return ((ret == 0) && host_present) ? 0 : length;
}
LOG_OUTPUT_DEFINE(log_output, IS_ENABLED(CONFIG_LOG_BACKEND_RTT_MODE_BLOCK) ?
data_out_block_mode : data_out_drop_mode,
LOG_OUTPUT_DEFINE(log_output_rtt,
IS_ENABLED(CONFIG_LOG_BACKEND_RTT_MODE_BLOCK) ?
data_out_block_mode : data_out_drop_mode,
char_buf, sizeof(char_buf));
static void put(const struct log_backend *const backend,
@ -235,7 +236,7 @@ static void put(const struct log_backend *const backend,
uint32_t flag = IS_ENABLED(CONFIG_LOG_BACKEND_RTT_SYST_ENABLE) ?
LOG_OUTPUT_FLAG_FORMAT_SYST : 0;
log_backend_std_put(&log_output, flag, msg);
log_backend_std_put(&log_output_rtt, flag, msg);
}
static void log_backend_rtt_cfg(void)
@ -258,14 +259,14 @@ static void log_backend_rtt_init(void)
static void panic(struct log_backend const *const backend)
{
panic_mode = true;
log_backend_std_panic(&log_output);
log_backend_std_panic(&log_output_rtt);
}
static void dropped(const struct log_backend *const backend, uint32_t cnt)
{
ARG_UNUSED(backend);
log_backend_std_dropped(&log_output, cnt);
log_backend_std_dropped(&log_output_rtt, cnt);
}
static void sync_string(const struct log_backend *const backend,
@ -275,7 +276,7 @@ static void sync_string(const struct log_backend *const backend,
uint32_t flag = IS_ENABLED(CONFIG_LOG_BACKEND_RTT_SYST_ENABLE) ?
LOG_OUTPUT_FLAG_FORMAT_SYST : 0;
log_backend_std_sync_string(&log_output, flag, src_level,
log_backend_std_sync_string(&log_output_rtt, flag, src_level,
timestamp, fmt, ap);
}
@ -286,7 +287,7 @@ static void sync_hexdump(const struct log_backend *const backend,
uint32_t flag = IS_ENABLED(CONFIG_LOG_BACKEND_RTT_SYST_ENABLE) ?
LOG_OUTPUT_FLAG_FORMAT_SYST : 0;
log_backend_std_sync_hexdump(&log_output, flag, src_level,
log_backend_std_sync_hexdump(&log_output_rtt, flag, src_level,
timestamp, metadata, data, length);
}

10
subsys/logging/log_backend_spinel.c
View file

@ -20,7 +20,7 @@ static bool panic_mode;
static int write(uint8_t *data, size_t length, void *ctx);
LOG_OUTPUT_DEFINE(log_output, write, char_buf, sizeof(char_buf));
LOG_OUTPUT_DEFINE(log_output_spinel, write, char_buf, sizeof(char_buf));
static inline bool is_panic_mode(void)
{
@ -33,7 +33,7 @@ static void put(const struct log_backend *const backend,
/* prevent adding CRLF, which may crash spinel decoding */
uint32_t flag = LOG_OUTPUT_FLAG_CRLF_NONE;
log_backend_std_put(&log_output, flag, msg);
log_backend_std_put(&log_output_spinel, flag, msg);
}
static void sync_string(const struct log_backend *const backend,
@ -43,7 +43,7 @@ static void sync_string(const struct log_backend *const backend,
/* prevent adding CRLF, which may crash spinel decoding */
uint32_t flag = LOG_OUTPUT_FLAG_CRLF_NONE;
log_backend_std_sync_string(&log_output, flag, src_level,
log_backend_std_sync_string(&log_output_spinel, flag, src_level,
timestamp, fmt, ap);
}
@ -55,7 +55,7 @@ static void sync_hexdump(const struct log_backend *const backend,
/* prevent adding CRLF, which may crash spinel decoding */
uint32_t flag = LOG_OUTPUT_FLAG_CRLF_NONE;
log_backend_std_sync_hexdump(&log_output, flag, src_level,
log_backend_std_sync_hexdump(&log_output_spinel, flag, src_level,
timestamp, metadata, data, length);
}
@ -74,7 +74,7 @@ static void dropped(const struct log_backend *const backend, uint32_t cnt)
{
ARG_UNUSED(backend);
log_backend_std_dropped(&log_output, cnt);
log_backend_std_dropped(&log_output_spinel, cnt);
}
static int write(uint8_t *data, size_t length, void *ctx)

10
subsys/logging/log_backend_swo.c
View file

@ -63,7 +63,7 @@ static int char_out(uint8_t *data, size_t length, void *ctx)
return length;
}
LOG_OUTPUT_DEFINE(log_output, char_out, buf, sizeof(buf));
LOG_OUTPUT_DEFINE(log_output_swo, char_out, buf, sizeof(buf));
static void log_backend_swo_put(const struct log_backend *const backend,
struct log_msg *msg)
@ -71,7 +71,7 @@ static void log_backend_swo_put(const struct log_backend *const backend,
uint32_t flag = IS_ENABLED(CONFIG_LOG_BACKEND_SWO_SYST_ENABLE) ?
LOG_OUTPUT_FLAG_FORMAT_SYST : 0;
log_backend_std_put(&log_output, flag, msg);
log_backend_std_put(&log_output_swo, flag, msg);
}
static void log_backend_swo_init(void)
@ -108,7 +108,7 @@ static void dropped(const struct log_backend *const backend, uint32_t cnt)
{
ARG_UNUSED(backend);
log_backend_std_dropped(&log_output, cnt);
log_backend_std_dropped(&log_output_swo, cnt);
}
static void log_backend_swo_sync_string(const struct log_backend *const backend,
@ -118,7 +118,7 @@ static void log_backend_swo_sync_string(const struct log_backend *const backend,
uint32_t flag = IS_ENABLED(CONFIG_LOG_BACKEND_SWO_SYST_ENABLE) ?
LOG_OUTPUT_FLAG_FORMAT_SYST : 0;
log_backend_std_sync_string(&log_output, flag, src_level,
log_backend_std_sync_string(&log_output_swo, flag, src_level,
timestamp, fmt, ap);
}
@ -130,7 +130,7 @@ static void log_backend_swo_sync_hexdump(
uint32_t flag = IS_ENABLED(CONFIG_LOG_BACKEND_SWO_SYST_ENABLE) ?
LOG_OUTPUT_FLAG_FORMAT_SYST : 0;
log_backend_std_sync_hexdump(&log_output, flag, src_level,
log_backend_std_sync_hexdump(&log_output_swo, flag, src_level,
timestamp, metadata, data, length);
}

16
subsys/logging/log_backend_uart.c
View file

@ -24,9 +24,9 @@ static int char_out(uint8_t *data, size_t length, void *ctx)
return length;
}
static uint8_t buf;
static uint8_t uart_output_buf;
LOG_OUTPUT_DEFINE(log_output, char_out, &buf, 1);
LOG_OUTPUT_DEFINE(log_output_uart, char_out, &uart_output_buf, 1);
static void put(const struct log_backend *const backend,
struct log_msg *msg)
@ -34,7 +34,7 @@ static void put(const struct log_backend *const backend,
uint32_t flag = IS_ENABLED(CONFIG_LOG_BACKEND_UART_SYST_ENABLE) ?
LOG_OUTPUT_FLAG_FORMAT_SYST : 0;
log_backend_std_put(&log_output, flag, msg);
log_backend_std_put(&log_output_uart, flag, msg);
}
static void log_backend_uart_init(void)
@ -44,19 +44,19 @@ static void log_backend_uart_init(void)
dev = device_get_binding(CONFIG_UART_CONSOLE_ON_DEV_NAME);
assert(dev);
log_output_ctx_set(&log_output, dev);
log_output_ctx_set(&log_output_uart, dev);
}
static void panic(struct log_backend const *const backend)
{
log_backend_std_panic(&log_output);
log_backend_std_panic(&log_output_uart);
}
static void dropped(const struct log_backend *const backend, uint32_t cnt)
{
ARG_UNUSED(backend);
log_backend_std_dropped(&log_output, cnt);
log_backend_std_dropped(&log_output_uart, cnt);
}
static void sync_string(const struct log_backend *const backend,
@ -66,7 +66,7 @@ static void sync_string(const struct log_backend *const backend,
uint32_t flag = IS_ENABLED(CONFIG_LOG_BACKEND_UART_SYST_ENABLE) ?
LOG_OUTPUT_FLAG_FORMAT_SYST : 0;
log_backend_std_sync_string(&log_output, flag, src_level,
log_backend_std_sync_string(&log_output_uart, flag, src_level,
timestamp, fmt, ap);
}
@ -77,7 +77,7 @@ static void sync_hexdump(const struct log_backend *const backend,
uint32_t flag = IS_ENABLED(CONFIG_LOG_BACKEND_UART_SYST_ENABLE) ?
LOG_OUTPUT_FLAG_FORMAT_SYST : 0;
log_backend_std_sync_hexdump(&log_output, flag, src_level,
log_backend_std_sync_hexdump(&log_output_uart, flag, src_level,
timestamp, metadata, data, length);
}

15
subsys/logging/log_backend_xtensa_sim.c
View file

@ -18,7 +18,7 @@
#define CHAR_BUF_SIZE (IS_ENABLED(CONFIG_LOG_IMMEDIATE) ? \
1 : CONFIG_LOG_BACKEND_XTENSA_OUTPUT_BUFFER_SIZE)
static uint8_t buf[CHAR_BUF_SIZE];
static uint8_t xtensa_log_buf[CHAR_BUF_SIZE];
static int char_out(uint8_t *data, size_t length, void *ctx)
{
@ -34,32 +34,33 @@ static int char_out(uint8_t *data, size_t length, void *ctx)
return length;
}
LOG_OUTPUT_DEFINE(log_output, char_out, buf, sizeof(buf));
LOG_OUTPUT_DEFINE(log_output_xsim, char_out,
xtensa_log_buf, sizeof(xtensa_log_buf));
static void put(const struct log_backend *const backend,
struct log_msg *msg)
{
log_backend_std_put(&log_output, 0, msg);
log_backend_std_put(&log_output_xsim, 0, msg);
}
static void panic(struct log_backend const *const backend)
{
log_backend_std_panic(&log_output);
log_backend_std_panic(&log_output_xsim);
}
static void dropped(const struct log_backend *const backend, uint32_t cnt)
{
ARG_UNUSED(backend);
log_backend_std_dropped(&log_output, cnt);
log_backend_std_dropped(&log_output_xsim, cnt);
}
static void sync_string(const struct log_backend *const backend,
struct log_msg_ids src_level, uint32_t timestamp,
const char *fmt, va_list ap)
{
log_backend_std_sync_string(&log_output, 0, src_level,
log_backend_std_sync_string(&log_output_xsim, 0, src_level,
timestamp, fmt, ap);
}
@ -67,7 +68,7 @@ static void sync_hexdump(const struct log_backend *const backend,
struct log_msg_ids src_level, uint32_t timestamp,
const char *metadata, const uint8_t *data, uint32_t length)
{
log_backend_std_sync_hexdump(&log_output, 0, src_level,
log_backend_std_sync_hexdump(&log_output_xsim, 0, src_level,
timestamp, metadata, data, length);
}

7
subsys/logging/log_core.c
View file

@ -760,13 +760,14 @@ uint32_t z_impl_log_filter_set(struct log_backend const *const backend,
uint32_t *filters = log_dynamic_filters_get(src_id);
if (backend == NULL) {
struct log_backend const *backend;
struct log_backend const *iter_backend;
uint32_t max = 0U;
uint32_t current;
for (int i = 0; i < log_backend_count_get(); i++) {
backend = log_backend_get(i);
current = log_filter_set(backend, domain_id,
iter_backend = log_backend_get(i);
current = log_filter_set(iter_backend,
domain_id,
src_id, level);
max = MAX(current, max);
}

4
subsys/logging/log_output.c
View file

@ -229,9 +229,9 @@ static void color_print(const struct log_output *log_output,
bool color, bool start, uint32_t level)
{
if (color) {
const char *color = start && (colors[level] != NULL) ?
const char *log_color = start && (colors[level] != NULL) ?
colors[level] : LOG_COLOR_CODE_DEFAULT;
print_formatted(log_output, "%s", color);
print_formatted(log_output, "%s", log_color);
}
}