src/database/rrdlabels.c
// SPDX-License-Identifier: GPL-3.0-or-later
#define NETDATA_RRD_INTERNALS
#include "rrd.h"
// Key OF HS ARRRAY
struct {
Pvoid_t JudyHS;
SPINLOCK spinlock;
} global_labels = {
.JudyHS = (Pvoid_t) NULL,
.spinlock = NETDATA_SPINLOCK_INITIALIZER
};
typedef struct label_registry_idx {
STRING *key;
STRING *value;
} LABEL_REGISTRY_IDX;
typedef struct labels_registry_entry {
LABEL_REGISTRY_IDX index;
} RRDLABEL;
// Value of HS array
typedef struct labels_registry_idx_entry {
RRDLABEL label;
size_t refcount;
} RRDLABEL_IDX;
typedef struct rrdlabels {
SPINLOCK spinlock;
size_t version;
Pvoid_t JudyL;
} RRDLABELS;
#define lfe_start_nolock(label_list, label, ls) \
do { \
bool _first_then_next = true; \
Pvoid_t *_PValue; \
Word_t _Index = 0; \
while ((_PValue = JudyLFirstThenNext((label_list)->JudyL, &_Index, &_first_then_next))) { \
(ls) = *(RRDLABEL_SRC *)_PValue; \
(void)(ls); \
(label) = (void *)_Index;
#define lfe_done_nolock() \
} \
} \
while (0)
#define lfe_start_read(label_list, label, ls) \
do { \
spinlock_lock(&(label_list)->spinlock); \
bool _first_then_next = true; \
Pvoid_t *_PValue; \
Word_t _Index = 0; \
while ((_PValue = JudyLFirstThenNext((label_list)->JudyL, &_Index, &_first_then_next))) { \
(ls) = *(RRDLABEL_SRC *)_PValue; \
(void)(ls); \
(label) = (void *)_Index;
#define lfe_done(label_list) \
} \
spinlock_unlock(&(label_list)->spinlock); \
} \
while (0)
static inline void STATS_PLUS_MEMORY(struct dictionary_stats *stats, size_t key_size, size_t item_size, size_t value_size) {
if(key_size)
__atomic_fetch_add(&stats->memory.index, (long)JUDYHS_INDEX_SIZE_ESTIMATE(key_size), __ATOMIC_RELAXED);
if(item_size)
__atomic_fetch_add(&stats->memory.dict, (long)item_size, __ATOMIC_RELAXED);
if(value_size)
__atomic_fetch_add(&stats->memory.values, (long)value_size, __ATOMIC_RELAXED);
}
static inline void STATS_MINUS_MEMORY(struct dictionary_stats *stats, size_t key_size, size_t item_size, size_t value_size) {
if(key_size)
__atomic_fetch_sub(&stats->memory.index, (long)JUDYHS_INDEX_SIZE_ESTIMATE(key_size), __ATOMIC_RELAXED);
if(item_size)
__atomic_fetch_sub(&stats->memory.dict, (long)item_size, __ATOMIC_RELAXED);
if(value_size)
__atomic_fetch_sub(&stats->memory.values, (long)value_size, __ATOMIC_RELAXED);
}
// ----------------------------------------------------------------------------
// labels sanitization
/*
* All labels follow these rules:
*
* Character Symbol Values Names
* UTF-8 characters UTF-8 yes -> _
* Lower case letter [a-z] yes yes
* Upper case letter [A-Z] yes -> [a-z]
* Digit [0-9] yes yes
* Underscore _ yes yes
* Minus - yes yes
* Plus + yes -> _
* Colon : yes -> _
* Semicolon ; -> : -> _
* Equal = -> : -> _
* Period . yes yes
* Comma , -> . -> .
* Slash / yes yes
* Backslash \ -> / -> /
* At @ yes -> _
* Space yes -> _
* Opening parenthesis ( yes -> _
* Closing parenthesis ) yes -> _
* anything else -> _ -> _
*
* The above rules should allow users to set in tags (indicative):
*
* 1. hostnames and domain names as-is
* 2. email addresses as-is
* 3. floating point numbers, converted to always use a dot as the decimal point
*
* Leading and trailing spaces and control characters are removed from both label
* names and values.
*
* Multiple spaces inside the label name or the value are removed (only 1 is retained).
* In names spaces are also converted to underscores.
*
* Names that are only underscores are rejected (they do not enter the dictionary).
*
* The above rules do not require any conversion to be included in JSON strings.
*
* Label names and values are truncated to LABELS_MAX_LENGTH (200) characters.
*
* When parsing, label key and value are separated by the first colon (:) found.
* So label:value1:value2 is parsed as key = "label", value = "value1:value2"
*
* This means a label key cannot contain a colon (:) - it is converted to
* underscore if it does.
*
*/
#define RRDLABELS_MAX_NAME_LENGTH 200
#define RRDLABELS_MAX_VALUE_LENGTH 800 // 800 in bytes, up to 200 UTF-8 characters
static unsigned char label_spaces_char_map[256];
static unsigned char label_names_char_map[256];
static unsigned char label_values_char_map[256] = {
[0] = '\0', //
[1] = '_', //
[2] = '_', //
[3] = '_', //
[4] = '_', //
[5] = '_', //
[6] = '_', //
[7] = '_', //
[8] = '_', //
[9] = '_', //
[10] = '_', //
[11] = '_', //
[12] = '_', //
[13] = '_', //
[14] = '_', //
[15] = '_', //
[16] = '_', //
[17] = '_', //
[18] = '_', //
[19] = '_', //
[20] = '_', //
[21] = '_', //
[22] = '_', //
[23] = '_', //
[24] = '_', //
[25] = '_', //
[26] = '_', //
[27] = '_', //
[28] = '_', //
[29] = '_', //
[30] = '_', //
[31] = '_', //
[32] = ' ', // SPACE keep
[33] = '_', // !
[34] = '_', // "
[35] = '_', // #
[36] = '_', // $
[37] = '_', // %
[38] = '_', // &
[39] = '_', // '
[40] = '(', // ( keep
[41] = ')', // ) keep
[42] = '_', // *
[43] = '+', // + keep
[44] = '.', // , convert , to .
[45] = '-', // - keep
[46] = '.', // . keep
[47] = '/', // / keep
[48] = '0', // 0 keep
[49] = '1', // 1 keep
[50] = '2', // 2 keep
[51] = '3', // 3 keep
[52] = '4', // 4 keep
[53] = '5', // 5 keep
[54] = '6', // 6 keep
[55] = '7', // 7 keep
[56] = '8', // 8 keep
[57] = '9', // 9 keep
[58] = ':', // : keep
[59] = ':', // ; convert ; to :
[60] = '_', // <
[61] = ':', // = convert = to :
[62] = '_', // >
[63] = '_', // ?
[64] = '@', // @
[65] = 'A', // A keep
[66] = 'B', // B keep
[67] = 'C', // C keep
[68] = 'D', // D keep
[69] = 'E', // E keep
[70] = 'F', // F keep
[71] = 'G', // G keep
[72] = 'H', // H keep
[73] = 'I', // I keep
[74] = 'J', // J keep
[75] = 'K', // K keep
[76] = 'L', // L keep
[77] = 'M', // M keep
[78] = 'N', // N keep
[79] = 'O', // O keep
[80] = 'P', // P keep
[81] = 'Q', // Q keep
[82] = 'R', // R keep
[83] = 'S', // S keep
[84] = 'T', // T keep
[85] = 'U', // U keep
[86] = 'V', // V keep
[87] = 'W', // W keep
[88] = 'X', // X keep
[89] = 'Y', // Y keep
[90] = 'Z', // Z keep
[91] = '[', // [ keep
[92] = '/', // backslash convert \ to /
[93] = ']', // ] keep
[94] = '_', // ^
[95] = '_', // _ keep
[96] = '_', // `
[97] = 'a', // a keep
[98] = 'b', // b keep
[99] = 'c', // c keep
[100] = 'd', // d keep
[101] = 'e', // e keep
[102] = 'f', // f keep
[103] = 'g', // g keep
[104] = 'h', // h keep
[105] = 'i', // i keep
[106] = 'j', // j keep
[107] = 'k', // k keep
[108] = 'l', // l keep
[109] = 'm', // m keep
[110] = 'n', // n keep
[111] = 'o', // o keep
[112] = 'p', // p keep
[113] = 'q', // q keep
[114] = 'r', // r keep
[115] = 's', // s keep
[116] = 't', // t keep
[117] = 'u', // u keep
[118] = 'v', // v keep
[119] = 'w', // w keep
[120] = 'x', // x keep
[121] = 'y', // y keep
[122] = 'z', // z keep
[123] = '_', // {
[124] = '_', // |
[125] = '_', // }
[126] = '_', // ~
[127] = '_', //
[128] = '_', //
[129] = '_', //
[130] = '_', //
[131] = '_', //
[132] = '_', //
[133] = '_', //
[134] = '_', //
[135] = '_', //
[136] = '_', //
[137] = '_', //
[138] = '_', //
[139] = '_', //
[140] = '_', //
[141] = '_', //
[142] = '_', //
[143] = '_', //
[144] = '_', //
[145] = '_', //
[146] = '_', //
[147] = '_', //
[148] = '_', //
[149] = '_', //
[150] = '_', //
[151] = '_', //
[152] = '_', //
[153] = '_', //
[154] = '_', //
[155] = '_', //
[156] = '_', //
[157] = '_', //
[158] = '_', //
[159] = '_', //
[160] = '_', //
[161] = '_', //
[162] = '_', //
[163] = '_', //
[164] = '_', //
[165] = '_', //
[166] = '_', //
[167] = '_', //
[168] = '_', //
[169] = '_', //
[170] = '_', //
[171] = '_', //
[172] = '_', //
[173] = '_', //
[174] = '_', //
[175] = '_', //
[176] = '_', //
[177] = '_', //
[178] = '_', //
[179] = '_', //
[180] = '_', //
[181] = '_', //
[182] = '_', //
[183] = '_', //
[184] = '_', //
[185] = '_', //
[186] = '_', //
[187] = '_', //
[188] = '_', //
[189] = '_', //
[190] = '_', //
[191] = '_', //
[192] = '_', //
[193] = '_', //
[194] = '_', //
[195] = '_', //
[196] = '_', //
[197] = '_', //
[198] = '_', //
[199] = '_', //
[200] = '_', //
[201] = '_', //
[202] = '_', //
[203] = '_', //
[204] = '_', //
[205] = '_', //
[206] = '_', //
[207] = '_', //
[208] = '_', //
[209] = '_', //
[210] = '_', //
[211] = '_', //
[212] = '_', //
[213] = '_', //
[214] = '_', //
[215] = '_', //
[216] = '_', //
[217] = '_', //
[218] = '_', //
[219] = '_', //
[220] = '_', //
[221] = '_', //
[222] = '_', //
[223] = '_', //
[224] = '_', //
[225] = '_', //
[226] = '_', //
[227] = '_', //
[228] = '_', //
[229] = '_', //
[230] = '_', //
[231] = '_', //
[232] = '_', //
[233] = '_', //
[234] = '_', //
[235] = '_', //
[236] = '_', //
[237] = '_', //
[238] = '_', //
[239] = '_', //
[240] = '_', //
[241] = '_', //
[242] = '_', //
[243] = '_', //
[244] = '_', //
[245] = '_', //
[246] = '_', //
[247] = '_', //
[248] = '_', //
[249] = '_', //
[250] = '_', //
[251] = '_', //
[252] = '_', //
[253] = '_', //
[254] = '_', //
[255] = '_' //
};
__attribute__((constructor)) void initialize_labels_keys_char_map(void) {
// copy the values char map to the names char map
size_t i;
for(i = 0; i < 256 ;i++)
label_names_char_map[i] = label_values_char_map[i];
// apply overrides to the label names map
label_names_char_map['A'] = 'a';
label_names_char_map['B'] = 'b';
label_names_char_map['C'] = 'c';
label_names_char_map['D'] = 'd';
label_names_char_map['E'] = 'e';
label_names_char_map['F'] = 'f';
label_names_char_map['G'] = 'g';
label_names_char_map['H'] = 'h';
label_names_char_map['I'] = 'i';
label_names_char_map['J'] = 'j';
label_names_char_map['K'] = 'k';
label_names_char_map['L'] = 'l';
label_names_char_map['M'] = 'm';
label_names_char_map['N'] = 'n';
label_names_char_map['O'] = 'o';
label_names_char_map['P'] = 'p';
label_names_char_map['Q'] = 'q';
label_names_char_map['R'] = 'r';
label_names_char_map['S'] = 's';
label_names_char_map['T'] = 't';
label_names_char_map['U'] = 'u';
label_names_char_map['V'] = 'v';
label_names_char_map['W'] = 'w';
label_names_char_map['X'] = 'x';
label_names_char_map['Y'] = 'y';
label_names_char_map['Z'] = 'z';
label_names_char_map['='] = '_';
label_names_char_map[':'] = '_';
label_names_char_map['+'] = '_';
label_names_char_map[';'] = '_';
label_names_char_map['@'] = '_';
label_names_char_map['('] = '_';
label_names_char_map[')'] = '_';
label_names_char_map[' '] = '_';
label_names_char_map['\\'] = '/';
// create the space map
for(i = 0; i < 256 ;i++)
label_spaces_char_map[i] = (isspace(i) || iscntrl(i) || !isprint(i))?1:0;
}
__attribute__((constructor)) void initialize_label_stats(void) {
dictionary_stats_category_rrdlabels.memory.dict = 0;
dictionary_stats_category_rrdlabels.memory.index = 0;
dictionary_stats_category_rrdlabels.memory.values = 0;
}
size_t text_sanitize(unsigned char *dst, const unsigned char *src, size_t dst_size, const unsigned char *char_map, bool utf, const char *empty, size_t *multibyte_length) {
if(unlikely(!src || !dst_size)) return 0;
if(unlikely(!src || !*src)) {
strncpyz((char *)dst, empty, dst_size);
dst[dst_size - 1] = '\0';
size_t len = strlen((char *)dst);
if(multibyte_length) *multibyte_length = len;
return len;
}
unsigned char *d = dst;
// make room for the final string termination
unsigned char *end = &d[dst_size - 1];
// copy while converting, but keep only one space
// we start wil last_is_space = 1 to skip leading spaces
int last_is_space = 1;
size_t mblen = 0;
while(*src && d < end) {
unsigned char c = *src;
if(IS_UTF8_STARTBYTE(c) && IS_UTF8_BYTE(src[1]) && d + 2 < end) {
// UTF-8 multi-byte encoded character
// find how big this character is (2-4 bytes)
size_t utf_character_size = 2;
while(utf_character_size < 4 && src[utf_character_size] && IS_UTF8_BYTE(src[utf_character_size]) && !IS_UTF8_STARTBYTE(src[utf_character_size]))
utf_character_size++;
if(utf) {
while(utf_character_size) {
utf_character_size--;
*d++ = *src++;
}
}
else {
// UTF-8 characters are not allowed.
// Assume it is an underscore
// and skip all except the first byte
*d++ = '_';
src += (utf_character_size - 1);
}
last_is_space = 0;
mblen++;
continue;
}
if(label_spaces_char_map[c]) {
// a space character
if(!last_is_space) {
// add one space
*d++ = char_map[c];
mblen++;
}
last_is_space++;
}
else {
*d++ = char_map[c];
last_is_space = 0;
mblen++;
}
src++;
}
// remove the last trailing space
if(last_is_space && d > dst) {
d--;
mblen--;
}
// put a termination at the end of what we copied
*d = '\0';
// check if dst is all underscores and empty it if it is
if(*dst == '_') {
unsigned char *t = dst;
while (*t == '_') t++;
if (unlikely(*t == '\0')) {
*dst = '\0';
mblen = 0;
}
}
if(unlikely(*dst == '\0')) {
strncpyz((char *)dst, empty, dst_size);
dst[dst_size - 1] = '\0';
mblen = strlen((char *)dst);
if(multibyte_length) *multibyte_length = mblen;
return mblen;
}
if(multibyte_length) *multibyte_length = mblen;
return d - dst;
}
static inline size_t rrdlabels_sanitize_name(char *dst, const char *src, size_t dst_size) {
return text_sanitize((unsigned char *)dst, (const unsigned char *)src, dst_size, label_names_char_map, 0, "", NULL);
}
static inline size_t rrdlabels_sanitize_value(char *dst, const char *src, size_t dst_size) {
return text_sanitize((unsigned char *)dst, (const unsigned char *)src, dst_size, label_values_char_map, 1, "[none]", NULL);
}
// ----------------------------------------------------------------------------
// rrdlabels_create()
RRDLABELS *rrdlabels_create(void)
{
RRDLABELS *labels = callocz(1, sizeof(*labels));
STATS_PLUS_MEMORY(&dictionary_stats_category_rrdlabels, 0, sizeof(RRDLABELS), 0);
return labels;
}
static void dup_label(RRDLABEL *label_index)
{
if (!label_index)
return;
spinlock_lock(&global_labels.spinlock);
Pvoid_t *PValue = JudyHSGet(global_labels.JudyHS, (void *)label_index, sizeof(*label_index));
if (PValue && *PValue) {
RRDLABEL_IDX *rrdlabel = *PValue;
__atomic_add_fetch(&rrdlabel->refcount, 1, __ATOMIC_RELAXED);
}
spinlock_unlock(&global_labels.spinlock);
}
static RRDLABEL *add_label_name_value(const char *name, const char *value)
{
RRDLABEL_IDX *rrdlabel = NULL;
LABEL_REGISTRY_IDX label_index;
label_index.key = string_strdupz(name);
label_index.value = string_strdupz(value);
spinlock_lock(&global_labels.spinlock);
Pvoid_t *PValue = JudyHSIns(&global_labels.JudyHS, (void *)&label_index, sizeof(label_index), PJE0);
if(unlikely(!PValue || PValue == PJERR))
fatal("RRDLABELS: corrupted judyHS array");
if (*PValue) {
rrdlabel = *PValue;
string_freez(label_index.key);
string_freez(label_index.value);
} else {
rrdlabel = callocz(1, sizeof(*rrdlabel));
rrdlabel->label.index = label_index;
*PValue = rrdlabel;
STATS_PLUS_MEMORY(&dictionary_stats_category_rrdlabels, sizeof(LABEL_REGISTRY_IDX), sizeof(RRDLABEL_IDX), 0);
}
__atomic_add_fetch(&rrdlabel->refcount, 1, __ATOMIC_RELAXED);
spinlock_unlock(&global_labels.spinlock);
return &rrdlabel->label;
}
static void delete_label(RRDLABEL *label)
{
spinlock_lock(&global_labels.spinlock);
Pvoid_t *PValue = JudyHSGet(global_labels.JudyHS, &label->index, sizeof(label->index));
if (PValue && *PValue) {
RRDLABEL_IDX *rrdlabel = *PValue;
size_t refcount = __atomic_sub_fetch(&rrdlabel->refcount, 1, __ATOMIC_RELAXED);
if (refcount == 0) {
int ret = JudyHSDel(&global_labels.JudyHS, (void *)label, sizeof(*label), PJE0);
if (unlikely(ret == JERR))
STATS_MINUS_MEMORY(&dictionary_stats_category_rrdlabels, 0, sizeof(*rrdlabel), 0);
else
STATS_MINUS_MEMORY(&dictionary_stats_category_rrdlabels, sizeof(LABEL_REGISTRY_IDX), sizeof(*rrdlabel), 0);
string_freez(label->index.key);
string_freez(label->index.value);
freez(rrdlabel);
}
}
spinlock_unlock(&global_labels.spinlock);
}
// ----------------------------------------------------------------------------
// rrdlabels_destroy()
void rrdlabels_destroy(RRDLABELS *labels)
{
if (unlikely(!labels))
return;
spinlock_lock(&labels->spinlock);
Pvoid_t *PValue;
Word_t Index = 0;
bool first_then_next = true;
while ((PValue = JudyLFirstThenNext(labels->JudyL, &Index, &first_then_next))) {
delete_label((RRDLABEL *)Index);
}
size_t memory_freed = JudyLFreeArray(&labels->JudyL, PJE0);
STATS_MINUS_MEMORY(&dictionary_stats_category_rrdlabels, 0, memory_freed + sizeof(RRDLABELS), 0);
spinlock_unlock(&labels->spinlock);
freez(labels);
}
//
// Check in labels to see if we have the key specified in label
// same_value indicates if the value should also be matched
//
static RRDLABEL *rrdlabels_find_label_with_key_unsafe(RRDLABELS *labels, RRDLABEL *label, bool same_value)
{
if (unlikely(!labels))
return NULL;
Pvoid_t *PValue;
Word_t Index = 0;
bool first_then_next = true;
RRDLABEL *found = NULL;
while ((PValue = JudyLFirstThenNext(labels->JudyL, &Index, &first_then_next))) {
RRDLABEL *lb = (RRDLABEL *)Index;
if (lb->index.key == label->index.key && ((lb == label) == same_value)) {
found = (RRDLABEL *)Index;
break;
}
}
return found;
}
// ----------------------------------------------------------------------------
// rrdlabels_add()
static void labels_add_already_sanitized(RRDLABELS *labels, const char *key, const char *value, RRDLABEL_SRC ls)
{
RRDLABEL *new_label = add_label_name_value(key, value);
spinlock_lock(&labels->spinlock);
RRDLABEL_SRC new_ls = (ls & ~(RRDLABEL_FLAG_NEW | RRDLABEL_FLAG_OLD));
size_t mem_before_judyl = JudyLMemUsed(labels->JudyL);
Pvoid_t *PValue = JudyLIns(&labels->JudyL, (Word_t)new_label, PJE0);
if (!PValue || PValue == PJERR)
fatal("RRDLABELS: corrupted labels JudyL array");
if(*PValue) {
new_ls |= RRDLABEL_FLAG_OLD;
*((RRDLABEL_SRC *)PValue) = new_ls;
delete_label(new_label);
}
else {
new_ls |= RRDLABEL_FLAG_NEW;
*((RRDLABEL_SRC *)PValue) = new_ls;
RRDLABEL *old_label_with_same_key = rrdlabels_find_label_with_key_unsafe(labels, new_label, false);
if (old_label_with_same_key) {
(void) JudyLDel(&labels->JudyL, (Word_t) old_label_with_same_key, PJE0);
delete_label(old_label_with_same_key);
}
}
labels->version++;
size_t mem_after_judyl = JudyLMemUsed(labels->JudyL);
STATS_PLUS_MEMORY(&dictionary_stats_category_rrdlabels, 0, mem_after_judyl - mem_before_judyl, 0);
spinlock_unlock(&labels->spinlock);
}
void rrdlabels_add(RRDLABELS *labels, const char *name, const char *value, RRDLABEL_SRC ls)
{
if(!labels) {
netdata_log_error("%s(): called with NULL dictionary.", __FUNCTION__ );
return;
}
char n[RRDLABELS_MAX_NAME_LENGTH + 1], v[RRDLABELS_MAX_VALUE_LENGTH + 1];
rrdlabels_sanitize_name(n, name, RRDLABELS_MAX_NAME_LENGTH);
rrdlabels_sanitize_value(v, value, RRDLABELS_MAX_VALUE_LENGTH);
if(!*n) {
netdata_log_error("%s: cannot add name '%s' (value '%s') which is sanitized as empty string", __FUNCTION__, name, value);
return;
}
labels_add_already_sanitized(labels, n, v, ls);
}
bool rrdlabels_exist(RRDLABELS *labels, const char *key)
{
if (!labels)
return false;
STRING *this_key = string_strdupz(key);
RRDLABEL *lb;
RRDLABEL_SRC ls;
bool found = false;
lfe_start_read(labels, lb, ls)
{
if (lb->index.key == this_key) {
found = true;
break;
}
}
lfe_done(labels);
string_freez(this_key);
return found;
}
static const char *get_quoted_string_up_to(char *dst, size_t dst_size, const char *string, char upto1, char upto2) {
size_t len = 0;
char *d = dst, quote = 0;
while(*string && len++ < dst_size) {
if(unlikely(!quote && (*string == '\'' || *string == '"'))) {
quote = *string++;
continue;
}
if(unlikely(quote && *string == quote)) {
quote = 0;
string++;
continue;
}
if(unlikely(quote && *string == '\\' && string[1])) {
string++;
*d++ = *string++;
continue;
}
if(unlikely(!quote && (*string == upto1 || *string == upto2))) break;
*d++ = *string++;
}
*d = '\0';
if(*string) string++;
return string;
}
void rrdlabels_add_pair(RRDLABELS *labels, const char *string, RRDLABEL_SRC ls)
{
if(!labels) {
netdata_log_error("%s(): called with NULL dictionary.", __FUNCTION__ );
return;
}
char name[RRDLABELS_MAX_NAME_LENGTH + 1];
string = get_quoted_string_up_to(name, RRDLABELS_MAX_NAME_LENGTH, string, '=', ':');
char value[RRDLABELS_MAX_VALUE_LENGTH + 1];
get_quoted_string_up_to(value, RRDLABELS_MAX_VALUE_LENGTH, string, '\0', '\0');
rrdlabels_add(labels, name, value, ls);
}
// ----------------------------------------------------------------------------
void rrdlabels_value_to_buffer_array_item_or_null(RRDLABELS *labels, BUFFER *wb, const char *key) {
if(!labels) return;
STRING *this_key = string_strdupz(key);
RRDLABEL *lb;
RRDLABEL_SRC ls;
lfe_start_read(labels, lb, ls)
{
if (lb->index.key == this_key) {
if (lb->index.value)
buffer_json_add_array_item_string(wb, string2str(lb->index.value));
else
buffer_json_add_array_item_string(wb, NULL);
break;
}
}
lfe_done(labels);
string_freez(this_key);
}
// ----------------------------------------------------------------------------
void rrdlabels_get_value_strcpyz(RRDLABELS *labels, char *dst, size_t dst_len, const char *key) {
if(!labels) return;
STRING *this_key = string_strdupz(key);
RRDLABEL *lb;
RRDLABEL_SRC ls;
lfe_start_read(labels, lb, ls)
{
if (lb->index.key == this_key) {
if (lb->index.value)
strncpyz(dst, string2str(lb->index.value), dst_len);
else
dst[0] = '\0';
break;
}
}
lfe_done(labels);
string_freez(this_key);
}
void rrdlabels_get_value_strdup_or_null(RRDLABELS *labels, char **value, const char *key)
{
if(!labels) return;
STRING *this_key = string_strdupz(key);
RRDLABEL *lb;
RRDLABEL_SRC ls;
lfe_start_read(labels, lb, ls)
{
if (lb->index.key == this_key) {
*value = (lb->index.value) ? strdupz(string2str(lb->index.value)) : NULL;
break;
}
}
lfe_done(labels);
string_freez(this_key);
}
void rrdlabels_get_value_to_buffer_or_unset(RRDLABELS *labels, BUFFER *wb, const char *key, const char *unset)
{
if(!labels || !key || !wb) return;
STRING *this_key = string_strdupz(key);
RRDLABEL *lb;
RRDLABEL_SRC ls;
lfe_start_read(labels, lb, ls)
{
if (lb->index.key == this_key) {
if (lb->index.value)
buffer_strcat(wb, string2str(lb->index.value));
else
buffer_strcat(wb, unset);
break;
}
}
lfe_done(labels);
string_freez(this_key);
}
static void rrdlabels_unmark_all_unsafe(RRDLABELS *labels)
{
Pvoid_t *PValue;
Word_t Index = 0;
bool first_then_next = true;
while ((PValue = JudyLFirstThenNext(labels->JudyL, &Index, &first_then_next)))
*((RRDLABEL_SRC *)PValue) &= ~(RRDLABEL_FLAG_OLD | RRDLABEL_FLAG_NEW);
}
void rrdlabels_unmark_all(RRDLABELS *labels)
{
spinlock_lock(&labels->spinlock);
rrdlabels_unmark_all_unsafe(labels);
spinlock_unlock(&labels->spinlock);
}
static void rrdlabels_remove_all_unmarked_unsafe(RRDLABELS *labels)
{
Pvoid_t *PValue;
Word_t Index = 0;
bool first_then_next = true;
while ((PValue = JudyLFirstThenNext(labels->JudyL, &Index, &first_then_next))) {
if (!((*((RRDLABEL_SRC *)PValue)) & (RRDLABEL_FLAG_INTERNAL))) {
size_t mem_before_judyl = JudyLMemUsed(labels->JudyL);
(void)JudyLDel(&labels->JudyL, Index, PJE0);
size_t mem_after_judyl = JudyLMemUsed(labels->JudyL);
STATS_MINUS_MEMORY(&dictionary_stats_category_rrdlabels, 0, mem_before_judyl - mem_after_judyl, 0);
delete_label((RRDLABEL *)Index);
if (labels->JudyL != (Pvoid_t) NULL) {
Index = 0;
first_then_next = true;
}
}
}
}
void rrdlabels_remove_all_unmarked(RRDLABELS *labels)
{
spinlock_lock(&labels->spinlock);
rrdlabels_remove_all_unmarked_unsafe(labels);
spinlock_unlock(&labels->spinlock);
}
// ----------------------------------------------------------------------------
// rrdlabels_walkthrough_read()
int rrdlabels_walkthrough_read(RRDLABELS *labels, int (*callback)(const char *name, const char *value, RRDLABEL_SRC ls, void *data), void *data)
{
int ret = 0;
if(unlikely(!labels || !callback)) return 0;
RRDLABEL *lb;
RRDLABEL_SRC ls;
lfe_start_read(labels, lb, ls)
{
ret = callback(string2str(lb->index.key), string2str(lb->index.value), ls, data);
if (ret < 0)
break;
}
lfe_done(labels);
return ret;
}
static SIMPLE_PATTERN_RESULT rrdlabels_walkthrough_read_sp(RRDLABELS *labels, SIMPLE_PATTERN_RESULT (*callback)(const char *name, const char *value, RRDLABEL_SRC ls, void *data), void *data)
{
SIMPLE_PATTERN_RESULT ret = SP_NOT_MATCHED;
if(unlikely(!labels || !callback)) return 0;
RRDLABEL *lb;
RRDLABEL_SRC ls;
lfe_start_read(labels, lb, ls)
{
ret = callback(string2str(lb->index.key), string2str(lb->index.value), ls, data);
if (ret != SP_NOT_MATCHED)
break;
}
lfe_done(labels);
return ret;
}
// ----------------------------------------------------------------------------
// rrdlabels_migrate_to_these()
// migrate an existing label list to a new list
void rrdlabels_migrate_to_these(RRDLABELS *dst, RRDLABELS *src) {
if (!dst || !src || (dst == src))
return;
spinlock_lock(&dst->spinlock);
spinlock_lock(&src->spinlock);
rrdlabels_unmark_all_unsafe(dst);
RRDLABEL *label;
Pvoid_t *PValue;
RRDLABEL_SRC ls;
lfe_start_nolock(src, label, ls)
{
size_t mem_before_judyl = JudyLMemUsed(dst->JudyL);
PValue = JudyLIns(&dst->JudyL, (Word_t)label, PJE0);
if(unlikely(!PValue || PValue == PJERR))
fatal("RRDLABELS migrate: corrupted labels array");
RRDLABEL_SRC flag;
if (!*PValue) {
flag = (ls & ~(RRDLABEL_FLAG_OLD | RRDLABEL_FLAG_NEW)) | RRDLABEL_FLAG_NEW;
dup_label(label);
size_t mem_after_judyl = JudyLMemUsed(dst->JudyL);
STATS_PLUS_MEMORY(&dictionary_stats_category_rrdlabels, 0, mem_after_judyl - mem_before_judyl, 0);
}
else
flag = RRDLABEL_FLAG_OLD;
*((RRDLABEL_SRC *)PValue) |= flag;
}
lfe_done_nolock();
rrdlabels_remove_all_unmarked_unsafe(dst);
dst->version = src->version;
spinlock_unlock(&src->spinlock);
spinlock_unlock(&dst->spinlock);
}
//
//
// Return the common labels count in labels1, labels2
//
size_t rrdlabels_common_count(RRDLABELS *labels1, RRDLABELS *labels2)
{
if (!labels1 || !labels2)
return 0;
if (labels1 == labels2)
return rrdlabels_entries(labels1);
RRDLABEL *label;
RRDLABEL_SRC ls;
spinlock_lock(&labels1->spinlock);
spinlock_lock(&labels2->spinlock);
size_t count = 0;
lfe_start_nolock(labels2, label, ls)
{
RRDLABEL *old_label_with_key = rrdlabels_find_label_with_key_unsafe(labels1, label, true);
if (old_label_with_key)
count++;
}
lfe_done_nolock();
spinlock_unlock(&labels2->spinlock);
spinlock_unlock(&labels1->spinlock);
return count;
}
void rrdlabels_copy(RRDLABELS *dst, RRDLABELS *src)
{
if (!dst || !src || (dst == src))
return;
RRDLABEL *label;
RRDLABEL_SRC ls;
spinlock_lock(&dst->spinlock);
spinlock_lock(&src->spinlock);
size_t mem_before_judyl = JudyLMemUsed(dst->JudyL);
bool update_statistics = false;
lfe_start_nolock(src, label, ls)
{
RRDLABEL *old_label_with_key = rrdlabels_find_label_with_key_unsafe(dst, label, false);
Pvoid_t *PValue = JudyLIns(&dst->JudyL, (Word_t)label, PJE0);
if(unlikely(!PValue || PValue == PJERR))
fatal("RRDLABELS: corrupted labels array");
if (!*PValue) {
dup_label(label);
ls = (ls & ~(RRDLABEL_FLAG_OLD)) | RRDLABEL_FLAG_NEW;
dst->version++;
update_statistics = true;
if (old_label_with_key) {
(void)JudyLDel(&dst->JudyL, (Word_t)old_label_with_key, PJE0);
delete_label((RRDLABEL *)old_label_with_key);
}
}
else
ls = (ls & ~(RRDLABEL_FLAG_NEW)) | RRDLABEL_FLAG_OLD;
*((RRDLABEL_SRC *)PValue) = ls;
}
lfe_done_nolock();
if (update_statistics) {
size_t mem_after_judyl = JudyLMemUsed(dst->JudyL);
STATS_PLUS_MEMORY(&dictionary_stats_category_rrdlabels, 0, mem_after_judyl - mem_before_judyl, 0);
}
spinlock_unlock(&src->spinlock);
spinlock_unlock(&dst->spinlock);
}
// ----------------------------------------------------------------------------
// rrdlabels_match_simple_pattern()
// returns true when there are keys in the dictionary matching a simple pattern
struct simple_pattern_match_name_value {
size_t searches;
SIMPLE_PATTERN *pattern;
char equal;
};
static SIMPLE_PATTERN_RESULT simple_pattern_match_name_only_callback(const char *name, const char *value, RRDLABEL_SRC ls __maybe_unused, void *data) {
struct simple_pattern_match_name_value *t = (struct simple_pattern_match_name_value *)data;
(void)value;
// we return -1 to stop the walkthrough on first match
t->searches++;
SIMPLE_PATTERN_RESULT ret = simple_pattern_matches_extract(t->pattern, name, NULL, 0);
if (ret == SP_MATCHED_NEGATIVE)
ret = SP_NOT_MATCHED;
return ret;
}
static SIMPLE_PATTERN_RESULT simple_pattern_match_name_and_value_callback(const char *name, const char *value, RRDLABEL_SRC ls __maybe_unused, void *data) {
struct simple_pattern_match_name_value *t = (struct simple_pattern_match_name_value *)data;
// we return -1 to stop the walkthrough on first match
t->searches++;
if(simple_pattern_matches(t->pattern, name)) return -1;
size_t len = RRDLABELS_MAX_NAME_LENGTH + RRDLABELS_MAX_VALUE_LENGTH + 2; // +1 for =, +1 for \0
char tmp[len], *dst = &tmp[0];
const char *v = value;
// copy the name
while(*name) *dst++ = *name++;
// add the equal
*dst++ = t->equal;
// add the value
while(*v) *dst++ = *v++;
// terminate it
*dst = '\0';
t->searches++;
return simple_pattern_matches_length_extract(t->pattern, tmp, dst - tmp, NULL, 0);
}
SIMPLE_PATTERN_RESULT rrdlabels_match_simple_pattern_parsed(RRDLABELS *labels, SIMPLE_PATTERN *pattern, char equal, size_t *searches) {
if (!labels) return false;
struct simple_pattern_match_name_value t = {
.searches = 0,
.pattern = pattern,
.equal = equal
};
SIMPLE_PATTERN_RESULT ret = rrdlabels_walkthrough_read_sp(labels, equal?simple_pattern_match_name_and_value_callback:simple_pattern_match_name_only_callback, &t);
if(searches)
*searches = t.searches;
return ret;
}
bool rrdlabels_match_simple_pattern(RRDLABELS *labels, const char *simple_pattern_txt) {
if (!labels) return false;
SIMPLE_PATTERN *pattern = simple_pattern_create(simple_pattern_txt, " ,|\t\r\n\f\v", SIMPLE_PATTERN_EXACT, true);
char equal = '\0';
const char *s;
for(s = simple_pattern_txt; *s ; s++) {
if (*s == '=' || *s == ':') {
equal = *s;
break;
}
}
SIMPLE_PATTERN_RESULT ret = rrdlabels_match_simple_pattern_parsed(labels, pattern, equal, NULL);
simple_pattern_free(pattern);
return ret == SP_MATCHED_POSITIVE;
}
// ----------------------------------------------------------------------------
// Log all labels
static int rrdlabels_log_label_to_buffer_callback(const char *name, const char *value, void *data) {
BUFFER *wb = (BUFFER *)data;
buffer_sprintf(wb, "Label: %s: \"%s\" (", name, value);
buffer_strcat(wb, "unknown");
buffer_strcat(wb, ")\n");
return 1;
}
void rrdlabels_log_to_buffer(RRDLABELS *labels, BUFFER *wb)
{
RRDLABEL *lb;
RRDLABEL_SRC ls;
lfe_start_read(labels, lb, ls)
rrdlabels_log_label_to_buffer_callback((void *) string2str(lb->index.key), (void *) string2str(lb->index.value), wb);
lfe_done(labels);
}
// ----------------------------------------------------------------------------
// rrdlabels_to_buffer()
struct labels_to_buffer {
BUFFER *wb;
bool (*filter_callback)(const char *name, const char *value, RRDLABEL_SRC ls, void *data);
void *filter_data;
void (*name_sanitizer)(char *dst, const char *src, size_t dst_size);
void (*value_sanitizer)(char *dst, const char *src, size_t dst_size);
const char *before_each;
const char *quote;
const char *equal;
const char *between_them;
size_t count;
};
static int label_to_buffer_callback(const RRDLABEL *lb, void *value __maybe_unused, RRDLABEL_SRC ls, void *data)
{
struct labels_to_buffer *t = (struct labels_to_buffer *)data;
size_t n_size = (t->name_sanitizer ) ? ( RRDLABELS_MAX_NAME_LENGTH * 2 ) : 1;
size_t v_size = (t->value_sanitizer) ? ( RRDLABELS_MAX_VALUE_LENGTH * 2 ) : 1;
char n[n_size];
char v[v_size];
const char *name = string2str(lb->index.key);
const char *nn = name, *vv = string2str(lb->index.value);
if(t->name_sanitizer) {
t->name_sanitizer(n, name, n_size);
nn = n;
}
if(t->value_sanitizer) {
t->value_sanitizer(v, string2str(lb->index.value), v_size);
vv = v;
}
if(!t->filter_callback || t->filter_callback(name, string2str(lb->index.value), ls, t->filter_data)) {
buffer_sprintf(t->wb, "%s%s%s%s%s%s%s%s%s", t->count++?t->between_them:"", t->before_each, t->quote, nn, t->quote, t->equal, t->quote, vv, t->quote);
return 1;
}
return 0;
}
int label_walkthrough_read(RRDLABELS *labels, int (*callback)(const RRDLABEL *item, void *entry, RRDLABEL_SRC ls, void *data), void *data)
{
int ret = 0;
if(unlikely(!labels || !callback)) return 0;
RRDLABEL *lb;
RRDLABEL_SRC ls;
lfe_start_read(labels, lb, ls)
{
ret = callback((const RRDLABEL *)lb, (void *)string2str(lb->index.value), ls, data);
if (ret < 0)
break;
}
lfe_done(labels);
return ret;
}
int rrdlabels_to_buffer(RRDLABELS *labels, BUFFER *wb, const char *before_each, const char *equal, const char *quote, const char *between_them, bool (*filter_callback)(const char *name, const char *value, RRDLABEL_SRC ls, void *data), void *filter_data, void (*name_sanitizer)(char *dst, const char *src, size_t dst_size), void (*value_sanitizer)(char *dst, const char *src, size_t dst_size)) {
struct labels_to_buffer tmp = {
.wb = wb,
.filter_callback = filter_callback,
.filter_data = filter_data,
.name_sanitizer = name_sanitizer,
.value_sanitizer = value_sanitizer,
.before_each = before_each,
.equal = equal,
.quote = quote,
.between_them = between_them,
.count = 0
};
return label_walkthrough_read(labels, label_to_buffer_callback, (void *)&tmp);
}
void rrdlabels_to_buffer_json_members(RRDLABELS *labels, BUFFER *wb)
{
RRDLABEL *lb;
RRDLABEL_SRC ls;
lfe_start_read(labels, lb, ls)
buffer_json_member_add_string(wb, string2str(lb->index.key), string2str(lb->index.value));
lfe_done(labels);
}
size_t rrdlabels_entries(RRDLABELS *labels __maybe_unused)
{
if (unlikely(!labels))
return 0;
size_t count;
spinlock_lock(&labels->spinlock);
count = JudyLCount(labels->JudyL, 0, -1, PJE0);
spinlock_unlock(&labels->spinlock);
return count;
}
size_t rrdlabels_version(RRDLABELS *labels __maybe_unused)
{
if (unlikely(!labels))
return 0;
return (size_t) labels->version;
}
void rrdset_update_rrdlabels(RRDSET *st, RRDLABELS *new_rrdlabels) {
if(!st->rrdlabels)
st->rrdlabels = rrdlabels_create();
if (new_rrdlabels)
rrdlabels_migrate_to_these(st->rrdlabels, new_rrdlabels);
rrdset_flag_set(st, RRDSET_FLAG_METADATA_UPDATE);
rrdhost_flag_set(st->rrdhost, RRDHOST_FLAG_METADATA_UPDATE);
rrdset_metadata_updated(st);
}
struct pattern_array *pattern_array_allocate()
{
struct pattern_array *pa = callocz(1, sizeof(*pa));
return pa;
}
static void pattern_array_add_lblkey_with_sp(struct pattern_array *pa, const char *key, SIMPLE_PATTERN *sp)
{
if (!pa || !key || !sp)
return;
STRING *string_key = string_strdupz(key);
Pvoid_t *Pvalue = JudyLIns(&pa->JudyL, (Word_t) string_key, PJE0);
if (!Pvalue) {
string_freez(string_key);
simple_pattern_free(sp);
return;
}
struct pattern_array_item *pai;
if (*Pvalue) {
pai = *Pvalue;
} else {
*Pvalue = pai = callocz(1, sizeof(*pai));
pa->key_count++;
}
pai->size++;
Pvalue = JudyLIns(&pai->JudyL, (Word_t) pai->size, PJE0);
if (!Pvalue) {
simple_pattern_free(sp);
return;
}
*Pvalue = sp;
}
bool pattern_array_label_match(
struct pattern_array *pa,
RRDLABELS *labels,
char eq,
size_t *searches)
{
if (!pa || !labels)
return true;
Pvoid_t *Pvalue;
Word_t Index = 0;
bool first_then_next = true;
while ((Pvalue = JudyLFirstThenNext(pa->JudyL, &Index, &first_then_next))) {
// for each label key in the patterns array
struct pattern_array_item *pai = *Pvalue;
SIMPLE_PATTERN_RESULT match = SP_NOT_MATCHED ;
for (Word_t i = 1; i <= pai->size; i++) {
// for each pattern in the label key pattern list
if (!(Pvalue = JudyLGet(pai->JudyL, i, PJE0)) || !*Pvalue)
continue;
match = rrdlabels_match_simple_pattern_parsed(labels, (SIMPLE_PATTERN *)(*Pvalue), eq, searches);
if(match != SP_NOT_MATCHED)
break;
}
if (match != SP_MATCHED_POSITIVE)
return false;
}
return true;
}
struct pattern_array *pattern_array_add_key_simple_pattern(struct pattern_array *pa, const char *key, SIMPLE_PATTERN *pattern)
{
if (unlikely(!pattern || !key))
return pa;
if (!pa)
pa = pattern_array_allocate();
pattern_array_add_lblkey_with_sp(pa, key, pattern);
return pa;
}
struct pattern_array *pattern_array_add_simple_pattern(struct pattern_array *pa, SIMPLE_PATTERN *pattern, char sep)
{
if (unlikely(!pattern))
return pa;
if (!pa)
pa = pattern_array_allocate();
char *label_key;
while (pattern && (label_key = simple_pattern_iterate(&pattern))) {
char key[RRDLABELS_MAX_NAME_LENGTH + 1], *key_sep;
if (unlikely(!label_key || !(key_sep = strchr(label_key, sep))))
return pa;
*key_sep = '\0';
strncpyz(key, label_key, RRDLABELS_MAX_NAME_LENGTH);
*key_sep = sep;
pattern_array_add_lblkey_with_sp(pa, key, string_to_simple_pattern(label_key));
}
return pa;
}
struct pattern_array *pattern_array_add_key_value(struct pattern_array *pa, const char *key, const char *value, char sep)
{
if (unlikely(!key || !value))
return pa;
if (!pa)
pa = pattern_array_allocate();
char label_key[RRDLABELS_MAX_NAME_LENGTH + RRDLABELS_MAX_VALUE_LENGTH + 2];
snprintfz(label_key, sizeof(label_key) - 1, "%s%c%s", key, sep, value);
pattern_array_add_lblkey_with_sp(
pa, key, simple_pattern_create(label_key, SIMPLE_PATTERN_DEFAULT_WEB_SEPARATORS, SIMPLE_PATTERN_EXACT, true));
return pa;
}
void pattern_array_free(struct pattern_array *pa)
{
if (!pa)
return;
Pvoid_t *Pvalue;
Word_t Index = 0;
while ((Pvalue = JudyLFirst(pa->JudyL, &Index, PJE0))) {
struct pattern_array_item *pai = *Pvalue;
for (Word_t i = 1; i <= pai->size; i++) {
if (!(Pvalue = JudyLGet(pai->JudyL, i, PJE0)))
continue;
simple_pattern_free((SIMPLE_PATTERN *) (*Pvalue));
}
JudyLFreeArray(&(pai->JudyL), PJE0);
string_freez((STRING *)Index);
(void) JudyLDel(&(pa->JudyL), Index, PJE0);
freez(pai);
Index = 0;
}
freez(pa);
}
// ----------------------------------------------------------------------------
// rrdlabels unit test
struct rrdlabels_unittest_add_a_pair {
const char *pair;
const char *expected_name;
const char *expected_value;
const char *name;
const char *value;
int errors;
};
RRDLABEL *rrdlabels_find_label_with_key(RRDLABELS *labels, const char *key, RRDLABEL_SRC *source)
{
if (!labels || !key)
return NULL;
STRING *this_key = string_strdupz(key);
RRDLABEL *lb = NULL;
RRDLABEL_SRC ls;
lfe_start_read(labels, lb, ls)
{
if (lb->index.key == this_key) {
if (source)
*source = ls;
break;
}
}
lfe_done(labels);
string_freez(this_key);
return lb;
}
static int rrdlabels_unittest_add_a_pair_callback(const char *name, const char *value, RRDLABEL_SRC ls __maybe_unused, void *data) {
struct rrdlabels_unittest_add_a_pair *t = (struct rrdlabels_unittest_add_a_pair *)data;
t->name = name;
t->value = value;
if(strcmp(name, t->expected_name) != 0) {
fprintf(stderr, "name is wrong, found \"%s\", expected \"%s\"", name, t->expected_name);
t->errors++;
}
if(value == NULL && t->expected_value == NULL) {
;
}
else if(value == NULL || t->expected_value == NULL) {
fprintf(stderr, "value is wrong, found \"%s\", expected \"%s\"", value?value:"(null)", t->expected_value?t->expected_value:"(null)");
t->errors++;
}
else if(strcmp(value, t->expected_value) != 0) {
fprintf(stderr, "values don't match, found \"%s\", expected \"%s\"", value, t->expected_value);
t->errors++;
}
return 1;
}
static int rrdlabels_unittest_add_a_pair(const char *pair, const char *name, const char *value) {
RRDLABELS *labels = rrdlabels_create();
int errors;
fprintf(stderr, "rrdlabels_add_pair(labels, %s) ... ", pair);
rrdlabels_add_pair(labels, pair, RRDLABEL_SRC_CONFIG);
struct rrdlabels_unittest_add_a_pair tmp = {
.pair = pair,
.expected_name = name,
.expected_value = value,
.errors = 0
};
int ret = rrdlabels_walkthrough_read(labels, rrdlabels_unittest_add_a_pair_callback, &tmp);
errors = tmp.errors;
if(ret != 1) {
fprintf(stderr, "failed to get \"%s\" label", name);
errors++;
}
if(!errors)
fprintf(stderr, " OK, name='%s' and value='%s'\n", tmp.name, tmp.value?tmp.value:"(null)");
else
fprintf(stderr, " FAILED\n");
rrdlabels_destroy(labels);
return errors;
}
static int rrdlabels_unittest_add_pairs() {
fprintf(stderr, "\n%s() tests\n", __FUNCTION__);
int errors = 0;
// basic test
errors += rrdlabels_unittest_add_a_pair("tag=value", "tag", "value");
errors += rrdlabels_unittest_add_a_pair("tag:value", "tag", "value");
// test newlines
errors += rrdlabels_unittest_add_a_pair(" tag = \t value \r\n", "tag", "value");
// test : in values
errors += rrdlabels_unittest_add_a_pair("tag=:value", "tag", ":value");
errors += rrdlabels_unittest_add_a_pair("tag::value", "tag", ":value");
errors += rrdlabels_unittest_add_a_pair(" tag = :value ", "tag", ":value");
errors += rrdlabels_unittest_add_a_pair(" tag : :value ", "tag", ":value");
errors += rrdlabels_unittest_add_a_pair("tag:5", "tag", "5");
errors += rrdlabels_unittest_add_a_pair("tag:55", "tag", "55");
errors += rrdlabels_unittest_add_a_pair("tag:aa", "tag", "aa");
errors += rrdlabels_unittest_add_a_pair("tag:a", "tag", "a");
// test empty values
errors += rrdlabels_unittest_add_a_pair("tag", "tag", "[none]");
errors += rrdlabels_unittest_add_a_pair("tag:", "tag", "[none]");
errors += rrdlabels_unittest_add_a_pair("tag:\"\"", "tag", "[none]");
errors += rrdlabels_unittest_add_a_pair("tag:''", "tag", "[none]");
errors += rrdlabels_unittest_add_a_pair("tag:\r\n", "tag", "[none]");
errors += rrdlabels_unittest_add_a_pair("tag\r\n", "tag", "[none]");
// test UTF-8 in values
errors += rrdlabels_unittest_add_a_pair("tag: country:Ελλάδα", "tag", "country:Ελλάδα");
errors += rrdlabels_unittest_add_a_pair("\"tag\": \"country:Ελλάδα\"", "tag", "country:Ελλάδα");
errors += rrdlabels_unittest_add_a_pair("\"tag\": country:\"Ελλάδα\"", "tag", "country:Ελλάδα");
errors += rrdlabels_unittest_add_a_pair("\"tag=1\": country:\"Gre\\\"ece\"", "tag_1", "country:Gre_ece");
errors += rrdlabels_unittest_add_a_pair("\"tag=1\" = country:\"Gre\\\"ece\"", "tag_1", "country:Gre_ece");
errors += rrdlabels_unittest_add_a_pair("\t'LABE=L'\t=\t\"World\" peace", "labe_l", "World peace");
errors += rrdlabels_unittest_add_a_pair("\t'LA\\'B:EL'\t=\tcountry:\"World\":\"Europe\":\"Greece\"", "la_b_el", "country:World:Europe:Greece");
errors += rrdlabels_unittest_add_a_pair("\t'LA\\'B:EL'\t=\tcountry\\\"World\"\\\"Europe\"\\\"Greece\"", "la_b_el", "country/World/Europe/Greece");
errors += rrdlabels_unittest_add_a_pair("NAME=\"VALUE\"", "name", "VALUE");
errors += rrdlabels_unittest_add_a_pair("\"NAME\" : \"VALUE\"", "name", "VALUE");
errors += rrdlabels_unittest_add_a_pair("NAME: \"VALUE\"", "name", "VALUE");
return errors;
}
static int rrdlabels_unittest_expect_value(RRDLABELS *labels, const char *key, const char *value, RRDLABEL_SRC required_source)
{
RRDLABEL_SRC source;
RRDLABEL *label = rrdlabels_find_label_with_key(labels, key, &source);
return (!label || strcmp(string2str(label->index.value), value) != 0 || (source != required_source));
}
static int rrdlabels_unittest_double_check()
{
fprintf(stderr, "\n%s() tests\n", __FUNCTION__);
int ret = 0;
RRDLABELS *labels = rrdlabels_create();
rrdlabels_add(labels, "key1", "value1", RRDLABEL_SRC_CONFIG);
ret += rrdlabels_unittest_expect_value(labels, "key1", "value1", RRDLABEL_FLAG_NEW | RRDLABEL_SRC_CONFIG);
rrdlabels_add(labels, "key1", "value2", RRDLABEL_SRC_CONFIG);
ret += !rrdlabels_unittest_expect_value(labels, "key1", "value2", RRDLABEL_FLAG_OLD | RRDLABEL_SRC_CONFIG);
rrdlabels_add(labels, "key2", "value1", RRDLABEL_SRC_ACLK|RRDLABEL_SRC_AUTO);
ret += !rrdlabels_unittest_expect_value(labels, "key1", "value3", RRDLABEL_FLAG_NEW | RRDLABEL_SRC_ACLK);
ret += (rrdlabels_entries(labels) != 2);
rrdlabels_destroy(labels);
if (ret)
fprintf(stderr, "\n%s() tests failed\n", __FUNCTION__);
return ret;
}
static int rrdlabels_walkthrough_index_read(RRDLABELS *labels, int (*callback)(const char *name, const char *value, RRDLABEL_SRC ls, size_t index, void *data), void *data)
{
int ret = 0;
if(unlikely(!labels || !callback)) return 0;
RRDLABEL *lb;
RRDLABEL_SRC ls;
size_t index = 0;
lfe_start_read(labels, lb, ls)
{
ret = callback(string2str(lb->index.key), string2str(lb->index.value), ls, index, data);
if (ret < 0)
break;
index++;
}
lfe_done(labels);
return ret;
}
static int unittest_dump_labels(const char *name, const char *value, RRDLABEL_SRC ls, size_t index, void *data __maybe_unused)
{
if (!index && data) {
fprintf(stderr, "%s\n", (char *) data);
}
fprintf(stderr, "LABEL \"%s\" = %d \"%s\"\n", name, ls & (~RRDLABEL_FLAG_INTERNAL), value);
return 1;
}
static int rrdlabels_unittest_pattern_check()
{
fprintf(stderr, "\n%s() tests\n", __FUNCTION__);
int rc = 0;
RRDLABELS *labels = NULL;
labels = rrdlabels_create();
rrdlabels_add(labels, "_module", "disk_detection", RRDLABEL_SRC_CONFIG);
rrdlabels_add(labels, "_plugin", "super_plugin", RRDLABEL_SRC_CONFIG);
rrdlabels_add(labels, "key1", "value1", RRDLABEL_SRC_CONFIG);
rrdlabels_add(labels, "key2", "caterpillar", RRDLABEL_SRC_CONFIG);
rrdlabels_add(labels, "key3", "elephant", RRDLABEL_SRC_CONFIG);
rrdlabels_add(labels, "key4", "value4", RRDLABEL_SRC_CONFIG);
bool match;
struct pattern_array *pa = pattern_array_add_key_value(NULL, "_module", "wrong_module", '=');
match = pattern_array_label_match(pa, labels, '=', NULL);
// This should not match: _module in ("wrong_module")
if (match)
rc++;
pattern_array_add_key_value(pa, "_module", "disk_detection", '=');
match = pattern_array_label_match(pa, labels, '=', NULL);
// This should match: _module in ("wrong_module","disk_detection")
if (!match)
rc++;
pattern_array_add_key_value(pa, "key1", "wrong_key1_value", '=');
match = pattern_array_label_match(pa, labels, '=', NULL);
// This should not match: _module in ("wrong_module","disk_detection") AND key1 in ("wrong_key1_value")
if (match)
rc++;
pattern_array_add_key_value(pa, "key1", "value1", '=');
match = pattern_array_label_match(pa, labels, '=', NULL);
// This should match: _module in ("wrong_module","disk_detection") AND key1 in ("wrong_key1_value", "value1")
if (!match)
rc++;
SIMPLE_PATTERN *sp = simple_pattern_create("key2=cat*,!d*", SIMPLE_PATTERN_DEFAULT_WEB_SEPARATORS, SIMPLE_PATTERN_EXACT, true);
pattern_array_add_lblkey_with_sp(pa, "key2", sp);
sp = simple_pattern_create("key3=*phant", SIMPLE_PATTERN_DEFAULT_WEB_SEPARATORS, SIMPLE_PATTERN_EXACT, true);
pattern_array_add_lblkey_with_sp(pa, "key3", sp);
match = pattern_array_label_match(pa, labels, '=', NULL);
// This should match: _module in ("wrong_module","disk_detection") AND key1 in ("wrong_key1_value", "value1") AND key2 in ("cat* !d*") AND key3 in ("*phant")
if (!match)
rc++;
rrdlabels_add(labels, "key3", "now_fail", RRDLABEL_SRC_CONFIG);
match = pattern_array_label_match(pa, labels, '=', NULL);
// This should not match: _module in ("wrong_module","disk_detection") AND key1 in ("wrong_key1_value", "value1") AND key2 in ("cat* !d*") AND key3 in ("*phant")
if (match)
rc++;
pattern_array_free(pa);
rrdlabels_destroy(labels);
return rc;
}
static int rrdlabels_unittest_migrate_check()
{
fprintf(stderr, "\n%s() tests\n", __FUNCTION__);
RRDLABELS *labels1 = NULL;
RRDLABELS *labels2 = NULL;
labels1 = rrdlabels_create();
labels2 = rrdlabels_create();
rrdlabels_add(labels1, "key1", "value1", RRDLABEL_SRC_CONFIG);
rrdlabels_add(labels1, "key1", "value2", RRDLABEL_SRC_CONFIG);
rrdlabels_add(labels2, "new_key1", "value2", RRDLABEL_SRC_CONFIG);
rrdlabels_add(labels2, "new_key2", "value2", RRDLABEL_SRC_CONFIG);
rrdlabels_add(labels2, "key1", "value2", RRDLABEL_SRC_CONFIG);
fprintf(stderr, "Labels1 entries found %zu (should be 1)\n", rrdlabels_entries(labels1));
fprintf(stderr, "Labels2 entries found %zu (should be 3)\n", rrdlabels_entries(labels2));
rrdlabels_migrate_to_these(labels1, labels2);
int rc = 0;
rc = rrdlabels_unittest_expect_value(labels1, "key1", "value2", RRDLABEL_FLAG_OLD | RRDLABEL_SRC_CONFIG);
if (rc)
return rc;
fprintf(stderr, "labels1 (migrated) entries found %zu (should be 3)\n", rrdlabels_entries(labels1));
size_t entries = rrdlabels_entries(labels1);
rrdlabels_destroy(labels1);
rrdlabels_destroy(labels2);
if (entries != 3)
return 1;
// Copy test
labels1 = rrdlabels_create();
labels2 = rrdlabels_create();
rrdlabels_add(labels1, "key1", "value1", RRDLABEL_SRC_CONFIG);
rrdlabels_add(labels1, "key2", "value2", RRDLABEL_SRC_CONFIG);
rrdlabels_add(labels1, "key3", "value3", RRDLABEL_SRC_CONFIG);
rrdlabels_add(labels1, "key4", "value4", RRDLABEL_SRC_CONFIG); // 4 keys
rrdlabels_walkthrough_index_read(labels1, unittest_dump_labels, "\nlabels1");
rrdlabels_add(labels2, "key0", "value0", RRDLABEL_SRC_CONFIG);
rrdlabels_add(labels2, "key1", "value1", RRDLABEL_SRC_CONFIG);
rrdlabels_add(labels2, "key2", "value2", RRDLABEL_SRC_CONFIG);
rc = rrdlabels_unittest_expect_value(labels1, "key1", "value1", RRDLABEL_FLAG_NEW | RRDLABEL_SRC_CONFIG);
if (rc)
return rc;
rrdlabels_walkthrough_index_read(labels2, unittest_dump_labels, "\nlabels2");
rrdlabels_copy(labels1, labels2); // labels1 should have 5 keys
rc = rrdlabels_unittest_expect_value(labels1, "key1", "value1", RRDLABEL_FLAG_OLD | RRDLABEL_SRC_CONFIG);
if (rc)
return rc;
rc = rrdlabels_unittest_expect_value(labels1, "key0", "value0", RRDLABEL_FLAG_NEW | RRDLABEL_SRC_CONFIG);
if (rc)
return rc;
rrdlabels_walkthrough_index_read(labels1, unittest_dump_labels, "\nlabels1 after copy from labels2");
entries = rrdlabels_entries(labels1);
fprintf(stderr, "labels1 (copied) entries found %zu (should be 5)\n", rrdlabels_entries(labels1));
if (entries != 5)
return 1;
rrdlabels_add(labels1, "key0", "value0", RRDLABEL_SRC_CONFIG);
rc = rrdlabels_unittest_expect_value(labels1, "key0", "value0", RRDLABEL_FLAG_OLD | RRDLABEL_SRC_CONFIG);
rrdlabels_destroy(labels1);
rrdlabels_destroy(labels2);
return rc;
}
struct pattern_array *trim_and_add_key_to_values(struct pattern_array *pa, const char *key, STRING *input);
static int rrdlabels_unittest_check_pattern_list(RRDLABELS *labels, const char *pattern, bool expected) {
fprintf(stderr, "rrdlabels_match_simple_pattern(labels, \"%s\") ... ", pattern);
STRING *str = string_strdupz(pattern);
struct pattern_array *pa = trim_and_add_key_to_values(NULL, NULL, str);
bool ret = pattern_array_label_match(pa, labels, '=', NULL);
fprintf(stderr, "%s, got %s expected %s\n", (ret == expected)?"OK":"FAILED", ret?"true":"false", expected?"true":"false");
string_freez(str);
pattern_array_free(pa);
return (ret == expected)?0:1;
}
static int rrdlabels_unittest_host_chart_labels() {
fprintf(stderr, "\n%s() tests\n", __FUNCTION__);
int errors = 0;
RRDLABELS *labels = rrdlabels_create();
rrdlabels_add(labels, "_hostname", "hostname1", RRDLABEL_SRC_CONFIG);
rrdlabels_add(labels, "_os", "linux", RRDLABEL_SRC_CONFIG);
rrdlabels_add(labels, "_distro", "ubuntu", RRDLABEL_SRC_CONFIG);
// match a single key
errors += rrdlabels_unittest_check_pattern_list(labels, "_hostname=*", true);
errors += rrdlabels_unittest_check_pattern_list(labels, "_hostname=!*", false);
// conflicting keys (some positive, some negative)
errors += rrdlabels_unittest_check_pattern_list(labels, "_hostname=* _os=!*", false);
errors += rrdlabels_unittest_check_pattern_list(labels, "_hostname=!* _os=*", false);
// the user uses a key that is not there
errors += rrdlabels_unittest_check_pattern_list(labels, "_not_a_key=*", false);
errors += rrdlabels_unittest_check_pattern_list(labels, "_not_a_key=!*", false);
errors += rrdlabels_unittest_check_pattern_list(labels, "_not_a_key=* _hostname=* _os=*", false);
errors += rrdlabels_unittest_check_pattern_list(labels, "_not_a_key=!* _hostname=* _os=*", false);
// positive and negative matches on the same key
errors += rrdlabels_unittest_check_pattern_list(labels, "_hostname=!*invalid* !*bad* *name*", true);
errors += rrdlabels_unittest_check_pattern_list(labels, "_hostname=*name* !*invalid* !*bad*", true);
// positive and negative matches on the same key with catch all
errors += rrdlabels_unittest_check_pattern_list(labels, "_hostname=!*invalid* !*bad* *", true);
errors += rrdlabels_unittest_check_pattern_list(labels, "_hostname=* !*invalid* !*bad*", true);
errors += rrdlabels_unittest_check_pattern_list(labels, "_hostname=!*invalid* !*name* *", false);
errors += rrdlabels_unittest_check_pattern_list(labels, "_hostname=* !*invalid* !*name*", true);
errors += rrdlabels_unittest_check_pattern_list(labels, "_hostname=*name* !*", true);
errors += rrdlabels_unittest_check_pattern_list(labels, "_hostname=!*name* _os=l*", false);
errors += rrdlabels_unittest_check_pattern_list(labels, "_os=l* hostname=!*name*", false);
errors += rrdlabels_unittest_check_pattern_list(labels, "_hostname=*name* _hostname=*", true);
errors += rrdlabels_unittest_check_pattern_list(labels, "_hostname=*name* _os=l*", true);
errors += rrdlabels_unittest_check_pattern_list(labels, "_os=l* _hostname=*name*", true);
rrdlabels_destroy(labels);
return errors;
}
static int rrdlabels_unittest_check_simple_pattern(RRDLABELS *labels, const char *pattern, bool expected) {
fprintf(stderr, "rrdlabels_match_simple_pattern(labels, \"%s\") ... ", pattern);
bool ret = rrdlabels_match_simple_pattern(labels, pattern);
fprintf(stderr, "%s, got %s expected %s\n", (ret == expected)?"OK":"FAILED", ret?"true":"false", expected?"true":"false");
return (ret == expected)?0:1;
}
static int rrdlabels_unittest_simple_pattern() {
fprintf(stderr, "\n%s() tests\n", __FUNCTION__);
int errors = 0;
RRDLABELS *labels = rrdlabels_create();
rrdlabels_add(labels, "tag1", "value1", RRDLABEL_SRC_CONFIG);
rrdlabels_add(labels, "tag2", "value2", RRDLABEL_SRC_CONFIG);
rrdlabels_add(labels, "tag3", "value3", RRDLABEL_SRC_CONFIG);
errors += rrdlabels_unittest_check_simple_pattern(labels, "*", true);
errors += rrdlabels_unittest_check_simple_pattern(labels, "tag", false);
errors += rrdlabels_unittest_check_simple_pattern(labels, "tag*", true);
errors += rrdlabels_unittest_check_simple_pattern(labels, "*1", true);
errors += rrdlabels_unittest_check_simple_pattern(labels, "value*", false);
errors += rrdlabels_unittest_check_simple_pattern(labels, "*=value*", true);
errors += rrdlabels_unittest_check_simple_pattern(labels, "*:value*", true);
errors += rrdlabels_unittest_check_simple_pattern(labels, "*2", true);
errors += rrdlabels_unittest_check_simple_pattern(labels, "*2 *3", true);
errors += rrdlabels_unittest_check_simple_pattern(labels, "!tag3 *2", true);
errors += rrdlabels_unittest_check_simple_pattern(labels, "tag1 tag2", true);
errors += rrdlabels_unittest_check_simple_pattern(labels, "tag1tag2", false);
errors += rrdlabels_unittest_check_simple_pattern(labels, "invalid1 invalid2 tag3", true);
errors += rrdlabels_unittest_check_simple_pattern(labels, "!tag1 tag4", false);
errors += rrdlabels_unittest_check_simple_pattern(labels, "tag1=value1", true);
errors += rrdlabels_unittest_check_simple_pattern(labels, "tag1=value2", false);
errors += rrdlabels_unittest_check_simple_pattern(labels, "tag*=value*", true);
errors += rrdlabels_unittest_check_simple_pattern(labels, "!tag*=value*", false);
errors += rrdlabels_unittest_check_simple_pattern(labels, "!tag2=something2 tag2=*2", true);
rrdlabels_destroy(labels);
return errors;
}
int rrdlabels_unittest_sanitize_value(const char *src, const char *expected) {
char buf[RRDLABELS_MAX_VALUE_LENGTH + 1];
size_t len = rrdlabels_sanitize_value(buf, src, RRDLABELS_MAX_VALUE_LENGTH);
size_t expected_len = strlen(expected);
int err = 0;
if(strcmp(buf, expected) != 0) err = 1;
if(len != expected_len) err = 1;
fprintf(stderr, "%s(%s): %s, expected '%s', got '%s', expected bytes = %zu, got bytes = %zu\n", __FUNCTION__, src, (err==1)?"FAILED":"OK", expected, buf, expected_len, strlen(buf));
return err;
}
int rrdlabels_unittest_sanitization() {
int errors = 0;
errors += rrdlabels_unittest_sanitize_value("", "[none]");
errors += rrdlabels_unittest_sanitize_value("1", "1");
errors += rrdlabels_unittest_sanitize_value(" hello world ", "hello world");
errors += rrdlabels_unittest_sanitize_value("[none]", "[none]");
// 2-byte UTF-8
errors += rrdlabels_unittest_sanitize_value(" Ελλάδα ", "Ελλάδα");
errors += rrdlabels_unittest_sanitize_value("aŰbŲcŴ", "aŰbŲcŴ");
errors += rrdlabels_unittest_sanitize_value("Ű b Ų c Ŵ", "Ű b Ų c Ŵ");
// 3-byte UTF-8
errors += rrdlabels_unittest_sanitize_value("‱", "‱");
errors += rrdlabels_unittest_sanitize_value("a‱b", "a‱b");
errors += rrdlabels_unittest_sanitize_value("a ‱ b", "a ‱ b");
// 4-byte UTF-8
errors += rrdlabels_unittest_sanitize_value("𩸽", "𩸽");
errors += rrdlabels_unittest_sanitize_value("a𩸽b", "a𩸽b");
errors += rrdlabels_unittest_sanitize_value("a 𩸽 b", "a 𩸽 b");
// mixed multi-byte
errors += rrdlabels_unittest_sanitize_value("Ű‱𩸽‱Ű", "Ű‱𩸽‱Ű");
return errors;
}
int rrdlabels_unittest(void) {
int errors = 0;
errors += rrdlabels_unittest_sanitization();
errors += rrdlabels_unittest_add_pairs();
errors += rrdlabels_unittest_simple_pattern();
errors += rrdlabels_unittest_host_chart_labels();
errors += rrdlabels_unittest_double_check();
errors += rrdlabels_unittest_migrate_check();
errors += rrdlabels_unittest_pattern_check();
fprintf(stderr, "%d errors found\n", errors);
return errors;
}