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