Blame tests/clar_libgit2_trace.c

Packit ae9e2a
#include "clar_libgit2.h"
Packit ae9e2a
#include "clar_libgit2_trace.h"
Packit ae9e2a
#include "clar_libgit2_timer.h"
Packit ae9e2a
#include "trace.h"
Packit ae9e2a
Packit ae9e2a
Packit ae9e2a
struct method {
Packit ae9e2a
	const char *name;
Packit ae9e2a
	void (*git_trace_cb)(git_trace_level_t level, const char *msg);
Packit ae9e2a
	void (*close)(void);
Packit ae9e2a
};
Packit ae9e2a
Packit ae9e2a
Packit ae9e2a
#if defined(GIT_TRACE)
Packit ae9e2a
static void _git_trace_cb__printf(git_trace_level_t level, const char *msg)
Packit ae9e2a
{
Packit ae9e2a
	/* TODO Use level to print a per-message prefix. */
Packit ae9e2a
	GIT_UNUSED(level);
Packit ae9e2a
Packit ae9e2a
	printf("%s\n", msg);
Packit ae9e2a
}
Packit ae9e2a
Packit ae9e2a
#if defined(GIT_WIN32)
Packit ae9e2a
static void _git_trace_cb__debug(git_trace_level_t level, const char *msg)
Packit ae9e2a
{
Packit ae9e2a
	/* TODO Use level to print a per-message prefix. */
Packit ae9e2a
	GIT_UNUSED(level);
Packit ae9e2a
Packit ae9e2a
	OutputDebugString(msg);
Packit ae9e2a
	OutputDebugString("\n");
Packit ae9e2a
Packit ae9e2a
	printf("%s\n", msg);
Packit ae9e2a
}
Packit ae9e2a
#else
Packit ae9e2a
#define _git_trace_cb__debug _git_trace_cb__printf
Packit ae9e2a
#endif
Packit ae9e2a
Packit ae9e2a
Packit ae9e2a
static void _trace_printf_close(void)
Packit ae9e2a
{
Packit ae9e2a
	fflush(stdout);
Packit ae9e2a
}
Packit ae9e2a
Packit ae9e2a
#define _trace_debug_close _trace_printf_close
Packit ae9e2a
Packit ae9e2a
Packit ae9e2a
static struct method s_methods[] = {
Packit ae9e2a
	{ "printf", _git_trace_cb__printf, _trace_printf_close },
Packit ae9e2a
	{ "debug",  _git_trace_cb__debug,  _trace_debug_close  },
Packit ae9e2a
	/* TODO add file method */
Packit ae9e2a
	{0},
Packit ae9e2a
};
Packit ae9e2a
Packit ae9e2a
Packit ae9e2a
static int s_trace_loaded = 0;
Packit ae9e2a
static int s_trace_level = GIT_TRACE_NONE;
Packit ae9e2a
static struct method *s_trace_method = NULL;
Packit ae9e2a
Packit ae9e2a
Packit ae9e2a
static int set_method(const char *name)
Packit ae9e2a
{
Packit ae9e2a
	int k;
Packit ae9e2a
Packit ae9e2a
	if (!name || !*name)
Packit ae9e2a
		name = "printf";
Packit ae9e2a
Packit ae9e2a
	for (k=0; (s_methods[k].name); k++) {
Packit ae9e2a
		if (strcmp(name, s_methods[k].name) == 0) {
Packit ae9e2a
			s_trace_method = &s_methods[k];
Packit ae9e2a
			return 0;
Packit ae9e2a
		}
Packit ae9e2a
	}
Packit ae9e2a
	fprintf(stderr, "Unknown CLAR_TRACE_METHOD: '%s'\n", name);
Packit ae9e2a
	return -1;
Packit ae9e2a
}
Packit ae9e2a
Packit ae9e2a
Packit ae9e2a
/**
Packit ae9e2a
 * Lookup CLAR_TRACE_LEVEL and CLAR_TRACE_METHOD from
Packit ae9e2a
 * the environment and set the above s_trace_* fields.
Packit ae9e2a
 *
Packit ae9e2a
 * If CLAR_TRACE_LEVEL is not set, we disable tracing.
Packit ae9e2a
 *
Packit ae9e2a
 * TODO If set, we assume GIT_TRACE_TRACE level, which
Packit ae9e2a
 * logs everything. Later, we may want to parse the
Packit ae9e2a
 * value of the environment variable and set a specific
Packit ae9e2a
 * level.
Packit ae9e2a
 *
Packit ae9e2a
 * We assume the "printf" method.  This can be changed
Packit ae9e2a
 * with the CLAR_TRACE_METHOD environment variable.
Packit ae9e2a
 * Currently, this is only needed on Windows for a "debug"
Packit ae9e2a
 * version which also writes to the debug output window
Packit ae9e2a
 * in Visual Studio.
Packit ae9e2a
 *
Packit ae9e2a
 * TODO add a "file" method that would open and write
Packit ae9e2a
 * to a well-known file. This would help keep trace
Packit ae9e2a
 * output and clar output separate.
Packit ae9e2a
 *
Packit ae9e2a
 */
