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); ptr 17 * might be NULL too then. otherwise an empty string has used == 1 (and ptr[0] 18 * == 0); 19 * 20 * copy/append functions will ensure used >= 1 (i.e. never leave it in the 21 * special empty state); only buffer_copy_buffer will copy the special empty 22 * state. 23 */ 24 typedef struct { 25 char *ptr; 26 27 /* "used" includes a terminating 0 */ 28 uint32_t used; 29 /* size of allocated buffer at *ptr */ 30 uint32_t size; 31 } buffer; 32 33 /* create new buffer; either empty or copy given data */ 34 __attribute_returns_nonnull__ 35 buffer* buffer_init(void); 36 37 __attribute_returns_nonnull__ 38 buffer* buffer_init_buffer(const buffer *src); /* src can be NULL */ 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 void buffer_move(buffer * restrict b, buffer * restrict src); 47 48 /* make sure buffer is large enough to store a string of given size 49 * and a terminating zero. 50 * sets b to an empty string, and may drop old content. 51 * @return b->ptr 52 */ 53 __attribute_returns_nonnull__ 54 char* buffer_string_prepare_copy(buffer *b, size_t size); 55 56 /* allocate buffer large enough to be able to append a string of given size 57 * if b was empty (used == 0) it will contain an empty string (used == 1) 58 * afterwards 59 * "used" data is preserved; if not empty buffer must contain a 60 * zero terminated string. 61 */ 62 __attribute_returns_nonnull__ 63 char* buffer_string_prepare_append(buffer *b, size_t size); 64 65 /* use after prepare_(copy,append) when you have written data to the buffer 66 * to increase the buffer length by size. also sets the terminating zero. 67 * requires enough space is present for the terminating zero (prepare with the 68 * same size to be sure). 69 */ 70 void buffer_commit(buffer *b, size_t size); 71 72 /* sets string length: 73 * - always stores a terminating zero to terminate the "new" string 74 * - does not modify the string data apart from terminating zero 75 * - reallocates the buffer iff needed 76 */ 77 void buffer_string_set_length(buffer *b, uint32_t len); 78 79 /* clear buffer 80 * - invalidate buffer contents 81 * - unsets used chars but does not modify existing ptr contents 82 * (b->ptr *is not* set to an empty, '\0'-terminated string "") 83 */ 84 static inline void buffer_clear(buffer *b); 85 86 /* reset buffer 87 * - invalidate buffer contents 88 * - unsets used chars 89 * - keeps smaller buffer (unmodified) for reuse 90 * (b->ptr *is not* set to an empty, '\0'-terminated string "") 91 * - frees larger buffer (b->size > BUFFER_MAX_REUSE_SIZE) 92 */ 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 void buffer_free_ptr(buffer *b); 100 101 void buffer_copy_string(buffer * restrict b, const char * restrict s); 102 void buffer_copy_string_len(buffer * restrict b, const char * restrict s, size_t s_len); 103 static inline void buffer_copy_buffer(buffer * restrict b, const buffer * restrict src); 104 105 void buffer_append_string(buffer * restrict b, const char * restrict s); 106 void buffer_append_string_len(buffer * restrict b, const char * restrict s, size_t s_len); 107 static inline void buffer_append_string_buffer(buffer * restrict b, const buffer * restrict src); 108 109 #define buffer_append_uint_hex(b,len) buffer_append_uint_hex_lc((b),(len)) 110 void buffer_append_uint_hex_lc(buffer *b, uintmax_t len); 111 void buffer_append_int(buffer *b, intmax_t val); 112 113 void buffer_append_strftime(buffer * restrict b, const char * restrict format, const struct tm * restrict tm); 114 115 /* '-', log_10 (2^bits) = bits * log 2 / log 10 < bits * 0.31, terminating 0 */ 116 #define LI_ITOSTRING_LENGTH (2 + (8 * sizeof(intmax_t) * 31 + 99) / 100) 117 118 size_t li_itostrn(char *buf, size_t buf_len, intmax_t val); 119 size_t li_utostrn(char *buf, size_t buf_len, uintmax_t val); 120 121 /* buf must be (at least) 2*s_len + 1 big. uses lower-case hex letters. */ 122 #define li_tohex(buf,buf_len,s,s_len) li_tohex_lc((buf),(buf_len),(s),(s_len)) 123 void li_tohex_lc(char * restrict buf, size_t buf_len, const char * restrict s, size_t s_len); 124 void li_tohex_uc(char * restrict buf, size_t buf_len, const char * restrict s, size_t s_len); 125 126 /* NULL buffer or empty buffer (used == 0); 127 * unset "string" (buffer) config options are initialized to used == 0, 128 * while setting an empty string leads to used == 1 129 */ 130 __attribute_pure__ 131 static inline int buffer_is_empty(const buffer *b); 132 /* NULL buffer, empty buffer (used == 0) or empty string (used == 1) */ 133 __attribute_pure__ 134 static inline int buffer_string_is_empty(const buffer *b); 135 136 __attribute_pure__ 137 int buffer_eq_icase_ssn(const char * const a, const char * const b, const size_t len); 138 139 __attribute_pure__ 140 int buffer_eq_icase_ss(const char * const a, const size_t alen, const char * const b, const size_t blen); 141 142 __attribute_pure__ 143 int buffer_eq_icase_slen(const buffer * const b, const char * const s, const size_t slen); 144 145 __attribute_pure__ 146 int buffer_eq_slen(const buffer * const b, const char * const s, const size_t slen); 147 148 __attribute_pure__ 149 int buffer_is_equal(const buffer *a, const buffer *b); 150 151 __attribute_pure__ 152 int buffer_is_equal_right_len(const buffer *a, const buffer *b, size_t len); 153 154 __attribute_pure__ 155 int buffer_is_equal_string(const buffer *a, const char *s, size_t b_len); 156 157 __attribute_pure__ 158 int buffer_is_equal_caseless_string(const buffer *a, const char *s, size_t b_len); 159 160 void buffer_substr_replace (buffer * restrict b, size_t offset, size_t len, const buffer * restrict replace); 161 162 void buffer_append_string_encoded_hex_lc(buffer * restrict b, const char * restrict s, size_t len); 163 void buffer_append_string_encoded_hex_uc(buffer * restrict b, const char * restrict s, size_t len); 164 165 typedef enum { 166 ENCODING_REL_URI, /* for coding a rel-uri (/with space/and%percent) nicely as part of a href */ 167 ENCODING_REL_URI_PART, /* same as ENC_REL_URL plus coding / too as %2F */ 168 ENCODING_HTML, /* & becomes & and so on */ 169 ENCODING_MINIMAL_XML /* minimal encoding for xml */ 170 } buffer_encoding_t; 171 172 void buffer_append_string_encoded(buffer * restrict b, const char * restrict s, size_t s_len, buffer_encoding_t encoding); 173 174 /* escape non-printable characters; simple escapes for \t, \r, \n; fallback to \xCC */ 175 void buffer_append_string_c_escaped(buffer * restrict b, const char * restrict s, size_t s_len); 176 177 /* to upper case, replace non alpha-numerics with '_'; if is_http_header prefix with "HTTP_" unless s is "content-type" */ 178 void buffer_copy_string_encoded_cgi_varnames(buffer * restrict b, const char * restrict s, size_t s_len, int is_http_header); 179 180 void buffer_urldecode_path(buffer *url); 181 void buffer_urldecode_query(buffer *url); 182 int buffer_is_valid_UTF8(const buffer *b); 183 void buffer_path_simplify(buffer *dest, buffer *src); 184 185 void buffer_to_lower(buffer *b); 186 void buffer_to_upper(buffer *b); 187 188 189 /** deprecated */ 190 char hex2int(unsigned char c); 191 char int2hex(char i); 192 193 __attribute_pure__ 194 static inline int light_isdigit(int c); 195 static inline int light_isdigit(int c) { 196 return ((uint32_t)c-'0' <= '9'-'0'); 197 } 198 199 __attribute_pure__ 200 static inline int light_isxdigit(int c); 201 static inline int light_isxdigit(int c) { 202 return light_isdigit(c) || (((uint32_t)c | 0x20)-'a' <= 'f'-'a'); 203 } 204 205 __attribute_pure__ 206 static inline int light_isalpha(int c); 207 static inline int light_isalpha(int c) { 208 return (((uint32_t)c | 0x20)-'a' <= 'z'-'a'); 209 } 210 211 __attribute_pure__ 212 static inline int light_isalnum(int c); 213 static inline int light_isalnum(int c) { 214 return light_isdigit(c) || light_isalpha(c); 215 } 216 217 #define light_isupper(c) ((uint32_t)(c)-'A' <= 'Z'-'A') 218 #define light_islower(c) ((uint32_t)(c)-'a' <= 'z'-'a') 219 220 #define light_bshift(b) ((uint64_t)1uL << (b)) 221 #define light_btst(a,b) ((a) & ((uint64_t)1uL << (b))) 222 #define light_bclr(a,b) ((a) &= ~((uint64_t)1uL << (b))) 223 #define light_bset(a,b) ((a) |= ((uint64_t)1uL << (b))) 224 225 226 __attribute_pure__ 227 static inline uint32_t buffer_string_length(const buffer *b); /* buffer string length without terminating 0 */ 228 229 __attribute_pure__ 230 static inline uint32_t buffer_string_space(const buffer *b); /* maximum length of string that can be stored without reallocating */ 231 232 static inline void buffer_append_slash(buffer *b); /* append '/' no non-empty strings not ending in '/' */ 233 void buffer_append_path_len(buffer * restrict b, const char * restrict a, size_t alen); /* join strings with '/', if '/' not present */ 234 235 #define BUFFER_APPEND_STRING_CONST(x, y) \ 236 buffer_append_string_len(x, y, sizeof(y) - 1) 237 238 #define BUFFER_COPY_STRING_CONST(x, y) \ 239 buffer_copy_string_len(x, y, sizeof(y) - 1) 240 241 #define BUFFER_INTLEN_PTR(x) (x)->used ? (int)((x)->used - 1) : 0, (x)->ptr 242 243 #define CONST_LEN_STR(x) (uint32_t)sizeof(x)-1, x 244 #define CONST_STR_LEN(x) x, (uint32_t)sizeof(x) - 1 245 #define CONST_BUF_LEN(x) ((x) ? (x)->ptr : NULL), buffer_string_length(x) 246 247 248 #define LI_NORETURN __attribute_noreturn__ 249 250 __attribute_cold__ 251 void log_failed_assert(const char *filename, unsigned int line, const char *msg) LI_NORETURN; 252 #define force_assert(x) do { if (!(x)) log_failed_assert(__FILE__, __LINE__, "assertion failed: " #x); } while(0) 253 #define SEGFAULT() log_failed_assert(__FILE__, __LINE__, "aborted"); 254 255 /* inline implementations */ 256 257 static inline int buffer_is_empty(const buffer *b) { 258 return NULL == b || 0 == b->used; 259 } 260 static inline int buffer_string_is_empty(const buffer *b) { 261 return NULL == b || b->used < 2; 262 } 263 264 static inline uint32_t buffer_string_length(const buffer *b) { 265 return NULL != b && 0 != b->used ? b->used - 1 : 0; 266 } 267 268 static inline uint32_t buffer_string_space(const buffer *b) { 269 return NULL != b && b->size ? b->size - (b->used | (0 == b->used)) : 0; 270 } 271 272 static inline void buffer_copy_buffer(buffer * restrict b, const buffer * restrict src) { 273 buffer_copy_string_len(b, CONST_BUF_LEN(src)); 274 } 275 276 static inline void buffer_append_string_buffer(buffer * restrict b, const buffer * restrict src) { 277 buffer_append_string_len(b, CONST_BUF_LEN(src)); 278 } 279 280 static inline void buffer_append_slash(buffer *b) { 281 uint32_t len = buffer_string_length(b); 282 if (len > 0 && '/' != b->ptr[len-1]) BUFFER_APPEND_STRING_CONST(b, "/"); 283 } 284 285 static inline void buffer_clear(buffer *b) { 286 b->used = 0; 287 } 288 289 static inline void buffer_reset(buffer *b) { 290 b->used = 0; 291 /* release buffer larger than BUFFER_MAX_REUSE_SIZE bytes */ 292 if (b->size > BUFFER_MAX_REUSE_SIZE) buffer_free_ptr(b); 293 } 294 295 296 #endif 297