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 buffer_add_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 ("%g", 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 ("%g", 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, const value_list_t *vl)
 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, const value_list_t *vl)
 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 value_list_to_json (char *buffer, size_t buffer_size, /* {{{ */
 229                 const data_set_t *ds, const value_list_t *vl, int store_rates)
 230 {
 231   char temp[512];
 232   size_t offset = 0;
 233   int status;
 234
 235   memset (buffer, 0, buffer_size);
 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   /* All value lists have a leading comma. The first one will be replaced with
 249    * a square bracket in `format_json_finalize'. */
 250   BUFFER_ADD (",{");
 251
 252   status = values_to_json (temp, sizeof (temp), ds, vl, store_rates);
 253   if (status != 0)
 254     return (status);
 255   BUFFER_ADD ("\"values\":%s", temp);
 256
 257   status = dstypes_to_json (temp, sizeof (temp), ds, vl);
 258   if (status != 0)
 259     return (status);
 260   BUFFER_ADD (",\"dstypes\":%s", temp);
 261
 262   status = dsnames_to_json (temp, sizeof (temp), ds, vl);
 263   if (status != 0)
 264     return (status);
 265   BUFFER_ADD (",\"dsnames\":%s", temp);
 266
 267   BUFFER_ADD (",\"time\":%.3f", CDTIME_T_TO_DOUBLE (vl->time));
 268   BUFFER_ADD (",\"interval\":%.3f", CDTIME_T_TO_DOUBLE (vl->interval));
 269
 270   if (vl->meta) {
 271     int i, num;
 272     char **table;
 273     meta_data_t *meta = vl->meta;
 274
 275     num = meta_data_toc(meta, &table);
 276     for (i = 0; i < num; ++i) {
 277       int type;
 278       char *string;
 279       int64_t si;
 280       uint64_t ui;
 281       double d;
 282       _Bool b;
 283
 284       type = meta_data_type(meta, table[i]);
 285       if (type == MD_TYPE_STRING) {
 286         if (meta_data_get_string(meta, table[i], &string))
 287           continue;
 288         BUFFER_ADD(",\"%s\":\"%s\"", table[i], string);
 289         free(string);
 290       } else if (type == MD_TYPE_SIGNED_INT) {
 291         if (meta_data_get_signed_int(meta, table[i], &si))
 292           continue;
 293         BUFFER_ADD(",\"%s\":%ld", table[i], si);
 294       } else if (type == MD_TYPE_UNSIGNED_INT) {
 295         if (meta_data_get_unsigned_int(meta, table[i], &ui))
 296           continue;
 297         BUFFER_ADD(",\"%s\":%lu", table[i], ui);
 298       } else if (type == MD_TYPE_DOUBLE) {
 299         if (meta_data_get_double(meta, table[i], &d))
 300           continue;
 301         BUFFER_ADD(",\"%s\":%f", table[i], d);
 302       } else if (type == MD_TYPE_BOOLEAN) {
 303         if (meta_data_get_boolean(meta, table[i], &b))
 304           continue;
 305         if (b)
 306           BUFFER_ADD(",\"%s\":%u", table[i], b);
 307         else
 308           BUFFER_ADD(",\"%s\":%u", table[i], b);
 309       }
 310       free(table[i]);
 311     }
 312     free(table);
 313   }
 314
 315 #define BUFFER_ADD_KEYVAL(key, value) do { \
 316   status = escape_string (temp, sizeof (temp), (value)); \
 317   if (status != 0) \
 318     return (status); \
 319   BUFFER_ADD (",\"%s\":%s", (key), temp); \
 320 } while (0)
 321
 322   BUFFER_ADD_KEYVAL ("host", vl->host);
 323   BUFFER_ADD_KEYVAL ("plugin", vl->plugin);
 324   BUFFER_ADD_KEYVAL ("plugin_instance", vl->plugin_instance);
 325   BUFFER_ADD_KEYVAL ("type", vl->type);
 326   BUFFER_ADD_KEYVAL ("type_instance", vl->type_instance);
 327
 328   BUFFER_ADD ("}");
 329
 330 #undef BUFFER_ADD_KEYVAL
 331 #undef BUFFER_ADD
 332
 333   DEBUG ("format_json: value_list_to_json: buffer = %s;", buffer);
 334
 335   return (0);
 336 } /* }}} int value_list_to_json */
 337
 338 static int format_json_value_list_nocheck (char *buffer, /* {{{ */
 339     size_t *ret_buffer_fill, size_t *ret_buffer_free,
 340     const data_set_t *ds, const value_list_t *vl,
 341     int store_rates, size_t temp_size)
 342 {
 343   char temp[temp_size];
 344   int status;
 345
 346   status = value_list_to_json (temp, sizeof (temp), ds, vl, store_rates);
 347   if (status != 0)
 348     return (status);
 349   temp_size = strlen (temp);
 350
 351   memcpy (buffer + (*ret_buffer_fill), temp, temp_size + 1);
 352   (*ret_buffer_fill) += temp_size;
 353   (*ret_buffer_free) -= temp_size;
 354
 355   return (0);
 356 } /* }}} int format_json_value_list_nocheck */
 357
 358 int format_json_initialize (char *buffer, /* {{{ */
 359     size_t *ret_buffer_fill, size_t *ret_buffer_free)
 360 {
 361   size_t buffer_fill;
 362   size_t buffer_free;
 363
 364   if ((buffer == NULL) || (ret_buffer_fill == NULL) || (ret_buffer_free == NULL))
 365     return (-EINVAL);
 366
 367   buffer_fill = *ret_buffer_fill;
 368   buffer_free = *ret_buffer_free;
 369
 370   buffer_free = buffer_fill + buffer_free;
 371   buffer_fill = 0;
 372
 373   if (buffer_free < 3)
 374     return (-ENOMEM);
 375
 376   memset (buffer, 0, buffer_free);
 377   *ret_buffer_fill = buffer_fill;
 378   *ret_buffer_free = buffer_free;
 379
 380   return (0);
 381 } /* }}} int format_json_initialize */
 382
 383 int format_json_finalize (char *buffer, /* {{{ */
 384     size_t *ret_buffer_fill, size_t *ret_buffer_free)
 385 {
 386   size_t pos;
 387
 388   if ((buffer == NULL) || (ret_buffer_fill == NULL) || (ret_buffer_free == NULL))
 389     return (-EINVAL);
 390
 391   if (*ret_buffer_free < 2)
 392     return (-ENOMEM);
 393
 394   /* Replace the leading comma added in `value_list_to_json' with a square
 395    * bracket. */
 396   if (buffer[0] != ',')
 397     return (-EINVAL);
 398   buffer[0] = '[';
 399
 400   pos = *ret_buffer_fill;
 401   buffer[pos] = ']';
 402   buffer[pos+1] = 0;
 403
 404   (*ret_buffer_fill)++;
 405   (*ret_buffer_free)--;
 406
 407   return (0);
 408 } /* }}} int format_json_finalize */
 409
 410 int format_json_value_list (char *buffer, /* {{{ */
 411     size_t *ret_buffer_fill, size_t *ret_buffer_free,
 412     const data_set_t *ds, const value_list_t *vl, int store_rates)
 413 {
 414   if ((buffer == NULL)
 415       || (ret_buffer_fill == NULL) || (ret_buffer_free == NULL)
 416       || (ds == NULL) || (vl == NULL))
 417     return (-EINVAL);
 418
 419   if (*ret_buffer_free < 3)
 420     return (-ENOMEM);
 421
 422   return (format_json_value_list_nocheck (buffer,
 423         ret_buffer_fill, ret_buffer_free, ds, vl,
 424         store_rates, (*ret_buffer_free) - 2));
 425 } /* }}} int format_json_value_list */
 426
 427 /* vim: set sw=2 sts=2 et fdm=marker : */