efi_strings.h File Reference

EFI strings. More...

#include <stddef.h>
#include <stdint.h>
#include <stdarg.h>

Go to the source code of this file.

Macros
#define	efi_sprintf(buf, fmt, ...)   efi_snprintf ( (buf), ~( ( size_t ) 0 ), (fmt), ## __VA_ARGS__ )
	Write a formatted string to a buffer. More...

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
int	efi_vsnprintf (wchar_t *wbuf, size_t wsize, const char *fmt, va_list args)
	Write a formatted string to a wide-character buffer. More...
int	efi_snprintf (wchar_t *wbuf, size_t wsize, const char *fmt,...)
	Write a formatted string to a buffer. More...
int	efi_vssnprintf (wchar_t *wbuf, ssize_t swsize, const char *fmt, va_list args)
	Version of efi_vsnprintf() that accepts a signed buffer size. More...
int	efi_ssnprintf (wchar_t *wbuf, ssize_t swsize, const char *fmt,...)
	Version of efi_vsnprintf() that accepts a signed buffer size. More...
int	efi_vasprintf (wchar_t **strp, const char *fmt, va_list args)
	Write a formatted string to newly allocated memory. More...
int	efi_asprintf (wchar_t **strp, const char *fmt,...)
	Write a formatted string to newly allocated memory. More...
static int	efi_vsprintf (wchar_t *buf, const char *fmt, va_list args)
	Write a formatted string to a wide-character buffer. More...

Detailed Description

EFI strings.

Definition in file efi_strings.h.

Macro Definition Documentation

efi_sprintf

