Convert LTTngTop to C++ and state system

[lttngtop.git] / src / lttngtop.cpp

/*
 * Copyright (C) 2011-2012 Julien Desfossez
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License Version 2 as
 * published by the Free Software Foundation;
 *
 * 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, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#include <config.h>
#include <stdio.h>
#include <stdint.h>
extern "C" {
#include <babeltrace/babeltrace.h>
#include <babeltrace/ctf/events.h>
#include <babeltrace/ctf/callbacks.h>
#include <babeltrace/ctf/iterator.h>
}
#include <fcntl.h>
#include <pthread.h>
#include <popt.h>
#include <stdlib.h>
#include <ftw.h>
#include <dirent.h>
#include <ctype.h>
#include <sys/stat.h>
#include <unistd.h>
#include <string.h>
#include <errno.h>
#include <sys/types.h>
#include <fts.h>
#include <assert.h>

#include "lttngtoptypes.h"
#include "cputop.h"
#include "iostreamtop.h"
#include "common.h"
#include "cursesdisplay.h"

#define DEFAULT_FILE_ARRAY_SIZE 1

const char *opt_input_path;

pthread_t display_thread;
pthread_t timer_thread;

int quit = 0;
std::string history_file;

enum {
	OPT_NONE = 0,
	OPT_HELP,
	OPT_LIST,
	OPT_VERBOSE,
	OPT_DEBUG,
	OPT_NAMES,
};

static struct poptOption long_options[] = {
	/* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
	{ "help", 'h', POPT_ARG_NONE, NULL, OPT_HELP, NULL, NULL },
	{ NULL, 0, 0, NULL, 0, NULL, NULL },
};

void *refresh_thread(void *p)
{
	while (1) {
		if (quit)
			return NULL;
		sem_wait(&pause_sem);
		sem_post(&pause_sem);
		sem_post(&timer);
		sleep(refresh_display/NSEC_PER_SEC);
	}
}

void *ncurses_display(void *p)
{
	sem_wait(&bootstrap);
	/*
	 * Prevent the 1 second delay when we hit ESC
	 */
	ESCDELAY = 0;
	init_ncurses();

	while (1) {
		sem_wait(&timer);
		sem_wait(&goodtodisplay);
		sem_wait(&pause_sem);

		display();

		sem_post(&goodtoupdate);
		sem_post(&pause_sem);

		if (quit) {
			reset_ncurses();
			pthread_exit(0);
		}
	}
}

/*
 * We soft update each attribute during the execution for perfromance reasons.
 * Here we write the actual intervals to disk, which are needed to query history.
 */
void create_intervals(unsigned long timestamp)
{
	StateValue::SharedPtr value;

	for (std::set<Quark>::iterator i = modified_quarks.begin();
	     i != modified_quarks.end();
	     i++) {
		value = state_system->getCurrentStateValue(*i);
		/* To force the creation of an interval (which is what we want)
		   we need to pass a different value than the current value.
		   We reapply the correct value afterwards */
		if (std::tr1::dynamic_pointer_cast<NullStateValue>(value)) {
			state_system->modifyAttribute(timestamp, *i, 0);
		} else {
			state_system->modifyAttribute(timestamp, *i,
						      StateValue::getNullValue());
		}
		state_system->updateCurrentState(*i, value);
	}
	modified_quarks.clear();
}

/*
 * hook on each event to check the timestamp and refresh the display if
 * necessary
 */
enum bt_cb_ret check_timestamp(struct bt_ctf_event *call_data,
		void *private_data)
{
	unsigned long timestamp;

	timestamp = bt_ctf_get_timestamp(call_data);
	if (timestamp == -1ULL)
		goto error;

	if (last_display_update == 0)
		last_display_update = timestamp;

	if (first_display_update == 0)
		first_display_update = timestamp;

	if (timestamp - last_display_update >= refresh_display) {
		sem_wait(&goodtoupdate);
		create_intervals(timestamp);
		update_state_on_refresh(last_display_update, timestamp);
		sem_post(&goodtodisplay);
		sem_post(&bootstrap);
		last_display_update = timestamp;
	}
	return BT_CB_OK;

error:
	fprintf(stderr, "check_timestamp callback error\n");
	return BT_CB_ERROR_STOP;
}

/*
 * get_perf_counter : get or create and return a perf_counter struct for
 * either a process or a cpu (specified by root)
 */
