command parser: Add support for the GETVAL command.
[collectd.git] / src / utils_cmd_getval.c
1 /**
2  * collectd - src/utils_cmd_getval.c
3  * Copyright (C) 2008       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 "common.h"
30 #include "plugin.h"
31
32 #include "utils_cache.h"
33 #include "utils_parse_option.h"
34 #include "utils_cmd_getval.h"
35
36 cmd_status_t cmd_parse_getval (size_t argc, char **argv,
37     cmd_getval_t *ret_getval, cmd_error_handler_t *err)
38 {
39   char *identifier_copy;
40   int status;
41
42   if (argc != 1)
43   {
44     if (argc == 0)
45       cmd_error (CMD_PARSE_ERROR, err, "Missing identifier.");
46     else
47       cmd_error (CMD_PARSE_ERROR, err,
48           "Garbage after identifier: `%s'.", argv[1]);
49     return (CMD_PARSE_ERROR);
50   }
51
52   /* parse_identifier() modifies its first argument,
53    * returning pointers into it */
54   identifier_copy = sstrdup (argv[0]);
55
56   status = parse_identifier (argv[0], &ret_getval->identifier.host,
57       &ret_getval->identifier.plugin, &ret_getval->identifier.plugin_instance,
58       &ret_getval->identifier.type, &ret_getval->identifier.type_instance);
59   if (status != 0)
60   {
61     DEBUG ("cmd_parse_getval: Cannot parse identifier `%s'.", identifier_copy);
62     cmd_error (CMD_PARSE_ERROR, err,
63         "Cannot parse identifier `%s'.", identifier_copy);
64     sfree (identifier_copy);
65     return (CMD_PARSE_ERROR);
66   }
67
68   ret_getval->raw_identifier = identifier_copy;
69   return (CMD_OK);
70 } /* cmd_status_t cmd_parse_getval */
71
72 #define print_to_socket(fh, ...) \
73   do { \
74     if (fprintf (fh, __VA_ARGS__) < 0) { \
75       char errbuf[1024]; \
76       WARNING ("cmd_handle_getval: failed to write to socket #%i: %s", \
77           fileno (fh), sstrerror (errno, errbuf, sizeof (errbuf))); \
78       return -1; \
79     } \
80     fflush(fh); \
81   } while (0)
82
83 cmd_status_t cmd_handle_getval (FILE *fh, char *buffer)
84 {
85   cmd_error_handler_t err = { cmd_error_fh, fh };
86   cmd_status_t status;
87   cmd_t cmd;
88
89   gauge_t *values;
90   size_t values_num;
91
92   const data_set_t *ds;
93
94
95   if ((fh == NULL) || (buffer == NULL))
96     return (-1);
97
98   DEBUG ("utils_cmd_getval: cmd_handle_getval (fh = %p, buffer = %s);",
99       (void *) fh, buffer);
100
101   if ((status = cmd_parse (buffer, &cmd, &err)) != CMD_OK)
102     return (status);
103   if (cmd.type != CMD_GETVAL)
104   {
105     cmd_error (CMD_UNKNOWN_COMMAND, &err,
106         "Unexpected command: `%s'.", CMD_TO_STRING (cmd.type));
107     cmd_destroy (&cmd);
108     return (CMD_UNKNOWN_COMMAND);
109   }
110
111   ds = plugin_get_ds (cmd.cmd.getval.identifier.type);
112   if (ds == NULL)
113   {
114     DEBUG ("cmd_handle_getval: plugin_get_ds (%s) == NULL;",
115         cmd.cmd.getval.identifier.type);
116     cmd_error (CMD_ERROR, &err, "Type `%s' is unknown.\n",
117         cmd.cmd.getval.identifier.type);
118     cmd_destroy (&cmd);
119     return (-1);
120   }
121
122   values = NULL;
123   values_num = 0;
124   status = uc_get_rate_by_name (cmd.cmd.getval.raw_identifier, &values, &values_num);
125   if (status != 0)
126   {
127     cmd_error (CMD_ERROR, &err, "No such value.");
128     cmd_destroy (&cmd);
129     return (CMD_ERROR);
130   }
131
132   if (ds->ds_num != values_num)
133   {
134     ERROR ("ds[%s]->ds_num = %zu, "
135         "but uc_get_rate_by_name returned %zu values.",
136         ds->type, ds->ds_num, values_num);
137     cmd_error (CMD_ERROR, &err, "Error reading value from cache.");
138     sfree (values);
139     cmd_destroy (&cmd);
140     return (CMD_ERROR);
141   }
142
143   print_to_socket (fh, "%zu Value%s found\n", values_num,
144       (values_num == 1) ? "" : "s");
145   for (size_t i = 0; i < values_num; i++)
146   {
147     print_to_socket (fh, "%s=", ds->ds[i].name);
148     if (isnan (values[i]))
149     {
150       print_to_socket (fh, "NaN\n");
151     }
152     else
153     {
154       print_to_socket (fh, "%12e\n", values[i]);
155     }
156   }
157
158   sfree (values);
159   cmd_destroy (&cmd);
160
161   return (CMD_OK);
162 } /* cmd_status_t cmd_handle_getval */
163
164 void cmd_destroy_getval (cmd_getval_t *getval)
165 {
166   if (getval == NULL)
167     return;
168
169   sfree (getval->raw_identifier);
170 } /* void cmd_destroy_getval */
171
172 /* vim: set sw=2 sts=2 ts=8 : */