trace_view.c

/*
	Copyright Jeroen Vreeken (pe1rxq@amsat.org), 2007
	Copyright Stichting C.A. Muller Radioastronomiestation, 2007

	This program is free software: you can redistribute it and/or modify
	it under the terms of the GNU General Public License as published by
	the Free Software Foundation, either version 3 of the License, or
	(at your option) any later version.

	This program is distributed in the hope that it will be useful,
	but WITHOUT ANY WARRANTY; without even the implied warranty of
	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
	GNU General Public License for more details.

	You should have received a copy of the GNU General Public License
	along with this program.  If not, see <http://www.gnu.org/licenses/>.

 */

#include <stdio.h>
#include <stdlib.h>
#include <unistd.h>
#include <sys/types.h>
#include <sys/socket.h>
#include <netinet/in.h>
#include <string.h>
#include <math.h>
#include <time.h>
#include <err.h>

#include <trace/trace.h>

time_t starttime;

int val_buflen;

//#define VAL_BUFLEN (60 * 5)
FILE *fdplot = NULL;
int doplot = 0;

struct trace_view {
	struct trace *trace;
	char *tmpfilename;
	FILE *fdtmp;
	struct trace_value *value;
	int bufpos;
};

struct trace_view *traces;

float samp_min, samp_max;

static void add_to_range(float val)
{

	if (val < samp_min)
		samp_min = val;
	if (val > samp_max)
		samp_max = val;
}

void plot_values(struct trace_view *traces, int nr_traces)
{
	int i;
	int bufpos = (traces[0].bufpos + val_buflen - 1) % val_buflen;
	long long now = traces[0].value[bufpos].t.tv_sec;
	long nown = traces[0].value[bufpos].t.tv_nsec;
	float range, range_low, range_high;
	
	fprintf(fdplot, "plot ");

	for(i = 0; i < nr_traces; i++) {
		if (i > 0)
			fprintf(fdplot, ", ");
		fprintf(fdplot, "'%s' using ($1-%lld.%09ld):($2) title '%s [%s]' with lines",
		    traces[i].tmpfilename,
		    now, nown,
		    traces[i].trace->name, 
		    "");
	}
	fprintf(fdplot, "\n");

	// Calculate an y range that will fit all samples, plus a tiny bit
	// more so the lowest/highest values are still visible at the edges of
	// the plot.
	//printf("sample range: %f, %f\n", samp_min, samp_max);
	range = samp_max - samp_min;
	if (range == 0.0)
		range = 0.1;

	range_low = samp_min - range * 0.02;
	range_high = samp_max + range * 0.02;
	fprintf(fdplot, "set yrange [%e:%e]\n", range_low, range_high);

	fflush(NULL);

	return;
}

static void print_value(FILE *fd,
    struct trace *trace, struct trace_value *value)
{
	switch (trace->type) {
		case TRACE_VALUE_TYPE_FLOAT:
			fprintf(fd, "%ld.%09ld %e\n", 
			value->t.tv_sec, value->t.tv_nsec, value->value.f);
			add_to_range(value->value.f);
			break;
		case TRACE_VALUE_TYPE_BOOL:
			fprintf(fd, "%ld.%09ld %d\n", 
			value->t.tv_sec, value->t.tv_nsec, value->value.b);
			add_to_range(value->value.b);
			break;
		case TRACE_VALUE_TYPE_UINT8:
			fprintf(fd, "%ld.%09ld %u\n", 
			value->t.tv_sec, value->t.tv_nsec, value->value.u8);
			add_to_range(value->value.u8);
			break;
		case TRACE_VALUE_TYPE_UINT16:
			fprintf(fd, "%ld.%09ld %u\n", 
			value->t.tv_sec, value->t.tv_nsec, value->value.u16);
			add_to_range(value->value.u16);
			break;
		case TRACE_VALUE_TYPE_UINT32:
			fprintf(fd, "%ld.%09ld %u\n", 
			value->t.tv_sec, value->t.tv_nsec, value->value.u32);
			add_to_range(value->value.u32);
			break;
		case TRACE_VALUE_TYPE_SINT8:
			fprintf(fd, "%ld.%09ld %d\n", 
			value->t.tv_sec, value->t.tv_nsec, value->value.s8);
			add_to_range(value->value.s8);
			break;
		case TRACE_VALUE_TYPE_SINT16:
			fprintf(fd, "%ld.%09ld %d\n", 
			value->t.tv_sec, value->t.tv_nsec, value->value.s16);
			add_to_range(value->value.s16);
			break;
		case TRACE_VALUE_TYPE_SINT32:
			fprintf(fd, "%ld.%09ld %d\n", 
			value->t.tv_sec, value->t.tv_nsec, value->value.s32);
			add_to_range(value->value.s32);
			break;
	}
}

static void handler_value(struct trace *trace, int channel,
    struct trace_value *value)
{
	struct trace_view *view;
	int i;
	
	view = trace->private;
	
	view->value[view->bufpos] = *value;

	freopen(NULL, "w", view->fdtmp);
	for (i = view->bufpos + 1; i < val_buflen; i++) {
		if ((!view->value[i].t.tv_sec) ||
		    (view->value[i].t.tv_sec == 1))
			continue;

		print_value(view->fdtmp, trace, &view->value[i]);
	}
	for (i = 0; i <= view->bufpos; i++) {
		if (!view->value[i].t.tv_sec)
			continue;

		print_value(view->fdtmp, trace, &view->value[i]);
	}
	fflush(view->fdtmp);


	view->bufpos++;
	view->bufpos %= val_buflen;
	
