forked from netdata/netdata
-
Notifications
You must be signed in to change notification settings - Fork 0
/
rrdlabels.c
1148 lines (957 loc) · 36 KB
/
rrdlabels.c
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
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
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
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// SPDX-License-Identifier: GPL-3.0-or-later
#define NETDATA_RRD_INTERNALS
#include "rrd.h"
#ifdef UNIT_TESTING
// cmocka workaround for strdupz()
#ifdef strdupz
#undef strdupz
#endif // strdupz
#define strdupz(x) strdup(x)
#endif // UNIT_TESTING
// ----------------------------------------------------------------------------
// 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 -> _
* Backslash \ -> / -> _
* At @ yes -> _
* Space -> _ -> _
* 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 - convert SPACE to underscore
[33] = '_', // !
[34] = '_', // "
[35] = '_', // #
[36] = '_', // $
[37] = '_', // %
[38] = '_', // &
[39] = '_', // '
[40] = '_', // (
[41] = '_', // )
[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] = '_', // [
[92] = '/', // backslash convert \ to /
[93] = '_', // ]
[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['\\'] = '_';
// create the spaces map
for(i = 0; i < 256 ;i++)
label_spaces_char_map[i] = (isspace(i) || iscntrl(i) || !isprint(i))?1:0;
}
static size_t rrdlabels_sanitize(unsigned char *dst, const unsigned char *src, size_t dst_size, unsigned char *char_map, bool utf) {
if(unlikely(!dst_size)) return 0;
if(unlikely(!src || !*src)) {
*dst = '\0';
return 0;
}
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 white 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
d = dst;
while(*d == '_') d++;
if(!*d) {
*dst = '\0';
mblen = 0;
}
return mblen;
}
static inline size_t rrdlabels_sanitize_name(char *dst, const char *src, size_t dst_size) {
return rrdlabels_sanitize((unsigned char *)dst, (const unsigned char *)src, dst_size, label_names_char_map, 0);
}
static inline size_t rrdlabels_sanitize_value(char *dst, const char *src, size_t dst_size) {
return rrdlabels_sanitize((unsigned char *)dst, (const unsigned char *)src, dst_size, label_values_char_map, 1);
}
// ----------------------------------------------------------------------------
// rrdlabels_create()
typedef struct rrdlabel {
const char *value;
RRDLABEL_SRC label_source;
} RRDLABEL;
static void rrdlabel_insert_callback(const char *name, void *value, void *data) {
(void)name;
DICTIONARY *dict = (DICTIONARY *)data; (void)dict;
RRDLABEL *lb = (RRDLABEL *)value;
// allocate our own memory for the value
lb->value = strdupz(lb->value);
lb->label_source |= RRDLABEL_FLAG_NEW;
}
static void rrdlabel_delete_callback(const char *name, void *value, void *data) {
(void)name;
DICTIONARY *dict = (DICTIONARY *)data; (void)dict;
RRDLABEL *lb = (RRDLABEL *)value;
freez((void *)lb->value);
lb->value = NULL;
}
static void rrdlabel_conflict_callback(const char *name, void *oldvalue, void *newvalue, void *data) {
(void)name;
DICTIONARY *dict = (DICTIONARY *)data; (void)dict;
RRDLABEL *lbold = (RRDLABEL *)oldvalue;
RRDLABEL *lbnew = (RRDLABEL *)newvalue;
if(strcmp(lbold->value, lbnew->value) == 0) {
// they are the same
lbold->label_source |= lbnew->label_source;
lbold->label_source |= RRDLABEL_FLAG_OLD;
}
else {
// they are different
freez((void *)lbold->value);
lbold->value = strdupz(lbnew->value);
lbold->label_source = lbnew->label_source;
lbold->label_source |= RRDLABEL_FLAG_NEW;
}
}
DICTIONARY *rrdlabels_create(void) {
DICTIONARY *dict = dictionary_create(DICTIONARY_FLAG_DONT_OVERWRITE_VALUE);
dictionary_register_insert_callback(dict, rrdlabel_insert_callback, dict);
dictionary_register_delete_callback(dict, rrdlabel_delete_callback, dict);
dictionary_register_conflict_callback(dict, rrdlabel_conflict_callback, dict);
return dict;
}
// ----------------------------------------------------------------------------
// rrdlabels_destroy()
void rrdlabels_destroy(DICTIONARY *labels_dict) {
dictionary_destroy(labels_dict);
}
// ----------------------------------------------------------------------------
// rrdlabels_add()
static void labels_add_already_sanitized(DICTIONARY *dict, const char *key, const char *value, RRDLABEL_SRC ls) {
if(ls & RRDLABEL_FLAG_NEW) ls &= ~RRDLABEL_FLAG_NEW;
if(ls & RRDLABEL_FLAG_OLD) ls &= ~RRDLABEL_FLAG_OLD;
RRDLABEL tmp = {
.label_source = ls,
.value = value
};
dictionary_set(dict, key, &tmp, sizeof(RRDLABEL));
}
void rrdlabels_add(DICTIONARY *dict, const char *name, const char *value, RRDLABEL_SRC ls) {
if(!dict) {
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) {
error("%s: cannot add name '%s' (value '%s') which is sanitized as empty string", __FUNCTION__, name, value);
return;
}
labels_add_already_sanitized(dict, n, v, ls);
}
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(DICTIONARY *dict, const char *string, RRDLABEL_SRC ls) {
if(!dict) {
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(dict, name, value, ls);
}
// ----------------------------------------------------------------------------
// rrdlabels_get_to_buffer_or_null()
void rrdlabels_get_value_to_buffer_or_null(DICTIONARY *labels, BUFFER *wb, const char *key, const char *quote, const char *null) {
// Get a read lock on the dictionary
// to copy the value into the buffer
const char *v;
dfe_start_read(labels, v) {
RRDLABEL *lb = dictionary_get_having_read_lock(labels, key);
if(lb && lb->value)
buffer_sprintf(wb, "%s%s%s", quote, lb->value, quote);
else
buffer_strcat(wb, null);
}
dfe_done(v);
}
// ----------------------------------------------------------------------------
// rrdlabels_unmark_all()
// remove labels RRDLABEL_FLAG_OLD and RRDLABEL_FLAG_NEW from all dictionary items
static int remove_flags_old_new(const char *name, void *value, void *data) {
(void)name;
(void)data;
RRDLABEL *lb = (RRDLABEL *)value;
if(lb->label_source & RRDLABEL_FLAG_OLD) lb->label_source &= ~RRDLABEL_FLAG_OLD;
if(lb->label_source & RRDLABEL_FLAG_NEW) lb->label_source &= ~RRDLABEL_FLAG_NEW;
return 1;
}
void rrdlabels_unmark_all(DICTIONARY *labels) {
dictionary_walkthrough_read(labels, remove_flags_old_new, NULL);
}
// ----------------------------------------------------------------------------
// rrdlabels_remove_all_unmarked()
// remove dictionary items that are neither old, nor new
static int remove_not_old_not_new_callback(const char *name, void *value, void *data) {
DICTIONARY *dict = (DICTIONARY *)data;
RRDLABEL *lb = (RRDLABEL *)value;
if(!(lb->label_source & RRDLABEL_FLAG_OLD) && !(lb->label_source & RRDLABEL_FLAG_NEW)) {
dictionary_del_having_write_lock(dict, name);
return 1;
}
return 0;
}
void rrdlabels_remove_all_unmarked(DICTIONARY *labels) {
dictionary_walkthrough_write(labels, remove_not_old_not_new_callback, labels);
}
// ----------------------------------------------------------------------------
// rrdlabels_walkthrough_read()
struct labels_walkthrough {
int (*callback)(const char *name, const char *value, RRDLABEL_SRC ls, void *data);
void *data;
};
static int labels_walkthrough_callback(const char *name, void *value, void *data) {
struct labels_walkthrough *d = (struct labels_walkthrough *)data;
RRDLABEL *lb = (RRDLABEL *)value;
RRDLABEL_SRC ls = lb->label_source;
if(ls & RRDLABEL_FLAG_NEW) ls &= ~RRDLABEL_FLAG_NEW;
if(ls & RRDLABEL_FLAG_OLD) ls &= ~RRDLABEL_FLAG_OLD;
return d->callback(name, lb->value, ls, d->data);
}
int rrdlabels_walkthrough_read(DICTIONARY *labels, int (*callback)(const char *name, const char *value, RRDLABEL_SRC ls, void *data), void *data) {
struct labels_walkthrough d = {
.callback = callback,
.data = data
};
return dictionary_walkthrough_read(labels, labels_walkthrough_callback, &d);
}
int rrdlabels_sorted_walkthrough_read(DICTIONARY *labels, int (*callback)(const char *name, const char *value, RRDLABEL_SRC ls, void *data), void *data) {
struct labels_walkthrough d = {
.callback = callback,
.data = data
};
return dictionary_sorted_walkthrough_read(labels, labels_walkthrough_callback, &d);
}
// ----------------------------------------------------------------------------
// rrdlabels_migrate_to_these()
// migrate an existing label list to a new list, INPLACE
static int copy_label_to_dictionary_callback(const char *name, void *value, void *data) {
DICTIONARY *dst = (DICTIONARY *)data;
RRDLABEL *lb = (RRDLABEL *)value;
labels_add_already_sanitized(dst, name, lb->value, lb->label_source);
return 1;
}
void rrdlabels_migrate_to_these(DICTIONARY *dst, DICTIONARY *src) {
if(!dst || !src) return;
// remove the RRDLABEL_FLAG_OLD and RRDLABEL_FLAG_NEW from all items
rrdlabels_unmark_all(dst);
// Mark the existing ones as RRDLABEL_FLAG_OLD,
// or the newly added ones as RRDLABEL_FLAG_NEW
dictionary_walkthrough_read(src, copy_label_to_dictionary_callback, dst);
// remove the unmarked dst
rrdlabels_remove_all_unmarked(dst);
}
void rrdlabels_copy(DICTIONARY *dst, DICTIONARY *src) {
if(!dst || !src) return;
dictionary_walkthrough_read(src, copy_label_to_dictionary_callback, dst);
}
// ----------------------------------------------------------------------------
// rrdlabels_match_simple_pattern()
// returns true when there are keys in the dictionary matching a simple pattern
struct simple_pattern_match_name_value {
SIMPLE_PATTERN *pattern;
char equal;
};
static int simple_pattern_match_name_only_callback(const char *name, void *value, 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
if(simple_pattern_matches(t->pattern, name)) return -1;
return 0;
}
static int simple_pattern_match_name_and_value_callback(const char *name, void *value, void *data) {
struct simple_pattern_match_name_value *t = (struct simple_pattern_match_name_value *)data;
RRDLABEL *lb = (RRDLABEL *)value;
// we return -1 to stop the walkthrough on first match
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 = lb->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';
if(simple_pattern_matches(t->pattern, tmp)) return -1;
return 0;
}
bool rrdlabels_match_simple_pattern_parsed(DICTIONARY *labels, SIMPLE_PATTERN *pattern, char equal) {
if (!labels) return false;
struct simple_pattern_match_name_value t = {
.pattern = pattern,
.equal = equal
};
int ret = dictionary_walkthrough_read(labels, equal?simple_pattern_match_name_and_value_callback:simple_pattern_match_name_only_callback, &t);
return (ret == -1)?true:false;
}
bool rrdlabels_match_simple_pattern(DICTIONARY *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);
char equal = '\0';
const char *s;
for(s = simple_pattern_txt; *s ; s++) {
if (*s == '=' || *s == ':') {
equal = *s;
break;
}
}
bool ret = rrdlabels_match_simple_pattern_parsed(labels, pattern, equal);
simple_pattern_free(pattern);
return ret;
}
// ----------------------------------------------------------------------------
// Log all labels
static int rrdlabels_log_label_to_buffer_callback(const char *name, void *value, void *data) {
BUFFER *wb = (BUFFER *)data;
RRDLABEL *lb = (RRDLABEL *)value;
buffer_sprintf(wb, "Label: %s: \"%s\" (", name, lb->value);
size_t sources = 0;
if(lb->label_source & RRDLABEL_SRC_AUTO)
buffer_sprintf(wb, "%sauto", sources++?",":"");
if(lb->label_source & RRDLABEL_SRC_CONFIG)
buffer_sprintf(wb, "%snetdata.conf", sources++?",":"");
if(lb->label_source & RRDLABEL_SRC_K8S)
buffer_sprintf(wb, "%sk8s", sources++?",":"");
if(lb->label_source & RRDLABEL_SRC_ACLK)
buffer_sprintf(wb, "%saclk", sources++?",":"");
if(!sources)
buffer_strcat(wb, "unknown");
buffer_strcat(wb, ")\n");
return 1;
}
void rrdlabels_log_to_buffer(DICTIONARY *labels, BUFFER *wb) {
dictionary_sorted_walkthrough_read(labels, rrdlabels_log_label_to_buffer_callback, wb);
}
// ----------------------------------------------------------------------------
// 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 char *name, void *value, void *data) {
struct labels_to_buffer *t = (struct labels_to_buffer *)data;
RRDLABEL *lb = (RRDLABEL *)value;
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 *nn = name, *vv = lb->value;
if(t->name_sanitizer) {
t->name_sanitizer(n, name, n_size);
nn = n;
}
if(t->value_sanitizer) {
t->value_sanitizer(v, lb->value, v_size);
vv = v;
}
if(!t->filter_callback || (t->filter_callback && t->filter_callback(name, lb->value, lb->label_source, 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;
}
void rrdlabels_to_buffer(DICTIONARY *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
};
dictionary_sorted_walkthrough_read(labels, label_to_buffer_callback, (void *)&tmp);
}
static int chart_label_store_to_sql_callback(const char *name, const char *value, RRDLABEL_SRC ls, void *data) {
RRDSET *st = (RRDSET *)data;
sql_store_chart_label(st->chart_uuid, (int)ls, (char *)name, (char *)value);
return 1;
}
void rrdset_update_rrdlabels(RRDSET *st, DICTIONARY *new_rrdlabels) {
if(!st->state->chart_labels)
st->state->chart_labels = rrdlabels_create();
if (new_rrdlabels)
rrdlabels_migrate_to_these(st->state->chart_labels, new_rrdlabels);
// TODO - we should also cleanup sqlite from old new_rrdlabels that have been removed
rrdlabels_walkthrough_read(st->state->chart_labels, chart_label_store_to_sql_callback, st);
}
// ----------------------------------------------------------------------------
// 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;
RRDLABEL_SRC ls;
int errors;
};
int rrdlabels_unittest_add_a_pair_callback(const char *name, const char *value, RRDLABEL_SRC ls, void *data) {
struct rrdlabels_unittest_add_a_pair *t = (struct rrdlabels_unittest_add_a_pair *)data;
t->name = name;
t->value = value;
t->ls = ls;
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?value:"(null)", t->expected_value?t->expected_value:"(null)");
t->errors++;
}
return 1;
}
int rrdlabels_unittest_add_a_pair(const char *pair, const char *name, const char *value) {
DICTIONARY *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)