src/graph_instance.c

   1 #include <stdlib.h>
   2 #include <string.h>
   3 #include <errno.h>
   4 #include <time.h>
   5
   6 #include "graph_instance.h"
   7 #include "graph_def.h"
   8 #include "graph_ident.h"
   9 #include "graph_list.h"
  10 #include "common.h"
  11 #include "utils_cgi.h"
  12
  13 #include <fcgiapp.h>
  14 #include <fcgi_stdio.h>
  15
  16 struct graph_instance_s /* {{{ */
  17 {
  18   graph_ident_t *select;
  19
  20   graph_ident_t **files;
  21   size_t files_num;
  22 }; /* }}} struct graph_instance_s */
  23
  24 struct def_callback_data_s
  25 {
  26   graph_instance_t *inst;
  27   str_array_t *args;
  28 };
  29 typedef struct def_callback_data_s def_callback_data_t;
  30
  31 /*
  32  * Private functions
  33  */
  34 /* Create one DEF for each data source in the file. Called by
  35  * "inst_get_default_defs" for each file. */
  36 static graph_def_t *ident_get_default_defs (graph_config_t *cfg, /* {{{ */
  37     graph_ident_t *ident, graph_def_t *def_head)
  38 {
  39   graph_def_t *defs = NULL;
  40   char *file;
  41   char **dses = NULL;
  42   size_t dses_num = 0;
  43   int status;
  44   size_t i;
  45
  46   if ((cfg == NULL) || (ident == NULL))
  47     return (def_head);
  48
  49   file = ident_to_file (ident);
  50   if (file == NULL)
  51   {
  52     fprintf (stderr, "ident_get_default_defs: ident_to_file failed\n");
  53     return (def_head);
  54   }
  55
  56   status = ds_list_from_rrd_file (file, &dses_num, &dses);
  57   if (status != 0)
  58   {
  59     free (file);
  60     return (def_head);
  61   }
  62
  63   for (i = 0; i < dses_num; i++)
  64   {
  65     graph_def_t *def;
  66
  67     def = def_search (def_head, ident, dses[i]);
  68     if (def != NULL)
  69       continue;
  70
  71     def = def_create (cfg, ident, dses[i]);
  72     if (def == NULL)
  73       continue;
  74
  75     if (defs == NULL)
  76       defs = def;
  77     else
  78       def_append (defs, def);
  79
  80     free (dses[i]);
  81   }
  82
  83   free (dses);
  84   free (file);
  85
  86   return (defs);
  87 } /* }}} int ident_get_default_defs */
  88
  89 /* Create one or more DEFs for each file in the graph instance. The number
  90  * depends on the number of data sources in each of the files. Called from
  91  * "inst_get_rrdargs" if no DEFs are available from the configuration.
  92  * */
  93 static graph_def_t *inst_get_default_defs (graph_config_t *cfg, /* {{{ */
  94     graph_instance_t *inst)
  95 {
  96   graph_def_t *defs = NULL;
  97   size_t i;
  98
  99   if ((cfg == NULL) || (inst == NULL))
 100     return (NULL);
 101
 102   for (i = 0; i < inst->files_num; i++)
 103   {
 104     graph_def_t *def;
 105
 106     def = ident_get_default_defs (cfg, inst->files[i], defs);
 107     if (def == NULL)
 108       continue;
 109
 110     if (defs == NULL)
 111       defs = def;
 112     else
 113       def_append (defs, def);
 114   }
 115
 116   return (defs);
 117 } /* }}} graph_def_t *inst_get_default_defs */
 118
 119 /* Called with each DEF in turn. Calls "def_get_rrdargs" with every appropriate
 120  * file / DEF pair. */
 121 static int gl_instance_get_rrdargs_cb (graph_def_t *def, void *user_data) /* {{{ */
 122 {
 123   def_callback_data_t *data = user_data;
 124   graph_instance_t *inst = data->inst;
 125   str_array_t *args = data->args;
 126
 127   size_t i;
 128
 129   for (i = 0; i < inst->files_num; i++)
 130   {
 131     if (!def_matches (def, inst->files[i]))
 132       continue;
 133
 134     def_get_rrdargs (def, inst->files[i], args);
 135   }
 136
 137   return (0);
 138 } /* }}} int gl_instance_get_rrdargs_cb */
 139
 140 static const char *get_part_from_param (const char *prim_key, /* {{{ */
 141     const char *sec_key)
 142 {
 143   const char *val;
 144
 145   val = param (prim_key);
 146   if (val != NULL)
 147     return (val);
 148
 149   return (param (sec_key));
 150 } /* }}} const char *get_part_from_param */
 151
 152 /*
 153  * Public functions
 154  */
 155 graph_instance_t *inst_create (graph_config_t *cfg, /* {{{ */
 156     const graph_ident_t *ident)
 157 {
 158   graph_instance_t *i;
 159   graph_ident_t *selector;
 160
 161   if ((cfg == NULL) || (ident == NULL))
 162     return (NULL);
 163
 164   i = malloc (sizeof (*i));
 165   if (i == NULL)
 166     return (NULL);
 167   memset (i, 0, sizeof (*i));
 168
 169   selector = graph_get_selector (cfg);
 170   if (selector == NULL)
 171   {
 172     fprintf (stderr, "inst_create: graph_get_selector failed\n");
 173     free (i);
 174     return (NULL);
 175   }
 176
 177   i->select = ident_copy_with_selector (selector, ident,
 178       IDENT_FLAG_REPLACE_ANY);
 179   if (i->select == NULL)
 180   {
 181     fprintf (stderr, "inst_create: ident_copy_with_selector failed\n");
 182     ident_destroy (selector);
 183     free (i);
 184     return (NULL);
 185   }
 186
 187   ident_destroy (selector);
 188
 189   i->files = NULL;
 190   i->files_num = 0;
 191
 192   return (i);
 193 } /* }}} graph_instance_t *inst_create */
 194
 195 void inst_destroy (graph_instance_t *inst) /* {{{ */
 196 {
 197   size_t i;
 198
 199   if (inst == NULL)
 200     return;
 201
 202   ident_destroy (inst->select);
 203
 204   for (i = 0; i < inst->files_num; i++)
 205     ident_destroy (inst->files[i]);
 206   free (inst->files);
 207
 208   free (inst);
 209 } /* }}} void inst_destroy */
 210
 211 int inst_add_file (graph_instance_t *inst, /* {{{ */
 212     const graph_ident_t *file)
 213 {
 214   graph_ident_t **tmp;
 215
 216   tmp = realloc (inst->files, sizeof (*inst->files) * (inst->files_num + 1));
 217   if (tmp == NULL)
 218     return (ENOMEM);
 219   inst->files = tmp;
 220
 221   inst->files[inst->files_num] = ident_clone (file);
 222   if (inst->files[inst->files_num] == NULL)
 223     return (ENOMEM);
 224
 225   inst->files_num++;
 226
 227   return (0);
 228 } /* }}} int inst_add_file */
 229
 230 graph_instance_t *inst_get_selected (graph_config_t *cfg) /* {{{ */
 231 {
 232   const char *host = get_part_from_param ("inst_host", "host");
 233   const char *plugin = get_part_from_param ("inst_plugin", "plugin");
 234   const char *plugin_instance = get_part_from_param ("inst_plugin_instance",
 235       "plugin_instance");
 236   const char *type = get_part_from_param ("inst_type", "type");
 237   const char *type_instance = get_part_from_param ("inst_type_instance",
 238       "type_instance");
 239
 240   graph_ident_t *ident;
 241   graph_instance_t *inst;
 242
 243   if (cfg == NULL)
 244     cfg = gl_graph_get_selected ();
 245
 246   if (cfg == NULL)
 247   {
 248     DEBUG ("inst_get_selected: cfg == NULL;\n");
 249     return (NULL);
 250   }
 251
 252   if ((host == NULL)
 253       || (plugin == NULL) || (plugin_instance == NULL)
 254       || (type == NULL) || (type_instance == NULL))
 255   {
 256     DEBUG ("inst_get_selected: A parameter is NULL.\n");
 257     return (NULL);
 258   }
 259
 260   ident = ident_create (host, plugin, plugin_instance, type, type_instance);
 261   if (ident == NULL)
 262   {
 263     fprintf (stderr, "inst_get_selected: ident_create failed\n");
 264     return (NULL);
 265   }
 266
 267   inst = graph_inst_find_exact (cfg, ident);
 268   ident_destroy (ident);
 269
 270   return (inst);
 271 } /* }}} graph_instance_t *inst_get_selected */
 272
 273 int inst_get_rrdargs (graph_config_t *cfg, /* {{{ */
 274     graph_instance_t *inst,
 275     str_array_t *args)
 276 {
 277   def_callback_data_t data = { inst, args };
 278   graph_def_t *defs;
 279   int status;
 280
 281   if ((cfg == NULL) || (inst == NULL) || (args == NULL))
 282     return (EINVAL);
 283
 284   status = graph_get_rrdargs (cfg, inst, args);
 285   if (status != 0)
 286     return (status);
 287
 288   defs = graph_get_defs (cfg);
 289   if (defs == NULL)
 290   {
 291     defs = inst_get_default_defs (cfg, inst);
 292
 293     if (defs == NULL)
 294       return (-1);
 295
 296     status = def_foreach (defs, gl_instance_get_rrdargs_cb, &data);
 297
 298     def_destroy (defs);
 299   }
 300   else
 301   {
 302     status = def_foreach (defs, gl_instance_get_rrdargs_cb, &data);
 303   }
 304
 305   return (status);
 306 } /* }}} int inst_get_rrdargs */
 307
 308 graph_ident_t *inst_get_selector (graph_instance_t *inst) /* {{{ */
 309 {
 310   if (inst == NULL)
 311     return (NULL);
 312
 313   return (ident_clone (inst->select));
 314 } /* }}} graph_ident_t *inst_get_selector */
 315
 316 int inst_get_params (graph_config_t *cfg, graph_instance_t *inst, /* {{{ */
 317     char *buffer, size_t buffer_size)
 318 {
 319   graph_ident_t *cfg_select;
 320
 321   if ((cfg == NULL) || (inst == NULL)
 322       || (buffer == NULL) || (buffer_size < 1))
 323     return (EINVAL);
 324
 325   cfg_select = graph_get_selector (cfg);
 326   if (cfg_select == NULL)
 327   {
 328     fprintf (stderr, "inst_get_params: graph_get_selector failed");
 329     return (-1);
 330   }
 331
 332   buffer[0] = 0;
 333
 334 #define COPY_FIELD(field) do {                                  \
 335   const char *cfg_f  = ident_get_##field (cfg_select);          \
 336   const char *inst_f = ident_get_##field (inst->select);        \
 337   if (strcmp (cfg_f, inst_f) == 0)                              \
 338   {                                                             \
 339     strlcat (buffer, #field, buffer_size);                      \
 340     strlcat (buffer, "=", buffer_size);                         \
 341     strlcat (buffer, cfg_f, buffer_size);                       \
 342   }                                                             \
 343   else                                                          \
 344   {                                                             \
 345     strlcat (buffer, "graph_", buffer_size);                    \
 346     strlcat (buffer, #field, buffer_size);                      \
 347     strlcat (buffer, "=", buffer_size);                         \
 348     strlcat (buffer, cfg_f, buffer_size);                       \
 349     strlcat (buffer, ";", buffer_size);                         \
 350     strlcat (buffer, "inst_", buffer_size);                     \
 351     strlcat (buffer, #field, buffer_size);                      \
 352     strlcat (buffer, "=", buffer_size);                         \
 353     strlcat (buffer, inst_f, buffer_size);                      \
 354   }                                                             \
 355 } while (0)
 356
 357   COPY_FIELD(host);
 358   strlcat (buffer, ";", buffer_size);
 359   COPY_FIELD(plugin);
 360   strlcat (buffer, ";", buffer_size);
 361   COPY_FIELD(plugin_instance);
 362   strlcat (buffer, ";", buffer_size);
 363   COPY_FIELD(type);
 364   strlcat (buffer, ";", buffer_size);
 365   COPY_FIELD(type_instance);
 366
 367 #undef COPY_FIELD
 368
 369   ident_destroy (cfg_select);
 370
 371   return (0);
 372 } /* }}} int inst_get_params */
 373
 374 int inst_compare_ident (graph_instance_t *inst, /* {{{ */
 375     const graph_ident_t *ident)
 376 {
 377   if ((inst == NULL) || (ident == NULL))
 378     return (0);
 379
 380   return (ident_compare (inst->select, ident));
 381 } /* }}} int inst_compare_ident */
 382
 383 _Bool inst_matches_ident (graph_instance_t *inst, /* {{{ */
 384     const graph_ident_t *ident)
 385 {
 386   if ((inst == NULL) || (ident == NULL))
 387     return (0);
 388
 389   return (ident_matches (inst->select, ident));
 390 } /* }}} _Bool inst_matches_ident */
 391
 392 _Bool inst_matches_string (graph_config_t *cfg, /* {{{ */
 393     graph_instance_t *inst,
 394     const char *term)
 395 {
 396   char buffer[1024];
 397   int status;
 398
 399   if ((cfg == NULL) || (inst == NULL) || (term == NULL))
 400     return (0);
 401
 402   status = inst_describe (cfg, inst, buffer, sizeof (buffer));
 403   if (status != 0)
 404   {
 405     fprintf (stderr, "inst_matches_string: inst_describe failed\n");
 406     return (status);
 407   }
 408
 409   strtolower (buffer);
 410
 411   /* no match */
 412   if (strstr (buffer, term) == NULL)
 413     return (0);
 414
 415   return (1);
 416 } /* }}} _Bool inst_matches_string */
 417
 418 _Bool inst_matches_field (graph_instance_t *inst, /* {{{ */
 419     graph_ident_field_t field, const char *field_value)
 420 {
 421   const char *selector_field;
 422   size_t i;
 423
 424   if ((inst == NULL) || (field_value == NULL))
 425     return (0);
 426
 427   selector_field = ident_get_field (inst->select, field);
 428   if (selector_field == NULL)
 429     return (0);
 430
 431   assert (!IS_ANY (selector_field));
 432   if (!IS_ALL (selector_field))
 433   {
 434     if (strcasecmp (selector_field, field_value) == 0)
 435       return (1);
 436     else
 437       return (0);
 438   }
 439
 440   /* The selector field is an ALL selector
 441    * => we need to check the files to see if the instance matches. */
 442   for (i = 0; i < inst->files_num; i++)
 443   {
 444     selector_field = ident_get_field (inst->files[i], field);
 445     if (selector_field == NULL)
 446       continue;
 447
 448     assert (!IS_ANY (selector_field));
 449     assert (!IS_ALL (selector_field));
 450
 451     if (strcasecmp (selector_field, field_value) == 0)
 452       return (1);
 453   } /* for files */
 454
 455   return (0);
 456 } /* }}} _Bool inst_matches_field */
 457
 458 int inst_describe (graph_config_t *cfg, graph_instance_t *inst, /* {{{ */
 459     char *buffer, size_t buffer_size)
 460 {
 461   graph_ident_t *cfg_select;
 462
 463   if ((cfg == NULL) || (inst == NULL)
 464       || (buffer == NULL) || (buffer_size < 2))
 465     return (EINVAL);
 466
 467   cfg_select = graph_get_selector (cfg);
 468   if (cfg_select == NULL)
 469   {
 470     fprintf (stderr, "inst_describe: graph_get_selector failed\n");
 471     return (-1);
 472   }
 473
 474   buffer[0] = 0;
 475
 476 #define CHECK_FIELD(field) do {                                              \
 477   if (IS_ANY (ident_get_##field (cfg_select)))                               \
 478   {                                                                          \
 479     if (buffer[0] != 0)                                                      \
 480       strlcat (buffer, "/", buffer_size);                                    \
 481     strlcat (buffer, ident_get_##field (inst->select), buffer_size);         \
 482   }                                                                          \
 483 } while (0)
 484
 485   CHECK_FIELD (host);
 486   CHECK_FIELD (plugin);
 487   CHECK_FIELD (plugin_instance);
 488   CHECK_FIELD (type);
 489   CHECK_FIELD (type_instance);
 490
 491 #undef CHECK_FIELD
 492
 493   if (buffer[0] == 0)
 494     strlcat (buffer, "default", buffer_size);
 495
 496   ident_destroy (cfg_select);
 497
 498   return (0);
 499 } /* }}} int inst_describe */
 500
 501 time_t inst_get_mtime (graph_instance_t *inst) /* {{{ */
 502 {
 503   size_t i;
 504   time_t mtime;
 505
 506   if (inst == NULL)
 507     return (0);
 508
 509   mtime = 0;
 510   for (i = 0; i < inst->files_num; i++)
 511   {
 512     time_t tmp;
 513
 514     tmp = ident_get_mtime (inst->files[i]);
 515     if (mtime < tmp)
 516       mtime = tmp;
 517   }
 518
 519   return (mtime);
 520 } /* }}} time_t inst_get_mtime */
 521
 522 /* vim: set sw=2 sts=2 et fdm=marker : */