sbuff.c File Reference

A generic string buffer structure for string printing and parsing. More...

#include <freeradius-devel/util/misc.h>
#include <freeradius-devel/util/syserror.h>
#include <freeradius-devel/util/atexit.h>

Include dependency graph for sbuff.c:

Go to the source code of this file.

Macros
#define	CHECK_SBUFF_INIT(_sbuff)   do { if (!(_sbuff)->extend && (unlikely(!(_sbuff)->buff) || unlikely(!(_sbuff)->start) || unlikely(!(_sbuff)->end) || unlikely(!(_sbuff)->p))) return 0; } while (0)
#define	CONSTRAINED_END(_sbuff, _max, _used)    (((_max) - (_used)) > fr_sbuff_remaining(_sbuff) ? (_sbuff)->end : (_sbuff)->p + ((_max) - (_used)))
	Constrain end pointer to prevent advancing more than the amount the caller specified.
#define	FILL_OR_GOTO_DONE(_out, _in, _len)   if (fr_sbuff_move(_out, _in, _len) < (size_t)(_len)) goto done
	Fill as much of the output buffer we can and break on partial copy.
#define	SBUFF_PARSE_FLOAT_DEF(_name, _type, _func, _max_char)
	Used to define a number parsing functions for floats.
#define	SBUFF_PARSE_INT_DEF(_name, _type, _min, _max, _max_char, _base)
	Used to define a number parsing functions for signed integers.
#define	SBUFF_PARSE_UINT_DEF(_name, _type, _max, _max_char, _base)
	Used to define a number parsing functions for signed integers.

Functions
size_t	_fr_sbuff_move_marker_to_marker (fr_sbuff_marker_t *out, fr_sbuff_marker_t *in, size_t len)
	Move data from one marker to another.
size_t	_fr_sbuff_move_marker_to_sbuff (fr_sbuff_t *out, fr_sbuff_marker_t *in, size_t len)
	Move data from a marker to an sbuff.
size_t	_fr_sbuff_move_sbuff_to_marker (fr_sbuff_marker_t *out, fr_sbuff_t *in, size_t len)
	Move data from an sbuff to a marker.
size_t	_fr_sbuff_move_sbuff_to_sbuff (fr_sbuff_t *out, fr_sbuff_t *in, size_t len)
	Move data from one sbuff to another.
static int	_sbuff_scratch_free (void *arg)
	Free the scratch buffer used for printf.
size_t	fr_sbuff_adv_past_allowed (fr_sbuff_t *sbuff, size_t len, bool const allowed[static UINT8_MAX+1], fr_sbuff_term_t const *tt)
	Wind position past characters in the allowed set.
size_t	fr_sbuff_adv_past_str (fr_sbuff_t *sbuff, char const *needle, size_t needle_len)
	Return true and advance past the end of the needle if needle occurs next in the sbuff.
size_t	fr_sbuff_adv_past_strcase (fr_sbuff_t *sbuff, char const *needle, size_t needle_len)
	Return true and advance past the end of the needle if needle occurs next in the sbuff.
char *	fr_sbuff_adv_to_chr (fr_sbuff_t *sbuff, size_t len, char c)
	Wind position to first instance of specified char.
char *	fr_sbuff_adv_to_chr_utf8 (fr_sbuff_t *sbuff, size_t len, char const *chr)
	Wind position to first instance of specified multibyte utf8 char.
char *	fr_sbuff_adv_to_str (fr_sbuff_t *sbuff, size_t len, char const *needle, size_t needle_len)
	Wind position to the first instance of the specified needle.
char *	fr_sbuff_adv_to_strcase (fr_sbuff_t *sbuff, size_t len, char const *needle, size_t needle_len)
	Wind position to the first instance of the specified needle.
size_t	fr_sbuff_adv_until (fr_sbuff_t *sbuff, size_t len, fr_sbuff_term_t const *tt, char escape_chr)
	Wind position until we hit a character in the terminal set.
bool	fr_sbuff_eof_file (fr_sbuff_t *sbuff)
	Accessor function for the EOF state of the file extendor.
size_t	fr_sbuff_extend_file (fr_sbuff_extend_status_t *status, fr_sbuff_t *sbuff, size_t extension)
	Refresh the buffer with more data from the file.
size_t	fr_sbuff_extend_talloc (fr_sbuff_extend_status_t *status, fr_sbuff_t *sbuff, size_t extension)
	Reallocate the current buffer.
ssize_t	fr_sbuff_in_bstrcpy_buffer (fr_sbuff_t *sbuff, char const *str)
	Copy bytes into the sbuff up to the first \0.
ssize_t	fr_sbuff_in_bstrncpy (fr_sbuff_t *sbuff, char const *str, size_t len)
	Copy bytes into the sbuff up to the first \0.
ssize_t	fr_sbuff_in_escape (fr_sbuff_t *sbuff, char const *in, size_t inlen, fr_sbuff_escape_rules_t const *e_rules)
	Print an escaped string to an sbuff.
ssize_t	fr_sbuff_in_escape_buffer (fr_sbuff_t *sbuff, char const *in, fr_sbuff_escape_rules_t const *e_rules)
	Print an escaped string to an sbuff taking a talloced buffer as input.
ssize_t	fr_sbuff_in_sprintf (fr_sbuff_t *sbuff, char const *fmt,...)
	Print using a fmt string to an sbuff.
ssize_t	fr_sbuff_in_strcpy (fr_sbuff_t *sbuff, char const *str)
	Copy bytes into the sbuff up to the first \0.
