The FreeRADIUS server $Id: f3670dba8951ca10eb4948feb3dc3db9423a334f $
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: 21fbc1ca3e35a38bb0408959186c6ff1d71c6abe $")
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/** Escape the contents of one sbuff into another
248 *
249 * @param[out] out Where to write the escaped value.
250 * @param[in] in Value to escape. Consumed on success.
251 * @return
252 * - >= 0 the number of bytes written to out.
253 * - -1 out did not have enough space for the escaped value. Neither sbuff is advanced.
254 */
255typedef fr_slen_t (*fr_sbuff_escape_func_t)(fr_sbuff_t *out, fr_sbuff_t *in);
256
257/** A set of terminal sequences, and escape rules
258 *
259 */
260typedef struct {
261 fr_sbuff_unescape_rules_t const *escapes; //!< Escape characters
262
263 fr_sbuff_term_t const *terminals; //!< Terminal characters used as a hint
264 ///< that a token is not complete.
265} fr_sbuff_parse_rules_t;
266
267/** Result of an sbuff copy, print or parse operation
268 *
269 * 0 is success. Every failure is negative, so `< 0` tests work, but
270 * callers should switch on the value so that a new member is caught
271 * by -Wswitch-enum.
272 *
273 * Also used by parsers built on the sbuff functions to report why a
274 * token could not be parsed.
275 */
276typedef enum {
277 FR_SBUFF_OK = 0, //!< Operation completed.
278
279 /*
280 * Destination side
281 */
282 FR_SBUFF_ERR_NO_SPACE = -1, //!< Destination sbuff filled and could not be extended.
283 ///< For copy out functions the partial copy is left in
284 ///< place and the length written.
285
286 /*
287 * Source side
288 */
289 FR_SBUFF_ERR_EXTEND = -2, //!< Source sbuff's extend callback reported an error
290 ///< (file read failure). Distinct from end of input.
291 FR_SBUFF_ERR_INPUT_EMPTY = -3, //!< No input bytes where a token was required.
292 FR_SBUFF_ERR_INPUT_SHORT = -4, //!< Input ended before the requested byte count was copied.
293
294 /*
295 * Token shape
296 */
297 FR_SBUFF_ERR_NOT_FOUND = -5, //!< Input does not start with a token of the requested type.
298 FR_SBUFF_ERR_TRAILING = -6, //!< Token parsed, but the next byte would continue it
299 ///< (no_trailing was set).
300 FR_SBUFF_ERR_FORMAT = -7, //!< Token has the right shape but invalid content.
301
302 /*
303 * Numeric range
304 */
305 FR_SBUFF_ERR_OVERFLOW = -8, //!< Numeric token above the output type's maximum.
306 FR_SBUFF_ERR_UNDERFLOW = -9, //!< Numeric token below the output type's minimum.
307
308 /*
309 * Caller error
310 */
311 FR_SBUFF_ERR_UNINITIALISED = -10, //!< sbuff has no buffer and no extend callback, so
312 ///< nothing can be read from it or written to it.
313 ///< Only builds that compile the sbuff checks in
314 ///< (debug builds, and static analysis) return this.
315} fr_sbuff_err_t;
316
317extern fr_table_num_ordered_t const sbuff_err_table[];
318extern size_t sbuff_err_table_len;
319
320/** Return the string representation of a result
321 */
322static inline char const *fr_sbuff_err_to_str(fr_sbuff_err_t result)
323{
324 return fr_table_str_by_value(sbuff_err_table, result, "<INVALID>");
325}
326
327/** Replace the contents of the thread local error stack with the string representation of a result
328 */
329static inline void fr_sbuff_err_to_strerror(fr_sbuff_err_t result)
330{
331 fr_strerror_const(fr_sbuff_err_to_str(result));
332}
333
334/** Return whether the sbuff is extendable
335 */
336static inline bool fr_sbuff_is_extendable(fr_sbuff_t *sbuff)
337{
338 return sbuff->extend && (!sbuff->eof || (sbuff->eof(sbuff) == false));
339}
340
341#define fr_sbuff_was_extended(_status) (_status & FR_SBUFF_FLAG_EXTENDED)
342
343extern bool const sbuff_char_class_uint[SBUFF_CHAR_CLASS];
344extern bool const sbuff_char_class_int[SBUFF_CHAR_CLASS];
345extern bool const sbuff_char_class_float[SBUFF_CHAR_CLASS];
346extern bool const sbuff_char_class_zero[SBUFF_CHAR_CLASS];
347extern bool const sbuff_char_class_hex[SBUFF_CHAR_CLASS];
348extern bool const sbuff_char_alpha_num[SBUFF_CHAR_CLASS];
349extern bool const sbuff_char_word[SBUFF_CHAR_CLASS];
350extern bool const sbuff_char_whitespace[SBUFF_CHAR_CLASS];
351extern bool const sbuff_char_line_endings[SBUFF_CHAR_CLASS];
352extern bool const sbuff_char_blank[SBUFF_CHAR_CLASS];
353extern bool const sbuff_char_class_hostname[SBUFF_CHAR_CLASS];
354
355/** Matches a-z,A-Z
356 */
357#define SBUFF_CHAR_CLASS_ALPHA \
358 ['a'] = true, ['b'] = true, ['c'] = true, ['d'] = true, ['e'] = true, \
359 ['f'] = true, ['g'] = true, ['h'] = true, ['i'] = true, ['j'] = true, \
360 ['k'] = true, ['l'] = true, ['m'] = true, ['n'] = true, ['o'] = true, \
361 ['p'] = true, ['q'] = true, ['r'] = true, ['s'] = true, ['t'] = true, \
362 ['u'] = true, ['v'] = true, ['w'] = true, ['x'] = true, ['y'] = true, \
363 ['z'] = true, \
364 ['A'] = true, ['B'] = true, ['C'] = true, ['D'] = true, ['E'] = true, \
365 ['F'] = true, ['G'] = true, ['H'] = true, ['I'] = true, ['J'] = true, \
366 ['K'] = true, ['L'] = true, ['M'] = true, ['N'] = true, ['O'] = true, \
367 ['P'] = true, ['Q'] = true, ['R'] = true, ['S'] = true, ['T'] = true, \
368 ['U'] = true, ['V'] = true, ['W'] = true, ['X'] = true, ['Y'] = true, \
369 ['Z'] = true
370
371/** Matches 0-9
372 */
373#define SBUFF_CHAR_CLASS_NUM \
374 ['0'] = true, ['1'] = true, ['2'] = true, ['3'] = true, ['4'] = true, \
375 ['5'] = true, ['6'] = true, ['7'] = true, ['8'] = true, ['9'] = true
376
377/** Matches 0-9,a-z,A-Z
378 */
379#define SBUFF_CHAR_CLASS_ALPHA_NUM \
380 SBUFF_CHAR_CLASS_ALPHA, \
381 SBUFF_CHAR_CLASS_NUM
382
383/** Matches 0-9,a-f,A-F
384 */
385#define SBUFF_CHAR_CLASS_HEX \
386 SBUFF_CHAR_CLASS_NUM, \
387 ['a'] = true, ['b'] = true, ['c'] = true, ['d'] = true, ['e'] = true, \
388 ['f'] = true, \
389 ['A'] = true, ['B'] = true, ['C'] = true, ['D'] = true, ['E'] = true, \
390 ['F'] = true
391
392#define SBUFF_CHAR_CLASS_SYMBOLS \
393 ['!'] = true, ['"'] = true, ['#'] = true, ['$'] = true, ['%'] = true, \
394 ['&'] = true, ['/'] = true, ['('] = true, [')'] = true, ['*'] = true, \
395 ['+'] = true, ['`'] = true, ['-'] = true, ['.'] = true, ['/'] = true, \
396 [':'] = true, [';'] = true, ['<'] = true, ['='] = true, ['>'] = true, \
397 ['?'] = true, ['@'] = true, ['['] = true, ['\''] = true, [']'] = true, \
398 ['^'] = true, ['_'] = true, ['`'] = true, ['{'] = true, ['|'] = true, \
399 ['}'] = true, ['~'] = true \
400
401/*
402 * If the additional tables need to be generated feel free to use this
403 * code snippet.
404 *
405 * @verbatim
406 #include <stdio.h>
407 #include <stdlib.h>
408
409 int main(int argc, char **argv)
410 {
411 int start, end, i;
412 start = atoi(argv[1]);
413 end = atoi(argv[2]);
414 for (i = start; i <= end; i++) {
415 printf("[0x%02x] = true, ", i);
416 if (!(i % 8)) printf("\\\n");
417 }
418 return 0;
419 }
420 * @endverbatim
421 */
422
423/** Unprintables (ascii range)
424 *
425 * We don't include characters in the extended range (128-255) as they're
426 * likely part of a multi-byte sequence and we don't want to break UTF8 strings.
427 */
428#define SBUFF_CHAR_UNPRINTABLES_LOW \
429 [0x00] = true, \
430 [0x01] = true, [0x02] = true, [0x03] = true, [0x04] = true, [0x05] = true, [0x06] = true, [0x07] = true, [0x08] = true, \
431 [0x09] = true, [0x0a] = true, [0x0b] = true, [0x0c] = true, [0x0d] = true, [0x0e] = true, [0x0f] = true, [0x10] = true, \
432 [0x11] = true, [0x12] = true, [0x13] = true, [0x14] = true, [0x15] = true, [0x16] = true, [0x17] = true, [0x18] = true, \
433 [0x19] = true, [0x1a] = true, [0x1b] = true, [0x1c] = true, [0x1d] = true, [0x1e] = true, [0x1f] = true, \
434 [0x7f] = true
435
436/** Unprintables (extended range)
437 *
438 * If these characters are being escaped, the function should also be passed
439 * the 'do_utf8' flag.
440 */
441#define SBUFF_CHAR_UNPRINTABLES_EXTENDED \
442 [0x80] = true, \
443 [0x81] = true, [0x82] = true, [0x83] = true, [0x84] = true, [0x85] = true, [0x86] = true, [0x87] = true, [0x88] = true, \
444 [0x89] = true, [0x8a] = true, [0x8b] = true, [0x8c] = true, [0x8d] = true, [0x8e] = true, [0x8f] = true, [0x90] = true, \
445 [0x91] = true, [0x92] = true, [0x93] = true, [0x94] = true, [0x95] = true, [0x96] = true, [0x97] = true, [0x98] = true, \
446 [0x99] = true, [0x9a] = true, [0x9b] = true, [0x9c] = true, [0x9d] = true, [0x9e] = true, [0x9f] = true, [0xa0] = true, \
447 [0xa1] = true, [0xa2] = true, [0xa3] = true, [0xa4] = true, [0xa5] = true, [0xa6] = true, [0xa7] = true, [0xa8] = true, \
448 [0xa9] = true, [0xaa] = true, [0xab] = true, [0xac] = true, [0xad] = true, [0xae] = true, [0xaf] = true, [0xb0] = true, \
449 [0xb1] = true, [0xb2] = true, [0xb3] = true, [0xb4] = true, [0xb5] = true, [0xb6] = true, [0xb7] = true, [0xb8] = true, \
450 [0xb9] = true, [0xba] = true, [0xbb] = true, [0xbc] = true, [0xbd] = true, [0xbe] = true, [0xbf] = true, [0xc0] = true, \
451 [0xc1] = true, [0xc2] = true, [0xc3] = true, [0xc4] = true, [0xc5] = true, [0xc6] = true, [0xc7] = true, [0xc8] = true, \
452 [0xc9] = true, [0xca] = true, [0xcb] = true, [0xcc] = true, [0xcd] = true, [0xce] = true, [0xcf] = true, [0xd0] = true, \
453 [0xd1] = true, [0xd2] = true, [0xd3] = true, [0xd4] = true, [0xd5] = true, [0xd6] = true, [0xd7] = true, [0xd8] = true, \
454 [0xd9] = true, [0xda] = true, [0xdb] = true, [0xdc] = true, [0xdd] = true, [0xde] = true, [0xdf] = true, [0xe0] = true, \
455 [0xe1] = true, [0xe2] = true, [0xe3] = true, [0xe4] = true, [0xe5] = true, [0xe6] = true, [0xe7] = true, [0xe8] = true, \
456 [0xe9] = true, [0xea] = true, [0xeb] = true, [0xec] = true, [0xed] = true, [0xee] = true, [0xef] = true, [0xf0] = true, \
457 [0xf1] = true, [0xf2] = true, [0xf3] = true, [0xf4] = true, [0xf5] = true, [0xf6] = true, [0xf7] = true, [0xf8] = true, \
458 [0xf9] = true, [0xfa] = true, [0xfb] = true, [0xfc] = true, [0xfd] = true, [0xfe] = true, [0xff] = true
459
460/** Generic wrapper macro to return if there's insufficient memory to satisfy the request on the sbuff
461 *
462 */
463#define FR_SBUFF_RETURN(_func, _sbuff, ...) \
464do { \
465 ssize_t _slen; \
466 _slen = _func(_sbuff, ## __VA_ARGS__ ); \
467 if (_slen < 0) return _slen; \
468} while (0)
469
470/** @name Ephemeral copying macros
471 * @{
472 */
473
474/** @cond */
475
476/** Copy another fr_sbuff_t, modifying it.
477 *
478 * @private
479 */
480#define _FR_SBUFF(_sbuff_or_marker, _start, _current, _end, _extend, _eof, _adv_parent) \
481((fr_sbuff_t){ \
482 .buff = fr_sbuff_buff(_sbuff_or_marker), \
483 .start = (_start), \
484 .end = (_end), \
485 .p = (_current), \
486 .is_const = fr_sbuff_ptr(_sbuff_or_marker)->is_const, \
487 .adv_parent = (_adv_parent), \
488 .shifted = 0, \
489 .extend = (_extend), \
490 .eof = (_eof), \
491 .uctx = fr_sbuff_ptr(_sbuff_or_marker)->uctx, \
492 .parent = fr_sbuff_ptr(_sbuff_or_marker) \
493})
494/* @endcond */
495
496/** Create a new sbuff pointing to the same underlying buffer
497 *
498 * - Parent will _NOT_ be advanced by operations on its child.
499 * - Child will have its `start` pointer set to the `p` pointer of the parent.
500 *
501 * @param[in] _sbuff_or_marker to make an ephemeral copy of.
502 */
503#define FR_SBUFF(_sbuff_or_marker) _FR_SBUFF(_sbuff_or_marker, \
504 fr_sbuff_current(_sbuff_or_marker), \
505 fr_sbuff_current(_sbuff_or_marker), \
506 fr_sbuff_end(_sbuff_or_marker), \
507 fr_sbuff_ptr(_sbuff_or_marker)->extend, \
508 fr_sbuff_ptr(_sbuff_or_marker)->eof, \
509 0x00)
510
511/** Create a new sbuff pointing to the same underlying buffer
512 *
513 * - Parent will _NOT_ be advanced by operations on its child.
514 * - Child will have its `start` pointer set to the `start` pointer of the parent.
515 *
516 * @param[in] _sbuff_or_marker to make an ephemeral copy of.
517 */
518#define FR_SBUFF_ABS(_sbuff_or_marker) _FR_SBUFF(_sbuff_or_marker, \
519 fr_sbuff_start(_sbuff_or_marker), \
520 fr_sbuff_current(_sbuff_or_marker), \
521 fr_sbuff_end(_sbuff_or_marker), \
522 fr_sbuff_ptr(_sbuff_or_marker)->extend, \
523 0x00)
524
525/** Create a new sbuff pointing to the same underlying buffer
526 *
527 * The intent of this sbuff type is to allow parsing operations to be performed
528 * on a subset of the buffer data.
529 *
530 * - Parent will _NOT_ be advanced by operations on its child.
531 * - Child will have its `start` pointer set to the `start` pointer of the parent.
532 * - Child will have its `end` pointer set to the `p` pointer of the parent.
533 * - Child will not extend parent.
534 *
535 * @param[in] _sbuff_or_marker to make an ephemeral copy of.
536 */
537#define FR_SBUFF_REPARSE(_sbuff_or_marker) _FR_SBUFF(_sbuff_or_marker, \
538 fr_sbuff_start(_sbuff_or_marker), \
539 fr_sbuff_start(_sbuff_or_marker), \
540 fr_sbuff_current(_sbuff_or_marker), \
541 NULL, \
542 NULL, \
543 0x00)
544
545/** Create a new sbuff pointing to the same underlying buffer
546 *
547 * - Parent `p` pointer will be advanced with child's `p` pointer.
548 * - Child will have its `start` pointer set to the `p` pointer of the parent.
549 *
550 * @param[in] _sbuff_or_marker to make an ephemeral copy of.
551 */
552#define FR_SBUFF_BIND_CURRENT(_sbuff_or_marker) _FR_SBUFF(_sbuff_or_marker, \
553 fr_sbuff_current(_sbuff_or_marker), \
554 fr_sbuff_current(_sbuff_or_marker), \
555 fr_sbuff_end(_sbuff_or_marker), \
556 fr_sbuff_ptr(_sbuff_or_marker)->extend, \
557 fr_sbuff_ptr(_sbuff_or_marker)->eof, \
558 0x01)
559
560/** Create a new sbuff pointing to the same underlying buffer
561 *
562 * - Parent `p` pointer will be advanced with child's `p` pointer.
563 * - Child will have its `start` pointer set to the `start` pointer of the parent.
564 *
565 * @param[in] _sbuff_or_marker to make an ephemeral copy of.
566 */
567#define FR_SBUFF_BIND_CURRENT_ABS(_sbuff_or_marker) FR_SBUFF_ABS(_sbuff_or_marker, \
568 fr_sbuff_start(_sbuff_or_marker), \
569 fr_sbuff_current(_sbuff_or_marker), \
570 fr_sbuff_end(_sbuff_or_marker), \
571 fr_sbuff_ptr(_sbuff_or_marker)->extend, \
572 fr_sbuff_ptr(_sbuff_or_marker)->eof, \
573 0x01)
574
575/** Creates an empty sbuff which can then be used as a destination for printing
576 *
577 * @note The return value of the function should be used to determine how much
578 * data was written to the buffer.
579 *
580 * @param[in] _start of the buffer.
581 * @param[in] _len_or_end Length of the buffer or the end pointer.
582 */
583#define FR_SBUFF_OUT(_start, _len_or_end) \
584((fr_sbuff_t){ \
585 .buff_i = _start, \
586 .start_i = _Generic((_start), \
587 char * : _start, \
588 uint8_t * : _start \
589 ), \
590 .end_i = _Generic((_len_or_end), \
591 size_t : (char const *)(_start) + ((size_t)(_len_or_end) - 1), \
592 long : (char const *)(_start) + ((size_t)(_len_or_end) - 1), \
593 int : (char const *)(_start) + ((size_t)(_len_or_end) - 1), \
594 unsigned int : (char const *)(_start) + ((size_t)(_len_or_end) - 1), \
595 char * : (char const *)(_len_or_end), \
596 char const * : (char const *)(_len_or_end) \
597 ), \
598 .p_i = _start, \
599 .is_const = false, \
600})
601
602/** Creates an sbuff from existing data, so the caller can read from it.
603 *
604 * @note The return value of the function should be used to determine how much
605 * data was written to the buffer.
606 *
607 * @param[in] _start of the buffer.
608 * @param[in] _len_or_end Length of the buffer or the end pointer.
609 */
610#define FR_SBUFF_IN(_start, _len_or_end) \
611((fr_sbuff_t){ \
612 .buff_i = _start, \
613 .start_i = _Generic((_start), \
614 char * : _start, \
615 char const * : _start, \
616 uint8_t * : _start, \
617 uint8_t const * : _start \
618 ), \
619 .end_i = _Generic((_len_or_end), \
620 size_t : (char const *)(_start) + (size_t)(_len_or_end), \
621 long : (char const *)(_start) + (size_t)(_len_or_end), \
622 int : (char const *)(_start) + (size_t)(_len_or_end), \
623 unsigned int : (char const *)(_start) + (size_t)(_len_or_end), \
624 char * : (char const *)(_len_or_end), \
625 char const * : (char const *)(_len_or_end) \
626 ), \
627 .p_i = _start, \
628 .is_const = true, \
629})
630
631#define FR_SBUFF_IN_STR(_start) FR_SBUFF_IN(_start, strlen(_start))
632
633/** Structure to encapsulate a thread local sbuff information
634 *
635 */
636typedef struct {
637 fr_sbuff_t sbuff; //!< Thread local sbuff.
638 fr_sbuff_uctx_talloc_t tctx; //!< Thread local tctx.
639} fr_sbuff_thread_local_t;
640
641static inline int _sbuff_thread_local_free(void *sbtl)
642{
643 return talloc_free(sbtl);
644}
645
646/** Create a function local and thread local extensible sbuff
647 *
648 * @param[out] _sbuff_out Where to write a pointer to the thread local sbuff
649 * @param[in] _init Initial size for the sbuff buffer.
650 * @param[in] _max Maximum size of the sbuff buffer.
651 */
652#define FR_SBUFF_TALLOC_THREAD_LOCAL(_out, _init, _max) \
653do { \
654 static _Thread_local fr_sbuff_thread_local_t *_sbuff_t_local; \
655 if (!_sbuff_t_local) { \
656 fr_sbuff_thread_local_t *sbtl = talloc_zero(NULL, fr_sbuff_thread_local_t); \
657 fr_sbuff_init_talloc(sbtl, &sbtl->sbuff, &sbtl->tctx, _init, _max); \
658 fr_atexit_thread_local(_sbuff_t_local, _sbuff_thread_local_free, sbtl); \
659 *(_out) = &_sbuff_t_local->sbuff; \
660 } else { \
661 fr_sbuff_reset_talloc(&_sbuff_t_local->sbuff); \
662 *(_out) = &_sbuff_t_local->sbuff; \
663 } \
664} while (0)
665
666void fr_sbuff_update(fr_sbuff_t *sbuff, char *new_buff, size_t new_len);
667
668size_t fr_sbuff_shift(fr_sbuff_t *sbuff, size_t shift, bool move_end);
669
670size_t fr_sbuff_extend_file(fr_sbuff_extend_status_t *status, fr_sbuff_t *sbuff, size_t extension);
671
672bool fr_sbuff_eof_file(fr_sbuff_t *sbuff);
673
674size_t fr_sbuff_extend_talloc(fr_sbuff_extend_status_t *status, fr_sbuff_t *sbuff, size_t extension);
675
676int fr_sbuff_trim_talloc(fr_sbuff_t *sbuff, size_t len);
677
678int fr_sbuff_reset_talloc(fr_sbuff_t *sbuff);
679
680static inline void fr_sbuff_terminate(fr_sbuff_t *sbuff)
681{
682 *sbuff->p = '\0';
683}
684
685static inline void _fr_sbuff_init(fr_sbuff_t *out, char const *start, char const *end, bool is_const)
686{
687 if (unlikely(end < start)) end = start; /* Could be an assert? */
688
689 *out = (fr_sbuff_t){
690 .buff_i = start,
691 .start_i = start,
692 .p_i = start,
693 .end_i = end,
694 .is_const = is_const
695 };
696}
697
698/*
699 * GCC is stupid and will warn about output variables
700 * being unnitialised, even if they're not dereferenced.
701 */
702#if defined(__GNUC__) && __GNUC__ >= 11
703DIAG_OFF(maybe-uninitialized)
704#endif
705
706/** Initialise an sbuff around a stack allocated buffer for printing
707 *
708 * Will \0 terminate the output buffer.
709 *
710 * @param[out] _out Pointer to buffer.
711 * @param[in] _start Start of the buffer. Cannot be const.
712 * @param[in] _len_or_end Either an end pointer or the length
713 * of the buffer. 'end' can be const.
714 */
715#define fr_sbuff_init_out(_out, _start, _len_or_end) \
716do { \
717 *(_start) = '\0'; \
718 _fr_sbuff_init(_out, _start, \
719 _Generic((_len_or_end), \
720 size_t : (char const *)(_start) + ((size_t)(_len_or_end) - 1), \
721 long : (char const *)(_start) + ((size_t)(_len_or_end) - 1), \
722 int : (char const *)(_start) + ((size_t)(_len_or_end) - 1), \
723 char * : (char const *)(_len_or_end), \
724 char const * : (char const *)(_len_or_end) \
725 ), \
726 false); \
727} while (0)
728
729#if defined(__GNUC__) && __GNUC__ >= 11
730DIAG_ON(maybe-uninitialized)
731#endif
732
733/** Initialise an sbuff around a stack allocated buffer for parsing
734 *
735 * @param[out] _out Pointer to buffer.
736 * @param[in] _start Start of the buffer.
737 * @param[in] _len_or_end Either an end pointer or the length
738 * of the buffer.
739 */
740#define fr_sbuff_init_in(_out, _start, _len_or_end) \
741_fr_sbuff_init(_out, _start, \
742_Generic((_len_or_end), \
743 size_t : (char const *)(_start) + (size_t)(_len_or_end), \
744 long : (char const *)(_start) + (size_t)(_len_or_end), \
745 int : (char const *)(_start) + (size_t)(_len_or_end), \
746 char * : (char const *)(_len_or_end), \
747 char const * : (char const *)(_len_or_end) \
748), \
749IS_CONST(char *, _start))
750
751/** Initialise a special sbuff which automatically reads in more data as the buffer is exhausted
752 *
753 * @param[out] sbuff to initialise.
754 * @param[out] fctx to initialise. Must have a lifetime >= to the sbuff.
755 * @param[in] buff Temporary buffer to use for storing file contents.
756 * @param[in] len Length of the temporary buffer.
757 * @param[in] file to read from.
758 * @param[in] max The maximum length of data to read from the file.
759 * @return
760 * - The passed sbuff on success.
761 * - NULL on failure.
762 */
763static inline fr_sbuff_t *fr_sbuff_init_file(fr_sbuff_t *sbuff, fr_sbuff_uctx_file_t *fctx,
764 char *buff, size_t len, FILE *file, size_t max)
765{
766 *fctx = (fr_sbuff_uctx_file_t){
767 .file = file,
768 .max = max,
769 .buff_end = buff + len //!< Store the real end
770 };
771
772 *sbuff = (fr_sbuff_t){
773 .buff = buff,
774 .start = buff,
775 .p = buff,
776 .end = buff, //!< Starts with 0 bytes available
777 .extend = fr_sbuff_extend_file,
778 .eof = fr_sbuff_eof_file,
779 .uctx = fctx
780 };
781
782 return sbuff;
783}
784
785/** Initialise a special sbuff which automatically extends as additional data is written
786 *
787 * @param[in] ctx to allocate buffer in.
788 * @param[out] sbuff to initialise.
789 * @param[out] tctx to initialise. Must have a lifetime >= to the sbuff.
790 * @param[in] init The length of the initial buffer, excluding \0 byte.
791 * @param[in] max The maximum length of the buffer.
792 * @return
793 * - The passed sbuff on success.
794 * - NULL on failure.
795 */
796static inline fr_sbuff_t *fr_sbuff_init_talloc(TALLOC_CTX *ctx,
797 fr_sbuff_t *sbuff, fr_sbuff_uctx_talloc_t *tctx,
798 size_t init, size_t max)
799{
800 char *buff;
801
802 *tctx = (fr_sbuff_uctx_talloc_t){
803 .ctx = ctx,
804 .init = init,
805 .max = max
806 };
807
808 /*
809 * Allocate the initial buffer
810 *
811 * We always allocate a buffer so we don't
812 * trigger ubsan errors by performing
813 * arithmetic on NULL pointers.
814 */
815 buff = talloc_zero_array(ctx, char, init + 1);
816 if (!buff) {
817 fr_strerror_printf("Failed allocating buffer of %zu bytes", init + 1);
818 memset(sbuff, 0, sizeof(*sbuff)); /* clang scan */
819 return NULL;
820 }
821
822 *sbuff = (fr_sbuff_t){
823 .buff = buff,
824 .start = buff,
825 .p = buff,
826 .end = buff + init,
827 .extend = fr_sbuff_extend_talloc,
828 .uctx = tctx
829 };
830
831 return sbuff;
832}
833/** @} */
834
835/** @name Accessors
836 *
837 * Caching the values of these pointers or the pointer values from the sbuff
838 * directly is strongly discouraged as they can become invalidated during
839 * stream parsing or when printing to an auto-expanding buffer.
840 *
841 * These functions should only be used to pass sbuff pointers into 3rd party
842 * APIs.
843 *
844 * @{
845 */
846
847/** Return a pointer to the sbuff
848 *
849 * @param[in] _sbuff_or_marker to return a pointer to.
850 * @return A pointer to the sbuff.
851 */
852#define fr_sbuff_ptr(_sbuff_or_marker) \
853 _Generic((_sbuff_or_marker), \
854 fr_sbuff_t * : ((fr_sbuff_t *)(_sbuff_or_marker)), \
855 fr_sbuff_marker_t * : ((fr_sbuff_marker_t *)(_sbuff_or_marker))->parent \
856 )
857
858/** Return a pointer to the start of the underlying buffer in an sbuff or one of its markers
859 *
860 * @param[in] _sbuff_or_marker to return the buffer for.
861 * @return A pointer to the start of the buffer.
862 */
863#define fr_sbuff_buff(_sbuff_or_marker) \
864 _Generic((_sbuff_or_marker), \
865 fr_sbuff_t * : ((fr_sbuff_t const *)(_sbuff_or_marker))->buff, \
866 fr_sbuff_t const * : ((fr_sbuff_t const *)(_sbuff_or_marker))->buff, \
867 fr_sbuff_marker_t * : ((fr_sbuff_marker_t const *)(_sbuff_or_marker))->parent->buff, \
868 fr_sbuff_marker_t const * : ((fr_sbuff_marker_t const *)(_sbuff_or_marker))->parent->buff \
869 )
870
871/** Return a pointer to the 'start' position of an sbuff or one of its markers
872 *
873 * The start position is not necessarily the start of the buffer, and is
874 * advanced every time an sbuff is copied.
875 *
876 * @param[in] _sbuff_or_marker to return the start position of.
877 * @return A pointer to the start position of the buffer.
878 */
879#define fr_sbuff_start(_sbuff_or_marker) \
880 (_Generic((_sbuff_or_marker), \
881 fr_sbuff_t * : ((fr_sbuff_t const *)(_sbuff_or_marker))->start, \
882 fr_sbuff_t const * : ((fr_sbuff_t const *)(_sbuff_or_marker))->start, \
883 fr_sbuff_marker_t * : ((fr_sbuff_marker_t const *)(_sbuff_or_marker))->parent->start, \
884 fr_sbuff_marker_t const * : ((fr_sbuff_marker_t const *)(_sbuff_or_marker))->parent->start \
885 ))
886
887/** Return a pointer to the 'current' position of an sbuff or one of its markers
888 *
889 * @note Should not be derferenced as it may point past the end of the buffer.
890 * Use #fr_sbuff_char to get the current char.
891 *
892 * @param[in] _sbuff_or_marker to return the current position of.
893 * @return A pointer to the current position of the buffer or marker.
894 */
895#define fr_sbuff_current(_sbuff_or_marker) \
896 (_Generic((_sbuff_or_marker), \
897 fr_sbuff_t * : ((fr_sbuff_t const *)(_sbuff_or_marker))->p, \
898 fr_sbuff_t const * : ((fr_sbuff_t const *)(_sbuff_or_marker))->p, \
899 fr_sbuff_marker_t * : ((fr_sbuff_marker_t const *)(_sbuff_or_marker))->p, \
900 fr_sbuff_marker_t const * : ((fr_sbuff_marker_t const *)(_sbuff_or_marker))->p \
901 ))
902
903/** Return a pointer to the 'end' position of an sbuff or one of its markers
904 *
905 * @param[in] _sbuff_or_marker to return the end position of.
906< * @return A pointer to the end position of the buffer or marker.
907 */
908#define fr_sbuff_end(_sbuff_or_marker) \
909 (_Generic((_sbuff_or_marker), \
910 fr_sbuff_t * : ((fr_sbuff_t const *)(_sbuff_or_marker))->end, \
911 fr_sbuff_t const * : ((fr_sbuff_t const *)(_sbuff_or_marker))->end, \
912 fr_sbuff_marker_t * : ((fr_sbuff_marker_t const *)(_sbuff_or_marker))->parent->end, \
913 fr_sbuff_marker_t const * : ((fr_sbuff_marker_t const *)(_sbuff_or_marker))->parent->end \
914 ))
915
916/** Return the value of the shifted field
917 *
918 * @param[in] _sbuff_or_marker to return the position of.
919 * @return the number of bytes the buffer has been shifted.
920 */
921#define fr_sbuff_shifted(_sbuff_or_marker) \
922 (_Generic((_sbuff_or_marker), \
923 fr_sbuff_t * : ((fr_sbuff_t const *)(_sbuff_or_marker))->shifted, \
924 fr_sbuff_t const * : ((fr_sbuff_t const *)(_sbuff_or_marker))->shifted, \
925 fr_sbuff_marker_t * : ((fr_sbuff_marker_t const *)(_sbuff_or_marker))->parent->shifted, \
926 fr_sbuff_marker_t const * : ((fr_sbuff_marker_t const *)(_sbuff_or_marker))->parent->shifted \
927 ))
928
929/** Return the current char pointed to by the sbuff or '\0' if no more chars remain
930 *
931 * @note Should be used in place of #fr_sbuff_current if switching over the current char.
932 *
933 * @param[in] _sbuff_or_marker to return the current char from.
934 * @param[in] _eob char used to indicate End of Buffer, usually '\0'.
935 * @return The current char pointed to be the sbuff.
936 */
937#define fr_sbuff_char(_sbuff_or_marker, _eob) \
938 (fr_sbuff_current(_sbuff_or_marker) >= fr_sbuff_end(_sbuff_or_marker) ? _eob : *fr_sbuff_current(_sbuff_or_marker))
939
940/** Return the current char as a uint8_t, pointed to by the sbuff or '\0' if no more chars remain
941 *
942 * @note Should be used in place of #fr_sbuff_char when using the char as an index to an array
943 *
944 * @param[in] _sbuff_or_marker to return the current char from.
945 * @param[in] _eob char used to indicate End of Buffer, usually '\0'.
946 * @return The current char pointed to be the sbuff.
947 */
948#define fr_sbuff_uint8(_sbuff_or_marker, _eob) ((uint8_t) fr_sbuff_char(_sbuff_or_marker, _eob))
949
950/** Start a switch block over the current sbuff char
951 *
952 * @note '\0' is used to indicate EOB.
953 *
954 * @param[in] _sbuff_or_marker to return the current char from.
955 * @param[in] _eob char used to indicate End of Buffer, usually '\0'.
956 */
957#define fr_sbuff_switch(_sbuff_or_marker, _eob) \
958 switch (fr_sbuff_char(_sbuff_or_marker, _eob))
959/** @} */
960
961/** @name Length calculations
962 * @{
963 */
964
965/** Return the difference in position between the two sbuffs or markers
966 *
967 * @param[in] _a The first sbuff or marker.
968 * @param[in] _b The second sbuff or marker.
969 * @return
970 * - >0 the number of bytes _a is ahead of _b.
971 * - 0 _a and _b are the same position.
972 * - <0 the number of bytes _a is behind of _b.
973 */
974#define fr_sbuff_diff(_a, _b) \
975 ((ssize_t)(fr_sbuff_current(_a) - fr_sbuff_current(_b)))
976
977/** Return the number of bytes remaining between the sbuff or marker and the end of the buffer
978 *
979 * @note Do not use this in functions that may be used for stream parsing
980 * unless you're sure you know what you're doing.
981 * The value return does not reflect the number of bytes that may
982 * be potentially read from the stream, only the number of bytes
983 * until the end of the current chunk.
984 *
985 * @param[in] _sbuff_or_marker to return the number of bytes remaining for.
986 * @return
987 * - >0 the number of bytes remaining before we reach the end of the buffer.
988 * - -0 we're at the end of the buffer.
989 */
990#define fr_sbuff_remaining(_sbuff_or_marker) \
991 ((size_t)(fr_sbuff_end(_sbuff_or_marker) < fr_sbuff_current(_sbuff_or_marker) ? \
992 0 : (fr_sbuff_end(_sbuff_or_marker) - fr_sbuff_current(_sbuff_or_marker))))
993
994/** Return the number of bytes remaining between the start of the sbuff or marker and the current position
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 * - -0 the current position is at the start of the buffer.
1000 */
1001#define fr_sbuff_used(_sbuff_or_marker) \
1002 ((size_t)(fr_sbuff_start(_sbuff_or_marker) > fr_sbuff_current(_sbuff_or_marker) ? \
1003 0 : (fr_sbuff_current(_sbuff_or_marker) - fr_sbuff_start(_sbuff_or_marker))))
1004
1005/** Sets an error marker in the parent
1006 *
1007 * If an error already exists at this level it will be used instead of the provided error.
1008 *
1009 * @param[in] sbuff who's parent we'll set the error marker in.
1010 * @param[in] err marker to set.
1011 * @return <0 the negative offset of the error.
1012 */
1013static inline fr_slen_t _fr_sbuff_error(fr_sbuff_t *sbuff, char const *err)
1014{
1015 fr_sbuff_t *parent = sbuff->parent;
1016 fr_slen_t slen;
1017
1018 if (sbuff->err) err = sbuff->err;
1019 if (parent) parent->err = err;
1020
1021 slen = -((err - fr_sbuff_start(sbuff)) + 1);
1022
1023#if defined(__clang_analyzer__) || defined (__COVERITY__)
1024 /*
1025 * Convince clang that the return value
1026 * is always negative. It never can be
1027 * else the sbuff code is very broken.
1028 */
1029 if (slen >= 0) return -1;
1030#endif
1031
1032 return slen;
1033}
1034
1035/** Return the current position as an error marker
1036 *
1037 * @param[in] _sbuff_or_marker Error marker will be set from the current position of this sbuff.
1038 *
1039 * +1 is added to the position to disambiguate with 0 meaning "parsed no data".
1040 *
1041 * An error at offset 0 will be returned as -1.
1042 */
1043#define fr_sbuff_error(_sbuff_or_marker) \
1044 _fr_sbuff_error(fr_sbuff_ptr(_sbuff_or_marker), fr_sbuff_current(_sbuff_or_marker))
1045
1046/** Like fr_sbuff_used, but adjusts for the value returned for the amount shifted
1047 *
1048 * @param[in] _sbuff_or_marker to return the number of bytes used for.
1049 * @return
1050 * - >0 the number of bytes the current position has advanced past the start +
1051 * the amount the buffer has shifted.
1052 * - -0 the current position is at the start of the buffer (and hasn't been shifted).
1053 */
1054#define fr_sbuff_used_total(_sbuff_or_marker) \
1055 ((size_t)((fr_sbuff_current(_sbuff_or_marker) + fr_sbuff_shifted(_sbuff_or_marker)) - fr_sbuff_start(_sbuff_or_marker)))
1056
1057/** The length of the underlying buffer
1058 *
1059 * @param[in] _sbuff_or_marker to return the length of.
1060 * @return The length of the underlying buffer (minus 1 byte for \0).
1061 */
1062#define fr_sbuff_len(_sbuff_or_marker) \
1063 ((size_t)(fr_sbuff_end(_sbuff_or_marker) - fr_sbuff_buff(_sbuff_or_marker)))
1064
1065/** How many bytes the sbuff or marker is behind its parent
1066 *
1067 * @param[in] _sbuff_or_marker
1068 * @return
1069 * - 0 the sbuff or marker is ahead of its parent.
1070 * - >0 the number of bytes the marker is behind its parent.
1071 */
1072#define fr_sbuff_behind(_sbuff_or_marker) \
1073 (fr_sbuff_current(_sbuff_or_marker) > fr_sbuff_current((_sbuff_or_marker)->parent) ? \
1074 0 : fr_sbuff_current((_sbuff_or_marker)->parent) - fr_sbuff_current(_sbuff_or_marker))
1075
1076/** How many bytes the sbuff or marker is ahead of its parent
1077 *
1078 * @return
1079 * - 0 the sbuff or marker is behind its parent.
1080 * - >0 the number of bytes the marker is ahead of its parent.
1081 */
1082#define fr_sbuff_ahead(_sbuff_or_marker) \
1083 (fr_sbuff_current((_sbuff_or_marker)->parent) > fr_sbuff_current(_sbuff_or_marker) ? \
1084 0 : fr_sbuff_current(_sbuff_or_marker) - fr_sbuff_current((_sbuff_or_marker)->parent))
1085
1086/** Return the current position in the sbuff as a negative offset
1087 *
1088 */
1089#define FR_SBUFF_ERROR_RETURN(_sbuff_or_marker) return fr_sbuff_error(_sbuff_or_marker)
1090
1091/** Check if _len bytes are available in the sbuff, and if not return -1
1092 *
1093 */
1094#define FR_SBUFF_CHECK_REMAINING_RETURN(_sbuff, _len) \
1095 if ((_len) > fr_sbuff_remaining(_sbuff)) return -1
1096
1097static inline size_t _fr_sbuff_extend_lowat(fr_sbuff_extend_status_t *status, fr_sbuff_t *in, size_t remaining, size_t lowat)
1098{
1099 size_t extended;
1100 fr_sbuff_extend_status_t our_status = 0;
1101
1102 if (!fr_sbuff_is_extendable(in)) {
1103 no_extend:
1104 if (status) *status = our_status;
1105 return remaining;
1106 }
1107
1108 /* Still have data remaining, no need to try and extend */
1109 if (remaining >= lowat) goto no_extend;
1110
1111 if (!in->extend || ((extended = in->extend(&our_status, in, lowat - remaining)) == 0)) {
1112 goto no_extend;
1113 }
1114
1115 our_status |= FR_SBUFF_FLAG_EXTENDED;
1116
1117 if (status) *status = our_status;
1118 return remaining + extended;
1119}
1120
1121/** Extend a buffer if we're below the low water mark
1122 *
1123 * @param[out] _status Should be initialised to FR_SBUFF_EXTENDABLE
1124 * for the first call to this function if used
1125 * as a loop condition.
1126 * Will be filled with the result of the previous
1127 * call, and can be used to determine if the buffer
1128 * was extended.
1129 * @param[in] _sbuff_or_marker to extend.
1130 * @param[in] _lowat If bytes remaining are below the amount, extend.
1131 * @return
1132 * - 0 if there are no bytes left in the buffer and we couldn't extend.
1133 * - >0 the number of bytes in the buffer after extending.
1134 */
1135#define fr_sbuff_extend_lowat(_status, _sbuff_or_marker, _lowat) \
1136 _fr_sbuff_extend_lowat(_status, \
1137 fr_sbuff_ptr(_sbuff_or_marker), \
1138 fr_sbuff_remaining(_sbuff_or_marker), _lowat)
1139
1140/** Check if _len bytes are available in the sbuff and extend the buffer if possible
1141 *
1142 * If we do not have _len bytes in the sbuff after extending, then return.
1143 *
1144 * @param[in] _sbuff to extend.
1145 * @param[in] _len The minimum amount the sbuff should be extended by.
1146 * @return -1 if _len bytes are not available in the sbuff after attempting to extend it.
1147 */
1148#define FR_SBUFF_EXTEND_LOWAT_OR_RETURN(_sbuff, _len) \
1149do { \
1150 size_t _remaining = fr_sbuff_extend_lowat(NULL, _sbuff, _len); \
1151 if (_remaining < _len) return -1; \
1152} while (0)
1153
1154/** Extend a buffer if no space remains
1155 *
1156 * @param[in] _sbuff_or_marker to extend.
1157 * @return
1158 * - 0 if there are no bytes left in the buffer and we couldn't extend.
1159 * - >0 the number of bytes in the buffer after extending.
1160 */
1161#define fr_sbuff_extend(_sbuff_or_marker) fr_sbuff_extend_lowat(NULL, _sbuff_or_marker, 1)
1162
1163/** @} */
1164
1165/** @name Position modification (recursive)
1166 *
1167 * Change the current position of pointers in the sbuff and their children.
1168 * @{
1169 */
1170
1171/** Update the position of p in a list of sbuffs
1172 *
1173 * @note Do not call directly.
1174 */
1175static inline void _fr_sbuff_set_recurse(fr_sbuff_t *sbuff, char const *p)
1176{
1177 sbuff->p_i = p;
1178 sbuff->err = NULL; /* Modifying the position of the sbuff clears the error */
1179
1180 if (sbuff->adv_parent && sbuff->parent) _fr_sbuff_set_recurse(sbuff->parent, p);
1181}
1182
1183static inline ssize_t _fr_sbuff_marker_set(fr_sbuff_marker_t *m, char const *p)
1184{
1185 fr_sbuff_t *sbuff = m->parent;
1186 char *current = m->p;
1187
1188 if (unlikely(p > sbuff->end)) return -1;
1189 if (unlikely(p < sbuff->start)) return 0;
1190
1191 sbuff->err = NULL; /* Modifying the position of any markers clears the error, unsure if this is correct? */
1192 m->p_i = p;
1193
1194 return p - current;
1195}
1196
1197static inline ssize_t _fr_sbuff_set(fr_sbuff_t *sbuff, char const *p)
1198{
1199 char const *c;
1200
1201 if (unlikely(p > sbuff->end)) return -1;
1202 if (unlikely(p < sbuff->start)) return 0;
1203
1204 c = sbuff->p;
1205 _fr_sbuff_set_recurse(sbuff, p);
1206
1207 return p - c;
1208}
1209
1210/** Set the position in a sbuff using another sbuff, a char pointer, or a length
1211 *
1212 * @param[in] _dst sbuff or marker to set the position for.
1213 * @param[in] _src Variable to glean new position from. Behaviour here
1214 * depends on the type of the variable.
1215 * - sbuff, the current position of the sbuff.
1216 * - marker, the current position of the marker.
1217 * - pointer, the position of the pointer.
1218 * - size_t, _dst->start + _src.
1219 * @return
1220 * - 0 not advanced.
1221 * - >0 the number of bytes the sbuff was advanced by.
1222 * - <0 the number of bytes the sbuff was moved backwards by, or -1 if
1223 * the new position is past the end of the buffer.
1224 */
1225#define fr_sbuff_set(_dst, _src) \
1226_Generic((_dst), \
1227 fr_sbuff_t * : _fr_sbuff_set, \
1228 fr_sbuff_marker_t * : _fr_sbuff_marker_set \
1229)(_dst, \
1230_Generic((_src), \
1231 fr_sbuff_t * : fr_sbuff_current((fr_sbuff_t const *)(_src)), \
1232 fr_sbuff_t const * : fr_sbuff_current((fr_sbuff_t const *)(_src)), \
1233 fr_sbuff_marker_t * : fr_sbuff_current((fr_sbuff_marker_t const *)(_src)), \
1234 fr_sbuff_marker_t const * : fr_sbuff_current((fr_sbuff_marker_t const *)(_src)), \
1235 char const * : (char const *)(_src), \
1236 char * : (char const *)(_src), \
1237 size_t : (fr_sbuff_start(_dst) + (uintptr_t)(_src)) \
1238))
1239
1240/** Set an sbuff to a given position, and return how much it was advanced
1241 *
1242 * @param[in] _dst to modify.
1243 * @param[in] _src position to set it too.
1244 * @return The number of bytes _dst was advanced.
1245 */
1246#define FR_SBUFF_SET_RETURN(_dst, _src) return fr_sbuff_set(_dst, _src)
1247
1248/** Advance position in sbuff by N bytes
1249 *
1250 * @param[in] _sbuff_or_marker to advance.
1251 * @param[in] _len How much to advance sbuff by.
1252 * @return
1253 * - 0 not advanced.
1254 * - >0 the number of bytes the sbuff was advanced by.
1255 * - <0 the number of bytes the sbuff was moved backwards by, or -1 if
1256 * the new position is past the end of the buffer.
1257 */
1258#define fr_sbuff_advance(_sbuff_or_marker, _len) fr_sbuff_set(_sbuff_or_marker, (fr_sbuff_current(_sbuff_or_marker) + (_len)))
1259#define FR_SBUFF_ADVANCE_RETURN(_sbuff, _len) FR_SBUFF_RETURN(fr_sbuff_advance, _sbuff, _len)
1260
1261/** Reset the current position of the sbuff to the start of the string
1262 *
1263 */
1264static inline void fr_sbuff_set_to_start(fr_sbuff_t *sbuff)
1265{
1266 _fr_sbuff_set_recurse(sbuff, sbuff->start);
1267}
1268
1269/** Reset the current position of the sbuff to the end of the string
1270 *
1271 */
1272static inline void fr_sbuff_set_to_end(fr_sbuff_t *sbuff)
1273{
1274 _fr_sbuff_set_recurse(sbuff, sbuff->end);
1275}
1276/** @} */
1277
1278/** @name Add a marker to an sbuff
1279 *
1280 * Markers are used to indicate an area of the code is working at a particular
1281 * point in a string buffer.
1282 *
1283 * If the sbuff is performing stream parsing, then markers are used to update
1284 * any pointers to the buffer, as the data in the buffer is shifted to make
1285 * room for new data from the stream.
1286 *
1287 * If the sbuff is being used to create strings, then the markers are updated
1288 * if the buffer is re-allocated.
1289 * @{
1290 */
1291
1292/** Adds a new pointer to the beginning of the list of pointers to update
1293 *
1294 * @param[out] m to initialise.
1295 * @param[in] sbuff to associate marker with.
1296 * @return The position the marker was set to.
1297 */
1298static inline char *fr_sbuff_marker(fr_sbuff_marker_t *m, fr_sbuff_t *sbuff)
1299{
1300 *m = (fr_sbuff_marker_t){
1301 .next = sbuff->m, /* Link into the head */
1302 .p = sbuff->p, /* Set the current position in the sbuff */
1303 .parent = sbuff /* Record which sbuff this marker was associated with */
1304 };
1305 sbuff->m = m;
1306
1307 return sbuff->p;
1308}
1309
1310/** Used to update the position of an 'end' position marker
1311 *
1312 * Updates a marker so that it represents a 'constrained' end.
1313 * If max > fr_sbuff_remaining() + fr_sbuff_used_total(), then the marker will
1314 * be set to the end of the sbuff.
1315 *
1316 * Otherwise the marker will be set to the position indicated by
1317 * start + (max - fr_sbuff_used_total()).
1318 *
1319 * This is used to add a constraint on the amount data that can be copied from
1320 * an extendable buffer.
1321 *
1322 * @param[in] m Marker created with #fr_sbuff_marker.
1323 * @param[in] max amount of data we allow to be read from
1324 * the sbuff. May be SIZE_MAX in which
1325 * case there is no constraint imposed
1326 * and the marker is set to the end of the buffer.
1327 */
1328static inline char *fr_sbuff_marker_update_end(fr_sbuff_marker_t *m, size_t max)
1329{
1330 fr_sbuff_t *sbuff = m->parent;
1331 size_t used = fr_sbuff_used_total(sbuff);
1332 size_t left;
1333
1334 /*
1335 * Clamp at max instead of overflowing.
1336 */
1337 if (used >= max) {
1338 m->p = fr_sbuff_current(sbuff);
1339 return m->p;
1340 }
1341
1342 left = max - used;
1343
1344 m->p = (left > fr_sbuff_remaining(sbuff) ?
1345 fr_sbuff_end(sbuff) :
1346 fr_sbuff_current(sbuff) + left);
1347
1348 return m->p;
1349}
1350
1351/** Trims the linked list back to the specified pointer
1352 *
1353 * Pointers should be released in the inverse order to allocation.
1354 *
1355 * Alternatively the oldest pointer can be released, resulting in any newer pointer
1356 * also being removed from the list.
1357 *
1358 * @param[in] m to release.
1359 */
1360static inline void fr_sbuff_marker_release(fr_sbuff_marker_t *m)
1361{
1362 m->parent->m = m->next;
1363
1364#ifndef NDEBUG
1365 memset(m, 0, sizeof(*m)); /* Use after release */
1366#endif
1367}
1368
1369/** Trims the linked list back to the specified pointer and return how many bytes marker was behind p
1370 *
1371 * Pointers should be released in the inverse order to allocation.
1372 *
1373 * Alternatively the oldest pointer can be released, resulting in any newer pointer
1374 * also being removed from the list.
1375 *
1376 * @param[in] m to release.
1377 * @return
1378 * - 0 marker is ahead of p.
1379 * - >0 the number of bytes the marker is behind p.
1380 */
1381static inline size_t fr_sbuff_marker_release_behind(fr_sbuff_marker_t *m)
1382{
1383 size_t len = fr_sbuff_behind(m);
1384 fr_sbuff_marker_release(m);
1385 return len;
1386}
1387
1388/** Trims the linked list back to the specified pointer and return how many bytes marker was ahead of p
1389 *
1390 * Pointers should be released in the inverse order to allocation.
1391 *
1392 * Alternatively the oldest pointer can be released, resulting in any newer pointer
1393 * also being removed from the list.
1394 *
1395 * @param[in] m to release.
1396 * @return
1397 * - 0 marker is ahead of p.
1398 * - >0 the number of bytes the marker is behind p.
1399 */
1400static inline size_t fr_sbuff_marker_release_ahead(fr_sbuff_marker_t *m)
1401{
1402 size_t len = fr_sbuff_ahead(m);
1403 fr_sbuff_marker_release(m);
1404 return len;
1405}
1406
1407/** Trims the linked list back to the specified pointer and return how many bytes marker was behind p
1408 *
1409 * Pointers should be released in the inverse order to allocation.
1410 *
1411 * Alternatively the oldest pointer can be released, resulting in any newer pointer
1412 * also being removed from the list.
1413 *
1414 * @param[in] m to release.
1415 * @return
1416 * - 0 marker is ahead of p.
1417 * - >0 the number of bytes the marker is behind p.
1418 */
1419static inline size_t fr_sbuff_marker_release_reset_behind(fr_sbuff_marker_t *m)
1420{
1421 size_t len = fr_sbuff_behind(m);
1422 fr_sbuff_set(m->parent, m);
1423 fr_sbuff_marker_release(m);
1424 return len;
1425}
1426
1427/** Trims the linked list back to the specified pointer and return how many bytes marker was ahead of p
1428 *
1429 * Pointers should be released in the inverse order to allocation.
1430 *
1431 * Alternatively the oldest pointer can be released, resulting in any newer pointer
1432 * also being removed from the list.
1433 *
1434 * @param[in] m to release.
1435 * @return
1436 * - 0 marker is ahead of p.
1437 * - >0 the number of bytes the marker is behind p.
1438 */
1439static inline size_t fr_sbuff_marker_release_reset_ahead(fr_sbuff_marker_t *m)
1440{
1441 size_t len = fr_sbuff_ahead(m);
1442 fr_sbuff_set(m->parent, m);
1443 fr_sbuff_marker_release(m);
1444 return len;
1445}
1446/** @} */
1447
1448/** @name Copy data between an sbuff/marker
1449 *
1450 * These functions are typically used for moving data between sbuffs
1451 *
1452 * @{
1453 */
1454size_t _fr_sbuff_move_sbuff_to_sbuff(fr_sbuff_t *out, fr_sbuff_t *in, size_t len);
1455
1456size_t _fr_sbuff_move_marker_to_sbuff(fr_sbuff_t *out, fr_sbuff_marker_t *in, size_t len);
1457
1458size_t _fr_sbuff_move_marker_to_marker(fr_sbuff_marker_t *out, fr_sbuff_marker_t *in, size_t len);
1459
1460size_t _fr_sbuff_move_sbuff_to_marker(fr_sbuff_marker_t *out, fr_sbuff_t *in, size_t len);
1461
1462/** Copy in as many bytes as possible from one sbuff or marker to another
1463 *
1464 * @param[in] _out to copy into.
1465 * @param[in] _in to copy from.
1466 * @param[in] _len The maximum length to copy.
1467 * @return Number of bytes copied.
1468 */
1469#define fr_sbuff_move(_out, _in, _len) \
1470 _Generic((_out), \
1471 fr_sbuff_t * : \
1472 _Generic((_in), \
1473 fr_sbuff_t * : _fr_sbuff_move_sbuff_to_sbuff((fr_sbuff_t *)_out, (fr_sbuff_t *)_in, _len), \
1474 fr_sbuff_marker_t * : _fr_sbuff_move_marker_to_sbuff((fr_sbuff_t *)_out, (fr_sbuff_marker_t *)_in, _len) \
1475 ), \
1476 fr_sbuff_marker_t * : \
1477 _Generic((_in), \
1478 fr_sbuff_t * : _fr_sbuff_move_sbuff_to_marker((fr_sbuff_marker_t *)_out, (fr_sbuff_t *)_in, _len), \
1479 fr_sbuff_marker_t * : _fr_sbuff_move_marker_to_marker((fr_sbuff_marker_t *)_out, (fr_sbuff_marker_t *)_in, _len) \
1480 ) \
1481 )
1482/** @} */
1483
1484/** @name Copy/print complete input data to an sbuff
1485 *
1486 * These functions are typically used for printing.
1487 *
1488 * @{
1489 */
1490#define fr_sbuff_in_char(_sbuff, ...) fr_sbuff_in_bstrncpy(_sbuff, ((char []){ __VA_ARGS__ }), sizeof((char []){ __VA_ARGS__ }))
1491#define FR_SBUFF_IN_CHAR_RETURN(_sbuff, ...) FR_SBUFF_RETURN(fr_sbuff_in_bstrncpy, _sbuff, ((char []){ __VA_ARGS__ }), sizeof((char []){ __VA_ARGS__ }))
1492
1493ssize_t fr_sbuff_in_strcpy(fr_sbuff_t *sbuff, char const *str);
1494#define FR_SBUFF_IN_STRCPY_RETURN(...) FR_SBUFF_RETURN(fr_sbuff_in_strcpy, ##__VA_ARGS__)
1495
1496ssize_t fr_sbuff_in_bstrncpy(fr_sbuff_t *sbuff, char const *str, size_t len);
1497#define FR_SBUFF_IN_BSTRNCPY_RETURN(...) FR_SBUFF_RETURN(fr_sbuff_in_bstrncpy, ##__VA_ARGS__)
1498
1499#define fr_sbuff_in_strcpy_literal(_sbuff, _str) fr_sbuff_in_bstrncpy(_sbuff, _str, sizeof(_str) - 1)
1500#define FR_SBUFF_IN_STRCPY_LITERAL_RETURN(_sbuff, _str) FR_SBUFF_RETURN(fr_sbuff_in_bstrncpy, _sbuff, _str, sizeof(_str) - 1)
1501
1502ssize_t fr_sbuff_in_bstrcpy_buffer(fr_sbuff_t *sbuff, char const *str);
1503#define FR_SBUFF_IN_BSTRCPY_BUFFER_RETURN(...) FR_SBUFF_RETURN(fr_sbuff_in_bstrcpy_buffer, ##__VA_ARGS__)
1504
1505ssize_t fr_sbuff_in_vsprintf(fr_sbuff_t *sbuff, char const *fmt, va_list ap);
1506#define FR_SBUFF_IN_VSPRINTF_RETURN(...) FR_SBUFF_RETURN(fr_sbuff_in_vsprintf, ##__VA_ARGS__)
1507
1508ssize_t fr_sbuff_in_sprintf(fr_sbuff_t *sbuff, char const *fmt, ...);
1509#define FR_SBUFF_IN_SPRINTF_RETURN(...) FR_SBUFF_RETURN(fr_sbuff_in_sprintf, ##__VA_ARGS__)
1510
1511ssize_t fr_sbuff_in_escape(fr_sbuff_t *sbuff, char const *in, size_t inlen, fr_sbuff_escape_rules_t const *e_rules);
1512#define FR_SBUFF_IN_ESCAPE_RETURN(...) FR_SBUFF_RETURN(fr_sbuff_in_escape, ##__VA_ARGS__)
1513
1514bool fr_sbuff_in_needs_escaping(char const *in, size_t inlen, fr_sbuff_escape_rules_t const *e_rules) CC_HINT(nonnull(1));
1515
1516ssize_t fr_sbuff_in_escape_buffer(fr_sbuff_t *sbuff, char const *in, fr_sbuff_escape_rules_t const *e_rules);
1517#define FR_SBUFF_IN_ESCAPE_BUFFER_RETURN(...) FR_SBUFF_RETURN(fr_sbuff_in_escape_buffer, ##__VA_ARGS__)
1518
1519fr_slen_t fr_sbuff_in_array(fr_sbuff_t *sbuff, char const * const *array, char const *sep);
1520#define FR_SBUFF_IN_ARRAY(...) FR_SBUFF_RETURN(fr_sbuff_in_array, ##__VA_ARGS__)
1521
1522/** Lookup a string in a table using an integer value, and copy it to the sbuff
1523 *
1524 * @param[out] _slen Where to write the return value.
1525 * @param[in] _sbuff to search in.
1526 * @param[in] _table to search for number in.
1527 * @param[in] _number to search for.
1528 * @param[in] _def Default string value.
1529 */
1530#define fr_sbuff_in_table_str(_slen, _sbuff, _table, _number, _def) \
1531 _slen = fr_sbuff_in_strcpy(_sbuff, fr_table_str_by_value(_table, _number, _def))
1532#define FR_SBUFF_IN_TABLE_STR_RETURN(_sbuff, _table, _number, _def) \
1533do { \
1534 ssize_t _slen; \
1535 fr_sbuff_in_table_str(_slen, _sbuff, _table, _number, _def); \
1536 if (_slen < 0) return _slen; \
1537} while (0)
1538/** @} */
1539
1540/** @name Copy data out of an sbuff
1541 *
1542 * These functions are typically used for parsing.
1543 *
1544 * @{
1545 */
1546
1547/** Toggle any chars to 'true' in out, that were present in, out or in
1548 *
1549 */
1550static inline void fr_sbuff_allowed_merge(bool out[static SBUFF_CHAR_CLASS], bool const in[static SBUFF_CHAR_CLASS])
1551{
1552 for (size_t i = 0; i <= UINT8_MAX; i++) out[i] = out[i] || in[i];
1553}
1554
1555fr_sbuff_term_t *fr_sbuff_terminals_amerge(TALLOC_CTX *ctx,
1556 fr_sbuff_term_t const *a, fr_sbuff_term_t const *b);
1557
1558fr_sbuff_err_t fr_sbuff_out_bstrncpy(size_t *len, fr_sbuff_t *out, fr_sbuff_t *in, size_t max)
1559 CC_HINT(warn_unused_result);
1560
1561fr_sbuff_err_t fr_sbuff_out_bstrncpy_exact(fr_sbuff_t *out, fr_sbuff_t *in, size_t len) CC_HINT(warn_unused_result);
1562
1563fr_sbuff_err_t fr_sbuff_out_bstrncpy_allowed(size_t *len, fr_sbuff_t *out, fr_sbuff_t *in, size_t max,
1564 bool const allowed[static SBUFF_CHAR_CLASS])
1565 CC_HINT(warn_unused_result);
1566
1567fr_sbuff_err_t fr_sbuff_out_bstrncpy_until(size_t *len, fr_sbuff_t *out, fr_sbuff_t *in, size_t max,
1568 fr_sbuff_term_t const *tt,
1569 fr_sbuff_unescape_rules_t const *u_rules)
1570 CC_HINT(warn_unused_result);
1571
1572fr_sbuff_err_t fr_sbuff_out_unescape_until(size_t *len, fr_sbuff_t *out, fr_sbuff_t *in, size_t max,
1573 fr_sbuff_term_t const *tt,
1574 fr_sbuff_unescape_rules_t const *u_rules)
1575 CC_HINT(warn_unused_result);
1576
1577/** Find the longest prefix in an sbuff
1578 *
1579 * @param[out] _match_len The length of the matched string.
1580 * May be NULL.
1581 * @param[out] _out The value resolved in the table.
1582 * @param[in] _table to find longest match in.
1583 * @param[in] _sbuff containing the needle.
1584 * @param[in] _def Default value if no match is found.
1585 */
1586#define fr_sbuff_out_by_longest_prefix(_match_len, _out, _table, _sbuff, _def) \
1587do { \
1588 size_t _match_len_tmp; \
1589 fr_sbuff_extend_lowat(NULL, _sbuff, fr_table_max_needle_len(_table)); \
1590 *(_out) = fr_table_value_by_longest_prefix(&_match_len_tmp, _table, \
1591 fr_sbuff_current(_sbuff), fr_sbuff_remaining(_sbuff), \
1592 _def); \
1593 (void) fr_sbuff_advance(_sbuff, _match_len_tmp); /* can't fail */ \
1594 *(_match_len) = _match_len_tmp; \
1595} while (0)
1596
1597/** Build a talloc wrapper function for a fr_sbuff_out_* function
1598 *
1599 * @param[in] _func to call.
1600 * @param[in] _in input sbuff arg.
1601 * @param[in] _len expected output len.
1602 * @param[in] ... additional arguments to pass to _func.
1603 */
1604#define SBUFF_OUT_TALLOC_ERR_FUNC_DEF(_func, _in, _len, ...) \
1605{ \
1606 fr_sbuff_t sbuff; \
1607 fr_sbuff_uctx_talloc_t tctx; \
1608 fr_sbuff_err_t err; \
1609 fr_slen_t slen = -1; \
1610 if (unlikely(fr_sbuff_init_talloc(ctx, &sbuff, &tctx, \
1611 ((_len) != SIZE_MAX) ? (_len) : 1024, \
1612 ((_len) != SIZE_MAX) ? (_len) : SIZE_MAX) == NULL)) { \
1613 error: \
1614 TALLOC_FREE(sbuff.buff); \
1615 *out = NULL; \
1616 return slen; \
1617 } \
1618 slen = _func(&err, &sbuff, _in, _len, ##__VA_ARGS__); \
1619 if (slen < 0) goto error; \
1620 if (unlikely(fr_sbuff_trim_talloc(&sbuff, SIZE_MAX) < 0)) { \
1621 slen = -1; \
1622 goto error; \
1623 } \
1624 *out = sbuff.buff; \
1625 return slen; \
1626}
1627
1628/** Build a talloc wrapper function for a fr_sbuff_out_* function
1629 *
1630 * @param[in] _func to call.
1631 * @param[in] _in input sbuff arg.
1632 * @param[in] _len expected output len.
1633 * @param[in] ... additional arguments to pass to _func.
1634 */
1635#define SBUFF_OUT_TALLOC_FUNC_DEF(_func, _in, _len, ...) \
1636{ \
1637 fr_sbuff_t sbuff; \
1638 fr_sbuff_uctx_talloc_t tctx; \
1639 fr_slen_t slen = -1; \
1640 if (unlikely(fr_sbuff_init_talloc(ctx, &sbuff, &tctx, \
1641 ((_len) != SIZE_MAX) ? (_len) : 1024, \
1642 ((_len) != SIZE_MAX) ? (_len) : SIZE_MAX) == NULL)) { \
1643 error: \
1644 TALLOC_FREE(sbuff.buff); \
1645 *out = NULL; \
1646 return slen; \
1647 } \
1648 slen = _func(&sbuff, _in, _len, ##__VA_ARGS__); \
1649 if (slen < 0) goto error; \
1650 if (unlikely(fr_sbuff_trim_talloc(&sbuff, SIZE_MAX) < 0)) { \
1651 slen = -1; \
1652 goto error; \
1653 } \
1654 *out = sbuff.buff; \
1655 return slen; \
1656}
1657
1658/** Build a talloc wrapper function for a fr_sbuff_out_* function
1659 *
1660 * @param[in] _func to call.
1661 * @param[in] ... additional arguments to pass to _func.
1662 */
1663#define SBUFF_OUT_TALLOC_FUNC_NO_LEN_DEF(_func, ...) \
1664{ \
1665 fr_sbuff_t sbuff; \
1666 fr_sbuff_uctx_talloc_t tctx; \
1667 fr_slen_t slen = -1; \
1668 if (unlikely(fr_sbuff_init_talloc(ctx, &sbuff, &tctx, 0, SIZE_MAX) == NULL)) { \
1669 error: \
1670 TALLOC_FREE(sbuff.buff); \
1671 *out = NULL; \
1672 return slen; \
1673 } \
1674 slen = _func(&sbuff, ##__VA_ARGS__); \
1675 if (slen < 0) goto error; \
1676 if (unlikely(fr_sbuff_trim_talloc(&sbuff, SIZE_MAX) < 0)) { \
1677 slen = -1; \
1678 goto error; \
1679 } \
1680 *out = sbuff.buff; \
1681 return slen; \
1682}
1683
1684/** Build a talloc wrapper function for a fr_sbuff_out_* function that reports an fr_sbuff_err_t through an argument
1685 *
1686 * The wrapper sets the error to #FR_SBUFF_ERR_NO_SPACE when the output buffer
1687 * cannot be allocated or trimmed, so the caller always receives an error code
1688 * with a negative return.
1689 *
1690 * @param[in] _func to call.
1691 * @param[in] _err fr_sbuff_err_t pointer argument of the wrapper, may be NULL.
1692 * @param[in] ... additional arguments to pass to _func after _err.
1693 */
1694#define SBUFF_OUT_TALLOC_FUNC_NO_LEN_ERR_DEF(_func, _err, ...) \
1695{ \
1696 fr_sbuff_t sbuff; \
1697 fr_sbuff_uctx_talloc_t tctx; \
1698 fr_slen_t slen = -1; \
1699 if (unlikely(fr_sbuff_init_talloc(ctx, &sbuff, &tctx, 0, SIZE_MAX) == NULL)) { \
1700 if (_err) *(_err) = FR_SBUFF_ERR_NO_SPACE; \
1701 error: \
1702 TALLOC_FREE(sbuff.buff); \
1703 *out = NULL; \
1704 return slen; \
1705 } \
1706 slen = _func(&sbuff, _err, ##__VA_ARGS__); \
1707 if (slen < 0) goto error; \
1708 if (unlikely(fr_sbuff_trim_talloc(&sbuff, SIZE_MAX) < 0)) { \
1709 if (_err) *(_err) = FR_SBUFF_ERR_NO_SPACE; \
1710 slen = -1; \
1711 goto error; \
1712 } \
1713 *out = sbuff.buff; \
1714 return slen; \
1715}
1716
1717/** Build a talloc wrapper function for a fr_sbuff_out_* function returning fr_sbuff_err_t
1718 *
1719 * On any error the buffer is freed and *out is set to NULL.
1720 *
1721 * @param[in] _func to call.
1722 * @param[in] _in input sbuff arg.
1723 * @param[in] _len expected output len.
1724 * @param[in] ... additional arguments to pass to _func.
1725 */
1726#define SBUFF_OUT_TALLOC_FUNC_ERR_DEF(_func, _in, _len, ...) \
1727{ \
1728 fr_sbuff_t sbuff; \
1729 fr_sbuff_uctx_talloc_t tctx; \
1730 fr_sbuff_err_t err; \
1731 if (unlikely(fr_sbuff_init_talloc(ctx, &sbuff, &tctx, \
1732 ((_len) != SIZE_MAX) ? (_len) : 1024, \
1733 ((_len) != SIZE_MAX) ? (_len) : SIZE_MAX) == NULL)) { \
1734 err = FR_SBUFF_ERR_NO_SPACE; \
1735 error: \
1736 TALLOC_FREE(sbuff.buff); \
1737 *out = NULL; \
1738 return err; \
1739 } \
1740 err = _func(&sbuff, _in, _len, ##__VA_ARGS__); \
1741 if (err != FR_SBUFF_OK) goto error; \
1742 if (unlikely(fr_sbuff_trim_talloc(&sbuff, SIZE_MAX) < 0)) { \
1743 err = FR_SBUFF_ERR_NO_SPACE; \
1744 goto error; \
1745 } \
1746 *out = sbuff.buff; \
1747 return FR_SBUFF_OK; \
1748}
1749
1750/** Build a talloc wrapper function for a fr_sbuff_out_* function returning fr_sbuff_err_t and a length
1751 *
1752 * The wrapped function takes a `size_t *len` out argument first, which is
1753 * passed through. On any error the buffer is freed, *out is set to NULL
1754 * and *len to 0.
1755 *
1756 * @param[in] _func to call.
1757 * @param[in] _in input sbuff arg.
1758 * @param[in] _max maximum number of bytes to copy.
1759 * @param[in] ... additional arguments to pass to _func.
1760 */
1761#define SBUFF_OUT_TALLOC_FUNC_ERR_LEN_DEF(_func, _in, _max, ...) \
1762{ \
1763 fr_sbuff_t sbuff; \
1764 fr_sbuff_uctx_talloc_t tctx; \
1765 fr_sbuff_err_t err; \
1766 if (unlikely(fr_sbuff_init_talloc(ctx, &sbuff, &tctx, \
1767 ((_max) != SIZE_MAX) ? (_max) : 1024, \
1768 ((_max) != SIZE_MAX) ? (_max) : SIZE_MAX) == NULL)) { \
1769 err = FR_SBUFF_ERR_NO_SPACE; \
1770 error: \
1771 TALLOC_FREE(sbuff.buff); \
1772 *out = NULL; \
1773 if (len) *len = 0; \
1774 return err; \
1775 } \
1776 err = _func(len, &sbuff, _in, _max, ##__VA_ARGS__); \
1777 if (err < 0) goto error; \
1778 if (unlikely(fr_sbuff_trim_talloc(&sbuff, SIZE_MAX) < 0)) { \
1779 err = FR_SBUFF_ERR_NO_SPACE; \
1780 goto error; \
1781 } \
1782 *out = sbuff.buff; \
1783 return FR_SBUFF_OK; \
1784}
1785
1786static inline fr_sbuff_err_t fr_sbuff_out_abstrncpy(TALLOC_CTX *ctx, char **out, size_t *len, fr_sbuff_t *in, size_t max)
1787SBUFF_OUT_TALLOC_FUNC_ERR_LEN_DEF(fr_sbuff_out_bstrncpy, in, max)
1788
1789static inline fr_sbuff_err_t fr_sbuff_out_abstrncpy_exact(TALLOC_CTX *ctx, char **out, fr_sbuff_t *in, size_t len)
1790SBUFF_OUT_TALLOC_FUNC_ERR_DEF(fr_sbuff_out_bstrncpy_exact, in, len)
1791
1792static inline fr_sbuff_err_t fr_sbuff_out_abstrncpy_allowed(TALLOC_CTX *ctx, char **out, size_t *len, fr_sbuff_t *in, size_t max,
1793 bool const allowed[static SBUFF_CHAR_CLASS])
1794SBUFF_OUT_TALLOC_FUNC_ERR_LEN_DEF(fr_sbuff_out_bstrncpy_allowed, in, max, allowed)
1795
1796static inline fr_sbuff_err_t fr_sbuff_out_abstrncpy_until(TALLOC_CTX *ctx, char **out, size_t *len, fr_sbuff_t *in, size_t max,
1797 fr_sbuff_term_t const *tt,
1798 fr_sbuff_unescape_rules_t const *u_rules)
1799SBUFF_OUT_TALLOC_FUNC_ERR_LEN_DEF(fr_sbuff_out_bstrncpy_until, in, max, tt, u_rules)
1800
1801static inline fr_sbuff_err_t fr_sbuff_out_aunescape_until(TALLOC_CTX *ctx, char **out, size_t *len, fr_sbuff_t *in, size_t max,
1802 fr_sbuff_term_t const *tt,
1803 fr_sbuff_unescape_rules_t const *u_rules)
1804SBUFF_OUT_TALLOC_FUNC_ERR_LEN_DEF(fr_sbuff_out_unescape_until, in, max, tt, u_rules)
1805/** @} */
1806
1807/** @name Look for a token in a particular format, parse it, and write it to the output pointer
1808 *
1809 * These functions should not be called directly. #fr_sbuff_out should be used instead
1810 * so that if the output variable type changes, the parse rules are automatically changed.
1811 *
1812 * On success the input sbuff is advanced past the token. On failure it is not
1813 * advanced, and the result says why:
1814 *
1815 * - FR_SBUFF_ERR_INPUT_EMPTY no input.
1816 * - FR_SBUFF_ERR_NOT_FOUND input does not start with a token of the requested type.
1817 * - FR_SBUFF_ERR_TRAILING the token would continue past the widest representation
1818 * of the type (only with no_trailing). out is set to the type's maximum.
1819 * - FR_SBUFF_ERR_OVERFLOW / FR_SBUFF_ERR_UNDERFLOW the token is out of range for
1820 * the type. out is set to the type's maximum or minimum.
1821 * - FR_SBUFF_ERR_EXTEND the input could not be extended.
1822 * @{
1823 */
1824fr_sbuff_err_t fr_sbuff_out_bool(bool *out, fr_sbuff_t *in) CC_HINT(warn_unused_result);
1825
1826fr_sbuff_err_t fr_sbuff_out_int8(int8_t *out, fr_sbuff_t *sbuff, bool no_trailing) CC_HINT(warn_unused_result);
1827fr_sbuff_err_t fr_sbuff_out_int16(int16_t *out, fr_sbuff_t *sbuff, bool no_trailing) CC_HINT(warn_unused_result);
1828fr_sbuff_err_t fr_sbuff_out_int32(int32_t *out, fr_sbuff_t *sbuff, bool no_trailing) CC_HINT(warn_unused_result);
1829fr_sbuff_err_t fr_sbuff_out_int64(int64_t *out, fr_sbuff_t *sbuff, bool no_trailing) CC_HINT(warn_unused_result);
1830fr_sbuff_err_t fr_sbuff_out_ssize(ssize_t *out, fr_sbuff_t *sbuff, bool no_trailing) CC_HINT(warn_unused_result);
1831fr_sbuff_err_t fr_sbuff_out_uint8(uint8_t *out, fr_sbuff_t *sbuff, bool no_trailing) CC_HINT(warn_unused_result);
1832fr_sbuff_err_t fr_sbuff_out_uint16(uint16_t *out, fr_sbuff_t *sbuff, bool no_trailing) CC_HINT(warn_unused_result);
1833fr_sbuff_err_t fr_sbuff_out_uint32(uint32_t *out, fr_sbuff_t *sbuff, bool no_trailing) CC_HINT(warn_unused_result);
1834fr_sbuff_err_t fr_sbuff_out_uint64(uint64_t *out, fr_sbuff_t *sbuff, bool no_trailing) CC_HINT(warn_unused_result);
1835fr_sbuff_err_t fr_sbuff_out_size(size_t *out, fr_sbuff_t *sbuff, bool no_trailing) CC_HINT(warn_unused_result);
1836
1837fr_sbuff_err_t fr_sbuff_out_uint8_dec(uint8_t *out, fr_sbuff_t *sbuff, bool no_trailing) CC_HINT(warn_unused_result);
1838fr_sbuff_err_t fr_sbuff_out_uint16_dec(uint16_t *out, fr_sbuff_t *sbuff, bool no_trailing) CC_HINT(warn_unused_result);
1839fr_sbuff_err_t fr_sbuff_out_uint32_dec(uint32_t *out, fr_sbuff_t *sbuff, bool no_trailing) CC_HINT(warn_unused_result);
1840fr_sbuff_err_t fr_sbuff_out_uint64_dec(uint64_t *out, fr_sbuff_t *sbuff, bool no_trailing) CC_HINT(warn_unused_result);
1841fr_sbuff_err_t fr_sbuff_out_size_dec(size_t *out, fr_sbuff_t *sbuff, bool no_trailing) CC_HINT(warn_unused_result);
1842
1843fr_sbuff_err_t fr_sbuff_out_uint8_oct(uint8_t *out, fr_sbuff_t *sbuff, bool no_trailing) CC_HINT(warn_unused_result);
1844fr_sbuff_err_t fr_sbuff_out_uint16_oct(uint16_t *out, fr_sbuff_t *sbuff, bool no_trailing) CC_HINT(warn_unused_result);
1845fr_sbuff_err_t fr_sbuff_out_uint32_oct(uint32_t *out, fr_sbuff_t *sbuff, bool no_trailing) CC_HINT(warn_unused_result);
1846fr_sbuff_err_t fr_sbuff_out_uint64_oct(uint64_t *out, fr_sbuff_t *sbuff, bool no_trailing) CC_HINT(warn_unused_result);
1847fr_sbuff_err_t fr_sbuff_out_size_oct(size_t *out, fr_sbuff_t *sbuff, bool no_trailing) CC_HINT(warn_unused_result);
1848
1849fr_sbuff_err_t fr_sbuff_out_uint8_hex(uint8_t *out, fr_sbuff_t *sbuff, bool no_trailing) CC_HINT(warn_unused_result);
1850fr_sbuff_err_t fr_sbuff_out_uint16_hex(uint16_t *out, fr_sbuff_t *sbuff, bool no_trailing) CC_HINT(warn_unused_result);
1851fr_sbuff_err_t fr_sbuff_out_uint32_hex(uint32_t *out, fr_sbuff_t *sbuff, bool no_trailing) CC_HINT(warn_unused_result);
1852fr_sbuff_err_t fr_sbuff_out_uint64_hex(uint64_t *out, fr_sbuff_t *sbuff, bool no_trailing) CC_HINT(warn_unused_result);
1853fr_sbuff_err_t fr_sbuff_out_size_hex(size_t *out, fr_sbuff_t *sbuff, bool no_trailing) CC_HINT(warn_unused_result);
1854
1855fr_sbuff_err_t fr_sbuff_out_float32(float *out, fr_sbuff_t *sbuff, bool no_trailing) CC_HINT(warn_unused_result);
1856fr_sbuff_err_t fr_sbuff_out_float64(double *out, fr_sbuff_t *sbuff, bool no_trailing) CC_HINT(warn_unused_result);
1857
1858#ifndef SIZE_SAME_AS_UINT64
1859# define _fr_sbuff_out_size(_out, _in) size_t * : fr_sbuff_out_size((size_t *)_out, _in, true),
1860#else
1861# define _fr_sbuff_out_size(_out, _in)
1862#endif
1863
1864#ifndef SSIZE_SAME_AS_INT64
1865# define _fr_sbuff_out_ssize(_out, _in) ssize_t * : fr_sbuff_out_ssize((ssize_t *)_out, _in, true),
1866#else
1867# define _fr_sbuff_out_ssize(_out, _in)
1868#endif
1869
1870/** Parse a value based on the output type
1871 *
1872 * @param[out] _out Pointer to a bool, integer or float.
1873 * @param[in] _in Sbuff to parse the value from. Advanced past the value on success.
1874 * @return
1875 * - FR_SBUFF_OK on success.
1876 * - < 0 on failure, see the parse functions above.
1877 */
1878#define fr_sbuff_out(_out, _in) \
1879 _Generic((_out), \
1880 bool * : fr_sbuff_out_bool((bool *)_out, _in), \
1881 int8_t * : fr_sbuff_out_int8((int8_t *)_out, _in, true), \
1882 int16_t * : fr_sbuff_out_int16((int16_t *)_out, _in, true), \
1883 int32_t * : fr_sbuff_out_int32((int32_t *)_out, _in, true), \
1884 int64_t * : fr_sbuff_out_int64((int64_t *)_out, _in, true), \
1885 _fr_sbuff_out_ssize(_out, _in) \
1886 uint8_t * : fr_sbuff_out_uint8((uint8_t *)_out, _in, true), \
1887 uint16_t * : fr_sbuff_out_uint16((uint16_t *)_out, _in, true), \
1888 uint32_t * : fr_sbuff_out_uint32((uint32_t *)_out, _in, true), \
1889 uint64_t * : fr_sbuff_out_uint64((uint64_t *)_out, _in, true), \
1890 _fr_sbuff_out_size(_out, _in) \
1891 float * : fr_sbuff_out_float32((float *)_out, _in, true), \
1892 double * : fr_sbuff_out_float64((double *)_out, _in, true) \
1893 )
1894/** @} */
1895
1896
1897/** @name Conditional advancement
1898 *
1899 * These functions are typically used for parsing when trying to locate
1900 * a sequence of characters in the sbuff.
1901 *
1902 * @{
1903 */
1904size_t fr_sbuff_adv_past_str(fr_sbuff_t *sbuff, char const *needle, size_t need_len);
1905
1906#define fr_sbuff_adv_past_str_literal(_sbuff, _needle) fr_sbuff_adv_past_str(_sbuff, _needle, sizeof(_needle) - 1)
1907
1908size_t fr_sbuff_adv_past_strcase(fr_sbuff_t *sbuff, char const *needle, size_t need_len);
1909
1910#define fr_sbuff_adv_past_strcase_literal(_sbuff, _needle) fr_sbuff_adv_past_strcase(_sbuff, _needle, sizeof(_needle) - 1)
1911
1912size_t fr_sbuff_adv_past_allowed(fr_sbuff_t *sbuff, size_t len,
1913 bool const allowed[static SBUFF_CHAR_CLASS], fr_sbuff_term_t const *tt);
1914
1915#define fr_sbuff_adv_past_zeros(_sbuff, _len, _tt) fr_sbuff_adv_past_allowed(_sbuff, _len, sbuff_char_class_zero, _tt)
1916
1917#define fr_sbuff_adv_past_whitespace(_sbuff, _len, _tt) fr_sbuff_adv_past_allowed(_sbuff, _len, sbuff_char_whitespace, _tt)
1918
1919#define fr_sbuff_adv_past_blank(_sbuff, _len, _tt) fr_sbuff_adv_past_allowed(_sbuff, _len, sbuff_char_blank, _tt)
1920
1921size_t fr_sbuff_adv_until(fr_sbuff_t *sbuff, size_t len, fr_sbuff_term_t const *tt, char escape_chr);
1922
1923char *fr_sbuff_adv_to_chr_utf8(fr_sbuff_t *in, size_t len, char const *chr);
1924
1925char *fr_sbuff_adv_to_chr(fr_sbuff_t *in, size_t len, char c);
1926
1927char *fr_sbuff_adv_to_str(fr_sbuff_t *sbuff, size_t len, char const *needle, size_t needle_len);
1928
1929#define fr_sbuff_adv_to_str_literal(_sbuff, _len, _needle) fr_sbuff_adv_to_str(_sbuff, _len, _needle, sizeof(_needle) - 1)
1930
1931char *fr_sbuff_adv_to_strcase(fr_sbuff_t *sbuff, size_t len, char const *needle, size_t needle_len);
1932
1933#define fr_sbuff_adv_to_strcase_literal(_sbuff, _len, _needle) fr_sbuff_adv_to_strcase(_sbuff, _len, _needle, sizeof(_needle) - 1)
1934
1935bool fr_sbuff_next_if_char(fr_sbuff_t *sbuff, char c);
1936
1937bool fr_sbuff_next_unless_char(fr_sbuff_t *sbuff, char c);
1938
1939/** Advance the sbuff by one char
1940 *
1941 */
1942static inline char fr_sbuff_next(fr_sbuff_t *sbuff)
1943{
1944 if (!fr_sbuff_extend(sbuff)) return '\0';
1945 return fr_sbuff_advance(sbuff, 1);
1946}
1947/** @} */
1948
1949/** @name Remove chars from a buffer and re-terminate
1950 *
1951 * @{
1952 */
1953size_t fr_sbuff_trim(fr_sbuff_t *sbuff, bool const to_trim[static SBUFF_CHAR_CLASS]);
1954/** @} */
1955
1956/** @name Conditions
1957 *
1958 * These functions are typically used in recursive decent parsing for
1959 * look ahead.
1960 * @{
1961 */
1962bool fr_sbuff_is_terminal(fr_sbuff_t *in, fr_sbuff_term_t const *tt);
1963
1964static inline bool fr_sbuff_is_in_charset(fr_sbuff_t *sbuff, bool const chars[static SBUFF_CHAR_CLASS])
1965{
1966 if (!fr_sbuff_extend(sbuff)) return false;
1967 return chars[(uint8_t)*sbuff->p];
1968}
1969
1970static inline bool fr_sbuff_is_str(fr_sbuff_t *sbuff, char const *str, size_t len)
1971{
1972 if (len == SIZE_MAX) len = strlen(str);
1973 if (fr_sbuff_extend_lowat(NULL, sbuff, len) < len) return false;
1974 return memcmp(sbuff->p, str, len) == 0;
1975}
1976#define fr_sbuff_is_str_literal(_sbuff, _str) fr_sbuff_is_str(_sbuff, _str, sizeof(_str) - 1)
1977
1978#define fr_sbuff_eof(_x) (!fr_sbuff_extend(_x))
1979
1980static inline bool _fr_sbuff_is_char(fr_sbuff_t *sbuff, char *p, char c)
1981{
1982 if (!fr_sbuff_extend(sbuff)) return false;
1983 return *p == c;
1984}
1985static inline bool _fr_marker_is_char(fr_sbuff_marker_t *marker, char *p, char c)
1986{
1987 if (!fr_sbuff_extend(marker)) return false;
1988 return *p == c;
1989}
1990#define fr_sbuff_is_char(_sbuff_or_marker, _c) \
1991 _Generic((_sbuff_or_marker), \
1992 fr_sbuff_t * : _fr_sbuff_is_char((fr_sbuff_t *)(_sbuff_or_marker), fr_sbuff_current(_sbuff_or_marker), _c), \
1993 fr_sbuff_marker_t * : _fr_marker_is_char((fr_sbuff_marker_t *)(_sbuff_or_marker), fr_sbuff_current(_sbuff_or_marker), _c) \
1994 )
1995
1996#define SBUFF_IS_FUNC(_name, _test) \
1997 static inline bool _fr_sbuff_is_ ## _name(fr_sbuff_t *sbuff, char *p) \
1998 { \
1999 if (!fr_sbuff_extend(sbuff)) return false; \
2000 return _test; \
2001 }\
2002 static inline bool _fr_marker_is_ ## _name(fr_sbuff_marker_t *marker, char *p) \
2003 { \
2004 if (!fr_sbuff_extend(marker)) return false; \
2005 return _test; \
2006 }
2007
2008#define SBUFF_IS_GENERIC(_sbuff_or_marker, _name) \
2009 _Generic((_sbuff_or_marker), \
2010 fr_sbuff_t * : _fr_sbuff_is_ ## _name((fr_sbuff_t *)(_sbuff_or_marker), fr_sbuff_current(_sbuff_or_marker)), \
2011 fr_sbuff_marker_t * : _fr_marker_is_ ## _name((fr_sbuff_marker_t *)(_sbuff_or_marker), fr_sbuff_current(_sbuff_or_marker)) \
2012 )
2013
2014SBUFF_IS_FUNC(digit, isdigit((uint8_t) *p))
2015#define fr_sbuff_is_digit(_sbuff_or_marker) \
2016 SBUFF_IS_GENERIC(_sbuff_or_marker, digit)
2017
2018SBUFF_IS_FUNC(upper, isupper((uint8_t) *p))
2019#define fr_sbuff_is_upper(_sbuff_or_marker) \
2020 SBUFF_IS_GENERIC(_sbuff_or_marker, upper)
2021
2022SBUFF_IS_FUNC(lower, islower((uint8_t) *p))
2023#define fr_sbuff_is_lower(_sbuff_or_marker) \
2024 SBUFF_IS_GENERIC(_sbuff_or_marker, lower)
2025
2026SBUFF_IS_FUNC(alpha, isalpha((uint8_t) *p))
2027#define fr_sbuff_is_alpha(_sbuff_or_marker) \
2028 SBUFF_IS_GENERIC(_sbuff_or_marker, alpha)
2029
2030SBUFF_IS_FUNC(alnum, isalnum((uint8_t) *p))
2031#define fr_sbuff_is_alnum(_sbuff_or_marker) \
2032 SBUFF_IS_GENERIC(_sbuff_or_marker, alnum)
2033
2034SBUFF_IS_FUNC(space, isspace((uint8_t) *p))
2035#define fr_sbuff_is_space(_sbuff_or_marker) \
2036 SBUFF_IS_GENERIC(_sbuff_or_marker, space)
2037
2038SBUFF_IS_FUNC(hex, isxdigit((uint8_t) *p))
2039#define fr_sbuff_is_hex(_sbuff_or_marker) \
2040 SBUFF_IS_GENERIC(_sbuff_or_marker, hex)
2041
2042/** @} */
2043
2044void fr_sbuff_unescape_debug(FILE *fp, fr_sbuff_unescape_rules_t const *escapes);
2045
2046void fr_sbuff_terminal_debug(FILE *fp, fr_sbuff_term_t const *tt);
2047
2048void fr_sbuff_parse_rules_debug(FILE *fp, fr_sbuff_parse_rules_t const *p_rules);
2049
2050/*
2051 * ...printf("foo %.*s", fr_sbuff_as_percent_s(&sbuff));
2052 */
2053#define fr_sbuff_as_percent_s(_sbuff) (int) fr_sbuff_remaining(_sbuff), fr_sbuff_current(_sbuff)
2054
2055fr_slen_t fr_sbuff_array_concat(fr_sbuff_t *out, char const * const *array, char const *sep) CC_HINT(nonnull(1,2));
2056
2057
2058#ifdef __cplusplus
2059}
2060#endif
RCSIDH
#define RCSIDH(h, id)
Definition build.h:561
DIAG_OFF
#define DIAG_OFF(_x)
Definition build.h:534
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_err_t
fr_sbuff_err_t
Definition merged_model.c:54
FR_SBUFF_ERR_INPUT_EMPTY
@ FR_SBUFF_ERR_INPUT_EMPTY
Definition merged_model.c:58
FR_SBUFF_ERR_FORMAT
@ FR_SBUFF_ERR_FORMAT
Definition merged_model.c:62
FR_SBUFF_ERR_TRAILING
@ FR_SBUFF_ERR_TRAILING
Definition merged_model.c:61
FR_SBUFF_ERR_NO_SPACE
@ FR_SBUFF_ERR_NO_SPACE
Definition merged_model.c:56
FR_SBUFF_ERR_UNINITIALISED
@ FR_SBUFF_ERR_UNINITIALISED
Definition merged_model.c:65
FR_SBUFF_ERR_EXTEND
@ FR_SBUFF_ERR_EXTEND
Definition merged_model.c:57
FR_SBUFF_ERR_UNDERFLOW
@ FR_SBUFF_ERR_UNDERFLOW
Definition merged_model.c:64
FR_SBUFF_ERR_OVERFLOW
@ FR_SBUFF_ERR_OVERFLOW
Definition merged_model.c:63
FR_SBUFF_ERR_INPUT_SHORT
@ FR_SBUFF_ERR_INPUT_SHORT
Definition merged_model.c:59
FR_SBUFF_ERR_NOT_FOUND
@ FR_SBUFF_ERR_NOT_FOUND
Definition merged_model.c:60
FR_SBUFF_OK
@ FR_SBUFF_OK
Definition merged_model.c:55
fr_sbuff_escape_rules_t
Definition merged_model.c:250
fr_sbuff_t
Definition merged_model.c:40
name
static char const * name
Definition rlm_redis_ippool_tool.c:140
sbuff_char_class_hex
bool const sbuff_char_class_hex[SBUFF_CHAR_CLASS]
Definition sbuff.c:109
sbuff_char_word
bool const sbuff_char_word[SBUFF_CHAR_CLASS]
Definition sbuff.c:111
sbuff_char_class_float
bool const sbuff_char_class_float[SBUFF_CHAR_CLASS]
Definition sbuff.c:85
sbuff_char_class_uint
bool const sbuff_char_class_uint[SBUFF_CHAR_CLASS]
Definition sbuff.c:75
sbuff_char_class_hostname
bool const sbuff_char_class_hostname[SBUFF_CHAR_CLASS]
Definition sbuff.c:97
sbuff_err_table_len
size_t sbuff_err_table_len
Definition sbuff.c:56
sbuff_char_blank
bool const sbuff_char_blank[SBUFF_CHAR_CLASS]
Definition sbuff.c:123
sbuff_char_class_int
bool const sbuff_char_class_int[SBUFF_CHAR_CLASS]
Definition sbuff.c:80
sbuff_char_whitespace
bool const sbuff_char_whitespace[SBUFF_CHAR_CLASS]
Definition sbuff.c:115
sbuff_err_table
fr_table_num_ordered_t const sbuff_err_table[]
Definition sbuff.c:43
sbuff_char_line_endings
bool const sbuff_char_line_endings[SBUFF_CHAR_CLASS]
Definition sbuff.c:119
sbuff_char_alpha_num
bool const sbuff_char_alpha_num[SBUFF_CHAR_CLASS]
Definition sbuff.c:110
sbuff_char_class_zero
bool const sbuff_char_class_zero[SBUFF_CHAR_CLASS]
Definition sbuff.c:90
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:179
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:181
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
in
static fr_sbuff_err_t char size_t fr_sbuff_t * in
Definition value.h:1061
out
static fr_sbuff_err_t char ** out
Definition value.h:1061
Generated by   doxygen 1.9.8