Quark get_perf_counter(unsigned long timestamp, Quark root, std::string name)
{
	Quark perf_counter;

	if (state_system->attributeExists(root, "perf/" + name)) {
		return state_system->getQuark(root, "perf/" + name);
	} else {
		perf_counter = state_system->getQuark(root, "perf/" + name);
		modify_attribute(timestamp, &perf_counter, "count", 0);
		modify_attribute(timestamp, &perf_counter, "visible", 1);
		add_in_sequence(timestamp, perf_counter,
				state_system->getQuark(root, "perf"));
		return perf_counter;
	}
}

void update_perf_value(unsigned long timestamp, Quark proc, Quark cpu,
		       std::string name, int value)
{
	Quark cpu_perf, process_perf;
	int count;

	cpu_perf = get_perf_counter(timestamp, cpu, name);
	get_current_attribute_value_int(&cpu_perf, "count", count);
	if (count < value) {
		process_perf = get_perf_counter(timestamp, proc, name);
		increase_attribute(
			timestamp, &process_perf, "count", value - count);
		modify_attribute(timestamp, &cpu_perf, "count", value);
	}
}

void extract_perf_counter_scope(unsigned long timestamp,
				const struct bt_ctf_event *event,
				const struct definition *scope,
				Quark proc, Quark cpu)
{
	struct definition const * const *list = NULL;
	const struct definition *field;
	unsigned int count;
	int ret;
	std::string key;
	Quark perf_quark;

	if (!scope)
		goto end;

	ret = bt_ctf_get_field_list(event, scope, &list, &count);
	if (ret < 0)
		goto end;

	if (count == 0)
		goto end;

	if (get_current_attribute_value_quark(
		    NULL, "perf", perf_quark)) {
		do {
			get_current_attribute_value_string(
				&perf_quark, "key", key);
			field = bt_ctf_get_field(event, scope, key.c_str());
			if (field) {
				int value = bt_ctf_get_uint64(field);
				if (bt_ctf_field_get_error())
					continue;
				update_perf_value(
					timestamp, proc, cpu, key, value);
			}
		} while (get_current_attribute_value_quark(
				 &perf_quark, "next", perf_quark));
	}


end:
	return;
}

void update_perf_counter(unsigned long timestamp, Quark proc,
			 const struct bt_ctf_event *event)
{
	Quark cpu;
	const struct definition *scope;

	cpu = get_cpu(get_cpu_id(event), timestamp);

	scope = bt_ctf_get_top_level_scope(event, BT_STREAM_EVENT_CONTEXT);
	extract_perf_counter_scope(timestamp, event, scope, proc, cpu);

	scope = bt_ctf_get_top_level_scope(event, BT_STREAM_PACKET_CONTEXT);
	extract_perf_counter_scope(timestamp, event, scope, proc, cpu);

	scope = bt_ctf_get_top_level_scope(event, BT_EVENT_CONTEXT);
	extract_perf_counter_scope(timestamp, event, scope, proc, cpu);
}

enum bt_cb_ret fix_process_table(struct bt_ctf_event *call_data,
					   void *private_data)
{	int pid, tid, ppid;
	char *comm;
	Quark parent, child;
	unsigned long timestamp;

	timestamp = bt_ctf_get_timestamp(call_data);
	if (timestamp == -1ULL)
		goto error;

	pid = get_context_pid(call_data);
	if ((unsigned long)pid == -1ULL) {
		goto error;
	}
	tid = get_context_tid(call_data);
	if ((unsigned long)tid == -1ULL) {
		goto error;
	}
	ppid = get_context_ppid(call_data);
	if ((unsigned long)ppid == -1ULL) {
		goto error;
	}
	comm = get_context_comm(call_data);
	if (!comm) {
		goto error;
	}

	/* find or create the current process */
	if (!find_process_tid(tid, child))
		child = add_proc(tid, comm, timestamp);
	update_proc(timestamp, child, pid, tid, ppid, comm);

	if (pid != tid) {
		/* find or create the parent */
		if (!find_process_tid(pid, parent)) {
			parent = add_proc(pid, comm, timestamp);
			modify_attribute(timestamp, &parent, "pid", pid);
		}

		/* attach the parent to the current process */
		modify_attribute(timestamp, &parent, "threadparent", parent);
		add_thread(timestamp, parent, child);
	}

	update_perf_counter(timestamp, child, call_data);

	return BT_CB_OK;

error:
	return BT_CB_ERROR_STOP;
}

