8 #include <sys/resource.h>
13 #include "appconfig.h"
16 #include "plugin_tc.h"
18 #include "../config.h"
20 #define RRD_TYPE_TC "tc"
21 #define RRD_TYPE_TC_LEN strlen(RRD_TYPE_TC)
23 // ----------------------------------------------------------------------------
25 // this requires the script plugins.d/tc-qos-helper.sh
27 #define TC_LINE_MAX 1024
45 unsigned long long bytes;
46 unsigned long long packets;
47 unsigned long long dropped;
48 unsigned long long overlimits;
49 unsigned long long requeues;
50 unsigned long long lended;
51 unsigned long long borrowed;
52 unsigned long long giants;
53 unsigned long long tokens;
54 unsigned long long ctokens;
56 char updated; // updated bytes
57 char seen; // seen in the tc list (even without bytes)
59 struct tc_class *next;
60 struct tc_class *prev;
72 avl_tree classes_index;
74 struct tc_class *classes;
76 struct tc_device *next;
77 struct tc_device *prev;
81 struct tc_device *tc_device_root = NULL;
83 // ----------------------------------------------------------------------------
86 static int tc_device_compare(void* a, void* b) {
87 if(((struct tc_device *)a)->hash < ((struct tc_device *)b)->hash) return -1;
88 else if(((struct tc_device *)a)->hash > ((struct tc_device *)b)->hash) return 1;
89 else return strcmp(((struct tc_device *)a)->id, ((struct tc_device *)b)->id);
92 avl_tree tc_device_root_index = {
97 #define tc_device_index_add(st) avl_insert(&tc_device_root_index, (avl *)(st))
98 #define tc_device_index_del(st) avl_remove(&tc_device_root_index, (avl *)(st))
100 static inline struct tc_device *tc_device_index_find(const char *id, uint32_t hash) {
101 struct tc_device tmp;
103 tmp.hash = (hash)?hash:simple_hash(tmp.id);
105 return (struct tc_device *)avl_search(&(tc_device_root_index), (avl *)&tmp);
109 // ----------------------------------------------------------------------------
112 static int tc_class_compare(void* a, void* b) {
113 if(((struct tc_class *)a)->hash < ((struct tc_class *)b)->hash) return -1;
114 else if(((struct tc_class *)a)->hash > ((struct tc_class *)b)->hash) return 1;
115 else return strcmp(((struct tc_class *)a)->id, ((struct tc_class *)b)->id);
118 #define tc_class_index_add(st, rd) avl_insert(&((st)->classes_index), (avl *)(rd))
119 #define tc_class_index_del(st, rd) avl_remove(&((st)->classes_index), (avl *)(rd))
121 static inline struct tc_class *tc_class_index_find(struct tc_device *st, const char *id, uint32_t hash) {
124 tmp.hash = (hash)?hash:simple_hash(tmp.id);
126 return (struct tc_class *)avl_search(&(st->classes_index), (avl *) &tmp);
129 // ----------------------------------------------------------------------------
131 static inline void tc_class_free(struct tc_device *n, struct tc_class *c) {
132 debug(D_TC_LOOP, "Removing from device '%s' class '%s', parentid '%s', leafid '%s', seen=%d", n->id, c->id, c->parentid?c->parentid:"", c->leafid?c->leafid:"", c->seen);
134 if(c->next) c->next->prev = c->prev;
135 if(c->prev) c->prev->next = c->next;
136 if(n->classes == c) {
137 if(c->next) n->classes = c->next;
138 else n->classes = c->prev;
141 tc_class_index_del(n, c);
143 if(c->id) free(c->id);
144 if(c->name) free(c->name);
145 if(c->leafid) free(c->leafid);
146 if(c->parentid) free(c->parentid);
151 static inline void tc_device_classes_cleanup(struct tc_device *d) {
152 static int cleanup_every = 999;
154 if(cleanup_every > 0) {
155 cleanup_every = (int) -config_get_number("plugin:tc", "cleanup unused classes every", 60);
156 if(cleanup_every > 0) cleanup_every = -cleanup_every;
157 if(cleanup_every == 0) cleanup_every = -1;
160 struct tc_class *c = d->classes;
162 if(c->seen < cleanup_every) {
163 struct tc_class *nc = c->next;
176 static inline void tc_device_commit(struct tc_device *d)
178 static int enable_new_interfaces = -1;
180 if(enable_new_interfaces == -1) enable_new_interfaces = config_get_boolean("plugin:tc", "enable new interfaces detected at runtime", 1);
182 // we only need to add leaf classes
183 struct tc_class *c, *x;
186 for(c = d->classes ; c ; c = c->next) {
191 // mark the classes as leafs and parents
192 for(c = d->classes ; c ; c = c->next) {
193 if(!c->updated) continue;
195 for(x = d->classes ; x ; x = x->next) {
196 if(!x->updated) continue;
201 ( c->hash == x->parent_hash && strcmp(c->id, x->parentid) == 0) ||
202 (c->leafid && c->leaf_hash == x->parent_hash && strcmp(c->leafid, x->parentid) == 0))) {
203 // debug(D_TC_LOOP, "TC: In device '%s', class '%s' (leafid: '%s') has as leaf class '%s' (parentid: '%s').", d->name?d->name:d->id, c->name?c->name:c->id, c->leafid?c->leafid:c->id, x->name?x->name:x->id, x->parentid?x->parentid:x->id);
212 for ( c = d->classes ; c ; c = c->next) {
213 if(c->isleaf && c->hasparent) debug(D_TC_LOOP, "TC: Device %s, class %s, OK", d->name, c->id);
214 else debug(D_TC_LOOP, "TC: Device %s, class %s, IGNORE (isleaf: %d, hasparent: %d, parent: %s)", d->name, c->id, c->isleaf, c->hasparent, c->parentid);
218 // we need at least a class
219 for(c = d->classes ; c ; c = c->next) {
220 // debug(D_TC_LOOP, "TC: Device '%s', class '%s', isLeaf=%d, HasParent=%d, Seen=%d", d->name?d->name:d->id, c->name?c->name:c->id, c->isleaf, c->hasparent, c->seen);
221 if(!c->updated) continue;
222 if(c->isleaf && c->hasparent) break;
225 debug(D_TC_LOOP, "TC: Ignoring TC device '%s'. No leaf classes.", d->name?d->name:d->id);
226 tc_device_classes_cleanup(d);
230 char var_name[CONFIG_MAX_NAME + 1];
231 snprintfz(var_name, CONFIG_MAX_NAME, "qos for %s", d->id);
232 if(config_get_boolean("plugin:tc", var_name, enable_new_interfaces)) {
233 RRDSET *st = rrdset_find_bytype(RRD_TYPE_TC, d->id);
235 debug(D_TC_LOOP, "TC: Creating new chart for device '%s'", d->name?d->name:d->id);
237 st = rrdset_create(RRD_TYPE_TC, d->id, d->name?d->name:d->id, d->family?d->family:d->id, RRD_TYPE_TC ".qos", "Class Usage", "kilobits/s", 7000, rrd_update_every, RRDSET_TYPE_STACKED);
239 for(c = d->classes ; c ; c = c->next) {
240 if(!c->updated) continue;
242 if(c->isleaf && c->hasparent)
243 rrddim_add(st, c->id, c->name?c->name:c->id, 8, 1024, RRDDIM_INCREMENTAL);
247 debug(D_TC_LOOP, "TC: Updating chart for device '%s'", d->name?d->name:d->id);
248 rrdset_next_plugins(st);
250 if(d->name && strcmp(d->id, d->name) != 0) rrdset_set_name(st, d->name);
253 for(c = d->classes ; c ; c = c->next) {
254 if(!c->updated) continue;
256 if(c->isleaf && c->hasparent) {
257 RRDDIM *rd = rrddim_find(st, c->id);
260 debug(D_TC_LOOP, "TC: Adding to chart '%s', dimension '%s' (name: '%s')", st->id, c->id, c->name);
262 // new class, we have to add it
263 rd = rrddim_add(st, c->id, c->name?c->name:c->id, 8, 1024, RRDDIM_INCREMENTAL);
265 else debug(D_TC_LOOP, "TC: Updating chart '%s', dimension '%s'", st->id, c->id);
267 rrddim_set_by_pointer(st, rd, c->bytes);
269 // if it has a name, different to the id
271 // update the rrd dimension with the new name
272 debug(D_TC_LOOP, "TC: Setting chart '%s', dimension '%s' name to '%s'", st->id, rd->id, c->name);
273 rrddim_set_name(st, rd, c->name);
283 tc_device_classes_cleanup(d);
286 static inline void tc_device_set_class_name(struct tc_device *d, char *id, char *name)
288 struct tc_class *c = tc_class_index_find(d, id, 0);
290 if(c->name) free(c->name);
293 if(name && *name && strcmp(c->id, name) != 0) {
294 debug(D_TC_LOOP, "TC: Setting device '%s', class '%s' name to '%s'", d->id, id, name);
295 c->name = strdup(name);
300 static inline void tc_device_set_device_name(struct tc_device *d, char *name) {
301 if(d->name) free(d->name);
304 if(name && *name && strcmp(d->id, name) != 0) {
305 debug(D_TC_LOOP, "TC: Setting device '%s' name to '%s'", d->id, name);
306 d->name = strdup(name);
310 static inline void tc_device_set_device_family(struct tc_device *d, char *family) {
311 if(d->family) free(d->family);
314 if(family && *family && strcmp(d->id, family) != 0) {
315 debug(D_TC_LOOP, "TC: Setting device '%s' family to '%s'", d->id, family);
316 d->family = strdup(family);
318 // no need for null termination - it is already null
321 static inline struct tc_device *tc_device_create(char *id)
323 struct tc_device *d = tc_device_index_find(id, 0);
326 debug(D_TC_LOOP, "TC: Creating device '%s'", id);
328 d = calloc(1, sizeof(struct tc_device));
330 fatal("Cannot allocate memory for tc_device %s", id);
335 d->hash = simple_hash(d->id);
337 avl_init(&d->classes_index, tc_class_compare);
338 tc_device_index_add(d);
340 if(!tc_device_root) {
344 d->next = tc_device_root;
345 tc_device_root->prev = d;
353 static inline struct tc_class *tc_class_add(struct tc_device *n, char *id, char *parentid, char *leafid)
355 struct tc_class *c = tc_class_index_find(n, id, 0);
358 debug(D_TC_LOOP, "TC: Creating in device '%s', class id '%s', parentid '%s', leafid '%s'", n->id, id, parentid?parentid:"", leafid?leafid:"");
360 c = calloc(1, sizeof(struct tc_class));
362 fatal("Cannot allocate memory for tc class");
366 if(n->classes) n->classes->prev = c;
367 c->next = n->classes;
375 c->hash = simple_hash(c->id);
377 if(parentid && *parentid) {
378 c->parentid = strdup(parentid);
379 c->parent_hash = simple_hash(c->parentid);
382 if(leafid && *leafid) {
383 c->leafid = strdup(leafid);
384 c->leaf_hash = simple_hash(c->leafid);
387 tc_class_index_add(n, c);
395 static inline void tc_device_free(struct tc_device *n)
397 if(n->next) n->next->prev = n->prev;
398 if(n->prev) n->prev->next = n->next;
399 if(tc_device_root == n) {
400 if(n->next) tc_device_root = n->next;
401 else tc_device_root = n->prev;
404 tc_device_index_del(n);
406 while(n->classes) tc_class_free(n, n->classes);
408 if(n->id) free(n->id);
409 if(n->name) free(n->name);
410 if(n->family) free(n->family);
415 static inline void tc_device_free_all()
417 while(tc_device_root)
418 tc_device_free(tc_device_root);
423 static inline int tc_space(char c) {
436 static inline void tc_split_words(char *str, char **words, int max_words) {
440 // skip all white space
441 while(tc_space(*s)) s++;
443 // store the first word
446 // while we have something
451 // terminate the word
454 // skip all white space
455 while(tc_space(*s)) s++;
457 // if we reached the end, stop
460 // store the next word
461 if(i < max_words) words[i++] = s;
467 // terminate the words
468 while(i < max_words) words[i++] = NULL;
471 pid_t tc_child_pid = 0;
472 void *tc_main(void *ptr)
476 info("TC thread created with task id %d", gettid());
478 if(pthread_setcanceltype(PTHREAD_CANCEL_DEFERRED, NULL) != 0)
479 error("Cannot set pthread cancel type to DEFERRED.");
481 if(pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, NULL) != 0)
482 error("Cannot set pthread cancel state to ENABLE.");
484 struct rusage thread;
485 RRDSET *stcpu = NULL, *sttime = NULL;
487 char buffer[TC_LINE_MAX+1] = "";
488 char *words[MAX_WORDS] = { NULL };
490 uint32_t BEGIN_HASH = simple_hash("BEGIN");
491 uint32_t END_HASH = simple_hash("END");
492 uint32_t CLASS_HASH = simple_hash("class");
493 uint32_t SENT_HASH = simple_hash("Sent");
494 uint32_t LENDED_HASH = simple_hash("lended:");
495 uint32_t TOKENS_HASH = simple_hash("tokens:");
496 uint32_t SETDEVICENAME_HASH = simple_hash("SETDEVICENAME");
497 uint32_t SETDEVICEGROUP_HASH = simple_hash("SETDEVICEGROUP");
498 uint32_t SETCLASSNAME_HASH = simple_hash("SETCLASSNAME");
499 uint32_t WORKTIME_HASH = simple_hash("WORKTIME");
500 #ifdef DETACH_PLUGINS_FROM_NETDATA
501 uint32_t MYPID_HASH = simple_hash("MYPID");
506 if(unlikely(netdata_exit)) break;
509 struct tc_device *device = NULL;
510 struct tc_class *class = NULL;
512 snprintfz(buffer, TC_LINE_MAX, "exec %s %d", config_get("plugin:tc", "script to run to get tc values", PLUGINS_DIR "/tc-qos-helper.sh"), rrd_update_every);
513 debug(D_TC_LOOP, "executing '%s'", buffer);
514 // fp = popen(buffer, "r");
515 fp = mypopen(buffer, &tc_child_pid);
517 error("TC: Cannot popen(\"%s\", \"r\").", buffer);
522 while(fgets(buffer, TC_LINE_MAX, fp) != NULL) {
523 if(unlikely(netdata_exit)) break;
525 buffer[TC_LINE_MAX] = '\0';
526 // debug(D_TC_LOOP, "TC: read '%s'", buffer);
528 tc_split_words(buffer, words, MAX_WORDS);
529 if(!words[0] || !*words[0]) {
530 // debug(D_TC_LOOP, "empty line");
533 // else debug(D_TC_LOOP, "First word is '%s'", words[0]);
535 first_hash = simple_hash(words[0]);
537 if(device && first_hash == CLASS_HASH && strcmp(words[0], "class") == 0) {
538 // debug(D_TC_LOOP, "CLASS line on class id='%s', parent='%s', parentid='%s', leaf='%s', leafid='%s'", words[2], words[3], words[4], words[5], words[6]);
540 // clear the last class
543 // words[1] : class type
545 // words[3] : parent or root
546 if(words[1] && words[2] && words[3] && (strcmp(words[3], "parent") == 0 || strcmp(words[3], "root") == 0)) {
547 //char *type = words[1]; // the class: htb, fq_codel, etc
549 // we are only interested for HTB classes
550 //if(strcmp(type, "htb") != 0) continue;
552 char *id = words[2]; // the class major:minor
553 char *parent = words[3]; // 'parent' or 'root'
554 char *parentid = words[4]; // the parent's id
555 char *leaf = words[5]; // 'leaf'
556 char *leafid = words[6]; // leafid
558 if(strcmp(parent, "root") == 0) {
562 else if(!leaf || strcmp(leaf, "leaf") != 0)
565 char leafbuf[20 + 1] = "";
566 if(leafid && leafid[strlen(leafid) - 1] == ':') {
567 strncpyz(leafbuf, leafid, 20 - 1);
568 strcat(leafbuf, "1");
572 class = tc_class_add(device, id, parentid, leafid);
575 else if(first_hash == END_HASH && strcmp(words[0], "END") == 0) {
576 // debug(D_TC_LOOP, "END line");
579 if(pthread_setcancelstate(PTHREAD_CANCEL_DISABLE, NULL) != 0)
580 error("Cannot set pthread cancel state to DISABLE.");
582 tc_device_commit(device);
583 // tc_device_free(device);
587 if(pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, NULL) != 0)
588 error("Cannot set pthread cancel state to ENABLE.");
591 else if(first_hash == BEGIN_HASH && strcmp(words[0], "BEGIN") == 0) {
592 // debug(D_TC_LOOP, "BEGIN line on device '%s'", words[1]);
595 // tc_device_free(device);
600 if(words[1] && *words[1]) {
601 device = tc_device_create(words[1]);
605 else if(device && class && first_hash == SENT_HASH && strcmp(words[0], "Sent") == 0) {
606 // debug(D_TC_LOOP, "SENT line '%s'", words[1]);
607 if(words[1] && *words[1]) {
608 class->bytes = strtoull(words[1], NULL, 10);
612 if(words[3] && *words[3])
613 class->packets = strtoull(words[3], NULL, 10);
615 if(words[6] && *words[6])
616 class->dropped = strtoull(words[6], NULL, 10);
618 if(words[8] && *words[8])
619 class->overlimits = strtoull(words[8], NULL, 10);
621 if(words[10] && *words[10])
622 class->requeues = strtoull(words[8], NULL, 10);
624 else if(device && class && class->updated && first_hash == LENDED_HASH && strcmp(words[0], "lended:") == 0) {
625 // debug(D_TC_LOOP, "LENDED line '%s'", words[1]);
626 if(words[1] && *words[1])
627 class->lended = strtoull(words[1], NULL, 10);
629 if(words[3] && *words[3])
630 class->borrowed = strtoull(words[3], NULL, 10);
632 if(words[5] && *words[5])
633 class->giants = strtoull(words[5], NULL, 10);
635 else if(device && class && class->updated && first_hash == TOKENS_HASH && strcmp(words[0], "tokens:") == 0) {
636 // debug(D_TC_LOOP, "TOKENS line '%s'", words[1]);
637 if(words[1] && *words[1])
638 class->tokens = strtoull(words[1], NULL, 10);
640 if(words[3] && *words[3])
641 class->ctokens = strtoull(words[3], NULL, 10);
643 else if(device && first_hash == SETDEVICENAME_HASH && strcmp(words[0], "SETDEVICENAME") == 0) {
644 // debug(D_TC_LOOP, "SETDEVICENAME line '%s'", words[1]);
645 if(words[1] && *words[1]) tc_device_set_device_name(device, words[1]);
647 else if(device && first_hash == SETDEVICEGROUP_HASH && strcmp(words[0], "SETDEVICEGROUP") == 0) {
648 // debug(D_TC_LOOP, "SETDEVICEGROUP line '%s'", words[1]);
649 if(words[1] && *words[1]) tc_device_set_device_family(device, words[1]);
651 else if(device && first_hash == SETCLASSNAME_HASH && strcmp(words[0], "SETCLASSNAME") == 0) {
652 // debug(D_TC_LOOP, "SETCLASSNAME line '%s' '%s'", words[1], words[2]);
654 char *path = words[2];
655 if(id && *id && path && *path) tc_device_set_class_name(device, id, path);
657 else if(first_hash == WORKTIME_HASH && strcmp(words[0], "WORKTIME") == 0) {
658 // debug(D_TC_LOOP, "WORKTIME line '%s' '%s'", words[1], words[2]);
659 getrusage(RUSAGE_THREAD, &thread);
661 if(!stcpu) stcpu = rrdset_find("netdata.plugin_tc_cpu");
663 stcpu = rrdset_create("netdata", "plugin_tc_cpu", NULL, "tc.helper", NULL, "NetData TC CPU usage", "milliseconds/s", 135000, rrd_update_every, RRDSET_TYPE_STACKED);
664 rrddim_add(stcpu, "user", NULL, 1, 1000, RRDDIM_INCREMENTAL);
665 rrddim_add(stcpu, "system", NULL, 1, 1000, RRDDIM_INCREMENTAL);
667 else rrdset_next(stcpu);
669 rrddim_set(stcpu, "user" , thread.ru_utime.tv_sec * 1000000ULL + thread.ru_utime.tv_usec);
670 rrddim_set(stcpu, "system", thread.ru_stime.tv_sec * 1000000ULL + thread.ru_stime.tv_usec);
673 if(!sttime) stcpu = rrdset_find("netdata.plugin_tc_time");
675 sttime = rrdset_create("netdata", "plugin_tc_time", NULL, "tc.helper", NULL, "NetData TC script execution", "milliseconds/run", 135001, rrd_update_every, RRDSET_TYPE_AREA);
676 rrddim_add(sttime, "run_time", "run time", 1, 1, RRDDIM_ABSOLUTE);
678 else rrdset_next(sttime);
680 rrddim_set(sttime, "run_time", atoll(words[1]));
684 #ifdef DETACH_PLUGINS_FROM_NETDATA
685 else if(first_hash == MYPID_HASH && (strcmp(words[0], "MYPID") == 0)) {
686 // debug(D_TC_LOOP, "MYPID line '%s'", words[1]);
688 pid_t pid = atol(id);
690 if(pid) tc_child_pid = pid;
692 debug(D_TC_LOOP, "TC: Child PID is %d.", tc_child_pid);
696 // debug(D_TC_LOOP, "IGNORED line");
699 // fgets() failed or loop broke
700 int code = mypclose(fp, tc_child_pid);
704 // tc_device_free(device);
710 tc_device_free_all();
715 if(code == 1 || code == 127) {
717 // 127 = cannot even run it
718 error("TC: tc-qos-helper.sh exited with code %d. Disabling it.", code);
720 tc_device_free_all();
725 sleep((unsigned int) rrd_update_every);