#define efi_sprintf	(		buf,
			fmt,
			...
	)		efi_snprintf ( (buf), ~( ( size_t ) 0 ), (fmt), ## __VA_ARGS__ )

Write a formatted string to a buffer.

Parameters

wbuf	Buffer into which to write the string
fmt	Format string
...	Arguments corresponding to the format string

Return values

wlen	Length of formatted string (in wide characters)

Definition at line 45 of file efi_strings.h.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

efi_vsnprintf()

int efi_vsnprintf	(	wchar_t *	wbuf,
		size_t	wsize,
		const char *	fmt,
		va_list	args
	)

Write a formatted string to a wide-character buffer.

Parameters

wbuf	Buffer into which to write the string
wsize	Size of buffer (in wide characters)
fmt	Format string
args	Arguments corresponding to the format string

Return values

wlen	Length of formatted string (in wide characters)

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 74 of file efi_strings.c.

                                   {
        struct efi_sputc_context sctx;
        size_t wlen;
        size_t wend;

        /* Hand off to vcprintf */
        sctx.ctx.handler = efi_printf_sputc;
        sctx.buf = wbuf;
        sctx.max_wlen = wsize;
        wlen = vcprintf ( &sctx.ctx, fmt, args );

        /* Add trailing NUL */
        if ( wsize ) {
                wend = wsize - 1;
                if ( wlen < wend )
                        wend = wlen;
                wbuf[wend] = '\0';
        }

        return wlen;
}

References efi_sputc_context::buf, efi_sputc_context::ctx, efi_printf_sputc(), fmt, printf_context::handler, efi_sputc_context::max_wlen, and vcprintf().

Referenced by efi_ifr_string(), efi_snprintf(), efi_vasprintf(), efi_vsprintf(), and efi_vssnprintf().

efi_snprintf()

int efi_snprintf	(	wchar_t *	wbuf,
		size_t	wsize,
		const char *	fmt,
			...
	)

Write a formatted string to a buffer.

Parameters

wbuf	Buffer into which to write the string
wsize	Size of buffer (in wide characters)
fmt	Format string
...	Arguments corresponding to the format string

Return values

wlen	Length of formatted string (in wide characters)

Definition at line 106 of file efi_strings.c.

                                                                       {
        va_list args;
        int i;

        va_start ( args, fmt );
        i = efi_vsnprintf ( wbuf, wsize, fmt, args );
        va_end ( args );
        return i;
}

References efi_vsnprintf(), fmt, va_end, and va_start.

Referenced by efi_block_filename(), efi_file_varlen(), efi_image_path(), efi_local_open_resolved(), efi_snp_hii_append(), efi_snp_probe(), and efivars_fetch().

efi_vssnprintf()

int efi_vssnprintf	(	wchar_t *	wbuf,
		ssize_t	swsize,
		const char *	fmt,
		va_list	args
	)

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

Parameters

wbuf	Buffer into which to write the string
swsize	Size of buffer (in wide characters)
fmt	Format string
args	Arguments corresponding to the format string

Return values

wlen	Length of formatted string (in wide characters)

Definition at line 125 of file efi_strings.c.

                                    {

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

        /* Hand off to vsnprintf */
        return efi_vsnprintf ( wbuf, swsize, fmt, args );
}

References efi_vsnprintf(), and fmt.

Referenced by efi_ssnprintf().

efi_ssnprintf()

int efi_ssnprintf	(	wchar_t *	wbuf,
		ssize_t	swsize,
		const char *	fmt,
			...
	)

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

Parameters

wbuf	Buffer into which to write the string
swsize	Size of buffer (in wide characters)
fmt	Format string
...	Arguments corresponding to the format string

Return values

wlen	Length of formatted string (in wide characters)

Definition at line 145 of file efi_strings.c.

                                                                          {
        va_list args;
        int len;

        /* Hand off to vssnprintf */
        va_start ( args, fmt );
        len = efi_vssnprintf ( wbuf, swsize, fmt, args );
        va_end ( args );
        return len;
}

References efi_vssnprintf(), fmt, len, va_end, and va_start.

efi_vasprintf()

int efi_vasprintf	(	wchar_t **	wstrp,
		const char *	fmt,
		va_list	args
	)

Write a formatted string to newly allocated memory.

Parameters

wstrp	Pointer to hold allocated string
fmt	Format string
args	Arguments corresponding to the format string

Return values

len	Length of formatted string (in wide characters)

Definition at line 164 of file efi_strings.c.

                                                                     {
        size_t len;
        va_list args_tmp;

        /* Calculate length needed for string */
        va_copy ( args_tmp, args );
        len = ( efi_vsnprintf ( NULL, 0, fmt, args_tmp ) + 1 );
        va_end ( args_tmp );

        /* Allocate and fill string */
        *wstrp = malloc ( len * sizeof ( **wstrp ) );
        if ( ! *wstrp )
                return -ENOMEM;
        return efi_vsnprintf ( *wstrp, len, fmt, args );
}

References efi_vsnprintf(), ENOMEM, fmt, len, malloc(), NULL, va_copy, and va_end.

Referenced by efi_asprintf().

efi_asprintf()

int efi_asprintf	(	wchar_t **	wstrp,
		const char *	fmt,
			...
	)

Write a formatted string to newly allocated memory.

Parameters

wstrp	Pointer to hold allocated string
fmt	Format string
...	Arguments corresponding to the format string

Return values

len	Length of formatted string (in wide characters)

Definition at line 188 of file efi_strings.c.

                                                           {
        va_list args;
        int len;

        va_start ( args, fmt );
        len = efi_vasprintf ( wstrp, fmt, args );
        va_end ( args );
        return len;
}

References efi_vasprintf(), fmt, len, va_end, and va_start.

Referenced by efi_image_cmdline(), and efi_shim_cmdline().

efi_vsprintf()

static int efi_vsprintf ( wchar_t *  buf, const char *  fmt, va_list  args  )

inlinestatic

Write a formatted string to a wide-character buffer.

Parameters

wbuf	Buffer into which to write the string
fmt	Format string
args	Arguments corresponding to the format string

Return values

wlen	Length of formatted string (in wide characters)

Definition at line 33 of file efi_strings.h.

                                                                               {
        return efi_vsnprintf ( buf, ~( ( size_t ) 0 ), fmt, args );
}

References efi_vsnprintf(), and fmt.