src/daemon/utils_match.h

   1 /**
   2  * collectd - src/utils_match.h
   3  * Copyright (C) 2008-2014  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 #ifndef UTILS_MATCH_H
  28 #define UTILS_MATCH_H 1
  29
  30 #include "plugin.h"
  31
  32 /*
  33  * Each type may have 12 sub-types
  34  * 0x1000 = 1000000000000
  35  *          ^             <- Type bit
  36  *           ^^^^^^^^^^^^ <- Subtype bits
  37  */
  38 #define UTILS_MATCH_DS_TYPE_GAUGE    0x1000
  39 #define UTILS_MATCH_DS_TYPE_COUNTER  0x2000
  40 #define UTILS_MATCH_DS_TYPE_DERIVE   0x4000
  41 #define UTILS_MATCH_DS_TYPE_ABSOLUTE 0x8000
  42
  43 #define UTILS_MATCH_CF_GAUGE_AVERAGE 0x01
  44 #define UTILS_MATCH_CF_GAUGE_MIN     0x02
  45 #define UTILS_MATCH_CF_GAUGE_MAX     0x04
  46 #define UTILS_MATCH_CF_GAUGE_LAST    0x08
  47 #define UTILS_MATCH_CF_GAUGE_INC     0x10
  48 #define UTILS_MATCH_CF_GAUGE_ADD     0x20
  49 #define UTILS_MATCH_CF_GAUGE_PERSIST 0x40
  50
  51 #define UTILS_MATCH_CF_COUNTER_SET   0x01
  52 #define UTILS_MATCH_CF_COUNTER_ADD   0x02
  53 #define UTILS_MATCH_CF_COUNTER_INC   0x04
  54
  55 #define UTILS_MATCH_CF_DERIVE_SET   0x01
  56 #define UTILS_MATCH_CF_DERIVE_ADD   0x02
  57 #define UTILS_MATCH_CF_DERIVE_INC   0x04
  58
  59 #define UTILS_MATCH_CF_ABSOLUTE_SET   0x01
  60 #define UTILS_MATCH_CF_ABSOLUTE_ADD   0x02
  61 #define UTILS_MATCH_CF_ABSOLUTE_INC   0x04
  62
  63 /*
  64  * Data types
  65  */
  66 struct cu_match_s;
  67 typedef struct cu_match_s cu_match_t;
  68
  69 struct cu_match_value_s
  70 {
  71   int ds_type;
  72   value_t value;
  73   unsigned int values_num;
  74 };
  75 typedef struct cu_match_value_s cu_match_value_t;
  76
  77 /*
  78  * Prototypes
  79  */
  80 /*
  81  * NAME
  82  *  match_create_callback
  83  *
  84  * DESCRIPTION
  85  *  Creates a new `cu_match_t' object which will use the regular expression
  86  *  `regex' to match lines, see the `match_apply' method below. If the line
  87  *  matches, the callback passed in `callback' will be called along with the
  88  *  pointer `user_pointer'.
  89  *  The string that's passed to the callback depends on the regular expression:
  90  *  If the regular expression includes a sub-match, i. e. something like
  91  *    "value=([0-9][0-9]*)"
  92  *  then only the submatch (the part in the parenthesis) will be passed to the
  93  *  callback. If there is no submatch, then the entire string is passed to the
  94  *  callback.
  95  *  The optional `excluderegex' allows to exclude the line from the match, if
  96  *  the excluderegex matches.
  97  *  When `match_destroy' is called the `user_data' pointer is freed using
  98  *  the `free_user_data' callback - if it is not NULL.
  99  */
 100 cu_match_t *match_create_callback (const char *regex, const char *excluderegex,
 101                 int (*callback) (const char *str,
 102                   char * const *matches, size_t matches_num, void *user_data),
 103                 void *user_data, void (*free_user_data) (void *user_data));
 104
 105 /*
 106  * NAME
 107  *  match_create_simple
 108  *
 109  * DESCRIPTION
 110  *  Creates a new `cu_match_t' with a default callback. The user data for that
 111  *  default callback will be a `cu_match_value_t' structure, with
 112  *  `ds_type' copied to the structure. The default callback will handle the
 113  *  string as containing a number (see strtoll(3) and strtod(3)) and store that
 114  *  number in the `value' member. How that is done depends on `ds_type':
 115  *
 116  *  UTILS_MATCH_DS_TYPE_GAUGE
 117  *    The function will search for a floating point number in the string and
 118  *    store it in value.gauge.
 119  *  UTILS_MATCH_DS_TYPE_COUNTER_SET
 120  *    The function will search for an integer in the string and store it in
 121  *    value.counter.
 122  *  UTILS_MATCH_DS_TYPE_COUNTER_ADD
 123  *    The function will search for an integer in the string and add it to the
 124  *    value in value.counter.
 125  *  UTILS_MATCH_DS_TYPE_COUNTER_INC
 126  *    The function will not search for anything in the string and increase
 127  *    value.counter by one.
 128  */
 129 cu_match_t *match_create_simple (const char *regex,
 130                                  const char *excluderegex, int ds_type);
 131
 132 /*
 133  * NAME
 134  *  match_value_reset
 135  *
 136  * DESCRIPTION
 137  *   Resets the internal state, if applicable. This function must be called
 138  *   after each iteration for "simple" matches, usually after dispatching the
 139  *   metrics.
 140  */
 141 void match_value_reset (cu_match_value_t *mv);
 142
 143 /*
 144  * NAME
 145  *  match_destroy
 146  *
 147  * DESCRIPTION
 148  *  Destroys the object and frees all internal resources.
 149  */
 150 void match_destroy (cu_match_t *obj);
 151
 152 /*
 153  * NAME
 154  *  match_apply
 155  *
 156  * DESCRIPTION
 157  *  Tries to match the string `str' with the regular expression of `obj'. If
 158  *  the string matches, calls the callback in `obj' with the (sub-)match.
 159  *
 160  *  The user_data pointer passed to `match_create_callback' is NOT freed
 161  *  automatically. The `cu_match_value_t' structure allocated by
 162  *  `match_create_callback' is freed automatically.
 163  */
 164 int match_apply (cu_match_t *obj, const char *str);
 165
 166 /*
 167  * NAME
 168  *  match_get_user_data
 169  *
 170  * DESCRIPTION
 171  *  Returns the pointer passed to `match_create_callback' or a pointer to the
 172  *  `cu_match_value_t' structure allocated by `match_create_simple'.
 173  */
 174 void *match_get_user_data (cu_match_t *obj);
 175
 176 #endif /* UTILS_MATCH_H */
 177
 178 /* vim: set sw=2 sts=2 ts=8 : */