src/web_buffer.c

   1 #ifdef HAVE_CONFIG_H
   2 #include <config.h>
   3 #endif
   4 #include <stdlib.h>
   5 #include <string.h>
   6
   7 #ifdef STORAGE_WITH_MATH
   8 #include <math.h>
   9 #endif
  10
  11 #include "common.h"
  12 #include "web_buffer.h"
  13 #include "log.h"
  14
  15 #define BUFFER_OVERFLOW_EOF "EOF"
  16
  17 static inline void buffer_overflow_init(BUFFER *b)
  18 {
  19         b->buffer[b->size] = '\0';
  20         strcpy(&b->buffer[b->size + 1], BUFFER_OVERFLOW_EOF);
  21 }
  22
  23 #ifdef NETDATA_INTERNAL_CHECKS
  24 #define buffer_overflow_check(b) _buffer_overflow_check(b, __FILE__, __FUNCTION__, __LINE__)
  25 #else
  26 #define buffer_overflow_check(b)
  27 #endif
  28
  29 static inline void _buffer_overflow_check(BUFFER *b, const char *file, const char *function, const unsigned long line)
  30 {
  31         if(b->len > b->size) {
  32                 error("BUFFER: length %ld is above size %ld, at line %lu, at function %s() of file '%s'.", b->len, b->size, line, function, file);
  33                 b->len = b->size;
  34         }
  35
  36         if(b->buffer[b->size] != '\0' || strcmp(&b->buffer[b->size + 1], BUFFER_OVERFLOW_EOF)) {
  37                 error("BUFFER: detected overflow at line %lu, at function %s() of file '%s'.", line, function, file);
  38                 buffer_overflow_init(b);
  39         }
  40 }
  41
  42
  43 void buffer_reset(BUFFER *wb)
  44 {
  45         buffer_flush(wb);
  46
  47         wb->contenttype = CT_TEXT_PLAIN;
  48         wb->options = 0;
  49         wb->date = 0;
  50
  51         buffer_overflow_check(wb);
  52 }
  53
  54 const char *buffer_tostring(BUFFER *wb)
  55 {
  56         buffer_need_bytes(wb, 1);
  57         wb->buffer[wb->len] = '\0';
  58
  59         buffer_overflow_check(wb);
  60
  61         return(wb->buffer);
  62 }
  63
  64 void buffer_char_replace(BUFFER *wb, char from, char to)
  65 {
  66         char *s = wb->buffer, *end = &wb->buffer[wb->len];
  67
  68         while(s != end) {
  69                 if(*s == from) *s = to;
  70                 s++;
  71         }
  72
  73         buffer_overflow_check(wb);
  74 }
  75
  76
  77 void buffer_strcat(BUFFER *wb, const char *txt)
  78 {
  79         if(unlikely(!txt || !*txt)) return;
  80
  81         buffer_need_bytes(wb, 1);
  82
  83         char *s = &wb->buffer[wb->len], *start, *end = &wb->buffer[wb->size];
  84         long len = wb->len;
  85
  86         start = s;
  87         while(*txt && s != end)
  88                 *s++ = *txt++;
  89
  90         len += s - start;
  91
  92         wb->len = len;
  93         buffer_overflow_check(wb);
  94
  95         if(*txt) {
  96                 debug(D_WEB_BUFFER, "strcat(): increasing web_buffer at position %ld, size = %ld\n", wb->len, wb->size);
  97                 len = strlen(txt);
  98                 buffer_increase(wb, len);
  99                 buffer_strcat(wb, txt);
 100         }
 101         else {
 102                 // terminate the string
 103                 // without increasing the length
 104                 buffer_need_bytes(wb, (size_t)1);
 105                 wb->buffer[wb->len] = '\0';
 106         }
 107 }
 108
 109
 110 void buffer_snprintf(BUFFER *wb, size_t len, const char *fmt, ...)
 111 {
 112         if(unlikely(!fmt || !*fmt)) return;
 113
 114         buffer_need_bytes(wb, len + 1);
 115
 116         va_list args;
 117         va_start(args, fmt);
 118         wb->len += vsnprintfz(&wb->buffer[wb->len], len, fmt, args);
 119         va_end(args);
 120
 121         buffer_overflow_check(wb);
 122
 123         // the buffer is \0 terminated by vsnprintfz
 124 }
 125
 126 void buffer_vsprintf(BUFFER *wb, const char *fmt, va_list args)
 127 {
 128         if(unlikely(!fmt || !*fmt)) return;
 129
 130         buffer_need_bytes(wb, 2);
 131
 132         size_t len = wb->size - wb->len - 1;
 133
 134         wb->len += vsnprintfz(&wb->buffer[wb->len], len, fmt, args);
 135
 136         buffer_overflow_check(wb);
 137
 138         // the buffer is \0 terminated by vsnprintfz
 139 }
 140
 141 void buffer_sprintf(BUFFER *wb, const char *fmt, ...)
 142 {
 143         if(unlikely(!fmt || !*fmt)) return;
 144
 145         buffer_need_bytes(wb, 2);
 146
 147         size_t len = wb->size - wb->len - 1;
 148         size_t wrote;
 149
 150         va_list args;
 151         va_start(args, fmt);
 152         wrote = (size_t) vsnprintfz(&wb->buffer[wb->len], len, fmt, args);
 153         va_end(args);
 154
 155         if(unlikely(wrote >= len)) {
 156                 // there is bug in vsnprintf() and it returns
 157                 // a number higher to len, but it does not
 158                 // overflow the buffer.
 159                 // our buffer overflow detector will log it
 160                 // if it does.
 161                 buffer_overflow_check(wb);
 162
 163                 debug(D_WEB_BUFFER, "web_buffer_sprintf(): increasing web_buffer at position %ld, size = %ld\n", wb->len, wb->size);
 164                 buffer_need_bytes(wb, len + WEB_DATA_LENGTH_INCREASE_STEP);
 165
 166                 va_start(args, fmt);
 167                 buffer_vsprintf(wb, fmt, args);
 168                 va_end(args);
 169         }
 170         else
 171                 wb->len += wrote;
 172
 173         // the buffer is \0 terminated by vsnprintf
 174 }
 175
 176
 177 void buffer_rrd_value(BUFFER *wb, calculated_number value)
 178 {
 179         buffer_need_bytes(wb, 50);
 180         wb->len += print_calculated_number(&wb->buffer[wb->len], value);
 181
 182         // terminate it
 183         buffer_need_bytes(wb, 1);
 184         wb->buffer[wb->len] = '\0';
 185
 186         buffer_overflow_check(wb);
 187 }
 188
 189 // generate a javascript date, the fastest possible way...
 190 void buffer_jsdate(BUFFER *wb, int year, int month, int day, int hours, int minutes, int seconds)
 191 {
 192   //         10        20        30      = 35
 193         // 01234567890123456789012345678901234
 194         // Date(2014,04,01,03,28,20)
 195
 196         buffer_need_bytes(wb, 30);
 197
 198         char *b = &wb->buffer[wb->len], *p;
 199   unsigned int *q = (unsigned int *)b;
 200
 201   #if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
 202     *q++ = 0x65746144;  // "Date" backwards.
 203   #else
 204     *q++ = 0x44617465;  // "Date"
 205   #endif
 206   p = (char *)q;
 207
 208   *p++ = '(';
 209   *p++ = '0' + year / 1000; year %= 1000;
 210   *p++ = '0' + year / 100;  year %= 100;
 211   *p++ = '0' + year / 10;
 212   *p++ = '0' + year % 10;
 213   *p++ = ',';
 214   *p   = '0' + month / 10; if (*p != '0') p++;
 215   *p++ = '0' + month % 10;
 216   *p++ = ',';
 217   *p   = '0' + day / 10; if (*p != '0') p++;
 218   *p++ = '0' + day % 10;
 219   *p++ = ',';
 220   *p   = '0' + hours / 10; if (*p != '0') p++;
 221   *p++ = '0' + hours % 10;
 222   *p++ = ',';
 223   *p   = '0' + minutes / 10; if (*p != '0') p++;
 224   *p++ = '0' + minutes % 10;
 225   *p++ = ',';
 226   *p   = '0' + seconds / 10; if (*p != '0') p++;
 227   *p++ = '0' + seconds % 10;
 228
 229   unsigned short *r = (unsigned short *)p;
 230
 231 #if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
 232     *r++ = 0x0029;  // ")\0" backwards.
 233   #else
 234     *r++ = 0x2900;  // ")\0"
 235   #endif
 236
 237         wb->len += (size_t)((char *)r - b - 1);
 238
 239         // terminate it
 240         wb->buffer[wb->len] = '\0';
 241         buffer_overflow_check(wb);
 242 }
 243
 244 // generate a date, the fastest possible way...
 245 void buffer_date(BUFFER *wb, int year, int month, int day, int hours, int minutes, int seconds)
 246 {
 247         //         10        20        30      = 35
 248         // 01234567890123456789012345678901234
 249         // 2014-04-01 03:28:20
 250
 251         buffer_need_bytes(wb, 36);
 252
 253         char *b = &wb->buffer[wb->len];
 254   char *p = b;
 255
 256   *p++ = '0' + year / 1000; year %= 1000;
 257   *p++ = '0' + year / 100;  year %= 100;
 258   *p++ = '0' + year / 10;
 259   *p++ = '0' + year % 10;
 260   *p++ = '-';
 261   *p++ = '0' + month / 10;
 262   *p++ = '0' + month % 10;
 263   *p++ = '-';
 264   *p++ = '0' + day / 10;
 265   *p++ = '0' + day % 10;
 266   *p++ = ' ';
 267   *p++ = '0' + hours / 10;
 268   *p++ = '0' + hours % 10;
 269   *p++ = ':';
 270   *p++ = '0' + minutes / 10;
 271   *p++ = '0' + minutes % 10;
 272   *p++ = ':';
 273   *p++ = '0' + seconds / 10;
 274   *p++ = '0' + seconds % 10;
 275   *p = '\0';
 276
 277         wb->len += (size_t)(p - b);
 278
 279         // terminate it
 280         wb->buffer[wb->len] = '\0';
 281         buffer_overflow_check(wb);
 282 }
 283
 284 BUFFER *buffer_create(size_t size)
 285 {
 286         BUFFER *b;
 287
 288         debug(D_WEB_BUFFER, "Creating new web buffer of size %zu.", size);
 289
 290         b = calloc(1, sizeof(BUFFER));
 291         if(!b) {
 292                 error("Cannot allocate a web_buffer.");
 293                 return NULL;
 294         }
 295
 296         b->buffer = malloc(size + sizeof(BUFFER_OVERFLOW_EOF) + 2);
 297         if(!b->buffer) {
 298                 error("Cannot allocate a buffer of size %zu.", size + sizeof(BUFFER_OVERFLOW_EOF) + 2);
 299                 free(b);
 300                 return NULL;
 301         }
 302         b->buffer[0] = '\0';
 303         b->size = size;
 304         b->contenttype = CT_TEXT_PLAIN;
 305         buffer_overflow_init(b);
 306         buffer_overflow_check(b);
 307
 308         return(b);
 309 }
 310
 311 void buffer_free(BUFFER *b)
 312 {
 313         buffer_overflow_check(b);
 314
 315         debug(D_WEB_BUFFER, "Freeing web buffer of size %zu.", b->size);
 316
 317         if(b->buffer) free(b->buffer);
 318         free(b);
 319 }
 320
 321 void buffer_increase(BUFFER *b, size_t free_size_required)
 322 {
 323         buffer_overflow_check(b);
 324
 325         size_t left = b->size - b->len;
 326
 327         if(left >= free_size_required) return;
 328
 329         size_t increase = free_size_required - left;
 330         if(increase < WEB_DATA_LENGTH_INCREASE_STEP) increase = WEB_DATA_LENGTH_INCREASE_STEP;
 331
 332         debug(D_WEB_BUFFER, "Increasing data buffer from size %zu to %zu.", b->size, b->size + increase);
 333
 334         b->buffer = realloc(b->buffer, b->size + increase + sizeof(BUFFER_OVERFLOW_EOF) + 2);
 335         if(!b->buffer)
 336                 fatal("Failed to increase data buffer from size %zu to %zu.",
 337                         b->size + sizeof(BUFFER_OVERFLOW_EOF) + 2,
 338                         b->size + increase + sizeof(BUFFER_OVERFLOW_EOF) + 2);
 339
 340         b->size += increase;
 341
 342         buffer_overflow_init(b);
 343         buffer_overflow_check(b);
 344 }