ssize_t	fr_sbuff_in_vsprintf (fr_sbuff_t *sbuff, char const *fmt, va_list ap)
	Print using a fmt string to an sbuff.
bool	fr_sbuff_is_terminal (fr_sbuff_t *in, fr_sbuff_term_t const *tt)
	Efficient terminal string search.
bool	fr_sbuff_next_if_char (fr_sbuff_t *sbuff, char c)
	Return true if the current char matches, and if it does, advance.
bool	fr_sbuff_next_unless_char (fr_sbuff_t *sbuff, char c)
	Return true and advance if the next char does not match.
fr_slen_t	fr_sbuff_out_bool (bool *out, fr_sbuff_t *in)
	See if the string contains a truth value.
size_t	fr_sbuff_out_bstrncpy (fr_sbuff_t *out, fr_sbuff_t *in, size_t len)
	Copy as many bytes as possible from a sbuff to a sbuff.
size_t	fr_sbuff_out_bstrncpy_allowed (fr_sbuff_t *out, fr_sbuff_t *in, size_t len, bool const allowed[static UINT8_MAX+1])
	Copy as many allowed characters as possible from a sbuff to a sbuff.
ssize_t	fr_sbuff_out_bstrncpy_exact (fr_sbuff_t *out, fr_sbuff_t *in, size_t len)
	Copy exactly len bytes from a sbuff to a sbuff or fail.
size_t	fr_sbuff_out_bstrncpy_until (fr_sbuff_t *out, fr_sbuff_t *in, size_t len, fr_sbuff_term_t const *tt, fr_sbuff_unescape_rules_t const *u_rules)
	Copy as many allowed characters as possible from a sbuff to a sbuff.
size_t	fr_sbuff_out_unescape_until (fr_sbuff_t *out, fr_sbuff_t *in, size_t len, fr_sbuff_term_t const *tt, fr_sbuff_unescape_rules_t const *u_rules)
	Copy as many allowed characters as possible from a sbuff to a sbuff.
void	fr_sbuff_parse_rules_debug (fr_sbuff_parse_rules_t const *p_rules)
int	fr_sbuff_reset_talloc (fr_sbuff_t *sbuff)
	Reset a talloced buffer to its initial length, clearing any data stored.
size_t	fr_sbuff_shift (fr_sbuff_t *sbuff, size_t shift, bool move_end)
	Shift the contents of the sbuff, returning the number of bytes we managed to shift.
void	fr_sbuff_terminal_debug (fr_sbuff_term_t const *tt)
static void	fr_sbuff_terminal_idx_init (size_t *needle_len, uint8_t idx[static UINT8_MAX+1], fr_sbuff_term_t const *term)
	Populate a terminal index.
static bool	fr_sbuff_terminal_search (fr_sbuff_t *in, char const *p, uint8_t idx[static UINT8_MAX+1], fr_sbuff_term_t const *term, size_t needle_len)
	Efficient terminal string search.
fr_sbuff_term_t *	fr_sbuff_terminals_amerge (TALLOC_CTX *ctx, fr_sbuff_term_t const *a, fr_sbuff_term_t const *b)
	Merge two sets of terminal strings.
size_t	fr_sbuff_trim (fr_sbuff_t *sbuff, bool const to_trim[static UINT8_MAX+1])
	Trim trailing characters from a string we're composing.
int	fr_sbuff_trim_talloc (fr_sbuff_t *sbuff, size_t len)
	Trim a talloced sbuff to the minimum length required to represent the contained string.
void	fr_sbuff_unescape_debug (fr_sbuff_unescape_rules_t const *escapes)
void	fr_sbuff_update (fr_sbuff_t *sbuff, char *new_buff, size_t new_len)
	Update all markers and pointers in the set of sbuffs to point to new_buff.
static size_t	min (size_t x, size_t y)
static ssize_t	safecpy (char *o_start, char *o_end, char const *i_start, char const *i_end)
	Copy function that allows overlapping memory ranges to be copied.
static char const *	sbuff_print_char (char c)
	Print a char in a friendly format.
static int	sbuff_scratch_init (TALLOC_CTX **out)
static int8_t	terminal_cmp (fr_sbuff_term_elem_t const *a, fr_sbuff_term_elem_t const *b)
	Compare two terminal elements for ordering purposes.

Variables
bool const	sbuff_char_alpha_num [UINT8_MAX+1] = { SBUFF_CHAR_CLASS_ALPHA_NUM }
bool const	sbuff_char_blank [UINT8_MAX+1]
bool const	sbuff_char_class_float [UINT8_MAX+1]
bool const	sbuff_char_class_hex [UINT8_MAX+1] = { SBUFF_CHAR_CLASS_HEX }
bool const	sbuff_char_class_hostname [UINT8_MAX+1]
bool const	sbuff_char_class_int [UINT8_MAX+1]
bool const	sbuff_char_class_uint [UINT8_MAX+1]
bool const	sbuff_char_class_zero [UINT8_MAX+1]
bool const	sbuff_char_line_endings [UINT8_MAX+1]
bool const	sbuff_char_whitespace [UINT8_MAX+1]
bool const	sbuff_char_word [UINT8_MAX+1]
fr_table_num_ordered_t const	sbuff_parse_error_table []
size_t	sbuff_parse_error_table_len = NUM_ELEMENTS(sbuff_parse_error_table)
static _Thread_local char *	sbuff_scratch
static _Thread_local bool	sbuff_scratch_freed
	When true, prevent use of the scratch space.