void init_lttngtop()
{
	sem_init(&goodtodisplay, 0, 0);
	sem_init(&goodtoupdate, 0, 1);
	sem_init(&timer, 0, 1);
	sem_init(&bootstrap, 0, 0);
	sem_init(&pause_sem, 0, 1);
	sem_init(&end_trace_sem, 0, 0);

	// TODO: real file name
	std::stringstream ss;
	ss << "history" << time(NULL) << ".hst";
	history_file = ss.str();
	IntervalHistoryProvider *ihp = g_new(IntervalHistoryProvider, 1);
	new (ihp) IntervalHistoryProvider(history_file);
	state_system = g_new(StateSystem, 1);
	new (state_system) StateSystem(ihp);

	/* Create global attributes */
	state_system->updateCurrentState(
		state_system->getQuark("nbproc"), 0);
	state_system->updateCurrentState(
		state_system->getQuark("nbnewproc"), 0);
	state_system->updateCurrentState(
		state_system->getQuark("nbdeadproc"), 0);
	state_system->updateCurrentState(
		state_system->getQuark("nbthreads"), 0);
	state_system->updateCurrentState(
		state_system->getQuark("nbnewthreads"), 0);
	state_system->updateCurrentState(
		state_system->getQuark("nbdeadthreads"), 0);
	state_system->updateCurrentState(
		state_system->getQuark("nbfiles"), 0);
	state_system->updateCurrentState(
		state_system->getQuark("nbnewfiles"), 0);
	state_system->updateCurrentState(
		state_system->getQuark("nbdeadfiles"), 0);
}

void usage(FILE *fp)
{
	fprintf(fp, "LTTngTop %s\n\n", VERSION);
	fprintf(fp, "Usage : lttngtop /path/to/trace\n");
}

/*
 * Return 0 if caller should continue, < 0 if caller should return
 * error, > 0 if caller should exit without reporting error.
 */
static int parse_options(int argc, char **argv)
{
	poptContext pc;
	int opt, ret = 0;

	if (argc == 1) {
		usage(stdout);
		return 1;   /* exit cleanly */
	}

	pc = poptGetContext(NULL, argc, (const char **) argv, long_options, 0);
	poptReadDefaultConfig(pc, 0);

	while ((opt = poptGetNextOpt(pc)) != -1) {
		switch (opt) {
			case OPT_HELP:
				usage(stdout);
				ret = 1;    /* exit cleanly */
				goto end;
			default:
				ret = -EINVAL;
				goto end;
		}
	}

	opt_input_path = poptGetArg(pc);
	if (!opt_input_path) {
		ret = -EINVAL;
		goto end;
	}
end:
	if (pc) {
		poptFreeContext(pc);
	}
	return ret;
}

void iter_trace(struct bt_context *bt_ctx)
{
	struct bt_ctf_iter *iter;
	struct bt_iter_pos begin_pos;
	const struct bt_ctf_event *event;
	int ret = 0;

	begin_pos.type = bt_iter_pos::BT_SEEK_BEGIN;
	iter = bt_ctf_iter_create(bt_ctx, &begin_pos, NULL);

	/* at each event check if we need to refresh */
	bt_ctf_iter_add_callback(iter, 0, NULL, 0,
			check_timestamp,
			NULL, NULL, NULL);
	/* at each event, verify the status of the process table */
	bt_ctf_iter_add_callback(iter, 0, NULL, 0,
			fix_process_table,
			NULL, NULL, NULL);
	/* to handle the scheduling events */
	bt_ctf_iter_add_callback(iter,
			g_quark_from_static_string("sched_switch"),
			NULL, 0, handle_sched_switch, NULL, NULL, NULL);
	/* to clean up the process table */
	bt_ctf_iter_add_callback(iter,
			g_quark_from_static_string("sched_process_free"),
			NULL, 0, handle_sched_process_free, NULL, NULL, NULL);
	/* to get all the process from the statedumps */
	bt_ctf_iter_add_callback(iter,
			g_quark_from_static_string(
				"lttng_statedump_process_state"),
			NULL, 0, handle_statedump_process_state,
			NULL, NULL, NULL);

	/* for IO top */
	bt_ctf_iter_add_callback(iter,
			g_quark_from_static_string("exit_syscall"),
			NULL, 0, handle_exit_syscall, NULL, NULL, NULL);
	bt_ctf_iter_add_callback(iter,
			g_quark_from_static_string("sys_write"),
			NULL, 0, handle_sys_write, NULL, NULL, NULL);
	bt_ctf_iter_add_callback(iter,
			g_quark_from_static_string("sys_read"),
			NULL, 0, handle_sys_read, NULL, NULL, NULL);
	bt_ctf_iter_add_callback(iter,
			g_quark_from_static_string("sys_open"),
			NULL, 0, handle_sys_open, NULL, NULL, NULL);
	bt_ctf_iter_add_callback(iter,
			g_quark_from_static_string("sys_close"),
			NULL, 0, handle_sys_close, NULL, NULL, NULL);
	bt_ctf_iter_add_callback(iter,
			g_quark_from_static_string(
					"lttng_statedump_file_descriptor"),
			NULL, 0, handle_statedump_file_descriptor,
			NULL, NULL, NULL);

	while ((event = bt_ctf_iter_read_event(iter)) != NULL) {
		ret = bt_iter_next(bt_ctf_get_iter(iter));
		if (ret < 0)
			goto end_iter;
	}

	/* block until quit, we reached the end of the trace */
	sem_wait(&end_trace_sem);

end_iter:
	bt_ctf_iter_destroy(iter);
}

