vsprintf.c File Reference

#include <stddef.h>
#include <stdarg.h>
#include <stdio.h>
#include <console.h>
#include <errno.h>
#include <gpxe/vsprintf.h>

Go to the source code of this file.

Data Structures
struct	sputc_context
	Context used by vsnprintf() and friends. More...
Defines
#define	CHAR_LEN   0
	"hh" length modifier
#define	SHORT_LEN   1
	"h" length modifier
#define	INT_LEN   2
	no length modifier
#define	LONG_LEN   3
	"l" length modifier
#define	LONGLONG_LEN   4
	"ll" length modifier
#define	SIZE_T_LEN   5
	"z" length modifier
#define	LCASE   0x20
	Use lower-case for hexadecimal digits.
#define	ALT_FORM   0x02
	Use "alternate form".
Functions
	FILE_LICENCE (GPL2_OR_LATER)
static char *	format_hex (char *end, unsigned long long num, int width, int flags)
	Format a hexadecimal number.
static char *	format_decimal (char *end, signed long num, int width)
	Format a decimal number.
static void	cputchar (struct printf_context *ctx, unsigned int c)
	Print character via a printf context.
size_t	vcprintf (struct printf_context *ctx, const char *fmt, va_list args)
	Write a formatted string to a printf context.
static void	printf_sputc (struct printf_context *ctx, unsigned int c)
	Write character to buffer.
int	vsnprintf (char *buf, size_t size, const char *fmt, va_list args)
	Write a formatted string to a buffer.
int	snprintf (char *buf, size_t size, const char *fmt,...)
	Write a formatted string to a buffer.
int	vssnprintf (char *buf, ssize_t ssize, const char *fmt, va_list args)
	Version of vsnprintf() that accepts a signed buffer size.
int	ssnprintf (char *buf, ssize_t ssize, const char *fmt,...)
	Version of vsnprintf() that accepts a signed buffer size.
static void	printf_putchar (struct printf_context *ctx __unused, unsigned int c)
	Write character to console.
int	vprintf (const char *fmt, va_list args)
	Write a formatted string to the console.
int	printf (const char *fmt,...)
	Write a formatted string to the console.
Variables
static uint8_t	type_sizes []

---

Detailed Description

Definition in file vsprintf.c.

---

Define Documentation

#define CHAR_LEN   0

"hh" length modifier

Definition at line 30 of file vsprintf.c.

#define SHORT_LEN   1

"h" length modifier

Definition at line 31 of file vsprintf.c.

#define INT_LEN   2

no length modifier

Definition at line 32 of file vsprintf.c.

Referenced by vcprintf().

#define LONG_LEN   3

"l" length modifier

Definition at line 33 of file vsprintf.c.

#define LONGLONG_LEN   4

"ll" length modifier

Definition at line 34 of file vsprintf.c.

#define SIZE_T_LEN   5

"z" length modifier

Definition at line 35 of file vsprintf.c.

Referenced by vcprintf().

#define LCASE   0x20

Use lower-case for hexadecimal digits.

Note that this value is set to 0x20 since that makes for very efficient calculations. (Bitwise-ORing with LCASE converts to a lower-case character, for example.)

Definition at line 53 of file vsprintf.c.

Referenced by format_hex(), and vcprintf().

#define ALT_FORM   0x02

Use "alternate form".

For hexadecimal numbers, this means to add a "0x" or "0X" prefix to the number.

Definition at line 61 of file vsprintf.c.

Referenced by format_hex(), and vcprintf().

---

Function Documentation

FILE_LICENCE

(

GPL2_OR_LATER

)

static char* format_hex	(	char *	end,
		unsigned long long	num,
		int	width,
		int	flags
	)			[static]

Format a hexadecimal number.

Parameters:

	end	End of buffer to contain number
	num	Number to format
	width	Minimum field width

Return values:

ptr

End of buffer

Fills a buffer in reverse order with a formatted hexadecimal number. The number will be zero-padded to the specified width. Lower-case and "alternate form" (i.e. "0x" prefix) flags may be set.

There must be enough space in the buffer to contain the largest number that this function can format.

Definition at line 79 of file vsprintf.c.

References ALT_FORM, and LCASE.