Detailed Description

A generic string buffer structure for string printing and parsing.

Copyright

2020 Arran Cudbard-Bell a.cud.nosp@m.bard.nosp@m.b@fre.nosp@m.erad.nosp@m.ius.o.nosp@m.rg

Definition in file sbuff.c.

Macro Definition Documentation

CHECK_SBUFF_INIT

#define CHECK_SBUFF_INIT

(

_sbuff

)

do { if (!(_sbuff)->extend && (unlikely(!(_sbuff)->buff) || unlikely(!(_sbuff)->start) || unlikely(!(_sbuff)->end) || unlikely(!(_sbuff)->p))) return 0; } while (0)

Definition at line 55 of file sbuff.c.

CONSTRAINED_END

#define CONSTRAINED_END	(		_sbuff,
			_max,
			_used
	)		(((_max) - (_used)) > fr_sbuff_remaining(_sbuff) ? (_sbuff)->end : (_sbuff)->p + ((_max) - (_used)))

Constrain end pointer to prevent advancing more than the amount the caller specified.

Parameters

[in]	_sbuff	to constrain.
[in]	_max	maximum amount to advance.
[in]	_used	how much we've advanced so far.

Returns

a temporary end pointer.

Definition at line 496 of file sbuff.c.

FILL_OR_GOTO_DONE

#define FILL_OR_GOTO_DONE	(		_out,
			_in,
			_len
	)		if (fr_sbuff_move(_out, _in, _len) < (size_t)(_len)) goto done

Fill as much of the output buffer we can and break on partial copy.

Parameters

[in]	_out	sbuff to write to.
[in]	_in	sbuff to copy from.
[in]	_len	maximum amount to copy.

Definition at line 487 of file sbuff.c.

SBUFF_PARSE_FLOAT_DEF

#define SBUFF_PARSE_FLOAT_DEF	(		_name,
			_type,
			_func,
			_max_char
	)

Used to define a number parsing functions for floats.

Parameters

[in]	_name	Function suffix.
[in]	_type	Output type.
[in]	_func	Parsing function to use.
[in]	_max_char	Maximum digits that can be used to represent an integer. Can't use stringify because of width modifiers like 'u' used in <stdint.h>.

Definition at line 1326 of file sbuff.c.

SBUFF_PARSE_INT_DEF

#define SBUFF_PARSE_INT_DEF	(		_name,
			_type,
			_min,
			_max,
			_max_char,
			_base
	)

Used to define a number parsing functions for signed integers.

Parameters

[in]	_name	Function suffix.
[in]	_type	Output type.
[in]	_min	value.
[in]	_max	value.
[in]	_max_char	Maximum digits that can be used to represent an integer. Can't use stringify because of width modifiers like 'u' used in <stdint.h>.
[in]	_base	to use.

Definition at line 1175 of file sbuff.c.

SBUFF_PARSE_UINT_DEF

#define SBUFF_PARSE_UINT_DEF	(		_name,
			_type,
			_max,
			_max_char,
			_base
	)

Used to define a number parsing functions for signed integers.

Parameters

[in]	_name	Function suffix.
[in]	_type	Output type.
[in]	_max	value.
[in]	_max_char	Maximum digits that can be used to represent an integer. Can't use stringify because of width modifiers like 'u' used in <stdint.h>.
[in]	_base	of the number being parsed, 8, 10, 16 etc...

Definition at line 1242 of file sbuff.c.

Function Documentation

_fr_sbuff_move_marker_to_marker()

size_t _fr_sbuff_move_marker_to_marker	(	fr_sbuff_marker_t *	out,
		fr_sbuff_marker_t *	in,
		size_t	len
	)

Move data from one marker to another.

Note

Do not call this function directly use fr_sbuff_move

Parameters

[in]	out	marker to copy data to.
[in]	in	marker to copy data from.
[in]	len	Maximum length of string to copy.

Returns

The amount of data copied.

Definition at line 1417 of file sbuff.c.

Here is the call graph for this function:

_fr_sbuff_move_marker_to_sbuff()

size_t _fr_sbuff_move_marker_to_sbuff	(	fr_sbuff_t *	out,
		fr_sbuff_marker_t *	in,
		size_t	len
	)

Move data from a marker to an sbuff.

Note

Do not call this function directly use fr_sbuff_move

Parameters

[in]	out	sbuff to copy data to.
[in]	in	marker to copy data from.
[in]	len	Maximum length of string to copy.

Returns

The amount of data copied.

Definition at line 1397 of file sbuff.c.

Here is the call graph for this function:

_fr_sbuff_move_sbuff_to_marker()

size_t _fr_sbuff_move_sbuff_to_marker	(	fr_sbuff_marker_t *	out,
		fr_sbuff_t *	in,
		size_t	len
	)

Move data from an sbuff to a marker.

Note

Do not call this function directly use fr_sbuff_move

Parameters

[in]	out	marker to copy data to.
[in]	in	sbuff to copy data from.
[in]	len	Maximum length of string to copy.

Returns

The amount of data copied.

Definition at line 1437 of file sbuff.c.

Here is the call graph for this function:

_fr_sbuff_move_sbuff_to_sbuff()

size_t _fr_sbuff_move_sbuff_to_sbuff	(	fr_sbuff_t *	out,
		fr_sbuff_t *	in,
		size_t	len
	)

Move data from one sbuff to another.

Note

Do not call this function directly use fr_sbuff_move

