src/utils_format_json.c

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