The FreeRADIUS server $Id: 15bac2a4c627c01d1aa2047687b3418955ac7f00 $
Loading...
Searching...
No Matches
sbuff.h
Go to the documentation of this file.
1#pragma once
2/*
3 * This program is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation; either version 2 of the License, or
6 * (at your option) any later version.
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License
14 * along with this program; if not, write to the Free Software
15 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
16 */
17
18/** A generic buffer structure for string printing and parsing strings
19 *
20 * Because doing manual length checks is error prone and a waste of everyones time.
21 *
22 * @file src/lib/util/sbuff.h
23 *
24 * @copyright 2020 Arran Cudbard-Bell <a.cudbardb@freeradius.org>
25 */
26RCSIDH(sbuff_h, "$Id: c776b5f5b8045b6f5235e61185ef0eeca1732a0f $")
27
28# ifdef __cplusplus
29extern "C" {
30# endif
31
32#include <ctype.h>
33#include <errno.h>
34#include <limits.h>
35#include <stdio.h>
36#include <sys/types.h>
37
38/** Represents number of bytes parsed or location of parse error
39 *
40 * Number of bytes parsed will be >= 0.
41 *
42 * If a parse error occurs the value will be the negative offset
43 * of the error -1. i.e. offset 0 will be -1.
44 *
45 * This is to disambiguate between 0 bytes parsed and error at
46 * offset 0.
47 */
48typedef ssize_t fr_slen_t;
49typedef struct fr_sbuff_s fr_sbuff_t;
50typedef struct fr_sbuff_ptr_s fr_sbuff_marker_t;
51
52#include <freeradius-devel/util/atexit.h>
53#include <freeradius-devel/util/strerror.h>
54#include <freeradius-devel/util/table.h>
55#include <freeradius-devel/util/talloc.h>
56
57/** Whether the buffer is currently extendable and whether it was extended
58 *
59 */
60DIAG_OFF(attributes)
61DIAG_OFF(cast-align)
62typedef enum CC_HINT(flag_enum) {
63 FR_SBUFF_FLAG_EXTENDED = 0x01, //!< The last call to extend function actually extended the buffer.
64 FR_SBUFF_FLAG_EXTEND_ERROR = 0x02 //!< The last call to an extend function resulted in an error.
65 ///< Error should be provided using fr_strerror_const/fr_strerror_printf
66 ///< by the extension function.
67} fr_sbuff_extend_status_t;
68DIAG_OFF(attributes)
69
70/** Extension callback
71 *
72 * Retrieves additional data from a source and adds it to a buffer.
73 */
74typedef size_t(*fr_sbuff_extend_t)(fr_sbuff_extend_status_t *status, fr_sbuff_t *sbuff, size_t req_extension);
75
76/** For a given extension function, returns whether it is at EOF
77 *
78 */
79typedef bool(*fr_sbuff_eof_t)(fr_sbuff_t *sbuff);
80
81
82struct fr_sbuff_ptr_s {
83 union {
84 char const *p_i; //!< Immutable position pointer.
85 char *p; //!< Mutable position pointer.
86 };
87 fr_sbuff_marker_t *next; //!< Next m in the list.
88 fr_sbuff_t *parent; //!< Owner of the marker
89};
90
91struct fr_sbuff_s {
92 union {
93 char const *buff_i; //!< Immutable buffer pointer.
94 char *buff; //!< Mutable buffer pointer.
95 };
96
97 union {
98 char const *start_i; //!< Immutable start pointer.
99 char *start; //!< Mutable start pointer.
100 };
101
102 union {
103 char const *end_i; //!< Immutable end pointer.
104 char *end; //!< Mutable end pointer.
105 };
106
107 union {
108 char const *p_i; //!< Immutable position pointer.
109 char *p; //!< Mutable position pointer.
110 };
111
112 char const *err; //!< Where the last error occurred.
113
114 unsigned int is_const:1; //!< Can't be modified.
115 unsigned int adv_parent:1; //!< If true, advance the parent.
116 size_t shifted; //!< How many bytes this sbuff has been
117 ///< shifted since its creation.
118
119 fr_sbuff_extend_t extend; //!< Function to re-populate or extend
120 ///< the buffer.
121
122 fr_sbuff_eof_t eof; //!< Function to determine if the buffer is at EOF.
123
124 void *uctx; //!< Extend uctx data.
125
126 fr_sbuff_t *parent; //!< sbuff this sbuff was copied from.
127
128 fr_sbuff_marker_t *m; //!< Pointers to update if the underlying
129 ///< buffer changes.
130};
131
132/** Talloc sbuff extension structure
133 *
134 * Holds the data necessary for creating dynamically
135 * extensible buffers.
136 */
137typedef struct {
138 TALLOC_CTX *ctx; //!< Context to alloc new buffers in.
139 size_t init; //!< How much to allocate initially.
140 size_t max; //!< Maximum size of the buffer.
141} fr_sbuff_uctx_talloc_t;
142
143/** File sbuff extension structure
144 *
145 * Holds the data necessary for creating dynamically
146 * extensible file buffers.
147 */
148typedef struct {
149 FILE *file; //!< FILE * we're reading from.
150 char *buff_end; //!< The true end of the buffer.
151 size_t max; //!< Maximum number of bytes to read.
152 size_t shifted; //!< How much we've read from this file.
153 bool eof; //!< are we at EOF?
154} fr_sbuff_uctx_file_t;
155
156/** Terminal element with pre-calculated lengths
157 *
158 */
159typedef struct {
160 char const *str; //!< Terminal string
161 size_t len; //!< Length of string
162} fr_sbuff_term_elem_t;
163
164/** Set of terminal elements
165 *
166 * The elements MUST be listed in sorted order. If the inputs are
167 * not sorted, then all kinds of things will break.
168 */
169typedef struct {
170 size_t len; //!< Length of the list.
171 fr_sbuff_term_elem_t *elem; //!< A sorted list of terminal strings.
172} fr_sbuff_term_t;
173
174/** Initialise a terminal structure with a single string
175 *
176 * @param[in] _str terminal string.
177 */
178#define FR_SBUFF_TERM(_str) \
179(fr_sbuff_term_t){ \
180 .len = 1, \
181 .elem = (fr_sbuff_term_elem_t[]){ L(_str) }, \
182}
183
184/** Initialise a terminal structure with a list of sorted strings
185 *
186 * Strings must be lexicographically sorted.
187 *
188 * @param[in] ... Lexicographically sorted list of terminal strings.
189 */
190#define FR_SBUFF_TERMS(...) \
191(fr_sbuff_term_t){ \
192 .len = (sizeof((fr_sbuff_term_elem_t[]){ __VA_ARGS__ }) / sizeof(fr_sbuff_term_elem_t)), \
193 .elem = (fr_sbuff_term_elem_t[]){ __VA_ARGS__ }, \
194}
195
196/*
197 * We can't put this into a typdef:
198 *
199 * typedef bool sbuff_char_class_t[static UINT8_MAX + 1];
200 *
201 * So we use a macro instead.
202 */
203#define SBUFF_CHAR_CLASS UINT8_MAX + 1
204
205/** Set of parsing rules for *unescape_until functions
206 *
207 */
208typedef struct {
209 char const *name; //!< Name for rule set to aid we debugging.
210
211 char chr; //!< Character at the start of an escape sequence.
212 char subs[SBUFF_CHAR_CLASS]; //!< Special characters and their substitutions.
213 ///< Indexed by the printable representation i.e.
214 ///< 'n' for \n.
215 bool skip[SBUFF_CHAR_CLASS]; //!< Characters that are escaped, but left in the
216 ///< output along with the escape character.
217 ///< This is useful where we need to interpret escape
218 ///< sequences for parsing, but where the string will
219 ///< be passed off to a 3rd party library which will
220 ///< need to interpret the same sequences.
221
222 bool do_hex; //!< Process hex sequences i.e. @verbatim\x<hex><hex>.@endverbatim
223 bool do_oct; //!< Process oct sequences i.e. @verbatim<oct><oct><oct>.@endverbatim
224} fr_sbuff_unescape_rules_t;
225
226/** Set of parsing rules for *unescape_until functions
227 *
228 */
229typedef struct {
230 char const *name; //!< Name for rule set to aid we debugging.
231
232 char chr; //!< Character at the start of an escape sequence.
233
234 char subs[SBUFF_CHAR_CLASS]; //!< Special characters and their substitutions.
235 ///< Indexed by the binary representation i.e.
236 ///< 0x0a for \n.
237 bool esc[SBUFF_CHAR_CLASS]; //!< Characters that should be translated to hex or
238 ///< octal escape sequences.
239 bool do_utf8; //!< If true Don't apply escaping rules to valid UTF-8 sequences.
240
241 bool do_hex; //!< Represent escaped chars as hex sequences i.e.
242 ///< @verbatim\x<hex><hex>@endverbatim
243 bool do_oct; //!< Represent escapes chars as octal sequences i.e.
244 ///< @verbatim<oct><oct><oct>@endvertbatim
245} fr_sbuff_escape_rules_t;
246
247/** A set of terminal sequences, and escape rules
248 *
249 */
250typedef struct {
251 fr_sbuff_unescape_rules_t const *escapes; //!< Escape characters
252
253 fr_sbuff_term_t const *terminals; //!< Terminal characters used as a hint
254 ///< that a token is not complete.
255} fr_sbuff_parse_rules_t;
256
257/** Standard parsing errors to be used by sbuff functions and other sbuff based parsing functions
258 *
259 */
260typedef enum {
261 FR_SBUFF_PARSE_OK = 0, //!< No error.
262 FR_SBUFF_PARSE_ERROR_NOT_FOUND = -1, //!< String does not contain a token
263 ///< matching the output type.
264 FR_SBUFF_PARSE_ERROR_TRAILING = -2, //!< Trailing characters found.
265 FR_SBUFF_PARSE_ERROR_FORMAT = -3, //!< Format of data was invalid.
266 FR_SBUFF_PARSE_ERROR_OUT_OF_SPACE = -4, //!< No space available in output buffer.
267 FR_SBUFF_PARSE_ERROR_NUM_OVERFLOW = -5, //!< Integer type would overflow.
268 FR_SBUFF_PARSE_ERROR_NUM_UNDERFLOW = -6, //!< Integer type would underflow.
269 FR_SBUFF_PARSE_ERROR_INPUT_EMPTY = -7, //!< Input is empty, and should not be empty
270} fr_sbuff_parse_error_t;
271
272extern fr_table_num_ordered_t const sbuff_parse_error_table[];
273extern size_t sbuff_parse_error_table_len;
274
275/** Replace the contents of the thread local error stack with the string representation of a parse error
276 */
277static inline void fr_sbuff_parse_error_to_strerror(fr_sbuff_parse_error_t err)
278{
279 fr_strerror_const(fr_table_str_by_value(sbuff_parse_error_table, err, "<INVALID>"));
280}
281
282/** Return whether the sbuff is extendable
283 */
284static inline bool fr_sbuff_is_extendable(fr_sbuff_t *sbuff)
285{
286 return sbuff->extend && (!sbuff->eof || (sbuff->eof(sbuff) == false));
287}
288
289#define fr_sbuff_was_extended(_status) (_status & FR_SBUFF_FLAG_EXTENDED)
290
291extern bool const sbuff_char_class_uint[SBUFF_CHAR_CLASS];
292extern bool const sbuff_char_class_int[SBUFF_CHAR_CLASS];
293extern bool const sbuff_char_class_float[SBUFF_CHAR_CLASS];
294extern bool const sbuff_char_class_zero[SBUFF_CHAR_CLASS];
295extern bool const sbuff_char_class_hex[SBUFF_CHAR_CLASS];
296extern bool const sbuff_char_alpha_num[SBUFF_CHAR_CLASS];
297extern bool const sbuff_char_word[SBUFF_CHAR_CLASS];
298extern bool const sbuff_char_whitespace[SBUFF_CHAR_CLASS];
299extern bool const sbuff_char_line_endings[SBUFF_CHAR_CLASS];
300extern bool const sbuff_char_blank[SBUFF_CHAR_CLASS];
301extern bool const sbuff_char_class_hostname[SBUFF_CHAR_CLASS];
302
303/** Matches a-z,A-Z
304 */
305#define SBUFF_CHAR_CLASS_ALPHA \
306 ['a'] = true, ['b'] = true, ['c'] = true, ['d'] = true, ['e'] = true, \
307 ['f'] = true, ['g'] = true, ['h'] = true, ['i'] = true, ['j'] = true, \
308 ['k'] = true, ['l'] = true, ['m'] = true, ['n'] = true, ['o'] = true, \
309 ['p'] = true, ['q'] = true, ['r'] = true, ['s'] = true, ['t'] = true, \
310 ['u'] = true, ['v'] = true, ['w'] = true, ['x'] = true, ['y'] = true, \
311 ['z'] = true, \
312 ['A'] = true, ['B'] = true, ['C'] = true, ['D'] = true, ['E'] = true, \
313 ['F'] = true, ['G'] = true, ['H'] = true, ['I'] = true, ['J'] = true, \
314 ['K'] = true, ['L'] = true, ['M'] = true, ['N'] = true, ['O'] = true, \
315 ['P'] = true, ['Q'] = true, ['R'] = true, ['S'] = true, ['T'] = true, \
316 ['U'] = true, ['V'] = true, ['W'] = true, ['X'] = true, ['Y'] = true, \
317 ['Z'] = true
318
319/** Matches 0-9
320 */
321#define SBUFF_CHAR_CLASS_NUM \
322 ['0'] = true, ['1'] = true, ['2'] = true, ['3'] = true, ['4'] = true, \
323 ['5'] = true, ['6'] = true, ['7'] = true, ['8'] = true, ['9'] = true
324
325/** Matches 0-9,a-z,A-Z
326 */
327#define SBUFF_CHAR_CLASS_ALPHA_NUM \
328 SBUFF_CHAR_CLASS_ALPHA, \
329 SBUFF_CHAR_CLASS_NUM
330
331/** Matches 0-9,a-f,A-F
332 */
333#define SBUFF_CHAR_CLASS_HEX \
334 SBUFF_CHAR_CLASS_NUM, \
335 ['a'] = true, ['b'] = true, ['c'] = true, ['d'] = true, ['e'] = true, \
336 ['f'] = true, \
337 ['A'] = true, ['B'] = true, ['C'] = true, ['D'] = true, ['E'] = true, \
338 ['F'] = true
339
340#define SBUFF_CHAR_CLASS_SYMBOLS \
341 ['!'] = true, ['"'] = true, ['#'] = true, ['$'] = true, ['%'] = true, \
342 ['&'] = true, ['/'] = true, ['('] = true, [')'] = true, ['*'] = true, \
343 ['+'] = true, ['`'] = true, ['-'] = true, ['.'] = true, ['/'] = true, \
344 [':'] = true, [';'] = true, ['<'] = true, ['='] = true, ['>'] = true, \
345 ['?'] = true, ['@'] = true, ['['] = true, ['\''] = true, [']'] = true, \
346 ['^'] = true, ['_'] = true, ['`'] = true, ['{'] = true, ['|'] = true, \
347 ['}'] = true, ['~'] = true \
348
349/*
350 * If the additional tables need to be generated feel free to use this
351 * code snippet.
352 *
353 * @verbatim
354 #include <stdio.h>
355 #include <stdlib.h>
356
357 int main(int argc, char **argv)
358 {
359 int start, end, i;
360 start = atoi(argv[1]);
361 end = atoi(argv[2]);
362 for (i = start; i <= end; i++) {
363 printf("[0x%02x] = true, ", i);
364 if (!(i % 8)) printf("\\\n");
365 }
366 return 0;
367 }
368 * @endverbatim
369 */
370
371/** Unprintables (ascii range)
372 *
373 * We don't include characters in the extended range (128-255) as they're
374 * likely part of a multi-byte sequence and we don't want to break UTF8 strings.
375 */
376#define SBUFF_CHAR_UNPRINTABLES_LOW \
377 [0x00] = true, \
378 [0x01] = true, [0x02] = true, [0x03] = true, [0x04] = true, [0x05] = true, [0x06] = true, [0x07] = true, [0x08] = true, \
379 [0x09] = true, [0x0a] = true, [0x0b] = true, [0x0c] = true, [0x0d] = true, [0x0e] = true, [0x0f] = true, [0x10] = true, \
380 [0x11] = true, [0x12] = true, [0x13] = true, [0x14] = true, [0x15] = true, [0x16] = true, [0x17] = true, [0x18] = true, \
381 [0x19] = true, [0x1a] = true, [0x1b] = true, [0x1c] = true, [0x1d] = true, [0x1e] = true, [0x1f] = true, \
382 [0x7f] = true
383
384/** Unprintables (extended range)
385 *
386 * If these characters are being escaped, the function should also be passed
387 * the 'do_utf8' flag.
388 */
389#define SBUFF_CHAR_UNPRINTABLES_EXTENDED \
390 [0x80] = true, \
391 [0x81] = true, [0x82] = true, [0x83] = true, [0x84] = true, [0x85] = true, [0x86] = true, [0x87] = true, [0x88] = true, \
392 [0x89] = true, [0x8a] = true, [0x8b] = true, [0x8c] = true, [0x8d] = true, [0x8e] = true, [0x8f] = true, [0x90] = true, \
393 [0x91] = true, [0x92] = true, [0x93] = true, [0x94] = true, [0x95] = true, [0x96] = true, [0x97] = true, [0x98] = true, \
394 [0x99] = true, [0x9a] = true, [0x9b] = true, [0x9c] = true, [0x9d] = true, [0x9e] = true, [0x9f] = true, [0xa0] = true, \
395 [0xa1] = true, [0xa2] = true, [0xa3] = true, [0xa4] = true, [0xa5] = true, [0xa6] = true, [0xa7] = true, [0xa8] = true, \
396 [0xa9] = true, [0xaa] = true, [0xab] = true, [0xac] = true, [0xad] = true, [0xae] = true, [0xaf] = true, [0xb0] = true, \
397 [0xb1] = true, [0xb2] = true, [0xb3] = true, [0xb4] = true, [0xb5] = true, [0xb6] = true, [0xb7] = true, [0xb8] = true, \
398 [0xb9] = true, [0xba] = true, [0xbb] = true, [0xbc] = true, [0xbd] = true, [0xbe] = true, [0xbf] = true, [0xc0] = true, \
399 [0xc1] = true, [0xc2] = true, [0xc3] = true, [0xc4] = true, [0xc5] = true, [0xc6] = true, [0xc7] = true, [0xc8] = true, \
400 [0xc9] = true, [0xca] = true, [0xcb] = true, [0xcc] = true, [0xcd] = true, [0xce] = true, [0xcf] = true, [0xd0] = true, \
401 [0xd1] = true, [0xd2] = true, [0xd3] = true, [0xd4] = true, [0xd5] = true, [0xd6] = true, [0xd7] = true, [0xd8] = true, \
402 [0xd9] = true, [0xda] = true, [0xdb] = true, [0xdc] = true, [0xdd] = true, [0xde] = true, [0xdf] = true, [0xe0] = true, \
403 [0xe1] = true, [0xe2] = true, [0xe3] = true, [0xe4] = true, [0xe5] = true, [0xe6] = true, [0xe7] = true, [0xe8] = true, \
404 [0xe9] = true, [0xea] = true, [0xeb] = true, [0xec] = true, [0xed] = true, [0xee] = true, [0xef] = true, [0xf0] = true, \
405 [0xf1] = true, [0xf2] = true, [0xf3] = true, [0xf4] = true, [0xf5] = true, [0xf6] = true, [0xf7] = true, [0xf8] = true, \
406 [0xf9] = true, [0xfa] = true, [0xfb] = true, [0xfc] = true, [0xfd] = true, [0xfe] = true, [0xff] = true
407
408/** Generic wrapper macro to return if there's insufficient memory to satisfy the request on the sbuff
409 *
410 */
411#define FR_SBUFF_RETURN(_func, _sbuff, ...) \
412do { \
413 ssize_t _slen; \
414 _slen = _func(_sbuff, ## __VA_ARGS__ ); \
415 if (_slen < 0) return _slen; \
416} while (0)
417
418/** @name Ephemeral copying macros
419 * @{
420 */
421
422/** @cond */
423
424/** Copy another fr_sbuff_t, modifying it.
425 *
426 * @private
427 */
428#define _FR_SBUFF(_sbuff_or_marker, _start, _current, _end, _extend, _eof, _adv_parent) \
429((fr_sbuff_t){ \
430 .buff = fr_sbuff_buff(_sbuff_or_marker), \
431 .start = (_start), \
432 .end = (_end), \
433 .p = (_current), \
434 .is_const = fr_sbuff_ptr(_sbuff_or_marker)->is_const, \
435 .adv_parent = (_adv_parent), \
436 .shifted = 0, \
437 .extend = (_extend), \
438 .eof = (_eof), \
439 .uctx = fr_sbuff_ptr(_sbuff_or_marker)->uctx, \
440 .parent = fr_sbuff_ptr(_sbuff_or_marker) \
441})
442/* @endcond */
443
444/** Create a new sbuff pointing to the same underlying buffer
445 *
446 * - Parent will _NOT_ be advanced by operations on its child.
447 * - Child will have its `start` pointer set to the `p` pointer of the parent.
448 *
449 * @param[in] _sbuff_or_marker to make an ephemeral copy of.
450 */
451#define FR_SBUFF(_sbuff_or_marker) _FR_SBUFF(_sbuff_or_marker, \
452 fr_sbuff_current(_sbuff_or_marker), \
453 fr_sbuff_current(_sbuff_or_marker), \
454 fr_sbuff_end(_sbuff_or_marker), \
455 fr_sbuff_ptr(_sbuff_or_marker)->extend, \
456 fr_sbuff_ptr(_sbuff_or_marker)->eof, \
457 0x00)
458
459/** Create a new sbuff pointing to the same underlying buffer
460 *
461 * - Parent will _NOT_ be advanced by operations on its child.
462 * - Child will have its `start` pointer set to the `start` pointer of the parent.
463 *
464 * @param[in] _sbuff_or_marker to make an ephemeral copy of.
465 */
466#define FR_SBUFF_ABS(_sbuff_or_marker) _FR_SBUFF(_sbuff_or_marker, \
467 fr_sbuff_start(_sbuff_or_marker), \
468 fr_sbuff_current(_sbuff_or_marker), \
469 fr_sbuff_end(_sbuff_or_marker), \
470 fr_sbuff_ptr(_sbuff_or_marker)->extend, \
471 0x00)
472
473/** Create a new sbuff pointing to the same underlying buffer
474 *
475 * The intent of this sbuff type is to allow parsing operations to be performed
476 * on a subset of the buffer data.
477 *
478 * - Parent will _NOT_ be advanced by operations on its child.
479 * - Child will have its `start` pointer set to the `start` pointer of the parent.
480 * - Child will have its `end` pointer set to the `p` pointer of the parent.
481 * - Child will not extend parent.
482 *
483 * @param[in] _sbuff_or_marker to make an ephemeral copy of.
484 */
485#define FR_SBUFF_REPARSE(_sbuff_or_marker) _FR_SBUFF(_sbuff_or_marker, \
486 fr_sbuff_start(_sbuff_or_marker), \
487 fr_sbuff_start(_sbuff_or_marker), \
488 fr_sbuff_current(_sbuff_or_marker), \
489 NULL, \
490 NULL, \
491 0x00)
492
493/** Create a new sbuff pointing to the same underlying buffer
494 *
495 * - Parent `p` pointer will be advanced with child's `p` pointer.
496 * - Child will have its `start` pointer set to the `p` pointer of the parent.
497 *
498 * @param[in] _sbuff_or_marker to make an ephemeral copy of.
499 */
500#define FR_SBUFF_BIND_CURRENT(_sbuff_or_marker) _FR_SBUFF(_sbuff_or_marker, \
501 fr_sbuff_current(_sbuff_or_marker), \
502 fr_sbuff_current(_sbuff_or_marker), \
503 fr_sbuff_end(_sbuff_or_marker), \
504 fr_sbuff_ptr(_sbuff_or_marker)->extend, \
505 fr_sbuff_ptr(_sbuff_or_marker)->eof, \
506 0x01)
507
508/** Create a new sbuff pointing to the same underlying buffer
509 *
510 * - Parent `p` pointer will be advanced with child's `p` pointer.
511 * - Child will have its `start` pointer set to the `start` pointer of the parent.
512 *
513 * @param[in] _sbuff_or_marker to make an ephemeral copy of.
514 */
515#define FR_SBUFF_BIND_CURRENT_ABS(_sbuff_or_marker) FR_SBUFF_ABS(_sbuff_or_marker, \
516 fr_sbuff_start(_sbuff_or_marker), \
517 fr_sbuff_current(_sbuff_or_marker), \
518 fr_sbuff_end(_sbuff_or_marker), \
519 fr_sbuff_ptr(_sbuff_or_marker)->extend, \
520 fr_sbuff_ptr(_sbuff_or_marker)->eof, \
521 0x01)
522
523/** Creates an empty sbuff which can then be used as a destination for printing
524 *
525 * @note The return value of the function should be used to determine how much
526 * data was written to the buffer.
527 *
528 * @param[in] _start of the buffer.
529 * @param[in] _len_or_end Length of the buffer or the end pointer.
530 */
531#define FR_SBUFF_OUT(_start, _len_or_end) \
532((fr_sbuff_t){ \
533 .buff_i = _start, \
534 .start_i = _Generic((_start), \
535 char * : _start, \
536 uint8_t * : _start \
537 ), \
538 .end_i = _Generic((_len_or_end), \
539 size_t : (char const *)(_start) + ((size_t)(_len_or_end) - 1), \
540 long : (char const *)(_start) + ((size_t)(_len_or_end) - 1), \
541 int : (char const *)(_start) + ((size_t)(_len_or_end) - 1), \
542 unsigned int : (char const *)(_start) + ((size_t)(_len_or_end) - 1), \
543 char * : (char const *)(_len_or_end), \
544 char const * : (char const *)(_len_or_end) \
545 ), \
546 .p_i = _start, \
547 .is_const = false, \
548})
549
550/** Creates an sbuff from existing data, so the caller can read from it.
551 *
552 * @note The return value of the function should be used to determine how much
553 * data was written to the buffer.
554 *
555 * @param[in] _start of the buffer.
556 * @param[in] _len_or_end Length of the buffer or the end pointer.
557 */
558#define FR_SBUFF_IN(_start, _len_or_end) \
559((fr_sbuff_t){ \
560 .buff_i = _start, \
561 .start_i = _Generic((_start), \
562 char * : _start, \
563 char const * : _start, \
564 uint8_t * : _start, \
565 uint8_t const * : _start \
566 ), \
567 .end_i = _Generic((_len_or_end), \
568 size_t : (char const *)(_start) + (size_t)(_len_or_end), \
569 long : (char const *)(_start) + (size_t)(_len_or_end), \
570 int : (char const *)(_start) + (size_t)(_len_or_end), \
571 unsigned int : (char const *)(_start) + (size_t)(_len_or_end), \
572 char * : (char const *)(_len_or_end), \
573 char const * : (char const *)(_len_or_end) \
574 ), \
575 .p_i = _start, \
576 .is_const = true, \
577})
578
579#define FR_SBUFF_IN_STR(_start) FR_SBUFF_IN(_start, strlen(_start))
580
581/** Structure to encapsulate a thread local sbuff information
582 *
583 */
584typedef struct {
585 fr_sbuff_t sbuff; //!< Thread local sbuff.
586 fr_sbuff_uctx_talloc_t tctx; //!< Thread local tctx.
587} fr_sbuff_thread_local_t;
588
589static inline int _sbuff_thread_local_free(void *sbtl)
590{
591 return talloc_free(sbtl);
592}
593
594/** Create a function local and thread local extensible sbuff
595 *
596 * @param[out] _sbuff_out Where to write a pointer to the thread local sbuff
597 * @param[in] _init Initial size for the sbuff buffer.
598 * @param[in] _max Maximum size of the sbuff buffer.
599 */
600#define FR_SBUFF_TALLOC_THREAD_LOCAL(_out, _init, _max) \
601do { \
602 static _Thread_local fr_sbuff_thread_local_t *_sbuff_t_local; \
603 if (!_sbuff_t_local) { \
604 fr_sbuff_thread_local_t *sbtl = talloc_zero(NULL, fr_sbuff_thread_local_t); \
605 fr_sbuff_init_talloc(sbtl, &sbtl->sbuff, &sbtl->tctx, _init, _max); \
606 fr_atexit_thread_local(_sbuff_t_local, _sbuff_thread_local_free, sbtl); \
607 *(_out) = &_sbuff_t_local->sbuff; \
608 } else { \
609 fr_sbuff_reset_talloc(&_sbuff_t_local->sbuff); \
610 *(_out) = &_sbuff_t_local->sbuff; \
611 } \
612} while (0)
613
614void fr_sbuff_update(fr_sbuff_t *sbuff, char *new_buff, size_t new_len);
615
616size_t fr_sbuff_shift(fr_sbuff_t *sbuff, size_t shift, bool move_end);
617
618size_t fr_sbuff_extend_file(fr_sbuff_extend_status_t *status, fr_sbuff_t *sbuff, size_t extension);
619
620bool fr_sbuff_eof_file(fr_sbuff_t *sbuff);
621
622size_t fr_sbuff_extend_talloc(fr_sbuff_extend_status_t *status, fr_sbuff_t *sbuff, size_t extension);
623
624int fr_sbuff_trim_talloc(fr_sbuff_t *sbuff, size_t len);
625
626int fr_sbuff_reset_talloc(fr_sbuff_t *sbuff);
627
628static inline void fr_sbuff_terminate(fr_sbuff_t *sbuff)
629{
630 *sbuff->p = '\0';
631}
632
633static inline void _fr_sbuff_init(fr_sbuff_t *out, char const *start, char const *end, bool is_const)
634{
635 if (unlikely(end < start)) end = start; /* Could be an assert? */
636
637 *out = (fr_sbuff_t){
638 .buff_i = start,
639 .start_i = start,
640 .p_i = start,
641 .end_i = end,
642 .is_const = is_const
643 };
644}
645
646/*
647 * GCC is stupid and will warn about output variables
648 * being unnitialised, even if they're not dereferenced.
649 */
650#if defined(__GNUC__) && __GNUC__ >= 11
651DIAG_OFF(maybe-uninitialized)
652#endif
653
654/** Initialise an sbuff around a stack allocated buffer for printing
655 *
656 * Will \0 terminate the output buffer.
657 *
658 * @param[out] _out Pointer to buffer.
659 * @param[in] _start Start of the buffer. Cannot be const.
660 * @param[in] _len_or_end Either an end pointer or the length
661 * of the buffer. 'end' can be const.
662 */
663#define fr_sbuff_init_out(_out, _start, _len_or_end) \
664do { \
665 *(_start) = '\0'; \
666 _fr_sbuff_init(_out, _start, \
667 _Generic((_len_or_end), \
668 size_t : (char const *)(_start) + ((size_t)(_len_or_end) - 1), \
669 long : (char const *)(_start) + ((size_t)(_len_or_end) - 1), \
670 int : (char const *)(_start) + ((size_t)(_len_or_end) - 1), \
671 char * : (char const *)(_len_or_end), \
672 char const * : (char const *)(_len_or_end) \
673 ), \
674 false); \
675} while (0)
676
677#if defined(__GNUC__) && __GNUC__ >= 11
678DIAG_ON(maybe-uninitialized)
679#endif
680
681/** Initialise an sbuff around a stack allocated buffer for parsing
682 *
683 * @param[out] _out Pointer to buffer.
684 * @param[in] _start Start of the buffer.
685 * @param[in] _len_or_end Either an end pointer or the length
686 * of the buffer.
687 */
688#define fr_sbuff_init_in(_out, _start, _len_or_end) \
689_fr_sbuff_init(_out, _start, \
690_Generic((_len_or_end), \
691 size_t : (char const *)(_start) + (size_t)(_len_or_end), \
692 long : (char const *)(_start) + (size_t)(_len_or_end), \
693 int : (char const *)(_start) + (size_t)(_len_or_end), \
694 char * : (char const *)(_len_or_end), \
695 char const * : (char const *)(_len_or_end) \
696), \
697IS_CONST(char *, _start))
698
699/** Initialise a special sbuff which automatically reads in more data as the buffer is exhausted
700 *
701 * @param[out] sbuff to initialise.
702 * @param[out] fctx to initialise. Must have a lifetime >= to the sbuff.
703 * @param[in] buff Temporary buffer to use for storing file contents.
704 * @param[in] len Length of the temporary buffer.
705 * @param[in] file to read from.
706 * @param[in] max The maximum length of data to read from the file.
707 * @return
708 * - The passed sbuff on success.
709 * - NULL on failure.
710 */
711static inline fr_sbuff_t *fr_sbuff_init_file(fr_sbuff_t *sbuff, fr_sbuff_uctx_file_t *fctx,
712 char *buff, size_t len, FILE *file, size_t max)
713{
714 *fctx = (fr_sbuff_uctx_file_t){
715 .file = file,
716 .max = max,
717 .buff_end = buff + len //!< Store the real end
718 };
719
720 *sbuff = (fr_sbuff_t){
721 .buff = buff,
722 .start = buff,
723 .p = buff,
724 .end = buff, //!< Starts with 0 bytes available
725 .extend = fr_sbuff_extend_file,
726 .eof = fr_sbuff_eof_file,
727 .uctx = fctx
728 };
729
730 return sbuff;
731}
732
733/** Initialise a special sbuff which automatically extends as additional data is written
734 *
735 * @param[in] ctx to allocate buffer in.
736 * @param[out] sbuff to initialise.
737 * @param[out] tctx to initialise. Must have a lifetime >= to the sbuff.
738 * @param[in] init The length of the initial buffer, excluding \0 byte.
739 * @param[in] max The maximum length of the buffer.
740 * @return
741 * - The passed sbuff on success.
742 * - NULL on failure.
743 */
744static inline fr_sbuff_t *fr_sbuff_init_talloc(TALLOC_CTX *ctx,
745 fr_sbuff_t *sbuff, fr_sbuff_uctx_talloc_t *tctx,
746 size_t init, size_t max)
747{
748 char *buff;
749
750 *tctx = (fr_sbuff_uctx_talloc_t){
751 .ctx = ctx,
752 .init = init,
753 .max = max
754 };
755
756 /*
757 * Allocate the initial buffer
758 *
759 * We always allocate a buffer so we don't
760 * trigger ubsan errors by performing
761 * arithmetic on NULL pointers.
762 */
763 buff = talloc_zero_array(ctx, char, init + 1);
764 if (!buff) {
765 fr_strerror_printf("Failed allocating buffer of %zu bytes", init + 1);
766 memset(sbuff, 0, sizeof(*sbuff)); /* clang scan */
767 return NULL;
768 }
769
770 *sbuff = (fr_sbuff_t){
771 .buff = buff,
772 .start = buff,
773 .p = buff,
774 .end = buff + init,
775 .extend = fr_sbuff_extend_talloc,
776 .uctx = tctx
777 };
778
779 return sbuff;
780}
781/** @} */
782
783/** @name Accessors
784 *
785 * Caching the values of these pointers or the pointer values from the sbuff
786 * directly is strongly discouraged as they can become invalidated during
787 * stream parsing or when printing to an auto-expanding buffer.
788 *
789 * These functions should only be used to pass sbuff pointers into 3rd party
790 * APIs.
791 *
792 * @{
793 */
794
795/** Return a pointer to the sbuff
796 *
797 * @param[in] _sbuff_or_marker to return a pointer to.
798 * @return A pointer to the sbuff.
799 */
800#define fr_sbuff_ptr(_sbuff_or_marker) \
801 _Generic((_sbuff_or_marker), \
802 fr_sbuff_t * : ((fr_sbuff_t *)(_sbuff_or_marker)), \
803 fr_sbuff_marker_t * : ((fr_sbuff_marker_t *)(_sbuff_or_marker))->parent \
804 )
805
806/** Return a pointer to the start of the underlying buffer in an sbuff or one of its markers
807 *
808 * @param[in] _sbuff_or_marker to return the buffer for.
809 * @return A pointer to the start of the buffer.
810 */
811#define fr_sbuff_buff(_sbuff_or_marker) \
812 _Generic((_sbuff_or_marker), \
813 fr_sbuff_t * : ((fr_sbuff_t const *)(_sbuff_or_marker))->buff, \
814 fr_sbuff_t const * : ((fr_sbuff_t const *)(_sbuff_or_marker))->buff, \
815 fr_sbuff_marker_t * : ((fr_sbuff_marker_t const *)(_sbuff_or_marker))->parent->buff, \
816 fr_sbuff_marker_t const * : ((fr_sbuff_marker_t const *)(_sbuff_or_marker))->parent->buff \
817 )
818
819/** Return a pointer to the 'start' position of an sbuff or one of its markers
820 *
821 * The start position is not necessarily the start of the buffer, and is
822 * advanced every time an sbuff is copied.
823 *
824 * @param[in] _sbuff_or_marker to return the start position of.
825 * @return A pointer to the start position of the buffer.
826 */
827#define fr_sbuff_start(_sbuff_or_marker) \
828 (_Generic((_sbuff_or_marker), \
829 fr_sbuff_t * : ((fr_sbuff_t const *)(_sbuff_or_marker))->start, \
830 fr_sbuff_t const * : ((fr_sbuff_t const *)(_sbuff_or_marker))->start, \
831 fr_sbuff_marker_t * : ((fr_sbuff_marker_t const *)(_sbuff_or_marker))->parent->start, \
832 fr_sbuff_marker_t const * : ((fr_sbuff_marker_t const *)(_sbuff_or_marker))->parent->start \
833 ))
834
835/** Return a pointer to the 'current' position of an sbuff or one of its markers
836 *
837 * @note Should not be derferenced as it may point past the end of the buffer.
838 * Use #fr_sbuff_char to get the current char.
839 *
840 * @param[in] _sbuff_or_marker to return the current position of.
841 * @return A pointer to the current position of the buffer or marker.
842 */
843#define fr_sbuff_current(_sbuff_or_marker) \
844 (_Generic((_sbuff_or_marker), \
845 fr_sbuff_t * : ((fr_sbuff_t const *)(_sbuff_or_marker))->p, \
846 fr_sbuff_t const * : ((fr_sbuff_t const *)(_sbuff_or_marker))->p, \
847 fr_sbuff_marker_t * : ((fr_sbuff_marker_t const *)(_sbuff_or_marker))->p, \
848 fr_sbuff_marker_t const * : ((fr_sbuff_marker_t const *)(_sbuff_or_marker))->p \
849 ))
850
851/** Return a pointer to the 'end' position of an sbuff or one of its markers
852 *
853 * @param[in] _sbuff_or_marker to return the end position of.
854< * @return A pointer to the end position of the buffer or marker.
855 */
856#define fr_sbuff_end(_sbuff_or_marker) \
857 (_Generic((_sbuff_or_marker), \
858 fr_sbuff_t * : ((fr_sbuff_t const *)(_sbuff_or_marker))->end, \
859 fr_sbuff_t const * : ((fr_sbuff_t const *)(_sbuff_or_marker))->end, \
860 fr_sbuff_marker_t * : ((fr_sbuff_marker_t const *)(_sbuff_or_marker))->parent->end, \
861 fr_sbuff_marker_t const * : ((fr_sbuff_marker_t const *)(_sbuff_or_marker))->parent->end \
862 ))
863
864/** Return the value of the shifted field
865 *
866 * @param[in] _sbuff_or_marker to return the position of.
867 * @return the number of bytes the buffer has been shifted.
868 */
869#define fr_sbuff_shifted(_sbuff_or_marker) \
870 (_Generic((_sbuff_or_marker), \
871 fr_sbuff_t * : ((fr_sbuff_t const *)(_sbuff_or_marker))->shifted, \
872 fr_sbuff_t const * : ((fr_sbuff_t const *)(_sbuff_or_marker))->shifted, \
873 fr_sbuff_marker_t * : ((fr_sbuff_marker_t const *)(_sbuff_or_marker))->parent->shifted, \
874 fr_sbuff_marker_t const * : ((fr_sbuff_marker_t const *)(_sbuff_or_marker))->parent->shifted \
875 ))
876
877/** Return the current char pointed to by the sbuff or '\0' if no more chars remain
878 *
879 * @note Should be used in place of #fr_sbuff_current if switching over the current char.
880 *
881 * @param[in] _sbuff_or_marker to return the current char from.
882 * @param[in] _eob char used to indicate End of Buffer, usually '\0'.
883 * @return The current char pointed to be the sbuff.
884 */
885#define fr_sbuff_char(_sbuff_or_marker, _eob) \
886 (fr_sbuff_current(_sbuff_or_marker) >= fr_sbuff_end(_sbuff_or_marker) ? _eob : *fr_sbuff_current(_sbuff_or_marker))
887
888/** Return the current char as a uint8_t, pointed to by the sbuff or '\0' if no more chars remain
889 *
890 * @note Should be used in place of #fr_sbuff_char when using the char as an index to an array
891 *
892 * @param[in] _sbuff_or_marker to return the current char from.
893 * @param[in] _eob char used to indicate End of Buffer, usually '\0'.
894 * @return The current char pointed to be the sbuff.
895 */
896#define fr_sbuff_uint8(_sbuff_or_marker, _eob) ((uint8_t) fr_sbuff_char(_sbuff_or_marker, _eob))
897
898/** Start a switch block over the current sbuff char
899 *
900 * @note '\0' is used to indicate EOB.
901 *
902 * @param[in] _sbuff_or_marker to return the current char from.
903 * @param[in] _eob char used to indicate End of Buffer, usually '\0'.
904 */
905#define fr_sbuff_switch(_sbuff_or_marker, _eob) \
906 switch (fr_sbuff_char(_sbuff_or_marker, _eob))
907/** @} */
908
909/** @name Length calculations
910 * @{
911 */
912
913/** Return the difference in position between the two sbuffs or markers
914 *
915 * @param[in] _a The first sbuff or marker.
916 * @param[in] _b The second sbuff or marker.
917 * @return
918 * - >0 the number of bytes _a is ahead of _b.
919 * - 0 _a and _b are the same position.
920 * - <0 the number of bytes _a is behind of _b.
921 */
922#define fr_sbuff_diff(_a, _b) \
923 ((ssize_t)(fr_sbuff_current(_a) - fr_sbuff_current(_b)))
924
925/** Return the number of bytes remaining between the sbuff or marker and the end of the buffer
926 *
927 * @note Do not use this in functions that may be used for stream parsing
928 * unless you're sure you know what you're doing.
929 * The value return does not reflect the number of bytes that may
930 * be potentially read from the stream, only the number of bytes
931 * until the end of the current chunk.
932 *
933 * @param[in] _sbuff_or_marker to return the number of bytes remaining for.
934 * @return
935 * - >0 the number of bytes remaining before we reach the end of the buffer.
936 * - -0 we're at the end of the buffer.
937 */
938#define fr_sbuff_remaining(_sbuff_or_marker) \
939 ((size_t)(fr_sbuff_end(_sbuff_or_marker) < fr_sbuff_current(_sbuff_or_marker) ? \
940 0 : (fr_sbuff_end(_sbuff_or_marker) - fr_sbuff_current(_sbuff_or_marker))))
941
942/** Return the number of bytes remaining between the start of the sbuff or marker and the current position
943 *
944 * @param[in] _sbuff_or_marker to return the number of bytes used for.
945 * @return
946 * - >0 the number of bytes the current position has advanced past the start.
947 * - -0 the current position is at the start of the buffer.
948 */
949#define fr_sbuff_used(_sbuff_or_marker) \
950 ((size_t)(fr_sbuff_start(_sbuff_or_marker) > fr_sbuff_current(_sbuff_or_marker) ? \
951 0 : (fr_sbuff_current(_sbuff_or_marker) - fr_sbuff_start(_sbuff_or_marker))))
952
953/** Sets an error marker in the parent
954 *
955 * If an error already exists at this level it will be used instead of the provided error.
956 *
957 * @param[in] sbuff who's parent we'll set the error marker in.
958 * @param[in] err marker to set.
959 * @return <0 the negative offset of the error.
960 */
961static inline fr_slen_t _fr_sbuff_error(fr_sbuff_t *sbuff, char const *err)
962{
963 fr_sbuff_t *parent = sbuff->parent;
964 fr_slen_t slen;
965
966 if (sbuff->err) err = sbuff->err;
967 if (parent) parent->err = err;
968
969 slen = -((err - fr_sbuff_start(sbuff)) + 1);
970
971#ifdef __clang_analyzer__
972 /*
973 * Convince clang that the return value
974 * is always negative. It never can be
975 * else the sbuff code is very broken.
976 */
977 if (slen >= 0) return -1;
978#endif
979
980 return slen;
981}
982
983/** Return the current position as an error marker
984 *
985 * @param[in] _sbuff_or_marker Error marker will be set from the current position of this sbuff.
986 *
987 * +1 is added to the position to disambiguate with 0 meaning "parsed no data".
988 *
989 * An error at offset 0 will be returned as -1.
990 */
991#define fr_sbuff_error(_sbuff_or_marker) \
992 _fr_sbuff_error(fr_sbuff_ptr(_sbuff_or_marker), fr_sbuff_current(_sbuff_or_marker))
993
994/** Like fr_sbuff_used, but adjusts for the value returned for the amount shifted
995 *
996 * @param[in] _sbuff_or_marker to return the number of bytes used for.
997 * @return
998 * - >0 the number of bytes the current position has advanced past the start +
999 * the amount the buffer has shifted.
1000 * - -0 the current position is at the start of the buffer (and hasn't been shifted).
1001 */
1002#define fr_sbuff_used_total(_sbuff_or_marker) \
1003 ((size_t)((fr_sbuff_current(_sbuff_or_marker) + fr_sbuff_shifted(_sbuff_or_marker)) - fr_sbuff_start(_sbuff_or_marker)))
1004
1005/** The length of the underlying buffer
1006 *
1007 * @param[in] _sbuff_or_marker to return the length of.
1008 * @return The length of the underlying buffer (minus 1 byte for \0).
1009 */
1010#define fr_sbuff_len(_sbuff_or_marker) \
1011 ((size_t)(fr_sbuff_end(_sbuff_or_marker) - fr_sbuff_buff(_sbuff_or_marker)))
1012
1013/** How many bytes the sbuff or marker is behind its parent
1014 *
1015 * @param[in] _sbuff_or_marker
1016 * @return
1017 * - 0 the sbuff or marker is ahead of its parent.
1018 * - >0 the number of bytes the marker is behind its parent.
1019 */
1020#define fr_sbuff_behind(_sbuff_or_marker) \
1021 (fr_sbuff_current(_sbuff_or_marker) > fr_sbuff_current((_sbuff_or_marker)->parent) ? \
1022 0 : fr_sbuff_current((_sbuff_or_marker)->parent) - fr_sbuff_current(_sbuff_or_marker))
1023
1024/** How many bytes the sbuff or marker is ahead of its parent
1025 *
1026 * @return
1027 * - 0 the sbuff or marker is behind its parent.
1028 * - >0 the number of bytes the marker is ahead of its parent.
1029 */
1030#define fr_sbuff_ahead(_sbuff_or_marker) \
1031 (fr_sbuff_current((_sbuff_or_marker)->parent) > fr_sbuff_current(_sbuff_or_marker) ? \
1032 0 : fr_sbuff_current(_sbuff_or_marker) - fr_sbuff_current((_sbuff_or_marker)->parent))
1033
1034/** Return the current position in the sbuff as a negative offset
1035 *
1036 */
1037#define FR_SBUFF_ERROR_RETURN(_sbuff_or_marker) return fr_sbuff_error(_sbuff_or_marker)
1038
1039/** Check if _len bytes are available in the sbuff, and if not return the number of bytes we'd need
1040 *
1041 */
1042#define FR_SBUFF_CHECK_REMAINING_RETURN(_sbuff, _len) \
1043 if ((_len) > fr_sbuff_remaining(_sbuff)) return -((_len) - fr_sbuff_remaining(_sbuff))
1044
1045static inline size_t _fr_sbuff_extend_lowat(fr_sbuff_extend_status_t *status, fr_sbuff_t *in, size_t remaining, size_t lowat)
1046{
1047 size_t extended;
1048 fr_sbuff_extend_status_t our_status = 0;
1049
1050 if (!fr_sbuff_is_extendable(in)) {
1051 no_extend:
1052 if (status) *status = our_status;
1053 return remaining;
1054 }
1055
1056 /* Still have data remaining, no need to try and extend */
1057 if (remaining >= lowat) goto no_extend;
1058
1059 if (!in->extend || ((extended = in->extend(&our_status, in, lowat - remaining)) == 0)) {
1060 goto no_extend;
1061 }
1062
1063 our_status |= FR_SBUFF_FLAG_EXTENDED;
1064
1065 if (status) *status = our_status;
1066 return remaining + extended;
1067}
1068
1069/** Extend a buffer if we're below the low water mark
1070 *
1071 * @param[out] _status Should be initialised to FR_SBUFF_EXTENDABLE
1072 * for the first call to this function if used
1073 * as a loop condition.
1074 * Will be filled with the result of the previous
1075 * call, and can be used to determine if the buffer
1076 * was extended.
1077 * @param[in] _sbuff_or_marker to extend.
1078 * @param[in] _lowat If bytes remaining are below the amount, extend.
1079 * @return
1080 * - 0 if there are no bytes left in the buffer and we couldn't extend.
1081 * - >0 the number of bytes in the buffer after extending.
1082 */
1083#define fr_sbuff_extend_lowat(_status, _sbuff_or_marker, _lowat) \
1084 _fr_sbuff_extend_lowat(_status, \
1085 fr_sbuff_ptr(_sbuff_or_marker), \
1086 fr_sbuff_remaining(_sbuff_or_marker), _lowat)
1087
1088/** Check if _len bytes are available in the sbuff and extend the buffer if possible
1089 *
1090 * If we do not have _len bytes in the sbuff after extending, then return.
1091 *
1092 * @param[in] _sbuff to extend.
1093 * @param[in] _len The minimum amount the sbuff should be extended by.
1094 * @return The number of bytes we would need to satisfy _len as a negative integer.
1095 */
1096#define FR_SBUFF_EXTEND_LOWAT_OR_RETURN(_sbuff, _len) \
1097do { \
1098 size_t _remaining = fr_sbuff_extend_lowat(NULL, _sbuff, _len); \
1099 if (_remaining < _len) return -(_len - _remaining); \
1100} while (0)
1101
1102/** Extend a buffer if no space remains
1103 *
1104 * @param[in] _sbuff_or_marker to extend.
1105 * @return
1106 * - 0 if there are no bytes left in the buffer and we couldn't extend.
1107 * - >0 the number of bytes in the buffer after extending.
1108 */
1109#define fr_sbuff_extend(_sbuff_or_marker) fr_sbuff_extend_lowat(NULL, _sbuff_or_marker, 1)
1110
1111/** @} */
1112
1113/** @name Position modification (recursive)
1114 *
1115 * Change the current position of pointers in the sbuff and their children.
1116 * @{
1117 */
1118
1119/** Update the position of p in a list of sbuffs
1120 *
1121 * @note Do not call directly.
1122 */
1123static inline void _fr_sbuff_set_recurse(fr_sbuff_t *sbuff, char const *p)
1124{
1125 sbuff->p_i = p;
1126 sbuff->err = NULL; /* Modifying the position of the sbuff clears the error */
1127
1128 if (sbuff->adv_parent && sbuff->parent) _fr_sbuff_set_recurse(sbuff->parent, p);
1129}
1130
1131static inline ssize_t _fr_sbuff_marker_set(fr_sbuff_marker_t *m, char const *p)
1132{
1133 fr_sbuff_t *sbuff = m->parent;
1134 char *current = m->p;
1135
1136 if (unlikely(p > sbuff->end)) return -(p - sbuff->end);
1137 if (unlikely(p < sbuff->start)) return 0;
1138
1139 sbuff->err = NULL; /* Modifying the position of any markers clears the error, unsure if this is correct? */
1140 m->p_i = p;
1141
1142 return p - current;
1143}
1144
1145static inline ssize_t _fr_sbuff_set(fr_sbuff_t *sbuff, char const *p)
1146{
1147 char const *c;
1148
1149 if (unlikely(p > sbuff->end)) return -(p - sbuff->end);
1150 if (unlikely(p < sbuff->start)) return 0;
1151
1152 c = sbuff->p;
1153 _fr_sbuff_set_recurse(sbuff, p);
1154
1155 return p - c;
1156}
1157
1158/** Set the position in a sbuff using another sbuff, a char pointer, or a length
1159 *
1160 * @param[in] _dst sbuff or marker to set the position for.
1161 * @param[in] _src Variable to glean new position from. Behaviour here
1162 * depends on the type of the variable.
1163 * - sbuff, the current position of the sbuff.
1164 * - marker, the current position of the marker.
1165 * - pointer, the position of the pointer.
1166 * - size_t, _dst->start + _src.
1167 * @return
1168 * - 0 not advanced.
1169 * - >0 the number of bytes the sbuff was advanced by.
1170 * - <0 the number of bytes required to complete the advancement
1171 */
1172#define fr_sbuff_set(_dst, _src) \
1173_Generic((_dst), \
1174 fr_sbuff_t * : _fr_sbuff_set, \
1175 fr_sbuff_marker_t * : _fr_sbuff_marker_set \
1176)(_dst, \
1177_Generic((_src), \
1178 fr_sbuff_t * : fr_sbuff_current((fr_sbuff_t const *)(_src)), \
1179 fr_sbuff_t const * : fr_sbuff_current((fr_sbuff_t const *)(_src)), \
1180 fr_sbuff_marker_t * : fr_sbuff_current((fr_sbuff_marker_t const *)(_src)), \
1181 fr_sbuff_marker_t const * : fr_sbuff_current((fr_sbuff_marker_t const *)(_src)), \
1182 char const * : (char const *)(_src), \
1183 char * : (char const *)(_src), \
1184 size_t : (fr_sbuff_start(_dst) + (uintptr_t)(_src)) \
1185))
1186
1187/** Set an sbuff to a given position, and return how much it was advanced
1188 *
1189 * @param[in] _dst to modify.
1190 * @param[in] _src position to set it too.
1191 * @return The number of bytes _dst was advanced.
1192 */
1193#define FR_SBUFF_SET_RETURN(_dst, _src) return fr_sbuff_set(_dst, _src)
1194
1195/** Advance position in sbuff by N bytes
1196 *
1197 * @param[in] _sbuff_or_marker to advance.
1198 * @param[in] _len How much to advance sbuff by.
1199 * @return
1200 * - 0 not advanced.
1201 * - >0 the number of bytes the sbuff was advanced by.
1202 * - <0 the number of bytes required to complete the advancement
1203 */
1204#define fr_sbuff_advance(_sbuff_or_marker, _len) fr_sbuff_set(_sbuff_or_marker, (fr_sbuff_current(_sbuff_or_marker) + (_len)))
1205#define FR_SBUFF_ADVANCE_RETURN(_sbuff, _len) FR_SBUFF_RETURN(fr_sbuff_advance, _sbuff, _len)
1206
1207/** Reset the current position of the sbuff to the start of the string
1208 *
1209 */
1210static inline void fr_sbuff_set_to_start(fr_sbuff_t *sbuff)
1211{
1212 _fr_sbuff_set_recurse(sbuff, sbuff->start);
1213}
1214
1215/** Reset the current position of the sbuff to the end of the string
1216 *
1217 */
1218static inline void fr_sbuff_set_to_end(fr_sbuff_t *sbuff)
1219{
1220 _fr_sbuff_set_recurse(sbuff, sbuff->end);
1221}
1222/** @} */
1223
1224/** @name Add a marker to an sbuff
1225 *
1226 * Markers are used to indicate an area of the code is working at a particular
1227 * point in a string buffer.
1228 *
1229 * If the sbuff is performing stream parsing, then markers are used to update
1230 * any pointers to the buffer, as the data in the buffer is shifted to make
1231 * room for new data from the stream.
1232 *
1233 * If the sbuff is being used to create strings, then the markers are updated
1234 * if the buffer is re-allocated.
1235 * @{
1236 */
1237
1238/** Adds a new pointer to the beginning of the list of pointers to update
1239 *
1240 * @param[out] m to initialise.
1241 * @param[in] sbuff to associate marker with.
1242 * @return The position the marker was set to.
1243 */
1244static inline char *fr_sbuff_marker(fr_sbuff_marker_t *m, fr_sbuff_t *sbuff)
1245{
1246 *m = (fr_sbuff_marker_t){
1247 .next = sbuff->m, /* Link into the head */
1248 .p = sbuff->p, /* Set the current position in the sbuff */
1249 .parent = sbuff /* Record which sbuff this marker was associated with */
1250 };
1251 sbuff->m = m;
1252
1253 return sbuff->p;
1254}
1255
1256/** Used to update the position of an 'end' position marker
1257 *
1258 * Updates a marker so that it represents a 'constrained' end.
1259 * If max > fr_sbuff_remaining() + fr_sbuff_used_total(), then the marker will
1260 * be set to the end of the sbuff.
1261 *
1262 * Otherwise the marker will be set to the position indicated by
1263 * start + (max - fr_sbuff_used_total()).
1264 *
1265 * This is used to add a constraint on the amount data that can be copied from
1266 * an extendable buffer.
1267 *
1268 * @param[in] m Marker created with #fr_sbuff_marker.
1269 * @param[in] max amount of data we allow to be read from
1270 * the sbuff. May be SIZE_MAX in which
1271 * case there is no constraint imposed
1272 * and the marker is set to the end of the buffer.
1273 */
1274static inline char *fr_sbuff_marker_update_end(fr_sbuff_marker_t *m, size_t max)
1275{
1276 fr_sbuff_t *sbuff = m->parent;
1277 size_t used = fr_sbuff_used_total(sbuff);
1278
1279 m->p = (((max) - (used)) > fr_sbuff_remaining(sbuff) ?
1280 fr_sbuff_end(sbuff) :
1281 fr_sbuff_current(sbuff) + ((max) - (used)));
1282
1283 return m->p;
1284}
1285
1286/** Trims the linked list back to the specified pointer
1287 *
1288 * Pointers should be released in the inverse order to allocation.
1289 *
1290 * Alternatively the oldest pointer can be released, resulting in any newer pointer
1291 * also being removed from the list.
1292 *
1293 * @param[in] m to release.
1294 */
1295static inline void fr_sbuff_marker_release(fr_sbuff_marker_t *m)
1296{
1297 m->parent->m = m->next;
1298
1299#ifndef NDEBUG
1300 memset(m, 0, sizeof(*m)); /* Use after release */
1301#endif
1302}
1303
1304/** Trims the linked list back to the specified pointer and return how many bytes marker was behind p
1305 *
1306 * Pointers should be released in the inverse order to allocation.
1307 *
1308 * Alternatively the oldest pointer can be released, resulting in any newer pointer
1309 * also being removed from the list.
1310 *
1311 * @param[in] m to release.
1312 * @return
1313 * - 0 marker is ahead of p.
1314 * - >0 the number of bytes the marker is behind p.
1315 */
1316static inline size_t fr_sbuff_marker_release_behind(fr_sbuff_marker_t *m)
1317{
1318 size_t len = fr_sbuff_behind(m);
1319 fr_sbuff_marker_release(m);
1320 return len;
1321}
1322
1323/** Trims the linked list back to the specified pointer and return how many bytes marker was ahead of p
1324 *
1325 * Pointers should be released in the inverse order to allocation.
1326 *
1327 * Alternatively the oldest pointer can be released, resulting in any newer pointer
1328 * also being removed from the list.
1329 *
1330 * @param[in] m to release.
1331 * @return
1332 * - 0 marker is ahead of p.
1333 * - >0 the number of bytes the marker is behind p.
1334 */
1335static inline size_t fr_sbuff_marker_release_ahead(fr_sbuff_marker_t *m)
1336{
1337 size_t len = fr_sbuff_ahead(m);
1338 fr_sbuff_marker_release(m);
1339 return len;
1340}
1341
1342/** Trims the linked list back to the specified pointer and return how many bytes marker was behind p
1343 *
1344 * Pointers should be released in the inverse order to allocation.
1345 *
1346 * Alternatively the oldest pointer can be released, resulting in any newer pointer
1347 * also being removed from the list.
1348 *
1349 * @param[in] m to release.
1350 * @return
1351 * - 0 marker is ahead of p.
1352 * - >0 the number of bytes the marker is behind p.
1353 */
1354static inline size_t fr_sbuff_marker_release_reset_behind(fr_sbuff_marker_t *m)
1355{
1356 size_t len = fr_sbuff_behind(m);
1357 fr_sbuff_set(m->parent, m);
1358 fr_sbuff_marker_release(m);
1359 return len;
1360}
1361
1362/** Trims the linked list back to the specified pointer and return how many bytes marker was ahead of p
1363 *
1364 * Pointers should be released in the inverse order to allocation.
1365 *
1366 * Alternatively the oldest pointer can be released, resulting in any newer pointer
1367 * also being removed from the list.
1368 *
1369 * @param[in] m to release.
1370 * @return
1371 * - 0 marker is ahead of p.
1372 * - >0 the number of bytes the marker is behind p.
1373 */
1374static inline size_t fr_sbuff_marker_release_reset_ahead(fr_sbuff_marker_t *m)
1375{
1376 size_t len = fr_sbuff_ahead(m);
1377 fr_sbuff_set(m->parent, m);
1378 fr_sbuff_marker_release(m);
1379 return len;
1380}
1381/** @} */
1382
1383/** @name Copy data between an sbuff/marker
1384 *
1385 * These functions are typically used for moving data between sbuffs
1386 *
1387 * @{
1388 */
1389size_t _fr_sbuff_move_sbuff_to_sbuff(fr_sbuff_t *out, fr_sbuff_t *in, size_t len);
1390
1391size_t _fr_sbuff_move_marker_to_sbuff(fr_sbuff_t *out, fr_sbuff_marker_t *in, size_t len);
1392
1393size_t _fr_sbuff_move_marker_to_marker(fr_sbuff_marker_t *out, fr_sbuff_marker_t *in, size_t len);
1394
1395size_t _fr_sbuff_move_sbuff_to_marker(fr_sbuff_marker_t *out, fr_sbuff_t *in, size_t len);
1396
1397/** Copy in as many bytes as possible from one sbuff or marker to another
1398 *
1399 * @param[in] _out to copy into.
1400 * @param[in] _in to copy from.
1401 * @param[in] _len The maximum length to copy.
1402 * @return Number of bytes copied.
1403 */
1404#define fr_sbuff_move(_out, _in, _len) \
1405 _Generic((_out), \
1406 fr_sbuff_t * : \
1407 _Generic((_in), \
1408 fr_sbuff_t * : _fr_sbuff_move_sbuff_to_sbuff((fr_sbuff_t *)_out, (fr_sbuff_t *)_in, _len), \
1409 fr_sbuff_marker_t * : _fr_sbuff_move_marker_to_sbuff((fr_sbuff_t *)_out, (fr_sbuff_marker_t *)_in, _len) \
1410 ), \
1411 fr_sbuff_marker_t * : \
1412 _Generic((_in), \
1413 fr_sbuff_t * : _fr_sbuff_move_sbuff_to_marker((fr_sbuff_marker_t *)_out, (fr_sbuff_t *)_in, _len), \
1414 fr_sbuff_marker_t * : _fr_sbuff_move_marker_to_marker((fr_sbuff_marker_t *)_out, (fr_sbuff_marker_t *)_in, _len) \
1415 ) \
1416 )
1417/** @} */
1418
1419/** @name Copy/print complete input data to an sbuff
1420 *
1421 * These functions are typically used for printing.
1422 *
1423 * @{
1424 */
1425#define fr_sbuff_in_char(_sbuff, ...) fr_sbuff_in_bstrncpy(_sbuff, ((char []){ __VA_ARGS__ }), sizeof((char []){ __VA_ARGS__ }))
1426#define FR_SBUFF_IN_CHAR_RETURN(_sbuff, ...) FR_SBUFF_RETURN(fr_sbuff_in_bstrncpy, _sbuff, ((char []){ __VA_ARGS__ }), sizeof((char []){ __VA_ARGS__ }))
1427
1428ssize_t fr_sbuff_in_strcpy(fr_sbuff_t *sbuff, char const *str);
1429#define FR_SBUFF_IN_STRCPY_RETURN(...) FR_SBUFF_RETURN(fr_sbuff_in_strcpy, ##__VA_ARGS__)
1430
1431ssize_t fr_sbuff_in_bstrncpy(fr_sbuff_t *sbuff, char const *str, size_t len);
1432#define FR_SBUFF_IN_BSTRNCPY_RETURN(...) FR_SBUFF_RETURN(fr_sbuff_in_bstrncpy, ##__VA_ARGS__)
1433
1434#define fr_sbuff_in_strcpy_literal(_sbuff, _str) fr_sbuff_in_bstrncpy(_sbuff, _str, sizeof(_str) - 1)
1435#define FR_SBUFF_IN_STRCPY_LITERAL_RETURN(_sbuff, _str) FR_SBUFF_RETURN(fr_sbuff_in_bstrncpy, _sbuff, _str, sizeof(_str) - 1)
1436
1437ssize_t fr_sbuff_in_bstrcpy_buffer(fr_sbuff_t *sbuff, char const *str);
1438#define FR_SBUFF_IN_BSTRCPY_BUFFER_RETURN(...) FR_SBUFF_RETURN(fr_sbuff_in_bstrcpy_buffer, ##__VA_ARGS__)
1439
1440ssize_t fr_sbuff_in_vsprintf(fr_sbuff_t *sbuff, char const *fmt, va_list ap);
1441#define FR_SBUFF_IN_VSPRINTF_RETURN(...) FR_SBUFF_RETURN(fr_sbuff_in_vsprintf, ##__VA_ARGS__)
1442
1443ssize_t fr_sbuff_in_sprintf(fr_sbuff_t *sbuff, char const *fmt, ...);
1444#define FR_SBUFF_IN_SPRINTF_RETURN(...) FR_SBUFF_RETURN(fr_sbuff_in_sprintf, ##__VA_ARGS__)
1445
1446ssize_t fr_sbuff_in_escape(fr_sbuff_t *sbuff, char const *in, size_t inlen, fr_sbuff_escape_rules_t const *e_rules);
1447#define FR_SBUFF_IN_ESCAPE_RETURN(...) FR_SBUFF_RETURN(fr_sbuff_in_escape, ##__VA_ARGS__)
1448
1449ssize_t fr_sbuff_in_escape_buffer(fr_sbuff_t *sbuff, char const *in, fr_sbuff_escape_rules_t const *e_rules);
1450#define FR_SBUFF_IN_ESCAPE_BUFFER_RETURN(...) FR_SBUFF_RETURN(fr_sbuff_in_escape_buffer, ##__VA_ARGS__)
1451
1452ssize_t fr_sbuff_in_array(fr_sbuff_t *sbuff, char const * const *array, char const *sep);
1453#define FR_SBUFF_IN_ARRAY(...) FR_SBUFF_RETURN(fr_sbuff_in_array, ##__VA_ARGS__)
1454
1455/** Lookup a string in a table using an integer value, and copy it to the sbuff
1456 *
1457 * @param[out] _slen Where to write the return value.
1458 * @param[in] _sbuff to search in.
1459 * @param[in] _table to search for number in.
1460 * @param[in] _number to search for.
1461 * @param[in] _def Default string value.
1462 */
1463#define fr_sbuff_in_table_str(_slen, _sbuff, _table, _number, _def) \
1464 _slen = fr_sbuff_in_strcpy(_sbuff, fr_table_str_by_value(_table, _number, _def))
1465#define FR_SBUFF_IN_TABLE_STR_RETURN(_sbuff, _table, _number, _def) \
1466do { \
1467 ssize_t _slen; \
1468 fr_sbuff_in_table_str(_slen, _sbuff, _table, _number, _def); \
1469 if (_slen < 0) return _slen; \
1470} while (0)
1471/** @} */
1472
1473/** @name Copy data out of an sbuff
1474 *
1475 * These functions are typically used for parsing.
1476 *
1477 * @{
1478 */
1479
1480/** Toggle any chars to 'true' in out, that were present in, out or in
1481 *
1482 */
1483static inline void fr_sbuff_allowed_merge(bool out[static SBUFF_CHAR_CLASS], bool const in[static SBUFF_CHAR_CLASS])
1484{
1485 for (size_t i = 0; i <= UINT8_MAX; i++) out[i] = out[i] || in[i];
1486}
1487
1488fr_sbuff_term_t *fr_sbuff_terminals_amerge(TALLOC_CTX *ctx,
1489 fr_sbuff_term_t const *a, fr_sbuff_term_t const *b);
1490
1491size_t fr_sbuff_out_bstrncpy(fr_sbuff_t *out, fr_sbuff_t *in, size_t len);
1492
1493ssize_t fr_sbuff_out_bstrncpy_exact(fr_sbuff_t *out, fr_sbuff_t *in, size_t len);
1494
1495size_t fr_sbuff_out_bstrncpy_allowed(fr_sbuff_t *out, fr_sbuff_t *in, size_t len,
1496 bool const allowed[static SBUFF_CHAR_CLASS]);
1497
1498size_t fr_sbuff_out_bstrncpy_until(fr_sbuff_t *out, fr_sbuff_t *in, size_t len,
1499 fr_sbuff_term_t const *tt,
1500 fr_sbuff_unescape_rules_t const *u_rules);
1501
1502size_t fr_sbuff_out_unescape_until(fr_sbuff_t *out, fr_sbuff_t *in, size_t len,
1503 fr_sbuff_term_t const *tt,
1504 fr_sbuff_unescape_rules_t const *u_rules);
1505
1506/** Find the longest prefix in an sbuff
1507 *
1508 * @param[out] _match_len The length of the matched string.
1509 * May be NULL.
1510 * @param[out] _out The value resolved in the table.
1511 * @param[in] _table to find longest match in.
1512 * @param[in] _sbuff containing the needle.
1513 * @param[in] _def Default value if no match is found.
1514 */
1515#define fr_sbuff_out_by_longest_prefix(_match_len, _out, _table, _sbuff, _def) \
1516do { \
1517 size_t _match_len_tmp; \
1518 fr_sbuff_extend_lowat(NULL, _sbuff, fr_table_max_needle_len(_table)); \
1519 *(_out) = fr_table_value_by_longest_prefix(&_match_len_tmp, _table, \
1520 fr_sbuff_current(_sbuff), fr_sbuff_remaining(_sbuff), \
1521 _def); \
1522 (void) fr_sbuff_advance(_sbuff, _match_len_tmp); /* can't fail */ \
1523 *(_match_len) = _match_len_tmp; \
1524} while (0)
1525
1526/** Build a talloc wrapper function for a fr_sbuff_out_* function
1527 *
1528 * @param[in] _func to call.
1529 * @param[in] _in input sbuff arg.
1530 * @param[in] _len expected output len.
1531 * @param[in] ... additional arguments to pass to _func.
1532 */
1533#define SBUFF_OUT_TALLOC_ERR_FUNC_DEF(_func, _in, _len, ...) \
1534{ \
1535 fr_sbuff_t sbuff; \
1536 fr_sbuff_uctx_talloc_t tctx; \
1537 fr_sbuff_parse_error_t err; \
1538 fr_slen_t slen = -1; \
1539 if (unlikely(fr_sbuff_init_talloc(ctx, &sbuff, &tctx, \
1540 ((_len) != SIZE_MAX) ? (_len) : 1024, \
1541 ((_len) != SIZE_MAX) ? (_len) : SIZE_MAX) == NULL)) { \
1542 error: \
1543 TALLOC_FREE(sbuff.buff); \
1544 *out = NULL; \
1545 return slen; \
1546 } \
1547 slen = _func(&err, &sbuff, _in, _len, ##__VA_ARGS__); \
1548 if (slen < 0) goto error; \
1549 if (unlikely(fr_sbuff_trim_talloc(&sbuff, SIZE_MAX) < 0)) { \
1550 slen = -1; \
1551 goto error; \
1552 } \
1553 *out = sbuff.buff; \
1554 return slen; \
1555}
1556
1557/** Build a talloc wrapper function for a fr_sbuff_out_* function
1558 *
1559 * @param[in] _func to call.
1560 * @param[in] _in input sbuff arg.
1561 * @param[in] _len expected output len.
1562 * @param[in] ... additional arguments to pass to _func.
1563 */
1564#define SBUFF_OUT_TALLOC_FUNC_DEF(_func, _in, _len, ...) \
1565{ \
1566 fr_sbuff_t sbuff; \
1567 fr_sbuff_uctx_talloc_t tctx; \
1568 fr_slen_t slen = -1; \
1569 if (unlikely(fr_sbuff_init_talloc(ctx, &sbuff, &tctx, \
1570 ((_len) != SIZE_MAX) ? (_len) : 1024, \
1571 ((_len) != SIZE_MAX) ? (_len) : SIZE_MAX) == NULL)) { \
1572 error: \
1573 TALLOC_FREE(sbuff.buff); \
1574 *out = NULL; \
1575 return slen; \
1576 } \
1577 slen = _func(&sbuff, _in, _len, ##__VA_ARGS__); \
1578 if (slen < 0) goto error; \
1579 if (unlikely(fr_sbuff_trim_talloc(&sbuff, SIZE_MAX) < 0)) { \
1580 slen = -1; \
1581 goto error; \
1582 } \
1583 *out = sbuff.buff; \
1584 return slen; \
1585}
1586
1587/** Build a talloc wrapper function for a fr_sbuff_out_* function
1588 *
1589 * @param[in] _func to call.
1590 * @param[in] ... additional arguments to pass to _func.
1591 */
1592#define SBUFF_OUT_TALLOC_FUNC_NO_LEN_DEF(_func, ...) \
1593{ \
1594 fr_sbuff_t sbuff; \
1595 fr_sbuff_uctx_talloc_t tctx; \
1596 fr_slen_t slen = -1; \
1597 if (unlikely(fr_sbuff_init_talloc(ctx, &sbuff, &tctx, 0, SIZE_MAX) == NULL)) { \
1598 error: \
1599 TALLOC_FREE(sbuff.buff); \
1600 *out = NULL; \
1601 return slen; \
1602 } \
1603 slen = _func(&sbuff, ##__VA_ARGS__); \
1604 if (slen < 0) goto error; \
1605 if (unlikely(fr_sbuff_trim_talloc(&sbuff, SIZE_MAX) < 0)) { \
1606 slen = -1; \
1607 goto error; \
1608 } \
1609 *out = sbuff.buff; \
1610 return slen; \
1611}
1612
1613static inline fr_slen_t fr_sbuff_out_abstrncpy(TALLOC_CTX *ctx, char **out, fr_sbuff_t *in, size_t len)
1614SBUFF_OUT_TALLOC_FUNC_DEF(fr_sbuff_out_bstrncpy, in, len)
1615
1616static inline fr_slen_t fr_sbuff_out_abstrncpy_exact(TALLOC_CTX *ctx, char **out, fr_sbuff_t *in, size_t len)
1617SBUFF_OUT_TALLOC_FUNC_DEF(fr_sbuff_out_bstrncpy_exact, in, len)
1618
1619static inline fr_slen_t fr_sbuff_out_abstrncpy_allowed(TALLOC_CTX *ctx, char **out, fr_sbuff_t *in, size_t len,
1620 bool const allowed[static SBUFF_CHAR_CLASS])
1621SBUFF_OUT_TALLOC_FUNC_DEF(fr_sbuff_out_bstrncpy_allowed, in, len, allowed)
1622
1623static inline fr_slen_t fr_sbuff_out_abstrncpy_until(TALLOC_CTX *ctx, char **out, fr_sbuff_t *in, size_t len,
1624 fr_sbuff_term_t const *tt,
1625 fr_sbuff_unescape_rules_t const *u_rules)
1626SBUFF_OUT_TALLOC_FUNC_DEF(fr_sbuff_out_bstrncpy_until, in, len, tt, u_rules)
1627
1628static inline fr_slen_t fr_sbuff_out_aunescape_until(TALLOC_CTX *ctx, char **out, fr_sbuff_t *in, size_t len,
1629 fr_sbuff_term_t const *tt,
1630 fr_sbuff_unescape_rules_t const *u_rules)
1631SBUFF_OUT_TALLOC_FUNC_DEF(fr_sbuff_out_unescape_until, in, len, tt, u_rules)
1632/** @} */
1633
1634/** @name Look for a token in a particular format, parse it, and write it to the output pointer
1635 *
1636 * These functions should not be called directly. #fr_sbuff_out should be used instead
1637 * so that if the output variable type changes, the parse rules are automatically changed.
1638 * @{
1639 */
1640fr_slen_t fr_sbuff_out_bool(bool *out, fr_sbuff_t *in);
1641
1642fr_slen_t fr_sbuff_out_int8(fr_sbuff_parse_error_t *err, int8_t *out, fr_sbuff_t *sbuff, bool no_trailing);
1643fr_slen_t fr_sbuff_out_int16(fr_sbuff_parse_error_t *err, int16_t *out, fr_sbuff_t *sbuff, bool no_trailing);
1644fr_slen_t fr_sbuff_out_int32(fr_sbuff_parse_error_t *err, int32_t *out, fr_sbuff_t *sbuff, bool no_trailing);
1645fr_slen_t fr_sbuff_out_int64(fr_sbuff_parse_error_t *err, int64_t *out, fr_sbuff_t *sbuff, bool no_trailing);
1646fr_slen_t fr_sbuff_out_ssize(fr_sbuff_parse_error_t *err, ssize_t *out, fr_sbuff_t *sbuff, bool no_trailing);
1647fr_slen_t fr_sbuff_out_uint8(fr_sbuff_parse_error_t *err, uint8_t *out, fr_sbuff_t *sbuff, bool no_trailing);
1648fr_slen_t fr_sbuff_out_uint16(fr_sbuff_parse_error_t *err, uint16_t *out, fr_sbuff_t *sbuff, bool no_trailing);
1649fr_slen_t fr_sbuff_out_uint32(fr_sbuff_parse_error_t *err, uint32_t *out, fr_sbuff_t *sbuff, bool no_trailing);
1650fr_slen_t fr_sbuff_out_uint64(fr_sbuff_parse_error_t *err, uint64_t *out, fr_sbuff_t *sbuff, bool no_trailing);
1651fr_slen_t fr_sbuff_out_size(fr_sbuff_parse_error_t *err, size_t *out, fr_sbuff_t *sbuff, bool no_trailing);
1652
1653fr_slen_t fr_sbuff_out_uint8_dec(fr_sbuff_parse_error_t *err, uint8_t *out, fr_sbuff_t *sbuff, bool no_trailing);
1654fr_slen_t fr_sbuff_out_uint16_dec(fr_sbuff_parse_error_t *err, uint16_t *out, fr_sbuff_t *sbuff, bool no_trailing);
1655fr_slen_t fr_sbuff_out_uint32_dec(fr_sbuff_parse_error_t *err, uint32_t *out, fr_sbuff_t *sbuff, bool no_trailing);
1656fr_slen_t fr_sbuff_out_uint64_dec(fr_sbuff_parse_error_t *err, uint64_t *out, fr_sbuff_t *sbuff, bool no_trailing);
1657fr_slen_t fr_sbuff_out_size_dec(fr_sbuff_parse_error_t *err, size_t *out, fr_sbuff_t *sbuff, bool no_trailing);
1658
1659fr_slen_t fr_sbuff_out_uint8_oct(fr_sbuff_parse_error_t *err, uint8_t *out, fr_sbuff_t *sbuff, bool no_trailing);
1660fr_slen_t fr_sbuff_out_uint16_oct(fr_sbuff_parse_error_t *err, uint16_t *out, fr_sbuff_t *sbuff, bool no_trailing);
1661fr_slen_t fr_sbuff_out_uint32_oct(fr_sbuff_parse_error_t *err, uint32_t *out, fr_sbuff_t *sbuff, bool no_trailing);
1662fr_slen_t fr_sbuff_out_uint64_oct(fr_sbuff_parse_error_t *err, uint64_t *out, fr_sbuff_t *sbuff, bool no_trailing);
1663fr_slen_t fr_sbuff_out_size_oct(fr_sbuff_parse_error_t *err, size_t *out, fr_sbuff_t *sbuff, bool no_trailing);
1664
1665fr_slen_t fr_sbuff_out_uint8_hex(fr_sbuff_parse_error_t *err, uint8_t *out, fr_sbuff_t *sbuff, bool no_trailing);
1666fr_slen_t fr_sbuff_out_uint16_hex(fr_sbuff_parse_error_t *err, uint16_t *out, fr_sbuff_t *sbuff, bool no_trailing);
1667fr_slen_t fr_sbuff_out_uint32_hex(fr_sbuff_parse_error_t *err, uint32_t *out, fr_sbuff_t *sbuff, bool no_trailing);
1668fr_slen_t fr_sbuff_out_uint64_hex(fr_sbuff_parse_error_t *err, uint64_t *out, fr_sbuff_t *sbuff, bool no_trailing);
1669fr_slen_t fr_sbuff_out_size_hex(fr_sbuff_parse_error_t *err, size_t *out, fr_sbuff_t *sbuff, bool no_trailing);
1670
1671fr_slen_t fr_sbuff_out_float32(fr_sbuff_parse_error_t *err, float *out, fr_sbuff_t *sbuff, bool no_trailing);
1672fr_slen_t fr_sbuff_out_float64(fr_sbuff_parse_error_t *err, double *out, fr_sbuff_t *sbuff, bool no_trailing);
1673
1674#ifndef SIZE_SAME_AS_UINT64
1675# define _fr_sbuff_out_size(_err, _out, _in) size_t * : fr_sbuff_out_size(_err, (size_t *)_out, _in, true),
1676#else
1677# define _fr_sbuff_out_size(_err, _out, _in)
1678#endif
1679
1680#ifndef SSIZE_SAME_AS_INT64
1681# define _fr_sbuff_out_ssize(_err, _out, _in) ssize_t * : fr_sbuff_out_ssize(_err, (ssize_t *)_out, _in, true),
1682#else
1683# define _fr_sbuff_out_ssize(_err, _out, _in)
1684#endif
1685
1686/** Parse a value based on the output type
1687 *
1688 * @param[out] _err If not NULL a value describing the parse error
1689 * will be written to err.
1690 * @param[out] _out Pointer to an integer type.
1691 * @param[in] _in Sbuff to parse integer from.
1692 * @return The number of bytes parsed (even on error).
1693 */
1694#define fr_sbuff_out(_err, _out, _in) \
1695 _Generic((_out), \
1696 bool * : fr_sbuff_out_bool((bool *)_out, _in), \
1697 int8_t * : fr_sbuff_out_int8(_err, (int8_t *)_out, _in, true), \
1698 int16_t * : fr_sbuff_out_int16(_err, (int16_t *)_out, _in, true), \
1699 int32_t * : fr_sbuff_out_int32(_err, (int32_t *)_out, _in, true), \
1700 int64_t * : fr_sbuff_out_int64(_err, (int64_t *)_out, _in, true), \
1701 _fr_sbuff_out_ssize(_err, _out, _in) \
1702 uint8_t * : fr_sbuff_out_uint8(_err, (uint8_t *)_out, _in, true), \
1703 uint16_t * : fr_sbuff_out_uint16(_err, (uint16_t *)_out, _in, true), \
1704 uint32_t * : fr_sbuff_out_uint32(_err, (uint32_t *)_out, _in, true), \
1705 uint64_t * : fr_sbuff_out_uint64(_err, (uint64_t *)_out, _in, true), \
1706 _fr_sbuff_out_size(_err, _out, _in) \
1707 float * : fr_sbuff_out_float32(_err, (float *)_out, _in, true), \
1708 double * : fr_sbuff_out_float64(_err, (double *)_out, _in, true) \
1709 )
1710/** @} */
1711
1712
1713/** @name Conditional advancement
1714 *
1715 * These functions are typically used for parsing when trying to locate
1716 * a sequence of characters in the sbuff.
1717 *
1718 * @{
1719 */
1720size_t fr_sbuff_adv_past_str(fr_sbuff_t *sbuff, char const *needle, size_t need_len);
1721
1722#define fr_sbuff_adv_past_str_literal(_sbuff, _needle) fr_sbuff_adv_past_str(_sbuff, _needle, sizeof(_needle) - 1)
1723
1724size_t fr_sbuff_adv_past_strcase(fr_sbuff_t *sbuff, char const *needle, size_t need_len);
1725
1726#define fr_sbuff_adv_past_strcase_literal(_sbuff, _needle) fr_sbuff_adv_past_strcase(_sbuff, _needle, sizeof(_needle) - 1)
1727
1728size_t fr_sbuff_adv_past_allowed(fr_sbuff_t *sbuff, size_t len,
1729 bool const allowed[static SBUFF_CHAR_CLASS], fr_sbuff_term_t const *tt);
1730
1731#define fr_sbuff_adv_past_zeros(_sbuff, _len, _tt) fr_sbuff_adv_past_allowed(_sbuff, _len, sbuff_char_class_zero, _tt)
1732
1733#define fr_sbuff_adv_past_whitespace(_sbuff, _len, _tt) fr_sbuff_adv_past_allowed(_sbuff, _len, sbuff_char_whitespace, _tt)
1734
1735#define fr_sbuff_adv_past_blank(_sbuff, _len, _tt) fr_sbuff_adv_past_allowed(_sbuff, _len, sbuff_char_blank, _tt)
1736
1737size_t fr_sbuff_adv_until(fr_sbuff_t *sbuff, size_t len, fr_sbuff_term_t const *tt, char escape_chr);
1738
1739char *fr_sbuff_adv_to_chr_utf8(fr_sbuff_t *in, size_t len, char const *chr);
1740
1741char *fr_sbuff_adv_to_chr(fr_sbuff_t *in, size_t len, char c);
1742
1743char *fr_sbuff_adv_to_str(fr_sbuff_t *sbuff, size_t len, char const *needle, size_t needle_len);
1744
1745#define fr_sbuff_adv_to_str_literal(_sbuff, _len, _needle) fr_sbuff_adv_to_str(_sbuff, _len, _needle, sizeof(_needle) - 1)
1746
1747char *fr_sbuff_adv_to_strcase(fr_sbuff_t *sbuff, size_t len, char const *needle, size_t needle_len);
1748
1749#define fr_sbuff_adv_to_strcase_literal(_sbuff, _len, _needle) fr_sbuff_adv_to_strcase(_sbuff, _len, _needle, sizeof(_needle) - 1)
1750
1751bool fr_sbuff_next_if_char(fr_sbuff_t *sbuff, char c);
1752
1753bool fr_sbuff_next_unless_char(fr_sbuff_t *sbuff, char c);
1754
1755/** Advance the sbuff by one char
1756 *
1757 */
1758static inline char fr_sbuff_next(fr_sbuff_t *sbuff)
1759{
1760 if (!fr_sbuff_extend(sbuff)) return '\0';
1761 return fr_sbuff_advance(sbuff, 1);
1762}
1763/** @} */
1764
1765/** @name Remove chars from a buffer and re-terminate
1766 *
1767 * @{
1768 */
1769size_t fr_sbuff_trim(fr_sbuff_t *sbuff, bool const to_trim[static SBUFF_CHAR_CLASS]);
1770/** @} */
1771
1772/** @name Conditions
1773 *
1774 * These functions are typically used in recursive decent parsing for
1775 * look ahead.
1776 * @{
1777 */
1778bool fr_sbuff_is_terminal(fr_sbuff_t *in, fr_sbuff_term_t const *tt);
1779
1780static inline bool fr_sbuff_is_in_charset(fr_sbuff_t *sbuff, bool const chars[static SBUFF_CHAR_CLASS])
1781{
1782 if (!fr_sbuff_extend(sbuff)) return false;
1783 return chars[(uint8_t)*sbuff->p];
1784}
1785
1786static inline bool fr_sbuff_is_str(fr_sbuff_t *sbuff, char const *str, size_t len)
1787{
1788 if (len == SIZE_MAX) len = strlen(str);
1789 if (fr_sbuff_extend_lowat(NULL, sbuff, len) < len) return false;
1790 return memcmp(sbuff->p, str, len) == 0;
1791}
1792#define fr_sbuff_is_str_literal(_sbuff, _str) fr_sbuff_is_str(_sbuff, _str, sizeof(_str) - 1)
1793
1794#define fr_sbuff_eof(_x) (!fr_sbuff_extend(_x))
1795
1796static inline bool _fr_sbuff_is_char(fr_sbuff_t *sbuff, char *p, char c)
1797{
1798 if (!fr_sbuff_extend(sbuff)) return false;
1799 return *p == c;
1800}
1801static inline bool _fr_marker_is_char(fr_sbuff_marker_t *marker, char *p, char c)
1802{
1803 if (!fr_sbuff_extend(marker)) return false;
1804 return *p == c;
1805}
1806#define fr_sbuff_is_char(_sbuff_or_marker, _c) \
1807 _Generic((_sbuff_or_marker), \
1808 fr_sbuff_t * : _fr_sbuff_is_char((fr_sbuff_t *)(_sbuff_or_marker), fr_sbuff_current(_sbuff_or_marker), _c), \
1809 fr_sbuff_marker_t * : _fr_marker_is_char((fr_sbuff_marker_t *)(_sbuff_or_marker), fr_sbuff_current(_sbuff_or_marker), _c) \
1810 )
1811
1812#define SBUFF_IS_FUNC(_name, _test) \
1813 static inline bool _fr_sbuff_is_ ## _name(fr_sbuff_t *sbuff, char *p) \
1814 { \
1815 if (!fr_sbuff_extend(sbuff)) return false; \
1816 return _test; \
1817 }\
1818 static inline bool _fr_marker_is_ ## _name(fr_sbuff_marker_t *marker, char *p) \
1819 { \
1820 if (!fr_sbuff_extend(marker)) return false; \
1821 return _test; \
1822 }
1823
1824#define SBUFF_IS_GENERIC(_sbuff_or_marker, _name) \
1825 _Generic((_sbuff_or_marker), \
1826 fr_sbuff_t * : _fr_sbuff_is_ ## _name((fr_sbuff_t *)(_sbuff_or_marker), fr_sbuff_current(_sbuff_or_marker)), \
1827 fr_sbuff_marker_t * : _fr_marker_is_ ## _name((fr_sbuff_marker_t *)(_sbuff_or_marker), fr_sbuff_current(_sbuff_or_marker)) \
1828 )
1829
1830SBUFF_IS_FUNC(digit, isdigit((uint8_t) *p))
1831#define fr_sbuff_is_digit(_sbuff_or_marker) \
1832 SBUFF_IS_GENERIC(_sbuff_or_marker, digit)
1833
1834SBUFF_IS_FUNC(upper, isupper((uint8_t) *p))
1835#define fr_sbuff_is_upper(_sbuff_or_marker) \
1836 SBUFF_IS_GENERIC(_sbuff_or_marker, upper)
1837
1838SBUFF_IS_FUNC(lower, islower((uint8_t) *p))
1839#define fr_sbuff_is_lower(_sbuff_or_marker) \
1840 SBUFF_IS_GENERIC(_sbuff_or_marker, lower)
1841
1842SBUFF_IS_FUNC(alpha, isalpha((uint8_t) *p))
1843#define fr_sbuff_is_alpha(_sbuff_or_marker) \
1844 SBUFF_IS_GENERIC(_sbuff_or_marker, alpha)
1845
1846SBUFF_IS_FUNC(alnum, isalnum((uint8_t) *p))
1847#define fr_sbuff_is_alnum(_sbuff_or_marker) \
1848 SBUFF_IS_GENERIC(_sbuff_or_marker, alnum)
1849
1850SBUFF_IS_FUNC(space, isspace((uint8_t) *p))
1851#define fr_sbuff_is_space(_sbuff_or_marker) \
1852 SBUFF_IS_GENERIC(_sbuff_or_marker, space)
1853
1854SBUFF_IS_FUNC(hex, isxdigit((uint8_t) *p))
1855#define fr_sbuff_is_hex(_sbuff_or_marker) \
1856 SBUFF_IS_GENERIC(_sbuff_or_marker, hex)
1857
1858/** @} */
1859
1860void fr_sbuff_unescape_debug(FILE *fp, fr_sbuff_unescape_rules_t const *escapes);
1861
1862void fr_sbuff_terminal_debug(FILE *fp, fr_sbuff_term_t const *tt);
1863
1864void fr_sbuff_parse_rules_debug(FILE *fp, fr_sbuff_parse_rules_t const *p_rules);
1865
1866/*
1867 * ...printf("foo %.*s", fr_sbuff_as_percent_s(&sbuff));
1868 */
1869#define fr_sbuff_as_percent_s(_sbuff) (int) fr_sbuff_remaining(_sbuff), fr_sbuff_current(_sbuff)
1870
1871fr_slen_t fr_sbuff_array_concat(fr_sbuff_t *out, char const * const *array, char const *sep) CC_HINT(nonnull(1,2));
1872
1873
1874#ifdef __cplusplus
1875}
1876#endif
RCSIDH
#define RCSIDH(h, id)
Definition build.h:513
DIAG_OFF
#define DIAG_OFF(_x)
Definition build.h:486
err
static fr_slen_t err
Definition dict.h:882
escapes
static const bool escapes[SBUFF_CHAR_CLASS]
Definition util.c:40
ssize_t
long int ssize_t
Definition merged_model.c:24
fr_sbuff_parse_error_t
fr_sbuff_parse_error_t
Definition merged_model.c:45
FR_SBUFF_PARSE_ERROR_NUM_OVERFLOW
@ FR_SBUFF_PARSE_ERROR_NUM_OVERFLOW
Integer type would overflow.
Definition merged_model.c:52
FR_SBUFF_PARSE_ERROR_NUM_UNDERFLOW
@ FR_SBUFF_PARSE_ERROR_NUM_UNDERFLOW
Integer type would underflow.
Definition merged_model.c:53
FR_SBUFF_PARSE_ERROR_NOT_FOUND
@ FR_SBUFF_PARSE_ERROR_NOT_FOUND
String does not contain a token matching the output type.
Definition merged_model.c:47
FR_SBUFF_PARSE_ERROR_FORMAT
@ FR_SBUFF_PARSE_ERROR_FORMAT
Format of data was invalid.
Definition merged_model.c:50
FR_SBUFF_PARSE_OK
@ FR_SBUFF_PARSE_OK
No error.
Definition merged_model.c:46
FR_SBUFF_PARSE_ERROR_OUT_OF_SPACE
@ FR_SBUFF_PARSE_ERROR_OUT_OF_SPACE
No space available in output buffer.
Definition merged_model.c:51
FR_SBUFF_PARSE_ERROR_TRAILING
@ FR_SBUFF_PARSE_ERROR_TRAILING
Trailing characters found.
Definition merged_model.c:49
fr_sbuff_escape_rules_t
Definition merged_model.c:228
fr_sbuff_t
Definition merged_model.c:37
name
static char const * name
Definition rlm_redis_ippool_tool.c:156
sbuff_char_class_hex
bool const sbuff_char_class_hex[SBUFF_CHAR_CLASS]
Definition sbuff.c:98
sbuff_char_word
bool const sbuff_char_word[SBUFF_CHAR_CLASS]
Definition sbuff.c:100
sbuff_char_class_float
bool const sbuff_char_class_float[SBUFF_CHAR_CLASS]
Definition sbuff.c:74
sbuff_char_class_uint
bool const sbuff_char_class_uint[SBUFF_CHAR_CLASS]
Definition sbuff.c:64
sbuff_parse_error_table_len
size_t sbuff_parse_error_table_len
Definition sbuff.c:53
sbuff_char_class_hostname
bool const sbuff_char_class_hostname[SBUFF_CHAR_CLASS]
Definition sbuff.c:86
sbuff_char_blank
bool const sbuff_char_blank[SBUFF_CHAR_CLASS]
Definition sbuff.c:112
sbuff_char_class_int
bool const sbuff_char_class_int[SBUFF_CHAR_CLASS]
Definition sbuff.c:69
sbuff_char_whitespace
bool const sbuff_char_whitespace[SBUFF_CHAR_CLASS]
Definition sbuff.c:104
sbuff_char_line_endings
bool const sbuff_char_line_endings[SBUFF_CHAR_CLASS]
Definition sbuff.c:108
sbuff_char_alpha_num
bool const sbuff_char_alpha_num[SBUFF_CHAR_CLASS]
Definition sbuff.c:99
sbuff_char_class_zero
bool const sbuff_char_class_zero[SBUFF_CHAR_CLASS]
Definition sbuff.c:79
sbuff_parse_error_table
fr_table_num_ordered_t const sbuff_parse_error_table[]
Definition sbuff.c:43
fr_sbuff_uctx_talloc_t::ctx
TALLOC_CTX * ctx
Context to alloc new buffers in.
Definition sbuff.h:138
fr_sbuff_eof_t
bool(* fr_sbuff_eof_t)(fr_sbuff_t *sbuff)
For a given extension function, returns whether it is at EOF.
Definition sbuff.h:79
SBUFF_CHAR_CLASS
#define SBUFF_CHAR_CLASS
Definition sbuff.h:203
fr_sbuff_uctx_file_t::shifted
size_t shifted
How much we've read from this file.
Definition sbuff.h:152
fr_sbuff_s::shifted
size_t shifted
How many bytes this sbuff has been shifted since its creation.
Definition sbuff.h:116
fr_sbuff_s::extend
fr_sbuff_extend_t extend
Function to re-populate or extend the buffer.
Definition sbuff.h:119
fr_sbuff_s::is_const
unsigned int is_const
Can't be modified.
Definition sbuff.h:114
fr_sbuff_term_elem_t::str
char const * str
Terminal string.
Definition sbuff.h:160
fr_sbuff_s::uctx
void * uctx
Extend uctx data.
Definition sbuff.h:124
fr_sbuff_uctx_talloc_t::init
size_t init
How much to allocate initially.
Definition sbuff.h:139
fr_sbuff_unescape_rules_t::chr
char chr
Character at the start of an escape sequence.
Definition sbuff.h:211
fr_sbuff_unescape_rules_t::name
char const * name
Name for rule set to aid we debugging.
Definition sbuff.h:209
fr_sbuff_unescape_rules_t::do_oct
bool do_oct
Process oct sequences i.e.
Definition sbuff.h:223
fr_sbuff_s::m
fr_sbuff_marker_t * m
Pointers to update if the underlying buffer changes.
Definition sbuff.h:128
fr_sbuff_term_t::len
size_t len
Length of the list.
Definition sbuff.h:170
fr_sbuff_s::err
char const * err
Where the last error occurred.
Definition sbuff.h:112
fr_sbuff_unescape_rules_t::do_hex
bool do_hex
Process hex sequences i.e.
Definition sbuff.h:222
fr_sbuff_uctx_talloc_t::max
size_t max
Maximum size of the buffer.
Definition sbuff.h:140
fr_sbuff_term_elem_t::len
size_t len
Length of string.
Definition sbuff.h:161
fr_sbuff_uctx_file_t::buff_end
char * buff_end
The true end of the buffer.
Definition sbuff.h:150
fr_sbuff_s::parent
fr_sbuff_t * parent
sbuff this sbuff was copied from.
Definition sbuff.h:126
fr_sbuff_ptr_s::next
fr_sbuff_marker_t * next
Next m in the list.
Definition sbuff.h:87
fr_sbuff_uctx_file_t::eof
bool eof
are we at EOF?
Definition sbuff.h:153
fr_sbuff_term_t::elem
fr_sbuff_term_elem_t * elem
A sorted list of terminal strings.
Definition sbuff.h:171
fr_slen_t
ssize_t fr_slen_t
Represents number of bytes parsed or location of parse error.
Definition sbuff.h:48
fr_sbuff_ptr_s::parent
fr_sbuff_t * parent
Owner of the marker.
Definition sbuff.h:88
fr_sbuff_s::eof
fr_sbuff_eof_t eof
Function to determine if the buffer is at EOF.
Definition sbuff.h:122
fr_sbuff_extend_t
size_t(* fr_sbuff_extend_t)(fr_sbuff_extend_status_t *status, fr_sbuff_t *sbuff, size_t req_extension)
Extension callback.
Definition sbuff.h:74
fr_sbuff_s::adv_parent
unsigned int adv_parent
If true, advance the parent.
Definition sbuff.h:115
fr_sbuff_uctx_file_t::file
FILE * file
FILE * we're reading from.
Definition sbuff.h:149
fr_sbuff_uctx_file_t::max
size_t max
Maximum number of bytes to read.
Definition sbuff.h:151
fr_sbuff_extend_status_t
fr_sbuff_extend_status_t
Whether the buffer is currently extendable and whether it was extended.
Definition sbuff.h:62
FR_SBUFF_FLAG_EXTEND_ERROR
@ FR_SBUFF_FLAG_EXTEND_ERROR
The last call to an extend function resulted in an error.
Definition sbuff.h:64
FR_SBUFF_FLAG_EXTENDED
@ FR_SBUFF_FLAG_EXTENDED
The last call to extend function actually extended the buffer.
Definition sbuff.h:63
fr_sbuff_ptr_s
Definition sbuff.h:82
fr_sbuff_s
Definition sbuff.h:91
fr_sbuff_term_elem_t
Terminal element with pre-calculated lengths.
Definition sbuff.h:159
fr_sbuff_term_t
Set of terminal elements.
Definition merged_model.c:161
fr_sbuff_uctx_file_t
File sbuff extension structure.
Definition sbuff.h:148
fr_sbuff_uctx_talloc_t
Talloc sbuff extension structure.
Definition sbuff.h:137
fr_sbuff_unescape_rules_t
Set of parsing rules for *unescape_until functions.
Definition merged_model.c:163
buff
static char buff[sizeof("18446744073709551615")+3]
Definition size_tests.c:37
fr_table_str_by_value
#define fr_table_str_by_value(_table, _number, _def)
Convert an integer to a string.
Definition table.h:804
fr_table_num_ordered_t
An element in an arbitrarily ordered array of name to num mappings.
Definition table.h:57
fr_strerror_const
#define fr_strerror_const(_msg)
Definition strerror.h:223
Generated by   doxygen 1.9.8