Both in and out will be advanced by len, with len set to the shortest value between the user specified value, the number of bytes remaining in the input buffer (after extension), and the number of bytes remaining in the output buffer (after extension).

Parameters

[in]	out	sbuff to copy data to.
[in]	in	sbuff to copy data from.
[in]	len	Maximum length of string to copy.

Returns

The amount of data copied.

Definition at line 1377 of file sbuff.c.

Here is the call graph for this function:

_sbuff_scratch_free()

static int _sbuff_scratch_free ( void *  arg )

static

Free the scratch buffer used for printf.

Definition at line 1525 of file sbuff.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_sbuff_adv_past_allowed()

size_t fr_sbuff_adv_past_allowed	(	fr_sbuff_t *	sbuff,
		size_t	len,
		bool const	allowed[static UINT8_MAX+1],
		fr_sbuff_term_t const *	tt
	)

Wind position past characters in the allowed set.

Parameters

[in]	sbuff	sbuff to search in.
[in]	len	Maximum amount to advance by. Unconstrained if SIZE_MAX.
[in]	allowed	character set.
[in]	tt	If not NULL, stop if we find a terminal sequence.

Returns

how many bytes we advanced.

Definition at line 1779 of file sbuff.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_sbuff_adv_past_str()

size_t fr_sbuff_adv_past_str	(	fr_sbuff_t *	sbuff,
		char const *	needle,
		size_t	needle_len
	)

Return true and advance past the end of the needle if needle occurs next in the sbuff.

Parameters

[in]	sbuff	to search in.
[in]	needle	to search for.
[in]	needle_len	of needle. If SIZE_MAX strlen is used to determine length of the needle.

Returns

how many bytes we advanced

Definition at line 1714 of file sbuff.c.

Here is the caller graph for this function:

fr_sbuff_adv_past_strcase()

size_t fr_sbuff_adv_past_strcase	(	fr_sbuff_t *	sbuff,
		char const *	needle,
		size_t	needle_len
	)

Return true and advance past the end of the needle if needle occurs next in the sbuff.

This function is similar to fr_sbuff_adv_past_str but is case insensitive.

Parameters

[in]	sbuff	to search in.
[in]	needle	to search for.
[in]	needle_len	of needle. If SIZE_MAX strlen is used to determine length of the needle.

Returns

how many bytes we advanced

Definition at line 1745 of file sbuff.c.

Here is the caller graph for this function:

fr_sbuff_adv_to_chr()

char * fr_sbuff_adv_to_chr	(	fr_sbuff_t *	sbuff,
		size_t	len,
		char	c
	)

Wind position to first instance of specified char.

Parameters

[in,out]	sbuff	to search in.
[in]	len	Maximum amount to advance by. Unconstrained if SIZE_MAX.
[in]	c	to search for.

Returns

• NULL, no instances found.
• The position of the first character.

Definition at line 1958 of file sbuff.c.

Here is the caller graph for this function:

fr_sbuff_adv_to_chr_utf8()

char * fr_sbuff_adv_to_chr_utf8	(	fr_sbuff_t *	sbuff,
		size_t	len,
		char const *	chr
	)

Wind position to first instance of specified multibyte utf8 char.

Only use this function if the search char could be multibyte, as there's a large performance penalty.

Parameters

[in,out]	sbuff	to search in.
[in]	len	the maximum number of characters to search in sbuff.
[in]	chr	to search for.

Returns

• NULL, no instances found.
• The position of the first character.

Definition at line 1913 of file sbuff.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_sbuff_adv_to_str()

char * fr_sbuff_adv_to_str	(	fr_sbuff_t *	sbuff,
		size_t	len,
		char const *	needle,
		size_t	needle_len
	)

Wind position to the first instance of the specified needle.

Parameters

[in,out]	sbuff	sbuff to search in.
[in]	len	Maximum amount to advance by. Unconstrained if SIZE_MAX.
[in]	needle	to search for.
[in]	needle_len	Length of the needle. SIZE_MAX to used strlen.

Returns

• NULL, no instances found.
• The position of the first character.

Definition at line 1994 of file sbuff.c.

Here is the caller graph for this function:

fr_sbuff_adv_to_strcase()

char * fr_sbuff_adv_to_strcase	(	fr_sbuff_t *	sbuff,
		size_t	len,
		char const *	needle,
		size_t	needle_len
	)

Wind position to the first instance of the specified needle.

Parameters

[in,out]	sbuff	sbuff to search in.
[in]	len	Maximum amount to advance by. Unconstrained if SIZE_MAX.
[in]	needle	to search for.
[in]	needle_len	Length of the needle. SIZE_MAX to used strlen.

Returns

• NULL, no instances found.
• The position of the first character.

Definition at line 2047 of file sbuff.c.

Here is the caller graph for this function:

fr_sbuff_adv_until()

size_t fr_sbuff_adv_until	(	fr_sbuff_t *	sbuff,
		size_t	len,
		fr_sbuff_term_t const *	tt,
		char	escape_chr
	)

Wind position until we hit a character in the terminal set.

Parameters

[in]	sbuff	sbuff to search in.
[in]	len	Maximum amount to advance by. Unconstrained if SIZE_MAX.
[in]	tt	Token terminals in the encompassing grammar.
[in]	escape_chr	If not '\0', ignore characters in the tt set when prefixed with this escape character.

Returns

how many bytes we advanced.

Definition at line 1854 of file sbuff.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_sbuff_eof_file()

bool fr_sbuff_eof_file

(

fr_sbuff_t *

sbuff

)

Accessor function for the EOF state of the file extendor.

