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