Referenced by vcprintf().

                                       {
        char *ptr = end;
        int case_mod;

        /* Generate the number */
        case_mod = flags & LCASE;
        do {
                *(--ptr) = "0123456789ABCDEF"[ num & 0xf ] | case_mod;
                num >>= 4;
        } while ( num );

        /* Zero-pad to width */
        while ( ( end - ptr ) < width )
                *(--ptr) = '0';

        /* Add "0x" or "0X" if alternate form specified */
        if ( flags & ALT_FORM ) {
                *(--ptr) = 'X' | case_mod;
                *(--ptr) = '0';
        }

        return ptr;
}

static char* format_decimal	(	char *	end,
		signed long	num,
		int	width
	)			[static]

Format a decimal number.

Parameters:

	end	End of buffer to contain number
	num	Number to format
	width	Minimum field width

Return values:

ptr

End of buffer

Fills a buffer in reverse order with a formatted decimal number. The number will be space-padded to the specified width.

There must be enough space in the buffer to contain the largest number that this function can format.

Definition at line 118 of file vsprintf.c.

Referenced by vcprintf().

                                                                       {
        char *ptr = end;
        int negative = 0;

        /* Generate the number */
        if ( num < 0 ) {
                negative = 1;
                num = -num;
        }
        do {
                *(--ptr) = '0' + ( num % 10 );
                num /= 10;
        } while ( num );

        /* Add "-" if necessary */
        if ( negative )
                *(--ptr) = '-';

        /* Space-pad to width */
        while ( ( end - ptr ) < width )
                *(--ptr) = ' ';

        return ptr;
}

static void cputchar	(	struct printf_context *	ctx,
		unsigned int	c
	)			[inline, static]

Print character via a printf context.

Parameters:

	ctx	Context
	c	Character

Call's the printf_context::handler() method and increments printf_context::len.

Definition at line 152 of file vsprintf.c.

References printf_context::handler, and printf_context::len.

Referenced by vcprintf().

                                                                           {
        ctx->handler ( ctx, c );
        ++ctx->len;
}

size_t vcprintf	(	struct printf_context *	ctx,
		const char *	fmt,
		va_list	args
	)

Write a formatted string to a printf context.

Parameters:

	ctx	Context
	fmt	Format string
	args	Arguments corresponding to the format string

Return values:

len

Length of formatted string

Definition at line 165 of file vsprintf.c.

References ALT_FORM, cputchar(), format_decimal(), format_hex(), INT_LEN, LCASE, printf_context::len, SIZE_T_LEN, type_sizes, and va_arg.

Referenced by vprintf(), vsnprintf(), and vw_printw().

                                                                              {
        int flags;
        int width;
        uint8_t *length;
        char *ptr;
        char tmp_buf[32]; /* 32 is enough for all numerical formats.
                           * Insane width fields could overflow this buffer. */

        /* Initialise context */
        ctx->len = 0;

        for ( ; *fmt ; fmt++ ) {
                /* Pass through ordinary characters */
                if ( *fmt != '%' ) {
                        cputchar ( ctx, *fmt );
                        continue;
                }
                fmt++;
                /* Process flag characters */
                flags = 0;
                for ( ; ; fmt++ ) {
                        if ( *fmt == '#' ) {
                                flags |= ALT_FORM;
                        } else if ( *fmt == '0' ) {
                                /* We always 0-pad hex and space-pad decimal */
                        } else {
                                /* End of flag characters */
                                break;
                        }
                }
                /* Process field width */
                width = 0;
                for ( ; ; fmt++ ) {
                        if ( ( ( unsigned ) ( *fmt - '0' ) ) < 10 ) {
                                width = ( width * 10 ) + ( *fmt - '0' );
                        } else {
                                break;
                        }
                }
                /* We don't do floating point */
                /* Process length modifier */
                length = &type_sizes[INT_LEN];
                for ( ; ; fmt++ ) {
                        if ( *fmt == 'h' ) {
                                length--;
                        } else if ( *fmt == 'l' ) {
                                length++;
                        } else if ( *fmt == 'z' ) {
                                length = &type_sizes[SIZE_T_LEN];
                        } else {
                                break;
                        }
                }
                /* Process conversion specifier */
                ptr = tmp_buf + sizeof ( tmp_buf ) - 1;
                *ptr = '\0';
                if ( *fmt == 'c' ) {
                        cputchar ( ctx, va_arg ( args, unsigned int ) );
                } else if ( *fmt == 's' ) {
                        ptr = va_arg ( args, char * );
                        if ( ! ptr )
                                ptr = "<NULL>";
                } else if ( *fmt == 'p' ) {
                        intptr_t ptrval;

                        ptrval = ( intptr_t ) va_arg ( args, void * );
                        ptr = format_hex ( ptr, ptrval, width, 
                                           ( ALT_FORM | LCASE ) );
                } else if ( ( *fmt & ~0x20 ) == 'X' ) {
                        unsigned long long hex;

                        flags |= ( *fmt & 0x20 ); /* LCASE */
                        if ( *length >= sizeof ( unsigned long long ) ) {
                                hex = va_arg ( args, unsigned long long );
                        } else if ( *length >= sizeof ( unsigned long ) ) {
                                hex = va_arg ( args, unsigned long );
                        } else {
                                hex = va_arg ( args, unsigned int );
                        }
                        ptr = format_hex ( ptr, hex, width, flags );
                } else if ( ( *fmt == 'd' ) || ( *fmt == 'i' ) ){
                        signed long decimal;

                        if ( *length >= sizeof ( signed long ) ) {
                                decimal = va_arg ( args, signed long );
                        } else {
                                decimal = va_arg ( args, signed int );
                        }
                        ptr = format_decimal ( ptr, decimal, width );
                } else {
                        *(--ptr) = *fmt;
                }
                /* Write out conversion result */
                for ( ; *ptr ; ptr++ ) {
                        cputchar ( ctx, *ptr );
                }
        }

        return ctx->len;
}