Definition at line 341 of file sbuff.c.

fr_sbuff_extend_file()

size_t fr_sbuff_extend_file	(	fr_sbuff_extend_status_t *	status,
		fr_sbuff_t *	sbuff,
		size_t	extension
	)

Refresh the buffer with more data from the file.

Check for errors

Definition at line 267 of file sbuff.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_sbuff_extend_talloc()

size_t fr_sbuff_extend_talloc	(	fr_sbuff_extend_status_t *	status,
		fr_sbuff_t *	sbuff,
		size_t	extension
	)

Reallocate the current buffer.

Parameters

[in]	status	Extend status.
[in]	sbuff	to be extended.
[in]	extension	How many additional bytes should be allocated in the buffer.

Returns

• 0 the extension operation failed.
• >0 the number of bytes the buffer was extended by.

Definition at line 357 of file sbuff.c.

Here is the call graph for this function:

fr_sbuff_in_bstrcpy_buffer()

ssize_t fr_sbuff_in_bstrcpy_buffer	(	fr_sbuff_t *	sbuff,
		char const *	str
	)

Copy bytes into the sbuff up to the first \0.

Parameters

[in]	sbuff	to copy into.
[in]	str	talloced buffer to copy into sbuff.

Returns

• >= 0 the number of bytes copied into the sbuff.
• <0 the number of bytes required to complete the copy operation.

Definition at line 1504 of file sbuff.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_sbuff_in_bstrncpy()

ssize_t fr_sbuff_in_bstrncpy	(	fr_sbuff_t *	sbuff,
		char const *	str,
		size_t	len
	)

Copy bytes into the sbuff up to the first \0.

Parameters

[in]	sbuff	to copy into.
[in]	str	to copy into buffer.
[in]	len	number of bytes to copy.

Returns

• >= 0 the number of bytes copied into the sbuff.
• <0 the number of bytes required to complete the copy operation.

Definition at line 1482 of file sbuff.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_sbuff_in_escape()

ssize_t fr_sbuff_in_escape	(	fr_sbuff_t *	sbuff,
		char const *	in,
		size_t	inlen,
		fr_sbuff_escape_rules_t const *	e_rules
	)

Print an escaped string to an sbuff.

Parameters

[in]	sbuff	to print into.
[in]	in	to escape.
[in]	inlen	of string to escape.
[in]	e_rules	Escaping rules. Used to escape special characters as data is written to the sbuff. May be NULL.

Returns

• >= 0 the number of bytes printed into the sbuff.
• <0 the number of bytes required to complete the print operation.

Definition at line 1622 of file sbuff.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_sbuff_in_escape_buffer()

ssize_t fr_sbuff_in_escape_buffer	(	fr_sbuff_t *	sbuff,
		char const *	in,
		fr_sbuff_escape_rules_t const *	e_rules
	)

Print an escaped string to an sbuff taking a talloced buffer as input.

Parameters

[in]	sbuff	to print into.
[in]	in	to escape.
[in]	e_rules	Escaping rules. Used to escape special characters as data is written to the sbuff. May be NULL.

Returns

• >= 0 the number of bytes printed into the sbuff.
• <0 the number of bytes required to complete the print operation.

Definition at line 1697 of file sbuff.c.

Here is the call graph for this function:

fr_sbuff_in_sprintf()

ssize_t fr_sbuff_in_sprintf	(	fr_sbuff_t *	sbuff,
		char const *	fmt,
			...
	)

Print using a fmt string to an sbuff.

Parameters

[in]	sbuff	to print into.
[in]	fmt	string.
[in]	...	arguments for format string.

Returns

• >= 0 the number of bytes printed into the sbuff.
• <0 the number of bytes required to complete the print operation.

Definition at line 1597 of file sbuff.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_sbuff_in_strcpy()

ssize_t fr_sbuff_in_strcpy	(	fr_sbuff_t *	sbuff,
		char const *	str
	)

Copy bytes into the sbuff up to the first \0.

Parameters

[in]	sbuff	to copy into.
[in]	str	to copy into buffer.

Returns

• >= 0 the number of bytes copied into the sbuff.
• <0 the number of bytes required to complete the copy operation.

Definition at line 1456 of file sbuff.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_sbuff_in_vsprintf()

ssize_t fr_sbuff_in_vsprintf	(	fr_sbuff_t *	sbuff,
		char const *	fmt,
		va_list	ap
	)

Print using a fmt string to an sbuff.

Parameters

[in]	sbuff	to print into.
[in]	fmt	string.
[in]	ap	arguments for format string.

Returns

• >= 0 the number of bytes printed into the sbuff.
• <0 the number of bytes required to complete the print operation.

Definition at line 1564 of file sbuff.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_sbuff_is_terminal()

bool fr_sbuff_is_terminal	(	fr_sbuff_t *	in,
		fr_sbuff_term_t const *	tt
	)

Efficient terminal string search.

Caller should ensure that a buffer extension of needle_len bytes has been requested before calling this function.

Parameters

[in]	in	Sbuff to search in.
[in]	tt	Token terminals in the encompassing grammar.

Returns

• true if found.
• false if not.

Definition at line 2154 of file sbuff.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_sbuff_next_if_char()

bool fr_sbuff_next_if_char	(	fr_sbuff_t *	sbuff,
		char	c
	)

Return true if the current char matches, and if it does, advance.

Parameters

[in]	sbuff	to search for char in.
[in]	c	char to search for.

Returns

• true and advance if the next character matches.
• false and don't advance if the next character doesn't match.

