Imported Upstream version 1.0.0upstream/1.0.0

1 files changed, 532 insertions, 0 deletions

diff --git a/src/plugins_d.c b/src/plugins_d.c
new file mode 100755
index 000000000..eb8f141b8
--- /dev/null
+++ b/src/plugins_d.c
@@ -0,0 +1,532 @@
+#ifdef HAVE_CONFIG_H
+#include <config.h>
+#endif
+#include <sys/types.h>
+#include <dirent.h>
+#include <pthread.h>
+#include <string.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <signal.h>
+
+#include "main.h"
+#include "common.h"
+#include "appconfig.h"
+#include "log.h"
+#include "rrd.h"
+#include "popen.h"
+#include "plugins_d.h"
+
+struct plugind *pluginsd_root = NULL;
+
+#define MAX_WORDS 20
+
+static inline int pluginsd_space(char c) {
+	switch(c) {
+	case ' ':
+	case '\t':
+	case '\r':
+	case '\n':
+	case '=':
+		return 1;
+
+	default:
+		return 0;
+	}
+}
+
+static int pluginsd_split_words(char *str, char **words, int max_words) {
+	char *s = str, quote = 0;
+	int i = 0, j;
+
+	// skip all white space
+	while(unlikely(pluginsd_space(*s))) s++;
+
+	// check for quote
+	if(unlikely(*s == '\'' || *s == '"')) {
+		quote = *s;	// remember the quote
+		s++;		// skip the quote
+	}
+
+	// store the first word
+	words[i++] = s;
+
+	// while we have something
+	while(likely(*s)) {
+		// if it is escape
+		if(unlikely(*s == '\\' && s[1])) {
+			s += 2;
+			continue;
+		}
+
+		// if it is quote
+		else if(unlikely(*s == quote)) {
+			quote = 0;
+			*s = ' ';
+			continue;
+		}
+
+		// if it is a space
+		else if(unlikely(quote == 0 && pluginsd_space(*s))) {
+
+			// terminate the word
+			*s++ = '\0';
+
+			// skip all white space
+			while(likely(pluginsd_space(*s))) s++;
+
+			// check for quote
+			if(unlikely(*s == '\'' || *s == '"')) {
+				quote = *s;	// remember the quote
+				s++;		// skip the quote
+			}
+
+			// if we reached the end, stop
+			if(unlikely(!*s)) break;
+
+			// store the next word
+			if(likely(i < max_words)) words[i++] = s;
+			else break;
+		}
+
+		// anything else
+		else s++;
+	}
+
+	// terminate the words
+	j = i;
+	while(likely(j < max_words)) words[j++] = NULL;
+
+	return i;
+}
+
+
+void *pluginsd_worker_thread(void *arg)
+{
+	struct plugind *cd = (struct plugind *)arg;
+	char line[PLUGINSD_LINE_MAX + 1];
+
+#ifdef DETACH_PLUGINS_FROM_NETDATA
+	unsigned long long usec = 0, susec = 0;
+	struct timeval last = {0, 0} , now = {0, 0};
+#endif
+
+	char *words[MAX_WORDS] = { NULL };
+	uint32_t SET_HASH = simple_hash("SET");
+	uint32_t BEGIN_HASH = simple_hash("BEGIN");
+	uint32_t END_HASH = simple_hash("END");
+	uint32_t FLUSH_HASH = simple_hash("FLUSH");
+	uint32_t CHART_HASH = simple_hash("CHART");
+	uint32_t DIMENSION_HASH = simple_hash("DIMENSION");
+	uint32_t DISABLE_HASH = simple_hash("DISABLE");
+#ifdef DETACH_PLUGINS_FROM_NETDATA
+	uint32_t MYPID_HASH = simple_hash("MYPID");
+	uint32_t STOPPING_WAKE_ME_UP_PLEASE_HASH = simple_hash("STOPPING_WAKE_ME_UP_PLEASE");
+#endif
+
+	while(likely(1)) {
+		if(unlikely(netdata_exit)) break;
+
+		FILE *fp = mypopen(cd->cmd, &cd->pid);
+		if(unlikely(!fp)) {
+			error("Cannot popen(\"%s\", \"r\").", cd->cmd);
+			break;
+		}
+
+		info("PLUGINSD: '%s' running on pid %d", cd->fullfilename, cd->pid);
+
+		RRDSET *st = NULL;
+		unsigned long long count = 0;
+		char *s;
+		uint32_t hash;
+
+		while(likely(fgets(line, PLUGINSD_LINE_MAX, fp) != NULL)) {
+			if(unlikely(netdata_exit)) break;
+
+			line[PLUGINSD_LINE_MAX] = '\0';
+
+			// debug(D_PLUGINSD, "PLUGINSD: %s: %s", cd->filename, line);
+
+			int w = pluginsd_split_words(line, words, MAX_WORDS);
+			s = words[0];
+			if(unlikely(!s || !*s || !w)) {
+				// debug(D_PLUGINSD, "PLUGINSD: empty line");
+				continue;
+			}
+
+			// debug(D_PLUGINSD, "PLUGINSD: words 0='%s' 1='%s' 2='%s' 3='%s' 4='%s' 5='%s' 6='%s' 7='%s' 8='%s' 9='%s'", words[0], words[1], words[2], words[3], words[4], words[5], words[6], words[7], words[8], words[9]);
+
+			hash = simple_hash(s);
+
+			if(likely(hash == SET_HASH && !strcmp(s, "SET"))) {
+				char *dimension = words[1];
+				char *value = words[2];
+
+				if(unlikely(!dimension || !*dimension)) {
+					error("PLUGINSD: '%s' is requesting a SET on chart '%s', without a dimension. Disabling it.", cd->fullfilename, st->id);
+					cd->enabled = 0;
+					killpid(cd->pid, SIGTERM);
+					break;
+				}
+
+				if(unlikely(!value || !*value)) value = NULL;
+
+				if(unlikely(!st)) {
+					error("PLUGINSD: '%s' is requesting a SET on dimension %s with value %s, without a BEGIN. Disabling it.", cd->fullfilename, dimension, value?value:"<nothing>");
+					cd->enabled = 0;
+					killpid(cd->pid, SIGTERM);
+					break;
+				}
+
+				if(unlikely(st->debug)) debug(D_PLUGINSD, "PLUGINSD: '%s' is setting dimension %s/%s to %s", cd->fullfilename, st->id, dimension, value?value:"<nothing>");
+
+				if(value) rrddim_set(st, dimension, atoll(value));
+
+				count++;
+			}
+			else if(likely(hash == BEGIN_HASH && !strcmp(s, "BEGIN"))) {
+				char *id = words[1];
+				char *microseconds_txt = words[2];
+
+				if(unlikely(!id)) {
+					error("PLUGINSD: '%s' is requesting a BEGIN without a chart id. Disabling it.", cd->fullfilename);
+					cd->enabled = 0;
+					killpid(cd->pid, SIGTERM);
+					break;
+				}
+
+				st = rrdset_find(id);
+				if(unlikely(!st)) {
+					error("PLUGINSD: '%s' is requesting a BEGIN on chart '%s', which does not exist. Disabling it.", cd->fullfilename, id);
+					cd->enabled = 0;
+					killpid(cd->pid, SIGTERM);
+					break;
+				}
+
+				if(likely(st->counter_done)) {
+					unsigned long long microseconds = 0;
+					if(microseconds_txt && *microseconds_txt) microseconds = strtoull(microseconds_txt, NULL, 10);
+					if(microseconds) rrdset_next_usec(st, microseconds);
+					else rrdset_next_plugins(st);
+				}
+			}
+			else if(likely(hash == END_HASH && !strcmp(s, "END"))) {
+				if(unlikely(!st)) {
+					error("PLUGINSD: '%s' is requesting an END, without a BEGIN. Disabling it.", cd->fullfilename);
+					cd->enabled = 0;
+					killpid(cd->pid, SIGTERM);
+					break;
+				}
+
+				if(unlikely(st->debug)) debug(D_PLUGINSD, "PLUGINSD: '%s' is requesting a END on chart %s", cd->fullfilename, st->id);
+
+				rrdset_done(st);
+				st = NULL;
+			}
+			else if(likely(hash == FLUSH_HASH && !strcmp(s, "FLUSH"))) {
+				debug(D_PLUGINSD, "PLUGINSD: '%s' is requesting a FLUSH", cd->fullfilename);
+				st = NULL;
+			}
+			else if(likely(hash == CHART_HASH && !strcmp(s, "CHART"))) {
+				int noname = 0;
+				st = NULL;
+
+				if((words[1]) != NULL && (words[2]) != NULL && strcmp(words[1], words[2]) == 0)
+					noname = 1;
+
+				char *type = words[1];
+				char *id = NULL;
+				if(likely(type)) {
+					id = strchr(type, '.');
+					if(likely(id)) { *id = '\0'; id++; }
+				}
+				char *name = words[2];
+				char *title = words[3];
+				char *units = words[4];
+				char *family = words[5];
+				char *context = words[6];
+				char *chart = words[7];
+				char *priority_s = words[8];
+				char *update_every_s = words[9];
+
+				if(unlikely(!type || !*type || !id || !*id)) {
+					error("PLUGINSD: '%s' is requesting a CHART, without a type.id. Disabling it.", cd->fullfilename);
+					cd->enabled = 0;
+					killpid(cd->pid, SIGTERM);
+					break;
+				}
+
+				int priority = 1000;
+				if(likely(priority_s)) priority = atoi(priority_s);
+
+				int update_every = cd->update_every;
+				if(likely(update_every_s)) update_every = atoi(update_every_s);
+				if(unlikely(!update_every)) update_every = cd->update_every;
+
+				int chart_type = RRDSET_TYPE_LINE;
+				if(unlikely(chart)) chart_type = rrdset_type_id(chart);
+
+				if(unlikely(noname || !name || !*name || strcasecmp(name, "NULL") == 0 || strcasecmp(name, "(NULL)") == 0)) name = NULL;
+				if(unlikely(!family || !*family)) family = NULL;
+				if(unlikely(!context || !*context)) context = NULL;
+
+				st = rrdset_find_bytype(type, id);
+				if(unlikely(!st)) {
+					debug(D_PLUGINSD, "PLUGINSD: Creating chart type='%s', id='%s', name='%s', family='%s', context='%s', chart='%s', priority=%d, update_every=%d"
+						, type, id
+						, name?name:""
+						, family?family:""
+						, context?context:""
+						, rrdset_type_name(chart_type)
+						, priority
+						, update_every
+						);
+
+					st = rrdset_create(type, id, name, family, context, title, units, priority, update_every, chart_type);
+					cd->update_every = update_every;
+				}
+				else debug(D_PLUGINSD, "PLUGINSD: Chart '%s' already exists. Not adding it again.", st->id);
+			}
+			else if(likely(hash == DIMENSION_HASH && !strcmp(s, "DIMENSION"))) {
+				char *id = words[1];
+				char *name = words[2];
+				char *algorithm = words[3];
+				char *multiplier_s = words[4];
+				char *divisor_s = words[5];
+				char *options = words[6];
+
+				if(unlikely(!id || !*id)) {
+					error("PLUGINSD: '%s' is requesting a DIMENSION, without an id. Disabling it.", cd->fullfilename);
+					cd->enabled = 0;
+					killpid(cd->pid, SIGTERM);
+					break;
+				}
+
+				if(unlikely(!st)) {
+					error("PLUGINSD: '%s' is requesting a DIMENSION, without a CHART. Disabling it.", cd->fullfilename);
+					cd->enabled = 0;
+					killpid(cd->pid, SIGTERM);
+					break;
+				}
+
+				long multiplier = 1;
+				if(multiplier_s && *multiplier_s) multiplier = atol(multiplier_s);
+				if(unlikely(!multiplier)) multiplier = 1;
+
+				long divisor = 1;
+				if(likely(divisor_s && *divisor_s)) divisor = atol(divisor_s);
+				if(unlikely(!divisor)) divisor = 1;
+
+				if(unlikely(!algorithm || !*algorithm)) algorithm = "absolute";
+
+				if(unlikely(st->debug)) debug(D_PLUGINSD, "PLUGINSD: Creating dimension in chart %s, id='%s', name='%s', algorithm='%s', multiplier=%ld, divisor=%ld, hidden='%s'"
+					, st->id
+					, id
+					, name?name:""
+					, rrddim_algorithm_name(rrddim_algorithm_id(algorithm))
+					, multiplier
+					, divisor
+					, options?options:""
+					);
+
+				RRDDIM *rd = rrddim_find(st, id);
+				if(unlikely(!rd)) {
+					rd = rrddim_add(st, id, name, multiplier, divisor, rrddim_algorithm_id(algorithm));
+					rd->flags = 0x00000000;
+					if(options && *options) {
+						if(strstr(options, "hidden") != NULL) rd->flags |= RRDDIM_FLAG_HIDDEN;
+						if(strstr(options, "noreset") != NULL) rd->flags |= RRDDIM_FLAG_DONT_DETECT_RESETS_OR_OVERFLOWS;
+						if(strstr(options, "nooverflow") != NULL) rd->flags |= RRDDIM_FLAG_DONT_DETECT_RESETS_OR_OVERFLOWS;
+					}
+				}
+				else if(unlikely(st->debug)) debug(D_PLUGINSD, "PLUGINSD: dimension %s/%s already exists. Not adding it again.", st->id, id);
+			}
+			else if(unlikely(hash == DISABLE_HASH && !strcmp(s, "DISABLE"))) {
+				error("PLUGINSD: '%s' called DISABLE. Disabling it.", cd->fullfilename);
+				cd->enabled = 0;
+				killpid(cd->pid, SIGTERM);
+				break;
+			}
+#ifdef DETACH_PLUGINS_FROM_NETDATA
+			else if(likely(hash == MYPID_HASH && !strcmp(s, "MYPID"))) {
+				char *pid_s = words[1];
+				pid_t pid = atol(pid_s);
+
+				if(likely(pid)) cd->pid = pid;
+				debug(D_PLUGINSD, "PLUGINSD: %s is on pid %d", cd->id, cd->pid);
+			}
+			else if(likely(hash == STOPPING_WAKE_ME_UP_PLEASE_HASH && !strcmp(s, "STOPPING_WAKE_ME_UP_PLEASE"))) {
+				error("PLUGINSD: '%s' (pid %d) called STOPPING_WAKE_ME_UP_PLEASE.", cd->fullfilename, cd->pid);
+
+				gettimeofday(&now, NULL);
+				if(unlikely(!usec && !susec)) {
+					// our first run
+					susec = cd->rrd_update_every * 1000000ULL;
+				}
+				else {
+					// second+ run
+					usec = usecdiff(&now, &last) - susec;
+					error("PLUGINSD: %s last loop took %llu usec (worked for %llu, sleeped for %llu).\n", cd->fullfilename, usec + susec, usec, susec);
+					if(unlikely(usec < (rrd_update_every * 1000000ULL / 2ULL))) susec = (rrd_update_every * 1000000ULL) - usec;
+					else susec = rrd_update_every * 1000000ULL / 2ULL;
+				}
+
+				error("PLUGINSD: %s sleeping for %llu. Will kill with SIGCONT pid %d to wake it up.\n", cd->fullfilename, susec, cd->pid);
+				usleep(susec);
+				killpid(cd->pid, SIGCONT);
+				bcopy(&now, &last, sizeof(struct timeval));
+				break;
+			}
+#endif
+			else {
+				error("PLUGINSD: '%s' is sending command '%s' which is not known by netdata. Disabling it.", cd->fullfilename, s);
+				cd->enabled = 0;
+				killpid(cd->pid, SIGTERM);
+				break;
+			}
+		}
+
+		info("PLUGINSD: '%s' on pid %d stopped.", cd->fullfilename, cd->pid);
+
+		// fgets() failed or loop broke
+		int code = mypclose(fp, cd->pid);
+		if(code == 1 || code == 127) {
+			// 1 = DISABLE
+			// 127 = cannot even run it
+			error("PLUGINSD: '%s' (pid %d) exited with code %d. Disabling it.", cd->fullfilename, cd->pid, code);
+			cd->enabled = 0;
+		}
+
+		if(netdata_exit) {
+			cd->pid = 0;
+			cd->enabled = 0;
+			cd->obsolete = 1;
+			pthread_exit(NULL);
+			return NULL;
+		}
+
+		if(unlikely(!count && cd->enabled)) {
+			error("PLUGINSD: '%s' (pid %d) does not generate usefull output. Waiting a bit before starting it again.", cd->fullfilename, cd->pid);
+			sleep((unsigned int) (cd->update_every * 10));
+		}
+
+		cd->pid = 0;
+		if(likely(cd->enabled)) sleep((unsigned int) cd->update_every);
+		else break;
+	}
+
+	cd->obsolete = 1;
+	pthread_exit(NULL);
+	return NULL;
+}
+
+void *pluginsd_main(void *ptr)
+{
+	if(ptr) { ; }
+
+	info("PLUGINS.D thread created with task id %d", gettid());
+
+	if(pthread_setcanceltype(PTHREAD_CANCEL_DEFERRED, NULL) != 0)
+		error("Cannot set pthread cancel type to DEFERRED.");
+
+	if(pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, NULL) != 0)
+		error("Cannot set pthread cancel state to ENABLE.");
+
+	char *dir_name = config_get("plugins", "plugins directory", PLUGINS_DIR);
+	int automatic_run = config_get_boolean("plugins", "enable running new plugins", 1);
+	int scan_frequency = (int) config_get_number("plugins", "check for new plugins every", 60);
+	DIR *dir = NULL;
+	struct dirent *file = NULL;
+	struct plugind *cd;
+
+	// enable the apps plugin by default
+	// config_get_boolean("plugins", "apps", 1);
+
+	if(scan_frequency < 1) scan_frequency = 1;
+
+	while(likely(1)) {
+		if(unlikely(netdata_exit)) break;
+
+		dir = opendir(dir_name);
+		if(unlikely(!dir)) {
+			error("Cannot open directory '%s'.", dir_name);
+			pthread_exit(NULL);
+			return NULL;
+		}
+
+		while(likely((file = readdir(dir)))) {
+			if(unlikely(netdata_exit)) break;
+
+			debug(D_PLUGINSD, "PLUGINSD: Examining file '%s'", file->d_name);
+
+			if(unlikely(strcmp(file->d_name, ".") == 0 || strcmp(file->d_name, "..") == 0)) continue;
+
+			int len = (int) strlen(file->d_name);
+			if(unlikely(len <= (int)PLUGINSD_FILE_SUFFIX_LEN)) continue;
+			if(unlikely(strcmp(PLUGINSD_FILE_SUFFIX, &file->d_name[len - (int)PLUGINSD_FILE_SUFFIX_LEN]) != 0)) {
+				debug(D_PLUGINSD, "PLUGINSD: File '%s' does not end in '%s'.", file->d_name, PLUGINSD_FILE_SUFFIX);
+				continue;
+			}
+
+			char pluginname[CONFIG_MAX_NAME + 1];
+			snprintf(pluginname, CONFIG_MAX_NAME, "%.*s", (int)(len - PLUGINSD_FILE_SUFFIX_LEN), file->d_name);
+			int enabled = config_get_boolean("plugins", pluginname, automatic_run);
+
+			if(unlikely(!enabled)) {
+				debug(D_PLUGINSD, "PLUGINSD: plugin '%s' is not enabled", file->d_name);
+				continue;
+			}
+
+			// check if it runs already
+			for(cd = pluginsd_root ; likely(cd) ; cd = cd->next) {
+				if(unlikely(strcmp(cd->filename, file->d_name) == 0)) break;
+			}
+			if(likely(cd && !cd->obsolete)) {
+				debug(D_PLUGINSD, "PLUGINSD: plugin '%s' is already running", cd->filename);
+				continue;
+			}
+
+			// it is not running
+			// allocate a new one, or use the obsolete one
+			if(unlikely(!cd)) {
+				cd = calloc(sizeof(struct plugind), 1);
+				if(unlikely(!cd)) fatal("Cannot allocate memory for plugin.");
+
+				snprintf(cd->id, CONFIG_MAX_NAME, "plugin:%s", pluginname);
+
+				strncpy(cd->filename, file->d_name, FILENAME_MAX);
+				snprintf(cd->fullfilename, FILENAME_MAX, "%s/%s", dir_name, cd->filename);
+
+				cd->enabled = enabled;
+				cd->update_every = (int) config_get_number(cd->id, "update every", rrd_update_every);
+				cd->started_t = time(NULL);
+
+				char *def = "";
+				snprintf(cd->cmd, PLUGINSD_CMD_MAX, "exec %s %d %s", cd->fullfilename, cd->update_every, config_get(cd->id, "command options", def));
+
+				// link it
+				if(likely(pluginsd_root)) cd->next = pluginsd_root;
+				pluginsd_root = cd;
+			}
+			cd->obsolete = 0;
+
+			if(unlikely(!cd->enabled)) continue;
+
+			// spawn a new thread for it
+			if(unlikely(pthread_create(&cd->thread, NULL, pluginsd_worker_thread, cd) != 0)) {
+				error("PLUGINSD: failed to create new thread for plugin '%s'.", cd->filename);
+				cd->obsolete = 1;
+			}
+			else if(unlikely(pthread_detach(cd->thread) != 0))
+				error("PLUGINSD: Cannot request detach of newly created thread for plugin '%s'.", cd->filename);
+		}
+
+		closedir(dir);
+		sleep((unsigned int) scan_frequency);
+	}
+
+	pthread_exit(NULL);
+	return NULL;
+}
+
+