	doplot++;
}

static void usage(char *progname)
{

	fprintf(stderr, "usage: %s [options] [one or more trace names]\n"
	    "available options:\n"
	    " --host [hostname]       set the name of the host to connect to\n"
	    " --port [port#]          set the remote port number to connect "
	    "to\n"
	    " --interval [seconds]    set the sample interval\n",
	    " --history [seconds]     set the length of the plot\n",
	    progname);
	exit(1);
}

int main(int argc, char **argv)
{
	struct timespec t_int;
	struct trace_view *t;
	double interval, history;
	char *host;
        int trace_nr, i, port, ret = 0;

	starttime = time(NULL);
	host = "localhost";
	port = 10000;

	if (argc < 2)
		usage(argv[0]);

	history = 60.0;
	interval = 0.2;

	traces = calloc(sizeof(struct trace_view), argc - 1);
	trace_nr = 0;
	for (i = 0; i < argc - 1; i++) {
		char *tracename = argv[i+1];
		int fdmkstemp;
		
		if (strcmp(tracename, "--host") == 0) {
			if (i >= argc - 2)
				errx(1, "missing hostname");
			
			i++;
			host = argv[i + 1];
			fprintf(stderr, "Setting remote host to '%s'\n",
			    host);
			continue;
		}
		if (strcmp(tracename, "--port") == 0) {
			if (i >= argc - 2)
				errx(1, "missing port number");
			
			i++;
			port = atoi(argv[i + 1]);
			fprintf(stderr, "Setting remote port to %d\n", port);
			continue;
		}
		if (strcmp(tracename, "--interval") == 0) {
			if (i >= argc - 2)
				errx(1, "missing interval argument");
			
			i++;
			interval = atof(argv[i + 1]);
			fprintf(stderr, "Setting sample interval %fs\n",
			    interval);
			continue;
		}
		if (strcmp(tracename, "--history") == 0) {
			if (i >= argc - 2)
				errx(1, "missing history argument");
			
			i++;
			history = atof(argv[i + 1]);
			fprintf(stderr, "Setting history to %fs\n", history);
			continue;
		}
		
		fprintf(stderr, "Adding trace '%s'\n", tracename);
		t = &traces[trace_nr];
		t->trace = trace_open(host, port);
		if (!t->trace) {
			fprintf(stderr, "opening trace on %s:%d failed\n",
			    host, port);
			return 1;
		}
		t->trace->private = &traces[trace_nr];
		trace_name_set(t->trace, tracename);

		t->tmpfilename = malloc(100);
		sprintf(t->tmpfilename,
		     "/tmp/trace_view_XXXXXX");
		fdmkstemp = mkstemp(t->tmpfilename);
	
		printf("Going to use %s temp file for '%s' data\n",
		    t->tmpfilename, tracename);
		t->fdtmp = fdopen(fdmkstemp, "w");
		if (t->fdtmp == NULL) {
			perror("fopen() failed");
			return 1;
		}

		t->trace->handler_value = handler_value;
		trace_nr++;
	}
	
	if (trace_nr == 0) {
		// Only options, but no trace names..
		fprintf(stderr, "Error: Need at least one trace name.\n\n");
		usage(argv[0]);
	}
	
	// calculate buffer length & sample interval
	if (interval <= 0.0)
		errx(1, "invalid interval!");
	if (history <= 0.0)
		errx(1, "invalid history length!");
	if (history < interval)
		errx(1, "history length must be >= interval!");
	
	t_int.tv_sec = floor(interval);
	t_int.tv_nsec = (interval - t_int.tv_sec) * 1.0e9;

	//t_int.tv_sec = 0;
	//t_int.tv_nsec = 200 * 1000;
	
	// set interval on all trace connections
	for (i = 0; i < trace_nr; i++) {
		struct trace_pkt *pkt;

		t = &traces[i];
		pkt = trace_packet_new();
		trace_packet_interval_set(pkt, 
		    &t_int, TRACE_INTERVAL_TYPE_INTERVAL);
		trace_packet_write(t->trace, pkt);
		trace_packet_put(pkt);
	}
	

	// allocate memory for enough samples
	val_buflen = ceil(history / interval);
	//printf("buflen=%d samples\n", val_buflen);
	//printf("interval= %d.%09d\n", t_int.tv_sec, t_int.tv_nsec);

	for (i = 0; i < trace_nr; i++) {
		traces[i].value = calloc(val_buflen,
		    sizeof(struct trace_value));
		if (traces[i].value == NULL)
			errx(1, "out of memory!");
	}
	
	fdplot = popen("gnuplot -noraise", "w");
	if (fdplot == NULL) {
		perror("popen() failed");
		return 1;
	}
	
	fprintf(fdplot, "set grid\n");

	samp_min = +INFINITY;
	samp_max = -INFINITY;

	do {
		fd_set fdrx;
		
		int high = 0;

		FD_ZERO(&fdrx);
	
		for (i = 0; i < trace_nr; i++) {
			trace_fd_set(traces[i].trace, &fdrx, &high);
		}
		
		select(high+1, &fdrx, NULL, NULL, NULL);

		for (i = 0; i < trace_nr; i++) {
			trace_handle(traces[i].trace, &fdrx);
		}

		if (doplot >= trace_nr) {
			plot_values(traces, trace_nr);
			doplot = 0;

			samp_min = +INFINITY;
			samp_max = -INFINITY;
		}
	} while (ret == 0);

	for (i = 0; i < argc - 1; i++)
		unlink(traces[i].tmpfilename);

	return 0;
}