static void printf_sputc	(	struct printf_context *	ctx,
		unsigned int	c
	)			[static]

Write character to buffer.

Parameters:

	ctx	Context
	c	Character

Definition at line 281 of file vsprintf.c.

References sputc_context::buf, container_of, printf_context::len, and sputc_context::max_len.

Referenced by vsnprintf().

                                                                        {
        struct sputc_context * sctx =
                container_of ( ctx, struct sputc_context, ctx );

        if ( ctx->len < sctx->max_len )
                sctx->buf[ctx->len] = c;
}

int vsnprintf	(	char *	buf,
		size_t	size,
		const char *	fmt,
		va_list	args
	)

Write a formatted string to a buffer.

Parameters:

	buf	Buffer into which to write the string
	size	Size of buffer
	fmt	Format string
	args	Arguments corresponding to the format string

Return values:

len

Length of formatted string

If the buffer is too small to contain the string, the returned length is the length that would have been written had enough space been available.

Definition at line 302 of file vsprintf.c.

References sputc_context::buf, sputc_context::ctx, printf_context::handler, sputc_context::max_len, printf_sputc(), and vcprintf().

Referenced by snprintf(), vasprintf(), vmsg(), vsprintf(), vssnprintf(), and xfer_vprintf().

                                                                        {
        struct sputc_context sctx;
        size_t len;
        size_t end;

        /* Hand off to vcprintf */
        sctx.ctx.handler = printf_sputc;
        sctx.buf = buf;
        sctx.max_len = size;
        len = vcprintf ( &sctx.ctx, fmt, args );

        /* Add trailing NUL */
        if ( size ) {
                end = size - 1;
                if ( len < end )
                        end = len;
                buf[end] = '\0';
        }

        return len;
}

int snprintf	(	char *	buf,
		size_t	size,
		const char *	fmt,
			...
	)

Write a formatted string to a buffer.

Parameters:

	buf	Buffer into which to write the string
	size	Size of buffer
	fmt	Format string
	...	Arguments corresponding to the format string

Return values:

len

Length of formatted string

Definition at line 333 of file vsprintf.c.

References va_end, va_start, and vsnprintf().

Referenced by __vxge_hw_vpath_fw_ver_get(), boot_next_server_and_filename(), cpio_set_field(), dhcp_tag_name(), efi_strerror(), eisabus_probe(), fetchf_int(), fetchf_ipv4(), fetchf_uint(), fetchf_uuid(), http_step(), ib_sma_node_desc(), ipoib_ntoa(), isabus_probe(), isapnpbus_probe(), iwlist(), mcabus_probe(), multiboot_add_cmdline(), pcibus_probe(), pxe_menu_draw_item(), pxe_tftp_open(), pxenv_undi_get_iface_info(), register_image(), register_netdev(), settings_name(), skge_board_name(), strerror(), t509bus_probe(), tftp_apply_settings(), tftp_send_rrq(), undipci_probe(), and uri_decode().

                                                              {
        va_list args;
        int i;

        va_start ( args, fmt );
        i = vsnprintf ( buf, size, fmt, args );
        va_end ( args );
        return i;
}

