michaelh/zephyr
1
0
Fork 0
Code Releases Activity

lib: os: make snprintk fns generally available

Browse source 
The intention of disabling CONFIG_PRINTK is that all
invocations of it will compile to nothing, saving a lot
of runtime overhead and footprint since all the format
strings are completely dropped; instances of printk()
and related functions are no-ops.

However, some subsystems need snprintk() for string
processing, since the snprintf() implementations in even
minimal C library are too costly in text footprint or
stack usage for some applications. This processing is
required for the application to even function.

This patch continues to have disabling  CONFIG_PRINTK to
cause the non snprintk functions to become no-ops, but
now we always compile the necessary bits for snprintk(),
relying on gc-sections to discard them if unused.

z_vprintk() is now unconditionally defined in the header
since it is not tied to any particular output sink and
is intended for users who know exactly what they are
doing (it's in zephyr private scope).

Relates to: #21564

Signed-off-by: Andrew Boie <andrew.p.boie@intel.com>
This commit is contained in:
Andrew Boie 2020-01-02 11:57:43 -08:00 • committed by Johan Hedberg
commit d76ae46c0c
4 changed files with 17 additions and 31 deletions
Download patch file Download diff file Expand all files Collapse all files

2
include/kernel.h
View file

@ -5274,6 +5274,7 @@ extern void k_mem_domain_remove_thread(k_tid_t thread);
/** @} */
#ifdef CONFIG_PRINTK
/**
* @brief Emit a character buffer to the console device
*
@ -5283,6 +5284,7 @@ extern void k_mem_domain_remove_thread(k_tid_t thread);
* @req K-MISC-006
*/
__syscall void k_str_out(char *c, size_t n);
#endif
/**
* @brief Disable preservation of floating point context information.

35
include/sys/printk.h
View file

@ -47,13 +47,6 @@ extern "C" {
#ifdef CONFIG_PRINTK
extern __printf_like(1, 2) void printk(const char *fmt, ...);
extern __printf_like(1, 0) void vprintk(const char *fmt, va_list ap);
extern __printf_like(3, 4) int snprintk(char *str, size_t size,
const char *fmt, ...);
extern __printf_like(3, 0) int vsnprintk(char *str, size_t size,
const char *fmt, va_list ap);
extern __printf_like(3, 0) void z_vprintk(int (*out)(int f, void *c), void *ctx,
const char *fmt, va_list ap);
#else
static inline __printf_like(1, 2) void printk(const char *fmt, ...)
{
@ -65,28 +58,16 @@ static inline __printf_like(1, 0) void vprintk(const char *fmt, va_list ap)
ARG_UNUSED(fmt);
ARG_UNUSED(ap);
}
static inline __printf_like(3, 4) int snprintk(char *str, size_t size,
const char *fmt, ...)
{
ARG_UNUSED(str);
ARG_UNUSED(size);
ARG_UNUSED(fmt);
return 0;
}
static inline __printf_like(3, 0) int vsnprintk(char *str, size_t size,
const char *fmt, va_list ap)
{
ARG_UNUSED(str);
ARG_UNUSED(size);
ARG_UNUSED(fmt);
ARG_UNUSED(ap);
return 0;
}
#endif
extern __printf_like(3, 4) int snprintk(char *str, size_t size,
const char *fmt, ...);
extern __printf_like(3, 0) int vsnprintk(char *str, size_t size,
const char *fmt, va_list ap);
extern __printf_like(3, 0) void z_vprintk(int (*out)(int f, void *c), void *ctx,
const char *fmt, va_list ap);
#ifdef __cplusplus
}
#endif

3
lib/os/CMakeLists.txt
View file

@ -11,6 +11,7 @@ zephyr_sources(
fdtable.c
hex.c
mempool.c
printk.c
rb.c
sem.c
thread_entry.c
@ -20,8 +21,6 @@ zephyr_sources(
zephyr_sources_ifdef(CONFIG_JSON_LIBRARY json.c)
zephyr_sources_if_kconfig(printk.c)
zephyr_sources_if_kconfig(ring_buffer.c)
zephyr_sources_ifdef(CONFIG_ASSERT assert.c)

8
lib/os/printk.c
View file

@ -37,6 +37,7 @@ static void _printk_hex_ulong(out_func_t out, void *ctx,
const unsigned long long num, enum pad_type padding,
int min_width);
#ifdef CONFIG_PRINTK
/**
* @brief Default character output routine that does nothing
* @param c Character to swallow
@ -84,6 +85,7 @@ void *__printk_get_hook(void)
{
return _char_out;
}
#endif /* CONFIG_PRINTK */
static void print_err(out_func_t out, void *ctx)
{
@ -285,6 +287,7 @@ still_might_format:
}
}
#ifdef CONFIG_PRINTK
#ifdef CONFIG_USERSPACE
struct buf_out_context {
int count;
@ -348,7 +351,7 @@ void vprintk(const char *fmt, va_list ap)
z_vprintk(char_out, &ctx, fmt, ap);
}
#endif
#endif /* CONFIG_USERSPACE */
void z_impl_k_str_out(char *c, size_t n)
{
@ -366,7 +369,7 @@ static inline void z_vrfy_k_str_out(char *c, size_t n)
z_impl_k_str_out((char *)c, n);
}
#include <syscalls/k_str_out_mrsh.c>
#endif
#endif /* CONFIG_USERSPACE */
/**
* @brief Output a string
@ -403,6 +406,7 @@ void printk(const char *fmt, ...)
}
va_end(ap);
}
#endif /* CONFIG_PRINTK */
/**
* @brief Output an unsigned long long in hex format