Packit ae9e2a
static void _load_trace_params(void)
Packit ae9e2a
{
Packit ae9e2a
	char *sz_level;
Packit ae9e2a
	char *sz_method;
Packit ae9e2a
Packit ae9e2a
	s_trace_loaded = 1;
Packit ae9e2a
Packit ae9e2a
	sz_level = cl_getenv("CLAR_TRACE_LEVEL");
Packit ae9e2a
	if (!sz_level || !*sz_level) {
Packit ae9e2a
		s_trace_level = GIT_TRACE_NONE;
Packit ae9e2a
		s_trace_method = NULL;
Packit ae9e2a
		return;
Packit ae9e2a
	}
Packit ae9e2a
Packit ae9e2a
	/* TODO Parse sz_level and set s_trace_level. */
Packit ae9e2a
	s_trace_level = GIT_TRACE_TRACE;
Packit ae9e2a
Packit ae9e2a
	sz_method = cl_getenv("CLAR_TRACE_METHOD");
Packit ae9e2a
	if (set_method(sz_method) < 0)
Packit ae9e2a
		set_method(NULL);
Packit ae9e2a
}
Packit ae9e2a
Packit ae9e2a
#define HR "================================================================"
Packit ae9e2a
Packit ae9e2a
/**
Packit ae9e2a
 * Timer to report the take spend in a test's run() method.
Packit ae9e2a
 */
Packit ae9e2a
static cl_perf_timer s_timer_run = CL_PERF_TIMER_INIT;
Packit ae9e2a
Packit ae9e2a
/**
Packit ae9e2a
 * Timer to report total time in a test (init, run, cleanup).
Packit ae9e2a
 */
Packit ae9e2a
static cl_perf_timer s_timer_test = CL_PERF_TIMER_INIT;
Packit ae9e2a
Packit ae9e2a
void _cl_trace_cb__event_handler(
Packit ae9e2a
	cl_trace_event ev,
Packit ae9e2a
	const char *suite_name,
Packit ae9e2a
	const char *test_name,
Packit ae9e2a
	void *payload)
