src/utils_match.h

   1 /**
   2  * collectd - src/utils_match.h
   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 #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
  50 #define UTILS_MATCH_CF_COUNTER_SET   0x01
  51 #define UTILS_MATCH_CF_COUNTER_ADD   0x02
  52 #define UTILS_MATCH_CF_COUNTER_INC   0x04
  53
  54 #define UTILS_MATCH_CF_DERIVE_SET   0x01
  55 #define UTILS_MATCH_CF_DERIVE_ADD   0x02
  56 #define UTILS_MATCH_CF_DERIVE_INC   0x04
  57
  58 #define UTILS_MATCH_CF_ABSOLUTE_SET   0x01
  59 #define UTILS_MATCH_CF_ABSOLUTE_ADD   0x02
  60 #define UTILS_MATCH_CF_ABSOLUTE_INC   0x04
  61
  62 /*
  63  * Data types
  64  */
  65 struct cu_match_s;
  66 typedef struct cu_match_s cu_match_t;
  67
  68 struct cu_match_value_s
  69 {
  70   int ds_type;
  71   value_t value;
  72   unsigned int values_num;
  73 };
  74 typedef struct cu_match_value_s cu_match_value_t;
  75
  76 /*
  77  * Prototypes
  78  */
  79 /*
  80  * NAME
  81  *  match_create_callback
  82  *
  83  * DESCRIPTION
  84  *  Creates a new `cu_match_t' object which will use the regular expression
  85  *  `regex' to match lines, see the `match_apply' method below. If the line
  86  *  matches, the callback passed in `callback' will be called along with the
  87  *  pointer `user_pointer'.
  88  *  The string that's passed to the callback depends on the regular expression:
  89  *  If the regular expression includes a sub-match, i. e. something like
  90  *    "value=([0-9][0-9]*)"
  91  *  then only the submatch (the part in the parenthesis) will be passed to the
  92  *  callback. If there is no submatch, then the entire string is passed to the
  93  *  callback.
  94  *  The optional `excluderegex' allows to exclude the line from the match, if
  95  *  the excluderegex matches.
  96  */
  97 cu_match_t *match_create_callback (const char *regex, const char *excluderegex,
  98                 int (*callback) (const char *str,
  99                   char * const *matches, size_t matches_num, void *user_data),
 100                 void *user_data);
 101
 102 /*
 103  * NAME
 104  *  match_create_simple
 105  *
 106  * DESCRIPTION
 107  *  Creates a new `cu_match_t' with a default callback. The user data for that
 108  *  default callback will be a `cu_match_value_t' structure, with
 109  *  `ds_type' copied to the structure. The default callback will handle the
 110  *  string as containing a number (see strtoll(3) and strtod(3)) and store that
 111  *  number in the `value' member. How that is done depends on `ds_type':
 112  *
 113  *  UTILS_MATCH_DS_TYPE_GAUGE
 114  *    The function will search for a floating point number in the string and
 115  *    store it in value.gauge.
 116  *  UTILS_MATCH_DS_TYPE_COUNTER_SET
 117  *    The function will search for an integer in the string and store it in
 118  *    value.counter.
 119  *  UTILS_MATCH_DS_TYPE_COUNTER_ADD
 120  *    The function will search for an integer in the string and add it to the
 121  *    value in value.counter.
 122  *  UTILS_MATCH_DS_TYPE_COUNTER_INC
 123  *    The function will not search for anything in the string and increase
 124  *    value.counter by one.
 125  */
 126 cu_match_t *match_create_simple (const char *regex,
 127                                  const char *excluderegex, int ds_type);
 128
 129 /*
 130  * NAME
 131  *  match_destroy
 132  *
 133  * DESCRIPTION
 134  *  Destroys the object and frees all internal resources.
 135  */
 136 void match_destroy (cu_match_t *obj);
 137
 138 /*
 139  * NAME
 140  *  match_apply
 141  *
 142  * DESCRIPTION
 143  *  Tries to match the string `str' with the regular expression of `obj'. If
 144  *  the string matches, calls the callback in `obj' with the (sub-)match.
 145  *
 146  *  The user_data pointer passed to `match_create_callback' is NOT freed
 147  *  automatically. The `cu_match_value_t' structure allocated by
 148  *  `match_create_callback' is freed automatically.
 149  */
 150 int match_apply (cu_match_t *obj, const char *str);
 151
 152 /*
 153  * NAME
 154  *  match_get_user_data
 155  *
 156  * DESCRIPTION
 157  *  Returns the pointer passed to `match_create_callback' or a pointer to the
 158  *  `cu_match_value_t' structure allocated by `match_create_simple'.
 159  */
 160 void *match_get_user_data (cu_match_t *obj);
 161
 162 #endif /* UTILS_MATCH_H */
 163
 164 /* vim: set sw=2 sts=2 ts=8 : */