1 #ifndef _BUFFER_H_
2 #define _BUFFER_H_
3 #include "first.h"
4
5 struct tm; /* declaration */
6
7 /**
8 * max size of a buffer which will just be reset
9 * to ->used = 0 instead of really freeing the buffer
10 */
11 #define BUFFER_MAX_REUSE_SIZE 4096
12
13 /* generic string + binary data container; contains a terminating 0 in both
14 * cases
15 *
16 * used == 0 indicates a special "empty" state (unset config values);
17 * ptr might be NULL, too.
18 *
19 * copy/append functions will ensure used >= 1
20 * (i.e. never leave it in the special empty state)
21 */
22 typedef struct {
23 char *ptr;
24
25 /* "used" includes a terminating 0 */
26 uint32_t used;
27 /* size of allocated buffer at *ptr */
28 uint32_t size;
29 } buffer;
30
31 /* create new buffer; either empty or copy given data */
32 __attribute_malloc__
33 __attribute_returns_nonnull__
34 buffer* buffer_init(void);
35
36 void buffer_free(buffer *b); /* b can be NULL */
37
38 /* reset b. if NULL != b && NULL != src, move src content to b. reset src. */
39 __attribute_nonnull__()
40 void buffer_move(buffer * restrict b, buffer * restrict src);
41
42 /* make sure buffer is large enough to store a string of given size
43 * and a terminating zero.
44 * sets b to an empty string, and may drop old content.
45 * @return b->ptr
46 */
47 __attribute_nonnull__()
48 __attribute_returns_nonnull__
49 char* buffer_string_prepare_copy(buffer *b, size_t size);
50
51 /* allocate buffer large enough to be able to append a string of given size
52 * if b was empty (used == 0) it will contain an empty string (used == 1)
53 * afterwards
54 * "used" data is preserved; if not empty buffer must contain a
55 * zero terminated string.
56 */
57 __attribute_nonnull__()
58 __attribute_returns_nonnull__
59 char* buffer_string_prepare_append(buffer *b, size_t size);
60
61 /* extend and modify buffer for immediate addition of x bytes (differs from
62 * buffer_string_prepare_append() which only ensures space is available)
63 * returns pointer to which callers should immediately write x bytes
64 */
65 __attribute_nonnull__()
66 __attribute_returns_nonnull__
67 char* buffer_extend(buffer * const restrict b, size_t x);
68
69 /* use after prepare_(copy,append) when you have written data to the buffer
70 * to increase the buffer length by size. also sets the terminating zero.
71 * requires enough space is present for the terminating zero (prepare with the
72 * same size to be sure).
73 */
74 __attribute_nonnull__()
75 void buffer_commit(buffer *b, size_t size);
76
77 /* clear buffer
78 * - invalidate buffer contents
79 * - unsets used chars but does not modify existing ptr contents
80 * (b->ptr *is not* set to an empty, '\0'-terminated string "")
81 */
82 __attribute_nonnull__()
83 static inline void buffer_clear(buffer *b);
84
85 /* reset buffer
86 * - invalidate buffer contents
87 * - unsets used chars
88 * - keeps smaller buffer (unmodified) for reuse
89 * (b->ptr *is not* set to an empty, '\0'-terminated string "")
90 * - frees larger buffer (b->size > BUFFER_MAX_REUSE_SIZE)
91 */
92 __attribute_nonnull__()
93 static inline void buffer_reset(buffer *b);
94
95 /* free buffer ptr
96 * - invalidate buffer contents; free ptr; reset ptr, used, size to 0
97 */
98 __attribute_cold__
99 __attribute_nonnull__()
100 void buffer_free_ptr(buffer *b);
101
102 void buffer_copy_string(buffer * restrict b, const char * restrict s);
103 void buffer_copy_string_len(buffer * restrict b, const char * restrict s, size_t len);
104 void buffer_copy_string_len_lc(buffer * restrict b, const char * restrict s, size_t len);
105
106 void buffer_append_string(buffer * restrict b, const char * restrict s);
107 void buffer_append_string_len(buffer * restrict b, const char * restrict s, size_t len);
108 void buffer_append_str2(buffer * restrict b, const char *s1, size_t len1, const char *s2, size_t len2);
109 void buffer_append_str3(buffer * restrict b, const char *s1, size_t len1, const char *s2, size_t len2, const char *s3, size_t len3);
110
111 #ifndef LI_CONST_IOVEC
112 #define LI_CONST_IOVEC
113 struct const_iovec {
114 const void *iov_base;
115 size_t iov_len;
116 };
117 #endif
118
119 __attribute_nonnull__()
120 void buffer_append_iovec(buffer * restrict b, const struct const_iovec *iov, size_t n);
121
122 #define buffer_append_uint_hex(b,len) buffer_append_uint_hex_lc((b),(len))
123 __attribute_nonnull__()
124 void buffer_append_uint_hex_lc(buffer *b, uintmax_t len);
125 __attribute_nonnull__()
126 void buffer_append_int(buffer *b, intmax_t val);
127
128 void buffer_append_strftime(buffer * restrict b, const char * restrict format, const struct tm * restrict tm);
129
130 /* '-', log_10 (2^bits) = bits * log 2 / log 10 < bits * 0.31, terminating 0 */
131 #define LI_ITOSTRING_LENGTH (2 + (8 * sizeof(intmax_t) * 31 + 99) / 100)
132
133 __attribute_nonnull__()
134 size_t li_itostrn(char *buf, size_t buf_len, intmax_t val);
135 __attribute_nonnull__()
136 size_t li_utostrn(char *buf, size_t buf_len, uintmax_t val);
137
138 /* buf must be (at least) 2*s_len + 1 big. uses lower-case hex letters. */
139 #define li_tohex(buf,buf_len,s,s_len) li_tohex_lc((buf),(buf_len),(s),(s_len))
140 __attribute_nonnull__()
141 void li_tohex_lc(char * restrict buf, size_t buf_len, const char * restrict s, size_t s_len);
142 __attribute_nonnull__()
143 void li_tohex_uc(char * restrict buf, size_t buf_len, const char * restrict s, size_t s_len);
144
145 __attribute_nonnull__()
146 __attribute_pure__
147 int buffer_eq_icase_ssn(const char * const a, const char * const b, const size_t len);
148
149 __attribute_nonnull__()
150 __attribute_pure__
151 int buffer_eq_icase_ss(const char * const a, const size_t alen, const char * const b, const size_t blen);
152
153 __attribute_nonnull__()
154 __attribute_pure__
155 int buffer_eq_icase_slen(const buffer * const b, const char * const s, const size_t slen);
156
157 __attribute_nonnull__()
158 __attribute_pure__
159 int buffer_eq_slen(const buffer * const b, const char * const s, const size_t slen);
160
161 __attribute_nonnull__()
162 __attribute_pure__
163 int buffer_is_equal(const buffer *a, const buffer *b);
164
165 __attribute_nonnull__()
166 void buffer_substr_replace (buffer * restrict b, size_t offset, size_t len, const buffer * restrict replace);
167
168 __attribute_nonnull__()
169 void buffer_append_string_encoded_hex_lc(buffer * restrict b, const char * restrict s, size_t len);
170 __attribute_nonnull__()
171 void buffer_append_string_encoded_hex_uc(buffer * restrict b, const char * restrict s, size_t len);
172
173 typedef enum {
174 ENCODING_REL_URI, /* for coding a rel-uri (/with space/and%percent) nicely as part of a href */
175 ENCODING_REL_URI_PART, /* same as ENC_REL_URL plus coding / too as %2F */
176 ENCODING_HTML, /* & becomes & and so on */
177 ENCODING_MINIMAL_XML /* minimal encoding for xml */
178 } buffer_encoding_t;
179
180 void buffer_append_string_encoded(buffer * restrict b, const char * restrict s, size_t s_len, buffer_encoding_t encoding);
181
182 /* escape non-printable characters; simple escapes for \t, \r, \n; fallback to \xCC */
183 __attribute_nonnull__()
184 void buffer_append_string_c_escaped(buffer * restrict b, const char * restrict s, size_t s_len);
185
186 /* escape non-printable chars, '"', '\\', and chars which high bit set */
187 void buffer_append_bs_escaped (buffer * restrict b, const char * restrict s, size_t len);
188 void buffer_append_bs_escaped_json (buffer * restrict b, const char * restrict s, size_t len);
189
190 __attribute_nonnull__()
191 void buffer_urldecode_path(buffer *b);
192
193 __attribute_nonnull__()
194 __attribute_pure__
195 int buffer_is_valid_UTF8(const buffer *b);
196
197 __attribute_nonnull__()
198 void buffer_path_simplify(buffer *b);
199
200 __attribute_nonnull__()
201 void buffer_to_lower(buffer *b);
202 __attribute_nonnull__()
203 void buffer_to_upper(buffer *b);
204
205
206 /** deprecated */
207 __attribute_const__
208 char hex2int(unsigned char c);
209
210 int li_hex2bin (unsigned char *bin, size_t binlen, const char *hexstr, size_t len);
211
212 __attribute_pure__
213 static inline int light_isdigit(int c);
light_isdigit(int c)214 static inline int light_isdigit(int c) {
215 return ((uint32_t)c-'0' <= '9'-'0');
216 }
217
218 __attribute_pure__
219 static inline int light_isxdigit(int c);
light_isxdigit(int c)220 static inline int light_isxdigit(int c) {
221 return light_isdigit(c) || (((uint32_t)c | 0x20)-'a' <= 'f'-'a');
222 }
223
224 __attribute_pure__
225 static inline int light_isalpha(int c);
light_isalpha(int c)226 static inline int light_isalpha(int c) {
227 return (((uint32_t)c | 0x20)-'a' <= 'z'-'a');
228 }
229
230 __attribute_pure__
231 static inline int light_isalnum(int c);
light_isalnum(int c)232 static inline int light_isalnum(int c) {
233 return light_isdigit(c) || light_isalpha(c);
234 }
235
236 #define light_isupper(c) ((uint32_t)(c)-'A' <= 'Z'-'A')
237 #define light_islower(c) ((uint32_t)(c)-'a' <= 'z'-'a')
238
239 #define light_bshift(b) ((uint64_t)1uL << (b))
240 #define light_btst(a,b) ((a) & ((uint64_t)1uL << (b)))
241 #define light_bclr(a,b) ((a) &= ~((uint64_t)1uL << (b)))
242 #define light_bset(a,b) ((a) |= ((uint64_t)1uL << (b)))
243
244
245 void buffer_append_path_len(buffer * restrict b, const char * restrict a, size_t alen); /* join strings with '/', if '/' not present */
246 void buffer_copy_path_len2(buffer * restrict b, const char * restrict s1, size_t len1, const char * restrict s2, size_t len2);
247
248 __attribute_nonnull__()
249 __attribute_pure__
250 static inline int buffer_has_slash_suffix (const buffer * const b);
251
252 __attribute_nonnull__()
253 __attribute_pure__
254 static inline int buffer_has_pathsep_suffix (const buffer * const b);
255
256 #define BUFFER_INTLEN_PTR(x) (int)buffer_clen(x), (x)->ptr
257 #define BUF_PTR_LEN(x) (x)->ptr, buffer_clen(x)
258
259 #define CONST_LEN_STR(x) (uint32_t)sizeof(x)-1, x
260 #define CONST_STR_LEN(x) x, (uint32_t)sizeof(x) - 1
261
262
263 /* inline implementations */
264
265 __attribute_nonnull__()
266 __attribute_pure__
267 static inline int buffer_is_unset(const buffer *b);
buffer_is_unset(const buffer * b)268 static inline int buffer_is_unset(const buffer *b) {
269 return 0 == b->used;
270 }
271
272 __attribute_nonnull__()
273 __attribute_pure__
274 static inline int buffer_is_blank(const buffer *b);
buffer_is_blank(const buffer * b)275 static inline int buffer_is_blank(const buffer *b) {
276 return b->used < 2; /* buffer_is_blank() || buffer_is_unset() */
277 }
278
279 /* buffer "C" len (bytes) */
280 __attribute_nonnull__()
281 __attribute_pure__
282 static inline uint32_t buffer_clen (const buffer *b);
buffer_clen(const buffer * b)283 static inline uint32_t buffer_clen (const buffer *b) {
284 return b->used - (0 != b->used);
285 }
286
287 /* buffer space remaining to append string without reallocating */
288 __attribute_nonnull__()
289 __attribute_pure__
290 static inline uint32_t buffer_string_space(const buffer *b);
buffer_string_space(const buffer * b)291 static inline uint32_t buffer_string_space(const buffer *b) {
292 return b->size ? b->size - (b->used | (0 == b->used)) : 0;
293 }
294
295 __attribute_nonnull__()
296 static inline void buffer_copy_buffer(buffer * restrict b, const buffer * restrict src);
buffer_copy_buffer(buffer * restrict b,const buffer * restrict src)297 static inline void buffer_copy_buffer(buffer * restrict b, const buffer * restrict src) {
298 buffer_copy_string_len(b, BUF_PTR_LEN(src));
299 }
300
301 __attribute_nonnull__()
302 static inline void buffer_append_buffer(buffer * restrict b, const buffer * restrict src);
buffer_append_buffer(buffer * restrict b,const buffer * restrict src)303 static inline void buffer_append_buffer(buffer * restrict b, const buffer * restrict src) {
304 buffer_append_string_len(b, BUF_PTR_LEN(src));
305 }
306
307 __attribute_nonnull__()
308 static inline void buffer_truncate(buffer *b, uint32_t len);
buffer_truncate(buffer * b,uint32_t len)309 static inline void buffer_truncate(buffer *b, uint32_t len) {
310 b->ptr[len] = '\0'; /* b->ptr must exist; use buffer_blank() for trunc 0 */
311 b->used = len + 1;
312 }
313
314 __attribute_nonnull__()
315 static inline void buffer_blank(buffer *b);
buffer_blank(buffer * b)316 static inline void buffer_blank(buffer *b) {
317 b->ptr ? buffer_truncate(b, 0) : (void)buffer_extend(b, 0);
318 }
319
320 __attribute_nonnull__()
321 static inline void buffer_append_char (buffer *b, char c);
buffer_append_char(buffer * b,char c)322 static inline void buffer_append_char (buffer *b, char c) {
323 *(buffer_extend(b, 1)) = c;
324 }
325
326 /* append '/' to non-empty strings not ending in '/' */
327 __attribute_nonnull__()
328 static inline void buffer_append_slash(buffer *b);
buffer_append_slash(buffer * b)329 static inline void buffer_append_slash(buffer *b) {
330 const uint32_t len = buffer_clen(b);
331 if (len > 0 && '/' != b->ptr[len-1])
332 buffer_append_char(b, '/');
333 }
334
buffer_clear(buffer * b)335 static inline void buffer_clear(buffer *b) {
336 b->used = 0;
337 }
338
buffer_reset(buffer * b)339 static inline void buffer_reset(buffer *b) {
340 b->used = 0;
341 /* release buffer larger than BUFFER_MAX_REUSE_SIZE bytes */
342 if (b->size > BUFFER_MAX_REUSE_SIZE) buffer_free_ptr(b);
343 }
344
buffer_has_slash_suffix(const buffer * const b)345 static inline int buffer_has_slash_suffix (const buffer * const b) {
346 return (b->used > 1 && b->ptr[b->used-2] == '/');
347 }
348
buffer_has_pathsep_suffix(const buffer * const b)349 static inline int buffer_has_pathsep_suffix (const buffer * const b) {
350 return (b->used > 1 && b->ptr[b->used-2] == '/');
351 }
352
353
354 /* backwards compat (deprecated; older interfaces) */
355
356 #define buffer_append_string_buffer buffer_append_buffer
357 #define buffer_is_equal_caseless_string buffer_eq_icase_slen
358 #define buffer_is_equal_string buffer_eq_slen
359
360 #define BUFFER_APPEND_STRING_CONST(x, y) \
361 buffer_append_string_len(x, y, sizeof(y) - 1)
362
363 #define BUFFER_COPY_STRING_CONST(x, y) \
364 buffer_copy_string_len(x, y, sizeof(y) - 1)
365
366 #define CONST_BUF_LEN(x) ((x) ? (x)->ptr : NULL), buffer_string_length(x)
367
368 /* NULL buffer or empty buffer (used == 0);
369 * unset "string" (buffer) config options are initialized to used == 0,
370 * while setting an empty string leads to used == 1
371 */
372 __attribute_pure__
373 static inline int buffer_is_empty(const buffer *b);
buffer_is_empty(const buffer * b)374 static inline int buffer_is_empty(const buffer *b) {
375 return NULL == b || buffer_is_unset(b);
376 }
377 /* NULL buffer, empty buffer (used == 0) or empty string (used == 1) */
378 __attribute_pure__
379 static inline int buffer_string_is_empty(const buffer *b);
buffer_string_is_empty(const buffer * b)380 static inline int buffer_string_is_empty(const buffer *b) {
381 return NULL == b || buffer_is_blank(b);
382 }
383
384 /* buffer string length without terminating 0 */
385 __attribute_pure__
386 static inline uint32_t buffer_string_length(const buffer *b);
buffer_string_length(const buffer * b)387 static inline uint32_t buffer_string_length(const buffer *b) {
388 return NULL != b ? buffer_clen(b) : 0;
389 }
390
391 /* sets string length:
392 * - deprecated; use buffer_truncate() or buffer_extend() instead
393 * - always stores a terminating zero to terminate the "new" string
394 * - does not modify the string data apart from terminating zero
395 * - reallocates the buffer iff needed
396 */
397 __attribute_nonnull__()
398 static inline void buffer_string_set_length(buffer *b, uint32_t len);
buffer_string_set_length(buffer * b,uint32_t len)399 static inline void buffer_string_set_length(buffer *b, uint32_t len) {
400 if (len < b->size)
401 buffer_truncate(b, len);
402 else
403 buffer_extend(b, len - buffer_clen(b));
404 }
405
406
407 #include "ck.h"
408 #define force_assert(x) ck_assert(x)
409 #define log_failed_assert(file,line,msg) ck_bt_abort((file),(line),(msg))
410 #define SEGFAULT() ck_bt_abort(__FILE__, __LINE__, "aborted")
411
412
413 #endif
414