int vssnprintf	(	char *	buf,
		ssize_t	ssize,
		const char *	fmt,
		va_list	args
	)

Version of vsnprintf() that accepts a signed buffer size.

Parameters:

	buf	Buffer into which to write the string
	size	Size of buffer
	fmt	Format string
	args	Arguments corresponding to the format string

Return values:

len

Length of formatted string

Definition at line 352 of file vsprintf.c.

References vsnprintf().

Referenced by ssnprintf().

                                                                           {

        /* Treat negative buffer size as zero buffer size */
        if ( ssize < 0 )
                ssize = 0;

        /* Hand off to vsnprintf */
        return vsnprintf ( buf, ssize, fmt, args );
}

int ssnprintf	(	char *	buf,
		ssize_t	ssize,
		const char *	fmt,
			...
	)

Version of vsnprintf() that accepts a signed buffer size.

Parameters:

	buf	Buffer into which to write the string
	size	Size of buffer
	fmt	Format string
	...	Arguments corresponding to the format string

Return values:

len

Length of formatted string

Definition at line 371 of file vsprintf.c.

References va_end, va_start, and vssnprintf().

Referenced by fetchf_hex(), iscsi_build_login_request_strings(), unparse_uri(), and uri_encode().

                                                                 {
        va_list args;
        int len;

        /* Hand off to vssnprintf */
        va_start ( args, fmt );
        len = vssnprintf ( buf, ssize, fmt, args );
        va_end ( args );
        return len;
}

static void printf_putchar	(	struct printf_context *ctx	__unused,
		unsigned int	c
	)			[static]

Write character to console.

Parameters:

	ctx	Context
	c	Character

Definition at line 388 of file vsprintf.c.

References putchar().

Referenced by vprintf().

                                              {
        putchar ( c );
}

int vprintf	(	const char *	fmt,
		va_list	args
	)

Write a formatted string to the console.

Parameters:

	fmt	Format string
	args	Arguments corresponding to the format string

Return values:

len

Length of formatted string

Definition at line 400 of file vsprintf.c.

References printf_context::handler, printf_putchar(), and vcprintf().

Referenced by printf().

                                              {
        struct printf_context ctx;

        /* Hand off to vcprintf */
        ctx.handler = printf_putchar;   
        return vcprintf ( &ctx, fmt, args );    
}

int printf	(	const char *	fmt,
			...
	)

Write a formatted string to the console.

Parameters:

	fmt	Format string
	...	Arguments corresponding to the format string

Return values:

len

Length of formatted string

Definition at line 415 of file vsprintf.c.

References va_end, va_start, and vprintf().

