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