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 typedef enum { 187 BS_ESCAPE_DEFAULT 188 ,BS_ESCAPE_JSON 189 } buffer_bs_escape_t; 190 191 /* escape non-printable chars, '"', '\\', and chars which high bit set */ 192 void buffer_append_bs_escaped (buffer * restrict b, const char * restrict s, size_t len, buffer_bs_escape_t esc); 193 194 __attribute_nonnull__() 195 void buffer_urldecode_path(buffer *b); 196 197 __attribute_nonnull__() 198 __attribute_pure__ 199 int buffer_is_valid_UTF8(const buffer *b); 200 201 __attribute_nonnull__() 202 void buffer_path_simplify(buffer *b); 203 204 __attribute_nonnull__() 205 void buffer_to_lower(buffer *b); 206 __attribute_nonnull__() 207 void buffer_to_upper(buffer *b); 208 209 210 /** deprecated */ 211 __attribute_const__ 212 char hex2int(unsigned char c); 213 214 int li_hex2bin (unsigned char *bin, size_t binlen, const char *hexstr, size_t len); 215 216 __attribute_pure__ 217 static inline int light_isdigit(int c); 218 static inline int light_isdigit(int c) { 219 return ((uint32_t)c-'0' <= '9'-'0'); 220 } 221 222 __attribute_pure__ 223 static inline int light_isxdigit(int c); 224 static inline int light_isxdigit(int c) { 225 return light_isdigit(c) || (((uint32_t)c | 0x20)-'a' <= 'f'-'a'); 226 } 227 228 __attribute_pure__ 229 static inline int light_isalpha(int c); 230 static inline int light_isalpha(int c) { 231 return (((uint32_t)c | 0x20)-'a' <= 'z'-'a'); 232 } 233 234 __attribute_pure__ 235 static inline int light_isalnum(int c); 236 static inline int light_isalnum(int c) { 237 return light_isdigit(c) || light_isalpha(c); 238 } 239 240 #define light_isupper(c) ((uint32_t)(c)-'A' <= 'Z'-'A') 241 #define light_islower(c) ((uint32_t)(c)-'a' <= 'z'-'a') 242 243 #define light_bshift(b) ((uint64_t)1uL << (b)) 244 #define light_btst(a,b) ((a) & ((uint64_t)1uL << (b))) 245 #define light_bclr(a,b) ((a) &= ~((uint64_t)1uL << (b))) 246 #define light_bset(a,b) ((a) |= ((uint64_t)1uL << (b))) 247 248 249 void buffer_append_path_len(buffer * restrict b, const char * restrict a, size_t alen); /* join strings with '/', if '/' not present */ 250 void buffer_copy_path_len2(buffer * restrict b, const char * restrict s1, size_t len1, const char * restrict s2, size_t len2); 251 252 __attribute_nonnull__() 253 __attribute_pure__ 254 static inline int buffer_has_slash_suffix (const buffer * const b); 255 256 __attribute_nonnull__() 257 __attribute_pure__ 258 static inline int buffer_has_pathsep_suffix (const buffer * const b); 259 260 #define BUFFER_INTLEN_PTR(x) (int)buffer_clen(x), (x)->ptr 261 #define BUF_PTR_LEN(x) (x)->ptr, buffer_clen(x) 262 263 #define CONST_LEN_STR(x) (uint32_t)sizeof(x)-1, x 264 #define CONST_STR_LEN(x) x, (uint32_t)sizeof(x) - 1 265 266 267 /* inline implementations */ 268 269 __attribute_nonnull__() 270 __attribute_pure__ 271 static inline int buffer_is_unset(const buffer *b); 272 static inline int buffer_is_unset(const buffer *b) { 273 return 0 == b->used; 274 } 275 276 __attribute_nonnull__() 277 __attribute_pure__ 278 static inline int buffer_is_blank(const buffer *b); 279 static inline int buffer_is_blank(const buffer *b) { 280 return b->used < 2; /* buffer_is_blank() || buffer_is_unset() */ 281 } 282 283 /* buffer "C" len (bytes) */ 284 __attribute_nonnull__() 285 __attribute_pure__ 286 static inline uint32_t buffer_clen (const buffer *b); 287 static inline uint32_t buffer_clen (const buffer *b) { 288 return b->used - (0 != b->used); 289 } 290 291 /* buffer space remaining to append string without reallocating */ 292 __attribute_nonnull__() 293 __attribute_pure__ 294 static inline uint32_t buffer_string_space(const buffer *b); 295 static inline uint32_t buffer_string_space(const buffer *b) { 296 return b->size ? b->size - (b->used | (0 == b->used)) : 0; 297 } 298 299 __attribute_nonnull__() 300 static inline void buffer_copy_buffer(buffer * restrict b, const buffer * restrict src); 301 static inline void buffer_copy_buffer(buffer * restrict b, const buffer * restrict src) { 302 buffer_copy_string_len(b, BUF_PTR_LEN(src)); 303 } 304 305 __attribute_nonnull__() 306 static inline void buffer_append_buffer(buffer * restrict b, const buffer * restrict src); 307 static inline void buffer_append_buffer(buffer * restrict b, const buffer * restrict src) { 308 buffer_append_string_len(b, BUF_PTR_LEN(src)); 309 } 310 311 __attribute_nonnull__() 312 static inline void buffer_truncate(buffer *b, uint32_t len); 313 static inline void buffer_truncate(buffer *b, uint32_t len) { 314 b->ptr[len] = '\0'; /* b->ptr must exist; use buffer_blank() for trunc 0 */ 315 b->used = len + 1; 316 } 317 318 __attribute_nonnull__() 319 static inline void buffer_blank(buffer *b); 320 static inline void buffer_blank(buffer *b) { 321 b->ptr ? buffer_truncate(b, 0) : (void)buffer_extend(b, 0); 322 } 323 324 __attribute_nonnull__() 325 static inline void buffer_append_char (buffer *b, char c); 326 static inline void buffer_append_char (buffer *b, char c) { 327 *(buffer_extend(b, 1)) = c; 328 } 329 330 /* append '/' to non-empty strings not ending in '/' */ 331 __attribute_nonnull__() 332 static inline void buffer_append_slash(buffer *b); 333 static inline void buffer_append_slash(buffer *b) { 334 const uint32_t len = buffer_clen(b); 335 if (len > 0 && '/' != b->ptr[len-1]) 336 buffer_append_char(b, '/'); 337 } 338 339 static inline void buffer_clear(buffer *b) { 340 b->used = 0; 341 } 342 343 static inline void buffer_reset(buffer *b) { 344 b->used = 0; 345 /* release buffer larger than BUFFER_MAX_REUSE_SIZE bytes */ 346 if (b->size > BUFFER_MAX_REUSE_SIZE) buffer_free_ptr(b); 347 } 348 349 static inline int buffer_has_slash_suffix (const buffer * const b) { 350 return (b->used > 1 && b->ptr[b->used-2] == '/'); 351 } 352 353 static inline int buffer_has_pathsep_suffix (const buffer * const b) { 354 return (b->used > 1 && b->ptr[b->used-2] == '/'); 355 } 356 357 358 /* backwards compat (deprecated; older interfaces) */ 359 360 #define buffer_append_string_buffer buffer_append_buffer 361 #define buffer_is_equal_caseless_string buffer_eq_icase_slen 362 #define buffer_is_equal_string buffer_eq_slen 363 364 #define BUFFER_APPEND_STRING_CONST(x, y) \ 365 buffer_append_string_len(x, y, sizeof(y) - 1) 366 367 #define BUFFER_COPY_STRING_CONST(x, y) \ 368 buffer_copy_string_len(x, y, sizeof(y) - 1) 369 370 #define CONST_BUF_LEN(x) ((x) ? (x)->ptr : NULL), buffer_string_length(x) 371 372 /* NULL buffer or empty buffer (used == 0); 373 * unset "string" (buffer) config options are initialized to used == 0, 374 * while setting an empty string leads to used == 1 375 */ 376 __attribute_pure__ 377 static inline int buffer_is_empty(const buffer *b); 378 static inline int buffer_is_empty(const buffer *b) { 379 return NULL == b || buffer_is_unset(b); 380 } 381 /* NULL buffer, empty buffer (used == 0) or empty string (used == 1) */ 382 __attribute_pure__ 383 static inline int buffer_string_is_empty(const buffer *b); 384 static inline int buffer_string_is_empty(const buffer *b) { 385 return NULL == b || buffer_is_blank(b); 386 } 387 388 /* buffer string length without terminating 0 */ 389 __attribute_pure__ 390 static inline uint32_t buffer_string_length(const buffer *b); 391 static inline uint32_t buffer_string_length(const buffer *b) { 392 return NULL != b ? buffer_clen(b) : 0; 393 } 394 395 /* sets string length: 396 * - deprecated; use buffer_truncate() or buffer_extend() instead 397 * - always stores a terminating zero to terminate the "new" string 398 * - does not modify the string data apart from terminating zero 399 * - reallocates the buffer iff needed 400 */ 401 __attribute_nonnull__() 402 static inline void buffer_string_set_length(buffer *b, uint32_t len); 403 static inline void buffer_string_set_length(buffer *b, uint32_t len) { 404 if (len < b->size) 405 buffer_truncate(b, len); 406 else 407 buffer_extend(b, len - buffer_clen(b)); 408 } 409 410 411 #include "ck.h" 412 #define force_assert(x) ck_assert(x) 413 #define log_failed_assert(file,line,msg) ck_bt_abort((file),(line),(msg)) 414 #define SEGFAULT() ck_bt_abort(__FILE__, __LINE__, "aborted") 415 416 417 #endif 418