src/utils_format_json.c

   1 /**
   2  * collectd - src/utils_format_json.c
   3  * Copyright (C) 2009       Florian octo Forster
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining a
   6  * copy of this software and associated documentation files (the "Software"),
   7  * to deal in the Software without restriction, including without limitation
   8  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   9  * and/or sell copies of the Software, and to permit persons to whom the
  10  * Software is furnished to do so, subject to the following conditions:
  11  *
  12  * The above copyright notice and this permission notice shall be included in
  13  * all copies or substantial portions of the Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  18  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  21  * DEALINGS IN THE SOFTWARE.
  22  *
  23  * Authors:
  24  *   Florian octo Forster <octo at collectd.org>
  25  **/
  26
  27 #include "collectd.h"
  28 #include "plugin.h"
  29 #include "common.h"
  30
  31 #include "utils_cache.h"
  32 #include "utils_format_json.h"
  33
  34 static int json_escape_string (char *buffer, size_t buffer_size, /* {{{ */
  35     const char *string)
  36 {
  37   size_t src_pos;
  38   size_t dst_pos;
  39
  40   if ((buffer == NULL) || (string == NULL))
  41     return (-EINVAL);
  42
  43   if (buffer_size < 3)
  44     return (-ENOMEM);
  45
  46   dst_pos = 0;
  47
  48 #define BUFFER_ADD(c) do { \
  49   if (dst_pos >= (buffer_size - 1)) { \
  50     buffer[buffer_size - 1] = 0; \
  51     return (-ENOMEM); \
  52   } \
  53   buffer[dst_pos] = (c); \
  54   dst_pos++; \
  55 } while (0)
  56
  57   /* Escape special characters */
  58   BUFFER_ADD ('"');
  59   for (src_pos = 0; string[src_pos] != 0; src_pos++)
  60   {
  61     if ((string[src_pos] == '"')
  62         || (string[src_pos] == '\\'))
  63     {
  64       BUFFER_ADD ('\\');
  65       BUFFER_ADD (string[src_pos]);
  66     }
  67     else if (string[src_pos] <= 0x001F)
  68       BUFFER_ADD ('?');
  69     else
  70       BUFFER_ADD (string[src_pos]);
  71   } /* for */
  72   BUFFER_ADD ('"');
  73   buffer[dst_pos] = 0;
  74
  75 #undef BUFFER_ADD
  76
  77   return (0);
  78 } /* }}} int json_escape_string */
  79
  80 static int values_to_json (char *buffer, size_t buffer_size, /* {{{ */
  81                 const data_set_t *ds, const value_list_t *vl, int store_rates)
  82 {
  83   size_t offset = 0;
  84   int i;
  85   gauge_t *rates = NULL;
  86
  87   memset (buffer, 0, buffer_size);
  88
  89 #define BUFFER_ADD(...) do { \
  90   int status; \
  91   status = ssnprintf (buffer + offset, buffer_size - offset, \
  92       __VA_ARGS__); \
  93   if (status < 1) \
  94   { \
  95     sfree(rates); \
  96     return (-1); \
  97   } \
  98   else if (((size_t) status) >= (buffer_size - offset)) \
  99   { \
 100     sfree(rates); \
 101     return (-ENOMEM); \
 102   } \
 103   else \
 104     offset += ((size_t) status); \
 105 } while (0)
 106
 107   BUFFER_ADD ("[");
 108   for (i = 0; i < ds->ds_num; i++)
 109   {
 110     if (i > 0)
 111       BUFFER_ADD (",");
 112
 113     if (ds->ds[i].type == DS_TYPE_GAUGE)
 114     {
 115       if(isfinite (vl->values[i].gauge))
 116         BUFFER_ADD (JSON_GAUGE_FORMAT, vl->values[i].gauge);
 117       else
 118         BUFFER_ADD ("null");
 119     }
 120     else if (store_rates)
 121     {
 122       if (rates == NULL)
 123         rates = uc_get_rate (ds, vl);
 124       if (rates == NULL)
 125       {
 126         WARNING ("utils_format_json: uc_get_rate failed.");
 127         sfree(rates);
 128         return (-1);
 129       }
 130
 131       if(isfinite (rates[i]))
 132         BUFFER_ADD (JSON_GAUGE_FORMAT, rates[i]);
 133       else
 134         BUFFER_ADD ("null");
 135     }
 136     else if (ds->ds[i].type == DS_TYPE_COUNTER)
 137       BUFFER_ADD ("%llu", vl->values[i].counter);
 138     else if (ds->ds[i].type == DS_TYPE_DERIVE)
 139       BUFFER_ADD ("%"PRIi64, vl->values[i].derive);
 140     else if (ds->ds[i].type == DS_TYPE_ABSOLUTE)
 141       BUFFER_ADD ("%"PRIu64, vl->values[i].absolute);
 142     else
 143     {
 144       ERROR ("format_json: Unknown data source type: %i",
 145           ds->ds[i].type);
 146       sfree (rates);
 147       return (-1);
 148     }
 149   } /* for ds->ds_num */
 150   BUFFER_ADD ("]");
 151
 152 #undef BUFFER_ADD
 153
 154   DEBUG ("format_json: values_to_json: buffer = %s;", buffer);
 155   sfree(rates);
 156   return (0);
 157 } /* }}} int values_to_json */
 158
 159 static int dstypes_to_json (char *buffer, size_t buffer_size, /* {{{ */
 160                 const data_set_t *ds)
 161 {
 162   size_t offset = 0;
 163   int i;
 164
 165   memset (buffer, 0, buffer_size);
 166
 167 #define BUFFER_ADD(...) do { \
 168   int status; \
 169   status = ssnprintf (buffer + offset, buffer_size - offset, \
 170       __VA_ARGS__); \
 171   if (status < 1) \
 172     return (-1); \
 173   else if (((size_t) status) >= (buffer_size - offset)) \
 174     return (-ENOMEM); \
 175   else \
 176     offset += ((size_t) status); \
 177 } while (0)
 178
 179   BUFFER_ADD ("[");
 180   for (i = 0; i < ds->ds_num; i++)
 181   {
 182     if (i > 0)
 183       BUFFER_ADD (",");
 184
 185     BUFFER_ADD ("\"%s\"", DS_TYPE_TO_STRING (ds->ds[i].type));
 186   } /* for ds->ds_num */
 187   BUFFER_ADD ("]");
 188
 189 #undef BUFFER_ADD
 190
 191   DEBUG ("format_json: dstypes_to_json: buffer = %s;", buffer);
 192
 193   return (0);
 194 } /* }}} int dstypes_to_json */
 195
 196 static int dsnames_to_json (char *buffer, size_t buffer_size, /* {{{ */
 197                 const data_set_t *ds)
 198 {
 199   size_t offset = 0;
 200   int i;
 201
 202   memset (buffer, 0, buffer_size);
 203
 204 #define BUFFER_ADD(...) do { \
 205   int status; \
 206   status = ssnprintf (buffer + offset, buffer_size - offset, \
 207       __VA_ARGS__); \
 208   if (status < 1) \
 209     return (-1); \
 210   else if (((size_t) status) >= (buffer_size - offset)) \
 211     return (-ENOMEM); \
 212   else \
 213     offset += ((size_t) status); \
 214 } while (0)
 215
 216   BUFFER_ADD ("[");
 217   for (i = 0; i < ds->ds_num; i++)
 218   {
 219     if (i > 0)
 220       BUFFER_ADD (",");
 221
 222     BUFFER_ADD ("\"%s\"", ds->ds[i].name);
 223   } /* for ds->ds_num */
 224   BUFFER_ADD ("]");
 225
 226 #undef BUFFER_ADD
 227
 228   DEBUG ("format_json: dsnames_to_json: buffer = %s;", buffer);
 229
 230   return (0);
 231 } /* }}} int dsnames_to_json */
 232
 233 static int meta_data_keys_to_json (char *buffer, size_t buffer_size, /* {{{ */
 234     meta_data_t *meta, char **keys, size_t keys_num)
 235 {
 236   size_t offset = 0;
 237   int status;
 238   size_t i;
 239
 240   buffer[0] = 0;
 241
 242 #define BUFFER_ADD(...) do { \
 243   status = ssnprintf (buffer + offset, buffer_size - offset, \
 244       __VA_ARGS__); \
 245   if (status < 1) \
 246     return (-1); \
 247   else if (((size_t) status) >= (buffer_size - offset)) \
 248     return (-ENOMEM); \
 249   else \
 250     offset += ((size_t) status); \
 251 } while (0)
 252
 253   for (i = 0; i < keys_num; ++i)
 254   {
 255     int type;
 256     char *key = keys[i];
 257
 258     type = meta_data_type (meta, key);
 259     if (type == MD_TYPE_STRING)
 260     {
 261       char *value = NULL;
 262       if (meta_data_get_string (meta, key, &value) == 0)
 263       {
 264         char temp[512] = "";
 265         json_escape_string (temp, sizeof (temp), value);
 266         sfree (value);
 267         BUFFER_ADD (",\"%s\":%s", key, temp);
 268       }
 269     }
 270     else if (type == MD_TYPE_SIGNED_INT)
 271     {
 272       int64_t value = 0;
 273       if (meta_data_get_signed_int (meta, key, &value) == 0)
 274         BUFFER_ADD (",\"%s\":%"PRIi64, key, value);
 275     }
 276     else if (type == MD_TYPE_UNSIGNED_INT)
 277     {
 278       uint64_t value = 0;
 279       if (meta_data_get_unsigned_int (meta, key, &value) == 0)
 280         BUFFER_ADD (",\"%s\":%"PRIu64, key, value);
 281     }
 282     else if (type == MD_TYPE_DOUBLE)
 283     {
 284       double value = 0.0;
 285       if (meta_data_get_double (meta, key, &value) == 0)
 286         BUFFER_ADD (",\"%s\":%f", key, value);
 287     }
 288     else if (type == MD_TYPE_BOOLEAN)
 289     {
 290       _Bool value = 0;
 291       if (meta_data_get_boolean (meta, key, &value) == 0)
 292         BUFFER_ADD (",\"%s\":%s", key, value ? "true" : "false");
 293     }
 294   } /* for (keys) */
 295
 296   if (offset <= 0)
 297     return (ENOENT);
 298
 299   buffer[0] = '{'; /* replace leading ',' */
 300   BUFFER_ADD ("}");
 301
 302 #undef BUFFER_ADD
 303
 304   return (0);
 305 } /* }}} int meta_data_keys_to_json */
 306
 307 static int meta_data_to_json (char *buffer, size_t buffer_size, /* {{{ */
 308     meta_data_t *meta)
 309 {
 310   char **keys = NULL;
 311   size_t keys_num;
 312   int status;
 313   size_t i;
 314
 315   if ((buffer == NULL) || (buffer_size == 0) || (meta == NULL))
 316     return (EINVAL);
 317
 318   status = meta_data_toc (meta, &keys);
 319   if (status <= 0)
 320     return (status);
 321   keys_num = (size_t) status;
 322
 323   status = meta_data_keys_to_json (buffer, buffer_size, meta, keys, keys_num);
 324
 325   for (i = 0; i < keys_num; ++i)
 326     sfree (keys[i]);
 327   sfree (keys);
 328
 329   return status;
 330 } /* }}} int meta_data_to_json */
 331
 332 static int value_list_to_json (char *buffer, size_t buffer_size, /* {{{ */
 333                 const data_set_t *ds, const value_list_t *vl, int store_rates)
 334 {
 335   char temp[512];
 336   size_t offset = 0;
 337   int status;
 338
 339   memset (buffer, 0, buffer_size);
 340
 341 #define BUFFER_ADD(...) do { \
 342   status = ssnprintf (buffer + offset, buffer_size - offset, \
 343       __VA_ARGS__); \
 344   if (status < 1) \
 345     return (-1); \
 346   else if (((size_t) status) >= (buffer_size - offset)) \
 347     return (-ENOMEM); \
 348   else \
 349     offset += ((size_t) status); \
 350 } while (0)
 351
 352   /* All value lists have a leading comma. The first one will be replaced with
 353    * a square bracket in `format_json_finalize'. */
 354   BUFFER_ADD (",{");
 355
 356   status = values_to_json (temp, sizeof (temp), ds, vl, store_rates);
 357   if (status != 0)
 358     return (status);
 359   BUFFER_ADD ("\"values\":%s", temp);
 360
 361   status = dstypes_to_json (temp, sizeof (temp), ds);
 362   if (status != 0)
 363     return (status);
 364   BUFFER_ADD (",\"dstypes\":%s", temp);
 365
 366   status = dsnames_to_json (temp, sizeof (temp), ds);
 367   if (status != 0)
 368     return (status);
 369   BUFFER_ADD (",\"dsnames\":%s", temp);
 370
 371   BUFFER_ADD (",\"time\":%.3f", CDTIME_T_TO_DOUBLE (vl->time));
 372   BUFFER_ADD (",\"interval\":%.3f", CDTIME_T_TO_DOUBLE (vl->interval));
 373
 374 #define BUFFER_ADD_KEYVAL(key, value) do { \
 375   status = json_escape_string (temp, sizeof (temp), (value)); \
 376   if (status != 0) \
 377     return (status); \
 378   BUFFER_ADD (",\"%s\":%s", (key), temp); \
 379 } while (0)
 380
 381   BUFFER_ADD_KEYVAL ("host", vl->host);
 382   BUFFER_ADD_KEYVAL ("plugin", vl->plugin);
 383   BUFFER_ADD_KEYVAL ("plugin_instance", vl->plugin_instance);
 384   BUFFER_ADD_KEYVAL ("type", vl->type);
 385   BUFFER_ADD_KEYVAL ("type_instance", vl->type_instance);
 386
 387   if (vl->meta != NULL)
 388   {
 389     char meta_buffer[buffer_size];
 390     memset (meta_buffer, 0, sizeof (meta_buffer));
 391     status = meta_data_to_json (meta_buffer, sizeof (meta_buffer), vl->meta);
 392     if (status != 0)
 393       return (status);
 394
 395     BUFFER_ADD (",\"meta\":%s", meta_buffer);
 396   } /* if (vl->meta != NULL) */
 397
 398   BUFFER_ADD ("}");
 399
 400 #undef BUFFER_ADD_KEYVAL
 401 #undef BUFFER_ADD
 402
 403   DEBUG ("format_json: value_list_to_json: buffer = %s;", buffer);
 404
 405   return (0);
 406 } /* }}} int value_list_to_json */
 407
 408 static int format_json_value_list_nocheck (char *buffer, /* {{{ */
 409     size_t *ret_buffer_fill, size_t *ret_buffer_free,
 410     const data_set_t *ds, const value_list_t *vl,
 411     int store_rates, size_t temp_size)
 412 {
 413   char temp[temp_size];
 414   int status;
 415
 416   status = value_list_to_json (temp, sizeof (temp), ds, vl, store_rates);
 417   if (status != 0)
 418     return (status);
 419   temp_size = strlen (temp);
 420
 421   memcpy (buffer + (*ret_buffer_fill), temp, temp_size + 1);
 422   (*ret_buffer_fill) += temp_size;
 423   (*ret_buffer_free) -= temp_size;
 424
 425   return (0);
 426 } /* }}} int format_json_value_list_nocheck */
 427
 428 int format_json_initialize (char *buffer, /* {{{ */
 429     size_t *ret_buffer_fill, size_t *ret_buffer_free)
 430 {
 431   size_t buffer_fill;
 432   size_t buffer_free;
 433
 434   if ((buffer == NULL) || (ret_buffer_fill == NULL) || (ret_buffer_free == NULL))
 435     return (-EINVAL);
 436
 437   buffer_fill = *ret_buffer_fill;
 438   buffer_free = *ret_buffer_free;
 439
 440   buffer_free = buffer_fill + buffer_free;
 441   buffer_fill = 0;
 442
 443   if (buffer_free < 3)
 444     return (-ENOMEM);
 445
 446   memset (buffer, 0, buffer_free);
 447   *ret_buffer_fill = buffer_fill;
 448   *ret_buffer_free = buffer_free;
 449
 450   return (0);
 451 } /* }}} int format_json_initialize */
 452
 453 int format_json_finalize (char *buffer, /* {{{ */
 454     size_t *ret_buffer_fill, size_t *ret_buffer_free)
 455 {
 456   size_t pos;
 457
 458   if ((buffer == NULL) || (ret_buffer_fill == NULL) || (ret_buffer_free == NULL))
 459     return (-EINVAL);
 460
 461   if (*ret_buffer_free < 2)
 462     return (-ENOMEM);
 463
 464   /* Replace the leading comma added in `value_list_to_json' with a square
 465    * bracket. */
 466   if (buffer[0] != ',')
 467     return (-EINVAL);
 468   buffer[0] = '[';
 469
 470   pos = *ret_buffer_fill;
 471   buffer[pos] = ']';
 472   buffer[pos+1] = 0;
 473
 474   (*ret_buffer_fill)++;
 475   (*ret_buffer_free)--;
 476
 477   return (0);
 478 } /* }}} int format_json_finalize */
 479
 480 int format_json_value_list (char *buffer, /* {{{ */
 481     size_t *ret_buffer_fill, size_t *ret_buffer_free,
 482     const data_set_t *ds, const value_list_t *vl, int store_rates)
 483 {
 484   if ((buffer == NULL)
 485       || (ret_buffer_fill == NULL) || (ret_buffer_free == NULL)
 486       || (ds == NULL) || (vl == NULL))
 487     return (-EINVAL);
 488
 489   if (*ret_buffer_free < 3)
 490     return (-ENOMEM);
 491
 492   return (format_json_value_list_nocheck (buffer,
 493         ret_buffer_fill, ret_buffer_free, ds, vl,
 494         store_rates, (*ret_buffer_free) - 2));
 495 } /* }}} int format_json_value_list */
 496
 497 /* vim: set sw=2 sts=2 et fdm=marker : */