2 * collectd - src/utils_match.h
3 * Copyright (C) 2008 Florian octo Forster
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.
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.
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
20 * Florian octo Forster <octo at verplant.org>
24 #define UTILS_MATCH_H 1
29 * Each type may have 12 sub-types
30 * 0x1000 = 1000000000000
32 * ^^^^^^^^^^^^ <- Subtype bits
34 #define UTILS_MATCH_DS_TYPE_GAUGE 0x1000
35 #define UTILS_MATCH_DS_TYPE_COUNTER 0x2000
36 #define UTILS_MATCH_DS_TYPE_DERIVE 0x4000
37 #define UTILS_MATCH_DS_TYPE_ABSOLUTE 0x8000
39 #define UTILS_MATCH_CF_GAUGE_AVERAGE 0x01
40 #define UTILS_MATCH_CF_GAUGE_MIN 0x02
41 #define UTILS_MATCH_CF_GAUGE_MAX 0x04
42 #define UTILS_MATCH_CF_GAUGE_LAST 0x08
43 #define UTILS_MATCH_CF_GAUGE_INC 0x10
44 #define UTILS_MATCH_CF_GAUGE_ADD 0x20
46 #define UTILS_MATCH_CF_COUNTER_SET 0x01
47 #define UTILS_MATCH_CF_COUNTER_ADD 0x02
48 #define UTILS_MATCH_CF_COUNTER_INC 0x04
50 #define UTILS_MATCH_CF_DERIVE_SET 0x01
51 #define UTILS_MATCH_CF_DERIVE_ADD 0x02
52 #define UTILS_MATCH_CF_DERIVE_INC 0x04
54 #define UTILS_MATCH_CF_ABSOLUTE_SET 0x01
55 #define UTILS_MATCH_CF_ABSOLUTE_ADD 0x02
56 #define UTILS_MATCH_CF_ABSOLUTE_INC 0x04
62 typedef struct cu_match_s cu_match_t;
64 struct cu_match_value_s
68 unsigned int values_num;
70 typedef struct cu_match_value_s cu_match_value_t;
77 * match_create_callback
80 * Creates a new `cu_match_t' object which will use the regular expression
81 * `regex' to match lines, see the `match_apply' method below. If the line
82 * matches, the callback passed in `callback' will be called along with the
83 * pointer `user_pointer'.
84 * The string that's passed to the callback depends on the regular expression:
85 * If the regular expression includes a sub-match, i. e. something like
86 * "value=([0-9][0-9]*)"
87 * then only the submatch (the part in the parenthesis) will be passed to the
88 * callback. If there is no submatch, then the entire string is passed to the
90 * The optional `excluderegex' allows to exclude the line from the match, if
91 * the excluderegex matches.
93 cu_match_t *match_create_callback (const char *regex, const char *excluderegex,
94 int (*callback) (const char *str,
95 char * const *matches, size_t matches_num, void *user_data),
100 * match_create_simple
103 * Creates a new `cu_match_t' with a default callback. The user data for that
104 * default callback will be a `cu_match_value_t' structure, with
105 * `ds_type' copied to the structure. The default callback will handle the
106 * string as containing a number (see strtoll(3) and strtod(3)) and store that
107 * number in the `value' member. How that is done depends on `ds_type':
109 * UTILS_MATCH_DS_TYPE_GAUGE
110 * The function will search for a floating point number in the string and
111 * store it in value.gauge.
112 * UTILS_MATCH_DS_TYPE_COUNTER_SET
113 * The function will search for an integer in the string and store it in
115 * UTILS_MATCH_DS_TYPE_COUNTER_ADD
116 * The function will search for an integer in the string and add it to the
117 * value in value.counter.
118 * UTILS_MATCH_DS_TYPE_COUNTER_INC
119 * The function will not search for anything in the string and increase
120 * value.counter by one.
122 cu_match_t *match_create_simple (const char *regex,
123 const char *excluderegex, int ds_type);
130 * Destroys the object and frees all internal resources.
132 void match_destroy (cu_match_t *obj);
139 * Tries to match the string `str' with the regular expression of `obj'. If
140 * the string matches, calls the callback in `obj' with the (sub-)match.
142 * The user_data pointer passed to `match_create_callback' is NOT freed
143 * automatically. The `cu_match_value_t' structure allocated by
144 * `match_create_callback' is freed automatically.
146 int match_apply (cu_match_t *obj, const char *str);
150 * match_get_user_data
153 * Returns the pointer passed to `match_create_callback' or a pointer to the
154 * `cu_match_value_t' structure allocated by `match_create_simple'.
156 void *match_get_user_data (cu_match_t *obj);
158 #endif /* UTILS_MATCH_H */
160 /* vim: set sw=2 sts=2 ts=8 : */