Merge branch 'collectd-4.10' into collectd-5.3
[collectd.git] / src / utils_match.h
1 /**
2  * collectd - src/utils_match.h
3  * Copyright (C) 2008-2014  Florian octo Forster
4  *
5  * This program is free software; you can redistribute it and/or modify it
6  * under the terms of the GNU General Public License as published by the
7  * Free Software Foundation; either version 2 of the License, or (at your
8  * option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful, but
11  * WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License along
16  * with this program; if not, write to the Free Software Foundation, Inc.,
17  * 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
18  *
19  * Authors:
20  *   Florian octo Forster <octo at verplant.org>
21  **/
22
23 #ifndef UTILS_MATCH_H
24 #define UTILS_MATCH_H 1
25
26 #include "plugin.h"
27
28 /*
29  * Defines
30  */
31 #define UTILS_MATCH_DS_TYPE_GAUGE    0x10
32 #define UTILS_MATCH_DS_TYPE_COUNTER  0x20
33 #define UTILS_MATCH_DS_TYPE_DERIVE   0x40
34 #define UTILS_MATCH_DS_TYPE_ABSOLUTE 0x80
35
36 #define UTILS_MATCH_CF_GAUGE_AVERAGE 0x01
37 #define UTILS_MATCH_CF_GAUGE_MIN     0x02
38 #define UTILS_MATCH_CF_GAUGE_MAX     0x04
39 #define UTILS_MATCH_CF_GAUGE_LAST    0x08
40
41 #define UTILS_MATCH_CF_COUNTER_SET   0x01
42 #define UTILS_MATCH_CF_COUNTER_ADD   0x02
43 #define UTILS_MATCH_CF_COUNTER_INC   0x04
44
45 #define UTILS_MATCH_CF_DERIVE_SET   0x01
46 #define UTILS_MATCH_CF_DERIVE_ADD   0x02
47 #define UTILS_MATCH_CF_DERIVE_INC   0x04
48
49 #define UTILS_MATCH_CF_ABSOLUTE_SET   0x01
50 #define UTILS_MATCH_CF_ABSOLUTE_ADD   0x02
51 #define UTILS_MATCH_CF_ABSOLUTE_INC   0x04
52
53 /*
54  * Data types
55  */
56 struct cu_match_s;
57 typedef struct cu_match_s cu_match_t;
58
59 struct cu_match_value_s
60 {
61   int ds_type;
62   value_t value;
63   unsigned int values_num;
64 };
65 typedef struct cu_match_value_s cu_match_value_t;
66
67 /*
68  * Prototypes
69  */
70 /*
71  * NAME
72  *  match_create_callback
73  *
74  * DESCRIPTION
75  *  Creates a new `cu_match_t' object which will use the regular expression
76  *  `regex' to match lines, see the `match_apply' method below. If the line
77  *  matches, the callback passed in `callback' will be called along with the
78  *  pointer `user_pointer'.
79  *  The string that's passed to the callback depends on the regular expression:
80  *  If the regular expression includes a sub-match, i. e. something like
81  *    "value=([0-9][0-9]*)"
82  *  then only the submatch (the part in the parenthesis) will be passed to the
83  *  callback. If there is no submatch, then the entire string is passed to the
84  *  callback.
85  *  The optional `excluderegex' allows to exclude the line from the match, if
86  *  the excluderegex matches.
87  */
88 cu_match_t *match_create_callback (const char *regex, const char *excluderegex,
89                 int (*callback) (const char *str,
90                   char * const *matches, size_t matches_num, void *user_data),
91                 void *user_data);
92
93 /*
94  * NAME
95  *  match_create_simple
96  *
97  * DESCRIPTION
98  *  Creates a new `cu_match_t' with a default callback. The user data for that
99  *  default callback will be a `cu_match_value_t' structure, with
100  *  `ds_type' copied to the structure. The default callback will handle the
101  *  string as containing a number (see strtoll(3) and strtod(3)) and store that
102  *  number in the `value' member. How that is done depends on `ds_type':
103  *
104  *  UTILS_MATCH_DS_TYPE_GAUGE
105  *    The function will search for a floating point number in the string and
106  *    store it in value.gauge.
107  *  UTILS_MATCH_DS_TYPE_COUNTER_SET
108  *    The function will search for an integer in the string and store it in
109  *    value.counter.
110  *  UTILS_MATCH_DS_TYPE_COUNTER_ADD
111  *    The function will search for an integer in the string and add it to the
112  *    value in value.counter.
113  *  UTILS_MATCH_DS_TYPE_COUNTER_INC
114  *    The function will not search for anything in the string and increase
115  *    value.counter by one.
116  */
117 cu_match_t *match_create_simple (const char *regex,
118                                  const char *excluderegex, int ds_type);
119
120 /*
121  * NAME
122  *  match_value_reset
123  *
124  * DESCRIPTION
125  *   Resets the internal state, if applicable. This function must be called
126  *   after each iteration for "simple" matches, usually after dispatching the
127  *   metrics.
128  */
129 void match_value_reset (cu_match_value_t *mv);
130
131 /*
132  * NAME
133  *  match_destroy
134  *
135  * DESCRIPTION
136  *  Destroys the object and frees all internal resources.
137  */
138 void match_destroy (cu_match_t *obj);
139
140 /*
141  * NAME
142  *  match_apply
143  *
144  * DESCRIPTION
145  *  Tries to match the string `str' with the regular expression of `obj'. If
146  *  the string matches, calls the callback in `obj' with the (sub-)match.
147  *
148  *  The user_data pointer passed to `match_create_callback' is NOT freed
149  *  automatically. The `cu_match_value_t' structure allocated by
150  *  `match_create_callback' is freed automatically.
151  */
152 int match_apply (cu_match_t *obj, const char *str);
153
154 /*
155  * NAME
156  *  match_get_user_data
157  *
158  * DESCRIPTION
159  *  Returns the pointer passed to `match_create_callback' or a pointer to the
160  *  `cu_match_value_t' structure allocated by `match_create_simple'.
161  */
162 void *match_get_user_data (cu_match_t *obj);
163
164 #endif /* UTILS_MATCH_H */
165
166 /* vim: set sw=2 sts=2 ts=8 : */