PRINTF(9)
π PRINTF(9): formatted output conversion π
okay so welcome to the Kernel Developer's Manual, bestie β this is the page for printf, uprintf, tprintf, and log (plus vprintf() and vlog() chilling in the synopsis). It's giving kernel-side formatted output, and honestly the vibes are immaculate. π«Ά
πΈ NAME πΈ
printf, uprintf, tprintf, log β formatted output conversion. periodt.
β¨ SYNOPSIS β¨
#include <sys/types.h>
#include <sys/systm.h>
int
printf(const char *fmt, ...);
void
tprintf(struct proc *p, int pri, const char *fmt, ...);
int
uprintf(const char *fmt, ...);
int
vprintf(const char *fmt, va_list ap);
#include <sys/syslog.h>
void
log(int pri, const char *fmt, ...);
void
vlog(int pri, const char *fmt, va_list ap);
π DESCRIPTION π
The printf family of functions are similar to the printf(3) family of functions. The different functions each use a different output stream. no cap, that's the whole plot.
- The
uprintf()function outputs to the current process' controlling tty. - The
printf()function writes to the console as well as to the logging facility. - The
tprintf()function outputs to the tty associated with the processpand the logging facility ifpriis not-1. - The
log()function sends the message to the kernel logging facility, using the log level as indicated bypri, and to the console if no process is yet reading the log.
Each of these related functions use the fmt parameter in the same manner as printf(3). However, printf adds two other conversion specifiers and omits one. lowkey iconic behavior.
π %b β bitmask decode realness π
The %b identifier expects two arguments: an int and a char *. These are used as a register value and a print mask for decoding bitmasks.
The print mask is made up of two parts: the base and the arguments.
- The base value is the output base (radix) expressed as an octal value; for example,
\10gives octal and\20gives hexadecimal. - The arguments are made up of a sequence of bit identifiers.
Each bit identifier begins with a character specifying the number of the bit (starting from 1) this identifier describes.
- The characters from
\01to\40can be used to specify bit numbers in the range from 1 to 32. - The characters from
\200to\377to specify bit numbers in the range from 1 to 128.
The rest of the identifier is a string of characters containing the name of the bit. The identifier is terminated by either the bit number at the start of the next bit identifier or by NUL for the last bit identifier.
π¦ %D β hexdump helper π¦
The %D identifier is meant to assist in hexdumps. It requires two arguments: a u_char * pointer and a char * string.
The memory pointed to by the pointer is output in hexadecimal one byte at a time. The string is used as a delimiter between individual bytes. If present, a width directive will specify the number of bytes to display. By default, 16 bytes of data are output.
π %n β nope, not here π
The %n conversion specifier is not supported. not me looking for it, bestie, it's literally not on the menu.
π log() priority tea π
The log() function uses syslog(3) level values LOG_DEBUG through LOG_EMERG for its pri parameter (mistakenly called βpriorityβ here).
Alternatively, if a pri of -1 is given, the message will be appended to the last log message started by a previous call to log().
As these messages are generated by the kernel itself, the facility will always be LOG_KERN. periodt.
π¦ RETURN VALUES π¦
The printf() and the uprintf() functions return the number of characters displayed. that's it, that's the return value. β¨
π EXAMPLES π
This example demonstrates the use of the %b and %D conversion specifiers. The function
void
printf_test(void)
{
printf("reg=%b\n", 3, "\10\2BITTWO\1BITONE");
printf("out: %4D\n", "AAZZ", ":");
}
will produce the following output:
reg=3<BITTWO,BITONE>
out: 41:41:5a:5a
The same output will be generated by the following function:
void
printf_test(void)
{
printf("reg=%b\n", 3, "\10\201BITTWO\200BITONE");
printf("out: %4D\n", "AAZZ", ":");
}
The call
log(LOG_DEBUG, "%s%d: been there.\n", sc->sc_name, sc->sc_unit);
will add the appropriate debug message at priority βkern.debugβ to the system log.
π SEE ALSO π
π okay that's the whole PRINTF(9) page, bestie β sourced from Debian, dated December 19, 2025. periodt. π
π¦ where this page comes from
- freebsd 14.5: base 14.5
- freebsd 15.1: base 15.1
- Copyright (c) 2001 Andrew R. Reiter
- Copyright (c) 2004 Joerg Wunsch
- π girlified by deepseek-ai/DeepSeek-V4.1-Flash-1017 on : a language model's rewrite of the original, under its terms