src/utils_cmd_putval.c

   1 /**
   2  * collectd - src/utils_cmd_putval.c
   3  * Copyright (C) 2007-2009  Florian octo Forster
   4  * Copyright (C) 2016       Sebastian tokkee Harl
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a
   7  * copy of this software and associated documentation files (the "Software"),
   8  * to deal in the Software without restriction, including without limitation
   9  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  10  * and/or sell copies of the Software, and to permit persons to whom the
  11  * Software is furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in
  14  * all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  21  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  22  * DEALINGS IN THE SOFTWARE.
  23  *
  24  * Authors:
  25  *   Florian octo Forster <octo at collectd.org>
  26  *   Sebastian tokkee Harl <sh at tokkee.org>
  27  **/
  28
  29 #include "collectd.h"
  30
  31 #include "common.h"
  32 #include "plugin.h"
  33
  34 #include "utils_cmds.h"
  35 #include "utils_cmd_putval.h"
  36 #include "utils_parse_option.h"
  37 #include "utils_cmd_putval.h"
  38
  39 /*
  40  * private helper functions
  41  */
  42
  43 static int set_option (value_list_t *vl, const char *key, const char *value)
  44 {
  45         if ((vl == NULL) || (key == NULL) || (value == NULL))
  46                 return (-1);
  47
  48         if (strcasecmp ("interval", key) == 0)
  49         {
  50                 double tmp;
  51                 char *endptr;
  52
  53                 endptr = NULL;
  54                 errno = 0;
  55                 tmp = strtod (value, &endptr);
  56
  57                 if ((errno == 0) && (endptr != NULL)
  58                                 && (endptr != value) && (tmp > 0.0))
  59                         vl->interval = DOUBLE_TO_CDTIME_T (tmp);
  60         }
  61         else
  62                 return (1);
  63
  64         return (0);
  65 } /* int set_option */
  66
  67 /*
  68  * public API
  69  */
  70
  71 cmd_status_t cmd_parse_putval (size_t argc, char **argv,
  72                 cmd_putval_t *ret_putval, cmd_error_handler_t *err)
  73 {
  74         cmd_status_t result;
  75
  76         char *identifier;
  77         char *hostname;
  78         char *plugin;
  79         char *plugin_instance;
  80         char *type;
  81         char *type_instance;
  82         int   status;
  83
  84         char *identifier_copy;
  85
  86         const data_set_t *ds;
  87         value_list_t vl = VALUE_LIST_INIT;
  88         size_t i;
  89
  90         if (argc < 2)
  91         {
  92                 cmd_error (CMD_PARSE_ERROR, err,
  93                                 "Missing identifier and/or value-list.");
  94                 return (CMD_PARSE_ERROR);
  95         }
  96
  97         identifier = argv[0];
  98
  99         /* parse_identifier() modifies its first argument, returning pointers into
 100          * it; retain the old value for later. */
 101         identifier_copy = sstrdup (identifier);
 102
 103         status = parse_identifier (identifier, &hostname,
 104                         &plugin, &plugin_instance,
 105                         &type, &type_instance,
 106                         NULL);
 107         if (status != 0)
 108         {
 109                 DEBUG ("cmd_handle_putval: Cannot parse identifier `%s'.",
 110                                 identifier_copy);
 111                 cmd_error (CMD_PARSE_ERROR, err, "Cannot parse identifier `%s'.",
 112                                 identifier_copy);
 113                 sfree (identifier_copy);
 114                 return (CMD_PARSE_ERROR);
 115         }
 116
 117         if ((strlen (hostname) >= sizeof (vl.host))
 118                         || (strlen (plugin) >= sizeof (vl.plugin))
 119                         || ((plugin_instance != NULL)
 120                                 && (strlen (plugin_instance) >= sizeof (vl.plugin_instance)))
 121                         || ((type_instance != NULL)
 122                                 && (strlen (type_instance) >= sizeof (vl.type_instance))))
 123         {
 124                 cmd_error (CMD_PARSE_ERROR, err, "Identifier too long.");
 125                 sfree (identifier_copy);
 126                 return (CMD_PARSE_ERROR);
 127         }
 128
 129         sstrncpy (vl.host, hostname, sizeof (vl.host));
 130         sstrncpy (vl.plugin, plugin, sizeof (vl.plugin));
 131         sstrncpy (vl.type, type, sizeof (vl.type));
 132         if (plugin_instance != NULL)
 133                 sstrncpy (vl.plugin_instance, plugin_instance, sizeof (vl.plugin_instance));
 134         if (type_instance != NULL)
 135                 sstrncpy (vl.type_instance, type_instance, sizeof (vl.type_instance));
 136
 137         ds = plugin_get_ds (type);
 138         if (ds == NULL)
 139         {
 140                 cmd_error (CMD_PARSE_ERROR, err, "1 Type `%s' isn't defined.", type);
 141                 sfree (identifier_copy);
 142                 return (CMD_PARSE_ERROR);
 143         }
 144
 145         hostname = NULL;
 146         plugin = NULL; plugin_instance = NULL;
 147         type = NULL;   type_instance = NULL;
 148
 149         vl.values_len = ds->ds_num;
 150         vl.values = malloc (vl.values_len * sizeof (*vl.values));
 151         if (vl.values == NULL)
 152         {
 153                 cmd_error (CMD_ERROR, err, "malloc failed.");
 154                 sfree (identifier_copy);
 155                 return (CMD_ERROR);
 156         }
 157
 158         ret_putval->raw_identifier = identifier_copy;
 159         if (ret_putval->raw_identifier == NULL)
 160         {
 161                 cmd_error (CMD_ERROR, err, "malloc failed.");
 162                 cmd_destroy_putval (ret_putval);
 163                 sfree (vl.values);
 164                 return (CMD_ERROR);
 165         }
 166
 167         /* All the remaining fields are part of the option list. */
 168         result = CMD_OK;
 169         for (i = 1; i < argc; ++i)
 170         {
 171                 value_list_t *tmp;
 172
 173                 char *key   = NULL;
 174                 char *value = NULL;
 175
 176                 status = cmd_parse_option (argv[i], &key, &value, err);
 177                 if (status == CMD_OK)
 178                 {
 179                         assert (key != NULL);
 180                         assert (value != NULL);
 181                         set_option (&vl, key, value);
 182                         continue;
 183                 }
 184                 else if (status != CMD_NO_OPTION)
 185                 {
 186                         /* parse_option failed, buffer has been modified.
 187                          * => we need to abort */
 188                         result = status;
 189                         break;
 190                 }
 191                 /* else: cmd_parse_option did not find an option; treat this as a
 192                  * value list. */
 193
 194                 status = parse_values (argv[i], &vl, ds);
 195                 if (status != 0)
 196                 {
 197                         cmd_error (CMD_PARSE_ERROR, err, "Parsing the values string failed.");
 198                         result = CMD_PARSE_ERROR;
 199                         break;
 200                 }
 201
 202                 tmp = (value_list_t *) realloc (ret_putval->vl,
 203                                 (ret_putval->vl_num + 1) * sizeof(*ret_putval->vl));
 204                 if (tmp == NULL)
 205                 {
 206                         cmd_error (CMD_ERROR, err, "realloc failed.");
 207                         cmd_destroy_putval (ret_putval);
 208                         result = CMD_ERROR;
 209                         break;
 210                 }
 211
 212                 ret_putval->vl = tmp;
 213                 ret_putval->vl_num++;
 214                 memcpy (&ret_putval->vl[ret_putval->vl_num - 1], &vl, sizeof (vl));
 215         } /* while (*buffer != 0) */
 216         /* Done parsing the options. */
 217
 218         if (result != CMD_OK)
 219         {
 220                 if (ret_putval->vl_num == 0)
 221                         sfree (vl.values);
 222                 cmd_destroy_putval (ret_putval);
 223         }
 224
 225         return (result);
 226 } /* cmd_status_t cmd_parse_putval */
 227
 228 void cmd_destroy_putval (cmd_putval_t *putval)
 229 {
 230         size_t i;
 231
 232         if (putval == NULL)
 233                 return;
 234
 235         sfree (putval->raw_identifier);
 236
 237         for (i = 0; i < putval->vl_num; ++i)
 238         {
 239                 if (i == 0) /* values is shared between all entries */
 240                         sfree (putval->vl[i].values);
 241                 meta_data_destroy (putval->vl[i].meta);
 242                 putval->vl[i].meta = NULL;
 243         }
 244         sfree (putval->vl);
 245         putval->vl = NULL;
 246         putval->vl_num = 0;
 247 } /* void cmd_destroy_putval */
 248
 249 cmd_status_t cmd_handle_putval (FILE *fh, char *buffer)
 250 {
 251         cmd_error_handler_t err = { cmd_error_fh, fh };
 252         cmd_t cmd;
 253         size_t i;
 254
 255         int status;
 256
 257         DEBUG ("utils_cmd_putval: cmd_handle_putval (fh = %p, buffer = %s);",
 258                         (void *) fh, buffer);
 259
 260         if ((status = cmd_parse (buffer, &cmd, &err)) != CMD_OK)
 261                 return (status);
 262         if (cmd.type != CMD_PUTVAL)
 263         {
 264                 cmd_error (CMD_UNKNOWN_COMMAND, &err, "Unexpected command: `%s'.",
 265                                 CMD_TO_STRING (cmd.type));
 266                 cmd_destroy (&cmd);
 267                 return (CMD_UNKNOWN_COMMAND);
 268         }
 269
 270         for (i = 0; i < cmd.cmd.putval.vl_num; ++i)
 271                 plugin_dispatch_values (&cmd.cmd.putval.vl[i]);
 272
 273         if (fh != stdout)
 274                 cmd_error (CMD_OK, &err, "Success: %i %s been dispatched.",
 275                                 (int)cmd.cmd.putval.vl_num,
 276                                 (cmd.cmd.putval.vl_num == 1) ? "value has" : "values have");
 277
 278         cmd_destroy (&cmd);
 279         return (CMD_OK);
 280 } /* int cmd_handle_putval */
 281
 282 int cmd_create_putval (char *ret, size_t ret_len, /* {{{ */
 283         const data_set_t *ds, const value_list_t *vl)
 284 {
 285         char buffer_ident[6 * DATA_MAX_NAME_LEN];
 286         char buffer_values[1024];
 287         int status;
 288
 289         status = FORMAT_VL (buffer_ident, sizeof (buffer_ident), vl);
 290         if (status != 0)
 291                 return (status);
 292         escape_string (buffer_ident, sizeof (buffer_ident));
 293
 294         status = format_values (buffer_values, sizeof (buffer_values),
 295                         ds, vl, /* store rates = */ 0);
 296         if (status != 0)
 297                 return (status);
 298         escape_string (buffer_values, sizeof (buffer_values));
 299
 300         ssnprintf (ret, ret_len,
 301                         "PUTVAL %s interval=%.3f %s",
 302                         buffer_ident,
 303                         (vl->interval > 0)
 304                         ? CDTIME_T_TO_DOUBLE (vl->interval)
 305                         : CDTIME_T_TO_DOUBLE (plugin_get_interval ()),
 306                         buffer_values);
 307
 308         return (0);
 309 } /* }}} int cmd_create_putval */