Referenced by __attribute__(), _dump_regs(), alloc(), amd79c901_read_mode(), amd8111e_poll_link(), amd8111e_probe_ext_phy(), amd8111e_restart(), amd8111e_transmit(), amd8111e_wait_tx_ring(), ansiscr_movetoyx(), ansiscr_putc(), ansiscr_reset(), aoeboot(), aout_download(), aout_probe(), autoboot(), autoboot_exec(), beep(), bi_depermanent(), bi_free(), bi_permanent(), bi_terminate(), bnx2_fw_sync(), bnx2_init_board(), bnx2_init_nvram(), bnx2_probe(), bnx2_report_link(), bnx2_reset_chip(), bnx2_transmit(), ce_loader(), check_duplex(), check_region(), clear_exec(), clrline(), config_exec(), corkscrew_probe1(), cs89x0_probe(), cs89x0_transmit(), davicom_reset(), davicom_transmit(), dbg_autocolourise(), dbg_decolourise(), dbg_hex_dump_da_row(), detect_aui(), detect_bnc(), detect_tp(), dhcp(), dhcp_exec(), dhcp_syntax(), digest_exec(), digest_syntax(), dm9132_id_table(), dmfe_poll(), dmfe_probe(), echo_exec(), eepro_poll(), eepro_probe(), eepro_transmit(), eeprom_rdy(), enable_multicast(), epic100_open(), epic100_poll(), epic100_probe(), epic100_transmit(), eth_pio_write(), eth_probe(), execv(), exit_exec(), fnrec_dump(), forcedeth_probe(), forcedeth_reset(), gateA20_set(), gdbstub_exec(), gdbstub_syntax(), gdbudp_init(), get_eeprom_data(), get_x_header(), getopt_long(), help_exec(), hfa384x_copy_from_bap(), hfa384x_copy_to_bap(), hfa384x_docmd_wait(), hfa384x_drvr_getconfig(), hfa384x_drvr_setconfig(), hfa384x_wait_for_event(), ib_srpboot(), ics1893_read_mode(), ifcommon_do_list(), ifcommon_syntax(), iflinkwait(), ifopen(), ifstat(), ifstat_errors(), imgargs_exec(), imgargs_syntax(), imgexec_exec(), imgexec_syntax(), imgfetch_core_exec(), imgfetch_core_syntax(), imgfree_exec(), imgfree_syntax(), imgload_exec(), imgload_syntax(), imgstat(), imgstat_syntax(), init_media(), iscsiboot(), iwlist(), iwstat(), keep_san(), legacy_probe(), linebuf_test(), login_exec(), main(), match_long_option(), match_short_option(), monojob_wait(), more(), mtd_poll(), mtd_probe(), mtd_transmit(), netboot(), ns83820_probe(), ns83820_run_bist(), ns8390_poll(), nway_start(), parse_eeprom(), pause(), pci_resource_flags(), pcnet32_probe(), pcnet32_transmit(), phy_init(), phy_intr(), pnic_api_check(), pnic_command(), pnic_command_quiet(), pnic_do_nway(), pnic_probe(), prism2_find_plx(), prism2_pci_probe(), prism2_probe(), prism2_transmit(), pxe_menu_prompt_and_select(), pxe_menu_select(), pxebs(), pxebs_exec(), pxebs_syntax(), readline(), reg_delay(), rhine_disable(), rhine_poll(), rhine_probe1(), route(), route_syntax(), rtl8201_read_mode(), sanboot_exec(), sanboot_syntax(), select_media(), send_test_pkt(), set_exec(), set_rx_mode(), shell_banner(), show_exec(), sis900_get_mac_addr(), sis900_init_rxd(), sis900_init_rxfilter(), sis900_init_txd(), sis900_poll(), sis900_probe(), sis900_read_mode(), sis900_transmit(), sis96x_get_mac_addr(), sleep_exec(), smc9000_poll(), smc9000_probe(), smc9000_transmit(), smc_detect_phy(), smc_read_phy_register(), smc_write_phy_register(), start_link(), sundance_poll(), sundance_probe(), sundance_transmit(), t509_poll(), t509_transmit(), t515_poll(), t515_reset(), t529_probe(), t595_poll(), t595_transmit(), t5x9_probe(), test_parse_unparse(), test_resolve(), tg3_abort_hw(), tg3_get_invariants(), tg3_link_report(), tg3_probe(), tg3_restart_fw(), tg3_setup_hw(), tg3_stop_block(), tg3_transmit(), time_exec(), TLan_PhyDetect(), TLan_PhyFinishAutoNeg(), tlan_probe(), tlan_transmit(), tulip_check_duplex(), tulip_probe(), tulip_reset(), tulip_transmit(), umalloc_test(), update_linkspeed(), uri_test(), velocity_get_pci_info(), velocity_init_info(), velocity_init_registers(), velocity_open(), velocity_print_link_status(), velocity_probe(), velocity_set_bool_opt(), velocity_set_int_opt(), velocity_set_media_mode(), velocity_transmit(), virtnet_probe(), vp_find_vq(), vt6103_read_mode(), vxge_probe(), vxgetlink(), vxsetlink(), w89c840_poll(), w89c840_probe(), w89c840_reset(), w89c840_transmit(), whereami(), and wince_probe().

                                    {
        va_list args;
        int i;

        va_start ( args, fmt );
        i = vprintf ( fmt, args );
        va_end ( args );
        return i;
}

---

Variable Documentation

uint8_t type_sizes[] [static]

Initial value:

 {
        [CHAR_LEN]      = sizeof ( char ),
        [SHORT_LEN]     = sizeof ( short ),
        [INT_LEN]       = sizeof ( int ),
        [LONG_LEN]      = sizeof ( long ),
        [LONGLONG_LEN]  = sizeof ( long long ),
        [SIZE_T_LEN]    = sizeof ( size_t ),
}

Definition at line 37 of file vsprintf.c.

Referenced by vcprintf().