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