src/utils_cmds.h

   1 /**
   2  * collectd - src/utils_cmds.h
   3  * Copyright (C) 2016 Sebastian 'tokkee' Harl
   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  *   Sebastian 'tokkee' Harl <sh at tokkee.org>
  25  **/
  26
  27 #ifndef UTILS_CMDS_H
  28 #define UTILS_CMDS_H 1
  29
  30 #include "plugin.h"
  31
  32 #include <stdarg.h>
  33
  34 typedef enum {
  35         CMD_UNKNOWN = 0,
  36         CMD_FLUSH   = 1,
  37         CMD_GETVAL  = 2,
  38         CMD_LISTVAL = 3,
  39         CMD_PUTVAL  = 4,
  40 } cmd_type_t;
  41 #define CMD_TO_STRING(type) \
  42         ((type) == CMD_FLUSH) ? "FLUSH" \
  43                 : ((type) == CMD_GETVAL) ? "GETVAL" \
  44                 : ((type) == CMD_LISTVAL) ? "LISTVAL" \
  45                 : ((type) == CMD_PUTVAL) ? "PUTVAL" \
  46                 : "UNKNOWN"
  47
  48 typedef struct {
  49         double timeout;
  50
  51         char **plugins;
  52         size_t plugins_num;
  53         identifier_t *identifiers;
  54         size_t identifiers_num;
  55 } cmd_flush_t;
  56
  57 typedef struct {
  58         char *raw_identifier;
  59         identifier_t identifier;
  60 } cmd_getval_t;
  61
  62 typedef struct {
  63 } cmd_listval_t;
  64
  65 typedef struct {
  66         /* The raw identifier as provided by the user. */
  67         char *raw_identifier;
  68
  69         /* An array of the fully parsed identifier and all value lists, and their
  70          * options as provided by the user. */
  71         value_list_t *vl;
  72         size_t vl_num;
  73 } cmd_putval_t;
  74
  75 /*
  76  * NAME
  77  *   cmd_t
  78  *
  79  * DESCRIPTION
  80  *   The representation of a fully parsed command.
  81  */
  82 typedef struct {
  83         cmd_type_t type;
  84         union {
  85                 cmd_flush_t flush;
  86                 cmd_getval_t getval;
  87                 cmd_listval_t listval;
  88                 cmd_putval_t putval;
  89         } cmd;
  90 } cmd_t;
  91
  92 /*
  93  * NAME
  94  *   cmd_status_t
  95  *
  96  * DESCRIPTION
  97  *   Status codes describing the parse result.
  98  */
  99 typedef enum {
 100         CMD_OK              =  0,
 101         CMD_ERROR           = -1,
 102         CMD_PARSE_ERROR     = -2,
 103         CMD_UNKNOWN_COMMAND = -3,
 104
 105         /* Not necessarily fatal errors. */
 106         CMD_NO_OPTION       =  1,
 107 } cmd_status_t;
 108
 109 /*
 110  * NAME
 111  *   cmd_error_handler_t
 112  *
 113  * DESCRIPTION
 114  *   An error handler describes a callback to be invoked when the parser
 115  *   encounters an error. The user data pointer will be passed to the callback
 116  *   as the first argument.
 117  */
 118 typedef struct {
 119         void (*cb) (void *, cmd_status_t, const char *, va_list);
 120         void *ud;
 121 } cmd_error_handler_t;
 122
 123 /*
 124  * NAME:
 125  *   cmd_error
 126  *
 127  * DESCRIPTION
 128  *   Reports an error via the specified error handler (if set).
 129  */
 130 void cmd_error (cmd_status_t status, cmd_error_handler_t *err,
 131                 const char *format, ...);
 132
 133 /*
 134  * NAME
 135  *   cmd_parse
 136  *
 137  * DESCRIPTION
 138  *   Parse a command string and populate a command object.
 139  *
 140  * PARAMETERS
 141  *   `buffer'  The command string to be parsed.
 142  *   `ret_cmd' The parse result will be stored at this location.
 143  *   `err'     An optional error handler to invoke on error.
 144  *
 145  * RETURN VALUE
 146  *   CMD_OK on success or the respective error code otherwise.
 147  */
 148 cmd_status_t cmd_parse (char *buffer,
 149                 cmd_t *ret_cmd, cmd_error_handler_t *err);
 150
 151 cmd_status_t cmd_parsev (size_t argc, char **argv,
 152                 cmd_t *ret_cmd, cmd_error_handler_t *err);
 153
 154 void cmd_destroy (cmd_t *cmd);
 155
 156 /*
 157  * NAME
 158  *   cmd_parse_option
 159  *
 160  * DESCRIPTION
 161  *   Parses a command option which must be of the form:
 162  *     name=value with \ and spaces
 163  *
 164  * PARAMETERS
 165  *   `field'     The parsed input field with any quotes removed and special
 166  *               characters unescaped.
 167  *   `ret_key'   The parsed key will be stored at this location.
 168  *   `ret_value' The parsed value will be stored at this location.
 169  *
 170  * RETURN VALUE
 171  *   CMD_OK on success or an error code otherwise.
 172  *   CMD_NO_OPTION if `field' does not represent an option at all (missing
 173  *   equal sign).
 174  */
 175 cmd_status_t cmd_parse_option (char *field,
 176                 char **ret_key, char **ret_value, cmd_error_handler_t *err);
 177
 178 /*
 179  * NAME
 180  *   cmd_error_fh
 181  *
 182  * DESCRIPTION
 183  *   An error callback writing the message to an open file handle using the
 184  *   format expected by the unixsock or exec plugins.
 185  *
 186  * PARAMETERS
 187  *   `ud'     Error handler user-data pointer. This must be an open
 188  *            file-handle (FILE *).
 189  *   `status' The error status code.
 190  *   `format' Printf-style format string.
 191  *   `ap'     Variable argument list providing the arguments for the format
 192  *            string.
 193  */
 194 void cmd_error_fh (void *ud, cmd_status_t status,
 195                 const char *format, va_list ap);
 196
 197 #endif /* UTILS_CMDS_H */