Definition at line 2090 of file sbuff.c.

Here is the caller graph for this function:

fr_sbuff_next_unless_char()

bool fr_sbuff_next_unless_char	(	fr_sbuff_t *	sbuff,
		char	c
	)

Return true and advance if the next char does not match.

Parameters

[in]	sbuff	to search for char in.
[in]	c	char to search for.

Returns

• true and advance unless the character matches.
• false and don't advance if the next character matches.

Definition at line 2111 of file sbuff.c.

Here is the caller graph for this function:

fr_sbuff_out_bool()

fr_slen_t fr_sbuff_out_bool	(	bool *	out,
		fr_sbuff_t *	in
	)

See if the string contains a truth value.

Parameters

[out]	out	Where to write boolean value.
[in]	in	Where to search for a truth value.

Returns

• >0 the number of bytes consumed.
• -1 no bytes copied, was not a truth value.

Definition at line 1111 of file sbuff.c.

Here is the caller graph for this function:

fr_sbuff_out_bstrncpy()

size_t fr_sbuff_out_bstrncpy	(	fr_sbuff_t *	out,
		fr_sbuff_t *	in,
		size_t	len
	)

Copy as many bytes as possible from a sbuff to a sbuff.

Copy size is limited by available data in sbuff and space in output sbuff.

Parameters

[out]	out	Where to copy to.
[in]	in	Where to copy from. Will copy len bytes from current position in buffer.
[in]	len	How many bytes to copy. If SIZE_MAX the entire buffer will be copied.

Returns

• 0 no bytes copied.
• >0 the number of bytes copied.

Definition at line 725 of file sbuff.c.

Here is the caller graph for this function:

fr_sbuff_out_bstrncpy_allowed()

size_t fr_sbuff_out_bstrncpy_allowed	(	fr_sbuff_t *	out,
		fr_sbuff_t *	in,
		size_t	len,
		bool const	allowed[static UINT8_MAX+1]
	)

Copy as many allowed characters as possible from a sbuff to a sbuff.

Copy size is limited by available data in sbuff and output buffer length.

As soon as a disallowed character is found the copy is stopped. The input sbuff will be left pointing at the first disallowed character.

Parameters

[out]	out	Where to copy to.
[in]	in	Where to copy from. Will copy len bytes from current position in buffer.
[in]	len	How many bytes to copy. If SIZE_MAX the entire buffer will be copied.
[in]	allowed	Characters to include the copy.

Returns

• 0 no bytes copied.
• >0 the number of bytes copied.

Definition at line 818 of file sbuff.c.

fr_sbuff_out_bstrncpy_exact()

ssize_t fr_sbuff_out_bstrncpy_exact	(	fr_sbuff_t *	out,
		fr_sbuff_t *	in,
		size_t	len
	)

Copy exactly len bytes from a sbuff to a sbuff or fail.

Copy size is limited by available data in sbuff, space in output sbuff, and length.

Parameters

[out]	out	Where to copy to.
[in]	in	Where to copy from. Will copy len bytes from current position in buffer.
[in]	len	How many bytes to copy. If SIZE_MAX the entire buffer will be copied.

Returns

• 0 no bytes copied, no token found of sufficient length in input buffer.
• >0 the number of bytes copied.
• <0 the number of additional output bytes we would have needed to complete the copy.

Definition at line 763 of file sbuff.c.

Here is the call graph for this function:

fr_sbuff_out_bstrncpy_until()

size_t fr_sbuff_out_bstrncpy_until	(	fr_sbuff_t *	out,
		fr_sbuff_t *	in,
		size_t	len,
		fr_sbuff_term_t const *	tt,
		fr_sbuff_unescape_rules_t const *	u_rules
	)

Copy as many allowed characters as possible from a sbuff to a sbuff.

Copy size is limited by available data in sbuff and output buffer length.

As soon as a disallowed character is found the copy is stopped. The input sbuff will be left pointing at the first disallowed character.

Parameters

[out]	out	Where to copy to.
[in]	in	Where to copy from. Will copy len bytes from current position in buffer.
[in]	len	How many bytes to copy. If SIZE_MAX the entire buffer will be copied.
[in]	tt	Token terminals in the encompassing grammar.
[in]	u_rules	If not NULL, ignore characters in the until set when prefixed with u_rules->chr. FIXME - Should actually evaluate u_rules fully.

Returns

• 0 no bytes copied.
• >0 the number of bytes copied.

Definition at line 864 of file sbuff.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_sbuff_out_unescape_until()

size_t fr_sbuff_out_unescape_until	(	fr_sbuff_t *	out,
		fr_sbuff_t *	in,
		size_t	len,
		fr_sbuff_term_t const *	tt,
		fr_sbuff_unescape_rules_t const *	u_rules
	)

Copy as many allowed characters as possible from a sbuff to a sbuff.

Copy size is limited by available data in sbuff and output buffer length.

As soon as a disallowed character is found the copy is stopped. The input sbuff will be left pointing at the first disallowed character.

This de-escapes characters as they're copied out of the sbuff.

Parameters

[out]	out	Where to copy to.
[in]	in	Where to copy from. Will copy len bytes from current position in buffer.
[in]	len	How many bytes to copy. If SIZE_MAX the entire buffer will be copied.
[in]	tt	Token terminal strings in the encompassing grammar.
[in]	u_rules	for processing unescape sequences.

Returns

• 0 no bytes copied.
• >0 the number of bytes written to out.

Definition at line 937 of file sbuff.c.

