git.itanic.dy.fi Git - rrdd/blob - onewire_parser.c

   1 #include <stdio.h>
   2 #include <ownetapi.h>
   3 #include <sys/types.h>
   4 #include <sys/stat.h>
   5 #include <fcntl.h>
   6 #include <unistd.h>
   7 #include <math.h>
   8
   9 #include "parser.h"
  10 #include "debug.h"
  11 #include "string.h"
  12 #include "utils.h"
  13 #include "plugin.h"
  14 #include "version.h"
  15 #include "utils.h"
  16
  17 struct owparser_state {
  18         double prev_delta[20];
  19         double prev_data;
  20 };
  21
  22 static struct owparser_state *allocate_parser_state(const char **datastr)
  23 {
  24         int i;
  25
  26         /*
  27          * Count how many sensor entries we need. First entry belongs
  28          * to server address or mount point and last one is NULL. So
  29          * the index final is the count of actual valid sensor
  30          * entries.
  31          */
  32         for (i = 0; datastr[i]; i++)
  33                 ;
  34
  35         return calloc(sizeof(struct owparser_state), i);
  36 }
  37
  38 static double max_glitch_delta(const struct owparser_state *s)
  39 {
  40         double max_delta = 0;
  41         int i;
  42
  43         for (i = 0; i < ARRAY_SIZE(s->prev_delta); i++)
  44                 max_delta = max(s->prev_delta[i], max_delta);
  45
  46         return max_delta;
  47 }
  48
  49 static int might_be_glitch(double data, const struct owparser_state *s)
  50 {
  51         double max_delta, delta;
  52
  53         max_delta = max_glitch_delta(s);
  54
  55         /* Probably no enough data yet, so no glitch detection */
  56         if (max_delta == 0)
  57                 return 0;
  58
  59         /*
  60          * Simple glitch detection. If delta to previous value is more
  61          * than twice as larger as any of the older delta, we might
  62          * have a glitch
  63          */
  64         delta = fabs(data - s->prev_data);
  65
  66         return delta > max_delta * 2;
  67 }
  68
  69 static void update_glitch_data(double data, struct owparser_state *s)
  70 {
  71         double max_delta = 0;
  72         int i;
  73
  74         for (i = 1; i < ARRAY_SIZE(s->prev_delta); i++) {
  75                 s->prev_delta[i - 1] = s->prev_delta[i];
  76                 max_delta = max(s->prev_delta[i], max_delta);
  77         }
  78
  79         /* Avoid storing the first incorrect delta value */
  80         if (s->prev_data || max_delta)
  81                 s->prev_delta[--i] = fabs(data - s->prev_data);
  82
  83         s->prev_data = data;
  84 }
  85
  86 static int parse_opts(const char *str, char *ow_path, size_t pathlen,
  87                 double *offset)
  88 {
  89         char *endptr;
  90         const char *start_str = str;
  91         const char offset_str[] = "offset=";
  92
  93         if (!offset)
  94                 return 0;
  95
  96         /*
  97          * Skip the onewire path entry. Options begin after the first
  98          * white space
  99          */
 100         for (; *str; str++)
 101                 if (isspace(*str))
 102                         break;
 103
 104         /* Copy the onewire path without options */
 105         strncpy(ow_path, start_str, pathlen);
 106         ow_path[str - start_str] = '\0';
 107
 108         /* Get the next non-space, which is where the argument begins */
 109         for (; *str; str++)
 110                 if (!isspace(*str))
 111                         break;
 112
 113         if (strncmp(str, offset_str, sizeof(offset_str) - 1))
 114                 return 0;
 115         str += sizeof(offset_str) - 1;
 116
 117         *offset = strtod(str, &endptr);
 118
 119         if (str != endptr)
 120                 return 1;
 121
 122         return 0;
 123 }
 124
 125 static int make_uncached(char *path, size_t len)
 126 {
 127         char p1[1024], p2[1024], *p = path;
 128
 129         if (strstr(path, "/uncached/"))
 130                 return 0;
 131
 132         p1[sizeof(p1) - 1] = '\0';
 133         p2[sizeof(p2) - 1] = '\0';
 134
 135         /*
 136          * Naively assume the "uncached" string can be put after the
 137          * first slash
 138          */
 139         while (*p && *p != '/')
 140                 p++;
 141
 142         if (!*p)
 143                 return -1;
 144
 145         *p = 0;
 146         p++;
 147
 148         strncpy(p1, path, sizeof(p1) - 1);
 149         strncpy(p2, p, sizeof(p2) - 1);
 150         snprintf(path, len, "%s/uncached/%s", p1, p2);
 151
 152         return 0;
 153 }
 154
 155 static int owfs_read(const char *mount_point, const char *path, char **res)
 156 {
 157         char result[64];
 158         char file[2048];
 159         int fd, ret;
 160
 161         snprintf(file, sizeof(file), "%s/%s", mount_point, path);
 162
 163         fd = open(file, O_RDONLY | O_CLOEXEC);
 164         if (fd < 0) {
 165                 pr_err("Failed to open file %s: %m\n", file);
 166                 return -1;
 167         }
 168
 169         ret = read(fd, result, sizeof(result));
 170         if (ret < 0) {
 171                 pr_err("Failed to read from file %s: %m\n", file);
 172                 goto out_close;
 173         }
 174
 175         *res = strndup(result, sizeof(result));
 176
 177 out_close:
 178         close(fd);
 179
 180         return ret;
 181 }
 182
 183 static int is_mount_point(const char *str)
 184 {
 185         /*
 186          * Filesystem paths begin with a slash, everything else must
 187          * be a network addresses
 188          */
 189         if (str[0] == '/')
 190                 return 1;
 191
 192         return 0;
 193 }
 194
 195 static int onewire_parser(char *rrd_data, const char **parser_data, void **s)
 196 {
 197         OWNET_HANDLE h;
 198         const char *server_addr, *mount_point;
 199         struct owparser_state *state = *s;
 200         char buf[24], *tmp;
 201         int i = 1, ret;
 202         int max_str = RRD_DATA_MAX_LEN;
 203         int is_mountpoint = is_mount_point(parser_data[0]);
 204
 205         if (!parser_data) {
 206                 pr_err("No parser data available\n");
 207                 return -1;
 208         }
 209
 210         if (!state)
 211                 *s = state = allocate_parser_state(parser_data);
 212
 213         if (is_mountpoint) {
 214                 mount_point = parser_data[0];
 215
 216                 if (!mount_point) {
 217                         pr_err("Server address not specified\n");
 218                         return -1;
 219                 }
 220         } else {
 221                 server_addr = parser_data[0];
 222
 223                 if (!server_addr) {
 224                         pr_err("Server address not specified\n");
 225                         return -1;
 226                 }
 227
 228                 h = OWNET_init(server_addr);
 229                 if (h < 0) {
 230                         pr_err("Failed to connect to server %s\n", server_addr);
 231                         return -1;
 232                 }
 233         }
 234
 235         while (parser_data[i]) {
 236                 double offset = 0, data, prev_data = 85;
 237                 char *endptr;
 238                 char ow_path[1024];
 239                 int retries = 0;
 240                 int glitches = 0;
 241
 242                 if (!strcmp("U", parser_data[i])) {
 243 undefined:
 244                         ret = snprintf(rrd_data, max_str, "U");
 245                         max_str -= ret;
 246                         rrd_data += ret;
 247                         goto next;
 248                 }
 249
 250                 parse_opts(parser_data[i], ow_path, sizeof(ow_path), &offset);
 251
 252                 while (1) {
 253                         int fail, j;
 254                         char *tmp2;
 255
 256                         tmp = NULL;
 257                         pr_info("Reading data for entry %s with offset of %.2f\n",
 258                                 ow_path, offset);
 259
 260                         if (is_mountpoint)
 261                                 ret = owfs_read(mount_point, ow_path, &tmp);
 262                         else
 263                                 ret = OWNET_read(h, ow_path, &tmp);
 264
 265                         /* Skip leading white space */
 266                         tmp2 = tmp;
 267                         for (j = 0; j < ret && *tmp2 == ' '; j++)
 268                                 tmp2++;
 269
 270                         if (ret > 0)
 271                                 fail = !strncmp(tmp2, "85", 2);
 272                         else
 273                                 fail = 1;
 274
 275                         if (ret <= 0 || fail)
 276                                 goto retry;
 277
 278
 279                         /*
 280                          * Older versions of OWNET_read did not NULL
 281                          * terminate data.
 282                          */
 283                         memcpy(buf, tmp, min(ret, sizeof(buf) -1));
 284                         buf[ret] = 0;
 285
 286                         data = strtod(buf, &endptr);
 287
 288                         free(tmp);
 289                         tmp = NULL;
 290
 291                         /*
 292                          * If we read the almost same value as
 293                          * previously, it's not a glitch
 294                          */
 295                         if (glitches && prev_data != 85) {
 296                                 double d = max_glitch_delta(&state[i]);
 297
 298                                 if (fabs(data - prev_data) <= d * 2)
 299                                         break;
 300                         }
 301
 302                         if (might_be_glitch(data, &state[i]) &&
 303                                 glitches < 4 && retries < 7) {
 304                                 glitches++;
 305                                 prev_data = data;
 306                                 pr_info("Retrying due to a glitch: %f\n", data);
 307                                 goto retry;
 308                         }
 309
 310                         break;
 311 retry:
 312                         /*
 313                          * In case of failure, retry with uncached
 314                          * data. This is likely to help as it forces a
 315                          * retry even if the sensor is missing from
 316                          * the cache. We treat "85" also as a failure,
 317                          * as temp sensors some times report 85 under
 318                          * faulty conditions.
 319                          */
 320                         ret = make_uncached(ow_path, sizeof(ow_path));
 321                         if (retries >= 10 || ret < 0) {
 322                                 pr_err("Failed to read entry %s: %m\n",
 323                                         parser_data[i]);
 324                                 goto undefined;
 325                         }
 326                         retries++;
 327                         if (tmp)
 328                                 free(tmp);
 329                 }
 330
 331                 update_glitch_data(data, &state[i]);
 332
 333                 if (endptr == buf) {
 334                         pr_err("Failed to parse data %s\n", buf);
 335                         goto undefined;
 336                 }
 337
 338                 data += offset;
 339
 340                 ret = snprintf(rrd_data, max_str, "%f", data);
 341                 max_str -= ret;
 342                 rrd_data += ret;
 343
 344 next:
 345                 i++;
 346                 if (!parser_data[i])
 347                         break;
 348
 349                 ret = snprintf(rrd_data, max_str, ":");
 350                 max_str -= ret;
 351                 rrd_data += ret;
 352         }
 353         rrd_data = 0;
 354
 355         if (!is_mountpoint)
 356                 OWNET_finish();
 357
 358         return 0;
 359 }
 360
 361 static struct parser_info onewire_parser_info = {
 362         .name = "onewire",
 363         .parse = onewire_parser,
 364 };
 365
 366 static int init_onewire_parser(void)
 367 {
 368         return register_parser(&onewire_parser_info);
 369 }
 370
 371 struct plugin_info plugin_info = {
 372         .name = "onewire_parser",
 373         .init = init_onewire_parser,
 374         .version = RRDD_VERSION,
 375 };