mirror of
https://github.com/zephyrproject-rtos/zephyr
synced 2025-08-16 00:18:49 +00:00
d76ae46c0c
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>
76 lines
1.9 KiB
C
76 lines
1.9 KiB
C
/* printk.h - low-level debug output */
|
|
|
|
/*
|
|
* Copyright (c) 2010-2012, 2014 Wind River Systems, Inc.
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
#ifndef ZEPHYR_INCLUDE_SYS_PRINTK_H_
|
|
#define ZEPHYR_INCLUDE_SYS_PRINTK_H_
|
|
|
|
#include <toolchain.h>
|
|
#include <stddef.h>
|
|
#include <stdarg.h>
|
|
#include <inttypes.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
*
|
|
* @brief Print kernel debugging message.
|
|
*
|
|
* This routine prints a kernel debugging message to the system console.
|
|
* Output is send immediately, without any mutual exclusion or buffering.
|
|
*
|
|
* A basic set of conversion specifier characters are supported:
|
|
* - signed decimal: \%d, \%i
|
|
* - unsigned decimal: \%u
|
|
* - unsigned hexadecimal: \%x (\%X is treated as \%x)
|
|
* - pointer: \%p
|
|
* - string: \%s
|
|
* - character: \%c
|
|
* - percent: \%\%
|
|
*
|
|
* Field width (with or without leading zeroes) is supported.
|
|
* Length attributes h, hh, l, ll and z are supported. However, integral
|
|
* values with %lld and %lli are only printed if they fit in a long
|
|
* otherwise 'ERR' is printed. Full 64-bit values may be printed with %llx.
|
|
* Flags and precision attributes are not supported.
|
|
*
|
|
* @param fmt Format string.
|
|
* @param ... Optional list of format arguments.
|
|
*
|
|
* @return N/A
|
|
*/
|
|
#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);
|
|
#else
|
|
static inline __printf_like(1, 2) void printk(const char *fmt, ...)
|
|
{
|
|
ARG_UNUSED(fmt);
|
|
}
|
|
|
|
static inline __printf_like(1, 0) void vprintk(const char *fmt, va_list ap)
|
|
{
|
|
ARG_UNUSED(fmt);
|
|
ARG_UNUSED(ap);
|
|
}
|
|
#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
|
|
|
|
#endif
|