Here is the call graph for this function:

fr_sbuff_parse_rules_debug()

void fr_sbuff_parse_rules_debug

(

fr_sbuff_parse_rules_t const *

p_rules

)

Definition at line 2263 of file sbuff.c.

Here is the call graph for this function:

fr_sbuff_reset_talloc()

int fr_sbuff_reset_talloc

(

fr_sbuff_t *

sbuff

)

Reset a talloced buffer to its initial length, clearing any data stored.

Parameters

[in]

sbuff

to reset.

Returns

• 0 on success.
• -1 on failure - markers present pointing past the end of string data.

Definition at line 456 of file sbuff.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_sbuff_shift()

size_t fr_sbuff_shift	(	fr_sbuff_t *	sbuff,
		size_t	shift,
		bool	move_end
	)

Shift the contents of the sbuff, returning the number of bytes we managed to shift.

Parameters

[in]	sbuff	to shift.
[in]	shift	the contents of the buffer this many bytes towards the start of the buffer.
[in]	move_end	If the buffer is used for reading, then this should be true so we cannot read passed the end of valid data.

Returns

• 0 the shift failed due to constraining pointers.
• >0 the number of bytes we managed to shift pointers in the sbuff. memmove should be used to move the existing contents of the buffer, and fill the free space at the end of the buffer with additional data.

Definition at line 197 of file sbuff.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_sbuff_terminal_debug()

void fr_sbuff_terminal_debug

(

fr_sbuff_term_t const *

tt

)

Definition at line 2254 of file sbuff.c.

Here is the caller graph for this function:

fr_sbuff_terminal_idx_init()

static void fr_sbuff_terminal_idx_init ( size_t *  needle_len, uint8_t  idx[static UINT8_MAX+1], fr_sbuff_term_t const *  term  )

inlinestatic

Populate a terminal index.

Parameters

[out]	needle_len	the longest needle. Will not be set if the terminal array is empty.
[out]	idx	to populate.
[in]	term	Terminals to populate the index with.

Definition at line 507 of file sbuff.c.

Here is the caller graph for this function:

fr_sbuff_terminal_search()

static bool fr_sbuff_terminal_search ( fr_sbuff_t *  in, char const *  p, uint8_t  idx[static UINT8_MAX+1], fr_sbuff_term_t const *  term, size_t  needle_len  )

inlinestatic

Efficient terminal string search.

Caller should ensure that a buffer extension of needle_len bytes has been requested before calling this function.

Parameters

[in]	in	Sbuff to search in.
[in]	p	Current position (may be ahead of in->p).
[in]	idx	Fastpath index, populated by fr_sbuff_terminal_idx_init.
[in]	term	terminals to search in.
[in]	needle_len	Length of the longest needle.

Returns

• true if found.
• false if not.

Definition at line 542 of file sbuff.c.

Here is the caller graph for this function:

fr_sbuff_terminals_amerge()

fr_sbuff_term_t * fr_sbuff_terminals_amerge	(	TALLOC_CTX *	ctx,
		fr_sbuff_term_t const *	a,
		fr_sbuff_term_t const *	b
	)

Merge two sets of terminal strings.

Parameters

[in]	ctx	to allocate the new terminal array in.
[in]	a	first set of terminals to merge.
[in]	b	second set of terminals to merge.

Returns

A new set of de-duplicated and sorted terminals.

Definition at line 647 of file sbuff.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_sbuff_trim()

size_t fr_sbuff_trim	(	fr_sbuff_t *	sbuff,
		bool const	to_trim[static UINT8_MAX+1]
	)

Trim trailing characters from a string we're composing.

Parameters

[in]	sbuff	to trim trailing characters from.
[in]	to_trim	Charset to trim.

Returns

how many chars we removed.

Definition at line 2130 of file sbuff.c.

Here is the caller graph for this function:

fr_sbuff_trim_talloc()

int fr_sbuff_trim_talloc	(	fr_sbuff_t *	sbuff,
		size_t	len
	)

Trim a talloced sbuff to the minimum length required to represent the contained string.

Parameters

[in]	sbuff	to trim.
[in]	len	Length to trim to. Passing SIZE_MAX will result in the buffer being trimmed to the length of the content.

Returns

• 0 on success.
• -1 on failure - markers present pointing past the end of string data.

Definition at line 421 of file sbuff.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_sbuff_unescape_debug()

void fr_sbuff_unescape_debug

(

fr_sbuff_unescape_rules_t const *

escapes

)

Definition at line 2233 of file sbuff.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_sbuff_update()

void fr_sbuff_update	(	fr_sbuff_t *	sbuff,
		char *	new_buff,
		size_t	new_len
	)

Update all markers and pointers in the set of sbuffs to point to new_buff.

This function should be used if the underlying buffer is realloced.

Parameters

[in]	sbuff	to update.
[in]	new_buff	to assign to to sbuff.
[in]	new_len	Length of the new buffer.

Definition at line 156 of file sbuff.c.

Here is the call graph for this function:

Here is the caller graph for this function:

min()

static size_t min ( size_t  x, size_t  y  )

inlinestatic

Definition at line 143 of file sbuff.c.

Here is the caller graph for this function:

safecpy()

static ssize_t safecpy ( char *  o_start, char *  o_end, char const *  i_start, char const *  i_end  )

inlinestatic

Copy function that allows overlapping memory ranges to be copied.

Parameters

[out]	o_start	start of output buffer.
[in]	o_end	end of the output buffer.
[in]	i_start	start of the input buffer.
[in]	i_end	end of data to copy.