/*
 * bt_context_add_traces_recursive: Open a trace recursively
 * (copied from BSD code in converter/babeltrace.c)
 *
 * Find each trace present in the subdirectory starting from the given
 * path, and add them to the context. The packet_seek parameter can be
 * NULL: this specify to use the default format packet_seek.
 *
 * Return: 0 on success, nonzero on failure.
 * Unable to open toplevel: failure.
 * Unable to open some subdirectory or file: warn and continue;
 */
int bt_context_add_traces_recursive(struct bt_context *ctx, const char *path,
		const char *format_str,
		void (*packet_seek)(struct stream_pos *pos,
			size_t offset, int whence))
{
	FTS *tree;
	FTSENT *node;
	GArray *trace_ids;
	char lpath[PATH_MAX];
	char * const paths[2] = { lpath, NULL };
	int ret = -1;

	/*
	 * Need to copy path, because fts_open can change it.
	 * It is the pointer array, not the strings, that are constant.
	 */
	strncpy(lpath, path, PATH_MAX);
	lpath[PATH_MAX - 1] = '\0';

	tree = fts_open(paths, FTS_NOCHDIR | FTS_LOGICAL, 0);
	if (tree == NULL) {
		fprintf(stderr, "[error] [Context] Cannot traverse \"%s\" for reading.\n",
				path);
		return -EINVAL;
	}

	trace_ids = g_array_new(FALSE, TRUE, sizeof(int));

	while ((node = fts_read(tree))) {
		int dirfd, metafd;

		if (!(node->fts_info & FTS_D))
			continue;

		dirfd = open(node->fts_accpath, 0);
		if (dirfd < 0) {
			fprintf(stderr, "[error] [Context] Unable to open trace "
				"directory file descriptor.\n");
			ret = dirfd;
			goto error;
		}
		metafd = openat(dirfd, "metadata", O_RDONLY);
		if (metafd < 0) {
			close(dirfd);
			ret = -1;
			continue;
		} else {
			int trace_id;

			ret = close(metafd);
			if (ret < 0) {
				perror("close");
				goto error;
			}
			ret = close(dirfd);
			if (ret < 0) {
				perror("close");
				goto error;
			}

			trace_id = bt_context_add_trace(ctx,
				node->fts_accpath, format_str,
				packet_seek, NULL, NULL);
			if (trace_id < 0) {
				fprintf(stderr, "[warning] [Context] opening trace \"%s\" from %s "
					"for reading.\n", node->fts_accpath, path);
				/* Allow to skip erroneous traces. */
				continue;
			}
			g_array_append_val(trace_ids, trace_id);
		}
	}

	g_array_free(trace_ids, TRUE);
	return ret;

error:
	return ret;
}

