blob: 0701f8a3a6feadf12b0774c1e001c48cf35a9a80 [file] [log] [blame]
/*
* Copyright (c) 2010, 2013-2014 Wind River Systems, Inc.
*
* SPDX-License-Identifier: Apache-2.0
*/
/**
* @file
* @brief Low-level debug output
*
* Low-level debugging output. Platform installs a character output routine at
* init time. If no routine is installed, a nop routine is called.
*/
#include <zephyr/kernel.h>
#include <zephyr/sys/printk.h>
#include <stdarg.h>
#include <zephyr/toolchain.h>
#include <zephyr/linker/sections.h>
#include <zephyr/syscall_handler.h>
#include <zephyr/logging/log.h>
#include <zephyr/sys/cbprintf.h>
#include <zephyr/llext/symbol.h>
#include <sys/types.h>
/* Option present only when CONFIG_USERSPACE enabled. */
#ifndef CONFIG_PRINTK_BUFFER_SIZE
#define CONFIG_PRINTK_BUFFER_SIZE 0
#endif
#if defined(CONFIG_PRINTK_SYNC)
static struct k_spinlock lock;
#endif
#ifdef CONFIG_PRINTK
/**
* @brief Default character output routine that does nothing
* @param c Character to swallow
*
* Note this is defined as a weak symbol, allowing architecture code
* to override it where possible to enable very early logging.
*
* @return 0
*/
/* LCOV_EXCL_START */
__attribute__((weak)) int arch_printk_char_out(int c)
{
ARG_UNUSED(c);
/* do nothing */
return 0;
}
/* LCOV_EXCL_STOP */
int (*_char_out)(int c) = arch_printk_char_out;
/**
* @brief Install the character output routine for printk
*
* To be called by the platform's console driver at init time. Installs a
* routine that outputs one ASCII character at a time.
* @param fn putc routine to install
*/
void __printk_hook_install(int (*fn)(int c))
{
_char_out = fn;
}
/**
* @brief Get the current character output routine for printk
*
* To be called by any console driver that would like to save
* current hook - if any - for later re-installation.
*
* @return a function pointer or NULL if no hook is set
*/
void *__printk_get_hook(void)
{
return _char_out;
}
struct buf_out_context {
#ifdef CONFIG_PICOLIBC
FILE file;
#endif
unsigned int buf_count;
char buf[CONFIG_PRINTK_BUFFER_SIZE];
};
static void buf_flush(struct buf_out_context *ctx)
{
k_str_out(ctx->buf, ctx->buf_count);
ctx->buf_count = 0U;
}
static int buf_char_out(int c, void *ctx_p)
{
struct buf_out_context *ctx = ctx_p;
ctx->buf[ctx->buf_count++] = c;
if (ctx->buf_count == CONFIG_PRINTK_BUFFER_SIZE) {
buf_flush(ctx);
}
return c;
}
static int char_out(int c, void *ctx_p)
{
(void) ctx_p;
return _char_out(c);
}
void vprintk(const char *fmt, va_list ap)
{
if (IS_ENABLED(CONFIG_LOG_PRINTK)) {
z_log_vprintk(fmt, ap);
return;
}
if (k_is_user_context()) {
struct buf_out_context ctx = {
#ifdef CONFIG_PICOLIBC
.file = FDEV_SETUP_STREAM((int(*)(char, FILE *))buf_char_out,
NULL, NULL, _FDEV_SETUP_WRITE),
#else
0
#endif
};
#ifdef CONFIG_PICOLIBC
(void) vfprintf(&ctx.file, fmt, ap);
#else
cbvprintf(buf_char_out, &ctx, fmt, ap);
#endif
if (ctx.buf_count) {
buf_flush(&ctx);
}
} else {
#ifdef CONFIG_PRINTK_SYNC
k_spinlock_key_t key = k_spin_lock(&lock);
#endif
#ifdef CONFIG_PICOLIBC
FILE console = FDEV_SETUP_STREAM((int(*)(char, FILE *))char_out,
NULL, NULL, _FDEV_SETUP_WRITE);
(void) vfprintf(&console, fmt, ap);
#else
cbvprintf(char_out, NULL, fmt, ap);
#endif
#ifdef CONFIG_PRINTK_SYNC
k_spin_unlock(&lock, key);
#endif
}
}
void z_impl_k_str_out(char *c, size_t n)
{
size_t i;
#ifdef CONFIG_PRINTK_SYNC
k_spinlock_key_t key = k_spin_lock(&lock);
#endif
for (i = 0; i < n; i++) {
_char_out(c[i]);
}
#ifdef CONFIG_PRINTK_SYNC
k_spin_unlock(&lock, key);
#endif
}
#ifdef CONFIG_USERSPACE
static inline void z_vrfy_k_str_out(char *c, size_t n)
{
Z_OOPS(Z_SYSCALL_MEMORY_READ(c, n));
z_impl_k_str_out((char *)c, n);
}
#include <syscalls/k_str_out_mrsh.c>
#endif /* CONFIG_USERSPACE */
/**
* @brief Output a string
*
* Output a string on output installed by platform at init time. Some
* printf-like formatting is available.
*
* Available formatting:
* - %x/%X: outputs a number in hexadecimal format
* - %s: outputs a null-terminated string
* - %p: pointer, same as %x with a 0x prefix
* - %u: outputs a number in unsigned decimal format
* - %d/%i: outputs a number in signed decimal format
*
* 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.
*
* @param fmt formatted string to output
*/
void printk(const char *fmt, ...)
{
va_list ap;
va_start(ap, fmt);
vprintk(fmt, ap);
va_end(ap);
}
EXPORT_SYMBOL(printk);
#endif /* defined(CONFIG_PRINTK) */
#ifndef CONFIG_PICOLIBC
struct str_context {
char *str;
int max;
int count;
};
static int str_out(int c, struct str_context *ctx)
{
if (ctx->str == NULL || ctx->count >= ctx->max) {
ctx->count++;
return c;
}
if (ctx->count == ctx->max - 1) {
ctx->str[ctx->count++] = '\0';
} else {
ctx->str[ctx->count++] = c;
}
return c;
}
int snprintk(char *str, size_t size, const char *fmt, ...)
{
va_list ap;
int ret;
va_start(ap, fmt);
ret = vsnprintk(str, size, fmt, ap);
va_end(ap);
return ret;
}
int vsnprintk(char *str, size_t size, const char *fmt, va_list ap)
{
struct str_context ctx = { str, size, 0 };
cbvprintf(str_out, &ctx, fmt, ap);
if (ctx.count < ctx.max) {
str[ctx.count] = '\0';
}
return ctx.count;
}
#endif