Returns

• >0 the number of bytes copied.
• 0 invalid args.
• <0 the number of bytes we'd need to complete the copy.

Definition at line 123 of file sbuff.c.

Here is the caller graph for this function:

sbuff_print_char()

static char const * sbuff_print_char ( char  c )

static

Print a char in a friendly format.

Definition at line 2187 of file sbuff.c.

Here is the call graph for this function:

Here is the caller graph for this function:

sbuff_scratch_init()

static int sbuff_scratch_init ( TALLOC_CTX **  out )

inlinestatic

Definition at line 1531 of file sbuff.c.

Here is the call graph for this function:

Here is the caller graph for this function:

terminal_cmp()

static int8_t terminal_cmp ( fr_sbuff_term_elem_t const *  a, fr_sbuff_term_elem_t const *  b  )

inlinestatic

Compare two terminal elements for ordering purposes.

Parameters

[in]	a	first terminal to compare.
[in]	b	second terminal to compare.

Returns

CMP(a,b)

Definition at line 623 of file sbuff.c.

Here is the caller graph for this function:

Variable Documentation

sbuff_char_alpha_num

bool const sbuff_char_alpha_num[UINT8_MAX+1] = { SBUFF_CHAR_CLASS_ALPHA_NUM }

Definition at line 95 of file sbuff.c.

sbuff_char_blank

bool const sbuff_char_blank[UINT8_MAX+1]

Initial value:

= {
        ['\t'] = true, [' '] = true,
}

Definition at line 108 of file sbuff.c.

sbuff_char_class_float

bool const sbuff_char_class_float[UINT8_MAX+1]

Initial value:

= {
        SBUFF_CHAR_CLASS_NUM,
        ['-'] = true, ['+'] = true, ['e'] = true, ['E'] = true, ['.'] = true,
}

Definition at line 70 of file sbuff.c.

sbuff_char_class_hex

bool const sbuff_char_class_hex[UINT8_MAX+1] = { SBUFF_CHAR_CLASS_HEX }

Definition at line 94 of file sbuff.c.

sbuff_char_class_hostname

bool const sbuff_char_class_hostname[UINT8_MAX+1]

Initial value:

= {
        SBUFF_CHAR_CLASS_ALPHA_NUM,
        ['.'] = true,           
        [':'] = true,           
        ['-'] = true,           
        ['/'] = true,           
        ['['] = true,           
        [']'] = true,           
        ['_'] = true,           
        ['*'] = true,           
}

Definition at line 82 of file sbuff.c.

sbuff_char_class_int

bool const sbuff_char_class_int[UINT8_MAX+1]

Initial value:

= {
        SBUFF_CHAR_CLASS_NUM,
        ['+'] = true, ['-'] = true
}

Definition at line 65 of file sbuff.c.

sbuff_char_class_uint

bool const sbuff_char_class_uint[UINT8_MAX+1]

Initial value:

= {
        SBUFF_CHAR_CLASS_NUM,
        ['+'] = true
}

Definition at line 60 of file sbuff.c.

sbuff_char_class_zero

bool const sbuff_char_class_zero[UINT8_MAX+1]

Initial value:

= {
        ['0'] = true
}

Definition at line 75 of file sbuff.c.

sbuff_char_line_endings

bool const sbuff_char_line_endings[UINT8_MAX+1]

Initial value:

= {
        ['\n'] = true, ['\r'] = true
}

Definition at line 104 of file sbuff.c.

sbuff_char_whitespace

bool const sbuff_char_whitespace[UINT8_MAX+1]

Initial value:

= {
        ['\t'] = true, ['\n'] = true, ['\r'] = true, ['\f'] = true, ['\v'] = true, [' '] = true,
}

Definition at line 100 of file sbuff.c.

sbuff_char_word

bool const sbuff_char_word[UINT8_MAX+1]

Initial value:

= {
        SBUFF_CHAR_CLASS_ALPHA_NUM,
        ['-'] = true, ['_'] = true,
}

Definition at line 96 of file sbuff.c.

sbuff_parse_error_table

fr_table_num_ordered_t const sbuff_parse_error_table[]

Initial value:

= {
        { L("ok"),                      FR_SBUFF_PARSE_OK                               },
        { L("token not found"),         FR_SBUFF_PARSE_ERROR_NOT_FOUND                  },
        { L("trailing data"),           FR_SBUFF_PARSE_ERROR_TRAILING                   },
        { L("token format invalid"),    FR_SBUFF_PARSE_ERROR_FORMAT                     },
        { L("out of space"),            FR_SBUFF_PARSE_ERROR_OUT_OF_SPACE               },
        { L("integer overflow"),        FR_SBUFF_PARSE_ERROR_NUM_OVERFLOW               },
        { L("integer underflow"),       FR_SBUFF_PARSE_ERROR_NUM_UNDERFLOW              }
}

Definition at line 43 of file sbuff.c.

sbuff_parse_error_table_len

size_t sbuff_parse_error_table_len = NUM_ELEMENTS(sbuff_parse_error_table)

Definition at line 52 of file sbuff.c.

sbuff_scratch

_Thread_local char* sbuff_scratch

static

Definition at line 30 of file sbuff.c.

sbuff_scratch_freed

_Thread_local bool sbuff_scratch_freed

static

When true, prevent use of the scratch space.

This prevents us from initialising a pool after the thread local destructors have run.

The destructors may be called manually before thread exit, and we don't want to re-initialise the pool

Definition at line 38 of file sbuff.c.