static int check_field_requirements(const struct bt_ctf_field_decl *const * field_list,
		int field_cnt, int *tid_check, int *pid_check,
		int *procname_check, int *ppid_check)
{
	int j;
	const char *name;
	Quark perf;
	Quark perf_root = state_system->getQuark("perf");
	static bool first_perf_counter = true;

	for (j = 0; j < field_cnt; j++) {
		name = bt_ctf_get_decl_field_name(field_list[j]);
		if (*tid_check == 0) {
			if (strncmp(name, "tid", 3) == 0)
				(*tid_check)++;
		}
		if (*pid_check == 0) {
			if (strncmp(name, "tid", 3) == 0)
				(*pid_check)++;
		}
		if (*ppid_check == 0) {
			if (strncmp(name, "ppid", 4) == 0)
				(*ppid_check)++;
		}
		if (*procname_check == 0) {
			if (strncmp(name, "procname", 8) == 0)
				(*procname_check)++;
		}
		if (strncmp(name, "perf_", 5) == 0) {
			if (!state_system->attributeExists(
				    perf_root, name+5)) {
				perf = state_system->getQuark(perf_root, name+5);
				/* by default, sort on the first perf context */
				if (first_perf_counter) {
					modify_attribute(0, &perf, "sort", 1);
					first_perf_counter = false;
				}
				modify_attribute(0, &perf, "visible", 1);
				add_in_sequence(0, perf, perf_root);
			}
		}
	}

	if (*tid_check == 1 && *pid_check == 1 && *ppid_check == 1 &&
			*procname_check == 1)
		return 0;

	return -1;
}

/*
 * check_requirements: check if the required context informations are available
 *
 * If each mandatory context information is available for at least in one
 * event, return 0 otherwise return -1.
 */
int check_requirements(struct bt_context *ctx)
{
	unsigned int i, evt_cnt, field_cnt;
	struct bt_ctf_event_decl *const * evt_list;
	const struct bt_ctf_field_decl *const * field_list;
	int tid_check = 0;
	int pid_check = 0;
	int procname_check = 0;
	int ppid_check = 0;
	int ret = 0;

	bt_ctf_get_event_decl_list(0, ctx, &evt_list, &evt_cnt);
	for (i = 0; i < evt_cnt; i++) {
		bt_ctf_get_decl_fields(evt_list[i], BT_STREAM_EVENT_CONTEXT,
				&field_list, &field_cnt);
		ret = check_field_requirements(field_list, field_cnt,
				&tid_check, &pid_check, &procname_check,
				&ppid_check);

		bt_ctf_get_decl_fields(evt_list[i], BT_EVENT_CONTEXT,
				&field_list, &field_cnt);
		ret = check_field_requirements(field_list, field_cnt,
				&tid_check, &pid_check, &procname_check,
				&ppid_check);

		bt_ctf_get_decl_fields(evt_list[i], BT_STREAM_PACKET_CONTEXT,
				&field_list, &field_cnt);
		ret = check_field_requirements(field_list, field_cnt,
				&tid_check, &pid_check, &procname_check,
				&ppid_check);
	}

	if (tid_check == 0) {
		ret = -1;
		fprintf(stderr, "[error] missing tid context information\n");
	}
	if (pid_check == 0) {
		ret = -1;
		fprintf(stderr, "[error] missing pid context information\n");
	}
	if (ppid_check == 0) {
		ret = -1;
		fprintf(stderr, "[error] missing ppid context information\n");
	}
	if (procname_check == 0) {
		ret = -1;
		fprintf(stderr, "[error] missing procname context information\n");
	}

	return ret;
}

int main(int argc, char **argv)
{
	int ret;
	struct bt_context *bt_ctx = NULL;

	ret = parse_options(argc, argv);
	if (ret < 0) {
		fprintf(stdout, "Error parsing options.\n\n");
		usage(stdout);
		exit(EXIT_FAILURE);
	} else if (ret > 0) {
		exit(EXIT_SUCCESS);
	}

	init_lttngtop();

	bt_ctx = bt_context_create();
	ret = bt_context_add_traces_recursive(bt_ctx, opt_input_path, "ctf", NULL);
	if (ret < 0) {
		fprintf(stderr, "[error] Opening the trace\n");
		goto end;
	}

	ret = check_requirements(bt_ctx);
	if (ret < 0) {
		fprintf(stderr, "[error] some mandatory contexts were missing, exiting.\n");
		goto end;
	}

	pthread_create(&display_thread, NULL, ncurses_display, (void *) NULL);
	pthread_create(&timer_thread, NULL, refresh_thread, (void *) NULL);

	iter_trace(bt_ctx);

	quit = 1;
	pthread_join(display_thread, NULL);
	pthread_join(timer_thread, NULL);

end:
	bt_context_put(bt_ctx);
	return 0;
}