Packit ae9e2a
{
Packit ae9e2a
	GIT_UNUSED(payload);
Packit ae9e2a
Packit ae9e2a
	switch (ev) {
Packit ae9e2a
	case CL_TRACE__SUITE_BEGIN:
Packit ae9e2a
		git_trace(GIT_TRACE_TRACE, "\n\n%s\n%s: Begin Suite", HR, suite_name);
Packit ae9e2a
#if 0 && defined(GIT_MSVC_CRTDBG)
Packit ae9e2a
		git_win32__crtdbg_stacktrace__dump(
Packit ae9e2a
			GIT_WIN32__CRTDBG_STACKTRACE__SET_MARK,
Packit ae9e2a
			suite_name);
Packit ae9e2a
#endif
Packit ae9e2a
		break;
Packit ae9e2a
Packit ae9e2a
	case CL_TRACE__SUITE_END:
Packit ae9e2a
#if 0 && defined(GIT_MSVC_CRTDBG)
Packit ae9e2a
		/* As an example of checkpointing, dump leaks within this suite.
Packit ae9e2a
		 * This may generate false positives for things like the global
Packit ae9e2a
		 * TLS error state and maybe the odb cache since they aren't
Packit ae9e2a
		 * freed until the global shutdown and outside the scope of this
Packit ae9e2a
		 * set of tests.
Packit ae9e2a
		 *
Packit ae9e2a
		 * This may under-report if the test itself uses a checkpoint.
Packit ae9e2a
		 * See tests/trace/windows/stacktrace.c
Packit ae9e2a
		 */
Packit ae9e2a
		git_win32__crtdbg_stacktrace__dump(
Packit ae9e2a
			GIT_WIN32__CRTDBG_STACKTRACE__LEAKS_SINCE_MARK,
Packit ae9e2a
			suite_name);
Packit ae9e2a
#endif
Packit ae9e2a
		git_trace(GIT_TRACE_TRACE, "\n\n%s: End Suite\n%s", suite_name, HR);
Packit ae9e2a
		break;
Packit ae9e2a
Packit ae9e2a
	case CL_TRACE__TEST__BEGIN:
Packit ae9e2a
		git_trace(GIT_TRACE_TRACE, "\n%s::%s: Begin Test", suite_name, test_name);
Packit ae9e2a
		cl_perf_timer__init(&s_timer_test);
Packit ae9e2a
		cl_perf_timer__start(&s_timer_test);
Packit ae9e2a
		break;
Packit ae9e2a
Packit ae9e2a
	case CL_TRACE__TEST__END:
Packit ae9e2a
		cl_perf_timer__stop(&s_timer_test);
Packit ae9e2a
		git_trace(GIT_TRACE_TRACE, "%s::%s: End Test (%.3f %.3f)", suite_name, test_name,
Packit ae9e2a
				  cl_perf_timer__last(&s_timer_run),
Packit ae9e2a
				  cl_perf_timer__last(&s_timer_test));
Packit ae9e2a
		break;
Packit ae9e2a
Packit ae9e2a
	case CL_TRACE__TEST__RUN_BEGIN:
Packit ae9e2a
		git_trace(GIT_TRACE_TRACE, "%s::%s: Begin Run", suite_name, test_name);
Packit ae9e2a
		cl_perf_timer__init(&s_timer_run);
Packit ae9e2a
		cl_perf_timer__start(&s_timer_run);
Packit ae9e2a
		break;
Packit ae9e2a
Packit ae9e2a
	case CL_TRACE__TEST__RUN_END:
Packit ae9e2a
		cl_perf_timer__stop(&s_timer_run);
Packit ae9e2a
		git_trace(GIT_TRACE_TRACE, "%s::%s: End Run", suite_name, test_name);
Packit ae9e2a
		break;
Packit ae9e2a
Packit ae9e2a
	case CL_TRACE__TEST__LONGJMP:
Packit ae9e2a
		cl_perf_timer__stop(&s_timer_run);
Packit ae9e2a
		git_trace(GIT_TRACE_TRACE, "%s::%s: Aborted", suite_name, test_name);
Packit ae9e2a
		break;
Packit ae9e2a
Packit ae9e2a
	default:
Packit ae9e2a
		break;
Packit ae9e2a
	}
Packit ae9e2a
}
Packit ae9e2a
Packit ae9e2a
#endif /*GIT_TRACE*/
Packit ae9e2a
Packit ae9e2a
/**
Packit ae9e2a
 * Setup/Enable git_trace() based upon settings user's environment.
Packit ae9e2a
 *
Packit ae9e2a
 */
Packit ae9e2a
void cl_global_trace_register(void)
Packit ae9e2a
{
Packit ae9e2a
#if defined(GIT_TRACE)
Packit ae9e2a
	if (!s_trace_loaded)
Packit ae9e2a
		_load_trace_params();
Packit ae9e2a
Packit ae9e2a
	if (s_trace_level == GIT_TRACE_NONE)
Packit ae9e2a
		return;
Packit ae9e2a
	if (s_trace_method == NULL)
Packit ae9e2a
		return;
Packit ae9e2a
	if (s_trace_method->git_trace_cb == NULL)
Packit ae9e2a
		return;
Packit ae9e2a
Packit ae9e2a
	git_trace_set(s_trace_level, s_trace_method->git_trace_cb);
Packit ae9e2a
	cl_trace_register(_cl_trace_cb__event_handler, NULL);
Packit ae9e2a
#endif
Packit ae9e2a
}
Packit ae9e2a
Packit ae9e2a
/**
Packit ae9e2a
 * If we turned on git_trace() earlier, turn it off.
Packit ae9e2a
 *
Packit ae9e2a
 * This is intended to let us close/flush any buffered
Packit ae9e2a
 * IO if necessary.
Packit ae9e2a
 *
Packit ae9e2a
 */
Packit ae9e2a
void cl_global_trace_disable(void)
Packit ae9e2a
{
Packit ae9e2a
#if defined(GIT_TRACE)
Packit ae9e2a
	cl_trace_register(NULL, NULL);
Packit ae9e2a
	git_trace_set(GIT_TRACE_NONE, NULL);
Packit ae9e2a
	if (s_trace_method && s_trace_method->close)
Packit ae9e2a
		s_trace_method->close();
Packit ae9e2a
Packit ae9e2a
	/* Leave s_trace_ vars set so they can restart tracing
Packit ae9e2a
	 * since we only want to hit the environment variables
Packit ae9e2a
	 * once.
Packit ae9e2a
	 */
Packit ae9e2a
#endif
Packit ae9e2a
}